Home | History | Annotate | Line # | Download | only in include
vis.h revision 1.1 
      1 /*-
      2  * Copyright (c) 1990 The Regents of the University of California.
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  * 1. Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  * 2. Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in the
     12  *    documentation and/or other materials provided with the distribution.
     13  * 3. All advertising materials mentioning features or use of this software
     14  *    must display the following acknowledgement:
     15  *	This product includes software developed by the University of
     16  *	California, Berkeley and its contributors.
     17  * 4. Neither the name of the University nor the names of its contributors
     18  *    may be used to endorse or promote products derived from this software
     19  *    without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     31  * SUCH DAMAGE.
     32  *
     33  *	@(#)vis.h	5.9 (Berkeley) 4/3/91
     34  */
     35 
     36 #ifndef _VIS_H_
     37 #define	_VIS_H_
     38 
     39 /*
     40  * to select alternate encoding format
     41  */
     42 #define	VIS_OCTAL	0x01	/* use octal \ddd format */
     43 #define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropiate */
     44 
     45 /*
     46  * to alter set of characters encoded (default is to encode all
     47  * non-graphic except space, tab, and newline).
     48  */
     49 #define	VIS_SP		0x04	/* also encode space */
     50 #define	VIS_TAB		0x08	/* also encode tab */
     51 #define	VIS_NL		0x10	/* also encode newline */
     52 #define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
     53 #define	VIS_SAFE	0x20	/* only encode "unsafe" characters */
     54 
     55 /*
     56  * other
     57  */
     58 #define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
     59 
     60 /*
     61  * unvis return codes
     62  */
     63 #define	UNVIS_VALID	 1	/* character valid */
     64 #define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
     65 #define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
     66 #define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
     67 #define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
     68 
     69 /*
     70  * unvis flags
     71  */
     72 #define	UNVIS_END	1	/* no more characters */
     73 
     74 #include <sys/cdefs.h>
     75 
     76 __BEGIN_DECLS
     77 char	*vis __P((char *, char, int, char));
     78 int	strvis __P((char *, const char *, int));
     79 int	strvisx __P((char *, const char *, size_t, int));
     80 int	strunvis __P((char *, const char *));
     81 int	unvis __P((char *, char, int *, int));
     82 __END_DECLS
     83 
     84 #endif /* !_VIS_H_ */
     85