Merge pull request #62 from painless-security/jennifer/report_incoming_ipaddr
[trust_router.git] / include / tr_list.h
1 /*
2  * Copyright (c) 2018 JANET(UK)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
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  * 3. Neither the name of JANET(UK) nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31  * OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34
35 #ifndef TRUST_ROUTER_TR_LIST_H
36 #define TRUST_ROUTER_TR_LIST_H
37
38 #include <talloc.h>
39 #include <glib.h>
40
41 typedef GPtrArray *TR_LIST;
42
43 typedef void (TR_LIST_FOREACH_FUNC)(void *item, void *cookie);
44
45 typedef struct tr_list_iter{
46   TR_LIST *list;
47   guint index;
48 } TR_LIST_ITER;
49
50 #define tr_list_index(LIST, INDEX) (g_ptr_array_index(*(LIST),(INDEX)))
51 #define tr_list_length(LIST) ((size_t)((*(LIST))->len))
52
53 TR_LIST *tr_list_new(TALLOC_CTX *mem_ctx);
54 void tr_list_free(TR_LIST *list);
55 void *tr_list_add(TR_LIST *list, void *item, int steal);
56
57 TR_LIST_ITER *tr_list_iter_new(TALLOC_CTX *mem_ctx);
58 void tr_list_iter_free(TR_LIST_ITER *iter);
59 void *tr_list_iter_first(TR_LIST_ITER *iter, TR_LIST *list);
60 void *tr_list_iter_next(TR_LIST_ITER *iter);
61 void tr_list_foreach(TR_LIST *list, TR_LIST_FOREACH_FUNC *func, void *cookie);
62
63 #endif //TRUST_ROUTER_TR_LIST_H