Exclude some files and directories by default, add flag to include them

By default, don't add the following to the archive:

- .DS_Store files
- .git directories, .gitignore and .gitmodules files

Add new flag, -a/--all-files, which forces such files/directories to be
included anyway.

Author: igrr

Makefile

@@ -81,12 +81,19 @@ clean:
 SPIFFS_TEST_FS_CONFIG := -s 0x100000 -p 512 -b 0x2000
 
 test: $(TARGET)
+	rm -rf spiffs/.git
+	rm -f spiffs/.DS_Store
 	ls -1 spiffs > out.list0
+	touch spiffs/.DS_Store
+	mkdir -p spiffs/.git
+	touch spiffs/.git/foo
 	./mkspiffs -c spiffs $(SPIFFS_TEST_FS_CONFIG) out.spiffs | sort | sed s/^\\/// > out.list1
 	./mkspiffs -u spiffs_u $(SPIFFS_TEST_FS_CONFIG) out.spiffs | sort | sed s/^\\/// > out.list_u
 	./mkspiffs -l $(SPIFFS_TEST_FS_CONFIG) out.spiffs | cut -f 2 | sort | sed s/^\\/// > out.list2
 	diff --strip-trailing-cr out.list0 out.list1
 	diff --strip-trailing-cr out.list0 out.list2
+	rm -rf spiffs/.git
+	rm -f spiffs/.DS_Store
 	diff spiffs spiffs_u
 	rm -f out.{list0,list1,list2,list_u,spiffs}
 	rm -R spiffs_u

main.cpp

@@ -38,6 +38,16 @@ static std::vector<uint8_t> s_spiffsWorkBuf;
 static std::vector<uint8_t> s_spiffsFds;
 static std::vector<uint8_t> s_spiffsCache;
 
+static int s_debugLevel = 0;
+static bool s_addAllFiles;
+
+// Unless -a flag is given, these files/directories will not be included into the image
+static const char* ignored_file_names[] = {
+    ".DS_Store",
+    ".git",
+    ".gitignore",
+    ".gitmodules"
+};
 
 static s32_t api_spiffs_read(u32_t addr, u32_t size, u8_t *dst){
     memcpy(dst, &s_flashmem[0] + addr, size);
@@ -55,7 +65,6 @@ static s32_t api_spiffs_erase(u32_t addr, u32_t size){
 }
 
 
-int g_debugLevel = 0;
 
 
 //implementation
@@ -121,7 +130,7 @@ int addFile(char* name, const char* path) {
     size_t size = ftell(src);
     fseek(src, 0, SEEK_SET);
 
-    if (g_debugLevel > 0) {
+    if (s_debugLevel > 0) {
         std::cout << "file size: " << size << std::endl;
     }
 
@@ -146,7 +155,7 @@ int addFile(char* name, const char* path) {
             }
             std::cerr << std::endl;
 
-            if (g_debugLevel > 0) {
+            if (s_debugLevel > 0) {
                 std::cout << "data left: " << left << std::endl;
             }
 
@@ -181,6 +190,21 @@ int addFiles(const char* dirname, const char* subPath) {
                 continue;
             }
 
+            if (!s_addAllFiles) {
+                bool skip = false;
+                size_t ignored_file_names_count = sizeof(ignored_file_names) / sizeof(ignored_file_names[0]);
+                for (size_t i = 0; i < ignored_file_names_count; ++i) {
+                    if (strcmp(ent->d_name, ignored_file_names[i]) == 0) {
+                        std::cerr << "skipping " << ent->d_name << std::endl;
+                        skip = true;
+                        break;
+                    }
+                }
+                if (skip) {
+                    continue;
+                }
+            }
+
             std::string fullpath = dirPath;
             fullpath += ent->d_name;
             struct stat path_stat;
@@ -217,7 +241,7 @@ int addFiles(const char* dirname, const char* subPath) {
             if (addFile((char*)filepath.c_str(), fullpath.c_str()) != 0) {
                 std::cerr << "error adding file!" << std::endl;
                 error = true;
-                if (g_debugLevel > 0) {
+                if (s_debugLevel > 0) {
                     std::cout << std::endl;
                 }
                 break;
@@ -516,20 +540,22 @@ void processArgs(int argc, const char** argv) {
     TCLAP::ValueArg<int> imageSizeArg( "s", "size", "fs image size, in bytes", false, 0x10000, "number" );
     TCLAP::ValueArg<int> pageSizeArg( "p", "page", "fs page size, in bytes", false, 256, "number" );
     TCLAP::ValueArg<int> blockSizeArg( "b", "block", "fs block size, in bytes", false, 4096, "number" );
+    TCLAP::SwitchArg addAllFilesArg( "a", "all-files", "when creating an image, include files which are normally ignored; currently only applies to '.DS_Store' files and '.git' directories", false);
     TCLAP::ValueArg<int> debugArg( "d", "debug", "Debug level. 0 means no debug output.", false, 0, "0-5" );
 
     cmd.add( imageSizeArg );
     cmd.add( pageSizeArg );
     cmd.add( blockSizeArg );
-    cmd.add(debugArg);
+    cmd.add( addAllFilesArg );
+    cmd.add( debugArg );
     std::vector<TCLAP::Arg*> args = {&packArg, &unpackArg, &listArg, &visualizeArg};
     cmd.xorAdd( args );
     cmd.add( outNameArg );
     cmd.parse( argc, argv );
 
     if (debugArg.getValue() > 0) {
         std::cout << "Debug output enabled" << std::endl;
-        g_debugLevel = debugArg.getValue();
+        s_debugLevel = debugArg.getValue();
     }
 
     if (packArg.isSet()) {
@@ -548,6 +574,7 @@ void processArgs(int argc, const char** argv) {
     s_imageSize = imageSizeArg.getValue();
     s_pageSize  = pageSizeArg.getValue();
     s_blockSize = blockSizeArg.getValue();
+    s_addAllFiles = addAllFilesArg.isSet();
 }
 
 int main(int argc, const char * argv[]) {