Convert consecutive FSF copyright years to ranges.
[bpt/emacs.git] / src / regex.h
CommitLineData
b1fe2cfc 1/* Definitions for data structures and routines for the regular
8b20806d 2 expression library, version 0.12.
b1fe2cfc 3
73b0cd50 4 Copyright (C) 1985, 1989-1993, 1995, 2000-2011
429ab54e 5 Free Software Foundation, Inc.
b1fe2cfc
KB
6
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
e468b87f 9 the Free Software Foundation; either version 3, or (at your option)
b1fe2cfc
KB
10 any later version.
11
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.
16
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
4fc5845f 19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
ba4a8e51 20 USA. */
b1fe2cfc 21
0b32bf0e
SM
22#ifndef _REGEX_H
23#define _REGEX_H 1
24
25/* Allow the use in C++ code. */
26#ifdef __cplusplus
27extern "C" {
28#endif
b1fe2cfc 29
9114e279
KB
30/* POSIX says that <sys/types.h> must be included (by the caller) before
31 <regex.h>. */
32
0b32bf0e 33#if !defined _POSIX_C_SOURCE && !defined _POSIX_SOURCE && defined VMS
9114e279
KB
34/* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it
35 should be there. */
0b32bf0e 36# include <stddef.h>
d074788d
JB
37#endif
38
b1fe2cfc 39/* The following bits are used to determine the regexp syntax we
fb4a568d
SM
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
b1fe2cfc
KB
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. */
0b32bf0e 45typedef unsigned long int reg_syntax_t;
f95d599c 46
b1fe2cfc
KB
47/* If this bit is not set, then \ inside a bracket expression is literal.
48 If set, then such a \ quotes the following character. */
0b32bf0e 49#define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1)
b1fe2cfc
KB
50
51/* If this bit is not set, then + and ? are operators, and \+ and \? are
0b32bf0e 52 literals.
b1fe2cfc
KB
53 If set, then \+ and \? are operators and + and ? are literals. */
54#define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
55
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)
61
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
0b32bf0e 68 before a close-group or an alternation operator.
b1fe2cfc
KB
69
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)
75
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
0b32bf0e 79 some contexts; otherwise they are ordinary. Specifically,
b1fe2cfc
KB
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)
83
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)
87
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)
91
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)
95
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)
99
100/* If this bit is set, either \{...\} or {...} defines an
0b32bf0e 101 interval, depending on RE_NO_BK_BRACES.
b1fe2cfc
KB
102 If not set, \{, \}, {, and } are literals. */
103#define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
104
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)
108
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)
112
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)
117
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)
121
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)
125
0b32bf0e 126/* If this bit is set, then | is an alternation operator, and \| is literal.
b1fe2cfc
KB
127 If not set, then \| is an alternation operator, and | is literal. */
128#define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
129
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)
135
0b32bf0e
SM
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)
139
5cc05562
RS
140/* If this bit is set, succeed as soon as we match the whole pattern,
141 without further backtracking. */
0b32bf0e 142#define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1)
f95d599c 143
0b32bf0e
SM
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)
dd52d970 147
0b32bf0e 148/* If this bit is set, then *?, +? and ?? match non greedily. */
98222d27 149#define RE_FRUGAL (RE_NO_GNU_OPS << 1)
0b32bf0e
SM
150
151/* If this bit is set, then (?:...) is treated as a shy group. */
152#define RE_SHY_GROUPS (RE_FRUGAL << 1)
5cc05562 153
c0f9ea08
SM
154/* If this bit is set, ^ and $ only match at beg/end of buffer. */
155#define RE_NO_NEWLINE_ANCHOR (RE_SHY_GROUPS << 1)
156
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)
164
b1fe2cfc
KB
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. */
169extern reg_syntax_t re_syntax_options;
766ff627
RS
170
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. */
174extern Lisp_Object re_match_object;
175#endif
176
b1fe2cfc
KB
177\f
178/* Define combinations of the above bits for the standard possibilities.
179 (The [[[ comments delimit what gets put into the Texinfo file, so
fb4a568d 180 don't delete them!) */
b1fe2cfc 181/* [[[begin syntaxes]]] */
0b32bf0e
SM
182#define RE_SYNTAX_EMACS \
183 (RE_CHAR_CLASSES | RE_INTERVALS | RE_SHY_GROUPS | RE_FRUGAL)
b1fe2cfc
KB
184
185#define RE_SYNTAX_AWK \
0b32bf0e
SM
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)
191
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))
b1fe2cfc
KB
195
196#define RE_SYNTAX_POSIX_AWK \
0b32bf0e
SM
197 (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS \
198 | RE_INTERVALS | RE_NO_GNU_OPS)
b1fe2cfc
KB
199
200#define RE_SYNTAX_GREP \
201 (RE_BK_PLUS_QM | RE_CHAR_CLASSES \
202 | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \
0b32bf0e 203 | RE_NEWLINE_ALT)
b1fe2cfc
KB
204
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 \
0b32bf0e 209 | RE_NO_BK_VBAR)
b1fe2cfc
KB
210
211#define RE_SYNTAX_POSIX_EGREP \
212 (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)
213
9114e279
KB
214/* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */
215#define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
216
b1fe2cfc
KB
217#define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
218
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 \
0b32bf0e 222 | RE_INTERVALS | RE_NO_EMPTY_RANGES)
b1fe2cfc
KB
223
224#define RE_SYNTAX_POSIX_BASIC \
225 (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
226
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)
232
233#define RE_SYNTAX_POSIX_EXTENDED \
0b32bf0e
SM
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)
b1fe2cfc 238
0b32bf0e
SM
239/* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INDEP_OPS is
240 removed and RE_NO_BK_REFS is added. */
b1fe2cfc
KB
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]]] */
247\f
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
0b32bf0e 252# undef RE_DUP_MAX
b1fe2cfc 253#endif
0b32bf0e
SM
254/* If sizeof(int) == 2, then ((1 << 15) - 1) overflows. */
255#define RE_DUP_MAX (0x7fff)
b1fe2cfc
KB
256
257
258/* POSIX `cflags' bits (i.e., information for `regcomp'). */
259
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
263
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)
0b32bf0e 267
b1fe2cfc
KB
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)
272
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)
276
277
278/* POSIX `eflags' bits (i.e., information for regexec). */
279
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
286
287/* Like REG_NOTBOL, except for the end-of-line. */
288#define REG_NOTEOL (1 << 1)
289
290
291/* If any error codes are removed, changed, or added, update the
292 `re_error_msg' table in regex.c. */
293typedef enum
294{
0b32bf0e
SM
295#ifdef _XOPEN_SOURCE
296 REG_ENOSYS = -1, /* This will never happen for this implementation. */
297#endif
298
b1fe2cfc
KB
299 REG_NOERROR = 0, /* Success. */
300 REG_NOMATCH, /* Didn't find a match (for regexec). */
301
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. */
0b32bf0e 310 REG_EPAREN, /* Parenthesis imbalance. */
b1fe2cfc
KB
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. */
316
317 /* Error codes we've added. */
318 REG_EEND, /* Premature end. */
319 REG_ESIZE, /* Compiled pattern bigger than 2^16 bytes. */
be13f5e5
KH
320 REG_ERPAREN, /* Unmatched ) or \); not returned from regcomp. */
321 REG_ERANGEX /* Range striding over charsets. */
b1fe2cfc
KB
322} reg_errcode_t;
323\f
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. */
329
fc4e96c8 330#ifndef RE_TRANSLATE_TYPE
0b32bf0e 331# define RE_TRANSLATE_TYPE char *
6fffb26e
RS
332#endif
333
b1fe2cfc
KB
334struct re_pattern_buffer
335{
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;
341
342 /* Number of bytes to which `buffer' points. */
98222d27 343 size_t allocated;
b1fe2cfc
KB
344
345 /* Number of bytes actually used in `buffer'. */
98222d27 346 size_t used;
b1fe2cfc
KB
347
348 /* Syntax setting with which the pattern was compiled. */
349 reg_syntax_t syntax;
350
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;
355
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. */
6fffb26e 360 RE_TRANSLATE_TYPE translate;
b1fe2cfc
KB
361
362 /* Number of subexpressions found by the compiler. */
363 size_t re_nsub;
364
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
dd52d970 368 this absolutely perfectly; see `re_compile_fastmap'. */
b1fe2cfc
KB
369 unsigned can_be_null : 1;
370
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;
379
9114e279
KB
380 /* Set to zero when `regex_compile' compiles a pattern; set to one
381 by `re_compile_fastmap' if it updates the fastmap. */
b1fe2cfc
KB
382 unsigned fastmap_accurate : 1;
383
9114e279
KB
384 /* If set, `re_match_2' does not return information about
385 subexpressions. */
b1fe2cfc
KB
386 unsigned no_sub : 1;
387
388 /* If set, a beginning-of-line anchor doesn't match at the
0b32bf0e 389 beginning of the string. */
b1fe2cfc
KB
390 unsigned not_bol : 1;
391
392 /* Similarly for an end-of-line anchor. */
393 unsigned not_eol : 1;
394
1351dd3b
SM
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;
398
2d1675e4 399#ifdef emacs
66f089b2 400 /* If true, multi-byte form in the regexp pattern should be
0f4b87bf 401 recognized as a multibyte character. */
766ff627 402 unsigned multibyte : 1;
66f089b2
KH
403
404 /* If true, multi-byte form in the target of match should be
405 recognized as a multibyte character. */
406 unsigned target_multibyte : 1;
0f4b87bf
KH
407
408 /* Charset of unibyte characters at compiling time. */
409 int charset_unibyte;
2d1675e4 410#endif
766ff627 411
b1fe2cfc
KB
412/* [[[end pattern_buffer]]] */
413};
414
415typedef struct re_pattern_buffer regex_t;
b1fe2cfc
KB
416\f
417/* Type for byte offsets within the string. POSIX mandates this. */
418typedef int regoff_t;
419
420
421/* This is the structure we store register match data in. See
422 regex.texinfo for a full description of what registers match. */
423struct re_registers
424{
425 unsigned num_regs;
426 regoff_t *start;
427 regoff_t *end;
428};
429
430
431/* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
432 `re_match_2' returns information about at least this many registers
433 the first time a `regs' structure is passed. */
434#ifndef RE_NREGS
0b32bf0e 435# define RE_NREGS 30
b1fe2cfc
KB
436#endif
437
438
439/* POSIX specification for registers. Aside from the different names than
440 `re_registers', POSIX uses an array of structures, instead of a
441 structure of arrays. */
442typedef struct
443{
444 regoff_t rm_so; /* Byte offset from string's start to substring's start. */
445 regoff_t rm_eo; /* Byte offset from string's start to substring's end. */
446} regmatch_t;
447\f
448/* Declarations for routines. */
449
450/* To avoid duplicating every routine declaration -- once with a
451 prototype (if we are ANSI), and once without (if we aren't) -- we
452 use the following macro to declare argument types. This
453 unfortunately clutters up the declarations a bit, but I think it's
65565c68 454 worth it. */
b1fe2cfc 455
2a90cd71 456#if defined __STDC__ || defined PROTOTYPES
0783dc9a 457
0b32bf0e 458# define _RE_ARGS(args) args
0783dc9a 459
2a90cd71 460#else /* not __STDC__ || PROTOTYPES */
0783dc9a 461
0b32bf0e 462# define _RE_ARGS(args) ()
0783dc9a 463
2a90cd71 464#endif /* not __STDC__ || PROTOTYPES */
b1fe2cfc
KB
465
466/* Sets the current default syntax to SYNTAX, and return the old syntax.
467 You can also simply assign to the `re_syntax_options' variable. */
468extern reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax));
469
470/* Compile the regular expression PATTERN, with length LENGTH
471 and syntax given by the global `re_syntax_options', into the buffer
472 BUFFER. Return NULL if successful, and an error string if not. */
473extern const char *re_compile_pattern
0b32bf0e 474 _RE_ARGS ((const char *pattern, size_t length,
b1fe2cfc
KB
475 struct re_pattern_buffer *buffer));
476
477
478/* Compile a fastmap for the compiled pattern in BUFFER; used to
479 accelerate searches. Return 0 if successful and -2 if was an
480 internal error. */
481extern int re_compile_fastmap _RE_ARGS ((struct re_pattern_buffer *buffer));
482
483
484/* Search in the string STRING (with length LENGTH) for the pattern
485 compiled into BUFFER. Start searching at position START, for RANGE
486 characters. Return the starting position of the match, -1 for no
487 match, or -2 for an internal error. Also return register
488 information in REGS (if REGS and BUFFER->no_sub are nonzero). */
489extern int re_search
490 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
491 int length, int start, int range, struct re_registers *regs));
492
493
494/* Like `re_search', but search in the concatenation of STRING1 and
495 STRING2. Also, stop searching at index START + STOP. */
496extern int re_search_2
497 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
498 int length1, const char *string2, int length2,
499 int start, int range, struct re_registers *regs, int stop));
500
501
502/* Like `re_search', but return how many characters in STRING the regexp
503 in BUFFER matched, starting at position START. */
504extern int re_match
505 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
506 int length, int start, struct re_registers *regs));
507
508
509/* Relates to `re_match' as `re_search_2' relates to `re_search'. */
0b32bf0e 510extern int re_match_2
b1fe2cfc
KB
511 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
512 int length1, const char *string2, int length2,
513 int start, struct re_registers *regs, int stop));
514
515
516/* Set REGS to hold NUM_REGS registers, storing them in STARTS and
517 ENDS. Subsequent matches using BUFFER and REGS will use this memory
518 for recording register information. STARTS and ENDS must be
519 allocated with malloc, and must each be at least `NUM_REGS * sizeof
520 (regoff_t)' bytes long.
521
522 If NUM_REGS == 0, then subsequent matches should allocate their own
523 register data.
524
525 Unless this function is called, the first search or match using
526 PATTERN_BUFFER will allocate its own register data, without
527 freeing the old data. */
528extern void re_set_registers
529 _RE_ARGS ((struct re_pattern_buffer *buffer, struct re_registers *regs,
530 unsigned num_regs, regoff_t *starts, regoff_t *ends));
531
0b32bf0e
SM
532#if defined _REGEX_RE_COMP || defined _LIBC
533# ifndef _CRAY
b1fe2cfc
KB
534/* 4.2 bsd compatibility. */
535extern char *re_comp _RE_ARGS ((const char *));
536extern int re_exec _RE_ARGS ((const char *));
0b32bf0e
SM
537# endif
538#endif
539
540/* GCC 2.95 and later have "__restrict"; C99 compilers have
541 "restrict", and "configure" may have defined "restrict". */
542#ifndef __restrict
543# if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
544# if defined restrict || 199901L <= __STDC_VERSION__
545# define __restrict restrict
546# else
547# define __restrict
548# endif
549# endif
273c0c50 550#endif
b90e26e1 551/* For now conditionally define __restrict_arr to expand to nothing.
0b32bf0e
SM
552 Ideally we would have a test for the compiler which allows defining
553 it to restrict. */
27847466 554#ifndef __restrict_arr
b90e26e1 555# define __restrict_arr
27847466 556#endif
b1fe2cfc
KB
557
558/* POSIX compatibility. */
0b32bf0e
SM
559extern int regcomp _RE_ARGS ((regex_t *__restrict __preg,
560 const char *__restrict __pattern,
561 int __cflags));
562
563extern int regexec _RE_ARGS ((const regex_t *__restrict __preg,
564 const char *__restrict __string, size_t __nmatch,
565 regmatch_t __pmatch[__restrict_arr],
566 int __eflags));
567
568extern size_t regerror _RE_ARGS ((int __errcode, const regex_t *__preg,
569 char *__errbuf, size_t __errbuf_size));
570
571extern void regfree _RE_ARGS ((regex_t *__preg));
572
573
574#ifdef __cplusplus
575}
576#endif /* C++ */
577
c13ecd8f
RS
578/* For platform which support the ISO C amendement 1 functionality we
579 support user defined character classes. */
580#if WIDE_CHAR_SUPPORT
581/* Solaris 2.5 has a bug: <wchar.h> must be included before <wctype.h>. */
582# include <wchar.h>
583# include <wctype.h>
584#endif
585
586#if WIDE_CHAR_SUPPORT
587/* The GNU C library provides support for user-defined character classes
588 and the functions from ISO C amendement 1. */
589# ifdef CHARCLASS_NAME_MAX
590# define CHAR_CLASS_MAX_LENGTH CHARCLASS_NAME_MAX
591# else
592/* This shouldn't happen but some implementation might still have this
593 problem. Use a reasonable default value. */
594# define CHAR_CLASS_MAX_LENGTH 256
595# endif
596typedef wctype_t re_wctype_t;
597typedef wchar_t re_wchar_t;
598# define re_wctype wctype
599# define re_iswctype iswctype
600# define re_wctype_to_bit(cc) 0
601#else
602# define CHAR_CLASS_MAX_LENGTH 9 /* Namely, `multibyte'. */
603# define btowc(c) c
604
605/* Character classes. */
606typedef enum { RECC_ERROR = 0,
607 RECC_ALNUM, RECC_ALPHA, RECC_WORD,
608 RECC_GRAPH, RECC_PRINT,
609 RECC_LOWER, RECC_UPPER,
610 RECC_PUNCT, RECC_CNTRL,
611 RECC_DIGIT, RECC_XDIGIT,
612 RECC_BLANK, RECC_SPACE,
613 RECC_MULTIBYTE, RECC_NONASCII,
614 RECC_ASCII, RECC_UNIBYTE
615} re_wctype_t;
616
fa8459a3
DN
617extern char re_iswctype (int ch, re_wctype_t cc);
618extern re_wctype_t re_wctype (const unsigned char* str);
619
c13ecd8f
RS
620typedef int re_wchar_t;
621
4e2f601f 622extern void re_set_whitespace_regexp (const char *regexp);
fa8459a3 623
c13ecd8f
RS
624#endif /* not WIDE_CHAR_SUPPORT */
625
0b32bf0e 626#endif /* regex.h */
b1fe2cfc 627\f