wcampbell0x2a / bintex Goto Github PK

View Code? Open in Web Editor NEW

4.0 4.0 0.0 89 KB

Create bytefield latex digrams with the use of rust proc-macros and deku

License: Apache License 2.0

Rust 98.90% TeX 1.10%

latex proc-macro rust

bintex's People

Contributors

Stargazers

Watchers

bintex's Issues

Support `leftwordgroup` and `rightwordgroup`

Add `unused` attribute

Support `endianness`

Add `trybuild` compile tests

Custom `bitheader`

Support multi-line bit protocols

Support the following struct:

#[derive(BinTex)]
#[bintex(bit_width = 8)]
struct Example {
    #[bintex(bits = "12")]
    a: u8,
    #[bintex(bits = "6")]
    b: u8,
}

As a bonus feature, this could also use the \bitbox[bltr] bottom,left,top,right notation for not having lines between fields.

Other examples:

The following has the u32 = 32 bits, which would fill 4-8 bit levels

#[derive(BinTex)]
#[bintex(bit_width = "8")]
struct Testing {
    #[deku(bits = "4")]
    a: u8,
    #[deku(bits = "4")]
    b: u8,
    c: u32,
}

Support `bitwidth` and `bitheight`

Add Table generation for Enums

Normal Enum

This is pretty trivial for normal Enums:

#[deku(type = "u8", bits = "4")]
enum DekuTest {
    #[deku(id = "0b1001")]
    VariantA,,
    #[deku(id = "0b0110")]
    VariantB,,
}

That would just emit the enum table.

Figure DekuTest

field	id
VariantA	0b1001
VariantB	0b0110

Advanced Enum

This will be difficult for advanced enums:

#[deku(type = "u8", bits = "4")]
enum DekuTest {
    #[deku(id = "0b1001")]
    VariantA( #[deku(bits = "4")] u8, u8),
}

That latex_output would emit one enum table, and another bytefield for the VariantA.

Figure DekuTest

field	id
VariantA	0b1001

Bytefield VariantA

Support `bgcolor` field for `bitbox`

Example form bytefield docs:

\bitbox{8}[bgcolor=lightgreen]{Exponent}

Use type value `T::BITS` if `bits` not given

Override `ident` for extra string inside field

#[derive(BinTex)]
#[bintex(bit_width = 8)]
struct Example {
    #[bintex(bits = "12", ident = "The A Field is used for Anti Gravity")]
    a: u8,
    #[bintex(bits = "6")]
    b: u8,
}

wcampbell0x2a / bintex Goto Github PK

bintex's People

Contributors

Stargazers

Watchers

bintex's Issues

Normal Enum

Figure DekuTest

Advanced Enum

Figure DekuTest

Bytefield VariantA

Recommend Projects

Recommend Topics

Recommend Org