Interface ReadOnlyFlowrAnalyzerEnvironmentContext

ReadonlycleanEnv

builtInEnvironment

• get builtInEnvironment(): {
      builtInEnv?: true;
      id: number;
      memory: ReadonlyMap;
      parent: { readonly id: number; readonly parent: ...; readonly memory: ReadonlyMap<BrandedIdentifier, readonly ({ readonly type: InGraphReferenceType; readonly definedAt: NodeId; ... 6 more ...; readonly cds?: readonly { ...; }[] | undefined; } | { ...; } | { ...; })[]>; readonly builtInEnv?: true | undefined; };
  }

  Get the built-in environment used during analysis.

  Returns {
      builtInEnv?: true;
      id: number;
      memory: ReadonlyMap;
      parent: { readonly id: number; readonly parent: ...; readonly memory: ReadonlyMap<BrandedIdentifier, readonly ({ readonly type: InGraphReferenceType; readonly definedAt: NodeId; ... 6 more ...; readonly cds?: readonly { ...; }[] | undefined; } | { ...; } | { ...; })[]>; readonly builtInEnv?: true | undefined; };
  }

  • Optional ReadonlybuiltInEnv?: true

    Built-in environment that must not change; only for the top-most envs.

  • Readonlyid: number

    Unique internally generated identifier, used for debugging not comparison

  • Readonlymemory: ReadonlyMap

    Maps to exactly one definition of an identifier if the source is known, otherwise to a list of all possible definitions

  • Readonlyparent: { readonly id: number; readonly parent: ...; readonly memory: ReadonlyMap<BrandedIdentifier, readonly ({ readonly type: InGraphReferenceType; readonly definedAt: NodeId; ... 6 more ...; readonly cds?: readonly { ...; }[] | undefined; } | { ...; } | { ...; })[]>; readonly builtInEnv?: true | undefined; }

    Lexical parent of the environment, if any (can be manipulated by R code)

emptyBuiltInEnvironment

• get emptyBuiltInEnvironment(): {
      builtInEnv?: true;
      id: number;
      memory: ReadonlyMap;
      parent: { readonly id: number; readonly parent: ...; readonly memory: ReadonlyMap<BrandedIdentifier, readonly ({ readonly type: InGraphReferenceType; readonly definedAt: NodeId; ... 6 more ...; readonly cds?: readonly { ...; }[] | undefined; } | { ...; } | { ...; })[]>; readonly builtInEnv?: true | undefined; };
  }

  Get the empty built-in environment used during analysis. The empty built-in environment only contains primitive definitions.

  Returns {
      builtInEnv?: true;
      id: number;
      memory: ReadonlyMap;
      parent: { readonly id: number; readonly parent: ...; readonly memory: ReadonlyMap<BrandedIdentifier, readonly ({ readonly type: InGraphReferenceType; readonly definedAt: NodeId; ... 6 more ...; readonly cds?: readonly { ...; }[] | undefined; } | { ...; } | { ...; })[]>; readonly builtInEnv?: true | undefined; };
  }

  • Optional ReadonlybuiltInEnv?: true

    Built-in environment that must not change; only for the top-most envs.

  • Readonlyid: number

    Unique internally generated identifier, used for debugging not comparison

  • Readonlymemory: ReadonlyMap

    Maps to exactly one definition of an identifier if the source is known, otherwise to a list of all possible definitions

  • Readonlyparent: { readonly id: number; readonly parent: ...; readonly memory: ReadonlyMap<BrandedIdentifier, readonly ({ readonly type: InGraphReferenceType; readonly definedAt: NodeId; ... 6 more ...; readonly cds?: readonly { ...; }[] | undefined; } | { ...; } | { ...; })[]>; readonly builtInEnv?: true | undefined; }

    Lexical parent of the environment, if any (can be manipulated by R code)

builtInDefinitionsOf

• builtInDefinitionsOf(name: Identifier): readonly IdentifierDefinition[]

  Every built-in definition flowR carries for name, matched by its plain name.

  Parameters

  • name: Identifier

  Returns readonly IdentifierDefinition[]

builtInFunctionOf

• builtInFunctionOf(name: Identifier): BuiltInIdentifierDefinition | undefined

  The built-in function flowR defines for name, respecting its namespace: dplyr::filter picks flowR's dplyr definition rather than whatever else is registered under filter.

  Parameters

  • name: Identifier

  Returns BuiltInIdentifierDefinition | undefined

getCleanEnvFingerprint

• getCleanEnvFingerprint(): string

  Get the fingerprint of the clean environment with the configured built-in environment as base.

  Returns string

knowsPackage

• knowsPackage(pkg: string): boolean

  Whether flowR carries definitions of its own for package pkg, i.e. whether it knows what attaching that package brings even when no signature database resolves it. Built once and kept, as the built-in environment does not change during an analysis.

  Parameters

  • pkg: string

  Returns boolean

makeCleanEnv

• makeCleanEnv(): REnvironmentInformation

  Create a new environment with the configured built-in environment as base. Knows only the built-ins, no attached package, so prefer cleanEnvOf wherever an environment is at hand.

  Returns REnvironmentInformation

makeCleanEnvWithEmptyBuiltIns

• makeCleanEnvWithEmptyBuiltIns(): REnvironmentInformation

  Create a new environment with an empty built-in environment as base.

  Returns REnvironmentInformation

makeEmptyEnv

• makeEmptyEnv(): REnvironmentInformation

  A completely empty environment.

  Returns REnvironmentInformation

statedDefinitionsOf

• statedDefinitionsOf(
      name: Identifier,
  ): readonly IdentifierDefinition[] | undefined

  The definitions the configuration states for name without any package attached: its namespace's when it names one, otherwise what every package together states for the bare name.

  Parameters

  • name: Identifier

  Returns readonly IdentifierDefinition[] | undefined

statedFor

• statedFor(pkg: string): BuiltInMemory | undefined

  What the configuration states about pkg's exports, undefined when it states nothing (these are not in the built-in environment: attaching the package brings them into scope).

  Parameters

  • pkg: string

  Returns BuiltInMemory | undefined