1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/appbase.cpp
3 // Purpose: implements wxAppConsoleBase class
4 // Author: Vadim Zeitlin
6 // Created: 19.06.2003 (extracted from common/appcmn.cpp)
8 // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9 // License: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/msw/wrapwin.h" // includes windows.h for MessageBox()
36 #include "wx/wxcrtvararg.h"
39 #include "wx/apptrait.h"
40 #include "wx/cmdline.h"
41 #include "wx/confbase.h"
42 #include "wx/evtloop.h"
43 #include "wx/filename.h"
44 #include "wx/msgout.h"
45 #include "wx/ptr_scpd.h"
46 #include "wx/tokenzr.h"
47 #include "wx/thread.h"
49 #if wxUSE_EXCEPTIONS && wxUSE_STL
55 #if !defined(__WXMSW__) || defined(__WXMICROWIN__)
56 #include <signal.h> // for SIGTRAP used by wxTrap()
60 #endif // ! __WXPALMOS5__
63 #include "wx/fontmap.h"
64 #endif // wxUSE_FONTMAP
66 #if defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
67 // For MacTypes.h for Debugger function
68 #include <CoreFoundation/CFBase.h>
71 #if defined(__WXMAC__)
73 #include <CoreServices/CoreServices.h>
75 #include "wx/mac/private.h" // includes mac headers
81 #include "wx/stackwalk.h"
83 #include "wx/msw/debughlp.h"
85 #endif // wxUSE_STACKWALKER
87 #include "wx/recguard.h"
90 // wxABI_VERSION can be defined when compiling applications but it should be
91 // left undefined when compiling the library itself, it is then set to its
92 // default value in version.h
93 #if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99
94 #error "wxABI_VERSION should not be defined when compiling the library"
97 // ----------------------------------------------------------------------------
98 // private functions prototypes
99 // ----------------------------------------------------------------------------
102 // really just show the assert dialog
103 static bool DoShowAssertDialog(const wxString
& msg
);
105 // prepare for showing the assert dialog, use the given traits or
106 // DoShowAssertDialog() as last fallback to really show it
108 void ShowAssertDialog(const wxString
& szFile
,
110 const wxString
& szFunc
,
111 const wxString
& szCond
,
112 const wxString
& szMsg
,
113 wxAppTraits
*traits
= NULL
);
115 // turn on the trace masks specified in the env variable WXTRACE
116 static void LINKAGEMODE
SetTraceMasks();
117 #endif // __WXDEBUG__
119 // ----------------------------------------------------------------------------
121 // ----------------------------------------------------------------------------
123 wxAppConsole
*wxAppConsoleBase::ms_appInstance
= NULL
;
125 wxAppInitializerFunction
wxAppConsoleBase::ms_appInitFn
= NULL
;
127 // ----------------------------------------------------------------------------
129 // ----------------------------------------------------------------------------
131 // this defines wxEventLoopPtr
132 wxDEFINE_TIED_SCOPED_PTR_TYPE(wxEventLoopBase
)
134 // ============================================================================
135 // wxAppConsoleBase implementation
136 // ============================================================================
138 // ----------------------------------------------------------------------------
140 // ----------------------------------------------------------------------------
142 wxAppConsoleBase::wxAppConsoleBase()
147 ms_appInstance
= wx_static_cast(wxAppConsole
*, this);
152 // In unicode mode the SetTraceMasks call can cause an apptraits to be
153 // created, but since we are still in the constructor the wrong kind will
154 // be created for GUI apps. Destroy it so it can be created again later.
161 wxAppConsoleBase::~wxAppConsoleBase()
166 // ----------------------------------------------------------------------------
167 // initilization/cleanup
168 // ----------------------------------------------------------------------------
170 bool wxAppConsoleBase::Initialize(int& WXUNUSED(argc
), wxChar
**WXUNUSED(argv
))
173 GetTraits()->SetLocale();
177 wxPendingEventsLocker
= new wxCriticalSection
;
181 if ( m_appName
.empty() && argv
)
183 // the application name is, by default, the name of its executable file
184 wxFileName::SplitPath(argv
[0], NULL
, &m_appName
, NULL
);
186 #endif // !__WXPALMOS__
191 wxEventLoopBase
*wxAppConsoleBase::CreateMainLoop()
193 return GetTraits()->CreateEventLoop();
196 void wxAppConsoleBase::CleanUp()
204 delete wxPendingEvents
;
205 wxPendingEvents
= NULL
;
208 delete wxPendingEventsLocker
;
209 wxPendingEventsLocker
= NULL
;
210 #endif // wxUSE_THREADS
213 // ----------------------------------------------------------------------------
215 // ----------------------------------------------------------------------------
217 bool wxAppConsoleBase::OnInit()
219 #if wxUSE_CMDLINE_PARSER
220 wxCmdLineParser
parser(argc
, argv
);
222 OnInitCmdLine(parser
);
225 switch ( parser
.Parse(false /* don't show usage */) )
228 cont
= OnCmdLineHelp(parser
);
232 cont
= OnCmdLineParsed(parser
);
236 cont
= OnCmdLineError(parser
);
242 #endif // wxUSE_CMDLINE_PARSER
247 int wxAppConsoleBase::OnRun()
252 int wxAppConsoleBase::OnExit()
255 // delete the config object if any (don't use Get() here, but Set()
256 // because Get() could create a new config object)
257 delete wxConfigBase::Set((wxConfigBase
*) NULL
);
258 #endif // wxUSE_CONFIG
263 void wxAppConsoleBase::Exit()
265 if (m_mainLoop
!= NULL
)
271 // ----------------------------------------------------------------------------
273 // ----------------------------------------------------------------------------
275 wxAppTraits
*wxAppConsoleBase::CreateTraits()
277 return new wxConsoleAppTraits
;
280 wxAppTraits
*wxAppConsoleBase::GetTraits()
282 // FIXME-MT: protect this with a CS?
285 m_traits
= CreateTraits();
287 wxASSERT_MSG( m_traits
, _T("wxApp::CreateTraits() failed?") );
293 // ----------------------------------------------------------------------------
295 // ----------------------------------------------------------------------------
297 int wxAppConsoleBase::MainLoop()
299 wxEventLoopBaseTiedPtr
mainLoop(&m_mainLoop
, CreateMainLoop());
301 return m_mainLoop
? m_mainLoop
->Run() : -1;
304 void wxAppConsoleBase::ExitMainLoop()
306 // we should exit from the main event loop, not just any currently active
307 // (e.g. modal dialog) event loop
308 if ( m_mainLoop
&& m_mainLoop
->IsRunning() )
314 bool wxAppConsoleBase::Pending()
316 // use the currently active message loop here, not m_mainLoop, because if
317 // we're showing a modal dialog (with its own event loop) currently the
318 // main event loop is not running anyhow
319 wxEventLoopBase
* const loop
= wxEventLoopBase::GetActive();
321 return loop
&& loop
->Pending();
324 bool wxAppConsoleBase::Dispatch()
326 // see comment in Pending()
327 wxEventLoopBase
* const loop
= wxEventLoopBase::GetActive();
329 return loop
&& loop
->Dispatch();
332 bool wxAppConsoleBase::HasPendingEvents() const
334 wxENTER_CRIT_SECT( *wxPendingEventsLocker
);
336 bool has
= wxPendingEvents
&& !wxPendingEvents
->IsEmpty();
338 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker
);
344 bool wxAppConsoleBase::IsMainLoopRunning()
346 const wxAppConsole
* const app
= GetInstance();
348 return app
&& app
->m_mainLoop
!= NULL
;
351 void wxAppConsoleBase::ProcessPendingEvents()
354 if ( !wxPendingEventsLocker
)
358 wxENTER_CRIT_SECT( *wxPendingEventsLocker
);
362 // iterate until the list becomes empty: the handlers remove themselves
363 // from it when they don't have any more pending events
364 wxList::compatibility_iterator node
= wxPendingEvents
->GetFirst();
367 // In ProcessPendingEvents(), new handlers might be add
368 // and we can safely leave the critical section here.
369 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker
);
371 wxEvtHandler
*handler
= (wxEvtHandler
*)node
->GetData();
372 handler
->ProcessPendingEvents();
374 wxENTER_CRIT_SECT( *wxPendingEventsLocker
);
376 // restart as the iterators could have been invalidated
377 node
= wxPendingEvents
->GetFirst();
381 wxLEAVE_CRIT_SECT( *wxPendingEventsLocker
);
384 void wxAppConsoleBase::WakeUpIdle()
387 m_mainLoop
->WakeUp();
390 bool wxAppConsoleBase::ProcessIdle()
394 event
.SetEventObject(this);
396 return event
.MoreRequested();
399 int wxAppConsoleBase::FilterEvent(wxEvent
& WXUNUSED(event
))
401 // process the events normally by default
405 // ----------------------------------------------------------------------------
406 // exception handling
407 // ----------------------------------------------------------------------------
412 wxAppConsoleBase::HandleEvent(wxEvtHandler
*handler
,
413 wxEventFunction func
,
414 wxEvent
& event
) const
416 // by default, simply call the handler
417 (handler
->*func
)(event
);
420 void wxAppConsoleBase::OnUnhandledException()
423 // we're called from an exception handler so we can re-throw the exception
424 // to recover its type
431 catch ( std::exception
& e
)
433 what
.Printf("std::exception of type \"%s\", what() = \"%s\"",
434 typeid(e
).name(), e
.what());
439 what
= "unknown exception";
442 wxMessageOutputBest().Printf(
443 "*** Caught unhandled %s; terminating\n", what
445 #endif // __WXDEBUG__
448 // ----------------------------------------------------------------------------
449 // exceptions support
450 // ----------------------------------------------------------------------------
452 bool wxAppConsoleBase::OnExceptionInMainLoop()
456 // some compilers are too stupid to know that we never return after throw
457 #if defined(__DMC__) || (defined(_MSC_VER) && _MSC_VER < 1200)
462 #endif // wxUSE_EXCEPTIONS
464 // ----------------------------------------------------------------------------
466 // ----------------------------------------------------------------------------
468 #if wxUSE_CMDLINE_PARSER
470 #define OPTION_VERBOSE "verbose"
472 void wxAppConsoleBase::OnInitCmdLine(wxCmdLineParser
& parser
)
474 // the standard command line options
475 static const wxCmdLineEntryDesc cmdLineDesc
[] =
481 gettext_noop("show this help message"),
483 wxCMD_LINE_OPTION_HELP
491 gettext_noop("generate verbose log messages"),
501 parser
.SetDesc(cmdLineDesc
);
504 bool wxAppConsoleBase::OnCmdLineParsed(wxCmdLineParser
& parser
)
507 if ( parser
.Found(OPTION_VERBOSE
) )
509 wxLog::SetVerbose(true);
518 bool wxAppConsoleBase::OnCmdLineHelp(wxCmdLineParser
& parser
)
525 bool wxAppConsoleBase::OnCmdLineError(wxCmdLineParser
& parser
)
532 #endif // wxUSE_CMDLINE_PARSER
534 // ----------------------------------------------------------------------------
536 // ----------------------------------------------------------------------------
539 bool wxAppConsoleBase::CheckBuildOptions(const char *optionsSignature
,
540 const char *componentName
)
542 #if 0 // can't use wxLogTrace, not up and running yet
543 printf("checking build options object '%s' (ptr %p) in '%s'\n",
544 optionsSignature
, optionsSignature
, componentName
);
547 if ( strcmp(optionsSignature
, WX_BUILD_OPTIONS_SIGNATURE
) != 0 )
549 wxString lib
= wxString::FromAscii(WX_BUILD_OPTIONS_SIGNATURE
);
550 wxString prog
= wxString::FromAscii(optionsSignature
);
551 wxString progName
= wxString::FromAscii(componentName
);
554 msg
.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %s,\nand %s used %s."),
555 lib
.c_str(), progName
.c_str(), prog
.c_str());
557 wxLogFatalError(msg
.c_str());
559 // normally wxLogFatalError doesn't return
569 void wxAppConsoleBase::OnAssertFailure(const wxChar
*file
,
575 ShowAssertDialog(file
, line
, func
, cond
, msg
, GetTraits());
578 void wxAppConsoleBase::OnAssert(const wxChar
*file
,
583 OnAssertFailure(file
, line
, NULL
, cond
, msg
);
586 #endif // __WXDEBUG__
588 // ============================================================================
589 // other classes implementations
590 // ============================================================================
592 // ----------------------------------------------------------------------------
593 // wxConsoleAppTraitsBase
594 // ----------------------------------------------------------------------------
598 wxLog
*wxConsoleAppTraitsBase::CreateLogTarget()
600 return new wxLogStderr
;
605 wxMessageOutput
*wxConsoleAppTraitsBase::CreateMessageOutput()
607 return new wxMessageOutputStderr
;
612 wxFontMapper
*wxConsoleAppTraitsBase::CreateFontMapper()
614 return (wxFontMapper
*)new wxFontMapperBase
;
617 #endif // wxUSE_FONTMAP
619 wxRendererNative
*wxConsoleAppTraitsBase::CreateRenderer()
621 // console applications don't use renderers
626 bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString
& msg
)
628 return wxAppTraitsBase::ShowAssertDialog(msg
);
632 bool wxConsoleAppTraitsBase::HasStderr()
634 // console applications always have stderr, even under Mac/Windows
638 void wxConsoleAppTraitsBase::ScheduleForDestroy(wxObject
*object
)
643 void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject
* WXUNUSED(object
))
648 // ----------------------------------------------------------------------------
650 // ----------------------------------------------------------------------------
653 void wxAppTraitsBase::SetLocale()
655 wxSetlocale(LC_ALL
, "");
656 wxUpdateLocaleIsUtf8();
661 void wxMutexGuiEnterImpl();
662 void wxMutexGuiLeaveImpl();
664 void wxAppTraitsBase::MutexGuiEnter()
666 wxMutexGuiEnterImpl();
669 void wxAppTraitsBase::MutexGuiLeave()
671 wxMutexGuiLeaveImpl();
674 void WXDLLIMPEXP_BASE
wxMutexGuiEnter()
676 wxAppConsoleBase::GetInstance()->GetTraits()->MutexGuiEnter();
679 void WXDLLIMPEXP_BASE
wxMutexGuiLeave()
681 wxAppConsoleBase::GetInstance()->GetTraits()->MutexGuiLeave();
683 #endif // wxUSE_THREADS
687 bool wxAppTraitsBase::ShowAssertDialog(const wxString
& msgOriginal
)
689 wxString msg
= msgOriginal
;
691 #if wxUSE_STACKWALKER
692 #if !defined(__WXMSW__)
693 // on Unix stack frame generation may take some time, depending on the
694 // size of the executable mainly... warn the user that we are working
695 wxFprintf(stderr
, wxT("[Debug] Generating a stack trace... please wait"));
699 const wxString stackTrace
= GetAssertStackTrace();
700 if ( !stackTrace
.empty() )
701 msg
<< _T("\n\nCall stack:\n") << stackTrace
;
702 #endif // wxUSE_STACKWALKER
704 return DoShowAssertDialog(msg
);
707 #if wxUSE_STACKWALKER
708 wxString
wxAppTraitsBase::GetAssertStackTrace()
712 class StackDump
: public wxStackWalker
717 const wxString
& GetStackTrace() const { return m_stackTrace
; }
720 virtual void OnStackFrame(const wxStackFrame
& frame
)
722 m_stackTrace
<< wxString::Format
725 wx_truncate_cast(int, frame
.GetLevel())
728 wxString name
= frame
.GetName();
731 m_stackTrace
<< wxString::Format(_T("%-40s"), name
.c_str());
735 m_stackTrace
<< wxString::Format(_T("%p"), frame
.GetAddress());
738 if ( frame
.HasSourceLocation() )
740 m_stackTrace
<< _T('\t')
741 << frame
.GetFileName()
746 m_stackTrace
<< _T('\n');
750 wxString m_stackTrace
;
753 // don't show more than maxLines or we could get a dialog too tall to be
754 // shown on screen: 20 should be ok everywhere as even with 15 pixel high
755 // characters it is still only 300 pixels...
756 static const int maxLines
= 20;
759 dump
.Walk(2, maxLines
); // don't show OnAssert() call itself
760 stackTrace
= dump
.GetStackTrace();
762 const int count
= stackTrace
.Freq(wxT('\n'));
763 for ( int i
= 0; i
< count
- maxLines
; i
++ )
764 stackTrace
= stackTrace
.BeforeLast(wxT('\n'));
768 #endif // wxUSE_STACKWALKER
771 #endif // __WXDEBUG__
773 // ============================================================================
774 // global functions implementation
775 // ============================================================================
785 // what else can we do?
794 wxTheApp
->WakeUpIdle();
796 //else: do nothing, what can we do?
802 bool wxAssertIsEqual(int x
, int y
)
807 // break into the debugger
810 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
812 #elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
814 #elif defined(__UNIX__)
821 // this function is called when an assert fails
822 static void wxDoOnAssert(const wxString
& szFile
,
824 const wxString
& szFunc
,
825 const wxString
& szCond
,
826 const wxString
& szMsg
= wxEmptyString
)
829 static int s_bInAssert
= 0;
831 wxRecursionGuard
guard(s_bInAssert
);
832 if ( guard
.IsInside() )
834 // can't use assert here to avoid infinite loops, so just trap
842 // by default, show the assert dialog box -- we can't customize this
844 ShowAssertDialog(szFile
, nLine
, szFunc
, szCond
, szMsg
);
848 // let the app process it as it wants
849 // FIXME-UTF8: use wc_str(), not c_str(), when ANSI build is removed
850 wxTheApp
->OnAssertFailure(szFile
.c_str(), nLine
, szFunc
.c_str(),
851 szCond
.c_str(), szMsg
.c_str());
855 void wxOnAssert(const wxString
& szFile
,
857 const wxString
& szFunc
,
858 const wxString
& szCond
,
859 const wxString
& szMsg
)
861 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
, szMsg
);
864 void wxOnAssert(const wxString
& szFile
,
866 const wxString
& szFunc
,
867 const wxString
& szCond
)
869 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
);
872 void wxOnAssert(const wxChar
*szFile
,
875 const wxChar
*szCond
,
878 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
, szMsg
);
881 void wxOnAssert(const char *szFile
,
885 const wxString
& szMsg
)
887 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
, szMsg
);
890 void wxOnAssert(const char *szFile
,
894 const wxCStrData
& msg
)
896 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
, msg
);
900 void wxOnAssert(const char *szFile
,
905 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
);
908 void wxOnAssert(const char *szFile
,
914 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
, szMsg
);
917 void wxOnAssert(const char *szFile
,
923 wxDoOnAssert(szFile
, nLine
, szFunc
, szCond
, szMsg
);
925 #endif // wxUSE_UNICODE
927 #endif // __WXDEBUG__
929 // ============================================================================
930 // private functions implementation
931 // ============================================================================
935 static void LINKAGEMODE
SetTraceMasks()
939 if ( wxGetEnv(wxT("WXTRACE"), &mask
) )
941 wxStringTokenizer
tkn(mask
, wxT(",;:"));
942 while ( tkn
.HasMoreTokens() )
943 wxLog::AddTraceMask(tkn
.GetNextToken());
949 bool DoShowAssertDialog(const wxString
& msg
)
951 // under MSW we can show the dialog even in the console mode
952 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
953 wxString
msgDlg(msg
);
955 // this message is intentionally not translated -- it is for
957 msgDlg
+= wxT("\nDo you want to stop the program?\n")
958 wxT("You can also choose [Cancel] to suppress ")
959 wxT("further warnings.");
961 switch ( ::MessageBox(NULL
, msgDlg
.wx_str(), _T("wxWidgets Debug Alert"),
962 MB_YESNOCANCEL
| MB_ICONSTOP
) )
972 //case IDNO: nothing to do
975 wxFprintf(stderr
, wxT("%s\n"), msg
.c_str());
978 // TODO: ask the user to enter "Y" or "N" on the console?
980 #endif // __WXMSW__/!__WXMSW__
982 // continue with the asserts
986 // show the assert modal dialog
988 void ShowAssertDialog(const wxString
& szFile
,
990 const wxString
& szFunc
,
991 const wxString
& szCond
,
992 const wxString
& szMsg
,
995 // this variable can be set to true to suppress "assert failure" messages
996 static bool s_bNoAsserts
= false;
1001 // make life easier for people using VC++ IDE by using this format: like
1002 // this, clicking on the message will take us immediately to the place of
1003 // the failed assert
1004 msg
.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile
, nLine
, szCond
);
1006 // add the function name, if any
1007 if ( !szFunc
.empty() )
1008 msg
<< _T(" in ") << szFunc
<< _T("()");
1010 // and the message itself
1011 if ( !szMsg
.empty() )
1013 msg
<< _T(": ") << szMsg
;
1015 else // no message given
1021 // if we are not in the main thread, output the assert directly and trap
1022 // since dialogs cannot be displayed
1023 if ( !wxThread::IsMain() )
1025 msg
+= wxT(" [in child thread]");
1027 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
1029 OutputDebugString(msg
.wx_str());
1032 wxFprintf(stderr
, wxT("%s\n"), msg
.c_str());
1035 // He-e-e-e-elp!! we're asserting in a child thread
1039 #endif // wxUSE_THREADS
1041 if ( !s_bNoAsserts
)
1043 // send it to the normal log destination
1044 wxLogDebug(_T("%s"), msg
.c_str());
1048 // delegate showing assert dialog (if possible) to that class
1049 s_bNoAsserts
= traits
->ShowAssertDialog(msg
);
1051 else // no traits object
1053 // fall back to the function of last resort
1054 s_bNoAsserts
= DoShowAssertDialog(msg
);
1059 #endif // __WXDEBUG__