1 /* $NetBSD: vis.c,v 1.60 2013/02/21 16:21:20 joerg Exp $ */
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * Copyright (c) 1999, 2005 The NetBSD Foundation, Inc.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
45 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
46 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
47 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
48 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
49 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
50 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
51 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
52 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
53 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
54 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
55 * POSSIBILITY OF SUCH DAMAGE.
60 #if defined(LIBC_SCCS) && !defined(lint)
61 __RCSID("$NetBSD: vis.c,v 1.60 2013/02/21 16:21:20 joerg Exp $");
62 #endif /* LIBC_SCCS and not lint */
64 __FBSDID("$FreeBSD$");
67 #include <sys/types.h>
68 #include <sys/param.h>
79 __weak_alias(strvisx,_strvisx)
82 #if !HAVE_VIS || !HAVE_SVIS
89 * The reason for going through the trouble to deal with character encodings
90 * in vis(3), is that we use this to safe encode output of commands. This
91 * safe encoding varies depending on the character set. For example if we
92 * display ps output in French, we don't want to display French characters
96 static wchar_t *do_svis(wchar_t *, wint_t, int, wint_t, const wchar_t *);
101 #define iswoctal(c) (((u_char)(c)) >= L'0' && ((u_char)(c)) <= L'7')
102 #define iswwhite(c) (c == L' ' || c == L'\t' || c == L'\n')
103 #define iswsafe(c) (c == L'\b' || c == BELL || c == L'\r')
104 #define xtoa(c) L"0123456789abcdef"[c]
105 #define XTOA(c) L"0123456789ABCDEF"[c]
109 #if !HAVE_NBTOOL_CONFIG_H
112 * On NetBSD MB_LEN_MAX is currently 32 which does not fit on any integer
113 * integral type and it is probably wrong, since currently the maximum
114 * number of bytes and character needs is 6. Until this is fixed, the
115 * loops below are using sizeof(uint64_t) - 1 instead of MB_LEN_MAX, and
116 * the assertion is commented out.
120 * On FreeBSD including <sys/systm.h> for CTASSERT only works in kernel
124 #define CTASSERT(x) _CTASSERT(x, __LINE__)
125 #define _CTASSERT(x, y) __CTASSERT(x, y)
126 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
128 #endif /* __FreeBSD__ */
130 CTASSERT(MB_LEN_MAX <= sizeof(uint64_t));
132 #endif /* !__NetBSD__ */
136 * This is do_hvis, for HTTP style (RFC 1808)
139 do_hvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
143 || c == L'$' || c == L'-' || c == L'_' || c == L'.' || c == L'+'
145 || c == L'!' || c == L'*' || c == L'\'' || c == L'(' || c == L')'
147 dst = do_svis(dst, c, flags, nextc, extra);
150 *dst++ = xtoa(((unsigned int)c >> 4) & 0xf);
151 *dst++ = xtoa((unsigned int)c & 0xf);
158 * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
159 * NB: No handling of long lines or CRLF.
162 do_mvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
165 /* Space at the end of the line */
166 ((iswspace(c) && (nextc == L'\r' || nextc == L'\n')) ||
168 (!iswspace(c) && (c < 33 || (c > 60 && c < 62) || c > 126)) ||
169 /* Specific char to be escaped */
170 wcschr(L"#$@[\\]^`{|}~", c) != NULL)) {
172 *dst++ = XTOA(((unsigned int)c >> 4) & 0xf);
173 *dst++ = XTOA((unsigned int)c & 0xf);
175 dst = do_svis(dst, c, flags, nextc, extra);
180 * Output single byte of multibyte character.
183 do_mbyte(wchar_t *dst, wint_t c, int flags, wint_t nextc, int iswextra)
185 if (flags & VIS_CSTYLE) {
188 *dst++ = L'\\'; *dst++ = L'n';
191 *dst++ = L'\\'; *dst++ = L'r';
194 *dst++ = L'\\'; *dst++ = L'b';
197 *dst++ = L'\\'; *dst++ = L'a';
200 *dst++ = L'\\'; *dst++ = L'v';
203 *dst++ = L'\\'; *dst++ = L't';
206 *dst++ = L'\\'; *dst++ = L'f';
209 *dst++ = L'\\'; *dst++ = L's';
212 *dst++ = L'\\'; *dst++ = L'0';
213 if (iswoctal(nextc)) {
226 if (iswextra || ((c & 0177) == L' ') || (flags & VIS_OCTAL)) {
228 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 6) & 03) + L'0';
229 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 3) & 07) + L'0';
230 *dst++ = (c & 07) + L'0';
232 if ((flags & VIS_NOSLASH) == 0)
256 * This is do_vis, the central code of vis.
257 * dst: Pointer to the destination buffer
258 * c: Character to encode
260 * nextc: The character following 'c'
261 * extra: Pointer to the list of extra characters to be
262 * backslash-protected.
265 do_svis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
267 int iswextra, i, shft;
270 iswextra = wcschr(extra, c) != NULL;
271 if (!iswextra && (iswgraph(c) || iswwhite(c) ||
272 ((flags & VIS_SAFE) && iswsafe(c)))) {
277 /* See comment in istrsenvisx() output loop, below. */
279 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
281 bmsk = (uint64_t)0xffLL << shft;
283 if ((c & wmsk) || i == 0)
284 dst = do_mbyte(dst, (wint_t)(
285 (uint64_t)(c & bmsk) >> shft),
286 flags, nextc, iswextra);
292 typedef wchar_t *(*visfun_t)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
295 * Return the appropriate encoding function depending on the flags given.
300 if (flags & VIS_HTTPSTYLE)
302 if (flags & VIS_MIMESTYLE)
308 * Expand list of extra characters to not visually encode.
311 makeextralist(int flags, const char *src)
317 if ((dst = calloc(len + MAXEXTRAS, sizeof(*dst))) == NULL)
320 if (mbstowcs(dst, src, len) == (size_t)-1) {
322 for (i = 0; i < len; i++)
323 dst[i] = (wint_t)(u_char)src[i];
326 d = dst + wcslen(dst);
328 if (flags & VIS_GLOB) {
335 if (flags & VIS_SP) *d++ = L' ';
336 if (flags & VIS_TAB) *d++ = L'\t';
337 if (flags & VIS_NL) *d++ = L'\n';
338 if ((flags & VIS_NOSLASH) == 0) *d++ = L'\\';
346 * The main internal function.
347 * All user-visible functions call this one.
350 istrsenvisx(char *mbdst, size_t *dlen, const char *mbsrc, size_t mblength,
351 int flags, const char *mbextra, int *cerr_ptr)
353 wchar_t *dst, *src, *pdst, *psrc, *start, *extra;
358 int clen = 0, cerr = 0, error = -1, i, shft;
359 ssize_t mbslength, maxolen;
361 _DIAGASSERT(mbdst != NULL);
362 _DIAGASSERT(mbsrc != NULL);
363 _DIAGASSERT(mbextra != NULL);
366 * Input (mbsrc) is a char string considered to be multibyte
367 * characters. The input loop will read this string pulling
368 * one character, possibly multiple bytes, from mbsrc and
369 * converting each to wchar_t in src.
371 * The vis conversion will be done using the wide char
374 * This will then be converted back to a multibyte string to
375 * return to the caller.
378 /* Allocate space for the wide char strings */
379 psrc = pdst = extra = NULL;
381 mblength = strlen(mbsrc);
382 if ((psrc = calloc(mblength + 1, sizeof(*psrc))) == NULL)
384 if ((pdst = calloc((4 * mblength) + 1, sizeof(*pdst))) == NULL)
389 /* Use caller's multibyte conversion error flag. */
395 * Handle up to mblength characters (not bytes). We do not
396 * stop at NULs because we may be processing a block of data
397 * that includes NULs.
399 mbslength = (ssize_t)mblength;
401 * When inputing a single character, must also read in the
402 * next character for nextc, the look-ahead character.
406 while (mbslength > 0) {
407 /* Convert one multibyte character to wchar_t. */
409 clen = mbtowc(src, mbsrc, MB_LEN_MAX);
410 if (cerr || clen < 0) {
411 /* Conversion error, process as a byte instead. */
412 *src = (wint_t)(u_char)*mbsrc;
418 * NUL in input gives 0 return value. process
419 * as single NUL byte and keep going.
422 /* Advance buffer character pointer. */
424 /* Advance input pointer by number of bytes read. */
426 /* Decrement input byte count. */
432 * In the single character input case, we will have actually
433 * processed two characters, c and nextc. Reset len back to
434 * just a single character.
439 /* Convert extra argument to list of characters for this mode. */
440 extra = makeextralist(flags, mbextra);
442 if (dlen && *dlen == 0) {
446 *mbdst = '\0'; /* can't create extra, return "" */
451 /* Look up which processing function to call. */
452 f = getvisfun(flags);
455 * Main processing loop.
456 * Call do_Xvis processing function one character at a time
457 * with next character available for look-ahead.
459 for (start = dst; len > 0; len--) {
461 dst = (*f)(dst, c, flags, len >= 1 ? *src : L'\0', extra);
468 /* Terminate the string in the buffer. */
473 * Convert wchar_t string back to multibyte output string.
474 * If we have hit a multi-byte conversion error on input,
475 * output byte-by-byte here. Else use wctomb().
478 maxolen = dlen ? *dlen : (wcslen(start) * MB_LEN_MAX + 1);
480 for (dst = start; len > 0; len--) {
482 clen = wctomb(mbdst, *dst);
483 if (cerr || clen < 0) {
485 * Conversion error, process as a byte(s) instead.
486 * Examine each byte and higher-order bytes for
488 * 0x000000000000a264 -> a2 64
489 * 0x000000001f00a264 -> 1f 00 a2 64
493 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
495 bmsk = (uint64_t)0xffLL << shft;
497 if ((*dst & wmsk) || i == 0)
498 mbdst[clen++] = (char)(
499 (uint64_t)(*dst & bmsk) >>
504 /* If this character would exceed our output limit, stop. */
505 if (olen + clen > (size_t)maxolen)
507 /* Advance output pointer by number of bytes written. */
509 /* Advance buffer character pointer. */
511 /* Incrment output character count. */
515 /* Terminate the output string. */
518 /* Pass conversion error flag out. */
537 * The "svis" variants all take an "extra" arg that is a pointer
538 * to a NUL-terminated list of characters to be encoded, too.
539 * These functions are useful e. g. to encode strings in such a
540 * way so that they are not interpreted by a shell.
544 svis(char *mbdst, int c, int flags, int nextc, const char *mbextra)
552 ret = istrsenvisx(mbdst, NULL, cc, 1, flags, mbextra, NULL);
559 snvis(char *mbdst, size_t dlen, int c, int flags, int nextc, const char *mbextra)
567 ret = istrsenvisx(mbdst, &dlen, cc, 1, flags, mbextra, NULL);
574 strsvis(char *mbdst, const char *mbsrc, int flags, const char *mbextra)
576 return istrsenvisx(mbdst, NULL, mbsrc, 0, flags, mbextra, NULL);
580 strsnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags, const char *mbextra)
582 return istrsenvisx(mbdst, &dlen, mbsrc, 0, flags, mbextra, NULL);
586 strsvisx(char *mbdst, const char *mbsrc, size_t len, int flags, const char *mbextra)
588 return istrsenvisx(mbdst, NULL, mbsrc, len, flags, mbextra, NULL);
592 strsnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
595 return istrsenvisx(mbdst, &dlen, mbsrc, len, flags, mbextra, NULL);
599 strsenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
600 const char *mbextra, int *cerr_ptr)
602 return istrsenvisx(mbdst, &dlen, mbsrc, len, flags, mbextra, cerr_ptr);
608 * vis - visually encode characters
611 vis(char *mbdst, int c, int flags, int nextc)
619 ret = istrsenvisx(mbdst, NULL, cc, 1, flags, "", NULL);
626 nvis(char *mbdst, size_t dlen, int c, int flags, int nextc)
634 ret = istrsenvisx(mbdst, &dlen, cc, 1, flags, "", NULL);
641 * strvis - visually encode characters from src into dst
643 * Dst must be 4 times the size of src to account for possible
644 * expansion. The length of dst, not including the trailing NULL,
649 strvis(char *mbdst, const char *mbsrc, int flags)
651 return istrsenvisx(mbdst, NULL, mbsrc, 0, flags, "", NULL);
655 strnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags)
657 return istrsenvisx(mbdst, &dlen, mbsrc, 0, flags, "", NULL);
661 * strvisx - visually encode characters from src into dst
663 * Dst must be 4 times the size of src to account for possible
664 * expansion. The length of dst, not including the trailing NULL,
667 * Strvisx encodes exactly len characters from src into dst.
668 * This is useful for encoding a block of data.
672 strvisx(char *mbdst, const char *mbsrc, size_t len, int flags)
674 return istrsenvisx(mbdst, NULL, mbsrc, len, flags, "", NULL);
678 strnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags)
680 return istrsenvisx(mbdst, &dlen, mbsrc, len, flags, "", NULL);
684 strenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
687 return istrsenvisx(mbdst, &dlen, mbsrc, len, flags, "", cerr_ptr);