Blender  V3.3
BLI_listbase.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later
2  * Copyright 2001-2002 NaN Holding BV. All rights reserved. */
3 
4 #pragma once
5 
10 #include "BLI_compiler_attrs.h"
11 #include "BLI_utildefines.h"
12 #include "DNA_listBase.h"
13 // struct ListBase;
14 // struct LinkData;
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
23 int BLI_findindex(const struct ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT
24  ATTR_NONNULL(1);
29 int BLI_findstringindex(const struct ListBase *listbase,
30  const char *id,
32 
36 ListBase BLI_listbase_from_link(struct Link *some_link);
37 
38 /* Find forwards. */
39 
43 void *BLI_findlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT
44  ATTR_NONNULL(1);
45 
49 void *BLI_findlinkfrom(struct Link *start, int number) ATTR_WARN_UNUSED_RESULT;
50 
55 void *BLI_findstring(const struct ListBase *listbase,
56  const char *id,
62 void *BLI_findstring_ptr(const struct ListBase *listbase,
63  const char *id,
69 void *BLI_findptr(const struct ListBase *listbase,
70  const void *ptr,
76 void *BLI_listbase_bytes_find(const ListBase *listbase,
77  const void *bytes,
78  size_t bytes_size,
87 void *BLI_listbase_string_or_index_find(const struct ListBase *listbase,
88  const char *string,
89  size_t string_offset,
91 
92 /* Find backwards. */
93 
97 void *BLI_rfindlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT
98  ATTR_NONNULL(1);
103 void *BLI_rfindstring(const struct ListBase *listbase,
104  const char *id,
110 void *BLI_rfindstring_ptr(const struct ListBase *listbase,
111  const char *id,
117 void *BLI_rfindptr(const struct ListBase *listbase,
118  const void *ptr,
124 void *BLI_listbase_bytes_rfind(const ListBase *listbase,
125  const void *bytes,
126  size_t bytes_size,
128 
132 void BLI_freelistN(struct ListBase *listbase) ATTR_NONNULL(1);
136 void BLI_addtail(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
142 void BLI_remlink(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
146 bool BLI_remlink_safe(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
150 void *BLI_pophead(ListBase *listbase) ATTR_NONNULL(1);
154 void *BLI_poptail(ListBase *listbase) ATTR_NONNULL(1);
155 
159 void BLI_addhead(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
164 void BLI_insertlinkbefore(struct ListBase *listbase, void *vnextlink, void *vnewlink)
165  ATTR_NONNULL(1);
170 void BLI_insertlinkafter(struct ListBase *listbase, void *vprevlink, void *vnewlink)
171  ATTR_NONNULL(1);
179 void BLI_insertlinkreplace(ListBase *listbase, void *vreplacelink, void *vnewlink)
180  ATTR_NONNULL(1, 2, 3);
186 void BLI_listbase_sort(struct ListBase *listbase, int (*cmp)(const void *, const void *))
187  ATTR_NONNULL(1, 2);
189  int (*cmp)(void *, const void *, const void *),
190  void *thunk) ATTR_NONNULL(1, 2);
199 bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL();
205 bool BLI_listbase_move_index(ListBase *listbase, int from, int to) ATTR_NONNULL();
209 void BLI_freelist(struct ListBase *listbase) ATTR_NONNULL(1);
215 int BLI_listbase_count_at_most(const struct ListBase *listbase,
216  int count_max) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
224 void BLI_freelinkN(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
225 
229 void BLI_listbase_swaplinks(struct ListBase *listbase, void *vlinka, void *vlinkb)
230  ATTR_NONNULL(1, 2);
235 void BLI_listbases_swaplinks(struct ListBase *listbasea,
236  struct ListBase *listbaseb,
237  void *vlinka,
238  void *vlinkb) ATTR_NONNULL(2, 3);
239 
243 void BLI_movelisttolist(struct ListBase *dst, struct ListBase *src) ATTR_NONNULL(1, 2);
251 void BLI_duplicatelist(struct ListBase *dst, const struct ListBase *src) ATTR_NONNULL(1, 2);
252 void BLI_listbase_reverse(struct ListBase *lb) ATTR_NONNULL(1);
256 void BLI_listbase_rotate_first(struct ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
260 void BLI_listbase_rotate_last(struct ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
261 
266 {
267  return (lb->first && lb->first == lb->last);
268 }
270 {
271  return (lb->first == (void *)0);
272 }
274 {
275  lb->first = lb->last = (void *)0;
276 }
277 
284 BLI_INLINE bool BLI_listbase_equal(const struct ListBase *a, const struct ListBase *b)
285 {
286  if (a == NULL) {
287  return b == NULL;
288  }
289  if (b == NULL) {
290  return false;
291  }
292  return a->first == b->first && a->last == b->last;
293 }
294 
298 struct LinkData *BLI_genericNodeN(void *data);
299 
314 #define LISTBASE_CIRCULAR_FORWARD_BEGIN(lb, lb_iter, lb_init) \
315  if ((lb)->first && (lb_init || (lb_init = (lb)->first))) { \
316  lb_iter = lb_init; \
317  do {
318 #define LISTBASE_CIRCULAR_FORWARD_END(lb, lb_iter, lb_init) \
319  } \
320  while ((lb_iter = (lb_iter)->next ? (lb_iter)->next : (lb)->first), (lb_iter != lb_init)) \
321  ; \
322  } \
323  ((void)0)
324 
325 #define LISTBASE_CIRCULAR_BACKWARD_BEGIN(lb, lb_iter, lb_init) \
326  if ((lb)->last && (lb_init || (lb_init = (lb)->last))) { \
327  lb_iter = lb_init; \
328  do {
329 #define LISTBASE_CIRCULAR_BACKWARD_END(lb, lb_iter, lb_init) \
330  } \
331  while ((lb_iter = (lb_iter)->prev ? (lb_iter)->prev : (lb)->last), (lb_iter != lb_init)) \
332  ; \
333  } \
334  ((void)0)
335 
336 #define LISTBASE_FOREACH(type, var, list) \
337  for (type var = (type)((list)->first); var != NULL; var = (type)(((Link *)(var))->next))
338 
344 #define LISTBASE_FOREACH_INDEX(type, var, list, index_var) \
345  for (type var = (((void)(index_var = 0)), (type)((list)->first)); var != NULL; \
346  var = (type)(((Link *)(var))->next), index_var++)
347 
348 #define LISTBASE_FOREACH_BACKWARD(type, var, list) \
349  for (type var = (type)((list)->last); var != NULL; var = (type)(((Link *)(var))->prev))
350 
354 #define LISTBASE_FOREACH_MUTABLE(type, var, list) \
355  for (type var = (type)((list)->first), *var##_iter_next; \
356  ((var != NULL) ? ((void)(var##_iter_next = (type)(((Link *)(var))->next)), 1) : 0); \
357  var = var##_iter_next)
358 
362 #define LISTBASE_FOREACH_BACKWARD_MUTABLE(type, var, list) \
363  for (type var = (type)((list)->last), *var##_iter_prev; \
364  ((var != NULL) ? ((void)(var##_iter_prev = (type)(((Link *)(var))->prev)), 1) : 0); \
365  var = var##_iter_prev)
366 
367 #ifdef __cplusplus
368 }
369 #endif
370 
371 #ifdef __cplusplus
372 BLI_INLINE bool operator==(const ListBase &a, const ListBase &b)
373 {
374  return BLI_listbase_equal(&a, &b);
375 }
376 #endif
#define ATTR_WARN_UNUSED_RESULT
#define ATTR_NONNULL(...)
#define BLI_INLINE
BLI_INLINE bool BLI_listbase_is_empty(const struct ListBase *lb)
Definition: BLI_listbase.h:269
void * BLI_pophead(ListBase *listbase) ATTR_NONNULL(1)
Definition: listbase.c:221
void BLI_addhead(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition: listbase.c:60
bool BLI_listbase_move_index(ListBase *listbase, int from, int to) ATTR_NONNULL()
Definition: listbase.c:436
void BLI_freelinkN(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition: listbase.c:239
void * BLI_findstring_ptr(const struct ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void void * BLI_listbase_string_or_index_find(const struct ListBase *listbase, const char *string, size_t string_offset, int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void BLI_insertlinkreplace(ListBase *listbase, void *vreplacelink, void *vnewlink) ATTR_NONNULL(1
void void void void void BLI_duplicatelist(struct ListBase *dst, const struct ListBase *src) ATTR_NONNULL(1
void void BLI_listbase_rotate_last(struct ListBase *lb, void *vlink) ATTR_NONNULL(1
BLI_INLINE void BLI_listbase_clear(struct ListBase *lb)
Definition: BLI_listbase.h:273
void * BLI_rfindlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
struct LinkData * BLI_genericNodeN(void *data)
Definition: listbase.c:842
void BLI_listbase_rotate_first(struct ListBase *lb, void *vlink) ATTR_NONNULL(1
void BLI_insertlinkafter(struct ListBase *listbase, void *vprevlink, void *vnewlink) ATTR_NONNULL(1)
Definition: listbase.c:301
void * BLI_listbase_bytes_rfind(const ListBase *listbase, const void *bytes, size_t bytes_size, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
void void void BLI_movelisttolist(struct ListBase *dst, struct ListBase *src) ATTR_NONNULL(1
void * BLI_findlinkfrom(struct Link *start, int number) ATTR_WARN_UNUSED_RESULT
Definition: listbase.c:534
bool BLI_remlink_safe(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition: listbase.c:123
int BLI_listbase_count_at_most(const struct ListBase *listbase, int count_max) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
BLI_INLINE bool BLI_listbase_equal(const struct ListBase *a, const struct ListBase *b)
Definition: BLI_listbase.h:284
void * BLI_listbase_bytes_find(const ListBase *listbase, const void *bytes, size_t bytes_size, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
void void BLI_freelistN(struct ListBase *listbase) ATTR_NONNULL(1)
Definition: listbase.c:466
void void BLI_INLINE bool BLI_listbase_is_single(const struct ListBase *lb)
Definition: BLI_listbase.h:265
void void BLI_listbase_sort(struct ListBase *listbase, int(*cmp)(const void *, const void *)) ATTR_NONNULL(1
void BLI_addtail(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition: listbase.c:80
void BLI_remlink(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition: listbase.c:100
void * BLI_poptail(ListBase *listbase) ATTR_NONNULL(1)
Definition: listbase.c:230
void void void bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL()
Definition: listbase.c:405
int BLI_findindex(const struct ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void void BLI_listbases_swaplinks(struct ListBase *listbasea, struct ListBase *listbaseb, void *vlinka, void *vlinkb) ATTR_NONNULL(2
void BLI_insertlinkbefore(struct ListBase *listbase, void *vnextlink, void *vnewlink) ATTR_NONNULL(1)
Definition: listbase.c:340
void void void void BLI_movelisttolist_reverse(struct ListBase *dst, struct ListBase *src) ATTR_NONNULL(1
int BLI_findstringindex(const struct ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void * BLI_findlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void void void void void void BLI_listbase_reverse(struct ListBase *lb) ATTR_NONNULL(1)
Definition: listbase.c:797
ListBase BLI_listbase_from_link(struct Link *some_link)
Definition: listbase.c:761
void * BLI_findstring(const struct ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void * BLI_rfindstring_ptr(const struct ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void BLI_freelist(struct ListBase *listbase) ATTR_NONNULL(1)
Definition: listbase.c:452
void void void BLI_listbase_sort_r(ListBase *listbase, int(*cmp)(void *, const void *, const void *), void *thunk) ATTR_NONNULL(1
void * BLI_rfindstring(const struct ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
int BLI_listbase_count(const struct ListBase *listbase) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void * BLI_rfindptr(const struct ListBase *listbase, const void *ptr, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void * BLI_findptr(const struct ListBase *listbase, const void *ptr, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
void BLI_listbase_swaplinks(struct ListBase *listbase, void *vlinka, void *vlinkb) ATTR_NONNULL(1
These structs are the foundation for all linked lists in the library system.
StackEntry * from
SyclQueue void void * src
ccl_gpu_kernel_postfix ccl_global float int int int int float bool int offset
static unsigned a[3]
Definition: RandGen.cpp:78
bool operator==(const AttributeIDRef &a, const AttributeIDRef &b)
static const pxr::TfToken b("b", pxr::TfToken::Immortal)
void * last
Definition: DNA_listBase.h:31
void * first
Definition: DNA_listBase.h:31
PointerRNA * ptr
Definition: wm_files.c:3480