File: coma.py
   1 #!/usr/bin/python3
   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 # coma [options...] [regex/style pairs...]
  27 #
  28 # COlor MAtches colors/styles regex matches everywhere they're found,
  29 # using the named-style associated to the regex in its argument-pair.
  30 #
  31 # Lines not matching any regex stay verbatim.
  32 #
  33 # The colors/styles available are:
  34 #     blue
  35 #     bold
  36 #     gray
  37 #     green
  38 #     inverse
  39 #     magenta
  40 #     orange
  41 #     red
  42 #     underline
  43 #
  44 # Some style aliases are:
  45 #     b       blue
  46 #     g       green
  47 #     m       magenta
  48 #     o       orange
  49 #     r       red
  50 #     u       underline
  51 #     hi      inverse (highlight)
  52 
  53 
  54 from io import StringIO
  55 from re import compile, Pattern
  56 from sys import argv, exit, stderr, stdin, stdout
  57 from typing import List, Tuple
  58 
  59 
  60 # info is the message shown when the script isn't given any argument, or
  61 # when the leading argument is one of the standard cmd-line help options
  62 info = '''
  63 coma [options...] [regex/style pairs...]
  64 
  65 COlor MAtches colors/styles regex matches everywhere they're found,
  66 using the named-style associated to the regex in its argument-pair.
  67 
  68 Lines not matching any regex stay verbatim.
  69 
  70 The colors/styles available are:
  71     blue
  72     bold
  73     gray
  74     green
  75     inverse
  76     magenta
  77     orange
  78     red
  79     underline
  80 
  81 Some style aliases are:
  82     b       blue
  83     g       green
  84     m       magenta
  85     o       orange
  86     r       red
  87     u       underline
  88     hi      inverse (highlight)
  89 '''.strip()
  90 
  91 # a leading help-option arg means show the help message and quit
  92 if len(argv) == 2 and argv[1].lower() in ('-h', '--h', '-help', '--help'):
  93     print(info, file=stderr)
  94     exit(0)
  95 
  96 
  97 def fail(msg, code: int = 1) -> None:
  98     '''Show the error message given, and quit the app right away.'''
  99     print(f'\x1b[31m{msg}\x1b[0m', file=stderr)
 100     exit(code)
 101 
 102 
 103 def style_line(sb: StringIO, pairs: List[Tuple[Patternstr]]) -> None:
 104     '''Does what it says, replacing content of the StringIO given to it.'''
 105 
 106     for (expr, style) in pairs:
 107         src = sb.getvalue()
 108         sb.truncate(0)
 109         sb.seek(0)
 110 
 111         # j keeps track of end of detected file-extensions, and is used
 112         # outside the regex-match loop to detect trailing parts in lines
 113         j = 0
 114 
 115         # matches is to keep track of whether any matches occurred
 116         matches = 0
 117 
 118         # replace all regex-matches on the line by surrounding each
 119         # matched substring with ANSI styles/resets
 120         for m in expr.finditer(src):
 121             matches += 1
 122             # remember previous index-end, used to emit the part before
 123             # the current match
 124             start = j
 125 
 126             i = m.start()
 127             j = m.end()
 128 
 129             # remember part before match
 130             write_slice(sb, src, start, i)
 131             # style current match
 132             sb.write(style)
 133             # copy match as is
 134             write_slice(sb, src, i, j)
 135             # reset style
 136             sb.write('\x1b[0m')
 137 
 138         if matches == 0:
 139             # avoid emptying lines with no matches
 140             sb.write(src)
 141             return
 142 
 143         # no need to copy the line when it's not changing anyway
 144         if j > 0:
 145             # don't forget the last part of the line, or the whole line
 146             sb.write(src[j:])
 147 
 148 
 149 def write_slice(sb: StringIO, s: str, start: int, end: int) -> None:
 150     # '''Emit slice-like substrings without allocating slices.'''
 151     # for i in range(start, end):
 152     #     sb.write(s[i])
 153     sb.write(s[start:end])
 154 
 155 
 156 # names_aliases normalizes lookup keys for table names2styles
 157 names_aliases = {
 158     'b': 'blue',
 159     'g': 'green',
 160     'm': 'magenta',
 161     'o': 'orange',
 162     'r': 'red',
 163     'u': 'underline',
 164 
 165     'hi': 'inverse',
 166     'inv': 'inverse',
 167     'mag': 'magenta',
 168 
 169     'flip': 'inverse',
 170     'swap': 'inverse',
 171 
 172     'reset': 'plain',
 173     'highlight': 'inverse',
 174     'hilite': 'inverse',
 175     'invert': 'inverse',
 176     'inverted': 'inverse',
 177     'swapped': 'inverse',
 178 }
 179 
 180 # names2styles matches color/style names to their ANSI-style strings
 181 names2styles = {
 182     'blue': '\x1b[38;5;26m',
 183     'bold': '\x1b[1m',
 184     'gray': '\x1b[38;5;249m',
 185     'green': '\x1b[38;5;29m',
 186     'inverse': '\x1b[7m',
 187     'magenta': '\x1b[38;5;99m',
 188     'orange': '\x1b[38;5;166m',
 189     'plain': '\x1b[0m',
 190     'red': '\x1b[31m',
 191     'underline': '\x1b[4m',
 192 }
 193 
 194 
 195 def restyle_lines(src) -> None:
 196     sb = StringIO()
 197     for line in src:
 198         # ignore trailing carriage-returns and line-feeds in lines
 199         end = len(line)
 200         if end > 1 and line[end - 2] == '\r' and line[end - 1] == '\n':
 201             end -= 2
 202         elif end > 0 and line[end - 1] == '\n':
 203             end -= 1
 204 
 205         sb.truncate(0)
 206         sb.seek(0)
 207         write_slice(sb, line, 0, end)
 208         style_line(sb, pairs)
 209         stdout.write(sb.getvalue())
 210         stdout.write('\n')
 211     sb.close()
 212 
 213 
 214 # no args or a leading help-option arg means show the help message and quit
 215 if len(argv) == 1 or argv[1] in ('-h', '--h', '-help', '--help'):
 216     print(info, file=stderr)
 217     exit(0)
 218 
 219 # ensure an even number of args, after any leading options
 220 if len(argv) % 2 != 1:
 221     pre = 'expected an even number of args as regex/style pairs'
 222     fail(f'{pre}, but got {len(argv) - 1} instead')
 223 
 224 # make regex/ANSI-style pairs which are directly usable
 225 pairs: List[Tuple[Patternstr]] = []
 226 start_args = 1
 227 while start_args + 1 < len(argv):
 228     # compile regex
 229     try:
 230         expr = compile(argv[start_args + 0])
 231     except Exception as e:
 232         fail(e)
 233 
 234     # lookup style name
 235     name = argv[start_args + 1]
 236     if name in names_aliases:
 237         name = names_aliases[name]
 238     if not name in names2styles:
 239         fail(f'style named {name} not supported')
 240 
 241     # remember both for later
 242     pairs.append((expr, names2styles[name]))
 243     # previous check ensures args has an even number of items
 244     start_args += 2
 245 
 246 try:
 247     stdout.reconfigure(newline='\n', encoding='utf-8')
 248     restyle_lines(stdin)
 249 except BrokenPipeError:
 250     # quit quietly, instead of showing a confusing error message
 251     stderr.flush()
 252     stderr.close()
 253 except KeyboardInterrupt:
 254     # quit quietly, instead of showing a confusing error message
 255     stderr.flush()
 256     stderr.close()
 257     exit(2)
 258 except Exception as e:
 259     fail(e, 1)