1021d409fSDag-Erling Smørgrav /* $OpenBSD: vis.c,v 1.25 2015/09/13 11:32:51 guenther Exp $ */
2d0c8c0bcSDag-Erling Smørgrav /*-
3d0c8c0bcSDag-Erling Smørgrav * Copyright (c) 1989, 1993
4d0c8c0bcSDag-Erling Smørgrav * The Regents of the University of California. All rights reserved.
5d0c8c0bcSDag-Erling Smørgrav *
6d0c8c0bcSDag-Erling Smørgrav * Redistribution and use in source and binary forms, with or without
7d0c8c0bcSDag-Erling Smørgrav * modification, are permitted provided that the following conditions
8d0c8c0bcSDag-Erling Smørgrav * are met:
9d0c8c0bcSDag-Erling Smørgrav * 1. Redistributions of source code must retain the above copyright
10d0c8c0bcSDag-Erling Smørgrav * notice, this list of conditions and the following disclaimer.
11d0c8c0bcSDag-Erling Smørgrav * 2. Redistributions in binary form must reproduce the above copyright
12d0c8c0bcSDag-Erling Smørgrav * notice, this list of conditions and the following disclaimer in the
13d0c8c0bcSDag-Erling Smørgrav * documentation and/or other materials provided with the distribution.
14d95e11bfSDag-Erling Smørgrav * 3. Neither the name of the University nor the names of its contributors
15d0c8c0bcSDag-Erling Smørgrav * may be used to endorse or promote products derived from this software
16d0c8c0bcSDag-Erling Smørgrav * without specific prior written permission.
17d0c8c0bcSDag-Erling Smørgrav *
18d0c8c0bcSDag-Erling Smørgrav * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19d0c8c0bcSDag-Erling Smørgrav * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20d0c8c0bcSDag-Erling Smørgrav * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21d0c8c0bcSDag-Erling Smørgrav * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22d0c8c0bcSDag-Erling Smørgrav * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23d0c8c0bcSDag-Erling Smørgrav * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24d0c8c0bcSDag-Erling Smørgrav * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25d0c8c0bcSDag-Erling Smørgrav * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26d0c8c0bcSDag-Erling Smørgrav * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27d0c8c0bcSDag-Erling Smørgrav * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28d0c8c0bcSDag-Erling Smørgrav * SUCH DAMAGE.
29d0c8c0bcSDag-Erling Smørgrav */
30021d409fSDag-Erling Smørgrav
31021d409fSDag-Erling Smørgrav /* OPENBSD ORIGINAL: lib/libc/gen/vis.c */
32021d409fSDag-Erling Smørgrav
33d95e11bfSDag-Erling Smørgrav #include "includes.h"
34d0c8c0bcSDag-Erling Smørgrav #if !defined(HAVE_STRNVIS) || defined(BROKEN_STRNVIS)
35d0c8c0bcSDag-Erling Smørgrav
36d0c8c0bcSDag-Erling Smørgrav #include <sys/types.h>
37d95e11bfSDag-Erling Smørgrav #include <errno.h>
38d0c8c0bcSDag-Erling Smørgrav #include <ctype.h>
39d0c8c0bcSDag-Erling Smørgrav #include <limits.h>
40d0c8c0bcSDag-Erling Smørgrav #include <string.h>
41d0c8c0bcSDag-Erling Smørgrav #include <stdlib.h>
42021d409fSDag-Erling Smørgrav
43021d409fSDag-Erling Smørgrav #include "vis.h"
44021d409fSDag-Erling Smørgrav
45021d409fSDag-Erling Smørgrav #define isoctal(c) (((u_char)(c)) >= '0' && ((u_char)(c)) <= '7')
46d0c8c0bcSDag-Erling Smørgrav #define isvisible(c,flag) \
47d0c8c0bcSDag-Erling Smørgrav (((c) == '\\' || (flag & VIS_ALL) == 0) && \
48d0c8c0bcSDag-Erling Smørgrav (((u_int)(c) <= UCHAR_MAX && isascii((u_char)(c)) && \
49d95e11bfSDag-Erling Smørgrav (((c) != '*' && (c) != '?' && (c) != '[' && (c) != '#') || \
50d95e11bfSDag-Erling Smørgrav (flag & VIS_GLOB) == 0) && isgraph((u_char)(c))) || \
51d95e11bfSDag-Erling Smørgrav ((flag & VIS_SP) == 0 && (c) == ' ') || \
52d0c8c0bcSDag-Erling Smørgrav ((flag & VIS_TAB) == 0 && (c) == '\t') || \
53d0c8c0bcSDag-Erling Smørgrav ((flag & VIS_NL) == 0 && (c) == '\n') || \
54d0c8c0bcSDag-Erling Smørgrav ((flag & VIS_SAFE) && ((c) == '\b' || \
55d0c8c0bcSDag-Erling Smørgrav (c) == '\007' || (c) == '\r' || \
56d0c8c0bcSDag-Erling Smørgrav isgraph((u_char)(c))))))
57021d409fSDag-Erling Smørgrav
58d0c8c0bcSDag-Erling Smørgrav /*
59d0c8c0bcSDag-Erling Smørgrav * vis - visually encode characters
60d0c8c0bcSDag-Erling Smørgrav */
61d0c8c0bcSDag-Erling Smørgrav char *
vis(char * dst,int c,int flag,int nextc)62d0c8c0bcSDag-Erling Smørgrav vis(char *dst, int c, int flag, int nextc)
63d0c8c0bcSDag-Erling Smørgrav {
64d0c8c0bcSDag-Erling Smørgrav if (isvisible(c, flag)) {
65d0c8c0bcSDag-Erling Smørgrav if ((c == '"' && (flag & VIS_DQ) != 0) ||
66d0c8c0bcSDag-Erling Smørgrav (c == '\\' && (flag & VIS_NOSLASH) == 0))
67d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
68d0c8c0bcSDag-Erling Smørgrav *dst++ = c;
69d0c8c0bcSDag-Erling Smørgrav *dst = '\0';
70d0c8c0bcSDag-Erling Smørgrav return (dst);
71d0c8c0bcSDag-Erling Smørgrav }
72d0c8c0bcSDag-Erling Smørgrav
73d0c8c0bcSDag-Erling Smørgrav if (flag & VIS_CSTYLE) {
74d0c8c0bcSDag-Erling Smørgrav switch(c) {
75d0c8c0bcSDag-Erling Smørgrav case '\n':
76d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
77d0c8c0bcSDag-Erling Smørgrav *dst++ = 'n';
78d0c8c0bcSDag-Erling Smørgrav goto done;
79d0c8c0bcSDag-Erling Smørgrav case '\r':
80d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
81d0c8c0bcSDag-Erling Smørgrav *dst++ = 'r';
82d0c8c0bcSDag-Erling Smørgrav goto done;
83d0c8c0bcSDag-Erling Smørgrav case '\b':
84d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
85d0c8c0bcSDag-Erling Smørgrav *dst++ = 'b';
86d0c8c0bcSDag-Erling Smørgrav goto done;
87d0c8c0bcSDag-Erling Smørgrav case '\a':
88d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
89d0c8c0bcSDag-Erling Smørgrav *dst++ = 'a';
90d0c8c0bcSDag-Erling Smørgrav goto done;
91d0c8c0bcSDag-Erling Smørgrav case '\v':
92d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
93d0c8c0bcSDag-Erling Smørgrav *dst++ = 'v';
94d0c8c0bcSDag-Erling Smørgrav goto done;
95d0c8c0bcSDag-Erling Smørgrav case '\t':
96d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
97d0c8c0bcSDag-Erling Smørgrav *dst++ = 't';
98d0c8c0bcSDag-Erling Smørgrav goto done;
99d0c8c0bcSDag-Erling Smørgrav case '\f':
100d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
101d0c8c0bcSDag-Erling Smørgrav *dst++ = 'f';
102d0c8c0bcSDag-Erling Smørgrav goto done;
103d0c8c0bcSDag-Erling Smørgrav case ' ':
104d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
105d0c8c0bcSDag-Erling Smørgrav *dst++ = 's';
106d0c8c0bcSDag-Erling Smørgrav goto done;
107d0c8c0bcSDag-Erling Smørgrav case '\0':
108d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
109d0c8c0bcSDag-Erling Smørgrav *dst++ = '0';
110d0c8c0bcSDag-Erling Smørgrav if (isoctal(nextc)) {
111021d409fSDag-Erling Smørgrav *dst++ = '0';
112021d409fSDag-Erling Smørgrav *dst++ = '0';
113d0c8c0bcSDag-Erling Smørgrav }
114d0c8c0bcSDag-Erling Smørgrav goto done;
115d0c8c0bcSDag-Erling Smørgrav }
116d0c8c0bcSDag-Erling Smørgrav }
117d0c8c0bcSDag-Erling Smørgrav if (((c & 0177) == ' ') || (flag & VIS_OCTAL) ||
118d0c8c0bcSDag-Erling Smørgrav ((flag & VIS_GLOB) && (c == '*' || c == '?' || c == '[' || c == '#'))) {
119d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
120d0c8c0bcSDag-Erling Smørgrav *dst++ = ((u_char)c >> 6 & 07) + '0';
121d0c8c0bcSDag-Erling Smørgrav *dst++ = ((u_char)c >> 3 & 07) + '0';
122d0c8c0bcSDag-Erling Smørgrav *dst++ = ((u_char)c & 07) + '0';
123d0c8c0bcSDag-Erling Smørgrav goto done;
124d0c8c0bcSDag-Erling Smørgrav }
125021d409fSDag-Erling Smørgrav if ((flag & VIS_NOSLASH) == 0)
126d0c8c0bcSDag-Erling Smørgrav *dst++ = '\\';
127d0c8c0bcSDag-Erling Smørgrav if (c & 0200) {
128d0c8c0bcSDag-Erling Smørgrav c &= 0177;
129d0c8c0bcSDag-Erling Smørgrav *dst++ = 'M';
130d0c8c0bcSDag-Erling Smørgrav }
131d0c8c0bcSDag-Erling Smørgrav if (iscntrl((u_char)c)) {
132d0c8c0bcSDag-Erling Smørgrav *dst++ = '^';
133d0c8c0bcSDag-Erling Smørgrav if (c == 0177)
134d0c8c0bcSDag-Erling Smørgrav *dst++ = '?';
135d0c8c0bcSDag-Erling Smørgrav else
136d0c8c0bcSDag-Erling Smørgrav *dst++ = c + '@';
137d0c8c0bcSDag-Erling Smørgrav } else {
138d0c8c0bcSDag-Erling Smørgrav *dst++ = '-';
139d0c8c0bcSDag-Erling Smørgrav *dst++ = c;
140d0c8c0bcSDag-Erling Smørgrav }
141d0c8c0bcSDag-Erling Smørgrav done:
142d0c8c0bcSDag-Erling Smørgrav *dst = '\0';
143d0c8c0bcSDag-Erling Smørgrav return (dst);
144d0c8c0bcSDag-Erling Smørgrav }
145d0c8c0bcSDag-Erling Smørgrav DEF_WEAK(vis);
146d0c8c0bcSDag-Erling Smørgrav
147d0c8c0bcSDag-Erling Smørgrav /*
148d0c8c0bcSDag-Erling Smørgrav * strvis, strnvis, strvisx - visually encode characters from src into dst
149d0c8c0bcSDag-Erling Smørgrav *
150d0c8c0bcSDag-Erling Smørgrav * Dst must be 4 times the size of src to account for possible
151d0c8c0bcSDag-Erling Smørgrav * expansion. The length of dst, not including the trailing NULL,
152d0c8c0bcSDag-Erling Smørgrav * is returned.
153d0c8c0bcSDag-Erling Smørgrav *
154021d409fSDag-Erling Smørgrav * Strnvis will write no more than siz-1 bytes (and will NULL terminate).
155d0c8c0bcSDag-Erling Smørgrav * The number of bytes needed to fully encode the string is returned.
156021d409fSDag-Erling Smørgrav *
157d0c8c0bcSDag-Erling Smørgrav * Strvisx encodes exactly len bytes from src into dst.
158d0c8c0bcSDag-Erling Smørgrav * This is useful for encoding a block of data.
159d0c8c0bcSDag-Erling Smørgrav */
160d0c8c0bcSDag-Erling Smørgrav int
strvis(char * dst,const char * src,int flag)161d0c8c0bcSDag-Erling Smørgrav strvis(char *dst, const char *src, int flag)
162d0c8c0bcSDag-Erling Smørgrav {
163d0c8c0bcSDag-Erling Smørgrav char c;
164d0c8c0bcSDag-Erling Smørgrav char *start;
165d0c8c0bcSDag-Erling Smørgrav
166021d409fSDag-Erling Smørgrav for (start = dst; (c = *src);)
167d0c8c0bcSDag-Erling Smørgrav dst = vis(dst, c, flag, *++src);
168d0c8c0bcSDag-Erling Smørgrav *dst = '\0';
169d95e11bfSDag-Erling Smørgrav return (dst - start);
170021d409fSDag-Erling Smørgrav }
171d0c8c0bcSDag-Erling Smørgrav DEF_WEAK(strvis);
172d95e11bfSDag-Erling Smørgrav
173d0c8c0bcSDag-Erling Smørgrav int
strnvis(char * dst,const char * src,size_t siz,int flag)174d0c8c0bcSDag-Erling Smørgrav strnvis(char *dst, const char *src, size_t siz, int flag)
175d95e11bfSDag-Erling Smørgrav {
176d0c8c0bcSDag-Erling Smørgrav char *start, *end;
177d0c8c0bcSDag-Erling Smørgrav char tbuf[5];
178d0c8c0bcSDag-Erling Smørgrav int c, i;
179d0c8c0bcSDag-Erling Smørgrav
180d0c8c0bcSDag-Erling Smørgrav i = 0;
181d0c8c0bcSDag-Erling Smørgrav for (start = dst, end = start + siz - 1; (c = *src) && dst < end; ) {
182d0c8c0bcSDag-Erling Smørgrav if (isvisible(c, flag)) {
183d95e11bfSDag-Erling Smørgrav if ((c == '"' && (flag & VIS_DQ) != 0) ||
184d0c8c0bcSDag-Erling Smørgrav (c == '\\' && (flag & VIS_NOSLASH) == 0)) {
185d0c8c0bcSDag-Erling Smørgrav /* need space for the extra '\\' */
186d0c8c0bcSDag-Erling Smørgrav if (dst + 1 >= end) {
187d0c8c0bcSDag-Erling Smørgrav i = 2;
188d0c8c0bcSDag-Erling Smørgrav break;
189d95e11bfSDag-Erling Smørgrav }
190d95e11bfSDag-Erling Smørgrav *dst++ = '\\';
191d95e11bfSDag-Erling Smørgrav }
192d95e11bfSDag-Erling Smørgrav i = 1;
193d95e11bfSDag-Erling Smørgrav *dst++ = c;
194d95e11bfSDag-Erling Smørgrav src++;
195d0c8c0bcSDag-Erling Smørgrav } else {
196d0c8c0bcSDag-Erling Smørgrav i = vis(tbuf, c, flag, *++src) - tbuf;
197d0c8c0bcSDag-Erling Smørgrav if (dst + i <= end) {
198d95e11bfSDag-Erling Smørgrav memcpy(dst, tbuf, i);
199d95e11bfSDag-Erling Smørgrav dst += i;
200d0c8c0bcSDag-Erling Smørgrav } else {
201d95e11bfSDag-Erling Smørgrav src--;
202d0c8c0bcSDag-Erling Smørgrav break;
203d0c8c0bcSDag-Erling Smørgrav }
204d0c8c0bcSDag-Erling Smørgrav }
205d0c8c0bcSDag-Erling Smørgrav }
206d0c8c0bcSDag-Erling Smørgrav if (siz > 0)
207d0c8c0bcSDag-Erling Smørgrav *dst = '\0';
208d0c8c0bcSDag-Erling Smørgrav if (dst + i > end) {
209d0c8c0bcSDag-Erling Smørgrav /* adjust return value for truncation */
210021d409fSDag-Erling Smørgrav while ((c = *src))
211d0c8c0bcSDag-Erling Smørgrav dst += vis(tbuf, c, flag, *++src) - tbuf;
212021d409fSDag-Erling Smørgrav }
213d0c8c0bcSDag-Erling Smørgrav return (dst - start);
214d0c8c0bcSDag-Erling Smørgrav }
215d0c8c0bcSDag-Erling Smørgrav
216d0c8c0bcSDag-Erling Smørgrav int
stravis(char ** outp,const char * src,int flag)217d0c8c0bcSDag-Erling Smørgrav stravis(char **outp, const char *src, int flag)
218d0c8c0bcSDag-Erling Smørgrav {
219d0c8c0bcSDag-Erling Smørgrav char *buf;
220d0c8c0bcSDag-Erling Smørgrav int len, serrno;
221d0c8c0bcSDag-Erling Smørgrav
222d0c8c0bcSDag-Erling Smørgrav buf = reallocarray(NULL, 4, strlen(src) + 1);
223d0c8c0bcSDag-Erling Smørgrav if (buf == NULL)
224d0c8c0bcSDag-Erling Smørgrav return -1;
225d0c8c0bcSDag-Erling Smørgrav len = strvis(buf, src, flag);
226 serrno = errno;
227 *outp = realloc(buf, len + 1);
228 if (*outp == NULL) {
229 *outp = buf;
230 errno = serrno;
231 }
232 return (len);
233 }
234
235 int
strvisx(char * dst,const char * src,size_t len,int flag)236 strvisx(char *dst, const char *src, size_t len, int flag)
237 {
238 char c;
239 char *start;
240
241 for (start = dst; len > 1; len--) {
242 c = *src;
243 dst = vis(dst, c, flag, *++src);
244 }
245 if (len)
246 dst = vis(dst, *src, flag, '\0');
247 *dst = '\0';
248 return (dst - start);
249 }
250
251 #endif
252