1 /** $MirOS: src/include/vis.h,v 1.3 2013/10/31 20:06:09 tg Exp $ */ 2 /* $OpenBSD: vis.h,v 1.11 2005/08/09 19:38:31 millert Exp $ */ 3 /* $NetBSD: vis.h,v 1.16 2005/09/13 01:44:32 christos Exp $ */ 4 5 /*- 6 * Copyright © 2013 7 * Thorsten “mirabilos” Glaser <tg@mirbsd.org> 8 * Copyright (c) 1990, 1993 9 * The Regents of the University of California. 10 * All rights reserved. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)vis.h 8.1 (Berkeley) 6/2/93 37 */ 38 39 #ifndef _VIS_H_ 40 #define _VIS_H_ 41 42 /* 43 * to select alternate encoding format 44 */ 45 #define VIS_OCTAL 0x01 /* use octal \ddd format */ 46 #define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropriate */ 47 48 /* 49 * to alter set of characters encoded (default is to encode all 50 * non-graphic except space, tab, and newline). 51 */ 52 #define VIS_SP 0x04 /* also encode space */ 53 #define VIS_TAB 0x08 /* also encode tab */ 54 #define VIS_NL 0x10 /* also encode newline */ 55 #define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL) 56 #define VIS_SAFE 0x20 /* only encode "unsafe" characters */ 57 58 /* 59 * other 60 */ 61 #define VIS_NOSLASH 0x40 /* inhibit printing '\' */ 62 #define VIS_HTTPSTYLE 0x80 /* http-style escape % HEX HEX */ 63 #define VIS_GLOB 0x100 /* encode glob(3) magics and '#' */ 64 65 /* 66 * unvis return codes 67 */ 68 #define UNVIS_VALID 1 /* character valid */ 69 #define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */ 70 #define UNVIS_NOCHAR 3 /* valid sequence, no character produced */ 71 #define UNVIS_SYNBAD -1 /* unrecognized escape sequence */ 72 #define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */ 73 74 /* 75 * unvis flags 76 */ 77 #define UNVIS_END 1 /* no more characters */ 78 79 #include <sys/cdefs.h> 80 81 __BEGIN_DECLS 82 char *vis(char *, int, int, int); 83 char *svis(char *, int, int, int, const char *); 84 int strvis(char *, const char *, int); 85 int strsvis(char *, const char *, int, const char *); 86 int strnvis(char *, const char *, size_t, int) 87 __attribute__((__bounded__(__string__, 1, 3))); 88 int strnsvis(char *, const char *, size_t, int, const char *) 89 __attribute__((__bounded__(__string__, 1, 3))); 90 int strvisx(char *, const char *, size_t, int) 91 __attribute__((__bounded__(__string__, 1, 3))); 92 int strsvisx(char *, const char *, size_t, int, const char *) 93 __attribute__((__bounded__(__string__, 1, 3))); 94 int strunvis(char *, const char *); 95 int strunvisx(char *, const char *, int) 96 __attribute__((__bounded__(__string__, 1, 3))); 97 int unvis(char *, char, int *, int); 98 ssize_t strnunvis(char *, const char *, size_t) 99 __attribute__((__bounded__(__string__, 1, 3))); 100 __END_DECLS 101 102 #endif /* !_VIS_H_ */ 103