Merge pull request #7 from LBNL-ETA/DirectoryRestructure

Directory restructure

Author: vidanovic

CMakeLists.txt

@@ -32,14 +32,14 @@ endif()
 
 include(CMakeLists-xmlParser.txt)
 
-add_subdirectory(src)
+add_subdirectory(include/fileParse)
 
 target_include_directories(${LIB_NAME}
     PUBLIC 
         $<INSTALL_INTERFACE:include>    
         $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
     PRIVATE
-        ${CMAKE_CURRENT_SOURCE_DIR}/src
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
 )
 
 Option(BUILD_FileParse_tests "Build FileParse tests." ON)

src/FP_Array.hxx renamed to include/fileParse/Array.hxx

@@ -10,7 +10,7 @@
 #include <functional>
 #include <stdexcept>
 
-#include "FP_Common.hxx"
+#include "Common.hxx"
 
 namespace FileParse
 {
@@ -52,13 +52,14 @@ namespace FileParse
 
         if(auto currentNode{findParentOfLastTag(node, arr.nodeNames)}; currentNode.has_value())
         {
-            auto minimum{
-              std::min(arr.data.size(), static_cast<size_t>(currentNode.value().nChildNode()))};
+            const auto childNodes{currentNode.value().getChildNodesByName(arr.nodeNames.back())};
+
+            // std::array is fixed and cannot be resized, so we need to limit the number of elements
+            auto minimum{std::min(arr.data.size(), childNodes.size())};
             for(int i = 0; i < minimum; ++i)
             {
-                NodeAdapter activeNode = currentNode.value().getChildNode(arr.nodeNames.back(), i);
                 T item;
-                activeNode >> item;
+                childNodes[i] >> item;
                 arr.data[i] = item;
             }
         }

src/FP_Base.hxx renamed to include/fileParse/Base.hxx

@@ -10,7 +10,7 @@
 #include <unordered_map>
 #include <array>
 
-#include "FP_Formatter.hxx"
+#include "Formatter.hxx"
 
 namespace FileParse
 {
@@ -151,15 +151,16 @@ namespace FileParse
     std::optional<NodeAdapter> findParentOfLastTag(NodeAdapter node,
                                                    const std::vector<std::string> & nodeNames)
     {
-        NodeAdapter currentNode = node;
+        std::optional<NodeAdapter> currentNode = node;
 
         for(size_t i = 0; i < nodeNames.size() - 1; ++i)
         {
-            currentNode = currentNode.getChildNode(nodeNames[i], 0);
-            if(currentNode.isEmpty())
+            if(!currentNode)
             {
                 return std::nullopt;
             }
+
+            currentNode = currentNode->getFirstChildByName(nodeNames[i]);
         }
 
         return currentNode;
@@ -348,9 +349,9 @@ namespace FileParse
     inline std::enable_if_t<is_valid_map<MapType>::value, const NodeAdapter &>
       operator>>(const NodeAdapter & node, MapType & map)
     {
-        for(int i = 0; i < node.nChildNode(); ++i)
+        const auto & childNodes{node.getChildNodes()};
+        for(const auto & childNode : childNodes)
         {
-            auto childNode = node.getChildNode(i);
             std::string key = childNode.getCurrentTag();
 
             typename MapType::mapped_type val;

src/CMakeLists.txt renamed to include/fileParse/CMakeLists.txt

@@ -1,19 +1,19 @@
 set( CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE ON )
 
 add_library( ${LIB_NAME}
-        FP_Base.hxx
-		FP_Formatter.hxx
-		FP_Formatter.cxx
-		FP_Common.hxx
-		FP_Enum.hxx
-		FP_Map.hxx
-		FP_Optional.hxx
-		FP_Set.hxx
-		FP_StringConversion.hxx
-		FP_Variant.hxx
-		FP_Vector.hxx
-		FP_XMLNodeAdapter.cxx
-		FP_XMLNodeAdapter.hxx)
+		Base.hxx
+		Formatter.hxx
+		Formatter.cxx
+		Common.hxx
+		Enum.hxx
+		Map.hxx
+		Optional.hxx
+		Set.hxx
+		StringConversion.hxx
+		Variant.hxx
+		Vector.hxx
+		XMLNodeAdapter.cxx
+		XMLNodeAdapter.hxx)
 
 if(NOT "${fPIC}")
   set(fPIC ON)

src/FP_Common.hxx renamed to include/fileParse/Common.hxx

@@ -7,7 +7,7 @@
 #include <string>
 #include <vector>
 
-#include "FP_Base.hxx"
+#include "Base.hxx"
 
 namespace FileParse
 {
@@ -81,10 +81,10 @@ namespace FileParse
     {
         for(const auto & nodeName : child.nodeNames)
         {
-            auto childNode = node.getChildNode(nodeName, 0);
-            if(!childNode.isEmpty())
+            auto childNode{node.getFirstChildByName(nodeName)};
+            if(childNode.has_value())
             {
-                childNode >> child.data;
+                childNode.value() >> child.data;
             }
         }
         return node;

src/FP_Enum.hxx renamed to include/fileParse/Enum.hxx

@@ -1,4 +1,4 @@
-#include "FP_Formatter.hxx"
+#include "Formatter.hxx"
 
 namespace FileParse
 {

src/FP_Formatter.cxx renamed to include/fileParse/Formatter.cxx

@@ -6,6 +6,7 @@
 
 #include <string>
 #include <vector>
+#include <optional>
 
 /// Interface INodeAdapter provides a set of virtual functions for node manipulation
 /// and data extraction in a tree-like structure.
@@ -22,23 +23,19 @@ public:
     /// Gets the tag of the current node.
     [[nodiscard]] virtual std::string getCurrentTag() const = 0;
 
-    /// Checks if the current tag matches the provided name.
-    [[nodiscard]] virtual bool isCurrentTag(std::string_view name) const = 0;
-
     /// Gets the text content of the current node.
     [[nodiscard]] virtual std::string getText() const = 0;
 
-    /// Counts the number of child nodes of the current node.
-    [[nodiscard]] virtual int nChildNode() const = 0;
-
-    /// Gets the child node at the specified index.
-    [[nodiscard]] virtual AdapterType getChildNode(int i) const = 0;
-
     // Gets all child nodes of the current node.
     [[nodiscard]] virtual std::vector<AdapterType> getChildNodes() const = 0;
 
-    /// Gets the child node with the specified name at the specified index.
-    [[nodiscard]] virtual AdapterType getChildNode(std::string_view name, int i) const = 0;
+    /// If child with given name exists, it will return the first child node with the given name.
+    [[nodiscard]] virtual std::optional<AdapterType>
+      getFirstChildByName(std::string_view name) const = 0;
+
+    /// Gets the child nodes with the specified name.
+    [[nodiscard]] virtual std::vector<AdapterType> getChildNodesByName(std::string_view name) const
+      = 0;
 
     /// Counts the number of child nodes with the specified name.
     [[nodiscard]] virtual int nChildNode(std::string_view name) const = 0;

src/FP_Formatter.hxx renamed to include/fileParse/Formatter.hxx

@@ -7,8 +7,8 @@
 
 #include <functional>
 
-#include "FP_Common.hxx"
-#include "FP_StringConversion.hxx"
+#include "Common.hxx"
+#include "StringConversion.hxx"
 
 namespace FileParse
 {
@@ -100,13 +100,9 @@ namespace FileParse
                              std::string_view childNodeName,
                              MapType & map)
     {
-        int childCount = node.nChildNode(childNodeName.data());
-        for(int i = 0; i < childCount; ++i)
+        const auto childNodes{node.getChildNodesByName(childNodeName.data())};
+        for(const auto & childNode : childNodes)
         {
-            auto childNode = node.getChildNode(childNodeName.data(), i);
-
-            // Assuming key and value types have default constructors and
-            // have the appropriate `>>` operators overloaded.
             typename MapType::key_type key;
             typename MapType::mapped_type value;
 
@@ -159,10 +155,9 @@ namespace FileParse
     inline std::enable_if_t<is_valid_map<MapType>::value, const NodeAdapter &> deserializeEnumMap(
       const NodeAdapter & node, MapType & map, std::function<EnumType(std::string_view)> converter)
     {
-        int totalNodes = node.nChildNode();
-        for(int i = 0; i < totalNodes; ++i)
+        const auto & childNodes{node.getChildNodes()};
+        for(const auto & childNode : childNodes)
         {
-            NodeAdapter childNode = node.getChildNode(i);
             if(!childNode.isEmpty())
             {
                 const auto text = childNode.getText();

src/FP_INodeAdapter.hxx renamed to include/fileParse/INodeAdapter.hxx

@@ -6,7 +6,7 @@
 
 #include <optional>
 
-#include "FP_Common.hxx"
+#include "Common.hxx"
 
 namespace FileParse
 {

src/FP_Map.hxx renamed to include/fileParse/Map.hxx

@@ -8,7 +8,7 @@
 #include <functional>
 #include <stdexcept>
 
-#include "FP_Common.hxx"
+#include "Common.hxx"
 
 namespace FileParse
 {
@@ -51,11 +51,11 @@ namespace FileParse
 
         if(auto currentNode{findParentOfLastTag(node, vec.nodeNames)}; currentNode.has_value())
         {
-            for(int i = 0; i < currentNode.value().nChildNode(vec.nodeNames.back()); ++i)
+            const auto childNodes{currentNode.value().getChildNodesByName(vec.nodeNames.back())};
+            for(const auto & childNode : childNodes)
             {
-                NodeAdapter activeNode = currentNode.value().getChildNode(vec.nodeNames.back(), i);
                 T item;
-                activeNode >> item;
+                childNode >> item;
                 vec.data.insert(item);
             }
         }
@@ -164,15 +164,11 @@ namespace FileParse
 
         if(auto currentNode{findParentOfLastTag(node, tags)}; currentNode.has_value())
         {
-            int totalNodes = currentNode.value().nChildNode(tags.back());
-            for(int i = 0; i < totalNodes; ++i)
+            const auto childNodes{currentNode.value().getChildNodesByName(tags.back())};
+            for(const auto & childNode : childNodes)
             {
-                NodeAdapter childNode = currentNode.value().getChildNode(tags.back(), i);
-                if(!childNode.isEmpty())
-                {
-                    const auto text = childNode.getText();
-                    vec.insert(converter(text));
-                }
+                const auto text = childNode.getText();
+                vec.insert(converter(text));
             }
         }
 

src/FP_Optional.hxx renamed to include/fileParse/Optional.hxx

@@ -6,7 +6,7 @@
 
 #include <variant>
 
-#include "FP_Common.hxx"
+#include "Common.hxx"
 
 namespace FileParse
 {

src/FP_Set.hxx renamed to include/fileParse/Set.hxx

@@ -9,7 +9,7 @@
 #include <functional>
 #include <stdexcept>
 
-#include "FP_Common.hxx"
+#include "Common.hxx"
 
 namespace FileParse
 {
@@ -55,13 +55,12 @@ namespace FileParse
 
         if(auto currentNode{findParentOfLastTag(node, vec.nodeNames)}; currentNode.has_value())
         {
-            int childCount = currentNode.value().nChildNode(vec.nodeNames.back());
-            vec.data.reserve(childCount);
-            for(int i = 0; i < childCount; ++i)
+            const auto childNodes{currentNode.value().getChildNodesByName(vec.nodeNames.back())};
+            vec.data.reserve(childNodes.size());
+            for(const auto & childNode : childNodes)
             {
-                NodeAdapter activeNode = currentNode.value().getChildNode(vec.nodeNames.back(), i);
                 T item;
-                activeNode >> item;
+                childNode >> item;
                 vec.data.push_back(item);
             }
         }
@@ -95,7 +94,8 @@ namespace FileParse
     /// @tparam NodeAdapter The type of the node adapter.
     /// @tparam T The type of elements in the vector.
     /// @param node The node to serialize the optional vector into.
-    /// @param opt_vec The Child object containing the optional vector and node hierarchy information.
+    /// @param opt_vec The Child object containing the optional vector and node hierarchy
+    /// information.
     /// @return Reference to the updated node.
     template<typename NodeAdapter, typename T>
     inline NodeAdapter & operator<<(NodeAdapter & node,
@@ -170,15 +170,12 @@ namespace FileParse
 
         if(auto currentNode{findParentOfLastTag(node, tags)}; currentNode.has_value())
         {
-            int totalNodes = currentNode.value().nChildNode(tags.back());
-            for(int i = 0; i < totalNodes; ++i)
+            const auto childNodes{currentNode.value().getChildNodesByName(tags.back())};
+            vec.reserve(childNodes.size());
+            for(const auto & childNode : childNodes)
             {
-                NodeAdapter childNode = currentNode.value().getChildNode(tags.back(), i);
-                if(!childNode.isEmpty())
-                {
-                    const auto text = childNode.getText();
-                    vec.emplace_back(converter(text));
-                }
+                const auto text = childNode.getText();
+                vec.emplace_back(converter(text));
             }
         }