doxygen: prevent GPL license block from being parsed as doxygen comment.
[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 #ifndef BPY_RNA_H
25 #define BPY_RNA_H
26
27 #include "RNA_access.h"
28 #include "RNA_types.h"
29 #include "BKE_idprop.h"
30
31 extern PyTypeObject pyrna_struct_meta_idprop_Type;
32 extern PyTypeObject pyrna_struct_Type;
33 extern PyTypeObject pyrna_prop_Type;
34 extern PyTypeObject pyrna_prop_array_Type;
35 extern PyTypeObject pyrna_prop_collection_Type;
36
37 #define BPy_StructRNA_Check(v)                  (PyObject_TypeCheck(v, &pyrna_struct_Type))
38 #define BPy_StructRNA_CheckExact(v)             (Py_TYPE(v) == &pyrna_struct_Type)
39 #define BPy_PropertyRNA_Check(v)                (PyObject_TypeCheck(v, &pyrna_prop_Type))
40 #define BPy_PropertyRNA_CheckExact(v)   (Py_TYPE(v) == &pyrna_prop_Type)
41
42 typedef struct {
43         PyObject_HEAD /* required python macro   */
44         PointerRNA ptr;
45 } BPy_DummyPointerRNA;
46
47 typedef struct {
48         PyObject_HEAD /* required python macro   */
49         PointerRNA ptr;
50         int freeptr; /* needed in some cases if ptr.data is created on the fly, free when deallocing */
51 } BPy_StructRNA;
52
53 typedef struct {
54         PyObject_HEAD /* required python macro   */
55         PointerRNA ptr;
56         PropertyRNA *prop;
57 } BPy_PropertyRNA;
58
59 typedef struct {
60         PyObject_HEAD /* required python macro   */
61         PointerRNA ptr;
62         PropertyRNA *prop;
63
64         /* Arystan: this is a hack to allow sub-item r/w access like: face.uv[n][m] */
65         int arraydim; /* array dimension, e.g: 0 for face.uv, 2 for face.uv[n][m], etc. */
66         int arrayoffset; /* array first item offset, e.g. if face.uv is [4][2], arrayoffset for face.uv[n] is 2n */
67 } BPy_PropertyArrayRNA;
68
69 /* cheap trick */
70 #define BPy_BaseTypeRNA BPy_PropertyRNA
71
72 StructRNA *srna_from_self(PyObject *self, const char *error_prefix);
73 StructRNA *pyrna_struct_as_srna(PyObject *self, int parent, const char *error_prefix);
74
75 void      BPY_rna_init( void );
76 PyObject *BPY_rna_module( void );
77 void      BPY_update_rna_module( void );
78 /*PyObject *BPY_rna_doc( void );*/
79 PyObject *BPY_rna_types( void );
80
81 PyObject *pyrna_struct_CreatePyObject( PointerRNA *ptr );
82 PyObject *pyrna_prop_CreatePyObject( PointerRNA *ptr, PropertyRNA *prop );
83
84 /* operators also need this to set args */
85 int pyrna_pydict_to_props(PointerRNA *ptr, PyObject *kw, int all_args, const char *error_prefix);
86 PyObject * pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop);
87
88 PyObject *pyrna_enum_bitfield_to_py(struct EnumPropertyItem *items, int value);
89 int pyrna_set_to_enum_bitfield(EnumPropertyItem *items, PyObject *value, int *r_value, const char *error_prefix);
90
91 int pyrna_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value, const char *error_prefix);
92
93 int pyrna_deferred_register_class(struct StructRNA *srna, PyObject *py_class);
94
95 /* called before stopping python */
96 void pyrna_alloc_types(void);
97 void pyrna_free_types(void);
98
99 /* primitive type conversion */
100 int pyrna_py_to_array(PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix);
101 int pyrna_py_to_array_index(PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix);
102 PyObject *pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index);
103
104 PyObject *pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop);
105 PyObject *pyrna_py_from_array_index(BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index);
106 PyObject *pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop);
107 int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value);
108
109 int pyrna_write_check(void);
110
111 void BPY_modules_update(struct bContext *C); //XXX temp solution
112
113 /* bpy.utils.(un)register_class */
114 extern PyMethodDef meth_bpy_register_class;
115 extern PyMethodDef meth_bpy_unregister_class;
116
117 #endif