1 /* $OpenBSD: vis.c,v 1.26 2022/05/04 18:57:50 deraadt 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 "../config.h"
33 #include <sys/types.h>
46 return uc >= '0' && uc <= '7';
50 isvisible(int c, int flag)
52 int vis_sp = flag & VIS_SP;
53 int vis_tab = flag & VIS_TAB;
54 int vis_nl = flag & VIS_NL;
55 int vis_safe = flag & VIS_SAFE;
56 int vis_glob = flag & VIS_GLOB;
57 int vis_all = flag & VIS_ALL;
60 if (c == '\\' || !vis_all) {
61 if ((u_int)c <= UCHAR_MAX && isascii(uc) &&
62 ((c != '*' && c != '?' && c != '[' && c != '#') || !vis_glob) &&
65 if (!vis_sp && c == ' ')
67 if (!vis_tab && c == '\t')
69 if (!vis_nl && c == '\n')
71 if (vis_safe && (c == '\b' || c == '\007' || c == '\r' || isgraph(uc)))
78 * vis - visually encode characters
81 vis(char *dst, int c, int flag, int nextc)
83 int vis_dq = flag & VIS_DQ;
84 int vis_noslash = flag & VIS_NOSLASH;
85 int vis_cstyle = flag & VIS_CSTYLE;
86 int vis_octal = flag & VIS_OCTAL;
87 int vis_glob = flag & VIS_GLOB;
89 if (isvisible(c, flag)) {
90 if ((c == '"' && vis_dq) ||
91 (c == '\\' && !vis_noslash))
135 if (isoctal(nextc)) {
142 if (((c & 0177) == ' ') || vis_octal ||
143 (vis_glob && (c == '*' || c == '?' || c == '[' || c == '#'))) {
145 *dst++ = ((u_char)c >> 6 & 07) + '0';
146 *dst++ = ((u_char)c >> 3 & 07) + '0';
147 *dst++ = ((u_char)c & 07) + '0';
156 if (iscntrl((u_char)c)) {
172 * strvis, strnvis, strvisx - visually encode characters from src into dst
174 * Dst must be 4 times the size of src to account for possible
175 * expansion. The length of dst, not including the trailing NULL,
178 * Strnvis will write no more than siz-1 bytes (and will NULL terminate).
179 * The number of bytes needed to fully encode the string is returned.
181 * Strvisx encodes exactly len bytes from src into dst.
182 * This is useful for encoding a block of data.
185 strvis(char *dst, const char *src, int flag)
190 for (start = dst; (c = *src);)
191 dst = vis(dst, c, flag, *++src);
193 return (dst - start);
197 strnvis(char *dst, const char *src, size_t siz, int flag)
199 int vis_dq = flag & VIS_DQ;
200 int vis_noslash = flag & VIS_NOSLASH;
206 for (start = dst, end = start + siz - 1; (c = *src) && dst < end; ) {
207 if (isvisible(c, flag)) {
208 if ((c == '"' && vis_dq) ||
209 (c == '\\' && !vis_noslash)) {
210 /* need space for the extra '\\' */
211 if (dst + 1 >= end) {
221 i = vis(tbuf, c, flag, *++src) - tbuf;
222 if (dst + i <= end) {
223 memcpy(dst, tbuf, i);
234 /* adjust return value for truncation */
236 dst += vis(tbuf, c, flag, *++src) - tbuf;
238 return (dst - start);
242 stravis(char **outp, const char *src, int flag)
247 buf = reallocarray(NULL, 4, strlen(src) + 1);
250 len = strvis(buf, src, flag);
252 *outp = realloc(buf, len + 1);
261 strvisx(char *dst, const char *src, size_t len, int flag)
266 for (start = dst; len > 1; len--) {
268 dst = vis(dst, c, flag, *++src);
271 dst = vis(dst, *src, flag, '\0');
273 return (dst - start);