list — CMake 4.0.1 Documentation (original) (raw)

Operations on semicolon-separated lists.

Synopsis¶

Reading list(LENGTH ) list(GET [ ...] ) list(JOIN ) list(SUBLIST )

Search list(FIND )

Modification list(APPEND [...]) list(FILTER {INCLUDE | EXCLUDE} REGEX ) list(INSERT [...]) list(POP_BACK [...]) list(POP_FRONT [...]) list(PREPEND [...]) list(REMOVE_ITEM ...) list(REMOVE_AT ...) list(REMOVE_DUPLICATES ) list(TRANSFORM [...])

Ordering list(REVERSE ) list(SORT [...])

Introduction¶

The list subcommands APPEND, INSERT, FILTER,PREPEND, POP_BACK, POP_FRONT, REMOVE_AT,REMOVE_ITEM, REMOVE_DUPLICATES, REVERSE andSORT may create new values for the list within the current CMake variable scope. Similar to the set() command, the list command creates new variable values in the current scope, even if the list itself is actually defined in a parent scope. To propagate the results of these operations upwards, use set() with PARENT_SCOPE,set() with CACHE INTERNAL, or some other means of value propagation.

Note

A list in cmake is a ; separated group of strings. To create a list, the set() command can be used. For example,set(var a b c d e) creates a list with a;b;c;d;e, andset(var "a b c d e") creates a string or a list with one item in it. (Note that macro arguments are not variables, and therefore cannot be used in LIST commands.)

Individual elements may not contain an unequal number of [ and ]characters, and may not end in a backslash (\). See semicolon-separated lists for details.

Note

When specifying index values, if <element index> is 0 or greater, it is indexed from the beginning of the list, with 0 representing the first list element. If <element index> is -1 or lesser, it is indexed from the end of the list, with -1 representing the last list element. Be careful when counting with negative indices: they do not start from 0. -0 is equivalent to 0, the first list element.

Reading¶

list(LENGTH )¶

Returns the list's length.

list(GET [ ...] )¶

Returns the list of elements specified by indices from the list.

list(JOIN )¶

Added in version 3.12.

Returns a string joining all list's elements using the glue string. To join multiple strings, which are not part of a list, use string(JOIN).

list(SUBLIST )¶

Added in version 3.12.

Returns a sublist of the given list. If <length> is 0, an empty list will be returned. If <length> is -1 or the list is smaller than <begin>+<length> then the remaining elements of the list starting at <begin> will be returned.

Search¶

list(FIND )¶

Returns the index of the element specified in the list or -1 if it wasn't found.

Modification¶

list(APPEND [ ...])¶

Appends elements to the list. If no variable named <list> exists in the current scope its value is treated as empty and the elements are appended to that empty list.

list(FILTER <INCLUDE|EXCLUDE> REGEX <regular_expression>)¶

Added in version 3.6.

Includes or removes items from the list that match the mode's pattern. In REGEX mode, items will be matched against the given regular expression.

For more information on regular expressions look understring(REGEX).

list(INSERT <element_index> [ ...])¶

Inserts elements to the list to the specified index. It is an error to specify an out-of-range index. Valid indexes are 0 to _N_where N is the length of the list, inclusive. An empty list has length 0. If no variable named <list> exists in the current scope its value is treated as empty and the elements are inserted in that empty list.

list(POP_BACK [...])¶

Added in version 3.15.

If no variable name is given, removes exactly one element. Otherwise, with N variable names provided, assign the last N elements' values to the given variables and then remove the last N values from<list>.

list(POP_FRONT [...])¶

Added in version 3.15.

If no variable name is given, removes exactly one element. Otherwise, with N variable names provided, assign the first N elements' values to the given variables and then remove the first N values from<list>.

list(PREPEND [ ...])¶

Added in version 3.15.

Insert elements to the 0th position in the list. If no variable named<list> exists in the current scope its value is treated as empty and the elements are prepended to that empty list.

list(REMOVE_ITEM [ ...])¶

Removes all instances of the given items from the list.

list(REMOVE_AT [ ...])¶

Removes items at given indices from the list.

list(REMOVE_DUPLICATES )¶

Removes duplicated items in the list. The relative order of items is preserved, but if duplicates are encountered, only the first instance is preserved.

list(TRANSFORM [] [OUTPUT_VARIABLE ])¶

Added in version 3.12.

Transforms the list by applying an <ACTION> to all or, by specifying a<SELECTOR>, to the selected elements of the list, storing the result in-place or in the specified output variable.

Note

The TRANSFORM sub-command does not change the number of elements in the list. If a <SELECTOR> is specified, only some elements will be changed, the other ones will remain the same as before the transformation.

<ACTION> specifies the action to apply to the elements of the list. The actions have exactly the same semantics as sub-commands of thestring() command. <ACTION> must be one of the following:

APPEND, PREPEND

Append, prepend specified value to each element of the list.

list(TRANSFORM (APPEND|PREPEND) ...)¶

TOLOWER, TOUPPER

Convert each element of the list to lower, upper characters.

list(TRANSFORM (TOLOWER|TOUPPER) ...)¶

STRIP

Remove leading and trailing spaces from each element of the list.

list(TRANSFORM STRIP ...)¶

GENEX_STRIP

Strip anygenerator expressionsfrom each element of the list.

list(TRANSFORM GENEX_STRIP ...)¶

REPLACE

Match the regular expression as many times as possible and substitute the replacement expression for the match for each element of the list (same semantic as string(REGEX REPLACE)).

list(TRANSFORM REPLACE <regular_expression> <replace_expression> ...)¶

<SELECTOR> determines which elements of the list will be transformed. Only one type of selector can be specified at a time. When given, <SELECTOR> must be one of the following:

AT

Specify a list of indexes.

list(TRANSFORM AT [ ...] ...)

FOR

Specify a range with, optionally, an increment used to iterate over the range.

list(TRANSFORM FOR [] ...)

REGEX

Specify a regular expression. Only elements matching the regular expression will be transformed.

list(TRANSFORM REGEX ...)

Ordering¶

list(REVERSE )¶

Reverses the contents of the list in-place.

list(SORT [COMPARE ] [CASE ] [ORDER ])¶

Sorts the list in-place alphabetically.

Added in version 3.13: Added the COMPARE, CASE, and ORDER options.

Added in version 3.18: Added the COMPARE NATURAL option.

Use the COMPARE keyword to select the comparison method for sorting. The <compare> option should be one of:

STRING

Sorts a list of strings alphabetically. This is the default behavior if the COMPARE option is not given.

FILE_BASENAME

Sorts a list of pathnames of files by their basenames.

NATURAL

Sorts a list of strings using natural order (see strverscmp(3) manual), i.e. such that contiguous digits are compared as whole numbers. For example: the following list 10.0 1.1 2.1 8.0 2.0 3.1_will be sorted as 1.1 2.0 2.1 3.1 8.0 10.0 if the NATURALcomparison is selected where it will be sorted as_1.1 10.0 2.0 2.1 3.1 8.0 with the STRING comparison.

Use the CASE keyword to select a case sensitive or case insensitive sort mode. The <case> option should be one of:

SENSITIVE

List items are sorted in a case-sensitive manner. This is the default behavior if the CASE option is not given.

INSENSITIVE

List items are sorted case insensitively. The order of items which differ only by upper/lowercase is not specified.

To control the sort order, the ORDER keyword can be given. The <order> option should be one of:

ASCENDING

Sorts the list in ascending order. This is the default behavior when the ORDER option is not given.

DESCENDING

Sorts the list in descending order.