posix/regex.h

   1 /* Definitions for data structures and routines for the regular
   2    expression library, version 0.12.
   3    Copyright (C) 1985,89,90,91,92,93,95,96,97 Free Software Foundation, Inc.
   4
   5    This file is part of the GNU C Library.  Its master source is NOT part of
   6    the C library, however.  The master source lives in /gd/gnu/lib.
   7
   8    The GNU C Library is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU Library General Public License as
  10    published by the Free Software Foundation; either version 2 of the
  11    License, or (at your option) any later version.
  12
  13    The GNU C Library is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    Library General Public License for more details.
  17
  18    You should have received a copy of the GNU Library General Public
  19    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  20    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21    Boston, MA 02111-1307, USA.  */
  22
  23 #ifndef __REGEXP_LIBRARY_H__
  24 #define __REGEXP_LIBRARY_H__
  25
  26 /* Allow the use in C++ code.  */
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /* POSIX says that <sys/types.h> must be included (by the caller) before
  32    <regex.h>.  */
  33
  34 #if !defined (_POSIX_C_SOURCE) && !defined (_POSIX_SOURCE) && defined (VMS)
  35 /* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it
  36    should be there.  */
  37 #include <stddef.h>
  38 #endif
  39
  40 /* The following bits are used to determine the regexp syntax we
  41    recognize.  The set/not-set meanings are chosen so that Emacs syntax
  42    remains the value 0.  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 reg_syntax_t;
  46
  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 (1)
  50
  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)
  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
  68            before a close-group or an alternation operator.
  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
  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)
  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
 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)
 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
 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)
 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
 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
 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)
 143
 144 /* This global variable defines the particular regexp syntax to use (for
 145    some interfaces).  When a regexp is compiled, the syntax used is
 146    stored in the pattern buffer, so changing this does not affect
 147    already-compiled regexps.  */
 148 extern reg_syntax_t re_syntax_options;
 149 \f
 150 /* Define combinations of the above bits for the standard possibilities.
 151    (The [[[ comments delimit what gets put into the Texinfo file, so
 152    don't delete them!)  */
 153 /* [[[begin syntaxes]]] */
 154 #define RE_SYNTAX_EMACS 0
 155
 156 #define RE_SYNTAX_AWK                                                   \
 157   (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL                       \
 158    | RE_NO_BK_PARENS            | RE_NO_BK_REFS                         \
 159    | RE_NO_BK_VBAR               | RE_NO_EMPTY_RANGES                   \
 160    | RE_UNMATCHED_RIGHT_PAREN_ORD)
 161
 162 #define RE_SYNTAX_POSIX_AWK                                             \
 163   (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS)
 164
 165 #define RE_SYNTAX_GREP                                                  \
 166   (RE_BK_PLUS_QM              | RE_CHAR_CLASSES                         \
 167    | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS                            \
 168    | RE_NEWLINE_ALT)
 169
 170 #define RE_SYNTAX_EGREP                                                 \
 171   (RE_CHAR_CLASSES        | RE_CONTEXT_INDEP_ANCHORS                    \
 172    | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE                    \
 173    | RE_NEWLINE_ALT       | RE_NO_BK_PARENS                             \
 174    | RE_NO_BK_VBAR)
 175
 176 #define RE_SYNTAX_POSIX_EGREP                                           \
 177   (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)
 178
 179 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff.  */
 180 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
 181
 182 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
 183
 184 /* Syntax bits common to both basic and extended POSIX regex syntax.  */
 185 #define _RE_SYNTAX_POSIX_COMMON                                         \
 186   (RE_CHAR_CLASSES | RE_DOT_NEWLINE      | RE_DOT_NOT_NULL              \
 187    | RE_INTERVALS  | RE_NO_EMPTY_RANGES)
 188
 189 #define RE_SYNTAX_POSIX_BASIC                                           \
 190   (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
 191
 192 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes
 193    RE_LIMITED_OPS, i.e., \? \+ \| are not recognized.  Actually, this
 194    isn't minimal, since other operators, such as \`, aren't disabled.  */
 195 #define RE_SYNTAX_POSIX_MINIMAL_BASIC                                   \
 196   (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)
 197
 198 #define RE_SYNTAX_POSIX_EXTENDED                                        \
 199   (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS                   \
 200    | RE_CONTEXT_INDEP_OPS  | RE_NO_BK_BRACES                            \
 201    | RE_NO_BK_PARENS       | RE_NO_BK_VBAR                              \
 202    | RE_UNMATCHED_RIGHT_PAREN_ORD)
 203
 204 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS
 205    replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added.  */
 206 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED                                \
 207   (_RE_SYNTAX_POSIX_COMMON  | RE_CONTEXT_INDEP_ANCHORS                  \
 208    | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES                           \
 209    | RE_NO_BK_PARENS        | RE_NO_BK_REFS                             \
 210    | RE_NO_BK_VBAR          | RE_UNMATCHED_RIGHT_PAREN_ORD)
 211 /* [[[end syntaxes]]] */
 212 \f
 213 /* Maximum number of duplicates an interval can allow.  Some systems
 214    (erroneously) define this in other header files, but we want our
 215    value, so remove any previous define.  */
 216 #ifdef RE_DUP_MAX
 217 #undef RE_DUP_MAX
 218 #endif
 219 #define RE_DUP_MAX ((1 << 15) - 1)
 220
 221
 222 /* POSIX `cflags' bits (i.e., information for `regcomp').  */
 223
 224 /* If this bit is set, then use extended regular expression syntax.
 225    If not set, then use basic regular expression syntax.  */
 226 #define REG_EXTENDED 1
 227
 228 /* If this bit is set, then ignore case when matching.
 229    If not set, then case is significant.  */
 230 #define REG_ICASE (REG_EXTENDED << 1)
 231
 232 /* If this bit is set, then anchors do not match at newline
 233      characters in the string.
 234    If not set, then anchors do match at newlines.  */
 235 #define REG_NEWLINE (REG_ICASE << 1)
 236
 237 /* If this bit is set, then report only success or fail in regexec.
 238    If not set, then returns differ between not matching and errors.  */
 239 #define REG_NOSUB (REG_NEWLINE << 1)
 240
 241
 242 /* POSIX `eflags' bits (i.e., information for regexec).  */
 243
 244 /* If this bit is set, then the beginning-of-line operator doesn't match
 245      the beginning of the string (presumably because it's not the
 246      beginning of a line).
 247    If not set, then the beginning-of-line operator does match the
 248      beginning of the string.  */
 249 #define REG_NOTBOL 1
 250
 251 /* Like REG_NOTBOL, except for the end-of-line.  */
 252 #define REG_NOTEOL (1 << 1)
 253
 254
 255 /* If any error codes are removed, changed, or added, update the
 256    `re_error_msg' table in regex.c.  */
 257 typedef enum
 258 {
 259   REG_NOERROR = 0,      /* Success.  */
 260   REG_NOMATCH,          /* Didn't find a match (for regexec).  */
 261
 262   /* POSIX regcomp return error codes.  (In the order listed in the
 263      standard.)  */
 264   REG_BADPAT,           /* Invalid pattern.  */
 265   REG_ECOLLATE,         /* Not implemented.  */
 266   REG_ECTYPE,           /* Invalid character class name.  */
 267   REG_EESCAPE,          /* Trailing backslash.  */
 268   REG_ESUBREG,          /* Invalid back reference.  */
 269   REG_EBRACK,           /* Unmatched left bracket.  */
 270   REG_EPAREN,           /* Parenthesis imbalance.  */
 271   REG_EBRACE,           /* Unmatched \{.  */
 272   REG_BADBR,            /* Invalid contents of \{\}.  */
 273   REG_ERANGE,           /* Invalid range end.  */
 274   REG_ESPACE,           /* Ran out of memory.  */
 275   REG_BADRPT,           /* No preceding re for repetition op.  */
 276
 277   /* Error codes we've added.  */
 278   REG_EEND,             /* Premature end.  */
 279   REG_ESIZE,            /* Compiled pattern bigger than 2^16 bytes.  */
 280   REG_ERPAREN           /* Unmatched ) or \); not returned from regcomp.  */
 281 } reg_errcode_t;
 282 \f
 283 /* This data structure represents a compiled pattern.  Before calling
 284    the pattern compiler, the fields `buffer', `allocated', `fastmap',
 285    `translate', and `no_sub' can be set.  After the pattern has been
 286    compiled, the `re_nsub' field is available.  All other fields are
 287    private to the regex routines.  */
 288
 289 #ifndef RE_TRANSLATE_TYPE
 290 #define RE_TRANSLATE_TYPE char *
 291 #endif
 292
 293 struct re_pattern_buffer
 294 {
 295 /* [[[begin pattern_buffer]]] */
 296         /* Space that holds the compiled pattern.  It is declared as
 297           `unsigned char *' because its elements are
 298            sometimes used as array indexes.  */
 299   unsigned char *buffer;
 300
 301         /* Number of bytes to which `buffer' points.  */
 302   unsigned long allocated;
 303
 304         /* Number of bytes actually used in `buffer'.  */
 305   unsigned long used;
 306
 307         /* Syntax setting with which the pattern was compiled.  */
 308   reg_syntax_t syntax;
 309
 310         /* Pointer to a fastmap, if any, otherwise zero.  re_search uses
 311            the fastmap, if there is one, to skip over impossible
 312            starting points for matches.  */
 313   char *fastmap;
 314
 315         /* Either a translate table to apply to all characters before
 316            comparing them, or zero for no translation.  The translation
 317            is applied to a pattern when it is compiled and to a string
 318            when it is matched.  */
 319   RE_TRANSLATE_TYPE translate;
 320
 321         /* Number of subexpressions found by the compiler.  */
 322   size_t re_nsub;
 323
 324         /* Zero if this pattern cannot match the empty string, one else.
 325            Well, in truth it's used only in `re_search_2', to see
 326            whether or not we should use the fastmap, so we don't set
 327            this absolutely perfectly; see `re_compile_fastmap' (the
 328            `duplicate' case).  */
 329   unsigned can_be_null : 1;
 330
 331         /* If REGS_UNALLOCATED, allocate space in the `regs' structure
 332              for `max (RE_NREGS, re_nsub + 1)' groups.
 333            If REGS_REALLOCATE, reallocate space if necessary.
 334            If REGS_FIXED, use what's there.  */
 335 #define REGS_UNALLOCATED 0
 336 #define REGS_REALLOCATE 1
 337 #define REGS_FIXED 2
 338   unsigned regs_allocated : 2;
 339
 340         /* Set to zero when `regex_compile' compiles a pattern; set to one
 341            by `re_compile_fastmap' if it updates the fastmap.  */
 342   unsigned fastmap_accurate : 1;
 343
 344         /* If set, `re_match_2' does not return information about
 345            subexpressions.  */
 346   unsigned no_sub : 1;
 347
 348         /* If set, a beginning-of-line anchor doesn't match at the
 349            beginning of the string.  */
 350   unsigned not_bol : 1;
 351
 352         /* Similarly for an end-of-line anchor.  */
 353   unsigned not_eol : 1;
 354
 355         /* If true, an anchor at a newline matches.  */
 356   unsigned newline_anchor : 1;
 357
 358 /* [[[end pattern_buffer]]] */
 359 };
 360
 361 typedef struct re_pattern_buffer regex_t;
 362 \f
 363 /* Type for byte offsets within the string.  POSIX mandates this.  */
 364 typedef int regoff_t;
 365
 366
 367 /* This is the structure we store register match data in.  See
 368    regex.texinfo for a full description of what registers match.  */
 369 struct re_registers
 370 {
 371   unsigned num_regs;
 372   regoff_t *start;
 373   regoff_t *end;
 374 };
 375
 376
 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.  */
 380 #ifndef RE_NREGS
 381 #define RE_NREGS 30
 382 #endif
 383
 384
 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.  */
 388 typedef struct
 389 {
 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.  */
 392 } regmatch_t;
 393 \f
 394 /* Declarations for routines.  */
 395
 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
 400    worth it.  */
 401
 402 #if __STDC__
 403
 404 #define _RE_ARGS(args) args
 405
 406 #else /* not __STDC__ */
 407
 408 #define _RE_ARGS(args) ()
 409
 410 #endif /* not __STDC__ */
 411
 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));
 415
 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));
 422
 423
 424 /* Compile a fastmap for the compiled pattern in BUFFER; used to
 425    accelerate searches.  Return 0 if successful and -2 if was an
 426    internal error.  */
 427 extern int re_compile_fastmap _RE_ARGS ((struct re_pattern_buffer *buffer));
 428
 429
 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).  */
 435 extern int re_search
 436   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
 437             int length, int start, int range, struct re_registers *regs));
 438
 439
 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));
 446
 447
 448 /* Like `re_search', but return how many characters in STRING the regexp
 449    in BUFFER matched, starting at position START.  */
 450 extern int re_match
 451   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
 452              int length, int start, struct re_registers *regs));
 453
 454
 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));
 460
 461
 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.
 467
 468    If NUM_REGS == 0, then subsequent matches should allocate their own
 469    register data.
 470
 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));
 477
 478 #ifdef _REGEX_RE_COMP
 479 /* 4.2 bsd compatibility.  */
 480 extern char *re_comp _RE_ARGS ((const char *));
 481 extern int re_exec _RE_ARGS ((const char *));
 482 #endif
 483
 484 /* POSIX compatibility.  */
 485 extern int regcomp _RE_ARGS ((regex_t *preg, const char *pattern, int cflags));
 486 extern int regexec
 487   _RE_ARGS ((const regex_t *preg, const char *string, size_t nmatch,
 488              regmatch_t pmatch[], int eflags));
 489 extern size_t regerror
 490   _RE_ARGS ((int errcode, const regex_t *preg, char *errbuf,
 491              size_t errbuf_size));
 492 extern void regfree _RE_ARGS ((regex_t *preg));
 493
 494
 495 #ifdef __cplusplus
 496 }
 497 #endif  /* C++ */
 498
 499 #endif /* not __REGEXP_LIBRARY_H__ */
 500 \f
 501 /*
 502 Local variables:
 503 make-backup-files: t
 504 version-control: t
 505 trim-versions-without-asking: nil
 506 End:
 507 */