Attributes

Spice offers the option to annotate single function or whole modules via attributes.

Module attributes¶

1
2
3
4

// Attribute for the whole module
#![core.linker.flag = "-pthread"]

// ...

Available attributes¶

• core.linker.flag: string (default: ""): Append linker flag
• core.linux.linker.flag: string (default: ""): Append linker flag for Linux
• core.darwin.linker.flag: string (default: ""): Append linker flag for macOS
• core.windows.linker.flag: string (default: ""): Append linker flag for Windows
• core.linker.additionalSource: string (default: ""): Compile and link an additional C/C++ source file, given relative to the annotated module
• core.compiler.alwaysKeepOnNameCollision: bool (default: false): Always keep the symbols of this source files when merging the name registries of multiple source files

Function attributes¶

1
2
3
4
5
6

#[core.compiler.mangle = false]
f<int> test(long input) {
    return input == 0 ? 123 : 456;
}

// ...

Available attributes¶

• core.compiler.mangle: bool (default: true): Enable/disable name mangling for the annotated function
• core.compiler.mangledName: string: Set the mangled name for the annotated function
• core.compiler.redZone: bool: Allow or forbid the use of the red zone below the stack pointer in the annotated function. Overrides --no-red-zone, which sets the default for all other functions. Only x86_64 has a red zone. Code that runs while interrupts can push onto its stack, like a kernel, must not use it. The experimental TPDE backend always uses the red zone on x86_64, so it rejects false there (on AArch64, the value is accepted and has no effect)
• test: bool: Mark the annotated function as test
• test.name: string: Set the name of the test (only functions or procedures with the test attribute are considered as tests)
• test.skip: bool: Skip the annotated function (only functions or procedures with the test attribute are considered as tests)

External declaration attributes¶

External declarations are not name-mangled by default, so they link against C symbols (and extern "C" C++ symbols) without any attribute.

1
2
3
4

#[core.compiler.mangledName = "strlen"]
ext f<unsigned long> cStringLength(string);

// ...

Available attributes¶

• core.compiler.mangle: bool (default: false): Enable/disable name mangling for the annotated declaration, e.g. to link against a Spice function from another compilation unit
• core.compiler.mangledName: string: Set the linker symbol for the annotated declaration
• core.linker.dll: bool: Enable linkage as dll (only relevant for Windows)

Struct attributes¶

1
2
3
4

#[core.compiler.alwaysEmitVTable = true]
public type A struct {
    // ...
}

Available attributes¶

• core.compiler.alwaysEmitVTable: bool: Always emit a vtable for the annotated struct
• core.compiler.packed: bool: Pack the annotated struct

Interface attributes¶

1
2
3
4

#[core.compiler.fixedTypeId = 230]
public type A interface {
    // ...
}

Available attributes¶

• core.compiler.fixedTypeId: int: Set a fixed type id for the annotated interface. Intended for internal use only.