-/*
- * ParametersPlugin_EvalListener.cpp
- *
- * Created on: Apr 28, 2015
- * Author: sbh
- */
+// Copyright (C) 2014-2023 CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
#include <pyconfig.h>
#include <ParametersPlugin_EvalListener.h>
-#include <ParametersPlugin_PyInterp.h>
+#include <ParametersPlugin_Parameter.h>
-#include <Events_Error.h>
+#include <Events_InfoMessage.h>
+#include <Locale_Convert.h>
+
+#include <ModelAPI_AttributeDouble.h>
+#include <ModelAPI_AttributeInteger.h>
+#include <ModelAPI_AttributeRefList.h>
+#include <ModelAPI_AttributeString.h>
+#include <ModelAPI_AttributeValidator.h>
+#include <ModelAPI_Document.h>
#include <ModelAPI_Events.h>
+#include <ModelAPI_ResultParameter.h>
+#include <ModelAPI_Session.h>
#include <ModelAPI_Tools.h>
-#include <ModelAPI_AttributeDouble.h>
+
#include <GeomDataAPI_Point.h>
#include <GeomDataAPI_Point2D.h>
+#include <QMessageBox>
+
+#include <ModuleBase_Tools.h>
+
#include <string>
+#include <set>
#include <sstream>
+//------------------------------------------------------------------------------
+// Tools
+
+static std::wstring toStdWString(double theValue)
+{
+ std::wostringstream sstream;
+ sstream << theValue;
+ size_t aPos = sstream.str().find(L".");
+ std::wstring aPnt = L"";
+ if (aPos == std::wstring::npos)
+ aPnt = L".";
+ return sstream.str() + aPnt;
+}
+
+//------------------------------------------------------------------------------
+
ParametersPlugin_EvalListener::ParametersPlugin_EvalListener()
{
Events_Loop* aLoop = Events_Loop::loop();
- const Events_ID kEvaluationEvent = ModelAPI_AttributeEvalMessage::eventId();
- aLoop->registerListener(this, kEvaluationEvent, NULL, true);
- myInterp = std::shared_ptr<ParametersPlugin_PyInterp>(new ParametersPlugin_PyInterp());
- myInterp->initialize();
+ Events_ID anEvents_IDs[] = {
+ ModelAPI_ObjectRenamedMessage::eventId(),
+ ModelAPI_ReplaceParameterMessage::eventId()
+ };
+
+ for (unsigned long long i = 0; i < sizeof(anEvents_IDs)/sizeof(anEvents_IDs[0]); ++i)
+ aLoop->registerListener(this, anEvents_IDs[i], NULL, true);
}
ParametersPlugin_EvalListener::~ParametersPlugin_EvalListener()
{
}
-void ParametersPlugin_EvalListener::processEvent(const std::shared_ptr<Events_Message>& theMessage)
+void ParametersPlugin_EvalListener::processEvent(
+ const std::shared_ptr<Events_Message>& theMessage)
{
if (!theMessage.get())
return;
- const Events_ID kEvaluationEvent = ModelAPI_AttributeEvalMessage::eventId();
- if (theMessage->eventID() == kEvaluationEvent) {
- std::shared_ptr<ModelAPI_AttributeEvalMessage> aMessage =
- std::dynamic_pointer_cast<ModelAPI_AttributeEvalMessage>(theMessage);
-
- // Double
- AttributeDoublePtr aDoubleAttribute =
- std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(aMessage->attribute());
- if (aDoubleAttribute.get()) {
- std::string anError;
- double aValue = evaluate(aDoubleAttribute->text(), anError);
- if (anError.empty()) {
- aDoubleAttribute->setValue(aValue);
- aDoubleAttribute->setExpressionInvalid(false);
- } else { // set feature as invalid-parameter arguments
- aDoubleAttribute->setExpressionInvalid(true);
- }
- }
+ const Events_ID kObjectRenamedEvent = ModelAPI_ObjectRenamedMessage::eventId();
+ const Events_ID kReplaceParameterEvent = ModelAPI_ReplaceParameterMessage::eventId();
- // Point
- AttributePointPtr aPointAttribute =
- std::dynamic_pointer_cast<GeomDataAPI_Point>(aMessage->attribute());
- if (aPointAttribute.get()) {
- std::string anError[3];
- double aValue[3] = {
- evaluate(aPointAttribute->textX(), anError[0]),
- evaluate(aPointAttribute->textY(), anError[1]),
- evaluate(aPointAttribute->textZ(), anError[2])
- };
- bool isValid[3] = {
- anError[0].empty(),
- anError[1].empty(),
- anError[2].empty()
- };
- aPointAttribute->setExpressionInvalid(0, !isValid[0]);
- aPointAttribute->setExpressionInvalid(1, !isValid[1]);
- aPointAttribute->setExpressionInvalid(2, !isValid[2]);
-
- aPointAttribute->setValue(
- isValid[0] ? aValue[0] : aPointAttribute->x(),
- isValid[1] ? aValue[1] : aPointAttribute->y(),
- isValid[2] ? aValue[2] : aPointAttribute->z()
- );
- }
+ if (theMessage->eventID() == kObjectRenamedEvent) {
+ processObjectRenamedEvent(theMessage);
+ } else if (theMessage->eventID() == kReplaceParameterEvent) {
+ processReplaceParameterEvent(theMessage);
+ }
+}
- // Point2D
- AttributePoint2DPtr aPoint2DAttribute =
- std::dynamic_pointer_cast<GeomDataAPI_Point2D>(aMessage->attribute());
- if (aPoint2DAttribute.get()) {
- std::string anError[2];
- double aValue[2] = {
- evaluate(aPoint2DAttribute->textX(), anError[0]),
- evaluate(aPoint2DAttribute->textY(), anError[1])
- };
- bool isValid[2] = {
- anError[0].empty(),
- anError[1].empty()
- };
- aPoint2DAttribute->setExpressionInvalid(0, !isValid[0]);
- aPoint2DAttribute->setExpressionInvalid(1, !isValid[1]);
-
- aPoint2DAttribute->setValue(
- isValid[0] ? aValue[0] : aPoint2DAttribute->x(),
- isValid[1] ? aValue[1] : aPoint2DAttribute->y()
- );
+std::wstring ParametersPlugin_EvalListener::renameInPythonExpression(
+ const std::wstring& theExpression,
+ const std::wstring& theOldName,
+ const std::wstring& theNewName)
+{
+ std::wstring anExpressionString = theExpression;
+
+ // ask interpreter to compute the positions in the expression
+ std::shared_ptr<ModelAPI_ComputePositionsMessage> aMsg =
+ ModelAPI_ComputePositionsMessage::send(theExpression, theOldName, this);
+ const std::list<std::pair<int, int> >& aPositions = aMsg->positions();
+
+ if (aPositions.empty())
+ return anExpressionString;
+
+ std::map<int, std::list<int> > aLines;
+ std::list<std::pair<int, int> >::const_iterator it = aPositions.begin();
+ for (; it != aPositions.end(); ++it)
+ aLines[it->first].push_back(it->second);
+
+ // Start renaming from the end to keep indexes if theNewName is longer then theOldName
+ std::map<int, std::list<int> >::const_reverse_iterator ritLine = aLines.rbegin();
+ for (; ritLine != aLines.rend(); ++ritLine) {
+ // Calculate the start of the line (find the aLineNo occurrence of "\n" )
+ int aLineNo = ritLine->first - 1;
+ size_t aLineStart = 0;
+ for (int i = 0; i < aLineNo; ++i)
+ aLineStart = anExpressionString.find(L"\n", aLineStart) + 1;
+
+ const std::list<int>& aColOffsets = ritLine->second;
+ std::list<int>::const_reverse_iterator ritOffset = aColOffsets.rbegin();
+ for (; ritOffset != aColOffsets.rend(); ++ritOffset) {
+ int anOffset = *ritOffset;
+ anExpressionString.replace(aLineStart + anOffset, theOldName.size(), theNewName);
}
- } else {
- Events_Error::send(std::string("ParametersPlugin python interpreter, unhandled message caught: ")
- + theMessage->eventID().eventText());
}
+
+ return anExpressionString;
+}
+
+void ParametersPlugin_EvalListener::renameInParameter(
+ std::shared_ptr<ParametersPlugin_Parameter> theParameter,
+ const std::wstring& theOldName,
+ const std::wstring& theNewName)
+{
+ std::shared_ptr<ModelAPI_AttributeString> anExpressionAttribute =
+ theParameter->string(ParametersPlugin_Parameter::EXPRESSION_ID());
+
+ std::wstring anExpressionString = anExpressionAttribute->isUValue() ?
+ Locale::Convert::toWString(anExpressionAttribute->valueU()) :
+ Locale::Convert::toWString(anExpressionAttribute->value());
+ anExpressionString = renameInPythonExpression(anExpressionString,
+ theOldName,
+ theNewName);
+ // Issue #588. No need for reevaluating expression.
+ // Moreover, current history may not contain necessary parameters.
+ bool aWasBlocked = anExpressionAttribute->owner()->data()->blockSendAttributeUpdated(true);
+ anExpressionAttribute->setValue(anExpressionString);
+ anExpressionAttribute->owner()->data()->blockSendAttributeUpdated(aWasBlocked);
+}
+
+void ParametersPlugin_EvalListener::renameInAttribute(
+ std::shared_ptr<ModelAPI_Attribute> theAttribute,
+ const std::wstring& theOldName,
+ const std::wstring& theNewName)
+{
+ if (theAttribute->attributeType() == ModelAPI_AttributeInteger::typeId()) {
+ AttributeIntegerPtr anAttribute =
+ std::dynamic_pointer_cast<ModelAPI_AttributeInteger>(theAttribute);
+ std::wstring anExpressionString = anAttribute->text();
+ anExpressionString = renameInPythonExpression(anExpressionString,
+ theOldName, theNewName);
+ anAttribute->setText(anExpressionString);
+ } else
+ if (theAttribute->attributeType() == ModelAPI_AttributeDouble::typeId()) {
+ AttributeDoublePtr anAttribute =
+ std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(theAttribute);
+ std::wstring anExpressionString = anAttribute->text();
+ anExpressionString = renameInPythonExpression(anExpressionString,
+ theOldName, theNewName);
+ anAttribute->setText(anExpressionString);
+ } else
+ if (theAttribute->attributeType() == GeomDataAPI_Point::typeId()) {
+ AttributePointPtr anAttribute =
+ std::dynamic_pointer_cast<GeomDataAPI_Point>(theAttribute);
+ std::wstring anExpressionString[3] = {
+ anAttribute->textX(),
+ anAttribute->textY(),
+ anAttribute->textZ()
+ };
+ for (int i = 0; i < 3; ++i)
+ anExpressionString[i] = renameInPythonExpression(anExpressionString[i],
+ theOldName, theNewName);
+ anAttribute->setText(anExpressionString[0],
+ anExpressionString[1],
+ anExpressionString[2]);
+ } else
+ if (theAttribute->attributeType() == GeomDataAPI_Point2D::typeId()) {
+ AttributePoint2DPtr anAttribute =
+ std::dynamic_pointer_cast<GeomDataAPI_Point2D>(theAttribute);
+ std::wstring anExpressionString[2] = {
+ anAttribute->textX(),
+ anAttribute->textY()
+ };
+ for (int i = 0; i < 2; ++i)
+ anExpressionString[i] = renameInPythonExpression(anExpressionString[i],
+ theOldName, theNewName);
+ anAttribute->setText(anExpressionString[0],
+ anExpressionString[1]);
+ }
+}
+
+void ParametersPlugin_EvalListener::renameInDependents(
+ std::shared_ptr<ModelAPI_ResultParameter> theResultParameter,
+ const std::wstring& theOldName,
+ const std::wstring& theNewName)
+{
+ std::set<std::shared_ptr<ModelAPI_Attribute> > anAttributes =
+ theResultParameter->data()->refsToMe();
+ std::set<std::shared_ptr<ModelAPI_Attribute> >::const_iterator anAttributeIt =
+ anAttributes.cbegin();
+ for (; anAttributeIt != anAttributes.cend(); ++anAttributeIt) {
+ const AttributePtr& anAttribute = *anAttributeIt;
+ if (anAttribute->attributeType() == ModelAPI_AttributeRefList::typeId()) {
+ std::shared_ptr<ParametersPlugin_Parameter> aParameter =
+ std::dynamic_pointer_cast<ParametersPlugin_Parameter>(
+ anAttribute->owner());
+ if (aParameter.get())
+ // Rename
+ renameInParameter(aParameter, theOldName, theNewName);
+ } else
+ // Rename
+ renameInAttribute(anAttribute, theOldName, theNewName);
+ }
+}
+
+bool isValidAttribute(const AttributePtr& theAttribute)
+{
+ std::string aValidator;
+ Events_InfoMessage anError;
+ return ModelAPI_Session::get()->validators()->validate(theAttribute, aValidator, anError);
}
-double ParametersPlugin_EvalListener::evaluate(const std::string& theExpression,
- std::string& theError)
+void setParameterName(ResultParameterPtr theResultParameter, const std::string& theName)
{
- std::list<std::string> anExprParams = myInterp->compile(theExpression);
- // find expression's params in the model
- std::list<std::string> aContext;
- std::list<std::string>::iterator it = anExprParams.begin();
- for ( ; it != anExprParams.end(); it++) {
- double aValue;
- ResultParameterPtr aParamRes;
- if (!ModelAPI_Tools::findVariable(*it, aValue, aParamRes)) continue;
-
- std::ostringstream sstream;
- sstream << aValue;
- std::string aParamValue = sstream.str();
- aContext.push_back(*it + "=" + aParamValue);
+ bool aWasBlocked = theResultParameter->data()->blockSendAttributeUpdated(true);
+ theResultParameter->data()->setName(Locale::Convert::toWString(theName));
+ theResultParameter->data()->blockSendAttributeUpdated(aWasBlocked, false);
+
+ std::shared_ptr<ParametersPlugin_Parameter> aParameter =
+ std::dynamic_pointer_cast<ParametersPlugin_Parameter>(
+ ModelAPI_Feature::feature(theResultParameter));
+
+ std::string anOldName = Locale::Convert::toString(aParameter->name());
+ aWasBlocked = aParameter->data()->blockSendAttributeUpdated(true);
+ aParameter->data()->setName(Locale::Convert::toWString(theName));
+ aParameter->string(ParametersPlugin_Parameter::VARIABLE_ID())->setValue(theName);
+ aParameter->data()->blockSendAttributeUpdated(aWasBlocked);
+}
+
+void ParametersPlugin_EvalListener::processObjectRenamedEvent(
+ const std::shared_ptr<Events_Message>& theMessage)
+{
+ std::shared_ptr<ModelAPI_ObjectRenamedMessage> aMessage =
+ std::dynamic_pointer_cast<ModelAPI_ObjectRenamedMessage>(theMessage);
+
+ // Empty new name is not available too but it will be rejected by
+ // name validator in isValidAttribute.
+ if (!aMessage.get() || aMessage->oldName().empty())
+ return;
+
+ // check if the renamed object is a result parameter
+ ResultParameterPtr aResultParameter =
+ std::dynamic_pointer_cast<ModelAPI_ResultParameter>(aMessage->object());
+ if (!aResultParameter.get())
+ return;
+
+ // get parameter feature for the result
+ std::shared_ptr<ParametersPlugin_Parameter> aParameter =
+ std::dynamic_pointer_cast<ParametersPlugin_Parameter>(
+ ModelAPI_Feature::feature(aResultParameter));
+ if (!aParameter.get())
+ return;
+
+ std::wstring aNotActivatedNames;
+ if (!ModelAPI_Tools::allDocumentsActivated(aNotActivatedNames)) {
+ static const std::string aMsgContext("ParametersPlugin");
+ static const std::string aMsgText =
+ "Selected objects can be used in Part documents which are not loaded: " +
+ std::string("%1. Would you like to continue?");
+ Events_InfoMessage aMsg(aMsgContext, aMsgText);
+ aMsg.arg(aNotActivatedNames.c_str());
+ QMessageBox::StandardButton aRes =
+ QMessageBox::warning(0, ModuleBase_Tools::translate(aMsgContext, "Warning"),
+ ModuleBase_Tools::translate(aMsg),
+ QMessageBox::No | QMessageBox::Yes, QMessageBox::No);
+ if (aRes != QMessageBox::Yes) {
+ setParameterName(aResultParameter, Locale::Convert::toString(aMessage->oldName()));
+ return;
+ }
+ }
+
+ // try to update the parameter feature according the new name
+ setParameterName(aResultParameter, Locale::Convert::toString(aMessage->newName()));
+ if (!isValidAttribute(aParameter->string(ParametersPlugin_Parameter::VARIABLE_ID()))) {
+ //setParameterName(aResultParameter, aMessage->oldName());
+ if (myOldNames.find(aParameter.get()) == myOldNames.end())
+ myOldNames[aParameter.get()] = aMessage->oldName();
+ return;
}
- myInterp->extendLocalContext(aContext);
- double result = myInterp->evaluate(theExpression, theError);
- myInterp->clearLocalContext();
- return result;
+
+ std::wstring anOldName = aMessage->oldName();
+ if (myOldNames.find(aParameter.get()) != myOldNames.end()) {
+ anOldName = myOldNames[aParameter.get()];
+ myOldNames.erase(aParameter.get());
+ aParameter->execute(); // to enable result because of previously incorrect name
+ }
+
+ renameInDependents(aResultParameter, anOldName, aMessage->newName());
+}
+
+void ParametersPlugin_EvalListener::processReplaceParameterEvent(
+ const std::shared_ptr<Events_Message>& theMessage)
+{
+ std::shared_ptr<ModelAPI_ReplaceParameterMessage> aMessage =
+ std::dynamic_pointer_cast<ModelAPI_ReplaceParameterMessage>(theMessage);
+
+ // get parameter feature for the object
+ std::shared_ptr<ParametersPlugin_Parameter> aParameter =
+ std::dynamic_pointer_cast<ParametersPlugin_Parameter>(
+ ModelAPI_Feature::feature(aMessage->object()));
+ if (!aParameter.get())
+ return;
+
+ ResultParameterPtr aResultParameter =
+ std::dynamic_pointer_cast<ModelAPI_ResultParameter>(
+ aParameter->firstResult());
+ if (!aResultParameter.get())
+ return;
+
+ double aRealValue = aResultParameter->data()->real(ModelAPI_ResultParameter::VALUE())->value();
+ std::wstring aValue = toStdWString(aRealValue);
+
+ renameInDependents(aResultParameter, aResultParameter->data()->name(), aValue);
}