0029195: OCAF - ensure thread safety for different documents.
[occt.git] / src / CDM / CDM_MetaData.cxx
1 // Created on: 1997-10-22
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 <CDM_Application.hxx>
19 #include <CDM_Document.hxx>
20 #include <CDM_MetaData.hxx>
21 #include <CDM_MetaDataLookUpTable.hxx>
22 #include <CDM_Reference.hxx>
23 #include <CDF_Session.hxx>
24 #include <Standard_Dump.hxx>
25 #include <CDF_Application.hxx>
26 #include <Standard_NoSuchObject.hxx>
27 #include <Standard_Type.hxx>
28 #include <TCollection_ExtendedString.hxx>
29 #include <OSD_Thread.hxx>
30
31 IMPLEMENT_STANDARD_RTTIEXT(CDM_MetaData,Standard_Transient)
32
33 CDM_MetaData::CDM_MetaData(const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath,const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly):
34 myIsRetrieved(Standard_False),
35 myDocument(NULL),
36 myFolder(aFolder),
37 myName(aName),
38 myHasVersion(Standard_False),
39 myFileName(aFileName),
40 myPath(aPath),
41 myDocumentVersion(0),
42 myIsReadOnly(ReadOnly) 
43 {}
44
45 CDM_MetaData::CDM_MetaData(const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath,const TCollection_ExtendedString& aVersion,const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly):
46 myIsRetrieved(Standard_False),
47 myDocument(NULL),
48 myFolder(aFolder),
49 myName(aName),
50 myVersion(aVersion),
51 myHasVersion(Standard_True),
52 myFileName(aFileName),
53 myPath(aPath),
54 myDocumentVersion(0),
55 myIsReadOnly(ReadOnly)  
56 {}
57
58 Standard_Boolean CDM_MetaData::IsRetrieved() const {
59   return myIsRetrieved;
60 }
61
62 Handle(CDM_Document) CDM_MetaData::Document() const {
63   return myDocument;
64 }
65
66 void CDM_MetaData::SetDocument(const Handle(CDM_Document)& aDocument) {
67   myIsRetrieved = Standard_True;
68   myDocument = aDocument.operator->();
69 }
70 void CDM_MetaData::UnsetDocument() {
71   myIsRetrieved = Standard_False;
72 }
73 Handle(CDM_MetaData) CDM_MetaData::LookUp(const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath,const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly) {
74   Handle(CDM_MetaData) theMetaData;
75   TCollection_ExtendedString aConventionalPath=aPath;
76   aConventionalPath.ChangeAll('\\','/');
77   CDM_MetaDataLookUpTable* aLookUpTable = LookUpTable();
78   if (!aLookUpTable) return theMetaData;
79   if(!aLookUpTable->IsBound(aConventionalPath)) {
80     theMetaData = new CDM_MetaData(aFolder,aName,aPath,aFileName,ReadOnly);
81     aLookUpTable->Bind(aConventionalPath, theMetaData);
82   }
83   else
84     theMetaData = aLookUpTable->Find(aConventionalPath);
85   
86   return theMetaData;
87 }
88 Handle(CDM_MetaData) CDM_MetaData::LookUp(const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath, const TCollection_ExtendedString& aVersion, const TCollection_ExtendedString& aFileName,const Standard_Boolean ReadOnly) {
89   Handle(CDM_MetaData) theMetaData;
90   TCollection_ExtendedString aConventionalPath=aPath;
91   aConventionalPath.ChangeAll('\\','/');
92   CDM_MetaDataLookUpTable* aLookUpTable = LookUpTable();
93   if (!aLookUpTable) return theMetaData;
94   if(!aLookUpTable->IsBound(aConventionalPath)) {
95     theMetaData = new CDM_MetaData(aFolder,aName,aPath,aVersion,aFileName,ReadOnly);
96     aLookUpTable->Bind(aConventionalPath,theMetaData);
97   }
98   else
99     theMetaData = aLookUpTable->Find(aConventionalPath);
100   
101   return theMetaData;
102 }
103
104 TCollection_ExtendedString CDM_MetaData::Folder() const {
105   return myFolder;
106 }
107 TCollection_ExtendedString CDM_MetaData::Name() const {
108   return myName;
109 }
110 TCollection_ExtendedString CDM_MetaData::Version() const {
111   Standard_NoSuchObject_Raise_if(!myHasVersion,"Document has no version");
112   return myVersion;
113 }
114 Standard_Boolean CDM_MetaData::HasVersion() const {
115   return myHasVersion;
116 }
117
118 TCollection_ExtendedString CDM_MetaData::FileName() const {
119   return myFileName;
120 }
121 TCollection_ExtendedString CDM_MetaData::Path() const {
122   return myPath;
123 }
124 Standard_OStream& CDM_MetaData::Print(Standard_OStream& anOStream) const {
125   anOStream << "*CDM_MetaData*";
126   anOStream <<  myFolder << "," << myName; 
127   if(HasVersion()) anOStream << "," << myVersion ;
128   anOStream << "; Physical situation: ";
129   anOStream << myFileName;
130   anOStream << std::endl;
131   return anOStream;
132 }
133 Standard_OStream& CDM_MetaData::operator << (Standard_OStream& anOStream) {
134   return Print(anOStream);
135 }
136
137 CDM_MetaDataLookUpTable* CDM_MetaData::LookUpTable() {
138   Handle(CDF_Session) aSession = CDF_Session::Create();
139   Handle(CDF_Application) anApp;
140   CDM_MetaDataLookUpTable* pLookUpTable(NULL);
141   if (aSession->FindApplication(OSD_Thread::Current(), anApp))
142     return anApp->MetaDataLookUpTable();
143   return pLookUpTable;
144 }
145 Standard_Integer CDM_MetaData::DocumentVersion(const Handle(CDM_Application)& anApplication) {
146   if(myDocumentVersion==0) myDocumentVersion=anApplication->DocumentVersion(this);
147   return myDocumentVersion;
148 }
149 Standard_Boolean CDM_MetaData::IsReadOnly() const {
150   return myIsReadOnly;
151 }
152 void CDM_MetaData::SetIsReadOnly() {
153   myIsReadOnly=Standard_True;
154 }
155     
156 void CDM_MetaData::UnsetIsReadOnly() {
157   myIsReadOnly=Standard_False;
158 }
159
160 //=======================================================================
161 //function : DumpJson
162 //purpose  : 
163 //=======================================================================
164 void CDM_MetaData::DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth) const
165 {
166   OCCT_DUMP_TRANSIENT_CLASS_BEGIN (theOStream)
167
168   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsRetrieved)
169   OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, myDocument)
170   
171   OCCT_DUMP_FIELD_VALUE_STRING (theOStream, myFolder)
172   OCCT_DUMP_FIELD_VALUE_STRING (theOStream, myName)
173   OCCT_DUMP_FIELD_VALUE_STRING (theOStream, myVersion)
174   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myHasVersion)
175   OCCT_DUMP_FIELD_VALUE_STRING (theOStream, myFileName)
176   OCCT_DUMP_FIELD_VALUE_STRING (theOStream, myPath)
177   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myDocumentVersion)
178   OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsReadOnly)
179 }