list

对分号分隔列表的操作。

概要

Reading
  list(LENGTH <list> <out-var>)
  list(GET <list> <element index> [<index> ...] <out-var>)
  list(JOIN <list> <glue> <out-var>)
  list(SUBLIST <list> <begin> <length> <out-var>)

Search
  list(FIND <list> <value> <out-var>)

Modification
  list(APPEND <list> [<element>...])
  list(FILTER <list> {INCLUDE | EXCLUDE} REGEX <regex>)
  list(INSERT <list> <index> [<element>...])
  list(POP_BACK <list> [<out-var>...])
  list(POP_FRONT <list> [<out-var>...])
  list(PREPEND <list> [<element>...])
  list(REMOVE_ITEM <list> <value>...)
  list(REMOVE_AT <list> <index>...)
  list(REMOVE_DUPLICATES <list>)
  list(TRANSFORM <list> <ACTION> [...])

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

简介

list 子命令 APPEND, INSERT, FILTER, PREPEND, POP_BACK, POP_FRONT, REMOVE_AT, REMOVE_ITEM, REMOVE_DUPLICATES, REVERSE 和 SORT 可能会为当前 CMake 变量作用域内的列表创建新值。类似于 set() 命令，即使列表本身实际上是在父作用域中定义的，list 命令也会在当前作用域中创建新的变量值。要将这些操作的结果向上层传播，请使用 set() 和 PARENT_SCOPE，set() 和 CACHE INTERNAL，或一些其他值传播方式。

注意

cmake 中的列表是由 ; 分隔的字符串组。要创建列表，可以使用 set() 命令。例如，set(var a b c d e) 创建一个包含 a;b;c;d;e 的列表，而 set(var "a b c d e") 创建一个字符串或一个包含一个项目的列表。（请注意，宏参数不是变量，因此不能在 LIST 命令中使用。）

单个元素可能不包含不等数量的 [ 和 ] 字符，并且不能以反斜杠 (\) 结尾。有关详细信息，请参阅分号分隔列表。

注意

当指定索引值时，如果 <element index> 大于或等于 0，则从列表的开头索引，其中 0 表示第一个列表元素。如果 <element index> 小于或等于 -1，则从列表的末尾索引，其中 -1 表示最后一个列表元素。使用负索引计数时要小心：它们不是从 0 开始的。-0 等同于 0，即第一个列表元素。

读取

list(LENGTH <list> <output variable>)

返回列表的长度。

list(GET <list> <element index> [<element index> ...] <output variable>)

返回列表中由索引指定的元素列表。

list(JOIN <list> <glue> <output variable>)

在 3.12 版本中添加。

返回一个字符串，该字符串使用胶合字符串连接所有列表的元素。要连接多个非列表一部分的字符串，请使用 string(JOIN)。

list(SUBLIST <list> <begin> <length> <output variable>)

在 3.12 版本中添加。

返回给定列表的子列表。如果 <length> 为 0，将返回一个空列表。如果 <length> 为 -1 或者列表小于 <begin>+<length>，则将返回从 <begin> 开始的列表的剩余元素。

搜索

list(FIND <list> <value> <output variable>)

返回列表中指定元素的索引，如果未找到，则返回 -1。

修改

list(APPEND <list> [<element> ...])

将元素追加到列表。如果当前作用域中不存在名为 <list> 的变量，则其值被视为空，并且元素将追加到该空列表中。

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

在 3.6 版本中添加。

包括或删除列表中与模式匹配的项目。在 REGEX 模式下，项目将与给定的正则表达式匹配。

有关正则表达式的更多信息，请查看 string(REGEX)。

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

将元素插入到列表中指定的索引处。指定超出范围的索引是错误的。有效索引为 0 到 N，其中 N 是列表的长度，包括 N。空列表的长度为 0。如果当前作用域中不存在名为 <list> 的变量，则其值被视为空，并且元素将插入到该空列表中。

list(POP_BACK <list> [<out-var>...])

在 3.15 版本中添加。

如果未给出变量名，则恰好删除一个元素。否则，如果提供了 N 个变量名，则将最后 N 个元素的值分配给给定的变量，然后从 <list> 中删除最后 N 个值。

list(POP_FRONT <list> [<out-var>...])

在 3.15 版本中添加。

如果未给出变量名，则恰好删除一个元素。否则，如果提供了 N 个变量名，则将前 N 个元素的值分配给给定的变量，然后从 <list> 中删除前 N 个值。

list(PREPEND <list> [<element> ...])

在 3.15 版本中添加。

将元素插入到列表中的第 0 个位置。如果当前作用域中不存在名为 <list> 的变量，则其值被视为空，并且元素将前置到该空列表中。

list(REMOVE_ITEM <list> <value> [<value> ...])

从列表中删除给定项目的所有实例。

list(REMOVE_AT <list> <index> [<index> ...])

从列表中删除给定索引处的项目。

list(REMOVE_DUPLICATES <list>)

删除列表中重复的项目。项目的相对顺序被保留，但是如果遇到重复项，则仅保留第一个实例。

list(TRANSFORM <list> <ACTION> [<SELECTOR>] [OUTPUT_VARIABLE <output variable>])

在 3.12 版本中添加。

通过将 <ACTION> 应用于列表的所有元素，或者通过指定 <SELECTOR> 应用于列表的选定元素来转换列表，并将结果就地或存储在指定的输出变量中。

注意

TRANSFORM 子命令不会更改列表中元素的数量。如果指定了 <SELECTOR>，则只会更改某些元素，其他元素将保持与转换前相同。

<ACTION> 指定要应用于列表元素的操作。这些操作与 string() 命令的子命令具有完全相同的语义。<ACTION> 必须是以下之一

APPEND, PREPEND

将指定的值追加、前置到列表的每个元素。

list(TRANSFORM <list> (APPEND|PREPEND) <value> ...)

TOLOWER, TOUPPER

将列表的每个元素转换为小写、大写字符。

list(TRANSFORM <list> (TOLOWER|TOUPPER) ...)

STRIP

删除列表中每个元素的前导和尾随空格。

list(TRANSFORM <list> STRIP ...)

GENEX_STRIP

从列表的每个元素中去除任何生成器表达式。

list(TRANSFORM <list> GENEX_STRIP ...)

REPLACE

尽可能多次匹配正则表达式，并将替换表达式替换为列表中每个元素的匹配项（与 string(REGEX REPLACE) 语义相同）。

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

<SELECTOR> 确定将转换列表的哪些元素。一次只能指定一种类型的选择器。如果给定，<SELECTOR> 必须是以下之一

AT

指定索引列表。

list(TRANSFORM <list> <ACTION> AT <index> [<index> ...] ...)

FOR

指定一个范围，可以选择使用增量来迭代该范围。

list(TRANSFORM <list> <ACTION> FOR <start> <stop> [<step>] ...)

REGEX

指定正则表达式。只有与正则表达式匹配的元素才会被转换。

list(TRANSFORM <list> <ACTION> REGEX <regular_expression> ...)

排序

list(REVERSE <list>)

就地反转列表的内容。

list(SORT <list> [COMPARE <compare>] [CASE <case>] [ORDER <order>])

按字母顺序就地排序列表。

在 3.13 版本中添加: 添加了 COMPARE、CASE 和 ORDER 选项。

在 3.18 版本中添加: 添加了 COMPARE NATURAL 选项。

使用 COMPARE 关键字选择排序的比较方法。<compare> 选项应为以下之一

STRING

按字母顺序排序字符串列表。如果未给出 COMPARE 选项，则这是默认行为。

FILE_BASENAME

按文件基本名称排序文件路径名列表。

NATURAL

使用自然顺序（参见 strverscmp(3) 手册）排序字符串列表，即，将连续的数字作为整数进行比较。例如：以下列表 10.0 1.1 2.1 8.0 2.0 3.1 将排序为 1.1 2.0 2.1 3.1 8.0 10.0 （如果选择了 NATURAL 比较），而使用 STRING 比较，它将排序为 1.1 10.0 2.0 2.1 3.1 8.0。

使用 CASE 关键字选择区分大小写或不区分大小写的排序模式。<case> 选项应为以下之一

SENSITIVE

列表项以区分大小写的方式排序。如果未给出 CASE 选项，则这是默认行为。

INSENSITIVE

列表项以不区分大小写的方式排序。仅大小写不同的项目的顺序未指定。

要控制排序顺序，可以给出 ORDER 关键字。<order> 选项应为以下之一

ASCENDING

以升序排序列表。当未给出 ORDER 选项时，这是默认行为。

DESCENDING

以降序排序列表。