lib/mbswidth.c

   1 /* Determine the number of screen columns needed for a string.
   2    Copyright (C) 2000-2002 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 /* Written by Bruno Haible <haible@clisp.cons.org>.  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 /* Get MB_CUR_MAX.  */
  25 #include <stdlib.h>
  26
  27 #include <string.h>
  28
  29 /* Get isprint().  */
  30 #include <ctype.h>
  31
  32 /* Get mbstate_t, mbrtowc(), mbsinit(), wcwidth().  */
  33 #if HAVE_WCHAR_H
  34 # include <wchar.h>
  35 #endif
  36
  37 /* Get iswprint(), iswcntrl().  */
  38 #if HAVE_WCTYPE_H
  39 # include <wctype.h>
  40 #endif
  41 #if !defined iswprint && !HAVE_ISWPRINT
  42 # define iswprint(wc) 1
  43 #endif
  44 #if !defined iswcntrl && !HAVE_ISWCNTRL
  45 # define iswcntrl(wc) 0
  46 #endif
  47
  48 #ifndef mbsinit
  49 # if !HAVE_MBSINIT
  50 #  define mbsinit(ps) 1
  51 # endif
  52 #endif
  53
  54 #ifndef HAVE_DECL_WCWIDTH
  55 "this configure-time declaration test was not run"
  56 #endif
  57 #if !HAVE_DECL_WCWIDTH
  58 int wcwidth ();
  59 #endif
  60
  61 #ifndef wcwidth
  62 # if !HAVE_WCWIDTH
  63 /* wcwidth doesn't exist, so assume all printable characters have
  64    width 1.  */
  65 #  define wcwidth(wc) ((wc) == 0 ? 0 : iswprint (wc) ? 1 : -1)
  66 # endif
  67 #endif
  68
  69 /* Get ISPRINT.  */
  70 #if defined (STDC_HEADERS) || (!defined (isascii) && !defined (HAVE_ISASCII))
  71 # define IN_CTYPE_DOMAIN(c) 1
  72 #else
  73 # define IN_CTYPE_DOMAIN(c) isascii(c)
  74 #endif
  75 /* Undefine to protect against the definition in wctype.h of solaris2.6.   */
  76 #undef ISPRINT
  77 #define ISPRINT(c) (IN_CTYPE_DOMAIN (c) && isprint (c))
  78 #undef ISCNTRL
  79 #define ISCNTRL(c) (IN_CTYPE_DOMAIN (c) && iscntrl (c))
  80
  81 #include "mbswidth.h"
  82
  83 /* Returns the number of columns needed to represent the multibyte
  84    character string pointed to by STRING.  If a non-printable character
  85    occurs, and MBSW_REJECT_UNPRINTABLE is specified, -1 is returned.
  86    With flags = MBSW_REJECT_INVALID | MBSW_REJECT_UNPRINTABLE, this is
  87    the multibyte analogon of the wcswidth function.  */
  88 int
  89 mbswidth (const char *string, int flags)
  90 {
  91   return mbsnwidth (string, strlen (string), flags);
  92 }
  93
  94 /* Returns the number of columns needed to represent the multibyte
  95    character string pointed to by STRING of length NBYTES.  If a
  96    non-printable character occurs, and MBSW_REJECT_UNPRINTABLE is
  97    specified, -1 is returned.  */
  98 int
  99 mbsnwidth (const char *string, size_t nbytes, int flags)
 100 {
 101   const char *p = string;
 102   const char *plimit = p + nbytes;
 103   int width;
 104
 105   width = 0;
 106 #if HAVE_MBRTOWC
 107   if (MB_CUR_MAX > 1)
 108     {
 109       while (p < plimit)
 110         switch (*p)
 111           {
 112             case ' ': case '!': case '"': case '#': case '%':
 113             case '&': case '\'': case '(': case ')': case '*':
 114             case '+': case ',': case '-': case '.': case '/':
 115             case '0': case '1': case '2': case '3': case '4':
 116             case '5': case '6': case '7': case '8': case '9':
 117             case ':': case ';': case '<': case '=': case '>':
 118             case '?':
 119             case 'A': case 'B': case 'C': case 'D': case 'E':
 120             case 'F': case 'G': case 'H': case 'I': case 'J':
 121             case 'K': case 'L': case 'M': case 'N': case 'O':
 122             case 'P': case 'Q': case 'R': case 'S': case 'T':
 123             case 'U': case 'V': case 'W': case 'X': case 'Y':
 124             case 'Z':
 125             case '[': case '\\': case ']': case '^': case '_':
 126             case 'a': case 'b': case 'c': case 'd': case 'e':
 127             case 'f': case 'g': case 'h': case 'i': case 'j':
 128             case 'k': case 'l': case 'm': case 'n': case 'o':
 129             case 'p': case 'q': case 'r': case 's': case 't':
 130             case 'u': case 'v': case 'w': case 'x': case 'y':
 131             case 'z': case '{': case '|': case '}': case '~':
 132               /* These characters are printable ASCII characters.  */
 133               p++;
 134               width++;
 135               break;
 136             default:
 137               /* If we have a multibyte sequence, scan it up to its end.  */
 138               {
 139                 mbstate_t mbstate;
 140                 memset (&mbstate, 0, sizeof mbstate);
 141                 do
 142                   {
 143                     wchar_t wc;
 144                     size_t bytes;
 145                     int w;
 146
 147                     bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
 148
 149                     if (bytes == (size_t) -1)
 150                       /* An invalid multibyte sequence was encountered.  */
 151                       {
 152                         if (!(flags & MBSW_REJECT_INVALID))
 153                           {
 154                             p++;
 155                             width++;
 156                             break;
 157                           }
 158                         else
 159                           return -1;
 160                       }
 161
 162                     if (bytes == (size_t) -2)
 163                       /* An incomplete multibyte character at the end.  */
 164                       {
 165                         if (!(flags & MBSW_REJECT_INVALID))
 166                           {
 167                             p = plimit;
 168                             width++;
 169                             break;
 170                           }
 171                         else
 172                           return -1;
 173                       }
 174
 175                     if (bytes == 0)
 176                       /* A null wide character was encountered.  */
 177                       bytes = 1;
 178
 179                     w = wcwidth (wc);
 180                     if (w >= 0)
 181                       /* A printable multibyte character.  */
 182                       width += w;
 183                     else
 184                       /* An unprintable multibyte character.  */
 185                       if (!(flags & MBSW_REJECT_UNPRINTABLE))
 186                         width += (iswcntrl (wc) ? 0 : 1);
 187                       else
 188                         return -1;
 189
 190                     p += bytes;
 191                   }
 192                 while (! mbsinit (&mbstate));
 193               }
 194               break;
 195           }
 196       return width;
 197     }
 198 #endif
 199
 200   while (p < plimit)
 201     {
 202       unsigned char c = (unsigned char) *p++;
 203
 204       if (ISPRINT (c))
 205         width++;
 206       else if (!(flags & MBSW_REJECT_UNPRINTABLE))
 207         width += (ISCNTRL (c) ? 0 : 1);
 208       else
 209         return -1;
 210     }
 211   return width;
 212 }