Fix T56195: Typo in BLI_array_utils.h.
[blender.git] / source / blender / blenlib / BLI_array_utils.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __BLI_ARRAY_UTILS_H__
22 #define __BLI_ARRAY_UTILS_H__
23
24 /** \file BLI_array_utils.h
25  *  \ingroup bli
26  *  \brief Generic array manipulation API.
27  */
28
29 #include "BLI_compiler_typecheck.h"
30
31 void _bli_array_reverse(void *arr, unsigned int arr_len, size_t arr_stride);
32 #define BLI_array_reverse(arr, arr_len) \
33         _bli_array_reverse(arr, arr_len, sizeof(*(arr)))
34
35 void _bli_array_wrap(void *arr, unsigned int arr_len, size_t arr_stride, int dir);
36 #define BLI_array_wrap(arr, arr_len, dir) \
37         _bli_array_wrap(arr, arr_len, sizeof(*(arr)), dir)
38
39 void _bli_array_permute(
40         void *arr, const unsigned int arr_len, const size_t arr_stride,
41         const unsigned int *index, void *arr_temp);
42 #define BLI_array_permute(arr, arr_len, order) \
43         _bli_array_permute(arr, arr_len, sizeof(*(arr)), order, NULL)
44 #define BLI_array_permute_ex(arr, arr_len, order, arr_temp) \
45         _bli_array_permute(arr, arr_len, sizeof(*(arr)), order, arr_temp)
46
47 int _bli_array_findindex(const void *arr, unsigned int arr_len, size_t arr_stride, const void *p);
48 #define BLI_array_findindex(arr, arr_len, p) \
49         _bli_array_findindex(arr, arr_len, sizeof(*(arr)), p)
50
51 int _bli_array_rfindindex(const void *arr, unsigned int arr_len, size_t arr_stride, const void *p);
52 #define BLI_array_rfindindex(arr, arr_len, p) \
53         _bli_array_rfindindex(arr, arr_len, sizeof(*(arr)), p)
54
55 void _bli_array_binary_and(
56         void *arr, const void *arr_a, const void *arr_b,
57         unsigned int arr_len, size_t arr_stride);
58 #define BLI_array_binary_and(arr, arr_a, arr_b, arr_len) \
59         (CHECK_TYPE_PAIR_INLINE(*(arr), *(arr_a)), \
60          CHECK_TYPE_PAIR_INLINE(*(arr), *(arr_b)), \
61          _bli_array_binary_and(arr, arr_a, arr_b, arr_len, sizeof(*(arr))))
62
63 void _bli_array_binary_or(
64         void *arr, const void *arr_a, const void *arr_b,
65         unsigned int arr_len, size_t arr_stride);
66 #define BLI_array_binary_or(arr, arr_a, arr_b, arr_len) \
67         (CHECK_TYPE_PAIR_INLINE(*(arr), *(arr_a)), \
68          CHECK_TYPE_PAIR_INLINE(*(arr), *(arr_b)), \
69          _bli_array_binary_or(arr, arr_a, arr_b, arr_len, sizeof(*(arr))))
70
71 bool _bli_array_iter_span(
72         const void *arr,
73         unsigned int arr_len, size_t arr_stride,
74         bool use_wrap, bool use_delimit_bounds,
75         bool (*test_fn)(const void *arr_item, void *user_data), void *user_data,
76         unsigned int span_step[2], unsigned int *r_span_len);
77 #define BLI_array_iter_span( \
78         arr, arr_len, use_wrap, use_delimit_bounds, test_fn, user_data, \
79         span_step, r_span_len) \
80         _bli_array_iter_span( \
81                 arr, arr_len, sizeof(*(arr)), use_wrap, use_delimit_bounds, test_fn, user_data, \
82                 span_step, r_span_len)
83
84 bool _bli_array_is_zeroed(
85         const void *arr,
86         unsigned int arr_len, size_t arr_stride);
87 #define BLI_array_is_zeroed(arr, arr_len) \
88         _bli_array_is_zeroed( \
89                 arr, arr_len, sizeof(*(arr)))
90
91 #endif  /* __BLI_ARRAY_UTILS_H__ */