WarningParser (MISRA Compliance Report Plugin 1.0 API)

java.lang.Object
- rortveiten.misra.WarningParser

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

CppcheckWarningParser, PcLintWarningParser
```
public abstract class WarningParser
extends Object
implements hudson.ExtensionPoint
```
Abstract class with functions to parse warnings from a specific MISRA checker tool. Extend this class and implement the abstract methods in order to implement a parser for a new tool. See PCLintWarningParser for an example.

Author:

Oyvind Rortveit

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`WarningParser.CommentProperties`
`static class`	`WarningParser.MisraVersion`
`protected static class`	`WarningParser.Suppression`
`protected static class`	`WarningParser.Violation`

Nested classes/interfaces inherited from interface hudson.ExtensionPoint
hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERR_COULD_NOT_DETERMINE_SUPPRESSED_GUIDELINE`
`static int`	`ERR_GRP_ERROR`
`static int`	`ERR_GUIDELINE_NOT_FOUND`
`static int`	`ERR_ILLEGAL_DEVIATION`
`static int`	`ERR_READ_FILE`
`static int`	`ERR_WRITE_FILE`
`protected int`	`errorCode`
`protected PrintStream`	`out`

Constructor Summary

Constructors
Constructor and Description

WarningParser()

Constructors
Constructor and Description
`WarningParser()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static hudson.ExtensionList<WarningParser>`	`all()` This is how we get all subclasses, so you don't need to do anything but add a new subclass to the project in order to create support for a new tool.
`protected abstract List<String>`	`findSuppressionComments(String fileContent)` Parse the contents of a source code file, and return a list of all suppression comments in the file.
`String`	`getDeviationPattern()`
`int`	`getErrorCode()` Gets the errors produced by this warningparser
`String`	`getFalsePositivePattern()`
`protected abstract Set<String>`	`getGuidelineIdsFromComment(String comment)` For a single suppression comment, find each MISRA violation that is suppressed by this comment.
`String`	`getGuidelinePattern()`
`List<Guideline>`	`getGuidelines()`
`String`	`getLogFilePath()`
`protected static String`	`getMisraLintFileContent(WarningParser.MisraVersion misraVersion)` These files are provided by Gimpel software as settings for PC-lint.
`WarningParser.MisraVersion`	`getMisraVersion()`
`String`	`getNonMisraPattern()`
`hudson.FilePath`	`getWorkspace()`
`void`	`initialize(WarningParser.MisraVersion misraVersion)` Initializes/resets this warning parser and sets the MISRA version.
`boolean`	`isCompliant()`
`protected void`	`log(String s)`
`abstract String`	`name()`
`protected List<WarningParser.CommentProperties>`	`parseSourceFile(String fileName)`
`void`	`parseSourceFiles(List<String> filesToParse)`
`protected abstract List<WarningParser.Violation>`	`parseWarningLine(String line)` Parse a line from the output of the MISRA checker tool (e.g.
`void`	`parseWarnings(List<String> lines)`
`void`	`readGrp(List<String> grpLines)` Reads in a guideline categorization plan (GRP) from a list of strings, each containing a guideline to be recategorized and its new category separated by a comma, e.g "Rule 1.1, mandatory" or "Directive 2.1, disapplied"
`void`	`setDeviationPattern(String regex)`
`void`	`setFalsePositivePattern(String regex)`
`void`	`setGuidelinePattern(String regex)`
`protected void`	`setGuidelines(List<Guideline> guidelines)` Method only meant for injection from tests to reduce test-refactoring effort
`void`	`setLogFilePath(String logFilePath)`
`void`	`setLogger(PrintStream logger)`
`protected void`	`setMisraVersion(WarningParser.MisraVersion misraVersion)` Resets this parser and sets a specific MISRA version.
`void`	`setNonMisraPattern(String regex)`
`void`	`setWorkspace(hudson.FilePath workspace)`
`String`	`summary()`
`Set<WarningParser.MisraVersion>`	`supportedMisraVersions()` Returns the set of all MISRA-guideline versions supported by this warning parser.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ERR_GUIDELINE_NOT_FOUND
```
public static final int ERR_GUIDELINE_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERR_COULD_NOT_DETERMINE_SUPPRESSED_GUIDELINE
```
public static final int ERR_COULD_NOT_DETERMINE_SUPPRESSED_GUIDELINE
```
    See Also:
    
    Constant Field Values
  - ERR_GRP_ERROR
```
public static final int ERR_GRP_ERROR
```
    See Also:
    
    Constant Field Values
  - ERR_ILLEGAL_DEVIATION
```
public static final int ERR_ILLEGAL_DEVIATION
```
    See Also:
    
    Constant Field Values
  - ERR_READ_FILE
```
public static final int ERR_READ_FILE
```
    See Also:
    
    Constant Field Values
  - ERR_WRITE_FILE
```
public static final int ERR_WRITE_FILE
```
    See Also:
    
    Constant Field Values
  - errorCode
```
protected int errorCode
```
  - out
```
protected PrintStream out
```
- Constructor Detail
  - WarningParser
```
public WarningParser()
```
- Method Detail
  - parseWarningLine
```
protected abstract List<WarningParser.Violation> parseWarningLine(String line)
```
    Parse a line from the output of the MISRA checker tool (e.g. PC-lint).
    
    Parameters:
    
    line - A single line of text from the parser tools output. The parser should be configured so that a violation does not cover more than one line.
    
    Returns:
    
    A list of MISRA-violations described by this line. If the line does not represent any MISRA-violations, return null or an empty list.
  - findSuppressionComments
```
protected abstract List<String> findSuppressionComments(String fileContent)
```
    Parse the contents of a source code file, and return a list of all suppression comments in the file. A suppression comment is a comment that is used to suppress a warning from the checker tool. For example, for PC-lint this is every comment that starts out with "lint" immediately following the comment opening symbol. The returned string should contain the full text of the comment, including any suppression tokens.
    
    Parameters:
    
    fileContent - The full contents of the source file as a string
    
    Returns:
    
    A list of all suppression comments in the file
  - getGuidelineIdsFromComment
```
protected abstract Set<String> getGuidelineIdsFromComment(String comment)
```
    For a single suppression comment, find each MISRA violation that is suppressed by this comment.
    Note: This is likely the most difficult method to implement, since it may have to map tool error codes to MISRA guidelines. If this mapping is too complex, you can implement this method to always return null. This will force the user to always add a GUIDELINE(...) tag to suppression comments, or end up with an invalid report.
    
    Parameters:
    
    comment - A suppression comment from the source file
    
    Returns:
    
    A set of guidelines suppressed by this comment, e.g "Rule 1.2". Return null or an empty set if no MISRA guidelines are suppressed, or we could not determine which guideline is suppressed by this comment.
  - name
```
public abstract String name()
```
    Returns:
    
    The name of this warning parser
  - supportedMisraVersions
```
public Set<WarningParser.MisraVersion> supportedMisraVersions()
```
    Returns the set of all MISRA-guideline versions supported by this warning parser. Override if your warning parser does not support all guideline versions.
    
    Returns:
    
    A set of all versions of the MISRA guidelines that are supported by this warning parser.
  - setMisraVersion
```
protected void setMisraVersion(WarningParser.MisraVersion misraVersion)
```
    Resets this parser and sets a specific MISRA version. Override this method to set the MISRA version and reset your WarningParser implementation. To set the misra version from outside this class' descendants, use initialize() instead.
    
    Parameters:
    
    misraVersion - Version of MISRA rules to use.
  - initialize
```
public final void initialize(WarningParser.MisraVersion misraVersion)
```
    Initializes/resets this warning parser and sets the MISRA version. This method will call setMisraVersion, which can be overridden by subclasses.
    
    Parameters:
    
    misraVersion - Version of the MISRA rules to use
  - getMisraVersion
```
public final WarningParser.MisraVersion getMisraVersion()
```
  - getGuidelines
```
public final List<Guideline> getGuidelines()
```
  - setGuidelines
```
protected void setGuidelines(List<Guideline> guidelines)
```
    Method only meant for injection from tests to reduce test-refactoring effort
    
    Parameters:
    
    guidelines - List of guideliness
  - getMisraLintFileContent
```
protected static final String getMisraLintFileContent(WarningParser.MisraVersion misraVersion)
```
    These files are provided by Gimpel software as settings for PC-lint. They can be very useful, since they contain lists of all guidelines.
    
    Parameters:
    
    misraVersion - Version of MISRA guidelines
    
    Returns:
    
    The whole file content
  - getErrorCode
```
public final int getErrorCode()
```
    Gets the errors produced by this warningparser
    
    Returns:
    
    A bitfield ORed together of all the errors that have occurred (see the errorcodes starting with ERR_ )
  - getFalsePositivePattern
```
public final String getFalsePositivePattern()
```
  - setFalsePositivePattern
```
public final void setFalsePositivePattern(String regex)
```
  - getDeviationPattern
```
public final String getDeviationPattern()
```
  - setDeviationPattern
```
public final void setDeviationPattern(String regex)
```
  - getNonMisraPattern
```
public final String getNonMisraPattern()
```
  - setNonMisraPattern
```
public final void setNonMisraPattern(String regex)
```
  - getGuidelinePattern
```
public final String getGuidelinePattern()
```
  - setGuidelinePattern
```
public final void setGuidelinePattern(String regex)
```
  - setLogger
```
public final void setLogger(PrintStream logger)
```
  - parseSourceFile
```
protected List<WarningParser.CommentProperties> parseSourceFile(String fileName)
```
  - parseWarnings
```
public final void parseWarnings(List<String> lines)
```
  - parseSourceFiles
```
public final void parseSourceFiles(List<String> filesToParse)
```
  - readGrp
```
public final void readGrp(List<String> grpLines)
```
    Reads in a guideline categorization plan (GRP) from a list of strings, each containing a guideline to be recategorized and its new category separated by a comma, e.g "Rule 1.1, mandatory" or "Directive 2.1, disapplied"
    
    Parameters:
    
    grpLines - List of lines from the GRP file
  - log
```
protected final void log(String s)
```
  - isCompliant
```
public final boolean isCompliant()
```
  - summary
```
public final String summary()
```
  - all
```
public static final hudson.ExtensionList<WarningParser> all()
```
    This is how we get all subclasses, so you don't need to do anything but add a new subclass to the project in order to create support for a new tool.
    
    Returns:
    
    All registered WarningParsers.
  - getLogFilePath
```
public final String getLogFilePath()
```
  - setLogFilePath
```
public final void setLogFilePath(String logFilePath)
```
  - getWorkspace
```
public final hudson.FilePath getWorkspace()
```
  - setWorkspace
```
public final void setWorkspace(hudson.FilePath workspace)
```

Class WarningParser

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERR_GUIDELINE_NOT_FOUND

ERR_COULD_NOT_DETERMINE_SUPPRESSED_GUIDELINE

ERR_GRP_ERROR

ERR_ILLEGAL_DEVIATION

ERR_READ_FILE

ERR_WRITE_FILE

errorCode

out

Constructor Detail

WarningParser

Method Detail

parseWarningLine

findSuppressionComments

getGuidelineIdsFromComment

name

supportedMisraVersions

setMisraVersion

initialize

getMisraVersion

getGuidelines

setGuidelines

getMisraLintFileContent

getErrorCode

getFalsePositivePattern

setFalsePositivePattern

getDeviationPattern

setDeviationPattern

getNonMisraPattern

setNonMisraPattern

getGuidelinePattern

setGuidelinePattern

setLogger

parseSourceFile

parseWarnings

parseSourceFiles

readGrp

log

isCompliant

summary

all

getLogFilePath

setLogFilePath

getWorkspace

setWorkspace