File: leak.sh
   1 #!/bin/sh
   2 
   3 # The MIT License (MIT)
   4 #
   5 # Copyright © 2024 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 # leak [style-name...]
  27 #
  28 # Emit copies of stdin lines both to stdout and to stderr, thus `leaking`
  29 # the contents going through a pipe of commands, using the leading argument
  30 # as the style/color name to use to decorate the stderr output.
  31 #
  32 # If no style name is given, a default one is chosen.
  33 #
  34 # As its name suggests, its main use is to inspect/debug the intermediate
  35 # stages of a `pipelined` shell command.
  36 #
  37 # Supported style names include
  38 #
  39 # - red     - orange    - bold     - underline
  40 # - green   - magenta   - purple   - invert
  41 # - blue    - gray      - italic
  42 #
  43 # Supported aliases for style names include
  44 #
  45 #   b    (blue)
  46 #   g    (green)
  47 #   h    (hilight/invert)
  48 #   m    (magenta)
  49 #   o    (orange)
  50 #   p    (purple)
  51 #   r    (red)
  52 #   u    (underline)
  53 
  54 
  55 # handle help options
  56 case "$1" in
  57     -h|--h|-help|--help)
  58         awk '/^# +leak/, /^$/ { gsub(/^# ?/, ""); print }' "$0"
  59         exit 0
  60     ;;
  61 esac
  62 
  63 name="$(echo "${1:-gray}" | sed 's/^--?//')"
  64 [ $# -gt 0 ] && shift
  65 
  66 # handle special style-names
  67 case "${name}" in
  68     plain)
  69         # the general case can't handle simply removing all styles
  70         awk '{
  71             gsub(/\x1b\[[0-9;]*[A-Za-z]/, "")
  72             print
  73             fflush()
  74             print > "/dev/stderr"
  75         }'
  76         exit $?
  77     ;;
  78 
  79     keep)
  80         # the general case handles empty style-strings as errors
  81         awk '{
  82             printf "%s\x1b[0m\n", $0
  83             fflush()
  84             printf "%s\x1b[0m\n", $0 > "/dev/stderr"
  85         }'
  86         exit $?
  87     ;;
  88 esac
  89 
  90 # general case to handle actual styles
  91 awk -v name="${name}" '
  92 BEGIN {
  93     # pick a default style, when no style is given
  94     if (name == "") name = "gray"
  95     orig = name
  96     gsub(/^-{1,2}/, "", name)
  97 
  98     # alias-lookup table
  99     a["r"] = "red"
 100     a["g"] = "green"
 101     a["b"] = "blue"
 102     a["o"] = "orange"
 103     a["p"] = "purple"
 104     a["m"] = "magenta"
 105     a["h"] = "invert"
 106     a["i"] = "invert"
 107     a["u"] = "underline"
 108     a["or"] = "orange"
 109     a["ma"] = "magenta"
 110     a["hi"] = "invert"
 111     a["in"] = "invert"
 112     a["un"] = "underline"
 113     a["inv"] = "invert"
 114     a["mag"] = "magenta"
 115     a["grey"] = "gray"
 116     a["inverse"] = "invert"
 117     a["inverted"] = "invert"
 118     a["hilite"] = "invert"
 119     a["hilited"] = "invert"
 120     a["highlight"] = "invert"
 121     a["highlighted"] = "invert"
 122     a["underlined"] = "underline"
 123     a["bb"] = "blueback"
 124     a["gb"] = "greenback"
 125     a["mb"] = "magentaback"
 126     a["ob"] = "orangeback"
 127     a["pb"] = "purpleback"
 128     a["br"] = "redback"
 129     a["bg"] = "greenback"
 130     a["bm"] = "magentaback"
 131     a["bo"] = "orangeback"
 132     a["bp"] = "purpleback"
 133     a["br"] = "redback"
 134     a["bluebg"] = "blueback"
 135     a["graybg"] = "grayback"
 136     a["greenbg"] = "greenback"
 137     a["greyback"] = "grayback"
 138     a["greybg"] = "grayback"
 139     a["magentabg"] = "magentaback"
 140     a["orangebg"] = "orangeback"
 141     a["purplebg"] = "purpleback"
 142     a["redbg"] = "redback"
 143     a["magback"] = "magentaback"
 144     a["magbg"] = "magentaback"
 145     a["orback"] = "orangeback"
 146     a["orbg"] = "orangeback"
 147     a["purback"] = "purpleback"
 148     a["purbg"] = "purpleback"
 149 
 150     # style-lookup table
 151     s["red"] = "\x1b[38;2;204;0;0m"
 152     s["green"] = "\x1b[38;2;0;135;95m"
 153     s["blue"] = "\x1b[38;2;0;95;215m"
 154     s["orange"] = "\x1b[38;2;215;95;0m"
 155     s["purple"] = "\x1b[38;2;135;95;255m"
 156     s["magenta"] = "\x1b[38;2;215;0;255m"
 157     s["gray"] = "\x1b[38;2;168;168;168m"
 158     s["bold"] = "\x1b[1m"
 159     s["invert"] = "\x1b[7m"
 160     s["italic"] = "\x1b[3m"
 161     s["underline"] = "\x1b[4m"
 162     s["blueback"] = "\x1b[48;2;0;95;215m\x1b[38;2;238;238;238m"
 163     s["grayback"] = "\x1b[48;2;168;168;168m\x1b[38;2;238;238;238m"
 164     s["greenback"] = "\x1b[48;2;0;135;95m\x1b[38;2;238;238;238m"
 165     s["magentaback"] = "\x1b[48;2;215;0;255m\x1b[38;2;238;238;238m"
 166     s["orangeback"] = "\x1b[48;2;215;95;0m\x1b[38;2;238;238;238m"
 167     s["purpleback"] = "\x1b[48;2;135;95;255m\x1b[38;2;238;238;238m"
 168     s["redback"] = "\x1b[48;2;204;0;0m\x1b[38;2;238;238;238m"
 169 
 170     # resolve aliases
 171     if (a[name] != "") name = a[name]
 172 
 173     # handle unsupported style-names with an error
 174     if (s[name] == "") {
 175         fmt = "\x1b[31munsupported style/color name `%s`\x1b[0m\n"
 176         printf fmt, orig > "/dev/stderr"
 177         exit 1
 178     }
 179 
 180     # match ANSI-code to the name
 181     style = s[name]
 182 }
 183 
 184 # leak (re)styled lines to stderr
 185 {
 186     print
 187     fflush()
 188 
 189     gsub(/\x1b\[[0-9;]*[A-Za-z]/, "")
 190     printf "%s%s\x1b[0m\n", style, $0 > "/dev/stderr"
 191 }
 192 ' "$@"