unidecompiler-gui-sdk 0.1.0__tar.gz

unidecompiler_gui_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: unidecompiler-gui-sdk
+Version: 0.1.0
+Summary: Stable read-only plugin API for unidecompiler-gui
+Author-email: Wker <1670133844@qq.com>
+License-Expression: AGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/Wker666/unidecompiler
+Project-URL: Repository, https://github.com/Wker666/unidecompiler
+Project-URL: Issues, https://github.com/Wker666/unidecompiler/issues
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# unidecompiler-gui-sdk
+
+Stable, read-only API for trusted `unidecompiler-gui` Python plugins. The SDK
+does not depend on Qt, core internals, frontends, or the simulator implementation.
+
+Install it directly when developing a plugin:
+
+```sh
+python -m pip install unidecompiler-gui-sdk
+```
+
+End users do not need to install it separately: `unidecompiler-gui` depends on
+the matching SDK API.
+
+## Minimal Plugin
+
+Place `plugin.toml` and the declared entry module in one directory:
+
+```toml
+[plugin]
+id = "example.workspace-inspector"
+name = "Workspace Inspector"
+version = "1.0.0"
+api = "1"
+entry = "workspace_inspector:register"
+
+[python]
+requires = []
+```
+
+```python
+from unidecompiler_gui_sdk import Command, Panel, PanelState
+
+
+def register(context):
+    context.panels.register(Panel("summary", "Summary"))
+
+    def refresh(plugin_context):
+        document = plugin_context.active_document
+        text = "No active document" if document is None else document.display_name
+        plugin_context.set_panel_state("summary", PanelState.text_view(text))
+
+    context.commands.register(Command("refresh", "Refresh summary", refresh))
+    context.subscribe("document_selected", lambda _document: refresh(context))
+```
+
+The plugin entry function receives a plugin-scoped context. Plugins are trusted
+in-process code, are not sandboxed, and must not import Qt or private
+decompiler/simulator modules. See the repository's
+`docs/GUI_PLUGIN_DEVELOPMENT.md` for the complete contract.
+
+The GUI calls the manifest entry function with a plugin-scoped `PluginContext`.
+Context snapshots are frozen data and navigation/simulation are host requests.
+Register extensions through `context.commands.register(Command(...))` and
+`context.panels.register(Panel(...))`; panels use `PanelState` data rather than
+Qt widgets. The SDK exposes no generic IR, decoded artifacts, frontends, Qt
+objects, or simulator execution internals.
+
+For simulation, request frontend-owned targets with
+`request_simulation_targets(document_id)`. The asynchronous target job returns
+`SimulationTargetSnapshot` values containing a display label, parameter names,
+and an opaque query. Pass that query unchanged to `submit_simulation`. Finished
+jobs contain SDK-owned `SimulationResultSnapshot` and
+`SimulationEventSnapshot` data, never simulator implementation objects.
+
+`context.settings` stores JSON-compatible values under the current plugin ID;
+one plugin cannot address another plugin's settings namespace.

unidecompiler_gui_sdk-0.1.0/README.md

@@ -0,0 +1,67 @@
+# unidecompiler-gui-sdk
+
+Stable, read-only API for trusted `unidecompiler-gui` Python plugins. The SDK
+does not depend on Qt, core internals, frontends, or the simulator implementation.
+
+Install it directly when developing a plugin:
+
+```sh
+python -m pip install unidecompiler-gui-sdk
+```
+
+End users do not need to install it separately: `unidecompiler-gui` depends on
+the matching SDK API.
+
+## Minimal Plugin
+
+Place `plugin.toml` and the declared entry module in one directory:
+
+```toml
+[plugin]
+id = "example.workspace-inspector"
+name = "Workspace Inspector"
+version = "1.0.0"
+api = "1"
+entry = "workspace_inspector:register"
+
+[python]
+requires = []
+```
+
+```python
+from unidecompiler_gui_sdk import Command, Panel, PanelState
+
+
+def register(context):
+    context.panels.register(Panel("summary", "Summary"))
+
+    def refresh(plugin_context):
+        document = plugin_context.active_document
+        text = "No active document" if document is None else document.display_name
+        plugin_context.set_panel_state("summary", PanelState.text_view(text))
+
+    context.commands.register(Command("refresh", "Refresh summary", refresh))
+    context.subscribe("document_selected", lambda _document: refresh(context))
+```
+
+The plugin entry function receives a plugin-scoped context. Plugins are trusted
+in-process code, are not sandboxed, and must not import Qt or private
+decompiler/simulator modules. See the repository's
+`docs/GUI_PLUGIN_DEVELOPMENT.md` for the complete contract.
+
+The GUI calls the manifest entry function with a plugin-scoped `PluginContext`.
+Context snapshots are frozen data and navigation/simulation are host requests.
+Register extensions through `context.commands.register(Command(...))` and
+`context.panels.register(Panel(...))`; panels use `PanelState` data rather than
+Qt widgets. The SDK exposes no generic IR, decoded artifacts, frontends, Qt
+objects, or simulator execution internals.
+
+For simulation, request frontend-owned targets with
+`request_simulation_targets(document_id)`. The asynchronous target job returns
+`SimulationTargetSnapshot` values containing a display label, parameter names,
+and an opaque query. Pass that query unchanged to `submit_simulation`. Finished
+jobs contain SDK-owned `SimulationResultSnapshot` and
+`SimulationEventSnapshot` data, never simulator implementation objects.
+
+`context.settings` stores JSON-compatible values under the current plugin ID;
+one plugin cannot address another plugin's settings namespace.

unidecompiler_gui_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "unidecompiler-gui-sdk"
+version = "0.1.0"
+description = "Stable read-only plugin API for unidecompiler-gui"
+readme = "README.md"
+license = "AGPL-3.0-or-later"
+authors = [{ name = "Wker", email = "1670133844@qq.com" }]
+requires-python = ">=3.11"
+
+[project.urls]
+Homepage = "https://github.com/Wker666/unidecompiler"
+Repository = "https://github.com/Wker666/unidecompiler"
+Issues = "https://github.com/Wker666/unidecompiler/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]

unidecompiler_gui_sdk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

unidecompiler_gui_sdk-0.1.0/src/unidecompiler_gui_sdk/__init__.py

@@ -0,0 +1,29 @@
+"""Public, GUI-neutral SDK for trusted unidecompiler GUI plugins."""
+
+from .api import (
+    AstNodeSnapshot,
+    CommandRegistrar,
+    Command,
+    DocumentSnapshot,
+    FunctionSnapshot,
+    Panel,
+    PanelRegistrar,
+    PanelState,
+    PluginContext,
+    PluginSettings,
+    ReferenceSnapshot,
+    SelectionSnapshot,
+    SimulationJobSnapshot,
+    SimulationEventSnapshot,
+    SimulationResultSnapshot,
+    SimulationTargetJobSnapshot,
+    SimulationTargetSnapshot,
+    SourceLocation,
+)
+
+__all__ = [
+    "AstNodeSnapshot", "Command", "CommandRegistrar", "DocumentSnapshot", "FunctionSnapshot",
+    "Panel", "PanelRegistrar", "PanelState", "PluginContext", "PluginSettings", "ReferenceSnapshot",
+    "SelectionSnapshot", "SimulationEventSnapshot", "SimulationJobSnapshot", "SimulationResultSnapshot",
+    "SimulationTargetJobSnapshot", "SimulationTargetSnapshot", "SourceLocation",
+]

unidecompiler_gui_sdk-0.1.0/src/unidecompiler_gui_sdk/api.py

@@ -0,0 +1,202 @@
+"""Versioned data contracts shared by GUI plugins and the GUI host."""
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any, Callable, Protocol
+
+
+API_VERSION = "1"
+
+
+@dataclass(frozen=True)
+class SourceLocation:
+    frontend: str
+    offset: int | None
+    line: int | None = None
+    detail: str | None = None
+
+
+@dataclass(frozen=True)
+class FunctionSnapshot:
+    id: str
+    name: str
+    status: str
+    params: tuple[str, ...] = ()
+    source: SourceLocation | None = None
+
+
+@dataclass(frozen=True)
+class AstNodeSnapshot:
+    id: str
+    kind: str
+    source: SourceLocation | None = None
+    children: tuple["AstNodeSnapshot", ...] = ()
+
+
+@dataclass(frozen=True)
+class ReferenceSnapshot:
+    kind: str
+    name: str
+    function_id: str | None
+    source: SourceLocation | None = None
+    target_ids: tuple[str, ...] = ()
+
+
+@dataclass(frozen=True)
+class DocumentSnapshot:
+    id: str
+    display_name: str
+    status: str
+    frontend_id: str | None
+    revision: int
+    functions: tuple[FunctionSnapshot, ...] = ()
+    pseudocode: str = ""
+
+
+@dataclass(frozen=True)
+class SelectionSnapshot:
+    document_id: str | None = None
+    function_id: str | None = None
+    source: SourceLocation | None = None
+
+
+@dataclass(frozen=True)
+class SimulationEventSnapshot:
+    kind: str
+    function: str
+    block: str | None = None
+    detail: str = ""
+    source: SourceLocation | None = None
+    args: tuple[Any, ...] = ()
+    values: tuple[Any, ...] = ()
+    exception: str | None = None
+    stdout: str = ""
+    stderr: str = ""
+
+
+@dataclass(frozen=True)
+class SimulationResultSnapshot:
+    status: str
+    values: tuple[Any, ...] = ()
+    exception: str | None = None
+    cause: str | None = None
+    locals: tuple[tuple[str, Any], ...] = ()
+    steps: int = 0
+    diagnostic: str | None = None
+    events: tuple[SimulationEventSnapshot, ...] = ()
+    trace_truncated: bool = False
+
+
+@dataclass(frozen=True)
+class SimulationTargetSnapshot:
+    """Presentation-safe simulator target with a frontend-owned opaque query."""
+
+    label: str
+    query: object
+    params: tuple[str, ...] = ()
+
+
+@dataclass(frozen=True)
+class SimulationTargetJobSnapshot:
+    id: str
+    document_id: str
+    revision: int
+    status: str
+    targets: tuple[SimulationTargetSnapshot, ...] = ()
+    diagnostic: str | None = None
+    stale: bool = False
+
+
+@dataclass(frozen=True)
+class SimulationJobSnapshot:
+    id: str
+    document_id: str
+    revision: int
+    status: str
+    result: SimulationResultSnapshot | None = None
+    diagnostic: str | None = None
+    stale: bool = False
+
+
+@dataclass(frozen=True)
+class PanelState:
+    kind: str
+    columns: tuple[str, ...] = ()
+    rows: tuple[tuple[str, ...], ...] = ()
+    text: str = ""
+
+    @classmethod
+    def text_view(cls, text: str) -> "PanelState":
+        return cls("text", text=text)
+
+    @classmethod
+    def table(cls, columns: tuple[str, ...], rows: tuple[tuple[object, ...], ...]) -> "PanelState":
+        return cls("table", columns=columns, rows=tuple(tuple(str(value) for value in row) for row in rows))
+
+
+CommandCallback = Callable[["PluginContext"], None]
+
+
+@dataclass(frozen=True)
+class Command:
+    id: str
+    title: str
+    callback: CommandCallback
+    shortcut: str | None = None
+
+
+@dataclass(frozen=True)
+class Panel:
+    id: str
+    title: str
+    state: PanelState = field(default_factory=lambda: PanelState.text_view(""))
+
+
+class CommandRegistrar(Protocol):
+    def register(self, command: Command) -> None: ...
+
+
+class PanelRegistrar(Protocol):
+    def register(self, panel: Panel) -> None: ...
+
+
+class PluginSettings(Protocol):
+    """JSON-compatible settings isolated to the current plugin ID."""
+
+    def get(self, key: str, default: Any = None) -> Any: ...
+    def set(self, key: str, value: Any) -> None: ...
+    def delete(self, key: str) -> None: ...
+
+
+class PluginContext(Protocol):
+    @property
+    def documents(self) -> tuple[DocumentSnapshot, ...]: ...
+
+    @property
+    def active_document(self) -> DocumentSnapshot | None: ...
+
+    @property
+    def selection(self) -> SelectionSnapshot: ...
+
+    def get_document(self, document_id: str) -> DocumentSnapshot | None: ...
+    def get_function(self, document_id: str, function_id: str) -> FunctionSnapshot | None: ...
+    def get_ast(self, document_id: str, function_id: str | None = None) -> AstNodeSnapshot | None: ...
+    def get_references(self, document_id: str, function_id: str | None = None) -> tuple[ReferenceSnapshot, ...]: ...
+    def focus_source(self, document_id: str, source: SourceLocation) -> bool: ...
+    def focus_function(self, document_id: str, function_id: str) -> bool: ...
+    def request_simulation_targets(self, document_id: str) -> SimulationTargetJobSnapshot: ...
+    def get_target_job(self, job_id: str) -> SimulationTargetJobSnapshot | None: ...
+    def submit_simulation(self, document_id: str, query: object, args: tuple[object, ...] = (), runtime_path: str | None = None) -> SimulationJobSnapshot: ...
+    def get_job(self, job_id: str) -> SimulationJobSnapshot | None: ...
+    def cancel_job(self, job_id: str) -> bool: ...
+    def set_panel_state(self, panel_id: str, state: PanelState) -> None: ...
+    def subscribe(self, event: str, callback: Callable[[object], None]) -> Callable[[], None]: ...
+
+    @property
+    def commands(self) -> CommandRegistrar: ...
+
+    @property
+    def panels(self) -> PanelRegistrar: ...
+
+    @property
+    def settings(self) -> PluginSettings: ...

unidecompiler_gui_sdk-0.1.0/src/unidecompiler_gui_sdk.egg-info/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: unidecompiler-gui-sdk
+Version: 0.1.0
+Summary: Stable read-only plugin API for unidecompiler-gui
+Author-email: Wker <1670133844@qq.com>
+License-Expression: AGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/Wker666/unidecompiler
+Project-URL: Repository, https://github.com/Wker666/unidecompiler
+Project-URL: Issues, https://github.com/Wker666/unidecompiler/issues
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# unidecompiler-gui-sdk
+
+Stable, read-only API for trusted `unidecompiler-gui` Python plugins. The SDK
+does not depend on Qt, core internals, frontends, or the simulator implementation.
+
+Install it directly when developing a plugin:
+
+```sh
+python -m pip install unidecompiler-gui-sdk
+```
+
+End users do not need to install it separately: `unidecompiler-gui` depends on
+the matching SDK API.
+
+## Minimal Plugin
+
+Place `plugin.toml` and the declared entry module in one directory:
+
+```toml
+[plugin]
+id = "example.workspace-inspector"
+name = "Workspace Inspector"
+version = "1.0.0"
+api = "1"
+entry = "workspace_inspector:register"
+
+[python]
+requires = []
+```
+
+```python
+from unidecompiler_gui_sdk import Command, Panel, PanelState
+
+
+def register(context):
+    context.panels.register(Panel("summary", "Summary"))
+
+    def refresh(plugin_context):
+        document = plugin_context.active_document
+        text = "No active document" if document is None else document.display_name
+        plugin_context.set_panel_state("summary", PanelState.text_view(text))
+
+    context.commands.register(Command("refresh", "Refresh summary", refresh))
+    context.subscribe("document_selected", lambda _document: refresh(context))
+```
+
+The plugin entry function receives a plugin-scoped context. Plugins are trusted
+in-process code, are not sandboxed, and must not import Qt or private
+decompiler/simulator modules. See the repository's
+`docs/GUI_PLUGIN_DEVELOPMENT.md` for the complete contract.
+
+The GUI calls the manifest entry function with a plugin-scoped `PluginContext`.
+Context snapshots are frozen data and navigation/simulation are host requests.
+Register extensions through `context.commands.register(Command(...))` and
+`context.panels.register(Panel(...))`; panels use `PanelState` data rather than
+Qt widgets. The SDK exposes no generic IR, decoded artifacts, frontends, Qt
+objects, or simulator execution internals.
+
+For simulation, request frontend-owned targets with
+`request_simulation_targets(document_id)`. The asynchronous target job returns
+`SimulationTargetSnapshot` values containing a display label, parameter names,
+and an opaque query. Pass that query unchanged to `submit_simulation`. Finished
+jobs contain SDK-owned `SimulationResultSnapshot` and
+`SimulationEventSnapshot` data, never simulator implementation objects.
+
+`context.settings` stores JSON-compatible values under the current plugin ID;
+one plugin cannot address another plugin's settings namespace.

unidecompiler_gui_sdk-0.1.0/src/unidecompiler_gui_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+src/unidecompiler_gui_sdk/__init__.py
+src/unidecompiler_gui_sdk/api.py
+src/unidecompiler_gui_sdk.egg-info/PKG-INFO
+src/unidecompiler_gui_sdk.egg-info/SOURCES.txt
+src/unidecompiler_gui_sdk.egg-info/dependency_links.txt
+src/unidecompiler_gui_sdk.egg-info/top_level.txt

unidecompiler_gui_sdk-0.1.0/src/unidecompiler_gui_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

unidecompiler_gui_sdk-0.1.0/src/unidecompiler_gui_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+unidecompiler_gui_sdk