svn merge ^/trunk/blender -r40644:40720
[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 #else /* WITH_PYTHON_SAFETY */
48
49  /* default, no defines! */
50
51 #endif /* !WITH_PYTHON_SAFETY */
52
53
54 /* sanity checks on above defs */
55 #if defined(USE_PYRNA_INVALIDATE_WEAKREF) && !defined(USE_WEAKREFS)
56 #define USE_WEAKREFS
57 #endif
58
59 #if defined(USE_PYRNA_INVALIDATE_GC) && defined(USE_PYRNA_INVALIDATE_WEAKREF)
60 #error "Only 1 reference check method at a time!"
61 #endif
62
63 /* only used by operator introspection get_rna(), this is only used for doc gen
64  * so prefer the leak to the memory bloat for now. */
65 // #define PYRNA_FREE_SUPPORT
66
67 /* use real collection iterators rather than faking with a list
68  * this is needed so enums can be iterated over without crashing,
69  * since finishing the iteration frees temp allocated enums */
70 #define USE_PYRNA_ITER
71
72 /* --- end bpy build options --- */
73
74 struct ID;
75
76 extern PyTypeObject pyrna_struct_meta_idprop_Type;
77 extern PyTypeObject pyrna_struct_Type;
78 extern PyTypeObject pyrna_prop_Type;
79 extern PyTypeObject pyrna_prop_array_Type;
80 extern PyTypeObject pyrna_prop_collection_Type;
81 extern PyTypeObject pyrna_func_Type;
82
83 #define BPy_StructRNA_Check(v)                  (PyObject_TypeCheck(v, &pyrna_struct_Type))
84 #define BPy_StructRNA_CheckExact(v)             (Py_TYPE(v) == &pyrna_struct_Type)
85 #define BPy_PropertyRNA_Check(v)                (PyObject_TypeCheck(v, &pyrna_prop_Type))
86 #define BPy_PropertyRNA_CheckExact(v)   (Py_TYPE(v) == &pyrna_prop_Type)
87
88 #define PYRNA_STRUCT_CHECK_OBJ(obj) if(pyrna_struct_validity_check(obj) == -1) { return NULL; }
89 #define PYRNA_STRUCT_CHECK_INT(obj) if(pyrna_struct_validity_check(obj) == -1) { return -1; }
90
91 #define PYRNA_PROP_CHECK_OBJ(obj) if(pyrna_prop_validity_check(obj) == -1) { return NULL; }
92 #define PYRNA_PROP_CHECK_INT(obj) if(pyrna_prop_validity_check(obj) == -1) { return -1; }
93
94 #define PYRNA_STRUCT_IS_VALID(pysrna) (((BPy_StructRNA *)(pysrna))->ptr.type != NULL)
95 #define PYRNA_PROP_IS_VALID(pysrna) (((BPy_PropertyRNA *)(pysrna))->ptr.type != NULL)
96
97 /* 'in_weakreflist' MUST be aligned */
98
99 typedef struct {
100         PyObject_HEAD /* required python macro   */
101 #ifdef USE_WEAKREFS
102         PyObject *in_weakreflist;
103 #endif
104         PointerRNA      ptr;
105 } BPy_DummyPointerRNA;
106
107 typedef struct {
108         PyObject_HEAD /* required python macro   */
109 #ifdef USE_WEAKREFS
110         PyObject *in_weakreflist;
111 #endif
112         PointerRNA ptr;
113 #ifdef USE_PYRNA_STRUCT_REFERENCE
114         /* generic PyObject we hold a reference to, example use:
115          * hold onto the collection iterator to prevent it from freeing allocated data we may use */
116         PyObject *reference;
117 #endif /* !USE_PYRNA_STRUCT_REFERENCE */
118
119 #ifdef PYRNA_FREE_SUPPORT
120         int freeptr; /* needed in some cases if ptr.data is created on the fly, free when deallocing */
121 #endif /* PYRNA_FREE_SUPPORT */
122 } BPy_StructRNA;
123
124 typedef struct {
125         PyObject_HEAD /* required python macro   */
126 #ifdef USE_WEAKREFS
127         PyObject *in_weakreflist;
128 #endif
129         PointerRNA ptr;
130         PropertyRNA *prop;
131 } BPy_PropertyRNA;
132
133 typedef struct {
134         PyObject_HEAD /* required python macro   */
135 #ifdef USE_WEAKREFS
136         PyObject *in_weakreflist;
137 #endif
138         PointerRNA ptr;
139         PropertyRNA *prop;
140
141         /* Arystan: this is a hack to allow sub-item r/w access like: face.uv[n][m] */
142         int arraydim; /* array dimension, e.g: 0 for face.uv, 2 for face.uv[n][m], etc. */
143         int arrayoffset; /* array first item offset, e.g. if face.uv is [4][2], arrayoffset for face.uv[n] is 2n */
144 } BPy_PropertyArrayRNA;
145
146 typedef struct {
147         PyObject_HEAD /* required python macro   */
148 #ifdef USE_WEAKREFS
149         PyObject *in_weakreflist;
150 #endif
151
152         /* collection iterator spesific parts */
153         CollectionPropertyIterator iter;
154 } BPy_PropertyCollectionIterRNA;
155
156 typedef struct {
157         PyObject_HEAD /* required python macro   */
158 #ifdef USE_WEAKREFS
159         PyObject *in_weakreflist;
160 #endif
161         PointerRNA ptr;
162         FunctionRNA *func;
163 } BPy_FunctionRNA;
164
165 /* cheap trick */
166 #define BPy_BaseTypeRNA BPy_PropertyRNA
167
168 StructRNA *srna_from_self(PyObject *self, const char *error_prefix);
169 StructRNA *pyrna_struct_as_srna(PyObject *self, int parent, const char *error_prefix);
170
171 void      BPY_rna_init(void);
172 PyObject *BPY_rna_module(void);
173 void      BPY_update_rna_module(void);
174 /*PyObject *BPY_rna_doc(void);*/
175 PyObject *BPY_rna_types(void);
176
177 PyObject *pyrna_struct_CreatePyObject(PointerRNA *ptr);
178 PyObject *pyrna_prop_CreatePyObject(PointerRNA *ptr, PropertyRNA *prop);
179
180 /* operators also need this to set args */
181 int pyrna_pydict_to_props(PointerRNA *ptr, PyObject *kw, int all_args, const char *error_prefix);
182 PyObject *pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop);
183
184 PyObject *pyrna_enum_bitfield_to_py(struct EnumPropertyItem *items, int value);
185 int pyrna_set_to_enum_bitfield(EnumPropertyItem *items, PyObject *value, int *r_value, const char *error_prefix);
186
187 int pyrna_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value, const char *error_prefix);
188
189 int pyrna_deferred_register_class(struct StructRNA *srna, PyObject *py_class);
190
191 /* called before stopping python */
192 void pyrna_alloc_types(void);
193 void pyrna_free_types(void);
194
195 /* primitive type conversion */
196 int pyrna_py_to_array(PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix);
197 int pyrna_py_to_array_index(PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix);
198 PyObject *pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index);
199
200 PyObject *pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop);
201 PyObject *pyrna_py_from_array_index(BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index);
202 PyObject *pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop);
203 int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value);
204
205 int pyrna_write_check(void);
206 void pyrna_write_set(int val);
207
208 int pyrna_struct_validity_check(BPy_StructRNA *pysrna);
209 int pyrna_prop_validity_check(BPy_PropertyRNA *self);
210
211 /* bpy.utils.(un)register_class */
212 extern PyMethodDef meth_bpy_register_class;
213 extern PyMethodDef meth_bpy_unregister_class;
214
215 #endif