doxygen: add newline after \file
[blender.git] / source / blender / bmesh / intern / bmesh_operator_api_inline.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
17 /** \file
18  * \ingroup bmesh
19  *
20  * BMesh inline operator functions.
21  */
22
23 #ifndef __BMESH_OPERATOR_API_INLINE_H__
24 #define __BMESH_OPERATOR_API_INLINE_H__
25
26 /* tool flag API. never, ever ever should tool code put junk in
27  * header flags (element->head.flag), nor should they use
28  * element->head.eflag1/eflag2.  instead, use this api to set
29  * flags.
30  *
31  * if you need to store a value per element, use a
32  * ghash or a mapping slot to do it. */
33
34 /* flags 15 and 16 (1 << 14 and 1 << 15) are reserved for bmesh api use */
35 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2)
36 BLI_INLINE short _bmo_elem_flag_test(BMesh *bm, const BMFlagLayer *oflags, const short oflag)
37 {
38         BLI_assert(bm->use_toolflags);
39         return oflags[bm->toolflag_index].f & oflag;
40 }
41
42 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2)
43 BLI_INLINE bool _bmo_elem_flag_test_bool(BMesh *bm, const BMFlagLayer *oflags, const short oflag)
44 {
45         BLI_assert(bm->use_toolflags);
46         return (oflags[bm->toolflag_index].f & oflag) != 0;
47 }
48
49 ATTR_NONNULL(1, 2)
50 BLI_INLINE void _bmo_elem_flag_enable(BMesh *bm, BMFlagLayer *oflags, const short oflag)
51 {
52         BLI_assert(bm->use_toolflags);
53         oflags[bm->toolflag_index].f |= oflag;
54 }
55
56 ATTR_NONNULL(1, 2)
57 BLI_INLINE void _bmo_elem_flag_disable(BMesh *bm, BMFlagLayer *oflags, const short oflag)
58 {
59         BLI_assert(bm->use_toolflags);
60         oflags[bm->toolflag_index].f &= (short)~oflag;
61 }
62
63 ATTR_NONNULL(1, 2)
64 BLI_INLINE void _bmo_elem_flag_set(BMesh *bm, BMFlagLayer *oflags, const short oflag, int val)
65 {
66         BLI_assert(bm->use_toolflags);
67         if (val) oflags[bm->toolflag_index].f |= oflag;
68         else     oflags[bm->toolflag_index].f &= (short)~oflag;
69 }
70
71 ATTR_NONNULL(1, 2)
72 BLI_INLINE void _bmo_elem_flag_toggle(BMesh *bm, BMFlagLayer *oflags, const short oflag)
73 {
74         BLI_assert(bm->use_toolflags);
75         oflags[bm->toolflag_index].f ^= oflag;
76 }
77
78 ATTR_NONNULL(1, 2)
79 BLI_INLINE void BMO_slot_map_int_insert(
80         BMOperator *op, BMOpSlot *slot,
81         void *element, const int val)
82 {
83         union { void *ptr; int val; } t = {NULL};
84         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INT);
85         BMO_slot_map_insert(op, slot, element, ((void)(t.val = val), t.ptr));
86 }
87
88 ATTR_NONNULL(1, 2)
89 BLI_INLINE void BMO_slot_map_bool_insert(
90         BMOperator *op, BMOpSlot *slot,
91         void *element, const bool val)
92 {
93         union { void *ptr; bool val; } t = {NULL};
94         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_BOOL);
95         BMO_slot_map_insert(op, slot, element, ((void)(t.val = val), t.ptr));
96 }
97
98 ATTR_NONNULL(1, 2)
99 BLI_INLINE void BMO_slot_map_float_insert(
100         BMOperator *op, BMOpSlot *slot,
101         void *element, const float val)
102 {
103         union { void *ptr; float val; } t = {NULL};
104         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_FLT);
105         BMO_slot_map_insert(op, slot, element, ((void)(t.val = val), t.ptr));
106 }
107
108
109 /* pointer versions of BMO_slot_map_float_get and BMO_slot_map_float_insert.
110  *
111  * do NOT use these for non-operator-api-allocated memory! instead
112  * use BMO_slot_map_data_get and BMO_slot_map_insert, which copies the data. */
113
114 ATTR_NONNULL(1, 2)
115 BLI_INLINE void BMO_slot_map_ptr_insert(
116         BMOperator *op, BMOpSlot *slot,
117         const void *element, void *val)
118 {
119         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INTERNAL);
120         BMO_slot_map_insert(op, slot, element, val);
121 }
122
123 ATTR_NONNULL(1, 2)
124 BLI_INLINE void BMO_slot_map_elem_insert(
125         BMOperator *op, BMOpSlot *slot,
126         const void *element, void *val)
127 {
128         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_ELEM);
129         BMO_slot_map_insert(op, slot, element, val);
130 }
131
132
133 /* no values */
134 ATTR_NONNULL(1, 2)
135 BLI_INLINE void BMO_slot_map_empty_insert(
136         BMOperator *op, BMOpSlot *slot,
137         const void *element)
138 {
139         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_EMPTY);
140         BMO_slot_map_insert(op, slot, element, NULL);
141 }
142
143 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
144 BLI_INLINE bool BMO_slot_map_contains(BMOpSlot *slot, const void *element)
145 {
146         BLI_assert(slot->slot_type == BMO_OP_SLOT_MAPPING);
147         return BLI_ghash_haskey(slot->data.ghash, element);
148 }
149
150 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
151 BLI_INLINE void **BMO_slot_map_data_get(BMOpSlot *slot, const void *element)
152 {
153
154         return BLI_ghash_lookup_p(slot->data.ghash, element);
155 }
156
157 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
158 BLI_INLINE float BMO_slot_map_float_get(BMOpSlot *slot, const void *element)
159 {
160         void **data;
161         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_FLT);
162
163         data = BMO_slot_map_data_get(slot, element);
164         if (data) {
165                 return *(float *)data;
166         }
167         else {
168                 return 0.0f;
169         }
170 }
171
172 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
173 BLI_INLINE int BMO_slot_map_int_get(BMOpSlot *slot, const void *element)
174 {
175         void **data;
176         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INT);
177
178         data = BMO_slot_map_data_get(slot, element);
179         if (data) {
180                 return *(int *)data;
181         }
182         else {
183                 return 0;
184         }
185 }
186
187 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
188 BLI_INLINE bool BMO_slot_map_bool_get(BMOpSlot *slot, const void *element)
189 {
190         void **data;
191         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_BOOL);
192
193         data = BMO_slot_map_data_get(slot, element);
194         if (data) {
195                 return *(bool *)data;
196         }
197         else {
198                 return false;
199         }
200 }
201
202 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
203 BLI_INLINE void *BMO_slot_map_ptr_get(BMOpSlot *slot, const void *element)
204 {
205         void **val = BMO_slot_map_data_get(slot, element);
206         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INTERNAL);
207         if (val) return *val;
208
209         return NULL;
210 }
211
212 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
213 BLI_INLINE void *BMO_slot_map_elem_get(BMOpSlot *slot, const void *element)
214 {
215         void **val = (void **) BMO_slot_map_data_get(slot, element);
216         BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_ELEM);
217         if (val) return *val;
218
219         return NULL;
220 }
221
222 #endif /* __BMESH_OPERATOR_API_INLINE_H__ */