Implement monitoring of file descriptors in wxMotif event loop.

[wxWidgets.git] / include / wx / evtloop.h

diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h
index ad58b1482c1e354a6e1353f0a51bf78050a77aca..a9034aeac8a03744c35bd82de5d53b72838c2c15 100644 (file)
--- a/include/wx/evtloop.h
+++ b/include/wx/evtloop.h
@@ -15,6 +15,19 @@
 #include "wx/event.h"
 #include "wx/utils.h"
 
 #include "wx/event.h"
 #include "wx/utils.h"
 

+// TODO: implement wxEventLoopSource for MSW (it should wrap a HANDLE and be
+//       monitored using MsgWaitForMultipleObjects())
+#if defined(__WXOSX__) || (defined(__UNIX__) && !defined(__WXMSW__))
+    #define wxUSE_EVENTLOOP_SOURCE 1
+#else
+    #define wxUSE_EVENTLOOP_SOURCE 0
+#endif
+
+#if wxUSE_EVENTLOOP_SOURCE
+    class wxEventLoopSource;
+    class wxEventLoopSourceHandler;
+#endif
+

 /*
     NOTE ABOUT wxEventLoopBase::YieldFor LOGIC
     ------------------------------------------
 /*
     NOTE ABOUT wxEventLoopBase::YieldFor LOGIC
     ------------------------------------------


@@ -64,12 +77,21 @@ public:
     // returns true if this is the main loop
     bool IsMain() const;
 
     // returns true if this is the main loop
     bool IsMain() const;
 

+#if wxUSE_EVENTLOOP_SOURCE
+    // create a new event loop source wrapping the given file descriptor and
+    // monitor it for events occurring on this descriptor in all event loops
+    static wxEventLoopSource *
+      AddSourceForFD(int fd, wxEventLoopSourceHandler *handler, int flags);
+#endif // wxUSE_EVENTLOOP_SOURCE

 
     // dispatch&processing
     // -------------------
 
     // start the event loop, return the exit code when it is finished
 
     // dispatch&processing
     // -------------------
 
     // start the event loop, return the exit code when it is finished

-    virtual int Run() = 0;
+    //
+    // notice that wx ports should override DoRun(), this method is virtual
+    // only to allow overriding it in the user code for custom event loops
+    virtual int Run();

 
     // is this event loop running now?
     //
 
     // is this event loop running now?
     //


@@ -78,7 +100,15 @@ public:
     bool IsRunning() const;
 
     // exit from the loop with the given exit code
     bool IsRunning() const;
 
     // exit from the loop with the given exit code

-    virtual void Exit(int rc = 0) = 0;
+    //
+    // this can be only used to exit the currently running loop, use
+    // ScheduleExit() if this might not be the case
+    virtual void Exit(int rc = 0);
+
+    // ask the event loop to exit with the given exit code, can be used even if
+    // this loop is not running right now but the loop must have been started,
+    // i.e. Run() should have been already called
+    virtual void ScheduleExit(int rc = 0) = 0;

 
     // return true if any events are available
     virtual bool Pending() const = 0;
 
     // return true if any events are available
     virtual bool Pending() const = 0;


@@ -114,25 +144,25 @@ public:
     // Yield-related hooks
     // -------------------
 
     // Yield-related hooks
     // -------------------
 

-        // process all currently pending events right now
-        //
-        // it is an error to call Yield() recursively unless the value of
-        // onlyIfNeeded is true
-        //
-        // WARNING: this function is dangerous as it can lead to unexpected
-        //          reentrancies (i.e. when called from an event handler it
-        //          may result in calling the same event handler again), use
-        //          with _extreme_ care or, better, don't use at all!
+    // process all currently pending events right now
+    //
+    // it is an error to call Yield() recursively unless the value of
+    // onlyIfNeeded is true
+    //
+    // WARNING: this function is dangerous as it can lead to unexpected
+    //          reentrancies (i.e. when called from an event handler it
+    //          may result in calling the same event handler again), use
+    //          with _extreme_ care or, better, don't use at all!

     bool Yield(bool onlyIfNeeded = false);
     virtual bool YieldFor(long eventsToProcess) = 0;
 
     bool Yield(bool onlyIfNeeded = false);
     virtual bool YieldFor(long eventsToProcess) = 0;
 

-        // returns true if the main thread is inside a Yield() call
+    // returns true if the main thread is inside a Yield() call

     virtual bool IsYielding() const
         { return m_isInsideYield; }
 
     virtual bool IsYielding() const
         { return m_isInsideYield; }
 

-        // returns true if events of the given event category should be immediately
-        // processed inside a wxApp::Yield() call or rather should be queued for
-        // later processing by the main event loop
+    // returns true if events of the given event category should be immediately
+    // processed inside a wxApp::Yield() call or rather should be queued for
+    // later processing by the main event loop

     virtual bool IsEventAllowedInsideYield(wxEventCategory cat) const
         { return (m_eventsToProcessInsideYield & cat) != 0; }
 
     virtual bool IsEventAllowedInsideYield(wxEventCategory cat) const
         { return (m_eventsToProcessInsideYield & cat) != 0; }
 


@@ -150,22 +180,38 @@ public:
 
 
 protected:
 
 
 protected:

+    // real implementation of Run()
+    virtual int DoRun() = 0;
+

     // this function should be called before the event loop terminates, whether
     // this happens normally (because of Exit() call) or abnormally (because of
     // an exception thrown from inside the loop)
     virtual void OnExit();
 
     // this function should be called before the event loop terminates, whether
     // this happens normally (because of Exit() call) or abnormally (because of
     // an exception thrown from inside the loop)
     virtual void OnExit();
 

+    // Return true if we're currently inside our Run(), even if another nested
+    // event loop is currently running, unlike IsRunning() (which should have
+    // been really called IsActive() but it's too late to change this now).
+    bool IsInsideRun() const { return m_isInsideRun; }
+
+

     // the pointer to currently active loop
     static wxEventLoopBase *ms_activeLoop;
 
     // the pointer to currently active loop
     static wxEventLoopBase *ms_activeLoop;
 

+    // should we exit the loop?
+    bool m_shouldExit;
+

     // YieldFor() helpers:
     bool m_isInsideYield;
     long m_eventsToProcessInsideYield;
 
     // YieldFor() helpers:
     bool m_isInsideYield;
     long m_eventsToProcessInsideYield;
 

+private:
+    // this flag is set on entry into Run() and reset before leaving it
+    bool m_isInsideRun;
+

     wxDECLARE_NO_COPY_CLASS(wxEventLoopBase);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxEventLoopBase);
 };
 

-#if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXDFB__) || defined(__UNIX__)
+#if defined(__WINDOWS__) || defined(__WXMAC__) || defined(__WXDFB__) || (defined(__UNIX__) && !defined(__WXOSX__))

 
 // this class can be used to implement a standard event loop logic using
 // Pending() and Dispatch()
 
 // this class can be used to implement a standard event loop logic using
 // Pending() and Dispatch()


@@ -176,15 +222,15 @@ class WXDLLIMPEXP_BASE wxEventLoopManual : public wxEventLoopBase
 public:
     wxEventLoopManual();
 
 public:
     wxEventLoopManual();
 

-    // enters a loop calling OnNextIteration(), Pending() and Dispatch() and
-    // terminating when Exit() is called
-    virtual int Run();
-

     // sets the "should exit" flag and wakes up the loop so that it terminates
     // soon
     // sets the "should exit" flag and wakes up the loop so that it terminates
     // soon

-    virtual void Exit(int rc = 0);
+    virtual void ScheduleExit(int rc = 0);

 
 protected:
 
 protected:

+    // enters a loop calling OnNextIteration(), Pending() and Dispatch() and
+    // terminating when Exit() is called
+    virtual int DoRun();
+

     // may be overridden to perform some action at the start of each new event
     // loop iteration
     virtual void OnNextIteration() { }
     // may be overridden to perform some action at the start of each new event
     // loop iteration
     virtual void OnNextIteration() { }


@@ -193,10 +239,13 @@ protected:
     // the loop exit code
     int m_exitcode;
 
     // the loop exit code
     int m_exitcode;
 

-    // should we exit the loop?
-    bool m_shouldExit;
-

 private:
 private:

+    // process all already pending events and dispatch a new one (blocking
+    // until it appears in the event queue if necessary)
+    //
+    // returns the return value of Dispatch()
+    bool ProcessEvents();
+

     wxDECLARE_NO_COPY_CLASS(wxEventLoopManual);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxEventLoopManual);
 };
 


@@ -205,16 +254,32 @@ private:
 // we're moving away from old m_impl wxEventLoop model as otherwise the user
 // code doesn't have access to platform-specific wxEventLoop methods and this
 // can sometimes be very useful (e.g. under MSW this is necessary for
 // we're moving away from old m_impl wxEventLoop model as otherwise the user
 // code doesn't have access to platform-specific wxEventLoop methods and this
 // can sometimes be very useful (e.g. under MSW this is necessary for

-// integration with MFC) but currently this is done for MSW only, other ports
-// should follow a.s.a.p.
-#if defined(__WXPALMOS__)
-    #include "wx/palmos/evtloop.h"
-#elif defined(__WXMSW__)
+// integration with MFC) but currently this is not done for all ports yet (e.g.
+// wxX11) so fall back to the old wxGUIEventLoop definition below for them
+
+#if defined(__DARWIN__)
+    // CoreFoundation-based event loop is currently in wxBase so include it in
+    // any case too (although maybe it actually shouldn't be there at all)
+    #include "wx/osx/core/evtloop.h"
+#endif
+
+// include the header defining wxConsoleEventLoop
+#if defined(__UNIX__) && !defined(__WXMSW__)
+    #include "wx/unix/evtloop.h"
+#elif defined(__WINDOWS__)
+    #include "wx/msw/evtloopconsole.h"
+#endif
+
+#if wxUSE_GUI
+
+// include the appropriate header defining wxGUIEventLoop
+
+#if defined(__WXMSW__)

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

-#elif defined(__WXMAC__)
-    #include "wx/osx/evtloop.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/evtloop.h"
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/evtloop.h"

+#elif defined(__WXOSX__)
+    #include "wx/osx/evtloop.h"

 #elif defined(__WXDFB__)
     #include "wx/dfb/evtloop.h"
 #elif defined(__WXGTK20__)
 #elif defined(__WXDFB__)
     #include "wx/dfb/evtloop.h"
 #elif defined(__WXGTK20__)


@@ -231,8 +296,7 @@ public:
     wxGUIEventLoop() { m_impl = NULL; }
     virtual ~wxGUIEventLoop();
 
     wxGUIEventLoop() { m_impl = NULL; }
     virtual ~wxGUIEventLoop();
 

-    virtual int Run();
-    virtual void Exit(int rc = 0);
+    virtual void ScheduleExit(int rc = 0);

     virtual bool Pending() const;
     virtual bool Dispatch();
     virtual int DispatchTimeout(unsigned long timeout)
     virtual bool Pending() const;
     virtual bool Dispatch();
     virtual int DispatchTimeout(unsigned long timeout)


@@ -253,6 +317,8 @@ public:
     virtual bool YieldFor(long eventsToProcess);
 
 protected:
     virtual bool YieldFor(long eventsToProcess);
 
 protected:

+    virtual int DoRun();
+

     // the pointer to the port specific implementation class
     wxEventLoopImpl *m_impl;
 
     // the pointer to the port specific implementation class
     wxEventLoopImpl *m_impl;
 


@@ -261,19 +327,16 @@ protected:
 
 #endif // platforms
 
 
 #endif // platforms
 

-// also include the header defining wxConsoleEventLoop for Unix systems
-#if defined(__UNIX__)
-    #include "wx/unix/evtloop.h"
-#endif
+#endif // wxUSE_GUI

 
 

-// we use a class rather than a typedef because wxEventLoop is forward-declared
-// in many places

 #if wxUSE_GUI
 #if wxUSE_GUI

+    // we use a class rather than a typedef because wxEventLoop is
+    // forward-declared in many places

     class wxEventLoop : public wxGUIEventLoop { };
     class wxEventLoop : public wxGUIEventLoop { };

-#else // !GUI
+#else // !wxUSE_GUI

     // we can't define wxEventLoop differently in GUI and base libraries so use
     // a #define to still allow writing wxEventLoop in the user code
     // we can't define wxEventLoop differently in GUI and base libraries so use
     // a #define to still allow writing wxEventLoop in the user code

-    #if wxUSE_CONSOLE_EVENTLOOP && (defined(__WXMSW__) || defined(__UNIX__))
+    #if wxUSE_CONSOLE_EVENTLOOP && (defined(__WINDOWS__) || defined(__UNIX__))

         #define wxEventLoop wxConsoleEventLoop
     #else // we still must define it somehow for the code below...
         #define wxEventLoop wxEventLoopBase
         #define wxEventLoop wxConsoleEventLoop
     #else // we still must define it somehow for the code below...
         #define wxEventLoop wxEventLoopBase


@@ -282,7 +345,7 @@ protected:
 
 inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; }
 
 
 inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; }
 

-#if wxUSE_GUI
+#if wxUSE_GUI && !defined(__WXOSX__)

 // ----------------------------------------------------------------------------
 // wxModalEventLoop
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxModalEventLoop
 // ----------------------------------------------------------------------------