Making valueDeclarations read-only and deriving them from symbols

Fraunhofer-AISEC · May 3, 2024 · cd64e28 · cd64e28
1 parent b40a1ce
commit cd64e28
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 10 deletions.
diff --git a/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/ScopeManager.kt b/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/ScopeManager.kt
@@ -164,9 +164,11 @@ class ScopeManager : ScopeProvider {
                     // will add it to the underlying AST node as well. This was already done by the
                     // respective sub-scope manager. We add it directly to the declarations array
                     // instead.
-                    existing.valueDeclarations.addAll(entry.value.valueDeclarations)
                     existing.structureDeclarations.addAll(entry.value.structureDeclarations)
 
+                    // merge symbols
+                    existing.symbols.mergeFrom(entry.value.symbols)
+
                     // copy over the typedefs as well just to be sure
                     existing.typedefs.putAll(entry.value.typedefs)
 
@@ -412,7 +414,7 @@ class ScopeManager : ScopeProvider {
             }
             is ValueDeclaration -> {
                 val scope = this.firstScopeIsInstanceOrNull<ValueDeclarationScope>()
-                scope?.addValueDeclaration(declaration, addToAST)
+                scope?.addDeclaration(declaration, addToAST)
             }
             is EnumDeclaration,
             is RecordDeclaration,

diff --git a/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/graph/scopes/GlobalScope.kt b/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/graph/scopes/GlobalScope.kt
@@ -49,7 +49,6 @@ class GlobalScope : StructureDeclarationScope(null) {
     fun mergeFrom(others: Collection<GlobalScope>) {
         for (other in others) {
             structureDeclarations.addAll(other.structureDeclarations)
-            valueDeclarations.addAll(other.valueDeclarations)
             typedefs.putAll(other.typedefs)
 
             // Make sure, the child scopes of the global scope point to the new global scope parent
@@ -60,10 +59,9 @@ class GlobalScope : StructureDeclarationScope(null) {
             }
 
             // Merge symbols lists
-            for (symbolList in other.symbols) {
-                val list = symbols.computeIfAbsent(symbolList.key) { mutableListOf() }
-                list += symbolList.value
+            symbols.mergeFrom(other.symbols)
 
+            for (symbolList in other.symbols) {
                 // Update the scope property of all nodes that live on the global scope to our new
                 // global scope (this)
                 for (symbol in symbolList.value) {

diff --git a/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/graph/scopes/Scope.kt b/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/graph/scopes/Scope.kt
@@ -210,3 +210,11 @@ private fun MutableList<Declaration>.replaceImports(symbol: Symbol) {
         }
     }
 }
+
+/** This function merges in all entries from the [symbolMap] into the current [SymbolMap]. */
+fun SymbolMap.mergeFrom(symbolMap: SymbolMap) {
+    for (entry in symbolMap) {
+        val list = this.computeIfAbsent(entry.key) { mutableListOf() }
+        list += entry.value
+    }
+}
diff --git a/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/graph/scopes/ValueDeclarationScope.kt b/cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/graph/scopes/ValueDeclarationScope.kt
@@ -40,7 +40,10 @@ import org.slf4j.LoggerFactory
  * Works for if, for, and extends to the block scope
  */
 open class ValueDeclarationScope(override var astNode: Node?) : Scope(astNode) {
-    @Transient var valueDeclarations = mutableListOf<ValueDeclaration>()
+    val valueDeclarations: List<ValueDeclaration>
+        get() {
+            return symbols.flatMap { it.value }.filterIsInstance<ValueDeclaration>()
+        }
 
     /** A map of typedefs keyed by their alias. */
     @Transient val typedefs = mutableMapOf<Type, TypedefDeclaration>()
@@ -68,8 +71,7 @@ open class ValueDeclarationScope(override var astNode: Node?) : Scope(astNode) {
      * @param valueDeclaration the [ValueDeclaration]
      * @param addToAST whether to also add the declaration to the AST of its holder.
      */
-    fun addValueDeclaration(valueDeclaration: ValueDeclaration, addToAST: Boolean) {
-        valueDeclarations.add(valueDeclaration)
+    protected fun addValueDeclaration(valueDeclaration: ValueDeclaration, addToAST: Boolean) {
         if (addToAST) {
             if (astNode is DeclarationHolder) {
                 val holder = astNode as DeclarationHolder

diff --git a/cpg-language-cxx/src/main/kotlin/de/fraunhofer/aisec/cpg/frontends/cxx/DeclaratorHandler.kt b/cpg-language-cxx/src/main/kotlin/de/fraunhofer/aisec/cpg/frontends/cxx/DeclaratorHandler.kt
@@ -283,7 +283,7 @@ class DeclaratorHandler(lang: CXXLanguageFrontend) :
             // AST field, (for now) we only want those methods in there, that were actual AST
             // parents. This is also something that we need to figure out how we want to handle
             // this.
-            parentScope.valueDeclarations.add(declaration)
+            parentScope.addSymbol(declaration.symbol, declaration)
         } else {
             // Add the declaration via the scope manager
             frontend.scopeManager.addDeclaration(declaration)