* colorize - Read text from standard input stream or file and print
* it colorized through use of ANSI escape sequences
*
- * Copyright (c) 2011-2018 Steven Schubiger
+ * Copyright (c) 2011-2019 Steven Schubiger
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#define VALID_FILE_TYPE(mode) (S_ISREG (mode) || S_ISLNK (mode) || S_ISFIFO (mode))
-#define STACK_VAR(ptr) do { \
- stack_var (&vars_list, &stacked_vars, stacked_vars, ptr); \
+#define STACK_VAR(ptr) do { \
+ stack (&vars_list, &stacked_vars, stacked_vars, ptr, IS_GENERIC); \
} while (false)
-
-#define RELEASE_VAR(ptr) do { \
- release_var (vars_list, stacked_vars, (void **)&ptr); \
+#define STACK_FILE(ptr) do { \
+ stack (&vars_list, &stacked_vars, stacked_vars, ptr, IS_FILE); \
+} while (false)
+#define RELEASE(ptr) do { \
+ release (vars_list, stacked_vars, (void **)&ptr); \
} while (false)
#if !DEBUG
#define PROGRAM_NAME "colorize"
-#define VERSION "0.64"
+#define VERSION "0.65"
typedef enum { false, true } bool;
FMT_ERROR,
FMT_FILE,
FMT_TYPE,
- FMT_CONF
+ FMT_CONF,
+ FMT_CONF_FILE
};
static const char *formats[] = {
- "%s", /* generic */
- "%s '%s'", /* string */
- "%s `%s' %s", /* quote */
- "%s color '%s' %s", /* color */
- "%s color '%s' %s '%s'", /* random */
- "less than %lu bytes %s", /* error */
- "%s: %s", /* file */
- "%s: %s: %s", /* type */
- "%s: option '%s' %s" /* conf */
+ "%s", /* generic */
+ "%s '%s'", /* string */
+ "%s `%s' %s", /* quote */
+ "%s color '%s' %s", /* color */
+ "%s color '%s' %s '%s'", /* random */
+ "less than %lu bytes %s", /* error */
+ "%s: %s", /* file */
+ "%s: %s: %s", /* type */
+ "%s: option '%s' %s", /* conf */
+ "config file %s: %s" /* conf file */
};
enum { GENERIC, FOREGROUND = 0, BACKGROUND };
};
static unsigned int opts_set;
-enum {
+enum opt_set {
OPT_ATTR_SET = 0x01,
OPT_EXCLUDE_RANDOM_SET = 0x02,
OPT_OMIT_COLOR_EMPTY_SET = 0x04
enum attr_type type;
};
+enum var_type {
+ IS_GENERIC,
+ IS_FILE,
+ IS_UNUSED
+};
+struct var_list {
+ void *ptr;
+ enum var_type type;
+};
+
static FILE *stream;
#if DEBUG
static FILE *log;
#endif
static unsigned int stacked_vars;
-static void **vars_list;
+static struct var_list *vars_list;
static bool clean;
static bool clean_all;
static void print_tstamp (FILE *);
#endif
static void process_opts (int, char **, char **);
+static void conf_file_path (char **);
static void process_opt_attr (const char *, const bool);
static void write_attr (const struct attr *, unsigned int *, const bool);
static void process_opt_exclude_random (const char *, const bool);
static FILE *open_file (const char *, const char *);
static void vfprintf_diag (const char *, ...);
static void vfprintf_fail (const char *, ...);
-static void stack_var (void ***, unsigned int *, unsigned int, void *);
-static void release_var (void **, unsigned int, void **);
-
-extern int optind;
+static void stack (struct var_list **, unsigned int *, unsigned int, void *, enum var_type);
+static void release (struct var_list *, unsigned int, void **);
int
main (int argc, char **argv)
#if DEBUG
log = open_file (DEBUG_FILE, "w");
print_tstamp (log);
+ /* We're in debugging mode, hence we can't invoke STACK_FILE()
+ prior to print_tstamp(), because both cause text to be written
+ to the same logfile which is expected to have the timestamp
+ first. */
+ STACK_FILE (log);
#endif
attr[0] = '\0';
#elif !defined(TEST)
if (conf_file == NULL)
{
- uid_t uid;
- struct passwd *passwd;
- size_t size;
-
- uid = getuid ();
- errno = 0;
- if ((passwd = getpwuid (uid)) == NULL)
- {
- if (errno == 0)
- vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid);
- else
- perror ("getpwuid");
- exit (EXIT_FAILURE);
- }
- size = strlen (passwd->pw_dir) + 1 + strlen (CONF_FILE) + 1;
- conf_file = xmalloc (size);
- snprintf (conf_file, size, "%s/%s", passwd->pw_dir, CONF_FILE);
+ conf_file_path (&conf_file);
+ STACK_VAR (conf_file);
}
else
{
free (conf_file);
conf_file = s;
}
+ STACK_VAR (conf_file);
errno = 0;
if (access (conf_file, F_OK) == -1)
- vfprintf_fail (formats[FMT_FILE], conf_file, strerror (errno));
+ vfprintf_fail (formats[FMT_CONF_FILE], conf_file, strerror (errno));
}
#endif
#if defined(CONF_FILE_TEST) || !defined(TEST)
parse_conf (conf_file, &config);
#endif
#if !defined(CONF_FILE_TEST) && !defined(TEST)
- free (conf_file);
+ RELEASE (conf_file);
#endif
init_conf_vars (&config);
if (clean && clean_all)
vfprintf_fail (formats[FMT_GENERIC], "--clean and --clean-all switch are mutually exclusive");
if (arg_cnt > 1)
- {
- const char *const format = "%s %s";
- const char *const message = "switch cannot be used with more than one file";
- if (clean)
- vfprintf_fail (format, "--clean", message);
- else if (clean_all)
- vfprintf_fail (format, "--clean-all", message);
- }
+ vfprintf_fail ("--clean%s switch cannot be used with more than one file", clean_all ? "-all" : "");
+ {
+ unsigned int i;
+ const struct option_set {
+ const char *option;
+ enum opt_set set;
+ } options[] = {
+ { "attr", OPT_ATTR_SET },
+ { "exclude-random", OPT_EXCLUDE_RANDOM_SET },
+ { "omit-color-empty", OPT_OMIT_COLOR_EMPTY_SET },
+ };
+ for (i = 0; i < COUNT_OF (options, struct option_set); i++)
+ if (opts_set & options[i].set)
+ vfprintf_diag ("--%s switch has no meaning with --clean%s", options[i].option, clean_all ? "-all" : "");
+ }
}
else
{
if (arg_cnt == 0 || arg_cnt > 2)
{
- vfprintf_diag ("%u arguments provided, expected 1-2 arguments or clean option", arg_cnt);
+ vfprintf_diag ("%u arguments provided, expected 1-2 arguments or --clean[-all]", arg_cnt);
print_hint ();
exit (EXIT_FAILURE);
}
free_conf (&config);
- RELEASE_VAR (exclude);
+ RELEASE (exclude);
exit (EXIT_SUCCESS);
}
}
#endif
+#define DUP_CONFIG() \
+ *conf_file = xstrdup (optarg); \
+ break;
+
#define PRINT_HELP_EXIT() \
print_help (); \
exit (EXIT_SUCCESS);
print_version (); \
exit (EXIT_SUCCESS);
-extern char *optarg;
-
static void
process_opts (int argc, char **argv, char **conf_file)
{
int opt;
- while ((opt = getopt_long (argc, argv, "hV", long_opts, NULL)) != -1)
+ while ((opt = getopt_long (argc, argv, "c:hV", long_opts, NULL)) != -1)
{
switch (opt)
{
case OPT_ATTR:
opts_set |= OPT_ATTR_SET;
opts_arg.attr = xstrdup (optarg);
+ STACK_VAR (opts_arg.attr);
break;
case OPT_CLEAN:
clean = true;
clean_all = true;
break;
case OPT_CONFIG:
- *conf_file = xstrdup (optarg);
- break;
+ DUP_CONFIG ();
case OPT_EXCLUDE_RANDOM:
opts_set |= OPT_EXCLUDE_RANDOM_SET;
opts_arg.exclude_random = xstrdup (optarg);
+ STACK_VAR (opts_arg.exclude_random);
break;
case OPT_OMIT_COLOR_EMPTY:
opts_set |= OPT_OMIT_COLOR_EMPTY_SET;
ABORT_TRACE ();
}
break;
+ case 'c':
+ DUP_CONFIG ();
case 'h':
PRINT_HELP_EXIT ();
case 'V':
}
}
+static void
+conf_file_path (char **conf_file)
+{
+ char *path;
+ uid_t uid;
+ struct passwd *passwd;
+ size_t size;
+
+ uid = getuid ();
+ errno = 0;
+ if ((passwd = getpwuid (uid)) == NULL)
+ {
+ if (errno == 0)
+ vfprintf_diag ("password file entry for uid %lu not found", (unsigned long)uid);
+ else
+ perror ("getpwuid");
+ exit (EXIT_FAILURE);
+ }
+ /* getpwuid() leaks memory */
+ size = strlen (passwd->pw_dir) + 1 + strlen (CONF_FILE) + 1;
+ path = xmalloc (size);
+ snprintf (path, size, "%s/%s", passwd->pw_dir, CONF_FILE);
+
+ *conf_file = path;
+}
+
static void
process_opt_attr (const char *p, const bool is_opt)
{
while (*p)
{
const char *s;
- if (!isalnum (*p))
+ if (!isalnum ((unsigned char)*p))
vfprintf_fail ("%s must be provided a string", desc_type[DESC_TYPE]);
s = p;
- while (isalnum (*p))
+ while (isalnum ((unsigned char)*p))
p++;
if (*p != '\0' && *p != ',')
vfprintf_fail ("%s must have strings separated by ,", desc_type[DESC_TYPE]);
strncpy (attr_invalid, s, p - s);
attr_invalid[p - s] = '\0';
vfprintf_fail ("%s attribute '%s' is not valid", desc_type[DESC_TYPE], attr_invalid);
- RELEASE_VAR (attr_invalid); /* never reached */
+ RELEASE (attr_invalid); /* never reached */
}
}
if (*p)
{
bool valid = false;
unsigned int i;
- if (exclude)
- RELEASE_VAR (exclude);
+ RELEASE (exclude);
exclude = xstrdup (s);
STACK_VAR (exclude);
for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */
}
if (!valid)
vfprintf_fail ("%s must be provided a plain color",
- is_opt ? "--exlude-random switch" : "exclude-random conf option");
+ is_opt ? "--exclude-random switch" : "exclude-random conf option");
}
static void
if (opts_set & OPT_OMIT_COLOR_EMPTY_SET)
omit_color_empty = true;
- free (opts_arg.attr);
- free (opts_arg.exclude_random);
+ RELEASE (opts_arg.attr);
+ RELEASE (opts_arg.exclude_random);
}
#define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
FILE *conf;
conf = open_file (conf_file, "r");
+ STACK_FILE (conf);
while (fgets (line, sizeof (line), conf))
{
char *p;
cnt++;
+ if ((p = strchr (line, '\r')) && *(p + 1) != '\n')
+ vfprintf_fail ("%s: CR ending of line %u is not supported, switch to CRLF/LF instead", conf_file, cnt);
if (strlen (line) > (sizeof (line) - 2))
vfprintf_fail ("%s: line %u exceeds maximum of %u characters", conf_file, cnt, (unsigned int)(sizeof (line) - 2));
- if ((p = strrchr (line, '\n')))
+ if ((p = strpbrk (line, "\n\r")))
*p = '\0';
/* NAME PARSING (start) */
p = line;
opt = p;
if (!(assign = strchr (opt, '='))) /* check for = */
{
- char *space;
- if ((space = strchr (opt, ' ')))
- *space = '\0';
+ char *s;
+ if ((s = strpbrk (opt, "# ")))
+ *s = '\0';
vfprintf_fail (formats[FMT_CONF], conf_file, opt, "not followed by =");
}
p = assign;
/* NAME PARSING (end) */
/* NAME VALIDATION (start) */
for (p = opt; *p; p++)
- if (!isalnum (*p) && *p != '-')
+ if (!isalnum ((unsigned char)*p) && *p != '-')
vfprintf_fail (formats[FMT_CONF], conf_file, opt, "cannot be made of non-option characters");
/* NAME VALIDATION (end) */
/* VALUE PARSING (start) */
/* save option name */
cfg = xstrdup (opt);
+ STACK_VAR (cfg);
/* save option value (allow empty ones) */
val = strlen (value) ? xstrdup (value) : NULL;
+ STACK_VAR (val);
assign_conf (conf_file, config, cfg, val);
- free (cfg);
+ RELEASE (cfg);
}
- fclose (conf);
+ RELEASE (conf);
}
+#define ASSIGN_CONF(str,val) do { \
+ RELEASE (str); \
+ str = val; \
+} while (false)
+
static void
assign_conf (const char *conf_file, struct conf *config, const char *cfg, char *val)
{
if (streq (cfg, "attr"))
- {
- free (config->attr);
- config->attr = val;
- }
+ ASSIGN_CONF (config->attr, val);
else if (streq (cfg, "color"))
- {
- free (config->color);
- config->color = val;
- }
+ ASSIGN_CONF (config->color, val);
else if (streq (cfg, "exclude-random"))
- {
- free (config->exclude_random);
- config->exclude_random = val;
- }
+ ASSIGN_CONF (config->exclude_random, val);
else if (streq (cfg, "omit-color-empty"))
- {
- free (config->omit_color_empty);
- config->omit_color_empty = val;
- }
+ ASSIGN_CONF (config->omit_color_empty, val);
else
vfprintf_fail (formats[FMT_CONF], conf_file, cfg, "not recognized");
}
else if (streq (config->omit_color_empty, "no"))
omit_color_empty = false;
else
- vfprintf_fail ("omit-color-empty conf option is not valid");
+ vfprintf_fail (formats[FMT_GENERIC], "omit-color-empty conf option is not valid");
}
}
};
const struct opt_data opts_data[] = {
{ "attr", NULL, "=ATTR1,ATTR2,..." },
- { "config", NULL, "=PATH" },
+ { "config", "c", "=PATH" },
{ "exclude-random", NULL, "=COLOR" },
{ "help", "h", NULL },
{ "version", "V", NULL },
const char *code = entry->code;
if (code)
printf ("\t\t{\033[%s#\033[0m} [%c%c]%s%*s%s\n",
- code, toupper (*name), *name, name + 1, 10 - (int)strlen (name), " ", name);
+ code, toupper ((unsigned char)*name), *name, name + 1, 10 - (int)strlen (name), " ", name);
else
printf ("\t\t{-} %s%*s%s\n", name, 13 - (int)strlen (name), " ", name);
}
if (opt_data)
{
if (opt_data->short_opt)
- printf ("\t\t-%s, --%s\n", opt_data->short_opt, opt->name);
+ printf ("\t\t-%s, --%s", opt_data->short_opt, opt->name);
else
- printf ("\t\t --%s%s\n", opt->name, opt_data->arg);
+ printf ("\t\t --%s", opt->name);
+ if (opt_data->arg)
+ printf ("%s", opt_data->arg);
+ printf ("\n");
}
else
printf ("\t\t --%s\n", opt->name);
cleanup (void)
{
if (stream && fileno (stream) != STDIN_FILENO)
- fclose (stream);
+ RELEASE (stream);
#if DEBUG
if (log)
- fclose (log);
+ RELEASE (log);
#endif
if (vars_list)
{
unsigned int i;
for (i = 0; i < stacked_vars; i++)
- free (vars_list[i]);
+ {
+ struct var_list *var = &vars_list[i];
+ switch (var->type)
+ {
+ case IS_GENERIC:
+ free (var->ptr);
+ break;
+ case IS_FILE:
+ fclose (var->ptr);
+ break;
+ case IS_UNUSED:
+ break;
+ default: /* never reached */
+ ABORT_TRACE ();
+ }
+ }
free_null (vars_list);
}
}
unsigned int i;
for (i = 0; color_names[i]; i++)
{
- RELEASE_VAR (color_names[i]->name);
- RELEASE_VAR (color_names[i]->orig);
- RELEASE_VAR (color_names[i]);
+ RELEASE (color_names[i]->name);
+ RELEASE (color_names[i]->orig);
+ RELEASE (color_names[i]);
}
}
static void
free_conf (struct conf *config)
{
- free (config->attr);
- free (config->color);
- free (config->exclude_random);
- free (config->omit_color_empty);
+ RELEASE (config->attr);
+ RELEASE (config->color);
+ RELEASE (config->exclude_random);
+ RELEASE (config->omit_color_empty);
}
static void
process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct color **colors, const char **file, FILE **stream, struct conf *config)
{
- bool use_conf_color;
+ bool has_hyphen, use_conf_color;
int ret;
char *p;
struct stat sb;
assert (color_string != NULL);
- if (streq (color_string, "-"))
+ has_hyphen = streq (color_string, "-");
+
+ if (has_hyphen)
{
if (file_string)
vfprintf_fail (formats[FMT_GENERIC], "hyphen cannot be used as color string");
- else
+ else if (!config->color)
vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceded by color string");
}
- if ((ret = lstat (color_string, &sb)) == 0) /* exists */
+ if (!has_hyphen && (ret = lstat (color_string, &sb)) == 0) /* exists */
/* Ensure that we don't fail if there's a file with one or more
color names in its path. */
use_conf_color = skip_path_colors (color_string, file_string, &sb, !!config->color);
+ else if (has_hyphen)
+ use_conf_color = true;
+ else
+ use_conf_color = false;
/* Use color from config file. */
- if (arg_cnt == 1
- && (access (color_string, F_OK) != -1)
- && use_conf_color)
+ if (arg_cnt == 1 && use_conf_color)
{
file_string = color_string;
color_string = config->color;
vfprintf_fail (formats[FMT_TYPE], file, "unrecognized type", get_file_type (sb.st_mode));
*stream = open_file (file, "r");
+ STACK_FILE (*stream);
}
*file = file_string;
}
assert (p != NULL);
for (ch = color; *ch; ch++)
- if (!isalpha (*ch))
+ if (!isalpha ((unsigned char)*ch))
vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be made of non-alphabetic characters");
for (ch = color + 1; *ch; ch++)
- if (!islower (*ch))
+ if (!islower ((unsigned char)*ch))
vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be in mixed lower/upper case");
if (streq (color, "None"))
vfprintf_fail (formats[FMT_COLOR], tables[index].desc, color, "cannot be bold");
- if (isupper (*color))
+ if (isupper ((unsigned char)*color))
{
switch (index)
{
break;
case BACKGROUND:
vfprintf_fail (formats[FMT_COLOR], tables[BACKGROUND].desc, color, "cannot be bold");
+ break;
default: /* never reached */
ABORT_TRACE ();
}
STACK_VAR (color_names[index]->orig);
for (ch = color; *ch; ch++)
- *ch = tolower (*ch);
+ *ch = tolower ((unsigned char)*ch);
color_names[index]->name = xstrdup (color);
STACK_VAR (color_names[index]->name);
}
- RELEASE_VAR (str);
+ RELEASE (str);
}
static void
do {
check_values = false;
iter++;
- if (!isdigit (*p))
+ if (!isdigit ((unsigned char)*p))
break;
digit = p;
- while (isdigit (*p))
+ while (isdigit ((unsigned char)*p))
p++;
if (p - digit > 2)
break;
static bool
validate_esc_clean_all (const char **p)
{
- while (isdigit (**p) || **p == ';')
+ while (isdigit ((unsigned char)**p) || **p == ';')
(*p)++;
return (**p == 'm');
}
assert (strlen (str) > 0);
assert (strlen (name) > 0);
- if (!(*str == *name || *str == toupper (*name)))
+ if (!(*str == *name || *str == toupper ((unsigned char)*name)))
return false;
else if (*(name + 1) != '\0'
&& !((p = strstr (str + 1, name + 1)) && p == str + 1))
}
static void
-stack_var (void ***list, unsigned int *stacked, unsigned int index, void *ptr)
+stack (struct var_list **list, unsigned int *stacked, unsigned int index, void *ptr, enum var_type type)
{
+ struct var_list *var;
/* nothing to stack */
if (ptr == NULL)
return;
if (!*list)
- *list = xmalloc (sizeof (void *));
+ *list = xmalloc (sizeof (struct var_list));
else
{
unsigned int i;
for (i = 0; i < *stacked; i++)
- if (!(*list)[i])
- {
- (*list)[i] = ptr;
- return; /* reused */
- }
- *list = xrealloc (*list, (*stacked + 1) * sizeof (void *));
+ {
+ var = &(*list)[i];
+ if (var->type == IS_UNUSED)
+ {
+ var->ptr = ptr;
+ var->type = type;
+ return; /* reused */
+ }
+ }
+ *list = xrealloc (*list, (*stacked + 1) * sizeof (struct var_list));
}
- (*list)[index] = ptr;
+ var = &(*list)[index];
+ var->ptr = ptr;
+ var->type = type;
(*stacked)++;
}
static void
-release_var (void **list, unsigned int stacked, void **ptr)
+release (struct var_list *list, unsigned int stacked, void **ptr)
{
unsigned int i;
/* nothing to release */
if (*ptr == NULL)
return;
for (i = 0; i < stacked; i++)
- if (list[i] == *ptr)
- {
- free (*ptr);
- *ptr = NULL;
- list[i] = NULL;
- return;
+ {
+ struct var_list *var = &list[i];
+ if (var->type != IS_UNUSED
+ && var->ptr == *ptr)
+ {
+ switch (var->type)
+ {
+ case IS_GENERIC:
+ free (*ptr);
+ break;
+ case IS_FILE:
+ fclose (*ptr);
+ break;
+ default: /* never reached */
+ ABORT_TRACE ();
+ }
+ *ptr = NULL;
+ var->ptr = NULL;
+ var->type = IS_UNUSED;
+ return;
}
+ }
}