zuspec-be-sw 0.0.1.20941125465rc0

Zuspec C/C++ software backend

Zuspec Software Backend

The Zuspec Software (SW) Backend transforms Zuspec hardware component models into executable C/C++ code for simulation, testing, and modeling.

Features

• Component Translation: Zuspec Components → C structs and functions
• Async/Sync: Transforms async methods with optional sync conversion
• Protocol Interfaces: Generates C API structs for Protocol types
• Type Mapping: Maps Zuspec types to C types
• Validation: Pre-generation compatibility checks
• Compilation: Built-in GCC compiler interface
• Test Execution: Automated test runner
• Type Specialization: Optional monomorphization (experimental)

Installation

pip install zuspec-be-sw

Quick Start

import zuspec.dataclasses as zdc
from zuspec.be.sw import CGenerator, CValidator, CCompiler, TestRunner
from pathlib import Path

@zdc.dataclass
class Counter(zdc.Component):
    count: int = zdc.field(default=0)
    
    def increment(self):
        self.count += 1
    
    def get_count(self) -> int:
        return self.count

# Build → Validate → Generate → Compile → Run
factory = zdc.DataModelFactory()
ctxt = factory.build(Counter)

validator = CValidator()
assert validator.validate(ctxt)

gen = CGenerator(Path("output"))
sources = gen.generate(ctxt)

compiler = CCompiler(Path("output"))
exe = compiler.compile(sources, Path("output/test"))

runner = TestRunner()
result = runner.run(exe)

Generated C Code

typedef struct Counter {
    int count;
} Counter;

void Counter_init(Counter *self);
void Counter_increment(Counter *self);
int Counter_get_count(Counter *self);

Documentation

• Quickstart
• Features
• Generator
• Examples
• API
• Testing
• Contributing

Requirements

• Python >= 3.7
• zuspec-dataclasses
• C compiler (GCC)

License

Apache-2.0