-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added a LookupScopeStatement
node
#1742
Open
oxisto
wants to merge
1
commit into
main
Choose a base branch
from
search-scope-statement
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.newLookupScopeStatement | ||
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 [newLookupScopeStatement] 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) | ||
} |
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
98 changes: 98 additions & 0 deletions
98
cpg-core/src/test/kotlin/de/fraunhofer/aisec/cpg/graph/StatementBuilderTest.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,98 @@ | ||
/* | ||
* 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 | ||
|
||
import de.fraunhofer.aisec.cpg.ScopeManager | ||
import de.fraunhofer.aisec.cpg.TranslationConfiguration | ||
import de.fraunhofer.aisec.cpg.TranslationContext | ||
import de.fraunhofer.aisec.cpg.TypeManager | ||
import de.fraunhofer.aisec.cpg.frontends.TestLanguageFrontend | ||
import de.fraunhofer.aisec.cpg.graph.builder.translationResult | ||
import de.fraunhofer.aisec.cpg.graph.scopes.GlobalScope | ||
import de.fraunhofer.aisec.cpg.test.assertRefersTo | ||
import kotlin.test.Test | ||
import kotlin.test.assertIs | ||
import kotlin.test.assertNotNull | ||
|
||
class StatementBuilderTest { | ||
@Test | ||
fun testNewLookupScopeStatement() { | ||
val frontend = | ||
TestLanguageFrontend( | ||
ctx = | ||
TranslationContext( | ||
TranslationConfiguration.builder().defaultPasses().build(), | ||
ScopeManager(), | ||
TypeManager() | ||
) | ||
) | ||
val result = | ||
frontend.build { | ||
translationResult { | ||
var tu = | ||
with(frontend) { | ||
var tu = newTranslationUnitDeclaration("main.file") | ||
scopeManager.resetToGlobal(tu) | ||
|
||
var globalA = newVariableDeclaration("a") | ||
scopeManager.addDeclaration(globalA) | ||
|
||
var func = newFunctionDeclaration("main") | ||
scopeManager.enterScope(func) | ||
|
||
var body = newBlock() | ||
scopeManager.enterScope(body) | ||
|
||
var localA = newVariableDeclaration("a") | ||
var stmt = newDeclarationStatement() | ||
stmt.declarations += localA | ||
scopeManager.addDeclaration(localA) | ||
body += stmt | ||
|
||
body += newLookupScopeStatement(listOf("a"), scopeManager.globalScope) | ||
body += newReference("a") | ||
|
||
scopeManager.leaveScope(body) | ||
func.body = body | ||
scopeManager.leaveScope(func) | ||
|
||
scopeManager.addDeclaration(func) | ||
scopeManager.leaveScope(tu) | ||
tu | ||
} | ||
|
||
components.firstOrNull()?.translationUnits?.add(tu) | ||
} | ||
} | ||
|
||
val globalA = result.variables["a"] | ||
assertNotNull(globalA) | ||
assertIs<GlobalScope>(globalA.scope) | ||
|
||
val a = result.refs["a"] | ||
assertRefersTo(a, globalA) | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't get this. Don't we want do do something with
targetScope
? Or add the information to thesymbol
?What's the purpose of this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we are storing the node in predefinedLookupScopes so that it can later be retrieved by lookupSymbol.