cmake.utils/option

cmake.utils/option.__define_socmake_option(NAME TYPE DESCRIPTION DEFAULT **kwargs)
cmake.utils/option.option_enum(VARIABLE DESCRIPTION ENUM_VALUES DEFAULT)

Create a CMake integer option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters:

  • VARIABLE (string) – name of the variable.

  • DESCRIPTION (string) – short description string for the variable

  • ENUM_VALUES (list[string]) – possible values variable can have

  • DEFAULT (integer) – default value of the variable

cmake.utils/option.option_string(VARIABLE DESCRIPTION DEFAULT)

Create a CMake integer option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters:

  • VARIABLE (string) – name of the variable.

  • DESCRIPTION (string) – short description string for the variable

  • DEFAULT (string) – default value of the variable

cmake.utils/option.option_integer(VARIABLE DESCRIPTION DEFAULT)

Create a CMake integer option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters:

  • VARIABLE (string) – name of the variable.

  • DESCRIPTION (string) – short description string for the variable

  • DEFAULT (integer) – default value of the variable

cmake.utils/option.option_boolean(VARIABLE DESCRIPTION DEFAULT)

Create a CMake boolean option that can be modified through CLI. Option defined this way will be visible in cmake-gui interface as well as SoCMake help_options() help menu. To override the variable use cmake -D<VARIABLE>=<VALUE>

Parameters:

  • VARIABLE (string) – name of the variable.

  • DESCRIPTION (string) – short description string for the variable

  • DEFAULT (boolean) – default value of the variable

${VARIABLE}

Note

This variable is a user-editable option, meaning it appears within the cache and can be edited on the command line by the -D flag.

Help text:

${DESCRIPTION}

Default value:

${DEFAULT}

Type:

bool