* colorize - Read text from standard input stream or file and print
* it colorized through use of ANSI escape sequences
*
- * Copyright (c) 2011-2012 Steven Schubiger
+ * Copyright (c) 2011-2013 Steven Schubiger
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <time.h>
#include <unistd.h>
+#ifndef DEBUG
+# define DEBUG 0
+#endif
+
#define str(arg) #arg
#define to_str(arg) str(arg)
#define streq(s1, s2) (strcmp (s1, s2) == 0)
+#if DEBUG
+# define xmalloc(size) malloc_wrap_debug(size, __FILE__, __LINE__)
+# define xcalloc(nmemb, size) calloc_wrap_debug(nmemb, size, __FILE__, __LINE__)
+# define xrealloc(ptr, size) realloc_wrap_debug(ptr, size, __FILE__, __LINE__)
+#else
+# define xmalloc(size) malloc_wrap(size)
+# define xcalloc(nmemb, size) calloc_wrap(nmemb, size)
+# define xrealloc(ptr, size) realloc_wrap(ptr, size)
+#endif
+
+#define free_null(ptr) free_wrap((void **)&ptr)
+#define xstrdup(str) strdup_wrap(str)
+
#if !defined BUF_SIZE || BUF_SIZE <= 0
# undef BUF_SIZE
# define BUF_SIZE 4096 + 1
release_var (vars_list, stacked_vars, (void **)&ptr); \
} while (false);
+#define MEM_ALLOC_FAIL_DEBUG(file, line) do { \
+ fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
+ exit (2); \
+} while (false);
+#define MEM_ALLOC_FAIL() do { \
+ fprintf (stderr, "%s: memory allocation failure\n", program_name); \
+ exit (2); \
+} while (false);
+
#define ABORT_TRACE() \
- fprintf (stderr, "aborting in source file %s, line %d\n", __FILE__, __LINE__); \
+ fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
abort (); \
#define CHECK_COLORS_RANDOM(color1, color2) \
&& (streq (color_names[color2]->name, "none") \
|| streq (color_names[color2]->name, "default")) \
-#define VERSION "0.47"
+#define COLOR_SEP_CHAR '/'
+
+#define VERSION "0.50"
typedef unsigned short bool;
"%s", /* generic */
"%s color '%s' %s", /* color */
"%s color '%s' %s '%s'", /* random */
- "less than %d bytes %s", /* error */
+ "less than %u bytes %s", /* error */
"%s: %s", /* file */
};
{ bg_colors, sizeof (bg_colors) / sizeof (struct color), "background" },
};
-enum stream_mode { SCAN_FIRST = 1, SCAN_ALWAYS };
-
-struct ending {
- unsigned int flags;
- const char newline[3];
-};
-
-static const struct ending endings[] = {
- { CR & LF, "\r\n" },
- { CR, "\r" },
- { LF, "\n" },
-};
-
static FILE *stream = NULL;
static unsigned int stacked_vars = 0;
static void **vars_list = NULL;
+static bool clean = false;
+static bool clean_all = false;
+
static char *exclude = NULL;
static const char *program_name;
static void cleanup (void);
static void free_color_names (struct color_name **);
static void process_options (unsigned int, char **, bool *, const struct color **, const char **, FILE **);
-static void read_print_stream (bool, const struct color **, const char *, FILE *, enum stream_mode);
+static void process_file_option (const char *, const char **, FILE **);
+static void read_print_stream (bool, const struct color **, const char *, FILE *);
static void find_color_entries (struct color_name **, const struct color **);
static void find_color_entry (const char *const, unsigned int, const struct color **);
static void print_line (const struct color **, bool, const char * const, unsigned int);
-static char *xstrdup (const char *);
+static void print_clean (const char *);
+static void print_free_offsets (const char *, char ***, unsigned int);
+static void *malloc_wrap (size_t);
+static void *calloc_wrap (size_t, size_t);
+static void *realloc_wrap (void *, size_t);
+static void *malloc_wrap_debug (size_t, const char *, unsigned int);
+static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
+static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
+static void free_wrap (void **);
+static char *strdup_wrap (const char *);
+static char *str_concat (const char *, const char *);
static void vfprintf_fail (const char *, ...);
static void stack_var (void ***, unsigned int *, unsigned int, void *);
static void release_var (void **, unsigned int, void **);
+#define SET_OPT_TYPE(type) \
+ opt_type = type; \
+ opt = 0; \
+ goto PARSE_OPT; \
+
extern char *optarg;
extern int optind;
{
unsigned int arg_cnt = 0;
- bool invalid_opt = false;
+ enum {
+ OPT_CLEAN = 1,
+ OPT_CLEAN_ALL,
+ OPT_EXCLUDE_RANDOM,
+ OPT_HELP,
+ OPT_VERSION
+ };
- int opt;
+ int opt, opt_type = 0;
struct option long_opts[] = {
- { "exclude-random", required_argument, NULL, 'e' },
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { 0, 0, 0, 0 },
+ { "clean", no_argument, &opt_type, OPT_CLEAN },
+ { "clean-all", no_argument, &opt_type, OPT_CLEAN_ALL },
+ { "exclude-random", required_argument, &opt_type, OPT_EXCLUDE_RANDOM },
+ { "help", no_argument, &opt_type, OPT_HELP },
+ { "version", no_argument, &opt_type, OPT_VERSION },
+ { 0, 0, 0, 0 },
};
bool bold = false;
const char *file;
- enum stream_mode mode = SCAN_FIRST;
-
program_name = argv[0];
atexit (cleanup);
while ((opt = getopt_long (argc, argv, "hv", long_opts, NULL)) != -1)
{
+ PARSE_OPT:
switch (opt)
{
- case 'e': {
- char *p;
- exclude = xstrdup (optarg);
- STACK_VAR (exclude);
- for (p = exclude; *p; p++)
- *p = tolower (*p);
- if (streq (exclude, "random"))
- vfprintf_fail (formats[FMT_GENERIC], "--exclude-random switch must be provided a color");
+ case 0: /* long opts */
+ switch (opt_type)
+ {
+ case OPT_CLEAN:
+ clean = true;
+ break;
+ case OPT_CLEAN_ALL:
+ clean_all = true;
+ break;
+ case OPT_EXCLUDE_RANDOM: {
+ char *p;
+ exclude = xstrdup (optarg);
+ STACK_VAR (exclude);
+ for (p = exclude; *p; p++)
+ *p = tolower (*p);
+ if (streq (exclude, "random"))
+ vfprintf_fail (formats[FMT_GENERIC], "--exclude-random switch must be provided a color");
+ break;
+ }
+ case OPT_HELP:
+ print_help ();
+ exit (EXIT_SUCCESS);
+ case OPT_VERSION:
+ print_version ();
+ exit (EXIT_SUCCESS);
+ default: /* never reached */
+ ABORT_TRACE ();
+ }
break;
- }
case 'h':
- print_help ();
- exit (EXIT_SUCCESS);
+ SET_OPT_TYPE (OPT_HELP);
case 'v':
- print_version ();
- exit (EXIT_SUCCESS);
+ SET_OPT_TYPE (OPT_VERSION);
case '?':
- invalid_opt = true;
- break;
+ print_help ();
+ exit (EXIT_FAILURE);
default: /* never reached */
ABORT_TRACE ();
}
arg_cnt = argc - optind;
- if (arg_cnt == 0 || arg_cnt > 2 || invalid_opt)
+ if (clean || clean_all)
{
- print_help ();
- exit (EXIT_FAILURE);
+ if (clean && clean_all)
+ vfprintf_fail (formats[FMT_GENERIC], "--clean and --clean-all switch are mutually exclusive");
+ if (arg_cnt > 1)
+ {
+ const char *format = "%s %s";
+ const char *message = "switch cannot be used with more than one file";
+ if (clean)
+ vfprintf_fail (format, "--clean", message);
+ else if (clean_all)
+ vfprintf_fail (format, "--clean-all", message);
+ }
+ }
+ else
+ {
+ if (arg_cnt == 0 || arg_cnt > 2)
+ {
+ print_help ();
+ exit (EXIT_FAILURE);
+ }
}
- process_options (arg_cnt, &argv[optind], &bold, colors, &file, &stream);
- read_print_stream (bold, colors, file, stream, mode);
+ if (clean || clean_all)
+ process_file_option (argv[optind], &file, &stream);
+ else
+ process_options (arg_cnt, &argv[optind], &bold, colors, &file, &stream);
+ read_print_stream (bold, colors, file, stream);
RELEASE_VAR (exclude);
{
unsigned int i;
- printf ("Usage: %s (foreground) OR (foreground)/(background) [-|file]\n\n", program_name);
+ printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name, COLOR_SEP_CHAR);
printf ("\tColors (foreground) (background)\n");
for (i = 0; i < tables[FOREGROUND].count; i++)
{
printf ("\twhereas for lower case colors will be of normal intensity.\n");
printf ("\n\tOptions\n");
+ printf ("\t\t --clean\n");
+ printf ("\t\t --clean-all\n");
+ printf ("\t\t --exclude-random\n");
printf ("\t\t-h, --help\n");
printf ("\t\t-v, --version\n\n");
}
c_flags = "unknown";
#endif
printf ("Compiler flags: %s\n", c_flags);
- printf ("Buffer size: %d bytes\n", BUF_SIZE - 1);
+ printf ("Buffer size: %u bytes\n", BUF_SIZE - 1);
}
static void
unsigned int i;
for (i = 0; i < stacked_vars; i++)
if (vars_list[i])
- {
- free (vars_list[i]);
- vars_list[i] = NULL;
- }
- free (vars_list);
- vars_list = NULL;
+ free_null (vars_list[i]);
+
+ free_null (vars_list);
}
}
unsigned int i;
for (i = 0; color_names[i]; i++)
{
- free (color_names[i]->name);
- color_names[i]->name = NULL;
- free (color_names[i]->orig);
- color_names[i]->orig = NULL;
- free (color_names[i]);
- color_names[i] = NULL;
+ free_null (color_names[i]->name);
+ free_null (color_names[i]->orig);
+ free_null (color_names[i]);
}
}
break;
}
}
- if (matched && *color == '/' && *(color + 1))
+ if (matched && *color == COLOR_SEP_CHAR && *(color + 1))
color++;
else
break;
have_file = (*color != '\0');
if (have_file)
- vfprintf_fail (formats[FMT_GENERIC], "file must be preceeded by color string");
+ {
+ if (file_string)
+ vfprintf_fail (formats[FMT_GENERIC], "file cannot be used as color string");
+ else
+ vfprintf_fail (formats[FMT_GENERIC], "file must be preceeded by color string");
+ }
}
- if ((p = strchr (color_string, '/')))
+ if ((p = strchr (color_string, COLOR_SEP_CHAR)))
{
if (p == color_string)
vfprintf_fail (formats[FMT_GENERIC], "foreground color missing");
else if (p == color_string + strlen (color_string) - 1)
vfprintf_fail (formats[FMT_GENERIC], "background color missing");
- else if (strchr (++p, '/'))
+ else if (strchr (++p, COLOR_SEP_CHAR))
vfprintf_fail (formats[FMT_GENERIC], "one color pair allowed only");
}
for (index = 0, color = str; *color; index++, color = p)
{
char *ch, *sep;
- if ((sep = strchr (color, '/')))
+ if ((sep = strchr (color, COLOR_SEP_CHAR)))
{
*sep = '\0';
p = sep + 1;
}
}
- color_names[index] = malloc (sizeof (struct color_name));
+ color_names[index] = xcalloc (1, sizeof (struct color_name));
color_names[index]->orig = xstrdup (color);
if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code)
find_color_entry ("default", FOREGROUND, colors);
+ process_file_option (file_string, file, stream);
+}
+
+static void
+process_file_option (const char *file_string, const char **file, FILE **stream)
+{
if (file_string)
{
if (streq (file_string, "-"))
assert (*stream);
}
+#define MERGE_PRINT_LINE(part_line, line, flags, check_eof) do { \
+ char *current_line, *merged_line = NULL; \
+ if (part_line) \
+ { \
+ merged_line = str_concat (part_line, line); \
+ free_null (part_line); \
+ } \
+ current_line = merged_line ? merged_line : (char *)line; \
+ if (!check_eof || *current_line != '\0') \
+ print_line (colors, bold, current_line, flags); \
+ free (merged_line); \
+} while (false);
+
static void
-read_print_stream (bool bold, const struct color **colors, const char *file, FILE *stream, enum stream_mode mode)
+read_print_stream (bool bold, const struct color **colors, const char *file, FILE *stream)
{
- char buf[BUF_SIZE];
+ char buf[BUF_SIZE], *part_line = NULL;
unsigned int flags = 0;
- bool first = false, always = false;
-
- switch (mode)
- {
- case SCAN_FIRST:
- first = true;
- break;
- case SCAN_ALWAYS:
- always = true;
- break;
- default: /* never reached */
- ABORT_TRACE ();
- }
while (!feof (stream))
{
if (bytes_read != (BUF_SIZE - 1) && ferror (stream))
vfprintf_fail (formats[FMT_ERROR], BUF_SIZE - 1, "read");
line = buf;
- LOOP: while ((eol = strpbrk (line, "\n\r")))
+ while ((eol = strpbrk (line, "\n\r")))
{
char *p;
- if (first || always)
+ flags &= ~(CR|LF);
+ if (*eol == '\r')
{
- first = false;
- flags &= ~(CR|LF);
- if (*eol == '\r')
- {
- flags |= CR;
- if (*(eol + 1) == '\n')
- flags |= LF;
- }
- else if (*eol == '\n')
+ flags |= CR;
+ if (*(eol + 1) == '\n')
flags |= LF;
- else
- vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending");
- }
- if (always)
- p = eol + SKIP_LINE_ENDINGS (flags);
- else /* first */
- {
- unsigned int i;
- unsigned int count = sizeof (endings) / sizeof (struct ending);
- for (i = 0; i < count; i++)
- {
- if (flags & endings[i].flags)
- {
- char *p;
- if ((p = strstr (eol, endings[i].newline)) && p == eol)
- break;
- else
- {
- always = true;
- goto LOOP;
- }
- }
- }
- p = eol + SKIP_LINE_ENDINGS (flags);
}
+ else if (*eol == '\n')
+ flags |= LF;
+ else
+ vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending");
+ p = eol + SKIP_LINE_ENDINGS (flags);
*eol = '\0';
- print_line (colors, bold, line, flags);
+ MERGE_PRINT_LINE (part_line, line, flags, false);
line = p;
}
- print_line (colors, bold, line, 0);
+ if (feof (stream)) {
+ MERGE_PRINT_LINE (part_line, line, 0, true);
+ }
+ else if (*line != '\0')
+ {
+ if (!clean && !clean_all) /* efficiency */
+ print_line (colors, bold, line, 0);
+ else if (!part_line)
+ part_line = xstrdup (line);
+ else
+ {
+ char *merged_line = str_concat (part_line, line);
+ free (part_line);
+ part_line = merged_line;
+ }
+ }
}
}
static void
print_line (const struct color **colors, bool bold, const char *const line, unsigned int flags)
{
- if (colors[BACKGROUND] && colors[BACKGROUND]->code)
- printf ("\033[%s", colors[BACKGROUND]->code);
- if (colors[FOREGROUND]->code)
- printf ("\033[%s%s%s\033[0m", bold ? "1;" : "", colors[FOREGROUND]->code, line);
+ /* --clean[-all] */
+ if (clean || clean_all)
+ print_clean (line);
else
- printf (formats[FMT_GENERIC], line);
+ {
+ /* Foreground color code is guaranteed to be set when background color code is present. */
+ if (colors[BACKGROUND] && colors[BACKGROUND]->code)
+ printf ("\033[%s", colors[BACKGROUND]->code);
+ if (colors[FOREGROUND]->code)
+ printf ("\033[%s%s%s\033[0m", bold ? "1;" : "", colors[FOREGROUND]->code, line);
+ else
+ printf (formats[FMT_GENERIC], line);
+ }
if (flags & CR)
putchar ('\r');
if (flags & LF)
putchar ('\n');
}
+static void
+print_clean (const char *line)
+{
+ const char *p;
+ char ***offsets = NULL;
+ unsigned int count = 0, i = 0;
+
+ for (p = line; *p;)
+ {
+ /* ESC[ */
+ if (*p == 27 && *(p + 1) == '[')
+ {
+ const char *begin = p;
+ p += 2;
+ if (clean_all)
+ {
+ while (isdigit (*p) || *p == ';')
+ p++;
+ }
+ else if (clean)
+ {
+ bool check_values;
+ unsigned int iter = 0;
+ const char *digit;
+ do {
+ check_values = false;
+ iter++;
+ if (!isdigit (*p))
+ goto DISCARD;
+ digit = p;
+ while (isdigit (*p))
+ p++;
+ if (p - digit > 2)
+ goto DISCARD;
+ else /* check range */
+ {
+ char val[3];
+ int value;
+ unsigned int i;
+ const unsigned int digits = p - digit;
+ for (i = 0; i < digits; i++)
+ val[i] = *digit++;
+ val[i] = '\0';
+ value = atoi (val);
+ if (value == 0) /* reset */
+ {
+ if (iter > 1)
+ goto DISCARD;
+ goto END;
+ }
+ else if (value == 1) /* bold */
+ {
+ bool discard = false;
+ if (iter > 1)
+ discard = true;
+ else if (*p != ';')
+ discard = true;
+ if (discard)
+ goto DISCARD;
+ p++;
+ check_values = true;
+ }
+ else if ((value >= 30 && value <= 37) || value == 39) /* foreground colors */
+ goto END;
+ else if ((value >= 40 && value <= 47) || value == 49) /* background colors */
+ {
+ if (iter > 1)
+ goto DISCARD;
+ goto END;
+ }
+ else
+ goto DISCARD;
+ }
+ } while (iter == 1 && check_values);
+ }
+ END: if (*p == 'm')
+ {
+ const char *end = p++;
+ if (!offsets)
+ offsets = xmalloc (++count * sizeof (char **));
+ else
+ offsets = xrealloc (offsets, ++count * sizeof (char **));
+ offsets[i] = xmalloc (2 * sizeof (char *));
+ offsets[i][0] = (char *)begin; /* ESC */
+ offsets[i][1] = (char *)end; /* m */
+ i++;
+ continue;
+ }
+ DISCARD:
+ continue;
+ }
+ p++;
+ }
+
+ if (offsets)
+ print_free_offsets (line, offsets, count);
+ else
+ printf (formats[FMT_GENERIC], line);
+}
+
+#define SET_CHAR(offset, new, old) \
+ *old = *offset; \
+ *offset = new; \
+
+#define RESTORE_CHAR(offset, old) \
+ *offset = old; \
+
+static void
+print_free_offsets (const char *line, char ***offsets, unsigned int count)
+{
+ char ch;
+ unsigned int i;
+
+ SET_CHAR (offsets[0][0], '\0', &ch);
+ printf (formats[FMT_GENERIC], line);
+ RESTORE_CHAR (offsets[0][0], ch);
+
+ for (i = 0; i < count; i++)
+ {
+ char ch;
+ bool next_offset = false;
+ if (i + 1 < count)
+ {
+ SET_CHAR (offsets[i + 1][0], '\0', &ch);
+ next_offset = true;
+ }
+ printf (formats[FMT_GENERIC], offsets[i][1] + 1);
+ if (next_offset)
+ RESTORE_CHAR (offsets[i + 1][0], ch);
+ }
+ for (i = 0; i < count; i++)
+ free_null (offsets[i]);
+ free_null (offsets);
+}
+
+static void *
+malloc_wrap (size_t size)
+{
+ void *p = malloc (size);
+ if (!p)
+ MEM_ALLOC_FAIL ();
+ return p;
+}
+
+static void *
+calloc_wrap (size_t nmemb, size_t size)
+{
+ void *p = calloc (nmemb, size);
+ if (!p)
+ MEM_ALLOC_FAIL ();
+ return p;
+}
+
+static void *
+realloc_wrap (void *ptr, size_t size)
+{
+ void *p = realloc (ptr, size);
+ if (!p)
+ MEM_ALLOC_FAIL ();
+ return p;
+}
+
+static void *
+malloc_wrap_debug (size_t size, const char *file, unsigned int line)
+{
+ void *p = malloc (size);
+ if (!p)
+ MEM_ALLOC_FAIL_DEBUG (file, line);
+ return p;
+}
+
+static void *
+calloc_wrap_debug (size_t nmemb, size_t size, const char *file, unsigned int line)
+{
+ void *p = calloc (nmemb, size);
+ if (!p)
+ MEM_ALLOC_FAIL_DEBUG (file, line);
+ return p;
+}
+
+static void *
+realloc_wrap_debug (void *ptr, size_t size, const char *file, unsigned int line)
+{
+ void *p = realloc (ptr, size);
+ if (!p)
+ MEM_ALLOC_FAIL_DEBUG (file, line);
+ return p;
+}
+
+static void
+free_wrap (void **ptr)
+{
+ free (*ptr);
+ *ptr = NULL;
+}
+
static char *
-xstrdup (const char *str)
+strdup_wrap (const char *str)
{
- const unsigned int len = strlen (str) + 1;
- char *p = malloc (len);
- assert (p != NULL);
+ const size_t len = strlen (str) + 1;
+ char *p = xmalloc (len);
strncpy (p, str, len);
return p;
}
+static char *
+str_concat (const char *str1, const char *str2)
+{
+ const size_t len = strlen (str1) + strlen (str2) + 1;
+ char *p, *str;
+
+ p = str = xmalloc (len);
+ strncpy (p, str1, strlen (str1));
+ p += strlen (str1);
+ strncpy (p, str2, strlen (str2));
+ p += strlen (str2);
+ *p = '\0';
+
+ return str;
+}
+
static void
vfprintf_fail (const char *fmt, ...)
{
if (ptr == NULL)
return;
if (!*list)
- *list = malloc (sizeof (void *));
+ *list = xmalloc (sizeof (void *));
else
{
unsigned int i;
(*list)[i] = ptr;
return; /* reused */
}
- *list = realloc (*list, (*stacked + 1) * sizeof (void *));
+ *list = xrealloc (*list, (*stacked + 1) * sizeof (void *));
}
(*list)[index] = ptr;
(*stacked)++;