Update highlight plugin for highlight api.

[ikiwiki.git] / IkiWiki / Plugin / highlight.pm

diff --git a/IkiWiki/Plugin/highlight.pm b/IkiWiki/Plugin/highlight.pm
index 4c02f6c236e4feca4f6113e73f793bee683fef2c..65e372db1336dbdedd6f1c5e256d4ef3b953aa2a 100644 (file)
--- a/IkiWiki/Plugin/highlight.pm
+++ b/IkiWiki/Plugin/highlight.pm
@@ -1,20 +1,23 @@
 #!/usr/bin/perl
 package IkiWiki::Plugin::highlight;
 
 #!/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 warnings;
 use strict;
 use IkiWiki 3.00;

+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
 
 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 => "htmlizefallback", id => "highlight", call =>
-               \&htmlizefallback);
+       hook(type => "htmlizeformat", id => "highlight", 
+               call => \&htmlizeformat, last => 1);

 }
 
 sub getsetup () {
 }
 
 sub getsetup () {


@@ -22,6 +25,7 @@ sub getsetup () {
                plugin => {
                        safe => 1,
                        rebuild => 1, # format plugin
                plugin => {
                        safe => 1,
                        rebuild => 1, # format plugin

+                       section => "format",

                },
                tohighlight => {
                        type => "string",
                },
                tohighlight => {
                        type => "string",


@@ -30,10 +34,48 @@ sub getsetup () {
                        safe => 1,
                        rebuild => 1,
                },
                        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 () {
 }
 
 sub checkconfig () {

-       if (exists $config{tohighlight}) {
+
+       eval q{use highlight};
+       if ($@) {
+               print STDERR "Failed to load highlight. Configuring anyway.\n";
+       };
+
+       if (highlight::DataDir->can('new')){
+               $data_dir=new highlight::DataDir();
+               $data_dir->searchDataDir("");
+       } else {
+               $data_dir=undef;
+       }
+
+       if (! exists $config{filetypes_conf}) {
+               $config{filetypes_conf}= 
+                    ($data_dir ? $data_dir->getConfDir() : "/etc/highlight/")
+                         . "filetypes.conf";
+       }
+       if (! exists $config{langdefdir}) {
+               $config{langdefdir}=
+                    ($data_dir ? $data_dir->getLangPath("")
+                     : "/usr/share/highlight/langDefs");
+
+       }
+       if (exists $config{tohighlight} && read_filetypes()) {

                foreach my $file (split ' ', $config{tohighlight}) {
                        my @opts = $file=~s/^\.// ?
                                (keepextension => 1) :
                foreach my $file (split ' ', $config{tohighlight}) {
                        my @opts = $file=~s/^\.// ?
                                (keepextension => 1) :


@@ -61,7 +103,7 @@ sub checkconfig () {
        }
 }
 
        }
 }
 

-sub htmlizefallback {
+sub htmlizeformat {

        my $format=lc shift;
        my $langfile=ext2langfile($format);
 
        my $format=lc shift;
        my $langfile=ext2langfile($format);
 


@@ -69,7 +111,7 @@ sub htmlizefallback {
                return;
        }
 
                return;
        }
 

-       return highlight($langfile, shift);
+       return Encode::decode_utf8(highlight($langfile, shift));

 }
 
 my %ext2lang;
 }
 
 my %ext2lang;


@@ -78,15 +120,35 @@ my %highlighters;
 
 # Parse highlight's config file to get extension => language mappings.
 sub read_filetypes () {
 
 # 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;

                }
        }
                }
        }

-       close IN;
-       $filetypes_read=1;
+
+       # highlight < 3.2 format
+       if (! keys %ext2lang) {
+               foreach (split("\n", $config)) {
+                       if (/^\$ext\((.*)\)=(.*)$/) {
+                               $ext2lang{$_}=$1 foreach $1, split ' ', $2;
+                       }
+               }
+       }
+
+       return $filetypes_read=1;

 }
 
 
 }
 
 


@@ -95,12 +157,12 @@ sub read_filetypes () {
 sub ext2langfile ($) {
        my $ext=shift;
 
 sub ext2langfile ($) {
        my $ext=shift;
 

-       my $langfile="$langdefdir/$ext.lang";
+       my $langfile="$config{langdefdir}/$ext.lang";

        return $langfile if exists $highlighters{$langfile};
 
        read_filetypes() unless $filetypes_read;
        if (exists $ext2lang{$ext}) {
        return $langfile if exists $highlighters{$langfile};
 
        read_filetypes() unless $filetypes_read;
        if (exists $ext2lang{$ext}) {

-               return "$langdefdir/$ext2lang{$ext}.lang";
+               return "$config{langdefdir}/$ext2lang{$ext}.lang";

        }
        # If a language only has one common extension, it will not
        # be listed in filetypes, so check the langfile.
        }
        # If a language only has one common extension, it will not
        # be listed in filetypes, so check the langfile.


@@ -125,11 +187,17 @@ sub highlight ($$) {
 
        my $gen;
        if (! exists $highlighters{$langfile}) {
 
        my $gen;
        if (! exists $highlighters{$langfile}) {

-               $gen = highlightc::CodeGenerator_getInstance($highlightc::XHTML);
+               $gen = highlight::CodeGenerator::getInstance($highlight::XHTML);

                $gen->setFragmentCode(1); # generate html fragment
                $gen->setHTMLEnclosePreTag(1); # include stylish <pre>
                $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
+               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;
        }
                $gen->setEncoding("utf-8");
                $highlighters{$langfile}=$gen;
        }