]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/appcmn.cpp
fixing overrelease and out-of-bounds write, fixes #13725
[wxWidgets.git] / src / common / appcmn.cpp
index 1255c30938d3d6499a47d5367995d0817c8620e9..9a3ead6a33da8b33425146009df9afb0fca625fc 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        common/appcmn.cpp
-// Purpose:     wxAppConsole and wxAppBase methods common to all platforms
+// Name:        src/common/appcmn.cpp
+// Purpose:     wxAppBase methods common to all platforms
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     18.10.99
 // headers
 // ---------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "appbase.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"
+    #include "wx/window.h"
     #include "wx/bitmap.h"
-    #include "wx/intl.h"
-    #include "wx/list.h"
     #include "wx/log.h"
     #include "wx/msgdlg.h"
-    #include "wx/bitmap.h"
     #include "wx/confbase.h"
+    #include "wx/utils.h"
+    #include "wx/wxcrtvararg.h"
 #endif
 
 #include "wx/apptrait.h"
 #include "wx/cmdline.h"
-#include "wx/evtloop.h"
 #include "wx/msgout.h"
 #include "wx/thread.h"
-#include "wx/utils.h"
-#include "wx/ptr_scpd.h"
-
-#if defined(__WXMSW__)
-  #include  "wx/msw/private.h"  // includes windows.h for LOGFONT
-#endif
+#include "wx/vidmode.h"
+#include "wx/evtloop.h"
 
 #if wxUSE_FONTMAP
     #include "wx/fontmap.h"
 #include "wx/build.h"
 WX_CHECK_BUILD_OPTIONS("wxCore")
 
-
-// ----------------------------------------------------------------------------
-// wxEventLoopPtr
-// ----------------------------------------------------------------------------
-
-// this defines wxEventLoopPtr
-wxDEFINE_TIED_SCOPED_PTR_TYPE(wxEventLoop);
-
 // ============================================================================
 // wxAppBase implementation
 // ============================================================================
@@ -77,13 +60,12 @@ wxDEFINE_TIED_SCOPED_PTR_TYPE(wxEventLoop);
 
 wxAppBase::wxAppBase()
 {
-    m_topWindow = (wxWindow *)NULL;
-    m_useBestVisual = FALSE;
-    m_isActive = TRUE;
+    m_topWindow = NULL;
+
+    m_useBestVisual = false;
+    m_forceTrueColour = false;
 
-#if wxUSE_EVTLOOP_IN_APP
-    m_mainLoop = NULL;
-#endif // wxUSE_EVTLOOP_IN_APP
+    m_isActive = true;
 
     // We don't want to exit the app if the user code shows a dialog from its
     // OnInit() -- but this is what would happen if we set m_exitOnFrameDelete
@@ -91,29 +73,28 @@ wxAppBase::wxAppBase()
     // OTOH, if we set it to No initially we'll have to overwrite it with Yes
     // when we enter our OnRun() because we do want the default behaviour from
     // then on. But this would be a problem if the user code calls
-    // SetExitOnFrameDelete(FALSE) from OnInit().
+    // SetExitOnFrameDelete(false) from OnInit().
     //
     // So we use the special "Later" value which is such that
-    // GetExitOnFrameDelete() returns FALSE for it but which we know we can
+    // GetExitOnFrameDelete() returns false for it but which we know we can
     // safely (i.e. without losing the effect of the users SetExitOnFrameDelete
     // call) overwrite in OnRun()
     m_exitOnFrameDelete = Later;
 }
 
-bool wxAppBase::Initialize(int& argc, wxChar **argv)
+bool wxAppBase::Initialize(int& argcOrig, wxChar **argvOrig)
 {
-    if ( !wxAppConsole::Initialize(argc, argv) )
+    if ( !wxAppConsole::Initialize(argcOrig, argvOrig) )
         return false;
 
-#if wxUSE_THREADS
-    wxPendingEventsLocker = new wxCriticalSection;
-#endif
-
     wxInitializeStockLists();
-    wxInitializeStockObjects();
 
     wxBitmap::InitStandardHandlers();
 
+    // for compatibility call the old initialization function too
+    if ( !OnInitGui() )
+        return false;
+
     return true;
 }
 
@@ -128,30 +109,63 @@ wxAppBase::~wxAppBase()
 
 void wxAppBase::CleanUp()
 {
-    // one last chance for pending objects to be cleaned up
+    // clean up all the pending objects
     DeletePendingObjects();
 
+    // and any remaining TLWs (they remove themselves from wxTopLevelWindows
+    // when destroyed, so iterate until none are left)
+    while ( !wxTopLevelWindows.empty() )
+    {
+        // do not use Destroy() here as it only puts the TLW in pending list
+        // but we want to delete them now
+        delete wxTopLevelWindows.GetFirst()->GetData();
+    }
+
+    // undo everything we did in Initialize() above
     wxBitmap::CleanUpHandlers();
 
-    wxDeleteStockObjects();
+    wxStockGDI::DeleteAll();
 
     wxDeleteStockLists();
 
-    delete wxTheColourDatabase;
-    wxTheColourDatabase = NULL;
+    wxDELETE(wxTheColourDatabase);
 
-    delete wxPendingEvents;
-    wxPendingEvents = NULL;
+    wxAppConsole::CleanUp();
+}
 
-#if wxUSE_THREADS
-    delete wxPendingEventsLocker;
-    wxPendingEventsLocker = NULL;
+// ----------------------------------------------------------------------------
+// various accessors
+// ----------------------------------------------------------------------------
+
+wxWindow* wxAppBase::GetTopWindow() const
+{
+    wxWindow* window = m_topWindow;
+    if (window == NULL && wxTopLevelWindows.GetCount() > 0)
+        window = wxTopLevelWindows.GetFirst()->GetData();
+    return window;
+}
+
+wxVideoMode wxAppBase::GetDisplayMode() const
+{
+    return wxVideoMode();
+}
+
+wxLayoutDirection wxAppBase::GetLayoutDirection() const
+{
+#if wxUSE_INTL
+    const wxLocale *const locale = wxGetLocale();
+    if ( locale )
+    {
+        const wxLanguageInfo *const
+            info = wxLocale::GetLanguageInfo(locale->GetLanguage());
+
+        if ( info )
+            return info->LayoutDirection;
+    }
+#endif // wxUSE_INTL
 
-    #if wxUSE_VALIDATORS
-        // If we don't do the following, we get an apparent memory leak.
-        ((wxEvtHandler&) wxDefaultValidator).ClearEventLocker();
-    #endif // wxUSE_VALIDATORS
-#endif // wxUSE_THREADS
+    // we don't know
+    return wxLayout_Default;
 }
 
 #if wxUSE_CMDLINE_PARSER
@@ -160,8 +174,8 @@ void wxAppBase::CleanUp()
 // GUI-specific command line options handling
 // ----------------------------------------------------------------------------
 
-#define OPTION_THEME   _T("theme")
-#define OPTION_MODE    _T("mode")
+#define OPTION_THEME   "theme"
+#define OPTION_MODE    "mode"
 
 void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
 {
@@ -174,7 +188,7 @@ void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
 #ifdef __WXUNIVERSAL__
         {
             wxCMD_LINE_OPTION,
-            _T(""),
+            NULL,
             OPTION_THEME,
             gettext_noop("specify the theme to use"),
             wxCMD_LINE_VAL_STRING,
@@ -182,29 +196,22 @@ void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
         },
 #endif // __WXUNIVERSAL__
 
-#if defined(__WXMGL__)
-        // VS: this is not specific to wxMGL, all fullscreen (framebuffer) ports
+#if defined(__WXDFB__)
+        // VS: this is not specific to wxDFB, all fullscreen (framebuffer) ports
         //     should provide this option. That's why it is in common/appcmn.cpp
-        //     and not mgl/app.cpp
+        //     and not dfb/app.cpp
         {
             wxCMD_LINE_OPTION,
-            _T(""),
+            NULL,
             OPTION_MODE,
             gettext_noop("specify display mode to use (e.g. 640x480-16)"),
             wxCMD_LINE_VAL_STRING,
             0x0
         },
-#endif // __WXMGL__
+#endif // __WXDFB__
 
         // terminator
-        {
-            wxCMD_LINE_NONE,
-            _T(""),
-            _T(""),
-            _T(""),
-            wxCMD_LINE_VAL_NONE,
-            0x0
-        }
+        wxCMD_LINE_DESC_END
     };
 
     parser.SetDesc(cmdLineGUIDesc);
@@ -220,7 +227,7 @@ bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
         if ( !theme )
         {
             wxLogError(_("Unsupported theme '%s'."), themeName.c_str());
-            return FALSE;
+            return false;
         }
 
         // Delete the defaultly created theme and set the new theme.
@@ -229,80 +236,27 @@ bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
     }
 #endif // __WXUNIVERSAL__
 
-#if defined(__WXMGL__)
+#if defined(__WXDFB__)
     wxString modeDesc;
     if ( parser.Found(OPTION_MODE, &modeDesc) )
     {
         unsigned w, h, bpp;
-        if ( wxSscanf(modeDesc.c_str(), _T("%ux%u-%u"), &w, &h, &bpp) != 3 )
+        if ( wxSscanf(modeDesc.c_str(), wxT("%ux%u-%u"), &w, &h, &bpp) != 3 )
         {
             wxLogError(_("Invalid display mode specification '%s'."), modeDesc.c_str());
-            return FALSE;
+            return false;
         }
 
         if ( !SetDisplayMode(wxVideoMode(w, h, bpp)) )
-            return FALSE;
+            return false;
     }
-#endif // __WXMGL__
+#endif // __WXDFB__
 
     return wxAppConsole::OnCmdLineParsed(parser);
 }
 
 #endif // wxUSE_CMDLINE_PARSER
 
-// ----------------------------------------------------------------------------
-// main event loop implementation
-// ----------------------------------------------------------------------------
-
-int wxAppBase::MainLoop()
-{
-#if wxUSE_EVTLOOP_IN_APP
-    wxEventLoopTiedPtr mainLoop(&m_mainLoop, new wxEventLoop);
-
-    return m_mainLoop->Run();
-#else // !wxUSE_EVTLOOP_IN_APP
-    return 0;
-#endif // wxUSE_EVTLOOP_IN_APP/!wxUSE_EVTLOOP_IN_APP
-}
-
-void wxAppBase::ExitMainLoop()
-{
-#if wxUSE_EVTLOOP_IN_APP
-    // we should exit from the main event loop, not just any currently active
-    // (e.g. modal dialog) event loop
-    if ( m_mainLoop && m_mainLoop->IsRunning() )
-    {
-        m_mainLoop->Exit(0);
-    }
-#endif // wxUSE_EVTLOOP_IN_APP
-}
-
-bool wxAppBase::Pending()
-{
-#if wxUSE_EVTLOOP_IN_APP
-    // 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
-    wxEventLoop * const loop = wxEventLoop::GetActive();
-
-    return loop && loop->Pending();
-#else // wxUSE_EVTLOOP_IN_APP
-    return false;
-#endif // wxUSE_EVTLOOP_IN_APP/!wxUSE_EVTLOOP_IN_APP
-}
-
-bool wxAppBase::Dispatch()
-{
-#if wxUSE_EVTLOOP_IN_APP
-    // see comment in Pending()
-    wxEventLoop * const loop = wxEventLoop::GetActive();
-
-    return loop && loop->Dispatch();
-#else // wxUSE_EVTLOOP_IN_APP
-    return true;
-#endif // wxUSE_EVTLOOP_IN_APP/!wxUSE_EVTLOOP_IN_APP
-}
-
 // ----------------------------------------------------------------------------
 // OnXXX() hooks
 // ----------------------------------------------------------------------------
@@ -311,10 +265,10 @@ bool wxAppBase::OnInitGui()
 {
 #ifdef __WXUNIVERSAL__
     if ( !wxTheme::Get() && !wxTheme::CreateDefault() )
-        return FALSE;
+        return false;
 #endif // __WXUNIVERSAL__
 
-    return TRUE;
+    return true;
 }
 
 int wxAppBase::OnRun()
@@ -327,7 +281,7 @@ int wxAppBase::OnRun()
     }
     //else: it has been changed, assume the user knows what he is doing
 
-    return MainLoop();
+    return wxAppConsole::OnRun();
 }
 
 int wxAppBase::OnExit()
@@ -339,11 +293,6 @@ int wxAppBase::OnExit()
     return wxAppConsole::OnExit();
 }
 
-void wxAppBase::Exit()
-{
-    ExitMainLoop();
-}
-
 wxAppTraits *wxAppBase::CreateTraits()
 {
     return new wxGUIAppTraits;
@@ -366,97 +315,53 @@ void wxAppBase::SetActive(bool active, wxWindow * WXUNUSED(lastFocus))
     (void)ProcessEvent(event);
 }
 
-void wxAppBase::DeletePendingObjects()
+bool wxAppBase::SafeYield(wxWindow *win, bool onlyIfNeeded)
 {
-    wxList::compatibility_iterator node = wxPendingDelete.GetFirst();
-    while (node)
-    {
-        wxObject *obj = node->GetData();
+    wxWindowDisabler wd(win);
 
-        delete obj;
+    wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
 
-        if (wxPendingDelete.Member(obj))
-            wxPendingDelete.Erase(node);
+    return loop && loop->Yield(onlyIfNeeded);
+}
 
-        // Deleting one object may have deleted other pending
-        // objects, so start from beginning of list again.
-        node = wxPendingDelete.GetFirst();
-    }
+bool wxAppBase::SafeYieldFor(wxWindow *win, long eventsToProcess)
+{
+    wxWindowDisabler wd(win);
+
+    wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
+
+    return loop && loop->YieldFor(eventsToProcess);
 }
 
-// Returns TRUE if more time is needed.
+
+// ----------------------------------------------------------------------------
+// idle handling
+// ----------------------------------------------------------------------------
+
+// Returns true if more time is needed.
 bool wxAppBase::ProcessIdle()
 {
+    // call the base class version first to send the idle event to wxTheApp
+    // itself
+    bool needMore = wxAppConsoleBase::ProcessIdle();
     wxIdleEvent event;
-    bool needMore = FALSE;
     wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
     while (node)
     {
         wxWindow* win = node->GetData();
-        if (SendIdleEvents(win, event))
-            needMore = TRUE;
+
+        // Don't send idle events to the windows that are about to be destroyed
+        // anyhow, this is wasteful and unexpected.
+        if ( !wxPendingDelete.Member(win) && win->SendIdleEvents(event) )
+            needMore = true;
         node = node->GetNext();
     }
 
-    event.SetEventObject(this);
-    (void) ProcessEvent(event);
-    if (event.MoreRequested())
-        needMore = TRUE;
-
     wxUpdateUIEvent::ResetUpdateTime();
-    
-    return needMore;
-}
-
-// Send idle event to window and all subwindows
-bool wxAppBase::SendIdleEvents(wxWindow* win, wxIdleEvent& event)
-{
-    bool needMore = FALSE;
-
-    win->OnInternalIdle();
-
-    if (wxIdleEvent::CanSend(win))
-    {
-        event.SetEventObject(win);
-        win->GetEventHandler()->ProcessEvent(event);
-
-        if (event.MoreRequested())
-            needMore = TRUE;
-    }
-    wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
-    while ( node )
-    {
-        wxWindow *child = node->GetData();
-        if (SendIdleEvents(child, event))
-            needMore = TRUE;
-
-        node = node->GetNext();
-    }
 
     return needMore;
 }
 
-void wxAppBase::OnIdle(wxIdleEvent& WXUNUSED(event))
-{
-    // If there are pending events, we must process them: pending events
-    // are either events to the threads other than main or events posted
-    // with wxPostEvent() functions
-    // GRG: I have moved this here so that all pending events are processed
-    //   before starting to delete any objects. This behaves better (in
-    //   particular, wrt wxPostEvent) and is coherent with wxGTK's current
-    //   behaviour. Changed Feb/2000 before 2.1.14
-    ProcessPendingEvents();
-
-    // 'Garbage' collection of windows deleted with Close().
-    DeletePendingObjects();
-
-#if wxUSE_LOG
-    // flush the logged messages if any
-    wxLog::FlushActive();
-#endif // wxUSE_LOG
-
-}
-
 // ----------------------------------------------------------------------------
 // wxGUIAppTraitsBase
 // ----------------------------------------------------------------------------
@@ -466,9 +371,13 @@ void wxAppBase::OnIdle(wxIdleEvent& WXUNUSED(event))
 wxLog *wxGUIAppTraitsBase::CreateLogTarget()
 {
 #if wxUSE_LOGGUI
+#ifndef __WXOSX_IPHONE__
     return new wxLogGui;
 #else
-    // wem ust have something!
+    return new wxLogStderr;
+#endif
+#else
+    // we must have something!
     return new wxLogStderr;
 #endif
 }
@@ -481,15 +390,18 @@ wxMessageOutput *wxGUIAppTraitsBase::CreateMessageOutput()
     // is (according to common practice):
     //     - console apps: to stderr (on any platform)
     //     - GUI apps: stderr on Unix platforms (!)
-    //                 message box under Windows and others
+    //                 stderr if available and message box otherwise on others
+    //                 (currently stderr only Windows if app running from console)
 #ifdef __UNIX__
     return new wxMessageOutputStderr;
 #else // !__UNIX__
     // wxMessageOutputMessageBox doesn't work under Motif
     #ifdef __WXMOTIF__
         return new wxMessageOutputLog;
+    #elif wxUSE_MSGDLG
+        return new wxMessageOutputBest(wxMSGOUT_PREFER_STDERR);
     #else
-        return new wxMessageOutputMessageBox;
+        return new wxMessageOutputStderr;
     #endif
 #endif // __UNIX__/!__UNIX__
 }
@@ -509,43 +421,59 @@ wxRendererNative *wxGUIAppTraitsBase::CreateRenderer()
     return NULL;
 }
 
-#ifdef __WXDEBUG__
-
 bool wxGUIAppTraitsBase::ShowAssertDialog(const wxString& msg)
 {
+#if wxDEBUG_LEVEL
     // under MSW we prefer to use the base class version using ::MessageBox()
     // even if wxMessageBox() is available because it has less chances to
     // double fault our app than our wxMessageBox()
-#if defined(__WXMSW__) || !wxUSE_MSGDLG
-    return wxAppTraitsBase::ShowAssertDialog(msg);
-#else // wxUSE_MSGDLG
-    // this message is intentionally not translated -- it is for
-    // developpers only
-    wxString msgDlg(msg);
-    msgDlg += wxT("\nDo you want to stop the program?\n")
-              wxT("You can also choose [Cancel] to suppress ")
-              wxT("further warnings.");
-
-    switch ( wxMessageBox(msgDlg, wxT("wxWindows Debug Alert"),
-                          wxYES_NO | wxCANCEL | wxICON_STOP ) )
+    //
+    // under DFB the message dialog is not always functional right now
+    //
+    // and finally we can't use wxMessageBox() if it wasn't compiled in, of
+    // course
+#if !defined(__WXMSW__) && !defined(__WXDFB__) && wxUSE_MSGDLG
+
+    // we can't (safely) show the GUI dialog from another thread, only do it
+    // for the asserts in the main thread
+    if ( wxIsMainThread() )
     {
-        case wxYES:
-            wxTrap();
-            break;
+        wxString msgDlg = msg;
+
+#if wxUSE_STACKWALKER
+        const wxString stackTrace = GetAssertStackTrace();
+        if ( !stackTrace.empty() )
+            msgDlg << wxT("\n\nCall stack:\n") << stackTrace;
+#endif // wxUSE_STACKWALKER
+
+        // this message is intentionally not translated -- it is for
+        // developpers only
+        msgDlg += wxT("\nDo you want to stop the program?\n")
+                  wxT("You can also choose [Cancel] to suppress ")
+                  wxT("further warnings.");
+
+        switch ( wxMessageBox(msgDlg, wxT("wxWidgets Debug Alert"),
+                              wxYES_NO | wxCANCEL | wxICON_STOP ) )
+        {
+            case wxYES:
+                wxTrap();
+                break;
 
-        case wxCANCEL:
-            // no more asserts
-            return true;
+            case wxCANCEL:
+                // no more asserts
+                return true;
+
+            //case wxNO: nothing to do
+        }
 
-        //case wxNO: nothing to do
+        return false;
     }
+#endif // wxUSE_MSGDLG
+#endif // wxDEBUG_LEVEL
 
-    return false;
-#endif // !wxUSE_MSGDLG/wxUSE_MSGDLG
+    return wxAppTraitsBase::ShowAssertDialog(msg);
 }
 
-#endif // __WXDEBUG__
-
 bool wxGUIAppTraitsBase::HasStderr()
 {
     // we consider that under Unix stderr always goes somewhere, even if the
@@ -557,58 +485,3 @@ bool wxGUIAppTraitsBase::HasStderr()
 #endif
 }
 
-void wxGUIAppTraitsBase::ScheduleForDestroy(wxObject *object)
-{
-    if ( !wxPendingDelete.Member(object) )
-        wxPendingDelete.Append(object);
-}
-
-void wxGUIAppTraitsBase::RemoveFromPendingDelete(wxObject *object)
-{
-    wxPendingDelete.DeleteObject(object);
-}
-
-#if wxUSE_SOCKETS
-
-#if defined(__UNIX__) || defined(__DARWIN__) || defined(__OS2__)
-    #include "wx/unix/gsockunx.h"
-#elif defined(__WINDOWS__)
-    #include "wx/msw/gsockmsw.h"
-#elif defined(__WXMAC__)
-  #include <MacHeaders.c>
-  #define OTUNIXERRORS 1
-  #include <OpenTransport.h>
-  #include <OpenTransportProviders.h>
-  #include <OpenTptInternet.h>
-
-  #include "wx/mac/gsockmac.h"
-#else
-    #error "Must include correct GSocket header here"
-#endif
-
-GSocketGUIFunctionsTable* wxGUIAppTraitsBase::GetSocketGUIFunctionsTable()
-{
-#if defined(__WXMAC__) && !defined(__DARWIN__)
-    // NB: wxMac CFM does not have any GUI-specific functions in gsocket.c and
-    //     so it doesn't need this table at all
-    return NULL;
-#else // !__WXMAC__ || __DARWIN__
-    static GSocketGUIFunctionsTable table =
-    {
-        _GSocket_GUI_Init,
-        _GSocket_GUI_Cleanup,
-        _GSocket_GUI_Init_Socket,
-        _GSocket_GUI_Destroy_Socket,
-#ifndef __WINDOWS__
-        _GSocket_Install_Callback,
-        _GSocket_Uninstall_Callback,
-#endif
-        _GSocket_Enable_Events,
-        _GSocket_Disable_Events
-    };
-    return &table;
-#endif // !__WXMAC__ || __DARWIN__
-}
-
-#endif
-