xref: /dragonfly/lib/libc/gen/vis.c (revision 1291159d)
1 /*	$NetBSD: vis.c,v 1.74 2017/11/27 16:37:21 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.74 2017/11/27 16:37:21 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 #if defined(__FreeBSD__) || defined(__DragonFly__)
146 /*
147  * On FreeBSD and DragonFly, including <sys/systm.h> for CTASSERT only
148  * works in kernel 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__ || __DragonFly__ */
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 
357 	len = strlen(src);
358 	if ((dst = calloc(len + MAXEXTRAS, sizeof(*dst))) == NULL)
359 		return NULL;
360 
361 	if ((flags & VIS_NOLOCALE) || mbstowcs(dst, src, len) == (size_t)-1) {
362 		size_t i;
363 		for (i = 0; i < len; i++)
364 			dst[i] = (wchar_t)(u_char)src[i];
365 		d = dst + len;
366 	} else
367 		d = dst + wcslen(dst);
368 
369 	if (flags & VIS_GLOB)
370 		for (s = char_glob; *s; *d++ = *s++)
371 			continue;
372 
373 	if (flags & VIS_SHELL)
374 		for (s = char_shell; *s; *d++ = *s++)
375 			continue;
376 
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'\\';
382 	*d = L'\0';
383 
384 	return dst;
385 }
386 
387 /*
388  * istrsenvisx()
389  * 	The main internal function.
390  *	All user-visible functions call this one.
391  */
392 static int
393 istrsenvisx(char **mbdstp, size_t *dlen, const char *mbsrc, size_t mblength,
394     int flags, const char *mbextra, int *cerr_ptr)
395 {
396 	wchar_t *dst, *src, *pdst, *psrc, *start, *extra;
397 	size_t len, olen;
398 	uint64_t bmsk, wmsk;
399 	wint_t c;
400 	visfun_t f;
401 	int clen = 0, cerr, error = -1, i, shft;
402 	char *mbdst, *mdst;
403 	ssize_t mbslength, maxolen;
404 
405 	_DIAGASSERT(mbdstp != NULL);
406 	_DIAGASSERT(mbsrc != NULL || mblength == 0);
407 	_DIAGASSERT(mbextra != NULL);
408 
409 	mbslength = (ssize_t)mblength;
410 	/*
411 	 * When inputing a single character, must also read in the
412 	 * next character for nextc, the look-ahead character.
413 	 */
414 	if (mbslength == 1)
415 		mbslength++;
416 
417 	/*
418 	 * Input (mbsrc) is a char string considered to be multibyte
419 	 * characters.  The input loop will read this string pulling
420 	 * one character, possibly multiple bytes, from mbsrc and
421 	 * converting each to wchar_t in src.
422 	 *
423 	 * The vis conversion will be done using the wide char
424 	 * wchar_t string.
425 	 *
426 	 * This will then be converted back to a multibyte string to
427 	 * return to the caller.
428 	 */
429 
430 	/* Allocate space for the wide char strings */
431 	psrc = pdst = extra = NULL;
432 	mdst = NULL;
433 	if ((psrc = calloc(mbslength + 1, sizeof(*psrc))) == NULL)
434 		return -1;
435 	if ((pdst = calloc((16 * mbslength) + 1, sizeof(*pdst))) == NULL)
436 		goto out;
437 	if (*mbdstp == NULL) {
438 		if ((mdst = calloc((16 * mbslength) + 1, sizeof(*mdst))) == NULL)
439 			goto out;
440 		*mbdstp = mdst;
441 	}
442 
443 	mbdst = *mbdstp;
444 	dst = pdst;
445 	src = psrc;
446 
447 	if (flags & VIS_NOLOCALE) {
448 		/* Do one byte at a time conversion */
449 		cerr = 1;
450 	} else {
451 		/* Use caller's multibyte conversion error flag. */
452 		cerr = cerr_ptr ? *cerr_ptr : 0;
453 	}
454 
455 	/*
456 	 * Input loop.
457 	 * Handle up to mblength characters (not bytes).  We do not
458 	 * stop at NULs because we may be processing a block of data
459 	 * that includes NULs.
460 	 */
461 	while (mbslength > 0) {
462 		/* Convert one multibyte character to wchar_t. */
463 		if (!cerr)
464 			clen = mbtowc(src, mbsrc, MB_LEN_MAX);
465 		if (cerr || clen < 0) {
466 			/* Conversion error, process as a byte instead. */
467 			*src = (wint_t)(u_char)*mbsrc;
468 			clen = 1;
469 			cerr = 1;
470 		}
471 		if (clen == 0) {
472 			/*
473 			 * NUL in input gives 0 return value. process
474 			 * as single NUL byte and keep going.
475 			 */
476 			clen = 1;
477 		}
478 		/* Advance buffer character pointer. */
479 		src++;
480 		/* Advance input pointer by number of bytes read. */
481 		mbsrc += clen;
482 		/* Decrement input byte count. */
483 		mbslength -= clen;
484 	}
485 	len = src - psrc;
486 	src = psrc;
487 
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 	for (dst = start; len > 0; len--) {
538 		if (!cerr)
539 			clen = wctomb(mbdst, *dst);
540 		if (cerr || clen < 0) {
541 			/*
542 			 * Conversion error, process as a byte(s) instead.
543 			 * Examine each byte and higher-order bytes for
544 			 * data.  E.g.,
545 			 *	0x000000000000a264 -> a2 64
546 			 *	0x000000001f00a264 -> 1f 00 a2 64
547 			 */
548 			clen = 0;
549 			wmsk = 0;
550 			for (i = sizeof(wmsk) - 1; i >= 0; i--) {
551 				shft = i * NBBY;
552 				bmsk = (uint64_t)0xffLL << shft;
553 				wmsk |= bmsk;
554 				if ((*dst & wmsk) || i == 0)
555 					mbdst[clen++] = (char)(
556 					    (uint64_t)(*dst & bmsk) >>
557 					    shft);
558 			}
559 			cerr = 1;
560 		}
561 		/* If this character would exceed our output limit, stop. */
562 		if (olen + clen > (size_t)maxolen)
563 			break;
564 		/* Advance output pointer by number of bytes written. */
565 		mbdst += clen;
566 		/* Advance buffer character pointer. */
567 		dst++;
568 		/* Incrment output character count. */
569 		olen += clen;
570 	}
571 
572 	/* Terminate the output string. */
573 	*mbdst = '\0';
574 
575 	if (flags & VIS_NOLOCALE) {
576 		/* Pass conversion error flag out. */
577 		if (cerr_ptr)
578 			*cerr_ptr = cerr;
579 	}
580 
581 	free(extra);
582 	free(pdst);
583 	free(psrc);
584 
585 	return (int)olen;
586 out:
587 	free(extra);
588 	free(pdst);
589 	free(psrc);
590 	free(mdst);
591 	return error;
592 }
593 
594 static int
595 istrsenvisxl(char **mbdstp, size_t *dlen, const char *mbsrc,
596     int flags, const char *mbextra, int *cerr_ptr)
597 {
598 	return istrsenvisx(mbdstp, dlen, mbsrc,
599 	    mbsrc != NULL ? strlen(mbsrc) : 0, flags, mbextra, cerr_ptr);
600 }
601 
602 #endif
603 
604 #if !HAVE_SVIS
605 /*
606  *	The "svis" variants all take an "extra" arg that is a pointer
607  *	to a NUL-terminated list of characters to be encoded, too.
608  *	These functions are useful e. g. to encode strings in such a
609  *	way so that they are not interpreted by a shell.
610  */
611 
612 char *
613 svis(char *mbdst, int c, int flags, int nextc, const char *mbextra)
614 {
615 	char cc[2];
616 	int ret;
617 
618 	cc[0] = c;
619 	cc[1] = nextc;
620 
621 	ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, mbextra, NULL);
622 	if (ret < 0)
623 		return NULL;
624 	return mbdst + ret;
625 }
626 
627 char *
628 snvis(char *mbdst, size_t dlen, int c, int flags, int nextc, const char *mbextra)
629 {
630 	char cc[2];
631 	int ret;
632 
633 	cc[0] = c;
634 	cc[1] = nextc;
635 
636 	ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, mbextra, NULL);
637 	if (ret < 0)
638 		return NULL;
639 	return mbdst + ret;
640 }
641 
642 int
643 strsvis(char *mbdst, const char *mbsrc, int flags, const char *mbextra)
644 {
645 	return istrsenvisxl(&mbdst, NULL, mbsrc, flags, mbextra, NULL);
646 }
647 
648 int
649 strsnvis(char *mbdst, size_t dlen, const char *mbsrc, int flags, const char *mbextra)
650 {
651 	return istrsenvisxl(&mbdst, &dlen, mbsrc, flags, mbextra, NULL);
652 }
653 
654 int
655 strsvisx(char *mbdst, const char *mbsrc, size_t len, int flags, const char *mbextra)
656 {
657 	return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, mbextra, NULL);
658 }
659 
660 int
661 strsnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
662     const char *mbextra)
663 {
664 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, NULL);
665 }
666 
667 int
668 strsenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
669     const char *mbextra, int *cerr_ptr)
670 {
671 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, mbextra, cerr_ptr);
672 }
673 #endif
674 
675 #if !HAVE_VIS
676 /*
677  * vis - visually encode characters
678  */
679 char *
680 vis(char *mbdst, int c, int flags, int nextc)
681 {
682 	char cc[2];
683 	int ret;
684 
685 	cc[0] = c;
686 	cc[1] = nextc;
687 
688 	ret = istrsenvisx(&mbdst, NULL, cc, 1, flags, "", NULL);
689 	if (ret < 0)
690 		return NULL;
691 	return mbdst + ret;
692 }
693 
694 char *
695 nvis(char *mbdst, size_t dlen, int c, int flags, int nextc)
696 {
697 	char cc[2];
698 	int ret;
699 
700 	cc[0] = c;
701 	cc[1] = nextc;
702 
703 	ret = istrsenvisx(&mbdst, &dlen, cc, 1, flags, "", NULL);
704 	if (ret < 0)
705 		return NULL;
706 	return mbdst + ret;
707 }
708 
709 /*
710  * strvis - visually encode characters from src into dst
711  *
712  *	Dst must be 4 times the size of src to account for possible
713  *	expansion.  The length of dst, not including the trailing NULL,
714  *	is returned.
715  */
716 
717 int
718 strvis(char *mbdst, const char *mbsrc, int flags)
719 {
720 	return istrsenvisxl(&mbdst, NULL, mbsrc, flags, "", NULL);
721 }
722 
723 int
724 strnvis(char *dst, const char *src, size_t len, int flag)
725 {
726 	return istrsenvisxl(&dst, &len, src, flag, "", NULL);
727 }
728 
729 int
730 stravis(char **mbdstp, const char *mbsrc, int flags)
731 {
732 	*mbdstp = NULL;
733 	return istrsenvisxl(mbdstp, NULL, mbsrc, flags, "", NULL);
734 }
735 
736 /*
737  * strvisx - visually encode characters from src into dst
738  *
739  *	Dst must be 4 times the size of src to account for possible
740  *	expansion.  The length of dst, not including the trailing NULL,
741  *	is returned.
742  *
743  *	Strvisx encodes exactly len characters from src into dst.
744  *	This is useful for encoding a block of data.
745  */
746 
747 int
748 strvisx(char *mbdst, const char *mbsrc, size_t len, int flags)
749 {
750 	return istrsenvisx(&mbdst, NULL, mbsrc, len, flags, "", NULL);
751 }
752 
753 int
754 strnvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags)
755 {
756 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", NULL);
757 }
758 
759 int
760 strenvisx(char *mbdst, size_t dlen, const char *mbsrc, size_t len, int flags,
761     int *cerr_ptr)
762 {
763 	return istrsenvisx(&mbdst, &dlen, mbsrc, len, flags, "", cerr_ptr);
764 }
765 #endif
766