Back to index

php5  5.3.10
pcre_info.c
Go to the documentation of this file.
00001 /*************************************************
00002 *      Perl-Compatible Regular Expressions       *
00003 *************************************************/
00004 
00005 /* PCRE is a library of functions to support regular expressions whose syntax
00006 and semantics are as close as possible to those of the Perl 5 language.
00007 
00008                        Written by Philip Hazel
00009            Copyright (c) 1997-2009 University of Cambridge
00010 
00011 -----------------------------------------------------------------------------
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014 
00015     * Redistributions of source code must retain the above copyright notice,
00016       this list of conditions and the following disclaimer.
00017 
00018     * Redistributions in binary form must reproduce the above copyright
00019       notice, this list of conditions and the following disclaimer in the
00020       documentation and/or other materials provided with the distribution.
00021 
00022     * Neither the name of the University of Cambridge nor the names of its
00023       contributors may be used to endorse or promote products derived from
00024       this software without specific prior written permission.
00025 
00026 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00027 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036 POSSIBILITY OF SUCH DAMAGE.
00037 -----------------------------------------------------------------------------
00038 */
00039 
00040 
00041 /* This module contains the external function pcre_info(), which gives some
00042 information about a compiled pattern. However, use of this function is now
00043 deprecated, as it has been superseded by pcre_fullinfo(). */
00044 
00045 
00046 #include "config.h"
00047 
00048 #include "pcre_internal.h"
00049 
00050 
00051 /*************************************************
00052 * (Obsolete) Return info about compiled pattern  *
00053 *************************************************/
00054 
00055 /* This is the original "info" function. It picks potentially useful data out
00056 of the private structure, but its interface was too rigid. It remains for
00057 backwards compatibility. The public options are passed back in an int - though
00058 the re->options field has been expanded to a long int, all the public options
00059 at the low end of it, and so even on 16-bit systems this will still be OK.
00060 Therefore, I haven't changed the API for pcre_info().
00061 
00062 Arguments:
00063   argument_re   points to compiled code
00064   optptr        where to pass back the options
00065   first_byte    where to pass back the first character,
00066                 or -1 if multiline and all branches start ^,
00067                 or -2 otherwise
00068 
00069 Returns:        number of capturing subpatterns
00070                 or negative values on error
00071 */
00072 
00073 PCRE_EXP_DEFN int PCRE_CALL_CONVENTION
00074 pcre_info(const pcre *argument_re, int *optptr, int *first_byte)
00075 {
00076 real_pcre internal_re;
00077 const real_pcre *re = (const real_pcre *)argument_re;
00078 if (re == NULL) return PCRE_ERROR_NULL;
00079 if (re->magic_number != MAGIC_NUMBER)
00080   {
00081   re = _pcre_try_flipped(re, &internal_re, NULL, NULL);
00082   if (re == NULL) return PCRE_ERROR_BADMAGIC;
00083   }
00084 if (optptr != NULL) *optptr = (int)(re->options & PUBLIC_COMPILE_OPTIONS);
00085 if (first_byte != NULL)
00086   *first_byte = ((re->flags & PCRE_FIRSTSET) != 0)? re->first_byte :
00087      ((re->flags & PCRE_STARTLINE) != 0)? -1 : -2;
00088 return re->top_bracket;
00089 }
00090 
00091 /* End of pcre_info.c */