30f6c02115aa70b51034ed46281e48b4ac43459c
[blender-staging.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 than 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
66 /* only used by operator introspection get_rna(), this is only used for doc gen
67  * so prefer the leak to the memory bloat for now. */
68 // #define PYRNA_FREE_SUPPORT
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(pyrna_struct_validity_check(obj) == -1) { return NULL; }
87 #define PYRNA_STRUCT_CHECK_INT(obj) if(pyrna_struct_validity_check(obj) == -1) { return -1; }
88
89 #define PYRNA_PROP_CHECK_OBJ(obj) if(pyrna_prop_validity_check(obj) == -1) { return NULL; }
90 #define PYRNA_PROP_CHECK_INT(obj) if(pyrna_prop_validity_check(obj) == -1) { return -1; }
91
92 #define PYRNA_STRUCT_IS_VALID(pysrna) (((BPy_StructRNA *)(pysrna))->ptr.type != NULL)
93 #define PYRNA_PROP_IS_VALID(pysrna) (((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         int 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 spesific 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, int 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
175 PyObject *pyrna_struct_CreatePyObject(PointerRNA *ptr);
176 PyObject *pyrna_prop_CreatePyObject(PointerRNA *ptr, PropertyRNA *prop);
177
178 /* operators also need this to set args */
179 int pyrna_pydict_to_props(PointerRNA *ptr, PyObject *kw, int all_args, const char *error_prefix);
180 PyObject *pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop);
181
182 PyObject *pyrna_enum_bitfield_to_py(struct EnumPropertyItem *items, int value);
183 int pyrna_set_to_enum_bitfield(EnumPropertyItem *items, PyObject *value, int *r_value, const char *error_prefix);
184
185 int pyrna_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value, const char *error_prefix);
186
187 int pyrna_deferred_register_class(struct StructRNA *srna, PyObject *py_class);
188
189 /* called before stopping python */
190 void pyrna_alloc_types(void);
191 void pyrna_free_types(void);
192
193 /* primitive type conversion */
194 int pyrna_py_to_array(PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix);
195 int pyrna_py_to_array_index(PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix);
196 PyObject *pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index);
197
198 PyObject *pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop);
199 PyObject *pyrna_py_from_array_index(BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index);
200 PyObject *pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop);
201 int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value);
202
203 int pyrna_write_check(void);
204 void pyrna_write_set(int val);
205
206 int pyrna_struct_validity_check(BPy_StructRNA *pysrna);
207 int pyrna_prop_validity_check(BPy_PropertyRNA *self);
208
209 /* bpy.utils.(un)register_class */
210 extern PyMethodDef meth_bpy_register_class;
211 extern PyMethodDef meth_bpy_unregister_class;
212
213 #endif