Menu
Search

Library Reference

version 2.112.0

overview

Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using a local clone.

dmd.common.bitfields

A library bitfields utility
Authors:
Dennis Korpel
License:
Boost License 1.0

Source common/bitfields.d

Documentation https://dlang.org/phobos/dmd_common_bitfields.html

Coverage https://codecov.io/gh/dlang/dmd/src/master/compiler/src/dmd/common/bitfields.d

string generateBitFields(S, T, string field = "", int bitOff = 0, int ID = __LINE__)()
if (__traits(isUnsigned, T));
Generate code for bit fields inside a struct/class body
Parameters:
S type of a struct with only boolean fields, which should become bit fields
T type of bit fields variable, must have enough bits to store all booleans
field if provided, assume it is declared and initialized elsewhere
bitOff start using bits at the given offset
Returns:
D code with a bit fields variable and getter / setter functions
Examples: 
enum E
{
    a, b, c,
}

static struct B
{
    bool x;
    bool y;
    E e = E.c;
    bool z = 1;
    private ubyte w = 77;
}

static struct S
{
    mixin(generateBitFields!(B, ushort));
}

S s;
assert(!s.x);
s.x = true;
assert(s.x);
s.x = false;
assert(!s.x);

s.y = true;
assert(s.y);
assert(!s.x);

assert(s.e == E.c);
s.e = E.a;
assert(s.e == E.a);

assert(s.z);
assert(s.w == 77);
s.w = 3;
assert(s.w == 3);