chartype.h revision 220220 
1/*	$NetBSD: chartype.h,v 1.6 2010/04/20 02:01:13 christos Exp $	*/
2
3/*-
4 * Copyright (c) 2009 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 *        This product includes software developed by the NetBSD
18 *        Foundation, Inc. and its contributors.
19 * 4. Neither the name of The NetBSD Foundation nor the names of its
20 *    contributors may be used to endorse or promote products derived
21 *    from this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 */
35
36#ifndef _h_chartype_f
37#define _h_chartype_f
38
39
40
41#ifdef WIDECHAR
42
43/* Ideally we should also test the value of the define to see if it
44 * supports non-BMP code points without requiring UTF-16, but nothing
45 * seems to actually advertise this properly, despite Unicode 3.1 having
46 * been around since 2001... */
47#if !defined(__NetBSD__) && !defined(__sun) && !(defined(__APPLE__) && defined(__MACH__))
48#ifndef __STDC_ISO_10646__
49/* In many places it is assumed that the first 127 code points are ASCII
50 * compatible, so ensure wchar_t indeed does ISO 10646 and not some other
51 * funky encoding that could break us in weird and wonderful ways. */
52	#error wchar_t must store ISO 10646 characters
53#endif
54#endif
55
56/* Oh for a <uchar.h> with char32_t and __STDC_UTF_32__ in it...
57 * ref: ISO/IEC DTR 19769
58 */
59#if WCHAR_MAX < INT32_MAX
60#warning Build environment does not support non-BMP characters
61#endif
62
63#define ct_mbtowc            mbtowc
64#define ct_mbtowc_reset      mbtowc(0,0,0)
65#define ct_wctomb            wctomb
66#define ct_wctomb_reset      wctomb(0,0)
67#define ct_wcstombs          wcstombs
68#define ct_mbstowcs          mbstowcs
69
70#define Char			wchar_t
71#define Int			wint_t
72#define FUN(prefix,rest)	prefix ## _w ## rest
73#define FUNW(type)		type ## _w
74#define TYPE(type)		type ## W
75#define FSTR			"%ls"
76#define STR(x) 			L ## x
77#define UC(c)			c
78#define Isalpha(x)  iswalpha(x)
79#define Isalnum(x)  iswalnum(x)
80#define Isgraph(x)  iswgraph(x)
81#define Isspace(x)  iswspace(x)
82#define Isdigit(x)  iswdigit(x)
83#define Iscntrl(x)  iswcntrl(x)
84#define Isprint(x)  iswprint(x)
85
86#define Isupper(x)  iswupper(x)
87#define Islower(x)  iswlower(x)
88#define Toupper(x)  towupper(x)
89#define Tolower(x)  towlower(x)
90
91#define IsASCII(x)  (x < 0x100)
92
93#define Strlen(x)       wcslen(x)
94#define Strchr(s,c)     wcschr(s,c)
95#define Strrchr(s,c)    wcsrchr(s,c)
96#define Strstr(s,v)     wcsstr(s,v)
97#define Strdup(x)       wcsdup(x)
98#define Strcpy(d,s)     wcscpy(d,s)
99#define Strncpy(d,s,n)  wcsncpy(d,s,n)
100#define Strncat(d,s,n)  wcsncat(d,s,n)
101
102#define Strcmp(s,v)     wcscmp(s,v)
103#define Strncmp(s,v,n)  wcsncmp(s,v,n)
104#define Strcspn(s,r)    wcscspn(s,r)
105
106#define Strtol(p,e,b)   wcstol(p,e,b)
107
108#define Width(c)	wcwidth(c)
109
110#else /* NARROW */
111
112#define ct_mbtowc            error
113#define ct_mbtowc_reset
114#define ct_wctomb            error
115#define ct_wctomb_reset
116#define ct_wcstombs(a, b, c)    (strncpy(a, b, c), strlen(a))
117#define ct_mbstowcs(a, b, c)    (strncpy(a, b, c), strlen(a))
118
119#define Char			char
120#define Int			int
121#define FUN(prefix,rest)	prefix ## _ ## rest
122#define FUNW(type)		type
123#define TYPE(type)		type
124#define FSTR			"%s"
125#define STR(x) 			x
126#define UC(c)			(unsigned char)(c)
127
128#define Isalpha(x)  isalpha((unsigned char)x)
129#define Isalnum(x)  isalnum((unsigned char)x)
130#define Isgraph(x)  isgraph((unsigned char)x)
131#define Isspace(x)  isspace((unsigned char)x)
132#define Isdigit(x)  isdigit((unsigned char)x)
133#define Iscntrl(x)  iscntrl((unsigned char)x)
134#define Isprint(x)  isprint((unsigned char)x)
135
136#define Isupper(x)  isupper((unsigned char)x)
137#define Islower(x)  islower((unsigned char)x)
138#define Toupper(x)  toupper((unsigned char)x)
139#define Tolower(x)  tolower((unsigned char)x)
140
141#define IsASCII(x)  isascii((unsigned char)x)
142
143#define Strlen(x)       strlen(x)
144#define Strchr(s,c)     strchr(s,c)
145#define Strrchr(s,c)    strrchr(s,c)
146#define Strstr(s,v)     strstr(s,v)
147#define Strdup(x)       strdup(x)
148#define Strcpy(d,s)     strcpy(d,s)
149#define Strncpy(d,s,n)  strncpy(d,s,n)
150#define Strncat(d,s,n)  strncat(d,s,n)
151
152#define Strcmp(s,v)     strcmp(s,v)
153#define Strncmp(s,v,n)  strncmp(s,v,n)
154#define Strcspn(s,r)    strcspn(s,r)
155
156#define Strtol(p,e,b)   strtol(p,e,b)
157
158#define Width(c)	1
159
160#endif
161
162
163#ifdef WIDECHAR
164/*
165 * Conversion buffer
166 */
167typedef struct ct_buffer_t {
168        char    *cbuff;
169        size_t  csize;
170        Char *wbuff;
171        size_t  wsize;
172} ct_buffer_t;
173
174#define ct_encode_string __ct_encode_string
175/* Encode a wide character string and return the UTF-8 encoded result. */
176public char *ct_encode_string(const Char *, ct_buffer_t *);
177
178#define ct_decode_string __ct_decode_string
179/* Decode a (multi)?byte string and return the wide character string result. */
180public Char *ct_decode_string(const char *, ct_buffer_t *);
181
182/* Decode a (multi)?byte argv string array.
183 * The pointer returned must be free()d when done. */
184protected Char **ct_decode_argv(int, const char *[],  ct_buffer_t *);
185
186/* Resizes the conversion buffer(s) if needed. */
187protected void ct_conv_buff_resize(ct_buffer_t *, size_t, size_t);
188protected ssize_t ct_encode_char(char *, size_t, Char);
189protected size_t ct_enc_width(Char);
190
191#define ct_free_argv(s)	el_free(s)
192
193#else
194#define	ct_encode_string(s, b)	(s)
195#define ct_decode_string(s, b)	(s)
196#define ct_decode_argv(l, s, b)	(s)
197#define ct_conv_buff_resize(b, os, ns)
198#define ct_encode_char(d, l, s)	(*d = s, 1)
199#define ct_free_argv(s)
200#endif
201
202#ifndef NARROWCHAR
203/* Encode a characted into the destination buffer, provided there is sufficent
204 * buffer space available. Returns the number of bytes used up (zero if the
205 * character cannot be encoded, -1 if there was not enough space available). */
206
207/* The maximum buffer size to hold the most unwieldly visual representation,
208 * in this case \U+nnnnn. */
209#define VISUAL_WIDTH_MAX 8
210
211/* The terminal is thought of in terms of X columns by Y lines. In the cases
212 * where a wide character takes up more than one column, the adjacent
213 * occupied column entries will contain this faux character. */
214#define MB_FILL_CHAR ((Char)-1)
215
216/* Visual width of character c, taking into account ^? , \0177 and \U+nnnnn
217 * style visual expansions. */
218protected int ct_visual_width(Char);
219
220/* Turn the given character into the appropriate visual format, matching
221 * the width given by ct_visual_width(). Returns the number of characters used
222 * up, or -1 if insufficient space. Buffer length is in count of Char's. */
223protected ssize_t ct_visual_char(Char *, size_t, Char);
224
225/* Convert the given string into visual format, using the ct_visual_char()
226 * function. Uses a static buffer, so not threadsafe. */
227protected const Char *ct_visual_string(const Char *);
228
229
230/* printable character, use ct_visual_width() to find out display width */
231#define CHTYPE_PRINT        ( 0)
232/* control character found inside the ASCII portion of the charset */
233#define CHTYPE_ASCIICTL     (-1)
234/* a \t */
235#define CHTYPE_TAB          (-2)
236/* a \n */
237#define CHTYPE_NL           (-3)
238/* non-printable character */
239#define CHTYPE_NONPRINT     (-4)
240/* classification of character c, as one of the above defines */
241protected int ct_chr_class(Char c);
242#endif
243
244
245#endif /* _chartype_f */
246