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

FileScope

class FileScope(var astNode: TranslationUnitDeclaration?) : Scope

Represents a scope that is only visible in the current file. This is usually used in programming languages for file-level imports.

The only supported AST node is a TranslationUnitDeclaration.

Constructors

constructor(astNode: TranslationUnitDeclaration?)

Properties

open var astNode: Node?

var children: MutableList<Scope>

The list of child scopes.

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

var labelStatements: MutableMap<String, LabelStatement>

var name: Name?

The real new name

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

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).

var scopedName: String?

FQN Name currently valid

var symbols: SymbolMap

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

wildcardImports

var wildcardImports: MutableSet<ImportDeclaration>

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

Functions

addLabelStatement

fun addLabelStatement(labelStatement: LabelStatement)

fun addSymbol(symbol: Symbol, declaration: Declaration)

Adds a declaration with the defined symbol.

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

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

open override fun hashCode(): Int

fun isBreakable(): Boolean

fun isContinuable(): Boolean

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.

open override fun toString(): String