xref: /freebsd/include/ndbm.h (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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  * $FreeBSD$
38  */
39 
40 #ifndef _NDBM_H_
41 #define	_NDBM_H_
42 
43 #include <db.h>
44 
45 /* Map dbm interface onto db(3). */
46 #define DBM_RDONLY	O_RDONLY
47 
48 /* Flags to dbm_store(). */
49 #define DBM_INSERT      0
50 #define DBM_REPLACE     1
51 
52 /*
53  * The db(3) support for ndbm always appends this suffix to the
54  * file name to avoid overwriting the user's original database.
55  */
56 #define	DBM_SUFFIX	".db"
57 
58 typedef struct {
59 	char *dptr;
60 	int dsize;
61 } datum;
62 
63 typedef DB DBM;
64 #define	dbm_pagfno(a)	DBM_PAGFNO_NOT_AVAILABLE
65 
66 __BEGIN_DECLS
67 int	 dbm_clearerr(DBM *);
68 void	 dbm_close(DBM *);
69 int	 dbm_delete(DBM *, datum);
70 int	 dbm_error(DBM *);
71 datum	 dbm_fetch(DBM *, datum);
72 datum	 dbm_firstkey(DBM *);
73 long	 dbm_forder(DBM *, datum);
74 datum	 dbm_nextkey(DBM *);
75 DBM	*dbm_open(const char *, int, int);
76 int	 dbm_store(DBM *, datum, datum, int);
77 int	 dbm_dirfno(DBM *);
78 __END_DECLS
79 
80 #endif /* !_NDBM_H_ */
81