Update.
[glibc.git] / posix / regex_internal.h
bloba7f6042935143b7b6c228f71f90f7468b177b806
1 /* Extended regular expression matching and search library.
2 Copyright (C) 2002 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Contributed by Isamu Hasegawa <isamu@yamato.ibm.com>.
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.
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.
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 02111-1307 USA. */
21 #ifndef _REGEX_INTERNAL_H
22 #define _REGEX_INTERNAL_H 1
24 /* Number of bits in a byte. */
25 #define BYTE_BITS 8
26 /* Number of single byte character. */
27 #define SBC_MAX 256
29 #define COLL_ELEM_LEN_MAX 8
31 /* The character which represents newline. */
32 #define NEWLINE_CHAR '\n'
34 /* Rename to standard API for using out of glibc. */
35 #ifndef _LIBC
36 # define __wctype wctype
37 # define __iswctype iswctype
38 # define __btowc btowc
39 # define __mempcpy memcpy
40 # define attribute_hidden
41 #endif /* not _LIBC */
43 extern const char __re_error_msgid[] attribute_hidden;
44 extern const size_t __re_error_msgid_idx[] attribute_hidden;
46 /* Number of bits in an unsinged int. */
47 #define UINT_BITS (sizeof (unsigned int) * BYTE_BITS)
48 /* Number of unsigned int in an bit_set. */
49 #define BITSET_UINTS ((SBC_MAX + UINT_BITS - 1) / UINT_BITS)
50 typedef unsigned int bitset[BITSET_UINTS];
51 typedef unsigned int *re_bitset_ptr_t;
53 #define bitset_set(set,i) (set[i / UINT_BITS] |= 1 << i % UINT_BITS)
54 #define bitset_clear(set,i) (set[i / UINT_BITS] &= ~(1 << i % UINT_BITS))
55 #define bitset_contain(set,i) (set[i / UINT_BITS] & (1 << i % UINT_BITS))
56 #define bitset_empty(set) memset (set, 0, sizeof (unsigned int) * BITSET_UINTS)
57 #define bitset_set_all(set) \
58 memset (set, 255, sizeof (unsigned int) * BITSET_UINTS)
59 #define bitset_copy(dest,src) \
60 memcpy (dest, src, sizeof (unsigned int) * BITSET_UINTS)
61 static inline void bitset_not (bitset set);
62 static inline void bitset_merge (bitset dest, const bitset src);
63 static inline void bitset_not_merge (bitset dest, const bitset src);
65 #define PREV_WORD_CONSTRAINT 0x0001
66 #define PREV_NOTWORD_CONSTRAINT 0x0002
67 #define NEXT_WORD_CONSTRAINT 0x0004
68 #define NEXT_NOTWORD_CONSTRAINT 0x0008
69 #define PREV_NEWLINE_CONSTRAINT 0x0010
70 #define NEXT_NEWLINE_CONSTRAINT 0x0020
71 #define PREV_BEGBUF_CONSTRAINT 0x0040
72 #define NEXT_ENDBUF_CONSTRAINT 0x0080
73 #define DUMMY_CONSTRAINT 0x0100
75 typedef enum
77 INSIDE_WORD = PREV_WORD_CONSTRAINT | NEXT_WORD_CONSTRAINT,
78 WORD_FIRST = PREV_NOTWORD_CONSTRAINT | NEXT_WORD_CONSTRAINT,
79 WORD_LAST = PREV_WORD_CONSTRAINT | NEXT_NOTWORD_CONSTRAINT,
80 LINE_FIRST = PREV_NEWLINE_CONSTRAINT,
81 LINE_LAST = NEXT_NEWLINE_CONSTRAINT,
82 BUF_FIRST = PREV_BEGBUF_CONSTRAINT,
83 BUF_LAST = NEXT_ENDBUF_CONSTRAINT,
84 WORD_DELIM = DUMMY_CONSTRAINT
85 } re_context_type;
87 typedef struct
89 int alloc;
90 int nelem;
91 int *elems;
92 } re_node_set;
94 typedef enum
96 NON_TYPE = 0,
98 /* Token type, these are used only by token. */
99 OP_OPEN_BRACKET,
100 OP_CLOSE_BRACKET,
101 OP_CHARSET_RANGE,
102 OP_OPEN_DUP_NUM,
103 OP_CLOSE_DUP_NUM,
104 OP_NON_MATCH_LIST,
105 OP_OPEN_COLL_ELEM,
106 OP_CLOSE_COLL_ELEM,
107 OP_OPEN_EQUIV_CLASS,
108 OP_CLOSE_EQUIV_CLASS,
109 OP_OPEN_CHAR_CLASS,
110 OP_CLOSE_CHAR_CLASS,
111 OP_WORD,
112 OP_NOTWORD,
113 BACK_SLASH,
115 /* Tree type, these are used only by tree. */
116 CONCAT,
117 ALT,
118 SUBEXP,
119 SIMPLE_BRACKET,
120 #ifdef RE_ENABLE_I18N
121 COMPLEX_BRACKET,
122 #endif /* RE_ENABLE_I18N */
124 /* Node type, These are used by token, node, tree. */
125 OP_OPEN_SUBEXP,
126 OP_CLOSE_SUBEXP,
127 OP_PERIOD,
128 CHARACTER,
129 END_OF_RE,
130 OP_ALT,
131 OP_DUP_ASTERISK,
132 OP_DUP_PLUS,
133 OP_DUP_QUESTION,
134 OP_BACK_REF,
135 ANCHOR,
136 OP_CONTEXT_NODE,
138 /* Dummy marker. */
139 END_OF_RE_TOKEN_T
140 } re_token_type_t;
142 #ifdef RE_ENABLE_I18N
143 typedef struct
145 /* Multibyte characters. */
146 wchar_t *mbchars;
148 /* Collating symbols. */
149 # ifdef _LIBC
150 int32_t *coll_syms;
151 # endif
153 /* Equivalence classes. */
154 # ifdef _LIBC
155 int32_t *equiv_classes;
156 # endif
158 /* Range expressions. */
159 # ifdef _LIBC
160 uint32_t *range_starts;
161 uint32_t *range_ends;
162 # else /* not _LIBC */
163 wchar_t *range_starts;
164 wchar_t *range_ends;
165 # endif /* not _LIBC */
167 /* Character classes. */
168 wctype_t *char_classes;
170 /* If this character set is the non-matching list. */
171 unsigned int non_match : 1;
173 /* # of multibyte characters. */
174 int nmbchars;
176 /* # of collating symbols. */
177 int ncoll_syms;
179 /* # of equivalence classes. */
180 int nequiv_classes;
182 /* # of range expressions. */
183 int nranges;
185 /* # of character classes. */
186 int nchar_classes;
187 } re_charset_t;
188 #endif /* RE_ENABLE_I18N */
190 typedef struct
192 union
194 unsigned char c; /* for CHARACTER */
195 re_bitset_ptr_t sbcset; /* for SIMPLE_BRACKET */
196 #ifdef RE_ENABLE_I18N
197 re_charset_t *mbcset; /* for COMPLEX_BRACKET */
198 #endif /* RE_ENABLE_I18N */
199 int idx; /* for BACK_REF */
200 re_context_type ctx_type; /* for ANCHOR */
201 struct
203 int entity; /* for OP_CONTEXT_NODE, index of the entity */
204 re_node_set *bkref_eclosure;
205 } *ctx_info;
206 } opr;
207 #if __GNUC__ >= 2
208 re_token_type_t type : 8;
209 #else
210 re_token_type_t type;
211 #endif
212 unsigned int constraint : 10; /* context constraint */
213 unsigned int duplicated : 1;
214 #ifdef RE_ENABLE_I18N
215 unsigned int mb_partial : 1;
216 #endif
217 } re_token_t;
219 #define IS_EPSILON_NODE(type) \
220 ((type) == OP_ALT || (type) == OP_DUP_ASTERISK || (type) == OP_DUP_PLUS \
221 || (type) == OP_DUP_QUESTION || (type) == ANCHOR \
222 || (type) == OP_OPEN_SUBEXP || (type) == OP_CLOSE_SUBEXP)
224 #define ACCEPT_MB_NODE(type) \
225 ((type) == COMPLEX_BRACKET || (type) == OP_PERIOD)
227 struct re_string_t
229 /* Indicate the raw buffer which is the original string passed as an
230 argument of regexec(), re_search(), etc.. */
231 const unsigned char *raw_mbs;
232 /* Store the multibyte string. In case of "case insensitive mode" like
233 REG_ICASE, upper cases of the string are stored, otherwise MBS points
234 the same address that RAW_MBS points. */
235 unsigned char *mbs;
236 /* Store the case sensitive multibyte string. In case of
237 "case insensitive mode", the original string are stored,
238 otherwise MBS_CASE points the same address that MBS points. */
239 unsigned char *mbs_case;
240 #ifdef RE_ENABLE_I18N
241 /* Store the wide character string which is corresponding to MBS. */
242 wint_t *wcs;
243 mbstate_t cur_state;
244 #endif
245 /* Index in RAW_MBS. Each character mbs[i] corresponds to
246 raw_mbs[raw_mbs_idx + i]. */
247 int raw_mbs_idx;
248 /* The length of the valid characters in the buffers. */
249 int valid_len;
250 /* The length of the buffers MBS, MBS_CASE, and WCS. */
251 int bufs_len;
252 /* The index in MBS, which is updated by re_string_fetch_byte. */
253 int cur_idx;
254 /* This is length_of_RAW_MBS - RAW_MBS_IDX. */
255 int len;
256 /* End of the buffer may be shorter than its length in the cases such
257 as re_match_2, re_search_2. Then, we use STOP for end of the buffer
258 instead of LEN. */
259 int stop;
261 /* The context of mbs[0]. We store the context independently, since
262 the context of mbs[0] may be different from raw_mbs[0], which is
263 the beginning of the input string. */
264 unsigned int tip_context;
265 /* The translation passed as a part of an argument of re_compile_pattern. */
266 RE_TRANSLATE_TYPE trans;
267 /* 1 if REG_ICASE. */
268 unsigned int icase : 1;
270 typedef struct re_string_t re_string_t;
271 /* In case of REG_ICASE, we allocate the buffer dynamically for mbs. */
272 #define MBS_ALLOCATED(pstr) (pstr->icase)
273 /* In case that we need translation, we allocate the buffer dynamically
274 for mbs_case. Note that mbs == mbs_case if not REG_ICASE. */
275 #define MBS_CASE_ALLOCATED(pstr) (pstr->trans != NULL)
278 static reg_errcode_t re_string_allocate (re_string_t *pstr,
279 const unsigned char *str, int len,
280 int init_len,
281 RE_TRANSLATE_TYPE trans, int icase);
282 static reg_errcode_t re_string_construct (re_string_t *pstr,
283 const unsigned char *str, int len,
284 RE_TRANSLATE_TYPE trans, int icase);
285 static reg_errcode_t re_string_reconstruct (re_string_t *pstr, int idx,
286 int eflags, int newline);
287 static reg_errcode_t re_string_realloc_buffers (re_string_t *pstr,
288 int new_buf_len);
289 #ifdef RE_ENABLE_I18N
290 static void build_wcs_buffer (re_string_t *pstr);
291 static void build_wcs_upper_buffer (re_string_t *pstr);
292 #endif /* RE_ENABLE_I18N */
293 static void build_upper_buffer (re_string_t *pstr);
294 static void re_string_translate_buffer (re_string_t *pstr);
295 static void re_string_destruct (re_string_t *pstr);
296 #ifdef RE_ENABLE_I18N
297 static int re_string_elem_size_at (const re_string_t *pstr, int idx);
298 static inline int re_string_char_size_at (const re_string_t *pstr, int idx);
299 static inline wint_t re_string_wchar_at (const re_string_t *pstr, int idx);
300 #endif /* RE_ENABLE_I18N */
301 static unsigned int re_string_context_at (const re_string_t *input, int idx,
302 int eflags, int newline_anchor);
303 #define re_string_peek_byte(pstr, offset) \
304 ((pstr)->mbs[(pstr)->cur_idx + offset])
305 #define re_string_peek_byte_case(pstr, offset) \
306 ((pstr)->mbs_case[(pstr)->cur_idx + offset])
307 #define re_string_fetch_byte(pstr) \
308 ((pstr)->mbs[(pstr)->cur_idx++])
309 #define re_string_fetch_byte_case(pstr) \
310 ((pstr)->mbs_case[(pstr)->cur_idx++])
311 #define re_string_first_byte(pstr, idx) \
312 ((idx) == (pstr)->len || (pstr)->wcs[idx] != WEOF)
313 #define re_string_is_single_byte_char(pstr, idx) \
314 ((pstr)->wcs[idx] != WEOF && ((pstr)->len == (idx) \
315 || (pstr)->wcs[(idx) + 1] != WEOF))
316 #define re_string_eoi(pstr) ((pstr)->stop <= (pstr)->cur_idx)
317 #define re_string_cur_idx(pstr) ((pstr)->cur_idx)
318 #define re_string_get_buffer(pstr) ((pstr)->mbs)
319 #define re_string_length(pstr) ((pstr)->len)
320 #define re_string_byte_at(pstr,idx) ((pstr)->mbs[idx])
321 #define re_string_skip_bytes(pstr,idx) ((pstr)->cur_idx += (idx))
322 #define re_string_set_index(pstr,idx) ((pstr)->cur_idx = (idx))
324 #define re_malloc(t,n) ((t *) malloc ((n) * sizeof (t)))
325 #define re_realloc(p,t,n) ((t *) realloc (p, (n) * sizeof (t)))
326 #define re_free(p) free (p)
328 struct bin_tree_t
330 struct bin_tree_t *parent;
331 struct bin_tree_t *left;
332 struct bin_tree_t *right;
334 /* `node_idx' is the index in dfa->nodes, if `type' == 0.
335 Otherwise `type' indicate the type of this node. */
336 re_token_type_t type;
337 int node_idx;
339 int first;
340 int next;
341 re_node_set eclosure;
343 typedef struct bin_tree_t bin_tree_t;
346 #define CONTEXT_WORD 1
347 #define CONTEXT_NEWLINE (CONTEXT_WORD << 1)
348 #define CONTEXT_BEGBUF (CONTEXT_NEWLINE << 1)
349 #define CONTEXT_ENDBUF (CONTEXT_BEGBUF << 1)
351 #define IS_WORD_CONTEXT(c) ((c) & CONTEXT_WORD)
352 #define IS_NEWLINE_CONTEXT(c) ((c) & CONTEXT_NEWLINE)
353 #define IS_BEGBUF_CONTEXT(c) ((c) & CONTEXT_BEGBUF)
354 #define IS_ENDBUF_CONTEXT(c) ((c) & CONTEXT_ENDBUF)
355 #define IS_ORDINARY_CONTEXT(c) ((c) == 0)
357 #define IS_WORD_CHAR(ch) (isalnum (ch) || (ch) == '_')
358 #define IS_NEWLINE(ch) ((ch) == NEWLINE_CHAR)
360 #define NOT_SATISFY_PREV_CONSTRAINT(constraint,context) \
361 ((((constraint) & PREV_WORD_CONSTRAINT) && !IS_WORD_CONTEXT (context)) \
362 || ((constraint & PREV_NOTWORD_CONSTRAINT) && IS_WORD_CONTEXT (context)) \
363 || ((constraint & PREV_NEWLINE_CONSTRAINT) && !IS_NEWLINE_CONTEXT (context))\
364 || ((constraint & PREV_BEGBUF_CONSTRAINT) && !IS_BEGBUF_CONTEXT (context)))
366 #define NOT_SATISFY_NEXT_CONSTRAINT(constraint,context) \
367 ((((constraint) & NEXT_WORD_CONSTRAINT) && !IS_WORD_CONTEXT (context)) \
368 || (((constraint) & NEXT_NOTWORD_CONSTRAINT) && IS_WORD_CONTEXT (context)) \
369 || (((constraint) & NEXT_NEWLINE_CONSTRAINT) && !IS_NEWLINE_CONTEXT (context)) \
370 || (((constraint) & NEXT_ENDBUF_CONSTRAINT) && !IS_ENDBUF_CONTEXT (context)))
372 struct re_dfastate_t
374 unsigned int hash;
375 re_node_set nodes;
376 re_node_set *entrance_nodes;
377 struct re_dfastate_t **trtable;
378 struct re_dfastate_t **trtable_search;
379 /* If this state is a special state.
380 A state is a special state if the state is the halt state, or
381 a anchor. */
382 unsigned int context : 2;
383 unsigned int halt : 1;
384 /* If this state can accept `multi byte'.
385 Note that we refer to multibyte characters, and multi character
386 collating elements as `multi byte'. */
387 unsigned int accept_mb : 1;
388 /* If this state has backreference node(s). */
389 unsigned int has_backref : 1;
390 unsigned int has_constraint : 1;
392 typedef struct re_dfastate_t re_dfastate_t;
394 typedef struct
396 /* start <= node < end */
397 int start;
398 int end;
399 } re_subexp_t;
401 struct re_state_table_entry
403 int num;
404 int alloc;
405 re_dfastate_t **array;
408 struct re_backref_cache_entry
410 int node;
411 int from;
412 int to;
413 int flag;
416 typedef struct
418 /* EFLAGS of the argument of regexec. */
419 int eflags;
420 /* Where the matching ends. */
421 int match_last;
422 /* The string object corresponding to the input string. */
423 re_string_t *input;
424 /* The state log used by the matcher. */
425 re_dfastate_t **state_log;
426 int state_log_top;
427 /* Back reference cache. */
428 int nbkref_ents;
429 int abkref_ents;
430 struct re_backref_cache_entry *bkref_ents;
431 int max_bkref_len;
432 } re_match_context_t;
434 struct re_dfa_t
436 re_bitset_ptr_t word_char;
438 /* number of subexpressions `re_nsub' is in regex_t. */
439 int subexps_alloc;
440 re_subexp_t *subexps;
442 re_token_t *nodes;
443 int nodes_alloc;
444 int nodes_len;
445 bin_tree_t *str_tree;
446 int *firsts;
447 int *nexts;
448 re_node_set *edests;
449 re_node_set *eclosures;
450 re_node_set *inveclosures;
451 struct re_state_table_entry *state_table;
452 unsigned int state_hash_mask;
453 re_dfastate_t *init_state;
454 re_dfastate_t *init_state_word;
455 re_dfastate_t *init_state_nl;
456 re_dfastate_t *init_state_begbuf;
457 int states_alloc;
458 int init_node;
459 int nbackref; /* The number of backreference in this dfa. */
460 /* If this dfa has "multibyte node", which is a backreference or
461 a node which can accept multibyte character or multi character
462 collating element. */
463 unsigned int has_mb_node : 1;
465 typedef struct re_dfa_t re_dfa_t;
467 static reg_errcode_t re_node_set_alloc (re_node_set *set, int size);
468 static reg_errcode_t re_node_set_init_1 (re_node_set *set, int elem);
469 static reg_errcode_t re_node_set_init_2 (re_node_set *set, int elem1,
470 int elem2);
471 #define re_node_set_init_empty(set) memset (set, '\0', sizeof (re_node_set))
472 static reg_errcode_t re_node_set_init_copy (re_node_set *dest,
473 const re_node_set *src);
474 static reg_errcode_t re_node_set_intersect (re_node_set *dest,
475 const re_node_set *src1,
476 const re_node_set *src2);
477 static reg_errcode_t re_node_set_add_intersect (re_node_set *dest,
478 const re_node_set *src1,
479 const re_node_set *src2);
480 static reg_errcode_t re_node_set_init_union (re_node_set *dest,
481 const re_node_set *src1,
482 const re_node_set *src2);
483 static reg_errcode_t re_node_set_merge (re_node_set *dest,
484 const re_node_set *src);
485 static int re_node_set_insert (re_node_set *set, int elem);
486 static int re_node_set_compare (const re_node_set *set1,
487 const re_node_set *set2);
488 static int re_node_set_contains (const re_node_set *set, int elem);
489 static void re_node_set_remove_at (re_node_set *set, int idx);
490 #define re_node_set_empty(p) ((p)->nelem = 0)
491 #define re_node_set_free(set) re_free ((set)->elems)
492 static int re_dfa_add_node (re_dfa_t *dfa, re_token_t token, int mode);
493 static re_dfastate_t *re_acquire_state (reg_errcode_t *err, re_dfa_t *dfa,
494 const re_node_set *nodes);
495 static re_dfastate_t *re_acquire_state_context (reg_errcode_t *err,
496 re_dfa_t *dfa,
497 const re_node_set *nodes,
498 unsigned int context);
501 typedef enum
503 SB_CHAR,
504 MB_CHAR,
505 EQUIV_CLASS,
506 COLL_SYM,
507 CHAR_CLASS
508 } bracket_elem_type;
510 typedef struct
512 bracket_elem_type type;
513 union
515 unsigned char ch;
516 unsigned char *name;
517 wchar_t wch;
518 } opr;
519 } bracket_elem_t;
522 /* Inline functions for bitset operation. */
523 static inline void
524 bitset_not (set)
525 bitset set;
527 int bitset_i;
528 for (bitset_i = 0; bitset_i < BITSET_UINTS; ++bitset_i)
529 set[bitset_i] = ~set[bitset_i];
532 static inline void
533 bitset_merge (dest, src)
534 bitset dest;
535 const bitset src;
537 int bitset_i;
538 for (bitset_i = 0; bitset_i < BITSET_UINTS; ++bitset_i)
539 dest[bitset_i] |= src[bitset_i];
542 static inline void
543 bitset_not_merge (dest, src)
544 bitset dest;
545 const bitset src;
547 int i;
548 for (i = 0; i < BITSET_UINTS; ++i)
549 dest[i] |= ~src[i];
552 #ifdef RE_ENABLE_I18N
553 /* Inline functions for re_string. */
554 static inline int
555 re_string_char_size_at (pstr, idx)
556 const re_string_t *pstr;
557 int idx;
559 int byte_idx;
560 if (MB_CUR_MAX == 1)
561 return 1;
562 for (byte_idx = 1; idx + byte_idx < pstr->len; ++byte_idx)
563 if (pstr->wcs[idx + byte_idx] != WEOF)
564 break;
565 return byte_idx;
568 static inline wint_t
569 re_string_wchar_at (pstr, idx)
570 const re_string_t *pstr;
571 int idx;
573 if (MB_CUR_MAX == 1)
574 return (wint_t) pstr->mbs[idx];
575 return (wint_t) pstr->wcs[idx];
578 static int
579 re_string_elem_size_at (pstr, idx)
580 const re_string_t *pstr;
581 int idx;
583 #ifdef _LIBC
584 const unsigned char *p;
585 const char *extra;
586 const int32_t *table, *indirect;
587 int32_t tmp;
588 # include <locale/weight.h>
589 uint_fast32_t nrules = _NL_CURRENT_WORD (LC_COLLATE, _NL_COLLATE_NRULES);
591 if (nrules != 0)
593 table = (const int32_t *) _NL_CURRENT (LC_COLLATE, _NL_COLLATE_TABLEMB);
594 extra = (const char *) _NL_CURRENT (LC_COLLATE, _NL_COLLATE_EXTRAMB);
595 indirect = (const int32_t *) _NL_CURRENT (LC_COLLATE,
596 _NL_COLLATE_INDIRECTMB);
597 p = pstr->mbs + idx;
598 tmp = findidx (&p);
599 return p - (const unsigned char *) pstr->mbs - idx;
601 else
602 #endif /* _LIBC */
603 return 1;
605 #endif /* RE_ENABLE_I18N */
607 #endif /* _REGEX_INTERNAL_H */