Merge branch 'blender2.7'
[blender.git] / source / blender / python / generic / idprop_py_api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup pygen
18  */
19
20
21 #ifndef __IDPROP_PY_API_H__
22 #define __IDPROP_PY_API_H__
23
24 struct BPy_IDGroup_Iter;
25 struct ID;
26 struct IDProperty;
27
28 extern PyTypeObject BPy_IDArray_Type;
29 extern PyTypeObject BPy_IDGroup_Iter_Type;
30 extern PyTypeObject BPy_IDGroup_Type;
31
32 #define BPy_IDArray_Check(v)                    (PyObject_TypeCheck(v, &BPy_IDArray_Type))
33 #define BPy_IDArray_CheckExact(v)               (Py_TYPE(v) == &BPy_IDArray_Type)
34 #define BPy_IDGroup_Iter_Check(v)               (PyObject_TypeCheck(v, &BPy_IDGroup_Iter_Type))
35 #define BPy_IDGroup_Iter_CheckExact(v)  (Py_TYPE(v) == &BPy_IDGroup_Iter_Type)
36 #define BPy_IDGroup_Check(v)                    (PyObject_TypeCheck(v, &BPy_IDGroup_Type))
37 #define BPy_IDGroup_CheckExact(v)               (Py_TYPE(v) == &BPy_IDGroup_Type)
38
39 typedef struct BPy_IDProperty {
40         PyObject_VAR_HEAD
41         struct ID *id;           /* can be NULL */
42         struct IDProperty *prop; /* must be second member */
43         struct IDProperty *parent;
44         PyObject *data_wrap;
45 } BPy_IDProperty;
46
47 typedef struct BPy_IDArray {
48         PyObject_VAR_HEAD
49         struct ID *id;            /* can be NULL */
50         struct IDProperty *prop;  /* must be second member */
51 } BPy_IDArray;
52
53 typedef struct BPy_IDGroup_Iter {
54         PyObject_VAR_HEAD
55         BPy_IDProperty *group;
56         struct IDProperty *cur;
57         int mode;
58 } BPy_IDGroup_Iter;
59
60 PyObject *BPy_Wrap_GetKeys(struct IDProperty *prop);
61 PyObject *BPy_Wrap_GetValues(struct ID *id, struct IDProperty *prop);
62 PyObject *BPy_Wrap_GetItems(struct ID *id, struct IDProperty *prop);
63 int BPy_Wrap_SetMapItem(struct IDProperty *prop, PyObject *key, PyObject *val);
64
65
66 PyObject *BPy_IDGroup_WrapData(struct ID *id, struct IDProperty *prop, struct IDProperty *parent);
67 bool BPy_IDProperty_Map_ValidateAndCreate(PyObject *key, struct IDProperty *group, PyObject *ob);
68
69 void IDProp_Init_Types(void);
70
71 PyObject *BPyInit_idprop(void);
72
73 #define IDPROP_ITER_KEYS        0
74 #define IDPROP_ITER_ITEMS       1
75
76 #endif /* __IDPROP_PY_API_H__ */