]>
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-2018 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_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
88 #define RELEASE_VAR(ptr) do { \
89 release_var (vars_list, stacked_vars, (void **)&ptr); \
93 # define MEM_ALLOC_FAIL() do { \
94 fprintf (stderr, "%s: memory allocation failure\n", program_name); \
95 exit (EXIT_FAILURE); \
98 # define MEM_ALLOC_FAIL_DEBUG(file, line) do { \
99 fprintf (stderr, "Memory allocation failure in source file %s, line %u\n", file, line); \
100 exit (EXIT_FAILURE); \
104 #define ABORT_TRACE() \
105 fprintf (stderr, "Aborting in source file %s, line %u\n", __FILE__, __LINE__); \
108 #define CHECK_COLORS_RANDOM(color1, color2) \
109 streq (color_names[color1]->name, "random") \
110 && (streq (color_names[color2]->name, "none") \
111 || streq (color_names[color2]->name, "default"))
113 #define ALLOC_COMPLETE_PART_LINE 8
115 #if defined(COLOR_SEP_CHAR_COLON)
116 # define COLOR_SEP_CHAR ':'
117 #elif defined(COLOR_SEP_CHAR_SLASH)
118 # define COLOR_SEP_CHAR '/'
120 # define COLOR_SEP_CHAR '/'
123 #define CONF_FILE ".colorize.conf"
126 # define DEBUG_FILE "debug.txt"
129 #define MAX_ATTRIBUTE_CHARS (6 * 2)
131 #define PROGRAM_NAME "colorize"
133 #define VERSION "0.64"
135 typedef enum { false, true } bool;
140 char *exclude_random
;
141 char *omit_color_empty
;
144 enum { DESC_OPTION
, DESC_CONF
};
156 static const struct color fg_colors
[] = {
163 { "magenta", "35m" },
166 { "default", "39m" },
168 static const struct color bg_colors
[] = {
175 { "magenta", "45m" },
178 { "default", "49m" },
197 static const char *formats
[] = {
199 "%s '%s'", /* string */
200 "%s `%s' %s", /* quote */
201 "%s color '%s' %s", /* color */
202 "%s color '%s' %s '%s'", /* random */
203 "less than %lu bytes %s", /* error */
205 "%s: %s: %s", /* type */
206 "%s: option '%s' %s" /* conf */
209 enum { GENERIC
, FOREGROUND
= 0, BACKGROUND
};
211 static const struct {
212 const struct color
*entries
;
216 { fg_colors
, COUNT_OF (fg_colors
, struct color
), "foreground" },
217 { bg_colors
, COUNT_OF (bg_colors
, struct color
), "background" },
220 static unsigned int opts_set
;
223 OPT_EXCLUDE_RANDOM_SET
= 0x02,
224 OPT_OMIT_COLOR_EMPTY_SET
= 0x04
228 char *exclude_random
;
229 } opts_arg
= { NULL
, NULL
};
237 OPT_OMIT_COLOR_EMPTY
,
242 static const struct option long_opts
[] = {
243 { "attr", required_argument
, &opt_type
, OPT_ATTR
},
244 { "clean", no_argument
, &opt_type
, OPT_CLEAN
},
245 { "clean-all", no_argument
, &opt_type
, OPT_CLEAN_ALL
},
246 { "config", required_argument
, &opt_type
, OPT_CONFIG
},
247 { "exclude-random", required_argument
, &opt_type
, OPT_EXCLUDE_RANDOM
},
248 { "omit-color-empty", no_argument
, &opt_type
, OPT_OMIT_COLOR_EMPTY
},
249 { "help", no_argument
, &opt_type
, OPT_HELP
},
250 { "version", no_argument
, &opt_type
, OPT_VERSION
},
251 { NULL
, 0, NULL
, 0 },
256 ATTR_UNDERSCORE
= 0x02,
259 ATTR_CONCEALED
= 0x10
272 static unsigned int stacked_vars
;
273 static void **vars_list
;
276 static bool clean_all
;
277 static bool omit_color_empty
;
279 static char attr
[MAX_ATTRIBUTE_CHARS
+ 1];
280 static char *exclude
;
282 static const char *program_name
;
285 static void print_tstamp (FILE *);
287 static void process_opts (int, char **, char **);
288 static void process_opt_attr (const char *, const bool);
289 static void write_attr (const struct attr
*, unsigned int *, const bool);
290 static void process_opt_exclude_random (const char *, const bool);
291 static void parse_conf (const char *, struct conf
*);
292 static void assign_conf (const char *, struct conf
*, const char *, char *);
293 static void init_conf_vars (const struct conf
*);
294 static void init_opts_vars (void);
295 static void print_hint (void);
296 static void print_help (void);
297 static void print_version (void);
298 static void cleanup (void);
299 static void free_color_names (struct color_name
**);
300 static void free_conf (struct conf
*);
301 static void process_args (unsigned int, char **, char *, const struct color
**, const char **, FILE **, struct conf
*);
302 static void process_file_arg (const char *, const char **, FILE **);
303 static bool skip_path_colors (const char *, const char *, const struct stat
*, const bool);
304 static void gather_color_names (const char *, char *, struct color_name
**);
305 static void read_print_stream (const char *, const struct color
**, const char *, FILE *);
306 static void merge_print_line (const char *, const char *, FILE *);
307 static void complete_part_line (const char *, char **, FILE *);
308 static bool get_next_char (char *, const char **, FILE *, bool *);
309 static void save_char (char, char **, size_t *, size_t *);
310 static void find_color_entries (struct color_name
**, const struct color
**);
311 static void find_color_entry (const struct color_name
*, unsigned int, const struct color
**);
312 static void print_line (const char *, const struct color
**, const char * const, unsigned int, bool);
313 static void print_clean (const char *);
314 static bool is_esc (const char *);
315 static const char *get_end_of_esc (const char *);
316 static const char *get_end_of_text (const char *);
317 static void print_text (const char *, size_t);
318 static bool gather_esc_offsets (const char *, const char **, const char **);
319 static bool validate_esc_clean_all (const char **);
320 static bool validate_esc_clean (int, unsigned int, unsigned int *, const char **, bool *);
321 static bool is_reset (int, unsigned int, const char **);
322 static bool is_attr (int, unsigned int, unsigned int, const char **);
323 static bool is_fg_color (int, const char **);
324 static bool is_bg_color (int, unsigned int, const char **);
326 static void *malloc_wrap (size_t);
327 static void *calloc_wrap (size_t, size_t);
328 static void *realloc_wrap (void *, size_t);
330 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
331 static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
332 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
334 static void free_wrap (void **);
335 static char *strdup_wrap (const char *, const char *, unsigned int);
336 static char *str_concat_wrap (const char *, const char *, const char *, unsigned int);
337 static char *expand_string (const char *);
338 static bool get_bytes_size (unsigned long, struct bytes_size
*);
339 static char *get_file_type (mode_t
);
340 static bool has_color_name (const char *, const char *);
341 static FILE *open_file (const char *, const char *);
342 static void vfprintf_diag (const char *, ...);
343 static void vfprintf_fail (const char *, ...);
344 static void stack_var (void ***, unsigned int *, unsigned int, void *);
345 static void release_var (void **, unsigned int, void **);
350 main (int argc
, char **argv
)
352 unsigned int arg_cnt
;
354 const struct color
*colors
[2] = {
355 NULL
, /* foreground */
356 NULL
, /* background */
359 const char *file
= NULL
;
361 char *conf_file
= NULL
;
362 struct conf config
= { NULL
, NULL
, NULL
, NULL
};
364 program_name
= argv
[0];
367 setvbuf (stdout
, NULL
, _IOLBF
, 0);
370 log
= open_file (DEBUG_FILE
, "w");
376 process_opts (argc
, argv
, &conf_file
);
378 #ifdef CONF_FILE_TEST
379 conf_file
= to_str (CONF_FILE_TEST
);
381 if (conf_file
== NULL
)
384 struct passwd
*passwd
;
389 if ((passwd
= getpwuid (uid
)) == NULL
)
392 vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid
);
397 size
= strlen (passwd
->pw_dir
) + 1 + strlen (CONF_FILE
) + 1;
398 conf_file
= xmalloc (size
);
399 snprintf (conf_file
, size
, "%s/%s", passwd
->pw_dir
, CONF_FILE
);
404 if ((s
= expand_string (conf_file
)))
410 if (access (conf_file
, F_OK
) == -1)
411 vfprintf_fail (formats
[FMT_FILE
], conf_file
, strerror (errno
));
414 #if defined(CONF_FILE_TEST) || !defined(TEST)
415 if (access (conf_file
, F_OK
) != -1)
416 parse_conf (conf_file
, &config
);
418 #if !defined(CONF_FILE_TEST) && !defined(TEST)
421 init_conf_vars (&config
);
425 arg_cnt
= argc
- optind
;
427 if (clean
|| clean_all
)
429 if (clean
&& clean_all
)
430 vfprintf_fail (formats
[FMT_GENERIC
], "--clean and --clean-all switch are mutually exclusive");
433 const char *const format
= "%s %s";
434 const char *const message
= "switch cannot be used with more than one file";
436 vfprintf_fail (format
, "--clean", message
);
438 vfprintf_fail (format
, "--clean-all", message
);
443 if (arg_cnt
== 0 || arg_cnt
> 2)
445 vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt
);
451 if (clean
|| clean_all
)
452 process_file_arg (argv
[optind
], &file
, &stream
);
454 process_args (arg_cnt
, &argv
[optind
], &attr
[0], colors
, &file
, &stream
, &config
);
455 read_print_stream (&attr
[0], colors
, file
, stream
);
459 RELEASE_VAR (exclude
);
466 print_tstamp (FILE *log
)
477 perror ("localtime");
480 written
= strftime (str
, sizeof (str
), "%Y-%m-%d %H:%M:%S %Z", tm
);
482 vfprintf_fail (formats
[FMT_GENERIC
], "strftime: 0 returned");
484 fprintf (log
, "%s\n", str
);
491 #define PRINT_HELP_EXIT() \
495 #define PRINT_VERSION_EXIT() \
502 process_opts (int argc
, char **argv
, char **conf_file
)
505 while ((opt
= getopt_long (argc
, argv
, "hV", long_opts
, NULL
)) != -1)
509 case 0: /* long opts */
513 opts_set
|= OPT_ATTR_SET
;
514 opts_arg
.attr
= xstrdup (optarg
);
523 *conf_file
= xstrdup (optarg
);
525 case OPT_EXCLUDE_RANDOM
:
526 opts_set
|= OPT_EXCLUDE_RANDOM_SET
;
527 opts_arg
.exclude_random
= xstrdup (optarg
);
529 case OPT_OMIT_COLOR_EMPTY
:
530 opts_set
|= OPT_OMIT_COLOR_EMPTY_SET
;
535 PRINT_VERSION_EXIT ();
536 default: /* never reached */
543 PRINT_VERSION_EXIT ();
547 default: /* never reached */
554 process_opt_attr (const char *p
, const bool is_opt
)
556 /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */
557 const struct attr attrs
[] = {
558 { "bold", 1, ATTR_BOLD
},
559 { "underscore", 4, ATTR_UNDERSCORE
},
560 { "blink", 5, ATTR_BLINK
},
561 { "reverse", 7, ATTR_REVERSE
},
562 { "concealed", 8, ATTR_CONCEALED
},
564 unsigned int attr_types
= 0;
565 const char *desc_type
[2] = { "--attr switch", "attr conf option" };
566 const unsigned int DESC_TYPE
= is_opt
? DESC_OPTION
: DESC_CONF
;
572 vfprintf_fail ("%s must be provided a string", desc_type
[DESC_TYPE
]);
576 if (*p
!= '\0' && *p
!= ',')
577 vfprintf_fail ("%s must have strings separated by ,", desc_type
[DESC_TYPE
]);
580 bool valid_attr
= false;
582 for (i
= 0; i
< COUNT_OF (attrs
, struct attr
); i
++)
584 const size_t name_len
= strlen (attrs
[i
].name
);
585 if ((size_t)(p
- s
) == name_len
&& strneq (s
, attrs
[i
].name
, name_len
))
587 write_attr (&attrs
[i
], &attr_types
, is_opt
);
594 char *attr_invalid
= xmalloc ((p
- s
) + 1);
595 STACK_VAR (attr_invalid
);
596 strncpy (attr_invalid
, s
, p
- s
);
597 attr_invalid
[p
- s
] = '\0';
598 vfprintf_fail ("%s attribute '%s' is not valid", desc_type
[DESC_TYPE
], attr_invalid
);
599 RELEASE_VAR (attr_invalid
); /* never reached */
608 write_attr (const struct attr
*attr_i
, unsigned int *attr_types
, const bool is_opt
)
610 const unsigned int val
= attr_i
->val
;
611 const enum attr_type attr_type
= attr_i
->type
;
612 const char *attr_name
= attr_i
->name
;
614 if (*attr_types
& attr_type
)
615 vfprintf_fail ("%s has attribute '%s' twice or more",
616 is_opt
? "--attr switch" : "attr conf option", attr_name
);
617 snprintf (attr
+ strlen (attr
), 3, "%u;", val
);
618 *attr_types
|= attr_type
;
622 process_opt_exclude_random (const char *s
, const bool is_opt
)
627 RELEASE_VAR (exclude
);
628 exclude
= xstrdup (s
);
630 for (i
= 1; i
< tables
[GENERIC
].count
- 1; i
++) /* skip color none and default */
632 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
633 if (streq (exclude
, entry
->name
))
640 vfprintf_fail ("%s must be provided a plain color",
641 is_opt
? "--exlude-random switch" : "exclude-random conf option");
645 init_opts_vars (void)
647 if (opts_set
& OPT_ATTR_SET
)
649 attr
[0] = '\0'; /* Clear attr string to discard values from the config file. */
650 process_opt_attr (opts_arg
.attr
, true);
652 if (opts_set
& OPT_EXCLUDE_RANDOM_SET
)
653 process_opt_exclude_random (opts_arg
.exclude_random
, true);
654 if (opts_set
& OPT_OMIT_COLOR_EMPTY_SET
)
655 omit_color_empty
= true;
657 free (opts_arg
.attr
);
658 free (opts_arg
.exclude_random
);
661 #define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
664 parse_conf (const char *conf_file
, struct conf
*config
)
669 conf
= open_file (conf_file
, "r");
671 while (fgets (line
, sizeof (line
), conf
))
674 char *assign
, *comment
, *opt
, *value
;
677 if (strlen (line
) > (sizeof (line
) - 2))
678 vfprintf_fail ("%s: line exceeds maximum of %u characters", conf_file
, (unsigned int)(sizeof (line
) - 2));
679 if ((p
= strrchr (line
, '\n')))
681 /* NAME PARSING (start) */
683 /* skip leading spaces and tabs for name */
684 while (IS_SPACE (*p
))
686 /* skip line if a) string end, b) comment, [cd]) newline */
687 if (*p
== '\0' || *p
== '#' || *p
== '\n' || *p
== '\r')
690 if (!(assign
= strchr (opt
, '='))) /* check for = */
693 if ((space
= strchr (opt
, ' ')))
695 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "not followed by =");
698 /* skip trailing spaces and tabs for name */
699 while (IS_SPACE (*(p
- 1)))
702 /* NAME PARSING (end) */
703 /* NAME VALIDATION (start) */
704 for (p
= opt
; *p
; p
++)
705 if (!isalnum (*p
) && *p
!= '-')
706 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "cannot be made of non-option characters");
707 /* NAME VALIDATION (end) */
708 /* VALUE PARSING (start) */
710 /* skip leading spaces and tabs for value */
711 while (IS_SPACE (*p
))
713 /* skip line if comment */
717 if ((comment
= strchr (p
, '#')))
721 /* skip trailing spaces and tabs for value */
722 while (IS_SPACE (*(p
- 1)))
725 /* VALUE PARSING (end) */
727 /* save option name */
729 /* save option value (allow empty ones) */
730 val
= strlen (value
) ? xstrdup (value
) : NULL
;
732 assign_conf (conf_file
, config
, cfg
, val
);
740 assign_conf (const char *conf_file
, struct conf
*config
, const char *cfg
, char *val
)
742 if (streq (cfg
, "attr"))
747 else if (streq (cfg
, "color"))
749 free (config
->color
);
752 else if (streq (cfg
, "exclude-random"))
754 free (config
->exclude_random
);
755 config
->exclude_random
= val
;
757 else if (streq (cfg
, "omit-color-empty"))
759 free (config
->omit_color_empty
);
760 config
->omit_color_empty
= val
;
763 vfprintf_fail (formats
[FMT_CONF
], conf_file
, cfg
, "not recognized");
767 init_conf_vars (const struct conf
*config
)
770 process_opt_attr (config
->attr
, false);
771 if (config
->exclude_random
)
772 process_opt_exclude_random (config
->exclude_random
, false);
773 if (config
->omit_color_empty
)
775 if (streq (config
->omit_color_empty
, "yes"))
776 omit_color_empty
= true;
777 else if (streq (config
->omit_color_empty
, "no"))
778 omit_color_empty
= false;
780 vfprintf_fail ("omit-color-empty conf option is not valid");
787 fprintf (stderr
, "Type `%s --help' for help screen.\n", program_name
);
795 const char *short_opt
;
798 const struct opt_data opts_data
[] = {
799 { "attr", NULL
, "=ATTR1,ATTR2,..." },
800 { "config", NULL
, "=PATH" },
801 { "exclude-random", NULL
, "=COLOR" },
802 { "help", "h", NULL
},
803 { "version", "V", NULL
},
805 const struct option
*opt
= long_opts
;
808 printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name
, COLOR_SEP_CHAR
);
809 printf ("\tColors (foreground) (background)\n");
810 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
812 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
813 const char *name
= entry
->name
;
814 const char *code
= entry
->code
;
816 printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
817 code
, toupper (*name
), *name
, name
+ 1, 10 - (int)strlen (name
), " ", name
);
819 printf ("\t\t{-} %s%*s%s\n", name
, 13 - (int)strlen (name
), " ", name
);
821 printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
823 printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
824 printf ("\twhereas for lower case colors will be of normal intensity.\n");
826 printf ("\n\tOptions\n");
827 for (; opt
->name
; opt
++)
829 const struct opt_data
*opt_data
= NULL
;
831 for (i
= 0; i
< COUNT_OF (opts_data
, struct opt_data
); i
++)
832 if (streq (opt
->name
, opts_data
[i
].name
))
834 opt_data
= &opts_data
[i
];
839 if (opt_data
->short_opt
)
840 printf ("\t\t-%s, --%s\n", opt_data
->short_opt
, opt
->name
);
842 printf ("\t\t --%s%s\n", opt
->name
, opt_data
->arg
);
845 printf ("\t\t --%s\n", opt
->name
);
854 # include "version.h"
856 const char *const version
= NULL
;
858 const char *version_prefix
, *version_string
;
859 const char *c_flags
, *ld_flags
, *cpp_flags
;
860 const char *const desc_flags_unknown
= "unknown";
861 struct bytes_size bytes_size
;
864 c_flags
= to_str (CFLAGS
);
866 c_flags
= desc_flags_unknown
;
869 ld_flags
= to_str (LDFLAGS
);
871 ld_flags
= desc_flags_unknown
;
874 cpp_flags
= to_str (CPPFLAGS
);
876 cpp_flags
= desc_flags_unknown
;
883 version_prefix
= version
? "" : "v";
884 version_string
= version
? version
: VERSION
;
885 printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME
, version_prefix
, version_string
, __DATE__
, __TIME__
);
887 printf ("Compiler flags: %s\n", c_flags
);
888 printf ("Linker flags: %s\n", ld_flags
);
889 printf ("Preprocessor flags: %s\n", cpp_flags
);
890 if (get_bytes_size (BUF_SIZE
, &bytes_size
))
892 if (BUF_SIZE
% 1024 == 0)
893 printf ("Buffer size: %u%c\n", bytes_size
.size
, bytes_size
.unit
);
895 printf ("Buffer size: %u%c, %u byte%s\n", bytes_size
.size
, bytes_size
.unit
,
896 BUF_SIZE
% 1024, BUF_SIZE
% 1024 > 1 ? "s" : "");
899 printf ("Buffer size: %lu byte%s\n", (unsigned long)BUF_SIZE
, BUF_SIZE
> 1 ? "s" : "");
900 printf ("Color separator: '%c'\n", COLOR_SEP_CHAR
);
901 printf ("Debugging: %s\n", debug
? "yes" : "no");
907 if (stream
&& fileno (stream
) != STDIN_FILENO
)
917 for (i
= 0; i
< stacked_vars
; i
++)
919 free_null (vars_list
);
924 free_color_names (struct color_name
**color_names
)
927 for (i
= 0; color_names
[i
]; i
++)
929 RELEASE_VAR (color_names
[i
]->name
);
930 RELEASE_VAR (color_names
[i
]->orig
);
931 RELEASE_VAR (color_names
[i
]);
936 free_conf (struct conf
*config
)
939 free (config
->color
);
940 free (config
->exclude_random
);
941 free (config
->omit_color_empty
);
945 process_args (unsigned int arg_cnt
, char **arg_strings
, char *attr
, const struct color
**colors
, const char **file
, FILE **stream
, struct conf
*config
)
951 struct color_name
*color_names
[3] = {
952 NULL
, /* foreground */
953 NULL
, /* background */
954 NULL
, /* sentinel value */
957 const char *color_string
= arg_cnt
>= 1 ? arg_strings
[0] : NULL
;
958 const char *file_string
= arg_cnt
== 2 ? arg_strings
[1] : NULL
;
960 assert (color_string
!= NULL
);
962 if (streq (color_string
, "-"))
965 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen cannot be used as color string");
967 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen must be preceded by color string");
970 if ((ret
= lstat (color_string
, &sb
)) == 0) /* exists */
971 /* Ensure that we don't fail if there's a file with one or more
972 color names in its path. */
973 use_conf_color
= skip_path_colors (color_string
, file_string
, &sb
, !!config
->color
);
975 /* Use color from config file. */
977 && (access (color_string
, F_OK
) != -1)
980 file_string
= color_string
;
981 color_string
= config
->color
;
984 if ((p
= strchr (color_string
, COLOR_SEP_CHAR
)))
986 if (p
== color_string
)
987 vfprintf_fail (formats
[FMT_STRING
], "foreground color missing in string", color_string
);
988 else if (p
== color_string
+ strlen (color_string
) - 1)
989 vfprintf_fail (formats
[FMT_STRING
], "background color missing in string", color_string
);
990 else if (strchr (++p
, COLOR_SEP_CHAR
))
991 vfprintf_fail (formats
[FMT_STRING
], "one color pair allowed only for string", color_string
);
994 gather_color_names (color_string
, attr
, color_names
);
996 assert (color_names
[FOREGROUND
] != NULL
);
998 if (color_names
[BACKGROUND
])
1001 const unsigned int color_sets
[2][2] = { { FOREGROUND
, BACKGROUND
}, { BACKGROUND
, FOREGROUND
} };
1002 for (i
= 0; i
< 2; i
++)
1004 const unsigned int color1
= color_sets
[i
][0];
1005 const unsigned int color2
= color_sets
[i
][1];
1006 if (CHECK_COLORS_RANDOM (color1
, color2
))
1007 vfprintf_fail (formats
[FMT_RANDOM
], tables
[color1
].desc
, color_names
[color1
]->orig
, "cannot be combined with", color_names
[color2
]->orig
);
1011 find_color_entries (color_names
, colors
);
1012 assert (colors
[FOREGROUND
] != NULL
);
1013 free_color_names (color_names
);
1015 if (!colors
[FOREGROUND
]->code
&& colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1017 struct color_name color_name
;
1018 color_name
.name
= color_name
.orig
= "default";
1020 find_color_entry (&color_name
, FOREGROUND
, colors
);
1021 assert (colors
[FOREGROUND
]->code
!= NULL
);
1024 process_file_arg (file_string
, file
, stream
);
1028 process_file_arg (const char *file_string
, const char **file
, FILE **stream
)
1032 if (streq (file_string
, "-"))
1036 const char *file
= file_string
;
1041 ret
= stat (file
, &sb
);
1044 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1046 if (!VALID_FILE_TYPE (sb
.st_mode
))
1047 vfprintf_fail (formats
[FMT_TYPE
], file
, "unrecognized type", get_file_type (sb
.st_mode
));
1049 *stream
= open_file (file
, "r");
1051 *file
= file_string
;
1059 assert (*stream
!= NULL
);
1060 assert (*file
!= NULL
);
1064 skip_path_colors (const char *color_string
, const char *file_string
, const struct stat
*sb
, const bool has_conf
)
1068 const char *color
= color_string
;
1069 const mode_t mode
= sb
->st_mode
;
1071 for (c
= 1; c
<= 2 && *color
; c
++)
1073 bool matched
= false;
1075 for (i
= 0; i
< tables
[GENERIC
].count
; i
++)
1077 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
1078 if (has_color_name (color
, entry
->name
))
1080 color
+= strlen (entry
->name
);
1085 if (!matched
&& has_color_name (color
, "random"))
1087 color
+= strlen ("random");
1090 if (matched
&& *color
== COLOR_SEP_CHAR
&& *(color
+ 1))
1096 have_file
= (*color
!= '\0');
1100 const char *file_existing
= color_string
;
1102 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "cannot be used as color string");
1105 if (VALID_FILE_TYPE (mode
))
1109 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "must be preceded by color string");
1112 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "is not a valid file type");
1119 gather_color_names (const char *color_string
, char *attr
, struct color_name
**color_names
)
1122 char *color
, *p
, *str
;
1124 str
= xstrdup (color_string
);
1127 for (index
= 0, color
= str
; *color
; index
++, color
= p
)
1132 if ((sep
= strchr (color
, COLOR_SEP_CHAR
)))
1138 p
= color
+ strlen (color
);
1141 for (ch
= color
; *ch
; ch
++)
1143 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be made of non-alphabetic characters");
1145 for (ch
= color
+ 1; *ch
; ch
++)
1147 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be in mixed lower/upper case");
1149 if (streq (color
, "None"))
1150 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be bold");
1152 if (isupper (*color
))
1157 snprintf (attr
+ strlen (attr
), 3, "1;");
1160 vfprintf_fail (formats
[FMT_COLOR
], tables
[BACKGROUND
].desc
, color
, "cannot be bold");
1161 default: /* never reached */
1166 color_names
[index
] = xcalloc (1, sizeof (struct color_name
));
1167 STACK_VAR (color_names
[index
]);
1169 color_names
[index
]->orig
= xstrdup (color
);
1170 STACK_VAR (color_names
[index
]->orig
);
1172 for (ch
= color
; *ch
; ch
++)
1173 *ch
= tolower (*ch
);
1175 color_names
[index
]->name
= xstrdup (color
);
1176 STACK_VAR (color_names
[index
]->name
);
1183 read_print_stream (const char *attr
, const struct color
**colors
, const char *file
, FILE *stream
)
1185 char buf
[BUF_SIZE
+ 1];
1186 unsigned int flags
= 0;
1188 while (!feof (stream
))
1193 bytes_read
= fread (buf
, 1, BUF_SIZE
, stream
);
1194 if (bytes_read
!= BUF_SIZE
&& ferror (stream
))
1195 vfprintf_fail (formats
[FMT_ERROR
], BUF_SIZE
, "read");
1196 buf
[bytes_read
] = '\0';
1198 while ((eol
= strpbrk (line
, "\n\r")))
1200 const bool has_text
= (eol
> line
);
1206 if (*(eol
+ 1) == '\n')
1209 else if (*eol
== '\n')
1211 else /* never reached */
1212 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized line ending");
1213 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
1215 print_line (attr
, colors
, line
, flags
,
1216 omit_color_empty
? has_text
: true);
1222 print_line (attr
, colors
, line
, 0, true);
1224 else if (*line
!= '\0')
1227 if ((clean
|| clean_all
) && (p
= strrchr (line
, '\033')))
1228 merge_print_line (line
, p
, stream
);
1230 print_line (attr
, colors
, line
, 0, true);
1236 merge_print_line (const char *line
, const char *p
, FILE *stream
)
1239 char *merged_esc
= NULL
;
1240 const char *esc
= "";
1241 const char char_restore
= *p
;
1243 complete_part_line (p
+ 1, &buf
, stream
);
1247 /* form escape sequence */
1248 esc
= merged_esc
= str_concat (p
, buf
);
1249 /* shorten partial line accordingly */
1254 #ifdef TEST_MERGE_PART_LINE
1255 printf ("%s%s", line
, esc
);
1257 _exit (EXIT_SUCCESS
);
1260 *(char *)p
= char_restore
;
1267 complete_part_line (const char *p
, char **buf
, FILE *stream
)
1269 bool got_next_char
= false, read_from_stream
;
1273 if (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
1277 if (read_from_stream
)
1278 save_char (ch
, buf
, &i
, &size
);
1282 if (read_from_stream
)
1283 ungetc ((int)ch
, stream
);
1284 return; /* cancel */
1288 return; /* cancel */
1290 while (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
1292 if (isdigit (ch
) || ch
== ';')
1294 if (read_from_stream
)
1295 save_char (ch
, buf
, &i
, &size
);
1297 else /* got next character */
1299 got_next_char
= true;
1308 if (read_from_stream
)
1309 save_char (ch
, buf
, &i
, &size
);
1313 if (read_from_stream
)
1314 ungetc ((int)ch
, stream
);
1315 return; /* cancel */
1319 return; /* cancel */
1323 get_next_char (char *ch
, const char **p
, FILE *stream
, bool *read_from_stream
)
1328 if ((c
= fgetc (stream
)) != EOF
)
1331 *read_from_stream
= true;
1336 *read_from_stream
= false;
1344 *read_from_stream
= false;
1350 save_char (char ch
, char **buf
, size_t *i
, size_t *size
)
1354 *size
= ALLOC_COMPLETE_PART_LINE
;
1355 *buf
= xmalloc (*size
);
1357 /* +1: effective occupied size of buffer */
1358 else if ((*i
+ 1) == *size
)
1361 *buf
= xrealloc (*buf
, *size
);
1364 (*buf
)[*i
+ 1] = '\0';
1369 find_color_entries (struct color_name
**color_names
, const struct color
**colors
)
1375 gettimeofday (&tv
, NULL
);
1376 srand (tv
.tv_usec
* tv
.tv_sec
);
1378 for (index
= 0; color_names
[index
]; index
++)
1380 const char *color_name
= color_names
[index
]->name
;
1382 const unsigned int count
= tables
[index
].count
;
1383 const struct color
*const color_entries
= tables
[index
].entries
;
1385 if (streq (color_name
, "random"))
1391 i
= rand() % (count
- 2) + 1; /* omit color none and default */
1395 /* --exclude-random */
1396 if (exclude
&& streq (exclude
, color_entries
[i
].name
))
1398 else if (color_names
[BACKGROUND
] && streq (color_names
[BACKGROUND
]->name
, color_entries
[i
].name
))
1402 if (streq (colors
[FOREGROUND
]->name
, color_entries
[i
].name
))
1405 default: /* never reached */
1408 } while (excludable
);
1409 colors
[index
] = (struct color
*)&color_entries
[i
];
1412 find_color_entry (color_names
[index
], index
, colors
);
1417 find_color_entry (const struct color_name
*color_name
, unsigned int index
, const struct color
**colors
)
1422 const unsigned int count
= tables
[index
].count
;
1423 const struct color
*const color_entries
= tables
[index
].entries
;
1425 for (i
= 0; i
< count
; i
++)
1426 if (streq (color_name
->name
, color_entries
[i
].name
))
1428 colors
[index
] = (struct color
*)&color_entries
[i
];
1433 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color_name
->orig
, "not recognized");
1437 print_line (const char *attr
, const struct color
**colors
, const char *const line
, unsigned int flags
, bool emit_colors
)
1440 if (clean
|| clean_all
)
1442 /* skip for --omit-color-empty? */
1443 else if (emit_colors
)
1445 /* Foreground color code is guaranteed to be set when background color code is present. */
1446 if (colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1447 printf ("\033[%s", colors
[BACKGROUND
]->code
);
1448 if (colors
[FOREGROUND
]->code
)
1449 printf ("\033[%s%s%s\033[0m", attr
, colors
[FOREGROUND
]->code
, line
);
1451 printf (formats
[FMT_GENERIC
], line
);
1460 print_clean (const char *line
)
1462 const char *p
= line
;
1465 p
= get_end_of_esc (p
);
1469 const char *text_start
= p
;
1470 const char *text_end
= get_end_of_text (p
);
1471 print_text (text_start
, text_end
- text_start
);
1472 p
= get_end_of_esc (text_end
);
1477 is_esc (const char *p
)
1479 return gather_esc_offsets (p
, NULL
, NULL
);
1483 get_end_of_esc (const char *p
)
1486 const char *end
= NULL
;
1487 while ((esc
= strchr (p
, '\033')))
1489 if (gather_esc_offsets (esc
, NULL
, &end
))
1493 return end
? end
+ 1 : p
+ strlen (p
);
1497 get_end_of_text (const char *p
)
1500 const char *start
= NULL
;
1501 while ((esc
= strchr (p
, '\033')))
1503 if (gather_esc_offsets (esc
, &start
, NULL
))
1507 return start
? start
: p
+ strlen (p
);
1511 print_text (const char *p
, size_t len
)
1513 size_t bytes_written
;
1514 bytes_written
= fwrite (p
, 1, len
, stdout
);
1515 if (bytes_written
!= len
)
1516 vfprintf_fail (formats
[FMT_ERROR
], (unsigned long)len
, "written");
1520 gather_esc_offsets (const char *p
, const char **start
, const char **end
)
1523 if (*p
== 27 && *(p
+ 1) == '[')
1526 const char *const begin
= p
;
1529 valid
= validate_esc_clean_all (&p
);
1533 unsigned int prev_iter
, iter
;
1535 prev_iter
= iter
= 0;
1537 check_values
= false;
1542 while (isdigit (*p
))
1546 else /* check range */
1551 const unsigned int digits
= p
- digit
;
1552 for (i
= 0; i
< digits
; i
++)
1556 valid
= validate_esc_clean (value
, iter
, &prev_iter
, &p
, &check_values
);
1558 } while (check_values
);
1573 validate_esc_clean_all (const char **p
)
1575 while (isdigit (**p
) || **p
== ';')
1577 return (**p
== 'm');
1581 validate_esc_clean (int value
, unsigned int iter
, unsigned int *prev_iter
, const char **p
, bool *check_values
)
1583 if (is_reset (value
, iter
, p
))
1585 else if (is_attr (value
, iter
, *prev_iter
, p
))
1588 *check_values
= true;
1590 return false; /* partial escape sequence, need another valid value */
1592 else if (is_fg_color (value
, p
))
1594 else if (is_bg_color (value
, iter
, p
))
1601 is_reset (int value
, unsigned int iter
, const char **p
)
1603 return (value
== 0 && iter
== 1 && **p
== 'm');
1607 is_attr (int value
, unsigned int iter
, unsigned int prev_iter
, const char **p
)
1609 return ((value
> 0 && value
< 10) && (iter
- prev_iter
== 1) && **p
== ';');
1613 is_fg_color (int value
, const char **p
)
1615 return (((value
>= 30 && value
<= 37) || value
== 39) && **p
== 'm');
1619 is_bg_color (int value
, unsigned int iter
, const char **p
)
1621 return (((value
>= 40 && value
<= 47) || value
== 49) && iter
== 1 && **p
== 'm');
1626 malloc_wrap (size_t size
)
1628 void *p
= malloc (size
);
1635 calloc_wrap (size_t nmemb
, size_t size
)
1637 void *p
= calloc (nmemb
, size
);
1644 realloc_wrap (void *ptr
, size_t size
)
1646 void *p
= realloc (ptr
, size
);
1652 static const char *const format_debug
= "%s: %10s %7lu bytes [source file %s, line %5u]\n";
1654 malloc_wrap_debug (size_t size
, const char *file
, unsigned int line
)
1656 void *p
= malloc (size
);
1658 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1659 fprintf (log
, format_debug
, program_name
, "malloc'ed", (unsigned long)size
, file
, line
);
1664 calloc_wrap_debug (size_t nmemb
, size_t size
, const char *file
, unsigned int line
)
1666 void *p
= calloc (nmemb
, size
);
1668 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1669 fprintf (log
, format_debug
, program_name
, "calloc'ed", (unsigned long)(nmemb
* size
), file
, line
);
1674 realloc_wrap_debug (void *ptr
, size_t size
, const char *file
, unsigned int line
)
1676 void *p
= realloc (ptr
, size
);
1678 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1679 fprintf (log
, format_debug
, program_name
, "realloc'ed", (unsigned long)size
, file
, line
);
1685 free_wrap (void **ptr
)
1692 # define do_malloc(len, file, line) malloc_wrap(len)
1694 # define do_malloc(len, file, line) malloc_wrap_debug(len, file, line)
1698 strdup_wrap (const char *str
, const char *file
, unsigned int line
)
1700 const size_t len
= strlen (str
) + 1;
1701 char *p
= do_malloc (len
, file
, line
);
1702 strncpy (p
, str
, len
);
1707 str_concat_wrap (const char *str1
, const char *str2
, const char *file
, unsigned int line
)
1709 const size_t len
= strlen (str1
) + strlen (str2
) + 1;
1712 p
= str
= do_malloc (len
, file
, line
);
1713 strncpy (p
, str1
, strlen (str1
));
1715 strncpy (p
, str2
, strlen (str2
));
1723 expand_string (const char *str
)
1728 wordexp (str
, &p
, 0);
1729 if (p
.we_wordc
>= 1)
1730 s
= xstrdup (p
.we_wordv
[0]);
1737 get_bytes_size (unsigned long bytes
, struct bytes_size
*bytes_size
)
1739 const char *unit
, units
[] = { '0', 'K', 'M', 'G', '\0' };
1740 unsigned long size
= bytes
;
1744 while (size
>= 1024 && *(unit
+ 1))
1749 bytes_size
->size
= (unsigned int)size
;
1750 bytes_size
->unit
= *unit
;
1755 get_file_type (mode_t mode
)
1759 else if (S_ISDIR (mode
))
1761 else if (S_ISCHR (mode
))
1762 return "character device";
1763 else if (S_ISBLK (mode
))
1764 return "block device";
1765 else if (S_ISFIFO (mode
))
1766 return "named pipe";
1767 else if (S_ISLNK (mode
))
1768 return "symbolic link";
1769 else if (S_ISSOCK (mode
))
1776 has_color_name (const char *str
, const char *name
)
1780 assert (strlen (str
) > 0);
1781 assert (strlen (name
) > 0);
1783 if (!(*str
== *name
|| *str
== toupper (*name
)))
1785 else if (*(name
+ 1) != '\0'
1786 && !((p
= strstr (str
+ 1, name
+ 1)) && p
== str
+ 1))
1793 open_file (const char *file
, const char *mode
)
1798 stream
= fopen (file
, mode
);
1800 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1805 #define DO_VFPRINTF(fmt) \
1807 fprintf (stderr, "%s: ", program_name); \
1808 va_start (ap, fmt); \
1809 vfprintf (stderr, fmt, ap); \
1811 fprintf (stderr, "\n");
1814 vfprintf_diag (const char *fmt
, ...)
1820 vfprintf_fail (const char *fmt
, ...)
1823 exit (EXIT_FAILURE
);
1827 stack_var (void ***list
, unsigned int *stacked
, unsigned int index
, void *ptr
)
1829 /* nothing to stack */
1833 *list
= xmalloc (sizeof (void *));
1837 for (i
= 0; i
< *stacked
; i
++)
1841 return; /* reused */
1843 *list
= xrealloc (*list
, (*stacked
+ 1) * sizeof (void *));
1845 (*list
)[index
] = ptr
;
1850 release_var (void **list
, unsigned int stacked
, void **ptr
)
1853 /* nothing to release */
1856 for (i
= 0; i
< stacked
; i
++)
1857 if (list
[i
] == *ptr
)