tools/PyInterp/src/PyInterp_Utils.h

   1 // Copyright (C) 2007-2016  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 /**
  35  * \class PyLockWrapper
  36  * \brief Python GIL wrapper.
  37  *
  38  * Utility class wrapping the Python GIL acquisition. This makes use of the high level
  39  * API (PyGILState_Ensure and PyGILState_Release), and is hence compatible with only
  40  * one running Python interpreter (no call to Py_NewInterpreter()).
  41  * When the class is instanciated the lock is acquired. It is released at destruction time.
  42  * Copy construction (and hence assignation) is forbidden.
  43  */
  44 class PYINTERP_EXPORT PyLockWrapper
  45 {
  46 public:
  47   /**
  48    * \brief Constructor. Automatically acquires GIL.
  49    */
  50   PyLockWrapper()
  51   {
  52     _gil_state = PyGILState_Ensure();
  53     // Save current thread state for later comparison
  54     _state = PyGILState_GetThisThreadState();
  55   }
  56
  57   /**
  58    * \brief Destructor. Automatically releases GIL.
  59    */
  60   ~PyLockWrapper()
  61   {
  62     PyThreadState* _currState = PyGILState_GetThisThreadState();
  63 #ifdef _DEBUG_
  64     if (_currState != _state)
  65     {
  66       std::cout << "!!!!!!!!! PyLockWrapper inconsistency - now entering infinite loop for debugging\n";
  67       while(1);
  68     }
  69 #endif
  70     PyGILState_Release(_gil_state);
  71   }
  72
  73 private:
  74   PyGILState_STATE _gil_state;
  75   PyThreadState* _state;
  76
  77   // "Rule of 3" - Forbid usage of copy operator and copy-constructor
  78   PyLockWrapper(const PyLockWrapper & another);
  79   const PyLockWrapper & operator=(const PyLockWrapper & another);
  80 };
  81
  82 /**
  83  * \class PyObjWrapper
  84  * \brief Utility class to properly handle the reference counting required on Python objects.
  85  */
  86 class PYINTERP_EXPORT PyObjWrapper
  87 {
  88   PyObject* myObject;
  89 public:
  90   PyObjWrapper(PyObject* theObject) : myObject(theObject) {}
  91   PyObjWrapper() : myObject(0) {}
  92   virtual ~PyObjWrapper() { Py_XDECREF(myObject); }
  93
  94   operator PyObject*()    { return myObject;  }
  95   PyObject* operator->()  { return myObject;  }
  96   PyObject* get()         { return myObject;  }
  97   bool operator!()        { return !myObject; }
  98   bool operator==(PyObject* theObject) { return myObject == theObject; }
  99   PyObject** operator&()  { return &myObject; }
 100   PyObjWrapper& operator=(PyObjWrapper* theObjWrapper)
 101   {
 102     Py_XDECREF(myObject);
 103     myObject = theObjWrapper->myObject;
 104     Py_XINCREF(myObject);
 105     return *this;
 106   }
 107   PyObjWrapper& operator=(const PyObjWrapper& theObjWrapper)
 108   {
 109     Py_XDECREF(myObject);
 110     myObject = theObjWrapper.myObject;
 111     Py_XINCREF(myObject);
 112     return *this;
 113   }
 114 };
 115
 116 #endif // PYINTERP_UTILS_H