lib/mbswidth.h

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