Class SemanticCfgGuidedVisitor<OtherInfo, Cfg, Ast, Dfg, Config>
Type Parameters
- OtherInfo = NoInfo
- Cfg extends ControlFlowInformation = ControlFlowInformation
- Ast extends NormalizedAst<OtherInfo> = NormalizedAst<OtherInfo>
- Dfg extends DataflowInformation = DataflowInformation
- Config extends SemanticCfgGuidedVisitorConfiguration<OtherInfo, Cfg, Ast, Dfg> = SemanticCfgGuidedVisitorConfiguration<OtherInfo, Cfg, Ast, Dfg>
Hierarchy (View Summary)
- DataflowAwareCfgGuidedVisitor<Cfg, Dfg, Config>
- SemanticCfgGuidedVisitor
Hierarchy-Diagram
Index
Constructors
Properties
Methods
get
Constructors
constructor
- new SemanticCfgGuidedVisitor<
OtherInfo = object,
Cfg extends
ControlFlowInformation<CfgSimpleVertex> = ControlFlowInformation<
CfgSimpleVertex,
>,
Ast extends
NormalizedAst<OtherInfo, RNode<OtherInfo & ParentInformation>> = NormalizedAst<
OtherInfo,
RNode<OtherInfo & ParentInformation>,
>,
Dfg extends DataflowInformation = DataflowInformation,
Config extends
SemanticCfgGuidedVisitorConfiguration<OtherInfo, Cfg, Ast, Dfg> = SemanticCfgGuidedVisitorConfiguration<
OtherInfo,
Cfg,
Ast,
Dfg,
>,
>(
config: Config,
): SemanticCfgGuidedVisitor<OtherInfo, Cfg, Ast, Dfg, Config>Type Parameters
- OtherInfo = object
- Cfg extends ControlFlowInformation<CfgSimpleVertex> = ControlFlowInformation<CfgSimpleVertex>
- Ast extends NormalizedAst<OtherInfo, RNode<OtherInfo & ParentInformation>> = NormalizedAst<OtherInfo, RNode<OtherInfo & ParentInformation>>
- Dfg extends DataflowInformation = DataflowInformation
- Config extends SemanticCfgGuidedVisitorConfiguration<OtherInfo, Cfg, Ast, Dfg> = SemanticCfgGuidedVisitorConfiguration<OtherInfo, Cfg, Ast, Dfg>
Parameters
- config: Config
Returns SemanticCfgGuidedVisitor<OtherInfo, Cfg, Ast, Dfg, Config>
Methods
Protectedget
Get the control flow vertex for the given node id or fail if it does not exist.
Parameters
- id: NodeId
Returns undefined | CfgSimpleVertex
Protectedget
Get the dataflow graph vertex for the given id
Parameters
- id: NodeId
Returns undefined | DataflowGraphVertexArgument
Protectedget
Get the normalized AST node for the given id or fail if it does not exist.
Parameters
- id: NodeId
Returns undefined | RNode<OtherInfo & ParentInformation>
Protectedget
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
- onAssignmentCall(
_data: {
call: DataflowGraphVertexFunctionCall;
source?: NodeId;
target?: NodeId;
},
): voidParameters
- _data: { call: DataflowGraphVertexFunctionCall; source?: NodeId; target?: NodeId }
Returns void
Protectedon
Parameters
- node: CfgBasicBlockVertex
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- call: DataflowGraphVertexFunctionCall
- origin: string
Returns void
Protectedon
- onDispatchFunctionCallOrigins(
call: DataflowGraphVertexFunctionCall,
origins: readonly string[],
): voidParameters
- call: DataflowGraphVertexFunctionCall
- origins: readonly string[]
Returns void
Protectedon
Parameters
- _node: CfgEndMarkerVertex
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- node: CfgExpressionVertex
Returns void
Protectedon
- onForLoopCall(
_data: {
body: FunctionArgument;
call: DataflowGraphVertexFunctionCall;
variable: FunctionArgument;
vector: FunctionArgument;
},
): voidParameters
- _data: {
body: FunctionArgument;
call: DataflowGraphVertexFunctionCall;
variable: FunctionArgument;
vector: FunctionArgument;
}
Returns void
- _data: {
Protectedon
Called for every anonymous function definition
Parameters
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
- onIfThenElseCall(
_data: {
call: DataflowGraphVertexFunctionCall;
condition: FunctionArgument;
else: undefined | FunctionArgument;
then: FunctionArgument;
},
): voidParameters
- _data: {
call: DataflowGraphVertexFunctionCall;
condition: FunctionArgument;
else: undefined | FunctionArgument;
then: FunctionArgument;
}
Returns void
- _data: {
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Called for every constant logical value in the program
Parameters
- _vertex: DataflowGraphVertexValue
- _node: RLogical
Returns void
Protectedon
Parameters
- _node: CfgMidMarkerVertex
Returns void
Protectedon
Called for every constant number value in the program
Parameters
- _vertex: DataflowGraphVertexValue
- _node: RNumber
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { body: FunctionArgument; call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- node: CfgStatementVertex
Returns void
Protectedon
Called for every constant string value in the program
Parameters
- _vertex: DataflowGraphVertexValue
- _node: RString
Returns void
Protectedon
Parameters
Returns void
Protectedon
Called for every variable that is written within the program. You can use getOrigins to get the origins of the variable.
Parameters
Returns void
Protectedon
Called for every variable that is read within the program. You can use getOrigins to get the origins of the variable.
Parameters
- _vertex: DataflowGraphVertexUse
Returns void
Protectedon
Parameters
- _data: { call: DataflowGraphVertexFunctionCall }
Returns void
Protectedon
Parameters
- node: NodeId
Returns void
Protectedon
- onWhileLoopCall(
_data: {
body: FunctionArgument;
call: DataflowGraphVertexFunctionCall;
condition: FunctionArgument;
},
): voidParameters
- _data: {
body: FunctionArgument;
call: DataflowGraphVertexFunctionCall;
condition: FunctionArgument;
}
Returns void
- _data: {
start
Start the visiting process.
Returns void
Protectedstart
Parameters
- start: readonly NodeId[]
Returns void
Protectedvisit
Parameters
Returns void
Protectedvisit
Parameters
Returns void
Protectedvisit
call this function to indicate that a node is to be considered visited.
Parameters
- node: NodeId
Returns boolean
trueif the node was not visited before,falseotherwise
Protectedvisit
Parameters
Returns void
Protectedvisit
Parameters
Returns void
Protectedvisit
Parameters
Returns void
This visitor extends on the DataflowAwareCfgGuidedVisitor by dispatching visitors for separate function calls as well, providing more information! In a way, this is the mixin of syntactic and dataflow guided visitation.
Overwrite the functions starting with
onto implement your logic. In general, there is just one special case that you need to be aware of:In the context of a function call, flowR may be unsure to which origin the call relate! Consider the following example:
Obtaining the origins of the call to
foowill return both built-in functionslibraryandrm. The general semantic visitor can not decide on how to combine these cases, and it is up to your overload of SemanticCfgGuidedVisitor#onDispatchFunctionCallOrigins|onDispatchFunctionCallOrigins to decide how to handle this.Use BasicCfgGuidedVisitor#start to start the traversal.