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>
69 #include "un-namespace.h"
72 __weak_alias(strvisx,_strvisx)
75 #if !HAVE_VIS || !HAVE_SVIS
76 #include "namespace.h"
81 #include "un-namespace.h"
84 * The reason for going through the trouble to deal with character encodings
85 * in vis(3), is that we use this to safe encode output of commands. This
86 * safe encoding varies depending on the character set. For example if we
87 * display ps output in French, we don't want to display French characters
91 static wchar_t *do_svis(wchar_t *, wint_t, int, wint_t, const wchar_t *);
96 #if defined(LC_C_LOCALE)
97 #define iscgraph(c) isgraph_l(c, LC_C_LOCALE)
99 /* Keep it simple for now, no locale stuff */
100 #define iscgraph(c) isgraph(c)
108 ol = setlocale(LC_CTYPE, "C");
111 setlocale(LC_CTYPE, ol);
117 #define ISGRAPH(flags, c) \
118 (((flags) & VIS_NOLOCALE) ? iscgraph(c) : iswgraph(c))
120 #define iswoctal(c) (((u_char)(c)) >= L'0' && ((u_char)(c)) <= L'7')
121 #define iswwhite(c) (c == L' ' || c == L'\t' || c == L'\n')
122 #define iswsafe(c) (c == L'\b' || c == BELL || c == L'\r')
123 #define xtoa(c) L"0123456789abcdef"[c]
124 #define XTOA(c) L"0123456789ABCDEF"[c]
128 static const wchar_t char_shell[] = L"'`\";&<>()|{}]\\$!^~";
129 static const wchar_t char_glob[] = L"*?[#";
131 #if !HAVE_NBTOOL_CONFIG_H
134 * On NetBSD MB_LEN_MAX is currently 32 which does not fit on any integer
135 * integral type and it is probably wrong, since currently the maximum
136 * number of bytes and character needs is 6. Until this is fixed, the
137 * loops below are using sizeof(uint64_t) - 1 instead of MB_LEN_MAX, and
138 * the assertion is commented out.
140 #if defined(__FreeBSD__) || defined(__DragonFly__)
142 * On FreeBSD and DragonFly, including <sys/systm.h> for CTASSERT only
143 * works in kernel mode.
146 #define CTASSERT(x) _CTASSERT(x, __LINE__)
147 #define _CTASSERT(x, y) __CTASSERT(x, y)
148 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
150 #endif /* __FreeBSD__ || __DragonFly__ */
151 CTASSERT(MB_LEN_MAX <= sizeof(uint64_t));
152 #endif /* !__NetBSD__ */
156 * This is do_hvis, for HTTP style (RFC 1808)
159 do_hvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
163 || c == L'$' || c == L'-' || c == L'_' || c == L'.' || c == L'+'
165 || c == L'!' || c == L'*' || c == L'\'' || c == L'(' || c == L')'
167 dst = do_svis(dst, c, flags, nextc, extra);
170 *dst++ = xtoa(((unsigned int)c >> 4) & 0xf);
171 *dst++ = xtoa((unsigned int)c & 0xf);
178 * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
179 * NB: No handling of long lines or CRLF.
182 do_mvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
185 /* Space at the end of the line */
186 ((iswspace(c) && (nextc == L'\r' || nextc == L'\n')) ||
188 (!iswspace(c) && (c < 33 || (c > 60 && c < 62) || c > 126)) ||
189 /* Specific char to be escaped */
190 wcschr(L"#$@[\\]^`{|}~", c) != NULL)) {
192 *dst++ = XTOA(((unsigned int)c >> 4) & 0xf);
193 *dst++ = XTOA((unsigned int)c & 0xf);
195 dst = do_svis(dst, c, flags, nextc, extra);
200 * Output single byte of multibyte character.
203 do_mbyte(wchar_t *dst, wint_t c, int flags, wint_t nextc, int iswextra)
205 if (flags & VIS_CSTYLE) {
208 *dst++ = L'\\'; *dst++ = L'n';
211 *dst++ = L'\\'; *dst++ = L'r';
214 *dst++ = L'\\'; *dst++ = L'b';
217 *dst++ = L'\\'; *dst++ = L'a';
220 *dst++ = L'\\'; *dst++ = L'v';
223 *dst++ = L'\\'; *dst++ = L't';
226 *dst++ = L'\\'; *dst++ = L'f';
229 *dst++ = L'\\'; *dst++ = L's';
232 *dst++ = L'\\'; *dst++ = L'0';
233 if (iswoctal(nextc)) {
238 /* We cannot encode these characters in VIS_CSTYLE
239 * because they special meaning */
255 case L'$': /* vis(1) -l */
258 if (ISGRAPH(flags, c) && !iswoctal(c)) {
265 if (iswextra || ((c & 0177) == L' ') || (flags & VIS_OCTAL)) {
267 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 6) & 03) + L'0';
268 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 3) & 07) + L'0';
269 *dst++ = (c & 07) + L'0';
271 if ((flags & VIS_NOSLASH) == 0)
295 * This is do_vis, the central code of vis.
296 * dst: Pointer to the destination buffer
297 * c: Character to encode
299 * nextc: The character following 'c'
300 * extra: Pointer to the list of extra characters to be
301 * backslash-protected.
304 do_svis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
306 int iswextra, i, shft;
309 iswextra = wcschr(extra, c) != NULL;
310 if (((flags & VIS_ALL) == 0) &&
312 (ISGRAPH(flags, c) || iswwhite(c) ||
313 ((flags & VIS_SAFE) && iswsafe(c)))) {
318 /* See comment in istrsenvisx() output loop, below. */
320 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
322 bmsk = (uint64_t)0xffLL << shft;
324 if ((c & wmsk) || i == 0)
325 dst = do_mbyte(dst, (wint_t)(
326 (uint64_t)(c & bmsk) >> shft),
327 flags, nextc, iswextra);
333 typedef wchar_t *(*visfun_t)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
336 * Return the appropriate encoding function depending on the flags given.
341 if (flags & VIS_HTTPSTYLE)
343 if (flags & VIS_MIMESTYLE)
349 * Expand list of extra characters to not visually encode.
352 makeextralist(int flags, const char *src)
359 bzero(&mbstate, sizeof(mbstate));
361 if ((dst = calloc(len + MAXEXTRAS, sizeof(*dst))) == NULL)
364 if ((flags & VIS_NOLOCALE) || mbsrtowcs(dst, &src, len, &mbstate) == (size_t)-1) {
366 for (i = 0; i < len; i++)
367 dst[i] = (wchar_t)(u_char)src[i];
370 d = dst + wcslen(dst);
372 if (flags & VIS_GLOB)
373 for (s = char_glob; *s; *d++ = *s++)
376 if (flags & VIS_SHELL)
377 for (s = char_shell; *s; *d++ = *s++)
380 if (flags & VIS_SP) *d++ = L' ';
381 if (flags & VIS_TAB) *d++ = L'\t';
382 if (flags & VIS_NL) *d++ = L'\n';
383 if (flags & VIS_DQ) *d++ = L'"';
384 if ((flags & VIS_NOSLASH) == 0) *d++ = L'\\';
392 * The main internal function.
393 * All user-visible functions call this one.
396 istrsenvisx(char **mbdstp, size_t *dlen, const char *mbsrc, size_t mblength,
397 int flags, const char *mbextra, int *cerr_ptr)
399 wchar_t *dst, *src, *pdst, *psrc, *start, *extra;
404 int clen = 0, cerr, error = -1, i, shft;
406 ssize_t mbslength, maxolen;
409 _DIAGASSERT(mbdstp != NULL);
410 _DIAGASSERT(mbsrc != NULL || mblength == 0);
411 _DIAGASSERT(mbextra != NULL);
413 mbslength = (ssize_t)mblength;
415 * When inputing a single character, must also read in the
416 * next character for nextc, the look-ahead character.
422 * Input (mbsrc) is a char string considered to be multibyte
423 * characters. The input loop will read this string pulling
424 * one character, possibly multiple bytes, from mbsrc and
425 * converting each to wchar_t in src.
427 * The vis conversion will be done using the wide char
430 * This will then be converted back to a multibyte string to
431 * return to the caller.
434 /* Allocate space for the wide char strings */
435 psrc = pdst = extra = NULL;
437 if ((psrc = calloc(mbslength + 1, sizeof(*psrc))) == NULL)
439 if ((pdst = calloc((16 * mbslength) + 1, sizeof(*pdst))) == NULL)
441 if (*mbdstp == NULL) {
442 if ((mdst = calloc((16 * mbslength) + 1, sizeof(*mdst))) == NULL)
451 if (flags & VIS_NOLOCALE) {
452 /* Do one byte at a time conversion */
455 /* Use caller's multibyte conversion error flag. */
456 cerr = cerr_ptr ? *cerr_ptr : 0;
461 * Handle up to mblength characters (not bytes). We do not
462 * stop at NULs because we may be processing a block of data
463 * that includes NULs.
465 bzero(&mbstate, sizeof(mbstate));
466 while (mbslength > 0) {
467 /* Convert one multibyte character to wchar_t. */
469 clen = mbrtowc(src, mbsrc, MB_LEN_MAX, &mbstate);
470 if (cerr || clen < 0) {
471 /* Conversion error, process as a byte instead. */
472 *src = (wint_t)(u_char)*mbsrc;
478 * NUL in input gives 0 return value. process
479 * as single NUL byte and keep going.
483 /* Advance buffer character pointer. */
485 /* Advance input pointer by number of bytes read. */
487 /* Decrement input byte count. */
494 * In the single character input case, we will have actually
495 * processed two characters, c and nextc. Reset len back to
496 * just a single character.
501 /* Convert extra argument to list of characters for this mode. */
502 extra = makeextralist(flags, mbextra);
504 if (dlen && *dlen == 0) {
508 *mbdst = '\0'; /* can't create extra, return "" */
513 /* Look up which processing function to call. */
514 f = getvisfun(flags);
517 * Main processing loop.
518 * Call do_Xvis processing function one character at a time
519 * with next character available for look-ahead.
521 for (start = dst; len > 0; len--) {
523 dst = (*f)(dst, c, flags, len >= 1 ? *src : L'\0', extra);
530 /* Terminate the string in the buffer. */
535 * Convert wchar_t string back to multibyte output string.
536 * If we have hit a multi-byte conversion error on input,
537 * output byte-by-byte here. Else use wctomb().
540 maxolen = dlen ? *dlen : (wcslen(start) * MB_LEN_MAX + 1);
542 bzero(&mbstate, sizeof(mbstate));
543 for (dst = start; len > 0; len--) {
545 clen = wcrtomb(mbdst, *dst, &mbstate);
546 if (cerr || clen < 0) {
548 * Conversion error, process as a byte(s) instead.
549 * Examine each byte and higher-order bytes for
551 * 0x000000000000a264 -> a2 64
552 * 0x000000001f00a264 -> 1f 00 a2 64
556 for (i = sizeof(wmsk) - 1; i >= 0; i--) {
558 bmsk = (uint64_t)0xffLL << shft;
560 if ((*dst & wmsk) || i == 0)
561 mbdst[clen++] = (char)(
562 (uint64_t)(*dst & bmsk) >>
567 /* If this character would exceed our output limit, stop. */
568 if (olen + clen > (size_t)maxolen)
570 /* Advance output pointer by number of bytes written. */
572 /* Advance buffer character pointer. */
574 /* Incrment output character count. */
578 /* Terminate the output string. */
581 if (flags & VIS_NOLOCALE) {
582 /* Pass conversion error flag out. */
601 istrsenvisxl(char **mbdstp, size_t *dlen, const char *mbsrc,
602 int flags, const char *mbextra, int *cerr_ptr)
604 return istrsenvisx(mbdstp, dlen, mbsrc,
605 mbsrc != NULL ? strlen(mbsrc) : 0, flags, mbextra, cerr_ptr);
612 * The "svis" variants all take an "extra" arg that is a pointer
613 * to a NUL-terminated list of characters to be encoded, too.
614 * These functions are useful e. g. to encode strings in such a
615 * way so that they are not interpreted by a shell.
619 svis(char *mbdst, int c, int flags, int nextc, const char *mbextra)
627 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, mbextra, NULL);
634 snvis(char *mbdst, size_t dlen, int c, int flags, int nextc, const char *mbextra)
642 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, mbextra, NULL);
649 strsvis(char *mbdst, const char *mbsrc, int flags, const char *mbextra)
651 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, mbextra, NULL);
655 strsnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags, const char *mbextra)
657 return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, mbextra, NULL);
661 strsvisx(char *mbdst, const char *mbsrc, size_t len, int flags, const char *mbextra)
663 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, mbextra, NULL);
667 strsnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
670 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, NULL);
674 strsenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
675 const char *mbextra, int *cerr_ptr)
677 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, cerr_ptr);
683 * vis - visually encode characters
686 vis(char *mbdst, int c, int flags, int nextc)
694 ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, "", NULL);
701 nvis(char *mbdst, size_t dlen, int c, int flags, int nextc)
709 ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, "", NULL);
716 * strvis - visually encode characters from src into dst
718 * Dst must be 4 times the size of src to account for possible
719 * expansion. The length of dst, not including the trailing NULL,
724 strvis(char *mbdst, const char *mbsrc, int flags)
726 return istrsenvisxl(&mbdst, NULL, mbsrc, flags, "", NULL);
730 strnvis(char *dst, const char *src, size_t len, int flag)
732 return istrsenvisxl(&dst, &len, src, flag, "", NULL);
736 stravis(char **mbdstp, const char *mbsrc, int flags)
739 return istrsenvisxl(mbdstp, NULL, mbsrc, flags, "", NULL);
743 * strvisx - visually encode characters from src into dst
745 * Dst must be 4 times the size of src to account for possible
746 * expansion. The length of dst, not including the trailing NULL,
749 * Strvisx encodes exactly len characters from src into dst.
750 * This is useful for encoding a block of data.
754 strvisx(char *mbdst, const char *mbsrc, size_t len, int flags)
756 return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, "", NULL);
760 strnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags)
762 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", NULL);
766 strenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
769 return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", cerr_ptr);