1 /* $NetBSD: vis.h,v 1.25 2017/04/23 01:57:36 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 #include <machine/stdint.h> 38 39 #ifndef _SIZE_T_DECLARED 40 #define _SIZE_T_DECLARED 41 typedef __size_t size_t; 42 #endif 43 44 /* 45 * to select alternate encoding format 46 */ 47 #define VIS_OCTAL 0x0001 /* use octal \ddd format */ 48 #define VIS_CSTYLE 0x0002 /* use \[nrft0..] where appropiate */ 49 50 /* 51 * to alter set of characters encoded (default is to encode all 52 * non-graphic except space, tab, and newline). 53 */ 54 #define VIS_SP 0x0004 /* also encode space */ 55 #define VIS_TAB 0x0008 /* also encode tab */ 56 #define VIS_NL 0x0010 /* also encode newline */ 57 #define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL) 58 #define VIS_SAFE 0x0020 /* only encode "unsafe" characters */ 59 #define VIS_DQ 0x8000 /* also encode double quotes */ 60 #define VIS_ALL 0x00010000 /* encode all characters */ 61 62 /* 63 * other 64 */ 65 #define VIS_NOSLASH 0x0040 /* inhibit printing '\' */ 66 #define VIS_HTTP1808 0x0080 /* http-style escape % hex hex */ 67 #define VIS_HTTPSTYLE 0x0080 /* http-style escape % hex hex */ 68 #define VIS_MIMESTYLE 0x0100 /* mime-style escape = HEX HEX */ 69 #define VIS_HTTP1866 0x0200 /* http-style &#num; or &string; */ 70 #define VIS_NOESCAPE 0x0400 /* don't decode `\' */ 71 #define _VIS_END 0x0800 /* for unvis */ 72 #define VIS_GLOB 0x1000 /* encode glob(3) magic characters */ 73 #define VIS_SHELL 0x2000 /* encode shell special characters [not glob] */ 74 #define VIS_META (VIS_WHITE | VIS_GLOB | VIS_SHELL) 75 #define VIS_NOLOCALE 0x4000 /* encode using the C locale */ 76 77 /* 78 * unvis return codes 79 */ 80 #define UNVIS_VALID 1 /* character valid */ 81 #define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */ 82 #define UNVIS_NOCHAR 3 /* valid sequence, no character produced */ 83 #define UNVIS_SYNBAD -1 /* unrecognized escape sequence */ 84 #define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */ 85 86 /* 87 * unvis flags 88 */ 89 #define UNVIS_END _VIS_END /* no more characters */ 90 91 #include <sys/cdefs.h> 92 93 __BEGIN_DECLS 94 char *vis(char *, int, int, int); 95 char *nvis(char *, size_t, int, int, int); 96 97 char *svis(char *, int, int, int, const char *); 98 char *snvis(char *, size_t, int, int, int, const char *); 99 100 int strvis(char *, const char *, int); 101 int stravis(char **, const char *, int); 102 int strnvis(char *, const char *, size_t, int); 103 104 int strsvis(char *, const char *, int, const char *); 105 int strsnvis(char *, size_t, const char *, int, const char *); 106 107 int strvisx(char *, const char *, size_t, int); 108 int strnvisx(char *, size_t, const char *, size_t, int); 109 int strenvisx(char *, size_t, const char *, size_t, int, int *); 110 111 int strsvisx(char *, const char *, size_t, int, const char *); 112 int strsnvisx(char *, size_t, const char *, size_t, int, const char *); 113 int strsenvisx(char *, size_t, const char *, size_t , int, const char *, 114 int *); 115 116 int strunvis(char *, const char *); 117 int strnunvis(char *, size_t, const char *); 118 119 int strunvisx(char *, const char *, int); 120 int strnunvisx(char *, size_t, const char *, int); 121 122 int unvis(char *, int, int *, int); 123 __END_DECLS 124 125 #endif /* !_VIS_H_ */ 126