org.sonar.python.metrics

Class FileLinesVisitor

java.lang.Object

org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

org.sonar.python.metrics.FileLinesVisitor

All Implemented Interfaces:

com.sonar.sslr.api.AstAndTokenVisitor, com.sonar.sslr.api.AstVisitor, org.sonar.squidbridge.api.CodeVisitor

public class FileLinesVisitor
extends org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>
implements com.sonar.sslr.api.AstAndTokenVisitor

Visitor that computes CoreMetrics.NCLOC_DATA_KEY and CoreMetrics.COMMENT_LINES_DATA_KEY metrics used by the DevCockpit.

Constructor Summary

Constructors

Constructor and Description
FileLinesVisitor(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.fs.FileSystem fileSystem, Map<org.sonar.api.batch.fs.InputFile,Set<Integer>> linesOfCode, boolean ignoreHeaderComments)

Method Summary

Modifier and Type	Method and Description
void	init()
void	leaveFile(com.sonar.sslr.api.AstNode astNode)
void	visitComment(com.sonar.sslr.api.Trivia trivia)
void	visitFile(com.sonar.sslr.api.AstNode astNode)
void	visitNode(com.sonar.sslr.api.AstNode astNode)
void	visitToken(com.sonar.sslr.api.Token token) Gets the lines of codes and lines of comments (with character #).

Methods inherited from class org.sonar.squidbridge.SquidAstVisitor

destroy, getAstNodeTypesToVisit, getContext, leaveNode, setContext, subscribeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sonar.sslr.api.AstVisitor

getAstNodeTypesToVisit, leaveNode

Constructor Detail

FileLinesVisitor

public FileLinesVisitor(org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory,
                        org.sonar.api.batch.fs.FileSystem fileSystem,
                        Map<org.sonar.api.batch.fs.InputFile,Set<Integer>> linesOfCode,
                        boolean ignoreHeaderComments)

Method Detail

init

public void init()

Overrides:

init in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

visitFile

public void visitFile(com.sonar.sslr.api.AstNode astNode)

Specified by:

visitFile in interface com.sonar.sslr.api.AstVisitor

Overrides:

visitFile in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

visitNode

public void visitNode(com.sonar.sslr.api.AstNode astNode)

Specified by:

visitNode in interface com.sonar.sslr.api.AstVisitor

Overrides:

visitNode in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

visitToken

public void visitToken(com.sonar.sslr.api.Token token)

Gets the lines of codes and lines of comments (with character #). Does not get the lines of docstrings.

Specified by:

visitToken in interface com.sonar.sslr.api.AstAndTokenVisitor

visitComment

public void visitComment(com.sonar.sslr.api.Trivia trivia)

leaveFile

public void leaveFile(com.sonar.sslr.api.AstNode astNode)

Specified by:

leaveFile in interface com.sonar.sslr.api.AstVisitor

Overrides:

leaveFile in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>