0025748: Parallel version of progress indicator
[occt.git] / src / CDF / CDF_StoreList.cxx
1 // Created on: 1997-08-08
2 // Created by: Jean-Louis Frenkel
3 // Copyright (c) 1997-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17
18 #include <CDF_Application.hxx>
19 #include <CDF_MetaDataDriver.hxx>
20 #include <CDF_MetaDataDriverError.hxx>
21 #include <CDF_Session.hxx>
22 #include <CDF_StoreList.hxx>
23 #include <CDM_Document.hxx>
24 #include <CDM_MetaData.hxx>
25 #include <CDM_ReferenceIterator.hxx>
26 #include <PCDM.hxx>
27 #include <PCDM_Document.hxx>
28 #include <PCDM_StorageDriver.hxx>
29 #include <Standard_ErrorHandler.hxx>
30 #include <Standard_NoSuchObject.hxx>
31 #include <TCollection_ExtendedString.hxx>
32
33 IMPLEMENT_STANDARD_RTTIEXT(CDF_StoreList,Standard_Transient)
34
35 static void CAUGHT(const Standard_Failure& theException,TCollection_ExtendedString& status,const TCollection_ExtendedString& what) {
36   status += what;
37   status += theException.GetMessageString();
38 }
39
40 CDF_StoreList::CDF_StoreList(const Handle(CDM_Document)& aDocument) {
41   myMainDocument = aDocument;
42   Add(aDocument);
43 }
44
45 void CDF_StoreList::Add(const Handle(CDM_Document)& aDocument) {
46
47   if(!myItems.Contains(aDocument) && aDocument != myMainDocument) myItems.Add(aDocument);
48   myStack.Prepend(aDocument);
49   
50   CDM_ReferenceIterator it(aDocument);
51   for (;it.More();it.Next()) {
52     if(it.Document()->IsModified())  Add(it.Document());
53   }
54 }
55 Standard_Boolean CDF_StoreList::IsConsistent () const {
56   Standard_Boolean yes = Standard_True;
57   CDM_MapIteratorOfMapOfDocument it (myItems); 
58   for ( ; it.More() && yes ; it.Next()) {
59     yes = it.Key()->HasRequestedFolder();
60   }
61   return yes && myMainDocument->HasRequestedFolder();
62 }
63 void CDF_StoreList::Init() {
64   myIterator = CDM_MapIteratorOfMapOfDocument(myItems);
65 }
66 Standard_Boolean CDF_StoreList::More() const {
67   return myIterator.More();
68 }
69
70 void CDF_StoreList::Next() {
71   myIterator.Next();
72 }
73
74 Handle(CDM_Document) CDF_StoreList::Value() const {
75   return myIterator.Key();
76 }
77 PCDM_StoreStatus CDF_StoreList::Store (Handle(CDM_MetaData)& aMetaData, 
78                                       TCollection_ExtendedString& aStatusAssociatedText, 
79                                       const Message_ProgressRange& theRange)
80 {
81   Handle(CDF_MetaDataDriver) theMetaDataDriver = Handle(CDF_Application)::DownCast((myMainDocument->Application()))->MetaDataDriver();
82
83   PCDM_StoreStatus status = PCDM_SS_OK;
84   {
85     try {
86       OCC_CATCH_SIGNALS
87       for (; !myStack.IsEmpty(); myStack.RemoveFirst()) {
88
89         Handle(CDM_Document) theDocument = myStack.First();
90         if( theDocument == myMainDocument || theDocument->IsModified()) {
91
92           Handle(CDF_Application) anApp = Handle(CDF_Application)::DownCast (theDocument->Application());
93           if (anApp.IsNull())
94           {
95             throw Standard_Failure("Document has no application, cannot save!");
96           }
97           Handle(PCDM_StorageDriver) aDocumentStorageDriver = 
98             anApp->WriterFromFormat(theDocument->StorageFormat());
99           if (aDocumentStorageDriver.IsNull())
100           {
101             Standard_SStream aMsg;
102             aMsg <<"No storage driver does exist for this format: " << theDocument->StorageFormat() << (char)0;
103             throw Standard_Failure(aMsg.str().c_str());
104           }
105
106           // Reset the store-status.
107           // It has sense in multi-threaded access to the storage driver - this way we reset the status for each call.
108           aDocumentStorageDriver->SetStoreStatus(PCDM_SS_OK);
109
110           if(!theMetaDataDriver->FindFolder(theDocument->RequestedFolder())) {
111             Standard_SStream aMsg; aMsg << "could not find the active dbunit";
112             aMsg << TCollection_ExtendedString(theDocument->RequestedFolder())<< (char)0;
113             throw Standard_NoSuchObject(aMsg.str().c_str());
114           }
115           TCollection_ExtendedString theName=theMetaDataDriver->BuildFileName(theDocument);
116
117           aDocumentStorageDriver->Write(theDocument, theName, theRange);
118           status = aDocumentStorageDriver->GetStoreStatus();
119           aMetaData = theMetaDataDriver->CreateMetaData(theDocument,theName);
120           theDocument->SetMetaData(aMetaData);
121
122           CDM_ReferenceIterator it(theDocument);
123           for(; it.More();it.Next()) {
124             theMetaDataDriver->CreateReference(aMetaData,it.Document()->MetaData(),it.ReferenceIdentifier(),it.DocumentVersion());
125           }
126         }
127       }
128     }
129
130     catch (CDF_MetaDataDriverError const& anException) {
131       CAUGHT(anException, aStatusAssociatedText, TCollection_ExtendedString("metadatadriver failed; reason:"));
132       status = PCDM_SS_DriverFailure;
133     }
134     catch (Standard_Failure const& anException) {
135       CAUGHT(anException, aStatusAssociatedText, TCollection_ExtendedString("driver failed; reason:"));
136       status = PCDM_SS_Failure; 
137     }
138   }
139
140   return status;
141 }