root

_{^{This page applies to v0.1-alpha}}
home > 0.1-alpha home > 0.1-alpha reference home

TODO

14 members:

• arch
• artefact_root
• buildsystem
• buildsystem_root
• defaults
• generated_src_root
• glob
• method
• platform
• shared
• src_ext
• target
• vcfiletype
• workspace

arch

Target architecture

K	V
variant	single
type	choice
choices	:x86, :x86_64
default	:x86_64

artefact_root

Root of generated build artefacts

K	V
variant	single
type	dir

Notes

• Does not check if path exists at generation time

Flags

K	V
:force	Suppress warning if path does not exist

buildsystem

Target build system

K	V
variant	single
type	choice
choices	:vs2019, :vs2022
default	:vs2022

buildsystem_root

Root of generated build system

K	V
variant	single
type	dir

Notes

• Does not check if path exists at generation time

Flags

K	V
:force	Suppress warning if path does not exist

defaults

Set target defaults at file or global scope

K	V
variant	array
elem type	block

Notes

• Unsorted
• Duplicates are allowed

Options

scope

Scope

K	V
variant	single
type	choice
choices	:file, :global

Notes

• Must be specified

configs

Build configurations

K	V
variant	array
elem type	string
default	[:debug, :release]

Notes

• Default value is overwritten rather than extended Examples

configs [:debug, :release]

virtual

Virtual

K	V
variant	single
type	bool
default	false

Notes

• Virtual targets do not inherit defaults

generated_src_root

Root location where for src files created during build

K	V
variant	single
type	dir

Notes

• Does not check if path exists at generation time

Flags

K	V
:force	Suppress warning if path does not exist

glob

Glob for files

method

Define a utility method

platform

Target platform

K	V
variant	single
type	choice
choices	:windows
default	:windows

shared

Define a shared definition

src_ext

File extensions used when matching src files

K	V
variant	array
elem type	ext

Notes

• Defaults to standard C/C++ file types and host/platform-specific files, but more can be added for informational purposes.
• Unsorted

target

Define a target

vcfiletype

VisualC file types

K	V
variant	hash
key type	ext
value type	string
default	{".h"=>:ClInclude, ".inl"=>:ClInclude, ".hpp"=>:ClInclude, ".cpp"=>:ClCompile, ".c"=>:ClCompile, ".cxx"=>:ClCompile, ".cc"=>:ClCompile, ".png"=>:Image, ".asm"=>:MASM, ".rc"=>:ResourceCompile, ".natvis"=>:Natvis}

workspace

Define a workspace

_{^{Generated using Redcarpet, CodeRay, Inter and FiraCode. css by Harry Denholm.}}