mirror of
https://git.openldap.org/openldap/openldap.git
synced 2025-12-23 08:09:34 -05:00
75 lines
2.6 KiB
C
75 lines
2.6 KiB
C
/*
|
|
dict.h - dictionary functions
|
|
This file is part of the nss-ldapd library.
|
|
|
|
Copyright (C) 2007, 2008 Arthur de Jong
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _DICT_H
|
|
#define _DICT_H
|
|
|
|
#include "compat/attrs.h"
|
|
|
|
/*
|
|
These functions provide a mapping between a case insensitive
|
|
string and a pointer.
|
|
*/
|
|
typedef struct dictionary DICT;
|
|
|
|
/* Create a new instance of a dictionary. Returns NULL
|
|
in case of memory allocation errors. */
|
|
DICT *dict_new(void)
|
|
LIKE_MALLOC MUST_USE;
|
|
|
|
/* Add a relation in the dictionary. The key is duplicated
|
|
and can be reused by the caller. The pointer is just stored.
|
|
This function returns non-0 in case of memory allocation
|
|
errors. If the key was previously in use the value
|
|
is replaced. All key comparisons are case insensitive. */
|
|
int dict_put(DICT *dict,const char *key,void *value);
|
|
|
|
/* Look up a key in the dictionary and return the associated
|
|
value. NULL is returned if the key is not found in the dictionary.
|
|
All key comparisons are case insensitive. */
|
|
void *dict_get(DICT *dict,const char *key)
|
|
MUST_USE;
|
|
|
|
/* Delete a key-value association from the dictionary.
|
|
All key comparisons are case insensitive. */
|
|
/*void dict_del(DICT *dict,const char *key);*/
|
|
|
|
/* Remove the dictionary from memory. All allocated storage
|
|
for the dictionary and the keys is freed.
|
|
Note that values are not freed. This is the responsibility
|
|
of the caller. */
|
|
void dict_free(DICT *dict);
|
|
|
|
/* Function for looping over all dictionary keys and values.
|
|
This resets the search to the beginning of the dictionary.
|
|
This is required before calling dict_loop_next(); */
|
|
void dict_loop_first(DICT *dict);
|
|
|
|
/* Function for looping over all dictionary keys and values.
|
|
This returns a stored key. NULL is returned when all
|
|
keys have been returned. The key and value are
|
|
stored in the key and value parameters if they aren't
|
|
NULL. */
|
|
const char *dict_loop_next(DICT *dict,const char **key,void **value)
|
|
MUST_USE;
|
|
|
|
#endif /* _DICT_H */
|