chartype.h revision 1.20 
1/*	$OpenBSD: chartype.h,v 1.20 2016/05/06 18:01:40 schwarze Exp $	*/
2/*	$NetBSD: chartype.h,v 1.31 2016/04/11 18:56:31 christos Exp $	*/
3
4/*-
5 * Copyright (c) 2009 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 */
29
30#ifndef _h_chartype_f
31#define _h_chartype_f
32
33/* Ideally we should also test the value of the define to see if it
34 * supports non-BMP code points without requiring UTF-16, but nothing
35 * seems to actually advertise this properly, despite Unicode 3.1 having
36 * been around since 2001... */
37#if !defined(__NetBSD__) && !defined(__OpenBSD__)
38#ifndef __STDC_ISO_10646__
39/* In many places it is assumed that the first 127 code points are ASCII
40 * compatible, so ensure wchar_t indeed does ISO 10646 and not some other
41 * funky encoding that could break us in weird and wonderful ways. */
42	#error wchar_t must store ISO 10646 characters
43#endif
44#endif
45
46/* Oh for a <uchar.h> with char32_t and __STDC_UTF_32__ in it...
47 * ref: ISO/IEC DTR 19769
48 */
49#if WCHAR_MAX < INT32_MAX
50#warning Build environment does not support non-BMP characters
51#endif
52
53/*
54 * Conversion buffer
55 */
56typedef struct ct_buffer_t {
57        char    *cbuff;
58        size_t  csize;
59        wchar_t *wbuff;
60        size_t  wsize;
61} ct_buffer_t;
62
63/* Encode a wide-character string and return the UTF-8 encoded result. */
64char *ct_encode_string(const wchar_t *, ct_buffer_t *);
65
66/* Decode a (multi)?byte string and return the wide-character string result. */
67wchar_t *ct_decode_string(const char *, ct_buffer_t *);
68
69/* Decode a (multi)?byte argv string array.
70 * The pointer returned must be free()d when done. */
71protected wchar_t **ct_decode_argv(int, const char *[],  ct_buffer_t *);
72
73/* Encode a character into the destination buffer, provided there is sufficient
74 * buffer space available. Returns the number of bytes used up (zero if the
75 * character cannot be encoded, -1 if there was not enough space available). */
76protected ssize_t ct_encode_char(char *, size_t, wchar_t);
77protected size_t ct_enc_width(wchar_t);
78
79/* The maximum buffer size to hold the most unwieldy visual representation,
80 * in this case \U+nnnnn. */
81#define VISUAL_WIDTH_MAX 8
82
83/* The terminal is thought of in terms of X columns by Y lines. In the cases
84 * where a wide character takes up more than one column, the adjacent
85 * occupied column entries will contain this faux character. */
86#define MB_FILL_CHAR ((wchar_t)-1)
87
88/* Visual width of character c, taking into account ^? , \0177 and \U+nnnnn
89 * style visual expansions. */
90protected int ct_visual_width(wchar_t);
91
92/* Turn the given character into the appropriate visual format, matching
93 * the width given by ct_visual_width(). Returns the number of characters used
94 * up, or -1 if insufficient space. Buffer length is in count of wchar_t's. */
95protected ssize_t ct_visual_char(wchar_t *, size_t, wchar_t);
96
97/* Convert the given string into visual format, using the ct_visual_char()
98 * function. Uses a static buffer, so not threadsafe. */
99protected const wchar_t *ct_visual_string(const wchar_t *);
100
101
102/* printable character, use ct_visual_width() to find out display width */
103#define CHTYPE_PRINT        ( 0)
104/* control character found inside the ASCII portion of the charset */
105#define CHTYPE_ASCIICTL     (-1)
106/* a \t */
107#define CHTYPE_TAB          (-2)
108/* a \n */
109#define CHTYPE_NL           (-3)
110/* non-printable character */
111#define CHTYPE_NONPRINT     (-4)
112/* classification of character c, as one of the above defines */
113protected int ct_chr_class(wchar_t c);
114
115#endif /* _chartype_f */
116