]>
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");
416 const char *const format
= "%s %s";
417 const char *const message
= "switch cannot be used with more than one file";
419 vfprintf_fail (format
, "--clean", message
);
421 vfprintf_fail (format
, "--clean-all", message
);
425 const struct option_set
{
429 { "attr", OPT_ATTR_SET
},
430 { "exclude-random", OPT_EXCLUDE_RANDOM_SET
},
431 { "omit-color-empty", OPT_OMIT_COLOR_EMPTY_SET
},
433 for (i
= 0; i
< COUNT_OF (options
, struct option_set
); i
++)
434 if (opts_set
& options
[i
].set
)
435 vfprintf_diag ("--%s switch has no meaning with --clean%s", options
[i
].option
, clean_all
? "-all" : "");
440 if (arg_cnt
== 0 || arg_cnt
> 2)
442 vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt
);
448 if (clean
|| clean_all
)
449 process_file_arg (argv
[optind
], &file
, &stream
);
451 process_args (arg_cnt
, &argv
[optind
], &attr
[0], colors
, &file
, &stream
, &config
);
452 read_print_stream (&attr
[0], colors
, file
, stream
);
456 RELEASE_VAR (exclude
);
463 print_tstamp (FILE *log
)
474 perror ("localtime");
477 written
= strftime (str
, sizeof (str
), "%Y-%m-%d %H:%M:%S %Z", tm
);
479 vfprintf_fail (formats
[FMT_GENERIC
], "strftime: 0 returned");
481 fprintf (log
, "%s\n", str
);
488 #define DUP_CONFIG() \
489 *conf_file = xstrdup (optarg); \
492 #define PRINT_HELP_EXIT() \
496 #define PRINT_VERSION_EXIT() \
503 process_opts (int argc
, char **argv
, char **conf_file
)
506 while ((opt
= getopt_long (argc
, argv
, "c:hV", long_opts
, NULL
)) != -1)
510 case 0: /* long opts */
514 opts_set
|= OPT_ATTR_SET
;
515 opts_arg
.attr
= 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 */
545 PRINT_VERSION_EXIT ();
549 default: /* never reached */
556 conf_file_path (char **conf_file
)
560 struct passwd
*passwd
;
565 if ((passwd
= getpwuid (uid
)) == NULL
)
568 vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid
);
573 size
= strlen (passwd
->pw_dir
) + 1 + strlen (CONF_FILE
) + 1;
574 path
= xmalloc (size
);
575 snprintf (path
, size
, "%s/%s", passwd
->pw_dir
, CONF_FILE
);
581 process_opt_attr (const char *p
, const bool is_opt
)
583 /* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */
584 const struct attr attrs
[] = {
585 { "bold", 1, ATTR_BOLD
},
586 { "underscore", 4, ATTR_UNDERSCORE
},
587 { "blink", 5, ATTR_BLINK
},
588 { "reverse", 7, ATTR_REVERSE
},
589 { "concealed", 8, ATTR_CONCEALED
},
591 unsigned int attr_types
= 0;
592 const char *desc_type
[2] = { "--attr switch", "attr conf option" };
593 const unsigned int DESC_TYPE
= is_opt
? DESC_OPTION
: DESC_CONF
;
599 vfprintf_fail ("%s must be provided a string", desc_type
[DESC_TYPE
]);
603 if (*p
!= '\0' && *p
!= ',')
604 vfprintf_fail ("%s must have strings separated by ,", desc_type
[DESC_TYPE
]);
607 bool valid_attr
= false;
609 for (i
= 0; i
< COUNT_OF (attrs
, struct attr
); i
++)
611 const size_t name_len
= strlen (attrs
[i
].name
);
612 if ((size_t)(p
- s
) == name_len
&& strneq (s
, attrs
[i
].name
, name_len
))
614 write_attr (&attrs
[i
], &attr_types
, is_opt
);
621 char *attr_invalid
= xmalloc ((p
- s
) + 1);
622 STACK_VAR (attr_invalid
);
623 strncpy (attr_invalid
, s
, p
- s
);
624 attr_invalid
[p
- s
] = '\0';
625 vfprintf_fail ("%s attribute '%s' is not valid", desc_type
[DESC_TYPE
], attr_invalid
);
626 RELEASE_VAR (attr_invalid
); /* never reached */
635 write_attr (const struct attr
*attr_i
, unsigned int *attr_types
, const bool is_opt
)
637 const unsigned int val
= attr_i
->val
;
638 const enum attr_type attr_type
= attr_i
->type
;
639 const char *attr_name
= attr_i
->name
;
641 if (*attr_types
& attr_type
)
642 vfprintf_fail ("%s has attribute '%s' twice or more",
643 is_opt
? "--attr switch" : "attr conf option", attr_name
);
644 snprintf (attr
+ strlen (attr
), 3, "%u;", val
);
645 *attr_types
|= attr_type
;
649 process_opt_exclude_random (const char *s
, const bool is_opt
)
653 RELEASE_VAR (exclude
);
654 exclude
= xstrdup (s
);
656 for (i
= 1; i
< tables
[GENERIC
].count
- 1; i
++) /* skip color none and default */
658 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
659 if (streq (exclude
, entry
->name
))
666 vfprintf_fail ("%s must be provided a plain color",
667 is_opt
? "--exclude-random switch" : "exclude-random conf option");
671 init_opts_vars (void)
673 if (opts_set
& OPT_ATTR_SET
)
675 attr
[0] = '\0'; /* Clear attr string to discard values from the config file. */
676 process_opt_attr (opts_arg
.attr
, true);
678 if (opts_set
& OPT_EXCLUDE_RANDOM_SET
)
679 process_opt_exclude_random (opts_arg
.exclude_random
, true);
680 if (opts_set
& OPT_OMIT_COLOR_EMPTY_SET
)
681 omit_color_empty
= true;
683 free (opts_arg
.attr
);
684 free (opts_arg
.exclude_random
);
687 #define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
690 parse_conf (const char *conf_file
, struct conf
*config
)
692 unsigned int cnt
= 0;
696 conf
= open_file (conf_file
, "r");
698 while (fgets (line
, sizeof (line
), conf
))
701 char *assign
, *comment
, *opt
, *value
;
705 if ((p
= strchr (line
, '\r')) && *(p
+ 1) != '\n')
706 vfprintf_fail ("%s: CR ending of line %u is not supported, switch to CRLF/LF instead", conf_file
, cnt
);
707 if (strlen (line
) > (sizeof (line
) - 2))
708 vfprintf_fail ("%s: line %u exceeds maximum of %u characters", conf_file
, cnt
, (unsigned int)(sizeof (line
) - 2));
709 if ((p
= strpbrk (line
, "\n\r")))
711 /* NAME PARSING (start) */
713 /* skip leading spaces and tabs for name */
714 while (IS_SPACE (*p
))
716 /* skip line if a) string end, b) comment, [cd]) newline */
717 if (*p
== '\0' || *p
== '#' || *p
== '\n' || *p
== '\r')
720 if (!(assign
= strchr (opt
, '='))) /* check for = */
723 if ((s
= strpbrk (opt
, "# ")))
725 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "not followed by =");
728 /* skip trailing spaces and tabs for name */
729 while (IS_SPACE (*(p
- 1)))
732 /* NAME PARSING (end) */
733 /* NAME VALIDATION (start) */
734 for (p
= opt
; *p
; p
++)
735 if (!isalnum (*p
) && *p
!= '-')
736 vfprintf_fail (formats
[FMT_CONF
], conf_file
, opt
, "cannot be made of non-option characters");
737 /* NAME VALIDATION (end) */
738 /* VALUE PARSING (start) */
740 /* skip leading spaces and tabs for value */
741 while (IS_SPACE (*p
))
743 /* skip line if comment */
747 if ((comment
= strchr (p
, '#')))
751 /* skip trailing spaces and tabs for value */
752 while (IS_SPACE (*(p
- 1)))
755 /* VALUE PARSING (end) */
757 /* save option name */
759 /* save option value (allow empty ones) */
760 val
= strlen (value
) ? xstrdup (value
) : NULL
;
762 assign_conf (conf_file
, config
, cfg
, val
);
769 #define ASSIGN_CONF(str,val) do { \
775 assign_conf (const char *conf_file
, struct conf
*config
, const char *cfg
, char *val
)
777 if (streq (cfg
, "attr"))
778 ASSIGN_CONF (config
->attr
, val
);
779 else if (streq (cfg
, "color"))
780 ASSIGN_CONF (config
->color
, val
);
781 else if (streq (cfg
, "exclude-random"))
782 ASSIGN_CONF (config
->exclude_random
, val
);
783 else if (streq (cfg
, "omit-color-empty"))
784 ASSIGN_CONF (config
->omit_color_empty
, val
);
786 vfprintf_fail (formats
[FMT_CONF
], conf_file
, cfg
, "not recognized");
790 init_conf_vars (const struct conf
*config
)
793 process_opt_attr (config
->attr
, false);
794 if (config
->exclude_random
)
795 process_opt_exclude_random (config
->exclude_random
, false);
796 if (config
->omit_color_empty
)
798 if (streq (config
->omit_color_empty
, "yes"))
799 omit_color_empty
= true;
800 else if (streq (config
->omit_color_empty
, "no"))
801 omit_color_empty
= false;
803 vfprintf_fail (formats
[FMT_GENERIC
], "omit-color-empty conf option is not valid");
810 fprintf (stderr
, "Type `%s --help' for help screen.\n", program_name
);
818 const char *short_opt
;
821 const struct opt_data opts_data
[] = {
822 { "attr", NULL
, "=ATTR1,ATTR2,..." },
823 { "config", "c", "=PATH" },
824 { "exclude-random", NULL
, "=COLOR" },
825 { "help", "h", NULL
},
826 { "version", "V", NULL
},
828 const struct option
*opt
= long_opts
;
831 printf ("Usage: %s (foreground) OR (foreground)%c(background) OR --clean[-all] [-|file]\n\n", program_name
, COLOR_SEP_CHAR
);
832 printf ("\tColors (foreground) (background)\n");
833 for (i
= 0; i
< tables
[FOREGROUND
].count
; i
++)
835 const struct color
*entry
= &tables
[FOREGROUND
].entries
[i
];
836 const char *name
= entry
->name
;
837 const char *code
= entry
->code
;
839 printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
840 code
, toupper (*name
), *name
, name
+ 1, 10 - (int)strlen (name
), " ", name
);
842 printf ("\t\t{-} %s%*s%s\n", name
, 13 - (int)strlen (name
), " ", name
);
844 printf ("\t\t{*} [Rr]%s%*s%s [--exclude-random=<foreground color>]\n", "andom", 10 - (int)strlen ("random"), " ", "random");
846 printf ("\n\tFirst character of color name in upper case denotes increased intensity,\n");
847 printf ("\twhereas for lower case colors will be of normal intensity.\n");
849 printf ("\n\tOptions\n");
850 for (; opt
->name
; opt
++)
852 const struct opt_data
*opt_data
= NULL
;
854 for (i
= 0; i
< COUNT_OF (opts_data
, struct opt_data
); i
++)
855 if (streq (opt
->name
, opts_data
[i
].name
))
857 opt_data
= &opts_data
[i
];
862 if (opt_data
->short_opt
)
863 printf ("\t\t-%s, --%s", opt_data
->short_opt
, opt
->name
);
865 printf ("\t\t --%s", opt
->name
);
867 printf ("%s", opt_data
->arg
);
871 printf ("\t\t --%s\n", opt
->name
);
880 # include "version.h"
882 const char *const version
= NULL
;
884 const char *version_prefix
, *version_string
;
885 const char *c_flags
, *ld_flags
, *cpp_flags
;
886 const char *const desc_flags_unknown
= "unknown";
887 struct bytes_size bytes_size
;
890 c_flags
= to_str (CFLAGS
);
892 c_flags
= desc_flags_unknown
;
895 ld_flags
= to_str (LDFLAGS
);
897 ld_flags
= desc_flags_unknown
;
900 cpp_flags
= to_str (CPPFLAGS
);
902 cpp_flags
= desc_flags_unknown
;
909 version_prefix
= version
? "" : "v";
910 version_string
= version
? version
: VERSION
;
911 printf ("%s %s%s (compiled at %s, %s)\n", PROGRAM_NAME
, version_prefix
, version_string
, __DATE__
, __TIME__
);
913 printf ("Compiler flags: %s\n", c_flags
);
914 printf ("Linker flags: %s\n", ld_flags
);
915 printf ("Preprocessor flags: %s\n", cpp_flags
);
916 if (get_bytes_size (BUF_SIZE
, &bytes_size
))
918 if (BUF_SIZE
% 1024 == 0)
919 printf ("Buffer size: %u%c\n", bytes_size
.size
, bytes_size
.unit
);
921 printf ("Buffer size: %u%c, %u byte%s\n", bytes_size
.size
, bytes_size
.unit
,
922 BUF_SIZE
% 1024, BUF_SIZE
% 1024 > 1 ? "s" : "");
925 printf ("Buffer size: %lu byte%s\n", (unsigned long)BUF_SIZE
, BUF_SIZE
> 1 ? "s" : "");
926 printf ("Color separator: '%c'\n", COLOR_SEP_CHAR
);
927 printf ("Debugging: %s\n", debug
? "yes" : "no");
933 if (stream
&& fileno (stream
) != STDIN_FILENO
)
943 for (i
= 0; i
< stacked_vars
; i
++)
945 free_null (vars_list
);
950 free_color_names (struct color_name
**color_names
)
953 for (i
= 0; color_names
[i
]; i
++)
955 RELEASE_VAR (color_names
[i
]->name
);
956 RELEASE_VAR (color_names
[i
]->orig
);
957 RELEASE_VAR (color_names
[i
]);
962 free_conf (struct conf
*config
)
965 free (config
->color
);
966 free (config
->exclude_random
);
967 free (config
->omit_color_empty
);
971 process_args (unsigned int arg_cnt
, char **arg_strings
, char *attr
, const struct color
**colors
, const char **file
, FILE **stream
, struct conf
*config
)
973 bool has_hyphen
, use_conf_color
;
977 struct color_name
*color_names
[3] = {
978 NULL
, /* foreground */
979 NULL
, /* background */
980 NULL
, /* sentinel value */
983 const char *color_string
= arg_cnt
>= 1 ? arg_strings
[0] : NULL
;
984 const char *file_string
= arg_cnt
== 2 ? arg_strings
[1] : NULL
;
986 assert (color_string
!= NULL
);
988 has_hyphen
= streq (color_string
, "-");
993 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen cannot be used as color string");
994 else if (!config
->color
)
995 vfprintf_fail (formats
[FMT_GENERIC
], "hyphen must be preceded by color string");
998 if (!has_hyphen
&& (ret
= lstat (color_string
, &sb
)) == 0) /* exists */
999 /* Ensure that we don't fail if there's a file with one or more
1000 color names in its path. */
1001 use_conf_color
= skip_path_colors (color_string
, file_string
, &sb
, !!config
->color
);
1002 else if (has_hyphen
)
1003 use_conf_color
= true;
1005 use_conf_color
= false;
1007 /* Use color from config file. */
1008 if (arg_cnt
== 1 && use_conf_color
)
1010 file_string
= color_string
;
1011 color_string
= config
->color
;
1014 if ((p
= strchr (color_string
, COLOR_SEP_CHAR
)))
1016 if (p
== color_string
)
1017 vfprintf_fail (formats
[FMT_STRING
], "foreground color missing in string", color_string
);
1018 else if (p
== color_string
+ strlen (color_string
) - 1)
1019 vfprintf_fail (formats
[FMT_STRING
], "background color missing in string", color_string
);
1020 else if (strchr (++p
, COLOR_SEP_CHAR
))
1021 vfprintf_fail (formats
[FMT_STRING
], "one color pair allowed only for string", color_string
);
1024 gather_color_names (color_string
, attr
, color_names
);
1026 assert (color_names
[FOREGROUND
] != NULL
);
1028 if (color_names
[BACKGROUND
])
1031 const unsigned int color_sets
[2][2] = { { FOREGROUND
, BACKGROUND
}, { BACKGROUND
, FOREGROUND
} };
1032 for (i
= 0; i
< 2; i
++)
1034 const unsigned int color1
= color_sets
[i
][0];
1035 const unsigned int color2
= color_sets
[i
][1];
1036 if (CHECK_COLORS_RANDOM (color1
, color2
))
1037 vfprintf_fail (formats
[FMT_RANDOM
], tables
[color1
].desc
, color_names
[color1
]->orig
, "cannot be combined with", color_names
[color2
]->orig
);
1041 find_color_entries (color_names
, colors
);
1042 assert (colors
[FOREGROUND
] != NULL
);
1043 free_color_names (color_names
);
1045 if (!colors
[FOREGROUND
]->code
&& colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1047 struct color_name color_name
;
1048 color_name
.name
= color_name
.orig
= "default";
1050 find_color_entry (&color_name
, FOREGROUND
, colors
);
1051 assert (colors
[FOREGROUND
]->code
!= NULL
);
1054 process_file_arg (file_string
, file
, stream
);
1058 process_file_arg (const char *file_string
, const char **file
, FILE **stream
)
1062 if (streq (file_string
, "-"))
1066 const char *file
= file_string
;
1071 ret
= stat (file
, &sb
);
1074 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1076 if (!VALID_FILE_TYPE (sb
.st_mode
))
1077 vfprintf_fail (formats
[FMT_TYPE
], file
, "unrecognized type", get_file_type (sb
.st_mode
));
1079 *stream
= open_file (file
, "r");
1081 *file
= file_string
;
1089 assert (*stream
!= NULL
);
1090 assert (*file
!= NULL
);
1094 skip_path_colors (const char *color_string
, const char *file_string
, const struct stat
*sb
, const bool has_conf
)
1098 const char *color
= color_string
;
1099 const mode_t mode
= sb
->st_mode
;
1101 for (c
= 1; c
<= 2 && *color
; c
++)
1103 bool matched
= false;
1105 for (i
= 0; i
< tables
[GENERIC
].count
; i
++)
1107 const struct color
*entry
= &tables
[GENERIC
].entries
[i
];
1108 if (has_color_name (color
, entry
->name
))
1110 color
+= strlen (entry
->name
);
1115 if (!matched
&& has_color_name (color
, "random"))
1117 color
+= strlen ("random");
1120 if (matched
&& *color
== COLOR_SEP_CHAR
&& *(color
+ 1))
1126 have_file
= (*color
!= '\0');
1130 const char *file_existing
= color_string
;
1132 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "cannot be used as color string");
1135 if (VALID_FILE_TYPE (mode
))
1139 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "must be preceded by color string");
1142 vfprintf_fail (formats
[FMT_QUOTE
], get_file_type (mode
), file_existing
, "is not a valid file type");
1149 gather_color_names (const char *color_string
, char *attr
, struct color_name
**color_names
)
1152 char *color
, *p
, *str
;
1154 str
= xstrdup (color_string
);
1157 for (index
= 0, color
= str
; *color
; index
++, color
= p
)
1162 if ((sep
= strchr (color
, COLOR_SEP_CHAR
)))
1168 p
= color
+ strlen (color
);
1171 for (ch
= color
; *ch
; ch
++)
1173 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be made of non-alphabetic characters");
1175 for (ch
= color
+ 1; *ch
; ch
++)
1177 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be in mixed lower/upper case");
1179 if (streq (color
, "None"))
1180 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color
, "cannot be bold");
1182 if (isupper (*color
))
1187 snprintf (attr
+ strlen (attr
), 3, "1;");
1190 vfprintf_fail (formats
[FMT_COLOR
], tables
[BACKGROUND
].desc
, color
, "cannot be bold");
1192 default: /* never reached */
1197 color_names
[index
] = xcalloc (1, sizeof (struct color_name
));
1198 STACK_VAR (color_names
[index
]);
1200 color_names
[index
]->orig
= xstrdup (color
);
1201 STACK_VAR (color_names
[index
]->orig
);
1203 for (ch
= color
; *ch
; ch
++)
1204 *ch
= tolower (*ch
);
1206 color_names
[index
]->name
= xstrdup (color
);
1207 STACK_VAR (color_names
[index
]->name
);
1214 read_print_stream (const char *attr
, const struct color
**colors
, const char *file
, FILE *stream
)
1216 char buf
[BUF_SIZE
+ 1];
1217 unsigned int flags
= 0;
1219 while (!feof (stream
))
1224 bytes_read
= fread (buf
, 1, BUF_SIZE
, stream
);
1225 if (bytes_read
!= BUF_SIZE
&& ferror (stream
))
1226 vfprintf_fail (formats
[FMT_ERROR
], BUF_SIZE
, "read");
1227 buf
[bytes_read
] = '\0';
1229 while ((eol
= strpbrk (line
, "\n\r")))
1231 const bool has_text
= (eol
> line
);
1237 if (*(eol
+ 1) == '\n')
1240 else if (*eol
== '\n')
1242 else /* never reached */
1243 vfprintf_fail (formats
[FMT_FILE
], file
, "unrecognized line ending");
1244 p
= eol
+ SKIP_LINE_ENDINGS (flags
);
1246 print_line (attr
, colors
, line
, flags
,
1247 omit_color_empty
? has_text
: true);
1253 print_line (attr
, colors
, line
, 0, true);
1255 else if (*line
!= '\0')
1258 if ((clean
|| clean_all
) && (p
= strrchr (line
, '\033')))
1259 merge_print_line (line
, p
, stream
);
1261 print_line (attr
, colors
, line
, 0, true);
1267 merge_print_line (const char *line
, const char *p
, FILE *stream
)
1270 char *merged_esc
= NULL
;
1271 const char *esc
= "";
1272 const char char_restore
= *p
;
1274 complete_part_line (p
+ 1, &buf
, stream
);
1278 /* form escape sequence */
1279 esc
= merged_esc
= str_concat (p
, buf
);
1280 /* shorten partial line accordingly */
1285 #ifdef TEST_MERGE_PART_LINE
1286 printf ("%s%s", line
, esc
);
1288 _exit (EXIT_SUCCESS
);
1291 *(char *)p
= char_restore
;
1298 complete_part_line (const char *p
, char **buf
, FILE *stream
)
1300 bool got_next_char
= false, read_from_stream
;
1304 if (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
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 */
1321 while (get_next_char (&ch
, &p
, stream
, &read_from_stream
))
1323 if (isdigit (ch
) || ch
== ';')
1325 if (read_from_stream
)
1326 save_char (ch
, buf
, &i
, &size
);
1328 else /* got next character */
1330 got_next_char
= true;
1339 if (read_from_stream
)
1340 save_char (ch
, buf
, &i
, &size
);
1344 if (read_from_stream
)
1345 ungetc ((int)ch
, stream
);
1346 return; /* cancel */
1350 return; /* cancel */
1354 get_next_char (char *ch
, const char **p
, FILE *stream
, bool *read_from_stream
)
1359 if ((c
= fgetc (stream
)) != EOF
)
1362 *read_from_stream
= true;
1367 *read_from_stream
= false;
1375 *read_from_stream
= false;
1381 save_char (char ch
, char **buf
, size_t *i
, size_t *size
)
1385 *size
= ALLOC_COMPLETE_PART_LINE
;
1386 *buf
= xmalloc (*size
);
1388 /* +1: effective occupied size of buffer */
1389 else if ((*i
+ 1) == *size
)
1392 *buf
= xrealloc (*buf
, *size
);
1395 (*buf
)[*i
+ 1] = '\0';
1400 find_color_entries (struct color_name
**color_names
, const struct color
**colors
)
1406 gettimeofday (&tv
, NULL
);
1407 srand (tv
.tv_usec
* tv
.tv_sec
);
1409 for (index
= 0; color_names
[index
]; index
++)
1411 const char *color_name
= color_names
[index
]->name
;
1413 const unsigned int count
= tables
[index
].count
;
1414 const struct color
*const color_entries
= tables
[index
].entries
;
1416 if (streq (color_name
, "random"))
1422 i
= rand() % (count
- 2) + 1; /* omit color none and default */
1426 /* --exclude-random */
1427 if (exclude
&& streq (exclude
, color_entries
[i
].name
))
1429 else if (color_names
[BACKGROUND
] && streq (color_names
[BACKGROUND
]->name
, color_entries
[i
].name
))
1433 if (streq (colors
[FOREGROUND
]->name
, color_entries
[i
].name
))
1436 default: /* never reached */
1439 } while (excludable
);
1440 colors
[index
] = (struct color
*)&color_entries
[i
];
1443 find_color_entry (color_names
[index
], index
, colors
);
1448 find_color_entry (const struct color_name
*color_name
, unsigned int index
, const struct color
**colors
)
1453 const unsigned int count
= tables
[index
].count
;
1454 const struct color
*const color_entries
= tables
[index
].entries
;
1456 for (i
= 0; i
< count
; i
++)
1457 if (streq (color_name
->name
, color_entries
[i
].name
))
1459 colors
[index
] = (struct color
*)&color_entries
[i
];
1464 vfprintf_fail (formats
[FMT_COLOR
], tables
[index
].desc
, color_name
->orig
, "not recognized");
1468 print_line (const char *attr
, const struct color
**colors
, const char *const line
, unsigned int flags
, bool emit_colors
)
1471 if (clean
|| clean_all
)
1473 /* skip for --omit-color-empty? */
1474 else if (emit_colors
)
1476 /* Foreground color code is guaranteed to be set when background color code is present. */
1477 if (colors
[BACKGROUND
] && colors
[BACKGROUND
]->code
)
1478 printf ("\033[%s", colors
[BACKGROUND
]->code
);
1479 if (colors
[FOREGROUND
]->code
)
1480 printf ("\033[%s%s%s\033[0m", attr
, colors
[FOREGROUND
]->code
, line
);
1482 printf (formats
[FMT_GENERIC
], line
);
1491 print_clean (const char *line
)
1493 const char *p
= line
;
1496 p
= get_end_of_esc (p
);
1500 const char *text_start
= p
;
1501 const char *text_end
= get_end_of_text (p
);
1502 print_text (text_start
, text_end
- text_start
);
1503 p
= get_end_of_esc (text_end
);
1508 is_esc (const char *p
)
1510 return gather_esc_offsets (p
, NULL
, NULL
);
1514 get_end_of_esc (const char *p
)
1517 const char *end
= NULL
;
1518 while ((esc
= strchr (p
, '\033')))
1520 if (gather_esc_offsets (esc
, NULL
, &end
))
1524 return end
? end
+ 1 : p
+ strlen (p
);
1528 get_end_of_text (const char *p
)
1531 const char *start
= NULL
;
1532 while ((esc
= strchr (p
, '\033')))
1534 if (gather_esc_offsets (esc
, &start
, NULL
))
1538 return start
? start
: p
+ strlen (p
);
1542 print_text (const char *p
, size_t len
)
1544 size_t bytes_written
;
1545 bytes_written
= fwrite (p
, 1, len
, stdout
);
1546 if (bytes_written
!= len
)
1547 vfprintf_fail (formats
[FMT_ERROR
], (unsigned long)len
, "written");
1551 gather_esc_offsets (const char *p
, const char **start
, const char **end
)
1554 if (*p
== 27 && *(p
+ 1) == '[')
1557 const char *const begin
= p
;
1560 valid
= validate_esc_clean_all (&p
);
1564 unsigned int prev_iter
, iter
;
1566 prev_iter
= iter
= 0;
1568 check_values
= false;
1573 while (isdigit (*p
))
1577 else /* check range */
1582 const unsigned int digits
= p
- digit
;
1583 for (i
= 0; i
< digits
; i
++)
1587 valid
= validate_esc_clean (value
, iter
, &prev_iter
, &p
, &check_values
);
1589 } while (check_values
);
1604 validate_esc_clean_all (const char **p
)
1606 while (isdigit (**p
) || **p
== ';')
1608 return (**p
== 'm');
1612 validate_esc_clean (int value
, unsigned int iter
, unsigned int *prev_iter
, const char **p
, bool *check_values
)
1614 if (is_reset (value
, iter
, p
))
1616 else if (is_attr (value
, iter
, *prev_iter
, p
))
1619 *check_values
= true;
1621 return false; /* partial escape sequence, need another valid value */
1623 else if (is_fg_color (value
, p
))
1625 else if (is_bg_color (value
, iter
, p
))
1632 is_reset (int value
, unsigned int iter
, const char **p
)
1634 return (value
== 0 && iter
== 1 && **p
== 'm');
1638 is_attr (int value
, unsigned int iter
, unsigned int prev_iter
, const char **p
)
1640 return ((value
> 0 && value
< 10) && (iter
- prev_iter
== 1) && **p
== ';');
1644 is_fg_color (int value
, const char **p
)
1646 return (((value
>= 30 && value
<= 37) || value
== 39) && **p
== 'm');
1650 is_bg_color (int value
, unsigned int iter
, const char **p
)
1652 return (((value
>= 40 && value
<= 47) || value
== 49) && iter
== 1 && **p
== 'm');
1657 malloc_wrap (size_t size
)
1659 void *p
= malloc (size
);
1666 calloc_wrap (size_t nmemb
, size_t size
)
1668 void *p
= calloc (nmemb
, size
);
1675 realloc_wrap (void *ptr
, size_t size
)
1677 void *p
= realloc (ptr
, size
);
1683 static const char *const format_debug
= "%s: %10s %7lu bytes [source file %s, line %5u]\n";
1685 malloc_wrap_debug (size_t size
, const char *file
, unsigned int line
)
1687 void *p
= malloc (size
);
1689 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1690 fprintf (log
, format_debug
, program_name
, "malloc'ed", (unsigned long)size
, file
, line
);
1695 calloc_wrap_debug (size_t nmemb
, size_t size
, const char *file
, unsigned int line
)
1697 void *p
= calloc (nmemb
, size
);
1699 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1700 fprintf (log
, format_debug
, program_name
, "calloc'ed", (unsigned long)(nmemb
* size
), file
, line
);
1705 realloc_wrap_debug (void *ptr
, size_t size
, const char *file
, unsigned int line
)
1707 void *p
= realloc (ptr
, size
);
1709 MEM_ALLOC_FAIL_DEBUG (file
, line
);
1710 fprintf (log
, format_debug
, program_name
, "realloc'ed", (unsigned long)size
, file
, line
);
1716 free_wrap (void **ptr
)
1723 # define do_malloc(len, file, line) malloc_wrap(len)
1725 # define do_malloc(len, file, line) malloc_wrap_debug(len, file, line)
1729 strdup_wrap (const char *str
, const char *file
, unsigned int line
)
1731 const size_t len
= strlen (str
) + 1;
1732 char *p
= do_malloc (len
, file
, line
);
1733 strncpy (p
, str
, len
);
1738 str_concat_wrap (const char *str1
, const char *str2
, const char *file
, unsigned int line
)
1740 const size_t len
= strlen (str1
) + strlen (str2
) + 1;
1743 p
= str
= do_malloc (len
, file
, line
);
1744 strncpy (p
, str1
, strlen (str1
));
1746 strncpy (p
, str2
, strlen (str2
));
1754 expand_string (const char *str
)
1759 wordexp (str
, &p
, 0);
1760 if (p
.we_wordc
>= 1)
1761 s
= xstrdup (p
.we_wordv
[0]);
1768 get_bytes_size (unsigned long bytes
, struct bytes_size
*bytes_size
)
1770 const char *unit
, units
[] = { '0', 'K', 'M', 'G', '\0' };
1771 unsigned long size
= bytes
;
1775 while (size
>= 1024 && *(unit
+ 1))
1780 bytes_size
->size
= (unsigned int)size
;
1781 bytes_size
->unit
= *unit
;
1786 get_file_type (mode_t mode
)
1790 else if (S_ISDIR (mode
))
1792 else if (S_ISCHR (mode
))
1793 return "character device";
1794 else if (S_ISBLK (mode
))
1795 return "block device";
1796 else if (S_ISFIFO (mode
))
1797 return "named pipe";
1798 else if (S_ISLNK (mode
))
1799 return "symbolic link";
1800 else if (S_ISSOCK (mode
))
1807 has_color_name (const char *str
, const char *name
)
1811 assert (strlen (str
) > 0);
1812 assert (strlen (name
) > 0);
1814 if (!(*str
== *name
|| *str
== toupper (*name
)))
1816 else if (*(name
+ 1) != '\0'
1817 && !((p
= strstr (str
+ 1, name
+ 1)) && p
== str
+ 1))
1824 open_file (const char *file
, const char *mode
)
1829 stream
= fopen (file
, mode
);
1831 vfprintf_fail (formats
[FMT_FILE
], file
, strerror (errno
));
1836 #define DO_VFPRINTF(fmt) \
1838 fprintf (stderr, "%s: ", program_name); \
1839 va_start (ap, fmt); \
1840 vfprintf (stderr, fmt, ap); \
1842 fprintf (stderr, "\n");
1845 vfprintf_diag (const char *fmt
, ...)
1851 vfprintf_fail (const char *fmt
, ...)
1854 exit (EXIT_FAILURE
);
1858 stack_var (void ***list
, unsigned int *stacked
, unsigned int index
, void *ptr
)
1860 /* nothing to stack */
1864 *list
= xmalloc (sizeof (void *));
1868 for (i
= 0; i
< *stacked
; i
++)
1872 return; /* reused */
1874 *list
= xrealloc (*list
, (*stacked
+ 1) * sizeof (void *));
1876 (*list
)[index
] = ptr
;
1881 release_var (void **list
, unsigned int stacked
, void **ptr
)
1884 /* nothing to release */
1887 for (i
= 0; i
< stacked
; i
++)
1888 if (list
[i
] == *ptr
)