com.sonarsource.cobol.api.ast

Class CobolAstVisitor

java.lang.Object

com.sonarsource.cobol.api.ast.CobolAstVisitor

All Implemented Interfaces:

AstVisitor, org.sonar.squid.api.CodeVisitor

Direct Known Subclasses:

CobolAstCheck

public abstract class CobolAstVisitor
extends Object
implements org.sonar.squid.api.CodeVisitor, AstVisitor

Base class to visit an AST (Abstract Syntactic Tree) generated by a parser. Methods are visited in the following sequential order : init(), visitFile(), visitNode(), leaveNode(), leaveFile() and destroy()

Field Summary

Fields

Modifier and Type	Field and Description
protected CobolGrammar	grammar

Constructor Summary

Constructors

Constructor and Description
CobolAstVisitor()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSourceCode(org.sonar.squid.api.SourceCode child) Do not use
void	destroy() Destroy the visitor.
List<AstNodeType>	getAstNodeTypesToVisit() This method can't be overridden.
Charset	getCharset()
protected CicsGrammar	getCicsGrammar()
protected CobolGrammar	getCobolGrammar()
Comments	getComments()
CobolExecutionFlow	getExecutionFlow()
File	getFile()
protected DB2Grammar	getSqlGrammar()
CobolSymbolTable	getSymbolTable()
void	init() Initialize the visitor.
void	leaveFile(AstNode astNode) Called once a computation unit tree has been fully visited.
void	leaveNode(AstNode astNode) Called once an AST node has been fully visited.
org.sonar.squid.api.SourceCode	peekSourceCode() Do not use
void	popSourceCode() Do not use
void	processMetrics(org.sonar.squid.indexer.SquidIndex index) Called after leaveFile(AstNode), after metrics have been aggregated.
void	setCharset(Charset charset)
void	setComments(Comments comments) Do not use
void	setExecutionFlow(CobolExecutionFlow executionFlow)
void	setFile(File file)
void	setGrammar(CobolGrammar grammar) Do not use
void	setSourceCodeStack(Deque<org.sonar.squid.api.SourceCode> sourceCodeStack) Do not use
void	setSymbolTable(CobolSymbolTable symbolTable) Do not use
void	subscribeTo(AstNodeType... astNodeTypes) This method must called into the init() method when a Cobol AST visitor wants to subscribe to a set of AST node type.
void	visitFile(AstNode astNode) Called before starting visiting a computation unit tree.
void	visitNode(AstNode astNode) Called to process an AST node whose type has been registered to be visited.

Methods inherited from class java.lang.Object

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

Field Detail

grammar

protected CobolGrammar grammar

Constructor Detail

CobolAstVisitor

public CobolAstVisitor()

Method Detail

getAstNodeTypesToVisit

public final List<AstNodeType> getAstNodeTypesToVisit()

This method can't be overridden. The method subscribeTo(AstNodeType... astNodeTypes) must be used to while overriding the public void init() method.

Specified by:

getAstNodeTypesToVisit in interface AstVisitor

Returns:

the AST node types this must be registered for.

subscribeTo

public final void subscribeTo(AstNodeType... astNodeTypes)

This method must called into the init() method when a Cobol AST visitor wants to subscribe to a set of AST node type.

setSourceCodeStack

public final void setSourceCodeStack(Deque<org.sonar.squid.api.SourceCode> sourceCodeStack)

Do not use

setGrammar

public final void setGrammar(CobolGrammar grammar)

Do not use

setComments

public final void setComments(Comments comments)

Do not use

setSymbolTable

public final void setSymbolTable(CobolSymbolTable symbolTable)

Do not use

getSymbolTable

public final CobolSymbolTable getSymbolTable()

getComments

public final Comments getComments()

addSourceCode

public final void addSourceCode(org.sonar.squid.api.SourceCode child)

Do not use

popSourceCode

public final void popSourceCode()

Do not use

peekSourceCode

public final org.sonar.squid.api.SourceCode peekSourceCode()

Do not use

init

public void init()

Initialize the visitor. This is the time to verify that the visitor has everything required to perform it job. This method is called once.

visitFile

public void visitFile(@Nullable
             AstNode astNode)

Called before starting visiting a computation unit tree. Ideal place to initialize information that is to be collected while processing the tree.

Specified by:

visitFile in interface AstVisitor

Parameters:

astNode - the root of the tree, or null if no tree

visitNode

public void visitNode(AstNode astNode)

Called to process an AST node whose type has been registered to be visited.

Specified by:

visitNode in interface AstVisitor

Parameters:

astNode - the AST node to process

leaveFile

public void leaveFile(@Nullable
             AstNode astNode)

Called once a computation unit tree has been fully visited. Ideal place to report on information collected while processing a tree.

Specified by:

leaveFile in interface AstVisitor

Parameters:

astNode - the root of the tree, or null if no tree

leaveNode

public void leaveNode(AstNode astNode)

Called once an AST node has been fully visited.

Specified by:

leaveNode in interface AstVisitor

Parameters:

astNode - the AST node which has been visited

processMetrics

public void processMetrics(org.sonar.squid.indexer.SquidIndex index)

Called after leaveFile(AstNode), after metrics have been aggregated.

destroy

public void destroy()

Destroy the visitor. It is being retired from service.

setFile

public final void setFile(File file)

getFile

public final File getFile()

getCharset

public Charset getCharset()

setCharset

public void setCharset(Charset charset)

getCobolGrammar

protected final CobolGrammar getCobolGrammar()

getSqlGrammar

protected final DB2Grammar getSqlGrammar()

getCicsGrammar

protected final CicsGrammar getCicsGrammar()

setExecutionFlow

public final void setExecutionFlow(CobolExecutionFlow executionFlow)

getExecutionFlow

public final CobolExecutionFlow getExecutionFlow()