Class clava

constructor

• new clava(): clava

• Returns clava

StaticuseSpecsLogger

StaticaddExistingFile

• addExistingFile(path): void

• Parameters

  • path: string | File

    Path to an existing source file that will be added to the AST. If the file does not exists, throws an exception.

  Returns void

StaticaddFile

• addFile($file): void

• Parameters

  • $file: FileJp

    The file to add to the AST.

  Returns void

StaticclearAstHistory

• clearAstHistory(): void

• Clears all ASTs except for the one at the top of the stack. If there is one of none AST on the stack does nothing.

  Returns void

StaticfindJp

• findJp($jp): any

• Looks for a join point in the current AST.

  Parameters

  • $jp: Joinpoint

    A join point from any AST

  Returns any

  The equivalent join point from the AST at the top of the current AST stack

StaticgetAvailableIncludes

• getAvailableIncludes(): List<Include>

• Returns List<Include>

  A list of join points representing available user includes

StaticgetBaseFolder

• getBaseFolder(): string

• Returns string

  The folder of the first input source element, either itself, if a folder, or the parent folder, if it is a file.

StaticgetData

• getData(): clavaDataStore

• Returns clavaDataStore

  DataStore with the data of the current weaver

StaticgetIncludeFolders

• getIncludeFolders(): any

• Returns any

  A set with paths to the include folders of the current configuration.

StaticgetProgram

• getProgram(): Program

• Returns Program

  The join point $program.

StaticgetStackSize

• getStackSize(): any

• The current number of elements in the AST stack.

  Returns any

StaticgetStandard

• getStandard(): string

• Returns the standard being used for compilation.

  Returns string

StaticgetWeavingFolder

• getWeavingFolder(): string

• Returns string

  The folder where the code represented by the AST will be written at the end of execution.

StaticisCxx

• isCxx(): boolean

• Returns boolean

StaticpopAst

• popAst(): void

• Discards the AST at the top of the current AST stack.

  Returns void

StaticpushAst

• pushAst($program?): void

• Creates a clone of the current AST and pushes the clone to the top of the current AST stack. If a $program join point is passed, that join point is added to the top of the stack instead.

  Parameters

  • Optional$program: Program

    program to push to the AST.

  Returns void

Staticrebuild

• rebuild(): boolean

• Returns boolean

StaticrebuildFuzzy

• rebuildFuzzy(): void

• Returns void

StaticrunClava

• runClava(args): boolean

• Launches a Clava weaving session.

  Parameters

  • args: string | any[]

    The arguments to pass to the weaver, as if it was launched from the command-line

  Returns boolean

  True if the weaver execution without problems, false otherwise

StaticrunClavaParallel

• runClavaParallel(argsLists, threads?, clavaCommand?): any[]

• Launches several Clava weaving sessions in parallel.

  Parameters

  • argsLists: string[][]

    An array where each element is an array with the arguments to pass to the weaver, as if it was launched from the command-line
  • threads: number = -1

    Number of threads to use
  • clavaCommand: string | string[] = ...

    The command we should use to call Clava (e.g., /usr/local/bin/clava)

  Returns any[]

  The results of each execution

StaticwriteCode

• writeCode(outputFoldername): File

• Writes the code of the current AST to the given folder.

  Parameters

  • outputFoldername: string

  Returns File