1 /* Definitions for data structures and routines for the regular
2 expression library, version 0.12.
4 Copyright (C) 1985, 1989, 1990, 1991, 1992, 1993 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; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
20 #ifndef __REGEXP_LIBRARY_H__
21 #define __REGEXP_LIBRARY_H__
25 #error This header should not be used when the system has a regex.h
28 /* POSIX says that <sys/types.h> must be included (by the caller) before
32 /* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it
38 #if defined(__cplusplus)
43 /* The following bits are used to determine the regexp syntax we
44 recognize. The set/not-set meanings are chosen so that Emacs syntax
45 remains the value 0. The bits are given in alphabetical order, and
46 the definitions shifted by one from the previous bit; thus, when we
47 add or remove a bit, only one other definition need change. */
48 typedef unsigned reg_syntax_t;
50 /* If this bit is not set, then \ inside a bracket expression is literal.
51 If set, then such a \ quotes the following character. */
52 #define RE_BACKSLASH_ESCAPE_IN_LISTS (1)
54 /* If this bit is not set, then + and ? are operators, and \+ and \? are
56 If set, then \+ and \? are operators and + and ? are literals. */
57 #define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
59 /* If this bit is set, then character classes are supported. They are:
60 [:alpha:], [:upper:], [:lower:], [:digit:], [:alnum:], [:xdigit:],
61 [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
62 If not set, then character classes are not supported. */
63 #define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
65 /* If this bit is set, then ^ and $ are always anchors (outside bracket
66 expressions, of course).
67 If this bit is not set, then it depends:
68 ^ is an anchor if it is at the beginning of a regular
69 expression or after an open-group or an alternation operator;
70 $ is an anchor if it is at the end of a regular expression, or
71 before a close-group or an alternation operator.
73 This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
74 POSIX draft 11.2 says that * etc. in leading positions is undefined.
75 We already implemented a previous draft which made those constructs
76 invalid, though, so we haven't changed the code back. */
77 #define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
79 /* If this bit is set, then special characters are always special
80 regardless of where they are in the pattern.
81 If this bit is not set, then special characters are special only in
82 some contexts; otherwise they are ordinary. Specifically,
83 * + ? and intervals are only special when not after the beginning,
84 open-group, or alternation operator. */
85 #define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
87 /* If this bit is set, then *, +, ?, and { cannot be first in an re or
88 immediately after an alternation or begin-group operator. */
89 #define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
91 /* If this bit is set, then . matches newline.
92 If not set, then it doesn't. */
93 #define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
95 /* If this bit is set, then . doesn't match NUL.
96 If not set, then it does. */
97 #define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
99 /* If this bit is set, nonmatching lists [^...] do not match newline.
100 If not set, they do. */
101 #define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
103 /* If this bit is set, either \{...\} or {...} defines an
104 interval, depending on RE_NO_BK_BRACES.
105 If not set, \{, \}, {, and } are literals. */
106 #define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
108 /* If this bit is set, +, ? and | aren't recognized as operators.
109 If not set, they are. */
110 #define RE_LIMITED_OPS (RE_INTERVALS << 1)
112 /* If this bit is set, newline is an alternation operator.
113 If not set, newline is literal. */
114 #define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
116 /* If this bit is set, then `{...}' defines an interval, and \{ and \}
118 If not set, then `\{...\}' defines an interval. */
119 #define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)
121 /* If this bit is set, (...) defines a group, and \( and \) are literals.
122 If not set, \(...\) defines a group, and ( and ) are literals. */
123 #define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
125 /* If this bit is set, then \<digit> matches <digit>.
126 If not set, then \<digit> is a back-reference. */
127 #define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
129 /* If this bit is set, then | is an alternation operator, and \| is literal.
130 If not set, then \| is an alternation operator, and | is literal. */
131 #define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
133 /* If this bit is set, then an ending range point collating higher
134 than the starting range point, as in [z-a], is invalid.
135 If not set, then when ending range point collates higher than the
136 starting range point, the range is ignored. */
137 #define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)
139 /* If this bit is set, then an unmatched ) is ordinary.
140 If not set, then an unmatched ) is invalid. */
141 #define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)
143 /* This global variable defines the particular regexp syntax to use (for
144 some interfaces). When a regexp is compiled, the syntax used is
145 stored in the pattern buffer, so changing this does not affect
146 already-compiled regexps. */
147 extern reg_syntax_t re_syntax_options;
149 /* Define combinations of the above bits for the standard possibilities.
150 (The [[[ comments delimit what gets put into the Texinfo file, so
151 don't delete them!) */
152 /* [[[begin syntaxes]]] */
153 #define RE_SYNTAX_EMACS 0
155 #define RE_SYNTAX_AWK \
156 (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL \
157 | RE_NO_BK_PARENS | RE_NO_BK_REFS \
158 | RE_NO_BK_VBAR | RE_NO_EMPTY_RANGES \
159 | RE_UNMATCHED_RIGHT_PAREN_ORD)
161 #define RE_SYNTAX_POSIX_AWK \
162 (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS)
164 #define RE_SYNTAX_GREP \
165 (RE_BK_PLUS_QM | RE_CHAR_CLASSES \
166 | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \
169 #define RE_SYNTAX_EGREP \
170 (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS \
171 | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE \
172 | RE_NEWLINE_ALT | RE_NO_BK_PARENS \
175 #define RE_SYNTAX_POSIX_EGREP \
176 (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)
178 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */
179 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
181 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
183 /* Syntax bits common to both basic and extended POSIX regex syntax. */
184 #define _RE_SYNTAX_POSIX_COMMON \
185 (RE_CHAR_CLASSES | RE_DOT_NEWLINE | RE_DOT_NOT_NULL \
186 | RE_INTERVALS | RE_NO_EMPTY_RANGES)
188 #define RE_SYNTAX_POSIX_BASIC \
189 (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
191 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes
192 RE_LIMITED_OPS, i.e., \? \+ \| are not recognized. Actually, this
193 isn't minimal, since other operators, such as \`, aren't disabled. */
194 #define RE_SYNTAX_POSIX_MINIMAL_BASIC \
195 (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)
197 #define RE_SYNTAX_POSIX_EXTENDED \
198 (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \
199 | RE_CONTEXT_INDEP_OPS | RE_NO_BK_BRACES \
200 | RE_NO_BK_PARENS | RE_NO_BK_VBAR \
201 | RE_UNMATCHED_RIGHT_PAREN_ORD)
203 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS
204 replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added. */
205 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED \
206 (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \
207 | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES \
208 | RE_NO_BK_PARENS | RE_NO_BK_REFS \
209 | RE_NO_BK_VBAR | RE_UNMATCHED_RIGHT_PAREN_ORD)
210 /* [[[end syntaxes]]] */
212 /* Maximum number of duplicates an interval can allow. Some systems
213 (erroneously) define this in other header files, but we want our
214 value, so remove any previous define. */
218 #define RE_DUP_MAX ((1 << 15) - 1)
221 /* POSIX `cflags' bits (i.e., information for `regcomp'). */
223 /* If this bit is set, then use extended regular expression syntax.
224 If not set, then use basic regular expression syntax. */
225 #define REG_EXTENDED 1
227 /* If this bit is set, then ignore case when matching.
228 If not set, then case is significant. */
229 #define REG_ICASE (REG_EXTENDED << 1)
231 /* If this bit is set, then anchors do not match at newline
232 characters in the string.
233 If not set, then anchors do match at newlines. */
234 #define REG_NEWLINE (REG_ICASE << 1)
236 /* If this bit is set, then report only success or fail in regexec.
237 If not set, then returns differ between not matching and errors. */
238 #define REG_NOSUB (REG_NEWLINE << 1)
241 /* POSIX `eflags' bits (i.e., information for regexec). */
243 /* If this bit is set, then the beginning-of-line operator doesn't match
244 the beginning of the string (presumably because it's not the
245 beginning of a line).
246 If not set, then the beginning-of-line operator does match the
247 beginning of the string. */
250 /* Like REG_NOTBOL, except for the end-of-line. */
251 #define REG_NOTEOL (1 << 1)
254 /* If any error codes are removed, changed, or added, update the
255 `re_error_msg' table in regex.c. */
258 REG_NOERROR = 0, /* Success. */
259 REG_NOMATCH, /* Didn't find a match (for regexec). */
261 /* POSIX regcomp return error codes. (In the order listed in the
263 REG_BADPAT, /* Invalid pattern. */
264 REG_ECOLLATE, /* Not implemented. */
265 REG_ECTYPE, /* Invalid character class name. */
266 REG_EESCAPE, /* Trailing backslash. */
267 REG_ESUBREG, /* Invalid back reference. */
268 REG_EBRACK, /* Unmatched left bracket. */
269 REG_EPAREN, /* Parenthesis imbalance. */
270 REG_EBRACE, /* Unmatched \{. */
271 REG_BADBR, /* Invalid contents of \{\}. */
272 REG_ERANGE, /* Invalid range end. */
273 REG_ESPACE, /* Ran out of memory. */
274 REG_BADRPT, /* No preceding re for repetition op. */
276 /* Error codes we've added. */
277 REG_EEND, /* Premature end. */
278 REG_ESIZE, /* Compiled pattern bigger than 2^16 bytes. */
279 REG_ERPAREN /* Unmatched ) or \); not returned from regcomp. */
282 /* This data structure represents a compiled pattern. Before calling
283 the pattern compiler, the fields `buffer', `allocated', `fastmap',
284 `translate', and `no_sub' can be set. After the pattern has been
285 compiled, the `re_nsub' field is available. All other fields are
286 private to the regex routines. */
288 struct re_pattern_buffer
290 /* [[[begin pattern_buffer]]] */
291 /* Space that holds the compiled pattern. It is declared as
292 `unsigned char *' because its elements are
293 sometimes used as array indexes. */
294 unsigned char *buffer;
296 /* Number of bytes to which `buffer' points. */
297 unsigned long allocated;
299 /* Number of bytes actually used in `buffer'. */
302 /* Syntax setting with which the pattern was compiled. */
305 /* Pointer to a fastmap, if any, otherwise zero. re_search uses
306 the fastmap, if there is one, to skip over impossible
307 starting points for matches. */
310 /* Either a translate table to apply to all characters before
311 comparing them, or zero for no translation. The translation
312 is applied to a pattern when it is compiled and to a string
313 when it is matched. */
316 /* Number of subexpressions found by the compiler. */
319 /* Zero if this pattern cannot match the empty string, one else.
320 Well, in truth it's used only in `re_search_2', to see
321 whether or not we should use the fastmap, so we don't set
322 this absolutely perfectly; see `re_compile_fastmap' (the
323 `duplicate' case). */
324 unsigned can_be_null : 1;
326 /* If REGS_UNALLOCATED, allocate space in the `regs' structure
327 for `max (RE_NREGS, re_nsub + 1)' groups.
328 If REGS_REALLOCATE, reallocate space if necessary.
329 If REGS_FIXED, use what's there. */
330 #define REGS_UNALLOCATED 0
331 #define REGS_REALLOCATE 1
333 unsigned regs_allocated : 2;
335 /* Set to zero when `regex_compile' compiles a pattern; set to one
336 by `re_compile_fastmap' if it updates the fastmap. */
337 unsigned fastmap_accurate : 1;
339 /* If set, `re_match_2' does not return information about
343 /* If set, a beginning-of-line anchor doesn't match at the
344 beginning of the string. */
345 unsigned not_bol : 1;
347 /* Similarly for an end-of-line anchor. */
348 unsigned not_eol : 1;
350 /* If true, an anchor at a newline matches. */
351 unsigned newline_anchor : 1;
353 /* [[[end pattern_buffer]]] */
356 typedef struct re_pattern_buffer regex_t;
359 /* search.c (search_buffer) in Emacs needs this one opcode value. It is
360 defined both in `regex.c' and here. */
361 #define RE_EXACTN_VALUE 1
363 /* Type for byte offsets within the string. POSIX mandates this. */
364 typedef int regoff_t;
367 /* This is the structure we store register match data in. See
368 regex.texinfo for a full description of what registers match. */
377 /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
378 `re_match_2' returns information about at least this many registers
379 the first time a `regs' structure is passed. */
385 /* POSIX specification for registers. Aside from the different names than
386 `re_registers', POSIX uses an array of structures, instead of a
387 structure of arrays. */
390 regoff_t rm_so; /* Byte offset from string's start to substring's start. */
391 regoff_t rm_eo; /* Byte offset from string's start to substring's end. */
394 /* Declarations for routines. */
396 /* To avoid duplicating every routine declaration -- once with a
397 prototype (if we are ANSI), and once without (if we aren't) -- we
398 use the following macro to declare argument types. This
399 unfortunately clutters up the declarations a bit, but I think it's
404 #define _RE_ARGS(args) args
406 #else /* not __STDC__ */
408 #define _RE_ARGS(args) ()
410 #endif /* not __STDC__ */
412 /* Sets the current default syntax to SYNTAX, and return the old syntax.
413 You can also simply assign to the `re_syntax_options' variable. */
414 extern reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax));
416 /* Compile the regular expression PATTERN, with length LENGTH
417 and syntax given by the global `re_syntax_options', into the buffer
418 BUFFER. Return NULL if successful, and an error string if not. */
419 extern const char *re_compile_pattern
420 _RE_ARGS ((const char *pattern, int length,
421 struct re_pattern_buffer *buffer));
424 /* Compile a fastmap for the compiled pattern in BUFFER; used to
425 accelerate searches. Return 0 if successful and -2 if was an
427 extern int re_compile_fastmap _RE_ARGS ((struct re_pattern_buffer *buffer));
430 /* Search in the string STRING (with length LENGTH) for the pattern
431 compiled into BUFFER. Start searching at position START, for RANGE
432 characters. Return the starting position of the match, -1 for no
433 match, or -2 for an internal error. Also return register
434 information in REGS (if REGS and BUFFER->no_sub are nonzero). */
436 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
437 int length, int start, int range, struct re_registers *regs));
440 /* Like `re_search', but search in the concatenation of STRING1 and
441 STRING2. Also, stop searching at index START + STOP. */
442 extern int re_search_2
443 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
444 int length1, const char *string2, int length2,
445 int start, int range, struct re_registers *regs, int stop));
448 /* Like `re_search', but return how many characters in STRING the regexp
449 in BUFFER matched, starting at position START. */
451 _RE_ARGS ((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 extern int re_match_2
457 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
458 int length1, const char *string2, int length2,
459 int start, struct re_registers *regs, int stop));
462 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
463 ENDS. Subsequent matches using BUFFER and REGS will use this memory
464 for recording register information. STARTS and ENDS must be
465 allocated with malloc, and must each be at least `NUM_REGS * sizeof
466 (regoff_t)' bytes long.
468 If NUM_REGS == 0, then subsequent matches should allocate their own
471 Unless this function is called, the first search or match using
472 PATTERN_BUFFER will allocate its own register data, without
473 freeing the old data. */
474 extern void re_set_registers
475 _RE_ARGS ((struct re_pattern_buffer *buffer, struct re_registers *regs,
476 unsigned num_regs, regoff_t *starts, regoff_t *ends));
478 /* 4.2 bsd compatibility. */
479 extern char *re_comp _RE_ARGS ((const char *));
480 extern int re_exec _RE_ARGS ((const char *));
482 /* POSIX compatibility. */
483 extern int regcomp _RE_ARGS ((regex_t *preg, const char *pattern, int cflags));
485 _RE_ARGS ((const regex_t *preg, const char *string, size_t nmatch,
486 regmatch_t pmatch[], int eflags));
487 extern size_t regerror
488 _RE_ARGS ((int errcode, const regex_t *preg, char *errbuf,
489 size_t errbuf_size));
490 extern void regfree _RE_ARGS ((regex_t *preg));
493 #if defined(__cplusplus)
497 #endif /* not __REGEXP_LIBRARY_H__ */
503 trim-versions-without-asking: nil