*** empty log message ***
[gnulib.git] / lib / mbswidth.h
blob38911da00259d5ee8ed1859100fa3c76cc6623fd
1 /* Determine the number of screen columns needed for a string.
2 Copyright (C) 2000-2001 Free Software Foundation, Inc.
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.
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.
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. */
18 #ifndef PARAMS
19 # if defined (__GNUC__) || __STDC__
20 # define PARAMS(Args) Args
21 # else
22 # define PARAMS(Args) ()
23 # endif
24 #endif
26 /* Optional flags to influence mbswidth/mbsnwidth behavior. */
28 /* If this bit is set, return -1 upon finding an invalid or incomplete
29 character. Otherwise, assume invalid characters have width 1. */
30 #define MBSW_REJECT_INVALID 1
32 /* If this bit is set, return -1 upon finding a non-printable character.
33 Otherwise, assume unprintable characters have width 0 if they are
34 control characters and 1 otherwise. */
35 #define MBSW_REJECT_UNPRINTABLE 2
37 /* Returns the number of screen columns needed for STRING. */
38 #define mbswidth gnu_mbswidth /* avoid clash with UnixWare 7.1.1 function */
39 extern int mbswidth PARAMS ((const char *string, int flags));
41 /* Returns the number of screen columns needed for the NBYTES bytes
42 starting at BUF. */
43 extern int mbsnwidth PARAMS ((const char *buf, size_t nbytes, int flags));