git.cworth.org Git - tar/blob - gnu/mbuiter.h

   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, 2010 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 3 of the License, or
   9    (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 /* Written by Bruno Haible <bruno@clisp.org>.  */
  20
  21 /* The macros in this file implement forward iteration through a
  22    multi-byte string, without knowing its length a-priori.
  23
  24    With these macros, an iteration loop that looks like
  25
  26       char *iter;
  27       for (iter = buf; *iter != '\0'; iter++)
  28         {
  29           do_something (*iter);
  30         }
  31
  32    becomes
  33
  34       mbui_iterator_t iter;
  35       for (mbui_init (iter, buf); mbui_avail (iter); mbui_advance (iter))
  36         {
  37           do_something (mbui_cur_ptr (iter), mb_len (mbui_cur (iter)));
  38         }
  39
  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.
  44
  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.
  52
  53    mbui_iterator_t
  54      is a type usable for variable declarations.
  55
  56    mbui_init (iter, startptr)
  57      initializes the iterator, starting at startptr.
  58
  59    mbui_avail (iter)
  60      returns true if there are more multibyte chracters available before
  61      the end of string is reached. In this case, mbui_cur (iter) is
  62      initialized to the next multibyte chracter.
  63
  64    mbui_advance (iter)
  65      advances the iterator by one multibyte character.
  66
  67    mbui_cur (iter)
  68      returns the current multibyte character, of type mbchar_t.  All the
  69      macros defined in mbchar.h can be used on it.
  70
  71    mbui_cur_ptr (iter)
  72      return a pointer to the beginning of the current multibyte character.
  73
  74    mbui_reloc (iter, ptrdiff)
  75      relocates iterator when the string is moved by ptrdiff bytes.
  76
  77    mbui_copy (&destiter, &srciter)
  78      copies srciter to destiter.
  79
  80    Here are the function prototypes of the macros.
  81
  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);
  89  */
  90
  91 #ifndef _MBUITER_H
  92 #define _MBUITER_H 1
  93
  94 #include <assert.h>
  95 #include <stdbool.h>
  96 #include <stddef.h>
  97 #include <stdlib.h>
  98 #include <string.h>
  99
 100 /* Tru64 with Desktop Toolkit C has a bug: <stdio.h> must be included before
 101    <wchar.h>.
 102    BSD/OS 4.1 has a bug: <stdio.h> and <time.h> must be included before
 103    <wchar.h>.  */
 104 #include <stdio.h>
 105 #include <time.h>
 106 #include <wchar.h>
 107
 108 #include "mbchar.h"
 109 #include "strnlen1.h"
 110
 111 struct mbuiter_multi
 112 {
 113   bool in_shift;        /* true if next byte may not be interpreted as ASCII */
 114   mbstate_t state;      /* if in_shift: current shift state */
 115   bool next_done;       /* true if mbui_avail has already filled the following */
 116   struct mbchar cur;    /* the current character:
 117         const char *cur.ptr             pointer to current character
 118         The following are only valid after mbui_avail.
 119         size_t cur.bytes                number of bytes of current character
 120         bool cur.wc_valid               true if wc is a valid wide character
 121         wchar_t cur.wc                  if wc_valid: the current character
 122         */
 123 };
 124
 125 static inline void
 126 mbuiter_multi_next (struct mbuiter_multi *iter)
 127 {
 128   if (iter->next_done)
 129     return;
 130   if (iter->in_shift)
 131     goto with_shift;
 132   /* Handle most ASCII characters quickly, without calling mbrtowc().  */
 133   if (is_basic (*iter->cur.ptr))
 134     {
 135       /* These characters are part of the basic character set.  ISO C 99
 136          guarantees that their wide character code is identical to their
 137          char code.  */
 138       iter->cur.bytes = 1;
 139       iter->cur.wc = *iter->cur.ptr;
 140       iter->cur.wc_valid = true;
 141     }
 142   else
 143     {
 144       assert (mbsinit (&iter->state));
 145       iter->in_shift = true;
 146     with_shift:
 147       iter->cur.bytes = mbrtowc (&iter->cur.wc, iter->cur.ptr,
 148                                  strnlen1 (iter->cur.ptr, MB_CUR_MAX),
 149                                  &iter->state);
 150       if (iter->cur.bytes == (size_t) -1)
 151         {
 152           /* An invalid multibyte sequence was encountered.  */
 153           iter->cur.bytes = 1;
 154           iter->cur.wc_valid = false;
 155           /* Whether to set iter->in_shift = false and reset iter->state
 156              or not is not very important; the string is bogus anyway.  */
 157         }
 158       else if (iter->cur.bytes == (size_t) -2)
 159         {
 160           /* An incomplete multibyte character at the end.  */
 161           iter->cur.bytes = strlen (iter->cur.ptr);
 162           iter->cur.wc_valid = false;
 163           /* Whether to set iter->in_shift = false and reset iter->state
 164              or not is not important; the string end is reached anyway.  */
 165         }
 166       else
 167         {
 168           if (iter->cur.bytes == 0)
 169             {
 170               /* A null wide character was encountered.  */
 171               iter->cur.bytes = 1;
 172               assert (*iter->cur.ptr == '\0');
 173               assert (iter->cur.wc == 0);
 174             }
 175           iter->cur.wc_valid = true;
 176
 177           /* When in the initial state, we can go back treating ASCII
 178              characters more quickly.  */
 179           if (mbsinit (&iter->state))
 180             iter->in_shift = false;
 181         }
 182     }
 183   iter->next_done = true;
 184 }
 185
 186 static inline void
 187 mbuiter_multi_reloc (struct mbuiter_multi *iter, ptrdiff_t ptrdiff)
 188 {
 189   iter->cur.ptr += ptrdiff;
 190 }
 191
 192 static inline void
 193 mbuiter_multi_copy (struct mbuiter_multi *new_iter, const struct mbuiter_multi *old_iter)
 194 {
 195   if ((new_iter->in_shift = old_iter->in_shift))
 196     memcpy (&new_iter->state, &old_iter->state, sizeof (mbstate_t));
 197   else
 198     memset (&new_iter->state, 0, sizeof (mbstate_t));
 199   new_iter->next_done = old_iter->next_done;
 200   mb_copy (&new_iter->cur, &old_iter->cur);
 201 }
 202
 203 /* Iteration macros.  */
 204 typedef struct mbuiter_multi mbui_iterator_t;
 205 #define mbui_init(iter, startptr) \
 206   ((iter).cur.ptr = (startptr), \
 207    (iter).in_shift = false, memset (&(iter).state, '\0', sizeof (mbstate_t)), \
 208    (iter).next_done = false)
 209 #define mbui_avail(iter) \
 210   (mbuiter_multi_next (&(iter)), !mb_isnul ((iter).cur))
 211 #define mbui_advance(iter) \
 212   ((iter).cur.ptr += (iter).cur.bytes, (iter).next_done = false)
 213
 214 /* Access to the current character.  */
 215 #define mbui_cur(iter) (iter).cur
 216 #define mbui_cur_ptr(iter) (iter).cur.ptr
 217
 218 /* Relocation.  */
 219 #define mbui_reloc(iter, ptrdiff) mbuiter_multi_reloc (&iter, ptrdiff)
 220
 221 /* Copying an iterator.  */
 222 #define mbui_copy mbuiter_multi_copy
 223
 224 #endif /* _MBUITER_H */