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.
58 #include <sys/cdefs.h>
59 #if defined(LIBC_SCCS) && !defined(lint)
60 __RCSID("$NetBSD: vis.c,v 1.60 2013/02/21 16:21:20 joerg Exp $");
61 #endif /* LIBC_SCCS and not lint */
63 __FBSDID("$FreeBSD$");
64 #define _DIAGASSERT(x) assert(x)
67 #include "namespace.h"
68 #include <sys/types.h>
69 #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
110 #if !defined(__NetBSD__) && ! defined(__minix)
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__ */
129 CTASSERT(MB_LEN_MAX
<= sizeof(uint64_t));
130 #endif /* !__NetBSD__ */
134 * This is do_hvis, for HTTP style (RFC 1808)
137 do_hvis(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, const wchar_t *extra
)
141 || c
== L
'$' || c
== L
'-' || c
== L
'_' || c
== L
'.' || c
== L
'+'
143 || c
== L
'!' || c
== L
'*' || c
== L
'\'' || c
== L
'(' || c
== L
')'
145 dst
= do_svis(dst
, c
, flags
, nextc
, extra
);
148 *dst
++ = xtoa(((unsigned int)c
>> 4) & 0xf);
149 *dst
++ = xtoa((unsigned int)c
& 0xf);
156 * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
157 * NB: No handling of long lines or CRLF.
160 do_mvis(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, const wchar_t *extra
)
163 /* Space at the end of the line */
164 ((iswspace(c
) && (nextc
== L
'\r' || nextc
== L
'\n')) ||
166 (!iswspace(c
) && (c
< 33 || (c
> 60 && c
< 62) || c
> 126)) ||
167 /* Specific char to be escaped */
168 wcschr(L
"#$@[\\]^`{|}~", c
) != NULL
)) {
170 *dst
++ = XTOA(((unsigned int)c
>> 4) & 0xf);
171 *dst
++ = XTOA((unsigned int)c
& 0xf);
173 dst
= do_svis(dst
, c
, flags
, nextc
, extra
);
178 * Output single byte of multibyte character.
181 do_mbyte(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, int iswextra
)
183 if (flags
& VIS_CSTYLE
) {
186 *dst
++ = L
'\\'; *dst
++ = L
'n';
189 *dst
++ = L
'\\'; *dst
++ = L
'r';
192 *dst
++ = L
'\\'; *dst
++ = L
'b';
195 *dst
++ = L
'\\'; *dst
++ = L
'a';
198 *dst
++ = L
'\\'; *dst
++ = L
'v';
201 *dst
++ = L
'\\'; *dst
++ = L
't';
204 *dst
++ = L
'\\'; *dst
++ = L
'f';
207 *dst
++ = L
'\\'; *dst
++ = L
's';
210 *dst
++ = L
'\\'; *dst
++ = L
'0';
211 if (iswoctal(nextc
)) {
224 if (iswextra
|| ((c
& 0177) == L
' ') || (flags
& VIS_OCTAL
)) {
226 *dst
++ = (u_char
)(((u_int32_t
)(u_char
)c
>> 6) & 03) + L
'0';
227 *dst
++ = (u_char
)(((u_int32_t
)(u_char
)c
>> 3) & 07) + L
'0';
228 *dst
++ = (c
& 07) + L
'0';
230 if ((flags
& VIS_NOSLASH
) == 0)
254 * This is do_vis, the central code of vis.
255 * dst: Pointer to the destination buffer
256 * c: Character to encode
258 * nextc: The character following 'c'
259 * extra: Pointer to the list of extra characters to be
260 * backslash-protected.
263 do_svis(wchar_t *dst
, wint_t c
, int flags
, wint_t nextc
, const wchar_t *extra
)
265 int iswextra
, i
, shft
;
268 iswextra
= wcschr(extra
, c
) != NULL
;
269 if (!iswextra
&& (iswgraph(c
) || iswwhite(c
) ||
270 ((flags
& VIS_SAFE
) && iswsafe(c
)))) {
275 /* See comment in istrsenvisx() output loop, below. */
277 for (i
= sizeof(wmsk
) - 1; i
>= 0; i
--) {
279 bmsk
= (uint64_t)0xffLL
<< shft
;
281 if ((c
& wmsk
) || i
== 0)
282 dst
= do_mbyte(dst
, (wint_t)(
283 (uint64_t)(c
& bmsk
) >> shft
),
284 flags
, nextc
, iswextra
);
290 typedef wchar_t *(*visfun_t
)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
293 * Return the appropriate encoding function depending on the flags given.
298 if (flags
& VIS_HTTPSTYLE
)
300 if (flags
& VIS_MIMESTYLE
)
306 * Expand list of extra characters to not visually encode.
309 makeextralist(int flags
, const char *src
)
315 if ((dst
= calloc(len
+ MAXEXTRAS
, sizeof(*dst
))) == NULL
)
318 if (mbstowcs(dst
, src
, len
) == (size_t)-1) {
320 for (i
= 0; i
< len
; i
++)
321 dst
[i
] = (wint_t)(u_char
)src
[i
];
324 d
= dst
+ wcslen(dst
);
326 if (flags
& VIS_GLOB
) {
333 if (flags
& VIS_SP
) *d
++ = L
' ';
334 if (flags
& VIS_TAB
) *d
++ = L
'\t';
335 if (flags
& VIS_NL
) *d
++ = L
'\n';
336 if ((flags
& VIS_NOSLASH
) == 0) *d
++ = L
'\\';
344 * The main internal function.
345 * All user-visible functions call this one.
348 istrsenvisx(char *mbdst
, size_t *dlen
, const char *mbsrc
, size_t mblength
,
349 int flags
, const char *mbextra
, int *cerr_ptr
)
351 wchar_t *dst
, *src
, *pdst
, *psrc
, *start
, *extra
;
356 int clen
= 0, cerr
= 0, error
= -1, i
, shft
;
357 ssize_t mbslength
, maxolen
;
359 _DIAGASSERT(mbdst
!= NULL
);
360 _DIAGASSERT(mbsrc
!= NULL
);
361 _DIAGASSERT(mbextra
!= NULL
);
364 * Input (mbsrc) is a char string considered to be multibyte
365 * characters. The input loop will read this string pulling
366 * one character, possibly multiple bytes, from mbsrc and
367 * converting each to wchar_t in src.
369 * The vis conversion will be done using the wide char
372 * This will then be converted back to a multibyte string to
373 * return to the caller.
376 /* Allocate space for the wide char strings */
377 psrc
= pdst
= extra
= NULL
;
379 mblength
= strlen(mbsrc
);
380 if ((psrc
= calloc(mblength
+ 1, sizeof(*psrc
))) == NULL
)
382 if ((pdst
= calloc((4 * mblength
) + 1, sizeof(*pdst
))) == NULL
)
387 /* Use caller's multibyte conversion error flag. */
393 * Handle up to mblength characters (not bytes). We do not
394 * stop at NULs because we may be processing a block of data
395 * that includes NULs.
397 mbslength
= (ssize_t
)mblength
;
399 * When inputing a single character, must also read in the
400 * next character for nextc, the look-ahead character.
404 while (mbslength
> 0) {
405 /* Convert one multibyte character to wchar_t. */
407 clen
= mbtowc(src
, mbsrc
, MB_LEN_MAX
);
408 if (cerr
|| clen
< 0) {
409 /* Conversion error, process as a byte instead. */
410 *src
= (wint_t)(u_char
)*mbsrc
;
416 * NUL in input gives 0 return value. process
417 * as single NUL byte and keep going.
420 /* Advance buffer character pointer. */
422 /* Advance input pointer by number of bytes read. */
424 /* Decrement input byte count. */
430 * In the single character input case, we will have actually
431 * processed two characters, c and nextc. Reset len back to
432 * just a single character.
437 /* Convert extra argument to list of characters for this mode. */
438 extra
= makeextralist(flags
, mbextra
);
440 if (dlen
&& *dlen
== 0) {
444 *mbdst
= '\0'; /* can't create extra, return "" */
449 /* Look up which processing function to call. */
450 f
= getvisfun(flags
);
453 * Main processing loop.
454 * Call do_Xvis processing function one character at a time
455 * with next character available for look-ahead.
457 for (start
= dst
; len
> 0; len
--) {
459 dst
= (*f
)(dst
, c
, flags
, len
>= 1 ? *src
: L
'\0', extra
);
466 /* Terminate the string in the buffer. */
471 * Convert wchar_t string back to multibyte output string.
472 * If we have hit a multi-byte conversion error on input,
473 * output byte-by-byte here. Else use wctomb().
476 maxolen
= dlen
? *dlen
: (wcslen(start
) * MB_LEN_MAX
+ 1);
478 for (dst
= start
; len
> 0; len
--) {
480 clen
= wctomb(mbdst
, *dst
);
481 if (cerr
|| clen
< 0) {
483 * Conversion error, process as a byte(s) instead.
484 * Examine each byte and higher-order bytes for
486 * 0x000000000000a264 -> a2 64
487 * 0x000000001f00a264 -> 1f 00 a2 64
491 for (i
= sizeof(wmsk
) - 1; i
>= 0; i
--) {
493 bmsk
= (uint64_t)0xffLL
<< shft
;
495 if ((*dst
& wmsk
) || i
== 0)
496 mbdst
[clen
++] = (char)(
497 (uint64_t)(*dst
& bmsk
) >>
502 /* If this character would exceed our output limit, stop. */
503 if (olen
+ clen
> (size_t)maxolen
)
505 /* Advance output pointer by number of bytes written. */
507 /* Advance buffer character pointer. */
509 /* Incrment output character count. */
513 /* Terminate the output string. */
516 /* Pass conversion error flag out. */
535 * The "svis" variants all take an "extra" arg that is a pointer
536 * to a NUL-terminated list of characters to be encoded, too.
537 * These functions are useful e. g. to encode strings in such a
538 * way so that they are not interpreted by a shell.
542 svis(char *mbdst
, int c
, int flags
, int nextc
, const char *mbextra
)
550 ret
= istrsenvisx(mbdst
, NULL
, cc
, 1, flags
, mbextra
, NULL
);
557 snvis(char *mbdst
, size_t dlen
, int c
, int flags
, int nextc
, const char *mbextra
)
565 ret
= istrsenvisx(mbdst
, &dlen
, cc
, 1, flags
, mbextra
, NULL
);
572 strsvis(char *mbdst
, const char *mbsrc
, int flags
, const char *mbextra
)
574 return istrsenvisx(mbdst
, NULL
, mbsrc
, 0, flags
, mbextra
, NULL
);
578 strsnvis(char *mbdst
, size_t dlen
, const char *mbsrc
, int flags
, const char *mbextra
)
580 return istrsenvisx(mbdst
, &dlen
, mbsrc
, 0, flags
, mbextra
, NULL
);
584 strsvisx(char *mbdst
, const char *mbsrc
, size_t len
, int flags
, const char *mbextra
)
586 return istrsenvisx(mbdst
, NULL
, mbsrc
, len
, flags
, mbextra
, NULL
);
590 strsnvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
,
593 return istrsenvisx(mbdst
, &dlen
, mbsrc
, len
, flags
, mbextra
, NULL
);
597 strsenvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
,
598 const char *mbextra
, int *cerr_ptr
)
600 return istrsenvisx(mbdst
, &dlen
, mbsrc
, len
, flags
, mbextra
, cerr_ptr
);
606 * vis - visually encode characters
609 vis(char *mbdst
, int c
, int flags
, int nextc
)
617 ret
= istrsenvisx(mbdst
, NULL
, cc
, 1, flags
, "", NULL
);
624 nvis(char *mbdst
, size_t dlen
, int c
, int flags
, int nextc
)
632 ret
= istrsenvisx(mbdst
, &dlen
, cc
, 1, flags
, "", NULL
);
639 * strvis - visually encode characters from src into dst
641 * Dst must be 4 times the size of src to account for possible
642 * expansion. The length of dst, not including the trailing NULL,
647 strvis(char *mbdst
, const char *mbsrc
, int flags
)
649 return istrsenvisx(mbdst
, NULL
, mbsrc
, 0, flags
, "", NULL
);
653 strnvis(char *mbdst
, size_t dlen
, const char *mbsrc
, int flags
)
655 return istrsenvisx(mbdst
, &dlen
, mbsrc
, 0, flags
, "", NULL
);
659 * strvisx - visually encode characters from src into dst
661 * Dst must be 4 times the size of src to account for possible
662 * expansion. The length of dst, not including the trailing NULL,
665 * Strvisx encodes exactly len characters from src into dst.
666 * This is useful for encoding a block of data.
670 strvisx(char *mbdst
, const char *mbsrc
, size_t len
, int flags
)
672 return istrsenvisx(mbdst
, NULL
, mbsrc
, len
, flags
, "", NULL
);
676 strnvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
)
678 return istrsenvisx(mbdst
, &dlen
, mbsrc
, len
, flags
, "", NULL
);
682 strenvisx(char *mbdst
, size_t dlen
, const char *mbsrc
, size_t len
, int flags
,
685 return istrsenvisx(mbdst
, &dlen
, mbsrc
, len
, flags
, "", cerr_ptr
);