]>
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>
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)
59 #if !defined BUF_SIZE || BUF_SIZE <= 0
61 # define BUF_SIZE 4096 + 1
67 #define SKIP_LINE_ENDINGS(flags) (((flags) & CR) && ((flags) & LF) ? 2 : 1)
69 #define STACK_VAR(ptr) do { \
70 stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
73 #define RELEASE_VAR(ptr) do { \
74 release_var (vars_list, stacked_vars, (void **)&ptr); \
77 #define MEM_ALLOC_FAIL_DEBUG(file, line) do { \
78 fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
81 #define MEM_ALLOC_FAIL() do { \
82 fprintf (stderr, "%s: memory allocation failure\n", program_name); \
86 #define ABORT_TRACE() \
87 fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
90 #define CHECK_COLORS_RANDOM(color1, color2) \
91 streq (color_names[color1]->name, "random") \
92 && (streq (color_names[color2]->name, "none") \
93 || streq (color_names[color2]->name, "default")) \
95 #define COLOR_SEP_CHAR '/'
97 #define VERSION "0.50"
99 typedef unsigned short bool;
101 enum { false, true };
108 static struct color_name
*color_names
[3] = { NULL
, NULL
, NULL
};
115 static const struct color fg_colors
[] = {
123 { "magenta", "36m" },
125 { "default", "39m" },
127 static const struct color bg_colors
[] = {
135 { "magenta", "46m" },
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 enum stream_mode
{ SCAN_FIRST
= 1, SCAN_ALWAYS
};
170 const char newline
[3];
173 static const struct ending endings
[] = {
179 static FILE *stream
= NULL
;
181 static unsigned int stacked_vars
= 0;
182 static void **vars_list
= NULL
;
184 static bool clean
= false;
185 static bool clean_all
= false;
187 static char *exclude
= NULL
;
189 static const char *program_name
;
191 static void print_help (void);
192 static void print_version (void);
193 static void cleanup (void);
194 static void free_color_names (struct color_name
**);
195 static void process_options (unsigned int, char **, bool *, const struct color
**, const char **, FILE **);
196 static void process_file_option (const char *, const char **, FILE **);
197 static void read_print_stream (bool, const struct color
**, const char *, FILE *, enum stream_mode
);
198 static void find_color_entries (struct color_name
**, const struct color
**);
199 static void find_color_entry (const char *const, unsigned int, const struct color
**);
200 static void print_line (const struct color
**, bool, const char * const, unsigned int);
201 static void print_clean (const char *);
202 static void print_free_offsets (const char *, char ***, unsigned int);
203 static void *malloc_wrap (size_t);
204 static void *calloc_wrap (size_t, size_t);
205 static void *realloc_wrap (void *, size_t);
206 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
207 static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
208 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
209 static void free_wrap (void **);
210 static char *strdup_wrap (const char *);
211 static char *str_concat (const char *, const char *);
212 static void vfprintf_fail (const char *, ...);
213 static void stack_var (void ***, unsigned int *, unsigned int, void *);
214 static void release_var (void **, unsigned int, void **);
216 #define SET_OPT_TYPE(type) \
225 main (int argc
, char **argv
)
227 unsigned int arg_cnt
= 0;
237 int opt
, opt_type
= 0;
238 struct option long_opts
[] = {
239 { "clean", no_argument
, &opt_type
, OPT_CLEAN
},
240 { "clean-all", no_argument
, &opt_type
, OPT_CLEAN_ALL
},
241 { "exclude-random", required_argument
, &opt_type
, OPT_EXCLUDE_RANDOM
},
242 { "help", no_argument
, &opt_type
, OPT_HELP
},
243 { "version", no_argument
, &opt_type
, OPT_VERSION
},
249 const struct color
*colors
[2] = {
250 NULL
, /* foreground */
251 NULL
, /* background */
256 enum stream_mode mode
= SCAN_FIRST
;
258 program_name
= argv
[0];
261 setvbuf (stdout
, NULL
, _IOLBF
, 0);
263 while ((opt
= getopt_long (argc
, argv
, "hv", long_opts
, NULL
)) != -1)
268 case 0: /* long opts */
277 case OPT_EXCLUDE_RANDOM
: {
279 exclude
= xstrdup (optarg
);
281 for (p
= exclude
; *p
; p
++)
283 if (streq (exclude
, "random"))
284 vfprintf_fail (formats
[FMT_GENERIC
], "--exclude-random switch must be provided a color");
293 default: /* never reached */
298 SET_OPT_TYPE (OPT_HELP
);
300 SET_OPT_TYPE (OPT_VERSION
);
304 default: /* never reached */
309 arg_cnt
= argc
- optind
;
311 if (clean
|| clean_all
)
313 if (clean
&& clean_all
)
314 vfprintf_fail (formats
[FMT_GENERIC
], "--clean and --clean-all switch are mutually exclusive");
317 const char *format
= "%s %s";
318 const char *message
= "switch cannot be used with more than one file";
320 vfprintf_fail (format
, "--clean", message
);
322 vfprintf_fail (format
, "--clean-all", message
);
327 if (arg_cnt
== 0 || arg_cnt
> 2)
334 if (clean
|| clean_all
)
335 process_file_option (argv
[optind
], &file
, &stream
);
337 process_options (arg_cnt
, &argv
[optind
], &bold
, colors
, &file
, &stream
);
338 read_print_stream (bold
, colors
, file
, stream
, mode
);
340 RELEASE_VAR (exclude
);
350 printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name
, COLOR_SEP_CHAR
);
351 printf ("\tColors (foreground) (background)\n");
352 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
354 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
355 const char *name
= entry
->name
;
356 const char *code
= entry
->code
;
358 printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
359 code
, toupper (*name
), *name
, name
+ 1, 10 - (int)strlen (name
), " ", name
);
361 printf ("\t\t{-} %s%*s%s\n", name
, 13 - (int)strlen (name
), " ", name
);
363 printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
365 printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
366 printf ("\twhereas for lower case colors will be of normal intensity.\n");
368 printf ("\n\tOptions\n");
369 printf ("\t\t --clean\n");
370 printf ("\t\t --clean-all\n");
371 printf ("\t\t --exclude-random\n");
372 printf ("\t\t-h, --help\n");
373 printf ("\t\t-v, --version\n\n");
380 printf ("%s v%s (compiled at %s, %s)\n", "colorize", VERSION
, __DATE__
, __TIME__
);
382 c_flags
= to_str (CFLAGS
);
386 printf ("Compiler flags: %s\n", c_flags
);
387 printf ("Buffer size: %u bytes\n", BUF_SIZE
- 1);
393 free_color_names (color_names
);
395 if (stream
&& fileno (stream
) != STDIN_FILENO
)
401 for (i
= 0; i
< stacked_vars
; i
++)
403 free_null (vars_list
[i
]);
405 free_null (vars_list
);
410 free_color_names (struct color_name
**color_names
)
413 for (i
= 0; color_names
[i
]; i
++)
415 free_null (color_names
[i
]->name
);
416 free_null (color_names
[i
]->orig
);
417 free_null (color_names
[i
]);
422 process_options (unsigned int arg_cnt
, char **option_strings
, bool *bold
, const struct color
**colors
, const char **file
, FILE **stream
)
426 char *color
, *p
, *str
;
429 const char *color_string
= arg_cnt
>= 1 ? option_strings
[0] : NULL
;
430 const char *file_string
= arg_cnt
== 2 ? option_strings
[1] : NULL
;
432 assert (color_string
);
434 if (streq (color_string
, "-"))
437 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen cannot be used as color string");
439 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen must be preceeded by color string");
442 ret
= stat (color_string
, &sb
);
444 /* Ensure that we don't fail if there's a file with one or more
445 color names in its path. */
450 const char *color
= color_string
;
452 for (c
= 1; c
<= 2 && *color
; c
++)
454 bool matched
= false;
456 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
458 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
460 if ((p
= strstr (color
, entry
->name
)) && p
== color
)
462 color
= p
+ strlen (entry
->name
);
467 if (matched
&& *color
== COLOR_SEP_CHAR
&& *(color
+ 1))
473 have_file
= (*color
!= '\0');
478 vfprintf_fail (formats
[FMT_GENERIC
], "file cannot be used as color string");
480 vfprintf_fail (formats
[FMT_GENERIC
], "file must be preceeded by color string");
484 if ((p
= strchr (color_string
, COLOR_SEP_CHAR
)))
486 if (p
== color_string
)
487 vfprintf_fail (formats
[FMT_GENERIC
], "foreground color missing");
488 else if (p
== color_string
+ strlen (color_string
) - 1)
489 vfprintf_fail (formats
[FMT_GENERIC
], "background color missing");
490 else if (strchr (++p
, COLOR_SEP_CHAR
))
491 vfprintf_fail (formats
[FMT_GENERIC
], "one color pair allowed only");
494 str
= xstrdup (color_string
);
497 for (index
= 0, color
= str
; *color
; index
++, color
= p
)
500 if ((sep
= strchr (color
, COLOR_SEP_CHAR
)))
506 p
= color
+ strlen (color
);
508 for (ch
= color
; *ch
; ch
++)
510 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be made of non-alphabetic characters");
512 for (ch
= color
+ 1; *ch
; ch
++)
514 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be in mixed lower/upper case");
516 if (streq (color
, "None"))
517 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be bold");
519 if (isupper (*color
))
527 vfprintf_fail (formats
[FMT_COLOR
], tables
[BACKGROUND
].desc
, color
, "cannot be bold");
529 default: /* never reached */
534 color_names
[index
] = xcalloc (1, sizeof (struct color_name
));
536 color_names
[index
]->orig
= xstrdup (color
);
538 for (ch
= color
; *ch
; ch
++)
541 color_names
[index
]->name
= xstrdup (color
);
546 assert (color_names
[FOREGROUND
]);
548 if (color_names
[BACKGROUND
])
551 unsigned int color_sets
[2][2] = { { FOREGROUND
, BACKGROUND
}, { BACKGROUND
, FOREGROUND
} };
552 for (i
= 0; i
< 2; i
++)
554 unsigned int color1
= color_sets
[i
][0];
555 unsigned int color2
= color_sets
[i
][1];
556 if (CHECK_COLORS_RANDOM (color1
, color2
))
557 vfprintf_fail (formats
[FMT_RANDOM
], tables
[color1
].desc
, color_names
[color1
]->orig
, "cannot be combined with", color_names
[color2
]->orig
);
561 find_color_entries (color_names
, colors
);
562 free_color_names (color_names
);
564 if (!colors
[FOREGROUND
]->code
&& colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
565 find_color_entry ("default", FOREGROUND
, colors
);
567 process_file_option (file_string
, file
, stream
);
571 process_file_option (const char *file_string
, const char **file
, FILE **stream
)
575 if (streq (file_string
, "-"))
580 const char *file
= file_string
;
585 ret
= stat (file
, &sb
);
588 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
590 if (!(S_ISREG (sb
.st_mode
) || S_ISLNK (sb
.st_mode
) || S_ISFIFO (sb
.st_mode
)))
591 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized file type");
595 s
= fopen (file
, "r");
597 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
611 #define MERGE_PRINT_LINE(part_line, line, flags, check_eof) do { \
612 char *current_line, *merged_line = NULL; \
615 merged_line = str_concat (part_line, line); \
616 free_null (part_line); \
618 current_line = merged_line ? merged_line : (char *)line; \
619 if (!check_eof || *current_line != '\0') \
620 print_line (colors, bold, current_line, flags); \
621 free (merged_line); \
625 read_print_stream (bool bold
, const struct color
**colors
, const char *file
, FILE *stream
, enum stream_mode mode
)
627 char buf
[BUF_SIZE
], *part_line
= NULL
;
628 unsigned int flags
= 0;
629 bool first
= false, always
= false;
639 default: /* never reached */
643 while (!feof (stream
))
648 memset (buf
, '\0', BUF_SIZE
);
649 bytes_read
= fread (buf
, 1, BUF_SIZE
- 1, stream
);
650 if (bytes_read
!= (BUF_SIZE
- 1) && ferror (stream
))
651 vfprintf_fail (formats
[FMT_ERROR
], BUF_SIZE
- 1, "read");
653 LOOP
: 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");
672 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
676 unsigned int count
= sizeof (endings
) / sizeof (struct ending
);
677 for (i
= 0; i
< count
; i
++)
679 if (flags
& endings
[i
].flags
)
682 if ((p
= strstr (eol
, endings
[i
].newline
)) && p
== eol
)
691 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
694 MERGE_PRINT_LINE (part_line
, line
, flags
, false);
698 MERGE_PRINT_LINE (part_line
, line
, 0, true);
702 if (!clean
&& !clean_all
) /* efficiency */
703 print_line (colors
, bold
, line
, 0);
705 part_line
= xstrdup (line
);
708 char *merged_line
= str_concat (part_line
, line
);
710 part_line
= merged_line
;
717 find_color_entries (struct color_name
**color_names
, const struct color
**colors
)
723 gettimeofday (&tv
, NULL
);
724 srand (tv
.tv_usec
* tv
.tv_sec
);
726 for (index
= 0; color_names
[index
]; index
++)
728 const char *color_name
= color_names
[index
]->name
;
730 const unsigned int count
= tables
[index
].count
;
731 const struct color
*const color_entries
= tables
[index
].entries
;
733 if (streq (color_name
, "random"))
739 i
= rand() % (count
- 2) + 1; /* omit color none and default */
743 /* --exclude-random */
744 if (exclude
&& streq (exclude
, color_entries
[i
].name
))
746 else if (color_names
[BACKGROUND
] && streq (color_names
[BACKGROUND
]->name
, color_entries
[i
].name
))
750 if (streq (colors
[FOREGROUND
]->name
, color_entries
[i
].name
))
753 default: /* never reached */
756 } while (excludable
);
757 colors
[index
] = (struct color
*)&color_entries
[i
];
760 find_color_entry (color_name
, index
, colors
);
765 find_color_entry (const char *const color_name
, unsigned int index
, const struct color
**colors
)
770 const unsigned int count
= tables
[index
].count
;
771 const struct color
*const color_entries
= tables
[index
].entries
;
773 for (i
= 0; i
< count
; i
++)
774 if (streq (color_name
, color_entries
[i
].name
))
776 colors
[index
] = (struct color
*)&color_entries
[i
];
781 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color_name
, "not recognized");
785 print_line (const struct color
**colors
, bool bold
, const char *const line
, unsigned int flags
)
788 if (clean
|| clean_all
)
792 /* Foreground color code is guaranteed to be set when background color code is present. */
793 if (colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
794 printf ("\033[%s", colors
[BACKGROUND
]->code
);
795 if (colors
[FOREGROUND
]->code
)
796 printf ("\033[%s%s%s\033[0m", bold
? "1;" : "", colors
[FOREGROUND
]->code
, line
);
798 printf (formats
[FMT_GENERIC
], line
);
807 print_clean (const char *line
)
810 char ***offsets
= NULL
;
811 unsigned int count
= 0, i
= 0;
816 if (*p
== 27 && *(p
+ 1) == '[')
818 const char *begin
= p
;
822 while (isdigit (*p
) || *p
== ';')
827 bool check_values
, first
= true;
832 check_values
= false;
833 if (!first
&& !isdigit (*p
))
840 else /* check range */
845 const unsigned int digits
= p
- digit
;
846 for (i
= 0; i
< digits
; i
++)
850 if (!((value
== 0 || value
== 1) /* attributes */
851 || (value
>= 30 && value
<= 37) /* foreground colors */
852 || (value
>= 40 && value
<= 47) /* background colors */
853 || (value
== 39 || value
== 49))) /* default colors */
862 } while (check_values
);
866 const char *end
= p
++;
868 offsets
= xmalloc (++count
* sizeof (char **));
870 offsets
= xrealloc (offsets
, ++count
* sizeof (char **));
871 offsets
[i
] = xmalloc (2 * sizeof (char *));
872 offsets
[i
][0] = (char *)begin
; /* ESC */
873 offsets
[i
][1] = (char *)end
; /* m */
884 print_free_offsets (line
, offsets
, count
);
886 printf (formats
[FMT_GENERIC
], line
);
889 #define SET_CHAR(offset, new, old) \
893 #define RESTORE_CHAR(offset, old) \
897 print_free_offsets (const char *line
, char ***offsets
, unsigned int count
)
902 SET_CHAR (offsets
[0][0], '\0', &ch
);
903 printf (formats
[FMT_GENERIC
], line
);
904 RESTORE_CHAR (offsets
[0][0], ch
);
906 for (i
= 0; i
< count
; i
++)
909 bool next_offset
= false;
912 SET_CHAR (offsets
[i
+ 1][0], '\0', &ch
);
915 printf (formats
[FMT_GENERIC
], offsets
[i
][1] + 1);
917 RESTORE_CHAR (offsets
[i
+ 1][0], ch
);
919 for (i
= 0; i
< count
; i
++)
920 free_null (offsets
[i
]);
925 malloc_wrap (size_t size
)
927 void *p
= malloc (size
);
934 calloc_wrap (size_t nmemb
, size_t size
)
936 void *p
= calloc (nmemb
, size
);
943 realloc_wrap (void *ptr
, size_t size
)
945 void *p
= realloc (ptr
, size
);
952 malloc_wrap_debug (size_t size
, const char *file
, unsigned int line
)
954 void *p
= malloc (size
);
956 MEM_ALLOC_FAIL_DEBUG (file
, line
);
961 calloc_wrap_debug (size_t nmemb
, size_t size
, const char *file
, unsigned int line
)
963 void *p
= calloc (nmemb
, size
);
965 MEM_ALLOC_FAIL_DEBUG (file
, line
);
970 realloc_wrap_debug (void *ptr
, size_t size
, const char *file
, unsigned int line
)
972 void *p
= realloc (ptr
, size
);
974 MEM_ALLOC_FAIL_DEBUG (file
, line
);
979 free_wrap (void **ptr
)
986 strdup_wrap (const char *str
)
988 const size_t len
= strlen (str
) + 1;
989 char *p
= xmalloc (len
);
990 strncpy (p
, str
, len
);
995 str_concat (const char *str1
, const char *str2
)
997 const size_t len
= strlen (str1
) + strlen (str2
) + 1;
1000 p
= str
= xmalloc (len
);
1001 strncpy (p
, str1
, strlen (str1
));
1003 strncpy (p
, str2
, strlen (str2
));
1011 vfprintf_fail (const char *fmt
, ...)
1014 fprintf (stderr
, "%s: ", program_name
);
1016 vfprintf (stderr
, fmt
, ap
);
1018 fprintf (stderr
, "\n");
1019 exit (EXIT_FAILURE
);
1023 stack_var (void ***list
, unsigned int *stacked
, unsigned int index
, void *ptr
)
1025 /* nothing to stack */
1029 *list
= xmalloc (sizeof (void *));
1033 for (i
= 0; i
< *stacked
; i
++)
1037 return; /* reused */
1039 *list
= xrealloc (*list
, (*stacked
+ 1) * sizeof (void *));
1041 (*list
)[index
] = ptr
;
1046 release_var (void **list
, unsigned int stacked
, void **ptr
)
1049 /* nothing to release */
1052 for (i
= 0; i
< stacked
; i
++)
1053 if (list
[i
] == *ptr
)