xref: /freebsd/include/ndbm.h (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
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. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)ndbm.h	8.1 (Berkeley) 6/2/93
33  * $FreeBSD$
34  */
35 
36 #ifndef _NDBM_H_
37 #define	_NDBM_H_
38 
39 #include <db.h>
40 
41 /* Map dbm interface onto db(3). */
42 #define DBM_RDONLY	O_RDONLY
43 
44 /* Flags to dbm_store(). */
45 #define DBM_INSERT      0
46 #define DBM_REPLACE     1
47 
48 /*
49  * The db(3) support for ndbm always appends this suffix to the
50  * file name to avoid overwriting the user's original database.
51  */
52 #define	DBM_SUFFIX	".db"
53 
54 typedef struct {
55 	void *dptr;
56 	int dsize;	/* XXX Should be size_t according to 1003.1-2008. */
57 } datum;
58 
59 typedef DB DBM;
60 #define	dbm_pagfno(a)	DBM_PAGFNO_NOT_AVAILABLE
61 
62 __BEGIN_DECLS
63 int	 dbm_clearerr(DBM *);
64 void	 dbm_close(DBM *);
65 int	 dbm_delete(DBM *, datum);
66 int	 dbm_error(DBM *);
67 datum	 dbm_fetch(DBM *, datum);
68 datum	 dbm_firstkey(DBM *);
69 #if __BSD_VISIBLE
70 long	 dbm_forder(DBM *, datum);
71 #endif
72 datum	 dbm_nextkey(DBM *);
73 DBM	*dbm_open(const char *, int, mode_t);
74 int	 dbm_store(DBM *, datum, datum, int);
75 #if __BSD_VISIBLE
76 int	 dbm_dirfno(DBM *);
77 #endif
78 __END_DECLS
79 
80 #endif /* !_NDBM_H_ */
81