mirror of
https://github.com/openvswitch/ovs
synced 2025-10-15 14:17:18 +00:00
f391294fde
Many uses of "shash" or "svec" data structures really call for a "set of strings" data type. This commit introduces such a data structure. Later commits convert inappropriate uses of shash and svec to use sset instead.
89 lines
2.9 KiB
C
89 lines
2.9 KiB
C
/*
|
||
* Copyright (c) 2011 Nicira Networks.
|
||
*
|
||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
* you may not use this file except in compliance with the License.
|
||
* You may obtain a copy of the License at:
|
||
*
|
||
* http://www.apache.org/licenses/LICENSE-2.0
|
||
*
|
||
* Unless required by applicable law or agreed to in writing, software
|
||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
* See the License for the specific language governing permissions and
|
||
* limitations under the License.
|
||
*/
|
||
|
||
#ifndef SSET_H
|
||
#define SSET_H
|
||
|
||
#include "hmap.h"
|
||
|
||
struct sset_node {
|
||
struct hmap_node hmap_node;
|
||
char name[1];
|
||
};
|
||
|
||
/* A set of strings. */
|
||
struct sset {
|
||
struct hmap map;
|
||
};
|
||
|
||
#define SSET_INITIALIZER(SSET) { HMAP_INITIALIZER(&(SSET)->map) }
|
||
|
||
/* Basics. */
|
||
void sset_init(struct sset *);
|
||
void sset_destroy(struct sset *);
|
||
void sset_clone(struct sset *, const struct sset *);
|
||
void sset_swap(struct sset *, struct sset *);
|
||
void sset_moved(struct sset *);
|
||
|
||
/* Count. */
|
||
bool sset_is_empty(const struct sset *);
|
||
size_t sset_count(const struct sset *);
|
||
|
||
/* Insertion. */
|
||
struct sset_node *sset_add(struct sset *, const char *);
|
||
struct sset_node *sset_add_and_free(struct sset *, char *);
|
||
void sset_add_assert(struct sset *, const char *);
|
||
void sset_add_array(struct sset *, char **, size_t n);
|
||
|
||
/* Deletion. */
|
||
void sset_clear(struct sset *);
|
||
void sset_delete(struct sset *, struct sset_node *);
|
||
bool sset_find_and_delete(struct sset *, const char *);
|
||
void sset_find_and_delete_assert(struct sset *, const char *);
|
||
char *sset_pop(struct sset *);
|
||
|
||
/* Search. */
|
||
struct sset_node *sset_find(const struct sset *, const char *);
|
||
bool sset_contains(const struct sset *, const char *);
|
||
bool sset_equals(const struct sset *, const struct sset *);
|
||
|
||
/* Iteration macros. */
|
||
#define SSET_FOR_EACH(NAME, SSET) \
|
||
for ((NAME) = SSET_FIRST(SSET); \
|
||
SSET_NODE_FROM_NAME(NAME) != NULL; \
|
||
(NAME) = SSET_NEXT(SSET, NAME))
|
||
|
||
#define SSET_FOR_EACH_SAFE(NAME, NEXT, SSET) \
|
||
for ((NAME) = SSET_FIRST(SSET); \
|
||
(SSET_NODE_FROM_NAME(NAME) != NULL \
|
||
? (NEXT) = SSET_NEXT(SSET, NAME), true \
|
||
: false); \
|
||
(NAME) = (NEXT))
|
||
|
||
/* Implementation helper macros. */
|
||
|
||
#define SSET_NODE_FROM_HMAP_NODE(HMAP_NODE) \
|
||
CONTAINER_OF(HMAP_NODE, struct sset_node, hmap_node)
|
||
#define SSET_NAME_FROM_HMAP_NODE(HMAP_NODE) \
|
||
((const char *) (SSET_NODE_FROM_HMAP_NODE(HMAP_NODE)->name))
|
||
#define SSET_NODE_FROM_NAME(NAME) CONTAINER_OF(NAME, struct sset_node, name)
|
||
#define SSET_FIRST(SSET) SSET_NAME_FROM_HMAP_NODE(hmap_first(&(SSET)->map))
|
||
#define SSET_NEXT(SSET, NAME) \
|
||
SSET_NAME_FROM_HMAP_NODE( \
|
||
hmap_next(&(SSET)->map, &SSET_NODE_FROM_NAME(NAME)->hmap_node))
|
||
|
||
#endif /* sset.h */
|