Merge pull request #628 from sebproell/yaml-emit-rel-paths

Let --to-yaml emit relative file paths

Author: sebproell

apps/global_full/4C_global_full_main.cpp

@@ -349,6 +349,13 @@ int main(int argc, char* argv[])
     if (Core::Communication::my_mpi_rank(lcomm) == 0)
     {
       std::filesystem::path inputfile_name = argv[2];
+      // Always make the input file path relative to the working directory. This ensures that any
+      // absolute path encountered in the input file stays that way.
+      if (inputfile_name.is_absolute())
+      {
+        inputfile_name = std::filesystem::relative(inputfile_name);
+      }
+
       std::filesystem::path outputfile_name;
       if (argc == 3)
       {
@@ -370,7 +377,7 @@ int main(int argc, char* argv[])
       Core::IO::InputFile input_file = Global::set_up_input_file(lcomm);
       input_file.read(inputfile_name);
       std::ofstream output_file(outputfile_name);
-      input_file.write_as_yaml(output_file);
+      input_file.write_as_yaml(output_file, outputfile_name);
       printf("The input file has been converted to yaml format");
       if (argc == 3) printf(", saved as %s", outputfile_name.c_str());
       printf("\n");

src/core/io/src/4C_io_input_file.cpp

@@ -1032,7 +1032,7 @@ namespace Core::IO
     out << tree;
   }
 
-  void InputFile::write_as_yaml(std::ostream& out) const
+  void InputFile::write_as_yaml(std::ostream& out, const std::filesystem::path& file_name) const
   {
     auto tree = init_yaml_tree_with_exceptions();
     tree.rootref() |= ryml::MAP;
@@ -1048,7 +1048,8 @@ namespace Core::IO
       {
         auto& spec = pimpl_->valid_sections_.at(section_name);
         match_section(section_name, container);
-        YamlNodeRef section_node{tree.rootref(), ""};
+        YamlNodeRef section_node{
+            tree.rootref(), file_name.empty() ? std::filesystem::path{} : file_name};
         spec.emit(section_node, container);
       }
       else

src/core/io/src/4C_io_input_file.hpp

@@ -251,11 +251,12 @@ namespace Core::IO
 
     /**
      * Write the content of the input file to the given output stream @p out. The content is
-     * written in .yaml format.
+     * written in .yaml format. The optional @p file_name is used to construct correct relative
+     * paths for all path parameters.
      *
      * @note You probably only want to call this function on rank 0.
      */
-    void write_as_yaml(std::ostream& out) const;
+    void write_as_yaml(std::ostream& out, const std::filesystem::path& file_name = {}) const;
 
    private:
     std::unique_ptr<Internal::InputFileImpl> pimpl_;

src/core/io/src/4C_io_input_spec.cpp

@@ -88,8 +88,7 @@ void Core::IO::InputSpec::emit_metadata(YamlNodeRef yaml) const
 {
   FOUR_C_ASSERT(pimpl_, "InputSpec is empty.");
 
-  auto root = yaml.node;
-  pimpl_->emit_metadata(root);
+  pimpl_->emit_metadata(yaml);
 }
 
 Core::IO::Internal::InputSpecImpl& Core::IO::InputSpec::impl()

src/core/io/src/4C_io_input_spec_builders.cpp

@@ -10,7 +10,6 @@
 #include "4C_utils_string.hpp"
 
 #include <format>
-#include <iostream>
 #include <numeric>
 #include <set>
 #include <unordered_map>
@@ -751,25 +750,25 @@ void Core::IO::Internal::GroupSpec::print(std::ostream& stream, std::size_t inde
   }
 }
 
-void Core::IO::Internal::GroupSpec::emit_metadata(ryml::NodeRef node) const
+void Core::IO::Internal::GroupSpec::emit_metadata(YamlNodeRef node) const
 {
-  node |= ryml::MAP;
-  node["name"] << name;
+  node.node |= ryml::MAP;
+  node.node["name"] << name;
 
-  node["type"] = "group";
+  node.node["type"] = "group";
   if (!data.description.empty())
   {
-    node["description"] << data.description;
+    node.node["description"] << data.description;
   }
-  emit_value_as_yaml(node["required"], data.required.value());
-  emit_value_as_yaml(node["defaultable"], data.defaultable);
-  node["specs"] |= ryml::SEQ;
+  emit_value_as_yaml(node.wrap(node.node["required"]), data.required.value());
+  emit_value_as_yaml(node.wrap(node.node["defaultable"]), data.defaultable);
+  node.node["specs"] |= ryml::SEQ;
   {
     for (const auto& spec : specs)
     {
-      auto child = node["specs"].append_child();
+      auto child = node.node["specs"].append_child();
       child |= ryml::MAP;
-      spec.impl().emit_metadata(child);
+      spec.impl().emit_metadata(node.wrap(child));
     };
   }
 }
@@ -864,23 +863,23 @@ void Core::IO::Internal::AllOfSpec::print(std::ostream& stream, std::size_t inde
   }
 }
 
-void Core::IO::Internal::AllOfSpec::emit_metadata(ryml::NodeRef node) const
+void Core::IO::Internal::AllOfSpec::emit_metadata(YamlNodeRef node) const
 {
-  node |= ryml::MAP;
+  node.node |= ryml::MAP;
 
-  node["type"] = "all_of";
+  node.node["type"] = "all_of";
   if (!data.description.empty())
   {
-    node["description"] << data.description;
+    node.node["description"] << data.description;
   }
-  emit_value_as_yaml(node["required"], data.required.value());
-  node["specs"] |= ryml::SEQ;
+  emit_value_as_yaml(node.wrap(node.node["required"]), data.required.value());
+  node.node["specs"] |= ryml::SEQ;
   {
     for (const auto& spec : specs)
     {
-      auto child = node["specs"].append_child();
+      auto child = node.node["specs"].append_child();
       child |= ryml::MAP;
-      spec.impl().emit_metadata(child);
+      spec.impl().emit_metadata(node.wrap(child));
     }
   }
 }
@@ -1021,20 +1020,20 @@ void Core::IO::Internal::OneOfSpec::print(std::ostream& stream, std::size_t inde
   }
 }
 
-void Core::IO::Internal::OneOfSpec::emit_metadata(ryml::NodeRef node) const
+void Core::IO::Internal::OneOfSpec::emit_metadata(YamlNodeRef node) const
 {
-  node |= ryml::MAP;
+  node.node |= ryml::MAP;
 
-  node["type"] << "one_of";
+  node.node["type"] << "one_of";
   if (!data.description.empty())
   {
-    node["description"] << data.description;
+    node.node["description"] << data.description;
   }
-  node["specs"] |= ryml::SEQ;
+  node.node["specs"] |= ryml::SEQ;
   for (const auto& spec : specs)
   {
-    auto child = node["specs"].append_child();
-    spec.impl().emit_metadata(child);
+    auto child = node.node["specs"].append_child();
+    spec.impl().emit_metadata(node.wrap(child));
   }
 }
 
@@ -1153,21 +1152,21 @@ void Core::IO::Internal::ListSpec::print(std::ostream& stream, std::size_t inden
   spec.impl().print(stream, indent + 2);
 }
 
-void Core::IO::Internal::ListSpec::emit_metadata(ryml::NodeRef node) const
+void Core::IO::Internal::ListSpec::emit_metadata(YamlNodeRef node) const
 {
-  node |= ryml::MAP;
+  node.node |= ryml::MAP;
 
-  node["name"] << name;
+  node.node["name"] << name;
 
-  node["type"] << "list";
+  node.node["type"] << "list";
   if (!data.description.empty())
   {
-    node["description"] << Core::Utils::trim(data.description);
+    node.node["description"] << Core::Utils::trim(data.description);
   }
-  emit_value_as_yaml(node["required"], data.required);
-  if (data.size > 0) node["size"] << data.size;
-  node["spec"] |= ryml::MAP;
-  spec.impl().emit_metadata(node["spec"]);
+  emit_value_as_yaml(node.wrap(node.node["required"]), data.required);
+  if (data.size > 0) node.node["size"] << data.size;
+  node.node["spec"] |= ryml::MAP;
+  spec.impl().emit_metadata(node.wrap(node.node["spec"]));
 }