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