cpg-core/de.fraunhofer.aisec.cpg.graph.scopes/GlobalScope

GlobalScope

class GlobalScope : StructureDeclarationScope

This should ideally only be called once. It constructs a new global scope, which is not associated to any AST node. However, depending on the language, a language frontend can explicitly set the ast node using ScopeManager.resetToGlobal if the language needs a global scope that is restricted to a translation unit, i.e. C++ while still maintaining a unique list of global variables.

Constructors

GlobalScope

constructor()

Properties

astNode

override var astNode: Node?

children

@Transient

var children: MutableList<Scope>

The list of child scopes.

globalScope

val globalScope: Scope?

Returns the GlobalScope of this scope by traversing its parents upwards.

var id: Long?

Required field for object graph mapping. It contains the scope id.

labelStatements

@Transient

var labelStatements: MutableMap<String, LabelStatement>

name

var name: Name?

The real new name

parent

var parent: Scope?

Scopes are nested and therefore have a parent child relationship, this two members will help navigate through the scopes,e.g. when looking up variables.

predefinedLookupScopes

@Transient

var predefinedLookupScopes: MutableMap<Symbol, LookupScopeStatement>

In some languages, the lookup scope of a symbol that is being resolved (e.g. of a Reference) can be adjusted through keywords (such as global in Python or PHP).

scopedName

var scopedName: String?

FQN Name currently valid

structureDeclarations

val structureDeclarations: List<Declaration>

symbols

@Transient

var symbols: SymbolMap

A map of symbols and their respective Declaration nodes that declare them.

typedefs

@Transient

val typedefs: MutableMap<Name, TypedefDeclaration>

A map of typedefs keyed by their alias name. This is still needed as a bridge until we completely redesign the alias / typedef system.

valueDeclarations

val valueDeclarations: List<ValueDeclaration>

wildcardImports

@Transient

var wildcardImports: MutableSet<ImportDeclaration>

A list of ImportDeclaration nodes that have ImportDeclaration.wildcardImport set to true.

Functions

addDeclaration

open override fun addDeclaration(declaration: Declaration, addToAST: Boolean)

addLabelStatement

fun addLabelStatement(labelStatement: LabelStatement)

addSymbol

fun addSymbol(symbol: Symbol, declaration: Declaration)

Adds a declaration with the defined symbol.

addSymbols

fun addSymbols(other: MutableMap<Symbol, MutableSet<Declaration>>)

addTypedef

fun addTypedef(typedef: TypedefDeclaration)

equals

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

hashCode

open override fun hashCode(): Int

isBreakable

fun isBreakable(): Boolean

isContinuable

fun isContinuable(): Boolean

lookupSymbol

fun lookupSymbol(symbol: Symbol, thisScopeOnly: Boolean = false, replaceImports: Boolean = true, predicate: (Declaration) -> Boolean? = null): List<Declaration>

Looks up a list of Declaration nodes for the specified symbol. Optionally, predicate can be used for additional filtering.

mergeFrom

fun mergeFrom(others: Collection<GlobalScope>)

Because the way we currently handle parallel parsing in TranslationManager.parseParallel, we end up with multiple GlobalScope objects, one for each TranslationUnitDeclaration. In the end, we need to merge all these different scopes into one final global scope. To be somewhat consistent with the behaviour of TranslationManager.parseSequentially, we assign the last translation unit declaration we see to the AST node of the GlobalScope. This is not completely ideal, but the best we can do for now.

toString

open override fun toString(): String