mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-17 04:31:04 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Add note to each string() subcommand that assumes ASCII input

Browse Source 
Fixes: #19465
This commit is contained in:
Craig Scott
2019-07-19 20:35:40 +10:00
parent 26cd64d977
commit b97673f54b
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Help/command/string.rst
View File

@@ -59,6 +59,10 @@ search for the position of the last occurrence of the specified
``<substring>``. If the ``<substring>`` is not found, a position of -1 is ``<substring>``. If the ``<substring>`` is not found, a position of -1 is
returned. returned.
The ``string(FIND)`` subcommand treats all strings as ASCII-only characters.
The index stored in ``<output_variable>`` will also be counted in bytes,
so strings containing multi-byte characters may lead to unexpected results.
.. _REPLACE: .. _REPLACE:
.. code-block:: cmake .. code-block:: cmake
@@ -239,7 +243,9 @@ Convert ``<string>`` to upper characters.
string(LENGTH <string> <output_variable>) string(LENGTH <string> <output_variable>)
Store in an ``<output_variable>`` a given string's length. Store in an ``<output_variable>`` a given string's length in bytes.
Note that this means if ``<string>`` contains multi-byte characters, the
result stored in ``<output_variable>`` will *not* be the number of characters.
.. _SUBSTRING: .. _SUBSTRING:
@@ -252,6 +258,9 @@ Store in an ``<output_variable>`` a substring of a given ``<string>``. If
will be returned. If ``<string>`` is shorter than ``<length>`` then the will be returned. If ``<string>`` is shorter than ``<length>`` then the
end of the string is used instead. end of the string is used instead.
Both ``<begin>`` and ``<length>`` are counted in bytes, so care must
be exercised if ``<string>`` could contain multi-byte characters.
.. note:: .. note::
CMake 3.1 and below reported an error if ``<length>`` pointed past CMake 3.1 and below reported an error if ``<length>`` pointed past
the end of ``<string>``. the end of ``<string>``.