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