BLI_listbase.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include <cstddef>
 
#include "BLI_compiler_attrs.h"
#include "BLI_compiler_compat.h"
 
#include "DNA_listBase.h"

int BLI_findindex(const ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1);
int BLI_findstringindex(const ListBase *listbase,
                        const char *id,
                        int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);

ListBase BLI_listbase_from_link(Link *some_link);
 
/* Find forwards. */

void *BLI_findlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);

void *BLI_findlinkfrom(Link *start, int step) ATTR_WARN_UNUSED_RESULT;

void *BLI_findstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1);
void *BLI_listbase_findafter_string(Link *link, const char *id, int offset) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1);
void *BLI_findstring_ptr(const ListBase *listbase,
                         const char *id,
                         int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
void *BLI_listbase_findafter_string_ptr(Link *link, const char *id, int offset);

void *BLI_findptr(const struct ListBase *listbase,
                  const void *ptr,
                  int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
void *BLI_listbase_bytes_find(const ListBase *listbase,
                              const void *bytes,
                              size_t bytes_size,
                              int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
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);
 
/* Find backwards. */

void *BLI_rfindlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
void *BLI_rfindstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1);
void *BLI_rfindstring_ptr(const ListBase *listbase,
                          const char *id,
                          int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
void *BLI_rfindptr(const ListBase *listbase, const void *ptr, int offset) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1);
void *BLI_listbase_bytes_rfind(const ListBase *listbase,
                               const void *bytes,
                               size_t bytes_size,
                               int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);

void BLI_freelistN(ListBase *listbase) ATTR_NONNULL(1);
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
bool BLI_remlink_safe(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
void *BLI_pophead(ListBase *listbase) ATTR_NONNULL(1);
void *BLI_poptail(ListBase *listbase) ATTR_NONNULL(1);

void BLI_addhead(ListBase *listbase, void *vlink) ATTR_NONNULL(1);
void BLI_insertlinkbefore(ListBase *listbase, void *vnextlink, void *vnewlink) ATTR_NONNULL(1);
void BLI_insertlinkafter(ListBase *listbase, void *vprevlink, void *vnewlink) ATTR_NONNULL(1);
void BLI_insertlinkreplace(ListBase *listbase, void *vreplacelink, void *vnewlink)
    ATTR_NONNULL(1, 2, 3);
void BLI_listbase_sort(ListBase *listbase, int (*cmp)(const void *, const void *))
    ATTR_NONNULL(1, 2);
void BLI_listbase_sort_r(ListBase *listbase,
                         int (*cmp)(void *, const void *, const void *),
                         void *thunk) ATTR_NONNULL(1, 2);
bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL();
bool BLI_listbase_move_index(ListBase *listbase, int from, int to) ATTR_NONNULL();
void BLI_freelist(ListBase *listbase) ATTR_NONNULL(1);
int BLI_listbase_count_at_most(const ListBase *listbase, int count_max) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1);
BLI_INLINE bool BLI_listbase_count_is_equal_to(const ListBase *listbase, const int count_cmp)
{
  return BLI_listbase_count_at_most(listbase, count_cmp + 1) == count_cmp;
}

int BLI_listbase_count(const ListBase *listbase) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
void BLI_freelinkN(ListBase *listbase, void *vlink) ATTR_NONNULL(1);

void BLI_listbase_swaplinks(ListBase *listbase, void *vlinka, void *vlinkb) ATTR_NONNULL(1, 2);
void BLI_listbases_swaplinks(ListBase *listbasea, ListBase *listbaseb, void *vlinka, void *vlinkb)
    ATTR_NONNULL(2, 3);

void BLI_movelisttolist(ListBase *dst, ListBase *src) ATTR_NONNULL(1, 2);
void BLI_movelisttolist_reverse(ListBase *dst, ListBase *src) ATTR_NONNULL(1, 2);
void BLI_listbase_split_after(ListBase *original_listbase, ListBase *split_listbase, void *vlink)
    ATTR_NONNULL(1, 2);
void BLI_duplicatelist(ListBase *dst, const ListBase *src) ATTR_NONNULL(1, 2);
void BLI_listbase_reverse(ListBase *lb) ATTR_NONNULL(1);
void BLI_listbase_rotate_first(ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
void BLI_listbase_rotate_last(ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);

BLI_INLINE bool BLI_listbase_is_single(const ListBase *lb)
{
  return (lb->first && lb->first == lb->last);
}
BLI_INLINE bool BLI_listbase_is_empty(const ListBase *lb)
{
  return (lb->first == (void *)nullptr);
}
BLI_INLINE void BLI_listbase_clear(ListBase *lb)
{
  lb->first = lb->last = (void *)nullptr;
}

bool BLI_listbase_validate(ListBase *lb);

BLI_INLINE bool BLI_listbase_equal(const ListBase *a, const ListBase *b)
{
  if (a == nullptr) {
    return b == nullptr;
  }
  if (b == nullptr) {
    return false;
  }
  return a->first == b->first && a->last == b->last;
}

LinkData *BLI_genericNodeN(void *data);

#define LISTBASE_CIRCULAR_FORWARD_BEGIN(type, lb, lb_iter, lb_init) \
  if ((lb)->first && (lb_init || (lb_init = (type)(lb)->first))) { \
    lb_iter = (type)(lb_init); \
    do {
#define LISTBASE_CIRCULAR_FORWARD_END(type, lb, lb_iter, lb_init) \
  } \
  while ((lb_iter = (lb_iter)->next ? (type)(lb_iter)->next : (type)(lb)->first), \
         (lb_iter != lb_init)) \
    ; \
  } \
  ((void)0)
 
#define LISTBASE_CIRCULAR_BACKWARD_BEGIN(type, lb, lb_iter, lb_init) \
  if ((lb)->last && (lb_init || (lb_init = (type)(lb)->last))) { \
    lb_iter = lb_init; \
    do {
#define LISTBASE_CIRCULAR_BACKWARD_END(type, lb, lb_iter, lb_init) \
  } \
  while ((lb_iter = (lb_iter)->prev ? (lb_iter)->prev : (type)(lb)->last), (lb_iter != lb_init)) \
    ; \
  } \
  ((void)0)
 
#define LISTBASE_FOREACH(type, var, list) \
  for (type var = (type)((list)->first); var != nullptr; var = (type)(((Link *)(var))->next))

#define LISTBASE_FOREACH_INDEX(type, var, list, index_var) \
  for (type var = (((void)(index_var = 0)), (type)((list)->first)); var != nullptr; \
       var = (type)(((Link *)(var))->next), index_var++)
 
#define LISTBASE_FOREACH_BACKWARD(type, var, list) \
  for (type var = (type)((list)->last); var != nullptr; var = (type)(((Link *)(var))->prev))

#define LISTBASE_FOREACH_MUTABLE(type, var, list) \
  for (type var = (type)((list)->first), *var##_iter_next; \
       ((var != nullptr) ? ((void)(var##_iter_next = (type)(((Link *)(var))->next)), 1) : 0); \
       var = var##_iter_next)

#define LISTBASE_FOREACH_BACKWARD_MUTABLE(type, var, list) \
  for (type var = (type)((list)->last), *var##_iter_prev; \
       ((var != nullptr) ? ((void)(var##_iter_prev = (type)(((Link *)(var))->prev)), 1) : 0); \
       var = var##_iter_prev)
 
BLI_INLINE bool operator==(const ListBase &a, const ListBase &b)
{
  return BLI_listbase_equal(&a, &b);
}
BLI_INLINE bool operator!=(const ListBase &a, const ListBase &b)
{
  return !(a == b);
}
 
template<typename T, typename Fn> T *BLI_listbase_find(const ListBase &listbase, Fn &&predicate)
{
  LISTBASE_FOREACH (T *, link, &listbase) {
    const T &value = *static_cast<const T *>(link);
    if (predicate(value)) {
      return link;
    }
  }
  return nullptr;
}