Blender V5.3
BLI_listbase.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
11#include <cstddef>
12
13#include "BLI_compiler_attrs.hh"
16
17#include "DNA_listBase.h"
18
19#include <type_traits>
20
21namespace blender {
22
26int BLI_findindex(const ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT
27 ATTR_NONNULL(1);
32int BLI_findstringindex(const ListBase *listbase,
33 const char *id,
35
40
44template<typename T> ListBaseT<T> BLI_listbase_from_link(T *some_link)
45{
46 const ListBase list = BLI_listbase_from_link(reinterpret_cast<Link *>(some_link));
47 return ListBaseT<T>{static_cast<T *>(list.first_), static_cast<T *>(list.last_)};
48}
49
50/* Find forwards. */
51
55void *BLI_findlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
56
61void *BLI_findlinkfrom(Link *start, int step) ATTR_WARN_UNUSED_RESULT;
62
67void *BLI_findstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT
68 ATTR_NONNULL(1);
73void *BLI_listbase_findafter_string(Link *link, const char *id, int offset) ATTR_WARN_UNUSED_RESULT
74 ATTR_NONNULL(1);
79void *BLI_findstring_ptr(const ListBase *listbase,
80 const char *id,
86void *BLI_listbase_findafter_string_ptr(Link *link, const char *id, int offset);
87
92void *BLI_findptr(const ListBase *listbase, const void *ptr, int offset) ATTR_WARN_UNUSED_RESULT
93 ATTR_NONNULL(1);
98void *BLI_listbase_bytes_find(const ListBase *listbase,
99 const void *bytes,
100 size_t bytes_size,
101 int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
109void *BLI_listbase_string_or_index_find(const ListBase *listbase,
110 const char *string,
111 size_t string_offset,
113
114/* Find backwards. */
115
119void *BLI_rfindlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
124void *BLI_rfindstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT
125 ATTR_NONNULL(1);
130void *BLI_rfindstring_ptr(const ListBase *listbase,
131 const char *id,
137void *BLI_rfindptr(const ListBase *listbase, const void *ptr, int offset) ATTR_WARN_UNUSED_RESULT
138 ATTR_NONNULL(1);
143void *BLI_listbase_bytes_rfind(const ListBase *listbase,
144 const void *bytes,
145 size_t bytes_size,
146 int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
147
151void BLI_freelistN(ListBase *listbase) ATTR_NONNULL(1);
155void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
161void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
165bool BLI_remlink_safe(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
169void *BLI_pophead(ListBase *listbase) ATTR_NONNULL(1);
173void *BLI_poptail(ListBase *listbase) ATTR_NONNULL(1);
174
178void BLI_addhead(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
183void BLI_insertlinkbefore(ListBase *listbase, void *vnextlink, void *vnewlink) ATTR_NONNULL(1);
188void BLI_insertlinkafter(ListBase *listbase, void *vprevlink, void *vnewlink) ATTR_NONNULL(1);
196void BLI_insertlinkreplace(ListBase *listbase, void *vreplacelink, void *vnewlink)
197 ATTR_NONNULL(1, 2, 3);
203void BLI_listbase_sort(ListBase *listbase, int (*cmp)(const void *, const void *))
204 ATTR_NONNULL(1, 2);
205void BLI_listbase_sort_r(ListBase *listbase,
206 int (*cmp)(void *, const void *, const void *),
207 void *thunk) ATTR_NONNULL(1, 2);
216bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL();
222bool BLI_listbase_move_index(ListBase *listbase, int from, int to) ATTR_NONNULL();
226void BLI_freelist(ListBase *listbase) ATTR_NONNULL(1);
232int BLI_listbase_count_at_most(const ListBase *listbase, int count_max) ATTR_WARN_UNUSED_RESULT
233 ATTR_NONNULL(1);
239BLI_INLINE bool BLI_listbase_count_is_equal_to(const ListBase *listbase, const int count_cmp)
240{
241 return BLI_listbase_count_at_most(listbase, count_cmp + 1) == count_cmp;
242}
243
247int BLI_listbase_count(const ListBase *listbase) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
251void BLI_freelinkN(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
252
256void BLI_listbase_swaplinks(ListBase *listbase, void *vlinka, void *vlinkb) ATTR_NONNULL(1, 2);
261void BLI_listbases_swaplinks(ListBase *listbasea, ListBase *listbaseb, void *vlinka, void *vlinkb)
262 ATTR_NONNULL(2, 3);
263
267void BLI_movelisttolist(ListBase *dst, ListBase *src) ATTR_NONNULL(1, 2);
271void BLI_movelisttolist_reverse(ListBase *dst, ListBase *src) ATTR_NONNULL(1, 2);
279void BLI_listbase_split_after(ListBase *original_listbase, ListBase *split_listbase, void *vlink)
280 ATTR_NONNULL(1, 2);
284void BLI_duplicatelist(ListBase *dst, const ListBase *src) ATTR_NONNULL(1, 2);
285void BLI_listbase_reverse(ListBase *lb) ATTR_NONNULL(1);
289void BLI_listbase_rotate_first(ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
293void BLI_listbase_rotate_last(ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
294
299{
300 return (lb->first_ && lb->first_ == lb->last_);
301}
303{
304 return (lb->first_ == static_cast<void *>(nullptr));
305}
307{
308 lb->first_ = lb->last_ = static_cast<void *>(nullptr);
309}
310
315bool BLI_listbase_validate(ListBase *lb);
316
324{
325 if (a == nullptr) {
326 return b == nullptr;
327 }
328 if (b == nullptr) {
329 return false;
330 }
331 return a->first_ == b->first_ && a->last_ == b->last_;
332}
333
337LinkData *BLI_genericNodeN(void *data);
338
353#define LISTBASE_CIRCULAR_FORWARD_BEGIN(type, lb, lb_iter, lb_init) \
354 if ((lb)->first_ && (lb_init || (lb_init = (type)(lb)->first_))) { \
355 lb_iter = (type)(lb_init); \
356 do {
357#define LISTBASE_CIRCULAR_FORWARD_END(type, lb, lb_iter, lb_init) \
358 } \
359 while ((lb_iter = (lb_iter)->next ? (type)(lb_iter)->next : (type)(lb)->first_), \
360 (lb_iter != lb_init)) \
361 ; \
362 } \
363 ((void)0)
364
365#define LISTBASE_CIRCULAR_BACKWARD_BEGIN(type, lb, lb_iter, lb_init) \
366 if ((lb)->last_ && (lb_init || (lb_init = (type)(lb)->last_))) { \
367 lb_iter = lb_init; \
368 do {
369#define LISTBASE_CIRCULAR_BACKWARD_END(type, lb, lb_iter, lb_init) \
370 } \
371 while ((lb_iter = (lb_iter)->prev ? (lb_iter)->prev : (type)(lb)->last_), (lb_iter != lb_init)) \
372 ; \
373 } \
374 ((void)0)
375
377{
378 return BLI_listbase_equal(&a, &b);
379}
381{
382 return !(a == b);
383}
384
385template<typename T, typename Fn>
386T *BLI_listbase_find(const ListBaseT<T> &listbase, Fn &&predicate)
387{
388 for (const T &value : listbase) {
389 if (predicate(value)) {
390 return &value;
391 }
392 }
393 return nullptr;
394}
395
396} // namespace blender
#define ATTR_WARN_UNUSED_RESULT
#define ATTR_NONNULL(...)
These structs are the foundation for all linked lists in the library system.
#define BLI_INLINE
#define index(i)
VecBase< float, D > step(VecOp< float, D >, VecOp< float, D >) RET
#define T
bool operator==(const Error &left, const Error &right)
BMesh Iterators.
void * BLI_findptr(const ListBase *listbase, const void *ptr, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:710
void void BLI_listbases_swaplinks(ListBase *listbasea, ListBase *listbaseb, void *vlinka, void *vlinkb) ATTR_NONNULL(2
Definition listbase.cc:224
void * BLI_rfindlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:556
void * BLI_poptail(ListBase *listbase) ATTR_NONNULL(1)
Definition listbase.cc:268
void BLI_addhead(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:98
void BLI_insertlinkreplace(ListBase *listbase, void *vreplacelink, void *vnewlink) ATTR_NONNULL(1
Definition listbase.cc:417
BLI_INLINE void BLI_listbase_clear(ListBase *lb)
void void void void void void BLI_duplicatelist(ListBase *dst, const ListBase *src) ATTR_NONNULL(1
Definition listbase.cc:834
bool operator!=(const CPPType &a, const CPPType &b)
void * BLI_rfindstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:633
void * BLI_listbase_findafter_string(Link *link, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:645
void * BLI_findstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:615
void void void BLI_movelisttolist(ListBase *dst, ListBase *src) ATTR_NONNULL(1
Definition listbase.cc:32
BLI_INLINE bool BLI_listbase_equal(const ListBase *a, const ListBase *b)
BLI_INLINE bool BLI_listbase_is_empty(const ListBase *lb)
void void BLI_listbase_rotate_last(ListBase *lb, void *vlink) ATTR_NONNULL(1
Definition listbase.cc:882
void * BLI_pophead(ListBase *listbase) ATTR_NONNULL(1)
Definition listbase.cc:259
bool BLI_listbase_validate(ListBase *lb)
Definition listbase.cc:895
void * BLI_findlinkfrom(Link *start, int step) ATTR_WARN_UNUSED_RESULT
Definition listbase.cc:571
void * BLI_findlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:541
int BLI_findstringindex(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:794
int BLI_findindex(const ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:593
void * BLI_findstring_ptr(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:658
void BLI_freelist(ListBase *listbase) ATTR_NONNULL(1)
Definition listbase.cc:490
void void BLI_freelistN(ListBase *listbase) ATTR_NONNULL(1)
Definition listbase.cc:504
void void void BLI_listbase_sort_r(ListBase *listbase, int(*cmp)(void *, const void *, const void *), void *thunk) ATTR_NONNULL(1
Definition listbase.cc:328
void * BLI_rfindstring_ptr(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:674
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:138
void * BLI_listbase_bytes_rfind(const ListBase *listbase, const void *bytes, size_t bytes_size, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
Definition listbase.cc:752
BMesh const char void * data
void BLI_insertlinkafter(ListBase *listbase, void *vprevlink, void *vnewlink) ATTR_NONNULL(1)
Definition listbase.cc:339
void void void void void BLI_listbase_split_after(ListBase *original_listbase, ListBase *split_listbase, void *vlink) ATTR_NONNULL(1
Definition listbase.cc:69
bool BLI_listbase_move_index(ListBase *listbase, int from, int to) ATTR_NONNULL()
Definition listbase.cc:474
void * BLI_listbase_findafter_string_ptr(Link *link, const char *id, int offset)
Definition listbase.cc:693
void BLI_listbase_swaplinks(ListBase *listbase, void *vlinka, void *vlinkb) ATTR_NONNULL(1
Definition listbase.cc:171
void BLI_listbase_rotate_first(ListBase *lb, void *vlink) ATTR_NONNULL(1
Definition listbase.cc:869
void BLI_freelinkN(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:277
BLI_INLINE bool BLI_listbase_count_is_equal_to(const ListBase *listbase, const int count_cmp)
LinkData * BLI_genericNodeN(void *data)
Definition listbase.cc:936
void * BLI_rfindptr(const ListBase *listbase, const void *ptr, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:722
void void void void void void void BLI_listbase_reverse(ListBase *lb) ATTR_NONNULL(1)
Definition listbase.cc:850
int BLI_listbase_count(const ListBase *listbase) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:531
int BLI_listbase_count_at_most(const ListBase *listbase, int count_max) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:518
void BLI_insertlinkbefore(ListBase *listbase, void *vnextlink, void *vnewlink) ATTR_NONNULL(1)
Definition listbase.cc:378
void void BLI_listbase_sort(ListBase *listbase, int(*cmp)(const void *, const void *)) ATTR_NONNULL(1
Definition listbase.cc:319
void void * BLI_listbase_string_or_index_find(const ListBase *listbase, const char *string, size_t string_offset, int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:768
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
void * BLI_listbase_bytes_find(const ListBase *listbase, const void *bytes, size_t bytes_size, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
Definition listbase.cc:737
bool BLI_remlink_safe(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:161
void void void void BLI_movelisttolist_reverse(ListBase *dst, ListBase *src) ATTR_NONNULL(1
Definition listbase.cc:50
bool ATTR_WARN_UNUSED_RESULT
void ATTR_NONNULL(1, 2)
ListBase BLI_listbase_from_link(Link *some_link)
Definition listbase.cc:814
T * BLI_listbase_find(const ListBaseT< T > &listbase, Fn &&predicate)
void void void bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL()
Definition listbase.cc:443
void void BLI_INLINE bool BLI_listbase_is_single(const ListBase *lb)