aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Steven Schubiger <stsc@refcnt.org> 2024-07-28 17:04:36 +0200
committerGravatar Steven Schubiger <stsc@refcnt.org> 2024-07-28 17:04:36 +0200
commit46921f49f5e5e68f75a0d08671147ea4edcc8b0b (patch)
tree976e0702780ff80fe44e191c0d0c0e70bd35e587
parentd681c49c3229265ab29621430a64606165629c9b (diff)
downloadcolorize-46921f49f5e5e68f75a0d08671147ea4edcc8b0b.tar.gz
colorize-46921f49f5e5e68f75a0d08671147ea4edcc8b0b.tar.bz2
Allow for background color rainbow mode
-rw-r--r--colorize.17
-rw-r--r--colorize.c120
-rwxr-xr-xt/conf/fail.t20
-rwxr-xr-xt/conf/parse/fail.t3
-rwxr-xr-xt/conf/parse/success.t4
-rwxr-xr-xt/conf/use.t10
-rwxr-xr-xt/fail.t8
-rwxr-xr-xtest.pl12
8 files changed, 132 insertions, 52 deletions
diff --git a/colorize.1 b/colorize.1
index 0f805fe..3aea22f 100644
--- a/colorize.1
+++ b/colorize.1
@@ -1,4 +1,4 @@
-.TH COLORIZE 1 "2024-07-25" "colorize v0.66" "User Commands"
+.TH COLORIZE 1 "2024-07-28" "colorize v0.66" "User Commands"
.SH NAME
colorize \- colorize text on terminal with ANSI escape sequences
.SH SYNOPSIS
@@ -52,6 +52,9 @@ omit printing color escape sequences for empty lines
.BR \-\-rainbow\-fg
enable foreground color rainbow mode
.TP
+.BR \-\-rainbow\-bg
+enable background color rainbow mode
+.TP
.BR \-h ", " \-\-help
show help screen and exit
.TP
@@ -80,6 +83,7 @@ color = magenta # favorite one
exclude-random = black
omit-color-empty = yes
rainbow-fg = no
+rainbow-bg = no
.fi
.RE
.RE
@@ -93,6 +97,7 @@ color (value same as command-line colors)
exclude-random (value same as command-line option)
omit-color-empty (yes/no)
rainbow-fg (yes/no)
+rainbow-bg (yes/no)
.fi
.RE
.RE
diff --git a/colorize.c b/colorize.c
index 1dbebc9..9cca228 100644
--- a/colorize.c
+++ b/colorize.c
@@ -142,6 +142,7 @@ struct conf {
char *exclude_random;
char *omit_color_empty;
char *rainbow_fg;
+ char *rainbow_bg;
};
enum { DESC_OPTION, DESC_CONF };
@@ -215,7 +216,7 @@ static const char *formats[] = {
"%s: option '%s' %s", /* conf */
"config file %s: %s", /* conf file */
"%s %s", /* conf init */
- "%s color '%s' %s" /* rainbow */
+ "%s color '%s' %s %s" /* rainbow */
};
enum { GENERIC, FOREGROUND = 0, BACKGROUND };
@@ -234,7 +235,8 @@ enum opt_set {
OPT_ATTR_SET = 0x01,
OPT_EXCLUDE_RANDOM_SET = 0x02,
OPT_OMIT_COLOR_EMPTY_SET = 0x04,
- OPT_RAINBOW_FG_SET = 0x08
+ OPT_RAINBOW_FG_SET = 0x08,
+ OPT_RAINBOW_BG_SET = 0x10
};
static struct {
char *attr;
@@ -249,6 +251,7 @@ enum {
OPT_EXCLUDE_RANDOM,
OPT_OMIT_COLOR_EMPTY,
OPT_RAINBOW_FG,
+ OPT_RAINBOW_BG,
OPT_HELP,
OPT_VERSION
};
@@ -261,6 +264,7 @@ static const struct option long_opts[] = {
{ "exclude-random", required_argument, &opt_type, OPT_EXCLUDE_RANDOM },
{ "omit-color-empty", no_argument, &opt_type, OPT_OMIT_COLOR_EMPTY },
{ "rainbow-fg", no_argument, &opt_type, OPT_RAINBOW_FG },
+ { "rainbow-bg", no_argument, &opt_type, OPT_RAINBOW_BG },
{ "help", no_argument, &opt_type, OPT_HELP },
{ "version", no_argument, &opt_type, OPT_VERSION },
{ NULL, 0, NULL, 0 },
@@ -297,10 +301,16 @@ static FILE *log;
static unsigned int stacked_vars;
static struct var_list *vars_list;
+static struct {
+ bool fg;
+ bool bg;
+} rainbow_from_conf = { false, false };
+
static bool clean;
static bool clean_all;
static bool omit_color_empty;
static bool rainbow_fg;
+static bool rainbow_bg;
static char attr[MAX_ATTRIBUTE_CHARS + 1];
static char *exclude;
@@ -317,8 +327,8 @@ 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_conf_boolean (const char *, bool *, const char *);
+static void init_conf_vars (const char *, const struct conf *);
+static void init_conf_boolean (const char *, bool *, const char *, bool *);
static void init_opts_vars (void);
static void print_hint (void);
static void print_help (void);
@@ -338,8 +348,8 @@ static void save_char (char, char **, size_t *, size_t *);
static void find_color_entries (struct color_name **, const struct color **);
static void find_color_entry (const struct color_name *, unsigned int, const struct color **);
static void print_line (const char *, const struct color **, const char * const, unsigned int, bool);
-static unsigned int get_rainbow_index (const struct color **, unsigned int, unsigned int);
-static bool skipable_rainbow_index (const struct color **, unsigned int);
+static unsigned int get_rainbow_index (const struct color **, unsigned int, unsigned int, unsigned int);
+static bool skipable_rainbow_index (const struct color **, unsigned int, unsigned int);
static void print_clean (const char *);
static bool is_esc (const char *);
static const char *get_end_of_esc (const char *);
@@ -387,7 +397,7 @@ main (int argc, char **argv)
const char *file = NULL;
char *conf_file = NULL;
- struct conf config = { NULL, NULL, NULL, NULL, NULL };
+ struct conf config = { NULL, NULL, NULL, NULL, NULL, NULL };
program_name = argv[0];
atexit (cleanup);
@@ -434,12 +444,13 @@ main (int argc, char **argv)
if (access (conf_file, F_OK) != -1)
parse_conf (conf_file, &config);
#endif
+ init_conf_vars (conf_file, &config);
+
+ init_opts_vars ();
+
#if !defined(CONF_FILE_TEST) && !defined(TEST)
RELEASE (conf_file);
#endif
- init_conf_vars (&config);
-
- init_opts_vars ();
arg_cnt = argc - optind;
@@ -459,6 +470,7 @@ main (int argc, char **argv)
{ "exclude-random", OPT_EXCLUDE_RANDOM_SET },
{ "omit-color-empty", OPT_OMIT_COLOR_EMPTY_SET },
{ "rainbow-fg", OPT_RAINBOW_FG_SET },
+ { "rainbow-bg", OPT_RAINBOW_BG_SET },
};
for (i = 0; i < COUNT_OF (options, struct option_set); i++)
if (opts_set & options[i].set)
@@ -467,6 +479,12 @@ main (int argc, char **argv)
}
else
{
+ if (rainbow_fg && rainbow_bg)
+ vfprintf_fail ("%s and %s are mutually exclusive",
+ !rainbow_from_conf.fg ? "--rainbow-fg switch" : "rainbow-fg conf option",
+ !rainbow_from_conf.bg ? "--rainbow-bg switch" : "rainbow-bg conf option"
+ );
+
if (arg_cnt == 0 || arg_cnt > 2)
{
vfprintf_diag ("%u arguments provided, expected 1-2 arguments or --clean[-all]", arg_cnt);
@@ -562,6 +580,9 @@ process_opts (int argc, char **argv, char **conf_file)
case OPT_RAINBOW_FG:
opts_set |= OPT_RAINBOW_FG_SET;
break;
+ case OPT_RAINBOW_BG:
+ opts_set |= OPT_RAINBOW_BG_SET;
+ break;
case OPT_HELP:
PRINT_HELP_EXIT ();
case OPT_VERSION:
@@ -715,6 +736,8 @@ init_opts_vars (void)
omit_color_empty = true;
if (opts_set & OPT_RAINBOW_FG_SET)
rainbow_fg = true;
+ if (opts_set & OPT_RAINBOW_BG_SET)
+ rainbow_bg = true;
RELEASE (opts_arg.attr);
RELEASE (opts_arg.exclude_random);
@@ -823,25 +846,38 @@ assign_conf (const char *conf_file, struct conf *config, const char *cfg, char *
ASSIGN_CONF (config->omit_color_empty, val);
else if (streq (cfg, "rainbow-fg"))
ASSIGN_CONF (config->rainbow_fg, val);
+ else if (streq (cfg, "rainbow-bg"))
+ ASSIGN_CONF (config->rainbow_bg, val);
else
vfprintf_fail (formats[FMT_CONF], conf_file, cfg, "not recognized");
}
static void
-init_conf_vars (const struct conf *config)
+init_conf_vars (const char *conf_file, const struct conf *config)
{
+ bool dummy;
+
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)
- init_conf_boolean (config->omit_color_empty, &omit_color_empty, "omit-color-empty");
- if (config->rainbow_fg)
- init_conf_boolean (config->rainbow_fg, &rainbow_fg, "rainbow-fg");
+ init_conf_boolean (config->omit_color_empty, &omit_color_empty, "omit-color-empty", &dummy);
+
+ if (config->rainbow_fg || config->rainbow_bg)
+ {
+ if (config->rainbow_fg && config->rainbow_bg)
+ vfprintf_fail (formats[FMT_CONF_FILE], conf_file, "rainbow-fg and rainbow-bg option are mutually exclusive");
+
+ if (config->rainbow_fg)
+ init_conf_boolean (config->rainbow_fg, &rainbow_fg, "rainbow-fg", &rainbow_from_conf.fg);
+ else if (config->rainbow_bg)
+ init_conf_boolean (config->rainbow_bg, &rainbow_bg, "rainbow-bg", &rainbow_from_conf.bg);
+ }
}
static void
-init_conf_boolean (const char *conf_var, bool *boolean_var, const char *name)
+init_conf_boolean (const char *conf_var, bool *boolean_var, const char *name, bool *seen_opt)
{
if (streq (conf_var, "yes"))
*boolean_var = true;
@@ -849,6 +885,7 @@ init_conf_boolean (const char *conf_var, bool *boolean_var, const char *name)
*boolean_var = false;
else
vfprintf_fail (formats[FMT_CONF_INIT], name, "conf option is not valid");
+ *seen_opt = true;
}
static void
@@ -1028,6 +1065,7 @@ free_conf (struct conf *config)
RELEASE (config->exclude_random);
RELEASE (config->omit_color_empty);
RELEASE (config->rainbow_fg);
+ RELEASE (config->rainbow_bg);
}
static void
@@ -1101,8 +1139,12 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct
}
}
- /* --rainbow-fg */
- if (rainbow_fg)
+ /* --rainbow-bg */
+ if (rainbow_bg && !color_names[BACKGROUND])
+ vfprintf_fail ("background color required with %s", !rainbow_from_conf.bg ? "--rainbow-bg switch" : "rainbow-bg conf option");
+
+ /* --rainbow{-fg,-bg} */
+ if (rainbow_fg || rainbow_bg)
{
unsigned int i;
const unsigned int color_set[2] = { FOREGROUND, BACKGROUND };
@@ -1113,7 +1155,12 @@ process_args (unsigned int arg_cnt, char **arg_strings, char *attr, const struct
streq (color_names[color]->name, "none")
|| streq (color_names[color]->name, "default"))
)
- vfprintf_fail (formats[FMT_RAINBOW], tables[color].desc, color_names[color]->orig, "cannot be used with --rainbow-fg");
+ {
+ vfprintf_fail (formats[FMT_RAINBOW], tables[color].desc, color_names[color]->orig, "cannot be used with",
+ rainbow_fg ? !rainbow_from_conf.fg ? "--rainbow-fg switch" : "rainbow-fg conf option"
+ : !rainbow_from_conf.bg ? "--rainbow-bg switch" : "rainbow-bg conf option"
+ );
+ }
}
}
@@ -1553,20 +1600,31 @@ print_line (const char *attr, const struct color **colors, const char *const lin
/* skip for --omit-color-empty? */
else if (emit_colors)
{
- /* --rainbow-fg */
- if (rainbow_fg)
+ /* --rainbow{-fg,-bg} */
+ if (rainbow_fg || rainbow_bg)
{
- unsigned int index;
- const unsigned int max_index = tables[FOREGROUND].count - 2; /* omit color default */
+ const unsigned int color_sets[2][2] = { { FOREGROUND, BACKGROUND }, { BACKGROUND, FOREGROUND } };
+ unsigned int color_iter, color_cmp, set;
+ unsigned int index, max_index;
+
+ if (rainbow_fg)
+ set = 0;
+ else if (rainbow_bg)
+ set = 1;
+
+ color_iter = color_sets[set][0];
+ color_cmp = color_sets[set][1];
+
+ max_index = tables[color_iter].count - 2; /* omit color default */
if (rainbow_index == 0)
- rainbow_index = colors[FOREGROUND]->index; /* init */
+ rainbow_index = colors[color_iter]->index; /* init */
else if (rainbow_index > max_index)
rainbow_index = 1; /* black */
- index = get_rainbow_index (colors, rainbow_index, max_index);
+ index = get_rainbow_index (colors, color_cmp, rainbow_index, max_index);
- colors[FOREGROUND] = (struct color *)&tables[FOREGROUND].entries[index];
+ colors[color_iter] = (struct color *)&tables[color_iter].entries[index];
rainbow_index = index + 1;
}
@@ -1586,13 +1644,13 @@ print_line (const char *attr, const struct color **colors, const char *const lin
}
static unsigned int
-get_rainbow_index (const struct color **colors, unsigned int index, unsigned int max)
+get_rainbow_index (const struct color **colors, unsigned int color_cmp, unsigned int index, unsigned int max)
{
- if (skipable_rainbow_index (colors, index))
+ if (skipable_rainbow_index (colors, color_cmp, index))
{
if (index + 1 > max)
{
- if (skipable_rainbow_index (colors, 1))
+ if (skipable_rainbow_index (colors, color_cmp, 1))
return 2;
else
return 1;
@@ -1605,9 +1663,11 @@ get_rainbow_index (const struct color **colors, unsigned int index, unsigned int
}
static bool
-skipable_rainbow_index (const struct color **colors, unsigned int index)
+skipable_rainbow_index (const struct color **colors, unsigned int color_cmp, unsigned int index)
{
- return (colors[BACKGROUND] && index == colors[BACKGROUND]->index);
+ if (color_cmp == BACKGROUND && !colors[color_cmp])
+ return false;
+ return (index == colors[color_cmp]->index);
}
static void
diff --git a/t/conf/fail.t b/t/conf/fail.t
index 9e16a49..0a16f8e 100755
--- a/t/conf/fail.t
+++ b/t/conf/fail.t
@@ -12,7 +12,7 @@ use IPC::Open3 qw(open3);
use Symbol qw(gensym);
use Test::More;
-my $tests = 8;
+my $tests = 10;
my $run_program_fail = sub
{
@@ -39,14 +39,16 @@ SKIP: {
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' ],
- [ 'rainbow-fg=unsure', 'rainbow-fg conf option is not valid' ],
+ [ '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' ],
+ [ 'rainbow-fg=unsure', 'rainbow-fg conf option is not valid' ],
+ [ 'rainbow-bg=unsure', 'rainbow-bg conf option is not valid' ],
+ [ "rainbow-fg=yes\nrainbow-bg=no", 'mutually exclusive' ],
);
foreach my $set (@set) {
open(my $fh, '>', $conf_file) or die "Cannot open `$conf_file' for writing: $!\n";
diff --git a/t/conf/parse/fail.t b/t/conf/parse/fail.t
index 13f27ff..f3aef48 100755
--- a/t/conf/parse/fail.t
+++ b/t/conf/parse/fail.t
@@ -12,7 +12,7 @@ use IPC::Open3 qw(open3);
use Symbol qw(gensym);
use Test::More;
-my $tests = 10;
+my $tests = 11;
my $run_program_fail = sub
{
@@ -47,6 +47,7 @@ SKIP: {
[ 'exclude-random1=black', 'option \'exclude-random1\' not recognized' ],
[ 'omit-color-empty1=yes', 'option \'omit-color-empty1\' not recognized' ],
[ 'rainbow-fg1=no', 'option \'rainbow-fg1\' not recognized' ],
+ [ 'rainbow-bg1=no', 'option \'rainbow-bg1\' not recognized' ],
[ 'attr', 'option \'attr\' not followed by =' ],
[ 'attr#', 'option \'attr\' not followed by =' ],
[ 'attr bold', 'option \'attr\' not followed by =' ],
diff --git a/t/conf/parse/success.t b/t/conf/parse/success.t
index 1ce06b0..9dd4937 100755
--- a/t/conf/parse/success.t
+++ b/t/conf/parse/success.t
@@ -12,7 +12,7 @@ use IPC::Open3 qw(open3);
use Symbol qw(gensym);
use Test::More;
-my $tests = 23;
+my $tests = 25;
my $conf = <<'EOT';
# comment
@@ -31,6 +31,7 @@ color=green
exclude-random=black
omit-color-empty=yes
rainbow-fg=no
+rainbow-bg=no
attr=bold # comment
attr=bold # comment
attr=
@@ -38,6 +39,7 @@ color=
exclude-random=
omit-color-empty=
rainbow-fg=
+rainbow-bg=
EOT
my $run_program_succeed = sub
diff --git a/t/conf/use.t b/t/conf/use.t
index 5132afa..8c0586e 100755
--- a/t/conf/use.t
+++ b/t/conf/use.t
@@ -12,9 +12,9 @@ my $tests = 21;
my $conf = <<'EOT';
attr=underscore
-color=yellow # tested also in color.t
+color=yellow/black # tested also in color.t
omit-color-empty=yes
-rainbow-fg=yes
+rainbow-bg=yes
EOT
plan tests => $tests;
@@ -37,11 +37,11 @@ EOT
close($fh);
is(qx($program $infile1), <<"EOT", 'use config');
-\e[4;33mfoo\e[0m
+\e[40m\e[4;33mfoo\e[0m
-\e[4;34mbar\e[0m
+\e[41m\e[4;33mbar\e[0m
-\e[4;35mbaz\e[0m
+\e[42m\e[4;33mbaz\e[0m
EOT
my $infile2 = $write_to_tmpfile->('foo');
diff --git a/t/fail.t b/t/fail.t
index c44cb7a..c587fb3 100755
--- a/t/fail.t
+++ b/t/fail.t
@@ -12,7 +12,7 @@ use IPC::Open3 qw(open3);
use Symbol qw(gensym);
use Test::More;
-my $tests = 29;
+my $tests = 31;
my $run_program_fail = sub
{
@@ -65,10 +65,12 @@ SKIP: {
[ 'random/default', 'cannot be combined with' ],
[ 'none/random', 'cannot be combined with' ],
[ 'default/random', 'cannot be combined with' ],
+ [ '--rainbow-fg --rainbow-bg', 'mutually exclusive' ],
+ [ 'green --rainbow-bg', 'background color required with' ],
[ 'white/none --rainbow-fg', 'cannot be used with --rainbow-fg' ],
- [ 'white/default --rainbow-fg', 'cannot be used with --rainbow-fg' ],
+ [ 'white/default --rainbow-bg', 'cannot be used with --rainbow-bg' ],
[ 'none/white --rainbow-fg', 'cannot be used with --rainbow-fg' ],
- [ 'default/white --rainbow-fg', 'cannot be used with --rainbow-fg' ],
+ [ 'default/white --rainbow-bg', 'cannot be used with --rainbow-bg' ],
);
foreach my $set (@set) {
ok($run_program_fail->($program, $set->[0], $set->[1]), $set->[1]);
diff --git a/test.pl b/test.pl
index 5467722..8294e8f 100755
--- a/test.pl
+++ b/test.pl
@@ -13,7 +13,7 @@ use Getopt::Long qw(:config no_auto_abbrev no_ignore_case);
use Test::Harness qw(runtests);
use Test::More;
-my $tests = 34;
+my $tests = 36;
my $valgrind_cmd = '';
{
@@ -101,7 +101,7 @@ SKIP: {
{
my $ok = true;
- foreach my $option (qw(--attr=bold --exclude-random=black --omit-color-empty --rainbow-fg)) {
+ foreach my $option (qw(--attr=bold --exclude-random=black --omit-color-empty --rainbow-fg --rainbow-bg)) {
$ok &= qx($valgrind_cmd$program $option $switch $infile1 2>&1 >/dev/null) =~ /switch has no meaning with/;
}
ok($ok, "$type strict options");
@@ -170,6 +170,14 @@ SKIP: {
is_deeply([split /\n/, qx($valgrind_cmd$program white --rainbow-fg $infile)],
[split /\n/, "\e[37mfoo\e[0m\n\e[30mbar\e[0m\n\e[31mbaz\e[0m"],
'switch rainbow-fg (reset)');
+
+ is_deeply([split /\n/, qx($valgrind_cmd$program black/black --rainbow-bg $infile)],
+ [split /\n/, "\e[41m\e[30mfoo\e[0m\n\e[42m\e[30mbar\e[0m\n\e[43m\e[30mbaz\e[0m"],
+ 'switch rainbow-bg (init)');
+
+ is_deeply([split /\n/, qx($valgrind_cmd$program green/white --rainbow-bg $infile)],
+ [split /\n/, "\e[47m\e[32mfoo\e[0m\n\e[40m\e[32mbar\e[0m\n\e[41m\e[32mbaz\e[0m"],
+ 'switch rainbow-bg (reset)');
}
SKIP: {