dilim/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-08-09 01:01:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

string(JSON): Add PARTIAL_EQUAL for subset style JSON comparisons

Browse Source 
Fixes: #27641
This commit is contained in:
Taylor Sasser
2026-02-23 16:00:46 -05:00
committed by Brad King
parent 95a07e2fc6
commit b14da400de
5 changed files with 422 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
Help/command/string.rst
View File

@@ -59,6 +59,8 @@ Synopsis
<member|index> [<member|index> ...] <value>)
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
`EQUAL <JSON-EQUAL_>`__ <json-string1> <json-string2>)
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
`PARTIAL_EQUAL <JSON-EQUAL_>`__ <json-string1> <json-string2>)
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
`STRING_ENCODE <STRING-ENCODE_>`__ <string>)
@@ -637,6 +639,42 @@ string is passed as a single argument even if it contains semicolons.
will be set to a true value if the JSON objects are considered equal,
or a false value otherwise.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
PARTIAL_EQUAL <json-pattern> <json-actual>)
:target: JSON-PARTIAL_EQUAL
.. versionadded:: 4.4
Compare two JSON values using *partial* equality. The first argument
(``<json-pattern>``) is treated as a pattern to match against the second
argument (``<json-actual>``), which is treated as the complete JSON value.
The contents of ``<json-pattern>`` and ``<json-actual>`` must be valid JSON.
The ``<out-var>`` will be set to a true value if ``<json-pattern>`` is
contained within ``<json-actual>`` according to the rules below, or a false
value otherwise.
Partial equality is not symmetric. In general,
``PARTIAL_EQUAL(A, B)`` and ``PARTIAL_EQUAL(B, A)`` may produce different
results.
Matching rules:
* **Scalars** (null, number, string, boolean) must match exactly.
* **Objects** match if every member in ``<json-pattern>`` exists in
``<json-actual>`` and the corresponding values also match recursively.
Extra members in ``<json-actual>`` are ignored.
* **Arrays** match if every element in ``<json-pattern>`` matches a
distinct element in ``<json-actual>`` recursively. Once an element in
``<json-actual>`` successfully matches an element in ``<json-pattern>``,
it is consumed and cannot be reused to match any subsequent elements.
Array element order is not significant. Extra elements in
``<json-actual>`` are ignored.
Type differences do not match (for example, an object does not match an
array, and a string does not match a number).
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
STRING_ENCODE <string>)