a5177e8de9293d6edd62cf8d854e3ca9327f63c8
[occt.git] / src / Draw / Draw_Interpretor.cxx
1 // Created on: 1995-02-23
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1995-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 #include <Draw_Interpretor.hxx>
18 #include <Draw_Appli.hxx>
19 #include <Standard_SStream.hxx>
20 #include <Standard_RangeError.hxx>
21 #include <Standard_ErrorHandler.hxx>
22 #include <Standard_Macro.hxx>
23
24 #include <TCollection_AsciiString.hxx>
25 #include <TCollection_ExtendedString.hxx>
26 #include <OSD_Process.hxx>
27 #include <OSD_Path.hxx>
28 #include <OSD.hxx>
29 #include <OSD_File.hxx>
30
31 #include <string.h>
32 #include <tcl.h>
33 #include <fcntl.h>
34 #ifndef _WIN32
35 #include <unistd.h>
36 #endif
37
38 // for capturing of cout and cerr (dup(), dup2())
39 #ifdef _WIN32
40 #include <io.h>
41 #include <sys/stat.h>  
42 #endif
43
44 #if ! defined(STDOUT_FILENO)
45 #define STDOUT_FILENO fileno(stdout)
46 #endif
47 #if ! defined(STDERR_FILENO)
48 #define STDERR_FILENO fileno(stderr)
49 #endif
50
51 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 1)))
52 #define TCL_USES_UTF8
53 #endif
54
55 // logging helpers
56 namespace {
57   void dumpArgs (Standard_OStream& os, int argc, const char *argv[])
58   {
59     for (int i=0; i < argc; i++)
60       os << argv[i] << " ";
61     os << endl;
62   }
63
64   void flush_standard_streams ()
65   {
66     fflush (stderr);
67     fflush (stdout);
68     cerr << flush;
69     cout << flush;
70   }
71
72   int capture_start (int theFDStd, int theFDLog)
73   {
74     Standard_ASSERT_RETURN (theFDLog >= 0, "Invalid descriptor of log file", -1);
75
76     // Duplicate a file descriptor of the standard stream to be able to restore output to it later
77     int aFDSave = dup (theFDStd);
78     if (aFDSave < 0)
79     {
80       perror ("Error capturing standard stream to log: dup() returned");
81       return -1;
82     }
83
84     // Redirect the stream to the log file
85     if (dup2 (theFDLog, theFDStd) < 0)
86     {
87       close (aFDSave);
88       perror ("Error capturing standard stream to log: dup2() returned");
89       return -1;
90     }
91
92     // remember saved file descriptor of standard stream
93     return aFDSave;
94   }
95
96   void capture_end (int theFDStd, int& theFDSave)
97   {
98     if (theFDSave < 0)
99       return;
100
101     // restore normal descriptors of console stream
102     if (dup2(theFDSave, theFDStd) < 0)
103     {
104       perror ("Error returning capturing standard stream to log: dup2() returned");
105       return;
106     }
107
108     // close saved file descriptor
109     close(theFDSave);
110     theFDSave = -1;
111   }
112
113 } // anonymous namespace
114
115 // MKV 29.03.05
116 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 4))) && !defined(USE_NON_CONST)
117 static Standard_Integer CommandCmd 
118 (ClientData theClientData, Tcl_Interp *interp,
119  Standard_Integer argc, const char* argv[])
120 #else
121 static Standard_Integer CommandCmd 
122 (ClientData theClientData, Tcl_Interp *interp,
123  Standard_Integer argc, char* argv[])
124 #endif
125 {
126   static Standard_Integer code;
127   code = TCL_OK;
128   Draw_Interpretor::CallBackData* aCallback = (Draw_Interpretor::CallBackData* )theClientData;
129   Draw_Interpretor& di = *(aCallback->myDI);
130
131   // log command execution, except commands manipulating log itself and echo
132   Standard_Boolean isLogManipulation = (strcmp (argv[0], "dlog") == 0 || 
133                                         strcmp (argv[0], "decho") == 0);
134   Standard_Boolean doLog  = (di.GetDoLog() && ! isLogManipulation);
135   Standard_Boolean doEcho = (di.GetDoEcho() && ! isLogManipulation);
136
137   // flush cerr and cout
138   flush_standard_streams();
139
140   // capture cout and cerr to log
141   int aFDstdout = STDOUT_FILENO;
142   int aFDstderr = STDERR_FILENO;
143   int aFDerr_save = -1;
144   int aFDout_save = -1;
145   if (doLog)
146   {
147     aFDout_save = capture_start (aFDstdout, di.GetLogFileDescriptor());
148     aFDerr_save = capture_start (aFDstderr, di.GetLogFileDescriptor());
149   }
150
151   if (doEcho || doLog)
152     dumpArgs (cout, argc, argv);
153
154   // run command
155   try {
156     OCC_CATCH_SIGNALS
157
158     // get exception if control-break has been pressed 
159     OSD::ControlBreak();
160
161     // OCC680: Transfer UTF-8 directly to OCC commands without locale usage
162       
163     Standard_Integer fres = aCallback->Invoke ( di, argc, argv /*anArgs.GetArgv()*/ );
164     if (fres != 0) 
165       code = TCL_ERROR;
166   }
167   catch (Standard_Failure const& anException) {
168     // fail if Draw_ExitOnCatch is set
169     // MKV 29.03.05
170 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 4))) && !defined(USE_NON_CONST)
171     const char*  cc = Tcl_GetVar(interp,
172                           "Draw_ExitOnCatch",TCL_GLOBAL_ONLY);
173 #else
174     char* const cc = Tcl_GetVar(interp,
175                           "Draw_ExitOnCatch",TCL_GLOBAL_ONLY);
176 #endif
177
178     cout << "An exception was caught " << anException << endl;
179
180     if (cc && Draw::Atoi(cc)) {
181 #ifdef _WIN32
182       Tcl_Exit(0);
183 #else      
184       Tcl_Eval(interp,"exit");
185 #endif
186     }
187
188     // get the error message
189     Standard_SStream ss;
190     ss << "** Exception ** " << anException << ends;
191     Tcl_SetResult(interp,(char*)(ss.str().c_str()),TCL_VOLATILE);
192     code = TCL_ERROR;
193   }
194
195   // log command result
196   if (doLog || doEcho)
197   {
198     const char* aResultStr = Tcl_GetStringResult (interp);
199     if (aResultStr != 0 && aResultStr[0] != '\0' )
200     {
201       std::cout << aResultStr << std::endl;
202     }
203   }
204
205   // flush streams
206   flush_standard_streams();
207
208   // end capturing cout and cerr 
209   if (doLog) 
210   {
211     capture_end (aFDstderr, aFDerr_save);
212     capture_end (aFDstdout, aFDout_save);
213   }
214
215   return code;
216 }
217
218 static void CommandDelete (ClientData theClientData)
219 {
220   Draw_Interpretor::CallBackData* aCallback = (Draw_Interpretor::CallBackData* )theClientData;
221   delete aCallback;
222 }
223
224 //=======================================================================
225 //function : Draw_Interpretor
226 //purpose  : 
227 //=======================================================================
228
229 Draw_Interpretor::Draw_Interpretor() :
230   isAllocated(Standard_False), myDoLog(Standard_False), myDoEcho(Standard_False), myFDLog(-1)
231 {
232 // The tcl interpreter is not created immediately as it is kept 
233 // by a global variable and created and deleted before the main().
234   myInterp  = NULL;
235 }
236
237 //=======================================================================
238 //function : Init
239 //purpose  : It is necessary to call this function
240 //=======================================================================
241
242 void Draw_Interpretor::Init()
243 {
244   if (isAllocated) 
245     Tcl_DeleteInterp(myInterp);
246   isAllocated=Standard_True;
247   myInterp=Tcl_CreateInterp();
248 }
249
250 //=======================================================================
251 //function : Draw_Interpretor
252 //purpose  : 
253 //=======================================================================
254
255 Draw_Interpretor::Draw_Interpretor(const Draw_PInterp& p) :
256   isAllocated(Standard_False),
257   myInterp(p),
258   myDoLog(Standard_False),
259   myDoEcho(Standard_False)
260 {
261 }
262
263 //=======================================================================
264 //function : add
265 //purpose  :
266 //=======================================================================
267 void Draw_Interpretor::add (const Standard_CString          theCommandName,
268                             const Standard_CString          theHelp,
269                             const Standard_CString          theFileName,
270                             Draw_Interpretor::CallBackData* theCallback,
271                             const Standard_CString          theGroup)
272 {
273   Standard_ASSERT_RAISE (myInterp != NULL, "Attempt to add command to Null interpretor");
274
275   Standard_PCharacter aName  = (Standard_PCharacter )theCommandName;
276   Standard_PCharacter aHelp  = (Standard_PCharacter )theHelp;
277   Standard_PCharacter aGroup = (Standard_PCharacter )theGroup;
278   Tcl_CreateCommand (myInterp, aName, CommandCmd, (ClientData )theCallback, CommandDelete);
279
280   // add the help
281   Tcl_SetVar2 (myInterp, "Draw_Helps",  aName,  aHelp, TCL_GLOBAL_ONLY);
282   Tcl_SetVar2 (myInterp, "Draw_Groups", aGroup, aName,
283                      TCL_GLOBAL_ONLY | TCL_APPEND_VALUE | TCL_LIST_ELEMENT);
284
285   // add path to source file (keep not more than two last subdirectories)
286   if (theFileName  == NULL
287    || *theFileName == '\0')
288   {
289     return;
290   }
291
292   OSD_Path aPath (theFileName);
293   Standard_Integer nbTrek = aPath.TrekLength();
294   for (Standard_Integer i = 2; i < nbTrek; ++i)
295   {
296     aPath.RemoveATrek (1);
297   }
298   aPath.SetDisk ("");
299   aPath.SetNode ("");
300   TCollection_AsciiString aSrcPath;
301   aPath.SystemName (aSrcPath);
302   if (aSrcPath.Value(1) == '/')
303     aSrcPath.Remove(1);
304   Tcl_SetVar2 (myInterp, "Draw_Files", aName, aSrcPath.ToCString(), TCL_GLOBAL_ONLY);
305 }
306
307 //=======================================================================
308 //function : Remove
309 //purpose  : 
310 //=======================================================================
311
312 Standard_Boolean Draw_Interpretor::Remove(Standard_CString const n)
313 {
314   Standard_PCharacter pN;
315   //
316   pN=(Standard_PCharacter)n;
317  
318   Standard_Integer result = Tcl_DeleteCommand(myInterp,pN);
319   return result == 0;
320 }
321
322 //=======================================================================
323 //function : Result
324 //purpose  : 
325 //=======================================================================
326
327 Standard_CString Draw_Interpretor::Result() const
328 {
329 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 5)))
330   return Tcl_GetStringResult(myInterp);
331 #else
332   return myInterp->result;
333 #endif
334 }
335
336 //=======================================================================
337 //function : Reset
338 //purpose  : 
339 //=======================================================================
340
341 void Draw_Interpretor::Reset()
342 {
343   Tcl_ResetResult(myInterp);
344 }
345
346 //=======================================================================
347 //function : Append
348 //purpose  : 
349 //=======================================================================
350
351 Draw_Interpretor& Draw_Interpretor::Append(const Standard_CString s)
352 {
353 #ifdef TCL_USES_UTF8
354   // Convert string to UTF-8 format for Tcl
355   Tcl_DString TclString;
356   Tcl_ExternalToUtfDString ( NULL, s, -1, &TclString );
357   Tcl_AppendResult ( myInterp, Tcl_DStringValue ( &TclString ), (Standard_CString)0 );
358   Tcl_DStringFree ( &TclString );
359 #else
360   Tcl_AppendResult(myInterp,s,(Standard_CString)0);
361 #endif
362   return *this;
363 }
364
365 //=======================================================================
366 //function : Append
367 //purpose  : 
368 //=======================================================================
369
370 Draw_Interpretor& Draw_Interpretor::Append(const TCollection_AsciiString& s)
371 {
372   return Append (s.ToCString());
373 }
374
375 //=======================================================================
376 //function : Append
377 //purpose  : 
378 //=======================================================================
379
380 Draw_Interpretor& Draw_Interpretor::Append(const TCollection_ExtendedString& theString)
381 {
382 #ifdef TCL_USES_UTF8
383   // Convert string to UTF-8 format for Tcl
384   char *str = new char[theString.LengthOfCString()+1];
385   theString.ToUTF8CString (str);
386   Tcl_AppendResult ( myInterp, str, (Standard_CString)0 );
387   delete[] str;
388 #else
389   // put as ascii string, replacing non-ascii characters by '?'
390   TCollection_AsciiString str (theString, '?');
391   Tcl_AppendResult(myInterp,str.ToCString(),(Standard_CString)0);
392 #endif
393   return *this;
394 }
395
396 //=======================================================================
397 //function : Append
398 //purpose  : 
399 //=======================================================================
400
401 Draw_Interpretor& Draw_Interpretor::Append(const Standard_Integer i)
402 {
403   char c[100];
404   Sprintf(c,"%d",i);
405   Tcl_AppendResult(myInterp,c,(Standard_CString)0);
406   return *this;
407 }
408
409 //=======================================================================
410 //function : Append
411 //purpose  : 
412 //=======================================================================
413
414 Draw_Interpretor& Draw_Interpretor::Append(const Standard_Real r)
415 {
416   char s[100];
417   Sprintf(s,"%.17g",r);
418   Tcl_AppendResult(myInterp,s,(Standard_CString)0);
419   return *this;
420 }
421
422 //=======================================================================
423 //function : Append
424 //purpose  : 
425 //=======================================================================
426
427 Draw_Interpretor& Draw_Interpretor::Append(const Standard_SStream& s)
428 {
429   return Append (s.str().c_str());
430 }
431
432 //=======================================================================
433 //function : AppendElement
434 //purpose  : 
435 //=======================================================================
436
437 void Draw_Interpretor::AppendElement(const Standard_CString s)
438 {
439 #ifdef TCL_USES_UTF8
440   // Convert string to UTF-8 format for Tcl
441   Tcl_DString TclString;
442   Tcl_ExternalToUtfDString ( NULL, s, -1, &TclString );
443   Tcl_AppendElement ( myInterp, Tcl_DStringValue ( &TclString ) );
444   Tcl_DStringFree ( &TclString );
445 #else
446 #ifdef IRIX
447   //AppendElement is declared as (Tcl_Interp *interp, char *string)
448   //on SGI 32
449   Tcl_AppendElement(myInterp,(char*) s);
450 #else
451   Tcl_AppendElement(myInterp, s);
452 #endif
453 #endif
454 }
455
456 //=======================================================================
457 //function : Eval
458 //purpose  : 
459 //=======================================================================
460
461 Standard_Integer Draw_Interpretor::Eval(const Standard_CString line)
462 {
463   return Tcl_Eval(myInterp,line);
464 }
465
466
467 //=======================================================================
468 //function : Eval
469 //purpose  : 
470 //=======================================================================
471
472 Standard_Integer Draw_Interpretor::RecordAndEval(const Standard_CString line,
473                                                  const Standard_Integer flags)
474 {
475   return Tcl_RecordAndEval(myInterp,line,flags);
476 }
477
478 //=======================================================================
479 //function : EvalFile
480 //purpose  : 
481 //=======================================================================
482
483 Standard_Integer Draw_Interpretor::EvalFile(const Standard_CString fname)
484 {
485   return Tcl_EvalFile(myInterp,fname);
486 }
487
488 //=======================================================================
489 //function : PrintHelp
490 //purpose  :
491 //=======================================================================
492
493 Standard_Integer Draw_Interpretor::PrintHelp (const Standard_CString theCommandName)
494 {
495   TCollection_AsciiString aCmd     = TCollection_AsciiString ("help ") + theCommandName;
496   Standard_PCharacter     aLinePtr = (Standard_PCharacter )aCmd.ToCString();
497   return Tcl_Eval (myInterp, aLinePtr);
498 }
499
500 //=======================================================================
501 //function :Complete
502 //purpose  : 
503 //=======================================================================
504
505 Standard_Boolean Draw_Interpretor::Complete(const Standard_CString line)
506 {
507   Standard_PCharacter pLine;
508   //
509   pLine=(Standard_PCharacter)line;
510   return Tcl_CommandComplete (pLine) != 0;
511 }
512
513 //=======================================================================
514 //function : Destroy
515 //purpose  : 
516 //=======================================================================
517
518 Draw_Interpretor::~Draw_Interpretor()
519 {
520   SetDoLog (Standard_False);
521   if (myFDLog >=0)
522   {
523     close (myFDLog);
524     myFDLog = 0;
525   }
526
527   // MKV 01.02.05
528 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 4)))
529   try {
530     OCC_CATCH_SIGNALS
531     Tcl_Exit(0);
532   }
533   catch (Standard_Failure) {
534 #ifdef OCCT_DEBUG
535     cout <<"Tcl_Exit have an exeption" << endl;
536 #endif
537   }
538 #else
539 #ifdef _WIN32
540   Tcl_Exit(0);
541 #endif  
542 #endif
543 }
544
545 //=======================================================================
546 //function : Interp
547 //purpose  : 
548 //=======================================================================
549
550 Draw_PInterp Draw_Interpretor::Interp() const
551 {
552   Standard_DomainError_Raise_if (myInterp==NULL , "No call for  Draw_Interpretor::Init()");
553   return myInterp;
554 }
555
556 void Draw_Interpretor::Set(const Draw_PInterp& PIntrp)
557 {
558   if (isAllocated)
559     Tcl_DeleteInterp(myInterp);
560   isAllocated = Standard_False;
561   myInterp = PIntrp;
562 }
563
564 //=======================================================================
565 //function : Logging
566 //purpose  : 
567 //=======================================================================
568
569 void Draw_Interpretor::SetDoLog (Standard_Boolean doLog)
570 {
571   if (myDoLog == doLog)
572     return;
573
574   // create log file if not opened yet
575   if (doLog && myFDLog < 0)
576   {
577 #ifdef _WIN32
578     char tmpfile[L_tmpnam + 1];
579     tmpnam(tmpfile);
580     myFDLog = open (tmpfile, O_RDWR | O_CREAT | O_EXCL | O_TEMPORARY, S_IREAD | S_IWRITE);
581 #else
582     // according to Linux Filesystem Hierarchy Standard, 3.17,
583     // /tmp/ is the right directory for temporary files
584     char tmpfile[256] = "/tmp/occt_draw_XXXXXX";
585     myFDLog = mkstemp (tmpfile);
586     if (myFDLog >= 0)
587     {
588 //      printf ("Tmp file: %s\n", tmpfile);
589       unlink (tmpfile); // make sure the file will be deleted on close
590     }
591 #endif
592     if (myFDLog < 0)
593     {
594       perror ("Error creating temporary file for capturing console output");
595       printf ("path: %s\n", tmpfile);
596       return;
597     }
598   }
599
600   myDoLog = doLog;
601 }
602
603 void Draw_Interpretor::SetDoEcho (Standard_Boolean doEcho)
604 {
605   myDoEcho = doEcho;
606 }
607
608 Standard_Boolean Draw_Interpretor::GetDoLog () const
609 {
610   return myDoLog;
611 }
612
613 Standard_Boolean Draw_Interpretor::GetDoEcho () const
614 {
615   return myDoEcho;
616 }
617
618 void Draw_Interpretor::ResetLog ()
619 {
620   if (myFDLog < 0)
621     return;
622
623   // flush cerr and cout, for the case if they are bound to the log
624   flush_standard_streams();
625
626   lseek (myFDLog, 0, SEEK_SET);
627
628 #ifdef _WIN32
629   if (_chsize_s (myFDLog, 0) != 0)
630 #else
631   if (ftruncate (myFDLog, 0) != 0)
632 #endif
633   {
634     perror ("Error truncating the console log");
635   }
636 }
637
638 void Draw_Interpretor::AddLog (const Standard_CString theStr)
639 {
640   if (myFDLog < 0 || ! theStr || ! theStr[0])
641     return;
642
643   // flush cerr and cout, for the case if they are bound to the log
644   flush_standard_streams();
645
646   // write as plain bytes
647   if (write (myFDLog, theStr, (unsigned int)strlen(theStr)) <0)
648   {
649     perror ("Error writing to console log");
650   }
651 }
652
653 TCollection_AsciiString Draw_Interpretor::GetLog ()
654 {
655   TCollection_AsciiString aLog;
656   if (myFDLog < 0)
657     return aLog;
658
659   // flush cerr and cout
660   flush_standard_streams();
661
662   // rewind the file to its start
663   lseek (myFDLog, 0, SEEK_SET);
664
665   // read the whole log to string; this implementation
666   // is not optimized but should be sufficient
667   const int BUFSIZE = 4096;
668   char buffer[BUFSIZE + 1];
669   for (;;)
670   {
671     int nbRead = read (myFDLog, buffer, BUFSIZE);
672     if (nbRead <= 0)
673     {
674       break;
675     }
676     buffer[nbRead] = '\0';
677     aLog.AssignCat (buffer);
678   }
679
680   return aLog;
681 }