Rev 58345 | Blame | Last modification | View Log | Download | RSS feed
/************************************************** Perl-Compatible Regular Expressions **************************************************//* PCRE is a library of functions to support regular expressions whose syntaxand semantics are as close as possible to those of the Perl 5 language.Written by Philip HazelCopyright (c) 1997-2012 University of Cambridge-----------------------------------------------------------------------------Redistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditions are met:* Redistributions of source code must retain the above copyright notice,this list of conditions and the following disclaimer.* Redistributions in binary form must reproduce the above copyrightnotice, this list of conditions and the following disclaimer in thedocumentation and/or other materials provided with the distribution.* Neither the name of the University of Cambridge nor the names of itscontributors may be used to endorse or promote products derived fromthis software without specific prior written permission.THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THEIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSEARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BELIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, ORCONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OFSUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESSINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER INCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THEPOSSIBILITY OF SUCH DAMAGE.-----------------------------------------------------------------------------*//* This module contains some convenience functions for extracting substringsfrom the subject string after a regex match has succeeded. The original ideafor these functions came from Scott Wimer. */#ifdef HAVE_CONFIG_H#include "config.h"#endif#include "pcre_internal.h"/************************************************** Find number for named string **************************************************//* This function is used by the get_first_set() function below, as wellas being generally available. It assumes that names are unique.Arguments:code the compiled regexstringname the name whose number is requiredReturns: the number of the named parentheses, or a negative number(PCRE_ERROR_NOSUBSTRING) if not found*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre_get_stringnumber(const pcre *code, const char *stringname)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre16_get_stringnumber(const pcre16 *code, PCRE_SPTR16 stringname)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre32_get_stringnumber(const pcre32 *code, PCRE_SPTR32 stringname)#endif{int rc;int entrysize;int top, bot;pcre_uchar *nametable;#ifdef COMPILE_PCRE8if ((rc = pcre_fullinfo(code, NULL, PCRE_INFO_NAMECOUNT, &top)) != 0)return rc;if (top <= 0) return PCRE_ERROR_NOSUBSTRING;if ((rc = pcre_fullinfo(code, NULL, PCRE_INFO_NAMEENTRYSIZE, &entrysize)) != 0)return rc;if ((rc = pcre_fullinfo(code, NULL, PCRE_INFO_NAMETABLE, &nametable)) != 0)return rc;#endif#ifdef COMPILE_PCRE16if ((rc = pcre16_fullinfo(code, NULL, PCRE_INFO_NAMECOUNT, &top)) != 0)return rc;if (top <= 0) return PCRE_ERROR_NOSUBSTRING;if ((rc = pcre16_fullinfo(code, NULL, PCRE_INFO_NAMEENTRYSIZE, &entrysize)) != 0)return rc;if ((rc = pcre16_fullinfo(code, NULL, PCRE_INFO_NAMETABLE, &nametable)) != 0)return rc;#endif#ifdef COMPILE_PCRE32if ((rc = pcre32_fullinfo(code, NULL, PCRE_INFO_NAMECOUNT, &top)) != 0)return rc;if (top <= 0) return PCRE_ERROR_NOSUBSTRING;if ((rc = pcre32_fullinfo(code, NULL, PCRE_INFO_NAMEENTRYSIZE, &entrysize)) != 0)return rc;if ((rc = pcre32_fullinfo(code, NULL, PCRE_INFO_NAMETABLE, &nametable)) != 0)return rc;#endifbot = 0;while (top > bot){int mid = (top + bot) / 2;pcre_uchar *entry = nametable + entrysize*mid;int c = STRCMP_UC_UC((pcre_uchar *)stringname,(pcre_uchar *)(entry + IMM2_SIZE));if (c == 0) return GET2(entry, 0);if (c > 0) bot = mid + 1; else top = mid;}return PCRE_ERROR_NOSUBSTRING;}/************************************************** Find (multiple) entries for named string **************************************************//* This is used by the get_first_set() function below, as well as beinggenerally available. It is used when duplicated names are permitted.Arguments:code the compiled regexstringname the name whose entries requiredfirstptr where to put the pointer to the first entrylastptr where to put the pointer to the last entryReturns: the length of each entry, or a negative number(PCRE_ERROR_NOSUBSTRING) if not found*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre_get_stringtable_entries(const pcre *code, const char *stringname,char **firstptr, char **lastptr)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre16_get_stringtable_entries(const pcre16 *code, PCRE_SPTR16 stringname,PCRE_UCHAR16 **firstptr, PCRE_UCHAR16 **lastptr)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre32_get_stringtable_entries(const pcre32 *code, PCRE_SPTR32 stringname,PCRE_UCHAR32 **firstptr, PCRE_UCHAR32 **lastptr)#endif{int rc;int entrysize;int top, bot;pcre_uchar *nametable, *lastentry;#ifdef COMPILE_PCRE8if ((rc = pcre_fullinfo(code, NULL, PCRE_INFO_NAMECOUNT, &top)) != 0)return rc;if (top <= 0) return PCRE_ERROR_NOSUBSTRING;if ((rc = pcre_fullinfo(code, NULL, PCRE_INFO_NAMEENTRYSIZE, &entrysize)) != 0)return rc;if ((rc = pcre_fullinfo(code, NULL, PCRE_INFO_NAMETABLE, &nametable)) != 0)return rc;#endif#ifdef COMPILE_PCRE16if ((rc = pcre16_fullinfo(code, NULL, PCRE_INFO_NAMECOUNT, &top)) != 0)return rc;if (top <= 0) return PCRE_ERROR_NOSUBSTRING;if ((rc = pcre16_fullinfo(code, NULL, PCRE_INFO_NAMEENTRYSIZE, &entrysize)) != 0)return rc;if ((rc = pcre16_fullinfo(code, NULL, PCRE_INFO_NAMETABLE, &nametable)) != 0)return rc;#endif#ifdef COMPILE_PCRE32if ((rc = pcre32_fullinfo(code, NULL, PCRE_INFO_NAMECOUNT, &top)) != 0)return rc;if (top <= 0) return PCRE_ERROR_NOSUBSTRING;if ((rc = pcre32_fullinfo(code, NULL, PCRE_INFO_NAMEENTRYSIZE, &entrysize)) != 0)return rc;if ((rc = pcre32_fullinfo(code, NULL, PCRE_INFO_NAMETABLE, &nametable)) != 0)return rc;#endiflastentry = nametable + entrysize * (top - 1);bot = 0;while (top > bot){int mid = (top + bot) / 2;pcre_uchar *entry = nametable + entrysize*mid;int c = STRCMP_UC_UC((pcre_uchar *)stringname,(pcre_uchar *)(entry + IMM2_SIZE));if (c == 0){pcre_uchar *first = entry;pcre_uchar *last = entry;while (first > nametable){if (STRCMP_UC_UC((pcre_uchar *)stringname,(pcre_uchar *)(first - entrysize + IMM2_SIZE)) != 0) break;first -= entrysize;}while (last < lastentry){if (STRCMP_UC_UC((pcre_uchar *)stringname,(pcre_uchar *)(last + entrysize + IMM2_SIZE)) != 0) break;last += entrysize;}#if defined COMPILE_PCRE8*firstptr = (char *)first;*lastptr = (char *)last;#elif defined COMPILE_PCRE16*firstptr = (PCRE_UCHAR16 *)first;*lastptr = (PCRE_UCHAR16 *)last;#elif defined COMPILE_PCRE32*firstptr = (PCRE_UCHAR32 *)first;*lastptr = (PCRE_UCHAR32 *)last;#endifreturn entrysize;}if (c > 0) bot = mid + 1; else top = mid;}return PCRE_ERROR_NOSUBSTRING;}/************************************************** Find first set of multiple named strings **************************************************//* This function allows for duplicate names in the table of named substrings.It returns the number of the first one that was set in a pattern match.Arguments:code the compiled regexstringname the name of the capturing substringovector the vector of matched substringsReturns: the number of the first that is set,or the number of the last one if none are set,or a negative number on error*/#if defined COMPILE_PCRE8static intget_first_set(const pcre *code, const char *stringname, int *ovector)#elif defined COMPILE_PCRE16static intget_first_set(const pcre16 *code, PCRE_SPTR16 stringname, int *ovector)#elif defined COMPILE_PCRE32static intget_first_set(const pcre32 *code, PCRE_SPTR32 stringname, int *ovector)#endif{const REAL_PCRE *re = (const REAL_PCRE *)code;int entrysize;pcre_uchar *entry;#if defined COMPILE_PCRE8char *first, *last;#elif defined COMPILE_PCRE16PCRE_UCHAR16 *first, *last;#elif defined COMPILE_PCRE32PCRE_UCHAR32 *first, *last;#endif#if defined COMPILE_PCRE8if ((re->options & PCRE_DUPNAMES) == 0 && (re->flags & PCRE_JCHANGED) == 0)return pcre_get_stringnumber(code, stringname);entrysize = pcre_get_stringtable_entries(code, stringname, &first, &last);#elif defined COMPILE_PCRE16if ((re->options & PCRE_DUPNAMES) == 0 && (re->flags & PCRE_JCHANGED) == 0)return pcre16_get_stringnumber(code, stringname);entrysize = pcre16_get_stringtable_entries(code, stringname, &first, &last);#elif defined COMPILE_PCRE32if ((re->options & PCRE_DUPNAMES) == 0 && (re->flags & PCRE_JCHANGED) == 0)return pcre32_get_stringnumber(code, stringname);entrysize = pcre32_get_stringtable_entries(code, stringname, &first, &last);#endifif (entrysize <= 0) return entrysize;for (entry = (pcre_uchar *)first; entry <= (pcre_uchar *)last; entry += entrysize){int n = GET2(entry, 0);if (ovector[n*2] >= 0) return n;}return GET2(entry, 0);}/************************************************** Copy captured string to given buffer **************************************************//* This function copies a single captured substring into a given buffer.Note that we use memcpy() rather than strncpy() in case there are binary zerosin the string.Arguments:subject the subject string that was matchedovector pointer to the offsets tablestringcount the number of substrings that were captured(i.e. the yield of the pcre_exec call, unlessthat was zero, in which case it should be 1/3of the offset table size)stringnumber the number of the required substringbuffer where to put the substringsize the size of the bufferReturns: if successful:the length of the copied string, not including the zerothat is put on the end; can be zeroif not successful:PCRE_ERROR_NOMEMORY (-6) buffer too smallPCRE_ERROR_NOSUBSTRING (-7) no such captured substring*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre_copy_substring(const char *subject, int *ovector, int stringcount,int stringnumber, char *buffer, int size)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre16_copy_substring(PCRE_SPTR16 subject, int *ovector, int stringcount,int stringnumber, PCRE_UCHAR16 *buffer, int size)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre32_copy_substring(PCRE_SPTR32 subject, int *ovector, int stringcount,int stringnumber, PCRE_UCHAR32 *buffer, int size)#endif{int yield;if (stringnumber < 0 || stringnumber >= stringcount)return PCRE_ERROR_NOSUBSTRING;stringnumber *= 2;yield = ovector[stringnumber+1] - ovector[stringnumber];if (size < yield + 1) return PCRE_ERROR_NOMEMORY;memcpy(buffer, subject + ovector[stringnumber], IN_UCHARS(yield));buffer[yield] = 0;return yield;}/************************************************** Copy named captured string to given buffer **************************************************//* This function copies a single captured substring into a given buffer,identifying it by name. If the regex permits duplicate names, the firstsubstring that is set is chosen.Arguments:code the compiled regexsubject the subject string that was matchedovector pointer to the offsets tablestringcount the number of substrings that were captured(i.e. the yield of the pcre_exec call, unlessthat was zero, in which case it should be 1/3of the offset table size)stringname the name of the required substringbuffer where to put the substringsize the size of the bufferReturns: if successful:the length of the copied string, not including the zerothat is put on the end; can be zeroif not successful:PCRE_ERROR_NOMEMORY (-6) buffer too smallPCRE_ERROR_NOSUBSTRING (-7) no such captured substring*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre_copy_named_substring(const pcre *code, const char *subject,int *ovector, int stringcount, const char *stringname,char *buffer, int size)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre16_copy_named_substring(const pcre16 *code, PCRE_SPTR16 subject,int *ovector, int stringcount, PCRE_SPTR16 stringname,PCRE_UCHAR16 *buffer, int size)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre32_copy_named_substring(const pcre32 *code, PCRE_SPTR32 subject,int *ovector, int stringcount, PCRE_SPTR32 stringname,PCRE_UCHAR32 *buffer, int size)#endif{int n = get_first_set(code, stringname, ovector);if (n <= 0) return n;#if defined COMPILE_PCRE8return pcre_copy_substring(subject, ovector, stringcount, n, buffer, size);#elif defined COMPILE_PCRE16return pcre16_copy_substring(subject, ovector, stringcount, n, buffer, size);#elif defined COMPILE_PCRE32return pcre32_copy_substring(subject, ovector, stringcount, n, buffer, size);#endif}/************************************************** Copy all captured strings to new store **************************************************//* This function gets one chunk of store and builds a list of pointers and allof the captured substrings in it. A NULL pointer is put on the end of the list.Arguments:subject the subject string that was matchedovector pointer to the offsets tablestringcount the number of substrings that were captured(i.e. the yield of the pcre_exec call, unlessthat was zero, in which case it should be 1/3of the offset table size)listptr set to point to the list of pointersReturns: if successful: 0if not successful:PCRE_ERROR_NOMEMORY (-6) failed to get store*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre_get_substring_list(const char *subject, int *ovector, int stringcount,const char ***listptr)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre16_get_substring_list(PCRE_SPTR16 subject, int *ovector, int stringcount,PCRE_SPTR16 **listptr)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre32_get_substring_list(PCRE_SPTR32 subject, int *ovector, int stringcount,PCRE_SPTR32 **listptr)#endif{int i;int size = sizeof(pcre_uchar *);int double_count = stringcount * 2;pcre_uchar **stringlist;pcre_uchar *p;for (i = 0; i < double_count; i += 2)size += sizeof(pcre_uchar *) + IN_UCHARS(ovector[i+1] - ovector[i] + 1);stringlist = (pcre_uchar **)(PUBL(malloc))(size);if (stringlist == NULL) return PCRE_ERROR_NOMEMORY;#if defined COMPILE_PCRE8*listptr = (const char **)stringlist;#elif defined COMPILE_PCRE16*listptr = (PCRE_SPTR16 *)stringlist;#elif defined COMPILE_PCRE32*listptr = (PCRE_SPTR32 *)stringlist;#endifp = (pcre_uchar *)(stringlist + stringcount + 1);for (i = 0; i < double_count; i += 2){int len = ovector[i+1] - ovector[i];memcpy(p, subject + ovector[i], IN_UCHARS(len));*stringlist++ = p;p += len;*p++ = 0;}*stringlist = NULL;return 0;}/************************************************** Free store obtained by get_substring_list **************************************************//* This function exists for the benefit of people calling PCRE from non-Cprograms that can call its functions, but not free() or (PUBL(free))()directly.Argument: the result of a previous pcre_get_substring_list()Returns: nothing*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN void PCRE_CALL_CONVENTIONpcre_free_substring_list(const char **pointer)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN void PCRE_CALL_CONVENTIONpcre16_free_substring_list(PCRE_SPTR16 *pointer)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN void PCRE_CALL_CONVENTIONpcre32_free_substring_list(PCRE_SPTR32 *pointer)#endif{(PUBL(free))((void *)pointer);}/************************************************** Copy captured string to new store **************************************************//* This function copies a single captured substring into a piece of newstoreArguments:subject the subject string that was matchedovector pointer to the offsets tablestringcount the number of substrings that were captured(i.e. the yield of the pcre_exec call, unlessthat was zero, in which case it should be 1/3of the offset table size)stringnumber the number of the required substringstringptr where to put a pointer to the substringReturns: if successful:the length of the string, not including the zero thatis put on the end; can be zeroif not successful:PCRE_ERROR_NOMEMORY (-6) failed to get storePCRE_ERROR_NOSUBSTRING (-7) substring not present*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre_get_substring(const char *subject, int *ovector, int stringcount,int stringnumber, const char **stringptr)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre16_get_substring(PCRE_SPTR16 subject, int *ovector, int stringcount,int stringnumber, PCRE_SPTR16 *stringptr)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre32_get_substring(PCRE_SPTR32 subject, int *ovector, int stringcount,int stringnumber, PCRE_SPTR32 *stringptr)#endif{int yield;pcre_uchar *substring;if (stringnumber < 0 || stringnumber >= stringcount)return PCRE_ERROR_NOSUBSTRING;stringnumber *= 2;yield = ovector[stringnumber+1] - ovector[stringnumber];substring = (pcre_uchar *)(PUBL(malloc))(IN_UCHARS(yield + 1));if (substring == NULL) return PCRE_ERROR_NOMEMORY;memcpy(substring, subject + ovector[stringnumber], IN_UCHARS(yield));substring[yield] = 0;#if defined COMPILE_PCRE8*stringptr = (const char *)substring;#elif defined COMPILE_PCRE16*stringptr = (PCRE_SPTR16)substring;#elif defined COMPILE_PCRE32*stringptr = (PCRE_SPTR32)substring;#endifreturn yield;}/************************************************** Copy named captured string to new store **************************************************//* This function copies a single captured substring, identified by name, intonew store. If the regex permits duplicate names, the first substring that isset is chosen.Arguments:code the compiled regexsubject the subject string that was matchedovector pointer to the offsets tablestringcount the number of substrings that were captured(i.e. the yield of the pcre_exec call, unlessthat was zero, in which case it should be 1/3of the offset table size)stringname the name of the required substringstringptr where to put the pointerReturns: if successful:the length of the copied string, not including the zerothat is put on the end; can be zeroif not successful:PCRE_ERROR_NOMEMORY (-6) couldn't get memoryPCRE_ERROR_NOSUBSTRING (-7) no such captured substring*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre_get_named_substring(const pcre *code, const char *subject,int *ovector, int stringcount, const char *stringname,const char **stringptr)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre16_get_named_substring(const pcre16 *code, PCRE_SPTR16 subject,int *ovector, int stringcount, PCRE_SPTR16 stringname,PCRE_SPTR16 *stringptr)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN int PCRE_CALL_CONVENTIONpcre32_get_named_substring(const pcre32 *code, PCRE_SPTR32 subject,int *ovector, int stringcount, PCRE_SPTR32 stringname,PCRE_SPTR32 *stringptr)#endif{int n = get_first_set(code, stringname, ovector);if (n <= 0) return n;#if defined COMPILE_PCRE8return pcre_get_substring(subject, ovector, stringcount, n, stringptr);#elif defined COMPILE_PCRE16return pcre16_get_substring(subject, ovector, stringcount, n, stringptr);#elif defined COMPILE_PCRE32return pcre32_get_substring(subject, ovector, stringcount, n, stringptr);#endif}/************************************************** Free store obtained by get_substring **************************************************//* This function exists for the benefit of people calling PCRE from non-Cprograms that can call its functions, but not free() or (PUBL(free))()directly.Argument: the result of a previous pcre_get_substring()Returns: nothing*/#if defined COMPILE_PCRE8PCRE_EXP_DEFN void PCRE_CALL_CONVENTIONpcre_free_substring(const char *pointer)#elif defined COMPILE_PCRE16PCRE_EXP_DEFN void PCRE_CALL_CONVENTIONpcre16_free_substring(PCRE_SPTR16 pointer)#elif defined COMPILE_PCRE32PCRE_EXP_DEFN void PCRE_CALL_CONVENTIONpcre32_free_substring(PCRE_SPTR32 pointer)#endif{(PUBL(free))((void *)pointer);}/* End of pcre_get.c */