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 PRINT_HELP_EXIT() \
 492     print_help ();        \
 493     exit (EXIT_SUCCESS);
 494
 495 #define PRINT_VERSION_EXIT() \
 496     print_version ();        \
 497     exit (EXIT_SUCCESS);
 498
 499 extern char *optarg;
 500
 501 static void
 502 process_opts (int argc, char **argv, char **conf_file)
 503 {
 504     int opt;
 505     while ((opt = getopt_long (argc, argv, "hV", long_opts, NULL)) != -1)
 506       {
 507         switch (opt)
 508           {
 509             case 0: /* long opts */
 510               switch (opt_type)
 511                 {
 512                   case OPT_ATTR:
 513                     opts_set |= OPT_ATTR_SET;
 514                     opts_arg.attr = xstrdup (optarg);
 515                     break;
 516                   case OPT_CLEAN:
 517                     clean = true;
 518                     break;
 519                   case OPT_CLEAN_ALL:
 520                     clean_all = true;
 521                     break;
 522                   case OPT_CONFIG:
 523                     *conf_file = xstrdup (optarg);
 524                     break;
 525                   case OPT_EXCLUDE_RANDOM:
 526                     opts_set |= OPT_EXCLUDE_RANDOM_SET;
 527                     opts_arg.exclude_random = xstrdup (optarg);
 528                     break;
 529                   case OPT_OMIT_COLOR_EMPTY:
 530                     opts_set |= OPT_OMIT_COLOR_EMPTY_SET;
 531                     break;
 532                   case OPT_HELP:
 533                     PRINT_HELP_EXIT ();
 534                   case OPT_VERSION:
 535                     PRINT_VERSION_EXIT ();
 536                   default: /* never reached */
 537                     ABORT_TRACE ();
 538                 }
 539               break;
 540             case 'h':
 541               PRINT_HELP_EXIT ();
 542             case 'V':
 543               PRINT_VERSION_EXIT ();
 544             case '?':
 545               print_hint ();
 546               exit (EXIT_FAILURE);
 547             default: /* never reached */
 548               ABORT_TRACE ();
 549           }
 550       }
 551 }
 552
 553 static void
 554 process_opt_attr (const char *p, const bool is_opt)
 555 {
 556     /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS!  */
 557     const struct attr attrs[] = {
 558         { "bold",       1, ATTR_BOLD       },
 559         { "underscore", 4, ATTR_UNDERSCORE },
 560         { "blink",      5, ATTR_BLINK      },
 561         { "reverse",    7, ATTR_REVERSE    },
 562         { "concealed",  8, ATTR_CONCEALED  },
 563     };
 564     unsigned int attr_types = 0;
 565     const char *desc_type[2] = { "--attr switch", "attr conf option" };
 566     const unsigned int DESC_TYPE = is_opt ? DESC_OPTION : DESC_CONF;
 567
 568     while (*p)
 569       {
 570         const char *s;
 571         if (!isalnum (*p))
 572           vfprintf_fail ("%s must be provided a string", desc_type[DESC_TYPE]);
 573         s = p;
 574         while (isalnum (*p))
 575           p++;
 576         if (*p != '\0' && *p != ',')
 577           vfprintf_fail ("%s must have strings separated by ,", desc_type[DESC_TYPE]);
 578         else
 579           {
 580             bool valid_attr = false;
 581             unsigned int i;
 582             for (i = 0; i < COUNT_OF (attrs, struct attr); i++)
 583               {
 584                 const size_t name_len = strlen (attrs[i].name);
 585                 if ((size_t)(p - s) == name_len && strneq (s, attrs[i].name, name_len))
 586                   {
 587                     write_attr (&attrs[i], &attr_types, is_opt);
 588                     valid_attr = true;
 589                     break;
 590                   }
 591               }
 592             if (!valid_attr)
 593               {
 594                 char *attr_invalid = xmalloc ((p - s) + 1);
 595                 STACK_VAR (attr_invalid);
 596                 strncpy (attr_invalid, s, p - s);
 597                 attr_invalid[p - s] = '\0';
 598                 vfprintf_fail ("%s attribute '%s' is not valid", desc_type[DESC_TYPE], attr_invalid);
 599                 RELEASE_VAR (attr_invalid); /* never reached */
 600               }
 601           }
 602         if (*p)
 603           p++;
 604       }
 605 }
 606
 607 static void
 608 write_attr (const struct attr *attr_i, unsigned int *attr_types, const bool is_opt)
 609 {
 610     const unsigned int val = attr_i->val;
 611     const enum attr_type attr_type = attr_i->type;
 612     const char *attr_name = attr_i->name;
 613
 614     if (*attr_types & attr_type)
 615       vfprintf_fail ("%s has attribute '%s' twice or more",
 616                      is_opt ? "--attr switch" : "attr conf option", attr_name);
 617     snprintf (attr + strlen (attr), 3, "%u;", val);
 618     *attr_types |= attr_type;
 619 }
 620
 621 static void
 622 process_opt_exclude_random (const char *s, const bool is_opt)
 623 {
 624     bool valid = false;
 625     unsigned int i;
 626     if (exclude)
 627       RELEASE_VAR (exclude);
 628     exclude = xstrdup (s);
 629     STACK_VAR (exclude);
 630     for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */
 631       {
 632         const struct color *entry = &tables[GENERIC].entries[i];
 633         if (streq (exclude, entry->name))
 634           {
 635             valid = true;
 636             break;
 637           }
 638       }
 639     if (!valid)
 640       vfprintf_fail ("%s must be provided a plain color",
 641                      is_opt ? "--exlude-random switch" : "exclude-random conf option");
 642 }
 643
 644 static void
 645 init_opts_vars (void)
 646 {
 647     if (opts_set & OPT_ATTR_SET)
 648       {
 649         attr[0] = '\0'; /* Clear attr string to discard values from the config file.  */
 650         process_opt_attr (opts_arg.attr, true);
 651       }
 652     if (opts_set & OPT_EXCLUDE_RANDOM_SET)
 653       process_opt_exclude_random (opts_arg.exclude_random, true);
 654     if (opts_set & OPT_OMIT_COLOR_EMPTY_SET)
 655       omit_color_empty = true;
 656
 657     free (opts_arg.attr);
 658     free (opts_arg.exclude_random);
 659 }
 660
 661 #define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
 662
 663 static void
 664 parse_conf (const char *conf_file, struct conf *config)
 665 {
 666     unsigned int cnt = 0;
 667     char line[256 + 1];
 668     FILE *conf;
 669
 670     conf = open_file (conf_file, "r");
 671
 672     while (fgets (line, sizeof (line), conf))
 673       {
 674         char *cfg, *val;
 675         char *assign, *comment, *opt, *value;
 676         char *p;
 677
 678         cnt++;
 679         if (strlen (line) > (sizeof (line) - 2))
 680           vfprintf_fail ("%s: line %u exceeds maximum of %u characters", conf_file, cnt, (unsigned int)(sizeof (line) - 2));
 681         if ((p = strrchr (line, '\n')))
 682           *p = '\0';
 683 /* NAME PARSING (start) */
 684         p = line;
 685         /* skip leading spaces and tabs for name */
 686         while (IS_SPACE (*p))
 687           p++;
 688         /* skip line if a) string end, b) comment, [cd]) newline */
 689         if (*p == '\0' || *p == '#' || *p == '\n' || *p == '\r')
 690           continue;
 691         opt = p;
 692         if (!(assign = strchr (opt, '='))) /* check for = */
 693           {
 694             char *space;
 695             if ((space = strchr (opt, ' ')))
 696               *space = '\0';
 697             vfprintf_fail (formats[FMT_CONF], conf_file, opt, "not followed by =");
 698           }
 699         p = assign;
 700         /* skip trailing spaces and tabs for name */
 701         while (IS_SPACE (*(p - 1)))
 702           p--;
 703         *p = '\0';
 704 /* NAME PARSING (end) */
 705 /* NAME VALIDATION (start) */
 706         for (p = opt; *p; p++)
 707           if (!isalnum (*p) && *p != '-')
 708             vfprintf_fail (formats[FMT_CONF], conf_file, opt, "cannot be made of non-option characters");
 709 /* NAME VALIDATION (end) */
 710 /* VALUE PARSING (start) */
 711         p = assign + 1;
 712         /* skip leading spaces and tabs for value */
 713         while (IS_SPACE (*p))
 714           p++;
 715         /* skip line if comment */
 716         if (*p == '#')
 717           continue;
 718         value = p;
 719         if ((comment = strchr (p, '#')))
 720           p = comment;
 721         else
 722           p += strlen (p);
 723         /* skip trailing spaces and tabs for value */
 724         while (IS_SPACE (*(p - 1)))
 725           p--;
 726         *p = '\0';
 727 /* VALUE PARSING (end) */
 728
 729         /* save option name */
 730         cfg = xstrdup (opt);
 731         /* save option value (allow empty ones) */
 732         val = strlen (value) ? xstrdup (value) : NULL;
 733
 734         assign_conf (conf_file, config, cfg, val);
 735         free (cfg);
 736       }
 737
 738     fclose (conf);
 739 }
 740
 741 static void
 742 assign_conf (const char *conf_file, struct conf *config, const char *cfg, char *val)
 743 {
 744     if (streq (cfg, "attr"))
 745       {
 746         free (config->attr);
 747         config->attr = val;
 748       }
 749     else if (streq (cfg, "color"))
 750       {
 751         free (config->color);
 752         config->color = val;
 753       }
 754     else if (streq (cfg, "exclude-random"))
 755       {
 756         free (config->exclude_random);
 757         config->exclude_random = val;
 758       }
 759     else if (streq (cfg, "omit-color-empty"))
 760       {
 761         free (config->omit_color_empty);
 762         config->omit_color_empty = val;
 763       }
 764     else
 765       vfprintf_fail (formats[FMT_CONF], conf_file, cfg, "not recognized");
 766 }
 767
 768 static void
 769 init_conf_vars (const struct conf *config)
 770 {
 771     if (config->attr)
 772       process_opt_attr (config->attr, false);
 773     if (config->exclude_random)
 774       process_opt_exclude_random (config->exclude_random, false);
 775     if (config->omit_color_empty)
 776       {
 777         if (streq (config->omit_color_empty, "yes"))
 778           omit_color_empty = true;
 779         else if (streq (config->omit_color_empty, "no"))
 780           omit_color_empty = false;
 781         else
 782           vfprintf_fail ("omit-color-empty conf option is not valid");
 783       }
 784 }
 785
 786 static void
 787 print_hint (void)
 788 {
 789     fprintf (stderr, "Type `%s --help' for help screen.\n", program_name);
 790 }
 791
 792 static void
 793 print_help (void)
 794 {
 795     struct opt_data {
 796         const char *name;
 797         const char *short_opt;
 798         const char *arg;
 799     };
 800     const struct opt_data opts_data[] = {
 801         { "attr",           NULL, "=ATTR1,ATTR2,..." },
 802         { "config",         NULL, "=PATH"            },
 803         { "exclude-random", NULL, "=COLOR"           },
 804         { "help",           "h",  NULL               },
 805         { "version",        "V",  NULL               },
 806     };
 807     const struct option *opt = long_opts;
 808     unsigned int i;
 809
 810     printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name, COLOR_SEP_CHAR);
 811     printf ("\tColors (foreground) (background)\n");
 812     for (i = 0; i < tables[FOREGROUND].count; i++)
 813       {
 814         const struct color *entry = &tables[FOREGROUND].entries[i];
 815         const char *name = entry->name;
 816         const char *code = entry->code;
 817         if (code)
 818           printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
 819                    code, toupper (*name), *name, name + 1, 10 - (int)strlen (name), " ", name);
 820         else
 821           printf ("\t\t{-} %s%*s%s\n", name, 13 - (int)strlen (name), " ", name);
 822       }
 823     printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
 824
 825     printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
 826     printf ("\twhereas for lower case colors will be of normal intensity.\n");
 827
 828     printf ("\n\tOptions\n");
 829     for (; opt->name; opt++)
 830       {
 831         const struct opt_data *opt_data = NULL;
 832         unsigned int i;
 833         for (i = 0; i < COUNT_OF (opts_data, struct opt_data); i++)
 834           if (streq (opt->name, opts_data[i].name))
 835             {
 836               opt_data = &opts_data[i];
 837               break;
 838             }
 839         if (opt_data)
 840           {
 841             if (opt_data->short_opt)
 842               printf ("\t\t-%s, --%s\n", opt_data->short_opt, opt->name);
 843             else
 844               printf ("\t\t    --%s%s\n", opt->name, opt_data->arg);
 845           }
 846         else
 847           printf ("\t\t    --%s\n", opt->name);
 848       }
 849     printf ("\n");
 850 }
 851
 852 static void
 853 print_version (void)
 854 {
 855 #ifdef HAVE_VERSION
 856 # include "version.h"
 857 #else
 858     const char *const version = NULL;
 859 #endif
 860     const char *version_prefix, *version_string;
 861     const char *c_flags, *ld_flags, *cpp_flags;
 862     const char *const desc_flags_unknown = "unknown";
 863     struct bytes_size bytes_size;
 864     bool debug;
 865 #ifdef CFLAGS
 866     c_flags = to_str (CFLAGS);
 867 #else
 868     c_flags = desc_flags_unknown;
 869 #endif
 870 #ifdef LDFLAGS
 871     ld_flags = to_str (LDFLAGS);
 872 #else
 873     ld_flags = desc_flags_unknown;
 874 #endif
 875 #ifdef CPPFLAGS
 876     cpp_flags = to_str (CPPFLAGS);
 877 #else
 878     cpp_flags = desc_flags_unknown;
 879 #endif
 880 #if DEBUG
 881     debug = true;
 882 #else
 883     debug = false;
 884 #endif
 885     version_prefix = version ? "" : "v";
 886     version_string = version ? version : VERSION;
 887     printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME, version_prefix, version_string, __DATE__, __TIME__);
 888
 889     printf ("Compiler flags: %s\n", c_flags);
 890     printf ("Linker flags: %s\n", ld_flags);
 891     printf ("Preprocessor flags: %s\n", cpp_flags);
 892     if (get_bytes_size (BUF_SIZE, &bytes_size))
 893       {
 894         if (BUF_SIZE % 1024 == 0)
 895           printf ("Buffer size: %u%c\n", bytes_size.size, bytes_size.unit);
 896         else
 897           printf ("Buffer size: %u%c, %u byte%s\n", bytes_size.size, bytes_size.unit,
 898                    BUF_SIZE % 1024, BUF_SIZE % 1024 > 1 ? "s" : "");
 899       }
 900     else
 901       printf ("Buffer size: %lu byte%s\n", (unsigned long)BUF_SIZE, BUF_SIZE > 1 ? "s" : "");
 902     printf ("Color separator: '%c'\n", COLOR_SEP_CHAR);
 903     printf ("Debugging: %s\n", debug ? "yes" : "no");
 904 }
 905
 906 static void
 907 cleanup (void)
 908 {
 909     if (stream && fileno (stream) != STDIN_FILENO)
 910       fclose (stream);
 911 #if DEBUG
 912     if (log)
 913       fclose (log);
 914 #endif
 915
 916     if (vars_list)
 917       {
 918         unsigned int i;
 919         for (i = 0; i < stacked_vars; i++)
 920           free (vars_list[i]);
 921         free_null (vars_list);
 922       }
 923 }
 924
 925 static void
 926 free_color_names (struct color_name **color_names)
 927 {
 928     unsigned int i;
 929     for (i = 0; color_names[i]; i++)
 930       {
 931         RELEASE_VAR (color_names[i]->name);
 932         RELEASE_VAR (color_names[i]->orig);
 933         RELEASE_VAR (color_names[i]);
 934       }
 935 }
 936
 937 static void
 938 free_conf (struct conf *config)
 939 {
 940     free (config->attr);
 941     free (config->color);
 942     free (config->exclude_random);
 943     free (config->omit_color_empty);
 944 }
 945
 946 static void
 947 process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct color **colors, const char **file, FILE **stream, struct conf *config)
 948 {
 949     bool use_conf_color;
 950     int ret;
 951     char *p;
 952     struct stat sb;
 953     struct color_name *color_names[3] = {
 954         NULL, /* foreground */
 955         NULL, /* background */
 956         NULL, /* sentinel value */
 957     };
 958
 959     const char *color_string = arg_cnt >= 1 ? arg_strings[0] : NULL;
 960     const char *file_string  = arg_cnt == 2 ? arg_strings[1] : NULL;
 961
 962     assert (color_string != NULL);
 963
 964     if (streq (color_string, "-"))
 965       {
 966         if (file_string)
 967           vfprintf_fail (formats[FMT_GENERIC], "hyphen cannot be used as color string");
 968         else
 969           vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceded by color string");
 970       }
 971
 972     if ((ret = lstat (color_string, &sb)) == 0) /* exists */
 973       /* Ensure that we don't fail if there's a file with one or more
 974          color names in its path.  */
 975       use_conf_color = skip_path_colors (color_string, file_string, &sb, !!config->color);
 976
 977     /* Use color from config file.  */
 978     if (arg_cnt == 1
 979      && (access (color_string, F_OK) != -1)
 980      && use_conf_color)
 981       {
 982         file_string = color_string;
 983         color_string = config->color;
 984       }
 985
 986     if ((p = strchr (color_string, COLOR_SEP_CHAR)))
 987       {
 988         if (p == color_string)
 989           vfprintf_fail (formats[FMT_STRING], "foreground color missing in string", color_string);
 990         else if (p == color_string + strlen (color_string) - 1)
 991           vfprintf_fail (formats[FMT_STRING], "background color missing in string", color_string);
 992         else if (strchr (++p, COLOR_SEP_CHAR))
 993           vfprintf_fail (formats[FMT_STRING], "one color pair allowed only for string", color_string);
 994       }
 995
 996     gather_color_names (color_string, attr, color_names);
 997
 998     assert (color_names[FOREGROUND] != NULL);
 999
1000     if (color_names[BACKGROUND])
1001       {
1002         unsigned int i;
1003         const unsigned int color_sets[2][2] = { { FOREGROUND, BACKGROUND }, { BACKGROUND, FOREGROUND } };
1004         for (i = 0; i < 2; i++)
1005           {
1006             const unsigned int color1 = color_sets[i][0];
1007             const unsigned int color2 = color_sets[i][1];
1008             if (CHECK_COLORS_RANDOM (color1, color2))
1009               vfprintf_fail (formats[FMT_RANDOM], tables[color1].desc, color_names[color1]->orig, "cannot be combined with", color_names[color2]->orig);
1010           }
1011       }
1012
1013     find_color_entries (color_names, colors);
1014     assert (colors[FOREGROUND] != NULL);
1015     free_color_names (color_names);
1016
1017     if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code)
1018       {
1019         struct color_name color_name;
1020         color_name.name = color_name.orig = "default";
1021
1022         find_color_entry (&color_name, FOREGROUND, colors);
1023         assert (colors[FOREGROUND]->code != NULL);
1024       }
1025
1026     process_file_arg (file_string, file, stream);
1027 }
1028
1029 static void
1030 process_file_arg (const char *file_string, const char **file, FILE **stream)
1031 {
1032     if (file_string)
1033       {
1034         if (streq (file_string, "-"))
1035           *stream = stdin;
1036         else
1037           {
1038             const char *file = file_string;
1039             struct stat sb;
1040             int ret;
1041
1042             errno = 0;
1043             ret = stat (file, &sb);
1044
1045             if (ret == -1)
1046               vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
1047
1048             if (!VALID_FILE_TYPE (sb.st_mode))
1049               vfprintf_fail (formats[FMT_TYPE], file, "unrecognized type", get_file_type (sb.st_mode));
1050
1051             *stream = open_file (file, "r");
1052           }
1053         *file = file_string;
1054       }
1055     else
1056       {
1057         *stream = stdin;
1058         *file = "stdin";
1059       }
1060
1061     assert (*stream != NULL);
1062     assert (*file != NULL);
1063 }
1064
1065 static bool
1066 skip_path_colors (const char *color_string, const char *file_string, const struct stat *sb, const bool has_conf)
1067 {
1068     bool have_file;
1069     unsigned int c;
1070     const char *color = color_string;
1071     const mode_t mode = sb->st_mode;
1072
1073     for (c = 1; c <= 2 && *color; c++)
1074       {
1075         bool matched = false;
1076         unsigned int i;
1077         for (i = 0; i < tables[GENERIC].count; i++)
1078           {
1079             const struct color *entry = &tables[GENERIC].entries[i];
1080             if (has_color_name (color, entry->name))
1081               {
1082                 color += strlen (entry->name);
1083                 matched = true;
1084                 break;
1085               }
1086           }
1087         if (!matched && has_color_name (color, "random"))
1088           {
1089             color += strlen ("random");
1090             matched = true;
1091           }
1092         if (matched && *color == COLOR_SEP_CHAR && *(color + 1))
1093           color++;
1094         else
1095           break;
1096       }
1097
1098     have_file = (*color != '\0');
1099
1100     if (have_file)
1101       {
1102         const char *file_existing = color_string;
1103         if (file_string)
1104           vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "cannot be used as color string");
1105         else
1106           {
1107             if (VALID_FILE_TYPE (mode))
1108               {
1109                 if (has_conf)
1110                   return true;
1111                 vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "must be preceded by color string");
1112               }
1113             else
1114               vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "is not a valid file type");
1115           }
1116       }
1117     return false;
1118 }
1119
1120 static void
1121 gather_color_names (const char *color_string, char *attr, struct color_name **color_names)
1122 {
1123     unsigned int index;
1124     char *color, *p, *str;
1125
1126     str = xstrdup (color_string);
1127     STACK_VAR (str);
1128
1129     for (index = 0, color = str; *color; index++, color = p)
1130       {
1131         char *ch, *sep;
1132
1133         p = NULL;
1134         if ((sep = strchr (color, COLOR_SEP_CHAR)))
1135           {
1136             *sep = '\0';
1137             p = sep + 1;
1138           }
1139         else
1140           p = color + strlen (color);
1141         assert (p != NULL);
1142
1143         for (ch = color; *ch; ch++)
1144           if (!isalpha (*ch))
1145             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be made of non-alphabetic characters");
1146
1147         for (ch = color + 1; *ch; ch++)
1148           if (!islower (*ch))
1149             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be in mixed lower/upper case");
1150
1151         if (streq (color, "None"))
1152           vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be bold");
1153
1154         if (isupper (*color))
1155           {
1156             switch (index)
1157               {
1158                 case FOREGROUND:
1159                   snprintf (attr + strlen (attr), 3, "1;");
1160                   break;
1161                 case BACKGROUND:
1162                   vfprintf_fail (formats[FMT_COLOR], tables[BACKGROUND].desc, color, "cannot be bold");
1163                 default: /* never reached */
1164                   ABORT_TRACE ();
1165               }
1166           }
1167
1168         color_names[index] = xcalloc (1, sizeof (struct color_name));
1169         STACK_VAR (color_names[index]);
1170
1171         color_names[index]->orig = xstrdup (color);
1172         STACK_VAR (color_names[index]->orig);
1173
1174         for (ch = color; *ch; ch++)
1175           *ch = tolower (*ch);
1176
1177         color_names[index]->name = xstrdup (color);
1178         STACK_VAR (color_names[index]->name);
1179       }
1180
1181     RELEASE_VAR (str);
1182 }
1183
1184 static void
1185 read_print_stream (const char *attr, const struct color **colors, const char *file, FILE *stream)
1186 {
1187     char buf[BUF_SIZE + 1];
1188     unsigned int flags = 0;
1189
1190     while (!feof (stream))
1191       {
1192         size_t bytes_read;
1193         char *eol;
1194         const char *line;
1195         bytes_read = fread (buf, 1, BUF_SIZE, stream);
1196         if (bytes_read != BUF_SIZE && ferror (stream))
1197           vfprintf_fail (formats[FMT_ERROR], BUF_SIZE, "read");
1198         buf[bytes_read] = '\0';
1199         line = buf;
1200         while ((eol = strpbrk (line, "\n\r")))
1201           {
1202             const bool has_text = (eol > line);
1203             const char *p;
1204             flags &= ~(CR|LF);
1205             if (*eol == '\r')
1206               {
1207                 flags |= CR;
1208                 if (*(eol + 1) == '\n')
1209                   flags |= LF;
1210               }
1211             else if (*eol == '\n')
1212               flags |= LF;
1213             else /* never reached */
1214               vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending");
1215             p = eol + SKIP_LINE_ENDINGS (flags);
1216             *eol = '\0';
1217             print_line (attr, colors, line, flags,
1218                         omit_color_empty ? has_text : true);
1219             line = p;
1220           }
1221         if (feof (stream))
1222           {
1223             if (*line != '\0')
1224               print_line (attr, colors, line, 0, true);
1225           }
1226         else if (*line != '\0')
1227           {
1228             char *p;
1229             if ((clean || clean_all) && (p = strrchr (line, '\033')))
1230               merge_print_line (line, p, stream);
1231             else
1232               print_line (attr, colors, line, 0, true);
1233           }
1234       }
1235 }
1236
1237 static void
1238 merge_print_line (const char *line, const char *p, FILE *stream)
1239 {
1240     char *buf = NULL;
1241     char *merged_esc = NULL;
1242     const char *esc = "";
1243     const char char_restore = *p;
1244
1245     complete_part_line (p + 1, &buf, stream);
1246
1247     if (buf)
1248       {
1249         /* form escape sequence */
1250         esc = merged_esc = str_concat (p, buf);
1251         /* shorten partial line accordingly */
1252         *(char *)p = '\0';
1253         free (buf);
1254       }
1255
1256 #ifdef TEST_MERGE_PART_LINE
1257     printf ("%s%s", line, esc);
1258     fflush (stdout);
1259     _exit (EXIT_SUCCESS);
1260 #else
1261     print_clean (line);
1262     *(char *)p = char_restore;
1263     print_clean (esc);
1264     free (merged_esc);
1265 #endif
1266 }
1267
1268 static void
1269 complete_part_line (const char *p, char **buf, FILE *stream)
1270 {
1271     bool got_next_char = false, read_from_stream;
1272     char ch;
1273     size_t i = 0, size;
1274
1275     if (get_next_char (&ch, &p, stream, &read_from_stream))
1276       {
1277         if (ch == '[')
1278           {
1279             if (read_from_stream)
1280               save_char (ch, buf, &i, &size);
1281           }
1282         else
1283           {
1284             if (read_from_stream)
1285               ungetc ((int)ch, stream);
1286             return; /* cancel */
1287           }
1288       }
1289     else
1290       return; /* cancel */
1291
1292     while (get_next_char (&ch, &p, stream, &read_from_stream))
1293       {
1294         if (isdigit (ch) || ch == ';')
1295           {
1296             if (read_from_stream)
1297               save_char (ch, buf, &i, &size);
1298           }
1299         else /* got next character */
1300           {
1301             got_next_char = true;
1302             break;
1303           }
1304       }
1305
1306     if (got_next_char)
1307       {
1308         if (ch == 'm')
1309           {
1310             if (read_from_stream)
1311               save_char (ch, buf, &i, &size);
1312           }
1313         else
1314           {
1315             if (read_from_stream)
1316               ungetc ((int)ch, stream);
1317             return; /* cancel */
1318           }
1319       }
1320     else
1321       return; /* cancel */
1322 }
1323
1324 static bool
1325 get_next_char (char *ch, const char **p, FILE *stream, bool *read_from_stream)
1326 {
1327     if (**p == '\0')
1328       {
1329         int c;
1330         if ((c = fgetc (stream)) != EOF)
1331           {
1332             *ch = (char)c;
1333             *read_from_stream = true;
1334             return true;
1335           }
1336         else
1337           {
1338             *read_from_stream = false;
1339             return false;
1340           }
1341       }
1342     else
1343       {
1344         *ch = **p;
1345         (*p)++;
1346         *read_from_stream = false;
1347         return true;
1348       }
1349 }
1350
1351 static void
1352 save_char (char ch, char **buf, size_t *i, size_t *size)
1353 {
1354     if (!*buf)
1355       {
1356         *size = ALLOC_COMPLETE_PART_LINE;
1357         *buf = xmalloc (*size);
1358       }
1359     /* +1: effective occupied size of buffer */
1360     else if ((*i + 1) == *size)
1361       {
1362         *size *= 2;
1363         *buf = xrealloc (*buf, *size);
1364       }
1365     (*buf)[*i] = ch;
1366     (*buf)[*i + 1] = '\0';
1367     (*i)++;
1368 }
1369
1370 static void
1371 find_color_entries (struct color_name **color_names, const struct color **colors)
1372 {
1373     struct timeval tv;
1374     unsigned int index;
1375
1376     /* randomness */
1377     gettimeofday (&tv, NULL);
1378     srand (tv.tv_usec * tv.tv_sec);
1379
1380     for (index = 0; color_names[index]; index++)
1381       {
1382         const char *color_name = color_names[index]->name;
1383
1384         const unsigned int count                = tables[index].count;
1385         const struct color *const color_entries = tables[index].entries;
1386
1387         if (streq (color_name, "random"))
1388           {
1389             bool excludable;
1390             unsigned int i;
1391             do {
1392               excludable = false;
1393               i = rand() % (count - 2) + 1; /* omit color none and default */
1394               switch (index)
1395                 {
1396                   case FOREGROUND:
1397                     /* --exclude-random */
1398                     if (exclude && streq (exclude, color_entries[i].name))
1399                       excludable = true;
1400                     else if (color_names[BACKGROUND] && streq (color_names[BACKGROUND]->name, color_entries[i].name))
1401                       excludable = true;
1402                     break;
1403                   case BACKGROUND:
1404                     if (streq (colors[FOREGROUND]->name, color_entries[i].name))
1405                       excludable = true;
1406                     break;
1407                   default: /* never reached */
1408                     ABORT_TRACE ();
1409                  }
1410             } while (excludable);
1411             colors[index] = (struct color *)&color_entries[i];
1412           }
1413         else
1414           find_color_entry (color_names[index], index, colors);
1415       }
1416 }
1417
1418 static void
1419 find_color_entry (const struct color_name *color_name, unsigned int index, const struct color **colors)
1420 {
1421     bool found = false;
1422     unsigned int i;
1423
1424     const unsigned int count                = tables[index].count;
1425     const struct color *const color_entries = tables[index].entries;
1426
1427     for (i = 0; i < count; i++)
1428       if (streq (color_name->name, color_entries[i].name))
1429         {
1430           colors[index] = (struct color *)&color_entries[i];
1431           found = true;
1432           break;
1433         }
1434     if (!found)
1435       vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color_name->orig, "not recognized");
1436 }
1437
1438 static void
1439 print_line (const char *attr, const struct color **colors, const char *const line, unsigned int flags, bool emit_colors)
1440 {
1441     /* --clean[-all] */
1442     if (clean || clean_all)
1443       print_clean (line);
1444     /* skip for --omit-color-empty? */
1445     else if (emit_colors)
1446       {
1447         /* Foreground color code is guaranteed to be set when background color code is present.  */
1448         if (colors[BACKGROUND] && colors[BACKGROUND]->code)
1449           printf ("\033[%s", colors[BACKGROUND]->code);
1450         if (colors[FOREGROUND]->code)
1451           printf ("\033[%s%s%s\033[0m", attr, colors[FOREGROUND]->code, line);
1452         else
1453           printf (formats[FMT_GENERIC], line);
1454       }
1455     if (flags & CR)
1456       putchar ('\r');
1457     if (flags & LF)
1458       putchar ('\n');
1459 }
1460
1461 static void
1462 print_clean (const char *line)
1463 {
1464     const char *p = line;
1465
1466     if (is_esc (p))
1467       p = get_end_of_esc (p);
1468
1469     while (*p != '\0')
1470       {
1471         const char *text_start = p;
1472         const char *text_end = get_end_of_text (p);
1473         print_text (text_start, text_end - text_start);
1474         p = get_end_of_esc (text_end);
1475       }
1476 }
1477
1478 static bool
1479 is_esc (const char *p)
1480 {
1481     return gather_esc_offsets (p, NULL, NULL);
1482 }
1483
1484 static const char *
1485 get_end_of_esc (const char *p)
1486 {
1487     const char *esc;
1488     const char *end = NULL;
1489     while ((esc = strchr (p, '\033')))
1490       {
1491         if (gather_esc_offsets (esc, NULL, &end))
1492           break;
1493         p = esc + 1;
1494       }
1495     return end ? end + 1 : p + strlen (p);
1496 }
1497
1498 static const char *
1499 get_end_of_text (const char *p)
1500 {
1501     const char *esc;
1502     const char *start = NULL;
1503     while ((esc = strchr (p, '\033')))
1504       {
1505         if (gather_esc_offsets (esc, &start, NULL))
1506           break;
1507         p = esc + 1;
1508       }
1509     return start ? start : p + strlen (p);
1510 }
1511
1512 static void
1513 print_text (const char *p, size_t len)
1514 {
1515     size_t bytes_written;
1516     bytes_written = fwrite (p, 1, len, stdout);
1517     if (bytes_written != len)
1518       vfprintf_fail (formats[FMT_ERROR], (unsigned long)len, "written");
1519 }
1520
1521 static bool
1522 gather_esc_offsets (const char *p, const char **start, const char **end)
1523 {
1524     /* ESC[ */
1525     if (*p == 27 && *(p + 1) == '[')
1526       {
1527         bool valid = false;
1528         const char *const begin = p;
1529         p += 2;
1530         if (clean_all)
1531           valid = validate_esc_clean_all (&p);
1532         else if (clean)
1533           {
1534             bool check_values;
1535             unsigned int prev_iter, iter;
1536             const char *digit;
1537             prev_iter = iter = 0;
1538             do {
1539               check_values = false;
1540               iter++;
1541               if (!isdigit (*p))
1542                 break;
1543               digit = p;
1544               while (isdigit (*p))
1545                 p++;
1546               if (p - digit > 2)
1547                 break;
1548               else /* check range */
1549                 {
1550                   char val[3];
1551                   int value;
1552                   unsigned int i;
1553                   const unsigned int digits = p - digit;
1554                   for (i = 0; i < digits; i++)
1555                     val[i] = *digit++;
1556                   val[i] = '\0';
1557                   value = atoi (val);
1558                   valid = validate_esc_clean (value, iter, &prev_iter, &p, &check_values);
1559                 }
1560             } while (check_values);
1561           }
1562         if (valid)
1563           {
1564             if (start)
1565               *start = begin;
1566             if (end)
1567               *end = p;
1568             return true;
1569           }
1570       }
1571     return false;
1572 }
1573
1574 static bool
1575 validate_esc_clean_all (const char **p)
1576 {
1577     while (isdigit (**p) || **p == ';')
1578       (*p)++;
1579     return (**p == 'm');
1580 }
1581
1582 static bool
1583 validate_esc_clean (int value, unsigned int iter, unsigned int *prev_iter, const char **p, bool *check_values)
1584 {
1585     if (is_reset (value, iter, p))
1586       return true;
1587     else if (is_attr (value, iter, *prev_iter, p))
1588       {
1589         (*p)++;
1590         *check_values = true;
1591         *prev_iter = iter;
1592         return false; /* partial escape sequence, need another valid value */
1593       }
1594     else if (is_fg_color (value, p))
1595       return true;
1596     else if (is_bg_color (value, iter, p))
1597       return true;
1598     else
1599       return false;
1600 }
1601
1602 static bool
1603 is_reset (int value, unsigned int iter, const char **p)
1604 {
1605     return (value == 0 && iter == 1 && **p == 'm');
1606 }
1607
1608 static bool
1609 is_attr (int value, unsigned int iter, unsigned int prev_iter, const char **p)
1610 {
1611     return ((value > 0 && value < 10) && (iter - prev_iter == 1) && **p == ';');
1612 }
1613
1614 static bool
1615 is_fg_color (int value, const char **p)
1616 {
1617     return (((value >= 30 && value <= 37) || value == 39) && **p == 'm');
1618 }
1619
1620 static bool
1621 is_bg_color (int value, unsigned int iter, const char **p)
1622 {
1623     return (((value >= 40 && value <= 47) || value == 49) && iter == 1 && **p == 'm');
1624 }
1625
1626 #if !DEBUG
1627 static void *
1628 malloc_wrap (size_t size)
1629 {
1630     void *p = malloc (size);
1631     if (!p)
1632       MEM_ALLOC_FAIL ();
1633     return p;
1634 }
1635
1636 static void *
1637 calloc_wrap (size_t nmemb, size_t size)
1638 {
1639     void *p = calloc (nmemb, size);
1640     if (!p)
1641       MEM_ALLOC_FAIL ();
1642     return p;
1643 }
1644
1645 static void *
1646 realloc_wrap (void *ptr, size_t size)
1647 {
1648     void *p = realloc (ptr, size);
1649     if (!p)
1650       MEM_ALLOC_FAIL ();
1651     return p;
1652 }
1653 #else
1654 static const char *const format_debug = "%s: %10s %7lu bytes [source file %s, line %5u]\n";
1655 static void *
1656 malloc_wrap_debug (size_t size, const char *file, unsigned int line)
1657 {
1658     void *p = malloc (size);
1659     if (!p)
1660       MEM_ALLOC_FAIL_DEBUG (file, line);
1661     fprintf (log, format_debug, program_name, "malloc'ed", (unsigned long)size, file, line);
1662     return p;
1663 }
1664
1665 static void *
1666 calloc_wrap_debug (size_t nmemb, size_t size, const char *file, unsigned int line)
1667 {
1668     void *p = calloc (nmemb, size);
1669     if (!p)
1670       MEM_ALLOC_FAIL_DEBUG (file, line);
1671     fprintf (log, format_debug, program_name, "calloc'ed", (unsigned long)(nmemb * size), file, line);
1672     return p;
1673 }
1674
1675 static void *
1676 realloc_wrap_debug (void *ptr, size_t size, const char *file, unsigned int line)
1677 {
1678     void *p = realloc (ptr, size);
1679     if (!p)
1680       MEM_ALLOC_FAIL_DEBUG (file, line);
1681     fprintf (log, format_debug, program_name, "realloc'ed", (unsigned long)size, file, line);
1682     return p;
1683 }
1684 #endif /* !DEBUG */
1685
1686 static void
1687 free_wrap (void **ptr)
1688 {
1689     free (*ptr);
1690     *ptr = NULL;
1691 }
1692
1693 #if !DEBUG
1694 # define do_malloc(len, file, line) malloc_wrap(len)
1695 #else
1696 # define do_malloc(len, file, line) malloc_wrap_debug(len, file, line)
1697 #endif
1698
1699 static char *
1700 strdup_wrap (const char *str, const char *file, unsigned int line)
1701 {
1702     const size_t len = strlen (str) + 1;
1703     char *p = do_malloc (len, file, line);
1704     strncpy (p, str, len);
1705     return p;
1706 }
1707
1708 static char *
1709 str_concat_wrap (const char *str1, const char *str2, const char *file, unsigned int line)
1710 {
1711     const size_t len = strlen (str1) + strlen (str2) + 1;
1712     char *p, *str;
1713
1714     p = str = do_malloc (len, file, line);
1715     strncpy (p, str1, strlen (str1));
1716     p += strlen (str1);
1717     strncpy (p, str2, strlen (str2));
1718     p += strlen (str2);
1719     *p = '\0';
1720
1721     return str;
1722 }
1723
1724 static char *
1725 expand_string (const char *str)
1726 {
1727     char *s = NULL;
1728     wordexp_t p;
1729
1730     wordexp (str, &p, 0);
1731     if (p.we_wordc >= 1)
1732       s = xstrdup (p.we_wordv[0]);
1733     wordfree (&p);
1734
1735     return s;
1736 }
1737
1738 static bool
1739 get_bytes_size (unsigned long bytes, struct bytes_size *bytes_size)
1740 {
1741     const char *unit, units[] = { '0', 'K', 'M', 'G', '\0' };
1742     unsigned long size = bytes;
1743     if (bytes < 1024)
1744       return false;
1745     unit = units;
1746     while (size >= 1024 && *(unit + 1))
1747       {
1748         size /= 1024;
1749         unit++;
1750       }
1751     bytes_size->size = (unsigned int)size;
1752     bytes_size->unit = *unit;
1753     return true;
1754 }
1755
1756 static char *
1757 get_file_type (mode_t mode)
1758 {
1759     if (S_ISREG (mode))
1760       return "file";
1761     else if (S_ISDIR (mode))
1762       return "directory";
1763     else if (S_ISCHR (mode))
1764       return "character device";
1765     else if (S_ISBLK (mode))
1766       return "block device";
1767     else if (S_ISFIFO (mode))
1768       return "named pipe";
1769     else if (S_ISLNK (mode))
1770       return "symbolic link";
1771     else if (S_ISSOCK (mode))
1772       return "socket";
1773     else
1774       return "file";
1775 }
1776
1777 static bool
1778 has_color_name (const char *str, const char *name)
1779 {
1780     char *p;
1781
1782     assert (strlen (str) > 0);
1783     assert (strlen (name) > 0);
1784
1785     if (!(*str == *name || *str == toupper (*name)))
1786       return false;
1787     else if (*(name + 1) != '\0'
1788      && !((p = strstr (str + 1, name + 1)) && p == str + 1))
1789       return false;
1790     else
1791       return true;
1792 }
1793
1794 static FILE *
1795 open_file (const char *file, const char *mode)
1796 {
1797     FILE *stream;
1798
1799     errno = 0;
1800     stream = fopen (file, mode);
1801     if (!stream)
1802       vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
1803
1804     return stream;
1805 }
1806
1807 #define DO_VFPRINTF(fmt)                    \
1808     va_list ap;                             \
1809     fprintf (stderr, "%s: ", program_name); \
1810     va_start (ap, fmt);                     \
1811     vfprintf (stderr, fmt, ap);             \
1812     va_end (ap);                            \
1813     fprintf (stderr, "\n");
1814
1815 static void
1816 vfprintf_diag (const char *fmt, ...)
1817 {
1818     DO_VFPRINTF (fmt);
1819 }
1820
1821 static void
1822 vfprintf_fail (const char *fmt, ...)
1823 {
1824     DO_VFPRINTF (fmt);
1825     exit (EXIT_FAILURE);
1826 }
1827
1828 static void
1829 stack_var (void ***list, unsigned int *stacked, unsigned int index, void *ptr)
1830 {
1831     /* nothing to stack */
1832     if (ptr == NULL)
1833       return;
1834     if (!*list)
1835       *list = xmalloc (sizeof (void *));
1836     else
1837       {
1838         unsigned int i;
1839         for (i = 0; i < *stacked; i++)
1840           if (!(*list)[i])
1841             {
1842               (*list)[i] = ptr;
1843               return; /* reused */
1844             }
1845         *list = xrealloc (*list, (*stacked + 1) * sizeof (void *));
1846       }
1847     (*list)[index] = ptr;
1848     (*stacked)++;
1849 }
1850
1851 static void
1852 release_var (void **list, unsigned int stacked, void **ptr)
1853 {
1854     unsigned int i;
1855     /* nothing to release */
1856     if (*ptr == NULL)
1857       return;
1858     for (i = 0; i < stacked; i++)
1859       if (list[i] == *ptr)
1860         {
1861           free (*ptr);
1862           *ptr = NULL;
1863           list[i] = NULL;
1864           return;
1865         }
1866 }