// Author: Vadim Zeitlin
// Modified by:
// Created: 01.06.01
-// RCS-ID: $Id$
// Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#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;
+ // 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
- 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?
//
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;
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();
+ // 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;
+ // should we exit the loop?
+ bool m_shouldExit;
+
// YieldFor() helpers:
bool m_isInsideYield;
long m_eventsToProcessInsideYield;
+ // this flag is set on entry into Run() and reset before leaving it
+ bool m_isInsideRun;
+private:
+
wxDECLARE_NO_COPY_CLASS(wxEventLoopBase);
};
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
- virtual void Exit(int rc = 0);
+ virtual void ScheduleExit(int rc = 0);
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() { }
// the loop exit code
int m_exitcode;
- // 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)
#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/evtloop.h"
-#elif wxUSE_GUI
+ #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
#include "wx/msw/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__)
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 void ScheduleExit(int rc = 0);
virtual bool Pending() const;
virtual bool Dispatch();
virtual int DispatchTimeout(unsigned long timeout)
virtual bool YieldFor(long eventsToProcess);
protected:
+ virtual int DoRun();
+
// the pointer to the port specific implementation class
wxEventLoopImpl *m_impl;
#endif // wxUSE_GUI
-// include the header defining wxConsoleEventLoop for Unix systems
-#if defined(__UNIX__) && !defined(__WXMSW__)
-#include "wx/unix/evtloop.h"
-#elif defined(__WINDOWS__)
-#include "wx/msw/evtloopconsole.h"
-#endif
-
#if wxUSE_GUI
// we use a class rather than a typedef because wxEventLoop is
// forward-declared in many places
projects / wxWidgets.git / blobdiff