EmbedFile Tool: Added comments to EmbedFile tool used to create a portable embedded resources for C++ applications.

J. Ritchie Carroll committed 7 years ago

Commit 4d1a1af1 parent 948fa611 file · +44 −12Browse files

Showing the changes to Source/Tools/EmbedFile/EmbedFile.cpp (1 of 1 file). Show all

Unified · Split

Source/Tools/EmbedFile/EmbedFile.cpp+44−12

-// EmbedFile.cpp : This file contains the 'main' function. Program execution begins and ends there.
+//******************************************************************************************************
+//  EmbedFile.cpp - Gbtc
 //
+//  Copyright � 2019, Grid Protection Alliance.  All Rights Reserved.
+//
+//  Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See
+//  the NOTICE file distributed with this work for additional information regarding copyright ownership.
+//  The GPA licenses this file to you under the MIT License (MIT), the "License"; you may not use this
+//  file except in compliance with the License. You may obtain a copy of the License at:
+//
+//      http://opensource.org/licenses/MIT
+//
+//  Unless agreed to in writing, the subject software distributed under the License is distributed on an
+//  "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the
+//  License for the specific language governing permissions and limitations.
+//
+//  Code Modification History:
+//  ----------------------------------------------------------------------------------------------------
+//  02/02/2019 - J. Ritchie Carrikk
+//       Generated original version of source code.
+//
+//******************************************************************************************************
+/*
+ * This application is used to create a portable embedded resource for a C++ application.
+ * The program will take the file name specified as a command line argument and turn it
+ * into a byte array where the array is declared in a .H file and defined in a .CPP file.
+ */
 #include "pch.h"
 FILE* open_or_exit(const char* fname, const char* mode)
 {
     FILE* f;
-    errno_t err;
-    if ((err = fopen_s(&f, fname, mode)) != 0) {
+    if (fopen_s(&f, fname, mode) != 0) {
         perror(fname);
         exit(EXIT_FAILURE);
     }
     return f;
 }
-void write_byte(FILE* out, int32_t& chars, bool& first, unsigned char value)
+void write_byte(FILE* out, int32_t& chars, unsigned char value)
 {
     if (chars++ % 10 == 0)
     {
-        if (!first)
+        if (chars > 1)
             fprintf(out, ",");
         fprintf(out, "\n    ");
     }
     fprintf(out, "0x%02X", value);
-    first = false;
 }
 int main(int argc, char** argv)
 {
     if (argc < 3) {
         fprintf(stderr, "USAGE: %s {sym} {rsrc} [{namespace}] [addnull]\n\n"
-            "  Creates {sym}.cpp from the contents of {rsrc}\n",
+            "  Creates {sym}.cpp/.h from the contents of {rsrc}\n",
             argv[0]);
         return EXIT_FAILURE;
     }
     const char* sym = argv[1];
     FILE* in = open_or_exit(argv[2], "r");
-    char empty[1] = "";
     const char* prefix = "";
     bool addNullByte = false;
+    // Third argument is optional C++ namespace prefix
     if (argc > 3)
         prefix = argv[3];
+    // Fourth argument is optional command to add a null byte to resource
     if (argc > 4)
         addNullByte = _strcmpi(argv[4], "addnull") == 0;
+    // Create .H resource file
     char symfile[256];
     snprintf(symfile, sizeof(symfile), "%s.h", sym);
     FILE* out = open_or_exit(symfile,"w");
+    // Define #ifdef directive symbol used to include header file only once
     char symdirective[256];
     const char* s = sym;
     char* d = symdirective;
     localtime_s(&timeinfo, &rawtime);
     asctime_s(now, 256, &timeinfo);
+    // Write header for .H resource file
     fprintf(out, "// Auto-generated on %s", now);
     fprintf(out, "// EmbedFile.exe %s %s %s%s\n\n", sym, argv[2], prefix, addNullByte ? " addnull" : "");
     fprintf(out, "#ifndef %s\n", symdirective);
     if (strlen(prefix) > 0)
     {
+        // When a C++ namespace prefix is provided, break each namespace
+        // component out into separate namespace commands for the .H file
         char source[256];
         strcpy_s(source, 256, prefix);
     fprintf(out, "\n\n#endif\n");
     fclose(out);
+    // Create .CPP resource file
     snprintf(symfile, sizeof(symfile), "%s.cpp", sym);
     out = open_or_exit(symfile,"w");
+    // Write header for .CPP resource file
     fprintf(out, "// Auto-generated on %s", now);
     fprintf(out, "// EmbedFile.exe %s %s %s%s\n\n", sym, argv[2], prefix, addNullByte ? " addnull" : "");
     fprintf(out, "#include \"%s.h\"\n\n", sym);
     fprintf(out, "const uint8_t %s%s[] = {", prefix, sym);
     unsigned char buf[256];
-    size_t nread = 0;
+    size_t nread;
     int32_t chars = 0;
-    bool first = true;
+    // Write resource bytes
     do
     {
         nread = fread(buf, 1, sizeof(buf), in);
         size_t i;
         for (i = 0; i < nread; i++)
-            write_byte(out, chars, first, buf[i]);
+            write_byte(out, chars, buf[i]);
     }
     while (nread > 0);
     // Write NULL as last character, if requested
     if (addNullByte)
-        write_byte(out, chars, first, '\0');
+        write_byte(out, chars, '\0');
     fprintf(out, "\n};\n\n");
     fprintf(out, "const uint32_t %s%sLength = sizeof(%s%s);\n", prefix, sym, prefix, sym);

EmbedFile Tool: Added comments to EmbedFile tool used to create a portable embedded resources for C++ applications.

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code