summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Steven Schubiger <stsc@refcnt.org>2019-09-13 21:15:22 +0200
committerGravatar Steven Schubiger <stsc@refcnt.org>2019-09-13 21:15:22 +0200
commitb5ff1ba35b959261c855262b6e820732e72b0bfe (patch)
treeb5b0cdc7ec3438b441e736d56bccf44785ae96ae
parent763a5a99b3af4161cd1dd4c7ee2c450c4b6137a5 (diff)
parent660177bb22c5b8b54c0ec3aabd1930fd49584e23 (diff)
downloadcolorize-b5ff1ba35b959261c855262b6e820732e72b0bfe.tar.gz
colorize-b5ff1ba35b959261c855262b6e820732e72b0bfe.tar.bz2
Merge branch 'config_file'
-rw-r--r--README6
-rw-r--r--colorize.156
-rw-r--r--colorize.c384
-rw-r--r--doc/colorize.html3
-rwxr-xr-xt/conf/attr_clear.t31
-rwxr-xr-xt/conf/color.t33
-rwxr-xr-xt/conf/fail.t59
-rwxr-xr-xt/conf/param.t51
-rwxr-xr-xt/conf/parse/fail.t63
-rwxr-xr-xt/conf/parse/success.t74
-rwxr-xr-xt/conf/use.t57
-rwxr-xr-xt/merge.t4
-rwxr-xr-xtest.pl6
13 files changed, 774 insertions, 53 deletions
diff --git a/README b/README
index 4fcf139..20c1f00 100644
--- a/README
+++ b/README
@@ -56,6 +56,12 @@ file provided here for the `tee' invocation will be populated
with the captured output from both standard output and error
stream.
+Configuration File
+------------------
+A user configuration file may be populated with options and
+according values. See man page source file `colorize.1' for
+details.
+
Documentation
-------------
See man page source file: colorize.1.
diff --git a/colorize.1 b/colorize.1
index f3341ed..02ffe2e 100644
--- a/colorize.1
+++ b/colorize.1
@@ -1,4 +1,4 @@
-.TH COLORIZE 1 "2019-02-23" "colorize v0.64" "User Commands"
+.TH COLORIZE 1 "2019-09-01" "colorize v0.64" "User Commands"
.SH NAME
colorize \- colorize text on terminal with ANSI escape sequences
.SH SYNOPSIS
@@ -40,6 +40,9 @@ clean text from color escape sequences emitted by colorize
.BR \-\-clean\-all
clean text from all valid color escape sequences
.TP
+.BR \-c ", " \-\-config=\fIPATH\fR
+alternate configuration file location
+.TP
.BR \-\-exclude\-random=\fICOLOR\fR
text color to be excluded when selecting a random foreground color
.TP
@@ -51,6 +54,57 @@ show help screen and exit
.TP
.BR \-V ", " \-\-version
display version data and exit
+.SH FILES
+.TP
+.B ~/.colorize.conf
+user configuration file
+.PP
+.RS
+If the aforementioned file exists, it is read, parsed and processed
+prior to handling the command-line options. Command-line options
+override configuration values, but are currently not capable of
+unsetting them. If unsetting is desired, comment them out or remove
+them.
+.RE
+.PP
+.RS
+.B Sample configuration file
+.RS
+.nf
+# ~/.colorize.conf
+attr = bold,underscore
+color = magenta # favorite one
+exclude-random = black
+omit-color-empty = yes
+.fi
+.RE
+.RE
+.PP
+.RS
+.B Configurable options and values
+.RS
+.nf
+attr (values same as command-line option)
+color (value same as command-line colors)
+exclude-random (value same as command-line option)
+omit-color-empty (yes/no)
+.fi
+.RE
+.RE
+.PP
+.RS
+.B Syntax
+.RS
+Each line ought to start with a name of an option, followed by = and
+an optional value. Leaving the value blank, unsets the option.
+.PP
+Whitespace is allowed before the option name, after the option name,
+before the option value and after the option value.
+.PP
+Comments may be placed before or after the option is set. Everything
+following the '#' sign is treated as being commented out.
+.RE
+.RE
.SH NOTES
The list of color escape sequence codes being emitted and omitted is
as follows:
diff --git a/colorize.c b/colorize.c
index 356fc01..147e684 100644
--- a/colorize.c
+++ b/colorize.c
@@ -27,6 +27,7 @@
#include <ctype.h>
#include <errno.h>
#include <getopt.h>
+#include <pwd.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
@@ -36,6 +37,7 @@
#include <sys/stat.h>
#include <time.h>
#include <unistd.h>
+#include <wordexp.h>
#ifndef DEBUG
# define DEBUG 0
@@ -118,6 +120,8 @@
# define COLOR_SEP_CHAR '/'
#endif
+#define CONF_FILE ".colorize.conf"
+
#if DEBUG
# define DEBUG_FILE "debug.txt"
#endif
@@ -130,6 +134,15 @@
typedef enum { false, true } bool;
+struct conf {
+ char *attr;
+ char *color;
+ char *exclude_random;
+ char *omit_color_empty;
+};
+
+enum { DESC_OPTION, DESC_CONF };
+
struct color_name {
char *name;
char *orig;
@@ -178,7 +191,8 @@ enum {
FMT_RANDOM,
FMT_ERROR,
FMT_FILE,
- FMT_TYPE
+ FMT_TYPE,
+ FMT_CONF
};
static const char *formats[] = {
"%s", /* generic */
@@ -189,6 +203,7 @@ static const char *formats[] = {
"less than %lu bytes %s", /* error */
"%s: %s", /* file */
"%s: %s: %s", /* type */
+ "%s: option '%s' %s" /* conf */
};
enum { GENERIC, FOREGROUND = 0, BACKGROUND };
@@ -202,10 +217,22 @@ static const struct {
{ bg_colors, COUNT_OF (bg_colors, struct color), "background" },
};
+static unsigned int opts_set;
+enum {
+ OPT_ATTR_SET = 0x01,
+ OPT_EXCLUDE_RANDOM_SET = 0x02,
+ OPT_OMIT_COLOR_EMPTY_SET = 0x04
+};
+static struct {
+ char *attr;
+ char *exclude_random;
+} opts_arg = { NULL, NULL };
+
enum {
OPT_ATTR = 1,
OPT_CLEAN,
OPT_CLEAN_ALL,
+ OPT_CONFIG,
OPT_EXCLUDE_RANDOM,
OPT_OMIT_COLOR_EMPTY,
OPT_HELP,
@@ -216,6 +243,7 @@ static const struct option long_opts[] = {
{ "attr", required_argument, &opt_type, OPT_ATTR },
{ "clean", no_argument, &opt_type, OPT_CLEAN },
{ "clean-all", no_argument, &opt_type, OPT_CLEAN_ALL },
+ { "config", required_argument, &opt_type, OPT_CONFIG },
{ "exclude-random", required_argument, &opt_type, OPT_EXCLUDE_RANDOM },
{ "omit-color-empty", no_argument, &opt_type, OPT_OMIT_COLOR_EMPTY },
{ "help", no_argument, &opt_type, OPT_HELP },
@@ -256,17 +284,23 @@ static const char *program_name;
#if DEBUG
static void print_tstamp (FILE *);
#endif
-static void process_opts (int, char **);
-static void process_opt_attr (const char *);
-static void write_attr (const struct attr *, unsigned int *);
+static void process_opts (int, char **, 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 void parse_conf (const char *, struct conf *);
+static void assign_conf (const char *, struct conf *, const char *, char *);
+static void init_conf_vars (const struct conf *);
+static void init_opts_vars (void);
static void print_hint (void);
static void print_help (void);
static void print_version (void);
static void cleanup (void);
static void free_color_names (struct color_name **);
-static void process_args (unsigned int, char **, char *, const struct color **, const char **, FILE **);
+static void free_conf (struct conf *);
+static void process_args (unsigned int, char **, char *, const struct color **, const char **, FILE **, struct conf *);
static void process_file_arg (const char *, const char **, FILE **);
-static void skip_path_colors (const char *, const char *, const struct stat *);
+static bool skip_path_colors (const char *, const char *, const struct stat *, const bool);
static void gather_color_names (const char *, char *, struct color_name **);
static void read_print_stream (const char *, const struct color **, const char *, FILE *);
static void merge_print_line (const char *, const char *, FILE *);
@@ -300,6 +334,7 @@ static void *realloc_wrap_debug (void *, size_t, const char *, unsigned int);
static void free_wrap (void **);
static char *strdup_wrap (const char *, const char *, unsigned int);
static char *str_concat_wrap (const char *, const char *, const char *, unsigned int);
+static char *expand_string (const char *);
static bool get_bytes_size (unsigned long, struct bytes_size *);
static char *get_file_type (mode_t);
static bool has_color_name (const char *, const char *);
@@ -323,6 +358,9 @@ main (int argc, char **argv)
const char *file = NULL;
+ char *conf_file = NULL;
+ struct conf config = { NULL, NULL, NULL, NULL };
+
program_name = argv[0];
atexit (cleanup);
@@ -335,7 +373,54 @@ main (int argc, char **argv)
attr[0] = '\0';
- process_opts (argc, argv);
+ process_opts (argc, argv, &conf_file);
+
+#ifdef CONF_FILE_TEST
+ conf_file = to_str (CONF_FILE_TEST);
+#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);
+ }
+ else
+ {
+ char *s;
+ if ((s = expand_string (conf_file)))
+ {
+ free (conf_file);
+ conf_file = s;
+ }
+ errno = 0;
+ if (access (conf_file, F_OK) == -1)
+ vfprintf_fail (formats[FMT_FILE], conf_file, strerror (errno));
+ }
+#endif
+#if defined(CONF_FILE_TEST) || !defined(TEST)
+ if (access (conf_file, F_OK) != -1)
+ parse_conf (conf_file, &config);
+#endif
+#if !defined(CONF_FILE_TEST) && !defined(TEST)
+ free (conf_file);
+#endif
+ init_conf_vars (&config);
+
+ init_opts_vars ();
arg_cnt = argc - optind;
@@ -366,9 +451,11 @@ main (int argc, char **argv)
if (clean || clean_all)
process_file_arg (argv[optind], &file, &stream);
else
- process_args (arg_cnt, &argv[optind], &attr[0], colors, &file, &stream);
+ process_args (arg_cnt, &argv[optind], &attr[0], colors, &file, &stream, &config);
read_print_stream (&attr[0], colors, file, stream);
+ free_conf (&config);
+
RELEASE_VAR (exclude);
exit (EXIT_SUCCESS);
@@ -401,6 +488,10 @@ print_tstamp (FILE *log)
}
#endif
+#define DUP_CONFIG() \
+ *conf_file = xstrdup (optarg); \
+ break;
+
#define PRINT_HELP_EXIT() \
print_help (); \
exit (EXIT_SUCCESS);
@@ -412,10 +503,10 @@ print_tstamp (FILE *log)
extern char *optarg;
static void
-process_opts (int argc, char **argv)
+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)
{
@@ -423,7 +514,8 @@ process_opts (int argc, char **argv)
switch (opt_type)
{
case OPT_ATTR:
- process_opt_attr (optarg);
+ opts_set |= OPT_ATTR_SET;
+ opts_arg.attr = xstrdup (optarg);
break;
case OPT_CLEAN:
clean = true;
@@ -431,26 +523,14 @@ process_opts (int argc, char **argv)
case OPT_CLEAN_ALL:
clean_all = true;
break;
- case OPT_EXCLUDE_RANDOM: {
- bool valid = false;
- unsigned int i;
- exclude = xstrdup (optarg);
- STACK_VAR (exclude);
- for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */
- {
- const struct color *entry = &tables[GENERIC].entries[i];
- if (streq (exclude, entry->name))
- {
- valid = true;
- break;
- }
- }
- if (!valid)
- vfprintf_fail (formats[FMT_GENERIC], "--exclude-random switch must be provided a plain color");
+ case OPT_CONFIG:
+ DUP_CONFIG ();
+ case OPT_EXCLUDE_RANDOM:
+ opts_set |= OPT_EXCLUDE_RANDOM_SET;
+ opts_arg.exclude_random = xstrdup (optarg);
break;
- }
case OPT_OMIT_COLOR_EMPTY:
- omit_color_empty = true;
+ opts_set |= OPT_OMIT_COLOR_EMPTY_SET;
break;
case OPT_HELP:
PRINT_HELP_EXIT ();
@@ -460,6 +540,8 @@ process_opts (int argc, char **argv)
ABORT_TRACE ();
}
break;
+ case 'c':
+ DUP_CONFIG ();
case 'h':
PRINT_HELP_EXIT ();
case 'V':
@@ -474,7 +556,7 @@ process_opts (int argc, char **argv)
}
static void
-process_opt_attr (const char *p)
+process_opt_attr (const char *p, const bool is_opt)
{
/* If attributes are added to this "list", also increase MAX_ATTRIBUTE_CHARS! */
const struct attr attrs[] = {
@@ -485,17 +567,19 @@ process_opt_attr (const char *p)
{ "concealed", 8, ATTR_CONCEALED },
};
unsigned int attr_types = 0;
+ const char *desc_type[2] = { "--attr switch", "attr conf option" };
+ const unsigned int DESC_TYPE = is_opt ? DESC_OPTION : DESC_CONF;
while (*p)
{
const char *s;
if (!isalnum (*p))
- vfprintf_fail (formats[FMT_GENERIC], "--attr switch must be provided a string");
+ vfprintf_fail ("%s must be provided a string", desc_type[DESC_TYPE]);
s = p;
while (isalnum (*p))
p++;
if (*p != '\0' && *p != ',')
- vfprintf_fail (formats[FMT_GENERIC], "--attr switch must have strings separated by ,");
+ vfprintf_fail ("%s must have strings separated by ,", desc_type[DESC_TYPE]);
else
{
bool valid_attr = false;
@@ -505,7 +589,7 @@ process_opt_attr (const char *p)
const size_t name_len = strlen (attrs[i].name);
if ((size_t)(p - s) == name_len && strneq (s, attrs[i].name, name_len))
{
- write_attr (&attrs[i], &attr_types);
+ write_attr (&attrs[i], &attr_types, is_opt);
valid_attr = true;
break;
}
@@ -516,7 +600,7 @@ process_opt_attr (const char *p)
STACK_VAR (attr_invalid);
strncpy (attr_invalid, s, p - s);
attr_invalid[p - s] = '\0';
- vfprintf_fail ("--attr switch attribute '%s' is not valid", attr_invalid);
+ vfprintf_fail ("%s attribute '%s' is not valid", desc_type[DESC_TYPE], attr_invalid);
RELEASE_VAR (attr_invalid); /* never reached */
}
}
@@ -526,19 +610,185 @@ process_opt_attr (const char *p)
}
static void
-write_attr (const struct attr *attr_i, unsigned int *attr_types)
+write_attr (const struct attr *attr_i, unsigned int *attr_types, const bool is_opt)
{
const unsigned int val = attr_i->val;
const enum attr_type attr_type = attr_i->type;
const char *attr_name = attr_i->name;
if (*attr_types & attr_type)
- vfprintf_fail ("--attr switch has attribute '%s' twice or more", attr_name);
+ vfprintf_fail ("%s has attribute '%s' twice or more",
+ is_opt ? "--attr switch" : "attr conf option", attr_name);
snprintf (attr + strlen (attr), 3, "%u;", val);
*attr_types |= attr_type;
}
static void
+process_opt_exclude_random (const char *s, const bool is_opt)
+{
+ bool valid = false;
+ unsigned int i;
+ if (exclude)
+ RELEASE_VAR (exclude);
+ exclude = xstrdup (s);
+ STACK_VAR (exclude);
+ for (i = 1; i < tables[GENERIC].count - 1; i++) /* skip color none and default */
+ {
+ const struct color *entry = &tables[GENERIC].entries[i];
+ if (streq (exclude, entry->name))
+ {
+ valid = true;
+ break;
+ }
+ }
+ if (!valid)
+ vfprintf_fail ("%s must be provided a plain color",
+ is_opt ? "--exlude-random switch" : "exclude-random conf option");
+}
+
+static void
+init_opts_vars (void)
+{
+ if (opts_set & OPT_ATTR_SET)
+ {
+ attr[0] = '\0'; /* Clear attr string to discard values from the config file. */
+ process_opt_attr (opts_arg.attr, true);
+ }
+ if (opts_set & OPT_EXCLUDE_RANDOM_SET)
+ process_opt_exclude_random (opts_arg.exclude_random, true);
+ if (opts_set & OPT_OMIT_COLOR_EMPTY_SET)
+ omit_color_empty = true;
+
+ free (opts_arg.attr);
+ free (opts_arg.exclude_random);
+}
+
+#define IS_SPACE(c) ((c) == ' ' || (c) == '\t')
+
+static void
+parse_conf (const char *conf_file, struct conf *config)
+{
+ unsigned int cnt = 0;
+ char line[256 + 1];
+ FILE *conf;
+
+ conf = open_file (conf_file, "r");
+
+ while (fgets (line, sizeof (line), conf))
+ {
+ char *cfg, *val;
+ char *assign, *comment, *opt, *value;
+ char *p;
+
+ 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')))
+ *p = '\0';
+/* NAME PARSING (start) */
+ p = line;
+ /* skip leading spaces and tabs for name */
+ while (IS_SPACE (*p))
+ p++;
+ /* skip line if a) string end, b) comment, [cd]) newline */
+ if (*p == '\0' || *p == '#' || *p == '\n' || *p == '\r')
+ continue;
+ opt = p;
+ if (!(assign = strchr (opt, '='))) /* check for = */
+ {
+ char *space;
+ if ((space = strchr (opt, ' ')))
+ *space = '\0';
+ vfprintf_fail (formats[FMT_CONF], conf_file, opt, "not followed by =");
+ }
+ p = assign;
+ /* skip trailing spaces and tabs for name */
+ while (IS_SPACE (*(p - 1)))
+ p--;
+ *p = '\0';
+/* NAME PARSING (end) */
+/* NAME VALIDATION (start) */
+ for (p = opt; *p; p++)
+ if (!isalnum (*p) && *p != '-')
+ vfprintf_fail (formats[FMT_CONF], conf_file, opt, "cannot be made of non-option characters");
+/* NAME VALIDATION (end) */
+/* VALUE PARSING (start) */
+ p = assign + 1;
+ /* skip leading spaces and tabs for value */
+ while (IS_SPACE (*p))
+ p++;
+ /* skip line if comment */
+ if (*p == '#')
+ continue;
+ value = p;
+ if ((comment = strchr (p, '#')))
+ p = comment;
+ else
+ p += strlen (p);
+ /* skip trailing spaces and tabs for value */
+ while (IS_SPACE (*(p - 1)))
+ p--;
+ *p = '\0';
+/* VALUE PARSING (end) */
+
+ /* save option name */
+ cfg = xstrdup (opt);
+ /* save option value (allow empty ones) */
+ val = strlen (value) ? xstrdup (value) : NULL;
+
+ assign_conf (conf_file, config, cfg, val);
+ free (cfg);
+ }
+
+ fclose (conf);
+}
+
+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;
+ }
+ else if (streq (cfg, "color"))
+ {
+ free (config->color);
+ config->color = val;
+ }
+ else if (streq (cfg, "exclude-random"))
+ {
+ free (config->exclude_random);
+ config->exclude_random = val;
+ }
+ else if (streq (cfg, "omit-color-empty"))
+ {
+ free (config->omit_color_empty);
+ config->omit_color_empty = val;
+ }
+ else
+ vfprintf_fail (formats[FMT_CONF], conf_file, cfg, "not recognized");
+}
+
+static void
+init_conf_vars (const struct conf *config)
+{
+ if (config->attr)
+ process_opt_attr (config->attr, false);
+ if (config->exclude_random)
+ process_opt_exclude_random (config->exclude_random, false);
+ if (config->omit_color_empty)
+ {
+ if (streq (config->omit_color_empty, "yes"))
+ omit_color_empty = true;
+ else if (streq (config->omit_color_empty, "no"))
+ omit_color_empty = false;
+ else
+ vfprintf_fail ("omit-color-empty conf option is not valid");
+ }
+}
+
+static void
print_hint (void)
{
fprintf (stderr, "Type `%s --help' for help screen.\n", program_name);
@@ -554,6 +804,7 @@ print_help (void)
};
const struct opt_data opts_data[] = {
{ "attr", NULL, "=ATTR1,ATTR2,..." },
+ { "config", "c", "=PATH" },
{ "exclude-random", NULL, "=COLOR" },
{ "help", "h", NULL },
{ "version", "V", NULL },
@@ -593,9 +844,12 @@ print_help (void)
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);
@@ -689,8 +943,18 @@ free_color_names (struct color_name **color_names)
}
static void
-process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct color **colors, const char **file, FILE **stream)
+free_conf (struct conf *config)
+{
+ free (config->attr);
+ free (config->color);
+ free (config->exclude_random);
+ free (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;
int ret;
char *p;
struct stat sb;
@@ -713,12 +977,19 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct
vfprintf_fail (formats[FMT_GENERIC], "hyphen must be preceded by color string");
}
- ret = lstat (color_string, &sb);
+ if ((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);
- /* Ensure that we don't fail if there's a file with one or more
- color names in its path. */
- if (ret == 0) /* success */
- skip_path_colors (color_string, file_string, &sb);
+ /* Use color from config file. */
+ if (arg_cnt == 1
+ && (access (color_string, F_OK) != -1)
+ && use_conf_color)
+ {
+ file_string = color_string;
+ color_string = config->color;
+ }
if ((p = strchr (color_string, COLOR_SEP_CHAR)))
{
@@ -799,8 +1070,8 @@ process_file_arg (const char *file_string, const char **file, FILE **stream)
assert (*file != NULL);
}
-static void
-skip_path_colors (const char *color_string, const char *file_string, const struct stat *sb)
+static bool
+skip_path_colors (const char *color_string, const char *file_string, const struct stat *sb, const bool has_conf)
{
bool have_file;
unsigned int c;
@@ -842,11 +1113,16 @@ skip_path_colors (const char *color_string, const char *file_string, const struc
else
{
if (VALID_FILE_TYPE (mode))
- vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "must be preceded by color string");
+ {
+ if (has_conf)
+ return true;
+ vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "must be preceded by color string");
+ }
else
vfprintf_fail (formats[FMT_QUOTE], get_file_type (mode), file_existing, "is not a valid file type");
}
}
+ return false;
}
static void
@@ -1453,6 +1729,20 @@ str_concat_wrap (const char *str1, const char *str2, const char *file, unsigned
return str;
}
+static char *
+expand_string (const char *str)
+{
+ char *s = NULL;
+ wordexp_t p;
+
+ wordexp (str, &p, 0);
+ if (p.we_wordc >= 1)
+ s = xstrdup (p.we_wordv[0]);
+ wordfree (&p);
+
+ return s;
+}
+
static bool
get_bytes_size (unsigned long bytes, struct bytes_size *bytes_size)
{
diff --git a/doc/colorize.html b/doc/colorize.html
index c32c762..381ddb0 100644
--- a/doc/colorize.html
+++ b/doc/colorize.html
@@ -31,6 +31,7 @@ Usage: ./colorize (foreground) OR (foreground)/(background) OR --clean[-all] [-|
--attr=ATTR1,ATTR2,...
--clean
--clean-all
+ -c, --config=PATH
--exclude-random=COLOR
--omit-color-empty
-h, --help
@@ -102,7 +103,7 @@ permitted by applicable law.
</pre>
<pre>
<span style="color:yellow;font-weight:bold;">[sts@apollo ~/colorize]$</span> ./colorize --version
-colorize v0.63-5-gadd8a17 (compiled at Feb 1 2018, 17:05:52)
+colorize v0.64-17-ga3c5c67 (compiled at Sep 10 2019, 21:32:03)
Compiler flags: &quot;-ansi -pedantic &quot;
Linker flags: &quot;&quot;
Preprocessor flags: &quot;&quot;
diff --git a/t/conf/attr_clear.t b/t/conf/attr_clear.t
new file mode 100755
index 0000000..7bbe5f9
--- /dev/null
+++ b/t/conf/attr_clear.t
@@ -0,0 +1,31 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use lib qw(lib);
+
+use Colorize::Common qw(:defaults $write_to_tmpfile);
+use File::Temp qw(tmpnam);
+use Test::More;
+
+my $tests = 1;
+
+plan tests => $tests;
+
+SKIP: {
+ my $program = tmpnam();
+ my $conf_file = tmpnam();
+
+ skip 'compiling failed (attr clear)', $tests unless system(qq($compiler -DTEST -DCONF_FILE_TEST=\"$conf_file\" -o $program $source)) == 0;
+
+ my $infile = $write_to_tmpfile->('foo');
+
+ open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} "attr=blink\n";
+ close($fh);
+
+ is(qx($program default --attr=bold $infile), "\e[1;39mfoo\e[0m", 'discard conf attr string');
+
+ unlink $program;
+ unlink $conf_file;
+}
diff --git a/t/conf/color.t b/t/conf/color.t
new file mode 100755
index 0000000..3adfd5b
--- /dev/null
+++ b/t/conf/color.t
@@ -0,0 +1,33 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use lib qw(lib);
+
+use Colorize::Common qw(:defaults $write_to_tmpfile);
+use File::Temp qw(tmpnam);
+use Test::More;
+
+my $tests = 3;
+
+plan tests => $tests;
+
+SKIP: {
+ my $program = tmpnam();
+ my $conf_file = tmpnam();
+
+ skip 'compiling failed (color)', $tests unless system(qq($compiler -DTEST -DCONF_FILE_TEST=\"$conf_file\" -o $program $source)) == 0;
+
+ my $infile = $write_to_tmpfile->('foo');
+
+ open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} "color=green\n";
+ close($fh);
+
+ is(qx($program $infile), "\e[32mfoo\e[0m", 'color from config');
+ is(qx(printf %s "foo" | $program none/none), 'foo', 'read from stdin');
+ is(qx($program none/none $infile), 'foo', 'read from file');
+
+ unlink $program;
+ unlink $conf_file;
+}
diff --git a/t/conf/fail.t b/t/conf/fail.t
new file mode 100755
index 0000000..d3b8852
--- /dev/null
+++ b/t/conf/fail.t
@@ -0,0 +1,59 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use lib qw(lib);
+use constant true => 1;
+use constant false => 0;
+
+use Colorize::Common qw(:defaults $write_to_tmpfile);
+use File::Temp qw(tmpnam);
+use IPC::Open3 qw(open3);
+use Symbol qw(gensym);
+use Test::More;
+
+my $tests = 7;
+
+my $run_program_fail = sub
+{
+ my ($program, $message, $infile) = @_;
+
+ my $err = gensym;
+
+ my $pid = open3(gensym, gensym, $err, $program, qw(default), $infile);
+ waitpid($pid, 0);
+
+ my $output = do { local $/; <$err> };
+
+ return ($? >> 8 == 1 && $output =~ /$message/) ? true : false;
+};
+
+plan tests => $tests;
+
+SKIP: {
+ my $program = tmpnam();
+ my $conf_file = tmpnam();
+
+ skip 'compiling failed (config failure exit)', $tests unless system(qq($compiler -DTEST -DCONF_FILE_TEST=\"$conf_file\" -o $program $source)) == 0;
+
+ my $infile = $write_to_tmpfile->('');
+
+ my @set = (
+ [ 'attr=:', 'attr conf option must be provided a string' ],
+ [ 'attr=bold:underscore', 'attr conf option must have strings separated by ,' ],
+ [ 'attr=b0ld', 'attr conf option attribute \'b0ld\' is not valid' ],
+ [ 'attr=b0ld,underscore', 'attr conf option attribute \'b0ld\' is not valid' ], # handle comma
+ [ 'attr=bold,bold', 'attr conf option has attribute \'bold\' twice or more' ],
+ [ 'exclude-random=random', 'exclude-random conf option must be provided a plain color' ],
+ [ 'omit-color-empty=unsure', 'omit-color-empty conf option is not valid' ],
+ );
+ foreach my $set (@set) {
+ open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} $set->[0], "\n";
+ close($fh);
+ ok($run_program_fail->($program, $set->[1], $infile), $set->[1]);
+ }
+
+ unlink $program;
+ unlink $conf_file;
+}
diff --git a/t/conf/param.t b/t/conf/param.t
new file mode 100755
index 0000000..520df2b
--- /dev/null
+++ b/t/conf/param.t
@@ -0,0 +1,51 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use lib qw(lib);
+
+use Colorize::Common qw(:defaults $write_to_tmpfile);
+use File::Temp qw(tmpnam);
+use Test::More;
+
+my $tests = 2;
+
+my $conf = <<'EOT';
+attr=bold
+color=blue
+omit-color-empty=yes
+EOT
+
+my $expected = <<"EOT";
+\e[1;34mfoo\e[0m
+
+\e[1;34mbar\e[0m
+
+\e[1;34mbaz\e[0m
+EOT
+
+plan tests => $tests;
+
+SKIP: {
+ my $program = tmpnam();
+ my $conf_file = tmpnam();
+ # -DTEST omitted on purpose
+ skip 'compiling failed (config param)', $tests unless system(qq($compiler -o $program $source)) == 0;
+
+ my $infile = $write_to_tmpfile->(<<'EOT');
+foo
+
+bar
+
+baz
+EOT
+ open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} $conf;
+ close($fh);
+
+ is(qx($program -c $conf_file $infile), $expected, 'short option');
+ is(qx($program --config=$conf_file $infile), $expected, 'long option');
+
+ unlink $program;
+ unlink $conf_file;
+}
diff --git a/t/conf/parse/fail.t b/t/conf/parse/fail.t
new file mode 100755
index 0000000..ea267f8
--- /dev/null
+++ b/t/conf/parse/fail.t
@@ -0,0 +1,63 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use lib qw(lib);
+use constant true => 1;
+use constant false => 0;
+
+use Colorize::Common qw(:defaults $write_to_tmpfile);
+use File::Temp qw(tmpnam);
+use IPC::Open3 qw(open3);
+use Symbol qw(gensym);
+use Test::More;
+
+my $tests = 8;
+
+my $run_program_fail = sub
+{
+ my ($program, $message, $infile) = @_;
+
+ my $err = gensym;
+
+ my $pid = open3(gensym, gensym, $err, $program, qw(default), $infile);
+ waitpid($pid, 0);
+
+ my $output = do { local $/; <$err> };
+
+ return ($? >> 8 == 1 && $output =~ /$message/) ? true : false;
+};
+
+plan tests => $tests;
+
+SKIP: {
+ my $program = tmpnam();
+ my $conf_file = tmpnam();
+
+ skip 'compiling failed (config parse failure)', $tests unless system(qq($compiler -DTEST -DCONF_FILE_TEST=\"$conf_file\" -o $program $source)) == 0;
+
+ my $infile = $write_to_tmpfile->('');
+
+ my $chars_exceed = 'x' x 256;
+
+ my @set = (
+ [ '[attr=bold', 'option \'\[attr\' cannot be made of non-option characters' ],
+ [ 'attr1=bold', 'option \'attr1\' not recognized' ],
+ [ 'color1=magenta', 'option \'color1\' not recognized' ],
+ [ 'exclude-random1=black', 'option \'exclude-random1\' not recognized' ],
+ [ 'omit-color-empty1=yes', 'option \'omit-color-empty1\' not recognized' ],
+ [ 'attr', 'option \'attr\' not followed by =' ],
+ [ 'attr bold', 'option \'attr\' not followed by =' ],
+ [ "color=$chars_exceed", 'line 1 exceeds maximum of' ],
+ );
+
+ foreach my $set (@set) {
+ open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} $set->[0], "\n";
+ close($fh);
+ ok($run_program_fail->($program, $set->[1], $infile), $set->[1]);
+ }
+
+ unlink $program;
+ unlink $conf_file;
+}
diff --git a/t/conf/parse/success.t b/t/conf/parse/success.t
new file mode 100755
index 0000000..fe2d46d
--- /dev/null
+++ b/t/conf/parse/success.t
@@ -0,0 +1,74 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use lib qw(lib);
+use constant true => 1;
+use constant false => 0;
+
+use Colorize::Common qw(:defaults $write_to_tmpfile);
+use File::Temp qw(tmpnam);
+use IPC::Open3 qw(open3);
+use Symbol qw(gensym);
+use Test::More;
+
+my $tests = 21;
+
+my $conf = <<'EOT';
+# comment
+ # comment
+ # comment
+attr=bold
+attr =bold
+attr= bold
+attr =bold
+attr= bold
+attr = bold
+ color=green
+color=green
+ color=green
+color=green
+exclude-random=black
+omit-color-empty=yes
+attr=bold # comment
+attr=bold # comment
+attr=
+color=
+exclude-random=
+omit-color-empty=
+EOT
+
+my $run_program_succeed = sub
+{
+ my ($program, $infile) = @_;
+
+ my $err = gensym;
+
+ my $pid = open3(gensym, gensym, $err, $program, qw(default), $infile);
+ waitpid($pid, 0);
+
+ my $output = do { local $/; <$err> };
+
+ return ($? >> 8 == 0 && $output eq '') ? true : false;
+};
+
+plan tests => $tests;
+
+SKIP: {
+ my $program = tmpnam();
+ my $conf_file = tmpnam();
+
+ skip 'compiling failed (config parse success)', $tests unless system(qq($compiler -DTEST -DCONF_FILE_TEST=\"$conf_file\" -o $program $source)) == 0;
+
+ my $infile = $write_to_tmpfile->('');
+
+ foreach my $line (split /\n/, $conf) {
+ open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} $line, "\n";
+ close($fh);
+ ok($run_program_succeed->($program, $infile), $line);
+ }
+
+ unlink $program;
+ unlink $conf_file;
+}
diff --git a/t/conf/use.t b/t/conf/use.t
new file mode 100755
index 0000000..0a695df
--- /dev/null
+++ b/t/conf/use.t
@@ -0,0 +1,57 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use lib qw(lib);
+
+use Colorize::Common qw(:defaults $write_to_tmpfile);
+use File::Temp qw(tmpnam);
+use Test::More;
+
+my $tests = 21;
+
+my $conf = <<'EOT';
+attr=underscore
+color=yellow # tested also in color.t
+omit-color-empty=yes
+EOT
+
+plan tests => $tests;
+
+SKIP: {
+ my $program = tmpnam();
+ my $conf_file = tmpnam();
+
+ skip 'compiling failed (use config)', $tests unless system(qq($compiler -DTEST -DCONF_FILE_TEST=\"$conf_file\" -o $program $source)) == 0;
+
+ my $infile1 = $write_to_tmpfile->(<<'EOT');
+foo
+
+bar
+
+baz
+EOT
+ open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} $conf;
+ close($fh);
+
+ is(qx($program $infile1), <<"EOT", 'use config');
+\e[4;33mfoo\e[0m
+
+\e[4;33mbar\e[0m
+
+\e[4;33mbaz\e[0m
+EOT
+ my $infile2 = $write_to_tmpfile->('foo');
+
+ open($fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
+ print {$fh} "exclude-random=black\n";
+ close($fh);
+
+ for (my $i = 1; $i <= 20; $i++) {
+ like(qx($program random $infile2), qr/^\e\[3[1-7]mfoo\e\[0m$/, 'use exclude-random');
+ }
+
+ unlink $program;
+ unlink $conf_file;
+}
diff --git a/t/merge.t b/t/merge.t
index 848c022..a234b12 100755
--- a/t/merge.t
+++ b/t/merge.t
@@ -103,7 +103,7 @@ my $compile = sub
my ($buf_size) = @_;
return true if exists $programs{$buf_size};
my $program = tmpnam();
- return false unless system("$compiler -DTEST_MERGE_PART_LINE -DBUF_SIZE=$buf_size -o $program $source") == 0;
+ return false unless system("$compiler -DTEST -DTEST_MERGE_PART_LINE -DBUF_SIZE=$buf_size -o $program $source") == 0;
$programs{$buf_size} = $program;
return true; # compiling succeeded
};
@@ -147,7 +147,7 @@ foreach my $test (@pushback) {
my $buf_size = $test->[1];
SKIP: {
my $program = tmpnam();
- skip $compiling_failed_msg, 1 unless system("$compiler -DBUF_SIZE=$buf_size -o $program $source") == 0;
+ skip $compiling_failed_msg, 1 unless system("$compiler -DTEST -DBUF_SIZE=$buf_size -o $program $source") == 0;
ok(qx(printf %s "$test->[0]" | $program --clean) eq $test->[0], 'pushback: ' . $test_name->($test->[0], $buf_size));
unlink $program;
}
diff --git a/test.pl b/test.pl
index 85e12b5..0ed7436 100755
--- a/test.pl
+++ b/test.pl
@@ -7,6 +7,7 @@ use constant true => 1;
use constant false => 0;
use Colorize::Common qw(:defaults $compiler_flags %BUF_SIZE $valgrind_command $write_to_tmpfile);
+use File::Find;
use File::Temp qw(tmpnam);
use Getopt::Long qw(:config no_auto_abbrev no_ignore_case);
use Test::Harness qw(runtests);
@@ -28,8 +29,9 @@ my $valgrind_cmd = '';
}
{
- my @test_files = glob('t/*.t');
- eval { runtests(@test_files) } or warn $@;
+ my @test_files;
+ find ({ wanted => sub { push @test_files, $File::Find::name if /\.t$/ } }, 't');
+ eval { runtests(sort @test_files) } or warn $@;
}
plan tests => $tests;