File: nn.sh
   1 #!/bin/sh
   2 
   3 # The MIT License (MIT)
   4 #
   5 # Copyright © 2020-2025 pacman64
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining a copy
   8 # of this software and associated documentation files (the “Software”), to deal
   9 # in the Software without restriction, including without limitation the rights
  10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11 # copies of the Software, and to permit persons to whom the Software is
  12 # furnished to do so, subject to the following conditions:
  13 #
  14 # The above copyright notice and this permission notice shall be included in
  15 # all copies or substantial portions of the Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23 # SOFTWARE.
  24 
  25 
  26 # nn [option...] [files...]
  27 #
  28 #
  29 # Nice Numbers restyles all runs of 4+ digits by alternating ANSI-styles
  30 # every 3-digit group, so long numbers become easier to read at a glance.
  31 #
  32 # All (optional) leading options start with either single or double-dash,
  33 # and most of them change the style/color used. Some of the options are,
  34 # shown in their single-dash form:
  35 #
  36 #     -h          show this help message
  37 #     -help       show this help message
  38 #
  39 #     -b          use a blue color
  40 #     -blue       use a blue color
  41 #     -bold       bold-style digits
  42 #     -g          use a green color
  43 #     -gray       use a gray color (default)
  44 #     -green      use a green color
  45 #     -hi         use a highlighting/inverse style
  46 #     -highlight  use a highlighting/inverse style
  47 #     -hilite     use a highlighting/inverse style
  48 #     -inverse    use a highlighting/inverse style
  49 #     -m          use a magenta color
  50 #     -magenta    use a magenta color
  51 #     -o          use an orange color
  52 #     -orange     use an orange color
  53 #     -p          use a purple color
  54 #     -purple     use a purple color
  55 #     -r          use a red color
  56 #     -red        use a red color
  57 #     -u          underline digits
  58 #     -underline  underline digits
  59 
  60 
  61 case "$1" in
  62     -h|--h|-help|--help)
  63         awk '/^# +nn /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
  64         exit 0
  65     ;;
  66 esac
  67 
  68 name="${1:-gray}"
  69 [ $# -gt 0 ] && shift
  70 
  71 [ "$1" = "--" ] && shift
  72 
  73 command='awk'
  74 if [ -p 1 ] || [ -t 1 ]; then
  75     command='stdbuf -oL awk'
  76 fi
  77 
  78 # show all non-existing files given
  79 failed=0
  80 for arg in "$@"; do
  81     if [ "${arg}" = "-" ]; then
  82         continue
  83     fi
  84     if [ ! -e "${arg}" ]; then
  85         printf "no file named \"%s\"\n" "${arg}" > /dev/stderr
  86         failed=1
  87     fi
  88 done
  89 
  90 if [ "${failed}" -gt 0 ]; then
  91     exit 2
  92 fi
  93 
  94 # general case to handle actual styles
  95 ${command} -v name="${name}" '
  96     BEGIN {
  97         orig = name
  98         gsub(/^-{1,2}/, "", name)
  99 
 100         # alias-lookup table
 101         a["r"] = "red"
 102         a["g"] = "green"
 103         a["b"] = "blue"
 104         a["o"] = "orange"
 105         a["p"] = "purple"
 106         a["m"] = "magenta"
 107         a["h"] = "invert"
 108         a["i"] = "invert"
 109         a["u"] = "underline"
 110         a["or"] = "orange"
 111         a["ma"] = "magenta"
 112         a["hi"] = "invert"
 113         a["in"] = "invert"
 114         a["un"] = "underline"
 115         a["inv"] = "invert"
 116         a["mag"] = "magenta"
 117         a["grey"] = "gray"
 118         a["inverse"] = "invert"
 119         a["inverted"] = "invert"
 120         a["hilite"] = "invert"
 121         a["hilited"] = "invert"
 122         a["highlight"] = "invert"
 123         a["highlighted"] = "invert"
 124         a["underlined"] = "underline"
 125         a["bb"] = "blueback"
 126         a["gb"] = "greenback"
 127         a["mb"] = "magentaback"
 128         a["ob"] = "orangeback"
 129         a["pb"] = "purpleback"
 130         a["rb"] = "redback"
 131         a["bg"] = "greenback"
 132         a["bm"] = "magentaback"
 133         a["bo"] = "orangeback"
 134         a["bp"] = "purpleback"
 135         a["br"] = "redback"
 136         a["bluebg"] = "blueback"
 137         a["graybg"] = "grayback"
 138         a["greenbg"] = "greenback"
 139         a["greyback"] = "grayback"
 140         a["greybg"] = "grayback"
 141         a["magentabg"] = "magentaback"
 142         a["orangebg"] = "orangeback"
 143         a["purplebg"] = "purpleback"
 144         a["redbg"] = "redback"
 145         a["magback"] = "magentaback"
 146         a["magbg"] = "magentaback"
 147         a["orback"] = "orangeback"
 148         a["orbg"] = "orangeback"
 149         a["purback"] = "purpleback"
 150         a["purbg"] = "purpleback"
 151 
 152         # style-lookup table
 153         s["red"] = "\x1b[38;2;204;0;0m"
 154         s["green"] = "\x1b[38;2;0;135;95m"
 155         s["blue"] = "\x1b[38;2;0;95;215m"
 156         s["orange"] = "\x1b[38;2;215;95;0m"
 157         s["purple"] = "\x1b[38;2;135;95;255m"
 158         s["magenta"] = "\x1b[38;2;215;0;255m"
 159         s["gray"] = "\x1b[38;2;168;168;168m"
 160         s["bold"] = "\x1b[1m"
 161         s["invert"] = "\x1b[7m"
 162         s["italic"] = "\x1b[3m"
 163         s["underline"] = "\x1b[4m"
 164         s["blueback"] = "\x1b[48;2;0;95;215m\x1b[38;2;238;238;238m"
 165         s["grayback"] = "\x1b[48;2;168;168;168m\x1b[38;2;238;238;238m"
 166         s["greenback"] = "\x1b[48;2;0;135;95m\x1b[38;2;238;238;238m"
 167         s["magentaback"] = "\x1b[48;2;215;0;255m\x1b[38;2;238;238;238m"
 168         s["orangeback"] = "\x1b[48;2;215;95;0m\x1b[38;2;238;238;238m"
 169         s["purpleback"] = "\x1b[48;2;135;95;255m\x1b[38;2;238;238;238m"
 170         s["redback"] = "\x1b[48;2;204;0;0m\x1b[38;2;238;238;238m"
 171 
 172         # resolve aliases
 173         if (a[name] != "") name = a[name]
 174 
 175         # handle unsupported style-names with an error
 176         if (s[name] == "") {
 177             fmt = "\x1b[31munsupported style/color name `%s`\x1b[0m\n"
 178             printf fmt, orig > "/dev/stderr"
 179             exit 1
 180         }
 181 
 182         # match ANSI-code to the name
 183         style = s[name]
 184     }
 185 
 186     # (re)style all long-enough digit-runs/numbers in lines
 187     {
 188         # ignore screen/buffer-switching ANSI-codes, to avoid corrupting them
 189         gsub(/\x1b\[([0-9]{4,}[A-Za-z])/, "")
 190 
 191         line = $0
 192 
 193         # restyle digit-runs which are longer than 3
 194         while (match(line, /[0-9]{4,}/)) {
 195             # give up on digit-runs which are unusually long, to mitigate the
 196             # quadratic time-complexity of slicing strings in a loop
 197             if (RLENGTH > 1000) {
 198                 printf "%s", substr(line, 1, RSTART + RLENGTH)
 199                 line = substr(line, RSTART + RLENGTH)
 200                 continue
 201             }
 202 
 203             len = RLENGTH
 204             lead = len % 3
 205             alt = lead > 0
 206 
 207             printf "%s", substr(line, 1, RSTART + lead - 1)
 208             line = substr(line, RSTART + lead)
 209             len -= lead
 210 
 211             while (len > 0) {
 212                 if (alt == 1) {
 213                     printf "%s%s\x1b[0m", style, substr(line, 1, 3)
 214                 } else {
 215                     printf "%s", substr(line, 1, 3)
 216                 }
 217 
 218                 alt = 1 - alt
 219                 line = substr(line, 4)
 220                 len -= 3
 221             }
 222         }
 223 
 224         printf "%s\n", line
 225     }
 226 ' "$@"