doxygen: add newline after \file
[blender.git] / source / blender / blenlib / BLI_listbase.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_LISTBASE_H__
21 #define __BLI_LISTBASE_H__
22
23 /** \file
24  * \ingroup bli
25  */
26
27 #include "BLI_compiler_attrs.h"
28 #include "BLI_utildefines.h"
29 #include "DNA_listBase.h"
30 //struct ListBase;
31 //struct LinkData;
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 int BLI_findindex(const struct ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
38 int BLI_findstringindex(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
39
40 /* find forwards */
41 void *BLI_findlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
42 void *BLI_findstring(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
43 void *BLI_findstring_ptr(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
44 void *BLI_findptr(const struct ListBase *listbase, const void *ptr, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
45 void *BLI_listbase_bytes_find(const ListBase *listbase, const void *bytes, const size_t bytes_size, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
46
47 /* find backwards */
48 void *BLI_rfindlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
49 void *BLI_rfindstring(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
50 void *BLI_rfindstring_ptr(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
51 void *BLI_rfindptr(const struct ListBase *listbase, const void *ptr, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
52 void *BLI_listbase_bytes_rfind(const ListBase *listbase, const void *bytes, const size_t bytes_size, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
53
54 void BLI_freelistN(struct ListBase *listbase) ATTR_NONNULL(1);
55 void BLI_addtail(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
56 void BLI_remlink(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
57 bool BLI_remlink_safe(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
58 void *BLI_pophead(ListBase *listbase) ATTR_NONNULL(1);
59 void *BLI_poptail(ListBase *listbase) ATTR_NONNULL(1);
60
61 void BLI_addhead(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
62 void BLI_insertlinkbefore(struct ListBase *listbase, void *vnextlink, void *vnewlink) ATTR_NONNULL(1);
63 void BLI_insertlinkafter(struct ListBase *listbase, void *vprevlink, void *vnewlink) ATTR_NONNULL(1);
64 void BLI_insertlinkreplace(ListBase *listbase, void *v_l_src, void *v_l_dst) ATTR_NONNULL(1, 2, 3);
65 void BLI_listbase_sort(struct ListBase *listbase, int (*cmp)(const void *, const void *)) ATTR_NONNULL(1, 2);
66 void BLI_listbase_sort_r(ListBase *listbase, int (*cmp)(void *, const void *, const void *), void *thunk) ATTR_NONNULL(1, 2);
67 bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL();
68 void BLI_freelist(struct ListBase *listbase) ATTR_NONNULL(1);
69 int  BLI_listbase_count_at_most(const struct ListBase *listbase, const int count_max) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
70 int  BLI_listbase_count(const struct ListBase *listbase) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
71 void BLI_freelinkN(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
72
73 void BLI_listbase_swaplinks(struct ListBase *listbase, void *vlinka, void *vlinkb) ATTR_NONNULL(1, 2);
74 void BLI_listbases_swaplinks(struct ListBase *listbasea, struct ListBase *listbaseb, void *vlinka, void *vlinkb) ATTR_NONNULL(2, 3);
75
76 void BLI_movelisttolist(struct ListBase *dst, struct ListBase *src) ATTR_NONNULL(1, 2);
77 void BLI_movelisttolist_reverse(struct ListBase *dst, struct ListBase *src) ATTR_NONNULL(1, 2);
78 void BLI_duplicatelist(struct ListBase *dst, const struct ListBase *src) ATTR_NONNULL(1, 2);
79 void BLI_listbase_reverse(struct ListBase *lb) ATTR_NONNULL(1);
80 void BLI_listbase_rotate_first(struct ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
81 void BLI_listbase_rotate_last(struct ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
82
83 /**
84  * Utility functions to avoid first/last references inline all over.
85  */
86 BLI_INLINE bool BLI_listbase_is_single(const struct ListBase *lb) { return (lb->first && lb->first == lb->last); }
87 BLI_INLINE bool BLI_listbase_is_empty(const struct ListBase *lb) { return (lb->first == (void *)0); }
88 BLI_INLINE void BLI_listbase_clear(struct ListBase *lb) { lb->first = lb->last = (void *)0; }
89
90 /* create a generic list node containing link to provided data */
91 struct LinkData *BLI_genericNodeN(void *data);
92
93 /**
94  * Does a full loop on the list, with any value acting as first
95  * (handy for cycling items)
96  *
97  * \code{.c}
98  *
99  * LISTBASE_CIRCULAR_FORWARD_BEGIN(listbase, item, item_init)
100  * {
101  *     ...operate on marker...
102  * }
103  * LISTBASE_CIRCULAR_FORWARD_END (listbase, item, item_init);
104  *
105  * \endcode
106  */
107 #define LISTBASE_CIRCULAR_FORWARD_BEGIN(lb, lb_iter, lb_init) \
108 if ((lb)->first && (lb_init || (lb_init = (lb)->first))) { \
109         lb_iter = lb_init; \
110         do {
111 #define LISTBASE_CIRCULAR_FORWARD_END(lb, lb_iter, lb_init) \
112         } while ((lb_iter  = (lb_iter)->next ? (lb_iter)->next : (lb)->first), \
113                  (lb_iter != lb_init)); \
114 }
115
116 #define LISTBASE_CIRCULAR_BACKWARD_BEGIN(lb, lb_iter, lb_init) \
117 if ((lb)->last && (lb_init || (lb_init = (lb)->last))) { \
118         lb_iter = lb_init; \
119         do {
120 #define LISTBASE_CIRCULAR_BACKWARD_END(lb, lb_iter, lb_init) \
121         } while ((lb_iter  = (lb_iter)->prev ? (lb_iter)->prev : (lb)->last), \
122                  (lb_iter != lb_init)); \
123 }
124
125 #define LISTBASE_FOREACH(type, var, list) \
126         for (type var = (type)((list)->first); \
127              var != NULL; \
128              var = (type)(((Link*)(var))->next))
129
130 #ifdef __cplusplus
131 }
132 #endif
133
134 #endif  /* __BLI_LISTBASE_H__ */