X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/3ab4a224eb8d34c041977288575d251ee18f009f..192b9cd13b3ba000f1d0a2d32c141b9513be7936:/regexp.h

diff --git a/regexp.h b/regexp.h
index 33e7c20..1353a92 100644
--- a/regexp.h
+++ b/regexp.h
@@ -55,8 +55,17 @@ typedef struct regexp_paren_pair {
     I32 end;
 } regexp_paren_pair;
 
-/* this is ordered such that the most commonly used 
-   fields are at the start of the struct */
+/*
+  The regexp/REGEXP struct, see L<perlreapi> for further documentation
+  on the individual fields. The struct is ordered so that the most
+  commonly used fields are placed at the start.
+
+  Any patch that adds items to this struct will need to include
+  changes to F<sv.c> (C<Perl_re_dup()>) and F<regcomp.c>
+  (C<pregfree()>). This involves freeing or cloning items in the
+  regexp's data array based on the data item's type.
+*/
+
 typedef struct regexp {
         /* what engine created this regexp? */
 	const struct regexp_engine* engine; 
@@ -113,22 +122,65 @@ typedef struct re_scream_pos_data_s
  */
 typedef struct regexp_engine {
     REGEXP* (*comp) (pTHX_ const SV * const pattern, const U32 flags);
-    I32	    (*exec) (pTHX_ regexp* prog, char* stringarg, char* strend,
-			    char* strbeg, I32 minend, SV* screamer,
-			    void* data, U32 flags);
-    char*   (*intuit) (pTHX_ regexp *prog, SV *sv, char *strpos,
-			    char *strend, U32 flags,
-			    struct re_scream_pos_data_s *data);
-    SV*	    (*checkstr) (pTHX_ regexp *prog);
-    void    (*free) (pTHX_ struct regexp* r);
-    SV*     (*numbered_buff_get) (pTHX_ const REGEXP * const rx, I32 paren, SV* usesv);
-    SV*     (*named_buff_get)(pTHX_ const REGEXP * const rx, SV* namesv, U32 flags);
-    SV*     (*qr_pkg)(pTHX_ const REGEXP * const rx);
+    I32     (*exec) (pTHX_ REGEXP * const rx, char* stringarg, char* strend,
+                     char* strbeg, I32 minend, SV* screamer,
+                     void* data, U32 flags);
+    char*   (*intuit) (pTHX_ REGEXP * const rx, SV *sv, char *strpos,
+                       char *strend, const U32 flags,
+                       re_scream_pos_data *data);
+    SV*     (*checkstr) (pTHX_ REGEXP * const rx);
+    void    (*free) (pTHX_ REGEXP * const rx);
+    void    (*numbered_buff_FETCH) (pTHX_ REGEXP * const rx, const I32 paren,
+                                    SV * const sv);
+    void    (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
+                                   SV const * const value);
+    I32     (*numbered_buff_LENGTH) (pTHX_ REGEXP * const rx, const SV * const sv,
+                                    const I32 paren);
+    SV*     (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
+                           SV * const value, const U32 flags);
+    SV*     (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
+                                const U32 flags);
+    SV*     (*qr_package)(pTHX_ REGEXP * const rx);
 #ifdef USE_ITHREADS
-    void* (*dupe) (pTHX_ const regexp *r, CLONE_PARAMS *param);
-#endif    
+    void*   (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);
+#endif
 } regexp_engine;
 
+/*
+  These are passed to the numbered capture variable callbacks as the
+  paren name. >= 1 is reserved for actual numbered captures, i.e. $1,
+  $2 etc.
+*/
+#define RXf_PREMATCH  -2 /* $` / ${^PREMATCH}  */
+#define RXf_POSTMATCH -1 /* $' / ${^POSTMATCH} */
+#define RXf_MATCH      0 /* $& / ${^MATCH}     */
+
+/*
+  Flags that are passed to the named_buff and named_buff_iter
+  callbacks above. Those routines are called from universal.c via the
+  Tie::Hash::NamedCapture interface for %+ and %- and the re::
+  functions in the same file.
+*/
+
+/* The Tie::Hash::NamedCapture operation this is part of, if any */
+#define RXf_HASH_FETCH     0x0001
+#define RXf_HASH_STORE     0x0002
+#define RXf_HASH_DELETE    0x0004
+#define RXf_HASH_CLEAR     0x0008
+#define RXf_HASH_EXISTS    0x0010
+#define RXf_HASH_SCALAR    0x0020
+#define RXf_HASH_FIRSTKEY  0x0040
+#define RXf_HASH_NEXTKEY   0x0080
+
+/* Whether %+ or %- is being operated on */
+#define RXf_HASH_ONE       0x0100 /* %+ */
+#define RXf_HASH_ALL       0x0200 /* %- */
+
+/* Whether this is being called from a re:: function */
+#define RXf_HASH_REGNAME         0x0400
+#define RXf_HASH_REGNAMES        0x0800
+#define RXf_HASH_REGNAMES_COUNT  0x1000 
+
 /* Flags stored in regexp->extflags 
  * These are used by code external to the regexp engine
  *