X-Git-Url: http://git.refcnt.org/?p=colorize.git;a=blobdiff_plain;f=colorize.c;h=854581bee0e3c6a73f1cfb10e39f3ebd79e5ce06;hp=ba5926a4f0503841afe6777d2d75455a64b4b615;hb=6323c270d4c14a27d0b7d035698e2b16ac840ac9;hpb=873cb28ff8c8e0a4b64cc872878a72b5fcd66a98 diff --git a/colorize.c b/colorize.c index ba5926a..854581b 100644 --- a/colorize.c +++ b/colorize.c @@ -2,7 +2,7 @@ * colorize - Read text from standard input stream or file and print * it colorized through use of ANSI escape sequences * - * Copyright (c) 2011-2017 Steven Schubiger + * Copyright (c) 2011-2018 Steven Schubiger * * 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 @@ -27,6 +27,7 @@ #include #include #include +#include #include #include #include @@ -73,6 +74,8 @@ #define LF 0x01 #define CR 0x02 +#define COUNT_OF(obj, type) (sizeof (obj) / sizeof (type)) + #define SKIP_LINE_ENDINGS(flags) ((flags) == (CR|LF) ? 2 : 1) #define VALID_FILE_TYPE(mode) (S_ISREG (mode) || S_ISLNK (mode) || S_ISFIFO (mode)) @@ -99,12 +102,12 @@ #define ABORT_TRACE() \ fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \ - abort (); \ + abort (); #define CHECK_COLORS_RANDOM(color1, color2) \ streq (color_names[color1]->name, "random") \ && (streq (color_names[color2]->name, "none") \ - || streq (color_names[color2]->name, "default")) \ + || streq (color_names[color2]->name, "default")) #define ALLOC_COMPLETE_PART_LINE 8 @@ -116,6 +119,8 @@ # define COLOR_SEP_CHAR '/' #endif +#define CONF_FILE ".colorize.conf" + #if DEBUG # define DEBUG_FILE "debug.txt" #endif @@ -124,10 +129,19 @@ #define PROGRAM_NAME "colorize" -#define VERSION "0.63" +#define VERSION "0.64" typedef enum { false, true } bool; +struct conf { + char *attr; + char *color; + char *exclude_random; + char *omit_color_empty; +}; + +enum { DESC_OPTION, DESC_CONF }; + struct color_name { char *name; char *orig; @@ -176,7 +190,8 @@ enum { FMT_RANDOM, FMT_ERROR, FMT_FILE, - FMT_TYPE + FMT_TYPE, + FMT_CONF }; static const char *formats[] = { "%s", /* generic */ @@ -187,6 +202,7 @@ static const char *formats[] = { "less than %lu bytes %s", /* error */ "%s: %s", /* file */ "%s: %s: %s", /* type */ + "%s: option '%s' %s" /* conf */ }; enum { GENERIC, FOREGROUND = 0, BACKGROUND }; @@ -196,8 +212,8 @@ static const struct { unsigned int count; const char *desc; } tables[] = { - { fg_colors, sizeof (fg_colors) / sizeof (struct color), "foreground" }, - { bg_colors, sizeof (bg_colors) / sizeof (struct color), "background" }, + { fg_colors, COUNT_OF (fg_colors, struct color), "foreground" }, + { bg_colors, COUNT_OF (bg_colors, struct color), "background" }, }; enum { @@ -251,17 +267,25 @@ static char *exclude; static const char *program_name; +#if DEBUG +static void print_tstamp (FILE *); +#endif static void process_opts (int, char **); -static void process_opt_attr (const char *); -static void write_attr (const struct attr *, unsigned int *); +static void process_opt_attr (const char *, const bool); +static void write_attr (const struct attr *, unsigned int *, const bool); +static void process_opt_exclude_random (const char *, const bool); +static void parse_conf (const char *, struct conf *); +static void assign_conf (const char *, struct conf *, const char *, char *); +static void init_conf_vars (const struct conf *); static void print_hint (void); static void print_help (void); static void print_version (void); static void cleanup (void); static void free_color_names (struct color_name **); -static void process_args (unsigned int, char **, char *, const struct color **, const char **, FILE **); +static void free_conf (struct conf *); +static void process_args (unsigned int, char **, char *, const struct color **, const char **, FILE **, struct conf *); static void process_file_arg (const char *, const char **, FILE **); -static void skip_path_colors (const char *, const char *, const struct stat *); +static bool skip_path_colors (const char *, const char *, const struct stat *, const bool); static void gather_color_names (const char *, char *, struct color_name **); static void read_print_stream (const char *, const struct color **, const char *, FILE *); static void merge_print_line (const char *, const char *, FILE *); @@ -318,6 +342,13 @@ main (int argc, char **argv) const char *file = NULL; + char *conf_file; + uid_t uid; + struct passwd *passwd; + size_t size; + + struct conf config = { NULL, NULL, NULL, NULL }; + program_name = argv[0]; atexit (cleanup); @@ -325,10 +356,37 @@ main (int argc, char **argv) #if DEBUG log = open_file (DEBUG_FILE, "w"); + print_tstamp (log); #endif attr[0] = '\0'; +#ifdef CONF_FILE_TEST + conf_file = to_str (CONF_FILE_TEST); +#elif !defined(TEST) + uid = getuid (); + errno = 0; + if ((passwd = getpwuid (uid)) == NULL) + { + if (errno == 0) + vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid); + else + perror ("getpwuid"); + exit (EXIT_FAILURE); + } + size = strlen (passwd->pw_dir) + 1 + strlen (CONF_FILE) + 1; + conf_file = xmalloc (size); + snprintf (conf_file, size, "%s/%s", passwd->pw_dir, CONF_FILE); +#endif +#if defined(CONF_FILE_TEST) || !defined(TEST) + if (access (conf_file, F_OK) != -1) + parse_conf (conf_file, &config); +#endif +#if !defined(CONF_FILE_TEST) && !defined(TEST) + free (conf_file); +#endif + init_conf_vars (&config); + process_opts (argc, argv); arg_cnt = argc - optind; @@ -339,8 +397,8 @@ main (int argc, char **argv) vfprintf_fail (formats[FMT_GENERIC], "--clean and --clean-all switch are mutually exclusive"); if (arg_cnt > 1) { - const char *format = "%s %s"; - const char *message = "switch cannot be used with more than one file"; + const char *const format = "%s %s"; + const char *const message = "switch cannot be used with more than one file"; if (clean) vfprintf_fail (format, "--clean", message); else if (clean_all) @@ -360,21 +418,50 @@ main (int argc, char **argv) if (clean || clean_all) process_file_arg (argv[optind], &file, &stream); else - process_args (arg_cnt, &argv[optind], &attr[0], colors, &file, &stream); + process_args (arg_cnt, &argv[optind], &attr[0], colors, &file, &stream, &config); read_print_stream (&attr[0], colors, file, stream); + free_conf (&config); + RELEASE_VAR (exclude); exit (EXIT_SUCCESS); } +#if DEBUG +static void +print_tstamp (FILE *log) +{ + time_t t; + struct tm *tm; + char str[128]; + size_t written; + + t = time (NULL); + tm = localtime (&t); + if (tm == NULL) + { + perror ("localtime"); + exit (EXIT_FAILURE); + } + written = strftime (str, sizeof (str), "%Y-%m-%d %H:%M:%S %Z", tm); + if (written == 0) + vfprintf_fail (formats[FMT_GENERIC], "strftime: 0 returned"); + + fprintf (log, "%s\n", str); + while (written--) + fprintf (log, "="); + fprintf (log, "\n"); +} +#endif + #define PRINT_HELP_EXIT() \ print_help (); \ - exit (EXIT_SUCCESS); \ + exit (EXIT_SUCCESS); #define PRINT_VERSION_EXIT() \ print_version (); \ - exit (EXIT_SUCCESS); \ + exit (EXIT_SUCCESS); extern char *optarg; @@ -390,7 +477,8 @@ process_opts (int argc, char **argv) switch (opt_type) { case OPT_ATTR: - process_opt_attr (optarg); + attr[0] = '\0'; /* Clear attr string to discard values from the config file. */ + process_opt_attr (optarg, true); break; case OPT_CLEAN: clean = true; @@ -398,24 +486,9 @@ process_opts (int argc, char **argv) case OPT_CLEAN_ALL: clean_all = true; break; - case OPT_EXCLUDE_RANDOM: { - bool valid = false; - unsigned int i; - exclude = xstrdup (optarg); - STACK_VAR (exclude); - for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */ - { - const struct color *entry = &tables[GENERIC].entries[i]; - if (streq (exclude, entry->name)) - { - valid = true; - break; - } - } - if (!valid) - vfprintf_fail (formats[FMT_GENERIC], "--exclude-random switch must be provided a plain color"); + case OPT_EXCLUDE_RANDOM: + process_opt_exclude_random (optarg, true); break; - } case OPT_OMIT_COLOR_EMPTY: omit_color_empty = true; break; @@ -441,7 +514,7 @@ process_opts (int argc, char **argv) } static void -process_opt_attr (const char *p) +process_opt_attr (const char *p, const bool is_opt) { /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */ const struct attr attrs[] = { @@ -452,27 +525,29 @@ process_opt_attr (const char *p) { "concealed", 8, ATTR_CONCEALED }, }; unsigned int attr_types = 0; + const char *desc_type[2] = { "--attr switch", "attr conf option" }; + const unsigned int DESC_TYPE = is_opt ? DESC_OPTION : DESC_CONF; while (*p) { const char *s; if (!isalnum (*p)) - vfprintf_fail (formats[FMT_GENERIC], "--attr switch must be provided a string"); + vfprintf_fail ("%s must be provided a string", desc_type[DESC_TYPE]); s = p; while (isalnum (*p)) p++; if (*p != '\0' && *p != ',') - vfprintf_fail (formats[FMT_GENERIC], "--attr switch must have strings separated by ,"); + vfprintf_fail ("%s must have strings separated by ,", desc_type[DESC_TYPE]); else { bool valid_attr = false; unsigned int i; - for (i = 0; i < sizeof (attrs) / sizeof (struct attr); i++) + for (i = 0; i < COUNT_OF (attrs, struct attr); i++) { const size_t name_len = strlen (attrs[i].name); if ((size_t)(p - s) == name_len && strneq (s, attrs[i].name, name_len)) { - write_attr (&attrs[i], &attr_types); + write_attr (&attrs[i], &attr_types, is_opt); valid_attr = true; break; } @@ -483,7 +558,7 @@ process_opt_attr (const char *p) STACK_VAR (attr_invalid); strncpy (attr_invalid, s, p - s); attr_invalid[p - s] = '\0'; - vfprintf_fail ("--attr switch attribute '%s' is not valid", attr_invalid); + vfprintf_fail ("%s attribute '%s' is not valid", desc_type[DESC_TYPE], attr_invalid); RELEASE_VAR (attr_invalid); /* never reached */ } } @@ -493,18 +568,165 @@ process_opt_attr (const char *p) } static void -write_attr (const struct attr *attr_i, unsigned int *attr_types) +write_attr (const struct attr *attr_i, unsigned int *attr_types, const bool is_opt) { const unsigned int val = attr_i->val; const enum attr_type attr_type = attr_i->type; const char *attr_name = attr_i->name; if (*attr_types & attr_type) - vfprintf_fail ("--attr switch has attribute '%s' twice or more", attr_name); + vfprintf_fail ("%s has attribute '%s' twice or more", + is_opt ? "--attr switch" : "attr conf option", attr_name); snprintf (attr + strlen (attr), 3, "%u;", val); *attr_types |= attr_type; } +static void +process_opt_exclude_random (const char *s, const bool is_opt) +{ + bool valid = false; + unsigned int i; + if (exclude) + RELEASE_VAR (exclude); + exclude = xstrdup (s); + STACK_VAR (exclude); + for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */ + { + const struct color *entry = &tables[GENERIC].entries[i]; + if (streq (exclude, entry->name)) + { + valid = true; + break; + } + } + if (!valid) + vfprintf_fail ("%s must be provided a plain color", + is_opt ? "--exlude-random switch" : "exclude-random conf option"); +} + +#define IS_SPACE(c) ((c) == ' ' || (c) == '\t') + +static void +parse_conf (const char *conf_file, struct conf *config) +{ + char line[256 + 1]; + FILE *conf; + + conf = open_file (conf_file, "r"); + + while (fgets (line, sizeof (line), conf)) + { + char *cfg, *val; + char *assign, *comment, *opt, *value; + char *p; + + if (strlen (line) > (sizeof (line) - 2)) + vfprintf_fail ("%s: line exceeds maximum of %u characters", conf_file, (unsigned int)(sizeof (line) - 2)); + if ((p = strrchr (line, '\n'))) + *p = '\0'; +/* NAME PARSING (start) */ + p = line; + /* skip leading spaces and tabs for name */ + while (IS_SPACE (*p)) + p++; + /* skip line if a) string end, b) comment, [cd]) newline */ + if (*p == '\0' || *p == '#' || *p == '\n' || *p == '\r') + continue; + opt = p; + if (!(assign = strchr (opt, '='))) /* check for = */ + { + char *space; + if ((space = strchr (opt, ' '))) + *space = '\0'; + vfprintf_fail (formats[FMT_CONF], conf_file, opt, "not followed by ="); + } + p = assign; + /* skip trailing spaces and tabs for name */ + while (IS_SPACE (*(p - 1))) + p--; + *p = '\0'; +/* NAME PARSING (end) */ +/* NAME VALIDATION (start) */ + for (p = opt; *p; p++) + if (!isalnum (*p) && *p != '-') + vfprintf_fail (formats[FMT_CONF], conf_file, opt, "cannot be made of non-option characters"); +/* NAME VALIDATION (end) */ +/* VALUE PARSING (start) */ + p = assign + 1; + /* skip leading spaces and tabs for value */ + while (IS_SPACE (*p)) + p++; + /* skip line if comment */ + if (*p == '#') + continue; + value = p; + if ((comment = strchr (p, '#'))) + p = comment; + else + p += strlen (p); + /* skip trailing spaces and tabs for value */ + while (IS_SPACE (*(p - 1))) + p--; + *p = '\0'; +/* VALUE PARSING (end) */ + + /* save option name */ + cfg = xstrdup (opt); + /* save option value (allow empty ones) */ + val = strlen (value) ? xstrdup (value) : NULL; + + assign_conf (conf_file, config, cfg, val); + free (cfg); + } + + fclose (conf); +} + +static void +assign_conf (const char *conf_file, struct conf *config, const char *cfg, char *val) +{ + if (streq (cfg, "attr")) + { + free (config->attr); + config->attr = val; + } + else if (streq (cfg, "color")) + { + free (config->color); + config->color = val; + } + else if (streq (cfg, "exclude-random")) + { + free (config->exclude_random); + config->exclude_random = val; + } + else if (streq (cfg, "omit-color-empty")) + { + free (config->omit_color_empty); + config->omit_color_empty = val; + } + else + vfprintf_fail (formats[FMT_CONF], conf_file, cfg, "not recognized"); +} + +static void +init_conf_vars (const struct conf *config) +{ + if (config->attr) + process_opt_attr (config->attr, false); + if (config->exclude_random) + process_opt_exclude_random (config->exclude_random, false); + if (config->omit_color_empty) + { + if (streq (config->omit_color_empty, "yes")) + omit_color_empty = true; + else if (streq (config->omit_color_empty, "no")) + omit_color_empty = false; + else + vfprintf_fail ("omit-color-empty conf option is not valid"); + } +} + static void print_hint (void) { @@ -551,7 +773,7 @@ print_help (void) { const struct opt_data *opt_data = NULL; unsigned int i; - for (i = 0; i < sizeof (opts_data) / sizeof (struct opt_data); i++) + for (i = 0; i < COUNT_OF (opts_data, struct opt_data); i++) if (streq (opt->name, opts_data[i].name)) { opt_data = &opts_data[i]; @@ -576,7 +798,7 @@ print_version (void) #ifdef HAVE_VERSION # include "version.h" #else - const char *version = NULL; + const char *const version = NULL; #endif const char *version_prefix, *version_string; const char *c_flags, *ld_flags, *cpp_flags; @@ -656,12 +878,26 @@ free_color_names (struct color_name **color_names) } static void -process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct color **colors, const char **file, FILE **stream) +free_conf (struct conf *config) +{ + free (config->attr); + free (config->color); + free (config->exclude_random); + free (config->omit_color_empty); +} + +static void +process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct color **colors, const char **file, FILE **stream, struct conf *config) { + bool use_conf_color; int ret; char *p; struct stat sb; - struct color_name *color_names[3] = { NULL, NULL, NULL }; + struct color_name *color_names[3] = { + NULL, /* foreground */ + NULL, /* background */ + NULL, /* sentinel value */ + }; const char *color_string = arg_cnt >= 1 ? arg_strings[0] : NULL; const char *file_string = arg_cnt == 2 ? arg_strings[1] : NULL; @@ -676,12 +912,19 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceded by color string"); } - ret = lstat (color_string, &sb); + if ((ret = lstat (color_string, &sb)) == 0) /* exists */ + /* Ensure that we don't fail if there's a file with one or more + color names in its path. */ + use_conf_color = skip_path_colors (color_string, file_string, &sb, !!config->color); - /* Ensure that we don't fail if there's a file with one or more - color names in its path. */ - if (ret == 0) /* success */ - skip_path_colors (color_string, file_string, &sb); + /* Use color from config file. */ + if (arg_cnt == 1 + && (access (color_string, F_OK) != -1) + && use_conf_color) + { + file_string = color_string; + color_string = config->color; + } if ((p = strchr (color_string, COLOR_SEP_CHAR))) { @@ -762,8 +1005,8 @@ process_file_arg (const char *file_string, const char **file, FILE **stream) assert (*file != NULL); } -static void -skip_path_colors (const char *color_string, const char *file_string, const struct stat *sb) +static bool +skip_path_colors (const char *color_string, const char *file_string, const struct stat *sb, const bool has_conf) { bool have_file; unsigned int c; @@ -805,11 +1048,16 @@ skip_path_colors (const char *color_string, const char *file_string, const struc else { if (VALID_FILE_TYPE (mode)) - vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "must be preceded by color string"); + { + if (has_conf) + return true; + vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "must be preceded by color string"); + } else vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "is not a valid file type"); } } + return false; } static void @@ -905,7 +1153,7 @@ read_print_stream (const char *attr, const struct color **colors, const char *fi } else if (*eol == '\n') flags |= LF; - else + else /* never reached */ vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending"); p = eol + SKIP_LINE_ENDINGS (flags); *eol = '\0'; @@ -1346,13 +1594,14 @@ realloc_wrap (void *ptr, size_t size) return p; } #else +static const char *const format_debug = "%s: %10s %7lu bytes [source file %s, line %5u]\n"; static void * malloc_wrap_debug (size_t size, const char *file, unsigned int line) { void *p = malloc (size); if (!p) MEM_ALLOC_FAIL_DEBUG (file, line); - fprintf (log, "%s: malloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)size, file, line); + fprintf (log, format_debug, program_name, "malloc'ed", (unsigned long)size, file, line); return p; } @@ -1362,7 +1611,7 @@ calloc_wrap_debug (size_t nmemb, size_t size, const char *file, unsigned int lin void *p = calloc (nmemb, size); if (!p) MEM_ALLOC_FAIL_DEBUG (file, line); - fprintf (log, "%s: calloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)(nmemb * size), file, line); + fprintf (log, format_debug, program_name, "calloc'ed", (unsigned long)(nmemb * size), file, line); return p; } @@ -1372,7 +1621,7 @@ realloc_wrap_debug (void *ptr, size_t size, const char *file, unsigned int line) void *p = realloc (ptr, size); if (!p) MEM_ALLOC_FAIL_DEBUG (file, line); - fprintf (log, "%s: realloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)size, file, line); + fprintf (log, format_debug, program_name, "realloc'ed", (unsigned long)size, file, line); return p; } #endif /* !DEBUG */ @@ -1490,7 +1739,7 @@ open_file (const char *file, const char *mode) va_start (ap, fmt); \ vfprintf (stderr, fmt, ap); \ va_end (ap); \ - fprintf (stderr, "\n"); \ + fprintf (stderr, "\n"); static void vfprintf_diag (const char *fmt, ...)