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