xref: /freebsd/contrib/libc-vis/vis.c (revision 74d9553e43cfafc29448d0bb836916aa21dea0de)
1 /*	$NetBSD: vis.c,v 1.71 2016/01/14 20:41:23 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  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  * 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.
18  *
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
29  * SUCH DAMAGE.
30  */
31 
32 /*-
33  * Copyright (c) 1999, 2005 The NetBSD Foundation, Inc.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
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.
44  *
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.
56  */
57 
58 #include <sys/cdefs.h>
59 #if defined(LIBC_SCCS) && !defined(lint)
60 __RCSID("$NetBSD: vis.c,v 1.71 2016/01/14 20:41:23 christos Exp $");
61 #endif /* LIBC_SCCS and not lint */
62 #ifdef __FBSDID
63 __FBSDID("$FreeBSD$");
64 #define	_DIAGASSERT(x)	assert(x)
65 #endif
66 
67 #include "namespace.h"
68 #include <sys/types.h>
69 #include <sys/param.h>
70 
71 #include <assert.h>
72 #include <vis.h>
73 #include <errno.h>
74 #include <stdlib.h>
75 #include <wchar.h>
76 #include <wctype.h>
77 
78 #ifdef __weak_alias
79 __weak_alias(strvisx,_strvisx)
80 #endif
81 
82 #if !HAVE_VIS || !HAVE_SVIS
83 #include <ctype.h>
84 #include <limits.h>
85 #include <stdio.h>
86 #include <string.h>
87 
88 /*
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
93  * as M-foo.
94  */
95 
96 static wchar_t *do_svis(wchar_t *, wint_t, int, wint_t, const wchar_t *);
97 
98 #undef BELL
99 #define BELL L'\a'
100 
101 #if defined(LC_C_LOCALE)
102 #define iscgraph(c)      isgraph_l(c, LC_C_LOCALE)
103 #else
104 /* Keep it simple for now, no locale stuff */
105 #define iscgraph(c)	isgraph(c)
106 #ifdef notyet
107 #include <locale.h>
108 static int
109 iscgraph(int c) {
110 	int rv;
111 	char *ol;
112 
113 	ol = setlocale(LC_CTYPE, "C");
114 	rv = isgraph(c);
115 	if (ol)
116 		setlocale(LC_CTYPE, ol);
117 	return rv;
118 }
119 #endif
120 #endif
121 
122 #define ISGRAPH(flags, c) \
123     (((flags) & VIS_NOLOCALE) ? iscgraph(c) : iswgraph(c))
124 
125 #define iswoctal(c)	(((u_char)(c)) >= L'0' && ((u_char)(c)) <= L'7')
126 #define iswwhite(c)	(c == L' ' || c == L'\t' || c == L'\n')
127 #define iswsafe(c)	(c == L'\b' || c == BELL || c == L'\r')
128 #define xtoa(c)		L"0123456789abcdef"[c]
129 #define XTOA(c)		L"0123456789ABCDEF"[c]
130 
131 #define MAXEXTRAS	30
132 
133 static const wchar_t char_shell[] = L"'`\";&<>()|{}]\\$!^~";
134 static const wchar_t char_glob[] = L"*?[#";
135 
136 #if !HAVE_NBTOOL_CONFIG_H
137 #ifndef __NetBSD__
138 /*
139  * On NetBSD MB_LEN_MAX is currently 32 which does not fit on any integer
140  * integral type and it is probably wrong, since currently the maximum
141  * number of bytes and character needs is 6. Until this is fixed, the
142  * loops below are using sizeof(uint64_t) - 1 instead of MB_LEN_MAX, and
143  * the assertion is commented out.
144  */
145 #ifdef __FreeBSD__
146 /*
147  * On FreeBSD including <sys/systm.h> for CTASSERT only works in kernel
148  * mode.
149  */
150 #ifndef CTASSERT
151 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
152 #define _CTASSERT(x, y)         __CTASSERT(x, y)
153 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
154 #endif
155 #endif /* __FreeBSD__ */
156 CTASSERT(MB_LEN_MAX <= sizeof(uint64_t));
157 #endif /* !__NetBSD__ */
158 #endif
159 
160 /*
161  * This is do_hvis, for HTTP style (RFC 1808)
162  */
163 static wchar_t *
164 do_hvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
165 {
166 	if (iswalnum(c)
167 	    /* safe */
168 	    || c == L'$' || c == L'-' || c == L'_' || c == L'.' || c == L'+'
169 	    /* extra */
170 	    || c == L'!' || c == L'*' || c == L'\'' || c == L'(' || c == L')'
171 	    || c == L',')
172 		dst = do_svis(dst, c, flags, nextc, extra);
173 	else {
174 		*dst++ = L'%';
175 		*dst++ = xtoa(((unsigned int)c >> 4) & 0xf);
176 		*dst++ = xtoa((unsigned int)c & 0xf);
177 	}
178 
179 	return dst;
180 }
181 
182 /*
183  * This is do_mvis, for Quoted-Printable MIME (RFC 2045)
184  * NB: No handling of long lines or CRLF.
185  */
186 static wchar_t *
187 do_mvis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
188 {
189 	if ((c != L'\n') &&
190 	    /* Space at the end of the line */
191 	    ((iswspace(c) && (nextc == L'\r' || nextc == L'\n')) ||
192 	    /* Out of range */
193 	    (!iswspace(c) && (c < 33 || (c > 60 && c < 62) || c > 126)) ||
194 	    /* Specific char to be escaped */
195 	    wcschr(L"#$@[\\]^`{|}~", c) != NULL)) {
196 		*dst++ = L'=';
197 		*dst++ = XTOA(((unsigned int)c >> 4) & 0xf);
198 		*dst++ = XTOA((unsigned int)c & 0xf);
199 	} else
200 		dst = do_svis(dst, c, flags, nextc, extra);
201 	return dst;
202 }
203 
204 /*
205  * Output single byte of multibyte character.
206  */
207 static wchar_t *
208 do_mbyte(wchar_t *dst, wint_t c, int flags, wint_t nextc, int iswextra)
209 {
210 	if (flags & VIS_CSTYLE) {
211 		switch (c) {
212 		case L'\n':
213 			*dst++ = L'\\'; *dst++ = L'n';
214 			return dst;
215 		case L'\r':
216 			*dst++ = L'\\'; *dst++ = L'r';
217 			return dst;
218 		case L'\b':
219 			*dst++ = L'\\'; *dst++ = L'b';
220 			return dst;
221 		case BELL:
222 			*dst++ = L'\\'; *dst++ = L'a';
223 			return dst;
224 		case L'\v':
225 			*dst++ = L'\\'; *dst++ = L'v';
226 			return dst;
227 		case L'\t':
228 			*dst++ = L'\\'; *dst++ = L't';
229 			return dst;
230 		case L'\f':
231 			*dst++ = L'\\'; *dst++ = L'f';
232 			return dst;
233 		case L' ':
234 			*dst++ = L'\\'; *dst++ = L's';
235 			return dst;
236 		case L'\0':
237 			*dst++ = L'\\'; *dst++ = L'0';
238 			if (iswoctal(nextc)) {
239 				*dst++ = L'0';
240 				*dst++ = L'0';
241 			}
242 			return dst;
243 		/* We cannot encode these characters in VIS_CSTYLE
244 		 * because they special meaning */
245 		case L'n':
246 		case L'r':
247 		case L'b':
248 		case L'a':
249 		case L'v':
250 		case L't':
251 		case L'f':
252 		case L's':
253 		case L'0':
254 		case L'M':
255 		case L'^':
256 		case L'$': /* vis(1) -l */
257 			break;
258 		default:
259 			if (ISGRAPH(flags, c) && !iswoctal(c)) {
260 				*dst++ = L'\\';
261 				*dst++ = c;
262 				return dst;
263 			}
264 		}
265 	}
266 	if (iswextra || ((c & 0177) == L' ') || (flags & VIS_OCTAL)) {
267 		*dst++ = L'\\';
268 		*dst++ = (u_char)(((u_int32_t)(u_char)c >> 6) & 03) + L'0';
269 		*dst++ = (u_char)(((u_int32_t)(u_char)c >> 3) & 07) + L'0';
270 		*dst++ =			     (c	      & 07) + L'0';
271 	} else {
272 		if ((flags & VIS_NOSLASH) == 0)
273 			*dst++ = L'\\';
274 
275 		if (c & 0200) {
276 			c &= 0177;
277 			*dst++ = L'M';
278 		}
279 
280 		if (iswcntrl(c)) {
281 			*dst++ = L'^';
282 			if (c == 0177)
283 				*dst++ = L'?';
284 			else
285 				*dst++ = c + L'@';
286 		} else {
287 			*dst++ = L'-';
288 			*dst++ = c;
289 		}
290 	}
291 
292 	return dst;
293 }
294 
295 /*
296  * This is do_vis, the central code of vis.
297  * dst:	      Pointer to the destination buffer
298  * c:	      Character to encode
299  * flags:     Flags word
300  * nextc:     The character following 'c'
301  * extra:     Pointer to the list of extra characters to be
302  *	      backslash-protected.
303  */
304 static wchar_t *
305 do_svis(wchar_t *dst, wint_t c, int flags, wint_t nextc, const wchar_t *extra)
306 {
307 	int iswextra, i, shft;
308 	uint64_t bmsk, wmsk;
309 
310 	iswextra = wcschr(extra, c) != NULL;
311 	if (!iswextra && (ISGRAPH(flags, c) || iswwhite(c) ||
312 	    ((flags & VIS_SAFE) && iswsafe(c)))) {
313 		*dst++ = c;
314 		return dst;
315 	}
316 
317 	/* See comment in istrsenvisx() output loop, below. */
318 	wmsk = 0;
319 	for (i = sizeof(wmsk) - 1; i >= 0; i--) {
320 		shft = i * NBBY;
321 		bmsk = (uint64_t)0xffLL << shft;
322 		wmsk |= bmsk;
323 		if ((c & wmsk) || i == 0)
324 			dst = do_mbyte(dst, (wint_t)(
325 			    (uint64_t)(c & bmsk) >> shft),
326 			    flags, nextc, iswextra);
327 	}
328 
329 	return dst;
330 }
331 
332 typedef wchar_t *(*visfun_t)(wchar_t *, wint_t, int, wint_t, const wchar_t *);
333 
334 /*
335  * Return the appropriate encoding function depending on the flags given.
336  */
337 static visfun_t
338 getvisfun(int flags)
339 {
340 	if (flags & VIS_HTTPSTYLE)
341 		return do_hvis;
342 	if (flags & VIS_MIMESTYLE)
343 		return do_mvis;
344 	return do_svis;
345 }
346 
347 /*
348  * Expand list of extra characters to not visually encode.
349  */
350 static wchar_t *
351 makeextralist(int flags, const char *src)
352 {
353 	wchar_t *dst, *d;
354 	size_t len;
355 	const wchar_t *s;
356 	mbstate_t mbstate;
357 
358 	bzero(&mbstate, sizeof(mbstate));
359 	len = strlen(src);
360 	if ((dst = calloc(len + MAXEXTRAS, sizeof(*dst))) == NULL)
361 		return NULL;
362 
363 	if ((flags & VIS_NOLOCALE) || mbsrtowcs(dst, &src, len, &mbstate) == (size_t)-1) {
364 		size_t i;
365 		for (i = 0; i < len; i++)
366 			dst[i] = (wchar_t)(u_char)src[i];
367 		d = dst + len;
368 	} else
369 		d = dst + wcslen(dst);
370 
371 	if (flags & VIS_GLOB)
372 		for (s = char_glob; *s; *d++ = *s++)
373 			continue;
374 
375 	if (flags & VIS_SHELL)
376 		for (s = char_shell; *s; *d++ = *s++)
377 			continue;
378 
379 	if (flags & VIS_SP) *d++ = L' ';
380 	if (flags & VIS_TAB) *d++ = L'\t';
381 	if (flags & VIS_NL) *d++ = L'\n';
382 	if ((flags & VIS_NOSLASH) == 0) *d++ = L'\\';
383 	*d = L'\0';
384 
385 	return dst;
386 }
387 
388 /*
389  * istrsenvisx()
390  * 	The main internal function.
391  *	All user-visible functions call this one.
392  */
393 static int
394 istrsenvisx(char **mbdstp, size_t *dlen, const char *mbsrc, size_t mblength,
395     int flags, const char *mbextra, int *cerr_ptr)
396 {
397 	wchar_t *dst, *src, *pdst, *psrc, *start, *extra;
398 	size_t len, olen;
399 	uint64_t bmsk, wmsk;
400 	wint_t c;
401 	visfun_t f;
402 	int clen = 0, cerr, error = -1, i, shft;
403 	char *mbdst, *mdst;
404 	ssize_t mbslength, maxolen;
405 	mbstate_t mbstate;
406 
407 	_DIAGASSERT(mbdstp != NULL);
408 	_DIAGASSERT(mbsrc != NULL || mblength == 0);
409 	_DIAGASSERT(mbextra != NULL);
410 
411 	/*
412 	 * Input (mbsrc) is a char string considered to be multibyte
413 	 * characters.  The input loop will read this string pulling
414 	 * one character, possibly multiple bytes, from mbsrc and
415 	 * converting each to wchar_t in src.
416 	 *
417 	 * The vis conversion will be done using the wide char
418 	 * wchar_t string.
419 	 *
420 	 * This will then be converted back to a multibyte string to
421 	 * return to the caller.
422 	 */
423 
424 	/* Allocate space for the wide char strings */
425 	psrc = pdst = extra = NULL;
426 	mdst = NULL;
427 	if ((psrc = calloc(mblength + 1, sizeof(*psrc))) == NULL)
428 		return -1;
429 	if ((pdst = calloc((4 * mblength) + 1, sizeof(*pdst))) == NULL)
430 		goto out;
431 	if (*mbdstp == NULL) {
432 		if ((mdst = calloc((4 * mblength) + 1, sizeof(*mdst))) == NULL)
433 			goto out;
434 		*mbdstp = mdst;
435 	}
436 
437 	mbdst = *mbdstp;
438 	dst = pdst;
439 	src = psrc;
440 
441 	if (flags & VIS_NOLOCALE) {
442 		/* Do one byte at a time conversion */
443 		cerr = 1;
444 	} else {
445 		/* Use caller's multibyte conversion error flag. */
446 		cerr = cerr_ptr ? *cerr_ptr : 0;
447 	}
448 
449 	/*
450 	 * Input loop.
451 	 * Handle up to mblength characters (not bytes).  We do not
452 	 * stop at NULs because we may be processing a block of data
453 	 * that includes NULs.
454 	 */
455 	mbslength = (ssize_t)mblength;
456 	/*
457 	 * When inputing a single character, must also read in the
458 	 * next character for nextc, the look-ahead character.
459 	 */
460 	if (mbslength == 1)
461 		mbslength++;
462 	bzero(&mbstate, sizeof(mbstate));
463 	while (mbslength > 0) {
464 		/* Convert one multibyte character to wchar_t. */
465 		if (!cerr)
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;
470 			clen = 1;
471 			cerr = 1;
472 		}
473 		if (clen == 0)
474 			/*
475 			 * NUL in input gives 0 return value. process
476 			 * as single NUL byte and keep going.
477 			 */
478 			clen = 1;
479 		/* Advance buffer character pointer. */
480 		src++;
481 		/* Advance input pointer by number of bytes read. */
482 		mbsrc += clen;
483 		/* Decrement input byte count. */
484 		mbslength -= clen;
485 	}
486 	len = src - psrc;
487 	src = psrc;
488 	/*
489 	 * In the single character input case, we will have actually
490 	 * processed two characters, c and nextc.  Reset len back to
491 	 * just a single character.
492 	 */
493 	if (mblength < len)
494 		len = mblength;
495 
496 	/* Convert extra argument to list of characters for this mode. */
497 	extra = makeextralist(flags, mbextra);
498 	if (!extra) {
499 		if (dlen && *dlen == 0) {
500 			errno = ENOSPC;
501 			goto out;
502 		}
503 		*mbdst = '\0';	/* can't create extra, return "" */
504 		error = 0;
505 		goto out;
506 	}
507 
508 	/* Look up which processing function to call. */
509 	f = getvisfun(flags);
510 
511 	/*
512 	 * Main processing loop.
513 	 * Call do_Xvis processing function one character at a time
514 	 * with next character available for look-ahead.
515 	 */
516 	for (start = dst; len > 0; len--) {
517 		c = *src++;
518 		dst = (*f)(dst, c, flags, len >= 1 ? *src : L'\0', extra);
519 		if (dst == NULL) {
520 			errno = ENOSPC;
521 			goto out;
522 		}
523 	}
524 
525 	/* Terminate the string in the buffer. */
526 	*dst = L'\0';
527 
528 	/*
529 	 * Output loop.
530 	 * Convert wchar_t string back to multibyte output string.
531 	 * If we have hit a multi-byte conversion error on input,
532 	 * output byte-by-byte here.  Else use wctomb().
533 	 */
534 	len = wcslen(start);
535 	maxolen = dlen ? *dlen : (wcslen(start) * MB_LEN_MAX + 1);
536 	olen = 0;
537 	bzero(&mbstate, sizeof(mbstate));
538 	for (dst = start; len > 0; len--) {
539 		if (!cerr)
540 			clen = wcrtomb(mbdst, *dst, &mbstate);
541 		if (cerr || clen < 0) {
542 			/*
543 			 * Conversion error, process as a byte(s) instead.
544 			 * Examine each byte and higher-order bytes for
545 			 * data.  E.g.,
546 			 *	0x000000000000a264 -> a2 64
547 			 *	0x000000001f00a264 -> 1f 00 a2 64
548 			 */
549 			clen = 0;
550 			wmsk = 0;
551 			for (i = sizeof(wmsk) - 1; i >= 0; i--) {
552 				shft = i * NBBY;
553 				bmsk = (uint64_t)0xffLL << shft;
554 				wmsk |= bmsk;
555 				if ((*dst & wmsk) || i == 0)
556 					mbdst[clen++] = (char)(
557 					    (uint64_t)(*dst & bmsk) >>
558 					    shft);
559 			}
560 			cerr = 1;
561 		}
562 		/* If this character would exceed our output limit, stop. */
563 		if (olen + clen > (size_t)maxolen)
564 			break;
565 		/* Advance output pointer by number of bytes written. */
566 		mbdst += clen;
567 		/* Advance buffer character pointer. */
568 		dst++;
569 		/* Incrment output character count. */
570 		olen += clen;
571 	}
572 
573 	/* Terminate the output string. */
574 	*mbdst = '\0';
575 
576 	if (flags & VIS_NOLOCALE) {
577 		/* Pass conversion error flag out. */
578 		if (cerr_ptr)
579 			*cerr_ptr = cerr;
580 	}
581 
582 	free(extra);
583 	free(pdst);
584 	free(psrc);
585 
586 	return (int)olen;
587 out:
588 	free(extra);
589 	free(pdst);
590 	free(psrc);
591 	free(mdst);
592 	return error;
593 }
594 
595 static int
596 istrsenvisxl(char **mbdstp, size_t *dlen, const char *mbsrc,
597     int flags, const char *mbextra, int *cerr_ptr)
598 {
599 	return istrsenvisx(mbdstp, dlen, mbsrc,
600 	    mbsrc != NULL ? strlen(mbsrc) : 0, flags, mbextra, cerr_ptr);
601 }
602 
603 #endif
604 
605 #if !HAVE_SVIS
606 /*
607  *	The "svis" variants all take an "extra" arg that is a pointer
608  *	to a NUL-terminated list of characters to be encoded, too.
609  *	These functions are useful e. g. to encode strings in such a
610  *	way so that they are not interpreted by a shell.
611  */
612 
613 char *
614 svis(char *mbdst, int c, int flags, int nextc, const char *mbextra)
615 {
616 	char cc[2];
617 	int ret;
618 
619 	cc[0] = c;
620 	cc[1] = nextc;
621 
622 	ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, mbextra, NULL);
623 	if (ret < 0)
624 		return NULL;
625 	return mbdst + ret;
626 }
627 
628 char *
629 snvis(char *mbdst, size_t dlen, int c, int flags, int nextc, const char *mbextra)
630 {
631 	char cc[2];
632 	int ret;
633 
634 	cc[0] = c;
635 	cc[1] = nextc;
636 
637 	ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, mbextra, NULL);
638 	if (ret < 0)
639 		return NULL;
640 	return mbdst + ret;
641 }
642 
643 int
644 strsvis(char *mbdst, const char *mbsrc, int flags, const char *mbextra)
645 {
646 	return istrsenvisxl(&mbdst, NULL, mbsrc, flags, mbextra, NULL);
647 }
648 
649 int
650 strsnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags, const char *mbextra)
651 {
652 	return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, mbextra, NULL);
653 }
654 
655 int
656 strsvisx(char *mbdst, const char *mbsrc, size_t len, int flags, const char *mbextra)
657 {
658 	return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, mbextra, NULL);
659 }
660 
661 int
662 strsnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
663     const char *mbextra)
664 {
665 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, NULL);
666 }
667 
668 int
669 strsenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
670     const char *mbextra, int *cerr_ptr)
671 {
672 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, cerr_ptr);
673 }
674 #endif
675 
676 #if !HAVE_VIS
677 /*
678  * vis - visually encode characters
679  */
680 char *
681 vis(char *mbdst, int c, int flags, int nextc)
682 {
683 	char cc[2];
684 	int ret;
685 
686 	cc[0] = c;
687 	cc[1] = nextc;
688 
689 	ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, "", NULL);
690 	if (ret < 0)
691 		return NULL;
692 	return mbdst + ret;
693 }
694 
695 char *
696 nvis(char *mbdst, size_t dlen, int c, int flags, int nextc)
697 {
698 	char cc[2];
699 	int ret;
700 
701 	cc[0] = c;
702 	cc[1] = nextc;
703 
704 	ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, "", NULL);
705 	if (ret < 0)
706 		return NULL;
707 	return mbdst + ret;
708 }
709 
710 /*
711  * strvis - visually encode characters from src into dst
712  *
713  *	Dst must be 4 times the size of src to account for possible
714  *	expansion.  The length of dst, not including the trailing NULL,
715  *	is returned.
716  */
717 
718 int
719 strvis(char *mbdst, const char *mbsrc, int flags)
720 {
721 	return istrsenvisxl(&mbdst, NULL, mbsrc, flags, "", NULL);
722 }
723 
724 int
725 strnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags)
726 {
727 	return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, "", NULL);
728 }
729 
730 int
731 stravis(char **mbdstp, const char *mbsrc, int flags)
732 {
733 	*mbdstp = NULL;
734 	return istrsenvisxl(mbdstp, NULL, mbsrc, flags, "", NULL);
735 }
736 
737 /*
738  * strvisx - visually encode characters from src into dst
739  *
740  *	Dst must be 4 times the size of src to account for possible
741  *	expansion.  The length of dst, not including the trailing NULL,
742  *	is returned.
743  *
744  *	Strvisx encodes exactly len characters from src into dst.
745  *	This is useful for encoding a block of data.
746  */
747 
748 int
749 strvisx(char *mbdst, const char *mbsrc, size_t len, int flags)
750 {
751 	return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, "", NULL);
752 }
753 
754 int
755 strnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags)
756 {
757 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", NULL);
758 }
759 
760 int
761 strenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
762     int *cerr_ptr)
763 {
764 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", cerr_ptr);
765 }
766 #endif
767