xref: /minix/crypto/external/bsd/libsaslc/dist/src/dict.h (revision 0a6a1f1d)
1 /* $NetBSD: dict.h,v 1.4 2011/02/12 23:21:32 christos Exp $ */
2 
3 /* Copyright (c) 2010 The NetBSD Foundation, Inc.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The NetBSD Foundation
7  * by Mateusz Kocielski.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *        This product includes software developed by the NetBSD
20  *        Foundation, Inc. and its contributors.
21  * 4. Neither the name of The NetBSD Foundation nor the names of its
22  *    contributors may be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED.	IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 
39 #ifndef _DICT_H_
40 #define _DICT_H_
41 
42 #include <stdbool.h>
43 #include <stdlib.h>
44 
45 typedef enum {
46 	DICT_OK = 0,
47 	DICT_NOMEM,
48 	DICT_KEYNOTFOUND,
49 	DICT_KEYEXISTS,
50 	DICT_KEYINVALID,
51 	DICT_VALBAD
52 } saslc__dict_result_t;
53 
54 /* dictionary type */
55 typedef struct saslc__dict_t saslc__dict_t;
56 
57 /* interface */
58 saslc__dict_t *saslc__dict_create(void);
59 void saslc__dict_destroy(saslc__dict_t *);
60 const char *saslc__dict_get(saslc__dict_t *, const char *);
61 size_t saslc__dict_get_len(saslc__dict_t *, const char *);
62 saslc__dict_result_t saslc__dict_insert(saslc__dict_t *, const char *,
63     const char *);
64 saslc__dict_result_t saslc__dict_remove(saslc__dict_t *, const char *);
65 
66 #endif /* ! _DICT_H_ */
67