244afd9c7eaff630b002e560aabfcb81b9578e1a
[users/jgh/exim.git] / src / src / pcre / pcre_fullinfo.c
1 /* $Cambridge: exim/src/src/pcre/pcre_fullinfo.c,v 1.3 2006/11/07 16:50:36 ph10 Exp $ */
2
3 /*************************************************
4 *      Perl-Compatible Regular Expressions       *
5 *************************************************/
6
7 /*PCRE is a library of functions to support regular expressions whose syntax
8 and semantics are as close as possible to those of the Perl 5 language.
9
10                        Written by Philip Hazel
11            Copyright (c) 1997-2006 University of Cambridge
12
13 -----------------------------------------------------------------------------
14 Redistribution and use in source and binary forms, with or without
15 modification, are permitted provided that the following conditions are met:
16
17     * Redistributions of source code must retain the above copyright notice,
18       this list of conditions and the following disclaimer.
19
20     * Redistributions in binary form must reproduce the above copyright
21       notice, this list of conditions and the following disclaimer in the
22       documentation and/or other materials provided with the distribution.
23
24     * Neither the name of the University of Cambridge nor the names of its
25       contributors may be used to endorse or promote products derived from
26       this software without specific prior written permission.
27
28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
32 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 POSSIBILITY OF SUCH DAMAGE.
39 -----------------------------------------------------------------------------
40 */
41
42
43 /* This module contains the external function pcre_fullinfo(), which returns
44 information about a compiled pattern. */
45
46
47 #include "pcre_internal.h"
48
49
50 /*************************************************
51 *        Return info about compiled pattern      *
52 *************************************************/
53
54 /* This is a newer "info" function which has an extensible interface so
55 that additional items can be added compatibly.
56
57 Arguments:
58   argument_re      points to compiled code
59   extra_data       points extra data, or NULL
60   what             what information is required
61   where            where to put the information
62
63 Returns:           0 if data returned, negative on error
64 */
65
66 PCRE_DATA_SCOPE int
67 pcre_fullinfo(const pcre *argument_re, const pcre_extra *extra_data, int what,
68   void *where)
69 {
70 real_pcre internal_re;
71 pcre_study_data internal_study;
72 const real_pcre *re = (const real_pcre *)argument_re;
73 const pcre_study_data *study = NULL;
74
75 if (re == NULL || where == NULL) return PCRE_ERROR_NULL;
76
77 if (extra_data != NULL && (extra_data->flags & PCRE_EXTRA_STUDY_DATA) != 0)
78   study = (const pcre_study_data *)extra_data->study_data;
79
80 if (re->magic_number != MAGIC_NUMBER)
81   {
82   re = _pcre_try_flipped(re, &internal_re, study, &internal_study);
83   if (re == NULL) return PCRE_ERROR_BADMAGIC;
84   if (study != NULL) study = &internal_study;
85   }
86
87 switch (what)
88   {
89   case PCRE_INFO_OPTIONS:
90   *((unsigned long int *)where) = re->options & PUBLIC_OPTIONS;
91   break;
92
93   case PCRE_INFO_SIZE:
94   *((size_t *)where) = re->size;
95   break;
96
97   case PCRE_INFO_STUDYSIZE:
98   *((size_t *)where) = (study == NULL)? 0 : study->size;
99   break;
100
101   case PCRE_INFO_CAPTURECOUNT:
102   *((int *)where) = re->top_bracket;
103   break;
104
105   case PCRE_INFO_BACKREFMAX:
106   *((int *)where) = re->top_backref;
107   break;
108
109   case PCRE_INFO_FIRSTBYTE:
110   *((int *)where) =
111     ((re->options & PCRE_FIRSTSET) != 0)? re->first_byte :
112     ((re->options & PCRE_STARTLINE) != 0)? -1 : -2;
113   break;
114
115   /* Make sure we pass back the pointer to the bit vector in the external
116   block, not the internal copy (with flipped integer fields). */
117
118   case PCRE_INFO_FIRSTTABLE:
119   *((const uschar **)where) =
120     (study != NULL && (study->options & PCRE_STUDY_MAPPED) != 0)?
121       ((const pcre_study_data *)extra_data->study_data)->start_bits : NULL;
122   break;
123
124   case PCRE_INFO_LASTLITERAL:
125   *((int *)where) =
126     ((re->options & PCRE_REQCHSET) != 0)? re->req_byte : -1;
127   break;
128
129   case PCRE_INFO_NAMEENTRYSIZE:
130   *((int *)where) = re->name_entry_size;
131   break;
132
133   case PCRE_INFO_NAMECOUNT:
134   *((int *)where) = re->name_count;
135   break;
136
137   case PCRE_INFO_NAMETABLE:
138   *((const uschar **)where) = (const uschar *)re + re->name_table_offset;
139   break;
140
141   case PCRE_INFO_DEFAULT_TABLES:
142   *((const uschar **)where) = (const uschar *)(_pcre_default_tables);
143   break;
144
145   default: return PCRE_ERROR_BADOPTION;
146   }
147
148 return 0;
149 }
150
151 /* End of pcre_fullinfo.c */