Make code reading BMP files more robust.

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

diff --git a/src/common/appcmn.cpp b/src/common/appcmn.cpp
index 845d4ebc44d2f27bb95b15b78e17272bfc46691e..9a3ead6a33da8b33425146009df9afb0fca625fc 100644 (file)
--- a/src/common/appcmn.cpp
+++ b/src/common/appcmn.cpp
@@ -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
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     18.10.99


@@ -17,10 +17,6 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "appbase.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -30,22 +26,29 @@
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"

+    #include "wx/window.h"

     #include "wx/bitmap.h"
     #include "wx/bitmap.h"

-    #include "wx/intl.h"
-    #include "wx/list.h"

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

-    #include "wx/bitmap.h"

     #include "wx/confbase.h"
     #include "wx/confbase.h"

+    #include "wx/utils.h"
+    #include "wx/wxcrtvararg.h"

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

+#include "wx/cmdline.h"
+#include "wx/msgout.h"
+#include "wx/thread.h"
+#include "wx/vidmode.h"
+#include "wx/evtloop.h"
+

 #if wxUSE_FONTMAP
     #include "wx/fontmap.h"
 #endif // wxUSE_FONTMAP
 #if wxUSE_FONTMAP
     #include "wx/fontmap.h"
 #endif // wxUSE_FONTMAP

-#include "wx/msgout.h"
-#include "wx/thread.h"
-#include "wx/utils.h"
+
+// DLL options compatibility check:
+#include "wx/build.h"
+WX_CHECK_BUILD_OPTIONS("wxCore")

 
 // ============================================================================
 // wxAppBase implementation
 
 // ============================================================================
 // wxAppBase implementation


@@ -57,9 +60,12 @@
 
 wxAppBase::wxAppBase()
 {
 
 wxAppBase::wxAppBase()
 {

-    m_topWindow = (wxWindow *)NULL;
-    m_useBestVisual = FALSE;
-    m_isActive = TRUE;
+    m_topWindow = NULL;
+
+    m_useBestVisual = false;
+    m_forceTrueColour = false;
+
+    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
 
     // 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


@@ -67,32 +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
     // 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
     //
     // 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;
 }
 
     // 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;
 
         return false;
 

-#if wxUSE_THREADS
-    wxPendingEventsLocker = new wxCriticalSection;
-#endif
-
-    wxTheColourDatabase = new wxColourDatabase(wxKEY_STRING);
-    wxTheColourDatabase->Initialize();
-

     wxInitializeStockLists();
     wxInitializeStockLists();

-    wxInitializeStockObjects();

 
     wxBitmap::InitStandardHandlers();
 
 
     wxBitmap::InitStandardHandlers();
 

+    // for compatibility call the old initialization function too
+    if ( !OnInitGui() )
+        return false;
+

     return true;
 }
 
     return true;
 }
 


@@ -107,32 +109,154 @@ wxAppBase::~wxAppBase()
 
 void wxAppBase::CleanUp()
 {
 
 void wxAppBase::CleanUp()
 {

-    // one last chance for pending objects to be cleaned up
+    // clean up all the pending objects

     DeletePendingObjects();
 
     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();
 
     wxBitmap::CleanUpHandlers();
 

-    wxDeleteStockObjects();
+    wxStockGDI::DeleteAll();

 
     wxDeleteStockLists();
 
 
     wxDeleteStockLists();
 

-    delete wxTheColourDatabase;
-    wxTheColourDatabase = NULL;
+    wxDELETE(wxTheColourDatabase);
+
+    wxAppConsole::CleanUp();
+}
+
+// ----------------------------------------------------------------------------
+// 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
+
+    // we don't know
+    return wxLayout_Default;
+}
+
+#if wxUSE_CMDLINE_PARSER
+
+// ----------------------------------------------------------------------------
+// GUI-specific command line options handling
+// ----------------------------------------------------------------------------
+
+#define OPTION_THEME   "theme"
+#define OPTION_MODE    "mode"
+
+void wxAppBase::OnInitCmdLine(wxCmdLineParser& parser)
+{
+    // first add the standard non GUI options
+    wxAppConsole::OnInitCmdLine(parser);
+
+    // the standard command line options
+    static const wxCmdLineEntryDesc cmdLineGUIDesc[] =
+    {
+#ifdef __WXUNIVERSAL__
+        {
+            wxCMD_LINE_OPTION,
+            NULL,
+            OPTION_THEME,
+            gettext_noop("specify the theme to use"),
+            wxCMD_LINE_VAL_STRING,
+            0x0
+        },
+#endif // __WXUNIVERSAL__
+
+#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 dfb/app.cpp
+        {
+            wxCMD_LINE_OPTION,
+            NULL,
+            OPTION_MODE,
+            gettext_noop("specify display mode to use (e.g. 640x480-16)"),
+            wxCMD_LINE_VAL_STRING,
+            0x0
+        },
+#endif // __WXDFB__
+
+        // terminator
+        wxCMD_LINE_DESC_END
+    };
+
+    parser.SetDesc(cmdLineGUIDesc);
+}

 
 

-#if wxUSE_THREADS
-    delete wxPendingEvents;
-    wxPendingEvents = NULL;
+bool wxAppBase::OnCmdLineParsed(wxCmdLineParser& parser)
+{
+#ifdef __WXUNIVERSAL__
+    wxString themeName;
+    if ( parser.Found(OPTION_THEME, &themeName) )
+    {
+        wxTheme *theme = wxTheme::Create(themeName);
+        if ( !theme )
+        {
+            wxLogError(_("Unsupported theme '%s'."), themeName.c_str());
+            return false;
+        }
+
+        // Delete the defaultly created theme and set the new theme.
+        delete wxTheme::Get();
+        wxTheme::Set(theme);
+    }
+#endif // __WXUNIVERSAL__

 
 

-    delete wxPendingEventsLocker;
-    wxPendingEventsLocker = NULL;
+#if defined(__WXDFB__)
+    wxString modeDesc;
+    if ( parser.Found(OPTION_MODE, &modeDesc) )
+    {
+        unsigned w, h, bpp;
+        if ( wxSscanf(modeDesc.c_str(), wxT("%ux%u-%u"), &w, &h, &bpp) != 3 )
+        {
+            wxLogError(_("Invalid display mode specification '%s'."), modeDesc.c_str());
+            return false;
+        }
+
+        if ( !SetDisplayMode(wxVideoMode(w, h, bpp)) )
+            return false;
+    }
+#endif // __WXDFB__

 
 

-#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
+    return wxAppConsole::OnCmdLineParsed(parser);

 }
 
 }
 

+#endif // wxUSE_CMDLINE_PARSER
+

 // ----------------------------------------------------------------------------
 // OnXXX() hooks
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // OnXXX() hooks
 // ----------------------------------------------------------------------------


@@ -141,10 +265,10 @@ bool wxAppBase::OnInitGui()
 {
 #ifdef __WXUNIVERSAL__
     if ( !wxTheme::Get() && !wxTheme::CreateDefault() )
 {
 #ifdef __WXUNIVERSAL__
     if ( !wxTheme::Get() && !wxTheme::CreateDefault() )

-        return FALSE;
+        return false;

 #endif // __WXUNIVERSAL__
 
 #endif // __WXUNIVERSAL__
 

-    return TRUE;
+    return true;

 }
 
 int wxAppBase::OnRun()
 }
 
 int wxAppBase::OnRun()


@@ -157,12 +281,16 @@ int wxAppBase::OnRun()
     }
     //else: it has been changed, assume the user knows what he is doing
 
     }
     //else: it has been changed, assume the user knows what he is doing
 

-    return MainLoop();
+    return wxAppConsole::OnRun();

 }
 
 }
 

-void wxAppBase::Exit()
+int wxAppBase::OnExit()

 {
 {

-    ExitMainLoop();
+#ifdef __WXUNIVERSAL__
+    delete wxTheme::Set(NULL);
+#endif // __WXUNIVERSAL__
+
+    return wxAppConsole::OnExit();

 }
 
 wxAppTraits *wxAppBase::CreateTraits()
 }
 
 wxAppTraits *wxAppBase::CreateTraits()


@@ -187,22 +315,51 @@ void wxAppBase::SetActive(bool active, wxWindow * WXUNUSED(lastFocus))
     (void)ProcessEvent(event);
 }
 
     (void)ProcessEvent(event);
 }
 

-void wxAppBase::DeletePendingObjects()
+bool wxAppBase::SafeYield(wxWindow *win, bool onlyIfNeeded)
+{
+    wxWindowDisabler wd(win);
+
+    wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
+
+    return loop && loop->Yield(onlyIfNeeded);
+}
+
+bool wxAppBase::SafeYieldFor(wxWindow *win, long eventsToProcess)
+{
+    wxWindowDisabler wd(win);
+
+    wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
+
+    return loop && loop->YieldFor(eventsToProcess);
+}
+
+
+// ----------------------------------------------------------------------------
+// idle handling
+// ----------------------------------------------------------------------------
+
+// Returns true if more time is needed.
+bool wxAppBase::ProcessIdle()

 {
 {

-    wxNode *node = wxPendingDelete.GetFirst();
+    // call the base class version first to send the idle event to wxTheApp
+    // itself
+    bool needMore = wxAppConsoleBase::ProcessIdle();
+    wxIdleEvent event;
+    wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();

     while (node)
     {
     while (node)
     {

-        wxObject *obj = node->GetData();
+        wxWindow* win = node->GetData();

 
 

-        delete obj;
+        // 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();
+    }

 
 

-        if (wxPendingDelete.Member(obj))
-            delete node;
+    wxUpdateUIEvent::ResetUpdateTime();

 
 

-        // Deleting one object may have deleted other pending
-        // objects, so start from beginning of list again.
-        node = wxPendingDelete.GetFirst();
-    }
+    return needMore;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -213,7 +370,16 @@ void wxAppBase::DeletePendingObjects()
 
 wxLog *wxGUIAppTraitsBase::CreateLogTarget()
 {
 
 wxLog *wxGUIAppTraitsBase::CreateLogTarget()
 {

+#if wxUSE_LOGGUI
+#ifndef __WXOSX_IPHONE__

     return new wxLogGui;
     return new wxLogGui;

+#else
+    return new wxLogStderr;
+#endif
+#else
+    // we must have something!
+    return new wxLogStderr;
+#endif

 }
 
 #endif // wxUSE_LOG
 }
 
 #endif // wxUSE_LOG


@@ -224,15 +390,18 @@ wxMessageOutput *wxGUIAppTraitsBase::CreateMessageOutput()
     // is (according to common practice):
     //     - console apps: to stderr (on any platform)
     //     - GUI apps: stderr on Unix platforms (!)
     // 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;
 #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
     #else

-        return new wxMessageOutputMessageBox;
+        return new wxMessageOutputStderr;

     #endif
 #endif // __UNIX__/!__UNIX__
 }
     #endif
 #endif // __UNIX__/!__UNIX__
 }


@@ -246,43 +415,65 @@ wxFontMapper *wxGUIAppTraitsBase::CreateFontMapper()
 
 #endif // wxUSE_FONTMAP
 
 
 #endif // wxUSE_FONTMAP
 

-#ifdef __WXDEBUG__
+wxRendererNative *wxGUIAppTraitsBase::CreateRenderer()
+{
+    // use the default native renderer by default
+    return NULL;
+}

 
 bool wxGUIAppTraitsBase::ShowAssertDialog(const wxString& msg)
 {
 
 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()
     // 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 ) )
-    {
-        case wxYES:
-            wxTrap();
-            break;
+    //
+    // 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

 
 

-        case wxCANCEL:
-            // no more asserts
-            return true;
+    // we can't (safely) show the GUI dialog from another thread, only do it
+    // for the asserts in the main thread
+    if ( wxIsMainThread() )
+    {
+        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 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
 bool wxGUIAppTraitsBase::HasStderr()
 {
     // we consider that under Unix stderr always goes somewhere, even if the


@@ -294,14 +485,3 @@ bool wxGUIAppTraitsBase::HasStderr()
 #endif
 }
 
 #endif
 }
 

-void wxGUIAppTraitsBase::ScheduleForDestroy(wxObject *object)
-{
-    if ( !wxPendingDelete.Member(object) )
-        wxPendingDelete.Append(object);
-}
-
-void wxGUIAppTraitsBase::RemoveFromPendingDelete(wxObject *object)
-{
-    wxPendingDelete.DeleteObject(object);
-}
-