X-Git-Url: http://git.refcnt.org/?p=colorize.git;a=blobdiff_plain;f=colorize.c;h=8a1cb5236adc3edd3e268afe70acef24eab4a658;hp=70de8488614cd2c2cbb24a8b8740b5c245f2584c;hb=HEAD;hpb=52a7c4ca9ae542e8e768daaffed6e3122b71d503 diff --git a/colorize.c b/colorize.c index 70de848..a1e1398 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-2016 Steven Schubiger + * Copyright (c) 2011-2019 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 @@ -19,6 +19,7 @@ * */ +#define _DEFAULT_SOURCE #define _BSD_SOURCE #define _XOPEN_SOURCE 700 #define _FILE_OFFSET_BITS 64 @@ -26,6 +27,7 @@ #include #include #include +#include #include #include #include @@ -35,6 +37,7 @@ #include #include #include +#include #ifndef DEBUG # define DEBUG 0 @@ -44,6 +47,7 @@ #define to_str(arg) str(arg) #define streq(s1, s2) (strcmp (s1, s2) == 0) +#define strneq(s1, s2, n) (strncmp (s1, s2, n) == 0) #if !DEBUG # define xmalloc(size) malloc_wrap(size) @@ -71,16 +75,20 @@ #define LF 0x01 #define CR 0x02 -#define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1) +#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)) -#define STACK_VAR(ptr) do { \ - stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \ +#define STACK_VAR(ptr) do { \ + stack (&vars_list, &stacked_vars, stacked_vars, ptr, IS_GENERIC); \ } while (false) - -#define RELEASE_VAR(ptr) do { \ - release_var (vars_list, stacked_vars, (void **)&ptr); \ +#define STACK_FILE(ptr) do { \ + stack (&vars_list, &stacked_vars, stacked_vars, ptr, IS_FILE); \ +} while (false) +#define RELEASE(ptr) do { \ + release (vars_list, stacked_vars, (void **)&ptr); \ } while (false) #if !DEBUG @@ -97,12 +105,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 @@ -114,12 +122,29 @@ # define COLOR_SEP_CHAR '/' #endif -#define DEBUG_FILE "debug.txt" +#define CONF_FILE ".colorize.conf" + +#if DEBUG +# define DEBUG_FILE "debug.txt" +#endif + +#define MAX_ATTRIBUTE_CHARS (6 * 2) -#define VERSION "0.59" +#define PROGRAM_NAME "colorize" + +#define VERSION "0.65" 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; @@ -160,7 +185,7 @@ struct bytes_size { char unit; }; -enum fmts { +enum { FMT_GENERIC, FMT_STRING, FMT_QUOTE, @@ -168,45 +193,89 @@ enum fmts { FMT_RANDOM, FMT_ERROR, FMT_FILE, - FMT_TYPE + FMT_TYPE, + FMT_CONF, + FMT_CONF_FILE }; static const char *formats[] = { - "%s", /* generic */ - "%s '%s'", /* string */ - "%s `%s' %s", /* quote */ - "%s color '%s' %s", /* color */ - "%s color '%s' %s '%s'", /* random */ - "less than %lu bytes %s", /* error */ - "%s: %s", /* file */ - "%s: %s: %s", /* type */ + "%s", /* generic */ + "%s '%s'", /* string */ + "%s `%s' %s", /* quote */ + "%s color '%s' %s", /* color */ + "%s color '%s' %s '%s'", /* random */ + "less than %lu bytes %s", /* error */ + "%s: %s", /* file */ + "%s: %s: %s", /* type */ + "%s: option '%s' %s", /* conf */ + "config file %s: %s" /* conf file */ }; enum { GENERIC, FOREGROUND = 0, BACKGROUND }; static const struct { - struct color const *entries; + const struct color *entries; 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" }, }; +static unsigned int opts_set; +enum opt_set { + OPT_ATTR_SET = 0x01, + OPT_EXCLUDE_RANDOM_SET = 0x02, + OPT_OMIT_COLOR_EMPTY_SET = 0x04 +}; +static struct { + char *attr; + char *exclude_random; +} opts_arg = { NULL, NULL }; + enum { - OPT_CLEAN = 1, + OPT_ATTR = 1, + OPT_CLEAN, OPT_CLEAN_ALL, + OPT_CONFIG, OPT_EXCLUDE_RANDOM, + OPT_OMIT_COLOR_EMPTY, OPT_HELP, OPT_VERSION }; static int opt_type; static const struct option long_opts[] = { - { "clean", no_argument, &opt_type, OPT_CLEAN }, - { "clean-all", no_argument, &opt_type, OPT_CLEAN_ALL }, - { "exclude-random", required_argument, &opt_type, OPT_EXCLUDE_RANDOM }, - { "help", no_argument, &opt_type, OPT_HELP }, - { "version", no_argument, &opt_type, OPT_VERSION }, - { NULL, 0, NULL, 0 }, + { "attr", required_argument, &opt_type, OPT_ATTR }, + { "clean", no_argument, &opt_type, OPT_CLEAN }, + { "clean-all", no_argument, &opt_type, OPT_CLEAN_ALL }, + { "config", required_argument, &opt_type, OPT_CONFIG }, + { "exclude-random", required_argument, &opt_type, OPT_EXCLUDE_RANDOM }, + { "omit-color-empty", no_argument, &opt_type, OPT_OMIT_COLOR_EMPTY }, + { "help", no_argument, &opt_type, OPT_HELP }, + { "version", no_argument, &opt_type, OPT_VERSION }, + { NULL, 0, NULL, 0 }, +}; + +enum attr_type { + ATTR_BOLD = 0x01, + ATTR_UNDERSCORE = 0x02, + ATTR_BLINK = 0x04, + ATTR_REVERSE = 0x08, + ATTR_CONCEALED = 0x10 +}; +struct attr { + const char *name; + unsigned int val; + enum attr_type type; +}; + +enum var_type { + IS_GENERIC, + IS_FILE, + IS_UNUSED +}; +struct var_list { + void *ptr; + enum var_type type; }; static FILE *stream; @@ -215,33 +284,47 @@ static FILE *log; #endif static unsigned int stacked_vars; -static void **vars_list; +static struct var_list *vars_list; static bool clean; static bool clean_all; +static bool omit_color_empty; +static char attr[MAX_ATTRIBUTE_CHARS + 1]; static char *exclude; static const char *program_name; -static void process_opts (int, char **); +#if DEBUG +static void print_tstamp (FILE *); +#endif +static void process_opts (int, char **, char **); +static void conf_file_path (char **); +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 init_opts_vars (void); 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 **, bool *, 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 void gather_color_names (const char *, bool *, struct color_name **); -static void read_print_stream (bool, const struct color **, const char *, FILE *); +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 *); static void complete_part_line (const char *, char **, FILE *); static bool get_next_char (char *, const char **, FILE *, bool *); static void save_char (char, char **, size_t *, size_t *); static void find_color_entries (struct color_name **, const struct color **); static void find_color_entry (const struct color_name *, unsigned int, const struct color **); -static void print_line (bool, const struct color **, const char * const, unsigned int); +static void print_line (const char *, const struct color **, const char * const, unsigned int, bool); static void print_clean (const char *); static bool is_esc (const char *); static const char *get_end_of_esc (const char *); @@ -249,9 +332,9 @@ static const char *get_end_of_text (const char *); static void print_text (const char *, size_t); static bool gather_esc_offsets (const char *, const char **, const char **); static bool validate_esc_clean_all (const char **); -static bool validate_esc_clean (int, unsigned int, const char **, bool *); +static bool validate_esc_clean (int, unsigned int, unsigned int *, const char **, bool *); static bool is_reset (int, unsigned int, const char **); -static bool is_bold (int, unsigned int, const char **); +static bool is_attr (int, unsigned int, unsigned int, const char **); static bool is_fg_color (int, const char **); static bool is_bg_color (int, unsigned int, const char **); #if !DEBUG @@ -266,24 +349,21 @@ static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int); static void free_wrap (void **); static char *strdup_wrap (const char *, const char *, unsigned int); static char *str_concat_wrap (const char *, const char *, const char *, unsigned int); +static char *expand_string (const char *); static bool get_bytes_size (unsigned long, struct bytes_size *); static char *get_file_type (mode_t); static bool has_color_name (const char *, const char *); static FILE *open_file (const char *, const char *); static void vfprintf_diag (const char *, ...); static void vfprintf_fail (const char *, ...); -static void stack_var (void ***, unsigned int *, unsigned int, void *); -static void release_var (void **, unsigned int, void **); - -extern int optind; +static void stack (struct var_list **, unsigned int *, unsigned int, void *, enum var_type); +static void release (struct var_list *, unsigned int, void **); int main (int argc, char **argv) { unsigned int arg_cnt; - bool bold = false; - const struct color *colors[2] = { NULL, /* foreground */ NULL, /* background */ @@ -291,6 +371,9 @@ main (int argc, char **argv) const char *file = NULL; + char *conf_file = NULL; + struct conf config = { NULL, NULL, NULL, NULL }; + program_name = argv[0]; atexit (cleanup); @@ -298,9 +381,50 @@ main (int argc, char **argv) #if DEBUG log = open_file (DEBUG_FILE, "w"); + print_tstamp (log); + /* We're in debugging mode, hence we can't invoke STACK_FILE() + prior to print_tstamp(), because both cause text to be written + to the same logfile which is expected to have the timestamp + first. */ + STACK_FILE (log); #endif - process_opts (argc, argv); + attr[0] = '\0'; + + process_opts (argc, argv, &conf_file); + +#ifdef CONF_FILE_TEST + conf_file = to_str (CONF_FILE_TEST); +#elif !defined(TEST) + if (conf_file == NULL) + { + conf_file_path (&conf_file); + STACK_VAR (conf_file); + } + else + { + char *s; + if ((s = expand_string (conf_file))) + { + free (conf_file); + conf_file = s; + } + STACK_VAR (conf_file); + errno = 0; + if (access (conf_file, F_OK) == -1) + vfprintf_fail (formats[FMT_CONF_FILE], conf_file, strerror (errno)); + } +#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) + RELEASE (conf_file); +#endif + init_conf_vars (&config); + + init_opts_vars (); arg_cnt = argc - optind; @@ -309,20 +433,27 @@ main (int argc, char **argv) if (clean && clean_all) 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"; - if (clean) - vfprintf_fail (format, "--clean", message); - else if (clean_all) - vfprintf_fail (format, "--clean-all", message); - } + vfprintf_fail ("--clean%s switch cannot be used with more than one file", clean_all ? "-all" : ""); + { + unsigned int i; + const struct option_set { + const char *option; + enum opt_set set; + } options[] = { + { "attr", OPT_ATTR_SET }, + { "exclude-random", OPT_EXCLUDE_RANDOM_SET }, + { "omit-color-empty", OPT_OMIT_COLOR_EMPTY_SET }, + }; + for (i = 0; i < COUNT_OF (options, struct option_set); i++) + if (opts_set & options[i].set) + vfprintf_diag ("--%s switch has no meaning with --clean%s", options[i].option, clean_all ? "-all" : ""); + } } else { if (arg_cnt == 0 || arg_cnt > 2) { - vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt); + vfprintf_diag ("%u arguments provided, expected 1-2 arguments or --clean[-all]", arg_cnt); print_hint (); exit (EXIT_FAILURE); } @@ -331,71 +462,101 @@ main (int argc, char **argv) if (clean || clean_all) process_file_arg (argv[optind], &file, &stream); else - process_args (arg_cnt, &argv[optind], &bold, colors, &file, &stream); - read_print_stream (bold, 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); + RELEASE (exclude); exit (EXIT_SUCCESS); } -#define SET_OPT_TYPE(type) \ - opt_type = type; \ - opt = 0; \ - goto PARSE_OPT; \ +#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 DUP_CONFIG() \ + *conf_file = xstrdup (optarg); \ + break; -extern char *optarg; +#define PRINT_HELP_EXIT() \ + print_help (); \ + exit (EXIT_SUCCESS); + +#define PRINT_VERSION_EXIT() \ + print_version (); \ + exit (EXIT_SUCCESS); static void -process_opts (int argc, char **argv) +process_opts (int argc, char **argv, char **conf_file) { int opt; - while ((opt = getopt_long (argc, argv, "hV", long_opts, NULL)) != -1) + while ((opt = getopt_long (argc, argv, "c:hV", long_opts, NULL)) != -1) { - PARSE_OPT: switch (opt) { case 0: /* long opts */ switch (opt_type) { + case OPT_ATTR: + opts_set |= OPT_ATTR_SET; + opts_arg.attr = xstrdup (optarg); + STACK_VAR (opts_arg.attr); + break; case OPT_CLEAN: clean = true; break; 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_CONFIG: + DUP_CONFIG (); + case OPT_EXCLUDE_RANDOM: + opts_set |= OPT_EXCLUDE_RANDOM_SET; + opts_arg.exclude_random = xstrdup (optarg); + STACK_VAR (opts_arg.exclude_random); + break; + case OPT_OMIT_COLOR_EMPTY: + opts_set |= OPT_OMIT_COLOR_EMPTY_SET; break; - } case OPT_HELP: - print_help (); - exit (EXIT_SUCCESS); + PRINT_HELP_EXIT (); case OPT_VERSION: - print_version (); - exit (EXIT_SUCCESS); + PRINT_VERSION_EXIT (); default: /* never reached */ ABORT_TRACE (); } break; + case 'c': + DUP_CONFIG (); case 'h': - SET_OPT_TYPE (OPT_HELP); + PRINT_HELP_EXIT (); case 'V': - SET_OPT_TYPE (OPT_VERSION); + PRINT_VERSION_EXIT (); case '?': print_hint (); exit (EXIT_FAILURE); @@ -405,6 +566,262 @@ process_opts (int argc, char **argv) } } +static void +conf_file_path (char **conf_file) +{ + char *path; + uid_t uid; + struct passwd *passwd; + size_t size; + + 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); + } + /* getpwuid() leaks memory */ + size = strlen (passwd->pw_dir) + 1 + strlen (CONF_FILE) + 1; + path = xmalloc (size); + snprintf (path, size, "%s/%s", passwd->pw_dir, CONF_FILE); + + *conf_file = path; +} + +static void +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[] = { + { "bold", 1, ATTR_BOLD }, + { "underscore", 4, ATTR_UNDERSCORE }, + { "blink", 5, ATTR_BLINK }, + { "reverse", 7, ATTR_REVERSE }, + { "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 ((unsigned char)*p)) + vfprintf_fail ("%s must be provided a string", desc_type[DESC_TYPE]); + s = p; + while (isalnum ((unsigned char)*p)) + p++; + if (*p != '\0' && *p != ',') + vfprintf_fail ("%s must have strings separated by ,", desc_type[DESC_TYPE]); + else + { + bool valid_attr = false; + unsigned int 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, is_opt); + valid_attr = true; + break; + } + } + if (!valid_attr) + { + char *attr_invalid = xmalloc ((p - s) + 1); + STACK_VAR (attr_invalid); + strncpy (attr_invalid, s, p - s); + attr_invalid[p - s] = '\0'; + vfprintf_fail ("%s attribute '%s' is not valid", desc_type[DESC_TYPE], attr_invalid); + RELEASE (attr_invalid); /* never reached */ + } + } + if (*p) + p++; + } +} + +static void +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 ("%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; + RELEASE (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 ? "--exclude-random switch" : "exclude-random conf option"); +} + +static void +init_opts_vars (void) +{ + if (opts_set & OPT_ATTR_SET) + { + attr[0] = '\0'; /* Clear attr string to discard values from the config file. */ + process_opt_attr (opts_arg.attr, true); + } + if (opts_set & OPT_EXCLUDE_RANDOM_SET) + process_opt_exclude_random (opts_arg.exclude_random, true); + if (opts_set & OPT_OMIT_COLOR_EMPTY_SET) + omit_color_empty = true; + + RELEASE (opts_arg.attr); + RELEASE (opts_arg.exclude_random); +} + +#define IS_SPACE(c) ((c) == ' ' || (c) == '\t') + +static void +parse_conf (const char *conf_file, struct conf *config) +{ + unsigned int cnt = 0; + char line[256 + 1]; + FILE *conf; + + conf = open_file (conf_file, "r"); + STACK_FILE (conf); + + while (fgets (line, sizeof (line), conf)) + { + char *cfg, *val; + char *assign, *comment, *opt, *value; + char *p; + + cnt++; + if ((p = strchr (line, '\r')) && *(p + 1) != '\n') + vfprintf_fail ("%s: CR ending of line %u is not supported, switch to CRLF/LF instead", conf_file, cnt); + if (strlen (line) > (sizeof (line) - 2)) + vfprintf_fail ("%s: line %u exceeds maximum of %u characters", conf_file, cnt, (unsigned int)(sizeof (line) - 2)); + if ((p = strpbrk (line, "\n\r"))) + *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 *s; + if ((s = strpbrk (opt, "# "))) + *s = '\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 ((unsigned char)*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); + STACK_VAR (cfg); + /* save option value (allow empty ones) */ + val = strlen (value) ? xstrdup (value) : NULL; + STACK_VAR (val); + + assign_conf (conf_file, config, cfg, val); + RELEASE (cfg); + } + + RELEASE (conf); +} + +#define ASSIGN_CONF(str,val) do { \ + RELEASE (str); \ + str = val; \ +} while (false) + +static void +assign_conf (const char *conf_file, struct conf *config, const char *cfg, char *val) +{ + if (streq (cfg, "attr")) + ASSIGN_CONF (config->attr, val); + else if (streq (cfg, "color")) + ASSIGN_CONF (config->color, val); + else if (streq (cfg, "exclude-random")) + ASSIGN_CONF (config->exclude_random, val); + else if (streq (cfg, "omit-color-empty")) + ASSIGN_CONF (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 (formats[FMT_GENERIC], "omit-color-empty conf option is not valid"); + } +} + static void print_hint (void) { @@ -414,13 +831,17 @@ print_hint (void) static void print_help (void) { - struct short_opt { + struct opt_data { const char *name; const char *short_opt; + const char *arg; }; - const struct short_opt short_opts[] = { - { "help", "h" }, - { "version", "V" }, + const struct opt_data opts_data[] = { + { "attr", NULL, "=ATTR1,ATTR2,..." }, + { "config", "c", "=PATH" }, + { "exclude-random", NULL, "=COLOR" }, + { "help", "h", NULL }, + { "version", "V", NULL }, }; const struct option *opt = long_opts; unsigned int i; @@ -434,7 +855,7 @@ print_help (void) const char *code = entry->code; if (code) printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n", - code, toupper (*name), *name, name + 1, 10 - (int)strlen (name), " ", name); + code, toupper ((unsigned char)*name), *name, name + 1, 10 - (int)strlen (name), " ", name); else printf ("\t\t{-} %s%*s%s\n", name, 13 - (int)strlen (name), " ", name); } @@ -446,18 +867,24 @@ print_help (void) printf ("\n\tOptions\n"); for (; opt->name; opt++) { - const char *short_opt = NULL; + const struct opt_data *opt_data = NULL; unsigned int i; - for (i = 0; i < sizeof (short_opts) / sizeof (struct short_opt); 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]; + break; + } + if (opt_data) { - if (streq (opt->name, short_opts[i].name)) - { - short_opt = short_opts[i].short_opt; - break; - } + if (opt_data->short_opt) + printf ("\t\t-%s, --%s", opt_data->short_opt, opt->name); + else + printf ("\t\t --%s", opt->name); + if (opt_data->arg) + printf ("%s", opt_data->arg); + printf ("\n"); } - if (short_opt) - printf ("\t\t-%s, --%s\n", short_opt, opt->name); else printf ("\t\t --%s\n", opt->name); } @@ -470,16 +897,27 @@ 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; + const char *c_flags, *ld_flags, *cpp_flags; + const char *const desc_flags_unknown = "unknown"; struct bytes_size bytes_size; bool debug; #ifdef CFLAGS c_flags = to_str (CFLAGS); #else - c_flags = "unknown"; + c_flags = desc_flags_unknown; +#endif +#ifdef LDFLAGS + ld_flags = to_str (LDFLAGS); +#else + ld_flags = desc_flags_unknown; +#endif +#ifdef CPPFLAGS + cpp_flags = to_str (CPPFLAGS); +#else + cpp_flags = desc_flags_unknown; #endif #if DEBUG debug = true; @@ -488,9 +926,11 @@ print_version (void) #endif version_prefix = version ? "" : "v"; version_string = version ? version : VERSION; - printf ("colorize %s%s (compiled at %s, %s)\n", version_prefix, version_string, __DATE__, __TIME__); + printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME, version_prefix, version_string, __DATE__, __TIME__); printf ("Compiler flags: %s\n", c_flags); + printf ("Linker flags: %s\n", ld_flags); + printf ("Preprocessor flags: %s\n", cpp_flags); if (get_bytes_size (BUF_SIZE, &bytes_size)) { if (BUF_SIZE % 1024 == 0) @@ -509,17 +949,32 @@ static void cleanup (void) { if (stream && fileno (stream) != STDIN_FILENO) - fclose (stream); + RELEASE (stream); #if DEBUG if (log) - fclose (log); + RELEASE (log); #endif if (vars_list) { unsigned int i; for (i = 0; i < stacked_vars; i++) - free (vars_list[i]); + { + struct var_list *var = &vars_list[i]; + switch (var->type) + { + case IS_GENERIC: + free (var->ptr); + break; + case IS_FILE: + fclose (var->ptr); + break; + case IS_UNUSED: + break; + default: /* never reached */ + ABORT_TRACE (); + } + } free_null (vars_list); } } @@ -530,39 +985,64 @@ free_color_names (struct color_name **color_names) unsigned int i; for (i = 0; color_names[i]; i++) { - RELEASE_VAR (color_names[i]->name); - RELEASE_VAR (color_names[i]->orig); - RELEASE_VAR (color_names[i]); + RELEASE (color_names[i]->name); + RELEASE (color_names[i]->orig); + RELEASE (color_names[i]); } } static void -process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct color **colors, const char **file, FILE **stream) +free_conf (struct conf *config) { + RELEASE (config->attr); + RELEASE (config->color); + RELEASE (config->exclude_random); + RELEASE (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 has_hyphen, 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; - assert (color_string); + assert (color_string != NULL); + + has_hyphen = streq (color_string, "-"); - if (streq (color_string, "-")) + if (has_hyphen) { if (file_string) vfprintf_fail (formats[FMT_GENERIC], "hyphen cannot be used as color string"); - else + else if (!config->color) vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceded by color string"); } - ret = lstat (color_string, &sb); + if (!has_hyphen && (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); + else if (has_hyphen) + use_conf_color = true; + else + use_conf_color = false; - /* 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 && use_conf_color) + { + file_string = color_string; + color_string = config->color; + } if ((p = strchr (color_string, COLOR_SEP_CHAR))) { @@ -574,9 +1054,9 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct vfprintf_fail (formats[FMT_STRING], "one color pair allowed only for string", color_string); } - gather_color_names (color_string, bold, color_names); + gather_color_names (color_string, attr, color_names); - assert (color_names[FOREGROUND]); + assert (color_names[FOREGROUND] != NULL); if (color_names[BACKGROUND]) { @@ -592,6 +1072,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct } find_color_entries (color_names, colors); + assert (colors[FOREGROUND] != NULL); free_color_names (color_names); if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code) @@ -600,6 +1081,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct color_name.name = color_name.orig = "default"; find_color_entry (&color_name, FOREGROUND, colors); + assert (colors[FOREGROUND]->code != NULL); } process_file_arg (file_string, file, stream); @@ -628,6 +1110,7 @@ process_file_arg (const char *file_string, const char **file, FILE **stream) vfprintf_fail (formats[FMT_TYPE], file, "unrecognized type", get_file_type (sb.st_mode)); *stream = open_file (file, "r"); + STACK_FILE (*stream); } *file = file_string; } @@ -637,12 +1120,12 @@ process_file_arg (const char *file_string, const char **file, FILE **stream) *file = "stdin"; } - assert (*stream); - assert (*file); + assert (*stream != NULL); + 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; @@ -678,21 +1161,26 @@ skip_path_colors (const char *color_string, const char *file_string, const struc if (have_file) { - const char *file_exists = color_string; + const char *file_existing = color_string; if (file_string) - vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "cannot be used as color string"); + vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "cannot be used as color string"); else { if (VALID_FILE_TYPE (mode)) - vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "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_exists, "is not a valid file type"); + vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "is not a valid file type"); } } + return false; } static void -gather_color_names (const char *color_string, bool *bold, struct color_name **color_names) +gather_color_names (const char *color_string, char *attr, struct color_name **color_names) { unsigned int index; char *color, *p, *str; @@ -712,28 +1200,29 @@ gather_color_names (const char *color_string, bool *bold, struct color_name **co } else p = color + strlen (color); - assert (p); + assert (p != NULL); for (ch = color; *ch; ch++) - if (!isalpha (*ch)) + if (!isalpha ((unsigned char)*ch)) vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be made of non-alphabetic characters"); for (ch = color + 1; *ch; ch++) - if (!islower (*ch)) + if (!islower ((unsigned char)*ch)) vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be in mixed lower/upper case"); if (streq (color, "None")) vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be bold"); - if (isupper (*color)) + if (isupper ((unsigned char)*color)) { switch (index) { case FOREGROUND: - *bold = true; + snprintf (attr + strlen (attr), 3, "1;"); break; case BACKGROUND: vfprintf_fail (formats[FMT_COLOR], tables[BACKGROUND].desc, color, "cannot be bold"); + break; default: /* never reached */ ABORT_TRACE (); } @@ -746,17 +1235,17 @@ gather_color_names (const char *color_string, bool *bold, struct color_name **co STACK_VAR (color_names[index]->orig); for (ch = color; *ch; ch++) - *ch = tolower (*ch); + *ch = tolower ((unsigned char)*ch); color_names[index]->name = xstrdup (color); STACK_VAR (color_names[index]->name); } - RELEASE_VAR (str); + RELEASE (str); } static void -read_print_stream (bool bold, const struct color **colors, const char *file, FILE *stream) +read_print_stream (const char *attr, const struct color **colors, const char *file, FILE *stream) { char buf[BUF_SIZE + 1]; unsigned int flags = 0; @@ -773,7 +1262,8 @@ read_print_stream (bool bold, const struct color **colors, const char *file, FIL line = buf; while ((eol = strpbrk (line, "\n\r"))) { - char *p; + const bool has_text = (eol > line); + const char *p; flags &= ~(CR|LF); if (*eol == '\r') { @@ -783,17 +1273,18 @@ read_print_stream (bool bold, const struct color **colors, const char *file, FIL } 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'; - print_line (bold, colors, line, flags); + print_line (attr, colors, line, flags, + omit_color_empty ? has_text : true); line = p; } if (feof (stream)) { if (*line != '\0') - print_line (bold, colors, line, 0); + print_line (attr, colors, line, 0, true); } else if (*line != '\0') { @@ -801,7 +1292,7 @@ read_print_stream (bool bold, const struct color **colors, const char *file, FIL if ((clean || clean_all) && (p = strrchr (line, '\033'))) merge_print_line (line, p, stream); else - print_line (bold, colors, line, 0); + print_line (attr, colors, line, 0, true); } } } @@ -868,7 +1359,7 @@ complete_part_line (const char *p, char **buf, FILE *stream) if (read_from_stream) save_char (ch, buf, &i, &size); } - else /* read next character */ + else /* got next character */ { got_next_char = true; break; @@ -1008,18 +1499,19 @@ find_color_entry (const struct color_name *color_name, unsigned int index, const } static void -print_line (bool bold, const struct color **colors, const char *const line, unsigned int flags) +print_line (const char *attr, const struct color **colors, const char *const line, unsigned int flags, bool emit_colors) { /* --clean[-all] */ if (clean || clean_all) print_clean (line); - else + /* skip for --omit-color-empty? */ + else if (emit_colors) { /* Foreground color code is guaranteed to be set when background color code is present. */ if (colors[BACKGROUND] && colors[BACKGROUND]->code) printf ("\033[%s", colors[BACKGROUND]->code); if (colors[FOREGROUND]->code) - printf ("\033[%s%s%s\033[0m", bold ? "1;" : "", colors[FOREGROUND]->code, line); + printf ("\033[%s%s%s\033[0m", attr, colors[FOREGROUND]->code, line); else printf (formats[FMT_GENERIC], line); } @@ -1103,15 +1595,16 @@ gather_esc_offsets (const char *p, const char **start, const char **end) else if (clean) { bool check_values; - unsigned int iter = 0; + unsigned int prev_iter, iter; const char *digit; + prev_iter = iter = 0; do { check_values = false; iter++; - if (!isdigit (*p)) + if (!isdigit ((unsigned char)*p)) break; digit = p; - while (isdigit (*p)) + while (isdigit ((unsigned char)*p)) p++; if (p - digit > 2) break; @@ -1125,7 +1618,7 @@ gather_esc_offsets (const char *p, const char **start, const char **end) val[i] = *digit++; val[i] = '\0'; value = atoi (val); - valid = validate_esc_clean (value, iter, &p, &check_values); + valid = validate_esc_clean (value, iter, &prev_iter, &p, &check_values); } } while (check_values); } @@ -1144,20 +1637,21 @@ gather_esc_offsets (const char *p, const char **start, const char **end) static bool validate_esc_clean_all (const char **p) { - while (isdigit (**p) || **p == ';') + while (isdigit ((unsigned char)**p) || **p == ';') (*p)++; return (**p == 'm'); } static bool -validate_esc_clean (int value, unsigned int iter, const char **p, bool *check_values) +validate_esc_clean (int value, unsigned int iter, unsigned int *prev_iter, const char **p, bool *check_values) { if (is_reset (value, iter, p)) return true; - else if (is_bold (value, iter, p)) + else if (is_attr (value, iter, *prev_iter, p)) { (*p)++; *check_values = true; + *prev_iter = iter; return false; /* partial escape sequence, need another valid value */ } else if (is_fg_color (value, p)) @@ -1175,9 +1669,9 @@ is_reset (int value, unsigned int iter, const char **p) } static bool -is_bold (int value, unsigned int iter, const char **p) +is_attr (int value, unsigned int iter, unsigned int prev_iter, const char **p) { - return (value == 1 && iter == 1 && **p == ';'); + return ((value > 0 && value < 10) && (iter - prev_iter == 1) && **p == ';'); } static bool @@ -1220,13 +1714,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; } @@ -1236,7 +1731,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; } @@ -1246,7 +1741,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 */ @@ -1289,6 +1784,20 @@ str_concat_wrap (const char *str1, const char *str2, const char *file, unsigned return str; } +static char * +expand_string (const char *str) +{ + char *s = NULL; + wordexp_t p; + + wordexp (str, &p, 0); + if (p.we_wordc >= 1) + s = xstrdup (p.we_wordv[0]); + wordfree (&p); + + return s; +} + static bool get_bytes_size (unsigned long bytes, struct bytes_size *bytes_size) { @@ -1333,16 +1842,16 @@ has_color_name (const char *str, const char *name) { char *p; - assert (strlen (str)); - assert (strlen (name)); + assert (strlen (str) > 0); + assert (strlen (name) > 0); - if (!(*str == *name || *str == toupper (*name))) + if (!(*str == *name || *str == toupper ((unsigned char)*name))) return false; else if (*(name + 1) != '\0' && !((p = strstr (str + 1, name + 1)) && p == str + 1)) return false; - - return true; + else + return true; } static FILE * @@ -1364,7 +1873,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, ...) @@ -1380,41 +1889,63 @@ vfprintf_fail (const char *fmt, ...) } static void -stack_var (void ***list, unsigned int *stacked, unsigned int index, void *ptr) +stack (struct var_list **list, unsigned int *stacked, unsigned int index, void *ptr, enum var_type type) { + struct var_list *var; /* nothing to stack */ if (ptr == NULL) return; if (!*list) - *list = xmalloc (sizeof (void *)); + *list = xmalloc (sizeof (struct var_list)); else { unsigned int i; for (i = 0; i < *stacked; i++) - if (!(*list)[i]) - { - (*list)[i] = ptr; - return; /* reused */ - } - *list = xrealloc (*list, (*stacked + 1) * sizeof (void *)); + { + var = &(*list)[i]; + if (var->type == IS_UNUSED) + { + var->ptr = ptr; + var->type = type; + return; /* reused */ + } + } + *list = xrealloc (*list, (*stacked + 1) * sizeof (struct var_list)); } - (*list)[index] = ptr; + var = &(*list)[index]; + var->ptr = ptr; + var->type = type; (*stacked)++; } static void -release_var (void **list, unsigned int stacked, void **ptr) +release (struct var_list *list, unsigned int stacked, void **ptr) { unsigned int i; /* nothing to release */ if (*ptr == NULL) return; for (i = 0; i < stacked; i++) - if (list[i] == *ptr) - { - free (*ptr); - *ptr = NULL; - list[i] = NULL; - return; + { + struct var_list *var = &list[i]; + if (var->type != IS_UNUSED + && var->ptr == *ptr) + { + switch (var->type) + { + case IS_GENERIC: + free (*ptr); + break; + case IS_FILE: + fclose (*ptr); + break; + default: /* never reached */ + ABORT_TRACE (); + } + *ptr = NULL; + var->ptr = NULL; + var->type = IS_UNUSED; + return; } + } }