cpg-core/de.fraunhofer.aisec.cpg.frontends/CompilationDatabase

CompilationDatabase

class CompilationDatabase : ArrayList<CompilationDatabase.CompilationDatabaseEntry>

A compilation database contains necessary information about the include paths and possible compiler flags that should be used for an individual source file. It follows the JSON Compilation Database Format Specification (see https://clang.llvm.org/docs/JSONCompilationDatabase.html).

It is basically a list of CompilationDatabaseEntry entries. For now, we are primarily interested in the include paths, but in the future, we might extend this to other compiler flags.

Constructors

CompilationDatabase

constructor()

Types

object Companion

CompilationDatabaseEntry

data class CompilationDatabaseEntry(val directory: String?, val command: String? = null, val arguments: List<String>? = null, val file: String, val output: String?)

This is the structure of how each object inside compile_commands.json looks like.

ParsedCompilationDatabaseEntry

data class ParsedCompilationDatabaseEntry(val includes: MutableList<String> = mutableListOf(), var component: String = DEFAULT_COMPONENT, var arch: String? = null)

This represents a parsed CompilationDatabaseEntry with all necessary information extracted.

Properties

allIncludePaths

val allIncludePaths: List<String>

Returns the include paths for all files in compilation database.

val Collection<Type>.commonType: Type?

This computed property returns the common type in a Collection of Type objects. For example, if two types A and B both derive from the interface C`` then C` would be returned.

var components: MutableMap<ComponentName, MutableList<File>>

A cached list of components and their files. Can be used to supply TranslationConfiguration.softwareComponents with the necessary files to parse for each component.

open override val size: Int

val sourceFiles: List<File>

Functions

open override fun add(element: CompilationDatabase.CompilationDatabaseEntry): Boolean

open override fun add(index: Int, element: CompilationDatabase.CompilationDatabaseEntry)

fun <EdgeType : Edge<Node>> MutableList<Node>.add(target: Node, builder: EdgeType.() -> Unit): Boolean

open override fun addAll(elements: Collection<CompilationDatabase.CompilationDatabaseEntry>): Boolean

open override fun addAll(index: Int, elements: Collection<CompilationDatabase.CompilationDatabaseEntry>): Boolean

fun addIncludePath(srcFile: File, paths: List<String>)

fun TypeOperations.apply(root: Type): Type

Wraps the given Type into a chain of PointerTypes and ReferenceTypes, given the operations in TypeOperations.

fun <T : Node> Collection<T>?.byNameOrNull(lookup: String, modifier: SearchModifier): T?

This function returns the first node that matches the name on the supplied list of nodes.

open override fun clear()

open override fun clone(): Any

open operator override fun contains(element: CompilationDatabase.CompilationDatabaseEntry): Boolean

open override fun containsAll(elements: Collection<CompilationDatabase.CompilationDatabaseEntry>): Boolean

open fun ensureCapacity(p0: Int)

open operator override fun equals(other: Any?): Boolean

open override fun forEach(p0: Consumer<in CompilationDatabase.CompilationDatabaseEntry>)

open operator override fun get(index: Int): CompilationDatabase.CompilationDatabaseEntry

operator fun <T : Node> Collection<T>?.get(predicate: (T) -> Boolean, modifier: SearchModifier = SearchModifier.NONE): T?

A shortcut to call firstOrNull using the [] syntax.

operator fun <T : Node> Collection<T>?.get(lookup: String, modifier: SearchModifier = SearchModifier.NONE): T?

A shortcut to call byNameOrNull using the [] syntax.

fun getAllSymbols(name: ComponentName): MutableMap<String, String>

Returns all defined symbols for the specified component.

getIncludePaths

fun getIncludePaths(file: File): List<String>?

Returns the include paths for the specified file.

fun getSymbols(name: ComponentName, file: File): Map<String, String>?

Returns defined symbols for the specified file and component.

open override fun hashCode(): Int

open override fun indexOf(element: CompilationDatabase.CompilationDatabaseEntry): Int

operator fun <T : Node> Collection<T>.invoke(predicate: (T) -> Boolean): List<T>

A shortcut invoke filter on a list of nodes.

operator fun <T : Node> Collection<T>.invoke(lookup: String): List<T>

A shortcut to filter a list of nodes by their name.

inline operator fun <T> List<Node>.invoke(i: Int = 0): T?

Returns the i-th item in this list (or null) and casts it to T.

open override fun isEmpty(): Boolean

open operator override fun iterator(): MutableIterator<CompilationDatabase.CompilationDatabaseEntry>

open override fun lastIndexOf(element: CompilationDatabase.CompilationDatabaseEntry): Int

open override fun listIterator(): MutableListIterator<CompilationDatabase.CompilationDatabaseEntry>

open override fun listIterator(index: Int): MutableListIterator<CompilationDatabase.CompilationDatabaseEntry>

open fun parallelStream(): Stream<CompilationDatabase.CompilationDatabaseEntry>

open override fun remove(element: CompilationDatabase.CompilationDatabaseEntry): Boolean

open override fun removeAll(elements: Collection<CompilationDatabase.CompilationDatabaseEntry>): Boolean

open override fun removeAt(p0: Int): CompilationDatabase.CompilationDatabaseEntry

open override fun removeIf(p0: Predicate<in CompilationDatabase.CompilationDatabaseEntry>): Boolean

open override fun replaceAll(p0: UnaryOperator<CompilationDatabase.CompilationDatabaseEntry>)

open override fun retainAll(elements: Collection<CompilationDatabase.CompilationDatabaseEntry>): Boolean

open operator override fun set(index: Int, element: CompilationDatabase.CompilationDatabaseEntry): CompilationDatabase.CompilationDatabaseEntry

open override fun sort(p0: Comparator<in CompilationDatabase.CompilationDatabaseEntry>)

open override fun spliterator(): Spliterator<CompilationDatabase.CompilationDatabaseEntry>

open fun stream(): Stream<CompilationDatabase.CompilationDatabaseEntry>

open override fun subList(fromIndex: Int, toIndex: Int): MutableList<CompilationDatabase.CompilationDatabaseEntry>

open override fun toArray(): Array<Any>

open override fun <T : Any> toArray(p0: Array<T>): Array<T>

open fun <T : Any> ~~toArray~~(p0: IntFunction<Array<T>>): Array<T>

fun <T> Collection<T>.toIdentitySet(): IdentitySet<T>

open override fun toString(): String

open fun trimToSize()