Interface ReadonlyFlowrAnalysisProvider
interface ReadonlyFlowrAnalysisProvider {
controlflow(
simplifications?: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[],
kind?: CfgKind,
force?: boolean,
): Promise<ControlFlowInformation<CfgSimpleVertex>>;
dataflow(
force?: boolean,
): Promise<DataflowInformation & PipelinePerStepMetaInformation>;
flowrConfig: FlowrConfigOptions;
inspectContext(): ReadOnlyFlowrAnalyzerContext;
normalize(
force?: boolean,
): Promise<
NormalizedAst<ParentInformation, RNode<ParentInformation>> & PipelinePerStepMetaInformation,
>;
parse(
force?: boolean,
): Promise<ParseStepOutput<string | Tree> & PipelinePerStepMetaInformation>;
parserInformation(): Promise<TreeSitterInformation | RShellInformation>;
query<
Types extends
| "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter" = | "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter",
>(
query: Queries<Types>,
): Promise<QueryResults<Types>>;
runFull(force?: boolean): Promise<void>;
runSearch<Search extends FlowrSearchLike>(
search: Search,
): Promise<GetSearchElements<SearchOutput<Search>>>;
sendCommandWithOutput(
command: string,
addonConfig?: Partial<OutputCollectorConfiguration>,
): Promise<string[]>;
}
controlflow(
simplifications?: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[],
kind?: CfgKind,
force?: boolean,
): Promise<ControlFlowInformation<CfgSimpleVertex>>;
dataflow(
force?: boolean,
): Promise<DataflowInformation & PipelinePerStepMetaInformation>;
flowrConfig: FlowrConfigOptions;
inspectContext(): ReadOnlyFlowrAnalyzerContext;
normalize(
force?: boolean,
): Promise<
NormalizedAst<ParentInformation, RNode<ParentInformation>> & PipelinePerStepMetaInformation,
>;
parse(
force?: boolean,
): Promise<ParseStepOutput<string | Tree> & PipelinePerStepMetaInformation>;
parserInformation(): Promise<TreeSitterInformation | RShellInformation>;
query<
Types extends
| "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter" = | "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter",
>(
query: Queries<Types>,
): Promise<QueryResults<Types>>;
runFull(force?: boolean): Promise<void>;
runSearch<Search extends FlowrSearchLike>(
search: Search,
): Promise<GetSearchElements<SearchOutput<Search>>>;
sendCommandWithOutput(
command: string,
addonConfig?: Partial<OutputCollectorConfiguration>,
): Promise<string[]>;
}
Hierarchy (View Summary)
- ReadonlyFlowrAnalysisProvider
Implemented by
Hierarchy-Diagram
Index
Methods
controlflow
- controlflow(
simplifications?: readonly (
| "unique-cf-sets"
| "analyze-dead-code"
| "remove-dead-code"
| "to-basic-blocks"
)[],
kind?: CfgKind,
force?: boolean,
): Promise<ControlFlowInformation<CfgSimpleVertex>>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<CfgSimpleVertex>>
dataflow
Get the dataflow graph for the request.
Parameters
Optionalforce: booleanDo not use the cache, instead force new analyses.
Returns Promise<DataflowInformation & PipelinePerStepMetaInformation>
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, RNode<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, RNode<ParentInformation>> & PipelinePerStepMetaInformation,
>
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<ParseStepOutput<string | Tree> & PipelinePerStepMetaInformation>
parser
Get the name of the parser used by the analyzer.
Returns Promise<TreeSitterInformation | RShellInformation>
query
- query<
Types extends
| "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter" = | "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter",
>(
query: Queries<Types>,
): Promise<QueryResults<Types>>Access the query API for the request.
Type Parameters
- Types extends
| "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter" =
| "search"
| "config"
| "origin"
| "dataflow"
| "call-context"
| "control-flow"
| "dataflow-lens"
| "df-shape"
| "normalized-ast"
| "id-map"
| "dataflow-cluster"
| "static-slice"
| "lineage"
| "dependencies"
| "location-map"
| "happens-before"
| "inspect-higher-order"
| "resolve-value"
| "project"
| "linter"
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>>>
send
- sendCommandWithOutput(
command: string,
addonConfig?: Partial<OutputCollectorConfiguration>,
): Promise<string[]>Sends a command to the underlying R engine and collects the output.
Parameters
- command: string
The command to send to the R engine.
OptionaladdonConfig: Partial<OutputCollectorConfiguration>Additional configuration for the output collector.
Returns Promise<string[]>
- command: string
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.