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

   1 /*
   2  * Automated Testing Framework (atf)
   3  *
   4  * Copyright (c) 2008, 2009 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_LIST_H)
  31 #define ATF_C_LIST_H
  32
  33 #include <stdarg.h>
  34
  35 #include <atf-c/error_fwd.h>
  36 #include <atf-c/object.h>
  37
  38 /* ---------------------------------------------------------------------
  39  * The "atf_list_citer" type.
  40  * --------------------------------------------------------------------- */
  41
  42 struct atf_list_citer {
  43     const struct atf_list *m_list;
  44     const void *m_entry;
  45 };
  46 typedef struct atf_list_citer atf_list_citer_t;
  47
  48 /* Getters. */
  49 const void *atf_list_citer_data(const atf_list_citer_t);
  50 atf_list_citer_t atf_list_citer_next(const atf_list_citer_t);
  51
  52 /* Operators. */
  53 bool atf_equal_list_citer_list_citer(const atf_list_citer_t,
  54                                      const atf_list_citer_t);
  55
  56 /* ---------------------------------------------------------------------
  57  * The "atf_list_iter" type.
  58  * --------------------------------------------------------------------- */
  59
  60 struct atf_list_iter {
  61     struct atf_list *m_list;
  62     void *m_entry;
  63 };
  64 typedef struct atf_list_iter atf_list_iter_t;
  65
  66 /* Getters. */
  67 void *atf_list_iter_data(const atf_list_iter_t);
  68 atf_list_iter_t atf_list_iter_next(const atf_list_iter_t);
  69
  70 /* Operators. */
  71 bool atf_equal_list_iter_list_iter(const atf_list_iter_t,
  72                                    const atf_list_iter_t);
  73
  74 /* ---------------------------------------------------------------------
  75  * The "atf_list" type.
  76  * --------------------------------------------------------------------- */
  77
  78 struct atf_list {
  79     atf_object_t m_object;
  80
  81     void *m_begin;
  82     void *m_end;
  83
  84     size_t m_size;
  85 };
  86 typedef struct atf_list atf_list_t;
  87
  88 /* Constructors and destructors */
  89 atf_error_t atf_list_init(atf_list_t *);
  90 void atf_list_fini(atf_list_t *);
  91
  92 /* Getters. */
  93 atf_list_iter_t atf_list_begin(atf_list_t *);
  94 atf_list_citer_t atf_list_begin_c(const atf_list_t *);
  95 atf_list_iter_t atf_list_end(atf_list_t *);
  96 atf_list_citer_t atf_list_end_c(const atf_list_t *);
  97 void *atf_list_index(atf_list_t *, const size_t);
  98 const void *atf_list_index_c(const atf_list_t *, const size_t);
  99 size_t atf_list_size(const atf_list_t *);
 100
 101 /* Modifiers. */
 102 atf_error_t atf_list_append(atf_list_t *, void *, bool);
 103 void atf_list_append_list(atf_list_t *, atf_list_t *);
 104
 105 /* Macros. */
 106 #define atf_list_for_each(iter, list) \
 107     for (iter = atf_list_begin(list); \
 108          !atf_equal_list_iter_list_iter((iter), atf_list_end(list)); \
 109          iter = atf_list_iter_next(iter))
 110 #define atf_list_for_each_c(iter, list) \
 111     for (iter = atf_list_begin_c(list); \
 112          !atf_equal_list_citer_list_citer((iter), atf_list_end_c(list)); \
 113          iter = atf_list_citer_next(iter))
 114
 115 #endif /* ATF_C_LIST_H */