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