src/SALOME_PYQT/SALOME_PYQT_GUILight/SALOME_PYQT_PyModule.cxx

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   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 // File   : SALOME_PYQT_PyModule.cxx
  21 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
  22 //
  23
  24 #include "SALOME_PYQT_PyModule.h"
  25 #include "SALOME_PYQT_PyInterp.h"
  26
  27 #include "LightApp_Application.h"
  28 #include "LightApp_DataObject.h"
  29 #include "LightApp_Module.h"
  30 #include "LightApp_Study.h"
  31 #include "PyInterp_Dispatcher.h"
  32 #include "QtxActionMenuMgr.h"
  33 #include "QtxWorkspace.h"
  34 #include "QtxWorkstack.h"
  35 #include "STD_MDIDesktop.h"
  36 #include "STD_TabDesktop.h"
  37 #include "SUITApp_init_python.hxx"
  38 #include "SUIT_ResourceMgr.h"
  39 #include "SUIT_ViewManager.h"
  40 #include "SUIT_ViewModel.h"
  41 #include "SUIT_ViewWindow.h"
  42
  43 #include <QApplication>
  44 #include <QDomDocument>
  45 #include <QDomElement>
  46 #include <QDomNode>
  47 #include <QFile>
  48 #include <QMenu>
  49 #include <QMutex>
  50
  51 #include <utilities.h>
  52
  53 #include "sipAPISalomePyQtGUILight.h"
  54
  55 /*!
  56   \brief Default menu group number.
  57   \internal
  58 */
  59 const int DEFAULT_GROUP = 40;
  60
  61 /*!
  62   \brief Mutex used to lock access from several threads to the shared
  63   (static) data
  64   \internal
  65 */
  66 QMutex myInitMutex;
  67
  68 /*! DEBUG mode */
  69 const bool DEBUG = false;
  70
  71 /*!
  72   \var IsCallOldMethods
  73   \brief Allow calling obsolete callback methods.
  74   \internal
  75
  76   If the macro CALL_OLD_METHODS is not defined, the invoking
  77   of obsolete Python module's methods like setSetting(), definePopup(),
  78   etc. is blocked.
  79
  80   CALL_OLD_METHODS macro can be defined, for example, by adding
  81   -DCALL_OLD_METHODS compilation option to the CMakeLists.txt.
  82 */
  83 #ifdef CALL_OLD_METHODS
  84 const bool IsCallOldMethods = true;
  85 #else
  86 const bool IsCallOldMethods = false;
  87 #endif
  88
  89 /*!
  90   \brief Get tag name for the DOM element.
  91   \internal
  92   \param element DOM element
  93   \return tag name or empty string if the element does not have tag name
  94 */
  95 static QString tagName( const QDomElement& element )
  96 {
  97   return element.tagName().trimmed();
  98 }
  99
 100 /*!
 101   \brief Get value of DOM element's attribute.
 102   \internal
 103   \param element DOM element
 104   \param attName attribute name
 105   \return attribute value or empty string if the element does not have such attribute
 106 */
 107 static QString attribute( const QDomElement& element, const QString& attName )
 108 {
 109   return element.attribute( attName ).trimmed();
 110 }
 111
 112 /*!
 113   \brief Inspect specified string for the boolean value.
 114   \internal
 115
 116   This function returns \c true if string represents boolean value:
 117   - "true", "yes" or "1" for \c true
 118   - "false", "no" or "0" for \c false
 119   Second parameter allows to specify what boolean value is expected:
 120   - 1: \c true
 121   - 0: \c false
 122   - other value is not taken into account (return represented value)
 123
 124   \param value inspected string
 125   \param check expected boolean value
 126   \return boolean value represented by the string (\a check is not 1 or 0)
 127           or \c true if value correspond to the specified \a check
 128 */
 129 static bool checkBool( const QString& value, const int check = -1 )
 130 {
 131   QString v = value.toLower();
 132   if ( ( v == "true"  || v == "yes" || v == "1" ) && ( check != 0 ) )
 133     return true;
 134   if ( ( v == "false" || v == "no"  || v == "0" ) && ( check == 0 ) )
 135     return true;
 136   return false;
 137 }
 138
 139 /*!
 140   \brief Inspect specified string for the integer value.
 141   \internal
 142
 143   This function returns returns -1 if item is empty or represents
 144   an invalid number.
 145   \param value inspected string
 146   \param def default value
 147   \param shift shift value (it is added to the integer value to produce shifted result)
 148 */
 149 static int checkInt( const QString& value, const int def = -1, const int shift = -1 )
 150 {
 151   bool bOk;
 152   int val = value.toInt( &bOk );
 153   if ( !bOk ) val = def;
 154   if ( shift > 0 && bOk && val < 0 )
 155     val += shift;
 156   return val;
 157 }
 158
 159 /*!
 160   \class FuncMsg
 161   \brief Function call in/out tracer.
 162   \internal
 163 */
 164
 165 class FuncMsg
 166 {
 167 public:
 168   FuncMsg( const QString& funcName )
 169   {
 170     myName = funcName;
 171     if ( DEBUG )
 172       MESSAGE( qPrintable( myName ) << " [ begin ]" );
 173   }
 174   ~FuncMsg()
 175   {
 176     if ( DEBUG )
 177       MESSAGE( qPrintable( myName ) << " [ end ]" );
 178   }
 179   void message( const QString& msg )
 180   {
 181     if ( DEBUG )
 182       MESSAGE( qPrintable( myName ) << " : " << qPrintable( msg ) );
 183   }
 184 private:
 185   QString myName;
 186 };
 187
 188 /*!
 189   \class PyModuleHelper::InitLocker
 190   \brief Initialization locker
 191   \internal
 192 */
 193
 194 class PyModuleHelper::InitLocker
 195 {
 196 public:
 197   InitLocker( LightApp_Module* );
 198   ~InitLocker();
 199 };
 200
 201 /*!
 202   \brief Constructor
 203   \internal
 204 */
 205 PyModuleHelper::InitLocker::InitLocker( LightApp_Module* module )
 206 {
 207   QMutexLocker ml( &myInitMutex );
 208   myInitModule = module;
 209 }
 210
 211 /*!
 212   \brief Destructor
 213   \internal
 214 */
 215 PyModuleHelper::InitLocker::~InitLocker()
 216 {
 217   QMutexLocker ml( &myInitMutex );
 218   myInitModule = 0;
 219 }
 220
 221 /*!
 222   \class PyModuleHelper::XmlHandler
 223   \brief XML resource files parser.
 224   \internal
 225
 226   This class is used to provide backward compatibility with
 227   existing Python modules in which obsolete menu definition system
 228   (via XML files) is used.
 229 */
 230
 231 class PyModuleHelper::XmlHandler
 232 {
 233 public:
 234   XmlHandler( PyModuleHelper* helper, const QString& fileName );
 235   void             createActions();
 236   void             createPopup( QMenu* menu,
 237                                 const QString& context,
 238                                 const QString& parent,
 239                                 const QString& object );
 240   void             activateMenus( bool );
 241
 242 private:
 243   LightApp_Module* module() const;
 244   QIcon            loadIcon( const QString& fileName );
 245
 246   void             createMenu( QDomNode& parentNode,
 247                                const int parentMenuId = -1,
 248                                QMenu* parentPopup = 0 );
 249   void             createToolBar( QDomNode& parentNode );
 250   void             insertPopupItems( QDomNode& parentNode,
 251                                      QMenu* menu );
 252
 253 private:
 254   PyModuleHelper*  myHelper;
 255   QDomDocument     myDoc;
 256   QList<int>       myMenuItems;
 257 };
 258
 259
 260 /*!
 261   \brief Constructor
 262   \internal
 263   \param module pointer to the GUI module
 264   \param fileName path to the XML menu description file
 265 */
 266 PyModuleHelper::XmlHandler::XmlHandler( PyModuleHelper*  helper,
 267                                         const QString&   fileName )
 268 : myHelper( helper )
 269 {
 270   if ( !fileName.isEmpty() ) {
 271     QFile aFile( fileName );
 272     if ( aFile.open( QIODevice::ReadOnly ) ) {
 273       myDoc.setContent( &aFile );
 274     }
 275   }
 276 }
 277
 278 /*!
 279   \brief Parse XML file and create actions.
 280   \internal
 281
 282   Called by PyModuleHelper::initialize() in order to create actions
 283   (menus, toolbars).
 284 */
 285 void PyModuleHelper::XmlHandler::createActions()
 286 {
 287   // get document element
 288   QDomElement aDocElem = myDoc.documentElement();
 289
 290   // create main menu actions
 291   QDomNodeList aMenuList = aDocElem.elementsByTagName( "menu-item" );
 292   for ( int i = 0; i < aMenuList.count(); i++ ) {
 293     QDomNode n = aMenuList.item( i );
 294     createMenu( n );
 295   }
 296
 297   // create toolbars actions
 298   QDomNodeList aToolsList = aDocElem.elementsByTagName( "toolbar" );
 299   for ( int i = 0; i < aToolsList.count(); i++ ) {
 300     QDomNode n = aToolsList.item( i );
 301     createToolBar( n );
 302   }
 303 }
 304
 305 /*!
 306   \brief Create popup menu.
 307   \internal
 308   \param menu popup menu
 309   \param context popup menu context
 310   \param context popup menu parent object name
 311   \param context popup menu object name
 312 */
 313 void PyModuleHelper::XmlHandler::createPopup( QMenu*         menu,
 314                                               const QString& context,
 315                                               const QString& parent,
 316                                               const QString& object )
 317 {
 318   // get document element
 319   QDomElement aDocElem = myDoc.documentElement();
 320
 321   // get popup menus actions
 322   QDomNodeList aPopupList = aDocElem.elementsByTagName( "popupmenu" );
 323   for ( int i = 0; i < aPopupList.count(); i++ ) {
 324     QDomNode n = aPopupList.item( i );
 325     if ( !n.isNull() && n.isElement() ) {
 326       QDomElement e = n.toElement();
 327       // QString lab = attribute( e, "label-id" ); // not used //
 328       QString ctx = attribute( e, "context-id" );
 329       QString prt = attribute( e, "parent-id"  );
 330       QString obj = attribute( e, "object-id"  );
 331       if ( ctx == context && prt == parent && obj == object )  {
 332         insertPopupItems( n, menu );
 333         break;
 334       }
 335     }
 336   }
 337 }
 338
 339 /*!
 340   \brief Activate/deactivate menus
 341   \internal
 342   \param enable if \c true menus are activated, otherwise menus are deactivated
 343 */
 344 void PyModuleHelper::XmlHandler::activateMenus( bool enable )
 345 {
 346   if ( module() ) {
 347     QtxActionMenuMgr* mgr = module()->menuMgr();
 348     foreach( int id, myMenuItems ) mgr->setEmptyEnabled( id, enable );
 349   }
 350 }
 351
 352 /*!
 353   \brief Get owner module
 354 */
 355 LightApp_Module* PyModuleHelper::XmlHandler::module() const
 356 {
 357   return myHelper->module();
 358 }
 359
 360 /*!
 361   \brief Load an icon from the module resources by the specified file name.
 362   \param fileName icon file name
 363   \return icon object
 364 */
 365
 366 QIcon PyModuleHelper::XmlHandler::loadIcon( const QString& fileName )
 367 {
 368   QIcon icon;
 369
 370   if ( module() && !fileName.isEmpty() ) {
 371       SUIT_ResourceMgr* resMgr = module()->getApp()->resourceMgr();
 372       QPixmap pixmap = resMgr->loadPixmap( module()->name(),
 373           QApplication::translate( module()->name().toLatin1().data(),
 374                                    fileName.toLatin1().data() ) );
 375       if ( !pixmap.isNull() )
 376         icon = QIcon( pixmap );
 377   }
 378
 379   return icon;
 380 }
 381
 382 /*!
 383   \brief Create main menu item and insert actions to it.
 384   \internal
 385   \param parentNode XML node with menu description
 386   \param parentMenuId parent menu ID (-1 for top-level menu)
 387   \param parentPopup parent popup menu (0 for top-level menu)
 388 */
 389 void PyModuleHelper::XmlHandler::createMenu( QDomNode& parentNode,
 390                                              const int parentMenuId,
 391                                              QMenu*    parentPopup )
 392 {
 393   if ( !module() || parentNode.isNull() )
 394     return;
 395
 396   QDomElement parentElement = parentNode.toElement();
 397   if ( !parentElement.isNull() ) {
 398     QString plabel = attribute( parentElement, "label-id" );
 399     int     pid    = checkInt( attribute( parentElement, "item-id" ) );
 400     int     ppos   = checkInt( attribute( parentElement, "pos-id" ) );
 401     int     group  = checkInt( attribute( parentElement, "group-id" ),
 402                                PyModuleHelper::defaultMenuGroup() );
 403     if ( !plabel.isEmpty() ) {
 404       QMenu* popup = 0;
 405       int menuId = -1;
 406       // create menu
 407       menuId = module()->createMenu( plabel,         // label
 408                                      parentMenuId,   // parent menu ID, -1 for top-level menu
 409                                      pid,            // ID
 410                                      group,          // group ID
 411                                      ppos );         // position
 412       myMenuItems.append( menuId );
 413       QDomNode node = parentNode.firstChild();
 414       while ( !node.isNull() ) {
 415         if ( node.isElement() ) {
 416           QDomElement elem = node.toElement();
 417           QString aTagName = tagName( elem );
 418           if ( aTagName == "popup-item" ) {
 419             int     id      = checkInt( attribute( elem, "item-id" ) );
 420             int     pos     = checkInt( attribute( elem, "pos-id" ) );
 421             int     group   = checkInt( attribute( elem, "group-id" ),
 422                                         PyModuleHelper::defaultMenuGroup() );
 423             QString label   = attribute( elem, "label-id" );
 424             QIcon   icon    = loadIcon( attribute( elem, "icon-id" ) );
 425             QString tooltip = attribute( elem, "tooltip-id" );
 426             QString accel   = attribute( elem, "accel-id" );
 427             bool    toggle  = checkBool( attribute( elem, "toggle-id" ) );
 428
 429             // -1 action ID is not allowed : it means that <item-id> attribute is missed in the XML file!
 430             // also check if the action with given ID is already created
 431             if ( id != -1 ) {
 432               // create menu action
 433               QAction* action = module()->createAction( id,                     // ID
 434                                                         tooltip,                // tooltip
 435                                                         icon,                   // icon
 436                                                         label,                  // menu text
 437                                                         tooltip,                // status-bar text
 438                                                         QKeySequence( accel ),  // keyboard accelerator
 439                                                         module(),               // action owner
 440                                                         toggle );               // toogled action
 441               myHelper->connectAction( action );
 442               module()->createMenu( action,   // action
 443                                     menuId,   // parent menu ID
 444                                     id,       // ID (same as for createAction())
 445                                     group,    // group ID
 446                                     pos );    // position
 447             }
 448           }
 449           else if ( aTagName == "submenu" ) {
 450             // create sub-menu
 451             createMenu( node, menuId, popup );
 452           }
 453           else if ( aTagName == "separator" ) {
 454             // create menu separator
 455             int id    = checkInt( attribute( elem, "item-id" ) ); // separator can have ID
 456             int pos   = checkInt( attribute( elem, "pos-id" ) );
 457             int group = checkInt( attribute( elem, "group-id" ),
 458                                   PyModuleHelper::defaultMenuGroup() );
 459             QAction* action = module()->separator();
 460             module()->createMenu( action,  // separator action
 461                                   menuId,  // parent menu ID
 462                                   id,      // ID
 463                                   group,   // group ID
 464                                   pos );   // position
 465           }
 466         }
 467         node = node.nextSibling();
 468       }
 469     }
 470   }
 471 }
 472
 473 /*!
 474   \brief Create a toolbar and insert actions to it.
 475   \param parentNode XML node with toolbar description
 476 */
 477 void PyModuleHelper::XmlHandler::createToolBar( QDomNode& parentNode )
 478 {
 479   if ( !module() || parentNode.isNull() )
 480     return;
 481
 482   QDomElement parentElement = parentNode.toElement();
 483   if ( !parentElement.isNull() ) {
 484     QString aLabel = attribute( parentElement, "label-id" );
 485     QString aName  = attribute( parentElement, "name-id" );
 486     if ( !aLabel.isEmpty() ) {
 487       // create toolbar
 488       int tbId = module()->createTool( aLabel, aName );
 489       QDomNode node = parentNode.firstChild();
 490       while ( !node.isNull() ) {
 491         if ( node.isElement() ) {
 492           QDomElement elem = node.toElement();
 493           QString aTagName = tagName( elem );
 494           if ( aTagName == "toolbutton-item" ) {
 495             int     id      = checkInt( attribute( elem, "item-id" ) );
 496             int     pos     = checkInt( attribute( elem, "pos-id" ) );
 497             QString label   = attribute( elem, "label-id" );
 498             QIcon   icon    = loadIcon( attribute( elem, "icon-id" ) );
 499             QString tooltip = attribute( elem, "tooltip-id" );
 500             QString accel   = attribute( elem, "accel-id" );
 501             bool    toggle  = checkBool( attribute( elem, "toggle-id" ) );
 502
 503             // -1 action ID is not allowed : it means that <item-id> attribute is missed in the XML file!
 504             // also check if the action with given ID is already created
 505             if ( id != -1 ) {
 506                 // create toolbar action
 507                 QAction* action = module()->createAction( id,                     // ID
 508                                                           tooltip,                // tooltip
 509                                                           icon,                   // icon
 510                                                           label,                  // menu text
 511                                                           tooltip,                // status-bar text
 512                                                           QKeySequence( accel ),  // keyboard accelerator
 513                                                           module(),               // action owner
 514                                                           toggle );               // toogled action
 515                 myHelper->connectAction( action );
 516                 module()->createTool( action, tbId, -1, pos );
 517             }
 518           }
 519           else if ( aTagName == "separatorTB" || aTagName == "separator" ) {
 520             // create toolbar separator
 521             int pos = checkInt( attribute( elem, "pos-id" ) );
 522             QAction* action = module()->separator();
 523             module()->createTool( action, tbId, -1, pos );
 524           }
 525         }
 526         node = node.nextSibling();
 527       }
 528     }
 529   }
 530 }
 531
 532 /*!
 533   \brief Fill popup menu with the items.
 534   \param parentNode XML node with popup menu description
 535   \param menu popup menu
 536 */
 537 void PyModuleHelper::XmlHandler::insertPopupItems( QDomNode& parentNode, QMenu* menu )
 538 {
 539   if ( !module() && parentNode.isNull() )
 540     return;
 541
 542   // we create popup menus without help of QtxPopupMgr
 543   QDomNode node = parentNode.firstChild();
 544   while ( !node.isNull() ) {
 545     if ( node.isElement() ) {
 546       QDomElement elem = node.toElement();
 547       QString aTagName = tagName( elem );
 548       QList<QAction*> actions = menu->actions();
 549       if ( aTagName == "popup-item" ) {
 550         // insert a command item
 551         int     id      = checkInt( attribute( elem, "item-id" ) );
 552         int     pos     = checkInt( attribute( elem, "pos-id" ) );
 553         QString label   = attribute( elem, "label-id" );
 554         QIcon   icon    = loadIcon( attribute( elem, "icon-id" ) );
 555         QString tooltip = attribute( elem, "tooltip-id" );
 556         QString accel   = attribute( elem, "accel-id" );
 557         bool    toggle  = checkBool( attribute( elem, "toggle-id" ) );
 558
 559         // -1 action ID is not allowed : it means that <item-id> attribute is missed in the XML file!
 560         // also check if the action with given ID is already created
 561         if ( id != -1 ) {
 562           QAction* action = module()->createAction( id,                     // ID
 563                                                     tooltip,                // tooltip
 564                                                     icon,                   // icon
 565                                                     label,                  // menu text
 566                                                     tooltip,                // status-bar text
 567                                                     QKeySequence( accel ),  // keyboard accelerator
 568                                                     module(),               // action owner
 569                                                     toggle );               // toogled action
 570           myHelper->connectAction( action );
 571           QAction* before = ( pos >= 0 && pos < actions.count() ) ? actions[ pos ] : 0;
 572           menu->insertAction( before, action );
 573         }
 574       }
 575       else if ( aTagName == "submenu" ) {
 576         // create sub-menu
 577         ////int     id    = checkInt( attribute( elem, "item-id" ) ); // not used //
 578         int     pos   = checkInt( attribute( elem, "pos-id" ) );
 579         QString label = attribute( elem, "label-id" );
 580         QString icon  = attribute( elem, "icon-id" );
 581
 582         QIcon anIcon;
 583         if ( !icon.isEmpty() ) {
 584           QPixmap pixmap  = module()->getApp()->resourceMgr()->loadPixmap( module()->name(), icon );
 585           if ( !pixmap.isNull() )
 586             anIcon = QIcon( pixmap );
 587         }
 588
 589         QMenu* newPopup = menu->addMenu( anIcon, label );
 590         QAction* before = ( pos >= 0 && pos < actions.count() ) ? actions[ pos ] : 0;
 591         menu->insertMenu( before, newPopup );
 592         insertPopupItems( node, newPopup );
 593       }
 594       else if ( aTagName == "separator" ) {
 595         // create menu separator
 596         int pos = checkInt( attribute( elem, "pos-id" ) );
 597         QAction* action = module()->separator();
 598         QAction* before = ( pos >= 0 && pos < actions.count() ) ? actions[ pos ] : 0;
 599         menu->insertAction( before, action );
 600       }
 601     }
 602     node = node.nextSibling();
 603   }
 604 }
 605
 606 /*!
 607   \class PyModuleHelper
 608   \brief This class implements API helper for all the Python-based
 609   SALOME GUI modules.
 610 */
 611
 612 PyModuleHelper::InterpMap PyModuleHelper::myInterpMap;
 613 LightApp_Module*          PyModuleHelper::myInitModule = 0;
 614
 615 /*!
 616   \brief Constructor
 617   \param module owner module
 618 */
 619 PyModuleHelper::PyModuleHelper( LightApp_Module* module ) :
 620   QObject( module ),
 621   myModule( module ),
 622   myPyModule( 0 ),
 623   myInterp( 0 ),
 624   myXmlHandler ( 0 ),
 625   myLastActivateStatus( true )
 626 {
 627   setObjectName( "python_module_helper" );
 628 }
 629
 630 /*!
 631   \brief Destructor
 632 */
 633 PyModuleHelper::~PyModuleHelper()
 634 {
 635   delete myXmlHandler;
 636   if ( myInterp && myPyModule ) {
 637     PyLockWrapper aLock; // Acquire GIL
 638     Py_XDECREF( myPyModule );
 639   }
 640 }
 641
 642 /*!
 643   \brief Get the module being initialized.
 644
 645   This is a little trick :) needed to provide an access from Python
 646   (SalomePyQt) to the module being currently activated. The problem
 647   that during the process of module initialization (initialize()
 648   function) it is not yet available via application->activeModule()
 649   call.
 650
 651   This method returns valid pointer only if called in scope of
 652   initialize() function or in several other specific cases.
 653
 654   \return the module being currently initialized
 655 */
 656 LightApp_Module* PyModuleHelper::getInitModule()
 657 {
 658   QMutexLocker ml( &myInitMutex );
 659   return myInitModule;
 660 }
 661
 662 /*!
 663   \brief Get default menu group identifier
 664   \return menu group ID (40 by default)
 665 */
 666 int PyModuleHelper::defaultMenuGroup()
 667 {
 668   return DEFAULT_GROUP;
 669 }
 670
 671 /*!
 672   \brief Get owner module
 673   \return owner module
 674 */
 675 LightApp_Module* PyModuleHelper::module() const
 676 {
 677   return myModule;
 678 }
 679
 680 /*!
 681   \brief Get Python GUI module object
 682   \return python module
 683 */
 684 PyObject* PyModuleHelper::pythonModule() const
 685 {
 686   return myPyModule;
 687 }
 688
 689 /*!
 690   \brief Connect action to the internal actionActivated() slot.
 691
 692   Actions connected to internal actionActivated(), when activated, will
 693   be forwarded to the Python GUI module OnGUIEvent() function.
 694
 695   \param a action being connected
 696 */
 697 void PyModuleHelper::connectAction( QAction* a )
 698 {
 699   if ( myModule && a )
 700     QObject::connect( a, SIGNAL( triggered( bool ) ),
 701                       this, SLOT( actionActivated() ),
 702                       Qt::UniqueConnection );
 703 }
 704
 705 /*!
 706   \brief Get the dockable windows associated with the module.
 707
 708   To fill the list of windows the correspondind Python module's windows()
 709   method is called during the module initialization.
 710
 711   By default, ObjectBrowser, PythonConsole and LogWindow windows are
 712   associated to the module.
 713
 714   Allowed dockable windows:
 715   - LightApp_Application::WT_ObjectBrowser : object browser
 716   - LightApp_Application::WT_PyConsole : python console
 717   - LightApp_Application::WT_LogWindow : log messages output window
 718
 719   Dock area is defined by Qt::DockWidgetArea enumeration:
 720   - Qt::TopDockWidgetArea : top dock area
 721   - Qt::BottomDockWidgetArea : bottom dock area
 722   - Qt::LeftDockWidgetArea : left dock area
 723   - Qt::RightDockWidgetArea : right dock area
 724
 725   \return map of dockable windows in form { <window_type> : <dock_area> }
 726 */
 727 QMap<int, int> PyModuleHelper::windows() const
 728 {
 729   FuncMsg fmsg( "PyModuleHelper::windows()" );
 730
 731   return myWindowsMap;
 732 }
 733
 734 /*!
 735   \brief Define the compatible view windows associated with the module.
 736
 737   The associated view windows are opened automatically when the module
 738   is activated.
 739
 740   To fill the list of views the correspondind Python module's views()
 741   method is called during the module initialization.
 742   By default, the list of view types is empty.
 743
 744   \return list of view windows types
 745 */
 746 QStringList PyModuleHelper::viewManagers() const
 747 {
 748   FuncMsg fmsg( "PyModuleHelper::viewManagers()" );
 749
 750   return myViewMgrList;
 751 }
 752
 753 /*!
 754   \brief Initialization of the Python-based SALOME module.
 755
 756   This method can be used for creation of the menus, toolbars and
 757   other such stuff.
 758
 759   There are two ways to do this:
 760   1) for obsolete modules, the implementation of this method first tries to read
 761   the <module>_<language>.xml resource file which contains a menu,
 762   toolbars and popup menus description;
 763   2) new modules can create menus by direct calling of the
 764   corresponding methods of SalomePyQt Python API in the Python
 765   module's initialize() method which is called from here.
 766
 767   \note SALOME supports two modes of modules loading:
 768   - immediate (all the modules are created and initialized
 769   immediately when the application object is created);
 770   - postponed modules loading (used currently); in this mode
 771   the module is loaded only by explicit request.
 772   If postponed modules loading is not used, the active
 773   study might be not yet defined at this stage, so initialize()
 774   method should not perform any study-based initialization.
 775   Such actions can be better done in activate() function.
 776
 777   \param app parent application object
 778 */
 779 void PyModuleHelper::initialize( CAM_Application* app )
 780 {
 781   FuncMsg fmsg( "PyModuleHelper::initialize()" );
 782
 783   // temporarily store module being currently activated
 784   // in the global variable to make it accessible from
 785   // Python API
 786   InitLocker lock( myModule );
 787
 788   // try to get XML resource file name
 789   SUIT_ResourceMgr* resMgr = myModule->getApp()->resourceMgr();
 790   if ( !myXmlHandler && resMgr ) {
 791     // get current language
 792     QString lang = resMgr->stringValue( "language", "language", "en" );
 793     // get menu description file name
 794     QString aFileName = QString( "%1_%2.xml" ).arg( myModule->name() ).arg( lang );
 795     aFileName = resMgr->path( "resources", myModule->name(), aFileName );
 796     if ( !aFileName.isEmpty() && QFile::exists( aFileName ) ) {
 797       // create XML handler instance
 798       myXmlHandler = new XmlHandler( this, aFileName );
 799       // ask XML handler to create actions
 800       myXmlHandler->createActions();
 801     }
 802   }
 803
 804   class InitializeReq : public PyInterp_Request
 805   {
 806   public:
 807     InitializeReq( PyModuleHelper*  _helper,
 808                    CAM_Application* _app )
 809       : PyInterp_Request( 0, true ), // this request should be processed synchronously (sync == true)
 810         myHelper( _helper ),
 811         myApp( _app )
 812     {}
 813   protected:
 814     virtual void execute()
 815     {
 816       myHelper->internalInitialize( myApp );
 817     }
 818   private:
 819     PyModuleHelper*  myHelper;
 820     CAM_Application* myApp;
 821   };
 822
 823   // post request
 824   PyInterp_Dispatcher::Get()->Exec( new InitializeReq( this, app ) );
 825 }
 826
 827 /*!
 828   \brief Activation of the module.
 829
 830   This function is usually used in order to show the module's
 831   specific menus and toolbars, update actions state and perform
 832   other such actions required when the module is activated.
 833
 834   \note Returning \c false from this function prevents the
 835   module activation.
 836
 837   \param study parent study
 838   \return \c true if activation is successful and \c false otherwise
 839 */
 840 bool PyModuleHelper::activate( SUIT_Study* study )
 841 {
 842   FuncMsg fmsg( "PyModuleHelper::activate()" );
 843
 844   // reset the activation status to the default value
 845   myLastActivateStatus = true;
 846
 847   class ActivateReq : public PyInterp_Request
 848   {
 849   public:
 850     ActivateReq( PyModuleHelper* _helper,
 851                  SUIT_Study*     _study,
 852                  bool            _customize )
 853   : PyInterp_Request( 0, true ), // this request should be processed synchronously (sync == true)
 854     myHelper( _helper ),
 855     myStudy ( _study ),
 856     myCustomize( _customize )
 857   {}
 858   protected:
 859     virtual void execute()
 860       {
 861         if ( !myCustomize )
 862           myHelper->internalActivate( myStudy );  // first activation stage
 863         else
 864           myHelper->internalCustomize( myStudy ); // second activation stage
 865       }
 866   private:
 867     PyModuleHelper* myHelper;
 868     SUIT_Study*     myStudy;
 869     bool            myCustomize;
 870   };
 871
 872   // post request for activation (customize=false)
 873   PyInterp_Dispatcher::Get()->Exec( new ActivateReq( this, study, false ) );
 874
 875   // check activation status (can be set to false by internalActivate())
 876   if ( myLastActivateStatus ) {
 877     // activate menus, toolbars, etc
 878     if ( myXmlHandler ) myXmlHandler->activateMenus( true );
 879
 880     // show menus / toolbars
 881     myModule->setMenuShown( true );
 882     myModule->setToolShown( true );
 883
 884     // post request for customization (customize=true)
 885     PyInterp_Dispatcher::Get()->Exec( new ActivateReq( this, study, true ) );
 886
 887     // check activation status (can be set to false by internalCustomize())
 888     if ( myLastActivateStatus ) {
 889       // connect preferences changing signal
 890       connect( myModule->getApp(), SIGNAL( preferenceChanged( const QString&, const QString&, const QString& ) ),
 891                this,               SLOT(   preferenceChanged( const QString&, const QString&, const QString& ) ) );
 892
 893       // connect active view change signal
 894       SUIT_Desktop* d = study->application()->desktop();
 895       connect( d,     SIGNAL( windowActivated( SUIT_ViewWindow* ) ),
 896                this,  SLOT( activeViewChanged( SUIT_ViewWindow* ) ) );
 897       // if active window exists, call activeViewChanged() function;
 898       // temporary solution: if a getActiveView() in SalomePyQt available
 899       // we no longer need this
 900       SUIT_ViewWindow* view = d->activeWindow();
 901       if ( view ) activeViewChanged( view );
 902       // get all view currently opened in the study and connect their signals to
 903       // the corresponding slots of the class.
 904       foreach ( view, d->windows() ) connectView( view );
 905     }
 906     else {
 907       // hide menus / toolbars in case of error
 908       myModule->setMenuShown( false );
 909       myModule->setToolShown( false );
 910     }
 911   }
 912
 913   return myLastActivateStatus;
 914 }
 915
 916 /*!
 917   \brief Deactivation of the module.
 918
 919   This function is usually used in order to hide the module's
 920   specific menus and toolbars and perform other such actions
 921   required when the module is deactivated.
 922
 923   \param study parent study
 924   \return \c true if deactivation is successful and \c false otherwise
 925 */
 926 bool PyModuleHelper::deactivate( SUIT_Study* study )
 927 {
 928   FuncMsg fmsg( "PyModuleHelper::deactivate()" );
 929
 930   class DeactivateReq : public PyInterp_LockRequest
 931   {
 932   public:
 933     DeactivateReq( PyInterp_Interp* _py_interp,
 934                    PyModuleHelper*  _helper,
 935                    SUIT_Study*      _study )
 936       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
 937         myHelper( _helper ),
 938         myStudy ( _study )
 939     {}
 940   protected:
 941     virtual void execute()
 942     {
 943       myHelper->internalDeactivate( myStudy );
 944     }
 945   private:
 946     PyModuleHelper* myHelper;
 947     SUIT_Study*     myStudy;
 948   };
 949
 950   // post request
 951   PyInterp_Dispatcher::Get()->Exec( new DeactivateReq( myInterp, this, study ) );
 952
 953   // disconnect preferences changing signal
 954   disconnect( myModule->getApp(), SIGNAL( preferenceChanged( const QString&, const QString&, const QString& ) ),
 955               this,               SLOT(   preferenceChanged( const QString&, const QString&, const QString& ) ) );
 956
 957   // disconnect the SUIT_Desktop signal windowActivated()
 958   SUIT_Desktop* d = study->application()->desktop();
 959   disconnect( d,     SIGNAL( windowActivated( SUIT_ViewWindow* ) ),
 960               this,  SLOT( activeViewChanged( SUIT_ViewWindow* ) ) );
 961
 962   // deactivate menus, toolbars, etc
 963   if ( myXmlHandler ) myXmlHandler->activateMenus( false );
 964
 965   // hide menus / toolbars
 966   myModule->setMenuShown( false );
 967   myModule->setToolShown( false );
 968
 969   return true;
 970 }
 971
 972 /*!
 973   \brief Close of the module.
 974
 975   This function is usually used in order to close the module's
 976   specific menus and toolbars and perform other such actions
 977   required when the module is closed.
 978 */
 979 void PyModuleHelper::modelClosed( SUIT_Study* study )
 980 {
 981   FuncMsg fmsg( "PyModuleHelper::modelClosed()" );
 982
 983   class StudyClosedReq : public PyInterp_LockRequest
 984   {
 985   public:
 986     StudyClosedReq( PyInterp_Interp* _py_interp,
 987                    PyModuleHelper*  _helper,
 988                    SUIT_Study*      _study )
 989       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
 990         myHelper( _helper ),
 991         myStudy ( _study )
 992     {}
 993   protected:
 994     virtual void execute()
 995     {
 996       myHelper->internalClosedStudy( myStudy );
 997     }
 998   private:
 999     PyModuleHelper* myHelper;
1000     SUIT_Study*     myStudy;
1001   };
1002
1003   // post request
1004   PyInterp_Dispatcher::Get()->Exec( new StudyClosedReq( myInterp, this, study ) );
1005
1006   // disconnect preferences changing signal
1007   disconnect( myModule->getApp(), SIGNAL( preferenceChanged( const QString&, const QString&, const QString& ) ),
1008               this,               SLOT(   preferenceChanged( const QString&, const QString&, const QString& ) ) );
1009
1010   // disconnect the SUIT_Desktop signal windowActivated()
1011   SUIT_Desktop* d = study->application()->desktop();
1012   disconnect( d,     SIGNAL( windowActivated( SUIT_ViewWindow* ) ),
1013               this,  SLOT( activeViewChanged( SUIT_ViewWindow* ) ) );
1014
1015   // deactivate menus, toolbars, etc
1016   if ( myXmlHandler ) myXmlHandler->activateMenus( false );
1017
1018   // hide menus / toolbars
1019   myModule->setMenuShown( false );
1020   myModule->setToolShown( false );
1021 }
1022
1023
1024 /*!
1025   \brief Process module's preferences changing.
1026
1027   Called when the module's own preferences are changed.
1028
1029   \param section preference resources section
1030   \param parameter preference resources parameter name
1031 */
1032 void PyModuleHelper::preferencesChanged( const QString& section,
1033                                          const QString& parameter )
1034 {
1035   FuncMsg fmsg( "PyModuleHelper::preferencesChanged()" );
1036
1037   class PrefChangeReq : public PyInterp_LockRequest
1038   {
1039   public:
1040     PrefChangeReq( PyInterp_Interp* _py_interp,
1041                    PyModuleHelper*  _helper,
1042                    const QString&   _section,
1043                    const QString&   _parameter )
1044       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1045         myHelper ( _helper ),
1046         mySection( _section ),
1047         myParameter( _parameter )
1048     {}
1049   protected:
1050     virtual void execute()
1051     {
1052       myHelper->internalPreferencesChanged( mySection, myParameter );
1053     }
1054   private:
1055     PyModuleHelper* myHelper;
1056     QString         mySection, myParameter;
1057   };
1058
1059   // post the request only if dispatcher is not busy!
1060   // execute request synchronously
1061   if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1062     PyInterp_Dispatcher::Get()->Exec( new PrefChangeReq( myInterp, this, section, parameter ) );
1063 }
1064
1065 /*!
1066   \brief Process application preferences changing.
1067
1068   Called when any application setting is changed.
1069
1070   \param module preference module
1071   \param section preference resources section
1072   \param parameter preference resources parameter name
1073 */
1074 void PyModuleHelper::preferenceChanged( const QString& module,
1075                                         const QString& section,
1076                                         const QString& parameter )
1077 {
1078   FuncMsg fmsg( "PyModuleHelper::preferenceChanged()" );
1079
1080   // module's own preferences are processed by other preferencesChanged() method
1081   if ( module != myModule->moduleName() ) {
1082     // call helper
1083     preferencesChanged( section, parameter );
1084   }
1085 }
1086
1087 /*!
1088   \brief Process study activation.
1089
1090   Called when study desktop is activated. Used for notifying the Python
1091   module about changing of the active study.
1092
1093   \param study study being activated
1094 */
1095 void PyModuleHelper::studyActivated( SUIT_Study* study )
1096 {
1097   FuncMsg fmsg( "PyModuleHelper::studyActivated()" );
1098
1099   // StudyChangedReq: request class for internal studyChanged() operation
1100   class StudyChangedReq : public PyInterp_Request
1101   {
1102   public:
1103     StudyChangedReq( PyModuleHelper* _helper,
1104                      SUIT_Study*     _study )
1105       : PyInterp_Request(0, true ), // this request should be processed synchronously (sync == true)
1106         myHelper( _helper ),
1107         myStudy ( _study )
1108     {}
1109   protected:
1110     virtual void execute()
1111     {
1112       myHelper->internalStudyChanged( myStudy );
1113     }
1114   private:
1115     PyModuleHelper* myHelper;
1116     SUIT_Study*     myStudy;
1117   };
1118
1119   // post request
1120   PyInterp_Dispatcher::Get()->Exec( new StudyChangedReq( this, study ) );
1121 }
1122
1123 /*!
1124   \brief Process action activation.
1125
1126   Called when action is activated. Used for notifying the Python
1127   module about any related action activation.
1128
1129   \sa connectAction()
1130 */
1131 void PyModuleHelper::actionActivated()
1132 {
1133   FuncMsg fmsg( "PyModuleHelper::actionActivated()" );
1134
1135   // perform synchronous request to Python event dispatcher
1136   class ActionReq : public PyInterp_LockRequest
1137   {
1138   public:
1139     ActionReq( PyInterp_Interp* _py_interp,
1140                PyModuleHelper*  _helper,
1141                int              _id )
1142       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1143         myHelper( _helper ),
1144         myId    ( _id  )
1145     {}
1146   protected:
1147     virtual void execute()
1148     {
1149       myHelper->internalActionActivated( myId );
1150     }
1151   private:
1152     PyModuleHelper* myHelper;
1153     int             myId;
1154   };
1155
1156   // get sender action
1157   QAction* action = qobject_cast<QAction*>( sender() );
1158   if ( !action )
1159     return;
1160
1161   // post request
1162   PyInterp_Dispatcher::Get()->Exec( new ActionReq( myInterp, this, myModule->actionId( action ) ) );
1163 }
1164
1165 /*!
1166   \brief update selection from other views or modules.
1167
1168   Called when selection is modified outside.
1169 */
1170 void PyModuleHelper::selectionUpdated(const QStringList& entries)
1171 {
1172   FuncMsg fmsg( "PyModuleHelper::selectionUpdated()" );
1173   MESSAGE("selectionUpdated");
1174
1175   // perform synchronous request to Python event dispatcher
1176   class SelectionReq : public PyInterp_LockRequest
1177   {
1178   public:
1179     SelectionReq( PyInterp_Interp* _py_interp,
1180                   PyModuleHelper*  _helper,
1181                   const QStringList& _entries )
1182       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1183         myHelper( _helper ),
1184         myEntries( _entries  )
1185     {
1186       MESSAGE("SelectionReq");
1187     }
1188   protected:
1189     virtual void execute()
1190     {
1191       MESSAGE("execute");
1192       myHelper->internalSelectionUpdated( myEntries );
1193     }
1194   private:
1195     PyModuleHelper* myHelper;
1196     const QStringList& myEntries;
1197   };
1198
1199   // post request
1200   PyInterp_Dispatcher::Get()->Exec( new SelectionReq( myInterp, this, entries ) );
1201 }
1202
1203 /*!
1204   \brief Process context popup menu request.
1205
1206   Called when user activates popup menu in some window
1207   (view, object browser, etc).
1208
1209   \param context popup menu context (e.g. "ObjectBrowser")
1210   \param menu popup menu
1211 */
1212 void PyModuleHelper::contextMenu( const QString& context, QMenu* menu )
1213 {
1214   FuncMsg fmsg( "PyModuleHelper::contextMenu()" );
1215
1216   class ContextMenuReq : public PyInterp_LockRequest
1217   {
1218   public:
1219     ContextMenuReq( PyInterp_Interp* _py_interp,
1220                     PyModuleHelper*  _helper,
1221                     const QString&   _context,
1222                     QMenu*           _menu )
1223       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1224         myHelper ( _helper ),
1225         myContext( _context ),
1226         myMenu   ( _menu )
1227     {}
1228   protected:
1229     virtual void execute()
1230     {
1231       myHelper->internalContextMenu( myContext, myMenu );
1232     }
1233   private:
1234     PyModuleHelper* myHelper;
1235     QString         myContext;
1236     QMenu*          myMenu;
1237   };
1238
1239   // post request only if dispatcher is not busy!
1240   // execute request synchronously
1241   if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1242     PyInterp_Dispatcher::Get()->Exec( new ContextMenuReq( myInterp, this, context, menu ) );
1243 }
1244
1245 /*!
1246   \brief Export preferences for the Python module.
1247   Called only once when the first instance of the module is created or
1248   when common Preferences dialog box is first time invoked.
1249 */
1250 void PyModuleHelper::createPreferences()
1251 {
1252   FuncMsg fmsg( "PyModuleHelper::createPreferences()" );
1253
1254   // temporary set myInitModule because createPreferences() method
1255   // might be called during the module intialization process
1256   InitLocker lock( myModule );
1257
1258   class CreatePrefReq : public PyInterp_LockRequest
1259   {
1260   public:
1261     CreatePrefReq( PyInterp_Interp* _py_interp,
1262                    PyModuleHelper*  _helper )
1263       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1264         myHelper( _helper )
1265     {}
1266   protected:
1267     virtual void execute()
1268     {
1269       myHelper->internalCreatePreferences();
1270     }
1271   private:
1272     PyModuleHelper* myHelper;
1273   };
1274
1275   // post request only if dispatcher is not busy!
1276   // execute request synchronously
1277   if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1278     PyInterp_Dispatcher::Get()->Exec( new CreatePrefReq( myInterp, this ) );
1279 }
1280
1281 /*!
1282   \brief Signal handler windowActivated(SUIT_ViewWindow*) of SUIT_Desktop
1283
1284   Used to notify Python module that active view has been changed by the user.
1285
1286   \param view view being activated
1287 */
1288 void PyModuleHelper::activeViewChanged( SUIT_ViewWindow* view )
1289 {
1290   FuncMsg fmsg( "PyModuleHelper::activeViewChanged()" );
1291
1292   // perform synchronous request to Python event dispatcher
1293   class ActiveViewChangeReq : public PyInterp_LockRequest
1294   {
1295   public:
1296     ActiveViewChangeReq( PyInterp_Interp* _py_interp,
1297                          PyModuleHelper*  _helper,
1298                          SUIT_ViewWindow* _view )
1299       : PyInterp_LockRequest( _py_interp, 0, true ),
1300         myHelper( _helper ),
1301         myView( _view )
1302     {}
1303   protected:
1304     virtual void execute()
1305     {
1306       myHelper->internalActiveViewChanged( myView );
1307     }
1308   private:
1309     PyModuleHelper*  myHelper;
1310     SUIT_ViewWindow* myView;
1311   };
1312
1313   // connect view (if it is not connected yet)
1314   connectView( view );
1315
1316   PyInterp_Dispatcher::Get()->Exec( new ActiveViewChangeReq( myInterp, this, view ) );
1317 }
1318
1319 /*!
1320   \brief Signal handler tryClose(SUIT_ViewWindow*) of a view
1321   \param view view being closed
1322 */
1323 void PyModuleHelper::tryCloseView( SUIT_ViewWindow* view )
1324 {
1325   FuncMsg fmsg( "PyModuleHelper::tryCloseView()" );
1326
1327   class TryCloseViewReq : public PyInterp_LockRequest
1328   {
1329   public:
1330     TryCloseViewReq( PyInterp_Interp* _py_interp,
1331                      PyModuleHelper*  _helper,
1332                      SUIT_ViewWindow* _view )
1333       : PyInterp_LockRequest( _py_interp, 0, true ),
1334         myHelper( _helper ),
1335         myView( _view )
1336     {}
1337   protected:
1338     virtual void execute()
1339     {
1340       myHelper->internalTryCloseView( myView );
1341     }
1342   private:
1343     PyModuleHelper*  myHelper;
1344     SUIT_ViewWindow* myView;
1345   };
1346
1347   PyInterp_Dispatcher::Get()->Exec( new TryCloseViewReq( myInterp, this, view ) );
1348 }
1349
1350 /*!
1351   \brief Signal handler closing(SUIT_ViewWindow*) of a view
1352   \param view view being closed
1353 */
1354 void PyModuleHelper::closeView( SUIT_ViewWindow* view )
1355 {
1356   FuncMsg fmsg( "PyModuleHelper::closeView()" );
1357
1358   class CloseViewReq : public PyInterp_LockRequest
1359   {
1360   public:
1361     CloseViewReq( PyInterp_Interp* _py_interp,
1362                   PyModuleHelper*  _helper,
1363                   SUIT_ViewWindow* _view )
1364       : PyInterp_LockRequest( _py_interp, 0, true ),
1365         myHelper( _helper ),
1366         myView( _view )
1367     {}
1368   protected:
1369     virtual void execute()
1370     {
1371       myHelper->internalCloseView( myView );
1372     }
1373   private:
1374     PyModuleHelper*  myHelper;
1375     SUIT_ViewWindow* myView;
1376   };
1377
1378   PyInterp_Dispatcher::Get()->Exec( new CloseViewReq( myInterp, this, view ) );
1379 }
1380
1381 /*!
1382   \brief Signal handler cloneView() of OCCViewer_ViewWindow
1383   \param view view being cloned
1384 */
1385 void PyModuleHelper::cloneView( SUIT_ViewWindow* view )
1386 {
1387   FuncMsg fmsg( "PyModuleHelper::cloneView()" );
1388
1389   class CloneViewReq : public PyInterp_LockRequest
1390   {
1391   public:
1392     CloneViewReq( PyInterp_Interp* _py_interp,
1393                   PyModuleHelper*  _helper,
1394                   SUIT_ViewWindow* _view )
1395       : PyInterp_LockRequest( _py_interp, 0, true ),
1396         myHelper( _helper ),
1397         myView( _view )
1398     {}
1399   protected:
1400     virtual void execute()
1401     {
1402       myHelper->internalCloneView( myView );
1403     }
1404   private:
1405     PyModuleHelper*  myHelper;
1406     SUIT_ViewWindow* myView;
1407   };
1408
1409   PyInterp_Dispatcher::Get()->Exec( new CloneViewReq( myInterp, this, view ) );
1410 }
1411
1412 /*!
1413   \brief Save module data. Called when user saves study.
1414   \param files output list of files where module stores data
1415   \param url study URL
1416 */
1417 void PyModuleHelper::save( QStringList& files, const QString& url )
1418 {
1419   FuncMsg fmsg( "PyModuleHelper::save()" );
1420
1421   // temporary set myInitModule because save() method
1422   // might be called by the framework when this module is inactive,
1423   // but still it should be possible to access this module's data
1424   // from Python
1425   InitLocker lock( myModule );
1426
1427   // perform synchronous request to Python event dispatcher
1428   class SaveReq: public PyInterp_LockRequest
1429   {
1430   public:
1431     SaveReq( PyInterp_Interp* _py_interp,
1432              PyModuleHelper*  _helper,
1433              QStringList&     _files,
1434              const QString&   _url )
1435       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1436         myHelper( _helper ) ,
1437         myFiles( _files ),
1438         myUrl( _url )
1439     {}
1440   protected:
1441     virtual void execute()
1442     {
1443       myHelper->internalSave( myFiles, myUrl );
1444     }
1445   private:
1446     PyModuleHelper* myHelper;
1447     QStringList&    myFiles;
1448     QString         myUrl;
1449   };
1450
1451   // Posting the request only if dispatcher is not busy!
1452   // Executing the request synchronously
1453   if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1454     PyInterp_Dispatcher::Get()->Exec( new SaveReq( myInterp, this, files, url ) );
1455 }
1456
1457 /*
1458   \brief Load module data. Called when user opens study
1459   and activates module.
1460   \param files list of files where module data is stored
1461   \param url study URL
1462   \return \c true if loading has been finished successfully or \c false otherwise
1463 */
1464 bool PyModuleHelper::load( const QStringList& files, const QString& url )
1465 {
1466   FuncMsg fmsg( "PyModuleHelper::load()" );
1467
1468   bool loaded = false;
1469
1470   class LoadReq: public PyInterp_LockRequest
1471   {
1472   public:
1473     LoadReq( PyInterp_Interp* _py_interp,
1474              PyModuleHelper*  _helper,
1475              QStringList      _files,
1476              const QString&   _url,
1477              bool&            _loaded )
1478       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1479         myHelper( _helper ) ,
1480         myFiles( _files ),
1481         myUrl( _url ),
1482         myLoaded( _loaded )
1483     {}
1484   protected:
1485     virtual void execute()
1486     {
1487       myHelper->internalLoad( myFiles, myUrl, myLoaded );
1488     }
1489   private:
1490     PyModuleHelper* myHelper;
1491     QStringList     myFiles;
1492     QString         myUrl;
1493     bool&           myLoaded;
1494   };
1495
1496   // Posting the request only if dispatcher is not busy!
1497   // Executing the request synchronously
1498   if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1499     PyInterp_Dispatcher::Get()->Exec( new LoadReq( myInterp, this, files, url, loaded ) );
1500
1501   return loaded;
1502 }
1503
1504 /*!
1505   \brief Dump module data to the Python script.
1506   Called when user activates dump study operation.
1507   \param files output list of files where module stores python script
1508 */
1509 void PyModuleHelper::dumpPython( QStringList& files )
1510 {
1511   FuncMsg fmsg( "PyModuleHelper::dumpPython()" );
1512
1513   // temporary set myInitModule because dumpPython() method
1514   // might be called by the framework when this module is inactive,
1515   // but still it should be possible to access this module's data
1516   // from Python
1517   InitLocker lock( myModule );
1518
1519   class DumpPythonReq: public PyInterp_LockRequest
1520   {
1521   public:
1522     DumpPythonReq( PyInterp_Interp* _py_interp,
1523                    PyModuleHelper*  _helper,
1524                    QStringList&     _files )
1525       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1526         myHelper( _helper ) ,
1527         myFiles( _files )
1528     {}
1529   protected:
1530     virtual void execute()
1531     {
1532       myHelper->internalDumpPython( myFiles );
1533     }
1534   private:
1535     PyModuleHelper* myHelper;
1536     QStringList&    myFiles;
1537   };
1538
1539   // Posting the request only if dispatcher is not busy!
1540   // Executing the request synchronously
1541   if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1542     PyInterp_Dispatcher::Get()->Exec( new DumpPythonReq( myInterp, this, files ) );
1543 }
1544
1545 /*!
1546   \brief Test if object \a what can be dragged by the user.
1547   \param what data object being tested
1548   \return \c true if object can be dragged or \c false otherwise
1549 */
1550 bool PyModuleHelper::isDraggable( const SUIT_DataObject* what ) const
1551 {
1552   FuncMsg fmsg( "PyModuleHelper::isDraggable()" );
1553
1554   bool draggable = false;
1555
1556   // perform synchronous request to Python event dispatcher
1557   class IsDraggableReq: public PyInterp_LockRequest
1558   {
1559   public:
1560     IsDraggableReq( PyInterp_Interp*     _py_interp,
1561                     PyModuleHelper*      _helper,
1562                     LightApp_DataObject* _data_object,
1563                     bool&                _is_draggable )
1564       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1565         myHelper( _helper ) ,
1566         myDataObject( _data_object ),
1567         myIsDraggable( _is_draggable )
1568     {}
1569   protected:
1570     virtual void execute()
1571     {
1572       myIsDraggable = myHelper->internalIsDraggable( myDataObject );
1573     }
1574   private:
1575     PyModuleHelper*      myHelper;
1576     LightApp_DataObject* myDataObject;
1577     bool&                myIsDraggable;
1578   };
1579
1580   const LightApp_DataObject* data_object = dynamic_cast<const LightApp_DataObject*>( what );
1581   if ( data_object ) {
1582     // Posting the request only if dispatcher is not busy!
1583     // Executing the request synchronously
1584     if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1585       PyInterp_Dispatcher::Get()->Exec( new IsDraggableReq( myInterp,
1586                                         const_cast<PyModuleHelper*>( this ),
1587                                         const_cast<LightApp_DataObject*>( data_object ),
1588                                         draggable ) );
1589   }
1590
1591   return draggable;
1592 }
1593
1594 /*!
1595   \brief Test if drop operation can be done on the \a where object.
1596   \param where data object being tested
1597   \return \c true if if drop operation is supported by object or \c false otherwise
1598 */
1599 bool PyModuleHelper::isDropAccepted( const SUIT_DataObject* where ) const
1600 {
1601   FuncMsg fmsg( "PyModuleHelper::isDropAccepted()" );
1602
1603   bool dropAccepted = false;
1604
1605   // perform synchronous request to Python event dispatcher
1606   class IsDropAcceptedReq: public PyInterp_LockRequest
1607   {
1608   public:
1609     IsDropAcceptedReq( PyInterp_Interp*     _py_interp,
1610                        PyModuleHelper*      _helper,
1611                        LightApp_DataObject* _data_object,
1612                        bool&                _is_drop_accepted )
1613       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1614         myHelper( _helper ) ,
1615         myDataObject( _data_object ),
1616         myIsDropAccepted( _is_drop_accepted )
1617     {}
1618   protected:
1619     virtual void execute()
1620     {
1621       myIsDropAccepted = myHelper->internalIsDropAccepted( myDataObject );
1622     }
1623   private:
1624     PyModuleHelper*      myHelper;
1625     LightApp_DataObject* myDataObject;
1626     bool&                myIsDropAccepted;
1627   };
1628
1629   const LightApp_DataObject* data_object = dynamic_cast<const LightApp_DataObject*>( where );
1630   if ( data_object ) {
1631     // Posting the request only if dispatcher is not busy!
1632     // Executing the request synchronously
1633     if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1634       PyInterp_Dispatcher::Get()->Exec( new IsDropAcceptedReq( myInterp,
1635                                          const_cast<PyModuleHelper*>( this ),
1636                                          const_cast<LightApp_DataObject*>( data_object ),
1637                                          dropAccepted ) );
1638   }
1639
1640   return dropAccepted;
1641 }
1642
1643 /*!
1644   \brief Perform drop operation
1645   \param what list of data objects being dropped
1646   \param where target data object for drop operation
1647   \param row line (child item index) where drop operation is performed to
1648   \param action current drop action (copy or move)
1649 */
1650 void PyModuleHelper::dropObjects( const DataObjectList& what, SUIT_DataObject* where,
1651                                   const int row, Qt::DropAction action )
1652 {
1653   FuncMsg fmsg( "PyModuleHelper::dropObjects()" );
1654
1655   // perform synchronous request to Python event dispatcher
1656   class DropObjectsReq: public PyInterp_LockRequest
1657   {
1658   public:
1659     DropObjectsReq( PyInterp_Interp*      _py_interp,
1660                     PyModuleHelper*       _helper,
1661                     const DataObjectList& _what,
1662                     SUIT_DataObject*      _where,
1663                     const int             _row,
1664                     Qt::DropAction        _action )
1665       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1666         myHelper( _helper ) ,
1667         myWhat( _what ),
1668         myWhere( _where ),
1669         myRow( _row ),
1670         myAction ( _action )
1671     {}
1672   protected:
1673     virtual void execute()
1674     {
1675       myHelper->internalDropObjects( myWhat, myWhere, myRow, myAction );
1676     }
1677   private:
1678     PyModuleHelper*  myHelper;
1679     DataObjectList   myWhat;
1680     SUIT_DataObject* myWhere;
1681     int              myRow;
1682     Qt::DropAction   myAction;
1683   };
1684
1685   // Posting the request only if dispatcher is not busy!
1686   // Executing the request synchronously
1687   if ( !PyInterp_Dispatcher::Get()->IsBusy() )
1688     PyInterp_Dispatcher::Get()->Exec( new DropObjectsReq( myInterp, this, what, where, row, action ) );
1689 }
1690
1691 /*!
1692   \brief Get module engine IOR
1693   \return engine IOR as it is supplied by GUI Python module
1694  */
1695 QString PyModuleHelper::engineIOR() const
1696 {
1697   FuncMsg fmsg( "PyModuleHelper::engineIOR()" );
1698
1699   class EngineIORReq : public PyInterp_LockRequest
1700   {
1701   public:
1702     EngineIORReq( PyInterp_Interp* _py_interp,
1703                   PyModuleHelper*  _helper,
1704                   QString&         _ior )
1705       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
1706         myHelper( _helper ),
1707         myIOR( _ior )
1708     {}
1709   protected:
1710     virtual void execute()
1711     {
1712       myIOR = myHelper->internalEngineIOR();
1713     }
1714   private:
1715     PyModuleHelper* myHelper;
1716     QString&        myIOR;
1717   };
1718
1719   static QString anIOR;
1720
1721   if ( anIOR.isEmpty() ) {
1722     // post request
1723     PyInterp_Dispatcher::Get()->Exec( new EngineIORReq( myInterp,
1724                                       const_cast<PyModuleHelper*>( this ),
1725                                       anIOR ) );
1726   }
1727
1728   return anIOR;
1729 }
1730
1731 /*!
1732   \brief Initialize python subinterpreter (one per study).
1733   \internal
1734   \param studyId study ID
1735 */
1736 void PyModuleHelper::initInterp( int studyId )
1737 {
1738   FuncMsg fmsg( "--- PyModuleHelper::initInterp()" );
1739
1740   // check study Id
1741   if ( !studyId ) {
1742     // Error! Study Id must not be 0!
1743     myInterp = 0;
1744     return;
1745   }
1746
1747   QMutexLocker ml( &myInitMutex );
1748
1749   // try to find the subinterpreter
1750   if ( myInterpMap.contains( studyId ) ) {
1751     // found!
1752     myInterp = myInterpMap[ studyId ];
1753     return;
1754   }
1755
1756   myInterp = new SALOME_PYQT_PyInterp();
1757   myInterp->initialize();
1758   myInterpMap[ studyId ] = myInterp;
1759
1760 #ifndef GUI_DISABLE_CORBA
1761   if ( !SUIT_PYTHON::initialized ) {
1762     // import 'salome' module and call 'salome_init' method;
1763     // do it only once on interpreter creation
1764     // ... first get python lock
1765     PyLockWrapper aLock; // Acquire GIL
1766     // ... then import a module
1767     PyObjWrapper aMod = PyImport_ImportModule( "salome" );
1768     if ( !aMod ) {
1769       // Error!
1770       PyErr_Print();
1771       return;
1772     }
1773     // ... then call a method
1774     int embedded = 1;
1775     PyObjWrapper aRes( PyObject_CallMethod( aMod, (char*)"salome_init", (char*)"ii", studyId, embedded ) );
1776     if ( !aRes ) {
1777       // Error!
1778       PyErr_Print();
1779       return;
1780     }
1781   }
1782 #endif
1783 }
1784
1785 /*!
1786   \brief Import Python GUI module and store reference to the module.
1787   \internal
1788
1789   Warning! initInterp() should be called first!!!
1790 */
1791 void PyModuleHelper::importModule()
1792 {
1793   FuncMsg fmsg( "--- PyModuleHelper::importModule()" );
1794
1795   // check if the subinterpreter is initialized
1796   if ( !myInterp ) {
1797     // Error! Python subinterpreter should be initialized first!
1798     myPyModule = 0;
1799     return;
1800   }
1801
1802   // import Python GUI module and put it in <myPyModule> attribute
1803   // ... first get python lock
1804   PyLockWrapper aLock; // Acquire GIL
1805   // ... then import a module
1806   QString aMod = QString( "%1GUI" ).arg( myModule->name() );
1807   try {
1808     myPyModule = PyImport_ImportModule( aMod.toLatin1().data() );
1809   }
1810   catch (...) {
1811   }
1812
1813   if ( !myPyModule ) {
1814     // Error!
1815     PyErr_Print();
1816     return;
1817   }
1818 }
1819
1820 /*!
1821   \brief Set study workspace to the Python module.
1822   \internal
1823
1824   Calls setWorkSpace() method of the Python module with
1825   PyQt QWidget object to use with interpreter.
1826
1827   Attention! initInterp() and importModule() should be called first!!!
1828 */
1829 void PyModuleHelper::setWorkSpace()
1830 {
1831   FuncMsg fmsg( "--- PyModuleHelper::setWorkSpace()" );
1832
1833   if ( !IsCallOldMethods )
1834     return;
1835
1836   // check if the subinterpreter is initialized and Python module is imported
1837   if ( !myInterp || !myPyModule ) {
1838     // Error! Python subinterpreter should be initialized and module should be imported first!
1839     return;
1840   }
1841
1842   // call setWorkSpace() method
1843   // ... first get python lock
1844   PyLockWrapper aLock; // Acquire GIL
1845
1846   // ... then try to import SalomePyQt module. If it's not possible don't go on.
1847   PyObjWrapper aQtModule( PyImport_ImportModule( "SalomePyQt" ) );
1848   if( !aQtModule ) {
1849     // Error!
1850     PyErr_Print();
1851     return;
1852   }
1853
1854   // ... then get workspace object
1855   QWidget* aWorkspace = 0;
1856   if ( myModule->getApp()->desktop()->inherits( "STD_MDIDesktop" ) ) {
1857     STD_MDIDesktop* d = dynamic_cast<STD_MDIDesktop*>( myModule->getApp()->desktop() );
1858     if ( d )
1859       aWorkspace = d->workspace();
1860   }
1861   else if ( myModule->getApp()->desktop()->inherits( "STD_TabDesktop" ) ) {
1862     STD_TabDesktop* d = dynamic_cast<STD_TabDesktop*>( myModule->getApp()->desktop() );
1863     if ( d )
1864       aWorkspace = d->workstack();
1865   }
1866 #if SIP_VERSION >= 0x041300
1867   static const sipTypeDef *sipType_QWidget = 0;
1868   if (!sipType_QWidget)
1869     sipType_QWidget = sipFindType("QWidget");
1870 #endif
1871   PyObjWrapper pyws( sipBuildResult( 0, "D", aWorkspace, sipType_QWidget , NULL) );
1872   // ... and finally call Python module's setWorkSpace() method (obsolete)
1873   if ( PyObject_HasAttrString( myPyModule, (char*)"setWorkSpace" ) ) {
1874     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"setWorkSpace", (char*)"O", pyws.get() ) );
1875     if( !res ) {
1876       PyErr_Print();
1877     }
1878   }
1879 }
1880
1881 /*!
1882   \brief Initialization callback function
1883   \internal
1884
1885   Performs the following actions:
1886   - initialize or get the Python interpreter (one per study)
1887   - import the Python module
1888   - pass the workspace widget to the Python module
1889   - call Python module's initialize() method
1890   - call Python module's windows() method
1891   - call Python module's views() method
1892
1893   \param app parent application object
1894 */
1895 void PyModuleHelper::internalInitialize( CAM_Application* app )
1896 {
1897   FuncMsg fmsg( "--- PyModuleHelper::internalInitialize()" );
1898
1899   // reset interpreter to NULL
1900   myInterp = 0;
1901
1902   // get study Id
1903   LightApp_Application* anApp = dynamic_cast<LightApp_Application*>( app );
1904   if ( !anApp )
1905     return;
1906   LightApp_Study* aStudy = dynamic_cast<LightApp_Study*>( app->activeStudy() );
1907   if ( !aStudy )
1908     return;
1909   int aStudyId = aStudy ? aStudy->id() : 0;
1910
1911   // initialize Python subinterpreter (on per study) and put it in <myInterp> variable
1912   initInterp( aStudyId );
1913   if ( !myInterp )
1914     return; // Error
1915
1916   // import Python GUI module
1917   importModule();
1918   if ( !myPyModule )
1919     return; // Error
1920
1921   // then call Python module's initialize() method
1922   // ... first get python lock
1923   PyLockWrapper aLock; // Acquire GIL
1924
1925   // ... (the Python module is already imported)
1926   // ... finally call Python module's initialize() method
1927   if ( PyObject_HasAttrString( myPyModule, (char*)"initialize" ) ) {
1928     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"initialize", (char*)"" ) );
1929     if ( !res ) {
1930       PyErr_Print();
1931     }
1932   }
1933
1934   // get required dockable windows list from the Python module
1935   // by calling windows() method
1936   // ... first put default values
1937   myWindowsMap.insert( LightApp_Application::WT_ObjectBrowser, Qt::LeftDockWidgetArea );
1938   myWindowsMap.insert( LightApp_Application::WT_PyConsole,     Qt::BottomDockWidgetArea );
1939   myWindowsMap.insert( LightApp_Application::WT_LogWindow,     Qt::BottomDockWidgetArea );
1940
1941   if ( PyObject_HasAttrString( myPyModule , (char*)"windows" ) ) {
1942     PyObjWrapper res1( PyObject_CallMethod( myPyModule, (char*)"windows", (char*)"" ) );
1943     if ( !res1 ) {
1944       PyErr_Print();
1945     }
1946     else {
1947       myWindowsMap.clear();
1948       if ( PyDict_Check( res1 ) ) {
1949         PyObject* key;
1950         PyObject* value;
1951         Py_ssize_t pos = 0;
1952         while ( PyDict_Next( res1, &pos, &key, &value ) ) {
1953           // parse the return value
1954           // it should be a map: {integer:integer}
1955           int aKey, aValue;
1956           if( key && PyInt_Check( key ) && value && PyInt_Check( value ) ) {
1957             aKey   = PyInt_AsLong( key );
1958             aValue = PyInt_AsLong( value );
1959             myWindowsMap[ aKey ] = aValue;
1960           }
1961         }
1962       }
1963     }
1964   }
1965
1966   // get compatible view windows types from the Python module
1967   // by calling views() method
1968   if ( PyObject_HasAttrString( myPyModule , (char*)"views" ) ) {
1969     PyObjWrapper res2( PyObject_CallMethod( myPyModule, (char*)"views", (char*)"" ) );
1970     if ( !res2 ) {
1971       PyErr_Print();
1972     }
1973     else {
1974       // parse the return value
1975       // result can be one string...
1976       if ( PyString_Check( res2 ) ) {
1977         myViewMgrList.append( PyString_AsString( res2 ) );
1978       }
1979       // ... or list of strings
1980       else if ( PyList_Check( res2 ) ) {
1981         int size = PyList_Size( res2 );
1982         for ( int i = 0; i < size; i++ ) {
1983           PyObject* value = PyList_GetItem( res2, i );
1984           if( value && PyString_Check( value ) ) {
1985             myViewMgrList.append( PyString_AsString( value ) );
1986           }
1987         }
1988       }
1989     }
1990   }
1991 }
1992
1993 /*!
1994   \brief Activation callback function
1995   \internal
1996
1997   Performs the following actions:
1998   - initialize or get the Python interpreter (one per study)
1999   - import the Python GUI module
2000   - call Python module's activate() method
2001
2002   \param study parent study
2003 */
2004 void PyModuleHelper::internalActivate( SUIT_Study* study )
2005 {
2006   FuncMsg fmsg( "--- PyModuleHelper::internalActivate()" );
2007
2008   // get study Id
2009   LightApp_Study* aStudy = dynamic_cast<LightApp_Study*>( study );
2010   int aStudyId = aStudy ? aStudy->id() : 0;
2011
2012   // initialize Python subinterpreter (on per study) and put it in <myInterp> variable
2013   initInterp( aStudyId );
2014   if ( !myInterp ) {
2015     myLastActivateStatus = false;
2016     return; // Error
2017   }
2018
2019   // import Python GUI module
2020   importModule();
2021   if ( !myPyModule ) {
2022     myLastActivateStatus = false;
2023     return; // Error
2024   }
2025
2026   // get python lock
2027   PyLockWrapper aLock; // Acquire GIL
2028
2029   // call Python module's activate() method (for the new modules)
2030   if ( PyObject_HasAttrString( myPyModule , (char*)"activate" ) ) {
2031     PyObject* res1 = PyObject_CallMethod( myPyModule, (char*)"activate", (char*)"" );
2032     if ( !res1 || !PyBool_Check( res1 ) ) {
2033       PyErr_Print();
2034       // always true for old modules (no return value)
2035       myLastActivateStatus = true;
2036     }
2037     else {
2038       // detect return status
2039       myLastActivateStatus = PyObject_IsTrue( res1 );
2040     }
2041   }
2042 }
2043
2044 /*!
2045   \brief Additional menu customization callback function
2046   \internal
2047
2048   Performs the following actions:
2049   - get the Python interpreter (one per study)
2050   - import the Python GUI module
2051   - call Python module's setSettings() method (obsolete function,
2052   used for compatibility with old code)
2053
2054   \param study parent study
2055 */
2056 void PyModuleHelper::internalCustomize( SUIT_Study* study )
2057 {
2058   FuncMsg fmsg( "--- PyModuleHelper::internalCustomize()" );
2059
2060   // get study Id
2061   LightApp_Study* aStudy = dynamic_cast<LightApp_Study*>( study );
2062   int aStudyId = aStudy ? aStudy->id() : 0;
2063
2064   // initialize Python subinterpreter (on per study) and put it in <myInterp> variable
2065   initInterp( aStudyId );
2066   if ( !myInterp ) {
2067     myLastActivateStatus = false;
2068     return; // Error
2069   }
2070
2071   // import Python GUI module
2072   importModule();
2073   if ( !myPyModule ) {
2074     myLastActivateStatus = false;
2075     return; // Error
2076   }
2077
2078   // call Python module's setWorkSpace() method (obsolete)
2079   setWorkSpace();
2080
2081   // get python lock
2082   PyLockWrapper aLock; // Acquire GIL
2083
2084   if ( IsCallOldMethods ) {
2085     // call Python module's setSettings() method (obsolete)
2086     if ( PyObject_HasAttrString( myPyModule , (char*)"setSettings" ) ) {
2087       PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"setSettings", (char*)"" ) );
2088       if( !res ) {
2089         PyErr_Print();
2090       }
2091       myLastActivateStatus = myLastActivateStatus && true;
2092     }
2093   }
2094 }
2095
2096 /*!
2097   \brief Deactivation callback function
2098   \internal
2099
2100   Performs the following actions:
2101   - call Python module's deactivate() method
2102
2103   \param study parent study
2104 */
2105 void PyModuleHelper::internalDeactivate( SUIT_Study* study )
2106 {
2107   FuncMsg fmsg( "--- PyModuleHelper::internalDeactivate()" );
2108
2109   // check that Python subinterpreter is initialized and Python module is imported
2110   if ( !myInterp || !myPyModule ) {
2111     // Error! Python subinterpreter should be initialized and module should be imported first!
2112     return;
2113   }
2114   // then call Python module's deactivate() method
2115   if ( PyObject_HasAttrString( myPyModule , (char*)"deactivate" ) ) {
2116     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"deactivate", (char*)"" ) );
2117     if( !res ) {
2118       PyErr_Print();
2119     }
2120   }
2121 }
2122
2123 /*!
2124   \brief Internal closure:
2125
2126   Performs the following actions:
2127   - call Python module's closeStudy() method
2128
2129   \param theStudy parent study object
2130 */
2131 void PyModuleHelper::internalClosedStudy( SUIT_Study* theStudy )
2132 {
2133   FuncMsg fmsg( "--- PyModuleHelper::internalClosedStudy()" );
2134
2135   // Get study Id
2136   // get study Id
2137   LightApp_Study* aStudy = dynamic_cast<LightApp_Study*>( theStudy );
2138   int aStudyId = aStudy ? aStudy->id() : 0;
2139
2140   // check that Python subinterpreter is initialized and Python module is imported
2141   if ( !myInterp || !myPyModule ) {
2142     // Error! Python subinterpreter should be initialized and module should be imported first!
2143     return;
2144   }
2145   // then call Python module's deactivate() method
2146   if ( PyObject_HasAttrString( myPyModule , (char*)"closeStudy" ) ) {
2147     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"closeStudy", (char*)"i", aStudyId ) );
2148     if( !res ) {
2149       PyErr_Print();
2150     }
2151   }
2152 }
2153
2154
2155
2156 /*!
2157   \brief Preference changing callback function.
2158   \internal
2159
2160   Performs the following actions:
2161   - call Python module's preferenceChanged() method
2162
2163   \param section resources section name
2164   \param setting resources parameter name
2165 */
2166 void PyModuleHelper::internalPreferencesChanged( const QString& section, const QString& setting )
2167 {
2168   FuncMsg fmsg( "--- PyModuleHelper::internalPreferencesChanged()" );
2169
2170   // check that Python subinterpreter is initialized and Python module is imported
2171   if ( !myInterp || !myPyModule ) {
2172     // Error! Python subinterpreter should be initialized and module should be imported first!
2173     return;
2174   }
2175
2176   if ( PyObject_HasAttrString( myPyModule, (char*)"preferenceChanged" ) ) {
2177     PyObjWrapper res( PyObject_CallMethod( myPyModule,
2178                                            (char*)"preferenceChanged",
2179                                            (char*)"ss",
2180                                            section.toLatin1().constData(),
2181                                            setting.toLatin1().constData() ) );
2182     if( !res ) {
2183       PyErr_Print();
2184     }
2185   }
2186 }
2187
2188 /*!
2189   \brief Active study change callback function.
2190   \internal
2191
2192   Called when active the study is actived (user brings its
2193   desktop to top):
2194   - initialize or get the Python interpreter (one per study)
2195   - import the Python GUI module
2196   - call Python module's activeStudyChanged() method
2197
2198   \param study study being activated
2199 */
2200 void PyModuleHelper::internalStudyChanged( SUIT_Study* study )
2201 {
2202   FuncMsg fmsg( "--- PyModuleHelper::internalStudyChanged()" );
2203
2204   // get study Id
2205   LightApp_Study* aStudy = dynamic_cast<LightApp_Study*>( study );
2206   int id = aStudy ? aStudy->id() : 0;
2207
2208   fmsg.message( QString( "study id = %1" ).arg( id ) );
2209
2210   // initialize Python subinterpreter (on per study) and put it in <myInterp> variable
2211   initInterp( id );
2212   if ( !myInterp )
2213     return; // Error
2214
2215   // import Python GUI module
2216   importModule();
2217   if ( !myPyModule )
2218     return; // Error
2219
2220   // call Python module's setWorkSpace() method
2221   setWorkSpace();
2222
2223   // get python lock
2224   PyLockWrapper aLock; // Acquire GIL
2225
2226   // call Python module's activeStudyChanged() method
2227   if ( PyObject_HasAttrString( myPyModule, (char*)"activeStudyChanged" ) ) {
2228     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"activeStudyChanged", (char*)"i", id ) );
2229     if( !res ) {
2230       PyErr_Print();
2231     }
2232   }
2233 }
2234
2235 /*!
2236   \brief GUI event handling callback function
2237   \internal
2238
2239   Performs the following actions:
2240   - calls Python module's OnGUIEvent() method
2241
2242   \param id GUI action ID
2243 */
2244 void PyModuleHelper::internalActionActivated( int id )
2245 {
2246   FuncMsg fmsg( "--- PyModuleHelper::internalActionActivated()" );
2247   fmsg.message( QString( "action id = %1" ).arg( id ) );
2248
2249   // Python interpreter should be initialized and Python module should be
2250   // import first
2251   if ( !myInterp || !myPyModule )
2252     return; // Error
2253
2254   if ( PyObject_HasAttrString( myPyModule, (char*)"OnGUIEvent" ) ) {
2255     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"OnGUIEvent", (char*)"i", id ) );
2256     if( !res ) {
2257       PyErr_Print();
2258     }
2259   }
2260 }
2261
2262 /*!
2263   \brief update selection from other views or modules
2264   \internal
2265
2266   Performs the following actions:
2267   - calls Python module's onSelectionpdated(entries) method
2268
2269   \param list of entries
2270 */
2271 void PyModuleHelper::internalSelectionUpdated(const QStringList& entries)
2272 {
2273   FuncMsg fmsg("--- PyModuleHelper::internalSelectionUpdated()");
2274   MESSAGE("internalSelectionUpdated");
2275
2276   // Python interpreter should be initialized and Python module should be imported first
2277   if (!myInterp || !myPyModule)
2278     return; // Error
2279
2280   QStringList* theList = new QStringList(entries);
2281
2282 #if SIP_VERSION >= 0x041300
2283   static const sipTypeDef *sipType_QStringList = 0;
2284   if (!sipType_QStringList)
2285     sipType_QStringList = sipFindType("QStringList");
2286 #endif
2287   PyObjWrapper sipList( sipBuildResult( 0, "D", theList, sipType_QStringList, NULL ) );
2288   if (PyObject_HasAttrString(myPyModule, (char*) "onSelectionUpdated"))
2289     {
2290       MESSAGE("call onSelectionUpdated");
2291       PyObjWrapper res(PyObject_CallMethod(myPyModule, (char*) "onSelectionUpdated", (char*) "O", sipList.get()));
2292
2293       if (!res)
2294         {
2295           PyErr_Print();
2296         }
2297     }
2298 }
2299
2300 /*!
2301   \brief Context popup menu handling callback function
2302   \internal
2303
2304   Performs the following actions:
2305   - calls Python module's definePopup(...) method (obsolete function,
2306   used for compatibility with old code) to define the popup menu context
2307   - parses XML resourses file (if exists) and fills the popup menu with the items)
2308   - calls Python module's customPopup(...) method (obsolete function,
2309   used for compatibility with old code) to allow module to customize the popup menu
2310   - for new modules calls createPopupMenu() function to allow the
2311   modules to build the popup menu by using insertItem(...) Qt functions.
2312
2313   \param context popup menu context
2314   \param menu popup menu
2315 */
2316 void PyModuleHelper::internalContextMenu( const QString& context, QMenu* menu )
2317 {
2318   FuncMsg fmsg( "--- PyModuleHelper::internalContextMenu()" );
2319   fmsg.message( QString( "context: %1" ).arg( context ) );
2320
2321   // Python interpreter should be initialized and Python module should be
2322   // import first
2323   if ( !myInterp || !myPyModule )
2324     return; // Error
2325
2326   QString aContext( "" ), aObject( "" ), aParent( context );
2327
2328   if ( IsCallOldMethods && PyObject_HasAttrString( myPyModule, (char*)"definePopup" ) ) {
2329     // call definePopup() Python module's function
2330     // this is obsolete function, used only for compatibility reasons
2331     PyObjWrapper res( PyObject_CallMethod( myPyModule,
2332                                            (char*)"definePopup",
2333                                            (char*)"sss",
2334                                            context.toLatin1().constData(),
2335                                            aObject.toLatin1().constData(),
2336                                            aParent.toLatin1().constData() ) );
2337     if( !res ) {
2338       PyErr_Print();
2339     }
2340     else {
2341       // parse return value
2342       char *co, *ob, *pa;
2343       if( PyArg_ParseTuple( res, "sss", &co, &ob, &pa ) ) {
2344         aContext = co;
2345         aObject  = ob;
2346         aParent  = pa;
2347       }
2348     }
2349   } // if ( IsCallOldMethods ... )
2350
2351   // first try to create menu via XML parser:
2352   // we create popup menus without help of QtxPopupMgr
2353   if ( myXmlHandler )
2354     myXmlHandler->createPopup( menu, aContext, aParent, aObject );
2355
2356 #if SIP_VERSION >= 0x041300
2357   static const sipTypeDef *sipType_QMenu = 0;
2358   if (!sipType_QMenu)
2359     sipType_QMenu = sipFindType("QMenu");
2360 #endif
2361   PyObjWrapper sipPopup( sipBuildResult( 0, "D", menu, sipType_QMenu, NULL ) );
2362
2363   // then call Python module's createPopupMenu() method (for new modules)
2364   if ( PyObject_HasAttrString( myPyModule, (char*)"createPopupMenu" ) ) {
2365     PyObjWrapper res1( PyObject_CallMethod( myPyModule,
2366                                             (char*)"createPopupMenu",
2367                                             (char*)"Os",
2368                                             sipPopup.get(),
2369                                             context.toLatin1().constData() ) );
2370     if( !res1 ) {
2371       PyErr_Print();
2372     }
2373   }
2374
2375   if ( IsCallOldMethods && PyObject_HasAttrString( myPyModule, (char*)"customPopup" ) ) {
2376     // call customPopup() Python module's function
2377     // this is obsolete function, used only for compatibility reasons
2378     PyObjWrapper res2( PyObject_CallMethod( myPyModule,
2379                                             (char*)"customPopup",
2380                                             (char*)"Osss",
2381                                             sipPopup.get(),
2382                                             aContext.toLatin1().constData(),
2383                                             aObject.toLatin1().constData(),
2384                                             aParent.toLatin1().constData() ) );
2385     if( !res2 ) {
2386       PyErr_Print();
2387     }
2388   }
2389 }
2390
2391 /*!
2392   \brief Preferences initialization callback function.
2393   \internal
2394
2395   Performs the following actions:
2396   - calls Python module's createPreferences() method
2397 */
2398 void PyModuleHelper::internalCreatePreferences()
2399 {
2400   FuncMsg fmsg( "--- PyModuleHelper::internalCreatePreferences()" );
2401
2402   // Python interpreter should be initialized and Python module should be
2403   // import first
2404   if ( !myInterp || !myPyModule )
2405     return; // Error
2406
2407   if ( PyObject_HasAttrString( myPyModule, (char*)"createPreferences" ) ) {
2408     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"createPreferences", (char*)"" ) );
2409     if( !res ) {
2410       PyErr_Print();
2411     }
2412   }
2413 }
2414
2415 /*!
2416   \brief Active view changing callback function
2417   \internal
2418   \param view view being activated
2419 */
2420 void PyModuleHelper::internalActiveViewChanged( SUIT_ViewWindow* view )
2421 {
2422   FuncMsg fmsg( "--- PyModuleHelper::internalActiveViewChanged()" );
2423
2424   if ( !myInterp || !myPyModule || !view )
2425     return;
2426
2427   fmsg.message( QString( "view id: %1" ).arg( view->getId() ) );
2428
2429   if ( PyObject_HasAttrString( myPyModule, (char*)"activeViewChanged" ) ) {
2430     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"activeViewChanged", (char*)"i" , view->getId() ) );
2431     if ( !res ) {
2432       PyErr_Print();
2433     }
2434   }
2435 }
2436
2437 /*!
2438   \brief View closing callback function
2439   \internal
2440   \param view view user tries to close
2441 */
2442 void PyModuleHelper::internalTryCloseView( SUIT_ViewWindow* view )
2443 {
2444   FuncMsg fmsg( "--- PyModuleHelper::internalTryCloseView()" );
2445
2446   if ( !myInterp || !myPyModule || !view )
2447     return;
2448
2449   fmsg.message( QString( "view id: %1" ).arg( view->getId() ) );
2450
2451   if ( PyObject_HasAttrString( myPyModule, (char*)"viewTryClose" ) )
2452   {
2453     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"viewTryClose", (char*)"i", view->getId() ) );
2454     if ( !res )
2455     {
2456       PyErr_Print();
2457     }
2458   }
2459 }
2460
2461 /*!
2462   \brief View closing callback function
2463   \internal
2464   \param view view being closed
2465 */
2466 void PyModuleHelper::internalCloseView( SUIT_ViewWindow* view )
2467 {
2468   FuncMsg fmsg( "--- PyModuleHelper::internalCloseView()" );
2469
2470   if ( !myInterp || !myPyModule || !view )
2471     return;
2472
2473   fmsg.message( QString( "view id: %1" ).arg( view->getId() ) );
2474
2475   if ( PyObject_HasAttrString( myPyModule, (char*)"viewClosed" ) )
2476   {
2477     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"viewClosed", (char*)"i", view->getId() ) );
2478     if ( !res )
2479     {
2480       PyErr_Print();
2481     }
2482   }
2483 }
2484
2485 /*!
2486   \brief View cloning callback function
2487   \internal
2488   \param view view being cloned
2489 */
2490 void PyModuleHelper::internalCloneView( SUIT_ViewWindow* view )
2491 {
2492   FuncMsg fmsg( "--- PyModuleHelper::internalCloneView()" );
2493
2494   if ( !myInterp || !myPyModule || !view )
2495     return;
2496
2497   fmsg.message( QString( "view id: %1" ).arg( view->getId() ) );
2498
2499   if ( PyObject_HasAttrString( myPyModule, (char*)"viewCloned" ) )
2500   {
2501     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"viewCloned", (char*)"i", view->getId() ) );
2502     if( !res )
2503       PyErr_Print();
2504   }
2505 }
2506
2507 /*!
2508   \brief Module data saving callback function.
2509   \internal
2510   \param files output list of files where module stores data
2511   \param url study URL
2512 */
2513 void PyModuleHelper::internalSave( QStringList& files, const QString& url )
2514 {
2515   FuncMsg fmsg( "--- PyModuleHelper::internalSave()" );
2516
2517   // Python interpreter should be initialized and Python module should be
2518   // import firs
2519   // files list should contain a path to the temporary directory as a first entry
2520   if ( !myInterp || !myPyModule || files.isEmpty() )
2521     return;
2522
2523   if ( PyObject_HasAttrString(myPyModule, (char*)"saveFiles") ) {
2524
2525     // try with two parameters (new syntax)
2526     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"saveFiles",
2527                                            (char*)"ss",
2528                                            files.first().toLatin1().constData(),
2529                                            url.toLatin1().constData() ) );
2530     if ( !res )
2531       // try with single parameter (old syntax)
2532       res = PyObject_CallMethod( myPyModule, (char*)"saveFiles",
2533                                  (char*)"s", files.first().toLatin1().constData() );
2534
2535     if ( !res ) {
2536       PyErr_Print();
2537     }
2538     else {
2539       // parse the return value
2540       // result can be one string...
2541       if ( PyString_Check( res ) ) {
2542         QString astr = PyString_AsString( res );
2543         files.append( astr );
2544       }
2545       //also result can be a list...
2546       else if ( PyList_Check( res ) ) {
2547         int size = PyList_Size( res );
2548         for ( int i = 0; i < size; i++ ) {
2549           PyObject* value = PyList_GetItem( res, i );
2550           if ( value && PyString_Check( value ) ) {
2551             files.append( PyString_AsString( value ) );
2552           }
2553         }
2554       }
2555     }
2556   }
2557 }
2558
2559 /*!
2560   \brief Module data loading callback function.
2561   \internal
2562   \param files list of files where module data is stored
2563   \param url study URL
2564   \param opened output success flag
2565 */
2566 void PyModuleHelper::internalLoad( const QStringList& files, const QString& url, bool& opened )
2567 {
2568   FuncMsg fmsg( "--- PyModuleHelper::internalLoad()" );
2569
2570   // Python interpreter should be initialized and Python module should be
2571   // import first
2572   if ( !myInterp || !myPyModule || files.isEmpty() )
2573     return;
2574
2575   QStringList* theList = new QStringList( files );
2576
2577 #if SIP_VERSION >= 0x041300
2578   static const sipTypeDef *sipType_QStringList = 0;
2579   if (!sipType_QStringList)
2580     sipType_QStringList = sipFindType("QStringList");
2581 #endif
2582   PyObjWrapper sipList( sipBuildResult( 0, "D", theList, sipType_QStringList, NULL ) );
2583   if ( PyObject_HasAttrString(myPyModule , (char*)"openFiles") ) {
2584
2585     // try with two parameters (new syntax)
2586     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"openFiles",
2587                                            (char*)"Os", sipList.get(),
2588                                            url.toLatin1().constData() ) );
2589
2590     if ( !res )
2591       // try with single parameter (old syntax)
2592       res = PyObject_CallMethod( myPyModule, (char*)"openFiles",
2593                                  (char*)"O", sipList.get() );
2594
2595     if ( !res || !PyBool_Check( res ) ) {
2596       PyErr_Print();
2597       opened = false;
2598     }
2599     else {
2600       opened = PyObject_IsTrue( res );
2601     }
2602   }
2603 }
2604
2605 /*!
2606   \brief Module dump python callback function.
2607   \internal
2608   \param files output list of files where module stores python script
2609 */
2610 void PyModuleHelper::internalDumpPython( QStringList& files )
2611 {
2612   FuncMsg fmsg( "--- PyModuleHelper::internalDumpPython()" );
2613
2614   // Python interpreter should be initialized and Python module should be
2615   // import first
2616   // files list should contain a path to the temporary directory
2617   if ( !myInterp || !myPyModule || files.isEmpty() )
2618     return;
2619
2620   if ( PyObject_HasAttrString(myPyModule, (char*)"dumpStudy") ) {
2621     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"dumpStudy",
2622                                            (char*)"s", files.first().toLatin1().constData()));
2623
2624     if ( !res ) {
2625       PyErr_Print();
2626     }
2627     else {
2628       // parse the return value
2629       // result can be one string...
2630       if ( PyString_Check( res ) ) {
2631         QString astr = PyString_AsString( res );
2632         //SCRUTE(astr);
2633         files.append(astr);
2634       }
2635       //also result can be a list...
2636       else if ( PyList_Check( res ) ) {
2637         int size = PyList_Size( res );
2638         for ( int i = 0; i < size; i++ ) {
2639           PyObject* value = PyList_GetItem( res, i );
2640           if( value && PyString_Check( value ) ) {
2641             files.append( PyString_AsString( value ) );
2642           }
2643         }
2644       }
2645     }
2646   }
2647 }
2648
2649 /*!
2650   \brief Check data object's 'draggable' status callback function.
2651   \internal
2652   \param what data object being tested
2653   \return \c true if object can be dragged or \c false otherwise
2654 */
2655 bool PyModuleHelper::internalIsDraggable( LightApp_DataObject* what )
2656 {
2657   FuncMsg fmsg( "--- PyModuleHelper::internalIsDraggable()" );
2658
2659   // Python interpreter should be initialized and Python module should be
2660   // import first
2661   if ( !myInterp || !myPyModule || !what )
2662     return false;
2663
2664   bool draggable = false;
2665
2666   if ( PyObject_HasAttrString(myPyModule , (char*)"isDraggable") ) {
2667     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"isDraggable",
2668                       (char*)"s", what->entry().toLatin1().constData() ) );
2669     if( !res || !PyBool_Check( res )) {
2670       PyErr_Print();
2671       draggable = false;
2672     }
2673     else{
2674       draggable = PyObject_IsTrue( res );
2675     }
2676   }
2677
2678   return draggable;
2679 }
2680
2681 /*!
2682   \brief Check data object's 'drop allowed' status callback function.
2683   \internal
2684   \param where data object being tested
2685   \return \c true if if drop operation is supported by object or \c false otherwise
2686 */
2687 bool PyModuleHelper::internalIsDropAccepted( LightApp_DataObject* where )
2688 {
2689   FuncMsg fmsg( "--- PyModuleHelper::internalIsDropAccepted()" );
2690
2691   // Python interpreter should be initialized and Python module should be
2692   // import first
2693   if ( !myInterp || !myPyModule || !where )
2694     return false;
2695
2696   bool dropAccepted = false;
2697
2698   if ( PyObject_HasAttrString(myPyModule , (char*)"isDropAccepted") ) {
2699     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"isDropAccepted",
2700                       (char*)"s", where->entry().toLatin1().constData() ) );
2701     if( !res || !PyBool_Check( res )) {
2702       PyErr_Print();
2703       dropAccepted = false;
2704     }
2705     else{
2706       dropAccepted = PyObject_IsTrue( res );
2707     }
2708   }
2709
2710   return dropAccepted;
2711 }
2712
2713 /*!
2714   \brief Data dropping callback function.
2715   \internal
2716   \param what list of data objects being dropped
2717   \param where target data object for drop operation
2718   \param row line (child item index) where drop operation is performed to
2719   \param action current drop action (copy or move)
2720 */
2721 void PyModuleHelper::internalDropObjects( const DataObjectList& what, SUIT_DataObject* where,
2722                                           const int row, Qt::DropAction action )
2723 {
2724   FuncMsg fmsg( "--- PyModuleHelper::internalDropObjects()" );
2725
2726   // Python interpreter should be initialized and Python module should be
2727   // import first
2728   if ( !myInterp || !myPyModule || what.isEmpty() || !where )
2729     return;
2730
2731   QStringList* theList = new QStringList();
2732
2733   LightApp_DataObject* whereObject = dynamic_cast<LightApp_DataObject*>( where );
2734   if ( !whereObject ) return;
2735
2736   for ( int i = 0; i < what.count(); i++ ) {
2737     LightApp_DataObject* dataObject = dynamic_cast<LightApp_DataObject*>( what[i] );
2738     if ( dataObject ) theList->append( dataObject->entry() );
2739   }
2740
2741 #if SIP_VERSION >= 0x041300
2742   static const sipTypeDef *sipType_QStringList = 0;
2743   if (!sipType_QStringList)
2744     sipType_QStringList = sipFindType("QStringList");
2745 #endif
2746   PyObjWrapper sipList( sipBuildResult( 0, "D", theList, sipType_QStringList, NULL) );
2747   if ( PyObject_HasAttrString(myPyModule, (char*)"dropObjects") ) {
2748       PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"dropObjects", (char*)"Osii",
2749                         sipList.get(),
2750                         whereObject->entry().toLatin1().constData(),
2751                         row, action ) );
2752
2753     if( !res ) {
2754       PyErr_Print();
2755     }
2756   }
2757 }
2758
2759 /*!
2760   \brief Get engine IOR callback function
2761   \internal
2762
2763   Tries to get engine IOR from the Python module using engineIOR() function.
2764   That function can load module engine using appropriate container if required.
2765
2766   \return engine IOR or empty string if it is not provided by Python module
2767 */
2768 QString PyModuleHelper::internalEngineIOR() const
2769 {
2770   FuncMsg fmsg( "--- PyModuleHelper::internalEngineIOR()" );
2771
2772   QString ior;
2773
2774   // Python interpreter should be initialized and Python module should be
2775   // import first
2776   if ( myInterp && myModule ) {
2777     if ( PyObject_HasAttrString( myPyModule , "engineIOR" ) ) {
2778       PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"engineIOR", (char*)"" ) );
2779       if ( !res ) {
2780           PyErr_Print();
2781       }
2782       else {
2783         // parse the return value, result chould be string
2784         if ( PyString_Check( res ) ) {
2785           ior = PyString_AsString( res );
2786         }
2787       }
2788     }
2789   }
2790   return ior;
2791 }
2792
2793 /*!
2794   \brief Connects signals about activating and cloning view on internal slots
2795   \param view view being connected
2796 */
2797 void PyModuleHelper::connectView( SUIT_ViewWindow* view )
2798 {
2799   SUIT_ViewManager* viewMgr = view->getViewManager();
2800   SUIT_ViewModel* viewModel = viewMgr ? viewMgr->getViewModel() : 0;
2801
2802   // Connect tryCloseView() and deleteView() signals
2803   if ( viewMgr ) {
2804     connect( viewMgr, SIGNAL( tryCloseView( SUIT_ViewWindow* ) ),
2805              this, SLOT( tryCloseView( SUIT_ViewWindow* ) ),
2806              Qt::UniqueConnection );
2807     connect( viewMgr, SIGNAL( deleteView( SUIT_ViewWindow* ) ),
2808              this, SLOT( closeView( SUIT_ViewWindow* ) ),
2809              Qt::UniqueConnection );
2810   }
2811
2812   // Connect cloneView() signal of an OCC View
2813   if ( view->inherits( "OCCViewer_ViewWindow" ) ) {
2814     connect( view, SIGNAL( viewCloned( SUIT_ViewWindow* ) ),
2815              this, SLOT( cloneView( SUIT_ViewWindow* ) ),
2816              Qt::UniqueConnection );
2817   }
2818   // Connect cloneView() signal of Plot2d View
2819   else if ( viewModel && viewModel->inherits( "Plot2d_Viewer" ) ) {
2820     connect( viewModel, SIGNAL( viewCloned( SUIT_ViewWindow* ) ),
2821              this, SLOT( cloneView( SUIT_ViewWindow* ) ),
2822              Qt::UniqueConnection );
2823   }
2824 }
2825
2826
2827
2828 void PyModuleHelper::internalOBClickedPython( const QString& theObj, int theColumn)
2829 {
2830   FuncMsg fmsg( "--- PyModuleHelper::internalOBClickedPython()" );
2831
2832   // Python interpreter should be initialized and Python module should be
2833   // import first
2834   if ( !myInterp || !myPyModule )
2835     return; // Error
2836
2837   if ( PyObject_HasAttrString( myPyModule, (char*)"onObjectBrowserClicked" ) ) {
2838     PyObjWrapper res( PyObject_CallMethod( myPyModule, (char*)"onObjectBrowserClicked", (char*)"si", theObj.toLatin1().constData(), theColumn ) );
2839     if( !res ) {
2840       PyErr_Print();
2841     }
2842   }
2843 }
2844
2845
2846
2847 void PyModuleHelper::onObjectBrowserClicked(SUIT_DataObject* theObj, int theColumn)
2848 {
2849   FuncMsg fmsg( "PyModuleHelper::onObjectBrowserClicked()" );
2850
2851   // temporary set myInitModule because dumpPython() method
2852   // might be called by the framework when this module is inactive,
2853   // but still it should be possible to access this module's data
2854   // from Python
2855   InitLocker lock( myModule );
2856
2857   class PythonReq: public PyInterp_LockRequest
2858   {
2859   public:
2860     PythonReq( PyInterp_Interp* _py_interp,
2861                PyModuleHelper*  _helper,
2862                const QString& _entry,
2863                int     _column )
2864       : PyInterp_LockRequest( _py_interp, 0, true ), // this request should be processed synchronously (sync == true)
2865         myHelper( _helper ) ,
2866         myEntry( _entry ),
2867         myColumn( _column )
2868     {}
2869   protected:
2870     virtual void execute()
2871     {
2872       myHelper->internalOBClickedPython( myEntry, myColumn );
2873     }
2874   private:
2875     PyModuleHelper* myHelper;
2876     int    myColumn;
2877     QString myEntry;
2878   };
2879
2880   // Posting the request only if dispatcher is not busy!
2881   // Executing the request synchronously
2882   const LightApp_DataObject* data_object = dynamic_cast<const LightApp_DataObject*>( theObj );
2883   if ( (!PyInterp_Dispatcher::Get()->IsBusy()) && data_object )
2884     PyInterp_Dispatcher::Get()->Exec( new PythonReq( myInterp, this, data_object->entry(), theColumn ) );
2885 }
2886