Revert reentrancy patch (#1573619)
[wxWidgets.git] / src / common / appbase.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/appbase.cpp
3 // Purpose: implements wxAppConsole class
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 19.06.2003 (extracted from common/appcmn.cpp)
7 // RCS-ID: $Id$
8 // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9 // License: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #ifndef WX_PRECOMP
28 #ifdef __WXMSW__
29 #include "wx/msw/wrapwin.h" // includes windows.h for MessageBox()
30 #endif
31 #include "wx/list.h"
32 #include "wx/app.h"
33 #include "wx/intl.h"
34 #include "wx/log.h"
35 #include "wx/utils.h"
36 #endif //WX_PRECOMP
37
38 #include "wx/apptrait.h"
39 #include "wx/cmdline.h"
40 #include "wx/confbase.h"
41 #include "wx/filename.h"
42 #include "wx/msgout.h"
43 #include "wx/tokenzr.h"
44
45 #if !defined(__WXMSW__) || defined(__WXMICROWIN__)
46 #include <signal.h> // for SIGTRAP used by wxTrap()
47 #endif //Win/Unix
48
49 #if wxUSE_FONTMAP
50 #include "wx/fontmap.h"
51 #endif // wxUSE_FONTMAP
52
53 #if defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
54 // For MacTypes.h for Debugger function
55 #include <CoreFoundation/CFBase.h>
56 #endif
57
58 #if defined(__WXMAC__)
59 #ifdef __DARWIN__
60 #include <CoreServices/CoreServices.h>
61 #else
62 #include "wx/mac/private.h" // includes mac headers
63 #endif
64 #endif // __WXMAC__
65
66 #ifdef __WXDEBUG__
67 #if wxUSE_STACKWALKER
68 #include "wx/stackwalk.h"
69 #ifdef __WXMSW__
70 #include "wx/msw/debughlp.h"
71 #endif
72 #endif // wxUSE_STACKWALKER
73 #endif // __WXDEBUG__
74
75 // wxABI_VERSION can be defined when compiling applications but it should be
76 // left undefined when compiling the library itself, it is then set to its
77 // default value in version.h
78 #if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99
79 #error "wxABI_VERSION should not be defined when compiling the library"
80 #endif
81
82 // ----------------------------------------------------------------------------
83 // private functions prototypes
84 // ----------------------------------------------------------------------------
85
86 #ifdef __WXDEBUG__
87 // really just show the assert dialog
88 static bool DoShowAssertDialog(const wxString& msg);
89
90 // prepare for showing the assert dialog, use the given traits or
91 // DoShowAssertDialog() as last fallback to really show it
92 static
93 void ShowAssertDialog(const wxChar *szFile,
94 int nLine,
95 const wxChar *szFunc,
96 const wxChar *szCond,
97 const wxChar *szMsg,
98 wxAppTraits *traits = NULL);
99
100 // turn on the trace masks specified in the env variable WXTRACE
101 static void LINKAGEMODE SetTraceMasks();
102 #endif // __WXDEBUG__
103
104 // ----------------------------------------------------------------------------
105 // global vars
106 // ----------------------------------------------------------------------------
107
108 wxAppConsole *wxAppConsole::ms_appInstance = NULL;
109
110 wxAppInitializerFunction wxAppConsole::ms_appInitFn = NULL;
111
112 // ============================================================================
113 // wxAppConsole implementation
114 // ============================================================================
115
116 // ----------------------------------------------------------------------------
117 // ctor/dtor
118 // ----------------------------------------------------------------------------
119
120 wxAppConsole::wxAppConsole()
121 {
122 m_traits = NULL;
123
124 ms_appInstance = this;
125
126 #ifdef __WXDEBUG__
127 SetTraceMasks();
128 #if wxUSE_UNICODE
129 // In unicode mode the SetTraceMasks call can cause an apptraits to be
130 // created, but since we are still in the constructor the wrong kind will
131 // be created for GUI apps. Destroy it so it can be created again later.
132 delete m_traits;
133 m_traits = NULL;
134 #endif
135 #endif
136 }
137
138 wxAppConsole::~wxAppConsole()
139 {
140 delete m_traits;
141 }
142
143 // ----------------------------------------------------------------------------
144 // initilization/cleanup
145 // ----------------------------------------------------------------------------
146
147 bool wxAppConsole::Initialize(int& argcOrig, wxChar **argvOrig)
148 {
149 // remember the command line arguments
150 argc = argcOrig;
151 argv = argvOrig;
152
153 #ifndef __WXPALMOS__
154 if ( m_appName.empty() && argv )
155 {
156 // the application name is, by default, the name of its executable file
157 wxFileName::SplitPath(argv[0], NULL, &m_appName, NULL);
158 }
159 #endif
160
161 return true;
162 }
163
164 void wxAppConsole::CleanUp()
165 {
166 }
167
168 // ----------------------------------------------------------------------------
169 // OnXXX() callbacks
170 // ----------------------------------------------------------------------------
171
172 bool wxAppConsole::OnInit()
173 {
174 #if wxUSE_CMDLINE_PARSER
175 wxCmdLineParser parser(argc, argv);
176
177 OnInitCmdLine(parser);
178
179 bool cont;
180 switch ( parser.Parse(false /* don't show usage */) )
181 {
182 case -1:
183 cont = OnCmdLineHelp(parser);
184 break;
185
186 case 0:
187 cont = OnCmdLineParsed(parser);
188 break;
189
190 default:
191 cont = OnCmdLineError(parser);
192 break;
193 }
194
195 if ( !cont )
196 return false;
197 #endif // wxUSE_CMDLINE_PARSER
198
199 return true;
200 }
201
202 int wxAppConsole::OnExit()
203 {
204 #if wxUSE_CONFIG
205 // delete the config object if any (don't use Get() here, but Set()
206 // because Get() could create a new config object)
207 delete wxConfigBase::Set((wxConfigBase *) NULL);
208 #endif // wxUSE_CONFIG
209
210 return 0;
211 }
212
213 void wxAppConsole::Exit()
214 {
215 exit(-1);
216 }
217
218 // ----------------------------------------------------------------------------
219 // traits stuff
220 // ----------------------------------------------------------------------------
221
222 wxAppTraits *wxAppConsole::CreateTraits()
223 {
224 return new wxConsoleAppTraits;
225 }
226
227 wxAppTraits *wxAppConsole::GetTraits()
228 {
229 // FIXME-MT: protect this with a CS?
230 if ( !m_traits )
231 {
232 m_traits = CreateTraits();
233
234 wxASSERT_MSG( m_traits, _T("wxApp::CreateTraits() failed?") );
235 }
236
237 return m_traits;
238 }
239
240 // we must implement CreateXXX() in wxApp itself for backwards compatibility
241 #if WXWIN_COMPATIBILITY_2_4
242
243 #if wxUSE_LOG
244
245 wxLog *wxAppConsole::CreateLogTarget()
246 {
247 wxAppTraits *traits = GetTraits();
248 return traits ? traits->CreateLogTarget() : NULL;
249 }
250
251 #endif // wxUSE_LOG
252
253 wxMessageOutput *wxAppConsole::CreateMessageOutput()
254 {
255 wxAppTraits *traits = GetTraits();
256 return traits ? traits->CreateMessageOutput() : NULL;
257 }
258
259 #endif // WXWIN_COMPATIBILITY_2_4
260
261 // ----------------------------------------------------------------------------
262 // event processing
263 // ----------------------------------------------------------------------------
264
265 void wxAppConsole::ProcessPendingEvents()
266 {
267 #if wxUSE_THREADS
268 if ( !wxPendingEventsLocker )
269 return;
270 #endif
271
272 // ensure that we're the only thread to modify the pending events list
273 wxENTER_CRIT_SECT( *wxPendingEventsLocker );
274
275 if ( !wxPendingEvents )
276 {
277 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
278 return;
279 }
280
281 // iterate until the list becomes empty
282 wxList::compatibility_iterator node = wxPendingEvents->GetFirst();
283 while (node)
284 {
285 wxEvtHandler *handler = (wxEvtHandler *)node->GetData();
286 wxPendingEvents->Erase(node);
287
288 // In ProcessPendingEvents(), new handlers might be add
289 // and we can safely leave the critical section here.
290 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
291
292 handler->ProcessPendingEvents();
293
294 wxENTER_CRIT_SECT( *wxPendingEventsLocker );
295
296 node = wxPendingEvents->GetFirst();
297 }
298
299 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
300 }
301
302 int wxAppConsole::FilterEvent(wxEvent& WXUNUSED(event))
303 {
304 // process the events normally by default
305 return -1;
306 }
307
308 // ----------------------------------------------------------------------------
309 // exception handling
310 // ----------------------------------------------------------------------------
311
312 #if wxUSE_EXCEPTIONS
313
314 void
315 wxAppConsole::HandleEvent(wxEvtHandler *handler,
316 wxEventFunction func,
317 wxEvent& event) const
318 {
319 // by default, simply call the handler
320 (handler->*func)(event);
321 }
322
323 #endif // wxUSE_EXCEPTIONS
324
325 // ----------------------------------------------------------------------------
326 // cmd line parsing
327 // ----------------------------------------------------------------------------
328
329 #if wxUSE_CMDLINE_PARSER
330
331 #define OPTION_VERBOSE _T("verbose")
332
333 void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser)
334 {
335 // the standard command line options
336 static const wxCmdLineEntryDesc cmdLineDesc[] =
337 {
338 {
339 wxCMD_LINE_SWITCH,
340 _T("h"),
341 _T("help"),
342 gettext_noop("show this help message"),
343 wxCMD_LINE_VAL_NONE,
344 wxCMD_LINE_OPTION_HELP
345 },
346
347 #if wxUSE_LOG
348 {
349 wxCMD_LINE_SWITCH,
350 wxEmptyString,
351 OPTION_VERBOSE,
352 gettext_noop("generate verbose log messages"),
353 wxCMD_LINE_VAL_NONE,
354 0x0
355 },
356 #endif // wxUSE_LOG
357
358 // terminator
359 {
360 wxCMD_LINE_NONE,
361 wxEmptyString,
362 wxEmptyString,
363 wxEmptyString,
364 wxCMD_LINE_VAL_NONE,
365 0x0
366 }
367 };
368
369 parser.SetDesc(cmdLineDesc);
370 }
371
372 bool wxAppConsole::OnCmdLineParsed(wxCmdLineParser& parser)
373 {
374 #if wxUSE_LOG
375 if ( parser.Found(OPTION_VERBOSE) )
376 {
377 wxLog::SetVerbose(true);
378 }
379 #else
380 wxUnusedVar(parser);
381 #endif // wxUSE_LOG
382
383 return true;
384 }
385
386 bool wxAppConsole::OnCmdLineHelp(wxCmdLineParser& parser)
387 {
388 parser.Usage();
389
390 return false;
391 }
392
393 bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser)
394 {
395 parser.Usage();
396
397 return false;
398 }
399
400 #endif // wxUSE_CMDLINE_PARSER
401
402 // ----------------------------------------------------------------------------
403 // debugging support
404 // ----------------------------------------------------------------------------
405
406 /* static */
407 bool wxAppConsole::CheckBuildOptions(const char *optionsSignature,
408 const char *componentName)
409 {
410 #if 0 // can't use wxLogTrace, not up and running yet
411 printf("checking build options object '%s' (ptr %p) in '%s'\n",
412 optionsSignature, optionsSignature, componentName);
413 #endif
414
415 if ( strcmp(optionsSignature, WX_BUILD_OPTIONS_SIGNATURE) != 0 )
416 {
417 wxString lib = wxString::FromAscii(WX_BUILD_OPTIONS_SIGNATURE);
418 wxString prog = wxString::FromAscii(optionsSignature);
419 wxString progName = wxString::FromAscii(componentName);
420 wxString msg;
421
422 msg.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %s,\nand %s used %s."),
423 lib.c_str(), progName.c_str(), prog.c_str());
424
425 wxLogFatalError(msg.c_str());
426
427 // normally wxLogFatalError doesn't return
428 return false;
429 }
430 #undef wxCMP
431
432 return true;
433 }
434
435 #ifdef __WXDEBUG__
436
437 void wxAppConsole::OnAssertFailure(const wxChar *file,
438 int line,
439 const wxChar *func,
440 const wxChar *cond,
441 const wxChar *msg)
442 {
443 ShowAssertDialog(file, line, func, cond, msg, GetTraits());
444 }
445
446 void wxAppConsole::OnAssert(const wxChar *file,
447 int line,
448 const wxChar *cond,
449 const wxChar *msg)
450 {
451 OnAssertFailure(file, line, NULL, cond, msg);
452 }
453
454 #endif // __WXDEBUG__
455
456 #if WXWIN_COMPATIBILITY_2_4
457
458 bool wxAppConsole::CheckBuildOptions(const wxBuildOptions& buildOptions)
459 {
460 return CheckBuildOptions(buildOptions.m_signature, "your program");
461 }
462
463 #endif
464
465 // ============================================================================
466 // other classes implementations
467 // ============================================================================
468
469 // ----------------------------------------------------------------------------
470 // wxConsoleAppTraitsBase
471 // ----------------------------------------------------------------------------
472
473 #if wxUSE_LOG
474
475 wxLog *wxConsoleAppTraitsBase::CreateLogTarget()
476 {
477 return new wxLogStderr;
478 }
479
480 #endif // wxUSE_LOG
481
482 wxMessageOutput *wxConsoleAppTraitsBase::CreateMessageOutput()
483 {
484 return new wxMessageOutputStderr;
485 }
486
487 #if wxUSE_FONTMAP
488
489 wxFontMapper *wxConsoleAppTraitsBase::CreateFontMapper()
490 {
491 return (wxFontMapper *)new wxFontMapperBase;
492 }
493
494 #endif // wxUSE_FONTMAP
495
496 wxRendererNative *wxConsoleAppTraitsBase::CreateRenderer()
497 {
498 // console applications don't use renderers
499 return NULL;
500 }
501
502 #ifdef __WXDEBUG__
503 bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString& msg)
504 {
505 return wxAppTraitsBase::ShowAssertDialog(msg);
506 }
507 #endif
508
509 bool wxConsoleAppTraitsBase::HasStderr()
510 {
511 // console applications always have stderr, even under Mac/Windows
512 return true;
513 }
514
515 void wxConsoleAppTraitsBase::ScheduleForDestroy(wxObject *object)
516 {
517 delete object;
518 }
519
520 void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject * WXUNUSED(object))
521 {
522 // nothing to do
523 }
524
525 #if wxUSE_SOCKETS
526 GSocketGUIFunctionsTable* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable()
527 {
528 return NULL;
529 }
530 #endif
531
532 // ----------------------------------------------------------------------------
533 // wxAppTraits
534 // ----------------------------------------------------------------------------
535
536 #ifdef __WXDEBUG__
537
538 bool wxAppTraitsBase::ShowAssertDialog(const wxString& msg)
539 {
540 return DoShowAssertDialog(msg);
541 }
542
543 #endif // __WXDEBUG__
544
545 // ============================================================================
546 // global functions implementation
547 // ============================================================================
548
549 void wxExit()
550 {
551 if ( wxTheApp )
552 {
553 wxTheApp->Exit();
554 }
555 else
556 {
557 // what else can we do?
558 exit(-1);
559 }
560 }
561
562 void wxWakeUpIdle()
563 {
564 if ( wxTheApp )
565 {
566 wxTheApp->WakeUpIdle();
567 }
568 //else: do nothing, what can we do?
569 }
570
571 #ifdef __WXDEBUG__
572
573 // wxASSERT() helper
574 bool wxAssertIsEqual(int x, int y)
575 {
576 return x == y;
577 }
578
579 // break into the debugger
580 void wxTrap()
581 {
582 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
583 DebugBreak();
584 #elif defined(__WXMAC__) && !defined(__DARWIN__)
585 #if __powerc
586 Debugger();
587 #else
588 SysBreak();
589 #endif
590 #elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
591 Debugger();
592 #elif defined(__UNIX__)
593 raise(SIGTRAP);
594 #else
595 // TODO
596 #endif // Win/Unix
597 }
598
599 // this function is called when an assert fails
600 void wxOnAssert(const wxChar *szFile,
601 int nLine,
602 const char *szFunc,
603 const wxChar *szCond,
604 const wxChar *szMsg)
605 {
606 // FIXME MT-unsafe
607 static bool s_bInAssert = false;
608
609 if ( s_bInAssert )
610 {
611 // He-e-e-e-elp!! we're trapped in endless loop
612 wxTrap();
613
614 s_bInAssert = false;
615
616 return;
617 }
618
619 s_bInAssert = true;
620
621 // __FUNCTION__ is always in ASCII, convert it to wide char if needed
622 const wxString strFunc = wxString::FromAscii(szFunc);
623
624 if ( !wxTheApp )
625 {
626 // by default, show the assert dialog box -- we can't customize this
627 // behaviour
628 ShowAssertDialog(szFile, nLine, strFunc, szCond, szMsg);
629 }
630 else
631 {
632 // let the app process it as it wants
633 wxTheApp->OnAssertFailure(szFile, nLine, strFunc, szCond, szMsg);
634 }
635
636 s_bInAssert = false;
637 }
638
639 #endif // __WXDEBUG__
640
641 // ============================================================================
642 // private functions implementation
643 // ============================================================================
644
645 #ifdef __WXDEBUG__
646
647 static void LINKAGEMODE SetTraceMasks()
648 {
649 #if wxUSE_LOG
650 wxString mask;
651 if ( wxGetEnv(wxT("WXTRACE"), &mask) )
652 {
653 wxStringTokenizer tkn(mask, wxT(",;:"));
654 while ( tkn.HasMoreTokens() )
655 wxLog::AddTraceMask(tkn.GetNextToken());
656 }
657 #endif // wxUSE_LOG
658 }
659
660 bool DoShowAssertDialog(const wxString& msg)
661 {
662 // under MSW we can show the dialog even in the console mode
663 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
664 wxString msgDlg(msg);
665
666 // this message is intentionally not translated -- it is for
667 // developpers only
668 msgDlg += wxT("\nDo you want to stop the program?\n")
669 wxT("You can also choose [Cancel] to suppress ")
670 wxT("further warnings.");
671
672 switch ( ::MessageBox(NULL, msgDlg, _T("wxWidgets Debug Alert"),
673 MB_YESNOCANCEL | MB_ICONSTOP ) )
674 {
675 case IDYES:
676 wxTrap();
677 break;
678
679 case IDCANCEL:
680 // stop the asserts
681 return true;
682
683 //case IDNO: nothing to do
684 }
685 #else // !__WXMSW__
686 wxFprintf(stderr, wxT("%s\n"), msg.c_str());
687 fflush(stderr);
688
689 // TODO: ask the user to enter "Y" or "N" on the console?
690 wxTrap();
691 #endif // __WXMSW__/!__WXMSW__
692
693 // continue with the asserts
694 return false;
695 }
696
697 #if wxUSE_STACKWALKER
698 static wxString GetAssertStackTrace()
699 {
700 wxString stackTrace;
701
702 class StackDump : public wxStackWalker
703 {
704 public:
705 StackDump() { }
706
707 const wxString& GetStackTrace() const { return m_stackTrace; }
708
709 protected:
710 virtual void OnStackFrame(const wxStackFrame& frame)
711 {
712 m_stackTrace << wxString::Format
713 (
714 _T("[%02d] "),
715 wx_truncate_cast(int, frame.GetLevel())
716 );
717
718 wxString name = frame.GetName();
719 if ( !name.empty() )
720 {
721 m_stackTrace << wxString::Format(_T("%-40s"), name.c_str());
722 }
723 else
724 {
725 m_stackTrace << wxString::Format(_T("%p"), frame.GetAddress());
726 }
727
728 if ( frame.HasSourceLocation() )
729 {
730 m_stackTrace << _T('\t')
731 << frame.GetFileName()
732 << _T(':')
733 << frame.GetLine();
734 }
735
736 m_stackTrace << _T('\n');
737 }
738
739 private:
740 wxString m_stackTrace;
741 };
742
743 StackDump dump;
744 dump.Walk(2); // don't show OnAssert() call itself
745 stackTrace = dump.GetStackTrace();
746
747 // don't show more than maxLines or we could get a dialog too tall to be
748 // shown on screen: 20 should be ok everywhere as even with 15 pixel high
749 // characters it is still only 300 pixels...
750 static const int maxLines = 20;
751 const int count = stackTrace.Freq(wxT('\n'));
752 for ( int i = 0; i < count - maxLines; i++ )
753 stackTrace = stackTrace.BeforeLast(wxT('\n'));
754
755 return stackTrace;
756 }
757 #endif // wxUSE_STACKWALKER
758
759 // show the assert modal dialog
760 static
761 void ShowAssertDialog(const wxChar *szFile,
762 int nLine,
763 const wxChar *szFunc,
764 const wxChar *szCond,
765 const wxChar *szMsg,
766 wxAppTraits *traits)
767 {
768 // this variable can be set to true to suppress "assert failure" messages
769 static bool s_bNoAsserts = false;
770
771 wxString msg;
772 msg.reserve(2048);
773
774 // make life easier for people using VC++ IDE by using this format: like
775 // this, clicking on the message will take us immediately to the place of
776 // the failed assert
777 msg.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile, nLine, szCond);
778
779 // add the function name, if any
780 if ( szFunc && *szFunc )
781 msg << _T(" in ") << szFunc << _T("()");
782
783 // and the message itself
784 if ( szMsg )
785 {
786 msg << _T(": ") << szMsg;
787 }
788 else // no message given
789 {
790 msg << _T('.');
791 }
792
793 #if wxUSE_STACKWALKER
794 const wxString stackTrace = GetAssertStackTrace();
795 if ( !stackTrace.empty() )
796 {
797 msg << _T("\n\nCall stack:\n") << stackTrace;
798 }
799 #endif // wxUSE_STACKWALKER
800
801 #if wxUSE_THREADS
802 // if we are not in the main thread, output the assert directly and trap
803 // since dialogs cannot be displayed
804 if ( !wxThread::IsMain() )
805 {
806 msg += wxT(" [in child thread]");
807
808 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
809 msg << wxT("\r\n");
810 OutputDebugString(msg );
811 #else
812 // send to stderr
813 wxFprintf(stderr, wxT("%s\n"), msg.c_str());
814 fflush(stderr);
815 #endif
816 // He-e-e-e-elp!! we're asserting in a child thread
817 wxTrap();
818 }
819 else
820 #endif // wxUSE_THREADS
821
822 if ( !s_bNoAsserts )
823 {
824 // send it to the normal log destination
825 wxLogDebug(_T("%s"), msg.c_str());
826
827 if ( traits )
828 {
829 // delegate showing assert dialog (if possible) to that class
830 s_bNoAsserts = traits->ShowAssertDialog(msg);
831 }
832 else // no traits object
833 {
834 // fall back to the function of last resort
835 s_bNoAsserts = DoShowAssertDialog(msg);
836 }
837 }
838 }
839
840 #endif // __WXDEBUG__