1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* Iterating through multibyte strings: macros for multi-byte encodings.
4 Copyright (C) 2001, 2005, 2007, 2009-2013 Free Software Foundation, Inc.
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 3 of the License, or
9 (at your option) any later version.
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.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 /* Written by Bruno Haible <bruno@clisp.org>. */
21 /* The macros in this file implement forward iteration through a
22 multi-byte string, without knowing its length a-priori.
24 With these macros, an iteration loop that looks like
27 for (iter = buf; *iter != '\0'; iter++)
35 for (mbui_init (iter, buf); mbui_avail (iter); mbui_advance (iter))
37 do_something (mbui_cur_ptr (iter), mb_len (mbui_cur (iter)));
40 The benefit of these macros over plain use of mbrtowc is:
41 - Handling of invalid multibyte sequences is possible without
42 making the code more complicated, while still preserving the
43 invalid multibyte sequences.
45 Compared to mbiter.h, the macros here don't need to know the string's
46 length a-priori. The downside is that at each step, the look-ahead
47 that guards against overrunning the terminating '\0' is more expensive.
48 The mbui_* macros are therefore suitable when there is a high probability
49 that only the first few multibyte characters need to be inspected.
50 Whereas the mbi_* macros are better if usually the iteration runs
51 through the entire string.
54 is a type usable for variable declarations.
56 mbui_init (iter, startptr)
57 initializes the iterator, starting at startptr.
60 returns true if there are more multibyte characters available before
61 the end of string is reached. In this case, mbui_cur (iter) is
62 initialized to the next multibyte character.
65 advances the iterator by one multibyte character.
68 returns the current multibyte character, of type mbchar_t. All the
69 macros defined in mbchar.h can be used on it.
72 return a pointer to the beginning of the current multibyte character.
74 mbui_reloc (iter, ptrdiff)
75 relocates iterator when the string is moved by ptrdiff bytes.
77 mbui_copy (&destiter, &srciter)
78 copies srciter to destiter.
80 Here are the function prototypes of the macros.
82 extern void mbui_init (mbui_iterator_t iter, const char *startptr);
83 extern bool mbui_avail (mbui_iterator_t iter);
84 extern void mbui_advance (mbui_iterator_t iter);
85 extern mbchar_t mbui_cur (mbui_iterator_t iter);
86 extern const char * mbui_cur_ptr (mbui_iterator_t iter);
87 extern void mbui_reloc (mbui_iterator_t iter, ptrdiff_t ptrdiff);
88 extern void mbui_copy (mbui_iterator_t *new, const mbui_iterator_t *old);
100 /* Tru64 with Desktop Toolkit C has a bug: <stdio.h> must be included before
102 BSD/OS 4.1 has a bug: <stdio.h> and <time.h> must be included before
109 #include "strnlen1.h"
111 _GL_INLINE_HEADER_BEGIN
112 #ifndef MBUITER_INLINE
113 # define MBUITER_INLINE _GL_INLINE
118 bool in_shift; /* true if next byte may not be interpreted as ASCII */
119 mbstate_t state; /* if in_shift: current shift state */
120 bool next_done; /* true if mbui_avail has already filled the following */
121 struct mbchar cur; /* the current character:
122 const char *cur.ptr pointer to current character
123 The following are only valid after mbui_avail.
124 size_t cur.bytes number of bytes of current character
125 bool cur.wc_valid true if wc is a valid wide character
126 wchar_t cur.wc if wc_valid: the current character
131 mbuiter_multi_next (struct mbuiter_multi *iter)
137 /* Handle most ASCII characters quickly, without calling mbrtowc(). */
138 if (is_basic (*iter->cur.ptr))
140 /* These characters are part of the basic character set. ISO C 99
141 guarantees that their wide character code is identical to their
144 iter->cur.wc = *iter->cur.ptr;
145 iter->cur.wc_valid = true;
149 assert (mbsinit (&iter->state));
150 iter->in_shift = true;
152 iter->cur.bytes = mbrtowc (&iter->cur.wc, iter->cur.ptr,
153 strnlen1 (iter->cur.ptr, MB_CUR_MAX),
155 if (iter->cur.bytes == (size_t) -1)
157 /* An invalid multibyte sequence was encountered. */
159 iter->cur.wc_valid = false;
160 /* Whether to set iter->in_shift = false and reset iter->state
161 or not is not very important; the string is bogus anyway. */
163 else if (iter->cur.bytes == (size_t) -2)
165 /* An incomplete multibyte character at the end. */
166 iter->cur.bytes = strlen (iter->cur.ptr);
167 iter->cur.wc_valid = false;
168 /* Whether to set iter->in_shift = false and reset iter->state
169 or not is not important; the string end is reached anyway. */
173 if (iter->cur.bytes == 0)
175 /* A null wide character was encountered. */
177 assert (*iter->cur.ptr == '\0');
178 assert (iter->cur.wc == 0);
180 iter->cur.wc_valid = true;
182 /* When in the initial state, we can go back treating ASCII
183 characters more quickly. */
184 if (mbsinit (&iter->state))
185 iter->in_shift = false;
188 iter->next_done = true;
192 mbuiter_multi_reloc (struct mbuiter_multi *iter, ptrdiff_t ptrdiff)
194 iter->cur.ptr += ptrdiff;
198 mbuiter_multi_copy (struct mbuiter_multi *new_iter, const struct mbuiter_multi *old_iter)
200 if ((new_iter->in_shift = old_iter->in_shift))
201 memcpy (&new_iter->state, &old_iter->state, sizeof (mbstate_t));
203 memset (&new_iter->state, 0, sizeof (mbstate_t));
204 new_iter->next_done = old_iter->next_done;
205 mb_copy (&new_iter->cur, &old_iter->cur);
208 /* Iteration macros. */
209 typedef struct mbuiter_multi mbui_iterator_t;
210 #define mbui_init(iter, startptr) \
211 ((iter).cur.ptr = (startptr), \
212 (iter).in_shift = false, memset (&(iter).state, '\0', sizeof (mbstate_t)), \
213 (iter).next_done = false)
214 #define mbui_avail(iter) \
215 (mbuiter_multi_next (&(iter)), !mb_isnul ((iter).cur))
216 #define mbui_advance(iter) \
217 ((iter).cur.ptr += (iter).cur.bytes, (iter).next_done = false)
219 /* Access to the current character. */
220 #define mbui_cur(iter) (iter).cur
221 #define mbui_cur_ptr(iter) (iter).cur.ptr
224 #define mbui_reloc(iter, ptrdiff) mbuiter_multi_reloc (&iter, ptrdiff)
226 /* Copying an iterator. */
227 #define mbui_copy mbuiter_multi_copy
229 _GL_INLINE_HEADER_END
231 #endif /* _MBUITER_H */