Fri, 09 Nov 2018 17:11:12 +0100
fixes document switching with textareas (Motif)
0 | 1 | /* |
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
3 | * | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
4 | * Copyright 2016 Olaf Wintermann. All rights reserved. |
0 | 5 | * |
6 | * Redistribution and use in source and binary forms, with or without | |
7 | * modification, are permitted provided that the following conditions are met: | |
8 | * | |
9 | * 1. Redistributions of source code must retain the above copyright | |
10 | * notice, this list of conditions and the following disclaimer. | |
11 | * | |
12 | * 2. Redistributions in binary form must reproduce the above copyright | |
13 | * notice, this list of conditions and the following disclaimer in the | |
14 | * documentation and/or other materials provided with the distribution. | |
15 | * | |
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
26 | * POSSIBILITY OF SUCH DAMAGE. | |
27 | */ | |
28 | /** | |
29 | * Doubly linked list implementation. | |
30 | * | |
31 | * @file list.h | |
32 | * @author Mike Becker | |
33 | * @author Olaf Wintermann | |
34 | */ | |
35 | ||
36 | #ifndef UCX_LIST_H | |
37 | #define UCX_LIST_H | |
38 | ||
39 | #include "ucx.h" | |
40 | #include "allocator.h" | |
41 | ||
42 | #ifdef __cplusplus | |
43 | extern "C" { | |
44 | #endif | |
45 | ||
46 | /** | |
47 | * Loop statement for UCX lists. | |
48 | * | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
49 | * The first argument is the name of the iteration variable. The scope of |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
50 | * this variable is limited to the <code>UCX_FOREACH</code> statement. |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
51 | * |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
52 | * The second argument is a pointer to the list. In most cases this will be the |
0 | 53 | * pointer to the first element of the list, but it may also be an arbitrary |
54 | * element of the list. The iteration will then start with that element. | |
55 | * | |
56 | * @param list The first element of the list | |
57 | * @param elem The variable name of the element | |
58 | */ | |
59 | #define UCX_FOREACH(elem,list) \ | |
60 | for (UcxList* elem = list ; elem != NULL ; elem = elem->next) | |
61 | ||
62 | /** | |
63 | * UCX list type. | |
64 | * @see UcxList | |
65 | */ | |
66 | typedef struct UcxList UcxList; | |
67 | ||
68 | /** | |
69 | * UCX list structure. | |
70 | */ | |
71 | struct UcxList { | |
72 | /** | |
73 | * List element payload. | |
74 | */ | |
75 | void *data; | |
76 | /** | |
77 | * Pointer to the next list element or <code>NULL</code>, if this is the | |
78 | * last element. | |
79 | */ | |
80 | UcxList *next; | |
81 | /** | |
82 | * Pointer to the previous list element or <code>NULL</code>, if this is | |
83 | * the first element. | |
84 | */ | |
85 | UcxList *prev; | |
86 | }; | |
87 | ||
88 | /** | |
89 | * Creates an element-wise copy of a list. | |
90 | * | |
91 | * This function clones the specified list by creating new list elements and | |
92 | * copying the data with the specified copy_func(). If no copy_func() is | |
93 | * specified, a shallow copy is created and the new list will reference the | |
94 | * same data as the source list. | |
95 | * | |
96 | * @param list the list to copy | |
97 | * @param cpyfnc a pointer to the function that shall copy an element (may be | |
98 | * <code>NULL</code>) | |
99 | * @param data additional data for the copy_func() | |
100 | * @return a pointer to the copy | |
101 | */ | |
102 | UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data); | |
103 | ||
104 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
105 | * Creates an element-wise copy of a list using a UcxAllocator. |
0 | 106 | * |
107 | * See ucx_list_clone() for details. | |
108 | * | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
109 | * You might want to pass the allocator via the <code>data</code> parameter, |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
110 | * to access it within the copy function for making deep copies. |
0 | 111 | * |
112 | * @param allocator the allocator to use | |
113 | * @param list the list to copy | |
114 | * @param cpyfnc a pointer to the function that shall copy an element (may be | |
115 | * <code>NULL</code>) | |
116 | * @param data additional data for the copy_func() | |
117 | * @return a pointer to the copy | |
118 | * @see ucx_list_clone() | |
119 | */ | |
120 | UcxList *ucx_list_clone_a(UcxAllocator *allocator, UcxList *list, | |
121 | copy_func cpyfnc, void* data); | |
122 | ||
123 | /** | |
124 | * Compares two UCX lists element-wise by using a compare function. | |
125 | * | |
126 | * Each element of the two specified lists are compared by using the specified | |
127 | * compare function and the additional data. The type and content of this | |
128 | * additional data depends on the cmp_func() used. | |
129 | * | |
130 | * If the list pointers denote elements within a list, the lists are compared | |
131 | * starting with the denoted elements. Thus any previous elements are not taken | |
132 | * into account. This might be useful to check, if certain list tails match | |
133 | * each other. | |
134 | * | |
135 | * @param list1 the first list | |
136 | * @param list2 the second list | |
137 | * @param cmpfnc the compare function | |
138 | * @param data additional data for the compare function | |
139 | * @return 1, if and only if the two lists equal element-wise, 0 otherwise | |
140 | */ | |
141 | int ucx_list_equals(const UcxList *list1, const UcxList *list2, | |
142 | cmp_func cmpfnc, void* data); | |
143 | ||
144 | /** | |
145 | * Destroys the entire list. | |
146 | * | |
147 | * The members of the list are not automatically freed, so ensure they are | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
148 | * otherwise referenced or destroyed by ucx_list_free_contents(). |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
149 | * Otherwise, a memory leak is likely to occur. |
0 | 150 | * |
151 | * <b>Caution:</b> the argument <b>MUST</b> denote an entire list (i.e. a call | |
152 | * to ucx_list_first() on the argument must return the argument itself) | |
153 | * | |
154 | * @param list the list to free | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
155 | * @see ucx_list_free_contents() |
0 | 156 | */ |
157 | void ucx_list_free(UcxList *list); | |
158 | ||
159 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
160 | * Destroys the entire list using a UcxAllocator. |
0 | 161 | * |
162 | * See ucx_list_free() for details. | |
163 | * | |
164 | * @param allocator the allocator to use | |
165 | * @param list the list to free | |
166 | * @see ucx_list_free() | |
167 | */ | |
168 | void ucx_list_free_a(UcxAllocator *allocator, UcxList *list); | |
169 | ||
170 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
171 | * Destroys the contents of the specified list by calling the specified |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
172 | * destructor on each of them. |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
173 | * |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
174 | * Note, that the contents are not usable afterwards and the list should be |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
175 | * destroyed with ucx_list_free(). |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
176 | * |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
177 | * @param list the list for which the contents shall be freed |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
178 | * @param destr the destructor function (e.g. stdlib free()) |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
179 | * @see ucx_list_free() |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
180 | */ |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
181 | void ucx_list_free_content(UcxList* list, ucx_destructor destr); |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
182 | |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
183 | |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
184 | /** |
0 | 185 | * Inserts an element at the end of the list. |
186 | * | |
124
80609f9675f1
added support for icons for the table widget (GTK)
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
0
diff
changeset
|
187 | * This is generally an O(n) operation, as the end of the list is retrieved with |
0 | 188 | * ucx_list_last(). |
189 | * | |
190 | * @param list the list where to append the data, or <code>NULL</code> to | |
191 | * create a new list | |
192 | * @param data the data to insert | |
193 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to | |
194 | * the newly created list otherwise | |
195 | */ | |
196 | UcxList *ucx_list_append(UcxList *list, void *data); | |
197 | ||
198 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
199 | * Inserts an element at the end of the list using a UcxAllocator. |
0 | 200 | * |
201 | * See ucx_list_append() for details. | |
202 | * | |
203 | * @param allocator the allocator to use | |
204 | * @param list the list where to append the data, or <code>NULL</code> to | |
205 | * create a new list | |
206 | * @param data the data to insert | |
207 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to | |
208 | * the newly created list otherwise | |
209 | * @see ucx_list_append() | |
210 | */ | |
211 | UcxList *ucx_list_append_a(UcxAllocator *allocator, UcxList *list, void *data); | |
212 | ||
213 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
214 | * Inserts an element at the end of the list, if it is not present in the list. |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
215 | * |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
216 | * |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
217 | * @param list the list where to append the data, or <code>NULL</code> to |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
218 | * create a new list |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
219 | * @param data the data to insert |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
220 | * @param cmpfnc the compare function |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
221 | * @param cmpdata additional data for the compare function |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
222 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
223 | * the newly created list otherwise |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
224 | * @see ucx_list_append() |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
225 | */ |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
226 | UcxList *ucx_list_append_once(UcxList *list, void *data, |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
227 | cmp_func cmpfnc, void *cmpdata); |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
228 | |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
229 | /** |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
230 | * Inserts an element at the end of the list, if it is not present in the list, |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
231 | * using a UcxAllocator. |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
232 | * |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
233 | * See ucx_list_append() for details. |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
234 | * |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
235 | * @param allocator the allocator to use |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
236 | * @param list the list where to append the data, or <code>NULL</code> to |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
237 | * create a new list |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
238 | * @param data the data to insert |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
239 | * @param cmpfnc the compare function |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
240 | * @param cmpdata additional data for the compare function |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
241 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
242 | * the newly created list otherwise |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
243 | * @see ucx_list_append_a() |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
244 | */ |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
245 | UcxList *ucx_list_append_once_a(UcxAllocator *allocator, |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
246 | UcxList *list, void *data, cmp_func cmpfnc, void *cmpdata); |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
247 | |
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
248 | /** |
0 | 249 | * Inserts an element at the beginning of the list. |
250 | * | |
251 | * You <i>should</i> overwrite the old list pointer by calling | |
252 | * <code>mylist = ucx_list_prepend(mylist, mydata);</code>. However, you may | |
253 | * also perform successive calls of ucx_list_prepend() on the same list pointer, | |
254 | * as this function always searchs for the head of the list with | |
255 | * ucx_list_first(). | |
256 | * | |
257 | * @param list the list where to insert the data or <code>NULL</code> to create | |
258 | * a new list | |
259 | * @param data the data to insert | |
260 | * @return a pointer to the new list head | |
261 | */ | |
262 | UcxList *ucx_list_prepend(UcxList *list, void *data); | |
263 | ||
264 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
265 | * Inserts an element at the beginning of the list using a UcxAllocator. |
0 | 266 | * |
267 | * See ucx_list_prepend() for details. | |
268 | * | |
269 | * @param allocator the allocator to use | |
270 | * @param list the list where to insert the data or <code>NULL</code> to create | |
271 | * a new list | |
272 | * @param data the data to insert | |
273 | * @return a pointer to the new list head | |
274 | * @see ucx_list_prepend() | |
275 | */ | |
276 | UcxList *ucx_list_prepend_a(UcxAllocator *allocator, UcxList *list, void *data); | |
277 | ||
278 | /** | |
279 | * Concatenates two lists. | |
280 | * | |
281 | * Either of the two arguments may be <code>NULL</code>. | |
282 | * | |
283 | * This function modifies the references to the next/previous element of | |
284 | * the last/first element of <code>list1</code>/<code> | |
285 | * list2</code>. | |
286 | * | |
287 | * @param list1 first list | |
288 | * @param list2 second list | |
289 | * @return if <code>list1</code> is <code>NULL</code>, <code>list2</code> is | |
290 | * returned, otherwise <code>list1</code> is returned | |
291 | */ | |
292 | UcxList *ucx_list_concat(UcxList *list1, UcxList *list2); | |
293 | ||
294 | /** | |
295 | * Returns the first element of a list. | |
296 | * | |
297 | * If the argument is the list pointer, it is directly returned. Otherwise | |
298 | * this function traverses to the first element of the list and returns the | |
299 | * list pointer. | |
300 | * | |
301 | * @param elem one element of the list | |
302 | * @return the first element of the list, the specified element is a member of | |
303 | */ | |
304 | UcxList *ucx_list_first(const UcxList *elem); | |
305 | ||
306 | /** | |
307 | * Returns the last element of a list. | |
308 | * | |
309 | * If the argument has no successor, it is the last element and therefore | |
310 | * directly returned. Otherwise this function traverses to the last element of | |
311 | * the list and returns it. | |
312 | * | |
313 | * @param elem one element of the list | |
314 | * @return the last element of the list, the specified element is a member of | |
315 | */ | |
316 | UcxList *ucx_list_last(const UcxList *elem); | |
317 | ||
318 | /** | |
319 | * Returns the list element at the specified index. | |
320 | * | |
321 | * @param list the list to retrieve the element from | |
322 | * @param index index of the element to return | |
323 | * @return the element at the specified index or <code>NULL</code>, if the | |
324 | * index is greater than the list size | |
325 | */ | |
124
80609f9675f1
added support for icons for the table widget (GTK)
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
0
diff
changeset
|
326 | UcxList *ucx_list_get(const UcxList *list, size_t index); |
0 | 327 | |
328 | /** | |
329 | * Returns the index of an element. | |
330 | * | |
331 | * @param list the list where to search for the element | |
332 | * @param elem the element to find | |
333 | * @return the index of the element or -1 if the list does not contain the | |
334 | * element | |
335 | */ | |
336 | ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem); | |
337 | ||
338 | /** | |
339 | * Returns the element count of the list. | |
340 | * | |
341 | * @param list the list whose elements are counted | |
342 | * @return the element count | |
343 | */ | |
344 | size_t ucx_list_size(const UcxList *list); | |
345 | ||
346 | /** | |
347 | * Returns the index of an element containing the specified data. | |
348 | * | |
349 | * This function uses a cmp_func() to compare the data of each list element | |
350 | * with the specified data. If no cmp_func is provided, the pointers are | |
351 | * compared. | |
352 | * | |
353 | * If the list contains the data more than once, the index of the first | |
354 | * occurrence is returned. | |
355 | * | |
356 | * @param list the list where to search for the data | |
357 | * @param elem the element data | |
358 | * @param cmpfnc the compare function | |
359 | * @param data additional data for the compare function | |
360 | * @return the index of the element containing the specified data or -1 if the | |
361 | * data is not found in this list | |
362 | */ | |
363 | ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func cmpfnc, void *data); | |
364 | ||
365 | /** | |
366 | * Checks, if a list contains a specific element. | |
367 | * | |
368 | * An element is found, if ucx_list_find() returns a value greater than -1. | |
369 | * | |
370 | * @param list the list where to search for the data | |
371 | * @param elem the element data | |
372 | * @param cmpfnc the compare function | |
373 | * @param data additional data for the compare function | |
374 | * @return 1, if and only if the list contains the specified element data | |
375 | * @see ucx_list_find() | |
376 | */ | |
377 | int ucx_list_contains(UcxList *list, void *elem, cmp_func cmpfnc, void *data); | |
378 | ||
379 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
380 | * Sorts a UcxList with natural merge sort. |
0 | 381 | * |
382 | * This function uses O(n) additional temporary memory for merge operations | |
383 | * that is automatically freed after each merge. | |
384 | * | |
385 | * As the head of the list might change, you <b>MUST</b> call this function | |
386 | * as follows: <code>mylist = ucx_list_sort(mylist, mycmpfnc, mydata);</code>. | |
387 | * | |
388 | * @param list the list to sort | |
389 | * @param cmpfnc the function that shall be used to compare the element data | |
390 | * @param data additional data for the cmp_func() | |
391 | * @return the sorted list | |
392 | */ | |
393 | UcxList *ucx_list_sort(UcxList *list, cmp_func cmpfnc, void *data); | |
394 | ||
395 | /** | |
396 | * Removes an element from the list. | |
397 | * | |
398 | * If the first element is removed, the list pointer changes. So it is | |
399 | * <i>highly recommended</i> to <i>always</i> update the pointer by calling | |
400 | * <code>mylist = ucx_list_remove(mylist, myelem);</code>. | |
401 | * | |
402 | * @param list the list from which the element shall be removed | |
124
80609f9675f1
added support for icons for the table widget (GTK)
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
0
diff
changeset
|
403 | * @param element the element to remove |
0 | 404 | * @return returns the updated list pointer or <code>NULL</code>, if the list |
405 | * is now empty | |
406 | */ | |
407 | UcxList *ucx_list_remove(UcxList *list, UcxList *element); | |
408 | ||
409 | /** | |
152
62921b370c60
fixes use after free when a GtkTreeView was destroyed
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
124
diff
changeset
|
410 | * Removes an element from the list using a UcxAllocator. |
0 | 411 | * |
412 | * See ucx_list_remove() for details. | |
413 | * | |
414 | * @param allocator the allocator to use | |
415 | * @param list the list from which the element shall be removed | |
124
80609f9675f1
added support for icons for the table widget (GTK)
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
0
diff
changeset
|
416 | * @param element the element to remove |
0 | 417 | * @return returns the updated list pointer or <code>NULL</code>, if the list |
418 | * @see ucx_list_remove() | |
419 | */ | |
420 | UcxList *ucx_list_remove_a(UcxAllocator *allocator, UcxList *list, | |
421 | UcxList *element); | |
422 | ||
423 | #ifdef __cplusplus | |
424 | } | |
425 | #endif | |
426 | ||
427 | #endif /* UCX_LIST_H */ | |
428 |