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