]> git.refcnt.org Git - colorize.git/blobdiff - colorize.c
colorize 0.54
[colorize.git] / colorize.c
index 1efc7d917794303de0132dd26b131bd0a30c4c06..26eaa2f5ee9092ac7d11862cf3e9b4ae741af604 100644 (file)
@@ -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-2013 Steven Schubiger
+ * Copyright (c) 2011-2014 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
@@ -19,7 +19,8 @@
  *
  */
 
-#define _POSIX_C_SOURCE 200809L
+#define _BSD_SOURCE
+#define _XOPEN_SOURCE 700
 #include <assert.h>
 #include <ctype.h>
 #include <errno.h>
 
 #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
+#if !DEBUG
 # define xmalloc(size)        malloc_wrap(size)
 # define xcalloc(nmemb, size) calloc_wrap(nmemb, size)
 # define xrealloc(ptr, size)  realloc_wrap(ptr, size)
+#else
+# 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__)
 #endif
 
 #define free_null(ptr) free_wrap((void **)&ptr)
 #define xstrdup(str)   strdup_wrap(str)
 
-#if !defined BUF_SIZE || BUF_SIZE <= 0
+#if BUF_SIZE <= 0
 # undef BUF_SIZE
-# define BUF_SIZE 4096 + 1
+#endif
+#ifndef BUF_SIZE
+# define BUF_SIZE 4096
 #endif
 
 #define LF 0x01
 
 #define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1)
 
+#define VALID_FILE_TYPE(mode) (S_ISREG (mode) || S_ISLNK (mode) || S_ISFIFO (mode))
+
 #define STACK_VAR(ptr) do {                                   \
     stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
-} while (false);
+} while (false)
 
 #define RELEASE_VAR(ptr) do {                             \
     release_var (vars_list, stacked_vars, (void **)&ptr); \
-} while (false);
+} 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 {                                          \
+#if !DEBUG
+# define MEM_ALLOC_FAIL() do {                                         \
     fprintf (stderr, "%s: memory allocation failure\n", program_name); \
     exit (2);                                                          \
-} while (false);
+} while (false)
+#else
+# 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)
+#endif
 
 #define ABORT_TRACE()                                                              \
     fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
 
 #define COLOR_SEP_CHAR '/'
 
-#define VERSION "0.51"
-
-typedef unsigned short bool;
+#define VERSION "0.54"
 
-enum { false, true };
+typedef enum { false, true } bool;
 
 struct color_name {
     char *name;
@@ -119,8 +125,8 @@ static const struct color fg_colors[] = {
     { "green",   "32m" },
     { "yellow",  "33m" },
     { "blue",    "34m" },
-    { "cyan",    "35m" },
-    { "magenta", "36m" },
+    { "magenta", "35m" },
+    { "cyan",    "36m" },
     { "white",   "37m" },
     { "default", "39m" },
 };
@@ -131,25 +137,31 @@ static const struct color bg_colors[] = {
     { "green",   "42m" },
     { "yellow",  "43m" },
     { "blue",    "44m" },
-    { "cyan",    "45m" },
-    { "magenta", "46m" },
+    { "magenta", "45m" },
+    { "cyan",    "46m" },
     { "white",   "47m" },
     { "default", "49m" },
 };
 
 enum fmts {
     FMT_GENERIC,
+    FMT_STRING,
+    FMT_QUOTE,
     FMT_COLOR,
     FMT_RANDOM,
     FMT_ERROR,
-    FMT_FILE
+    FMT_FILE,
+    FMT_TYPE
 };
 static const char *formats[] = {
     "%s",                    /* generic */
+    "%s '%s'",               /* string  */
+    "%s `%s' %s",            /* quote   */
     "%s color '%s' %s",      /* color   */
     "%s color '%s' %s '%s'", /* random  */
     "less than %u bytes %s", /* error   */
     "%s: %s",                /* file    */
+    "%s: %s: %s",            /* type    */
 };
 
 enum { FOREGROUND, BACKGROUND };
@@ -175,6 +187,7 @@ static char *exclude = NULL;
 
 static const char *program_name;
 
+static void print_hint (void);
 static void print_help (void);
 static void print_version (void);
 static void cleanup (void);
@@ -187,15 +200,20 @@ static void find_color_entry (const struct color_name *, unsigned int, const str
 static void print_line (bool, const struct color **, const char * const, unsigned int);
 static void print_clean (const char *);
 static void print_free_offsets (const char *, char ***, unsigned int);
+#if !DEBUG
 static void *malloc_wrap (size_t);
 static void *calloc_wrap (size_t, size_t);
 static void *realloc_wrap (void *, size_t);
+#else
 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);
+#endif
 static void free_wrap (void **);
 static char *strdup_wrap (const char *);
 static char *str_concat (const char *, const char *);
+static char *get_file_type (mode_t);
+static bool has_color_name (const char *, const char *);
 static void vfprintf_diag (const char *, ...);
 static void vfprintf_fail (const char *, ...);
 static void stack_var (void ***, unsigned int *, unsigned int, void *);
@@ -209,6 +227,8 @@ static void release_var (void **, unsigned int, void **);
 extern char *optarg;
 extern int optind;
 
+static int opt_type = 0;
+
 int
 main (int argc, char **argv)
 {
@@ -222,14 +242,14 @@ main (int argc, char **argv)
         OPT_VERSION
     };
 
-    int opt, opt_type = 0;
+    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        },
-        {  0,               0,                 0,         0                  },
+        {  NULL,            0,                 NULL,      0                  },
     };
 
     bool bold = false;
@@ -261,13 +281,21 @@ main (int argc, char **argv)
                     clean_all = true;
                     break;
                   case OPT_EXCLUDE_RANDOM: {
-                    char *p;
+                    bool valid = false;
+                    unsigned int i;
                     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");
+                    for (i = 1; i < tables[FOREGROUND].count - 1; i++) /* skip color none and default */
+                      {
+                        const struct color *entry = &tables[FOREGROUND].entries[i];
+                        if (streq (exclude, entry->name))
+                          {
+                            valid = true;
+                            break;
+                          }
+                      }
+                    if (!valid)
+                      vfprintf_fail (formats[FMT_GENERIC], "--exclude-random switch must be provided a plain color");
                     break;
                   }
                   case OPT_HELP:
@@ -285,7 +313,7 @@ main (int argc, char **argv)
             case 'v':
               SET_OPT_TYPE (OPT_VERSION);
             case '?':
-              print_help ();
+              print_hint ();
               exit (EXIT_FAILURE);
             default: /* never reached */
               ABORT_TRACE ();
@@ -312,8 +340,8 @@ main (int argc, char **argv)
       {
         if (arg_cnt == 0 || arg_cnt > 2)
           {
-            vfprintf_diag ("%u arguments provided, expected 1-2 arguments or option", arg_cnt);
-            print_help ();
+            vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt);
+            print_hint ();
             exit (EXIT_FAILURE);
           }
       }
@@ -329,6 +357,12 @@ main (int argc, char **argv)
     exit (EXIT_SUCCESS);
 }
 
+static void
+print_hint (void)
+{
+    fprintf (stderr, "Type `%s --help' for help screen.\n", program_name);
+}
+
 static void
 print_help (void)
 {
@@ -364,14 +398,21 @@ static void
 print_version (void)
 {
     const char *c_flags;
-    printf ("%s v%s (compiled at %s, %s)\n", "colorize", VERSION, __DATE__, __TIME__);
+    bool debug;
 #ifdef CFLAGS
     c_flags = to_str (CFLAGS);
 #else
     c_flags = "unknown";
 #endif
+#if DEBUG
+    debug = true;
+#else
+    debug = false;
+#endif
+    printf ("%s v%s (compiled at %s, %s)\n", "colorize", VERSION, __DATE__, __TIME__);
     printf ("Compiler flags: %s\n", c_flags);
-    printf ("Buffer size: %u bytes\n", BUF_SIZE - 1);
+    printf ("Buffer size: %u bytes\n", BUF_SIZE);
+    printf ("Debugging: %s\n", debug ? "yes" : "no");
 }
 
 static void
@@ -426,7 +467,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct
           vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceeded by color string");
       }
 
-    ret = stat (color_string, &sb);
+    ret = lstat (color_string, &sb);
 
     /* Ensure that we don't fail if there's a file with one or more
        color names in its path.  */
@@ -435,6 +476,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct
         bool have_file;
         unsigned int c;
         const char *color = color_string;
+        const mode_t mode = sb.st_mode;
 
         for (c = 1; c <= 2 && *color; c++)
           {
@@ -443,14 +485,18 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct
             for (i = 0; i < tables[FOREGROUND].count; i++)
               {
                 const struct color *entry = &tables[FOREGROUND].entries[i];
-                char *p;
-                if ((p = strstr (color, entry->name)) && p == color)
+                if (has_color_name (color, entry->name))
                   {
-                    color = p + strlen (entry->name);
+                    color += strlen (entry->name);
                     matched = true;
                     break;
                   }
               }
+            if (!matched && has_color_name (color, "random"))
+              {
+                color += strlen ("random");
+                matched = true;
+              }
             if (matched && *color == COLOR_SEP_CHAR && *(color + 1))
               color++;
             else
@@ -461,21 +507,27 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct
 
         if (have_file)
           {
+            const char *file_exists = color_string;
             if (file_string)
-              vfprintf_fail (formats[FMT_GENERIC], "file cannot be used as color string");
+              vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "cannot be used as color string");
             else
-              vfprintf_fail (formats[FMT_GENERIC], "file must be preceeded by color string");
+              {
+                if (VALID_FILE_TYPE (mode))
+                  vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "must be preceeded by color string");
+                else
+                  vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_exists, "is not a valid file type");
+              }
           }
       }
 
     if ((p = strchr (color_string, COLOR_SEP_CHAR)))
       {
         if (p == color_string)
-          vfprintf_fail (formats[FMT_GENERIC], "foreground color missing");
+          vfprintf_fail (formats[FMT_STRING], "foreground color missing in string", color_string);
         else if (p == color_string + strlen (color_string) - 1)
-          vfprintf_fail (formats[FMT_GENERIC], "background color missing");
+          vfprintf_fail (formats[FMT_STRING], "background color missing in string", color_string);
         else if (strchr (++p, COLOR_SEP_CHAR))
-          vfprintf_fail (formats[FMT_GENERIC], "one color pair allowed only");
+          vfprintf_fail (formats[FMT_STRING], "one color pair allowed only for string", color_string);
       }
 
     str = xstrdup (color_string);
@@ -484,6 +536,8 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct
     for (index = 0, color = str; *color; index++, color = p)
       {
         char *ch, *sep;
+
+        p = NULL;
         if ((sep = strchr (color, COLOR_SEP_CHAR)))
           {
             *sep = '\0';
@@ -491,6 +545,7 @@ process_args (unsigned int arg_cnt, char **arg_strings, bool *bold, const struct
           }
         else
           p = color + strlen (color);
+        assert (p);
 
         for (ch = color; *ch; ch++)
           if (!isalpha (*ch))
@@ -571,16 +626,16 @@ process_file_arg (const char *file_string, const char **file, FILE **stream)
             FILE *s;
             const char *file = file_string;
             struct stat sb;
-            int errno, ret;
+            int ret;
 
             errno = 0;
-            ret = stat (file, &sb);
+            ret = lstat (file, &sb);
 
             if (ret == -1)
               vfprintf_fail (formats[FMT_FILE], file, strerror (errno));
 
-            if (!(S_ISREG (sb.st_mode) || S_ISLNK (sb.st_mode) || S_ISFIFO (sb.st_mode)))
-              vfprintf_fail (formats[FMT_FILE], file, "unrecognized file type");
+            if (!VALID_FILE_TYPE (sb.st_mode))
+              vfprintf_fail (formats[FMT_TYPE], file, "unrecognized type", get_file_type (sb.st_mode));
 
             errno = 0;
 
@@ -612,12 +667,12 @@ process_file_arg (const char *file_string, const char **file, FILE **stream)
     if (!check_eof || *current_line != '\0')                     \
       print_line (bold, colors, current_line, flags);            \
     free (merged_line);                                          \
-} while (false);
+} while (false)
 
 static void
 read_print_stream (bool bold, const struct color **colors, const char *file, FILE *stream)
 {
-    char buf[BUF_SIZE], *part_line = NULL;
+    char buf[BUF_SIZE + 1], *part_line = NULL;
     unsigned int flags = 0;
 
     while (!feof (stream))
@@ -625,10 +680,10 @@ read_print_stream (bool bold, const struct color **colors, const char *file, FIL
         size_t bytes_read;
         char *eol;
         const char *line;
-        memset (buf, '\0', BUF_SIZE);
-        bytes_read = fread (buf, 1, BUF_SIZE - 1, stream);
-        if (bytes_read != (BUF_SIZE - 1) && ferror (stream))
-          vfprintf_fail (formats[FMT_ERROR], BUF_SIZE - 1, "read");
+        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");
         line = buf;
         while ((eol = strpbrk (line, "\n\r")))
           {
@@ -893,6 +948,7 @@ print_free_offsets (const char *line, char ***offsets, unsigned int count)
     free_null (offsets);
 }
 
+#if !DEBUG
 static void *
 malloc_wrap (size_t size)
 {
@@ -919,7 +975,7 @@ realloc_wrap (void *ptr, size_t size)
       MEM_ALLOC_FAIL ();
     return p;
 }
-
+#else
 static void *
 malloc_wrap_debug (size_t size, const char *file, unsigned int line)
 {
@@ -946,6 +1002,7 @@ realloc_wrap_debug (void *ptr, size_t size, const char *file, unsigned int line)
       MEM_ALLOC_FAIL_DEBUG (file, line);
     return p;
 }
+#endif
 
 static void
 free_wrap (void **ptr)
@@ -979,6 +1036,44 @@ str_concat (const char *str1, const char *str2)
     return str;
 }
 
+static char *
+get_file_type (mode_t mode)
+{
+    if (S_ISREG (mode))
+      return "file";
+    else if (S_ISDIR (mode))
+      return "directory";
+    else if (S_ISCHR (mode))
+      return "character device";
+    else if (S_ISBLK (mode))
+      return "block device";
+    else if (S_ISFIFO (mode))
+      return "named pipe";
+    else if (S_ISLNK (mode))
+      return "symbolic link";
+    else if (S_ISSOCK (mode))
+      return "socket";
+    else
+      return "file";
+}
+
+static bool
+has_color_name (const char *str, const char *name)
+{
+    char *p;
+
+    assert (strlen (str));
+    assert (strlen (name));
+
+    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;
+}
+
 #define DO_VFPRINTF(fmt)                    \
     va_list ap;                             \
     fprintf (stderr, "%s: ", program_name); \