1 /* $NetBSD: vis.c,v 1.74 2017/11/27 16:37:21 christos Exp $ */
2 /* $FreeBSD: head/contrib/libc-vis/vis.c 326307 2017-11-28 01:35:28Z brooks $ */
5 * Copyright (c) 1989, 1993
6 * The Regents of the University of California. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Copyright (c) 1999, 2005 The NetBSD Foundation, Inc.
35 * All rights reserved.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
40 * 1. Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
46 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
47 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
48 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
49 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
50 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
51 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
52 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
53 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
54 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
55 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
56 * POSSIBILITY OF SUCH DAMAGE.
59 #include "namespace.h"
60 #include <sys/types.h>
61 #include <sys/param.h>
71 __weak_alias(strvisx,_strvisx)
74 #if !HAVE_VIS || !HAVE_SVIS
81 * The reason for going through the trouble to deal with character encodings
82 * in vis(3), is that we use this to safe encode output of commands. This
83 * safe encoding varies depending on the character set. For example if we
84 * display ps output in French, we don't want to display French characters
88 static wchar_t *do_svis(wchar_t *, wint_t, int, wint_t, const wchar_t *);
93 #if defined(LC_C_LOCALE)
94 #define iscgraph(c) isgraph_l(c, LC_C_LOCALE)
96 /* Keep it simple for now, no locale stuff */
97 #define iscgraph(c) isgraph(c)
105 ol = setlocale(LC_CTYPE, "C");
108 setlocale(LC_CTYPE, ol);
114 #define ISGRAPH(flags, c) \
115 (((flags) & VIS_NOLOCALE) ? iscgraph(c) : iswgraph(c))
117 #define iswoctal(c) (((u_char)(c)) >= L'0' && ((u_char)(c)) <= L'7')
118 #define iswwhite(c) (c == L' ' || c == L'\t' || c == L'\n')
119 #define iswsafe(c) (c == L'\b' || c == BELL || c == L'\r')
120 #define xtoa(c) L"0123456789abcdef"[c]
121 #define XTOA(c) L"0123456789ABCDEF"[c]
125 static const wchar_t char_shell[] = L"'`\";&<>()|{}]\\$!^~";
126 static const wchar_t char_glob[] = L"*?[#";
128 #if !HAVE_NBTOOL_CONFIG_H
131 * On NetBSD MB_LEN_MAX is currently 32 which does not fit on any integer
132 * integral type and it is probably wrong, since currently the maximum
133 * number of bytes and character needs is 6. Until this is fixed, the
134 * loops below are using sizeof(uint64_t) - 1 instead of MB_LEN_MAX, and
135 * the assertion is commented out.
137 #if defined(__FreeBSD__) || defined(__DragonFly__)
139 * On FreeBSD and DragonFly, including <sys/systm.h> for CTASSERT only
140 * works in kernel mode.
143 #define CTASSERT(x) _CTASSERT(x, __LINE__)
144 #define _CTASSERT(x, y) __CTASSERT(x, y)
145 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
147 #endif /* __FreeBSD__ || __DragonFly__ */
148 CTASSERT(MB_LEN_MAX <= sizeof(uint64_t));
149 #endif /* !__NetBSD__ */
153 * This is do_hvis, for HTTP style (RFC 1808)
156 do_hvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
160 || c == L'$' || c == L'-' || c == L'_' || c == L'.' || c == L'+'
162 || c == L'!' || c == L'*' || c == L'\'' || c == L'(' || c == L')'
164 dst = do_svis(dst, c, flags, nextc, extra);
167 *dst++ = xtoa(((unsigned int)c >> 4) & 0xf);
168 *dst++ = xtoa((unsigned int)c & 0xf);
175 * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
176 * NB: No handling of long lines or CRLF.
179 do_mvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
182 /* Space at the end of the line */
183 ((iswspace(c) && (nextc == L'\r' || nextc == L'\n')) ||
185 (!iswspace(c) && (c < 33 || (c > 60 && c < 62) || c > 126)) ||
186 /* Specific char to be escaped */
187 wcschr(L"#$@[\\]^`{|}~", c) != NULL)) {
189 *dst++ = XTOA(((unsigned int)c >> 4) & 0xf);
190 *dst++ = XTOA((unsigned int)c & 0xf);
192 dst = do_svis(dst, c, flags, nextc, extra);
197 * Output single byte of multibyte character.
200 do_mbyte(wchar_t *dst, wint_t c, int flags, wint_t nextc, int iswextra)
202 if (flags & VIS_CSTYLE) {
205 *dst++ = L'\\'; *dst++ = L'n';
208 *dst++ = L'\\'; *dst++ = L'r';
211 *dst++ = L'\\'; *dst++ = L'b';
214 *dst++ = L'\\'; *dst++ = L'a';
217 *dst++ = L'\\'; *dst++ = L'v';
220 *dst++ = L'\\'; *dst++ = L't';
223 *dst++ = L'\\'; *dst++ = L'f';
226 *dst++ = L'\\'; *dst++ = L's';
229 *dst++ = L'\\'; *dst++ = L'0';
230 if (iswoctal(nextc)) {
235 /* We cannot encode these characters in VIS_CSTYLE
236 * because they special meaning */
252 case L'$': /* vis(1) -l */
255 if (ISGRAPH(flags, c) && !iswoctal(c)) {
262 if (iswextra || ((c & 0177) == L' ') || (flags & VIS_OCTAL)) {
264 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 6) & 03) + L'0';
265 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 3) & 07) + L'0';
266 *dst++ = (c & 07) + L'0';
268 if ((flags & VIS_NOSLASH) == 0)
292 * This is do_vis, the central code of vis.
293 * dst: Pointer to the destination buffer
294 * c: Character to encode
296 * nextc: The character following 'c'
297 * extra: Pointer to the list of extra characters to be
298 * backslash-protected.
301 do_svis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
303 int iswextra, i, shft;
306 iswextra = wcschr(extra, c) != NULL;
307 if (((flags & VIS_ALL) == 0) &&
309 (ISGRAPH(flags, c) || iswwhite(c) ||
310 ((flags & VIS_SAFE) && iswsafe(c)))) {
315 /* See comment in istrsenvisx() output loop, below. */
317 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
319 bmsk = (uint64_t)0xffLL << shft;
321 if ((c & wmsk) || i == 0)
322 dst = do_mbyte(dst, (wint_t)(
323 (uint64_t)(c & bmsk) >> shft),
324 flags, nextc, iswextra);
330 typedef wchar_t *(*visfun_t)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
333 * Return the appropriate encoding function depending on the flags given.
338 if (flags & VIS_HTTPSTYLE)
340 if (flags & VIS_MIMESTYLE)
346 * Expand list of extra characters to not visually encode.
349 makeextralist(int flags, const char *src)
356 bzero(&mbstate, sizeof(mbstate));
358 if ((dst = calloc(len + MAXEXTRAS, sizeof(*dst))) == NULL)
361 if ((flags & VIS_NOLOCALE) || mbsrtowcs(dst, &src, len, &mbstate) == (size_t)-1) {
363 for (i = 0; i < len; i++)
364 dst[i] = (wchar_t)(u_char)src[i];
367 d = dst + wcslen(dst);
369 if (flags & VIS_GLOB)
370 for (s = char_glob; *s; *d++ = *s++)
373 if (flags & VIS_SHELL)
374 for (s = char_shell; *s; *d++ = *s++)
377 if (flags & VIS_SP) *d++ = L' ';
378 if (flags & VIS_TAB) *d++ = L'\t';
379 if (flags & VIS_NL) *d++ = L'\n';
380 if (flags & VIS_DQ) *d++ = L'"';
381 if ((flags & VIS_NOSLASH) == 0) *d++ = L'\\';
389 * The main internal function.
390 * All user-visible functions call this one.
393 istrsenvisx(char **mbdstp, size_t *dlen, const char *mbsrc, size_t mblength,
394 int flags, const char *mbextra, int *cerr_ptr)
396 wchar_t *dst, *src, *pdst, *psrc, *start, *extra;
401 int clen = 0, cerr, error = -1, i, shft;
403 ssize_t mbslength, maxolen;
406 _DIAGASSERT(mbdstp != NULL);
407 _DIAGASSERT(mbsrc != NULL || mblength == 0);
408 _DIAGASSERT(mbextra != NULL);
410 mbslength = (ssize_t)mblength;
412 * When inputing a single character, must also read in the
413 * next character for nextc, the look-ahead character.
419 * Input (mbsrc) is a char string considered to be multibyte
420 * characters. The input loop will read this string pulling
421 * one character, possibly multiple bytes, from mbsrc and
422 * converting each to wchar_t in src.
424 * The vis conversion will be done using the wide char
427 * This will then be converted back to a multibyte string to
428 * return to the caller.
431 /* Allocate space for the wide char strings */
432 psrc = pdst = extra = NULL;
434 if ((psrc = calloc(mbslength + 1, sizeof(*psrc))) == NULL)
436 if ((pdst = calloc((16 * mbslength) + 1, sizeof(*pdst))) == NULL)
438 if (*mbdstp == NULL) {
439 if ((mdst = calloc((16 * mbslength) + 1, sizeof(*mdst))) == NULL)
448 if (flags & VIS_NOLOCALE) {
449 /* Do one byte at a time conversion */
452 /* Use caller's multibyte conversion error flag. */
453 cerr = cerr_ptr ? *cerr_ptr : 0;
458 * Handle up to mblength characters (not bytes). We do not
459 * stop at NULs because we may be processing a block of data
460 * that includes NULs.
462 bzero(&mbstate, sizeof(mbstate));
463 while (mbslength > 0) {
464 /* Convert one multibyte character to wchar_t. */
466 clen = mbrtowc(src, mbsrc, MB_LEN_MAX, &mbstate);
467 if (cerr || clen < 0) {
468 /* Conversion error, process as a byte instead. */
469 *src = (wint_t)(u_char)*mbsrc;
475 * NUL in input gives 0 return value. process
476 * as single NUL byte and keep going.
480 /* Advance buffer character pointer. */
482 /* Advance input pointer by number of bytes read. */
484 /* Decrement input byte count. */
491 * In the single character input case, we will have actually
492 * processed two characters, c and nextc. Reset len back to
493 * just a single character.
498 /* Convert extra argument to list of characters for this mode. */
499 extra = makeextralist(flags, mbextra);
501 if (dlen && *dlen == 0) {
505 *mbdst = '\0'; /* can't create extra, return "" */
510 /* Look up which processing function to call. */
511 f = getvisfun(flags);
514 * Main processing loop.
515 * Call do_Xvis processing function one character at a time
516 * with next character available for look-ahead.
518 for (start = dst; len > 0; len--) {
520 dst = (*f)(dst, c, flags, len >= 1 ? *src : L'\0', extra);
527 /* Terminate the string in the buffer. */
532 * Convert wchar_t string back to multibyte output string.
533 * If we have hit a multi-byte conversion error on input,
534 * output byte-by-byte here. Else use wctomb().
537 maxolen = dlen ? *dlen : (wcslen(start) * MB_LEN_MAX + 1);
539 bzero(&mbstate, sizeof(mbstate));
540 for (dst = start; len > 0; len--) {
542 clen = wcrtomb(mbdst, *dst, &mbstate);
543 if (cerr || clen < 0) {
545 * Conversion error, process as a byte(s) instead.
546 * Examine each byte and higher-order bytes for
548 * 0x000000000000a264 -> a2 64
549 * 0x000000001f00a264 -> 1f 00 a2 64
553 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
555 bmsk = (uint64_t)0xffLL << shft;
557 if ((*dst & wmsk) || i == 0)
558 mbdst[clen++] = (char)(
559 (uint64_t)(*dst & bmsk) >>
564 /* If this character would exceed our output limit, stop. */
565 if (olen + clen > (size_t)maxolen)
567 /* Advance output pointer by number of bytes written. */
569 /* Advance buffer character pointer. */
571 /* Incrment output character count. */
575 /* Terminate the output string. */
578 if (flags & VIS_NOLOCALE) {
579 /* Pass conversion error flag out. */
598 istrsenvisxl(char **mbdstp, size_t *dlen, const char *mbsrc,
599 int flags, const char *mbextra, int *cerr_ptr)
601 return istrsenvisx(mbdstp, dlen, mbsrc,
602 mbsrc != NULL ? strlen(mbsrc) : 0, flags, mbextra, cerr_ptr);
609 * The "svis" variants all take an "extra" arg that is a pointer
610 * to a NUL-terminated list of characters to be encoded, too.
611 * These functions are useful e. g. to encode strings in such a
612 * way so that they are not interpreted by a shell.
616 svis(char *mbdst, int c, int flags, int nextc, const char *mbextra)
624 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, mbextra, NULL);
631 snvis(char *mbdst, size_t dlen, int c, int flags, int nextc, const char *mbextra)
639 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, mbextra, NULL);
646 strsvis(char *mbdst, const char *mbsrc, int flags, const char *mbextra)
648 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, mbextra, NULL);
652 strsnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags, const char *mbextra)
654 return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, mbextra, NULL);
658 strsvisx(char *mbdst, const char *mbsrc, size_t len, int flags, const char *mbextra)
660 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, mbextra, NULL);
664 strsnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
667 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, NULL);
671 strsenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
672 const char *mbextra, int *cerr_ptr)
674 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, cerr_ptr);
680 * vis - visually encode characters
683 vis(char *mbdst, int c, int flags, int nextc)
691 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, "", NULL);
698 nvis(char *mbdst, size_t dlen, int c, int flags, int nextc)
706 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, "", NULL);
713 * strvis - visually encode characters from src into dst
715 * Dst must be 4 times the size of src to account for possible
716 * expansion. The length of dst, not including the trailing NULL,
721 strvis(char *mbdst, const char *mbsrc, int flags)
723 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, "", NULL);
727 strnvis(char *dst, const char *src, size_t len, int flag)
729 return istrsenvisxl(&dst, &len, src, flag, "", NULL);
733 stravis(char **mbdstp, const char *mbsrc, int flags)
736 return istrsenvisxl(mbdstp, NULL, mbsrc, flags, "", NULL);
740 * strvisx - visually encode characters from src into dst
742 * Dst must be 4 times the size of src to account for possible
743 * expansion. The length of dst, not including the trailing NULL,
746 * Strvisx encodes exactly len characters from src into dst.
747 * This is useful for encoding a block of data.
751 strvisx(char *mbdst, const char *mbsrc, size_t len, int flags)
753 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, "", NULL);
757 strnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags)
759 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", NULL);
763 strenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
766 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", cerr_ptr);