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   if ( !CORBA::is_nil( aNode ) ) {
 140
 141     SUPERV::Graph_var dataflow = Supervision.getMain()->getDataflow();
 142
 143     switch ( aNode->Kind() ) {
 144
 145     case SUPERV::FactoryNode :
 146       {
 147         SUPERV::FNode_var aFNode = dataflow->FNode( SUPERV::FNode::_narrow(aNode)->GetComponentName(),
 148                                                SUPERV::FNode::_narrow(aNode)->GetInterfaceName(),
 149                                                *SUPERV::FNode::_narrow(aNode)->Service() );
 150         if (CORBA::is_nil(aFNode)) {
 151           QMessageBox::warning(QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 152           return;
 153         }
 154
 155         SUPERV::INode_var aDummyEndNode;
 156         Supervision.getBrowser()->addNode(SUPERV::CNode::_narrow(aFNode), aDummyEndNode, myXCopyNode, myYCopyNode);
 157       }
 158       break;
 159
 160     case SUPERV::ComputingNode :
 161       {
 162         SUPERV::CNode_var aCNode = dataflow->CNode(*SUPERV::CNode::_narrow(aNode)->Service());
 163         if (CORBA::is_nil(aCNode)) {
 164           QMessageBox::warning(QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 165           return;
 166         }
 167
 168         SUPERV::INode_var aDummyEndNode;
 169         Supervision.getBrowser()->addNode(aCNode, aDummyEndNode, myXCopyNode, myYCopyNode);
 170       }
 171       break;
 172
 173     case SUPERV::InLineNode :
 174       {
 175         QString aFName;                  // new node's Py_function name
 176         SUPERV::ListOfStrings_var aFunc; // new node's Py_function body
 177
 178         // Automatic change of Py_function name ( + "_1", etc.)
 179         // 1. collect all python functions names of allready exist InLine nodes
 180         QStringList aFuncNames = getAllFunctions( dataflow );
 181         // 2. "fix" Main function_name and Main function_strings
 182         QString aOriginalName = SUPERV::INode::_narrow(aNode)->PyFuncName();
 183         if ( !aOriginalName.isEmpty() ) {
 184           aFName = getNewName( aFuncNames, aOriginalName );
 185           aFunc = SUPERV::INode::_narrow(aNode)->PyFunction();
 186           replaceName( aFunc, aOriginalName, aFName );
 187         }
 188         else { // empty function name and body
 189           aFName = QString( "" );
 190           aFunc = new SUPERV::ListOfStrings();
 191         }
 192
 193         // create the Engine's node
 194         SUPERV::INode_var aINode = dataflow->INode( aFName, aFunc );
 195
 196         if (CORBA::is_nil(aINode)) {
 197           QMessageBox::warning(QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 198           return;
 199         }
 200         copyPorts( aNode, aINode );
 201
 202         SUPERV::INode_var aDummyEndNode;
 203         Supervision.getBrowser()->addNode(SUPERV::CNode::_narrow(aINode), aDummyEndNode, myXCopyNode, myYCopyNode);
 204       }
 205       break;
 206
 207     case SUPERV::LoopNode :
 208       {
 209         QString aInitFName, aMoreFName, aNextFName;                // new node's Py_functions names
 210         SUPERV::ListOfStrings_var aInitFunc, aMoreFunc, aNextFunc; // new node's Py_functions bodies
 211
 212         // Automatic change of Py_function name ( + "_1", etc.)
 213         // 1. collect all python functions names of allready exist InLine nodes
 214         QStringList aFuncNames = getAllFunctions( dataflow );
 215         // 2.1 "fix" Init function_name and Init function_strings
 216         QString aOriginalName = SUPERV::LNode::_narrow(aNode)->PyInitName();
 217         if (!aOriginalName.isEmpty()) {
 218           aInitFName = getNewName( aFuncNames, aOriginalName );
 219           aInitFunc = SUPERV::LNode::_narrow(aNode)->PyInit();
 220           replaceName( aInitFunc, aOriginalName, aInitFName );
 221         }
 222         else { // empty function name and body
 223           aInitFName = QString( "" );
 224           aInitFunc = new SUPERV::ListOfStrings();
 225         }
 226         // 2.2 "fix" More function_name and More function_strings
 227         aOriginalName = SUPERV::LNode::_narrow(aNode)->PyMoreName();
 228         if (!aOriginalName.isEmpty()) {
 229           aMoreFName = getNewName( aFuncNames, aOriginalName );
 230           aMoreFunc = SUPERV::LNode::_narrow(aNode)->PyMore();
 231           replaceName( aMoreFunc, aOriginalName, aMoreFName );
 232         }
 233         else { // empty function name and body
 234           aMoreFName = QString( "" );
 235           aMoreFunc = new SUPERV::ListOfStrings();
 236         }
 237         // 2.3 "fix" Next function_name and Next function_strings
 238         aOriginalName = SUPERV::LNode::_narrow(aNode)->PyNextName();
 239         if (!aOriginalName.isEmpty()) {
 240           aNextFName = getNewName( aFuncNames, aOriginalName );
 241           aNextFunc = SUPERV::LNode::_narrow(aNode)->PyNext();
 242           replaceName( aNextFunc, aOriginalName, aNextFName );
 243         }
 244         else { // empty function name and body
 245           aNextFName = QString( "" );
 246           aNextFunc = new SUPERV::ListOfStrings();
 247         }
 248
 249         // create the Engine's node
 250         SUPERV::INode_var aEndNode;
 251         SUPERV::LNode_var aStartNode = dataflow->LNode(aInitFName, aInitFunc, aMoreFName, aMoreFunc, aNextFName, aNextFunc, aEndNode);
 252         if (CORBA::is_nil(aStartNode) || CORBA::is_nil(aEndNode)) {
 253           QMessageBox::warning(QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 254           return;
 255         }
 256         copyPorts( aNode, SUPERV::INode::_narrow( aStartNode ) );
 257
 258         Supervision.getBrowser()->addNode(SUPERV::CNode::_narrow(aStartNode), aEndNode, myXCopyNode, myYCopyNode);
 259       }
 260       break;
 261
 262     case SUPERV::SwitchNode :
 263       {
 264         QString aFName;                  // new node's Py_function name
 265         SUPERV::ListOfStrings_var aFunc; // new node's Py_function body
 266
 267         // Automatic change of Py_function name ( + "_1", etc.)
 268         // 1. collect all python functions names of allready exist InLine nodes
 269         QStringList aFuncNames = getAllFunctions( dataflow );
 270         // 2. "fix" Main function_name and Main function_strings
 271         QString aOriginalName = SUPERV::INode::_narrow(aNode)->PyFuncName();
 272         if ( !aOriginalName.isEmpty() ) {
 273           aFName = getNewName( aFuncNames, aOriginalName );
 274           aFunc = SUPERV::INode::_narrow(aNode)->PyFunction();
 275           replaceName( aFunc, aOriginalName, aFName );
 276         }
 277         else { // empty function name and body
 278           aFName = QString( "" );
 279           aFunc = new SUPERV::ListOfStrings();
 280         }
 281
 282         // create the Engine's node
 283         SUPERV::INode_var aEndNode;
 284         SUPERV::SNode_var aStartNode = dataflow->SNode(aFName, aFunc, aEndNode);
 285         if (CORBA::is_nil(aStartNode) || CORBA::is_nil(aEndNode)) {
 286           QMessageBox::warning(QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 287           return;
 288         }
 289         copyPorts( aNode, SUPERV::INode::_narrow( aStartNode ) );
 290         SUPERV::INode_var aNodeEnd = SUPERV::SNode::_narrow(aNode)->Coupled();
 291         copyPorts( SUPERV::CNode::_narrow( aNodeEnd ), aEndNode );
 292
 293         Supervision.getBrowser()->addNode(SUPERV::CNode::_narrow(aStartNode), aEndNode, myXCopyNode, myYCopyNode);
 294       }
 295       break;
 296
 297     case SUPERV::GOTONode :
 298       {
 299         QString aFName;                  // new node's Py_function name
 300         SUPERV::ListOfStrings_var aFunc; // new node's Py_function body
 301
 302         // Automatic change of Py_function name ( + "_1", etc.)
 303         // 1. collect all python functions names of allready exist InLine nodes
 304         QStringList aFuncNames = getAllFunctions( dataflow );
 305         // 2. "fix" Main function_name and Main function_strings
 306         QString aOriginalName = SUPERV::INode::_narrow(aNode)->PyFuncName();
 307         if ( !aOriginalName.isEmpty() ) {
 308           aFName = getNewName( aFuncNames, aOriginalName );
 309           aFunc = SUPERV::INode::_narrow(aNode)->PyFunction();
 310           replaceName( aFunc, aOriginalName, aFName );
 311         }
 312         else { // empty function name and body
 313           aFName = QString( "" );
 314           aFunc = new SUPERV::ListOfStrings();
 315         }
 316
 317         // create the Engine's node
 318         SUPERV::GNode_var aGNode = dataflow->GNode(aFName, aFunc, "");
 319         if (CORBA::is_nil(aGNode)) {
 320           QMessageBox::warning(QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 321           return;
 322         }
 323         copyPorts( aNode, SUPERV::INode::_narrow( aGNode ) );
 324
 325         SUPERV::INode_var aDummyEndNode;
 326         Supervision.getBrowser()->addNode(SUPERV::CNode::_narrow(aGNode), aDummyEndNode, myXCopyNode, myYCopyNode);
 327       }
 328       break;
 329
 330     case SUPERV::MacroNode :
 331       {
 332         /* to implement in the future */
 333         /*
 334         //get SubGraph from MacroNode
 335         SUPERV::Graph_var aMacro = SUPERV::Graph::_narrow(aNode);
 336         SUPERV::Graph_var aGraph;
 337         if (aMacro->IsStreamMacro())
 338           aGraph = aMacro->StreamObjRef();
 339         else
 340           aGraph = aMacro->FlowObjRef();
 341         SUPERV::Graph_var aMacroNode = dataflow->GraphMNode(aGraph);
 342
 343         if (CORBA::is_nil(aMacroNode)) {
 344           QMessageBox::warning(QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_CANT_CREATE_NODE"));
 345           return;
 346         }
 347
 348         SUPERV::INode_var aDummyEndNode;
 349         Supervision.getBrowser()->addNode(SUPERV::CNode::_narrow(aMacroNode), aDummyEndNode, myXCopyNode, myYCopyNode);
 350         */
 351       }
 352       break;
 353     }
 354   }
 355 }
 356
 357
 358 /**
 359  * Called from CanvasNode on "Paste port" command of popup menu
 360  */
 361 void SUPERVGUI_Clipboard::pastePort( SUPERVGUI_CanvasNode* node )
 362 {
 363   SUPERV::Port_var aPort = getCopyPort();
 364   if ( !CORBA::is_nil(aPort) ) {
 365     SUPERV::INode_var aNode = node->getInlineNode();
 366     if (!CORBA::is_nil(aNode)) {
 367       QString aName = aPort->Name();
 368       QString aType = aPort->Type();
 369       SUPERV::Port_var aPastePort;
 370       if (aPort->IsInput()) {
 371         //check if port with such name is alredy exists
 372         QStringList aNames = node->getPortsNamesIN(aNode, true);
 373         if (aNames.contains(aName))
 374           QMessageBox::warning( QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_PORT_EXIST") );
 375         else
 376           aPastePort = aNode->InPort(aName.latin1(), aType.latin1());
 377       }
 378       else {
 379         //check if port with such name is already exists
 380         QStringList aNames = node->getPortsNamesIN(aNode, false);
 381         if (aNames.contains(aName))
 382           QMessageBox::warning( QAD_Application::getDesktop(), tr("ERROR"), tr("MSG_PORT_EXIST") );
 383         else
 384           aPastePort = aNode->OutPort(aName.latin1(), aType.latin1());
 385       }
 386       if ( !CORBA::is_nil(aPastePort) )
 387         node->createPort( aPastePort.in() );
 388     }
 389   }
 390 }