src/ModuleBase/ModuleBase_WidgetDoubleValue.cpp

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #include <Config_Keywords.h>
  22 #include <Config_WidgetAPI.h>
  23 #include <Events_Loop.h>
  24
  25 #include <ModelAPI_AttributeDouble.h>
  26 #include <ModelAPI_Data.h>
  27 #include <ModelAPI_Object.h>
  28 #include <ModelAPI_Expression.h>
  29 #include <ModelAPI_AttributeString.h>
  30 #include <ModelAPI_Session.h>
  31 #include <ModelAPI_Document.h>
  32 #include <ModelAPI_ResultParameter.h>
  33 #include <ModelAPI_AttributeDouble.h>
  34 #include <ModelAPI_Tools.h>
  35 #include <ModelAPI_Events.h>
  36
  37 #include <ModuleBase_ParamSpinBox.h>
  38 #include <ModuleBase_Tools.h>
  39 #include <ModuleBase_WidgetDoubleValue.h>
  40 #include <ModuleBase_IconFactory.h>
  41
  42 #include <QFormLayout>
  43 #include <QLabel>
  44 #include <QList>
  45 #include <QObject>
  46 #include <QPixmap>
  47 #include <QString>
  48
  49 #include <cfloat>
  50
  51 #ifndef DBL_MAX
  52 #define DBL_MAX 1.7976931348623158e+308
  53 #endif
  54 #ifdef _DEBUG
  55 #include <iostream>
  56 #endif
  57
  58 #define DEBUG_COMPLETE_WITH_PARAMETERS
  59
  60 ModuleBase_WidgetDoubleValue::ModuleBase_WidgetDoubleValue(QWidget* theParent,
  61                                                            const Config_WidgetAPI* theData)
  62     : ModuleBase_ModelWidget(theParent, theData)
  63 {
  64   QFormLayout* aControlLay = new QFormLayout(this);
  65   ModuleBase_Tools::adjustMargins(aControlLay);
  66
  67   QString aLabelText = translate(theData->widgetLabel());
  68   QString aLabelIcon = QString::fromStdString(theData->widgetIcon());
  69   myLabel = new QLabel(aLabelText, this);
  70   if (!aLabelIcon.isEmpty())
  71     myLabel->setPixmap(ModuleBase_IconFactory::loadPixmap(aLabelIcon));
  72
  73   bool aAcceptVariables = theData->getBooleanAttribute(DOUBLE_WDG_ACCEPT_EXPRESSIONS, true);
  74
  75   mySpinBox = new ModuleBase_ParamSpinBox(this);
  76   mySpinBox->setAcceptVariables(aAcceptVariables);
  77   QString anObjName = QString::fromStdString(attributeID());
  78   mySpinBox->setObjectName(anObjName);
  79
  80   bool isOk = false;
  81   std::string aProp = theData->getProperty(DOUBLE_WDG_MIN);
  82   double aMinVal = QString::fromStdString(aProp).toDouble(&isOk);
  83   if (isOk) {
  84     mySpinBox->setMinimum(aMinVal);
  85   } else {
  86     mySpinBox->setMinimum(-DBL_MAX);
  87   }
  88
  89   aProp = theData->getProperty(DOUBLE_WDG_MAX);
  90   double aMaxVal = QString::fromStdString(aProp).toDouble(&isOk);
  91   if (isOk) {
  92     mySpinBox->setMaximum(aMaxVal);
  93   } else {
  94     mySpinBox->setMaximum(DBL_MAX);
  95   }
  96
  97   aProp = theData->getProperty(DOUBLE_WDG_STEP);
  98   double aStepVal = QString::fromStdString(aProp).toDouble(&isOk);
  99   if (isOk) {
 100     double aMinStep = pow(10, -1. * (double) mySpinBox->decimals());
 101     if(aStepVal < aMinStep){
 102       aStepVal = aMinStep;
 103     }
 104     mySpinBox->setSingleStep(aStepVal);
 105   }
 106
 107   double aDefVal = QString::fromStdString(getDefaultValue()).toDouble(&isOk);
 108   if (isOk) {
 109     mySpinBox->setValue(aDefVal);
 110   }
 111
 112   QString aTTip = translate(theData->widgetTooltip());
 113   mySpinBox->setToolTip(aTTip);
 114   myLabel->setToolTip(aTTip);
 115
 116   aControlLay->addRow(myLabel, mySpinBox);
 117   // we should listen textChanged signal as valueChanged do not send when text is modified
 118   connect(mySpinBox, SIGNAL(textChanged(const QString&)), this, SIGNAL(valuesModified()));
 119   mySpinBox->setValueEnabled(isValueEnabled());
 120 }
 121
 122 ModuleBase_WidgetDoubleValue::~ModuleBase_WidgetDoubleValue()
 123 {
 124 }
 125
 126 void ModuleBase_WidgetDoubleValue::activateCustom()
 127 {
 128   ModuleBase_ModelWidget::activateCustom();
 129 #ifdef DEBUG_COMPLETE_WITH_PARAMETERS
 130   QStringList aParameters;
 131   ModuleBase_Tools::getParameters(aParameters);
 132   mySpinBox->setCompletionList(aParameters);
 133 #endif
 134 }
 135
 136 bool ModuleBase_WidgetDoubleValue::resetCustom()
 137 {
 138   bool aDone = false;
 139   if (!isUseReset() || isComputedDefault() || mySpinBox->hasVariable()) {
 140     aDone = false;
 141   } else {
 142     bool isOk;
 143     double aDefValue = QString::fromStdString(getDefaultValue()).toDouble(&isOk);
 144     // reset the value just if there is a default value definition in the XML definition
 145     // if the value can not be found by the default value, do nothing
 146     if (isOk) {
 147       ModuleBase_Tools::setSpinValue(mySpinBox, aDefValue);
 148       storeValue();
 149       aDone = true;
 150     }
 151   }
 152   return aDone;
 153 }
 154
 155 bool ModuleBase_WidgetDoubleValue::storeValueCustom()
 156 {
 157   DataPtr aData = myFeature->data();
 158   AttributeDoublePtr aReal = aData->real(attributeID());
 159   if (mySpinBox->hasVariable()) {
 160     // Here is a text of a real value or an expression.
 161     QString aText = mySpinBox->text();
 162     if (aText.contains('=')) {
 163       if (!myParameter.get()) {
 164         myParameter = createParameter(aText);
 165       } else {
 166         editParameter(aText);
 167       }
 168       aText = aText.split('=').at(0) + "=";
 169     } else if (myParameter.get()){
 170       // Nullyfy the parameter reference without deletion of the created
 171       myParameter = FeaturePtr();
 172     }
 173     aReal->setText(aText.toStdString());
 174   } else {
 175     // it is important to set the empty text value to the attribute before set the value
 176     // because setValue tries to calculate the attribute value according to the
 177     // attribute current text
 178     aReal->setText("");
 179     aReal->setValue(mySpinBox->value());
 180   }
 181   updateObject(myFeature);
 182   return true;
 183 }
 184
 185 bool ModuleBase_WidgetDoubleValue::restoreValueCustom()
 186 {
 187   DataPtr aData = myFeature->data();
 188   AttributeDoublePtr aRef = aData->real(attributeID());
 189   std::string aTextRepr = aRef->text();
 190   if (!aTextRepr.empty()) {
 191     QString aText = QString::fromStdString(aTextRepr);
 192     if (aText.endsWith('=')) {
 193       if (!myParameter.get()) {
 194         QString aName = aText.left(aText.length() - aText.indexOf('=')).trimmed();
 195         myParameter = findParameter(aName);
 196       }
 197       AttributeStringPtr aExprAttr = myParameter->string("expression");
 198       aText += aExprAttr->value().c_str();
 199     }
 200     ModuleBase_Tools::setSpinText(mySpinBox, aText);
 201   } else {
 202     ModuleBase_Tools::setSpinValue(mySpinBox, aRef->isInitialized() ? aRef->value() : 0);
 203   }
 204   return true;
 205 }
 206
 207 void ModuleBase_WidgetDoubleValue::selectContent()
 208 {
 209   mySpinBox->selectAll();
 210 }
 211
 212 QList<QWidget*> ModuleBase_WidgetDoubleValue::getControls() const
 213 {
 214   QList<QWidget*> aList;
 215   aList.append(mySpinBox);
 216   return aList;
 217 }
 218
 219 bool ModuleBase_WidgetDoubleValue::processEnter()
 220 {
 221   bool isModified = getValueState() == ModifiedInPP;
 222   if (isModified) {
 223     emit valuesChanged();
 224     mySpinBox->selectAll();
 225   }
 226   return isModified;
 227 }
 228
 229
 230 FeaturePtr ModuleBase_WidgetDoubleValue::createParameter(const QString& theText) const
 231 {
 232   FeaturePtr aParameter;
 233   QStringList aList = theText.split("=");
 234   QString aParamName = aList.at(0).trimmed();
 235
 236   if (isNameExist(aParamName)) {
 237     return aParameter;
 238   }
 239
 240   if (!ModelAPI_Expression::isVariable(aParamName.toStdString())) {
 241     return aParameter;
 242   }
 243
 244   QString aExpression = aList.at(1).trimmed();
 245   if (aExpression.isEmpty()) {
 246     return aParameter;
 247   }
 248
 249   SessionPtr aMgr = ModelAPI_Session::get();
 250   std::shared_ptr<ModelAPI_Document> aDoc = aMgr->activeDocument();
 251
 252   aParameter = aDoc->addFeature("Parameter");
 253   if (aParameter.get()) {
 254     AttributeStringPtr aNameAttr = aParameter->string("variable");
 255     aNameAttr->setValue(aParamName.toStdString());
 256
 257     AttributeStringPtr aExprAttr = aParameter->string("expression");
 258     aExprAttr->setValue(aExpression.toStdString());
 259     aParameter->execute();
 260
 261     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
 262     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 263   }
 264   return aParameter;
 265 }
 266
 267 bool ModuleBase_WidgetDoubleValue::isNameExist(const QString& theName) const
 268 {
 269   SessionPtr aMgr = ModelAPI_Session::get();
 270   std::shared_ptr<ModelAPI_Document> aDoc = aMgr->activeDocument();
 271   FeaturePtr aParamFeature;
 272   int aNbFeatures = aDoc->numInternalFeatures();
 273   std::string aName = theName.toStdString();
 274   for (int i = 0; i < aNbFeatures; i++) {
 275     aParamFeature = aDoc->internalFeature(i);
 276     if (aParamFeature && aParamFeature->getKind() == "Parameter") {
 277       if ((myParameter != aParamFeature) && (aParamFeature->name() == aName))
 278         return true;
 279     }
 280   }
 281   return false;
 282 }
 283
 284 void ModuleBase_WidgetDoubleValue::editParameter(const QString& theText)
 285 {
 286   QStringList aList = theText.split("=");
 287   QString aParamName = aList.at(0).trimmed();
 288
 289   QString aExpression = aList.at(1).trimmed();
 290   if (aExpression.isEmpty()) {
 291     return;
 292   }
 293
 294   if (isNameExist(aParamName)) {
 295     return;
 296   }
 297   AttributeStringPtr aNameAttr = myParameter->string("variable");
 298   aNameAttr->setValue(aParamName.toStdString());
 299
 300   AttributeStringPtr aExprAttr = myParameter->string("expression");
 301   aExprAttr->setValue(aExpression.toStdString());
 302   myParameter->execute();
 303
 304   Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 305 }
 306
 307 FeaturePtr ModuleBase_WidgetDoubleValue::findParameter(const QString& theName) const
 308 {
 309   SessionPtr aMgr = ModelAPI_Session::get();
 310   std::shared_ptr<ModelAPI_Document> aDoc = aMgr->activeDocument();
 311   FeaturePtr aParamFeature;
 312   int aNbFeatures = aDoc->numInternalFeatures();
 313   std::string aName = theName.toStdString();
 314   for (int i = 0; i < aNbFeatures; i++) {
 315     aParamFeature = aDoc->internalFeature(i);
 316     if (aParamFeature && aParamFeature->getKind() == "Parameter") {
 317       if (aParamFeature->name() == aName)
 318         return aParamFeature;
 319     }
 320   }
 321   return FeaturePtr();
 322 }