gitweb.ps.run Git - ps-cgit/blob - filters/syntax-highlighting.sh

   1 #!/bin/sh
   2 # This script can be used to implement syntax highlighting in the cgit
   3 # tree-view by refering to this file with the source-filter or repo.source-
   4 # filter options in cgitrc.
   5 #
   6 # This script requires a shell supporting the ${var##pattern} syntax.
   7 # It is supported by at least dash and bash, however busybox environments
   8 # might have to use an external call to sed instead.
   9 #
  10 # Note: the highlight command (http://www.andre-simon.de/) uses css for syntax
  11 # highlighting, so you'll probably want something like the following included
  12 # in your css file (generated by highlight 2.4.8 and adapted for cgit):
  13 #
  14 # table.blob .num  { color:#2928ff; }
  15 # table.blob .esc  { color:#ff00ff; }
  16 # table.blob .str  { color:#ff0000; }
  17 # table.blob .dstr { color:#818100; }
  18 # table.blob .slc  { color:#838183; font-style:italic; }
  19 # table.blob .com  { color:#838183; font-style:italic; }
  20 # table.blob .dir  { color:#008200; }
  21 # table.blob .sym  { color:#000000; }
  22 # table.blob .kwa  { color:#000000; font-weight:bold; }
  23 # table.blob .kwb  { color:#830000; }
  24 # table.blob .kwc  { color:#000000; font-weight:bold; }
  25 # table.blob .kwd  { color:#010181; }
  26
  27 # store filename and extension in local vars
  28 BASENAME="$1"
  29 EXTENSION="${BASENAME##*.}"
  30
  31 # map Makefile and Makefile.* to .mk
  32 [ "${BASENAME%%.*}" == "Makefile" ] && EXTENSION=mk
  33
  34 # highlight versions 2 and 3 have different commandline options. Specifically,
  35 # the -X option that is used for version 2 is replaced by the -O xhtml option
  36 # for version 3.
  37 #
  38 # Version 2 can be found (for example) on EPEL 5, while version 3 can be
  39 # found (for example) on EPEL 6.
  40 #
  41 # This is for version 2
  42 exec highlight --force -f -I -X -S $EXTENSION 2>/dev/null
  43
  44 # This is for version 3
  45 #
  46 # On CentOS 6.2 (using highlight from EPEL), when highlight doesn't know about
  47 # an EXTENSION, it outputs a lua error and _no_ text, even when the --force
  48 # option is used.
  49 #
  50 # Also see the bug reports at:
  51 # http://sourceforge.net/tracker/?func=detail&aid=3490017&group_id=215618&atid=1034391
  52 # https://bugzilla.redhat.com/show_bug.cgi?id=795567
  53 #
  54 # This workaround can be removed when the bug is fixed upstream and the new
  55 # version is packaged in most distributions.
  56 #
  57 # The workaround is to set the extension to 'txt' (plain text) when highlight
  58 # exits with an error (doesn't know the format).
  59 #
  60 #echo "test" | highlight -f -I -O xhtml -S $EXTENSION &>/dev/null
  61 #[ ${?} -ne 0 ] && EXTENSION="txt"
  62 #exec highlight --force -f -I -O xhtml -S $EXTENSION 2>/dev/null