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

addFile

• addFile(
      file:
          | string
          | RParseRequestFromFile<ParseRequestAdditionalInfoBase>
          | FlowrFileProvider<string>,
      role?: SpecialFileRole,
  ): void

  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<ParseRequestAdditionalInfoBase>
        | FlowrFileProvider<string>
  • Optionalrole: SpecialFileRole

  Returns void

addFiles

• addFiles(
      ...files: (
          | string
          | RParseRequestFromFile<ParseRequestAdditionalInfoBase>
          | FlowrFileProvider<string>
      )[],
  ): void

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

  Parameters

  • ...files: (
        | string
        | RParseRequestFromFile<ParseRequestAdditionalInfoBase>
        | FlowrFileProvider<string>
    )[]

  Returns void

addRequest

• addRequest(request: RAnalysisRequest): void

  Add a request to the context. If the request is of type project, it will be expanded using the registered FlowrAnalyzerProjectDiscoveryPlugins.

  Parameters

  • request: RAnalysisRequest

  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[]

getFilesByRole

• getFilesByRole<Role extends SpecialFileRole>(role: Role): SpecialFiles[Role]

  Get all requests that have been added to this context.

  Type Parameters

  • Role extends SpecialFileRole

  Parameters

  • role: Role

  Returns SpecialFiles[Role]

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

  getFilesByRole(SpecialFileRole.Description)
  Copy

reset

• reset(): void

  Reset the context to its initial state.

  Returns void