]>
git.refcnt.org Git - colorize.git/blob - colorize.c
9a6a6f9d69ac26e2ef023a007038ddfba6026ebe
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-2019 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 _DEFAULT_SOURCE
24 #define _XOPEN_SOURCE 700
25 #define _FILE_OFFSET_BITS 64
36 #include <sys/types.h>
47 #define to_str(arg) str(arg)
49 #define streq(s1, s2) (strcmp (s1, s2) == 0)
50 #define strneq(s1, s2, n) (strncmp (s1, s2, n) == 0)
53 # define xmalloc(size) malloc_wrap(size)
54 # define xcalloc(nmemb, size) calloc_wrap(nmemb, size)
55 # define xrealloc(ptr, size) realloc_wrap(ptr, size)
56 # define xstrdup(str) strdup_wrap(str, NULL, 0)
57 # define str_concat(str1, str2) str_concat_wrap(str1, str2, NULL, 0)
59 # define xmalloc(size) malloc_wrap_debug(size, __FILE__, __LINE__)
60 # define xcalloc(nmemb, size) calloc_wrap_debug(nmemb, size, __FILE__, __LINE__)
61 # define xrealloc(ptr, size) realloc_wrap_debug(ptr, size, __FILE__, __LINE__)
62 # define xstrdup(str) strdup_wrap(str, __FILE__, __LINE__)
63 # define str_concat(str1, str2) str_concat_wrap(str1, str2, __FILE__, __LINE__)
66 #define free_null(ptr) free_wrap((void **)&ptr)
68 #if defined(BUF_SIZE) && (BUF_SIZE <= 0 || BUF_SIZE > 65536)
72 # define BUF_SIZE 4096
78 #define COUNT_OF(obj, type) (sizeof (obj) / sizeof (type))
80 #define SKIP_LINE_ENDINGS(flags) ((flags) == (CR|LF) ? 2 : 1)
82 #define VALID_FILE_TYPE(mode) (S_ISREG (mode) || S_ISLNK (mode) || S_ISFIFO (mode))
84 #define STACK_VAR(ptr) do { \
85 stack (&vars_list, &stacked_vars, stacked_vars, ptr, IS_GENERIC); \
87 #define STACK_FILE(ptr) do { \
88 stack (&vars_list, &stacked_vars, stacked_vars, ptr, IS_FILE); \
90 #define RELEASE(ptr) do { \
91 release (vars_list, stacked_vars, (void **)&ptr); \
95 # define MEM_ALLOC_FAIL() do { \
96 fprintf (stderr, "%s: memory allocation failure\n", program_name); \
97 exit (EXIT_FAILURE); \
100 # define MEM_ALLOC_FAIL_DEBUG(file, line) do { \
101 fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
102 exit (EXIT_FAILURE); \
106 #define ABORT_TRACE() \
107 fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
110 #define CHECK_COLORS_RANDOM(color1, color2) \
111 streq (color_names[color1]->name, "random") \
112 && (streq (color_names[color2]->name, "none") \
113 || streq (color_names[color2]->name, "default"))
115 #define ALLOC_COMPLETE_PART_LINE 8
117 #if defined(COLOR_SEP_CHAR_COLON)
118 # define COLOR_SEP_CHAR ':'
119 #elif defined(COLOR_SEP_CHAR_SLASH)
120 # define COLOR_SEP_CHAR '/'
122 # define COLOR_SEP_CHAR '/'
125 #define CONF_FILE ".colorize.conf"
128 # define DEBUG_FILE "debug.txt"
131 #define MAX_ATTRIBUTE_CHARS (6 * 2)
133 #define PROGRAM_NAME "colorize"
135 #define VERSION "0.65"
137 typedef enum { false, true } bool;
142 char *exclude_random
;
143 char *omit_color_empty
;
146 enum { DESC_OPTION
, DESC_CONF
};
158 static const struct color fg_colors
[] = {
165 { "magenta", "35m" },
168 { "default", "39m" },
170 static const struct color bg_colors
[] = {
177 { "magenta", "45m" },
180 { "default", "49m" },
200 static const char *formats
[] = {
202 "%s '%s'", /* string */
203 "%s `%s' %s", /* quote */
204 "%s color '%s' %s", /* color */
205 "%s color '%s' %s '%s'", /* random */
206 "less than %lu bytes %s", /* error */
208 "%s: %s: %s", /* type */
209 "%s: option '%s' %s", /* conf */
210 "config file %s: %s" /* conf file */
213 enum { GENERIC
, FOREGROUND
= 0, BACKGROUND
};
215 static const struct {
216 const struct color
*entries
;
220 { fg_colors
, COUNT_OF (fg_colors
, struct color
), "foreground" },
221 { bg_colors
, COUNT_OF (bg_colors
, struct color
), "background" },
224 static unsigned int opts_set
;
227 OPT_EXCLUDE_RANDOM_SET
= 0x02,
228 OPT_OMIT_COLOR_EMPTY_SET
= 0x04
232 char *exclude_random
;
233 } opts_arg
= { NULL
, NULL
};
241 OPT_OMIT_COLOR_EMPTY
,
246 static const struct option long_opts
[] = {
247 { "attr", required_argument
, &opt_type
, OPT_ATTR
},
248 { "clean", no_argument
, &opt_type
, OPT_CLEAN
},
249 { "clean-all", no_argument
, &opt_type
, OPT_CLEAN_ALL
},
250 { "config", required_argument
, &opt_type
, OPT_CONFIG
},
251 { "exclude-random", required_argument
, &opt_type
, OPT_EXCLUDE_RANDOM
},
252 { "omit-color-empty", no_argument
, &opt_type
, OPT_OMIT_COLOR_EMPTY
},
253 { "help", no_argument
, &opt_type
, OPT_HELP
},
254 { "version", no_argument
, &opt_type
, OPT_VERSION
},
255 { NULL
, 0, NULL
, 0 },
260 ATTR_UNDERSCORE
= 0x02,
263 ATTR_CONCEALED
= 0x10
286 static unsigned int stacked_vars
;
287 static struct var_list
*vars_list
;
290 static bool clean_all
;
291 static bool omit_color_empty
;
293 static char attr
[MAX_ATTRIBUTE_CHARS
+ 1];
294 static char *exclude
;
296 static const char *program_name
;
299 static void print_tstamp (FILE *);
301 static void process_opts (int, char **, char **);
302 static void conf_file_path (char **);
303 static void process_opt_attr (const char *, const bool);
304 static void write_attr (const struct attr
*, unsigned int *, const bool);
305 static void process_opt_exclude_random (const char *, const bool);
306 static void parse_conf (const char *, struct conf
*);
307 static void assign_conf (const char *, struct conf
*, const char *, char *);
308 static void init_conf_vars (const struct conf
*);
309 static void init_opts_vars (void);
310 static void print_hint (void);
311 static void print_help (void);
312 static void print_version (void);
313 static void cleanup (void);
314 static void free_color_names (struct color_name
**);
315 static void free_conf (struct conf
*);
316 static void process_args (unsigned int, char **, char *, const struct color
**, const char **, FILE **, struct conf
*);
317 static void process_file_arg (const char *, const char **, FILE **);
318 static bool skip_path_colors (const char *, const char *, const struct stat
*, const bool);
319 static void gather_color_names (const char *, char *, struct color_name
**);
320 static void read_print_stream (const char *, const struct color
**, const char *, FILE *);
321 static void merge_print_line (const char *, const char *, FILE *);
322 static void complete_part_line (const char *, char **, FILE *);
323 static bool get_next_char (char *, const char **, FILE *, bool *);
324 static void save_char (char, char **, size_t *, size_t *);
325 static void find_color_entries (struct color_name
**, const struct color
**);
326 static void find_color_entry (const struct color_name
*, unsigned int, const struct color
**);
327 static void print_line (const char *, const struct color
**, const char * const, unsigned int, bool);
328 static void print_clean (const char *);
329 static bool is_esc (const char *);
330 static const char *get_end_of_esc (const char *);
331 static const char *get_end_of_text (const char *);
332 static void print_text (const char *, size_t);
333 static bool gather_esc_offsets (const char *, const char **, const char **);
334 static bool validate_esc_clean_all (const char **);
335 static bool validate_esc_clean (int, unsigned int, unsigned int *, const char **, bool *);
336 static bool is_reset (int, unsigned int, const char **);
337 static bool is_attr (int, unsigned int, unsigned int, const char **);
338 static bool is_fg_color (int, const char **);
339 static bool is_bg_color (int, unsigned int, const char **);
341 static void *malloc_wrap (size_t);
342 static void *calloc_wrap (size_t, size_t);
343 static void *realloc_wrap (void *, size_t);
345 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
346 static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
347 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
349 static void free_wrap (void **);
350 static char *strdup_wrap (const char *, const char *, unsigned int);
351 static char *str_concat_wrap (const char *, const char *, const char *, unsigned int);
352 static char *expand_string (const char *);
353 static bool get_bytes_size (unsigned long, struct bytes_size
*);
354 static char *get_file_type (mode_t
);
355 static bool has_color_name (const char *, const char *);
356 static FILE *open_file (const char *, const char *);
357 static void vfprintf_diag (const char *, ...);
358 static void vfprintf_fail (const char *, ...);
359 static void stack (struct var_list
**, unsigned int *, unsigned int, void *, enum var_type
);
360 static void release (struct var_list
*, unsigned int, void **);
365 main (int argc
, char **argv
)
367 unsigned int arg_cnt
;
369 const struct color
*colors
[2] = {
370 NULL
, /* foreground */
371 NULL
, /* background */
374 const char *file
= NULL
;
376 char *conf_file
= NULL
;
377 struct conf config
= { NULL
, NULL
, NULL
, NULL
};
379 program_name
= argv
[0];
382 setvbuf (stdout
, NULL
, _IOLBF
, 0);
385 log
= open_file (DEBUG_FILE
, "w");
387 /* We're in debugging mode, hence we can't invoke STACK_FILE()
388 prior to print_tstamp(), because both cause text to be written
389 to the same logfile which is expected to have the timestamp
396 process_opts (argc
, argv
, &conf_file
);
398 #ifdef CONF_FILE_TEST
399 conf_file
= to_str (CONF_FILE_TEST
);
401 if (conf_file
== NULL
)
403 conf_file_path (&conf_file
);
404 STACK_VAR (conf_file
);
409 if ((s
= expand_string (conf_file
)))
414 STACK_VAR (conf_file
);
416 if (access (conf_file
, F_OK
) == -1)
417 vfprintf_fail (formats
[FMT_CONF_FILE
], conf_file
, strerror (errno
));
420 #if defined(CONF_FILE_TEST) || !defined(TEST)
421 if (access (conf_file
, F_OK
) != -1)
422 parse_conf (conf_file
, &config
);
424 #if !defined(CONF_FILE_TEST) && !defined(TEST)
427 init_conf_vars (&config
);
431 arg_cnt
= argc
- optind
;
433 if (clean
|| clean_all
)
435 if (clean
&& clean_all
)
436 vfprintf_fail (formats
[FMT_GENERIC
], "--clean and --clean-all switch are mutually exclusive");
438 vfprintf_fail ("--clean%s switch cannot be used with more than one file", clean_all
? "-all" : "");
441 const struct option_set
{
445 { "attr", OPT_ATTR_SET
},
446 { "exclude-random", OPT_EXCLUDE_RANDOM_SET
},
447 { "omit-color-empty", OPT_OMIT_COLOR_EMPTY_SET
},
449 for (i
= 0; i
< COUNT_OF (options
, struct option_set
); i
++)
450 if (opts_set
& options
[i
].set
)
451 vfprintf_diag ("--%s switch has no meaning with --clean%s", options
[i
].option
, clean_all
? "-all" : "");
456 if (arg_cnt
== 0 || arg_cnt
> 2)
458 vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt
);
464 if (clean
|| clean_all
)
465 process_file_arg (argv
[optind
], &file
, &stream
);
467 process_args (arg_cnt
, &argv
[optind
], &attr
[0], colors
, &file
, &stream
, &config
);
468 read_print_stream (&attr
[0], colors
, file
, stream
);
479 print_tstamp (FILE *log
)
490 perror ("localtime");
493 written
= strftime (str
, sizeof (str
), "%Y-%m-%d %H:%M:%S %Z", tm
);
495 vfprintf_fail (formats
[FMT_GENERIC
], "strftime: 0 returned");
497 fprintf (log
, "%s\n", str
);
504 #define DUP_CONFIG() \
505 *conf_file = xstrdup (optarg); \
508 #define PRINT_HELP_EXIT() \
512 #define PRINT_VERSION_EXIT() \
519 process_opts (int argc
, char **argv
, char **conf_file
)
522 while ((opt
= getopt_long (argc
, argv
, "c:hV", long_opts
, NULL
)) != -1)
526 case 0: /* long opts */
530 opts_set
|= OPT_ATTR_SET
;
531 opts_arg
.attr
= xstrdup (optarg
);
532 STACK_VAR (opts_arg
.attr
);
542 case OPT_EXCLUDE_RANDOM
:
543 opts_set
|= OPT_EXCLUDE_RANDOM_SET
;
544 opts_arg
.exclude_random
= xstrdup (optarg
);
545 STACK_VAR (opts_arg
.exclude_random
);
547 case OPT_OMIT_COLOR_EMPTY
:
548 opts_set
|= OPT_OMIT_COLOR_EMPTY_SET
;
553 PRINT_VERSION_EXIT ();
554 default: /* never reached */
563 PRINT_VERSION_EXIT ();
567 default: /* never reached */
574 conf_file_path (char **conf_file
)
578 struct passwd
*passwd
;
583 if ((passwd
= getpwuid (uid
)) == NULL
)
586 vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid
);
591 size
= strlen (passwd
->pw_dir
) + 1 + strlen (CONF_FILE
) + 1;
592 path
= xmalloc (size
);
593 snprintf (path
, size
, "%s/%s", passwd
->pw_dir
, CONF_FILE
);
599 process_opt_attr (const char *p
, const bool is_opt
)
601 /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */
602 const struct attr attrs
[] = {
603 { "bold", 1, ATTR_BOLD
},
604 { "underscore", 4, ATTR_UNDERSCORE
},
605 { "blink", 5, ATTR_BLINK
},
606 { "reverse", 7, ATTR_REVERSE
},
607 { "concealed", 8, ATTR_CONCEALED
},
609 unsigned int attr_types
= 0;
610 const char *desc_type
[2] = { "--attr switch", "attr conf option" };
611 const unsigned int DESC_TYPE
= is_opt
? DESC_OPTION
: DESC_CONF
;
617 vfprintf_fail ("%s must be provided a string", desc_type
[DESC_TYPE
]);
621 if (*p
!= '\0' && *p
!= ',')
622 vfprintf_fail ("%s must have strings separated by ,", desc_type
[DESC_TYPE
]);
625 bool valid_attr
= false;
627 for (i
= 0; i
< COUNT_OF (attrs
, struct attr
); i
++)
629 const size_t name_len
= strlen (attrs
[i
].name
);
630 if ((size_t)(p
- s
) == name_len
&& strneq (s
, attrs
[i
].name
, name_len
))
632 write_attr (&attrs
[i
], &attr_types
, is_opt
);
639 char *attr_invalid
= xmalloc ((p
- s
) + 1);
640 STACK_VAR (attr_invalid
);
641 strncpy (attr_invalid
, s
, p
- s
);
642 attr_invalid
[p
- s
] = '\0';
643 vfprintf_fail ("%s attribute '%s' is not valid", desc_type
[DESC_TYPE
], attr_invalid
);
644 RELEASE (attr_invalid
); /* never reached */
653 write_attr (const struct attr
*attr_i
, unsigned int *attr_types
, const bool is_opt
)
655 const unsigned int val
= attr_i
->val
;
656 const enum attr_type attr_type
= attr_i
->type
;
657 const char *attr_name
= attr_i
->name
;
659 if (*attr_types
& attr_type
)
660 vfprintf_fail ("%s has attribute '%s' twice or more",
661 is_opt
? "--attr switch" : "attr conf option", attr_name
);
662 snprintf (attr
+ strlen (attr
), 3, "%u;", val
);
663 *attr_types
|= attr_type
;
667 process_opt_exclude_random (const char *s
, const bool is_opt
)
672 exclude
= xstrdup (s
);
674 for (i
= 1; i
< tables
[GENERIC
].count
- 1; i
++) /* skip color none and default */
676 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
677 if (streq (exclude
, entry
->name
))
684 vfprintf_fail ("%s must be provided a plain color",
685 is_opt
? "--exclude-random switch" : "exclude-random conf option");
689 init_opts_vars (void)
691 if (opts_set
& OPT_ATTR_SET
)
693 attr
[0] = '\0'; /* Clear attr string to discard values from the config file. */
694 process_opt_attr (opts_arg
.attr
, true);
696 if (opts_set
& OPT_EXCLUDE_RANDOM_SET
)
697 process_opt_exclude_random (opts_arg
.exclude_random
, true);
698 if (opts_set
& OPT_OMIT_COLOR_EMPTY_SET
)
699 omit_color_empty
= true;
701 RELEASE (opts_arg
.attr
);
702 RELEASE (opts_arg
.exclude_random
);
705 #define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
708 parse_conf (const char *conf_file
, struct conf
*config
)
710 unsigned int cnt
= 0;
714 conf
= open_file (conf_file
, "r");
717 while (fgets (line
, sizeof (line
), conf
))
720 char *assign
, *comment
, *opt
, *value
;
724 if ((p
= strchr (line
, '\r')) && *(p
+ 1) != '\n')
725 vfprintf_fail ("%s: CR ending of line %u is not supported, switch to CRLF/LF instead", conf_file
, cnt
);
726 if (strlen (line
) > (sizeof (line
) - 2))
727 vfprintf_fail ("%s: line %u exceeds maximum of %u characters", conf_file
, cnt
, (unsigned int)(sizeof (line
) - 2));
728 if ((p
= strpbrk (line
, "\n\r")))
730 /* NAME PARSING (start) */
732 /* skip leading spaces and tabs for name */
733 while (IS_SPACE (*p
))
735 /* skip line if a) string end, b) comment, [cd]) newline */
736 if (*p
== '\0' || *p
== '#' || *p
== '\n' || *p
== '\r')
739 if (!(assign
= strchr (opt
, '='))) /* check for = */
742 if ((s
= strpbrk (opt
, "# ")))
744 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "not followed by =");
747 /* skip trailing spaces and tabs for name */
748 while (IS_SPACE (*(p
- 1)))
751 /* NAME PARSING (end) */
752 /* NAME VALIDATION (start) */
753 for (p
= opt
; *p
; p
++)
754 if (!isalnum (*p
) && *p
!= '-')
755 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "cannot be made of non-option characters");
756 /* NAME VALIDATION (end) */
757 /* VALUE PARSING (start) */
759 /* skip leading spaces and tabs for value */
760 while (IS_SPACE (*p
))
762 /* skip line if comment */
766 if ((comment
= strchr (p
, '#')))
770 /* skip trailing spaces and tabs for value */
771 while (IS_SPACE (*(p
- 1)))
774 /* VALUE PARSING (end) */
776 /* save option name */
779 /* save option value (allow empty ones) */
780 val
= strlen (value
) ? xstrdup (value
) : NULL
;
783 assign_conf (conf_file
, config
, cfg
, val
);
790 #define ASSIGN_CONF(str,val) do { \
796 assign_conf (const char *conf_file
, struct conf
*config
, const char *cfg
, char *val
)
798 if (streq (cfg
, "attr"))
799 ASSIGN_CONF (config
->attr
, val
);
800 else if (streq (cfg
, "color"))
801 ASSIGN_CONF (config
->color
, val
);
802 else if (streq (cfg
, "exclude-random"))
803 ASSIGN_CONF (config
->exclude_random
, val
);
804 else if (streq (cfg
, "omit-color-empty"))
805 ASSIGN_CONF (config
->omit_color_empty
, val
);
807 vfprintf_fail (formats
[FMT_CONF
], conf_file
, cfg
, "not recognized");
811 init_conf_vars (const struct conf
*config
)
814 process_opt_attr (config
->attr
, false);
815 if (config
->exclude_random
)
816 process_opt_exclude_random (config
->exclude_random
, false);
817 if (config
->omit_color_empty
)
819 if (streq (config
->omit_color_empty
, "yes"))
820 omit_color_empty
= true;
821 else if (streq (config
->omit_color_empty
, "no"))
822 omit_color_empty
= false;
824 vfprintf_fail (formats
[FMT_GENERIC
], "omit-color-empty conf option is not valid");
831 fprintf (stderr
, "Type `%s --help' for help screen.\n", program_name
);
839 const char *short_opt
;
842 const struct opt_data opts_data
[] = {
843 { "attr", NULL
, "=ATTR1,ATTR2,..." },
844 { "config", "c", "=PATH" },
845 { "exclude-random", NULL
, "=COLOR" },
846 { "help", "h", NULL
},
847 { "version", "V", NULL
},
849 const struct option
*opt
= long_opts
;
852 printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name
, COLOR_SEP_CHAR
);
853 printf ("\tColors (foreground) (background)\n");
854 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
856 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
857 const char *name
= entry
->name
;
858 const char *code
= entry
->code
;
860 printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
861 code
, toupper (*name
), *name
, name
+ 1, 10 - (int)strlen (name
), " ", name
);
863 printf ("\t\t{-} %s%*s%s\n", name
, 13 - (int)strlen (name
), " ", name
);
865 printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
867 printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
868 printf ("\twhereas for lower case colors will be of normal intensity.\n");
870 printf ("\n\tOptions\n");
871 for (; opt
->name
; opt
++)
873 const struct opt_data
*opt_data
= NULL
;
875 for (i
= 0; i
< COUNT_OF (opts_data
, struct opt_data
); i
++)
876 if (streq (opt
->name
, opts_data
[i
].name
))
878 opt_data
= &opts_data
[i
];
883 if (opt_data
->short_opt
)
884 printf ("\t\t-%s, --%s", opt_data
->short_opt
, opt
->name
);
886 printf ("\t\t --%s", opt
->name
);
888 printf ("%s", opt_data
->arg
);
892 printf ("\t\t --%s\n", opt
->name
);
901 # include "version.h"
903 const char *const version
= NULL
;
905 const char *version_prefix
, *version_string
;
906 const char *c_flags
, *ld_flags
, *cpp_flags
;
907 const char *const desc_flags_unknown
= "unknown";
908 struct bytes_size bytes_size
;
911 c_flags
= to_str (CFLAGS
);
913 c_flags
= desc_flags_unknown
;
916 ld_flags
= to_str (LDFLAGS
);
918 ld_flags
= desc_flags_unknown
;
921 cpp_flags
= to_str (CPPFLAGS
);
923 cpp_flags
= desc_flags_unknown
;
930 version_prefix
= version
? "" : "v";
931 version_string
= version
? version
: VERSION
;
932 printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME
, version_prefix
, version_string
, __DATE__
, __TIME__
);
934 printf ("Compiler flags: %s\n", c_flags
);
935 printf ("Linker flags: %s\n", ld_flags
);
936 printf ("Preprocessor flags: %s\n", cpp_flags
);
937 if (get_bytes_size (BUF_SIZE
, &bytes_size
))
939 if (BUF_SIZE
% 1024 == 0)
940 printf ("Buffer size: %u%c\n", bytes_size
.size
, bytes_size
.unit
);
942 printf ("Buffer size: %u%c, %u byte%s\n", bytes_size
.size
, bytes_size
.unit
,
943 BUF_SIZE
% 1024, BUF_SIZE
% 1024 > 1 ? "s" : "");
946 printf ("Buffer size: %lu byte%s\n", (unsigned long)BUF_SIZE
, BUF_SIZE
> 1 ? "s" : "");
947 printf ("Color separator: '%c'\n", COLOR_SEP_CHAR
);
948 printf ("Debugging: %s\n", debug
? "yes" : "no");
954 if (stream
&& fileno (stream
) != STDIN_FILENO
)
964 for (i
= 0; i
< stacked_vars
; i
++)
966 struct var_list
*var
= &vars_list
[i
];
977 default: /* never reached */
981 free_null (vars_list
);
986 free_color_names (struct color_name
**color_names
)
989 for (i
= 0; color_names
[i
]; i
++)
991 RELEASE (color_names
[i
]->name
);
992 RELEASE (color_names
[i
]->orig
);
993 RELEASE (color_names
[i
]);
998 free_conf (struct conf
*config
)
1000 RELEASE (config
->attr
);
1001 RELEASE (config
->color
);
1002 RELEASE (config
->exclude_random
);
1003 RELEASE (config
->omit_color_empty
);
1007 process_args (unsigned int arg_cnt
, char **arg_strings
, char *attr
, const struct color
**colors
, const char **file
, FILE **stream
, struct conf
*config
)
1009 bool has_hyphen
, use_conf_color
;
1013 struct color_name
*color_names
[3] = {
1014 NULL
, /* foreground */
1015 NULL
, /* background */
1016 NULL
, /* sentinel value */
1019 const char *color_string
= arg_cnt
>= 1 ? arg_strings
[0] : NULL
;
1020 const char *file_string
= arg_cnt
== 2 ? arg_strings
[1] : NULL
;
1022 assert (color_string
!= NULL
);
1024 has_hyphen
= streq (color_string
, "-");
1029 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen cannot be used as color string");
1030 else if (!config
->color
)
1031 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen must be preceded by color string");
1034 if (!has_hyphen
&& (ret
= lstat (color_string
, &sb
)) == 0) /* exists */
1035 /* Ensure that we don't fail if there's a file with one or more
1036 color names in its path. */
1037 use_conf_color
= skip_path_colors (color_string
, file_string
, &sb
, !!config
->color
);
1038 else if (has_hyphen
)
1039 use_conf_color
= true;
1041 use_conf_color
= false;
1043 /* Use color from config file. */
1044 if (arg_cnt
== 1 && use_conf_color
)
1046 file_string
= color_string
;
1047 color_string
= config
->color
;
1050 if ((p
= strchr (color_string
, COLOR_SEP_CHAR
)))
1052 if (p
== color_string
)
1053 vfprintf_fail (formats
[FMT_STRING
], "foreground color missing in string", color_string
);
1054 else if (p
== color_string
+ strlen (color_string
) - 1)
1055 vfprintf_fail (formats
[FMT_STRING
], "background color missing in string", color_string
);
1056 else if (strchr (++p
, COLOR_SEP_CHAR
))
1057 vfprintf_fail (formats
[FMT_STRING
], "one color pair allowed only for string", color_string
);
1060 gather_color_names (color_string
, attr
, color_names
);
1062 assert (color_names
[FOREGROUND
] != NULL
);
1064 if (color_names
[BACKGROUND
])
1067 const unsigned int color_sets
[2][2] = { { FOREGROUND
, BACKGROUND
}, { BACKGROUND
, FOREGROUND
} };
1068 for (i
= 0; i
< 2; i
++)
1070 const unsigned int color1
= color_sets
[i
][0];
1071 const unsigned int color2
= color_sets
[i
][1];
1072 if (CHECK_COLORS_RANDOM (color1
, color2
))
1073 vfprintf_fail (formats
[FMT_RANDOM
], tables
[color1
].desc
, color_names
[color1
]->orig
, "cannot be combined with", color_names
[color2
]->orig
);
1077 find_color_entries (color_names
, colors
);
1078 assert (colors
[FOREGROUND
] != NULL
);
1079 free_color_names (color_names
);
1081 if (!colors
[FOREGROUND
]->code
&& colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1083 struct color_name color_name
;
1084 color_name
.name
= color_name
.orig
= "default";
1086 find_color_entry (&color_name
, FOREGROUND
, colors
);
1087 assert (colors
[FOREGROUND
]->code
!= NULL
);
1090 process_file_arg (file_string
, file
, stream
);
1094 process_file_arg (const char *file_string
, const char **file
, FILE **stream
)
1098 if (streq (file_string
, "-"))
1102 const char *file
= file_string
;
1107 ret
= stat (file
, &sb
);
1110 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1112 if (!VALID_FILE_TYPE (sb
.st_mode
))
1113 vfprintf_fail (formats
[FMT_TYPE
], file
, "unrecognized type", get_file_type (sb
.st_mode
));
1115 *stream
= open_file (file
, "r");
1116 STACK_FILE (*stream
);
1118 *file
= file_string
;
1126 assert (*stream
!= NULL
);
1127 assert (*file
!= NULL
);
1131 skip_path_colors (const char *color_string
, const char *file_string
, const struct stat
*sb
, const bool has_conf
)
1135 const char *color
= color_string
;
1136 const mode_t mode
= sb
->st_mode
;
1138 for (c
= 1; c
<= 2 && *color
; c
++)
1140 bool matched
= false;
1142 for (i
= 0; i
< tables
[GENERIC
].count
; i
++)
1144 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
1145 if (has_color_name (color
, entry
->name
))
1147 color
+= strlen (entry
->name
);
1152 if (!matched
&& has_color_name (color
, "random"))
1154 color
+= strlen ("random");
1157 if (matched
&& *color
== COLOR_SEP_CHAR
&& *(color
+ 1))
1163 have_file
= (*color
!= '\0');
1167 const char *file_existing
= color_string
;
1169 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "cannot be used as color string");
1172 if (VALID_FILE_TYPE (mode
))
1176 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "must be preceded by color string");
1179 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "is not a valid file type");
1186 gather_color_names (const char *color_string
, char *attr
, struct color_name
**color_names
)
1189 char *color
, *p
, *str
;
1191 str
= xstrdup (color_string
);
1194 for (index
= 0, color
= str
; *color
; index
++, color
= p
)
1199 if ((sep
= strchr (color
, COLOR_SEP_CHAR
)))
1205 p
= color
+ strlen (color
);
1208 for (ch
= color
; *ch
; ch
++)
1210 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be made of non-alphabetic characters");
1212 for (ch
= color
+ 1; *ch
; ch
++)
1214 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be in mixed lower/upper case");
1216 if (streq (color
, "None"))
1217 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be bold");
1219 if (isupper (*color
))
1224 snprintf (attr
+ strlen (attr
), 3, "1;");
1227 vfprintf_fail (formats
[FMT_COLOR
], tables
[BACKGROUND
].desc
, color
, "cannot be bold");
1229 default: /* never reached */
1234 color_names
[index
] = xcalloc (1, sizeof (struct color_name
));
1235 STACK_VAR (color_names
[index
]);
1237 color_names
[index
]->orig
= xstrdup (color
);
1238 STACK_VAR (color_names
[index
]->orig
);
1240 for (ch
= color
; *ch
; ch
++)
1241 *ch
= tolower (*ch
);
1243 color_names
[index
]->name
= xstrdup (color
);
1244 STACK_VAR (color_names
[index
]->name
);
1251 read_print_stream (const char *attr
, const struct color
**colors
, const char *file
, FILE *stream
)
1253 char buf
[BUF_SIZE
+ 1];
1254 unsigned int flags
= 0;
1256 while (!feof (stream
))
1261 bytes_read
= fread (buf
, 1, BUF_SIZE
, stream
);
1262 if (bytes_read
!= BUF_SIZE
&& ferror (stream
))
1263 vfprintf_fail (formats
[FMT_ERROR
], BUF_SIZE
, "read");
1264 buf
[bytes_read
] = '\0';
1266 while ((eol
= strpbrk (line
, "\n\r")))
1268 const bool has_text
= (eol
> line
);
1274 if (*(eol
+ 1) == '\n')
1277 else if (*eol
== '\n')
1279 else /* never reached */
1280 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized line ending");
1281 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
1283 print_line (attr
, colors
, line
, flags
,
1284 omit_color_empty
? has_text
: true);
1290 print_line (attr
, colors
, line
, 0, true);
1292 else if (*line
!= '\0')
1295 if ((clean
|| clean_all
) && (p
= strrchr (line
, '\033')))
1296 merge_print_line (line
, p
, stream
);
1298 print_line (attr
, colors
, line
, 0, true);
1304 merge_print_line (const char *line
, const char *p
, FILE *stream
)
1307 char *merged_esc
= NULL
;
1308 const char *esc
= "";
1309 const char char_restore
= *p
;
1311 complete_part_line (p
+ 1, &buf
, stream
);
1315 /* form escape sequence */
1316 esc
= merged_esc
= str_concat (p
, buf
);
1317 /* shorten partial line accordingly */
1322 #ifdef TEST_MERGE_PART_LINE
1323 printf ("%s%s", line
, esc
);
1325 _exit (EXIT_SUCCESS
);
1328 *(char *)p
= char_restore
;
1335 complete_part_line (const char *p
, char **buf
, FILE *stream
)
1337 bool got_next_char
= false, read_from_stream
;
1341 if (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
1345 if (read_from_stream
)
1346 save_char (ch
, buf
, &i
, &size
);
1350 if (read_from_stream
)
1351 ungetc ((int)ch
, stream
);
1352 return; /* cancel */
1356 return; /* cancel */
1358 while (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
1360 if (isdigit (ch
) || ch
== ';')
1362 if (read_from_stream
)
1363 save_char (ch
, buf
, &i
, &size
);
1365 else /* got next character */
1367 got_next_char
= true;
1376 if (read_from_stream
)
1377 save_char (ch
, buf
, &i
, &size
);
1381 if (read_from_stream
)
1382 ungetc ((int)ch
, stream
);
1383 return; /* cancel */
1387 return; /* cancel */
1391 get_next_char (char *ch
, const char **p
, FILE *stream
, bool *read_from_stream
)
1396 if ((c
= fgetc (stream
)) != EOF
)
1399 *read_from_stream
= true;
1404 *read_from_stream
= false;
1412 *read_from_stream
= false;
1418 save_char (char ch
, char **buf
, size_t *i
, size_t *size
)
1422 *size
= ALLOC_COMPLETE_PART_LINE
;
1423 *buf
= xmalloc (*size
);
1425 /* +1: effective occupied size of buffer */
1426 else if ((*i
+ 1) == *size
)
1429 *buf
= xrealloc (*buf
, *size
);
1432 (*buf
)[*i
+ 1] = '\0';
1437 find_color_entries (struct color_name
**color_names
, const struct color
**colors
)
1443 gettimeofday (&tv
, NULL
);
1444 srand (tv
.tv_usec
* tv
.tv_sec
);
1446 for (index
= 0; color_names
[index
]; index
++)
1448 const char *color_name
= color_names
[index
]->name
;
1450 const unsigned int count
= tables
[index
].count
;
1451 const struct color
*const color_entries
= tables
[index
].entries
;
1453 if (streq (color_name
, "random"))
1459 i
= rand() % (count
- 2) + 1; /* omit color none and default */
1463 /* --exclude-random */
1464 if (exclude
&& streq (exclude
, color_entries
[i
].name
))
1466 else if (color_names
[BACKGROUND
] && streq (color_names
[BACKGROUND
]->name
, color_entries
[i
].name
))
1470 if (streq (colors
[FOREGROUND
]->name
, color_entries
[i
].name
))
1473 default: /* never reached */
1476 } while (excludable
);
1477 colors
[index
] = (struct color
*)&color_entries
[i
];
1480 find_color_entry (color_names
[index
], index
, colors
);
1485 find_color_entry (const struct color_name
*color_name
, unsigned int index
, const struct color
**colors
)
1490 const unsigned int count
= tables
[index
].count
;
1491 const struct color
*const color_entries
= tables
[index
].entries
;
1493 for (i
= 0; i
< count
; i
++)
1494 if (streq (color_name
->name
, color_entries
[i
].name
))
1496 colors
[index
] = (struct color
*)&color_entries
[i
];
1501 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color_name
->orig
, "not recognized");
1505 print_line (const char *attr
, const struct color
**colors
, const char *const line
, unsigned int flags
, bool emit_colors
)
1508 if (clean
|| clean_all
)
1510 /* skip for --omit-color-empty? */
1511 else if (emit_colors
)
1513 /* Foreground color code is guaranteed to be set when background color code is present. */
1514 if (colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1515 printf ("\033[%s", colors
[BACKGROUND
]->code
);
1516 if (colors
[FOREGROUND
]->code
)
1517 printf ("\033[%s%s%s\033[0m", attr
, colors
[FOREGROUND
]->code
, line
);
1519 printf (formats
[FMT_GENERIC
], line
);
1528 print_clean (const char *line
)
1530 const char *p
= line
;
1533 p
= get_end_of_esc (p
);
1537 const char *text_start
= p
;
1538 const char *text_end
= get_end_of_text (p
);
1539 print_text (text_start
, text_end
- text_start
);
1540 p
= get_end_of_esc (text_end
);
1545 is_esc (const char *p
)
1547 return gather_esc_offsets (p
, NULL
, NULL
);
1551 get_end_of_esc (const char *p
)
1554 const char *end
= NULL
;
1555 while ((esc
= strchr (p
, '\033')))
1557 if (gather_esc_offsets (esc
, NULL
, &end
))
1561 return end
? end
+ 1 : p
+ strlen (p
);
1565 get_end_of_text (const char *p
)
1568 const char *start
= NULL
;
1569 while ((esc
= strchr (p
, '\033')))
1571 if (gather_esc_offsets (esc
, &start
, NULL
))
1575 return start
? start
: p
+ strlen (p
);
1579 print_text (const char *p
, size_t len
)
1581 size_t bytes_written
;
1582 bytes_written
= fwrite (p
, 1, len
, stdout
);
1583 if (bytes_written
!= len
)
1584 vfprintf_fail (formats
[FMT_ERROR
], (unsigned long)len
, "written");
1588 gather_esc_offsets (const char *p
, const char **start
, const char **end
)
1591 if (*p
== 27 && *(p
+ 1) == '[')
1594 const char *const begin
= p
;
1597 valid
= validate_esc_clean_all (&p
);
1601 unsigned int prev_iter
, iter
;
1603 prev_iter
= iter
= 0;
1605 check_values
= false;
1610 while (isdigit (*p
))
1614 else /* check range */
1619 const unsigned int digits
= p
- digit
;
1620 for (i
= 0; i
< digits
; i
++)
1624 valid
= validate_esc_clean (value
, iter
, &prev_iter
, &p
, &check_values
);
1626 } while (check_values
);
1641 validate_esc_clean_all (const char **p
)
1643 while (isdigit (**p
) || **p
== ';')
1645 return (**p
== 'm');
1649 validate_esc_clean (int value
, unsigned int iter
, unsigned int *prev_iter
, const char **p
, bool *check_values
)
1651 if (is_reset (value
, iter
, p
))
1653 else if (is_attr (value
, iter
, *prev_iter
, p
))
1656 *check_values
= true;
1658 return false; /* partial escape sequence, need another valid value */
1660 else if (is_fg_color (value
, p
))
1662 else if (is_bg_color (value
, iter
, p
))
1669 is_reset (int value
, unsigned int iter
, const char **p
)
1671 return (value
== 0 && iter
== 1 && **p
== 'm');
1675 is_attr (int value
, unsigned int iter
, unsigned int prev_iter
, const char **p
)
1677 return ((value
> 0 && value
< 10) && (iter
- prev_iter
== 1) && **p
== ';');
1681 is_fg_color (int value
, const char **p
)
1683 return (((value
>= 30 && value
<= 37) || value
== 39) && **p
== 'm');
1687 is_bg_color (int value
, unsigned int iter
, const char **p
)
1689 return (((value
>= 40 && value
<= 47) || value
== 49) && iter
== 1 && **p
== 'm');
1694 malloc_wrap (size_t size
)
1696 void *p
= malloc (size
);
1703 calloc_wrap (size_t nmemb
, size_t size
)
1705 void *p
= calloc (nmemb
, size
);
1712 realloc_wrap (void *ptr
, size_t size
)
1714 void *p
= realloc (ptr
, size
);
1720 static const char *const format_debug
= "%s: %10s %7lu bytes [source file %s, line %5u]\n";
1722 malloc_wrap_debug (size_t size
, const char *file
, unsigned int line
)
1724 void *p
= malloc (size
);
1726 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1727 fprintf (log
, format_debug
, program_name
, "malloc'ed", (unsigned long)size
, file
, line
);
1732 calloc_wrap_debug (size_t nmemb
, size_t size
, const char *file
, unsigned int line
)
1734 void *p
= calloc (nmemb
, size
);
1736 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1737 fprintf (log
, format_debug
, program_name
, "calloc'ed", (unsigned long)(nmemb
* size
), file
, line
);
1742 realloc_wrap_debug (void *ptr
, size_t size
, const char *file
, unsigned int line
)
1744 void *p
= realloc (ptr
, size
);
1746 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1747 fprintf (log
, format_debug
, program_name
, "realloc'ed", (unsigned long)size
, file
, line
);
1753 free_wrap (void **ptr
)
1760 # define do_malloc(len, file, line) malloc_wrap(len)
1762 # define do_malloc(len, file, line) malloc_wrap_debug(len, file, line)
1766 strdup_wrap (const char *str
, const char *file
, unsigned int line
)
1768 const size_t len
= strlen (str
) + 1;
1769 char *p
= do_malloc (len
, file
, line
);
1770 strncpy (p
, str
, len
);
1775 str_concat_wrap (const char *str1
, const char *str2
, const char *file
, unsigned int line
)
1777 const size_t len
= strlen (str1
) + strlen (str2
) + 1;
1780 p
= str
= do_malloc (len
, file
, line
);
1781 strncpy (p
, str1
, strlen (str1
));
1783 strncpy (p
, str2
, strlen (str2
));
1791 expand_string (const char *str
)
1796 wordexp (str
, &p
, 0);
1797 if (p
.we_wordc
>= 1)
1798 s
= xstrdup (p
.we_wordv
[0]);
1805 get_bytes_size (unsigned long bytes
, struct bytes_size
*bytes_size
)
1807 const char *unit
, units
[] = { '0', 'K', 'M', 'G', '\0' };
1808 unsigned long size
= bytes
;
1812 while (size
>= 1024 && *(unit
+ 1))
1817 bytes_size
->size
= (unsigned int)size
;
1818 bytes_size
->unit
= *unit
;
1823 get_file_type (mode_t mode
)
1827 else if (S_ISDIR (mode
))
1829 else if (S_ISCHR (mode
))
1830 return "character device";
1831 else if (S_ISBLK (mode
))
1832 return "block device";
1833 else if (S_ISFIFO (mode
))
1834 return "named pipe";
1835 else if (S_ISLNK (mode
))
1836 return "symbolic link";
1837 else if (S_ISSOCK (mode
))
1844 has_color_name (const char *str
, const char *name
)
1848 assert (strlen (str
) > 0);
1849 assert (strlen (name
) > 0);
1851 if (!(*str
== *name
|| *str
== toupper (*name
)))
1853 else if (*(name
+ 1) != '\0'
1854 && !((p
= strstr (str
+ 1, name
+ 1)) && p
== str
+ 1))
1861 open_file (const char *file
, const char *mode
)
1866 stream
= fopen (file
, mode
);
1868 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1873 #define DO_VFPRINTF(fmt) \
1875 fprintf (stderr, "%s: ", program_name); \
1876 va_start (ap, fmt); \
1877 vfprintf (stderr, fmt, ap); \
1879 fprintf (stderr, "\n");
1882 vfprintf_diag (const char *fmt
, ...)
1888 vfprintf_fail (const char *fmt
, ...)
1891 exit (EXIT_FAILURE
);
1895 stack (struct var_list
**list
, unsigned int *stacked
, unsigned int index
, void *ptr
, enum var_type type
)
1897 struct var_list
*var
;
1898 /* nothing to stack */
1902 *list
= xmalloc (sizeof (struct var_list
));
1906 for (i
= 0; i
< *stacked
; i
++)
1909 if (var
->type
== IS_UNUSED
)
1913 return; /* reused */
1916 *list
= xrealloc (*list
, (*stacked
+ 1) * sizeof (struct var_list
));
1918 var
= &(*list
)[index
];
1925 release (struct var_list
*list
, unsigned int stacked
, void **ptr
)
1928 /* nothing to release */
1931 for (i
= 0; i
< stacked
; i
++)
1933 struct var_list
*var
= &list
[i
];
1934 if (var
->type
!= IS_UNUSED
1935 && var
->ptr
== *ptr
)
1945 default: /* never reached */
1950 var
->type
= IS_UNUSED
;