summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/todo/syntax_highlighting.mdwn5
-rw-r--r--doc/todo/tracking_bugs_with_dependencies.mdwn282
2 files changed, 185 insertions, 102 deletions
diff --git a/doc/todo/syntax_highlighting.mdwn b/doc/todo/syntax_highlighting.mdwn
index 2bbaeedfa..81ba19bc8 100644
--- a/doc/todo/syntax_highlighting.mdwn
+++ b/doc/todo/syntax_highlighting.mdwn
@@ -51,6 +51,11 @@ releases the 5 or 6 language definitions he has running on his web site, it migh
5 seconds, which isn't bad. And, it has a C++ library, which it
seems likely perl bindings could be written for, to eliminate
even that overhead.
+ > [highlight](http://www.andre-simon.de) has similar features to source-highlight, and swig bindings
+ > that should make it trivial in principle to call from perl. I like highlight a bit better because
+ > it has a pass-through feature that I find very useful. My memory is unfortunately a bit fuzzy as to how
+ > well the swig bindings work. [[DavidBremner]]
+
* Engines that already support a wide variety of file types are of
course preferred. If the engine doesn't support a particular type
diff --git a/doc/todo/tracking_bugs_with_dependencies.mdwn b/doc/todo/tracking_bugs_with_dependencies.mdwn
index 417d5910e..6e55e46af 100644
--- a/doc/todo/tracking_bugs_with_dependencies.mdwn
+++ b/doc/todo/tracking_bugs_with_dependencies.mdwn
@@ -252,6 +252,11 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
>>> is to not generate perl code, but just directly run perl code that
>>> populates specFuncs.
+>>>> I don't think this is as bad as you make out, but your addition of the
+>>>> data array will break with the recursion my patch adds in pagespec_makeperl.
+>>>> To fix that I'll need to pass a reference to that array into pagespec_makeperl.
+>>>> I think I can then do the same thing to $params{specFuncs}. -- [[Will]]
+
> * Seems that the only reason `match_glob` has to check for `~` is
> because when a named spec appears in a pagespec, it is translated
> to `match_glob("~foo")`. If, instead, `pagespec_makeperl` checked
@@ -272,6 +277,19 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
>>> because the link target it is being asked to check for is a single
>>> page name, not a glob.
+>>>> A named pagespec should fall into the glob case. These two pagespecs should be the same:
+
+ link(a*)
+
+>>>> and
+
+ define(aStar, a*) and link(aStar)
+
+>>>> In the first case, we want the pagespec to match any page that links to a page matching the glob.
+>>>> In the second case, we want the pagespec to match any page that links to a page matching the named spec.
+>>>> match_link() was already doing existential part. The patches to this code were simply to remove the `lc()`
+>>>> call from the named pagespec name. Can that `lc` be removed entirely? -- [[Will]]
+
> * Generally, the need to modify `match_*` functions so that they
> check for and handle named pagespecs seems suboptimal, if
> only because there might be others people may want to use named
@@ -289,6 +307,9 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
>>> But if a plugin adds its own match function, it has
>>> to explicitly call that code to support named pagespecs.
+>>>> Yes, and it can do that in just three lines of code. But if we automatically check for named pagespecs all the time we
+>>>> potentially break any matching function that doesn't accept pages, or wants to use multiple arguments.
+
> * I need to check if your trick to avoid infinite recursion
> works if there are two named specs that recursively
> call one-another. I suspect it does, but will test this
@@ -310,6 +331,14 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
>>> it shouldn't (but I haven't verified that really happens).
>>> That could certianly be a show-stopper. --[[Joey]]
+>>>> I think this can happen in the new closure based code. I don't think this could happen in the old code. -- [[Will]]
+
+>>>> Even if that works, this is a good argument for having a syntactic difference between named pagespecs and normal pages.
+>>>> If you're joining two pagespecs with 'or', you don't want a named pagespec in the first part overriding a page name in the
+>>>> second part. Oh, and I assume 'or' has the right operator precedence that "a and b or c" is "(a and b) or c", and not "a and (b or c)" -- [[Will]]
+
+>>>>> Looks like its bracketed in the code anyway... -- [[Will]]
+
>> Secondly, it seems that there are two types of dependency, and ikiwiki
>> currently only handles one of them. The first type is "Rebuild this
>> page when any of these other pages changes" - ikiwiki handles this.
@@ -328,113 +357,159 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
>>>> case though and I'll be suprised if they fit well into pagespecs.
>>>> --[[Joey]]
+>>>>> The issue is that the existential pagespec matching allows you to build things that have similar
+>>>>> problems to backlinks.
+>>>>> e.g. the following inline:
+
+ \[[!inline pages="define(~done, link(done)) and link(~done)" archive=yes]]
+
+>>>>> includes any page that links to a page that links to done. Now imagine I add a new link to 'done' on
+>>>>> some random page somewhere - a page which some other page links to which didn't previously get included - the set of pages accepted by the pagespec, and hence the set of
+>>>>> pages inlined, will change. But, there is no dependency anywhere on the page that I altered, so
+>>>>> ikiwiki will not rebuild the page with the inline in it. What is happening is that the page that I altered affects
+>>>>> the set of pages matched by the pagespec without itself being matched by the pagespec, and hence included in the dependency list.
+
+>>>>> To make this work well, I think you need to recognise two types of dependencies for each page (and no
+>>>>> special cases for particular types of links, eg backlinks). The first type of dependency says, "The content of
+>>>>> this page depends upon the content of these other pages". The `add_depends()` in the shortcuts
+>>>>> plugin is of this form: any time the shortcuts page is edited, any page with a shortcut on it
+>>>>> is rebuilt. The inline plugin also needs to add dependencies of this form to detect when the inlined
+>>>>> content changes. By contrast, the map plugin does not need a dependency of this form, because it
+>>>>> doesn't actually care about the content of any pages, just which pages it needs to include (which we'll handle next).
+
+>>>>> The second type of dependency says, "The content of this page depends upon the exact set of pages matched
+>>>>> by this pagespec". The first type of dependency was about the content of some pages, the second type is about
+>>>>> which pages get matched by a pagespec. This is the type of dependency tracking that the map plugin needs.
+>>>>> If the set of pages matched by map pagespec changes, then the page with the map on it needs to be rebuilt to show a different list of pages.
+>>>>> Inline needs this type of dependency as well as the previous type - This type handles a change in which pages
+>>>>> are inlined, the previous type handles a change in the content of any of those pages. Shortcut does not need this type of
+>>>>> dependency. Most of the places that use `add_depends()` seem to need this type of dependency rather than the first type.
+
+>>>>> Implementation Details: The first type of dependency can be handled very similarly to the current
+>>>>> dependency system. You just need to keep a list of pages that the content depends upon. You could
+>>>>> keep that list as a pagespec, but if you do this you might want to check that the pagespec doesn't change,
+>>>>> possibly by adding a dependency of the second type along with the dependency of the first type.
+
+>>>>> The second type of dependency is a little more tricky. For each page, we'd need a list of pagespecs that
+>>>>> the page depended on, and for each pagespec you'd want to store the list of pages that currently match it.
+>>>>> On refresh, you'd need to check each pagespec to see if the set of pages that match it has changed, and if
+>>>>> that set has changed, then rebuild the dependent page(s). Oh, and for this second type of dependency, I
+>>>>> don't think you can merge pagespecs. If I wanted to know if either "\*" or "link(done)" changes, then just checking
+>>>>> to see if the set of pages matched by "\* or link(done)" changes doesn't work.
+
+>>>>> The current system works because even though you usually want dependencies of the second type, the set of pages
+>>>>> referred to by a pagespec can only change if one of those pages itself changes. i.e. A dependency check of the
+>>>>> first type will catch a dependency change of the second type with current pagespecs.
+>>>>> This doesn't work with backlinks, and it doesn't work with existential matching. Backlinks are currently special-cased. I don't know
+>>>>> how to special-case existential matching - I suspect you're better off just getting the dependency tracking right.
+
+>>>>> I also tried to come up with other possible solutions: e.g. can we find the dependencies for a pagespec? That
+>>>>> would be the set of pages where a change on one of those pages could lead to a change in the set of pages matched by the pagespec.
+>>>>> For old-style pagespecs without backlinks, the dependency set for a pagespec is the same as the set of pages the pagespec matches.
+>>>>> Unfortunately, with existential matching, the set of pages that each
+>>>>> pagespec depends upon can quickly become "*", which is not very useful. -- [[Will]]
+
+Patch updated to use closures rather than inline generated code for named pagespecs. Also includes some new use of ErrorReason where appropriate. -- [[Will]]
+
----
diff --git a/IkiWiki.pm b/IkiWiki.pm
- index 4e4da11..8b3cdfe 100644
+ index 061a1c6..1e78a63 100644
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
- @@ -1550,7 +1550,16 @@ sub globlist_to_pagespec ($) {
-
- sub is_globlist ($) {
- my $s=shift;
- - return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
- + return ! ($s =~ /
- + (^\s*
- + [^\s(]+ # single item
- + (\( # possibly with parens after it
- + ([^)]* # with stuff inside those parens
- + (\([^)]*\))*)* # maybe even nested parens
- + \))?\s*$
- + ) |
- + (\s and \s) | (\s or \s) # or we find 'and' or 'or' somewhere
- + /xs);
- }
-
- sub safequote ($) {
- @@ -1631,7 +1640,7 @@ sub pagespec_merge ($$) {
+ @@ -1774,8 +1774,12 @@ sub pagespec_merge ($$) {
return "($a) or ($b)";
}
-sub pagespec_translate ($) {
- +sub pagespec_makeperl ($) {
+ +# is perl really so dumb it requires a forward declaration for recursive calls?
+ +sub pagespec_translate ($$);
+ +
+ +sub pagespec_translate ($$) {
my $spec=shift;
+ + my $specFuncsRef=shift;
- # Support for old-style GlobLists.
- @@ -1650,12 +1659,14 @@ sub pagespec_translate ($) {
+ # Convert spec to perl code.
+ my $code="";
+ @@ -1789,7 +1793,9 @@ sub pagespec_translate ($) {
|
\) # )
|
- \w+\([^\)]*\) # command(params)
- + define\(\s*~\w+\s*,((\([^()]*\)) | ([^()]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
+ + define\(\s*~\w+\s*,((\([^()]*\)) | ([^()]+))+\) # define(~specName, spec) - spec can contain parens 1 deep
+ |
+ \w+\([^()]*\) # command(params) - params cannot contain parens
|
[^\s()]+ # any other text
)
- \s* # ignore whitespace
- - }igx) {
- + }igxs) {
- my $word=$1;
- if (lc $word eq 'and') {
- $code.=' &&';
- @@ -1666,16 +1677,23 @@ sub pagespec_translate ($) {
+ @@ -1805,10 +1811,19 @@ sub pagespec_translate ($) {
elsif ($word eq "(" || $word eq ")" || $word eq "!") {
$code.=' '.$word;
}
- elsif ($word =~ /^(\w+)\((.*)\)$/) {
- + elsif ($word =~ /^define\(\s*~(\w+)\s*,(.*)\)$/s) {
- + $code .= " (\$params{specFuncs}->{$1}="; # (exists \$params{specFuncs}) &&
- + $code .= "memoize(";
- + $code .= &pagespec_makeperl($2);
- + $code .= ")";
- + $code .= ") ";
+ + elsif ($word =~ /^define\(\s*(~\w+)\s*,(.*)\)$/s) {
+ + my $name = $1;
+ + my $subSpec = $2;
+ + my $newSpecFunc = pagespec_translate($subSpec, $specFuncsRef);
+ + return if $@ || ! defined $newSpecFunc;
+ + $specFuncsRef->{$name} = $newSpecFunc;
+ + push @data, qq{Created named pagespec "$name"};
+ + $code.="IkiWiki::SuccessReason->new(\$data[$#data])";
+ }
+ elsif ($word =~ /^(\w+)\((.*)\)$/s) {
if (exists $IkiWiki::PageSpec::{"match_$1"}) {
- - $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
- + $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \%params)";
+ push @data, $2;
+ - $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
+ + $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_, specFuncs => \$specFuncsRef)";
}
else {
- $code.=' 0';
- }
+ push @data, qq{unknown function in pagespec "$word"};
+ @@ -1817,7 +1832,7 @@ sub pagespec_translate ($) {
}
else {
- - $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
- + $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \%params)";
+ push @data, $word;
+ - $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
+ + $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_, specFuncs => \$specFuncsRef)";
}
}
- @@ -1683,8 +1701,18 @@ sub pagespec_translate ($) {
- $code=0;
+ @@ -1826,7 +1841,7 @@ sub pagespec_translate ($) {
}
- + return 'sub { my $page=shift; my %params = @_; '.$code.' }';
- +}
- +
- +sub pagespec_translate ($) {
- + my $spec=shift;
- +
- + my $code = pagespec_makeperl($spec);
- +
- + # print STDERR "Spec '$spec' generated code '$code'\n";
- +
no warnings;
- return eval 'sub { my $page=shift; '.$code.' }';
- + return eval $code;
+ + return eval 'memoize (sub { my $page=shift; '.$code.' })';
}
sub pagespec_match ($$;@) {
- @@ -1699,7 +1727,7 @@ sub pagespec_match ($$;@) {
+ @@ -1839,7 +1854,7 @@ sub pagespec_match ($$;@) {
+ unshift @params, 'location';
+ }
- my $sub=pagespec_translate($spec);
- return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
- - return $sub->($page, @params);
- + return $sub->($page, @params, specFuncs => {});
- }
+ - my $sub=pagespec_translate($spec);
+ + my $sub=pagespec_translate($spec, +{});
+ return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
+ if $@ || ! defined $sub;
+ return $sub->($page, @params);
+ @@ -1850,7 +1865,7 @@ sub pagespec_match_list ($$;@) {
+ my $spec=shift;
+ my @params=@_;
+ - my $sub=pagespec_translate($spec);
+ + my $sub=pagespec_translate($spec, +{});
+ error "syntax error in pagespec \"$spec\""
+ if $@ || ! defined $sub;
+
+ @@ -1872,7 +1887,7 @@ sub pagespec_match_list ($$;@) {
sub pagespec_valid ($) {
- @@ -1748,11 +1776,78 @@ sub new {
+ my $spec=shift;
+
+ - my $sub=pagespec_translate($spec);
+ + my $sub=pagespec_translate($spec, +{});
+ return ! $@;
+ }
+
+ @@ -1919,6 +1934,68 @@ sub new {
package IkiWiki::PageSpec;
@@ -442,15 +517,14 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
+ my $page=shift;
+ my $specName=shift;
+ my %params=@_;
- +
- + error("Unable to find specFuncs in params to check_named_spec()!") unless exists $params{specFuncs};
+ +
+ + return IkiWiki::ErrorReason->new("Unable to find specFuncs in params to check_named_spec()!")
+ + unless exists $params{specFuncs};
+
+ my $specFuncsRef=$params{specFuncs};
- +
- + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
+ +
+ + return IkiWiki::ErrorReason->new("Named page spec '$specName' is not valid")
+ unless (substr($specName, 0, 1) eq '~');
- +
- + $specName = substr($specName, 1);
+
+ if (exists $specFuncsRef->{$specName}) {
+ # remove the named spec from the spec refs
@@ -461,7 +535,7 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
+ $specFuncsRef->{$specName} = $sub;
+ return $result;
+ } else {
- + return IkiWiki::FailReason->new("Page spec '$specName' does not exist");
+ + return IkiWiki::ErrorReason->new("Page spec '$specName' does not exist");
+ }
+}
+
@@ -470,14 +544,14 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
+ my $specName=shift;
+ my $funcref=shift;
+ my %params=@_;
- +
- + error("Unable to find specFuncs in params to check_named_spec_existential()!") unless exists $params{specFuncs};
+ +
+ + return IkiWiki::ErrorReason->new("Unable to find specFuncs in params to check_named_spec_existential()!")
+ + unless exists $params{specFuncs};
+ my $specFuncsRef=$params{specFuncs};
+
- + return IkiWiki::FailReason->new("Named page spec '$specName' is not valid")
+ + return IkiWiki::ErrorReason->new("Named page spec '$specName' is not valid")
+ unless (substr($specName, 0, 1) eq '~');
- + $specName = substr($specName, 1);
- +
+ +
+ if (exists $specFuncsRef->{$specName}) {
+ # remove the named spec from the spec refs
+ # when we recurse to avoid infinite recursion
@@ -489,7 +563,7 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
+ my $tempResult = $funcref->($page, $nextpage, %params);
+ if ($tempResult) {
+ $specFuncsRef->{$specName} = $sub;
- + return $tempResult;
+ + return IkiWiki::SuccessReason->new("Existential check of '$specName' matches because $tempResult");
+ }
+ }
+ }
@@ -497,12 +571,14 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
+ $specFuncsRef->{$specName} = $sub;
+ return IkiWiki::FailReason->new("No page in spec '$specName' was successfully matched");
+ } else {
- + return IkiWiki::FailReason->new("Named page spec '$specName' does not exist");
+ + return IkiWiki::ErrorReason->new("Named page spec '$specName' does not exist");
+ }
+}
+
- sub match_glob ($$;@) {
- my $page=shift;
+ sub derel ($$) {
+ my $path=shift;
+ my $from=shift;
+ @@ -1937,6 +2014,10 @@ sub match_glob ($$;@) {
my $glob=shift;
my %params=@_;
@@ -510,30 +586,31 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
+ return check_named_spec($page, $glob, %params);
+ }
+
- my $from=exists $params{location} ? $params{location} : '';
-
- # relative matching
- @@ -1782,11 +1877,12 @@ sub match_internal ($$;@) {
+ $glob=derel($glob, $params{location});
+
+ my $regexp=IkiWiki::glob2re($glob);
+ @@ -1959,8 +2040,9 @@ sub match_internal ($$;@) {
sub match_link ($$;@) {
my $page=shift;
- my $link=lc(shift);
- + my $fulllink=shift;
+ + my $fullLink=shift;
my %params=@_;
- + my $link=lc($fulllink);
+ + my $link=lc($fullLink);
+ $link=derel($link, $params{location});
my $from=exists $params{location} ? $params{location} : '';
- -
- +
- # relative matching
- if ($link =~ m!^\.! && defined $from) {
- $from=~s#/?[^/]+$##;
- @@ -1804,19 +1900,32 @@ sub match_link ($$;@) {
+ @@ -1975,25 +2057,37 @@ sub match_link ($$;@) {
}
else {
return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
- if match_glob($p, $link, %params);
- + if match_glob($p, $fulllink, %params);
+ + if match_glob($p, $fullLink, %params);
+ $p=~s/^\///;
+ $link=~s/^\///;
+ return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
+ - if match_glob($p, $link, %params);
+ + if match_glob($p, $fullLink, %params);
}
}
return IkiWiki::FailReason->new("$page does not link to $link");
@@ -555,23 +632,24 @@ account all comments above (which doesn't mean it is above reproach :) ). --[[W
sub match_created_before ($$;@) {
my $page=shift;
my $testpage=shift;
- + my @params=@_;
+ my %params=@_;
+ -
+
+ if (substr($testpage, 0, 1) eq '~') {
- + return check_named_spec_existential($page, $testpage, \&match_created_before, @params);
+ + return check_named_spec_existential($page, $testpage, \&match_created_before, %params);
+ }
+ +
+ $testpage=derel($testpage, $params{location});
if (exists $IkiWiki::pagectime{$testpage}) {
- if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
- @@ -1834,6 +1943,11 @@ sub match_created_before ($$;@) {
- sub match_created_after ($$;@) {
- my $page=shift;
+ @@ -2014,6 +2108,10 @@ sub match_created_after ($$;@) {
my $testpage=shift;
- + my @params=@_;
- +
+ my %params=@_;
+
+ if (substr($testpage, 0, 1) eq '~') {
- + return check_named_spec_existential($page, $testpage, \&match_created_after, @params);
+ + return check_named_spec_existential($page, $testpage, \&match_created_after, %params);
+ }
+ +
+ $testpage=derel($testpage, $params{location});
if (exists $IkiWiki::pagectime{$testpage}) {
- if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {