classifier: Add helpers for setting ethernet addresses
[openvswitch] / lib / sset.h
1 /*
2  * Copyright (c) 2011 Nicira, Inc.
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 SSET_H
18 #define SSET_H
19
20 #include "hmap.h"
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 struct sset_node {
27     struct hmap_node hmap_node;
28     char name[1];
29 };
30
31 /* A set of strings. */
32 struct sset {
33     struct hmap map;
34 };
35
36 #define SSET_INITIALIZER(SSET) { HMAP_INITIALIZER(&(SSET)->map) }
37
38 /* Basics. */
39 void sset_init(struct sset *);
40 void sset_destroy(struct sset *);
41 void sset_clone(struct sset *, const struct sset *);
42 void sset_swap(struct sset *, struct sset *);
43 void sset_moved(struct sset *);
44
45 /* Count. */
46 bool sset_is_empty(const struct sset *);
47 size_t sset_count(const struct sset *);
48
49 /* Insertion. */
50 struct sset_node *sset_add(struct sset *, const char *);
51 struct sset_node *sset_add_and_free(struct sset *, char *);
52 void sset_add_assert(struct sset *, const char *);
53 void sset_add_array(struct sset *, char **, size_t n);
54
55 /* Deletion. */
56 void sset_clear(struct sset *);
57 void sset_delete(struct sset *, struct sset_node *);
58 bool sset_find_and_delete(struct sset *, const char *);
59 void sset_find_and_delete_assert(struct sset *, const char *);
60 char *sset_pop(struct sset *);
61
62 /* Search. */
63 struct sset_node *sset_find(const struct sset *, const char *);
64 bool sset_contains(const struct sset *, const char *);
65 bool sset_equals(const struct sset *, const struct sset *);
66
67 /* Iteration macros. */
68 #define SSET_FOR_EACH(NAME, SSET)               \
69     for ((NAME) = SSET_FIRST(SSET);             \
70          SSET_NODE_FROM_NAME(NAME) != NULL;     \
71          (NAME) = SSET_NEXT(SSET, NAME))
72
73 #define SSET_FOR_EACH_SAFE(NAME, NEXT, SSET)        \
74     for ((NAME) = SSET_FIRST(SSET);                 \
75          (SSET_NODE_FROM_NAME(NAME) != NULL         \
76           ? (NEXT) = SSET_NEXT(SSET, NAME), true    \
77           : false);                                 \
78          (NAME) = (NEXT))
79 \f
80 /* Implementation helper macros. */
81
82 #define SSET_NODE_FROM_HMAP_NODE(HMAP_NODE) \
83     CONTAINER_OF(HMAP_NODE, struct sset_node, hmap_node)
84 #define SSET_NAME_FROM_HMAP_NODE(HMAP_NODE) \
85     ((const char *) (SSET_NODE_FROM_HMAP_NODE(HMAP_NODE)->name))
86 #define SSET_NODE_FROM_NAME(NAME) CONTAINER_OF(NAME, struct sset_node, name)
87 #define SSET_FIRST(SSET) SSET_NAME_FROM_HMAP_NODE(hmap_first(&(SSET)->map))
88 #define SSET_NEXT(SSET, NAME)                                           \
89     SSET_NAME_FROM_HMAP_NODE(                                           \
90         hmap_next(&(SSET)->map, &SSET_NODE_FROM_NAME(NAME)->hmap_node))
91
92 #ifdef __cplusplus
93 }
94 #endif
95
96 #endif /* sset.h */