#!/usr/bin/perl
package IkiWiki::Plugin::highlight;
+# This has been tested with highlight 2.16 and highlight 3.2+svn19.
+# In particular version 3.2 won't work. It detects the different
+# versions by the presence of the the highlight::DataDir class.
+
use warnings;
use strict;
use IkiWiki 3.00;
-use highlight;
+use Encode;
-# locations of highlight's files
-my $filetypes="/etc/highlight/filetypes.conf";
-my $langdefdir="/usr/share/highlight/langDefs";
+my $data_dir;
sub import {
hook(type => "getsetup", id => "highlight", call => \&getsetup);
hook(type => "checkconfig", id => "highlight", call => \&checkconfig);
+ # this hook is used by the format plugin
+ hook(type => "htmlizeformat", id => "highlight",
+ call => \&htmlizeformat, last => 1);
}
sub getsetup () {
plugin => {
safe => 1,
rebuild => 1, # format plugin
+ section => "format",
},
tohighlight => {
type => "string",
- example => ".c, .h, .cpp, .pl, .py, Makefile:make",
- description => "source files to syntax highlight",
+ example => ".c .h .cpp .pl .py Makefile:make",
+ description => "types of source files to syntax highlight",
safe => 1,
rebuild => 1,
},
+ filetypes_conf => {
+ type => "string",
+ example => "/etc/highlight/filetypes.conf",
+ description => "location of highlight's filetypes.conf",
+ safe => 0,
+ rebuild => undef,
+ },
+ langdefdir => {
+ type => "string",
+ example => "/usr/share/highlight/langDefs",
+ description => "location of highlight's langDefs directory",
+ safe => 0,
+ rebuild => undef,
+ },
}
sub checkconfig () {
- if (exists $config{tohighlight}) {
- foreach my $file (split /, /, $config{tohighlight}) {
+ eval q{use highlight};
+ if (highlight::DataDir->can('new')) {
+ $data_dir=new highlight::DataDir();
+ $data_dir->searchDataDir("");
+ } else {
+ $data_dir=undef;
+ }
+
+ if (! exists $config{filetypes_conf}) {
+ if (! $data_dir ) {
+ $config{filetypes_conf}= "/etc/highlight/filetypes.conf";
+ } elsif ( $data_dir -> can('searchFile') ) {
+ # 3.18 +
+ $config{filetypes_conf}=
+ $data_dir -> searchFile("filetypes.conf");
+ } else {
+ # 3.9 +
+ $config{filetypes_conf}=
+ $data_dir -> getConfDir() . "/filetypes.conf";
+ }
+ }
+ # note that this is only used for old versions of highlight
+ # where $data_dir will not be defined.
+ if (! exists $config{langdefdir}) {
+ $config{langdefdir}= "/usr/share/highlight/langDefs";
+
+ }
+ if (exists $config{tohighlight} && read_filetypes()) {
+ foreach my $file (split ' ', $config{tohighlight}) {
my @opts = $file=~s/^\.// ?
(keepextension => 1) :
(noextension => 1);
id => $file,
call => sub {
my %params=@_;
- highlight($langfile, $params{content});
+ highlight($langfile, $file, $params{content});
},
longname => sprintf(gettext("Source code: %s"), $file),
@opts,
}
}
+sub htmlizeformat {
+ my $format=lc shift;
+ my $langfile=ext2langfile($format);
+
+ if (! defined $langfile) {
+ return;
+ }
+
+ return Encode::decode_utf8(highlight($langfile, $format, shift));
+}
+
my %ext2lang;
my $filetypes_read=0;
+my %highlighters;
# Parse highlight's config file to get extension => language mappings.
sub read_filetypes () {
- open (IN, $filetypes);
- while (<IN>) {
- chomp;
- if (/^\$ext\((.*)\)=(.*)$/) {
- $ext2lang{$_}=$1 foreach $1, split ' ', $2;
+ my $f;
+ if (!open($f, $config{filetypes_conf})) {
+ warn($config{filetypes_conf}.": ".$!);
+ return 0;
+ };
+
+ local $/=undef;
+ my $config=<$f>;
+ close $f;
+
+ # highlight >= 3.2 format (bind-style)
+ while ($config=~m/Lang\s*=\s*\"([^"]+)\"[,\s]+Extensions\s*=\s*{([^}]+)}/sg) {
+ my $lang=$1;
+ foreach my $bit (split ',', $2) {
+ $bit=~s/.*"(.*)".*/$1/s;
+ $ext2lang{$bit}=$lang;
+ }
+ }
+
+ # highlight < 3.2 format
+ if (! keys %ext2lang) {
+ foreach (split("\n", $config)) {
+ if (/^\$ext\((.*)\)=(.*)$/) {
+ $ext2lang{$_}=$1 foreach $1, split ' ', $2;
+ }
}
}
- close IN;
- $filetypes_read=1;
-}
-sub langfile ($) {
- return "$langdefdir/$_[0].lang";
+ return $filetypes_read=1;
}
+
+sub searchlangdef {
+ my $lang=shift;
+
+ if ($data_dir) {
+ return $data_dir->getLangPath($lang . ".lang");
+ } else {
+ return "$config{langdefdir}/$lang.lang";
+ }
+
+}
# Given a filename extension, determines the language definition to
# use to highlight it.
sub ext2langfile ($) {
my $ext=shift;
+ my $langfile=searchlangdef($ext);
+ return $langfile if exists $highlighters{$langfile};
+
read_filetypes() unless $filetypes_read;
if (exists $ext2lang{$ext}) {
- return langfile($ext2lang{$ext});
+ return searchlangdef($ext2lang{$ext});
}
# If a language only has one common extension, it will not
# be listed in filetypes, so check the langfile.
- elsif (-e langfile($ext)) {
- return langfile($ext);
+ elsif (-e $langfile) {
+ return $langfile;
}
else {
return undef;
# Interface to the highlight C library.
sub highlight ($$) {
my $langfile=shift;
+ my $extorfile=shift;
my $input=shift;
- my $gen = highlightc::CodeGenerator_getInstance($highlightc::XHTML);
- $gen->setFragmentCode(1); # generate html fragment
- $gen->setHTMLEnclosePreTag(1); # include stylish <pre>
- $gen->initLanguage($langfile);
- $gen->initTheme("/dev/null"); # theme is not needed because CSS is not emitted
- $gen->setEncoding("utf-8");
+ eval q{use highlight};
+ if ($@) {
+ print STDERR gettext("warning: highlight perl module not available; falling back to pass through");
+ return $input;
+ }
+
+ my $gen;
+ if (! exists $highlighters{$langfile}) {
+ no warnings 'once';
+ $gen = highlight::CodeGenerator::getInstance($highlight::XHTML);
+ use warnings;
+ $gen->setFragmentCode(1); # generate html fragment
+ $gen->setHTMLEnclosePreTag(1); # include stylish <pre>
+ if ($data_dir){
+ # new style, requires a real theme, but has no effect
+ $gen->initTheme($data_dir->getThemePath("seashell.theme"));
+ } else {
+ # old style, anything works.
+ $gen->initTheme("/dev/null");
+ }
+ $gen->loadLanguage($langfile); # must come after initTheme
+ $gen->setEncoding("utf-8");
+ $highlighters{$langfile}=$gen;
+ }
+ else {
+ $gen=$highlighters{$langfile};
+ }
- my $output=$gen->generateString($input);
- highlightc::CodeGenerator_deleteInstance($gen);
- return $output;
+ return "<div class=\"highlight-$extorfile\">".$gen->generateString($input)."</div>";
}
1