1 // Copyright (C) 2007-2020 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : PyInterp_Utils.h
23 // Author : Christian CAREMOLI, Paul RASCLE, Adrien BRUNETON
25 #ifndef PYINTERP_UTILS_H
26 #define PYINTERP_UTILS_H
34 #if PY_VERSION_HEX < 0x03050000
36 Py_EncodeLocale(const wchar_t *arg, size_t *size)
38 return _Py_wchar2char(arg, size);
41 Py_DecodeLocale(const char *arg, size_t *size)
43 return _Py_char2wchar(arg, size);
48 * \class PyLockWrapper
49 * \brief Python GIL wrapper.
51 * Utility class wrapping the Python GIL acquisition. This makes use of the high level
52 * API (PyGILState_Ensure and PyGILState_Release), and is hence compatible with only
53 * one running Python interpreter (no call to Py_NewInterpreter()).
54 * When the class is instanciated the lock is acquired. It is released at destruction time.
55 * Copy construction (and hence assignation) is forbidden.
57 class PYINTERP_EXPORT PyLockWrapper
61 * \brief Constructor. Automatically acquires GIL.
65 _gil_state = PyGILState_Ensure();
66 // Save current thread state for later comparison
67 _state = PyGILState_GetThisThreadState();
71 * \brief Destructor. Automatically releases GIL.
75 PyThreadState* _currState = PyGILState_GetThisThreadState();
78 if (_currState != _state)
80 std::cout << "!!!!!!!!! PyLockWrapper inconsistency - now entering infinite loop for debugging\n";
84 PyGILState_Release(_gil_state);
88 PyGILState_STATE _gil_state;
89 PyThreadState* _state;
91 // "Rule of 3" - Forbid usage of copy operator and copy-constructor
92 PyLockWrapper(const PyLockWrapper & another);
93 const PyLockWrapper & operator=(const PyLockWrapper & another);
98 * \brief Utility class to properly handle the reference counting required on Python objects.
100 class PYINTERP_EXPORT PyObjWrapper
104 PyObjWrapper(PyObject* theObject) : myObject(theObject) {}
105 PyObjWrapper() : myObject(0) {}
106 virtual ~PyObjWrapper() { Py_XDECREF(myObject); }
108 operator PyObject*() { return myObject; }
109 PyObject* operator->() { return myObject; }
110 PyObject* get() { return myObject; }
111 bool operator!() { return !myObject; }
112 bool operator==(PyObject* theObject) { return myObject == theObject; }
113 PyObject** operator&() { return &myObject; }
114 PyObjWrapper& operator=(PyObjWrapper* theObjWrapper)
116 Py_XDECREF(myObject);
117 myObject = theObjWrapper->myObject;
118 Py_XINCREF(myObject);
121 PyObjWrapper& operator=(const PyObjWrapper& theObjWrapper)
123 Py_XDECREF(myObject);
124 myObject = theObjWrapper.myObject;
125 Py_XINCREF(myObject);
130 #endif // PYINTERP_UTILS_H