Skip to content

Overlay: Add script to help maintain overlay annotations #19778

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.

Sign up for GitHub

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

Merged
kaspersv merged 3 commits into from
Jun 24, 2025
Merged

Overlay: Add script to help maintain overlay annotations #19778

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd2fe64
Add script to add overlay annotations
kaspersv May 30, 2025
b1346e2
Address copilot review comments
kaspersv Jun 17, 2025
ed8b787
rename overlay[caller] to overlay[caller?]
kaspersv Jun 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions config/add-overlay-annotations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# This script is used to annotate .qll files without any existing overlay annotations
# with overlay[local?] and overlay[caller] annotations. Maintenance of overlay annotations
# with overlay[local?] and overlay[caller?] annotations. Maintenance of overlay annotations
# in annotated files will be handled by QL-for-QL queries.

# It will walk the directory tree and annotate most .qll files, skipping only
Expand All @@ -24,7 +24,7 @@ def has_overlay_annotations(lines):
'''
Check whether the given lines contain any overlay[...] annotations.
'''
overlays = ["local", "local?", "global", "caller"]
overlays = ["local", "local?", "global", "caller", "caller?"]
annotations = [f"overlay[{t}]" for t in overlays]
return any(ann in line for ann in annotations for line in lines)

Expand Down Expand Up @@ -165,15 +165,15 @@ def insert_toplevel_maybe_local_annotation(filename, lines):

def insert_overlay_caller_annotations(lines):
'''
Mark pragma[inline] predicates as overlay[caller] if they are not declared private.
Mark pragma[inline] predicates as overlay[caller?] if they are not declared private.
'''
out_lines = []
for i, line in enumerate(lines):
trimmed = line.strip()
if trimmed == "pragma[inline]":
if i + 1 < len(lines) and not "private" in lines[i+1]:
whitespace = line[0: line.find(trimmed)]
out_lines.append(f"{whitespace}overlay[caller]\n")
out_lines.append(f"{whitespace}overlay[caller?]\n")
out_lines.append(line)
return out_lines

Expand Down