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