00001 /* 00002 Stop: You should be using simple_regex instead of regex.h! 00003 */ 00004 00010 00011 00012 #ifdef __cplusplus 00013 extern "C" 00014 { 00015 #endif 00016 00017 /* Definitions for data structures and routines for the regular 00018 expression library, version 0.12. 00019 00020 Copyright (C) 1985, 1989, 1990, 1991, 1992, 1993 Free Software Foundation, Inc. 00021 00022 This program is free software; you can redistribute it and/or modify 00023 it under the terms of the GNU General Public License as published by 00024 the Free Software Foundation; either version 2, or (at your option) 00025 any later version. 00026 00027 This program is distributed in the hope that it will be useful, 00028 but WITHOUT ANY WARRANTY; without even the implied warranty of 00029 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00030 GNU General Public License for more details. 00031 00032 You should have received a copy of the GNU General Public License 00033 along with this program; if not, write to the Free Software 00034 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ 00035 00036 #ifndef __REGEXP_LIBRARY_H__ 00037 #define __REGEXP_LIBRARY_H__ 00038 00039 /* POSIX says that <sys/types.h> must be included (by the caller) before 00040 <regex.h>. */ 00041 00042 #ifdef VMS 00043 /* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it 00044 should be there. */ 00045 #include <stddef.h> 00046 #endif 00047 00048 00049 /* The following bits are used to determine the regexp syntax we 00050 recognize. The set/not-set meanings are chosen so that Emacs syntax 00051 remains the value 0. The bits are given in alphabetical order, and 00052 the definitions shifted by one from the previous bit; thus, when we 00053 add or remove a bit, only one other definition need change. */ 00054 typedef unsigned reg_syntax_t; 00055 00056 /* If this bit is not set, then \ inside a bracket expression is literal. 00057 If set, then such a \ quotes the following character. */ 00058 #define RE_BACKSLASH_ESCAPE_IN_LISTS (1) 00059 00060 /* If this bit is not set, then + and ? are operators, and \+ and \? are 00061 literals. 00062 If set, then \+ and \? are operators and + and ? are literals. */ 00063 #define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1) 00064 00065 /* If this bit is set, then character classes are supported. They are: 00066 [:alpha:], [:upper:], [:lower:], [:digit:], [:alnum:], [:xdigit:], 00067 [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:]. 00068 If not set, then character classes are not supported. */ 00069 #define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1) 00070 00071 /* If this bit is set, then ^ and $ are always anchors (outside bracket 00072 expressions, of course). 00073 If this bit is not set, then it depends: 00074 ^ is an anchor if it is at the beginning of a regular 00075 expression or after an open-group or an alternation operator; 00076 $ is an anchor if it is at the end of a regular expression, or 00077 before a close-group or an alternation operator. 00078 00079 This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because 00080 POSIX draft 11.2 says that * etc. in leading positions is undefined. 00081 We already implemented a previous draft which made those constructs 00082 invalid, though, so we haven't changed the code back. */ 00083 #define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1) 00084 00085 /* If this bit is set, then special characters are always special 00086 regardless of where they are in the pattern. 00087 If this bit is not set, then special characters are special only in 00088 some contexts; otherwise they are ordinary. Specifically, 00089 * + ? and intervals are only special when not after the beginning, 00090 open-group, or alternation operator. */ 00091 #define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1) 00092 00093 /* If this bit is set, then *, +, ?, and { cannot be first in an re or 00094 immediately after an alternation or begin-group operator. */ 00095 #define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1) 00096 00097 /* If this bit is set, then . matches newline. 00098 If not set, then it doesn't. */ 00099 #define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1) 00100 00101 /* If this bit is set, then . doesn't match NUL. 00102 If not set, then it does. */ 00103 #define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1) 00104 00105 /* If this bit is set, nonmatching lists [^...] do not match newline. 00106 If not set, they do. */ 00107 #define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1) 00108 00109 /* If this bit is set, either \{...\} or {...} defines an 00110 interval, depending on RE_NO_BK_BRACES. 00111 If not set, \{, \}, {, and } are literals. */ 00112 #define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1) 00113 00114 /* If this bit is set, +, ? and | aren't recognized as operators. 00115 If not set, they are. */ 00116 #define RE_LIMITED_OPS (RE_INTERVALS << 1) 00117 00118 /* If this bit is set, newline is an alternation operator. 00119 If not set, newline is literal. */ 00120 #define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1) 00121 00122 /* If this bit is set, then `{...}' defines an interval, and \{ and \} 00123 are literals. 00124 If not set, then `\{...\}' defines an interval. */ 00125 #define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1) 00126 00127 /* If this bit is set, (...) defines a group, and \( and \) are literals. 00128 If not set, \(...\) defines a group, and ( and ) are literals. */ 00129 #define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1) 00130 00131 /* If this bit is set, then <digit> matches <digit>. 00132 If not set, then <digit> is a back-reference. */ 00133 #define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1) 00134 00135 /* If this bit is set, then | is an alternation operator, and \| is literal. 00136 If not set, then \| is an alternation operator, and | is literal. */ 00137 #define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1) 00138 00139 /* If this bit is set, then an ending range point collating higher 00140 than the starting range point, as in [z-a], is invalid. 00141 If not set, then when ending range point collates higher than the 00142 starting range point, the range is ignored. */ 00143 #define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1) 00144 00145 /* If this bit is set, then an unmatched ) is ordinary. 00146 If not set, then an unmatched ) is invalid. */ 00147 #define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1) 00148 00149 /* This global variable defines the particular regexp syntax to use (for 00150 some interfaces). When a regexp is compiled, the syntax used is 00151 stored in the pattern buffer, so changing this does not affect 00152 already-compiled regexps. */ 00153 extern reg_syntax_t re_syntax_options; 00154 00155 /* Define combinations of the above bits for the standard possibilities. 00156 (The [[[ comments delimit what gets put into the Texinfo file, so 00157 don't delete them!) */ 00158 /* [[[begin syntaxes]]] */ 00159 #define RE_SYNTAX_EMACS 0 00160 00161 #define RE_SYNTAX_AWK \ 00162 (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL \ 00163 | RE_NO_BK_PARENS | RE_NO_BK_REFS \ 00164 | RE_NO_BK_VBAR | RE_NO_EMPTY_RANGES \ 00165 | RE_UNMATCHED_RIGHT_PAREN_ORD) 00166 00167 #define RE_SYNTAX_POSIX_AWK \ 00168 (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS) 00169 00170 #define RE_SYNTAX_GREP \ 00171 (RE_BK_PLUS_QM | RE_CHAR_CLASSES \ 00172 | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \ 00173 | RE_NEWLINE_ALT) 00174 00175 #define RE_SYNTAX_EGREP \ 00176 (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS \ 00177 | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE \ 00178 | RE_NEWLINE_ALT | RE_NO_BK_PARENS \ 00179 | RE_NO_BK_VBAR) 00180 00181 #define RE_SYNTAX_POSIX_EGREP \ 00182 (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES) 00183 00184 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */ 00185 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC 00186 00187 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC 00188 00189 /* Syntax bits common to both basic and extended POSIX regex syntax. */ 00190 #define _RE_SYNTAX_POSIX_COMMON \ 00191 (RE_CHAR_CLASSES | RE_DOT_NEWLINE | RE_DOT_NOT_NULL \ 00192 | RE_INTERVALS | RE_NO_EMPTY_RANGES) 00193 00194 #define RE_SYNTAX_POSIX_BASIC \ 00195 (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM) 00196 00197 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes 00198 RE_LIMITED_OPS, i.e., \? \+ \| are not recognized. Actually, this 00199 isn't minimal, since other operators, such as \`, aren't disabled. */ 00200 #define RE_SYNTAX_POSIX_MINIMAL_BASIC \ 00201 (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS) 00202 00203 #define RE_SYNTAX_POSIX_EXTENDED \ 00204 (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \ 00205 | RE_CONTEXT_INDEP_OPS | RE_NO_BK_BRACES \ 00206 | RE_NO_BK_PARENS | RE_NO_BK_VBAR \ 00207 | RE_UNMATCHED_RIGHT_PAREN_ORD) 00208 00209 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS 00210 replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added. */ 00211 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED \ 00212 (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \ 00213 | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES \ 00214 | RE_NO_BK_PARENS | RE_NO_BK_REFS \ 00215 | RE_NO_BK_VBAR | RE_UNMATCHED_RIGHT_PAREN_ORD) 00216 /* [[[end syntaxes]]] */ 00217 00218 /* Maximum number of duplicates an interval can allow. Some systems 00219 (erroneously) define this in other header files, but we want our 00220 value, so remove any previous define. */ 00221 #ifdef RE_DUP_MAX 00222 #undef RE_DUP_MAX 00223 #endif 00224 #define RE_DUP_MAX ((1 << 15) - 1) 00225 00226 00227 /* POSIX `cflags' bits (i.e., information for `regcomp'). */ 00228 00229 /* If this bit is set, then use extended regular expression syntax. 00230 If not set, then use basic regular expression syntax. */ 00231 #define REG_EXTENDED 1 00232 00233 /* If this bit is set, then ignore case when matching. 00234 If not set, then case is significant. */ 00235 #define REG_ICASE (REG_EXTENDED << 1) 00236 00237 /* If this bit is set, then anchors do not match at newline 00238 characters in the string. 00239 If not set, then anchors do match at newlines. */ 00240 #define REG_NEWLINE (REG_ICASE << 1) 00241 00242 /* If this bit is set, then report only success or fail in regexec. 00243 If not set, then returns differ between not matching and errors. */ 00244 #define REG_NOSUB (REG_NEWLINE << 1) 00245 00246 00247 /* POSIX `eflags' bits (i.e., information for regexec). */ 00248 00249 /* If this bit is set, then the beginning-of-line operator doesn't match 00250 the beginning of the string (presumably because it's not the 00251 beginning of a line). 00252 If not set, then the beginning-of-line operator does match the 00253 beginning of the string. */ 00254 #define REG_NOTBOL 1 00255 00256 /* Like REG_NOTBOL, except for the end-of-line. */ 00257 #define REG_NOTEOL (1 << 1) 00258 00259 00260 /* If any error codes are removed, changed, or added, update the 00261 `re_error_msg' table in regex.c. */ 00262 typedef enum 00263 { 00264 REG_NOERROR = 0, /* Success. */ 00265 REG_NOMATCH, /* Didn't find a match (for regexec). */ 00266 00267 /* POSIX regcomp return error codes. (In the order listed in the 00268 standard.) */ 00269 REG_BADPAT, /* Invalid pattern. */ 00270 REG_ECOLLATE, /* Not implemented. */ 00271 REG_ECTYPE, /* Invalid character class name. */ 00272 REG_EESCAPE, /* Trailing backslash. */ 00273 REG_ESUBREG, /* Invalid back reference. */ 00274 REG_EBRACK, /* Unmatched left bracket. */ 00275 REG_EPAREN, /* Parenthesis imbalance. */ 00276 REG_EBRACE, /* Unmatched \{. */ 00277 REG_BADBR, /* Invalid contents of \{\}. */ 00278 REG_ERANGE, /* Invalid range end. */ 00279 REG_ESPACE, /* Ran out of memory. */ 00280 REG_BADRPT, /* No preceding re for repetition op. */ 00281 00282 /* Error codes we've added. */ 00283 REG_EEND, /* Premature end. */ 00284 REG_ESIZE, /* Compiled pattern bigger than 2^16 bytes. */ 00285 REG_ERPAREN /* Unmatched ) or \); not returned from regcomp. */ 00286 } reg_errcode_t; 00287 00288 /* This data structure represents a compiled pattern. Before calling 00289 the pattern compiler, the fields `buffer', `allocated', `fastmap', 00290 `translate', and `no_sub' can be set. After the pattern has been 00291 compiled, the `re_nsub' field is available. All other fields are 00292 private to the regex routines. */ 00293 00294 struct re_pattern_buffer 00295 { 00296 /* [[[begin pattern_buffer]]] */ 00297 /* Space that holds the compiled pattern. It is declared as 00298 `unsigned char *' because its elements are 00299 sometimes used as array indexes. */ 00300 unsigned char *buffer; 00301 00302 /* Number of bytes to which `buffer' points. */ 00303 unsigned long allocated; 00304 00305 /* Number of bytes actually used in `buffer'. */ 00306 unsigned long used; 00307 00308 /* Syntax setting with which the pattern was compiled. */ 00309 reg_syntax_t syntax; 00310 00311 /* Pointer to a fastmap, if any, otherwise zero. re_search uses 00312 the fastmap, if there is one, to skip over impossible 00313 starting points for matches. */ 00314 char *fastmap; 00315 00316 /* Either a translate table to apply to all characters before 00317 comparing them, or zero for no translation. The translation 00318 is applied to a pattern when it is compiled and to a string 00319 when it is matched. */ 00320 char *translate; 00321 00322 /* Number of subexpressions found by the compiler. */ 00323 size_t re_nsub; 00324 00325 /* Zero if this pattern cannot match the empty string, one else. 00326 Well, in truth it's used only in `re_search_2', to see 00327 whether or not we should use the fastmap, so we don't set 00328 this absolutely perfectly; see `re_compile_fastmap' (the 00329 `duplicate' case). */ 00330 unsigned can_be_null : 1; 00331 00332 /* If REGS_UNALLOCATED, allocate space in the `regs' structure 00333 for `max (RE_NREGS, re_nsub + 1)' groups. 00334 If REGS_REALLOCATE, reallocate space if necessary. 00335 If REGS_FIXED, use what's there. */ 00336 #define REGS_UNALLOCATED 0 00337 #define REGS_REALLOCATE 1 00338 #define REGS_FIXED 2 00339 unsigned regs_allocated : 2; 00340 00341 /* Set to zero when `regex_compile' compiles a pattern; set to one 00342 by `re_compile_fastmap' if it updates the fastmap. */ 00343 unsigned fastmap_accurate : 1; 00344 00345 /* If set, `re_match_2' does not return information about 00346 subexpressions. */ 00347 unsigned no_sub : 1; 00348 00349 /* If set, a beginning-of-line anchor doesn't match at the 00350 beginning of the string. */ 00351 unsigned not_bol : 1; 00352 00353 /* Similarly for an end-of-line anchor. */ 00354 unsigned not_eol : 1; 00355 00356 /* If true, an anchor at a newline matches. */ 00357 unsigned newline_anchor : 1; 00358 00359 /* [[[end pattern_buffer]]] */ 00360 }; 00361 00362 typedef struct re_pattern_buffer regex_t; 00363 00364 00365 /* search.c (search_buffer) in Emacs needs this one opcode value. It is 00366 defined both in `regex.c' and here. */ 00367 #define RE_EXACTN_VALUE 1 00368 00369 /* Type for byte offsets within the string. POSIX mandates this. */ 00370 typedef int regoff_t; 00371 00372 00373 /* This is the structure we store register match data in. See 00374 regex.texinfo for a full description of what registers match. */ 00375 struct re_registers 00376 { 00377 unsigned num_regs; 00378 regoff_t *start; 00379 regoff_t *end; 00380 }; 00381 00382 00383 /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer, 00384 `re_match_2' returns information about at least this many registers 00385 the first time a `regs' structure is passed. */ 00386 #ifndef RE_NREGS 00387 #define RE_NREGS 30 00388 #endif 00389 00390 00391 /* POSIX specification for registers. Aside from the different names than 00392 `re_registers', POSIX uses an array of structures, instead of a 00393 structure of arrays. */ 00394 typedef struct 00395 { 00396 regoff_t rm_so; /* Byte offset from string's start to substring's start. */ 00397 regoff_t rm_eo; /* Byte offset from string's start to substring's end. */ 00398 } regmatch_t; 00399 00400 /* Declarations for routines. */ 00401 00402 /* To avoid duplicating every routine declaration -- once with a 00403 prototype (if we are ANSI), and once without (if we aren't) -- we 00404 use the following macro to declare argument types. This 00405 unfortunately clutters up the declarations a bit, but I think it's 00406 worth it. */ 00407 00408 #if __STDC__ || defined(__cplusplus) 00409 00410 #define _RE_ARGS(args) args 00411 00412 #else /* not __STDC__ */ 00413 00414 #define _RE_ARGS(args) () 00415 00416 #endif /* not __STDC__ */ 00417 00418 /* Sets the current default syntax to SYNTAX, and return the old syntax. 00419 You can also simply assign to the `re_syntax_options' variable. */ 00420 extern reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax)); 00421 00422 /* Compile the regular expression PATTERN, with length LENGTH 00423 and syntax given by the global `re_syntax_options', into the buffer 00424 BUFFER. Return NULL if successful, and an error string if not. */ 00425 extern const char *re_compile_pattern 00426 _RE_ARGS ((const char *pattern, int length, 00427 struct re_pattern_buffer *buffer)); 00428 00429 00430 /* Compile a fastmap for the compiled pattern in BUFFER; used to 00431 accelerate searches. Return 0 if successful and -2 if was an 00432 internal error. */ 00433 extern int re_compile_fastmap _RE_ARGS ((struct re_pattern_buffer *buffer)); 00434 00435 00436 /* Search in the string STRING (with length LENGTH) for the pattern 00437 compiled into BUFFER. Start searching at position START, for RANGE 00438 characters. Return the starting position of the match, -1 for no 00439 match, or -2 for an internal error. Also return register 00440 information in REGS (if REGS and BUFFER->no_sub are nonzero). */ 00441 extern int re_search 00442 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string, 00443 int length, int start, int range, struct re_registers *regs)); 00444 00445 00446 /* Like `re_search', but search in the concatenation of STRING1 and 00447 STRING2. Also, stop searching at index START + STOP. */ 00448 extern int re_search_2 00449 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1, 00450 int length1, const char *string2, int length2, 00451 int start, int range, struct re_registers *regs, int stop)); 00452 00453 00454 /* Like `re_search', but return how many characters in STRING the regexp 00455 in BUFFER matched, starting at position START. */ 00456 extern int re_match 00457 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string, 00458 int length, int start, struct re_registers *regs)); 00459 00460 00461 /* Relates to `re_match' as `re_search_2' relates to `re_search'. */ 00462 extern int re_match_2 00463 _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1, 00464 int length1, const char *string2, int length2, 00465 int start, struct re_registers *regs, int stop)); 00466 00467 00468 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and 00469 ENDS. Subsequent matches using BUFFER and REGS will use this memory 00470 for recording register information. STARTS and ENDS must be 00471 allocated with malloc, and must each be at least `NUM_REGS * sizeof 00472 (regoff_t)' bytes long. 00473 00474 If NUM_REGS == 0, then subsequent matches should allocate their own 00475 register data. 00476 00477 Unless this function is called, the first search or match using 00478 PATTERN_BUFFER will allocate its own register data, without 00479 freeing the old data. */ 00480 extern void re_set_registers 00481 _RE_ARGS ((struct re_pattern_buffer *buffer, struct re_registers *regs, 00482 unsigned num_regs, regoff_t *starts, regoff_t *ends)); 00483 00484 /* 4.2 bsd compatibility. */ 00485 extern char *re_comp _RE_ARGS ((const char *)); 00486 extern int re_exec _RE_ARGS ((const char *)); 00487 00488 /* POSIX compatibility. */ 00489 extern int regcomp _RE_ARGS ((regex_t *preg, const char *pattern, int cflags)); 00490 extern int regexec 00491 _RE_ARGS ((const regex_t *preg, const char *string, size_t nmatch, 00492 regmatch_t pmatch[], int eflags)); 00493 extern int regexec1 00494 _RE_ARGS ((const regex_t *preg, const char *string, int stringLen, size_t nmatch, 00495 regmatch_t pmatch[], int eflags)); 00496 extern size_t regerror 00497 _RE_ARGS ((int errcode, const regex_t *preg, char *errbuf, 00498 size_t errbuf_size)); 00499 extern void regfree _RE_ARGS ((regex_t *preg)); 00500 00501 #endif /* not __REGEXP_LIBRARY_H__ */ 00502 00503 /* 00504 Local variables: 00505 make-backup-files: t 00506 version-control: t 00507 trim-versions-without-asking: nil 00508 End: 00509 */ 00510 #ifdef __cplusplus 00511 }; 00512 #endif 00513