1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
list
----
.. only:: html
.. contents::
List operations.
The list subcommands ``APPEND``, ``INSERT``, ``FILTER``, ``REMOVE_AT``,
``REMOVE_ITEM``, ``REMOVE_DUPLICATES``, ``REVERSE`` and ``SORT`` may create
new values for the list within the current CMake variable scope. Similar to
the :command:`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
:command:`set` with ``PARENT_SCOPE``, :command:`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``, and ``set(var "a b c d e")`` creates a
string or a list with one item in it. (Note macro arguments are not
variables, and therefore cannot be used in LIST commands.)
.. 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.
Capacity and Element access
^^^^^^^^^^^^^^^^^^^^^^^^^^^
LENGTH
""""""
::
list(LENGTH <list> <output variable>)
Returns the list's length.
GET
"""
::
list(GET <list> <element index> [<element index> ...] <output variable>)
Returns the list of elements specified by indices from the list.
JOIN
""""
::
list(JOIN <list> <glue> <output variable>)
Returns a string joining all list's elements using the glue string.
To join multiple strings, which are not part of a list, use ``JOIN`` operator
from :command:`string` command.
Search
^^^^^^
FIND
""""
::
list(FIND <list> <value> <output variable>)
Returns the index of the element specified in the list or -1
if it wasn't found.
Modification
^^^^^^^^^^^^
APPEND
""""""
::
list(APPEND <list> [<element> ...])
Appends elements to the list.
FILTER
""""""
::
list(FILTER <list> <INCLUDE|EXCLUDE> REGEX <regular_expression>)
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 see also the
:command:`string` command.
INSERT
""""""
::
list(INSERT <list> <element_index> <element> [<element> ...])
Inserts elements to the list to the specified location.
REMOVE_ITEM
"""""""""""
::
list(REMOVE_ITEM <list> <value> [<value> ...])
Removes the given items from the list.
REMOVE_AT
"""""""""
::
list(REMOVE_AT <list> <index> [<index> ...])
Removes items at given indices from the list.
REMOVE_DUPLICATES
"""""""""""""""""
::
list(REMOVE_DUPLICATES <list>)
Removes duplicated items in the list.
Sorting
^^^^^^^
REVERSE
"""""""
::
list(REVERSE <list>)
Reverses the contents of the list in-place.
SORT
""""
::
list(SORT <list>)
Sorts the list in-place alphabetically.
|
