Skip to content

Commit 98f425b

Browse files
committed
deploy: 57a26a5
1 parent f7808c3 commit 98f425b

File tree

71 files changed

+348
-174
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+348
-174
lines changed

.doctrees/arch/project_layout.doctree

-56 Bytes
Binary file not shown.
-84 Bytes
Binary file not shown.

.doctrees/arch/testing.doctree

11.9 KB
Binary file not shown.

.doctrees/environment.pickle

48.4 KB
Binary file not shown.

.doctrees/examples/gcc.doctree

12 Bytes
Binary file not shown.
-14 Bytes
Binary file not shown.

.doctrees/intro/toc.doctree

-48 Bytes
Binary file not shown.

.doctrees/user_api/generator.doctree

85.5 KB
Binary file not shown.

.doctrees/user_api/target.doctree

-1.42 KB
Binary file not shown.
-1.35 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading
Binary file not shown.

_sources/arch/project_layout.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Project Layout
3838
* third_party
3939
** CLI11
4040
** cpputest
41-
** flatbuffers
41+
** json
4242
** fmt
4343
** spdlog
4444
** taskflow
@@ -109,7 +109,7 @@ Global cmake variables and custom_targets
109109
* build_flags.cmake
110110
* test_flags.cmake
111111
* target
112-
* flatbuffers.cmake
112+
* json.cmake
113113
* fmt.cmake
114114
* spdlog.cmake
115115
* tpl.cmake
@@ -144,7 +144,7 @@ example
144144
third_party
145145
-----------
146146

147-
* Flatbuffers
147+
* JSON
148148
* Fmtlib
149149
* Spdlog
150150
* CLI11

_sources/arch/software_heirarchy.rst.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ BuildCC single lib
1111

1212
.. uml::
1313

14-
rectangle Flatbuffers as flatbuffers
14+
rectangle JSON as json
1515
rectangle fmt as fmt
1616
rectangle spdlog as spdlog
1717
rectangle Taskflow as taskflow
@@ -20,7 +20,7 @@ BuildCC single lib
2020

2121
rectangle BuildCC as buildcc
2222

23-
flatbuffers -up-> buildcc
23+
json -up-> buildcc
2424
fmt -up-> buildcc
2525
spdlog -up-> buildcc
2626
taskflow -up-> buildcc
@@ -39,7 +39,7 @@ BuildCC interface lib
3939

4040
.. uml::
4141

42-
rectangle Flatbuffers as flatbuffers #palegreen
42+
rectangle JSON as json #palegreen
4343
rectangle fmt as fmt #palegreen
4444
rectangle spdlog as spdlog #palegreen
4545
rectangle Taskflow as taskflow #palegreen
@@ -65,7 +65,7 @@ BuildCC interface lib
6565
cli11 -up-> args
6666
taskflow -up-> register
6767

68-
flatbuffers .up.> schema
68+
json .up.> schema
6969
env -up-> schema
7070

7171
schema -up-> toolchain

_sources/arch/testing.rst.txt

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,13 @@ mock_toolchain
3737
mock_target
3838
^^^^^^^^^^^^
3939

40-
.. doxygenfunction:: GeneratorRunner
40+
.. doxygenfunction:: CustomGeneratorRunner
4141

42-
.. doxygenfunction:: GeneratorExpect_InputRemoved
42+
.. doxygenfunction:: CustomGeneratorExpect_IdRemoved
4343

44-
.. doxygenfunction:: GeneratorExpect_InputAdded
44+
.. doxygenfunction:: CustomGeneratorExpect_IdAdded
4545

46-
.. doxygenfunction:: GeneratorExpect_InputUpdated
47-
48-
.. doxygenfunction:: GeneratorExpect_OutputChanged
49-
50-
.. doxygenfunction:: GeneratorExpect_CommandChanged
46+
.. doxygenfunction:: CustomGeneratorExpect_IdUpdated
5147

5248
From the :doc:`serialization_schema` **generator** we can see that our generator has 3 rebuild conditions
5349

_sources/examples/gcc.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Use BuildCC with CMake
218218
# fmt is imported by spdlog by default
219219
find_package(fmt_package NAMES "fmt" REQUIRED)
220220
find_package(spdlog_package NAMES "spdlog" REQUIRED)
221-
find_package(flatbuffers_package NAMES "flatbuffers" REQUIRED)
221+
find_package(nlohmann_json_package NAMES "nlohmann_json" REQUIRED)
222222
find_package(taskflow_package NAMES "Taskflow" "taskflow" REQUIRED)
223223
find_package(CLI11_package NAMES "CLI11" REQUIRED)
224224
find_package(tiny_process_library_package NAMES "tiny-process-library" REQUIRED)
@@ -227,7 +227,7 @@ Use BuildCC with CMake
227227
228228
message("Find package: ${fmt_package_DIR}")
229229
message("Find package: ${spdlog_package_DIR}")
230-
message("Find package: ${flatbuffers_package_DIR}")
230+
message("Find package: ${nlohmann_json_package_DIR}")
231231
message("Find package: ${taskflow_package_DIR}")
232232
message("Find package: ${CLI11_package_DIR}")
233233
message("Find package: ${tiny_process_library_package_DIR}") #

_sources/getting_started/buildexe_setup.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ For example we download the **fmt library** to our libs folder
144144
**** [git cloned]
145145
*** spdlog
146146
**** [git cloned]
147-
*** flatbuffers
147+
*** json
148148
**** [git cloned]
149149
** host
150150
*** gcc_x86_64-linux-gnu_9.3.0.toml

_sources/intro/toc.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Pre-requisites
2525
* C++17 filesystem library support
2626
* C++11 thread library support
2727
* Third Party Libraries (See License below)
28-
* Flatbuffers v2.0.0
28+
* JSON v3.11.2
2929
* Taskflow v3.1.0
3030
* CLI11 v2.1.0
3131
* Tiny Process Library v2.0.4
@@ -68,6 +68,6 @@ Licenses
6868
* `Tiny Process Library <https://gitlab.com/eidheim/tiny-process-library>`_ (Process handling) [MIT License]
6969
* `Taskflow <https://github.com/taskflow/taskflow>`_ (Parallel Programming) [MIT License] [Header Only]
7070
* See also `3rd-Party <https://github.com/taskflow/taskflow/tree/master/3rd-party>`_ used by Taskflow
71-
* `Flatbuffers <https://github.com/google/flatbuffers>`_ (Serialization) [Apache-2.0 License] [Header Only]
71+
* `Nlohmann::Json <https://github.com/nlohmann/json>`_ (Serialization) [MIT License] [Header Only]
7272
* `CLI11 <https://github.com/CLIUtils/CLI11>`_ (Argument Parsing) [BSD-3-Clause License] [Header Only]
7373
* `CppUTest <https://github.com/cpputest/cpputest>`_ (Unit Testing/Mocking) [BSD-3-Clause License]

_sources/user_api/generator.rst.txt

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
1-
Generator
2-
=========
1+
Template Generator
2+
===================
33

4-
generator.h
5-
-----------
4+
> TODO,
65

7-
.. doxygenclass:: buildcc::Generator
6+
File Generator
7+
===============
88

9-
.. doxygentypedef:: BaseGenerator
9+
> TODO
10+
11+
Custom Generator
12+
================
13+
14+
custom_generator.h
15+
-------------------
16+
17+
.. doxygenclass:: buildcc::CustomGenerator
1018

1119
Example
1220
--------
1321

22+
> TODO, Update example
23+
1424
.. code-block:: cpp
1525
:linenos:
1626

_sources/user_api/target.rst.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,6 @@ sync_api.h
3636

3737
.. doxygenclass:: buildcc::internal::SyncApi
3838

39-
target_getter.h
40-
-----------------
41-
42-
.. doxygenclass:: buildcc::internal::TargetInfoGetter
43-
4439
TargetInfo
4540
===========
4641

_sources/user_api/toolchain_utils.rst.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@ file_ext.h
88

99
.. doxygenenum:: buildcc::FileExt
1010

11-
function_lock.h
12-
-----------------
13-
14-
.. doxygenclass:: buildcc::FunctionLock
15-
1611
toolchain_config.h
1712
--------------------
1813

arch/cmake_boilerplate.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>

arch/design_patterns.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>

arch/namespaces.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>

arch/outputs.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>

arch/project_layout.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>
@@ -240,7 +242,7 @@
240242
<div class="section" id="project-layout">
241243
<h1>Project Layout<a class="headerlink" href="#project-layout" title="Permalink to this heading">#</a></h1>
242244
<p class="plantuml">
243-
<img src="../_images/plantuml-10e47c02afa512122c5fa782e6bf3ae6cc48f28d.png" alt="&#64;startmindmap
245+
<img src="../_images/plantuml-0301541550d46899ce00e184d59022fbf66c0426.png" alt="&#64;startmindmap
244246
* [root]
245247
** .clang-format
246248
** .gitmodules
@@ -275,7 +277,7 @@ <h1>Project Layout<a class="headerlink" href="#project-layout" title="Permalink
275277
* third_party
276278
** CLI11
277279
** cpputest
278-
** flatbuffers
280+
** json
279281
** fmt
280282
** spdlog
281283
** taskflow
@@ -405,7 +407,7 @@ <h2>cmake<a class="headerlink" href="#cmake" title="Permalink to this heading">#
405407
</li>
406408
<li><dl class="simple">
407409
<dt>target</dt><dd><ul>
408-
<li><p>flatbuffers.cmake</p></li>
410+
<li><p>json.cmake</p></li>
409411
<li><p>fmt.cmake</p></li>
410412
<li><p>spdlog.cmake</p></li>
411413
<li><p>tpl.cmake</p></li>
@@ -476,7 +478,7 @@ <h2>example<a class="headerlink" href="#example" title="Permalink to this headin
476478
<div class="section" id="third-party">
477479
<h2>third_party<a class="headerlink" href="#third-party" title="Permalink to this heading">#</a></h2>
478480
<ul class="simple">
479-
<li><p>Flatbuffers</p></li>
481+
<li><p>JSON</p></li>
480482
<li><p>Fmtlib</p></li>
481483
<li><p>Spdlog</p></li>
482484
<li><p>CLI11</p></li>

arch/serialization_schema.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>

arch/software_heirarchy.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>
@@ -247,7 +249,7 @@ <h2>BuildCC single lib<a class="headerlink" href="#buildcc-single-lib" title="Pe
247249
<li><p>After building the project all we need to do is <code class="docutils literal notranslate"><span class="pre">-lbuildcc</span> <span class="pre">-ltiny-process-library</span></code> or equivalent</p></li>
248250
</ul>
249251
<p class="plantuml">
250-
<img src="../_images/plantuml-0217fffc78ce874c8847e87d1a5f460f94194815.png" alt="rectangle Flatbuffers as flatbuffers
252+
<img src="../_images/plantuml-062ce616cfc91480b82e6700bd3638d725e92552.png" alt="rectangle JSON as json
251253
rectangle fmt as fmt
252254
rectangle spdlog as spdlog
253255
rectangle Taskflow as taskflow
@@ -256,7 +258,7 @@ <h2>BuildCC single lib<a class="headerlink" href="#buildcc-single-lib" title="Pe
256258
257259
rectangle BuildCC as buildcc
258260
259-
flatbuffers -up-&gt; buildcc
261+
json -up-&gt; buildcc
260262
fmt -up-&gt; buildcc
261263
spdlog -up-&gt; buildcc
262264
taskflow -up-&gt; buildcc
@@ -273,7 +275,7 @@ <h2>BuildCC interface lib<a class="headerlink" href="#buildcc-interface-lib" tit
273275
<li><p>Please see <a class="reference internal" href="testing.html"><span class="doc">Testing</span></a> for more information of how the <code class="docutils literal notranslate"><span class="pre">mock_*</span></code> equivalent of these libraries are used</p></li>
274276
</ul>
275277
<p class="plantuml">
276-
<img src="../_images/plantuml-ec70faad6a43503cdb6747457536977d7eca7583.png" alt="rectangle Flatbuffers as flatbuffers #palegreen
278+
<img src="../_images/plantuml-ae3f7ebf4d173c6318e66ad7923fce75225f7336.png" alt="rectangle JSON as json #palegreen
277279
rectangle fmt as fmt #palegreen
278280
rectangle spdlog as spdlog #palegreen
279281
rectangle Taskflow as taskflow #palegreen
@@ -299,7 +301,7 @@ <h2>BuildCC interface lib<a class="headerlink" href="#buildcc-interface-lib" tit
299301
cli11 -up-&gt; args
300302
taskflow -up-&gt; register
301303
302-
flatbuffers .up.&gt; schema
304+
json .up.&gt; schema
303305
env -up-&gt; schema
304306
305307
schema -up-&gt; toolchain

arch/style_guide.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html">Toolchain</a></li>
186186
<li class="toctree-l2"><a class="reference internal" href="../user_api/toolchain.html#specialized-toolchain">Specialized Toolchain</a></li>
187187
<li class="toctree-l2"><a class="reference internal" href="../user_api/target_utils.html">Target Utils</a></li>
188-
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Generator</a></li>
188+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html">Template Generator</a></li>
189+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#file-generator">File Generator</a></li>
190+
<li class="toctree-l2"><a class="reference internal" href="../user_api/generator.html#custom-generator">Custom Generator</a></li>
189191
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html">Target Info APIs</a></li>
190192
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#targetinfo">TargetInfo</a></li>
191193
<li class="toctree-l2"><a class="reference internal" href="../user_api/target.html#target-apis">Target APIs</a></li>

0 commit comments

Comments
 (0)