posix/regex.h

   1 /* Definitions for data structures and routines for the regular
   2    expression library.
   3    Copyright (C) 1985,1989-93,1995-98,2000,2001,2002,2003,2005,2006,2008
   4    Free Software Foundation, Inc.
   5    This file is part of the GNU C Library.
   6
   7    The GNU C Library is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU Lesser General Public
   9    License as published by the Free Software Foundation; either
  10    version 2.1 of the License, or (at your option) any later version.
  11
  12    The GNU C Library 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 GNU
  15    Lesser General Public License for more details.
  16
  17    You should have received a copy of the GNU Lesser General Public
  18    License along with the GNU C Library; if not, write to the Free
  19    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  20    02111-1307 USA.  */
  21
  22 #ifndef _REGEX_H
  23 #define _REGEX_H 1
  24
  25 #include <sys/types.h>
  26 #include <gnu/option-groups.h>
  27
  28 /* Allow the use in C++ code.  */
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* The following two types have to be signed and unsigned integer type
  34    wide enough to hold a value of a pointer.  For most ANSI compilers
  35    ptrdiff_t and size_t should be likely OK.  Still size of these two
  36    types is 2 for Microsoft C.  Ugh... */
  37 typedef long int s_reg_t;
  38 typedef unsigned long int active_reg_t;
  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 long int reg_syntax_t;
  46
  47 #ifdef __USE_GNU
  48 /* If this bit is not set, then \ inside a bracket expression is literal.
  49    If set, then such a \ quotes the following character.  */
  50 # define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1)
  51
  52 /* If this bit is not set, then + and ? are operators, and \+ and \? are
  53      literals.
  54    If set, then \+ and \? are operators and + and ? are literals.  */
  55 # define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
  56
  57 /* If this bit is set, then character classes are supported.  They are:
  58      [:alpha:], [:upper:], [:lower:],  [:digit:], [:alnum:], [:xdigit:],
  59      [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
  60    If not set, then character classes are not supported.  */
  61 # define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
  62
  63 /* If this bit is set, then ^ and $ are always anchors (outside bracket
  64      expressions, of course).
  65    If this bit is not set, then it depends:
  66         ^  is an anchor if it is at the beginning of a regular
  67            expression or after an open-group or an alternation operator;
  68         $  is an anchor if it is at the end of a regular expression, or
  69            before a close-group or an alternation operator.
  70
  71    This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
  72    POSIX draft 11.2 says that * etc. in leading positions is undefined.
  73    We already implemented a previous draft which made those constructs
  74    invalid, though, so we haven't changed the code back.  */
  75 # define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
  76
  77 /* If this bit is set, then special characters are always special
  78      regardless of where they are in the pattern.
  79    If this bit is not set, then special characters are special only in
  80      some contexts; otherwise they are ordinary.  Specifically,
  81      * + ? and intervals are only special when not after the beginning,
  82      open-group, or alternation operator.  */
  83 # define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
  84
  85 /* If this bit is set, then *, +, ?, and { cannot be first in an re or
  86      immediately after an alternation or begin-group operator.  */
  87 # define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
  88
  89 /* If this bit is set, then . matches newline.
  90    If not set, then it doesn't.  */
  91 # define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
  92
  93 /* If this bit is set, then . doesn't match NUL.
  94    If not set, then it does.  */
  95 # define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
  96
  97 /* If this bit is set, nonmatching lists [^...] do not match newline.
  98    If not set, they do.  */
  99 # define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
 100
 101 /* If this bit is set, either \{...\} or {...} defines an
 102      interval, depending on RE_NO_BK_BRACES.
 103    If not set, \{, \}, {, and } are literals.  */
 104 # define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
 105
 106 /* If this bit is set, +, ? and | aren't recognized as operators.
 107    If not set, they are.  */
 108 # define RE_LIMITED_OPS (RE_INTERVALS << 1)
 109
 110 /* If this bit is set, newline is an alternation operator.
 111    If not set, newline is literal.  */
 112 # define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
 113
 114 /* If this bit is set, then `{...}' defines an interval, and \{ and \}
 115      are literals.
 116   If not set, then `\{...\}' defines an interval.  */
 117 # define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)
 118
 119 /* If this bit is set, (...) defines a group, and \( and \) are literals.
 120    If not set, \(...\) defines a group, and ( and ) are literals.  */
 121 # define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
 122
 123 /* If this bit is set, then \<digit> matches <digit>.
 124    If not set, then \<digit> is a back-reference.  */
 125 # define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
 126
 127 /* If this bit is set, then | is an alternation operator, and \| is literal.
 128    If not set, then \| is an alternation operator, and | is literal.  */
 129 # define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
 130
 131 /* If this bit is set, then an ending range point collating higher
 132      than the starting range point, as in [z-a], is invalid.
 133    If not set, then when ending range point collates higher than the
 134      starting range point, the range is ignored.  */
 135 # define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)
 136
 137 /* If this bit is set, then an unmatched ) is ordinary.
 138    If not set, then an unmatched ) is invalid.  */
 139 # define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)
 140
 141 /* If this bit is set, succeed as soon as we match the whole pattern,
 142    without further backtracking.  */
 143 # define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1)
 144
 145 /* If this bit is set, do not process the GNU regex operators.
 146    If not set, then the GNU regex operators are recognized. */
 147 # define RE_NO_GNU_OPS (RE_NO_POSIX_BACKTRACKING << 1)
 148
 149 /* If this bit is set, turn on internal regex debugging.
 150    If not set, and debugging was on, turn it off.
 151    This only works if regex.c is compiled -DDEBUG.
 152    We define this bit always, so that all that's needed to turn on
 153    debugging is to recompile regex.c; the calling code can always have
 154    this bit set, and it won't affect anything in the normal case. */
 155 # define RE_DEBUG (RE_NO_GNU_OPS << 1)
 156
 157 /* If this bit is set, a syntactically invalid interval is treated as
 158    a string of ordinary characters.  For example, the ERE 'a{1' is
 159    treated as 'a\{1'.  */
 160 # define RE_INVALID_INTERVAL_ORD (RE_DEBUG << 1)
 161
 162 /* EGLIBC: Old regex implementation does not support these.  */
 163 # ifdef __OPTION_POSIX_REGEXP_GLIBC
 164 /* If this bit is set, then ignore case when matching.
 165    If not set, then case is significant.  */
 166 # define RE_ICASE (RE_INVALID_INTERVAL_ORD << 1)
 167
 168 /* This bit is used internally like RE_CONTEXT_INDEP_ANCHORS but only
 169    for ^, because it is difficult to scan the regex backwards to find
 170    whether ^ should be special.  */
 171 # define RE_CARET_ANCHORS_HERE (RE_ICASE << 1)
 172
 173 /* If this bit is set, then \{ cannot be first in an bre or
 174    immediately after an alternation or begin-group operator.  */
 175 # define RE_CONTEXT_INVALID_DUP (RE_CARET_ANCHORS_HERE << 1)
 176
 177 /* If this bit is set, then no_sub will be set to 1 during
 178    re_compile_pattern.  */
 179 # define RE_NO_SUB (RE_CONTEXT_INVALID_DUP << 1)
 180 # endif /* __OPTION_POSIX_REGEXP_GLIBC */
 181 #endif
 182
 183 /* This global variable defines the particular regexp syntax to use (for
 184    some interfaces).  When a regexp is compiled, the syntax used is
 185    stored in the pattern buffer, so changing this does not affect
 186    already-compiled regexps.  */
 187 extern reg_syntax_t re_syntax_options;
 188 \f
 189 #ifdef __USE_GNU
 190 /* Define combinations of the above bits for the standard possibilities.
 191    (The [[[ comments delimit what gets put into the Texinfo file, so
 192    don't delete them!)  */
 193 /* [[[begin syntaxes]]] */
 194 #define RE_SYNTAX_EMACS 0
 195
 196 #define RE_SYNTAX_AWK                                                   \
 197   (RE_BACKSLASH_ESCAPE_IN_LISTS   | RE_DOT_NOT_NULL                     \
 198    | RE_NO_BK_PARENS              | RE_NO_BK_REFS                       \
 199    | RE_NO_BK_VBAR                | RE_NO_EMPTY_RANGES                  \
 200    | RE_DOT_NEWLINE               | RE_CONTEXT_INDEP_ANCHORS            \
 201    | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS)
 202
 203 #define RE_SYNTAX_GNU_AWK                                               \
 204   ((RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DEBUG) \
 205    & ~(RE_DOT_NOT_NULL | RE_INTERVALS | RE_CONTEXT_INDEP_OPS            \
 206        | RE_CONTEXT_INVALID_OPS ))
 207
 208 #define RE_SYNTAX_POSIX_AWK                                             \
 209   (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS              \
 210    | RE_INTERVALS           | RE_NO_GNU_OPS)
 211
 212 #define RE_SYNTAX_GREP                                                  \
 213   (RE_BK_PLUS_QM              | RE_CHAR_CLASSES                         \
 214    | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS                            \
 215    | RE_NEWLINE_ALT)
 216
 217 #define RE_SYNTAX_EGREP                                                 \
 218   (RE_CHAR_CLASSES        | RE_CONTEXT_INDEP_ANCHORS                    \
 219    | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE                    \
 220    | RE_NEWLINE_ALT       | RE_NO_BK_PARENS                             \
 221    | RE_NO_BK_VBAR)
 222
 223 #define RE_SYNTAX_POSIX_EGREP                                           \
 224   (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES                     \
 225    | RE_INVALID_INTERVAL_ORD)
 226
 227 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff.  */
 228 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
 229
 230 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
 231
 232 /* Syntax bits common to both basic and extended POSIX regex syntax.  */
 233 #define _RE_SYNTAX_POSIX_COMMON                                         \
 234   (RE_CHAR_CLASSES | RE_DOT_NEWLINE      | RE_DOT_NOT_NULL              \
 235    | RE_INTERVALS  | RE_NO_EMPTY_RANGES)
 236
 237 #ifdef __OPTION_POSIX_REGEXP_GLIBC
 238 #define RE_SYNTAX_POSIX_BASIC                                           \
 239   (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM | RE_CONTEXT_INVALID_DUP)
 240 #else
 241 #define RE_SYNTAX_POSIX_BASIC                                           \
 242   (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
 243 #endif
 244
 245 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes
 246    RE_LIMITED_OPS, i.e., \? \+ \| are not recognized.  Actually, this
 247    isn't minimal, since other operators, such as \`, aren't disabled.  */
 248 #define RE_SYNTAX_POSIX_MINIMAL_BASIC                                   \
 249   (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)
 250
 251 #define RE_SYNTAX_POSIX_EXTENDED                                        \
 252   (_RE_SYNTAX_POSIX_COMMON  | RE_CONTEXT_INDEP_ANCHORS                  \
 253    | RE_CONTEXT_INDEP_OPS   | RE_NO_BK_BRACES                           \
 254    | RE_NO_BK_PARENS        | RE_NO_BK_VBAR                             \
 255    | RE_CONTEXT_INVALID_OPS | RE_UNMATCHED_RIGHT_PAREN_ORD)
 256
 257 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INDEP_OPS is
 258    removed and RE_NO_BK_REFS is added.  */
 259 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED                                \
 260   (_RE_SYNTAX_POSIX_COMMON  | RE_CONTEXT_INDEP_ANCHORS                  \
 261    | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES                           \
 262    | RE_NO_BK_PARENS        | RE_NO_BK_REFS                             \
 263    | RE_NO_BK_VBAR          | RE_UNMATCHED_RIGHT_PAREN_ORD)
 264 /* [[[end syntaxes]]] */
 265 \f
 266 /* Maximum number of duplicates an interval can allow.  Some systems
 267    (erroneously) define this in other header files, but we want our
 268    value, so remove any previous define.  */
 269 # ifdef RE_DUP_MAX
 270 #  undef RE_DUP_MAX
 271 # endif
 272 /* If sizeof(int) == 2, then ((1 << 15) - 1) overflows.  */
 273 # define RE_DUP_MAX (0x7fff)
 274 #endif
 275
 276
 277 /* POSIX `cflags' bits (i.e., information for `regcomp').  */
 278
 279 /* If this bit is set, then use extended regular expression syntax.
 280    If not set, then use basic regular expression syntax.  */
 281 #define REG_EXTENDED 1
 282
 283 /* If this bit is set, then ignore case when matching.
 284    If not set, then case is significant.  */
 285 #define REG_ICASE (REG_EXTENDED << 1)
 286
 287 /* If this bit is set, then anchors do not match at newline
 288      characters in the string.
 289    If not set, then anchors do match at newlines.  */
 290 #define REG_NEWLINE (REG_ICASE << 1)
 291
 292 /* If this bit is set, then report only success or fail in regexec.
 293    If not set, then returns differ between not matching and errors.  */
 294 #define REG_NOSUB (REG_NEWLINE << 1)
 295
 296
 297 /* POSIX `eflags' bits (i.e., information for regexec).  */
 298
 299 /* If this bit is set, then the beginning-of-line operator doesn't match
 300      the beginning of the string (presumably because it's not the
 301      beginning of a line).
 302    If not set, then the beginning-of-line operator does match the
 303      beginning of the string.  */
 304 #define REG_NOTBOL 1
 305
 306 /* Like REG_NOTBOL, except for the end-of-line.  */
 307 #define REG_NOTEOL (1 << 1)
 308
 309 #ifdef __OPTION_POSIX_REGEXP_GLIBC
 310 /* Use PMATCH[0] to delimit the start and end of the search in the
 311    buffer.  */
 312 #define REG_STARTEND (1 << 2)
 313 #endif
 314
 315
 316 /* If any error codes are removed, changed, or added, update the
 317    `re_error_msg' table in regex.c.  */
 318 typedef enum
 319 {
 320 #if defined _XOPEN_SOURCE || defined __USE_XOPEN2K
 321   REG_ENOSYS = -1,      /* This will never happen for this implementation.  */
 322 #endif
 323
 324   REG_NOERROR = 0,      /* Success.  */
 325   REG_NOMATCH,          /* Didn't find a match (for regexec).  */
 326
 327   /* POSIX regcomp return error codes.  (In the order listed in the
 328      standard.)  */
 329   REG_BADPAT,           /* Invalid pattern.  */
 330   REG_ECOLLATE,         /* Inalid collating element.  */
 331   REG_ECTYPE,           /* Invalid character class name.  */
 332   REG_EESCAPE,          /* Trailing backslash.  */
 333   REG_ESUBREG,          /* Invalid back reference.  */
 334   REG_EBRACK,           /* Unmatched left bracket.  */
 335   REG_EPAREN,           /* Parenthesis imbalance.  */
 336   REG_EBRACE,           /* Unmatched \{.  */
 337   REG_BADBR,            /* Invalid contents of \{\}.  */
 338   REG_ERANGE,           /* Invalid range end.  */
 339   REG_ESPACE,           /* Ran out of memory.  */
 340   REG_BADRPT,           /* No preceding re for repetition op.  */
 341
 342   /* Error codes we've added.  */
 343   REG_EEND,             /* Premature end.  */
 344   REG_ESIZE,            /* Compiled pattern bigger than 2^16 bytes.  */
 345   REG_ERPAREN           /* Unmatched ) or \); not returned from regcomp.  */
 346 } reg_errcode_t;
 347 \f
 348 /* This data structure represents a compiled pattern.  Before calling
 349    the pattern compiler, the fields `buffer', `allocated', `fastmap',
 350    `translate', and `no_sub' can be set.  After the pattern has been
 351    compiled, the `re_nsub' field is available.  All other fields are
 352    private to the regex routines.  */
 353
 354 #ifndef RE_TRANSLATE_TYPE
 355 # define __RE_TRANSLATE_TYPE unsigned char *
 356 # ifdef __USE_GNU
 357 #  define RE_TRANSLATE_TYPE __RE_TRANSLATE_TYPE
 358 # endif
 359 #endif
 360
 361 #ifdef __USE_GNU
 362 # define __REPB_PREFIX(name) name
 363 #else
 364 # define __REPB_PREFIX(name) __##name
 365 #endif
 366
 367 struct re_pattern_buffer
 368 {
 369   /* Space that holds the compiled pattern.  It is declared as
 370      `unsigned char *' because its elements are sometimes used as
 371      array indexes.  */
 372   unsigned char *__REPB_PREFIX(buffer);
 373
 374   /* Number of bytes to which `buffer' points.  */
 375   unsigned long int __REPB_PREFIX(allocated);
 376
 377   /* Number of bytes actually used in `buffer'.  */
 378   unsigned long int __REPB_PREFIX(used);
 379
 380   /* Syntax setting with which the pattern was compiled.  */
 381   reg_syntax_t __REPB_PREFIX(syntax);
 382
 383   /* Pointer to a fastmap, if any, otherwise zero.  re_search uses the
 384      fastmap, if there is one, to skip over impossible starting points
 385      for matches.  */
 386   char *__REPB_PREFIX(fastmap);
 387
 388   /* Either a translate table to apply to all characters before
 389      comparing them, or zero for no translation.  The translation is
 390      applied to a pattern when it is compiled and to a string when it
 391      is matched.  */
 392   __RE_TRANSLATE_TYPE __REPB_PREFIX(translate);
 393
 394   /* Number of subexpressions found by the compiler.  */
 395   size_t re_nsub;
 396
 397   /* Zero if this pattern cannot match the empty string, one else.
 398      Well, in truth it's used only in `re_search_2', to see whether or
 399      not we should use the fastmap, so we don't set this absolutely
 400      perfectly; see `re_compile_fastmap' (the `duplicate' case).  */
 401   unsigned __REPB_PREFIX(can_be_null) : 1;
 402
 403   /* If REGS_UNALLOCATED, allocate space in the `regs' structure
 404      for `max (RE_NREGS, re_nsub + 1)' groups.
 405      If REGS_REALLOCATE, reallocate space if necessary.
 406      If REGS_FIXED, use what's there.  */
 407 #ifdef __USE_GNU
 408 # define REGS_UNALLOCATED 0
 409 # define REGS_REALLOCATE 1
 410 # define REGS_FIXED 2
 411 #endif
 412   unsigned __REPB_PREFIX(regs_allocated) : 2;
 413
 414   /* Set to zero when `regex_compile' compiles a pattern; set to one
 415      by `re_compile_fastmap' if it updates the fastmap.  */
 416   unsigned __REPB_PREFIX(fastmap_accurate) : 1;
 417
 418   /* If set, `re_match_2' does not return information about
 419      subexpressions.  */
 420   unsigned __REPB_PREFIX(no_sub) : 1;
 421
 422   /* If set, a beginning-of-line anchor doesn't match at the beginning
 423      of the string.  */
 424   unsigned __REPB_PREFIX(not_bol) : 1;
 425
 426   /* Similarly for an end-of-line anchor.  */
 427   unsigned __REPB_PREFIX(not_eol) : 1;
 428
 429   /* If true, an anchor at a newline matches.  */
 430   unsigned __REPB_PREFIX(newline_anchor) : 1;
 431 };
 432
 433 typedef struct re_pattern_buffer regex_t;
 434 \f
 435 /* Type for byte offsets within the string.  POSIX mandates this.  */
 436 typedef int regoff_t;
 437
 438
 439 #ifdef __USE_GNU
 440 /* This is the structure we store register match data in.  See
 441    regex.texinfo for a full description of what registers match.  */
 442 struct re_registers
 443 {
 444   unsigned num_regs;
 445   regoff_t *start;
 446   regoff_t *end;
 447 };
 448
 449
 450 /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
 451    `re_match_2' returns information about at least this many registers
 452    the first time a `regs' structure is passed.  */
 453 # ifndef RE_NREGS
 454 #  define RE_NREGS 30
 455 # endif
 456 #endif
 457
 458
 459 /* POSIX specification for registers.  Aside from the different names than
 460    `re_registers', POSIX uses an array of structures, instead of a
 461    structure of arrays.  */
 462 typedef struct
 463 {
 464   regoff_t rm_so;  /* Byte offset from string's start to substring's start.  */
 465   regoff_t rm_eo;  /* Byte offset from string's start to substring's end.  */
 466 } regmatch_t;
 467 \f
 468 /* Declarations for routines.  */
 469
 470 #ifdef __USE_GNU
 471 /* Sets the current default syntax to SYNTAX, and return the old syntax.
 472    You can also simply assign to the `re_syntax_options' variable.  */
 473 extern reg_syntax_t re_set_syntax (reg_syntax_t __syntax);
 474
 475 /* Compile the regular expression PATTERN, with length LENGTH
 476    and syntax given by the global `re_syntax_options', into the buffer
 477    BUFFER.  Return NULL if successful, and an error string if not.  */
 478 extern const char *re_compile_pattern (const char *__pattern, size_t __length,
 479                                        struct re_pattern_buffer *__buffer);
 480
 481
 482 /* Compile a fastmap for the compiled pattern in BUFFER; used to
 483    accelerate searches.  Return 0 if successful and -2 if was an
 484    internal error.  */
 485 extern int re_compile_fastmap (struct re_pattern_buffer *__buffer);
 486
 487
 488 /* Search in the string STRING (with length LENGTH) for the pattern
 489    compiled into BUFFER.  Start searching at position START, for RANGE
 490    characters.  Return the starting position of the match, -1 for no
 491    match, or -2 for an internal error.  Also return register
 492    information in REGS (if REGS and BUFFER->no_sub are nonzero).  */
 493 extern int re_search (struct re_pattern_buffer *__buffer, const char *__string,
 494                       int __length, int __start, int __range,
 495                       struct re_registers *__regs);
 496
 497
 498 /* Like `re_search', but search in the concatenation of STRING1 and
 499    STRING2.  Also, stop searching at index START + STOP.  */
 500 extern int re_search_2 (struct re_pattern_buffer *__buffer,
 501                         const char *__string1, int __length1,
 502                         const char *__string2, int __length2, int __start,
 503                         int __range, struct re_registers *__regs, int __stop);
 504
 505
 506 /* Like `re_search', but return how many characters in STRING the regexp
 507    in BUFFER matched, starting at position START.  */
 508 extern int re_match (struct re_pattern_buffer *__buffer, const char *__string,
 509                      int __length, int __start, struct re_registers *__regs);
 510
 511
 512 /* Relates to `re_match' as `re_search_2' relates to `re_search'.  */
 513 extern int re_match_2 (struct re_pattern_buffer *__buffer,
 514                        const char *__string1, int __length1,
 515                        const char *__string2, int __length2, int __start,
 516                        struct re_registers *__regs, int __stop);
 517
 518
 519 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
 520    ENDS.  Subsequent matches using BUFFER and REGS will use this memory
 521    for recording register information.  STARTS and ENDS must be
 522    allocated with malloc, and must each be at least `NUM_REGS * sizeof
 523    (regoff_t)' bytes long.
 524
 525    If NUM_REGS == 0, then subsequent matches should allocate their own
 526    register data.
 527
 528    Unless this function is called, the first search or match using
 529    PATTERN_BUFFER will allocate its own register data, without
 530    freeing the old data.  */
 531 extern void re_set_registers (struct re_pattern_buffer *__buffer,
 532                               struct re_registers *__regs,
 533                               unsigned int __num_regs,
 534                               regoff_t *__starts, regoff_t *__ends);
 535 #endif  /* Use GNU */
 536
 537 #if defined _REGEX_RE_COMP || (defined _LIBC && defined __USE_BSD)
 538 # ifndef _CRAY
 539 /* 4.2 bsd compatibility.  */
 540 extern char *re_comp (const char *);
 541 extern int re_exec (const char *);
 542 # endif
 543 #endif
 544
 545 /* GCC 2.95 and later have "__restrict"; C99 compilers have
 546    "restrict", and "configure" may have defined "restrict".  */
 547 #ifndef __restrict
 548 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
 549 #  if defined restrict || 199901L <= __STDC_VERSION__
 550 #   define __restrict restrict
 551 #  else
 552 #   define __restrict
 553 #  endif
 554 # endif
 555 #endif
 556 /* gcc 3.1 and up support the [restrict] syntax.  */
 557 #ifndef __restrict_arr
 558 # if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)) \
 559      && !defined __GNUG__
 560 #  define __restrict_arr __restrict
 561 # else
 562 #  define __restrict_arr
 563 # endif
 564 #endif
 565
 566 /* POSIX compatibility.  */
 567 extern int regcomp (regex_t *__restrict __preg,
 568                     const char *__restrict __pattern,
 569                     int __cflags);
 570
 571 extern int regexec (const regex_t *__restrict __preg,
 572                     const char *__restrict __string, size_t __nmatch,
 573                     regmatch_t __pmatch[__restrict_arr],
 574                     int __eflags);
 575
 576 extern size_t regerror (int __errcode, const regex_t *__restrict __preg,
 577                         char *__restrict __errbuf, size_t __errbuf_size);
 578
 579 extern void regfree (regex_t *__preg);
 580
 581
 582 #ifdef __cplusplus
 583 }
 584 #endif  /* C++ */
 585
 586 #endif /* regex.h */