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 0x01 /* use octal \ddd format */ 55#define VIS_CSTYLE 0x02 /* 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 0x04 /* also encode space */ 62#define VIS_TAB 0x08 /* also encode tab */ 63#define VIS_NL 0x10 /* also encode newline */ 64#define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL) 65#define VIS_SAFE 0x20 /* only encode "unsafe" characters */ 66 67/* 68 * other 69 */ 70#define VIS_NOSLASH 0x40 /* inhibit printing '\' */ 71#define VIS_HTTPSTYLE 0x80 /* http-style escape % HEX HEX */ 72 73/* 74 * unvis return codes 75 */ 76#define UNVIS_VALID 1 /* character valid */ 77#define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */ 78#define UNVIS_NOCHAR 3 /* valid sequence, no character produced */ 79#define UNVIS_SYNBAD -1 /* unrecognized escape sequence */ 80#define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */ 81 82/* 83 * unvis flags 84 */ 85#define UNVIS_END 1 /* no more characters */ 86 87ROKEN_CPP_START 88 89ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL 90 rk_vis(char *, int, int, int); 91ROKEN_LIB_FUNCTION char * ROKEN_LIB_CALL 92 rk_svis(char *, int, int, int, const char *); 93ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL 94 rk_strvis(char *, const char *, int); 95ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL 96 rk_strsvis(char *, const char *, int, const char *); 97ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL 98 rk_strvisx(char *, const char *, size_t, int); 99ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL 100 rk_strsvisx(char *, const char *, size_t, int, const char *); 101ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL 102 rk_strunvis(char *, const char *); 103ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL 104 rk_strunvisx(char *, const char *, int); 105ROKEN_LIB_FUNCTION int ROKEN_LIB_CALL 106 rk_unvis(char *, int, int *, int); 107 108ROKEN_CPP_END 109 110#ifndef HAVE_VIS 111#undef vis 112#define vis(a,b,c,d) rk_vis(a,b,c,d) 113#endif 114 115#ifndef HAVE_SVIS 116#undef svis 117#define svis(a,b,c,d,e) rk_svis(a,b,c,d,e) 118#endif 119 120#ifndef HAVE_STRVIS 121#undef strvis 122#define strvis(a,b,c) rk_strvis(a,b,c) 123#endif 124 125#ifndef HAVE_STRSVIS 126#undef strsvis 127#define strsvis(a,b,c,d) rk_strsvis(a,b,c,d) 128#endif 129 130#ifndef HAVE_STRVISX 131#undef strvisx 132#define strvisx(a,b,c,d) rk_strvisx(a,b,c,d) 133#endif 134 135#ifndef HAVE_STRSVISX 136#undef strsvisx 137#define strsvisx(a,b,c,d,e) rk_strsvisx(a,b,c,d,e) 138#endif 139 140#ifndef HAVE_STRUNVIS 141#undef strunvis 142#define strunvis(a,b) rk_strunvis(a,b) 143#endif 144 145 146#ifndef HAVE_UNVIS 147#undef unvis 148#define unvis(a,b,c,d) rk_unvis(a,b,c,d) 149#endif 150 151#endif /* !_VIS_H_ */ 152