supporting clang memory management annotations

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

diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h
index df144fb97aaf60452455f4f351f276844cf94368..aafd2bce55bf7952a7afec32892b351f417a013f 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(__CYGWIN__))
+    #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,6 +77,12 @@ 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
+    // start monitoring it
+    virtual wxEventLoopSource *
+      AddSourceForFD(int fd, wxEventLoopSourceHandler *handler, int flags) = 0;
+#endif // wxUSE_EVENTLOOP_SOURCE

 
     // dispatch&processing
     // -------------------
 
     // dispatch&processing
     // -------------------


@@ -96,46 +115,16 @@ public:
     virtual void WakeUp() = 0;
 
 
     virtual void WakeUp() = 0;
 
 

-    // pending events
-    // --------------
-
-    // process all events in the wxHandlersWithPendingEvents list -- it is necessary
-    // to call this function to process posted events. This happens during each
-    // event loop iteration in GUI mode but if there is no main loop, it may be
-    // also called directly.
-    virtual void ProcessPendingEvents();
-
-    // check if there are pending events on global pending event list
-    bool HasPendingEvents() const;
-
-    // temporary suspends processing of the pending events
-    void SuspendProcessingOfPendingEvents();
-
-    // resume processing of the pending events previously stopped because of a
-    // call to SuspendProcessingOfPendingEvents()
-    void ResumeProcessingOfPendingEvents();
-
-    // called by ~wxEvtHandler to (eventually) remove the handler from the list of
-    // the handlers with pending events
-    void RemovePendingEventHandler(wxEvtHandler* toRemove);
-
-    // adds an event handler to the list of the handlers with pending events
-    void AppendPendingEventHandler(wxEvtHandler* toAppend);
-
-    // moves the event handler from the list of the handlers with pending events
-    //to the list of the handlers with _delayed_ pending events
-    void DelayPendingEventHandler(wxEvtHandler* toDelay);
-
-

     // idle handling
     // -------------
 
     // idle handling
     // -------------
 

-    // make sure that idle events are sent again
+        // make sure that idle events are sent again

     virtual void WakeUpIdle();
 
         // this virtual function is called  when the application
     virtual void WakeUpIdle();
 
         // this virtual function is called  when the application

-        // becomes idle and normally just sends wxIdleEvent to all interested
-        // parties
+        // becomes idle and by default it forwards to wxApp::ProcessIdle() and
+        // while it can be overridden in a custom event loop, you must call the
+        // base class version to ensure that idle events are still generated

         //
         // it should return true if more idle events are needed, false if not
     virtual bool ProcessIdle();
         //
         // it should return true if more idle events are needed, false if not
     virtual bool ProcessIdle();


@@ -144,25 +133,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; }
 


@@ -188,26 +177,14 @@ protected:
     // the pointer to currently active loop
     static wxEventLoopBase *ms_activeLoop;
 
     // the pointer to currently active loop
     static wxEventLoopBase *ms_activeLoop;
 

-    // the array of the handlers with pending events which needs to be processed
-    // inside ProcessPendingEvents()
-    wxEvtHandlerArray m_handlersWithPendingEvents;
-
-    // helper array used by ProcessPendingEvents()
-    wxEvtHandlerArray m_handlersWithPendingDelayedEvents;
-
-#if wxUSE_THREADS
-    // this critical section protects both the lists above
-    wxCriticalSection m_handlersWithPendingEventsLocker;
-#endif
-
-    // Yield() helpers:
+    // YieldFor() helpers:

     bool m_isInsideYield;
     long m_eventsToProcessInsideYield;
 
     wxDECLARE_NO_COPY_CLASS(wxEventLoopBase);
 };
 
     bool m_isInsideYield;
     long m_eventsToProcessInsideYield;
 
     wxDECLARE_NO_COPY_CLASS(wxEventLoopBase);
 };
 

-#if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXDFB__) || defined(__UNIX__)
+#if defined(__WXMSW__) || 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()


@@ -237,6 +214,15 @@ protected:
 
     // should we exit the loop?
     bool m_shouldExit;
 
     // should we exit the loop?
     bool m_shouldExit;

+
+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);

 };
 
 #endif // platforms using "manual" loop
 };
 
 #endif // platforms using "manual" loop


@@ -244,15 +230,21 @@ protected:
 // 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(__WXMSW__)
+    // this header defines both console and GUI loops for MSW

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

-#elif defined(__WXMAC__)
+#elif defined(__WXOSX__)
+    // 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/evtloop.h"
     #include "wx/osx/evtloop.h"

-#elif defined(__WXCOCOA__)
+#elif wxUSE_GUI
+
+// include the appropriate header defining wxGUIEventLoop
+
+#if defined(__WXCOCOA__)

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


@@ -270,6 +262,19 @@ public:
     wxGUIEventLoop() { m_impl = NULL; }
     virtual ~wxGUIEventLoop();
 
     wxGUIEventLoop() { m_impl = NULL; }
     virtual ~wxGUIEventLoop();
 

+#if wxUSE_EVENTLOOP_SOURCE
+    // We need to define a base class pure virtual method but we can't provide
+    // a generic implementation for it so simply fail.
+    virtual wxEventLoopSource *
+    AddSourceForFD(int WXUNUSED(fd),
+                   wxEventLoopSourceHandler * WXUNUSED(handler),
+                   int WXUNUSED(flags))
+    {
+        wxFAIL_MSG( "support for event loop sources not implemented" );
+        return NULL;
+    }
+#endif // wxUSE_EVENTLOOP_SOURCE
+

     virtual int Run();
     virtual void Exit(int rc = 0);
     virtual bool Pending() const;
     virtual int Run();
     virtual void Exit(int rc = 0);
     virtual bool Pending() const;


@@ -300,16 +305,18 @@ protected:
 
 #endif // platforms
 
 
 #endif // platforms
 

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

 #endif
 
 #endif
 

-// 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
     #if wxUSE_CONSOLE_EVENTLOOP && (defined(__WXMSW__) || defined(__UNIX__))
     // 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__))


@@ -321,7 +328,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
 // ----------------------------------------------------------------------------