字符串¶

字符串操作。

概要¶

Search and Replace
  string(FIND <string> <substring> <out-var> [...])
  string(REPLACE <match-string> <replace-string> <out-var> <input>...)
  string(REGEX MATCH <match-regex> <out-var> <input>...)
  string(REGEX MATCHALL <match-regex> <out-var> <input>...)
  string(REGEX REPLACE <match-regex> <replace-expr> <out-var> <input>...)

Manipulation
  string(APPEND <string-var> [<input>...])
  string(PREPEND <string-var> [<input>...])
  string(CONCAT <out-var> [<input>...])
  string(JOIN <glue> <out-var> [<input>...])
  string(TOLOWER <string> <out-var>)
  string(TOUPPER <string> <out-var>)
  string(LENGTH <string> <out-var>)
  string(SUBSTRING <string> <begin> <length> <out-var>)
  string(STRIP <string> <out-var>)
  string(GENEX_STRIP <string> <out-var>)
  string(REPEAT <string> <count> <out-var>)

Comparison
  string(COMPARE <op> <string1> <string2> <out-var>)

Hashing
  string(<HASH> <out-var> <input>)

Generation
  string(ASCII <number>... <out-var>)
  string(HEX <string> <out-var>)
  string(CONFIGURE <string> <out-var> [...])
  string(MAKE_C_IDENTIFIER <string> <out-var>)
  string(RANDOM [<option>...] <out-var>)
  string(TIMESTAMP <out-var> [<format string>] [UTC])
  string(UUID <out-var> ...)

JSON
  string(JSON <out-var> [ERROR_VARIABLE <error-var>]
         {GET | TYPE | LENGTH | REMOVE}
         <json-string> <member|index> [<member|index> ...])
  string(JSON <out-var> [ERROR_VARIABLE <error-var>]
         MEMBER <json-string>
         [<member|index> ...] <index>)
  string(JSON <out-var> [ERROR_VARIABLE <error-var>]
         SET <json-string>
         <member|index> [<member|index> ...] <value>)
  string(JSON <out-var> [ERROR_VARIABLE <error-var>]
         EQUAL <json-string1> <json-string2>)

搜索和替换¶

使用纯字符串搜索和替换¶

string(FIND <string> <substring> <output_variable> [REVERSE])¶

返回在提供的 <string> 中找到给定 <substring> 的位置。如果使用了 REVERSE 标志，命令将搜索指定 <substring> 最后一次出现的位置。如果未找到 <substring>，则返回位置 -1。

string(FIND) 子命令将所有字符串视为仅 ASCII 字符。存储在 <output_variable> 中的索引也将以字节为单位计数，因此包含多字节字符的字符串可能会导致意外的结果。

string(REPLACE <match_string> <replace_string> <output_variable> <input> [<input>...])¶: 将 <input> 中所有出现的 <match_string> 替换为 <replace_string>，并将结果存储在 <output_variable> 中。

使用正则表达式搜索和替换¶

string(REGEX MATCH <regular_expression> <output_variable> <input> [<input>...])¶: 匹配 <regular_expression> 一次，并将匹配项存储在 <output_variable> 中。所有 <input> 参数在匹配之前连接。正则表达式在下面的小节中指定。

string(REGEX MATCHALL <regular_expression> <output_variable> <input> [<input>...])¶: 尽可能多次匹配 <regular_expression>，并将匹配项作为列表存储在 <output_variable> 中。所有 <input> 参数在匹配之前连接。

string(REGEX REPLACE <regular_expression> <replacement_expression> <output_variable> <input> [<input>...])¶

尽可能多次匹配 <regular_expression>，并在输出中将匹配项替换为 <replacement_expression>。所有 <input> 参数在匹配之前连接。

<replacement_expression> 可以使用 \1、\2、...、\9 引用匹配的括号分隔的子表达式。请注意，在 CMake 代码中需要两个反斜杠 (\\1) 才能通过参数解析获得反斜杠。

正则表达式规范¶

以下字符在正则表达式中具有特殊含义

^: ^
$: $
.: .
\<char>: 匹配由 <char> 指定的单个字符。使用此方法匹配特殊的正则表达式字符，例如 \. 表示字面量 .，或 \\ 表示字面量反斜杠 \。转义非特殊字符是不必要的，但允许，例如 \a 匹配 a。
[ ]: []
[^ ]: [^]
-: -
*: *
+: +
?: ?
|: |
(): ()

在 3.9 版本中添加: 所有与正则表达式相关的命令，包括例如 if(MATCHES)，将子组匹配项保存在变量 CMAKE_MATCH_<n> 中，其中 <n> 为 0..9。

*、+ 和 ? 的优先级高于连接。| 的优先级低于连接。这意味着正则表达式 ^ab+d$ 匹配 abbd 但不匹配 ababd，而正则表达式 ^(ab|cd)$ 匹配 ab 但不匹配 abd。

CMake 语言转义序列，例如 \t、\r、\n 和 \\，可用于构造字面量制表符、回车符、换行符和反斜杠（分别）以传递到正则表达式中。例如

带引号的参数 "[ \t\r\n]" 指定一个正则表达式，它匹配任何单个空白字符。
带引号的参数 "[/\\]" 指定一个正则表达式，它匹配单个正斜杠 / 或反斜杠 \。
带引号的参数 "[A-Za-z0-9_]" 指定一个正则表达式，它匹配 C 语言环境中的任何单个“单词”字符。
带引号的参数 "\$\\a\\+b\$" 指定一个正则表达式，它匹配确切的字符串 (a+b)。在带引号的参数中，每个 \\ 都被解析为 \，因此正则表达式本身实际上是 $\a\+\b$。这也可以在方括号参数中指定，而无需转义反斜杠，例如 [[$\a\+\b$]]。

操作¶

string(APPEND <string_variable> [<input>...])¶: 在 3.4 版本中添加。

将所有 <input> 参数附加到字符串。

string(PREPEND <string_variable> [<input>...])¶: 在 3.10 版本中添加。

将所有 <input> 参数前置到字符串。

string(CONCAT <output_variable> [<input>...])¶: 将所有 <input> 参数连接在一起，并将结果存储在名为 <output_variable> 的变量中。

string(JOIN <glue> <output_variable> [<input>...])¶

在 3.12 版本中添加。

使用 <glue> 字符串将所有 <input> 参数连接在一起，并将结果存储在名为 <output_variable> 的变量中。

要连接列表的元素，请优先使用 list() 命令中的 JOIN 运算符。这允许元素中包含像 ; 这样的特殊字符。

string(TOLOWER <string> <output_variable>)¶: 将 <string> 转换为小写字符。

string(TOUPPER <string> <output_variable>)¶: 将 <string> 转换为大写字符。

string(LENGTH <string> <output_variable>)¶: 在 <output_variable> 中存储给定字符串的字节长度。请注意，这意味着如果 <string> 包含多字节字符，则存储在 <output_variable> 中的结果将不是字符数。

string(SUBSTRING <string> <begin> <length> <output_variable>)¶

在 <output_variable> 中存储给定 <string> 的子字符串。如果 <length> 为 -1，则返回从 <begin> 开始的字符串的剩余部分。

在 3.2 版本中更改: 如果 <string> 比 <length> 短，则改为使用字符串的末尾。以前版本的 CMake 在这种情况下会报告错误。

<begin> 和 <length> 均以字节为单位计数，因此如果 <string> 可能包含多字节字符，则必须小心。

string(STRIP <string> <output_variable>)¶: 在 <output_variable> 中存储给定 <string> 的子字符串，并删除前导和尾随空格。

string(GENEX_STRIP <string> <output_variable>)¶: 在 3.1 版本中添加。

从输入 <string> 中剥离任何 generator expressions，并将结果存储在 <output_variable> 中。

string(REPEAT <string> <count> <output_variable>)¶: 在 3.15 版本中添加。

生成输出字符串作为输入 <string> 重复 <count> 次。

比较¶

string(COMPARE LESS <string1> <string2> <output_variable>)¶
string(COMPARE GREATER <string1> <string2> <output_variable>)¶
string(COMPARE EQUAL <string1> <string2> <output_variable>)¶
string(COMPARE NOTEQUAL <string1> <string2> <output_variable>)¶
string(COMPARE LESS_EQUAL <string1> <string2> <output_variable>)¶
string(COMPARE GREATER_EQUAL <string1> <string2> <output_variable>)¶: 比较字符串，并在 <output_variable> 中存储 true 或 false。

在 3.7 版本中添加: 添加了 LESS_EQUAL 和 GREATER_EQUAL 选项。

哈希¶

string(<HASH> <output_variable> <input>)¶

计算 <input> 字符串的加密哈希值。支持的 <HASH> 算法名称为

MD5: 消息摘要算法 5, RFC 1321。
SHA1: 美国安全哈希算法 1, RFC 3174。
SHA224: 美国安全哈希算法, RFC 4634。
SHA256: 美国安全哈希算法, RFC 4634。
SHA384: 美国安全哈希算法, RFC 4634。
SHA512: 美国安全哈希算法, RFC 4634。
SHA3_224: Keccak SHA-3。
SHA3_256: Keccak SHA-3。
SHA3_384: Keccak SHA-3。
SHA3_512: Keccak SHA-3。

在 3.8 版本中添加: 添加了 SHA3_* 哈希算法。

生成¶

string(ASCII <number> [<number> ...] <output_variable>)¶: 将所有数字转换为相应的 ASCII 字符。

string(HEX <string> <output_variable>)¶: 在 3.18 版本中添加。

将输入 <string> 中的每个字节转换为其十六进制表示形式，并将连接的十六进制数字存储在 <output_variable> 中。输出中的字母（a 到 f）为小写。

string(CONFIGURE <string> <output_variable> [@ONLY] [ESCAPE_QUOTES])¶: 转换 <string>，就像 configure_file() 转换文件一样。

string(MAKE_C_IDENTIFIER <string> <output_variable>)¶: 将输入 <string> 中的每个非字母数字字符转换为下划线，并将结果存储在 <output_variable> 中。如果 <string> 的第一个字符是数字，则还将在结果前面添加一个下划线。

string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>] [RANDOM_SEED <seed>] <output_variable>)¶: 返回给定 <length> 的随机字符串，该字符串由给定 <alphabet> 中的字符组成。默认长度为 5 个字符，默认字母表为所有数字以及大小写字母。如果给定整数 RANDOM_SEED，则其值将用于播种随机数生成器。

string(TIMESTAMP <output_variable> [<format_string>] [UTC])¶

将当前日期和/或时间的字符串表示形式写入 <output_variable>。

如果命令无法获取时间戳，则 <output_variable> 将被设置为空字符串 ""。

可选的 UTC 标志请求当前日期/时间表示形式为协调世界时 (UTC) 而不是本地时间。

可选的 <format_string> 可以包含以下格式说明符

%%: 在 3.8 版本中添加。

%%
%d: 当月的第几天 (01-31)。
%H: 24 小时制的小时 (00-23)。
%I: 12 小时制的小时 (01-12)。
%j: 当年的第几天 (001-366)。
%m: 当月的月份 (01-12)。
%b: 在 3.7 版本中添加。

缩写月份名称（例如 Oct）。
%B: 在 3.10 版本中添加。

完整月份名称（例如 October）。
%M: 当前小时的分钟 (00-59)。
%s: 在 3.6 版本中添加。

自 1970 年 1 月 1 日午夜 (UTC) 以来的秒数（UNIX 时间）。
%S: 当前分钟的秒数。60 代表闰秒。(00-60)
%f: 在 3.23 版本中添加。

当前秒的微秒 (000000-999999)。
%U: 当年第几周 (00-53)。
%V: 在 3.22 版本中添加。

当年 ISO 8601 周数 (01-53)。
%w: 当周的第几天。0 是星期日。(0-6)
%a: 在 3.7 版本中添加。

缩写工作日名称（例如 Fri）。
%A: 在 3.10 版本中添加。

完整工作日名称（例如 Friday）。
%y: 当前年份的后两位数字 (00-99)。
%Y: 当前年份。
%z: 在 3.26 版本中添加。

时区与 UTC 的偏移量，以小时和分钟为单位，格式为 +hhmm 或 -hhmm。
%Z: 在 3.26 版本中添加。

时区名称。

未知的格式说明符将被忽略并按原样复制到输出中。

如果未给出显式的 <format_string>，则默认为

%Y-%m-%dT%H:%M:%S 对于本地时间。
%Y-%m-%dT%H:%M:%SZ 对于 UTC。

在 3.8 版本中添加: 如果设置了 SOURCE_DATE_EPOCH 环境变量，则将使用其值而不是当前时间。有关详细信息，请参阅 https://reproducible-builds.org/specs/source-date-epoch/。

string(UUID <output_variable> NAMESPACE <namespace> NAME <name> TYPE <MD5|SHA1> [UPPER])¶: 在 3.1 版本中添加。

根据 RFC4122 创建通用唯一标识符（也称为 GUID），基于 <namespace>（本身必须是有效的 UUID）和 <name> 的组合值的哈希值。哈希算法可以是 MD5（版本 3 UUID）或 SHA1（版本 5 UUID）。UUID 的格式为 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中每个 x 代表一个小写十六进制字符。如果需要，可以使用可选的 UPPER 标志请求大写表示形式。

JSON¶

在 3.19 版本中添加。

用于查询 JSON 字符串的功能。

注意

在以下每个与 JSON 相关的子命令中，如果给出了可选的 ERROR_VARIABLE 参数，则错误将会在 <error-variable> 中报告，并且 <out-var> 将会被设置为 <member|index>-[<member|index>...]-NOTFOUND，其中路径元素会一直显示到发生错误的点，或者如果不存在相关路径，则仅设置为 NOTFOUND。如果发生错误但未提供 ERROR_VARIABLE 选项，则会生成致命错误消息。如果未发生错误，则 <error-variable> 将会被设置为 NOTFOUND。

在以下子命令中，<json-string> 参数应该写成带引号的参数，以确保即使它包含分号，整个 JSON 字符串也作为单个参数传递。

string(JSON <out-var> [ERROR_VARIABLE <error-variable>] GET <json-string> <member|index> [<member|index> ...])¶: 从 <json-string> 中获取由 <member|index> 参数列表指定位置的元素。数组和对象元素将作为 JSON 字符串返回。布尔元素将作为 ON 或 OFF 返回。Null 元素将作为空字符串返回。数字和字符串类型将作为字符串返回。

string(JSON <out-var> [ERROR_VARIABLE <error-variable>] TYPE <json-string> <member|index> [<member|index> ...])¶: 获取 <json-string> 中由 <member|index> 参数列表指定位置的元素的类型。<out-var> 将会被设置为 NULL、NUMBER、STRING、BOOLEAN、ARRAY 或 OBJECT 之一。

string(JSON <out-var> [ERROR_VARIABLE <error-var>] MEMBER <json-string> [<member|index> ...] <index>)¶: 获取 <json-string> 中由 <member|index> 参数列表指定位置的第 <index> 个成员的名称。需要对象类型的元素。

string(JSON <out-var> [ERROR_VARIABLE <error-variable>] LENGTH <json-string> [<member|index> ...])¶: 获取 <json-string> 中由 <member|index> 参数列表指定位置的元素的长度。需要数组或对象类型的元素。

string(JSON <out-var> [ERROR_VARIABLE <error-variable>] REMOVE <json-string> <member|index> [<member|index> ...])¶: 从 <json-string> 中移除由 <member|index> 参数列表指定位置的元素。不包含已移除元素的 JSON 字符串将存储在 <out-var> 中。

string(JSON <out-var> [ERROR_VARIABLE <error-variable>] SET <json-string> <member|index> [<member|index> ...] <value>)¶: 将 <json-string> 中由 <member|index> 参数列表指定位置的元素设置为 <value>。<value> 的内容应该是有效的 JSON。如果 <json-string> 是一个数组，则可以通过使用大于或等于数组长度的数字作为 <member|index> 参数，将 <value> 追加到数组的末尾。

string(JSON <out-var> [ERROR_VARIABLE <error-var>] EQUAL <json-string1> <json-string2>)¶: 比较由 <json-string1> 和 <json-string2> 给出的两个 JSON 对象是否相等。<json-string1> 和 <json-string2> 的内容应该是有效的 JSON。<out-var> 将会在 JSON 对象被认为相等时设置为真值，否则设置为假值。