vis.h 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. /* $OpenBSD: vis.h,v 1.15 2015/07/20 01:52:27 millert Exp $ */
  2. /* $NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $ */
  3. /*-
  4. * Copyright (c) 1990 The Regents of the University of California.
  5. * 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 5.9 (Berkeley) 4/3/91
  32. */
  33. #ifndef _VIS_H_
  34. #define _VIS_H_
  35. /*
  36. * to select alternate encoding format
  37. */
  38. #define VIS_OCTAL 0x01 /* use octal \ddd format */
  39. #define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropriate */
  40. /*
  41. * to alter set of characters encoded (default is to encode all
  42. * non-graphic except space, tab, and newline).
  43. */
  44. #define VIS_SP 0x04 /* also encode space */
  45. #define VIS_TAB 0x08 /* also encode tab */
  46. #define VIS_NL 0x10 /* also encode newline */
  47. #define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL)
  48. #define VIS_SAFE 0x20 /* only encode "unsafe" characters */
  49. #define VIS_DQ 0x200 /* backslash-escape double quotes */
  50. #define VIS_ALL 0x400 /* encode all characters */
  51. /*
  52. * other
  53. */
  54. #define VIS_NOSLASH 0x40 /* inhibit printing '\' */
  55. #define VIS_GLOB 0x100 /* encode glob(3) magics and '#' */
  56. /*
  57. * unvis return codes
  58. */
  59. #define UNVIS_VALID 1 /* character valid */
  60. #define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */
  61. #define UNVIS_NOCHAR 3 /* valid sequence, no character produced */
  62. #define UNVIS_SYNBAD -1 /* unrecognized escape sequence */
  63. #define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */
  64. /*
  65. * unvis flags
  66. */
  67. #define UNVIS_END 1 /* no more characters */
  68. char *vis(char *, int, int, int);
  69. int strvis(char *, const char *, int);
  70. int stravis(char **, const char *, int);
  71. int strnvis(char *, const char *, size_t, int);
  72. int strvisx(char *, const char *, size_t, int);
  73. int strunvis(char *, const char *);
  74. int unvis(char *, char, int *, int);
  75. ssize_t strnunvis(char *, const char *, size_t);
  76. #endif /* !_VIS_H_ */