1 /* Copyright (c) 2012, 2014, 2015 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License. */
23 /* A map from string to string. */
25 struct hmap map; /* Contains "struct smap_node"s. */
29 struct hmap_node node; /* In struct smap's 'map' hmap. */
34 #define SMAP_INITIALIZER(SMAP) { HMAP_INITIALIZER(&(SMAP)->map) }
36 #define SMAP_FOR_EACH(SMAP_NODE, SMAP) \
37 HMAP_FOR_EACH (SMAP_NODE, node, &(SMAP)->map)
39 #define SMAP_FOR_EACH_SAFE(SMAP_NODE, NEXT, SMAP) \
40 HMAP_FOR_EACH_SAFE (SMAP_NODE, NEXT, node, &(SMAP)->map)
42 void smap_init(struct smap *);
43 void smap_destroy(struct smap *);
45 struct smap_node *smap_add(struct smap *, const char *, const char *);
46 struct smap_node *smap_add_nocopy(struct smap *, char *, char *);
47 bool smap_add_once(struct smap *, const char *, const char *);
48 void smap_add_format(struct smap *, const char *key, const char *, ...)
49 OVS_PRINTF_FORMAT(3, 4);
50 void smap_replace(struct smap *, const char *, const char *);
52 void smap_remove(struct smap *, const char *);
53 void smap_remove_node(struct smap *, struct smap_node *);
54 void smap_steal(struct smap *, struct smap_node *, char **keyp, char **valuep);
55 void smap_clear(struct smap *);
57 const char *smap_get(const struct smap *, const char *);
58 struct smap_node *smap_get_node(const struct smap *, const char *);
59 bool smap_get_bool(const struct smap *smap, const char *key, bool def);
60 int smap_get_int(const struct smap *smap, const char *key, int def);
61 bool smap_get_uuid(const struct smap *, const char *key, struct uuid *);
63 bool smap_is_empty(const struct smap *);
64 size_t smap_count(const struct smap *);
66 void smap_clone(struct smap *dst, const struct smap *src);
67 const struct smap_node **smap_sort(const struct smap *);
69 void smap_from_json(struct smap *, const struct json *);
70 struct json *smap_to_json(const struct smap *);
72 bool smap_equal(const struct smap *, const struct smap *);