PyAPI: add utilities PyTuple_SET_ITEMS, Py_INCREF_RET
[blender.git] / source / blender / python / generic / python_utildefines.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file blender/python/generic/python_utildefines.h
22  *  \ingroup pygen
23  *  \brief header-only utilities
24  *  \note light addition to Python.h, use py_capi_utils.h for larger features.
25  */
26
27 #ifndef __PYTHON_UTILDEFINES_H__
28 #define __PYTHON_UTILDEFINES_H__
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #define PyTuple_SET_ITEMS(op_arg, ...) \
35 { \
36         PyTupleObject *op = (PyTupleObject *)op_arg; \
37         PyObject **ob_items = op->ob_item; \
38         CHECK_TYPE_ANY(op_arg, PyObject *, PyTupleObject *); \
39         BLI_assert(_VA_NARGS_COUNT(__VA_ARGS__) == PyTuple_GET_SIZE(op)); \
40         ARRAY_SET_ITEMS(ob_items, __VA_ARGS__); \
41 } (void)0
42
43 /* wrap Py_INCREF & return the result,
44  * use sparingly to avoid comma operator or temp var assignment */
45 BLI_INLINE PyObject *Py_INCREF_RET(PyObject *op) { Py_INCREF(op); return op; }
46
47 #ifdef __cplusplus
48 }
49 #endif
50
51 #endif  /* __PYTHON_UTILDEFINES_H__ */
52