src/generic/timer.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        mgl/timer.cpp
   3 // Purpose:     wxTimer implementation
   4 // Author:      Vaclav Slavik
   5 // Id:          $Id$
   6 // Copyright:   (c) Vaclav Slavik
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  11 #pragma implementation "timer.h"
  12 #endif
  13
  14 // For compilers that support precompilation, includes "wx.h".
  15 #include "wx/wxprec.h"
  16
  17 #ifdef __BORLANDC__
  18     #pragma hdrstop
  19 #endif
  20
  21 // ----------------------------------------------------------------------------
  22 // NB: when using generic wxTimer implementation in your port, you *must* call
  23 //     wxTimer::NotifyTimers() often enough. The ideal place for this
  24 //     is in wxEventLoop::Dispatch().
  25 // ----------------------------------------------------------------------------
  26
  27 #include "wx/timer.h"
  28
  29 #if wxUSE_TIMER
  30
  31 #include "wx/log.h"
  32 #include "wx/module.h"
  33
  34 // ----------------------------------------------------------------------------
  35 // Time input function
  36 // ----------------------------------------------------------------------------
  37
  38 #ifdef __WXMGL__
  39     // We take advantage of wxMGL's _EVT_getTicks because it is faster
  40     // (especially under MS-DOS!) and more precise than wxGetLocalTimeMillis
  41     // if we are unlucky and the latter combines information from two sources.
  42     #include "wx/mgl/private.h"
  43     extern "C" ulong _EVT_getTicks();
  44     #define GetMillisecondsTime _EVT_getTicks
  45
  46     typedef ulong wxTimerTick_t;
  47
  48     #define wxTimerTickFmtSpec _T("lu")
  49     #define wxTimerTickPrintfArg(tt) (tt)
  50 #else // !__WXMGL__
  51     #define GetMillisecondsTime wxGetLocalTimeMillis
  52
  53     typedef wxLongLong wxTimerTick_t;
  54
  55     #if wxUSE_LONGLONG_WX
  56         #define wxTimerTickFmtSpec wxLongLongFmtSpec _T("d")
  57         #define wxTimerTickPrintfArg(tt) (tt.GetValue())
  58     #else // using native wxLongLong
  59         #define wxTimerTickFmtSpec _T("s")
  60         #define wxTimerTickPrintfArg(tt) (tt.ToString().c_str())
  61     #endif // wx/native long long
  62 #endif // __WXMGL__/!__WXMGL__
  63
  64 // ----------------------------------------------------------------------------
  65 // helper structures and wxTimerScheduler
  66 // ----------------------------------------------------------------------------
  67
  68 class wxTimerDesc
  69 {
  70 public:
  71     wxTimerDesc(wxTimer *t) :
  72         timer(t), running(false), next(NULL), prev(NULL),
  73         shotTime(0), deleteFlag(NULL) {}
  74
  75     wxTimer         *timer;
  76     bool             running;
  77     wxTimerDesc     *next, *prev;
  78     wxTimerTick_t    shotTime;
  79     volatile bool   *deleteFlag; // see comment in ~wxTimer
  80 };
  81
  82 class wxTimerScheduler
  83 {
  84 public:
  85     wxTimerScheduler() : m_timers(NULL) {}
  86
  87     void QueueTimer(wxTimerDesc *desc, wxTimerTick_t when = 0);
  88     void RemoveTimer(wxTimerDesc *desc);
  89     void NotifyTimers();
  90
  91 private:
  92     wxTimerDesc *m_timers;
  93 };
  94
  95 void wxTimerScheduler::QueueTimer(wxTimerDesc *desc, wxTimerTick_t when)
  96 {
  97     if ( desc->running )
  98         return; // already scheduled
  99
 100     if ( when == 0 )
 101         when = GetMillisecondsTime() + desc->timer->GetInterval();
 102     desc->shotTime = when;
 103     desc->running = true;
 104
 105     wxLogTrace( wxT("timer"),
 106                 wxT("queued timer %p at tick %") wxTimerTickFmtSpec,
 107                desc->timer,  wxTimerTickPrintfArg(when));
 108
 109     if ( m_timers )
 110     {
 111         wxTimerDesc *d = m_timers;
 112         while ( d->next && d->next->shotTime < when ) d = d->next;
 113         desc->next = d->next;
 114         desc->prev = d;
 115         if ( d->next )
 116             d->next->prev = desc;
 117         d->next = desc;
 118     }
 119     else
 120     {
 121         m_timers = desc;
 122         desc->prev = desc->next = NULL;
 123     }
 124 }
 125
 126 void wxTimerScheduler::RemoveTimer(wxTimerDesc *desc)
 127 {
 128     desc->running = false;
 129     if ( desc == m_timers )
 130         m_timers = desc->next;
 131     if ( desc->prev )
 132         desc->prev->next = desc->next;
 133     if ( desc->next )
 134         desc->next->prev = desc->prev;
 135     desc->prev = desc->next = NULL;
 136 }
 137
 138 void wxTimerScheduler::NotifyTimers()
 139 {
 140     if ( m_timers )
 141     {
 142         bool oneShot;
 143         volatile bool timerDeleted;
 144         wxTimerTick_t now = GetMillisecondsTime();
 145         wxTimerDesc *desc;
 146
 147         while ( m_timers && m_timers->shotTime <= now )
 148         {
 149             desc = m_timers;
 150             oneShot = desc->timer->IsOneShot();
 151             RemoveTimer(desc);
 152
 153             timerDeleted = false;
 154             desc->deleteFlag = &timerDeleted;
 155             desc->timer->Notify();
 156
 157             if ( !timerDeleted )
 158             {
 159                 wxLogTrace( wxT("timer"),
 160                             wxT("notified timer %p sheduled for %")
 161                             wxTimerTickFmtSpec,
 162                             desc->timer,
 163                             wxTimerTickPrintfArg(desc->shotTime) );
 164
 165                 desc->deleteFlag = NULL;
 166                 if ( !oneShot )
 167                     QueueTimer(desc, now + desc->timer->GetInterval());
 168             }
 169         }
 170     }
 171 }
 172
 173
 174 // ----------------------------------------------------------------------------
 175 // wxTimer
 176 // ----------------------------------------------------------------------------
 177
 178 IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)
 179
 180 wxTimerScheduler *gs_scheduler = NULL;
 181
 182 void wxTimer::Init()
 183 {
 184     if ( !gs_scheduler )
 185         gs_scheduler = new wxTimerScheduler;
 186     m_desc = new wxTimerDesc(this);
 187 }
 188
 189 wxTimer::~wxTimer()
 190 {
 191     wxLogTrace( wxT("timer"), wxT("destroying timer %p..."), this);
 192     if ( IsRunning() )
 193         Stop();
 194
 195     // NB: this is a hack: wxTimerScheduler must have some way of knowing
 196     //     that wxTimer object was deleted under its hands -- this may
 197     //     happen if somebody is really nasty and deletes the timer
 198     //     from wxTimer::Notify()
 199     if ( m_desc->deleteFlag != NULL )
 200         *m_desc->deleteFlag = true;
 201
 202     delete m_desc;
 203     wxLogTrace( wxT("timer"), wxT("    ...done destroying timer %p..."), this);
 204 }
 205
 206 bool wxTimer::IsRunning() const
 207 {
 208     return m_desc->running;
 209 }
 210
 211 bool wxTimer::Start(int millisecs, bool oneShot)
 212 {
 213     wxLogTrace( wxT("timer"), wxT("started timer %p: %i ms, oneshot=%i"),
 214                this, millisecs, oneShot);
 215
 216     if ( !wxTimerBase::Start(millisecs, oneShot) )
 217         return false;
 218
 219     gs_scheduler->QueueTimer(m_desc);
 220     return true;
 221 }
 222
 223 void wxTimer::Stop()
 224 {
 225     if ( !m_desc->running ) return;
 226
 227     gs_scheduler->RemoveTimer(m_desc);
 228 }
 229
 230 /*static*/ void wxTimer::NotifyTimers()
 231 {
 232     if ( gs_scheduler )
 233         gs_scheduler->NotifyTimers();
 234 }
 235
 236
 237
 238 // A module to deallocate memory properly:
 239 class wxTimerModule: public wxModule
 240 {
 241 DECLARE_DYNAMIC_CLASS(wxTimerModule)
 242 public:
 243     wxTimerModule() {}
 244     bool OnInit() { return true; }
 245     void OnExit() { delete gs_scheduler; gs_scheduler = NULL; }
 246 };
 247
 248 IMPLEMENT_DYNAMIC_CLASS(wxTimerModule, wxModule)
 249
 250
 251 #endif //wxUSE_TIMER