X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/121aea4614b46a02faa414e9067500f43a20130b..a57ea0102f67075861696d97e784c1b68f12fc51:/src/common/appbase.cpp diff --git a/src/common/appbase.cpp b/src/common/appbase.cpp index c0af2ac256..9ac78f57f6 100644 --- a/src/common/appbase.cpp +++ b/src/common/appbase.cpp @@ -1,12 +1,12 @@ /////////////////////////////////////////////////////////////////////////////// -// 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) // RCS-ID: $Id$ // Copyright: (c) 2003 Vadim Zeitlin -// License: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -25,56 +25,55 @@ #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/sysopt.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(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS - // For MacTypes.h for Debugger function - #include -#endif - -#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__ - -#ifdef __WXDEBUG__ +#if wxDEBUG_LEVEL #if wxUSE_STACKWALKER #include "wx/stackwalk.h" #ifdef __WXMSW__ #include "wx/msw/debughlp.h" #endif #endif // wxUSE_STACKWALKER -#endif // __WXDEBUG__ + + #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 @@ -87,19 +86,22 @@ // 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__ @@ -108,23 +110,36 @@ // global vars // ---------------------------------------------------------------------------- -wxAppConsole *wxAppConsole::ms_appInstance = NULL; +wxAppConsole *wxAppConsoleBase::ms_appInstance = NULL; + +wxAppInitializerFunction wxAppConsoleBase::ms_appInitFn = NULL; + +wxSocketManager *wxAppTraitsBase::ms_manager = NULL; + +WXDLLIMPEXP_DATA_BASE(wxList) wxPendingDelete; + +// ---------------------------------------------------------------------------- +// 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(); @@ -132,47 +147,84 @@ wxAppConsole::wxAppConsole() // In unicode mode the SetTraceMasks call can cause an apptraits to be // created, but since we are still in the constructor the wrong kind will // be created for GUI apps. Destroy it so it can be created again later. - delete m_traits; - m_traits = NULL; + wxDELETE(m_traits); #endif #endif + + wxEvtHandler::AddFilter(this); } -wxAppConsole::~wxAppConsole() +wxAppConsoleBase::~wxAppConsoleBase() { + wxEvtHandler::RemoveFilter(this); + + // we're being destroyed and using this object from now on may not work or + // even crash so don't leave dangling pointers to it + ms_appInstance = NULL; + delete m_traits; } // ---------------------------------------------------------------------------- -// initilization/cleanup +// initialization/cleanup // ---------------------------------------------------------------------------- -bool wxAppConsole::Initialize(int& argc, wxChar **argv) +bool wxAppConsoleBase::Initialize(int& WXUNUSED(argc), wxChar **WXUNUSED(argv)) { - // remember the command line arguments - this->argc = argc; - this->argv = argv; +#if wxUSE_INTL + GetTraits()->SetLocale(); +#endif // wxUSE_INTL + + return true; +} +wxString wxAppConsoleBase::GetAppName() const +{ + wxString name = m_appName; #ifndef __WXPALMOS__ - if ( m_appName.empty() && argv ) + if ( name.empty() ) { - // the application name is, by default, the name of its executable file - wxFileName::SplitPath(argv[0], NULL, &m_appName, NULL); + if ( argv ) + { + // the application name is, by default, the name of its executable file + wxFileName::SplitPath(argv[0], NULL, &name, NULL); + } } -#endif +#endif // !__WXPALMOS__ + return name; +} - return true; +wxString wxAppConsoleBase::GetAppDisplayName() const +{ + // use the explicitly provided display name, if any + if ( !m_appDisplayName.empty() ) + return m_appDisplayName; + + // if the application name was explicitly set, use it as is as capitalizing + // it won't always produce good results + if ( !m_appName.empty() ) + return m_appName; + + // if neither is set, use the capitalized version of the program file as + // it's the most reasonable default + return GetAppName().Capitalize(); +} + +wxEventLoopBase *wxAppConsoleBase::CreateMainLoop() +{ + return GetTraits()->CreateEventLoop(); } -void wxAppConsole::CleanUp() +void wxAppConsoleBase::CleanUp() { + wxDELETE(m_mainLoop); } // ---------------------------------------------------------------------------- // OnXXX() callbacks // ---------------------------------------------------------------------------- -bool wxAppConsole::OnInit() +bool wxAppConsoleBase::OnInit() { #if wxUSE_CMDLINE_PARSER wxCmdLineParser parser(argc, argv); @@ -202,114 +254,330 @@ bool wxAppConsole::OnInit() return true; } -int wxAppConsole::OnExit() +int wxAppConsoleBase::OnRun() +{ + return MainLoop(); +} + +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 ) { m_traits = CreateTraits(); - wxASSERT_MSG( m_traits, _T("wxApp::CreateTraits() failed?") ); + wxASSERT_MSG( m_traits, wxT("wxApp::CreateTraits() failed?") ); } 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; +} -#if wxUSE_LOG +// ---------------------------------------------------------------------------- +// wxEventLoop redirection +// ---------------------------------------------------------------------------- -wxLog *wxAppConsole::CreateLogTarget() +int wxAppConsoleBase::MainLoop() { - wxAppTraits *traits = GetTraits(); - return traits ? traits->CreateLogTarget() : NULL; + wxEventLoopBaseTiedPtr mainLoop(&m_mainLoop, CreateMainLoop()); + + return m_mainLoop ? m_mainLoop->Run() : -1; } -#endif // wxUSE_LOG +void wxAppConsoleBase::ExitMainLoop() +{ + // 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); + } +} + +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(); -wxMessageOutput *wxAppConsole::CreateMessageOutput() + return loop && loop->Pending(); +} + +bool wxAppConsoleBase::Dispatch() { - wxAppTraits *traits = GetTraits(); - return traits ? traits->CreateMessageOutput() : NULL; + // see comment in Pending() + wxEventLoopBase * const loop = wxEventLoopBase::GetActive(); + + return loop && loop->Dispatch(); } -#endif // WXWIN_COMPATIBILITY_2_4 +bool wxAppConsoleBase::Yield(bool onlyIfNeeded) +{ + wxEventLoopBase * const loop = wxEventLoopBase::GetActive(); + if ( loop ) + return loop->Yield(onlyIfNeeded); + + wxScopedPtr tmpLoop(CreateMainLoop()); + return tmpLoop->Yield(onlyIfNeeded); +} + +void wxAppConsoleBase::WakeUpIdle() +{ + wxEventLoopBase * const loop = wxEventLoopBase::GetActive(); + + if ( loop ) + loop->WakeUp(); +} + +bool wxAppConsoleBase::ProcessIdle() +{ + // synthesize an idle event and check if more of them are needed + wxIdleEvent event; + event.SetEventObject(this); + ProcessEvent(event); + +#if wxUSE_LOG + // flush the logged messages if any (do this after processing the events + // which could have logged new messages) + wxLog::FlushActive(); +#endif + + // Garbage collect all objects previously scheduled for destruction. + DeletePendingObjects(); + + return event.MoreRequested(); +} + +bool wxAppConsoleBase::UsesEventLoop() const +{ + // in console applications we don't know whether we're going to have an + // event loop so assume we won't -- unless we already have one running + return wxEventLoopBase::GetActive() != NULL; +} // ---------------------------------------------------------------------------- -// event processing +// events // ---------------------------------------------------------------------------- -void wxAppConsole::ProcessPendingEvents() +/* static */ +bool wxAppConsoleBase::IsMainLoopRunning() { -#if wxUSE_THREADS - if ( !wxPendingEventsLocker ) - return; -#endif - - // 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; +} + +int wxAppConsoleBase::FilterEvent(wxEvent& WXUNUSED(event)) +{ + // process the events normally by default + return Event_Skip; +} + +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 ( !wxPendingEvents ) + 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); + + // 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); +} - // In ProcessPendingEvents(), new handlers might be add - // and we can safely leave the critical section here. - wxLEAVE_CRIT_SECT( *wxPendingEventsLocker ); - - handler->ProcessPendingEvents(); +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); - wxENTER_CRIT_SECT( *wxPendingEventsLocker ); + 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 ) + { + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); - node = wxPendingEvents->GetFirst(); + 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(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(); + + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); + } + + // 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); } +} + +void wxAppConsoleBase::DeletePendingEvents() +{ + wxENTER_CRIT_SECT(m_handlersWithPendingEventsLocker); - wxLEAVE_CRIT_SECT( *wxPendingEventsLocker ); + 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); } -int wxAppConsole::FilterEvent(wxEvent& WXUNUSED(event)) +// ---------------------------------------------------------------------------- +// delayed objects destruction +// ---------------------------------------------------------------------------- + +bool wxAppConsoleBase::IsScheduledForDestruction(wxObject *object) const { - // process the events normally by default - return -1; + return wxPendingDelete.Member(object); +} + +void wxAppConsoleBase::ScheduleForDestruction(wxObject *object) +{ + if ( !UsesEventLoop() ) + { + // we won't be able to delete it later so do it right now + delete object; + return; + } + //else: we either already have or will soon start an event loop + + if ( !wxPendingDelete.Member(object) ) + wxPendingDelete.Append(object); +} + +void wxAppConsoleBase::DeletePendingObjects() +{ + wxList::compatibility_iterator node = wxPendingDelete.GetFirst(); + while (node) + { + wxObject *obj = node->GetData(); + + // remove it from the list first so that if we get back here somehow + // during the object deletion (e.g. wxYield called from its dtor) we + // wouldn't try to delete it the second time + if ( wxPendingDelete.Member(obj) ) + wxPendingDelete.Erase(node); + + delete obj; + + // Deleting one object may have deleted other pending + // objects, so start from beginning of list again. + node = wxPendingDelete.GetFirst(); + } } // ---------------------------------------------------------------------------- @@ -319,16 +587,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; @@ -346,17 +659,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 @@ -365,7 +678,7 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser) #if wxUSE_LOG { wxCMD_LINE_SWITCH, - wxEmptyString, + NULL, OPTION_VERBOSE, gettext_noop("generate verbose log messages"), wxCMD_LINE_VAL_NONE, @@ -374,20 +687,13 @@ void wxAppConsole::OnInitCmdLine(wxCmdLineParser& parser) #endif // wxUSE_LOG // terminator - { - wxCMD_LINE_NONE, - wxEmptyString, - wxEmptyString, - wxEmptyString, - 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) ) @@ -401,14 +707,14 @@ bool wxAppConsole::OnCmdLineParsed(wxCmdLineParser& parser) return true; } -bool wxAppConsole::OnCmdLineHelp(wxCmdLineParser& parser) +bool wxAppConsoleBase::OnCmdLineHelp(wxCmdLineParser& parser) { parser.Usage(); return false; } -bool wxAppConsole::OnCmdLineError(wxCmdLineParser& parser) +bool wxAppConsoleBase::OnCmdLineError(wxCmdLineParser& parser) { parser.Usage(); @@ -422,8 +728,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", @@ -437,7 +743,7 @@ bool wxAppConsole::CheckBuildOptions(const char *optionsSignature, wxString progName = wxString::FromAscii(componentName); wxString msg; - msg.Printf(_T("Mismatch between the program and library build versions detected.\nThe library used %s,\nand %s used %s."), + msg.Printf(wxT("Mismatch between the program and library build versions detected.\nThe library used %s,\nand %s used %s."), lib.c_str(), progName.c_str(), prog.c_str()); wxLogFatalError(msg.c_str()); @@ -445,32 +751,38 @@ bool wxAppConsole::CheckBuildOptions(const char *optionsSignature, // normally wxLogFatalError doesn't return return false; } -#undef wxCMP 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__ - -#if WXWIN_COMPATIBILITY_2_4 - -bool wxAppConsole::CheckBuildOptions(const wxBuildOptions& buildOptions) +void wxAppConsoleBase::OnAssert(const wxChar *file, + int line, + const wxChar *cond, + const wxChar *msg) { - return CheckBuildOptions(buildOptions.m_signature, "your program"); + OnAssertFailure(file, line, NULL, cond, msg); } -#endif - // ============================================================================ // other classes implementations // ============================================================================ @@ -508,12 +820,10 @@ wxRendererNative *wxConsoleAppTraitsBase::CreateRenderer() return NULL; } -#ifdef __WXDEBUG__ bool wxConsoleAppTraitsBase::ShowAssertDialog(const wxString& msg) { return wxAppTraitsBase::ShowAssertDialog(msg); } -#endif bool wxConsoleAppTraitsBase::HasStderr() { @@ -521,35 +831,148 @@ bool wxConsoleAppTraitsBase::HasStderr() return true; } -void wxConsoleAppTraitsBase::ScheduleForDestroy(wxObject *object) +// ---------------------------------------------------------------------------- +// wxAppTraits +// ---------------------------------------------------------------------------- + +#if wxUSE_INTL +void wxAppTraitsBase::SetLocale() +{ + wxSetlocale(LC_ALL, ""); + wxUpdateLocaleIsUtf8(); +} +#endif + +#if wxUSE_THREADS +void wxMutexGuiEnterImpl(); +void wxMutexGuiLeaveImpl(); + +void wxAppTraitsBase::MutexGuiEnter() { - delete object; + wxMutexGuiEnterImpl(); } -void wxConsoleAppTraitsBase::RemoveFromPendingDelete(wxObject * WXUNUSED(object)) +void wxAppTraitsBase::MutexGuiLeave() { - // nothing to do + wxMutexGuiLeaveImpl(); } -#if wxUSE_SOCKETS -GSocketGUIFunctionsTable* wxConsoleAppTraitsBase::GetSocketGUIFunctionsTable() +void WXDLLIMPEXP_BASE wxMutexGuiEnter() { - return NULL; + wxAppTraits * const traits = wxAppConsoleBase::GetTraitsIfExists(); + if ( traits ) + traits->MutexGuiEnter(); } -#endif -// ---------------------------------------------------------------------------- -// wxAppTraits -// ---------------------------------------------------------------------------- +void WXDLLIMPEXP_BASE wxMutexGuiLeave() +{ + wxAppTraits * const traits = wxAppConsoleBase::GetTraitsIfExists(); + if ( traits ) + traits->MutexGuiLeave(); +} +#endif // wxUSE_THREADS -#ifdef __WXDEBUG__ +bool wxAppTraitsBase::ShowAssertDialog(const wxString& msgOriginal) +{ +#if wxDEBUG_LEVEL + wxString msg; + +#if wxUSE_STACKWALKER + const wxString stackTrace = GetAssertStackTrace(); + if ( !stackTrace.empty() ) + { + msg << wxT("\n\nCall stack:\n") << stackTrace; -bool wxAppTraitsBase::ShowAssertDialog(const wxString& msg) + wxMessageOutputDebug().Output(msg); + } +#endif // wxUSE_STACKWALKER + + return DoShowAssertDialog(msgOriginal + msg); +#else // !wxDEBUG_LEVEL + wxUnusedVar(msgOriginal); + + return false; +#endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL +} + +#if wxUSE_STACKWALKER +wxString wxAppTraitsBase::GetAssertStackTrace() { - return DoShowAssertDialog(msg); +#if wxDEBUG_LEVEL + +#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, "Collecting stack trace information, please wait..."); + fflush(stderr); +#endif // !__WXMSW__ + + + 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 + ( + wxT("[%02d] "), + wx_truncate_cast(int, frame.GetLevel()) + ); + + wxString name = frame.GetName(); + if ( !name.empty() ) + { + m_stackTrace << wxString::Format(wxT("%-40s"), name.c_str()); + } + else + { + m_stackTrace << wxString::Format(wxT("%p"), frame.GetAddress()); + } + + if ( frame.HasSourceLocation() ) + { + m_stackTrace << wxT('\t') + << frame.GetFileName() + << wxT(':') + << frame.GetLine(); + } + + m_stackTrace << wxT('\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 -#endif // __WXDEBUG__ // ============================================================================ // global functions implementation @@ -577,25 +1000,19 @@ 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__) @@ -605,53 +1022,131 @@ void wxTrap() #endif // Win/Unix } -void wxAssert(int cond, - 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) { - if ( !cond ) - wxOnAssert(szFile, nLine, szCond, szMsg); -} + // If this option is set, we should abort immediately when assert happens. + if ( wxSystemOptions::GetOptionInt("exit-on-assert") ) + abort(); -// this function is called when an assert fails -void wxOnAssert(const wxChar *szFile, - int nLine, - const wxChar *szCond, - const wxChar *szMsg) -{ // 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 wxSetDefaultAssertHandler() +{ + wxTheAssertHandler = wxDefaultAssertHandler; } -#endif // __WXDEBUG__ +void wxOnAssert(const wxString& file, + int line, + const wxString& func, + const wxString& cond, + const wxString& msg) +{ + wxTheAssertHandler(file, line, func, cond, msg); +} + +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 @@ -672,19 +1167,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(), wxT("wxWidgets Debug Alert"), MB_YESNOCANCEL | MB_ICONSTOP ) ) { case IDYES: @@ -698,91 +1199,20 @@ bool DoShowAssertDialog(const wxString& msg) //case IDNO: nothing to do } #else // !__WXMSW__ - wxFprintf(stderr, wxT("%s\n"), msg.c_str()); - fflush(stderr); - - // TODO: ask the user to enter "Y" or "N" on the console? - wxTrap(); + wxUnusedVar(msg); #endif // __WXMSW__/!__WXMSW__ - // continue with the asserts + // continue with the asserts by default return false; } -#if wxUSE_STACKWALKER -static wxString GetAssertStackTrace() -{ - wxString stackTrace; - -#if wxUSE_DBGHELP - // check that we can get the stack trace before trying to do it - if ( !wxDbgHelpDLL::Init() ) - return stackTrace; -#endif - - 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] "), frame.GetLevel()); - - wxString name = frame.GetName(); - if ( !name.empty() ) - { - m_stackTrace << wxString::Format(_T("%-40s"), name.c_str()); - } - else - { - m_stackTrace << wxString::Format - ( - _T("0x%08lx"), - (unsigned long)frame.GetAddress() - ); - } - - if ( frame.HasSourceLocation() ) - { - m_stackTrace << _T('\t') - << frame.GetFileName() - << _T(':') - << frame.GetLine(); - } - - m_stackTrace << _T('\n'); - } - - private: - wxString m_stackTrace; - }; - - StackDump dump; - dump.Walk(5); // don't show OnAssert() call itself - stackTrace = dump.GetStackTrace(); - - // 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; - const int count = stackTrace.Freq(wxT('\n')); - for ( int i = 0; i < count - maxLines; i++ ) - stackTrace = stackTrace.BeforeLast(wxT('\n')); - - return stackTrace; -} -#endif // wxUSE_STACKWALKER - -// 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 @@ -794,51 +1224,36 @@ 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); - if ( szMsg ) + // add the function name, if any + if ( !func.empty() ) + msg << wxT(" in ") << func << wxT("()"); + + // and the message itself + if ( !msgUser.empty() ) { - msg << _T(": ") << szMsg; + msg << wxT(": ") << msgUser; } else // no message given { - msg << _T('.'); - } - -#if wxUSE_STACKWALKER - const wxString stackTrace = GetAssertStackTrace(); - if ( !stackTrace.empty() ) - { - msg << _T("\n\nCall stack:\n") << stackTrace; + msg << wxT('.'); } -#endif // wxUSE_STACKWALKER #if wxUSE_THREADS // if we are not in the main thread, output the assert directly and trap // since dialogs cannot be displayed if ( !wxThread::IsMain() ) { - msg += wxT(" [in child thread]"); - -#if defined(__WXMSW__) && !defined(__WXMICROWIN__) - msg << wxT("\r\n"); - OutputDebugString(msg ); -#else - // send to stderr - wxFprintf(stderr, wxT("%s\n"), msg.c_str()); - fflush(stderr); -#endif - // He-e-e-e-elp!! we're asserting in a child thread - wxTrap(); + msg += wxString::Format(" [in thread %lx]", wxThread::GetCurrentId()); } - else #endif // wxUSE_THREADS + // log the assert in any case + wxMessageOutputDebug().Output(msg); + if ( !s_bNoAsserts ) { - // send it to the normal log destination - wxLogDebug(_T("%s"), msg.c_str()); - if ( traits ) { // delegate showing assert dialog (if possible) to that class @@ -852,5 +1267,4 @@ void ShowAssertDialog(const wxChar *szFile, } } -#endif // __WXDEBUG__ - +#endif // wxDEBUG_LEVEL