Update.
[platform/upstream/glibc.git] / posix / regex.h
1 /* Definitions for data structures and routines for the regular
2    expression library, version 0.12.
3    Copyright (C) 1985,89,90,91,92,93,95,96,97 Free Software Foundation, Inc.
4
5    This file is part of the GNU C Library.  Its master source is NOT part of
6    the C library, however.  The master source lives in /gd/gnu/lib.
7
8    The GNU C Library is free software; you can redistribute it and/or
9    modify it under the terms of the GNU Library General Public License as
10    published by the Free Software Foundation; either version 2 of the
11    License, or (at your option) any later version.
12
13    The GNU C Library is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    Library General Public License for more details.
17
18    You should have received a copy of the GNU Library General Public
19    License along with the GNU C Library; see the file COPYING.LIB.  If not,
20    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21    Boston, MA 02111-1307, USA.  */
22
23 #ifndef __REGEXP_LIBRARY_H__
24 #define __REGEXP_LIBRARY_H__
25
26 /* Allow the use in C++ code.  */
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 /* POSIX says that <sys/types.h> must be included (by the caller) before
32    <regex.h>.  */
33
34 #if !defined (_POSIX_C_SOURCE) && !defined (_POSIX_SOURCE) && defined (VMS)
35 /* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it
36    should be there.  */
37 #include <stddef.h>
38 #endif
39
40 /* The following two types have to be signed and unsigned integer type
41    wide enough to hold a value of a pointer.  For most ANSI compilers
42    ptrdiff_t and size_t should be likely OK.  Still size of these two
43    types is 2 for Microsoft C.  Ugh... */
44 typedef long int s_reg_t;
45 typedef unsigned long int active_reg_t;
46
47 /* The following bits are used to determine the regexp syntax we
48    recognize.  The set/not-set meanings are chosen so that Emacs syntax
49    remains the value 0.  The bits are given in alphabetical order, and
50    the definitions shifted by one from the previous bit; thus, when we
51    add or remove a bit, only one other definition need change.  */
52 typedef unsigned long int reg_syntax_t;
53
54 /* If this bit is not set, then \ inside a bracket expression is literal.
55    If set, then such a \ quotes the following character.  */
56 #define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1)
57
58 /* If this bit is not set, then + and ? are operators, and \+ and \? are
59      literals.
60    If set, then \+ and \? are operators and + and ? are literals.  */
61 #define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
62
63 /* If this bit is set, then character classes are supported.  They are:
64      [:alpha:], [:upper:], [:lower:],  [:digit:], [:alnum:], [:xdigit:],
65      [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
66    If not set, then character classes are not supported.  */
67 #define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
68
69 /* If this bit is set, then ^ and $ are always anchors (outside bracket
70      expressions, of course).
71    If this bit is not set, then it depends:
72         ^  is an anchor if it is at the beginning of a regular
73            expression or after an open-group or an alternation operator;
74         $  is an anchor if it is at the end of a regular expression, or
75            before a close-group or an alternation operator.
76
77    This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
78    POSIX draft 11.2 says that * etc. in leading positions is undefined.
79    We already implemented a previous draft which made those constructs
80    invalid, though, so we haven't changed the code back.  */
81 #define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
82
83 /* If this bit is set, then special characters are always special
84      regardless of where they are in the pattern.
85    If this bit is not set, then special characters are special only in
86      some contexts; otherwise they are ordinary.  Specifically,
87      * + ? and intervals are only special when not after the beginning,
88      open-group, or alternation operator.  */
89 #define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
90
91 /* If this bit is set, then *, +, ?, and { cannot be first in an re or
92      immediately after an alternation or begin-group operator.  */
93 #define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
94
95 /* If this bit is set, then . matches newline.
96    If not set, then it doesn't.  */
97 #define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
98
99 /* If this bit is set, then . doesn't match NUL.
100    If not set, then it does.  */
101 #define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
102
103 /* If this bit is set, nonmatching lists [^...] do not match newline.
104    If not set, they do.  */
105 #define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
106
107 /* If this bit is set, either \{...\} or {...} defines an
108      interval, depending on RE_NO_BK_BRACES.
109    If not set, \{, \}, {, and } are literals.  */
110 #define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
111
112 /* If this bit is set, +, ? and | aren't recognized as operators.
113    If not set, they are.  */
114 #define RE_LIMITED_OPS (RE_INTERVALS << 1)
115
116 /* If this bit is set, newline is an alternation operator.
117    If not set, newline is literal.  */
118 #define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
119
120 /* If this bit is set, then `{...}' defines an interval, and \{ and \}
121      are literals.
122   If not set, then `\{...\}' defines an interval.  */
123 #define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)
124
125 /* If this bit is set, (...) defines a group, and \( and \) are literals.
126    If not set, \(...\) defines a group, and ( and ) are literals.  */
127 #define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
128
129 /* If this bit is set, then \<digit> matches <digit>.
130    If not set, then \<digit> is a back-reference.  */
131 #define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
132
133 /* If this bit is set, then | is an alternation operator, and \| is literal.
134    If not set, then \| is an alternation operator, and | is literal.  */
135 #define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
136
137 /* If this bit is set, then an ending range point collating higher
138      than the starting range point, as in [z-a], is invalid.
139    If not set, then when ending range point collates higher than the
140      starting range point, the range is ignored.  */
141 #define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)
142
143 /* If this bit is set, then an unmatched ) is ordinary.
144    If not set, then an unmatched ) is invalid.  */
145 #define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)
146
147 /* If this bit is set, succeed as soon as we match the whole pattern,
148    without further backtracking.  */
149 #define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1)
150
151 /* If this bit is set, do not process the GNU regex operators.
152    If not set, then the GNU regex operators are recognized. */
153 #define RE_NO_GNU_OPS (RE_NO_POSIX_BACKTRACKING << 1)
154
155 /* This global variable defines the particular regexp syntax to use (for
156    some interfaces).  When a regexp is compiled, the syntax used is
157    stored in the pattern buffer, so changing this does not affect
158    already-compiled regexps.  */
159 extern reg_syntax_t re_syntax_options;
160 \f
161 /* Define combinations of the above bits for the standard possibilities.
162    (The [[[ comments delimit what gets put into the Texinfo file, so
163    don't delete them!)  */
164 /* [[[begin syntaxes]]] */
165 #define RE_SYNTAX_EMACS 0
166
167 #define RE_SYNTAX_AWK                                                   \
168   (RE_BACKSLASH_ESCAPE_IN_LISTS   | RE_DOT_NOT_NULL                     \
169    | RE_NO_BK_PARENS              | RE_NO_BK_REFS                       \
170    | RE_NO_BK_VBAR                | RE_NO_EMPTY_RANGES                  \
171    | RE_DOT_NEWLINE                                                     \
172    | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS)
173
174 #define RE_SYNTAX_GNU_AWK                                               \
175   ((RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS)            \
176    & ~(RE_DOT_NOT_NULL | RE_INTERVALS))
177
178 #define RE_SYNTAX_POSIX_AWK                                             \
179   (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS | RE_NO_GNU_OPS)
180
181 #define RE_SYNTAX_GREP                                                  \
182   (RE_BK_PLUS_QM              | RE_CHAR_CLASSES                         \
183    | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS                            \
184    | RE_NEWLINE_ALT)
185
186 #define RE_SYNTAX_EGREP                                                 \
187   (RE_CHAR_CLASSES        | RE_CONTEXT_INDEP_ANCHORS                    \
188    | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE                    \
189    | RE_NEWLINE_ALT       | RE_NO_BK_PARENS                             \
190    | RE_NO_BK_VBAR)
191
192 #define RE_SYNTAX_POSIX_EGREP                                           \
193   (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)
194
195 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff.  */
196 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
197
198 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
199
200 /* Syntax bits common to both basic and extended POSIX regex syntax.  */
201 #define _RE_SYNTAX_POSIX_COMMON                                         \
202   (RE_CHAR_CLASSES | RE_DOT_NEWLINE      | RE_DOT_NOT_NULL              \
203    | RE_INTERVALS  | RE_NO_EMPTY_RANGES)
204
205 #define RE_SYNTAX_POSIX_BASIC                                           \
206   (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
207
208 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes
209    RE_LIMITED_OPS, i.e., \? \+ \| are not recognized.  Actually, this
210    isn't minimal, since other operators, such as \`, aren't disabled.  */
211 #define RE_SYNTAX_POSIX_MINIMAL_BASIC                                   \
212   (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)
213
214 #define RE_SYNTAX_POSIX_EXTENDED                                        \
215   (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS                   \
216    | RE_CONTEXT_INDEP_OPS  | RE_NO_BK_BRACES                            \
217    | RE_NO_BK_PARENS       | RE_NO_BK_VBAR                              \
218    | RE_UNMATCHED_RIGHT_PAREN_ORD)
219
220 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS
221    replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added.  */
222 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED                                \
223   (_RE_SYNTAX_POSIX_COMMON  | RE_CONTEXT_INDEP_ANCHORS                  \
224    | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES                           \
225    | RE_NO_BK_PARENS        | RE_NO_BK_REFS                             \
226    | RE_NO_BK_VBAR          | RE_UNMATCHED_RIGHT_PAREN_ORD)
227 /* [[[end syntaxes]]] */
228 \f
229 /* Maximum number of duplicates an interval can allow.  Some systems
230    (erroneously) define this in other header files, but we want our
231    value, so remove any previous define.  */
232 #ifdef RE_DUP_MAX
233 #undef RE_DUP_MAX
234 #endif
235 /* If sizeof(int) == 2, then ((1 << 15) - 1) overflows.  */
236 #define RE_DUP_MAX (0x7fff)
237
238
239 /* POSIX `cflags' bits (i.e., information for `regcomp').  */
240
241 /* If this bit is set, then use extended regular expression syntax.
242    If not set, then use basic regular expression syntax.  */
243 #define REG_EXTENDED 1
244
245 /* If this bit is set, then ignore case when matching.
246    If not set, then case is significant.  */
247 #define REG_ICASE (REG_EXTENDED << 1)
248
249 /* If this bit is set, then anchors do not match at newline
250      characters in the string.
251    If not set, then anchors do match at newlines.  */
252 #define REG_NEWLINE (REG_ICASE << 1)
253
254 /* If this bit is set, then report only success or fail in regexec.
255    If not set, then returns differ between not matching and errors.  */
256 #define REG_NOSUB (REG_NEWLINE << 1)
257
258
259 /* POSIX `eflags' bits (i.e., information for regexec).  */
260
261 /* If this bit is set, then the beginning-of-line operator doesn't match
262      the beginning of the string (presumably because it's not the
263      beginning of a line).
264    If not set, then the beginning-of-line operator does match the
265      beginning of the string.  */
266 #define REG_NOTBOL 1
267
268 /* Like REG_NOTBOL, except for the end-of-line.  */
269 #define REG_NOTEOL (1 << 1)
270
271
272 /* If any error codes are removed, changed, or added, update the
273    `re_error_msg' table in regex.c.  */
274 typedef enum
275 {
276   REG_NOERROR = 0,      /* Success.  */
277   REG_NOMATCH,          /* Didn't find a match (for regexec).  */
278
279   /* POSIX regcomp return error codes.  (In the order listed in the
280      standard.)  */
281   REG_BADPAT,           /* Invalid pattern.  */
282   REG_ECOLLATE,         /* Not implemented.  */
283   REG_ECTYPE,           /* Invalid character class name.  */
284   REG_EESCAPE,          /* Trailing backslash.  */
285   REG_ESUBREG,          /* Invalid back reference.  */
286   REG_EBRACK,           /* Unmatched left bracket.  */
287   REG_EPAREN,           /* Parenthesis imbalance.  */
288   REG_EBRACE,           /* Unmatched \{.  */
289   REG_BADBR,            /* Invalid contents of \{\}.  */
290   REG_ERANGE,           /* Invalid range end.  */
291   REG_ESPACE,           /* Ran out of memory.  */
292   REG_BADRPT,           /* No preceding re for repetition op.  */
293
294   /* Error codes we've added.  */
295   REG_EEND,             /* Premature end.  */
296   REG_ESIZE,            /* Compiled pattern bigger than 2^16 bytes.  */
297   REG_ERPAREN           /* Unmatched ) or \); not returned from regcomp.  */
298 } reg_errcode_t;
299 \f
300 /* This data structure represents a compiled pattern.  Before calling
301    the pattern compiler, the fields `buffer', `allocated', `fastmap',
302    `translate', and `no_sub' can be set.  After the pattern has been
303    compiled, the `re_nsub' field is available.  All other fields are
304    private to the regex routines.  */
305
306 #ifndef RE_TRANSLATE_TYPE
307 #define RE_TRANSLATE_TYPE char *
308 #endif
309
310 struct re_pattern_buffer
311 {
312 /* [[[begin pattern_buffer]]] */
313         /* Space that holds the compiled pattern.  It is declared as
314           `unsigned char *' because its elements are
315            sometimes used as array indexes.  */
316   unsigned char *buffer;
317
318         /* Number of bytes to which `buffer' points.  */
319   unsigned long allocated;
320
321         /* Number of bytes actually used in `buffer'.  */
322   unsigned long used;
323
324         /* Syntax setting with which the pattern was compiled.  */
325   reg_syntax_t syntax;
326
327         /* Pointer to a fastmap, if any, otherwise zero.  re_search uses
328            the fastmap, if there is one, to skip over impossible
329            starting points for matches.  */
330   char *fastmap;
331
332         /* Either a translate table to apply to all characters before
333            comparing them, or zero for no translation.  The translation
334            is applied to a pattern when it is compiled and to a string
335            when it is matched.  */
336   RE_TRANSLATE_TYPE translate;
337
338         /* Number of subexpressions found by the compiler.  */
339   size_t re_nsub;
340
341         /* Zero if this pattern cannot match the empty string, one else.
342            Well, in truth it's used only in `re_search_2', to see
343            whether or not we should use the fastmap, so we don't set
344            this absolutely perfectly; see `re_compile_fastmap' (the
345            `duplicate' case).  */
346   unsigned can_be_null : 1;
347
348         /* If REGS_UNALLOCATED, allocate space in the `regs' structure
349              for `max (RE_NREGS, re_nsub + 1)' groups.
350            If REGS_REALLOCATE, reallocate space if necessary.
351            If REGS_FIXED, use what's there.  */
352 #define REGS_UNALLOCATED 0
353 #define REGS_REALLOCATE 1
354 #define REGS_FIXED 2
355   unsigned regs_allocated : 2;
356
357         /* Set to zero when `regex_compile' compiles a pattern; set to one
358            by `re_compile_fastmap' if it updates the fastmap.  */
359   unsigned fastmap_accurate : 1;
360
361         /* If set, `re_match_2' does not return information about
362            subexpressions.  */
363   unsigned no_sub : 1;
364
365         /* If set, a beginning-of-line anchor doesn't match at the
366            beginning of the string.  */
367   unsigned not_bol : 1;
368
369         /* Similarly for an end-of-line anchor.  */
370   unsigned not_eol : 1;
371
372         /* If true, an anchor at a newline matches.  */
373   unsigned newline_anchor : 1;
374
375 /* [[[end pattern_buffer]]] */
376 };
377
378 typedef struct re_pattern_buffer regex_t;
379 \f
380 /* Type for byte offsets within the string.  POSIX mandates this.  */
381 typedef int regoff_t;
382
383
384 /* This is the structure we store register match data in.  See
385    regex.texinfo for a full description of what registers match.  */
386 struct re_registers
387 {
388   unsigned num_regs;
389   regoff_t *start;
390   regoff_t *end;
391 };
392
393
394 /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
395    `re_match_2' returns information about at least this many registers
396    the first time a `regs' structure is passed.  */
397 #ifndef RE_NREGS
398 #define RE_NREGS 30
399 #endif
400
401
402 /* POSIX specification for registers.  Aside from the different names than
403    `re_registers', POSIX uses an array of structures, instead of a
404    structure of arrays.  */
405 typedef struct
406 {
407   regoff_t rm_so;  /* Byte offset from string's start to substring's start.  */
408   regoff_t rm_eo;  /* Byte offset from string's start to substring's end.  */
409 } regmatch_t;
410 \f
411 /* Declarations for routines.  */
412
413 /* To avoid duplicating every routine declaration -- once with a
414    prototype (if we are ANSI), and once without (if we aren't) -- we
415    use the following macro to declare argument types.  This
416    unfortunately clutters up the declarations a bit, but I think it's
417    worth it.  */
418
419 #if __STDC__
420
421 #define _RE_ARGS(args) args
422
423 #else /* not __STDC__ */
424
425 #define _RE_ARGS(args) ()
426
427 #endif /* not __STDC__ */
428
429 /* Sets the current default syntax to SYNTAX, and return the old syntax.
430    You can also simply assign to the `re_syntax_options' variable.  */
431 extern reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax));
432
433 /* Compile the regular expression PATTERN, with length LENGTH
434    and syntax given by the global `re_syntax_options', into the buffer
435    BUFFER.  Return NULL if successful, and an error string if not.  */
436 extern const char *re_compile_pattern
437   _RE_ARGS ((const char *pattern, size_t length,
438              struct re_pattern_buffer *buffer));
439
440
441 /* Compile a fastmap for the compiled pattern in BUFFER; used to
442    accelerate searches.  Return 0 if successful and -2 if was an
443    internal error.  */
444 extern int re_compile_fastmap _RE_ARGS ((struct re_pattern_buffer *buffer));
445
446
447 /* Search in the string STRING (with length LENGTH) for the pattern
448    compiled into BUFFER.  Start searching at position START, for RANGE
449    characters.  Return the starting position of the match, -1 for no
450    match, or -2 for an internal error.  Also return register
451    information in REGS (if REGS and BUFFER->no_sub are nonzero).  */
452 extern int re_search
453   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
454             int length, int start, int range, struct re_registers *regs));
455
456
457 /* Like `re_search', but search in the concatenation of STRING1 and
458    STRING2.  Also, stop searching at index START + STOP.  */
459 extern int re_search_2
460   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
461              int length1, const char *string2, int length2,
462              int start, int range, struct re_registers *regs, int stop));
463
464
465 /* Like `re_search', but return how many characters in STRING the regexp
466    in BUFFER matched, starting at position START.  */
467 extern int re_match
468   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
469              int length, int start, struct re_registers *regs));
470
471
472 /* Relates to `re_match' as `re_search_2' relates to `re_search'.  */
473 extern int re_match_2
474   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
475              int length1, const char *string2, int length2,
476              int start, struct re_registers *regs, int stop));
477
478
479 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
480    ENDS.  Subsequent matches using BUFFER and REGS will use this memory
481    for recording register information.  STARTS and ENDS must be
482    allocated with malloc, and must each be at least `NUM_REGS * sizeof
483    (regoff_t)' bytes long.
484
485    If NUM_REGS == 0, then subsequent matches should allocate their own
486    register data.
487
488    Unless this function is called, the first search or match using
489    PATTERN_BUFFER will allocate its own register data, without
490    freeing the old data.  */
491 extern void re_set_registers
492   _RE_ARGS ((struct re_pattern_buffer *buffer, struct re_registers *regs,
493              unsigned num_regs, regoff_t *starts, regoff_t *ends));
494
495 #ifdef _REGEX_RE_COMP
496 #ifndef _CRAY
497 /* 4.2 bsd compatibility.  */
498 extern char *re_comp _RE_ARGS ((const char *));
499 extern int re_exec _RE_ARGS ((const char *));
500 #endif
501 #endif
502
503 /* POSIX compatibility.  */
504 extern int regcomp _RE_ARGS ((regex_t *preg, const char *pattern, int cflags));
505 extern int regexec
506   _RE_ARGS ((const regex_t *preg, const char *string, size_t nmatch,
507              regmatch_t pmatch[], int eflags));
508 extern size_t regerror
509   _RE_ARGS ((int errcode, const regex_t *preg, char *errbuf,
510              size_t errbuf_size));
511 extern void regfree _RE_ARGS ((regex_t *preg));
512
513
514 #ifdef __cplusplus
515 }
516 #endif  /* C++ */
517
518 #endif /* not __REGEXP_LIBRARY_H__ */
519 \f
520 /*
521 Local variables:
522 make-backup-files: t
523 version-control: t
524 trim-versions-without-asking: nil
525 End:
526 */