Simplified return values of IGenerator interface. Removed usage of ErrorCodes and replaced by a boolean value.

end2endzone · end2endzone · commit 98bf8e8e9cc2 · 2018-01-14T10:44:40.000-05:00
diff --git a/src/ArrayGenerator.cpp b/src/ArrayGenerator.cpp
@@ -25,12 +25,12 @@ namespace bin2cpp
     return "array";
   }
 
-  bin2cpp::ErrorCodes ArrayGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)
+  bool ArrayGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)
   {
     //check if input file exists
     FILE * input = fopen(iInputFilename, "rb");
     if (!input)
-      return bin2cpp::ErrorCodes::InputFileNotFound;
+      return false;
 
     //Uppercase function identifier
     std::string functionIdentifier = iFunctionIdentifier;
@@ -47,7 +47,7 @@ namespace bin2cpp
     if (!cpp)
     {
       fclose(input);
-      return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;
+      return false;
     }
 
     //determine file properties
@@ -137,7 +137,7 @@ namespace bin2cpp
     fclose(input);
     fclose(cpp);
 
-    return bin2cpp::ErrorCodes::Success;
+    return true;
   }
 
 }; //bin2cpp
diff --git a/src/ArrayGenerator.h b/src/ArrayGenerator.h
@@ -15,7 +15,7 @@ namespace bin2cpp
     ArrayGenerator();
     virtual ~ArrayGenerator();
     virtual const char * getName() const;
-    virtual bin2cpp::ErrorCodes createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize);
+    virtual bool createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize);
   };
 
 }; //bin2cpp
diff --git a/src/BaseGenerator.cpp b/src/BaseGenerator.cpp
@@ -77,11 +77,11 @@ namespace bin2cpp
     return output;
   }
 
-  bin2cpp::ErrorCodes BaseGenerator::createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier)
+  bool BaseGenerator::createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier)
   {
     FILE * header = fopen(iHeaderFilePath, "w");
     if (!header)
-      return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;
+      return false;
 
     std::string headercomments = getFileHeading(iInputFilename);
     fprintf(header, "%s", headercomments.c_str());
@@ -106,7 +106,7 @@ namespace bin2cpp
 
     fclose(header);
 
-    return bin2cpp::ErrorCodes::Success;
+    return true;
   }
 
 }; //bin2cpp
diff --git a/src/BaseGenerator.h b/src/BaseGenerator.h
@@ -15,7 +15,7 @@ namespace bin2cpp
     virtual ~BaseGenerator();
 
     //same header file for all generators
-    virtual bin2cpp::ErrorCodes createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier);
+    virtual bool createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier);
 
   protected:
     virtual std::string getGetterFunctionName(const char * iFunctionIdentifier);
diff --git a/src/IGenerator.h b/src/IGenerator.h
@@ -22,8 +22,8 @@ namespace bin2cpp
     ///<param name="iInputFilename">The path of the input file (resource) to embeded as a C++ source code.</param>
     ///<param name="iHeaderFilePath">The path of the header file (*.h) that is used for getting access to the functions.</param>
     ///<param name="iFunctionIdentifier">The unique identifier name for each data accessor functions.</param>
-    ///<returns>Returns an enum of type ErrorCodes which defines the results.</returns>
-    virtual bin2cpp::ErrorCodes createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier) = 0;
+    ///<returns>Returns true when the file was created. Returns false otherwise.</returns>
+    virtual bool createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier) = 0;
 
     ///<summary>
     ///Creates a cpp source file for embedding a given file into C++ source code.
@@ -32,8 +32,8 @@ namespace bin2cpp
     ///<param name="iCppFilePath">The path of the source file (*.cpp) that is used for getting access to the functions.</param>
     ///<param name="iFunctionIdentifier">The unique identifier name for each data accessor functions.</param>
     ///<param name="iChunkSize">The size in bytes of each chunk of data.</param>
-    ///<returns>Returns an enum of type ErrorCodes which defines the results.</returns>
-    virtual bin2cpp::ErrorCodes createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize) = 0;
+    ///<returns>Returns true when the file was created. Returns false otherwise.</returns>
+    virtual bool createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize) = 0;
   };
   
 }; //bin2cpp
diff --git a/src/SegmentGenerator.cpp b/src/SegmentGenerator.cpp
@@ -25,12 +25,12 @@ namespace bin2cpp
     return "segment";
   }
 
-  bin2cpp::ErrorCodes SegmentGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)
+  bool SegmentGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)
   {
     //check if input file exists
     FILE * input = fopen(iInputFilename, "rb");
     if (!input)
-      return bin2cpp::ErrorCodes::InputFileNotFound;
+      return false;
 
     //Uppercase function identifier
     std::string functionIdentifier = iFunctionIdentifier;
@@ -47,7 +47,7 @@ namespace bin2cpp
     if (!cpp)
     {
       fclose(input);
-      return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;
+      return false;
     }
 
     //determine file properties
@@ -127,7 +127,7 @@ namespace bin2cpp
     fclose(input);
     fclose(cpp);
 
-    return bin2cpp::ErrorCodes::Success;
+    return true;
   }
 
 }; //bin2cpp
diff --git a/src/SegmentGenerator.h b/src/SegmentGenerator.h
@@ -15,7 +15,7 @@ namespace bin2cpp
     SegmentGenerator();
     virtual ~SegmentGenerator();
     virtual const char * getName() const;
-    virtual bin2cpp::ErrorCodes createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize);
+    virtual bool createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize);
   };
 
 }; //bin2cpp
diff --git a/src/StringGenerator.cpp b/src/StringGenerator.cpp
@@ -25,12 +25,12 @@ namespace bin2cpp
     return "string";
   }
 
-  bin2cpp::ErrorCodes StringGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)
+  bool StringGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)
   {
     //check if input file exists
     FILE * input = fopen(iInputFilename, "rb");
     if (!input)
-      return bin2cpp::ErrorCodes::InputFileNotFound;
+      return false;
 
     //Uppercase function identifier
     std::string functionIdentifier = iFunctionIdentifier;
@@ -47,7 +47,7 @@ namespace bin2cpp
     if (!cpp)
     {
       fclose(input);
-      return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;
+      return false;
     }
 
     //determine file properties
@@ -136,7 +136,7 @@ namespace bin2cpp
     fclose(input);
     fclose(cpp);
 
-    return bin2cpp::ErrorCodes::Success;
+    return true;
   }
 
 }; //bin2cpp
diff --git a/src/StringGenerator.h b/src/StringGenerator.h
@@ -14,7 +14,7 @@ namespace bin2cpp
     StringGenerator();
     virtual ~StringGenerator();
     virtual const char * getName() const;
-    virtual bin2cpp::ErrorCodes createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize);
+    virtual bool createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize);
   };
 
 }; //bin2cpp
diff --git a/src/errorcodes.cpp b/src/errorcodes.cpp
@@ -58,12 +58,6 @@ namespace bin2cpp
     case bin2cpp::ErrorCodes::UnableToCreateOutputFiles:
       return "Unable to create output files";
       break;
-    case bin2cpp::ErrorCodes::OutputFileAlreadyExist:
-      return "Output file already exist";
-      break;
-    case bin2cpp::ErrorCodes::OutputFilesSkipped:
-      return "No change to input files. Skipping file generation";
-      break;
     };
     return "Unknown";
   }
diff --git a/src/errorcodes.h b/src/errorcodes.h
@@ -8,7 +8,7 @@ namespace bin2cpp
   class ErrorCodes
   {
   public:
-    enum Enum { Success, MissingArguments, InputFileNotFound, UnableToCreateOutputFiles, OutputFileAlreadyExist, OutputFilesSkipped };
+    enum Enum { Success, MissingArguments, InputFileNotFound, UnableToCreateOutputFiles };
 
     ErrorCodes(const ErrorCodes & iEnum);
     ErrorCodes(int iValue);
diff --git a/src/main.cpp b/src/main.cpp
@@ -26,7 +26,7 @@
 using namespace bin2cpp;
 
 //pre-declarations
-bin2cpp::ErrorCodes processFile(const std::string & inputFile, bin2cpp::IGenerator * generator, const std::string & functionIdentifier, const size_t & chunkSize, bool overrideExisting, const std::string & iOutputFilePath);
+bool processFile(const std::string & inputFile, bin2cpp::IGenerator * generator, const std::string & functionIdentifier, const size_t & chunkSize, bool overrideExisting, const std::string & iOutputFilePath);
 
 void printHeader()
 {
@@ -217,28 +217,18 @@ int main(int argc, char* argv[])
   std::string outputCppPath = outputFolder + "\\" + headerFilename;         bin2cpp::strReplace(outputCppPath, ".h", ".cpp");
   std::string cppFilename = headerFilename;                                 bin2cpp::strReplace(cppFilename, ".h", ".cpp");  
 
+  //check if input file exists
+  if (!bin2cpp::fileExists(inputFile.c_str()))
+    return bin2cpp::ErrorCodes::InputFileNotFound;
+
   //process files
-  bin2cpp::ErrorCodes headerResult = processFile(inputFile, generator, functionIdentifier, chunkSize, overrideExisting, outputHeaderPath);
-  switch(headerResult)
-  {
-  case bin2cpp::ErrorCodes::Success:
-  case bin2cpp::ErrorCodes::OutputFilesSkipped:
-    //ok
-    break;
-  default:
-    return headerResult;
-  };
+  bool headerResult = processFile(inputFile, generator, functionIdentifier, chunkSize, overrideExisting, outputHeaderPath);
+  if (!headerResult)
+    return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;
   
-  bin2cpp::ErrorCodes cppResult = processFile(inputFile, generator, functionIdentifier, chunkSize, overrideExisting, outputCppPath);
-  switch(cppResult)
-  {
-  case bin2cpp::ErrorCodes::Success:
-  case bin2cpp::ErrorCodes::OutputFilesSkipped:
-    //ok
-    break;
-  default:
-    return cppResult;
-  };
+  bool cppResult = processFile(inputFile, generator, functionIdentifier, chunkSize, overrideExisting, outputCppPath);
+  if (!cppResult)
+    return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;
 
   //success
   return bin2cpp::ErrorCodes::Success;
@@ -290,18 +280,18 @@ const char * getUpdateModeText(const FILE_UPDATE_MODE & iMode)
   };
 }
 
-bin2cpp::ErrorCodes processFile(const std::string & inputFile, bin2cpp::IGenerator * generator, const std::string & functionIdentifier, const size_t & chunkSize, bool overrideExisting, const std::string & iOutputFilePath)
+bool processFile(const std::string & inputFile, bin2cpp::IGenerator * generator, const std::string & functionIdentifier, const size_t & chunkSize, bool overrideExisting, const std::string & iOutputFilePath)
 {
   FILE_UPDATE_MODE mode = getFileUpdateMode(inputFile, iOutputFilePath, overrideExisting);
 
   //writing message
   bin2cpp::log(bin2cpp::LOG_INFO, "%s file \"%s\"...", getUpdateModeText(mode), iOutputFilePath.c_str());
   
   if (mode == SKIPPING)
-    return bin2cpp::ErrorCodes::OutputFilesSkipped;
+    return true; //skipping is success
 
   //generate file
-  bin2cpp::ErrorCodes result = bin2cpp::ErrorCodes::Success;
+  bool result = false;
   if (isCppHeaderFile(iOutputFilePath))
   {
     //generate header
@@ -312,17 +302,11 @@ bin2cpp::ErrorCodes processFile(const std::string & inputFile, bin2cpp::IGenerat
     //generate cpp
     result = generator->createCppSourceFile(inputFile.c_str(), iOutputFilePath.c_str(), functionIdentifier.c_str(), chunkSize);
   }
-  if (result == bin2cpp::ErrorCodes::Success ||
-      result == bin2cpp::ErrorCodes::OutputFilesSkipped)
-  {
-    //OK
-    return bin2cpp::ErrorCodes::Success;
-  }
-  else
+  if (!result)
   {
     //there was an error generating file
     bin2cpp::log(bin2cpp::LOG_ERROR, "%s", getErrorCodeDescription(result));
     bin2cpp::log(bin2cpp::LOG_ERROR, "Embedding failed!");
-    return result;
   }
+  return result;
 }

Original file line number	Diff line number	Diff line change
`@@ -25,12 +25,12 @@ namespace bin2cpp`
`25`	`25`	`return "array";`
`26`	`26`	`}`
`27`	`27`
`28`		`- bin2cpp::ErrorCodes ArrayGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)`
	`28`	`+ bool ArrayGenerator::createCppSourceFile(const char * iInputFilename, const char * iCppFilePath, const char * iFunctionIdentifier, size_t iChunkSize)`
`29`	`29`	`{`
`30`	`30`	`//check if input file exists`
`31`	`31`	`FILE * input = fopen(iInputFilename, "rb");`
`32`	`32`	`if (!input)`
`33`		`- return bin2cpp::ErrorCodes::InputFileNotFound;`
	`33`	`+ return false;`
`34`	`34`
`35`	`35`	`//Uppercase function identifier`
`36`	`36`	`std::string functionIdentifier = iFunctionIdentifier;`
`@@ -47,7 +47,7 @@ namespace bin2cpp`
`47`	`47`	`if (!cpp)`
`48`	`48`	`{`
`49`	`49`	`fclose(input);`
`50`		`- return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;`
	`50`	`+ return false;`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`//determine file properties`
`@@ -137,7 +137,7 @@ namespace bin2cpp`
`137`	`137`	`fclose(input);`
`138`	`138`	`fclose(cpp);`
`139`	`139`
`140`		`- return bin2cpp::ErrorCodes::Success;`
	`140`	`+ return true;`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`}; //bin2cpp`
Original file line number	Diff line number	Diff line change
`@@ -77,11 +77,11 @@ namespace bin2cpp`
`77`	`77`	`return output;`
`78`	`78`	`}`
`79`	`79`
`80`		`- bin2cpp::ErrorCodes BaseGenerator::createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier)`
	`80`	`+ bool BaseGenerator::createCppHeaderFile(const char * iInputFilename, const char * iHeaderFilePath, const char * iFunctionIdentifier)`
`81`	`81`	`{`
`82`	`82`	`FILE * header = fopen(iHeaderFilePath, "w");`
`83`	`83`	`if (!header)`
`84`		`- return bin2cpp::ErrorCodes::UnableToCreateOutputFiles;`
	`84`	`+ return false;`
`85`	`85`
`86`	`86`	`std::string headercomments = getFileHeading(iInputFilename);`
`87`	`87`	`fprintf(header, "%s", headercomments.c_str());`
`@@ -106,7 +106,7 @@ namespace bin2cpp`
`106`	`106`
`107`	`107`	`fclose(header);`
`108`	`108`
`109`		`- return bin2cpp::ErrorCodes::Success;`
	`109`	`+ return true;`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`}; //bin2cpp`