3796984ea81923532171d9bc548c6c3faa7eb3c1
[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 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 /* --- end bpy build options --- */
66
67 struct ID;
68
69 extern PyTypeObject pyrna_struct_meta_idprop_Type;
70 extern PyTypeObject pyrna_struct_Type;
71 extern PyTypeObject pyrna_prop_Type;
72 extern PyTypeObject pyrna_prop_array_Type;
73 extern PyTypeObject pyrna_prop_collection_Type;
74 extern PyTypeObject pyrna_func_Type;
75
76 #define BPy_StructRNA_Check(v)                  (PyObject_TypeCheck(v, &pyrna_struct_Type))
77 #define BPy_StructRNA_CheckExact(v)             (Py_TYPE(v) == &pyrna_struct_Type)
78 #define BPy_PropertyRNA_Check(v)                (PyObject_TypeCheck(v, &pyrna_prop_Type))
79 #define BPy_PropertyRNA_CheckExact(v)   (Py_TYPE(v) == &pyrna_prop_Type)
80
81 #define PYRNA_STRUCT_CHECK_OBJ(obj) if(pyrna_struct_validity_check(obj) == -1) { return NULL; }
82 #define PYRNA_STRUCT_CHECK_INT(obj) if(pyrna_struct_validity_check(obj) == -1) { return -1; }
83
84 #define PYRNA_PROP_CHECK_OBJ(obj) if(pyrna_prop_validity_check(obj) == -1) { return NULL; }
85 #define PYRNA_PROP_CHECK_INT(obj) if(pyrna_prop_validity_check(obj) == -1) { return -1; }
86
87 #define PYRNA_STRUCT_IS_VALID(pysrna) (((BPy_StructRNA *)(pysrna))->ptr.type != NULL)
88 #define PYRNA_PROP_IS_VALID(pysrna) (((BPy_PropertyRNA *)(pysrna))->ptr.type != NULL)
89
90 /* 'in_weakreflist' MUST be aligned */
91
92 typedef struct {
93         PyObject_HEAD /* required python macro   */
94 #ifdef USE_WEAKREFS
95         PyObject *in_weakreflist;
96 #endif
97         PointerRNA      ptr;
98 } BPy_DummyPointerRNA;
99
100 typedef struct {
101         PyObject_HEAD /* required python macro   */
102 #ifdef USE_WEAKREFS
103         PyObject *in_weakreflist;
104 #endif
105         PointerRNA ptr;
106 #ifdef USE_PYRNA_STRUCT_REFERENCE
107         /* generic PyObject we hold a reference to, example use:
108          * hold onto the collection iterator to prevent it from freeing allocated data we may use */
109         PyObject *reference;
110 #endif /* !USE_PYRNA_STRUCT_REFERENCE */
111         int freeptr; /* needed in some cases if ptr.data is created on the fly, free when deallocing */
112 } BPy_StructRNA;
113
114 typedef struct {
115         PyObject_HEAD /* required python macro   */
116 #ifdef USE_WEAKREFS
117         PyObject *in_weakreflist;
118 #endif
119         PointerRNA ptr;
120         PropertyRNA *prop;
121 } BPy_PropertyRNA;
122
123 typedef struct {
124         PyObject_HEAD /* required python macro   */
125 #ifdef USE_WEAKREFS
126         PyObject *in_weakreflist;
127 #endif
128         PointerRNA ptr;
129         PropertyRNA *prop;
130
131         /* Arystan: this is a hack to allow sub-item r/w access like: face.uv[n][m] */
132         int arraydim; /* array dimension, e.g: 0 for face.uv, 2 for face.uv[n][m], etc. */
133         int arrayoffset; /* array first item offset, e.g. if face.uv is [4][2], arrayoffset for face.uv[n] is 2n */
134 } BPy_PropertyArrayRNA;
135
136 typedef struct {
137         PyObject_HEAD /* required python macro   */
138 #ifdef USE_WEAKREFS
139         PyObject *in_weakreflist;
140 #endif
141
142         /* collection iterator spesific parts */
143         CollectionPropertyIterator iter;
144 } BPy_PropertyCollectionIterRNA;
145
146 typedef struct {
147         PyObject_HEAD /* required python macro   */
148 #ifdef USE_WEAKREFS
149         PyObject *in_weakreflist;
150 #endif
151         PointerRNA ptr;
152         FunctionRNA *func;
153 } BPy_FunctionRNA;
154
155 /* cheap trick */
156 #define BPy_BaseTypeRNA BPy_PropertyRNA
157
158 StructRNA *srna_from_self(PyObject *self, const char *error_prefix);
159 StructRNA *pyrna_struct_as_srna(PyObject *self, int parent, const char *error_prefix);
160
161 void      BPY_rna_init(void);
162 PyObject *BPY_rna_module(void);
163 void      BPY_update_rna_module(void);
164 /*PyObject *BPY_rna_doc(void);*/
165 PyObject *BPY_rna_types(void);
166
167 PyObject *pyrna_struct_CreatePyObject(PointerRNA *ptr);
168 PyObject *pyrna_prop_CreatePyObject(PointerRNA *ptr, PropertyRNA *prop);
169
170 /* operators also need this to set args */
171 int pyrna_pydict_to_props(PointerRNA *ptr, PyObject *kw, int all_args, const char *error_prefix);
172 PyObject *pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop);
173
174 PyObject *pyrna_enum_bitfield_to_py(struct EnumPropertyItem *items, int value);
175 int pyrna_set_to_enum_bitfield(EnumPropertyItem *items, PyObject *value, int *r_value, const char *error_prefix);
176
177 int pyrna_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value, const char *error_prefix);
178
179 int pyrna_deferred_register_class(struct StructRNA *srna, PyObject *py_class);
180
181 /* called before stopping python */
182 void pyrna_alloc_types(void);
183 void pyrna_free_types(void);
184
185 /* primitive type conversion */
186 int pyrna_py_to_array(PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix);
187 int pyrna_py_to_array_index(PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix);
188 PyObject *pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index);
189
190 PyObject *pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop);
191 PyObject *pyrna_py_from_array_index(BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index);
192 PyObject *pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop);
193 int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value);
194
195 int pyrna_write_check(void);
196 void pyrna_write_set(int val);
197
198 int pyrna_struct_validity_check(BPy_StructRNA *pysrna);
199 int pyrna_prop_validity_check(BPy_PropertyRNA *self);
200
201 /* bpy.utils.(un)register_class */
202 extern PyMethodDef meth_bpy_register_class;
203 extern PyMethodDef meth_bpy_unregister_class;
204
205 #endif