From b20080263e651f09833184ff2374ffa88896cd9f Mon Sep 17 00:00:00 2001 From: Alexheeeee Date: Fri, 6 Mar 2026 11:44:21 -0500 Subject: [PATCH 01/10] file paths --- examples/yaml_reader.cpp | 71 --------------------------------- lattice_files/ex.pals.yaml | 2 +- lattice_files/include.pals.yaml | 2 +- src/get_lattices.cpp | 10 ++--- src/yaml_c_wrapper.cpp | 6 +-- 5 files changed, 10 insertions(+), 81 deletions(-) delete mode 100644 examples/yaml_reader.cpp diff --git a/examples/yaml_reader.cpp b/examples/yaml_reader.cpp deleted file mode 100644 index 548097d..0000000 --- a/examples/yaml_reader.cpp +++ /dev/null @@ -1,71 +0,0 @@ -#include -#include "../src/yaml_c_wrapper.h" - -// If file name is provided as a command line argument, this will print out the -// expanded contents of the file to the terminal, as well as to expand.pals.yaml. -// Otherwise, it will use the example file ex.pals.yaml - -int main(int argc, char* argv[]) { - if (argc != 1) { - char* filename = argv[1]; - std::string path = "../lattice_files/"; - path += filename; - YAMLNodeHandle handle = parse_file(path.c_str()); - - lattice_expand(handle); - std::cout << "Printing out contents of file: " << filename << std::endl; - std::cout << yaml_to_string(handle) << std::endl; - write_file(handle, "../lattice_files/expand.pals.yaml"); - return 0; - } - // reading a lattice from a yaml file - YAMLNodeHandle handle = parse_file("../lattice_files/ex.pals.yaml"); - std::cout << "Printing out contents of file: " << "ex.pals.yaml" << std::endl; - // printing to terminal - std::cout << yaml_to_string(handle) << std::endl << std::endl; - - // type checking - // prints "handle is of type sequence: 1", 1 meaning true - std::cout << "handle is of type sequence: " << (is_sequence(handle)) - << "\n"; - - // accessing sequence - YAMLNodeHandle node = get_index(handle, 0); - /* prints - the first element is: - thingB: - kind: Sextupole - */ - std::cout << "the first element is: \n" << yaml_to_string(node) << "\n"; - - // accessing map - // prints "the value at key 'thingB' is: kind: Sextupole" - std::cout << "\nthe value at key 'thingB' is: " - << yaml_to_string(get_key(node, "thingB")) << "\n"; - - // creating a new node that's a map - YAMLNodeHandle map = create_map(); - set_value_int(map, "apples", 5); - - // creating a new node that's a sequence - YAMLNodeHandle sequence = create_sequence(); - push_string(sequence, "magnet1"); - push_string(sequence, ""); - YAMLNodeHandle scalar = create_scalar(); - set_scalar_string(scalar, "magnet2"); - set_at_index(sequence, 1, scalar); - // give sequence a name by putting it in a map: - YAMLNodeHandle magnets = create_map(); - set_value_node(magnets, "magnets", sequence); - - // adding new nodes to lattice - push_node(handle, map); - push_node(handle, magnets); - - // performing lattice expansion - lattice_expand(handle); - - // writing modified lattice file to expand.pals.yaml - write_file(handle, "../lattice_files/expand.pals.yaml"); - return 0; -} diff --git a/lattice_files/ex.pals.yaml b/lattice_files/ex.pals.yaml index d892512..f9fff91 100644 --- a/lattice_files/ex.pals.yaml +++ b/lattice_files/ex.pals.yaml @@ -22,7 +22,7 @@ direction: -1 - a_subline: # Item a_subline is repeated three times repeat: 3 -- include: "include.pals.yaml" +- include: "../lattice_files/include.pals.yaml" - a_subline: kind: BeamLine line: diff --git a/lattice_files/include.pals.yaml b/lattice_files/include.pals.yaml index d2af9d3..aa243f0 100644 --- a/lattice_files/include.pals.yaml +++ b/lattice_files/include.pals.yaml @@ -2,4 +2,4 @@ - first: 1 - second: 2 - third: 3 - - include: "include2.pals.yaml" + - include: "../lattice_files/include2.pals.yaml" diff --git a/src/get_lattices.cpp b/src/get_lattices.cpp index ff2d4c8..3aaa515 100644 --- a/src/get_lattices.cpp +++ b/src/get_lattices.cpp @@ -3,12 +3,12 @@ #include int main(int argc, char* argv[]) { - std::string file_name = "ex.pals.yaml"; + const char* file_name = "../lattice_files/ex.pals.yaml"; const char* lattice_name = ""; - if (argc >= 1) { - file_name = argv[0]; - } if (argc >= 2) { + file_name = argv[1]; + } + if (argc >= 3) { for (int i = 1; i < argc; i++) { if (strcmp(argv[i], "-lat") == 0) { lattice_name = argv[i+1]; @@ -16,7 +16,7 @@ int main(int argc, char* argv[]) { } } - struct lattices lat = get_lattices("ex.pals.yaml", lattice_name); + struct lattices lat = get_lattices(file_name, lattice_name); std::cout << "Printing original lattice information: " << std::endl; std::cout << yaml_to_string(lat.original) << std::endl << "\n\n"; diff --git a/src/yaml_c_wrapper.cpp b/src/yaml_c_wrapper.cpp index d5a3ca2..af22b18 100644 --- a/src/yaml_c_wrapper.cpp +++ b/src/yaml_c_wrapper.cpp @@ -113,7 +113,7 @@ void add_to_original(YAML::Node original, std::string filename) { if (!original[filename]) { YAML::Node node = YAML::Node(YAML::NodeType::Map); node["path"] = ""; - node["info"] = YAML::LoadFile("../lattice_files/" + filename); + node["info"] = YAML::LoadFile(filename); original[filename] = node; } } @@ -158,7 +158,7 @@ YAML::Node original_lattice(std::string filename) { Constructs the included lattice. */ YAML::Node included_lattice(std::string filename) { - YAML::Node included = YAML::LoadFile("../lattice_files/" + filename); + YAML::Node included = YAML::LoadFile(filename); std::vector include_files = search(included, [](YAML::Node node) { return node.IsMap() && node["include"]; }); @@ -328,7 +328,7 @@ statement will be expanded. that occurs latest in the file will be expanded. */ YAML::Node expanded_lattice(std::string filename, std::string lattice_name) { - YAML::Node root = YAML::LoadFile("../lattice_files/" + filename); + YAML::Node root = YAML::LoadFile(filename); root = included_lattice(filename); std::map* elements_map = get_dict(root); From 1aff29f56d802d0313485727c846ddc594820e26 Mon Sep 17 00:00:00 2001 From: Alexheeeee Date: Tue, 10 Mar 2026 16:50:43 -0400 Subject: [PATCH 02/10] update README, rename files --- CMakeLists.txt | 4 ++-- README.md | 22 ++++++++++++++++--- ...{example_read_write.cpp => example_rw.cpp} | 0 src/yaml_c_wrapper.cpp | 6 +++++ 4 files changed, 27 insertions(+), 5 deletions(-) rename examples/{example_read_write.cpp => example_rw.cpp} (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 524c8bc..865aac1 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -32,8 +32,8 @@ file(COPY ${CMAKE_SOURCE_DIR}/lattice_files/ add_library(yaml_c_wrapper SHARED src/yaml_c_wrapper.cpp) target_link_libraries(yaml_c_wrapper PUBLIC yaml-cpp) -add_executable(example_read_write examples/example_read_write.cpp) -target_link_libraries(example_read_write yaml_c_wrapper yaml-cpp) +add_executable(example_rw examples/example_rw.cpp) +target_link_libraries(example_rw yaml_c_wrapper yaml-cpp) add_executable(get_lattices src/get_lattices.cpp) target_link_libraries(get_lattices yaml_c_wrapper yaml-cpp) \ No newline at end of file diff --git a/README.md b/README.md index 4c9b5ee..c0ee467 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ repeat YAML::Nodes are values that act like pointers, so editing a node will cause the tree the node is contained in to reflect the changes. +Lattice files should be placed in the `lattice_files/` directory. + ## Usage In pals-cpp, run @@ -20,12 +22,26 @@ cmake --build build This builds `libyaml_c_wrapper.dylib`, a shared object library that can be used by other languages. -It also builds an executable using yaml_reader.cpp containing examples for how +It also builds an executable at build/example_rw containing examples for how to use the library to read lattice files, perform basic manipulations, and write -to other lattice files. To see the output, navigate to the build directory and run +to the lattice back to a file. To see the output, navigate to the build directory and run + +```console +./example_rw +``` +The program `get_lattices` will create a struct containing three lattices: +- `original` is a map containing the base lattice as well as any lattices included +in the base lattice. +- `included` is the base lattice but with all included files substituted in. +- `expanded` is the base lattice after lattice expansion has been performed. +Specify the lattice file with the first argument to the function. On default, +the lattice specified by the last `use` statement will be used, and if no `use` +statement exists, the lattice lattice in the file will be used. An optional flag +`-lat lattice_name` can be used to specify the lattice to expand, which has greatest +priority. For example, in the build directory, run ```console -./yaml_reader +./get_lattices ex.pals.yaml -lat lat2 ``` It will also build the tests. diff --git a/examples/example_read_write.cpp b/examples/example_rw.cpp similarity index 100% rename from examples/example_read_write.cpp rename to examples/example_rw.cpp diff --git a/src/yaml_c_wrapper.cpp b/src/yaml_c_wrapper.cpp index af22b18..fe868b9 100644 --- a/src/yaml_c_wrapper.cpp +++ b/src/yaml_c_wrapper.cpp @@ -69,6 +69,12 @@ std::vector search_kind(YAML::Node root, return search(root, condition_wrapper); } +// /* `node` should be a Lattice or Beamline. For each element in the line, +// add the map {parent, `node`.}*/ +// void add_parents(YAML::Node node) { + +// } + /* Recursively loops through the node to record all the lattices and beamlines and their corresponding parameters. From 343c3c23fdced42b0f1a6e91df5c6e7d76755516 Mon Sep 17 00:00:00 2001 From: Alexheeeee Date: Wed, 22 Apr 2026 15:06:00 -0400 Subject: [PATCH 03/10] working original and expand --- CMakeLists.txt | 19 +- README.md | 7 - examples/example_rw.cpp | 63 +-- lattice_files/ex.pals.yaml | 23 + src/get_lattices.cpp | 16 +- src/yaml_c_wrapper.cpp | 1056 +++++++++++++----------------------- src/yaml_c_wrapper.h | 151 +++--- 7 files changed, 514 insertions(+), 821 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 865aac1..1502979 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -12,28 +12,31 @@ enable_testing() include(FetchContent) FetchContent_Declare( - yaml-cpp - GIT_REPOSITORY https://github.com/jbeder/yaml-cpp.git - GIT_TAG yaml-cpp-0.9.0 + rapidyaml + GIT_REPOSITORY https://github.com/biojppm/rapidyaml.git + GIT_TAG v0.11.1 + GIT_SHALLOW FALSE ) + FetchContent_Declare( Catch2 GIT_REPOSITORY https://github.com/catchorg/Catch2.git GIT_TAG v3.5.2 ) -FetchContent_MakeAvailable(yaml-cpp) +FetchContent_MakeAvailable(rapidyaml) FetchContent_MakeAvailable(Catch2) -add_subdirectory(tests) + +# add_subdirectory(tests) file(COPY ${CMAKE_SOURCE_DIR}/lattice_files/ DESTINATION ${CMAKE_BINARY_DIR}/lattice_files/) add_library(yaml_c_wrapper SHARED src/yaml_c_wrapper.cpp) -target_link_libraries(yaml_c_wrapper PUBLIC yaml-cpp) +target_link_libraries(yaml_c_wrapper PUBLIC ryml) add_executable(example_rw examples/example_rw.cpp) -target_link_libraries(example_rw yaml_c_wrapper yaml-cpp) +target_link_libraries(example_rw yaml_c_wrapper ryml) add_executable(get_lattices src/get_lattices.cpp) -target_link_libraries(get_lattices yaml_c_wrapper yaml-cpp) \ No newline at end of file +target_link_libraries(get_lattices yaml_c_wrapper ryml) \ No newline at end of file diff --git a/README.md b/README.md index 2178e67..8868eca 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,7 @@ by other languages. It also builds an executable at build/example_rw containing examples for how to use the library to read lattice files, perform basic manipulations, and write -<<<<<<< HEAD to the lattice back to a file. To see the output, navigate to the build directory and run -======= -to other lattice files. To see the output, navigate to the directory `build` and run ->>>>>>> main The program `get_lattices` will create a struct containing three lattices: - `original` is a map containing the base lattice as well as any lattices included @@ -41,7 +37,6 @@ statement exists, the lattice lattice in the file will be used. An optional flag `-lat lattice_name` can be used to specify the lattice to expand, which has greatest priority. For example, in the build directory, run ```console -<<<<<<< HEAD ./example_rw ``` @@ -56,8 +51,6 @@ statement exists, the lattice lattice in the file will be used. An optional flag `-lat lattice_name` can be used to specify the lattice to expand, which has greatest priority. For example, in the build directory, run ```console -======= ->>>>>>> main ./get_lattices ex.pals.yaml -lat lat2 ``` diff --git a/examples/example_rw.cpp b/examples/example_rw.cpp index 9813a03..cbd6df3 100644 --- a/examples/example_rw.cpp +++ b/examples/example_rw.cpp @@ -1,57 +1,50 @@ #include #include "../src/yaml_c_wrapper.h" -#include int main(int argc, char* argv[]) { // reading a lattice from a yaml file - YAMLNodeHandle handle = parse_file("../lattice_files/ex.pals.yaml"); + YAMLTreeHandle tree = parse_file("../lattice_files/ex.pals.yaml"); std::cout << "Output of example_read_write.cpp" << std::endl; + // printing to terminal - std::cout << yaml_to_string(handle) << std::endl << std::endl; + std::cout << yaml_to_string(tree, get_root(tree)) << std::endl << std::endl; // type checking // prints "handle is of type sequence: 1", 1 meaning true - std::cout << "handle is of type sequence: " << (is_sequence(handle)) - << "\n"; + std::cout << "handle is of type sequence: " << is_sequence(tree, get_root(tree)) << "\n"; // accessing sequence - YAMLNodeHandle node = get_index(handle, 0); + YAMLNodeId node = get_child_by_index(tree, get_root(tree), 0); /* prints the first element is: thingB: kind: Sextupole */ - std::cout << "the first element is: \n" << yaml_to_string(node) << "\n"; + std::cout << "the first element is: \n" << yaml_to_string(tree, node) << "\n"; // accessing map // prints "the value at key 'thingB' is: kind: Sextupole" std::cout << "\nthe value at key 'thingB' is: " - << yaml_to_string(get_key(node, "thingB")) << "\n"; - - // creating a new node that's a map - YAMLNodeHandle map = create_map(); - set_value_int(map, "apples", 5); - - // creating a new node that's a sequence - YAMLNodeHandle sequence = create_sequence(); - push_string(sequence, "magnet1"); - push_string(sequence, ""); - YAMLNodeHandle scalar = create_scalar(); - set_scalar_string(scalar, "magnet2"); - set_at_index(sequence, 1, scalar); - // give sequence a name by putting it in a map: - YAMLNodeHandle magnets = create_map(); - set_value_node(magnets, "magnets", sequence); - - // adding new nodes to lattice - push_node(handle, map); - push_node(handle, magnets); - - // getting expanded lattice - struct lattices lat = get_lattices("ex.pals.yaml", "lat1"); - YAMLNodeHandle expanded = lat.expanded; - - // writing modified lattice file to expand.pals.yaml - write_file(handle, "../lattice_files/expand.pals.yaml"); + << yaml_to_string(tree, get_child_by_key(tree, node, "thingB")) << "\n"; + + // add a new sequence element to the root containing new_map: {apples: 5} + YAMLNodeId new_map_entry = add_map(tree, get_root(tree), NULL, END); + YAMLNodeId map = add_map(tree, new_map_entry, "new_map", END); + add_scalar(tree, map, "apples", "5", END); + + // add a new sequence element to the root containing magnets: {magnet_list: [...]} + YAMLNodeId magnets_entry = add_map(tree, get_root(tree), NULL, END); + YAMLNodeId magnets = add_map(tree, magnets_entry, "magnets", END); + YAMLNodeId sequence = add_sequence(tree, magnets, "magnet_list", END); + add_scalar(tree, sequence, NULL, "magnet1", END); + add_scalar(tree, sequence, NULL, "magnet2", 1); + + // print tree after modifications — if new nodes don't appear here the issue is in add_*, + // if they do appear but not in the file the issue is in write_file + std::cout << "\nTree after modifications:\n"; + std::cout << yaml_to_string(tree, get_root(tree)) << std::endl; + + bool ok = write_file(tree, "../lattice_files/expand.pals.yaml"); + std::cout << "write_file returned: " << ok << std::endl; return 0; -} +} \ No newline at end of file diff --git a/lattice_files/ex.pals.yaml b/lattice_files/ex.pals.yaml index f9fff91..5190156 100644 --- a/lattice_files/ex.pals.yaml +++ b/lattice_files/ex.pals.yaml @@ -1,5 +1,6 @@ - thingB: kind: Sextupole + length: 2 - lat1: kind: Lattice branches: @@ -31,3 +32,25 @@ - c - use: "lat2" - use: "lat1" + +# - lat: +# kind: Lattice +# branches: +# - inj_line + +# - inj_line: +# kind: BeamLine +# line: +# - to_dump: +# kind: Fork +# ForkP: +# to_line: generic_dump +# to_element: b_subline +# branch_name: this_dump +# propagate_reference: true + +# - generic_dump: +# kind: BeamLine +# line: +# - a_subline +# - b_subline \ No newline at end of file diff --git a/src/get_lattices.cpp b/src/get_lattices.cpp index 3aaa515..57db185 100644 --- a/src/get_lattices.cpp +++ b/src/get_lattices.cpp @@ -1,6 +1,7 @@ #include #include "../src/yaml_c_wrapper.h" -#include +#include +#include int main(int argc, char* argv[]) { const char* file_name = "../lattice_files/ex.pals.yaml"; @@ -15,16 +16,15 @@ int main(int argc, char* argv[]) { } } } - + struct lattices lat = get_lattices(file_name, lattice_name); - std::cout << "Printing original lattice information: " << std::endl; - std::cout << yaml_to_string(lat.original) << std::endl << "\n\n"; + std::cout << yaml_to_string(lat.original, get_root(lat.original)) << std::endl; - // put separating lines here - std::cout << "Printing included lattice information: " << std::endl; - std::cout << yaml_to_string(lat.included) << std::endl << "\n\n"; + // // put separating lines here + // std::cout << "Printing included lattice information: " << std::endl; + // std::cout << yaml_to_string(lat.included) << std::endl << "\n\n"; std::cout << "Printing expanded lattice information: " << std::endl; - std::cout << yaml_to_string(lat.expanded) << std::endl; + std::cout << yaml_to_string(lat.expanded, get_root(lat.expanded)) << std::endl; return 0; } \ No newline at end of file diff --git a/src/yaml_c_wrapper.cpp b/src/yaml_c_wrapper.cpp index 08456c4..16e8fb7 100644 --- a/src/yaml_c_wrapper.cpp +++ b/src/yaml_c_wrapper.cpp @@ -1,793 +1,469 @@ -#include - -#include +#include "yaml_c_wrapper.h" +#include +#include #include -#include -#include +#include +#include +#include +#include #include +#include + +// ============================================================ +// INTERNALS +// ============================================================ -#if defined(_WIN32) -#define YAML_API extern "C" __declspec(dllexport) -#else -#define YAML_API extern "C" __attribute__((visibility("default"))) -#endif - -// TODO: add absolute file paths -// for every element, add a field that points to the parent -/* -`original` is a map containing the base lattice as well as any lattices included -in the base lattice. They can be accessed using original[filename]. -`included` is the base lattice but with all included files substituted in. -`expanded` is the base lattice after lattice expansion has been performed. -*/ -struct lattices_int { - YAML::Node original; - YAML::Node included; - YAML::Node expanded; +struct ParsedData { + ryml::Tree tree; + std::string buffer; }; -template -std::vector search(YAML::Node root_node, Condition condition) { - std::vector matches; +#define GET_TREE(handle) (static_cast(handle)->tree) - if (condition(root_node)) matches.push_back(root_node); +// Shared helper: append or insert a blank child depending on index. +// Grows the node pool if needed since ryml does not auto-resize. +// index=END means append. +static size_t add_child_at(ryml::Tree& t, size_t parent, size_t index) { + if (t.size() + 1 >= t.capacity()) + t.reserve(t.capacity() + 64); - std::vector child_matches; - if (root_node.IsMap()) { - for (auto ele : root_node) { - child_matches = search(ele.second, condition); - matches.insert(matches.end(), child_matches.begin(), - child_matches.end()); - } - } else if (root_node.IsSequence()) { - for (int i = 0; i < root_node.size(); i++) { - child_matches = search(root_node[i], condition); - matches.insert(matches.end(), child_matches.begin(), - child_matches.end()); - } + if (index == END) { + return t.append_child(parent); } - return matches; + size_t num = t.num_children(parent); + if (index > num) index = num; + size_t after_id = (index > 0) ? t.child(parent, index - 1) : ryml::NONE; + return t.insert_child(parent, after_id); } -auto is_kind = [](YAML::Node node, std::string kind_type_string) { - if (node.IsMap()) { - for (auto ele : node) { - if (ele.second.IsMap() && - ele.second["kind"].as("") == kind_type_string) { - return true; - } - } +// Shared helper: optionally stamp a key onto a node. +static void maybe_set_key(ryml::Tree& t, size_t node, const char* key) { + if (key != nullptr) { + t.ref(node) |= ryml::KEY; + t.set_key(node, t.to_arena(ryml::to_csubstr(key))); } - return false; -}; - -std::vector search_kind(YAML::Node root, - std::string kind_type_string) { - auto condition_wrapper = [kind_type_string](const YAML::Node& node) { - return is_kind(node, kind_type_string); - }; - return search(root, condition_wrapper); } -// /* `node` should be a Lattice or Beamline. For each element in the line, -// add the map {parent, `node`.}*/ -// void add_parents(YAML::Node node) { - -// } - -/* -Recursively loops through the node to record all the lattices and beamlines and -their corresponding parameters. -*/ -void get_dict_helper(YAML::Node node, - std::map* element_map) { - if (node.IsSequence()) { - for (size_t i = 0; i < node.size(); i++) { - YAML::Node child = node[i]; - get_dict_helper(child, element_map); - } - } else if (node.IsMap()) { - for (auto ele : node) { - if (ele.second.IsMap() && ele.second["kind"]) { - element_map->insert({ele.first.as(), ele.second}); - } else { - get_dict_helper(ele.second, element_map); - } - } +// Recursive deep copy used by deep_copy_node and internal helpers. +static void deep_copy_recursive(ryml::Tree& dst_t, size_t dst_node, + const ryml::Tree& src_t, size_t src_node) { + ryml::NodeType safe_flags = ryml::MAP | ryml::SEQ | ryml::VAL | ryml::KEY; + dst_t.ref(dst_node) |= (src_t.type(src_node) & safe_flags); + + // Capture key/val as std::string BEFORE any append_child calls because + // append_child can reallocate the arena, dangling any csubstr views. + std::string key_str, val_str; + bool has_key = src_t.has_key(src_node); + bool has_val = src_t.has_val(src_node); + if (has_key) key_str = std::string(src_t.key(src_node).str, src_t.key(src_node).len); + if (has_val) val_str = std::string(src_t.val(src_node).str, src_t.val(src_node).len); + + // Collect child IDs before mutating the tree. + std::vector src_children; + for (size_t c = src_t.first_child(src_node); c != ryml::NONE; c = src_t.next_sibling(c)) + src_children.push_back(c); + + // Append children first (may reallocate arena). + std::vector dst_children; + for (size_t i = 0; i < src_children.size(); i++) + dst_children.push_back(dst_t.append_child(dst_node)); + + // Now safe to set key/val — arena is stable. + if (has_key) dst_t.set_key(dst_node, dst_t.to_arena(ryml::to_csubstr(key_str))); + if (has_val) dst_t.set_val(dst_node, dst_t.to_arena(ryml::to_csubstr(val_str))); + + for (size_t i = 0; i < src_children.size(); i++) + deep_copy_recursive(dst_t, dst_children[i], src_t, src_children[i]); +} + +// ============================================================ +// INTERNAL LATTICE LOGIC +// ============================================================ + +static void make_ele_map(std::map& map, + YAMLTreeHandle tree, YAMLNodeId node) { + if (node == YAML_NULL_ID) return; + if (is_scalar(tree, node)) return; + + if (is_map(tree, node)) { + YAMLNodeId params = get_child_by_index(tree, node, 0); + YAMLNodeId kind = get_child_by_key(tree, params, "kind"); + char* key = get_node_key(tree, params); + if (kind != YAML_NULL_ID && key != nullptr) + map.emplace(std::string(key), params); + yaml_free_string(key); } -} -/* -Constructs the map from names to lattice elements. The values in the map -are references to lattice elements with a given name, and modifying them -will directly modifty the lattice. Elements in values are stored in the order -that they appear in the lattice file. Use YAML::Clone if only the information -is required. -*/ -std::map* get_dict(YAML::Node root) { - std::map* element_map = - new std::map(); - get_dict_helper(root, element_map); - return element_map; -} - -/* -Adds the file contained in `filename` to `original`, which should be -lat.original. The key is the filename and the value is the contents of the file. -*/ -void add_to_original(YAML::Node original, std::string filename) { - if (!original[filename]) { - YAML::Node node = YAML::Node(YAML::NodeType::Map); - node["path"] = ""; - node["info"] = YAML::LoadFile(filename); - original[filename] = node; - } + for (size_t i = 0; i < get_size(tree, node); i++) + make_ele_map(map, tree, get_child_by_index(tree, node, i)); } -/* -Constructs the original lattice. -*/ -YAML::Node original_lattice(std::string filename) { - YAML::Node original = YAML::Node(YAML::NodeType::Map); - - std::vector files_to_process; - files_to_process.push_back(filename); +static void expand(YAMLTreeHandle tree, YAMLNodeId node, + std::map& map) { + if (node == YAML_NULL_ID) return; - auto find_includes = [](const YAML::Node& node) { - return node.IsMap() && node["include"]; - }; + if (is_scalar(tree, node)) { + char* name = as_string(tree, node); + if (name && map.count(name)) { + YAMLNodeId def = map.at(std::string(name)); + GET_TREE(tree).ref(node).clear_val(); + // Promote to map and deep-copy the definition under a keyed child. + GET_TREE(tree).ref(node) |= ryml::MAP; + size_t kv_child = GET_TREE(tree).append_child(node); + deep_copy_recursive(GET_TREE(tree), kv_child, GET_TREE(tree), def); - while (!files_to_process.empty()) { - std::string current_file = files_to_process.back(); - files_to_process.pop_back(); + // Stamp the key after the copy (arena may have moved). + GET_TREE(tree).ref(kv_child) |= ryml::KEY; + GET_TREE(tree).set_key(kv_child, + GET_TREE(tree).to_arena(ryml::to_csubstr(name))); - if (original[current_file]) { - continue; + expand(tree, node, map); } - - add_to_original(original, current_file); - YAML::Node loaded_content = original[current_file]["info"]; - std::vector includes_found = - search(loaded_content, find_includes); - for (const auto& inc_node : includes_found) { - std::string inc_fn = inc_node["include"].as(); - if (inc_fn.size() >= 5 && - inc_fn.substr(inc_fn.size() - 5) == ".yaml") { - files_to_process.push_back(inc_fn); - } - } - } - return original; -} - -/* -Constructs the included lattice. -*/ -YAML::Node included_lattice(std::string filename) { - YAML::Node included = YAML::LoadFile(filename); - std::vector include_files = - search(included, - [](YAML::Node node) { return node.IsMap() && node["include"]; }); - for (int i = 0; i < include_files.size(); i++) { - std::string inc_fn = include_files[i]["include"].as(); - if (inc_fn.size() >= 5 && inc_fn.substr(inc_fn.size() - 5) == ".yaml") { - YAML::Node node(YAML::NodeType::Sequence); - YAML::Node content = included_lattice(inc_fn); - YAML::Node file(YAML::NodeType::Map); - file["file"] = inc_fn; - - node.push_back(file); - node.push_back(content[0]); - - include_files[i].remove("include"); - include_files[i]["included"] = node; - } - } - return included; -} - -/* -Returns a new node with the elements in `line` inserted into `seq` at `index` -a `repeat` number of times. The value at index will be rewritten by the first -inserted element. For example, if seq = [1,2,3,4,5], line = [a,b], index = 2, -repeat = 3, calling the function will output [1,2,a,b,a,b,a,b,4,5]. -*/ -YAML::Node repeat(YAML::Node target_element, YAML::Node seq, int index, - int repeat_count) { - YAML::Node exp = YAML::Node(YAML::NodeType::Sequence); - for (int i = 0; i < index; i++) { - exp.push_back(YAML::Clone(seq[i])); - } - - YAML::Node inner_content = target_element; - if (inner_content.IsMap() && inner_content["line"]) { - inner_content = inner_content["line"]; - } - - for (int i = 0; i < repeat_count; i++) { - if (inner_content.IsSequence()) { - for (std::size_t j = 0; j < inner_content.size(); j++) { - exp.push_back(YAML::Clone(inner_content[j])); - } - } else { - exp.push_back(YAML::Clone(inner_content)); + yaml_free_string(name); + } else if (is_map(tree, node)) { + YAMLNodeId to_inherit = get_child_by_key(tree, node, "inherit"); + if (to_inherit != YAML_NULL_ID) { + YAMLNodeId ancestor = map.at(as_string(tree, to_inherit)); + deep_copy_children(tree, node, tree, ancestor, END); + set_node_key(tree, to_inherit, "inherited"); + expand(tree, node, map); } - } - for (std::size_t i = index + 1; i < seq.size(); i++) { - exp.push_back(YAML::Clone(seq[i])); - } - return exp; -} - -/* -Performs lattice expansion on the provided `node`. -*/ -YAML::Node expand_internal(YAML::Node node, - std::map* elements_map) { - if (node.IsScalar() && elements_map->count(node.as())) { - std::string element_name = node.as(); - YAML::Node wrapped_node = YAML::Node(YAML::NodeType::Map); - - wrapped_node[element_name] = expand_internal( - YAML::Clone(elements_map->at(element_name)), elements_map); - return wrapped_node; - } else if (node.IsSequence()) { - for (std::size_t i = 0; i < node.size(); i++) { - if (node[i].IsMap()) { - for (auto it = node[i].begin(); it != node[i].end(); ++it) { - if (it->second.IsMap() && it->second["repeat"]) { - std::string target_name = it->first.as(); - if (elements_map->count(target_name)) { - YAML::Node target_node = - YAML::Clone(elements_map->at(target_name)); - YAML::Node repeated_seq = - repeat(target_node, node, i, - it->second["repeat"].as()); - return expand_internal(repeated_seq, elements_map); + } else if (is_sequence(tree, node)) { + for (size_t i = 0; i < get_size(tree, node); i++) { + YAMLNodeId child = get_child_by_index(tree, node, i); + if (is_map(tree, child)) { + for (size_t j = 0; j < get_size(tree, child); j++) { + YAMLNodeId ele = get_child_by_index(tree, child, j); + if (ele != YAML_NULL_ID) { + YAMLNodeId repeat = get_child_by_key(tree, ele, "repeat"); + if (repeat != YAML_NULL_ID) { + char* ntimes_str = as_string(tree, repeat); + int ntimes = std::stoi(ntimes_str); + yaml_free_string(ntimes_str); // Free the string allocation + char* key_str = get_node_key(tree, ele); + remove_node(tree, node, child); + if (key_str) { + YAMLNodeId repeated_subline = map.at(key_str); + YAMLNodeId line = get_child_by_key(tree, repeated_subline, "line"); + for (int n = 0; n < ntimes; n++) { + deep_copy_children(tree, node, tree, line, i); + } + std::cout << yaml_to_string(tree, line); + } + yaml_free_string(key_str); // Free the key allocation } } } } + expand(tree, child, map); } - YAML::Node new_seq = YAML::Node(YAML::NodeType::Sequence); - for (std::size_t i = 0; i < node.size(); i++) { - new_seq.push_back(expand_internal(node[i], elements_map)); - } - return new_seq; - } else if (node.IsMap()) { - YAML::Node new_map = YAML::Clone(node); - - if (new_map["inherit"]) { - std::string parent_name = new_map["inherit"].as(); - new_map.remove("inherit"); - new_map["inherited"] = parent_name; - - if (elements_map->count(parent_name)) { - YAML::Node parent = elements_map->at(parent_name); - for (auto it = parent.begin(); it != parent.end(); ++it) { - std::string key = it->first.as(); - if (!new_map[key]) { - new_map[key] = YAML::Clone(it->second); - } - } - } - } - - // Expand all values in place using iterators - std::vector> expanded_entries; - for (auto it = new_map.begin(); it != new_map.end(); ++it) { - std::string key = it->first.as(); - YAML::Node expanded_value = expand_internal(it->second, elements_map); - expanded_entries.push_back({key, expanded_value}); - } - - // Rebuild the map with expanded values - YAML::Node final_map = YAML::Node(YAML::NodeType::Map); - for (const auto& entry : expanded_entries) { - final_map[entry.first] = entry.second; - } - - return final_map; } - return YAML::Clone(node); -} - -/* -Performs lattice expansion with the following rules: -1. If name is specified, the lattice in `root` with the given name will be -expanded. -2. If no name is specified, the lattice that appears latest in `root` will be -expanded. -*/ -void find_and_replace(std::string name, YAML::Node root, - std::map* elements_map) { - if (name != "") { - for (std::size_t i = 0; i < root.size(); i++) { - if (root[i].IsMap() && root[i][name]) { - root[i][name] = expand_internal(root[i][name], elements_map); - return; - } - } - } else { - for (int i = root.size() - 1; i >= 0; i--) { - if (root[i].IsMap() && root[i]["use"]) { - std::string target = root[i]["use"].as(); - - for (std::size_t j = 0; j < root.size(); j++) { - if (root[j].IsMap() && root[j][target]) { - root[j][target] = - expand_internal(root[j][target], elements_map); - return; - } + for (size_t i = 0; i < get_size(tree, node); i++) + expand(tree, get_child_by_index(tree, node, i), map); +} + +// static YAMLNodeId find_lattice_to_expand(YAMLTreeHandle tree, char* lat_name = "", +// std::map& map) { +// if (lat_name != "") { +// return map.at(lat_name); +// } else { + +// } +// } +static YAMLTreeHandle make_expanded(const char* filename) { + YAMLTreeHandle expanded = parse_file(filename); + if (!expanded) return nullptr; + + std::map map; + make_ele_map(map, expanded, get_root(expanded)); + ryml::Tree& t = GET_TREE(expanded); + t.reserve_arena(t.arena_capacity() + 100000); + t.reserve(t.capacity() + 10000); + + expand(expanded, get_root(expanded), map); + return expanded; +} + +static void add_to_master_tree(YAMLTreeHandle master, YAMLTreeHandle tree, + YAMLNodeId tree_node) { + if (tree_node == YAML_NULL_ID) return; + YAMLNodeId master_root = get_root(master); + if (is_scalar(tree, tree_node)) return; + + for (size_t i = 0; i < get_size(tree, tree_node); i++) { + YAMLNodeId ele = get_child_by_index(tree, tree_node, i); + add_to_master_tree(master, tree, ele); + + char* key = get_node_key(tree, ele); + if (key && strcmp(key, "include") == 0) { + char* child_filename = as_string(tree, ele); + if (child_filename) { + YAMLTreeHandle child_file = parse_file(child_filename); + if (child_file) { + YAMLNodeId child_root = get_root(child_file); + size_t dest = GET_TREE(master).append_child(master_root); + deep_copy_recursive(GET_TREE(master), dest, + GET_TREE(child_file), child_root); + set_node_key(master, dest, child_filename); + add_to_master_tree(master, child_file, child_root); + delete_tree(child_file); } + yaml_free_string(child_filename); } } - for (int i = root.size() - 1; i >= 0; i--) { - if (is_kind(root[i], "Lattice")) { - root[i] = expand_internal(root[i], elements_map); - return; - } - } + yaml_free_string(key); } } -/* -Constructs the expanded lattice. Expanding has the following priority: -1. If a lattice name is supplied through lattice_name, that lattice will be -expanded. -2. If no lattice_name is supplied, the lattice specified by the last use -statement will be expanded. -3. If no lattice_name is supplied and no use statements are present, the lattice -that occurs latest in the file will be expanded. -*/ -YAML::Node expanded_lattice(std::string filename, std::string lattice_name) { - YAML::Node root = YAML::LoadFile(filename); - root = included_lattice(filename); - std::map* elements_map = get_dict(root); - - find_and_replace(lattice_name, root, elements_map); - return root; -} - -struct lattices_int get_lattices_int(const std::string& filename, - const std::string& lattice_name = "") { - struct lattices_int lat; - lat.original = original_lattice(filename); - lat.included = included_lattice(filename); - lat.expanded = expanded_lattice(filename, lattice_name); - return lat; -} - -extern "C" { -typedef void* YAMLNodeHandle; - -struct lattices { - YAMLNodeHandle original; - YAMLNodeHandle included; - YAMLNodeHandle expanded; -}; - -YAML_API struct lattices get_lattices(const char* filename, - const char* lattice_name) { - struct lattices lat; - lat.original = static_cast( - new YAML::Node(original_lattice(std::string(filename)))); - lat.included = static_cast( - new YAML::Node(included_lattice(std::string(filename)))); - lat.expanded = static_cast(new YAML::Node( - expanded_lattice(std::string(filename), std::string(lattice_name)))); - return lat; -} - -// === CREATION/DELETION === -YAML_API YAMLNodeHandle create_node() { return new YAML::Node(); } +static YAMLTreeHandle make_original(const char* filename) { + YAMLTreeHandle master = create_empty_tree(); + YAMLTreeHandle tree = parse_file(filename); -YAML_API YAMLNodeHandle create_map() { - auto node = new YAML::Node(); - *node = YAML::Node(YAML::NodeType::Map); - return node; -} - -YAML_API YAMLNodeHandle create_sequence() { - auto node = new YAML::Node(); - *node = YAML::Node(YAML::NodeType::Sequence); - return node; -} - -YAML_API YAMLNodeHandle create_scalar() { - auto node = new YAML::Node(); - *node = YAML::Node(YAML::NodeType::Scalar); - return node; -} - -YAML_API void delete_node(YAMLNodeHandle handle) { - delete static_cast(handle); -} - -// === TYPE CHECKS === -YAML_API bool is_scalar(YAMLNodeHandle handle) { - return static_cast(handle)->IsScalar(); -} - -YAML_API bool is_sequence(YAMLNodeHandle handle) { - return static_cast(handle)->IsSequence(); -} - -YAML_API bool is_map(YAMLNodeHandle handle) { - return static_cast(handle)->IsMap(); -} - -YAML_API bool is_null(YAMLNodeHandle handle) { - return static_cast(handle)->IsNull(); -} - -// === ACCESS === -// equivalent to map[key] -YAML_API YAMLNodeHandle get_key(YAMLNodeHandle handle, const char* key) { - auto node = static_cast(handle); - auto child = (*node)[key]; - if (!child.IsDefined()) { - return nullptr; + if (tree) { + size_t dest = GET_TREE(master).append_child(get_root(master)); + deep_copy_recursive(GET_TREE(master), dest, + GET_TREE(tree), get_root(tree)); + set_node_key(master, dest, filename); + add_to_master_tree(master, tree, get_root(tree)); } - return new YAML::Node(child); + return master; } -YAML_API YAMLNodeHandle get_index(YAMLNodeHandle handle, int index) { - auto node = static_cast(handle); - if (index < 0 || index >= node->size()) { - return nullptr; - } - return new YAML::Node((*node)[index]); -} +// ============================================================ +// PUBLIC API +// ============================================================ -YAML_API bool has_key(YAMLNodeHandle handle, const char* key) { - auto node = static_cast(handle); - return (*node)[key].IsDefined(); -} +extern "C" { -YAML_API int size(YAMLNodeHandle handle) { - return static_cast(handle)->size(); +YAML_API struct lattices get_lattices(const char* filename, const char* lattice_name) { + struct lattices lat = {}; + lat.original = make_original(filename); + lat.expanded = make_expanded(filename); + return lat; } -// === PARSING === -YAML_API YAMLNodeHandle parse_string(const char* yaml_str) { - try { - return new YAML::Node(YAML::Load(yaml_str)); - } catch (...) { - return nullptr; - } -} +// --- PARSING & MEMORY --- -YAML_API YAMLNodeHandle parse_file(const char* filename) { +YAML_API YAMLTreeHandle parse_file(const char* filename) { try { - return new YAML::Node(YAML::LoadFile(filename)); - } catch (...) { - return nullptr; - } -} - -YAML_API char** get_keys(YAMLNodeHandle handle, int* out_count) { - auto node = static_cast(handle); - if (!node->IsMap()) { - *out_count = 0; - return nullptr; - } - - std::vector keys; - for (auto it = node->begin(); it != node->end(); ++it) { - keys.push_back(it->first.as()); - } + std::ifstream file(filename, std::ios::binary | std::ios::ate); + if (!file) return nullptr; - *out_count = keys.size(); - char** result = new char*[keys.size()]; - for (size_t i = 0; i < keys.size(); i++) { - result[i] = new char[keys[i].length() + 1]; - strcpy(result[i], keys[i].c_str()); - } - return result; -} + std::streamsize size = file.tellg(); + file.seekg(0, std::ios::beg); -// === CONVERT TO C TYPES (caller must free returned strings) === -YAML_API char* as_string(YAMLNodeHandle handle) { - try { - auto str = static_cast(handle)->as(); - char* result = new char[str.length() + 1]; - strcpy(result, str.c_str()); - return result; + ParsedData* data = new ParsedData(); + data->buffer.resize(size); + file.read(&data->buffer[0], size); + data->tree = ryml::parse_in_place(ryml::to_substr(data->buffer)); + return data; } catch (...) { return nullptr; } } -YAML_API int as_int(YAMLNodeHandle handle) { +YAML_API YAMLTreeHandle parse_string(const char* yaml_str) { try { - return static_cast(handle)->as(); + ParsedData* data = new ParsedData(); + data->buffer = yaml_str; + data->tree = ryml::parse_in_place(ryml::to_substr(data->buffer)); + return data; } catch (...) { - return 0; + return nullptr; } } -YAML_API double as_float(YAMLNodeHandle handle) { - try { - return static_cast(handle)->as(); - } catch (...) { - return 0.0; - } +YAML_API YAMLTreeHandle create_empty_tree() { + ParsedData* data = new ParsedData(); + data->tree.rootref() |= ryml::MAP; + return data; } -YAML_API bool as_bool(YAMLNodeHandle handle) { - try { - return static_cast(handle)->as(); - } catch (...) { - return false; - } +YAML_API void delete_tree(YAMLTreeHandle tree) { + delete static_cast(tree); } -// === MODIFICATION === -YAML_API void set_value_string(YAMLNodeHandle handle, const char* key, - const char* value) { - auto node = static_cast(handle); - (*node)[key] = value; +YAML_API void remove_node(YAMLTreeHandle tree, YAMLNodeId parent, YAMLNodeId child) { + if (parent == YAML_NULL_ID || child == YAML_NULL_ID) return; + ryml::Tree& t = GET_TREE(tree); + size_t index = t.child_pos(parent, child); + if (index != ryml::NONE) + t.ref(parent).remove_child(index); } -YAML_API void set_value_int(YAMLNodeHandle handle, const char* key, int value) { - auto node = static_cast(handle); - (*node)[key] = value; -} +// --- TRAVERSAL --- -YAML_API void set_value_float(YAMLNodeHandle handle, const char* key, - double value) { - auto node = static_cast(handle); - (*node)[key] = value; +YAML_API YAMLNodeId get_root(YAMLTreeHandle tree) { + if (!tree) return YAML_NULL_ID; + return GET_TREE(tree).root_id(); } -YAML_API void set_value_bool(YAMLNodeHandle handle, const char* key, - bool value) { - auto node = static_cast(handle); - (*node)[key] = value; +YAML_API YAMLNodeId get_parent(YAMLTreeHandle tree, YAMLNodeId node) { + ryml::Tree& t = GET_TREE(tree); + if (node == ryml::NONE || !t.has_parent(node)) return YAML_NULL_ID; + return t.parent(node); } -YAML_API void set_value_node(YAMLNodeHandle handle, const char* key, - YAMLNodeHandle value) { - auto node = static_cast(handle); - auto val_node = static_cast(value); - (*node)[key] = *val_node; +YAML_API YAMLNodeId get_child_by_key(YAMLTreeHandle tree, YAMLNodeId parent, const char* key) { + if (parent == YAML_NULL_ID) return YAML_NULL_ID; + ryml::Tree& t = GET_TREE(tree); + if (!t.is_map(parent)) return YAML_NULL_ID; + YAMLNodeId child = t.find_child(parent, ryml::to_csubstr(key)); + return (child == ryml::NONE) ? YAML_NULL_ID : child; } -YAML_API void set_scalar_string(YAMLNodeHandle handle, const char* value) { - if (handle == nullptr || value == nullptr) return; - auto node = static_cast(handle); - *node = value; +YAML_API YAMLNodeId get_child_by_index(YAMLTreeHandle tree, YAMLNodeId parent, size_t index) { + ryml::Tree& t = GET_TREE(tree); + if (!(t.is_seq(parent) || t.is_map(parent)) || index >= t.num_children(parent)) + return YAML_NULL_ID; + return t.child(parent, index); } -YAML_API void set_scalar_int(YAMLNodeHandle handle, int value) { - if (handle == nullptr) return; - auto node = static_cast(handle); - *node = value; +YAML_API size_t get_size(YAMLTreeHandle tree, YAMLNodeId node) { + if (node == YAML_NULL_ID) return 0; + return GET_TREE(tree).num_children(node); } -YAML_API void set_scalar_float(YAMLNodeHandle handle, double value) { - if (handle == nullptr) return; - auto node = static_cast(handle); - *node = value; +YAML_API char* get_node_key(YAMLTreeHandle tree, YAMLNodeId node) { + if (node == YAML_NULL_ID) return nullptr; + ryml::Tree& t = GET_TREE(tree); + if (!t.has_key(node)) return nullptr; + ryml::csubstr k = t.key(node); + char* result = new char[k.len + 1]; + memcpy(result, k.str, k.len); + result[k.len] = '\0'; + return result; } -YAML_API void set_scalar_bool(YAMLNodeHandle handle, bool value) { - if (handle == nullptr) return; - auto node = static_cast(handle); - *node = value; -} +// --- TYPE CHECKS --- -// Set node at index for sequences -YAML_API void set_at_index(YAMLNodeHandle handle, int index, - YAMLNodeHandle value) { - auto node = static_cast(handle); - auto val_node = static_cast(value); - (*node)[index] = *val_node; +YAML_API bool is_map(YAMLTreeHandle tree, YAMLNodeId node) { + if (node == YAML_NULL_ID) return false; + return GET_TREE(tree).is_map(node); } -YAML_API void push_string(YAMLNodeHandle handle, const char* value) { - auto node = static_cast(handle); - node->push_back(value); +YAML_API bool is_sequence(YAMLTreeHandle tree, YAMLNodeId node) { + if (node == YAML_NULL_ID) return false; + return GET_TREE(tree).is_seq(node); } -YAML_API void push_int(YAMLNodeHandle handle, int value) { - auto node = static_cast(handle); - node->push_back(value); +YAML_API bool is_scalar(YAMLTreeHandle tree, YAMLNodeId node) { + if (node == YAML_NULL_ID) return false; + return GET_TREE(tree).is_val(node); } -YAML_API void push_float(YAMLNodeHandle handle, double value) { - auto node = static_cast(handle); - node->push_back(value); -} +// --- READING VALUES --- -YAML_API void push_node(YAMLNodeHandle handle, YAMLNodeHandle value) { - auto node = static_cast(handle); - auto val_node = static_cast(value); - node->push_back(*val_node); +YAML_API char* as_string(YAMLTreeHandle tree, YAMLNodeId node) { + if (node == YAML_NULL_ID) return nullptr; + ryml::Tree& t = GET_TREE(tree); + if (!t.has_val(node)) return nullptr; + ryml::csubstr v = t.val(node); + char* result = new char[v.len + 1]; + memcpy(result, v.str, v.len); + result[v.len] = '\0'; + return result; } -// === WRITE TO FILE WITH EMITTER === - -YAML_API bool write_file(YAMLNodeHandle handle, const char* filename) { - try { - auto node = static_cast(handle); - - std::ofstream fout(filename); - if (!fout.is_open()) { - return false; - } - - YAML::Emitter out; - out << *node; - - fout << out.c_str(); - fout.close(); - return true; - } catch (...) { - return false; +// --- MODIFICATION --- + + +YAML_API YAMLNodeId add_scalar(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key, const char* value, size_t index) { + if (parent == YAML_NULL_ID) return YAML_NULL_ID; + ryml::Tree& t = GET_TREE(tree); + size_t new_id = add_child_at(t, parent, index); + if (t.is_map(parent)) maybe_set_key(t, new_id, key); + t.ref(new_id) |= ryml::VAL; + t.set_val(new_id, t.to_arena(ryml::to_csubstr(value))); + return new_id; +} + +YAML_API YAMLNodeId add_map(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key, size_t index) { + if (parent == YAML_NULL_ID) return YAML_NULL_ID; + ryml::Tree& t = GET_TREE(tree); + size_t new_id = add_child_at(t, parent, index); + if (t.is_map(parent)) maybe_set_key(t, new_id, key); + t.ref(new_id) |= ryml::MAP; + return new_id; +} + +YAML_API YAMLNodeId add_sequence(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key, size_t index) { + if (parent == YAML_NULL_ID) return YAML_NULL_ID; + ryml::Tree& t = GET_TREE(tree); + size_t new_id = add_child_at(t, parent, index); + if (t.is_map(parent)) maybe_set_key(t, new_id, key); + t.ref(new_id) |= ryml::SEQ; + return new_id; +} + +YAML_API void set_scalar(YAMLTreeHandle tree, YAMLNodeId node, const char* value) { + if (node == YAML_NULL_ID) return; + ryml::Tree& t = GET_TREE(tree); + t.ref(node) |= ryml::VAL; + t.set_val(node, t.to_arena(ryml::to_csubstr(value))); +} + +YAML_API void set_node_key(YAMLTreeHandle tree, YAMLNodeId node, const char* key) { + if (node == YAML_NULL_ID) return; + ryml::Tree& t = GET_TREE(tree); + t.ref(node) |= ryml::KEY; + t.set_key(node, t.to_arena(ryml::to_csubstr(key))); +} + +YAML_API void deep_copy_node(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, + YAMLTreeHandle src_tree, YAMLNodeId src_node) { + if (!dst_tree || !src_tree) return; + if (dst_node == YAML_NULL_ID || src_node == YAML_NULL_ID) return; + deep_copy_recursive(GET_TREE(dst_tree), dst_node, GET_TREE(src_tree), src_node); +} + +YAML_API void deep_copy_children(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, + YAMLTreeHandle src_tree, YAMLNodeId src_node, size_t index) { + if (!dst_tree || !src_tree) return; + if (dst_node == YAML_NULL_ID || src_node == YAML_NULL_ID) return; + ryml::Tree& dt = GET_TREE(dst_tree); + ryml::Tree& st = GET_TREE(src_tree); + size_t insert_pos = index; + for (size_t c = st.first_child(src_node); c != ryml::NONE; c = st.next_sibling(c)) { + if (dt.size() + 1 >= dt.capacity()) + dt.reserve(dt.capacity() + 64); + size_t new_child = add_child_at(dt, dst_node, insert_pos); + deep_copy_recursive(dt, new_child, st, c); + if (insert_pos != END) insert_pos++; } } -// Write with emitter control (removed SetWrap) -YAML_API bool write_file_formatted(YAMLNodeHandle handle, const char* filename, - int indent, bool flow_maps, bool flow_seqs) { - try { - auto node = static_cast(handle); - - std::ofstream fout(filename); - if (!fout.is_open()) { - return false; - } - - YAML::Emitter out; - - // Set formatting options (only valid ones) - out.SetIndent(indent); - out.SetMapFormat(flow_maps ? YAML::Flow : YAML::Block); - out.SetSeqFormat(flow_seqs ? YAML::Flow : YAML::Block); - out.SetBoolFormat(YAML::TrueFalseBool); // true/false instead of yes/no - out.SetNullFormat(YAML::LowerNull); // null instead of ~ - out.SetStringFormat(YAML::Auto); // Auto-detect if quotes needed - - out << *node; +// --- EMITTING & UTILS --- - fout << out.c_str(); - fout.close(); - return true; - } catch (...) { - return false; - } -} - -// Get YAML string with emitter -YAML_API char* yaml_emit(YAMLNodeHandle handle, int indent) { - try { - auto node = static_cast(handle); - - YAML::Emitter out; - out.SetIndent(indent); - out.SetBoolFormat(YAML::TrueFalseBool); - out.SetNullFormat(YAML::LowerNull); - out << *node; - - std::string str = out.c_str(); - char* result = new char[str.length() + 1]; - strcpy(result, str.c_str()); - return result; - } catch (...) { - return nullptr; - } +YAML_API char* yaml_to_string(YAMLTreeHandle tree, YAMLNodeId node) { + ryml::Tree& t = GET_TREE(tree); + if (node == ryml::NONE || node >= t.capacity()) return nullptr; + std::stringstream ss; + ss << t.ref(node); + std::string str = ss.str(); + char* result = new char[str.length() + 1]; + strcpy(result, str.c_str()); + return result; } -// Advanced version with all available options -YAML_API bool write_file_advanced( - YAMLNodeHandle handle, const char* filename, int indent, bool flow_maps, - bool flow_seqs, - int bool_format, // 0=YesNo, 1=TrueFalse, 2=OnOff - int null_format, // 0=Tilde (~), 1=Null (null), 2=NULL, 3=Null - int string_format) { // 0=Auto, 1=SingleQuoted, 2=DoubleQuoted, 3=Literal +YAML_API bool write_file(YAMLTreeHandle tree, const char* filename) { try { - auto node = static_cast(handle); - std::ofstream fout(filename); - if (!fout.is_open()) { - return false; - } - - YAML::Emitter out; - out.SetIndent(indent); - out.SetMapFormat(flow_maps ? YAML::Flow : YAML::Block); - out.SetSeqFormat(flow_seqs ? YAML::Flow : YAML::Block); - - // Boolean format - switch (bool_format) { - case 0: - out.SetBoolFormat(YAML::YesNoBool); - break; - case 1: - out.SetBoolFormat(YAML::TrueFalseBool); - break; - case 2: - out.SetBoolFormat(YAML::OnOffBool); - break; - default: - out.SetBoolFormat(YAML::TrueFalseBool); - } - - // Null format - switch (null_format) { - case 0: - out.SetNullFormat(YAML::TildeNull); - break; // ~ - case 1: - out.SetNullFormat(YAML::LowerNull); - break; // null - case 2: - out.SetNullFormat(YAML::UpperNull); - break; // NULL - case 3: - out.SetNullFormat(YAML::CamelNull); - break; // Null - default: - out.SetNullFormat(YAML::LowerNull); - } - - // String format - switch (string_format) { - case 0: - out.SetStringFormat(YAML::Auto); - break; - case 1: - out.SetStringFormat(YAML::SingleQuoted); - break; - case 2: - out.SetStringFormat(YAML::DoubleQuoted); - break; - case 3: - out.SetStringFormat(YAML::Literal); - break; - default: - out.SetStringFormat(YAML::Auto); - } - - out << *node; - - fout << out.c_str(); - fout.close(); + if (!fout) return false; + fout << GET_TREE(tree); return true; } catch (...) { return false; } } -// === UTILITY === -YAML_API char* yaml_to_string(YAMLNodeHandle handle) { - try { - YAML::Emitter out; - out << *static_cast(handle); - std::string str = out.c_str(); - char* result = new char[str.length() + 1]; - strcpy(result, str.c_str()); - return result; - } catch (...) { - return nullptr; - } -} - -// Helper to free strings allocated by this library -YAML_API void yaml_free_string(char* str) { delete[] str; } - -YAML_API void yaml_free_keys(char** keys, int count) { - for (int i = 0; i < count; i++) { - delete[] keys[i]; - } - delete[] keys; +YAML_API void yaml_free_string(char* str) { + delete[] str; } -YAML_API YAMLNodeHandle yaml_clone(YAMLNodeHandle handle) { - return new YAML::Node(YAML::Clone(*static_cast(handle))); -} -} \ No newline at end of file +} // extern "C" \ No newline at end of file diff --git a/src/yaml_c_wrapper.h b/src/yaml_c_wrapper.h index 7f58e38..663d2d8 100644 --- a/src/yaml_c_wrapper.h +++ b/src/yaml_c_wrapper.h @@ -1,87 +1,92 @@ #ifndef YAML_C_WRAPPER_H #define YAML_C_WRAPPER_H +#include #include +#ifdef _WIN32 + #define YAML_API __declspec(dllexport) +#else + #define YAML_API __attribute__((visibility("default"))) +#endif + +// --- CORE TYPES --- +typedef void* YAMLTreeHandle; +typedef size_t YAMLNodeId; + +// ryml uses (size_t)-1 to represent "not found" or "invalid" +#define YAML_NULL_ID ((size_t)-1) + +// Pass as the index argument to add_* functions to append instead of inserting +#define END ((size_t)-1) + +// struct lattices uses std::map so it must be C++ only #ifdef __cplusplus +#include +struct lattices { + YAMLTreeHandle original; + YAMLTreeHandle included; + YAMLTreeHandle expanded; +}; extern "C" { #endif -typedef void* YAMLNodeHandle; -struct lattices { - YAMLNodeHandle original; - YAMLNodeHandle included; - YAMLNodeHandle expanded; - }; - -struct lattices get_lattices(const char* filename, const char* lattice_name); - -// === CREATION === -YAMLNodeHandle create_node(void); -YAMLNodeHandle create_map(void); -YAMLNodeHandle create_sequence(void); -YAMLNodeHandle create_scalar(); -void delete_node(YAMLNodeHandle handle); - -// === PARSING === -YAMLNodeHandle parse_string(const char* yaml_str); -YAMLNodeHandle parse_file(const char* filename); - -// === TYPE CHECKING === -bool is_scalar(YAMLNodeHandle handle); -bool is_sequence(YAMLNodeHandle handle); -bool is_map(YAMLNodeHandle handle); -bool is_null(YAMLNodeHandle handle); - -// === ACCESS === -YAMLNodeHandle get_key(YAMLNodeHandle handle, const char* key); -YAMLNodeHandle get_index(YAMLNodeHandle handle, int index); -bool has_key(YAMLNodeHandle handle, const char* key); -int size(YAMLNodeHandle handle); -char** get_keys(YAMLNodeHandle handle, int* out_count); -void yaml_free_keys(char** keys, int count); - -// === CONVERSION === -char* as_string(YAMLNodeHandle handle); -int as_int(YAMLNodeHandle handle); -double as_float(YAMLNodeHandle handle); -bool as_bool(YAMLNodeHandle handle); -void yaml_free_string(char* str); - -// === MODIFICATION === -void set_value_string(YAMLNodeHandle handle, const char* key, - const char* value); -void set_value_int(YAMLNodeHandle handle, const char* key, int value); -void set_value_float(YAMLNodeHandle handle, const char* key, double value); -void set_value_bool(YAMLNodeHandle handle, const char* key, bool value); -void set_value_node(YAMLNodeHandle handle, const char* key, - YAMLNodeHandle value); - -void set_scalar_string(YAMLNodeHandle handle, const char* value); -void set_scalar_int(YAMLNodeHandle handle, int value); -void set_scalar_float(YAMLNodeHandle handle, double value); -void set_scalar_bool(YAMLNodeHandle handle, bool value); - -void set_at_index(YAMLNodeHandle handle, int index, YAMLNodeHandle value); -void push_string(YAMLNodeHandle handle, const char* value); -void push_int(YAMLNodeHandle handle, int value); -void push_float(YAMLNodeHandle handle, double value); -void yaml_push_bool(YAMLNodeHandle handle, bool value); -void push_node(YAMLNodeHandle handle, YAMLNodeHandle value); - -// === UTILITY === -char* yaml_to_string(YAMLNodeHandle handle); -char* yaml_emit(YAMLNodeHandle handle, int indent); -YAMLNodeHandle yaml_clone(YAMLNodeHandle handle); - -bool write_file(YAMLNodeHandle handle, const char* filename); -bool write_file_formatted(YAMLNodeHandle handle, const char* filename, - int indent, bool flow_maps, bool flow_seqs); -bool write_file_advanced(YAMLNodeHandle handle, const char* filename, int indent, bool flow_maps, - bool flow_seqs, int bool_format, int null_format, int string_format); +YAML_API struct lattices get_lattices(const char* filename, const char* lattice_name); + +// --- PARSING & MEMORY --- +YAML_API YAMLTreeHandle parse_file(const char* filename); +YAML_API YAMLTreeHandle parse_string(const char* yaml_str); +YAML_API YAMLTreeHandle create_empty_tree(); +YAML_API void delete_tree(YAMLTreeHandle tree); +YAML_API void remove_node(YAMLTreeHandle tree, YAMLNodeId parent, YAMLNodeId child); + +// --- TRAVERSAL --- +YAML_API YAMLNodeId get_root(YAMLTreeHandle tree); +YAML_API YAMLNodeId get_parent(YAMLTreeHandle tree, YAMLNodeId node); +YAML_API YAMLNodeId get_child_by_key(YAMLTreeHandle tree, YAMLNodeId parent, const char* key); +YAML_API YAMLNodeId get_child_by_index(YAMLTreeHandle tree, YAMLNodeId parent, size_t index); +YAML_API size_t get_size(YAMLTreeHandle tree, YAMLNodeId node); +YAML_API char* get_node_key(YAMLTreeHandle tree, YAMLNodeId node); + +// --- TYPE CHECKS --- +YAML_API bool is_map(YAMLTreeHandle tree, YAMLNodeId node); +YAML_API bool is_sequence(YAMLTreeHandle tree, YAMLNodeId node); +YAML_API bool is_scalar(YAMLTreeHandle tree, YAMLNodeId node); + +// --- READING VALUES (Caller must free returned strings with yaml_free_string) --- +YAML_API char* as_string(YAMLTreeHandle tree, YAMLNodeId node); + +// --- MODIFICATION --- +// For all three add_* functions: +// key=NULL -> no key set (use for sequence elements) +// index=SIZE_MAX -> append at end; any other value inserts at that position + +// Adds a new scalar child. If parent is a map, key is used; if a sequence, key is ignored. +YAML_API YAMLNodeId add_scalar(YAMLTreeHandle tree, YAMLNodeId parent, const char* key, const char* value, size_t index); + +// Adds a new empty map child. If parent is a map, key is used; if a sequence, key is ignored. +YAML_API YAMLNodeId add_map(YAMLTreeHandle tree, YAMLNodeId parent, const char* key, size_t index); + +// Adds a new empty sequence child. If parent is a map, key is used; if a sequence, key is ignored. +YAML_API YAMLNodeId add_sequence(YAMLTreeHandle tree, YAMLNodeId parent, const char* key, size_t index); + +// Changes the scalar value of an existing node. +YAML_API void set_scalar(YAMLTreeHandle tree, YAMLNodeId node, const char* value); + +// Changes or sets the key of an existing node. +YAML_API void set_node_key(YAMLTreeHandle tree, YAMLNodeId node, const char* key); + +// Deep-copies the type, value, and all children of src into the existing dst node. +YAML_API void deep_copy_node(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, YAMLTreeHandle src_tree, YAMLNodeId src_node); +// Copies all children of src_node into dst_node. Use END to append, or an index to insert at that position. +YAML_API void deep_copy_children(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, YAMLTreeHandle src_tree, YAMLNodeId src_node, size_t index); +// --- EMITTING & UTILS --- +YAML_API char* yaml_to_string(YAMLTreeHandle tree, YAMLNodeId node); +YAML_API bool write_file(YAMLTreeHandle tree, const char* filename); +YAML_API void yaml_free_string(char* str); #ifdef __cplusplus } #endif -#endif // YAML_C_WRAPPER_H \ No newline at end of file +#endif // YAML_C_WRAPPER_H \ No newline at end of file From b1199866fcdd31fe0ef685392bb3cea53e56f4b7 Mon Sep 17 00:00:00 2001 From: Alexheeeee Date: Thu, 7 May 2026 02:48:20 -0400 Subject: [PATCH 04/10] update from yaml-cpp to rapidyaml --- README.md | 20 +- examples/example_rw.cpp | 22 +- lattice_files/ex.pals.yaml | 32 +- src/get_lattices.cpp | 35 +- src/yaml_c_wrapper.cpp | 784 ++++++++++++++++++++++++---------- src/yaml_c_wrapper.h | 349 +++++++++++++-- tests/test_yaml_c_wrapper.cpp | 4 +- 7 files changed, 934 insertions(+), 312 deletions(-) diff --git a/README.md b/README.md index 8868eca..4bf1b7d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ ## Introduction -`yaml_c_wrapper.cpp` wraps `YAML::Node` into C objects so they can be part of a shared object library to interface with other languages +`YAMLTreeHandle` wraps `ryml::Tree` into C objects so they can be part of a shared object library to interface with other languages Implemented components of lattice expansion: include inherits repeat +forking -YAML::Nodes are values that act like pointers, so editing a node will cause the tree the node is -contained in to reflect the changes. +`ryml::Tree`s are stored in memory simply as arrays. `ryml::NodeRef` acts as a simple wrapper around nodes, +which are just indices in the tree array. Trees are obtained by parsing C++ std::string, and values are simply pointers to locations in the string. Therefore, the string must be kept in memory as long as the tree is in use. Lattice files should be placed in the `lattice_files/` directory. @@ -26,16 +27,6 @@ It also builds an executable at build/example_rw containing examples for how to use the library to read lattice files, perform basic manipulations, and write to the lattice back to a file. To see the output, navigate to the build directory and run -The program `get_lattices` will create a struct containing three lattices: -- `original` is a map containing the base lattice as well as any lattices included -in the base lattice. -- `included` is the base lattice but with all included files substituted in. -- `expanded` is the base lattice after lattice expansion has been performed. -Specify the lattice file with the first argument to the function. On default, -the lattice specified by the last `use` statement will be used, and if no `use` -statement exists, the lattice lattice in the file will be used. An optional flag -`-lat lattice_name` can be used to specify the lattice to expand, which has greatest -priority. For example, in the build directory, run ```console ./example_rw ``` @@ -69,4 +60,5 @@ ctest --test-dir build -R "Test Name" ``` ## To Do -add test cases for lattice expansion +Update test cases +Search by kind \ No newline at end of file diff --git a/examples/example_rw.cpp b/examples/example_rw.cpp index cbd6df3..341e0a2 100644 --- a/examples/example_rw.cpp +++ b/examples/example_rw.cpp @@ -1,4 +1,5 @@ #include + #include "../src/yaml_c_wrapper.h" int main(int argc, char* argv[]) { @@ -7,11 +8,12 @@ int main(int argc, char* argv[]) { std::cout << "Output of example_read_write.cpp" << std::endl; // printing to terminal - std::cout << yaml_to_string(tree, get_root(tree)) << std::endl << std::endl; + std::cout << node_to_string(tree, get_root(tree)) << std::endl << std::endl; // type checking // prints "handle is of type sequence: 1", 1 meaning true - std::cout << "handle is of type sequence: " << is_sequence(tree, get_root(tree)) << "\n"; + std::cout << "handle is of type sequence: " + << is_sequence(tree, get_root(tree)) << "\n"; // accessing sequence YAMLNodeId node = get_child_by_index(tree, get_root(tree), 0); @@ -20,29 +22,33 @@ int main(int argc, char* argv[]) { thingB: kind: Sextupole */ - std::cout << "the first element is: \n" << yaml_to_string(tree, node) << "\n"; + std::cout << "the first element is: \n" + << node_to_string(tree, node) << "\n"; // accessing map // prints "the value at key 'thingB' is: kind: Sextupole" std::cout << "\nthe value at key 'thingB' is: " - << yaml_to_string(tree, get_child_by_key(tree, node, "thingB")) << "\n"; + << node_to_string(tree, get_child_by_key(tree, node, "thingB")) + << "\n"; // add a new sequence element to the root containing new_map: {apples: 5} YAMLNodeId new_map_entry = add_map(tree, get_root(tree), NULL, END); YAMLNodeId map = add_map(tree, new_map_entry, "new_map", END); add_scalar(tree, map, "apples", "5", END); - // add a new sequence element to the root containing magnets: {magnet_list: [...]} + // add a new sequence element to the root containing magnets: {magnet_list: + // [...]} YAMLNodeId magnets_entry = add_map(tree, get_root(tree), NULL, END); YAMLNodeId magnets = add_map(tree, magnets_entry, "magnets", END); YAMLNodeId sequence = add_sequence(tree, magnets, "magnet_list", END); add_scalar(tree, sequence, NULL, "magnet1", END); add_scalar(tree, sequence, NULL, "magnet2", 1); - // print tree after modifications — if new nodes don't appear here the issue is in add_*, - // if they do appear but not in the file the issue is in write_file + // print tree after modifications — if new nodes don't appear here the issue + // is in add_*, if they do appear but not in the file the issue is in + // write_file std::cout << "\nTree after modifications:\n"; - std::cout << yaml_to_string(tree, get_root(tree)) << std::endl; + std::cout << node_to_string(tree, get_root(tree)) << std::endl; bool ok = write_file(tree, "../lattice_files/expand.pals.yaml"); std::cout << "write_file returned: " << ok << std::endl; diff --git a/lattice_files/ex.pals.yaml b/lattice_files/ex.pals.yaml index 5190156..c074548 100644 --- a/lattice_files/ex.pals.yaml +++ b/lattice_files/ex.pals.yaml @@ -23,6 +23,13 @@ direction: -1 - a_subline: # Item a_subline is repeated three times repeat: 3 + - to_dump: + kind: Fork + ForkP: + to_line: generic_dump + destination_element: dump_begin + branch_name: this_dump + propagate_reference: true - include: "../lattice_files/include.pals.yaml" - a_subline: kind: BeamLine @@ -33,24 +40,9 @@ - use: "lat2" - use: "lat1" -# - lat: -# kind: Lattice -# branches: -# - inj_line - -# - inj_line: -# kind: BeamLine -# line: -# - to_dump: -# kind: Fork -# ForkP: -# to_line: generic_dump -# to_element: b_subline -# branch_name: this_dump -# propagate_reference: true +- generic_dump: + kind: BeamLine + line: + - dump_begin + - amarker -# - generic_dump: -# kind: BeamLine -# line: -# - a_subline -# - b_subline \ No newline at end of file diff --git a/src/get_lattices.cpp b/src/get_lattices.cpp index 57db185..120a9d2 100644 --- a/src/get_lattices.cpp +++ b/src/get_lattices.cpp @@ -1,30 +1,37 @@ #include -#include "../src/yaml_c_wrapper.h" #include #include +#include "../src/yaml_c_wrapper.h" + int main(int argc, char* argv[]) { const char* file_name = "../lattice_files/ex.pals.yaml"; const char* lattice_name = ""; - if (argc >= 2) { - file_name = argv[1]; - } - if (argc >= 3) { - for (int i = 1; i < argc; i++) { - if (strcmp(argv[i], "-lat") == 0) { - lattice_name = argv[i+1]; + + for (int i = 1; i < argc; i++) { + if (strcmp(argv[i], "-lat") == 0) { + if (i + 1 < argc) { + lattice_name = argv[++i]; + } else { + std::cerr << "Error: -lat requires an argument" << std::endl; + return 1; } + } else { + file_name = argv[i]; } } struct lattices lat = get_lattices(file_name, lattice_name); - std::cout << yaml_to_string(lat.original, get_root(lat.original)) << std::endl; + + std::cout << "Printing original lattice: " << std::endl; + std::cout << tree_to_string(lat.original) << std::endl << "\n\n"; + + std::cout << "Printing included lattice: " << std::endl; + std::cout << tree_to_string(lat.included) << std::endl << "\n\n"; - // // put separating lines here - // std::cout << "Printing included lattice information: " << std::endl; - // std::cout << yaml_to_string(lat.included) << std::endl << "\n\n"; + std::cout << "Printing expanded lattice: " << std::endl; + std::cout << tree_to_string(lat.expanded) << std::endl; - std::cout << "Printing expanded lattice information: " << std::endl; - std::cout << yaml_to_string(lat.expanded, get_root(lat.expanded)) << std::endl; + write_file(lat.expanded, "../lattice_files/expand.pals.yaml"); return 0; } \ No newline at end of file diff --git a/src/yaml_c_wrapper.cpp b/src/yaml_c_wrapper.cpp index 16e8fb7..f6def31 100644 --- a/src/yaml_c_wrapper.cpp +++ b/src/yaml_c_wrapper.cpp @@ -1,18 +1,17 @@ #include "yaml_c_wrapper.h" + +#include +#include +#include +#include #include #include -#include #include -#include -#include -#include -#include -#include - -// ============================================================ -// INTERNALS -// ============================================================ +#include +// Underlying object for YAMLTreeHandle. Contains the parsed YAML tree and the +// string buffer it was parsed from. Nodes are identied by their index (of type +// size_t within its tree. struct ParsedData { ryml::Tree tree; std::string buffer; @@ -20,213 +19,534 @@ struct ParsedData { #define GET_TREE(handle) (static_cast(handle)->tree) -// Shared helper: append or insert a blank child depending on index. -// Grows the node pool if needed since ryml does not auto-resize. -// index=END means append. -static size_t add_child_at(ryml::Tree& t, size_t parent, size_t index) { - if (t.size() + 1 >= t.capacity()) - t.reserve(t.capacity() + 64); +// Grow node pool if nearly full. ryml does not auto-resize. +static void ensure_capacity(ryml::Tree& t, size_t needed = 1) { + if (t.size() + needed >= t.capacity()) t.reserve(t.capacity() + 64); +} - if (index == END) { - return t.append_child(parent); - } +// Append or insert a blank child. index=END means append. +static size_t add_child_at(ryml::Tree& t, size_t parent, size_t index) { + ensure_capacity(t); + if (index == END) return t.append_child(parent); size_t num = t.num_children(parent); if (index > num) index = num; - size_t after_id = (index > 0) ? t.child(parent, index - 1) : ryml::NONE; - return t.insert_child(parent, after_id); + size_t after = (index > 0) ? t.child(parent, index - 1) : ryml::NONE; + return t.insert_child(parent, after); } -// Shared helper: optionally stamp a key onto a node. -static void maybe_set_key(ryml::Tree& t, size_t node, const char* key) { - if (key != nullptr) { - t.ref(node) |= ryml::KEY; - t.set_key(node, t.to_arena(ryml::to_csubstr(key))); - } -} +// ============================================================ +// INTERNAL LATTICE LOGIC +// ============================================================ -// Recursive deep copy used by deep_copy_node and internal helpers. +// Cross-tree deep copy: copies type, key, val, and all descendants of src_node +// into the existing dst_node. Strings are copied into dst_t's arena. ryml only +// natively supports copying nodes within the same tree. static void deep_copy_recursive(ryml::Tree& dst_t, size_t dst_node, - const ryml::Tree& src_t, size_t src_node) { - ryml::NodeType safe_flags = ryml::MAP | ryml::SEQ | ryml::VAL | ryml::KEY; - dst_t.ref(dst_node) |= (src_t.type(src_node) & safe_flags); - - // Capture key/val as std::string BEFORE any append_child calls because - // append_child can reallocate the arena, dangling any csubstr views. - std::string key_str, val_str; - bool has_key = src_t.has_key(src_node); - bool has_val = src_t.has_val(src_node); - if (has_key) key_str = std::string(src_t.key(src_node).str, src_t.key(src_node).len); - if (has_val) val_str = std::string(src_t.val(src_node).str, src_t.val(src_node).len); - - // Collect child IDs before mutating the tree. + const ryml::Tree& src_t, size_t src_node) { std::vector src_children; - for (size_t c = src_t.first_child(src_node); c != ryml::NONE; c = src_t.next_sibling(c)) + for (size_t c = src_t.first_child(src_node); c != ryml::NONE; + c = src_t.next_sibling(c)) src_children.push_back(c); - // Append children first (may reallocate arena). - std::vector dst_children; - for (size_t i = 0; i < src_children.size(); i++) - dst_children.push_back(dst_t.append_child(dst_node)); + // Copy type flags (MAP, SEQ, VAL, KEY) + dst_t.ref(dst_node) |= (src_t.type(src_node) & + (ryml::MAP | ryml::SEQ | ryml::VAL | ryml::KEY)); - // Now safe to set key/val — arena is stable. - if (has_key) dst_t.set_key(dst_node, dst_t.to_arena(ryml::to_csubstr(key_str))); - if (has_val) dst_t.set_val(dst_node, dst_t.to_arena(ryml::to_csubstr(val_str))); + // Copy key and val + if (src_t.has_key(src_node)) { + ryml::csubstr k = src_t.key(src_node); + dst_t.set_key(dst_node, dst_t.to_arena(k)); + } + if (src_t.has_val(src_node)) { + ryml::csubstr v = src_t.val(src_node); + dst_t.set_val(dst_node, dst_t.to_arena(v)); + } + // Pre-allocate dst children, then recurse + std::vector dst_children; + for (size_t i = 0; i < src_children.size(); i++) { + ensure_capacity(dst_t); + dst_children.push_back(dst_t.append_child(dst_node)); + } for (size_t i = 0; i < src_children.size(); i++) deep_copy_recursive(dst_t, dst_children[i], src_t, src_children[i]); } -// ============================================================ -// INTERNAL LATTICE LOGIC -// ============================================================ +// Build a name->node map for all elements that have a "kind" key. +static void make_ele_map(std::map& emap, + const ryml::Tree& t, size_t node) { + // do nothing if node is a scalar + if (node == ryml::NONE || t.is_val(node)) return; + + // if node is a map from a name to it's properties and if the properties + // contain "kind", add the node to the element map + if (t.is_map(node)) { + size_t first = t.first_child(node); + if (first != ryml::NONE && t.has_key(first) && t.is_map(first) && + t.has_child(first, ryml::to_csubstr("kind"))) { + emap.emplace(std::string(t.key(first).str, t.key(first).len), + first); + } + } -static void make_ele_map(std::map& map, - YAMLTreeHandle tree, YAMLNodeId node) { - if (node == YAML_NULL_ID) return; - if (is_scalar(tree, node)) return; - - if (is_map(tree, node)) { - YAMLNodeId params = get_child_by_index(tree, node, 0); - YAMLNodeId kind = get_child_by_key(tree, params, "kind"); - char* key = get_node_key(tree, params); - if (kind != YAML_NULL_ID && key != nullptr) - map.emplace(std::string(key), params); - yaml_free_string(key); + // if node is a map or sequence, recurse into children + for (size_t c = t.first_child(node); c != ryml::NONE; c = t.next_sibling(c)) + make_ele_map(emap, t, c); +} + +// Forward declaration — handle_fork calls expand, expand calls handle_fork +static void expand(ryml::Tree& t, size_t node, + std::map& emap, + size_t branches = ryml::NONE); + +// Helper: get a string value of a keyed child, returns "" if not found +static std::string child_val_str(const ryml::Tree& t, size_t parent, + const char* key) { + size_t id = t.find_child(parent, ryml::to_csubstr(key)); + if (id == ryml::NONE || !t.has_val(id)) return ""; + return std::string(t.val(id).str, t.val(id).len); +} + +// Helper: find an element named 'name' within a line sequence. The element can +// be just the scalar name or defined as a map. +static size_t find_in_line(const ryml::Tree& t, size_t line, + const std::string& name) { + for (size_t c = t.first_child(line); c != ryml::NONE; + c = t.next_sibling(c)) { + if (t.is_val(c) && std::string(t.val(c).str, t.val(c).len) == name) + return c; + if (t.is_map(c)) { + size_t entry = t.first_child(c); + if (entry != ryml::NONE && t.has_key(entry) && + std::string(t.key(entry).str, t.key(entry).len) == name) + return entry; + } + } + return ryml::NONE; +} + +// Handle a Fork element: +// 1. Reads the ForkP +// 2. If the beamline ForkP["to_line"] doesn't exist in the lattice, +// create the target branch in branches +// 3. Rename the forked beamline to ForkP["branch_name"] +// 4. Create a fork_pointer in the element with pointing to "to_element" in the +// new bracnh. +static void handle_fork(ryml::Tree& t, size_t fork_node, size_t branches, + std::map& emap) { + if (branches == ryml::NONE) return; + + size_t forkp = t.find_child(fork_node, ryml::to_csubstr("ForkP")); + if (forkp == ryml::NONE || !t.is_map(forkp)) return; + + std::string to_line = child_val_str(t, forkp, "to_line"); + std::string to_element = child_val_str(t, forkp, "to_element"); + std::string branch_name = child_val_str(t, forkp, "branch_name"); + if (to_line.empty() || to_element.empty() || branch_name.empty()) return; + + // Check whether to_line already exists as a branch (by its original element + // name) + size_t existing_branch = ryml::NONE; + for (size_t c = t.first_child(branches); c != ryml::NONE; + c = t.next_sibling(c)) { + if (!t.is_map(c)) continue; + size_t entry = t.first_child(c); + if (entry != ryml::NONE && t.has_key(entry) && + std::string(t.key(entry).str, t.key(entry).len) == to_line) { + existing_branch = entry; + break; + } } - for (size_t i = 0; i < get_size(tree, node); i++) - make_ele_map(map, tree, get_child_by_index(tree, node, i)); -} + size_t branch_node = existing_branch; + if (existing_branch == ryml::NONE && emap.count(to_line)) { + size_t def = emap[to_line]; + // Append a new wrapper map to branches, then duplicate the definition + // into it + ensure_capacity(t, t.num_children(def) + 2); + size_t wrapper = t.append_child(branches); + t.to_map(wrapper); + branch_node = t.duplicate(def, wrapper, ryml::NONE); + // Rename from original element name to branch_name + t.set_key(branch_node, t.to_arena(ryml::to_csubstr(branch_name))); + // Expand the new branch so its scalars and inherits are resolved + expand(t, branch_node, emap, branches); + } -static void expand(YAMLTreeHandle tree, YAMLNodeId node, - std::map& map) { - if (node == YAML_NULL_ID) return; + if (branch_node == ryml::NONE) return; + + // Find to_element within the new branch's line + size_t line = t.find_child(branch_node, ryml::to_csubstr("line")); + if (line == ryml::NONE || !t.is_seq(line)) return; + size_t target = find_in_line(t, line, to_element); + if (target == ryml::NONE) return; + + // Add fork_pointer: + ensure_capacity(t); + std::string id_str = std::to_string(target); + size_t fp_child = t.append_child(fork_node); + t.ref(fp_child) |= ryml::KEY | ryml::VAL; + t.set_key(fp_child, t.to_arena(ryml::to_csubstr("fork_pointer"))); + t.set_val(fp_child, t.to_arena(ryml::to_csubstr(id_str))); +} + +/** + * Perform lattice expansion on the element `node`. + * 1. Substitute scalar elements with their full definition taken from emap. + * 2. Beamlines that contain "repeat: n" have their contents repeated n times. + * 3. Elements that contain "inherit: ancestor" have the contents of ancestor + * copied into element. + */ +static void expand(ryml::Tree& t, size_t node, + std::map& emap, size_t branches) { + if (node == ryml::NONE) return; + + // Sequence — handle 'repeat' + if (t.is_seq(node)) { + size_t child = t.first_child(node); + // loop over all children + while (child != ryml::NONE) { + size_t next = t.next_sibling(child); + if (t.is_map(child) && t.has_children(child)) { + // first_child because elements are defined as maps with only + // one key + size_t entry = t.first_child(child); + if (t.has_key(entry) && t.is_map(entry)) { + size_t repeat_id = + t.find_child(entry, ryml::to_csubstr("repeat")); + if (repeat_id != ryml::NONE && t.has_val(repeat_id)) { + int count = 0; + try { + count = std::stoi(std::string( + t.val(repeat_id).str, t.val(repeat_id).len)); + } catch (...) { + } + std::string target(t.key(entry).str, t.key(entry).len); + // check if the beamline to be repeated has been defined + // in the file + if (emap.count(target)) { + size_t def = emap[target]; + size_t line_id = + t.find_child(def, ryml::to_csubstr("line")); + size_t after = t.prev_sibling(child); + // if beamline to be repeated has a line, duplicate + // it `count` times, else just duplicate the name of + // the beamline `count` times + if (line_id != ryml::NONE && t.is_seq(line_id)) { + for (int r = 0; r < count; r++) + for (size_t c2 = t.first_child(line_id); + c2 != ryml::NONE; + c2 = t.next_sibling(c2)) { + ensure_capacity(t, 2); + after = t.duplicate(c2, node, after); + } + } else { + for (int r = 0; r < count; r++) { + ensure_capacity(t, 2); + size_t wrapper = + t.insert_child(node, after); + t.ref(wrapper) |= ryml::MAP; + t.duplicate(def, wrapper, ryml::NONE); + after = wrapper; + } + } + t.remove(child); + child = next; + continue; + } + } + } + } + expand(t, child, emap, branches); + child = next; + } + return; + } + + // Standalone scalar value + if (t.is_val(node) && !t.has_key(node)) { + std::string name(t.val(node).str, t.val(node).len); + // replace with definition in element map + if (emap.count(name)) { + size_t def = emap[name]; + ensure_capacity(t, 2); + t.change_type(node, ryml::MAP); + t.duplicate(def, node, ryml::NONE); + expand(t, node, emap, branches); + } + return; + } - if (is_scalar(tree, node)) { - char* name = as_string(tree, node); - if (name && map.count(name)) { - YAMLNodeId def = map.at(std::string(name)); - GET_TREE(tree).ref(node).clear_val(); - // Promote to map and deep-copy the definition under a keyed child. - GET_TREE(tree).ref(node) |= ryml::MAP; - size_t kv_child = GET_TREE(tree).append_child(node); - deep_copy_recursive(GET_TREE(tree), kv_child, GET_TREE(tree), def); - - // Stamp the key after the copy (arena may have moved). - GET_TREE(tree).ref(kv_child) |= ryml::KEY; - GET_TREE(tree).set_key(kv_child, - GET_TREE(tree).to_arena(ryml::to_csubstr(name))); - - expand(tree, node, map); + // Map — handle inherit, detect Lattice/Fork, recurse + if (t.is_map(node)) { + // Inherit: merge fields from named element (existing keys win) + size_t inherit_id = t.find_child(node, ryml::to_csubstr("inherit")); + if (inherit_id != ryml::NONE) { + std::string name(t.val(inherit_id).str, t.val(inherit_id).len); + if (emap.count(name)) { + ensure_capacity(t, t.num_children(emap[name]) + 1); + t.duplicate_children_no_rep(emap[name], node, ryml::NONE); + } } - yaml_free_string(name); - } else if (is_map(tree, node)) { - YAMLNodeId to_inherit = get_child_by_key(tree, node, "inherit"); - if (to_inherit != YAML_NULL_ID) { - YAMLNodeId ancestor = map.at(as_string(tree, to_inherit)); - deep_copy_children(tree, node, tree, ancestor, END); - set_node_key(tree, to_inherit, "inherited"); - expand(tree, node, map); + + // Detect kind to set context or trigger fork handling + std::string kind = child_val_str(t, node, "kind"); + size_t node_branches = branches; + if (kind == "Lattice") { + node_branches = t.find_child(node, ryml::to_csubstr("branches")); + } else if (kind == "Fork") { + handle_fork(t, node, branches, emap); } - } else if (is_sequence(tree, node)) { - for (size_t i = 0; i < get_size(tree, node); i++) { - YAMLNodeId child = get_child_by_index(tree, node, i); - if (is_map(tree, child)) { - for (size_t j = 0; j < get_size(tree, child); j++) { - YAMLNodeId ele = get_child_by_index(tree, child, j); - if (ele != YAML_NULL_ID) { - YAMLNodeId repeat = get_child_by_key(tree, ele, "repeat"); - if (repeat != YAML_NULL_ID) { - char* ntimes_str = as_string(tree, repeat); - int ntimes = std::stoi(ntimes_str); - yaml_free_string(ntimes_str); // Free the string allocation - char* key_str = get_node_key(tree, ele); - remove_node(tree, node, child); - if (key_str) { - YAMLNodeId repeated_subline = map.at(key_str); - YAMLNodeId line = get_child_by_key(tree, repeated_subline, "line"); - for (int n = 0; n < ntimes; n++) { - deep_copy_children(tree, node, tree, line, i); - } - std::cout << yaml_to_string(tree, line); - } - yaml_free_string(key_str); // Free the key allocation + size_t original_size = t.num_children(node); + size_t c = t.first_child(node); + for (size_t i = 0; i < original_size && c != ryml::NONE; + i++, c = t.next_sibling(c)) + expand(t, c, emap, node_branches); + } +} + +/** + * Recursive helper for make_included. Starting from `node`, replace all + * instances of "include: filename" with the contents of `filename`. Also + * recurses into `filename` to handle nested include statements. + */ +static void make_included_recursive(ryml::Tree& t, size_t node) { + if (node == ryml::NONE) return; + + if (t.is_seq(node)) { + size_t child = t.first_child(node); + while (child != ryml::NONE) { + size_t next = t.next_sibling(child); + + // Seq elements are anonymous MAP wrappers, so - include: "file" + // looks like: + // anon wrapper (MAP, no key) -> KEYVAL(key="include", val="file") + std::string filename; + bool is_include = false; + if (!t.has_key(child) && t.is_map(child) && + t.num_children(child) == 1) { + size_t inner = t.first_child(child); + if (inner != ryml::NONE && t.has_key(inner) && + t.key(inner) == ryml::to_csubstr("include") && + t.has_val(inner)) { + is_include = true; + filename = std::string(t.val(inner).str, t.val(inner).len); + } + } + + if (is_include) { + ParsedData* inc = + static_cast(parse_file(filename.c_str())); + if (inc) { + ryml::Tree& inc_t = inc->tree; + size_t after = child; + std::vector inserted; + // Splice each child of the included file's root into this + // sequence + if (inc_t.is_seq(inc_t.root_id())) { + for (size_t c = inc_t.first_child(inc_t.root_id()); + c != ryml::NONE; c = inc_t.next_sibling(c)) { + ensure_capacity(t); + size_t n = t.insert_child(node, after); + deep_copy_recursive(t, n, inc_t, c); + inserted.push_back(n); + after = n; } + } else { + // Included root is not a sequence — insert as a single + // element + ensure_capacity(t); + size_t n = t.insert_child(node, after); + deep_copy_recursive(t, n, inc_t, inc_t.root_id()); + inserted.push_back(n); } + delete inc; + // Recurse into inserted nodes to handle nested includes + for (size_t n : inserted) make_included_recursive(t, n); } + t.remove(child); + child = next; + continue; } - expand(tree, child, map); + + make_included_recursive(t, child); + child = next; } + return; } - for (size_t i = 0; i < get_size(tree, node); i++) - expand(tree, get_child_by_index(tree, node, i), map); + for (size_t c = t.first_child(node); c != ryml::NONE; c = t.next_sibling(c)) + make_included_recursive(t, c); +} + +/** + * Makes the included lattice file. Takes all instances of include statements in + * filename, as well as nested include statements within included files, and + * adds them all to the master tree. + */ +static YAMLTreeHandle make_included(const char* filename) { + ParsedData* data = static_cast(parse_file(filename)); + if (!data) return nullptr; + ryml::Tree& t = data->tree; + t.reserve(t.capacity() + 64); + t.reserve_arena(t.arena_capacity() + 65536); + make_included_recursive(t, t.root_id()); + return data; } -// static YAMLNodeId find_lattice_to_expand(YAMLTreeHandle tree, char* lat_name = "", -// std::map& map) { -// if (lat_name != "") { -// return map.at(lat_name); -// } else { +// helper function for find_lattice +static size_t find_lattice_recursive(const ryml::Tree& t, size_t node, + const std::string& name, + size_t& last_lattice, + std::string& use_name) { + if (!t.is_map(node) && !t.is_seq(node)) return ryml::NONE; + + for (size_t c = t.first_child(node); c != ryml::NONE; + c = t.next_sibling(c)) { + // Track "use" statements — last one wins + if (t.has_key(c) && t.key(c) == ryml::to_csubstr("use") && + t.has_val(c)) { + use_name = std::string(t.val(c).str, t.val(c).len); + continue; + } -// } -// } -static YAMLTreeHandle make_expanded(const char* filename) { - YAMLTreeHandle expanded = parse_file(filename); - if (!expanded) return nullptr; + // Check if this node is a lattice (map with kind: Lattice) + bool is_lattice = false; + if (t.is_map(c)) { + for (size_t child = t.first_child(c); child != ryml::NONE; + child = t.next_sibling(child)) { + if (t.has_key(child) && + t.key(child) == ryml::to_csubstr("kind") && + t.has_val(child) && + t.val(child) == ryml::to_csubstr("Lattice")) { + is_lattice = true; + break; + } + } + } + + if (is_lattice) { + if (!name.empty()) { + if (t.has_key(c) && + t.key(c) == ryml::csubstr(name.data(), name.size())) + return c; + } else { + last_lattice = c; + } + continue; + } + + size_t found = + find_lattice_recursive(t, c, name, last_lattice, use_name); + if (found != ryml::NONE) return found; + } - std::map map; - make_ele_map(map, expanded, get_root(expanded)); - ryml::Tree& t = GET_TREE(expanded); + return ryml::NONE; +} + +/** + * Finds the lattice to be expanded as specified in make_expanded. + */ +static size_t find_lattice(ryml::Tree& t, const std::string& name) { + size_t last_lattice = ryml::NONE; + std::string use_name; + + size_t found = + find_lattice_recursive(t, t.root_id(), name, last_lattice, use_name); + if (found != ryml::NONE) return found; + if (!name.empty()) return ryml::NONE; + + if (!use_name.empty()) return find_lattice(t, use_name); + + return last_lattice; +} + +/** + * Create the expanded lattice. Starts with the included lattice, and expands + * the lattice with the following priorities: + * 1. If `lat_name` != null, then expand the lattice called `lat_name` + * 2. If `lat_name` == null, expand the lattice specified in the last `use` + * statement. + * 3. If no use statement is present, expand the lattice that occurs last in + * the file. Last expansion performs the following: + * 1. Substitute scalar elements with their full definition, if defined in the + * file outside the lattice. + * 2. Beamlines that contain "repeat: n" have their contents repeated n times. + * 3. Elements that contain "inherit: ancestor" have the contents of ancestor + * copied into element. + */ +static YAMLTreeHandle make_expanded(const char* filename, + const char* lat_name) { + YAMLTreeHandle data = make_included(filename); + if (!data) return nullptr; + ryml::Tree& t = GET_TREE(data); t.reserve_arena(t.arena_capacity() + 100000); t.reserve(t.capacity() + 10000); - expand(expanded, get_root(expanded), map); - return expanded; -} - -static void add_to_master_tree(YAMLTreeHandle master, YAMLTreeHandle tree, - YAMLNodeId tree_node) { - if (tree_node == YAML_NULL_ID) return; - YAMLNodeId master_root = get_root(master); - if (is_scalar(tree, tree_node)) return; - - for (size_t i = 0; i < get_size(tree, tree_node); i++) { - YAMLNodeId ele = get_child_by_index(tree, tree_node, i); - add_to_master_tree(master, tree, ele); - - char* key = get_node_key(tree, ele); - if (key && strcmp(key, "include") == 0) { - char* child_filename = as_string(tree, ele); - if (child_filename) { - YAMLTreeHandle child_file = parse_file(child_filename); - if (child_file) { - YAMLNodeId child_root = get_root(child_file); - size_t dest = GET_TREE(master).append_child(master_root); - deep_copy_recursive(GET_TREE(master), dest, - GET_TREE(child_file), child_root); - set_node_key(master, dest, child_filename); - add_to_master_tree(master, child_file, child_root); - delete_tree(child_file); - } - yaml_free_string(child_filename); + std::map emap; + make_ele_map(emap, t, t.root_id()); + + std::string name_str = lat_name ? lat_name : ""; + size_t lat_node = find_lattice(t, name_str); + if (lat_node == ryml::NONE) return data; + size_t branches = t.find_child(lat_node, ryml::to_csubstr("branches")); + + expand(t, lat_node, emap, branches); + return data; +} + +/** + * Recursive helper for make_original. For each included file in `src`: + * 1. Load the file into a new temporary tree. + * 2. Make a new key-value pair in `master` with key = file name and value = + * file contents + * 3. Delete the temporary tree. + */ +static void add_to_master_tree(ryml::Tree& master, const ryml::Tree& src, + size_t node) { + if (node == ryml::NONE || src.is_val(node)) return; + for (size_t c = src.first_child(node); c != ryml::NONE; + c = src.next_sibling(c)) { + add_to_master_tree(master, src, c); + if (src.has_key(c) && src.key(c) == "include" && src.has_val(c)) { + std::string filename(src.val(c).str, src.val(c).len); + ParsedData* child = + static_cast(parse_file(filename.c_str())); + if (child) { + ensure_capacity(master, 2); + size_t dest = master.append_child(master.root_id()); + deep_copy_recursive(master, dest, child->tree, + child->tree.root_id()); + // Root has no key, so stamp the filename on after the copy + master.ref(dest) |= ryml::KEY; + master.set_key(dest, + master.to_arena(ryml::to_csubstr(filename))); + add_to_master_tree(master, child->tree, child->tree.root_id()); + delete child; } } - yaml_free_string(key); } } +/** + * Makes the original lattice. Creates a tree that maps included files to their + * contents. + */ static YAMLTreeHandle make_original(const char* filename) { - YAMLTreeHandle master = create_empty_tree(); - YAMLTreeHandle tree = parse_file(filename); - - if (tree) { - size_t dest = GET_TREE(master).append_child(get_root(master)); - deep_copy_recursive(GET_TREE(master), dest, - GET_TREE(tree), get_root(tree)); - set_node_key(master, dest, filename); - add_to_master_tree(master, tree, get_root(tree)); + ParsedData* master = new ParsedData(); + master->tree.rootref() |= ryml::MAP; + ParsedData* src = static_cast(parse_file(filename)); + if (src) { + ensure_capacity(master->tree, 2); + size_t dest = master->tree.append_child(master->tree.root_id()); + deep_copy_recursive(master->tree, dest, src->tree, src->tree.root_id()); + // Root has no key, so stamp the filename on after the copy + master->tree.ref(dest) |= ryml::KEY; + master->tree.set_key(dest, + master->tree.to_arena(ryml::to_csubstr(filename))); + add_to_master_tree(master->tree, src->tree, src->tree.root_id()); + delete src; } return master; } @@ -237,10 +557,12 @@ static YAMLTreeHandle make_original(const char* filename) { extern "C" { -YAML_API struct lattices get_lattices(const char* filename, const char* lattice_name) { +YAML_API struct lattices get_lattices(const char* filename, + const char* lattice_name) { struct lattices lat = {}; lat.original = make_original(filename); - lat.expanded = make_expanded(filename); + lat.included = make_included(filename); + lat.expanded = make_expanded(filename, lattice_name); return lat; } @@ -250,10 +572,8 @@ YAML_API YAMLTreeHandle parse_file(const char* filename) { try { std::ifstream file(filename, std::ios::binary | std::ios::ate); if (!file) return nullptr; - std::streamsize size = file.tellg(); file.seekg(0, std::ios::beg); - ParsedData* data = new ParsedData(); data->buffer.resize(size); file.read(&data->buffer[0], size); @@ -285,12 +605,10 @@ YAML_API void delete_tree(YAMLTreeHandle tree) { delete static_cast(tree); } -YAML_API void remove_node(YAMLTreeHandle tree, YAMLNodeId parent, YAMLNodeId child) { - if (parent == YAML_NULL_ID || child == YAML_NULL_ID) return; - ryml::Tree& t = GET_TREE(tree); - size_t index = t.child_pos(parent, child); - if (index != ryml::NONE) - t.ref(parent).remove_child(index); +YAML_API void remove_node(YAMLTreeHandle tree, YAMLNodeId parent, + YAMLNodeId child) { + if (child == YAML_NULL_ID) return; + GET_TREE(tree).remove(child); } // --- TRAVERSAL --- @@ -306,17 +624,20 @@ YAML_API YAMLNodeId get_parent(YAMLTreeHandle tree, YAMLNodeId node) { return t.parent(node); } -YAML_API YAMLNodeId get_child_by_key(YAMLTreeHandle tree, YAMLNodeId parent, const char* key) { +YAML_API YAMLNodeId get_child_by_key(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key) { if (parent == YAML_NULL_ID) return YAML_NULL_ID; ryml::Tree& t = GET_TREE(tree); if (!t.is_map(parent)) return YAML_NULL_ID; - YAMLNodeId child = t.find_child(parent, ryml::to_csubstr(key)); + size_t child = t.find_child(parent, ryml::to_csubstr(key)); return (child == ryml::NONE) ? YAML_NULL_ID : child; } -YAML_API YAMLNodeId get_child_by_index(YAMLTreeHandle tree, YAMLNodeId parent, size_t index) { +YAML_API YAMLNodeId get_child_by_index(YAMLTreeHandle tree, YAMLNodeId parent, + size_t index) { ryml::Tree& t = GET_TREE(tree); - if (!(t.is_seq(parent) || t.is_map(parent)) || index >= t.num_children(parent)) + if (!(t.is_seq(parent) || t.is_map(parent)) || + index >= t.num_children(parent)) return YAML_NULL_ID; return t.child(parent, index); } @@ -369,46 +690,56 @@ YAML_API char* as_string(YAMLTreeHandle tree, YAMLNodeId node) { // --- MODIFICATION --- - YAML_API YAMLNodeId add_scalar(YAMLTreeHandle tree, YAMLNodeId parent, - const char* key, const char* value, size_t index) { + const char* key, const char* value, + size_t index) { if (parent == YAML_NULL_ID) return YAML_NULL_ID; ryml::Tree& t = GET_TREE(tree); - size_t new_id = add_child_at(t, parent, index); - if (t.is_map(parent)) maybe_set_key(t, new_id, key); - t.ref(new_id) |= ryml::VAL; - t.set_val(new_id, t.to_arena(ryml::to_csubstr(value))); - return new_id; + size_t id = add_child_at(t, parent, index); + if (t.is_map(parent) && key) { + t.ref(id) |= ryml::KEY | ryml::VAL; + t.set_key(id, t.to_arena(ryml::to_csubstr(key))); + t.set_val(id, t.to_arena(ryml::to_csubstr(value))); + } else { + t.to_val(id, t.to_arena(ryml::to_csubstr(value))); + } + return id; } YAML_API YAMLNodeId add_map(YAMLTreeHandle tree, YAMLNodeId parent, - const char* key, size_t index) { + const char* key, size_t index) { if (parent == YAML_NULL_ID) return YAML_NULL_ID; ryml::Tree& t = GET_TREE(tree); - size_t new_id = add_child_at(t, parent, index); - if (t.is_map(parent)) maybe_set_key(t, new_id, key); - t.ref(new_id) |= ryml::MAP; - return new_id; + size_t id = add_child_at(t, parent, index); + if (t.is_map(parent) && key) + t.to_map(id, t.to_arena(ryml::to_csubstr(key))); + else + t.to_map(id); + return id; } YAML_API YAMLNodeId add_sequence(YAMLTreeHandle tree, YAMLNodeId parent, - const char* key, size_t index) { + const char* key, size_t index) { if (parent == YAML_NULL_ID) return YAML_NULL_ID; ryml::Tree& t = GET_TREE(tree); - size_t new_id = add_child_at(t, parent, index); - if (t.is_map(parent)) maybe_set_key(t, new_id, key); - t.ref(new_id) |= ryml::SEQ; - return new_id; + size_t id = add_child_at(t, parent, index); + if (t.is_map(parent) && key) + t.to_seq(id, t.to_arena(ryml::to_csubstr(key))); + else + t.to_seq(id); + return id; } -YAML_API void set_scalar(YAMLTreeHandle tree, YAMLNodeId node, const char* value) { +YAML_API void set_scalar(YAMLTreeHandle tree, YAMLNodeId node, + const char* value) { if (node == YAML_NULL_ID) return; ryml::Tree& t = GET_TREE(tree); t.ref(node) |= ryml::VAL; t.set_val(node, t.to_arena(ryml::to_csubstr(value))); } -YAML_API void set_node_key(YAMLTreeHandle tree, YAMLNodeId node, const char* key) { +YAML_API void set_node_key(YAMLTreeHandle tree, YAMLNodeId node, + const char* key) { if (node == YAML_NULL_ID) return; ryml::Tree& t = GET_TREE(tree); t.ref(node) |= ryml::KEY; @@ -416,31 +747,36 @@ YAML_API void set_node_key(YAMLTreeHandle tree, YAMLNodeId node, const char* key } YAML_API void deep_copy_node(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, - YAMLTreeHandle src_tree, YAMLNodeId src_node) { + YAMLTreeHandle src_tree, YAMLNodeId src_node) { if (!dst_tree || !src_tree) return; if (dst_node == YAML_NULL_ID || src_node == YAML_NULL_ID) return; - deep_copy_recursive(GET_TREE(dst_tree), dst_node, GET_TREE(src_tree), src_node); + ryml::Tree& dt = GET_TREE(dst_tree); + const ryml::Tree& st = GET_TREE(src_tree); + ensure_capacity(dt, st.num_children(src_node) + 1); + dt.duplicate_contents(&st, src_node, dst_node); } YAML_API void deep_copy_children(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, - YAMLTreeHandle src_tree, YAMLNodeId src_node, size_t index) { + YAMLTreeHandle src_tree, YAMLNodeId src_node, + size_t index) { if (!dst_tree || !src_tree) return; if (dst_node == YAML_NULL_ID || src_node == YAML_NULL_ID) return; ryml::Tree& dt = GET_TREE(dst_tree); - ryml::Tree& st = GET_TREE(src_tree); - size_t insert_pos = index; - for (size_t c = st.first_child(src_node); c != ryml::NONE; c = st.next_sibling(c)) { - if (dt.size() + 1 >= dt.capacity()) - dt.reserve(dt.capacity() + 64); - size_t new_child = add_child_at(dt, dst_node, insert_pos); - deep_copy_recursive(dt, new_child, st, c); - if (insert_pos != END) insert_pos++; - } + const ryml::Tree& st = GET_TREE(src_tree); + size_t after; + if (index == END) + after = dt.last_child(dst_node); + else if (index == 0) + after = ryml::NONE; + else + after = dt.child(dst_node, index - 1); + ensure_capacity(dt, st.num_children(src_node) + 1); + dt.duplicate_children(&st, src_node, dst_node, after); } // --- EMITTING & UTILS --- -YAML_API char* yaml_to_string(YAMLTreeHandle tree, YAMLNodeId node) { +YAML_API char* node_to_string(YAMLTreeHandle tree, YAMLNodeId node) { ryml::Tree& t = GET_TREE(tree); if (node == ryml::NONE || node >= t.capacity()) return nullptr; std::stringstream ss; @@ -451,6 +787,10 @@ YAML_API char* yaml_to_string(YAMLTreeHandle tree, YAMLNodeId node) { return result; } +YAML_API char* tree_to_string(YAMLTreeHandle tree) { + return node_to_string(tree, get_root(tree)); +} + YAML_API bool write_file(YAMLTreeHandle tree, const char* filename) { try { std::ofstream fout(filename); @@ -462,8 +802,6 @@ YAML_API bool write_file(YAMLTreeHandle tree, const char* filename) { } } -YAML_API void yaml_free_string(char* str) { - delete[] str; -} +YAML_API void yaml_free_string(char* str) { delete[] str; } -} // extern "C" \ No newline at end of file +} // extern "C" \ No newline at end of file diff --git a/src/yaml_c_wrapper.h b/src/yaml_c_wrapper.h index 663d2d8..944593f 100644 --- a/src/yaml_c_wrapper.h +++ b/src/yaml_c_wrapper.h @@ -1,13 +1,13 @@ #ifndef YAML_C_WRAPPER_H #define YAML_C_WRAPPER_H -#include #include +#include #ifdef _WIN32 - #define YAML_API __declspec(dllexport) +#define YAML_API __declspec(dllexport) #else - #define YAML_API __attribute__((visibility("default"))) +#define YAML_API __attribute__((visibility("default"))) #endif // --- CORE TYPES --- @@ -18,75 +18,362 @@ typedef size_t YAMLNodeId; #define YAML_NULL_ID ((size_t)-1) // Pass as the index argument to add_* functions to append instead of inserting -#define END ((size_t)-1) +#define END ((size_t)-1) // struct lattices uses std::map so it must be C++ only #ifdef __cplusplus #include struct lattices { - YAMLTreeHandle original; - YAMLTreeHandle included; - YAMLTreeHandle expanded; + YAMLTreeHandle original; // Raw tree mapping each file (including includes) + // to its unparsed contents + YAMLTreeHandle included; // Tree with all "include" directives resolved and + // spliced inline + YAMLTreeHandle expanded; // Tree with the selected lattice fully expanded }; extern "C" { #endif -YAML_API struct lattices get_lattices(const char* filename, const char* lattice_name); +/** + * Builds and returns all three representations of a lattice file. + * + * @param filename Path to the top-level YAML lattice file. + * @param lattice_name Name of the lattice to expand. If NULL or empty: + * - expands the lattice named by the last "use" + * statement, or + * - expands the last lattice defined in the file if no + * "use" is present. + * @return A `lattices` struct containing three handles: + * - `original`: raw tree mapping each file (including includes) to + * its unparsed contents. + * - `included`: tree with all "include" directives resolved and + * spliced inline. + * - `expanded`: tree with the selected lattice fully expanded — + * scalars substituted, repeats unrolled, inherits merged, and forks resolved. + * All three handles must be freed individually with delete_tree(). + */ +YAML_API struct lattices get_lattices(const char* filename, + const char* lattice_name); // --- PARSING & MEMORY --- + +/** + * Parses a YAML file from disk into an opaque tree handle. + * + * The file is read into an internal buffer and parsed in-place; the buffer + * is owned by the returned handle and freed by delete_tree(). + * + * @param filename Path to the YAML file to parse. + * @return A tree handle on success, NULL if the file cannot be opened or + * if parsing fails. + */ YAML_API YAMLTreeHandle parse_file(const char* filename); + +/** + * Parses a YAML string into an opaque tree handle. + * + * The string is copied into an internal buffer and parsed in-place; the + * buffer is owned by the returned handle and freed by delete_tree(). + * + * @param yaml_str Null-terminated YAML string to parse. + * @return A tree handle on success, NULL if parsing fails. + */ YAML_API YAMLTreeHandle parse_string(const char* yaml_str); + +/** + * Creates an empty tree with a MAP root node. + * + * Useful as a destination for deep_copy_node() / deep_copy_children(), + * or for building a tree programmatically via add_map(), add_sequence(), + * and add_scalar(). + * + * @return A tree handle representing an empty MAP. Must be freed with + * delete_tree(). + */ YAML_API YAMLTreeHandle create_empty_tree(); + +/** + * Frees all memory associated with a tree handle. + * + * @param tree Handle previously returned by parse_file(), parse_string(), + * create_empty_tree(), or get_lattices(). Passing NULL is safe + * and has no effect. + */ YAML_API void delete_tree(YAMLTreeHandle tree); -YAML_API void remove_node(YAMLTreeHandle tree, YAMLNodeId parent, YAMLNodeId child); + +/** + * Removes a child node and all its descendants from the tree. + * + * After removal the child's node ID is invalid and must not be used again. + * The parent parameter is accepted for API symmetry but is not used + * internally — the parent is inferred from the tree structure. + * + * @param tree Handle to the tree containing the node. + * @param parent Node ID of the parent (unused, may be YAML_NULL_ID). + * @param child Node ID to remove. If YAML_NULL_ID, this call is a no-op. + */ +YAML_API void remove_node(YAMLTreeHandle tree, YAMLNodeId parent, + YAMLNodeId child); // --- TRAVERSAL --- + +/** + * Returns the node ID of the tree's root node. + * + * @param tree Handle to a parsed or constructed tree. + * @return Root node ID, or YAML_NULL_ID if tree is NULL. + */ YAML_API YAMLNodeId get_root(YAMLTreeHandle tree); + +/** + * Returns the parent of a given node. + * + * @param tree Handle to the tree containing the node. + * @param node Node ID whose parent is requested. + * @return Parent node ID, or YAML_NULL_ID if node is the root or has no parent. + */ YAML_API YAMLNodeId get_parent(YAMLTreeHandle tree, YAMLNodeId node); -YAML_API YAMLNodeId get_child_by_key(YAMLTreeHandle tree, YAMLNodeId parent, const char* key); -YAML_API YAMLNodeId get_child_by_index(YAMLTreeHandle tree, YAMLNodeId parent, size_t index); + +/** + * Finds a direct child of a MAP node by its key. + * + * @param tree Handle to the tree. + * @param parent Node ID of a MAP node to search. + * @param key Null-terminated key string to look up. + * @return Node ID of the matching child, or YAML_NULL_ID if not found or + * if parent is not a MAP. + */ +YAML_API YAMLNodeId get_child_by_key(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key); + +/** + * Returns the nth child of a MAP or sequence node. + * + * @param tree Handle to the tree. + * @param parent Node ID of a MAP or sequence node. + * @param index Zero-based child index. + * @return Node ID of the child at position index, or YAML_NULL_ID if index + * is out of range or parent is neither a MAP nor a sequence. + */ +YAML_API YAMLNodeId get_child_by_index(YAMLTreeHandle tree, YAMLNodeId parent, + size_t index); + +/** + * Returns the number of direct children of a node. + * + * @param tree Handle to the tree. + * @param node Node ID of a MAP or sequence node. + * @return Number of children, or 0 if node is YAML_NULL_ID or is a scalar. + */ YAML_API size_t get_size(YAMLTreeHandle tree, YAMLNodeId node); + +/** + * Returns the key of a node as a newly allocated null-terminated string. + * + * @param tree Handle to the tree. + * @param node Node ID of a keyed node. + * @return Heap-allocated string containing the key. The caller must free it + * with yaml_free_string(). Returns NULL if node is YAML_NULL_ID or + * the node has no key. + */ YAML_API char* get_node_key(YAMLTreeHandle tree, YAMLNodeId node); // --- TYPE CHECKS --- + +/** + * Returns true if the node is a MAP (key-value container). + * + * @param tree Handle to the tree. + * @param node Node ID to test. + * @return true if the node is a MAP, false otherwise or if node is + * YAML_NULL_ID. + */ YAML_API bool is_map(YAMLTreeHandle tree, YAMLNodeId node); + +/** + * Returns true if the node is a sequence (ordered list). + * + * @param tree Handle to the tree. + * @param node Node ID to test. + * @return true if the node is a sequence, false otherwise or if node is + * YAML_NULL_ID. + */ YAML_API bool is_sequence(YAMLTreeHandle tree, YAMLNodeId node); + +/** + * Returns true if the node is a scalar (plain value, no children). + * + * @param tree Handle to the tree. + * @param node Node ID to test. + * @return true if the node is a scalar, false otherwise or if node is + * YAML_NULL_ID. + */ YAML_API bool is_scalar(YAMLTreeHandle tree, YAMLNodeId node); -// --- READING VALUES (Caller must free returned strings with yaml_free_string) --- +// --- READING VALUES --- + +/** + * Returns the scalar value of a node as a newly allocated null-terminated + * string. + * + * @param tree Handle to the tree. + * @param node Node ID of a node that has a value. + * @return Heap-allocated string containing the value. The caller must free it + * with yaml_free_string(). Returns NULL if node is YAML_NULL_ID or + * the node has no value (e.g. is a MAP or bare sequence). + */ YAML_API char* as_string(YAMLTreeHandle tree, YAMLNodeId node); // --- MODIFICATION --- -// For all three add_* functions: -// key=NULL -> no key set (use for sequence elements) -// index=SIZE_MAX -> append at end; any other value inserts at that position -// Adds a new scalar child. If parent is a map, key is used; if a sequence, key is ignored. -YAML_API YAMLNodeId add_scalar(YAMLTreeHandle tree, YAMLNodeId parent, const char* key, const char* value, size_t index); +/** + * Adds a scalar key-value child to a MAP, or a plain scalar to a sequence. + * + * @param tree Handle to the tree. + * @param parent Node ID of the parent MAP or sequence. + * @param key Key string for MAP parents. Pass NULL for sequence elements. + * @param value Null-terminated scalar value string. + * @param index Insertion position among existing children. Pass END to append. + * @return Node ID of the newly created child, or YAML_NULL_ID on failure. + */ +YAML_API YAMLNodeId add_scalar(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key, const char* value, + size_t index); + +/** + * Adds a new empty MAP child to an existing MAP or sequence. + * + * @param tree Handle to the tree. + * @param parent Node ID of the parent MAP or sequence. + * @param key Key string when parent is a MAP. Pass NULL for sequence + * elements. + * @param index Insertion position among existing children. Pass END to append. + * @return Node ID of the newly created MAP child, or YAML_NULL_ID on failure. + */ +YAML_API YAMLNodeId add_map(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key, size_t index); -// Adds a new empty map child. If parent is a map, key is used; if a sequence, key is ignored. -YAML_API YAMLNodeId add_map(YAMLTreeHandle tree, YAMLNodeId parent, const char* key, size_t index); +/** + * Adds a new empty sequence child to an existing MAP or sequence. + * + * @param tree Handle to the tree. + * @param parent Node ID of the parent MAP or sequence. + * @param key Key string when parent is a MAP. Pass NULL for sequence + * elements. + * @param index Insertion position among existing children. Pass END to append. + * @return Node ID of the newly created sequence child, or YAML_NULL_ID on + * failure. + */ +YAML_API YAMLNodeId add_sequence(YAMLTreeHandle tree, YAMLNodeId parent, + const char* key, size_t index); -// Adds a new empty sequence child. If parent is a map, key is used; if a sequence, key is ignored. -YAML_API YAMLNodeId add_sequence(YAMLTreeHandle tree, YAMLNodeId parent, const char* key, size_t index); +/** + * Sets or replaces the scalar value of an existing node. + * + * The value string is copied into the tree's internal arena. + * + * @param tree Handle to the tree. + * @param node Node ID to update. If YAML_NULL_ID, this call is a no-op. + * @param value Null-terminated value string to set. + */ +YAML_API void set_scalar(YAMLTreeHandle tree, YAMLNodeId node, + const char* value); -// Changes the scalar value of an existing node. -YAML_API void set_scalar(YAMLTreeHandle tree, YAMLNodeId node, const char* value); +/** + * Sets or replaces the key of an existing node. + * + * The key string is copied into the tree's internal arena. + * + * @param tree Handle to the tree. + * @param node Node ID to update. If YAML_NULL_ID, this call is a no-op. + * @param key Null-terminated key string to set. + */ +YAML_API void set_node_key(YAMLTreeHandle tree, YAMLNodeId node, + const char* key); -// Changes or sets the key of an existing node. -YAML_API void set_node_key(YAMLTreeHandle tree, YAMLNodeId node, const char* key); +/** + * Deep-copies the contents of a source node into a destination node, + * overwriting whatever was previously there. Works across different trees. + * + * Keys, values, type flags, and all descendants are copied. Strings are + * duplicated into the destination tree's arena so the source tree may be + * freed independently afterwards. + * + * @param dst_tree Handle to the destination tree. + * @param dst_node Node ID in dst_tree to copy into. + * @param src_tree Handle to the source tree (may be the same as dst_tree). + * @param src_node Node ID in src_tree to copy from. + * If either handle is NULL or either node is YAML_NULL_ID, + * this call is a no-op. + */ +YAML_API void deep_copy_node(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, + YAMLTreeHandle src_tree, YAMLNodeId src_node); + +/** + * Deep-copies the children of a source node into a destination node, + * inserting them at the given position. Works across different trees. + * + * Only the children are copied — the source node itself is not. Existing + * children of dst_node are preserved. Strings are duplicated into the + * destination tree's arena. + * + * @param dst_tree Handle to the destination tree. + * @param dst_node Node ID in dst_tree to copy children into. + * @param src_tree Handle to the source tree (may be the same as dst_tree). + * @param src_node Node ID in src_tree whose children are copied. + * @param index Insertion position among dst_node's existing children. + * Pass END to append after all existing children, or 0 to + * prepend before all existing children. + * If either handle is NULL or either node is YAML_NULL_ID, + * this call is a no-op. + */ +YAML_API void deep_copy_children(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, + YAMLTreeHandle src_tree, YAMLNodeId src_node, + size_t index); -// Deep-copies the type, value, and all children of src into the existing dst node. -YAML_API void deep_copy_node(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, YAMLTreeHandle src_tree, YAMLNodeId src_node); -// Copies all children of src_node into dst_node. Use END to append, or an index to insert at that position. -YAML_API void deep_copy_children(YAMLTreeHandle dst_tree, YAMLNodeId dst_node, YAMLTreeHandle src_tree, YAMLNodeId src_node, size_t index); // --- EMITTING & UTILS --- -YAML_API char* yaml_to_string(YAMLTreeHandle tree, YAMLNodeId node); + +/** + * Emits a node and its descendants as a YAML string. + * + * @param tree Handle to the tree. + * @param node Node ID to emit. If YAML_NULL_ID or out of range, returns NULL. + * @return Heap-allocated null-terminated YAML string. The caller must free it + * with yaml_free_string(). + */ +YAML_API char* node_to_string(YAMLTreeHandle tree, YAMLNodeId node); + +/** + * Emits a tree as a YAML string. Same as `node_to_string` but defaulted to + * the root. + * + * @param tree Handle to the tree. + * @return Heap-allocated null-terminated YAML string. The caller must free it + * with yaml_free_string(). + */ +YAML_API char* tree_to_string(YAMLTreeHandle tree); + +/** + * Writes the entire tree to a file as YAML. + * + * @param tree Handle to the tree to serialize. + * @param filename Path to the output file. Created or truncated if it already + * exists. + * @return true on success, false if the file could not be opened or if an + * error occurs during writing. + */ YAML_API bool write_file(YAMLTreeHandle tree, const char* filename); + +/** + * Frees a string returned by get_node_key(), as_string(), or yaml_to_string(). + * + * Passing NULL is safe and has no effect. + * + * @param str Pointer to the string to free. + */ YAML_API void yaml_free_string(char* str); #ifdef __cplusplus } #endif -#endif // YAML_C_WRAPPER_H \ No newline at end of file +#endif // YAML_C_WRAPPER_H \ No newline at end of file diff --git a/tests/test_yaml_c_wrapper.cpp b/tests/test_yaml_c_wrapper.cpp index a2ced7e..60ee8e4 100644 --- a/tests/test_yaml_c_wrapper.cpp +++ b/tests/test_yaml_c_wrapper.cpp @@ -524,7 +524,7 @@ TEST_CASE("YAML nodes can be converted to strings", "[conversion][string]") { YAMLNodeHandle map = create_map(); set_value_string(map, "key", "value"); - char* str = yaml_to_string(map); + char* str = node_to_string(map); REQUIRE(str != nullptr); REQUIRE(std::string(str).find("key") != std::string::npos); REQUIRE(std::string(str).find("value") != std::string::npos); @@ -612,7 +612,7 @@ TEST_CASE("Memory is properly managed", "[memory]") { YAMLNodeHandle node = create_map(); set_value_int(node, "test", i); - char* str = yaml_to_string(node); + char* str = node_to_string(node); yaml_free_string(str); delete_node(node); From 924168b4bda6bc55378b1071025980f634af4086 Mon Sep 17 00:00:00 2001 From: Alexheeeee Date: Thu, 7 May 2026 03:01:39 -0400 Subject: [PATCH 05/10] added doxygen for documentation --- Doxyfile | 3053 +++++++++++++++++ README.md | 5 + docs/html/annotated.html | 137 + docs/html/annotated_dup.js | 4 + docs/html/classes.html | 138 + docs/html/clipboard.js | 61 + docs/html/codefolding.js | 143 + docs/html/cookie.js | 58 + .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 147 + .../dir_68267d1309a1af8e8297ef4c3efbcdba.js | 6 + docs/html/doxygen.css | 2560 ++++++++++++++ docs/html/doxygen.svg | 28 + docs/html/doxygen_crawl.html | 93 + docs/html/files.html | 140 + docs/html/files_dup.js | 4 + docs/html/functions.html | 135 + docs/html/functions_vars.html | 135 + docs/html/get__lattices_8cpp.html | 171 + docs/html/get__lattices_8cpp.js | 4 + docs/html/globals.html | 221 ++ docs/html/globals_defs.html | 137 + docs/html/globals_func.html | 211 ++ docs/html/globals_type.html | 135 + docs/html/index.html | 133 + docs/html/md__r_e_a_d_m_e.html | 174 + docs/html/menu.js | 569 +++ docs/html/menudata.js | 66 + docs/html/navtree.css | 327 ++ docs/html/navtree.js | 1161 +++++++ docs/html/navtreedata.js | 55 + docs/html/navtreeindex0.js | 83 + docs/html/pages.html | 137 + docs/html/search/all_0.js | 7 + docs/html/search/all_1.js | 4 + docs/html/search/all_2.js | 4 + docs/html/search/all_3.js | 6 + docs/html/search/all_4.js | 4 + docs/html/search/all_5.js | 12 + docs/html/search/all_6.js | 6 + docs/html/search/all_7.js | 4 + docs/html/search/all_8.js | 4 + docs/html/search/all_9.js | 6 + docs/html/search/all_a.js | 4 + docs/html/search/all_b.js | 5 + docs/html/search/all_c.js | 5 + docs/html/search/all_d.js | 4 + docs/html/search/all_e.js | 10 + docs/html/search/classes_0.js | 4 + docs/html/search/defines_0.js | 4 + docs/html/search/defines_1.js | 4 + docs/html/search/defines_2.js | 5 + docs/html/search/files_0.js | 4 + docs/html/search/files_1.js | 5 + docs/html/search/functions_0.js | 7 + docs/html/search/functions_1.js | 4 + docs/html/search/functions_2.js | 6 + docs/html/search/functions_3.js | 10 + docs/html/search/functions_4.js | 6 + docs/html/search/functions_5.js | 4 + docs/html/search/functions_6.js | 4 + docs/html/search/functions_7.js | 5 + docs/html/search/functions_8.js | 4 + docs/html/search/functions_9.js | 5 + docs/html/search/functions_a.js | 4 + docs/html/search/functions_b.js | 4 + docs/html/search/functions_c.js | 4 + docs/html/search/pages_0.js | 4 + docs/html/search/pages_1.js | 4 + docs/html/search/pages_2.js | 5 + docs/html/search/pages_3.js | 4 + docs/html/search/search.css | 377 ++ docs/html/search/search.js | 708 ++++ docs/html/search/searchdata.js | 33 + docs/html/search/typedefs_0.js | 5 + docs/html/search/variables_0.js | 4 + docs/html/search/variables_1.js | 4 + docs/html/struct_parsed_data-members.html | 137 + docs/html/struct_parsed_data.html | 178 + docs/html/struct_parsed_data.js | 5 + docs/html/tabs.css | 482 +++ docs/html/yaml__c__wrapper_8cpp.html | 1092 ++++++ docs/html/yaml__c__wrapper_8cpp.js | 32 + docs/html/yaml__c__wrapper_8h.html | 1141 ++++++ docs/html/yaml__c__wrapper_8h.js | 35 + docs/html/yaml__c__wrapper_8h_source.html | 282 ++ {doc => docs}/index.md | 0 docs/latex/Makefile | 42 + docs/latex/annotated.tex | 4 + .../dir_68267d1309a1af8e8297ef4c3efbcdba.tex | 11 + docs/latex/dirs.tex | 9 + docs/latex/doxygen.sty | 898 +++++ docs/latex/etoc_doxygen.sty | 2178 ++++++++++++ docs/latex/files.tex | 6 + docs/latex/get__lattices_8cpp.tex | 22 + docs/latex/md__r_e_a_d_m_e.tex | 69 + docs/latex/refman.tex | 251 ++ docs/latex/struct_parsed_data.tex | 31 + docs/latex/yaml__c__wrapper_8cpp.tex | 606 ++++ docs/latex/yaml__c__wrapper_8h.tex | 629 ++++ docs/latex/yaml__c__wrapper_8h_source.tex | 125 + lattice_files/ex.pals.yaml | 2 +- src/yaml_c_wrapper.cpp | 8 +- 102 files changed, 20027 insertions(+), 5 deletions(-) create mode 100644 Doxyfile create mode 100644 docs/html/annotated.html create mode 100644 docs/html/annotated_dup.js create mode 100644 docs/html/classes.html create mode 100644 docs/html/clipboard.js create mode 100644 docs/html/codefolding.js create mode 100644 docs/html/cookie.js create mode 100644 docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html create mode 100644 docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js create mode 100644 docs/html/doxygen.css create mode 100644 docs/html/doxygen.svg create mode 100644 docs/html/doxygen_crawl.html create mode 100644 docs/html/files.html create mode 100644 docs/html/files_dup.js create mode 100644 docs/html/functions.html create mode 100644 docs/html/functions_vars.html create mode 100644 docs/html/get__lattices_8cpp.html create mode 100644 docs/html/get__lattices_8cpp.js create mode 100644 docs/html/globals.html create mode 100644 docs/html/globals_defs.html create mode 100644 docs/html/globals_func.html create mode 100644 docs/html/globals_type.html create mode 100644 docs/html/index.html create mode 100644 docs/html/md__r_e_a_d_m_e.html create mode 100644 docs/html/menu.js create mode 100644 docs/html/menudata.js create mode 100644 docs/html/navtree.css create mode 100644 docs/html/navtree.js create mode 100644 docs/html/navtreedata.js create mode 100644 docs/html/navtreeindex0.js create mode 100644 docs/html/pages.html create mode 100644 docs/html/search/all_0.js create mode 100644 docs/html/search/all_1.js create mode 100644 docs/html/search/all_2.js create mode 100644 docs/html/search/all_3.js create mode 100644 docs/html/search/all_4.js create mode 100644 docs/html/search/all_5.js create mode 100644 docs/html/search/all_6.js create mode 100644 docs/html/search/all_7.js create mode 100644 docs/html/search/all_8.js create mode 100644 docs/html/search/all_9.js create mode 100644 docs/html/search/all_a.js create mode 100644 docs/html/search/all_b.js create mode 100644 docs/html/search/all_c.js create mode 100644 docs/html/search/all_d.js create mode 100644 docs/html/search/all_e.js create mode 100644 docs/html/search/classes_0.js create mode 100644 docs/html/search/defines_0.js create mode 100644 docs/html/search/defines_1.js create mode 100644 docs/html/search/defines_2.js create mode 100644 docs/html/search/files_0.js create mode 100644 docs/html/search/files_1.js create mode 100644 docs/html/search/functions_0.js create mode 100644 docs/html/search/functions_1.js create mode 100644 docs/html/search/functions_2.js create mode 100644 docs/html/search/functions_3.js create mode 100644 docs/html/search/functions_4.js create mode 100644 docs/html/search/functions_5.js create mode 100644 docs/html/search/functions_6.js create mode 100644 docs/html/search/functions_7.js create mode 100644 docs/html/search/functions_8.js create mode 100644 docs/html/search/functions_9.js create mode 100644 docs/html/search/functions_a.js create mode 100644 docs/html/search/functions_b.js create mode 100644 docs/html/search/functions_c.js create mode 100644 docs/html/search/pages_0.js create mode 100644 docs/html/search/pages_1.js create mode 100644 docs/html/search/pages_2.js create mode 100644 docs/html/search/pages_3.js create mode 100644 docs/html/search/search.css create mode 100644 docs/html/search/search.js create mode 100644 docs/html/search/searchdata.js create mode 100644 docs/html/search/typedefs_0.js create mode 100644 docs/html/search/variables_0.js create mode 100644 docs/html/search/variables_1.js create mode 100644 docs/html/struct_parsed_data-members.html create mode 100644 docs/html/struct_parsed_data.html create mode 100644 docs/html/struct_parsed_data.js create mode 100644 docs/html/tabs.css create mode 100644 docs/html/yaml__c__wrapper_8cpp.html create mode 100644 docs/html/yaml__c__wrapper_8cpp.js create mode 100644 docs/html/yaml__c__wrapper_8h.html create mode 100644 docs/html/yaml__c__wrapper_8h.js create mode 100644 docs/html/yaml__c__wrapper_8h_source.html rename {doc => docs}/index.md (100%) create mode 100644 docs/latex/Makefile create mode 100644 docs/latex/annotated.tex create mode 100644 docs/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex create mode 100644 docs/latex/dirs.tex create mode 100644 docs/latex/doxygen.sty create mode 100644 docs/latex/etoc_doxygen.sty create mode 100644 docs/latex/files.tex create mode 100644 docs/latex/get__lattices_8cpp.tex create mode 100644 docs/latex/md__r_e_a_d_m_e.tex create mode 100644 docs/latex/refman.tex create mode 100644 docs/latex/struct_parsed_data.tex create mode 100644 docs/latex/yaml__c__wrapper_8cpp.tex create mode 100644 docs/latex/yaml__c__wrapper_8h.tex create mode 100644 docs/latex/yaml__c__wrapper_8h_source.tex diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..f51d675 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,3053 @@ +# Doxyfile 1.17.0 + +# This file describes the settings to be used by the documentation system +# Doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use Doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use Doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "pals-cpp" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewers a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = PALS lattice parser. + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where Doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./docs + +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding Doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise cause +# performance problems for the file system. Adjust CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by Doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which Doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where Doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful if your file system doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot, question mark or exclamation mark) of a +# Javadoc-style comment as the brief description. If set to NO, the Javadoc- +# style will behave just like regular Qt-style comments (thus requiring an +# explicit @brief command for a brief description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by Doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot, question mark or exclamation mark) of a Qt-style +# comment as the brief description. If set to NO, the Qt-style will behave just +# like regular Qt-style comments (thus requiring an explicit \brief command for +# a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and Doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# Doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as Doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make Doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by Doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by Doxygen, so you can +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# If the MARKDOWN_STRICT tag is enabled then Doxygen treats text in comments as +# Markdown formatted also in cases where Doxygen's native markup format +# conflicts with that of Markdown. This is only relevant in cases where +# backticks are used. Doxygen's native markup style allows a single quote to end +# a text fragment started with a backtick and then treat it as a piece of quoted +# text, whereas in Markdown such text fragment is treated as verbatim and only +# ends when a second matching backtick is found. Also, Doxygen's native markup +# format requires double quotes to be escaped when they appear in a backtick +# section, whereas this is not needed for Markdown. +# The default value is: YES. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_STRICT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 6. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 6 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled Doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect links explicitly created using # +# or the \link or \ref commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let Doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse +# them like normal C++ but will assume all classes use public instead of private +# inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# Doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then Doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# Doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run Doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 512, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and macOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The GENERATE_REQUIREMENTS tag can be used to enable (YES) or disable (NO) the +# requirements page. When enabled, this page is automatically created when at +# least one comment block with a \requirement command appears in the input. +# The default value is: YES. + +GENERATE_REQUIREMENTS = YES + +# The REQ_TRACEABILITY_INFO tag controls if traceability information is shown on +# the requirements page (only relevant when using \requirement comment blocks). +# The setting NO will disable the traceability information altogether. The +# setting UNSATISFIED_ONLY will show a list of requirements that are missing a +# satisfies relation (through the command: \satisfies). Similarly the setting +# UNVERIFIED_ONLY will show a list of requirements that are missing a verifies +# relation (through the command: \verifies). Setting the tag to YES (the +# default) will show both lists if applicable. +# Possible values are: YES, NO, UNSATISFIED_ONLY and UNVERIFIED_ONLY. +# The default value is: YES. +# This tag requires that the tag GENERATE_REQUIREMENTS is set to YES. + +REQ_TRACEABILITY_INFO = YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# Doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by Doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by Doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents Doxygen's defaults, run Doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run Doxygen from a directory containing a file called +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by Doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, Doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found +# while parsing the user defined layout file, such as missing or wrong elements. +# See also LAYOUT_FILE for details. If set to NO, problems with the layout file +# will be suppressed. +# The default value is: YES. + +WARN_LAYOUT_FILE = YES + +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ./src + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by Doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cxxm \ + *.cpp \ + *.cppm \ + *.ccm \ + *.c++ \ + *.c++m \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which Doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that Doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that Doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the Doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by Doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank Doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that Doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that Doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of Doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank Doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that Doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank Doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that Doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by Doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, Doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline (the HTML help workshop was already many +# years in maintenance mode). You can download the HTML help workshop from the +# web archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/https://download.microsoft.com/downl +# oad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# Doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by Doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has more details information than the tab index, you +# could consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines +# if an additional navigation panel is shown at the right hand side of the +# screen, displaying an outline of the contents of the main page, similar to +# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to +# NO, this option has no effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +PAGE_OUTLINE_PANEL = YES + +# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if +# the side bar is limited to only the treeview area (value NO) or if it should +# extend to the full height of the window (value YES). Setting this to YES gives +# a layout similar to e.g. https://docs.readthedocs.io with more room for +# contents, but less room for the project logo, title, and description. If +# GENERATE_TREEVIEW is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# Doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# Doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2, MathJax_3 and MathJax_4. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# https://docs.mathjax.org/en/v2.7/output.html), MathJax version 3 (see: +# https://docs.mathjax.org/en/v3.2/output/index.html) and MathJax version 4 +# (see: +# https://docs.mathjax.org/en/v4.0/output/index.htm). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. For Mathjax version 2 the +# destination directory should contain the MathJax.js script. For instance, if +# the mathjax directory is located at the same level as the HTML output +# directory, then MATHJAX_RELPATH should be ../mathjax. For Mathjax versions 3 +# and 4 the destination directory should contain the tex-.js script +# (where is either chtml or svg). The default value points to the +# MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. However, it is strongly recommended to install a local +# copy of MathJax from https://www.mathjax.org before deployment. The default +# value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# - in case of MathJax version 4: https://cdn.jsdelivr.net/npm/mathjax@4 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7/tex.html): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# https://docs.mathjax.org/en/v3.2/input/tex/extensions/): +# MATHJAX_EXTENSIONS = ams +# For example for MathJax version 4 (see +# https://docs.mathjax.org/en/v4.0/input/tex/extensions/): +# MATHJAX_EXTENSIONS = units +# Note that for Mathjax version 4 quite a few extensions are already +# automatically loaded. To disable a package in Mathjax version 4 one can use +# the package name prepended with a minus sign (- like MATHJAX_EXTENSIONS += +# -textmacros) +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces +# of code that will be used on startup of the MathJax code. See the Mathjax site +# for more details: +# - MathJax version 2 (see: +# https://docs.mathjax.org/en/v2.7/) +# - MathJax version 3 (see: +# https://docs.mathjax.org/en/v3.2/) +# - MathJax version 4 (see: +# https://docs.mathjax.org/en/v4.0/) For an example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for +# the HTML output. The underlying search engine uses JavaScript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the JavaScript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /