0028673: getsourcefile Draw command return different output on Linux and 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 #ifndef _WIN32
34 #include <unistd.h>
35 #endif
36
37 // for capturing of cout and cerr (dup(), dup2())
38 #ifdef _WIN32
39 #include <io.h>
40 #endif
41
42 #if ! defined(STDOUT_FILENO)
43 #define STDOUT_FILENO fileno(stdout)
44 #endif
45 #if ! defined(STDERR_FILENO)
46 #define STDERR_FILENO fileno(stderr)
47 #endif
48
49 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 1)))
50 #define TCL_USES_UTF8
51 #endif
52
53 // logging helpers
54 namespace {
55   void dumpArgs (Standard_OStream& os, int argc, const char *argv[])
56   {
57     for (int i=0; i < argc; i++)
58       os << argv[i] << " ";
59     os << endl;
60   }
61
62   void flush_standard_streams ()
63   {
64     fflush (stderr);
65     fflush (stdout);
66     cerr << flush;
67     cout << flush;
68   }
69
70   int capture_start (OSD_File& theTmpFile, int std_fd)
71   {
72     theTmpFile.BuildTemporary();
73     if (theTmpFile.Failed())
74     {
75       cerr << "Error: cannot create temporary file for capturing console output" << endl;
76       return -1;
77     }
78
79     // remember current file descriptors of standard stream, and replace it by temporary
80     return theTmpFile.Capture(std_fd);
81   }
82
83   void capture_end (OSD_File* tmp_file, int std_fd, int save_fd, Standard_OStream &log, Standard_Boolean doEcho)
84   {
85     if (!tmp_file)
86       return;
87
88     // restore normal descriptors of console stream
89   #ifdef _WIN32
90     _dup2(save_fd, std_fd);
91     _close(save_fd);
92   #else
93     dup2(save_fd, std_fd);
94     close(save_fd);
95   #endif
96
97     // extract all output and copy it to log and optionally to cout
98     const int BUFSIZE = 2048;
99     TCollection_AsciiString buf;
100     tmp_file->Rewind();
101     while (tmp_file->ReadLine (buf, BUFSIZE) > 0)
102     {
103       log << buf;
104       if (doEcho) 
105         cout << buf;
106     }
107
108     // close temporary file
109     tmp_file->Close();
110
111     // remove temporary file if this is not done by the system
112     if (tmp_file->Exists())
113       tmp_file->Remove();
114   }
115
116 } // anonymous namespace
117
118 // MKV 29.03.05
119 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 4))) && !defined(USE_NON_CONST)
120 static Standard_Integer CommandCmd 
121 (ClientData theClientData, Tcl_Interp *interp,
122  Standard_Integer argc, const char* argv[])
123 #else
124 static Standard_Integer CommandCmd 
125 (ClientData theClientData, Tcl_Interp *interp,
126  Standard_Integer argc, char* argv[])
127 #endif
128 {
129   static Standard_Integer code;
130   code = TCL_OK;
131   Draw_Interpretor::CallBackData* aCallback = (Draw_Interpretor::CallBackData* )theClientData;
132   Draw_Interpretor& di = *(aCallback->myDI);
133
134   // log command execution, except commands manipulating log itself and echo
135   Standard_Boolean isLogManipulation = (strcmp (argv[0], "dlog") == 0 || 
136                                         strcmp (argv[0], "decho") == 0);
137   Standard_Boolean doLog  = (di.GetDoLog() && ! isLogManipulation);
138   Standard_Boolean doEcho = (di.GetDoEcho() && ! isLogManipulation);
139   if (doLog)
140     dumpArgs (di.Log(), argc, argv);
141   if (doEcho)
142     dumpArgs (cout, argc, argv);
143
144   // flush cerr and cout
145   flush_standard_streams();
146
147   // capture cout and cerr to log
148   OSD_File aFile_out, aFile_err;
149   int fd_err_save = -1;
150   int fd_out_save = -1;
151   if (doLog)
152   {
153     fd_out_save = capture_start (aFile_out, STDOUT_FILENO);
154     fd_err_save = capture_start (aFile_err, STDERR_FILENO);
155   }
156
157   // run command
158   try {
159     OCC_CATCH_SIGNALS
160
161     // get exception if control-break has been pressed 
162     OSD::ControlBreak();
163
164     // OCC680: Transfer UTF-8 directly to OCC commands without locale usage
165       
166     Standard_Integer fres = aCallback->Invoke ( di, argc, argv /*anArgs.GetArgv()*/ );
167     if (fres != 0) 
168       code = TCL_ERROR;
169   }
170   catch (Standard_Failure const& anException) {
171     // fail if Draw_ExitOnCatch is set
172     // MKV 29.03.05
173 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 4))) && !defined(USE_NON_CONST)
174     const char*  cc = Tcl_GetVar(interp,
175                           "Draw_ExitOnCatch",TCL_GLOBAL_ONLY);
176 #else
177     char* const cc = Tcl_GetVar(interp,
178                           "Draw_ExitOnCatch",TCL_GLOBAL_ONLY);
179 #endif
180
181     cout << "An exception was caught " << anException << endl;
182
183     if (cc && Draw::Atoi(cc)) {
184 #ifdef _WIN32
185       Tcl_Exit(0);
186 #else      
187       Tcl_Eval(interp,"exit");
188 #endif
189     }
190
191     // get the error message
192     Standard_SStream ss;
193     ss << "** Exception ** " << anException << ends;
194     Tcl_SetResult(interp,(char*)(ss.str().c_str()),TCL_VOLATILE);
195     code = TCL_ERROR;
196   }
197
198   // flush streams
199   flush_standard_streams();
200
201   // end capturing cout and cerr 
202   if (doLog) 
203   {
204     capture_end (&aFile_err, STDERR_FILENO, fd_err_save, di.Log(), doEcho);
205     capture_end (&aFile_out, STDOUT_FILENO, fd_out_save, di.Log(), doEcho);
206   }
207
208   // log command result
209   const char* aResultStr = NULL;
210   if (doLog)
211   {
212     aResultStr = Tcl_GetStringResult (interp);
213     if (aResultStr != 0 && aResultStr[0] != '\0' )
214       di.Log() << Tcl_GetStringResult (interp) << endl;
215   }
216   if (doEcho)
217   {
218     if (aResultStr == NULL)
219       aResultStr = Tcl_GetStringResult (interp);
220     if (aResultStr != 0 && aResultStr[0] != '\0' )
221       cout << Tcl_GetStringResult (interp) << endl;
222   }
223
224   return code;
225 }
226
227 static void CommandDelete (ClientData theClientData)
228 {
229   Draw_Interpretor::CallBackData* aCallback = (Draw_Interpretor::CallBackData* )theClientData;
230   delete aCallback;
231 }
232
233 //=======================================================================
234 //function : Draw_Interpretor
235 //purpose  : 
236 //=======================================================================
237
238 Draw_Interpretor::Draw_Interpretor() :
239   isAllocated(Standard_False), myDoLog(Standard_False), myDoEcho(Standard_False)
240 {
241 // The tcl interpreter is not created immediately as it is kept 
242 // by a global variable and created and deleted before the main().
243   myInterp  = NULL;
244 }
245
246 //=======================================================================
247 //function : Init
248 //purpose  : It is necessary to call this function
249 //=======================================================================
250
251 void Draw_Interpretor::Init()
252 {
253   if (isAllocated) 
254     Tcl_DeleteInterp(myInterp);
255   isAllocated=Standard_True;
256   myInterp=Tcl_CreateInterp();
257 }
258
259 //=======================================================================
260 //function : Draw_Interpretor
261 //purpose  : 
262 //=======================================================================
263
264 Draw_Interpretor::Draw_Interpretor(const Draw_PInterp& p) :
265   isAllocated(Standard_False),
266   myInterp(p),
267   myDoLog(Standard_False),
268   myDoEcho(Standard_False)
269 {
270 }
271
272 //=======================================================================
273 //function : add
274 //purpose  :
275 //=======================================================================
276 void Draw_Interpretor::add (const Standard_CString          theCommandName,
277                             const Standard_CString          theHelp,
278                             const Standard_CString          theFileName,
279                             Draw_Interpretor::CallBackData* theCallback,
280                             const Standard_CString          theGroup)
281 {
282   if (myInterp == NULL)
283   {
284     Init();
285   }
286
287   Standard_PCharacter aName  = (Standard_PCharacter )theCommandName;
288   Standard_PCharacter aHelp  = (Standard_PCharacter )theHelp;
289   Standard_PCharacter aGroup = (Standard_PCharacter )theGroup;
290   Tcl_CreateCommand (myInterp, aName, CommandCmd, (ClientData )theCallback, CommandDelete);
291
292   // add the help
293   Tcl_SetVar2 (myInterp, "Draw_Helps",  aName,  aHelp, TCL_GLOBAL_ONLY);
294   Tcl_SetVar2 (myInterp, "Draw_Groups", aGroup, aName,
295                      TCL_GLOBAL_ONLY | TCL_APPEND_VALUE | TCL_LIST_ELEMENT);
296
297   // add path to source file (keep not more than two last subdirectories)
298   if (theFileName  == NULL
299    || *theFileName == '\0')
300   {
301     return;
302   }
303
304   OSD_Path aPath (theFileName);
305   Standard_Integer nbTrek = aPath.TrekLength();
306   for (Standard_Integer i = 2; i < nbTrek; ++i)
307   {
308     aPath.RemoveATrek (1);
309   }
310   aPath.SetDisk ("");
311   aPath.SetNode ("");
312   TCollection_AsciiString aSrcPath;
313   aPath.SystemName (aSrcPath);
314   if (aSrcPath.Value(1) == '/')
315     aSrcPath.Remove(1);
316   Tcl_SetVar2 (myInterp, "Draw_Files", aName, aSrcPath.ToCString(), TCL_GLOBAL_ONLY);
317 }
318
319 //=======================================================================
320 //function : Remove
321 //purpose  : 
322 //=======================================================================
323
324 Standard_Boolean Draw_Interpretor::Remove(Standard_CString const n)
325 {
326   Standard_PCharacter pN;
327   //
328   pN=(Standard_PCharacter)n;
329  
330   Standard_Integer result = Tcl_DeleteCommand(myInterp,pN);
331   return result == 0;
332 }
333
334 //=======================================================================
335 //function : Result
336 //purpose  : 
337 //=======================================================================
338
339 Standard_CString Draw_Interpretor::Result() const
340 {
341 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 5)))
342   return Tcl_GetStringResult(myInterp);
343 #else
344   return myInterp->result;
345 #endif
346 }
347
348 //=======================================================================
349 //function : Reset
350 //purpose  : 
351 //=======================================================================
352
353 void Draw_Interpretor::Reset()
354 {
355   Tcl_ResetResult(myInterp);
356 }
357
358 //=======================================================================
359 //function : Append
360 //purpose  : 
361 //=======================================================================
362
363 Draw_Interpretor& Draw_Interpretor::Append(const Standard_CString s)
364 {
365 #ifdef TCL_USES_UTF8
366   // Convert string to UTF-8 format for Tcl
367   Tcl_DString TclString;
368   Tcl_ExternalToUtfDString ( NULL, s, -1, &TclString );
369   Tcl_AppendResult ( myInterp, Tcl_DStringValue ( &TclString ), (Standard_CString)0 );
370   Tcl_DStringFree ( &TclString );
371 #else
372   Tcl_AppendResult(myInterp,s,(Standard_CString)0);
373 #endif
374   return *this;
375 }
376
377 //=======================================================================
378 //function : Append
379 //purpose  : 
380 //=======================================================================
381
382 Draw_Interpretor& Draw_Interpretor::Append(const TCollection_AsciiString& s)
383 {
384   return Append (s.ToCString());
385 }
386
387 //=======================================================================
388 //function : Append
389 //purpose  : 
390 //=======================================================================
391
392 Draw_Interpretor& Draw_Interpretor::Append(const TCollection_ExtendedString& theString)
393 {
394 #ifdef TCL_USES_UTF8
395   // Convert string to UTF-8 format for Tcl
396   char *str = new char[theString.LengthOfCString()+1];
397   theString.ToUTF8CString (str);
398   Tcl_AppendResult ( myInterp, str, (Standard_CString)0 );
399   delete[] str;
400 #else
401   // put as ascii string, replacing non-ascii characters by '?'
402   TCollection_AsciiString str (theString, '?');
403   Tcl_AppendResult(myInterp,str.ToCString(),(Standard_CString)0);
404 #endif
405   return *this;
406 }
407
408 //=======================================================================
409 //function : Append
410 //purpose  : 
411 //=======================================================================
412
413 Draw_Interpretor& Draw_Interpretor::Append(const Standard_Integer i)
414 {
415   char c[100];
416   Sprintf(c,"%d",i);
417   Tcl_AppendResult(myInterp,c,(Standard_CString)0);
418   return *this;
419 }
420
421 //=======================================================================
422 //function : Append
423 //purpose  : 
424 //=======================================================================
425
426 Draw_Interpretor& Draw_Interpretor::Append(const Standard_Real r)
427 {
428   char s[100];
429   Sprintf(s,"%.17g",r);
430   Tcl_AppendResult(myInterp,s,(Standard_CString)0);
431   return *this;
432 }
433
434 //=======================================================================
435 //function : Append
436 //purpose  : 
437 //=======================================================================
438
439 Draw_Interpretor& Draw_Interpretor::Append(const Standard_SStream& s)
440 {
441   return Append (s.str().c_str());
442 }
443
444 //=======================================================================
445 //function : AppendElement
446 //purpose  : 
447 //=======================================================================
448
449 void Draw_Interpretor::AppendElement(const Standard_CString s)
450 {
451 #ifdef TCL_USES_UTF8
452   // Convert string to UTF-8 format for Tcl
453   Tcl_DString TclString;
454   Tcl_ExternalToUtfDString ( NULL, s, -1, &TclString );
455   Tcl_AppendElement ( myInterp, Tcl_DStringValue ( &TclString ) );
456   Tcl_DStringFree ( &TclString );
457 #else
458 #ifdef IRIX
459   //AppendElement is declared as (Tcl_Interp *interp, char *string)
460   //on SGI 32
461   Tcl_AppendElement(myInterp,(char*) s);
462 #else
463   Tcl_AppendElement(myInterp, s);
464 #endif
465 #endif
466 }
467
468 //=======================================================================
469 //function : Eval
470 //purpose  : 
471 //=======================================================================
472
473 Standard_Integer Draw_Interpretor::Eval(const Standard_CString line)
474 {
475   return Tcl_Eval(myInterp,line);
476 }
477
478
479 //=======================================================================
480 //function : Eval
481 //purpose  : 
482 //=======================================================================
483
484 Standard_Integer Draw_Interpretor::RecordAndEval(const Standard_CString line,
485                                                  const Standard_Integer flags)
486 {
487   return Tcl_RecordAndEval(myInterp,line,flags);
488 }
489
490 //=======================================================================
491 //function : EvalFile
492 //purpose  : 
493 //=======================================================================
494
495 Standard_Integer Draw_Interpretor::EvalFile(const Standard_CString fname)
496 {
497   return Tcl_EvalFile(myInterp,fname);
498 }
499
500 //=======================================================================
501 //function : PrintHelp
502 //purpose  :
503 //=======================================================================
504
505 Standard_Integer Draw_Interpretor::PrintHelp (const Standard_CString theCommandName)
506 {
507   TCollection_AsciiString aCmd     = TCollection_AsciiString ("help ") + theCommandName;
508   Standard_PCharacter     aLinePtr = (Standard_PCharacter )aCmd.ToCString();
509   return Tcl_Eval (myInterp, aLinePtr);
510 }
511
512 //=======================================================================
513 //function :Complete
514 //purpose  : 
515 //=======================================================================
516
517 Standard_Boolean Draw_Interpretor::Complete(const Standard_CString line)
518 {
519   Standard_PCharacter pLine;
520   //
521   pLine=(Standard_PCharacter)line;
522   return Tcl_CommandComplete (pLine) != 0;
523 }
524
525 //=======================================================================
526 //function : Destroy
527 //purpose  : 
528 //=======================================================================
529
530 Draw_Interpretor::~Draw_Interpretor()
531 {
532   // MKV 01.02.05
533 #if ((TCL_MAJOR_VERSION > 8) || ((TCL_MAJOR_VERSION == 8) && (TCL_MINOR_VERSION >= 4)))
534   try {
535     OCC_CATCH_SIGNALS
536     Tcl_Exit(0);
537   }
538   catch (Standard_Failure) {
539 #ifdef OCCT_DEBUG
540     cout <<"Tcl_Exit have an exeption" << endl;
541 #endif
542   }
543 #else
544 #ifdef _WIN32
545   Tcl_Exit(0);
546 #endif  
547 #endif
548 }
549
550 //=======================================================================
551 //function : Interp
552 //purpose  : 
553 //=======================================================================
554
555 Draw_PInterp Draw_Interpretor::Interp() const
556 {
557   Standard_DomainError_Raise_if (myInterp==NULL , "No call for  Draw_Interpretor::Init()");
558   return myInterp;
559 }
560
561 void Draw_Interpretor::Set(const Draw_PInterp& PIntrp)
562 {
563   if (isAllocated)
564     Tcl_DeleteInterp(myInterp);
565   isAllocated = Standard_False;
566   myInterp = PIntrp;
567 }
568
569 //=======================================================================
570 //function : Logging
571 //purpose  : 
572 //=======================================================================
573
574 void Draw_Interpretor::SetDoLog (Standard_Boolean doLog)
575 {
576   myDoLog = doLog;
577 }
578
579 void Draw_Interpretor::SetDoEcho (Standard_Boolean doEcho)
580 {
581   myDoEcho = doEcho;
582 }
583
584 Standard_Boolean Draw_Interpretor::GetDoLog () const
585 {
586   return myDoLog;
587 }
588
589 Standard_Boolean Draw_Interpretor::GetDoEcho () const
590 {
591   return myDoEcho;
592 }
593
594 Standard_SStream& Draw_Interpretor::Log ()
595 {
596   return myLog;
597 }