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