inline_invlist.c

   1 /*    inline_invlist.c
   2  *
   3  *    Copyright (C) 2012 by Larry Wall and others
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  */
   8
   9 #if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
  10
  11 #define INVLIST_LEN_OFFSET 0    /* Number of elements in the inversion list */
  12 #define INVLIST_ITER_OFFSET 1   /* Current iteration position */
  13 #define INVLIST_PREVIOUS_INDEX_OFFSET 2  /* Place to cache index of previous
  14                                             result */
  15
  16 /* This is a combination of a version and data structure type, so that one
  17  * being passed in can be validated to be an inversion list of the correct
  18  * vintage.  When the structure of the header is changed, a new random number
  19  * in the range 2**31-1 should be generated and the new() method changed to
  20  * insert that at this location.  Then, if an auxiliary program doesn't change
  21  * correspondingly, it will be discovered immediately */
  22 #define INVLIST_VERSION_ID_OFFSET 3
  23 #define INVLIST_VERSION_ID 290655244
  24
  25 /* For safety, when adding new elements, remember to #undef them at the end of
  26  * the inversion list code section */
  27
  28 #define INVLIST_ZERO_OFFSET 4   /* 0 or 1; must be last element in header */
  29 /* The UV at position ZERO contains either 0 or 1.  If 0, the inversion list
  30  * contains the code point U+00000, and begins here.  If 1, the inversion list
  31  * doesn't contain U+0000, and it begins at the next UV in the array.
  32  * Inverting an inversion list consists of adding or removing the 0 at the
  33  * beginning of it.  By reserving a space for that 0, inversion can be made
  34  * very fast */
  35
  36 #define HEADER_LENGTH (INVLIST_ZERO_OFFSET + 1)
  37
  38 /* An element is in an inversion list iff its index is even numbered: 0, 2, 4,
  39  * etc */
  40 #define ELEMENT_RANGE_MATCHES_INVLIST(i) (! ((i) & 1))
  41 #define PREV_RANGE_MATCHES_INVLIST(i) (! ELEMENT_RANGE_MATCHES_INVLIST(i))
  42
  43 PERL_STATIC_INLINE UV*
  44 S__get_invlist_len_addr(pTHX_ SV* invlist)
  45 {
  46     /* Return the address of the UV that contains the current number
  47      * of used elements in the inversion list */
  48
  49     PERL_ARGS_ASSERT__GET_INVLIST_LEN_ADDR;
  50
  51     return (UV *) (SvPVX(invlist) + (INVLIST_LEN_OFFSET * sizeof (UV)));
  52 }
  53
  54 PERL_STATIC_INLINE UV
  55 S__invlist_len(pTHX_ SV* const invlist)
  56 {
  57     /* Returns the current number of elements stored in the inversion list's
  58      * array */
  59
  60     PERL_ARGS_ASSERT__INVLIST_LEN;
  61
  62     return *_get_invlist_len_addr(invlist);
  63 }
  64
  65 PERL_STATIC_INLINE bool
  66 S__invlist_contains_cp(pTHX_ SV* const invlist, const UV cp)
  67 {
  68     /* Does <invlist> contain code point <cp> as part of the set? */
  69
  70     IV index = _invlist_search(invlist, cp);
  71
  72     PERL_ARGS_ASSERT__INVLIST_CONTAINS_CP;
  73
  74     return index >= 0 && ELEMENT_RANGE_MATCHES_INVLIST(index);
  75 }
  76
  77 #endif