]>
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-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_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.65"
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 conf_file_path (char **);
289 static void process_opt_attr (const char *, const bool);
290 static void write_attr (const struct attr
*, unsigned int *, const bool);
291 static void process_opt_exclude_random (const char *, const bool);
292 static void parse_conf (const char *, struct conf
*);
293 static void assign_conf (const char *, struct conf
*, const char *, char *);
294 static void init_conf_vars (const struct conf
*);
295 static void init_opts_vars (void);
296 static void print_hint (void);
297 static void print_help (void);
298 static void print_version (void);
299 static void cleanup (void);
300 static void free_color_names (struct color_name
**);
301 static void free_conf (struct conf
*);
302 static void process_args (unsigned int, char **, char *, const struct color
**, const char **, FILE **, struct conf
*);
303 static void process_file_arg (const char *, const char **, FILE **);
304 static bool skip_path_colors (const char *, const char *, const struct stat
*, const bool);
305 static void gather_color_names (const char *, char *, struct color_name
**);
306 static void read_print_stream (const char *, const struct color
**, const char *, FILE *);
307 static void merge_print_line (const char *, const char *, FILE *);
308 static void complete_part_line (const char *, char **, FILE *);
309 static bool get_next_char (char *, const char **, FILE *, bool *);
310 static void save_char (char, char **, size_t *, size_t *);
311 static void find_color_entries (struct color_name
**, const struct color
**);
312 static void find_color_entry (const struct color_name
*, unsigned int, const struct color
**);
313 static void print_line (const char *, const struct color
**, const char * const, unsigned int, bool);
314 static void print_clean (const char *);
315 static bool is_esc (const char *);
316 static const char *get_end_of_esc (const char *);
317 static const char *get_end_of_text (const char *);
318 static void print_text (const char *, size_t);
319 static bool gather_esc_offsets (const char *, const char **, const char **);
320 static bool validate_esc_clean_all (const char **);
321 static bool validate_esc_clean (int, unsigned int, unsigned int *, const char **, bool *);
322 static bool is_reset (int, unsigned int, const char **);
323 static bool is_attr (int, unsigned int, unsigned int, const char **);
324 static bool is_fg_color (int, const char **);
325 static bool is_bg_color (int, unsigned int, const char **);
327 static void *malloc_wrap (size_t);
328 static void *calloc_wrap (size_t, size_t);
329 static void *realloc_wrap (void *, size_t);
331 static void *malloc_wrap_debug (size_t, const char *, unsigned int);
332 static void *calloc_wrap_debug (size_t, size_t, const char *, unsigned int);
333 static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
335 static void free_wrap (void **);
336 static char *strdup_wrap (const char *, const char *, unsigned int);
337 static char *str_concat_wrap (const char *, const char *, const char *, unsigned int);
338 static char *expand_string (const char *);
339 static bool get_bytes_size (unsigned long, struct bytes_size
*);
340 static char *get_file_type (mode_t
);
341 static bool has_color_name (const char *, const char *);
342 static FILE *open_file (const char *, const char *);
343 static void vfprintf_diag (const char *, ...);
344 static void vfprintf_fail (const char *, ...);
345 static void stack_var (void ***, unsigned int *, unsigned int, void *);
346 static void release_var (void **, unsigned int, void **);
351 main (int argc
, char **argv
)
353 unsigned int arg_cnt
;
355 const struct color
*colors
[2] = {
356 NULL
, /* foreground */
357 NULL
, /* background */
360 const char *file
= NULL
;
362 char *conf_file
= NULL
;
363 struct conf config
= { NULL
, NULL
, NULL
, NULL
};
365 program_name
= argv
[0];
368 setvbuf (stdout
, NULL
, _IOLBF
, 0);
371 log
= open_file (DEBUG_FILE
, "w");
377 process_opts (argc
, argv
, &conf_file
);
379 #ifdef CONF_FILE_TEST
380 conf_file
= to_str (CONF_FILE_TEST
);
382 if (conf_file
== NULL
)
383 conf_file_path (&conf_file
);
387 if ((s
= expand_string (conf_file
)))
393 if (access (conf_file
, F_OK
) == -1)
394 vfprintf_fail (formats
[FMT_FILE
], conf_file
, strerror (errno
));
397 #if defined(CONF_FILE_TEST) || !defined(TEST)
398 if (access (conf_file
, F_OK
) != -1)
399 parse_conf (conf_file
, &config
);
401 #if !defined(CONF_FILE_TEST) && !defined(TEST)
404 init_conf_vars (&config
);
408 arg_cnt
= argc
- optind
;
410 if (clean
|| clean_all
)
412 if (clean
&& clean_all
)
413 vfprintf_fail (formats
[FMT_GENERIC
], "--clean and --clean-all switch are mutually exclusive");
415 vfprintf_fail ("--clean%s switch cannot be used with more than one file", clean_all
? "-all" : "");
418 const struct option_set
{
422 { "attr", OPT_ATTR_SET
},
423 { "exclude-random", OPT_EXCLUDE_RANDOM_SET
},
424 { "omit-color-empty", OPT_OMIT_COLOR_EMPTY_SET
},
426 for (i
= 0; i
< COUNT_OF (options
, struct option_set
); i
++)
427 if (opts_set
& options
[i
].set
)
428 vfprintf_diag ("--%s switch has no meaning with --clean%s", options
[i
].option
, clean_all
? "-all" : "");
433 if (arg_cnt
== 0 || arg_cnt
> 2)
435 vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt
);
441 if (clean
|| clean_all
)
442 process_file_arg (argv
[optind
], &file
, &stream
);
444 process_args (arg_cnt
, &argv
[optind
], &attr
[0], colors
, &file
, &stream
, &config
);
445 read_print_stream (&attr
[0], colors
, file
, stream
);
449 RELEASE_VAR (exclude
);
456 print_tstamp (FILE *log
)
467 perror ("localtime");
470 written
= strftime (str
, sizeof (str
), "%Y-%m-%d %H:%M:%S %Z", tm
);
472 vfprintf_fail (formats
[FMT_GENERIC
], "strftime: 0 returned");
474 fprintf (log
, "%s\n", str
);
481 #define DUP_CONFIG() \
482 *conf_file = xstrdup (optarg); \
485 #define PRINT_HELP_EXIT() \
489 #define PRINT_VERSION_EXIT() \
496 process_opts (int argc
, char **argv
, char **conf_file
)
499 while ((opt
= getopt_long (argc
, argv
, "c:hV", long_opts
, NULL
)) != -1)
503 case 0: /* long opts */
507 opts_set
|= OPT_ATTR_SET
;
508 opts_arg
.attr
= xstrdup (optarg
);
518 case OPT_EXCLUDE_RANDOM
:
519 opts_set
|= OPT_EXCLUDE_RANDOM_SET
;
520 opts_arg
.exclude_random
= xstrdup (optarg
);
522 case OPT_OMIT_COLOR_EMPTY
:
523 opts_set
|= OPT_OMIT_COLOR_EMPTY_SET
;
528 PRINT_VERSION_EXIT ();
529 default: /* never reached */
538 PRINT_VERSION_EXIT ();
542 default: /* never reached */
549 conf_file_path (char **conf_file
)
553 struct passwd
*passwd
;
558 if ((passwd
= getpwuid (uid
)) == NULL
)
561 vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid
);
566 size
= strlen (passwd
->pw_dir
) + 1 + strlen (CONF_FILE
) + 1;
567 path
= xmalloc (size
);
568 snprintf (path
, size
, "%s/%s", passwd
->pw_dir
, CONF_FILE
);
574 process_opt_attr (const char *p
, const bool is_opt
)
576 /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */
577 const struct attr attrs
[] = {
578 { "bold", 1, ATTR_BOLD
},
579 { "underscore", 4, ATTR_UNDERSCORE
},
580 { "blink", 5, ATTR_BLINK
},
581 { "reverse", 7, ATTR_REVERSE
},
582 { "concealed", 8, ATTR_CONCEALED
},
584 unsigned int attr_types
= 0;
585 const char *desc_type
[2] = { "--attr switch", "attr conf option" };
586 const unsigned int DESC_TYPE
= is_opt
? DESC_OPTION
: DESC_CONF
;
592 vfprintf_fail ("%s must be provided a string", desc_type
[DESC_TYPE
]);
596 if (*p
!= '\0' && *p
!= ',')
597 vfprintf_fail ("%s must have strings separated by ,", desc_type
[DESC_TYPE
]);
600 bool valid_attr
= false;
602 for (i
= 0; i
< COUNT_OF (attrs
, struct attr
); i
++)
604 const size_t name_len
= strlen (attrs
[i
].name
);
605 if ((size_t)(p
- s
) == name_len
&& strneq (s
, attrs
[i
].name
, name_len
))
607 write_attr (&attrs
[i
], &attr_types
, is_opt
);
614 char *attr_invalid
= xmalloc ((p
- s
) + 1);
615 STACK_VAR (attr_invalid
);
616 strncpy (attr_invalid
, s
, p
- s
);
617 attr_invalid
[p
- s
] = '\0';
618 vfprintf_fail ("%s attribute '%s' is not valid", desc_type
[DESC_TYPE
], attr_invalid
);
619 RELEASE_VAR (attr_invalid
); /* never reached */
628 write_attr (const struct attr
*attr_i
, unsigned int *attr_types
, const bool is_opt
)
630 const unsigned int val
= attr_i
->val
;
631 const enum attr_type attr_type
= attr_i
->type
;
632 const char *attr_name
= attr_i
->name
;
634 if (*attr_types
& attr_type
)
635 vfprintf_fail ("%s has attribute '%s' twice or more",
636 is_opt
? "--attr switch" : "attr conf option", attr_name
);
637 snprintf (attr
+ strlen (attr
), 3, "%u;", val
);
638 *attr_types
|= attr_type
;
642 process_opt_exclude_random (const char *s
, const bool is_opt
)
646 RELEASE_VAR (exclude
);
647 exclude
= xstrdup (s
);
649 for (i
= 1; i
< tables
[GENERIC
].count
- 1; i
++) /* skip color none and default */
651 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
652 if (streq (exclude
, entry
->name
))
659 vfprintf_fail ("%s must be provided a plain color",
660 is_opt
? "--exclude-random switch" : "exclude-random conf option");
664 init_opts_vars (void)
666 if (opts_set
& OPT_ATTR_SET
)
668 attr
[0] = '\0'; /* Clear attr string to discard values from the config file. */
669 process_opt_attr (opts_arg
.attr
, true);
671 if (opts_set
& OPT_EXCLUDE_RANDOM_SET
)
672 process_opt_exclude_random (opts_arg
.exclude_random
, true);
673 if (opts_set
& OPT_OMIT_COLOR_EMPTY_SET
)
674 omit_color_empty
= true;
676 free (opts_arg
.attr
);
677 free (opts_arg
.exclude_random
);
680 #define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
683 parse_conf (const char *conf_file
, struct conf
*config
)
685 unsigned int cnt
= 0;
689 conf
= open_file (conf_file
, "r");
691 while (fgets (line
, sizeof (line
), conf
))
694 char *assign
, *comment
, *opt
, *value
;
698 if ((p
= strchr (line
, '\r')) && *(p
+ 1) != '\n')
699 vfprintf_fail ("%s: CR ending of line %u is not supported, switch to CRLF/LF instead", conf_file
, cnt
);
700 if (strlen (line
) > (sizeof (line
) - 2))
701 vfprintf_fail ("%s: line %u exceeds maximum of %u characters", conf_file
, cnt
, (unsigned int)(sizeof (line
) - 2));
702 if ((p
= strpbrk (line
, "\n\r")))
704 /* NAME PARSING (start) */
706 /* skip leading spaces and tabs for name */
707 while (IS_SPACE (*p
))
709 /* skip line if a) string end, b) comment, [cd]) newline */
710 if (*p
== '\0' || *p
== '#' || *p
== '\n' || *p
== '\r')
713 if (!(assign
= strchr (opt
, '='))) /* check for = */
716 if ((s
= strpbrk (opt
, "# ")))
718 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "not followed by =");
721 /* skip trailing spaces and tabs for name */
722 while (IS_SPACE (*(p
- 1)))
725 /* NAME PARSING (end) */
726 /* NAME VALIDATION (start) */
727 for (p
= opt
; *p
; p
++)
728 if (!isalnum (*p
) && *p
!= '-')
729 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "cannot be made of non-option characters");
730 /* NAME VALIDATION (end) */
731 /* VALUE PARSING (start) */
733 /* skip leading spaces and tabs for value */
734 while (IS_SPACE (*p
))
736 /* skip line if comment */
740 if ((comment
= strchr (p
, '#')))
744 /* skip trailing spaces and tabs for value */
745 while (IS_SPACE (*(p
- 1)))
748 /* VALUE PARSING (end) */
750 /* save option name */
752 /* save option value (allow empty ones) */
753 val
= strlen (value
) ? xstrdup (value
) : NULL
;
755 assign_conf (conf_file
, config
, cfg
, val
);
762 #define ASSIGN_CONF(str,val) do { \
768 assign_conf (const char *conf_file
, struct conf
*config
, const char *cfg
, char *val
)
770 if (streq (cfg
, "attr"))
771 ASSIGN_CONF (config
->attr
, val
);
772 else if (streq (cfg
, "color"))
773 ASSIGN_CONF (config
->color
, val
);
774 else if (streq (cfg
, "exclude-random"))
775 ASSIGN_CONF (config
->exclude_random
, val
);
776 else if (streq (cfg
, "omit-color-empty"))
777 ASSIGN_CONF (config
->omit_color_empty
, val
);
779 vfprintf_fail (formats
[FMT_CONF
], conf_file
, cfg
, "not recognized");
783 init_conf_vars (const struct conf
*config
)
786 process_opt_attr (config
->attr
, false);
787 if (config
->exclude_random
)
788 process_opt_exclude_random (config
->exclude_random
, false);
789 if (config
->omit_color_empty
)
791 if (streq (config
->omit_color_empty
, "yes"))
792 omit_color_empty
= true;
793 else if (streq (config
->omit_color_empty
, "no"))
794 omit_color_empty
= false;
796 vfprintf_fail (formats
[FMT_GENERIC
], "omit-color-empty conf option is not valid");
803 fprintf (stderr
, "Type `%s --help' for help screen.\n", program_name
);
811 const char *short_opt
;
814 const struct opt_data opts_data
[] = {
815 { "attr", NULL
, "=ATTR1,ATTR2,..." },
816 { "config", "c", "=PATH" },
817 { "exclude-random", NULL
, "=COLOR" },
818 { "help", "h", NULL
},
819 { "version", "V", NULL
},
821 const struct option
*opt
= long_opts
;
824 printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name
, COLOR_SEP_CHAR
);
825 printf ("\tColors (foreground) (background)\n");
826 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
828 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
829 const char *name
= entry
->name
;
830 const char *code
= entry
->code
;
832 printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
833 code
, toupper (*name
), *name
, name
+ 1, 10 - (int)strlen (name
), " ", name
);
835 printf ("\t\t{-} %s%*s%s\n", name
, 13 - (int)strlen (name
), " ", name
);
837 printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
839 printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
840 printf ("\twhereas for lower case colors will be of normal intensity.\n");
842 printf ("\n\tOptions\n");
843 for (; opt
->name
; opt
++)
845 const struct opt_data
*opt_data
= NULL
;
847 for (i
= 0; i
< COUNT_OF (opts_data
, struct opt_data
); i
++)
848 if (streq (opt
->name
, opts_data
[i
].name
))
850 opt_data
= &opts_data
[i
];
855 if (opt_data
->short_opt
)
856 printf ("\t\t-%s, --%s", opt_data
->short_opt
, opt
->name
);
858 printf ("\t\t --%s", opt
->name
);
860 printf ("%s", opt_data
->arg
);
864 printf ("\t\t --%s\n", opt
->name
);
873 # include "version.h"
875 const char *const version
= NULL
;
877 const char *version_prefix
, *version_string
;
878 const char *c_flags
, *ld_flags
, *cpp_flags
;
879 const char *const desc_flags_unknown
= "unknown";
880 struct bytes_size bytes_size
;
883 c_flags
= to_str (CFLAGS
);
885 c_flags
= desc_flags_unknown
;
888 ld_flags
= to_str (LDFLAGS
);
890 ld_flags
= desc_flags_unknown
;
893 cpp_flags
= to_str (CPPFLAGS
);
895 cpp_flags
= desc_flags_unknown
;
902 version_prefix
= version
? "" : "v";
903 version_string
= version
? version
: VERSION
;
904 printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME
, version_prefix
, version_string
, __DATE__
, __TIME__
);
906 printf ("Compiler flags: %s\n", c_flags
);
907 printf ("Linker flags: %s\n", ld_flags
);
908 printf ("Preprocessor flags: %s\n", cpp_flags
);
909 if (get_bytes_size (BUF_SIZE
, &bytes_size
))
911 if (BUF_SIZE
% 1024 == 0)
912 printf ("Buffer size: %u%c\n", bytes_size
.size
, bytes_size
.unit
);
914 printf ("Buffer size: %u%c, %u byte%s\n", bytes_size
.size
, bytes_size
.unit
,
915 BUF_SIZE
% 1024, BUF_SIZE
% 1024 > 1 ? "s" : "");
918 printf ("Buffer size: %lu byte%s\n", (unsigned long)BUF_SIZE
, BUF_SIZE
> 1 ? "s" : "");
919 printf ("Color separator: '%c'\n", COLOR_SEP_CHAR
);
920 printf ("Debugging: %s\n", debug
? "yes" : "no");
926 if (stream
&& fileno (stream
) != STDIN_FILENO
)
936 for (i
= 0; i
< stacked_vars
; i
++)
938 free_null (vars_list
);
943 free_color_names (struct color_name
**color_names
)
946 for (i
= 0; color_names
[i
]; i
++)
948 RELEASE_VAR (color_names
[i
]->name
);
949 RELEASE_VAR (color_names
[i
]->orig
);
950 RELEASE_VAR (color_names
[i
]);
955 free_conf (struct conf
*config
)
958 free (config
->color
);
959 free (config
->exclude_random
);
960 free (config
->omit_color_empty
);
964 process_args (unsigned int arg_cnt
, char **arg_strings
, char *attr
, const struct color
**colors
, const char **file
, FILE **stream
, struct conf
*config
)
966 bool has_hyphen
, use_conf_color
;
970 struct color_name
*color_names
[3] = {
971 NULL
, /* foreground */
972 NULL
, /* background */
973 NULL
, /* sentinel value */
976 const char *color_string
= arg_cnt
>= 1 ? arg_strings
[0] : NULL
;
977 const char *file_string
= arg_cnt
== 2 ? arg_strings
[1] : NULL
;
979 assert (color_string
!= NULL
);
981 has_hyphen
= streq (color_string
, "-");
986 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen cannot be used as color string");
987 else if (!config
->color
)
988 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen must be preceded by color string");
991 if (!has_hyphen
&& (ret
= lstat (color_string
, &sb
)) == 0) /* exists */
992 /* Ensure that we don't fail if there's a file with one or more
993 color names in its path. */
994 use_conf_color
= skip_path_colors (color_string
, file_string
, &sb
, !!config
->color
);
996 use_conf_color
= true;
998 use_conf_color
= false;
1000 /* Use color from config file. */
1001 if (arg_cnt
== 1 && use_conf_color
)
1003 file_string
= color_string
;
1004 color_string
= config
->color
;
1007 if ((p
= strchr (color_string
, COLOR_SEP_CHAR
)))
1009 if (p
== color_string
)
1010 vfprintf_fail (formats
[FMT_STRING
], "foreground color missing in string", color_string
);
1011 else if (p
== color_string
+ strlen (color_string
) - 1)
1012 vfprintf_fail (formats
[FMT_STRING
], "background color missing in string", color_string
);
1013 else if (strchr (++p
, COLOR_SEP_CHAR
))
1014 vfprintf_fail (formats
[FMT_STRING
], "one color pair allowed only for string", color_string
);
1017 gather_color_names (color_string
, attr
, color_names
);
1019 assert (color_names
[FOREGROUND
] != NULL
);
1021 if (color_names
[BACKGROUND
])
1024 const unsigned int color_sets
[2][2] = { { FOREGROUND
, BACKGROUND
}, { BACKGROUND
, FOREGROUND
} };
1025 for (i
= 0; i
< 2; i
++)
1027 const unsigned int color1
= color_sets
[i
][0];
1028 const unsigned int color2
= color_sets
[i
][1];
1029 if (CHECK_COLORS_RANDOM (color1
, color2
))
1030 vfprintf_fail (formats
[FMT_RANDOM
], tables
[color1
].desc
, color_names
[color1
]->orig
, "cannot be combined with", color_names
[color2
]->orig
);
1034 find_color_entries (color_names
, colors
);
1035 assert (colors
[FOREGROUND
] != NULL
);
1036 free_color_names (color_names
);
1038 if (!colors
[FOREGROUND
]->code
&& colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1040 struct color_name color_name
;
1041 color_name
.name
= color_name
.orig
= "default";
1043 find_color_entry (&color_name
, FOREGROUND
, colors
);
1044 assert (colors
[FOREGROUND
]->code
!= NULL
);
1047 process_file_arg (file_string
, file
, stream
);
1051 process_file_arg (const char *file_string
, const char **file
, FILE **stream
)
1055 if (streq (file_string
, "-"))
1059 const char *file
= file_string
;
1064 ret
= stat (file
, &sb
);
1067 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1069 if (!VALID_FILE_TYPE (sb
.st_mode
))
1070 vfprintf_fail (formats
[FMT_TYPE
], file
, "unrecognized type", get_file_type (sb
.st_mode
));
1072 *stream
= open_file (file
, "r");
1074 *file
= file_string
;
1082 assert (*stream
!= NULL
);
1083 assert (*file
!= NULL
);
1087 skip_path_colors (const char *color_string
, const char *file_string
, const struct stat
*sb
, const bool has_conf
)
1091 const char *color
= color_string
;
1092 const mode_t mode
= sb
->st_mode
;
1094 for (c
= 1; c
<= 2 && *color
; c
++)
1096 bool matched
= false;
1098 for (i
= 0; i
< tables
[GENERIC
].count
; i
++)
1100 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
1101 if (has_color_name (color
, entry
->name
))
1103 color
+= strlen (entry
->name
);
1108 if (!matched
&& has_color_name (color
, "random"))
1110 color
+= strlen ("random");
1113 if (matched
&& *color
== COLOR_SEP_CHAR
&& *(color
+ 1))
1119 have_file
= (*color
!= '\0');
1123 const char *file_existing
= color_string
;
1125 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "cannot be used as color string");
1128 if (VALID_FILE_TYPE (mode
))
1132 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "must be preceded by color string");
1135 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "is not a valid file type");
1142 gather_color_names (const char *color_string
, char *attr
, struct color_name
**color_names
)
1145 char *color
, *p
, *str
;
1147 str
= xstrdup (color_string
);
1150 for (index
= 0, color
= str
; *color
; index
++, color
= p
)
1155 if ((sep
= strchr (color
, COLOR_SEP_CHAR
)))
1161 p
= color
+ strlen (color
);
1164 for (ch
= color
; *ch
; ch
++)
1166 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be made of non-alphabetic characters");
1168 for (ch
= color
+ 1; *ch
; ch
++)
1170 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be in mixed lower/upper case");
1172 if (streq (color
, "None"))
1173 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be bold");
1175 if (isupper (*color
))
1180 snprintf (attr
+ strlen (attr
), 3, "1;");
1183 vfprintf_fail (formats
[FMT_COLOR
], tables
[BACKGROUND
].desc
, color
, "cannot be bold");
1185 default: /* never reached */
1190 color_names
[index
] = xcalloc (1, sizeof (struct color_name
));
1191 STACK_VAR (color_names
[index
]);
1193 color_names
[index
]->orig
= xstrdup (color
);
1194 STACK_VAR (color_names
[index
]->orig
);
1196 for (ch
= color
; *ch
; ch
++)
1197 *ch
= tolower (*ch
);
1199 color_names
[index
]->name
= xstrdup (color
);
1200 STACK_VAR (color_names
[index
]->name
);
1207 read_print_stream (const char *attr
, const struct color
**colors
, const char *file
, FILE *stream
)
1209 char buf
[BUF_SIZE
+ 1];
1210 unsigned int flags
= 0;
1212 while (!feof (stream
))
1217 bytes_read
= fread (buf
, 1, BUF_SIZE
, stream
);
1218 if (bytes_read
!= BUF_SIZE
&& ferror (stream
))
1219 vfprintf_fail (formats
[FMT_ERROR
], BUF_SIZE
, "read");
1220 buf
[bytes_read
] = '\0';
1222 while ((eol
= strpbrk (line
, "\n\r")))
1224 const bool has_text
= (eol
> line
);
1230 if (*(eol
+ 1) == '\n')
1233 else if (*eol
== '\n')
1235 else /* never reached */
1236 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized line ending");
1237 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
1239 print_line (attr
, colors
, line
, flags
,
1240 omit_color_empty
? has_text
: true);
1246 print_line (attr
, colors
, line
, 0, true);
1248 else if (*line
!= '\0')
1251 if ((clean
|| clean_all
) && (p
= strrchr (line
, '\033')))
1252 merge_print_line (line
, p
, stream
);
1254 print_line (attr
, colors
, line
, 0, true);
1260 merge_print_line (const char *line
, const char *p
, FILE *stream
)
1263 char *merged_esc
= NULL
;
1264 const char *esc
= "";
1265 const char char_restore
= *p
;
1267 complete_part_line (p
+ 1, &buf
, stream
);
1271 /* form escape sequence */
1272 esc
= merged_esc
= str_concat (p
, buf
);
1273 /* shorten partial line accordingly */
1278 #ifdef TEST_MERGE_PART_LINE
1279 printf ("%s%s", line
, esc
);
1281 _exit (EXIT_SUCCESS
);
1284 *(char *)p
= char_restore
;
1291 complete_part_line (const char *p
, char **buf
, FILE *stream
)
1293 bool got_next_char
= false, read_from_stream
;
1297 if (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
1301 if (read_from_stream
)
1302 save_char (ch
, buf
, &i
, &size
);
1306 if (read_from_stream
)
1307 ungetc ((int)ch
, stream
);
1308 return; /* cancel */
1312 return; /* cancel */
1314 while (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
1316 if (isdigit (ch
) || ch
== ';')
1318 if (read_from_stream
)
1319 save_char (ch
, buf
, &i
, &size
);
1321 else /* got next character */
1323 got_next_char
= true;
1332 if (read_from_stream
)
1333 save_char (ch
, buf
, &i
, &size
);
1337 if (read_from_stream
)
1338 ungetc ((int)ch
, stream
);
1339 return; /* cancel */
1343 return; /* cancel */
1347 get_next_char (char *ch
, const char **p
, FILE *stream
, bool *read_from_stream
)
1352 if ((c
= fgetc (stream
)) != EOF
)
1355 *read_from_stream
= true;
1360 *read_from_stream
= false;
1368 *read_from_stream
= false;
1374 save_char (char ch
, char **buf
, size_t *i
, size_t *size
)
1378 *size
= ALLOC_COMPLETE_PART_LINE
;
1379 *buf
= xmalloc (*size
);
1381 /* +1: effective occupied size of buffer */
1382 else if ((*i
+ 1) == *size
)
1385 *buf
= xrealloc (*buf
, *size
);
1388 (*buf
)[*i
+ 1] = '\0';
1393 find_color_entries (struct color_name
**color_names
, const struct color
**colors
)
1399 gettimeofday (&tv
, NULL
);
1400 srand (tv
.tv_usec
* tv
.tv_sec
);
1402 for (index
= 0; color_names
[index
]; index
++)
1404 const char *color_name
= color_names
[index
]->name
;
1406 const unsigned int count
= tables
[index
].count
;
1407 const struct color
*const color_entries
= tables
[index
].entries
;
1409 if (streq (color_name
, "random"))
1415 i
= rand() % (count
- 2) + 1; /* omit color none and default */
1419 /* --exclude-random */
1420 if (exclude
&& streq (exclude
, color_entries
[i
].name
))
1422 else if (color_names
[BACKGROUND
] && streq (color_names
[BACKGROUND
]->name
, color_entries
[i
].name
))
1426 if (streq (colors
[FOREGROUND
]->name
, color_entries
[i
].name
))
1429 default: /* never reached */
1432 } while (excludable
);
1433 colors
[index
] = (struct color
*)&color_entries
[i
];
1436 find_color_entry (color_names
[index
], index
, colors
);
1441 find_color_entry (const struct color_name
*color_name
, unsigned int index
, const struct color
**colors
)
1446 const unsigned int count
= tables
[index
].count
;
1447 const struct color
*const color_entries
= tables
[index
].entries
;
1449 for (i
= 0; i
< count
; i
++)
1450 if (streq (color_name
->name
, color_entries
[i
].name
))
1452 colors
[index
] = (struct color
*)&color_entries
[i
];
1457 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color_name
->orig
, "not recognized");
1461 print_line (const char *attr
, const struct color
**colors
, const char *const line
, unsigned int flags
, bool emit_colors
)
1464 if (clean
|| clean_all
)
1466 /* skip for --omit-color-empty? */
1467 else if (emit_colors
)
1469 /* Foreground color code is guaranteed to be set when background color code is present. */
1470 if (colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1471 printf ("\033[%s", colors
[BACKGROUND
]->code
);
1472 if (colors
[FOREGROUND
]->code
)
1473 printf ("\033[%s%s%s\033[0m", attr
, colors
[FOREGROUND
]->code
, line
);
1475 printf (formats
[FMT_GENERIC
], line
);
1484 print_clean (const char *line
)
1486 const char *p
= line
;
1489 p
= get_end_of_esc (p
);
1493 const char *text_start
= p
;
1494 const char *text_end
= get_end_of_text (p
);
1495 print_text (text_start
, text_end
- text_start
);
1496 p
= get_end_of_esc (text_end
);
1501 is_esc (const char *p
)
1503 return gather_esc_offsets (p
, NULL
, NULL
);
1507 get_end_of_esc (const char *p
)
1510 const char *end
= NULL
;
1511 while ((esc
= strchr (p
, '\033')))
1513 if (gather_esc_offsets (esc
, NULL
, &end
))
1517 return end
? end
+ 1 : p
+ strlen (p
);
1521 get_end_of_text (const char *p
)
1524 const char *start
= NULL
;
1525 while ((esc
= strchr (p
, '\033')))
1527 if (gather_esc_offsets (esc
, &start
, NULL
))
1531 return start
? start
: p
+ strlen (p
);
1535 print_text (const char *p
, size_t len
)
1537 size_t bytes_written
;
1538 bytes_written
= fwrite (p
, 1, len
, stdout
);
1539 if (bytes_written
!= len
)
1540 vfprintf_fail (formats
[FMT_ERROR
], (unsigned long)len
, "written");
1544 gather_esc_offsets (const char *p
, const char **start
, const char **end
)
1547 if (*p
== 27 && *(p
+ 1) == '[')
1550 const char *const begin
= p
;
1553 valid
= validate_esc_clean_all (&p
);
1557 unsigned int prev_iter
, iter
;
1559 prev_iter
= iter
= 0;
1561 check_values
= false;
1566 while (isdigit (*p
))
1570 else /* check range */
1575 const unsigned int digits
= p
- digit
;
1576 for (i
= 0; i
< digits
; i
++)
1580 valid
= validate_esc_clean (value
, iter
, &prev_iter
, &p
, &check_values
);
1582 } while (check_values
);
1597 validate_esc_clean_all (const char **p
)
1599 while (isdigit (**p
) || **p
== ';')
1601 return (**p
== 'm');
1605 validate_esc_clean (int value
, unsigned int iter
, unsigned int *prev_iter
, const char **p
, bool *check_values
)
1607 if (is_reset (value
, iter
, p
))
1609 else if (is_attr (value
, iter
, *prev_iter
, p
))
1612 *check_values
= true;
1614 return false; /* partial escape sequence, need another valid value */
1616 else if (is_fg_color (value
, p
))
1618 else if (is_bg_color (value
, iter
, p
))
1625 is_reset (int value
, unsigned int iter
, const char **p
)
1627 return (value
== 0 && iter
== 1 && **p
== 'm');
1631 is_attr (int value
, unsigned int iter
, unsigned int prev_iter
, const char **p
)
1633 return ((value
> 0 && value
< 10) && (iter
- prev_iter
== 1) && **p
== ';');
1637 is_fg_color (int value
, const char **p
)
1639 return (((value
>= 30 && value
<= 37) || value
== 39) && **p
== 'm');
1643 is_bg_color (int value
, unsigned int iter
, const char **p
)
1645 return (((value
>= 40 && value
<= 47) || value
== 49) && iter
== 1 && **p
== 'm');
1650 malloc_wrap (size_t size
)
1652 void *p
= malloc (size
);
1659 calloc_wrap (size_t nmemb
, size_t size
)
1661 void *p
= calloc (nmemb
, size
);
1668 realloc_wrap (void *ptr
, size_t size
)
1670 void *p
= realloc (ptr
, size
);
1676 static const char *const format_debug
= "%s: %10s %7lu bytes [source file %s, line %5u]\n";
1678 malloc_wrap_debug (size_t size
, const char *file
, unsigned int line
)
1680 void *p
= malloc (size
);
1682 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1683 fprintf (log
, format_debug
, program_name
, "malloc'ed", (unsigned long)size
, file
, line
);
1688 calloc_wrap_debug (size_t nmemb
, size_t size
, const char *file
, unsigned int line
)
1690 void *p
= calloc (nmemb
, size
);
1692 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1693 fprintf (log
, format_debug
, program_name
, "calloc'ed", (unsigned long)(nmemb
* size
), file
, line
);
1698 realloc_wrap_debug (void *ptr
, size_t size
, const char *file
, unsigned int line
)
1700 void *p
= realloc (ptr
, size
);
1702 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1703 fprintf (log
, format_debug
, program_name
, "realloc'ed", (unsigned long)size
, file
, line
);
1709 free_wrap (void **ptr
)
1716 # define do_malloc(len, file, line) malloc_wrap(len)
1718 # define do_malloc(len, file, line) malloc_wrap_debug(len, file, line)
1722 strdup_wrap (const char *str
, const char *file
, unsigned int line
)
1724 const size_t len
= strlen (str
) + 1;
1725 char *p
= do_malloc (len
, file
, line
);
1726 strncpy (p
, str
, len
);
1731 str_concat_wrap (const char *str1
, const char *str2
, const char *file
, unsigned int line
)
1733 const size_t len
= strlen (str1
) + strlen (str2
) + 1;
1736 p
= str
= do_malloc (len
, file
, line
);
1737 strncpy (p
, str1
, strlen (str1
));
1739 strncpy (p
, str2
, strlen (str2
));
1747 expand_string (const char *str
)
1752 wordexp (str
, &p
, 0);
1753 if (p
.we_wordc
>= 1)
1754 s
= xstrdup (p
.we_wordv
[0]);
1761 get_bytes_size (unsigned long bytes
, struct bytes_size
*bytes_size
)
1763 const char *unit
, units
[] = { '0', 'K', 'M', 'G', '\0' };
1764 unsigned long size
= bytes
;
1768 while (size
>= 1024 && *(unit
+ 1))
1773 bytes_size
->size
= (unsigned int)size
;
1774 bytes_size
->unit
= *unit
;
1779 get_file_type (mode_t mode
)
1783 else if (S_ISDIR (mode
))
1785 else if (S_ISCHR (mode
))
1786 return "character device";
1787 else if (S_ISBLK (mode
))
1788 return "block device";
1789 else if (S_ISFIFO (mode
))
1790 return "named pipe";
1791 else if (S_ISLNK (mode
))
1792 return "symbolic link";
1793 else if (S_ISSOCK (mode
))
1800 has_color_name (const char *str
, const char *name
)
1804 assert (strlen (str
) > 0);
1805 assert (strlen (name
) > 0);
1807 if (!(*str
== *name
|| *str
== toupper (*name
)))
1809 else if (*(name
+ 1) != '\0'
1810 && !((p
= strstr (str
+ 1, name
+ 1)) && p
== str
+ 1))
1817 open_file (const char *file
, const char *mode
)
1822 stream
= fopen (file
, mode
);
1824 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1829 #define DO_VFPRINTF(fmt) \
1831 fprintf (stderr, "%s: ", program_name); \
1832 va_start (ap, fmt); \
1833 vfprintf (stderr, fmt, ap); \
1835 fprintf (stderr, "\n");
1838 vfprintf_diag (const char *fmt
, ...)
1844 vfprintf_fail (const char *fmt
, ...)
1847 exit (EXIT_FAILURE
);
1851 stack_var (void ***list
, unsigned int *stacked
, unsigned int index
, void *ptr
)
1853 /* nothing to stack */
1857 *list
= xmalloc (sizeof (void *));
1861 for (i
= 0; i
< *stacked
; i
++)
1865 return; /* reused */
1867 *list
= xrealloc (*list
, (*stacked
+ 1) * sizeof (void *));
1869 (*list
)[index
] = ptr
;
1874 release_var (void **list
, unsigned int stacked
, void **ptr
)
1877 /* nothing to release */
1880 for (i
= 0; i
< stacked
; i
++)
1881 if (list
[i
] == *ptr
)