annotate compat/vis.h @ 6:1c0e7f79e737

Fix incorrect field size for text fields The field size should be the string length excluding the terminating null byte which is there for convenience only when using the C API and not part of the on-disk format.
author Guido Berhoerster <guido+libpws@berhoerster.name>
date Thu, 10 Jan 2019 09:35:16 +0100
parents 97097b4b6bfb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1 /* $OpenBSD: vis.h,v 1.15 2015/07/20 01:52:27 millert Exp $ */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
2 /* $NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $ */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
3
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
4 /*-
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
5 * Copyright (c) 1990 The Regents of the University of California.
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
6 * All rights reserved.
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
7 *
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
8 * Redistribution and use in source and binary forms, with or without
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
9 * modification, are permitted provided that the following conditions
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
10 * are met:
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
11 * 1. Redistributions of source code must retain the above copyright
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
12 * notice, this list of conditions and the following disclaimer.
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
13 * 2. Redistributions in binary form must reproduce the above copyright
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
14 * notice, this list of conditions and the following disclaimer in the
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
15 * documentation and/or other materials provided with the distribution.
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
16 * 3. Neither the name of the University nor the names of its contributors
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
17 * may be used to endorse or promote products derived from this software
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
18 * without specific prior written permission.
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
19 *
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
30 * SUCH DAMAGE.
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
31 *
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
32 * @(#)vis.h 5.9 (Berkeley) 4/3/91
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
33 */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
34
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
35 #ifndef _VIS_H_
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
36 #define _VIS_H_
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
37
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
38 #include <sys/types.h>
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
39
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
40 /*
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
41 * to select alternate encoding format
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
42 */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
43 #define VIS_OCTAL 0x01 /* use octal \ddd format */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
44 #define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropriate */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
45
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
46 /*
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
47 * to alter set of characters encoded (default is to encode all
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
48 * non-graphic except space, tab, and newline).
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
49 */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
50 #define VIS_SP 0x04 /* also encode space */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
51 #define VIS_TAB 0x08 /* also encode tab */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
52 #define VIS_NL 0x10 /* also encode newline */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
53 #define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL)
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
54 #define VIS_SAFE 0x20 /* only encode "unsafe" characters */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
55 #define VIS_DQ 0x200 /* backslash-escape double quotes */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
56 #define VIS_ALL 0x400 /* encode all characters */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
57
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
58 /*
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
59 * other
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
60 */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
61 #define VIS_NOSLASH 0x40 /* inhibit printing '\' */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
62 #define VIS_GLOB 0x100 /* encode glob(3) magics and '#' */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
63
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
64 /*
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
65 * unvis return codes
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
66 */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
67 #define UNVIS_VALID 1 /* character valid */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
68 #define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
69 #define UNVIS_NOCHAR 3 /* valid sequence, no character produced */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
70 #define UNVIS_SYNBAD -1 /* unrecognized escape sequence */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
71 #define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
72
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
73 /*
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
74 * unvis flags
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
75 */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
76 #define UNVIS_END 1 /* no more characters */
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
77
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
78 char *vis(char *, int, int, int);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
79 int strvis(char *, const char *, int);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
80 int stravis(char **, const char *, int);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
81 int strnvis(char *, const char *, size_t, int);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
82 int strvisx(char *, const char *, size_t, int);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
83 int strunvis(char *, const char *);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
84 int unvis(char *, char, int *, int);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
85 ssize_t strnunvis(char *, const char *, size_t);
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
86
97097b4b6bfb Add pwsdump utility
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
87 #endif /* !_VIS_H_ */