fix memory leak in wxScreenDC, fixes #13249

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

diff --git a/src/common/init.cpp b/src/common/init.cpp
index 14d60569292511b2f65d035f2bf02436e8855408..561b726ccd2cc0743a1c8886b4922299818febdf 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,36 +20,40 @@
 #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/module.h"
+#include "wx/scopedptr.h"
+#include "wx/except.h"

 
 

-#if defined(__WXMSW__) && defined(__WXDEBUG__)
+#if defined(__WXMSW__)
+    #include "wx/msw/private.h"

     #include "wx/msw/msvcrt.h"
 
     #include "wx/msw/msvcrt.h"
 

-    static struct EnableMemLeakChecking
-    {
-        EnableMemLeakChecking()
+    #ifdef wxCrtSetDbgFlag
+        static struct 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__
+            EnableMemLeakChecking()
+            {
+                // 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 // wxCrtSetDbgFlag
+#endif // __WXMSW__

 
 // ----------------------------------------------------------------------------
 // private classes
 
 // ----------------------------------------------------------------------------
 // private classes


@@ -59,34 +63,41 @@
 class wxDummyConsoleApp : public wxAppConsole
 {
 public:
 class wxDummyConsoleApp : public wxAppConsole
 {
 public:

-    virtual int OnRun() { wxFAIL_MSG( _T("unreachable code") ); return 0; }
+    wxDummyConsoleApp() { }
+
+    virtual int OnRun() { wxFAIL_MSG( wxT("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
 };
 
 // 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);

     }
     }

+
+    wxDECLARE_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,22 +105,23 @@ 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
-// always called
-class wxCleanupOnExit
-{
-public:
-    ~wxCleanupOnExit() { wxEntryCleanup(); }
-};
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+// suppress warnings about unused variables
+static inline void Use(void *) { }
+
+#define WX_SUPPRESS_UNUSED_WARN(x) Use(&x)

 
 // ----------------------------------------------------------------------------
 // initialization data
 
 // ----------------------------------------------------------------------------
 // initialization data


@@ -143,6 +155,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

+
+    wxDECLARE_NO_COPY_CLASS(InitData);

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


@@ -158,12 +172,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()


@@ -175,8 +204,8 @@ static void FreeConvertedArgs()
             free(gs_initData.argv[i]);
         }
 
             free(gs_initData.argv[i]);
         }
 

-        delete [] gs_initData.argv;
-        gs_initData.argv = NULL;
+        wxDELETEA(gs_initData.argv);
+        gs_initData.argc = 0;

     }
 }
 
     }
 }
 


@@ -189,7 +218,35 @@ 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();
+
+    // force wxLog to create a log target now: we do it because wxTheApp
+    // doesn't exist yet so wxLog will create a special log target which is
+    // safe to use even when the GUI is not available while without this call
+    // we could create wxApp in wxEntryStart() below, then log an error about
+    // e.g. failure to establish connection to the X server and wxLog would
+    // send it to wxLogGui (because wxTheApp does exist already) which, of
+    // course, can't be used in this case
+    //
+    // notice also that this does nothing if the user had set up a custom log
+    // target before -- which is fine as we want to give him this possibility
+    // (as it's impossible to override logging by overriding wxAppTraits::
+    // CreateLogTarget() before wxApp is created) and we just assume he knows
+    // what he is doing
+    wxLog::GetActiveTarget();
+#endif // wxUSE_LOG
+
+#ifdef __WXMSW__
+    // GUI applications obtain HINSTANCE in their WinMain() but we also need to
+    // initialize the global wxhInstance variable for the console programs as
+    // they may need it too, so set it here if it wasn't done yet
+    if ( !wxGetInstance() )
+    {
+        wxSetInstance(::GetModuleHandle(NULL));
+    }
+#endif // __WXMSW__

 
     return true;
 }
 
     return true;
 }


@@ -199,7 +256,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)


@@ -209,9 +272,7 @@ bool wxEntryStart(int& argc, wxChar **argv)
 
     // initialize wxRTTI
     if ( !DoCommonPreInit() )
 
     // initialize wxRTTI
     if ( !DoCommonPreInit() )

-    {

         return false;
         return false;

-    }

 
 
     // first of all, we need an application object
 
 
     // first of all, we need an application object


@@ -236,26 +297,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);
+    // remember, possibly modified (e.g. due to removal of toolkit-specific
+    // parameters), command line arguments in member variables
+    app->argc = argc;
+    app->argv = argv;

 
 

-    // for compatibility call the old initialization function too
-    if ( !wxTheApp->OnInitGui() )
-        return false;
+    wxCallAppCleanup callAppCleanup(app.get());

 
 
     // common initialization after wxTheApp creation
 
 
     // common initialization after wxTheApp creation


@@ -271,6 +328,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;
 }
 


@@ -281,7 +346,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();
 


@@ -297,27 +362,26 @@ 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
 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)
-    wxLog::DontCreateOnDemand();
-
-    // this will flush the old messages if any
-    delete wxLog::SetActiveTarget(new wxLogStderr);
+    // flush the logged messages if any and don't use the current probably
+    // unsafe log target any more: the default one (wxLogGui) can't be used
+    // after the resources are freed which happens when we return and the user
+    // supplied one might be even more unsafe (using any wxWidgets GUI function
+    // is unsafe starting from now)
+    //
+    // notice that wxLog will still recreate a default log target if any
+    // messages are logged but that one will be safe to use until the very end
+    delete wxLog::SetActiveTarget(NULL);

 #endif // wxUSE_LOG
 #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


@@ -325,8 +389,18 @@ 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
 #if wxUSE_LOG
     // and now delete the last logger as well

+    //
+    // we still don't disable log target auto-vivification even if any log
+    // objects created now will result in memory leaks because it seems better
+    // to leak memory which doesn't matter much considering the application is
+    // exiting anyhow than to not show messages which could still be logged
+    // from the user code (e.g. static dtors and such)

     delete wxLog::SetActiveTarget(NULL);
 #endif // wxUSE_LOG
 }
     delete wxLog::SetActiveTarget(NULL);
 #endif // wxUSE_LOG
 }


@@ -341,99 +415,65 @@ 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
 
 int wxEntryReal(int& argc, wxChar **argv)
 {
     // library initialization

-    if ( !wxEntryStart(argc, argv) )
-    {
-        return -1;
-    }
+    wxInitializer initializer(argc, argv);

 
 

-    // if wxEntryStart succeeded, we must call wxEntryCleanup even if the code
-    // below returns or throws
-    wxCleanupOnExit cleanupOnExit;
-
-    // app initialization
-    if ( !wxTheApp->OnInit() )
+    if ( !initializer.IsOk() )

     {
     {

-        // don't call OnExit() if OnInit() failed
+#if wxUSE_LOG
+        // flush any log messages explaining why we failed
+        delete wxLog::SetActiveTarget(NULL);
+#endif

         return -1;
     }
 
         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 )
+    wxTRY

     {
     {

-        // forcibly delete the window.
-        topWindow->Destroy();
-
-        // collect the dead objects
-        wxTheApp->DeletePendingObjects();
-    }
-#endif // 0
-
-    // app clean up
-    wxTheApp->OnExit();
-
-    return retValue;
-}
+        // app initialization
+        if ( !wxTheApp->CallOnInit() )
+        {
+            // don't call OnExit() if OnInit() failed
+            return -1;
+        }

 
 

-// wrap real wxEntry in a try-except block to be able to call
-// OnFatalException() if necessary
-#if defined(__WXMSW__) && wxUSE_ON_FATAL_EXCEPTION
+        // ensure that OnExit() is called if OnInit() had succeeded
+        class CallOnExit
+        {
+        public:
+            ~CallOnExit() { wxTheApp->OnExit(); }
+        } callOnExit;

 
 

-extern unsigned long wxGlobalSEHandler();
+        WX_SUPPRESS_UNUSED_WARN(callOnExit);

 
 

-int wxEntry(int& argc, wxChar **argv)
-{
-    __try
-    {
-        return wxEntryReal(argc, argv);
-    }
-    __except ( wxGlobalSEHandler() )
-    {
-        ::ExitProcess(3); // the same exit code as abort()
-
-        // 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


@@ -441,7 +481,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


@@ -450,6 +490,11 @@ int wxEntry(int& argc, char **argv)
 // wxInitialize/wxUninitialize
 // ----------------------------------------------------------------------------
 
 // wxInitialize/wxUninitialize
 // ----------------------------------------------------------------------------
 

+bool wxInitialize()
+{
+    return wxInitialize(0, (wxChar**)NULL);
+}
+

 bool wxInitialize(int argc, wxChar **argv)
 {
     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 bool wxInitialize(int argc, wxChar **argv)
 {
     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);


@@ -463,13 +508,27 @@ bool wxInitialize(int argc, wxChar **argv)
     return wxEntryStart(argc, argv);
 }
 
     return wxEntryStart(argc, argv);
 }
 

+#if wxUSE_UNICODE
+bool wxInitialize(int argc, char **argv)
+{
+    wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
+
+    if ( gs_initData.nInitCount++ )
+    {
+        // already initialized
+        return true;
+    }
+
+    return wxEntryStart(argc, argv);
+}
+#endif // wxUSE_UNICODE
+

 void wxUninitialize()
 {
     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 
 void wxUninitialize()
 {
     wxCRIT_SECT_LOCKER(lockInit, gs_initData.csInit);
 

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

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

-