Sync usage with man page.
[netbsd-mini2440.git] / gnu / dist / gettext / gettext-tools / lib / mbswidth.h
blob4fcdb2096ae17033a0045604880ef50881fd1f71
1 /* Determine the number of screen columns needed for a string.
2 Copyright (C) 2000-2004 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 #include <stddef.h>
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 However, we don't want to #include <wchar.h> on all platforms because
24 - Tru64 with Desktop Toolkit C has a bug: <stdio.h> must be included before
25 <wchar.h>.
26 - BSD/OS 4.1 has a bug: <stdio.h> and <time.h> must be included before
27 <wchar.h>. */
28 #if HAVE_DECL_MBSWIDTH_IN_WCHAR_H
29 # include <wchar.h>
30 #endif
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
38 /* Optional flags to influence mbswidth/mbsnwidth behavior. */
40 /* If this bit is set, return -1 upon finding an invalid or incomplete
41 character. Otherwise, assume invalid characters have width 1. */
42 #define MBSW_REJECT_INVALID 1
44 /* If this bit is set, return -1 upon finding a non-printable character.
45 Otherwise, assume unprintable characters have width 0 if they are
46 control characters and 1 otherwise. */
47 #define MBSW_REJECT_UNPRINTABLE 2
50 /* Returns the number of screen columns needed for STRING. */
51 #define mbswidth gnu_mbswidth /* avoid clash with UnixWare 7.1.1 function */
52 extern int mbswidth (const char *string, int flags);
54 /* Returns the number of screen columns needed for the NBYTES bytes
55 starting at BUF. */
56 extern int mbsnwidth (const char *buf, size_t nbytes, int flags);
59 #ifdef __cplusplus
61 #endif