236d865ed09c5df65411f500e8dc3114a3ca0f9f
[openvswitch] / lib / shash.h
1 /*
2  * Copyright (c) 2009 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef SHASH_H
18 #define SHASH_H 1
19
20 #include "hmap.h"
21
22 struct shash_node {
23     struct hmap_node node;
24     char *name;
25     void *data;
26 };
27
28 struct shash {
29     struct hmap map;
30 };
31
32 #define SHASH_INITIALIZER(SHASH) { HMAP_INITIALIZER(&(SHASH)->map) }
33
34 #define SHASH_FOR_EACH(SHASH_NODE, SHASH)                               \
35     HMAP_FOR_EACH (SHASH_NODE, struct shash_node, node, &(SHASH)->map)
36
37 #define SHASH_FOR_EACH_SAFE(SHASH_NODE, NEXT, SHASH)                \
38     HMAP_FOR_EACH_SAFE (SHASH_NODE, NEXT, struct shash_node, node,  \
39                         &(SHASH)->map)
40
41 void shash_init(struct shash *);
42 void shash_destroy(struct shash *);
43 void shash_clear(struct shash *);
44 bool shash_is_empty(const struct shash *);
45 size_t shash_count(const struct shash *);
46 struct shash_node *shash_add(struct shash *, const char *, const void *);
47 void shash_delete(struct shash *, struct shash_node *);
48 struct shash_node *shash_find(const struct shash *, const char *);
49 void *shash_find_data(const struct shash *, const char *);
50 void *shash_find_and_delete(struct shash *, const char *);
51 struct shash_node *shash_first(const struct shash *);
52 const struct shash_node **shash_sort(const struct shash *);
53
54 #endif /* shash.h */