Py/RNA API: WITH_PYTHON_SAFETY
[blender.git] / source / blender / python / intern / bpy_rna.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/python/intern/bpy_rna.h
26  *  \ingroup pythonintern
27  */
28
29 #ifndef BPY_RNA_H
30 #define BPY_RNA_H
31
32 /* --- bpy build options --- */
33 #ifdef WITH_PYTHON_SAFETY
34
35 /* play it safe and keep optional for now, need to test further now this affects looping on 10000's of verts for eg. */
36 #define USE_WEAKREFS
37
38 /* method to invalidate removed py data, XXX, slow to remove objects, otherwise no overhead */
39 /* #define USE_PYRNA_INVALIDATE_GC */
40
41 /* different method */
42 #define USE_PYRNA_INVALIDATE_WEAKREF
43
44 /* support for inter references, currently only needed for corner case */
45 #define USE_PYRNA_STRUCT_REFERENCE
46
47 /* use real collection iterators rather then faking with a list */
48 #define USE_PYRNA_ITER
49
50 #else /* WITH_PYTHON_SAFETY */
51
52  /* default, no defines! */
53
54 #endif /* !WITH_PYTHON_SAFETY */
55
56
57 /* sanity checks on above defs */
58 #if defined(USE_PYRNA_INVALIDATE_WEAKREF) && !defined(USE_WEAKREFS)
59 #define USE_WEAKREFS
60 #endif
61
62 #if defined(USE_PYRNA_INVALIDATE_GC) && defined(USE_PYRNA_INVALIDATE_WEAKREF)
63 #error "Only 1 reference check method at a time!"
64 #endif
65 /* --- end bpy build options --- */
66
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
74 #define BPy_StructRNA_Check(v)                  (PyObject_TypeCheck(v, &pyrna_struct_Type))
75 #define BPy_StructRNA_CheckExact(v)             (Py_TYPE(v) == &pyrna_struct_Type)
76 #define BPy_PropertyRNA_Check(v)                (PyObject_TypeCheck(v, &pyrna_prop_Type))
77 #define BPy_PropertyRNA_CheckExact(v)   (Py_TYPE(v) == &pyrna_prop_Type)
78
79 #define PYRNA_STRUCT_CHECK_OBJ(obj) if(pyrna_struct_validity_check(obj) == -1) { return NULL; }
80 #define PYRNA_STRUCT_CHECK_INT(obj) if(pyrna_struct_validity_check(obj) == -1) { return -1; }
81
82 #define PYRNA_PROP_CHECK_OBJ(obj) if(pyrna_prop_validity_check(obj) == -1) { return NULL; }
83 #define PYRNA_PROP_CHECK_INT(obj) if(pyrna_prop_validity_check(obj) == -1) { return -1; }
84
85 #define PYRNA_STRUCT_IS_VALID(pysrna) (((BPy_StructRNA *)(pysrna))->ptr.type != NULL)
86 #define PYRNA_PROP_IS_VALID(pysrna) (((BPy_PropertyRNA *)(pysrna))->ptr.type != NULL)
87
88 /* 'in_weakreflist' MUST be aligned */
89
90 typedef struct {
91         PyObject_HEAD /* required python macro   */
92 #ifdef USE_WEAKREFS
93         PyObject *in_weakreflist;
94 #endif
95         PointerRNA      ptr;
96 } BPy_DummyPointerRNA;
97
98 typedef struct {
99         PyObject_HEAD /* required python macro   */
100 #ifdef USE_WEAKREFS
101         PyObject *in_weakreflist;
102 #endif
103         PointerRNA ptr;
104 #ifdef USE_PYRNA_STRUCT_REFERENCE
105         /* generic PyObject we hold a reference to, example use:
106          * hold onto the collection iterator to prevent it from freeing allocated data we may use */
107         PyObject *reference;
108 #endif /* !USE_PYRNA_STRUCT_REFERENCE */
109         int freeptr; /* needed in some cases if ptr.data is created on the fly, free when deallocing */
110 } BPy_StructRNA;
111
112 typedef struct {
113         PyObject_HEAD /* required python macro   */
114 #ifdef USE_WEAKREFS
115         PyObject *in_weakreflist;
116 #endif
117         PointerRNA ptr;
118         PropertyRNA *prop;
119 } BPy_PropertyRNA;
120
121 typedef struct {
122         PyObject_HEAD /* required python macro   */
123 #ifdef USE_WEAKREFS
124         PyObject *in_weakreflist;
125 #endif
126         PointerRNA ptr;
127         PropertyRNA *prop;
128
129         /* Arystan: this is a hack to allow sub-item r/w access like: face.uv[n][m] */
130         int arraydim; /* array dimension, e.g: 0 for face.uv, 2 for face.uv[n][m], etc. */
131         int arrayoffset; /* array first item offset, e.g. if face.uv is [4][2], arrayoffset for face.uv[n] is 2n */
132 } BPy_PropertyArrayRNA;
133
134 typedef struct {
135         PyObject_HEAD /* required python macro   */
136 #ifdef USE_WEAKREFS
137         PyObject *in_weakreflist;
138 #endif
139
140         /* collection iterator spesific parts */
141         CollectionPropertyIterator iter;
142 } BPy_PropertyCollectionIterRNA;
143
144 /* cheap trick */
145 #define BPy_BaseTypeRNA BPy_PropertyRNA
146
147 StructRNA *srna_from_self(PyObject *self, const char *error_prefix);
148 StructRNA *pyrna_struct_as_srna(PyObject *self, int parent, const char *error_prefix);
149
150 void      BPY_rna_init( void );
151 PyObject *BPY_rna_module( void );
152 void      BPY_update_rna_module( void );
153 /*PyObject *BPY_rna_doc( void );*/
154 PyObject *BPY_rna_types( void );
155
156 PyObject *pyrna_struct_CreatePyObject( PointerRNA *ptr );
157 PyObject *pyrna_prop_CreatePyObject( PointerRNA *ptr, PropertyRNA *prop );
158
159 /* operators also need this to set args */
160 int pyrna_pydict_to_props(PointerRNA *ptr, PyObject *kw, int all_args, const char *error_prefix);
161 PyObject * pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop);
162
163 PyObject *pyrna_enum_bitfield_to_py(struct EnumPropertyItem *items, int value);
164 int pyrna_set_to_enum_bitfield(EnumPropertyItem *items, PyObject *value, int *r_value, const char *error_prefix);
165
166 int pyrna_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value, const char *error_prefix);
167
168 int pyrna_deferred_register_class(struct StructRNA *srna, PyObject *py_class);
169
170 /* called before stopping python */
171 void pyrna_alloc_types(void);
172 void pyrna_free_types(void);
173
174 /* primitive type conversion */
175 int pyrna_py_to_array(PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix);
176 int pyrna_py_to_array_index(PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix);
177 PyObject *pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index);
178
179 PyObject *pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop);
180 PyObject *pyrna_py_from_array_index(BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index);
181 PyObject *pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop);
182 int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value);
183
184 int pyrna_write_check(void);
185
186 int pyrna_struct_validity_check(BPy_StructRNA *pysrna);
187 int pyrna_prop_validity_check(BPy_PropertyRNA *self);
188
189 void BPY_modules_update(struct bContext *C); //XXX temp solution
190
191 /* bpy.utils.(un)register_class */
192 extern PyMethodDef meth_bpy_register_class;
193 extern PyMethodDef meth_bpy_unregister_class;
194
195 #endif