colorize.c

   1 /*
   2  * colorize - Read text from standard input stream or file and print
   3  *            it colorized through use of ANSI escape sequences
   4  *
   5  * Copyright (c) 2011-2018 Steven Schubiger
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 #define _DEFAULT_SOURCE
  23 #define _BSD_SOURCE
  24 #define _XOPEN_SOURCE 700
  25 #define _FILE_OFFSET_BITS 64
  26 #include <assert.h>
  27 #include <ctype.h>
  28 #include <errno.h>
  29 #include <getopt.h>
  30 #include <pwd.h>
  31 #include <stdarg.h>
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35 #include <sys/time.h>
  36 #include <sys/types.h>
  37 #include <sys/stat.h>
  38 #include <time.h>
  39 #include <unistd.h>
  40 #include <wordexp.h>
  41
  42 #ifndef DEBUG
  43 # define DEBUG 0
  44 #endif
  45
  46 #define str(arg) #arg
  47 #define to_str(arg) str(arg)
  48
  49 #define streq(s1, s2) (strcmp (s1, s2) == 0)
  50 #define strneq(s1, s2, n) (strncmp (s1, s2, n) == 0)
  51
  52 #if !DEBUG
  53 # define xmalloc(size)          malloc_wrap(size)
  54 # define xcalloc(nmemb, size)   calloc_wrap(nmemb, size)
  55 # define xrealloc(ptr, size)    realloc_wrap(ptr, size)
  56 # define xstrdup(str)           strdup_wrap(str,            NULL, 0)
  57 # define str_concat(str1, str2) str_concat_wrap(str1, str2, NULL, 0)
  58 #else
  59 # define xmalloc(size)          malloc_wrap_debug(size,        __FILE__, __LINE__)
  60 # define xcalloc(nmemb, size)   calloc_wrap_debug(nmemb, size, __FILE__, __LINE__)
  61 # define xrealloc(ptr, size)    realloc_wrap_debug(ptr, size,  __FILE__, __LINE__)
  62 # define xstrdup(str)           strdup_wrap(str,               __FILE__, __LINE__)
  63 # define str_concat(str1, str2) str_concat_wrap(str1, str2,    __FILE__, __LINE__)
  64 #endif
  65
  66 #define free_null(ptr) free_wrap((void **)&ptr)
  67
  68 #if defined(BUF_SIZE) && (BUF_SIZE <= 0 || BUF_SIZE > 65536)
  69 # undef BUF_SIZE
  70 #endif
  71 #ifndef BUF_SIZE
  72 # define BUF_SIZE 4096
  73 #endif
  74
  75 #define LF 0x01
  76 #define CR 0x02
  77
  78 #define COUNT_OF(obj, type) (sizeof (obj) / sizeof (type))
  79
  80 #define SKIP_LINE_ENDINGS(flags) ((flags) == (CR|LF) ? 2 : 1)
  81
  82 #define VALID_FILE_TYPE(mode) (S_ISREG (mode) || S_ISLNK (mode) || S_ISFIFO (mode))
  83
  84 #define STACK_VAR(ptr) do {                                   \
  85     stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
  86 } while (false)
  87
  88 #define RELEASE_VAR(ptr) do {                             \
  89     release_var (vars_list, stacked_vars, (void **)&ptr); \
  90 } while (false)
  91
  92 #if !DEBUG
  93 # define MEM_ALLOC_FAIL() do {                                         \
  94     fprintf (stderr, "%s: memory allocation failure\n", program_name); \
  95     exit (EXIT_FAILURE);                                               \
  96 } while (false)
  97 #else
  98 # define MEM_ALLOC_FAIL_DEBUG(file, line) do {                                              \
  99     fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
 100     exit (EXIT_FAILURE);                                                                    \
 101 } while (false)
 102 #endif
 103
 104 #define ABORT_TRACE()                                                              \
 105     fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
 106     abort ();
 107
 108 #define CHECK_COLORS_RANDOM(color1, color2)        \
 109      streq (color_names[color1]->name, "random")   \
 110  && (streq (color_names[color2]->name, "none")     \
 111   || streq (color_names[color2]->name, "default"))
 112
 113 #define ALLOC_COMPLETE_PART_LINE 8
 114
 115 #if defined(COLOR_SEP_CHAR_COLON)
 116 # define COLOR_SEP_CHAR ':'
 117 #elif defined(COLOR_SEP_CHAR_SLASH)
 118 # define COLOR_SEP_CHAR '/'
 119 #else
 120 # define COLOR_SEP_CHAR '/'
 121 #endif
 122
 123 #define CONF_FILE ".colorize.conf"
 124
 125 #if DEBUG
 126 # define DEBUG_FILE "debug.txt"
 127 #endif
 128
 129 #define MAX_ATTRIBUTE_CHARS (6 * 2)
 130
 131 #define PROGRAM_NAME "colorize"
 132
 133 #define VERSION "0.64"
 134
 135 typedef enum { false, true } bool;
 136
 137 struct conf {
 138     char *attr;
 139     char *color;
 140     char *exclude_random;
 141     char *omit_color_empty;
 142 };
 143
 144 enum { DESC_OPTION, DESC_CONF };
 145
 146 struct color_name {
 147     char *name;
 148     char *orig;
 149 };
 150
 151 struct color {
 152     const char *name;
 153     const char *code;
 154 };
 155
 156 static const struct color fg_colors[] = {
 157     { "none",     NULL },
 158     { "black",   "30m" },
 159     { "red",     "31m" },
 160     { "green",   "32m" },
 161     { "yellow",  "33m" },
 162     { "blue",    "34m" },
 163     { "magenta", "35m" },
 164     { "cyan",    "36m" },
 165     { "white",   "37m" },
 166     { "default", "39m" },
 167 };
 168 static const struct color bg_colors[] = {
 169     { "none",     NULL },
 170     { "black",   "40m" },
 171     { "red",     "41m" },
 172     { "green",   "42m" },
 173     { "yellow",  "43m" },
 174     { "blue",    "44m" },
 175     { "magenta", "45m" },
 176     { "cyan",    "46m" },
 177     { "white",   "47m" },
 178     { "default", "49m" },
 179 };
 180
 181 struct bytes_size {
 182     unsigned int size;
 183     char unit;
 184 };
 185
 186 enum {
 187     FMT_GENERIC,
 188     FMT_STRING,
 189     FMT_QUOTE,
 190     FMT_COLOR,
 191     FMT_RANDOM,
 192     FMT_ERROR,
 193     FMT_FILE,
 194     FMT_TYPE,
 195     FMT_CONF
 196 };
 197 static const char *formats[] = {
 198     "%s",                     /* generic */
 199     "%s '%s'",                /* string  */
 200     "%s `%s' %s",             /* quote   */
 201     "%s color '%s' %s",       /* color   */
 202     "%s color '%s' %s '%s'",  /* random  */
 203     "less than %lu bytes %s", /* error   */
 204     "%s: %s",                 /* file    */
 205     "%s: %s: %s",             /* type    */
 206     "%s: option '%s' %s"      /* conf    */
 207 };
 208
 209 enum { GENERIC, FOREGROUND = 0, BACKGROUND };
 210
 211 static const struct {
 212     const struct color *entries;
 213     unsigned int count;
 214     const char *desc;
 215 } tables[] = {
 216     { fg_colors, COUNT_OF (fg_colors, struct color), "foreground" },
 217     { bg_colors, COUNT_OF (bg_colors, struct color), "background" },
 218 };
 219
 220 static unsigned int opts_set;
 221 enum {
 222     OPT_ATTR_SET = 0x01,
 223     OPT_EXCLUDE_RANDOM_SET = 0x02,
 224     OPT_OMIT_COLOR_EMPTY_SET = 0x04
 225 };
 226 static struct {
 227     char *attr;
 228     char *exclude_random;
 229 } opts_arg = { NULL, NULL };
 230
 231 enum {
 232     OPT_ATTR = 1,
 233     OPT_CLEAN,
 234     OPT_CLEAN_ALL,
 235     OPT_CONFIG,
 236     OPT_EXCLUDE_RANDOM,
 237     OPT_OMIT_COLOR_EMPTY,
 238     OPT_HELP,
 239     OPT_VERSION
 240 };
 241 static int opt_type;
 242 static const struct option long_opts[] = {
 243     { "attr",             required_argument, &opt_type, OPT_ATTR             },
 244     { "clean",            no_argument,       &opt_type, OPT_CLEAN            },
 245     { "clean-all",        no_argument,       &opt_type, OPT_CLEAN_ALL        },
 246     { "config",           required_argument, &opt_type, OPT_CONFIG           },
 247     { "exclude-random",   required_argument, &opt_type, OPT_EXCLUDE_RANDOM   },
 248     { "omit-color-empty", no_argument,       &opt_type, OPT_OMIT_COLOR_EMPTY },
 249     { "help",             no_argument,       &opt_type, OPT_HELP             },
 250     { "version",          no_argument,       &opt_type, OPT_VERSION          },
 251     {  NULL,              0,                 NULL,      0                    },
 252 };
 253
 254 enum attr_type {
 255     ATTR_BOLD = 0x01,
 256     ATTR_UNDERSCORE = 0x02,
 257     ATTR_BLINK = 0x04,
 258     ATTR_REVERSE = 0x08,
 259     ATTR_CONCEALED = 0x10
 260 };
 261 struct attr {
 262     const char *name;
 263     unsigned int val;
 264     enum attr_type type;
 265 };
 266
 267 static FILE *stream;
 268 #if DEBUG
 269 static FILE *log;
 270 #endif
 271
 272 static unsigned int stacked_vars;
 273 static void **vars_list;
 274
 275 static bool clean;
 276 static bool clean_all;
 277 static bool omit_color_empty;
 278
 279 static char attr[MAX_ATTRIBUTE_CHARS + 1];
 280 static char *exclude;
 281
 282 static const char *program_name;
 283
 284 #if DEBUG
 285 static void print_tstamp (FILE *);
 286 #endif
 287 static void process_opts (int, char **, char **);
 288 static void process_opt_attr (const char *, const bool);
 289 static void write_attr (const struct attr *, unsigned int *, const bool);
 290 static void process_opt_exclude_random (const char *, const bool);
 291 static void parse_conf (const char *, struct conf *);
 292 static void assign_conf (const char *, struct conf *, const char *, char *);
 293 static void init_conf_vars (const struct conf *);
 294 static void init_opts_vars (void);
 295 static void print_hint (void);
 296 static void print_help (void);
 297 static void print_version (void);
 298 static void cleanup (void);
 299 static void free_color_names (struct color_name **);
 300 static void free_conf (struct conf *);
 301 static void process_args (unsigned int, char **, char *, const struct color **, const char **, FILE **, struct conf *);
 302 static void process_file_arg (const char *, const char **, FILE **);
 303 static bool skip_path_colors (const char *, const char *, const struct stat *, const bool);
 304 static void gather_color_names (const char *, char *, struct color_name **);
 305 static void read_print_stream (const char *, const struct color **, const char *, FILE *);
 306 static void merge_print_line (const char *, const char *, FILE *);
 307 static void complete_part_line (const char *, char **, FILE *);
 308 static bool get_next_char (char *, const char **, FILE *, bool *);
 309 static void save_char (char, char **, size_t *, size_t *);
 310 static void find_color_entries (struct color_name **, const struct color **);
 311 static void find_color_entry (const struct color_name *, unsigned int, const struct color **);
 312 static void print_line (const char *, const struct color **, const char * const, unsigned int, bool);
 313 static void print_clean (const char *);
 314 static bool is_esc (const char *);
 315 static const char *get_end_of_esc (const char *);
 316 static const char *get_end_of_text (const char *);
 317 static void print_text (const char *, size_t);
 318 static bool gather_esc_offsets (const char *, const char **, const char **);
 319 static bool validate_esc_clean_all (const char **);
 320 static bool validate_esc_clean (int, unsigned int, unsigned int *, const char **, bool *);
 321 static bool is_reset (int, unsigned int, const char **);
 322 static bool is_attr (int, unsigned int, unsigned int, const char **);
 323 static bool is_fg_color (int, const char **);
 324 static bool is_bg_color (int, unsigned int, const char **);
 325 #if !DEBUG
 326 static void *malloc_wrap (size_t);
 327 static void *calloc_wrap (size_t, size_t);
 328 static void *realloc_wrap (void *, size_t);
 329 #else
 330 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
 331 static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
 332 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
 333 #endif
 334 static void free_wrap (void **);
 335 static char *strdup_wrap (const char *, const char *, unsigned int);
 336 static char *str_concat_wrap (const char *, const char *, const char *, unsigned int);
 337 static char *expand_string (const char *);
 338 static bool get_bytes_size (unsigned long, struct bytes_size *);
 339 static char *get_file_type (mode_t);
 340 static bool has_color_name (const char *, const char *);
 341 static FILE *open_file (const char *, const char *);
 342 static void vfprintf_diag (const char *, ...);
 343 static void vfprintf_fail (const char *, ...);
 344 static void stack_var (void ***, unsigned int *, unsigned int, void *);
 345 static void release_var (void **, unsigned int, void **);
 346
 347 extern int optind;
 348
 349 int
 350 main (int argc, char **argv)
 351 {
 352     unsigned int arg_cnt;
 353
 354     const struct color *colors[2] = {
 355         NULL, /* foreground */
 356         NULL, /* background */
 357     };
 358
 359     const char *file = NULL;
 360
 361     char *conf_file = NULL;
 362     struct conf config = { NULL, NULL, NULL, NULL };
 363
 364     program_name = argv[0];
 365     atexit (cleanup);
 366
 367     setvbuf (stdout, NULL, _IOLBF, 0);
 368
 369 #if DEBUG
 370     log = open_file (DEBUG_FILE, "w");
 371     print_tstamp (log);
 372 #endif
 373
 374     attr[0] = '\0';
 375
 376     process_opts (argc, argv, &conf_file);
 377
 378 #ifdef CONF_FILE_TEST
 379     conf_file = to_str (CONF_FILE_TEST);
 380 #elif !defined(TEST)
 381     if (conf_file == NULL)
 382       {
 383         uid_t uid;
 384         struct passwd *passwd;
 385         size_t size;
 386
 387         uid = getuid ();
 388         errno = 0;
 389         if ((passwd = getpwuid (uid)) == NULL)
 390           {
 391             if (errno == 0)
 392               vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid);
 393             else
 394               perror ("getpwuid");
 395             exit (EXIT_FAILURE);
 396           }
 397         size = strlen (passwd->pw_dir) + 1 + strlen (CONF_FILE) + 1;
 398         conf_file = xmalloc (size);
 399         snprintf (conf_file, size, "%s/%s", passwd->pw_dir, CONF_FILE);
 400       }
 401     else
 402       {
 403         char *s;
 404         if ((s = expand_string (conf_file)))
 405           {
 406             free (conf_file);
 407             conf_file = s;
 408           }
 409         errno = 0;
 410         if (access (conf_file, F_OK) == -1)
 411           vfprintf_fail (formats[FMT_FILE], conf_file, strerror (errno));
 412       }
 413 #endif
 414 #if defined(CONF_FILE_TEST) || !defined(TEST)
 415     if (access (conf_file, F_OK) != -1)
 416       parse_conf (conf_file, &config);
 417 #endif
 418 #if !defined(CONF_FILE_TEST) && !defined(TEST)
 419     free (conf_file);
 420 #endif
 421     init_conf_vars (&config);
 422
 423     init_opts_vars ();
 424
 425     arg_cnt = argc - optind;
 426
 427     if (clean || clean_all)
 428       {
 429         if (clean && clean_all)
 430           vfprintf_fail (formats[FMT_GENERIC], "--clean and --clean-all switch are mutually exclusive");
 431         if (arg_cnt > 1)
 432           {
 433             const char *const format = "%s %s";
 434             const char *const message = "switch cannot be used with more than one file";
 435             if (clean)
 436               vfprintf_fail (format, "--clean", message);
 437             else if (clean_all)
 438               vfprintf_fail (format, "--clean-all", message);
 439           }
 440       }
 441     else
 442       {
 443         if (arg_cnt == 0 || arg_cnt > 2)
 444           {
 445             vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt);
 446             print_hint ();
 447             exit (EXIT_FAILURE);
 448           }
 449       }
 450
 451     if (clean || clean_all)
 452       process_file_arg (argv[optind], &file, &stream);
 453     else
 454       process_args (arg_cnt, &argv[optind], &attr[0], colors, &file, &stream, &config);
 455     read_print_stream (&attr[0], colors, file, stream);
 456
 457     free_conf (&config);
 458
 459     RELEASE_VAR (exclude);
 460
 461     exit (EXIT_SUCCESS);
 462 }
 463
 464 #if DEBUG
 465 static void
 466 print_tstamp (FILE *log)
 467 {
 468     time_t t;
 469     struct tm *tm;
 470     char str[128];
 471     size_t written;
 472
 473     t = time (NULL);
 474     tm = localtime (&t);
 475     if (tm == NULL)
 476       {
 477         perror ("localtime");
 478         exit (EXIT_FAILURE);
 479       }
 480     written = strftime (str, sizeof (str), "%Y-%m-%d %H:%M:%S %Z", tm);
 481     if (written == 0)
 482       vfprintf_fail (formats[FMT_GENERIC], "strftime: 0 returned");
 483
 484     fprintf (log, "%s\n", str);
 485     while (written--)
 486       fprintf (log, "=");
 487     fprintf (log, "\n");
 488 }
 489 #endif
 490
 491 #define DUP_CONFIG()               \
 492     *conf_file = xstrdup (optarg); \
 493     break;
 494
 495 #define PRINT_HELP_EXIT() \
 496     print_help ();        \
 497     exit (EXIT_SUCCESS);
 498
 499 #define PRINT_VERSION_EXIT() \
 500     print_version ();        \
 501     exit (EXIT_SUCCESS);
 502
 503 extern char *optarg;
 504
 505 static void
 506 process_opts (int argc, char **argv, char **conf_file)
 507 {
 508     int opt;
 509     while ((opt = getopt_long (argc, argv, "c:hV", long_opts, NULL)) != -1)
 510       {
 511         switch (opt)
 512           {
 513             case 0: /* long opts */
 514               switch (opt_type)
 515                 {
 516                   case OPT_ATTR:
 517                     opts_set |= OPT_ATTR_SET;
 518                     opts_arg.attr = xstrdup (optarg);
 519                     break;
 520                   case OPT_CLEAN:
 521                     clean = true;
 522                     break;
 523                   case OPT_CLEAN_ALL:
 524                     clean_all = true;
 525                     break;
 526                   case OPT_CONFIG:
 527                     DUP_CONFIG ();
 528                   case OPT_EXCLUDE_RANDOM:
 529                     opts_set |= OPT_EXCLUDE_RANDOM_SET;
 530                     opts_arg.exclude_random = xstrdup (optarg);
 531                     break;
 532                   case OPT_OMIT_COLOR_EMPTY:
 533                     opts_set |= OPT_OMIT_COLOR_EMPTY_SET;
 534                     break;
 535                   case OPT_HELP:
 536                     PRINT_HELP_EXIT ();
 537                   case OPT_VERSION:
 538                     PRINT_VERSION_EXIT ();
 539                   default: /* never reached */
 540                     ABORT_TRACE ();
 541                 }
 542               break;
 543             case 'c':
 544               DUP_CONFIG ();
 545             case 'h':
 546               PRINT_HELP_EXIT ();
 547             case 'V':
 548               PRINT_VERSION_EXIT ();
 549             case '?':
 550               print_hint ();
 551               exit (EXIT_FAILURE);
 552             default: /* never reached */
 553               ABORT_TRACE ();
 554           }
 555       }
 556 }
 557
 558 static void
 559 process_opt_attr (const char *p, const bool is_opt)
 560 {
 561     /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS!  */
 562     const struct attr attrs[] = {
 563         { "bold",       1, ATTR_BOLD       },
 564         { "underscore", 4, ATTR_UNDERSCORE },
 565         { "blink",      5, ATTR_BLINK      },
 566         { "reverse",    7, ATTR_REVERSE    },
 567         { "concealed",  8, ATTR_CONCEALED  },
 568     };
 569     unsigned int attr_types = 0;
 570     const char *desc_type[2] = { "--attr switch", "attr conf option" };
 571     const unsigned int DESC_TYPE = is_opt ? DESC_OPTION : DESC_CONF;
 572
 573     while (*p)
 574       {
 575         const char *s;
 576         if (!isalnum (*p))
 577           vfprintf_fail ("%s must be provided a string", desc_type[DESC_TYPE]);
 578         s = p;
 579         while (isalnum (*p))
 580           p++;
 581         if (*p != '\0' && *p != ',')
 582           vfprintf_fail ("%s must have strings separated by ,", desc_type[DESC_TYPE]);
 583         else
 584           {
 585             bool valid_attr = false;
 586             unsigned int i;
 587             for (i = 0; i < COUNT_OF (attrs, struct attr); i++)
 588               {
 589                 const size_t name_len = strlen (attrs[i].name);
 590                 if ((size_t)(p - s) == name_len && strneq (s, attrs[i].name, name_len))
 591                   {
 592                     write_attr (&attrs[i], &attr_types, is_opt);
 593                     valid_attr = true;
 594                     break;
 595                   }
 596               }
 597             if (!valid_attr)
 598               {
 599                 char *attr_invalid = xmalloc ((p - s) + 1);
 600                 STACK_VAR (attr_invalid);
 601                 strncpy (attr_invalid, s, p - s);
 602                 attr_invalid[p - s] = '\0';
 603                 vfprintf_fail ("%s attribute '%s' is not valid", desc_type[DESC_TYPE], attr_invalid);
 604                 RELEASE_VAR (attr_invalid); /* never reached */
 605               }
 606           }
 607         if (*p)
 608           p++;
 609       }
 610 }
 611
 612 static void
 613 write_attr (const struct attr *attr_i, unsigned int *attr_types, const bool is_opt)
 614 {
 615     const unsigned int val = attr_i->val;
 616     const enum attr_type attr_type = attr_i->type;
 617     const char *attr_name = attr_i->name;
 618
 619     if (*attr_types & attr_type)
 620       vfprintf_fail ("%s has attribute '%s' twice or more",
 621                      is_opt ? "--attr switch" : "attr conf option", attr_name);
 622     snprintf (attr + strlen (attr), 3, "%u;", val);
 623     *attr_types |= attr_type;
 624 }
 625
 626 static void
 627 process_opt_exclude_random (const char *s, const bool is_opt)
 628 {
 629     bool valid = false;
 630     unsigned int i;
 631     if (exclude)
 632       RELEASE_VAR (exclude);
 633     exclude = xstrdup (s);
 634     STACK_VAR (exclude);
 635     for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */
 636       {
 637         const struct color *entry = &tables[GENERIC].entries[i];
 638         if (streq (exclude, entry->name))
 639           {
 640             valid = true;
 641             break;
 642           }
 643       }
 644     if (!valid)
 645       vfprintf_fail ("%s must be provided a plain color",
 646                      is_opt ? "--exlude-random switch" : "exclude-random conf option");
 647 }
 648
 649 static void
 650 init_opts_vars (void)
 651 {
 652     if (opts_set & OPT_ATTR_SET)
 653       {
 654         attr[0] = '\0'; /* Clear attr string to discard values from the config file.  */
 655         process_opt_attr (opts_arg.attr, true);
 656       }
 657     if (opts_set & OPT_EXCLUDE_RANDOM_SET)
 658       process_opt_exclude_random (opts_arg.exclude_random, true);
 659     if (opts_set & OPT_OMIT_COLOR_EMPTY_SET)
 660       omit_color_empty = true;
 661
 662     free (opts_arg.attr);
 663     free (opts_arg.exclude_random);
 664 }
 665
 666 #define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
 667
 668 static void
 669 parse_conf (const char *conf_file, struct conf *config)
 670 {
 671     unsigned int cnt = 0;
 672     char line[256 + 1];
 673     FILE *conf;
 674
 675     conf = open_file (conf_file, "r");
 676
 677     while (fgets (line, sizeof (line), conf))
 678       {
 679         char *cfg, *val;
 680         char *assign, *comment, *opt, *value;
 681         char *p;
 682
 683         cnt++;
 684         if (strlen (line) > (sizeof (line) - 2))
 685           vfprintf_fail ("%s: line %u exceeds maximum of %u characters", conf_file, cnt, (unsigned int)(sizeof (line) - 2));
 686         if ((p = strrchr (line, '\n')))
 687           *p = '\0';
 688 /* NAME PARSING (start) */
 689         p = line;
 690         /* skip leading spaces and tabs for name */
 691         while (IS_SPACE (*p))
 692           p++;
 693         /* skip line if a) string end, b) comment, [cd]) newline */
 694         if (*p == '\0' || *p == '#' || *p == '\n' || *p == '\r')
 695           continue;
 696         opt = p;
 697         if (!(assign = strchr (opt, '='))) /* check for = */
 698           {
 699             char *space;
 700             if ((space = strchr (opt, ' ')))
 701               *space = '\0';
 702             vfprintf_fail (formats[FMT_CONF], conf_file, opt, "not followed by =");
 703           }
 704         p = assign;
 705         /* skip trailing spaces and tabs for name */
 706         while (IS_SPACE (*(p - 1)))
 707           p--;
 708         *p = '\0';
 709 /* NAME PARSING (end) */
 710 /* NAME VALIDATION (start) */
 711         for (p = opt; *p; p++)
 712           if (!isalnum (*p) && *p != '-')
 713             vfprintf_fail (formats[FMT_CONF], conf_file, opt, "cannot be made of non-option characters");
 714 /* NAME VALIDATION (end) */
 715 /* VALUE PARSING (start) */
 716         p = assign + 1;
 717         /* skip leading spaces and tabs for value */
 718         while (IS_SPACE (*p))
 719           p++;
 720         /* skip line if comment */
 721         if (*p == '#')
 722           continue;
 723         value = p;
 724         if ((comment = strchr (p, '#')))
 725           p = comment;
 726         else
 727           p += strlen (p);
 728         /* skip trailing spaces and tabs for value */
 729         while (IS_SPACE (*(p - 1)))
 730           p--;
 731         *p = '\0';
 732 /* VALUE PARSING (end) */
 733
 734         /* save option name */
 735         cfg = xstrdup (opt);
 736         /* save option value (allow empty ones) */
 737         val = strlen (value) ? xstrdup (value) : NULL;
 738
 739         assign_conf (conf_file, config, cfg, val);
 740         free (cfg);
 741       }
 742
 743     fclose (conf);
 744 }
 745
 746 static void
 747 assign_conf (const char *conf_file, struct conf *config, const char *cfg, char *val)
 748 {
 749     if (streq (cfg, "attr"))
 750       {
 751         free (config->attr);
 752         config->attr = val;
 753       }
 754     else if (streq (cfg, "color"))
 755       {
 756         free (config->color);
 757         config->color = val;
 758       }
 759     else if (streq (cfg, "exclude-random"))
 760       {
 761         free (config->exclude_random);
 762         config->exclude_random = val;
 763       }
 764     else if (streq (cfg, "omit-color-empty"))
 765       {
 766         free (config->omit_color_empty);
 767         config->omit_color_empty = val;
 768       }
 769     else
 770       vfprintf_fail (formats[FMT_CONF], conf_file, cfg, "not recognized");
 771 }
 772
 773 static void
 774 init_conf_vars (const struct conf *config)
 775 {
 776     if (config->attr)
 777       process_opt_attr (config->attr, false);
 778     if (config->exclude_random)
 779       process_opt_exclude_random (config->exclude_random, false);
 780     if (config->omit_color_empty)
 781       {
 782         if (streq (config->omit_color_empty, "yes"))
 783           omit_color_empty = true;
 784         else if (streq (config->omit_color_empty, "no"))
 785           omit_color_empty = false;
 786         else
 787           vfprintf_fail ("omit-color-empty conf option is not valid");
 788       }
 789 }
 790
 791 static void
 792 print_hint (void)
 793 {
 794     fprintf (stderr, "Type `%s --help' for help screen.\n", program_name);
 795 }
 796
 797 static void
 798 print_help (void)
 799 {
 800     struct opt_data {
 801         const char *name;
 802         const char *short_opt;
 803         const char *arg;
 804     };
 805     const struct opt_data opts_data[] = {
 806         { "attr",           NULL, "=ATTR1,ATTR2,..." },
 807         { "config",         "c",  "=PATH"            },
 808         { "exclude-random", NULL, "=COLOR"           },
 809         { "help",           "h",  NULL               },
 810         { "version",        "V",  NULL               },
 811     };
 812     const struct option *opt = long_opts;
 813     unsigned int i;
 814
 815     printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name, COLOR_SEP_CHAR);
 816     printf ("\tColors (foreground) (background)\n");
 817     for (i = 0; i < tables[FOREGROUND].count; i++)
 818       {
 819         const struct color *entry = &tables[FOREGROUND].entries[i];
 820         const char *name = entry->name;
 821         const char *code = entry->code;
 822         if (code)
 823           printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
 824                    code, toupper (*name), *name, name + 1, 10 - (int)strlen (name), " ", name);
 825         else
 826           printf ("\t\t{-} %s%*s%s\n", name, 13 - (int)strlen (name), " ", name);
 827       }
 828     printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
 829
 830     printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
 831     printf ("\twhereas for lower case colors will be of normal intensity.\n");
 832
 833     printf ("\n\tOptions\n");
 834     for (; opt->name; opt++)
 835       {
 836         const struct opt_data *opt_data = NULL;
 837         unsigned int i;
 838         for (i = 0; i < COUNT_OF (opts_data, struct opt_data); i++)
 839           if (streq (opt->name, opts_data[i].name))
 840             {
 841               opt_data = &opts_data[i];
 842               break;
 843             }
 844         if (opt_data)
 845           {
 846             if (opt_data->short_opt)
 847               printf ("\t\t-%s, --%s", opt_data->short_opt, opt->name);
 848             else
 849               printf ("\t\t    --%s", opt->name);
 850             if (opt_data->arg)
 851               printf ("%s", opt_data->arg);
 852             printf ("\n");
 853           }
 854         else
 855           printf ("\t\t    --%s\n", opt->name);
 856       }
 857     printf ("\n");
 858 }
 859
 860 static void
 861 print_version (void)
 862 {
 863 #ifdef HAVE_VERSION
 864 # include "version.h"
 865 #else
 866     const char *const version = NULL;
 867 #endif
 868     const char *version_prefix, *version_string;
 869     const char *c_flags, *ld_flags, *cpp_flags;
 870     const char *const desc_flags_unknown = "unknown";
 871     struct bytes_size bytes_size;
 872     bool debug;
 873 #ifdef CFLAGS
 874     c_flags = to_str (CFLAGS);
 875 #else
 876     c_flags = desc_flags_unknown;
 877 #endif
 878 #ifdef LDFLAGS
 879     ld_flags = to_str (LDFLAGS);
 880 #else
 881     ld_flags = desc_flags_unknown;
 882 #endif
 883 #ifdef CPPFLAGS
 884     cpp_flags = to_str (CPPFLAGS);
 885 #else
 886     cpp_flags = desc_flags_unknown;
 887 #endif
 888 #if DEBUG
 889     debug = true;
 890 #else
 891     debug = false;
 892 #endif
 893     version_prefix = version ? "" : "v";
 894     version_string = version ? version : VERSION;
 895     printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME, version_prefix, version_string, __DATE__, __TIME__);
 896
 897     printf ("Compiler flags: %s\n", c_flags);
 898     printf ("Linker flags: %s\n", ld_flags);
 899     printf ("Preprocessor flags: %s\n", cpp_flags);
 900     if (get_bytes_size (BUF_SIZE, &bytes_size))
 901       {
 902         if (BUF_SIZE % 1024 == 0)
 903           printf ("Buffer size: %u%c\n", bytes_size.size, bytes_size.unit);
 904         else
 905           printf ("Buffer size: %u%c, %u byte%s\n", bytes_size.size, bytes_size.unit,
 906                    BUF_SIZE % 1024, BUF_SIZE % 1024 > 1 ? "s" : "");
 907       }
 908     else
 909       printf ("Buffer size: %lu byte%s\n", (unsigned long)BUF_SIZE, BUF_SIZE > 1 ? "s" : "");
 910     printf ("Color separator: '%c'\n", COLOR_SEP_CHAR);
 911     printf ("Debugging: %s\n", debug ? "yes" : "no");
 912 }
 913
 914 static void
 915 cleanup (void)
 916 {
 917     if (stream && fileno (stream) != STDIN_FILENO)
 918       fclose (stream);
 919 #if DEBUG
 920     if (log)
 921       fclose (log);
 922 #endif
 923
 924     if (vars_list)
 925       {
 926         unsigned int i;
 927         for (i = 0; i < stacked_vars; i++)
 928           free (vars_list[i]);
 929         free_null (vars_list);
 930       }
 931 }
 932
 933 static void
 934 free_color_names (struct color_name **color_names)
 935 {
 936     unsigned int i;
 937     for (i = 0; color_names[i]; i++)
 938       {
 939         RELEASE_VAR (color_names[i]->name);
 940         RELEASE_VAR (color_names[i]->orig);
 941         RELEASE_VAR (color_names[i]);
 942       }
 943 }
 944
 945 static void
 946 free_conf (struct conf *config)
 947 {
 948     free (config->attr);
 949     free (config->color);
 950     free (config->exclude_random);
 951     free (config->omit_color_empty);
 952 }
 953
 954 static void
 955 process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct color **colors, const char **file, FILE **stream, struct conf *config)
 956 {
 957     bool use_conf_color;
 958     int ret;
 959     char *p;
 960     struct stat sb;
 961     struct color_name *color_names[3] = {
 962         NULL, /* foreground */
 963         NULL, /* background */
 964         NULL, /* sentinel value */
 965     };
 966
 967     const char *color_string = arg_cnt >= 1 ? arg_strings[0] : NULL;
 968     const char *file_string  = arg_cnt == 2 ? arg_strings[1] : NULL;
 969
 970     assert (color_string != NULL);
 971
 972     if (streq (color_string, "-"))
 973       {
 974         if (file_string)
 975           vfprintf_fail (formats[FMT_GENERIC], "hyphen cannot be used as color string");
 976         else
 977           vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceded by color string");
 978       }
 979
 980     if ((ret = lstat (color_string, &sb)) == 0) /* exists */
 981       /* Ensure that we don't fail if there's a file with one or more
 982          color names in its path.  */
 983       use_conf_color = skip_path_colors (color_string, file_string, &sb, !!config->color);
 984
 985     /* Use color from config file.  */
 986     if (arg_cnt == 1
 987      && (access (color_string, F_OK) != -1)
 988      && use_conf_color)
 989       {
 990         file_string = color_string;
 991         color_string = config->color;
 992       }
 993
 994     if ((p = strchr (color_string, COLOR_SEP_CHAR)))
 995       {
 996         if (p == color_string)
 997           vfprintf_fail (formats[FMT_STRING], "foreground color missing in string", color_string);
 998         else if (p == color_string + strlen (color_string) - 1)
 999           vfprintf_fail (formats[FMT_STRING], "background color missing in string", color_string);
1000         else if (strchr (++p, COLOR_SEP_CHAR))
1001           vfprintf_fail (formats[FMT_STRING], "one color pair allowed only for string", color_string);
1002       }
1003
1004     gather_color_names (color_string, attr, color_names);
1005
1006     assert (color_names[FOREGROUND] != NULL);
1007
1008     if (color_names[BACKGROUND])
1009       {
1010         unsigned int i;
1011         const unsigned int color_sets[2][2] = { { FOREGROUND, BACKGROUND }, { BACKGROUND, FOREGROUND } };
1012         for (i = 0; i < 2; i++)
1013           {
1014             const unsigned int color1 = color_sets[i][0];
1015             const unsigned int color2 = color_sets[i][1];
1016             if (CHECK_COLORS_RANDOM (color1, color2))
1017               vfprintf_fail (formats[FMT_RANDOM], tables[color1].desc, color_names[color1]->orig, "cannot be combined with", color_names[color2]->orig);
1018           }
1019       }
1020
1021     find_color_entries (color_names, colors);
1022     assert (colors[FOREGROUND] != NULL);
1023     free_color_names (color_names);
1024
1025     if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code)
1026       {
1027         struct color_name color_name;
1028         color_name.name = color_name.orig = "default";
1029
1030         find_color_entry (&color_name, FOREGROUND, colors);
1031         assert (colors[FOREGROUND]->code != NULL);
1032       }
1033
1034     process_file_arg (file_string, file, stream);
1035 }
1036
1037 static void
1038 process_file_arg (const char *file_string, const char **file, FILE **stream)
1039 {
1040     if (file_string)
1041       {
1042         if (streq (file_string, "-"))
1043           *stream = stdin;
1044         else
1045           {
1046             const char *file = file_string;
1047             struct stat sb;
1048             int ret;
1049
1050             errno = 0;
1051             ret = stat (file, &sb);
1052
1053             if (ret == -1)
1054               vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
1055
1056             if (!VALID_FILE_TYPE (sb.st_mode))
1057               vfprintf_fail (formats[FMT_TYPE], file, "unrecognized type", get_file_type (sb.st_mode));
1058
1059             *stream = open_file (file, "r");
1060           }
1061         *file = file_string;
1062       }
1063     else
1064       {
1065         *stream = stdin;
1066         *file = "stdin";
1067       }
1068
1069     assert (*stream != NULL);
1070     assert (*file != NULL);
1071 }
1072
1073 static bool
1074 skip_path_colors (const char *color_string, const char *file_string, const struct stat *sb, const bool has_conf)
1075 {
1076     bool have_file;
1077     unsigned int c;
1078     const char *color = color_string;
1079     const mode_t mode = sb->st_mode;
1080
1081     for (c = 1; c <= 2 && *color; c++)
1082       {
1083         bool matched = false;
1084         unsigned int i;
1085         for (i = 0; i < tables[GENERIC].count; i++)
1086           {
1087             const struct color *entry = &tables[GENERIC].entries[i];
1088             if (has_color_name (color, entry->name))
1089               {
1090                 color += strlen (entry->name);
1091                 matched = true;
1092                 break;
1093               }
1094           }
1095         if (!matched && has_color_name (color, "random"))
1096           {
1097             color += strlen ("random");
1098             matched = true;
1099           }
1100         if (matched && *color == COLOR_SEP_CHAR && *(color + 1))
1101           color++;
1102         else
1103           break;
1104       }
1105
1106     have_file = (*color != '\0');
1107
1108     if (have_file)
1109       {
1110         const char *file_existing = color_string;
1111         if (file_string)
1112           vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "cannot be used as color string");
1113         else
1114           {
1115             if (VALID_FILE_TYPE (mode))
1116               {
1117                 if (has_conf)
1118                   return true;
1119                 vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "must be preceded by color string");
1120               }
1121             else
1122               vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "is not a valid file type");
1123           }
1124       }
1125     return false;
1126 }
1127
1128 static void
1129 gather_color_names (const char *color_string, char *attr, struct color_name **color_names)
1130 {
1131     unsigned int index;
1132     char *color, *p, *str;
1133
1134     str = xstrdup (color_string);
1135     STACK_VAR (str);
1136
1137     for (index = 0, color = str; *color; index++, color = p)
1138       {
1139         char *ch, *sep;
1140
1141         p = NULL;
1142         if ((sep = strchr (color, COLOR_SEP_CHAR)))
1143           {
1144             *sep = '\0';
1145             p = sep + 1;
1146           }
1147         else
1148           p = color + strlen (color);
1149         assert (p != NULL);
1150
1151         for (ch = color; *ch; ch++)
1152           if (!isalpha (*ch))
1153             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be made of non-alphabetic characters");
1154
1155         for (ch = color + 1; *ch; ch++)
1156           if (!islower (*ch))
1157             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be in mixed lower/upper case");
1158
1159         if (streq (color, "None"))
1160           vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be bold");
1161
1162         if (isupper (*color))
1163           {
1164             switch (index)
1165               {
1166                 case FOREGROUND:
1167                   snprintf (attr + strlen (attr), 3, "1;");
1168                   break;
1169                 case BACKGROUND:
1170                   vfprintf_fail (formats[FMT_COLOR], tables[BACKGROUND].desc, color, "cannot be bold");
1171                 default: /* never reached */
1172                   ABORT_TRACE ();
1173               }
1174           }
1175
1176         color_names[index] = xcalloc (1, sizeof (struct color_name));
1177         STACK_VAR (color_names[index]);
1178
1179         color_names[index]->orig = xstrdup (color);
1180         STACK_VAR (color_names[index]->orig);
1181
1182         for (ch = color; *ch; ch++)
1183           *ch = tolower (*ch);
1184
1185         color_names[index]->name = xstrdup (color);
1186         STACK_VAR (color_names[index]->name);
1187       }
1188
1189     RELEASE_VAR (str);
1190 }
1191
1192 static void
1193 read_print_stream (const char *attr, const struct color **colors, const char *file, FILE *stream)
1194 {
1195     char buf[BUF_SIZE + 1];
1196     unsigned int flags = 0;
1197
1198     while (!feof (stream))
1199       {
1200         size_t bytes_read;
1201         char *eol;
1202         const char *line;
1203         bytes_read = fread (buf, 1, BUF_SIZE, stream);
1204         if (bytes_read != BUF_SIZE && ferror (stream))
1205           vfprintf_fail (formats[FMT_ERROR], BUF_SIZE, "read");
1206         buf[bytes_read] = '\0';
1207         line = buf;
1208         while ((eol = strpbrk (line, "\n\r")))
1209           {
1210             const bool has_text = (eol > line);
1211             const char *p;
1212             flags &= ~(CR|LF);
1213             if (*eol == '\r')
1214               {
1215                 flags |= CR;
1216                 if (*(eol + 1) == '\n')
1217                   flags |= LF;
1218               }
1219             else if (*eol == '\n')
1220               flags |= LF;
1221             else /* never reached */
1222               vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending");
1223             p = eol + SKIP_LINE_ENDINGS (flags);
1224             *eol = '\0';
1225             print_line (attr, colors, line, flags,
1226                         omit_color_empty ? has_text : true);
1227             line = p;
1228           }
1229         if (feof (stream))
1230           {
1231             if (*line != '\0')
1232               print_line (attr, colors, line, 0, true);
1233           }
1234         else if (*line != '\0')
1235           {
1236             char *p;
1237             if ((clean || clean_all) && (p = strrchr (line, '\033')))
1238               merge_print_line (line, p, stream);
1239             else
1240               print_line (attr, colors, line, 0, true);
1241           }
1242       }
1243 }
1244
1245 static void
1246 merge_print_line (const char *line, const char *p, FILE *stream)
1247 {
1248     char *buf = NULL;
1249     char *merged_esc = NULL;
1250     const char *esc = "";
1251     const char char_restore = *p;
1252
1253     complete_part_line (p + 1, &buf, stream);
1254
1255     if (buf)
1256       {
1257         /* form escape sequence */
1258         esc = merged_esc = str_concat (p, buf);
1259         /* shorten partial line accordingly */
1260         *(char *)p = '\0';
1261         free (buf);
1262       }
1263
1264 #ifdef TEST_MERGE_PART_LINE
1265     printf ("%s%s", line, esc);
1266     fflush (stdout);
1267     _exit (EXIT_SUCCESS);
1268 #else
1269     print_clean (line);
1270     *(char *)p = char_restore;
1271     print_clean (esc);
1272     free (merged_esc);
1273 #endif
1274 }
1275
1276 static void
1277 complete_part_line (const char *p, char **buf, FILE *stream)
1278 {
1279     bool got_next_char = false, read_from_stream;
1280     char ch;
1281     size_t i = 0, size;
1282
1283     if (get_next_char (&ch, &p, stream, &read_from_stream))
1284       {
1285         if (ch == '[')
1286           {
1287             if (read_from_stream)
1288               save_char (ch, buf, &i, &size);
1289           }
1290         else
1291           {
1292             if (read_from_stream)
1293               ungetc ((int)ch, stream);
1294             return; /* cancel */
1295           }
1296       }
1297     else
1298       return; /* cancel */
1299
1300     while (get_next_char (&ch, &p, stream, &read_from_stream))
1301       {
1302         if (isdigit (ch) || ch == ';')
1303           {
1304             if (read_from_stream)
1305               save_char (ch, buf, &i, &size);
1306           }
1307         else /* got next character */
1308           {
1309             got_next_char = true;
1310             break;
1311           }
1312       }
1313
1314     if (got_next_char)
1315       {
1316         if (ch == 'm')
1317           {
1318             if (read_from_stream)
1319               save_char (ch, buf, &i, &size);
1320           }
1321         else
1322           {
1323             if (read_from_stream)
1324               ungetc ((int)ch, stream);
1325             return; /* cancel */
1326           }
1327       }
1328     else
1329       return; /* cancel */
1330 }
1331
1332 static bool
1333 get_next_char (char *ch, const char **p, FILE *stream, bool *read_from_stream)
1334 {
1335     if (**p == '\0')
1336       {
1337         int c;
1338         if ((c = fgetc (stream)) != EOF)
1339           {
1340             *ch = (char)c;
1341             *read_from_stream = true;
1342             return true;
1343           }
1344         else
1345           {
1346             *read_from_stream = false;
1347             return false;
1348           }
1349       }
1350     else
1351       {
1352         *ch = **p;
1353         (*p)++;
1354         *read_from_stream = false;
1355         return true;
1356       }
1357 }
1358
1359 static void
1360 save_char (char ch, char **buf, size_t *i, size_t *size)
1361 {
1362     if (!*buf)
1363       {
1364         *size = ALLOC_COMPLETE_PART_LINE;
1365         *buf = xmalloc (*size);
1366       }
1367     /* +1: effective occupied size of buffer */
1368     else if ((*i + 1) == *size)
1369       {
1370         *size *= 2;
1371         *buf = xrealloc (*buf, *size);
1372       }
1373     (*buf)[*i] = ch;
1374     (*buf)[*i + 1] = '\0';
1375     (*i)++;
1376 }
1377
1378 static void
1379 find_color_entries (struct color_name **color_names, const struct color **colors)
1380 {
1381     struct timeval tv;
1382     unsigned int index;
1383
1384     /* randomness */
1385     gettimeofday (&tv, NULL);
1386     srand (tv.tv_usec * tv.tv_sec);
1387
1388     for (index = 0; color_names[index]; index++)
1389       {
1390         const char *color_name = color_names[index]->name;
1391
1392         const unsigned int count                = tables[index].count;
1393         const struct color *const color_entries = tables[index].entries;
1394
1395         if (streq (color_name, "random"))
1396           {
1397             bool excludable;
1398             unsigned int i;
1399             do {
1400               excludable = false;
1401               i = rand() % (count - 2) + 1; /* omit color none and default */
1402               switch (index)
1403                 {
1404                   case FOREGROUND:
1405                     /* --exclude-random */
1406                     if (exclude && streq (exclude, color_entries[i].name))
1407                       excludable = true;
1408                     else if (color_names[BACKGROUND] && streq (color_names[BACKGROUND]->name, color_entries[i].name))
1409                       excludable = true;
1410                     break;
1411                   case BACKGROUND:
1412                     if (streq (colors[FOREGROUND]->name, color_entries[i].name))
1413                       excludable = true;
1414                     break;
1415                   default: /* never reached */
1416                     ABORT_TRACE ();
1417                  }
1418             } while (excludable);
1419             colors[index] = (struct color *)&color_entries[i];
1420           }
1421         else
1422           find_color_entry (color_names[index], index, colors);
1423       }
1424 }
1425
1426 static void
1427 find_color_entry (const struct color_name *color_name, unsigned int index, const struct color **colors)
1428 {
1429     bool found = false;
1430     unsigned int i;
1431
1432     const unsigned int count                = tables[index].count;
1433     const struct color *const color_entries = tables[index].entries;
1434
1435     for (i = 0; i < count; i++)
1436       if (streq (color_name->name, color_entries[i].name))
1437         {
1438           colors[index] = (struct color *)&color_entries[i];
1439           found = true;
1440           break;
1441         }
1442     if (!found)
1443       vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color_name->orig, "not recognized");
1444 }
1445
1446 static void
1447 print_line (const char *attr, const struct color **colors, const char *const line, unsigned int flags, bool emit_colors)
1448 {
1449     /* --clean[-all] */
1450     if (clean || clean_all)
1451       print_clean (line);
1452     /* skip for --omit-color-empty? */
1453     else if (emit_colors)
1454       {
1455         /* Foreground color code is guaranteed to be set when background color code is present.  */
1456         if (colors[BACKGROUND] && colors[BACKGROUND]->code)
1457           printf ("\033[%s", colors[BACKGROUND]->code);
1458         if (colors[FOREGROUND]->code)
1459           printf ("\033[%s%s%s\033[0m", attr, colors[FOREGROUND]->code, line);
1460         else
1461           printf (formats[FMT_GENERIC], line);
1462       }
1463     if (flags & CR)
1464       putchar ('\r');
1465     if (flags & LF)
1466       putchar ('\n');
1467 }
1468
1469 static void
1470 print_clean (const char *line)
1471 {
1472     const char *p = line;
1473
1474     if (is_esc (p))
1475       p = get_end_of_esc (p);
1476
1477     while (*p != '\0')
1478       {
1479         const char *text_start = p;
1480         const char *text_end = get_end_of_text (p);
1481         print_text (text_start, text_end - text_start);
1482         p = get_end_of_esc (text_end);
1483       }
1484 }
1485
1486 static bool
1487 is_esc (const char *p)
1488 {
1489     return gather_esc_offsets (p, NULL, NULL);
1490 }
1491
1492 static const char *
1493 get_end_of_esc (const char *p)
1494 {
1495     const char *esc;
1496     const char *end = NULL;
1497     while ((esc = strchr (p, '\033')))
1498       {
1499         if (gather_esc_offsets (esc, NULL, &end))
1500           break;
1501         p = esc + 1;
1502       }
1503     return end ? end + 1 : p + strlen (p);
1504 }
1505
1506 static const char *
1507 get_end_of_text (const char *p)
1508 {
1509     const char *esc;
1510     const char *start = NULL;
1511     while ((esc = strchr (p, '\033')))
1512       {
1513         if (gather_esc_offsets (esc, &start, NULL))
1514           break;
1515         p = esc + 1;
1516       }
1517     return start ? start : p + strlen (p);
1518 }
1519
1520 static void
1521 print_text (const char *p, size_t len)
1522 {
1523     size_t bytes_written;
1524     bytes_written = fwrite (p, 1, len, stdout);
1525     if (bytes_written != len)
1526       vfprintf_fail (formats[FMT_ERROR], (unsigned long)len, "written");
1527 }
1528
1529 static bool
1530 gather_esc_offsets (const char *p, const char **start, const char **end)
1531 {
1532     /* ESC[ */
1533     if (*p == 27 && *(p + 1) == '[')
1534       {
1535         bool valid = false;
1536         const char *const begin = p;
1537         p += 2;
1538         if (clean_all)
1539           valid = validate_esc_clean_all (&p);
1540         else if (clean)
1541           {
1542             bool check_values;
1543             unsigned int prev_iter, iter;
1544             const char *digit;
1545             prev_iter = iter = 0;
1546             do {
1547               check_values = false;
1548               iter++;
1549               if (!isdigit (*p))
1550                 break;
1551               digit = p;
1552               while (isdigit (*p))
1553                 p++;
1554               if (p - digit > 2)
1555                 break;
1556               else /* check range */
1557                 {
1558                   char val[3];
1559                   int value;
1560                   unsigned int i;
1561                   const unsigned int digits = p - digit;
1562                   for (i = 0; i < digits; i++)
1563                     val[i] = *digit++;
1564                   val[i] = '\0';
1565                   value = atoi (val);
1566                   valid = validate_esc_clean (value, iter, &prev_iter, &p, &check_values);
1567                 }
1568             } while (check_values);
1569           }
1570         if (valid)
1571           {
1572             if (start)
1573               *start = begin;
1574             if (end)
1575               *end = p;
1576             return true;
1577           }
1578       }
1579     return false;
1580 }
1581
1582 static bool
1583 validate_esc_clean_all (const char **p)
1584 {
1585     while (isdigit (**p) || **p == ';')
1586       (*p)++;
1587     return (**p == 'm');
1588 }
1589
1590 static bool
1591 validate_esc_clean (int value, unsigned int iter, unsigned int *prev_iter, const char **p, bool *check_values)
1592 {
1593     if (is_reset (value, iter, p))
1594       return true;
1595     else if (is_attr (value, iter, *prev_iter, p))
1596       {
1597         (*p)++;
1598         *check_values = true;
1599         *prev_iter = iter;
1600         return false; /* partial escape sequence, need another valid value */
1601       }
1602     else if (is_fg_color (value, p))
1603       return true;
1604     else if (is_bg_color (value, iter, p))
1605       return true;
1606     else
1607       return false;
1608 }
1609
1610 static bool
1611 is_reset (int value, unsigned int iter, const char **p)
1612 {
1613     return (value == 0 && iter == 1 && **p == 'm');
1614 }
1615
1616 static bool
1617 is_attr (int value, unsigned int iter, unsigned int prev_iter, const char **p)
1618 {
1619     return ((value > 0 && value < 10) && (iter - prev_iter == 1) && **p == ';');
1620 }
1621
1622 static bool
1623 is_fg_color (int value, const char **p)
1624 {
1625     return (((value >= 30 && value <= 37) || value == 39) && **p == 'm');
1626 }
1627
1628 static bool
1629 is_bg_color (int value, unsigned int iter, const char **p)
1630 {
1631     return (((value >= 40 && value <= 47) || value == 49) && iter == 1 && **p == 'm');
1632 }
1633
1634 #if !DEBUG
1635 static void *
1636 malloc_wrap (size_t size)
1637 {
1638     void *p = malloc (size);
1639     if (!p)
1640       MEM_ALLOC_FAIL ();
1641     return p;
1642 }
1643
1644 static void *
1645 calloc_wrap (size_t nmemb, size_t size)
1646 {
1647     void *p = calloc (nmemb, size);
1648     if (!p)
1649       MEM_ALLOC_FAIL ();
1650     return p;
1651 }
1652
1653 static void *
1654 realloc_wrap (void *ptr, size_t size)
1655 {
1656     void *p = realloc (ptr, size);
1657     if (!p)
1658       MEM_ALLOC_FAIL ();
1659     return p;
1660 }
1661 #else
1662 static const char *const format_debug = "%s: %10s %7lu bytes [source file %s, line %5u]\n";
1663 static void *
1664 malloc_wrap_debug (size_t size, const char *file, unsigned int line)
1665 {
1666     void *p = malloc (size);
1667     if (!p)
1668       MEM_ALLOC_FAIL_DEBUG (file, line);
1669     fprintf (log, format_debug, program_name, "malloc'ed", (unsigned long)size, file, line);
1670     return p;
1671 }
1672
1673 static void *
1674 calloc_wrap_debug (size_t nmemb, size_t size, const char *file, unsigned int line)
1675 {
1676     void *p = calloc (nmemb, size);
1677     if (!p)
1678       MEM_ALLOC_FAIL_DEBUG (file, line);
1679     fprintf (log, format_debug, program_name, "calloc'ed", (unsigned long)(nmemb * size), file, line);
1680     return p;
1681 }
1682
1683 static void *
1684 realloc_wrap_debug (void *ptr, size_t size, const char *file, unsigned int line)
1685 {
1686     void *p = realloc (ptr, size);
1687     if (!p)
1688       MEM_ALLOC_FAIL_DEBUG (file, line);
1689     fprintf (log, format_debug, program_name, "realloc'ed", (unsigned long)size, file, line);
1690     return p;
1691 }
1692 #endif /* !DEBUG */
1693
1694 static void
1695 free_wrap (void **ptr)
1696 {
1697     free (*ptr);
1698     *ptr = NULL;
1699 }
1700
1701 #if !DEBUG
1702 # define do_malloc(len, file, line) malloc_wrap(len)
1703 #else
1704 # define do_malloc(len, file, line) malloc_wrap_debug(len, file, line)
1705 #endif
1706
1707 static char *
1708 strdup_wrap (const char *str, const char *file, unsigned int line)
1709 {
1710     const size_t len = strlen (str) + 1;
1711     char *p = do_malloc (len, file, line);
1712     strncpy (p, str, len);
1713     return p;
1714 }
1715
1716 static char *
1717 str_concat_wrap (const char *str1, const char *str2, const char *file, unsigned int line)
1718 {
1719     const size_t len = strlen (str1) + strlen (str2) + 1;
1720     char *p, *str;
1721
1722     p = str = do_malloc (len, file, line);
1723     strncpy (p, str1, strlen (str1));
1724     p += strlen (str1);
1725     strncpy (p, str2, strlen (str2));
1726     p += strlen (str2);
1727     *p = '\0';
1728
1729     return str;
1730 }
1731
1732 static char *
1733 expand_string (const char *str)
1734 {
1735     char *s = NULL;
1736     wordexp_t p;
1737
1738     wordexp (str, &p, 0);
1739     if (p.we_wordc >= 1)
1740       s = xstrdup (p.we_wordv[0]);
1741     wordfree (&p);
1742
1743     return s;
1744 }
1745
1746 static bool
1747 get_bytes_size (unsigned long bytes, struct bytes_size *bytes_size)
1748 {
1749     const char *unit, units[] = { '0', 'K', 'M', 'G', '\0' };
1750     unsigned long size = bytes;
1751     if (bytes < 1024)
1752       return false;
1753     unit = units;
1754     while (size >= 1024 && *(unit + 1))
1755       {
1756         size /= 1024;
1757         unit++;
1758       }
1759     bytes_size->size = (unsigned int)size;
1760     bytes_size->unit = *unit;
1761     return true;
1762 }
1763
1764 static char *
1765 get_file_type (mode_t mode)
1766 {
1767     if (S_ISREG (mode))
1768       return "file";
1769     else if (S_ISDIR (mode))
1770       return "directory";
1771     else if (S_ISCHR (mode))
1772       return "character device";
1773     else if (S_ISBLK (mode))
1774       return "block device";
1775     else if (S_ISFIFO (mode))
1776       return "named pipe";
1777     else if (S_ISLNK (mode))
1778       return "symbolic link";
1779     else if (S_ISSOCK (mode))
1780       return "socket";
1781     else
1782       return "file";
1783 }
1784
1785 static bool
1786 has_color_name (const char *str, const char *name)
1787 {
1788     char *p;
1789
1790     assert (strlen (str) > 0);
1791     assert (strlen (name) > 0);
1792
1793     if (!(*str == *name || *str == toupper (*name)))
1794       return false;
1795     else if (*(name + 1) != '\0'
1796      && !((p = strstr (str + 1, name + 1)) && p == str + 1))
1797       return false;
1798     else
1799       return true;
1800 }
1801
1802 static FILE *
1803 open_file (const char *file, const char *mode)
1804 {
1805     FILE *stream;
1806
1807     errno = 0;
1808     stream = fopen (file, mode);
1809     if (!stream)
1810       vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
1811
1812     return stream;
1813 }
1814
1815 #define DO_VFPRINTF(fmt)                    \
1816     va_list ap;                             \
1817     fprintf (stderr, "%s: ", program_name); \
1818     va_start (ap, fmt);                     \
1819     vfprintf (stderr, fmt, ap);             \
1820     va_end (ap);                            \
1821     fprintf (stderr, "\n");
1822
1823 static void
1824 vfprintf_diag (const char *fmt, ...)
1825 {
1826     DO_VFPRINTF (fmt);
1827 }
1828
1829 static void
1830 vfprintf_fail (const char *fmt, ...)
1831 {
1832     DO_VFPRINTF (fmt);
1833     exit (EXIT_FAILURE);
1834 }
1835
1836 static void
1837 stack_var (void ***list, unsigned int *stacked, unsigned int index, void *ptr)
1838 {
1839     /* nothing to stack */
1840     if (ptr == NULL)
1841       return;
1842     if (!*list)
1843       *list = xmalloc (sizeof (void *));
1844     else
1845       {
1846         unsigned int i;
1847         for (i = 0; i < *stacked; i++)
1848           if (!(*list)[i])
1849             {
1850               (*list)[i] = ptr;
1851               return; /* reused */
1852             }
1853         *list = xrealloc (*list, (*stacked + 1) * sizeof (void *));
1854       }
1855     (*list)[index] = ptr;
1856     (*stacked)++;
1857 }
1858
1859 static void
1860 release_var (void **list, unsigned int stacked, void **ptr)
1861 {
1862     unsigned int i;
1863     /* nothing to release */
1864     if (*ptr == NULL)
1865       return;
1866     for (i = 0; i < stacked; i++)
1867       if (list[i] == *ptr)
1868         {
1869           free (*ptr);
1870           *ptr = NULL;
1871           list[i] = NULL;
1872           return;
1873         }
1874 }