Class FlowrAnalyzerCache<Parser>

This provides the full analyzer caching layer, please avoid using this directly and prefer the FlowrAnalyzer.

Type Parameters

Parser extends KnownParser

Hierarchy (View Summary)

FlowrCache<AnalyzerCacheType<Parser>>
- FlowrAnalyzerCache

Constructors

`Protected`constructor

new FlowrAnalyzerCache<Parser extends KnownParser>(
args: FlowrAnalyzerCacheOptions<Parser>,
): FlowrAnalyzerCache<Parser>
Type Parameters
- Parser extends KnownParser
Parameters
- args: FlowrAnalyzerCacheOptions<Parser>
Returns FlowrAnalyzerCache<Parser>
Overrides FlowrCache.constructor
- Defined in src/project/cache/flowr-analyzer-cache.ts:54

Methods

`Static`create

create<Parser extends KnownParser>(
data: FlowrAnalyzerCacheOptions<Parser>,
): FlowrAnalyzerCache<Parser>
Type Parameters
- Parser extends KnownParser
Parameters
- data: FlowrAnalyzerCacheOptions<Parser>
Returns FlowrAnalyzerCache<Parser>
- Defined in src/project/cache/flowr-analyzer-cache.ts:71

callGraph

callGraph(force?: boolean): Promise<CallGraph>
Get the call graph for the request, computing if necessary.
Parameters
- Optionalforce: boolean
  Do not use the cache, instead force new analyses.
Returns Promise<CallGraph>
- Defined in src/project/cache/flowr-analyzer-cache.ts:240

`Protected`computeIfAbsent

computeIfAbsent(
force: boolean | undefined,
compute: () => AnalyzerCacheType,
): AnalyzerCacheType
Get the cached value or compute it if not present. This will, by default, not trigger any notifyDependents calls, as this is only a cache retrieval.
Parameters
- force: boolean | undefined
- compute: () => AnalyzerCacheType
Returns AnalyzerCacheType
Inherited from FlowrCache.computeIfAbsent
- Defined in src/project/cache/flowr-cache.ts:106

controlflow

controlflow(
    force: boolean | undefined,
    simplifications?: readonly (
        | "unique-cf-sets"
        | "analyze-dead-code"
        | "remove-dead-code"
        | "to-basic-blocks"
    )[],
): Promise<ControlFlowInformation<CfgVertex>>
Get the control flow graph (CFG) for the request, computing if necessary.
Parameters
- force: boolean | undefined
  Do not use the cache, instead force new analyses.
- Optionalsimplifications: readonly (
      | "unique-cf-sets"
      | "analyze-dead-code"
      | "remove-dead-code"
      | "to-basic-blocks"
  )[]
  Simplification passes to be applied to the CFG.
Returns Promise<ControlFlowInformation<CfgVertex>>
- Defined in src/project/cache/flowr-analyzer-cache.ts:218

dataflow

dataflow(
force?: boolean,
): Promise<NonNullable<AnalyzerCacheType<Parser>["dataflow"]>>
Get the dataflow graph for the request, computing if necessary.
Parameters
- Optionalforce: boolean
  Do not use the cache, instead force new analyses.
Returns Promise<NonNullable<AnalyzerCacheType<Parser>["dataflow"]>>

See
FlowrAnalyzerCache#peekDataflow - to get the dataflow graph if already available without triggering a new computation.
- Defined in src/project/cache/flowr-analyzer-cache.ts:200

derive

derive<T>(key: object, compute: () => Promise<T>): Promise<T>
A value computed from the current analysis once per key, dropped with the analysis. A failed computation is not kept, so the next caller tries again. Callers asking while it runs share the one promise, so a value of one analysis is never computed twice concurrently. See ReadonlyFlowrAnalysisProvider#derive for what to keep in mind when choosing the key.
Type Parameters
- T
Parameters
- key: object
- compute: () => Promise<T>
Returns Promise<T>
Example
```
const first = cache.derive(key, compute);
const second = cache.derive(key, compute); // the same promise
```
- Defined in src/project/cache/flowr-analyzer-cache.ts:258

normalize

normalize(
force?: boolean,
): Promise<NonNullable<AnalyzerCacheType<Parser>["normalize"]>>
Get the normalized abstract syntax tree for the request, normalizing if necessary.
Parameters
- Optionalforce: boolean
  Do not use the cache, instead force new analyses.
Returns Promise<NonNullable<AnalyzerCacheType<Parser>["normalize"]>>

See
FlowrAnalyzerCache#peekNormalize - to get the normalized AST if already available without triggering a new normalization.
- Defined in src/project/cache/flowr-analyzer-cache.ts:182

notifyDependents

notifyDependents(event: InvalidationEvent): void
Notify all dependents of a cache invalidation event.
Parameters
- event: InvalidationEvent
Returns void
Inherited from FlowrCache.notifyDependents
- Defined in src/project/cache/flowr-cache.ts:96

parse

parse(force?: boolean): Promise<NonNullable<AnalyzerCacheType<Parser>["parse"]>>
Get the parse output for the request, parsing if necessary.
Parameters
- Optionalforce: boolean
  Do not use the cache, instead force a new parse.
Returns Promise<NonNullable<AnalyzerCacheType<Parser>["parse"]>>

See
FlowrAnalyzerCache#peekParse - to get the parse output if already available without triggering a new parse.
- Defined in src/project/cache/flowr-analyzer-cache.ts:164

peekCallGraph

peekCallGraph(): CallGraph | undefined
Get the call graph for the request if already available, otherwise return undefined.

Returns CallGraph | undefined
- Defined in src/project/cache/flowr-analyzer-cache.ts:285

peekControlflow

peekControlflow(
    simplifications:
        | readonly (
            | "unique-cf-sets"
            | "analyze-dead-code"
            | "remove-dead-code"
            | "to-basic-blocks"
        )[]
        | undefined,
): ControlFlowInformation<CfgVertex>
| undefined
Get the control flow graph (CFG) for the request if already available, otherwise return undefined.
Parameters
- simplifications:
      | readonly (
          | "unique-cf-sets"
          | "analyze-dead-code"
          | "remove-dead-code"
          | "to-basic-blocks"
      )[]
      | undefined
  Simplification passes to be applied to the CFG.
Returns ControlFlowInformation<CfgVertex> | undefined

See
FlowrAnalyzerCache#controlflow - to get the control flow graph, computing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:232

peekDataflow

peekDataflow(): NonNullable<AnalyzerCacheType<Parser>["dataflow"]> | undefined
Get the dataflow graph for the request if already available, otherwise return undefined. This will not trigger a new computation.

Returns NonNullable<AnalyzerCacheType<Parser>["dataflow"]> | undefined

See
FlowrAnalyzerCache#dataflow - to get the dataflow graph, computing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:209

peekNormalize

peekNormalize(): NonNullable<AnalyzerCacheType<Parser>["normalize"]> | undefined
Get the normalized abstract syntax tree for the request if already available, otherwise return undefined. This will not trigger a new normalization.

Returns NonNullable<AnalyzerCacheType<Parser>["normalize"]> | undefined

See
FlowrAnalyzerCache#normalize - to get the normalized AST, normalizing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:191

peekParse

peekParse(): NonNullable<AnalyzerCacheType<Parser>["parse"]> | undefined
Get the parse output for the request if already available, otherwise return undefined. This will not trigger a new parse.

Returns NonNullable<AnalyzerCacheType<Parser>["parse"]> | undefined

See
FlowrAnalyzerCache#parse - to get the parse output, parsing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:173

Class FlowrAnalyzerCache<Parser>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns FlowrAnalyzerCache<Parser>

Methods

Staticcreate

Type Parameters

Parameters

Returns FlowrAnalyzerCache<Parser>

callGraph

Parameters

Returns Promise<CallGraph>

ProtectedcomputeIfAbsent

Parameters

Returns AnalyzerCacheType

controlflow

Parameters

Returns Promise<ControlFlowInformation<CfgVertex>>

dataflow

Parameters

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

See

derive

Type Parameters

Parameters

Returns Promise<T>

Example

normalize

Parameters

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

See

notifyDependents

Parameters

Returns void

parse

Parameters

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

See

peekCallGraph

Returns CallGraph | undefined

peekControlflow

Parameters

Returns ControlFlowInformation<CfgVertex> | undefined

See

peekDataflow

Returns NonNullable<AnalyzerCacheType<Parser>["dataflow"]> | undefined

See

peekNormalize

Returns NonNullable<AnalyzerCacheType<Parser>["normalize"]> | undefined

See

peekParse

Returns NonNullable<AnalyzerCacheType<Parser>["parse"]> | undefined

See

receive

Parameters

Returns void

registerDependent

Parameters

Returns void

removeDependent

Parameters

Returns void

reset

Returns void

Settings

On This Page

`Protected`constructor

`Static`create

`Protected`computeIfAbsent