ovs-brcompatd: Simplify code in brc_recv_update().
[openvswitch] / lib / shash.h
1 /*
2  * Copyright (c) 2009, 2010 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 #ifdef  __cplusplus
23 extern "C" {
24 #endif
25
26 struct shash_node {
27     struct hmap_node node;
28     char *name;
29     void *data;
30 };
31
32 struct shash {
33     struct hmap map;
34 };
35
36 #define SHASH_INITIALIZER(SHASH) { HMAP_INITIALIZER(&(SHASH)->map) }
37
38 #define SHASH_FOR_EACH(SHASH_NODE, SHASH) \
39     HMAP_FOR_EACH (SHASH_NODE, node, &(SHASH)->map)
40
41 #define SHASH_FOR_EACH_SAFE(SHASH_NODE, NEXT, SHASH) \
42     HMAP_FOR_EACH_SAFE (SHASH_NODE, NEXT, node, &(SHASH)->map)
43
44 void shash_init(struct shash *);
45 void shash_destroy(struct shash *);
46 void shash_destroy_free_data(struct shash *);
47 void shash_swap(struct shash *, struct shash *);
48 void shash_moved(struct shash *);
49 void shash_clear(struct shash *);
50 void shash_clear_free_data(struct shash *);
51 bool shash_is_empty(const struct shash *);
52 size_t shash_count(const struct shash *);
53 struct shash_node *shash_add(struct shash *, const char *, const void *);
54 struct shash_node *shash_add_nocopy(struct shash *, char *, const void *);
55 bool shash_add_once(struct shash *, const char *, const void *);
56 void shash_add_assert(struct shash *, const char *, const void *);
57 void *shash_replace(struct shash *, const char *, const void *data);
58 void shash_delete(struct shash *, struct shash_node *);
59 char *shash_steal(struct shash *, struct shash_node *);
60 struct shash_node *shash_find(const struct shash *, const char *);
61 void *shash_find_data(const struct shash *, const char *);
62 void *shash_find_and_delete(struct shash *, const char *);
63 void *shash_find_and_delete_assert(struct shash *, const char *);
64 struct shash_node *shash_first(const struct shash *);
65 const struct shash_node **shash_sort(const struct shash *);
66 bool shash_equal_keys(const struct shash *, const struct shash *);
67 struct shash_node *shash_random_node(struct shash *);
68
69 /* Working with "smaps": shashes used as string-to-string maps. */
70 void smap_destroy(struct shash *);
71 bool smap_equal(const struct shash *, const struct shash *);
72 void smap_clone(struct shash *, const struct shash *);
73 void smap_add(struct shash *, const char *key, const char *value);
74
75 #ifdef  __cplusplus
76 }
77 #endif
78
79 #endif /* shash.h */