cleanup for 10.5

[wxWidgets.git] / src / generic / timer.cpp

diff --git a/src/generic/timer.cpp b/src/generic/timer.cpp
index 39974a6b8e361efac41926879df2acce05aea7cb..a2daf62003aac3cd53fa04e0be7ae480de910899 100644 (file)
--- a/src/generic/timer.cpp
+++ b/src/generic/timer.cpp
@@ -1,16 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        mgl/timer.cpp
+// Name:        src/generic/timer.cpp

 // Purpose:     wxTimer implementation
 // Author:      Vaclav Slavik
 // Id:          $Id$
 // Purpose:     wxTimer implementation
 // Author:      Vaclav Slavik
 // Id:          $Id$

-// Copyright:   (c) 2001-2002 SciTech Software, Inc. (www.scitechsoft.com)
+// Copyright:   (c) Vaclav Slavik

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "timer.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -19,17 +15,19 @@
 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------

-// NB: when using generic wxTimer implementation in your port, you *must* call 
-//     wxTimer::NotifyTimers() often enough. The ideal place for this 
+// NB: when using generic wxTimer implementation in your port, you *must* call
+//     wxTimer::NotifyTimers() often enough. The ideal place for this

 //     is in wxEventLoop::Dispatch().
 // ----------------------------------------------------------------------------
 
 //     is in wxEventLoop::Dispatch().
 // ----------------------------------------------------------------------------
 

-#include "wx/timer.h"
-

 #if wxUSE_TIMER
 
 #if wxUSE_TIMER
 

-#include "wx/log.h"
-#include "wx/module.h"
+#include "wx/timer.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/module.h"
+#endif

 
 // ----------------------------------------------------------------------------
 // Time input function
 
 // ----------------------------------------------------------------------------
 // Time input function


@@ -41,10 +39,52 @@
     // if we are unlucky and the latter combines information from two sources.
     #include "wx/mgl/private.h"
     extern "C" ulong _EVT_getTicks();
     // if we are unlucky and the latter combines information from two sources.
     #include "wx/mgl/private.h"
     extern "C" ulong _EVT_getTicks();

-    #define GetMillisecondsTime() _EVT_getTicks()
-#else
-    #define GetMillisecondsTime() wxGetLocalTimeMillis().ToLong()
-#endif
+    #define GetMillisecondsTime _EVT_getTicks
+
+    typedef ulong wxTimerTick_t;
+
+    #define wxTimerTickFmtSpec _T("lu")
+    #define wxTimerTickPrintfArg(tt) (tt)
+
+    #ifdef __DOS__
+        // Under DOS the MGL timer has a 24hr period, so consider the 12 hours
+        // before y to be 'less' and the the 12 hours after 'greater' modulo
+        // 24 hours.
+        inline bool wxTickGreaterEqual(wxTimerTick_t x, wxTimerTick_t y)
+        {
+            // _EVT_getTicks wraps at 1573040 * 55
+            const wxTimerTick_t modulus = 1573040 * 55;
+            return (2 * modulus + x - y) % modulus < modulus / 2;
+        }
+    #else
+        // If wxTimerTick_t is 32-bits then it'll wrap in around 50 days. So
+        // let the 25 days before y be 'less' and 25 days after be 'greater'.
+        inline bool wxTickGreaterEqual(wxTimerTick_t x, wxTimerTick_t y)
+        {
+            // This code assumes wxTimerTick_t is an unsigned type.
+            // Set half_modulus with top bit set and the rest zeros.
+            const wxTimerTick_t half_modulus = ~((~(wxTimerTick_t)0) >> 1);
+            return x - y < half_modulus;
+        }
+    #endif
+#else // !__WXMGL__
+    #define GetMillisecondsTime wxGetLocalTimeMillis
+
+    typedef wxLongLong wxTimerTick_t;
+
+    #if wxUSE_LONGLONG_WX
+        #define wxTimerTickFmtSpec wxLongLongFmtSpec _T("d")
+        #define wxTimerTickPrintfArg(tt) (tt.GetValue())
+    #else // using native wxLongLong
+        #define wxTimerTickFmtSpec _T("s")
+        #define wxTimerTickPrintfArg(tt) (tt.ToString().c_str())
+    #endif // wx/native long long
+
+    inline bool wxTickGreaterEqual(wxTimerTick_t x, wxTimerTick_t y)
+    {
+        return x >= y;
+    }
+#endif // __WXMGL__/!__WXMGL__

 
 // ----------------------------------------------------------------------------
 // helper structures and wxTimerScheduler
 
 // ----------------------------------------------------------------------------
 // helper structures and wxTimerScheduler


@@ -53,14 +93,14 @@
 class wxTimerDesc
 {
 public:
 class wxTimerDesc
 {
 public:

-    wxTimerDesc(wxTimer *t) : 
-        timer(t), running(FALSE), next(NULL), prev(NULL), 
+    wxTimerDesc(wxTimer *t) :
+        timer(t), running(false), next(NULL), prev(NULL),

         shotTime(0), deleteFlag(NULL) {}
 
     wxTimer         *timer;
     bool             running;
     wxTimerDesc     *next, *prev;
         shotTime(0), deleteFlag(NULL) {}
 
     wxTimer         *timer;
     bool             running;
     wxTimerDesc     *next, *prev;

-    unsigned long    shotTime;  
+    wxTimerTick_t    shotTime;

     volatile bool   *deleteFlag; // see comment in ~wxTimer
 };
 
     volatile bool   *deleteFlag; // see comment in ~wxTimer
 };
 


@@ -69,26 +109,27 @@ class wxTimerScheduler
 public:
     wxTimerScheduler() : m_timers(NULL) {}
 
 public:
     wxTimerScheduler() : m_timers(NULL) {}
 

-    void QueueTimer(wxTimerDesc *desc, unsigned long when = 0);
+    void QueueTimer(wxTimerDesc *desc, wxTimerTick_t when = 0);

     void RemoveTimer(wxTimerDesc *desc);
     void NotifyTimers();
     void RemoveTimer(wxTimerDesc *desc);
     void NotifyTimers();

-   
+

 private:
     wxTimerDesc *m_timers;
 };
 
 private:
     wxTimerDesc *m_timers;
 };
 

-void wxTimerScheduler::QueueTimer(wxTimerDesc *desc, unsigned long when)
+void wxTimerScheduler::QueueTimer(wxTimerDesc *desc, wxTimerTick_t when)

 {
     if ( desc->running )
         return; // already scheduled
 {
     if ( desc->running )
         return; // already scheduled

-        
+

     if ( when == 0 )
         when = GetMillisecondsTime() + desc->timer->GetInterval();
     desc->shotTime = when;
     if ( when == 0 )
         when = GetMillisecondsTime() + desc->timer->GetInterval();
     desc->shotTime = when;

-    desc->running = TRUE;
+    desc->running = true;

 
 

-    wxLogTrace("timer", "queued timer %p at tick %i", 
-               desc->timer, when);
+    wxLogTrace( wxT("timer"),
+                wxT("queued timer %p at tick %") wxTimerTickFmtSpec,
+               desc->timer,  wxTimerTickPrintfArg(when));

 
     if ( m_timers )
     {
 
     if ( m_timers )
     {


@@ -109,7 +150,7 @@ void wxTimerScheduler::QueueTimer(wxTimerDesc *desc, unsigned long when)
 
 void wxTimerScheduler::RemoveTimer(wxTimerDesc *desc)
 {
 
 void wxTimerScheduler::RemoveTimer(wxTimerDesc *desc)
 {

-    desc->running = FALSE;
+    desc->running = false;

     if ( desc == m_timers )
         m_timers = desc->next;
     if ( desc->prev )
     if ( desc == m_timers )
         m_timers = desc->next;
     if ( desc->prev )


@@ -125,27 +166,37 @@ void wxTimerScheduler::NotifyTimers()
     {
         bool oneShot;
         volatile bool timerDeleted;
     {
         bool oneShot;
         volatile bool timerDeleted;

-        unsigned long now = GetMillisecondsTime();
-        wxTimerDesc *desc;
+        wxTimerTick_t now = GetMillisecondsTime();

 
 

-        while ( m_timers && m_timers->shotTime <= now )
+        for ( wxTimerDesc *desc = m_timers; desc; desc = desc->next )

         {
         {

-            desc = m_timers;
-            oneShot = desc->timer->IsOneShot();
-            RemoveTimer(desc);
-
-            timerDeleted = FALSE;
-            desc->deleteFlag = &timerDeleted;
-            desc->timer->Notify();
-            
-            if ( !timerDeleted )
+            if ( desc->running && wxTickGreaterEqual(now, desc->shotTime) )

             {
             {

-                wxLogTrace("timer", "notified timer %p sheduled for %i", 
-                           desc->timer, desc->shotTime);
-
-                desc->deleteFlag = NULL;
-                if ( !oneShot )
-                    QueueTimer(desc, now + desc->timer->GetInterval());
+                oneShot = desc->timer->IsOneShot();
+                RemoveTimer(desc);
+
+                timerDeleted = false;
+                desc->deleteFlag = &timerDeleted;
+                desc->timer->Notify();
+
+                if ( !timerDeleted )
+                {
+                    wxLogTrace( wxT("timer"),
+                                wxT("notified timer %p sheduled for %")
+                                wxTimerTickFmtSpec,
+                                desc->timer,
+                                wxTimerTickPrintfArg(desc->shotTime) );
+
+                    desc->deleteFlag = NULL;
+                    if ( !oneShot )
+                        QueueTimer(desc, now + desc->timer->GetInterval());
+                }
+                else
+                {
+                    desc = m_timers;
+                    if (!desc)
+                        break;
+                }

             }
         }
     }
             }
         }
     }


@@ -156,7 +207,7 @@ void wxTimerScheduler::NotifyTimers()
 // wxTimer
 // ----------------------------------------------------------------------------
 
 // wxTimer
 // ----------------------------------------------------------------------------
 

-IMPLEMENT_ABSTRACT_CLASS(wxTimer,wxObject)
+IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)

 
 wxTimerScheduler *gs_scheduler = NULL;
 
 
 wxTimerScheduler *gs_scheduler = NULL;
 


@@ -169,19 +220,19 @@ void wxTimer::Init()
 
 wxTimer::~wxTimer()
 {
 
 wxTimer::~wxTimer()
 {

-    wxLogTrace("timer", "destroying timer %p...", this);
+    wxLogTrace( wxT("timer"), wxT("destroying timer %p..."), this);

     if ( IsRunning() )
         Stop();
 
     // NB: this is a hack: wxTimerScheduler must have some way of knowing
     if ( IsRunning() )
         Stop();
 
     // NB: this is a hack: wxTimerScheduler must have some way of knowing

-    //     that wxTimer object was deleted under its hands -- this may 
+    //     that wxTimer object was deleted under its hands -- this may

     //     happen if somebody is really nasty and deletes the timer
     //     from wxTimer::Notify()
     if ( m_desc->deleteFlag != NULL )
     //     happen if somebody is really nasty and deletes the timer
     //     from wxTimer::Notify()
     if ( m_desc->deleteFlag != NULL )

-        *m_desc->deleteFlag = TRUE;
+        *m_desc->deleteFlag = true;

 
     delete m_desc;
 
     delete m_desc;

-    wxLogTrace("timer", "    ...done destroying timer %p...", this);
+    wxLogTrace( wxT("timer"), wxT("    ...done destroying timer %p..."), this);

 }
 
 bool wxTimer::IsRunning() const
 }
 
 bool wxTimer::IsRunning() const


@@ -191,20 +242,20 @@ bool wxTimer::IsRunning() const
 
 bool wxTimer::Start(int millisecs, bool oneShot)
 {
 
 bool wxTimer::Start(int millisecs, bool oneShot)
 {

-    wxLogTrace("timer", "started timer %p: %i ms, oneshot=%i", 
+    wxLogTrace( wxT("timer"), wxT("started timer %p: %i ms, oneshot=%i"),

                this, millisecs, oneShot);
 
     if ( !wxTimerBase::Start(millisecs, oneShot) )
                this, millisecs, oneShot);
 
     if ( !wxTimerBase::Start(millisecs, oneShot) )

-        return FALSE;
-    
+        return false;
+

     gs_scheduler->QueueTimer(m_desc);
     gs_scheduler->QueueTimer(m_desc);

-    return TRUE;
+    return true;

 }
 
 void wxTimer::Stop()
 {
     if ( !m_desc->running ) return;
 }
 
 void wxTimer::Stop()
 {
     if ( !m_desc->running ) return;

-    
+

     gs_scheduler->RemoveTimer(m_desc);
 }
 
     gs_scheduler->RemoveTimer(m_desc);
 }
 


@@ -222,7 +273,7 @@ class wxTimerModule: public wxModule
 DECLARE_DYNAMIC_CLASS(wxTimerModule)
 public:
     wxTimerModule() {}
 DECLARE_DYNAMIC_CLASS(wxTimerModule)
 public:
     wxTimerModule() {}

-    bool OnInit() { return TRUE; }
+    bool OnInit() { return true; }

     void OnExit() { delete gs_scheduler; gs_scheduler = NULL; }
 };
 
     void OnExit() { delete gs_scheduler; gs_scheduler = NULL; }
 };