lib/roken/vis.hin

   1 /*      $NetBSD: vis.h,v 1.16 2005/09/13 01:44:32 christos Exp $        */
   2
   3 /*-
   4  * Copyright (c) 1990, 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  *      @(#)vis.h       8.1 (Berkeley) 6/2/93
  32  */
  33
  34 #ifndef _VIS_H_
  35 #define _VIS_H_
  36
  37 #ifndef ROKEN_LIB_FUNCTION
  38 #ifdef _WIN32
  39 #define ROKEN_LIB_FUNCTION
  40 #define ROKEN_LIB_CALL     __cdecl
  41 #else
  42 #define ROKEN_LIB_FUNCTION
  43 #define ROKEN_LIB_CALL
  44 #endif
  45 #endif
  46
  47 #include <sys/types.h>
  48
  49 #include <roken.h>
  50
  51 /*
  52  * to select alternate encoding format
  53  */
  54 #define VIS_OCTAL       0x0001  /* use octal \ddd format */
  55 #define VIS_CSTYLE      0x0002  /* use \[nrft0..] where appropiate */
  56
  57 /*
  58  * to alter set of characters encoded (default is to encode all
  59  * non-graphic except space, tab, and newline).
  60  */
  61 #define VIS_SP          0x0004  /* also encode space */
  62 #define VIS_TAB         0x0008  /* also encode tab */
  63 #define VIS_NL          0x0010  /* also encode newline */
  64 #define VIS_WHITE       (VIS_SP | VIS_TAB | VIS_NL)
  65 #define VIS_SAFE        0x0020  /* only encode "unsafe" characters */
  66 #define VIS_DQ          0x8000  /* also encode double quotes */
  67
  68 /*
  69  * other
  70  */
  71 #define VIS_NOSLASH     0x0040  /* inhibit printing '\' */
  72 #define VIS_HTTPSTYLE   0x0080  /* http-style escape % HEX HEX */
  73 #define VIS_HTTP1808    0x0080  /* http-style escape % hex hex */
  74 #define VIS_GLOB        0x0100  /* encode glob(3) magic characters */
  75 #if 0
  76 /*
  77  * Not yet.  FreeBSD calls 0x0400 VIS_HTTP1866, but if that means RFC1866,
  78  * that's HTML 2.0, not HTTP.  Argh.
  79  */
  80 #define VIS_MIMESTYLE   0x0200  /* mime-style escape = HEX HEX */
  81 #define VIS_HTML1866    0x0400  /* HTML-style &#num; or &string; */
  82 #endif
  83 #define VIS_NOESCAPE    0x0800  /* don't decode `\'; URL-encode only when given
  84                                  * with VIS_HTTPSTYLE */
  85 #if 0
  86 #define _VIS_END        0x1000  /* for unvis */
  87 #endif
  88 #define VIS_SHELL       0x2000  /* encode shell special characters [not glob] */
  89 #define VIS_META        (VIS_WHITE | VIS_GLOB | VIS_SHELL)
  90 #define VIS_NOLOCALE    0x4000  /* encode using the C locale */
  91
  92 /*
  93  * unvis return codes
  94  */
  95 #define UNVIS_VALID      1      /* character valid */
  96 #define UNVIS_VALIDPUSH  2      /* character valid, push back passed char */
  97 #define UNVIS_NOCHAR     3      /* valid sequence, no character produced */
  98 #define UNVIS_SYNBAD    -1      /* unrecognized escape sequence */
  99 #define UNVIS_ERROR     -2      /* decoder in unknown state (unrecoverable) */
 100
 101 /*
 102  * unvis flags
 103  */
 104 #define UNVIS_END       1       /* no more characters */
 105
 106 ROKEN_CPP_START
 107
 108 ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL
 109         rk_vis(char *, int, int, int);
 110 ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL
 111         rk_svis(char *, int, int, int, const char *);
 112 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 113         rk_strvis(char *, const char *, int);
 114 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 115         rk_strsvis(char *, const char *, int, const char *);
 116 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 117         rk_strvisx(char *, const char *, size_t, int);
 118 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 119         rk_strsvisx(char *, const char *, size_t, int, const char *);
 120 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 121         rk_strunvis(char *, const char *);
 122 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 123         rk_strunvisx(char *, const char *, int);
 124 ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL
 125         rk_unvis(char *, int, int *, int);
 126
 127 ROKEN_CPP_END
 128
 129 #ifndef HAVE_VIS
 130 #undef vis
 131 #define vis(a,b,c,d) rk_vis(a,b,c,d)
 132 #endif
 133
 134 #ifndef HAVE_SVIS
 135 #undef svis
 136 #define svis(a,b,c,d,e) rk_svis(a,b,c,d,e)
 137 #endif
 138
 139 #ifndef HAVE_STRVIS
 140 #undef strvis
 141 #define strvis(a,b,c) rk_strvis(a,b,c)
 142 #endif
 143
 144 #ifndef HAVE_STRSVIS
 145 #undef strsvis
 146 #define strsvis(a,b,c,d) rk_strsvis(a,b,c,d)
 147 #endif
 148
 149 #ifndef HAVE_STRVISX
 150 #undef strvisx
 151 #define strvisx(a,b,c,d) rk_strvisx(a,b,c,d)
 152 #endif
 153
 154 #ifndef HAVE_STRSVISX
 155 #undef strsvisx
 156 #define strsvisx(a,b,c,d,e) rk_strsvisx(a,b,c,d,e)
 157 #endif
 158
 159 #ifndef HAVE_STRUNVIS
 160 #undef strunvis
 161 #define strunvis(a,b) rk_strunvis(a,b)
 162 #endif
 163
 164
 165 #ifndef HAVE_UNVIS
 166 #undef unvis
 167 #define unvis(a,b,c,d) rk_unvis(a,b,c,d)
 168 #endif
 169
 170 #endif /* !_VIS_H_ */