lib/libc/gen/unvis.3

   1 .\"     $NetBSD: unvis.3,v 1.17 2005/11/10 17:23:26 christos Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   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.
  17 .\"
  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
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)unvis.3     8.2 (Berkeley) 12/11/93
  31 .\"
  32 .Dd February 10, 2009
  33 .Dt UNVIS 3
  34 .Os
  35 .Sh NAME
  36 .Nm unvis ,
  37 .Nm strunvis
  38 .Nd decode a visual representation of characters
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In vis.h
  43 .Ft int
  44 .Fn unvis "char *cp" "int c" "int *astate" "int flag"
  45 .Ft int
  46 .Fn strunvis "char *dst" "const char *src"
  47 .Ft int
  48 .Fn strunvisx "char *dst" "const char *src" "int flag"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn unvis ,
  52 .Fn strunvis
  53 and
  54 .Fn strunvisx
  55 functions
  56 are used to decode a visual representation of characters, as produced
  57 by the
  58 .Xr vis 3
  59 function, back into
  60 the original form.
  61 .Pp
  62 The
  63 .Fn unvis
  64 function is called with successive characters in
  65 .Ar c
  66 until a valid sequence is recognized, at which time the decoded
  67 character is available at the character pointed to by
  68 .Ar cp .
  69 .Pp
  70 The
  71 .Fn strunvis
  72 function decodes the characters pointed to by
  73 .Ar src
  74 into the buffer pointed to by
  75 .Ar dst .
  76 The
  77 .Fn strunvis
  78 function simply copies
  79 .Ar src
  80 to
  81 .Ar dst ,
  82 decoding any escape sequences along the way,
  83 and returns the number of characters placed into
  84 .Ar dst ,
  85 or \-1 if an
  86 invalid escape sequence was detected.
  87 The size of
  88 .Ar dst
  89 should be equal to the size of
  90 .Ar src
  91 (that is, no expansion takes place during decoding).
  92 .Pp
  93 The
  94 .Fn strunvisx
  95 function does the same as the
  96 .Fn strunvis
  97 function,
  98 but it allows you to add a flag that specifies the style the string
  99 .Ar src
 100 is encoded with.
 101 Currently, the supported flags are:
 102 .Dv VIS_HTTPSTYLE
 103 and
 104 .Dv VIS_MIMESTYLE .
 105 .Pp
 106 The
 107 .Fn unvis
 108 function implements a state machine that can be used to decode an
 109 arbitrary stream of bytes.
 110 All state associated with the bytes being decoded is stored outside the
 111 .Fn unvis
 112 function (that is, a pointer to the state is passed in), so
 113 calls decoding different streams can be freely intermixed.
 114 To start decoding a stream of bytes, first initialize an integer to zero.
 115 Call
 116 .Fn unvis
 117 with each successive byte, along with a pointer
 118 to this integer, and a pointer to a destination character.
 119 The
 120 .Fn unvis
 121 function has several return codes that must be handled properly.
 122 They are:
 123 .Bl -tag -width UNVIS_VALIDPUSH
 124 .It Li \&0 (zero)
 125 Another character is necessary; nothing has been recognized yet.
 126 .It Dv UNVIS_VALID
 127 A valid character has been recognized and is available at the location
 128 pointed to by cp.
 129 .It Dv UNVIS_VALIDPUSH
 130 A valid character has been recognized and is available at the location
 131 pointed to by cp; however, the character currently passed in should
 132 be passed in again.
 133 .It Dv UNVIS_NOCHAR
 134 A valid sequence was detected, but no character was produced.
 135 This return code is necessary to indicate a logical break between characters.
 136 .It Dv UNVIS_SYNBAD
 137 An invalid escape sequence was detected, or the decoder is in an unknown state.
 138 The decoder is placed into the starting state.
 139 .El
 140 .Pp
 141 When all bytes in the stream have been processed, call
 142 .Fn unvis
 143 one more time with flag set to
 144 .Dv UNVIS_END
 145 to extract any remaining character (the character passed in is ignored).
 146 .Pp
 147 The
 148 .Ar flag
 149 argument is also used to specify the encoding style of the source.
 150 If set to
 151 .Dv VIS_HTTPSTYLE ,
 152 .Fn unvis
 153 will decode URI strings as specified in RFC 1808.
 154 If set to
 155 .Dv VIS_MIMESTYLE ,
 156 .Fn unvis
 157 will decode MIME Quoted-Printable strings as specified in RFC 2045.
 158 .Pp
 159 The following code fragment illustrates a proper use of
 160 .Fn unvis .
 161 .Bd -literal -offset indent
 162 int state = 0;
 163 char out;
 164
 165 while ((ch = getchar()) != EOF) {
 166 again:
 167         switch(unvis(\*[Am]out, ch, \*[Am]state, 0)) {
 168         case 0:
 169         case UNVIS_NOCHAR:
 170                 break;
 171         case UNVIS_VALID:
 172                 (void)putchar(out);
 173                 break;
 174         case UNVIS_VALIDPUSH:
 175                 (void)putchar(out);
 176                 goto again;
 177         case UNVIS_SYNBAD:
 178                 errx(EXIT_FAILURE, "Bad character sequence!");
 179         }
 180 }
 181 if (unvis(\*[Am]out, '\e0', \*[Am]state, UNVIS_END) == UNVIS_VALID)
 182         (void)putchar(out);
 183 .Ed
 184 .Sh SEE ALSO
 185 .Xr unvis 1 ,
 186 .Xr vis 1 ,
 187 .Xr vis 3
 188 .Rs
 189 .%A R. Fielding
 190 .%T Relative Uniform Resource Locators
 191 .%O RFC1808
 192 .Re
 193 .Sh HISTORY
 194 The
 195 .Fn unvis
 196 function
 197 first appeared in
 198 .Bx 4.4 .