regex.h

   1 /* Definitions for data structures and routines for the regular
   2    expression library, version 0.11.
   3
   4    Copyright (C) 1985, 89, 90, 91, 92 Free Software Foundation, Inc.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2, or (at your option)
   9    any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #ifndef __REGEXP_LIBRARY_H__
  21 #define __REGEXP_LIBRARY_H__
  22
  23 /* POSIX says that <sys/types.h> must be included before <regex.h>.  */
  24
  25 /* The following bits are used to determine the regexp syntax we
  26    recognize.  The set/not-set meanings are chosen so that Emacs syntax
  27    remains the value 0.  The bits are given in alphabetical order, and
  28    the definitions shifted by one from the previous bit; thus, when we
  29    add or remove a bit, only one other definition need change.  */
  30 typedef unsigned reg_syntax_t;
  31
  32 /* If this bit is not set, then \ inside a bracket expression is literal.
  33    If set, then such a \ quotes the following character.  */
  34 #define RE_BACKSLASH_ESCAPE_IN_LISTS (1)
  35
  36 /* If this bit is not set, then + and ? are operators, and \+ and \? are
  37      literals.
  38    If set, then \+ and \? are operators and + and ? are literals.  */
  39 #define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
  40
  41 /* If this bit is set, then character classes are supported.  They are:
  42      [:alpha:], [:upper:], [:lower:],  [:digit:], [:alnum:], [:xdigit:],
  43      [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
  44    If not set, then character classes are not supported.  */
  45 #define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
  46
  47 /* If this bit is set, then ^ and $ are always anchors (outside bracket
  48      expressions, of course).
  49    If this bit is not set, then it depends:
  50         ^  is an anchor if it is at the beginning of a regular
  51            expression or after an open-group or an alternation operator;
  52         $  is an anchor if it is at the end of a regular expression, or
  53            before a close-group or an alternation operator.
  54
  55    This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
  56    POSIX draft 11.2 says that * etc. in leading positions is undefined.
  57    We already implemented a previous draft which made those constructs
  58    invalid, though, so we haven't changed the code back.  */
  59 #define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
  60
  61 /* If this bit is set, then special characters are always special
  62      regardless of where they are in the pattern.
  63    If this bit is not set, then special characters are special only in
  64      some contexts; otherwise they are ordinary.  Specifically,
  65      * + ? and intervals are only special when not after the beginning,
  66      open-group, or alternation operator.  */
  67 #define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
  68
  69 /* If this bit is set, then *, +, ?, and { cannot be first in an re or
  70      immediately after an alternation or begin-group operator.  */
  71 #define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
  72
  73 /* If this bit is set, then . matches newline.
  74    If not set, then it doesn't.  */
  75 #define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
  76
  77 /* If this bit is set, then . doesn't match NUL.
  78    If not set, then it does.  */
  79 #define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
  80
  81 /* If this bit is set, nonmatching lists [^...] do not match newline.
  82    If not set, they do.  */
  83 #define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
  84
  85 /* If this bit is set, either \{...\} or {...} defines an
  86      interval, depending on RE_NO_BK_BRACES.
  87    If not set, \{, \}, {, and } are literals.  */
  88 #define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
  89
  90 /* If this bit is set, +, ? and | aren't recognized as operators.
  91    If not set, they are.  */
  92 #define RE_LIMITED_OPS (RE_INTERVALS << 1)
  93
  94 /* If this bit is set, newline is an alternation operator.
  95    If not set, newline is literal.  */
  96 #define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
  97
  98 /* If this bit is set, then `{...}' defines an interval, and \{ and \}
  99      are literals.
 100   If not set, then `\{...\}' defines an interval.  */
 101 #define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)
 102
 103 /* If this bit is set, (...) defines a group, and \( and \) are literals.
 104    If not set, \(...\) defines a group, and ( and ) are literals.  */
 105 #define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
 106
 107 /* If this bit is set, then \<digit> matches <digit>.
 108    If not set, then \<digit> is a back-reference.  */
 109 #define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
 110
 111 /* If this bit is set, then | is an alternation operator, and \| is literal.
 112    If not set, then \| is an alternation operator, and | is literal.  */
 113 #define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
 114
 115 /* If this bit is set, then an ending range point collating higher
 116      than the starting range point, as in [z-a], is invalid.
 117    If not set, then when ending range point collates higher than the
 118      starting range point, the range is ignored.  */
 119 #define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)
 120
 121 /* If this bit is set, then an unmatched ) is ordinary.
 122    If not set, then an unmatched ) is invalid.  */
 123 #define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)
 124
 125 /* This global variable defines the particular regexp syntax to use (for
 126    some interfaces).  When a regexp is compiled, the syntax used is
 127    stored in the pattern buffer, so changing this does not affect
 128    already-compiled regexps.  */
 129 extern reg_syntax_t re_syntax_options;
 130 \f
 131 /* Define combinations of the above bits for the standard possibilities.
 132    (The [[[ comments delimit what gets put into the Texinfo file, so
 133    don't delete them!)  */
 134 /* [[[begin syntaxes]]] */
 135 #define RE_SYNTAX_EMACS 0
 136
 137 #define RE_SYNTAX_AWK                                                   \
 138   (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL                       \
 139    | RE_NO_BK_PARENS            | RE_NO_BK_REFS                         \
 140    | RE_NO_BK_VAR               | RE_NO_EMPTY_RANGES                    \
 141    | RE_UNMATCHED_RIGHT_PAREN_ORD)
 142
 143 #define RE_SYNTAX_POSIX_AWK                                             \
 144   (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS)
 145
 146 #define RE_SYNTAX_GREP                                                  \
 147   (RE_BK_PLUS_QM              | RE_CHAR_CLASSES                         \
 148    | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS                            \
 149    | RE_NEWLINE_ALT)
 150
 151 #define RE_SYNTAX_EGREP                                                 \
 152   (RE_CHAR_CLASSES        | RE_CONTEXT_INDEP_ANCHORS                    \
 153    | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE                    \
 154    | RE_NEWLINE_ALT       | RE_NO_BK_PARENS                             \
 155    | RE_NO_BK_VBAR)
 156
 157 #define RE_SYNTAX_POSIX_EGREP                                           \
 158   (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)
 159
 160 #define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC
 161
 162 /* Syntax bits common to both basic and extended POSIX regex syntax.  */
 163 #define _RE_SYNTAX_POSIX_COMMON                                         \
 164   (RE_CHAR_CLASSES | RE_DOT_NEWLINE      | RE_DOT_NOT_NULL              \
 165    | RE_INTERVALS  | RE_NO_EMPTY_RANGES)
 166
 167 #define RE_SYNTAX_POSIX_BASIC                                           \
 168   (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)
 169
 170 /* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes
 171    RE_LIMITED_OPS, i.e., \? \+ \| are not recognized.  Actually, this
 172    isn't minimal, since other operators, such as \`, aren't disabled.  */
 173 #define RE_SYNTAX_POSIX_MINIMAL_BASIC                                   \
 174   (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)
 175
 176 #define RE_SYNTAX_POSIX_EXTENDED                                        \
 177   (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS                   \
 178    | RE_CONTEXT_INDEP_OPS  | RE_NO_BK_BRACES                            \
 179    | RE_NO_BK_PARENS       | RE_NO_BK_VBAR                              \
 180    | RE_UNMATCHED_RIGHT_PAREN_ORD)
 181
 182 /* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS
 183    replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added.  */
 184 #define RE_SYNTAX_POSIX_MINIMAL_EXTENDED                                \
 185   (_RE_SYNTAX_POSIX_COMMON  | RE_CONTEXT_INDEP_ANCHORS                  \
 186    | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES                           \
 187    | RE_NO_BK_PARENS        | RE_NO_BK_REFS                             \
 188    | RE_NO_BK_VBAR          | RE_UNMATCHED_RIGHT_PAREN_ORD)
 189 /* [[[end syntaxes]]] */
 190 \f
 191 /* Maximum number of duplicates an interval can allow.  Some systems
 192    (erroneously) define this in other header files, but we want our
 193    value, so remove any previous define.  */
 194 #ifdef RE_DUP_MAX
 195 #undef RE_DUP_MAX
 196 #endif
 197 #define RE_DUP_MAX ((1 << 15) - 1)
 198
 199
 200 /* POSIX `cflags' bits (i.e., information for `regcomp').  */
 201
 202 /* If this bit is set, then use extended regular expression syntax.
 203    If not set, then use basic regular expression syntax.  */
 204 #define REG_EXTENDED 1
 205
 206 /* If this bit is set, then ignore case when matching.
 207    If not set, then case is significant.  */
 208 #define REG_ICASE (REG_EXTENDED << 1)
 209
 210 /* If this bit is set, then anchors do not match at newline
 211      characters in the string.
 212    If not set, then anchors do match at newlines.  */
 213 #define REG_NEWLINE (REG_ICASE << 1)
 214
 215 /* If this bit is set, then report only success or fail in regexec.
 216    If not set, then returns differ between not matching and errors.  */
 217 #define REG_NOSUB (REG_NEWLINE << 1)
 218
 219
 220 /* POSIX `eflags' bits (i.e., information for regexec).  */
 221
 222 /* If this bit is set, then the beginning-of-line operator doesn't match
 223      the beginning of the string (presumably because it's not the
 224      beginning of a line).
 225    If not set, then the beginning-of-line operator does match the
 226      beginning of the string.  */
 227 #define REG_NOTBOL 1
 228
 229 /* Like REG_NOTBOL, except for the end-of-line.  */
 230 #define REG_NOTEOL (1 << 1)
 231
 232
 233 /* If any error codes are removed, changed, or added, update the
 234    `re_error_msg' table in regex.c.  */
 235 typedef enum
 236 {
 237   REG_NOERROR = 0,      /* Success.  */
 238   REG_NOMATCH,          /* Didn't find a match (for regexec).  */
 239
 240   /* POSIX regcomp return error codes.  (In the order listed in the
 241      standard.)  */
 242   REG_BADPAT,           /* Invalid pattern.  */
 243   REG_ECOLLATE,         /* Not implemented.  */
 244   REG_ECTYPE,           /* Invalid character class name.  */
 245   REG_EESCAPE,          /* Trailing backslash.  */
 246   REG_ESUBREG,          /* Invalid back reference.  */
 247   REG_EBRACK,           /* Unmatched left bracket.  */
 248   REG_EPAREN,           /* Parenthesis imbalance.  */
 249   REG_EBRACE,           /* Unmatched \{.  */
 250   REG_BADBR,            /* Invalid contents of \{\}.  */
 251   REG_ERANGE,           /* Invalid range end.  */
 252   REG_ESPACE,           /* Ran out of memory.  */
 253   REG_BADRPT,           /* No preceding re for repetition op.  */
 254
 255   /* Error codes we've added.  */
 256   REG_EEND,             /* Premature end.  */
 257   REG_ESIZE,            /* Compiled pattern bigger than 2^16 bytes.  */
 258   REG_ERPAREN           /* Unmatched ) or \); not returned from regcomp.  */
 259 } reg_errcode_t;
 260 \f
 261 /* This data structure represents a compiled pattern.  Before calling
 262    the pattern compiler, the fields `buffer', `allocated', `fastmap',
 263    `translate', and `no_sub' can be set.  After the pattern has been
 264    compiled, the `re_nsub' field is available.  All other fields are
 265    private to the regex routines.  */
 266
 267 struct re_pattern_buffer
 268 {
 269 /* [[[begin pattern_buffer]]] */
 270         /* Space that holds the compiled pattern.  It is declared as
 271           `unsigned char *' because its elements are
 272            sometimes used as array indexes.  */
 273   unsigned char *buffer;
 274
 275         /* Number of bytes to which `buffer' points.  */
 276   unsigned long allocated;
 277
 278         /* Number of bytes actually used in `buffer'.  */
 279   unsigned long used;
 280
 281         /* Syntax setting with which the pattern was compiled.  */
 282   reg_syntax_t syntax;
 283
 284         /* Pointer to a fastmap, if any, otherwise zero.  re_search uses
 285            the fastmap, if there is one, to skip over impossible
 286            starting points for matches.  */
 287   char *fastmap;
 288
 289         /* Either a translate table to apply to all characters before
 290            comparing them, or zero for no translation.  The translation
 291            is applied to a pattern when it is compiled and to a string
 292            when it is matched.  */
 293   char *translate;
 294
 295         /* Number of subexpressions found by the compiler.  */
 296   size_t re_nsub;
 297
 298         /* Zero if this pattern cannot match the empty string, one else.
 299            Well, in truth it's used only in `re_search_2', to see
 300            whether or not we should use the fastmap, so we don't set
 301            this absolutely perfectly; see `re_compile_fastmap' (the
 302            `duplicate' case).  */
 303   unsigned can_be_null : 1;
 304
 305         /* If REGS_UNALLOCATED, allocate space in the `regs' structure
 306              for `max (RE_NREGS, re_nsub + 1)' groups.
 307            If REGS_REALLOCATE, reallocate space if necessary.
 308            If REGS_FIXED, use what's there.  */
 309 #define REGS_UNALLOCATED 0
 310 #define REGS_REALLOCATE 1
 311 #define REGS_FIXED 2
 312   unsigned regs_allocated : 2;
 313
 314         /* Set to zero when regex_compile compiles a pattern; set to one
 315            by re_compile_fastmap when it updates the fastmap, if any.  */
 316   unsigned fastmap_accurate : 1;
 317
 318         /* If set, regexec reports only success or failure and does not
 319            return anything in pmatch.  */
 320   unsigned no_sub : 1;
 321
 322         /* If set, a beginning-of-line anchor doesn't match at the
 323            beginning of the string.  */
 324   unsigned not_bol : 1;
 325
 326         /* Similarly for an end-of-line anchor.  */
 327   unsigned not_eol : 1;
 328
 329         /* If true, an anchor at a newline matches.  */
 330   unsigned newline_anchor : 1;
 331
 332 /* [[[end pattern_buffer]]] */
 333 };
 334
 335 typedef struct re_pattern_buffer regex_t;
 336
 337
 338 /* search.c (search_buffer) in Emacs needs this one opcode value.  It is
 339    defined both in `regex.c' and here.  */
 340 #define RE_EXACTN_VALUE 1
 341 \f
 342 /* Type for byte offsets within the string.  POSIX mandates this.  */
 343 typedef int regoff_t;
 344
 345
 346 /* This is the structure we store register match data in.  See
 347    regex.texinfo for a full description of what registers match.  */
 348 struct re_registers
 349 {
 350   unsigned num_regs;
 351   regoff_t *start;
 352   regoff_t *end;
 353 };
 354
 355
 356 /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
 357    `re_match_2' returns information about at least this many registers
 358    the first time a `regs' structure is passed.  */
 359 #ifndef RE_NREGS
 360 #define RE_NREGS 30
 361 #endif
 362
 363
 364 /* POSIX specification for registers.  Aside from the different names than
 365    `re_registers', POSIX uses an array of structures, instead of a
 366    structure of arrays.  */
 367 typedef struct
 368 {
 369   regoff_t rm_so;  /* Byte offset from string's start to substring's start.  */
 370   regoff_t rm_eo;  /* Byte offset from string's start to substring's end.  */
 371 } regmatch_t;
 372 \f
 373 /* Declarations for routines.  */
 374
 375 /* To avoid duplicating every routine declaration -- once with a
 376    prototype (if we are ANSI), and once without (if we aren't) -- we
 377    use the following macro to declare argument types.  This
 378    unfortunately clutters up the declarations a bit, but I think it's
 379    worth it.
 380
 381    We also have to undo `const' if we are not ANSI.  */
 382
 383 #if __STDC__
 384 #define _RE_ARGS(args) args
 385 #else
 386 #define _RE_ARGS(args) ()
 387 #define const
 388 #endif
 389
 390 /* Sets the current default syntax to SYNTAX, and return the old syntax.
 391    You can also simply assign to the `re_syntax_options' variable.  */
 392 extern reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax));
 393
 394 /* Compile the regular expression PATTERN, with length LENGTH
 395    and syntax given by the global `re_syntax_options', into the buffer
 396    BUFFER.  Return NULL if successful, and an error string if not.  */
 397 extern const char *re_compile_pattern
 398   _RE_ARGS ((const char *pattern, int length,
 399              struct re_pattern_buffer *buffer));
 400
 401
 402 /* Compile a fastmap for the compiled pattern in BUFFER; used to
 403    accelerate searches.  Return 0 if successful and -2 if was an
 404    internal error.  */
 405 extern int re_compile_fastmap _RE_ARGS ((struct re_pattern_buffer *buffer));
 406
 407
 408 /* Search in the string STRING (with length LENGTH) for the pattern
 409    compiled into BUFFER.  Start searching at position START, for RANGE
 410    characters.  Return the starting position of the match, -1 for no
 411    match, or -2 for an internal error.  Also return register
 412    information in REGS (if REGS and BUFFER->no_sub are nonzero).  */
 413 extern int re_search
 414   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
 415             int length, int start, int range, struct re_registers *regs));
 416
 417
 418 /* Like `re_search', but search in the concatenation of STRING1 and
 419    STRING2.  Also, stop searching at index START + STOP.  */
 420 extern int re_search_2
 421   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
 422              int length1, const char *string2, int length2,
 423              int start, int range, struct re_registers *regs, int stop));
 424
 425
 426 /* Like `re_search', but return how many characters in STRING the regexp
 427    in BUFFER matched, starting at position START.  */
 428 extern int re_match
 429   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string,
 430              int length, int start, struct re_registers *regs));
 431
 432
 433 /* Relates to `re_match' as `re_search_2' relates to `re_search'.  */
 434 extern int re_match_2
 435   _RE_ARGS ((struct re_pattern_buffer *buffer, const char *string1,
 436              int length1, const char *string2, int length2,
 437              int start, struct re_registers *regs, int stop));
 438
 439
 440 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
 441    ENDS.  Subsequent matches using BUFFER and REGS will use this memory
 442    for recording register information.  STARTS and ENDS must be
 443    allocated with malloc, and must each be at least `NUM_REGS * sizeof
 444    (regoff_t)' bytes long.
 445
 446    If NUM_REGS == 0, then subsequent matches should allocate their own
 447    register data.
 448
 449    Unless this function is called, the first search or match using
 450    PATTERN_BUFFER will allocate its own register data, without
 451    freeing the old data.  */
 452 extern void re_set_registers
 453   _RE_ARGS ((struct re_pattern_buffer *buffer, struct re_registers *regs,
 454              unsigned num_regs, regoff_t *starts, regoff_t *ends));
 455
 456 /* 4.2 bsd compatibility.  */
 457 extern char *re_comp _RE_ARGS ((const char *));
 458 extern int re_exec _RE_ARGS ((const char *));
 459
 460 /* POSIX compatibility.  */
 461 extern int regcomp _RE_ARGS ((regex_t *preg, const char *pattern, int cflags));
 462 extern int regexec
 463   _RE_ARGS ((const regex_t *preg, const char *string, size_t nmatch,
 464              regmatch_t pmatch[], int eflags));
 465 extern size_t regerror
 466   _RE_ARGS ((int errcode, const regex_t *preg, char *errbuf,
 467              size_t errbuf_size));
 468 extern void regfree _RE_ARGS ((regex_t *preg));
 469
 470 #endif /* not __REGEXP_LIBRARY_H__ */
 471 \f
 472 /*
 473 Local variables:
 474 make-backup-files: t
 475 version-control: t
 476 trim-versions-without-asking: nil
 477 End:
 478 */