lib/libc/gen/vis.c

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