X-Git-Url: http://git.refcnt.org/?a=blobdiff_plain;f=colorize.c;h=59cab41c7ae8ae911d337431b9db08470ebbf1cc;hb=f7129232181024d51c0ea234a49e3525c464e3d6;hp=0cfbaad0862809baf37a7e3a0037748e557d87f8;hpb=eaa41b9e9f0bc54518efb56afb3bac671dbe2aba;p=colorize.git diff --git a/colorize.c b/colorize.c index 0cfbaad..59cab41 100644 --- a/colorize.c +++ b/colorize.c @@ -2,7 +2,7 @@ * colorize - Read text from standard input stream or file and print * it colorized through use of ANSI escape sequences * - * Copyright (c) 2011-2017 Steven Schubiger + * Copyright (c) 2011-2018 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 @@ -73,7 +73,9 @@ #define LF 0x01 #define CR 0x02 -#define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1) +#define COUNT_OF(obj, type) (sizeof (obj) / sizeof (type)) + +#define SKIP_LINE_ENDINGS(flags) ((flags) == (CR|LF) ? 2 : 1) #define VALID_FILE_TYPE(mode) (S_ISREG (mode) || S_ISLNK (mode) || S_ISFIFO (mode)) @@ -99,12 +101,12 @@ #define ABORT_TRACE() \ fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \ - abort (); \ + abort (); #define CHECK_COLORS_RANDOM(color1, color2) \ streq (color_names[color1]->name, "random") \ && (streq (color_names[color2]->name, "none") \ - || streq (color_names[color2]->name, "default")) \ + || streq (color_names[color2]->name, "default")) #define ALLOC_COMPLETE_PART_LINE 8 @@ -116,11 +118,15 @@ # define COLOR_SEP_CHAR '/' #endif -#define DEBUG_FILE "debug.txt" +#if DEBUG +# define DEBUG_FILE "debug.txt" +#endif + +#define MAX_ATTRIBUTE_CHARS (6 * 2) -#define MAX_ATTRIBUTE_CHARS (5 * 2) +#define PROGRAM_NAME "colorize" -#define VERSION "0.60" +#define VERSION "0.64" typedef enum { false, true } bool; @@ -164,7 +170,7 @@ struct bytes_size { char unit; }; -enum fmts { +enum { FMT_GENERIC, FMT_STRING, FMT_QUOTE, @@ -188,12 +194,12 @@ static const char *formats[] = { enum { GENERIC, FOREGROUND = 0, BACKGROUND }; static const struct { - struct color const *entries; + const struct color *entries; unsigned int count; const char *desc; } tables[] = { - { fg_colors, sizeof (fg_colors) / sizeof (struct color), "foreground" }, - { bg_colors, sizeof (bg_colors) / sizeof (struct color), "background" }, + { fg_colors, COUNT_OF (fg_colors, struct color), "foreground" }, + { bg_colors, COUNT_OF (bg_colors, struct color), "background" }, }; enum { @@ -201,18 +207,33 @@ enum { OPT_CLEAN, OPT_CLEAN_ALL, OPT_EXCLUDE_RANDOM, + OPT_OMIT_COLOR_EMPTY, 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 }, + { "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 }, + { "omit-color-empty", no_argument, &opt_type, OPT_OMIT_COLOR_EMPTY }, + { "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; @@ -225,15 +246,17 @@ static void **vars_list; static bool clean; static bool clean_all; +static bool omit_color_empty; static char attr[MAX_ATTRIBUTE_CHARS + 1]; static char *exclude; static const char *program_name; +static void print_tstamp (FILE *); static void process_opts (int, char **); static void process_opt_attr (const char *); -static void write_attr (unsigned int); +static void write_attr (const struct attr *, unsigned int *); static void print_hint (void); static void print_help (void); static void print_version (void); @@ -250,7 +273,7 @@ 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 (const char *, const struct color **, const char * const, unsigned int); +static void print_line (const char *, const struct color **, const char * const, unsigned int, bool); static void print_clean (const char *); static bool is_esc (const char *); static const char *get_end_of_esc (const char *); @@ -305,6 +328,7 @@ main (int argc, char **argv) #if DEBUG log = open_file (DEBUG_FILE, "w"); + print_tstamp (log); #endif attr[0] = '\0'; @@ -319,8 +343,8 @@ main (int argc, char **argv) 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"; + const char *const format = "%s %s"; + const char *const message = "switch cannot be used with more than one file"; if (clean) vfprintf_fail (format, "--clean", message); else if (clean_all) @@ -348,13 +372,38 @@ main (int argc, char **argv) exit (EXIT_SUCCESS); } +static void +print_tstamp (FILE *log) +{ + time_t t; + struct tm *tm; + char str[128]; + size_t written; + + t = time (NULL); + tm = localtime (&t); + if (tm == NULL) + { + perror ("localtime"); + exit (EXIT_FAILURE); + } + written = strftime (str, sizeof (str), "%Y-%m-%d %H:%M:%S %Z", tm); + if (written == 0) + vfprintf_fail (formats[FMT_GENERIC], "strftime: 0 returned"); + + fprintf (log, "%s\n", str); + while (written--) + fprintf (log, "="); + fprintf (log, "\n"); +} + #define PRINT_HELP_EXIT() \ print_help (); \ - exit (EXIT_SUCCESS); \ + exit (EXIT_SUCCESS); #define PRINT_VERSION_EXIT() \ print_version (); \ - exit (EXIT_SUCCESS); \ + exit (EXIT_SUCCESS); extern char *optarg; @@ -369,13 +418,9 @@ process_opts (int argc, char **argv) case 0: /* long opts */ switch (opt_type) { - case OPT_ATTR: { - char *opt; - opt = xstrdup (optarg); - process_opt_attr (opt); - free (opt); + case OPT_ATTR: + process_opt_attr (optarg); break; - } case OPT_CLEAN: clean = true; break; @@ -400,6 +445,9 @@ process_opts (int argc, char **argv) vfprintf_fail (formats[FMT_GENERIC], "--exclude-random switch must be provided a plain color"); break; } + case OPT_OMIT_COLOR_EMPTY: + omit_color_empty = true; + break; case OPT_HELP: PRINT_HELP_EXIT (); case OPT_VERSION: @@ -424,6 +472,16 @@ process_opts (int argc, char **argv) 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; @@ -436,19 +494,27 @@ process_opt_attr (const char *p) vfprintf_fail (formats[FMT_GENERIC], "--attr switch must have strings separated by ,"); else { - /* If attributes 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"); + bool valid_attr = false; + unsigned int i; + for (i = 0; i < COUNT_OF (attrs, 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++; @@ -456,9 +522,16 @@ process_opt_attr (const char *p) } static void -write_attr (unsigned int val) +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 @@ -470,13 +543,16 @@ print_hint (void) static void print_help (void) { - struct short_opt { + struct opt_data { const char *name; const char *short_opt; + const char *arg; }; - const struct short_opt short_opts[] = { - { "help", "h" }, - { "version", "V" }, + 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; @@ -502,18 +578,21 @@ print_help (void) printf ("\n\tOptions\n"); for (; opt->name; opt++) { - const char *short_opt = NULL; + const struct opt_data *opt_data = NULL; unsigned int i; - for (i = 0; i < sizeof (short_opts) / sizeof (struct short_opt); i++) + for (i = 0; i < COUNT_OF (opts_data, struct opt_data); i++) + if (streq (opt->name, opts_data[i].name)) + { + opt_data = &opts_data[i]; + break; + } + if (opt_data) { - if (streq (opt->name, short_opts[i].name)) - { - short_opt = short_opts[i].short_opt; - break; - } + 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); } - if (short_opt) - printf ("\t\t-%s, --%s\n", short_opt, opt->name); else printf ("\t\t --%s\n", opt->name); } @@ -526,26 +605,27 @@ print_version (void) #ifdef HAVE_VERSION # include "version.h" #else - const char *version = NULL; + const char *const version = NULL; #endif const char *version_prefix, *version_string; 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 = "unknown"; + ld_flags = desc_flags_unknown; #endif #ifdef CPPFLAGS cpp_flags = to_str (CPPFLAGS); #else - cpp_flags = "unknown"; + cpp_flags = desc_flags_unknown; #endif #if DEBUG debug = true; @@ -554,7 +634,7 @@ print_version (void) #endif version_prefix = version ? "" : "v"; version_string = version ? version : VERSION; - printf ("colorize %s%s (compiled at %s, %s)\n", version_prefix, version_string, __DATE__, __TIME__); + printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME, version_prefix, version_string, __DATE__, __TIME__); printf ("Compiler flags: %s\n", c_flags); printf ("Linker flags: %s\n", ld_flags); @@ -610,12 +690,16 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct int ret; char *p; struct stat sb; - struct color_name *color_names[3] = { NULL, NULL, NULL }; + struct color_name *color_names[3] = { + NULL, /* foreground */ + NULL, /* background */ + NULL, /* sentinel value */ + }; 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, "-")) { @@ -644,7 +728,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct gather_color_names (color_string, attr, color_names); - assert (color_names[FOREGROUND]); + assert (color_names[FOREGROUND] != NULL); if (color_names[BACKGROUND]) { @@ -660,6 +744,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct } find_color_entries (color_names, colors); + assert (colors[FOREGROUND] != NULL); free_color_names (color_names); if (!colors[FOREGROUND]->code && colors[BACKGROUND] && colors[BACKGROUND]->code) @@ -668,6 +753,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct 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); @@ -705,8 +791,8 @@ process_file_arg (const char *file_string, const char **file, FILE **stream) *file = "stdin"; } - assert (*stream); - assert (*file); + assert (*stream != NULL); + assert (*file != NULL); } static void @@ -746,15 +832,15 @@ skip_path_colors (const char *color_string, const char *file_string, const struc 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 preceded 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"); } } } @@ -780,7 +866,7 @@ gather_color_names (const char *color_string, char *attr, struct color_name **co } else p = color + strlen (color); - assert (p); + assert (p != NULL); for (ch = color; *ch; ch++) if (!isalpha (*ch)) @@ -841,6 +927,7 @@ read_print_stream (const char *attr, const struct color **colors, const char *fi line = buf; while ((eol = strpbrk (line, "\n\r"))) { + const bool has_text = (eol > line); const char *p; flags &= ~(CR|LF); if (*eol == '\r') @@ -851,17 +938,18 @@ read_print_stream (const char *attr, const struct color **colors, const char *fi } else if (*eol == '\n') flags |= LF; - else + else /* never reached */ vfprintf_fail (formats[FMT_FILE], file, "unrecognized line ending"); p = eol + SKIP_LINE_ENDINGS (flags); *eol = '\0'; - print_line (attr, colors, line, flags); + print_line (attr, colors, line, flags, + omit_color_empty ? has_text : true); line = p; } if (feof (stream)) { if (*line != '\0') - print_line (attr, colors, line, 0); + print_line (attr, colors, line, 0, true); } else if (*line != '\0') { @@ -869,7 +957,7 @@ read_print_stream (const char *attr, const struct color **colors, const char *fi if ((clean || clean_all) && (p = strrchr (line, '\033'))) merge_print_line (line, p, stream); else - print_line (attr, colors, line, 0); + print_line (attr, colors, line, 0, true); } } } @@ -936,7 +1024,7 @@ complete_part_line (const char *p, char **buf, FILE *stream) if (read_from_stream) save_char (ch, buf, &i, &size); } - else /* read next character */ + else /* got next character */ { got_next_char = true; break; @@ -1076,12 +1164,13 @@ find_color_entry (const struct color_name *color_name, unsigned int index, const } static void -print_line (const char *attr, 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, bool emit_colors) { /* --clean[-all] */ if (clean || clean_all) print_clean (line); - else + /* skip for --omit-color-empty? */ + else if (emit_colors) { /* Foreground color code is guaranteed to be set when background color code is present. */ if (colors[BACKGROUND] && colors[BACKGROUND]->code) @@ -1290,13 +1379,14 @@ realloc_wrap (void *ptr, size_t size) return p; } #else +static const char *const format_debug = "%s: %10s %7lu bytes [source file %s, line %5u]\n"; 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); - fprintf (log, "%s: malloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)size, file, line); + fprintf (log, format_debug, program_name, "malloc'ed", (unsigned long)size, file, line); return p; } @@ -1306,7 +1396,7 @@ calloc_wrap_debug (size_t nmemb, size_t size, const char *file, unsigned int lin void *p = calloc (nmemb, size); if (!p) MEM_ALLOC_FAIL_DEBUG (file, line); - fprintf (log, "%s: calloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)(nmemb * size), file, line); + fprintf (log, format_debug, program_name, "calloc'ed", (unsigned long)(nmemb * size), file, line); return p; } @@ -1316,7 +1406,7 @@ 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); - fprintf (log, "%s: realloc'ed %lu bytes [source file %s, line %u]\n", program_name, (unsigned long)size, file, line); + fprintf (log, format_debug, program_name, "realloc'ed", (unsigned long)size, file, line); return p; } #endif /* !DEBUG */ @@ -1403,16 +1493,16 @@ has_color_name (const char *str, const char *name) { char *p; - assert (strlen (str)); - assert (strlen (name)); + assert (strlen (str) > 0); + assert (strlen (name) > 0); if (!(*str == *name || *str == toupper (*name))) return false; else if (*(name + 1) != '\0' && !((p = strstr (str + 1, name + 1)) && p == str + 1)) return false; - - return true; + else + return true; } static FILE * @@ -1434,7 +1524,7 @@ open_file (const char *file, const char *mode) va_start (ap, fmt); \ vfprintf (stderr, fmt, ap); \ va_end (ap); \ - fprintf (stderr, "\n"); \ + fprintf (stderr, "\n"); static void vfprintf_diag (const char *fmt, ...)