xref: /openbsd/lib/libcurses/hashed_db.h (revision 3bef86f7)
1 /* $OpenBSD: hashed_db.h,v 1.2 2023/10/17 09:52:08 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright 2020 Thomas E. Dickey                                          *
5  * Copyright 2006-2014,2017 Free Software Foundation, Inc.                  *
6  *                                                                          *
7  * Permission is hereby granted, free of charge, to any person obtaining a  *
8  * copy of this software and associated documentation files (the            *
9  * "Software"), to deal in the Software without restriction, including      *
10  * without limitation the rights to use, copy, modify, merge, publish,      *
11  * distribute, distribute with modifications, sublicense, and/or sell       *
12  * copies of the Software, and to permit persons to whom the Software is    *
13  * furnished to do so, subject to the following conditions:                 *
14  *                                                                          *
15  * The above copyright notice and this permission notice shall be included  *
16  * in all copies or substantial portions of the Software.                   *
17  *                                                                          *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25  *                                                                          *
26  * Except as contained in this notice, the name(s) of the above copyright   *
27  * holders shall not be used in advertising or otherwise to promote the     *
28  * sale, use or other dealings in this Software without prior written       *
29  * authorization.                                                           *
30  ****************************************************************************/
31 
32 /****************************************************************************
33  *  Author: Thomas E. Dickey                        2006                    *
34  ****************************************************************************/
35 
36 /*
37  * $Id: hashed_db.h,v 1.2 2023/10/17 09:52:08 nicm Exp $
38  */
39 
40 #ifndef HASHED_DB_H
41 #define HASHED_DB_H 1
42 
43 #include <ncurses_cfg.h>
44 
45 #include <curses.h>
46 
47 #if USE_HASHED_DB
48 
49 #define DB_DBM_HSEARCH 0	/* quiet gcc -Wundef with db6 */
50 
51 #include <db.h>
52 
53 #ifndef DBM_SUFFIX
54 #define DBM_SUFFIX ".db"
55 #endif
56 
57 #ifdef DB_VERSION_MAJOR
58 #define HASHED_DB_API DB_VERSION_MAJOR
59 #else
60 #define HASHED_DB_API 1		/* e.g., db 1.8.5 */
61 #endif
62 
63 extern NCURSES_EXPORT(DB *) _nc_db_open(const char * /* path */, bool /* modify */);
64 extern NCURSES_EXPORT(bool) _nc_db_have_data(DBT * /* key */, DBT * /* data */, char ** /* buffer */, int * /* size */);
65 extern NCURSES_EXPORT(bool) _nc_db_have_index(DBT * /* key */, DBT * /* data */, char ** /* buffer */, int * /* size */);
66 extern NCURSES_EXPORT(int) _nc_db_close(DB * /* db */);
67 extern NCURSES_EXPORT(int) _nc_db_first(DB * /* db */, DBT * /* key */, DBT * /* data */);
68 extern NCURSES_EXPORT(int) _nc_db_next(DB * /* db */, DBT * /* key */, DBT * /* data */);
69 extern NCURSES_EXPORT(int) _nc_db_get(DB * /* db */, DBT * /* key */, DBT * /* data */);
70 extern NCURSES_EXPORT(int) _nc_db_put(DB * /* db */, DBT * /* key */, DBT * /* data */);
71 
72 #endif
73 
74 #endif /* HASHED_DB_H */
75