* colorize - Read text from standard input stream or file and print
* it colorized through use of ANSI escape sequences
*
- * Copyright (c) 2011-2015 Steven Schubiger
+ * Copyright (c) 2011-2017 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
*
*/
+#define _DEFAULT_SOURCE
#define _BSD_SOURCE
#define _XOPEN_SOURCE 700
#define _FILE_OFFSET_BITS 64
#define to_str(arg) str(arg)
#define streq(s1, s2) (strcmp (s1, s2) == 0)
+#define strneq(s1, s2, n) (strncmp (s1, s2, n) == 0)
#if !DEBUG
# define xmalloc(size) malloc_wrap(size)
#define ALLOC_COMPLETE_PART_LINE 8
-#define COLOR_SEP_CHAR '/'
+#if defined(COLOR_SEP_CHAR_COLON)
+# define COLOR_SEP_CHAR ':'
+#elif defined(COLOR_SEP_CHAR_SLASH)
+# define COLOR_SEP_CHAR '/'
+#else
+# define COLOR_SEP_CHAR '/'
+#endif
#define DEBUG_FILE "debug.txt"
-#define VERSION "0.57"
+#define MAX_ATTRIBUTE_CHARS (5 * 2)
+
+#define VERSION "0.60"
typedef enum { false, true } bool;
char *orig;
};
-static struct color_name *color_names[3] = { NULL, NULL, NULL };
-
struct color {
const char *name;
const char *code;
"%s: %s: %s", /* type */
};
-enum { FOREGROUND, BACKGROUND };
+enum { GENERIC, FOREGROUND = 0, BACKGROUND };
static const struct {
struct color const *entries;
{ bg_colors, sizeof (bg_colors) / sizeof (struct color), "background" },
};
+enum {
+ OPT_ATTR = 1,
+ OPT_CLEAN,
+ OPT_CLEAN_ALL,
+ OPT_EXCLUDE_RANDOM,
+ OPT_HELP,
+ OPT_VERSION
+};
+static int opt_type;
+static const struct option long_opts[] = {
+ { "attr", required_argument, &opt_type, OPT_ATTR },
+ { "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 },
+ { NULL, 0, NULL, 0 },
+};
+
static FILE *stream;
#if DEBUG
static FILE *log;
static bool clean;
static bool clean_all;
+static char attr[MAX_ATTRIBUTE_CHARS + 1];
static char *exclude;
static const char *program_name;
static void process_opts (int, char **);
+static void process_opt_attr (const char *);
+static void write_attr (unsigned int);
static void print_hint (void);
static void print_help (void);
static void print_version (void);
static void cleanup (void);
static void free_color_names (struct color_name **);
-static void process_args (unsigned int, char **, bool *, const struct color **, const char **, FILE **);
+static void process_args (unsigned int, char **, char *, const struct color **, const char **, FILE **);
static void process_file_arg (const char *, const char **, FILE **);
static void skip_path_colors (const char *, const char *, const struct stat *);
-static void gather_color_names (const char *, bool *, struct color_name **);
-static void read_print_stream (bool, const struct color **, const char *, FILE *);
-static void merge_print_line (bool, const struct color **, const char *, const char *, FILE *);
+static void gather_color_names (const char *, char *, struct color_name **);
+static void read_print_stream (const char *, const struct color **, const char *, FILE *);
+static void merge_print_line (const char *, const char *, FILE *);
static void complete_part_line (const char *, char **, FILE *);
static bool get_next_char (char *, const char **, FILE *, bool *);
-static void save_char (char, char **, unsigned long *, size_t *);
+static void save_char (char, char **, size_t *, size_t *);
static void find_color_entries (struct color_name **, const struct color **);
static void find_color_entry (const struct color_name *, unsigned int, const struct color **);
-static void print_line (bool, const struct color **, const char * const, unsigned int);
+static void print_line (const char *, const struct color **, const char * const, unsigned int);
static void print_clean (const char *);
static bool is_esc (const char *);
static const char *get_end_of_esc (const char *);
static void print_text (const char *, size_t);
static bool gather_esc_offsets (const char *, const char **, const char **);
static bool validate_esc_clean_all (const char **);
-static bool validate_esc_clean (int, unsigned int, const char **, bool *);
+static bool validate_esc_clean (int, unsigned int, unsigned int *, const char **, bool *);
static bool is_reset (int, unsigned int, const char **);
-static bool is_bold (int, unsigned int, const char **);
+static bool is_attr (int, unsigned int, unsigned int, const char **);
static bool is_fg_color (int, const char **);
static bool is_bg_color (int, unsigned int, const char **);
#if !DEBUG
{
unsigned int arg_cnt;
- bool bold = false;
-
const struct color *colors[2] = {
NULL, /* foreground */
NULL, /* background */
log = open_file (DEBUG_FILE, "w");
#endif
+ attr[0] = '\0';
+
process_opts (argc, argv);
arg_cnt = argc - optind;
if (clean || clean_all)
process_file_arg (argv[optind], &file, &stream);
else
- process_args (arg_cnt, &argv[optind], &bold, colors, &file, &stream);
- read_print_stream (bold, colors, file, stream);
+ process_args (arg_cnt, &argv[optind], &attr[0], colors, &file, &stream);
+ read_print_stream (&attr[0], colors, file, stream);
RELEASE_VAR (exclude);
exit (EXIT_SUCCESS);
}
-#define SET_OPT_TYPE(type) \
- opt_type = type; \
- opt = 0; \
- goto PARSE_OPT; \
+#define PRINT_HELP_EXIT() \
+ print_help (); \
+ exit (EXIT_SUCCESS); \
+
+#define PRINT_VERSION_EXIT() \
+ print_version (); \
+ exit (EXIT_SUCCESS); \
extern char *optarg;
-static int opt_type;
static void
process_opts (int argc, char **argv)
{
- enum {
- OPT_CLEAN = 1,
- OPT_CLEAN_ALL,
- OPT_EXCLUDE_RANDOM,
- OPT_HELP,
- OPT_VERSION
- };
-
int opt;
- struct option long_opts[] = {
- { "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 },
- { NULL, 0, NULL, 0 },
- };
-
while ((opt = getopt_long (argc, argv, "hV", long_opts, NULL)) != -1)
{
- PARSE_OPT:
switch (opt)
{
case 0: /* long opts */
switch (opt_type)
{
+ case OPT_ATTR: {
+ char *opt;
+ opt = xstrdup (optarg);
+ process_opt_attr (opt);
+ free (opt);
+ break;
+ }
case OPT_CLEAN:
clean = true;
break;
unsigned int i;
exclude = xstrdup (optarg);
STACK_VAR (exclude);
- for (i = 1; i < tables[FOREGROUND].count - 1; i++) /* skip color none and default */
+ for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */
{
- const struct color *entry = &tables[FOREGROUND].entries[i];
+ const struct color *entry = &tables[GENERIC].entries[i];
if (streq (exclude, entry->name))
{
valid = true;
break;
}
case OPT_HELP:
- print_help ();
- exit (EXIT_SUCCESS);
+ PRINT_HELP_EXIT ();
case OPT_VERSION:
- print_version ();
- exit (EXIT_SUCCESS);
+ PRINT_VERSION_EXIT ();
default: /* never reached */
ABORT_TRACE ();
}
break;
case 'h':
- SET_OPT_TYPE (OPT_HELP);
+ PRINT_HELP_EXIT ();
case 'V':
- SET_OPT_TYPE (OPT_VERSION);
+ PRINT_VERSION_EXIT ();
case '?':
print_hint ();
exit (EXIT_FAILURE);
}
}
+static void
+process_opt_attr (const char *p)
+{
+ while (*p)
+ {
+ const char *s;
+ if (!isalnum (*p))
+ vfprintf_fail (formats[FMT_GENERIC], "--attr switch must be provided a string");
+ s = p;
+ while (isalnum (*p))
+ p++;
+ if (*p != '\0' && *p != ',')
+ vfprintf_fail (formats[FMT_GENERIC], "--attr switch must have strings separated by ,");
+ else
+ {
+ /* If atttributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */
+ if (p - s == 4 && strneq (s, "bold", 4))
+ write_attr (1);
+ else if (p - s == 10 && strneq (s, "underscore", 10))
+ write_attr (4);
+ else if (p - s == 5 && strneq (s, "blink", 5))
+ write_attr (5);
+ else if (p - s == 7 && strneq (s, "reverse", 7))
+ write_attr (7);
+ else if (p - s == 9 && strneq (s, "concealed", 9))
+ write_attr (8);
+ else
+ vfprintf_fail (formats[FMT_GENERIC], "--attr switch must be provided valid attribute names");
+ }
+ if (*p)
+ p++;
+ }
+}
+
+static void
+write_attr (unsigned int val)
+{
+ snprintf (attr + strlen (attr), 3, "%u;", val);
+}
+
static void
print_hint (void)
{
static void
print_help (void)
{
+ struct short_opt {
+ const char *name;
+ const char *short_opt;
+ };
+ const struct short_opt short_opts[] = {
+ { "help", "h" },
+ { "version", "V" },
+ };
+ const struct option *opt = long_opts;
unsigned int i;
printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name, COLOR_SEP_CHAR);
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");
+ for (; opt->name; opt++)
+ {
+ const char *short_opt = NULL;
+ unsigned int i;
+ for (i = 0; i < sizeof (short_opts) / sizeof (struct short_opt); i++)
+ {
+ if (streq (opt->name, short_opts[i].name))
+ {
+ short_opt = short_opts[i].short_opt;
+ break;
+ }
+ }
+ if (short_opt)
+ printf ("\t\t-%s, --%s\n", short_opt, opt->name);
+ else
+ printf ("\t\t --%s\n", opt->name);
+ }
+ printf ("\n");
}
static void
const char *version = NULL;
#endif
const char *version_prefix, *version_string;
- const char *c_flags;
+ const char *c_flags, *ld_flags, *cpp_flags;
struct bytes_size bytes_size;
bool debug;
#ifdef CFLAGS
#else
c_flags = "unknown";
#endif
+#ifdef LDFLAGS
+ ld_flags = to_str (LDFLAGS);
+#else
+ ld_flags = "unknown";
+#endif
+#ifdef CPPFLAGS
+ cpp_flags = to_str (CPPFLAGS);
+#else
+ cpp_flags = "unknown";
+#endif
#if DEBUG
debug = true;
#else
printf ("colorize %s%s (compiled at %s, %s)\n", version_prefix, version_string, __DATE__, __TIME__);
printf ("Compiler flags: %s\n", c_flags);
+ printf ("Linker flags: %s\n", ld_flags);
+ printf ("Preprocessor flags: %s\n", cpp_flags);
if (get_bytes_size (BUF_SIZE, &bytes_size))
{
if (BUF_SIZE % 1024 == 0)
}
else
printf ("Buffer size: %lu byte%s\n", (unsigned long)BUF_SIZE, BUF_SIZE > 1 ? "s" : "");
+ printf ("Color separator: '%c'\n", COLOR_SEP_CHAR);
printf ("Debugging: %s\n", debug ? "yes" : "no");
}
static void
cleanup (void)
{
- free_color_names (color_names);
-
if (stream && fileno (stream) != STDIN_FILENO)
fclose (stream);
#if DEBUG
unsigned int i;
for (i = 0; color_names[i]; i++)
{
- free (color_names[i]->name);
- free (color_names[i]->orig);
- free_null (color_names[i]);
+ RELEASE_VAR (color_names[i]->name);
+ RELEASE_VAR (color_names[i]->orig);
+ RELEASE_VAR (color_names[i]);
}
}
static void
-process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct color **colors, const char **file, FILE **stream)
+process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct color **colors, const char **file, FILE **stream)
{
int ret;
char *p;
struct stat sb;
+ struct color_name *color_names[3] = { NULL, NULL, NULL };
const char *color_string = arg_cnt >= 1 ? arg_strings[0] : NULL;
const char *file_string = arg_cnt == 2 ? arg_strings[1] : NULL;
if (file_string)
vfprintf_fail (formats[FMT_GENERIC], "hyphen cannot be used as color string");
else
- vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceeded by color string");
+ vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceded by color string");
}
ret = lstat (color_string, &sb);
vfprintf_fail (formats[FMT_STRING], "one color pair allowed only for string", color_string);
}
- gather_color_names (color_string, bold, color_names);
+ gather_color_names (color_string, attr, color_names);
assert (color_names[FOREGROUND]);
{
bool matched = false;
unsigned int i;
- for (i = 0; i < tables[FOREGROUND].count; i++)
+ for (i = 0; i < tables[GENERIC].count; i++)
{
- const struct color *entry = &tables[FOREGROUND].entries[i];
+ const struct color *entry = &tables[GENERIC].entries[i];
if (has_color_name (color, entry->name))
{
color += strlen (entry->name);
else
{
if (VALID_FILE_TYPE (mode))
- vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "must be preceeded by color string");
+ vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "must be preceded by color string");
else
vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "is not a valid file type");
}
}
static void
-gather_color_names (const char *color_string, bool *bold, struct color_name **color_names)
+gather_color_names (const char *color_string, char *attr, struct color_name **color_names)
{
unsigned int index;
char *color, *p, *str;
switch (index)
{
case FOREGROUND:
- *bold = true;
+ snprintf (attr + strlen (attr), 3, "1;");
break;
case BACKGROUND:
vfprintf_fail (formats[FMT_COLOR], tables[BACKGROUND].desc, color, "cannot be bold");
}
color_names[index] = xcalloc (1, sizeof (struct color_name));
+ STACK_VAR (color_names[index]);
color_names[index]->orig = xstrdup (color);
+ STACK_VAR (color_names[index]->orig);
for (ch = color; *ch; ch++)
*ch = tolower (*ch);
color_names[index]->name = xstrdup (color);
+ STACK_VAR (color_names[index]->name);
}
RELEASE_VAR (str);
}
static void
-read_print_stream (bool bold, const struct color **colors, const char *file, FILE *stream)
+read_print_stream (const char *attr, const struct color **colors, const char *file, FILE *stream)
{
char buf[BUF_SIZE + 1];
unsigned int flags = 0;
size_t bytes_read;
char *eol;
const char *line;
- memset (buf, '\0', BUF_SIZE + 1);
bytes_read = fread (buf, 1, BUF_SIZE, stream);
if (bytes_read != BUF_SIZE && ferror (stream))
vfprintf_fail (formats[FMT_ERROR], BUF_SIZE, "read");
+ buf[bytes_read] = '\0';
line = buf;
while ((eol = strpbrk (line, "\n\r")))
{
- char *p;
+ const char *p;
flags &= ~(CR|LF);
if (*eol == '\r')
{
vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending");
p = eol + SKIP_LINE_ENDINGS (flags);
*eol = '\0';
- print_line (bold, colors, line, flags);
+ print_line (attr, colors, line, flags);
line = p;
}
if (feof (stream))
{
if (*line != '\0')
- print_line (bold, colors, line, 0);
+ print_line (attr, colors, line, 0);
}
else if (*line != '\0')
{
char *p;
if ((clean || clean_all) && (p = strrchr (line, '\033')))
- merge_print_line (bold, colors, line, p, stream);
+ merge_print_line (line, p, stream);
else
- print_line (bold, colors, line, 0);
+ print_line (attr, colors, line, 0);
}
}
}
static void
-merge_print_line (bool bold, const struct color **colors, const char *line, const char *p, FILE *stream)
+merge_print_line (const char *line, const char *p, FILE *stream)
{
char *buf = NULL;
- char *merged_part_line = NULL;
- const char *part_line;
+ char *merged_esc = NULL;
+ const char *esc = "";
+ const char char_restore = *p;
complete_part_line (p + 1, &buf, stream);
if (buf)
- part_line = merged_part_line = str_concat (line, buf);
- else
- part_line = line;
- free (buf);
+ {
+ /* form escape sequence */
+ esc = merged_esc = str_concat (p, buf);
+ /* shorten partial line accordingly */
+ *(char *)p = '\0';
+ free (buf);
+ }
#ifdef TEST_MERGE_PART_LINE
- printf ("%s", part_line);
- free (merged_part_line);
- exit (EXIT_SUCCESS);
+ printf ("%s%s", line, esc);
+ fflush (stdout);
+ _exit (EXIT_SUCCESS);
#else
- print_line (bold, colors, part_line, 0);
- free (merged_part_line);
+ print_clean (line);
+ *(char *)p = char_restore;
+ print_clean (esc);
+ free (merged_esc);
#endif
}
{
bool got_next_char = false, read_from_stream;
char ch;
- unsigned long i = 0;
- size_t size;
+ size_t i = 0, size;
if (get_next_char (&ch, &p, stream, &read_from_stream))
{
}
static void
-save_char (char ch, char **buf, unsigned long *i, size_t *size)
+save_char (char ch, char **buf, size_t *i, size_t *size)
{
if (!*buf)
{
}
static void
-print_line (bool bold, const struct color **colors, const char *const line, unsigned int flags)
+print_line (const char *attr, const struct color **colors, const char *const line, unsigned int flags)
{
/* --clean[-all] */
if (clean || clean_all)
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);
+ printf ("\033[%s%s%s\033[0m", attr, colors[FOREGROUND]->code, line);
else
printf (formats[FMT_GENERIC], line);
}
if (*p == 27 && *(p + 1) == '[')
{
bool valid = false;
- const char *begin = p;
+ const char *const begin = p;
p += 2;
if (clean_all)
valid = validate_esc_clean_all (&p);
else if (clean)
{
bool check_values;
- unsigned int iter = 0;
+ unsigned int prev_iter, iter;
const char *digit;
+ prev_iter = iter = 0;
do {
check_values = false;
iter++;
val[i] = *digit++;
val[i] = '\0';
value = atoi (val);
- valid = validate_esc_clean (value, iter, &p, &check_values);
+ valid = validate_esc_clean (value, iter, &prev_iter, &p, &check_values);
}
} while (check_values);
}
}
static bool
-validate_esc_clean (int value, unsigned int iter, const char **p, bool *check_values)
+validate_esc_clean (int value, unsigned int iter, unsigned int *prev_iter, const char **p, bool *check_values)
{
if (is_reset (value, iter, p))
return true;
- else if (is_bold (value, iter, p))
+ else if (is_attr (value, iter, *prev_iter, p))
{
(*p)++;
*check_values = true;
+ *prev_iter = iter;
return false; /* partial escape sequence, need another valid value */
}
else if (is_fg_color (value, p))
}
static bool
-is_bold (int value, unsigned int iter, const char **p)
+is_attr (int value, unsigned int iter, unsigned int prev_iter, const char **p)
{
- return (value == 1 && iter == 1 && **p == ';');
+ return ((value > 0 && value < 10) && (iter - prev_iter == 1) && **p == ';');
}
static bool