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