Global functions in SyncBromaScript

hiimjasmine00 · hiimjasmine00 · commit cfb42cea3496 · 2025-04-03T13:14:16.000-04:00
diff --git a/scripts/ghidra/Broma.java b/scripts/ghidra/Broma.java
@@ -213,7 +213,7 @@ public String getName() {
         
         public CConv getCallingConvention(Platform platform) {
             if (platform != Platform.WINDOWS32) {
-                if (dispatch.isEmpty() || !dispatch.get().value.contains("static")) return CConv.THISCALL;
+                if (parent != null && (dispatch.isEmpty() || !dispatch.get().value.contains("static"))) return CConv.THISCALL;
 
                 switch (platform) {
                     case WINDOWS64:
@@ -378,6 +378,7 @@ public List<Function> getFunctions(String name) {
      */
     private final List<Patch> patches;
     public final List<Class> classes;
+    public final List<Function> functions;
     private boolean committed = false;
 
     private Matcher forkMatcher(Pattern regex, Matcher of, String group, boolean find) {
@@ -393,13 +394,19 @@ private void applyRegexes(Platform platform) {
         while (matcher.find()) {
             this.classes.add(new Class(this, platform, matcher));
         }
+
+        var funMatcher = Regexes.GRAB_GLOBAL_FUNCTION.matcher(this.data);
+        while (funMatcher.find()) {
+            this.functions.add(new Function(this, null, platform, funMatcher));
+        }
     }
 
     private Broma() {
         this.path = null;
         this.data = null;
         this.patches = null;
         this.classes = null;
+        this.functions = null;
     }
 
     public static Broma fake() {
@@ -416,6 +423,7 @@ public Broma(Path path, Platform platform) throws IOException {
         data = Files.readString(path);
         patches = new ArrayList<Patch>();
         classes = new ArrayList<Class>();
+        functions = new ArrayList<Function>();
         this.applyRegexes(platform);
     }
 
diff --git a/scripts/ghidra/Regexes.java b/scripts/ghidra/Regexes.java
@@ -69,6 +69,32 @@ public static final Pattern grabFunction(String funName) {
             Pattern.DOTALL | Pattern.MULTILINE
         );
     }
+    public static final Pattern grabGlobalFunction(String funName) {
+        return Pattern.compile(
+            formatRegex(
+                // Grab attributes
+                "(?<attrs>\\[\\[.*?\\]\\]\\s*)?" +
+                // Must match start of line (MULTILINE flag required)
+                "(?<=^)" + 
+                // Get the dispatch modifier keyword if one is defined
+                "(?<dispatch>(?:inline|virtual|static|callback)\\s+)?" +
+                // Grab the return type and name of the function, or the name if it's a destructor
+                "(?:(?:(?<return>{0})\\s+(?<name>{2}))|(?<destructor>~{2}))" +
+                // Grab the parameters
+                "\\(\\s*(?<params>(?:{1}\\s*,?\\s*)*)\\)" +
+                "(?:" +
+                    // Grab the platforms
+                    "(?:\\s*=\\s*(?<platforms>(?:\\w+\\s+(?:0x[0-9a-fA-F]+|inline)\\s*,?\\s*)+))" +
+                    // Or the body
+                    "|(?<inlinebody>(?=\\s*\\'{'))" +
+                    // Or where we can add platforms
+                    "|(?<insertplatformshere>\\s*(?=;))" +
+                ")",
+                GRAB_TYPE, GRAB_PARAM, funName
+            ),
+            Pattern.DOTALL | Pattern.MULTILINE
+        );
+    }
     public static final Pattern grabPlatformAddress(String platformName) {
         return Pattern.compile(
             formatRegex("(?<platform>{0})\\s+0x(?<addr>[0-9a-fA-F]+)", platformName),
@@ -116,6 +142,7 @@ public static final Pattern grabMemberOrPad(String memberName) {
         Pattern.DOTALL
     );
     public static final Pattern GRAB_FUNCTION = grabFunction("\\w+");
+    public static final Pattern GRAB_GLOBAL_FUNCTION = grabGlobalFunction("\\w+");
     public static final Pattern GRAB_MEMBER = grabMemberOrPad("\\w+");
     public static final Pattern GRAB_PLATFORM_ADDRESS = grabPlatformAddress("\\w+");
 }
diff --git a/scripts/ghidra/ScriptWrapper.java b/scripts/ghidra/ScriptWrapper.java
@@ -53,6 +53,7 @@
 public class ScriptWrapper {
     List<String> classes = new ArrayList<String>();
     List<String> enums = new ArrayList<String>();
+    List<String> functions = new ArrayList<String>();
     GhidraScript wrapped;
     Path bindingsDir;
 
@@ -473,7 +474,7 @@ Signature getBromaSignature(Broma.Function fun, Platform platform, boolean ignor
         // Parse args
         List<Variable> bromaParams = new ArrayList<Variable>();
         // Add `this` arg
-        boolean hasThis = fun.dispatch.isEmpty() || !fun.dispatch.get().value.contains("static");
+        boolean hasThis = fun.parent != null && (fun.dispatch.isEmpty() || !fun.dispatch.get().value.contains("static"));
         if (hasThis && platform != Platform.ANDROID32 && platform != Platform.MAC_INTEL) {
             bromaParams.add(new ParameterImpl(
                 "this",
diff --git a/scripts/ghidra/SyncBromaScript.java b/scripts/ghidra/SyncBromaScript.java
@@ -144,6 +144,14 @@ public void run() throws Exception {
 
         wrapper.printfmt("Found {0} classes in Broma", wrapper.classes.size());
 
+        // Read functions
+        wrapper.functions.addAll(this.bromas.stream()
+            .map(b -> b.functions.stream().map(f -> f.getName()).toList())
+            .flatMap(List::stream)
+            .toList());
+
+        wrapper.printfmt("Found {0} functions in Broma", wrapper.functions.size());
+
         // Read enums
         var enumPath = Paths.get(wrapper.bindingsDir.toString(), "include", "Geode", "Enums.hpp");
         if (Files.exists(enumPath)) {
@@ -202,8 +210,8 @@ public SignatureImport promoted(SignatureImport to) {
 
     private SignatureImport importSignatureFromBroma(Address addr, Broma.Function fun, boolean force) throws Exception {
         final var name = fun.getName();
-        final var className = fun.parent.name.value;
-        final var fullName = className + "::" + name;
+        final var className = fun.parent != null ? fun.parent.name.value : null;
+        final var fullName = className != null ? className + "::" + name : name;
         final var listing = currentProgram.getListing();
 
         var status = SignatureImport.NOCHANGES;
@@ -219,7 +227,9 @@ private SignatureImport importSignatureFromBroma(Address addr, Broma.Function fu
                     addr, fun.platformOffset.get().value, fullName
                 ));
             }
-            data.setParentNamespace(wrapper.addOrGetNamespace(className));
+            if (className != null) {
+                data.setParentNamespace(wrapper.addOrGetNamespace(className));
+            }
         }
 
         // Check if function already has an user-provided name - in this case, it might be merged
@@ -252,7 +262,9 @@ private SignatureImport importSignatureFromBroma(Address addr, Broma.Function fu
             status = status.promoted(SignatureImport.ADDED);
         }
         data.getSymbol().setName(name, SourceType.USER_DEFINED);
-        data.setParentNamespace(wrapper.addOrGetNamespace(className));
+        if (className != null) {
+            data.setParentNamespace(wrapper.addOrGetNamespace(className));
+        }
 
         // Get the calling convention
         final var conv = fun.getCallingConvention(args.platform);
@@ -521,6 +533,30 @@ private void handleImport() throws Exception {
                     default: break;
                 }
             }
+
+            for (var fun : bro.functions) {
+                // Only add functions that have an offset on this platform
+                if (fun.platformOffset.isEmpty()) {
+                    continue;
+                }
+                var offset = Long.parseLong(fun.platformOffset.get().value, 16);
+                if (offset == Broma.PLACEHOLDER_ADDR) {
+                    continue;
+                }
+                var addr = currentProgram.getImageBase().add(offset);
+                
+                switch (importSignatureFromBroma(addr, fun, false)) {
+                    case ADDED: {
+                        importedAddCount += 1;
+                        wrapper.printfmt("Added {0} at {1}", fun.getName(), Long.toHexString(addr.getOffset()));
+                    } break;
+                    case UPDATED: {
+                        importedUpdateCount += 1;
+                        wrapper.printfmt("Updated {0} at {1}", fun.getName(), Long.toHexString(addr.getOffset()));
+                    } break;
+                    default: break;
+                }
+            }
         }
         wrapper.printfmt("Added {0} functions & updated {1} functions from Broma", importedAddCount, importedUpdateCount);
     }
