Add the source code for /usr/src/usr.bin from the Net/2 tape
[unix-history] / usr / src / include / vis.h
index 28b0613..72d6114 100644 (file)
@@ -1,59 +1,84 @@
-/*
- * Copyright (c) 1989 The Regents of the University of California.
+/*-
+ * Copyright (c) 1990 The Regents of the University of California.
  * All rights reserved.
  *
  * All rights reserved.
  *
- * Redistribution and use in source and binary forms are permitted
- * provided that the above copyright notice and this paragraph are
- * duplicated in all such forms and that any documentation,
- * advertising materials, and other materials related to such
- * distribution and use acknowledge that the software was developed
- * by the University of California, Berkeley.  The name of the
- * University may not be used to endorse or promote products derived
- * from this software without specific prior written permission.
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *     This product includes software developed by the University of
+ *     California, Berkeley and its contributors.
+ * 4. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
  *
  *
- *     @(#)vis.h       5.2 (Berkeley) %G%
+ *     @(#)vis.h       5.9 (Berkeley) 4/3/91
  */
 
  */
 
-
-/*
- * vis flags
- */
+#ifndef _VIS_H_
+#define        _VIS_H_
 
 /*
  * to select alternate encoding format
  */
 #define        VIS_OCTAL       0x01    /* use octal \ddd format */
 
 /*
  * to select alternate encoding format
  */
 #define        VIS_OCTAL       0x01    /* use octal \ddd format */
-#define        VIS_CSTYLE      0x02    /* use \[nrft...] where appropiate */
+#define        VIS_CSTYLE      0x02    /* use \[nrft0..] where appropiate */
+
 /*
 /*
- * to alter set of characters encoded
- * (default is to encode all non-graphic except space, tab, and newline)
+ * to alter set of characters encoded (default is to encode all
+ * non-graphic except space, tab, and newline).
  */
  */
-#define        VIS_TAB         0x04    /* also encode tab */
-#define        VIS_WHITE       0x08    /* also encode space, tab, and newline */
-#define        VIS_SAFE        0x10    /* only encode "unsafe" characters */
+#define        VIS_SP          0x04    /* also encode space */
+#define        VIS_TAB         0x08    /* also encode tab */
+#define        VIS_NL          0x10    /* also encode newline */
+#define        VIS_WHITE       (VIS_SP | VIS_TAB | VIS_NL)
+#define        VIS_SAFE        0x20    /* only encode "unsafe" characters */
+
 /*
  * other
  */
 /*
  * other
  */
-#define        VIS_NOSLASH     0x20    /* inhibit printing '\' */
-#define        VIS_NEXTC       0x40    /* nextc character is valid */
+#define        VIS_NOSLASH     0x40    /* inhibit printing '\' */
 
 
-extern char *cvis();
+/*
+ * unvis return codes
+ */
+#define        UNVIS_VALID      1      /* character valid */
+#define        UNVIS_VALIDPUSH  2      /* character valid, push back passed char */
+#define        UNVIS_NOCHAR     3      /* valid sequence, no character produced */
+#define        UNVIS_SYNBAD    -1      /* unrecognized escape sequence */
+#define        UNVIS_ERROR     -2      /* decoder in unknown state (unrecoverable) */
 
 /*
  * unvis flags
  */
 
 /*
  * unvis flags
  */
+#define        UNVIS_END       1       /* no more characters */
 
 
-#define        UNVIS_HAT       0x01    /* treat ^ as special */
-#define        UNVIS_END       0x02    /* reset decode machine */
+#include <sys/cdefs.h>
 
 
-/*
- * return codes
- */
-#define        UNVIS_NEEDMORE  0       /* not done, feed another char */
-#define        UNVIS_OK                1       /* done, character ready */
-#define        UNVIS_OKPUSH    2       /* done, push back passed char */
-#define        UNVIS_NOCHAR    3       /* done, no character ready (hidden newline) */
-#define        UNVIS_SYNBAD    -1      /* unrecognized escape sequence */
+__BEGIN_DECLS
+char   *vis __P((char *, char, int, char));
+int    strvis __P((char *, const char *, int));
+int    strvisx __P((char *, const char *, size_t, int));
+int    strunvis __P((char *, const char *));
+int    unvis __P((char *, char, int *, int));
+__END_DECLS
+
+#endif /* !_VIS_H_ */