Merge pull request #978 from Cyan4973/filelist

added --filelist command

.gitignore

@@ -52,6 +52,7 @@ tests/unicode_test*
 
 # editor artifacts
 .clang_complete
+.clangd
 *.swp
 .vscode/
 .vs/

Makefile

@@ -314,6 +314,11 @@ test-xxhsum-c: xxhsum
 	# Expects "FAILED open or read"
 	echo "0000000000000000  test-expects-file-not-found" | ./xxhsum -c -; test $$? -eq 1
 	echo "00000000  test-expects-file-not-found" | ./xxhsum -c -; test $$? -eq 1
+	# --filelist
+	echo xxhash.c > .test.filenames
+	$(RUN_ENV) ./xxhsum$(EXT) --filelist .test.filenames
+	# --filelist from stdin
+	cat .test.filenames | $(RUN_ENV) ./xxhsum$(EXT) --filelist
 	@$(RM) .test.*
 
 LIB_FUZZING_ENGINE?="-fsanitize=fuzzer"

cli/xxhsum.1.md

@@ -36,9 +36,6 @@ As xxHash is a fast non-cryptographic checksum algorithm,
 OPTIONS
 -------
 
-* `-V`, `--version`:
-  Displays xxhsum version and exits
-
 * `-H`*HASHTYPE*:
   Hash selection. *HASHTYPE* means `0`=XXH32, `1`=XXH64, `2`=XXH128, `3`=XXH3.
   Alternatively, *HASHTYPE* `32`=XXH32, `64`=XXH64, `128`=XXH128.
@@ -54,37 +51,43 @@ OPTIONS
   Set output hexadecimal checksum value as little endian convention.
   By default, value is displayed as big endian.
 
+* `-V`, `--version`:
+  Displays xxhsum version and exits
+
 * `-h`, `--help`:
   Displays help and exits
 
-### The following options are useful only when using lists in *FILE* (--check and --files-from):
+### Advanced file input options
 
-* `-c`, `--check` *FILE*:
-  Read xxHash sums from *FILE* and check them
-
-* `--files-from` *FILE*:
+* `--files-from`, `--filelist` *FILE*:
   Read filenames from *FILE* and generate hashes for them.
-  Valid *FILE*s have one filename per line, which can include embedded spaces, etc with no need for quotes, escapes, etc.
-  Note that a line commencing with '\\' will enable the convention used in the encoding of filenames against output hashes,
+  `stdin` is also a valid way to provide filenames (when no *FILE* or `-` provided).
+  Valid format is one filename per line, which can include embedded spaces, etc with no need for quotes, escapes, etc.
+  A line commencing with '\\' will enable the convention used in the encoding of filenames against output hashes,
   whereby subsequent \\\\, \n and \r seqeuences are converted to the single
   character 0x5C, 0x0A and 0x0D respectively.
 
-* `-q`, `--quiet`:
-   Don't print OK for each successfully verified hash (only for --check)
+### The following options are useful only for checksum verification:
+
+* `-c`, `--check` *FILE*:
+  Read xxHash sums from *FILE* and check them
 
 * `--strict`:
-  Return an error code if any line in *FILE** is invalid,
+  Return an error code if any line in *FILE* is invalid,
   not just if some checksums are wrong.
   This policy is disabled by default,
   though UI will prompt an informational message
   if any line in the file is detected invalid.
 
-* `--status`:
-  Don't output anything. Status code shows success.
-
 * `-w`, `--warn`:
   Emit a warning message about each improperly formatted line in *FILE*.
 
+* `-q`, `--quiet`:
+   Don't print OK for each successfully verified hash
+
+* `--status`:
+  Don't output anything. Only generate a Status code to show success.
+
 ### The following options are useful only benchmark purpose:
 
 * `-b`:

cli/xxhsum.c

@@ -584,18 +584,18 @@ typedef struct {
 } ParseFileReport;
 
 typedef struct {
-    const char*     inFileName;
-    FILE*           inFile;
-    int             lineMax;
-    char*           lineBuf;
-    size_t          blockSize;
-    char*           blockBuf;
-    XSUM_U32        strictMode;
-    XSUM_U32        statusOnly;
-    XSUM_U32        ignoreMissing;
-    XSUM_U32        warn;
-    XSUM_U32        quiet;
-    XSUM_U32        algoBitmask;
+    const char*  inFileName;
+    FILE*        inFile;
+    int          lineMax;
+    char*        lineBuf;
+    size_t       blockSize;
+    char*        blockBuf;
+    int          strictMode;
+    int          statusOnly;
+    int          ignoreMissing;
+    int          warn;
+    int          quiet;
+    XSUM_U32     algoBitmask;
     ParseFileReport report;
 } ParseFileArg;
 
@@ -1022,11 +1022,11 @@ static void XSUM_parseFile1(ParseFileArg* XSUM_parseFileArg, int rev)
  */
 static int XSUM_checkFile(const char* inFileName,
                           const Display_endianness displayEndianness,
-                          XSUM_U32 strictMode,
-                          XSUM_U32 statusOnly,
-                          XSUM_U32 ignoreMissing,
-                          XSUM_U32 warn,
-                          XSUM_U32 quiet,
+                          int strictMode,
+                          int statusOnly,
+                          int ignoreMissing,
+                          int warn,
+                          int quiet,
                           XSUM_U32 algoBitmask)
 {
     int result = 0;
@@ -1119,11 +1119,11 @@ static int XSUM_checkFile(const char* inFileName,
 
 static int XSUM_checkFiles(const char* fnList[], int fnTotal,
                            const Display_endianness displayEndianness,
-                           XSUM_U32 strictMode,
-                           XSUM_U32 statusOnly,
-                           XSUM_U32 ignoreMissing,
-                           XSUM_U32 warn,
-                           XSUM_U32 quiet,
+                           int strictMode,
+                           int statusOnly,
+                           int ignoreMissing,
+                           int warn,
+                           int quiet,
                            XSUM_U32 algoBitmask)
 {
     int ok = 1;
@@ -1286,9 +1286,9 @@ static int XSUM_generateFile(const char* inFileName,
     AlgoSelected hashType,
     Display_endianness displayEndianness,
     Display_convention convention,
-    XSUM_U32 statusOnly,
-    XSUM_U32 ignoreMissing,
-    XSUM_U32 warn)
+    int statusOnly,
+    int ignoreMissing,
+    int warn)
 {
     int result = 0;
     FILE* inFile = NULL;
@@ -1365,9 +1365,9 @@ static int XSUM_generateFiles(const char* fnList[], int fnTotal,
     AlgoSelected hashType,
     Display_endianness displayEndianness,
     Display_convention convention,
-    XSUM_U32 statusOnly,
-    XSUM_U32 ignoreMissing,
-    XSUM_U32 warn)
+    int statusOnly,
+    int ignoreMissing,
+    int warn)
 {
     int ok = 1;
 
@@ -1396,14 +1396,14 @@ static int XSUM_usage(const char* exename)
     XSUM_log( "Usage: %s [options] [files] \n\n", exename);
     XSUM_log( "When no filename provided or when '-' is provided, uses stdin as input. \n");
     XSUM_log( "\nOptions: \n");
-    XSUM_log( "  -H#              select an xxhash algorithm (default: %i) \n", (int)g_defaultAlgo);
-    XSUM_log( "                   0: XXH32 \n");
-    XSUM_log( "                   1: XXH64 \n");
-    XSUM_log( "                   2: XXH128 (also called XXH3_128bits) \n");
-    XSUM_log( "                   3: XXH3 (also called XXH3_64bits) \n");
-    XSUM_log( "  -c, --check      read xxHash checksum from [files] and check them \n");
-    XSUM_log( "      --files-from generate hashes for files listed in [files] \n");
-    XSUM_log( "  -h, --help       display a long help page about advanced options \n");
+    XSUM_log( "  -H#             select an xxhash algorithm (default: %i) \n", (int)g_defaultAlgo);
+    XSUM_log( "                  0: XXH32 \n");
+    XSUM_log( "                  1: XXH64 \n");
+    XSUM_log( "                  2: XXH128 (also called XXH3_128bits) \n");
+    XSUM_log( "                  3: XXH3 (also called XXH3_64bits) \n");
+    XSUM_log( "  -c, --check     read xxHash checksum from [files] and check them \n");
+    XSUM_log( "      --filelist  generate hashes for files listed in [files] \n");
+    XSUM_log( "  -h, --help      display a long help page about advanced options \n");
     return 0;
 }
 
@@ -1504,12 +1504,13 @@ XSUM_API int XSUM_main(int argc, const char* argv[])
 {
     int i, filenamesStart = 0;
     const char* const exename = XSUM_lastNameFromPath(argv[0]);
-    XSUM_U32 benchmarkMode = 0;
-    XSUM_U32 fileCheckMode = 0;
-    XSUM_U32 strictMode    = 0;
-    XSUM_U32 statusOnly    = 0;
-    XSUM_U32 warn          = 0;
-    XSUM_U32 ignoreMissing = 0;
+    int benchmarkMode = 0;
+    int fileCheckMode = 0;
+    int readFilenamesMode = 0;
+    int strictMode    = 0;
+    int statusOnly    = 0;
+    int warn          = 0;
+    int ignoreMissing = 0;
     XSUM_U32 algoBitmask   = algo_bitmask_all;
     int explicitStdin = 0;
     XSUM_U32 selectBenchIDs= 0;  /* 0 == use default k_testIDs_default, kBenchAll == bench all */
@@ -1531,7 +1532,8 @@ XSUM_API int XSUM_main(int argc, const char* argv[])
         assert(argument != NULL);
 
         if (!strcmp(argument, "--check")) { fileCheckMode = 1; continue; }
-        if (!strcmp(argument, "--files-from")) { fileCheckMode = 2; continue; }
+        if (!strcmp(argument, "--files-from")) { readFilenamesMode = 1; continue; }
+        if (!strcmp(argument, "--filelist")) { readFilenamesMode = 1; continue; }
         if (!strcmp(argument, "--benchmark-all")) { benchmarkMode = 1; selectBenchIDs = kBenchAll; continue; }
         if (!strcmp(argument, "--bench-all")) { benchmarkMode = 1; selectBenchIDs = kBenchAll; continue; }
         if (!strcmp(argument, "--quiet")) { XSUM_logLevel--; continue; }
@@ -1555,7 +1557,7 @@ XSUM_API int XSUM_main(int argc, const char* argv[])
         }
 
         /* command selection */
-        argument++;   /* note: *argument=='-' */
+        argument++;   /* note: argument[0] was =='-' */
         if (*argument == 0) explicitStdin = 1;
 
         while (*argument != 0) {
@@ -1595,7 +1597,7 @@ XSUM_API int XSUM_main(int argc, const char* argv[])
 
             /* Generate hash mode (tar style short form of --files-from)
             case 'T':
-                fileCheckMode = 2;
+                readFilenamesMode = 2;
                 argument++;
                 break; */
 
@@ -1660,12 +1662,16 @@ XSUM_API int XSUM_main(int argc, const char* argv[])
         return XSUM_badusage(exename);
 
     if (filenamesStart==0) filenamesStart = argc;
-    if (fileCheckMode == 1) {
+
+    if (fileCheckMode) {
         return XSUM_checkFiles(argv+filenamesStart, argc-filenamesStart,
                           displayEndianness, strictMode, statusOnly, ignoreMissing, warn, (XSUM_logLevel < 2) /*quiet*/, algoBitmask);
-    } else if (fileCheckMode == 2) {
+    }
+
+    if (readFilenamesMode) {
         return XSUM_generateFiles(argv + filenamesStart, argc - filenamesStart, algo, displayEndianness, convention, statusOnly, ignoreMissing, warn);
-    } else {
-        return XSUM_hashFiles(argv+filenamesStart, argc-filenamesStart, algo, displayEndianness, convention);
     }
+
+    return XSUM_hashFiles(argv+filenamesStart, argc-filenamesStart, algo, displayEndianness, convention);
+
 }