Tue, 05 Oct 2021 11:19:32 +0200
remove convenience macros
Users should write their own wrappers s.t. the type
information does not have to be repeated on every
call site.
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions 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 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28 /**
29 * \file list.h
30 * \brief Interface for list implementations.
31 * \author Mike Becker
32 * \author Olaf Wintermann
33 * \version 3.0
34 * \copyright 2-Clause BSD License
35 */
37 #ifndef UCX_LIST_H
38 #define UCX_LIST_H
40 #include <stdlib.h>
41 #include "allocator.h"
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
47 typedef int(*CxListComparator)(void const *left, void const *right);
49 typedef struct cx_list_s cx_list_s;
51 typedef struct {
52 int (*add)(cx_list_s *list, void *elem);
54 int (*insert)(cx_list_s *list, size_t index, void *elem);
56 int (*remove)(cx_list_s *list, size_t index);
58 void *(*at)(cx_list_s *list, size_t index);
60 size_t (*find)(cx_list_s *list, void *elem);
62 void *(*last)(cx_list_s *list);
63 } cx_list_class;
65 struct cx_list_s {
66 cx_list_class *cl;
67 CxAllocator allocator;
68 CxListComparator cmpfunc;
69 size_t itemsize;
70 size_t size;
71 size_t capacity;
72 };
74 typedef cx_list_s *CxList;
76 int cxListAdd(CxList list, void *elem);
78 int cxListInsert(CxList list, size_t index, void *elem);
80 int cxListRemove(CxList list, size_t index);
82 void *cxListAt(CxList list, size_t index);
84 size_t cxListFind(CxList list, void *elem);
86 void *cxListLast(CxList list);
88 #ifdef __cplusplus
89 } /* extern "C" */
90 #endif
92 #endif /* UCX_LIST_H */