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-2013 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 _POSIX_SOURCE
  23 #include <assert.h>
  24 #include <ctype.h>
  25 #include <errno.h>
  26 #include <getopt.h>
  27 #include <stdarg.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <sys/time.h>
  32 #include <sys/types.h>
  33 #include <sys/stat.h>
  34 #include <time.h>
  35 #include <unistd.h>
  36
  37 #ifndef DEBUG
  38 # define DEBUG 0
  39 #endif
  40
  41 #define str(arg) #arg
  42 #define to_str(arg) str(arg)
  43
  44 #define streq(s1, s2) (strcmp (s1, s2) == 0)
  45
  46 #if DEBUG
  47 # define xmalloc(size)        malloc_wrap_debug(size,        __FILE__, __LINE__)
  48 # define xcalloc(nmemb, size) calloc_wrap_debug(nmemb, size, __FILE__, __LINE__)
  49 # define xrealloc(ptr, size)  realloc_wrap_debug(ptr, size,  __FILE__, __LINE__)
  50 #else
  51 # define xmalloc(size)        malloc_wrap(size)
  52 # define xcalloc(nmemb, size) calloc_wrap(nmemb, size)
  53 # define xrealloc(ptr, size)  realloc_wrap(ptr, size)
  54 #endif
  55
  56 #define free_null(ptr) free_wrap((void **)&ptr)
  57 #define xstrdup(str)   strdup_wrap(str)
  58
  59 #if !defined BUF_SIZE || BUF_SIZE <= 0
  60 # undef BUF_SIZE
  61 # define BUF_SIZE 4096 + 1
  62 #endif
  63
  64 #define LF 0x01
  65 #define CR 0x02
  66
  67 #define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1)
  68
  69 #define STACK_VAR(ptr) do {                                   \
  70     stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
  71 } while (false);
  72
  73 #define RELEASE_VAR(ptr) do {                             \
  74     release_var (vars_list, stacked_vars, (void **)&ptr); \
  75 } while (false);
  76
  77 #define MEM_ALLOC_FAIL_DEBUG(file, line) do {                                               \
  78     fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
  79     exit (2);                                                                               \
  80 } while (false);
  81 #define MEM_ALLOC_FAIL() do {                                          \
  82     fprintf (stderr, "%s: memory allocation failure\n", program_name); \
  83     exit (2);                                                          \
  84 } while (false);
  85
  86 #define ABORT_TRACE()                                                              \
  87     fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
  88     abort ();                                                                      \
  89
  90 #define CHECK_COLORS_RANDOM(color1, color2)        \
  91      streq (color_names[color1]->name, "random")   \
  92  && (streq (color_names[color2]->name, "none")     \
  93   || streq (color_names[color2]->name, "default")) \
  94
  95 #define COLOR_SEP_CHAR '/'
  96
  97 #define VERSION "0.50"
  98
  99 typedef unsigned short bool;
 100
 101 enum { false, true };
 102
 103 struct color_name {
 104     char *name;
 105     char *orig;
 106 };
 107
 108 static struct color_name *color_names[3] = { NULL, NULL, NULL };
 109
 110 struct color {
 111     const char *name;
 112     const char *code;
 113 };
 114
 115 static const struct color fg_colors[] = {
 116     { "none",     NULL },
 117     { "black",   "30m" },
 118     { "red",     "31m" },
 119     { "green",   "32m" },
 120     { "yellow",  "33m" },
 121     { "blue",    "34m" },
 122     { "cyan",    "35m" },
 123     { "magenta", "36m" },
 124     { "white",   "37m" },
 125     { "default", "39m" },
 126 };
 127 static const struct color bg_colors[] = {
 128     { "none",     NULL },
 129     { "black",   "40m" },
 130     { "red",     "41m" },
 131     { "green",   "42m" },
 132     { "yellow",  "43m" },
 133     { "blue",    "44m" },
 134     { "cyan",    "45m" },
 135     { "magenta", "46m" },
 136     { "white",   "47m" },
 137     { "default", "49m" },
 138 };
 139
 140 enum fmts {
 141     FMT_GENERIC,
 142     FMT_COLOR,
 143     FMT_RANDOM,
 144     FMT_ERROR,
 145     FMT_FILE
 146 };
 147 static const char *formats[] = {
 148     "%s",                    /* generic */
 149     "%s color '%s' %s",      /* color   */
 150     "%s color '%s' %s '%s'", /* random  */
 151     "less than %u bytes %s", /* error   */
 152     "%s: %s",                /* file    */
 153 };
 154
 155 enum { FOREGROUND, BACKGROUND };
 156
 157 static const struct {
 158     struct color const *entries;
 159     unsigned int count;
 160     const char *desc;
 161 } tables[] = {
 162     { fg_colors, sizeof (fg_colors) / sizeof (struct color), "foreground" },
 163     { bg_colors, sizeof (bg_colors) / sizeof (struct color), "background" },
 164 };
 165
 166 static FILE *stream = NULL;
 167
 168 static unsigned int stacked_vars = 0;
 169 static void **vars_list = NULL;
 170
 171 static bool clean = false;
 172 static bool clean_all = false;
 173
 174 static char *exclude = NULL;
 175
 176 static const char *program_name;
 177
 178 static void print_help (void);
 179 static void print_version (void);
 180 static void cleanup (void);
 181 static void free_color_names (struct color_name **);
 182 static void process_options (unsigned int, char **, bool *, const struct color **, const char **, FILE **);
 183 static void process_file_option (const char *, const char **, FILE **);
 184 static void read_print_stream (bool, const struct color **, const char *, FILE *);
 185 static void find_color_entries (struct color_name **, const struct color **);
 186 static void find_color_entry (const struct color_name *, unsigned int, const struct color **);
 187 static void print_line (const struct color **, bool, const char * const, unsigned int);
 188 static void print_clean (const char *);
 189 static void print_free_offsets (const char *, char ***, unsigned int);
 190 static void *malloc_wrap (size_t);
 191 static void *calloc_wrap (size_t, size_t);
 192 static void *realloc_wrap (void *, size_t);
 193 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
 194 static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
 195 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
 196 static void free_wrap (void **);
 197 static char *strdup_wrap (const char *);
 198 static char *str_concat (const char *, const char *);
 199 static void vfprintf_diag (const char *, ...);
 200 static void vfprintf_fail (const char *, ...);
 201 static void stack_var (void ***, unsigned int *, unsigned int, void *);
 202 static void release_var (void **, unsigned int, void **);
 203
 204 #define SET_OPT_TYPE(type) \
 205     opt_type = type;       \
 206     opt = 0;               \
 207     goto PARSE_OPT;        \
 208
 209 extern char *optarg;
 210 extern int optind;
 211
 212 int
 213 main (int argc, char **argv)
 214 {
 215     unsigned int arg_cnt = 0;
 216
 217     enum {
 218         OPT_CLEAN = 1,
 219         OPT_CLEAN_ALL,
 220         OPT_EXCLUDE_RANDOM,
 221         OPT_HELP,
 222         OPT_VERSION
 223     };
 224
 225     int opt, opt_type = 0;
 226     struct option long_opts[] = {
 227         { "clean",          no_argument,       &opt_type, OPT_CLEAN          },
 228         { "clean-all",      no_argument,       &opt_type, OPT_CLEAN_ALL      },
 229         { "exclude-random", required_argument, &opt_type, OPT_EXCLUDE_RANDOM },
 230         { "help",           no_argument,       &opt_type, OPT_HELP           },
 231         { "version",        no_argument,       &opt_type, OPT_VERSION        },
 232         {  0,               0,                 0,         0                  },
 233     };
 234
 235     bool bold = false;
 236
 237     const struct color *colors[2] = {
 238         NULL, /* foreground */
 239         NULL, /* background */
 240     };
 241
 242     const char *file;
 243
 244     program_name = argv[0];
 245     atexit (cleanup);
 246
 247     setvbuf (stdout, NULL, _IOLBF, 0);
 248
 249     while ((opt = getopt_long (argc, argv, "hv", long_opts, NULL)) != -1)
 250       {
 251         PARSE_OPT:
 252         switch (opt)
 253           {
 254             case 0: /* long opts */
 255               switch (opt_type)
 256                 {
 257                   case OPT_CLEAN:
 258                     clean = true;
 259                     break;
 260                   case OPT_CLEAN_ALL:
 261                     clean_all = true;
 262                     break;
 263                   case OPT_EXCLUDE_RANDOM: {
 264                     char *p;
 265                     exclude = xstrdup (optarg);
 266                     STACK_VAR (exclude);
 267                     for (p = exclude; *p; p++)
 268                       *p = tolower (*p);
 269                     if (streq (exclude, "random"))
 270                       vfprintf_fail (formats[FMT_GENERIC], "--exclude-random switch must be provided a color");
 271                     break;
 272                   }
 273                   case OPT_HELP:
 274                     print_help ();
 275                     exit (EXIT_SUCCESS);
 276                   case OPT_VERSION:
 277                     print_version ();
 278                     exit (EXIT_SUCCESS);
 279                   default: /* never reached */
 280                     ABORT_TRACE ();
 281                 }
 282               break;
 283             case 'h':
 284               SET_OPT_TYPE (OPT_HELP);
 285             case 'v':
 286               SET_OPT_TYPE (OPT_VERSION);
 287             case '?':
 288               print_help ();
 289               exit (EXIT_FAILURE);
 290             default: /* never reached */
 291               ABORT_TRACE ();
 292           }
 293       }
 294
 295     arg_cnt = argc - optind;
 296
 297     if (clean || clean_all)
 298       {
 299         if (clean && clean_all)
 300           vfprintf_fail (formats[FMT_GENERIC], "--clean and --clean-all switch are mutually exclusive");
 301         if (arg_cnt > 1)
 302           {
 303             const char *format = "%s %s";
 304             const char *message = "switch cannot be used with more than one file";
 305             if (clean)
 306               vfprintf_fail (format, "--clean", message);
 307             else if (clean_all)
 308               vfprintf_fail (format, "--clean-all", message);
 309           }
 310       }
 311     else
 312       {
 313         if (arg_cnt == 0 || arg_cnt > 2)
 314           {
 315             print_help ();
 316             exit (EXIT_FAILURE);
 317           }
 318       }
 319
 320     if (clean || clean_all)
 321       process_file_option (argv[optind], &file, &stream);
 322     else
 323       process_options (arg_cnt, &argv[optind], &bold, colors, &file, &stream);
 324     read_print_stream (bold, colors, file, stream);
 325
 326     RELEASE_VAR (exclude);
 327
 328     exit (EXIT_SUCCESS);
 329 }
 330
 331 static void
 332 print_help (void)
 333 {
 334     unsigned int i;
 335
 336     printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name, COLOR_SEP_CHAR);
 337     printf ("\tColors (foreground) (background)\n");
 338     for (i = 0; i < tables[FOREGROUND].count; i++)
 339       {
 340         const struct color *entry = &tables[FOREGROUND].entries[i];
 341         const char *name = entry->name;
 342         const char *code = entry->code;
 343         if (code)
 344           printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
 345                    code, toupper (*name), *name, name + 1, 10 - (int)strlen (name), " ", name);
 346         else
 347           printf ("\t\t{-} %s%*s%s\n", name, 13 - (int)strlen (name), " ", name);
 348       }
 349     printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
 350
 351     printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
 352     printf ("\twhereas for lower case colors will be of normal intensity.\n");
 353
 354     printf ("\n\tOptions\n");
 355     printf ("\t\t    --clean\n");
 356     printf ("\t\t    --clean-all\n");
 357     printf ("\t\t    --exclude-random\n");
 358     printf ("\t\t-h, --help\n");
 359     printf ("\t\t-v, --version\n\n");
 360 }
 361
 362 static void
 363 print_version (void)
 364 {
 365     const char *c_flags;
 366     printf ("%s v%s (compiled at %s, %s)\n", "colorize", VERSION, __DATE__, __TIME__);
 367 #ifdef CFLAGS
 368     c_flags = to_str (CFLAGS);
 369 #else
 370     c_flags = "unknown";
 371 #endif
 372     printf ("Compiler flags: %s\n", c_flags);
 373     printf ("Buffer size: %u bytes\n", BUF_SIZE - 1);
 374 }
 375
 376 static void
 377 cleanup (void)
 378 {
 379     free_color_names (color_names);
 380
 381     if (stream && fileno (stream) != STDIN_FILENO)
 382       fclose (stream);
 383
 384     if (vars_list)
 385       {
 386         unsigned int i;
 387         for (i = 0; i < stacked_vars; i++)
 388           if (vars_list[i])
 389             free_null (vars_list[i]);
 390
 391         free_null (vars_list);
 392       }
 393 }
 394
 395 static void
 396 free_color_names (struct color_name **color_names)
 397 {
 398     unsigned int i;
 399     for (i = 0; color_names[i]; i++)
 400       {
 401         free_null (color_names[i]->name);
 402         free_null (color_names[i]->orig);
 403         free_null (color_names[i]);
 404       }
 405 }
 406
 407 static void
 408 process_options (unsigned int arg_cnt, char **option_strings, bool *bold, const struct color **colors, const char **file, FILE **stream)
 409 {
 410     int ret;
 411     unsigned int index;
 412     char *color, *p, *str;
 413     struct stat sb;
 414
 415     const char *color_string = arg_cnt >= 1 ? option_strings[0] : NULL;
 416     const char *file_string  = arg_cnt == 2 ? option_strings[1] : NULL;
 417
 418     assert (color_string);
 419
 420     if (streq (color_string, "-"))
 421       {
 422         if (file_string)
 423           vfprintf_fail (formats[FMT_GENERIC], "hyphen cannot be used as color string");
 424         else
 425           vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceeded by color string");
 426       }
 427
 428     ret = stat (color_string, &sb);
 429
 430     /* Ensure that we don't fail if there's a file with one or more
 431        color names in its path.  */
 432     if (ret != -1)
 433       {
 434         bool have_file;
 435         unsigned int c;
 436         const char *color = color_string;
 437
 438         for (c = 1; c <= 2 && *color; c++)
 439           {
 440             bool matched = false;
 441             unsigned int i;
 442             for (i = 0; i < tables[FOREGROUND].count; i++)
 443               {
 444                 const struct color *entry = &tables[FOREGROUND].entries[i];
 445                 char *p;
 446                 if ((p = strstr (color, entry->name)) && p == color)
 447                   {
 448                     color = p + strlen (entry->name);
 449                     matched = true;
 450                     break;
 451                   }
 452               }
 453             if (matched && *color == COLOR_SEP_CHAR && *(color + 1))
 454               color++;
 455             else
 456               break;
 457           }
 458
 459         have_file = (*color != '\0');
 460
 461         if (have_file)
 462           {
 463             if (file_string)
 464               vfprintf_fail (formats[FMT_GENERIC], "file cannot be used as color string");
 465             else
 466               vfprintf_fail (formats[FMT_GENERIC], "file must be preceeded by color string");
 467           }
 468       }
 469
 470     if ((p = strchr (color_string, COLOR_SEP_CHAR)))
 471       {
 472         if (p == color_string)
 473           vfprintf_fail (formats[FMT_GENERIC], "foreground color missing");
 474         else if (p == color_string + strlen (color_string) - 1)
 475           vfprintf_fail (formats[FMT_GENERIC], "background color missing");
 476         else if (strchr (++p, COLOR_SEP_CHAR))
 477           vfprintf_fail (formats[FMT_GENERIC], "one color pair allowed only");
 478       }
 479
 480     str = xstrdup (color_string);
 481     STACK_VAR (str);
 482
 483     for (index = 0, color = str; *color; index++, color = p)
 484       {
 485         char *ch, *sep;
 486         if ((sep = strchr (color, COLOR_SEP_CHAR)))
 487           {
 488             *sep = '\0';
 489             p = sep + 1;
 490           }
 491         else
 492           p = color + strlen (color);
 493
 494         for (ch = color; *ch; ch++)
 495           if (!isalpha (*ch))
 496             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be made of non-alphabetic characters");
 497
 498         for (ch = color + 1; *ch; ch++)
 499           if (!islower (*ch))
 500             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be in mixed lower/upper case");
 501
 502         if (streq (color, "None"))
 503           vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be bold");
 504
 505         if (isupper (*color))
 506           {
 507             switch (index)
 508               {
 509                 case FOREGROUND:
 510                   *bold = true;
 511                   break;
 512                 case BACKGROUND:
 513                   vfprintf_fail (formats[FMT_COLOR], tables[BACKGROUND].desc, color, "cannot be bold");
 514                   break;
 515                 default: /* never reached */
 516                   ABORT_TRACE ();
 517               }
 518           }
 519
 520         color_names[index] = xcalloc (1, sizeof (struct color_name));
 521
 522         color_names[index]->orig = xstrdup (color);
 523
 524         for (ch = color; *ch; ch++)
 525           *ch = tolower (*ch);
 526
 527         color_names[index]->name = xstrdup (color);
 528       }
 529
 530     RELEASE_VAR (str);
 531
 532     assert (color_names[FOREGROUND]);
 533
 534     if (color_names[BACKGROUND])
 535       {
 536         unsigned int i;
 537         unsigned int color_sets[2][2] = { { FOREGROUND, BACKGROUND }, { BACKGROUND, FOREGROUND } };
 538         for (i = 0; i < 2; i++)
 539           {
 540             unsigned int color1 = color_sets[i][0];
 541             unsigned int color2 = color_sets[i][1];
 542             if (CHECK_COLORS_RANDOM (color1, color2))
 543               vfprintf_fail (formats[FMT_RANDOM], tables[color1].desc, color_names[color1]->orig, "cannot be combined with", color_names[color2]->orig);
 544           }
 545       }
 546
 547     find_color_entries (color_names, colors);
 548     free_color_names (color_names);
 549
 550     if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code)
 551       {
 552         struct color_name color_name;
 553         color_name.name = color_name.orig = "default";
 554
 555         find_color_entry (&color_name, FOREGROUND, colors);
 556       }
 557
 558     process_file_option (file_string, file, stream);
 559 }
 560
 561 static void
 562 process_file_option (const char *file_string, const char **file, FILE **stream)
 563 {
 564     if (file_string)
 565       {
 566         if (streq (file_string, "-"))
 567           *stream = stdin;
 568         else
 569           {
 570             FILE *s;
 571             const char *file = file_string;
 572             struct stat sb;
 573             int errno, ret;
 574
 575             errno = 0;
 576             ret = stat (file, &sb);
 577
 578             if (ret == -1)
 579               vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
 580
 581             if (!(S_ISREG (sb.st_mode) || S_ISLNK (sb.st_mode) || S_ISFIFO (sb.st_mode)))
 582               vfprintf_fail (formats[FMT_FILE], file, "unrecognized file type");
 583
 584             errno = 0;
 585
 586             s = fopen (file, "r");
 587             if (!s)
 588               vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
 589             *stream = s;
 590           }
 591         *file = file_string;
 592       }
 593     else
 594       {
 595         *stream = stdin;
 596         *file = "stdin";
 597       }
 598
 599     assert (*stream);
 600 }
 601
 602 #define MERGE_PRINT_LINE(part_line, line, flags, check_eof) do { \
 603     char *current_line, *merged_line = NULL;                     \
 604     if (part_line)                                               \
 605       {                                                          \
 606         merged_line = str_concat (part_line, line);              \
 607         free_null (part_line);                                   \
 608       }                                                          \
 609     current_line = merged_line ? merged_line : (char *)line;     \
 610     if (!check_eof || *current_line != '\0')                     \
 611       print_line (colors, bold, current_line, flags);            \
 612     free (merged_line);                                          \
 613 } while (false);
 614
 615 static void
 616 read_print_stream (bool bold, const struct color **colors, const char *file, FILE *stream)
 617 {
 618     char buf[BUF_SIZE], *part_line = NULL;
 619     unsigned int flags = 0;
 620
 621     while (!feof (stream))
 622       {
 623         size_t bytes_read;
 624         char *eol;
 625         const char *line;
 626         memset (buf, '\0', BUF_SIZE);
 627         bytes_read = fread (buf, 1, BUF_SIZE - 1, stream);
 628         if (bytes_read != (BUF_SIZE - 1) && ferror (stream))
 629           vfprintf_fail (formats[FMT_ERROR], BUF_SIZE - 1, "read");
 630         line = buf;
 631         while ((eol = strpbrk (line, "\n\r")))
 632           {
 633             char *p;
 634             flags &= ~(CR|LF);
 635             if (*eol == '\r')
 636               {
 637                 flags |= CR;
 638                 if (*(eol + 1) == '\n')
 639                   flags |= LF;
 640               }
 641             else if (*eol == '\n')
 642               flags |= LF;
 643             else
 644               vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending");
 645             p = eol + SKIP_LINE_ENDINGS (flags);
 646             *eol = '\0';
 647             MERGE_PRINT_LINE (part_line, line, flags, false);
 648             line = p;
 649           }
 650         if (feof (stream)) {
 651           MERGE_PRINT_LINE (part_line, line, 0, true);
 652         }
 653         else if (*line != '\0')
 654           {
 655             if (!clean && !clean_all) /* efficiency */
 656               print_line (colors, bold, line, 0);
 657             else if (!part_line)
 658               part_line = xstrdup (line);
 659             else
 660               {
 661                 char *merged_line = str_concat (part_line, line);
 662                 free (part_line);
 663                 part_line = merged_line;
 664               }
 665           }
 666       }
 667 }
 668
 669 static void
 670 find_color_entries (struct color_name **color_names, const struct color **colors)
 671 {
 672     struct timeval tv;
 673     unsigned int index;
 674
 675     /* randomness */
 676     gettimeofday (&tv, NULL);
 677     srand (tv.tv_usec * tv.tv_sec);
 678
 679     for (index = 0; color_names[index]; index++)
 680       {
 681         const char *color_name = color_names[index]->name;
 682
 683         const unsigned int count                = tables[index].count;
 684         const struct color *const color_entries = tables[index].entries;
 685
 686         if (streq (color_name, "random"))
 687           {
 688             bool excludable;
 689             unsigned int i;
 690             do {
 691               excludable = false;
 692               i = rand() % (count - 2) + 1; /* omit color none and default */
 693               switch (index)
 694                 {
 695                   case FOREGROUND:
 696                     /* --exclude-random */
 697                     if (exclude && streq (exclude, color_entries[i].name))
 698                       excludable = true;
 699                     else if (color_names[BACKGROUND] && streq (color_names[BACKGROUND]->name, color_entries[i].name))
 700                       excludable = true;
 701                     break;
 702                   case BACKGROUND:
 703                     if (streq (colors[FOREGROUND]->name, color_entries[i].name))
 704                       excludable = true;
 705                     break;
 706                   default: /* never reached */
 707                     ABORT_TRACE ();
 708                  }
 709             } while (excludable);
 710             colors[index] = (struct color *)&color_entries[i];
 711           }
 712         else
 713           find_color_entry (color_names[index], index, colors);
 714       }
 715 }
 716
 717 static void
 718 find_color_entry (const struct color_name *color_name, unsigned int index, const struct color **colors)
 719 {
 720     bool found = false;
 721     unsigned int i;
 722
 723     const unsigned int count                = tables[index].count;
 724     const struct color *const color_entries = tables[index].entries;
 725
 726     for (i = 0; i < count; i++)
 727       if (streq (color_name->name, color_entries[i].name))
 728         {
 729           colors[index] = (struct color *)&color_entries[i];
 730           found = true;
 731           break;
 732         }
 733     if (!found)
 734       vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color_name->orig, "not recognized");
 735 }
 736
 737 static void
 738 print_line (const struct color **colors, bool bold, const char *const line, unsigned int flags)
 739 {
 740     /* --clean[-all] */
 741     if (clean || clean_all)
 742       print_clean (line);
 743     else
 744       {
 745         /* Foreground color code is guaranteed to be set when background color code is present.  */
 746         if (colors[BACKGROUND] && colors[BACKGROUND]->code)
 747           printf ("\033[%s", colors[BACKGROUND]->code);
 748         if (colors[FOREGROUND]->code)
 749           printf ("\033[%s%s%s\033[0m", bold ? "1;" : "", colors[FOREGROUND]->code, line);
 750         else
 751           printf (formats[FMT_GENERIC], line);
 752       }
 753     if (flags & CR)
 754       putchar ('\r');
 755     if (flags & LF)
 756       putchar ('\n');
 757 }
 758
 759 static void
 760 print_clean (const char *line)
 761 {
 762     const char *p;
 763     char ***offsets = NULL;
 764     unsigned int count = 0, i = 0;
 765
 766     for (p = line; *p;)
 767       {
 768         /* ESC[ */
 769         if (*p == 27 && *(p + 1) == '[')
 770           {
 771             const char *begin = p;
 772             p += 2;
 773             if (clean_all)
 774               {
 775                 while (isdigit (*p) || *p == ';')
 776                   p++;
 777               }
 778             else if (clean)
 779               {
 780                 bool check_values;
 781                 unsigned int iter = 0;
 782                 const char *digit;
 783                 do {
 784                   check_values = false;
 785                   iter++;
 786                   if (!isdigit (*p))
 787                     goto DISCARD;
 788                   digit = p;
 789                   while (isdigit (*p))
 790                     p++;
 791                   if (p - digit > 2)
 792                     goto DISCARD;
 793                   else /* check range */
 794                     {
 795                       char val[3];
 796                       int value;
 797                       unsigned int i;
 798                       const unsigned int digits = p - digit;
 799                       for (i = 0; i < digits; i++)
 800                         val[i] = *digit++;
 801                       val[i] = '\0';
 802                       value = atoi (val);
 803                       if (value == 0) /* reset */
 804                         {
 805                           if (iter > 1)
 806                             goto DISCARD;
 807                           goto END;
 808                         }
 809                       else if (value == 1) /* bold */
 810                         {
 811                           bool discard = false;
 812                           if (iter > 1)
 813                             discard = true;
 814                           else if (*p != ';')
 815                             discard = true;
 816                           if (discard)
 817                             goto DISCARD;
 818                           p++;
 819                           check_values = true;
 820                         }
 821                       else if ((value >= 30 && value <= 37) || value == 39) /* foreground colors */
 822                         goto END;
 823                       else if ((value >= 40 && value <= 47) || value == 49) /* background colors */
 824                         {
 825                           if (iter > 1)
 826                             goto DISCARD;
 827                           goto END;
 828                         }
 829                       else
 830                         goto DISCARD;
 831                     }
 832                 } while (iter == 1 && check_values);
 833               }
 834             END: if (*p == 'm')
 835               {
 836                 const char *end = p++;
 837                 if (!offsets)
 838                   offsets = xmalloc (++count * sizeof (char **));
 839                 else
 840                   offsets = xrealloc (offsets, ++count * sizeof (char **));
 841                 offsets[i] = xmalloc (2 * sizeof (char *));
 842                 offsets[i][0] = (char *)begin; /* ESC */
 843                 offsets[i][1] = (char *)end;   /* m */
 844                 i++;
 845                 continue;
 846               }
 847             DISCARD:
 848               continue;
 849           }
 850         p++;
 851       }
 852
 853     if (offsets)
 854       print_free_offsets (line, offsets, count);
 855     else
 856       printf (formats[FMT_GENERIC], line);
 857 }
 858
 859 #define SET_CHAR(offset, new, old) \
 860     *old = *offset;                \
 861     *offset = new;                 \
 862
 863 #define RESTORE_CHAR(offset, old)  \
 864     *offset = old;                 \
 865
 866 static void
 867 print_free_offsets (const char *line, char ***offsets, unsigned int count)
 868 {
 869     char ch;
 870     unsigned int i;
 871
 872     SET_CHAR (offsets[0][0], '\0', &ch);
 873     printf (formats[FMT_GENERIC], line);
 874     RESTORE_CHAR (offsets[0][0], ch);
 875
 876     for (i = 0; i < count; i++)
 877       {
 878         char ch;
 879         bool next_offset = false;
 880         if (i + 1 < count)
 881           {
 882             SET_CHAR (offsets[i + 1][0], '\0', &ch);
 883             next_offset = true;
 884           }
 885         printf (formats[FMT_GENERIC], offsets[i][1] + 1);
 886         if (next_offset)
 887           RESTORE_CHAR (offsets[i + 1][0], ch);
 888       }
 889     for (i = 0; i < count; i++)
 890       free_null (offsets[i]);
 891     free_null (offsets);
 892 }
 893
 894 static void *
 895 malloc_wrap (size_t size)
 896 {
 897     void *p = malloc (size);
 898     if (!p)
 899       MEM_ALLOC_FAIL ();
 900     return p;
 901 }
 902
 903 static void *
 904 calloc_wrap (size_t nmemb, size_t size)
 905 {
 906     void *p = calloc (nmemb, size);
 907     if (!p)
 908       MEM_ALLOC_FAIL ();
 909     return p;
 910 }
 911
 912 static void *
 913 realloc_wrap (void *ptr, size_t size)
 914 {
 915     void *p = realloc (ptr, size);
 916     if (!p)
 917       MEM_ALLOC_FAIL ();
 918     return p;
 919 }
 920
 921 static void *
 922 malloc_wrap_debug (size_t size, const char *file, unsigned int line)
 923 {
 924     void *p = malloc (size);
 925     if (!p)
 926       MEM_ALLOC_FAIL_DEBUG (file, line);
 927     return p;
 928 }
 929
 930 static void *
 931 calloc_wrap_debug (size_t nmemb, size_t size, const char *file, unsigned int line)
 932 {
 933     void *p = calloc (nmemb, size);
 934     if (!p)
 935       MEM_ALLOC_FAIL_DEBUG (file, line);
 936     return p;
 937 }
 938
 939 static void *
 940 realloc_wrap_debug (void *ptr, size_t size, const char *file, unsigned int line)
 941 {
 942     void *p = realloc (ptr, size);
 943     if (!p)
 944       MEM_ALLOC_FAIL_DEBUG (file, line);
 945     return p;
 946 }
 947
 948 static void
 949 free_wrap (void **ptr)
 950 {
 951     free (*ptr);
 952     *ptr = NULL;
 953 }
 954
 955 static char *
 956 strdup_wrap (const char *str)
 957 {
 958     const size_t len = strlen (str) + 1;
 959     char *p = xmalloc (len);
 960     strncpy (p, str, len);
 961     return p;
 962 }
 963
 964 static char *
 965 str_concat (const char *str1, const char *str2)
 966 {
 967     const size_t len = strlen (str1) + strlen (str2) + 1;
 968     char *p, *str;
 969
 970     p = str = xmalloc (len);
 971     strncpy (p, str1, strlen (str1));
 972     p += strlen (str1);
 973     strncpy (p, str2, strlen (str2));
 974     p += strlen (str2);
 975     *p = '\0';
 976
 977     return str;
 978 }
 979
 980 #define DO_VFPRINTF(fmt)                    \
 981     va_list ap;                             \
 982     fprintf (stderr, "%s: ", program_name); \
 983     va_start (ap, fmt);                     \
 984     vfprintf (stderr, fmt, ap);             \
 985     va_end (ap);                            \
 986     fprintf (stderr, "\n");                 \
 987
 988 static void
 989 vfprintf_diag (const char *fmt, ...)
 990 {
 991     DO_VFPRINTF (fmt);
 992 }
 993
 994 static void
 995 vfprintf_fail (const char *fmt, ...)
 996 {
 997     DO_VFPRINTF (fmt);
 998     exit (EXIT_FAILURE);
 999 }
1000
1001 static void
1002 stack_var (void ***list, unsigned int *stacked, unsigned int index, void *ptr)
1003 {
1004     /* nothing to stack */
1005     if (ptr == NULL)
1006       return;
1007     if (!*list)
1008       *list = xmalloc (sizeof (void *));
1009     else
1010       {
1011         unsigned int i;
1012         for (i = 0; i < *stacked; i++)
1013           if (!(*list)[i])
1014             {
1015               (*list)[i] = ptr;
1016               return; /* reused */
1017             }
1018         *list = xrealloc (*list, (*stacked + 1) * sizeof (void *));
1019       }
1020     (*list)[index] = ptr;
1021     (*stacked)++;
1022 }
1023
1024 static void
1025 release_var (void **list, unsigned int stacked, void **ptr)
1026 {
1027     unsigned int i;
1028     /* nothing to release */
1029     if (*ptr == NULL)
1030       return;
1031     for (i = 0; i < stacked; i++)
1032       if (list[i] == *ptr)
1033         {
1034           free (*ptr);
1035           *ptr = NULL;
1036           list[i] = NULL;
1037           return;
1038         }
1039 }