Home | History | Annotate | Line # | Download | only in detail 
      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 
     38 #include "list.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     atf_list_citer_t m_listiter;
     48 };
     49 typedef struct atf_map_citer atf_map_citer_t;
     50 
     51 /* Getters. */
     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);
     55 
     56 /* Operators. */
     57 bool atf_equal_map_citer_map_citer(const atf_map_citer_t,
     58                                    const atf_map_citer_t);
     59 
     60 /* ---------------------------------------------------------------------
     61  * The "atf_map_iter" type.
     62  * --------------------------------------------------------------------- */
     63 
     64 struct atf_map_iter {
     65     struct atf_map *m_map;
     66     void *m_entry;
     67     atf_list_iter_t m_listiter;
     68 };
     69 typedef struct atf_map_iter atf_map_iter_t;
     70 
     71 /* Getters. */
     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);
     75 
     76 /* Operators. */
     77 bool atf_equal_map_iter_map_iter(const atf_map_iter_t,
     78                                  const atf_map_iter_t);
     79 
     80 /* ---------------------------------------------------------------------
     81  * The "atf_map" type.
     82  * --------------------------------------------------------------------- */
     83 
     84 /* A list-based map.  Typically very inefficient, but our maps are small
     85  * enough. */
     86 struct atf_map {
     87     atf_list_t m_list;
     88 };
     89 typedef struct atf_map atf_map_t;
     90 
     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 *);
     95 
     96 /* Getters. */
     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 *);
    105 
    106 /* Modifiers. */
    107 atf_error_t atf_map_insert(atf_map_t *, const char *, void *, bool);
    108 
    109 /* Macros. */
    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))
    118 
    119 #endif /* ATF_C_MAP_H */
    120