src/SUPERVGUI/SUPERVGUI_Clipboard.cxx

   1 //  SUPERV SUPERVGUI : GUI for Supervisor component
   2 //
   3 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : SUPERVGUI_Clipboard.cxx
  25 //  Author : Alexander SLADKOV
  26 //  Module : SUPERV
  27
  28
  29 #include "SUPERVGUI_Clipboard.h"
  30 #include "SUPERVGUI_CanvasNode.h"
  31 #include "SUPERVGUI.h"
  32
  33
  34 SUPERVGUI_Clipboard* SUPERVGUI_Clipboard::myCB = 0;
  35
  36
  37 /**
  38  * Compute the next valid name for a Python function (add "_N" if a function with given name already exists)
  39  */
  40 QString getNewName( QStringList& allNames, const QString& oldName ) {
  41   QString newName;
  42   int id = 1; //increment index
  43   newName = oldName + QString("_") + QString::number( id );
  44   while ( allNames.contains( newName ) )
  45     newName = oldName + QString("_") + QString::number( ++id );
  46
  47   return newName;
  48 }
  49
  50 /**
  51  * Replaces origName string with newName string in all lines of theFunc
  52  * origName must be preceeded by space and end by space or '('.
  53  * asv : 14.01.05 : fix of a bug (exception on node creation):
  54  *      if origName and theFunc is null, return non-null empty strings!
  55  */
  56 void replaceName( SUPERV::ListOfStrings_var& theFunc, const QString& origName, const QString& newName ) {
  57   for ( int i = 0, n = theFunc->length(); i < n; i++ ) {
  58     QString aLine( theFunc[i] );
  59     int index = aLine.find( origName, 0 ); // find FIRST occurance of origName in aLine
  60     while ( index >= 0 ) {
  61       bool preceedingCharOk = ( index==0 || ( index > 0 && aLine[index-1].isSpace() ) );
  62       const int ll = aLine.length();
  63       const int ol = origName.length();
  64       const int ni = index + ol;
  65       bool nextCharOk = ( ll==ni || ( ll>ni && ( aLine[ni].isSpace() || aLine[ni]=='(' ) ) );
  66       if ( preceedingCharOk && nextCharOk ) {
  67         aLine = aLine.replace( index, origName.length(), newName );
  68         theFunc[i] = aLine.latin1();
  69       }
  70       index = aLine.find( origName, index+newName.length() ); // find NEXT occurance of origName in aLine
  71     }
  72   }
  73 }
  74
  75 /**
  76  * "Copies" all ports from fromNode to toNode: creates the sames ports in toNode in fact
  77  */
  78 void copyPorts( const SUPERV::CNode_var& fromNode, const SUPERV::INode_var& toNode ) {
  79   if ( CORBA::is_nil( fromNode ) || CORBA::is_nil( toNode ) )
  80     return;
  81   SUPERV::ListOfPorts_var aPList = fromNode->Ports();
  82   QString aName, aType;
  83   for (int i = 0; i < aPList->length(); i++) {
  84     aName = aPList[i].in()->Name();
  85     aType = aPList[i].in()->Type();
  86     if ( aPList[i].in()->IsInput() )
  87       toNode->InPort( aName.latin1(), aType.latin1() );
  88     else
  89       toNode->OutPort( aName.latin1(), aType.latin1() );
  90   }
  91 }
  92
  93 /**
  94  * Constructor
  95  */
  96 SUPERVGUI_Clipboard::SUPERVGUI_Clipboard( QObject* parent )
  97 : QObject( parent ) {
  98 }
  99
 100 /**
 101  * Destructor
 102  */
 103 SUPERVGUI_Clipboard::~SUPERVGUI_Clipboard() {
 104 }
 105
 106 /**
 107  * Returns all inline functions defined in inline (switch, loop, goto) nodes of given dataflow
 108  */
 109 QStringList getAllFunctions( SUPERV::Graph_var dataflow ) {
 110   QStringList aFuncNames;
 111   if ( !CORBA::is_nil( dataflow ) ) {
 112     SUPERV::ListOfNodes_var nodes = dataflow->Nodes();
 113     //InLine nodes
 114     for(int i = 0; i < nodes->INodes.length(); i++)
 115       aFuncNames.append(nodes->INodes[i]->PyFuncName());
 116     //Loop nodes
 117     for(int i = 0; i < nodes->LNodes.length(); i++) {
 118       aFuncNames.append(nodes->LNodes[i]->PyInitName());
 119       aFuncNames.append(nodes->LNodes[i]->PyMoreName());
 120       aFuncNames.append(nodes->LNodes[i]->PyNextName());
 121     }
 122     //Switch nodes
 123     for(int i = 0; i < nodes->SNodes.length(); i++)
 124       aFuncNames.append(nodes->SNodes[i]->PyFuncName());
 125     //GOTO nodes
 126     for(int i = 0; i < nodes->GNodes.length(); i++)
 127       aFuncNames.append(nodes->GNodes[i]->PyFuncName());
 128   }
 129   return aFuncNames;
 130 }
 131
 132 /**
 133  * Called on Paste Node command.  Inserts a new node to the dataflow equal to the copied node.
 134  * For InLine nodes the Python function name is changed ("_N" added).
 135  */
 136 void SUPERVGUI_Clipboard::pasteNode() {
 137   Trace("SUPERVGUI_Main::pasteNode");
 138   SUPERV::CNode_var aNode = getCopyNode();
 139
 140   SUPERVGUI* aSupMod = SUPERVGUI::Supervision();
 141   if ( !aSupMod ) {
 142     MESSAGE("NULL Supervision module!");
 143     return;
 144   }
 145
 146   SUPERVGUI_Main* aMain = aSupMod->getMain();
 147   if ( !CORBA::is_nil( aNode ) && aMain ) {
 148
 149     if ( !aMain->ReadyToModify() ) // null dataflow or executing, ..
 150       return;
 151
 152     aMain->Editing(); // PAL6170: GUI->Engine: setting "Editing" flag, why here? -> PAL7960
 153
 154     SUPERV::Graph_var dataflow = aMain->getDataflow();
 155
 156     switch ( aNode->Kind() ) {
 157
 158     case SUPERV::FactoryNode :
 159       {
 160         SUPERV::FNode_var aFNode = dataflow->FNode( SUPERV::FNode::_narrow(aNode)->GetComponentName(),
 161                                                SUPERV::FNode::_narrow(aNode)->GetInterfaceName(),
 162                                                *SUPERV::FNode::_narrow(aNode)->Service() );
 163         if (CORBA::is_nil(aFNode)) {
 164           QMessageBox::warning(SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 165           return;
 166         }
 167
 168         SUPERV::INode_var aDummyEndNode;
 169         aSupMod->getBrowser()->addNode(SUPERV::CNode::_narrow(aFNode), aDummyEndNode, myXCopyNode, myYCopyNode);
 170       }
 171       break;
 172
 173     case SUPERV::ComputingNode :
 174       {
 175         SUPERV::CNode_var aCNode = dataflow->CNode(*SUPERV::CNode::_narrow(aNode)->Service());
 176         if (CORBA::is_nil(aCNode)) {
 177           QMessageBox::warning(SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 178           return;
 179         }
 180
 181         SUPERV::INode_var aDummyEndNode;
 182         aSupMod->getBrowser()->addNode(aCNode, aDummyEndNode, myXCopyNode, myYCopyNode);
 183       }
 184       break;
 185
 186     case SUPERV::InLineNode :
 187       {
 188         QString aFName;                  // new node's Py_function name
 189         SUPERV::ListOfStrings_var aFunc; // new node's Py_function body
 190
 191         // Automatic change of Py_function name ( + "_1", etc.)
 192         // 1. collect all python functions names of allready exist InLine nodes
 193         QStringList aFuncNames = getAllFunctions( dataflow );
 194         // 2. "fix" Main function_name and Main function_strings
 195         QString aOriginalName = SUPERV::INode::_narrow(aNode)->PyFuncName();
 196         if ( !aOriginalName.isEmpty() ) {
 197           aFName = getNewName( aFuncNames, aOriginalName );
 198           aFunc = SUPERV::INode::_narrow(aNode)->PyFunction();
 199           replaceName( aFunc, aOriginalName, aFName );
 200         }
 201         else { // empty function name and body
 202           aFName = QString( "" );
 203           aFunc = new SUPERV::ListOfStrings();
 204         }
 205
 206         // create the Engine's node
 207         SUPERV::INode_var aINode = dataflow->INode( aFName, aFunc );
 208
 209         if (CORBA::is_nil(aINode)) {
 210           QMessageBox::warning(SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 211           return;
 212         }
 213         copyPorts( aNode, aINode );
 214
 215         SUPERV::INode_var aDummyEndNode;
 216         aSupMod->getBrowser()->addNode(SUPERV::CNode::_narrow(aINode), aDummyEndNode, myXCopyNode, myYCopyNode);
 217       }
 218       break;
 219
 220     case SUPERV::LoopNode :
 221       {
 222         QString aInitFName, aMoreFName, aNextFName;                // new node's Py_functions names
 223         SUPERV::ListOfStrings_var aInitFunc, aMoreFunc, aNextFunc; // new node's Py_functions bodies
 224
 225         // Automatic change of Py_function name ( + "_1", etc.)
 226         // 1. collect all python functions names of allready exist InLine nodes
 227         QStringList aFuncNames = getAllFunctions( dataflow );
 228         // 2.1 "fix" Init function_name and Init function_strings
 229         QString aOriginalName = SUPERV::LNode::_narrow(aNode)->PyInitName();
 230         if (!aOriginalName.isEmpty()) {
 231           aInitFName = getNewName( aFuncNames, aOriginalName );
 232           aInitFunc = SUPERV::LNode::_narrow(aNode)->PyInit();
 233           replaceName( aInitFunc, aOriginalName, aInitFName );
 234         }
 235         else { // empty function name and body
 236           aInitFName = QString( "" );
 237           aInitFunc = new SUPERV::ListOfStrings();
 238         }
 239         // 2.2 "fix" More function_name and More function_strings
 240         aOriginalName = SUPERV::LNode::_narrow(aNode)->PyMoreName();
 241         if (!aOriginalName.isEmpty()) {
 242           aMoreFName = getNewName( aFuncNames, aOriginalName );
 243           aMoreFunc = SUPERV::LNode::_narrow(aNode)->PyMore();
 244           replaceName( aMoreFunc, aOriginalName, aMoreFName );
 245         }
 246         else { // empty function name and body
 247           aMoreFName = QString( "" );
 248           aMoreFunc = new SUPERV::ListOfStrings();
 249         }
 250         // 2.3 "fix" Next function_name and Next function_strings
 251         aOriginalName = SUPERV::LNode::_narrow(aNode)->PyNextName();
 252         if (!aOriginalName.isEmpty()) {
 253           aNextFName = getNewName( aFuncNames, aOriginalName );
 254           aNextFunc = SUPERV::LNode::_narrow(aNode)->PyNext();
 255           replaceName( aNextFunc, aOriginalName, aNextFName );
 256         }
 257         else { // empty function name and body
 258           aNextFName = QString( "" );
 259           aNextFunc = new SUPERV::ListOfStrings();
 260         }
 261
 262         // create the Engine's node
 263         SUPERV::INode_var aEndNode;
 264         SUPERV::LNode_var aStartNode = dataflow->LNode(aInitFName, aInitFunc, aMoreFName, aMoreFunc, aNextFName, aNextFunc, aEndNode);
 265         if (CORBA::is_nil(aStartNode) || CORBA::is_nil(aEndNode)) {
 266           QMessageBox::warning(SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 267           return;
 268         }
 269         copyPorts( aNode, SUPERV::INode::_narrow( aStartNode ) );
 270
 271         aSupMod->getBrowser()->addNode(SUPERV::CNode::_narrow(aStartNode), aEndNode, myXCopyNode, myYCopyNode);
 272       }
 273       break;
 274
 275     case SUPERV::SwitchNode :
 276       {
 277         QString aFName;                  // new node's Py_function name
 278         SUPERV::ListOfStrings_var aFunc; // new node's Py_function body
 279
 280         // Automatic change of Py_function name ( + "_1", etc.)
 281         // 1. collect all python functions names of allready exist InLine nodes
 282         QStringList aFuncNames = getAllFunctions( dataflow );
 283         // 2. "fix" Main function_name and Main function_strings
 284         QString aOriginalName = SUPERV::INode::_narrow(aNode)->PyFuncName();
 285         if ( !aOriginalName.isEmpty() ) {
 286           aFName = getNewName( aFuncNames, aOriginalName );
 287           aFunc = SUPERV::INode::_narrow(aNode)->PyFunction();
 288           replaceName( aFunc, aOriginalName, aFName );
 289         }
 290         else { // empty function name and body
 291           aFName = QString( "" );
 292           aFunc = new SUPERV::ListOfStrings();
 293         }
 294
 295         // create the Engine's node
 296         SUPERV::INode_var aEndNode;
 297         SUPERV::SNode_var aStartNode = dataflow->SNode(aFName, aFunc, aEndNode);
 298         if (CORBA::is_nil(aStartNode) || CORBA::is_nil(aEndNode)) {
 299           QMessageBox::warning(SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 300           return;
 301         }
 302         copyPorts( aNode, SUPERV::INode::_narrow( aStartNode ) );
 303         SUPERV::INode_var aNodeEnd = SUPERV::SNode::_narrow(aNode)->Coupled();
 304         copyPorts( SUPERV::CNode::_narrow( aNodeEnd ), aEndNode );
 305
 306         aSupMod->getBrowser()->addNode(SUPERV::CNode::_narrow(aStartNode), aEndNode, myXCopyNode, myYCopyNode);
 307       }
 308       break;
 309
 310     case SUPERV::GOTONode :
 311       {
 312         QString aFName;                  // new node's Py_function name
 313         SUPERV::ListOfStrings_var aFunc; // new node's Py_function body
 314
 315         // Automatic change of Py_function name ( + "_1", etc.)
 316         // 1. collect all python functions names of allready exist InLine nodes
 317         QStringList aFuncNames = getAllFunctions( dataflow );
 318         // 2. "fix" Main function_name and Main function_strings
 319         QString aOriginalName = SUPERV::INode::_narrow(aNode)->PyFuncName();
 320         if ( !aOriginalName.isEmpty() ) {
 321           aFName = getNewName( aFuncNames, aOriginalName );
 322           aFunc = SUPERV::INode::_narrow(aNode)->PyFunction();
 323           replaceName( aFunc, aOriginalName, aFName );
 324         }
 325         else { // empty function name and body
 326           aFName = QString( "" );
 327           aFunc = new SUPERV::ListOfStrings();
 328         }
 329
 330         // create the Engine's node
 331         SUPERV::GNode_var aGNode = dataflow->GNode(aFName, aFunc, "");
 332         if (CORBA::is_nil(aGNode)) {
 333           QMessageBox::warning(SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 334           return;
 335         }
 336         copyPorts( aNode, SUPERV::INode::_narrow( aGNode ) );
 337
 338         SUPERV::INode_var aDummyEndNode;
 339         aSupMod->getBrowser()->addNode(SUPERV::CNode::_narrow(aGNode), aDummyEndNode, myXCopyNode, myYCopyNode);
 340       }
 341       break;
 342
 343     case SUPERV::MacroNode :
 344       {
 345         /* to implement in the future */
 346         /*
 347         //get SubGraph from MacroNode
 348         SUPERV::Graph_var aMacro = SUPERV::Graph::_narrow(aNode);
 349         SUPERV::Graph_var aGraph;
 350         if (aMacro->IsStreamMacro())
 351           aGraph = aMacro->StreamObjRef();
 352         else
 353           aGraph = aMacro->FlowObjRef();
 354         SUPERV::Graph_var aMacroNode = dataflow->GraphMNode(aGraph);
 355
 356         if (CORBA::is_nil(aMacroNode)) {
 357           QMessageBox::warning(SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 358           return;
 359         }
 360
 361         SUPERV::INode_var aDummyEndNode;
 362         aSupMod->getBrowser()->addNode(SUPERV::CNode::_narrow(aMacroNode), aDummyEndNode, myXCopyNode, myYCopyNode);
 363         */
 364       }
 365       break;
 366     }
 367   }
 368 }
 369
 370
 371 /**
 372  * Called from CanvasNode on "Paste port" command of popup menu
 373  */
 374 void SUPERVGUI_Clipboard::pastePort( SUPERVGUI_CanvasNode* node )
 375 {
 376   SUPERV::Port_var aPort = getCopyPort();
 377
 378   SUPERVGUI* aSupMod = SUPERVGUI::Supervision();
 379   if ( !aSupMod ) {
 380     MESSAGE("NULL Supervision module!");
 381     return;
 382   }
 383
 384   SUPERVGUI_Main* aMain = aSupMod->getMain();
 385   if ( !CORBA::is_nil(aPort) && aMain ) {
 386
 387     SUPERV::INode_var aNode = node->getInlineNode();
 388     if (!CORBA::is_nil(aNode)) {
 389       QString aName = aPort->Name();
 390       QString aType = aPort->Type();
 391       SUPERV::Port_var aPastePort;
 392       if (aPort->IsInput()) {
 393         //check if port with such name is alredy exists
 394         QStringList aNames = node->getPortsNamesIN(aNode, true);
 395         if (aNames.contains(aName))
 396           QMessageBox::warning( SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_PORT_EXIST") );
 397         else {
 398           aMain->Editing(); // PAL6170: GUI->Engine: setting "Editing" flag, why here? -> PAL7960
 399           aPastePort = aNode->InPort(aName.latin1(), aType.latin1());
 400         }
 401       }
 402       else {
 403         //check if port with such name is already exists
 404         QStringList aNames = node->getPortsNamesIN(aNode, false);
 405         if (aNames.contains(aName))
 406           QMessageBox::warning( SUIT_Session::session()->activeApplication()->desktop(), tr("ERROR"), tr("MSG_PORT_EXIST") );
 407         else {
 408           aMain->Editing(); // PAL6170: GUI->Engine: setting "Editing" flag, why here? -> PAL7960
 409           aPastePort = aNode->OutPort(aName.latin1(), aType.latin1());
 410         }
 411       }
 412       if ( !CORBA::is_nil(aPastePort) )
 413         node->createPort( aPastePort.in() );
 414     }
 415   }
 416 }