cleaning up common OSX code

[wxWidgets.git] / src / common / init.cpp

diff --git a/src/common/init.cpp b/src/common/init.cpp
index 58e2b591a22ee8c8e2e95c0177848fa8394d3b6c..adb68c947c9f1466c3dab4b37dd6065b4dc95658 100644 (file)
--- 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:
 // Purpose:     initialisation for the library
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -20,21 +20,22 @@
 #include "wx/wxprec.h"
 
 #ifdef    __BORLANDC__
 #include "wx/wxprec.h"
 
 #ifdef    __BORLANDC__

-  #pragma hdrstop
+    #pragma hdrstop

 #endif  //__BORLANDC__
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"
 #endif  //__BORLANDC__
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"

-    #include "wx/debug.h"

     #include "wx/filefn.h"
     #include "wx/log.h"
     #include "wx/filefn.h"
     #include "wx/log.h"

-    #include "wx/thread.h"
+    #include "wx/intl.h"
+    #include "wx/module.h"

 #endif
 
 #include "wx/init.h"
 #endif
 
 #include "wx/init.h"

+#include "wx/thread.h"

 
 #include "wx/ptr_scpd.h"
 
 #include "wx/ptr_scpd.h"

-#include "wx/module.h"
+#include "wx/except.h"

 
 #if defined(__WXMSW__) && defined(__WXDEBUG__)
     #include "wx/msw/msvcrt.h"
 
 #if defined(__WXMSW__) && defined(__WXDEBUG__)
     #include "wx/msw/msvcrt.h"


@@ -59,34 +60,40 @@
 class wxDummyConsoleApp : public wxAppConsole
 {
 public:
 class wxDummyConsoleApp : public wxAppConsole
 {
 public:

+    wxDummyConsoleApp() { }
+

     virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; }
     virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; }

+
+    DECLARE_NO_COPY_CLASS(wxDummyConsoleApp)

 };
 
 // we need a special kind of auto pointer to wxApp which not only deletes the
 };
 
 // we need a special kind of auto pointer to wxApp which not only deletes the

-// pointer it holds in its dtor but also resets wxTheApp
-wxDECLARE_SCOPED_PTR(wxApp, wxAppPtrBase);
-wxDEFINE_SCOPED_PTR(wxApp, wxAppPtrBase);
+// 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:
 
 class wxAppPtr : public wxAppPtrBase
 {
 public:

-    wxEXPLICIT wxAppPtr(wxApp *ptr = NULL) : wxAppPtrBase(ptr) { }
+    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!
     ~wxAppPtr()
     {
         if ( get() )
         {
             // the pointer is going to be deleted in the base class dtor, don't
             // leave the dangling pointer!

-            wxTheApp = NULL;
+            wxApp::SetInstance(NULL);

         }
     }
 
         }
     }
 

-    void Set(wxApp *ptr)
+    void Set(wxAppConsole *ptr)

     {
         reset(ptr);
 
     {
         reset(ptr);
 

-        wxTheApp = ptr;
+        wxApp::SetInstance(ptr);

     }
     }

+
+    DECLARE_NO_COPY_CLASS(wxAppPtr)

 };
 
 // class to ensure that wxAppBase::CleanUp() is called if our Initialize()
 };
 
 // class to ensure that wxAppBase::CleanUp() is called if our Initialize()


@@ -94,13 +101,13 @@ public:
 class wxCallAppCleanup
 {
 public:
 class wxCallAppCleanup
 {
 public:

-    wxCallAppCleanup(wxApp *app) : m_app(app) { }
+    wxCallAppCleanup(wxAppConsole *app) : m_app(app) { }

     ~wxCallAppCleanup() { if ( m_app ) m_app->CleanUp(); }
 
     void Dismiss() { m_app = NULL; }
 
 private:
     ~wxCallAppCleanup() { if ( m_app ) m_app->CleanUp(); }
 
     void Dismiss() { m_app = NULL; }
 
 private:

-    wxApp *m_app;
+    wxAppConsole *m_app;

 };
 
 // another tiny class which simply exists to ensure that wxEntryCleanup is
 };
 
 // another tiny class which simply exists to ensure that wxEntryCleanup is


@@ -152,6 +159,8 @@ static struct InitData
     // free it when doing cleanup to avoid memory leaks
     wchar_t **argv;
 #endif // wxUSE_UNICODE
     // free it when doing cleanup to avoid memory leaks
     wchar_t **argv;
 #endif // wxUSE_UNICODE

+
+    DECLARE_NO_COPY_CLASS(InitData)

 } gs_initData;
 
 // ============================================================================
 } gs_initData;
 
 // ============================================================================


@@ -167,12 +176,27 @@ static struct InitData
 static void ConvertArgsToUnicode(int argc, char **argv)
 {
     gs_initData.argv = new wchar_t *[argc + 1];
 static void ConvertArgsToUnicode(int argc, char **argv)
 {
     gs_initData.argv = new wchar_t *[argc + 1];

+    int wargc = 0;

     for ( int i = 0; i < argc; i++ )
     {
     for ( int i = 0; i < argc; i++ )
     {

-        gs_initData.argv[i] = wxStrdup(wxConvLocal.cMB2WX(argv[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.argv[argc] = NULL;
+    gs_initData.argc = wargc;
+    gs_initData.argv[wargc] = NULL;

 }
 
 static void FreeConvertedArgs()
 }
 
 static void FreeConvertedArgs()


@@ -186,6 +210,7 @@ static void FreeConvertedArgs()
 
         delete [] gs_initData.argv;
         gs_initData.argv = NULL;
 
         delete [] gs_initData.argv;
         gs_initData.argv = NULL;

+        gs_initData.argc = 0;

     }
 }
 
     }
 }
 


@@ -198,7 +223,17 @@ static void FreeConvertedArgs()
 // initialization which is always done (not customizable) before wxApp creation
 static bool DoCommonPreInit()
 {
 // initialization which is always done (not customizable) before wxApp creation
 static bool DoCommonPreInit()
 {

-    wxClassInfo::InitializeClasses();
+#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

 
     return true;
 }
 
     return true;
 }


@@ -208,7 +243,13 @@ static bool DoCommonPostInit()
 {
     wxModule::RegisterModules();
 
 {
     wxModule::RegisterModules();
 

-    return wxModule::InitializeModules();
+    if ( !wxModule::InitializeModules() )
+    {
+        wxLogError(_("Initialization failed in post init, aborting."));
+        return false;
+    }
+
+    return true;

 }
 
 bool wxEntryStart(int& argc, wxChar **argv)
 }
 
 bool wxEntryStart(int& argc, wxChar **argv)


@@ -245,25 +286,22 @@ bool wxEntryStart(int& argc, wxChar **argv)
     {
         // either IMPLEMENT_APP() was not used at all or it failed -- in any
         // case we still need something
     {
         // either IMPLEMENT_APP() was not used at all or it failed -- in any
         // case we still need something

-        //
-        // NB: cast is needed because for the backwards-compatibility reasons
-        //     wxTheApp is really a wxApp and not just wxAppConsole...
-        app.Set((wxApp *)new wxDummyConsoleApp);
+        app.Set(new wxDummyConsoleApp);

     }
 
 
     // wxApp initialization: this can be customized
     // --------------------------------------------
 
     }
 
 
     // wxApp initialization: this can be customized
     // --------------------------------------------
 

-    if ( !wxTheApp->Initialize(argc, argv) )
+    if ( !app->Initialize(argc, argv) )

     {
         return false;
     }
 
     {
         return false;
     }
 

-    wxCallAppCleanup callAppCleanup(wxTheApp);
+    wxCallAppCleanup callAppCleanup(app.get());

 
     // for compatibility call the old initialization function too
 
     // for compatibility call the old initialization function too

-    if ( !wxTheApp->OnInitGui() )
+    if ( !app->OnInitGui() )

         return false;
 
 
         return false;
 
 


@@ -280,6 +318,14 @@ bool wxEntryStart(int& argc, wxChar **argv)
     // and the cleanup object from doing cleanup
     callAppCleanup.Dismiss();
 
     // 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;
 }
 
     return true;
 }
 


@@ -290,7 +336,7 @@ bool wxEntryStart(int& argc, char **argv)
 {
     ConvertArgsToUnicode(argc, argv);
 
 {
     ConvertArgsToUnicode(argc, argv);
 

-    if ( !wxEntryStart(argc, gs_initData.argv) )
+    if ( !wxEntryStart(gs_initData.argc, gs_initData.argv) )

     {
         FreeConvertedArgs();
 
     {
         FreeConvertedArgs();
 


@@ -306,27 +352,25 @@ bool wxEntryStart(int& argc, char **argv)
 // clean up
 // ----------------------------------------------------------------------------
 
 // clean up
 // ----------------------------------------------------------------------------
 

-// cleanup done before destroying wxTheApp 
+// 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
 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

-    // wxWindows GUI function is unsafe starting from now)
+    // 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
     wxLog::DontCreateOnDemand();
 
     // this will flush the old messages if any
     delete wxLog::SetActiveTarget(new wxLogStderr);
 #endif // wxUSE_LOG

-
-    wxModule::CleanUpModules();

 }
 
 // cleanup done after destroying wxTheApp
 static void DoCommonPostCleanup()
 {
 }
 
 // cleanup done after destroying wxTheApp
 static void DoCommonPostCleanup()
 {

-    wxClassInfo::CleanUpClasses();
+    wxModule::CleanUpModules();

 
     // we can't do this in wxApp itself because it doesn't know if argv had
     // been allocated
 
     // we can't do this in wxApp itself because it doesn't know if argv had
     // been allocated


@@ -334,6 +378,10 @@ static void DoCommonPostCleanup()
     FreeConvertedArgs();
 #endif // wxUSE_UNICODE
 
     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);
 #if wxUSE_LOG
     // and now delete the last logger as well
     delete wxLog::SetActiveTarget(NULL);


@@ -350,38 +398,36 @@ void wxEntryCleanup()
     {
         wxTheApp->CleanUp();
 
     {
         wxTheApp->CleanUp();
 

-        delete wxTheApp;
-        wxTheApp = NULL;
+        // 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;

     }
 
 
     DoCommonPostCleanup();
     }
 
 
     DoCommonPostCleanup();

-
-    // check for memory leaks
-#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
-    if (wxDebugContext::CountObjectsLeft(TRUE) > 0)
-    {
-        wxLogDebug(wxT("There were memory leaks.\n"));
-        wxDebugContext::Dump();
-        wxDebugContext::PrintStatistics();
-    }
-#endif // Debug
-

 }
 
 // ----------------------------------------------------------------------------
 // wxEntry
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxEntry
 // ----------------------------------------------------------------------------
 

-#if !defined(__WXMSW__) || !wxUSE_ON_FATAL_EXCEPTION
+// for MSW the real wxEntry is defined in msw/main.cpp
+#ifndef __WXMSW__

     #define wxEntryReal wxEntry
     #define wxEntryReal wxEntry

-#endif // !(__WXMSW__ && wxUSE_ON_FATAL_EXCEPTION)
+#endif // !__WXMSW__

 
 int wxEntryReal(int& argc, wxChar **argv)
 {
     // library initialization
     if ( !wxEntryStart(argc, argv) )
     {
 
 int wxEntryReal(int& argc, wxChar **argv)
 {
     // library initialization
     if ( !wxEntryStart(argc, argv) )
     {

+#if wxUSE_LOG
+        // flush any log messages explaining why we failed
+        delete wxLog::SetActiveTarget(NULL);
+#endif

         return -1;
     }
 
         return -1;
     }
 


@@ -391,60 +437,31 @@ int wxEntryReal(int& argc, wxChar **argv)
 
     WX_SUPPRESS_UNUSED_WARN(cleanupOnExit);
 
 
     WX_SUPPRESS_UNUSED_WARN(cleanupOnExit);
 

-    // app initialization
-    if ( !wxTheApp->OnInit() )
+    wxTRY

     {
     {

-        // don't call OnExit() if OnInit() failed
-        return -1;
-    }
-
-    // app execution
-    int retValue = wxTheApp->OnRun();
-
-    // why should we do this? it doesn't close all window, just one of them and
-    // this shouldn't be necessary anyhow...
-#if 0
-    // close any remaining windows
-    wxWindow *topWindow = wxTheApp->GetTopWindow();
-    if ( topWindow )
-    {
-        // forcibly delete the window.
-        topWindow->Destroy();
-
-        // collect the dead objects
-        wxTheApp->DeletePendingObjects();
-    }
-#endif // 0
-
-    // app clean up
-    wxTheApp->OnExit();

 
 

-    return retValue;
-}
-
-// wrap real wxEntry in a try-except block to be able to call
-// OnFatalException() if necessary
-#if defined(__WXMSW__) && wxUSE_ON_FATAL_EXCEPTION
+        // app initialization
+        if ( !wxTheApp->CallOnInit() )
+        {
+            // don't call OnExit() if OnInit() failed
+            return -1;
+        }

 
 

-extern unsigned long wxGlobalSEHandler();
+        // ensure that OnExit() is called if OnInit() had succeeded
+        class CallOnExit
+        {
+        public:
+            ~CallOnExit() { wxTheApp->OnExit(); }
+        } callOnExit;

 
 

-int wxEntry(int& argc, wxChar **argv)
-{
-    __try
-    {
-        return wxEntryReal(argc, argv);
-    }
-    __except ( wxGlobalSEHandler() )
-    {
-        ::ExitProcess(3); // the same exit code as abort()
+        WX_SUPPRESS_UNUSED_WARN(callOnExit);

 
 

-        // this code is unreachable but put it here to suppress warnings
-        return -1;
+        // app execution
+        return wxTheApp->OnRun();

     }
     }

+    wxCATCH_ALL( wxTheApp->OnUnhandledException(); return -1; )

 }
 
 }
 

-#endif // __WXMSW__ && wxUSE_ON_FATAL_EXCEPTION
-

 #if wxUSE_UNICODE
 
 // as with wxEntryStart, we provide an ANSI wrapper
 #if wxUSE_UNICODE
 
 // as with wxEntryStart, we provide an ANSI wrapper


@@ -452,7 +469,7 @@ int wxEntry(int& argc, char **argv)
 {
     ConvertArgsToUnicode(argc, argv);
 
 {
     ConvertArgsToUnicode(argc, argv);
 

-    return wxEntry(argc, gs_initData.argv);
+    return wxEntry(gs_initData.argc, gs_initData.argv);

 }
 
 #endif // wxUSE_UNICODE
 }
 
 #endif // wxUSE_UNICODE


@@ -478,9 +495,8 @@ void wxUninitialize()
 {
     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 
 {
     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 

-    if ( !--gs_initData.nInitCount )
+    if ( --gs_initData.nInitCount == 0 )

     {
         wxEntryCleanup();
     }
 }
     {
         wxEntryCleanup();
     }
 }

-