2 * Automated Testing Framework (atf)
4 * Copyright (c) 2008 The NetBSD Foundation, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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.
30 #if !defined(ATF_C_MAP_H)
36 #include <atf-c/error_fwd.h>
40 /* ---------------------------------------------------------------------
41 * The "atf_map_citer" type.
42 * --------------------------------------------------------------------- */
44 struct atf_map_citer
{
45 const struct atf_map
*m_map
;
47 atf_list_citer_t m_listiter
;
49 typedef struct atf_map_citer atf_map_citer_t
;
52 const char *atf_map_citer_key(const atf_map_citer_t
);
53 const void *atf_map_citer_data(const atf_map_citer_t
);
54 atf_map_citer_t
atf_map_citer_next(const atf_map_citer_t
);
57 bool atf_equal_map_citer_map_citer(const atf_map_citer_t
,
58 const atf_map_citer_t
);
60 /* ---------------------------------------------------------------------
61 * The "atf_map_iter" type.
62 * --------------------------------------------------------------------- */
65 struct atf_map
*m_map
;
67 atf_list_iter_t m_listiter
;
69 typedef struct atf_map_iter atf_map_iter_t
;
72 const char *atf_map_iter_key(const atf_map_iter_t
);
73 void *atf_map_iter_data(const atf_map_iter_t
);
74 atf_map_iter_t
atf_map_iter_next(const atf_map_iter_t
);
77 bool atf_equal_map_iter_map_iter(const atf_map_iter_t
,
78 const atf_map_iter_t
);
80 /* ---------------------------------------------------------------------
82 * --------------------------------------------------------------------- */
84 /* A list-based map. Typically very inefficient, but our maps are small
89 typedef struct atf_map atf_map_t
;
91 /* Constructors and destructors */
92 atf_error_t
atf_map_init(atf_map_t
*);
93 atf_error_t
atf_map_init_charpp(atf_map_t
*, const char *const *);
94 void atf_map_fini(atf_map_t
*);
97 atf_map_iter_t
atf_map_begin(atf_map_t
*);
98 atf_map_citer_t
atf_map_begin_c(const atf_map_t
*);
99 atf_map_iter_t
atf_map_end(atf_map_t
*);
100 atf_map_citer_t
atf_map_end_c(const atf_map_t
*);
101 atf_map_iter_t
atf_map_find(atf_map_t
*, const char *);
102 atf_map_citer_t
atf_map_find_c(const atf_map_t
*, const char *);
103 size_t atf_map_size(const atf_map_t
*);
104 char **atf_map_to_charpp(const atf_map_t
*);
107 atf_error_t
atf_map_insert(atf_map_t
*, const char *, void *, bool);
110 #define atf_map_for_each(iter, map) \
111 for (iter = atf_map_begin(map); \
112 !atf_equal_map_iter_map_iter((iter), atf_map_end(map)); \
113 iter = atf_map_iter_next(iter))
114 #define atf_map_for_each_c(iter, map) \
115 for (iter = atf_map_begin_c(map); \
116 !atf_equal_map_citer_map_citer((iter), atf_map_end_c(map)); \
117 iter = atf_map_citer_next(iter))
119 #endif /* ATF_C_MAP_H */