external/bsd/bind/dist/unit/atf-src/atf-c/detail/map.h

   1 /*      $NetBSD: map.h,v 1.3 2014/12/10 04:38:03 christos Exp $ */
   2
   3 /*
   4  * Automated Testing Framework (atf)
   5  *
   6  * Copyright (c) 2008 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  19  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  25  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  27  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  29  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #if !defined(ATF_C_MAP_H)
  33 #define ATF_C_MAP_H
  34
  35 #include <stdarg.h>
  36 #include <stdbool.h>
  37
  38 #include <atf-c/error_fwd.h>
  39
  40 #include "list.h"
  41
  42 /* ---------------------------------------------------------------------
  43  * The "atf_map_citer" type.
  44  * --------------------------------------------------------------------- */
  45
  46 struct atf_map_citer {
  47     const struct atf_map *m_map;
  48     const void *m_entry;
  49     atf_list_citer_t m_listiter;
  50 };
  51 typedef struct atf_map_citer atf_map_citer_t;
  52
  53 /* Getters. */
  54 const char *atf_map_citer_key(const atf_map_citer_t);
  55 const void *atf_map_citer_data(const atf_map_citer_t);
  56 atf_map_citer_t atf_map_citer_next(const atf_map_citer_t);
  57
  58 /* Operators. */
  59 bool atf_equal_map_citer_map_citer(const atf_map_citer_t,
  60                                    const atf_map_citer_t);
  61
  62 /* ---------------------------------------------------------------------
  63  * The "atf_map_iter" type.
  64  * --------------------------------------------------------------------- */
  65
  66 struct atf_map_iter {
  67     struct atf_map *m_map;
  68     void *m_entry;
  69     atf_list_iter_t m_listiter;
  70 };
  71 typedef struct atf_map_iter atf_map_iter_t;
  72
  73 /* Getters. */
  74 const char *atf_map_iter_key(const atf_map_iter_t);
  75 void *atf_map_iter_data(const atf_map_iter_t);
  76 atf_map_iter_t atf_map_iter_next(const atf_map_iter_t);
  77
  78 /* Operators. */
  79 bool atf_equal_map_iter_map_iter(const atf_map_iter_t,
  80                                  const atf_map_iter_t);
  81
  82 /* ---------------------------------------------------------------------
  83  * The "atf_map" type.
  84  * --------------------------------------------------------------------- */
  85
  86 /* A list-based map.  Typically very inefficient, but our maps are small
  87  * enough. */
  88 struct atf_map {
  89     atf_list_t m_list;
  90 };
  91 typedef struct atf_map atf_map_t;
  92
  93 /* Constructors and destructors */
  94 atf_error_t atf_map_init(atf_map_t *);
  95 atf_error_t atf_map_init_charpp(atf_map_t *, const char *const *);
  96 void atf_map_fini(atf_map_t *);
  97
  98 /* Getters. */
  99 atf_map_iter_t atf_map_begin(atf_map_t *);
 100 atf_map_citer_t atf_map_begin_c(const atf_map_t *);
 101 atf_map_iter_t atf_map_end(atf_map_t *);
 102 atf_map_citer_t atf_map_end_c(const atf_map_t *);
 103 atf_map_iter_t atf_map_find(atf_map_t *, const char *);
 104 atf_map_citer_t atf_map_find_c(const atf_map_t *, const char *);
 105 size_t atf_map_size(const atf_map_t *);
 106 char **atf_map_to_charpp(const atf_map_t *);
 107
 108 /* Modifiers. */
 109 atf_error_t atf_map_insert(atf_map_t *, const char *, void *, bool);
 110
 111 /* Macros. */
 112 #define atf_map_for_each(iter, map) \
 113     for (iter = atf_map_begin(map); \
 114          !atf_equal_map_iter_map_iter((iter), atf_map_end(map)); \
 115          iter = atf_map_iter_next(iter))
 116 #define atf_map_for_each_c(iter, map) \
 117     for (iter = atf_map_begin_c(map); \
 118          !atf_equal_map_citer_map_citer((iter), atf_map_end_c(map)); \
 119          iter = atf_map_citer_next(iter))
 120
 121 #endif /* ATF_C_MAP_H */