pod/perlreapi.pod

   1 =head1 NAME
   2
   3 perlreapi - Perl regular expression plugin interface
   4
   5 =head1 DESCRIPTION
   6
   7 As of Perl 5.9.5 there is a new interface for plugging and using
   8 regular expression engines other than the default one.
   9
  10 Each engine is supposed to provide access to a constant structure of the
  11 following format:
  12
  13     typedef struct regexp_engine {
  14         REGEXP* (*comp) (pTHX_
  15                          const SV * const pattern, const U32 flags);
  16         I32     (*exec) (pTHX_
  17                          REGEXP * const rx,
  18                          char* stringarg,
  19                          char* strend, char* strbeg,
  20                          I32 minend, SV* screamer,
  21                          void* data, U32 flags);
  22         char*   (*intuit) (pTHX_
  23                            REGEXP * const rx, SV *sv,
  24                            char *strpos, char *strend, U32 flags,
  25                            struct re_scream_pos_data_s *data);
  26         SV*     (*checkstr) (pTHX_ REGEXP * const rx);
  27         void    (*free) (pTHX_ REGEXP * const rx);
  28         void    (*numbered_buff_FETCH) (pTHX_
  29                                         REGEXP * const rx,
  30                                         const I32 paren,
  31                                         SV * const sv);
  32         void    (*numbered_buff_STORE) (pTHX_
  33                                         REGEXP * const rx,
  34                                         const I32 paren,
  35                                         SV const * const value);
  36         I32     (*numbered_buff_LENGTH) (pTHX_
  37                                          REGEXP * const rx,
  38                                          const SV * const sv,
  39                                          const I32 paren);
  40         SV*     (*named_buff) (pTHX_
  41                                REGEXP * const rx,
  42                                SV * const key,
  43                                SV * const value,
  44                                U32 flags);
  45         SV*     (*named_buff_iter) (pTHX_
  46                                     REGEXP * const rx,
  47                                     const SV * const lastkey,
  48                                     const U32 flags);
  49         SV*     (*qr_package)(pTHX_ REGEXP * const rx);
  50     #ifdef USE_ITHREADS
  51         void*   (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
  52     #endif
  53         REGEXP* (*op_comp) (...);
  54
  55
  56 When a regexp is compiled, its C<engine> field is then set to point at
  57 the appropriate structure, so that when it needs to be used Perl can find
  58 the right routines to do so.
  59
  60 In order to install a new regexp handler, C<$^H{regcomp}> is set
  61 to an integer which (when casted appropriately) resolves to one of these
  62 structures. When compiling, the C<comp> method is executed, and the
  63 resulting C<regexp> structure's engine field is expected to point back at
  64 the same structure.
  65
  66 The pTHX_ symbol in the definition is a macro used by Perl under threading
  67 to provide an extra argument to the routine holding a pointer back to
  68 the interpreter that is executing the regexp. So under threading all
  69 routines get an extra argument.
  70
  71 =head1 Callbacks
  72
  73 =head2 comp
  74
  75     REGEXP* comp(pTHX_ const SV * const pattern, const U32 flags);
  76
  77 Compile the pattern stored in C<pattern> using the given C<flags> and
  78 return a pointer to a prepared C<REGEXP> structure that can perform
  79 the match. See L</The REGEXP structure> below for an explanation of
  80 the individual fields in the REGEXP struct.
  81
  82 The C<pattern> parameter is the scalar that was used as the
  83 pattern.  Previous versions of Perl would pass two C<char*> indicating
  84 the start and end of the stringified pattern; the following snippet can
  85 be used to get the old parameters:
  86
  87     STRLEN plen;
  88     char*  exp = SvPV(pattern, plen);
  89     char* xend = exp + plen;
  90
  91 Since any scalar can be passed as a pattern, it's possible to implement
  92 an engine that does something with an array (C<< "ook" =~ [ qw/ eek
  93 hlagh / ] >>) or with the non-stringified form of a compiled regular
  94 expression (C<< "ook" =~ qr/eek/ >>).  Perl's own engine will always
  95 stringify everything using the snippet above, but that doesn't mean
  96 other engines have to.
  97
  98 The C<flags> parameter is a bitfield which indicates which of the
  99 C<msixp> flags the regex was compiled with. It also contains
 100 additional info, such as if C<use locale> is in effect.
 101
 102 The C<eogc> flags are stripped out before being passed to the comp
 103 routine. The regex engine does not need to know if any of these
 104 are set, as those flags should only affect what Perl does with the
 105 pattern and its match variables, not how it gets compiled and
 106 executed.
 107
 108 By the time the comp callback is called, some of these flags have
 109 already had effect (noted below where applicable). However most of
 110 their effect occurs after the comp callback has run, in routines that
 111 read the C<< rx->extflags >> field which it populates.
 112
 113 In general the flags should be preserved in C<< rx->extflags >> after
 114 compilation, although the regex engine might want to add or delete
 115 some of them to invoke or disable some special behavior in Perl. The
 116 flags along with any special behavior they cause are documented below:
 117
 118 The pattern modifiers:
 119
 120 =over 4
 121
 122 =item C</m> - RXf_PMf_MULTILINE
 123
 124 If this is in C<< rx->extflags >> it will be passed to
 125 C<Perl_fbm_instr> by C<pp_split> which will treat the subject string
 126 as a multi-line string.
 127
 128 =item C</s> - RXf_PMf_SINGLELINE
 129
 130 =item C</i> - RXf_PMf_FOLD
 131
 132 =item C</x> - RXf_PMf_EXTENDED
 133
 134 If present on a regex, C<"#"> comments will be handled differently by the
 135 tokenizer in some cases.
 136
 137 TODO: Document those cases.
 138
 139 =item C</p> - RXf_PMf_KEEPCOPY
 140
 141 TODO: Document this
 142
 143 =item Character set
 144
 145 The character set semantics are determined by an enum that is contained
 146 in this field.  This is still experimental and subject to change, but
 147 the current interface returns the rules by use of the in-line function
 148 C<get_regex_charset(const U32 flags)>.  The only currently documented
 149 value returned from it is REGEX_LOCALE_CHARSET, which is set if
 150 C<use locale> is in effect. If present in C<< rx->extflags >>,
 151 C<split> will use the locale dependent definition of whitespace
 152 when RXf_SKIPWHITE or RXf_WHITE is in effect. ASCII whitespace
 153 is defined as per L<isSPACE|perlapi/isSPACE>, and by the internal
 154 macros C<is_utf8_space> under UTF-8, and C<isSPACE_LC> under C<use
 155 locale>.
 156
 157 =back
 158
 159 Additional flags:
 160
 161 =over 4
 162
 163 =item RXf_SPLIT
 164
 165 This flag was removed in perl 5.18.0.  C<split ' '> is now special-cased
 166 solely in the parser.  RXf_SPLIT is still #defined, so you can test for it.
 167 This is how it used to work:
 168
 169 If C<split> is invoked as C<split ' '> or with no arguments (which
 170 really means C<split(' ', $_)>, see L<split|perlfunc/split>), Perl will
 171 set this flag. The regex engine can then check for it and set the
 172 SKIPWHITE and WHITE extflags. To do this, the Perl engine does:
 173
 174     if (flags & RXf_SPLIT && r->prelen == 1 && r->precomp[0] == ' ')
 175         r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
 176
 177 =back
 178
 179 These flags can be set during compilation to enable optimizations in
 180 the C<split> operator.
 181
 182 =over 4
 183
 184 =item RXf_SKIPWHITE
 185
 186 This flag was removed in perl 5.18.0.  It is still #defined, so you can
 187 set it, but doing so will have no effect.  This is how it used to work:
 188
 189 If the flag is present in C<< rx->extflags >> C<split> will delete
 190 whitespace from the start of the subject string before it's operated
 191 on. What is considered whitespace depends on if the subject is a
 192 UTF-8 string and if the C<RXf_PMf_LOCALE> flag is set.
 193
 194 If RXf_WHITE is set in addition to this flag, C<split> will behave like
 195 C<split " "> under the Perl engine.
 196
 197 =item RXf_START_ONLY
 198
 199 Tells the split operator to split the target string on newlines
 200 (C<\n>) without invoking the regex engine.
 201
 202 Perl's engine sets this if the pattern is C</^/> (C<plen == 1 && *exp
 203 == '^'>), even under C</^/s>; see L<split|perlfunc>. Of course a
 204 different regex engine might want to use the same optimizations
 205 with a different syntax.
 206
 207 =item RXf_WHITE
 208
 209 Tells the split operator to split the target string on whitespace
 210 without invoking the regex engine. The definition of whitespace varies
 211 depending on if the target string is a UTF-8 string and on
 212 if RXf_PMf_LOCALE is set.
 213
 214 Perl's engine sets this flag if the pattern is C<\s+>.
 215
 216 =item RXf_NULL
 217
 218 Tells the split operator to split the target string on
 219 characters. The definition of character varies depending on if
 220 the target string is a UTF-8 string.
 221
 222 Perl's engine sets this flag on empty patterns, this optimization
 223 makes C<split //> much faster than it would otherwise be. It's even
 224 faster than C<unpack>.
 225
 226 =back
 227
 228 =head2 exec
 229
 230     I32 exec(pTHX_ REGEXP * const rx,
 231              char *stringarg, char* strend, char* strbeg,
 232              I32 minend, SV* screamer,
 233              void* data, U32 flags);
 234
 235 Execute a regexp. The arguments are
 236
 237 =over 4
 238
 239 =item rx
 240
 241 The regular expression to execute.
 242
 243 =item screamer
 244
 245 This strangely-named arg is the SV to be matched against. Note that the
 246 actual char array to be matched against is supplied by the arguments
 247 described below; the SV is just used to determine UTF8ness, C<pos()> etc.
 248
 249 =item strbeg
 250
 251 Pointer to the physical start of the string.
 252
 253 =item strend
 254
 255 Pointer to the character following the physical end of the string (i.e.
 256 the C<\0>).
 257
 258 =item stringarg
 259
 260 Pointer to the position in the string where matching should start; it might
 261 not be equal to C<strbeg> (for example in a later iteration of C</.../g>).
 262
 263 =item minend
 264
 265 Minimum length of string (measured in bytes from C<stringarg>) that must
 266 match; if the engine reaches the end of the match but hasn't reached this
 267 position in the string, it should fail.
 268
 269 =item data
 270
 271 Optimisation data; subject to change.
 272
 273 =item flags
 274
 275 Optimisation flags; subject to change.
 276
 277 =back
 278
 279 =head2 intuit
 280
 281     char* intuit(pTHX_ REGEXP * const rx,
 282                   SV *sv, char *strpos, char *strend,
 283                   const U32 flags, struct re_scream_pos_data_s *data);
 284
 285 Find the start position where a regex match should be attempted,
 286 or possibly if the regex engine should not be run because the
 287 pattern can't match. This is called, as appropriate, by the core,
 288 depending on the values of the C<extflags> member of the C<regexp>
 289 structure.
 290
 291 =head2 checkstr
 292
 293     SV* checkstr(pTHX_ REGEXP * const rx);
 294
 295 Return a SV containing a string that must appear in the pattern. Used
 296 by C<split> for optimising matches.
 297
 298 =head2 free
 299
 300     void free(pTHX_ REGEXP * const rx);
 301
 302 Called by Perl when it is freeing a regexp pattern so that the engine
 303 can release any resources pointed to by the C<pprivate> member of the
 304 C<regexp> structure. This is only responsible for freeing private data;
 305 Perl will handle releasing anything else contained in the C<regexp> structure.
 306
 307 =head2 Numbered capture callbacks
 308
 309 Called to get/set the value of C<$`>, C<$'>, C<$&> and their named
 310 equivalents, ${^PREMATCH}, ${^POSTMATCH} and $^{MATCH}, as well as the
 311 numbered capture groups (C<$1>, C<$2>, ...).
 312
 313 The C<paren> parameter will be C<1> for C<$1>, C<2> for C<$2> and so
 314 forth, and have these symbolic values for the special variables:
 315
 316     ${^PREMATCH}  RX_BUFF_IDX_CARET_PREMATCH
 317     ${^POSTMATCH} RX_BUFF_IDX_CARET_POSTMATCH
 318     ${^MATCH}     RX_BUFF_IDX_CARET_FULLMATCH
 319     $`            RX_BUFF_IDX_PREMATCH
 320     $'            RX_BUFF_IDX_POSTMATCH
 321     $&            RX_BUFF_IDX_FULLMATCH
 322
 323 Note that in Perl 5.17.3 and earlier, the last three constants were also
 324 used for the caret variants of the variables.
 325
 326
 327 The names have been chosen by analogy with L<Tie::Scalar> methods
 328 names with an additional B<LENGTH> callback for efficiency. However
 329 named capture variables are currently not tied internally but
 330 implemented via magic.
 331
 332 =head3 numbered_buff_FETCH
 333
 334     void numbered_buff_FETCH(pTHX_ REGEXP * const rx, const I32 paren,
 335                              SV * const sv);
 336
 337 Fetch a specified numbered capture. C<sv> should be set to the scalar
 338 to return, the scalar is passed as an argument rather than being
 339 returned from the function because when it's called Perl already has a
 340 scalar to store the value, creating another one would be
 341 redundant. The scalar can be set with C<sv_setsv>, C<sv_setpvn> and
 342 friends, see L<perlapi>.
 343
 344 This callback is where Perl untaints its own capture variables under
 345 taint mode (see L<perlsec>). See the C<Perl_reg_numbered_buff_fetch>
 346 function in F<regcomp.c> for how to untaint capture variables if
 347 that's something you'd like your engine to do as well.
 348
 349 =head3 numbered_buff_STORE
 350
 351     void    (*numbered_buff_STORE) (pTHX_
 352                                     REGEXP * const rx,
 353                                     const I32 paren,
 354                                     SV const * const value);
 355
 356 Set the value of a numbered capture variable. C<value> is the scalar
 357 that is to be used as the new value. It's up to the engine to make
 358 sure this is used as the new value (or reject it).
 359
 360 Example:
 361
 362     if ("ook" =~ /(o*)/) {
 363         # 'paren' will be '1' and 'value' will be 'ee'
 364         $1 =~ tr/o/e/;
 365     }
 366
 367 Perl's own engine will croak on any attempt to modify the capture
 368 variables, to do this in another engine use the following callback
 369 (copied from C<Perl_reg_numbered_buff_store>):
 370
 371     void
 372     Example_reg_numbered_buff_store(pTHX_
 373                                     REGEXP * const rx,
 374                                     const I32 paren,
 375                                     SV const * const value)
 376     {
 377         PERL_UNUSED_ARG(rx);
 378         PERL_UNUSED_ARG(paren);
 379         PERL_UNUSED_ARG(value);
 380
 381         if (!PL_localizing)
 382             Perl_croak(aTHX_ PL_no_modify);
 383     }
 384
 385 Actually Perl will not I<always> croak in a statement that looks
 386 like it would modify a numbered capture variable. This is because the
 387 STORE callback will not be called if Perl can determine that it
 388 doesn't have to modify the value. This is exactly how tied variables
 389 behave in the same situation:
 390
 391     package CaptureVar;
 392     use base 'Tie::Scalar';
 393
 394     sub TIESCALAR { bless [] }
 395     sub FETCH { undef }
 396     sub STORE { die "This doesn't get called" }
 397
 398     package main;
 399
 400     tie my $sv => "CaptureVar";
 401     $sv =~ y/a/b/;
 402
 403 Because C<$sv> is C<undef> when the C<y///> operator is applied to it,
 404 the transliteration won't actually execute and the program won't
 405 C<die>. This is different to how 5.8 and earlier versions behaved
 406 since the capture variables were READONLY variables then; now they'll
 407 just die when assigned to in the default engine.
 408
 409 =head3 numbered_buff_LENGTH
 410
 411     I32 numbered_buff_LENGTH (pTHX_
 412                               REGEXP * const rx,
 413                               const SV * const sv,
 414                               const I32 paren);
 415
 416 Get the C<length> of a capture variable. There's a special callback
 417 for this so that Perl doesn't have to do a FETCH and run C<length> on
 418 the result, since the length is (in Perl's case) known from an offset
 419 stored in C<< rx->offs >>, this is much more efficient:
 420
 421     I32 s1  = rx->offs[paren].start;
 422     I32 s2  = rx->offs[paren].end;
 423     I32 len = t1 - s1;
 424
 425 This is a little bit more complex in the case of UTF-8, see what
 426 C<Perl_reg_numbered_buff_length> does with
 427 L<is_utf8_string_loclen|perlapi/is_utf8_string_loclen>.
 428
 429 =head2 Named capture callbacks
 430
 431 Called to get/set the value of C<%+> and C<%->, as well as by some
 432 utility functions in L<re>.
 433
 434 There are two callbacks, C<named_buff> is called in all the cases the
 435 FETCH, STORE, DELETE, CLEAR, EXISTS and SCALAR L<Tie::Hash> callbacks
 436 would be on changes to C<%+> and C<%-> and C<named_buff_iter> in the
 437 same cases as FIRSTKEY and NEXTKEY.
 438
 439 The C<flags> parameter can be used to determine which of these
 440 operations the callbacks should respond to.  The following flags are
 441 currently defined:
 442
 443 Which L<Tie::Hash> operation is being performed from the Perl level on
 444 C<%+> or C<%+>, if any:
 445
 446     RXapif_FETCH
 447     RXapif_STORE
 448     RXapif_DELETE
 449     RXapif_CLEAR
 450     RXapif_EXISTS
 451     RXapif_SCALAR
 452     RXapif_FIRSTKEY
 453     RXapif_NEXTKEY
 454
 455 If C<%+> or C<%-> is being operated on, if any.
 456
 457     RXapif_ONE /* %+ */
 458     RXapif_ALL /* %- */
 459
 460 If this is being called as C<re::regname>, C<re::regnames> or
 461 C<re::regnames_count>, if any. The first two will be combined with
 462 C<RXapif_ONE> or C<RXapif_ALL>.
 463
 464     RXapif_REGNAME
 465     RXapif_REGNAMES
 466     RXapif_REGNAMES_COUNT
 467
 468 Internally C<%+> and C<%-> are implemented with a real tied interface
 469 via L<Tie::Hash::NamedCapture>. The methods in that package will call
 470 back into these functions. However the usage of
 471 L<Tie::Hash::NamedCapture> for this purpose might change in future
 472 releases. For instance this might be implemented by magic instead
 473 (would need an extension to mgvtbl).
 474
 475 =head3 named_buff
 476
 477     SV*     (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
 478                            SV * const value, U32 flags);
 479
 480 =head3 named_buff_iter
 481
 482     SV*     (*named_buff_iter) (pTHX_
 483                                 REGEXP * const rx,
 484                                 const SV * const lastkey,
 485                                 const U32 flags);
 486
 487 =head2 qr_package
 488
 489     SV* qr_package(pTHX_ REGEXP * const rx);
 490
 491 The package the qr// magic object is blessed into (as seen by C<ref
 492 qr//>). It is recommended that engines change this to their package
 493 name for identification regardless of if they implement methods
 494 on the object.
 495
 496 The package this method returns should also have the internal
 497 C<Regexp> package in its C<@ISA>. C<< qr//->isa("Regexp") >> should always
 498 be true regardless of what engine is being used.
 499
 500 Example implementation might be:
 501
 502     SV*
 503     Example_qr_package(pTHX_ REGEXP * const rx)
 504     {
 505         PERL_UNUSED_ARG(rx);
 506         return newSVpvs("re::engine::Example");
 507     }
 508
 509 Any method calls on an object created with C<qr//> will be dispatched to the
 510 package as a normal object.
 511
 512     use re::engine::Example;
 513     my $re = qr//;
 514     $re->meth; # dispatched to re::engine::Example::meth()
 515
 516 To retrieve the C<REGEXP> object from the scalar in an XS function use
 517 the C<SvRX> macro, see L<"REGEXP Functions" in perlapi|perlapi/REGEXP
 518 Functions>.
 519
 520     void meth(SV * rv)
 521     PPCODE:
 522         REGEXP * re = SvRX(sv);
 523
 524 =head2 dupe
 525
 526     void* dupe(pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
 527
 528 On threaded builds a regexp may need to be duplicated so that the pattern
 529 can be used by multiple threads. This routine is expected to handle the
 530 duplication of any private data pointed to by the C<pprivate> member of
 531 the C<regexp> structure.  It will be called with the preconstructed new
 532 C<regexp> structure as an argument, the C<pprivate> member will point at
 533 the B<old> private structure, and it is this routine's responsibility to
 534 construct a copy and return a pointer to it (which Perl will then use to
 535 overwrite the field as passed to this routine.)
 536
 537 This allows the engine to dupe its private data but also if necessary
 538 modify the final structure if it really must.
 539
 540 On unthreaded builds this field doesn't exist.
 541
 542 =head2 op_comp
 543
 544 This is private to the Perl core and subject to change. Should be left
 545 null.
 546
 547 =head1 The REGEXP structure
 548
 549 The REGEXP struct is defined in F<regexp.h>. All regex engines must be able to
 550 correctly build such a structure in their L</comp> routine.
 551
 552 The REGEXP structure contains all the data that Perl needs to be aware of
 553 to properly work with the regular expression. It includes data about
 554 optimisations that Perl can use to determine if the regex engine should
 555 really be used, and various other control info that is needed to properly
 556 execute patterns in various contexts, such as if the pattern anchored in
 557 some way, or what flags were used during the compile, or if the
 558 program contains special constructs that Perl needs to be aware of.
 559
 560 In addition it contains two fields that are intended for the private
 561 use of the regex engine that compiled the pattern. These are the
 562 C<intflags> and C<pprivate> members. C<pprivate> is a void pointer to
 563 an arbitrary structure, whose use and management is the responsibility
 564 of the compiling engine. Perl will never modify either of these
 565 values.
 566
 567     typedef struct regexp {
 568         /* what engine created this regexp? */
 569         const struct regexp_engine* engine;
 570
 571         /* what re is this a lightweight copy of? */
 572         struct regexp* mother_re;
 573
 574         /* Information about the match that the Perl core uses to manage
 575          * things */
 576         U32 extflags;   /* Flags used both externally and internally */
 577         I32 minlen;     /* mininum possible number of chars in */
 578                            string to match */
 579         I32 minlenret;  /* mininum possible number of chars in $& */
 580         U32 gofs;       /* chars left of pos that we search from */
 581
 582         /* substring data about strings that must appear
 583            in the final match, used for optimisations */
 584         struct reg_substr_data *substrs;
 585
 586         U32 nparens;  /* number of capture groups */
 587
 588         /* private engine specific data */
 589         U32 intflags;   /* Engine Specific Internal flags */
 590         void *pprivate; /* Data private to the regex engine which
 591                            created this object. */
 592
 593         /* Data about the last/current match. These are modified during
 594          * matching*/
 595         U32 lastparen;            /* highest close paren matched ($+) */
 596         U32 lastcloseparen;       /* last close paren matched ($^N) */
 597         regexp_paren_pair *swap;  /* Swap copy of *offs */
 598         regexp_paren_pair *offs;  /* Array of offsets for (@-) and
 599                                      (@+) */
 600
 601         char *subbeg;  /* saved or original string so \digit works
 602                           forever. */
 603         SV_SAVED_COPY  /* If non-NULL, SV which is COW from original */
 604         I32 sublen;    /* Length of string pointed by subbeg */
 605         I32 suboffset;  /* byte offset of subbeg from logical start of
 606                            str */
 607         I32 subcoffset; /* suboffset equiv, but in chars (for @-/@+) */
 608
 609         /* Information about the match that isn't often used */
 610         I32 prelen;           /* length of precomp */
 611         const char *precomp;  /* pre-compilation regular expression */
 612
 613         char *wrapped;  /* wrapped version of the pattern */
 614         I32 wraplen;    /* length of wrapped */
 615
 616         I32 seen_evals;   /* number of eval groups in the pattern - for
 617                              security checks */
 618         HV *paren_names;  /* Optional hash of paren names */
 619
 620         /* Refcount of this regexp */
 621         I32 refcnt;             /* Refcount of this regexp */
 622     } regexp;
 623
 624 The fields are discussed in more detail below:
 625
 626 =head2 C<engine>
 627
 628 This field points at a C<regexp_engine> structure which contains pointers
 629 to the subroutines that are to be used for performing a match. It
 630 is the compiling routine's responsibility to populate this field before
 631 returning the regexp object.
 632
 633 Internally this is set to C<NULL> unless a custom engine is specified in
 634 C<$^H{regcomp}>, Perl's own set of callbacks can be accessed in the struct
 635 pointed to by C<RE_ENGINE_PTR>.
 636
 637 =head2 C<mother_re>
 638
 639 TODO, see L<http://www.mail-archive.com/perl5-changes@perl.org/msg17328.html>
 640
 641 =head2 C<extflags>
 642
 643 This will be used by Perl to see what flags the regexp was compiled
 644 with, this will normally be set to the value of the flags parameter by
 645 the L<comp|/comp> callback. See the L<comp|/comp> documentation for
 646 valid flags.
 647
 648 =head2 C<minlen> C<minlenret>
 649
 650 The minimum string length (in characters) required for the pattern to match.
 651 This is used to
 652 prune the search space by not bothering to match any closer to the end of a
 653 string than would allow a match. For instance there is no point in even
 654 starting the regex engine if the minlen is 10 but the string is only 5
 655 characters long. There is no way that the pattern can match.
 656
 657 C<minlenret> is the minimum length (in characters) of the string that would
 658 be found in $& after a match.
 659
 660 The difference between C<minlen> and C<minlenret> can be seen in the
 661 following pattern:
 662
 663     /ns(?=\d)/
 664
 665 where the C<minlen> would be 3 but C<minlenret> would only be 2 as the \d is
 666 required to match but is not actually included in the matched content. This
 667 distinction is particularly important as the substitution logic uses the
 668 C<minlenret> to tell if it can do in-place substitutions (these can
 669 result in considerable speed-up).
 670
 671 =head2 C<gofs>
 672
 673 Left offset from pos() to start match at.
 674
 675 =head2 C<substrs>
 676
 677 Substring data about strings that must appear in the final match. This
 678 is currently only used internally by Perl's engine, but might be
 679 used in the future for all engines for optimisations.
 680
 681 =head2 C<nparens>, C<lastparen>, and C<lastcloseparen>
 682
 683 These fields are used to keep track of how many paren groups could be matched
 684 in the pattern, which was the last open paren to be entered, and which was
 685 the last close paren to be entered.
 686
 687 =head2 C<intflags>
 688
 689 The engine's private copy of the flags the pattern was compiled with. Usually
 690 this is the same as C<extflags> unless the engine chose to modify one of them.
 691
 692 =head2 C<pprivate>
 693
 694 A void* pointing to an engine-defined data structure. The Perl engine uses the
 695 C<regexp_internal> structure (see L<perlreguts/Base Structures>) but a custom
 696 engine should use something else.
 697
 698 =head2 C<swap>
 699
 700 Unused. Left in for compatibility with Perl 5.10.0.
 701
 702 =head2 C<offs>
 703
 704 A C<regexp_paren_pair> structure which defines offsets into the string being
 705 matched which correspond to the C<$&> and C<$1>, C<$2> etc. captures, the
 706 C<regexp_paren_pair> struct is defined as follows:
 707
 708     typedef struct regexp_paren_pair {
 709         I32 start;
 710         I32 end;
 711     } regexp_paren_pair;
 712
 713 If C<< ->offs[num].start >> or C<< ->offs[num].end >> is C<-1> then that
 714 capture group did not match. C<< ->offs[0].start/end >> represents C<$&> (or
 715 C<${^MATCH}> under C<//p>) and C<< ->offs[paren].end >> matches C<$$paren> where
 716 C<$paren >= 1>.
 717
 718 =head2 C<precomp> C<prelen>
 719
 720 Used for optimisations. C<precomp> holds a copy of the pattern that
 721 was compiled and C<prelen> its length. When a new pattern is to be
 722 compiled (such as inside a loop) the internal C<regcomp> operator
 723 checks if the last compiled C<REGEXP>'s C<precomp> and C<prelen>
 724 are equivalent to the new one, and if so uses the old pattern instead
 725 of compiling a new one.
 726
 727 The relevant snippet from C<Perl_pp_regcomp>:
 728
 729         if (!re || !re->precomp || re->prelen != (I32)len ||
 730             memNE(re->precomp, t, len))
 731         /* Compile a new pattern */
 732
 733 =head2 C<paren_names>
 734
 735 This is a hash used internally to track named capture groups and their
 736 offsets. The keys are the names of the buffers the values are dualvars,
 737 with the IV slot holding the number of buffers with the given name and the
 738 pv being an embedded array of I32.  The values may also be contained
 739 independently in the data array in cases where named backreferences are
 740 used.
 741
 742 =head2 C<substrs>
 743
 744 Holds information on the longest string that must occur at a fixed
 745 offset from the start of the pattern, and the longest string that must
 746 occur at a floating offset from the start of the pattern. Used to do
 747 Fast-Boyer-Moore searches on the string to find out if its worth using
 748 the regex engine at all, and if so where in the string to search.
 749
 750 =head2 C<subbeg> C<sublen> C<saved_copy> C<suboffset> C<subcoffset>
 751
 752 Used during the execution phase for managing search and replace patterns,
 753 and for providing the text for C<$&>, C<$1> etc. C<subbeg> points to a
 754 buffer (either the original string, or a copy in the case of
 755 C<RX_MATCH_COPIED(rx)>), and C<sublen> is the length of the buffer.  The
 756 C<RX_OFFS> start and end indices index into this buffer.
 757
 758 In the presence of the C<REXEC_COPY_STR> flag, but with the addition of
 759 the C<REXEC_COPY_SKIP_PRE> or C<REXEC_COPY_SKIP_POST> flags, an engine
 760 can choose not to copy the full buffer (although it must still do so in
 761 the presence of C<RXf_PMf_KEEPCOPY> or the relevant bits being set in
 762 C<PL_sawampersand>). In this case, it may set C<suboffset> to indicate the
 763 number of bytes from the logical start of the buffer to the physical start
 764 (i.e. C<subbeg>). It should also set C<subcoffset>, the number of
 765 characters in the offset. The latter is needed to support C<@-> and C<@+>
 766 which work in characters, not bytes.
 767
 768 =head2 C<wrapped> C<wraplen>
 769
 770 Stores the string C<qr//> stringifies to. The Perl engine for example
 771 stores C<(?^:eek)> in the case of C<qr/eek/>.
 772
 773 When using a custom engine that doesn't support the C<(?:)> construct
 774 for inline modifiers, it's probably best to have C<qr//> stringify to
 775 the supplied pattern, note that this will create undesired patterns in
 776 cases such as:
 777
 778     my $x = qr/a|b/;  # "a|b"
 779     my $y = qr/c/i;   # "c"
 780     my $z = qr/$x$y/; # "a|bc"
 781
 782 There's no solution for this problem other than making the custom
 783 engine understand a construct like C<(?:)>.
 784
 785 =head2 C<seen_evals>
 786
 787 This stores the number of eval groups in the pattern. This is used for security
 788 purposes when embedding compiled regexes into larger patterns with C<qr//>.
 789
 790 =head2 C<refcnt>
 791
 792 The number of times the structure is referenced. When this falls to 0, the
 793 regexp is automatically freed by a call to pregfree. This should be set to 1 in
 794 each engine's L</comp> routine.
 795
 796 =head1 HISTORY
 797
 798 Originally part of L<perlreguts>.
 799
 800 =head1 AUTHORS
 801
 802 Originally written by Yves Orton, expanded by E<AElig>var ArnfjE<ouml>rE<eth>
 803 Bjarmason.
 804
 805 =head1 LICENSE
 806
 807 Copyright 2006 Yves Orton and 2007 E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason.
 808
 809 This program is free software; you can redistribute it and/or modify it under
 810 the same terms as Perl itself.
 811
 812 =cut