TBD

Simply using yace on the models/*.yaml provide a 90%+ code coverage.
What remains is instrumented by tests in pytest.
These tests would benefit additions hitting error-cases that are not triggered by "natural" usage.

As the title describes.

TBD

yace depends on a compiler/interpreter and auxilary tooling for the targets it is emitting code for.
Whether or not these are available requires that the tool is available for execution. When it is not, then a not so friendly Python exception is dumped on stdout/stderr.

The above should be fixed by adding a preflight check to the target base-class.

TBD

As the title suggests, provide a single page providing an overview of all entities in: https://safl.dk/yace/idl/index.html

This is not available on main, however, for it to be really nice, then the entity-docs needs a slight bit of adjustment.

• Add script generating entity-list

To achieve simple code-emitters, then the IDL needs to be close in representation to the generated code. Otherwise, then the target needs to take differences into account. One example are nested structures / unions in C, especially with anonymous structs/unions.

Equivalent definitions are not support by e.g. Rust. Consequently, then the yet needs to this into account when emitting code. That is, hoist the nested structs/unions out and declare them top-level. This quickly becomes tedious work to do for each emitter-target. Thus, a nicer approach would be to transform the IDL by expanding the nested structs / unions.

Describing C API, C ABI, memory-layout, packing, padding, calling conventions etc.

As a lot of other FFI code-generators work using the C header as input, it would be convenient for yace to provide something similar. Considering:

• Add a tool yidlr which takes a C header-file as input and produces a yace yidl-file as output
• As the yace yidl-representation only encapsulate a subset of what is available with C, then it should be "best-effort" tool

It would be convenient with a helper bumping the version-number of yace in the various places.

They look messy:

make[1]: Entering directory '/home/runner/work/yace/yace'
Usage:
 
  make help          ; Brief target description
  make help-verbose  ; Verbose target descriptions
  make [target]      ; Invoke the given 'target'
 
Targets:
 
�[1mall           �[0m ; Do all: clean uninstall build install
�[1mall-system    �[0m ; Do all: clean uninstall build install-system
�[1mbuild         �[0m ; Build the package (source distribution package)
�[1mbump          �[0m ; run code format (style, code-conventions and language-integrity) on all files
�[1mclean         �[0m ; clean build artifacts (build, dist, output)
�[1mcoverage      �[0m ; Run emitter with coverage
�[1mdefault       �[0m ; invoke: 'make uninstall', 'make install'
�[1mdocs          �[0m ; generate documentation and open the HTML
�[1mdocs-build    �[0m ; generate documentation
�[1mdocs-view     �[0m ; open the HTML
�[1memit          �[0m ; Emit code for all examples
�[1memit-example  �[0m ; Emit code using the example interface model
�[1memit-nvme     �[0m ; Emit code using the NVMe interface model
�[1memit-xnvme    �[0m ; Emit code using the xNVMe interface model
�[1mformat        �[0m ; run code format (style, code-conventions and language-integrity) on staged changes
�[1mformat-all    �[0m ; run code format (style, code-conventions and language-integrity) on all files
�[1mhelp          �[0m ; Print the description of every target
�[1minstall       �[0m ; install for current user
�[1minstall-system�[0m ; install system-wide
�[1mrelease-build �[0m ; Produce Python distribution (sdist, bdist_wheel)
�[1mrelease-upload�[0m ; Produce + Upload Python distribution (sdist, bdist_wheel)
�[1muninstall     �[0m ; uninstall - Prefix with 'sudo' when uninstalling a system-wide installation
�[1mview          �[0m ; Inspect generated code
make[1]: Leaving directory '/home/runner/work/yace/yace'

• Add to yidl
• Add to target capi
• Add to target ctypes

This is a collection of functionality and issues expecting to be added/fixed for the first major release of yace

General Functionality

• #2
• #3

YIDL

• #4
• #5

Targets

• #8
• #9
• #10
• #11
• #12
• #13
• #14

Testing

• #6
• #7

Documentation

• #15
• #16
• #17
• #18
• #20
• #21

Infrastructure

• Auto-deploy to PyPI on release (pushing tags)
• #19

Now that the entity-list is generated thanks to (#15) then those captions / first-line comments should be re-worded to be used for this purpose.

Currently not all entities have proper is_valid_{attribute} validators. Until that happens, then a bit of type annotation and static checking goes a long way.

TBD

• Symbol validation (snake_case, identifier characters etc.)
• Bitfield validation (ensure members add up to total amount of bits)
• All entity-attributes must have a is_valid_{field}() validation method
• Wholesome checks
  • No symbol collisions (verifies no duplicates in top-level-scope
  • Possibly re-done post transformations

TBD

• Contain all tool dependencies
• Contain all Python dependencies
• Contain yace
• Provided as ghcr.io package
• Auto-deployed with release

This is work in progress, additional description of goals is TODO.

TBD