* 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 LF 0x01
#define CR 0x02
-#define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1)
+#define SKIP_LINE_ENDINGS(flags) ((flags) == (CR|LF) ? 2 : 1)
#define VALID_FILE_TYPE(mode) (S_ISREG (mode) || S_ISLNK (mode) || S_ISFIFO (mode))
# define COLOR_SEP_CHAR '/'
#endif
-#define DEBUG_FILE "debug.txt"
+#if DEBUG
+# define DEBUG_FILE "debug.txt"
+#endif
-#define VERSION "0.57"
+#define MAX_ATTRIBUTE_CHARS (6 * 2)
+
+#define VERSION "0.63"
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;
char unit;
};
-enum fmts {
+enum {
FMT_GENERIC,
FMT_STRING,
FMT_QUOTE,
"%s: %s: %s", /* type */
};
-enum { FOREGROUND, BACKGROUND };
+enum { GENERIC, FOREGROUND = 0, BACKGROUND };
static const struct {
- struct color const *entries;
+ const struct color *entries;
unsigned int count;
const char *desc;
} tables[] = {
{ 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 },
+};
+
+enum attr_type {
+ ATTR_BOLD = 0x01,
+ ATTR_UNDERSCORE = 0x02,
+ ATTR_BLINK = 0x04,
+ ATTR_REVERSE = 0x08,
+ ATTR_CONCEALED = 0x10
+};
+struct attr {
+ const char *name;
+ unsigned int val;
+ enum attr_type type;
+};
+
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 (const struct 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 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 **, 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:
+ process_opt_attr (optarg);
+ 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)
+{
+ /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */
+ const struct attr attrs[] = {
+ { "bold", 1, ATTR_BOLD },
+ { "underscore", 4, ATTR_UNDERSCORE },
+ { "blink", 5, ATTR_BLINK },
+ { "reverse", 7, ATTR_REVERSE },
+ { "concealed", 8, ATTR_CONCEALED },
+ };
+ unsigned int attr_types = 0;
+
+ 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
+ {
+ bool valid_attr = false;
+ unsigned int i;
+ for (i = 0; i < sizeof (attrs) / sizeof (struct attr); i++)
+ {
+ const size_t name_len = strlen (attrs[i].name);
+ if ((size_t)(p - s) == name_len && strneq (s, attrs[i].name, name_len))
+ {
+ write_attr (&attrs[i], &attr_types);
+ valid_attr = true;
+ break;
+ }
+ }
+ if (!valid_attr)
+ {
+ char *attr_invalid = xmalloc ((p - s) + 1);
+ STACK_VAR (attr_invalid);
+ strncpy (attr_invalid, s, p - s);
+ attr_invalid[p - s] = '\0';
+ vfprintf_fail ("--attr switch attribute '%s' is not valid", attr_invalid);
+ RELEASE_VAR (attr_invalid); /* never reached */
+ }
+ }
+ if (*p)
+ p++;
+ }
+}
+
+static void
+write_attr (const struct attr *attr_i, unsigned int *attr_types)
+{
+ const unsigned int val = attr_i->val;
+ const enum attr_type attr_type = attr_i->type;
+ const char *attr_name = attr_i->name;
+
+ if (*attr_types & attr_type)
+ vfprintf_fail ("--attr switch has attribute '%s' twice or more", attr_name);
+ snprintf (attr + strlen (attr), 3, "%u;", val);
+ *attr_types |= attr_type;
+}
+
static void
print_hint (void)
{
static void
print_help (void)
{
+ struct opt_data {
+ const char *name;
+ const char *short_opt;
+ const char *arg;
+ };
+ const struct opt_data opts_data[] = {
+ { "attr", NULL, "=ATTR1,ATTR2,..." },
+ { "exclude-random", NULL, "=COLOR" },
+ { "help", "h", NULL },
+ { "version", "V", NULL },
+ };
+ 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 struct opt_data *opt_data = NULL;
+ unsigned int i;
+ for (i = 0; i < sizeof (opts_data) / sizeof (struct opt_data); i++)
+ if (streq (opt->name, opts_data[i].name))
+ {
+ opt_data = &opts_data[i];
+ break;
+ }
+ if (opt_data)
+ {
+ if (opt_data->short_opt)
+ printf ("\t\t-%s, --%s\n", opt_data->short_opt, opt->name);
+ else
+ printf ("\t\t --%s%s\n", opt->name, opt_data->arg);
+ }
+ 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;
+ const char *const desc_flags_unknown = "unknown";
struct bytes_size bytes_size;
bool debug;
#ifdef CFLAGS
c_flags = to_str (CFLAGS);
#else
- c_flags = "unknown";
+ c_flags = desc_flags_unknown;
+#endif
+#ifdef LDFLAGS
+ ld_flags = to_str (LDFLAGS);
+#else
+ ld_flags = desc_flags_unknown;
+#endif
+#ifdef CPPFLAGS
+ cpp_flags = to_str (CPPFLAGS);
+#else
+ cpp_flags = desc_flags_unknown;
#endif
#if DEBUG
debug = true;
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)
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;
- assert (color_string);
+ assert (color_string != NULL);
if (streq (color_string, "-"))
{
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]);
+ assert (color_names[FOREGROUND] != NULL);
if (color_names[BACKGROUND])
{
}
find_color_entries (color_names, colors);
+ assert (colors[FOREGROUND] != NULL);
free_color_names (color_names);
if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code)
color_name.name = color_name.orig = "default";
find_color_entry (&color_name, FOREGROUND, colors);
+ assert (colors[FOREGROUND]->code != NULL);
}
process_file_arg (file_string, file, stream);
*file = "stdin";
}
- assert (*stream);
- assert (*file);
+ assert (*stream != NULL);
+ assert (*file != NULL);
}
static void
{
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);
if (have_file)
{
- const char *file_exists = color_string;
+ const char *file_existing = color_string;
if (file_string)
- vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "cannot be used as color string");
+ vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "cannot be used as color string");
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_existing, "must be preceded by color string");
else
- vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "is not a valid file type");
+ vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "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;
}
else
p = color + strlen (color);
- assert (p);
+ assert (p != NULL);
for (ch = color; *ch; ch++)
if (!isalpha (*ch))
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')
{
if ((clean || clean_all) && (p = strrchr (line, '\033')))
merge_print_line (line, p, stream);
else
- print_line (bold, colors, line, 0);
+ print_line (attr, colors, line, 0);
}
}
}
if (read_from_stream)
save_char (ch, buf, &i, &size);
}
- else /* read next character */
+ else /* got next character */
{
got_next_char = true;
break;
}
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
{
char *p;
- assert (strlen (str));
- assert (strlen (name));
+ assert (strlen (str) > 0);
+ assert (strlen (name) > 0);
if (!(*str == *name || *str == toupper (*name)))
return false;
projects / colorize.git / blobdiff