OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 ccmake.1.html	44.19 KB	04/04/2023 07:05:08 PM	rw-r--r--
📄 cmake-buildsystem.7.html	161.14 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-commands.7.html	21.66 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-compile-features.7.html	46.17 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-configure-log.7.html	35.93 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-developer.7.html	60.56 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-env-variables.7.html	15.36 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-file-api.7.html	174.79 KB	04/04/2023 07:05:10 PM	rw-r--r--
📄 cmake-generator-expressions.7.html	229.68 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-generators.7.html	16.07 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-gui.1.html	27.62 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-language.7.html	67.9 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-modules.7.html	37.63 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-packages.7.html	84.94 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-policies.7.html	48.41 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-presets.7.html	122.21 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-properties.7.html	80.47 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-qt.7.html	47.92 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-server.7.html	5.39 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-toolchains.7.html	92.74 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-variables.7.html	105.71 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake.1.html	170.8 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 cpack-generators.7.html	7.54 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 cpack.1.html	39.49 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 ctest.1.html	230.72 KB	04/04/2023 07:05:13 PM	rw-r--r--

Editing: cmake-file-api.7.html

<!DOCTYPE html>

<title>cmake-file-api(7) &mdash; CMake 3.26.3 Documentation</title>

</head><body>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="cmake-generator-expressions.7.html" title="cmake-generator-expressions(7)"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="../envvar/CCMAKE_COLORS.html" title="CCMAKE_COLORS"
 accesskey="P">previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-this"><a href="">cmake-file-api(7)</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="cmake-file-api-7">
<h1><a class="toc-backref" href="#id1" role="doc-backlink">cmake-file-api(7)</a><a class="headerlink" href="#cmake-file-api-7" title="Permalink to this heading">¶</a></h1>
<nav class="contents" id="contents">
Contents
<ul class="simple">
<li><a class="reference internal" href="#cmake-file-api-7" id="id1">cmake-file-api(7)</a>
<ul>
<li><a class="reference internal" href="#introduction" id="id2">Introduction</a></li>
<li><a class="reference internal" href="#api-v1" id="id3">API v1</a>
<ul>
<li><a class="reference internal" href="#v1-shared-stateless-query-files" id="id4">v1 Shared Stateless Query Files</a></li>
<li><a class="reference internal" href="#v1-client-stateless-query-files" id="id5">v1 Client Stateless Query Files</a></li>
<li><a class="reference internal" href="#v1-client-stateful-query-files" id="id6">v1 Client Stateful Query Files</a></li>
<li><a class="reference internal" href="#v1-reply-index-file" id="id7">v1 Reply Index File</a>
<ul>
<li><a class="reference internal" href="#v1-reply-file-reference" id="id8">v1 Reply File Reference</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v1-reply-files" id="id9">v1 Reply Files</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kinds" id="id10">Object Kinds</a>
<ul>
<li><a class="reference internal" href="#object-kind-codemodel" id="id11">Object Kind &quot;codemodel&quot;</a>
<ul>
<li><a class="reference internal" href="#codemodel-version-2" id="id12">&quot;codemodel&quot; version 2</a></li>
<li><a class="reference internal" href="#codemodel-version-2-directory-object" id="id13">&quot;codemodel&quot; version 2 &quot;directory&quot; object</a></li>
<li><a class="reference internal" href="#codemodel-version-2-target-object" id="id14">&quot;codemodel&quot; version 2 &quot;target&quot; object</a></li>
<li><a class="reference internal" href="#codemodel-version-2-backtrace-graph" id="id15">&quot;codemodel&quot; version 2 &quot;backtrace graph&quot;</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-configurelog" id="id16">Object Kind &quot;configureLog&quot;</a>
<ul>
<li><a class="reference internal" href="#configurelog-version-1" id="id17">&quot;configureLog&quot; version 1</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-cache" id="id18">Object Kind &quot;cache&quot;</a>
<ul>
<li><a class="reference internal" href="#cache-version-2" id="id19">&quot;cache&quot; version 2</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-cmakefiles" id="id20">Object Kind &quot;cmakeFiles&quot;</a>
<ul>
<li><a class="reference internal" href="#cmakefiles-version-1" id="id21">&quot;cmakeFiles&quot; version 1</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-toolchains" id="id22">Object Kind &quot;toolchains&quot;</a>
<ul>
<li><a class="reference internal" href="#toolchains-version-1" id="id23">&quot;toolchains&quot; version 1</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<section id="introduction">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this heading">¶</a></h2>
CMake provides a file-based API that clients may use to get semantic
information about the buildsystems CMake generates. Clients may use
the API by writing query files to a specific location in a build tree
to request zero or more <a class="reference internal" href="#object-kinds">Object Kinds</a>. When CMake generates the
buildsystem in that build tree it will read the query files and write
reply files for the client to read.
The file-based API uses a <code class="docutils literal notranslate">&lt;build&gt;/.cmake/api/</code> directory at the top
of a build tree. The API is versioned to support changes to the layout
of files within the API directory. API file layout versioning is
orthogonal to the versioning of <a class="reference internal" href="#object-kinds">Object Kinds</a> used in replies.
This version of CMake supports only one API version, <a class="reference internal" href="#api-v1">API v1</a>.
</section>
<section id="api-v1">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">API v1</a><a class="headerlink" href="#api-v1" title="Permalink to this heading">¶</a></h2>
API v1 is housed in the <code class="docutils literal notranslate">&lt;build&gt;/.cmake/api/v1/</code> directory.
It has the following subdirectories:
<dl>
<dt><code class="docutils literal notranslate">query/</code></dt><dd>Holds query files written by clients.
These may be <a class="reference internal" href="#v1-shared-stateless-query-files">v1 Shared Stateless Query Files</a>,
<a class="reference internal" href="#v1-client-stateless-query-files">v1 Client Stateless Query Files</a>, or <a class="reference internal" href="#v1-client-stateful-query-files">v1 Client Stateful Query Files</a>.
</dd>
<dt><code class="docutils literal notranslate">reply/</code></dt><dd>Holds reply files written by CMake whenever it runs to generate a build
system. These are indexed by a <a class="reference internal" href="#v1-reply-index-file">v1 Reply Index File</a> file that may
reference additional <a class="reference internal" href="#v1-reply-files">v1 Reply Files</a>. CMake owns all reply files.
Clients must never remove them.
Clients may look for and read a reply index file at any time.
Clients may optionally create the <code class="docutils literal notranslate">reply/</code> directory at any time
and monitor it for the appearance of a new reply index file.
</dd>
</dl>
<section id="v1-shared-stateless-query-files">
<h3><a class="toc-backref" href="#id4" role="doc-backlink">v1 Shared Stateless Query Files</a><a class="headerlink" href="#v1-shared-stateless-query-files" title="Permalink to this heading">¶</a></h3>
Shared stateless query files allow clients to share requests for
major versions of the <a class="reference internal" href="#object-kinds">Object Kinds</a> and get all requested versions
recognized by the CMake that runs.
Clients may create shared requests by creating empty files in the
<code class="docutils literal notranslate">v1/query/</code> directory. The form is:
<div class="highlight-none notranslate"><div class="highlight"><pre>&lt;build&gt;/.cmake/api/v1/query/&lt;kind&gt;-v&lt;major&gt;
</pre></div>
</div>
where <code class="docutils literal notranslate">&lt;kind&gt;</code> is one of the <a class="reference internal" href="#object-kinds">Object Kinds</a>, <code class="docutils literal notranslate">-v</code> is literal,
and <code class="docutils literal notranslate">&lt;major&gt;</code> is the major version number.
Files of this form are stateless shared queries not owned by any specific
client. Once created they should not be removed without external client
coordination or human intervention.
</section>
<section id="v1-client-stateless-query-files">
<h3><a class="toc-backref" href="#id5" role="doc-backlink">v1 Client Stateless Query Files</a><a class="headerlink" href="#v1-client-stateless-query-files" title="Permalink to this heading">¶</a></h3>
Client stateless query files allow clients to create owned requests for
major versions of the <a class="reference internal" href="#object-kinds">Object Kinds</a> and get all requested versions
recognized by the CMake that runs.
Clients may create owned requests by creating empty files in
client-specific query subdirectories. The form is:
<div class="highlight-none notranslate"><div class="highlight"><pre>&lt;build&gt;/.cmake/api/v1/query/client-&lt;client&gt;/&lt;kind&gt;-v&lt;major&gt;
</pre></div>
</div>
where <code class="docutils literal notranslate">client-</code> is literal, <code class="docutils literal notranslate">&lt;client&gt;</code> is a string uniquely
identifying the client, <code class="docutils literal notranslate">&lt;kind&gt;</code> is one of the <a class="reference internal" href="#object-kinds">Object Kinds</a>,
<code class="docutils literal notranslate">-v</code> is literal, and <code class="docutils literal notranslate">&lt;major&gt;</code> is the major version number.
Each client must choose a unique <code class="docutils literal notranslate">&lt;client&gt;</code> identifier via its
own means.
Files of this form are stateless queries owned by the client <code class="docutils literal notranslate">&lt;client&gt;</code>.
The owning client may remove them at any time.
</section>
<section id="v1-client-stateful-query-files">
<h3><a class="toc-backref" href="#id6" role="doc-backlink">v1 Client Stateful Query Files</a><a class="headerlink" href="#v1-client-stateful-query-files" title="Permalink to this heading">¶</a></h3>
Stateful query files allow clients to request a list of versions of
each of the <a class="reference internal" href="#object-kinds">Object Kinds</a> and get only the most recent version
recognized by the CMake that runs.
Clients may create owned stateful queries by creating <code class="docutils literal notranslate">query.json</code>
files in client-specific query subdirectories. The form is:
<div class="highlight-none notranslate"><div class="highlight"><pre>&lt;build&gt;/.cmake/api/v1/query/client-&lt;client&gt;/query.json
</pre></div>
</div>
where <code class="docutils literal notranslate">client-</code> is literal, <code class="docutils literal notranslate">&lt;client&gt;</code> is a string uniquely
identifying the client, and <code class="docutils literal notranslate">query.json</code> is literal. Each client
must choose a unique <code class="docutils literal notranslate">&lt;client&gt;</code> identifier via its own means.
<code class="docutils literal notranslate">query.json</code> files are stateful queries owned by the client <code class="docutils literal notranslate">&lt;client&gt;</code>.
The owning client may update or remove them at any time. When a
given client installation is updated it may then update the stateful
query it writes to build trees to request newer object versions.
This can be used to avoid asking CMake to generate multiple object
versions unnecessarily.
A <code class="docutils literal notranslate">query.json</code> file must contain a JSON object:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;requests&quot;: [
 { &quot;kind&quot;: &quot;&lt;kind&gt;&quot; , &quot;version&quot;: 1 },
 { &quot;kind&quot;: &quot;&lt;kind&gt;&quot; , &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 2 } },
 { &quot;kind&quot;: &quot;&lt;kind&gt;&quot; , &quot;version&quot;: [2, 1] },
 { &quot;kind&quot;: &quot;&lt;kind&gt;&quot; , &quot;version&quot;: [2, { &quot;major&quot;: 1, &quot;minor&quot;: 2 }] },
 { &quot;kind&quot;: &quot;&lt;kind&gt;&quot; , &quot;version&quot;: 1, &quot;client&quot;: {} },
 { &quot;kind&quot;: &quot;...&quot; }
 ],
 &quot;client&quot;: {}
}
</pre></div>
</div>
The members are:
<dl>
<dt><code class="docutils literal notranslate">requests</code></dt><dd>A JSON array containing zero or more requests. Each request is
a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">kind</code></dt><dd>Specifies one of the <a class="reference internal" href="#object-kinds">Object Kinds</a> to be included in the reply.
</dd>
<dt><code class="docutils literal notranslate">version</code></dt><dd>Indicates the version(s) of the object kind that the client
understands. Versions have major and minor components following
semantic version conventions. The value must be
<ul class="simple">
<li>a JSON integer specifying a (non-negative) major version number, or</li>
<li>a JSON object containing <code class="docutils literal notranslate">major</code> and (optionally) <code class="docutils literal notranslate">minor</code>
members specifying non-negative integer version components, or</li>
<li>a JSON array whose elements are each one of the above.</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">client</code></dt><dd>Optional member reserved for use by the client. This value is
preserved in the reply written for the client in the
<a class="reference internal" href="#v1-reply-index-file">v1 Reply Index File</a> but is otherwise ignored. Clients may use
this to pass custom information with a request through to its reply.
</dd>
</dl>
For each requested object kind CMake will choose the first version
that it recognizes for that kind among those listed in the request.
The response will use the selected major version with the highest
minor version known to the running CMake for that major version.
Therefore clients should list all supported major versions in
preferred order along with the minimal minor version required
for each major version.
</dd>
<dt><code class="docutils literal notranslate">client</code></dt><dd>Optional member reserved for use by the client. This value is
preserved in the reply written for the client in the
<a class="reference internal" href="#v1-reply-index-file">v1 Reply Index File</a> but is otherwise ignored. Clients may use
this to pass custom information with a query through to its reply.
</dd>
</dl>
Other <code class="docutils literal notranslate">query.json</code> top-level members are reserved for future use.
If present they are ignored for forward compatibility.
</section>
<section id="v1-reply-index-file">
<h3><a class="toc-backref" href="#id7" role="doc-backlink">v1 Reply Index File</a><a class="headerlink" href="#v1-reply-index-file" title="Permalink to this heading">¶</a></h3>
CMake writes an <code class="docutils literal notranslate">index-*.json</code> file to the <code class="docutils literal notranslate">v1/reply/</code> directory
whenever it runs to generate a build system. Clients must read the
reply index file first and may read other <a class="reference internal" href="#v1-reply-files">v1 Reply Files</a> only by
following references. The form of the reply index file name is:
<div class="highlight-none notranslate"><div class="highlight"><pre>&lt;build&gt;/.cmake/api/v1/reply/index-&lt;unspecified&gt;.json
</pre></div>
</div>
where <code class="docutils literal notranslate">index-</code> is literal and <code class="docutils literal notranslate">&lt;unspecified&gt;</code> is an unspecified
name selected by CMake. Whenever a new index file is generated it
is given a new name and any old one is deleted. During the short
time between these steps there may be multiple index files present;
the one with the largest name in lexicographic order is the current
index file.
The reply index file contains a JSON object:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;cmake&quot;: {
 &quot;version&quot;: {
 &quot;major&quot;: 3, &quot;minor&quot;: 14, &quot;patch&quot;: 0, &quot;suffix&quot;: &quot;&quot;,
 &quot;string&quot;: &quot;3.14.0&quot;, &quot;isDirty&quot;: false
 },
 &quot;paths&quot;: {
 &quot;cmake&quot;: &quot;/prefix/bin/cmake&quot;,
 &quot;ctest&quot;: &quot;/prefix/bin/ctest&quot;,
 &quot;cpack&quot;: &quot;/prefix/bin/cpack&quot;,
 &quot;root&quot;: &quot;/prefix/share/cmake-3.14&quot;
 },
 &quot;generator&quot;: {
 &quot;multiConfig&quot;: false,
 &quot;name&quot;: &quot;Unix Makefiles&quot;
 }
 },
 &quot;objects&quot;: [
 { &quot;kind&quot;: &quot;&lt;kind&gt;&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot; },
 { &quot;...&quot;: &quot;...&quot; }
 ],
 &quot;reply&quot;: {
 &quot;&lt;kind&gt;-v&lt;major&gt;&quot;: { &quot;kind&quot;: &quot;&lt;kind&gt;&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot; },
 &quot;&lt;unknown&gt;&quot;: { &quot;error&quot;: &quot;unknown query file&quot; },
 &quot;...&quot;: {},
 &quot;client-&lt;client&gt;&quot;: {
 &quot;&lt;kind&gt;-v&lt;major&gt;&quot;: { &quot;kind&quot;: &quot;&lt;kind&gt;&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot; },
 &quot;&lt;unknown&gt;&quot;: { &quot;error&quot;: &quot;unknown query file&quot; },
 &quot;...&quot;: {},
 &quot;query.json&quot;: {
 &quot;requests&quot;: [ {}, {}, {} ],
 &quot;responses&quot;: [
 { &quot;kind&quot;: &quot;&lt;kind&gt;&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot; },
 { &quot;error&quot;: &quot;unknown query file&quot; },
 { &quot;...&quot;: {} }
 ],
 &quot;client&quot;: {}
 }
 }
 }
}
</pre></div>
</div>
The members are:
<dl>
<dt><code class="docutils literal notranslate">cmake</code></dt><dd>A JSON object containing information about the instance of CMake that
generated the reply. It contains members:
<dl>
<dt><code class="docutils literal notranslate">version</code></dt><dd>A JSON object specifying the version of CMake with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">major</code>, <code class="docutils literal notranslate">minor</code>, <code class="docutils literal notranslate">patch</code></dt><dd>Integer values specifying the major, minor, and patch version components.
</dd>
<dt><code class="docutils literal notranslate">suffix</code></dt><dd>A string specifying the version suffix, if any, e.g. <code class="docutils literal notranslate">g0abc3</code>.
</dd>
<dt><code class="docutils literal notranslate">string</code></dt><dd>A string specifying the full version in the format
<code class="docutils literal notranslate">&lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;[-&lt;suffix&gt;]</code>.
</dd>
<dt><code class="docutils literal notranslate">isDirty</code></dt><dd>A boolean indicating whether the version was built from a version
controlled source tree with local modifications.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">paths</code></dt><dd>A JSON object specifying paths to things that come with CMake.
It has members for cmake, ctest, and cpack
whose values are JSON strings specifying the absolute path to each tool,
represented with forward slashes. It also has a <code class="docutils literal notranslate">root</code> member for
the absolute path to the directory containing CMake resources like the
<code class="docutils literal notranslate">Modules/</code> directory (see <a class="reference internal" href="../variable/CMAKE_ROOT.html#variable:CMAKE_ROOT" title="CMAKE_ROOT"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_ROOT</code></a>).
</dd>
<dt><code class="docutils literal notranslate">generator</code></dt><dd>A JSON object describing the CMake generator used for the build.
It has members:
<dl class="simple">
<dt><code class="docutils literal notranslate">multiConfig</code></dt><dd>A boolean specifying whether the generator supports multiple output
configurations.
</dd>
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name of the generator.
</dd>
<dt><code class="docutils literal notranslate">platform</code></dt><dd>If the generator supports <a class="reference internal" href="../variable/CMAKE_GENERATOR_PLATFORM.html#variable:CMAKE_GENERATOR_PLATFORM" title="CMAKE_GENERATOR_PLATFORM"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_GENERATOR_PLATFORM</code></a>,
this is a string specifying the generator platform name.
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">objects</code></dt><dd>A JSON array listing all versions of all <a class="reference internal" href="#object-kinds">Object Kinds</a> generated
as part of the reply. Each array entry is a
<a class="reference internal" href="#v1-reply-file-reference">v1 Reply File Reference</a>.
</dd>
<dt><code class="docutils literal notranslate">reply</code></dt><dd>A JSON object mirroring the content of the <code class="docutils literal notranslate">query/</code> directory
that CMake loaded to produce the reply. The members are of the form
<dl>
<dt><code class="docutils literal notranslate">&lt;kind&gt;-v&lt;major&gt;</code></dt><dd>A member of this form appears for each of the
<a class="reference internal" href="#v1-shared-stateless-query-files">v1 Shared Stateless Query Files</a> that CMake recognized as a
request for object kind <code class="docutils literal notranslate">&lt;kind&gt;</code> with major version <code class="docutils literal notranslate">&lt;major&gt;</code>.
The value is a <a class="reference internal" href="#v1-reply-file-reference">v1 Reply File Reference</a> to the corresponding
reply file for that object kind and version.
</dd>
<dt><code class="docutils literal notranslate">&lt;unknown&gt;</code></dt><dd>A member of this form appears for each of the
<a class="reference internal" href="#v1-shared-stateless-query-files">v1 Shared Stateless Query Files</a> that CMake did not recognize.
The value is a JSON object with a single <code class="docutils literal notranslate">error</code> member
containing a string with an error message indicating that the
query file is unknown.
</dd>
<dt><code class="docutils literal notranslate">client-&lt;client&gt;</code></dt><dd>A member of this form appears for each client-owned directory
holding <a class="reference internal" href="#v1-client-stateless-query-files">v1 Client Stateless Query Files</a>.
The value is a JSON object mirroring the content of the
<code class="docutils literal notranslate">query/client-&lt;client&gt;/</code> directory. The members are of the form:
<dl>
<dt><code class="docutils literal notranslate">&lt;kind&gt;-v&lt;major&gt;</code></dt><dd>A member of this form appears for each of the
<a class="reference internal" href="#v1-client-stateless-query-files">v1 Client Stateless Query Files</a> that CMake recognized as a
request for object kind <code class="docutils literal notranslate">&lt;kind&gt;</code> with major version <code class="docutils literal notranslate">&lt;major&gt;</code>.
The value is a <a class="reference internal" href="#v1-reply-file-reference">v1 Reply File Reference</a> to the corresponding
reply file for that object kind and version.
</dd>
<dt><code class="docutils literal notranslate">&lt;unknown&gt;</code></dt><dd>A member of this form appears for each of the
<a class="reference internal" href="#v1-client-stateless-query-files">v1 Client Stateless Query Files</a> that CMake did not recognize.
The value is a JSON object with a single <code class="docutils literal notranslate">error</code> member
containing a string with an error message indicating that the
query file is unknown.
</dd>
<dt><code class="docutils literal notranslate">query.json</code></dt><dd>This member appears for clients using
<a class="reference internal" href="#v1-client-stateful-query-files">v1 Client Stateful Query Files</a>.
If the <code class="docutils literal notranslate">query.json</code> file failed to read or parse as a JSON object,
this member is a JSON object with a single <code class="docutils literal notranslate">error</code> member
containing a string with an error message. Otherwise, this member
is a JSON object mirroring the content of the <code class="docutils literal notranslate">query.json</code> file.
The members are:
<dl class="simple">
<dt><code class="docutils literal notranslate">client</code></dt><dd>A copy of the <code class="docutils literal notranslate">query.json</code> file <code class="docutils literal notranslate">client</code> member, if it exists.
</dd>
<dt><code class="docutils literal notranslate">requests</code></dt><dd>A copy of the <code class="docutils literal notranslate">query.json</code> file <code class="docutils literal notranslate">requests</code> member, if it exists.
</dd>
<dt><code class="docutils literal notranslate">responses</code></dt><dd>If the <code class="docutils literal notranslate">query.json</code> file <code class="docutils literal notranslate">requests</code> member is missing or invalid,
this member is a JSON object with a single <code class="docutils literal notranslate">error</code> member
containing a string with an error message. Otherwise, this member
contains a JSON array with a response for each entry of the
<code class="docutils literal notranslate">requests</code> array, in the same order. Each response is
<ul class="simple">
<li>a JSON object with a single <code class="docutils literal notranslate">error</code> member containing a string
with an error message, or</li>
<li>a <a class="reference internal" href="#v1-reply-file-reference">v1 Reply File Reference</a> to the corresponding reply file for
the requested object kind and selected version.</li>
</ul>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
After reading the reply index file, clients may read the other
<a class="reference internal" href="#v1-reply-files">v1 Reply Files</a> it references.
<section id="v1-reply-file-reference">
<h4><a class="toc-backref" href="#id8" role="doc-backlink">v1 Reply File Reference</a><a class="headerlink" href="#v1-reply-file-reference" title="Permalink to this heading">¶</a></h4>
The reply index file represents each reference to another reply file
using a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">kind</code></dt><dd>A string specifying one of the <a class="reference internal" href="#object-kinds">Object Kinds</a>.
</dd>
<dt><code class="docutils literal notranslate">version</code></dt><dd>A JSON object with members <code class="docutils literal notranslate">major</code> and <code class="docutils literal notranslate">minor</code> specifying
integer version components of the object kind.
</dd>
<dt><code class="docutils literal notranslate">jsonFile</code></dt><dd>A JSON string specifying a path relative to the reply index file
to another JSON file containing the object.
</dd>
</dl>
</section>
</section>
<section id="v1-reply-files">
<h3><a class="toc-backref" href="#id9" role="doc-backlink">v1 Reply Files</a><a class="headerlink" href="#v1-reply-files" title="Permalink to this heading">¶</a></h3>
Reply files containing specific <a class="reference internal" href="#object-kinds">Object Kinds</a> are written by CMake.
The names of these files are unspecified and must not be interpreted
by clients. Clients must first read the <a class="reference internal" href="#v1-reply-index-file">v1 Reply Index File</a> and
follow references to the names of the desired response objects.
Reply files (including the index file) will never be replaced by
files of the same name but different content. This allows a client
to read the files concurrently with a running CMake that may generate
a new reply. However, after generating a new reply CMake will attempt
to remove reply files from previous runs that it did not just write.
If a client attempts to read a reply file referenced by the index but
finds the file missing, that means a concurrent CMake has generated
a new reply. The client may simply start again by reading the new
reply index file.
</section>
</section>
<section id="object-kinds">
<h2><a class="toc-backref" href="#id10" role="doc-backlink">Object Kinds</a><a class="headerlink" href="#object-kinds" title="Permalink to this heading">¶</a></h2>
The CMake file-based API reports semantic information about the build
system using the following kinds of JSON objects. Each kind of object
is versioned independently using semantic versioning with major and
minor components. Every kind of object has the form:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;kind&quot;: &quot;&lt;kind&gt;&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;...&quot;: {}
}
</pre></div>
</div>
The <code class="docutils literal notranslate">kind</code> member is a string specifying the object kind name.
The <code class="docutils literal notranslate">version</code> member is a JSON object with <code class="docutils literal notranslate">major</code> and <code class="docutils literal notranslate">minor</code>
members specifying integer components of the object kind's version.
Additional top-level members are specific to each object kind.
<section id="object-kind-codemodel">
<h3><a class="toc-backref" href="#id11" role="doc-backlink">Object Kind &quot;codemodel&quot;</a><a class="headerlink" href="#object-kind-codemodel" title="Permalink to this heading">¶</a></h3>
The <code class="docutils literal notranslate">codemodel</code> object kind describes the build system structure as
modeled by CMake.
There is only one <code class="docutils literal notranslate">codemodel</code> object major version, version 2.
Version 1 does not exist to avoid confusion with that from
<a class="reference internal" href="cmake-server.7.html#manual:cmake-server(7)" title="cmake-server(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-server(7)</code></a> mode.
<section id="codemodel-version-2">
<h4><a class="toc-backref" href="#id12" role="doc-backlink">&quot;codemodel&quot; version 2</a><a class="headerlink" href="#codemodel-version-2" title="Permalink to this heading">¶</a></h4>
<code class="docutils literal notranslate">codemodel</code> object version 2 is a JSON object:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;kind&quot;: &quot;codemodel&quot;,
 &quot;version&quot;: { &quot;major&quot;: 2, &quot;minor&quot;: 5 },
 &quot;paths&quot;: {
 &quot;source&quot;: &quot;/path/to/top-level-source-dir&quot;,
 &quot;build&quot;: &quot;/path/to/top-level-build-dir&quot;
 },
 &quot;configurations&quot;: [
 {
 &quot;name&quot;: &quot;Debug&quot;,
 &quot;directories&quot;: [
 {
 &quot;source&quot;: &quot;.&quot;,
 &quot;build&quot;: &quot;.&quot;,
 &quot;childIndexes&quot;: [ 1 ],
 &quot;projectIndex&quot;: 0,
 &quot;targetIndexes&quot;: [ 0 ],
 &quot;hasInstallRule&quot;: true,
 &quot;minimumCMakeVersion&quot;: {
 &quot;string&quot;: &quot;3.14&quot;
 },
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot;
 },
 {
 &quot;source&quot;: &quot;sub&quot;,
 &quot;build&quot;: &quot;sub&quot;,
 &quot;parentIndex&quot;: 0,
 &quot;projectIndex&quot;: 0,
 &quot;targetIndexes&quot;: [ 1 ],
 &quot;minimumCMakeVersion&quot;: {
 &quot;string&quot;: &quot;3.14&quot;
 },
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot;
 }
 ],
 &quot;projects&quot;: [
 {
 &quot;name&quot;: &quot;MyProject&quot;,
 &quot;directoryIndexes&quot;: [ 0, 1 ],
 &quot;targetIndexes&quot;: [ 0, 1 ]
 }
 ],
 &quot;targets&quot;: [
 {
 &quot;name&quot;: &quot;MyExecutable&quot;,
 &quot;directoryIndex&quot;: 0,
 &quot;projectIndex&quot;: 0,
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot;
 },
 {
 &quot;name&quot;: &quot;MyLibrary&quot;,
 &quot;directoryIndex&quot;: 1,
 &quot;projectIndex&quot;: 0,
 &quot;jsonFile&quot;: &quot;&lt;file&gt;&quot;
 }
 ]
 }
 ]
}
</pre></div>
</div>
The members specific to <code class="docutils literal notranslate">codemodel</code> objects are:
<dl>
<dt><code class="docutils literal notranslate">paths</code></dt><dd>A JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">source</code></dt><dd>A string specifying the absolute path to the top-level source directory,
represented with forward slashes.
</dd>
<dt><code class="docutils literal notranslate">build</code></dt><dd>A string specifying the absolute path to the top-level build directory,
represented with forward slashes.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">configurations</code></dt><dd>A JSON array of entries corresponding to available build configurations.
On single-configuration generators there is one entry for the value
of the <a class="reference internal" href="../variable/CMAKE_BUILD_TYPE.html#variable:CMAKE_BUILD_TYPE" title="CMAKE_BUILD_TYPE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_BUILD_TYPE</code></a> variable. For multi-configuration
generators there is an entry for each configuration listed in the
<a class="reference internal" href="../variable/CMAKE_CONFIGURATION_TYPES.html#variable:CMAKE_CONFIGURATION_TYPES" title="CMAKE_CONFIGURATION_TYPES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CONFIGURATION_TYPES</code></a> variable.
Each entry is a JSON object containing members:
<dl>
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name of the configuration, e.g. <code class="docutils literal notranslate">Debug</code>.
</dd>
<dt><code class="docutils literal notranslate">directories</code></dt><dd>A JSON array of entries each corresponding to a build system directory
whose source directory contains a <code class="docutils literal notranslate">CMakeLists.txt</code> file. The first
entry corresponds to the top-level directory. Each entry is a
JSON object containing members:
<dl>
<dt><code class="docutils literal notranslate">source</code></dt><dd>A string specifying the path to the source directory, represented
with forward slashes. If the directory is inside the top-level
source directory then the path is specified relative to that
directory (with <code class="docutils literal notranslate">.</code> for the top-level source directory itself).
Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">build</code></dt><dd>A string specifying the path to the build directory, represented
with forward slashes. If the directory is inside the top-level
build directory then the path is specified relative to that
directory (with <code class="docutils literal notranslate">.</code> for the top-level build directory itself).
Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">parentIndex</code></dt><dd>Optional member that is present when the directory is not top-level.
The value is an unsigned integer 0-based index of another entry in
the main <code class="docutils literal notranslate">directories</code> array that corresponds to the parent
directory that added this directory as a subdirectory.
</dd>
<dt><code class="docutils literal notranslate">childIndexes</code></dt><dd>Optional member that is present when the directory has subdirectories.
The value is a JSON array of entries corresponding to child directories
created by the <a class="reference internal" href="../command/add_subdirectory.html#command:add_subdirectory" title="add_subdirectory"><code class="xref cmake cmake-command docutils literal notranslate">add_subdirectory()</code></a> or <a class="reference internal" href="../command/subdirs.html#command:subdirs" title="subdirs"><code class="xref cmake cmake-command docutils literal notranslate">subdirs()</code></a>
command. Each entry is an unsigned integer 0-based index of another
entry in the main <code class="docutils literal notranslate">directories</code> array.
</dd>
<dt><code class="docutils literal notranslate">projectIndex</code></dt><dd>An unsigned integer 0-based index into the main <code class="docutils literal notranslate">projects</code> array
indicating the build system project to which the this directory belongs.
</dd>
<dt><code class="docutils literal notranslate">targetIndexes</code></dt><dd>Optional member that is present when the directory itself has targets,
excluding those belonging to subdirectories. The value is a JSON
array of entries corresponding to the targets. Each entry is an
unsigned integer 0-based index into the main <code class="docutils literal notranslate">targets</code> array.
</dd>
<dt><code class="docutils literal notranslate">minimumCMakeVersion</code></dt><dd>Optional member present when a minimum required version of CMake is
known for the directory. This is the <code class="docutils literal notranslate">&lt;min&gt;</code> version given to the
most local call to the <a class="reference internal" href="../command/cmake_minimum_required.html#command:cmake_minimum_required" title="cmake_minimum_required"><code class="xref cmake cmake-command docutils literal notranslate">cmake_minimum_required(VERSION)</code></a>
command in the directory itself or one of its ancestors.
The value is a JSON object with one member:
<dl>
<dt><code class="docutils literal notranslate">string</code></dt><dd>A string specifying the minimum required version in the format:
<div class="highlight-none notranslate"><div class="highlight"><pre>&lt;major&gt;.&lt;minor&gt;[.&lt;patch&gt;[.&lt;tweak&gt;]][&lt;suffix&gt;]
</pre></div>
</div>
Each component is an unsigned integer and the suffix may be an
arbitrary string.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">hasInstallRule</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code> when
the directory or one of its subdirectories contains any
<a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> rules, i.e. whether a <code class="docutils literal notranslate">make install</code>
or equivalent rule is available.
</dd>
<dt><code class="docutils literal notranslate">jsonFile</code></dt><dd>A JSON string specifying a path relative to the codemodel file
to another JSON file containing a
<a class="reference internal" href="#codemodel-version-2-directory-object">&quot;codemodel&quot; version 2 &quot;directory&quot; object</a>.
This field was added in codemodel version 2.3.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">projects</code></dt><dd>A JSON array of entries corresponding to the top-level project
and sub-projects defined in the build system. Each (sub-)project
corresponds to a source directory whose <code class="docutils literal notranslate">CMakeLists.txt</code> file
calls the <a class="reference internal" href="../command/project.html#command:project" title="project"><code class="xref cmake cmake-command docutils literal notranslate">project()</code></a> command with a project name different
from its parent directory. The first entry corresponds to the
top-level project.
Each entry is a JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name given to the <a class="reference internal" href="../command/project.html#command:project" title="project"><code class="xref cmake cmake-command docutils literal notranslate">project()</code></a> command.
</dd>
<dt><code class="docutils literal notranslate">parentIndex</code></dt><dd>Optional member that is present when the project is not top-level.
The value is an unsigned integer 0-based index of another entry in
the main <code class="docutils literal notranslate">projects</code> array that corresponds to the parent project
that added this project as a sub-project.
</dd>
<dt><code class="docutils literal notranslate">childIndexes</code></dt><dd>Optional member that is present when the project has sub-projects.
The value is a JSON array of entries corresponding to the sub-projects.
Each entry is an unsigned integer 0-based index of another
entry in the main <code class="docutils literal notranslate">projects</code> array.
</dd>
<dt><code class="docutils literal notranslate">directoryIndexes</code></dt><dd>A JSON array of entries corresponding to build system directories
that are part of the project. The first entry corresponds to the
top-level directory of the project. Each entry is an unsigned
integer 0-based index into the main <code class="docutils literal notranslate">directories</code> array.
</dd>
<dt><code class="docutils literal notranslate">targetIndexes</code></dt><dd>Optional member that is present when the project itself has targets,
excluding those belonging to sub-projects. The value is a JSON
array of entries corresponding to the targets. Each entry is an
unsigned integer 0-based index into the main <code class="docutils literal notranslate">targets</code> array.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">targets</code></dt><dd>A JSON array of entries corresponding to the build system targets.
Such targets are created by calls to <a class="reference internal" href="../command/add_executable.html#command:add_executable" title="add_executable"><code class="xref cmake cmake-command docutils literal notranslate">add_executable()</code></a>,
<a class="reference internal" href="../command/add_library.html#command:add_library" title="add_library"><code class="xref cmake cmake-command docutils literal notranslate">add_library()</code></a>, and <a class="reference internal" href="../command/add_custom_target.html#command:add_custom_target" title="add_custom_target"><code class="xref cmake cmake-command docutils literal notranslate">add_custom_target()</code></a>, excluding
imported targets and interface libraries (which do not generate any
build rules). Each entry is a JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the target name.
</dd>
<dt><code class="docutils literal notranslate">id</code></dt><dd>A string uniquely identifying the target. This matches the <code class="docutils literal notranslate">id</code>
field in the file referenced by <code class="docutils literal notranslate">jsonFile</code>.
</dd>
<dt><code class="docutils literal notranslate">directoryIndex</code></dt><dd>An unsigned integer 0-based index into the main <code class="docutils literal notranslate">directories</code> array
indicating the build system directory in which the target is defined.
</dd>
<dt><code class="docutils literal notranslate">projectIndex</code></dt><dd>An unsigned integer 0-based index into the main <code class="docutils literal notranslate">projects</code> array
indicating the build system project in which the target is defined.
</dd>
<dt><code class="docutils literal notranslate">jsonFile</code></dt><dd>A JSON string specifying a path relative to the codemodel file
to another JSON file containing a
<a class="reference internal" href="#codemodel-version-2-target-object">&quot;codemodel&quot; version 2 &quot;target&quot; object</a>.
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="codemodel-version-2-directory-object">
<h4><a class="toc-backref" href="#id13" role="doc-backlink">&quot;codemodel&quot; version 2 &quot;directory&quot; object</a><a class="headerlink" href="#codemodel-version-2-directory-object" title="Permalink to this heading">¶</a></h4>
A codemodel &quot;directory&quot; object is referenced by a <a class="reference internal" href="#codemodel-version-2">&quot;codemodel&quot; version 2</a>
object's <code class="docutils literal notranslate">directories</code> array. Each &quot;directory&quot; object is a JSON object
with members:
<dl>
<dt><code class="docutils literal notranslate">paths</code></dt><dd>A JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">source</code></dt><dd>A string specifying the path to the source directory, represented
with forward slashes. If the directory is inside the top-level
source directory then the path is specified relative to that
directory (with <code class="docutils literal notranslate">.</code> for the top-level source directory itself).
Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">build</code></dt><dd>A string specifying the path to the build directory, represented
with forward slashes. If the directory is inside the top-level
build directory then the path is specified relative to that
directory (with <code class="docutils literal notranslate">.</code> for the top-level build directory itself).
Otherwise the path is absolute.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">installers</code></dt><dd>A JSON array of entries corresponding to <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> rules.
Each entry is a JSON object containing members:
<dl>
<dt><code class="docutils literal notranslate">component</code></dt><dd>A string specifying the component selected by the corresponding
<a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> command invocation.
</dd>
<dt><code class="docutils literal notranslate">destination</code></dt><dd>Optional member that is present for specific <code class="docutils literal notranslate">type</code> values below.
The value is a string specifying the install destination path.
The path may be absolute or relative to the install prefix.
</dd>
<dt><code class="docutils literal notranslate">paths</code></dt><dd>Optional member that is present for specific <code class="docutils literal notranslate">type</code> values below.
The value is a JSON array of entries corresponding to the paths
(files or directories) to be installed. Each entry is one of:
<ul>
<li>A string specifying the path from which a file or directory
is to be installed. The portion of the path not preceded by
a <code class="docutils literal notranslate">/</code> also specifies the path (name) to which the file
or directory is to be installed under the destination.</li>
<li>A JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">from</code></dt><dd>A string specifying the path from which a file or directory
is to be installed.
</dd>
<dt><code class="docutils literal notranslate">to</code></dt><dd>A string specifying the path to which the file or directory
is to be installed under the destination.
</dd>
</dl>
</li>
</ul>
In both cases the paths are represented with forward slashes. If
the &quot;from&quot; path is inside the top-level directory documented by the
corresponding <code class="docutils literal notranslate">type</code> value, then the path is specified relative
to that directory. Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">type</code></dt><dd>A string specifying the type of installation rule. The value is one
of the following, with some variants providing additional members:
<dl>
<dt><code class="docutils literal notranslate">file</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(FILES)</code></a> or <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(PROGRAMS)</code></a> call.
The <code class="docutils literal notranslate">destination</code> and <code class="docutils literal notranslate">paths</code> members are populated, with paths
under the top-level source directory expressed relative to it.
The <code class="docutils literal notranslate">isOptional</code> member may exist.
This type has no additional members.
</dd>
<dt><code class="docutils literal notranslate">directory</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(DIRECTORY)</code></a> call.
The <code class="docutils literal notranslate">destination</code> and <code class="docutils literal notranslate">paths</code> members are populated, with paths
under the top-level source directory expressed relative to it.
The <code class="docutils literal notranslate">isOptional</code> member may exist.
This type has no additional members.
</dd>
<dt><code class="docutils literal notranslate">target</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(TARGETS)</code></a> call.
The <code class="docutils literal notranslate">destination</code> and <code class="docutils literal notranslate">paths</code> members are populated, with paths
under the top-level build directory expressed relative to it.
The <code class="docutils literal notranslate">isOptional</code> member may exist.
This type has additional members <code class="docutils literal notranslate">targetId</code>, <code class="docutils literal notranslate">targetIndex</code>,
<code class="docutils literal notranslate">targetIsImportLibrary</code>, and <code class="docutils literal notranslate">targetInstallNamelink</code>.
</dd>
<dt><code class="docutils literal notranslate">export</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(EXPORT)</code></a> call.
The <code class="docutils literal notranslate">destination</code> and <code class="docutils literal notranslate">paths</code> members are populated, with paths
under the top-level build directory expressed relative to it.
The <code class="docutils literal notranslate">paths</code> entries refer to files generated automatically by
CMake for installation, and their actual values are considered
private implementation details.
This type has additional members <code class="docutils literal notranslate">exportName</code> and <code class="docutils literal notranslate">exportTargets</code>.
</dd>
<dt><code class="docutils literal notranslate">script</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(SCRIPT)</code></a> call.
This type has additional member <code class="docutils literal notranslate">scriptFile</code>.
</dd>
<dt><code class="docutils literal notranslate">code</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(CODE)</code></a> call.
This type has no additional members.
</dd>
<dt><code class="docutils literal notranslate">importedRuntimeArtifacts</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(IMPORTED_RUNTIME_ARTIFACTS)</code></a> call.
The <code class="docutils literal notranslate">destination</code> member is populated. The <code class="docutils literal notranslate">isOptional</code> member may
exist. This type has no additional members.
</dd>
<dt><code class="docutils literal notranslate">runtimeDependencySet</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(RUNTIME_DEPENDENCY_SET)</code></a> call or an
<a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(TARGETS)</code></a> call with <code class="docutils literal notranslate">RUNTIME_DEPENDENCIES</code>. The
<code class="docutils literal notranslate">destination</code> member is populated. This type has additional members
<code class="docutils literal notranslate">runtimeDependencySetName</code> and <code class="docutils literal notranslate">runtimeDependencySetType</code>.
</dd>
<dt><code class="docutils literal notranslate">fileSet</code></dt><dd>An <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(TARGETS)</code></a> call with <code class="docutils literal notranslate">FILE_SET</code>.
The <code class="docutils literal notranslate">destination</code> and <code class="docutils literal notranslate">paths</code> members are populated.
The <code class="docutils literal notranslate">isOptional</code> member may exist.
This type has additional members <code class="docutils literal notranslate">fileSetName</code>, <code class="docutils literal notranslate">fileSetType</code>,
<code class="docutils literal notranslate">fileSetDirectories</code>, and <code class="docutils literal notranslate">fileSetTarget</code>.
This type was added in codemodel version 2.4.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">isExcludeFromAll</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code> when
<a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> is called with the <code class="docutils literal notranslate">EXCLUDE_FROM_ALL</code> option.
</dd>
<dt><code class="docutils literal notranslate">isForAllComponents</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code> when
<a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(SCRIPT|CODE)</code></a> is called with the
<code class="docutils literal notranslate">ALL_COMPONENTS</code> option.
</dd>
<dt><code class="docutils literal notranslate">isOptional</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code> when
<a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> is called with the <code class="docutils literal notranslate">OPTIONAL</code> option.
This is allowed when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">file</code>, <code class="docutils literal notranslate">directory</code>, or <code class="docutils literal notranslate">target</code>.
</dd>
<dt><code class="docutils literal notranslate">targetId</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">target</code>.
The value is a string uniquely identifying the target to be installed.
This matches the <code class="docutils literal notranslate">id</code> member of the target in the main
&quot;codemodel&quot; object's <code class="docutils literal notranslate">targets</code> array.
</dd>
<dt><code class="docutils literal notranslate">targetIndex</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">target</code>.
The value is an unsigned integer 0-based index into the main &quot;codemodel&quot;
object's <code class="docutils literal notranslate">targets</code> array for the target to be installed.
</dd>
<dt><code class="docutils literal notranslate">targetIsImportLibrary</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">target</code> and
the installer is for a Windows DLL import library file or for an
AIX linker import file. If present, it has boolean value <code class="docutils literal notranslate">true</code>.
</dd>
<dt><code class="docutils literal notranslate">targetInstallNamelink</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">target</code> and
the installer corresponds to a target that may use symbolic links
to implement the <a class="reference internal" href="../prop_tgt/VERSION.html#prop_tgt:VERSION" title="VERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">VERSION</code></a> and <a class="reference internal" href="../prop_tgt/SOVERSION.html#prop_tgt:SOVERSION" title="SOVERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">SOVERSION</code></a>
target properties.
The value is a string indicating how the installer is supposed to
handle the symlinks: <code class="docutils literal notranslate">skip</code> means the installer should skip the
symlinks and install only the real file, and <code class="docutils literal notranslate">only</code> means the
installer should install only the symlinks and not the real file.
In all cases the <code class="docutils literal notranslate">paths</code> member lists what it actually installs.
</dd>
<dt><code class="docutils literal notranslate">exportName</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">export</code>.
The value is a string specifying the name of the export.
</dd>
<dt><code class="docutils literal notranslate">exportTargets</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">export</code>.
The value is a JSON array of entries corresponding to the targets
included in the export. Each entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">id</code></dt><dd>A string uniquely identifying the target. This matches
the <code class="docutils literal notranslate">id</code> member of the target in the main &quot;codemodel&quot;
object's <code class="docutils literal notranslate">targets</code> array.
</dd>
<dt><code class="docutils literal notranslate">index</code></dt><dd>An unsigned integer 0-based index into the main &quot;codemodel&quot;
object's <code class="docutils literal notranslate">targets</code> array for the target.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">runtimeDependencySetName</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">runtimeDependencySet</code>
and the installer was created by an
<a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(RUNTIME_DEPENDENCY_SET)</code></a> call. The value is a string
specifying the name of the runtime dependency set that was installed.
</dd>
<dt><code class="docutils literal notranslate">runtimeDependencySetType</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">runtimeDependencySet</code>.
The value is a string with one of the following values:
<dl class="simple">
<dt><code class="docutils literal notranslate">library</code></dt><dd>Indicates that this installer installs dependencies that are not macOS
frameworks.
</dd>
<dt><code class="docutils literal notranslate">framework</code></dt><dd>Indicates that this installer installs dependencies that are macOS
frameworks.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">fileSetName</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">fileSet</code>. The value is
a string with the name of the file set.
This field was added in codemodel version 2.4.
</dd>
<dt><code class="docutils literal notranslate">fileSetType</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">fileSet</code>. The value is
a string with the type of the file set.
This field was added in codemodel version 2.4.
</dd>
<dt><code class="docutils literal notranslate">fileSetDirectories</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">fileSet</code>. The value
is a list of strings with the file set's base directories (determined by
genex-evaluation of <a class="reference internal" href="../prop_tgt/HEADER_DIRS.html#prop_tgt:HEADER_DIRS" title="HEADER_DIRS"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">HEADER_DIRS</code></a> or
<a class="reference internal" href="../prop_tgt/HEADER_DIRS_NAME.html#prop_tgt:HEADER_DIRS_&lt;NAME&gt;" title="HEADER_DIRS_&lt;NAME&gt;"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">HEADER_DIRS_&lt;NAME&gt;</code></a>).
This field was added in codemodel version 2.4.
</dd>
<dt><code class="docutils literal notranslate">fileSetTarget</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">fileSet</code>. The value
is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">id</code></dt><dd>A string uniquely identifying the target. This matches
the <code class="docutils literal notranslate">id</code> member of the target in the main &quot;codemodel&quot;
object's <code class="docutils literal notranslate">targets</code> array.
</dd>
<dt><code class="docutils literal notranslate">index</code></dt><dd>An unsigned integer 0-based index into the main &quot;codemodel&quot;
object's <code class="docutils literal notranslate">targets</code> array for the target.
</dd>
</dl>
This field was added in codemodel version 2.4.
</dd>
<dt><code class="docutils literal notranslate">scriptFile</code></dt><dd>Optional member that is present when <code class="docutils literal notranslate">type</code> is <code class="docutils literal notranslate">script</code>.
The value is a string specifying the path to the script file on disk,
represented with forward slashes. If the file is inside the top-level
source directory then the path is specified relative to that directory.
Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> or other command invocation that added this
installer is available. The value is an unsigned integer 0-based
index into the <code class="docutils literal notranslate">backtraceGraph</code> member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">backtraceGraph</code></dt><dd>A <a class="reference internal" href="#codemodel-version-2-backtrace-graph">&quot;codemodel&quot; version 2 &quot;backtrace graph&quot;</a> whose nodes are referenced
from <code class="docutils literal notranslate">backtrace</code> members elsewhere in this &quot;directory&quot; object.
</dd>
</dl>
</section>
<section id="codemodel-version-2-target-object">
<h4><a class="toc-backref" href="#id14" role="doc-backlink">&quot;codemodel&quot; version 2 &quot;target&quot; object</a><a class="headerlink" href="#codemodel-version-2-target-object" title="Permalink to this heading">¶</a></h4>
A codemodel &quot;target&quot; object is referenced by a <a class="reference internal" href="#codemodel-version-2">&quot;codemodel&quot; version 2</a>
object's <code class="docutils literal notranslate">targets</code> array. Each &quot;target&quot; object is a JSON object
with members:
<dl>
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the logical name of the target.
</dd>
<dt><code class="docutils literal notranslate">id</code></dt><dd>A string uniquely identifying the target. The format is unspecified
and should not be interpreted by clients.
</dd>
<dt><code class="docutils literal notranslate">type</code></dt><dd>A string specifying the type of the target. The value is one of
<code class="docutils literal notranslate">EXECUTABLE</code>, <code class="docutils literal notranslate">STATIC_LIBRARY</code>, <code class="docutils literal notranslate">SHARED_LIBRARY</code>,
<code class="docutils literal notranslate">MODULE_LIBRARY</code>, <code class="docutils literal notranslate">OBJECT_LIBRARY</code>, <code class="docutils literal notranslate">INTERFACE_LIBRARY</code>,
or <code class="docutils literal notranslate">UTILITY</code>.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the command in the source code that created the target is available.
The value is an unsigned integer 0-based index into the
<code class="docutils literal notranslate">backtraceGraph</code> member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
<dt><code class="docutils literal notranslate">folder</code></dt><dd>Optional member that is present when the <a class="reference internal" href="../prop_tgt/FOLDER.html#prop_tgt:FOLDER" title="FOLDER"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">FOLDER</code></a> target
property is set. The value is a JSON object with one member:
<dl class="simple">
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name of the target folder.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">paths</code></dt><dd>A JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">source</code></dt><dd>A string specifying the path to the target's source directory,
represented with forward slashes. If the directory is inside the
top-level source directory then the path is specified relative to
that directory (with <code class="docutils literal notranslate">.</code> for the top-level source directory itself).
Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">build</code></dt><dd>A string specifying the path to the target's build directory,
represented with forward slashes. If the directory is inside the
top-level build directory then the path is specified relative to
that directory (with <code class="docutils literal notranslate">.</code> for the top-level build directory itself).
Otherwise the path is absolute.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">nameOnDisk</code></dt><dd>Optional member that is present for executable and library targets
that are linked or archived into a single primary artifact.
The value is a string specifying the file name of that artifact on disk.
</dd>
<dt><code class="docutils literal notranslate">artifacts</code></dt><dd>Optional member that is present for executable and library targets
that produce artifacts on disk meant for consumption by dependents.
The value is a JSON array of entries corresponding to the artifacts.
Each entry is a JSON object containing one member:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the path to the file on disk, represented with
forward slashes. If the file is inside the top-level build directory
then the path is specified relative to that directory.
Otherwise the path is absolute.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">isGeneratorProvided</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code> if the
target is provided by CMake's build system generator rather than by
a command in the source code.
</dd>
<dt><code class="docutils literal notranslate">install</code></dt><dd>Optional member that is present when the target has an <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a>
rule. The value is a JSON object with members:
<dl>
<dt><code class="docutils literal notranslate">prefix</code></dt><dd>A JSON object specifying the installation prefix. It has one member:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the value of <a class="reference internal" href="../variable/CMAKE_INSTALL_PREFIX.html#variable:CMAKE_INSTALL_PREFIX" title="CMAKE_INSTALL_PREFIX"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_INSTALL_PREFIX</code></a>.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">destinations</code></dt><dd>A JSON array of entries specifying an install destination path.
Each entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the install destination path. The path may
be absolute or relative to the install prefix.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <a class="reference internal" href="../command/install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> command invocation that specified this
destination is available. The value is an unsigned integer 0-based
index into the <code class="docutils literal notranslate">backtraceGraph</code> member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">link</code></dt><dd>Optional member that is present for executables and shared library
targets that link into a runtime binary. The value is a JSON object
with members describing the link step:
<dl>
<dt><code class="docutils literal notranslate">language</code></dt><dd>A string specifying the language (e.g. <code class="docutils literal notranslate">C</code>, <code class="docutils literal notranslate">CXX</code>, <code class="docutils literal notranslate">Fortran</code>)
of the toolchain is used to invoke the linker.
</dd>
<dt><code class="docutils literal notranslate">commandFragments</code></dt><dd>Optional member that is present when fragments of the link command
line invocation are available. The value is a JSON array of entries
specifying ordered fragments. Each entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">fragment</code></dt><dd>A string specifying a fragment of the link command line invocation.
The value is encoded in the build system's native shell format.
</dd>
<dt><code class="docutils literal notranslate">role</code></dt><dd>A string specifying the role of the fragment's content:
<ul class="simple">
<li><code class="docutils literal notranslate">flags</code>: link flags.</li>
<li><code class="docutils literal notranslate">libraries</code>: link library file paths or flags.</li>
<li><code class="docutils literal notranslate">libraryPath</code>: library search path flags.</li>
<li><code class="docutils literal notranslate">frameworkPath</code>: macOS framework search path flags.</li>
</ul>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">lto</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code>
when link-time optimization (a.k.a. interprocedural optimization
or link-time code generation) is enabled.
</dd>
<dt><code class="docutils literal notranslate">sysroot</code></dt><dd>Optional member that is present when the <a class="reference internal" href="../variable/CMAKE_SYSROOT_LINK.html#variable:CMAKE_SYSROOT_LINK" title="CMAKE_SYSROOT_LINK"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSROOT_LINK</code></a>
or <a class="reference internal" href="../variable/CMAKE_SYSROOT.html#variable:CMAKE_SYSROOT" title="CMAKE_SYSROOT"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSROOT</code></a> variable is defined. The value is a
JSON object with one member:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the absolute path to the sysroot, represented
with forward slashes.
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">archive</code></dt><dd>Optional member that is present for static library targets. The value
is a JSON object with members describing the archive step:
<dl>
<dt><code class="docutils literal notranslate">commandFragments</code></dt><dd>Optional member that is present when fragments of the archiver command
line invocation are available. The value is a JSON array of entries
specifying the fragments. Each entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">fragment</code></dt><dd>A string specifying a fragment of the archiver command line invocation.
The value is encoded in the build system's native shell format.
</dd>
<dt><code class="docutils literal notranslate">role</code></dt><dd>A string specifying the role of the fragment's content:
<ul class="simple">
<li><code class="docutils literal notranslate">flags</code>: archiver flags.</li>
</ul>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">lto</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code>
when link-time optimization (a.k.a. interprocedural optimization
or link-time code generation) is enabled.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">dependencies</code></dt><dd>Optional member that is present when the target depends on other targets.
The value is a JSON array of entries corresponding to the dependencies.
Each entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">id</code></dt><dd>A string uniquely identifying the target on which this target depends.
This matches the main <code class="docutils literal notranslate">id</code> member of the other target.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <a class="reference internal" href="../command/add_dependencies.html#command:add_dependencies" title="add_dependencies"><code class="xref cmake cmake-command docutils literal notranslate">add_dependencies()</code></a>, <a class="reference internal" href="../command/target_link_libraries.html#command:target_link_libraries" title="target_link_libraries"><code class="xref cmake cmake-command docutils literal notranslate">target_link_libraries()</code></a>,
or other command invocation that created this dependency is
available. The value is an unsigned integer 0-based index into
the <code class="docutils literal notranslate">backtraceGraph</code> member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">fileSets</code></dt><dd>A JSON array of entries corresponding to the target's file sets. Each entry
is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name of the file set.
</dd>
<dt><code class="docutils literal notranslate">type</code></dt><dd>A string specifying the type of the file set. See
<a class="reference internal" href="../command/target_sources.html#command:target_sources" title="target_sources"><code class="xref cmake cmake-command docutils literal notranslate">target_sources()</code></a> supported file set types.
</dd>
<dt><code class="docutils literal notranslate">visibility</code></dt><dd>A string specifying the visibility of the file set; one of <code class="docutils literal notranslate">PUBLIC</code>,
<code class="docutils literal notranslate">PRIVATE</code>, or <code class="docutils literal notranslate">INTERFACE</code>.
</dd>
<dt><code class="docutils literal notranslate">baseDirectories</code></dt><dd>A JSON array of strings specifying the base directories containing sources
in the file set.
</dd>
</dl>
This field was added in codemodel version 2.5.
</dd>
<dt><code class="docutils literal notranslate">sources</code></dt><dd>A JSON array of entries corresponding to the target's source files.
Each entry is a JSON object with members:
<dl>
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the path to the source file on disk, represented
with forward slashes. If the file is inside the top-level source
directory then the path is specified relative to that directory.
Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">compileGroupIndex</code></dt><dd>Optional member that is present when the source is compiled.
The value is an unsigned integer 0-based index into the
<code class="docutils literal notranslate">compileGroups</code> array.
</dd>
<dt><code class="docutils literal notranslate">sourceGroupIndex</code></dt><dd>Optional member that is present when the source is part of a source
group either via the <a class="reference internal" href="../command/source_group.html#command:source_group" title="source_group"><code class="xref cmake cmake-command docutils literal notranslate">source_group()</code></a> command or by default.
The value is an unsigned integer 0-based index into the
<code class="docutils literal notranslate">sourceGroups</code> array.
</dd>
<dt><code class="docutils literal notranslate">isGenerated</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code> if
the source is <a class="reference internal" href="../prop_sf/GENERATED.html#prop_sf:GENERATED" title="GENERATED"><code class="xref cmake cmake-prop_sf docutils literal notranslate">GENERATED</code></a>.
</dd>
<dt><code class="docutils literal notranslate">fileSetIndex</code></dt><dd>Optional member that is present when the source is part of a file set.
The value is an unsigned integer 0-based index into the <code class="docutils literal notranslate">fileSets</code>
array.
This field was added in codemodel version 2.5.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <a class="reference internal" href="../command/target_sources.html#command:target_sources" title="target_sources"><code class="xref cmake cmake-command docutils literal notranslate">target_sources()</code></a>, <a class="reference internal" href="../command/add_executable.html#command:add_executable" title="add_executable"><code class="xref cmake cmake-command docutils literal notranslate">add_executable()</code></a>,
<a class="reference internal" href="../command/add_library.html#command:add_library" title="add_library"><code class="xref cmake cmake-command docutils literal notranslate">add_library()</code></a>, <a class="reference internal" href="../command/add_custom_target.html#command:add_custom_target" title="add_custom_target"><code class="xref cmake cmake-command docutils literal notranslate">add_custom_target()</code></a>, or other
command invocation that added this source to the target is
available. The value is an unsigned integer 0-based index into
the <code class="docutils literal notranslate">backtraceGraph</code> member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">sourceGroups</code></dt><dd>Optional member that is present when sources are grouped together by
the <a class="reference internal" href="../command/source_group.html#command:source_group" title="source_group"><code class="xref cmake cmake-command docutils literal notranslate">source_group()</code></a> command or by default. The value is a
JSON array of entries corresponding to the groups. Each entry is
a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name of the source group.
</dd>
<dt><code class="docutils literal notranslate">sourceIndexes</code></dt><dd>A JSON array listing the sources belonging to the group.
Each entry is an unsigned integer 0-based index into the
main <code class="docutils literal notranslate">sources</code> array for the target.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">compileGroups</code></dt><dd>Optional member that is present when the target has sources that compile.
The value is a JSON array of entries corresponding to groups of sources
that all compile with the same settings. Each entry is a JSON object
with members:
<dl>
<dt><code class="docutils literal notranslate">sourceIndexes</code></dt><dd>A JSON array listing the sources belonging to the group.
Each entry is an unsigned integer 0-based index into the
main <code class="docutils literal notranslate">sources</code> array for the target.
</dd>
<dt><code class="docutils literal notranslate">language</code></dt><dd>A string specifying the language (e.g. <code class="docutils literal notranslate">C</code>, <code class="docutils literal notranslate">CXX</code>, <code class="docutils literal notranslate">Fortran</code>)
of the toolchain is used to compile the source file.
</dd>
<dt><code class="docutils literal notranslate">languageStandard</code></dt><dd>Optional member that is present when the language standard is set
explicitly (e.g. via <a class="reference internal" href="../prop_tgt/CXX_STANDARD.html#prop_tgt:CXX_STANDARD" title="CXX_STANDARD"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">CXX_STANDARD</code></a>) or implicitly by
compile features. Each entry is a JSON object with two members:
<dl class="simple">
<dt><code class="docutils literal notranslate">backtraces</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <code class="docutils literal notranslate">&lt;LANG&gt;_STANDARD</code> setting is available. If the language
standard was set implicitly by compile features those are used as
the backtrace(s). It's possible for multiple compile features to
require the same language standard so there could be multiple
backtraces. The value is a JSON array with each entry being an
unsigned integer 0-based index into the <code class="docutils literal notranslate">backtraceGraph</code>
member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
<dt><code class="docutils literal notranslate">standard</code></dt><dd>String representing the language standard.
</dd>
</dl>
This field was added in codemodel version 2.2.
</dd>
<dt><code class="docutils literal notranslate">compileCommandFragments</code></dt><dd>Optional member that is present when fragments of the compiler command
line invocation are available. The value is a JSON array of entries
specifying ordered fragments. Each entry is a JSON object with
one member:
<dl class="simple">
<dt><code class="docutils literal notranslate">fragment</code></dt><dd>A string specifying a fragment of the compile command line invocation.
The value is encoded in the build system's native shell format.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">includes</code></dt><dd>Optional member that is present when there are include directories.
The value is a JSON array with an entry for each directory. Each
entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the path to the include directory,
represented with forward slashes.
</dd>
<dt><code class="docutils literal notranslate">isSystem</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code> if
the include directory is marked as a system include directory.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <a class="reference internal" href="../command/target_include_directories.html#command:target_include_directories" title="target_include_directories"><code class="xref cmake cmake-command docutils literal notranslate">target_include_directories()</code></a> or other command invocation
that added this include directory is available. The value is
an unsigned integer 0-based index into the <code class="docutils literal notranslate">backtraceGraph</code>
member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">precompileHeaders</code></dt><dd>Optional member that is present when <a class="reference internal" href="../command/target_precompile_headers.html#command:target_precompile_headers" title="target_precompile_headers"><code class="xref cmake cmake-command docutils literal notranslate">target_precompile_headers()</code></a>
or other command invocations set <a class="reference internal" href="../prop_tgt/PRECOMPILE_HEADERS.html#prop_tgt:PRECOMPILE_HEADERS" title="PRECOMPILE_HEADERS"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">PRECOMPILE_HEADERS</code></a> on the
target. The value is a JSON array with an entry for each header. Each
entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">header</code></dt><dd>Full path to the precompile header file.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <a class="reference internal" href="../command/target_precompile_headers.html#command:target_precompile_headers" title="target_precompile_headers"><code class="xref cmake cmake-command docutils literal notranslate">target_precompile_headers()</code></a> or other command invocation
that added this precompiled header is available. The value is an
unsigned integer 0-based index into the <code class="docutils literal notranslate">backtraceGraph</code> member's
<code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
This field was added in codemodel version 2.1.
</dd>
<dt><code class="docutils literal notranslate">defines</code></dt><dd>Optional member that is present when there are preprocessor definitions.
The value is a JSON array with an entry for each definition. Each
entry is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">define</code></dt><dd>A string specifying the preprocessor definition in the format
<code class="docutils literal notranslate">&lt;name&gt;[=&lt;value&gt;]</code>, e.g. <code class="docutils literal notranslate">DEF</code> or <code class="docutils literal notranslate">DEF=1</code>.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Optional member that is present when a CMake language backtrace to
the <a class="reference internal" href="../command/target_compile_definitions.html#command:target_compile_definitions" title="target_compile_definitions"><code class="xref cmake cmake-command docutils literal notranslate">target_compile_definitions()</code></a> or other command invocation
that added this preprocessor definition is available. The value is
an unsigned integer 0-based index into the <code class="docutils literal notranslate">backtraceGraph</code>
member's <code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">sysroot</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_SYSROOT_COMPILE.html#variable:CMAKE_SYSROOT_COMPILE" title="CMAKE_SYSROOT_COMPILE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSROOT_COMPILE</code></a> or <a class="reference internal" href="../variable/CMAKE_SYSROOT.html#variable:CMAKE_SYSROOT" title="CMAKE_SYSROOT"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSROOT</code></a>
variable is defined. The value is a JSON object with one member:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the absolute path to the sysroot, represented
with forward slashes.
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">backtraceGraph</code></dt><dd>A <a class="reference internal" href="#codemodel-version-2-backtrace-graph">&quot;codemodel&quot; version 2 &quot;backtrace graph&quot;</a> whose nodes are referenced
from <code class="docutils literal notranslate">backtrace</code> members elsewhere in this &quot;target&quot; object.
</dd>
</dl>
</section>
<section id="codemodel-version-2-backtrace-graph">
<h4><a class="toc-backref" href="#id15" role="doc-backlink">&quot;codemodel&quot; version 2 &quot;backtrace graph&quot;</a><a class="headerlink" href="#codemodel-version-2-backtrace-graph" title="Permalink to this heading">¶</a></h4>
The <code class="docutils literal notranslate">backtraceGraph</code> member of a <a class="reference internal" href="#codemodel-version-2-directory-object">&quot;codemodel&quot; version 2 &quot;directory&quot; object</a>,
or <a class="reference internal" href="#codemodel-version-2-target-object">&quot;codemodel&quot; version 2 &quot;target&quot; object</a> is a JSON object describing a
graph of backtraces. Its nodes are referenced from <code class="docutils literal notranslate">backtrace</code> members
elsewhere in the containing object. The backtrace graph object members are:
<dl>
<dt><code class="docutils literal notranslate">nodes</code></dt><dd>A JSON array listing nodes in the backtrace graph. Each entry
is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">file</code></dt><dd>An unsigned integer 0-based index into the backtrace <code class="docutils literal notranslate">files</code> array.
</dd>
<dt><code class="docutils literal notranslate">line</code></dt><dd>An optional member present when the node represents a line within
the file. The value is an unsigned integer 1-based line number.
</dd>
<dt><code class="docutils literal notranslate">command</code></dt><dd>An optional member present when the node represents a command
invocation within the file. The value is an unsigned integer
0-based index into the backtrace <code class="docutils literal notranslate">commands</code> array.
</dd>
<dt><code class="docutils literal notranslate">parent</code></dt><dd>An optional member present when the node is not the bottom of
the call stack. The value is an unsigned integer 0-based index
of another entry in the backtrace <code class="docutils literal notranslate">nodes</code> array.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">commands</code></dt><dd>A JSON array listing command names referenced by backtrace nodes.
Each entry is a string specifying a command name.
</dd>
<dt><code class="docutils literal notranslate">files</code></dt><dd>A JSON array listing CMake language files referenced by backtrace nodes.
Each entry is a string specifying the path to a file, represented
with forward slashes. If the file is inside the top-level source
directory then the path is specified relative to that directory.
Otherwise the path is absolute.
</dd>
</dl>
</section>
</section>
<section id="object-kind-configurelog">
<h3><a class="toc-backref" href="#id16" role="doc-backlink">Object Kind &quot;configureLog&quot;</a><a class="headerlink" href="#object-kind-configurelog" title="Permalink to this heading">¶</a></h3>
The <code class="docutils literal notranslate">configureLog</code> object kind describes the location and contents of
a <a class="reference internal" href="cmake-configure-log.7.html#manual:cmake-configure-log(7)" title="cmake-configure-log(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-configure-log(7)</code></a> file.
There is only one <code class="docutils literal notranslate">configureLog</code> object major version, version 1.
<section id="configurelog-version-1">
<h4><a class="toc-backref" href="#id17" role="doc-backlink">&quot;configureLog&quot; version 1</a><a class="headerlink" href="#configurelog-version-1" title="Permalink to this heading">¶</a></h4>
<code class="docutils literal notranslate">configureLog</code> object version 1 is a JSON object:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;kind&quot;: &quot;configureLog&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;path&quot;: &quot;/path/to/top-level-build-dir/CMakeFiles/CMakeConfigureLog.yaml&quot;,
 &quot;eventKindNames&quot;: [ &quot;try_compile-v1&quot;, &quot;try_run-v1&quot; ]
}
</pre></div>
</div>
The members specific to <code class="docutils literal notranslate">configureLog</code> objects are:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the path to the configure log file.
Clients must read the log file from this path, which may be
different than the path documented by <a class="reference internal" href="cmake-configure-log.7.html#manual:cmake-configure-log(7)" title="cmake-configure-log(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-configure-log(7)</code></a>.
The log file may not exist if no events are logged.
</dd>
<dt><code class="docutils literal notranslate">eventKindNames</code></dt><dd>A JSON array whose entries are each a JSON string naming one
of the <a class="reference internal" href="cmake-configure-log.7.html#manual:cmake-configure-log(7)" title="cmake-configure-log(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-configure-log(7)</code></a> versioned event kinds.
At most one version of each configure log event kind will be listed.
Although the configure log may contain other (versioned) event kinds,
clients must ignore those that are not listed in this field.
</dd>
</dl>
</section>
</section>
<section id="object-kind-cache">
<h3><a class="toc-backref" href="#id18" role="doc-backlink">Object Kind &quot;cache&quot;</a><a class="headerlink" href="#object-kind-cache" title="Permalink to this heading">¶</a></h3>
The <code class="docutils literal notranslate">cache</code> object kind lists cache entries. These are the
<a class="reference internal" href="cmake-language.7.html#cmake-language-variables">Variables</a> stored in the persistent cache
(<code class="docutils literal notranslate">CMakeCache.txt</code>) for the build tree.
There is only one <code class="docutils literal notranslate">cache</code> object major version, version 2.
Version 1 does not exist to avoid confusion with that from
<a class="reference internal" href="cmake-server.7.html#manual:cmake-server(7)" title="cmake-server(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-server(7)</code></a> mode.
<section id="cache-version-2">
<h4><a class="toc-backref" href="#id19" role="doc-backlink">&quot;cache&quot; version 2</a><a class="headerlink" href="#cache-version-2" title="Permalink to this heading">¶</a></h4>
<code class="docutils literal notranslate">cache</code> object version 2 is a JSON object:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;kind&quot;: &quot;cache&quot;,
 &quot;version&quot;: { &quot;major&quot;: 2, &quot;minor&quot;: 0 },
 &quot;entries&quot;: [
 {
 &quot;name&quot;: &quot;BUILD_SHARED_LIBS&quot;,
 &quot;value&quot;: &quot;ON&quot;,
 &quot;type&quot;: &quot;BOOL&quot;,
 &quot;properties&quot;: [
 {
 &quot;name&quot;: &quot;HELPSTRING&quot;,
 &quot;value&quot;: &quot;Build shared libraries&quot;
 }
 ]
 },
 {
 &quot;name&quot;: &quot;CMAKE_GENERATOR&quot;,
 &quot;value&quot;: &quot;Unix Makefiles&quot;,
 &quot;type&quot;: &quot;INTERNAL&quot;,
 &quot;properties&quot;: [
 {
 &quot;name&quot;: &quot;HELPSTRING&quot;,
 &quot;value&quot;: &quot;Name of generator.&quot;
 }
 ]
 }
 ]
}
</pre></div>
</div>
The members specific to <code class="docutils literal notranslate">cache</code> objects are:
<dl>
<dt><code class="docutils literal notranslate">entries</code></dt><dd>A JSON array whose entries are each a JSON object specifying a
cache entry. The members of each entry are:
<dl>
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name of the entry.
</dd>
<dt><code class="docutils literal notranslate">value</code></dt><dd>A string specifying the value of the entry.
</dd>
<dt><code class="docutils literal notranslate">type</code></dt><dd>A string specifying the type of the entry used by
<a class="reference internal" href="cmake-gui.1.html#manual:cmake-gui(1)" title="cmake-gui(1)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-gui(1)</code></a> to choose a widget for editing.
</dd>
<dt><code class="docutils literal notranslate">properties</code></dt><dd>A JSON array of entries specifying associated
<a class="reference internal" href="cmake-properties.7.html#cache-entry-properties">cache entry properties</a>.
Each entry is a JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string specifying the name of the cache entry property.
</dd>
<dt><code class="docutils literal notranslate">value</code></dt><dd>A string specifying the value of the cache entry property.
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
</section>
<section id="object-kind-cmakefiles">
<h3><a class="toc-backref" href="#id20" role="doc-backlink">Object Kind &quot;cmakeFiles&quot;</a><a class="headerlink" href="#object-kind-cmakefiles" title="Permalink to this heading">¶</a></h3>
The <code class="docutils literal notranslate">cmakeFiles</code> object kind lists files used by CMake while
configuring and generating the build system. These include the
<code class="docutils literal notranslate">CMakeLists.txt</code> files as well as included <code class="docutils literal notranslate">.cmake</code> files.
There is only one <code class="docutils literal notranslate">cmakeFiles</code> object major version, version 1.
<section id="cmakefiles-version-1">
<h4><a class="toc-backref" href="#id21" role="doc-backlink">&quot;cmakeFiles&quot; version 1</a><a class="headerlink" href="#cmakefiles-version-1" title="Permalink to this heading">¶</a></h4>
<code class="docutils literal notranslate">cmakeFiles</code> object version 1 is a JSON object:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;kind&quot;: &quot;cmakeFiles&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;paths&quot;: {
 &quot;build&quot;: &quot;/path/to/top-level-build-dir&quot;,
 &quot;source&quot;: &quot;/path/to/top-level-source-dir&quot;
 },
 &quot;inputs&quot;: [
 {
 &quot;path&quot;: &quot;CMakeLists.txt&quot;
 },
 {
 &quot;isGenerated&quot;: true,
 &quot;path&quot;: &quot;/path/to/top-level-build-dir/.../CMakeSystem.cmake&quot;
 },
 {
 &quot;isExternal&quot;: true,
 &quot;path&quot;: &quot;/path/to/external/third-party/module.cmake&quot;
 },
 {
 &quot;isCMake&quot;: true,
 &quot;isExternal&quot;: true,
 &quot;path&quot;: &quot;/path/to/cmake/Modules/CMakeGenericSystem.cmake&quot;
 }
 ]
}
</pre></div>
</div>
The members specific to <code class="docutils literal notranslate">cmakeFiles</code> objects are:
<dl>
<dt><code class="docutils literal notranslate">paths</code></dt><dd>A JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">source</code></dt><dd>A string specifying the absolute path to the top-level source directory,
represented with forward slashes.
</dd>
<dt><code class="docutils literal notranslate">build</code></dt><dd>A string specifying the absolute path to the top-level build directory,
represented with forward slashes.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">inputs</code></dt><dd>A JSON array whose entries are each a JSON object specifying an input
file used by CMake when configuring and generating the build system.
The members of each entry are:
<dl class="simple">
<dt><code class="docutils literal notranslate">path</code></dt><dd>A string specifying the path to an input file to CMake, represented
with forward slashes. If the file is inside the top-level source
directory then the path is specified relative to that directory.
Otherwise the path is absolute.
</dd>
<dt><code class="docutils literal notranslate">isGenerated</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code>
if the path specifies a file that is under the top-level
build directory and the build is out-of-source.
This member is not available on in-source builds.
</dd>
<dt><code class="docutils literal notranslate">isExternal</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code>
if the path specifies a file that is not under the top-level
source or build directories.
</dd>
<dt><code class="docutils literal notranslate">isCMake</code></dt><dd>Optional member that is present with boolean value <code class="docutils literal notranslate">true</code>
if the path specifies a file in the CMake installation.
</dd>
</dl>
</dd>
</dl>
</section>
</section>
<section id="object-kind-toolchains">
<h3><a class="toc-backref" href="#id22" role="doc-backlink">Object Kind &quot;toolchains&quot;</a><a class="headerlink" href="#object-kind-toolchains" title="Permalink to this heading">¶</a></h3>
The <code class="docutils literal notranslate">toolchains</code> object kind lists properties of the toolchains used during
the build. These include the language, compiler path, ID, and version.
There is only one <code class="docutils literal notranslate">toolchains</code> object major version, version 1.
<section id="toolchains-version-1">
<h4><a class="toc-backref" href="#id23" role="doc-backlink">&quot;toolchains&quot; version 1</a><a class="headerlink" href="#toolchains-version-1" title="Permalink to this heading">¶</a></h4>
<code class="docutils literal notranslate">toolchains</code> object version 1 is a JSON object:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;kind&quot;: &quot;toolchains&quot;,
 &quot;version&quot;: { &quot;major&quot;: 1, &quot;minor&quot;: 0 },
 &quot;toolchains&quot;: [
 {
 &quot;language&quot;: &quot;C&quot;,
 &quot;compiler&quot;: {
 &quot;path&quot;: &quot;/usr/bin/cc&quot;,
 &quot;id&quot;: &quot;GNU&quot;,
 &quot;version&quot;: &quot;9.3.0&quot;,
 &quot;implicit&quot;: {
 &quot;includeDirectories&quot;: [
 &quot;/usr/lib/gcc/x86_64-linux-gnu/9/include&quot;,
 &quot;/usr/local/include&quot;,
 &quot;/usr/include/x86_64-linux-gnu&quot;,
 &quot;/usr/include&quot;
 ],
 &quot;linkDirectories&quot;: [
 &quot;/usr/lib/gcc/x86_64-linux-gnu/9&quot;,
 &quot;/usr/lib/x86_64-linux-gnu&quot;,
 &quot;/usr/lib&quot;,
 &quot;/lib/x86_64-linux-gnu&quot;,
 &quot;/lib&quot;
 ],
 &quot;linkFrameworkDirectories&quot;: [],
 &quot;linkLibraries&quot;: [ &quot;gcc&quot;, &quot;gcc_s&quot;, &quot;c&quot;, &quot;gcc&quot;, &quot;gcc_s&quot; ]
 }
 },
 &quot;sourceFileExtensions&quot;: [ &quot;c&quot;, &quot;m&quot; ]
 },
 {
 &quot;language&quot;: &quot;CXX&quot;,
 &quot;compiler&quot;: {
 &quot;path&quot;: &quot;/usr/bin/c++&quot;,
 &quot;id&quot;: &quot;GNU&quot;,
 &quot;version&quot;: &quot;9.3.0&quot;,
 &quot;implicit&quot;: {
 &quot;includeDirectories&quot;: [
 &quot;/usr/include/c++/9&quot;,
 &quot;/usr/include/x86_64-linux-gnu/c++/9&quot;,
 &quot;/usr/include/c++/9/backward&quot;,
 &quot;/usr/lib/gcc/x86_64-linux-gnu/9/include&quot;,
 &quot;/usr/local/include&quot;,
 &quot;/usr/include/x86_64-linux-gnu&quot;,
 &quot;/usr/include&quot;
 ],
 &quot;linkDirectories&quot;: [
 &quot;/usr/lib/gcc/x86_64-linux-gnu/9&quot;,
 &quot;/usr/lib/x86_64-linux-gnu&quot;,
 &quot;/usr/lib&quot;,
 &quot;/lib/x86_64-linux-gnu&quot;,
 &quot;/lib&quot;
 ],
 &quot;linkFrameworkDirectories&quot;: [],
 &quot;linkLibraries&quot;: [
 &quot;stdc++&quot;, &quot;m&quot;, &quot;gcc_s&quot;, &quot;gcc&quot;, &quot;c&quot;, &quot;gcc_s&quot;, &quot;gcc&quot;
 ]
 }
 },
 &quot;sourceFileExtensions&quot;: [
 &quot;C&quot;, &quot;M&quot;, &quot;c++&quot;, &quot;cc&quot;, &quot;cpp&quot;, &quot;cxx&quot;, &quot;mm&quot;, &quot;CPP&quot;
 ]
 }
 ]
}
</pre></div>
</div>
The members specific to <code class="docutils literal notranslate">toolchains</code> objects are:
<dl>
<dt><code class="docutils literal notranslate">toolchains</code></dt><dd>A JSON array whose entries are each a JSON object specifying a toolchain
associated with a particular language. The members of each entry are:
<dl>
<dt><code class="docutils literal notranslate">language</code></dt><dd>A JSON string specifying the toolchain language, like C or CXX. Language
names are the same as language names that can be passed to the
<a class="reference internal" href="../command/project.html#command:project" title="project"><code class="xref cmake cmake-command docutils literal notranslate">project()</code></a> command. Because CMake only supports a single toolchain
per language, this field can be used as a key.
</dd>
<dt><code class="docutils literal notranslate">compiler</code></dt><dd>A JSON object containing members:
<dl>
<dt><code class="docutils literal notranslate">path</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_COMPILER.html#variable:CMAKE_&lt;LANG&gt;_COMPILER" title="CMAKE_&lt;LANG&gt;_COMPILER"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_COMPILER</code></a> variable is defined for the current
language. Its value is a JSON string holding the path to the compiler.
</dd>
<dt><code class="docutils literal notranslate">id</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_COMPILER_ID.html#variable:CMAKE_&lt;LANG&gt;_COMPILER_ID" title="CMAKE_&lt;LANG&gt;_COMPILER_ID"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_COMPILER_ID</code></a> variable is defined for the current
language. Its value is a JSON string holding the ID (GNU, MSVC, etc.) of
the compiler.
</dd>
<dt><code class="docutils literal notranslate">version</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_COMPILER_VERSION.html#variable:CMAKE_&lt;LANG&gt;_COMPILER_VERSION" title="CMAKE_&lt;LANG&gt;_COMPILER_VERSION"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_COMPILER_VERSION</code></a> variable is defined for the
current language. Its value is a JSON string holding the version of the
compiler.
</dd>
<dt><code class="docutils literal notranslate">target</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_COMPILER_TARGET.html#variable:CMAKE_&lt;LANG&gt;_COMPILER_TARGET" title="CMAKE_&lt;LANG&gt;_COMPILER_TARGET"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_COMPILER_TARGET</code></a> variable is defined for the
current language. Its value is a JSON string holding the cross-compiling
target of the compiler.
</dd>
<dt><code class="docutils literal notranslate">implicit</code></dt><dd>A JSON object containing members:
<dl class="simple">
<dt><code class="docutils literal notranslate">includeDirectories</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.html#variable:CMAKE_&lt;LANG&gt;_IMPLICIT_INCLUDE_DIRECTORIES" title="CMAKE_&lt;LANG&gt;_IMPLICIT_INCLUDE_DIRECTORIES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_IMPLICIT_INCLUDE_DIRECTORIES</code></a> variable is
defined for the current language. Its value is a JSON array of JSON
strings where each string holds a path to an implicit include
directory for the compiler.
</dd>
<dt><code class="docutils literal notranslate">linkDirectories</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.html#variable:CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_DIRECTORIES" title="CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_DIRECTORIES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_DIRECTORIES</code></a> variable is
defined for the current language. Its value is a JSON array of JSON
strings where each string holds a path to an implicit link directory
for the compiler.
</dd>
<dt><code class="docutils literal notranslate">linkFrameworkDirectories</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.html#variable:CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES" title="CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES</code></a> variable
is defined for the current language. Its value is a JSON array of JSON
strings where each string holds a path to an implicit link framework
directory for the compiler.
</dd>
<dt><code class="docutils literal notranslate">linkLibraries</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.html#variable:CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_LIBRARIES" title="CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_LIBRARIES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_IMPLICIT_LINK_LIBRARIES</code></a> variable is defined
for the current language. Its value is a JSON array of JSON strings
where each string holds a path to an implicit link library for the
compiler.
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">sourceFileExtensions</code></dt><dd>Optional member that is present when the
<a class="reference internal" href="../variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS.html#variable:CMAKE_&lt;LANG&gt;_SOURCE_FILE_EXTENSIONS" title="CMAKE_&lt;LANG&gt;_SOURCE_FILE_EXTENSIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_&lt;LANG&gt;_SOURCE_FILE_EXTENSIONS</code></a> variable is defined for
the current language. Its value is a JSON array of JSON strings where each
each string holds a file extension (without the leading dot) for the
language.
</dd>
</dl>
</dd>
</dl>
</section>
</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">cmake-file-api(7)</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#api-v1">API v1</a><ul>
<li><a class="reference internal" href="#v1-shared-stateless-query-files">v1 Shared Stateless Query Files</a></li>
<li><a class="reference internal" href="#v1-client-stateless-query-files">v1 Client Stateless Query Files</a></li>
<li><a class="reference internal" href="#v1-client-stateful-query-files">v1 Client Stateful Query Files</a></li>
<li><a class="reference internal" href="#v1-reply-index-file">v1 Reply Index File</a><ul>
<li><a class="reference internal" href="#v1-reply-file-reference">v1 Reply File Reference</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v1-reply-files">v1 Reply Files</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kinds">Object Kinds</a><ul>
<li><a class="reference internal" href="#object-kind-codemodel">Object Kind &quot;codemodel&quot;</a><ul>
<li><a class="reference internal" href="#codemodel-version-2">&quot;codemodel&quot; version 2</a></li>
<li><a class="reference internal" href="#codemodel-version-2-directory-object">&quot;codemodel&quot; version 2 &quot;directory&quot; object</a></li>
<li><a class="reference internal" href="#codemodel-version-2-target-object">&quot;codemodel&quot; version 2 &quot;target&quot; object</a></li>
<li><a class="reference internal" href="#codemodel-version-2-backtrace-graph">&quot;codemodel&quot; version 2 &quot;backtrace graph&quot;</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-configurelog">Object Kind &quot;configureLog&quot;</a><ul>
<li><a class="reference internal" href="#configurelog-version-1">&quot;configureLog&quot; version 1</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-cache">Object Kind &quot;cache&quot;</a><ul>
<li><a class="reference internal" href="#cache-version-2">&quot;cache&quot; version 2</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-cmakefiles">Object Kind &quot;cmakeFiles&quot;</a><ul>
<li><a class="reference internal" href="#cmakefiles-version-1">&quot;cmakeFiles&quot; version 1</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-kind-toolchains">Object Kind &quot;toolchains&quot;</a><ul>
<li><a class="reference internal" href="#toolchains-version-1">&quot;toolchains&quot; version 1</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="../envvar/CCMAKE_COLORS.html"
 title="previous chapter">CCMAKE_COLORS</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="cmake-generator-expressions.7.html"
 title="next chapter">cmake-generator-expressions(7)</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/manual/cmake-file-api.7.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="cmake-generator-expressions.7.html" title="cmake-generator-expressions(7)"
 >next</a> |</li>
 <li class="right" >
 <a href="../envvar/CCMAKE_COLORS.html" title="CCMAKE_COLORS"
 >previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-this"><a href="">cmake-file-api(7)</a></li> 
 </ul>
 </div>

<div class="footer" role="contentinfo">
 &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
 </div>
 </body>
</html>