Struct AddCustomTarget

pub struct AddCustomTarget<'t> {
    pub name: Token<'t>,
    pub all: bool,
    pub commands: Option<Vec<CustomCommand<'t>>>,
    pub depends: Option<Vec<Token<'t>>>,
    pub byproducts: Option<Vec<Token<'t>>>,
    pub working_directory: Option<Token<'t>>,
    pub comment: Option<Token<'t>>,
    pub job_pool: Option<Token<'t>>,
    pub verbatim: bool,
    pub uses_terminal: bool,
    pub command_expand_lists: bool,
    pub sources: Option<Vec<Token<'t>>>,
}

Add a target with no output so it will always be built.

Adds a target with the given name that executes the given commands. The target has no output file and is always considered out of date even if the commands try to create a file with the name of the target. Use the add_custom_command() command to generate a file with dependencies. By default nothing depends on the custom target. Use the add_dependencies() command to add dependencies to or from other targets.

Reference: https://cmake.org/cmake/help/v3.26/command/add_custom_target.html

Fields

name: Token<'t>

all: bool

Indicate that this target should be added to the default build target so that it will be run every time (the command cannot be called ALL).

commands: Option<Vec<CustomCommand<'t>>>

Specify the command-line(s) to execute at build time. If more than one COMMAND is specified they will be executed in order, but not necessarily composed into a stateful shell or batch script. (To run a full script, use the configure_file() command or the file(GENERATE) command to create it, and then specify a COMMAND to launch it.)

depends: Option<Vec<Token<'t>>>

Reference files and outputs of custom commands created with add_custom_command() command calls in the same directory (CMakeLists.txt file). They will be brought up to date when the target is built.

byproducts: Option<Vec<Token<'t>>>

Specify the files the command is expected to produce but whose modification time may or may not be updated on subsequent builds. If a byproduct name is a relative path it will be interpreted relative to the build tree directory corresponding to the current source directory. Each byproduct file will be marked with the GENERATED source file property automatically.

working_directory: Option<Token<'t>>

Execute the command with the given current working directory. If it is a relative path it will be interpreted relative to the build tree directory corresponding to the current source directory.

comment: Option<Token<'t>>

Display the given message before the commands are executed at build time.

job_pool: Option<Token<'t>>

Specify a pool for the Ninja generator. Incompatible with USES_TERMINAL, which implies the console pool. Using a pool that is not defined by JOB_POOLS causes an error by ninja at build time.

verbatim: bool

All arguments to the commands will be escaped properly for the build tool so that the invoked command receives each argument unchanged. Note that one level of escapes is still used by the CMake language processor before add_custom_target even sees the arguments. Use of VERBATIM is recommended as it enables correct behavior. When VERBATIM is not given the behavior is platform specific because there is no protection of tool-specific special characters.

uses_terminal: bool

The command will be given direct access to the terminal if possible. With the Ninja generator, this places the command in the console pool.

command_expand_lists: bool

Lists in COMMAND arguments will be expanded, including those created with generator expressions, allowing COMMAND arguments such as ${CC} “-I$<JOIN:$<TARGET_PROPERTY:foo,INCLUDE_DIRECTORIES>,;-I>” foo.cc to be properly expanded.

sources: Option<Vec<Token<'t>>>

Specify additional source files to be included in the custom target. Specified source files will be added to IDE project files for convenience in editing even if they have no build rules.

Trait Implementations

impl<'t> CMakeParse<'t> for AddCustomTarget<'t>

fn parse<'tv>( tokens: &'tv [Token<'t>], ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

fn complete(tokens: &[Token<'t>]) -> Result<Self, CommandParseError>

fn default_value() -> Option<Self>

fn matches( &self, field_keyword: &[u8], keyword: &[u8], tokens: &[Token<'t>], ) -> bool

fn matches_type( field_keyword: &[u8], keyword: &[u8], tokens: &[Token<'t>], ) -> bool

fn need_update( field_keyword: &[u8], keyword: &Token<'t>, buffer: &[Token<'t>], ) -> bool

fn start<'tv>( &mut self, field_keyword: &[u8], keyword: &Token<'t>, tokens: &'tv [Token<'t>], buffer: &mut Vec<Token<'t>>, ) -> Result<(bool, &'tv [Token<'t>]), CommandParseError>

fn rest<'tv>(tokens: &'tv [Token<'t>]) -> &'tv [Token<'t>]

fn need_push_keyword(keyword: &Token<'t>) -> bool

fn update_mode(keyword: &Token<'t>) -> bool

fn update<'tv>( &mut self, tokens: &'tv [Token<'t>], ) -> Result<(), CommandParseError>

fn end<'tv>(self, tokens: &'tv [Token<'t>]) -> Result<Self, CommandParseError>

fn push_keyword( &mut self, buffer: &mut Vec<Token<'t>>, keyword: &Token<'t>, ) -> bool

fn reset_mode() -> bool

impl<'t> CMakePositional<'t> for AddCustomTarget<'t>

fn positional<'tv>( default_name: &'static [u8], tokens: &'tv [Token<'t>], has_keyword: bool, ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

fn positional_complete<'tv>( default_name: &'static [u8], tokens: &'tv [Token<'t>], has_keyword: bool, ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

fn in_range<'tv>( default_name: &'static [u8], to: &'static [u8], allow_empty: bool, tokens: &'tv [Token<'t>], has_keyword: bool, ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

impl<'t> Clone for AddCustomTarget<'t>

fn clone(&self) -> AddCustomTarget<'t>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'t> Debug for AddCustomTarget<'t>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'t> Hash for AddCustomTarget<'t>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'t> Ord for AddCustomTarget<'t>

fn cmp(&self, other: &AddCustomTarget<'t>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'t> PartialEq for AddCustomTarget<'t>

fn eq(&self, other: &AddCustomTarget<'t>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'t> PartialOrd for AddCustomTarget<'t>

fn partial_cmp(&self, other: &AddCustomTarget<'t>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'t> ToCommandScope for AddCustomTarget<'t>

fn to_command_scope(&self) -> CommandScope

impl<'t> Eq for AddCustomTarget<'t>

impl<'t> StructuralPartialEq for AddCustomTarget<'t>