op_reg_common.h

   1 /*    op_reg_common.h
   2  *
   3  *    Definitions common to by op.h and regexp.h
   4  *
   5  *    Copyright (C) 2010 by Larry Wall and others
   6  *
   7  *    You may distribute under the terms of either the GNU General Public
   8  *    License or the Artistic License, as specified in the README file.
   9  *
  10  */
  11
  12 /* These defines are used in both op.h and regexp.h  The definitions use the
  13  * shift form so that ext/B/defsubs_h.PL will pick them up.
  14  *
  15  * Data structures used in the two headers have common fields, and in fact one
  16  * is copied onto the other.  This makes it easy to keep them in sync */
  17
  18 /* This tells where the first of these bits is.  Setting it to 0 saved cycles
  19  * and memory.  I (khw) think the code will work if changed back, but haven't
  20  * tested it */
  21 #define RXf_PMf_STD_PMMOD_SHIFT 0
  22
  23 /* The bits need to be ordered so that the msix are contiguous starting at bit
  24  * RXf_PMf_STD_PMMOD_SHIFT, followed by the p.  See STD_PAT_MODS and
  25  * INT_PAT_MODS in regexp.h for the reason contiguity is needed */
  26 #define RXf_PMf_MULTILINE      (1 << (RXf_PMf_STD_PMMOD_SHIFT+0))    /* /m */
  27 #define RXf_PMf_SINGLELINE     (1 << (RXf_PMf_STD_PMMOD_SHIFT+1))    /* /s */
  28 #define RXf_PMf_FOLD           (1 << (RXf_PMf_STD_PMMOD_SHIFT+2))    /* /i */
  29 #define RXf_PMf_EXTENDED       (1 << (RXf_PMf_STD_PMMOD_SHIFT+3))    /* /x */
  30 #define RXf_PMf_KEEPCOPY       (1 << (RXf_PMf_STD_PMMOD_SHIFT+4))    /* /p */
  31 #define RXf_PMf_LOCALE         (1 << (RXf_PMf_STD_PMMOD_SHIFT+5))
  32
  33 /* Next available bit after the above.  Name begins with '_' so won't be
  34  * exported by B */
  35 #define _RXf_PMf_SHIFT_NEXT (RXf_PMf_STD_PMMOD_SHIFT+6)
  36
  37 /* Mask of the above bits.  These need to be transferred from op_pmflags to
  38  * re->extflags during compilation */
  39 #define RXf_PMf_COMPILETIME    (RXf_PMf_MULTILINE|RXf_PMf_SINGLELINE|RXf_PMf_LOCALE|RXf_PMf_FOLD|RXf_PMf_EXTENDED|RXf_PMf_KEEPCOPY)
  40
  41 /* These copies need to be numerical or defsubs_h.PL won't know about them. */
  42 #define PMf_MULTILINE    1<<0
  43 #define PMf_SINGLELINE   1<<1
  44 #define PMf_FOLD         1<<2
  45 #define PMf_EXTENDED     1<<3
  46 #define PMf_KEEPCOPY     1<<4
  47 #define PMf_LOCALE       1<<5
  48
  49 #if PMf_MULTILINE != RXf_PMf_MULTILINE || PMf_SINGLELINE != RXf_PMf_SINGLELINE || PMf_FOLD != RXf_PMf_FOLD || PMf_EXTENDED != RXf_PMf_EXTENDED || PMf_KEEPCOPY != RXf_PMf_KEEPCOPY || PMf_LOCALE != RXf_PMf_LOCALE
  50 #   error RXf_PMf defines are wrong
  51 #endif
  52
  53 #define PMf_COMPILETIME RXf_PMf_COMPILETIME
  54
  55 /*  Error check that haven't left something out of this.  This isn't done
  56  *  directly in the #define because doing so confuses regcomp.pl.
  57  *  (2**n - 1) is n 1 bits, so the below gets the contiguous bits between the
  58  *  beginning and ending shifts */
  59 #if RXf_PMf_COMPILETIME != (((1 << (_RXf_PMf_SHIFT_NEXT))-1) \
  60                             & (~((1 << RXf_PMf_STD_PMMOD_SHIFT)-1)))
  61 #   error RXf_PMf_COMPILETIME is invalid
  62 #endif