tools/PyInterp/src/PyInterp_Utils.h

   1 // Copyright (C) 2007-2023  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //  File   : PyInterp_Utils.h
  23 //  Author : Christian CAREMOLI, Paul RASCLE, Adrien BRUNETON
  24
  25 #ifndef PYINTERP_UTILS_H
  26 #define PYINTERP_UTILS_H
  27
  28 #include "PyInterp.h"
  29
  30 #ifdef _DEBUG_
  31   #include <iostream>
  32 #endif
  33
  34 #if PY_VERSION_HEX < 0x03050000
  35 static char*
  36 Py_EncodeLocale(const wchar_t *arg, size_t *size)
  37 {
  38         return _Py_wchar2char(arg, size);
  39 }
  40 static wchar_t*
  41 Py_DecodeLocale(const char *arg, size_t *size)
  42 {
  43         return _Py_char2wchar(arg, size);
  44 }
  45 #endif
  46
  47 /**
  48  * \class PyLockWrapper
  49  * \brief Python GIL wrapper.
  50  *
  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 instantiated the lock is acquired. It is released at destruction time.
  55  * Copy construction (and hence assignation) is forbidden.
  56  */
  57 class PYINTERP_EXPORT PyLockWrapper
  58 {
  59 public:
  60   /**
  61    * \brief Constructor. Automatically acquires GIL.
  62    */
  63   PyLockWrapper()
  64   {
  65     _gil_state = PyGILState_Ensure();
  66     // Save current thread state for later comparison
  67     _state = PyGILState_GetThisThreadState();
  68   }
  69
  70   /**
  71    * \brief Destructor. Automatically releases GIL.
  72    */
  73   ~PyLockWrapper()
  74   {
  75     PyThreadState* _currState = PyGILState_GetThisThreadState();
  76     (void)_currState;
  77 #ifdef _DEBUG_
  78     if (_currState != _state)
  79     {
  80       std::cout << "!!!!!!!!! PyLockWrapper inconsistency - now entering infinite loop for debugging\n";
  81       while(1);
  82     }
  83 #endif
  84     PyGILState_Release(_gil_state);
  85   }
  86
  87 private:
  88   PyGILState_STATE _gil_state;
  89   PyThreadState* _state;
  90
  91   // "Rule of 3" - Forbid usage of copy operator and copy-constructor
  92   PyLockWrapper(const PyLockWrapper & another);
  93   const PyLockWrapper & operator=(const PyLockWrapper & another);
  94 };
  95
  96 /**
  97  * \class PyObjWrapper
  98  * \brief Utility class to properly handle the reference counting required on Python objects.
  99  */
 100 class PYINTERP_EXPORT PyObjWrapper
 101 {
 102   PyObject* myObject;
 103 public:
 104   PyObjWrapper(PyObject* theObject) : myObject(theObject) {}
 105   PyObjWrapper() : myObject(0) {}
 106   virtual ~PyObjWrapper() { Py_XDECREF(myObject); }
 107
 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)
 115   {
 116     Py_XDECREF(myObject);
 117     myObject = theObjWrapper->myObject;
 118     Py_XINCREF(myObject);
 119     return *this;
 120   }
 121   PyObjWrapper& operator=(const PyObjWrapper& theObjWrapper)
 122   {
 123     Py_XDECREF(myObject);
 124     myObject = theObjWrapper.myObject;
 125     Py_XINCREF(myObject);
 126     return *this;
 127   }
 128 };
 129
 130 #endif // PYINTERP_UTILS_H