Configuration data object (cfg_data)

This object encapsulates configuration values to be used for generating configuration files. A more in-depth description can be found in the the configuration page.

This object becomes immutable after first use. This means that calling set() or merge_from() will cause an error if this object has already been used in any function arguments. However, assignment creates a mutable copy.

Returned by

Configuration data object objects are returned by the following functions and methods:

• configuration_data()

Configuration data object methods

cfg_data.get()

Returns the value of varname, if the value has not been set returns default_value if it is defined (since 0.38.0) and errors out if not

# Returns the value of `varname`, if the
str | int | bool get(
  str              varname,           # The name of the variable to query
  str | int | bool [default_value],   # The default value to return when `varname` does not exist
)

Arguments

The method cfg_data.get() accepts the following positional arguments:

Name	Type	Description	Tags
varname	str	The name of the variable to query
default_value	str | int | bool	The default value to return when varname does not exist	[optional]

---

cfg_data.get_unquoted()

Returns the value of varname but without surrounding double quotes ("). If the value has not been set returns default_value if it is defined and errors out if not.

# Returns the value
str | int | bool get_unquoted(
  str              varname,           # The name of the variable to query
  str | int | bool [default_value],   # The default value to return when `varname` does not exist
)

Arguments

The method cfg_data.get_unquoted() accepts the following positional arguments:

Name	Type	Description	Tags
varname	str	The name of the variable to query
default_value	str | int | bool	The default value to return when varname does not exist	[optional]

---

cfg_data.has()

returns true if the specified variable is set

# returns `true` if the specified variable is set
bool has(
  str varname,     # The name of the variable to query
)

Arguments

The method cfg_data.has() accepts the following positional arguments:

Name	Type	Description	Tags
varname	str	The name of the variable to query

---

cfg_data.keys()

Returns an array of keys of the configuration data object.

You can iterate over this array with the foreach statement.

list[str] keys()

---

cfg_data.merge_from()

Takes as argument a different configuration data object and copies all entries from that object to the current.

# Takes as argument a different
void merge_from(
  cfg_data other,     # The other cfg_data object to merge into this one.
)

Arguments

The method cfg_data.merge_from() accepts the following positional arguments:

Name	Type	Description	Tags
other	cfg_data	The other cfg_data object to merge into this one.

---

cfg_data.set()

Sets a variable to a given value

# Sets a variable to a given value
void set(
  str              varname,     # The name of the variable to set
  str | int | bool value,       # The value to set

  # Keyword arguments:
  description : str  # Message / Comment that will be written in the
)

Arguments

The method cfg_data.set() accepts the following positional arguments:

Name	Type	Description	Tags
varname	str	The name of the variable to set
value	str | int | bool	The value to set

Finally, cfg_data.set() accepts the following keyword arguments:

Name	Type	Description	Tags
description	str	Message / Comment that will be written in the result file. The replacement assumes a file with C syntax. If your generated file is source code in some other language, you probably don't want to add a description field because it most likely will cause a syntax error.

---

cfg_data.set10()

Is the same as cfg_data.set() but the value is either true or false and will be written as 1 or 0, respectively

# Is the same as cfg_data.set() but the value
void set10(
  str        varname,     # The name of the variable to set
  bool | int value,       # The value to set as either `1` or `0`

  # Keyword arguments:
  description : str  # Message / Comment that will be written in the
)

Arguments

The method cfg_data.set10() accepts the following positional arguments:

Name	Type	Description	Tags
varname	str	The name of the variable to set
value	bool | int	The value to set as either 1 or 0 Passing numbers was never intended to work, and since 0.62 it has been deprecated. It will be removed in a future version of Meson. If you need to pass numbers use the .set method.

Finally, cfg_data.set10() accepts the following keyword arguments:

Name	Type	Description	Tags
description	str	Message / Comment that will be written in the result file. The replacement assumes a file with C syntax. If your generated file is source code in some other language, you probably don't want to add a description field because it most likely will cause a syntax error.

---

cfg_data.set_quoted()

Is same as cfg_data.set() but quotes the value in double quotes (")

# Is same as cfg_data.set() but quotes the value in double quotes (`"`)
void set_quoted(
  str              varname,     # The name of the variable to set
  str | int | bool value,       # The value to set

  # Keyword arguments:
  description : str  # Message / Comment that will be written in the
)

Arguments

The method cfg_data.set_quoted() accepts the following positional arguments:

Name	Type	Description	Tags
varname	str	The name of the variable to set
value	str | int | bool	The value to set

Finally, cfg_data.set_quoted() accepts the following keyword arguments:

Name	Type	Description	Tags
description	str	Message / Comment that will be written in the result file. The replacement assumes a file with C syntax. If your generated file is source code in some other language, you probably don't want to add a description field because it most likely will cause a syntax error.

---