src/XGUI/XGUI_OperationMgr.cpp

   1 // File:        XGUI_OperationMgr.h
   2 // Created:     20 Apr 2014
   3 // Author:      Natalia ERMOLAEVA
   4
   5 #include "XGUI_OperationMgr.h"
   6
   7 #include "ModuleBase_Operation.h"
   8 #include <ModelAPI_Validator.h>
   9 #include <ModelAPI_FeatureValidator.h>
  10
  11 #include <QMessageBox>
  12 #include <QApplication>
  13 #include <QKeyEvent>
  14
  15 XGUI_OperationMgr::XGUI_OperationMgr(QObject* theParent)
  16     : QObject(theParent)
  17 {
  18   // listen to Escape signal to stop the current operation
  19   qApp->installEventFilter(this);
  20 }
  21
  22 XGUI_OperationMgr::~XGUI_OperationMgr()
  23 {
  24 }
  25
  26 ModuleBase_Operation* XGUI_OperationMgr::currentOperation() const
  27 {
  28   return myOperations.count() > 0 ? myOperations.last() : 0;
  29 }
  30
  31 bool XGUI_OperationMgr::hasOperation() const
  32 {
  33   return (myOperations.count() > 0) && (myOperations.last() != NULL);
  34 }
  35
  36 int XGUI_OperationMgr::operationsCount() const
  37 {
  38   return myOperations.count();
  39 }
  40
  41 QStringList XGUI_OperationMgr::operationList() const
  42 {
  43   QStringList result;
  44   foreach(ModuleBase_Operation* eachOperation, myOperations) {
  45     FeaturePtr aFeature = eachOperation->feature();
  46     if(aFeature) {
  47       result << QString::fromStdString(aFeature->getKind());
  48     }
  49   }
  50   return result;
  51 }
  52
  53 ModuleBase_Operation* XGUI_OperationMgr::previousOperation(ModuleBase_Operation* theOperation) const
  54 {
  55   int idx = myOperations.lastIndexOf(theOperation);
  56   if(idx == -1 || idx == 0) {
  57     return NULL;
  58   }
  59   return myOperations.at(idx - 1);
  60 }
  61
  62 bool XGUI_OperationMgr::eventFilter(QObject *theObject, QEvent *theEvent)
  63 {
  64   if (theEvent->type() == QEvent::KeyRelease) {
  65     QKeyEvent* aKeyEvent = dynamic_cast<QKeyEvent*>(theEvent);
  66     if(aKeyEvent) {
  67       onKeyReleased(aKeyEvent);
  68       return true;
  69     }
  70   }
  71   return QObject::eventFilter(theObject, theEvent);
  72 }
  73
  74 bool XGUI_OperationMgr::startOperation(ModuleBase_Operation* theOperation)
  75 {
  76   if (!canStartOperation(theOperation))
  77     return false;
  78
  79   myOperations.append(theOperation);
  80
  81   connect(theOperation, SIGNAL(stopped()), this, SLOT(onOperationStopped()));
  82   connect(theOperation, SIGNAL(started()), this, SIGNAL(operationStarted()));
  83   connect(theOperation, SIGNAL(resumed()), this, SIGNAL(operationResumed()));
  84   connect(theOperation, SIGNAL(activateNextWidget(ModuleBase_ModelWidget*)), this,
  85           SIGNAL(activateNextWidget(ModuleBase_ModelWidget*)));
  86
  87   theOperation->start();
  88   onValidateOperation();
  89   return true;
  90 }
  91
  92 bool XGUI_OperationMgr::abortAllOperations()
  93 {
  94   if(!hasOperation()) {
  95     return true;
  96   } else if (operationsCount() == 1) {
  97     onAbortOperation();
  98     return true;
  99   }
 100   QString aMessage = tr("All active operations will be aborted.");
 101   int anAnswer = QMessageBox::question(qApp->activeWindow(),
 102                                        tr("Abort operation"),
 103                                        aMessage,
 104                                        QMessageBox::Ok | QMessageBox::Cancel,
 105                                        QMessageBox::Cancel);
 106   bool result = anAnswer == QMessageBox::Ok;
 107   while(result && hasOperation()) {
 108     currentOperation()->abort();
 109   }
 110   return result;
 111 }
 112
 113 bool XGUI_OperationMgr::validateOperation(ModuleBase_Operation* theOperation)
 114 {
 115   if (!theOperation)
 116     return false;
 117   //Get operation feature to validate
 118   FeaturePtr aFeature = theOperation->feature();
 119   if (!aFeature) return true; // rename operation
 120   //Get validators for the Id
 121   SessionPtr aMgr = ModelAPI_Session::get();
 122   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
 123
 124   bool isValid = aFactory->validate(aFeature);
 125   emit operationValidated(isValid);
 126   return isValid;
 127 }
 128
 129 void XGUI_OperationMgr::onValidateOperation()
 130 {
 131   if (!hasOperation())
 132     return;
 133   ModuleBase_Operation* anOperation = currentOperation();
 134   validateOperation(currentOperation());
 135 }
 136
 137 bool XGUI_OperationMgr::commitOperation()
 138 {
 139   if (validateOperation(currentOperation())) {
 140     onCommitOperation();
 141     return true;
 142   }
 143   return false;
 144 }
 145
 146 void XGUI_OperationMgr::resumeOperation(ModuleBase_Operation* theOperation)
 147 {
 148   theOperation->resume();
 149 }
 150
 151 bool XGUI_OperationMgr::canStartOperation(ModuleBase_Operation* theOperation)
 152 {
 153   bool aCanStart = true;
 154   ModuleBase_Operation* aCurrentOp = currentOperation();
 155   if (aCurrentOp) {
 156     if (!theOperation->isGranted()) {
 157       if (!aCurrentOp->isValid(theOperation)) {
 158         if (canAbortOperation()) {
 159           aCurrentOp->abort();
 160         } else {
 161           aCanStart = false;
 162         }
 163       }
 164     }
 165   }
 166   return aCanStart;
 167 }
 168
 169
 170 void XGUI_OperationMgr::onCommitOperation()
 171 {
 172   ModuleBase_Operation* anOperation = currentOperation();
 173   if (anOperation)
 174     anOperation->commit();
 175 }
 176
 177 void XGUI_OperationMgr::onAbortOperation()
 178 {
 179   if (hasOperation() && canAbortOperation()) {
 180     currentOperation()->abort();
 181   }
 182 }
 183
 184 bool XGUI_OperationMgr::canAbortOperation()
 185 {
 186   ModuleBase_Operation* anOperation = currentOperation();
 187   if(operationsCount() > 1) //in case of nested (sketch) operation no confirmation needed
 188     return true;
 189   if (anOperation && anOperation->isModified()) {
 190     QString aMessage = tr("%1 operation will be aborted.").arg(anOperation->id());
 191     int anAnswer = QMessageBox::question(qApp->activeWindow(),
 192                                          tr("Abort operation"),
 193                                          aMessage,
 194                                          QMessageBox::Ok | QMessageBox::Cancel,
 195                                          QMessageBox::Cancel);
 196     return anAnswer == QMessageBox::Ok;
 197   }
 198   return true;
 199 }
 200
 201 void XGUI_OperationMgr::onOperationStopped()
 202 {
 203   ModuleBase_Operation* aSenderOperation = dynamic_cast<ModuleBase_Operation*>(sender());
 204   ModuleBase_Operation* anOperation = currentOperation();
 205   if (!aSenderOperation || !anOperation || aSenderOperation != anOperation)
 206     return;
 207
 208   myOperations.removeAll(anOperation);
 209   anOperation->deleteLater();
 210
 211   emit operationStopped(anOperation);
 212
 213   // get last operation which can be resumed
 214   ModuleBase_Operation* aResultOp = 0;
 215   QListIterator<ModuleBase_Operation*> anIt(myOperations);
 216   anIt.toBack();
 217   while (anIt.hasPrevious()) {
 218     ModuleBase_Operation* anOp = anIt.previous();
 219     if (anOp) {
 220       aResultOp = anOp;
 221       break;
 222     }
 223   }
 224   if (aResultOp) {
 225     resumeOperation(aResultOp);
 226     onValidateOperation();
 227   }
 228 }
 229
 230 void XGUI_OperationMgr::onKeyReleased(QKeyEvent* theEvent)
 231 {
 232   // Let the manager decide what to do with the given key combination.
 233   ModuleBase_Operation* anOperation = currentOperation();
 234   bool isRestart = false;
 235   switch (theEvent->key()) {
 236     case Qt::Key_Escape: {
 237       onAbortOperation();
 238     }
 239       break;
 240     case Qt::Key_Return:
 241     case Qt::Key_Enter: {
 242       if(anOperation) {
 243          anOperation->activateNextToCurrentWidget();
 244       }
 245       commitOperation();
 246     }
 247       break;
 248     default:
 249       break;
 250   }
 251   if(anOperation)
 252     anOperation->keyReleased(theEvent->key());
 253 }
 254
 255 void XGUI_OperationMgr::onWidgetActivated(ModuleBase_ModelWidget* theWidget)
 256 {
 257   ModuleBase_Operation* anOperation = currentOperation();
 258   if (anOperation)
 259     anOperation->onWidgetActivated(theWidget);
 260 }