struct2ui 0.1.0__py3-none-any.whl

struct2ui-0.1.0.dist-info/METADATA

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: struct2ui
+Version: 0.1.0
+Summary: Render C struct / JSON schema as editable PySide6 UI, export to C/JSON/bin
+Author: Jay
+License: MIT License
+        
+        Copyright (c) 2026 Jay
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: qt,pyside6,gui,c-struct,json-schema,code-generation,parameter-tuning
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Qt.py>=1.3
+Provides-Extra: pyside6
+Requires-Dist: PySide6>=6.4; extra == "pyside6"
+Provides-Extra: pyqt6
+Requires-Dist: PyQt6>=6.4; extra == "pyqt6"
+Provides-Extra: elf
+Requires-Dist: pyelftools>=0.29; extra == "elf"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pyelftools>=0.29; extra == "dev"
+Dynamic: license-file
+
+# struct2ui
+
+Render C structs / JSON schemas as an **editable PySide6 UI**, and convert freely between **C / JSON / bin**. Built for algorithm parameter tuning: describe a C interface in JSON, auto-generate a Qt form, edit it, then export back to C source, JSON, or binary.
+
+## Features
+
+- **JSON → UI**: describe C structs / enums / arrays with minimal JSON and auto-render Qt widgets (int→QSpinBox, float→QDoubleSpinBox, enum→QComboBox, etc.).
+- **Embeddable**: `StructEditor` is a plain `QWidget` that drops into any PySide6 / PyQt UI.
+- **Multi-format export**: edited results export to C source, JSON, or binary; C source can also be parsed back into a schema.
+- **Validation**: keyword spell-checking (with “Did you mean X?” hints), semantic audits (`min<=max`, `step>0`), and pipeline cross-validation.
+- **Qt-binding agnostic**: built on [Qt.py](https://github.com/mottosso/Qt.py) — works with PySide6 / PyQt6 / PySide2 / PyQt5.
+
+## Installation
+
+```bash
+pip install struct2ui
+
+# Pick a Qt binding (choose one)
+pip install "struct2ui[pyside6]"
+pip install "struct2ui[pyqt6]"
+
+# Enable ELF layout verification (optional)
+pip install "struct2ui[elf]"
+```
+
+> The library itself only depends on `Qt.py`; you must install a Qt binding (PySide6 / PyQt6 / etc.) yourself.
+> ELF verification depends on `pyelftools`, installed via the `[elf]` extra.
+
+## Quick Start
+
+```python
+from Qt import QtWidgets
+from struct2ui import StructEditor
+
+app = QtWidgets.QApplication([])
+
+editor = StructEditor(
+    flow_file="abc.json",   # pipeline definition file
+    cfg_dir="cfg_t",        # modules dir: *.json holding struct/enum/typedef
+)
+editor.resize(480, 600)
+editor.show()
+
+app.exec_()
+```
+
+## Embedding into an Existing UI
+
+`StructEditor` is a regular `QWidget`; just put it into a layout:
+
+```python
+from Qt import QtWidgets
+from struct2ui import StructEditor
+
+class MyWindow(QtWidgets.QMainWindow):
+    def __init__(self):
+        super().__init__()
+        editor = StructEditor(
+            "abc.json", "cfg_t",
+            settings_org="MyCompany",   # custom QSettings scope to
+            settings_app="MyApp",       # avoid clashing with the host app
+        )
+        self.setCentralWidget(editor)
+```
+
+### Constructor Parameters
+
+| Parameter | Description |
+| --- | --- |
+| `flow_file` | Path to the pipeline JSON file (pipeline definition) |
+| `cfg_dir` | Modules directory holding `*.json` (struct / enum / typedef definitions) |
+| `parent` | Qt parent object, defaults to `None` |
+| `appearance` | Button appearance overrides, `{key: {'mode': ..., 'icon': ..., 'text': ...}}` |
+| `settings_org` | QSettings organization name, defaults to `'struct2ui'` |
+| `settings_app` | QSettings application name, defaults to `'StructEditor'` |
+
+## Export API
+
+The low-level export functions can be used standalone, without any UI:
+
+```python
+from struct2ui.schema import SchemaRegistry
+from struct2ui.exporters import (
+    emit_c,          # sections + registry -> C source string
+    dumps_json,      # -> JSON string
+    emit_bin,        # -> binary bytes
+    merge_abi,       # merge ABI info
+    verify_sections, # verify .bin layout against an ELF
+    parse_c_source,  # C source -> parse result
+    build_schema_dict,
+)
+```
+
+## Architecture
+
+| Layer | Module | Responsibility |
+| --- | --- | --- |
+| Schema (pure data, no Qt) | `struct2ui.schema` | Parse `*.json` into a Field tree; spell-checking, semantic audits, pipeline cross-validation |
+| UI rendering | `struct2ui.ui` | `WidgetFactory`, `FormRenderer`/`TreeRenderer`, array tables, `when` conditional binding |
+| Export | `struct2ui.exporters` | C / JSON / bin export, C source reverse parsing, ELF verification |
+| Top-level widget | `struct2ui.StructEditor` | Path bar / action buttons / content area; load report panel; QSettings path memory |
+
+## Development
+
+```bash
+pip install -e ".[dev]" --no-build-isolation
+python -m pytest
+```
+
+Tests live under `tests/` and drive real Qt widgets headlessly on the offscreen platform.
+
+## License
+
+[MIT](LICENSE) © Jay

struct2ui-0.1.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+struct2ui/__init__.py,sha256=3t4b6VmTwxeqbnWytq0NPHvLbR30NwdBiMEDCscvr84,87
+struct2ui/editor.py,sha256=A0gmb_1ZGXZelKlkiPCLiS_HUFEE7mIKwLPqu9iKegA,51784
+struct2ui/schema.py,sha256=y-yBjVgEaxSBV-Fxh6et_DFlwunbY9YI-xXFlt5JtMo,48147
+struct2ui/exporters/__init__.py,sha256=-nUwPMHej6yLIjF0paAZNZcul9YwYEZyfccH9H7XqzE,549
+struct2ui/exporters/bin_emitter.py,sha256=z_YIy5FFfa83Blz06PL39A6oNScgz1DHW1T0De2wobY,8904
+struct2ui/exporters/c_emitter.py,sha256=4Y7ADJKzrfduxZYTb5CmzuFhuUaVNDcmU_1q2Z0NI-4,8673
+struct2ui/exporters/c_parser.py,sha256=AJCFqnM14lP-7p8g199BWW146j5iX6eBhnWXn1Sg6GE,7574
+struct2ui/exporters/elf_verifier.py,sha256=JNc7DfeQbLJi2UJyNQ2xBGOIt_fkp6DNH6-lAp66xZ8,12335
+struct2ui/exporters/json_format.py,sha256=ihj4KnNSLJZllOq2zqzloXnmPsqhnK8ewsoDPRDTTHc,5059
+struct2ui/icons/c2j.png,sha256=azwc6sM78mdZJ_gcrgk8oePCtpFWsISZ50abkUi_X68,481
+struct2ui/icons/elf.png,sha256=6yrLbPj0Z2XXTXqRyBLSg9lM78-ud9aYOEPET0gNq1Q,374
+struct2ui/icons/export_notes_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=jizQPZ1gGXHihaMC_nwQRXeym_k1I8c6uZ0je9tOlf0,413
+struct2ui/icons/flowchart_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=zdCiQRKt_BV37pyngGQB75dt260n1lIahvbVVY5LU58,261
+struct2ui/icons/refresh_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=Vv4NVcTzuxT2GeQQLMuh2VhiNEPJCcA4GxJgX8mrLuw,408
+struct2ui/icons/report_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=nl6PjyDBPp1IMKPdocv8OQ434y1_Pc3RHaSMu9oip5c,327
+struct2ui/icons/save_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=-PmzLVVverpZMgXBc0kOb5WzZpxL--1ueraL6y0prlg,312
+struct2ui/icons/save_as_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=uY9mFM0FRukTqgpZlnfVa9q8Gn9la_yNzPNZMqaokCc,401
+struct2ui/icons/settings_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=oaEBh8cKo6hzH9b_rcjIPDBi2W1GBRnikPxqWS8Q8PQ,577
+struct2ui/icons/widgets_24dp_000000_FILL0_wght400_GRAD0_opsz24.png,sha256=rgynhq4ud7FCjChDwhamYeJehDQh8sDpl6bIoUownGk,356
+struct2ui/ui/__init__.py,sha256=d0Kb8qmDj5MYXygSZBhHZ76yIw-1GwRtpyEJ2hs6xTQ,1036
+struct2ui/ui/renderers.py,sha256=m87uhdY2Y3JCIxo5OMBCBCgsbdPRy0RXc46OgnR5GO0,13541
+struct2ui/ui/tables.py,sha256=zzhaNS7ZK7bfOuOOiH1eGBTPJwURqsvjpQR8TCC65KU,8549
+struct2ui/ui/widgets.py,sha256=k97NOx4xPYxR42rF8ntwerpR7r1y1Eweu_pOyJA3DkU,33964
+struct2ui-0.1.0.dist-info/licenses/LICENSE,sha256=xEsRvzJ-7Nbqa9ppe87ZOX9Xgmc2CJ7HOEFGRa0rcpU,1060
+struct2ui-0.1.0.dist-info/METADATA,sha256=5Xv6S8QaSK0kYoKM8_UiKaHDcRSuAaivyzKuzXTUaCU,6634
+struct2ui-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+struct2ui-0.1.0.dist-info/top_level.txt,sha256=5VSACaV9oM-KVn5zhiEnmO9YmzjfgTmpaRF1-8ylHk0,10
+struct2ui-0.1.0.dist-info/RECORD,,

struct2ui-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

struct2ui-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

struct2ui-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+struct2ui