bsd/include/vis.h

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