configure_file()

This function can run in three modes depending on the keyword arguments passed to it.

When a cfg_data object is passed to the configuration: keyword argument, it takes a template file as the input: (optional) and produces the output: (required) by substituting values from the configuration data as detailed in the configuration file documentation. (since 0.49.0) A dictionary can be passed instead of a cfg_data object.

When an array of strings is passed to the command: keyword argument, it takes any source or configured file as the input: and assumes that the output: is produced when the specified command is run.

You can install the outputted file with the install_dir: kwarg, see below.

(since 0.47.0) When the copy: keyword argument is set to true, this function will copy the file provided in input: to a file in the build directory with the name output: in the current directory.

Signature

# This function can run in three modes depending on the keyword arguments
file configure_file(
  build_subdir  : str                                # Places the build results in a subdirectory of the given name rather than directly into the build directory
  capture       : bool                               # When this argument is set to true,
  command       : array[str | file]                  # As explained above, if specified, Meson does not create
  configuration : cfg_data | dict[str | int | bool]  # As explained above, when passed this will provide the replacement
  copy          : bool                               # As explained above, if specified Meson only
  depfile       : str                                # A dependency file that the command can write listing
  encoding      : str                                # Set the file encoding for the input and output file
  format        : str                                # The format of defines
  input         : str | file                         # The input file name
  install       : bool                               # When true, this generated file is installed during
  install_dir   : str                                # The subdirectory to install the generated file to
  install_mode  : array[str | int]                   # Specify the file mode in symbolic format
  install_tag   : str                                # A string used by the `meson install --tags` command
  macro_name    : str                                # When specified, macro guards will be used instead of '#pragma once'
  output        : str                                # The output file name
  output_format : str                                # The format of the output to generate when no input
)

Arguments

The function configure_file() accepts the following keyword arguments:

Name	Type	Description	Tags
`build_subdir`	`str`	Places the build results in a subdirectory of the given name rather than directly into the build directory. This does not affect the install directory, which uses install_dir. This allows inserting a directory name into the build path, either when needed to use the build result while building other targets or as a way to support multiple targets with the same basename by using unique build_subdir values for each one. To prevent collisions within the build directory, build_subdir is not allowed to match a file or directory in the source directory, nor contain '..' to refer to the parent of the build directory.	(since 1.10.0)
`capture`	`bool`	When this argument is set to true, Meson captures `stdout` of the `command` and writes it to the target file specified as `output`.	(since 0.41.0) `default = false`
`command`	`array`[`str` \| `file`]	As explained above, if specified, Meson does not create the file itself but rather runs the specified command, which allows you to do fully custom file generation. (since 0.52.0) The command can contain file objects and more than one file can be passed to the `input` keyword argument, see `custom_target()` for details about string substitutions.
`configuration`	`cfg_data` \| `dict`[`str` \| `int` \| `bool`]	As explained above, when passed this will provide the replacement data for the input file (if provided) or key value pairs to be written to the output.
`copy`	`bool`	As explained above, if specified Meson only copies the file from input to output.	(since 0.47.0) `default = false`
`depfile`	`str`	A dependency file that the command can write listing all the additional files this target depends on. A change in any one of these files triggers a reconfiguration.	(since 0.52.0)
`encoding`	`str`	Set the file encoding for the input and output file. The supported encodings are those of python3, see standard-encodings.	(since 0.47.0) `default = 'utf-8'`
`format`	`str`	The format of defines. It defaults to `'meson'`, and so substitutes `#mesondefine` statements and variables surrounded by `@` characters, you can also use `'cmake'` to replace `#cmakedefine` statements and variables with the `${variable}` syntax. Finally you can use `'cmake@'` in which case substitutions will apply on `#cmakedefine` statements and variables with the `@variable@` syntax.	(since 0.46.0) `default = 'meson'`
`input`	`str` \| `file`	The input file name. If it's not specified in configuration mode, all the variables in the `configuration:` object (see above) are written to the `output:` file.
`install`	`bool`	When true, this generated file is installed during the install step, and `install_dir` must be set and not empty. When false, this generated file is not installed regardless of the value of `install_dir`. When omitted it defaults to true when `install_dir` is set and not empty, false otherwise.	(since 0.50.0) `default = false`
`install_dir`	`str`	The subdirectory to install the generated file to (e.g. `share/myproject`), if omitted or given the value of empty string, the file is not installed.
`install_mode`	`array`[`str` \| `int`]	Specify the file mode in symbolic format and optionally the owner/uid and group/gid for the installed files. See the `install_mode` kwarg of `install_data()` for more information.	(since 0.47.0)
`install_tag`	`str`	A string used by the `meson install --tags` command to install only a subset of the files. By default the file has no install tag which means it is not being installed when `--tags` argument is specified.	(since 0.60.0)
`macro_name`	`str`	When specified, macro guards will be used instead of '#pragma once'. The macro guard name will be the specified name.	(since 1.3.0)
`output`	`str`	The output file name. (since 0.41.0) may contain `@PLAINNAME@` or `@BASENAME@` substitutions, as well as (since 1.5.0) their indexed versions, like `@PLAINNAME0@` or `@BASENAME0@`. In configuration mode, the permissions of the input file (if it is specified) are copied to the output file.
`output_format`	`str`	The format of the output to generate when no input was specified. It defaults to `c`, in which case preprocessor directives will be prefixed with `#`, you can also use `nasm`, in which case the prefix will be `%`. (since 1.3.0) `json` format can also be used.	(since 0.47.0)

The results of the search are

Edit on GitHub