1 /*************************************************
2 * Perl-Compatible Regular Expressions *
3 *************************************************/
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.
8 Written by Philip Hazel
9 Copyright (c) 1997-2012 University of Cambridge
11 -----------------------------------------------------------------------------
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright notice,
16 this list of conditions and the following disclaimer.
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.
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.
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 -----------------------------------------------------------------------------
41 /* This module contains a PCRE private debugging function for printing out the
42 internal form of a compiled regular expression, along with some supporting
43 local functions. This source file is used in two places:
45 (1) It is #included by pcre_compile.c when it is compiled in debugging mode
46 (PCRE_DEBUG defined in pcre_internal.h). It is not included in production
47 compiles. In this case PCRE_INCLUDED is defined.
49 (2) It is also compiled separately and linked with pcretest.c, which can be
50 asked to print out a compiled regex for debugging purposes. */
58 /* For pcretest program. */
59 #define PRIV(name) name
61 /* We have to include pcre_internal.h because we need the internal info for
62 displaying the results of pcre_study() and we also need to know about the
63 internal macros, structures, and other internal data values; pcretest has
64 "inside information" compared to a program that strictly follows the PCRE API.
66 Although pcre_internal.h does itself include pcre.h, we explicitly include it
67 here before pcre_internal.h so that the PCRE_EXP_xxx macros get set
68 appropriately for an application, not for building PCRE. */
71 #include "pcre_internal.h"
73 /* These are the funtions that are contained within. It doesn't seem worth
74 having a separate .h file just for this. */
76 #endif /* PCRE_INCLUDED */
79 static /* Keep the following function as private. */
82 #if defined COMPILE_PCRE8
83 void pcre_printint(pcre *external_re, FILE *f, BOOL print_lengths);
84 #elif defined COMPILE_PCRE16
85 void pcre16_printint(pcre *external_re, FILE *f, BOOL print_lengths);
86 #elif defined COMPILE_PCRE32
87 void pcre32_printint(pcre *external_re, FILE *f, BOOL print_lengths);
90 /* Macro that decides whether a character should be output as a literal or in
91 hexadecimal. We don't use isprint() because that can vary from system to system
92 (even without the use of locales) and we want the output always to be the same,
93 for testing purposes. */
96 #define PRINTABLE(c) ((c) >= 64 && (c) < 255)
98 #define PRINTABLE(c) ((c) >= 32 && (c) < 127)
101 /* The table of operator names. */
103 static const char *priv_OP_names[] = { OP_NAME_LIST };
105 /* This table of operator lengths is not actually used by the working code,
106 but its size is needed for a check that ensures it is the correct size for the
107 number of opcodes (thus catching update omissions). */
109 static const pcre_uint8 priv_OP_lengths[] = { OP_LENGTHS };
113 /*************************************************
114 * Print single- or multi-byte character *
115 *************************************************/
118 print_char(FILE *f, pcre_uchar *ptr, BOOL utf)
120 pcre_uint32 c = *ptr;
124 (void)utf; /* Avoid compiler warning */
125 if (PRINTABLE(c)) fprintf(f, "%c", (char)c);
126 else if (c <= 0x80) fprintf(f, "\\x%02x", c);
127 else fprintf(f, "\\x{%x}", c);
132 #if defined COMPILE_PCRE8
134 if (!utf || (c & 0xc0) != 0xc0)
136 if (PRINTABLE(c)) fprintf(f, "%c", (char)c);
137 else if (c < 0x80) fprintf(f, "\\x%02x", c);
138 else fprintf(f, "\\x{%02x}", c);
144 int a = PRIV(utf8_table4)[c & 0x3f]; /* Number of additional bytes */
146 c = (c & PRIV(utf8_table3)[a]) << s;
147 for (i = 1; i <= a; i++)
149 /* This is a check for malformed UTF-8; it should only occur if the sanity
150 check has been turned off. Rather than swallow random bytes, just stop if
151 we hit a bad one. Print it with \X instead of \x as an indication. */
153 if ((ptr[i] & 0xc0) != 0x80)
155 fprintf(f, "\\X{%x}", c);
162 c |= (ptr[i] & 0x3f) << s;
164 fprintf(f, "\\x{%x}", c);
168 #elif defined COMPILE_PCRE16
170 if (!utf || (c & 0xfc00) != 0xd800)
172 if (PRINTABLE(c)) fprintf(f, "%c", (char)c);
173 else if (c <= 0x80) fprintf(f, "\\x%02x", c);
174 else fprintf(f, "\\x{%02x}", c);
179 /* This is a check for malformed UTF-16; it should only occur if the sanity
180 check has been turned off. Rather than swallow a low surrogate, just stop if
181 we hit a bad one. Print it with \X instead of \x as an indication. */
183 if ((ptr[1] & 0xfc00) != 0xdc00)
185 fprintf(f, "\\X{%x}", c);
189 c = (((c & 0x3ff) << 10) | (ptr[1] & 0x3ff)) + 0x10000;
190 fprintf(f, "\\x{%x}", c);
194 #elif defined COMPILE_PCRE32
196 if (!utf || (c & 0xfffff800u) != 0xd800u)
198 if (PRINTABLE(c)) fprintf(f, "%c", (char)c);
199 else if (c <= 0x80) fprintf(f, "\\x%02x", c);
200 else fprintf(f, "\\x{%x}", c);
205 /* This is a check for malformed UTF-32; it should only occur if the sanity
206 check has been turned off. Rather than swallow a surrogate, just stop if
207 we hit one. Print it with \X instead of \x as an indication. */
208 fprintf(f, "\\X{%x}", c);
212 #endif /* COMPILE_PCRE[8|16|32] */
214 #endif /* SUPPORT_UTF */
217 /*************************************************
218 * Print uchar string (regardless of utf) *
219 *************************************************/
222 print_puchar(FILE *f, PCRE_PUCHAR ptr)
226 register pcre_uint32 c = *ptr++;
227 if (PRINTABLE(c)) fprintf(f, "%c", c); else fprintf(f, "\\x{%x}", c);
231 /*************************************************
232 * Find Unicode property name *
233 *************************************************/
236 get_ucpname(unsigned int ptype, unsigned int pvalue)
240 for (i = PRIV(utt_size) - 1; i >= 0; i--)
242 if (ptype == PRIV(utt)[i].type && pvalue == PRIV(utt)[i].value) break;
244 return (i >= 0)? PRIV(utt_names) + PRIV(utt)[i].name_offset : "??";
246 /* It gets harder and harder to shut off unwanted compiler warnings. */
247 ptype = ptype * pvalue;
248 return (ptype == pvalue)? "??" : "??";
253 /*************************************************
254 * Print Unicode property value *
255 *************************************************/
257 /* "Normal" properties can be printed from tables. The PT_CLIST property is a
258 pseudo-property that contains a pointer to a list of case-equivalent
259 characters. This is used only when UCP support is available and UTF mode is
260 selected. It should never occur otherwise, but just in case it does, have
261 something ready to print. */
264 print_prop(FILE *f, pcre_uchar *code, const char *before, const char *after)
266 if (code[1] != PT_CLIST)
268 fprintf(f, "%s%s %s%s", before, priv_OP_names[*code], get_ucpname(code[1],
273 const char *not = (*code == OP_PROP)? "" : "not ";
275 fprintf(f, "%s%sclist %d%s", before, not, code[2], after);
277 const pcre_uint32 *p = PRIV(ucd_caseless_sets) + code[2];
278 fprintf (f, "%s%sclist", before, not);
279 while (*p < NOTACHAR) fprintf(f, " %04x", *p++);
280 fprintf(f, "%s", after);
288 /*************************************************
289 * Print compiled regex *
290 *************************************************/
292 /* Make this function work for a regex with integers either byte order.
293 However, we assume that what we are passed is a compiled regex. The
294 print_lengths flag controls whether offsets and lengths of items are printed.
295 They can be turned off from pcretest so that automatic tests on bytecode can be
296 written that do not depend on the value of LINK_SIZE. */
299 static /* Keep the following function as private. */
301 #if defined COMPILE_PCRE8
303 pcre_printint(pcre *external_re, FILE *f, BOOL print_lengths)
304 #elif defined COMPILE_PCRE16
306 pcre16_printint(pcre *external_re, FILE *f, BOOL print_lengths)
307 #elif defined COMPILE_PCRE32
309 pcre32_printint(pcre *external_re, FILE *f, BOOL print_lengths)
312 REAL_PCRE *re = (REAL_PCRE *)external_re;
313 pcre_uchar *codestart, *code;
316 unsigned int options = re->options;
317 int offset = re->name_table_offset;
318 int count = re->name_count;
319 int size = re->name_entry_size;
321 if (re->magic_number != MAGIC_NUMBER)
323 offset = ((offset << 8) & 0xff00) | ((offset >> 8) & 0xff);
324 count = ((count << 8) & 0xff00) | ((count >> 8) & 0xff);
325 size = ((size << 8) & 0xff00) | ((size >> 8) & 0xff);
326 options = ((options << 24) & 0xff000000) |
327 ((options << 8) & 0x00ff0000) |
328 ((options >> 8) & 0x0000ff00) |
329 ((options >> 24) & 0x000000ff);
332 code = codestart = (pcre_uchar *)re + offset + count * size;
333 /* PCRE_UTF(16|32) have the same value as PCRE_UTF8. */
334 utf = (options & PCRE_UTF8) != 0;
339 const char *flag = " ";
341 unsigned int extra = 0;
344 fprintf(f, "%3d ", (int)(code - codestart));
350 /* ========================================================================== */
351 /* These cases are never obeyed. This is a fudge that causes a compile-
352 time error if the vectors OP_names or OP_lengths, which are indexed
353 by opcode, are not the correct length. It seems to be the only way to do
354 such a check at compile time, as the sizeof() operator does not work in
355 the C preprocessor. */
357 case OP_TABLE_LENGTH:
358 case OP_TABLE_LENGTH +
359 ((sizeof(priv_OP_names)/sizeof(const char *) == OP_TABLE_LENGTH) &&
360 (sizeof(priv_OP_lengths) == OP_TABLE_LENGTH)):
362 /* ========================================================================== */
365 fprintf(f, " %s\n", priv_OP_names[*code]);
366 fprintf(f, "------------------------------------------------------------------\n");
374 code += 1 + print_char(f, code, utf);
376 while (*code == OP_CHAR);
385 code += 1 + print_char(f, code, utf);
387 while (*code == OP_CHARI);
395 if (print_lengths) fprintf(f, "%3d ", GET(code, 1));
396 else fprintf(f, " ");
397 fprintf(f, "%s %d", priv_OP_names[*code], GET2(code, 1+LINK_SIZE));
412 case OP_ASSERTBACK_NOT:
418 if (print_lengths) fprintf(f, "%3d ", GET(code, 1));
419 else fprintf(f, " ");
420 fprintf(f, "%s", priv_OP_names[*code]);
424 fprintf(f, " %s %d", priv_OP_names[*code], GET2(code, 1));
428 fprintf(f, "%3d %s", GET2(code,1), priv_OP_names[*code]);
433 pcre_uchar *entry = (pcre_uchar *)re + offset + (GET2(code, 1) * size) +
435 fprintf(f, " %s Cond ref <", flag);
436 print_puchar(f, entry);
437 fprintf(f, ">%d", GET2(code, 1 + IMM2_SIZE));
444 fprintf(f, " Cond recurse any");
446 fprintf(f, " Cond recurse %d", c);
451 pcre_uchar *entry = (pcre_uchar *)re + offset + (GET2(code, 1) * size) +
453 fprintf(f, " %s Cond recurse <", flag);
454 print_puchar(f, entry);
455 fprintf(f, ">%d", GET2(code, 1 + IMM2_SIZE));
460 fprintf(f, " Cond def");
490 case OP_TYPEMINQUERY:
491 case OP_TYPEPOSQUERY:
492 fprintf(f, " %s ", flag);
493 if (*code >= OP_TYPESTAR)
495 if (code[1] == OP_PROP || code[1] == OP_NOTPROP)
497 print_prop(f, code + 1, "", " ");
500 else fprintf(f, "%s", priv_OP_names[code[1]]);
502 else extra = print_char(f, code+1, utf);
503 fprintf(f, "%s", priv_OP_names[*code]);
516 fprintf(f, " %s ", flag);
517 extra = print_char(f, code + 1 + IMM2_SIZE, utf);
519 if (*code != OP_EXACT && *code != OP_EXACTI) fprintf(f, "0,");
520 fprintf(f, "%d}", GET2(code,1));
521 if (*code == OP_MINUPTO || *code == OP_MINUPTOI) fprintf(f, "?");
522 else if (*code == OP_POSUPTO || *code == OP_POSUPTOI) fprintf(f, "+");
529 if (code[1 + IMM2_SIZE] == OP_PROP || code[1 + IMM2_SIZE] == OP_NOTPROP)
531 print_prop(f, code + IMM2_SIZE + 1, " ", " ");
534 else fprintf(f, " %s", priv_OP_names[code[1 + IMM2_SIZE]]);
536 if (*code != OP_TYPEEXACT) fprintf(f, "0,");
537 fprintf(f, "%d}", GET2(code,1));
538 if (*code == OP_TYPEMINUPTO) fprintf(f, "?");
539 else if (*code == OP_TYPEPOSUPTO) fprintf(f, "+");
546 fprintf(f, " %s [^", flag);
547 extra = print_char(f, code + 1, utf);
558 case OP_NOTMINQUERYI:
559 case OP_NOTPOSQUERYI:
572 fprintf(f, " %s [^", flag);
573 extra = print_char(f, code + 1, utf);
574 fprintf(f, "]%s", priv_OP_names[*code]);
588 fprintf(f, " %s [^", flag);
589 extra = print_char(f, code + 1 + IMM2_SIZE, utf);
591 if (*code != OP_NOTEXACT && *code != OP_NOTEXACTI) fprintf(f, "0,");
592 fprintf(f, "%d}", GET2(code,1));
593 if (*code == OP_NOTMINUPTO || *code == OP_NOTMINUPTOI) fprintf(f, "?");
595 if (*code == OP_NOTPOSUPTO || *code == OP_NOTPOSUPTOI) fprintf(f, "+");
599 if (print_lengths) fprintf(f, "%3d ", GET(code, 1));
600 else fprintf(f, " ");
601 fprintf(f, "%s", priv_OP_names[*code]);
608 fprintf(f, " %s \\%d", flag, GET2(code,1));
609 ccode = code + priv_OP_lengths[*code];
610 goto CLASS_REF_REPEAT;
617 pcre_uchar *entry = (pcre_uchar *)re + offset + (GET2(code, 1) * size) +
619 fprintf(f, " %s \\k<", flag);
620 print_puchar(f, entry);
621 fprintf(f, ">%d", GET2(code, 1 + IMM2_SIZE));
623 ccode = code + priv_OP_lengths[*code];
624 goto CLASS_REF_REPEAT;
627 fprintf(f, " %s %d %d %d", priv_OP_names[*code], code[1], GET(code,2),
628 GET(code, 2 + LINK_SIZE));
633 print_prop(f, code, " ", "");
636 /* OP_XCLASS cannot occur in 8-bit, non-UTF mode. However, there's no harm
637 in having this code always here, and it makes it less messy without all
645 unsigned int min, max;
647 BOOL invertmap = FALSE;
649 pcre_uint8 inverted_map[32];
653 if (*code == OP_XCLASS)
655 extra = GET(code, 1);
656 ccode = code + LINK_SIZE + 1;
657 printmap = (*ccode & XCL_MAP) != 0;
658 if ((*ccode & XCL_NOT) != 0)
660 invertmap = (*ccode & XCL_HASPROP) == 0;
671 /* Print a bit map */
675 map = (pcre_uint8 *)ccode;
678 for (i = 0; i < 32; i++) inverted_map[i] = ~map[i];
682 for (i = 0; i < 256; i++)
684 if ((map[i/8] & (1 << (i&7))) != 0)
687 for (j = i+1; j < 256; j++)
688 if ((map[j/8] & (1 << (j&7))) == 0) break;
689 if (i == '-' || i == ']') fprintf(f, "\\");
690 if (PRINTABLE(i)) fprintf(f, "%c", i);
691 else fprintf(f, "\\x%02x", i);
694 if (j != i + 1) fprintf(f, "-");
695 if (j == '-' || j == ']') fprintf(f, "\\");
696 if (PRINTABLE(j)) fprintf(f, "%c", j);
697 else fprintf(f, "\\x%02x", j);
702 ccode += 32 / sizeof(pcre_uchar);
705 /* For an XCLASS there is always some additional data */
707 if (*code == OP_XCLASS)
710 while ((ch = *ccode++) != XCL_END)
713 const char *notch = "";
724 unsigned int ptype = *ccode++;
725 unsigned int pvalue = *ccode++;
730 fprintf(f, "[:%sgraph:]", notch);
734 fprintf(f, "[:%sprint:]", notch);
738 fprintf(f, "[:%spunct:]", notch);
742 fprintf(f, "\\%c{%s}", (not? 'P':'p'),
743 get_ucpname(ptype, pvalue));
750 ccode += 1 + print_char(f, ccode, utf);
754 ccode += 1 + print_char(f, ccode, utf);
761 /* Indicate a non-UTF class which was created by negation */
763 fprintf(f, "]%s", (*code == OP_NCLASS)? " (neg)" : "");
765 /* Handle repeats after a class or a back reference */
779 fprintf(f, "%s", priv_OP_names[*ccode]);
780 extra += priv_OP_lengths[*ccode];
787 max = GET2(ccode,1 + IMM2_SIZE);
788 if (max == 0) fprintf(f, "{%u,}", min);
789 else fprintf(f, "{%u,%u}", min, max);
790 if (*ccode == OP_CRMINRANGE) fprintf(f, "?");
791 else if (*ccode == OP_CRPOSRANGE) fprintf(f, "+");
792 extra += priv_OP_lengths[*ccode];
795 /* Do nothing if it's not a repeat; this code stops picky compilers
796 warning about the lack of a default code path. */
808 fprintf(f, " %s ", priv_OP_names[*code]);
809 print_puchar(f, code + 2);
814 fprintf(f, " %s", priv_OP_names[*code]);
822 /* Anything else is just an item with no data, but possibly a flag. */
825 fprintf(f, " %s %s", flag, priv_OP_names[*code]);
829 code += priv_OP_lengths[*code] + extra;
834 /* End of pcre_printint.src */