Salome HOME
Issue #1489 Multi-rotation problem if there is a reference to copied objects
[modules/shaper.git] / src / ModelAPI / ModelAPI_Tools.cpp
index 1da66a8455a1ddf10bca590fe54e44bc74601bc2..658def2ef133c08390ec5b53cda62c6861b08f35 100755 (executable)
 #include <ModelAPI_AttributeDocRef.h>
 #include <list>
 #include <map>
+#include <iostream>
+
+#include <Events_Loop.h>
+#include <ModelAPI_Events.h>
+
+//#define DEBUG_REMOVE_FEATURES
+
+#ifdef DEBUG_REMOVE_FEATURES
+void printMapInfo(const std::map<FeaturePtr, std::set<FeaturePtr> >& theMainList,
+                  const std::string& thePrefix)
+{
+  std::map<FeaturePtr, std::set<FeaturePtr> >::const_iterator aMainIt = theMainList.begin(),
+                                                              aMainLast = theMainList.end();
+  std::string anInfo;
+  for (; aMainIt != aMainLast; aMainIt++) {
+    FeaturePtr aMainListFeature = aMainIt->first;
+    std::set<FeaturePtr> aMainRefList = aMainIt->second;
+    std::set<FeaturePtr>::const_iterator anIt = aMainRefList.begin(), aLast = aMainRefList.end();
+    std::string aRefsInfo;
+    for (; anIt != aLast; anIt++) {
+      aRefsInfo += (*anIt)->name().c_str();
+      if (anIt != aLast)
+        aRefsInfo += ", ";
+    }
+    if (!aRefsInfo.empty()) {
+      anInfo = anInfo + aMainListFeature->name().c_str() + ": " + aRefsInfo + "\n";
+    }
+  }
+  std::cout << thePrefix.c_str() << ": " << anInfo.c_str() << std::endl;
+}
+
+void printListInfo(const std::set<FeaturePtr>& theMainList,
+                  const std::string& thePrefix)
+{
+  std::set<FeaturePtr>::const_iterator aMainIt = theMainList.begin(),
+                                       aMainLast = theMainList.end();
+  std::string anInfo;
+  for (; aMainIt != aMainLast; aMainIt++) {
+    FeaturePtr aRefFeature = *aMainIt;
+    anInfo += aRefFeature->name().c_str();
+    if (aMainIt != aMainLast)
+      anInfo += ", ";
+  }
+  std::cout << thePrefix.c_str() << ": " << anInfo.c_str() << std::endl;
+}
+#endif
 
 namespace ModelAPI_Tools {
 
@@ -22,6 +68,61 @@ std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult)
   return theResult->shape();
 }
 
+const char* toString(ModelAPI_ExecState theExecState) 
+{
+#define TO_STRING(__NAME__) case __NAME__: return #__NAME__;
+  switch (theExecState) {
+  TO_STRING(ModelAPI_StateDone)
+  TO_STRING(ModelAPI_StateMustBeUpdated)
+  TO_STRING(ModelAPI_StateExecFailed)
+  TO_STRING(ModelAPI_StateInvalidArgument)
+  TO_STRING(ModelAPI_StateNothing)
+  default: return "Unknown ExecState.";
+  }
+#undef TO_STRING
+}
+
+std::string getFeatureError(const FeaturePtr& theFeature)
+{
+  std::string anError;
+  if (!theFeature.get() || !theFeature->data()->isValid() || theFeature->isAction())
+    return anError;
+
+  // to be removed later, this error should be got from the feature
+  if (theFeature->data()->execState() == ModelAPI_StateDone ||
+      theFeature->data()->execState() == ModelAPI_StateMustBeUpdated)
+    return anError;
+
+  // set error indication
+  anError = theFeature->error();
+  if (anError.empty()) {
+    bool isDone = ( theFeature->data()->execState() == ModelAPI_StateDone
+                 || theFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
+    if (!isDone) {
+      anError = toString(theFeature->data()->execState());
+      // If the feature is Composite and error is StateInvalidArgument,
+      // error text should include error of first invalid sub-feature. Otherwise
+      // it is not clear what is the reason of the invalid argument.
+      if (theFeature->data()->execState() == ModelAPI_StateInvalidArgument) {
+        CompositeFeaturePtr aComposite =
+                    std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
+        if (aComposite) {
+          for (int i = 0, aSize = aComposite->numberOfSubs(); i < aSize; i++) {
+            FeaturePtr aSubFeature = aComposite->subFeature(i);
+            std::string aSubFeatureError = getFeatureError(aSubFeature);
+            if (!aSubFeatureError.empty()) {
+              anError = anError + " in " + aSubFeature->getKind() + ".\n" + aSubFeatureError;
+              break;
+            }
+          }
+        }
+      }
+    }
+  }
+
+  return anError;
+}
+
 ObjectPtr objectByName(const DocumentPtr& theDocument, const std::string& theGroup, const std::string& theName)
 {
   for (int anIndex = 0; anIndex < theDocument->size(theGroup); ++anIndex) {
@@ -33,32 +134,39 @@ ObjectPtr objectByName(const DocumentPtr& theDocument, const std::string& theGro
   return ObjectPtr();
 }
 
-bool findVariable(const DocumentPtr& theDocument, 
+bool findVariable(const DocumentPtr& theDocument, FeaturePtr theSearcher,
                   const std::string& theName, double& outValue, ResultParameterPtr& theParam)
 {
   ObjectPtr aParamObj = objectByName(theDocument, ModelAPI_ResultParameter::group(), theName);
   theParam = std::dynamic_pointer_cast<ModelAPI_ResultParameter>(aParamObj);
   if (!theParam.get())
     return false;
+  // avoid usage of parameters created later than the initial parameter
+  if (theSearcher.get() && theDocument->isLater(theDocument->feature(theParam), theSearcher))
+    return false;
   AttributeDoublePtr aValueAttribute = theParam->data()->real(ModelAPI_ResultParameter::VALUE());
   outValue = aValueAttribute->value();
   return true;
 }
 
-bool findVariable(const std::string& theName, double& outValue, ResultParameterPtr& theParam,
-                  const DocumentPtr& theDocument /*= DocumentPtr()*/)
+bool findVariable(FeaturePtr theSearcher, const std::string& theName, double& outValue, ResultParameterPtr& theParam,
+                  const DocumentPtr& theDocument)
 {
   SessionPtr aSession = ModelAPI_Session::get();
   std::list<DocumentPtr> aDocList;
   DocumentPtr aDocument = theDocument.get() ? theDocument : aSession->activeDocument();
+  if (findVariable(aDocument, theSearcher, theName, outValue, theParam))
+    return true;
   DocumentPtr aRootDocument = aSession->moduleDocument();
-  aDocList.push_back(aDocument);
   if (aDocument != aRootDocument) {
-    aDocList.push_back(aRootDocument);
-  }
-  for(std::list<DocumentPtr>::const_iterator it = aDocList.begin(); it != aDocList.end(); ++it) {
-    if (findVariable(*it, theName, outValue, theParam))
-      return true;
+    ResultPtr aPartResult = findPartResult(aRootDocument, aDocument);
+    if (aPartResult.get()) {
+      FeaturePtr aPartFeature;
+      if (theSearcher.get()) // only if the relative search is needed
+        aPartFeature = aRootDocument->feature(aPartResult);
+      if (findVariable(aRootDocument, aPartFeature, theName, outValue, theParam))
+        return true;
+    }
   }
   return false;
 }
@@ -151,7 +259,7 @@ void findRandomColor(std::vector<int>& theValues)
     fillColorMap();
   }
 
-  int aSize = myColorMap.size();
+  size_t aSize = myColorMap.size();
   int anIndex = rand() % aSize;
   if (myColorMap.find(anIndex) != myColorMap.end()) {
     theValues = myColorMap.at(anIndex);
@@ -160,20 +268,44 @@ void findRandomColor(std::vector<int>& theValues)
 
 ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub)
 {
-  for (int a = theMain->size(ModelAPI_ResultPart::group()) - 1; a >= 0; a--) {
-    ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(
-        theMain->object(ModelAPI_ResultPart::group(), a));
-    if (aPart && aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->value() == theSub) {
-      return aPart;
+  if (theMain != theSub) { // to optimize and avoid of crash on partset document close (don't touch the sub-document structure)
+    for (int a = theMain->size(ModelAPI_ResultPart::group()) - 1; a >= 0; a--) {
+      ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(
+          theMain->object(ModelAPI_ResultPart::group(), a));
+      if (aPart && aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->value() == theSub) {
+        return aPart;
+      }
     }
   }
   return ResultPtr();
 }
 
+FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub)
+{
+  if (theMain != theSub) { // to optimize and avoid of crash on partset document close (don't touch the sub-document structure)
+    for (int a = theMain->size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
+      FeaturePtr aPartFeat = std::dynamic_pointer_cast<ModelAPI_Feature>(
+          theMain->object(ModelAPI_Feature::group(), a));
+      if (aPartFeat.get()) {
+        const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aPartFeat->results();
+        std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
+        for(; aRes != aResList.end(); aRes++) {
+          ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes);
+          if (aPart.get()) {
+            if (aPart->isActivated() && aPart->partDoc() == theSub)
+              return aPartFeat;
+          } else break; // if the first is not Part, others are also not
+        }
+      }
+    }
+  }
+  return FeaturePtr();
+}
+
 CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature)
 {
   if (theFeature.get() && theFeature->data()->isValid()) {
-    const std::set<std::shared_ptr<ModelAPI_Attribute> > aRefs = theFeature->data()->refsToMe();
+    const std::set<std::shared_ptr<ModelAPI_Attribute> >& aRefs = theFeature->data()->refsToMe();
     std::set<std::shared_ptr<ModelAPI_Attribute> >::const_iterator aRefIter = aRefs.begin();
     for(; aRefIter != aRefs.end(); aRefIter++) {
       CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>
@@ -209,5 +341,213 @@ bool hasSubResults(const ResultPtr& theResult)
   return aCompSolid.get() && aCompSolid->numberOfSubs() > 0;
 }
 
+void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults)
+{
+  const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
+  std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
+  for (; aRIter != aResults.cend(); aRIter++) {
+    theResults.push_back(*aRIter);
+    // iterate sub-bodies of compsolid
+    ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRIter);
+    if (aComp.get()) {
+      int aNumSub = aComp->numberOfSubs();
+      for(int a = 0; a < aNumSub; a++) {
+        theResults.push_back(aComp->subResult(a));
+      }
+    }
+  }
+}
+
+bool removeFeaturesAndReferences(const std::set<FeaturePtr>& theFeatures,
+                                 const bool theFlushRedisplay,
+                                 const bool theUseComposite,
+                                 const bool theUseRecursion)
+{
+#ifdef DEBUG_REMOVE_FEATURES
+  printListInfo(theFeatures, "selection: ");
+#endif
+
+  std::map<FeaturePtr, std::set<FeaturePtr> > aReferences;
+  ModelAPI_Tools::findAllReferences(theFeatures, aReferences, theUseComposite, theUseRecursion);
+#ifdef DEBUG_REMOVE_FEATURES
+  printMapInfo(aReferences, "allDependencies: ");
+#endif
+
+  std::set<FeaturePtr> aFeaturesRefsTo;
+  ModelAPI_Tools::findRefsToFeatures(theFeatures, aReferences, aFeaturesRefsTo);
+#ifdef DEBUG_REMOVE_FEATURES
+  printListInfo(aFeaturesRefsTo, "references: ");
+#endif
+
+  std::set<FeaturePtr> aFeatures = theFeatures;
+  if (!aFeaturesRefsTo.empty())
+    aFeatures.insert(aFeaturesRefsTo.begin(), aFeaturesRefsTo.end());
+#ifdef DEBUG_REMOVE_FEATURES
+  printListInfo(aFeatures, "removeFeatures: ");
+#endif
+
+  return ModelAPI_Tools::removeFeatures(aFeatures, false);
+}
+
+bool removeFeatures(const std::set<FeaturePtr>& theFeatures,
+                    const bool theFlushRedisplay)
+{
+  bool isDone = false;
+  std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
+                                       aLast = theFeatures.end();
+  for (; anIt != aLast; anIt++) {
+    FeaturePtr aFeature = *anIt;
+    if (aFeature.get()) {
+      DocumentPtr aDoc = aFeature->document();
+      // flush REDISPLAY signal after remove feature
+      aDoc->removeFeature(aFeature);
+      isDone = true;
+    }
+  }
+  if (isDone && theFlushRedisplay) {
+    // the redisplay signal should be flushed in order to erase the feature presentation in the viewer
+    // if should be done after removeFeature() of document
+    Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
+  }
+  return true;
+}
+
+// Fills the references list by all references of the feature from the references map.
+// This is a recusive method to find references by next found feature in the map of references.
+// \param theFeature a feature to find references
+// \param theReferencesMap a map of references
+// \param theReferences an out container of references
+void addRefsToFeature(const FeaturePtr& theFeature,
+                      const std::map<FeaturePtr, std::set<FeaturePtr> >& theReferencesMap,
+                      std::set<FeaturePtr>& theReferences)
+{
+  if (theReferencesMap.find(theFeature) == theReferencesMap.end())
+    return; // this feature is not in the selection list, so exists without references to it
+  std::set<FeaturePtr> aMainReferences = theReferencesMap.at(theFeature);
+
+  std::set<FeaturePtr>::const_iterator anIt = aMainReferences.begin(),
+                                       aLast = aMainReferences.end();
+  for (; anIt != aLast; anIt++) {
+    FeaturePtr aRefFeature = *anIt;
+    if (theReferences.find(aRefFeature) == theReferences.end())
+      theReferences.insert(aRefFeature);
+    addRefsToFeature(aRefFeature, theReferencesMap, theReferences);
+  }
+}
+
+// For each feature from the feature list it searches references to the feature and append them
+// to the references map. This is a recusive method.
+// \param theFeature a feature to find references
+// \param theReferencesMap a map of references
+// \param theReferences an out container of references
+void findReferences(const std::set<FeaturePtr>& theFeatures,
+                    std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
+                    const bool theUseComposite, const bool theUseRecursion)
+{
+  std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
+                                        aLast = theFeatures.end();
+  for (; anIt != aLast; anIt++) {
+    FeaturePtr aFeature = *anIt;
+    if (aFeature.get() && theReferences.find(aFeature) == theReferences.end()) {
+      DocumentPtr aSelFeatureDoc = aFeature->document();
+      std::set<FeaturePtr> aSelRefFeatures;
+      aSelFeatureDoc->refsToFeature(aFeature, aSelRefFeatures, false/*do not emit signals*/);
+      if (theUseComposite) { // do not filter selection
+        theReferences[aFeature] = aSelRefFeatures;
+      }
+      else { // filter references to skip composition features of the current feature
+        std::set<FeaturePtr> aFilteredFeatures;
+        std::set<FeaturePtr>::const_iterator anIt = aSelRefFeatures.begin(),
+                                             aLast = aSelRefFeatures.end();
+        for (; anIt != aLast; anIt++) {
+          FeaturePtr aCFeature = *anIt;
+          CompositeFeaturePtr aComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCFeature);
+          if (aComposite.get() && aComposite->isSub(aFeature))
+            continue; /// composite of the current feature should be skipped
+          aFilteredFeatures.insert(aCFeature);
+        }
+        theReferences[aFeature] = aFilteredFeatures;
+      }
+      if (theUseRecursion)
+        findReferences(aSelRefFeatures, theReferences, theUseComposite, theUseRecursion);
+    }
+  }
+}
+
+void findAllReferences(const std::set<FeaturePtr>& theFeatures,
+                       std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
+                       const bool theUseComposite,
+                       const bool theUseRecursion)
+{
+  // For dependencies, find main_list:
+  // sk_1(ext_1, vertex_1)
+  // ext_1(bool_1, sk_3)
+  // vertex_1()
+  // sk_2(ext_2)
+  // ext_2(bool_2)
+  // sk_3()
+  // Information: bool_1 is not selected, ext_2(bool_2) exists
+  // find all referenced features
+  std::map<FeaturePtr, std::set<FeaturePtr> > aMainList;
+  findReferences(theFeatures, aMainList, theUseComposite, theUseRecursion);
+
+#ifdef DEBUG_REMOVE_FEATURES
+  printMapInfo(aMainList, "firstDependencies");
+#endif
+  // find all dependencies for each object:
+  // sk_1(ext_1, vertex_1) + (sk_3, bool_1)
+  // ext_1(bool_1, sk_3)
+  // vertex_1()
+  // sk_2(ext_2) + (bool_1)
+  // ext_2(bool_1)
+  // sk_3()
+  std::map<FeaturePtr, std::set<FeaturePtr> >::const_iterator aMainIt = aMainList.begin(),
+                                                              aMainLast = aMainList.end();
+  for (; aMainIt != aMainLast; aMainIt++) {
+    FeaturePtr aMainListFeature = aMainIt->first;
+    //std::string aName = aMainListFeature->name();
+    std::set<FeaturePtr> aMainRefList = aMainIt->second;
+    std::set<FeaturePtr> anAddRefFeatures;
+
+    std::set<FeaturePtr>::const_iterator anIt = aMainRefList.begin(),
+                                         aLast = aMainRefList.end();
+    for (; anIt != aLast; anIt++) {
+      FeaturePtr aFeature = *anIt;
+      addRefsToFeature(aFeature, aMainList, aMainRefList);
+    }
+    theReferences[aMainListFeature] = aMainRefList;
+  }
+
+#ifdef DEBUG_REMOVE_FEATURES
+  printMapInfo(theReferences, "allDependencies");
+#endif
+}
+
+void findRefsToFeatures(const std::set<FeaturePtr>& theFeatures,
+                        const std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
+                        std::set<FeaturePtr>& theFeaturesRefsTo)
+{
+  std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
+                                       aLast = theFeatures.end();
+  for (; anIt != aLast; anIt++) {
+    FeaturePtr aFeature = *anIt;
+    if (theReferences.find(aFeature) == theReferences.end())
+      continue;
+    std::set<FeaturePtr> aRefList = theReferences.at(aFeature);
+    std::set<FeaturePtr>::const_iterator aRefIt = aRefList.begin(), aRefLast = aRefList.end();
+    for (; aRefIt != aRefLast; aRefIt++) {
+      FeaturePtr aRefFeature = *aRefIt;
+      CompositeFeaturePtr aComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aRefFeature);
+      if (aComposite.get() && aComposite->isSub(aFeature))
+        continue; /// composite of the current feature should not be removed
+
+      if (theFeatures.find(aRefFeature) == theFeatures.end() && // it is not selected
+          theFeaturesRefsTo.find(aRefFeature) == theFeaturesRefsTo.end()) // it is not added
+        theFeaturesRefsTo.insert(aRefFeature);
+    }
+  }
+}
+
 } // namespace ModelAPI_Tools
 
+