Home | History | Annotate | Download | only in pcre
      1 /*************************************************
      2 *      Perl-Compatible Regular Expressions       *
      3 *************************************************/
      4 
      5 /* PCRE is a library of functions to support regular expressions whose syntax
      6 and semantics are as close as possible to those of the Perl 5 language.
      7 
      8                        Written by Philip Hazel
      9            Copyright (c) 1997-2009 University of Cambridge
     10 
     11 -----------------------------------------------------------------------------
     12 Redistribution and use in source and binary forms, with or without
     13 modification, are permitted provided that the following conditions are met:
     14 
     15     * Redistributions of source code must retain the above copyright notice,
     16       this list of conditions and the following disclaimer.
     17 
     18     * Redistributions in binary form must reproduce the above copyright
     19       notice, this list of conditions and the following disclaimer in the
     20       documentation and/or other materials provided with the distribution.
     21 
     22     * Neither the name of the University of Cambridge nor the names of its
     23       contributors may be used to endorse or promote products derived from
     24       this software without specific prior written permission.
     25 
     26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     27 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     28 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     29 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
     30 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36 POSSIBILITY OF SUCH DAMAGE.
     37 -----------------------------------------------------------------------------
     38 */
     39 
     40 
     41 /* This module contains the external function pcre_info(), which gives some
     42 information about a compiled pattern. However, use of this function is now
     43 deprecated, as it has been superseded by pcre_fullinfo(). */
     44 
     45 
     46 #ifdef HAVE_CONFIG_H
     47 #include "config.h"
     48 #endif
     49 
     50 #include "pcre_internal.h"
     51 
     52 
     53 /*************************************************
     54 * (Obsolete) Return info about compiled pattern  *
     55 *************************************************/
     56 
     57 /* This is the original "info" function. It picks potentially useful data out
     58 of the private structure, but its interface was too rigid. It remains for
     59 backwards compatibility. The public options are passed back in an int - though
     60 the re->options field has been expanded to a long int, all the public options
     61 at the low end of it, and so even on 16-bit systems this will still be OK.
     62 Therefore, I haven't changed the API for pcre_info().
     63 
     64 Arguments:
     65   argument_re   points to compiled code
     66   optptr        where to pass back the options
     67   first_byte    where to pass back the first character,
     68                 or -1 if multiline and all branches start ^,
     69                 or -2 otherwise
     70 
     71 Returns:        number of capturing subpatterns
     72                 or negative values on error
     73 */
     74 
     75 PCRE_EXP_DEFN int PCRE_CALL_CONVENTION
     76 pcre_info(const pcre *argument_re, int *optptr, int *first_byte)
     77 {
     78 real_pcre internal_re;
     79 const real_pcre *re = (const real_pcre *)argument_re;
     80 if (re == NULL) return PCRE_ERROR_NULL;
     81 if (re->magic_number != MAGIC_NUMBER)
     82   {
     83   re = _pcre_try_flipped(re, &internal_re, NULL, NULL);
     84   if (re == NULL) return PCRE_ERROR_BADMAGIC;
     85   }
     86 if (optptr != NULL) *optptr = (int)(re->options & PUBLIC_COMPILE_OPTIONS);
     87 if (first_byte != NULL)
     88   *first_byte = ((re->flags & PCRE_FIRSTSET) != 0)? re->first_byte :
     89      ((re->flags & PCRE_STARTLINE) != 0)? -1 : -2;
     90 return re->top_bracket;
     91 }
     92 
     93 /* End of pcre_info.c */
     94