args.h File Reference

Argument parsing. More...

Go to the source code of this file.

Classes
struct	args_info

Functions
void	args_parse (args_info *args, int argc, char **argv)
void	args_free (void)

Variables
bool	opt_stdout
bool	opt_force
bool	opt_keep_original
bool	opt_robot
bool	opt_ignore_check
const char	stdin_filename []

Detailed Description

Argument parsing.

Definition in file args.h.

Function Documentation

args_free()

void args_free

(

void

)

Definition at line 695 of file args.c.

{
    free(opt_block_list);
    return;
}

References free(), and opt_block_list.

Referenced by main().

args_parse()

void args_parse	(	args_info *	args,
		int	argc,
		char **	argv
	)

Definition at line 592 of file args.c.

{
    // Initialize those parts of *args that we need later.
    args->files_name = NULL;
    args->files_file = NULL;
    args->files_delim = '\0';
 
    // 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.
 
        // Look for full command names instead of substrings like
        // "un", "cat", and "lz" to reduce possibility of false
        // positives when the programs have been renamed.
        if (strstr(name, "xzcat") != NULL) {
            opt_mode = MODE_DECOMPRESS;
            opt_stdout = true;
        } else if (strstr(name, "unxz") != NULL) {
            opt_mode = MODE_DECOMPRESS;
        } else if (strstr(name, "lzcat") != NULL) {
            opt_format = FORMAT_LZMA;
            opt_mode = MODE_DECOMPRESS;
            opt_stdout = true;
        } else if (strstr(name, "unlzma") != NULL) {
            opt_format = FORMAT_LZMA;
            opt_mode = MODE_DECOMPRESS;
        } else if (strstr(name, "lzma") != NULL) {
            opt_format = FORMAT_LZMA;
        }
    }
 
    // First the flags from the environment
    parse_environment(args, argv[0], "XZ_DEFAULTS");
    parse_environment(args, argv[0], "XZ_OPT");
 
    // Then from the command line
    parse_real(args, argc, argv);
 
    // If encoder or decoder support was omitted at build time,
    // show an error now so that the rest of the code can rely on
    // that whatever is in opt_mode is also supported.
#ifndef HAVE_ENCODERS
    if (opt_mode == MODE_COMPRESS)
        message_fatal(_("Compression support was disabled "
                "at build time"));
#endif
#ifndef HAVE_DECODERS
    // Even MODE_LIST cannot work without decoder support so MODE_COMPRESS
    // is the only valid choice.
    if (opt_mode != MODE_COMPRESS)
        message_fatal(_("Decompression support was disabled "
                "at build time"));
#endif
 
    // 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;
    }
 
    // When compressing, if no --format flag was used, or it
    // was --format=auto, we compress to the .xz format.
    if (opt_mode == MODE_COMPRESS && opt_format == FORMAT_AUTO)
        opt_format = FORMAT_XZ;
 
    // 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 = (unsigned int)(argc - optind);
    }
 
    return;
}

References _, args, argv, coder_set_compression_settings(), FORMAT_AUTO, FORMAT_LZMA, FORMAT_RAW, FORMAT_XZ, int, message_fatal(), MODE_COMPRESS, MODE_DECOMPRESS, MODE_TEST, name, NULL, opt_format, opt_keep_original, opt_mode, opt_stdout, optind, parse_environment(), and parse_real().

Referenced by main().

Variable Documentation

opt_force

bool opt_force

extern

Definition at line 22 of file args.c.

Referenced by io_open_dest_real(), io_open_src_real(), io_unlink(), list_file(), and parse_real().

opt_ignore_check

bool opt_ignore_check

extern

Definition at line 25 of file args.c.

Referenced by parse_real().

opt_keep_original

bool opt_keep_original

extern

Definition at line 23 of file args.c.

Referenced by args_parse(), io_close_src(), and parse_real().

opt_robot

bool opt_robot

extern

Definition at line 24 of file args.c.

Referenced by get_check_names(), hardware_memlimit_show(), list_file(), list_totals(), main(), message_version(), parse_real(), and print_filename().

opt_stdout

bool opt_stdout

extern

Definition at line 21 of file args.c.

Referenced by args_parse(), io_open_dest_real(), io_open_src_real(), list_file(), main(), and parse_real().

stdin_filename

const char stdin_filename[]

extern

Definition at line 29 of file args.c.

Referenced by io_open_src_real(), list_file(), main(), parse_real(), and print_filename().