1 /* Definitions for data structures and routines for the regular
2 expression library, version 0.12.
4 Copyright (C) 1985, 89, 90, 91, 92, 93, 95 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Synched up with: FSF 19.29. */
23 #ifndef INCLUDED_regex_h_
24 #define INCLUDED_regex_h_
27 #define RE_TRANSLATE_TYPE Lisp_Object
29 #define RE_TRANSLATE_TYPE char *
32 /* POSIX says that <sys/types.h> must be included (by the caller) before
36 /* The following bits are used to determine the regexp syntax we
37 recognize. The not-set meaning typically corresponds to the syntax
38 used by Emacs (the exception is RE_INTERVAL, made for historical
39 reasons). The bits are given in alphabetical order, and the
40 definitions shifted by one from the previous bit; thus, when we add or
41 remove a bit, only one other definition need change. */
42 typedef unsigned reg_syntax_t;
44 /* If this bit is not set, then \ inside a bracket expression is literal.
45 If set, then such a \ quotes the following character. */
46 #define RE_BACKSLASH_ESCAPE_IN_LISTS (1)
48 /* If this bit is not set, then + and ? are operators, and \+ and \? are
50 If set, then \+ and \? are operators and + and ? are literals. */
51 #define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
53 /* If this bit is set, then character classes are supported. They are:
54 [:alpha:], [:upper:], [:lower:], [:digit:], [:alnum:], [:xdigit:],
55 [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
56 If not set, then character classes are not supported. */
57 #define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
59 /* If this bit is set, then ^ and $ are always anchors (outside bracket
60 expressions, of course).
61 If this bit is not set, then it depends:
62 ^ is an anchor if it is at the beginning of a regular
63 expression or after an open-group or an alternation operator;
64 $ is an anchor if it is at the end of a regular expression, or
65 before a close-group or an alternation operator.
67 This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
68 POSIX draft 11.2 says that * etc. in leading positions is undefined.
69 We already implemented a previous draft which made those constructs
70 invalid, though, so we haven't changed the code back. */
71 #define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
73 /* If this bit is set, then special characters are always special
74 regardless of where they are in the pattern.
75 If this bit is not set, then special characters are special only in
76 some contexts; otherwise they are ordinary. Specifically,
77 * + ? and intervals are only special when not after the beginning,
78 open-group, or alternation operator. */
79 #define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
81 /* If this bit is set, then *, +, ?, and { cannot be first in an re or
82 immediately after an alternation or begin-group operator. */
83 #define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
85 /* If this bit is set, then . matches newline.
86 If not set, then it doesn't. */
87 #define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
89 /* If this bit is set, then . doesn't match NUL.
90 If not set, then it does. */
91 #define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
93 /* If this bit is set, nonmatching lists [^...] do not match newline.
94 If not set, they do. */
95 #define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
97 /* If this bit is set, either \{...\} or {...} defines an
98 interval, depending on RE_NO_BK_BRACES.
99 If not set, \{, \}, {, and } are literals. */
100 #define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
102 /* If this bit is set, +, ? and | aren't recognized as operators.
103 If not set, they are. */
104 #define RE_LIMITED_OPS (RE_INTERVALS << 1)
106 /* If this bit is set, newline is an alternation operator.
107 If not set, newline is literal. */
108 #define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
110 /* If this bit is set, then `{...}' defines an interval, and \{ and \}
112 If not set, then `\{...\}' defines an interval. */
113 #define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)
115 /* If this bit is set, (...) defines a group, and \( and \) are literals.
116 If not set, \(...\) defines a group, and ( and ) are literals. */
117 #define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
119 /* If this bit is set, then \<digit> matches <digit>.
120 If not set, then \<digit> is a back-reference. */
121 #define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
123 /* If this bit is set, then | is an alternation operator, and \| is literal.
124 If not set, then \| is an alternation operator, and | is literal. */
125 #define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
127 /* If this bit is set, then an ending range point collating higher
128 than the starting range point, as in [z-a], is invalid.
129 If not set, then when ending range point collates higher than the
130 starting range point, the range is ignored. */
131 #define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)
133 /* If this bit is not set, allow minimal matching:
134 - a*? and a+? and a?? perform shortest-possible matching (compare with a*
135 and a+ and a?, respectively, which perform longest-possible matching)
136 - other juxtaposing of * + and ? is rejected.
137 If this bit is set, consecutive * + and ?'s are collapsed in a logical
139 - a*? and a+? are the same as a*
140 - a?? is the same as a?
142 #define RE_NO_MINIMAL_MATCHING (RE_NO_EMPTY_RANGES << 1)
144 /* If this bit is set, succeed as soon as we match the whole pattern,
145 without further backtracking. */
146 #define RE_NO_POSIX_BACKTRACKING (RE_NO_MINIMAL_MATCHING << 1)
148 /* If this bit is not set, (?:re) behaves like (re) (or \(?:re\) behaves like
149 \(re\)) except that the matched string is not registered. */
150 #define RE_NO_SHY_GROUPS (RE_NO_POSIX_BACKTRACKING << 1)
152 /* If this bit is set, then an unmatched ) is ordinary.
153 If not set, then an unmatched ) is invalid. */
154 #define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_SHY_GROUPS << 1)
156 /* This global variable defines the particular regexp syntax to use (for
157 some interfaces). When a regexp is compiled, the syntax used is
158 stored in the pattern buffer, so changing this does not affect
159 already-compiled regexps. */
160 extern reg_syntax_t re_syntax_options;
162 /* Define combinations of the above bits for the standard possibilities.
163 (The [[[ comments delimit what gets put into the Texinfo file, so
164 don't delete them!) */
165 /* [[[begin syntaxes]]] */
166 #define RE_SYNTAX_EMACS RE_INTERVALS
168 #define RE_SYNTAX_AWK \
169 (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL \
170 | RE_NO_BK_PARENS | RE_NO_BK_REFS \
171 | RE_NO_BK_VBAR | RE_NO_EMPTY_RANGES \
172 | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_SHY_GROUPS \
173 | RE_NO_MINIMAL_MATCHING)
175 #define RE_SYNTAX_POSIX_AWK \
176 (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS)
178 #define RE_SYNTAX_GREP \
179 (RE_BK_PLUS_QM | RE_CHAR_CLASSES \
180 | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \
181 | RE_NEWLINE_ALT | RE_NO_SHY_GROUPS \
182 | RE_NO_MINIMAL_MATCHING)
184 #define RE_SYNTAX_EGREP \
185 (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS \
186 | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE \
187 | RE_NEWLINE_ALT | RE_NO_BK_PARENS \
188 | RE_NO_BK_VBAR | RE_NO_SHY_GROUPS \
189 | RE_NO_MINIMAL_MATCHING)
191 #define RE_SYNTAX_POSIX_EGREP \
192 (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)
194 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */
195 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
197 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
199 /* Syntax bits common to both basic and extended POSIX regex syntax. */
200 #define _RE_SYNTAX_POSIX_COMMON \
201 (RE_CHAR_CLASSES | RE_DOT_NEWLINE | RE_DOT_NOT_NULL \
202 | RE_INTERVALS | RE_NO_EMPTY_RANGES | RE_NO_SHY_GROUPS \
203 | RE_NO_MINIMAL_MATCHING)
205 #define RE_SYNTAX_POSIX_BASIC \
206 (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
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)
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)
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]]] */
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. */
235 #define RE_DUP_MAX ((1 << 15) - 1)
238 /* POSIX `cflags' bits (i.e., information for `regcomp'). */
240 /* If this bit is set, then use extended regular expression syntax.
241 If not set, then use basic regular expression syntax. */
242 #define REG_EXTENDED 1
244 /* If this bit is set, then ignore case when matching.
245 If not set, then case is significant. */
246 #define REG_ICASE (REG_EXTENDED << 1)
248 /* If this bit is set, then anchors do not match at newline
249 characters in the string.
250 If not set, then anchors do match at newlines. */
251 #define REG_NEWLINE (REG_ICASE << 1)
253 /* If this bit is set, then report only success or fail in regexec.
254 If not set, then returns differ between not matching and errors. */
255 #define REG_NOSUB (REG_NEWLINE << 1)
258 /* POSIX `eflags' bits (i.e., information for regexec). */
260 /* If this bit is set, then the beginning-of-line operator doesn't match
261 the beginning of the string (presumably because it's not the
262 beginning of a line).
263 If not set, then the beginning-of-line operator does match the
264 beginning of the string. */
267 /* Like REG_NOTBOL, except for the end-of-line. */
268 #define REG_NOTEOL (1 << 1)
271 /* If any error codes are removed, changed, or added, update the
272 `re_error_msg' table in regex.c. */
275 REG_NOERROR = 0, /* Success. */
276 REG_NOMATCH, /* Didn't find a match (for regexec). */
278 /* POSIX regcomp return error codes. (In the order listed in the
280 REG_BADPAT, /* Invalid pattern. */
281 REG_ECOLLATE, /* Not implemented. */
282 REG_ECTYPE, /* Invalid character class name. */
283 REG_EESCAPE, /* Trailing backslash. */
284 REG_ESUBREG, /* Invalid back reference. */
285 REG_EBRACK, /* Unmatched left bracket. */
286 REG_EPAREN, /* Parenthesis imbalance. */
287 REG_EBRACE, /* Unmatched \{. */
288 REG_BADBR, /* Invalid contents of \{\}. */
289 REG_ERANGE, /* Invalid range end. */
290 REG_ESPACE, /* Ran out of memory. */
291 REG_BADRPT, /* No preceding re for repetition op. */
293 /* Error codes we've added. */
294 REG_EEND, /* Premature end. */
295 REG_ESIZE, /* Compiled pattern bigger than 2^16 bytes. */
296 REG_ERPAREN /* Unmatched ) or \); not returned from regcomp. */
298 ,REG_ESYNTAX /* Invalid syntax designator. */
301 ,REG_ERANGESPAN /* Ranges may not span charsets. */
302 ,REG_ECATEGORY /* Invalid category designator */
306 /* This data structure represents a compiled pattern. Before calling
307 the pattern compiler, the fields `buffer', `allocated', `fastmap',
308 `translate', and `no_sub' can be set. After the pattern has been
309 compiled, the `re_nsub' field is available. All other fields are
310 private to the regex routines. */
312 struct re_pattern_buffer
314 /* [[[begin pattern_buffer]]] */
315 /* Space that holds the compiled pattern. It is declared as
316 `unsigned char *' because its elements are
317 sometimes used as array indexes. */
318 unsigned char *buffer;
320 /* Number of bytes to which `buffer' points. */
321 unsigned long allocated;
323 /* Number of bytes actually used in `buffer'. */
326 /* Syntax setting with which the pattern was compiled. */
329 /* Pointer to a fastmap, if any, otherwise zero. re_search uses
330 the fastmap, if there is one, to skip over impossible
331 starting points for matches. */
334 /* Either a translate table to apply to all characters before
335 comparing them, or zero for no translation. The translation
336 is applied to a pattern when it is compiled and to a string
337 when it is matched. */
338 RE_TRANSLATE_TYPE translate;
340 /* Number of subexpressions found by the compiler. */
343 /* Zero if this pattern cannot match the empty string, one else.
344 Well, in truth it's used only in `re_search_2', to see
345 whether or not we should use the fastmap, so we don't set
346 this absolutely perfectly; see `re_compile_fastmap' (the
347 `duplicate' case). */
348 unsigned can_be_null : 1;
350 /* If REGS_UNALLOCATED, allocate space in the `regs' structure
351 for `max (RE_NREGS, re_nsub + 1)' groups.
352 If REGS_REALLOCATE, reallocate space if necessary.
353 If REGS_FIXED, use what's there. */
354 #define REGS_UNALLOCATED 0
355 #define REGS_REALLOCATE 1
357 unsigned regs_allocated : 2;
359 /* Set to zero when `regex_compile' compiles a pattern; set to one
360 by `re_compile_fastmap' if it updates the fastmap. */
361 unsigned fastmap_accurate : 1;
363 /* If set, `re_match_2' does not return information about
367 /* If set, a beginning-of-line anchor doesn't match at the
368 beginning of the string. */
369 unsigned not_bol : 1;
371 /* Similarly for an end-of-line anchor. */
372 unsigned not_eol : 1;
374 /* If true, an anchor at a newline matches. */
375 unsigned newline_anchor : 1;
377 /* [[[end pattern_buffer]]] */
380 typedef struct re_pattern_buffer regex_t;
382 /* Type for byte offsets within the string. POSIX mandates this. */
383 typedef int regoff_t;
386 /* This is the structure we store register match data in. See
387 regex.texinfo for a full description of what registers match. */
396 /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
397 `re_match_2' returns information about at least this many registers
398 the first time a `regs' structure is passed. */
404 /* POSIX specification for registers. Aside from the different names than
405 `re_registers', POSIX uses an array of structures, instead of a
406 structure of arrays. */
409 regoff_t rm_so; /* Byte offset from string's start to substring's start. */
410 regoff_t rm_eo; /* Byte offset from string's start to substring's end. */
413 /* Declarations for routines. */
415 /* Sets the current default syntax to SYNTAX, and return the old syntax.
416 You can also simply assign to the `re_syntax_options' variable. */
417 reg_syntax_t re_set_syntax (reg_syntax_t syntax);
419 /* Compile the regular expression PATTERN, with length LENGTH
420 and syntax given by the global `re_syntax_options', into the buffer
421 BUFFER. Return NULL if successful, and an error string if not. */
422 const char *re_compile_pattern (const char *pattern, int length,
423 struct re_pattern_buffer *buffer);
426 /* Compile a fastmap for the compiled pattern in BUFFER; used to
427 accelerate searches. Return 0 if successful and -2 if was an
429 int re_compile_fastmap (struct re_pattern_buffer *buffer);
432 /* Search in the string STRING (with length LENGTH) for the pattern
433 compiled into BUFFER. Start searching at position START, for RANGE
434 characters. Return the starting position of the match, -1 for no
435 match, or -2 for an internal error. Also return register
436 information in REGS (if REGS and BUFFER->no_sub are nonzero). */
437 int re_search (struct re_pattern_buffer *buffer, const char *string,
438 int length, int start, int range,
439 struct re_registers *regs);
442 /* Like `re_search', but search in the concatenation of STRING1 and
443 STRING2. Also, stop searching at index START + STOP. */
444 int re_search_2 (struct re_pattern_buffer *buffer, const char *string1,
445 int length1, const char *string2, int length2, int start,
446 int range, struct re_registers *regs, int stop);
449 /* Like `re_search', but return how many characters in STRING the regexp
450 in BUFFER matched, starting at position START. */
451 int re_match (struct re_pattern_buffer *buffer, const char *string,
452 int length, int start, struct re_registers *regs);
455 /* Relates to `re_match' as `re_search_2' relates to `re_search'. */
456 int re_match_2 (struct re_pattern_buffer *buffer, const char *string1,
457 int length1, const char *string2, int length2,
458 int start, struct re_registers *regs, int stop);
461 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
462 ENDS. Subsequent matches using BUFFER and REGS will use this memory
463 for recording register information. STARTS and ENDS must be
464 allocated with malloc, and must each be at least `NUM_REGS * sizeof
465 (regoff_t)' bytes long.
467 If NUM_REGS == 0, then subsequent matches should allocate their own
470 Unless this function is called, the first search or match using
471 PATTERN_BUFFER will allocate its own register data, without
472 freeing the old data. */
473 void re_set_registers (struct re_pattern_buffer *buffer,
474 struct re_registers *regs, unsigned num_regs,
475 regoff_t *starts, regoff_t *ends);
477 #ifdef _REGEX_RE_COMP
478 /* 4.2 bsd compatibility. */
479 char *re_comp (const char *);
480 int re_exec (const char *);
483 /* POSIX compatibility. */
484 int regcomp (regex_t *preg, const char *pattern, int cflags);
485 int regexec (const regex_t *preg, const char *string, size_t nmatch,
486 regmatch_t pmatch[], int eflags);
487 size_t regerror (int errcode, const regex_t *preg, char *errbuf,
489 void regfree (regex_t *preg);
491 #endif /* INCLUDED_regex_h_ */