here be a plugin for processing POD!

[git.ikiwiki.info.git] / IkiWiki / Plugin / table.pm

diff --git a/IkiWiki/Plugin/table.pm b/IkiWiki/Plugin/table.pm
index 01ba5e5042360d218d422e56296a6161552ff8fe..96d63f455f886e9111f0e7bd26558b020c1de61b 100644 (file)
--- a/IkiWiki/Plugin/table.pm
+++ b/IkiWiki/Plugin/table.pm
@@ -4,28 +4,52 @@ package IkiWiki::Plugin::table;
 use warnings;
 use strict;
 use Encode;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
-sub import { #{{{
-       hook(type => "preprocess", id => "table", call => \&preprocess);
-} # }}}
+sub import {
+       hook(type => "getsetup", id => "table", call => \&getsetup);
+       hook(type => "preprocess", id => "table", call => \&preprocess, scan => 1);
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+}
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        my %params =(
                format  => 'auto',
-               header  => 'yes',
+               header  => 'row',
                @_
        );
 
        if (exists $params{file}) {
-               if (! $pagesources{$params{file}}) {
-                       return "[[table ".gettext("cannot find file")."]]";
+               if (! exists $pagesources{$params{file}}) {
+                       error gettext("cannot find file");
                }
                $params{data} = readfile(srcfile($params{file}));
+               add_depends($params{page}, $params{file});
        }
-       else {
-               $params{data} = IkiWiki::linkify($params{page},
-                       $params{destpage}, $params{data});
+
+       if (! defined wantarray) {
+               # scan mode --  if the table uses an external file, need to
+               # scan that file too.
+               return unless exists $params{file};
+
+               IkiWiki::run_hooks(scan => sub {
+                       shift->(
+                               page => $params{page},
+                               content => $params{data},
+                       );
+               });
+
+               # Preprocess in scan-only mode.
+               IkiWiki::preprocess($params{page}, $params{page}, $params{data}, 1);
+
+               return;
        }
 
        if (lc $params{format} eq 'auto') {
@@ -40,21 +64,35 @@ sub preprocess (@) { #{{{
 
        my @data;
        if (lc $params{format} eq 'csv') {
-               @data=split_csv($params{data}, $params{delimiter});
+               @data=split_csv($params{data},
+                       defined $params{delimiter} ? $params{delimiter} : ",",);
+               # linkify after parsing since html link quoting can
+               # confuse CSV parsing
+               @data=map {
+                       [ map {
+                               IkiWiki::linkify($params{page},
+                                       $params{destpage}, $_);
+                       } @$_ ]
+               } @data;
        }
        elsif (lc $params{format} eq 'dsv') {
-               @data=split_dsv($params{data}, $params{delimiter});
+               # linkify before parsing since wikilinks can contain the
+               # delimiter
+               $params{data} = IkiWiki::linkify($params{page},
+                       $params{destpage}, $params{data});
+               @data=split_dsv($params{data},
+                       defined $params{delimiter} ? $params{delimiter} : "|",);
        }
        else {
-               return "[[table ".gettext("unknown data format")."]]";
+               error gettext("unknown data format");
        }
 
        my $header;
-       if (lc($params{header}) eq "yes") {
+       if (lc($params{header}) eq "row" || IkiWiki::yesno($params{header})) {
                $header=shift @data;
        }
        if (! @data) {
-               return "[[table ".gettext("empty data")."]]";
+               error gettext("empty data");
        }
 
        my @lines;
@@ -62,11 +100,10 @@ sub preprocess (@) { #{{{
                        ? "<table class=\"".$params{class}.'">'
                        : '<table>';
        push @lines, "\t<thead>",
-               genrow($params{page}, $params{destpage}, "th", @$header),
+               genrow(\%params, "th", @$header),
                "\t</thead>" if defined $header;
-       push @lines, "\t<tbody>";
-       push @lines, genrow($params{page}, $params{destpage}, "td", @$_)
-               foreach @data;
+       push @lines, "\t<tbody>" if defined $header;
+       push @lines, genrow(\%params, "td", @$_) foreach @data;
        push @lines, "\t</tbody>" if defined $header;
        push @lines, '</table>';
        my $html = join("\n", @lines);
@@ -79,23 +116,23 @@ sub preprocess (@) { #{{{
        else {  
                return $html;
        }            
-} #}}}
+}
 
-sub is_dsv_data ($) { #{{{
+sub is_dsv_data ($) {
        my $text = shift;
 
        my ($line) = split(/\n/, $text);
        return $line =~ m{.+\|};
 }
 
-sub split_csv ($$) { #{{{
+sub split_csv ($$) {
        my @text_lines = split(/\n/, shift);
        my $delimiter = shift;
 
        eval q{use Text::CSV};
        error($@) if $@;
        my $csv = Text::CSV->new({ 
-               sep_char        => defined $delimiter ? $delimiter : ",",
+               sep_char        => $delimiter,
                binary          => 1,
                allow_loose_quotes => 1,
        }) || error("could not create a Text::CSV object");
@@ -114,9 +151,9 @@ sub split_csv ($$) { #{{{
        }
 
        return @data;
-} #}}}
+}
 
-sub split_dsv ($$) { #{{{
+sub split_dsv ($$) {
        my @text_lines = split(/\n/, shift);
        my $delimiter = shift;
        $delimiter="|" unless defined $delimiter;
@@ -127,49 +164,46 @@ sub split_dsv ($$) { #{{{
        }
     
        return @data;
-} #}}}
+}
 
-sub genrow ($$$@) { #{{{
-       my $page = shift;
-       my $destpage = shift;
+sub genrow ($@) {
+       my %params=%{shift()};
        my $elt = shift;
        my @data = @_;
 
+       my $page=$params{page};
+       my $destpage=$params{destpage};
+       my $type=pagetype($pagesources{$page});
+
        my @ret;
        push @ret, "\t\t<tr>";
        for (my $x=0; $x < @data; $x++) {
-               my $cell=htmlize($page, $destpage, $data[$x]);
+               my $cell=IkiWiki::htmlize($page, $destpage, $type,
+                        IkiWiki::preprocess($page, $destpage, $data[$x]));
+
+               # automatic colspan for empty cells
                my $colspan=1;
                while ($x+1 < @data && $data[$x+1] eq '') {
                        $x++;
                        $colspan++;
                }
+
+               # check if the first column should be a header
+               my $e=$elt;
+               if ($x == 0 && lc($params{header}) eq "column") {
+                       $e="th";
+               }
+
                if ($colspan > 1) {
-                       push @ret, "\t\t\t<$elt colspan=\"$colspan\">$cell</$elt>"
+                       push @ret, "\t\t\t<$e colspan=\"$colspan\">$cell</$e>"
                }
                else {
-                       push @ret, "\t\t\t<$elt>$cell</$elt>"
+                       push @ret, "\t\t\t<$e>$cell</$e>"
                }
        }
        push @ret, "\t\t</tr>";
 
        return @ret;
-} #}}}
-
-sub htmlize ($$$) { #{{{
-       my $page = shift;
-       my $destpage = shift;
-       my $text = shift;
-
-       $text=IkiWiki::htmlize($page, pagetype($pagesources{$page}),
-               IkiWiki::preprocess($page, $destpage, $text));
-
-       # hack to get rid of enclosing junk added by markdown
-       $text=~s!^<p>!!;
-       $text=~s!</p>$!!;
-       chomp $text;
-
-       return $text;
 }
 
 1