GNUregex.h
上传用户:liugui
上传日期:2007-01-04
资源大小:822k
文件大小:18k
源码类别:

代理服务器

开发平台:

Unix_Linux

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