X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fa0d34477309140cee648df1a975ea5b00db0c0b..3b84c8078e7be6fdb8afb369e559c331b5416da8:/src/common/appbase.cpp?ds=sidebyside diff --git a/src/common/appbase.cpp b/src/common/appbase.cpp index 31fc28facb..269be5b575 100644 --- a/src/common/appbase.cpp +++ b/src/common/appbase.cpp @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: common/base/appbase.cpp -// Purpose: implements wxAppConsole class +// Name: src/common/appbase.cpp +// Purpose: implements wxAppConsoleBase class // Author: Vadim Zeitlin // Modified by: // Created: 19.06.2003 (extracted from common/appcmn.cpp) @@ -25,60 +25,82 @@ #endif #ifndef WX_PRECOMP + #ifdef __WXMSW__ + #include "wx/msw/wrapwin.h" // includes windows.h for MessageBox() + #endif + #include "wx/list.h" #include "wx/app.h" #include "wx/intl.h" - #include "wx/list.h" #include "wx/log.h" + #include "wx/utils.h" + #include "wx/wxcrtvararg.h" #endif //WX_PRECOMP -#include "wx/utils.h" #include "wx/apptrait.h" #include "wx/cmdline.h" #include "wx/confbase.h" +#include "wx/evtloop.h" #include "wx/filename.h" #include "wx/msgout.h" +#include "wx/scopedptr.h" #include "wx/tokenzr.h" +#include "wx/thread.h" + +#if wxUSE_EXCEPTIONS && wxUSE_STL + #include + #include +#endif +#ifndef __WXPALMOS5__ #if !defined(__WXMSW__) || defined(__WXMICROWIN__) #include // for SIGTRAP used by wxTrap() #endif //Win/Unix -#if defined(__WXMSW__) - #include "wx/msw/wrapwin.h" // includes windows.h for MessageBox() -#endif +#include +#endif // ! __WXPALMOS5__ #if wxUSE_FONTMAP #include "wx/fontmap.h" #endif // wxUSE_FONTMAP -#if defined(__WXMAC__) - // VZ: MacTypes.h is enough under Mac OS X (where I could test it) but - // I don't know which headers are needed under earlier systems so - // include everything when in doubt - #ifdef __DARWIN__ - #include "MacTypes.h" - #else - #include "wx/mac/private.h" // includes mac headers - #endif -#endif // __WXMAC__ +#if wxDEBUG_LEVEL + #if wxUSE_STACKWALKER + #include "wx/stackwalk.h" + #ifdef __WXMSW__ + #include "wx/msw/debughlp.h" + #endif + #endif // wxUSE_STACKWALKER + + #include "wx/recguard.h" +#endif // wxDEBUG_LEVEL + +// wxABI_VERSION can be defined when compiling applications but it should be +// left undefined when compiling the library itself, it is then set to its +// default value in version.h +#if wxABI_VERSION != wxMAJOR_VERSION * 10000 + wxMINOR_VERSION * 100 + 99 +#error "wxABI_VERSION should not be defined when compiling the library" +#endif // ---------------------------------------------------------------------------- // private functions prototypes // ---------------------------------------------------------------------------- -#ifdef __WXDEBUG__ +#if wxDEBUG_LEVEL // really just show the assert dialog static bool DoShowAssertDialog(const wxString& msg); // prepare for showing the assert dialog, use the given traits or // DoShowAssertDialog() as last fallback to really show it static - void ShowAssertDialog(const wxChar *szFile, - int nLine, - const wxChar *szCond, - const wxChar *szMsg, + void ShowAssertDialog(const wxString& file, + int line, + const wxString& func, + const wxString& cond, + const wxString& msg, wxAppTraits *traits = NULL); +#endif // wxDEBUG_LEVEL +#ifdef __WXDEBUG__ // turn on the trace masks specified in the env variable WXTRACE static void LINKAGEMODE SetTraceMasks(); #endif // __WXDEBUG__ @@ -87,23 +109,34 @@ // global vars // ---------------------------------------------------------------------------- -wxAppConsole *wxAppConsole::ms_appInstance = NULL; +wxAppConsole *wxAppConsoleBase::ms_appInstance = NULL; + +wxAppInitializerFunction wxAppConsoleBase::ms_appInitFn = NULL; + +wxSocketManager *wxAppTraitsBase::ms_manager = NULL; + +// ---------------------------------------------------------------------------- +// wxEventLoopPtr +// ---------------------------------------------------------------------------- -wxAppInitializerFunction wxAppConsole::ms_appInitFn = NULL; +// this defines wxEventLoopPtr +wxDEFINE_TIED_SCOPED_PTR_TYPE(wxEventLoopBase) // ============================================================================ -// wxAppConsole implementation +// wxAppConsoleBase implementation // ============================================================================ // ---------------------------------------------------------------------------- // ctor/dtor // ---------------------------------------------------------------------------- -wxAppConsole::wxAppConsole() +wxAppConsoleBase::wxAppConsoleBase() { m_traits = NULL; + m_mainLoop = NULL; + m_bDoPendingEventProcessing = true; - ms_appInstance = this; + ms_appInstance = static_cast(this); #ifdef __WXDEBUG__ SetTraceMasks(); @@ -117,47 +150,51 @@ wxAppConsole::wxAppConsole() #endif } -wxAppConsole::~wxAppConsole() +wxAppConsoleBase::~wxAppConsoleBase() { delete m_traits; } // ---------------------------------------------------------------------------- -// initilization/cleanup +// initialization/cleanup // ---------------------------------------------------------------------------- -bool wxAppConsole::Initialize(int& argc, wxChar **argv) +bool wxAppConsoleBase::Initialize(int& WXUNUSED(argc), wxChar **argv) { -#if wxUSE_LOG - // If some code logged something before wxApp instance was created, - // wxLogStderr was set as the target. Undo it here by destroying the - // current target. It will be re-created next time logging is needed, but - // this time wxAppTraits will be used: - delete wxLog::SetActiveTarget(NULL); -#endif // wxUSE_LOG - - // remember the command line arguments - this->argc = argc; - this->argv = argv; +#if wxUSE_INTL + GetTraits()->SetLocale(); +#endif // wxUSE_INTL - if ( m_appName.empty() && argv ) +#ifndef __WXPALMOS__ + if ( m_appName.empty() && argv && argv[0] ) { // the application name is, by default, the name of its executable file wxFileName::SplitPath(argv[0], NULL, &m_appName, NULL); } +#endif // !__WXPALMOS__ return true; } -void wxAppConsole::CleanUp() +wxEventLoopBase *wxAppConsoleBase::CreateMainLoop() { + return GetTraits()->CreateEventLoop(); +} + +void wxAppConsoleBase::CleanUp() +{ + if ( m_mainLoop ) + { + delete m_mainLoop; + m_mainLoop = NULL; + } } // ---------------------------------------------------------------------------- // OnXXX() callbacks // ---------------------------------------------------------------------------- -bool wxAppConsole::OnInit() +bool wxAppConsoleBase::OnInit() { #if wxUSE_CMDLINE_PARSER wxCmdLineParser parser(argc, argv); @@ -165,7 +202,7 @@ bool wxAppConsole::OnInit() OnInitCmdLine(parser); bool cont; - switch ( parser.Parse(FALSE /* don't show usage */) ) + switch ( parser.Parse(false /* don't show usage */) ) { case -1: cont = OnCmdLineHelp(parser); @@ -181,42 +218,46 @@ bool wxAppConsole::OnInit() } if ( !cont ) - return FALSE; + return false; #endif // wxUSE_CMDLINE_PARSER - return TRUE; + return true; +} + +int wxAppConsoleBase::OnRun() +{ + return MainLoop(); } -int wxAppConsole::OnExit() +int wxAppConsoleBase::OnExit() { #if wxUSE_CONFIG // delete the config object if any (don't use Get() here, but Set() // because Get() could create a new config object) - delete wxConfigBase::Set((wxConfigBase *) NULL); + delete wxConfigBase::Set(NULL); #endif // wxUSE_CONFIG - // use Set(NULL) and not Get() to avoid creating a message output object on - // demand when we just want to delete it - delete wxMessageOutput::Set(NULL); - return 0; } -void wxAppConsole::Exit() +void wxAppConsoleBase::Exit() { - exit(-1); + if (m_mainLoop != NULL) + ExitMainLoop(); + else + exit(-1); } // ---------------------------------------------------------------------------- // traits stuff // ---------------------------------------------------------------------------- -wxAppTraits *wxAppConsole::CreateTraits() +wxAppTraits *wxAppConsoleBase::CreateTraits() { return new wxConsoleAppTraits; } -wxAppTraits *wxAppConsole::GetTraits() +wxAppTraits *wxAppConsoleBase::GetTraits() { // FIXME-MT: protect this with a CS? if ( !m_traits ) @@ -229,65 +270,216 @@ wxAppTraits *wxAppConsole::GetTraits() return m_traits; } -// we must implement CreateXXX() in wxApp itself for backwards compatibility -#if WXWIN_COMPATIBILITY_2_4 +/* static */ +wxAppTraits *wxAppConsoleBase::GetTraitsIfExists() +{ + wxAppConsole * const app = GetInstance(); + return app ? app->GetTraits() : NULL; +} + +// ---------------------------------------------------------------------------- +// wxEventLoop redirection +// ---------------------------------------------------------------------------- -#if wxUSE_LOG +int wxAppConsoleBase::MainLoop() +{ + wxEventLoopBaseTiedPtr mainLoop(&m_mainLoop, CreateMainLoop()); -wxLog *wxAppConsole::CreateLogTarget() + return m_mainLoop ? m_mainLoop->Run() : -1; +} + +void wxAppConsoleBase::ExitMainLoop() { - wxAppTraits *traits = GetTraits(); - return traits ? traits->CreateLogTarget() : NULL; + // we should exit from the main event loop, not just any currently active + // (e.g. modal dialog) event loop + if ( m_mainLoop && m_mainLoop->IsRunning() ) + { + m_mainLoop->Exit(0); + } } -#endif // wxUSE_LOG +bool wxAppConsoleBase::Pending() +{ + // use the currently active message loop here, not m_mainLoop, because if + // we're showing a modal dialog (with its own event loop) currently the + // main event loop is not running anyhow + wxEventLoopBase * const loop = wxEventLoopBase::GetActive(); + + return loop && loop->Pending(); +} -wxMessageOutput *wxAppConsole::CreateMessageOutput() +bool wxAppConsoleBase::Dispatch() { - wxAppTraits *traits = GetTraits(); - return traits ? traits->CreateMessageOutput() : NULL; + // see comment in Pending() + wxEventLoopBase * const loop = wxEventLoopBase::GetActive(); + + return loop && loop->Dispatch(); +} + +bool wxAppConsoleBase::Yield(bool onlyIfNeeded) +{ + wxEventLoopBase * const loop = wxEventLoopBase::GetActive(); + + return loop && loop->Yield(onlyIfNeeded); +} + +void wxAppConsoleBase::WakeUpIdle() +{ + if ( m_mainLoop ) + m_mainLoop->WakeUp(); } -#endif // WXWIN_COMPATIBILITY_2_4 +bool wxAppConsoleBase::ProcessIdle() +{ + wxEventLoopBase * const loop = wxEventLoopBase::GetActive(); + + return loop && loop->ProcessIdle(); +} // ---------------------------------------------------------------------------- -// event processing +// events // ---------------------------------------------------------------------------- -void wxAppConsole::ProcessPendingEvents() +/* static */ +bool wxAppConsoleBase::IsMainLoopRunning() { - // ensure that we're the only thread to modify the pending events list - wxENTER_CRIT_SECT( *wxPendingEventsLocker ); + const wxAppConsole * const app = GetInstance(); + + return app && app->m_mainLoop != NULL; +} - if ( !wxPendingEvents ) +int wxAppConsoleBase::FilterEvent(wxEvent& WXUNUSED(event)) +{ + // process the events normally by default + return -1; +} + +void wxAppConsoleBase::DelayPendingEventHandler(wxEvtHandler* toDelay) +{ + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); + + // move the handler from the list of handlers with processable pending events + // to the list of handlers with pending events which needs to be processed later + m_handlersWithPendingEvents.Remove(toDelay); + + if (m_handlersWithPendingDelayedEvents.Index(toDelay) == wxNOT_FOUND) + m_handlersWithPendingDelayedEvents.Add(toDelay); + + wxLEAVE_CRIT_SECT(m_handlersWithPendingEventsLocker); +} + +void wxAppConsoleBase::RemovePendingEventHandler(wxEvtHandler* toRemove) +{ + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); + + if (m_handlersWithPendingEvents.Index(toRemove) != wxNOT_FOUND) { - wxLEAVE_CRIT_SECT( *wxPendingEventsLocker ); - return; + m_handlersWithPendingEvents.Remove(toRemove); + + // check that the handler was present only once in the list + wxASSERT_MSG( m_handlersWithPendingEvents.Index(toRemove) == wxNOT_FOUND, + "Handler occurs twice in the m_handlersWithPendingEvents list!" ); } + //else: it wasn't in this list at all, it's ok - // iterate until the list becomes empty - wxList::compatibility_iterator node = wxPendingEvents->GetFirst(); - while (node) + if (m_handlersWithPendingDelayedEvents.Index(toRemove) != wxNOT_FOUND) { - wxEvtHandler *handler = (wxEvtHandler *)node->GetData(); - wxPendingEvents->Erase(node); + m_handlersWithPendingDelayedEvents.Remove(toRemove); - // In ProcessPendingEvents(), new handlers might be add + // check that the handler was present only once in the list + wxASSERT_MSG( m_handlersWithPendingDelayedEvents.Index(toRemove) == wxNOT_FOUND, + "Handler occurs twice in m_handlersWithPendingDelayedEvents list!" ); + } + //else: it wasn't in this list at all, it's ok + + wxLEAVE_CRIT_SECT(m_handlersWithPendingEventsLocker); +} + +void wxAppConsoleBase::AppendPendingEventHandler(wxEvtHandler* toAppend) +{ + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); + + if ( m_handlersWithPendingEvents.Index(toAppend) == wxNOT_FOUND ) + m_handlersWithPendingEvents.Add(toAppend); + + wxLEAVE_CRIT_SECT(m_handlersWithPendingEventsLocker); +} + +bool wxAppConsoleBase::HasPendingEvents() const +{ + wxENTER_CRIT_SECT(const_cast(this)->m_handlersWithPendingEventsLocker); + + bool has = !m_handlersWithPendingEvents.IsEmpty(); + + wxLEAVE_CRIT_SECT(const_cast(this)->m_handlersWithPendingEventsLocker); + + return has; +} + +void wxAppConsoleBase::SuspendProcessingOfPendingEvents() +{ + m_bDoPendingEventProcessing = false; +} + +void wxAppConsoleBase::ResumeProcessingOfPendingEvents() +{ + m_bDoPendingEventProcessing = true; +} + +void wxAppConsoleBase::ProcessPendingEvents() +{ + if (!m_bDoPendingEventProcessing) + return; + + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); + + wxCHECK_RET( m_handlersWithPendingDelayedEvents.IsEmpty(), + "this helper list should be empty" ); + + // iterate until the list becomes empty: the handlers remove themselves + // from it when they don't have any more pending events + while (!m_handlersWithPendingEvents.IsEmpty()) + { + // In ProcessPendingEvents(), new handlers might be added // and we can safely leave the critical section here. - wxLEAVE_CRIT_SECT( *wxPendingEventsLocker ); - handler->ProcessPendingEvents(); - wxENTER_CRIT_SECT( *wxPendingEventsLocker ); + wxLEAVE_CRIT_SECT(m_handlersWithPendingEventsLocker); + + // NOTE: we always call ProcessPendingEvents() on the first event handler + // with pending events because handlers auto-remove themselves + // from this list (see RemovePendingEventHandler) if they have no + // more pending events. + m_handlersWithPendingEvents[0]->ProcessPendingEvents(); - node = wxPendingEvents->GetFirst(); + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); } - wxLEAVE_CRIT_SECT( *wxPendingEventsLocker ); + // now the wxHandlersWithPendingEvents is surely empty; however some event + // handlers may have moved themselves into wxHandlersWithPendingDelayedEvents + // because of a selective wxYield call in progress. + // Now we need to move them back to wxHandlersWithPendingEvents so the next + // call to this function has the chance of processing them: + if (!m_handlersWithPendingDelayedEvents.IsEmpty()) + { + WX_APPEND_ARRAY(m_handlersWithPendingEvents, m_handlersWithPendingDelayedEvents); + m_handlersWithPendingDelayedEvents.Clear(); + } + + wxLEAVE_CRIT_SECT(m_handlersWithPendingEventsLocker); } -int wxAppConsole::FilterEvent(wxEvent& WXUNUSED(event)) +void wxAppConsoleBase::DeletePendingEvents() { - // process the events normally by default - return -1; + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); + + wxCHECK_RET( m_handlersWithPendingDelayedEvents.IsEmpty(), + "this helper list should be empty" ); + + for (unsigned int i=0; iDeletePendingEvents(); + + m_handlersWithPendingEvents.Clear(); + + wxLEAVE_CRIT_SECT(m_handlersWithPendingEventsLocker); } // ---------------------------------------------------------------------------- @@ -297,16 +489,61 @@ int wxAppConsole::FilterEvent(wxEvent& WXUNUSED(event)) #if wxUSE_EXCEPTIONS void -wxAppConsole::HandleEvent(wxEvtHandler *handler, - wxEventFunction func, - wxEvent& event) const +wxAppConsoleBase::HandleEvent(wxEvtHandler *handler, + wxEventFunction func, + wxEvent& event) const { // by default, simply call the handler (handler->*func)(event); } -bool -wxAppConsole::OnExceptionInMainLoop() +void wxAppConsoleBase::CallEventHandler(wxEvtHandler *handler, + wxEventFunctor& functor, + wxEvent& event) const +{ + // If the functor holds a method then, for backward compatibility, call + // HandleEvent(): + wxEventFunction eventFunction = functor.GetEvtMethod(); + + if ( eventFunction ) + HandleEvent(handler, eventFunction, event); + else + functor(handler, event); +} + +void wxAppConsoleBase::OnUnhandledException() +{ +#ifdef __WXDEBUG__ + // we're called from an exception handler so we can re-throw the exception + // to recover its type + wxString what; + try + { + throw; + } +#if wxUSE_STL + catch ( std::exception& e ) + { + what.Printf("std::exception of type \"%s\", what() = \"%s\"", + typeid(e).name(), e.what()); + } +#endif // wxUSE_STL + catch ( ... ) + { + what = "unknown exception"; + } + + wxMessageOutputBest().Printf( + "*** Caught unhandled %s; terminating\n", what + ); +#endif // __WXDEBUG__ +} + +// ---------------------------------------------------------------------------- +// exceptions support +// ---------------------------------------------------------------------------- + +bool wxAppConsoleBase::OnExceptionInMainLoop() { throw; @@ -324,17 +561,17 @@ wxAppConsole::OnExceptionInMainLoop() #if wxUSE_CMDLINE_PARSER -#define OPTION_VERBOSE _T("verbose") +#define OPTION_VERBOSE "verbose" -void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser) +void wxAppConsoleBase::OnInitCmdLine(wxCmdLineParser& parser) { // the standard command line options static const wxCmdLineEntryDesc cmdLineDesc[] = { { wxCMD_LINE_SWITCH, - _T("h"), - _T("help"), + "h", + "help", gettext_noop("show this help message"), wxCMD_LINE_VAL_NONE, wxCMD_LINE_OPTION_HELP @@ -343,7 +580,7 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser) #if wxUSE_LOG { wxCMD_LINE_SWITCH, - _T(""), + NULL, OPTION_VERBOSE, gettext_noop("generate verbose log messages"), wxCMD_LINE_VAL_NONE, @@ -352,20 +589,13 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser) #endif // wxUSE_LOG // terminator - { - wxCMD_LINE_NONE, - _T(""), - _T(""), - _T(""), - wxCMD_LINE_VAL_NONE, - 0x0 - } + wxCMD_LINE_DESC_END }; parser.SetDesc(cmdLineDesc); } -bool wxAppConsole::OnCmdLineParsed(wxCmdLineParser& parser) +bool wxAppConsoleBase::OnCmdLineParsed(wxCmdLineParser& parser) { #if wxUSE_LOG if ( parser.Found(OPTION_VERBOSE) ) @@ -379,18 +609,18 @@ bool wxAppConsole::OnCmdLineParsed(wxCmdLineParser& parser) return true; } -bool wxAppConsole::OnCmdLineHelp(wxCmdLineParser& parser) +bool wxAppConsoleBase::OnCmdLineHelp(wxCmdLineParser& parser) { parser.Usage(); - return FALSE; + return false; } -bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser) +bool wxAppConsoleBase::OnCmdLineError(wxCmdLineParser& parser) { parser.Usage(); - return FALSE; + return false; } #endif // wxUSE_CMDLINE_PARSER @@ -400,8 +630,8 @@ bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser) // ---------------------------------------------------------------------------- /* static */ -bool wxAppConsole::CheckBuildOptions(const char *optionsSignature, - const char *componentName) +bool wxAppConsoleBase::CheckBuildOptions(const char *optionsSignature, + const char *componentName) { #if 0 // can't use wxLogTrace, not up and running yet printf("checking build options object '%s' (ptr %p) in '%s'\n", @@ -421,24 +651,39 @@ bool wxAppConsole::CheckBuildOptions(const char *optionsSignature, wxLogFatalError(msg.c_str()); // normally wxLogFatalError doesn't return - return FALSE; + return false; } -#undef wxCMP - return TRUE; + return true; } -#ifdef __WXDEBUG__ - -void wxAppConsole::OnAssert(const wxChar *file, - int line, - const wxChar *cond, - const wxChar *msg) +void wxAppConsoleBase::OnAssertFailure(const wxChar *file, + int line, + const wxChar *func, + const wxChar *cond, + const wxChar *msg) { - ShowAssertDialog(file, line, cond, msg, GetTraits()); +#if wxDEBUG_LEVEL + ShowAssertDialog(file, line, func, cond, msg, GetTraits()); +#else + // this function is still present even in debug level 0 build for ABI + // compatibility reasons but is never called there and so can simply do + // nothing in it + wxUnusedVar(file); + wxUnusedVar(line); + wxUnusedVar(func); + wxUnusedVar(cond); + wxUnusedVar(msg); +#endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL } -#endif // __WXDEBUG__ +void wxAppConsoleBase::OnAssert(const wxChar *file, + int line, + const wxChar *cond, + const wxChar *msg) +{ + OnAssertFailure(file, line, NULL, cond, msg); +} // ============================================================================ // other classes implementations @@ -477,12 +722,10 @@ wxRendererNative *wxConsoleAppTraitsBase::CreateRenderer() return NULL; } -#ifdef __WXDEBUG__ bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString& msg) { return wxAppTraitsBase::ShowAssertDialog(msg); } -#endif bool wxConsoleAppTraitsBase::HasStderr() { @@ -500,25 +743,142 @@ void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject * WXUNUSED(object) // nothing to do } -#if wxUSE_SOCKETS -GSocketGUIFunctionsTable* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable() +// ---------------------------------------------------------------------------- +// wxAppTraits +// ---------------------------------------------------------------------------- + +#if wxUSE_INTL +void wxAppTraitsBase::SetLocale() { - return NULL; + wxSetlocale(LC_ALL, ""); + wxUpdateLocaleIsUtf8(); } #endif -// ---------------------------------------------------------------------------- -// wxAppTraits -// ---------------------------------------------------------------------------- +#if wxUSE_THREADS +void wxMutexGuiEnterImpl(); +void wxMutexGuiLeaveImpl(); -#ifdef __WXDEBUG__ +void wxAppTraitsBase::MutexGuiEnter() +{ + wxMutexGuiEnterImpl(); +} + +void wxAppTraitsBase::MutexGuiLeave() +{ + wxMutexGuiLeaveImpl(); +} + +void WXDLLIMPEXP_BASE wxMutexGuiEnter() +{ + wxAppTraits * const traits = wxAppConsoleBase::GetTraitsIfExists(); + if ( traits ) + traits->MutexGuiEnter(); +} + +void WXDLLIMPEXP_BASE wxMutexGuiLeave() +{ + wxAppTraits * const traits = wxAppConsoleBase::GetTraitsIfExists(); + if ( traits ) + traits->MutexGuiLeave(); +} +#endif // wxUSE_THREADS -bool wxAppTraitsBase::ShowAssertDialog(const wxString& msg) +bool wxAppTraitsBase::ShowAssertDialog(const wxString& msgOriginal) { +#if wxDEBUG_LEVEL + wxString msg = msgOriginal; + +#if wxUSE_STACKWALKER +#if !defined(__WXMSW__) + // on Unix stack frame generation may take some time, depending on the + // size of the executable mainly... warn the user that we are working + wxFprintf(stderr, wxT("[Debug] Generating a stack trace... please wait")); + fflush(stderr); +#endif + + const wxString stackTrace = GetAssertStackTrace(); + if ( !stackTrace.empty() ) + msg << _T("\n\nCall stack:\n") << stackTrace; +#endif // wxUSE_STACKWALKER + return DoShowAssertDialog(msg); +#else // !wxDEBUG_LEVEL + wxUnusedVar(msgOriginal); + + return false; +#endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL } -#endif // __WXDEBUG__ +#if wxUSE_STACKWALKER +wxString wxAppTraitsBase::GetAssertStackTrace() +{ +#if wxDEBUG_LEVEL + wxString stackTrace; + + class StackDump : public wxStackWalker + { + public: + StackDump() { } + + const wxString& GetStackTrace() const { return m_stackTrace; } + + protected: + virtual void OnStackFrame(const wxStackFrame& frame) + { + m_stackTrace << wxString::Format + ( + _T("[%02d] "), + wx_truncate_cast(int, frame.GetLevel()) + ); + + wxString name = frame.GetName(); + if ( !name.empty() ) + { + m_stackTrace << wxString::Format(_T("%-40s"), name.c_str()); + } + else + { + m_stackTrace << wxString::Format(_T("%p"), frame.GetAddress()); + } + + if ( frame.HasSourceLocation() ) + { + m_stackTrace << _T('\t') + << frame.GetFileName() + << _T(':') + << frame.GetLine(); + } + + m_stackTrace << _T('\n'); + } + + private: + wxString m_stackTrace; + }; + + // don't show more than maxLines or we could get a dialog too tall to be + // shown on screen: 20 should be ok everywhere as even with 15 pixel high + // characters it is still only 300 pixels... + static const int maxLines = 20; + + StackDump dump; + dump.Walk(2, maxLines); // don't show OnAssert() call itself + stackTrace = dump.GetStackTrace(); + + const int count = stackTrace.Freq(wxT('\n')); + for ( int i = 0; i < count - maxLines; i++ ) + stackTrace = stackTrace.BeforeLast(wxT('\n')); + + return stackTrace; +#else // !wxDEBUG_LEVEL + // this function is still present for ABI-compatibility even in debug level + // 0 build but is not used there and so can simply do nothing + return wxString(); +#endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL +} +#endif // wxUSE_STACKWALKER + // ============================================================================ // global functions implementation @@ -546,25 +906,21 @@ void wxWakeUpIdle() //else: do nothing, what can we do? } -#ifdef __WXDEBUG__ - // wxASSERT() helper bool wxAssertIsEqual(int x, int y) { return x == y; } +#if wxDEBUG_LEVEL + // break into the debugger void wxTrap() { #if defined(__WXMSW__) && !defined(__WXMICROWIN__) DebugBreak(); -#elif defined(__WXMAC__) && !defined(__DARWIN__) - #if __powerc - Debugger(); - #else - SysBreak(); - #endif +#elif defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS + Debugger(); #elif defined(__UNIX__) raise(SIGTRAP); #else @@ -572,53 +928,122 @@ void wxTrap() #endif // Win/Unix } -void wxAssert(int cond, - const wxChar *szFile, - int nLine, - const wxChar *szCond, - const wxChar *szMsg) -{ - if ( !cond ) - wxOnAssert(szFile, nLine, szCond, szMsg); -} - -// this function is called when an assert fails -void wxOnAssert(const wxChar *szFile, - int nLine, - const wxChar *szCond, - const wxChar *szMsg) +// default assert handler +static void +wxDefaultAssertHandler(const wxString& file, + int line, + const wxString& func, + const wxString& cond, + const wxString& msg) { // FIXME MT-unsafe - static bool s_bInAssert = FALSE; + static int s_bInAssert = 0; - if ( s_bInAssert ) + wxRecursionGuard guard(s_bInAssert); + if ( guard.IsInside() ) { - // He-e-e-e-elp!! we're trapped in endless loop + // can't use assert here to avoid infinite loops, so just trap wxTrap(); - s_bInAssert = FALSE; - return; } - s_bInAssert = TRUE; - if ( !wxTheApp ) { // by default, show the assert dialog box -- we can't customize this // behaviour - ShowAssertDialog(szFile, nLine, szCond, szMsg); + ShowAssertDialog(file, line, func, cond, msg); } else { // let the app process it as it wants - wxTheApp->OnAssert(szFile, nLine, szCond, szMsg); + // FIXME-UTF8: use wc_str(), not c_str(), when ANSI build is removed + wxTheApp->OnAssertFailure(file.c_str(), line, func.c_str(), + cond.c_str(), msg.c_str()); } +} + +wxAssertHandler_t wxTheAssertHandler = wxDefaultAssertHandler; - s_bInAssert = FALSE; +void wxOnAssert(const wxString& file, + int line, + const wxString& func, + const wxString& cond, + const wxString& msg) +{ + wxTheAssertHandler(file, line, func, cond, msg); } -#endif // __WXDEBUG__ +void wxOnAssert(const wxString& file, + int line, + const wxString& func, + const wxString& cond) +{ + wxTheAssertHandler(file, line, func, cond, wxString()); +} + +void wxOnAssert(const wxChar *file, + int line, + const char *func, + const wxChar *cond, + const wxChar *msg) +{ + // this is the backwards-compatible version (unless we don't use Unicode) + // so it could be called directly from the user code and this might happen + // even when wxTheAssertHandler is NULL +#if wxUSE_UNICODE + if ( wxTheAssertHandler ) +#endif // wxUSE_UNICODE + wxTheAssertHandler(file, line, func, cond, msg); +} + +void wxOnAssert(const char *file, + int line, + const char *func, + const char *cond, + const wxString& msg) +{ + wxTheAssertHandler(file, line, func, cond, msg); +} + +void wxOnAssert(const char *file, + int line, + const char *func, + const char *cond, + const wxCStrData& msg) +{ + wxTheAssertHandler(file, line, func, cond, msg); +} + +#if wxUSE_UNICODE +void wxOnAssert(const char *file, + int line, + const char *func, + const char *cond) +{ + wxTheAssertHandler(file, line, func, cond, wxString()); +} + +void wxOnAssert(const char *file, + int line, + const char *func, + const char *cond, + const char *msg) +{ + wxTheAssertHandler(file, line, func, cond, msg); +} + +void wxOnAssert(const char *file, + int line, + const char *func, + const char *cond, + const wxChar *msg) +{ + wxTheAssertHandler(file, line, func, cond, msg); +} +#endif // wxUSE_UNICODE + +#endif // wxDEBUG_LEVEL // ============================================================================ // private functions implementation @@ -639,19 +1064,25 @@ static void LINKAGEMODE SetTraceMasks() #endif // wxUSE_LOG } +#endif // __WXDEBUG__ + +#if wxDEBUG_LEVEL + +static bool DoShowAssertDialog(const wxString& msg) { // under MSW we can show the dialog even in the console mode #if defined(__WXMSW__) && !defined(__WXMICROWIN__) wxString msgDlg(msg); - // this message is intentionally not translated -- it is for - // developpers only + // this message is intentionally not translated -- it is for developers + // only -- and the less code we use here, less is the danger of recursively + // asserting and dying msgDlg += wxT("\nDo you want to stop the program?\n") wxT("You can also choose [Cancel] to suppress ") wxT("further warnings."); - switch ( ::MessageBox(NULL, msgDlg, _T("wxWidgets Debug Alert"), + switch ( ::MessageBox(NULL, msgDlg.wx_str(), _T("wxWidgets Debug Alert"), MB_YESNOCANCEL | MB_ICONSTOP ) ) { case IDYES: @@ -676,16 +1107,17 @@ bool DoShowAssertDialog(const wxString& msg) return false; } -// show the assert modal dialog +// show the standard assert dialog static -void ShowAssertDialog(const wxChar *szFile, - int nLine, - const wxChar *szCond, - const wxChar *szMsg, +void ShowAssertDialog(const wxString& file, + int line, + const wxString& func, + const wxString& cond, + const wxString& msgUser, wxAppTraits *traits) { // this variable can be set to true to suppress "assert failure" messages - static bool s_bNoAsserts = FALSE; + static bool s_bNoAsserts = false; wxString msg; msg.reserve(2048); @@ -693,11 +1125,16 @@ void ShowAssertDialog(const wxChar *szFile, // make life easier for people using VC++ IDE by using this format: like // this, clicking on the message will take us immediately to the place of // the failed assert - msg.Printf(wxT("%s(%d): assert \"%s\" failed"), szFile, nLine, szCond); + msg.Printf(wxT("%s(%d): assert \"%s\" failed"), file, line, cond); + + // add the function name, if any + if ( !func.empty() ) + msg << _T(" in ") << func << _T("()"); - if ( szMsg ) + // and the message itself + if ( !msgUser.empty() ) { - msg << _T(": ") << szMsg; + msg << _T(": ") << msgUser; } else // no message given { @@ -713,7 +1150,7 @@ void ShowAssertDialog(const wxChar *szFile, #if defined(__WXMSW__) && !defined(__WXMICROWIN__) msg << wxT("\r\n"); - OutputDebugString(msg ); + OutputDebugString(msg.wx_str()); #else // send to stderr wxFprintf(stderr, wxT("%s\n"), msg.c_str()); @@ -722,6 +1159,7 @@ void ShowAssertDialog(const wxChar *szFile, // He-e-e-e-elp!! we're asserting in a child thread wxTrap(); } + else #endif // wxUSE_THREADS if ( !s_bNoAsserts ) @@ -742,5 +1180,4 @@ void ShowAssertDialog(const wxChar *szFile, } } -#endif // __WXDEBUG__ - +#endif // wxDEBUG_LEVEL