X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bc385ba9ebd0185d5bc3dcbf9fb3f35e3eac4d7a..8cbc59fe84f046685b873cf58f6c56debe59de1c:/src/common/init.cpp diff --git a/src/common/init.cpp b/src/common/init.cpp index 78576fb3c5..7af0af2157 100644 --- a/src/common/init.cpp +++ b/src/common/init.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: common/init.cpp +// Name: src/common/init.cpp // Purpose: initialisation for the library // Author: Vadim Zeitlin // Modified by: @@ -20,215 +20,518 @@ #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop + #pragma hdrstop #endif //__BORLANDC__ #ifndef WX_PRECOMP #include "wx/app.h" - #include "wx/debug.h" #include "wx/filefn.h" + #include "wx/log.h" + #include "wx/intl.h" + #include "wx/module.h" #endif -#include "wx/module.h" +#include "wx/init.h" +#include "wx/thread.h" -// ---------------------------------------------------------------------------- -// global vars -// ---------------------------------------------------------------------------- +#include "wx/scopedptr.h" +#include "wx/except.h" -wxApp * WXDLLEXPORT wxTheApp = NULL; +#if defined(__WXMSW__) && defined(__WXDEBUG__) + #include "wx/msw/msvcrt.h" -wxAppInitializerFunction - wxAppBase::m_appInitFn = (wxAppInitializerFunction)NULL; + static struct EnableMemLeakChecking + { + EnableMemLeakChecking() + { + // do check for memory leaks on program exit (another useful flag + // is _CRTDBG_DELAY_FREE_MEM_DF which doesn't free deallocated + // memory which may be used to simulate low-memory condition) + wxCrtSetDbgFlag(_CRTDBG_LEAK_CHECK_DF); + } + } gs_enableLeakChecks; +#endif // __WXMSW__ && __WXDEBUG__ // ---------------------------------------------------------------------------- // private classes // ---------------------------------------------------------------------------- -class /* no WXDLLEXPORT */ wxConsoleApp : public wxApp +// we need a dummy app object if the user doesn't want to create a real one +class wxDummyConsoleApp : public wxAppConsole { public: - virtual int OnRun() { wxFAIL_MSG(wxT("unreachable")); return 0; } + wxDummyConsoleApp() { } + + virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; } + virtual bool DoYield(bool, long) { return true; } + + wxDECLARE_NO_COPY_CLASS(wxDummyConsoleApp); +}; + +// we need a special kind of auto pointer to wxApp which not only deletes the +// pointer it holds in its dtor but also resets the global application pointer +wxDECLARE_SCOPED_PTR(wxAppConsole, wxAppPtrBase) +wxDEFINE_SCOPED_PTR(wxAppConsole, wxAppPtrBase) + +class wxAppPtr : public wxAppPtrBase +{ +public: + wxEXPLICIT wxAppPtr(wxAppConsole *ptr = NULL) : wxAppPtrBase(ptr) { } + ~wxAppPtr() + { + if ( get() ) + { + // the pointer is going to be deleted in the base class dtor, don't + // leave the dangling pointer! + wxApp::SetInstance(NULL); + } + } + + void Set(wxAppConsole *ptr) + { + reset(ptr); + + wxApp::SetInstance(ptr); + } + + wxDECLARE_NO_COPY_CLASS(wxAppPtr); +}; + +// class to ensure that wxAppBase::CleanUp() is called if our Initialize() +// fails +class wxCallAppCleanup +{ +public: + wxCallAppCleanup(wxAppConsole *app) : m_app(app) { } + ~wxCallAppCleanup() { if ( m_app ) m_app->CleanUp(); } + + void Dismiss() { m_app = NULL; } + +private: + wxAppConsole *m_app; +}; + +// another tiny class which simply exists to ensure that wxEntryCleanup is +// always called +class wxCleanupOnExit +{ +public: + ~wxCleanupOnExit() { wxEntryCleanup(); } }; // ---------------------------------------------------------------------------- // private functions // ---------------------------------------------------------------------------- -static bool DoInit(); -static void DoCleanUp(); +// suppress warnings about unused variables +static inline void Use(void *) { } + +#define WX_SUPPRESS_UNUSED_WARN(x) Use(&x) // ---------------------------------------------------------------------------- -// private vars +// initialization data // ---------------------------------------------------------------------------- -static size_t gs_nInitCount = 0; +static struct InitData +{ + InitData() + { + nInitCount = 0; + +#if wxUSE_UNICODE + argc = 0; + // argv = NULL; -- not even really needed +#endif // wxUSE_UNICODE + } + + // critical section protecting this struct + wxCRIT_SECT_DECLARE_MEMBER(csInit); + + // number of times wxInitialize() was called minus the number of times + // wxUninitialize() was + size_t nInitCount; + +#if wxUSE_UNICODE + int argc; + + // if we receive the command line arguments as ASCII and have to convert + // them to Unicode ourselves (this is the case under Unix but not Windows, + // for example), we remember the converted argv here because we'll have to + // free it when doing cleanup to avoid memory leaks + wchar_t **argv; +#endif // wxUSE_UNICODE + + wxDECLARE_NO_COPY_CLASS(InitData); +} gs_initData; // ============================================================================ // implementation // ============================================================================ // ---------------------------------------------------------------------------- -// stubs for some GUI functions +// command line arguments ANSI -> Unicode conversion // ---------------------------------------------------------------------------- -void WXDLLEXPORT wxExit() -{ - abort(); -} +#if wxUSE_UNICODE -// Yield to other apps/messages -bool WXDLLEXPORT wxYield() +static void ConvertArgsToUnicode(int argc, char **argv) { - // do nothing - return TRUE; + gs_initData.argv = new wchar_t *[argc + 1]; + int wargc = 0; + for ( int i = 0; i < argc; i++ ) + { +#ifdef __DARWIN__ + wxWCharBuffer buf(wxConvFileName->cMB2WX(argv[i])); +#else + wxWCharBuffer buf(wxConvLocal.cMB2WX(argv[i])); +#endif + if ( !buf ) + { + wxLogWarning(_("Command line argument %d couldn't be converted to Unicode and will be ignored."), + i); + } + else // converted ok + { + gs_initData.argv[wargc++] = wxStrdup(buf); + } + } + + gs_initData.argc = wargc; + gs_initData.argv[wargc] = NULL; } -// Yield to other apps/messages -void WXDLLEXPORT wxWakeUpIdle() +static void FreeConvertedArgs() { - // do nothing + if ( gs_initData.argv ) + { + for ( int i = 0; i < gs_initData.argc; i++ ) + { + free(gs_initData.argv[i]); + } + + delete [] gs_initData.argv; + gs_initData.argv = NULL; + gs_initData.argc = 0; + } } +#endif // wxUSE_UNICODE + // ---------------------------------------------------------------------------- -// wxBase-specific functions +// start up // ---------------------------------------------------------------------------- -bool WXDLLEXPORT wxInitialize() +// initialization which is always done (not customizable) before wxApp creation +static bool DoCommonPreInit() { - if ( gs_nInitCount ) - { - // already initialized - return TRUE; - } +#if wxUSE_LOG + // Reset logging in case we were cleaned up and are being reinitialized. + wxLog::DoCreateOnDemand(); + + // install temporary log sink: we can't use wxLogGui before wxApp is + // constructed and if we use wxLogStderr, all messages during + // initialization simply disappear under Windows + // + // note that we will delete this log target below + delete wxLog::SetActiveTarget(new wxLogBuffer); +#endif // wxUSE_LOG - wxASSERT_MSG( !wxTheApp, - wxT("either call wxInitialize or create app, not both!") ); + return true; +} - if ( !DoInit() ) +// non customizable initialization done after wxApp creation and initialization +static bool DoCommonPostInit() +{ + wxModule::RegisterModules(); + + if ( !wxModule::InitializeModules() ) { - return FALSE; + wxLogError(_("Initialization failed in post init, aborting.")); + return false; } - wxTheApp = new wxConsoleApp; - - if ( !wxTheApp ) +#if defined(__WXDEBUG__) + // check if event classes implement Clone() correctly + // NOTE: the check is done against _all_ event classes which are linked to + // the executable currently running, which are not necessarily all + // wxWidgets event classes. + const wxClassInfo *ci = wxClassInfo::GetFirst(); + for (; ci; ci = ci->GetNext()) { - return FALSE; + // is this class derived from wxEvent? + if (!ci->IsKindOf(CLASSINFO(wxEvent)) || wxString(ci->GetClassName()) == "wxEvent") + continue; + + if (!ci->IsDynamic()) + { + wxLogWarning("The event class '%s' should have a DECLARE_DYNAMIC_CLASS macro!", + ci->GetClassName()); + continue; + } + + // yes; test if it implements Clone() correctly + wxEvent* test = wxDynamicCast(ci->CreateObject(),wxEvent); + if (test == NULL) + { + wxLogWarning("The event class '%s' should have a DECLARE_DYNAMIC_CLASS macro!", + ci->GetClassName()); + continue; + } + + wxEvent* cloned = test->Clone(); + if (!cloned || cloned->GetClassInfo() != ci) + wxLogWarning("The event class '%s' does not correctly implement Clone()!", + ci->GetClassName()); + + delete cloned; + delete test; } +#endif - gs_nInitCount++; - - return TRUE; + return true; } -void WXDLLEXPORT wxUninitialize() +bool wxEntryStart(int& argc, wxChar **argv) { - if ( !--gs_nInitCount ) + // do minimal, always necessary, initialization + // -------------------------------------------- + + // initialize wxRTTI + if ( !DoCommonPreInit() ) + return false; + + + // first of all, we need an application object + // ------------------------------------------- + + // the user might have already created it himself somehow + wxAppPtr app(wxTheApp); + if ( !app.get() ) { - DoCleanUp(); + // if not, he might have used IMPLEMENT_APP() to give us a function to + // create it + wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction(); + + if ( fnCreate ) + { + // he did, try to create the custom wxApp object + app.Set((*fnCreate)()); + } } + + if ( !app.get() ) + { + // either IMPLEMENT_APP() was not used at all or it failed -- in any + // case we still need something + app.Set(new wxDummyConsoleApp); + } + + + // wxApp initialization: this can be customized + // -------------------------------------------- + + if ( !app->Initialize(argc, argv) ) + return false; + + // remember, possibly modified (e.g. due to removal of toolkit-specific + // parameters), command line arguments in member variables + app->argc = argc; + app->argv = argv; + + wxCallAppCleanup callAppCleanup(app.get()); + + + // common initialization after wxTheApp creation + // --------------------------------------------- + + if ( !DoCommonPostInit() ) + return false; + + + // prevent the smart pointer from destroying its contents + app.release(); + + // and the cleanup object from doing cleanup + callAppCleanup.Dismiss(); + +#if wxUSE_LOG + // now that we have a valid wxApp (wxLogGui would have crashed if we used + // it before now), we can delete the temporary sink we had created for the + // initialization messages -- the next time logging function is called, the + // sink will be recreated but this time wxAppTraits will be used + delete wxLog::SetActiveTarget(NULL); +#endif // wxUSE_LOG + + return true; } -int wxEntry(int argc, char **argv) +#if wxUSE_UNICODE + +// we provide a wxEntryStart() wrapper taking "char *" pointer too +bool wxEntryStart(int& argc, char **argv) { - // library initialization - if ( !DoInit() ) + ConvertArgsToUnicode(argc, argv); + + if ( !wxEntryStart(gs_initData.argc, gs_initData.argv) ) { - return -1; + FreeConvertedArgs(); + + return false; } - // create the app - if ( !wxTheApp ) - { - wxCHECK_MSG( wxApp::GetInitializerFunction(), -1, - wxT("No application object: use IMPLEMENT_APP macro.") ); + return true; +} - wxAppInitializerFunction fnCreate = wxApp::GetInitializerFunction(); +#endif // wxUSE_UNICODE - wxTheApp = (wxApp *)fnCreate(); - } +// ---------------------------------------------------------------------------- +// clean up +// ---------------------------------------------------------------------------- - wxCHECK_MSG( wxTheApp, -1, wxT("wxWindows error: no application object") ); +// cleanup done before destroying wxTheApp +static void DoCommonPreCleanup() +{ +#if wxUSE_LOG + // flush the logged messages if any and install a 'safer' log target: the + // default one (wxLogGui) can't be used after the resources are freed just + // below and the user supplied one might be even more unsafe (using any + // wxWidgets GUI function is unsafe starting from now) + wxLog::DontCreateOnDemand(); + + // this will flush the old messages if any + delete wxLog::SetActiveTarget(new wxLogStderr); +#endif // wxUSE_LOG +} - // app preinitialization - wxTheApp->argc = argc; +// cleanup done after destroying wxTheApp +static void DoCommonPostCleanup() +{ + wxModule::CleanUpModules(); + // we can't do this in wxApp itself because it doesn't know if argv had + // been allocated #if wxUSE_UNICODE - wxTheApp->argv = new wxChar*[argc+1]; - int mb_argc = 0; - while (mb_argc < argc) + FreeConvertedArgs(); +#endif // wxUSE_UNICODE + + // 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); + +#if wxUSE_LOG + // and now delete the last logger as well + delete wxLog::SetActiveTarget(NULL); +#endif // wxUSE_LOG +} + +void wxEntryCleanup() +{ + DoCommonPreCleanup(); + + + // delete the application object + if ( wxTheApp ) { - wxTheApp->argv[mb_argc] = wxStrdup(wxConvLibc.cMB2WX(argv[mb_argc])); - mb_argc++; + wxTheApp->CleanUp(); + + // reset the global pointer to it to NULL before destroying it as in + // some circumstances this can result in executing the code using + // wxTheApp and using half-destroyed object is no good + wxAppConsole * const app = wxApp::GetInstance(); + wxApp::SetInstance(NULL); + delete app; } - wxTheApp->argv[mb_argc] = (wxChar *)NULL; -#else - wxTheApp->argv = argv; -#endif - wxString name = wxFileNameFromPath(argv[0]); - wxStripExtension(name); - wxTheApp->SetAppName(name); - int retValue = 0; + DoCommonPostCleanup(); +} + +// ---------------------------------------------------------------------------- +// wxEntry +// ---------------------------------------------------------------------------- - // app initialization - if ( !wxTheApp->OnInit() ) - retValue = -1; +// for MSW the real wxEntry is defined in msw/main.cpp +#ifndef __WXMSW__ + #define wxEntryReal wxEntry +#endif // !__WXMSW__ - // app execution - if ( retValue == 0 ) +int wxEntryReal(int& argc, wxChar **argv) +{ + // library initialization + if ( !wxEntryStart(argc, argv) ) { - retValue = wxTheApp->OnRun(); +#if wxUSE_LOG + // flush any log messages explaining why we failed + delete wxLog::SetActiveTarget(NULL); +#endif + return -1; + } + + // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code + // below returns or throws + wxCleanupOnExit cleanupOnExit; + + WX_SUPPRESS_UNUSED_WARN(cleanupOnExit); - // app clean up - wxTheApp->OnExit(); + wxTRY + { + // app initialization + if ( !wxTheApp->CallOnInit() ) + { + // don't call OnExit() if OnInit() failed + return -1; + } + + // ensure that OnExit() is called if OnInit() had succeeded + class CallOnExit + { + public: + ~CallOnExit() { wxTheApp->OnExit(); } + } callOnExit; + + WX_SUPPRESS_UNUSED_WARN(callOnExit); + + // app execution + return wxTheApp->OnRun(); } + wxCATCH_ALL( wxTheApp->OnUnhandledException(); return -1; ) +} - // library clean up - DoCleanUp(); +#if wxUSE_UNICODE + +// as with wxEntryStart, we provide an ANSI wrapper +int wxEntry(int& argc, char **argv) +{ + ConvertArgsToUnicode(argc, argv); - return retValue; + return wxEntry(gs_initData.argc, gs_initData.argv); } +#endif // wxUSE_UNICODE + // ---------------------------------------------------------------------------- -// private functions +// wxInitialize/wxUninitialize // ---------------------------------------------------------------------------- -static bool DoInit() +bool wxInitialize(int argc, wxChar **argv) { - wxClassInfo::InitializeClasses(); + wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit); - wxModule::RegisterModules(); - if ( !wxModule::InitializeModules() ) + if ( gs_initData.nInitCount++ ) { - return FALSE; + // already initialized + return true; } - return TRUE; + return wxEntryStart(argc, argv); } -static void DoCleanUp() +void wxUninitialize() { -#if wxUSE_LOG - // flush the logged messages if any - wxLog *log = wxLog::GetActiveTarget(); - if (log != NULL && log->HasPendingMessages()) - log->Flush(); - - // continuing to use user defined log target is unsafe from now on because - // some resources may be already unavailable, so replace it by something - // more safe - wxLog *oldlog = wxLog::SetActiveTarget(new wxLogStderr); - if ( oldlog ) - delete oldlog; -#endif // wxUSE_LOG - - wxModule::CleanUpModules(); + wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit); - wxClassInfo::CleanUpClasses(); - - // delete the application object - delete wxTheApp; - wxTheApp = (wxApp *)NULL; + if ( --gs_initData.nInitCount == 0 ) + { + wxEntryCleanup(); + } }