add state function to Python builtins that exposes GhidraState object (…

…#75)
mandiant · Sep 6, 2023 · 7489831 · 7489831
1 parent 6cab0ab
commit 7489831
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/data/python/jepwrappers.py b/data/python/jepwrappers.py
@@ -307,6 +307,10 @@ def wrapped_monitor():
     return get_script().getMonitor()
 
 
+def wrapped_state():
+    return get_script_state()
+
+
 def wrapped_currentProgram():
     return get_script_state().getCurrentProgram()
 
@@ -328,6 +332,7 @@ def wrapped_currentHighlight():
 
 
 __builtins__["monitor"] = wrapped_monitor
+__builtins__["state"] = wrapped_state
 __builtins__["currentProgram"] = wrapped_currentProgram
 __builtins__["currentAddress"] = wrapped_currentAddress
 __builtins__["currentLocation"] = wrapped_currentLocation

diff --git a/data/python/tests/test_jepbridge.py b/data/python/tests/test_jepbridge.py
@@ -46,13 +46,15 @@ def test_type_instance(self):
 
     def test_ghidra_script_variables(self):
         self.assertIsJavaObject(monitor())
+        self.assertIsJavaObject(state())
         self.assertIsJavaObject(currentAddress())
         self.assertIsJavaObject(currentProgram())
         self.assertIsJavaObject(currentLocation())
         self.assertIsJavaObject(currentHighlight())
         self.assertIsJavaObject(currentSelection())
 
         self.assertIsNotJavaObject(monitor)
+        self.assertIsNotJavaObject(state)
         self.assertIsNotJavaObject(currentAddress)
         self.assertIsNotJavaObject(currentProgram)
         self.assertIsNotJavaObject(currentLocation)
@@ -61,8 +63,12 @@ def test_ghidra_script_variables(self):
 
     def test_ghidra_script_methods(self):
         self.assertIsInstance(getGhidraVersion(), str)
+        self.assertIsJavaObject(getState())
 
     def test_java_excluded_packages(self):
         import pdb
 
         self.assertIsNotJavaObject(pdb)
+
+    def test_ghidra_script_state(self):
+        self.assertTrue(state() == getState())