X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b87e74ace5a543f09467f77f16721bdc1958f80..f1b63efe8993c6c0460354bc2da7331526d43efa:/include/wx/evtloop.h diff --git a/include/wx/evtloop.h b/include/wx/evtloop.h index 4a70021ec3..6841c61fd0 100644 --- a/include/wx/evtloop.h +++ b/include/wx/evtloop.h @@ -14,13 +14,11 @@ #include "wx/utils.h" -class WXDLLEXPORT wxEventLoop; - // ---------------------------------------------------------------------------- -// wxEventLoop: a GUI event loop +// wxEventLoopBase: interface for wxEventLoop // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxEventLoopBase +class WXDLLIMPEXP_BASE wxEventLoopBase { public: // trivial, but needed (because of wxEventLoopBase) ctor @@ -29,6 +27,11 @@ public: // dtor virtual ~wxEventLoopBase() { } + // use this to check whether the event loop was successfully created before + // using it + virtual bool IsOk() const { return true; } + + // start the event loop, return the exit code when it is finished virtual int Run() = 0; @@ -41,11 +44,17 @@ public: // dispatch a single event, return false if we should exit from the loop virtual bool Dispatch() = 0; + // same as Dispatch() but doesn't wait for longer than the specified (in + // ms) timeout, return true if an event was processed, false if we should + // exit the loop or -1 if timeout expired + virtual int DispatchTimeout(unsigned long timeout) = 0; + + // return currently active (running) event loop, may be NULL - static wxEventLoop *GetActive() { return ms_activeLoop; } + static wxEventLoopBase *GetActive() { return ms_activeLoop; } // set currently active (running) event loop - static void SetActive(wxEventLoop* loop) { ms_activeLoop = loop; } + static void SetActive(wxEventLoopBase* loop) { ms_activeLoop = loop; } // is this event loop running now? // @@ -53,6 +62,10 @@ public: // spawned a nested (e.g. modal) event loop, this would return false bool IsRunning() const; + // implement this to wake up the loop: usually done by posting a dummy event + // to it (can be called from non main thread) + virtual void WakeUp() = 0; + protected: // this function should be called before the event loop terminates, whether // this happens normally (because of Exit() call) or abnormally (because of @@ -61,18 +74,18 @@ protected: // the pointer to currently active loop - static wxEventLoop *ms_activeLoop; + static wxEventLoopBase *ms_activeLoop; DECLARE_NO_COPY_CLASS(wxEventLoopBase) }; -#if defined(__WXMSW__) || defined(__WXMAC__) +#if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXDFB__) || defined(__UNIX__) // this class can be used to implement a standard event loop logic using // Pending() and Dispatch() // // it also handles idle processing automatically -class WXDLLEXPORT wxEventLoopManual : public wxEventLoopBase +class WXDLLIMPEXP_BASE wxEventLoopManual : public wxEventLoopBase { public: wxEventLoopManual(); @@ -86,10 +99,6 @@ public: virtual void Exit(int rc = 0); protected: - // implement this to wake up the loop: usually done by posting a dummy event - // to it (called from Exit()) - virtual void WakeUp() = 0; - // may be overridden to perform some action at the start of each new event // loop iteration virtual void OnNextIteration() { } @@ -114,33 +123,76 @@ protected: #elif defined(__WXMSW__) #include "wx/msw/evtloop.h" #elif defined(__WXMAC__) - #include "wx/mac/evtloop.h" + #include "wx/osx/evtloop.h" +#elif defined(__WXCOCOA__) + #include "wx/cocoa/evtloop.h" +#elif defined(__WXDFB__) + #include "wx/dfb/evtloop.h" +#elif defined(__WXGTK20__) + #include "wx/gtk/evtloop.h" #else // other platform -class WXDLLEXPORT wxEventLoopImpl; +#include "wx/stopwatch.h" // for wxMilliClock_t + +class WXDLLIMPEXP_FWD_CORE wxEventLoopImpl; -class WXDLLEXPORT wxEventLoop : public wxEventLoopBase +class WXDLLIMPEXP_CORE wxGUIEventLoop : public wxEventLoopBase { public: - wxEventLoop() { m_impl = NULL; } - virtual ~wxEventLoop(); + wxGUIEventLoop() { m_impl = NULL; } + virtual ~wxGUIEventLoop(); virtual int Run(); virtual void Exit(int rc = 0); virtual bool Pending() const; virtual bool Dispatch(); + virtual int DispatchTimeout(unsigned long timeout) + { + // TODO: this is, of course, horribly inefficient and a proper wait with + // timeout should be implemented for all ports natively... + const wxMilliClock_t timeEnd = wxGetLocalTimeMillis() + timeout; + for ( ;; ) + { + if ( Pending() ) + return Dispatch(); + + if ( wxGetLocalTimeMillis() >= timeEnd ) + return -1; + } + } + virtual void WakeUp() { } protected: // the pointer to the port specific implementation class wxEventLoopImpl *m_impl; - DECLARE_NO_COPY_CLASS(wxEventLoop) + DECLARE_NO_COPY_CLASS(wxGUIEventLoop) }; #endif // platforms +// also include the header defining wxConsoleEventLoop for Unix systems +#if defined(__UNIX__) + #include "wx/unix/evtloop.h" +#endif + +// we use a class rather than a typedef because wxEventLoop is forward-declared +// in many places +#if wxUSE_GUI + class wxEventLoop : public wxGUIEventLoop { }; +#else // !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__)) + #define wxEventLoop wxConsoleEventLoop + #else // we still must define it somehow for the code below... + #define wxEventLoop wxEventLoopBase + #endif +#endif + inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; } +#if wxUSE_GUI // ---------------------------------------------------------------------------- // wxModalEventLoop // ---------------------------------------------------------------------------- @@ -149,7 +201,7 @@ inline bool wxEventLoopBase::IsRunning() const { return GetActive() == this; } // implement modality, we will surely need platform-specific implementations // too, this generic implementation is here only temporarily to see how it // works -class WXDLLEXPORT wxModalEventLoop : public wxEventLoop +class WXDLLIMPEXP_CORE wxModalEventLoop : public wxGUIEventLoop { public: wxModalEventLoop(wxWindow *winModal) @@ -163,13 +215,15 @@ protected: delete m_windowDisabler; m_windowDisabler = NULL; - wxEventLoop::OnExit(); + wxGUIEventLoop::OnExit(); } private: wxWindowDisabler *m_windowDisabler; }; +#endif //wxUSE_GUI + // ---------------------------------------------------------------------------- // wxEventLoopActivator: helper class for wxEventLoop implementations // ---------------------------------------------------------------------------- @@ -180,20 +234,50 @@ private: class wxEventLoopActivator { public: - wxEventLoopActivator(wxEventLoop *evtLoop) + wxEventLoopActivator(wxEventLoopBase *evtLoop) { - m_evtLoopOld = wxEventLoop::GetActive(); - wxEventLoop::SetActive(evtLoop); + m_evtLoopOld = wxEventLoopBase::GetActive(); + wxEventLoopBase::SetActive(evtLoop); } ~wxEventLoopActivator() { // restore the previously active event loop - wxEventLoop::SetActive(m_evtLoopOld); + wxEventLoopBase::SetActive(m_evtLoopOld); + } + +private: + wxEventLoopBase *m_evtLoopOld; +}; + +#if wxUSE_CONSOLE_EVENTLOOP + +class wxEventLoopGuarantor +{ +public: + wxEventLoopGuarantor() + { + m_evtLoopNew = NULL; + if (!wxEventLoop::GetActive()) + { + m_evtLoopNew = new wxEventLoop; + wxEventLoop::SetActive(m_evtLoopNew); + } + } + + ~wxEventLoopGuarantor() + { + if (m_evtLoopNew) + { + wxEventLoop::SetActive(NULL); + delete m_evtLoopNew; + } } private: - wxEventLoop *m_evtLoopOld; + wxEventLoop *m_evtLoopNew; }; +#endif // wxUSE_CONSOLE_EVENTLOOP + #endif // _WX_EVTLOOP_H_