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