Interface ReadonlyFlowrAnalysisProvider<Parser>
Parser extends KnownParser = KnownParser,
> {
callGraph(force?: boolean): Promise<CallGraph>;
controlflow(
simplifications?: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[],
kind?: CfgKind,
force?: boolean,
): Promise<ControlFlowInformation<CfgVertex>>;
dataflow(
force?: boolean,
): Promise<DataflowInformation & PipelinePerStepMetaInformation>;
flowrConfig: FlowrConfig;
inspectContext(): ReadOnlyFlowrAnalyzerContext;
normalize(
force?: boolean,
): Promise<
NormalizedAst<ParentInformation, RProject<ParentInformation>> & PipelinePerStepMetaInformation,
>;
normalizeStandalone(data: string | RParseRequest): NormalizedAst;
parse(
force?: boolean,
): Promise<NonNullable<AnalyzerCacheType<Parser>["parse"]>>;
parserInformation(): KnownParserInformation;
parseStandalone(data: string | RParseRequest): Tree;
peekCallGraph(): CallGraph | undefined;
peekControlflow(
simplifications?: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[],
kind?: CfgKind,
): ControlFlowInformation<CfgVertex> | undefined;
peekDataflow(): | DataflowInformation & PipelinePerStepMetaInformation
| undefined;
peekNormalize(): | NormalizedAst<
ParentInformation,
RProject<ParentInformation>,
> & PipelinePerStepMetaInformation
| undefined;
peekParse(): NonNullable<AnalyzerCacheType<Parser>["parse"]> | undefined;
query<
Types extends
| "search"
| "origin"
| "call-context"
| "config"
| "dataflow"
| "does-call"
| "call-graph"
| "control-flow"
| "dataflow-lens"
| "files"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-exception"
| "inspect-higher-order"
| "inspect-recursion"
| "resolve-value"
| "project"
| "linter"
| "provenance"
| "input-sources" = | "search"
| "origin"
| "call-context"
| "config"
| "dataflow"
| "does-call"
| "call-graph"
| "control-flow"
| "dataflow-lens"
| "files"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-exception"
| "inspect-higher-order"
| "inspect-recursion"
| "resolve-value"
| "project"
| "linter"
| "provenance"
| "input-sources",
>(
query: Queries<Types>,
): Promise<QueryResults<Types>>;
runFull(force?: boolean): Promise<void>;
runSearch<Search extends FlowrSearchLike>(
search: Search,
): Promise<GetSearchElements<SearchOutput<Search>>>;
}
Type Parameters
- Parser extends KnownParser = KnownParser
Hierarchy (View Summary)
- ReadonlyFlowrAnalysisProvider
Implemented by
Hierarchy-Diagram
Methods
call
Calculate the call graph for the request.
Parameters
Optionalforce: boolean
Returns Promise<CallGraph>
controlflow
- controlflow(
simplifications?: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[],
kind?: CfgKind,
force?: boolean,
): Promise<ControlFlowInformation<CfgVertex>>Get the control flow graph (CFG) for the request.
Parameters
Optionalsimplifications: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[]Simplification passes to be applied to the CFG.
Optionalkind: CfgKindThe kind of CFG that is requested. By default, the CFG without dataflow information is returned.
Optionalforce: booleanDo not use the cache, instead force new analyses.
Returns Promise<ControlFlowInformation<CfgVertex>>
See
ReadonlyFlowrAnalysisProvider#peekControlflow - to get the CFG if already available without triggering a new computation.
dataflow
Get the dataflow graph for the request.
Parameters
Optionalforce: booleanDo not use the cache, instead force new analyses.
Returns Promise<DataflowInformation & PipelinePerStepMetaInformation>
See
ReadonlyFlowrAnalysisProvider#peekDataflow - to get the dataflow graph if already available without triggering a new computation.
inspect
Returns a read-only version of the project context information. This is the preferred method for users that want to inspect the context.
Returns ReadOnlyFlowrAnalyzerContext
normalize
- normalize(
force?: boolean,
): Promise<
NormalizedAst<ParentInformation, RProject<ParentInformation>> & PipelinePerStepMetaInformation,
>Get the normalized abstract syntax tree for the request.
Parameters
Optionalforce: booleanDo not use the cache, instead force new analyses.
Returns Promise<
NormalizedAst<ParentInformation, RProject<ParentInformation>> & PipelinePerStepMetaInformation,
>See
ReadonlyFlowrAnalysisProvider#peekNormalize - to get the normalized AST if already available without triggering a new computation.
normalize
Normalize standalone R code provided as a string or via the
file://protocol.Parameters
- data: string | RParseRequest
The R code to normalize, either as a string or as a
file://URL.
Returns NormalizedAst
Note
this method will always use the TreeSitterExecutor internally, make sure it is initialized!
- data: string | RParseRequest
parse
Get the parse output for the request.
The parse result type depends on the KnownParser used by the analyzer.
Parameters
Optionalforce: booleanDo not use the cache, instead force a new parse.
Returns Promise<NonNullable<AnalyzerCacheType<Parser>["parse"]>>
See
ReadonlyFlowrAnalysisProvider#peekParse - to get the parse output if already available without triggering a new computation.
parser
Returns a set of additional data and helper functions exposed by the underlying KnownParser, including the parser's BaseParserInformation.name and corresponding version information.
Returns KnownParserInformation
parse
Parse standalone R code provided as a string or via the
file://protocol.Parameters
- data: string | RParseRequest
The R code to parse, either as a string or as a
file://URL.
Returns Tree
Note
this method will always use the TreeSitterExecutor internally, make sure it is initialized!
- data: string | RParseRequest
peek
Peek at the call graph for the request, if it was already computed.
Returns CallGraph | undefined
peek
- peekControlflow(
simplifications?: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[],
kind?: CfgKind,
): ControlFlowInformation<CfgVertex> | undefinedPeek at the control flow graph (CFG) for the request, if it was already computed.
Parameters
Optionalsimplifications: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[]Optionalkind: CfgKind
Returns ControlFlowInformation<CfgVertex> | undefined
peek
Peek at the dataflow graph for the request, if it was already computed.
Returns DataflowInformation & PipelinePerStepMetaInformation | undefined
peek
- peekNormalize(): | NormalizedAst<ParentInformation, RProject<ParentInformation>> & PipelinePerStepMetaInformation
| undefinedPeek at the normalized abstract syntax tree for the request, if it was already computed.
Returns
| NormalizedAst<ParentInformation, RProject<ParentInformation>> & PipelinePerStepMetaInformation
| undefined
peek
Peek at the parse output for the request, if it was already computed.
Returns NonNullable<AnalyzerCacheType<Parser>["parse"]> | undefined
query
- query<
Types extends
| "search"
| "origin"
| "call-context"
| "config"
| "dataflow"
| "does-call"
| "call-graph"
| "control-flow"
| "dataflow-lens"
| "files"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-exception"
| "inspect-higher-order"
| "inspect-recursion"
| "resolve-value"
| "project"
| "linter"
| "provenance"
| "input-sources" = | "search"
| "origin"
| "call-context"
| "config"
| "dataflow"
| "does-call"
| "call-graph"
| "control-flow"
| "dataflow-lens"
| "files"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-exception"
| "inspect-higher-order"
| "inspect-recursion"
| "resolve-value"
| "project"
| "linter"
| "provenance"
| "input-sources",
>(
query: Queries<Types>,
): Promise<QueryResults<Types>>Access the query API for the request.
Type Parameters
- Types extends
| "search"
| "origin"
| "call-context"
| "config"
| "dataflow"
| "does-call"
| "call-graph"
| "control-flow"
| "dataflow-lens"
| "files"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-exception"
| "inspect-higher-order"
| "inspect-recursion"
| "resolve-value"
| "project"
| "linter"
| "provenance"
| "input-sources" =
| "search"
| "origin"
| "call-context"
| "config"
| "dataflow"
| "does-call"
| "call-graph"
| "control-flow"
| "dataflow-lens"
| "files"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-exception"
| "inspect-higher-order"
| "inspect-recursion"
| "resolve-value"
| "project"
| "linter"
| "provenance"
| "input-sources"
Returns Promise<QueryResults<Types>>
- Types extends
run
This executes all steps of the core analysis (parse, normalize, dataflow).
Parameters
Optionalforce: boolean
Returns Promise<void>
run
- runSearch<Search extends FlowrSearchLike>(
search: Search,
): Promise<GetSearchElements<SearchOutput<Search>>>Run a search on the current analysis.
Type Parameters
- Search extends FlowrSearchLike
Parameters
- search: Search
Returns Promise<GetSearchElements<SearchOutput<Search>>>
Exposes the central analyses and information provided by the FlowrAnalyzer to the linter, search, and query APIs. This allows us to exchange the underlying implementation of the analyzer without affecting the APIs. You can also use parseStandalone to parse standalone R code snippets.