fix [#36923] Merge / Delete vertices crashes for some meshes
[blender.git] / source / blender / bmesh / intern / bmesh_iterators.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  * Contributor(s): Joseph Eagar.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BMESH_ITERATORS_H__
24 #define __BMESH_ITERATORS_H__
25
26 /** \file blender/bmesh/intern/bmesh_iterators.h
27  *  \ingroup bmesh
28  */
29
30 /**
31  * \brief BMesh Iterators
32  *
33  * The functions and structures in this file
34  * provide a unified method for iterating over
35  * the elements of a mesh and answering simple
36  * adjacency queries. Tool authors should use
37  * the iterators provided in this file instead
38  * of inspecting the structure directly.
39  *
40  */
41
42 #include "BLI_compiler_attrs.h"
43 #include "BLI_mempool.h"
44
45 /* Defines for passing to BM_iter_new.
46  *
47  * "OF" can be substituted for "around"
48  * so BM_VERTS_OF_FACE means "vertices
49  * around a face."
50  */
51
52 /* these iterator over all elements of a specific
53  * type in the mesh.
54  *
55  * be sure to keep 'bm_iter_itype_htype_map' in sync with any changes
56  */
57 typedef enum BMIterType {
58         BM_VERTS_OF_MESH = 1,
59         BM_EDGES_OF_MESH = 2,
60         BM_FACES_OF_MESH = 3,
61         /* these are topological iterators. */
62         BM_EDGES_OF_VERT = 4,
63         BM_FACES_OF_VERT = 5,
64         BM_LOOPS_OF_VERT = 6,
65         BM_VERTS_OF_EDGE = 7, /* just v1, v2: added so py can use generalized sequencer wrapper */
66         BM_FACES_OF_EDGE = 8,
67         BM_VERTS_OF_FACE = 9,
68         BM_EDGES_OF_FACE = 10,
69         BM_LOOPS_OF_FACE = 11,
70         /* returns elements from all boundaries, and returns
71          * the first element at the end to flag that we're entering
72          * a different face hole boundary*/
73         BM_ALL_LOOPS_OF_FACE = 12,
74         /* iterate through loops around this loop, which are fetched
75          * from the other faces in the radial cycle surrounding the
76          * input loop's edge.*/
77         BM_LOOPS_OF_LOOP = 13,
78         BM_LOOPS_OF_EDGE = 14
79 } BMIterType;
80
81 #define BM_ITYPE_MAX 15
82
83 /* the iterator htype for each iterator */
84 extern const char bm_iter_itype_htype_map[BM_ITYPE_MAX];
85
86 #define BM_ITER_MESH(ele, iter, bm, itype) \
87         for (ele = BM_iter_new(iter, bm, itype, NULL); ele; ele = BM_iter_step(iter))
88
89 #define BM_ITER_MESH_INDEX(ele, iter, bm, itype, indexvar) \
90         for (ele = BM_iter_new(iter, bm, itype, NULL), indexvar = 0; ele; ele = BM_iter_step(iter), (indexvar)++)
91
92 /* a version of BM_ITER_MESH which keeps the next item in storage
93  * so we can delete the current item, see bug [#36923] */
94 #ifdef DEBUG
95 #  define BM_ITER_MESH_MUTABLE(ele, ele_next, iter, bm, itype) \
96         for (ele = BM_iter_new(iter, bm, itype, NULL); \
97         ele ? ((void)((iter)->count = BM_iter_mesh_count(bm, itype)), \
98                (void)(ele_next = BM_iter_step(iter)), 1) : 0; \
99         ele = ele_next)
100 #else
101 #  define BM_ITER_MESH_MUTABLE(ele, ele_next, iter, bm, itype) \
102         for (ele = BM_iter_new(iter, bm, itype, NULL); ele ? ((ele_next = BM_iter_step(iter)), 1) : 0; ele = ele_next)
103 #endif
104
105
106 #define BM_ITER_ELEM(ele, iter, data, itype) \
107         for (ele = BM_iter_new(iter, NULL, itype, data); ele; ele = BM_iter_step(iter))
108
109 #define BM_ITER_ELEM_INDEX(ele, iter, data, itype, indexvar) \
110         for (ele = BM_iter_new(iter, NULL, itype, data), indexvar = 0; ele; ele = BM_iter_step(iter), (indexvar)++)
111
112 /* iterator type structs */
113 struct BMIter__vert_of_mesh {
114         BMesh *bm;
115         BLI_mempool_iter pooliter;
116 };
117 struct BMIter__edge_of_mesh {
118         BMesh *bm;
119         BLI_mempool_iter pooliter;
120 };
121 struct BMIter__face_of_mesh {
122         BMesh *bm;
123         BLI_mempool_iter pooliter;
124 };
125 struct BMIter__edge_of_vert {
126         BMVert *vdata;
127         BMEdge *e_first, *e_next;
128 };
129 struct BMIter__face_of_vert {
130         BMVert *vdata;
131         BMLoop *l_first, *l_next;
132         BMEdge *e_first, *e_next;
133 };
134 struct BMIter__loop_of_vert {
135         BMVert *vdata;
136         BMLoop *l_first, *l_next;
137         BMEdge *e_first, *e_next;
138 };
139 struct BMIter__loop_of_edge {
140         BMEdge *edata;
141         BMLoop *l_first, *l_next;
142 };
143 struct BMIter__loop_of_loop {
144         BMLoop *ldata;
145         BMLoop *l_first, *l_next;
146 };
147 struct BMIter__face_of_edge {
148         BMEdge *edata;
149         BMLoop *l_first, *l_next;
150 };
151 struct BMIter__vert_of_edge {
152         BMEdge *edata;
153 };
154 struct BMIter__vert_of_face {
155         BMFace *pdata;
156         BMLoop *l_first, *l_next;
157 };
158 struct BMIter__edge_of_face {
159         BMFace *pdata;
160         BMLoop *l_first, *l_next;
161 };
162 struct BMIter__loop_of_face {
163         BMFace *pdata;
164         BMLoop *l_first, *l_next;
165 };
166
167 typedef void  (*BMIter__begin_cb) (void *);
168 typedef void *(*BMIter__step_cb) (void *);
169
170 /* Iterator Structure */
171 /* note: some of these vars are not used,
172  * so they have been commented to save stack space since this struct is used all over */
173 typedef struct BMIter {
174         /* keep union first */
175         union {
176                 struct BMIter__vert_of_mesh vert_of_mesh;
177                 struct BMIter__edge_of_mesh edge_of_mesh;
178                 struct BMIter__face_of_mesh face_of_mesh;
179
180                 struct BMIter__edge_of_vert edge_of_vert;
181                 struct BMIter__face_of_vert face_of_vert;
182                 struct BMIter__loop_of_vert loop_of_vert;
183                 struct BMIter__loop_of_edge loop_of_edge;
184                 struct BMIter__loop_of_loop loop_of_loop;
185                 struct BMIter__face_of_edge face_of_edge;
186                 struct BMIter__vert_of_edge vert_of_edge;
187                 struct BMIter__vert_of_face vert_of_face;
188                 struct BMIter__edge_of_face edge_of_face;
189                 struct BMIter__loop_of_face loop_of_face;
190         } data;
191
192         BMIter__begin_cb begin;
193         BMIter__step_cb step;
194
195         int count;  /* note, only some iterators set this, don't rely on it */
196         char itype;
197 } BMIter;
198
199 int     BM_iter_mesh_count(BMesh *bm, const char itype);
200 void   *BM_iter_at_index(BMesh *bm, const char itype, void *data, int index) ATTR_WARN_UNUSED_RESULT;
201 int     BM_iter_as_array(BMesh *bm, const char itype, void *data, void **array, const int len);
202 void   *BM_iter_as_arrayN(BMesh *bm, const char itype, void *data, int *r_len,
203                           void **stack_array, int stack_array_size) ATTR_WARN_UNUSED_RESULT;
204 int     BMO_iter_as_array(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask,
205                           void **array, const int len);
206 void    *BMO_iter_as_arrayN(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask,
207                             int *r_len,
208                             /* optional args to avoid an alloc (normally stack array) */
209                             void **stack_array, int stack_array_size);
210
211 int     BM_iter_elem_count_flag(const char itype, void *data, const char hflag, const bool value);
212 int     BMO_iter_elem_count_flag(BMesh *bm, const char itype, void *data, const short oflag, const bool value);
213 int     BM_iter_mesh_count_flag(const char itype, BMesh *bm, const char hflag, const bool value);
214
215 /* private for bmesh_iterators_inline.c */
216
217 #define BMITER_CB_DEF(name) \
218         struct BMIter__##name; \
219         void  bmiter__##name##_begin(struct BMIter__##name *iter); \
220         void *bmiter__##name##_step(struct BMIter__##name *iter)
221
222 BMITER_CB_DEF(vert_of_mesh);
223 BMITER_CB_DEF(edge_of_mesh);
224 BMITER_CB_DEF(face_of_mesh);
225 BMITER_CB_DEF(edge_of_vert);
226 BMITER_CB_DEF(face_of_vert);
227 BMITER_CB_DEF(loop_of_vert);
228 BMITER_CB_DEF(loop_of_edge);
229 BMITER_CB_DEF(loop_of_loop);
230 BMITER_CB_DEF(face_of_edge);
231 BMITER_CB_DEF(vert_of_edge);
232 BMITER_CB_DEF(vert_of_face);
233 BMITER_CB_DEF(edge_of_face);
234 BMITER_CB_DEF(loop_of_face);
235
236 #undef BMITER_CB_DEF
237
238 #include "intern/bmesh_iterators_inline.h"
239
240 #endif /* __BMESH_ITERATORS_H__ */