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

Companion

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 = "application", var arch: String? = null)

This represents a parsed CompilationDatabaseEntry with all necessary information extracted.

Functions

add

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

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

addAll

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

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

addIncludePath

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

byNameOrNull

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.

clear

open override fun clear()

clone

open override fun clone(): Any

contains

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

containsAll

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

ensureCapacity

open fun ensureCapacity(p0: Int)

equals

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

forEach

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

get

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

get

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.

getIncludePaths

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

Returns the include paths for the specified file.

getSymbols

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

Returns defined symbols for the specified file.

hashCode

open override fun hashCode(): Int

indexOf

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

invoke

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.

isEmpty

open override fun isEmpty(): Boolean

iterator

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

lastIndexOf

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

listIterator

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

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

parallelStream

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

remove

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

removeAll

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

removeAt

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

removeIf

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

replaceAll

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

retainAll

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

set

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

sort

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

spliterator

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

stream

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

subList

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

toArray

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>

toString

open override fun toString(): String

trimToSize

open fun trimToSize()

Properties

allIncludePaths

val allIncludePaths: List<String>

Returns the include paths for all files in compilation database.

components

val components: MutableMap<String, 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.

size

open override val size: Int

sourceFiles

val sourceFiles: List<File>