LCOV - differential code coverage report
Current view: top level - src/backend/utils/adt - regexp.c (source / functions) Coverage Total Hit UBC GBC CBC
Current: Differential Code Coverage 16@8cea358b128 vs 17@8cea358b128 Lines: 90.3 % 649 586 63 6 580
Current Date: 2024-04-14 14:21:10 Functions: 98.0 % 51 50 1 50
Baseline: 16@8cea358b128 Branches: 64.9 % 513 333 180 7 326
Baseline Date: 2024-04-14 14:21:09 Line coverage date bins:
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed (240..) days: 90.3 % 649 586 63 6 580
Function coverage date bins:
(240..) days: 98.0 % 51 50 1 50
Branch coverage date bins:
(240..) days: 64.9 % 513 333 180 7 326

 Age         Owner                    Branch data    TLA  Line data    Source code
                                  1                 :                : /*-------------------------------------------------------------------------
                                  2                 :                :  *
                                  3                 :                :  * regexp.c
                                  4                 :                :  *    Postgres' interface to the regular expression package.
                                  5                 :                :  *
                                  6                 :                :  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
                                  7                 :                :  * Portions Copyright (c) 1994, Regents of the University of California
                                  8                 :                :  *
                                  9                 :                :  *
                                 10                 :                :  * IDENTIFICATION
                                 11                 :                :  *    src/backend/utils/adt/regexp.c
                                 12                 :                :  *
                                 13                 :                :  *      Alistair Crooks added the code for the regex caching
                                 14                 :                :  *      agc - cached the regular expressions used - there's a good chance
                                 15                 :                :  *      that we'll get a hit, so this saves a compile step for every
                                 16                 :                :  *      attempted match. I haven't actually measured the speed improvement,
                                 17                 :                :  *      but it `looks' a lot quicker visually when watching regression
                                 18                 :                :  *      test output.
                                 19                 :                :  *
                                 20                 :                :  *      agc - incorporated Keith Bostic's Berkeley regex code into
                                 21                 :                :  *      the tree for all ports. To distinguish this regex code from any that
                                 22                 :                :  *      is existent on a platform, I've prepended the string "pg_" to
                                 23                 :                :  *      the functions regcomp, regerror, regexec and regfree.
                                 24                 :                :  *      Fixed a bug that was originally a typo by me, where `i' was used
                                 25                 :                :  *      instead of `oldest' when compiling regular expressions - benign
                                 26                 :                :  *      results mostly, although occasionally it bit you...
                                 27                 :                :  *
                                 28                 :                :  *-------------------------------------------------------------------------
                                 29                 :                :  */
                                 30                 :                : #include "postgres.h"
                                 31                 :                : 
                                 32                 :                : #include "catalog/pg_type.h"
                                 33                 :                : #include "funcapi.h"
                                 34                 :                : #include "regex/regex.h"
                                 35                 :                : #include "utils/array.h"
                                 36                 :                : #include "utils/builtins.h"
                                 37                 :                : #include "utils/memutils.h"
                                 38                 :                : #include "utils/varlena.h"
                                 39                 :                : 
                                 40                 :                : #define PG_GETARG_TEXT_PP_IF_EXISTS(_n) \
                                 41                 :                :     (PG_NARGS() > (_n) ? PG_GETARG_TEXT_PP(_n) : NULL)
                                 42                 :                : 
                                 43                 :                : 
                                 44                 :                : /* all the options of interest for regex functions */
                                 45                 :                : typedef struct pg_re_flags
                                 46                 :                : {
                                 47                 :                :     int         cflags;         /* compile flags for Spencer's regex code */
                                 48                 :                :     bool        glob;           /* do it globally (for each occurrence) */
                                 49                 :                : } pg_re_flags;
                                 50                 :                : 
                                 51                 :                : /* cross-call state for regexp_match and regexp_split functions */
                                 52                 :                : typedef struct regexp_matches_ctx
                                 53                 :                : {
                                 54                 :                :     text       *orig_str;       /* data string in original TEXT form */
                                 55                 :                :     int         nmatches;       /* number of places where pattern matched */
                                 56                 :                :     int         npatterns;      /* number of capturing subpatterns */
                                 57                 :                :     /* We store start char index and end+1 char index for each match */
                                 58                 :                :     /* so the number of entries in match_locs is nmatches * npatterns * 2 */
                                 59                 :                :     int        *match_locs;     /* 0-based character indexes */
                                 60                 :                :     int         next_match;     /* 0-based index of next match to process */
                                 61                 :                :     /* workspace for build_regexp_match_result() */
                                 62                 :                :     Datum      *elems;          /* has npatterns elements */
                                 63                 :                :     bool       *nulls;          /* has npatterns elements */
                                 64                 :                :     pg_wchar   *wide_str;       /* wide-char version of original string */
                                 65                 :                :     char       *conv_buf;       /* conversion buffer, if needed */
                                 66                 :                :     int         conv_bufsiz;    /* size thereof */
                                 67                 :                : } regexp_matches_ctx;
                                 68                 :                : 
                                 69                 :                : /*
                                 70                 :                :  * We cache precompiled regular expressions using a "self organizing list"
                                 71                 :                :  * structure, in which recently-used items tend to be near the front.
                                 72                 :                :  * Whenever we use an entry, it's moved up to the front of the list.
                                 73                 :                :  * Over time, an item's average position corresponds to its frequency of use.
                                 74                 :                :  *
                                 75                 :                :  * When we first create an entry, it's inserted at the front of
                                 76                 :                :  * the array, dropping the entry at the end of the array if necessary to
                                 77                 :                :  * make room.  (This might seem to be weighting the new entry too heavily,
                                 78                 :                :  * but if we insert new entries further back, we'll be unable to adjust to
                                 79                 :                :  * a sudden shift in the query mix where we are presented with MAX_CACHED_RES
                                 80                 :                :  * never-before-seen items used circularly.  We ought to be able to handle
                                 81                 :                :  * that case, so we have to insert at the front.)
                                 82                 :                :  *
                                 83                 :                :  * Knuth mentions a variant strategy in which a used item is moved up just
                                 84                 :                :  * one place in the list.  Although he says this uses fewer comparisons on
                                 85                 :                :  * average, it seems not to adapt very well to the situation where you have
                                 86                 :                :  * both some reusable patterns and a steady stream of non-reusable patterns.
                                 87                 :                :  * A reusable pattern that isn't used at least as often as non-reusable
                                 88                 :                :  * patterns are seen will "fail to keep up" and will drop off the end of the
                                 89                 :                :  * cache.  With move-to-front, a reusable pattern is guaranteed to stay in
                                 90                 :                :  * the cache as long as it's used at least once in every MAX_CACHED_RES uses.
                                 91                 :                :  */
                                 92                 :                : 
                                 93                 :                : /* this is the maximum number of cached regular expressions */
                                 94                 :                : #ifndef MAX_CACHED_RES
                                 95                 :                : #define MAX_CACHED_RES  32
                                 96                 :                : #endif
                                 97                 :                : 
                                 98                 :                : /* A parent memory context for regular expressions. */
                                 99                 :                : static MemoryContext RegexpCacheMemoryContext;
                                100                 :                : 
                                101                 :                : /* this structure describes one cached regular expression */
                                102                 :                : typedef struct cached_re_str
                                103                 :                : {
                                104                 :                :     MemoryContext cre_context;  /* memory context for this regexp */
                                105                 :                :     char       *cre_pat;        /* original RE (not null terminated!) */
                                106                 :                :     int         cre_pat_len;    /* length of original RE, in bytes */
                                107                 :                :     int         cre_flags;      /* compile flags: extended,icase etc */
                                108                 :                :     Oid         cre_collation;  /* collation to use */
                                109                 :                :     regex_t     cre_re;         /* the compiled regular expression */
                                110                 :                : } cached_re_str;
                                111                 :                : 
                                112                 :                : static int  num_res = 0;        /* # of cached re's */
                                113                 :                : static cached_re_str re_array[MAX_CACHED_RES];  /* cached re's */
                                114                 :                : 
                                115                 :                : 
                                116                 :                : /* Local functions */
                                117                 :                : static regexp_matches_ctx *setup_regexp_matches(text *orig_str, text *pattern,
                                118                 :                :                                                 pg_re_flags *re_flags,
                                119                 :                :                                                 int start_search,
                                120                 :                :                                                 Oid collation,
                                121                 :                :                                                 bool use_subpatterns,
                                122                 :                :                                                 bool ignore_degenerate,
                                123                 :                :                                                 bool fetching_unmatched);
                                124                 :                : static ArrayType *build_regexp_match_result(regexp_matches_ctx *matchctx);
                                125                 :                : static Datum build_regexp_split_result(regexp_matches_ctx *splitctx);
                                126                 :                : 
                                127                 :                : 
                                128                 :                : /*
                                129                 :                :  * RE_compile_and_cache - compile a RE, caching if possible
                                130                 :                :  *
                                131                 :                :  * Returns regex_t *
                                132                 :                :  *
                                133                 :                :  *  text_re --- the pattern, expressed as a TEXT object
                                134                 :                :  *  cflags --- compile options for the pattern
                                135                 :                :  *  collation --- collation to use for LC_CTYPE-dependent behavior
                                136                 :                :  *
                                137                 :                :  * Pattern is given in the database encoding.  We internally convert to
                                138                 :                :  * an array of pg_wchar, which is what Spencer's regex package wants.
                                139                 :                :  */
                                140                 :                : regex_t *
 4753 tgl@sss.pgh.pa.us         141                 :CBC      509144 : RE_compile_and_cache(text *text_re, int cflags, Oid collation)
                                142                 :                : {
 6050                           143   [ -  +  -  -  :         509144 :     int         text_re_len = VARSIZE_ANY_EXHDR(text_re);
                                     -  -  -  -  +  
                                                 + ]
                                144         [ +  + ]:         509144 :     char       *text_re_val = VARDATA_ANY(text_re);
                                145                 :                :     pg_wchar   *pattern;
                                146                 :                :     int         pattern_len;
                                147                 :                :     int         i;
                                148                 :                :     int         regcomp_result;
                                149                 :                :     cached_re_str re_temp;
                                150                 :                :     char        errMsg[100];
                                151                 :                :     MemoryContext oldcontext;
                                152                 :                : 
                                153                 :                :     /*
                                154                 :                :      * Look for a match among previously compiled REs.  Since the data
                                155                 :                :      * structure is self-organizing with most-used entries at the front, our
                                156                 :                :      * search strategy can just be to scan from the front.
                                157                 :                :      */
 7739                           158         [ +  + ]:         782065 :     for (i = 0; i < num_res; i++)
                                159                 :                :     {
 6050                           160         [ +  + ]:         779367 :         if (re_array[i].cre_pat_len == text_re_len &&
                                161         [ +  + ]:         513098 :             re_array[i].cre_flags == cflags &&
 4753                           162         [ +  + ]:         512496 :             re_array[i].cre_collation == collation &&
 6050                           163         [ +  + ]:         512414 :             memcmp(re_array[i].cre_pat, text_re_val, text_re_len) == 0)
                                164                 :                :         {
                                165                 :                :             /*
                                166                 :                :              * Found a match; move it to front if not there already.
                                167                 :                :              */
 7739                           168         [ +  + ]:         506446 :             if (i > 0)
                                169                 :                :             {
                                170                 :         227977 :                 re_temp = re_array[i];
                                171                 :         227977 :                 memmove(&re_array[1], &re_array[0], i * sizeof(cached_re_str));
                                172                 :         227977 :                 re_array[0] = re_temp;
                                173                 :                :             }
                                174                 :                : 
 6753                           175                 :         506446 :             return &re_array[0].cre_re;
                                176                 :                :         }
                                177                 :                :     }
                                178                 :                : 
                                179                 :                :     /* Set up the cache memory on first go through. */
  372 tmunro@postgresql.or      180         [ +  + ]:           2698 :     if (unlikely(RegexpCacheMemoryContext == NULL))
                                181                 :            635 :         RegexpCacheMemoryContext =
                                182                 :            635 :             AllocSetContextCreate(TopMemoryContext,
                                183                 :                :                                   "RegexpCacheMemoryContext",
                                184                 :                :                                   ALLOCSET_SMALL_SIZES);
                                185                 :                : 
                                186                 :                :     /*
                                187                 :                :      * Couldn't find it, so try to compile the new RE.  To avoid leaking
                                188                 :                :      * resources on failure, we build into the re_temp local.
                                189                 :                :      */
                                190                 :                : 
                                191                 :                :     /* Convert pattern string to wide characters */
 6050 tgl@sss.pgh.pa.us         192                 :           2698 :     pattern = (pg_wchar *) palloc((text_re_len + 1) * sizeof(pg_wchar));
                                193                 :           2698 :     pattern_len = pg_mb2wchar_with_len(text_re_val,
                                194                 :                :                                        pattern,
                                195                 :                :                                        text_re_len);
                                196                 :                : 
                                197                 :                :     /*
                                198                 :                :      * Make a memory context for this compiled regexp.  This is initially a
                                199                 :                :      * child of the current memory context, so it will be cleaned up
                                200                 :                :      * automatically if compilation is interrupted and throws an ERROR. We'll
                                201                 :                :      * re-parent it under the longer lived cache context if we make it to the
                                202                 :                :      * bottom of this function.
                                203                 :                :      */
  372 tmunro@postgresql.or      204                 :           2698 :     re_temp.cre_context = AllocSetContextCreate(CurrentMemoryContext,
                                205                 :                :                                                 "RegexpMemoryContext",
                                206                 :                :                                                 ALLOCSET_SMALL_SIZES);
                                207                 :           2698 :     oldcontext = MemoryContextSwitchTo(re_temp.cre_context);
                                208                 :                : 
 7739 tgl@sss.pgh.pa.us         209                 :           2698 :     regcomp_result = pg_regcomp(&re_temp.cre_re,
                                210                 :                :                                 pattern,
                                211                 :                :                                 pattern_len,
                                212                 :                :                                 cflags,
                                213                 :                :                                 collation);
                                214                 :                : 
                                215                 :           2686 :     pfree(pattern);
                                216                 :                : 
 7081                           217         [ +  + ]:           2686 :     if (regcomp_result != REG_OKAY)
                                218                 :                :     {
                                219                 :                :         /* re didn't compile (no need for pg_regfree, if so) */
 7739                           220                 :             18 :         pg_regerror(regcomp_result, &re_temp.cre_re, errMsg, sizeof(errMsg));
 7567                           221         [ +  - ]:             18 :         ereport(ERROR,
                                222                 :                :                 (errcode(ERRCODE_INVALID_REGULAR_EXPRESSION),
                                223                 :                :                  errmsg("invalid regular expression: %s", errMsg)));
                                224                 :                :     }
                                225                 :                : 
                                226                 :                :     /* Copy the pattern into the per-regexp memory context. */
  372 tmunro@postgresql.or      227                 :           2668 :     re_temp.cre_pat = palloc(text_re_len + 1);
                                228                 :           2668 :     memcpy(re_temp.cre_pat, text_re_val, text_re_len);
                                229                 :                : 
                                230                 :                :     /*
                                231                 :                :      * NUL-terminate it only for the benefit of the identifier used for the
                                232                 :                :      * memory context, visible in the pg_backend_memory_contexts view.
                                233                 :                :      */
                                234                 :           2668 :     re_temp.cre_pat[text_re_len] = 0;
                                235                 :           2668 :     MemoryContextSetIdentifier(re_temp.cre_context, re_temp.cre_pat);
                                236                 :                : 
 6050 tgl@sss.pgh.pa.us         237                 :           2668 :     re_temp.cre_pat_len = text_re_len;
 7739                           238                 :           2668 :     re_temp.cre_flags = cflags;
 4753                           239                 :           2668 :     re_temp.cre_collation = collation;
                                240                 :                : 
                                241                 :                :     /*
                                242                 :                :      * Okay, we have a valid new item in re_temp; insert it into the storage
                                243                 :                :      * array.  Discard last entry if needed.
                                244                 :                :      */
 7739                           245         [ +  + ]:           2668 :     if (num_res >= MAX_CACHED_RES)
                                246                 :                :     {
                                247                 :            387 :         --num_res;
                                248         [ -  + ]:            387 :         Assert(num_res < MAX_CACHED_RES);
                                249                 :                :         /* Delete the memory context holding the regexp and pattern. */
  372 tmunro@postgresql.or      250                 :            387 :         MemoryContextDelete(re_array[num_res].cre_context);
                                251                 :                :     }
                                252                 :                : 
                                253                 :                :     /* Re-parent the memory context to our long-lived cache context. */
                                254                 :           2668 :     MemoryContextSetParent(re_temp.cre_context, RegexpCacheMemoryContext);
                                255                 :                : 
 7739 tgl@sss.pgh.pa.us         256         [ +  + ]:           2668 :     if (num_res > 0)
                                257                 :           2033 :         memmove(&re_array[1], &re_array[0], num_res * sizeof(cached_re_str));
                                258                 :                : 
                                259                 :           2668 :     re_array[0] = re_temp;
                                260                 :           2668 :     num_res++;
                                261                 :                : 
  372 tmunro@postgresql.or      262                 :           2668 :     MemoryContextSwitchTo(oldcontext);
                                263                 :                : 
 6753 tgl@sss.pgh.pa.us         264                 :           2668 :     return &re_array[0].cre_re;
                                265                 :                : }
                                266                 :                : 
                                267                 :                : /*
                                268                 :                :  * RE_wchar_execute - execute a RE on pg_wchar data
                                269                 :                :  *
                                270                 :                :  * Returns true on match, false on no match
                                271                 :                :  *
                                272                 :                :  *  re --- the compiled pattern as returned by RE_compile_and_cache
                                273                 :                :  *  data --- the data to match against (need not be null-terminated)
                                274                 :                :  *  data_len --- the length of the data string
                                275                 :                :  *  start_search -- the offset in the data to start searching
                                276                 :                :  *  nmatch, pmatch  --- optional return area for match details
                                277                 :                :  *
                                278                 :                :  * Data is given as array of pg_wchar which is what Spencer's regex package
                                279                 :                :  * wants.
                                280                 :                :  */
                                281                 :                : static bool
 6235 neilc@samurai.com         282                 :         942198 : RE_wchar_execute(regex_t *re, pg_wchar *data, int data_len,
                                283                 :                :                  int start_search, int nmatch, regmatch_t *pmatch)
                                284                 :                : {
                                285                 :                :     int         regexec_result;
                                286                 :                :     char        errMsg[100];
                                287                 :                : 
                                288                 :                :     /* Perform RE match and return result */
 6753 tgl@sss.pgh.pa.us         289                 :         942198 :     regexec_result = pg_regexec(re,
                                290                 :                :                                 data,
                                291                 :                :                                 data_len,
                                292                 :                :                                 start_search,
                                293                 :                :                                 NULL,   /* no details */
                                294                 :                :                                 nmatch,
                                295                 :                :                                 pmatch,
                                296                 :                :                                 0);
                                297                 :                : 
 7081                           298   [ +  +  -  + ]:         942198 :     if (regexec_result != REG_OKAY && regexec_result != REG_NOMATCH)
                                299                 :                :     {
                                300                 :                :         /* re failed??? */
 6753 tgl@sss.pgh.pa.us         301                 :UBC           0 :         pg_regerror(regexec_result, re, errMsg, sizeof(errMsg));
 7081                           302         [ #  # ]:              0 :         ereport(ERROR,
                                303                 :                :                 (errcode(ERRCODE_INVALID_REGULAR_EXPRESSION),
                                304                 :                :                  errmsg("regular expression failed: %s", errMsg)));
                                305                 :                :     }
                                306                 :                : 
 7081 tgl@sss.pgh.pa.us         307                 :CBC      942198 :     return (regexec_result == REG_OKAY);
                                308                 :                : }
                                309                 :                : 
                                310                 :                : /*
                                311                 :                :  * RE_execute - execute a RE
                                312                 :                :  *
                                313                 :                :  * Returns true on match, false on no match
                                314                 :                :  *
                                315                 :                :  *  re --- the compiled pattern as returned by RE_compile_and_cache
                                316                 :                :  *  dat --- the data to match against (need not be null-terminated)
                                317                 :                :  *  dat_len --- the length of the data string
                                318                 :                :  *  nmatch, pmatch  --- optional return area for match details
                                319                 :                :  *
                                320                 :                :  * Data is given in the database encoding.  We internally
                                321                 :                :  * convert to array of pg_wchar which is what Spencer's regex package wants.
                                322                 :                :  */
                                323                 :                : static bool
 6235 neilc@samurai.com         324                 :         394611 : RE_execute(regex_t *re, char *dat, int dat_len,
                                325                 :                :            int nmatch, regmatch_t *pmatch)
                                326                 :                : {
                                327                 :                :     pg_wchar   *data;
                                328                 :                :     int         data_len;
                                329                 :                :     bool        match;
                                330                 :                : 
                                331                 :                :     /* Convert data string to wide characters */
                                332                 :         394611 :     data = (pg_wchar *) palloc((dat_len + 1) * sizeof(pg_wchar));
                                333                 :         394611 :     data_len = pg_mb2wchar_with_len(dat, data, dat_len);
                                334                 :                : 
                                335                 :                :     /* Perform RE match and return result */
                                336                 :         394611 :     match = RE_wchar_execute(re, data, data_len, 0, nmatch, pmatch);
                                337                 :                : 
                                338                 :         394611 :     pfree(data);
                                339                 :         394611 :     return match;
                                340                 :                : }
                                341                 :                : 
                                342                 :                : /*
                                343                 :                :  * RE_compile_and_execute - compile and execute a RE
                                344                 :                :  *
                                345                 :                :  * Returns true on match, false on no match
                                346                 :                :  *
                                347                 :                :  *  text_re --- the pattern, expressed as a TEXT object
                                348                 :                :  *  dat --- the data to match against (need not be null-terminated)
                                349                 :                :  *  dat_len --- the length of the data string
                                350                 :                :  *  cflags --- compile options for the pattern
                                351                 :                :  *  collation --- collation to use for LC_CTYPE-dependent behavior
                                352                 :                :  *  nmatch, pmatch  --- optional return area for match details
                                353                 :                :  *
                                354                 :                :  * Both pattern and data are given in the database encoding.  We internally
                                355                 :                :  * convert to array of pg_wchar which is what Spencer's regex package wants.
                                356                 :                :  */
                                357                 :                : bool
                                358                 :         393815 : RE_compile_and_execute(text *text_re, char *dat, int dat_len,
                                359                 :                :                        int cflags, Oid collation,
                                360                 :                :                        int nmatch, regmatch_t *pmatch)
                                361                 :                : {
                                362                 :                :     regex_t    *re;
                                363                 :                : 
                                364                 :                :     /* Use REG_NOSUB if caller does not want sub-match details */
  979 tgl@sss.pgh.pa.us         365         [ +  - ]:         393815 :     if (nmatch < 2)
                                366                 :         393815 :         cflags |= REG_NOSUB;
                                367                 :                : 
                                368                 :                :     /* Compile RE */
 4753                           369                 :         393815 :     re = RE_compile_and_cache(text_re, cflags, collation);
                                370                 :                : 
 6235 neilc@samurai.com         371                 :         393803 :     return RE_execute(re, dat, dat_len, nmatch, pmatch);
                                372                 :                : }
                                373                 :                : 
                                374                 :                : 
                                375                 :                : /*
                                376                 :                :  * parse_re_flags - parse the options argument of regexp_match and friends
                                377                 :                :  *
                                378                 :                :  *  flags --- output argument, filled with desired options
                                379                 :                :  *  opts --- TEXT object, or NULL for defaults
                                380                 :                :  *
                                381                 :                :  * This accepts all the options allowed by any of the callers; callers that
                                382                 :                :  * don't want some have to reject them after the fact.
                                383                 :                :  */
                                384                 :                : static void
 5995 bruce@momjian.us          385                 :         103030 : parse_re_flags(pg_re_flags *flags, text *opts)
                                386                 :                : {
                                387                 :                :     /* regex flavor is always folded into the compile flags */
 5289 tgl@sss.pgh.pa.us         388                 :         103030 :     flags->cflags = REG_ADVANCED;
 6091                           389                 :         103030 :     flags->glob = false;
                                390                 :                : 
 6235 neilc@samurai.com         391         [ +  + ]:         103030 :     if (opts)
                                392                 :                :     {
 5995 bruce@momjian.us          393         [ -  + ]:           1436 :         char       *opt_p = VARDATA_ANY(opts);
                                394   [ -  +  -  -  :           1436 :         int         opt_len = VARSIZE_ANY_EXHDR(opts);
                                     -  -  -  -  -  
                                                 + ]
                                395                 :                :         int         i;
                                396                 :                : 
 6235 neilc@samurai.com         397         [ +  + ]:           3319 :         for (i = 0; i < opt_len; i++)
                                398                 :                :         {
                                399   [ +  -  +  -  :           1895 :             switch (opt_p[i])
                                     +  +  -  -  +  
                                        -  -  +  + ]
                                400                 :                :             {
                                401                 :           1275 :                 case 'g':
                                402                 :           1275 :                     flags->glob = true;
                                403                 :           1275 :                     break;
 5995 bruce@momjian.us          404                 :UBC           0 :                 case 'b':       /* BREs (but why???) */
 6091 tgl@sss.pgh.pa.us         405                 :              0 :                     flags->cflags &= ~(REG_ADVANCED | REG_EXTENDED | REG_QUOTE);
                                406                 :              0 :                     break;
 5995 bruce@momjian.us          407                 :CBC           5 :                 case 'c':       /* case sensitive */
 6091 tgl@sss.pgh.pa.us         408                 :              5 :                     flags->cflags &= ~REG_ICASE;
                                409                 :              5 :                     break;
 5995 bruce@momjian.us          410                 :UBC           0 :                 case 'e':       /* plain EREs */
 6091 tgl@sss.pgh.pa.us         411                 :              0 :                     flags->cflags |= REG_EXTENDED;
                                412                 :              0 :                     flags->cflags &= ~(REG_ADVANCED | REG_QUOTE);
                                413                 :              0 :                     break;
 5995 bruce@momjian.us          414                 :CBC         146 :                 case 'i':       /* case insensitive */
 6235 neilc@samurai.com         415                 :            146 :                     flags->cflags |= REG_ICASE;
                                416                 :            146 :                     break;
 5995 bruce@momjian.us          417                 :            448 :                 case 'm':       /* Perloid synonym for n */
                                418                 :                :                 case 'n':       /* \n affects ^ $ . [^ */
 6235 neilc@samurai.com         419                 :            448 :                     flags->cflags |= REG_NEWLINE;
                                420                 :            448 :                     break;
 5995 bruce@momjian.us          421                 :UBC           0 :                 case 'p':       /* ~Perl, \n affects . [^ */
 6235 neilc@samurai.com         422                 :              0 :                     flags->cflags |= REG_NLSTOP;
                                423                 :              0 :                     flags->cflags &= ~REG_NLANCH;
                                424                 :              0 :                     break;
 5995 bruce@momjian.us          425                 :              0 :                 case 'q':       /* literal string */
 6091 tgl@sss.pgh.pa.us         426                 :              0 :                     flags->cflags |= REG_QUOTE;
                                427                 :              0 :                     flags->cflags &= ~(REG_ADVANCED | REG_EXTENDED);
                                428                 :              0 :                     break;
 5995 bruce@momjian.us          429                 :CBC           6 :                 case 's':       /* single line, \n ordinary */
 6091 tgl@sss.pgh.pa.us         430                 :              6 :                     flags->cflags &= ~REG_NEWLINE;
                                431                 :              6 :                     break;
 5995 bruce@momjian.us          432                 :UBC           0 :                 case 't':       /* tight syntax */
 6091 tgl@sss.pgh.pa.us         433                 :              0 :                     flags->cflags &= ~REG_EXPANDED;
                                434                 :              0 :                     break;
 5995 bruce@momjian.us          435                 :              0 :                 case 'w':       /* weird, \n affects ^ $ only */
 6235 neilc@samurai.com         436                 :              0 :                     flags->cflags &= ~REG_NLSTOP;
                                437                 :              0 :                     flags->cflags |= REG_NLANCH;
                                438                 :              0 :                     break;
 5995 bruce@momjian.us          439                 :CBC           3 :                 case 'x':       /* expanded syntax */
 6235 neilc@samurai.com         440                 :              3 :                     flags->cflags |= REG_EXPANDED;
                                441                 :              3 :                     break;
                                442                 :             12 :                 default:
                                443         [ +  - ]:             12 :                     ereport(ERROR,
                                444                 :                :                             (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                                445                 :                :                              errmsg("invalid regular expression option: \"%.*s\"",
                                446                 :                :                                     pg_mblen(opt_p + i), opt_p + i)));
                                447                 :                :                     break;
                                448                 :                :             }
                                449                 :                :         }
                                450                 :                :     }
                                451                 :         103018 : }
                                452                 :                : 
                                453                 :                : 
                                454                 :                : /*
                                455                 :                :  *  interface routines called by the function manager
                                456                 :                :  */
                                457                 :                : 
                                458                 :                : Datum
 8683 tgl@sss.pgh.pa.us         459                 :         161722 : nameregexeq(PG_FUNCTION_ARGS)
                                460                 :                : {
                                461                 :         161722 :     Name        n = PG_GETARG_NAME(0);
 6050                           462                 :         161722 :     text       *p = PG_GETARG_TEXT_PP(1);
                                463                 :                : 
 7739                           464                 :         161722 :     PG_RETURN_BOOL(RE_compile_and_execute(p,
                                465                 :                :                                           NameStr(*n),
                                466                 :                :                                           strlen(NameStr(*n)),
                                467                 :                :                                           REG_ADVANCED,
                                468                 :                :                                           PG_GET_COLLATION(),
                                469                 :                :                                           0, NULL));
                                470                 :                : }
                                471                 :                : 
                                472                 :                : Datum
 8683                           473                 :          12721 : nameregexne(PG_FUNCTION_ARGS)
                                474                 :                : {
                                475                 :          12721 :     Name        n = PG_GETARG_NAME(0);
 6050                           476                 :          12721 :     text       *p = PG_GETARG_TEXT_PP(1);
                                477                 :                : 
 7739                           478                 :          12721 :     PG_RETURN_BOOL(!RE_compile_and_execute(p,
                                479                 :                :                                            NameStr(*n),
                                480                 :                :                                            strlen(NameStr(*n)),
                                481                 :                :                                            REG_ADVANCED,
                                482                 :                :                                            PG_GET_COLLATION(),
                                483                 :                :                                            0, NULL));
                                484                 :                : }
                                485                 :                : 
                                486                 :                : Datum
 8683                           487                 :         198431 : textregexeq(PG_FUNCTION_ARGS)
                                488                 :                : {
 6050                           489                 :         198431 :     text       *s = PG_GETARG_TEXT_PP(0);
                                490                 :         198431 :     text       *p = PG_GETARG_TEXT_PP(1);
                                491                 :                : 
 7739                           492   [ -  +  -  -  :         198431 :     PG_RETURN_BOOL(RE_compile_and_execute(p,
                                     -  -  -  -  +  
                                           +  +  + ]
                                493                 :                :                                           VARDATA_ANY(s),
                                494                 :                :                                           VARSIZE_ANY_EXHDR(s),
                                495                 :                :                                           REG_ADVANCED,
                                496                 :                :                                           PG_GET_COLLATION(),
                                497                 :                :                                           0, NULL));
                                498                 :                : }
                                499                 :                : 
                                500                 :                : Datum
 8683                           501                 :          17067 : textregexne(PG_FUNCTION_ARGS)
                                502                 :                : {
 6050                           503                 :          17067 :     text       *s = PG_GETARG_TEXT_PP(0);
                                504                 :          17067 :     text       *p = PG_GETARG_TEXT_PP(1);
                                505                 :                : 
 7739                           506   [ -  +  -  -  :          17067 :     PG_RETURN_BOOL(!RE_compile_and_execute(p,
                                     -  -  -  -  +  
                                           +  +  + ]
                                507                 :                :                                            VARDATA_ANY(s),
                                508                 :                :                                            VARSIZE_ANY_EXHDR(s),
                                509                 :                :                                            REG_ADVANCED,
                                510                 :                :                                            PG_GET_COLLATION(),
                                511                 :                :                                            0, NULL));
                                512                 :                : }
                                513                 :                : 
                                514                 :                : 
                                515                 :                : /*
                                516                 :                :  *  routines that use the regexp stuff, but ignore the case.
                                517                 :                :  *  for this, we use the REG_ICASE flag to pg_regcomp
                                518                 :                :  */
                                519                 :                : 
                                520                 :                : 
                                521                 :                : Datum
                                522                 :           3612 : nameicregexeq(PG_FUNCTION_ARGS)
                                523                 :                : {
                                524                 :           3612 :     Name        n = PG_GETARG_NAME(0);
 6050                           525                 :           3612 :     text       *p = PG_GETARG_TEXT_PP(1);
                                526                 :                : 
 7739                           527                 :           3612 :     PG_RETURN_BOOL(RE_compile_and_execute(p,
                                528                 :                :                                           NameStr(*n),
                                529                 :                :                                           strlen(NameStr(*n)),
                                530                 :                :                                           REG_ADVANCED | REG_ICASE,
                                531                 :                :                                           PG_GET_COLLATION(),
                                532                 :                :                                           0, NULL));
                                533                 :                : }
                                534                 :                : 
                                535                 :                : Datum
                                536                 :              3 : nameicregexne(PG_FUNCTION_ARGS)
                                537                 :                : {
                                538                 :              3 :     Name        n = PG_GETARG_NAME(0);
 6050                           539                 :              3 :     text       *p = PG_GETARG_TEXT_PP(1);
                                540                 :                : 
 7739                           541                 :              3 :     PG_RETURN_BOOL(!RE_compile_and_execute(p,
                                542                 :                :                                            NameStr(*n),
                                543                 :                :                                            strlen(NameStr(*n)),
                                544                 :                :                                            REG_ADVANCED | REG_ICASE,
                                545                 :                :                                            PG_GET_COLLATION(),
                                546                 :                :                                            0, NULL));
                                547                 :                : }
                                548                 :                : 
                                549                 :                : Datum
                                550                 :             98 : texticregexeq(PG_FUNCTION_ARGS)
                                551                 :                : {
 6050                           552                 :             98 :     text       *s = PG_GETARG_TEXT_PP(0);
                                553                 :             98 :     text       *p = PG_GETARG_TEXT_PP(1);
                                554                 :                : 
 7739                           555   [ -  +  -  -  :             98 :     PG_RETURN_BOOL(RE_compile_and_execute(p,
                                     -  -  -  -  +  
                                           +  +  + ]
                                556                 :                :                                           VARDATA_ANY(s),
                                557                 :                :                                           VARSIZE_ANY_EXHDR(s),
                                558                 :                :                                           REG_ADVANCED | REG_ICASE,
                                559                 :                :                                           PG_GET_COLLATION(),
                                560                 :                :                                           0, NULL));
                                561                 :                : }
                                562                 :                : 
                                563                 :                : Datum
                                564                 :             11 : texticregexne(PG_FUNCTION_ARGS)
                                565                 :                : {
 6050                           566                 :             11 :     text       *s = PG_GETARG_TEXT_PP(0);
                                567                 :             11 :     text       *p = PG_GETARG_TEXT_PP(1);
                                568                 :                : 
 7739                           569   [ -  +  -  -  :             11 :     PG_RETURN_BOOL(!RE_compile_and_execute(p,
                                     -  -  -  -  +  
                                           +  +  + ]
                                570                 :                :                                            VARDATA_ANY(s),
                                571                 :                :                                            VARSIZE_ANY_EXHDR(s),
                                572                 :                :                                            REG_ADVANCED | REG_ICASE,
                                573                 :                :                                            PG_GET_COLLATION(),
                                574                 :                :                                            0, NULL));
                                575                 :                : }
                                576                 :                : 
                                577                 :                : 
                                578                 :                : /*
                                579                 :                :  * textregexsubstr()
                                580                 :                :  *      Return a substring matched by a regular expression.
                                581                 :                :  */
                                582                 :                : Datum
 7978 lockhart@fourpalms.o      583                 :            808 : textregexsubstr(PG_FUNCTION_ARGS)
                                584                 :                : {
 6050 tgl@sss.pgh.pa.us         585                 :            808 :     text       *s = PG_GETARG_TEXT_PP(0);
                                586                 :            808 :     text       *p = PG_GETARG_TEXT_PP(1);
                                587                 :                :     regex_t    *re;
                                588                 :                :     regmatch_t  pmatch[2];
                                589                 :                :     int         so,
                                590                 :                :                 eo;
                                591                 :                : 
                                592                 :                :     /* Compile RE */
 4753                           593                 :            808 :     re = RE_compile_and_cache(p, REG_ADVANCED, PG_GET_COLLATION());
                                594                 :                : 
                                595                 :                :     /*
                                596                 :                :      * We pass two regmatch_t structs to get info about the overall match and
                                597                 :                :      * the match for the first parenthesized subexpression (if any). If there
                                598                 :                :      * is a parenthesized subexpression, we return what it matched; else
                                599                 :                :      * return what the whole regexp matched.
                                600                 :                :      */
 5870                           601         [ +  + ]:           1616 :     if (!RE_execute(re,
                                602   [ -  +  -  -  :           1616 :                     VARDATA_ANY(s), VARSIZE_ANY_EXHDR(s),
                                     -  -  -  -  -  
                                           +  -  + ]
                                603                 :                :                     2, pmatch))
                                604                 :              3 :         PG_RETURN_NULL();       /* definitely no match */
                                605                 :                : 
                                606         [ +  + ]:            805 :     if (re->re_nsub > 0)
                                607                 :                :     {
                                608                 :                :         /* has parenthesized subexpressions, use the first one */
 7875                           609                 :            761 :         so = pmatch[1].rm_so;
                                610                 :            761 :         eo = pmatch[1].rm_eo;
                                611                 :                :     }
                                612                 :                :     else
                                613                 :                :     {
                                614                 :                :         /* no parenthesized subexpression, use whole match */
 5870                           615                 :             44 :         so = pmatch[0].rm_so;
                                616                 :             44 :         eo = pmatch[0].rm_eo;
                                617                 :                :     }
                                618                 :                : 
                                619                 :                :     /*
                                620                 :                :      * It is possible to have a match to the whole pattern but no match for a
                                621                 :                :      * subexpression; for example 'foo(bar)?' is considered to match 'foo' but
                                622                 :                :      * there is no subexpression match.  So this extra test for match failure
                                623                 :                :      * is not redundant.
                                624                 :                :      */
                                625   [ +  +  -  + ]:            805 :     if (so < 0 || eo < 0)
                                626                 :              3 :         PG_RETURN_NULL();
                                627                 :                : 
                                628                 :            802 :     return DirectFunctionCall3(text_substr,
                                629                 :                :                                PointerGetDatum(s),
                                630                 :                :                                Int32GetDatum(so + 1),
                                631                 :                :                                Int32GetDatum(eo - so));
                                632                 :                : }
                                633                 :                : 
                                634                 :                : /*
                                635                 :                :  * textregexreplace_noopt()
                                636                 :                :  *      Return a string matched by a regular expression, with replacement.
                                637                 :                :  *
                                638                 :                :  * This version doesn't have an option argument: we default to case
                                639                 :                :  * sensitive match, replace the first instance only.
                                640                 :                :  */
                                641                 :                : Datum
 6853 bruce@momjian.us          642                 :           4344 : textregexreplace_noopt(PG_FUNCTION_ARGS)
                                643                 :                : {
 6050 tgl@sss.pgh.pa.us         644                 :           4344 :     text       *s = PG_GETARG_TEXT_PP(0);
                                645                 :           4344 :     text       *p = PG_GETARG_TEXT_PP(1);
                                646                 :           4344 :     text       *r = PG_GETARG_TEXT_PP(2);
                                647                 :                : 
  979                           648                 :           4344 :     PG_RETURN_TEXT_P(replace_text_regexp(s, p, r,
                                649                 :                :                                          REG_ADVANCED, PG_GET_COLLATION(),
                                650                 :                :                                          0, 1));
                                651                 :                : }
                                652                 :                : 
                                653                 :                : /*
                                654                 :                :  * textregexreplace()
                                655                 :                :  *      Return a string matched by a regular expression, with replacement.
                                656                 :                :  */
                                657                 :                : Datum
 6853 bruce@momjian.us          658                 :           1239 : textregexreplace(PG_FUNCTION_ARGS)
                                659                 :                : {
 6050 tgl@sss.pgh.pa.us         660                 :           1239 :     text       *s = PG_GETARG_TEXT_PP(0);
                                661                 :           1239 :     text       *p = PG_GETARG_TEXT_PP(1);
                                662                 :           1239 :     text       *r = PG_GETARG_TEXT_PP(2);
                                663                 :           1239 :     text       *opt = PG_GETARG_TEXT_PP(3);
                                664                 :                :     pg_re_flags flags;
                                665                 :                : 
                                666                 :                :     /*
                                667                 :                :      * regexp_replace() with four arguments will be preferentially resolved as
                                668                 :                :      * this form when the fourth argument is of type UNKNOWN.  However, the
                                669                 :                :      * user might have intended to call textregexreplace_extended_no_n.  If we
                                670                 :                :      * see flags that look like an integer, emit the same error that
                                671                 :                :      * parse_re_flags would, but add a HINT about how to fix it.
                                672                 :                :      */
  985                           673   [ -  +  -  -  :           1239 :     if (VARSIZE_ANY_EXHDR(opt) > 0)
                                     -  -  -  -  -  
                                           +  +  - ]
                                674                 :                :     {
                                675         [ -  + ]:           1239 :         char       *opt_p = VARDATA_ANY(opt);
                                676                 :                : 
                                677   [ +  -  +  + ]:           1239 :         if (*opt_p >= '0' && *opt_p <= '9')
                                678         [ +  - ]:              3 :             ereport(ERROR,
                                679                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                                680                 :                :                      errmsg("invalid regular expression option: \"%.*s\"",
                                681                 :                :                             pg_mblen(opt_p), opt_p),
                                682                 :                :                      errhint("If you meant to use regexp_replace() with a start parameter, cast the fourth argument to integer explicitly.")));
                                683                 :                :     }
                                684                 :                : 
 6091                           685                 :           1236 :     parse_re_flags(&flags, opt);
                                686                 :                : 
  979                           687                 :           1233 :     PG_RETURN_TEXT_P(replace_text_regexp(s, p, r,
                                688                 :                :                                          flags.cflags, PG_GET_COLLATION(),
                                689                 :                :                                          0, flags.glob ? 0 : 1));
                                690                 :                : }
                                691                 :                : 
                                692                 :                : /*
                                693                 :                :  * textregexreplace_extended()
                                694                 :                :  *      Return a string matched by a regular expression, with replacement.
                                695                 :                :  *      Extends textregexreplace by allowing a start position and the
                                696                 :                :  *      choice of the occurrence to replace (0 means all occurrences).
                                697                 :                :  */
                                698                 :                : Datum
  985                           699                 :             33 : textregexreplace_extended(PG_FUNCTION_ARGS)
                                700                 :                : {
                                701                 :             33 :     text       *s = PG_GETARG_TEXT_PP(0);
                                702                 :             33 :     text       *p = PG_GETARG_TEXT_PP(1);
                                703                 :             33 :     text       *r = PG_GETARG_TEXT_PP(2);
                                704                 :             33 :     int         start = 1;
                                705                 :             33 :     int         n = 1;
                                706         [ +  + ]:             33 :     text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(5);
                                707                 :                :     pg_re_flags re_flags;
                                708                 :                : 
                                709                 :                :     /* Collect optional parameters */
                                710         [ +  - ]:             33 :     if (PG_NARGS() > 3)
                                711                 :                :     {
                                712                 :             33 :         start = PG_GETARG_INT32(3);
                                713         [ +  + ]:             33 :         if (start <= 0)
                                714         [ +  - ]:              3 :             ereport(ERROR,
                                715                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                                716                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                                717                 :                :                             "start", start)));
                                718                 :                :     }
                                719         [ +  + ]:             30 :     if (PG_NARGS() > 4)
                                720                 :                :     {
                                721                 :             27 :         n = PG_GETARG_INT32(4);
                                722         [ +  + ]:             27 :         if (n < 0)
                                723         [ +  - ]:              3 :             ereport(ERROR,
                                724                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                                725                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                                726                 :                :                             "n", n)));
                                727                 :                :     }
                                728                 :                : 
                                729                 :                :     /* Determine options */
                                730                 :             27 :     parse_re_flags(&re_flags, flags);
                                731                 :                : 
                                732                 :                :     /* If N was not specified, deduce it from the 'g' flag */
                                733         [ +  + ]:             27 :     if (PG_NARGS() <= 4)
                                734                 :              3 :         n = re_flags.glob ? 0 : 1;
                                735                 :                : 
                                736                 :                :     /* Do the replacement(s) */
  979                           737                 :             27 :     PG_RETURN_TEXT_P(replace_text_regexp(s, p, r,
                                738                 :                :                                          re_flags.cflags, PG_GET_COLLATION(),
                                739                 :                :                                          start - 1, n));
                                740                 :                : }
                                741                 :                : 
                                742                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                                743                 :                : Datum
  985                           744                 :              3 : textregexreplace_extended_no_n(PG_FUNCTION_ARGS)
                                745                 :                : {
                                746                 :              3 :     return textregexreplace_extended(fcinfo);
                                747                 :                : }
                                748                 :                : 
                                749                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                                750                 :                : Datum
                                751                 :              3 : textregexreplace_extended_no_flags(PG_FUNCTION_ARGS)
                                752                 :                : {
                                753                 :              3 :     return textregexreplace_extended(fcinfo);
                                754                 :                : }
                                755                 :                : 
                                756                 :                : /*
                                757                 :                :  * similar_to_escape(), similar_escape()
                                758                 :                :  *
                                759                 :                :  * Convert a SQL "SIMILAR TO" regexp pattern to POSIX style, so it can be
                                760                 :                :  * used by our regexp engine.
                                761                 :                :  *
                                762                 :                :  * similar_escape_internal() is the common workhorse for three SQL-exposed
                                763                 :                :  * functions.  esc_text can be passed as NULL to select the default escape
                                764                 :                :  * (which is '\'), or as an empty string to select no escape character.
                                765                 :                :  */
                                766                 :                : static text *
 1681                           767                 :             69 : similar_escape_internal(text *pat_text, text *esc_text)
                                768                 :                : {
                                769                 :                :     text       *result;
                                770                 :                :     char       *p,
                                771                 :                :                *e,
                                772                 :                :                *r;
                                773                 :                :     int         plen,
                                774                 :                :                 elen;
 7875                           775                 :             69 :     bool        afterescape = false;
 5216                           776                 :             69 :     bool        incharclass = false;
 7875                           777                 :             69 :     int         nquotes = 0;
                                778                 :                : 
 6050                           779         [ -  + ]:             69 :     p = VARDATA_ANY(pat_text);
                                780   [ -  +  -  -  :             69 :     plen = VARSIZE_ANY_EXHDR(pat_text);
                                     -  -  -  -  -  
                                                 + ]
 1681                           781         [ +  + ]:             69 :     if (esc_text == NULL)
                                782                 :                :     {
                                783                 :                :         /* No ESCAPE clause provided; default to backslash as escape */
 7875                           784                 :             20 :         e = "\\";
                                785                 :             20 :         elen = 1;
                                786                 :                :     }
                                787                 :                :     else
                                788                 :                :     {
 6050                           789         [ -  + ]:             49 :         e = VARDATA_ANY(esc_text);
                                790   [ -  +  -  -  :             49 :         elen = VARSIZE_ANY_EXHDR(esc_text);
                                     -  -  -  -  -  
                                                 + ]
 7875                           791         [ +  + ]:             49 :         if (elen == 0)
                                792                 :              3 :             e = NULL;           /* no escape character */
 1681                           793         [ +  + ]:             46 :         else if (elen > 1)
                                794                 :                :         {
 3518 jdavis@postgresql.or      795                 :              3 :             int         escape_mblen = pg_mbstrlen_with_len(e, elen);
                                796                 :                : 
                                797         [ +  - ]:              3 :             if (escape_mblen > 1)
                                798         [ +  - ]:              3 :                 ereport(ERROR,
                                799                 :                :                         (errcode(ERRCODE_INVALID_ESCAPE_SEQUENCE),
                                800                 :                :                          errmsg("invalid escape string"),
                                801                 :                :                          errhint("Escape string must be empty or one character.")));
                                802                 :                :         }
                                803                 :                :     }
                                804                 :                : 
                                805                 :                :     /*----------
                                806                 :                :      * We surround the transformed input string with
                                807                 :                :      *          ^(?: ... )$
                                808                 :                :      * which requires some explanation.  We need "^" and "$" to force
                                809                 :                :      * the pattern to match the entire input string as per the SQL spec.
                                810                 :                :      * The "(?:" and ")" are a non-capturing set of parens; we have to have
                                811                 :                :      * parens in case the string contains "|", else the "^" and "$" will
                                812                 :                :      * be bound into the first and last alternatives which is not what we
                                813                 :                :      * want, and the parens must be non capturing because we don't want them
                                814                 :                :      * to count when selecting output for SUBSTRING.
                                815                 :                :      *
                                816                 :                :      * When the pattern is divided into three parts by escape-double-quotes,
                                817                 :                :      * what we emit is
                                818                 :                :      *          ^(?:part1){1,1}?(part2){1,1}(?:part3)$
                                819                 :                :      * which requires even more explanation.  The "{1,1}?" on part1 makes it
                                820                 :                :      * non-greedy so that it will match the smallest possible amount of text
                                821                 :                :      * not the largest, as required by SQL.  The plain parens around part2
                                822                 :                :      * are capturing parens so that that part is what controls the result of
                                823                 :                :      * SUBSTRING.  The "{1,1}" forces part2 to be greedy, so that it matches
                                824                 :                :      * the largest possible amount of text; hence part3 must match the
                                825                 :                :      * smallest amount of text, as required by SQL.  We don't need an explicit
                                826                 :                :      * greediness marker on part3.  Note that this also confines the effects
                                827                 :                :      * of any "|" characters to the respective part, which is what we want.
                                828                 :                :      *
                                829                 :                :      * The SQL spec says that SUBSTRING's pattern must contain exactly two
                                830                 :                :      * escape-double-quotes, but we only complain if there's more than two.
                                831                 :                :      * With none, we act as though part1 and part3 are empty; with one, we
                                832                 :                :      * act as though part3 is empty.  Both behaviors fall out of omitting
                                833                 :                :      * the relevant part separators in the above expansion.  If the result
                                834                 :                :      * of this function is used in a plain regexp match (SIMILAR TO), the
                                835                 :                :      * escape-double-quotes have no effect on the match behavior.
                                836                 :                :      *----------
                                837                 :                :      */
                                838                 :                : 
                                839                 :                :     /*
                                840                 :                :      * We need room for the prefix/postfix and part separators, plus as many
                                841                 :                :      * as 3 output bytes per input byte; since the input is at most 1GB this
                                842                 :                :      * can't overflow size_t.
                                843                 :                :      */
 1797 tgl@sss.pgh.pa.us         844                 :             66 :     result = (text *) palloc(VARHDRSZ + 23 + 3 * (size_t) plen);
 7875                           845                 :             66 :     r = VARDATA(result);
                                846                 :                : 
                                847                 :             66 :     *r++ = '^';
 6576                           848                 :             66 :     *r++ = '(';
                                849                 :             66 :     *r++ = '?';
                                850                 :             66 :     *r++ = ':';
                                851                 :                : 
 7875                           852         [ +  + ]:            548 :     while (plen > 0)
                                853                 :                :     {
 6756 bruce@momjian.us          854                 :            485 :         char        pchar = *p;
                                855                 :                : 
                                856                 :                :         /*
                                857                 :                :          * If both the escape character and the current character from the
                                858                 :                :          * pattern are multi-byte, we need to take the slow path.
                                859                 :                :          *
                                860                 :                :          * But if one of them is single-byte, we can process the pattern one
                                861                 :                :          * byte at a time, ignoring multi-byte characters.  (This works
                                862                 :                :          * because all server-encodings have the property that a valid
                                863                 :                :          * multi-byte character representation cannot contain the
                                864                 :                :          * representation of a valid single-byte character.)
                                865                 :                :          */
                                866                 :                : 
 3518 jdavis@postgresql.or      867         [ -  + ]:            485 :         if (elen > 1)
                                868                 :                :         {
 3249 bruce@momjian.us          869                 :UBC           0 :             int         mblen = pg_mblen(p);
                                870                 :                : 
 3518 jdavis@postgresql.or      871         [ #  # ]:              0 :             if (mblen > 1)
                                872                 :                :             {
                                873                 :                :                 /* slow, multi-byte path */
                                874         [ #  # ]:              0 :                 if (afterescape)
                                875                 :                :                 {
                                876                 :              0 :                     *r++ = '\\';
                                877                 :              0 :                     memcpy(r, p, mblen);
                                878                 :              0 :                     r += mblen;
                                879                 :              0 :                     afterescape = false;
                                880                 :                :                 }
                                881   [ #  #  #  #  :              0 :                 else if (e && elen == mblen && memcmp(e, p, mblen) == 0)
                                              #  # ]
                                882                 :                :                 {
                                883                 :                :                     /* SQL escape character; do not send to output */
                                884                 :              0 :                     afterescape = true;
                                885                 :                :                 }
                                886                 :                :                 else
                                887                 :                :                 {
                                888                 :                :                     /*
                                889                 :                :                      * We know it's a multi-byte character, so we don't need
                                890                 :                :                      * to do all the comparisons to single-byte characters
                                891                 :                :                      * that we do below.
                                892                 :                :                      */
                                893                 :              0 :                     memcpy(r, p, mblen);
                                894                 :              0 :                     r += mblen;
                                895                 :                :                 }
                                896                 :                : 
                                897                 :              0 :                 p += mblen;
                                898                 :              0 :                 plen -= mblen;
                                899                 :                : 
                                900                 :              0 :                 continue;
                                901                 :                :             }
                                902                 :                :         }
                                903                 :                : 
                                904                 :                :         /* fast path */
 7875 tgl@sss.pgh.pa.us         905         [ +  + ]:CBC         485 :         if (afterescape)
                                906                 :                :         {
 1797                           907   [ +  +  +  - ]:             77 :             if (pchar == '"' && !incharclass)  /* escape-double-quote? */
                                908                 :                :             {
                                909                 :                :                 /* emit appropriate part separator, per notes above */
                                910         [ +  + ]:             68 :                 if (nquotes == 0)
                                911                 :                :                 {
                                912                 :             34 :                     *r++ = ')';
                                913                 :             34 :                     *r++ = '{';
                                914                 :             34 :                     *r++ = '1';
                                915                 :             34 :                     *r++ = ',';
                                916                 :             34 :                     *r++ = '1';
                                917                 :             34 :                     *r++ = '}';
                                918                 :             34 :                     *r++ = '?';
                                919                 :             34 :                     *r++ = '(';
                                920                 :                :                 }
                                921         [ +  + ]:             34 :                 else if (nquotes == 1)
                                922                 :                :                 {
                                923                 :             31 :                     *r++ = ')';
                                924                 :             31 :                     *r++ = '{';
                                925                 :             31 :                     *r++ = '1';
                                926                 :             31 :                     *r++ = ',';
                                927                 :             31 :                     *r++ = '1';
                                928                 :             31 :                     *r++ = '}';
                                929                 :             31 :                     *r++ = '(';
                                930                 :             31 :                     *r++ = '?';
                                931                 :             31 :                     *r++ = ':';
                                932                 :                :                 }
                                933                 :                :                 else
                                934         [ +  - ]:              3 :                     ereport(ERROR,
                                935                 :                :                             (errcode(ERRCODE_INVALID_USE_OF_ESCAPE_CHARACTER),
                                936                 :                :                              errmsg("SQL regular expression may not contain more than two escape-double-quote separators")));
                                937                 :             65 :                 nquotes++;
                                938                 :                :             }
                                939                 :                :             else
                                940                 :                :             {
                                941                 :                :                 /*
                                942                 :                :                  * We allow any character at all to be escaped; notably, this
                                943                 :                :                  * allows access to POSIX character-class escapes such as
                                944                 :                :                  * "\d".  The SQL spec is considerably more restrictive.
                                945                 :                :                  */
 7875                           946                 :              9 :                 *r++ = '\\';
                                947                 :              9 :                 *r++ = pchar;
                                948                 :                :             }
                                949                 :             74 :             afterescape = false;
                                950                 :                :         }
                                951   [ +  +  +  + ]:            408 :         else if (e && pchar == *e)
                                952                 :                :         {
                                953                 :                :             /* SQL escape character; do not send to output */
                                954                 :             77 :             afterescape = true;
                                955                 :                :         }
 5216                           956         [ +  + ]:            331 :         else if (incharclass)
                                957                 :                :         {
 5216 tgl@sss.pgh.pa.us         958         [ -  + ]:GBC          18 :             if (pchar == '\\')
 5216 tgl@sss.pgh.pa.us         959                 :UBC           0 :                 *r++ = '\\';
 5216 tgl@sss.pgh.pa.us         960                 :GBC          18 :             *r++ = pchar;
                                961         [ +  + ]:             18 :             if (pchar == ']')
                                962                 :              3 :                 incharclass = false;
                                963                 :                :         }
 5216 tgl@sss.pgh.pa.us         964         [ +  + ]:CBC         313 :         else if (pchar == '[')
                                965                 :                :         {
 5216 tgl@sss.pgh.pa.us         966                 :GBC           3 :             *r++ = pchar;
                                967                 :              3 :             incharclass = true;
                                968                 :                :         }
 7875 tgl@sss.pgh.pa.us         969         [ +  + ]:CBC         310 :         else if (pchar == '%')
                                970                 :                :         {
                                971                 :             57 :             *r++ = '.';
                                972                 :             57 :             *r++ = '*';
                                973                 :                :         }
                                974         [ +  + ]:            253 :         else if (pchar == '_')
                                975                 :             26 :             *r++ = '.';
 5216                           976         [ +  + ]:            227 :         else if (pchar == '(')
                                977                 :                :         {
                                978                 :                :             /* convert to non-capturing parenthesis */
                                979                 :              9 :             *r++ = '(';
                                980                 :              9 :             *r++ = '?';
                                981                 :              9 :             *r++ = ':';
                                982                 :                :         }
 5300                           983   [ +  +  +  +  :            218 :         else if (pchar == '\\' || pchar == '.' ||
                                              +  - ]
                                984         [ -  + ]:            213 :                  pchar == '^' || pchar == '$')
                                985                 :                :         {
 7875                           986                 :              5 :             *r++ = '\\';
                                987                 :              5 :             *r++ = pchar;
                                988                 :                :         }
                                989                 :                :         else
                                990                 :            213 :             *r++ = pchar;
                                991                 :            482 :         p++, plen--;
                                992                 :                :     }
                                993                 :                : 
 6576                           994                 :             63 :     *r++ = ')';
 7875                           995                 :             63 :     *r++ = '$';
                                996                 :                : 
 6256                           997                 :             63 :     SET_VARSIZE(result, r - ((char *) result));
                                998                 :                : 
 1681                           999                 :             63 :     return result;
                               1000                 :                : }
                               1001                 :                : 
                               1002                 :                : /*
                               1003                 :                :  * similar_to_escape(pattern, escape)
                               1004                 :                :  */
                               1005                 :                : Datum
                               1006                 :             49 : similar_to_escape_2(PG_FUNCTION_ARGS)
                               1007                 :                : {
                               1008                 :             49 :     text       *pat_text = PG_GETARG_TEXT_PP(0);
                               1009                 :             49 :     text       *esc_text = PG_GETARG_TEXT_PP(1);
                               1010                 :                :     text       *result;
                               1011                 :                : 
                               1012                 :             49 :     result = similar_escape_internal(pat_text, esc_text);
                               1013                 :                : 
                               1014                 :             43 :     PG_RETURN_TEXT_P(result);
                               1015                 :                : }
                               1016                 :                : 
                               1017                 :                : /*
                               1018                 :                :  * similar_to_escape(pattern)
                               1019                 :                :  * Inserts a default escape character.
                               1020                 :                :  */
                               1021                 :                : Datum
                               1022                 :             20 : similar_to_escape_1(PG_FUNCTION_ARGS)
                               1023                 :                : {
                               1024                 :             20 :     text       *pat_text = PG_GETARG_TEXT_PP(0);
                               1025                 :                :     text       *result;
                               1026                 :                : 
                               1027                 :             20 :     result = similar_escape_internal(pat_text, NULL);
                               1028                 :                : 
                               1029                 :             20 :     PG_RETURN_TEXT_P(result);
                               1030                 :                : }
                               1031                 :                : 
                               1032                 :                : /*
                               1033                 :                :  * similar_escape(pattern, escape)
                               1034                 :                :  *
                               1035                 :                :  * Legacy function for compatibility with views stored using the
                               1036                 :                :  * pre-v13 expansion of SIMILAR TO.  Unlike the above functions, this
                               1037                 :                :  * is non-strict, which leads to not-per-spec handling of "ESCAPE NULL".
                               1038                 :                :  */
                               1039                 :                : Datum
 1681 tgl@sss.pgh.pa.us        1040                 :UBC           0 : similar_escape(PG_FUNCTION_ARGS)
                               1041                 :                : {
                               1042                 :                :     text       *pat_text;
                               1043                 :                :     text       *esc_text;
                               1044                 :                :     text       *result;
                               1045                 :                : 
                               1046                 :                :     /* This function is not strict, so must test explicitly */
                               1047         [ #  # ]:              0 :     if (PG_ARGISNULL(0))
                               1048                 :              0 :         PG_RETURN_NULL();
                               1049                 :              0 :     pat_text = PG_GETARG_TEXT_PP(0);
                               1050                 :                : 
                               1051         [ #  # ]:              0 :     if (PG_ARGISNULL(1))
                               1052                 :              0 :         esc_text = NULL;        /* use default escape character */
                               1053                 :                :     else
                               1054                 :              0 :         esc_text = PG_GETARG_TEXT_PP(1);
                               1055                 :                : 
                               1056                 :              0 :     result = similar_escape_internal(pat_text, esc_text);
                               1057                 :                : 
 7875                          1058                 :              0 :     PG_RETURN_TEXT_P(result);
                               1059                 :                : }
                               1060                 :                : 
                               1061                 :                : /*
                               1062                 :                :  * regexp_count()
                               1063                 :                :  *      Return the number of matches of a pattern within a string.
                               1064                 :                :  */
                               1065                 :                : Datum
  985 tgl@sss.pgh.pa.us        1066                 :CBC          24 : regexp_count(PG_FUNCTION_ARGS)
                               1067                 :                : {
                               1068                 :             24 :     text       *str = PG_GETARG_TEXT_PP(0);
                               1069                 :             24 :     text       *pattern = PG_GETARG_TEXT_PP(1);
                               1070                 :             24 :     int         start = 1;
                               1071         [ +  + ]:             24 :     text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(3);
                               1072                 :                :     pg_re_flags re_flags;
                               1073                 :                :     regexp_matches_ctx *matchctx;
                               1074                 :                : 
                               1075                 :                :     /* Collect optional parameters */
                               1076         [ +  + ]:             24 :     if (PG_NARGS() > 2)
                               1077                 :                :     {
                               1078                 :             21 :         start = PG_GETARG_INT32(2);
                               1079         [ +  + ]:             21 :         if (start <= 0)
                               1080         [ +  - ]:              6 :             ereport(ERROR,
                               1081                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1082                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1083                 :                :                             "start", start)));
                               1084                 :                :     }
                               1085                 :                : 
                               1086                 :                :     /* Determine options */
                               1087                 :             18 :     parse_re_flags(&re_flags, flags);
                               1088                 :                :     /* User mustn't specify 'g' */
                               1089         [ -  + ]:             18 :     if (re_flags.glob)
  985 tgl@sss.pgh.pa.us        1090         [ #  # ]:UBC           0 :         ereport(ERROR,
                               1091                 :                :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1092                 :                :         /* translator: %s is a SQL function name */
                               1093                 :                :                  errmsg("%s does not support the \"global\" option",
                               1094                 :                :                         "regexp_count()")));
                               1095                 :                :     /* But we find all the matches anyway */
  985 tgl@sss.pgh.pa.us        1096                 :CBC          18 :     re_flags.glob = true;
                               1097                 :                : 
                               1098                 :                :     /* Do the matching */
                               1099                 :             18 :     matchctx = setup_regexp_matches(str, pattern, &re_flags, start - 1,
                               1100                 :                :                                     PG_GET_COLLATION(),
                               1101                 :                :                                     false,  /* can ignore subexprs */
                               1102                 :                :                                     false, false);
                               1103                 :                : 
                               1104                 :             18 :     PG_RETURN_INT32(matchctx->nmatches);
                               1105                 :                : }
                               1106                 :                : 
                               1107                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1108                 :                : Datum
                               1109                 :              3 : regexp_count_no_start(PG_FUNCTION_ARGS)
                               1110                 :                : {
                               1111                 :              3 :     return regexp_count(fcinfo);
                               1112                 :                : }
                               1113                 :                : 
                               1114                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1115                 :                : Datum
                               1116                 :             15 : regexp_count_no_flags(PG_FUNCTION_ARGS)
                               1117                 :                : {
                               1118                 :             15 :     return regexp_count(fcinfo);
                               1119                 :                : }
                               1120                 :                : 
                               1121                 :                : /*
                               1122                 :                :  * regexp_instr()
                               1123                 :                :  *      Return the match's position within the string
                               1124                 :                :  */
                               1125                 :                : Datum
                               1126                 :             78 : regexp_instr(PG_FUNCTION_ARGS)
                               1127                 :                : {
                               1128                 :             78 :     text       *str = PG_GETARG_TEXT_PP(0);
                               1129                 :             78 :     text       *pattern = PG_GETARG_TEXT_PP(1);
                               1130                 :             78 :     int         start = 1;
                               1131                 :             78 :     int         n = 1;
                               1132                 :             78 :     int         endoption = 0;
                               1133         [ +  + ]:             78 :     text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(5);
                               1134                 :             78 :     int         subexpr = 0;
                               1135                 :                :     int         pos;
                               1136                 :                :     pg_re_flags re_flags;
                               1137                 :                :     regexp_matches_ctx *matchctx;
                               1138                 :                : 
                               1139                 :                :     /* Collect optional parameters */
                               1140         [ +  + ]:             78 :     if (PG_NARGS() > 2)
                               1141                 :                :     {
                               1142                 :             69 :         start = PG_GETARG_INT32(2);
                               1143         [ +  + ]:             69 :         if (start <= 0)
                               1144         [ +  - ]:              3 :             ereport(ERROR,
                               1145                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1146                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1147                 :                :                             "start", start)));
                               1148                 :                :     }
                               1149         [ +  + ]:             75 :     if (PG_NARGS() > 3)
                               1150                 :                :     {
                               1151                 :             63 :         n = PG_GETARG_INT32(3);
                               1152         [ +  + ]:             63 :         if (n <= 0)
                               1153         [ +  - ]:              3 :             ereport(ERROR,
                               1154                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1155                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1156                 :                :                             "n", n)));
                               1157                 :                :     }
                               1158         [ +  + ]:             72 :     if (PG_NARGS() > 4)
                               1159                 :                :     {
                               1160                 :             54 :         endoption = PG_GETARG_INT32(4);
                               1161   [ +  +  +  + ]:             54 :         if (endoption != 0 && endoption != 1)
                               1162         [ +  - ]:              6 :             ereport(ERROR,
                               1163                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1164                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1165                 :                :                             "endoption", endoption)));
                               1166                 :                :     }
                               1167         [ +  + ]:             66 :     if (PG_NARGS() > 6)
                               1168                 :                :     {
                               1169                 :             42 :         subexpr = PG_GETARG_INT32(6);
                               1170         [ +  + ]:             42 :         if (subexpr < 0)
                               1171         [ +  - ]:              3 :             ereport(ERROR,
                               1172                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1173                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1174                 :                :                             "subexpr", subexpr)));
                               1175                 :                :     }
                               1176                 :                : 
                               1177                 :                :     /* Determine options */
                               1178                 :             63 :     parse_re_flags(&re_flags, flags);
                               1179                 :                :     /* User mustn't specify 'g' */
                               1180         [ +  + ]:             63 :     if (re_flags.glob)
                               1181         [ +  - ]:              3 :         ereport(ERROR,
                               1182                 :                :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1183                 :                :         /* translator: %s is a SQL function name */
                               1184                 :                :                  errmsg("%s does not support the \"global\" option",
                               1185                 :                :                         "regexp_instr()")));
                               1186                 :                :     /* But we find all the matches anyway */
                               1187                 :             60 :     re_flags.glob = true;
                               1188                 :                : 
                               1189                 :                :     /* Do the matching */
                               1190                 :             60 :     matchctx = setup_regexp_matches(str, pattern, &re_flags, start - 1,
                               1191                 :                :                                     PG_GET_COLLATION(),
                               1192                 :                :                                     (subexpr > 0),   /* need submatches? */
                               1193                 :                :                                     false, false);
                               1194                 :                : 
                               1195                 :                :     /* When n exceeds matches return 0 (includes case of no matches) */
                               1196         [ +  + ]:             60 :     if (n > matchctx->nmatches)
                               1197                 :              6 :         PG_RETURN_INT32(0);
                               1198                 :                : 
                               1199                 :                :     /* When subexpr exceeds number of subexpressions return 0 */
                               1200         [ +  + ]:             54 :     if (subexpr > matchctx->npatterns)
                               1201                 :              6 :         PG_RETURN_INT32(0);
                               1202                 :                : 
                               1203                 :                :     /* Select the appropriate match position to return */
                               1204                 :             48 :     pos = (n - 1) * matchctx->npatterns;
                               1205         [ +  + ]:             48 :     if (subexpr > 0)
                               1206                 :             27 :         pos += subexpr - 1;
                               1207                 :             48 :     pos *= 2;
                               1208         [ +  + ]:             48 :     if (endoption == 1)
                               1209                 :             15 :         pos += 1;
                               1210                 :                : 
                               1211         [ +  + ]:             48 :     if (matchctx->match_locs[pos] >= 0)
                               1212                 :             45 :         PG_RETURN_INT32(matchctx->match_locs[pos] + 1);
                               1213                 :                :     else
                               1214                 :              3 :         PG_RETURN_INT32(0);     /* position not identifiable */
                               1215                 :                : }
                               1216                 :                : 
                               1217                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1218                 :                : Datum
                               1219                 :              9 : regexp_instr_no_start(PG_FUNCTION_ARGS)
                               1220                 :                : {
                               1221                 :              9 :     return regexp_instr(fcinfo);
                               1222                 :                : }
                               1223                 :                : 
                               1224                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1225                 :                : Datum
                               1226                 :              3 : regexp_instr_no_n(PG_FUNCTION_ARGS)
                               1227                 :                : {
                               1228                 :              3 :     return regexp_instr(fcinfo);
                               1229                 :                : }
                               1230                 :                : 
                               1231                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1232                 :                : Datum
                               1233                 :             12 : regexp_instr_no_endoption(PG_FUNCTION_ARGS)
                               1234                 :                : {
                               1235                 :             12 :     return regexp_instr(fcinfo);
                               1236                 :                : }
                               1237                 :                : 
                               1238                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1239                 :                : Datum
                               1240                 :              6 : regexp_instr_no_flags(PG_FUNCTION_ARGS)
                               1241                 :                : {
  985 tgl@sss.pgh.pa.us        1242                 :UBC           0 :     return regexp_instr(fcinfo);
                               1243                 :                : }
                               1244                 :                : 
                               1245                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1246                 :                : Datum
  985 tgl@sss.pgh.pa.us        1247                 :CBC           6 : regexp_instr_no_subexpr(PG_FUNCTION_ARGS)
                               1248                 :                : {
                               1249                 :              6 :     return regexp_instr(fcinfo);
                               1250                 :                : }
                               1251                 :                : 
                               1252                 :                : /*
                               1253                 :                :  * regexp_like()
                               1254                 :                :  *      Test for a pattern match within a string.
                               1255                 :                :  */
                               1256                 :                : Datum
                               1257                 :             15 : regexp_like(PG_FUNCTION_ARGS)
                               1258                 :                : {
                               1259                 :             15 :     text       *str = PG_GETARG_TEXT_PP(0);
                               1260                 :             15 :     text       *pattern = PG_GETARG_TEXT_PP(1);
                               1261         [ +  + ]:             15 :     text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(2);
                               1262                 :                :     pg_re_flags re_flags;
                               1263                 :                : 
                               1264                 :                :     /* Determine options */
                               1265                 :             15 :     parse_re_flags(&re_flags, flags);
                               1266                 :                :     /* User mustn't specify 'g' */
                               1267         [ +  + ]:             15 :     if (re_flags.glob)
                               1268         [ +  - ]:              3 :         ereport(ERROR,
                               1269                 :                :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1270                 :                :         /* translator: %s is a SQL function name */
                               1271                 :                :                  errmsg("%s does not support the \"global\" option",
                               1272                 :                :                         "regexp_like()")));
                               1273                 :                : 
                               1274                 :                :     /* Otherwise it's like textregexeq/texticregexeq */
                               1275   [ -  +  -  -  :             12 :     PG_RETURN_BOOL(RE_compile_and_execute(pattern,
                                     -  -  -  -  -  
                                           +  -  + ]
                               1276                 :                :                                           VARDATA_ANY(str),
                               1277                 :                :                                           VARSIZE_ANY_EXHDR(str),
                               1278                 :                :                                           re_flags.cflags,
                               1279                 :                :                                           PG_GET_COLLATION(),
                               1280                 :                :                                           0, NULL));
                               1281                 :                : }
                               1282                 :                : 
                               1283                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1284                 :                : Datum
                               1285                 :              3 : regexp_like_no_flags(PG_FUNCTION_ARGS)
                               1286                 :                : {
                               1287                 :              3 :     return regexp_like(fcinfo);
                               1288                 :                : }
                               1289                 :                : 
                               1290                 :                : /*
                               1291                 :                :  * regexp_match()
                               1292                 :                :  *      Return the first substring(s) matching a pattern within a string.
                               1293                 :                :  */
                               1294                 :                : Datum
 2797                          1295                 :           1278 : regexp_match(PG_FUNCTION_ARGS)
                               1296                 :                : {
                               1297                 :           1278 :     text       *orig_str = PG_GETARG_TEXT_PP(0);
                               1298                 :           1278 :     text       *pattern = PG_GETARG_TEXT_PP(1);
                               1299         [ +  + ]:           1278 :     text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(2);
                               1300                 :                :     pg_re_flags re_flags;
                               1301                 :                :     regexp_matches_ctx *matchctx;
                               1302                 :                : 
                               1303                 :                :     /* Determine options */
                               1304                 :           1278 :     parse_re_flags(&re_flags, flags);
                               1305                 :                :     /* User mustn't specify 'g' */
                               1306         [ +  + ]:           1278 :     if (re_flags.glob)
                               1307         [ +  - ]:              4 :         ereport(ERROR,
                               1308                 :                :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1309                 :                :         /* translator: %s is a SQL function name */
                               1310                 :                :                  errmsg("%s does not support the \"global\" option",
                               1311                 :                :                         "regexp_match()"),
                               1312                 :                :                  errhint("Use the regexp_matches function instead.")));
                               1313                 :                : 
  985                          1314                 :           1274 :     matchctx = setup_regexp_matches(orig_str, pattern, &re_flags, 0,
                               1315                 :                :                                     PG_GET_COLLATION(), true, false, false);
                               1316                 :                : 
 2797                          1317         [ +  + ]:           1274 :     if (matchctx->nmatches == 0)
                               1318                 :             85 :         PG_RETURN_NULL();
                               1319                 :                : 
                               1320         [ -  + ]:           1189 :     Assert(matchctx->nmatches == 1);
                               1321                 :                : 
                               1322                 :                :     /* Create workspace that build_regexp_match_result needs */
                               1323                 :           1189 :     matchctx->elems = (Datum *) palloc(sizeof(Datum) * matchctx->npatterns);
                               1324                 :           1189 :     matchctx->nulls = (bool *) palloc(sizeof(bool) * matchctx->npatterns);
                               1325                 :                : 
                               1326                 :           1189 :     PG_RETURN_DATUM(PointerGetDatum(build_regexp_match_result(matchctx)));
                               1327                 :                : }
                               1328                 :                : 
                               1329                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1330                 :                : Datum
                               1331                 :           1263 : regexp_match_no_flags(PG_FUNCTION_ARGS)
                               1332                 :                : {
                               1333                 :           1263 :     return regexp_match(fcinfo);
                               1334                 :                : }
                               1335                 :                : 
                               1336                 :                : /*
                               1337                 :                :  * regexp_matches()
                               1338                 :                :  *      Return a table of all matches of a pattern within a string.
                               1339                 :                :  */
                               1340                 :                : Datum
 6235 neilc@samurai.com        1341                 :            339 : regexp_matches(PG_FUNCTION_ARGS)
                               1342                 :                : {
                               1343                 :                :     FuncCallContext *funcctx;
                               1344                 :                :     regexp_matches_ctx *matchctx;
                               1345                 :                : 
                               1346         [ +  + ]:            339 :     if (SRF_IS_FIRSTCALL())
                               1347                 :                :     {
 5995 bruce@momjian.us         1348                 :            144 :         text       *pattern = PG_GETARG_TEXT_PP(1);
                               1349         [ +  + ]:            144 :         text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(2);
                               1350                 :                :         pg_re_flags re_flags;
                               1351                 :                :         MemoryContext oldcontext;
                               1352                 :                : 
 6235 neilc@samurai.com        1353                 :            144 :         funcctx = SRF_FIRSTCALL_INIT();
                               1354                 :            144 :         oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
                               1355                 :                : 
                               1356                 :                :         /* Determine options */
 2797 tgl@sss.pgh.pa.us        1357                 :            144 :         parse_re_flags(&re_flags, flags);
                               1358                 :                : 
                               1359                 :                :         /* be sure to copy the input string into the multi-call ctx */
 6227 neilc@samurai.com        1360                 :            141 :         matchctx = setup_regexp_matches(PG_GETARG_TEXT_P_COPY(0), pattern,
                               1361                 :                :                                         &re_flags, 0,
                               1362                 :                :                                         PG_GET_COLLATION(),
                               1363                 :                :                                         true, false, false);
                               1364                 :                : 
                               1365                 :                :         /* Pre-create workspace that build_regexp_match_result needs */
 6091 tgl@sss.pgh.pa.us        1366                 :            135 :         matchctx->elems = (Datum *) palloc(sizeof(Datum) * matchctx->npatterns);
                               1367                 :            135 :         matchctx->nulls = (bool *) palloc(sizeof(bool) * matchctx->npatterns);
                               1368                 :                : 
 6235 neilc@samurai.com        1369                 :            135 :         MemoryContextSwitchTo(oldcontext);
                               1370                 :            135 :         funcctx->user_fctx = (void *) matchctx;
                               1371                 :                :     }
                               1372                 :                : 
                               1373                 :            330 :     funcctx = SRF_PERCALL_SETUP();
                               1374                 :            330 :     matchctx = (regexp_matches_ctx *) funcctx->user_fctx;
                               1375                 :                : 
 6091 tgl@sss.pgh.pa.us        1376         [ +  + ]:            330 :     if (matchctx->next_match < matchctx->nmatches)
                               1377                 :                :     {
                               1378                 :                :         ArrayType  *result_ary;
                               1379                 :                : 
 2797                          1380                 :            195 :         result_ary = build_regexp_match_result(matchctx);
 6091                          1381                 :            195 :         matchctx->next_match++;
                               1382                 :            195 :         SRF_RETURN_NEXT(funcctx, PointerGetDatum(result_ary));
                               1383                 :                :     }
                               1384                 :                : 
 6235 neilc@samurai.com        1385                 :            135 :     SRF_RETURN_DONE(funcctx);
                               1386                 :                : }
                               1387                 :                : 
                               1388                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1389                 :                : Datum
                               1390                 :            177 : regexp_matches_no_flags(PG_FUNCTION_ARGS)
                               1391                 :                : {
                               1392                 :            177 :     return regexp_matches(fcinfo);
                               1393                 :                : }
                               1394                 :                : 
                               1395                 :                : /*
                               1396                 :                :  * setup_regexp_matches --- do the initial matching for regexp_match,
                               1397                 :                :  *      regexp_split, and related functions
                               1398                 :                :  *
                               1399                 :                :  * To avoid having to re-find the compiled pattern on each call, we do
                               1400                 :                :  * all the matching in one swoop.  The returned regexp_matches_ctx contains
                               1401                 :                :  * the locations of all the substrings matching the pattern.
                               1402                 :                :  *
                               1403                 :                :  * start_search: the character (not byte) offset in orig_str at which to
                               1404                 :                :  * begin the search.  Returned positions are relative to orig_str anyway.
                               1405                 :                :  * use_subpatterns: collect data about matches to parenthesized subexpressions.
                               1406                 :                :  * ignore_degenerate: ignore zero-length matches.
                               1407                 :                :  * fetching_unmatched: caller wants to fetch unmatched substrings.
                               1408                 :                :  *
                               1409                 :                :  * We don't currently assume that fetching_unmatched is exclusive of fetching
                               1410                 :                :  * the matched text too; if it's set, the conversion buffer is large enough to
                               1411                 :                :  * fetch any single matched or unmatched string, but not any larger
                               1412                 :                :  * substring.  (In practice, when splitting the matches are usually small
                               1413                 :                :  * anyway, and it didn't seem worth complicating the code further.)
                               1414                 :                :  */
                               1415                 :                : static regexp_matches_ctx *
 2797 tgl@sss.pgh.pa.us        1416                 :         101727 : setup_regexp_matches(text *orig_str, text *pattern, pg_re_flags *re_flags,
                               1417                 :                :                      int start_search,
                               1418                 :                :                      Oid collation,
                               1419                 :                :                      bool use_subpatterns,
                               1420                 :                :                      bool ignore_degenerate,
                               1421                 :                :                      bool fetching_unmatched)
                               1422                 :                : {
 6091                          1423                 :         101727 :     regexp_matches_ctx *matchctx = palloc0(sizeof(regexp_matches_ctx));
 2056 rhodiumtoad@postgres     1424                 :         101727 :     int         eml = pg_database_encoding_max_length();
                               1425                 :                :     int         orig_len;
                               1426                 :                :     pg_wchar   *wide_str;
                               1427                 :                :     int         wide_len;
                               1428                 :                :     int         cflags;
                               1429                 :                :     regex_t    *cpattern;
                               1430                 :                :     regmatch_t *pmatch;
                               1431                 :                :     int         pmatch_len;
                               1432                 :                :     int         array_len;
                               1433                 :                :     int         array_idx;
                               1434                 :                :     int         prev_match_end;
                               1435                 :                :     int         prev_valid_match_end;
                               1436                 :         101727 :     int         maxlen = 0;     /* largest fetch length in characters */
                               1437                 :                : 
                               1438                 :                :     /* save original string --- we'll extract result substrings from it */
 6235 neilc@samurai.com        1439                 :         101727 :     matchctx->orig_str = orig_str;
                               1440                 :                : 
                               1441                 :                :     /* convert string to pg_wchar form for matching */
 6050 tgl@sss.pgh.pa.us        1442   [ -  +  -  -  :         101727 :     orig_len = VARSIZE_ANY_EXHDR(orig_str);
                                     -  -  -  -  +  
                                                 + ]
 6091                          1443                 :         101727 :     wide_str = (pg_wchar *) palloc(sizeof(pg_wchar) * (orig_len + 1));
 6050                          1444         [ +  + ]:         101727 :     wide_len = pg_mb2wchar_with_len(VARDATA_ANY(orig_str), wide_str, orig_len);
                               1445                 :                : 
                               1446                 :                :     /* set up the compiled pattern */
  979                          1447                 :         101727 :     cflags = re_flags->cflags;
                               1448         [ +  + ]:         101727 :     if (!use_subpatterns)
                               1449                 :         100261 :         cflags |= REG_NOSUB;
                               1450                 :         101727 :     cpattern = RE_compile_and_cache(pattern, cflags, collation);
                               1451                 :                : 
                               1452                 :                :     /* do we want to remember subpatterns? */
 6091                          1453   [ +  +  +  + ]:         101721 :     if (use_subpatterns && cpattern->re_nsub > 0)
                               1454                 :                :     {
                               1455                 :           1355 :         matchctx->npatterns = cpattern->re_nsub;
                               1456                 :           1355 :         pmatch_len = cpattern->re_nsub + 1;
                               1457                 :                :     }
                               1458                 :                :     else
                               1459                 :                :     {
                               1460                 :         100366 :         use_subpatterns = false;
                               1461                 :         100366 :         matchctx->npatterns = 1;
                               1462                 :         100366 :         pmatch_len = 1;
                               1463                 :                :     }
                               1464                 :                : 
                               1465                 :                :     /* temporary output space for RE package */
                               1466                 :         101721 :     pmatch = palloc(sizeof(regmatch_t) * pmatch_len);
                               1467                 :                : 
                               1468                 :                :     /*
                               1469                 :                :      * the real output space (grown dynamically if needed)
                               1470                 :                :      *
                               1471                 :                :      * use values 2^n-1, not 2^n, so that we hit the limit at 2^28-1 rather
                               1472                 :                :      * than at 2^27
                               1473                 :                :      */
 2056 rhodiumtoad@postgres     1474         [ +  + ]:         101721 :     array_len = re_flags->glob ? 255 : 31;
 6091 tgl@sss.pgh.pa.us        1475                 :         101721 :     matchctx->match_locs = (int *) palloc(sizeof(int) * array_len);
                               1476                 :         101721 :     array_idx = 0;
                               1477                 :                : 
                               1478                 :                :     /* search for the pattern, perhaps repeatedly */
                               1479                 :         101721 :     prev_match_end = 0;
 2041 rhodiumtoad@postgres     1480                 :         101721 :     prev_valid_match_end = 0;
 6091 tgl@sss.pgh.pa.us        1481         [ +  + ]:         547587 :     while (RE_wchar_execute(cpattern, wide_str, wide_len, start_search,
                               1482                 :                :                             pmatch_len, pmatch))
                               1483                 :                :     {
                               1484                 :                :         /*
                               1485                 :                :          * If requested, ignore degenerate matches, which are zero-length
                               1486                 :                :          * matches occurring at the start or end of a string or just after a
                               1487                 :                :          * previous match.
                               1488                 :                :          */
                               1489         [ +  + ]:         447173 :         if (!ignore_degenerate ||
                               1490         [ +  + ]:         445591 :             (pmatch[0].rm_so < wide_len &&
                               1491         [ +  + ]:         445570 :              pmatch[0].rm_eo > prev_match_end))
                               1492                 :                :         {
                               1493                 :                :             /* enlarge output space if needed */
 2056 rhodiumtoad@postgres     1494         [ +  + ]:         447263 :             while (array_idx + matchctx->npatterns * 2 + 1 > array_len)
                               1495                 :                :             {
 1789 tgl@sss.pgh.pa.us        1496                 :            180 :                 array_len += array_len + 1; /* 2^n-1 => 2^(n+1)-1 */
                               1497         [ -  + ]:            180 :                 if (array_len > MaxAllocSize / sizeof(int))
 2056 rhodiumtoad@postgres     1498         [ #  # ]:UBC           0 :                     ereport(ERROR,
                               1499                 :                :                             (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
                               1500                 :                :                              errmsg("too many regular expression matches")));
 6091 tgl@sss.pgh.pa.us        1501                 :CBC         180 :                 matchctx->match_locs = (int *) repalloc(matchctx->match_locs,
                               1502                 :                :                                                         sizeof(int) * array_len);
                               1503                 :                :             }
                               1504                 :                : 
                               1505                 :                :             /* save this match's locations */
                               1506         [ +  + ]:         447083 :             if (use_subpatterns)
                               1507                 :                :             {
                               1508                 :                :                 int         i;
                               1509                 :                : 
                               1510         [ +  + ]:           3936 :                 for (i = 1; i <= matchctx->npatterns; i++)
                               1511                 :                :                 {
 1789                          1512                 :           2657 :                     int         so = pmatch[i].rm_so;
                               1513                 :           2657 :                     int         eo = pmatch[i].rm_eo;
                               1514                 :                : 
 2056 rhodiumtoad@postgres     1515                 :           2657 :                     matchctx->match_locs[array_idx++] = so;
                               1516                 :           2657 :                     matchctx->match_locs[array_idx++] = eo;
                               1517   [ +  +  +  -  :           2657 :                     if (so >= 0 && eo >= 0 && (eo - so) > maxlen)
                                              +  + ]
                               1518                 :           1710 :                         maxlen = (eo - so);
                               1519                 :                :                 }
                               1520                 :                :             }
                               1521                 :                :             else
                               1522                 :                :             {
 1789 tgl@sss.pgh.pa.us        1523                 :         445804 :                 int         so = pmatch[0].rm_so;
                               1524                 :         445804 :                 int         eo = pmatch[0].rm_eo;
                               1525                 :                : 
 2056 rhodiumtoad@postgres     1526                 :         445804 :                 matchctx->match_locs[array_idx++] = so;
                               1527                 :         445804 :                 matchctx->match_locs[array_idx++] = eo;
                               1528   [ +  -  +  -  :         445804 :                 if (so >= 0 && eo >= 0 && (eo - so) > maxlen)
                                              +  + ]
                               1529                 :         100283 :                     maxlen = (eo - so);
                               1530                 :                :             }
 6091 tgl@sss.pgh.pa.us        1531                 :         447083 :             matchctx->nmatches++;
                               1532                 :                : 
                               1533                 :                :             /*
                               1534                 :                :              * check length of unmatched portion between end of previous valid
                               1535                 :                :              * (nondegenerate, or degenerate but not ignored) match and start
                               1536                 :                :              * of current one
                               1537                 :                :              */
 2056 rhodiumtoad@postgres     1538         [ +  + ]:         447083 :             if (fetching_unmatched &&
                               1539         [ +  - ]:         445501 :                 pmatch[0].rm_so >= 0 &&
 2041                          1540         [ +  + ]:         445501 :                 (pmatch[0].rm_so - prev_valid_match_end) > maxlen)
                               1541                 :         190391 :                 maxlen = (pmatch[0].rm_so - prev_valid_match_end);
                               1542                 :         447083 :             prev_valid_match_end = pmatch[0].rm_eo;
                               1543                 :                :         }
 6091 tgl@sss.pgh.pa.us        1544                 :         447173 :         prev_match_end = pmatch[0].rm_eo;
                               1545                 :                : 
                               1546                 :                :         /* if not glob, stop after one match */
 2797                          1547         [ +  + ]:         447173 :         if (!re_flags->glob)
 6091                          1548                 :           1274 :             break;
                               1549                 :                : 
                               1550                 :                :         /*
                               1551                 :                :          * Advance search position.  Normally we start the next search at the
                               1552                 :                :          * end of the previous match; but if the match was of zero length, we
                               1553                 :                :          * have to advance by one character, or we'd just find the same match
                               1554                 :                :          * again.
                               1555                 :                :          */
 3910                          1556                 :         445899 :         start_search = prev_match_end;
                               1557         [ +  + ]:         445899 :         if (pmatch[0].rm_so == pmatch[0].rm_eo)
 6091                          1558                 :            588 :             start_search++;
                               1559         [ +  + ]:         445899 :         if (start_search > wide_len)
                               1560                 :             33 :             break;
                               1561                 :                :     }
                               1562                 :                : 
                               1563                 :                :     /*
                               1564                 :                :      * check length of unmatched portion between end of last match and end of
                               1565                 :                :      * input string
                               1566                 :                :      */
 2056 rhodiumtoad@postgres     1567         [ +  + ]:         101721 :     if (fetching_unmatched &&
 2041                          1568         [ +  + ]:         100192 :         (wide_len - prev_valid_match_end) > maxlen)
                               1569                 :             14 :         maxlen = (wide_len - prev_valid_match_end);
                               1570                 :                : 
                               1571                 :                :     /*
                               1572                 :                :      * Keep a note of the end position of the string for the benefit of
                               1573                 :                :      * splitting code.
                               1574                 :                :      */
 2056                          1575                 :         101721 :     matchctx->match_locs[array_idx] = wide_len;
                               1576                 :                : 
                               1577         [ +  - ]:         101721 :     if (eml > 1)
                               1578                 :                :     {
                               1579                 :         101721 :         int64       maxsiz = eml * (int64) maxlen;
                               1580                 :                :         int         conv_bufsiz;
                               1581                 :                : 
                               1582                 :                :         /*
                               1583                 :                :          * Make the conversion buffer large enough for any substring of
                               1584                 :                :          * interest.
                               1585                 :                :          *
                               1586                 :                :          * Worst case: assume we need the maximum size (maxlen*eml), but take
                               1587                 :                :          * advantage of the fact that the original string length in bytes is
                               1588                 :                :          * an upper bound on the byte length of any fetched substring (and we
                               1589                 :                :          * know that len+1 is safe to allocate because the varlena header is
                               1590                 :                :          * longer than 1 byte).
                               1591                 :                :          */
                               1592         [ +  + ]:         101721 :         if (maxsiz > orig_len)
                               1593                 :         100240 :             conv_bufsiz = orig_len + 1;
                               1594                 :                :         else
                               1595                 :           1481 :             conv_bufsiz = maxsiz + 1;   /* safe since maxsiz < 2^30 */
                               1596                 :                : 
                               1597                 :         101721 :         matchctx->conv_buf = palloc(conv_bufsiz);
                               1598                 :         101721 :         matchctx->conv_bufsiz = conv_bufsiz;
                               1599                 :         101721 :         matchctx->wide_str = wide_str;
                               1600                 :                :     }
                               1601                 :                :     else
                               1602                 :                :     {
                               1603                 :                :         /* No need to keep the wide string if we're in a single-byte charset. */
 2056 rhodiumtoad@postgres     1604                 :UBC           0 :         pfree(wide_str);
                               1605                 :              0 :         matchctx->wide_str = NULL;
                               1606                 :              0 :         matchctx->conv_buf = NULL;
                               1607                 :              0 :         matchctx->conv_bufsiz = 0;
                               1608                 :                :     }
                               1609                 :                : 
                               1610                 :                :     /* Clean up temp storage */
 6091 tgl@sss.pgh.pa.us        1611                 :CBC      101721 :     pfree(pmatch);
                               1612                 :                : 
                               1613                 :         101721 :     return matchctx;
                               1614                 :                : }
                               1615                 :                : 
                               1616                 :                : /*
                               1617                 :                :  * build_regexp_match_result - build output array for current match
                               1618                 :                :  */
                               1619                 :                : static ArrayType *
 2797                          1620                 :           1384 : build_regexp_match_result(regexp_matches_ctx *matchctx)
                               1621                 :                : {
 2056 rhodiumtoad@postgres     1622                 :           1384 :     char       *buf = matchctx->conv_buf;
 6091 tgl@sss.pgh.pa.us        1623                 :           1384 :     Datum      *elems = matchctx->elems;
                               1624                 :           1384 :     bool       *nulls = matchctx->nulls;
                               1625                 :                :     int         dims[1];
                               1626                 :                :     int         lbs[1];
                               1627                 :                :     int         loc;
                               1628                 :                :     int         i;
                               1629                 :                : 
                               1630                 :                :     /* Extract matching substrings from the original string */
                               1631                 :           1384 :     loc = matchctx->next_match * matchctx->npatterns * 2;
                               1632         [ +  + ]:           4011 :     for (i = 0; i < matchctx->npatterns; i++)
                               1633                 :                :     {
 5995 bruce@momjian.us         1634                 :           2627 :         int         so = matchctx->match_locs[loc++];
                               1635                 :           2627 :         int         eo = matchctx->match_locs[loc++];
                               1636                 :                : 
 6091 tgl@sss.pgh.pa.us        1637   [ +  +  -  + ]:           2627 :         if (so < 0 || eo < 0)
                               1638                 :                :         {
                               1639                 :              3 :             elems[i] = (Datum) 0;
                               1640                 :              3 :             nulls[i] = true;
                               1641                 :                :         }
 2056 rhodiumtoad@postgres     1642         [ +  - ]:           2624 :         else if (buf)
                               1643                 :                :         {
 1789 tgl@sss.pgh.pa.us        1644                 :           2624 :             int         len = pg_wchar2mb_with_len(matchctx->wide_str + so,
                               1645                 :                :                                                    buf,
                               1646                 :                :                                                    eo - so);
                               1647                 :                : 
 1550                          1648         [ -  + ]:           2624 :             Assert(len < matchctx->conv_bufsiz);
 2056 rhodiumtoad@postgres     1649                 :           2624 :             elems[i] = PointerGetDatum(cstring_to_text_with_len(buf, len));
                               1650                 :           2624 :             nulls[i] = false;
                               1651                 :                :         }
                               1652                 :                :         else
                               1653                 :                :         {
 6091 tgl@sss.pgh.pa.us        1654                 :UBC           0 :             elems[i] = DirectFunctionCall3(text_substr,
                               1655                 :                :                                            PointerGetDatum(matchctx->orig_str),
                               1656                 :                :                                            Int32GetDatum(so + 1),
                               1657                 :                :                                            Int32GetDatum(eo - so));
                               1658                 :              0 :             nulls[i] = false;
                               1659                 :                :         }
                               1660                 :                :     }
                               1661                 :                : 
                               1662                 :                :     /* And form an array */
 6091 tgl@sss.pgh.pa.us        1663                 :CBC        1384 :     dims[0] = matchctx->npatterns;
                               1664                 :           1384 :     lbs[0] = 1;
                               1665                 :                :     /* XXX: this hardcodes assumptions about the text type */
                               1666                 :           1384 :     return construct_md_array(elems, nulls, 1, dims, lbs,
                               1667                 :                :                               TEXTOID, -1, false, TYPALIGN_INT);
                               1668                 :                : }
                               1669                 :                : 
                               1670                 :                : /*
                               1671                 :                :  * regexp_split_to_table()
                               1672                 :                :  *      Split the string at matches of the pattern, returning the
                               1673                 :                :  *      split-out substrings as a table.
                               1674                 :                :  */
                               1675                 :                : Datum
 6235 neilc@samurai.com        1676                 :            311 : regexp_split_to_table(PG_FUNCTION_ARGS)
                               1677                 :                : {
                               1678                 :                :     FuncCallContext *funcctx;
                               1679                 :                :     regexp_matches_ctx *splitctx;
                               1680                 :                : 
                               1681         [ +  + ]:            311 :     if (SRF_IS_FIRSTCALL())
                               1682                 :                :     {
 5995 bruce@momjian.us         1683                 :             26 :         text       *pattern = PG_GETARG_TEXT_PP(1);
                               1684         [ +  + ]:             26 :         text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(2);
                               1685                 :                :         pg_re_flags re_flags;
                               1686                 :                :         MemoryContext oldcontext;
                               1687                 :                : 
 6235 neilc@samurai.com        1688                 :             26 :         funcctx = SRF_FIRSTCALL_INIT();
                               1689                 :             26 :         oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
                               1690                 :                : 
                               1691                 :                :         /* Determine options */
 2797 tgl@sss.pgh.pa.us        1692                 :             26 :         parse_re_flags(&re_flags, flags);
                               1693                 :                :         /* User mustn't specify 'g' */
                               1694         [ +  + ]:             23 :         if (re_flags.glob)
                               1695         [ +  - ]:              3 :             ereport(ERROR,
                               1696                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1697                 :                :             /* translator: %s is a SQL function name */
                               1698                 :                :                      errmsg("%s does not support the \"global\" option",
                               1699                 :                :                             "regexp_split_to_table()")));
                               1700                 :                :         /* But we find all the matches anyway */
                               1701                 :             20 :         re_flags.glob = true;
                               1702                 :                : 
                               1703                 :                :         /* be sure to copy the input string into the multi-call ctx */
 6091                          1704                 :             20 :         splitctx = setup_regexp_matches(PG_GETARG_TEXT_P_COPY(0), pattern,
                               1705                 :                :                                         &re_flags, 0,
                               1706                 :                :                                         PG_GET_COLLATION(),
                               1707                 :                :                                         false, true, true);
                               1708                 :                : 
 6235 neilc@samurai.com        1709                 :             20 :         MemoryContextSwitchTo(oldcontext);
                               1710                 :             20 :         funcctx->user_fctx = (void *) splitctx;
                               1711                 :                :     }
                               1712                 :                : 
                               1713                 :            305 :     funcctx = SRF_PERCALL_SETUP();
 6091 tgl@sss.pgh.pa.us        1714                 :            305 :     splitctx = (regexp_matches_ctx *) funcctx->user_fctx;
                               1715                 :                : 
                               1716         [ +  + ]:            305 :     if (splitctx->next_match <= splitctx->nmatches)
                               1717                 :                :     {
 5995 bruce@momjian.us         1718                 :            285 :         Datum       result = build_regexp_split_result(splitctx);
                               1719                 :                : 
 6091 tgl@sss.pgh.pa.us        1720                 :            285 :         splitctx->next_match++;
                               1721                 :            285 :         SRF_RETURN_NEXT(funcctx, result);
                               1722                 :                :     }
                               1723                 :                : 
                               1724                 :             20 :     SRF_RETURN_DONE(funcctx);
                               1725                 :                : }
                               1726                 :                : 
                               1727                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1728                 :                : Datum
 5995 bruce@momjian.us         1729                 :            276 : regexp_split_to_table_no_flags(PG_FUNCTION_ARGS)
                               1730                 :                : {
 6235 neilc@samurai.com        1731                 :            276 :     return regexp_split_to_table(fcinfo);
                               1732                 :                : }
                               1733                 :                : 
                               1734                 :                : /*
                               1735                 :                :  * regexp_split_to_array()
                               1736                 :                :  *      Split the string at matches of the pattern, returning the
                               1737                 :                :  *      split-out substrings as an array.
                               1738                 :                :  */
                               1739                 :                : Datum
 5995 bruce@momjian.us         1740                 :         100178 : regexp_split_to_array(PG_FUNCTION_ARGS)
                               1741                 :                : {
                               1742                 :         100178 :     ArrayBuildState *astate = NULL;
                               1743                 :                :     pg_re_flags re_flags;
                               1744                 :                :     regexp_matches_ctx *splitctx;
                               1745                 :                : 
                               1746                 :                :     /* Determine options */
 2797 tgl@sss.pgh.pa.us        1747         [ +  + ]:         100178 :     parse_re_flags(&re_flags, PG_GETARG_TEXT_PP_IF_EXISTS(2));
                               1748                 :                :     /* User mustn't specify 'g' */
                               1749         [ +  + ]:         100175 :     if (re_flags.glob)
                               1750         [ +  - ]:              3 :         ereport(ERROR,
                               1751                 :                :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1752                 :                :         /* translator: %s is a SQL function name */
                               1753                 :                :                  errmsg("%s does not support the \"global\" option",
                               1754                 :                :                         "regexp_split_to_array()")));
                               1755                 :                :     /* But we find all the matches anyway */
                               1756                 :         100172 :     re_flags.glob = true;
                               1757                 :                : 
 6050                          1758                 :         100172 :     splitctx = setup_regexp_matches(PG_GETARG_TEXT_PP(0),
                               1759                 :         100172 :                                     PG_GETARG_TEXT_PP(1),
                               1760                 :                :                                     &re_flags, 0,
                               1761                 :                :                                     PG_GET_COLLATION(),
                               1762                 :                :                                     false, true, true);
                               1763                 :                : 
 6091                          1764         [ +  + ]:         645580 :     while (splitctx->next_match <= splitctx->nmatches)
                               1765                 :                :     {
 6235 neilc@samurai.com        1766                 :         545408 :         astate = accumArrayResult(astate,
                               1767                 :                :                                   build_regexp_split_result(splitctx),
                               1768                 :                :                                   false,
                               1769                 :                :                                   TEXTOID,
                               1770                 :                :                                   CurrentMemoryContext);
 6091 tgl@sss.pgh.pa.us        1771                 :         545408 :         splitctx->next_match++;
                               1772                 :                :     }
                               1773                 :                : 
  595 peter@eisentraut.org     1774                 :         100172 :     PG_RETURN_DATUM(makeArrayResult(astate, CurrentMemoryContext));
                               1775                 :                : }
                               1776                 :                : 
                               1777                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1778                 :                : Datum
 5995 bruce@momjian.us         1779                 :         100157 : regexp_split_to_array_no_flags(PG_FUNCTION_ARGS)
                               1780                 :                : {
 6235 neilc@samurai.com        1781                 :         100157 :     return regexp_split_to_array(fcinfo);
                               1782                 :                : }
                               1783                 :                : 
                               1784                 :                : /*
                               1785                 :                :  * build_regexp_split_result - build output string for current match
                               1786                 :                :  *
                               1787                 :                :  * We return the string between the current match and the previous one,
                               1788                 :                :  * or the string after the last match when next_match == nmatches.
                               1789                 :                :  */
                               1790                 :                : static Datum
 5995 bruce@momjian.us         1791                 :         545693 : build_regexp_split_result(regexp_matches_ctx *splitctx)
                               1792                 :                : {
 2056 rhodiumtoad@postgres     1793                 :         545693 :     char       *buf = splitctx->conv_buf;
                               1794                 :                :     int         startpos;
                               1795                 :                :     int         endpos;
                               1796                 :                : 
 6091 tgl@sss.pgh.pa.us        1797         [ +  + ]:         545693 :     if (splitctx->next_match > 0)
                               1798                 :         445501 :         startpos = splitctx->match_locs[splitctx->next_match * 2 - 1];
                               1799                 :                :     else
                               1800                 :         100192 :         startpos = 0;
                               1801         [ -  + ]:         545693 :     if (startpos < 0)
 6091 tgl@sss.pgh.pa.us        1802         [ #  # ]:UBC           0 :         elog(ERROR, "invalid match ending position");
                               1803                 :                : 
 1550 tgl@sss.pgh.pa.us        1804                 :CBC      545693 :     endpos = splitctx->match_locs[splitctx->next_match * 2];
                               1805         [ -  + ]:         545693 :     if (endpos < startpos)
 1550 tgl@sss.pgh.pa.us        1806         [ #  # ]:UBC           0 :         elog(ERROR, "invalid match starting position");
                               1807                 :                : 
 2056 rhodiumtoad@postgres     1808         [ +  - ]:CBC      545693 :     if (buf)
                               1809                 :                :     {
                               1810                 :                :         int         len;
                               1811                 :                : 
                               1812                 :         545693 :         len = pg_wchar2mb_with_len(splitctx->wide_str + startpos,
                               1813                 :                :                                    buf,
                               1814                 :                :                                    endpos - startpos);
 1550 tgl@sss.pgh.pa.us        1815         [ -  + ]:         545693 :         Assert(len < splitctx->conv_bufsiz);
 2056 rhodiumtoad@postgres     1816                 :         545693 :         return PointerGetDatum(cstring_to_text_with_len(buf, len));
                               1817                 :                :     }
                               1818                 :                :     else
                               1819                 :                :     {
 2056 rhodiumtoad@postgres     1820                 :UBC           0 :         return DirectFunctionCall3(text_substr,
                               1821                 :                :                                    PointerGetDatum(splitctx->orig_str),
                               1822                 :                :                                    Int32GetDatum(startpos + 1),
                               1823                 :                :                                    Int32GetDatum(endpos - startpos));
                               1824                 :                :     }
                               1825                 :                : }
                               1826                 :                : 
                               1827                 :                : /*
                               1828                 :                :  * regexp_substr()
                               1829                 :                :  *      Return the substring that matches a regular expression pattern
                               1830                 :                :  */
                               1831                 :                : Datum
  985 tgl@sss.pgh.pa.us        1832                 :CBC          54 : regexp_substr(PG_FUNCTION_ARGS)
                               1833                 :                : {
                               1834                 :             54 :     text       *str = PG_GETARG_TEXT_PP(0);
                               1835                 :             54 :     text       *pattern = PG_GETARG_TEXT_PP(1);
                               1836                 :             54 :     int         start = 1;
                               1837                 :             54 :     int         n = 1;
                               1838         [ +  + ]:             54 :     text       *flags = PG_GETARG_TEXT_PP_IF_EXISTS(4);
                               1839                 :             54 :     int         subexpr = 0;
                               1840                 :                :     int         so,
                               1841                 :                :                 eo,
                               1842                 :                :                 pos;
                               1843                 :                :     pg_re_flags re_flags;
                               1844                 :                :     regexp_matches_ctx *matchctx;
                               1845                 :                : 
                               1846                 :                :     /* Collect optional parameters */
                               1847         [ +  + ]:             54 :     if (PG_NARGS() > 2)
                               1848                 :                :     {
                               1849                 :             45 :         start = PG_GETARG_INT32(2);
                               1850         [ +  + ]:             45 :         if (start <= 0)
                               1851         [ +  - ]:              3 :             ereport(ERROR,
                               1852                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1853                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1854                 :                :                             "start", start)));
                               1855                 :                :     }
                               1856         [ +  + ]:             51 :     if (PG_NARGS() > 3)
                               1857                 :                :     {
                               1858                 :             39 :         n = PG_GETARG_INT32(3);
                               1859         [ +  + ]:             39 :         if (n <= 0)
                               1860         [ +  - ]:              3 :             ereport(ERROR,
                               1861                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1862                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1863                 :                :                             "n", n)));
                               1864                 :                :     }
                               1865         [ +  + ]:             48 :     if (PG_NARGS() > 5)
                               1866                 :                :     {
                               1867                 :             24 :         subexpr = PG_GETARG_INT32(5);
                               1868         [ +  + ]:             24 :         if (subexpr < 0)
                               1869         [ +  - ]:              3 :             ereport(ERROR,
                               1870                 :                :                     (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1871                 :                :                      errmsg("invalid value for parameter \"%s\": %d",
                               1872                 :                :                             "subexpr", subexpr)));
                               1873                 :                :     }
                               1874                 :                : 
                               1875                 :                :     /* Determine options */
                               1876                 :             45 :     parse_re_flags(&re_flags, flags);
                               1877                 :                :     /* User mustn't specify 'g' */
                               1878         [ +  + ]:             45 :     if (re_flags.glob)
                               1879         [ +  - ]:              3 :         ereport(ERROR,
                               1880                 :                :                 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                               1881                 :                :         /* translator: %s is a SQL function name */
                               1882                 :                :                  errmsg("%s does not support the \"global\" option",
                               1883                 :                :                         "regexp_substr()")));
                               1884                 :                :     /* But we find all the matches anyway */
                               1885                 :             42 :     re_flags.glob = true;
                               1886                 :                : 
                               1887                 :                :     /* Do the matching */
                               1888                 :             42 :     matchctx = setup_regexp_matches(str, pattern, &re_flags, start - 1,
                               1889                 :                :                                     PG_GET_COLLATION(),
                               1890                 :                :                                     (subexpr > 0),   /* need submatches? */
                               1891                 :                :                                     false, false);
                               1892                 :                : 
                               1893                 :                :     /* When n exceeds matches return NULL (includes case of no matches) */
                               1894         [ +  + ]:             42 :     if (n > matchctx->nmatches)
                               1895                 :              6 :         PG_RETURN_NULL();
                               1896                 :                : 
                               1897                 :                :     /* When subexpr exceeds number of subexpressions return NULL */
                               1898         [ +  + ]:             36 :     if (subexpr > matchctx->npatterns)
                               1899                 :              3 :         PG_RETURN_NULL();
                               1900                 :                : 
                               1901                 :                :     /* Select the appropriate match position to return */
                               1902                 :             33 :     pos = (n - 1) * matchctx->npatterns;
                               1903         [ +  + ]:             33 :     if (subexpr > 0)
                               1904                 :             15 :         pos += subexpr - 1;
                               1905                 :             33 :     pos *= 2;
                               1906                 :             33 :     so = matchctx->match_locs[pos];
                               1907                 :             33 :     eo = matchctx->match_locs[pos + 1];
                               1908                 :                : 
                               1909   [ +  +  -  + ]:             33 :     if (so < 0 || eo < 0)
                               1910                 :              3 :         PG_RETURN_NULL();       /* unidentifiable location */
                               1911                 :                : 
                               1912                 :             30 :     PG_RETURN_DATUM(DirectFunctionCall3(text_substr,
                               1913                 :                :                                         PointerGetDatum(matchctx->orig_str),
                               1914                 :                :                                         Int32GetDatum(so + 1),
                               1915                 :                :                                         Int32GetDatum(eo - so)));
                               1916                 :                : }
                               1917                 :                : 
                               1918                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1919                 :                : Datum
                               1920                 :              9 : regexp_substr_no_start(PG_FUNCTION_ARGS)
                               1921                 :                : {
                               1922                 :              9 :     return regexp_substr(fcinfo);
                               1923                 :                : }
                               1924                 :                : 
                               1925                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1926                 :                : Datum
                               1927                 :              3 : regexp_substr_no_n(PG_FUNCTION_ARGS)
                               1928                 :                : {
                               1929                 :              3 :     return regexp_substr(fcinfo);
                               1930                 :                : }
                               1931                 :                : 
                               1932                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1933                 :                : Datum
                               1934                 :             12 : regexp_substr_no_flags(PG_FUNCTION_ARGS)
                               1935                 :                : {
                               1936                 :             12 :     return regexp_substr(fcinfo);
                               1937                 :                : }
                               1938                 :                : 
                               1939                 :                : /* This is separate to keep the opr_sanity regression test from complaining */
                               1940                 :                : Datum
                               1941                 :              6 : regexp_substr_no_subexpr(PG_FUNCTION_ARGS)
                               1942                 :                : {
                               1943                 :              6 :     return regexp_substr(fcinfo);
                               1944                 :                : }
                               1945                 :                : 
                               1946                 :                : /*
                               1947                 :                :  * regexp_fixed_prefix - extract fixed prefix, if any, for a regexp
                               1948                 :                :  *
                               1949                 :                :  * The result is NULL if there is no fixed prefix, else a palloc'd string.
                               1950                 :                :  * If it is an exact match, not just a prefix, *exact is returned as true.
                               1951                 :                :  */
                               1952                 :                : char *
 4296                          1953                 :           7190 : regexp_fixed_prefix(text *text_re, bool case_insensitive, Oid collation,
                               1954                 :                :                     bool *exact)
                               1955                 :                : {
                               1956                 :                :     char       *result;
                               1957                 :                :     regex_t    *re;
                               1958                 :                :     int         cflags;
                               1959                 :                :     int         re_result;
                               1960                 :                :     pg_wchar   *str;
                               1961                 :                :     size_t      slen;
                               1962                 :                :     size_t      maxlen;
                               1963                 :                :     char        errMsg[100];
                               1964                 :                : 
                               1965                 :           7190 :     *exact = false;             /* default result */
                               1966                 :                : 
                               1967                 :                :     /* Compile RE */
                               1968                 :           7190 :     cflags = REG_ADVANCED;
                               1969         [ +  + ]:           7190 :     if (case_insensitive)
                               1970                 :             31 :         cflags |= REG_ICASE;
                               1971                 :                : 
  979                          1972                 :           7190 :     re = RE_compile_and_cache(text_re, cflags | REG_NOSUB, collation);
                               1973                 :                : 
                               1974                 :                :     /* Examine it to see if there's a fixed prefix */
 4296                          1975                 :           7178 :     re_result = pg_regprefix(re, &str, &slen);
                               1976                 :                : 
                               1977   [ +  +  +  - ]:           7178 :     switch (re_result)
                               1978                 :                :     {
                               1979                 :            360 :         case REG_NOMATCH:
                               1980                 :            360 :             return NULL;
                               1981                 :                : 
                               1982                 :            907 :         case REG_PREFIX:
                               1983                 :                :             /* continue with wchar conversion */
                               1984                 :            907 :             break;
                               1985                 :                : 
                               1986                 :           5911 :         case REG_EXACT:
                               1987                 :           5911 :             *exact = true;
                               1988                 :                :             /* continue with wchar conversion */
                               1989                 :           5911 :             break;
                               1990                 :                : 
 4296 tgl@sss.pgh.pa.us        1991                 :UBC           0 :         default:
                               1992                 :                :             /* re failed??? */
                               1993                 :              0 :             pg_regerror(re_result, re, errMsg, sizeof(errMsg));
                               1994         [ #  # ]:              0 :             ereport(ERROR,
                               1995                 :                :                     (errcode(ERRCODE_INVALID_REGULAR_EXPRESSION),
                               1996                 :                :                      errmsg("regular expression failed: %s", errMsg)));
                               1997                 :                :             break;
                               1998                 :                :     }
                               1999                 :                : 
                               2000                 :                :     /* Convert pg_wchar result back to database encoding */
 4296 tgl@sss.pgh.pa.us        2001                 :CBC        6818 :     maxlen = pg_database_encoding_max_length() * slen + 1;
                               2002                 :           6818 :     result = (char *) palloc(maxlen);
                               2003                 :           6818 :     slen = pg_wchar2mb_with_len(str, result, slen);
                               2004         [ -  + ]:           6818 :     Assert(slen < maxlen);
                               2005                 :                : 
  372 tmunro@postgresql.or     2006                 :           6818 :     pfree(str);
                               2007                 :                : 
 4296 tgl@sss.pgh.pa.us        2008                 :           6818 :     return result;
                               2009                 :                : }
        

Generated by: LCOV version 2.1-beta2-3-g6141622