Salome HOME
updated copyright message
[modules/shaper.git] / src / XGUI / XGUI_Tools.cpp
index cd7248f45e878c93cba110f38930608f7afe4b00..ea54214ec37c2ab0e1226c8dd43aee2409d89122 100644 (file)
@@ -1,7 +1,30 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+// 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 "XGUI_Tools.h"
 
+#include "XGUI_ModuleConnector.h"
+#include "XGUI_Workshop.h"
+
+#include "ModuleBase_IWorkshop.h"
+#include "ModuleBase_Tools.h"
+
 #include <TopoDS_Shape.hxx>
 #include <ModelAPI_Object.h>
 #include <ModelAPI_Result.h>
 #include <ModelAPI_ResultPart.h>
 #include <ModelAPI_CompositeFeature.h>
 #include <ModelAPI_Tools.h>
-#include <Events_Error.h>
+#include <ModelAPI_ResultConstruction.h>
+#include <ModelAPI_ResultBody.h>
+#include <Events_InfoMessage.h>
 
 #include <GeomAPI_Shape.h>
+#include <GeomAlgoAPI_CompoundBuilder.h>
+
+#include <TopoDS_Shape.hxx>
 
 #include <QDir>
 #include <QMessageBox>
 
 #include <iostream>
 #include <sstream>
+#include <string>
+
+#ifndef WIN32
+# include <sys/stat.h>
+# include <dirent.h>
+# include <unistd.h>
+# define _separator_ '/'
+#else
+#include <io.h>
+#define F_OK 0
+#define access _access
+# include <windows.h>
+# define _separator_ '\\'
+#endif
 
 namespace XGUI_Tools {
 //******************************************************************
@@ -37,7 +79,8 @@ QString dir(const QString& path, bool isAbs)
 QString file(const QString& path, bool withExt)
 {
   QString fPath = path;
-  while (!fPath.isEmpty() && (fPath[fPath.length() - 1] == '\\' || fPath[fPath.length() - 1] == '/'))
+  while (!fPath.isEmpty() && (fPath[fPath.length() - 1] == '\\' ||
+          fPath[fPath.length() - 1] == '/'))
     fPath.remove(fPath.length() - 1, 1);
 
   if (withExt)
@@ -56,6 +99,21 @@ QString addSlash(const QString& path)
   return res;
 }
 
+//******************************************************************
+QString unionOfObjectNames(const QObjectPtrList& theObjects, const QString& theSeparator)
+{
+  QStringList aObjectNames;
+  foreach (ObjectPtr aObj, theObjects) {
+    if (aObj->data()->isValid())
+      aObjectNames << QString::fromStdWString(aObj->data()->name());
+  }
+  if (aObjectNames.count() == 0)
+    return QString();
+  if (aObjectNames.count() == 1)
+    return aObjectNames.first();
+  return aObjectNames.join(theSeparator);
+}
+
 //******************************************************************
 bool isModelObject(FeaturePtr theFeature)
 {
@@ -82,23 +140,19 @@ std::string featureInfo(FeaturePtr theFeature)
  }
  }*/
 
+
 //******************************************************************
-bool canRemoveOrRename(QWidget* theParent, const QObjectPtrList& theObjects)
+bool canRemoveOrRename(QWidget* theParent, const std::set<FeaturePtr>& theFeatures)
 {
   bool aResult = true;
-  QString aNotActivatedNames;
-  if (!XGUI_Tools::allDocumentsActivated(aNotActivatedNames)) {
-    DocumentPtr aModuleDoc = ModelAPI_Session::get()->moduleDocument();
-    bool aFoundPartSetObject = false;
-    foreach (ObjectPtr aObj, theObjects) {
-      if (aObj->groupName() == ModelAPI_ResultPart::group())
-        continue;
-      aFoundPartSetObject = aObj->document() == aModuleDoc;
-    }
+  std::wstring aNotActivatedNames;
+  if (!ModelAPI_Tools::allDocumentsActivated(aNotActivatedNames)) {
+    bool aFoundPartSetObject = ModuleBase_Tools::hasModuleDocumentFeature(theFeatures);
     if (aFoundPartSetObject) {
+      const char* aKeyStr = "Selected objects can be used in Part documents which are not loaded: "
+                            "%1. Whould you like to continue?";
       QMessageBox::StandardButton aRes = QMessageBox::warning(theParent, QObject::tr("Warning"),
-               QObject::tr("Selected objects can be used in Part documents which are not loaded: \
-%1. Whould you like to continue?").arg(aNotActivatedNames),
+               QObject::tr(aKeyStr).arg(QString::fromStdWString(aNotActivatedNames)),
                QMessageBox::No | QMessageBox::Yes, QMessageBox::No);
       aResult = aRes == QMessageBox::Yes;
     }
@@ -107,177 +161,243 @@ bool canRemoveOrRename(QWidget* theParent, const QObjectPtrList& theObjects)
 }
 
 //******************************************************************
-bool canRename(const ObjectPtr& theObject, const QString& theName)
+bool isAscii(const QString& theStr)
 {
-  if (std::dynamic_pointer_cast<ModelAPI_ResultParameter>(theObject).get()) {
-    double aValue;
-    ResultParameterPtr aParam;
-    if (ModelAPI_Tools::findVariable(theObject->document(), qPrintable(theName), aValue, aParam)) {
-      QString aErrMsg(QObject::tr("Selected parameter can not be renamed to: %1. \
- There is a parameter with the same name. Its value is: %2.").arg(qPrintable(theName)).arg(aValue));
-      // We can not use here a dialog box for message - it will crash editing process in ObjectBrowser
-      Events_Error::send(aErrMsg.toStdString());
+  char aCh;
+  for (int i = 0; i < theStr.size(); i++) {
+    aCh = theStr[i].toLatin1();
+    if (aCh == 0)
+      return false;
+    if ((aCh >= 0x30) && (aCh <= 0x39))
+      continue;
+    else if ((aCh >= 0x41) && (aCh <= 0x5A))
+      continue;
+    else if ((aCh >= 0x61) && (aCh <= 0x7A))
+      continue;
+    else if (aCh == 0x5f)
+      continue;
+    else
       return false;
-    }
   }
-
   return true;
 }
 
 //******************************************************************
-bool allDocumentsActivated(QString& theNotActivatedNames)
+bool isValidName(const QString& theName)
 {
-  bool anAllPartActivated = true;
-  QStringList aRefNames;
-
-  DocumentPtr aRootDoc = ModelAPI_Session::get()->moduleDocument();
-  int aSize = aRootDoc->size(ModelAPI_ResultPart::group());
-  for (int i = 0; i < aSize; i++) {
-    ObjectPtr aObject = aRootDoc->object(ModelAPI_ResultPart::group(), i);
-    ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(aObject);
-    if (!aPart->isActivated()) {
-      anAllPartActivated = false;
-      aRefNames.append(aObject->data()->name().c_str());
+  QChar aChar;
+  for (int i = 0; i < theName.size(); i++) {
+    aChar = theName[i];
+    if (!aChar.isLetterOrNumber()) {
+      if ((aChar != "_") && (!aChar.isSpace()))
+        return false;
     }
   }
-  theNotActivatedNames = aRefNames.join(", ");
-  return anAllPartActivated;
+  return true;
 }
 
-//**************************************************************
-void refsToFeatureInFeatureDocument(const ObjectPtr& theObject, std::set<FeaturePtr>& theRefFeatures)
+//******************************************************************
+bool canRename(const ObjectPtr& theObject, const QString& theName)
 {
-  FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
-  if (aFeature.get()) {
-    DocumentPtr aFeatureDoc = aFeature->document();
-    // 1. find references in the current document
-    aFeatureDoc->refsToFeature(aFeature, theRefFeatures, false);
+  std::string aType = theObject->groupName();
+  if (aType == ModelAPI_ResultParameter::group()) {
+    // For parameters names only ASCII symbols have to be used
+    if (!isAscii(theName))
+      return false;
+
+    double aValue;
+    ResultParameterPtr aParam;
+    if (ModelAPI_Tools::findVariable(theObject->document(),
+          FeaturePtr(), theName.toStdWString(), aValue, aParam)) {
+      const char* aKeyStr = "Selected parameter can not be renamed to: %1. "
+                            "There is a parameter with the same name. Its value is: %2.";
+      QString aErrMsg(QObject::tr(aKeyStr).arg(theName).arg(aValue));
+      // We can not use here a dialog box for message -
+      // it will crash editing process in ObjectBrowser
+      Events_InfoMessage("XGUI_Tools", aErrMsg.toStdString()).send();
+      return false;
+    }
+  }
+  else {
+    if (!isValidName(theName))
+      return false;
+
+    DocumentPtr aDoc = theObject->document();
+    ObjectPtr aObj =
+      aDoc->objectByName(aType, theName.toStdWString());
+
+    if (aObj.get() && theObject != aObj) {
+      QString aErrMsg(QObject::tr("Name %2 already exists in %1.").
+        arg(aType.c_str()).arg(theName));
+      // We can not use here a dialog box for message -
+      // it will crash editing process in ObjectBrowser
+      Events_InfoMessage("XGUI_Tools", aErrMsg.toStdString()).send();
+      return false;
+    }
   }
+
+  return true;
 }
 
 //**************************************************************
-bool XGUI_Tools::isSubOfComposite(const ObjectPtr& theObject)
+
+XGUI_Workshop* workshop(ModuleBase_IWorkshop* theWorkshop)
 {
-  bool isSub = false;
-  std::set<FeaturePtr> aRefFeatures;
-  refsToFeatureInFeatureDocument(theObject, aRefFeatures);
-  std::set<FeaturePtr>::const_iterator anIt = aRefFeatures.begin(),
-                                       aLast = aRefFeatures.end();
-  for (; anIt != aLast && !isSub; anIt++) {
-    isSub = isSubOfComposite(theObject, *anIt);
-  }
-  return isSub;
+  XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(theWorkshop);
+  return aConnector ? aConnector->workshop() : 0;
 }
 
-//**************************************************************
-bool isSubOfComposite(const ObjectPtr& theObject, const FeaturePtr& theFeature)
+
+//********************************************************************
+QString generateName(const ModuleBase_ViewerPrsPtr& thePrs)
 {
-  bool isSub = false;
-  CompositeFeaturePtr aComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
-  if (aComposite.get()) {
-    isSub = aComposite->isSub(theObject);
-    // the recursive is possible, the parameters are sketch circle and extrusion cut. They are
-    // separated by composite sketch feature
-    if (!isSub) {
-      int aNbSubs = aComposite->numberOfSubs();
-      for (int aSub = 0; aSub < aNbSubs && !isSub; aSub++) {
-        isSub = isSubOfComposite(theObject, aComposite->subFeature(aSub));
+  if (!thePrs.get() || !thePrs->object().get())
+    return "Undefined";
+
+  GeomShapePtr aContext;
+  ObjectPtr anObject = thePrs->object();
+  ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
+  if (aResult.get())
+    aContext = aResult->shape();
+  else {
+    // TODO if there is this case
+  }
+
+  QString aName = QString::fromStdWString(anObject->data()->name());
+  if (aContext.get()) {
+    GeomShapePtr aSubShape(new GeomAPI_Shape());
+    TopoDS_Shape aShape = ModuleBase_Tools::getSelectedShape(thePrs);
+    if (!aShape.IsNull()) {
+      aSubShape->setImpl(new TopoDS_Shape(aShape));
+      if (!aSubShape->isEqual(aContext)) {
+        QString aTypeName;
+        switch (aShape.ShapeType()) {
+        case TopAbs_COMPOUND:
+          aTypeName = "compound";
+          break;
+        case TopAbs_COMPSOLID:
+          aTypeName = "compsolid";
+          break;
+        case TopAbs_SOLID:
+          aTypeName = "solid";
+          break;
+        case TopAbs_SHELL:
+          aTypeName = "shell";
+          break;
+        case TopAbs_FACE:
+          aTypeName = "face";
+          break;
+        case TopAbs_WIRE:
+          aTypeName = "wire";
+          break;
+        case TopAbs_EDGE:
+          aTypeName = "edge";
+          break;
+        case TopAbs_VERTEX:
+          aTypeName = "vertex";
+          break;
+        case TopAbs_SHAPE:
+          aTypeName = "shape";
+          break;
+        }
+        int aId = GeomAlgoAPI_CompoundBuilder::id(aContext, aSubShape);
+        aName += QString("/%1_%2").arg(aTypeName).arg(aId);
       }
     }
   }
-  return isSub;
+  return aName;
 }
 
-//**************************************************************
-void refsToFeatureInAllDocuments(const ObjectPtr& theSourceObject, const ObjectPtr& theObject,
-                                 std::set<FeaturePtr>& theDirectRefFeatures, 
-                                 std::set<FeaturePtr>& theIndirectRefFeatures,
-                                 std::set<FeaturePtr>& theAlreadyProcessed)
+std::wstring strToWStr(const std::string& theStr) {
+  size_t aLen = theStr.size();
+  std::wstring aResult(aLen, L'#');
+  mbstowcs(&aResult[0], theStr.c_str(), aLen);
+  return aResult;
+}
+
+std::string getTmpDirByPath( const std::string& theTmpPath)
 {
-  FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
-  if (!aFeature.get())
-    return;
-  if (theAlreadyProcessed.find(aFeature) != theAlreadyProcessed.end())
-    return;
-  theAlreadyProcessed.insert(aFeature);
-
-  // 1. find references in the current document
-
-  std::set<FeaturePtr> aRefFeatures;
-  refsToFeatureInFeatureDocument(theObject, aRefFeatures);
-  std::set<FeaturePtr>::const_iterator anIt = aRefFeatures.begin(),
-                                       aLast = aRefFeatures.end();
-  for (; anIt != aLast; anIt++) {
-    // composite feature should not be deleted when the sub feature is to be deleted
-    if (!isSubOfComposite(theSourceObject, *anIt))
-      theDirectRefFeatures.insert(*anIt);
+  std::string aTmpDir = theTmpPath;
+  if (aTmpDir == "" || access(aTmpDir.c_str() , F_OK) != 0) {
+#ifdef WIN32
+    char *Tmp_dir = getenv("TEMP");
+    if (Tmp_dir == NULL) {
+      Tmp_dir = getenv("TMP");
+      if (Tmp_dir == NULL)
+        aTmpDir = "C:\\";
+      else
+        aTmpDir = Tmp_dir;
+    }
+    else
+      aTmpDir = Tmp_dir;
+#else
+    aTmpDir = "/tmp/";
+#endif
   }
 
-  // 2. find references in all documents if the document of the feature is
-  // "PartSet". Features of this document can be used in all other documents
-  DocumentPtr aFeatureDoc = aFeature->document();
-
-  SessionPtr aMgr = ModelAPI_Session::get();
-  DocumentPtr aModuleDoc = aMgr->moduleDocument();
-  if (aFeatureDoc == aModuleDoc) {
-    // the feature and results of the feature should be found in references
-    std::list<ObjectPtr> aObjects;
-    aObjects.push_back(aFeature);
-    typedef std::list<std::shared_ptr<ModelAPI_Result> > ResultsList;
-    const ResultsList& aResults = aFeature->results();
-    ResultsList::const_iterator aRIter = aResults.begin();
-    for (; aRIter != aResults.cend(); aRIter++) {
-      ResultPtr aRes = *aRIter;
-      if (aRes.get())
-        aObjects.push_back(aRes);
-    }
-    // get all opened documents; found features in the documents;
-    // get a list of objects where a feature refers;
-    // search in these objects the deleted objects.
-    SessionPtr aMgr = ModelAPI_Session::get();
-    std::list<DocumentPtr> anOpenedDocs = aMgr->allOpenedDocuments();
-    std::list<DocumentPtr>::const_iterator anIt = anOpenedDocs.begin(),
-                                            aLast = anOpenedDocs.end();
-    std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
-    for (; anIt != aLast; anIt++) {
-      DocumentPtr aDocument = *anIt;
-      if (aDocument == aFeatureDoc)
-        continue; // this document has been already processed in 1.1
-
-      int aFeaturesCount = aDocument->size(ModelAPI_Feature::group());
-      for (int aId = 0; aId < aFeaturesCount; aId++) {
-        ObjectPtr anObject = aDocument->object(ModelAPI_Feature::group(), aId);
-        FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
-        if (!aFeature.get())
-          continue;
-
-        aRefs.clear();
-        aFeature->data()->referencesToObjects(aRefs);
-        std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRef = aRefs.begin();
-        bool aHasReferenceToObject = false;
-        for(; aRef != aRefs.end() && !aHasReferenceToObject; aRef++) {
-          std::list<ObjectPtr>::iterator aRefObj = aRef->second.begin();
-          for(; aRefObj != aRef->second.end() && !aHasReferenceToObject; aRefObj++) {
-            std::list<ObjectPtr>::const_iterator aObjIt = aObjects.begin();
-            for(; aObjIt != aObjects.end() && !aHasReferenceToObject; aObjIt++) {
-              aHasReferenceToObject = *aObjIt == *aRefObj;
-            }
-          }
-        }
-        if (aHasReferenceToObject && !isSubOfComposite(theSourceObject, aFeature))
-          theDirectRefFeatures.insert(aFeature);
-      }
-    }
+  if (aTmpDir.back() != _separator_)
+    aTmpDir += _separator_;
+
+  srand((unsigned int)time( NULL ));
+  //Get a random number to present a name of a sub directory
+  int aRND = 999 + (int)(100000.0*rand()/(RAND_MAX+1.0));
+  char buffer[127];
+  sprintf(buffer, "%d", aRND);
+  std::string aSubDir(buffer);
+  if (aSubDir.size() <= 1)
+    aSubDir = "123049876";
+
+  aTmpDir += aSubDir; //Get RND sub directory
+
+  std::string aDir = aTmpDir;
+
+  for(aRND = 0; access(aDir.c_str() , F_OK) == 0; aRND++) {
+    sprintf( buffer, "%d", aRND );
+    aDir = aTmpDir + buffer;  //Build a unique directory name
+  }
+  if (aDir.back() != _separator_)
+    aDir += _separator_;
+
+#ifdef WIN32
+  CreateDirectory(strToWStr(aDir).c_str(), NULL);
+#else
+  mkdir( aDir.c_str(), 0x1ff );
+#endif
+
+  return aDir;
+}
+
+std::string getTmpDirByEnv( const char* thePathEnv)
+{
+  char* aVal = thePathEnv[0] == 0 ? 0 : getenv(thePathEnv);
+  std::string dir = aVal ? aVal : "";
+  return getTmpDirByPath(dir).c_str();
+}
+
+void removeTemporaryFiles(const std::string& theDirectory,
+  const std::list<std::string>& theFiles)
+{
+  std::string aDirName = theDirectory;
+
+  std::list<std::string>::const_iterator aFilesIter = theFiles.cbegin();
+  for(; aFilesIter != theFiles.cend(); aFilesIter++) {
+    const std::string& aFile = *aFilesIter;
+    if(access(aFile.c_str() , F_OK) != 0)
+      continue;
+
+#ifdef WIN32
+    DeleteFile(strToWStr(aFile).c_str());
+#else
+    unlink(aFile.c_str());
+#endif
   }
 
-  // Run recursion. It is possible recursive dependency, like the following: plane, extrusion uses plane,
-  // axis is built on extrusion. Delete of a plane should check the dependency from the axis also.
-  std::set<FeaturePtr>::const_iterator aFeatureIt = theDirectRefFeatures.begin();
-  for (; aFeatureIt != theDirectRefFeatures.end(); ++aFeatureIt) {
-    std::set<FeaturePtr> aRecursiveRefFeatures;
-    refsToFeatureInAllDocuments(theSourceObject, *aFeatureIt, 
-      aRecursiveRefFeatures, aRecursiveRefFeatures, theAlreadyProcessed);
-    theIndirectRefFeatures.insert(aRecursiveRefFeatures.begin(), aRecursiveRefFeatures.end());
+  if(access(aDirName.c_str() , F_OK) == 0) {
+#ifdef WIN32
+    RemoveDirectory(strToWStr(aDirName).c_str());
+#else
+    rmdir(aDirName.c_str());
+#endif
   }
 }