lib/mbswidth.h

   1 /* Determine the number of screen columns needed for a string.
   2    Copyright (C) 2000-2004, 2007, 2009-2021 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 3 of the License, or
   7    (at your option) 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, see <https://www.gnu.org/licenses/>.  */
  16
  17 #include <stddef.h>
  18
  19 /* Avoid a clash of our mbswidth() with a function of the same name defined
  20    in UnixWare 7.1.1 <wchar.h>.  We need this #include before the #define
  21    below.  */
  22 #if HAVE_DECL_MBSWIDTH_IN_WCHAR_H
  23 # include <wchar.h>
  24 #endif
  25
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31
  32 /* Optional flags to influence mbswidth/mbsnwidth behavior.  */
  33
  34 /* If this bit is set, return -1 upon finding an invalid or incomplete
  35    character.  Otherwise, assume invalid characters have width 1.  */
  36 #define MBSW_REJECT_INVALID 1
  37
  38 /* If this bit is set, return -1 upon finding a non-printable character.
  39    Otherwise, assume unprintable characters have width 0 if they are
  40    control characters and 1 otherwise.  */
  41 #define MBSW_REJECT_UNPRINTABLE 2
  42
  43
  44 /* Returns the number of screen columns needed for STRING.  */
  45 #define mbswidth gnu_mbswidth  /* avoid clash with UnixWare 7.1.1 function */
  46 extern int mbswidth (const char *string, int flags);
  47
  48 /* Returns the number of screen columns needed for the NBYTES bytes
  49    starting at BUF.  */
  50 extern int mbsnwidth (const char *buf, size_t nbytes, int flags);
  51
  52
  53 #ifdef __cplusplus
  54 }
  55 #endif