external/bsd/atf/dist/atf-c/map.h

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