Bevel mod: cleanup flags and extra data.
[blender.git] / source / blender / python / intern / bpy_rna.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 pythonintern
19  */
20
21 #ifndef __BPY_RNA_H__
22 #define __BPY_RNA_H__
23
24 /* --- bpy build options --- */
25 #ifdef WITH_PYTHON_SAFETY
26
27 /* play it safe and keep optional for now, need to test further now this affects looping on 10000's of verts for eg. */
28 #define USE_WEAKREFS
29
30 /* method to invalidate removed py data, XXX, slow to remove objects, otherwise no overhead */
31 /* #define USE_PYRNA_INVALIDATE_GC */
32
33 /* different method */
34 #define USE_PYRNA_INVALIDATE_WEAKREF
35
36 /* support for inter references, currently only needed for corner case */
37 #define USE_PYRNA_STRUCT_REFERENCE
38
39 #else /* WITH_PYTHON_SAFETY */
40
41  /* default, no defines! */
42
43 #endif /* !WITH_PYTHON_SAFETY */
44
45
46 /* sanity checks on above defs */
47 #if defined(USE_PYRNA_INVALIDATE_WEAKREF) && !defined(USE_WEAKREFS)
48 #define USE_WEAKREFS
49 #endif
50
51 #if defined(USE_PYRNA_INVALIDATE_GC) && defined(USE_PYRNA_INVALIDATE_WEAKREF)
52 #error "Only 1 reference check method at a time!"
53 #endif
54
55 /* only used by operator introspection get_rna(), this is only used for doc gen
56  * so prefer the leak to the memory bloat for now. */
57 // #define PYRNA_FREE_SUPPORT
58
59 /* use real collection iterators rather than faking with a list
60  * this is needed so enums can be iterated over without crashing,
61  * since finishing the iteration frees temp allocated enums */
62 #define USE_PYRNA_ITER
63
64 /* --- end bpy build options --- */
65
66 struct ID;
67
68 extern PyTypeObject pyrna_struct_meta_idprop_Type;
69 extern PyTypeObject pyrna_struct_Type;
70 extern PyTypeObject pyrna_prop_Type;
71 extern PyTypeObject pyrna_prop_array_Type;
72 extern PyTypeObject pyrna_prop_collection_Type;
73 extern PyTypeObject pyrna_func_Type;
74
75 #define BPy_StructRNA_Check(v)                  (PyObject_TypeCheck(v, &pyrna_struct_Type))
76 #define BPy_StructRNA_CheckExact(v)             (Py_TYPE(v) == &pyrna_struct_Type)
77 #define BPy_PropertyRNA_Check(v)                (PyObject_TypeCheck(v, &pyrna_prop_Type))
78 #define BPy_PropertyRNA_CheckExact(v)   (Py_TYPE(v) == &pyrna_prop_Type)
79
80 #define PYRNA_STRUCT_CHECK_OBJ(obj) if (UNLIKELY(pyrna_struct_validity_check(obj) == -1)) { return NULL; } (void)0
81 #define PYRNA_STRUCT_CHECK_INT(obj) if (UNLIKELY(pyrna_struct_validity_check(obj) == -1)) { return -1;   } (void)0
82
83 #define PYRNA_PROP_CHECK_OBJ(obj) if (UNLIKELY(pyrna_prop_validity_check(obj) == -1)) { return NULL; } (void)0
84 #define PYRNA_PROP_CHECK_INT(obj) if (UNLIKELY(pyrna_prop_validity_check(obj) == -1)) { return -1;   } (void)0
85
86 #define PYRNA_STRUCT_IS_VALID(pysrna) (LIKELY(((BPy_StructRNA *)(pysrna))->ptr.type != NULL))
87 #define PYRNA_PROP_IS_VALID(pysrna)   (LIKELY(((BPy_PropertyRNA *)(pysrna))->ptr.type != NULL))
88
89 /* 'in_weakreflist' MUST be aligned */
90
91 typedef struct {
92         PyObject_HEAD /* required python macro   */
93 #ifdef USE_WEAKREFS
94         PyObject *in_weakreflist;
95 #endif
96         PointerRNA      ptr;
97 } BPy_DummyPointerRNA;
98
99 typedef struct {
100         PyObject_HEAD /* required python macro   */
101 #ifdef USE_WEAKREFS
102         PyObject *in_weakreflist;
103 #endif
104         PointerRNA ptr;
105 #ifdef USE_PYRNA_STRUCT_REFERENCE
106         /* generic PyObject we hold a reference to, example use:
107          * hold onto the collection iterator to prevent it from freeing allocated data we may use */
108         PyObject *reference;
109 #endif /* !USE_PYRNA_STRUCT_REFERENCE */
110
111 #ifdef PYRNA_FREE_SUPPORT
112         bool freeptr;  /* needed in some cases if ptr.data is created on the fly, free when deallocing */
113 #endif /* PYRNA_FREE_SUPPORT */
114 } BPy_StructRNA;
115
116 typedef struct {
117         PyObject_HEAD /* required python macro   */
118 #ifdef USE_WEAKREFS
119         PyObject *in_weakreflist;
120 #endif
121         PointerRNA ptr;
122         PropertyRNA *prop;
123 } BPy_PropertyRNA;
124
125 typedef struct {
126         PyObject_HEAD /* required python macro   */
127 #ifdef USE_WEAKREFS
128         PyObject *in_weakreflist;
129 #endif
130         PointerRNA ptr;
131         PropertyRNA *prop;
132
133         /* Arystan: this is a hack to allow sub-item r/w access like: face.uv[n][m] */
134         int arraydim; /* array dimension, e.g: 0 for face.uv, 2 for face.uv[n][m], etc. */
135         int arrayoffset; /* array first item offset, e.g. if face.uv is [4][2], arrayoffset for face.uv[n] is 2n */
136 } BPy_PropertyArrayRNA;
137
138 typedef struct {
139         PyObject_HEAD /* required python macro   */
140 #ifdef USE_WEAKREFS
141         PyObject *in_weakreflist;
142 #endif
143
144         /* collection iterator specific parts */
145         CollectionPropertyIterator iter;
146 } BPy_PropertyCollectionIterRNA;
147
148 typedef struct {
149         PyObject_HEAD /* required python macro   */
150 #ifdef USE_WEAKREFS
151         PyObject *in_weakreflist;
152 #endif
153         PointerRNA ptr;
154         FunctionRNA *func;
155 } BPy_FunctionRNA;
156
157 /* cheap trick */
158 #define BPy_BaseTypeRNA BPy_PropertyRNA
159
160 StructRNA *srna_from_self(PyObject *self, const char *error_prefix);
161 StructRNA *pyrna_struct_as_srna(PyObject *self, const bool parent, const char *error_prefix);
162
163 void      BPY_rna_init(void);
164 PyObject *BPY_rna_module(void);
165 void      BPY_update_rna_module(void);
166 /*PyObject *BPY_rna_doc(void);*/
167 PyObject *BPY_rna_types(void);
168 void      BPY_rna_register_cb(void);
169
170 PyObject *pyrna_struct_CreatePyObject(PointerRNA *ptr);
171 PyObject *pyrna_prop_CreatePyObject(PointerRNA *ptr, PropertyRNA *prop);
172
173 /* extern'd by other modules which don't deal closely with RNA */
174 PyObject *pyrna_id_CreatePyObject(struct ID *id);
175 bool      pyrna_id_FromPyObject(PyObject *obj, struct ID **id);
176 bool      pyrna_id_CheckPyObject(PyObject *obj);
177
178 /* operators also need this to set args */
179 int pyrna_pydict_to_props(PointerRNA *ptr, PyObject *kw, const bool all_args, const char *error_prefix);
180 PyObject *pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop);
181
182 unsigned int *pyrna_set_to_enum_bitmap(
183         const struct EnumPropertyItem *items, PyObject *value,
184         int type_size, bool type_convert_sign,
185         int bitmap_size,
186         const char *error_prefix);
187 PyObject *pyrna_enum_bitfield_to_py(
188         const struct EnumPropertyItem *items, int value);
189 int pyrna_set_to_enum_bitfield(
190         const struct EnumPropertyItem *items, PyObject *value, int *r_value, const char *error_prefix);
191
192 int pyrna_enum_value_from_id(
193         const EnumPropertyItem *item, const char *identifier, int *value, const char *error_prefix);
194
195 int pyrna_deferred_register_class(struct StructRNA *srna, PyTypeObject *py_class);
196
197 /* called before stopping python */
198 void pyrna_alloc_types(void);
199 void pyrna_free_types(void);
200
201 /* primitive type conversion */
202 int pyrna_py_to_array(PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix);
203 int pyrna_py_to_array_index(PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix);
204 PyObject *pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index);
205
206 PyObject *pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop);
207 PyObject *pyrna_py_from_array_index(BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index);
208 PyObject *pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop);
209 int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value);
210
211 bool pyrna_write_check(void);
212 void pyrna_write_set(bool val);
213
214 void pyrna_invalidate(BPy_DummyPointerRNA *self);
215 int pyrna_struct_validity_check(BPy_StructRNA *pysrna);
216 int pyrna_prop_validity_check(BPy_PropertyRNA *self);
217
218 /* bpy.utils.(un)register_class */
219 extern PyMethodDef meth_bpy_register_class;
220 extern PyMethodDef meth_bpy_unregister_class;
221
222 /* bpy.utils._bl_owner_(get/set) */
223 extern PyMethodDef meth_bpy_owner_id_set;
224 extern PyMethodDef meth_bpy_owner_id_get;
225
226 extern BPy_StructRNA *bpy_context_module;
227
228 #endif