vis.c revision 1.30 1 /* $NetBSD: vis.c,v 1.30 2005/05/20 01:22:48 lukem 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 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 * 3. All advertising materials mentioning features or use of this software
45 * must display the following acknowledgement:
46 * This product includes software developed by the NetBSD
47 * Foundation, Inc. and its contributors.
48 * 4. Neither the name of The NetBSD Foundation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
53 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
54 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
55 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
56 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
57 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
58 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
59 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
60 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
61 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
62 * POSSIBILITY OF SUCH DAMAGE.
63 */
64
65 #include <sys/cdefs.h>
66 #if defined(LIBC_SCCS) && !defined(lint)
67 __RCSID("$NetBSD: vis.c,v 1.30 2005/05/20 01:22:48 lukem Exp $");
68 #endif /* LIBC_SCCS and not lint */
69
70 #include "namespace.h"
71 #include <sys/types.h>
72
73 #include <assert.h>
74 #include <vis.h>
75 #include <stdlib.h>
76
77 #ifdef __weak_alias
78 __weak_alias(strsvis,_strsvis)
79 __weak_alias(strsvisx,_strsvisx)
80 __weak_alias(strvis,_strvis)
81 __weak_alias(strvisx,_strvisx)
82 __weak_alias(svis,_svis)
83 __weak_alias(vis,_vis)
84 #endif
85
86 #if !HAVE_VIS || !HAVE_SVIS
87 #include <ctype.h>
88 #include <limits.h>
89 #include <stdio.h>
90 #include <string.h>
91
92 #undef BELL
93 #define BELL '\a'
94
95 #define isoctal(c) (((u_char)(c)) >= '0' && ((u_char)(c)) <= '7')
96 #define iswhite(c) (c == ' ' || c == '\t' || c == '\n')
97 #define issafe(c) (c == '\b' || c == BELL || c == '\r')
98 #define xtoa(c) "0123456789abcdef"[c]
99
100 #define MAXEXTRAS 5
101
102
103 #define MAKEEXTRALIST(flag, extra, orig) \
104 do { \
105 const char *o = orig; \
106 char *e; \
107 while (*o++) \
108 continue; \
109 extra = alloca((size_t)((o - orig) + MAXEXTRAS)); \
110 for (o = orig, e = extra; (*e++ = *o++) != '\0';) \
111 continue; \
112 e--; \
113 if (flag & VIS_SP) *e++ = ' '; \
114 if (flag & VIS_TAB) *e++ = '\t'; \
115 if (flag & VIS_NL) *e++ = '\n'; \
116 if ((flag & VIS_NOSLASH) == 0) *e++ = '\\'; \
117 *e = '\0'; \
118 } while (/*CONSTCOND*/0)
119
120
121 /*
122 * This is HVIS, the macro of vis used to HTTP style (RFC 1808)
123 */
124 #define HVIS(dst, c, flag, nextc, extra) \
125 do \
126 if (!isascii(c) || !isalnum(c) || strchr("$-_.+!*'(),", c) != NULL) { \
127 *dst++ = '%'; \
128 *dst++ = xtoa(((unsigned int)c >> 4) & 0xf); \
129 *dst++ = xtoa((unsigned int)c & 0xf); \
130 } else { \
131 SVIS(dst, c, flag, nextc, extra); \
132 } \
133 while (/*CONSTCOND*/0)
134
135 /*
136 * This is SVIS, the central macro of vis.
137 * dst: Pointer to the destination buffer
138 * c: Character to encode
139 * flag: Flag word
140 * nextc: The character following 'c'
141 * extra: Pointer to the list of extra characters to be
142 * backslash-protected.
143 */
144 #define SVIS(dst, c, flag, nextc, extra) \
145 do { \
146 int isextra; \
147 isextra = strchr(extra, c) != NULL; \
148 if (!isextra && isascii(c) && (isgraph(c) || iswhite(c) || \
149 ((flag & VIS_SAFE) && issafe(c)))) { \
150 *dst++ = c; \
151 break; \
152 } \
153 if (flag & VIS_CSTYLE) { \
154 switch (c) { \
155 case '\n': \
156 *dst++ = '\\'; *dst++ = 'n'; \
157 continue; \
158 case '\r': \
159 *dst++ = '\\'; *dst++ = 'r'; \
160 continue; \
161 case '\b': \
162 *dst++ = '\\'; *dst++ = 'b'; \
163 continue; \
164 case BELL: \
165 *dst++ = '\\'; *dst++ = 'a'; \
166 continue; \
167 case '\v': \
168 *dst++ = '\\'; *dst++ = 'v'; \
169 continue; \
170 case '\t': \
171 *dst++ = '\\'; *dst++ = 't'; \
172 continue; \
173 case '\f': \
174 *dst++ = '\\'; *dst++ = 'f'; \
175 continue; \
176 case ' ': \
177 *dst++ = '\\'; *dst++ = 's'; \
178 continue; \
179 case '\0': \
180 *dst++ = '\\'; *dst++ = '0'; \
181 if (isoctal(nextc)) { \
182 *dst++ = '0'; \
183 *dst++ = '0'; \
184 } \
185 continue; \
186 default: \
187 if (isgraph(c)) { \
188 *dst++ = '\\'; *dst++ = c; \
189 continue; \
190 } \
191 } \
192 } \
193 if (isextra || ((c & 0177) == ' ') || (flag & VIS_OCTAL)) { \
194 *dst++ = '\\'; \
195 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 6) & 03) + '0'; \
196 *dst++ = (u_char)(((u_int32_t)(u_char)c >> 3) & 07) + '0'; \
197 *dst++ = (c & 07) + '0'; \
198 } else { \
199 if ((flag & VIS_NOSLASH) == 0) *dst++ = '\\'; \
200 if (c & 0200) { \
201 c &= 0177; *dst++ = 'M'; \
202 } \
203 if (iscntrl(c)) { \
204 *dst++ = '^'; \
205 if (c == 0177) \
206 *dst++ = '?'; \
207 else \
208 *dst++ = c + '@'; \
209 } else { \
210 *dst++ = '-'; *dst++ = c; \
211 } \
212 } \
213 } while (/*CONSTCOND*/0)
214
215
216 /*
217 * svis - visually encode characters, also encoding the characters
218 * pointed to by `extra'
219 */
220 char *
221 svis(dst, c, flag, nextc, extra)
222 char *dst;
223 int c, flag, nextc;
224 const char *extra;
225 {
226 char *nextra;
227 _DIAGASSERT(dst != NULL);
228 _DIAGASSERT(extra != NULL);
229 MAKEEXTRALIST(flag, nextra, extra);
230 if (flag & VIS_HTTPSTYLE)
231 HVIS(dst, c, flag, nextc, nextra);
232 else
233 SVIS(dst, c, flag, nextc, nextra);
234 *dst = '\0';
235 return(dst);
236 }
237
238
239 /*
240 * strsvis, strsvisx - visually encode characters from src into dst
241 *
242 * Extra is a pointer to a \0-terminated list of characters to
243 * be encoded, too. These functions are useful e. g. to
244 * encode strings in such a way so that they are not interpreted
245 * by a shell.
246 *
247 * Dst must be 4 times the size of src to account for possible
248 * expansion. The length of dst, not including the trailing NULL,
249 * is returned.
250 *
251 * Strsvisx encodes exactly len bytes from src into dst.
252 * This is useful for encoding a block of data.
253 */
254 int
255 strsvis(dst, csrc, flag, extra)
256 char *dst;
257 const char *csrc;
258 int flag;
259 const char *extra;
260 {
261 int c;
262 char *start;
263 char *nextra;
264 const unsigned char *src = (const unsigned char *)csrc;
265
266 _DIAGASSERT(dst != NULL);
267 _DIAGASSERT(src != NULL);
268 _DIAGASSERT(extra != NULL);
269 MAKEEXTRALIST(flag, nextra, extra);
270 if (flag & VIS_HTTPSTYLE) {
271 for (start = dst; (c = *src++) != '\0'; /* empty */)
272 HVIS(dst, c, flag, *src, nextra);
273 } else {
274 for (start = dst; (c = *src++) != '\0'; /* empty */)
275 SVIS(dst, c, flag, *src, nextra);
276 }
277 *dst = '\0';
278 return (dst - start);
279 }
280
281
282 int
283 strsvisx(dst, csrc, len, flag, extra)
284 char *dst;
285 const char *csrc;
286 size_t len;
287 int flag;
288 const char *extra;
289 {
290 unsigned char c;
291 char *start;
292 char *nextra;
293 const unsigned char *src = (const unsigned char *)csrc;
294
295 _DIAGASSERT(dst != NULL);
296 _DIAGASSERT(src != NULL);
297 _DIAGASSERT(extra != NULL);
298 MAKEEXTRALIST(flag, nextra, extra);
299
300 if (flag & VIS_HTTPSTYLE) {
301 for (start = dst; len > 0; len--) {
302 c = *src++;
303 HVIS(dst, c, flag, len ? *src : '\0', nextra);
304 }
305 } else {
306 for (start = dst; len > 0; len--) {
307 c = *src++;
308 SVIS(dst, c, flag, len ? *src : '\0', nextra);
309 }
310 }
311 *dst = '\0';
312 return (dst - start);
313 }
314 #endif
315
316 #if !HAVE_VIS
317 /*
318 * vis - visually encode characters
319 */
320 char *
321 vis(dst, c, flag, nextc)
322 char *dst;
323 int c, flag, nextc;
324
325 {
326 char *extra;
327 unsigned char uc = (unsigned char)c;
328
329 _DIAGASSERT(dst != NULL);
330
331 MAKEEXTRALIST(flag, extra, "");
332 if (flag & VIS_HTTPSTYLE)
333 HVIS(dst, uc, flag, nextc, extra);
334 else
335 SVIS(dst, uc, flag, nextc, extra);
336 *dst = '\0';
337 return (dst);
338 }
339
340
341 /*
342 * strvis, strvisx - visually encode characters from src into dst
343 *
344 * Dst must be 4 times the size of src to account for possible
345 * expansion. The length of dst, not including the trailing NULL,
346 * is returned.
347 *
348 * Strvisx encodes exactly len bytes from src into dst.
349 * This is useful for encoding a block of data.
350 */
351 int
352 strvis(dst, src, flag)
353 char *dst;
354 const char *src;
355 int flag;
356 {
357 char *extra;
358
359 MAKEEXTRALIST(flag, extra, "");
360 return (strsvis(dst, src, flag, extra));
361 }
362
363
364 int
365 strvisx(dst, src, len, flag)
366 char *dst;
367 const char *src;
368 size_t len;
369 int flag;
370 {
371 char *extra;
372
373 MAKEEXTRALIST(flag, extra, "");
374 return (strsvisx(dst, src, len, flag, extra));
375 }
376 #endif
377