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