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