Reflection

C3 allows both compile time and runtime reflection.

During compile time, some type information is available in the form of compile time constants associated with each type.

Runtime type information is also available by retrieving a typeid from a runtime object (such as from an object of type any via <runtime_obj>.type most commonly) and then comparing the properties of the returned runtime typeid against the corresponding properties (if any) of the compile time equivalent <type>.typeid. Note however that run time typeids currently have a much smaller set of available properties.

See the documentation about the any type for more information if you want or need runtime reflection. Such runtime info can be switched on or conditionally checked (e.g. via <runtime_obj>.type == <type>.typeid) to implement runtime polymorphism.

Compile time reflection in 0.7.x

During compile time there are many compile time fields that may be accessed using “dot notation” of the form <type>.<property>. That works for types, but in contrast when you want to retrieve type information about values or other expressions then try the $ functions instead.

For example, notice that <type>.sizeof and $sizeof(<value>) do not operate on the same kinds of entities. The former is for types whereas the later is for values.

They can nonetheless be used to achieve similar effects though. For example, the following assertions all pass:

$assert(short.sizeof == $sizeof((short)0));

short sh = 0;
$assert($sizeof(sh) == $typeof(sh).sizeof);

Type properties

Here are the property-like (“dot notation”) constants associated with each type:

• alignof
• associated
• elements
• extnameof
• inf
• inner
• kindof
• len
• max
• membersof
• methodsof
• min
• nan
• nameof
• names
• paramsof
• parentof
• qnameof
• returns
• sizeof
• typeid
• values

Many of these properties are very useful for writing generics macros and contracts.

alignof

Returns the alignment in bytes needed for the type.

struct Foo @align(8)
{
    int a;
}

uint a = Foo.alignof; // 8

associated

Only available for enums. Returns an array containing the types of associated values if any.

enum Foo : int (double d, String s)
{
    BAR { 1.0, "normal" },
    BAZ { 2.0, "exceptional" }
}
String s = Foo.associated[0].nameof; // "double"

inf

Only available for floating point types

Returns a representation of floating point “infinity”.

inner

This returns a typeid to an “inner” type. What this means is different for each type:

• Array -> the array base type.
• Bitstruct -> underlying base type.
• Distinct -> the underlying type.
• Enum -> underlying enum base type.
• Pointer -> the type being pointed to.
• Vector -> the vector base type.

It is not defined for other types.

kindof

Returns the underlying TypeKind as defined in std::core::types.

TypeKind kind = int.kindof; // TypeKind.SIGNED_INT

len

Returns the length of the array. For enums and constdefs, it will return the number of constants.

enum Foo
{
    BAR,
    BAZ
}
usz len = int[4].len; // 4
int foo_values = Foo.len; // 2

max

Returns the maximum value of the type (only valid for integer and float types).

ushort max_ushort = ushort.max; // 65535

membersof

Only available for bitstruct, struct and union types.

Returns a compile time list containing the fields in a bitstruct, struct or union. The elements have the compile time only type of member_ref.

Note: As the list is an “untyped” list, you are limited to iterating and accessing it at compile time.

struct Baz
{
    int x;
    Foo* z;
}
String x = Baz.membersof[1].nameof; // "z"

A member_ref has properties alignof, kindof, membersof, nameof, offsetof, sizeof and typeid.

methodsof

This property returns the methods associated with a type as a constant array of strings.

Methods are generally registered after types are registered, which means that the use of “methodsof” may return inconsistent results depending on where in the resolution cycle it is invoked. It is always safe to use inside a function.

min

Returns the minimum value of the type (only valid for integer and float types).

ichar min_ichar = ichar.min; // -128

nameof

Returns the name of the type.

names

Returns a slice containing the names of an enum.

enum FooEnum
{
    BAR,
    BAZ
}
String[] x = FooEnum.names; // ["BAR", "BAZ"]

paramsof

Only available for function pointer types. Returns a ReflectedParam struct for all function pointer parameters.

alias TestFunc = fn int(int x, double f);
String s = TestFunc.paramsof[1].name; // "f"
typeid t = TestFunc.paramsof[1].type; // double.typeid

parentof

Only available for bitstruct and struct types. Returns the typeid of the parent type.

struct Foo
{
    int a;
}

struct Bar
{
    inline Foo f;
}

String x = Bar.parentof.nameof; // "Foo"

returns

Only available for function types. Returns the typeid of the return type.

alias TestFunc = fn int(int, double);
String s = TestFunc.returns.nameof; // "int"

sizeof

Returns the size in bytes for the given type, like C sizeof.

usz x = Foo.sizeof;

typeid

Returns the typeid for the given type. aliass will return the typeid of the underlying type. The typeid size is the same as that of an iptr.

typeid x = Foo.typeid;

values

Returns a slice containing the values of an enum.

enum FooEnum
{
    BAR,
    BAZ
}
String x = FooEnum.values[1].nameof; // "BAR"

Compile time reflection in 0.8+

Starting from 0.8.0, compile time information about types is accessed using ::, e.g. MyType::size.

For values use $reflect(<value>) to access the reflected properties for the underlying value.

The exception is $typeof(<value>), which creates a type from the type of the value. There are convenience macros like @sizeof(<value>), @kindof(<value>) for immediately accessing reflection data without explicitly invoking $reflect.

Type properties & functions

The following type properties and functions are available:

• alignment (all runtime types)
• from_ordinal (constdef and enum only)
• has_equals
• is_ordered
• is_substruct (struct only)
• len (array, vector, enum, constdef - runtime available)
• lookup_field (enum)
• max / min (int and float types)
• members (struct, union, enum, bitstruct)
• methods (all non-optional runtime types)
• nan / inf (float types)
• inner (runtime types except int, float, struct and union types)
• kind (runtime available)
• name / qname / cname (cname is limited to all user-defined types)
• params (function types)
• parent (constdef, struct, typedef - runtime available)
• returns (function types)
• size (runtime available)
• typeid (all runtime types + untypedlist)
• get_tag / has_tag (user-defined types)
• values (constdef, enum)

alignment

Returns the alignment in bytes needed for the type.

struct Foo @align(8)
{
    int a;
}

uint a = Foo::alignment; // 8

from_ordinal

Only available for constdef and enum. Converts an integer value to the enum/constdef of that ordinal. In the case of constdef it might be different from the actual value.

has_equals

Is == and != supported.

is_ordered

Are all comparisons supported, either because the type has is built-in or added through operator overloading.

is_substruct

Only available for structs.

True is a struct has an inline member.

len

Returns the length of the array or vector. For enums and constdefs, it will return the number of constants.

enum Foo
{
    BAR,
    BAZ
}
usz len = int[4]::len; // 4
int foo_values = Foo::len; // 2

lookup_field

Only available for enums.

Look up the enum value by matching the first associated value:

enum Foo : (int val)
{
    ABC { 3 },
    LIFF { 42 }
}
...
Foo? foo = Foo::lookup_field(val, 42); // Returns Foo.ABC

max / min

Only available for integer and floating point types.

Returns the maximum / minimum value of the type.

ushort max_ushort = ushort::max; // 65535
ichar min_ichar = ichar::min; // -128

members

Only available for enum, bitstruct, struct and union types.

Returns a compile time list containing the fields in a bitstruct, struct or union. For enums it’s the associated value declarations. The elements are of type reflected_ref, as if you had done $reflect on the element.

Note: As the list is an “untyped” list, you are limited to iterating and accessing it at compile time.

struct Baz
{
    int x;
    Foo* z;
}
String x = Baz::members[1].name; // "z"

methods

This property returns the methods associated with a type as a constant array of strings.

Note

Warning!

Methods are generally registered after types are registered, which means that the use of “methodsof” may return inconsistent results depending on where in the resolution cycle it is invoked. It is always safe to use inside a function.

nan / inf

Only available for floating point types

Returns a representation of floating point “NaN” / “infinity”.

inner

This returns a typeid to an “inner” type. What this means is different for each type:

• Array -> the array base type.
• Bitstruct -> underlying base type.
• Distinct -> the underlying type.
• Enum -> underlying enum base type.
• Pointer -> the type being pointed to.
• Vector -> the vector base type.

It is not defined for other types.

kind

Returns the underlying TypeKind as defined in std::core::types.

TypeKind kind = int::kind; // TypeKind.SIGNED_INT

name / qname / cname

Returns the name of the type: qname is the qualified name, so adds the module path before the name. cname returns the external name, and as such isn’t available for built-in types.

params

Only available for function pointer types. Returns a ReflectedParam struct for all function pointer parameters.

alias TestFunc = fn int(int x, double f);
String s = TestFunc::params[1].name; // "f"
typeid t = TestFunc::params[1].type; // double.typeid

parent

Only available for typedef, constdef, bitstruct and struct types.

Returns the typeid of the inline field.

struct Foo
{
    int a;
}

struct Bar
{
    inline Foo f;
}

String x = Bar::parent.name; // "Foo"

returns

Only available for function types. Returns the typeid of the return type.

alias TestFunc = fn int(int, double);
String s = TestFunc::returns.name; // "int"

size

Returns the size in bytes for the given type, like C sizeof.

usz x = Foo::size;

get_tag / has_tag

get_tag retrieves the value of a @tag defined on the type, has_tag is used to check if the tag exists.

typeid

Returns the typeid for the given type. aliass will return the typeid of the underlying type. The typeid size is the same as that of an iptr.

typeid x = Foo.typeid;

values

Returns a slice containing the values of an enum or constdef.

enum FooEnum
{
    BAR,
    BAZ
}
String x = FooEnum.values[1].description; // "BAR"

Compile time functions

There are several built-in functions to inspect the code during compile time.

• $alignof 0.7.x only
• $defined
• $eval
• $evaltype
• $extnameof 0.7.x only
• $nameof 0.7.x only
• $offsetof 0.7.x only
• $qnameof 0.7.x only
• $sizeof 0.7.x only
• $stringify
• $typeof
• $reflect 0.8+

$defined

Returns true when the expression(s) inside are defined and all sub expressions are valid.

$defined(Foo);       // => true
$defined(Foo.x);     // => true
$defined(Foo.baz);   // => false

Foo foo = {};
// Check if a method exists:
$if $defined(foo.call):
    // Check what the method accepts:
    $switch :
       $case $defined(foo.call(1)) :
           foo.call(1);
       $default :
           // do nothing
    $endswitch
$endif

// Other way to write that:
$if $defined(foo.call, foo.call(1)):
    foo.call(1);
$endif

The full list of what $defined can check:

• SomeType a = <expr> - checks if <expr> can be used to initialize a variable of type SomeType
• var $a = <expr> - checks if <expr> can be compile-time evaluated.
• *<expr> - checks if <expr> can be dereferenced, <expr> must already be valid
• <expr>[<index>] - checks if indexing is valid, <expr> and <index> must already be valid, and when possible to check at compile-time if <index> is out of bounds this will return false
• <expr>[<index>] = <value> - same as above, but also checks if <value> can be assigned, <expr>, <index> and <value> must already be valid
• <expr>.<ident1>.<ident2> - check if .<ident2> is valid, <expr>.<ident1> must already be valid (“ident” is short for “identifier”)
• ident, #ident, @ident, IDENT, $$IDENT, $ident - check if identifier exists
• Type - check if the type exists
• &<expr> - check if you can take the address of <expr>, <expr> must already be valid
• &&<expr> - check if you can take the temporary address of <expr>, <expr> must already be valid
• $eval(<expr>) - check if the $eval evaluates to something valid, <expr> must already be valid
• <expr>(<arg0>, ...) - check that the arguments are valid for the <expr> macro/function, <expr> and all args must already be valid
• <expr>!! and <expr>! - check that <expr> is an optional, <expr> must already be valid
• <expr>? - check that <expr> is a fault, <expr> must already be valid
• <expr1> binary_operator <expr2> - check if the binary_operator (+, -, …) is defined between the two expressions, both expressions must already be valid
• (<Type>)<expr> - check if <expr> can be casted to <Type>, both <Type> and <expr> must already be valid

If for example <expr> is not defined when trying (<Type>)<expr> this will result in a compile-time error.

$eval

Converts a compile time string with the corresponding variable:

int a = 123;         // => a is now 123
$eval("a") = 222;    // => a is now 222
$eval("mymodule::fooFunc")(a); // => same as mymodule::fooFunc(a)

$eval is limited to a single, optionally path prefixed, identifier. Consequently methods cannot be evaluated directly:

struct Foo { ... }
fn int Foo.test(Foo* f) { ... }

fn void test()
{
    void* test1 = &$eval("test"); // Works
    void* test2 = &Foo.$eval("test"); // Works
    // void* test3 = &$eval("Foo.test"); // Error
}

$evaltype

Similar to $eval but for types:

$evaltype("float") f = 12.0f;

$reflect

Returns a reflection_ref of the expression. It can be queried for properties such as name, size, offset, alignment etc.

More information is forthcoming.

$stringify

Returns the expression as a string. $stringify has a special behaviour for handling macro expression parameters, where $stringify(#foo) will return the expression contained in #foo as a string, exactly as written in the macro call’s arguments, rather than simply return "#foo".

Thus, for example:

import std::io;

macro @describe(#expr)
{
  io::printfn("The value of `%s` is `%s`.", $stringify(#expr), #expr);
}

fn void main()
{
  @describe(isz.sizeof);
  //Prints:
  //  The value of `isz.sizeof` is `8`.
}

$typeof

Returns the type of an expression or variable.

Foo f;
$typeof(f) x = f;

0.7.x only

$alignof

Returns the alignment in bytes needed for the type or member.

module test::bar;

struct Foo
{
    int x;
    char[] y;
}
int g = 123;

$alignof(Foo.x); // => returns 4
$alignof(Foo.y); // => returns 8 on 64 bit
$alignof(Foo);   // => returns 8 on 64 bit
$alignof(g);     // => returns 4

$extnameof

Returns the external name of a type, variable or function. The external name is the one used by the linker.

fn void testfn(int x) { }
String a = $extnameof(g); // => "test.bar.g";
String b = $extnameof(testfn); // => "test.bar.testfn"

$nameof

Returns the name of a function or variable as a string without module prefixes.

fn void test() { }
int g = 1;

String a = $nameof(g); // => "g"
String b = $nameof(test); // => "test"

$offsetof

Returns the offset of a member in a struct.

Foo z;
$offsetof(z.y); // => returns 8 on 64 bit, 4 on 32 bit

$qnameof

Returns the same as $nameof, but with the full module name prepended.

module abc;
fn void test() { }
int g = 1;

String a = $qnameof(g); // => "abc::g"
String b = $qnameof(test); // => "abc::test"

$sizeof

This is used on a value to determine the allocation size needed. $sizeof(a) is equivalent to doing $typeof(a).sizeof. Note that this is only used on values and not on types.

$typeof(a)* x = allocate_bytes($sizeof(a));
*x = a;