fix the definition of many static functions marked as 'const' or functions which...

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

diff --git a/src/common/appcmn.cpp b/src/common/appcmn.cpp
index b01cdd229c74331915ea13c555bb99395c8eb0ef..af5a1d8eceed2902caa0b532b4c7644760cfe43f 100644 (file)
--- a/src/common/appcmn.cpp
+++ b/src/common/appcmn.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        common/appcmn.cpp
+// Name:        src/common/appcmn.cpp

 // Purpose:     wxAppBase methods common to all platforms
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxAppBase methods common to all platforms
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -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,57 +26,518 @@
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"
 
 #ifndef WX_PRECOMP
     #include "wx/app.h"

-    #include "wx/list.h"
+    #include "wx/window.h"
+    #include "wx/bitmap.h"
+    #include "wx/log.h"
+    #include "wx/msgdlg.h"
+    #include "wx/confbase.h"
+    #include "wx/utils.h"
+    #include "wx/wxcrtvararg.h"

 #endif
 
 #endif
 

+#include "wx/apptrait.h"
+#include "wx/cmdline.h"
+#include "wx/msgout.h"

 #include "wx/thread.h"
 #include "wx/thread.h"

-#include "wx/confbase.h"
+#include "wx/vidmode.h"

 
 

-// ===========================================================================
-// implementation
-// ===========================================================================
+#ifdef __WXDEBUG__
+    #if wxUSE_STACKWALKER
+        #include "wx/stackwalk.h"
+    #endif // wxUSE_STACKWALKER
+#endif // __WXDEBUG__

 
 

-// ---------------------------------------------------------------------------
-// wxAppBase
+#if defined(__WXMSW__)
+    #include  "wx/msw/private.h"  // includes windows.h for LOGFONT
+#endif
+
+#if wxUSE_FONTMAP
+    #include "wx/fontmap.h"
+#endif // wxUSE_FONTMAP
+
+// DLL options compatibility check:
+#include "wx/build.h"
+WX_CHECK_BUILD_OPTIONS("wxCore")
+
+WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
+
+// ============================================================================
+// wxAppBase implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// initialization

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-void wxAppBase::ProcessPendingEvents()
+wxAppBase::wxAppBase()

 {
 {

-    // ensure that we're the only thread to modify the pending events list
-    wxENTER_CRIT_SECT( *wxPendingEventsLocker );
+    m_topWindow = (wxWindow *)NULL;
+
+    m_useBestVisual = false;
+    m_forceTrueColour = false;
+
+    m_isActive = true;
+
+    m_isInsideYield = false;
+
+    // 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
+    // to Yes initially as this dialog would be the last top level window.
+    // 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().
+    //
+    // So we use the special "Later" value which is such that
+    // 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& argcOrig, wxChar **argvOrig)
+{
+    if ( !wxAppConsole::Initialize(argcOrig, argvOrig) )
+        return false;
+
+    wxInitializeStockLists();
+
+    wxBitmap::InitStandardHandlers();
+
+    return true;
+}

 
 

-    if ( !wxPendingEvents )
+// ----------------------------------------------------------------------------
+// cleanup
+// ----------------------------------------------------------------------------
+
+wxAppBase::~wxAppBase()
+{
+    // this destructor is required for Darwin
+}
+
+void wxAppBase::CleanUp()
+{
+    // 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();
+
+    wxStockGDI::DeleteAll();
+
+    wxDeleteStockLists();
+
+    delete wxTheColourDatabase;
+    wxTheColourDatabase = NULL;
+
+    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(__WXMGL__)
+        // VS: this is not specific to wxMGL, all fullscreen (framebuffer) ports
+        //     should provide this option. That's why it is in common/appcmn.cpp
+        //     and not mgl/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 // __WXMGL__
+
+        // terminator
+        wxCMD_LINE_DESC_END
+    };
+
+    parser.SetDesc(cmdLineGUIDesc);
+}
+
+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__
+
+#if defined(__WXMGL__)
+    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 )
+        {
+            wxLogError(_("Invalid display mode specification '%s'."), modeDesc.c_str());
+            return false;
+        }
+
+        if ( !SetDisplayMode(wxVideoMode(w, h, bpp)) )
+            return false;
+    }
+#endif // __WXMGL__
+
+    return wxAppConsole::OnCmdLineParsed(parser);
+}
+
+#endif // wxUSE_CMDLINE_PARSER
+
+// ----------------------------------------------------------------------------
+// OnXXX() hooks
+// ----------------------------------------------------------------------------
+
+bool wxAppBase::OnInitGui()
+{
+#ifdef __WXUNIVERSAL__
+    if ( !wxTheme::Get() && !wxTheme::CreateDefault() )
+        return false;
+#endif // __WXUNIVERSAL__
+
+    return true;
+}
+
+int wxAppBase::OnRun()
+{
+    // see the comment in ctor: if the initial value hasn't been changed, use
+    // the default Yes from now on
+    if ( m_exitOnFrameDelete == Later )

     {
     {

-        wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
+        m_exitOnFrameDelete = Yes;
+    }
+    //else: it has been changed, assume the user knows what he is doing
+
+    return wxAppConsole::OnRun();
+}
+
+int wxAppBase::OnExit()
+{
+#ifdef __WXUNIVERSAL__
+    delete wxTheme::Set(NULL);
+#endif // __WXUNIVERSAL__
+
+    return wxAppConsole::OnExit();
+}
+
+wxAppTraits *wxAppBase::CreateTraits()
+{
+    return new wxGUIAppTraits;
+}
+
+// ----------------------------------------------------------------------------
+// misc
+// ----------------------------------------------------------------------------
+
+void wxAppBase::SetActive(bool active, wxWindow * WXUNUSED(lastFocus))
+{
+    if ( active == m_isActive )

         return;
         return;

+
+    m_isActive = active;
+
+    wxActivateEvent event(wxEVT_ACTIVATE_APP, active);
+    event.SetEventObject(this);
+
+    (void)ProcessEvent(event);
+}
+
+// ----------------------------------------------------------------------------
+// idle handling
+// ----------------------------------------------------------------------------
+
+void wxAppBase::DeletePendingObjects()
+{
+    wxList::compatibility_iterator node = wxPendingDelete.GetFirst();
+    while (node)
+    {
+        wxObject *obj = node->GetData();
+
+        // remove it from the list first so that if we get back here somehow
+        // during the object deletion (e.g. wxYield called from its dtor) we
+        // wouldn't try to delete it the second time
+        if ( wxPendingDelete.Member(obj) )
+            wxPendingDelete.Erase(node);
+
+        delete obj;
+
+        // Deleting one object may have deleted other pending
+        // objects, so start from beginning of list again.
+        node = wxPendingDelete.GetFirst();

     }
     }

+}

 
 

-    // iterate until the list becomes empty
-    wxNode *node = wxPendingEvents->First();
+// Returns true if more time is needed.
+bool wxAppBase::ProcessIdle()
+{
+    // call the base class version first, it will process the pending events
+    // (which should be done before the idle events generation) and send the
+    // idle event to wxTheApp itself
+    bool needMore = wxAppConsoleBase::ProcessIdle();
+    wxIdleEvent event;
+    wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();

     while (node)
     {
     while (node)
     {

-        wxEvtHandler *handler = (wxEvtHandler *)node->Data();
-        delete node;
+        wxWindow* win = node->GetData();
+        if (SendIdleEvents(win, event))
+            needMore = true;
+        node = node->GetNext();
+    }
+
+    // 'Garbage' collection of windows deleted with Close().
+    DeletePendingObjects();

 
 

-        // In ProcessPendingEvents(), new handlers might be add
-       // and we can safely leave the critical section here.
-        wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
-        handler->ProcessPendingEvents();
-        wxENTER_CRIT_SECT( *wxPendingEventsLocker );
+#if wxUSE_LOG
+    // flush the logged messages if any
+    wxLog::FlushActive();
+#endif
+
+    wxUpdateUIEvent::ResetUpdateTime();
+
+    return needMore;
+}
+
+// Send idle event to window and all subwindows
+bool wxAppBase::SendIdleEvents(wxWindow* win, wxIdleEvent& event)
+{
+    bool needMore = false;

 
 

-        node = wxPendingEvents->First();
+    win->OnInternalIdle();
+
+    // should we send idle event to this window?
+    if ( wxIdleEvent::GetMode() == wxIDLE_PROCESS_ALL ||
+            win->HasExtraStyle(wxWS_EX_PROCESS_IDLE) )
+    {
+        event.SetEventObject(win);
+        win->HandleWindowEvent(event);
+
+        if (event.MoreRequested())
+            needMore = true;

     }
     }

-    
-    wxLEAVE_CRIT_SECT( *wxPendingEventsLocker );
+    wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
+    while ( node )
+    {
+        wxWindow *child = node->GetData();
+        if (SendIdleEvents(child, event))
+            needMore = true;
+
+        node = node->GetNext();
+    }
+
+    return needMore;

 }
 
 }
 

-int wxAppBase::OnExit()
+// ----------------------------------------------------------------------------
+// wxGUIAppTraitsBase
+// ----------------------------------------------------------------------------
+
+#if wxUSE_LOG
+
+wxLog *wxGUIAppTraitsBase::CreateLogTarget()
+{
+#if wxUSE_LOGGUI
+    return new wxLogGui;
+#else
+    // we must have something!
+    return new wxLogStderr;
+#endif
+}
+
+#endif // wxUSE_LOG
+
+wxMessageOutput *wxGUIAppTraitsBase::CreateMessageOutput()
+{
+    // The standard way of printing help on command line arguments (app --help)
+    // is (according to common practice):
+    //     - console apps: to stderr (on any platform)
+    //     - GUI apps: stderr on Unix platforms (!)
+    //                 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 wxMessageOutputStderr;
+    #endif
+#endif // __UNIX__/!__UNIX__
+}
+
+#if wxUSE_FONTMAP
+
+wxFontMapper *wxGUIAppTraitsBase::CreateFontMapper()
+{
+    return new wxFontMapper;
+}
+
+#endif // wxUSE_FONTMAP
+
+wxRendererNative *wxGUIAppTraitsBase::CreateRenderer()
+{
+    // use the default native renderer by default
+    return NULL;
+}
+
+#ifdef __WXDEBUG__
+
+bool wxGUIAppTraitsBase::ShowAssertDialog(const wxString& msg)
+{
+    // 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 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
+    return wxAppTraitsBase::ShowAssertDialog(msg);
+#else // wxUSE_MSGDLG
+    wxString msgDlg = msg;
+
+#if wxUSE_STACKWALKER
+    // on Unix stack frame generation may take some time, depending on the
+    // size of the executable mainly... warn the user that we are working
+    wxFprintf(stderr, wxT("[Debug] Generating a stack trace... please wait"));
+    fflush(stderr);
+
+    const wxString stackTrace = GetAssertStackTrace();
+    if ( !stackTrace.empty() )
+        msgDlg << _T("\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
+    }
+
+    return false;
+#endif // !wxUSE_MSGDLG/wxUSE_MSGDLG
+}
+
+#endif // __WXDEBUG__
+
+bool wxGUIAppTraitsBase::HasStderr()

 {
 {

-#if wxUSE_CONFIG
-    // delete the config object if any (don't use Get() here, but Set()
-    // because Get() could create a new config object)
-    delete wxConfigBase::Set((wxConfigBase *) NULL);
-#endif // wxUSE_CONFIG
+    // we consider that under Unix stderr always goes somewhere, even if the
+    // user doesn't always see it under GUI desktops
+#ifdef __UNIX__
+    return true;
+#else
+    return false;
+#endif
+}

 
 

-    return 0;
+void wxGUIAppTraitsBase::ScheduleForDestroy(wxObject *object)
+{
+    if ( !wxPendingDelete.Member(object) )
+        wxPendingDelete.Append(object);

 }
 }

+
+void wxGUIAppTraitsBase::RemoveFromPendingDelete(wxObject *object)
+{
+    wxPendingDelete.DeleteObject(object);
+}
+