Add Java IR.findModules(String name) API

GrammaTech · Nov 14, 2023 · 7ef7193 · 7ef7193
1 parent cbeab51
commit 7ef7193
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
   * More extensive test cases have been added.
 * Add elfStackExec and elfStackSize AuxData definitions
 * Add `IR.modules_named` helper method to Python API.
+* Add `IR.findModules(String name)` helper method to Java API.
 
 # 1.12.0
 

diff --git a/java/com/grammatech/gtirb/IR.java b/java/com/grammatech/gtirb/IR.java
@@ -151,6 +151,22 @@ public List<Module> getModules() {
         return Collections.unmodifiableList(this.modules);
     }
 
+    /**
+     * Find modules by name.
+     *
+     * @return A list of all {@link Module} in this {@link IR} that have a
+     * matching name.
+     */
+    public List<Module> findModules(String name) {
+        List<Module> modulesNamed = new ArrayList<Module>();
+        for (Module module : this.modules) {
+            if (name.equals(module.getName())) {
+                modulesNamed.add(module);
+            }
+        }
+        return modulesNamed;
+    }
+
     /**
      * Add a module to this {@link IR}.
      *

diff --git a/java/tests/TestIrSanity.java b/java/tests/TestIrSanity.java
@@ -163,4 +163,35 @@ void testAddAndRemoveModules() throws Exception {
         assertTrue(mod0.getIr().isEmpty());
         assertTrue(mod2.getIr().isEmpty());
     }
+
+    @Test
+    void testIrFindModules() throws Exception {
+        IR ir = new IR();
+
+        // test addModules (list)
+        List<Module> modules = new ArrayList<Module>();
+        modules.add(new Module(
+            "/opt/testModules/testModules-1.0.0/testModule0/bin/mod",
+            0x8FFFFFFF00000201L, 0x0L, FileFormat.ELF, ISA.X64, "mod0"));
+        modules.add(new Module(
+            "/opt/testModules/testModules-1.0.0/testModule1/bin/mod",
+            0x8FFFFFFF00000401L, 0x0L, FileFormat.ELF, ISA.X64, "mod1"));
+        modules.add(new Module(
+            "/opt/testModules/testModules-1.0.0/testModule1/bin/mod-dup",
+            0x8FFFFFFF00000401L, 0x0L, FileFormat.ELF, ISA.X64, "mod1"));
+        ir.addModules(modules);
+        assertTrue(ir.getModules().equals(modules));
+
+        List<Module> mod0_modules = ir.findModules("mod0");
+        assertEquals(1, mod0_modules.size());
+        for (Module module : mod0_modules) {
+            assertEquals("mod0", module.getName());
+        }
+
+        List<Module> mod1_modules = ir.findModules("mod1");
+        assertEquals(2, mod1_modules.size());
+        for (Module module : mod1_modules) {
+            assertEquals("mod1", module.getName());
+        }
+    }
 }