Mon, 15 Dec 2025 19:00:51 +0100
complete refactoring of low-level array list functions - relates to #619
now only the documentation needs to be updated
|
850
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
1 | /* |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
3 | * |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
4 | * Copyright 2024 Mike Becker, Olaf Wintermann All rights reserved. |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
5 | * |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
6 | * Redistribution and use in source and binary forms, with or without |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
7 | * modification, are permitted provided that the following conditions are met: |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
8 | * |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
9 | * 1. Redistributions of source code must retain the above copyright |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
10 | * notice, this list of conditions and the following disclaimer. |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
11 | * |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
12 | * 2. Redistributions in binary form must reproduce the above copyright |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
13 | * notice, this list of conditions and the following disclaimer in the |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
14 | * documentation and/or other materials provided with the distribution. |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
15 | * |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
27 | */ |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
28 | |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
29 | #include "cx/iterator.h" |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
30 | |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
31 | #include <string.h> |
|
1607
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
32 | #include <assert.h> |
|
850
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
33 | |
|
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
34 | static bool cx_iter_valid(const void *it) { |
|
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
35 | const struct cx_iterator_s *iter = it; |
|
850
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
36 | return iter->index < iter->elem_count; |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
37 | } |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
38 | |
|
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
39 | static void *cx_iter_current(const void *it) { |
|
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
854
diff
changeset
|
40 | const struct cx_iterator_s *iter = it; |
|
850
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
41 | return iter->elem_handle; |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
42 | } |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
43 | |
|
1070
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
44 | static void *cx_iter_current_ptr(const void *it) { |
|
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
45 | const struct cx_iterator_s *iter = it; |
|
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
46 | return *(void**)iter->elem_handle; |
|
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
47 | } |
|
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
48 | |
|
1607
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
49 | static void cx_iter_next(void *it) { |
|
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
851
diff
changeset
|
50 | struct cx_iterator_s *iter = it; |
|
1607
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
51 | assert(!iter->base.remove); |
|
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
52 | iter->index++; |
|
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
53 | iter->elem_handle = ((char *) iter->elem_handle) + iter->elem_size; |
|
850
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
54 | } |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
55 | |
|
1607
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
56 | CxIterator cxIterator(const void *array, size_t elem_size, size_t elem_count) { |
|
853
d4baf4dd55c3
simplify iterator structures
Mike Becker <universe@uap-core.de>
parents:
851
diff
changeset
|
57 | CxIterator iter; |
|
850
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
58 | |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
59 | iter.index = 0; |
|
1429
6e0c3a8a914a
remove the concept of "mutating iterators" - resolves #579
Mike Becker <universe@uap-core.de>
parents:
1070
diff
changeset
|
60 | iter.src_handle = (void*) array; |
|
6e0c3a8a914a
remove the concept of "mutating iterators" - resolves #579
Mike Becker <universe@uap-core.de>
parents:
1070
diff
changeset
|
61 | iter.elem_handle = (void*) array; |
|
850
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
62 | iter.elem_size = elem_size; |
|
b2bc48c2b251
add iterator over raw C arrays - closes #389
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
63 | iter.elem_count = array == NULL ? 0 : elem_count; |
|
854
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
64 | iter.base.valid = cx_iter_valid; |
|
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
65 | iter.base.current = cx_iter_current; |
|
1607
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
66 | iter.base.next = cx_iter_next; |
|
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
67 | iter.base.valid_impl = NULL; |
|
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
68 | iter.base.current_impl = NULL; |
|
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
69 | iter.base.next_impl = NULL; |
|
854
fe0d69d72bcd
fix members inherited by macro or include are not documented
Mike Becker <universe@uap-core.de>
parents:
853
diff
changeset
|
70 | iter.base.remove = false; |
|
1429
6e0c3a8a914a
remove the concept of "mutating iterators" - resolves #579
Mike Becker <universe@uap-core.de>
parents:
1070
diff
changeset
|
71 | iter.base.allow_remove = true; |
|
851
adb4e0737c33
issue #389 : add separate function for immutable arrays
Mike Becker <universe@uap-core.de>
parents:
850
diff
changeset
|
72 | |
|
1070
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
73 | return iter; |
|
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
74 | } |
|
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
75 | |
|
1607
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
76 | CxIterator cxIteratorPtr(const void *array, size_t elem_count) { |
|
0ecb13118cac
next step of simplifying the array API - relates to #619
Mike Becker <universe@uap-core.de>
parents:
1429
diff
changeset
|
77 | CxIterator iter = cxIterator(array, sizeof(void*), elem_count); |
|
1429
6e0c3a8a914a
remove the concept of "mutating iterators" - resolves #579
Mike Becker <universe@uap-core.de>
parents:
1070
diff
changeset
|
78 | iter.base.current = cx_iter_current_ptr; |
|
1070
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
79 | return iter; |
|
0a5a356a4486
add array iterator over pointer arrays
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
80 | } |