lib/mbswidth.h

   1 /* Determine the number of screen columns needed for a string.
   2    Copyright (C) 2000-2003 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 #include <stddef.h>
  19
  20 /* Avoid a clash of our mbswidth() with a function of the same name defined
  21    in UnixWare 7.1.1 <wchar.h>.  We need this #include before the #define
  22    below.  */
  23 #if HAVE_WCHAR_H
  24 # include <wchar.h>
  25 #endif
  26
  27
  28 /* Optional flags to influence mbswidth/mbsnwidth behavior.  */
  29
  30 /* If this bit is set, return -1 upon finding an invalid or incomplete
  31    character.  Otherwise, assume invalid characters have width 1.  */
  32 #define MBSW_REJECT_INVALID 1
  33
  34 /* If this bit is set, return -1 upon finding a non-printable character.
  35    Otherwise, assume unprintable characters have width 0 if they are
  36    control characters and 1 otherwise.  */
  37 #define MBSW_REJECT_UNPRINTABLE 2
  38
  39
  40 /* Returns the number of screen columns needed for STRING.  */
  41 #define mbswidth gnu_mbswidth  /* avoid clash with UnixWare 7.1.1 function */
  42 extern int mbswidth (const char *string, int flags);
  43
  44 /* Returns the number of screen columns needed for the NBYTES bytes
  45    starting at BUF.  */
  46 extern int mbsnwidth (const char *buf, size_t nbytes, int flags);