Renamed lzma to xz and lzmadec to xzdec. We create symlinks

lzma, unlzma, and lzcat in "make install" for backwards
compatibility with LZMA Utils 4.32.x; I'm not sure if this
should be the default though.

1 files changed, 500 insertions, 0 deletions

diff --git a/src/xz/args.c b/src/xz/args.c
new file mode 100644
index 00000000..a2efb277
--- /dev/null
+++ b/src/xz/args.c
@@ -0,0 +1,500 @@
+///////////////////////////////////////////////////////////////////////////////
+//
+/// \file       args.c
+/// \brief      Argument parsing
+///
+/// \note       Filter-specific options parsing is in options.c.
+//
+//  Copyright (C) 2007 Lasse Collin
+//
+//  This program is free software; you can redistribute it and/or
+//  modify it under the terms of the GNU Lesser General Public
+//  License as published by the Free Software Foundation; either
+//  version 2.1 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
+//  Lesser General Public License for more details.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+#include "private.h"
+
+#include "getopt.h"
+#include <ctype.h>
+
+
+bool opt_stdout = false;
+bool opt_force = false;
+bool opt_keep_original = false;
+
+// We don't modify or free() this, but we need to assign it in some
+// non-const pointers.
+const char *stdin_filename = "(stdin)";
+
+
+static void
+parse_real(args_info *args, int argc, char **argv)
+{
+	enum {
+		OPT_SUBBLOCK = INT_MIN,
+		OPT_X86,
+		OPT_POWERPC,
+		OPT_IA64,
+		OPT_ARM,
+		OPT_ARMTHUMB,
+		OPT_SPARC,
+		OPT_DELTA,
+		OPT_LZMA1,
+		OPT_LZMA2,
+
+		OPT_FILES,
+		OPT_FILES0,
+	};
+
+	static const char short_opts[] = "cC:dfF:hHlLkM:p:qrS:tT:vVz123456789";
+
+	static const struct option long_opts[] = {
+		// Operation mode
+		{ "compress",       no_argument,       NULL,  'z' },
+		{ "decompress",     no_argument,       NULL,  'd' },
+		{ "uncompress",     no_argument,       NULL,  'd' },
+		{ "test",           no_argument,       NULL,  't' },
+		{ "list",           no_argument,       NULL,  'l' },
+		{ "info",           no_argument,       NULL,  'l' },
+
+		// Operation modifiers
+		{ "keep",           no_argument,       NULL,  'k' },
+		{ "force",          no_argument,       NULL,  'f' },
+		{ "stdout",         no_argument,       NULL,  'c' },
+		{ "to-stdout",      no_argument,       NULL,  'c' },
+		{ "suffix",         required_argument, NULL,  'S' },
+		// { "recursive",      no_argument,       NULL,  'r' }, // TODO
+		{ "files",          optional_argument, NULL,  OPT_FILES },
+		{ "files0",         optional_argument, NULL,  OPT_FILES0 },
+
+		// Basic compression settings
+		{ "format",         required_argument, NULL,  'F' },
+		{ "check",          required_argument, NULL,  'C' },
+		{ "preset",         required_argument, NULL,  'p' },
+		{ "memory",         required_argument, NULL,  'M' },
+		{ "threads",        required_argument, NULL,  'T' },
+
+		{ "fast",           no_argument,       NULL,  '1' },
+		{ "best",           no_argument,       NULL,  '9' },
+
+		// Filters
+		{ "lzma1",          optional_argument, NULL,  OPT_LZMA1 },
+		{ "lzma2",          optional_argument, NULL,  OPT_LZMA2 },
+		{ "x86",            no_argument,       NULL,  OPT_X86 },
+		{ "bcj",            no_argument,       NULL,  OPT_X86 },
+		{ "powerpc",        no_argument,       NULL,  OPT_POWERPC },
+		{ "ppc",            no_argument,       NULL,  OPT_POWERPC },
+		{ "ia64",           no_argument,       NULL,  OPT_IA64 },
+		{ "itanium",        no_argument,       NULL,  OPT_IA64 },
+		{ "arm",            no_argument,       NULL,  OPT_ARM },
+		{ "armthumb",       no_argument,       NULL,  OPT_ARMTHUMB },
+		{ "sparc",          no_argument,       NULL,  OPT_SPARC },
+		{ "delta",          optional_argument, NULL,  OPT_DELTA },
+		{ "subblock",       optional_argument, NULL,  OPT_SUBBLOCK },
+
+		// Other options
+		{ "quiet",          no_argument,       NULL,  'q' },
+		{ "verbose",        no_argument,       NULL,  'v' },
+		{ "help",           no_argument,       NULL,  'h' },
+		{ "long-help",      no_argument,       NULL,  'H' },
+		{ "version",        no_argument,       NULL,  'V' },
+
+		{ NULL,                 0,                 NULL,   0 }
+	};
+
+	int c;
+
+	while ((c = getopt_long(argc, argv, short_opts, long_opts, NULL))
+			!= -1) {
+		switch (c) {
+		// gzip-like options
+
+		case '1': case '2': case '3': case '4':
+		case '5': case '6': case '7': case '8': case '9':
+			coder_set_preset(c - '0');
+			break;
+
+		case 'p': {
+			const uint64_t preset = str_to_uint64(
+					"preset", optarg, 1, 9);
+			coder_set_preset(preset);
+			break;
+		}
+
+		// --memory
+		case 'M':
+			// On 32-bit systems, SIZE_MAX would make more sense
+			// than UINT64_MAX. But use UINT64_MAX still so that
+			// scripts that assume > 4 GiB values don't break.
+			hardware_memlimit_set(str_to_uint64(
+					"memory", optarg, 0, UINT64_MAX));
+			break;
+
+		// --suffix
+		case 'S':
+			suffix_set(optarg);
+			break;
+
+		case 'T':
+			opt_threads = str_to_uint64("threads", optarg,
+					1, SIZE_MAX);
+			break;
+
+		// --version
+		case 'V':
+			// This doesn't return.
+			message_version();
+
+		// --stdout
+		case 'c':
+			opt_stdout = true;
+			break;
+
+		// --decompress
+		case 'd':
+			opt_mode = MODE_DECOMPRESS;
+			break;
+
+		// --force
+		case 'f':
+			opt_force = true;
+			break;
+
+		// --help
+		case 'h':
+			// This doesn't return.
+			message_help(false);
+
+		// --long-help
+		case 'H':
+			// This doesn't return.
+			message_help(true);
+
+		// --list
+		case 'l':
+			opt_mode = MODE_LIST;
+			break;
+
+		// --keep
+		case 'k':
+			opt_keep_original = true;
+			break;
+
+		// --quiet
+		case 'q':
+			message_verbosity_decrease();
+			break;
+
+		case 't':
+			opt_mode = MODE_TEST;
+			break;
+
+		// --verbose
+		case 'v':
+			message_verbosity_increase();
+			break;
+
+		case 'z':
+			opt_mode = MODE_COMPRESS;
+			break;
+
+		// Filter setup
+
+		case OPT_SUBBLOCK:
+			coder_add_filter(LZMA_FILTER_SUBBLOCK,
+					options_subblock(optarg));
+			break;
+
+		case OPT_X86:
+			coder_add_filter(LZMA_FILTER_X86, NULL);
+			break;
+
+		case OPT_POWERPC:
+			coder_add_filter(LZMA_FILTER_POWERPC, NULL);
+			break;
+
+		case OPT_IA64:
+			coder_add_filter(LZMA_FILTER_IA64, NULL);
+			break;
+
+		case OPT_ARM:
+			coder_add_filter(LZMA_FILTER_ARM, NULL);
+			break;
+
+		case OPT_ARMTHUMB:
+			coder_add_filter(LZMA_FILTER_ARMTHUMB, NULL);
+			break;
+
+		case OPT_SPARC:
+			coder_add_filter(LZMA_FILTER_SPARC, NULL);
+			break;
+
+		case OPT_DELTA:
+			coder_add_filter(LZMA_FILTER_DELTA,
+					options_delta(optarg));
+			break;
+
+		case OPT_LZMA1:
+			coder_add_filter(LZMA_FILTER_LZMA1,
+					options_lzma(optarg));
+			break;
+
+		case OPT_LZMA2:
+			coder_add_filter(LZMA_FILTER_LZMA2,
+					options_lzma(optarg));
+			break;
+
+		// Other
+
+		// --format
+		case 'F': {
+			// Just in case, support both "lzma" and "alone" since
+			// the latter was used for forward compatibility in
+			// LZMA Utils 4.32.x.
+			static const struct {
+				char str[8];
+				enum format_type format;
+			} types[] = {
+				{ "auto",   FORMAT_AUTO },
+				{ "xz",     FORMAT_XZ },
+				{ "lzma",   FORMAT_LZMA },
+				{ "alone",  FORMAT_LZMA },
+				// { "gzip",   FORMAT_GZIP },
+				// { "gz",     FORMAT_GZIP },
+				{ "raw",    FORMAT_RAW },
+			};
+
+			size_t i = 0;
+			while (strcmp(types[i].str, optarg) != 0)
+				if (++i == ARRAY_SIZE(types))
+					message_fatal(_("%s: Unknown file "
+							"format type"),
+							optarg);
+
+			opt_format = types[i].format;
+			break;
+		}
+
+		// --check
+		case 'C': {
+			static const struct {
+				char str[8];
+				lzma_check check;
+			} types[] = {
+				{ "none",   LZMA_CHECK_NONE },
+				{ "crc32",  LZMA_CHECK_CRC32 },
+				{ "crc64",  LZMA_CHECK_CRC64 },
+				{ "sha256", LZMA_CHECK_SHA256 },
+			};
+
+			size_t i = 0;
+			while (strcmp(types[i].str, optarg) != 0) {
+				if (++i == ARRAY_SIZE(types))
+					message_fatal(_("%s: Unknown integrity"
+							"check type"), optarg);
+			}
+
+			coder_set_check(types[i].check);
+			break;
+		}
+
+		case OPT_FILES:
+			args->files_delim = '\n';
+
+		// Fall through
+
+		case OPT_FILES0:
+			if (args->files_name != NULL)
+				message_fatal(_("Only one file can be "
+						"specified with `--files'"
+						"or `--files0'."));
+
+			if (optarg == NULL) {
+				args->files_name = (char *)stdin_filename;
+				args->files_file = stdin;
+			} else {
+				args->files_name = optarg;
+				args->files_file = fopen(optarg,
+						c == OPT_FILES ? "r" : "rb");
+				if (args->files_file == NULL)
+					message_fatal("%s: %s", optarg,
+							strerror(errno));
+			}
+
+			break;
+
+		default:
+			message_try_help();
+			my_exit(E_ERROR);
+		}
+	}
+
+	return;
+}
+
+
+static void
+parse_environment(args_info *args, char *argv0)
+{
+	char *env = getenv("XZ_OPT");
+	if (env == NULL)
+		return;
+
+	// We modify the string, so make a copy of it.
+	env = xstrdup(env);
+
+	// Calculate the number of arguments in env. argc stats at one
+	// to include space for the program name.
+	int argc = 1;
+	bool prev_was_space = true;
+	for (size_t i = 0; env[i] != '\0'; ++i) {
+		if (isspace(env[i])) {
+			prev_was_space = true;
+		} else if (prev_was_space) {
+			prev_was_space = false;
+
+			// Keep argc small enough to fit into a singed int
+			// and to keep it usable for memory allocation.
+			if (++argc == MIN(INT_MAX, SIZE_MAX / sizeof(char *)))
+				message_fatal(_("The environment variable "
+						"XZ_OPT contains too many "
+						"arguments"));
+		}
+	}
+
+	// Allocate memory to hold pointers to the arguments. Add one to get
+	// space for the terminating NULL (if some systems happen to need it).
+	char **argv = xmalloc(((size_t)(argc) + 1) * sizeof(char *));
+	argv[0] = argv0;
+	argv[argc] = NULL;
+
+	// Go through the string again. Split the arguments using '\0'
+	// characters and add pointers to the resulting strings to argv.
+	argc = 1;
+	prev_was_space = true;
+	for (size_t i = 0; env[i] != '\0'; ++i) {
+		if (isspace(env[i])) {
+			prev_was_space = true;
+			env[i] = '\0';
+		} else if (prev_was_space) {
+			prev_was_space = false;
+			argv[argc++] = env + i;
+		}
+	}
+
+	// Parse the argument list we got from the environment. All non-option
+	// arguments i.e. filenames are ignored.
+	parse_real(args, argc, argv);
+
+	// Reset the state of the getopt_long() so that we can parse the
+	// command line options too. There are two incompatible ways to
+	// do it.
+#ifdef HAVE_OPTRESET
+	// BSD
+	optind = 1;
+	optreset = 1;
+#else
+	// GNU, Solaris
+	optind = 0;
+#endif
+
+	// We don't need the argument list from environment anymore.
+	free(argv);
+	free(env);
+
+	return;
+}
+
+
+extern void
+args_parse(args_info *args, int argc, char **argv)
+{
+	// Initialize those parts of *args that we need later.
+	args->files_name = NULL;
+	args->files_file = NULL;
+	args->files_delim = '\0';
+
+	// Type of the file format to use when --format=auto or no --format
+	// was specified.
+	enum format_type format_compress_auto = FORMAT_XZ;
+
+	// Check how we were called.
+	{
+		// Remove the leading path name, if any.
+		const char *name = strrchr(argv[0], '/');
+		if (name == NULL)
+			name = argv[0];
+		else
+			++name;
+
+		// NOTE: It's possible that name[0] is now '\0' if argv[0]
+		// is weird, but it doesn't matter here.
+
+		// The default file format is .lzma if the command name
+		// contains "lz".
+		if (strstr(name, "lz") != NULL)
+			format_compress_auto = FORMAT_LZMA;
+
+		// Operation mode
+		if (strstr(name, "cat") != NULL) {
+			// Imply --decompress --stdout
+			opt_mode = MODE_DECOMPRESS;
+			opt_stdout = true;
+		} else if (strstr(name, "un") != NULL) {
+			// Imply --decompress
+			opt_mode = MODE_DECOMPRESS;
+		}
+	}
+
+	// First the flags from environment
+	parse_environment(args, argv[0]);
+
+	// Then from the command line
+	optind = 1;
+	parse_real(args, argc, argv);
+
+	// Never remove the source file when the destination is not on disk.
+	// In test mode the data is written nowhere, but setting opt_stdout
+	// will make the rest of the code behave well.
+	if (opt_stdout || opt_mode == MODE_TEST) {
+		opt_keep_original = true;
+		opt_stdout = true;
+	}
+
+	// If no --format flag was used, or it was --format=auto, we need to
+	// decide what is the target file format we are going to use. This
+	// depends on how we were called (checked earlier in this function).
+	if (opt_mode == MODE_COMPRESS && opt_format == FORMAT_AUTO)
+		opt_format = format_compress_auto;
+
+	// Compression settings need to be validated (options themselves and
+	// their memory usage) when compressing to any file format. It has to
+	// be done also when uncompressing raw data, since for raw decoding
+	// the options given on the command line are used to know what kind
+	// of raw data we are supposed to decode.
+	if (opt_mode == MODE_COMPRESS || opt_format == FORMAT_RAW)
+		coder_set_compression_settings();
+
+	// If no filenames are given, use stdin.
+	if (argv[optind] == NULL && args->files_name == NULL) {
+		// We don't modify or free() the "-" constant. The caller
+		// modifies this so don't make the struct itself const.
+		static char *names_stdin[2] = { (char *)"-", NULL };
+		args->arg_names = names_stdin;
+		args->arg_count = 1;
+	} else {
+		// We got at least one filename from the command line, or
+		// --files or --files0 was specified.
+		args->arg_names = argv + optind;
+		args->arg_count = argc - optind;
+	}
+
+	return;
+}