Class FlowrAnalyzer<Parser>

constructor

• new FlowrAnalyzer<Parser extends KnownParser = KnownParser>(
      config: FlowrConfigOptions,
      parser: Parser,
      ctx: FlowrAnalyzerContext,
      cache: FlowrAnalyzerCache<Parser>,
  ): FlowrAnalyzer<Parser>

  Create a new analyzer instance. Prefer the use of the FlowrAnalyzerBuilder instead of calling this constructor directly.

  Type Parameters

  • Parser extends KnownParser = KnownParser

  Parameters

  • config: FlowrConfigOptions

    The FlowR config to use for the analyses
  • parser: Parser

    The parser to use for parsing the given request.
  • ctx: FlowrAnalyzerContext

    The context to use for the analyses.
  • cache: FlowrAnalyzerCache<Parser>

    The caching layer to use for storing analysis results.

  Returns FlowrAnalyzer<Parser>

ReadonlyflowrConfig

close

• close(): boolean | void

  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

context

• context(): FlowrAnalyzerContext

  Returns project context information. If you are a user that wants to inspect the context, prefer inspectContext instead. Please be aware that modifications to the context may break analyzer assumptions.

  Returns FlowrAnalyzerContext

controlflow

• controlflow(
      simplifications?: readonly (
          | "unique-cf-sets"
          | "analyze-dead-code"
          | "remove-dead-code"
          | "to-basic-blocks"
      )[],
      useDataflow?: boolean,
      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.
  • OptionaluseDataflow: boolean

    Whether to use the dataflow graph for the creation of the CFG.
  • Optionalforce: boolean

    Do not use the cache, instead force new analyses.

  Returns Promise<ControlFlowInformation<CfgSimpleVertex>>

controlflowQuick

• controlflowQuick(
      force?: boolean,
  ): Promise<ControlFlowInformation<CfgSimpleVertex>>

  Get a quick and dirty control flow graph (CFG) for the request. This does not use the dataflow information and does not apply any simplifications.

  Parameters

  • Optionalforce: boolean

    Do not use the cache, instead force new analyses.

  Returns Promise<ControlFlowInformation<CfgSimpleVertex>>

dataflow

• dataflow(
      force?: boolean,
  ): Promise<NonNullable<AnalyzerCacheType<Parser>["dataflow"]>>

  Get the dataflow graph for the request.

  Parameters

  • Optionalforce: boolean

    Do not use the cache, instead force new analyses.

  Returns Promise<NonNullable<AnalyzerCacheType<Parser>["dataflow"]>>

inspectContext

• inspectContext(): ReadOnlyFlowrAnalyzerContext

  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<NonNullable<AnalyzerCacheType<Parser>["normalize"]>>

  Get the normalized abstract syntax tree for the request.

  Parameters

  • Optionalforce: boolean

    Do not use the cache, instead force new analyses.

  Returns Promise<NonNullable<AnalyzerCacheType<Parser>["normalize"]>>

parse

• parse(force?: boolean): Promise<NonNullable<AnalyzerCacheType<Parser>["parse"]>>

  Get the parse output for the request.

  The parse result type depends on the KnownParser used by the analyzer.

  Parameters

  • Optionalforce: boolean

    Do not use the cache, instead force a new parse.

  Returns Promise<NonNullable<AnalyzerCacheType<Parser>["parse"]>>

parserName

• parserName(): "r-shell" | "tree-sitter"

  Get the name of the parser used by the analyzer.

  Returns "r-shell" | "tree-sitter"

query

• query<
      Types extends
          | "config"
          | "origin"
          | "dataflow"
          | "search"
          | "dependencies"
          | "call-context"
          | "control-flow"
          | "dataflow-lens"
          | "df-shape"
          | "normalized-ast"
          | "id-map"
          | "dataflow-cluster"
          | "static-slice"
          | "lineage"
          | "location-map"
          | "happens-before"
          | "resolve-value"
          | "project"
          | "linter" = | "config"
      | "origin"
      | "dataflow"
      | "search"
      | "dependencies"
      | "call-context"
      | "control-flow"
      | "dataflow-lens"
      | "df-shape"
      | "normalized-ast"
      | "id-map"
      | "dataflow-cluster"
      | "static-slice"
      | "lineage"
      | "location-map"
      | "happens-before"
      | "resolve-value"
      | "project"
      | "linter",
  >(
      query: Queries<Types>,
  ): Promise<QueryResults<Types>>

  Access the query API for the request.

  Type Parameters

  • Types extends
        | "config"
        | "origin"
        | "dataflow"
        | "search"
        | "dependencies"
        | "call-context"
        | "control-flow"
        | "dataflow-lens"
        | "df-shape"
        | "normalized-ast"
        | "id-map"
        | "dataflow-cluster"
        | "static-slice"
        | "lineage"
        | "location-map"
        | "happens-before"
        | "resolve-value"
        | "project"
        | "linter" =
        | "config"
        | "origin"
        | "dataflow"
        | "search"
        | "dependencies"
        | "call-context"
        | "control-flow"
        | "dataflow-lens"
        | "df-shape"
        | "normalized-ast"
        | "id-map"
        | "dataflow-cluster"
        | "static-slice"
        | "lineage"
        | "location-map"
        | "happens-before"
        | "resolve-value"
        | "project"
        | "linter"

  Parameters

  • query: Queries<Types>

    The list of queries.

  Returns Promise<QueryResults<Types>>

reset

• reset(): void

  Reset all caches used by the analyzer and effectively force all analyses to be redone.

  Returns void

runFull

• runFull(force?: boolean): Promise<void>

  This executes all steps of the core analysis (parse, normalize, dataflow).

  Parameters

  • Optionalforce: boolean

  Returns Promise<void>

runSearch

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