@eagleoutice/flowr - v2.10.2
    Preparing search index...

    Class FlowrAnalyzer<Parser>

    Central class for conducting analyses with FlowR. Use the FlowrAnalyzerBuilder to create a new instance.

    If you want the original pattern of creating a pipeline and running all steps, you can still do this with FlowrAnalyzer#runFull.

    To inspect the context of the analyzer, use FlowrAnalyzer#inspectContext (if you are a plugin and need to modify it, use FlowrAnalyzer#context instead).

    Type Parameters

    Implements

    Index

    Constructors

    Accessors

    Methods

    • Close the parser if it was created by this builder. This is only required if you rely on an RShell/remote engine.

      Returns boolean | void

    • 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: CfgKind

        The kind of CFG that is requested. By default, the CFG without dataflow information is returned.

      • Optionalforce: boolean

        Do not use the cache, instead force new analyses.

      Returns Promise<ControlFlowInformation<CfgVertex>>

      ReadonlyFlowrAnalysisProvider#peekControlflow - to get the CFG if already available without triggering a new computation.

    • 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"

      Parameters

      Returns Promise<QueryResults<Types>>