Tweak comments, per Bruno's comments.
[gnulib.git] / lib / mbswidth.h
1 /* Determine the number of screen columns needed for a string.
2    Copyright (C) 2000 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 #ifndef PARAMS
19 # if defined PROTOTYPES || defined __STDC__
20 #  define PARAMS(Args) Args
21 # else
22 #  define PARAMS(Args) ()
23 # endif
24 #endif
25
26 /* Optional flags to influence mbswidth/mbsnwidth behavior.  */
27
28 /* Assume invalid characters have width 0.  If this bit is not set,
29    return -1 upon finding an invalid or incomplete character.  */
30 #define MBSW_ACCEPT_INVALID 1
31
32 /* Assume unprintable characters have width 1.  If this bit is not set,
33    return -1 upon finding a non-printable character.  */
34 #define MBSW_ACCEPT_UNPRINTABLE 2
35
36 /* Returns the number of screen columns needed for STRING.  */
37 extern int mbswidth PARAMS ((const char *string, int flags));
38
39 /* Returns the number of screen columns needed for the NBYTES bytes
40    starting at BUF.  */
41 extern int mbsnwidth PARAMS ((const char *buf, size_t nbytes, int flags));