Cleanup: sort forward declarations of enum & struct
[blender.git] / source / blender / python / generic / idprop_py_api.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): Joseph Eagar, Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/generic/idprop_py_api.h
24  *  \ingroup pygen
25  */
26
27
28 #ifndef __IDPROP_PY_API_H__
29 #define __IDPROP_PY_API_H__
30
31 struct BPy_IDGroup_Iter;
32 struct ID;
33 struct IDProperty;
34
35 extern PyTypeObject BPy_IDArray_Type;
36 extern PyTypeObject BPy_IDGroup_Iter_Type;
37 extern PyTypeObject BPy_IDGroup_Type;
38
39 #define BPy_IDArray_Check(v)                    (PyObject_TypeCheck(v, &BPy_IDArray_Type))
40 #define BPy_IDArray_CheckExact(v)               (Py_TYPE(v) == &BPy_IDArray_Type)
41 #define BPy_IDGroup_Iter_Check(v)               (PyObject_TypeCheck(v, &BPy_IDGroup_Iter_Type))
42 #define BPy_IDGroup_Iter_CheckExact(v)  (Py_TYPE(v) == &BPy_IDGroup_Iter_Type)
43 #define BPy_IDGroup_Check(v)                    (PyObject_TypeCheck(v, &BPy_IDGroup_Type))
44 #define BPy_IDGroup_CheckExact(v)               (Py_TYPE(v) == &BPy_IDGroup_Type)
45
46 typedef struct BPy_IDProperty {
47         PyObject_VAR_HEAD
48         struct ID *id;           /* can be NULL */
49         struct IDProperty *prop; /* must be second member */
50         struct IDProperty *parent;
51         PyObject *data_wrap;
52 } BPy_IDProperty;
53
54 typedef struct BPy_IDArray {
55         PyObject_VAR_HEAD
56         struct ID *id;            /* can be NULL */
57         struct IDProperty *prop;  /* must be second member */
58 } BPy_IDArray;
59
60 typedef struct BPy_IDGroup_Iter {
61         PyObject_VAR_HEAD
62         BPy_IDProperty *group;
63         struct IDProperty *cur;
64         int mode;
65 } BPy_IDGroup_Iter;
66
67 PyObject *BPy_Wrap_GetKeys(struct IDProperty *prop);
68 PyObject *BPy_Wrap_GetValues(struct ID *id, struct IDProperty *prop);
69 PyObject *BPy_Wrap_GetItems(struct ID *id, struct IDProperty *prop);
70 int BPy_Wrap_SetMapItem(struct IDProperty *prop, PyObject *key, PyObject *val);
71
72
73 PyObject *BPy_IDGroup_WrapData(struct ID *id, struct IDProperty *prop, struct IDProperty *parent);
74 bool BPy_IDProperty_Map_ValidateAndCreate(PyObject *key, struct IDProperty *group, PyObject *ob);
75
76 void IDProp_Init_Types(void);
77
78 PyObject *BPyInit_idprop(void);
79
80 #define IDPROP_ITER_KEYS        0
81 #define IDPROP_ITER_ITEMS       1
82
83 #endif /* __IDPROP_PY_API_H__ */