1 /* $OpenBSD: vis.c,v 1.19 2005/09/01 17:15:49 millert Exp $ */
3 * Copyright (c) 1989, 1993
4 * The Regents of the University of California. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the name of the University nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/types.h>
37 #define isoctal(c) (((u_char)(c)) >= '0' && ((u_char)(c)) <= '7')
38 #define isvisible(c) \
39 (((u_int)(c) <= UCHAR_MAX && isascii((u_char)(c)) && \
40 (((c) != '*' && (c) != '?' && (c) != '[' && (c) != '#') || \
41 (flag & VIS_GLOB) == 0) && isgraph((u_char)(c))) || \
42 ((flag & VIS_SP) == 0 && (c) == ' ') || \
43 ((flag & VIS_TAB) == 0 && (c) == '\t') || \
44 ((flag & VIS_NL) == 0 && (c) == '\n') || \
45 ((flag & VIS_SAFE) && ((c) == '\b' || \
46 (c) == '\007' || (c) == '\r' || \
47 isgraph((u_char)(c)))))
50 * vis - visually encode characters
53 vis(char *dst, int c, int flag, int nextc)
57 if (c == '\\' && (flag & VIS_NOSLASH) == 0)
63 if (flag & VIS_CSTYLE) {
100 if (isoctal(nextc)) {
107 if (((c & 0177) == ' ') || (flag & VIS_OCTAL) ||
108 ((flag & VIS_GLOB) && (c == '*' || c == '?' || c == '[' || c == '#'))) {
110 *dst++ = ((u_char)c >> 6 & 07) + '0';
111 *dst++ = ((u_char)c >> 3 & 07) + '0';
112 *dst++ = ((u_char)c & 07) + '0';
115 if ((flag & VIS_NOSLASH) == 0)
121 if (iscntrl((u_char)c)) {
137 * strvis, strnvis, strvisx - visually encode characters from src into dst
139 * Dst must be 4 times the size of src to account for possible
140 * expansion. The length of dst, not including the trailing NULL,
143 * Strnvis will write no more than siz-1 bytes (and will NULL terminate).
144 * The number of bytes needed to fully encode the string is returned.
146 * Strvisx encodes exactly len bytes from src into dst.
147 * This is useful for encoding a block of data.
150 strvis(char *dst, const char *src, int flag)
155 for (start = dst; (c = *src);)
156 dst = vis(dst, c, flag, *++src);
158 return (dst - start);
162 strnvis(char *dst, const char *src, size_t siz, int flag)
169 for (start = dst, end = start + siz - 1; (c = *src) && dst < end; ) {
173 if (c == '\\' && (flag & VIS_NOSLASH) == 0) {
174 /* need space for the extra '\\' */
185 i = vis(tbuf, c, flag, *++src) - tbuf;
186 if (dst + i <= end) {
187 memcpy(dst, tbuf, i);
198 /* adjust return value for truncation */
200 dst += vis(tbuf, c, flag, *++src) - tbuf;
202 return (dst - start);
206 strvisx(char *dst, const char *src, size_t len, int flag)
211 for (start = dst; len > 1; len--) {
213 dst = vis(dst, c, flag, *++src);
216 dst = vis(dst, *src, flag, '\0');
218 return (dst - start);