Package de.fraunhofer.aisec.cpg

Class TranslationConfiguration.Builder

java.lang.Object

de.fraunhofer.aisec.cpg.TranslationConfiguration.Builder

Enclosing class:

TranslationConfiguration

public static class TranslationConfiguration.Builder
extends java.lang.Object

Builds a TranslationConfiguration.

Example:

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TranslationConfiguration	build()
TranslationConfiguration.Builder	codeInNodes(boolean b)
TranslationConfiguration.Builder	debugParser(boolean debugParser)	Dump parser debug output to the logs (Caution: this will generate a lot of output).
TranslationConfiguration.Builder	defaultPasses()	Register all default Passes.
TranslationConfiguration.Builder	disableCleanup()
TranslationConfiguration.Builder	failOnError(boolean failOnError)	Fail analysis on first error.
TranslationConfiguration.Builder	includeBlacklist(java.lang.String includeFile)	Adds the specified file to the include blacklist.
TranslationConfiguration.Builder	includePath(java.lang.String includePath)	Directory containing include headers.
TranslationConfiguration.Builder	includeWhitelist(java.lang.String includeFile)	Adds the specified file to the include whitelist.
TranslationConfiguration.Builder	loadIncludes(boolean loadIncludes)	Load C/C++ include headers before the analysis.
TranslationConfiguration.Builder	processAnnotations(boolean b)	Specifies, whether annotations should be process or not.
TranslationConfiguration.Builder	registerPass(@NonNull Pass pass)	Register an additional Pass.
TranslationConfiguration.Builder	sourceLocations(java.io.File... sourceLocations)	Files or directories containing the source code to analyze.
TranslationConfiguration.Builder	sourceLocations(java.util.List<java.io.File> sourceLocations)	Files or directories containing the source code to analyze
TranslationConfiguration.Builder	symbols(java.util.Map<java.lang.String,java.lang.String> symbols)
TranslationConfiguration.Builder	topLevel(java.io.File topLevel)
TranslationConfiguration.Builder	useUnityBuild(boolean b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

symbols

public TranslationConfiguration.Builder symbols(java.util.Map<java.lang.String,java.lang.String> symbols)

sourceLocations

public TranslationConfiguration.Builder sourceLocations(java.io.File... sourceLocations)

Files or directories containing the source code to analyze.

Parameters:

sourceLocations -

Returns:

sourceLocations

public TranslationConfiguration.Builder sourceLocations(java.util.List<java.io.File> sourceLocations)

Files or directories containing the source code to analyze

Parameters:

sourceLocations -

Returns:

topLevel

public TranslationConfiguration.Builder topLevel(java.io.File topLevel)

debugParser

public TranslationConfiguration.Builder debugParser(boolean debugParser)

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

Parameters:

debugParser -

Returns:

failOnError

public TranslationConfiguration.Builder failOnError(boolean failOnError)

Fail analysis on first error. Try to continue otherwise.

Parameters:

failOnError -

Returns:

loadIncludes

public TranslationConfiguration.Builder loadIncludes(boolean loadIncludes)

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

Required for macro expansion.

Parameters:

loadIncludes -

Returns:

includePath

public TranslationConfiguration.Builder includePath(java.lang.String includePath)

Directory containing include headers.

Parameters:

includePath -

Returns:

includeWhitelist

public TranslationConfiguration.Builder includeWhitelist(java.lang.String includeFile)

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

Parameters:

includeFile -

Returns:

disableCleanup

public TranslationConfiguration.Builder disableCleanup()

includeBlacklist

public TranslationConfiguration.Builder includeBlacklist(java.lang.String includeFile)

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

Parameters:

includeFile -

Returns:

registerPass

public TranslationConfiguration.Builder registerPass(@NonNull Pass pass)

Register an additional Pass.

Parameters:

pass -

Returns:

defaultPasses

public TranslationConfiguration.Builder defaultPasses()

Register all default Passes.

This will register

1. FilenameMapper
2. TypeHierarchyResolver
3. ImportResolver
4. VariableUsageResolver
5. CallResolver
6. EvaluationOrderGraphPass
7. TypeResolver

to be executed exactly in the specified order

Returns:

codeInNodes

public TranslationConfiguration.Builder codeInNodes(boolean b)

processAnnotations

public TranslationConfiguration.Builder processAnnotations(boolean b)

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

Parameters:

b - the new value

Returns:

useUnityBuild

public TranslationConfiguration.Builder useUnityBuild(boolean b)

build

public TranslationConfiguration build()