Cleanup: remove redundant, invalid info from headers
[blender.git] / source / blender / python / generic / bpy_threads.c
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/bpy_threads.c
18  *  \ingroup pygen
19  *
20  * This file contains wrapper functions related to global interpreter lock.
21  * these functions are slightly different from the original Python API,
22  * don't throw SIGABRT even if the thread state is NULL. */
23
24 #include <Python.h>
25
26 #include "BLI_utildefines.h"
27 #include "../BPY_extern.h"
28
29 /* analogue of PyEval_SaveThread() */
30 BPy_ThreadStatePtr BPY_thread_save(void)
31 {
32         PyThreadState *tstate = PyThreadState_Swap(NULL);
33         /* note: tstate can be NULL when quitting Blender */
34
35         if (tstate && PyEval_ThreadsInitialized()) {
36                 PyEval_ReleaseLock();
37         }
38
39         return (BPy_ThreadStatePtr)tstate;
40 }
41
42 /* analogue of PyEval_RestoreThread() */
43 void BPY_thread_restore(BPy_ThreadStatePtr tstate)
44 {
45         if (tstate) {
46                 PyEval_RestoreThread((PyThreadState *)tstate);
47         }
48 }