1/*	$NetBSD: chartype.h,v 1.36 2019/09/15 21:09:11 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
29#ifndef _h_chartype_f
30#define _h_chartype_f
31
32/* Ideally we should also test the value of the define to see if it
33 * supports non-BMP code points without requiring UTF-16, but nothing
34 * seems to actually advertise this properly, despite Unicode 3.1 having
35 * been around since 2001... */
36#if	!defined(__NetBSD__) && \
37	!defined(__sun) && \
38	!(defined(__APPLE__) && defined(__MACH__)) && \
39	!defined(__OpenBSD__) && \
40	!defined(__FreeBSD__) && \
41	!defined(__DragonFly__)
42#ifndef __STDC_ISO_10646__
43/* In many places it is assumed that the first 127 code points are ASCII
44 * compatible, so ensure wchar_t indeed does ISO 10646 and not some other
45 * funky encoding that could break us in weird and wonderful ways. */
46	#error wchar_t must store ISO 10646 characters
47#endif
48#endif
49
50/* Oh for a <uchar.h> with char32_t and __STDC_UTF_32__ in it...
51 * ref: ISO/IEC DTR 19769
52 */
53#if WCHAR_MAX < INT32_MAX
54#warning Build environment does not support non-BMP characters
55#endif
56
57/*
58 * Conversion buffer
59 */
60typedef struct ct_buffer_t {
61        char    *cbuff;
62        size_t  csize;
63        wchar_t *wbuff;
64        size_t  wsize;
65} ct_buffer_t;
66
67/* Encode a wide-character string and return the UTF-8 encoded result. */
68char *ct_encode_string(const wchar_t *, ct_buffer_t *);
69
70/* Decode a (multi)?byte string and return the wide-character string result. */
71wchar_t *ct_decode_string(const char *, ct_buffer_t *);
72
73/* Decode a (multi)?byte argv string array.
74 * The pointer returned must be free()d when done. */
75libedit_private wchar_t **ct_decode_argv(int, const char *[],  ct_buffer_t *);
76
77/* Encode a character into the destination buffer, provided there is sufficient
78 * buffer space available. Returns the number of bytes used up (zero if the
79 * character cannot be encoded, -1 if there was not enough space available). */
80libedit_private ssize_t ct_encode_char(char *, size_t, wchar_t);
81libedit_private size_t ct_enc_width(wchar_t);
82
83/* The maximum buffer size to hold the most unwieldy visual representation,
84 * in this case \U+nnnnn. */
85#define VISUAL_WIDTH_MAX ((size_t)8)
86
87/* The terminal is thought of in terms of X columns by Y lines. In the cases
88 * where a wide character takes up more than one column, the adjacent
89 * occupied column entries will contain this faux character. */
90#define MB_FILL_CHAR ((wint_t)-1)
91
92/* Visual width of character c, taking into account ^? , \0177 and \U+nnnnn
93 * style visual expansions. */
94libedit_private int ct_visual_width(wchar_t);
95
96/* Turn the given character into the appropriate visual format, matching
97 * the width given by ct_visual_width(). Returns the number of characters used
98 * up, or -1 if insufficient space. Buffer length is in count of wchar_t's. */
99libedit_private ssize_t ct_visual_char(wchar_t *, size_t, wchar_t);
100
101/* Convert the given string into visual format, using the ct_visual_char()
102 * function. Uses a static buffer, so not threadsafe. */
103libedit_private const wchar_t *ct_visual_string(const wchar_t *, ct_buffer_t *);
104
105
106/* printable character, use ct_visual_width() to find out display width */
107#define CHTYPE_PRINT        ( 0)
108/* control character found inside the ASCII portion of the charset */
109#define CHTYPE_ASCIICTL     (-1)
110/* a \t */
111#define CHTYPE_TAB          (-2)
112/* a \n */
113#define CHTYPE_NL           (-3)
114/* non-printable character */
115#define CHTYPE_NONPRINT     (-4)
116/* classification of character c, as one of the above defines */
117libedit_private int ct_chr_class(wchar_t c);
118
119#endif /* _chartype_f */
120