don't evaluate assert expression unless the condition is false (patch 1450705)
[wxWidgets.git] / src / common / appbase.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: common/base/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 #include "wx/app.h"
29 #include "wx/intl.h"
30 #include "wx/list.h"
31 #include "wx/log.h"
32 #endif //WX_PRECOMP
33
34 #include "wx/utils.h"
35 #include "wx/apptrait.h"
36 #include "wx/cmdline.h"
37 #include "wx/confbase.h"
38 #include "wx/filename.h"
39 #include "wx/msgout.h"
40 #include "wx/tokenzr.h"
41
42 #if !defined(__WXMSW__) || defined(__WXMICROWIN__)
43 #include <signal.h> // for SIGTRAP used by wxTrap()
44 #endif //Win/Unix
45
46 #if defined(__WXMSW__)
47 #include "wx/msw/wrapwin.h" // includes windows.h for MessageBox()
48 #endif
49
50 #if wxUSE_FONTMAP
51 #include "wx/fontmap.h"
52 #endif // wxUSE_FONTMAP
53
54 #if defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
55 // For MacTypes.h for Debugger function
56 #include <CoreFoundation/CFBase.h>
57 #endif
58
59 #if defined(__WXMAC__)
60 #ifdef __DARWIN__
61 #include <CoreServices/CoreServices.h>
62 #else
63 #include "wx/mac/private.h" // includes mac headers
64 #endif
65 #endif // __WXMAC__
66
67 #ifdef __WXDEBUG__
68 #if wxUSE_STACKWALKER
69 #include "wx/stackwalk.h"
70 #ifdef __WXMSW__
71 #include "wx/msw/debughlp.h"
72 #endif
73 #endif // wxUSE_STACKWALKER
74 #endif // __WXDEBUG__
75
76 // wxABI_VERSION can be defined when compiling applications but it should be
77 // left undefined when compiling the library itself, it is then set to its
78 // default value in version.h
79 #if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99
80 #error "wxABI_VERSION should not be defined when compiling the library"
81 #endif
82
83 // ----------------------------------------------------------------------------
84 // private functions prototypes
85 // ----------------------------------------------------------------------------
86
87 #ifdef __WXDEBUG__
88 // really just show the assert dialog
89 static bool DoShowAssertDialog(const wxString& msg);
90
91 // prepare for showing the assert dialog, use the given traits or
92 // DoShowAssertDialog() as last fallback to really show it
93 static
94 void ShowAssertDialog(const wxChar *szFile,
95 int nLine,
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::OnAssert(const wxChar *file,
438 int line,
439 const wxChar *cond,
440 const wxChar *msg)
441 {
442 ShowAssertDialog(file, line, cond, msg, GetTraits());
443 }
444
445 #endif // __WXDEBUG__
446
447 #if WXWIN_COMPATIBILITY_2_4
448
449 bool wxAppConsole::CheckBuildOptions(const wxBuildOptions& buildOptions)
450 {
451 return CheckBuildOptions(buildOptions.m_signature, "your program");
452 }
453
454 #endif
455
456 // ============================================================================
457 // other classes implementations
458 // ============================================================================
459
460 // ----------------------------------------------------------------------------
461 // wxConsoleAppTraitsBase
462 // ----------------------------------------------------------------------------
463
464 #if wxUSE_LOG
465
466 wxLog *wxConsoleAppTraitsBase::CreateLogTarget()
467 {
468 return new wxLogStderr;
469 }
470
471 #endif // wxUSE_LOG
472
473 wxMessageOutput *wxConsoleAppTraitsBase::CreateMessageOutput()
474 {
475 return new wxMessageOutputStderr;
476 }
477
478 #if wxUSE_FONTMAP
479
480 wxFontMapper *wxConsoleAppTraitsBase::CreateFontMapper()
481 {
482 return (wxFontMapper *)new wxFontMapperBase;
483 }
484
485 #endif // wxUSE_FONTMAP
486
487 wxRendererNative *wxConsoleAppTraitsBase::CreateRenderer()
488 {
489 // console applications don't use renderers
490 return NULL;
491 }
492
493 #ifdef __WXDEBUG__
494 bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString& msg)
495 {
496 return wxAppTraitsBase::ShowAssertDialog(msg);
497 }
498 #endif
499
500 bool wxConsoleAppTraitsBase::HasStderr()
501 {
502 // console applications always have stderr, even under Mac/Windows
503 return true;
504 }
505
506 void wxConsoleAppTraitsBase::ScheduleForDestroy(wxObject *object)
507 {
508 delete object;
509 }
510
511 void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject * WXUNUSED(object))
512 {
513 // nothing to do
514 }
515
516 #if wxUSE_SOCKETS
517 GSocketGUIFunctionsTable* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable()
518 {
519 return NULL;
520 }
521 #endif
522
523 // ----------------------------------------------------------------------------
524 // wxAppTraits
525 // ----------------------------------------------------------------------------
526
527 #ifdef __WXDEBUG__
528
529 bool wxAppTraitsBase::ShowAssertDialog(const wxString& msg)
530 {
531 return DoShowAssertDialog(msg);
532 }
533
534 #endif // __WXDEBUG__
535
536 // ============================================================================
537 // global functions implementation
538 // ============================================================================
539
540 void wxExit()
541 {
542 if ( wxTheApp )
543 {
544 wxTheApp->Exit();
545 }
546 else
547 {
548 // what else can we do?
549 exit(-1);
550 }
551 }
552
553 void wxWakeUpIdle()
554 {
555 if ( wxTheApp )
556 {
557 wxTheApp->WakeUpIdle();
558 }
559 //else: do nothing, what can we do?
560 }
561
562 #ifdef __WXDEBUG__
563
564 // wxASSERT() helper
565 bool wxAssertIsEqual(int x, int y)
566 {
567 return x == y;
568 }
569
570 // break into the debugger
571 void wxTrap()
572 {
573 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
574 DebugBreak();
575 #elif defined(__WXMAC__) && !defined(__DARWIN__)
576 #if __powerc
577 Debugger();
578 #else
579 SysBreak();
580 #endif
581 #elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
582 Debugger();
583 #elif defined(__UNIX__)
584 raise(SIGTRAP);
585 #else
586 // TODO
587 #endif // Win/Unix
588 }
589
590 // this function is called when an assert fails
591 void wxOnAssert(const wxChar *szFile,
592 int nLine,
593 const wxChar *szCond,
594 const wxChar *szMsg)
595 {
596 // FIXME MT-unsafe
597 static bool s_bInAssert = false;
598
599 if ( s_bInAssert )
600 {
601 // He-e-e-e-elp!! we're trapped in endless loop
602 wxTrap();
603
604 s_bInAssert = false;
605
606 return;
607 }
608
609 s_bInAssert = true;
610
611 if ( !wxTheApp )
612 {
613 // by default, show the assert dialog box -- we can't customize this
614 // behaviour
615 ShowAssertDialog(szFile, nLine, szCond, szMsg);
616 }
617 else
618 {
619 // let the app process it as it wants
620 wxTheApp->OnAssert(szFile, nLine, szCond, szMsg);
621 }
622
623 s_bInAssert = false;
624 }
625
626 #endif // __WXDEBUG__
627
628 // ============================================================================
629 // private functions implementation
630 // ============================================================================
631
632 #ifdef __WXDEBUG__
633
634 static void LINKAGEMODE SetTraceMasks()
635 {
636 #if wxUSE_LOG
637 wxString mask;
638 if ( wxGetEnv(wxT("WXTRACE"), &mask) )
639 {
640 wxStringTokenizer tkn(mask, wxT(",;:"));
641 while ( tkn.HasMoreTokens() )
642 wxLog::AddTraceMask(tkn.GetNextToken());
643 }
644 #endif // wxUSE_LOG
645 }
646
647 bool DoShowAssertDialog(const wxString& msg)
648 {
649 // under MSW we can show the dialog even in the console mode
650 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
651 wxString msgDlg(msg);
652
653 // this message is intentionally not translated -- it is for
654 // developpers only
655 msgDlg += wxT("\nDo you want to stop the program?\n")
656 wxT("You can also choose [Cancel] to suppress ")
657 wxT("further warnings.");
658
659 switch ( ::MessageBox(NULL, msgDlg, _T("wxWidgets Debug Alert"),
660 MB_YESNOCANCEL | MB_ICONSTOP ) )
661 {
662 case IDYES:
663 wxTrap();
664 break;
665
666 case IDCANCEL:
667 // stop the asserts
668 return true;
669
670 //case IDNO: nothing to do
671 }
672 #else // !__WXMSW__
673 wxFprintf(stderr, wxT("%s\n"), msg.c_str());
674 fflush(stderr);
675
676 // TODO: ask the user to enter "Y" or "N" on the console?
677 wxTrap();
678 #endif // __WXMSW__/!__WXMSW__
679
680 // continue with the asserts
681 return false;
682 }
683
684 #if wxUSE_STACKWALKER
685 static wxString GetAssertStackTrace()
686 {
687 wxString stackTrace;
688
689 class StackDump : public wxStackWalker
690 {
691 public:
692 StackDump() { }
693
694 const wxString& GetStackTrace() const { return m_stackTrace; }
695
696 protected:
697 virtual void OnStackFrame(const wxStackFrame& frame)
698 {
699 m_stackTrace << wxString::Format
700 (
701 _T("[%02d] "),
702 wx_truncate_cast(int, frame.GetLevel())
703 );
704
705 wxString name = frame.GetName();
706 if ( !name.empty() )
707 {
708 m_stackTrace << wxString::Format(_T("%-40s"), name.c_str());
709 }
710 else
711 {
712 m_stackTrace << wxString::Format(_T("%p"), frame.GetAddress());
713 }
714
715 if ( frame.HasSourceLocation() )
716 {
717 m_stackTrace << _T('\t')
718 << frame.GetFileName()
719 << _T(':')
720 << frame.GetLine();
721 }
722
723 m_stackTrace << _T('\n');
724 }
725
726 private:
727 wxString m_stackTrace;
728 };
729
730 StackDump dump;
731 dump.Walk(5); // don't show OnAssert() call itself
732 stackTrace = dump.GetStackTrace();
733
734 // don't show more than maxLines or we could get a dialog too tall to be
735 // shown on screen: 20 should be ok everywhere as even with 15 pixel high
736 // characters it is still only 300 pixels...
737 static const int maxLines = 20;
738 const int count = stackTrace.Freq(wxT('\n'));
739 for ( int i = 0; i < count - maxLines; i++ )
740 stackTrace = stackTrace.BeforeLast(wxT('\n'));
741
742 return stackTrace;
743 }
744 #endif // wxUSE_STACKWALKER
745
746 // show the assert modal dialog
747 static
748 void ShowAssertDialog(const wxChar *szFile,
749 int nLine,
750 const wxChar *szCond,
751 const wxChar *szMsg,
752 wxAppTraits *traits)
753 {
754 // this variable can be set to true to suppress "assert failure" messages
755 static bool s_bNoAsserts = false;
756
757 wxString msg;
758 msg.reserve(2048);
759
760 // make life easier for people using VC++ IDE by using this format: like
761 // this, clicking on the message will take us immediately to the place of
762 // the failed assert
763 msg.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile, nLine, szCond);
764
765 if ( szMsg )
766 {
767 msg << _T(": ") << szMsg;
768 }
769 else // no message given
770 {
771 msg << _T('.');
772 }
773
774 #if wxUSE_STACKWALKER
775 const wxString stackTrace = GetAssertStackTrace();
776 if ( !stackTrace.empty() )
777 {
778 msg << _T("\n\nCall stack:\n") << stackTrace;
779 }
780 #endif // wxUSE_STACKWALKER
781
782 #if wxUSE_THREADS
783 // if we are not in the main thread, output the assert directly and trap
784 // since dialogs cannot be displayed
785 if ( !wxThread::IsMain() )
786 {
787 msg += wxT(" [in child thread]");
788
789 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
790 msg << wxT("\r\n");
791 OutputDebugString(msg );
792 #else
793 // send to stderr
794 wxFprintf(stderr, wxT("%s\n"), msg.c_str());
795 fflush(stderr);
796 #endif
797 // He-e-e-e-elp!! we're asserting in a child thread
798 wxTrap();
799 }
800 else
801 #endif // wxUSE_THREADS
802
803 if ( !s_bNoAsserts )
804 {
805 // send it to the normal log destination
806 wxLogDebug(_T("%s"), msg.c_str());
807
808 if ( traits )
809 {
810 // delegate showing assert dialog (if possible) to that class
811 s_bNoAsserts = traits->ShowAssertDialog(msg);
812 }
813 else // no traits object
814 {
815 // fall back to the function of last resort
816 s_bNoAsserts = DoShowAssertDialog(msg);
817 }
818 }
819 }
820
821 #endif // __WXDEBUG__
822