]>
git.refcnt.org Git - colorize.git/blob - colorize.c
9e0c294ba0ca89e5322b52481adcb00346a3fdc5
2 * colorize - Read text from standard input stream or file and print
3 * it colorized through use of ANSI escape sequences
5 * Copyright (c) 2011-2013 Steven Schubiger
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #define _POSIX_C_SOURCE 200809L
32 #include <sys/types.h>
42 #define to_str(arg) str(arg)
44 #define streq(s1, s2) (strcmp (s1, s2) == 0)
47 # define xmalloc(size) malloc_wrap_debug(size, __FILE__, __LINE__)
48 # define xcalloc(nmemb, size) calloc_wrap_debug(nmemb, size, __FILE__, __LINE__)
49 # define xrealloc(ptr, size) realloc_wrap_debug(ptr, size, __FILE__, __LINE__)
51 # define xmalloc(size) malloc_wrap(size)
52 # define xcalloc(nmemb, size) calloc_wrap(nmemb, size)
53 # define xrealloc(ptr, size) realloc_wrap(ptr, size)
56 #define free_null(ptr) free_wrap((void **)&ptr)
57 #define xstrdup(str) strdup_wrap(str)
63 # define BUF_SIZE 4096
69 #define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1)
71 #define STACK_VAR(ptr) do { \
72 stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
75 #define RELEASE_VAR(ptr) do { \
76 release_var (vars_list, stacked_vars, (void **)&ptr); \
79 #define MEM_ALLOC_FAIL_DEBUG(file, line) do { \
80 fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
83 #define MEM_ALLOC_FAIL() do { \
84 fprintf (stderr, "%s: memory allocation failure\n", program_name); \
88 #define ABORT_TRACE() \
89 fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
92 #define CHECK_COLORS_RANDOM(color1, color2) \
93 streq (color_names[color1]->name, "random") \
94 && (streq (color_names[color2]->name, "none") \
95 || streq (color_names[color2]->name, "default")) \
97 #define COLOR_SEP_CHAR '/'
99 #define VERSION "0.52"
101 typedef enum { false, true } bool;
108 static struct color_name
*color_names
[3] = { NULL
, NULL
, NULL
};
115 static const struct color fg_colors
[] = {
122 { "magenta", "35m" },
125 { "default", "39m" },
127 static const struct color bg_colors
[] = {
134 { "magenta", "45m" },
137 { "default", "49m" },
147 static const char *formats
[] = {
149 "%s color '%s' %s", /* color */
150 "%s color '%s' %s '%s'", /* random */
151 "less than %u bytes %s", /* error */
155 enum { FOREGROUND
, BACKGROUND
};
157 static const struct {
158 struct color
const *entries
;
162 { fg_colors
, sizeof (fg_colors
) / sizeof (struct color
), "foreground" },
163 { bg_colors
, sizeof (bg_colors
) / sizeof (struct color
), "background" },
166 static FILE *stream
= NULL
;
168 static unsigned int stacked_vars
= 0;
169 static void **vars_list
= NULL
;
171 static bool clean
= false;
172 static bool clean_all
= false;
174 static char *exclude
= NULL
;
176 static const char *program_name
;
178 static void print_help (void);
179 static void print_version (void);
180 static void cleanup (void);
181 static void free_color_names (struct color_name
**);
182 static void process_args (unsigned int, char **, bool *, const struct color
**, const char **, FILE **);
183 static void process_file_arg (const char *, const char **, FILE **);
184 static void read_print_stream (bool, const struct color
**, const char *, FILE *);
185 static void find_color_entries (struct color_name
**, const struct color
**);
186 static void find_color_entry (const struct color_name
*, unsigned int, const struct color
**);
187 static void print_line (bool, const struct color
**, const char * const, unsigned int);
188 static void print_clean (const char *);
189 static void print_free_offsets (const char *, char ***, unsigned int);
190 static void *malloc_wrap (size_t);
191 static void *calloc_wrap (size_t, size_t);
192 static void *realloc_wrap (void *, size_t);
193 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
194 static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
195 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
196 static void free_wrap (void **);
197 static char *strdup_wrap (const char *);
198 static char *str_concat (const char *, const char *);
199 static bool has_color_name (const char *, const char *);
200 static void vfprintf_diag (const char *, ...);
201 static void vfprintf_fail (const char *, ...);
202 static void stack_var (void ***, unsigned int *, unsigned int, void *);
203 static void release_var (void **, unsigned int, void **);
205 #define SET_OPT_TYPE(type) \
214 main (int argc
, char **argv
)
216 unsigned int arg_cnt
= 0;
226 int opt
, opt_type
= 0;
227 struct option long_opts
[] = {
228 { "clean", no_argument
, &opt_type
, OPT_CLEAN
},
229 { "clean-all", no_argument
, &opt_type
, OPT_CLEAN_ALL
},
230 { "exclude-random", required_argument
, &opt_type
, OPT_EXCLUDE_RANDOM
},
231 { "help", no_argument
, &opt_type
, OPT_HELP
},
232 { "version", no_argument
, &opt_type
, OPT_VERSION
},
233 { NULL
, 0, NULL
, 0 },
238 const struct color
*colors
[2] = {
239 NULL
, /* foreground */
240 NULL
, /* background */
243 const char *file
= NULL
;
245 program_name
= argv
[0];
248 setvbuf (stdout
, NULL
, _IOLBF
, 0);
250 while ((opt
= getopt_long (argc
, argv
, "hv", long_opts
, NULL
)) != -1)
255 case 0: /* long opts */
264 case OPT_EXCLUDE_RANDOM
: {
267 exclude
= xstrdup (optarg
);
269 for (i
= 1; i
< tables
[FOREGROUND
].count
- 1; i
++) /* skip color none and default */
271 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
272 if (streq (exclude
, entry
->name
))
279 vfprintf_fail (formats
[FMT_GENERIC
], "--exclude-random switch must be provided a plain color");
288 default: /* never reached */
293 SET_OPT_TYPE (OPT_HELP
);
295 SET_OPT_TYPE (OPT_VERSION
);
299 default: /* never reached */
304 arg_cnt
= argc
- optind
;
306 if (clean
|| clean_all
)
308 if (clean
&& clean_all
)
309 vfprintf_fail (formats
[FMT_GENERIC
], "--clean and --clean-all switch are mutually exclusive");
312 const char *format
= "%s %s";
313 const char *message
= "switch cannot be used with more than one file";
315 vfprintf_fail (format
, "--clean", message
);
317 vfprintf_fail (format
, "--clean-all", message
);
322 if (arg_cnt
== 0 || arg_cnt
> 2)
324 vfprintf_diag ("%u arguments provided, expected 1-2 arguments or option", arg_cnt
);
330 if (clean
|| clean_all
)
331 process_file_arg (argv
[optind
], &file
, &stream
);
333 process_args (arg_cnt
, &argv
[optind
], &bold
, colors
, &file
, &stream
);
334 read_print_stream (bold
, colors
, file
, stream
);
336 RELEASE_VAR (exclude
);
346 printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name
, COLOR_SEP_CHAR
);
347 printf ("\tColors (foreground) (background)\n");
348 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
350 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
351 const char *name
= entry
->name
;
352 const char *code
= entry
->code
;
354 printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
355 code
, toupper (*name
), *name
, name
+ 1, 10 - (int)strlen (name
), " ", name
);
357 printf ("\t\t{-} %s%*s%s\n", name
, 13 - (int)strlen (name
), " ", name
);
359 printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
361 printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
362 printf ("\twhereas for lower case colors will be of normal intensity.\n");
364 printf ("\n\tOptions\n");
365 printf ("\t\t --clean\n");
366 printf ("\t\t --clean-all\n");
367 printf ("\t\t --exclude-random\n");
368 printf ("\t\t-h, --help\n");
369 printf ("\t\t-v, --version\n\n");
378 c_flags
= to_str (CFLAGS
);
387 printf ("%s v%s (compiled at %s, %s)\n", "colorize", VERSION
, __DATE__
, __TIME__
);
388 printf ("Compiler flags: %s\n", c_flags
);
389 printf ("Buffer size: %u bytes\n", BUF_SIZE
);
390 printf ("Debugging: %s\n", debug
? "yes" : "no");
396 free_color_names (color_names
);
398 if (stream
&& fileno (stream
) != STDIN_FILENO
)
404 for (i
= 0; i
< stacked_vars
; i
++)
406 free_null (vars_list
[i
]);
408 free_null (vars_list
);
413 free_color_names (struct color_name
**color_names
)
416 for (i
= 0; color_names
[i
]; i
++)
418 free_null (color_names
[i
]->name
);
419 free_null (color_names
[i
]->orig
);
420 free_null (color_names
[i
]);
425 process_args (unsigned int arg_cnt
, char **arg_strings
, bool *bold
, const struct color
**colors
, const char **file
, FILE **stream
)
429 char *color
, *p
, *str
;
432 const char *color_string
= arg_cnt
>= 1 ? arg_strings
[0] : NULL
;
433 const char *file_string
= arg_cnt
== 2 ? arg_strings
[1] : NULL
;
435 assert (color_string
);
437 if (streq (color_string
, "-"))
440 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen cannot be used as color string");
442 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen must be preceeded by color string");
445 ret
= stat (color_string
, &sb
);
447 /* Ensure that we don't fail if there's a file with one or more
448 color names in its path. */
453 const char *color
= color_string
;
455 for (c
= 1; c
<= 2 && *color
; c
++)
457 bool matched
= false;
459 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
461 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
462 if (has_color_name (color
, entry
->name
))
464 color
+= strlen (entry
->name
);
469 if (!matched
&& has_color_name (color
, "random"))
471 color
+= strlen ("random");
474 if (matched
&& *color
== COLOR_SEP_CHAR
&& *(color
+ 1))
480 have_file
= (*color
!= '\0');
485 vfprintf_fail (formats
[FMT_GENERIC
], "file cannot be used as color string");
487 vfprintf_fail (formats
[FMT_GENERIC
], "file must be preceeded by color string");
491 if ((p
= strchr (color_string
, COLOR_SEP_CHAR
)))
493 if (p
== color_string
)
494 vfprintf_fail (formats
[FMT_GENERIC
], "foreground color missing");
495 else if (p
== color_string
+ strlen (color_string
) - 1)
496 vfprintf_fail (formats
[FMT_GENERIC
], "background color missing");
497 else if (strchr (++p
, COLOR_SEP_CHAR
))
498 vfprintf_fail (formats
[FMT_GENERIC
], "one color pair allowed only");
501 str
= xstrdup (color_string
);
504 for (index
= 0, color
= str
; *color
; index
++, color
= p
)
509 if ((sep
= strchr (color
, COLOR_SEP_CHAR
)))
515 p
= color
+ strlen (color
);
518 for (ch
= color
; *ch
; ch
++)
520 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be made of non-alphabetic characters");
522 for (ch
= color
+ 1; *ch
; ch
++)
524 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be in mixed lower/upper case");
526 if (streq (color
, "None"))
527 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be bold");
529 if (isupper (*color
))
537 vfprintf_fail (formats
[FMT_COLOR
], tables
[BACKGROUND
].desc
, color
, "cannot be bold");
539 default: /* never reached */
544 color_names
[index
] = xcalloc (1, sizeof (struct color_name
));
546 color_names
[index
]->orig
= xstrdup (color
);
548 for (ch
= color
; *ch
; ch
++)
551 color_names
[index
]->name
= xstrdup (color
);
556 assert (color_names
[FOREGROUND
]);
558 if (color_names
[BACKGROUND
])
561 unsigned int color_sets
[2][2] = { { FOREGROUND
, BACKGROUND
}, { BACKGROUND
, FOREGROUND
} };
562 for (i
= 0; i
< 2; i
++)
564 unsigned int color1
= color_sets
[i
][0];
565 unsigned int color2
= color_sets
[i
][1];
566 if (CHECK_COLORS_RANDOM (color1
, color2
))
567 vfprintf_fail (formats
[FMT_RANDOM
], tables
[color1
].desc
, color_names
[color1
]->orig
, "cannot be combined with", color_names
[color2
]->orig
);
571 find_color_entries (color_names
, colors
);
572 free_color_names (color_names
);
574 if (!colors
[FOREGROUND
]->code
&& colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
576 struct color_name color_name
;
577 color_name
.name
= color_name
.orig
= "default";
579 find_color_entry (&color_name
, FOREGROUND
, colors
);
582 process_file_arg (file_string
, file
, stream
);
586 process_file_arg (const char *file_string
, const char **file
, FILE **stream
)
590 if (streq (file_string
, "-"))
595 const char *file
= file_string
;
600 ret
= stat (file
, &sb
);
603 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
605 if (!(S_ISREG (sb
.st_mode
) || S_ISLNK (sb
.st_mode
) || S_ISFIFO (sb
.st_mode
)))
606 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized file type");
610 s
= fopen (file
, "r");
612 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
627 #define MERGE_PRINT_LINE(part_line, line, flags, check_eof) do { \
628 char *current_line, *merged_line = NULL; \
631 merged_line = str_concat (part_line, line); \
632 free_null (part_line); \
634 current_line = merged_line ? merged_line : (char *)line; \
635 if (!check_eof || *current_line != '\0') \
636 print_line (bold, colors, current_line, flags); \
637 free (merged_line); \
641 read_print_stream (bool bold
, const struct color
**colors
, const char *file
, FILE *stream
)
643 char buf
[BUF_SIZE
+ 1], *part_line
= NULL
;
644 unsigned int flags
= 0;
646 while (!feof (stream
))
651 memset (buf
, '\0', BUF_SIZE
+ 1);
652 bytes_read
= fread (buf
, 1, BUF_SIZE
, stream
);
653 if (bytes_read
!= BUF_SIZE
&& ferror (stream
))
654 vfprintf_fail (formats
[FMT_ERROR
], BUF_SIZE
, "read");
656 while ((eol
= strpbrk (line
, "\n\r")))
663 if (*(eol
+ 1) == '\n')
666 else if (*eol
== '\n')
669 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized line ending");
670 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
672 MERGE_PRINT_LINE (part_line
, line
, flags
, false);
676 MERGE_PRINT_LINE (part_line
, line
, 0, true);
678 else if (*line
!= '\0')
680 if (!clean
&& !clean_all
) /* efficiency */
681 print_line (bold
, colors
, line
, 0);
683 part_line
= xstrdup (line
);
686 char *merged_line
= str_concat (part_line
, line
);
688 part_line
= merged_line
;
695 find_color_entries (struct color_name
**color_names
, const struct color
**colors
)
701 gettimeofday (&tv
, NULL
);
702 srand (tv
.tv_usec
* tv
.tv_sec
);
704 for (index
= 0; color_names
[index
]; index
++)
706 const char *color_name
= color_names
[index
]->name
;
708 const unsigned int count
= tables
[index
].count
;
709 const struct color
*const color_entries
= tables
[index
].entries
;
711 if (streq (color_name
, "random"))
717 i
= rand() % (count
- 2) + 1; /* omit color none and default */
721 /* --exclude-random */
722 if (exclude
&& streq (exclude
, color_entries
[i
].name
))
724 else if (color_names
[BACKGROUND
] && streq (color_names
[BACKGROUND
]->name
, color_entries
[i
].name
))
728 if (streq (colors
[FOREGROUND
]->name
, color_entries
[i
].name
))
731 default: /* never reached */
734 } while (excludable
);
735 colors
[index
] = (struct color
*)&color_entries
[i
];
738 find_color_entry (color_names
[index
], index
, colors
);
743 find_color_entry (const struct color_name
*color_name
, unsigned int index
, const struct color
**colors
)
748 const unsigned int count
= tables
[index
].count
;
749 const struct color
*const color_entries
= tables
[index
].entries
;
751 for (i
= 0; i
< count
; i
++)
752 if (streq (color_name
->name
, color_entries
[i
].name
))
754 colors
[index
] = (struct color
*)&color_entries
[i
];
759 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color_name
->orig
, "not recognized");
763 print_line (bool bold
, const struct color
**colors
, const char *const line
, unsigned int flags
)
766 if (clean
|| clean_all
)
770 /* Foreground color code is guaranteed to be set when background color code is present. */
771 if (colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
772 printf ("\033[%s", colors
[BACKGROUND
]->code
);
773 if (colors
[FOREGROUND
]->code
)
774 printf ("\033[%s%s%s\033[0m", bold
? "1;" : "", colors
[FOREGROUND
]->code
, line
);
776 printf (formats
[FMT_GENERIC
], line
);
785 print_clean (const char *line
)
788 char ***offsets
= NULL
;
789 unsigned int count
= 0, i
= 0;
794 if (*p
== 27 && *(p
+ 1) == '[')
796 const char *begin
= p
;
800 while (isdigit (*p
) || *p
== ';')
806 unsigned int iter
= 0;
809 check_values
= false;
818 else /* check range */
823 const unsigned int digits
= p
- digit
;
824 for (i
= 0; i
< digits
; i
++)
828 if (value
== 0) /* reset */
834 else if (value
== 1) /* bold */
836 bool discard
= false;
846 else if ((value
>= 30 && value
<= 37) || value
== 39) /* foreground colors */
848 else if ((value
>= 40 && value
<= 47) || value
== 49) /* background colors */
857 } while (iter
== 1 && check_values
);
861 const char *end
= p
++;
863 offsets
= xmalloc (++count
* sizeof (char **));
865 offsets
= xrealloc (offsets
, ++count
* sizeof (char **));
866 offsets
[i
] = xmalloc (2 * sizeof (char *));
867 offsets
[i
][0] = (char *)begin
; /* ESC */
868 offsets
[i
][1] = (char *)end
; /* m */
879 print_free_offsets (line
, offsets
, count
);
881 printf (formats
[FMT_GENERIC
], line
);
884 #define SET_CHAR(offset, new, old) \
888 #define RESTORE_CHAR(offset, old) \
892 print_free_offsets (const char *line
, char ***offsets
, unsigned int count
)
897 SET_CHAR (offsets
[0][0], '\0', &ch
);
898 printf (formats
[FMT_GENERIC
], line
);
899 RESTORE_CHAR (offsets
[0][0], ch
);
901 for (i
= 0; i
< count
; i
++)
904 bool next_offset
= false;
907 SET_CHAR (offsets
[i
+ 1][0], '\0', &ch
);
910 printf (formats
[FMT_GENERIC
], offsets
[i
][1] + 1);
912 RESTORE_CHAR (offsets
[i
+ 1][0], ch
);
914 for (i
= 0; i
< count
; i
++)
915 free_null (offsets
[i
]);
920 malloc_wrap (size_t size
)
922 void *p
= malloc (size
);
929 calloc_wrap (size_t nmemb
, size_t size
)
931 void *p
= calloc (nmemb
, size
);
938 realloc_wrap (void *ptr
, size_t size
)
940 void *p
= realloc (ptr
, size
);
947 malloc_wrap_debug (size_t size
, const char *file
, unsigned int line
)
949 void *p
= malloc (size
);
951 MEM_ALLOC_FAIL_DEBUG (file
, line
);
956 calloc_wrap_debug (size_t nmemb
, size_t size
, const char *file
, unsigned int line
)
958 void *p
= calloc (nmemb
, size
);
960 MEM_ALLOC_FAIL_DEBUG (file
, line
);
965 realloc_wrap_debug (void *ptr
, size_t size
, const char *file
, unsigned int line
)
967 void *p
= realloc (ptr
, size
);
969 MEM_ALLOC_FAIL_DEBUG (file
, line
);
974 free_wrap (void **ptr
)
981 strdup_wrap (const char *str
)
983 const size_t len
= strlen (str
) + 1;
984 char *p
= xmalloc (len
);
985 strncpy (p
, str
, len
);
990 str_concat (const char *str1
, const char *str2
)
992 const size_t len
= strlen (str1
) + strlen (str2
) + 1;
995 p
= str
= xmalloc (len
);
996 strncpy (p
, str1
, strlen (str1
));
998 strncpy (p
, str2
, strlen (str2
));
1006 has_color_name (const char *str
, const char *name
)
1010 assert (strlen (str
));
1011 assert (strlen (name
));
1013 if (!(*str
== *name
|| *str
== toupper (*name
)))
1015 else if (*(name
+ 1) != '\0'
1016 && !((p
= strstr (str
+ 1, name
+ 1)) && p
== str
+ 1))
1022 #define DO_VFPRINTF(fmt) \
1024 fprintf (stderr, "%s: ", program_name); \
1025 va_start (ap, fmt); \
1026 vfprintf (stderr, fmt, ap); \
1028 fprintf (stderr, "\n"); \
1031 vfprintf_diag (const char *fmt
, ...)
1037 vfprintf_fail (const char *fmt
, ...)
1040 exit (EXIT_FAILURE
);
1044 stack_var (void ***list
, unsigned int *stacked
, unsigned int index
, void *ptr
)
1046 /* nothing to stack */
1050 *list
= xmalloc (sizeof (void *));
1054 for (i
= 0; i
< *stacked
; i
++)
1058 return; /* reused */
1060 *list
= xrealloc (*list
, (*stacked
+ 1) * sizeof (void *));
1062 (*list
)[index
] = ptr
;
1067 release_var (void **list
, unsigned int stacked
, void **ptr
)
1070 /* nothing to release */
1073 for (i
= 0; i
< stacked
; i
++)
1074 if (list
[i
] == *ptr
)