2 package IkiWiki::Plugin::highlight;
4 # This has been tested with highlight 2.16 and highlight 3.2+svn19.
5 # In particular version 3.2 won't work. It detects the different
6 # versions by the presence of the the highlight::DataDir class.
16 hook(type => "getsetup", id => "highlight", call => \&getsetup);
17 hook(type => "checkconfig", id => "highlight", call => \&checkconfig);
18 # this hook is used by the format plugin
19 hook(type => "htmlizeformat", id => "highlight",
20 call => \&htmlizeformat, last => 1);
27 rebuild => 1, # format plugin
32 example => ".c .h .cpp .pl .py Makefile:make",
33 description => "types of source files to syntax highlight",
39 example => "/etc/highlight/filetypes.conf",
40 description => "location of highlight's filetypes.conf",
46 example => "/usr/share/highlight/langDefs",
47 description => "location of highlight's langDefs directory",
54 eval q{use highlight};
55 if (highlight::DataDir->can('new')) {
56 $data_dir=new highlight::DataDir();
57 $data_dir->searchDataDir("");
62 if (! exists $config{filetypes_conf}) {
64 $config{filetypes_conf}= "/etc/highlight/filetypes.conf";
65 } elsif ( $data_dir -> can('getFiletypesConfPath') ) {
67 $config{filetypes_conf}=
68 $data_dir -> getFiletypesConfPath("filetypes");
71 $config{filetypes_conf}=
72 $data_dir -> getConfDir() . "/filetypes.conf";
75 # note that this is only used for old versions of highlight
76 # where $data_dir will not be defined.
77 if (! exists $config{langdefdir}) {
78 $config{langdefdir}= "/usr/share/highlight/langDefs";
81 if (exists $config{tohighlight} && read_filetypes()) {
82 foreach my $file (split ' ', $config{tohighlight}) {
83 my @opts = $file=~s/^\.// ?
84 (keepextension => 1) :
86 my $ext = $file=~s/:(.*)// ? $1 : $file;
88 my $langfile=ext2langfile($ext);
89 if (! defined $langfile) {
90 error(sprintf(gettext(
91 "tohighlight contains unknown file type '%s'"),
100 highlight($langfile, $file, $params{content});
102 longname => sprintf(gettext("Source code: %s"), $file),
111 my $langfile=ext2langfile($format);
113 if (! defined $langfile) {
117 return Encode::decode_utf8(highlight($langfile, $format, shift));
121 my $filetypes_read=0;
124 # Parse highlight's config file to get extension => language mappings.
125 sub read_filetypes () {
127 if (!open($f, $config{filetypes_conf})) {
128 warn($config{filetypes_conf}.": ".$!);
136 # highlight >= 3.2 format (bind-style)
137 while ($config=~m/Lang\s*=\s*\"([^"]+)\"[,\s]+Extensions\s*=\s*{([^}]+)}/sg) {
139 foreach my $bit (split ',', $2) {
140 $bit=~s/.*"(.*)".*/$1/s;
141 $ext2lang{$bit}=$lang;
145 # highlight < 3.2 format
146 if (! keys %ext2lang) {
147 foreach (split("\n", $config)) {
148 if (/^\$ext\((.*)\)=(.*)$/) {
149 $ext2lang{$_}=$1 foreach $1, split ' ', $2;
154 return $filetypes_read=1;
162 return $data_dir->getLangPath($lang . ".lang");
164 return "$config{langdefdir}/$lang.lang";
168 # Given a filename extension, determines the language definition to
169 # use to highlight it.
170 sub ext2langfile ($) {
173 my $langfile=searchlangdef($ext);
174 return $langfile if exists $highlighters{$langfile};
176 read_filetypes() unless $filetypes_read;
177 if (exists $ext2lang{$ext}) {
178 return searchlangdef($ext2lang{$ext});
180 # If a language only has one common extension, it will not
181 # be listed in filetypes, so check the langfile.
182 elsif (-e $langfile) {
190 # Interface to the highlight C library.
196 eval q{use highlight};
198 print STDERR gettext("warning: highlight perl module not available; falling back to pass through");
203 if (! exists $highlighters{$langfile}) {
205 $gen = highlight::CodeGenerator::getInstance($highlight::XHTML);
207 $gen->setFragmentCode(1); # generate html fragment
208 $gen->setHTMLEnclosePreTag(1); # include stylish <pre>
210 # new style, requires a real theme, but has no effect
211 $gen->initTheme($data_dir->getThemePath("seashell.theme"));
213 # old style, anything works.
214 $gen->initTheme("/dev/null");
216 $gen->loadLanguage($langfile); # must come after initTheme
217 $gen->setEncoding("utf-8");
218 $highlighters{$langfile}=$gen;
221 $gen=$highlighters{$langfile};
224 return "<div class=\"highlight-$extorfile\">".$gen->generateString($input)."</div>";