Branch
Hash :
7b089321
Author :
Date :
2025-01-01T09:24:36
maint: run 'make update-copyright'
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
/* Iterating through multibyte strings: macros for multi-byte encodings.
Copyright (C) 2001, 2005, 2007, 2009-2025 Free Software Foundation, Inc.
This file is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This file is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. */
/* Written by Bruno Haible <bruno@clisp.org>. */
/* The macros in this file implement forward iteration through a
multi-byte string.
With these macros, an iteration loop that looks like
char *iter;
for (iter = buf; iter < buf + buflen; iter++)
{
do_something (*iter);
}
becomes
mbi_iterator_t iter;
for (mbi_init (iter, buf, buflen); mbi_avail (iter); mbi_advance (iter))
{
do_something (mbi_cur_ptr (iter), mb_len (mbi_cur (iter)));
}
The benefit of these macros over plain use of mbrtowc is:
- Handling of invalid multibyte sequences is possible without
making the code more complicated, while still preserving the
invalid multibyte sequences.
mbi_iterator_t
is a type usable for variable declarations.
mbi_init (iter, startptr, length)
initializes the iterator, starting at startptr and crossing length bytes.
mbi_avail (iter)
returns true if there are more multibyte characters available before
the end of string is reached. In this case, mbi_cur (iter) is
initialized to the next multibyte character.
mbi_advance (iter)
advances the iterator by one multibyte character.
mbi_cur (iter)
returns the current multibyte character, of type mbchar_t. All the
macros defined in mbchar.h can be used on it.
mbi_cur_ptr (iter)
return a pointer to the beginning of the current multibyte character.
mbi_reloc (iter, ptrdiff)
relocates iterator when the string is moved by ptrdiff bytes.
mbi_copy (&destiter, &srciter)
copies srciter to destiter.
Here are the function prototypes of the macros.
extern void mbi_init (mbi_iterator_t iter,
const char *startptr, size_t length);
extern bool mbi_avail (mbi_iterator_t iter);
extern void mbi_advance (mbi_iterator_t iter);
extern mbchar_t mbi_cur (mbi_iterator_t iter);
extern const char * mbi_cur_ptr (mbi_iterator_t iter);
extern void mbi_reloc (mbi_iterator_t iter, ptrdiff_t ptrdiff);
extern void mbi_copy (mbi_iterator_t *new, const mbi_iterator_t *old);
*/
#ifndef _MBITER_H
#define _MBITER_H 1
/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE,
_GL_ATTRIBUTE_ALWAYS_INLINE. */
#if !_GL_CONFIG_H_INCLUDED
#error "Please include config.h first."
#endif
#include <assert.h>
#include <stddef.h>
#include <string.h>
#include <uchar.h>
#include <wchar.h>
#include "mbchar.h"
_GL_INLINE_HEADER_BEGIN
#ifndef MBITER_INLINE
# define MBITER_INLINE _GL_INLINE _GL_ATTRIBUTE_ALWAYS_INLINE
#endif
#ifdef __cplusplus
extern "C" {
#endif
struct mbiter_multi
{
const char *limit; /* pointer to end of string */
#if !GNULIB_MBRTOC32_REGULAR
bool in_shift; /* true if next byte may not be interpreted as ASCII */
/* If GNULIB_MBRTOC32_REGULAR, it is always false,
so optimize it away. */
#endif
mbstate_t state; /* if in_shift: current shift state */
/* If GNULIB_MBRTOC32_REGULAR, it is in an initial state
before and after every mbiter_multi_next invocation.
*/
bool next_done; /* true if mbi_avail has already filled the following */
struct mbchar cur; /* the current character:
const char *cur.ptr pointer to current character
The following are only valid after mbi_avail.
size_t cur.bytes number of bytes of current character
bool cur.wc_valid true if wc is a valid 32-bit wide character
char32_t cur.wc if wc_valid: the current character
*/
};
MBITER_INLINE void
mbiter_multi_next (struct mbiter_multi *iter)
{
if (iter->next_done)
return;
#if !GNULIB_MBRTOC32_REGULAR
if (iter->in_shift)
goto with_shift;
#endif
/* Handle most ASCII characters quickly, without calling mbrtowc(). */
if (is_basic (*iter->cur.ptr))
{
/* These characters are part of the POSIX portable character set.
For most of them, namely those in the ISO C basic character set,
ISO C 99 guarantees that their wide character code is identical to
their char code. For the few other ones, this is the case as well,
in all locale encodings that are in use. The 32-bit wide character
code is the same as well. */
iter->cur.bytes = 1;
iter->cur.wc = *iter->cur.ptr;
iter->cur.wc_valid = true;
}
else
{
assert (mbsinit (&iter->state));
#if !GNULIB_MBRTOC32_REGULAR
iter->in_shift = true;
with_shift:
#endif
iter->cur.bytes = mbrtoc32 (&iter->cur.wc, iter->cur.ptr,
iter->limit - iter->cur.ptr, &iter->state);
if (iter->cur.bytes == (size_t) -1)
{
/* An invalid multibyte sequence was encountered. */
iter->cur.bytes = 1;
iter->cur.wc_valid = false;
/* Allow the next invocation to continue from a sane state. */
#if !GNULIB_MBRTOC32_REGULAR
iter->in_shift = false;
#endif
mbszero (&iter->state);
}
else if (iter->cur.bytes == (size_t) -2)
{
/* An incomplete multibyte character at the end. */
iter->cur.bytes = iter->limit - iter->cur.ptr;
iter->cur.wc_valid = false;
#if !GNULIB_MBRTOC32_REGULAR
/* Cause the next mbi_avail invocation to return false. */
iter->in_shift = false;
#endif
/* Whether to reset iter->state or not is not important; the
string end is reached anyway. */
}
else
{
if (iter->cur.bytes == 0)
{
/* A null wide character was encountered. */
iter->cur.bytes = 1;
assert (*iter->cur.ptr == '\0');
assert (iter->cur.wc == 0);
}
#if !GNULIB_MBRTOC32_REGULAR
else if (iter->cur.bytes == (size_t) -3)
/* The previous multibyte sequence produced an additional 32-bit
wide character. */
iter->cur.bytes = 0;
#endif
iter->cur.wc_valid = true;
/* When in an initial state, we can go back treating ASCII
characters more quickly. */
#if !GNULIB_MBRTOC32_REGULAR
if (mbsinit (&iter->state))
iter->in_shift = false;
#endif
}
}
iter->next_done = true;
}
MBITER_INLINE void
mbiter_multi_reloc (struct mbiter_multi *iter, ptrdiff_t ptrdiff)
{
iter->cur.ptr += ptrdiff;
iter->limit += ptrdiff;
}
MBITER_INLINE void
mbiter_multi_copy (struct mbiter_multi *new_iter, const struct mbiter_multi *old_iter)
{
new_iter->limit = old_iter->limit;
#if !GNULIB_MBRTOC32_REGULAR
if ((new_iter->in_shift = old_iter->in_shift))
memcpy (&new_iter->state, &old_iter->state, sizeof (mbstate_t));
else
#endif
mbszero (&new_iter->state);
new_iter->next_done = old_iter->next_done;
mb_copy (&new_iter->cur, &old_iter->cur);
}
/* Iteration macros. */
typedef struct mbiter_multi mbi_iterator_t;
#if !GNULIB_MBRTOC32_REGULAR
#define mbi_init(iter, startptr, length) \
((iter).cur.ptr = (startptr), (iter).limit = (iter).cur.ptr + (length), \
(iter).in_shift = false, mbszero (&(iter).state), \
(iter).next_done = false)
#else
/* Optimized: no in_shift. */
#define mbi_init(iter, startptr, length) \
((iter).cur.ptr = (startptr), (iter).limit = (iter).cur.ptr + (length), \
mbszero (&(iter).state), \
(iter).next_done = false)
#endif
#if !GNULIB_MBRTOC32_REGULAR
#define mbi_avail(iter) \
(((iter).cur.ptr < (iter).limit || (iter).in_shift) \
&& (mbiter_multi_next (&(iter)), true))
#else
/* Optimized: no in_shift. */
#define mbi_avail(iter) \
((iter).cur.ptr < (iter).limit \
&& (mbiter_multi_next (&(iter)), true))
#endif
#define mbi_advance(iter) \
((iter).cur.ptr += (iter).cur.bytes, (iter).next_done = false)
/* Access to the current character. */
#define mbi_cur(iter) (iter).cur
#define mbi_cur_ptr(iter) (iter).cur.ptr
/* Relocation. */
#define mbi_reloc(iter, ptrdiff) mbiter_multi_reloc (&iter, ptrdiff)
/* Copying an iterator. */
#define mbi_copy mbiter_multi_copy
#ifdef __cplusplus
}
#endif
_GL_INLINE_HEADER_END
#endif /* _MBITER_H */