lib/mbswidth.c

   1 /* Determine the number of screen columns needed for a string.
   2    Copyright (C) 2000-2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /* Specification.  */
  25 #include "mbswidth.h"
  26
  27 /* Get MB_CUR_MAX.  */
  28 #include <stdlib.h>
  29
  30 #include <string.h>
  31
  32 /* Get isprint().  */
  33 #include <ctype.h>
  34
  35 /* Get mbstate_t, mbrtowc(), mbsinit().  */
  36 #if HAVE_WCHAR_H
  37 /* Tru64 with Desktop Toolkit C has a bug: <stdio.h> must be included before
  38    <wchar.h>.
  39    BSD/OS 4.1 has a bug: <stdio.h> and <time.h> must be included before
  40    <wchar.h>.  */
  41 # include <stdio.h>
  42 # include <time.h>
  43 # include <wchar.h>
  44 #endif
  45
  46 /* Get wcwidth().  */
  47 #include "wcwidth.h"
  48
  49 /* Get iswcntrl().  */
  50 #if HAVE_WCTYPE_H
  51 # include <wctype.h>
  52 #endif
  53 #if !defined iswcntrl && !HAVE_ISWCNTRL
  54 # define iswcntrl(wc) 0
  55 #endif
  56
  57 #ifndef mbsinit
  58 # if !HAVE_MBSINIT
  59 #  define mbsinit(ps) 1
  60 # endif
  61 #endif
  62
  63 /* Returns the number of columns needed to represent the multibyte
  64    character string pointed to by STRING.  If a non-printable character
  65    occurs, and MBSW_REJECT_UNPRINTABLE is specified, -1 is returned.
  66    With flags = MBSW_REJECT_INVALID | MBSW_REJECT_UNPRINTABLE, this is
  67    the multibyte analogue of the wcswidth function.
  68    If STRING is not of length < INT_MAX / 2, integer overflow can occur.  */
  69 int
  70 mbswidth (const char *string, int flags)
  71 {
  72   return mbsnwidth (string, strlen (string), flags);
  73 }
  74
  75 /* Returns the number of columns needed to represent the multibyte
  76    character string pointed to by STRING of length NBYTES.  If a
  77    non-printable character occurs, and MBSW_REJECT_UNPRINTABLE is
  78    specified, -1 is returned.
  79    If NBYTES is not < INT_MAX / 2, integer overflow can occur.  */
  80 int
  81 mbsnwidth (const char *string, size_t nbytes, int flags)
  82 {
  83   const char *p = string;
  84   const char *plimit = p + nbytes;
  85   int width;
  86
  87   width = 0;
  88 #if HAVE_MBRTOWC
  89   if (MB_CUR_MAX > 1)
  90     {
  91       while (p < plimit)
  92         switch (*p)
  93           {
  94             case ' ': case '!': case '"': case '#': case '%':
  95             case '&': case '\'': case '(': case ')': case '*':
  96             case '+': case ',': case '-': case '.': case '/':
  97             case '0': case '1': case '2': case '3': case '4':
  98             case '5': case '6': case '7': case '8': case '9':
  99             case ':': case ';': case '<': case '=': case '>':
 100             case '?':
 101             case 'A': case 'B': case 'C': case 'D': case 'E':
 102             case 'F': case 'G': case 'H': case 'I': case 'J':
 103             case 'K': case 'L': case 'M': case 'N': case 'O':
 104             case 'P': case 'Q': case 'R': case 'S': case 'T':
 105             case 'U': case 'V': case 'W': case 'X': case 'Y':
 106             case 'Z':
 107             case '[': case '\\': case ']': case '^': case '_':
 108             case 'a': case 'b': case 'c': case 'd': case 'e':
 109             case 'f': case 'g': case 'h': case 'i': case 'j':
 110             case 'k': case 'l': case 'm': case 'n': case 'o':
 111             case 'p': case 'q': case 'r': case 's': case 't':
 112             case 'u': case 'v': case 'w': case 'x': case 'y':
 113             case 'z': case '{': case '|': case '}': case '~':
 114               /* These characters are printable ASCII characters.  */
 115               p++;
 116               width++;
 117               break;
 118             default:
 119               /* If we have a multibyte sequence, scan it up to its end.  */
 120               {
 121                 mbstate_t mbstate;
 122                 memset (&mbstate, 0, sizeof mbstate);
 123                 do
 124                   {
 125                     wchar_t wc;
 126                     size_t bytes;
 127                     int w;
 128
 129                     bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
 130
 131                     if (bytes == (size_t) -1)
 132                       /* An invalid multibyte sequence was encountered.  */
 133                       {
 134                         if (!(flags & MBSW_REJECT_INVALID))
 135                           {
 136                             p++;
 137                             width++;
 138                             break;
 139                           }
 140                         else
 141                           return -1;
 142                       }
 143
 144                     if (bytes == (size_t) -2)
 145                       /* An incomplete multibyte character at the end.  */
 146                       {
 147                         if (!(flags & MBSW_REJECT_INVALID))
 148                           {
 149                             p = plimit;
 150                             width++;
 151                             break;
 152                           }
 153                         else
 154                           return -1;
 155                       }
 156
 157                     if (bytes == 0)
 158                       /* A null wide character was encountered.  */
 159                       bytes = 1;
 160
 161                     w = wcwidth (wc);
 162                     if (w >= 0)
 163                       /* A printable multibyte character.  */
 164                       width += w;
 165                     else
 166                       /* An unprintable multibyte character.  */
 167                       if (!(flags & MBSW_REJECT_UNPRINTABLE))
 168                         width += (iswcntrl (wc) ? 0 : 1);
 169                       else
 170                         return -1;
 171
 172                     p += bytes;
 173                   }
 174                 while (! mbsinit (&mbstate));
 175               }
 176               break;
 177           }
 178       return width;
 179     }
 180 #endif
 181
 182   while (p < plimit)
 183     {
 184       unsigned char c = (unsigned char) *p++;
 185
 186       if (isprint (c))
 187         width++;
 188       else if (!(flags & MBSW_REJECT_UNPRINTABLE))
 189         width += (iscntrl (c) ? 0 : 1);
 190       else
 191         return -1;
 192     }
 193   return width;
 194 }