declib 4.0.0__tar.gz → 4.0.2__tar.gz

{declib-4.0.0 → declib-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: declib
-Version: 4.0.0
+Version: 4.0.2
 Summary: Your Only Decompiler API Lib - A generic API to script in and out of decompilers
 License: BSD 2 Clause
 Project-URL: Homepage, https://github.com/binsync/declib
@@ -61,8 +61,15 @@ start a new process using a specified decompiler.
 You can find various examples using DecLib in the [examples](./examples) folder. Examples that are plugins show off
 more of the complicated API that allows you to use an abstracted UI, artifacts, and more.
 
+### Agent CLI
+
 If you want a simplified command line interface (especially well-suited for LLMs), see the
-[`decompiler` CLI guide](./docs/decompiler_cli.md).
+[decompiler CLI guide](./docs/decompiler_cli.md).
+
+```
+decompiler load /path/to/binary --backend ida
+decompiler decompile main --id 1234
+```
 
 ### UI Mode (default)
 To use the same script everywhere, use the convenience function `DecompilerInterface.discover_interface()`, which will

{declib-4.0.0 → declib-4.0.2}/README.md

@@ -28,8 +28,15 @@ start a new process using a specified decompiler.
 You can find various examples using DecLib in the [examples](./examples) folder. Examples that are plugins show off
 more of the complicated API that allows you to use an abstracted UI, artifacts, and more.
 
+### Agent CLI
+
 If you want a simplified command line interface (especially well-suited for LLMs), see the
-[`decompiler` CLI guide](./docs/decompiler_cli.md).
+[decompiler CLI guide](./docs/decompiler_cli.md).
+
+```
+decompiler load /path/to/binary --backend ida
+decompiler decompile main --id 1234
+```
 
 ### UI Mode (default)
 To use the same script everywhere, use the convenience function `DecompilerInterface.discover_interface()`, which will

{declib-4.0.0 → declib-4.0.2}/declib/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.0.0"
+__version__ = "4.0.2"
 
 
 import logging

{declib-4.0.0 → declib-4.0.2}/declib/api/decompiler_client.py

@@ -792,14 +792,14 @@ class DecompilerClient:
         _l.info("DecompilerClient shut down complete")
 
     def shutdown_server(self) -> None:
-        """Ask the server to tear down its decompiler interface, then disconnect.
+        """Ask the server to stop, then disconnect.
 
         Used by CLI commands like ``decompiler stop``. Regular usage should
         prefer :meth:`shutdown`, which leaves the server running.
         """
         if self._socket:
             try:
-                self._send_request({"type": "shutdown_deci"})
+                self._send_request({"type": "shutdown_server"})
             except Exception:
                 pass
         self.shutdown()
@@ -1216,4 +1216,4 @@ class DecompilerClient:
                     callback(gvar, **kwargs)
             except Exception as e:
                 _l.error(f"Error in global variable change callback: {e}")
-        return gvar
+        return gvar

{declib-4.0.0 → declib-4.0.2}/declib/decompilers/angr/interface.py

@@ -847,7 +847,13 @@ class AngrInterface(DecompilerInterface):
 
     @staticmethod
     def line_map_from_decompilation(dec):
-        import ailment
+        try:
+            # angr >= 9.2.2xx vendors ailment; the standalone `ailment` package
+            # is a different module whose Label class fails isinstance checks
+            # against statements produced by modern angr.
+            from angr import ailment
+        except ImportError:
+            import ailment
         from angr.analyses.decompiler.structured_codegen.c import CStructuredCodeWalker, CFunctionCall, CIfElse, CIfBreak
 
         if dec is None or dec.codegen is None:
@@ -874,7 +880,11 @@ class AngrInterface(DecompilerInterface):
             except Exception:
                 continue
 
-            ail_block_stmts = [stmt for stmt in ail_block.statements if not isinstance(stmt, ailment.statement.Label)]
+            ail_block_stmts = [
+                stmt for stmt in ail_block.statements
+                if not isinstance(stmt, ailment.statement.Label)
+                and getattr(stmt, "ins_addr", None) is not None
+            ]
             if not ail_block_stmts:
                 continue
 

{declib-4.0.0 → declib-4.0.2}/declib/decompilers/ghidra/interface.py

@@ -34,6 +34,10 @@ _l = logging.getLogger(__name__)
 
 class GhidraDecompilerInterface(DecompilerInterface):
     CACHE_TIMEOUT = 5
+    # GUI-backed Ghidra program APIs are not safe to enter concurrently from
+    # arbitrary socket worker threads. DecompilerServer routes calls through
+    # its main-thread dispatcher when this is enabled.
+    requires_main_thread_dispatch = True
     _program: Optional["Program"]
     flat_api: "FlatProgramAPI"
 
@@ -76,6 +80,7 @@ class GhidraDecompilerInterface(DecompilerInterface):
         # main thread queue
         self._main_thread_queue = queue.Queue()
         self._results_queue = queue.Queue()
+        self.requires_main_thread_dispatch = not kwargs.get("headless", False)
 
         super().__init__(
             name="ghidra",
@@ -1430,4 +1435,3 @@ class GhidraDecompilerInterface(DecompilerInterface):
             [code_unit for code_unit in self.currentProgram.getListing().getCodeUnits(func.getBody(), True)]
             for func in self.currentProgram.getFunctionManager().getFunctions(True)
         ]
-

{declib-4.0.0 → declib-4.0.2}/declib/plugin_installer.py

@@ -111,7 +111,7 @@ class PluginInstaller:
         - Path: install succeeded
         """
 
-        PluginInstaller.info(f"Install for {target}? [y/n]")
+        PluginInstaller.info(f"Install for {target}? [y/N]")
         res = prompt("")
         if res.lower() != "y":
             return None

{declib-4.0.0 → declib-4.0.2}/declib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: declib
-Version: 4.0.0
+Version: 4.0.2
 Summary: Your Only Decompiler API Lib - A generic API to script in and out of decompilers
 License: BSD 2 Clause
 Project-URL: Homepage, https://github.com/binsync/declib
@@ -61,8 +61,15 @@ start a new process using a specified decompiler.
 You can find various examples using DecLib in the [examples](./examples) folder. Examples that are plugins show off
 more of the complicated API that allows you to use an abstracted UI, artifacts, and more.
 
+### Agent CLI
+
 If you want a simplified command line interface (especially well-suited for LLMs), see the
-[`decompiler` CLI guide](./docs/decompiler_cli.md).
+[decompiler CLI guide](./docs/decompiler_cli.md).
+
+```
+decompiler load /path/to/binary --backend ida
+decompiler decompile main --id 1234
+```
 
 ### UI Mode (default)
 To use the same script everywhere, use the convenience function `DecompilerInterface.discover_interface()`, which will

{declib-4.0.0 → declib-4.0.2}/pyproject.toml

@@ -59,4 +59,4 @@ license-files = ["LICENSE"]
 find = {namespaces = false}
 
 [tool.setuptools.dynamic]
-version = {attr = "declib.__version__"}
+version = {attr = "declib.__version__"}

{declib-4.0.0 → declib-4.0.2}/tests/test_client_server.py

@@ -5,6 +5,7 @@ import tempfile
 import threading
 import time
 import unittest
+from types import MethodType
 from pathlib import Path
 
 from declib.api.decompiler_server import DecompilerServer
@@ -217,6 +218,27 @@ class TestClientServer(unittest.TestCase):
             # Test KeyError handling for non-existent function
             with self.assertRaises(KeyError, msg="Should raise KeyError for non-existent function"):
                 self.client.functions[0xDEADBEEF]  # Non-existent function
+
+    def test_shutdown_server_requests_server_stop(self):
+        """Test that shutdown_server asks the remote server loop to stop."""
+        sent_requests = []
+        client = object.__new__(DecompilerClient)
+        client._socket = object()
+        client._event_listener_running = False
+
+        def fake_send_request(self, request):
+            sent_requests.append(request)
+
+        def fake_shutdown(self):
+            sent_requests.append({"type": "client_shutdown"})
+
+        client._send_request = MethodType(fake_send_request, client)
+        client.shutdown = MethodType(fake_shutdown, client)
+
+        client.shutdown_server()
+
+        self.assertEqual(sent_requests[0], {"type": "shutdown_server"})
+        self.assertEqual(sent_requests[1], {"type": "client_shutdown"})
     
     def test_client_context_manager(self):
         """Test client context manager functionality"""
@@ -700,4 +722,4 @@ class TestClientServer(unittest.TestCase):
 
 
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()

{declib-4.0.0 → declib-4.0.2}/tests/test_decompilers.py

@@ -1,14 +1,18 @@
 import json
 import logging
 import subprocess
+import sys
 import tempfile
 import time
+import types
 import unittest
+from unittest.mock import MagicMock, patch
 from pathlib import Path
 from collections import defaultdict
 import os
 
 from declib.api import DecompilerInterface
+from declib.api.decompiler_server import DecompilerServer
 from declib.artifacts import FunctionHeader, StackVariable, Struct, GlobalVariable, Enum, Comment, ArtifactFormat, \
     Decompilation, Function, StructMember, Typedef, Segment
 from declib.decompilers import IDA_DECOMPILER, ANGR_DECOMPILER, BINJA_DECOMPILER, GHIDRA_DECOMPILER
@@ -65,6 +69,41 @@ class TestHeadlessInterfaces(unittest.TestCase):
         if self.deci is not None:
             self.deci.shutdown()
 
+    def test_ghidra_server_dispatch_requirement(self):
+        import declib.decompilers.ghidra as ghidra_package
+
+        pyghidra = types.ModuleType("pyghidra")
+        pyghidra_core = types.ModuleType("pyghidra.core")
+        pyghidra_core._analyze_program = MagicMock()
+        pyghidra_core._get_language = MagicMock()
+        pyghidra_core._get_compiler_spec = MagicMock()
+        jpype = types.ModuleType("jpype")
+        jpype.JClass = type
+
+        modules = {
+            "pyghidra": pyghidra,
+            "pyghidra.core": pyghidra_core,
+            "jpype": jpype,
+        }
+        with patch.object(ghidra_package, "interface", create=True):
+            with patch.dict(sys.modules, modules):
+                sys.modules.pop("declib.decompilers.ghidra.interface", None)
+                from declib.decompilers.ghidra.interface import GhidraDecompilerInterface
+
+                with patch.object(GhidraDecompilerInterface, "_init_gui_components"), \
+                        patch.object(GhidraDecompilerInterface, "_init_headless_components"):
+                    for headless, expected in ((True, False), (False, True)):
+                        with self.subTest(headless=headless):
+                            deci = GhidraDecompilerInterface(
+                                headless=headless,
+                                config=MagicMock(),
+                            )
+                            server = object.__new__(DecompilerServer)
+                            server.deci = deci
+
+                            self.assertIs(deci.requires_main_thread_dispatch, expected)
+                            self.assertIs(server.requires_main_thread, expected)
+
     def test_readme_example(self):
         # TODO: add angr
         for dec_name in [IDA_DECOMPILER, GHIDRA_DECOMPILER, BINJA_DECOMPILER]:
@@ -919,4 +958,4 @@ class TestHeadlessInterfaces(unittest.TestCase):
             deci.shutdown()
 
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()