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