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