Implemented ITemplateVariableLookup and TemplateProcessor classes for processing code generation from templates.

end2endzone · end2endzone · commit 8b1d3b864a36 · 2025-05-22T21:30:52.000-04:00
diff --git a/src/bin2cpp/CMakeLists.txt b/src/bin2cpp/CMakeLists.txt
@@ -22,6 +22,7 @@ add_executable(bin2cpp
   enums.h
   IGenerator.h
   INameProvider.h
+  ITemplateVariableLookup.h
   LegacyNameProvider.cpp
   LegacyNameProvider.h
   main.cpp
@@ -31,6 +32,8 @@ add_executable(bin2cpp
   SegmentGenerator.h
   StringGenerator.cpp
   StringGenerator.h
+  TemplateProcessor.cpp
+  TemplateProcessor.h
   types.h
   wildcard.cpp
   wildcard.h
diff --git a/src/bin2cpp/ITemplateVariableLookup.h b/src/bin2cpp/ITemplateVariableLookup.h
@@ -0,0 +1,50 @@
+/**********************************************************************************
+ * MIT License
+ * 
+ * Copyright (c) 2018 Antoine Beauchamp
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#ifndef ITEMPLATE_VARIABLE_LOOKUP_H
+#define ITEMPLATE_VARIABLE_LOOKUP_H
+
+#include <string>
+ 
+namespace bin2cpp
+{
+
+  class ITemplateVariableLookup
+  {
+  public:
+    virtual ~ITemplateVariableLookup()
+    {}
+
+    ///<summary>
+    ///Look up the value for a given template variable name.
+    ///</summary>
+    ///<param name="name">The name of the template variable.</param>
+    ///<return>Returns the value of the template variable. Returns an empty string if unknown.<return>
+    virtual std::string lookupTemplateVariable(const std::string& name) = 0;
+
+  };
+  
+}; //bin2cpp
+
+#endif //ITEMPLATE_VARIABLE_LOOKUP_H
diff --git a/src/bin2cpp/TemplateProcessor.cpp b/src/bin2cpp/TemplateProcessor.cpp
@@ -0,0 +1,133 @@
+/**********************************************************************************
+ * MIT License
+ * 
+ * Copyright (c) 2018 Antoine Beauchamp
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#include "TemplateProcessor.h"
+#include <fstream>
+#include <sstream>
+
+namespace bin2cpp
+{
+  TemplateProcessor::TemplateProcessor()
+  {
+    reset();
+  }
+
+  TemplateProcessor::~TemplateProcessor()
+  {
+  }
+
+  void TemplateProcessor::reset()
+  {
+    mTemplateText = NULL;
+    mVariableLookup = NULL;
+  }
+
+  void TemplateProcessor::setTemplateText(const std::string* value)
+  {
+    mTemplateText = value;
+  }
+
+  const std::string* TemplateProcessor::getTemplateText() const
+  {
+    return mTemplateText;
+  }
+
+  void TemplateProcessor::setTemplateVariableLookup(ITemplateVariableLookup* lookup)
+  {
+    mVariableLookup = lookup;
+  }
+
+  ITemplateVariableLookup* TemplateProcessor::getTemplateVariableLookup() const
+  {
+    return mVariableLookup;
+  }
+
+  void TemplateProcessor::writeString(std::string& output)
+  {
+    std::ostringstream output_stream;
+    std::set<std::string> recursion_history;
+    processTemplate(output_stream, *mTemplateText, recursion_history);
+    output = output_stream.str();
+  }
+
+  bool TemplateProcessor::writeFile(const std::string& file_path)
+  {
+    std::ofstream output_file(file_path);
+    if ( !output_file.is_open() ) return false;
+
+    std::set<std::string> recursion_history;
+    processTemplate(output_file, *mTemplateText, recursion_history);
+    return true;
+  }
+
+  //-------------------------------
+  //protected methods
+  //-------------------------------
+
+  void TemplateProcessor::processTemplate(std::ostream& output_stream, const std::string& value, std::set<std::string>& recursion_history)
+  {
+    size_t pos = 0;
+    while ( pos < value.size() )
+    {
+      if ( value[pos] == '$' && pos + 1 < value.size() && value[pos + 1] == '{' )
+      {
+        size_t end_pos = value.find('}', pos);
+        if ( end_pos != std::string::npos )
+        {
+          std::string variable_name = value.substr(pos + 2, end_pos - pos - 2);
+
+          // Detect actual circular dependency within same recursion path
+          if ( recursion_history.find(variable_name) != recursion_history.end() )
+          {
+            pos = end_pos + 1;
+            continue;
+          }
+
+          // Do the variable expansion
+          std::string expanded_value = mVariableLookup ? mVariableLookup->lookupTemplateVariable(variable_name) : "";
+
+          // Add variable to recursion history before expanding
+          recursion_history.insert(variable_name);
+
+          // Recursively process expanded value with updated recursion tracking
+          processTemplate(output_stream, expanded_value, recursion_history);
+
+          // Remove variable from recursion history after recursion returns
+          recursion_history.erase(variable_name);
+
+          pos = end_pos + 1;
+        }
+        else
+        {
+          output_stream.put(value[pos++]);
+        }
+      }
+      else
+      {
+        output_stream.put(value[pos++]);
+      }
+    }
+  }
+
+}; //bin2cpp
diff --git a/src/bin2cpp/TemplateProcessor.h b/src/bin2cpp/TemplateProcessor.h
@@ -0,0 +1,65 @@
+/**********************************************************************************
+ * MIT License
+ * 
+ * Copyright (c) 2018 Antoine Beauchamp
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#ifndef TEMPLATEPROCESSOR_H
+#define TEMPLATEPROCESSOR_H
+
+#include <string>
+#include <set>
+#include "ITemplateVariableLookup.h"
+
+namespace bin2cpp
+{
+
+  ///<summary>
+  ///A class for processing a template containing template markers variables
+  ///and replace those to their actual values.
+  ///</summary>
+  class TemplateProcessor
+  {
+  public:
+    TemplateProcessor();
+    virtual ~TemplateProcessor();
+    virtual void reset();
+
+    void setTemplateText(const std::string* value);
+    const std::string* getTemplateText() const;
+
+    void setTemplateVariableLookup(ITemplateVariableLookup* lookup);
+    ITemplateVariableLookup* getTemplateVariableLookup() const;
+
+    virtual void writeString(std::string& output);
+    virtual bool writeFile(const std::string& file_path);
+
+  protected:
+    virtual void processTemplate(std::ostream& output_stream, const std::string& value, std::set<std::string>& recursion_history);
+
+    //attributes
+    const std::string* mTemplateText;
+    ITemplateVariableLookup* mVariableLookup;
+  };
+
+}; //bin2cpp
+
+#endif //TEMPLATEPROCESSOR_H
diff --git a/test/bin2cpp_unittest/CMakeLists.txt b/test/bin2cpp_unittest/CMakeLists.txt
@@ -285,6 +285,9 @@ source_group("External Files" FILES
   ${CMAKE_SOURCE_DIR}/src/bin2cpp/common.h
   ${CMAKE_SOURCE_DIR}/src/bin2cpp/wildcard.cpp
   ${CMAKE_SOURCE_DIR}/src/bin2cpp/wildcard.h
+  ${CMAKE_SOURCE_DIR}/src/bin2cpp/ITemplateVariableLookup.h
+  ${CMAKE_SOURCE_DIR}/src/bin2cpp/TemplateProcessor.cpp
+  ${CMAKE_SOURCE_DIR}/src/bin2cpp/TemplateProcessor.h
 )
 
 # Ensure source files are properly recognized as generated
@@ -297,6 +300,9 @@ add_executable(bin2cpp_unittest
   ${CMAKE_SOURCE_DIR}/src/bin2cpp/common.h
   ${CMAKE_SOURCE_DIR}/src/bin2cpp/wildcard.cpp
   ${CMAKE_SOURCE_DIR}/src/bin2cpp/wildcard.h
+  ${CMAKE_SOURCE_DIR}/src/bin2cpp/ITemplateVariableLookup.h
+  ${CMAKE_SOURCE_DIR}/src/bin2cpp/TemplateProcessor.cpp
+  ${CMAKE_SOURCE_DIR}/src/bin2cpp/TemplateProcessor.h
   application.cpp
   application.h
   CMakeLists.txt
@@ -310,6 +316,8 @@ add_executable(bin2cpp_unittest
   TestCommon.h
   TestExtraction.cpp
   TestExtraction.h
+  TestTemplateProcessor.cpp
+  TestTemplateProcessor.h
   TestWildcard.cpp
   TestWildcard.h
   ${GENERATED_TEST_FILES}
diff --git a/test/bin2cpp_unittest/TestTemplateProcessor.cpp b/test/bin2cpp_unittest/TestTemplateProcessor.cpp
diff --git a/test/bin2cpp_unittest/TestTemplateProcessor.h b/test/bin2cpp_unittest/TestTemplateProcessor.h
