adding OnLaunched

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

diff --git a/src/common/evtloopcmn.cpp b/src/common/evtloopcmn.cpp
index d824c3182240f579acb92d24107458fe753046f9..2408d6e26b1e5162db8e5347de951715dfc3a5a6 100644 (file)
--- a/src/common/evtloopcmn.cpp
+++ b/src/common/evtloopcmn.cpp
@@ -2,10 +2,10 @@
 // Name:        src/common/evtloopcmn.cpp
 // Purpose:     common wxEventLoop-related stuff
 // Author:      Vadim Zeitlin
 // Name:        src/common/evtloopcmn.cpp
 // Purpose:     common wxEventLoop-related stuff
 // Author:      Vadim Zeitlin

-// Modified by:

 // Created:     2006-01-12
 // RCS-ID:      $Id$
 // Created:     2006-01-12
 // RCS-ID:      $Id$

-// Copyright:   (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2006, 2013 Vadim Zeitlin <vadim@wxwindows.org>
+//              (c) 2013 Rob Bresalier

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -22,6 +22,10 @@
     #include "wx/app.h"
 #endif //WX_PRECOMP
 
     #include "wx/app.h"
 #endif //WX_PRECOMP
 

+#include "wx/scopeguard.h"
+#include "wx/apptrait.h"
+#include "wx/private/eventloopsourcesmanager.h"
+

 // ----------------------------------------------------------------------------
 // wxEventLoopBase
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxEventLoopBase
 // ----------------------------------------------------------------------------


@@ -30,6 +34,9 @@ wxEventLoopBase *wxEventLoopBase::ms_activeLoop = NULL;
 
 wxEventLoopBase::wxEventLoopBase()
 {
 
 wxEventLoopBase::wxEventLoopBase()
 {

+    m_isInsideRun = false;
+    m_shouldExit = false;
+

     m_isInsideYield = false;
     m_eventsToProcessInsideYield = wxEVT_CATEGORY_ALL;
 }
     m_isInsideYield = false;
     m_eventsToProcessInsideYield = wxEVT_CATEGORY_ALL;
 }


@@ -50,6 +57,35 @@ void wxEventLoopBase::SetActive(wxEventLoopBase* loop)
         wxTheApp->OnEventLoopEnter(loop);
 }
 
         wxTheApp->OnEventLoopEnter(loop);
 }
 

+int wxEventLoopBase::Run()
+{
+    // event loops are not recursive, you need to create another loop!
+    wxCHECK_MSG( !IsInsideRun(), -1, wxT("can't reenter a message loop") );
+
+    // ProcessIdle() and ProcessEvents() below may throw so the code here should
+    // be exception-safe, hence we must use local objects for all actions we
+    // should undo
+    wxEventLoopActivator activate(this);
+
+    // We might be called again, after a previous call to ScheduleExit(), so
+    // reset this flag.
+    m_shouldExit = false;
+
+    // Set this variable to true for the duration of this method.
+    m_isInsideRun = true;
+    wxON_BLOCK_EXIT_SET(m_isInsideRun, false);
+
+    // Finally really run the loop.
+    return DoRun();
+}
+
+void wxEventLoopBase::Exit(int rc)
+{
+    wxCHECK_RET( IsRunning(), wxS("Use ScheduleExit() on not running loop") );
+
+    ScheduleExit(rc);
+}
+

 void wxEventLoopBase::OnExit()
 {
     if (wxTheApp)
 void wxEventLoopBase::OnExit()
 {
     if (wxTheApp)


@@ -81,6 +117,27 @@ bool wxEventLoopBase::Yield(bool onlyIfNeeded)
     return YieldFor(wxEVT_CATEGORY_ALL);
 }
 
     return YieldFor(wxEVT_CATEGORY_ALL);
 }
 

+#if wxUSE_EVENTLOOP_SOURCE
+
+wxEventLoopSource*
+wxEventLoopBase::AddSourceForFD(int fd,
+                                wxEventLoopSourceHandler *handler,
+                                int flags)
+{
+#if wxUSE_CONSOLE_EVENTLOOP
+    // Delegate to the event loop sources manager defined by it.
+    wxEventLoopSourcesManagerBase* const
+        manager = wxApp::GetValidTraits().GetEventLoopSourcesManager();
+    wxCHECK_MSG( manager, NULL, wxS("Must have wxEventLoopSourcesManager") );
+
+    return manager->AddSourceForFD(fd, handler, flags);
+#else // !wxUSE_CONSOLE_EVENTLOOP
+    return NULL;
+#endif // wxUSE_CONSOLE_EVENTLOOP/!wxUSE_CONSOLE_EVENTLOOP
+}
+
+#endif // wxUSE_EVENTLOOP_SOURCE
+

 // wxEventLoopManual is unused in the other ports
 #if defined(__WINDOWS__) || defined(__WXDFB__) || ( ( defined(__UNIX__) && !defined(__WXOSX__) ) && wxUSE_BASE)
 
 // wxEventLoopManual is unused in the other ports
 #if defined(__WINDOWS__) || defined(__WXDFB__) || ( ( defined(__UNIX__) && !defined(__WXOSX__) ) && wxUSE_BASE)
 


@@ -91,7 +148,6 @@ bool wxEventLoopBase::Yield(bool onlyIfNeeded)
 wxEventLoopManual::wxEventLoopManual()
 {
     m_exitcode = 0;
 wxEventLoopManual::wxEventLoopManual()
 {
     m_exitcode = 0;

-    m_shouldExit = false;

 }
 
 bool wxEventLoopManual::ProcessEvents()
 }
 
 bool wxEventLoopManual::ProcessEvents()


@@ -104,21 +160,21 @@ bool wxEventLoopManual::ProcessEvents()
     // and this input is only removed from it when pending event handlers are
     // executed)
     if ( wxTheApp )
     // and this input is only removed from it when pending event handlers are
     // executed)
     if ( wxTheApp )

+    {

         wxTheApp->ProcessPendingEvents();
 
         wxTheApp->ProcessPendingEvents();
 

+        // One of the pending event handlers could have decided to exit the
+        // loop so check for the flag before trying to dispatch more events
+        // (which could block indefinitely if no more are coming).
+        if ( m_shouldExit )
+            return false;
+    }
+

     return Dispatch();
 }
 
     return Dispatch();
 }
 

-int wxEventLoopManual::Run()
+int wxEventLoopManual::DoRun()

 {
 {

-    // event loops are not recursive, you need to create another loop!
-    wxCHECK_MSG( !IsRunning(), -1, wxT("can't reenter a message loop") );
-
-    // ProcessIdle() and ProcessEvents() below may throw so the code here should
-    // be exception-safe, hence we must use local objects for all actions we
-    // should undo
-    wxEventLoopActivator activate(this);
-

     // we must ensure that OnExit() is called even if an exception is thrown
     // from inside ProcessEvents() but we must call it from Exit() in normal
     // situations because it is supposed to be called synchronously,
     // we must ensure that OnExit() is called even if an exception is thrown
     // from inside ProcessEvents() but we must call it from Exit() in normal
     // situations because it is supposed to be called synchronously,


@@ -139,19 +195,11 @@ int wxEventLoopManual::Run()
 
                 // generate and process idle events for as long as we don't
                 // have anything else to do
 
                 // generate and process idle events for as long as we don't
                 // have anything else to do

-                while ( !Pending() && ProcessIdle() && !m_shouldExit )
+                while ( !m_shouldExit && !Pending() && ProcessIdle() )

                     ;
 
                     ;
 

-                // if the "should exit" flag is set, the loop should terminate
-                // but not before processing any remaining messages so while
-                // Pending() returns true, do process them

                 if ( m_shouldExit )
                 if ( m_shouldExit )

-                {
-                    while ( Pending() )
-                        ProcessEvents();
-

                     break;
                     break;

-                }

 
                 // a message came or no more idle processing to do, dispatch
                 // all the pending events and call Dispatch() to wait for the
 
                 // a message came or no more idle processing to do, dispatch
                 // all the pending events and call Dispatch() to wait for the


@@ -163,6 +211,33 @@ int wxEventLoopManual::Run()
                 }
             }
 
                 }
             }
 

+            // Process the remaining queued messages, both at the level of the
+            // underlying toolkit level (Pending/Dispatch()) and wx level
+            // (Has/ProcessPendingEvents()).
+            //
+            // We do run the risk of never exiting this loop if pending event
+            // handlers endlessly generate new events but they shouldn't do
+            // this in a well-behaved program and we shouldn't just discard the
+            // events we already have, they might be important.
+            for ( ;; )
+            {
+                bool hasMoreEvents = false;
+                if ( wxTheApp && wxTheApp->HasPendingEvents() )
+                {
+                    wxTheApp->ProcessPendingEvents();
+                    hasMoreEvents = true;
+                }
+
+                if ( Pending() )
+                {
+                    Dispatch();
+                    hasMoreEvents = true;
+                }
+
+                if ( !hasMoreEvents )
+                    break;
+            }
+

 #if wxUSE_EXCEPTIONS
             // exit the outer loop as well
             break;
 #if wxUSE_EXCEPTIONS
             // exit the outer loop as well
             break;


@@ -193,9 +268,9 @@ int wxEventLoopManual::Run()
     return m_exitcode;
 }
 
     return m_exitcode;
 }
 

-void wxEventLoopManual::Exit(int rc)
+void wxEventLoopManual::ScheduleExit(int rc)

 {
 {

-    wxCHECK_RET( IsRunning(), wxT("can't call Exit() if not running") );
+    wxCHECK_RET( IsInsideRun(), wxT("can't call ScheduleExit() if not running") );

 
     m_exitcode = rc;
     m_shouldExit = true;
 
     m_exitcode = rc;
     m_shouldExit = true;