12fa9ac1f7eb4fd49678bb1a623e6c2a0d827923
[dragonfly.git] / contrib / libedit / src / chartype.h
1 /*      $NetBSD: chartype.h,v 1.10 2011/11/16 01:45:10 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 #ifndef HAVE_WCSDUP
64 wchar_t *wcsdup(const wchar_t *s);
65 #endif
66
67 #define ct_mbtowc            mbtowc
68 #define ct_mbtowc_reset      mbtowc(0,0,(size_t)0)
69 #define ct_wctomb            wctomb
70 #define ct_wctomb_reset      wctomb(0,0)
71 #define ct_wcstombs          wcstombs
72 #define ct_mbstowcs          mbstowcs
73
74 #define Char                    wchar_t
75 #define Int                     wint_t
76 #define FUN(prefix,rest)        prefix ## _w ## rest
77 #define FUNW(type)              type ## _w
78 #define TYPE(type)              type ## W
79 #define FSTR                    "%ls"
80 #define STR(x)                  L ## x
81 #define UC(c)                   c
82 #define Isalpha(x)  iswalpha(x)
83 #define Isalnum(x)  iswalnum(x)
84 #define Isgraph(x)  iswgraph(x)
85 #define Isspace(x)  iswspace(x)
86 #define Isdigit(x)  iswdigit(x)
87 #define Iscntrl(x)  iswcntrl(x)
88 #define Isprint(x)  iswprint(x)
89
90 #define Isupper(x)  iswupper(x)
91 #define Islower(x)  iswlower(x)
92 #define Toupper(x)  towupper(x)
93 #define Tolower(x)  towlower(x)
94
95 #define IsASCII(x)  (x < 0x100)
96
97 #define Strlen(x)       wcslen(x)
98 #define Strchr(s,c)     wcschr(s,c)
99 #define Strrchr(s,c)    wcsrchr(s,c)
100 #define Strstr(s,v)     wcsstr(s,v)
101 #define Strdup(x)       wcsdup(x)
102 #define Strcpy(d,s)     wcscpy(d,s)
103 #define Strncpy(d,s,n)  wcsncpy(d,s,n)
104 #define Strncat(d,s,n)  wcsncat(d,s,n)
105
106 #define Strcmp(s,v)     wcscmp(s,v)
107 #define Strncmp(s,v,n)  wcsncmp(s,v,n)
108 #define Strcspn(s,r)    wcscspn(s,r)
109
110 #define Strtol(p,e,b)   wcstol(p,e,b)
111
112 static inline int
113 Width(wchar_t c)
114 {
115         int w = wcwidth(c);
116         return w < 0 ? 0 : w;
117 }
118
119 #else /* NARROW */
120
121 #define ct_mbtowc            error
122 #define ct_mbtowc_reset      
123 #define ct_wctomb            error
124 #define ct_wctomb_reset      
125 #define ct_wcstombs(a, b, c)    (strncpy(a, b, c), strlen(a))
126 #define ct_mbstowcs(a, b, c)    (strncpy(a, b, c), strlen(a))
127
128 #define Char                    char
129 #define Int                     int
130 #define FUN(prefix,rest)        prefix ## _ ## rest
131 #define FUNW(type)              type
132 #define TYPE(type)              type
133 #define FSTR                    "%s"
134 #define STR(x)                  x
135 #define UC(c)                   (unsigned char)(c)
136
137 #define Isalpha(x)  isalpha((unsigned char)x)
138 #define Isalnum(x)  isalnum((unsigned char)x)
139 #define Isgraph(x)  isgraph((unsigned char)x)
140 #define Isspace(x)  isspace((unsigned char)x)
141 #define Isdigit(x)  isdigit((unsigned char)x)
142 #define Iscntrl(x)  iscntrl((unsigned char)x)
143 #define Isprint(x)  isprint((unsigned char)x)
144
145 #define Isupper(x)  isupper((unsigned char)x)
146 #define Islower(x)  islower((unsigned char)x)
147 #define Toupper(x)  toupper((unsigned char)x)
148 #define Tolower(x)  tolower((unsigned char)x)
149
150 #define IsASCII(x)  isascii((unsigned char)x)
151
152 #define Strlen(x)       strlen(x)
153 #define Strchr(s,c)     strchr(s,c)
154 #define Strrchr(s,c)    strrchr(s,c)
155 #define Strstr(s,v)     strstr(s,v)
156 #define Strdup(x)       strdup(x)
157 #define Strcpy(d,s)     strcpy(d,s)
158 #define Strncpy(d,s,n)  strncpy(d,s,n)
159 #define Strncat(d,s,n)  strncat(d,s,n)
160
161 #define Strcmp(s,v)     strcmp(s,v)
162 #define Strncmp(s,v,n)  strncmp(s,v,n)
163 #define Strcspn(s,r)    strcspn(s,r)
164
165 #define Strtol(p,e,b)   strtol(p,e,b)
166
167 #define Width(c)        1
168
169 #endif
170
171
172 #ifdef WIDECHAR
173 /*
174  * Conversion buffer
175  */
176 typedef struct ct_buffer_t {
177         char    *cbuff;
178         size_t  csize;
179         Char *wbuff;
180         size_t  wsize;
181 } ct_buffer_t;
182
183 #define ct_encode_string __ct_encode_string
184 /* Encode a wide-character string and return the UTF-8 encoded result. */
185 public char *ct_encode_string(const Char *, ct_buffer_t *);
186
187 #define ct_decode_string __ct_decode_string
188 /* Decode a (multi)?byte string and return the wide-character string result. */
189 public Char *ct_decode_string(const char *, ct_buffer_t *);
190
191 /* Decode a (multi)?byte argv string array.
192  * The pointer returned must be free()d when done. */
193 protected Char **ct_decode_argv(int, const char *[],  ct_buffer_t *);
194
195 /* Resizes the conversion buffer(s) if needed. */
196 protected void ct_conv_buff_resize(ct_buffer_t *, size_t, size_t);
197 protected ssize_t ct_encode_char(char *, size_t, Char);
198 protected size_t ct_enc_width(Char);
199
200 #define ct_free_argv(s) el_free(s)
201
202 #else
203 #define ct_encode_string(s, b)  (s)
204 #define ct_decode_string(s, b)  (s)
205 #define ct_decode_argv(l, s, b) (s)
206 #define ct_conv_buff_resize(b, os, ns)
207 #define ct_encode_char(d, l, s) (*d = s, 1)
208 #define ct_free_argv(s)
209 #endif
210
211 #ifndef NARROWCHAR
212 /* Encode a characted into the destination buffer, provided there is sufficent
213  * buffer space available. Returns the number of bytes used up (zero if the
214  * character cannot be encoded, -1 if there was not enough space available). */
215
216 /* The maximum buffer size to hold the most unwieldly visual representation,
217  * in this case \U+nnnnn. */
218 #define VISUAL_WIDTH_MAX ((size_t)8)
219
220 /* The terminal is thought of in terms of X columns by Y lines. In the cases
221  * where a wide character takes up more than one column, the adjacent 
222  * occupied column entries will contain this faux character. */
223 #define MB_FILL_CHAR ((Char)-1)
224
225 /* Visual width of character c, taking into account ^? , \0177 and \U+nnnnn
226  * style visual expansions. */
227 protected int ct_visual_width(Char);
228
229 /* Turn the given character into the appropriate visual format, matching
230  * the width given by ct_visual_width(). Returns the number of characters used
231  * up, or -1 if insufficient space. Buffer length is in count of Char's. */
232 protected ssize_t ct_visual_char(Char *, size_t, Char);
233
234 /* Convert the given string into visual format, using the ct_visual_char()
235  * function. Uses a static buffer, so not threadsafe. */
236 protected const Char *ct_visual_string(const Char *);
237
238
239 /* printable character, use ct_visual_width() to find out display width */
240 #define CHTYPE_PRINT        ( 0)
241 /* control character found inside the ASCII portion of the charset */
242 #define CHTYPE_ASCIICTL     (-1)
243 /* a \t */
244 #define CHTYPE_TAB          (-2)
245 /* a \n */
246 #define CHTYPE_NL           (-3)
247 /* non-printable character */
248 #define CHTYPE_NONPRINT     (-4)
249 /* classification of character c, as one of the above defines */
250 protected int ct_chr_class(Char c);
251 #endif
252
253
254 #endif /* _chartype_f */