lib/libc/gen/unvis.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/unvis.c,v 1.4.8.1 2000/08/17 08:25:54 jhb Exp $
  34  */
  35
  36 #if defined(LIBC_SCCS) && !defined(lint)
  37 static char sccsid[] = "@(#)unvis.c     8.1 (Berkeley) 6/4/93";
  38 #endif /* LIBC_SCCS and not lint */
  39
  40 #include <sys/types.h>
  41 #include <vis.h>
  42
  43 /*
  44  * decode driven by state machine
  45  */
  46 #define S_GROUND        0       /* haven't seen escape char */
  47 #define S_START         1       /* start decoding special sequence */
  48 #define S_META          2       /* metachar started (M) */
  49 #define S_META1         3       /* metachar more, regular char (-) */
  50 #define S_CTRL          4       /* control char started (^) */
  51 #define S_OCTAL2        5       /* octal digit 2 */
  52 #define S_OCTAL3        6       /* octal digit 3 */
  53 #define S_HEX2          7       /* hex digit 2 */
  54
  55 #define S_HTTP          0x080   /* %HEXHEX escape */
  56
  57 #define isoctal(c)      (((u_char)(c)) >= '0' && ((u_char)(c)) <= '7')
  58 #define ishex(c)        (((u_char)(c)) >= '0' && ((u_char)(c)) <= '9' || ((u_char)(c)) >= 'a' && ((u_char)(c)) <= 'f')
  59
  60 /*
  61  * unvis - decode characters previously encoded by vis
  62  */
  63 int
  64 unvis(cp, c, astate, flag)
  65         char *cp;
  66         int c, *astate, flag;
  67 {
  68
  69         if (flag & UNVIS_END) {
  70                 if (*astate == S_OCTAL2 || *astate == S_OCTAL3) {
  71                         *astate = S_GROUND;
  72                         return (UNVIS_VALID);
  73                 }
  74                 return (*astate == S_GROUND ? UNVIS_NOCHAR : UNVIS_SYNBAD);
  75         }
  76
  77         switch (*astate & ~S_HTTP) {
  78
  79         case S_GROUND:
  80                 *cp = 0;
  81                 if (c == '\\') {
  82                         *astate = S_START;
  83                         return (0);
  84                 }
  85                 if (flag & VIS_HTTPSTYLE && c == '%') {
  86                         *astate = S_START | S_HTTP;
  87                         return (0);
  88                 }
  89                 *cp = c;
  90                 return (UNVIS_VALID);
  91
  92         case S_START:
  93                 if (*astate & S_HTTP) {
  94                     if (ishex(tolower(c))) {
  95                         *cp = isdigit(c) ? (c - '0') : (tolower(c) - 'a');
  96                         *astate = S_HEX2;
  97                         return (0);
  98                     }
  99                 }
 100                 switch(c) {
 101                 case '\\':
 102                         *cp = c;
 103                         *astate = S_GROUND;
 104                         return (UNVIS_VALID);
 105                 case '0': case '1': case '2': case '3':
 106                 case '4': case '5': case '6': case '7':
 107                         *cp = (c - '0');
 108                         *astate = S_OCTAL2;
 109                         return (0);
 110                 case 'M':
 111                         *cp = 0200;
 112                         *astate = S_META;
 113                         return (0);
 114                 case '^':
 115                         *astate = S_CTRL;
 116                         return (0);
 117                 case 'n':
 118                         *cp = '\n';
 119                         *astate = S_GROUND;
 120                         return (UNVIS_VALID);
 121                 case 'r':
 122                         *cp = '\r';
 123                         *astate = S_GROUND;
 124                         return (UNVIS_VALID);
 125                 case 'b':
 126                         *cp = '\b';
 127                         *astate = S_GROUND;
 128                         return (UNVIS_VALID);
 129                 case 'a':
 130                         *cp = '\007';
 131                         *astate = S_GROUND;
 132                         return (UNVIS_VALID);
 133                 case 'v':
 134                         *cp = '\v';
 135                         *astate = S_GROUND;
 136                         return (UNVIS_VALID);
 137                 case 't':
 138                         *cp = '\t';
 139                         *astate = S_GROUND;
 140                         return (UNVIS_VALID);
 141                 case 'f':
 142                         *cp = '\f';
 143                         *astate = S_GROUND;
 144                         return (UNVIS_VALID);
 145                 case 's':
 146                         *cp = ' ';
 147                         *astate = S_GROUND;
 148                         return (UNVIS_VALID);
 149                 case 'E':
 150                         *cp = '\033';
 151                         *astate = S_GROUND;
 152                         return (UNVIS_VALID);
 153                 case '\n':
 154                         /*
 155                          * hidden newline
 156                          */
 157                         *astate = S_GROUND;
 158                         return (UNVIS_NOCHAR);
 159                 case '$':
 160                         /*
 161                          * hidden marker
 162                          */
 163                         *astate = S_GROUND;
 164                         return (UNVIS_NOCHAR);
 165                 }
 166                 *astate = S_GROUND;
 167                 return (UNVIS_SYNBAD);
 168
 169         case S_META:
 170                 if (c == '-')
 171                         *astate = S_META1;
 172                 else if (c == '^')
 173                         *astate = S_CTRL;
 174                 else {
 175                         *astate = S_GROUND;
 176                         return (UNVIS_SYNBAD);
 177                 }
 178                 return (0);
 179
 180         case S_META1:
 181                 *astate = S_GROUND;
 182                 *cp |= c;
 183                 return (UNVIS_VALID);
 184
 185         case S_CTRL:
 186                 if (c == '?')
 187                         *cp |= 0177;
 188                 else
 189                         *cp |= c & 037;
 190                 *astate = S_GROUND;
 191                 return (UNVIS_VALID);
 192
 193         case S_OCTAL2:  /* second possible octal digit */
 194                 if (isoctal(c)) {
 195                         /*
 196                          * yes - and maybe a third
 197                          */
 198                         *cp = (*cp << 3) + (c - '0');
 199                         *astate = S_OCTAL3;
 200                         return (0);
 201                 }
 202                 /*
 203                  * no - done with current sequence, push back passed char
 204                  */
 205                 *astate = S_GROUND;
 206                 return (UNVIS_VALIDPUSH);
 207
 208         case S_OCTAL3:  /* third possible octal digit */
 209                 *astate = S_GROUND;
 210                 if (isoctal(c)) {
 211                         *cp = (*cp << 3) + (c - '0');
 212                         return (UNVIS_VALID);
 213                 }
 214                 /*
 215                  * we were done, push back passed char
 216                  */
 217                 return (UNVIS_VALIDPUSH);
 218
 219         case S_HEX2:    /* second mandatory hex digit */
 220                 if (ishex(tolower(c))) {
 221                         *cp = (isdigit(c) ? (*cp << 4) + (c - '0') : (*cp << 4) + (tolower(c) - 'a' + 10));
 222                 }
 223                 *astate = S_GROUND;
 224                 return (UNVIS_VALID);
 225
 226         default:
 227                 /*
 228                  * decoder in unknown state - (probably uninitialized)
 229                  */
 230                 *astate = S_GROUND;
 231                 return (UNVIS_SYNBAD);
 232         }
 233 }
 234
 235 /*
 236  * strunvis - decode src into dst
 237  *
 238  *      Number of chars decoded into dst is returned, -1 on error.
 239  *      Dst is null terminated.
 240  */
 241
 242 int
 243 strunvis(dst, src)
 244         register char *dst;
 245         register const char *src;
 246 {
 247         register char c;
 248         char *start = dst;
 249         int state = 0;
 250
 251         while ( (c = *src++) ) {
 252         again:
 253                 switch (unvis(dst, c, &state, 0)) {
 254                 case UNVIS_VALID:
 255                         dst++;
 256                         break;
 257                 case UNVIS_VALIDPUSH:
 258                         dst++;
 259                         goto again;
 260                 case 0:
 261                 case UNVIS_NOCHAR:
 262                         break;
 263                 default:
 264                         return (-1);
 265                 }
 266         }
 267         if (unvis(dst, c, &state, UNVIS_END) == UNVIS_VALID)
 268                 dst++;
 269         *dst = '\0';
 270         return (dst - start);
 271 }
 272
 273 int
 274 strunvisx(dst, src, flag)
 275         register char *dst;
 276         register const char *src;
 277 {
 278         register char c;
 279         char *start = dst;
 280         int state = 0;
 281
 282         while ( (c = *src++) ) {
 283         again:
 284                 switch (unvis(dst, c, &state, flag)) {
 285                 case UNVIS_VALID:
 286                         dst++;
 287                         break;
 288                 case UNVIS_VALIDPUSH:
 289                         dst++;
 290                         goto again;
 291                 case 0:
 292                 case UNVIS_NOCHAR:
 293                         break;
 294                 default:
 295                         return (-1);
 296                 }
 297         }
 298         if (unvis(dst, c, &state, UNVIS_END) == UNVIS_VALID)
 299                 dst++;
 300         *dst = '\0';
 301         return (dst - start);
 302 }