]> git.saurik.com Git - wxWidgets.git/blobdiff - src/mac/carbon/timer.cpp
suppress warning about converting -1 to MenuItemIndex
[wxWidgets.git] / src / mac / carbon / timer.cpp
index d485c86b8c24cca0eedaa997a120bc1b23b14aba..3c576d0650f3af02cadce17bfce228dea1ee59b9 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        timer.cpp
+// Name:        sec/mac/carbon/timer.cpp
 // Purpose:     wxTimer implementation
-// Author:      AUTHOR
+// Author:      Stefan Csomor
 // Modified by:
-// Created:     ??/??/98
+// Created:     1998-01-01
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) Stefan Csomor
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "timer.h"
-#endif
+#include "wx/wxprec.h"
 
-#include "wx/timer.h"
+#if wxUSE_TIMER
 
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
+#ifndef WX_PRECOMP
+    #include "wx/dynarray.h"
 #endif
 
+#include "wx/timer.h"
+
 #ifdef __WXMAC__
-#include "wx/mac/private.h"
+    #include "wx/mac/private.h"
 #endif
+
 #ifndef __DARWIN__
-#include <Timer.h>
+    #include <Timer.h>
 #endif
 
+IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)
+
+#define wxMAC_USE_CARBON_TIMER 1
+
+#if wxMAC_USE_CARBON_TIMER
+
+struct MacTimerInfo
+{
+    wxTimer* m_timer;
+    EventLoopTimerUPP m_proc;
+    EventLoopTimerRef   m_timerRef;
+};
+
+static pascal void wxProcessTimer( EventLoopTimerRef theTimer, void *data );
+static pascal void wxProcessTimer( EventLoopTimerRef theTimer, void *data )
+{
+    if ( data == NULL )
+        return;
+
+    wxTimer* timer = (wxTimer*)data;
+
+    if ( timer->IsOneShot() )
+        timer->Stop();
+
+    timer->Notify();
+}
+
+void wxTimer::Init()
+{
+    m_info = new MacTimerInfo();
+    m_info->m_timer = this;
+    m_info->m_proc = NULL;
+    m_info->m_timerRef = kInvalidID;
+}
+
+bool wxTimer::IsRunning() const
+{
+    return ( m_info->m_timerRef != kInvalidID );
+}
+
+wxTimer::~wxTimer()
+{
+    Stop();
+    if (m_info != NULL)
+    {
+        delete m_info;
+        m_info = NULL;
+    }
+}
+
+bool wxTimer::Start( int milliseconds, bool mode )
+{
+    (void)wxTimerBase::Start(milliseconds, mode);
+
+    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeout") );
+    wxCHECK_MSG( m_info->m_timerRef == NULL, false, wxT("attempting to restart a timer") );
+
+    m_info->m_timer = this;
+    m_info->m_proc = NewEventLoopTimerUPP( &wxProcessTimer );
+
+    OSStatus err = InstallEventLoopTimer(
+        GetMainEventLoop(),
+        m_milli*kEventDurationMillisecond,
+        IsOneShot() ? 0 : m_milli * kEventDurationMillisecond,
+        m_info->m_proc,
+        this,
+        &m_info->m_timerRef );
+    verify_noerr( err );
+
+    return true;
+}
+
+void wxTimer::Stop()
+{
+    if (m_info->m_timerRef)
+        RemoveEventLoopTimer( m_info->m_timerRef );
+    if (m_info->m_proc)
+        DisposeEventLoopTimerUPP( m_info->m_proc );
+
+    m_info->m_proc = NULL;
+    m_info->m_timerRef = kInvalidID;
+}
+
+#else
+
 typedef struct MacTimerInfo
 {
     TMTask m_task;
-    wxMacNotifierTableRef m_table ;
-    wxTimer* m_timer ;
-} ;
+    wxMacNotifierTableRef m_table;
+    wxTimer* m_timer;
+};
 
-static void wxProcessTimer( unsigned long event , void *data ) ;
+static void wxProcessTimer( unsigned long event, void *data );
 
 static pascal void MacTimerProc( TMTask * t )
 {
-       MacTimerInfo * tm = (MacTimerInfo*)  t ;
-       wxMacAddEvent( tm->m_table , wxProcessTimer, 0 , (void*) tm->m_timer , TRUE ) ;
+    MacTimerInfo * tm = (MacTimerInfo*) t;
+    wxMacAddEvent( tm->m_table, wxProcessTimer, 0, (void*) tm->m_timer, true );
 }
 
-static void wxProcessTimer( unsigned long event , void *data )
+// we need this array to track timers that are being deleted within the Notify procedure
+// adding the timer before the Notify call and checking after whether it still is in there
+// as the destructor would have removed it from the array
+
+wxArrayPtrVoid gTimersInProcess;
+
+static void wxProcessTimer( unsigned long event, void *data )
 {
-       if ( !data )
-               return ;
-               
-       wxTimer* timer = (wxTimer*) data ;
-       if ( timer->IsOneShot() )
-               timer->Stop() ;
-               
+    if ( data == NULL )
+        return;
+
+    wxTimer* timer = (wxTimer*) data;
+    if ( timer->IsOneShot() )
+        timer->Stop();
+
+    gTimersInProcess.Add( timer );
     timer->Notify();
 
-    if ( timer->m_info->m_task.tmAddr && !timer->IsOneShot() )
+    int index = gTimersInProcess.Index( timer );
+    if ( index != wxNOT_FOUND )
     {
-           PrimeTime( (QElemPtr)  &timer->m_info->m_task , timer->GetInterval() ) ;
+        gTimersInProcess.RemoveAt( index );
+
+        if ( !timer->IsOneShot() && timer->m_info->m_task.tmAddr )
+            PrimeTime( (QElemPtr) &timer->m_info->m_task, timer->GetInterval() );
     }
 }
 
 void wxTimer::Init()
 {
-    m_info = new MacTimerInfo() ;
-       m_info->m_task.tmAddr = NULL ;
-       m_info->m_task.tmWakeUp = 0 ;
-       m_info->m_task.tmReserved = 0 ;
-       m_info->m_task.qType = 0 ;
-       m_info->m_table = wxMacGetNotifierTable() ;
-       m_info->m_timer = this ;
+    m_info = new MacTimerInfo();
+    m_info->m_task.tmAddr = NULL;
+    m_info->m_task.tmWakeUp = 0;
+    m_info->m_task.tmReserved = 0;
+    m_info->m_task.qType = 0;
+    m_info->m_table = wxMacGetNotifierTable();
+    m_info->m_timer = this;
 }
 
-bool wxTimer::IsRunning() const 
+bool wxTimer::IsRunning() const
 {
-       return ( m_info->m_task.qType & kTMTaskActive ) ;
+    // as the qType may already indicate it is elapsed, but it
+    // was not handled internally yet
+    return ( m_info->m_task.tmAddr != NULL );
 }
 
 wxTimer::~wxTimer()
 {
     Stop();
-    delete m_info ;
-    m_info = NULL ;
+    if (m_info != NULL)
+    {
+        delete m_info;
+        m_info = NULL;
+    }
+
+    int index = gTimersInProcess.Index( this );
+    if ( index != wxNOT_FOUND )
+        gTimersInProcess.RemoveAt( index );
 }
 
-bool wxTimer::Start(int milliseconds,bool mode)
+bool wxTimer::Start( int milliseconds, bool mode )
 {
-    (void)wxTimerBase::Start(milliseconds, mode);
+    (void)wxTimerBase::Start( milliseconds, mode );
 
-    wxCHECK_MSG( m_milli > 0, FALSE, wxT("invalid value for timer timeour") );
-    wxCHECK_MSG( m_info->m_task.tmAddr == NULL , FALSE, wxT("attempting to restart a timer") );
+    wxCHECK_MSG( m_milli > 0, false, wxT("invalid value for timer timeout") );
+    wxCHECK_MSG( m_info->m_task.tmAddr == NULL, false, wxT("attempting to restart a timer") );
 
-    m_milli = milliseconds;
-#if defined(UNIVERSAL_INTERFACES_VERSION) && (UNIVERSAL_INTERFACES_VERSION >= 0x0340)
-    m_info->m_task.tmAddr = NewTimerUPP( MacTimerProc ) ;
-#else
-    m_info->m_task.tmAddr = NewTimerProc( MacTimerProc ) ;
-#endif
-    m_info->m_task.tmWakeUp = 0 ;
-    m_info->m_task.tmReserved = 0 ;
-       m_info->m_task.qType = 0 ;
-       m_info->m_timer = this ;
-    InsXTime((QElemPtr) &m_info->m_task ) ;
-    PrimeTime( (QElemPtr) &m_info->m_task , m_milli ) ;
-    return FALSE;
+    m_info->m_task.tmAddr = NewTimerUPP( MacTimerProc );
+    m_info->m_task.tmWakeUp = 0;
+    m_info->m_task.tmReserved = 0;
+    m_info->m_task.qType = 0;
+    m_info->m_timer = this;
+    InsXTime( (QElemPtr) &m_info->m_task );
+    PrimeTime( (QElemPtr) &m_info->m_task, m_milli );
+
+    return true;
 }
 
 void wxTimer::Stop()
 {
-    m_milli = 0 ;
     if ( m_info->m_task.tmAddr )
     {
-       RmvTime(  (QElemPtr) &m_info->m_task ) ;
-       DisposeTimerUPP(m_info->m_task.tmAddr) ;
-       m_info->m_task.tmAddr = NULL ;
+        RmvTime( (QElemPtr) &m_info->m_task );
+        DisposeTimerUPP( m_info->m_task.tmAddr );
+        m_info->m_task.tmAddr = NULL;
     }
-    wxMacRemoveAllNotifiersForData( wxMacGetNotifierTable() , this ) ;
+
+    wxMacRemoveAllNotifiersForData( wxMacGetNotifierTable(), this );
 }
 
+#endif // wxMAC_USE_CARBON_TIMER
 
+#endif // wxUSE_TIMER