Sat, 28 Sep 2024 15:55:14 +0200
make all function attributes leading - fixes #425
390 | 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 | */ | |
453
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
28 | /** |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
29 | * \file list.h |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
30 | * \brief Interface for list implementations. |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
31 | * \author Mike Becker |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
32 | * \author Olaf Wintermann |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
33 | * \copyright 2-Clause BSD License |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
34 | */ |
390 | 35 | |
36 | #ifndef UCX_LIST_H | |
37 | #define UCX_LIST_H | |
38 | ||
681
502105523db7
fix common.h include problems - fixes #255
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
39 | #include "common.h" |
677
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
40 | #include "collection.h" |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
41 | |
415 | 42 | #ifdef __cplusplus |
43 | extern "C" { | |
44 | #endif | |
45 | ||
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
46 | /** |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
47 | * List class type. |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
48 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
49 | typedef struct cx_list_class_s cx_list_class; |
435
0fe204d50f54
change inheritance model for lists
Mike Becker <universe@uap-core.de>
parents:
415
diff
changeset
|
50 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
51 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
52 | * Structure for holding the base data of a list. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
53 | */ |
435
0fe204d50f54
change inheritance model for lists
Mike Becker <universe@uap-core.de>
parents:
415
diff
changeset
|
54 | struct cx_list_s { |
854
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
55 | CX_COLLECTION_BASE; |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
56 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
57 | * The list class definition. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
58 | */ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
59 | const cx_list_class *cl; |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
60 | /** |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
61 | * The actual implementation in case the list class is delegating. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
62 | */ |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
63 | const cx_list_class *climpl; |
435
0fe204d50f54
change inheritance model for lists
Mike Becker <universe@uap-core.de>
parents:
415
diff
changeset
|
64 | }; |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
65 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
66 | /** |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
67 | * The class definition for arbitrary lists. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
68 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
69 | struct cx_list_class_s { |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
70 | /** |
524 | 71 | * Destructor function. |
708
1caed6c9ba68
fix inconsistent destructor requirements for list and map classes
Mike Becker <universe@uap-core.de>
parents:
704
diff
changeset
|
72 | * |
1caed6c9ba68
fix inconsistent destructor requirements for list and map classes
Mike Becker <universe@uap-core.de>
parents:
704
diff
changeset
|
73 | * Implementations SHALL invoke the content destructor functions if provided |
1caed6c9ba68
fix inconsistent destructor requirements for list and map classes
Mike Becker <universe@uap-core.de>
parents:
704
diff
changeset
|
74 | * and SHALL deallocate the list memory, if an allocator is provided. |
524 | 75 | */ |
76 | void (*destructor)(struct cx_list_s *list); | |
77 | ||
78 | /** | |
739
529c35a768f3
fix typo in list.h
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
708
diff
changeset
|
79 | * Member function for inserting a single element. |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
80 | * Implementors SHOULD see to performant implementations for corner cases. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
81 | */ |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
82 | int (*insert_element)( |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
83 | struct cx_list_s *list, |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
84 | size_t index, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
85 | const void *data |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
86 | ); |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
87 | |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
88 | /** |
638
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
89 | * Member function for inserting multiple elements. |
640
55cc3b373c5e
simplify list class - fixes #236
Mike Becker <universe@uap-core.de>
parents:
638
diff
changeset
|
90 | * Implementors SHOULD see to performant implementations for corner cases. |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
91 | * @see cx_list_default_insert_array() |
638
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
92 | */ |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
93 | size_t (*insert_array)( |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
94 | struct cx_list_s *list, |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
95 | size_t index, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
96 | const void *data, |
638
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
97 | size_t n |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
98 | ); |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
99 | |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
100 | /** |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
101 | * Member function for inserting sorted elements into a sorted list. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
102 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
103 | * @see cx_list_default_insert_sorted() |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
104 | */ |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
105 | size_t (*insert_sorted)( |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
106 | struct cx_list_s *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
107 | const void *sorted_data, |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
108 | size_t n |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
109 | ); |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
110 | |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
111 | /** |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
112 | * Member function for inserting an element relative to an iterator position. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
113 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
114 | int (*insert_iter)( |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
115 | struct cx_iterator_s *iter, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
116 | const void *elem, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
117 | int prepend |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
118 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
119 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
120 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
121 | * Member function for removing an element. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
122 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
123 | int (*remove)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
124 | struct cx_list_s *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
125 | size_t index |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
126 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
127 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
128 | /** |
664
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
129 | * Member function for removing all elements. |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
130 | */ |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
131 | void (*clear)(struct cx_list_s *list); |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
132 | |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
133 | /** |
647
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
134 | * Member function for swapping two elements. |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
135 | * @see cx_list_default_swap() |
647
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
136 | */ |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
137 | int (*swap)( |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
138 | struct cx_list_s *list, |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
139 | size_t i, |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
140 | size_t j |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
141 | ); |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
142 | |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
143 | /** |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
144 | * Member function for element lookup. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
145 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
146 | void *(*at)( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
147 | const struct cx_list_s *list, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
148 | size_t index |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
149 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
150 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
151 | /** |
764
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
152 | * Member function for finding and optionally removing an element. |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
153 | */ |
764
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
154 | ssize_t (*find_remove)( |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
155 | struct cx_list_s *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
156 | const void *elem, |
764
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
157 | bool remove |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
158 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
159 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
160 | /** |
741 | 161 | * Member function for sorting the list in-place. |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
162 | * @see cx_list_default_sort() |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
163 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
164 | void (*sort)(struct cx_list_s *list); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
165 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
166 | /** |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
167 | * Optional member function for comparing this list |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
168 | * to another list of the same type. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
169 | * If set to \c NULL, comparison won't be optimized. |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
170 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
171 | int (*compare)( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
172 | const struct cx_list_s *list, |
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
173 | const struct cx_list_s *other |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
174 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
175 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
176 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
177 | * Member function for reversing the order of the items. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
178 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
179 | void (*reverse)(struct cx_list_s *list); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
180 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
181 | /** |
640
55cc3b373c5e
simplify list class - fixes #236
Mike Becker <universe@uap-core.de>
parents:
638
diff
changeset
|
182 | * Member function for returning an iterator pointing to the specified index. |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
183 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
184 | struct cx_iterator_s (*iterator)( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
185 | const struct cx_list_s *list, |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
186 | size_t index, |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
187 | bool backward |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
188 | ); |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
189 | }; |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
190 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
191 | /** |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
192 | * Default implementation of an array insert. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
193 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
194 | * This function uses the element insert function for each element of the array. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
195 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
196 | * Use this in your own list class if you do not want to implement an optimized |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
197 | * version for your list. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
198 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
199 | * @param list the list |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
200 | * @param index the index where to insert the data |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
201 | * @param data a pointer to the array of data to insert |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
202 | * @param n the number of elements to insert |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
203 | * @return the number of elements actually inserted |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
204 | */ |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
205 | __attribute__((__nonnull__)) |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
206 | size_t cx_list_default_insert_array( |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
207 | struct cx_list_s *list, |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
208 | size_t index, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
209 | const void *data, |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
210 | size_t n |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
211 | ); |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
212 | |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
213 | /** |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
214 | * Default implementation of a sorted insert. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
215 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
216 | * This function uses the array insert function to insert consecutive groups |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
217 | * of sorted data. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
218 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
219 | * The source data \em must already be sorted wrt. the list's compare function. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
220 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
221 | * Use this in your own list class if you do not want to implement an optimized |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
222 | * version for your list. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
223 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
224 | * @param list the list |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
225 | * @param sorted_data a pointer to the array of pre-sorted data to insert |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
226 | * @param n the number of elements to insert |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
227 | * @return the number of elements actually inserted |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
228 | */ |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
229 | __attribute__((__nonnull__)) |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
230 | size_t cx_list_default_insert_sorted( |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
231 | struct cx_list_s *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
232 | const void *sorted_data, |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
233 | size_t n |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
234 | ); |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
235 | |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
236 | /** |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
237 | * Default unoptimized sort implementation. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
238 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
239 | * This function will copy all data to an array, sort the array with standard |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
240 | * qsort, and then copy the data back to the list memory. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
241 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
242 | * Use this in your own list class if you do not want to implement an optimized |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
243 | * version for your list. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
244 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
245 | * @param list the list that shall be sorted |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
246 | */ |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
247 | __attribute__((__nonnull__)) |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
248 | void cx_list_default_sort(struct cx_list_s *list); |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
249 | |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
250 | /** |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
251 | * Default unoptimized swap implementation. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
252 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
253 | * Use this in your own list class if you do not want to implement an optimized |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
254 | * version for your list. |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
255 | * |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
256 | * @param list the list in which to swap |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
257 | * @param i index of one element |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
258 | * @param j index of the other element |
882
f8ca6e6c0d48
add missing documentation for cx_list_default_swap() return value
Mike Becker <universe@uap-core.de>
parents:
876
diff
changeset
|
259 | * @return zero on success, non-zero when indices are out of bounds or memory |
f8ca6e6c0d48
add missing documentation for cx_list_default_swap() return value
Mike Becker <universe@uap-core.de>
parents:
876
diff
changeset
|
260 | * allocation for the temporary buffer fails |
875
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
261 | */ |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
262 | __attribute__((__nonnull__)) |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
263 | int cx_list_default_swap(struct cx_list_s *list, size_t i, size_t j); |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
264 | |
ee84ac776cbc
add default impl for some list member functions
Mike Becker <universe@uap-core.de>
parents:
856
diff
changeset
|
265 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
266 | * Common type for all list implementations. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
267 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
268 | typedef struct cx_list_s CxList; |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
269 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
270 | /** |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
271 | * Advises the list to store copies of the objects (default mode of operation). |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
272 | * |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
273 | * Retrieving objects from this list will yield pointers to the copies stored |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
274 | * within this list. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
275 | * |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
276 | * @param list the list |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
277 | * @see cxListStorePointers() |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
278 | */ |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
279 | __attribute__((__nonnull__)) |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
280 | void cxListStoreObjects(CxList *list); |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
281 | |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
282 | /** |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
283 | * Advises the list to only store pointers to the objects. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
284 | * |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
285 | * Retrieving objects from this list will yield the original pointers stored. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
286 | * |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
287 | * @note This function forcibly sets the element size to the size of a pointer. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
288 | * Invoking this function on a non-empty list that already stores copies of |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
289 | * objects is undefined. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
290 | * |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
291 | * @param list the list |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
292 | * @see cxListStoreObjects() |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
293 | */ |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
294 | __attribute__((__nonnull__)) |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
295 | void cxListStorePointers(CxList *list); |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
296 | |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
297 | /** |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
298 | * Returns true, if this list is storing pointers instead of the actual data. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
299 | * |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
300 | * @param list |
677
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
301 | * @return true, if this list is storing pointers |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
302 | * @see cxListStorePointers() |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
303 | */ |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
304 | __attribute__((__nonnull__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
305 | static inline bool cxListIsStoringPointers(const CxList *list) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
306 | return list->collection.store_pointer; |
677
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
307 | } |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
308 | |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
309 | /** |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
310 | * Returns the number of elements currently stored in the list. |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
311 | * |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
312 | * @param list the list |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
313 | * @return the number of currently stored elements |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
314 | */ |
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
315 | __attribute__((__nonnull__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
316 | static inline size_t cxListSize(const CxList *list) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
317 | return list->collection.size; |
677
b09aae58bba4
refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents:
669
diff
changeset
|
318 | } |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
319 | |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
320 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
321 | * Adds an item to the end of the list. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
322 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
323 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
324 | * @param elem a pointer to the element to add |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
325 | * @return zero on success, non-zero on memory allocation failure |
629
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
326 | * @see cxListAddArray() |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
327 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
328 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
329 | static inline int cxListAdd( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
330 | CxList *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
331 | const void *elem |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
332 | ) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
333 | return list->cl->insert_element(list, list->collection.size, elem); |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
334 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
335 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
336 | /** |
629
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
337 | * Adds multiple items to the end of the list. |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
338 | * |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
339 | * This method is more efficient than invoking cxListAdd() multiple times. |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
340 | * |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
341 | * If there is not enough memory to add all elements, the returned value is |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
342 | * less than \p n. |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
343 | * |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
344 | * If this list is storing pointers instead of objects \p array is expected to |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
345 | * be an array of pointers. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
346 | * |
629
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
347 | * @param list the list |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
348 | * @param array a pointer to the elements to add |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
349 | * @param n the number of elements to add |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
350 | * @return the number of added elements |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
351 | */ |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
352 | __attribute__((__nonnull__)) |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
353 | static inline size_t cxListAddArray( |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
354 | CxList *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
355 | const void *array, |
629
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
356 | size_t n |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
357 | ) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
358 | return list->cl->insert_array(list, list->collection.size, array, n); |
629
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
359 | } |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
360 | |
6c81ee4f11ad
#224 add cxListAddArray()
Mike Becker <universe@uap-core.de>
parents:
628
diff
changeset
|
361 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
362 | * Inserts an item at the specified index. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
363 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
364 | * If \p index equals the list \c size, this is effectively cxListAdd(). |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
365 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
366 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
367 | * @param index the index the element shall have |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
368 | * @param elem a pointer to the element to add |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
369 | * @return zero on success, non-zero on memory allocation failure |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
370 | * or when the index is out of bounds |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
371 | * @see cxListInsertAfter() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
372 | * @see cxListInsertBefore() |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
373 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
374 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
375 | static inline int cxListInsert( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
376 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
377 | size_t index, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
378 | const void *elem |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
379 | ) { |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
380 | return list->cl->insert_element(list, index, elem); |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
381 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
382 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
383 | /** |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
384 | * Inserts an item into a sorted list. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
385 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
386 | * @param list the list |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
387 | * @param elem a pointer to the element to add |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
388 | * @return zero on success, non-zero on memory allocation failure |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
389 | */ |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
390 | __attribute__((__nonnull__)) |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
391 | static inline int cxListInsertSorted( |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
392 | CxList *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
393 | const void *elem |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
394 | ) { |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
395 | const void *data = list->collection.store_pointer ? &elem : elem; |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
396 | return list->cl->insert_sorted(list, data, 1) == 0; |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
397 | } |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
398 | |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
399 | /** |
638
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
400 | * Inserts multiple items to the list at the specified index. |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
401 | * If \p index equals the list size, this is effectively cxListAddArray(). |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
402 | * |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
403 | * This method is usually more efficient than invoking cxListInsert() |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
404 | * multiple times. |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
405 | * |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
406 | * If there is not enough memory to add all elements, the returned value is |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
407 | * less than \p n. |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
408 | * |
641
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
409 | * If this list is storing pointers instead of objects \p array is expected to |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
410 | * be an array of pointers. |
d402fead3386
add new pointer list wrapper - resolves #234
Mike Becker <universe@uap-core.de>
parents:
640
diff
changeset
|
411 | * |
638
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
412 | * @param list the list |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
413 | * @param index the index where to add the elements |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
414 | * @param array a pointer to the elements to add |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
415 | * @param n the number of elements to add |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
416 | * @return the number of added elements |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
417 | */ |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
418 | __attribute__((__nonnull__)) |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
419 | static inline size_t cxListInsertArray( |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
420 | CxList *list, |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
421 | size_t index, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
422 | const void *array, |
638
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
423 | size_t n |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
424 | ) { |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
425 | return list->cl->insert_array(list, index, array, n); |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
426 | } |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
427 | |
eafb45eefc51
add cxListInsertArray() - fixes #224
Mike Becker <universe@uap-core.de>
parents:
630
diff
changeset
|
428 | /** |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
429 | * Inserts a sorted array into a sorted list. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
430 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
431 | * This method is usually more efficient than inserting each element separately, |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
432 | * because consecutive chunks of sorted data are inserted in one pass. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
433 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
434 | * If there is not enough memory to add all elements, the returned value is |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
435 | * less than \p n. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
436 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
437 | * If this list is storing pointers instead of objects \p array is expected to |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
438 | * be an array of pointers. |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
439 | * |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
440 | * @param list the list |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
441 | * @param array a pointer to the elements to add |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
442 | * @param n the number of elements to add |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
443 | * @return the number of added elements |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
444 | */ |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
445 | __attribute__((__nonnull__)) |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
446 | static inline size_t cxListInsertSortedArray( |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
447 | CxList *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
448 | const void *array, |
876
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
449 | size_t n |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
450 | ) { |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
451 | return list->cl->insert_sorted(list, array, n); |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
452 | } |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
453 | |
f4ce7df9cff0
add stupid default implementation for high level insertion sort
Mike Becker <universe@uap-core.de>
parents:
875
diff
changeset
|
454 | /** |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
455 | * Inserts an element after the current location of the specified iterator. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
456 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
457 | * The used iterator remains operational, but all other active iterators should |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
458 | * be considered invalidated. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
459 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
460 | * If \p iter is not a list iterator, the behavior is undefined. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
461 | * If \p iter is a past-the-end iterator, the new element gets appended to the list. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
462 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
463 | * @param iter an iterator |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
464 | * @param elem the element to insert |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
465 | * @return zero on success, non-zero on memory allocation failure |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
466 | * @see cxListInsert() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
467 | * @see cxListInsertBefore() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
468 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
469 | __attribute__((__nonnull__)) |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
470 | static inline int cxListInsertAfter( |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
471 | CxIterator *iter, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
472 | const void *elem |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
473 | ) { |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
474 | return ((struct cx_list_s *) iter->src_handle.m)->cl->insert_iter(iter, elem, 0); |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
475 | } |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
476 | |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
477 | /** |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
478 | * Inserts an element before the current location of the specified iterator. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
479 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
480 | * The used iterator remains operational, but all other active iterators should |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
481 | * be considered invalidated. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
482 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
483 | * If \p iter is not a list iterator, the behavior is undefined. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
484 | * If \p iter is a past-the-end iterator, the new element gets appended to the list. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
485 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
486 | * @param iter an iterator |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
487 | * @param elem the element to insert |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
488 | * @return zero on success, non-zero on memory allocation failure |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
489 | * @see cxListInsert() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
490 | * @see cxListInsertAfter() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
491 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
492 | __attribute__((__nonnull__)) |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
493 | static inline int cxListInsertBefore( |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
494 | CxIterator *iter, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
495 | const void *elem |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
496 | ) { |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
497 | return ((struct cx_list_s *) iter->src_handle.m)->cl->insert_iter(iter, elem, 1); |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
498 | } |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
499 | |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
500 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
501 | * Removes the element at the specified index. |
664
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
502 | * |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
503 | * If an element destructor function is specified, it is called before |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
504 | * removing the element. |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
505 | * |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
506 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
507 | * @param index the index of the element |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
508 | * @return zero on success, non-zero if the index is out of bounds |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
509 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
510 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
511 | static inline int cxListRemove( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
512 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
513 | size_t index |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
514 | ) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
515 | return list->cl->remove(list, index); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
516 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
517 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
518 | /** |
664
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
519 | * Removes all elements from this list. |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
520 | * |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
521 | * If an element destructor function is specified, it is called for each |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
522 | * element before removing them. |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
523 | * |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
524 | * @param list the list |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
525 | */ |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
526 | __attribute__((__nonnull__)) |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
527 | static inline void cxListClear(CxList *list) { |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
528 | list->cl->clear(list); |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
529 | } |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
530 | |
af5bf4603a5d
add cxListClear and fix missing destructor invocations - #241 #246
Mike Becker <universe@uap-core.de>
parents:
655
diff
changeset
|
531 | /** |
647
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
532 | * Swaps two items in the list. |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
533 | * |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
534 | * Implementations should only allocate temporary memory for the swap, if |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
535 | * it is necessary. |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
536 | * |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
537 | * @param list the list |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
538 | * @param i the index of the first element |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
539 | * @param j the index of the second element |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
540 | * @return zero on success, non-zero if one of the indices is out of bounds |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
541 | */ |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
542 | __attribute__((__nonnull__)) |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
543 | static inline int cxListSwap( |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
544 | CxList *list, |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
545 | size_t i, |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
546 | size_t j |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
547 | ) { |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
548 | return list->cl->swap(list, i, j); |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
549 | } |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
550 | |
2e6e9d9f2159
implement swap function for list elements - fixes #218
Mike Becker <universe@uap-core.de>
parents:
641
diff
changeset
|
551 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
552 | * Returns a pointer to the element at the specified index. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
553 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
554 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
555 | * @param index the index of the element |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
556 | * @return a pointer to the element or \c NULL if the index is out of bounds |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
557 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
558 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
559 | static inline void *cxListAt( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
560 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
561 | size_t index |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
562 | ) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
563 | return list->cl->at(list, index); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
564 | } |
439
9a5adedd6de6
add high-level function cxListAt()
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
565 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
566 | /** |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
567 | * Returns an iterator pointing to the item at the specified index. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
568 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
569 | * The returned iterator is position-aware. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
570 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
571 | * If the index is out of range, a past-the-end iterator will be returned. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
572 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
573 | * @param list the list |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
574 | * @param index the index where the iterator shall point at |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
575 | * @return a new iterator |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
576 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
577 | __attribute__((__nonnull__, __warn_unused_result__)) |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
578 | static inline CxIterator cxListIteratorAt( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
579 | const CxList *list, |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
580 | size_t index |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
581 | ) { |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
582 | return list->cl->iterator(list, index, false); |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
583 | } |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
584 | |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
585 | /** |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
586 | * Returns a backwards iterator pointing to the item at the specified index. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
587 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
588 | * The returned iterator is position-aware. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
589 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
590 | * If the index is out of range, a past-the-end iterator will be returned. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
591 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
592 | * @param list the list |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
593 | * @param index the index where the iterator shall point at |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
594 | * @return a new iterator |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
595 | */ |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
596 | __attribute__((__nonnull__, __warn_unused_result__)) |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
597 | static inline CxIterator cxListBackwardsIteratorAt( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
598 | const CxList *list, |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
599 | size_t index |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
600 | ) { |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
601 | return list->cl->iterator(list, index, true); |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
602 | } |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
603 | |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
604 | /** |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
605 | * Returns a mutating iterator pointing to the item at the specified index. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
606 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
607 | * The returned iterator is position-aware. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
608 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
609 | * If the index is out of range, a past-the-end iterator will be returned. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
610 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
611 | * @param list the list |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
612 | * @param index the index where the iterator shall point at |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
613 | * @return a new iterator |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
614 | */ |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
615 | __attribute__((__nonnull__, __warn_unused_result__)) |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
616 | CxIterator cxListMutIteratorAt( |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
617 | CxList *list, |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
618 | size_t index |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
619 | ); |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
620 | |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
621 | /** |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
622 | * Returns a mutating backwards iterator pointing to the item at the |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
623 | * specified index. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
624 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
625 | * The returned iterator is position-aware. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
626 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
627 | * If the index is out of range, a past-the-end iterator will be returned. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
628 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
629 | * @param list the list |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
630 | * @param index the index where the iterator shall point at |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
631 | * @return a new iterator |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
632 | */ |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
633 | __attribute__((__nonnull__, __warn_unused_result__)) |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
634 | CxIterator cxListMutBackwardsIteratorAt( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
635 | CxList *list, |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
636 | size_t index |
640
55cc3b373c5e
simplify list class - fixes #236
Mike Becker <universe@uap-core.de>
parents:
638
diff
changeset
|
637 | ); |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
638 | |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
639 | /** |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
640 | * Returns an iterator pointing to the first item of the list. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
641 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
642 | * The returned iterator is position-aware. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
643 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
644 | * If the list is empty, a past-the-end iterator will be returned. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
645 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
646 | * @param list the list |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
647 | * @return a new iterator |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
648 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
649 | __attribute__((__nonnull__, __warn_unused_result__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
650 | static inline CxIterator cxListIterator(const CxList *list) { |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
651 | return list->cl->iterator(list, 0, false); |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
652 | } |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
653 | |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
654 | /** |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
655 | * Returns a mutating iterator pointing to the first item of the list. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
656 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
657 | * The returned iterator is position-aware. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
658 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
659 | * If the list is empty, a past-the-end iterator will be returned. |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
660 | * |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
661 | * @param list the list |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
662 | * @return a new iterator |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
663 | */ |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
664 | __attribute__((__nonnull__, __warn_unused_result__)) |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
665 | static inline CxIterator cxListMutIterator(CxList *list) { |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
666 | return cxListMutIteratorAt(list, 0); |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
667 | } |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
668 | |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
669 | |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
670 | /** |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
671 | * Returns a backwards iterator pointing to the last item of the list. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
672 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
673 | * The returned iterator is position-aware. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
674 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
675 | * If the list is empty, a past-the-end iterator will be returned. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
676 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
677 | * @param list the list |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
678 | * @return a new iterator |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
679 | */ |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
680 | __attribute__((__nonnull__, __warn_unused_result__)) |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
681 | static inline CxIterator cxListBackwardsIterator(const CxList *list) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
682 | return list->cl->iterator(list, list->collection.size - 1, true); |
655
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
683 | } |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
684 | |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
685 | /** |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
686 | * Returns a mutating backwards iterator pointing to the last item of the list. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
687 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
688 | * The returned iterator is position-aware. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
689 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
690 | * If the list is empty, a past-the-end iterator will be returned. |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
691 | * |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
692 | * @param list the list |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
693 | * @return a new iterator |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
694 | */ |
7340c4255f1f
implement backwards iterator - fixes #238
Mike Becker <universe@uap-core.de>
parents:
647
diff
changeset
|
695 | __attribute__((__nonnull__, __warn_unused_result__)) |
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
764
diff
changeset
|
696 | static inline CxIterator cxListMutBackwardsIterator(CxList *list) { |
856
6bbbf219251d
fix name of collection base member (to avoid base.base)
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
697 | return cxListMutBackwardsIteratorAt(list, list->collection.size - 1); |
630
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
698 | } |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
699 | |
ac5e7f789048
separate iterators and mutating iterators
Mike Becker <universe@uap-core.de>
parents:
629
diff
changeset
|
700 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
701 | * Returns the index of the first element that equals \p elem. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
702 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
703 | * Determining equality is performed by the list's comparator function. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
704 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
705 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
706 | * @param elem the element to find |
699
35b2b99ee523
make list find return a negative value when elem not found
Mike Becker <universe@uap-core.de>
parents:
698
diff
changeset
|
707 | * @return the index of the element or a negative |
35b2b99ee523
make list find return a negative value when elem not found
Mike Becker <universe@uap-core.de>
parents:
698
diff
changeset
|
708 | * value when the element is not found |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
709 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
710 | __attribute__((__nonnull__)) |
699
35b2b99ee523
make list find return a negative value when elem not found
Mike Becker <universe@uap-core.de>
parents:
698
diff
changeset
|
711 | static inline ssize_t cxListFind( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
712 | const CxList *list, |
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
713 | const void *elem |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
714 | ) { |
764
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
715 | return list->cl->find_remove((CxList*)list, elem, false); |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
716 | } |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
717 | |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
718 | /** |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
719 | * Removes and returns the index of the first element that equals \p elem. |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
720 | * |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
721 | * Determining equality is performed by the list's comparator function. |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
722 | * |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
723 | * @param list the list |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
724 | * @param elem the element to find and remove |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
725 | * @return the index of the now removed element or a negative |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
726 | * value when the element is not found or could not be removed |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
727 | */ |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
728 | __attribute__((__nonnull__)) |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
729 | static inline ssize_t cxListFindRemove( |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
730 | CxList *list, |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
731 | const void *elem |
764
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
732 | ) { |
ccbdbd088455
add cxListFindRemove and cx_linked_list_find_node
Mike Becker <universe@uap-core.de>
parents:
759
diff
changeset
|
733 | return list->cl->find_remove(list, elem, true); |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
734 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
735 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
736 | /** |
741 | 737 | * Sorts the list in-place. |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
738 | * |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
739 | * \remark The underlying sort algorithm is implementation defined. |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
740 | * |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
741 | * @param list the list |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
742 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
743 | __attribute__((__nonnull__)) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
744 | static inline void cxListSort(CxList *list) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
745 | list->cl->sort(list); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
746 | } |
404 | 747 | |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
748 | /** |
490 | 749 | * Reverses the order of the items. |
750 | * | |
751 | * @param list the list | |
752 | */ | |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
753 | __attribute__((__nonnull__)) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
754 | static inline void cxListReverse(CxList *list) { |
490 | 755 | list->cl->reverse(list); |
756 | } | |
757 | ||
758 | /** | |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
759 | * Compares a list to another list of the same type. |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
760 | * |
618
1f5a8f6f3015
#219 array list: implement compare
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
761 | * First, the list sizes are compared. |
1f5a8f6f3015
#219 array list: implement compare
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
762 | * If they match, the lists are compared element-wise. |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
763 | * |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
764 | * @param list the list |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
765 | * @param other the list to compare to |
618
1f5a8f6f3015
#219 array list: implement compare
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
766 | * @return zero, if both lists are equal element wise, |
1f5a8f6f3015
#219 array list: implement compare
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
767 | * negative if the first list is smaller, positive if the first list is larger |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
768 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
769 | __attribute__((__nonnull__)) |
618
1f5a8f6f3015
#219 array list: implement compare
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
770 | int cxListCompare( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
771 | const CxList *list, |
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
882
diff
changeset
|
772 | const CxList *other |
618
1f5a8f6f3015
#219 array list: implement compare
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
773 | ); |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
774 | |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
775 | /** |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
776 | * Deallocates the memory of the specified list structure. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
777 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
778 | * Also calls content a destructor function, depending on the configuration |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
779 | * in CxList.content_destructor_type. |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
780 | * |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
781 | * This function itself is a destructor function for the CxList. |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
782 | * |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
783 | * @param list the list which shall be destroyed |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
784 | */ |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
785 | __attribute__((__nonnull__)) |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
786 | void cxListDestroy(CxList *list); |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
787 | |
704
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
788 | /** |
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
789 | * A shared instance of an empty list. |
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
790 | * |
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
791 | * Writing to that list is undefined. |
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
792 | */ |
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
793 | extern CxList * const cxEmptyList; |
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
794 | |
35f06c5eeb0e
add empty list implementation - fixes #258
Mike Becker <universe@uap-core.de>
parents:
699
diff
changeset
|
795 | |
415 | 796 | #ifdef __cplusplus |
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
621
diff
changeset
|
797 | } // extern "C" |
415 | 798 | #endif |
799 | ||
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
621
diff
changeset
|
800 | #endif // UCX_LIST_H |