0028862: Unification of empty labels saving procedure.
[occt.git] / src / DDocStd / DDocStd_ApplicationCommands.cxx
1 // Created on: 2000-03-01
2 // Created by: Denis PASCAL
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
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.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #include <DDocStd.hxx>
17 #include <Draw.hxx>
18 #include <Draw_Interpretor.hxx>
19 #include <Draw_Viewer.hxx>
20 #include <DDocStd_DrawDocument.hxx>
21 #include <TDocStd_Application.hxx>
22 #include <TDocStd_Document.hxx>
23 #include <TDataStd_Name.hxx>
24 #include <Draw.hxx>
25 #include <Standard_GUID.hxx>
26 #include <Standard_ExtString.hxx>
27 #include <TCollection_AsciiString.hxx>
28 #include <TCollection_ExtendedString.hxx>
29 #include <TDF.hxx>
30 #include <TDF_Data.hxx>
31 #include <TDF_ChildIterator.hxx>
32 #include <TDF_Tool.hxx> 
33
34 #include <OSD_Path.hxx>
35 #include <OSD_OpenFile.hxx>
36 #include <TDocStd_PathParser.hxx>
37 #include <XmlLDrivers.hxx>
38
39 #include <AIS_InteractiveContext.hxx>
40 #include <TPrsStd_AISViewer.hxx>
41 #include <ViewerTest.hxx>
42 #include <V3d_Viewer.hxx>
43
44 #ifndef _WIN32
45 extern Draw_Viewer dout;
46 #else
47 Standard_IMPORT Draw_Viewer dout;
48 #endif
49
50 //=======================================================================
51 //function : ListDocuments
52 //purpose  : 
53 //=======================================================================
54
55 static Standard_Integer DDocStd_ListDocuments (Draw_Interpretor& di,
56                                                Standard_Integer nb,
57                                                const char** /*a*/)
58 {  
59   if (nb == 1) {
60     Handle(TDocStd_Application) A = DDocStd::GetApplication();
61     Handle(TDocStd_Document) D;
62     Standard_Integer nbdoc = A->NbDocuments();
63     for (Standard_Integer i = 1; i <= nbdoc; i++) {
64       A->GetDocument(i,D);
65       di <<"document " << i;
66       if (D->IsSaved()) {
67         TCollection_AsciiString GetNameAsciiString(D->GetName().ToExtString(),'?');
68         TCollection_AsciiString GetPathAsciiString(D->GetPath().ToExtString(),'?');
69         //cout << " name : " << D->GetName();
70         //cout << " path : " << D->GetPath();
71         di << " name : " << GetNameAsciiString.ToCString();
72         di << " path : " << GetPathAsciiString.ToCString();
73       }
74       else di << " not saved";
75       di << "\n";
76     }
77     return 0;
78   }
79   di << "DDocStd_ListDocuments : Error\n";
80   return 1; 
81 }
82
83
84 //=======================================================================
85 //function : NewDocument
86 //purpose  : 
87 //=======================================================================
88
89 static Standard_Integer DDocStd_NewDocument (Draw_Interpretor& di,
90                                              Standard_Integer nb,
91                                              const char** a)
92 {    
93   Handle(TDocStd_Document) D; 
94   Handle(DDocStd_DrawDocument) DD;
95   if (nb == 2) {
96     if (!DDocStd::GetDocument(a[1],D,Standard_False)) { 
97       D = new TDocStd_Document("dummy");  
98       DD = new DDocStd_DrawDocument(D);  
99       Draw::Set(a[1],DD);       
100       di << "document (not handled by application)  " << a[1] << " created\n";  
101       DDocStd::ReturnLabel(di,D->Main()); 
102     }    
103     else di << a[1] << " is already a document\n";
104     return 0;
105   }
106   if (nb == 3) {   
107     if (!DDocStd::GetDocument(a[1],D,Standard_False)) {  
108       Handle(TDocStd_Application) A = DDocStd::GetApplication();
109       A->NewDocument(a[2],D);  
110       DD = new DDocStd_DrawDocument(D);  
111       TDataStd_Name::Set(D->GetData()->Root(),a[1]);  
112       Draw::Set(a[1],DD);    
113       di << "document " << a[1] << " created\n";    
114       DDocStd::ReturnLabel(di,D->Main()); 
115     }
116     else di << a[1] << " is already a document\n";
117     return 0;
118   }   
119   di << "DDocStd_NewDocument : Error\n";
120   return 1;
121 }
122
123 //=======================================================================
124 //function : Open
125 //purpose  : 
126 //=======================================================================
127
128 static Standard_Integer DDocStd_Open (Draw_Interpretor& di,
129                                       Standard_Integer nb,
130                                       const char** a)
131 {   
132   if (nb >= 3) {
133     TCollection_ExtendedString path (a[1]); 
134     Handle(TDocStd_Application) A = DDocStd::GetApplication();
135     Handle(TDocStd_Document) D;
136     Standard_Integer insession = A->IsInSession(path);
137     if (insession > 0) {  
138       di <<"document " << insession << "  is already in session\n";
139       return 0;
140     }
141     PCDM_ReaderStatus theStatus;
142
143     Standard_Boolean anUseStream = Standard_False;
144     for ( Standard_Integer i = 3; i < nb; i++ )
145     {
146       if (!strcmp (a[i], "-stream"))
147       {
148         di << "standard SEEKABLE stream is used\n";
149         anUseStream = Standard_True;
150         break;
151       }
152     }
153
154     if (anUseStream)
155     {
156       std::ifstream aFileStream;
157       OSD_OpenStream (aFileStream, path, std::ios::in | std::ios::binary);
158
159       theStatus = A->Open (aFileStream, D);
160     }
161     else
162     {
163       theStatus = A->Open(path,D);
164     }
165     if (theStatus == PCDM_RS_OK && !D.IsNull()) {
166       Handle(DDocStd_DrawDocument) DD = new DDocStd_DrawDocument(D);
167       TDataStd_Name::Set(D->GetData()->Root(),a[2]);
168       Draw::Set(a[2],DD);
169       return 0; 
170     } else {
171       switch ( theStatus ) {
172       case PCDM_RS_AlreadyRetrieved: 
173       case PCDM_RS_AlreadyRetrievedAndModified: {
174         di << " already retrieved \n" ;  
175         break;
176       }
177       case PCDM_RS_NoDriver: {
178         di << " could not retrieve , no Driver to make it \n" ;
179         break ;
180       }
181       case PCDM_RS_UnknownDocument:
182       case PCDM_RS_NoModel: {
183         di << " could not retrieve , Unknown Document or No Model \n";
184         break ; 
185       }
186       case PCDM_RS_TypeNotFoundInSchema:
187       case PCDM_RS_UnrecognizedFileFormat: {
188         di << " could not retrieve , Type not found or Unrecognized File Format\n";
189         break ;
190       }
191       case PCDM_RS_PermissionDenied: {
192         di << " could not retrieve , permission denied \n" ;  
193         break;
194       }
195       default:
196         di << " could not retrieve \n" ;  
197         break;
198       }
199       di << "DDocStd_Open : Error\n";
200     }   
201   }
202   return 1;
203 }
204
205 //=======================================================================
206 //function : Save
207 //purpose  : 
208 //=======================================================================
209
210 static Standard_Integer DDocStd_Save (Draw_Interpretor& di,
211                                       Standard_Integer nb,
212                                       const char** a)
213 {  
214   if (nb == 2) {
215     Handle(TDocStd_Document) D;    
216     if (!DDocStd::GetDocument(a[1],D)) return 1;
217     Handle(TDocStd_Application) A = DDocStd::GetApplication();
218     if (!D->IsSaved()) {
219       di << "this document has never been saved\n";
220       return 0;
221     }
222     A->Save(D);
223     return 0; 
224   }
225   di << "DDocStd_Save : Error\n";
226   return 1;
227 }
228
229 //=======================================================================
230 //function : SaveAs
231 //purpose  : 
232 //=======================================================================
233
234 static Standard_Integer DDocStd_SaveAs (Draw_Interpretor& di,
235                                         Standard_Integer nb,
236                                         const char** a)
237 {
238   if (nb >= 3) {
239     Handle(TDocStd_Document) D;    
240     if (!DDocStd::GetDocument(a[1],D)) return 1;  
241     TCollection_ExtendedString path (a[2]); 
242     Handle(TDocStd_Application) A = DDocStd::GetApplication();
243     PCDM_StoreStatus theStatus;
244
245     Standard_Boolean anUseStream(Standard_False), isSaveEmptyLabels(Standard_False);
246     for ( Standard_Integer i = 3; i < nb; i++ )
247     {
248       if (!strcmp (a[i], "-stream"))
249       {
250         di << "standard SEEKABLE stream is used\n";
251         anUseStream = Standard_True;
252         break;
253       } else {
254         isSaveEmptyLabels =  ((atoi (a[3])) != 0);
255         D->SetEmptyLabelsSavingMode(isSaveEmptyLabels);
256       }
257     }
258     if (anUseStream)
259     {
260       std::ofstream aFileStream;
261       OSD_OpenStream (aFileStream, path, std::ios::out | std::ios::binary);
262       theStatus = A->SaveAs (D, aFileStream);
263     }
264     else
265     {
266       theStatus = A->SaveAs(D,path);
267     }
268
269     if (theStatus != PCDM_SS_OK ) {
270       switch ( theStatus ) {
271       case PCDM_SS_DriverFailure: {
272         di << "Error saving document: Could not store , no driver found to make it\n";
273         break ;
274                                   }
275       case PCDM_SS_WriteFailure: {
276         di << "Error saving document: Write access failure\n";
277         break;
278                                  }
279       case PCDM_SS_Failure: {
280         di << "Error saving document: Write failure\n" ;
281         break;
282                             }
283       case PCDM_SS_Doc_IsNull: {
284         di << "Error saving document: No document to save\n";
285         break ;
286                                }
287       case PCDM_SS_No_Obj: {
288         di << "Error saving document: No objects written\n";
289         break;
290                            }
291       case PCDM_SS_Info_Section_Error: {
292         di << "Error saving document: Write info section failure\n" ;
293         break;
294                                        }
295       default:
296         break;
297       }
298       return 1;
299     } else {
300       return 0; 
301     }
302   }
303   di << "DDocStd_SaveAs : Error not enough argument\n";
304   return 1;
305 }
306
307 //=======================================================================
308 //function : Close
309 //purpose  : 
310 //=======================================================================
311
312 static Standard_Integer DDocStd_Close (Draw_Interpretor& /*theDI*/,
313                                        Standard_Integer  theArgNb,
314                                        const char**      theArgVec)
315 {   
316   if (theArgNb != 2)
317   {
318     std::cout << "DDocStd_Close : Error\n";
319     return 1;
320   }
321
322   Handle(TDocStd_Document) aDoc;
323   Standard_CString aDocName = theArgVec[1];
324   if (!DDocStd::GetDocument (aDocName, aDoc))
325   {
326     return 1;
327   }
328
329   TDF_Label aRoot = aDoc->GetData()->Root();
330   Handle(TPrsStd_AISViewer) aDocViewer;
331   if (TPrsStd_AISViewer::Find (aRoot, aDocViewer)
332    && !aDocViewer->GetInteractiveContext().IsNull())
333   {
334     Handle(V3d_Viewer) aViewer = aDocViewer->GetInteractiveContext()->CurrentViewer();
335     V3d_ListOfView aViews;
336     for (V3d_ListOfViewIterator aViewIter (aDocViewer->GetInteractiveContext()->CurrentViewer()->DefinedViewIterator()); aViewIter.More(); aViewIter.Next())
337     {
338       aViews.Append (aViewIter.Value());
339     }
340     for (V3d_ListOfViewIterator aViewIter (aViews); aViewIter.More(); aViewIter.Next())
341     {
342       Handle(V3d_View) aView = aViewIter.Value();
343       ViewerTest::RemoveView (aView);
344     }
345   }
346
347   Handle(TDocStd_Application) aDocApp = DDocStd::GetApplication();
348
349   aDocApp->Close (aDoc);
350
351   Handle(Draw_Drawable3D) aDrawable = Draw::Get (aDocName, Standard_False);
352   dout.RemoveDrawable (aDrawable);
353   Draw::Set (theArgVec[1], Handle(Draw_Drawable3D)());
354   return 0;
355 }
356
357 //=======================================================================
358 //function : IsInSession
359 //purpose  : 
360 //=======================================================================
361
362 static Standard_Integer DDocStd_IsInSession (Draw_Interpretor& di,
363                                              Standard_Integer nb,
364                                              const char** a)
365 {   
366   if (nb == 2) {   
367     Handle(TDocStd_Application) A = DDocStd::GetApplication();
368     di << A->IsInSession(a[1]);
369     return 0;
370   }  
371   di << "DDocStd_IsInSession : Error\n";
372   return 1;
373 }
374
375  
376 //=======================================================================
377 //function : OSDPath
378 //purpose  : 
379 //=======================================================================
380
381 static Standard_Integer DDocStd_OSDPath (Draw_Interpretor& di,
382                                          Standard_Integer nb,
383                                          const char** a)
384 {   
385   if (nb == 2) { 
386     OSD_Path path (a[1]);
387     di << "Node      : " << path.Node().ToCString() << "\n";  
388     di << "UserName  : " << path.UserName().ToCString() << "\n"; 
389     di << "Password  : " << path.Password().ToCString() << "\n";  
390     di << "Disk      : " << path.Disk().ToCString() << "\n";
391     di << "Trek      : " << path.Trek().ToCString() << "\n"; 
392     di << "Name      : " << path.Name().ToCString() << "\n";  
393     di << "Extension : " << path.Extension().ToCString() << "\n";
394     return 0;
395   }
396   di << "DDocStd_OSDPath : Error\n";
397   return 1;
398 }
399
400
401 //=======================================================================
402 //function : Path
403 //purpose  : 
404 //=======================================================================
405
406 static Standard_Integer DDocStd_Path (Draw_Interpretor& di,
407                                        Standard_Integer nb,
408                                        const char** a)
409 {   
410   if (nb == 2) { 
411     TDocStd_PathParser path (a[1]);
412     //cout << "Trek      : " << path.Trek() << endl;  
413     //cout << "Name      : " << path.Name() << endl; 
414     //cout << "Extension : " << path.Extension() << endl;
415     //cout << "Path      : " << path.Path() << endl;
416     TCollection_AsciiString TrekAsciiString(path.Trek().ToExtString(),'?');
417     TCollection_AsciiString NameAsciiString(path.Name().ToExtString(),'?');
418     TCollection_AsciiString ExtensionAsciiString(path.Extension().ToExtString(),'?');
419     TCollection_AsciiString PathAsciiString(path.Path().ToExtString(),'?');
420     di << "Trek      : " << TrekAsciiString.ToCString() << "\n";  
421     di << "Name      : " << NameAsciiString.ToCString() << "\n"; 
422     di << "Extension : " << ExtensionAsciiString.ToCString() << "\n";
423     di << "Path      : " << PathAsciiString.ToCString() << "\n";
424     return 0;
425   }
426   di << "DDocStd_Path : Error\n";
427   return 1;
428 }
429
430 //=======================================================================
431 //function : AddComment
432 //purpose  : 
433 //=======================================================================
434 static Standard_Integer DDocStd_AddComment (Draw_Interpretor& di,
435                                             Standard_Integer nb,
436                                             const char** a)
437 {  
438   if (nb == 3) {
439     Handle(TDocStd_Document) D;    
440     if (!DDocStd::GetDocument(a[1],D)) return 1;  
441     TCollection_ExtendedString comment (a[2]); 
442 //    Handle(TDocStd_Application) A = DDocStd::GetApplication();
443 //    A->AddComment(D,comment);
444     D->AddComment(comment);
445     return 0; 
446   }
447   di << "DDocStd_AddComment : Wrong arguments number\n";
448   return 1;
449 }
450
451 //=======================================================================
452 //function : PrintComments
453 //purpose  : 
454 //=======================================================================
455 static Standard_Integer DDocStd_PrintComments (Draw_Interpretor& di,
456                                                Standard_Integer nb,
457                                                const char** a)
458 {  
459   if (nb == 2) {
460     Handle(TDocStd_Document) D;    
461     if (!DDocStd::GetDocument(a[1],D)) return 1;  
462
463     TColStd_SequenceOfExtendedString comments;
464     D->Comments(comments);
465
466     for (int i = 1; i <= comments.Length(); i++)
467     {
468       //cout << comments(i) << endl;
469       TCollection_AsciiString commentAsciiString(comments(i).ToExtString(),'?');
470       di << commentAsciiString.ToCString() << "\n";
471     }
472
473     return 0; 
474   }
475   di << "DDocStd_PrintComments : Wrong arguments number\n";
476   return 1;
477 }
478
479 //=======================================================================
480 //function : SetStorageVerison
481 //purpose  : 
482 //=======================================================================
483 static Standard_Integer DDocStd_SetStorageVersion (Draw_Interpretor& ,
484                                                    Standard_Integer nb,
485                                                    const char** a)
486 {  
487   if (nb == 2)
488   {
489     const int version = atoi(a[1]);
490     XmlLDrivers::SetStorageVersion(version);
491     return 0;
492   }
493   return 1;
494 }
495
496 //=======================================================================
497 //function : GetStorageVerison
498 //purpose  : 
499 //=======================================================================
500 static Standard_Integer DDocStd_GetStorageVersion (Draw_Interpretor& di,
501                                                    Standard_Integer ,
502                                                    const char** )
503 {  
504   di << XmlLDrivers::StorageVersion() << "\n" ;
505   return 0;
506 }
507
508 //=======================================================================
509 //function : ApplicationCommands
510 //purpose  : 
511 //=======================================================================
512
513 void DDocStd::ApplicationCommands(Draw_Interpretor& theCommands) 
514 {
515   
516   static Standard_Boolean done = Standard_False;
517   if (done) return;
518   done = Standard_True;
519
520   const char* g = "DDocStd application commands";
521
522   // user application commands
523   theCommands.Add("ListDocuments",
524                   "ListDocuments",
525                   __FILE__, DDocStd_ListDocuments, g);  
526
527   theCommands.Add("NewDocument",
528                   "NewDocument docname format",
529                   __FILE__, DDocStd_NewDocument, g);  
530
531   theCommands.Add("Open",
532                   "Open path docname [-stream]",
533                   __FILE__, DDocStd_Open, g);   
534
535   theCommands.Add("SaveAs",
536                   "SaveAs DOC path [saveEmptyLabels: 0|1] [-stream]",
537                   __FILE__, DDocStd_SaveAs, g);  
538
539   theCommands.Add("Save",
540                   "Save",
541                   __FILE__, DDocStd_Save, g);  
542
543   theCommands.Add("Close",
544                   "Close DOC",
545                   __FILE__, DDocStd_Close, g);   
546
547   theCommands.Add("IsInSession",
548                   "IsInSession path",
549                   __FILE__, DDocStd_IsInSession, g);  
550
551   theCommands.Add("OSDPath",
552                   "OSDPath string",
553                   __FILE__, DDocStd_OSDPath, g);  
554
555   theCommands.Add("Path",
556                   "Path string",
557                   __FILE__, DDocStd_Path, g);
558
559   theCommands.Add("AddComment",
560                   "AddComment Doc string",
561                   __FILE__, DDocStd_AddComment, g);
562
563   theCommands.Add("PrintComments",
564                   "PrintComments Doc",
565                   __FILE__, DDocStd_PrintComments, g);
566
567   theCommands.Add("GetStorageVersion",
568                   "GetStorageVersion",
569                   __FILE__, DDocStd_GetStorageVersion, g);
570   theCommands.Add("SetStorageVersion",
571                   "SetStorageVersion Version",
572                   __FILE__, DDocStd_SetStorageVersion, g);
573 }