]>
git.refcnt.org Git - colorize.git/blob - colorize.c
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/>.
32 #include <sys/types.h>
40 #define to_str(arg) str(arg)
42 #define streq(s1, s2) (strcmp (s1, s2) == 0)
45 # define xmalloc(size) malloc_wrap_debug(size, __FILE__, __LINE__)
46 # define xrealloc(ptr, size) realloc_wrap_debug(ptr, size, __FILE__, __LINE__)
48 # define xmalloc(size) malloc_wrap(size)
49 # define xrealloc(ptr, size) realloc_wrap(ptr, size)
52 #define free_null(ptr) free_wrap((void **)&ptr)
53 #define xstrdup(str) strdup_wrap(str)
55 #if !defined BUF_SIZE || BUF_SIZE <= 0
57 # define BUF_SIZE 4096 + 1
63 #define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1)
65 #define STACK_VAR(ptr) do { \
66 stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
69 #define RELEASE_VAR(ptr) do { \
70 release_var (vars_list, stacked_vars, (void **)&ptr); \
73 #define MEM_ALLOC_FAIL_DEBUG(file, line) do { \
74 fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
77 #define MEM_ALLOC_FAIL() do { \
78 fprintf (stderr, "%s: memory allocation failure\n", program_name); \
82 #define ABORT_TRACE() \
83 fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
86 #define CHECK_COLORS_RANDOM(color1, color2) \
87 streq (color_names[color1]->name, "random") \
88 && (streq (color_names[color2]->name, "none") \
89 || streq (color_names[color2]->name, "default")) \
91 #define COLOR_SEP_CHAR '/'
93 #define VERSION "0.49"
95 typedef unsigned short bool;
104 static struct color_name
*color_names
[3] = { NULL
, NULL
, NULL
};
111 static const struct color fg_colors
[] = {
119 { "magenta", "36m" },
121 { "default", "39m" },
123 static const struct color bg_colors
[] = {
131 { "magenta", "46m" },
133 { "default", "49m" },
143 static const char *formats
[] = {
145 "%s color '%s' %s", /* color */
146 "%s color '%s' %s '%s'", /* random */
147 "less than %u bytes %s", /* error */
151 enum { FOREGROUND
, BACKGROUND
};
153 static const struct {
154 struct color
const *entries
;
158 { fg_colors
, sizeof (fg_colors
) / sizeof (struct color
), "foreground" },
159 { bg_colors
, sizeof (bg_colors
) / sizeof (struct color
), "background" },
162 enum stream_mode
{ SCAN_FIRST
= 1, SCAN_ALWAYS
};
166 const char newline
[3];
169 static const struct ending endings
[] = {
175 static FILE *stream
= NULL
;
177 static unsigned int stacked_vars
= 0;
178 static void **vars_list
= NULL
;
180 static bool clean
= false;
181 static char *exclude
= NULL
;
183 static const char *program_name
;
185 static void print_help (void);
186 static void print_version (void);
187 static void cleanup (void);
188 static void free_color_names (struct color_name
**);
189 static void process_options (unsigned int, char **, bool *, const struct color
**, const char **, FILE **);
190 static void process_file_option (const char *, const char **, FILE **);
191 static void read_print_stream (bool, const struct color
**, const char *, FILE *, enum stream_mode
);
192 static void find_color_entries (struct color_name
**, const struct color
**);
193 static void find_color_entry (const char *const, unsigned int, const struct color
**);
194 static void print_line (const struct color
**, bool, const char * const, unsigned int);
195 static void print_clean (const char *);
196 static void print_free_offsets (const char *, char ***, unsigned int);
197 static void *malloc_wrap (size_t);
198 static void *realloc_wrap (void *, size_t);
199 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
200 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
201 static void free_wrap (void **);
202 static char *strdup_wrap (const char *);
203 static char *str_concat (const char *, const char *);
204 static void vfprintf_fail (const char *, ...);
205 static void stack_var (void ***, unsigned int *, unsigned int, void *);
206 static void release_var (void **, unsigned int, void **);
212 main (int argc
, char **argv
)
214 unsigned int arg_cnt
= 0;
223 int opt
, opt_type
= 0;
224 struct option long_opts
[] = {
225 { "clean", no_argument
, &opt_type
, OPT_CLEAN
},
226 { "exclude-random", required_argument
, &opt_type
, OPT_EXCLUDE_RANDOM
},
227 { "help", no_argument
, &opt_type
, OPT_HELP
},
228 { "version", no_argument
, &opt_type
, OPT_VERSION
},
234 const struct color
*colors
[2] = {
235 NULL
, /* foreground */
236 NULL
, /* background */
241 enum stream_mode mode
= SCAN_FIRST
;
243 program_name
= argv
[0];
246 setvbuf (stdout
, NULL
, _IOLBF
, 0);
248 while ((opt
= getopt_long (argc
, argv
, "hv", long_opts
, NULL
)) != -1)
253 case 0: /* long opts */
259 case OPT_EXCLUDE_RANDOM
: {
261 exclude
= xstrdup (optarg
);
263 for (p
= exclude
; *p
; p
++)
265 if (streq (exclude
, "random"))
266 vfprintf_fail (formats
[FMT_GENERIC
], "--exclude-random switch must be provided a color");
275 default: /* never reached */
284 opt_type
= OPT_VERSION
;
290 default: /* never reached */
295 arg_cnt
= argc
- optind
;
300 vfprintf_fail (formats
[FMT_GENERIC
], "--clean switch cannot be used with more than one file");
304 if (arg_cnt
== 0 || arg_cnt
> 2)
312 process_file_option (argv
[optind
], &file
, &stream
);
314 process_options (arg_cnt
, &argv
[optind
], &bold
, colors
, &file
, &stream
);
315 read_print_stream (bold
, colors
, file
, stream
, mode
);
317 RELEASE_VAR (exclude
);
327 printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean [-|file]\n\n", program_name
, COLOR_SEP_CHAR
);
328 printf ("\tColors (foreground) (background)\n");
329 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
331 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
332 const char *name
= entry
->name
;
333 const char *code
= entry
->code
;
335 printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
336 code
, toupper (*name
), *name
, name
+ 1, 10 - (int)strlen (name
), " ", name
);
338 printf ("\t\t{-} %s%*s%s\n", name
, 13 - (int)strlen (name
), " ", name
);
340 printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
342 printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
343 printf ("\twhereas for lower case colors will be of normal intensity.\n");
345 printf ("\n\tOptions\n");
346 printf ("\t\t --clean\n");
347 printf ("\t\t --exclude-random\n");
348 printf ("\t\t-h, --help\n");
349 printf ("\t\t-v, --version\n\n");
356 printf ("%s v%s (compiled at %s, %s)\n", "colorize", VERSION
, __DATE__
, __TIME__
);
358 c_flags
= to_str (CFLAGS
);
362 printf ("Compiler flags: %s\n", c_flags
);
363 printf ("Buffer size: %u bytes\n", BUF_SIZE
- 1);
369 free_color_names (color_names
);
371 if (stream
&& fileno (stream
) != STDIN_FILENO
)
377 for (i
= 0; i
< stacked_vars
; i
++)
379 free_null (vars_list
[i
]);
381 free_null (vars_list
);
386 free_color_names (struct color_name
**color_names
)
389 for (i
= 0; color_names
[i
]; i
++)
391 free_null (color_names
[i
]->name
);
392 free_null (color_names
[i
]->orig
);
393 free_null (color_names
[i
]);
398 process_options (unsigned int arg_cnt
, char **option_strings
, bool *bold
, const struct color
**colors
, const char **file
, FILE **stream
)
402 char *color
, *p
, *str
;
405 const char *color_string
= arg_cnt
>= 1 ? option_strings
[0] : NULL
;
406 const char *file_string
= arg_cnt
== 2 ? option_strings
[1] : NULL
;
408 assert (color_string
);
410 if (streq (color_string
, "-"))
413 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen cannot be used as color string");
415 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen must be preceeded by color string");
418 ret
= stat (color_string
, &sb
);
420 /* Ensure that we don't fail if there's a file with one or more
421 color names in its path. */
426 const char *color
= color_string
;
428 for (c
= 1; c
<= 2 && *color
; c
++)
430 bool matched
= false;
432 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
434 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
436 if ((p
= strstr (color
, entry
->name
)) && p
== color
)
438 color
= p
+ strlen (entry
->name
);
443 if (matched
&& *color
== COLOR_SEP_CHAR
&& *(color
+ 1))
449 have_file
= (*color
!= '\0');
454 vfprintf_fail (formats
[FMT_GENERIC
], "file cannot be used as color string");
456 vfprintf_fail (formats
[FMT_GENERIC
], "file must be preceeded by color string");
460 if ((p
= strchr (color_string
, COLOR_SEP_CHAR
)))
462 if (p
== color_string
)
463 vfprintf_fail (formats
[FMT_GENERIC
], "foreground color missing");
464 else if (p
== color_string
+ strlen (color_string
) - 1)
465 vfprintf_fail (formats
[FMT_GENERIC
], "background color missing");
466 else if (strchr (++p
, COLOR_SEP_CHAR
))
467 vfprintf_fail (formats
[FMT_GENERIC
], "one color pair allowed only");
470 str
= xstrdup (color_string
);
473 for (index
= 0, color
= str
; *color
; index
++, color
= p
)
476 if ((sep
= strchr (color
, COLOR_SEP_CHAR
)))
482 p
= color
+ strlen (color
);
484 for (ch
= color
; *ch
; ch
++)
486 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be made of non-alphabetic characters");
488 for (ch
= color
+ 1; *ch
; ch
++)
490 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be in mixed lower/upper case");
492 if (streq (color
, "None"))
493 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be bold");
495 if (isupper (*color
))
503 vfprintf_fail (formats
[FMT_COLOR
], tables
[BACKGROUND
].desc
, color
, "cannot be bold");
505 default: /* never reached */
510 color_names
[index
] = xmalloc (sizeof (struct color_name
));
512 color_names
[index
]->orig
= xstrdup (color
);
514 for (ch
= color
; *ch
; ch
++)
517 color_names
[index
]->name
= xstrdup (color
);
522 assert (color_names
[FOREGROUND
]);
524 if (color_names
[BACKGROUND
])
527 unsigned int color_sets
[2][2] = { { FOREGROUND
, BACKGROUND
}, { BACKGROUND
, FOREGROUND
} };
528 for (i
= 0; i
< 2; i
++)
530 unsigned int color1
= color_sets
[i
][0];
531 unsigned int color2
= color_sets
[i
][1];
532 if (CHECK_COLORS_RANDOM (color1
, color2
))
533 vfprintf_fail (formats
[FMT_RANDOM
], tables
[color1
].desc
, color_names
[color1
]->orig
, "cannot be combined with", color_names
[color2
]->orig
);
537 find_color_entries (color_names
, colors
);
538 free_color_names (color_names
);
540 if (!colors
[FOREGROUND
]->code
&& colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
541 find_color_entry ("default", FOREGROUND
, colors
);
543 process_file_option (file_string
, file
, stream
);
547 process_file_option (const char *file_string
, const char **file
, FILE **stream
)
551 if (streq (file_string
, "-"))
556 const char *file
= file_string
;
561 ret
= stat (file
, &sb
);
564 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
566 if (!(S_ISREG (sb
.st_mode
) || S_ISLNK (sb
.st_mode
) || S_ISFIFO (sb
.st_mode
)))
567 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized file type");
571 s
= fopen (file
, "r");
573 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
587 #define MERGE_PRINT_LINE(part_line, line, flags, check_eof) do { \
588 char *current_line, *merged_line = NULL; \
591 merged_line = str_concat (part_line, line); \
592 free_null (part_line); \
594 current_line = merged_line ? merged_line : (char *)line; \
595 if (!check_eof || *current_line != '\0') \
596 print_line (colors, bold, current_line, flags); \
597 free (merged_line); \
601 read_print_stream (bool bold
, const struct color
**colors
, const char *file
, FILE *stream
, enum stream_mode mode
)
603 char buf
[BUF_SIZE
], *part_line
= NULL
;
604 unsigned int flags
= 0;
605 bool first
= false, always
= false;
615 default: /* never reached */
619 while (!feof (stream
))
624 memset (buf
, '\0', BUF_SIZE
);
625 bytes_read
= fread (buf
, 1, BUF_SIZE
- 1, stream
);
626 if (bytes_read
!= (BUF_SIZE
- 1) && ferror (stream
))
627 vfprintf_fail (formats
[FMT_ERROR
], BUF_SIZE
- 1, "read");
629 LOOP
: while ((eol
= strpbrk (line
, "\n\r")))
639 if (*(eol
+ 1) == '\n')
642 else if (*eol
== '\n')
645 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized line ending");
648 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
652 unsigned int count
= sizeof (endings
) / sizeof (struct ending
);
653 for (i
= 0; i
< count
; i
++)
655 if (flags
& endings
[i
].flags
)
658 if ((p
= strstr (eol
, endings
[i
].newline
)) && p
== eol
)
667 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
670 MERGE_PRINT_LINE (part_line
, line
, flags
, false);
674 MERGE_PRINT_LINE (part_line
, line
, 0, true);
678 if (!clean
) /* efficiency */
679 print_line (colors
, bold
, line
, 0);
681 part_line
= xstrdup (line
);
684 char *merged_line
= str_concat (part_line
, line
);
686 part_line
= merged_line
;
693 find_color_entries (struct color_name
**color_names
, const struct color
**colors
)
699 gettimeofday (&tv
, NULL
);
700 srand (tv
.tv_usec
* tv
.tv_sec
);
702 for (index
= 0; color_names
[index
]; index
++)
704 const char *color_name
= color_names
[index
]->name
;
706 const unsigned int count
= tables
[index
].count
;
707 const struct color
*const color_entries
= tables
[index
].entries
;
709 if (streq (color_name
, "random"))
715 i
= rand() % (count
- 2) + 1; /* omit color none and default */
719 /* --exclude-random */
720 if (exclude
&& streq (exclude
, color_entries
[i
].name
))
722 else if (color_names
[BACKGROUND
] && streq (color_names
[BACKGROUND
]->name
, color_entries
[i
].name
))
726 if (streq (colors
[FOREGROUND
]->name
, color_entries
[i
].name
))
729 default: /* never reached */
732 } while (excludable
);
733 colors
[index
] = (struct color
*)&color_entries
[i
];
736 find_color_entry (color_name
, index
, colors
);
741 find_color_entry (const char *const color_name
, unsigned int index
, const struct color
**colors
)
746 const unsigned int count
= tables
[index
].count
;
747 const struct color
*const color_entries
= tables
[index
].entries
;
749 for (i
= 0; i
< count
; i
++)
750 if (streq (color_name
, color_entries
[i
].name
))
752 colors
[index
] = (struct color
*)&color_entries
[i
];
757 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color_name
, "not recognized");
761 print_line (const struct color
**colors
, bool bold
, const char *const line
, unsigned int flags
)
768 if (colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
769 printf ("\033[%s", colors
[BACKGROUND
]->code
);
770 if (colors
[FOREGROUND
]->code
)
771 printf ("\033[%s%s%s\033[0m", bold
? "1;" : "", colors
[FOREGROUND
]->code
, line
);
773 printf (formats
[FMT_GENERIC
], line
);
782 print_clean (const char *line
)
785 char ***offsets
= NULL
;
786 unsigned int count
= 0, i
= 0;
791 if (*p
== 27 && *(p
+ 1) == '[')
793 bool check_values
, first
= true;
794 const char *begin
= p
;
800 check_values
= false;
801 if (!first
&& !isdigit (*p
))
808 else /* check range */
813 const unsigned int digits
= p
- digit
;
814 for (i
= 0; i
< digits
; i
++)
818 if (!((value
>= 0 && value
<= 8) /* attributes */
819 || (value
>= 30 && value
<= 37) /* foreground colors */
820 || (value
>= 40 && value
<= 47) /* background colors */
821 || (value
== 39 || value
== 49))) /* default colors */
830 } while (check_values
);
833 const char *end
= p
++;
835 offsets
= xmalloc (++count
* sizeof (char **));
837 offsets
= xrealloc (offsets
, ++count
* sizeof (char **));
838 offsets
[i
] = xmalloc (2 * sizeof (char *));
839 offsets
[i
][0] = (char *)begin
; /* ESC */
840 offsets
[i
][1] = (char *)end
; /* m */
851 print_free_offsets (line
, offsets
, count
);
853 printf (formats
[FMT_GENERIC
], line
);
856 #define SET_CHAR(offset, new, old) \
860 #define RESTORE_CHAR(offset, old) \
864 print_free_offsets (const char *line
, char ***offsets
, unsigned int count
)
869 SET_CHAR (offsets
[0][0], '\0', &ch
);
870 printf (formats
[FMT_GENERIC
], line
);
871 RESTORE_CHAR (offsets
[0][0], ch
);
873 for (i
= 0; i
< count
; i
++)
876 bool next_offset
= false;
879 SET_CHAR (offsets
[i
+ 1][0], '\0', &ch
);
882 printf (formats
[FMT_GENERIC
], offsets
[i
][1] + 1);
884 RESTORE_CHAR (offsets
[i
+ 1][0], ch
);
886 for (i
= 0; i
< count
; i
++)
887 free_null (offsets
[i
]);
892 malloc_wrap (size_t size
)
894 void *p
= malloc (size
);
901 realloc_wrap (void *ptr
, size_t size
)
903 void *p
= realloc (ptr
, size
);
910 malloc_wrap_debug (size_t size
, const char *file
, unsigned int line
)
912 void *p
= malloc (size
);
914 MEM_ALLOC_FAIL_DEBUG (file
, line
);
919 realloc_wrap_debug (void *ptr
, size_t size
, const char *file
, unsigned int line
)
921 void *p
= realloc (ptr
, size
);
923 MEM_ALLOC_FAIL_DEBUG (file
, line
);
928 free_wrap (void **ptr
)
935 strdup_wrap (const char *str
)
937 const size_t len
= strlen (str
) + 1;
938 char *p
= xmalloc (len
);
939 strncpy (p
, str
, len
);
944 str_concat (const char *str1
, const char *str2
)
946 const size_t len
= strlen (str1
) + strlen (str2
) + 1;
949 p
= str
= xmalloc (len
);
950 strncpy (p
, str1
, strlen (str1
));
952 strncpy (p
, str2
, strlen (str2
));
960 vfprintf_fail (const char *fmt
, ...)
963 fprintf (stderr
, "%s: ", program_name
);
965 vfprintf (stderr
, fmt
, ap
);
967 fprintf (stderr
, "\n");
972 stack_var (void ***list
, unsigned int *stacked
, unsigned int index
, void *ptr
)
974 /* nothing to stack */
978 *list
= xmalloc (sizeof (void *));
982 for (i
= 0; i
< *stacked
; i
++)
988 *list
= xrealloc (*list
, (*stacked
+ 1) * sizeof (void *));
990 (*list
)[index
] = ptr
;
995 release_var (void **list
, unsigned int stacked
, void **ptr
)
998 /* nothing to release */
1001 for (i
= 0; i
< stacked
; i
++)
1002 if (list
[i
] == *ptr
)