Get ready for cpp files

Author: Andres Sevillano

include/boilerplateCodeDoc.h

@@ -63,9 +63,9 @@ namespace boilerplateCodeDoc {
       /// @remark Although needed by another class, it's very handy to grab that piece of info here
       std::string namespace_id {};
 
-      /// @brief Expected C++ header file name to save automatically generated code
+      /// @brief Expected C++ h/cpp file name to save automatically generated code
       /// @remark Although needed by another class, it's very handy to grab that piece of info here
-      std::string header_filename {};
+      std::string cpp_filename {};
     };
 
 
@@ -178,9 +178,9 @@ namespace boilerplateCodeDoc {
       std::string css_class {};
     };
 
-     /// @brief Specific handler to generate HTML tables.
-    /// @remark Style will be provided by CSS if needed.
-    struct JsonSchema2CPP final: public JsonSchemaFilter {
+     /// @brief Specific handler to generate cpp header.
+    /// @remark Working in sync with JsonSchema2CPP.
+    struct JsonSchema2H final: public JsonSchemaFilter {
 
       ///@brief namespace to isolate autogenerated code
       /// @remark to be used as extra parameter
@@ -204,13 +204,43 @@ namespace boilerplateCodeDoc {
       // TODO
       static constexpr const char* const FOOTER {"\n\n// END: automatically generated code\n"};
 
+      ///@brief simplest constructor
+      JsonSchema2H(std::string extra_ = NAMESPACE, std::string header_ = HEADER, std::string footer_ = FOOTER) :
+	      JsonSchemaFilter(extra_, header_, footer_) {}
+
+      ///@brief filter to apply
+      bool operator()(const JsonSchema& jsonSchema) override;
+    };
+
+    /// @brief Specific handler to generate cpp file.
+    /// @remark Working in sync with JsonSchema2H.
+    struct JsonSchema2CPP final: public JsonSchemaFilter {
+
+      ///@brief namespace to isolate autogenerated code
+      /// @remark to be used as extra parameter
+      static constexpr const char* const NAMESPACE {"boilerplateExample"};
+
+      // Expected to be added the name of the file
+      // /** @file XXXXXXX.cpp
+      static constexpr const char* const HEADER {R"(
+	* @brief Example of automatically generated code.
+	*
+	* @bug Abuse of JSON Schema validation leads to crushes if an invalid json is queried (missing redundant checks to speed up).
+	*
+	*/
+       )"};
+
+      // TODO
+      static constexpr const char* const FOOTER {"\n\n// END: automatically generated code\n"};
+
       ///@brief simplest constructor
       JsonSchema2CPP(std::string extra_ = NAMESPACE, std::string header_ = HEADER, std::string footer_ = FOOTER) :
 	      JsonSchemaFilter(extra_, header_, footer_) {}
 
       ///@brief filter to apply
       bool operator()(const JsonSchema& jsonSchema) override;
     };
+
 } // namespace
 
 #endif // header

json/schema.json

@@ -4,7 +4,7 @@
   "description": "version 0.0.1",
   "type": "object",
   "namespace": "boilerplate::Example",
-  "headerFileName": "boilerplateExample.h",
+  "cppFileName": "boilerplateExample",
   "cssClass": "boilerplateExample",
   "metatype": "struct Data",
   "properties": {

src/boilerplateCodeDoc.cpp

@@ -115,8 +115,8 @@ boilerplateCodeDoc::JsonSchema::JsonSchema(std::string filename)
 			     if( document.HasMember("cssClass") ) {
 				      css_class = document["cssClass"].GetString();
 			      }
-			     if( document.HasMember("headerFileName") ) {
-				      header_filename = document["headerFileName"].GetString();
+			     if( document.HasMember("cppFileName") ) {
+				      cpp_filename = document["cppFileName"].GetString();
 			      }
 
 			     error = boilerplateCodeDoc::ParseErrorCode::OK;
@@ -445,9 +445,9 @@ return boilerplateOperator(jsonSchema, *this, jsonSchema.css_class, [](const Pro
 /****************************************************************************************/
 /****************************************************************************************/
 
-bool boilerplateCodeDoc::JsonSchema2CPP::operator()(const boilerplateCodeDoc::JsonSchema& jsonSchema)
+bool boilerplateCodeDoc::JsonSchema2H::operator()(const boilerplateCodeDoc::JsonSchema& jsonSchema)
 {
-if( not jsonSchema.header_filename.empty() && not header.empty() ) { header = "/** @file " + jsonSchema.header_filename + header; }
+if( not jsonSchema.cpp_filename.empty() && not header.empty() ) { header = "/** @file " + jsonSchema.cpp_filename + ".h" + header; }
 return boilerplateOperator(jsonSchema, *this, jsonSchema.namespace_id, [](const Properties& properties, std::string& filtered, std::string& namespace_id) {
 
   if(properties.size() > 0) {
@@ -492,3 +492,60 @@ return boilerplateOperator(jsonSchema, *this, jsonSchema.namespace_id, [](const
 
 }); // return boilerplateOperator
 } // operator()
+
+/****************************************************************************************/
+/****************************************************************************************/
+/****************************************************************************************/
+/*********************** ACTUAL LOGIC CODE **********************************************/
+/****************************************************************************************/
+/****************************************************************************************/
+/****************************************************************************************/
+
+bool boilerplateCodeDoc::JsonSchema2CPP::operator()(const boilerplateCodeDoc::JsonSchema& jsonSchema)
+{
+if( not jsonSchema.cpp_filename.empty() && not header.empty() ) { header = "/** @file " + jsonSchema.cpp_filename + ".cpp" + header; }
+return boilerplateOperator(jsonSchema, *this, jsonSchema.namespace_id, [](const Properties& properties, std::string& filtered, std::string& namespace_id) {
+
+	/*
+  if(properties.size() > 0) {
+
+    // supposed metatype is a must
+    std::string parentMetatype {};
+    parentMetatype = properties.begin()->second.parentMetatype;
+    if( parentMetatype.empty() ) { return; } // required
+
+    // if nothing is implemented, do nothing
+    bool nothing_implemented {true};
+    for(const auto& p : properties) {
+	if( implemented(p.second.metainfo) ) { nothing_implemented = false; break; }
+    }
+    if( nothing_implemented ) {
+	    filtered = "\n// " + parentMetatype + ": all their properties are not implemented\n\n" + filtered;
+	    return;
+    }
+
+    std::string addition {};
+    if( not namespace_id.empty() ) { addition += "namespace " + namespace_id + " {\n"; }
+    addition += "\n" + parentMetatype + " {\n\n";
+
+    for(const auto& p : properties) {
+
+	    if( not implemented(p.second.metainfo) ) { addition += "// " + p.second.name + ": " + p.second.metainfo + "\n"; continue; }
+
+	    std::string metatype {p.second.metatype};
+	    if( metatype.empty() ) { continue; } // required
+	    std::string name {p.second.name};
+	    if( name.empty() ) { continue; } // required
+
+	    if( not p.second.description.empty() ) { addition += "///@ brief " + p.second.description + "\n"; }
+	    addition += metatype + " " + name + " {};\n";
+    }
+
+    addition += "\n}; // " + parentMetatype + "\n";
+    if( not namespace_id.empty() ) { addition += "\n} // namespace " + namespace_id + "\n\n"; }
+
+    filtered = addition + filtered;
+  }
+*/
+}); // return boilerplateOperator
+} // operator()

src/tool.cpp

@@ -45,16 +45,16 @@ int main(int argc, char** argv)
 
    std::string schema{argv[1]};
    std::string html{argv[2]};
-   std::string cpp{argv[3]};
+   std::string h{argv[3]};
 
    JsonSchema jsonSchema{schema};
    if(jsonSchema.error != ParseErrorCode::OK) { std::cout << jsonSchema.message << std::endl; return 1; }
 
-   JsonSchema2CPP cppFilter{};
-   bool resultCPP = processFilter(jsonSchema, cpp, cppFilter);
+   JsonSchema2H hFilter{};
+   bool resultH = processFilter(jsonSchema, h, hFilter);
 
    JsonSchema2HTML htmlFilter{};
    bool resultHTML = processFilter(jsonSchema, html, htmlFilter);
 
-   return (resultCPP && resultHTML) ? 0 : 1;
+   return (resultH && resultHTML) ? 0 : 1;
 }

test/main.cpp

@@ -155,7 +155,34 @@ BOOST_AUTO_TEST_CASE( test002 ) {
 }
 
 BOOST_AUTO_TEST_CASE( test003 ) {
-   BOOST_TEST_MESSAGE( "\ntest003: Transform external Json Schema into C++ structure");
+   BOOST_TEST_MESSAGE( "\ntest003: Transform external Json Schema into C++ structure header");
+
+   // taken for granted that CMake copied default json schema file in the very directory where this test binary is generated
+   std::string filename{"schema.json"};
+   std::string binary{boost::unit_test::framework::master_test_suite().argv[0]};
+   size_t found = binary.find_last_of("/\\");
+   if( found > 0 ) {
+	BOOST_TEST_MESSAGE( "found=" << found);
+	filename = binary.substr(0,found+1) + filename;
+   }
+
+   int argc =boost::unit_test::framework::master_test_suite().argc;
+   if( argc > 1) {
+	filename = std::string(boost::unit_test::framework::master_test_suite().argv[1]);
+   }
+   BOOST_TEST_MESSAGE( "current binary=" << binary );
+   BOOST_TEST_MESSAGE( "schema.json=" << filename );
+
+   boiler::JsonSchema jsonSchema{filename};
+   BOOST_TEST_MESSAGE( "Json Schema: " << jsonSchema.message);
+   boiler::JsonSchema2H handler {};
+   bool result = handler(jsonSchema);
+   BOOST_TEST_MESSAGE( "JsonSchema2H: " << handler.message << "\n\n" << handler.filtered);
+   BOOST_CHECK( result );
+}
+
+BOOST_AUTO_TEST_CASE( test004 ) {
+   BOOST_TEST_MESSAGE( "\ntest004: Transform external Json Schema into C++ structure file");
 
    // taken for granted that CMake copied default json schema file in the very directory where this test binary is generated
    std::string filename{"schema.json"};
@@ -180,3 +207,4 @@ BOOST_AUTO_TEST_CASE( test003 ) {
    BOOST_TEST_MESSAGE( "JsonSchema2CPP: " << handler.message << "\n\n" << handler.filtered);
    BOOST_CHECK( result );
 }
+