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.56"
 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 = 0;
 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           if (vars_list[i])
 497             free (vars_list[i]);
 498
 499         free_null (vars_list);
 500       }
 501 }
 502
 503 static void
 504 free_color_names (struct color_name **color_names)
 505 {
 506     unsigned int i;
 507     for (i = 0; color_names[i]; i++)
 508       {
 509         free (color_names[i]->name);
 510         free (color_names[i]->orig);
 511         free_null (color_names[i]);
 512       }
 513 }
 514
 515 static void
 516 process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct color **colors, const char **file, FILE **stream)
 517 {
 518     int ret;
 519     unsigned int index;
 520     char *color, *p, *str;
 521     struct stat sb;
 522
 523     const char *color_string = arg_cnt >= 1 ? arg_strings[0] : NULL;
 524     const char *file_string  = arg_cnt == 2 ? arg_strings[1] : NULL;
 525
 526     assert (color_string);
 527
 528     if (streq (color_string, "-"))
 529       {
 530         if (file_string)
 531           vfprintf_fail (formats[FMT_GENERIC], "hyphen cannot be used as color string");
 532         else
 533           vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceeded by color string");
 534       }
 535
 536     ret = lstat (color_string, &sb);
 537
 538     /* Ensure that we don't fail if there's a file with one or more
 539        color names in its path.  */
 540     if (ret == 0) /* success */
 541       {
 542         bool have_file;
 543         unsigned int c;
 544         const char *color = color_string;
 545         const mode_t mode = sb.st_mode;
 546
 547         for (c = 1; c <= 2 && *color; c++)
 548           {
 549             bool matched = false;
 550             unsigned int i;
 551             for (i = 0; i < tables[FOREGROUND].count; i++)
 552               {
 553                 const struct color *entry = &tables[FOREGROUND].entries[i];
 554                 if (has_color_name (color, entry->name))
 555                   {
 556                     color += strlen (entry->name);
 557                     matched = true;
 558                     break;
 559                   }
 560               }
 561             if (!matched && has_color_name (color, "random"))
 562               {
 563                 color += strlen ("random");
 564                 matched = true;
 565               }
 566             if (matched && *color == COLOR_SEP_CHAR && *(color + 1))
 567               color++;
 568             else
 569               break;
 570           }
 571
 572         have_file = (*color != '\0');
 573
 574         if (have_file)
 575           {
 576             const char *file_exists = color_string;
 577             if (file_string)
 578               vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "cannot be used as color string");
 579             else
 580               {
 581                 if (VALID_FILE_TYPE (mode))
 582                   vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "must be preceeded by color string");
 583                 else
 584                   vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "is not a valid file type");
 585               }
 586           }
 587       }
 588
 589     if ((p = strchr (color_string, COLOR_SEP_CHAR)))
 590       {
 591         if (p == color_string)
 592           vfprintf_fail (formats[FMT_STRING], "foreground color missing in string", color_string);
 593         else if (p == color_string + strlen (color_string) - 1)
 594           vfprintf_fail (formats[FMT_STRING], "background color missing in string", color_string);
 595         else if (strchr (++p, COLOR_SEP_CHAR))
 596           vfprintf_fail (formats[FMT_STRING], "one color pair allowed only for string", color_string);
 597       }
 598
 599     str = xstrdup (color_string);
 600     STACK_VAR (str);
 601
 602     for (index = 0, color = str; *color; index++, color = p)
 603       {
 604         char *ch, *sep;
 605
 606         p = NULL;
 607         if ((sep = strchr (color, COLOR_SEP_CHAR)))
 608           {
 609             *sep = '\0';
 610             p = sep + 1;
 611           }
 612         else
 613           p = color + strlen (color);
 614         assert (p);
 615
 616         for (ch = color; *ch; ch++)
 617           if (!isalpha (*ch))
 618             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be made of non-alphabetic characters");
 619
 620         for (ch = color + 1; *ch; ch++)
 621           if (!islower (*ch))
 622             vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be in mixed lower/upper case");
 623
 624         if (streq (color, "None"))
 625           vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be bold");
 626
 627         if (isupper (*color))
 628           {
 629             switch (index)
 630               {
 631                 case FOREGROUND:
 632                   *bold = true;
 633                   break;
 634                 case BACKGROUND:
 635                   vfprintf_fail (formats[FMT_COLOR], tables[BACKGROUND].desc, color, "cannot be bold");
 636                 default: /* never reached */
 637                   ABORT_TRACE ();
 638               }
 639           }
 640
 641         color_names[index] = xcalloc (1, sizeof (struct color_name));
 642
 643         color_names[index]->orig = xstrdup (color);
 644
 645         for (ch = color; *ch; ch++)
 646           *ch = tolower (*ch);
 647
 648         color_names[index]->name = xstrdup (color);
 649       }
 650
 651     RELEASE_VAR (str);
 652
 653     assert (color_names[FOREGROUND]);
 654
 655     if (color_names[BACKGROUND])
 656       {
 657         unsigned int i;
 658         const unsigned int color_sets[2][2] = { { FOREGROUND, BACKGROUND }, { BACKGROUND, FOREGROUND } };
 659         for (i = 0; i < 2; i++)
 660           {
 661             const unsigned int color1 = color_sets[i][0];
 662             const unsigned int color2 = color_sets[i][1];
 663             if (CHECK_COLORS_RANDOM (color1, color2))
 664               vfprintf_fail (formats[FMT_RANDOM], tables[color1].desc, color_names[color1]->orig, "cannot be combined with", color_names[color2]->orig);
 665           }
 666       }
 667
 668     find_color_entries (color_names, colors);
 669     free_color_names (color_names);
 670
 671     if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code)
 672       {
 673         struct color_name color_name;
 674         color_name.name = color_name.orig = "default";
 675
 676         find_color_entry (&color_name, FOREGROUND, colors);
 677       }
 678
 679     process_file_arg (file_string, file, stream);
 680 }
 681
 682 static void
 683 process_file_arg (const char *file_string, const char **file, FILE **stream)
 684 {
 685     if (file_string)
 686       {
 687         if (streq (file_string, "-"))
 688           *stream = stdin;
 689         else
 690           {
 691             const char *file = file_string;
 692             struct stat sb;
 693             int ret;
 694
 695             errno = 0;
 696             ret = stat (file, &sb);
 697
 698             if (ret == -1)
 699               vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
 700
 701             if (!VALID_FILE_TYPE (sb.st_mode))
 702               vfprintf_fail (formats[FMT_TYPE], file, "unrecognized type", get_file_type (sb.st_mode));
 703
 704             *stream = open_file (file, "r");
 705           }
 706         *file = file_string;
 707       }
 708     else
 709       {
 710         *stream = stdin;
 711         *file = "stdin";
 712       }
 713
 714     assert (*stream);
 715     assert (*file);
 716 }
 717
 718 static void
 719 read_print_stream (bool bold, const struct color **colors, const char *file, FILE *stream)
 720 {
 721     char buf[BUF_SIZE + 1];
 722     unsigned int flags = 0;
 723
 724     while (!feof (stream))
 725       {
 726         size_t bytes_read;
 727         char *eol;
 728         const char *line;
 729         memset (buf, '\0', BUF_SIZE + 1);
 730         bytes_read = fread (buf, 1, BUF_SIZE, stream);
 731         if (bytes_read != BUF_SIZE && ferror (stream))
 732           vfprintf_fail (formats[FMT_ERROR], BUF_SIZE, "read");
 733         line = buf;
 734         while ((eol = strpbrk (line, "\n\r")))
 735           {
 736             char *p;
 737             flags &= ~(CR|LF);
 738             if (*eol == '\r')
 739               {
 740                 flags |= CR;
 741                 if (*(eol + 1) == '\n')
 742                   flags |= LF;
 743               }
 744             else if (*eol == '\n')
 745               flags |= LF;
 746             else
 747               vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending");
 748             p = eol + SKIP_LINE_ENDINGS (flags);
 749             *eol = '\0';
 750             print_line (bold, colors, line, flags);
 751             line = p;
 752           }
 753         if (feof (stream))
 754           {
 755             if (*line != '\0')
 756               print_line (bold, colors, line, 0);
 757           }
 758         else if (*line != '\0')
 759           {
 760             char *p;
 761             if ((clean || clean_all) && (p = strrchr (line, '\033')))
 762               merge_print_line (bold, colors, line, p, stream);
 763             else
 764               print_line (bold, colors, line, 0);
 765           }
 766       }
 767 }
 768
 769 static void
 770 merge_print_line (bool bold, const struct color **colors, const char *line, const char *p, FILE *stream)
 771 {
 772     char *buf = NULL;
 773     char *merged_part_line = NULL;
 774     const char *part_line;
 775
 776     complete_part_line (p + 1, &buf, stream);
 777
 778     if (buf)
 779       part_line = merged_part_line = str_concat (line, buf);
 780     else
 781       part_line = line;
 782     free (buf);
 783
 784 #ifdef TEST_MERGE_PART_LINE
 785     printf ("%s", part_line);
 786     free (merged_part_line);
 787     exit (EXIT_SUCCESS);
 788 #else
 789     print_line (bold, colors, part_line, 0);
 790     free (merged_part_line);
 791 #endif
 792 }
 793
 794 static void
 795 complete_part_line (const char *p, char **buf, FILE *stream)
 796 {
 797     bool got_next_char = false, read_from_stream;
 798     char ch;
 799     unsigned long i = 0;
 800     size_t size;
 801
 802     if (get_next_char (&ch, &p, stream, &read_from_stream))
 803       {
 804         if (ch == '[')
 805           {
 806             if (read_from_stream)
 807               save_char (ch, buf, &i, &size);
 808           }
 809         else
 810           {
 811             if (read_from_stream)
 812               ungetc ((int)ch, stream);
 813             return; /* cancel */
 814           }
 815       }
 816     else
 817       return; /* cancel */
 818
 819     while (get_next_char (&ch, &p, stream, &read_from_stream))
 820       {
 821         if (isdigit (ch) || ch == ';')
 822           {
 823             if (read_from_stream)
 824               save_char (ch, buf, &i, &size);
 825           }
 826         else /* read next character */
 827           {
 828             got_next_char = true;
 829             break;
 830           }
 831       }
 832
 833     if (got_next_char)
 834       {
 835         if (ch == 'm')
 836           {
 837             if (read_from_stream)
 838               save_char (ch, buf, &i, &size);
 839           }
 840         else
 841           {
 842             if (read_from_stream)
 843               ungetc ((int)ch, stream);
 844             return; /* cancel */
 845           }
 846       }
 847     else
 848       return; /* cancel */
 849 }
 850
 851 static bool
 852 get_next_char (char *ch, const char **p, FILE *stream, bool *read_from_stream)
 853 {
 854     if (**p == '\0')
 855       {
 856         int c;
 857         if ((c = fgetc (stream)) != EOF)
 858           {
 859             *ch = (char)c;
 860             *read_from_stream = true;
 861             return true;
 862           }
 863         else
 864           {
 865             *read_from_stream = false;
 866             return false;
 867           }
 868       }
 869     else
 870       {
 871         *ch = **p;
 872         (*p)++;
 873         *read_from_stream = false;
 874         return true;
 875       }
 876 }
 877
 878 static void
 879 save_char (char ch, char **buf, unsigned long *i, size_t *size)
 880 {
 881     if (!*buf)
 882       {
 883         *size = ALLOC_COMPLETE_PART_LINE;
 884         *buf = xmalloc (*size);
 885       }
 886     /* +1: effective occupied size of buffer */
 887     else if ((*i + 1) == *size)
 888       {
 889         *size *= 2;
 890         *buf = xrealloc (*buf, *size);
 891       }
 892     (*buf)[*i] = ch;
 893     (*buf)[*i + 1] = '\0';
 894     (*i)++;
 895 }
 896
 897 static void
 898 find_color_entries (struct color_name **color_names, const struct color **colors)
 899 {
 900     struct timeval tv;
 901     unsigned int index;
 902
 903     /* randomness */
 904     gettimeofday (&tv, NULL);
 905     srand (tv.tv_usec * tv.tv_sec);
 906
 907     for (index = 0; color_names[index]; index++)
 908       {
 909         const char *color_name = color_names[index]->name;
 910
 911         const unsigned int count                = tables[index].count;
 912         const struct color *const color_entries = tables[index].entries;
 913
 914         if (streq (color_name, "random"))
 915           {
 916             bool excludable;
 917             unsigned int i;
 918             do {
 919               excludable = false;
 920               i = rand() % (count - 2) + 1; /* omit color none and default */
 921               switch (index)
 922                 {
 923                   case FOREGROUND:
 924                     /* --exclude-random */
 925                     if (exclude && streq (exclude, color_entries[i].name))
 926                       excludable = true;
 927                     else if (color_names[BACKGROUND] && streq (color_names[BACKGROUND]->name, color_entries[i].name))
 928                       excludable = true;
 929                     break;
 930                   case BACKGROUND:
 931                     if (streq (colors[FOREGROUND]->name, color_entries[i].name))
 932                       excludable = true;
 933                     break;
 934                   default: /* never reached */
 935                     ABORT_TRACE ();
 936                  }
 937             } while (excludable);
 938             colors[index] = (struct color *)&color_entries[i];
 939           }
 940         else
 941           find_color_entry (color_names[index], index, colors);
 942       }
 943 }
 944
 945 static void
 946 find_color_entry (const struct color_name *color_name, unsigned int index, const struct color **colors)
 947 {
 948     bool found = false;
 949     unsigned int i;
 950
 951     const unsigned int count                = tables[index].count;
 952     const struct color *const color_entries = tables[index].entries;
 953
 954     for (i = 0; i < count; i++)
 955       if (streq (color_name->name, color_entries[i].name))
 956         {
 957           colors[index] = (struct color *)&color_entries[i];
 958           found = true;
 959           break;
 960         }
 961     if (!found)
 962       vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color_name->orig, "not recognized");
 963 }
 964
 965 static void
 966 print_line (bool bold, const struct color **colors, const char *const line, unsigned int flags)
 967 {
 968     /* --clean[-all] */
 969     if (clean || clean_all)
 970       print_clean (line);
 971     else
 972       {
 973         /* Foreground color code is guaranteed to be set when background color code is present.  */
 974         if (colors[BACKGROUND] && colors[BACKGROUND]->code)
 975           printf ("\033[%s", colors[BACKGROUND]->code);
 976         if (colors[FOREGROUND]->code)
 977           printf ("\033[%s%s%s\033[0m", bold ? "1;" : "", colors[FOREGROUND]->code, line);
 978         else
 979           printf (formats[FMT_GENERIC], line);
 980       }
 981     if (flags & CR)
 982       putchar ('\r');
 983     if (flags & LF)
 984       putchar ('\n');
 985 }
 986
 987 static void
 988 print_clean (const char *line)
 989 {
 990     const char *p = line;
 991
 992     if (is_esc (p))
 993       p = get_end_of_esc (p);
 994
 995     while (*p != '\0')
 996       {
 997         const char *text_start = p;
 998         const char *text_end = get_end_of_text (p);
 999         print_text (text_start, text_end - text_start);
1000         p = get_end_of_esc (text_end);
1001       }
1002 }
1003
1004 static bool
1005 is_esc (const char *p)
1006 {
1007     return gather_esc_offsets (p, NULL, NULL);
1008 }
1009
1010 static const char *
1011 get_end_of_esc (const char *p)
1012 {
1013     const char *esc;
1014     const char *end = NULL;
1015     while ((esc = strchr (p, '\033')))
1016       {
1017         if (gather_esc_offsets (esc, NULL, &end))
1018           break;
1019         p = esc + 1;
1020       }
1021     return end ? end + 1 : p + strlen (p);
1022 }
1023
1024 static const char *
1025 get_end_of_text (const char *p)
1026 {
1027     const char *esc;
1028     const char *start = NULL;
1029     while ((esc = strchr (p, '\033')))
1030       {
1031         if (gather_esc_offsets (esc, &start, NULL))
1032           break;
1033         p = esc + 1;
1034       }
1035     return start ? start : p + strlen (p);
1036 }
1037
1038 static void
1039 print_text (const char *p, size_t len)
1040 {
1041     size_t bytes_written;
1042     bytes_written = fwrite (p, 1, len, stdout);
1043     if (bytes_written != len)
1044       vfprintf_fail (formats[FMT_ERROR], (unsigned long)len, "written");
1045 }
1046
1047 static bool
1048 gather_esc_offsets (const char *p, const char **start, const char **end)
1049 {
1050     /* ESC[ */
1051     if (*p == 27 && *(p + 1) == '[')
1052       {
1053         bool valid = false;
1054         const char *begin = p;
1055         p += 2;
1056         if (clean_all)
1057           valid = validate_esc_clean_all (&p);
1058         else if (clean)
1059           {
1060             bool check_values;
1061             unsigned int iter = 0;
1062             const char *digit;
1063             do {
1064               check_values = false;
1065               iter++;
1066               if (!isdigit (*p))
1067                 break;
1068               digit = p;
1069               while (isdigit (*p))
1070                 p++;
1071               if (p - digit > 2)
1072                 break;
1073               else /* check range */
1074                 {
1075                   char val[3];
1076                   int value;
1077                   unsigned int i;
1078                   const unsigned int digits = p - digit;
1079                   for (i = 0; i < digits; i++)
1080                     val[i] = *digit++;
1081                   val[i] = '\0';
1082                   value = atoi (val);
1083                   valid = validate_esc_clean (value, iter, &p, &check_values);
1084                 }
1085             } while (check_values);
1086           }
1087         if (valid)
1088           {
1089             if (start)
1090               *start = begin;
1091             if (end)
1092               *end = p;
1093             return true;
1094           }
1095       }
1096     return false;
1097 }
1098
1099 static bool
1100 validate_esc_clean_all (const char **p)
1101 {
1102     while (isdigit (**p) || **p == ';')
1103       (*p)++;
1104     return (**p == 'm');
1105 }
1106
1107 static bool
1108 validate_esc_clean (int value, unsigned int iter, const char **p, bool *check_values)
1109 {
1110     if (is_reset (value, iter, p))
1111       return true;
1112     else if (is_bold (value, iter, p))
1113       {
1114         (*p)++;
1115         *check_values = true;
1116         return false; /* partial escape sequence, need another valid value */
1117       }
1118     else if (is_fg_color (value, p))
1119       return true;
1120     else if (is_bg_color (value, iter, p))
1121       return true;
1122     else
1123       return false;
1124 }
1125
1126 static bool
1127 is_reset (int value, unsigned int iter, const char **p)
1128 {
1129     return (value == 0 && iter == 1 && **p == 'm');
1130 }
1131
1132 static bool
1133 is_bold (int value, unsigned int iter, const char **p)
1134 {
1135     return (value == 1 && iter == 1 && **p == ';');
1136 }
1137
1138 static bool
1139 is_fg_color (int value, const char **p)
1140 {
1141     return (((value >= 30 && value <= 37) || value == 39) && **p == 'm');
1142 }
1143
1144 static bool
1145 is_bg_color (int value, unsigned int iter, const char **p)
1146 {
1147     return (((value >= 40 && value <= 47) || value == 49) && iter == 1 && **p == 'm');
1148 }
1149
1150 #if !DEBUG
1151 static void *
1152 malloc_wrap (size_t size)
1153 {
1154     void *p = malloc (size);
1155     if (!p)
1156       MEM_ALLOC_FAIL ();
1157     return p;
1158 }
1159
1160 static void *
1161 calloc_wrap (size_t nmemb, size_t size)
1162 {
1163     void *p = calloc (nmemb, size);
1164     if (!p)
1165       MEM_ALLOC_FAIL ();
1166     return p;
1167 }
1168
1169 static void *
1170 realloc_wrap (void *ptr, size_t size)
1171 {
1172     void *p = realloc (ptr, size);
1173     if (!p)
1174       MEM_ALLOC_FAIL ();
1175     return p;
1176 }
1177 #else
1178 static void *
1179 malloc_wrap_debug (size_t size, const char *file, unsigned int line)
1180 {
1181     void *p = malloc (size);
1182     if (!p)
1183       MEM_ALLOC_FAIL_DEBUG (file, line);
1184     fprintf (log, "%s: malloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)size, file, line);
1185     return p;
1186 }
1187
1188 static void *
1189 calloc_wrap_debug (size_t nmemb, size_t size, const char *file, unsigned int line)
1190 {
1191     void *p = calloc (nmemb, size);
1192     if (!p)
1193       MEM_ALLOC_FAIL_DEBUG (file, line);
1194     fprintf (log, "%s: calloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)(nmemb * size), file, line);
1195     return p;
1196 }
1197
1198 static void *
1199 realloc_wrap_debug (void *ptr, size_t size, const char *file, unsigned int line)
1200 {
1201     void *p = realloc (ptr, size);
1202     if (!p)
1203       MEM_ALLOC_FAIL_DEBUG (file, line);
1204     fprintf (log, "%s: realloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)size, file, line);
1205     return p;
1206 }
1207 #endif /* !DEBUG */
1208
1209 static void
1210 free_wrap (void **ptr)
1211 {
1212     free (*ptr);
1213     *ptr = NULL;
1214 }
1215
1216 #if !DEBUG
1217 # define do_malloc(len, file, line) malloc_wrap(len)
1218 #else
1219 # define do_malloc(len, file, line) malloc_wrap_debug(len, file, line)
1220 #endif
1221
1222 static char *
1223 strdup_wrap (const char *str, const char *file, unsigned int line)
1224 {
1225     const size_t len = strlen (str) + 1;
1226     char *p = do_malloc (len, file, line);
1227     strncpy (p, str, len);
1228     return p;
1229 }
1230
1231 static char *
1232 str_concat_wrap (const char *str1, const char *str2, const char *file, unsigned int line)
1233 {
1234     const size_t len = strlen (str1) + strlen (str2) + 1;
1235     char *p, *str;
1236
1237     p = str = do_malloc (len, file, line);
1238     strncpy (p, str1, strlen (str1));
1239     p += strlen (str1);
1240     strncpy (p, str2, strlen (str2));
1241     p += strlen (str2);
1242     *p = '\0';
1243
1244     return str;
1245 }
1246
1247 static bool
1248 get_bytes_size (unsigned long bytes, struct bytes_size *bytes_size)
1249 {
1250     const char *unit, units[] = { '0', 'K', 'M', 'G', '\0' };
1251     unsigned long size = bytes;
1252     if (bytes < 1024)
1253       return false;
1254     unit = units;
1255     while (size >= 1024 && *(unit + 1))
1256       {
1257         size /= 1024;
1258         unit++;
1259       }
1260     bytes_size->size = (unsigned int)size;
1261     bytes_size->unit = *unit;
1262     return true;
1263 }
1264
1265 static char *
1266 get_file_type (mode_t mode)
1267 {
1268     if (S_ISREG (mode))
1269       return "file";
1270     else if (S_ISDIR (mode))
1271       return "directory";
1272     else if (S_ISCHR (mode))
1273       return "character device";
1274     else if (S_ISBLK (mode))
1275       return "block device";
1276     else if (S_ISFIFO (mode))
1277       return "named pipe";
1278     else if (S_ISLNK (mode))
1279       return "symbolic link";
1280     else if (S_ISSOCK (mode))
1281       return "socket";
1282     else
1283       return "file";
1284 }
1285
1286 static bool
1287 has_color_name (const char *str, const char *name)
1288 {
1289     char *p;
1290
1291     assert (strlen (str));
1292     assert (strlen (name));
1293
1294     if (!(*str == *name || *str == toupper (*name)))
1295       return false;
1296     else if (*(name + 1) != '\0'
1297      && !((p = strstr (str + 1, name + 1)) && p == str + 1))
1298       return false;
1299
1300     return true;
1301 }
1302
1303 static FILE *
1304 open_file (const char *file, const char *mode)
1305 {
1306     FILE *stream;
1307
1308     errno = 0;
1309     stream = fopen (file, mode);
1310     if (!stream)
1311       vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
1312
1313     return stream;
1314 }
1315
1316 #define DO_VFPRINTF(fmt)                    \
1317     va_list ap;                             \
1318     fprintf (stderr, "%s: ", program_name); \
1319     va_start (ap, fmt);                     \
1320     vfprintf (stderr, fmt, ap);             \
1321     va_end (ap);                            \
1322     fprintf (stderr, "\n");                 \
1323
1324 static void
1325 vfprintf_diag (const char *fmt, ...)
1326 {
1327     DO_VFPRINTF (fmt);
1328 }
1329
1330 static void
1331 vfprintf_fail (const char *fmt, ...)
1332 {
1333     DO_VFPRINTF (fmt);
1334     exit (EXIT_FAILURE);
1335 }
1336
1337 static void
1338 stack_var (void ***list, unsigned int *stacked, unsigned int index, void *ptr)
1339 {
1340     /* nothing to stack */
1341     if (ptr == NULL)
1342       return;
1343     if (!*list)
1344       *list = xmalloc (sizeof (void *));
1345     else
1346       {
1347         unsigned int i;
1348         for (i = 0; i < *stacked; i++)
1349           if (!(*list)[i])
1350             {
1351               (*list)[i] = ptr;
1352               return; /* reused */
1353             }
1354         *list = xrealloc (*list, (*stacked + 1) * sizeof (void *));
1355       }
1356     (*list)[index] = ptr;
1357     (*stacked)++;
1358 }
1359
1360 static void
1361 release_var (void **list, unsigned int stacked, void **ptr)
1362 {
1363     unsigned int i;
1364     /* nothing to release */
1365     if (*ptr == NULL)
1366       return;
1367     for (i = 0; i < stacked; i++)
1368       if (list[i] == *ptr)
1369         {
1370           free (*ptr);
1371           *ptr = NULL;
1372           list[i] = NULL;
1373           return;
1374         }
1375 }