src/xdisp.c (single_display_spec_string): Correct a FIXME comment.
[emacs.git] / src / regex.h
blob7747ec576291c02007dd590f1c548d7eff4a87aa
1 /* Definitions for data structures and routines for the regular
2 expression library, version 0.12.
4 Copyright (C) 1985, 1989-1993, 1995, 2000-2011
5 Free Software Foundation, Inc.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20 USA. */
22 #ifndef _REGEX_H
23 #define _REGEX_H 1
25 /* Allow the use in C++ code. */
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
30 /* POSIX says that <sys/types.h> must be included (by the caller) before
31 <regex.h>. */
33 #if !defined _POSIX_C_SOURCE && !defined _POSIX_SOURCE && defined VMS
34 /* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it
35 should be there. */
36 # include <stddef.h>
37 #endif
39 /* The following bits are used to determine the regexp syntax we
40 recognize. The set/not-set meanings where historically chosen so
41 that Emacs syntax had the value 0.
42 The bits are given in alphabetical order, and
43 the definitions shifted by one from the previous bit; thus, when we
44 add or remove a bit, only one other definition need change. */
45 typedef unsigned long int reg_syntax_t;
47 /* If this bit is not set, then \ inside a bracket expression is literal.
48 If set, then such a \ quotes the following character. */
49 #define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1)
51 /* If this bit is not set, then + and ? are operators, and \+ and \? are
52 literals.
53 If set, then \+ and \? are operators and + and ? are literals. */
54 #define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
56 /* If this bit is set, then character classes are supported. They are:
57 [:alpha:], [:upper:], [:lower:], [:digit:], [:alnum:], [:xdigit:],
58 [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
59 If not set, then character classes are not supported. */
60 #define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
62 /* If this bit is set, then ^ and $ are always anchors (outside bracket
63 expressions, of course).
64 If this bit is not set, then it depends:
65 ^ is an anchor if it is at the beginning of a regular
66 expression or after an open-group or an alternation operator;
67 $ is an anchor if it is at the end of a regular expression, or
68 before a close-group or an alternation operator.
70 This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
71 POSIX draft 11.2 says that * etc. in leading positions is undefined.
72 We already implemented a previous draft which made those constructs
73 invalid, though, so we haven't changed the code back. */
74 #define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
76 /* If this bit is set, then special characters are always special
77 regardless of where they are in the pattern.
78 If this bit is not set, then special characters are special only in
79 some contexts; otherwise they are ordinary. Specifically,
80 * + ? and intervals are only special when not after the beginning,
81 open-group, or alternation operator. */
82 #define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
84 /* If this bit is set, then *, +, ?, and { cannot be first in an re or
85 immediately after an alternation or begin-group operator. */
86 #define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
88 /* If this bit is set, then . matches newline.
89 If not set, then it doesn't. */
90 #define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
92 /* If this bit is set, then . doesn't match NUL.
93 If not set, then it does. */
94 #define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
96 /* If this bit is set, nonmatching lists [^...] do not match newline.
97 If not set, they do. */
98 #define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
100 /* If this bit is set, either \{...\} or {...} defines an
101 interval, depending on RE_NO_BK_BRACES.
102 If not set, \{, \}, {, and } are literals. */
103 #define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
105 /* If this bit is set, +, ? and | aren't recognized as operators.
106 If not set, they are. */
107 #define RE_LIMITED_OPS (RE_INTERVALS << 1)
109 /* If this bit is set, newline is an alternation operator.
110 If not set, newline is literal. */
111 #define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
113 /* If this bit is set, then `{...}' defines an interval, and \{ and \}
114 are literals.
115 If not set, then `\{...\}' defines an interval. */
116 #define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)
118 /* If this bit is set, (...) defines a group, and \( and \) are literals.
119 If not set, \(...\) defines a group, and ( and ) are literals. */
120 #define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
122 /* If this bit is set, then \<digit> matches <digit>.
123 If not set, then \<digit> is a back-reference. */
124 #define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
126 /* If this bit is set, then | is an alternation operator, and \| is literal.
127 If not set, then \| is an alternation operator, and | is literal. */
128 #define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
130 /* If this bit is set, then an ending range point collating higher
131 than the starting range point, as in [z-a], is invalid.
132 If not set, then when ending range point collates higher than the
133 starting range point, the range is ignored. */
134 #define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)
136 /* If this bit is set, then an unmatched ) is ordinary.
137 If not set, then an unmatched ) is invalid. */
138 #define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)
140 /* If this bit is set, succeed as soon as we match the whole pattern,
141 without further backtracking. */
142 #define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1)
144 /* If this bit is set, do not process the GNU regex operators.
145 If not set, then the GNU regex operators are recognized. */
146 #define RE_NO_GNU_OPS (RE_NO_POSIX_BACKTRACKING << 1)
148 /* If this bit is set, then *?, +? and ?? match non greedily. */
149 #define RE_FRUGAL (RE_NO_GNU_OPS << 1)
151 /* If this bit is set, then (?:...) is treated as a shy group. */
152 #define RE_SHY_GROUPS (RE_FRUGAL << 1)
154 /* If this bit is set, ^ and $ only match at beg/end of buffer. */
155 #define RE_NO_NEWLINE_ANCHOR (RE_SHY_GROUPS << 1)
157 /* If this bit is set, turn on internal regex debugging.
158 If not set, and debugging was on, turn it off.
159 This only works if regex.c is compiled -DDEBUG.
160 We define this bit always, so that all that's needed to turn on
161 debugging is to recompile regex.c; the calling code can always have
162 this bit set, and it won't affect anything in the normal case. */
163 #define RE_DEBUG (RE_NO_NEWLINE_ANCHOR << 1)
165 /* This global variable defines the particular regexp syntax to use (for
166 some interfaces). When a regexp is compiled, the syntax used is
167 stored in the pattern buffer, so changing this does not affect
168 already-compiled regexps. */
169 extern reg_syntax_t re_syntax_options;
171 #ifdef emacs
172 /* In Emacs, this is the string or buffer in which we
173 are matching. It is used for looking up syntax properties. */
174 extern Lisp_Object re_match_object;
175 #endif
178 /* Define combinations of the above bits for the standard possibilities.
179 (The [[[ comments delimit what gets put into the Texinfo file, so
180 don't delete them!) */
181 /* [[[begin syntaxes]]] */
182 #define RE_SYNTAX_EMACS \
183 (RE_CHAR_CLASSES | RE_INTERVALS | RE_SHY_GROUPS | RE_FRUGAL)
185 #define RE_SYNTAX_AWK \
186 (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL \
187 | RE_NO_BK_PARENS | RE_NO_BK_REFS \
188 | RE_NO_BK_VBAR | RE_NO_EMPTY_RANGES \
189 | RE_DOT_NEWLINE | RE_CONTEXT_INDEP_ANCHORS \
190 | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS)
192 #define RE_SYNTAX_GNU_AWK \
193 ((RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DEBUG) \
194 & ~(RE_DOT_NOT_NULL | RE_INTERVALS | RE_CONTEXT_INDEP_OPS))
196 #define RE_SYNTAX_POSIX_AWK \
197 (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS \
198 | RE_INTERVALS | RE_NO_GNU_OPS)
200 #define RE_SYNTAX_GREP \
201 (RE_BK_PLUS_QM | RE_CHAR_CLASSES \
202 | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \
203 | RE_NEWLINE_ALT)
205 #define RE_SYNTAX_EGREP \
206 (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS \
207 | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE \
208 | RE_NEWLINE_ALT | RE_NO_BK_PARENS \
209 | RE_NO_BK_VBAR)
211 #define RE_SYNTAX_POSIX_EGREP \
212 (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)
214 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */
215 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
217 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
219 /* Syntax bits common to both basic and extended POSIX regex syntax. */
220 #define _RE_SYNTAX_POSIX_COMMON \
221 (RE_CHAR_CLASSES | RE_DOT_NEWLINE | RE_DOT_NOT_NULL \
222 | RE_INTERVALS | RE_NO_EMPTY_RANGES)
224 #define RE_SYNTAX_POSIX_BASIC \
225 (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
227 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes
228 RE_LIMITED_OPS, i.e., \? \+ \| are not recognized. Actually, this
229 isn't minimal, since other operators, such as \`, aren't disabled. */
230 #define RE_SYNTAX_POSIX_MINIMAL_BASIC \
231 (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)
233 #define RE_SYNTAX_POSIX_EXTENDED \
234 (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \
235 | RE_CONTEXT_INDEP_OPS | RE_NO_BK_BRACES \
236 | RE_NO_BK_PARENS | RE_NO_BK_VBAR \
237 | RE_CONTEXT_INVALID_OPS | RE_UNMATCHED_RIGHT_PAREN_ORD)
239 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INDEP_OPS is
240 removed and RE_NO_BK_REFS is added. */
241 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED \
242 (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \
243 | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES \
244 | RE_NO_BK_PARENS | RE_NO_BK_REFS \
245 | RE_NO_BK_VBAR | RE_UNMATCHED_RIGHT_PAREN_ORD)
246 /* [[[end syntaxes]]] */
248 /* Maximum number of duplicates an interval can allow. Some systems
249 (erroneously) define this in other header files, but we want our
250 value, so remove any previous define. */
251 #ifdef RE_DUP_MAX
252 # undef RE_DUP_MAX
253 #endif
254 /* If sizeof(int) == 2, then ((1 << 15) - 1) overflows. */
255 #define RE_DUP_MAX (0x7fff)
258 /* POSIX `cflags' bits (i.e., information for `regcomp'). */
260 /* If this bit is set, then use extended regular expression syntax.
261 If not set, then use basic regular expression syntax. */
262 #define REG_EXTENDED 1
264 /* If this bit is set, then ignore case when matching.
265 If not set, then case is significant. */
266 #define REG_ICASE (REG_EXTENDED << 1)
268 /* If this bit is set, then anchors do not match at newline
269 characters in the string.
270 If not set, then anchors do match at newlines. */
271 #define REG_NEWLINE (REG_ICASE << 1)
273 /* If this bit is set, then report only success or fail in regexec.
274 If not set, then returns differ between not matching and errors. */
275 #define REG_NOSUB (REG_NEWLINE << 1)
278 /* POSIX `eflags' bits (i.e., information for regexec). */
280 /* If this bit is set, then the beginning-of-line operator doesn't match
281 the beginning of the string (presumably because it's not the
282 beginning of a line).
283 If not set, then the beginning-of-line operator does match the
284 beginning of the string. */
285 #define REG_NOTBOL 1
287 /* Like REG_NOTBOL, except for the end-of-line. */
288 #define REG_NOTEOL (1 << 1)
291 /* If any error codes are removed, changed, or added, update the
292 `re_error_msg' table in regex.c. */
293 typedef enum
295 #ifdef _XOPEN_SOURCE
296 REG_ENOSYS = -1, /* This will never happen for this implementation. */
297 #endif
299 REG_NOERROR = 0, /* Success. */
300 REG_NOMATCH, /* Didn't find a match (for regexec). */
302 /* POSIX regcomp return error codes. (In the order listed in the
303 standard.) */
304 REG_BADPAT, /* Invalid pattern. */
305 REG_ECOLLATE, /* Not implemented. */
306 REG_ECTYPE, /* Invalid character class name. */
307 REG_EESCAPE, /* Trailing backslash. */
308 REG_ESUBREG, /* Invalid back reference. */
309 REG_EBRACK, /* Unmatched left bracket. */
310 REG_EPAREN, /* Parenthesis imbalance. */
311 REG_EBRACE, /* Unmatched \{. */
312 REG_BADBR, /* Invalid contents of \{\}. */
313 REG_ERANGE, /* Invalid range end. */
314 REG_ESPACE, /* Ran out of memory. */
315 REG_BADRPT, /* No preceding re for repetition op. */
317 /* Error codes we've added. */
318 REG_EEND, /* Premature end. */
319 REG_ESIZE, /* Compiled pattern bigger than 2^16 bytes. */
320 REG_ERPAREN, /* Unmatched ) or \); not returned from regcomp. */
321 REG_ERANGEX /* Range striding over charsets. */
322 } reg_errcode_t;
324 /* This data structure represents a compiled pattern. Before calling
325 the pattern compiler, the fields `buffer', `allocated', `fastmap',
326 `translate', and `no_sub' can be set. After the pattern has been
327 compiled, the `re_nsub' field is available. All other fields are
328 private to the regex routines. */
330 #ifndef RE_TRANSLATE_TYPE
331 # define RE_TRANSLATE_TYPE char *
332 #endif
334 struct re_pattern_buffer
336 /* [[[begin pattern_buffer]]] */
337 /* Space that holds the compiled pattern. It is declared as
338 `unsigned char *' because its elements are
339 sometimes used as array indexes. */
340 unsigned char *buffer;
342 /* Number of bytes to which `buffer' points. */
343 size_t allocated;
345 /* Number of bytes actually used in `buffer'. */
346 size_t used;
348 /* Syntax setting with which the pattern was compiled. */
349 reg_syntax_t syntax;
351 /* Pointer to a fastmap, if any, otherwise zero. re_search uses
352 the fastmap, if there is one, to skip over impossible
353 starting points for matches. */
354 char *fastmap;
356 /* Either a translate table to apply to all characters before
357 comparing them, or zero for no translation. The translation
358 is applied to a pattern when it is compiled and to a string
359 when it is matched. */
360 RE_TRANSLATE_TYPE translate;
362 /* Number of subexpressions found by the compiler. */
363 size_t re_nsub;
365 /* Zero if this pattern cannot match the empty string, one else.
366 Well, in truth it's used only in `re_search_2', to see
367 whether or not we should use the fastmap, so we don't set
368 this absolutely perfectly; see `re_compile_fastmap'. */
369 unsigned can_be_null : 1;
371 /* If REGS_UNALLOCATED, allocate space in the `regs' structure
372 for `max (RE_NREGS, re_nsub + 1)' groups.
373 If REGS_REALLOCATE, reallocate space if necessary.
374 If REGS_FIXED, use what's there. */
375 #define REGS_UNALLOCATED 0
376 #define REGS_REALLOCATE 1
377 #define REGS_FIXED 2
378 unsigned regs_allocated : 2;
380 /* Set to zero when `regex_compile' compiles a pattern; set to one
381 by `re_compile_fastmap' if it updates the fastmap. */
382 unsigned fastmap_accurate : 1;
384 /* If set, `re_match_2' does not return information about
385 subexpressions. */
386 unsigned no_sub : 1;
388 /* If set, a beginning-of-line anchor doesn't match at the
389 beginning of the string. */
390 unsigned not_bol : 1;
392 /* Similarly for an end-of-line anchor. */
393 unsigned not_eol : 1;
395 /* If true, the compilation of the pattern had to look up the syntax table,
396 so the compiled pattern is only valid for the current syntax table. */
397 unsigned used_syntax : 1;
399 #ifdef emacs
400 /* If true, multi-byte form in the regexp pattern should be
401 recognized as a multibyte character. */
402 unsigned multibyte : 1;
404 /* If true, multi-byte form in the target of match should be
405 recognized as a multibyte character. */
406 unsigned target_multibyte : 1;
408 /* Charset of unibyte characters at compiling time. */
409 int charset_unibyte;
410 #endif
412 /* [[[end pattern_buffer]]] */
415 typedef struct re_pattern_buffer regex_t;
417 /* Type for byte offsets within the string. POSIX mandates this to be an int,
418 but the Open Group has signalled its intention to change the requirement to
419 be that regoff_t be at least as wide as ptrdiff_t and ssize_t. Current
420 gnulib sources also use ssize_t, and we need this for supporting buffers and
421 strings > 2GB on 64-bit hosts. */
422 typedef ssize_t regoff_t;
425 /* This is the structure we store register match data in. See
426 regex.texinfo for a full description of what registers match. */
427 struct re_registers
429 unsigned num_regs;
430 regoff_t *start;
431 regoff_t *end;
435 /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
436 `re_match_2' returns information about at least this many registers
437 the first time a `regs' structure is passed. */
438 #ifndef RE_NREGS
439 # define RE_NREGS 30
440 #endif
443 /* POSIX specification for registers. Aside from the different names than
444 `re_registers', POSIX uses an array of structures, instead of a
445 structure of arrays. */
446 typedef struct
448 regoff_t rm_so; /* Byte offset from string's start to substring's start. */
449 regoff_t rm_eo; /* Byte offset from string's start to substring's end. */
450 } regmatch_t;
452 /* Declarations for routines. */
454 /* To avoid duplicating every routine declaration -- once with a
455 prototype (if we are ANSI), and once without (if we aren't) -- we
456 use the following macro to declare argument types. This
457 unfortunately clutters up the declarations a bit, but I think it's
458 worth it. */
460 #if defined __STDC__ || defined PROTOTYPES
462 # define _RE_ARGS(args) args
464 #else /* not __STDC__ || PROTOTYPES */
466 # define _RE_ARGS(args) ()
468 #endif /* not __STDC__ || PROTOTYPES */
470 /* Sets the current default syntax to SYNTAX, and return the old syntax.
471 You can also simply assign to the `re_syntax_options' variable. */
472 extern reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax));
474 /* Compile the regular expression PATTERN, with length LENGTH
475 and syntax given by the global `re_syntax_options', into the buffer
476 BUFFER. Return NULL if successful, and an error string if not. */
477 extern const char *re_compile_pattern
478 _RE_ARGS ((const char *pattern, size_t length,
479 struct re_pattern_buffer *buffer));
482 /* Compile a fastmap for the compiled pattern in BUFFER; used to
483 accelerate searches. Return 0 if successful and -2 if was an
484 internal error. */
485 extern int re_compile_fastmap _RE_ARGS ((struct re_pattern_buffer *buffer));
488 /* Search in the string STRING (with length LENGTH) for the pattern
489 compiled into BUFFER. Start searching at position START, for RANGE
490 characters. Return the starting position of the match, -1 for no
491 match, or -2 for an internal error. Also return register
492 information in REGS (if REGS and BUFFER->no_sub are nonzero). */
493 extern regoff_t re_search
494 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
495 size_t length, ssize_t start, ssize_t range,
496 struct re_registers *regs));
499 /* Like `re_search', but search in the concatenation of STRING1 and
500 STRING2. Also, stop searching at index START + STOP. */
501 extern regoff_t re_search_2
502 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
503 size_t length1, const char *string2, size_t length2,
504 ssize_t start, ssize_t range, struct re_registers *regs,
505 ssize_t stop));
508 /* Like `re_search', but return how many characters in STRING the regexp
509 in BUFFER matched, starting at position START. */
510 extern regoff_t re_match
511 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
512 size_t length, ssize_t start, struct re_registers *regs));
515 /* Relates to `re_match' as `re_search_2' relates to `re_search'. */
516 extern regoff_t re_match_2
517 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
518 size_t length1, const char *string2, size_t length2,
519 ssize_t start, struct re_registers *regs, ssize_t stop));
522 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
523 ENDS. Subsequent matches using BUFFER and REGS will use this memory
524 for recording register information. STARTS and ENDS must be
525 allocated with malloc, and must each be at least `NUM_REGS * sizeof
526 (regoff_t)' bytes long.
528 If NUM_REGS == 0, then subsequent matches should allocate their own
529 register data.
531 Unless this function is called, the first search or match using
532 PATTERN_BUFFER will allocate its own register data, without
533 freeing the old data. */
534 extern void re_set_registers
535 _RE_ARGS ((struct re_pattern_buffer *buffer, struct re_registers *regs,
536 unsigned num_regs, regoff_t *starts, regoff_t *ends));
538 #if defined _REGEX_RE_COMP || defined _LIBC
539 # ifndef _CRAY
540 /* 4.2 bsd compatibility. */
541 extern char *re_comp _RE_ARGS ((const char *));
542 extern int re_exec _RE_ARGS ((const char *));
543 # endif
544 #endif
546 /* GCC 2.95 and later have "__restrict"; C99 compilers have
547 "restrict", and "configure" may have defined "restrict". */
548 #ifndef __restrict
549 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
550 # if defined restrict || 199901L <= __STDC_VERSION__
551 # define __restrict restrict
552 # else
553 # define __restrict
554 # endif
555 # endif
556 #endif
557 /* For now conditionally define __restrict_arr to expand to nothing.
558 Ideally we would have a test for the compiler which allows defining
559 it to restrict. */
560 #ifndef __restrict_arr
561 # define __restrict_arr
562 #endif
564 /* POSIX compatibility. */
565 extern reg_errcode_t regcomp _RE_ARGS ((regex_t *__restrict __preg,
566 const char *__restrict __pattern,
567 int __cflags));
569 extern reg_errcode_t regexec _RE_ARGS ((const regex_t *__restrict __preg,
570 const char *__restrict __string,
571 size_t __nmatch,
572 regmatch_t __pmatch[__restrict_arr],
573 int __eflags));
575 extern size_t regerror _RE_ARGS ((int __errcode, const regex_t *__preg,
576 char *__errbuf, size_t __errbuf_size));
578 extern void regfree _RE_ARGS ((regex_t *__preg));
581 #ifdef __cplusplus
583 #endif /* C++ */
585 /* For platform which support the ISO C amendement 1 functionality we
586 support user defined character classes. */
587 #if WIDE_CHAR_SUPPORT
588 /* Solaris 2.5 has a bug: <wchar.h> must be included before <wctype.h>. */
589 # include <wchar.h>
590 # include <wctype.h>
591 #endif
593 #if WIDE_CHAR_SUPPORT
594 /* The GNU C library provides support for user-defined character classes
595 and the functions from ISO C amendement 1. */
596 # ifdef CHARCLASS_NAME_MAX
597 # define CHAR_CLASS_MAX_LENGTH CHARCLASS_NAME_MAX
598 # else
599 /* This shouldn't happen but some implementation might still have this
600 problem. Use a reasonable default value. */
601 # define CHAR_CLASS_MAX_LENGTH 256
602 # endif
603 typedef wctype_t re_wctype_t;
604 typedef wchar_t re_wchar_t;
605 # define re_wctype wctype
606 # define re_iswctype iswctype
607 # define re_wctype_to_bit(cc) 0
608 #else
609 # define CHAR_CLASS_MAX_LENGTH 9 /* Namely, `multibyte'. */
610 # define btowc(c) c
612 /* Character classes. */
613 typedef enum { RECC_ERROR = 0,
614 RECC_ALNUM, RECC_ALPHA, RECC_WORD,
615 RECC_GRAPH, RECC_PRINT,
616 RECC_LOWER, RECC_UPPER,
617 RECC_PUNCT, RECC_CNTRL,
618 RECC_DIGIT, RECC_XDIGIT,
619 RECC_BLANK, RECC_SPACE,
620 RECC_MULTIBYTE, RECC_NONASCII,
621 RECC_ASCII, RECC_UNIBYTE
622 } re_wctype_t;
624 extern char re_iswctype (int ch, re_wctype_t cc);
625 extern re_wctype_t re_wctype (const unsigned char* str);
627 typedef int re_wchar_t;
629 extern void re_set_whitespace_regexp (const char *regexp);
631 #endif /* not WIDE_CHAR_SUPPORT */
633 #endif /* regex.h */