src/InitializationPlugin/InitializationPlugin_PyInterp.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef INITIALIZATIONPLUGIN_PYINTERP_H_
  21 #define INITIALIZATIONPLUGIN_PYINTERP_H_
  22
  23 #include <PyInterp_Interp.h>
  24 #include <InitializationPlugin.h>
  25
  26 #include <list>
  27 #include <string>
  28 #include <utility>
  29
  30 /**
  31  * \class InitializationPlugin_PyInterp
  32  * \ingroup Plugins
  33  * \brief Helper class for using Python interpreter.
  34  */
  35 class INITIALIZATIONPLUGIN_EXPORT InitializationPlugin_PyInterp : public PyInterp_Interp
  36 {
  37  public:
  38   InitializationPlugin_PyInterp();
  39   virtual ~InitializationPlugin_PyInterp();
  40
  41   /// Returns a list of positions for theName in theExpression.
  42   std::list<std::pair<int, int> > positions(const std::wstring& theExpression,
  43                                             const std::wstring& theName);
  44   /// Compiles theExpression and returns a list of parameters used in theExpression.
  45   std::list<std::wstring> compile(const std::wstring& theExpression);
  46   /// Extends local context with the list of parameters.
  47   void extendLocalContext(const std::list<std::wstring>& theParameters);
  48   /// Clears local context.
  49   void clearLocalContext();
  50   /// Evaluates theExpression and returns its value.
  51   double evaluate(const std::wstring& theExpression, std::string& theError);
  52
  53   /// Runs the string command in the python interpreter. Returns true if no error is in result.
  54   bool runString(std::string theString);
  55
  56  protected:
  57   /// Returns error message.
  58   std::string errorMessage();
  59   /// Overrides PyInterp_Interp.
  60   virtual bool initContext();
  61   /// Reimplemented from PyInterp_Interp::closeContext().
  62   virtual void closeContext();
  63 };
  64
  65 #endif /* INITIALIZATIONPLUGIN_PYINTERP_H_ */