Blame


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