src/InitializationPlugin/InitializationPlugin_PyInterp.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef INITIALIZATIONPLUGIN_PYINTERP_H_
  22 #define INITIALIZATIONPLUGIN_PYINTERP_H_
  23
  24 #include <PyInterp_Interp.h>
  25 #include <InitializationPlugin.h>
  26
  27 #include <list>
  28 #include <string>
  29 #include <utility>
  30
  31 /**
  32  * \class InitializationPlugin_PyInterp
  33  * \ingroup Plugins
  34  * \brief Helper class for using Python interpreter.
  35  */
  36 class INITIALIZATIONPLUGIN_EXPORT InitializationPlugin_PyInterp : public PyInterp_Interp
  37 {
  38  public:
  39   InitializationPlugin_PyInterp();
  40   virtual ~InitializationPlugin_PyInterp();
  41
  42   /// Returns a list of positions for theName in theExpression.
  43   std::list<std::pair<int, int> > positions(const std::string& theExpression,
  44                                             const std::string& theName);
  45   /// Compiles theExpression and returns a list of parameters used in theExpression.
  46   std::list<std::string> compile(const std::string& theExpression);
  47   /// Extends local context with the list of parameters.
  48   void extendLocalContext(const std::list<std::string>& theParameters);
  49   /// Clears local context.
  50   void clearLocalContext();
  51   /// Evaluates theExpression and returns its value.
  52   double evaluate(const std::string& theExpression, std::string& theError);
  53
  54  protected:
  55   /// Returns error message.
  56   std::string errorMessage();
  57   /// Overrides PyInterp_Interp.
  58   virtual bool initContext();
  59   /// Reimplemented from PyInterp_Interp::closeContext().
  60   virtual void closeContext();
  61 };
  62
  63 #endif /* INITIALIZATIONPLUGIN_PYINTERP_H_ */