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

Hierarchy-Diagram

Index

Constructors

constructor

Methods

create computeIfAbsent controlflow dataflow normalize notifyDependents parse peekControlflow peekDataflow peekNormalize peekParse receive registerDependent removeDependent reset

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:53

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:70

`Protected`computeIfAbsent

computeIfAbsent(
force: undefined | boolean,
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: undefined | boolean
- compute: () => AnalyzerCacheType
Returns AnalyzerCacheType
Inherited from FlowrCache.computeIfAbsent
- Defined in src/project/cache/flowr-cache.ts:53

controlflow

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

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:153

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:132

notifyDependents

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

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:112

peekControlflow

peekControlflow(
    useDataflow: boolean,
    simplifications:
        | undefined
        | readonly (
            | "unique-cf-sets"
            | "analyze-dead-code"
            | "remove-dead-code"
            | "to-basic-blocks"
        )[],
): undefined
| ControlFlowInformation<CfgSimpleVertex>
Get the control flow graph (CFG) for the request if already available, otherwise return undefined.
Parameters
- useDataflow: boolean
  Whether to use the dataflow graph for the creation of the CFG.
- simplifications:
      | undefined
      | readonly (
          | "unique-cf-sets"
          | "analyze-dead-code"
          | "remove-dead-code"
          | "to-basic-blocks"
      )[]
  Simplification passes to be applied to the CFG.
Returns undefined | ControlFlowInformation<CfgSimpleVertex>
See
FlowrAnalyzerCache#controlflow - to get the control flow graph, computing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:203

peekDataflow

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

Returns undefined | NonNullable<AnalyzerCacheType<Parser>["dataflow"]>
See
FlowrAnalyzerCache#dataflow - to get the dataflow graph, computing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:164

peekNormalize

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

Returns undefined | NonNullable<AnalyzerCacheType<Parser>["normalize"]>
See
FlowrAnalyzerCache#normalize - to get the normalized AST, normalizing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:143

peekParse

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

Returns undefined | NonNullable<AnalyzerCacheType<Parser>["parse"]>
See
FlowrAnalyzerCache#parse - to get the parse output, parsing if necessary.
- Defined in src/project/cache/flowr-analyzer-cache.ts:123

Class FlowrAnalyzerCache<Parser>

Type Parameters

Hierarchy (View Summary)

Hierarchy-Diagram

Index

Constructors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns FlowrAnalyzerCache<Parser>

Methods

Staticcreate

Type Parameters

Parameters

Returns FlowrAnalyzerCache<Parser>

ProtectedcomputeIfAbsent

Parameters

Returns AnalyzerCacheType

controlflow

Parameters

Returns Promise<ControlFlowInformation<CfgSimpleVertex>>

dataflow

Parameters

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

See

normalize

Parameters

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

See

notifyDependents

Parameters

Returns void

parse

Parameters

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

See

peekControlflow

Parameters

Returns undefined | ControlFlowInformation<CfgSimpleVertex>

See

peekDataflow

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

See

peekNormalize

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

See

peekParse

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

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