blob: 74f218e7964d51d03a48e0621b6771a4c57d326a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
/*
* Copyright (C) 2014 Tobias Brunner
* HSR Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program 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 General Public License
* for more details.
*/
/**
* @defgroup dictionary dictionary
* @{ @ingroup collections
*/
#ifndef DICTIONARY_H_
#define DICTIONARY_H_
#include <collections/enumerator.h>
typedef struct dictionary_t dictionary_t;
/**
* Interface for read-only dictionaries.
*/
struct dictionary_t {
/**
* Create an enumerator over the key/value pairs in the dictionary.
*
* @return enumerator over (const void *key, void *value)
*/
enumerator_t *(*create_enumerator)(dictionary_t *this);
/**
* Returns the value with the given key, if the dictionary contains such an
* entry, otherwise NULL is returned.
*
* @param key the key of the requested value
* @return the value, NULL if not found
*/
void *(*get)(dictionary_t *this, const void *key);
/**
* Destroys a dictionary object.
*/
void (*destroy)(dictionary_t *this);
};
#endif /** DICTIONARY_H_ @}*/
|
