cpg-core/de.fraunhofer.aisec.cpg/TranslationConfiguration/Builder

Builder

Example:

TranslationManager.builder()
  .config(TranslationConfiguration.builder()
    .sourceLocations(new File("example.cpp"))
    .defaultPasses()
    .debugParser(true)
    .build())
  .build();

Constructors

Builder

constructor()

Functions

addIncludesToGraph

fun addIncludesToGraph(addIncludesToGraph: Boolean): TranslationConfiguration.Builder

Adds all required includes.

build

fun build(): TranslationConfiguration

codeInNodes

fun codeInNodes(b: Boolean): TranslationConfiguration.Builder

configurePass

inline fun <T : Pass<*>> configurePass(config: PassConfiguration): TranslationConfiguration.Builder

fun <T : Pass<*>> configurePass(clazz: KClass<T>, config: PassConfiguration): TranslationConfiguration.Builder

debugParser

fun debugParser(debugParser: Boolean): TranslationConfiguration.Builder

Dump parser debug output to the logs (Caution: this will generate a lot of output).

defaultPasses

fun defaultPasses(): TranslationConfiguration.Builder

disableCleanup

fun disableCleanup(): TranslationConfiguration.Builder

exclusionPatterns

fun exclusionPatterns(vararg patterns: String): TranslationConfiguration.Builder

Adds exclusion patterns for filtering files and directories.

fun exclusionPatterns(vararg patterns: Regex): TranslationConfiguration.Builder

Adds exclusion patterns using regular expressions for filtering files and directories.

failOnError

fun failOnError(failOnError: Boolean): TranslationConfiguration.Builder

Fail analysis on first error. Try to continue otherwise.

includeBlocklist

fun includeBlocklist(includeFile: Path): TranslationConfiguration.Builder

fun includeBlocklist(includeFile: String): TranslationConfiguration.Builder

Adds the specified file to the include blocklist. Relative and absolute paths are supported.

includePath

fun includePath(includePath: Path): TranslationConfiguration.Builder

fun includePath(includePath: String): TranslationConfiguration.Builder

Directory containing include headers.

includeWhitelist

fun includeWhitelist(includeFile: Path): TranslationConfiguration.Builder

fun includeWhitelist(includeFile: String): TranslationConfiguration.Builder

Adds the specified file to the include whitelist. Relative and absolute paths are supported.

inferenceConfiguration

fun inferenceConfiguration(configuration: InferenceConfiguration): TranslationConfiguration.Builder

loadIncludes

fun loadIncludes(loadIncludes: Boolean): TranslationConfiguration.Builder

Load C/C++ include headers before the analysis.

matchCommentsToNodes

fun matchCommentsToNodes(matchCommentsToNodes: Boolean): TranslationConfiguration.Builder

Match comments found in source files to nodes according to a heuristic.

optionalLanguage

fun optionalLanguage(className: String): TranslationConfiguration.Builder

Safely register an additional Language from a class name. If the Language given by the class name could not be loaded or instantiated, no Language is registered and no error is thrown. Please have a look at registerLanguage if an error should be thrown in case the language could not be registered.

processAnnotations

fun processAnnotations(b: Boolean): TranslationConfiguration.Builder

Specifies, whether annotations should be process or not. By default, they are not processed, since they might populate the graph too much.

registerFunctionSummaries

fun registerFunctionSummaries(vararg functionSummary: File): TranslationConfiguration.Builder

registerLanguage

inline fun <T : Language<*>> registerLanguage(): TranslationConfiguration.Builder

fun registerLanguage(language: Language<*>): TranslationConfiguration.Builder

Registers an additional Language.

fun registerLanguage(className: String): TranslationConfiguration.Builder

Loads and registers an additional Language based on a fully qualified class name (FQN).

registerPass

inline fun <P : Pass<*>> registerPass(): TranslationConfiguration.Builder

fun registerPass(passType: KClass<out Pass<*>>): TranslationConfiguration.Builder

replacePass

inline fun <OldPass : Pass<*>, For : Language<*>, With : Pass<*>> replacePass(): TranslationConfiguration.Builder

fun replacePass(passType: KClass<out Pass<*>>, forLanguage: KClass<out Language<*>>, with: KClass<out Pass<*>>): TranslationConfiguration.Builder

softwareComponents

fun softwareComponents(softwareComponents: MutableMap<String, List<File>>): TranslationConfiguration.Builder

Files or directories containing the source code to analyze organized by different components

sourceLocations

fun sourceLocations(vararg sourceLocations: File): TranslationConfiguration.Builder

fun sourceLocations(sourceLocations: List<File>): TranslationConfiguration.Builder

Files or directories containing the source code to analyze. Generates a dummy software component called "application".

symbols

fun symbols(symbols: Map<String, String>): TranslationConfiguration.Builder

topLevel

fun topLevel(topLevel: File?): TranslationConfiguration.Builder

unregisterLanguage

fun unregisterLanguage(language: Class<out Language<*>?>): TranslationConfiguration.Builder

Unregisters a registered de.fraunhofer.aisec.cpg.frontends.Language.

useCompilationDatabase

fun useCompilationDatabase(compilationDatabase: CompilationDatabase?): TranslationConfiguration.Builder

useParallelFrontends

fun useParallelFrontends(b: Boolean): TranslationConfiguration.Builder

If true, the ASTs for the source files are parsed in parallel, but the passes afterwards will still run in a single thread. This speeds up initial parsing but makes sure that further graph enrichment algorithms remain correct.

useParallelPasses

fun useParallelPasses(b: Boolean): TranslationConfiguration.Builder

useUnityBuild

fun useUnityBuild(b: Boolean): TranslationConfiguration.Builder

Only relevant for C++. A unity build refers to a build that consolidates all translation units into a single one, which has the advantage that header files are only processed once, adding far less duplicate nodes to the graph