-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This PR adds a new node type `LookupScopeStatement`, which can be used to adjust the lookup scope of symbols that are resolved in the current scope. Most prominent examples are Python's `global` and `nonlocal` statements. Support for python will be added in a later PR. This will only add the node and provides the basic functionality in the lookup.
- Loading branch information
Showing
4 changed files
with
181 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
cpg-core/src/main/kotlin/de/fraunhofer/aisec/cpg/graph/statements/LookupScopeStatement.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| /* | ||
| * Copyright (c) 2024, Fraunhofer AISEC. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * $$$$$$\ $$$$$$$\ $$$$$$\ | ||
| * $$ __$$\ $$ __$$\ $$ __$$\ | ||
| * $$ / \__|$$ | $$ |$$ / \__| | ||
| * $$ | $$$$$$$ |$$ |$$$$\ | ||
| * $$ | $$ ____/ $$ |\_$$ | | ||
| * $$ | $$\ $$ | $$ | $$ | | ||
| * \$$$$$ |$$ | \$$$$$ | | ||
| * \______/ \__| \______/ | ||
| * | ||
| */ | ||
| package de.fraunhofer.aisec.cpg.graph.statements | ||
|
|
||
| import de.fraunhofer.aisec.cpg.graph.newSearchScopeStatement | ||
| import de.fraunhofer.aisec.cpg.graph.scopes.Scope | ||
| import de.fraunhofer.aisec.cpg.graph.scopes.Symbol | ||
| import de.fraunhofer.aisec.cpg.graph.statements.expressions.Reference | ||
| import java.util.Objects | ||
|
|
||
| /** | ||
| * This statement modifies the lookup scope of one or more [Reference] nodes (or more precise it's | ||
| * symbols) within the current [Scope]. The most prominent example of this are the Python `global` | ||
| * and `nonlocal` keywords. | ||
| * | ||
| * This node itself does not implement the actual functionality. It is necessary to add this node | ||
| * (or the information therein) to [Scope.predefinedLookupScopes]. The reason for this is that we | ||
| * want to avoid AST traversals in the scope/identifier lookup. | ||
| * | ||
| * The [newSearchScopeStatement] node builder will add this automatically, so it is STRONGLY | ||
| * encouraged that the node builder is used instead of creating the node itself. | ||
| */ | ||
| class LookupScopeStatement : Statement() { | ||
|
|
||
| /** The symbols this statement affects. */ | ||
| var symbols: List<Symbol> = listOf() | ||
|
|
||
| /** The target scope to which the references are referring to. */ | ||
| var targetScope: Scope? = null | ||
|
|
||
| override fun equals(other: Any?): Boolean { | ||
| if (this === other) return true | ||
| if (other !is LookupScopeStatement) return false | ||
| return super.equals(other) && symbols == other.symbols && targetScope == other.targetScope | ||
| } | ||
|
|
||
| override fun hashCode() = Objects.hash(super.hashCode(), symbols, targetScope) | ||
| } |
67 changes: 67 additions & 0 deletions
67
cpg-core/src/test/kotlin/de/fraunhofer/aisec/cpg/graph/scopes/ScopeTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright (c) 2024, Fraunhofer AISEC. All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * $$$$$$\ $$$$$$$\ $$$$$$\ | ||
| * $$ __$$\ $$ __$$\ $$ __$$\ | ||
| * $$ / \__|$$ | $$ |$$ / \__| | ||
| * $$ | $$$$$$$ |$$ |$$$$\ | ||
| * $$ | $$ ____/ $$ |\_$$ | | ||
| * $$ | $$\ $$ | $$ | $$ | | ||
| * \$$$$$ |$$ | \$$$$$ | | ||
| * \______/ \__| \______/ | ||
| * | ||
| */ | ||
| package de.fraunhofer.aisec.cpg.graph.scopes | ||
|
|
||
| import de.fraunhofer.aisec.cpg.graph.Name | ||
| import de.fraunhofer.aisec.cpg.graph.declarations.VariableDeclaration | ||
| import de.fraunhofer.aisec.cpg.graph.statements.LookupScopeStatement | ||
| import de.fraunhofer.aisec.cpg.graph.statements.expressions.Block | ||
| import kotlin.test.Test | ||
| import kotlin.test.assertEquals | ||
|
|
||
| class ScopeTest { | ||
| @Test | ||
| fun testLookup() { | ||
| // some mock variable declarations, global and local | ||
| var globalA = VariableDeclaration() | ||
| globalA.name = Name("a") | ||
| var localA = VariableDeclaration() | ||
| localA.name = Name("a") | ||
|
|
||
| // two scopes, global and local | ||
| val globalScope = GlobalScope() | ||
| globalScope.addSymbol("a", globalA) | ||
| val scope = BlockScope(Block()) | ||
| scope.parent = globalScope | ||
| scope.addSymbol("a", localA) | ||
|
|
||
| // if we try to resolve "a" now, this should point to the local A since we start there and | ||
| // move upwards | ||
| var result = scope.lookupSymbol("a") | ||
| assertEquals(listOf(localA), result) | ||
|
|
||
| // now, we pretend to have a lookup scope modifier for a symbol, e.g. through "global" in | ||
| // Python | ||
| var stmt = LookupScopeStatement() | ||
| stmt.targetScope = globalScope | ||
| stmt.symbols = listOf("a") | ||
| scope.predefinedLookupScopes["a"] = stmt | ||
|
|
||
| // let's try the lookup again, this time it should point to the global A | ||
| result = scope.lookupSymbol("a") | ||
| assertEquals(listOf(globalA), result) | ||
| } | ||
| } |