Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenlib / BLI_listbase.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BLI_LISTBASE_H__
29 #define __BLI_LISTBASE_H__
30
31 /** \file BLI_listbase.h
32  *  \ingroup bli
33  */
34
35 #include "BLI_compiler_attrs.h"
36 #include "BLI_utildefines.h"
37 #include "DNA_listBase.h"
38 //struct ListBase;
39 //struct LinkData;
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 int BLI_findindex(const struct ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
46 int BLI_findstringindex(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
47
48 /* find forwards */
49 void *BLI_findlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
50 void *BLI_findstring(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
51 void *BLI_findstring_ptr(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
52 void *BLI_findptr(const struct ListBase *listbase, const void *ptr, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
53
54 /* find backwards */
55 void *BLI_rfindlink(const struct ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
56 void *BLI_rfindstring(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
57 void *BLI_rfindstring_ptr(const struct ListBase *listbase, const char *id, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
58 void *BLI_rfindptr(const struct ListBase *listbase, const void *ptr, const int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
59
60 void BLI_freelistN(struct ListBase *listbase) ATTR_NONNULL(1);
61 void BLI_addtail(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
62 void BLI_remlink(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
63 bool BLI_remlink_safe(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
64 void *BLI_pophead(ListBase *listbase) ATTR_NONNULL(1);
65 void *BLI_poptail(ListBase *listbase) ATTR_NONNULL(1);
66
67 void BLI_addhead(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
68 void BLI_insertlinkbefore(struct ListBase *listbase, void *vnextlink, void *vnewlink) ATTR_NONNULL(1);
69 void BLI_insertlinkafter(struct ListBase *listbase, void *vprevlink, void *vnewlink) ATTR_NONNULL(1);
70 void BLI_insertlinkreplace(ListBase *listbase, void *v_l_src, void *v_l_dst) ATTR_NONNULL(1, 2, 3);
71 void BLI_listbase_sort(struct ListBase *listbase, int (*cmp)(const void *, const void *)) ATTR_NONNULL(1, 2);
72 void BLI_listbase_sort_r(ListBase *listbase, int (*cmp)(void *, const void *, const void *), void *thunk) ATTR_NONNULL(1, 2);
73 bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL();
74 void BLI_freelist(struct ListBase *listbase) ATTR_NONNULL(1);
75 int  BLI_listbase_count_ex(const struct ListBase *listbase, const int count_max) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
76 int  BLI_listbase_count(const struct ListBase *listbase) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
77 void BLI_freelinkN(struct ListBase *listbase, void *vlink) ATTR_NONNULL(1);
78
79 void BLI_listbase_swaplinks(struct ListBase *listbase, void *vlinka, void *vlinkb) ATTR_NONNULL(1, 2);
80 void BLI_listbases_swaplinks(struct ListBase *listbasea, struct ListBase *listbaseb, void *vlinka, void *vlinkb) ATTR_NONNULL(2, 3);
81
82 void BLI_movelisttolist(struct ListBase *dst, struct ListBase *src) ATTR_NONNULL(1, 2);
83 void BLI_duplicatelist(struct ListBase *dst, const struct ListBase *src) ATTR_NONNULL(1, 2);
84 void BLI_listbase_reverse(struct ListBase *lb) ATTR_NONNULL(1);
85 void BLI_listbase_rotate_first(struct ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
86 void BLI_listbase_rotate_last(struct ListBase *lb, void *vlink) ATTR_NONNULL(1, 2);
87
88 /**
89  * Utility functions to avoid first/last references inline all over.
90  */
91 BLI_INLINE bool BLI_listbase_is_single(const struct ListBase *lb) { return (lb->first && lb->first == lb->last); }
92 BLI_INLINE bool BLI_listbase_is_empty(const struct ListBase *lb) { return (lb->first == (void *)0); }
93 BLI_INLINE void BLI_listbase_clear(struct ListBase *lb) { lb->first = lb->last = (void *)0; }
94
95 /* create a generic list node containing link to provided data */
96 struct LinkData *BLI_genericNodeN(void *data);
97
98 /**
99  * Does a full loop on the list, with any value acting as first
100  * (handy for cycling items)
101  *
102  * \code{.c}
103  *
104  * BLI_LISTBASE_CIRCULAR_FORWARD_BEGIN (listbase, item, item_init) {
105  *     ...operate on marker...
106  * }
107  * BLI_LISTBASE_CIRCULAR_FORWARD_END (listbase, item, item_init);
108  *
109  * \endcode
110  */
111 #define BLI_LISTBASE_CIRCULAR_FORWARD_BEGIN(lb, lb_iter, lb_init) \
112 if ((lb)->first && (lb_init || (lb_init = (lb)->first))) { \
113         lb_iter = lb_init; \
114         do {
115 #define BLI_LISTBASE_CIRCULAR_FORWARD_END(lb, lb_iter, lb_init) \
116         } while ((lb_iter  = (lb_iter)->next ? (lb_iter)->next : (lb)->first), \
117                  (lb_iter != lb_init)); \
118 }
119
120 #define BLI_LISTBASE_CIRCULAR_BACKWARD_BEGIN(lb, lb_iter, lb_init) \
121 if ((lb)->last && (lb_init || (lb_init = (lb)->last))) { \
122         lb_iter = lb_init; \
123         do {
124 #define BLI_LISTBASE_CIRCULAR_BACKWARD_END(lb, lb_iter, lb_init) \
125         } while ((lb_iter  = (lb_iter)->prev ? (lb_iter)->prev : (lb)->last), \
126                  (lb_iter != lb_init)); \
127 }
128
129 #ifdef __cplusplus
130 }
131 #endif
132
133 #endif  /* __BLI_LISTBASE_H__ */