X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;ds=sidebyside;f=Plugin.pod;h=4eefacc73fb7943a696f4d0ea8c8853f001b7da3;hb=refs%2Ftags%2Fv0.09;hp=76e8b3a7971423c35c7c1f010701aa4a2b73b21a;hpb=5feac29518975b05987edbc997123cfa06586bb8;p=perl%2Fmodules%2Fre-engine-Plugin.git
diff --git a/Plugin.pod b/Plugin.pod
index 76e8b3a..4eefacc 100644
--- a/Plugin.pod
+++ b/Plugin.pod
@@ -2,6 +2,10 @@
re::engine::Plugin - API to write custom regex engines
+=head1 VERSION
+
+Version 0.09
+
=head1 DESCRIPTION
As of perl 5.9.5 it's possible to lexically replace perl's built-in
@@ -19,12 +23,12 @@ C or runtime for C patterns, or something inbetween
depending on variable interpolation etc.
When this module is loaded into a scope it inserts a hook into
-C<$^H{regcomp}> (as described in L) to have each regexp
-constructed in its lexical scope handled by this engine, but it
-differs from other engines in that it also inserts other hooks into
-C<%^H> in the same scope that point to user-defined subroutines to use
-during compilation, execution etc, these are described in
-L below.
+C<$^H{regcomp}> (as described in L and L) to
+have each regexp constructed in its lexical scope handled by this
+engine, but it differs from other engines in that it also inserts
+other hooks into C<%^H> in the same scope that point to user-defined
+subroutines to use during compilation, execution etc, these are
+described in L below.
The callbacks (e.g. L) then get called with a
L object as their first argument. This object
@@ -51,7 +55,7 @@ caller's scope use use the following snippet:
sub import
{
- # Populates the caller's %^H with our callbacks
+ # Sets the caller's $^H{regcomp} his %^H with our callbacks
re::engine::Plugin->import(
comp => \&comp,
exec => \&exec,
@@ -122,6 +126,9 @@ available as the second argument (C<$str>) and through the L
method. The routine should return a true value if the match was
successful, and a false one if it wasn't.
+This callback can also be specified on an individual basis with the
+L method.
+
=head1 METHODS
=head2 str
@@ -182,6 +189,33 @@ called at all.
The length specified will be used as a a byte length (using
L), not a character length.
+=head2 nparens
+
+=head2 gofs
+
+=head2 callbacks
+
+ # A dumb regexp engine that just tests string equality
+ use re::engine::Plugin comp => sub {
+ my ($re) = @_;
+
+ my $pat = $re->pattern;
+
+ $re->callbacks(
+ exec => sub {
+ my ($re, $str) = @_;
+ return $pat eq $str;
+ },
+ );
+ };
+
+Takes a list of key-value pairs of names and subroutines, and replace the
+callback currently attached to the regular expression for the type given as
+the key by the code reference passed as the corresponding value.
+
+The only valid key is currently C. See L for more details about
+this callback.
+
=head2 num_captures
$re->num_captures(
@@ -231,7 +265,20 @@ done it'll allow the binding of C<%+> and C<%-> and support the
L methods FETCH, STORE, DELETE, CLEAR, EXISTS, FIRSTKEY,
NEXTKEY and SCALAR.
-=head1 Tainting
+=head1 CONSTANTS
+
+=head2 C
+
+True iff the module could have been built with thread-safety features
+enabled.
+
+=head2 C
+
+True iff this module could have been built with fork-safety features
+enabled. This will always be true except on Windows where it's false
+for perl 5.10.0 and below.
+
+=head1 TAINTING
The only way to untaint an existing variable in Perl is to use it as a
hash key or referencing subpatterns from a regular expression match
@@ -292,7 +339,7 @@ this module is responsible for how and if it untaints its variables.
L, L
-=head1 TODO / CAVEATS
+=head1 TODO & CAVEATS
I
@@ -385,19 +432,32 @@ tests.
=back
+=head1 DEPENDENCIES
+
+L 5.10.
+
+A C compiler.
+This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard.
+
+L (standard since perl 5.006).
+
=head1 BUGS
Please report any bugs that aren't already listed at
L to
L
-=head1 AUTHOR
+=head1 AUTHORS
+
+Evar ArnfjErE Bjarmason C<< >>
-Evar ArnfjErE Bjarmason
+Vincent Pit C<< >>
=head1 LICENSE
-Copyright 2007-2008 Evar ArnfjErE Bjarmason.
+Copyright 2007,2008 Evar ArnfjErE Bjarmason.
+
+Copyright 2009,2010,2011 Vincent Pit.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.