Created interface INameProvider. Moved functions getDefaultFunctionIdentifier() and getDefaultHeaderFile() from main.cpp to LegacyNameProvider.h.

Author: end2endzone

src/bin2cpp/CMakeLists.txt

@@ -21,6 +21,9 @@ add_executable(bin2cpp
   crc32.h
   enums.h
   IGenerator.h
+  INameProvider.h
+  LegacyNameProvider.cpp
+  LegacyNameProvider.h
   main.cpp
   ManagerGenerator.cpp
   ManagerGenerator.h

src/bin2cpp/INameProvider.h

@@ -0,0 +1,53 @@
+/**********************************************************************************
+ * 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 INAME_PROVIDER_H
+#define INAME_PROVIDER_H
+
+#include "types.h"
+ 
+namespace bin2cpp
+{
+
+  class INameProvider
+  {
+  public:
+
+    ///<summary>
+    ///Get the name of a function identifier based on a given file path.
+    ///</summary>
+    ///<param name="c">The new context.</param>
+    virtual std::string getDefaultFunctionIdentifier(const std::string & path, Dictionary & dict) = 0;
+
+    ///<summary>
+    ///Get the name of a function identifier based on a given file path.
+    ///</summary>
+    ///<param name="c">The new context.</param>
+    virtual std::string getDefaultHeaderFile(const std::string& path) = 0;
+
+  };
+  
+}; //bin2cpp
+
+#endif //INAME_PROVIDER_H

src/bin2cpp/LegacyNameProvider.cpp

@@ -0,0 +1,64 @@
+/**********************************************************************************
+ * 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 "LegacyNameProvider.h"
+
+#include "common.h"
+
+#include "rapidassist/strings.h"
+#include "rapidassist/filesystem.h"
+
+namespace bin2cpp
+{
+  LegacyNameProvider::LegacyNameProvider()
+  {
+  }
+
+  LegacyNameProvider::~LegacyNameProvider()
+  {
+  }
+
+  std::string LegacyNameProvider::getDefaultFunctionIdentifier(const std::string& path, Dictionary& dict)
+  {
+    std::string output;
+
+    //use the file name without extension as 'identifier'.
+    output = getUniqueFunctionIdentifierFromPath(path.c_str(), dict);
+    output = ra::strings::CapitalizeFirstCharacter(output);
+
+    return output;
+  }
+
+  std::string LegacyNameProvider::getDefaultHeaderFile(const std::string& path)
+  {
+    std::string output;
+
+    //use the file name without extension as 'headerfile'.
+    output = ra::filesystem::GetFilenameWithoutExtension(path.c_str());
+    output += ".h";
+
+    return output;
+  }
+
+}; //bin2cpp

src/bin2cpp/LegacyNameProvider.h

@@ -0,0 +1,48 @@
+/**********************************************************************************
+ * 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 LEGACYNAMEPROVIDER_H
+#define LEGACYNAMEPROVIDER_H
+
+#include "INameProvider.h"
+
+namespace bin2cpp
+{
+  ///<summary>
+  ///This is the legacy name generator which generates names for version 3.0.1 and before.
+  ///</summary>
+  class LegacyNameProvider : public virtual INameProvider
+  {
+  public:
+    LegacyNameProvider();
+    virtual ~LegacyNameProvider();
+
+    //INameProvider methods
+    virtual std::string getDefaultFunctionIdentifier(const std::string& path, Dictionary& dict);
+    virtual std::string getDefaultHeaderFile(const std::string& path);
+  };
+
+}; //bin2cpp
+
+#endif //LEGACYNAMEPROVIDER_H

src/bin2cpp/main.cpp

@@ -31,6 +31,8 @@
 #include "Win32ResourceGenerator.h"
 #include "ManagerGenerator.h"
 #include "Context.h"
+#include "INameProvider.h"
+#include "LegacyNameProvider.h"
 
 #include <stdlib.h>
 #include <stdio.h>
@@ -140,11 +142,9 @@ struct ARGUMENTS
 //pre-declarations
 bool generateOutputFile(const Context & c, const std::string & output_file_path, bin2cpp::IGenerator * generator);
 APP_ERROR_CODES processInputFile(const Context & c, bin2cpp::IGenerator * generator);
-APP_ERROR_CODES processInputDirectory(const Context & c, bin2cpp::IGenerator * generator);
+APP_ERROR_CODES processInputDirectory(const Context & c, bin2cpp::INameProvider* nameProvider, bin2cpp::IGenerator * generator);
 APP_ERROR_CODES processManagerFiles(const Context & c);
 APP_ERROR_CODES processPlainOutput(const Context & c, bin2cpp::IGenerator * generator);
-std::string getDefaultFunctionIdentifier(const Context & c, Dictionary & identifiers_dictionary);
-std::string getDefaultHeaderFile(const Context & c);
 
 void printHeader()
 {
@@ -230,7 +230,7 @@ int main(int argc, char* argv[])
   args.version = false;
 
   Context c;
-
+  INameProvider& nameProvider = LegacyNameProvider();
   std::string dummy;
 
   //help
@@ -344,14 +344,14 @@ int main(int argc, char* argv[])
     if (!ra::cli::ParseArgument("identifier", c.functionIdentifier, argc, argv))
     {
       //identifier is not manually specified.
-      c.functionIdentifier = getDefaultFunctionIdentifier(c, identifiers_dictionary);
+      c.functionIdentifier = nameProvider.getDefaultFunctionIdentifier(c.inputFilePath, identifiers_dictionary);
     }
 
     //headerfile
     if (!ra::cli::ParseArgument("headerfile", c.headerFilename, argc, argv))
     {
       //use the file name without extension as 'headerfile'.
-      c.headerFilename = getDefaultHeaderFile(c);
+      c.headerFilename = nameProvider.getDefaultHeaderFile(c.inputFilePath);
     }
   }
 
@@ -499,7 +499,7 @@ int main(int argc, char* argv[])
   }
   else if (c.hasInputDir)
   {
-    APP_ERROR_CODES error = processInputDirectory(c, generator);
+    APP_ERROR_CODES error = processInputDirectory(c, &nameProvider, generator);
     if (error != APP_ERROR_SUCCESS)
     {
       ra::logging::Log(ra::logging::LOG_ERROR, "%s.", getErrorCodeDescription(error));
@@ -521,28 +521,6 @@ int main(int argc, char* argv[])
   return APP_ERROR_SUCCESS;
 }
 
-std::string getDefaultFunctionIdentifier(const Context & c, Dictionary & identifiers_dictionary)
-{
-  std::string output;
-
-  //use the file name without extension as 'identifier'.
-  output = getUniqueFunctionIdentifierFromPath(c.inputFilePath.c_str(), identifiers_dictionary);
-  output = ra::strings::CapitalizeFirstCharacter(output);
-
-  return output;
-}
-
-std::string getDefaultHeaderFile(const Context & c)
-{
-  std::string output;
-
-  //use the file name without extension as 'headerfile'.
-  output = ra::filesystem::GetFilenameWithoutExtension(c.inputFilePath.c_str());
-  output += ".h";
-
-  return output;
-}
-
 APP_ERROR_CODES processInputFile(const Context & c, bin2cpp::IGenerator * generator)
 {
   // printing info
@@ -612,7 +590,7 @@ APP_ERROR_CODES processInputFile(const Context & c, bin2cpp::IGenerator * genera
   return APP_ERROR_SUCCESS;
 }
 
-APP_ERROR_CODES processInputDirectory(const Context& c, bin2cpp::IGenerator * generator)
+APP_ERROR_CODES processInputDirectory(const Context& c, bin2cpp::INameProvider * nameProvider, bin2cpp::IGenerator * generator)
 {
   //check if input dir exists
   if (!ra::filesystem::DirectoryExists(c.inputDirPath.c_str()))
@@ -680,10 +658,10 @@ APP_ERROR_CODES processInputDirectory(const Context& c, bin2cpp::IGenerator * ge
     cCopy.inputFilePath = file;
 
     //use the file name without extension as 'headerfile'.
-    cCopy.headerFilename = getDefaultHeaderFile(cCopy);
+    cCopy.headerFilename = nameProvider->getDefaultHeaderFile(cCopy.inputFilePath);
 
     //use the file name without extension as 'identifier'.
-    cCopy.functionIdentifier = getDefaultFunctionIdentifier(cCopy, identifiers_dictionary);
+    cCopy.functionIdentifier = nameProvider->getDefaultFunctionIdentifier(cCopy.inputFilePath, identifiers_dictionary);
 
     //build a relative file path
     std::string relative_file_path = file;