Add support for style overrides

Soft · Soft · commit 75b40ee1e603 · 2020-10-11T14:27:01.000+03:00
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright 2018-2019 Samuel Laurén
+Copyright 2018-2020 Samuel Laurén
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
diff --git a/README.md b/README.md
@@ -34,26 +34,35 @@ make
 ### Usage
 
 ```
-Usage: rainbowpath [-p PALETTE] [-s STYLE] [-S SEPARATOR] [-m METHOD]
+Usage: rainbowpath [-p PALETTE] [-s PALETTE] [-S SEPARATOR] [-m METHOD]
+                   [-M METHOD] [-o INDEX STYLE] [-O INDEX STYLE]
                    [-l] [-c] [-n] [-b] [-h] [-v] [PATH]
 
 Color path components using a palette.
 
 Options:
-  -p, --palette=PALETTE             Semicolon-separated list of styles for
-                                    path components
-  -s, --separator=STYLE             Style for path separators
-  -S, --separator-string=SEPARATOR  String used to separate path components
-                                    in the output (defaults to '/')
-  -m, --method=METHOD               Method for selecting styles from palette.
-                                    One of sequential, hash, random
-                                    (defaults to sequential).
-  -l, --leading                     Do not display leading path separator
-  -c, --compact                     Replace home directory path prefix with ~
-  -n, --newline                     Do not append newline
-  -b, --bash                        Escape control codes for use in Bash prompts
-  -h, --help                        Display this help
-  -v, --version                     Display version information
+  -p, --palette PALETTE                 Semicolon separated list of styles for
+                                        path components
+  -s, --separator-palette PALETTE       Semicolon separated list of styles for
+                                        path separators.
+  -S, --separator SEPARATOR             String used to separate path components
+                                        in the output (defaults to '/')
+  -m, --method METHOD                   Method for selecting styles from palette.
+                                        One of sequential, hash, random
+                                        (defaults to sequential).
+  -M, --separator-method METHOD         Method for selecting styles from separator
+                                        palette. One of sequential, hash, random
+                                        (defaults to sequential).
+  -o, --override INDEX STYLE            Override style at the given index. This option
+                                        can appear multiple times.
+  -O, --separator-override INDEX STYLE  Override separator style at the given index.
+                                        This option can appear multiple times.
+  -l, --leading                         Do not display leading path separator
+  -c, --compact                         Replace home directory path prefix with ~
+  -n, --newline                         Do not append newline
+  -b, --bash                            Escape control codes for use in Bash prompts
+  -h, --help                            Display this help
+  -v, --version                         Display version information
 ```
 
 ### Use in a Bash prompt
@@ -90,13 +99,51 @@ separated by commas. The possible properties are:
 | `underlined` | Underlined text                 |
 | `blink`      | Blinking text                   |
 
-Where `COLOR` is an integer between 0 and 255.
+Where `COLOR` is an integer between 0 and 255 or one of: `black`, `red`,
+`green`, `yellow`, `blue`, `magenta`, `cyan`, `white`.
 
-For example, the following invocation will display the current working
-directory's path altering path components' styles between underlined green (2)
-and bold yellow (3) on magenta (5) background:
+For example, the following invocation will display the path of the current
+working directory altering styles of path components between underlined green
+text and bold yellow text on magenta background:
 
 ``` shell
-rainbowpath --palette 'fg=2,underlined;fg=3,bg=5,bold'
+rainbowpath --palette 'fg=green,underlined;fg=yellow,bg=magenta,bold'
 ```
 
+### Style Overrides
+
+`--override` and `--separator-override` options make it possible to selectively
+override the style of particular path component at a specific index.
+
+For example, the following command displays all the directory components of the
+path as blue, except the first one (index `0` "this") which will be displayed as
+yellow.
+
+``` shell
+rainbowpath -p 'fg=blue' -o 0 'fg=yellow' '/this/is/an/example/'
+```
+
+Component indexes can also be negative, in which case they start at the end of
+the list of path components. For example, the following command will print
+"example" as yellow.
+
+``` shell
+rainbowpath -p 'fg=blue' -o -1 'fg=yellow' '/this/is/an/example/'
+```
+
+Override styles are merged with the base style from the palette. For example,
+the following command will display example in blue bold font.
+
+``` shell
+rainbowpath -p 'fg=blue' -o -1 'bold' '/this/is/an/example/'
+```
+
+Override styles are also able to revert style properties set by the base style.
+This can be achieved by prefixing the property name with a `!`.
+
+For example, the following command will print all path components in bold yellow
+font, except the last one which will be printed in the regular font:
+
+``` shell
+rainbowpath -p 'fg=yellow,bold' -o -1 '!fg,!bold' '/this/is/an/example/'
+```
diff --git a/man/rainbowpath.1 b/man/rainbowpath.1
@@ -1,5 +1,5 @@
 '\" t
-.TH RAINBOWPATH 1 2018-2019
+.TH RAINBOWPATH 1 2018-2020
 
 .SH NAME
 
@@ -8,26 +8,26 @@ rainbowpath \- Color path components using a palette.
 .SH SYNOPSIS
 
 .B rainbowpath
-[\fB\-p\fR \fIPALETTE\fR] [\fB\-s\fR \fISTYLE\fR] [\fB\-S\fR \fISEPARATOR\fR] [\fB\-m\fR \fIMETHOD\fR] [\fB\-l\fR] [\fB\-c\fR] [\fB\-n\fR] [\fB\-b\fR] [\fB\-h\fR] [\fB\-v\fR] [\fIPATH\fR]
+[\fB\-p\fR \fIPALETTE\fR] [\fB\-s\fR \fIPALETTE\fR] [\fB\-S\fR \fISEPARATOR\fR] [\fB\-m\fR \fIMETHOD\fR] [\fB\-M\fR \fIMETHOD\fR] [\fB\-o\fR \fIINDEX\fR \fISTYLE\fR] [\fB\-O\fR \fIINDEX\fR \fISTYLE\fR] [\fB\-l\fR] [\fB\-c\fR] [\fB\-n\fR] [\fB\-b\fR] [\fB\-h\fR] [\fB\-v\fR] [\fIPATH\fR]
 
 \fBrainbowpath\fR formats supplied path by coloring each path component with a
 color selected from a palette. By default, colors for path components are
 selected based on the order they appear in the palette. If no palette is
 supplied a default one will be used. When invoked without a path
-\fBrainbowpath\fR displays the current working directory.
+\fBrainbowpath\fR colors the path of the current working directory.
 
 .SH OPTIONS
 
 .TP
 .BI \-p " PALETTE\fR,\fP " \-\-palette " PALETTE"
-Semicolon-separated list of styles for path components.
+Semicolon separated list of styles for path components.
 
 .TP
-.BI \-s " STYLE\fR,\fP " \-\-separator " STYLE"
-Style for path separators.
+.BI \-s " PALETTE\fR,\fP " \-\-separator\-palette " PALETTE"
+Semicolon separated list of styles for path separators.
 
 .TP
-.BI \-S " SEPARATOR\fR,\fP " \-\-separator\-string " SEPARATOR"
+.BI \-S " SEPARATOR\fR,\fP " \-\-separator " SEPARATOR"
 String used to separate path components in the output (defaults to '\fI/\fR').
 
 .TP
@@ -39,6 +39,24 @@ styles based on the order they appear in the palette. \fIhash\fR mode selects
 styles based on the contents of path segment being processed. \fIrandom\fR mode
 selects styles randomly from the palette.
 
+.TP
+.BI \-M " METHOD\fR,\fP " \-\-separator\-method " METHOD"
+
+Method for selecting styles from separator palette. See \fB\-\-method\fR for
+further details.
+
+.TP
+.BI \-o " INDEX STYLE\fR,\fP " \-\-override " INDEX STYLE"
+
+Override style at the given index. This option can appear multiple times. See
+\fBSTYLE OVERRIDES\fR for further details.
+
+.TP
+.BI \-O " INDEX STYLE\fR,\fP " \-\-separator\-override " INDEX STYLE"
+
+Override separator style at given the index. This option can appear multiple
+times. See \fBSTYLE OVERRIDES\fR for further details.
+
 .TP
 .BR \-l ", " \-\-leading
 Do not display leading path separator.
@@ -66,8 +84,8 @@ Display version information.
 .SH STYLES
 
 Styles specify how path components should look. \fB\-\-palette\fR and
-\fB\-\-separator\fR options accept styles as arguments. Style consists of a list
-of properties separated by commas. The possible properties are:
+\fB\-\-separator\-palette\fR options accept styles as arguments. Style consists
+of a list of properties separated by commas. The possible properties are:
 
 .RS
 .TS
@@ -83,14 +101,54 @@ blink	Blinking text
 .TE
 .RE
 
-Where \fICOLOR\fR is an integer between \fI0\fR and \fI255\fR.
+Where \fICOLOR\fR is an integer between \fI0\fR and \fI255\fR or one of:
+\fIblack\fR, \fIred\fR, \fIgreen\fR, \fIyellow\fR, \fIblue\fR, \fImagenta\fR,
+\fIcyan\fR, \fIwhite\fR.
+
+For example, the following invocation will display the path of the current
+working directory altering styles of path components between underlined green
+text and bold yellow text on magenta background:
+
+.nf
+rainbowpath --palette 'fg=green,underlined;fg=yellow,bg=magenta,bold'
+.fi
+
+.SH STYLE OVERRIDES
+
+\fB\-\-override\fR and \fB\-\-separator-override\fR options make it possible to
+selectively override the style of particular path component at a specific index.
+
+For example, the following command displays all the directory components of the
+path as blue, except the first one (index \fI0\fR `this') which will be
+displayed as yellow.
+
+.nf
+rainbowpath -p 'fg=blue' -o 0 'fg=yellow' '/this/is/an/example/'
+.fi
+
+Component indexes can also be negative, in which case they start at the end of
+the list of path components. For example, the following command will print
+`example' as yellow.
+
+.nf
+rainbowpath -p 'fg=blue' -o -1 'fg=yellow' '/this/is/an/example/'
+.fi
+
+Override styles are merged with the base style from the palette. For example,
+the following command will display example in blue bold font.
+
+.nf
+rainbowpath -p 'fg=blue' -o -1 'bold' '/this/is/an/example/'
+.fi
+
+Override styles are also able to revert style properties set by the base style.
+This can be achieved by prefixing the property name with a \fI!\fR.
 
-For example, the following invocation will display the current working
-directory's path altering path components' styles between underlined green
-(\fI2\fR) and bold yellow (\fI3\fR) on magenta (\fI5\fR) background:
+For example, the following command will print all path components in bold yellow
+font, except the last one which will be printed in the regular font:
 
 .nf
-rainbowpath --palette 'fg=2,underlined;fg=3,bg=5,bold'
+rainbowpath -p 'fg=yellow,bold' -o -1 '!fg,!bold' '/this/is/an/example/'
 .fi
 
 .SH AUTHORS
diff --git a/src/rainbowpath.c b/src/rainbowpath.c

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright 2018-2019 Samuel Laurén`
	`1`	`+Copyright 2018-2020 Samuel Laurén`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person obtaining a copy of`
`4`	`4`	`this software and associated documentation files (the "Software"), to deal in`