Home | History | Annotate | Line # | Download | only in include
vis.h revision 1.13 
      1 /*	$NetBSD: vis.h,v 1.13 2002/12/12 23:00:37 lukem 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. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by the University of
     18  *	California, Berkeley and its contributors.
     19  * 4. Neither the name of the University nor the names of its contributors
     20  *    may be used to endorse or promote products derived from this software
     21  *    without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  *	@(#)vis.h	8.1 (Berkeley) 6/2/93
     36  */
     37 
     38 #ifndef _VIS_H_
     39 #define	_VIS_H_
     40 
     41 #include <sys/types.h>
     42 
     43 /*
     44  * to select alternate encoding format
     45  */
     46 #define	VIS_OCTAL	0x01	/* use octal \ddd format */
     47 #define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropiate */
     48 
     49 /*
     50  * to alter set of characters encoded (default is to encode all
     51  * non-graphic except space, tab, and newline).
     52  */
     53 #define	VIS_SP		0x04	/* also encode space */
     54 #define	VIS_TAB		0x08	/* also encode tab */
     55 #define	VIS_NL		0x10	/* also encode newline */
     56 #define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
     57 #define	VIS_SAFE	0x20	/* only encode "unsafe" characters */
     58 
     59 /*
     60  * other
     61  */
     62 #define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
     63 #define	VIS_HTTPSTYLE	0x80	/* http-style escape % HEX HEX */
     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 __P((char *, int, int, int));
     83 char	*svis __P((char *, int, int, int, const char *));
     84 int	strvis __P((char *, const char *, int));
     85 int	strsvis __P((char *, const char *, int, const char *));
     86 int	strvisx __P((char *, const char *, size_t, int));
     87 int	strsvisx __P((char *, const char *, size_t, int, const char *));
     88 int	strunvis __P((char *, const char *));
     89 int	strunvisx __P((char *, const char *, int));
     90 #ifdef __LIBC12_SOURCE__
     91 int	unvis __P((char *, int, int *, int));
     92 int	__unvis13 __P((char *, int, int *, int));
     93 #else
     94 int	unvis __P((char *, int, int *, int))	__RENAME(__unvis13);
     95 #endif
     96 __END_DECLS
     97 
     98 #endif /* !_VIS_H_ */
     99