rortveiten.misra

Class PcLintWarningParser

java.lang.Object

rortveiten.misra.WarningParser

rortveiten.misra.PcLintWarningParser

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public class PcLintWarningParser
extends WarningParser

Nested Class Summary

Nested classes/interfaces inherited from class rortveiten.misra.WarningParser

WarningParser.CommentProperties, WarningParser.MisraVersion, WarningParser.Suppression, WarningParser.Violation

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class rortveiten.misra.WarningParser

ERR_COULD_NOT_DETERMINE_SUPPRESSED_GUIDELINE, ERR_GRP_ERROR, ERR_GUIDELINE_NOT_FOUND, ERR_ILLEGAL_DEVIATION, ERR_READ_FILE, ERR_WRITE_FILE, errorCode, out

Constructor Summary

Constructors

Constructor and Description
PcLintWarningParser()

Method Summary

Modifier and Type	Method and Description
protected List<String>	findSuppressionComments(String fileContent) Parse the contents of a source code file, and return a list of all suppression comments in the file.
protected Set<String>	getGuidelineIdsFromComment(String comment) For a single suppression comment, find each MISRA violation that is suppressed by this comment.
String	name()
protected List<WarningParser.Violation>	parseWarningLine(String line) Parse a line from the output of the MISRA checker tool (e.g.
void	setMisraVersion(WarningParser.MisraVersion misraVersion) Resets this parser and sets a specific MISRA version.
Set<WarningParser.MisraVersion>	supportedMisraVersions() Returns the set of all MISRA-guideline versions supported by this warning parser.

Methods inherited from class rortveiten.misra.WarningParser

all, getDeviationPattern, getErrorCode, getFalsePositivePattern, getGuidelinePattern, getGuidelines, getLogFilePath, getMisraLintFileContent, getMisraVersion, getNonMisraPattern, getWorkspace, initialize, isCompliant, log, parseSourceFile, parseSourceFiles, parseWarnings, readGrp, setDeviationPattern, setFalsePositivePattern, setGuidelinePattern, setGuidelines, setLogFilePath, setLogger, setNonMisraPattern, setWorkspace, summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PcLintWarningParser

public PcLintWarningParser()

Method Detail

setMisraVersion

public void setMisraVersion(WarningParser.MisraVersion misraVersion)

Description copied from class: WarningParser

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.

Overrides:

setMisraVersion in class WarningParser

Parameters:

misraVersion - Version of MISRA rules to use.

parseWarningLine

protected List<WarningParser.Violation> parseWarningLine(String line)

Description copied from class: WarningParser

Parse a line from the output of the MISRA checker tool (e.g. PC-lint).

Specified by:

parseWarningLine in class WarningParser

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 List<String> findSuppressionComments(String fileContent)

Description copied from class: WarningParser

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.

Specified by:

findSuppressionComments in class WarningParser

Parameters:

fileContent - The full contents of the source file as a string

Returns:

A list of all suppression comments in the file

getGuidelineIdsFromComment

protected Set<String> getGuidelineIdsFromComment(String comment)

Description copied from class: WarningParser

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.

Specified by:

getGuidelineIdsFromComment in class WarningParser

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 String name()

Specified by:

name in class WarningParser

Returns:

The name of this warning parser

supportedMisraVersions

public Set<WarningParser.MisraVersion> supportedMisraVersions()

Description copied from class: WarningParser

Returns the set of all MISRA-guideline versions supported by this warning parser. Override if your warning parser does not support all guideline versions.

Overrides:

supportedMisraVersions in class WarningParser

Returns:

A set of all versions of the MISRA guidelines that are supported by this warning parser.