src/Model/Model_Document.cpp

   1 // File:        Model_Document.cxx
   2 // Created:     28 Feb 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #include <Model_Document.h>
   6 #include <ModelAPI_Feature.h>
   7 #include <Model_Data.h>
   8 #include <Model_Application.h>
   9 #include <Model_PluginManager.h>
  10 #include <Model_Events.h>
  11 #include <Events_Loop.h>
  12 #include <Events_Error.h>
  13
  14 #include <TDataStd_Integer.hxx>
  15 #include <TDataStd_Comment.hxx>
  16 #include <TDF_ChildIDIterator.hxx>
  17 #include <TDataStd_ReferenceArray.hxx>
  18 #include <TDataStd_HLabelArray1.hxx>
  19
  20 #include <climits>
  21
  22 #ifdef WIN32
  23 # define _separator_ '\\'
  24 #else
  25 # define _separator_ '/'
  26 #endif
  27
  28 static const int UNDO_LIMIT = 10; // number of possible undo operations
  29
  30 static const int TAG_GENERAL = 1; // general properties tag
  31 static const int TAG_OBJECTS = 2; // tag of the objects sub-tree (features)
  32 static const int TAG_HISTORY = 3; // tag of the history sub-tree (python dump)
  33
  34 using namespace std;
  35
  36 /// Returns the file name of this document by the nameof directory and identifuer of a document
  37 static TCollection_ExtendedString DocFileName(const char* theFileName, const string& theID)
  38 {
  39   TCollection_ExtendedString aPath ((const Standard_CString)theFileName);
  40   aPath += _separator_;
  41   aPath += theID.c_str();
  42   aPath += ".cbf"; // standard binary file extension
  43   return aPath;
  44 }
  45
  46 bool Model_Document::load(const char* theFileName)
  47 {
  48   Handle(Model_Application) anApp = Model_Application::getApplication();
  49   if (this == Model_PluginManager::get()->rootDocument().get()) {
  50     anApp->setLoadPath(theFileName);
  51   }
  52   TCollection_ExtendedString aPath (DocFileName(theFileName, myID));
  53   PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
  54   try
  55   {
  56     aStatus = anApp->Open(aPath, myDoc);
  57   }
  58   catch (Standard_Failure)
  59   {
  60     Handle(Standard_Failure) aFail = Standard_Failure::Caught();
  61     Events_Error::send(string("Exception in opening of document: ") + aFail->GetMessageString());
  62     return false;
  63   }
  64   bool isError = aStatus != PCDM_RS_OK;
  65   if (isError)
  66   {
  67     switch (aStatus)
  68     {
  69     case PCDM_RS_UnknownDocument:
  70       Events_Error::send(string("Can not open document: PCDM_RS_UnknownDocument")); break;
  71     case PCDM_RS_AlreadyRetrieved:
  72       Events_Error::send(string("Can not open document: PCDM_RS_AlreadyRetrieved")); break;
  73     case PCDM_RS_AlreadyRetrievedAndModified:
  74       Events_Error::send(string("Can not open document: PCDM_RS_AlreadyRetrievedAndModified")); break;
  75     case PCDM_RS_NoDriver:
  76       Events_Error::send(string("Can not open document: PCDM_RS_NoDriver")); break;
  77     case PCDM_RS_UnknownFileDriver:
  78       Events_Error::send(string("Can not open document: PCDM_RS_UnknownFileDriver")); break;
  79     case PCDM_RS_OpenError:
  80       Events_Error::send(string("Can not open document: PCDM_RS_OpenError")); break;
  81     case PCDM_RS_NoVersion:
  82       Events_Error::send(string("Can not open document: PCDM_RS_NoVersion")); break;
  83     case PCDM_RS_NoModel:
  84       Events_Error::send(string("Can not open document: PCDM_RS_NoModel")); break;
  85     case PCDM_RS_NoDocument:
  86       Events_Error::send(string("Can not open document: PCDM_RS_NoDocument")); break;
  87     case PCDM_RS_FormatFailure:
  88       Events_Error::send(string("Can not open document: PCDM_RS_FormatFailure")); break;
  89     case PCDM_RS_TypeNotFoundInSchema:
  90       Events_Error::send(string("Can not open document: PCDM_RS_TypeNotFoundInSchema")); break;
  91     case PCDM_RS_UnrecognizedFileFormat:
  92       Events_Error::send(string("Can not open document: PCDM_RS_UnrecognizedFileFormat")); break;
  93     case PCDM_RS_MakeFailure:
  94       Events_Error::send(string("Can not open document: PCDM_RS_MakeFailure")); break;
  95     case PCDM_RS_PermissionDenied:
  96       Events_Error::send(string("Can not open document: PCDM_RS_PermissionDenied")); break;
  97     case PCDM_RS_DriverFailure:
  98       Events_Error::send(string("Can not open document: PCDM_RS_DriverFailure")); break;
  99     default:
 100       Events_Error::send(string("Can not open document: unknown error")); break;
 101     }
 102   }
 103   if (!isError) {
 104     myDoc->SetUndoLimit(UNDO_LIMIT);
 105     synchronizeFeatures();
 106   }
 107   return !isError;
 108 }
 109
 110 bool Model_Document::save(const char* theFileName)
 111 {
 112   // create a directory in the root document if it is not yet exist
 113   if (this == Model_PluginManager::get()->rootDocument().get()) {
 114 #ifdef WIN32
 115     CreateDirectory(theFileName, NULL);
 116 #else
 117     mkdir(theFileName, 0x1ff);
 118 #endif
 119   }
 120   // filename in the dir is id of document inside of the given directory
 121   TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
 122   PCDM_StoreStatus aStatus;
 123   try {
 124     aStatus = Model_Application::getApplication()->SaveAs(myDoc, aPath);
 125   }
 126   catch (Standard_Failure) {
 127     Handle(Standard_Failure) aFail = Standard_Failure::Caught();
 128     Events_Error::send(string("Exception in saving of document: ") + aFail->GetMessageString());
 129     return false;
 130   }
 131   bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
 132   if (!isDone)
 133   {
 134     switch (aStatus)
 135     {
 136     case PCDM_SS_DriverFailure:
 137       Events_Error::send(string("Can not save document: PCDM_SS_DriverFailure"));
 138       break;
 139     case PCDM_SS_WriteFailure:
 140       Events_Error::send(string("Can not save document: PCDM_SS_WriteFailure"));
 141       break;
 142     case PCDM_SS_Failure:
 143     default:
 144       Events_Error::send(string("Can not save document: PCDM_SS_Failure"));
 145       break;
 146     }
 147   }
 148   myTransactionsAfterSave = 0;
 149   if (isDone) { // save also sub-documents if any
 150     set<string>::iterator aSubIter = mySubs.begin();
 151     for(; aSubIter != mySubs.end() && isDone; aSubIter++)
 152       isDone = subDocument(*aSubIter)->save(theFileName);
 153   }
 154   return isDone;
 155 }
 156
 157 void Model_Document::close()
 158 {
 159   // close all subs
 160   set<string>::iterator aSubIter = mySubs.begin();
 161   for(; aSubIter != mySubs.end(); aSubIter++)
 162     subDocument(*aSubIter)->close();
 163   mySubs.clear();
 164   // close this
 165   myDoc->Close();
 166   Model_Application::getApplication()->deleteDocument(myID);
 167 }
 168
 169 void Model_Document::startOperation()
 170 {
 171   // new command for this
 172   myDoc->NewCommand();
 173   // new command for all subs
 174   set<string>::iterator aSubIter = mySubs.begin();
 175   for(; aSubIter != mySubs.end(); aSubIter++)
 176     subDocument(*aSubIter)->startOperation();
 177 }
 178
 179 void Model_Document::finishOperation()
 180 {
 181   // returns false if delta is empty and no transaction was made
 182   myIsEmptyTr[myTransactionsAfterSave] = !myDoc->CommitCommand();
 183   myTransactionsAfterSave++;
 184   // finish for all subs
 185   set<string>::iterator aSubIter = mySubs.begin();
 186   for(; aSubIter != mySubs.end(); aSubIter++)
 187     subDocument(*aSubIter)->finishOperation();
 188 }
 189
 190 void Model_Document::abortOperation()
 191 {
 192   myDoc->AbortCommand();
 193   // abort for all subs
 194   set<string>::iterator aSubIter = mySubs.begin();
 195   for(; aSubIter != mySubs.end(); aSubIter++)
 196     subDocument(*aSubIter)->abortOperation();
 197 }
 198
 199 bool Model_Document::isOperation()
 200 {
 201   // operation is opened for all documents: no need to check subs
 202   return myDoc->HasOpenCommand() == Standard_True ;
 203 }
 204
 205 bool Model_Document::isModified()
 206 {
 207   // is modified if at least one operation was commited and not undoed
 208   return myTransactionsAfterSave > 0;
 209 }
 210
 211 bool Model_Document::canUndo()
 212 {
 213   if (myDoc->GetAvailableUndos() > 0)
 214     return true;
 215   // check other subs contains operation that can be undoed
 216   set<string>::iterator aSubIter = mySubs.begin();
 217   for(; aSubIter != mySubs.end(); aSubIter++)
 218     if (subDocument(*aSubIter)->canUndo())
 219       return true;
 220   return false;
 221 }
 222
 223 void Model_Document::undo()
 224 {
 225   myTransactionsAfterSave--;
 226   if (!myIsEmptyTr[myTransactionsAfterSave])
 227     myDoc->Undo();
 228   synchronizeFeatures();
 229   // undo for all subs
 230   set<string>::iterator aSubIter = mySubs.begin();
 231   for(; aSubIter != mySubs.end(); aSubIter++)
 232     subDocument(*aSubIter)->undo();
 233 }
 234
 235 bool Model_Document::canRedo()
 236 {
 237   if (myDoc->GetAvailableRedos() > 0)
 238     return true;
 239   // check other subs contains operation that can be redoed
 240   set<string>::iterator aSubIter = mySubs.begin();
 241   for(; aSubIter != mySubs.end(); aSubIter++)
 242     if (subDocument(*aSubIter)->canRedo())
 243       return true;
 244   return false;
 245 }
 246
 247 void Model_Document::redo()
 248 {
 249   if (!myIsEmptyTr[myTransactionsAfterSave])
 250     myDoc->Redo();
 251   myTransactionsAfterSave++;
 252   synchronizeFeatures();
 253   // redo for all subs
 254   set<string>::iterator aSubIter = mySubs.begin();
 255   for(; aSubIter != mySubs.end(); aSubIter++)
 256     subDocument(*aSubIter)->redo();
 257 }
 258
 259 boost::shared_ptr<ModelAPI_Feature> Model_Document::addFeature(string theID)
 260 {
 261   boost::shared_ptr<ModelAPI_Feature> aFeature =
 262     ModelAPI_PluginManager::get()->createFeature(theID);
 263   if (aFeature) {
 264     boost::dynamic_pointer_cast<Model_Document>(aFeature->documentToAdd())->addFeature(aFeature);
 265   } else {
 266     // TODO: generate error that feature is not created
 267   }
 268   return aFeature;
 269 }
 270
 271 void Model_Document::addFeature(const boost::shared_ptr<ModelAPI_Feature> theFeature)
 272 {
 273   const std::string& aGroup = theFeature->getGroup();
 274   TDF_Label aGroupLab = groupLabel(aGroup);
 275   TDF_Label anObjLab = aGroupLab.NewChild();
 276   boost::shared_ptr<Model_Data> aData(new Model_Data);
 277   aData->setFeature(theFeature);
 278   aData->setLabel(anObjLab);
 279   boost::shared_ptr<ModelAPI_Document> aThis =
 280     Model_Application::getApplication()->getDocument(myID);
 281   theFeature->setData(aData);
 282   theFeature->setDoc(aThis);
 283   setUniqueName(theFeature);
 284   theFeature->initAttributes();
 285   // keep the feature ID to restore document later correctly
 286   TDataStd_Comment::Set(anObjLab, theFeature->getKind().c_str());
 287   // put index of the feature in the group in the tree
 288   TDataStd_Integer::Set(anObjLab, myFeatures[aGroup].size());
 289   myFeatures[aGroup].push_back(theFeature);
 290   // store feature in the history of features array
 291   if (theFeature->isInHistory()) {
 292     Handle(TDataStd_ReferenceArray) aRefs;
 293     if (!groupLabel(FEATURES_GROUP).FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
 294       aRefs = TDataStd_ReferenceArray::Set(groupLabel(FEATURES_GROUP), 0, 0);
 295       aRefs->SetValue(0, anObjLab);
 296     } else { // extend array by one more element
 297       Handle(TDataStd_HLabelArray1) aNewArray =
 298         new TDataStd_HLabelArray1(aRefs->Lower(), aRefs->Upper() + 1);
 299       for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
 300         aNewArray->SetValue(a, aRefs->Value(a));
 301       }
 302       aNewArray->SetValue(aRefs->Upper() + 1, anObjLab);
 303       aRefs->SetInternalArray(aNewArray);
 304     }
 305   }
 306
 307   // event: feature is added
 308   static Events_ID anEvent = Events_Loop::eventByName(EVENT_FEATURE_CREATED);
 309   Model_FeatureUpdatedMessage aMsg(theFeature, anEvent);
 310   Events_Loop::loop()->send(aMsg);
 311 }
 312
 313 boost::shared_ptr<ModelAPI_Feature> Model_Document::feature(TDF_Label& theLabel)
 314 {
 315   Handle(TDataStd_Integer) aFeatureIndex;
 316   if (theLabel.FindAttribute(TDataStd_Integer::GetID(), aFeatureIndex)) {
 317     Handle(TDataStd_Comment) aGroupID;
 318     if (theLabel.Father().FindAttribute(TDataStd_Comment::GetID(), aGroupID)) {
 319       string aGroup = TCollection_AsciiString(aGroupID->Get()).ToCString();
 320       return myFeatures[aGroup][aFeatureIndex->Get()];
 321     }
 322   }
 323   return boost::shared_ptr<ModelAPI_Feature>(); // not found
 324 }
 325
 326 int Model_Document::featureIndex(boost::shared_ptr<ModelAPI_Feature> theFeature)
 327 {
 328   if (theFeature->document().get() != this) {
 329     return theFeature->document()->featureIndex(theFeature);
 330   }
 331   boost::shared_ptr<Model_Data> aData =
 332     boost::dynamic_pointer_cast<Model_Data>(theFeature->data());
 333   Handle(TDataStd_Integer) aFeatureIndex;
 334   if (aData->label().FindAttribute(TDataStd_Integer::GetID(), aFeatureIndex)) {
 335     return aFeatureIndex->Get();
 336   }
 337   return -1; // not found
 338 }
 339
 340 boost::shared_ptr<ModelAPI_Document> Model_Document::subDocument(string theDocID)
 341 {
 342   // just store sub-document identifier here to manage it later
 343   if (mySubs.find(theDocID) == mySubs.end())
 344     mySubs.insert(theDocID);
 345   return Model_Application::getApplication()->getDocument(theDocID);
 346 }
 347
 348 boost::shared_ptr<ModelAPI_Feature> Model_Document::feature(
 349   const string& theGroupID, const int theIndex)
 350 {
 351   if (theGroupID == FEATURES_GROUP) { // history is just a references array
 352     Handle(TDataStd_ReferenceArray) aRefs;
 353     if (groupLabel(FEATURES_GROUP).FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
 354       if (aRefs->Lower() <= theIndex && aRefs->Upper() >= theIndex) {
 355         TDF_Label aFeatureLab = aRefs->Value(theIndex);
 356         return feature(aFeatureLab);
 357       }
 358     }
 359   } else { // one of the group
 360     map<string, vector<boost::shared_ptr<ModelAPI_Feature> > >::iterator aGroup =
 361       myFeatures.find(theGroupID);
 362     if (aGroup != myFeatures.end() && (int)(aGroup->second.size()) > theIndex) {
 363       return aGroup->second[theIndex];
 364     }
 365   }
 366   // not found
 367   return boost::shared_ptr<ModelAPI_Feature>();
 368 }
 369
 370 int Model_Document::size(const string& theGroupID)
 371 {
 372   if (theGroupID == FEATURES_GROUP) { // history is just a references array
 373     Handle(TDataStd_ReferenceArray) aRefs;
 374     if (groupLabel(FEATURES_GROUP).FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
 375       return aRefs->Length();
 376   } else { // one of the group
 377     map<string, vector<boost::shared_ptr<ModelAPI_Feature> > >::iterator aGroup =
 378       myFeatures.find(theGroupID);
 379     if (aGroup != myFeatures.end())
 380       return aGroup->second.size();
 381   }
 382   // group is not found
 383   return 0;
 384 }
 385
 386 const vector<string>& Model_Document::getGroups() const
 387 {
 388   return myGroupsNames;
 389 }
 390
 391 Model_Document::Model_Document(const std::string theID)
 392     : myID(theID), myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
 393 {
 394   myDoc->SetUndoLimit(UNDO_LIMIT);
 395   myTransactionsAfterSave = 0;
 396   // to have something in the document and avoid empty doc open/save problem
 397   TDataStd_Integer::Set(myDoc->Main().Father(), 0);
 398 }
 399
 400 TDF_Label Model_Document::groupLabel(const string theGroup)
 401 {
 402   if (myGroups.find(theGroup) == myGroups.end()) {
 403     myGroups[theGroup] = myDoc->Main().FindChild(TAG_OBJECTS).NewChild();
 404     myGroupsNames.push_back(theGroup);
 405     // set to the group label the group idntifier to restore on "open"
 406     TDataStd_Comment::Set(myGroups[theGroup], theGroup.c_str());
 407     myFeatures[theGroup] = vector<boost::shared_ptr<ModelAPI_Feature> >();
 408   }
 409   return myGroups[theGroup];
 410 }
 411
 412 void Model_Document::setUniqueName(boost::shared_ptr<ModelAPI_Feature> theFeature)
 413 {
 414   // first count all objects of such kind to start with index = count + 1
 415   int a, aNumObjects = 0;
 416   int aSize = size(theFeature->getGroup());
 417   for(a = 0; a < aSize; a++) {
 418     if (feature(theFeature->getGroup(), a)->getKind() == theFeature->getKind())
 419       aNumObjects++;
 420   }
 421   // generate candidate name
 422   stringstream aNameStream;
 423   aNameStream<<theFeature->getKind()<<"_"<<aNumObjects + 1;
 424   string aName = aNameStream.str();
 425   // check this is unique, if not, increase index by 1
 426   for(a = 0; a < aSize;) {
 427     if (feature(theFeature->getGroup(), a)->data()->getName() == aName) {
 428       aNumObjects++;
 429       stringstream aNameStream;
 430       aNameStream<<theFeature->getKind()<<"_"<<aNumObjects + 1;
 431       // reinitialize iterator to make sure a new name is unique
 432       a = 0;
 433     } else a++;
 434   }
 435
 436   theFeature->data()->setName(aName);
 437 }
 438
 439 void Model_Document::synchronizeFeatures()
 440 {
 441   boost::shared_ptr<ModelAPI_Document> aThis = Model_Application::getApplication()->getDocument(myID);
 442   // iterate groups labels
 443   TDF_ChildIDIterator aGroupsIter(myDoc->Main().FindChild(TAG_OBJECTS),
 444     TDataStd_Comment::GetID(), Standard_False);
 445   vector<string>::iterator aGroupNamesIter = myGroupsNames.begin();
 446   for(; aGroupsIter.More() && aGroupNamesIter != myGroupsNames.end();
 447         aGroupsIter.Next(), aGroupNamesIter++) {
 448     string aGroupName = TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(
 449       aGroupsIter.Value())->Get()).ToCString();
 450     if (*aGroupNamesIter != aGroupName)
 451       break; // all since there is a change this must be recreated from scratch
 452   }
 453   // delete all groups left after the data model groups iteration
 454   while(aGroupNamesIter != myGroupsNames.end()) {
 455     string aGroupName = *aGroupNamesIter;
 456     myFeatures.erase(aGroupName);
 457     myGroups.erase(aGroupName);
 458     aGroupNamesIter = myGroupsNames.erase(aGroupNamesIter);
 459     // say that features were deleted from group
 460     Model_FeatureDeletedMessage aMsg(aThis, aGroupName);
 461     Events_Loop::loop()->send(aMsg);
 462   }
 463   // create new groups basing on the following data model update
 464   for(; aGroupsIter.More(); aGroupsIter.Next()) {
 465     string aGroupName = TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(
 466       aGroupsIter.Value())->Get()).ToCString();
 467     myGroupsNames.push_back(aGroupName);
 468     myGroups[aGroupName] = aGroupsIter.Value()->Label();
 469     myFeatures[aGroupName] = vector<boost::shared_ptr<ModelAPI_Feature> >();
 470   }
 471   // update features group by group
 472   aGroupsIter.Initialize(myDoc->Main().FindChild(TAG_OBJECTS),
 473     TDataStd_Comment::GetID(), Standard_False);
 474   for(; aGroupsIter.More(); aGroupsIter.Next()) {
 475     string aGroupName = TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(
 476       aGroupsIter.Value())->Get()).ToCString();
 477     // iterate features in internal container
 478     vector<boost::shared_ptr<ModelAPI_Feature> >& aFeatures = myFeatures[aGroupName];
 479     vector<boost::shared_ptr<ModelAPI_Feature> >::iterator aFIter = aFeatures.begin();
 480     // and in parallel iterate labels of features
 481     TDF_ChildIDIterator aFLabIter(
 482       aGroupsIter.Value()->Label(), TDataStd_Comment::GetID(), Standard_False);
 483     while(aFIter != aFeatures.end() || aFLabIter.More()) {
 484       static const int INFINITE_TAG = INT_MAX; // no label means that it exists somwhere in infinite
 485       int aFeatureTag = INFINITE_TAG;
 486       if (aFIter != aFeatures.end()) { // existing tag for feature
 487         boost::shared_ptr<Model_Data> aData = boost::dynamic_pointer_cast<Model_Data>((*aFIter)->data());
 488         aFeatureTag = aData->label().Tag();
 489       }
 490       int aDSTag = INFINITE_TAG;
 491       if (aFLabIter.More()) { // next label in DS is existing
 492         aDSTag = aFLabIter.Value()->Label().Tag();
 493       }
 494       if (aDSTag > aFeatureTag) { // feature is removed
 495         aFIter = aFeatures.erase(aFIter);
 496         // event: model is updated
 497         Model_FeatureDeletedMessage aMsg(aThis, aGroupName);
 498         Events_Loop::loop()->send(aMsg);
 499       } else if (aDSTag < aFeatureTag) { // a new feature is inserted
 500         // create a feature
 501         boost::shared_ptr<ModelAPI_Feature> aFeature = ModelAPI_PluginManager::get()->createFeature(
 502           TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(
 503           aFLabIter.Value())->Get()).ToCString());
 504
 505         boost::shared_ptr<Model_Data> aData(new Model_Data);
 506         TDF_Label aLab = aFLabIter.Value()->Label();
 507         aData->setLabel(aLab);
 508         aData->setFeature(aFeature);
 509         aFeature->setDoc(aThis);
 510         aFeature->setData(aData);
 511         aFeature->initAttributes();
 512
 513         if (aFIter == aFeatures.end()) {
 514           aFeatures.push_back(aFeature);
 515           aFIter = aFeatures.end();
 516         } else {
 517           aFIter++;
 518           aFeatures.insert(aFIter, aFeature);
 519         }
 520         // event: model is updated
 521         static Events_ID anEvent = Events_Loop::eventByName(EVENT_FEATURE_CREATED);
 522         Model_FeatureUpdatedMessage aMsg(aFeature, anEvent);
 523         Events_Loop::loop()->send(aMsg);
 524
 525         // feature for this label is added, so go to the next label
 526         aFLabIter.Next();
 527       } else { // nothing is changed, both iterators are incremented
 528         aFIter++;
 529         aFLabIter.Next();
 530       }
 531     }
 532   }
 533 }