Importing re-engine-Plugin-0.04_01.tar.gz

[perl/modules/re-engine-Plugin.git] / Plugin.pod

diff --git a/Plugin.pod b/Plugin.pod
index d4bb1a246bed672d35878a3dc84e4dd310b9d49d..1438f64dde0b50c647ac5e7e54f085b0148a19e5 100644 (file)
--- a/Plugin.pod
+++ b/Plugin.pod
@@ -2,6 +2,11 @@
 
 re::engine::Plugin - API to write custom regex engines
 
+=head1 NOTICE
+
+This is a B<developer release> that requires a patch to blead to work,
+the patch can be found in F<named_capture.patch> in this distribution.
+
 =head1 DESCRIPTION
 
 As of perl 5.9.5 it's possible to lexically replace perl's built-in
@@ -149,7 +154,7 @@ hashrefs, objects, etc.
 =head2 mod
 
     my %mod = $rx->mod;
-    say "has /ix" if $mod{i} and $mod{x};
+    say "has /ix" if %mod ~~ 'i' and %mod ~~ 'x';
 
 A key-value pair list of the modifiers the pattern was compiled with.
 The keys will zero or more of C<imsxp> and the values will be true
@@ -224,12 +229,10 @@ name an example).
 
 =head2 named_captures
 
-B<TODO>: implement
+B<TODO>: document
 
-perl internals still needs to be changed to support this but when it's
-done it'll allow the binding of C<%+> and C<%-> and support the
-L<Tie::Hash> methods FETCH, STORE, DELETE, CLEAR, EXISTS, FIRSTKEY,
-NEXTKEY and SCALAR.
+This is implemented but not documented, see F<t/named_buff> for usage
+examples.
 
 =head1 Tainting
 
@@ -300,6 +303,11 @@ I<here be dragons>
 
 =item *
 
+Export constants defined as macros in core relevant to our interests,
+e.g. PMf_ stuff and things needed by extflags.
+
+=item *
+
 Engines implemented with this module don't support C<s///> and C<split
 //>, the appropriate parts of the C<REGEXP> struct need to be wrapped
 and documented.