/* zstdcli - Command Line Interface (cli) for zstd Copyright (C) Yann Collet 2014-2015 GPL v2 License This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. You can contact the author at : - zstd source repository : https://github.com/Cyan4973/zstd - ztsd public forum : https://groups.google.com/forum/#!forum/lz4c */ /* Note : this is user program. It is not part of zstd compression library. The license of this compression CLI program is GPLv2. The license of zstd library is BSD. */ /************************************** * Compiler Options **************************************/ #define _CRT_SECURE_NO_WARNINGS /* Visual : removes warning from strcpy */ #define _POSIX_SOURCE 1 /* triggers fileno() within on unix */ /************************************** * Includes **************************************/ #include /* fprintf, getchar */ #include /* exit, calloc, free */ #include /* strcmp, strlen */ #include "bench.h" /* BMK_benchFiles, BMK_SetNbIterations */ #include "fileio.h" /************************************** * OS-specific Includes **************************************/ #if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__) # include // _O_BINARY # include // _setmode, _isatty # ifdef __MINGW32__ /* int _fileno(FILE *stream); // seems no longer useful // MINGW somehow forgets to include this windows declaration into */ # endif # define SET_BINARY_MODE(file) _setmode(_fileno(file), _O_BINARY) # define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream)) #else # include // isatty # define SET_BINARY_MODE(file) # define IS_CONSOLE(stdStream) isatty(fileno(stdStream)) #endif /************************************** * Constants **************************************/ #define COMPRESSOR_NAME "zstd command line interface" #ifndef ZSTD_VERSION # define ZSTD_VERSION "v0.0.1" #endif #define AUTHOR "Yann Collet" #define WELCOME_MESSAGE "*** %s %i-bits %s, by %s (%s) ***\n", COMPRESSOR_NAME, (int)(sizeof(void*)*8), ZSTD_VERSION, AUTHOR, __DATE__ #define ZSTD_EXTENSION ".zst" #define ZSTD_CAT "zstdcat" #define KB *(1 <<10) #define MB *(1 <<20) #define GB *(1U<<30) /************************************** * Display Macros **************************************/ #define DISPLAY(...) fprintf(stderr, __VA_ARGS__) #define DISPLAYLEVEL(l, ...) if (displayLevel>=l) { DISPLAY(__VA_ARGS__); } static unsigned displayLevel = 2; // 0 : no display // 1: errors // 2 : + result + interaction + warnings ; // 3 : + progression; // 4 : + information /************************************** * Exceptions **************************************/ #define DEBUG 0 #define DEBUGOUTPUT(...) if (DEBUG) DISPLAY(__VA_ARGS__); #define EXM_THROW(error, ...) \ { \ DEBUGOUTPUT("Error defined at %s, line %i : \n", __FILE__, __LINE__); \ DISPLAYLEVEL(1, "Error %i : ", error); \ DISPLAYLEVEL(1, __VA_ARGS__); \ DISPLAYLEVEL(1, "\n"); \ exit(error); \ } /************************************** * Command Line **************************************/ static int usage(const char* programName) { DISPLAY( "Usage :\n"); DISPLAY( " %s [arg] [input] [output]\n", programName); DISPLAY( "\n"); DISPLAY( "input : a filename\n"); DISPLAY( " with no FILE, or when FILE is - , read standard input\n"); DISPLAY( "Arguments :\n"); DISPLAY( " -d : decompression (default for %s extension)\n", ZSTD_EXTENSION); //DISPLAY( " -z : force compression\n"); DISPLAY( " -f : overwrite output without prompting \n"); DISPLAY( " -h/-H : display help/long help and exit\n"); return 0; } static int usage_advanced(const char* programName) { DISPLAY(WELCOME_MESSAGE); usage(programName); DISPLAY( "\n"); DISPLAY( "Advanced arguments :\n"); DISPLAY( " -V : display Version number and exit\n"); DISPLAY( " -v : verbose mode\n"); DISPLAY( " -q : suppress warnings; specify twice to suppress errors too\n"); DISPLAY( " -c : force write to standard output, even if it is the console\n"); //DISPLAY( " -t : test compressed file integrity\n"); DISPLAY( "Benchmark arguments :\n"); DISPLAY( " -b : benchmark file(s)\n"); DISPLAY( " -i# : iteration loops [1-9](default : 3), benchmark mode only\n"); return 0; } static int badusage(const char* programName) { DISPLAYLEVEL(1, "Incorrect parameters\n"); if (displayLevel >= 1) usage(programName); return 1; } static void waitEnter(void) { DISPLAY("Press enter to continue...\n"); getchar(); } int main(int argc, char** argv) { int i, bench=0, decode=0, forceStdout=0, main_pause=0; unsigned fileNameStart = 0; unsigned nbFiles = 0; const char* programName = argv[0]; const char* inFileName = NULL; const char* outFileName = NULL; char* dynNameSpace = NULL; char extension[] = ZSTD_EXTENSION; /* zstdcat behavior */ if (!strcmp(programName, ZSTD_CAT)) { decode=1; forceStdout=1; displayLevel=1; outFileName=stdoutmark; } // command switches for(i=1; i='0') && (*argument <='9')) iters *= 10, iters += *argument++ - '0'; BMK_SetNbIterations(iters); } break; /* Pause at the end (hidden option) */ case 'p': main_pause=1; argument++; break; /* unknown command */ default : return badusage(programName); } } continue; } /* first provided filename is input */ if (!inFileName) { inFileName = argument; fileNameStart = i; nbFiles = argc-i; continue; } /* second provided filename is output */ if (!outFileName) { outFileName = argument; if (!strcmp (outFileName, nullString)) outFileName = nulmark; continue; } } /* Welcome message (if verbose) */ DISPLAYLEVEL(3, WELCOME_MESSAGE); /* No input filename ==> use stdin */ if(!inFileName) { inFileName=stdinmark; } /* Check if input defined as console; trigger an error in this case */ if (!strcmp(inFileName, stdinmark) && IS_CONSOLE(stdin) ) return badusage(programName); /* Check if benchmark is selected */ if (bench) { BMK_bench(argv+fileNameStart, nbFiles, 0); goto _end; } /* No output filename ==> try to select one automatically (when possible) */ while (!outFileName) { if (!IS_CONSOLE(stdout)) { outFileName=stdoutmark; break; } /* Default to stdout whenever possible (i.e. not a console) */ if (!decode) /* compression to file */ { size_t l = strlen(inFileName); dynNameSpace = (char*)calloc(1,l+5); strcpy(dynNameSpace, inFileName); strcpy(dynNameSpace+l, ZSTD_EXTENSION); outFileName = dynNameSpace; DISPLAYLEVEL(2, "Compressed filename will be : %s \n", outFileName); break; } /* decompression to file (automatic name will work only if input filename has correct format extension) */ { size_t outl; size_t inl = strlen(inFileName); dynNameSpace = (char*)calloc(1,inl+1); outFileName = dynNameSpace; strcpy(dynNameSpace, inFileName); outl = inl; if (inl>4) while ((outl >= inl-4) && (inFileName[outl] == extension[outl-inl+4])) dynNameSpace[outl--]=0; if (outl != inl-5) { DISPLAYLEVEL(1, "Cannot determine an output filename\n"); return badusage(programName); } DISPLAYLEVEL(2, "Decoding file %s \n", outFileName); } } /* Check if output is defined as console; trigger an error in this case */ if (!strcmp(outFileName,stdoutmark) && IS_CONSOLE(stdout) && !forceStdout) return badusage(programName); /* No warning message in pure pipe mode (stdin + stdout) */ if (!strcmp(inFileName, stdinmark) && !strcmp(outFileName,stdoutmark) && (displayLevel==2)) displayLevel=1; /* IO Stream/File */ FIO_setNotificationLevel(displayLevel); if (decode) FIO_decompressFilename(outFileName, inFileName); else FIO_compressFilename(outFileName, inFileName); _end: if (main_pause) waitEnter(); free(dynNameSpace); return 0; }