regex.h

   1 /* Definitions for data structures and routines for the regular
   2    expression library.
   3    Copyright (C) 1985, 1989-2014 Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library 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 GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, see
  18    <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef _REGEX_H
  21 #define _REGEX_H 1
  22
  23 #ifdef HAVE_STDDEF_H
  24 #include <stddef.h>
  25 #endif
  26
  27 #ifdef HAVE_SYS_TYPES_H
  28 #include <sys/types.h>
  29 #endif
  30
  31 #ifndef _LIBC
  32 #define __USE_GNU       1
  33 #endif
  34
  35 /* Allow the use in C++ code.  */
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /* The following two types have to be signed and unsigned integer type
  41    wide enough to hold a value of a pointer.  For most ANSI compilers
  42    ptrdiff_t and size_t should be likely OK.  Still size of these two
  43    types is 2 for Microsoft C.  Ugh... */
  44 typedef long int s_reg_t;
  45 typedef unsigned long int active_reg_t;
  46
  47 /* The following bits are used to determine the regexp syntax we
  48    recognize.  The set/not-set meanings are chosen so that Emacs syntax
  49    remains the value 0.  The bits are given in alphabetical order, and
  50    the definitions shifted by one from the previous bit; thus, when we
  51    add or remove a bit, only one other definition need change.  */
  52 typedef unsigned long int reg_syntax_t;
  53
  54 #ifdef __USE_GNU
  55 /* If this bit is not set, then \ inside a bracket expression is literal.
  56    If set, then such a \ quotes the following character.  */
  57 # define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1)
  58
  59 /* If this bit is not set, then + and ? are operators, and \+ and \? are
  60      literals.
  61    If set, then \+ and \? are operators and + and ? are literals.  */
  62 # define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
  63
  64 /* If this bit is set, then character classes are supported.  They are:
  65      [:alpha:], [:upper:], [:lower:],  [:digit:], [:alnum:], [:xdigit:],
  66      [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
  67    If not set, then character classes are not supported.  */
  68 # define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
  69
  70 /* If this bit is set, then ^ and $ are always anchors (outside bracket
  71      expressions, of course).
  72    If this bit is not set, then it depends:
  73         ^  is an anchor if it is at the beginning of a regular
  74            expression or after an open-group or an alternation operator;
  75         $  is an anchor if it is at the end of a regular expression, or
  76            before a close-group or an alternation operator.
  77
  78    This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
  79    POSIX draft 11.2 says that * etc. in leading positions is undefined.
  80    We already implemented a previous draft which made those constructs
  81    invalid, though, so we haven't changed the code back.  */
  82 # define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
  83
  84 /* If this bit is set, then special characters are always special
  85      regardless of where they are in the pattern.
  86    If this bit is not set, then special characters are special only in
  87      some contexts; otherwise they are ordinary.  Specifically,
  88      * + ? and intervals are only special when not after the beginning,
  89      open-group, or alternation operator.  */
  90 # define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
  91
  92 /* If this bit is set, then *, +, ?, and { cannot be first in an re or
  93      immediately after an alternation or begin-group operator.  */
  94 # define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
  95
  96 /* If this bit is set, then . matches newline.
  97    If not set, then it doesn't.  */
  98 # define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
  99
 100 /* If this bit is set, then . doesn't match NUL.
 101    If not set, then it does.  */
 102 # define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
 103
 104 /* If this bit is set, nonmatching lists [^...] do not match newline.
 105    If not set, they do.  */
 106 # define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
 107
 108 /* If this bit is set, either \{...\} or {...} defines an
 109      interval, depending on RE_NO_BK_BRACES.
 110    If not set, \{, \}, {, and } are literals.  */
 111 # define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
 112
 113 /* If this bit is set, +, ? and | aren't recognized as operators.
 114    If not set, they are.  */
 115 # define RE_LIMITED_OPS (RE_INTERVALS << 1)
 116
 117 /* If this bit is set, newline is an alternation operator.
 118    If not set, newline is literal.  */
 119 # define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
 120
 121 /* If this bit is set, then `{...}' defines an interval, and \{ and \}
 122      are literals.
 123   If not set, then `\{...\}' defines an interval.  */
 124 # define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)
 125
 126 /* If this bit is set, (...) defines a group, and \( and \) are literals.
 127    If not set, \(...\) defines a group, and ( and ) are literals.  */
 128 # define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
 129
 130 /* If this bit is set, then \<digit> matches <digit>.
 131    If not set, then \<digit> is a back-reference.  */
 132 # define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
 133
 134 /* If this bit is set, then | is an alternation operator, and \| is literal.
 135    If not set, then \| is an alternation operator, and | is literal.  */
 136 # define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
 137
 138 /* If this bit is set, then an ending range point collating higher
 139      than the starting range point, as in [z-a], is invalid.
 140    If not set, then when ending range point collates higher than the
 141      starting range point, the range is ignored.  */
 142 # define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)
 143
 144 /* If this bit is set, then an unmatched ) is ordinary.
 145    If not set, then an unmatched ) is invalid.  */
 146 # define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)
 147
 148 /* If this bit is set, succeed as soon as we match the whole pattern,
 149    without further backtracking.  */
 150 # define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1)
 151
 152 /* If this bit is set, do not process the GNU regex operators.
 153    If not set, then the GNU regex operators are recognized. */
 154 # define RE_NO_GNU_OPS (RE_NO_POSIX_BACKTRACKING << 1)
 155
 156 /* If this bit is set, turn on internal regex debugging.
 157    If not set, and debugging was on, turn it off.
 158    This only works if regex.c is compiled -DDEBUG.
 159    We define this bit always, so that all that's needed to turn on
 160    debugging is to recompile regex.c; the calling code can always have
 161    this bit set, and it won't affect anything in the normal case. */
 162 # define RE_DEBUG (RE_NO_GNU_OPS << 1)
 163
 164 /* If this bit is set, a syntactically invalid interval is treated as
 165    a string of ordinary characters.  For example, the ERE 'a{1' is
 166    treated as 'a\{1'.  */
 167 # define RE_INVALID_INTERVAL_ORD (RE_DEBUG << 1)
 168
 169 /* If this bit is set, then ignore case when matching.
 170    If not set, then case is significant.  */
 171 # define RE_ICASE (RE_INVALID_INTERVAL_ORD << 1)
 172
 173 /* This bit is used internally like RE_CONTEXT_INDEP_ANCHORS but only
 174    for ^, because it is difficult to scan the regex backwards to find
 175    whether ^ should be special.  */
 176 # define RE_CARET_ANCHORS_HERE (RE_ICASE << 1)
 177
 178 /* If this bit is set, then \{ cannot be first in an bre or
 179    immediately after an alternation or begin-group operator.  */
 180 # define RE_CONTEXT_INVALID_DUP (RE_CARET_ANCHORS_HERE << 1)
 181
 182 /* If this bit is set, then no_sub will be set to 1 during
 183    re_compile_pattern.  */
 184 # define RE_NO_SUB (RE_CONTEXT_INVALID_DUP << 1)
 185 #endif
 186
 187 /* This global variable defines the particular regexp syntax to use (for
 188    some interfaces).  When a regexp is compiled, the syntax used is
 189    stored in the pattern buffer, so changing this does not affect
 190    already-compiled regexps.  */
 191 extern reg_syntax_t re_syntax_options;
 192 \f
 193 #ifdef __USE_GNU
 194 /* Define combinations of the above bits for the standard possibilities.
 195    (The [[[ comments delimit what gets put into the Texinfo file, so
 196    don't delete them!)  */
 197 /* [[[begin syntaxes]]] */
 198 #define RE_SYNTAX_EMACS 0
 199
 200 #define RE_SYNTAX_AWK                                                   \
 201   (RE_BACKSLASH_ESCAPE_IN_LISTS   | RE_DOT_NOT_NULL                     \
 202    | RE_NO_BK_PARENS              | RE_NO_BK_REFS                       \
 203    | RE_NO_BK_VBAR                | RE_NO_EMPTY_RANGES                  \
 204    | RE_DOT_NEWLINE               | RE_CONTEXT_INDEP_ANCHORS            \
 205    | RE_CHAR_CLASSES                                                    \
 206    | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS)
 207
 208 #define RE_SYNTAX_GNU_AWK                                               \
 209   ((RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS             \
 210     | RE_INVALID_INTERVAL_ORD)                                          \
 211    & ~(RE_DOT_NOT_NULL | RE_CONTEXT_INDEP_OPS                           \
 212       | RE_CONTEXT_INVALID_OPS ))
 213
 214 #define RE_SYNTAX_POSIX_AWK                                             \
 215   (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS              \
 216    | RE_INTERVALS           | RE_NO_GNU_OPS                             \
 217    | RE_INVALID_INTERVAL_ORD)
 218
 219 #define RE_SYNTAX_GREP                                                  \
 220   (RE_BK_PLUS_QM              | RE_CHAR_CLASSES                         \
 221    | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS                            \
 222    | RE_NEWLINE_ALT)
 223
 224 #define RE_SYNTAX_EGREP                                                 \
 225   (RE_CHAR_CLASSES        | RE_CONTEXT_INDEP_ANCHORS                    \
 226    | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE                    \
 227    | RE_NEWLINE_ALT       | RE_NO_BK_PARENS                             \
 228    | RE_NO_BK_VBAR)
 229
 230 #define RE_SYNTAX_POSIX_EGREP                                           \
 231   (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES                     \
 232    | RE_INVALID_INTERVAL_ORD)
 233
 234 /* P1003.2/D11.2, section 4.20.7.1, lines 5078ff.  */
 235 #define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC
 236
 237 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
 238
 239 /* Syntax bits common to both basic and extended POSIX regex syntax.  */
 240 #define _RE_SYNTAX_POSIX_COMMON                                         \
 241   (RE_CHAR_CLASSES | RE_DOT_NEWLINE      | RE_DOT_NOT_NULL              \
 242    | RE_INTERVALS  | RE_NO_EMPTY_RANGES)
 243
 244 #define RE_SYNTAX_POSIX_BASIC                                           \
 245   (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM | RE_CONTEXT_INVALID_DUP)
 246
 247 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes
 248    RE_LIMITED_OPS, i.e., \? \+ \| are not recognized.  Actually, this
 249    isn't minimal, since other operators, such as \`, aren't disabled.  */
 250 #define RE_SYNTAX_POSIX_MINIMAL_BASIC                                   \
 251   (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)
 252
 253 #define RE_SYNTAX_POSIX_EXTENDED                                        \
 254   (_RE_SYNTAX_POSIX_COMMON  | RE_CONTEXT_INDEP_ANCHORS                  \
 255    | RE_CONTEXT_INDEP_OPS   | RE_NO_BK_BRACES                           \
 256    | RE_NO_BK_PARENS        | RE_NO_BK_VBAR                             \
 257    | RE_CONTEXT_INVALID_OPS | RE_UNMATCHED_RIGHT_PAREN_ORD)
 258
 259 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INDEP_OPS is
 260    removed and RE_NO_BK_REFS is added.  */
 261 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED                                \
 262   (_RE_SYNTAX_POSIX_COMMON  | RE_CONTEXT_INDEP_ANCHORS                  \
 263    | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES                           \
 264    | RE_NO_BK_PARENS        | RE_NO_BK_REFS                             \
 265    | RE_NO_BK_VBAR          | RE_UNMATCHED_RIGHT_PAREN_ORD)
 266 /* [[[end syntaxes]]] */
 267 \f
 268 /* Maximum number of duplicates an interval can allow.  Some systems
 269    (erroneously) define this in other header files, but we want our
 270    value, so remove any previous define.  */
 271 # ifdef RE_DUP_MAX
 272 #  undef RE_DUP_MAX
 273 # endif
 274 /* If sizeof(int) == 2, then ((1 << 15) - 1) overflows.  */
 275 # define RE_DUP_MAX (0x7fff)
 276 #endif
 277
 278
 279 /* POSIX `cflags' bits (i.e., information for `regcomp').  */
 280
 281 /* If this bit is set, then use extended regular expression syntax.
 282    If not set, then use basic regular expression syntax.  */
 283 #define REG_EXTENDED 1
 284
 285 /* If this bit is set, then ignore case when matching.
 286    If not set, then case is significant.  */
 287 #define REG_ICASE (REG_EXTENDED << 1)
 288
 289 /* If this bit is set, then anchors do not match at newline
 290      characters in the string.
 291    If not set, then anchors do match at newlines.  */
 292 #define REG_NEWLINE (REG_ICASE << 1)
 293
 294 /* If this bit is set, then report only success or fail in regexec.
 295    If not set, then returns differ between not matching and errors.  */
 296 #define REG_NOSUB (REG_NEWLINE << 1)
 297
 298
 299 /* POSIX `eflags' bits (i.e., information for regexec).  */
 300
 301 /* If this bit is set, then the beginning-of-line operator doesn't match
 302      the beginning of the string (presumably because it's not the
 303      beginning of a line).
 304    If not set, then the beginning-of-line operator does match the
 305      beginning of the string.  */
 306 #define REG_NOTBOL 1
 307
 308 /* Like REG_NOTBOL, except for the end-of-line.  */
 309 #define REG_NOTEOL (1 << 1)
 310
 311 /* Use PMATCH[0] to delimit the start and end of the search in the
 312    buffer.  */
 313 #define REG_STARTEND (1 << 2)
 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    and `translate' can be set.  After the pattern has been compiled,
 351    the fields `re_nsub', `not_bol' and `not_eol' are available.  All
 352    other fields are 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
 479    To free the allocated storage, you must call `regfree' on BUFFER.
 480    Note that the translate table must either have been initialised by
 481    `regcomp', with a malloc'ed value, or set to NULL before calling
 482    `regfree'.  */
 483 extern const char *re_compile_pattern (const char *__pattern, size_t __length,
 484                                        struct re_pattern_buffer *__buffer);
 485
 486
 487 /* Compile a fastmap for the compiled pattern in BUFFER; used to
 488    accelerate searches.  Return 0 if successful and -2 if was an
 489    internal error.  */
 490 extern int re_compile_fastmap (struct re_pattern_buffer *__buffer);
 491
 492
 493 /* Search in the string STRING (with length LENGTH) for the pattern
 494    compiled into BUFFER.  Start searching at position START, for RANGE
 495    characters.  Return the starting position of the match, -1 for no
 496    match, or -2 for an internal error.  Also return register
 497    information in REGS (if REGS and BUFFER->no_sub are nonzero).  */
 498 extern int re_search (struct re_pattern_buffer *__buffer, const char *__cstring,
 499                       int __length, int __start, int __range,
 500                       struct re_registers *__regs);
 501
 502
 503 /* Like `re_search', but search in the concatenation of STRING1 and
 504    STRING2.  Also, stop searching at index START + STOP.  */
 505 extern int re_search_2 (struct re_pattern_buffer *__buffer,
 506                         const char *__string1, int __length1,
 507                         const char *__string2, int __length2, int __start,
 508                         int __range, struct re_registers *__regs, int __stop);
 509
 510
 511 /* Like `re_search', but return how many characters in STRING the regexp
 512    in BUFFER matched, starting at position START.  */
 513 extern int re_match (struct re_pattern_buffer *__buffer, const char *__cstring,
 514                      int __length, int __start, struct re_registers *__regs);
 515
 516
 517 /* Relates to `re_match' as `re_search_2' relates to `re_search'.  */
 518 extern int re_match_2 (struct re_pattern_buffer *__buffer,
 519                        const char *__string1, int __length1,
 520                        const char *__string2, int __length2, int __start,
 521                        struct re_registers *__regs, int __stop);
 522
 523
 524 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
 525    ENDS.  Subsequent matches using BUFFER and REGS will use this memory
 526    for recording register information.  STARTS and ENDS must be
 527    allocated with malloc, and must each be at least `NUM_REGS * sizeof
 528    (regoff_t)' bytes long.
 529
 530    If NUM_REGS == 0, then subsequent matches should allocate their own
 531    register data.
 532
 533    Unless this function is called, the first search or match using
 534    PATTERN_BUFFER will allocate its own register data, without
 535    freeing the old data.  */
 536 extern void re_set_registers (struct re_pattern_buffer *__buffer,
 537                               struct re_registers *__regs,
 538                               unsigned int __num_regs,
 539                               regoff_t *__starts, regoff_t *__ends);
 540 #endif  /* Use GNU */
 541
 542 #if defined _REGEX_RE_COMP || (defined _LIBC && defined __USE_MISC)
 543 # ifndef _CRAY
 544 /* 4.2 bsd compatibility.  */
 545 extern char *re_comp (const char *);
 546 extern int re_exec (const char *);
 547 # endif
 548 #endif
 549
 550 /* GCC 2.95 and later have "__restrict"; C99 compilers have
 551    "restrict", and "configure" may have defined "restrict".  */
 552 #ifndef __restrict
 553 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
 554 #  if defined restrict || 199901L <= __STDC_VERSION__
 555 #   define __restrict restrict
 556 #  else
 557 #   define __restrict
 558 #  endif
 559 # endif
 560 #endif
 561 /* gcc 3.1 and up support the [restrict] syntax.  */
 562 #ifndef __restrict_arr
 563 # if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)) \
 564      && !defined __GNUG__
 565 #  define __restrict_arr __restrict
 566 # else
 567 #  define __restrict_arr
 568 # endif
 569 #endif
 570
 571 /* POSIX compatibility.  */
 572 extern int regcomp (regex_t *__restrict __preg,
 573                     const char *__restrict __pattern,
 574                     int __cflags);
 575
 576 extern int regexec (const regex_t *__restrict __preg,
 577                     const char *__restrict __cstring, size_t __nmatch,
 578                     regmatch_t __pmatch[__restrict_arr],
 579                     int __eflags);
 580
 581 extern size_t regerror (int __errcode, const regex_t *__restrict __preg,
 582                         char *__restrict __errbuf, size_t __errbuf_size);
 583
 584 extern void regfree (regex_t *__preg);
 585
 586
 587 #ifdef __cplusplus
 588 }
 589 #endif  /* C++ */
 590
 591 #endif /* regex.h */