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 #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, struct shash_node, node, &(SHASH)->map)
  40
  41 #define SHASH_FOR_EACH_SAFE(SHASH_NODE, NEXT, SHASH)                \
  42     HMAP_FOR_EACH_SAFE (SHASH_NODE, NEXT, struct shash_node, node,  \
  43                         &(SHASH)->map)
  44
  45 void shash_init(struct shash *);
  46 void shash_destroy(struct shash *);
  47 void shash_clear(struct shash *);
  48 bool shash_is_empty(const struct shash *);
  49 struct shash_node *shash_add(struct shash *, const char *, void *);
  50 void shash_delete(struct shash *, struct shash_node *);
  51 struct shash_node *shash_find(const struct shash *, const char *);
  52 void *shash_find_data(const struct shash *, const char *);
  53 struct shash_node *shash_first(const struct shash *);
  54
  55 #ifdef  __cplusplus
  56 }
  57 #endif
  58
  59 #endif /* shash.h */