1 // Created on: 2002-11-26
2 // Created by: Vladimir ANIKIN
3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #include <DDocStd.hxx>
17 #include <TDocStd_MultiTransactionManager.hxx>
18 #include <DDocStd_DrawDocument.hxx>
19 #include <TDocStd_Document.hxx>
21 #include <DDF_Browser.hxx>
22 #include <TDF_Label.hxx>
23 #include <TDF_Tool.hxx>
24 #include <TDF_AttributeIterator.hxx>
25 #include <TDataStd_TreeNode.hxx>
26 #include <TDataStd_Integer.hxx>
27 #include <TDataStd_Real.hxx>
28 #include <TDataStd_Name.hxx>
29 #include <TDataStd_Comment.hxx>
30 #include <TDataStd_AsciiString.hxx>
31 #include <TDataStd_IntegerArray.hxx>
32 #include <TDataStd_RealArray.hxx>
33 #include <TDataStd_ByteArray.hxx>
34 #include <TNaming_NamedShape.hxx>
35 #include <TDataStd_UAttribute.hxx>
36 #include <TopoDS_Shape.hxx>
37 #include <Draw_Interpretor.hxx>
38 #include <TDF_Reference.hxx>
40 //=======================================================================
41 //function : mtmCreate
42 //purpose : creates new new multiple transactions' manager
43 //=======================================================================
45 static Handle(TDocStd_MultiTransactionManager) sMultiTransactionManager = 0;
47 static int mtmCreate (Draw_Interpretor& /*di*/, int n, const char** a)
49 if(!sMultiTransactionManager.IsNull())
50 sMultiTransactionManager->SetUndoLimit(0);
52 sMultiTransactionManager = new TDocStd_MultiTransactionManager();
54 sMultiTransactionManager->SetUndoLimit(Draw::Atoi(a[1]));
58 //=======================================================================
59 //function : mtmAddDocument
60 //purpose : adds a document to the transactions manager
61 //=======================================================================
63 static int mtmAddDocument (Draw_Interpretor& di, int n, const char** a)
65 if(sMultiTransactionManager.IsNull()) {
66 di << "Error : manager is not initialised\n";
70 Handle(DDocStd_DrawDocument) aDrawDoc =
71 Handle(DDocStd_DrawDocument)::DownCast(Draw::Get(a[1]));
72 if(aDrawDoc.IsNull()) {
73 di << "Error : wrong document name\n";
76 sMultiTransactionManager->AddDocument(aDrawDoc->GetDocument());
79 di << "Error : document name is not defined\n";
85 //=======================================================================
86 //function : mtmOpenTransaction
87 //purpose : opens new transaction
88 //=======================================================================
90 static int mtmOpenTransaction (Draw_Interpretor& di, int /*n*/, const char** /*a*/)
92 if(sMultiTransactionManager.IsNull()) {
93 di << "Error : manager is not initialised\n";
96 sMultiTransactionManager->OpenCommand();
100 //=======================================================================
101 //function : mtmCommitTransaction
102 //purpose : commits last opened transaction
103 //=======================================================================
105 static int mtmCommitTransaction (Draw_Interpretor& di, int n, const char** a)
107 if(sMultiTransactionManager.IsNull()) {
108 di << "Error : manager is not initialised\n";
112 sMultiTransactionManager->CommitCommand(TCollection_ExtendedString (a[1], Standard_True));
114 sMultiTransactionManager->CommitCommand();
118 //=======================================================================
119 //function : mtmAbortTransaction
120 //purpose : aborts last opened transaction
121 //=======================================================================
123 static int mtmAbortTransaction (Draw_Interpretor& di, int /*n*/, const char** /*a*/)
125 if(sMultiTransactionManager.IsNull()) {
126 di << "Error : manager is not initialised\n";
129 sMultiTransactionManager->AbortCommand();
133 //=======================================================================
135 //purpose : dumps state of the multiple transaction manager
136 //=======================================================================
138 static int mtmDump (Draw_Interpretor& di, int /*n*/, const char** /*a*/)
140 if(sMultiTransactionManager.IsNull()) {
141 di << "Error : manager is not initialised\n";
144 di << "*** Dump of MTM ***\n";
145 //sMultiTransactionManager->DumpTransaction(std::cout);
146 Standard_SStream aStream;
147 sMultiTransactionManager->DumpTransaction(aStream);
149 di << "\n*** End ***\n";
153 //=======================================================================
155 //purpose : undos last transaction
156 //=======================================================================
158 static int mtmUndo (Draw_Interpretor& di, int /*n*/, const char** /*a*/)
160 if(sMultiTransactionManager.IsNull()) {
161 di << "Error : manager is not initialised\n";
164 sMultiTransactionManager->Undo();
168 //=======================================================================
170 //purpose : redos last transaction
171 //=======================================================================
173 static int mtmRedo (Draw_Interpretor& di, int /*n*/, const char** /*a*/)
175 if(sMultiTransactionManager.IsNull()) {
176 di << "Error : manager is not initialised\n";
179 sMultiTransactionManager->Redo();
183 //=======================================================================
184 //function : mtmNestedMode
185 //purpose : redos last transaction
186 //=======================================================================
188 static int mtmNestedMode (Draw_Interpretor& di, int n, const char** a)
190 if(sMultiTransactionManager.IsNull()) {
191 di << "Error : manager is not initialised\n";
194 Standard_Boolean aMode = Standard_False;
196 aMode = Draw::Atoi(a[1]) ? Standard_True : Standard_False;
198 sMultiTransactionManager->SetNestedTransactionMode(aMode);
202 //=======================================================================
203 //function : XAttributeValue
205 //=======================================================================
207 static Standard_Integer XAttributeValue (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
209 if ( argc < 4 ) { di << "ERROR: Too few args\n"; return 1; }
210 Handle(DDF_Browser) browser = Handle(DDF_Browser)::DownCast (Draw::GetExisting (argv[1]));
211 if ( browser.IsNull() ) { std::cout << "Syntax error: Not a browser: " << argv[1] << "\n"; return 1; }
214 TDF_Tool::Label(browser->Data(),argv[2],lab);
215 if ( lab.IsNull() ) { di << "Syntax error: label is Null: " << argv[2] << "\n"; return 1; }
217 Standard_Integer num = Draw::Atoi ( argv[3] );
218 TDF_AttributeIterator itr(lab,Standard_False);
219 for (Standard_Integer i=1; itr.More() && i < num; i++) itr.Next();
221 if ( ! itr.More() ) { di << "Syntax error: Attribute #" << num << " not found\n"; return 1; }
223 const Handle(TDF_Attribute)& att = itr.Value();
224 if ( att->IsKind(STANDARD_TYPE(TDataStd_TreeNode)) )
226 Handle(TDataStd_TreeNode) TN = Handle(TDataStd_TreeNode)::DownCast(att);
227 TCollection_AsciiString ref;
228 if ( TN->HasFather() )
230 TDF_Tool::Entry ( TN->Father()->Label(), ref );
231 di << " ==> " << ref.ToCString();
235 di << " <== (" << ref.ToCString();
236 Handle(TDataStd_TreeNode) child = TN->First();
237 while ( ! child.IsNull() )
239 TDF_Tool::Entry ( child->Label(), ref );
240 if ( child != TN->First() ) di << ", ";
241 di << ref.ToCString();
242 child = child->Next();
247 else if ( att->IsKind(STANDARD_TYPE(TDF_Reference)) )
249 Handle(TDF_Reference) val = Handle(TDF_Reference)::DownCast ( att );
250 TCollection_AsciiString ref;
251 TDF_Tool::Entry ( val->Get(), ref );
252 di << "==> " << ref.ToCString();
254 else if ( att->IsKind(STANDARD_TYPE(TDataStd_Integer)) )
256 Handle(TDataStd_Integer) val = Handle(TDataStd_Integer)::DownCast ( att );
257 TCollection_AsciiString str ( val->Get() );
258 di << str.ToCString();
260 else if ( att->IsKind(STANDARD_TYPE(TDataStd_Real)) )
262 Handle(TDataStd_Real) val = Handle(TDataStd_Real)::DownCast ( att );
263 TCollection_AsciiString str ( val->Get() );
264 di << str.ToCString();
266 else if ( att->IsKind(STANDARD_TYPE(TDataStd_Name)) )
268 Handle(TDataStd_Name) val = Handle(TDataStd_Name)::DownCast ( att );
271 else if ( att->IsKind(STANDARD_TYPE(TDataStd_Comment)) )
273 Handle(TDataStd_Comment) val = Handle(TDataStd_Comment)::DownCast ( att );
276 else if ( att->IsKind(STANDARD_TYPE(TDataStd_AsciiString)) )
278 Handle(TDataStd_AsciiString) val = Handle(TDataStd_AsciiString)::DownCast ( att );
281 else if ( att->IsKind(STANDARD_TYPE(TDataStd_IntegerArray)) )
283 Handle(TDataStd_IntegerArray) val = Handle(TDataStd_IntegerArray)::DownCast ( att );
284 for ( Standard_Integer j=val->Lower(); j <= val->Upper(); j++ )
286 if ( j > val->Lower() ) di << ", ";
287 TCollection_AsciiString str ( val->Value(j) );
288 di << str.ToCString();
291 else if ( att->IsKind(STANDARD_TYPE(TDataStd_RealArray)) )
293 Handle(TDataStd_RealArray) val = Handle(TDataStd_RealArray)::DownCast ( att );
294 for ( Standard_Integer j=val->Lower(); j <= val->Upper(); j++ )
296 if ( j > val->Lower() ) di << ", ";
297 TCollection_AsciiString str ( val->Value(j) );
298 di << str.ToCString();
301 else if ( att->IsKind(STANDARD_TYPE(TDataStd_ByteArray)) )
303 Handle(TDataStd_ByteArray) val = Handle(TDataStd_ByteArray)::DownCast ( att );
304 for ( Standard_Integer j=val->Lower(); j <= val->Upper(); j++ )
306 if ( j > val->Lower() ) di << ", ";
307 TCollection_AsciiString str ( val->Value(j) );
308 di << str.ToCString();
311 else if ( att->IsKind(STANDARD_TYPE(TNaming_NamedShape)) )
313 Handle(TNaming_NamedShape) val = Handle(TNaming_NamedShape)::DownCast ( att );
314 TopoDS_Shape S = val->Get();
315 di << S.TShape()->DynamicType()->Name();
316 if ( ! S.Location().IsIdentity() ) di << "(located)";
322 //=======================================================================
323 //function : mtmRemoveDocument
324 //purpose : removes a document from the transactions manager
325 //=======================================================================
327 static int mtmRemoveDocument (Draw_Interpretor& di, int n, const char** a)
329 if(sMultiTransactionManager.IsNull()) {
330 di << "Error : manager is not initialised\n";
334 Handle(DDocStd_DrawDocument) aDrawDoc =
335 Handle(DDocStd_DrawDocument)::DownCast(Draw::Get(a[1]));
336 if(aDrawDoc.IsNull()) {
337 di << "Error : wrong document name\n";
340 sMultiTransactionManager->RemoveDocument(aDrawDoc->GetDocument());
343 di << "Error : document name is not defined\n";
349 //=======================================================================
350 //function : MTMCommands
352 //=======================================================================
354 void DDocStd::MTMCommands(Draw_Interpretor& theCommands)
356 static Standard_Boolean done = Standard_False;
358 done = Standard_True;
360 const char* g = "MTM test commands";
362 theCommands.Add("mtmCreate",
363 "\t [undo limit] creates new new multiple transactions' manager",
364 __FILE__, mtmCreate, g);
366 theCommands.Add("mtmAdd",
367 "\t <document name> adds a document to the transactions' manager",
368 __FILE__, mtmAddDocument, g);
370 theCommands.Add("mtmRemove",
371 "\t <document name> removes a document from the transactions' manager",
372 __FILE__, mtmRemoveDocument, g);
374 theCommands.Add("mtmOpen",
375 "\t opens new transaction",
376 __FILE__, mtmOpenTransaction, g);
378 theCommands.Add("mtmCommit",
379 "\t [<transaction name>] commits last opened transaction",
380 __FILE__, mtmCommitTransaction, g);
382 theCommands.Add("mtmAbort",
383 "\t aborts last opened transaction",
384 __FILE__, mtmAbortTransaction, g);
386 theCommands.Add("mtmDump",
387 "\t dumps state of the multiple transactions' manager",
388 __FILE__, mtmDump, g);
390 theCommands.Add("mtmUndo",
391 "\t undos last transaction",
392 __FILE__, mtmUndo, g);
394 theCommands.Add("mtmRedo",
395 "\t redos last transaction",
396 __FILE__, mtmRedo, g);
398 theCommands.Add("mtmNestedMode",
399 "\t [0/1] sets nested mode if 1 and usets if 0 (default 0)",
400 __FILE__, mtmNestedMode, g);
402 theCommands.Add ("XAttributeValue", "Doc label #attribute: internal command for browser",
403 __FILE__, XAttributeValue, g);