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