Derived Types

The yace derived types consists of:

Their ir representation follows below.

class yace.ir.derivedtypes.Bitfield(*, typ: ~yace.ir.datatypes.Typespec | ~typing.Literal['array_tspec', 'bool_tspec', 'char_tspec', 'enum_tspec', 'f32_tspec', 'f64_tspec', 'function_pointer_tspec', 'i16_tspec', 'i32_tspec', 'i64_tspec', 'i8_tspec', 'i_tspec', 'ih_tspec', 'il_tspec', 'ill_tspec', 'isize_tspec', 'pointer_tspec', 'record_tspec', 'string_tspec', 'u16_tspec', 'u32_tspec', 'u64_tspec', 'u8_tspec', 'u_tspec', 'ul_tspec', 'ull_tspec', 'us_tspec', 'usize_tspec', 'void_pointer_tspec', 'void_tspec'], doc: ~yace.ir.base.Docstring, sym: str, key: str = 'bitfield_decl', ant: dict | None = <factory>, nbits: int)

A representation of a bit-field within a yace.ir.Struct or yace.ir.Union, utilized by compiler to emit code in the C API similar to:

uint32_t foo : 10;

The ‘typ’ and ‘typ.width’ members inherited from Typed describe the type which in the example above it ‘uint32_t’. The width of the bitfield is captured by the field “nbits”

key: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nbits: int
class yace.ir.derivedtypes.BitfieldStruct(*, doc: ~yace.ir.base.Docstring, sym: str, key: str = 'bitfield_struct_decl', ant: dict | None = <factory>, width: int, members: ~typing.List[~yace.ir.derivedtypes.Bitfield])

A struct where all the fields / members are bitfields.

A partitioning of a fixed-width datatype (such as uint32_t) into a subset of named bit-ranges. Commonly encapsualted in C struct. For example:

struct bitfields {
    uint8_t foo : 2;
    uint8_t bar : 3;
    uint8_t baz : 3;
}

By doing so, then a struct-accessor is provided at less-than byte-addressability, which is very convenient. By providing a semanticly rich representation in yace then the actual implementation in a given language can be something better fitted.

For example, the above code in C is not portable, whereas other languages might support portable representations. By providing the abstract bit-field, then the code-emitter can generate what is best-suited for a given language, rather than translating C-representation-idioms as the above into something sub-optimal.

is_valid_members()

Checks whether the bitfield members match the width

key: str
members: List[Bitfield]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

width: int
class yace.ir.derivedtypes.Field(*, typ: ~yace.ir.datatypes.Typespec | ~typing.Literal['array_tspec', 'bool_tspec', 'char_tspec', 'enum_tspec', 'f32_tspec', 'f64_tspec', 'function_pointer_tspec', 'i16_tspec', 'i32_tspec', 'i64_tspec', 'i8_tspec', 'i_tspec', 'ih_tspec', 'il_tspec', 'ill_tspec', 'isize_tspec', 'pointer_tspec', 'record_tspec', 'string_tspec', 'u16_tspec', 'u32_tspec', 'u64_tspec', 'u8_tspec', 'u_tspec', 'ul_tspec', 'ull_tspec', 'us_tspec', 'usize_tspec', 'void_pointer_tspec', 'void_tspec'], doc: ~yace.ir.base.Docstring, sym: str, key: str = 'field_decl', ant: dict | None = <factory>)

A representation of yace.ir.Struct and yace.ir.Union, utilized by compiler to emit code in the C API similar to:

uint32_t bar;

That is, within a struct/union block e.g.:

struct foo {
    uint32_t bar;
};

The ‘typ’ and ‘typ.width’ members inherited from Typed are utilized to produce a fitting type-declaration for the target language, as in the examples above for C.

key: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class yace.ir.derivedtypes.Struct(*, doc: ~yace.ir.base.Docstring, sym: str, key: str = 'struct_decl', ant: dict | None = <factory>, members: ~typing.List[~yace.ir.derivedtypes.Field | ~yace.ir.derivedtypes.Bitfield])

A representation of a struct definition

key: str
members: List[Field | Bitfield]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class yace.ir.derivedtypes.Union(*, doc: ~yace.ir.base.Docstring, sym: str, key: str = 'union_decl', ant: dict | None = <factory>, members: ~typing.List[~yace.ir.derivedtypes.Field | ~yace.ir.derivedtypes.Bitfield])

Representation of enumerations / collections of constants

key: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].