xref: /freebsd/include/ndbm.h (revision 6e8394b8baa7d5d9153ab90de6824bcd19b3b4e1)
1 /*-
2  * Copyright (c) 1990, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Margo Seltzer.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)ndbm.h	8.1 (Berkeley) 6/2/93
37  */
38 
39 #ifndef _NDBM_H_
40 #define	_NDBM_H_
41 
42 #include <db.h>
43 
44 /* Map dbm interface onto db(3). */
45 #define DBM_RDONLY	O_RDONLY
46 
47 /* Flags to dbm_store(). */
48 #define DBM_INSERT      0
49 #define DBM_REPLACE     1
50 
51 /*
52  * The db(3) support for ndbm always appends this suffix to the
53  * file name to avoid overwriting the user's original database.
54  */
55 #define	DBM_SUFFIX	".db"
56 
57 typedef struct {
58 	char *dptr;
59 	int dsize;
60 } datum;
61 
62 typedef DB DBM;
63 #define	dbm_pagfno(a)	DBM_PAGFNO_NOT_AVAILABLE
64 
65 __BEGIN_DECLS
66 int	 dbm_clearerr __P((DBM *));
67 void	 dbm_close __P((DBM *));
68 int	 dbm_delete __P((DBM *, datum));
69 int	 dbm_error __P((DBM *));
70 datum	 dbm_fetch __P((DBM *, datum));
71 datum	 dbm_firstkey __P((DBM *));
72 long	 dbm_forder __P((DBM *, datum));
73 datum	 dbm_nextkey __P((DBM *));
74 DBM	*dbm_open __P((const char *, int, int));
75 int	 dbm_store __P((DBM *, datum, datum, int));
76 int	 dbm_dirfno __P((DBM *));
77 __END_DECLS
78 
79 #endif /* !_NDBM_H_ */
80