Class FlowrAnalyzerFilesContext

constructor

• new FlowrAnalyzerFilesContext(
      loadingOrder: FlowrAnalyzerLoadingOrderContext,
      plugins: readonly FlowrAnalyzerProjectDiscoveryPlugin[],
      fileLoaders: readonly FlowrAnalyzerFilePlugin[],
  ): FlowrAnalyzerFilesContext

  Parameters

  • loadingOrder: FlowrAnalyzerLoadingOrderContext
  • plugins: readonly FlowrAnalyzerProjectDiscoveryPlugin[]
  • fileLoaders: readonly FlowrAnalyzerFilePlugin[]

  Returns FlowrAnalyzerFilesContext

ReadonlyloadingOrder

Readonlyname

addConsideredFile

• addConsideredFile(path: string): void

  Record that a file has been considered during dataflow analysis.

  Parameters

  • path: string

  Returns void

addFile

• addFile(
      file:
          | string
          | RParseRequestFromFile
          | FlowrFileProvider<{ toString(): string }>,
      roles?: readonly FileRole[],
  ): FlowrFileProvider<{ toString(): string }>

  Add a file to the context. If the file has a special role, it will be added to the corresponding list of special files. This method also applies any registered FlowrAnalyzerFilePlugins to the file before adding it to the context.

  Parameters

  • file: string | RParseRequestFromFile | FlowrFileProvider<{ toString(): string }>
  • Optionalroles: readonly FileRole[]

  Returns FlowrFileProvider<{ toString(): string }>

addFiles

• addFiles(
      files: (
          | string
          | RParseRequestFromFile
          | FlowrFileProvider<{ toString(): string }>
      )[],
  ): void

  Add multiple files to the context. This is just a convenience method that calls addFile for each file.

  Parameters

  • files: (string | RParseRequestFromFile | FlowrFileProvider<{ toString(): string }>)[]

  Returns void

addRequests

• addRequests(requests: readonly RAnalysisRequest[]): void

  Add multiple requests to the context. This is just a convenience method that calls addRequest for each request.

  Parameters

  • requests: readonly RAnalysisRequest[]

  Returns void

computeLoadingOrder

• computeLoadingOrder(): readonly RParseRequest[]

  Get all requests that have been added to this context. This is a convenience method that calls FlowrAnalyzerLoadingOrderContext.getLoadingOrder.

  Returns readonly RParseRequest[]

consideredFilesList

• consideredFilesList(): readonly string[]

  Get all files that have been considered during dataflow analysis.

  Returns readonly string[]

exists

• exists(p: string, ignoreCase: boolean): string | undefined

  Check if a file exists at the given path, optionally ignoring case.

  Parameters

  • p: string
  • ignoreCase: boolean

    Whether to ignore case when checking for the file.

    Please note that this method checks the file system based on the configuration (see FlowrConfig.project.resolveUnknownPathsOnDisk).

  Returns string | undefined

  The actual path of the file if it exists, otherwise undefined.

getAllFiles

• getAllFiles(): FlowrFileProvider<{ toString(): string }>[]

  Get all files known to this context.

  Returns FlowrFileProvider<{ toString(): string }>[]

  An array of all files.

getFilesByRole

• getFilesByRole<Role extends FileRole>(role: Role): RoleBasedFiles[Role]

  Get all requests that have been added to this context.

  Type Parameters

  • Role extends FileRole

  Parameters

  • role: Role

  Returns RoleBasedFiles[Role]

  Example: If you want to obtain all description files, use

  getFilesByRole(SpecialFileRole.Description)
  Copy

hasCached

• hasCached(path: string): boolean

  Check if the context has a cached file with the given path.

  Parameters

  • path: string

    The path to the file.

  Returns boolean

hasFile

• hasFile(path: string): boolean

  Check if the context has a file with the given path. Please note, that this may also check the file system, depending on the configuration (see FlowrConfig.project.resolveUnknownPathsOnDisk).

  Parameters

  • path: string

    The path to the file.

    If you do not know the exact path or, e.g., casing of the file, use exists instead.

  Returns boolean

reset

• reset(): void

  Reset the context to its initial state.

  Returns void

resolveRequest

• resolveRequest(r: RParseRequest): { path?: string; r: RParseRequestFromText }

  Until parsers support multiple request types from the virtual context system, we resolve their contents.

  Parameters

  • r: RParseRequest

  Returns { path?: string; r: RParseRequestFromText }