src/runtime_swig/SALOMERuntime.i

   1 // Copyright (C) 2006-2024  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 // ----------------------------------------------------------------------------
  21 //
  22 %define SALOMEDOCSTRING
  23 "Implementation of nodes for SALOME platform."
  24 %enddef
  25
  26 %module(directors="1",docstring=SALOMEDOCSTRING) SALOMERuntime
  27
  28 //work around SWIG bug #1863647
  29 #if SWIG_VERSION >= 0x010336
  30 #define SwigPyIterator SALOMERuntime_PySwigIterator
  31 #else
  32 #define PySwigIterator SALOMERuntime_PySwigIterator
  33 #endif
  34
  35 %feature("autodoc", "1");
  36
  37 %include engtypemaps.i
  38
  39 #ifdef DOXYGEN_IS_OK
  40 %include docruntime.i
  41 #endif
  42
  43 // ----------------------------------------------------------------------------
  44
  45 %{
  46 #include "SalomeContainer.hxx"
  47 #include "SalomeHPContainer.hxx"
  48 #include "RuntimeSALOME.hxx"
  49 #include "SALOMEDispatcher.hxx"
  50 #include "SalomeProc.hxx"
  51 #include "PythonNode.hxx"
  52 #include "PythonPorts.hxx"
  53 #include "PresetNode.hxx"
  54 #include "PresetPorts.hxx"
  55 #include "CORBANode.hxx"
  56 #include "CORBAPorts.hxx"
  57 #include "StudyNodes.hxx"
  58 #include "StudyPorts.hxx"
  59 #include "TypeConversions.hxx"
  60 #include "TypeCode.hxx"
  61 #include "VisitorSaveSalomeSchema.hxx"
  62 #include "VisitorSalomeSaveState.hxx"
  63 #include "SalomeOptimizerLoop.hxx"
  64 #include "DistributedPythonNode.hxx"
  65 #include "PyOptimizerAlg.hxx"
  66 #include "PyStdout.hxx"
  67 #include "ExecutorSwig.hxx"
  68 #include <sstream>
  69 #include "Catalog.hxx"
  70 #include "ThreadLauncher.hxx"
  71 %}
  72
  73 // ----------------------------------------------------------------------------
  74
  75 %init
  76 %{
  77   // init section
  78
  79   PyObject* omnipy = PyImport_ImportModule((char*)"_omnipy");
  80   if (!omnipy)
  81   {
  82     PyErr_SetString(PyExc_ImportError,(char*)"Cannot import _omnipy");
  83     return NULL;
  84   }
  85   PyObject* pyapi = PyObject_GetAttrString(omnipy, (char*)"API");
  86   api = (omniORBpyAPI*)PyCapsule_GetPointer(pyapi,"_omnipy.API");
  87   Py_DECREF(pyapi);
  88 %}
  89
  90 %{
  91 static PyObject *convertContainer2(YACS::ENGINE::Container *cont, int owner=0)
  92 {
  93   if(!cont)
  94     return SWIG_NewPointerObj((void*)cont,SWIGTYPE_p_YACS__ENGINE__Container, owner);
  95   if(dynamic_cast<YACS::ENGINE::SalomeHPContainer *>(cont))
  96     {
  97       return SWIG_NewPointerObj((void*)dynamic_cast<YACS::ENGINE::SalomeHPContainer *>(cont),SWIGTYPE_p_YACS__ENGINE__SalomeHPContainer, owner);
  98     }
  99   if(dynamic_cast<YACS::ENGINE::SalomeContainer *>(cont))
 100     {
 101       return SWIG_NewPointerObj((void*)dynamic_cast<YACS::ENGINE::SalomeContainer *>(cont),SWIGTYPE_p_YACS__ENGINE__SalomeContainer, owner);
 102     }
 103   return SWIG_NewPointerObj((void*)cont,SWIGTYPE_p_YACS__ENGINE__Container, owner);
 104 }
 105 %}
 106
 107 // ----------------------------------------------------------------------------
 108
 109 #ifdef SWIGPYTHON
 110 %typemap(out) YACS_ORB::Observer_ptr
 111 {
 112   $result = api->cxxObjRefToPyObjRef($1, 1);
 113 }
 114
 115 %typemap(in) YACS_ORB::Observer_ptr
 116 {
 117   try
 118   {
 119      CORBA::Object_ptr obj = api->pyObjRefToCxxObjRef($input,1);
 120      $1 = YACS_ORB::Observer::_narrow(obj);
 121   }
 122   catch (...)
 123   {
 124      PyErr_SetString(PyExc_RuntimeError, "not a valid CORBA object ptr");
 125      return NULL;
 126   }
 127 }
 128
 129 %typemap(out) YACS::ENGINE::PyObj * "Py_INCREF($1); $result = $1;";
 130
 131 #endif
 132
 133 // ----------------------------------------------------------------------------
 134
 135 %import "pilot.i"
 136
 137 %rename(getSALOMERuntime) YACS::ENGINE::getSALOMERuntime; // to suppress a 503 warning
 138 %ignore omniORBpyAPI;
 139
 140 %include <YACSRuntimeSALOMEExport.hxx>
 141 %include "SalomeContainer.hxx"
 142 %include "SalomeHPContainer.hxx"
 143 %include "RuntimeSALOME.hxx"
 144 %include "SALOMEDispatcher.hxx"
 145 %include "SalomeProc.hxx"
 146 %include "PythonNode.hxx"
 147 %include "PythonPorts.hxx"
 148 %include "XMLPorts.hxx"
 149 %include "PresetNode.hxx"
 150 %include "PresetPorts.hxx"
 151 %include "CORBANode.hxx"
 152 %include "CORBAPorts.hxx"
 153 %include "StudyNodes.hxx"
 154 %include "StudyPorts.hxx"
 155 %include "SalomeOptimizerLoop.hxx"
 156 %include "DistributedPythonNode.hxx"
 157
 158 namespace YACS
 159 {
 160   namespace ENGINE
 161   {
 162     void schemaSaveState(Proc* proc,
 163                          Executor* exec,
 164                          const std::string& xmlSchemaFile);
 165     void schemaSaveStateUnsafe(Proc* proc, const std::string& xmlSchemaFile);
 166
 167     void VisitorSaveSalomeSchemaUnsafe(Proc* proc, const std::string& xmlSchema);
 168   }
 169 }
 170
 171
 172 %extend YACS::ENGINE::OutputPresetPort
 173 {
 174   void setDataPy(PyObject *ob)
 175   {
 176     std::string sss = convertPyObjectXml(self->edGetType(),ob);
 177     self->setData(sss);
 178   }
 179 }
 180
 181
 182 // Define the methods that can (default) or cannot (nodirector) be overloaded in Python
 183 %feature("director") YACS::ENGINE::PyOptimizerAlgBase;
 184 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::getTCForInProxy;
 185 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::getTCForOutProxy;
 186 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::initializeProxy;
 187 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::startProxy;
 188 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::takeDecisionProxy;
 189 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::finishProxy;
 190 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::hasError;
 191 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::getError;
 192 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::setError;
 193 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::getTCForAlgoInitProxy;
 194 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::getTCForAlgoResultProxy;
 195 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::getAlgoResultProxy;
 196 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgBase::setProc;
 197
 198 %feature("director") YACS::ENGINE::PyOptimizerAlgASync;
 199 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::getTCForInProxy;
 200 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::getTCForOutProxy;
 201 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::initializeProxy;
 202 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::startProxy;
 203 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::takeDecisionProxy;
 204 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::finishProxy;
 205 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::hasError;
 206 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::getError;
 207 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::setError;
 208 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::signalMasterAndWait;
 209 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::signalSlaveAndWait;
 210 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::start;
 211 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::takeDecision;
 212 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::run;
 213 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::getTCForAlgoInitProxy;
 214 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::getTCForAlgoResultProxy;
 215 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::getAlgoResultProxy;
 216 %feature("nodirector") YACS::ENGINE::PyOptimizerAlgASync::setProc;
 217
 218 %feature("director:except") {
 219     if ($error != NULL) {
 220         std::string errorMessage;
 221         PyObject* new_stderr = YACS::ENGINE::newPyStdOut(errorMessage);
 222         PySys_SetObject((char*)"stderr", new_stderr);
 223         PyErr_Print();
 224         PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
 225         Py_DECREF(new_stderr);
 226         throw YACS::Exception(errorMessage);
 227     }
 228 }
 229
 230 // Warning: as PyOptimizerAlgSync is only a typedef in PyOptimizerAlg.hxx, we have to
 231 // directly rename PyOptimizerAlgBase in OptimizerAlgSync. If someday PyOptimizerAlgSync
 232 // becomes a real derived class, this will have to be changed.
 233 %rename(OptimizerAlgSync) YACS::ENGINE::PyOptimizerAlgBase;
 234 %rename(OptimizerAlgASync) YACS::ENGINE::PyOptimizerAlgASync;
 235
 236 %include "PyOptimizerAlg.hxx"
 237
 238 %newobject YACS::ENGINE::RuntimeSALOME::createAnyPyObject;
 239
 240 %extend YACS::ENGINE::RuntimeSALOME
 241 {
 242   PyObject *createContainer(const std::string& kind="")
 243   {
 244     YACS::ENGINE::Container *ret(self->createContainer(kind));
 245     return convertContainer2(ret,SWIG_POINTER_OWN | 0);
 246   }
 247
 248   Any* createAnyPyObject(PyObject * pyobj)
 249   {
 250     return convertPyObjectNeutral(self->getBuiltinCatalog()->_typeMap["pyobj"],
 251                                   pyobj);
 252   }
 253 }
 254
 255 namespace YACS
 256 {
 257   namespace ENGINE
 258   {
 259     class YACSLIBENGINE_EXPORT ThreadDumpState
 260     {
 261     public:
 262       ThreadDumpState(Proc *proc, int nbSeconds, const std::string& dumpFile, const std::string& lockFile);
 263       ~ThreadDumpState();
 264       void start();
 265       void join();
 266     };
 267   }
 268 }