src/os2/timer.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/os2/timer.cpp
   3 // Purpose:     wxTimer implementation
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/17/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #include "wx/timer.h"
  16
  17 #ifndef WX_PRECOMP
  18     #include "wx/list.h"
  19     #include "wx/window.h"
  20     #include "wx/event.h"
  21     #include "wx/app.h"
  22     #include "wx/intl.h"
  23     #include "wx/log.h"
  24 #endif
  25
  26 #include "wx/os2/private.h"
  27
  28 #include <time.h>
  29 #include <sys/types.h>
  30
  31 #include <sys/timeb.h>
  32
  33 // ----------------------------------------------------------------------------
  34 // private globals
  35 // ----------------------------------------------------------------------------
  36
  37 // define a hash containing all the timers: it is indexed by timer id and
  38 // contains the corresponding timer
  39 WX_DECLARE_HASH_MAP(unsigned long, wxTimer *, wxIntegerHash, wxIntegerEqual,
  40                     wxTimerMap);
  41
  42 // instead of using a global here, wrap it in a static function as otherwise it
  43 // could have been used before being initialized if a timer object were created
  44 // globally
  45 static wxTimerMap& TimerMap()
  46 {
  47     static wxTimerMap s_timerMap;
  48
  49     return s_timerMap;
  50 }
  51
  52 // ----------------------------------------------------------------------------
  53 // private functions
  54 // ----------------------------------------------------------------------------
  55
  56 // timer callback used for all timers
  57 ULONG wxTimerProc(HWND hwnd, ULONG, int nIdTimer, ULONG);
  58
  59 // ----------------------------------------------------------------------------
  60 // macros
  61 // ----------------------------------------------------------------------------
  62
  63 IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxEvtHandler)
  64
  65 // ============================================================================
  66 // implementation
  67 // ============================================================================
  68
  69 // ----------------------------------------------------------------------------
  70 // wxTimer class
  71 // ----------------------------------------------------------------------------
  72
  73 void wxTimer::Init()
  74 {
  75     m_ulId = 0;
  76 }
  77
  78 wxTimer::~wxTimer()
  79 {
  80     wxTimer::Stop();
  81 }
  82
  83 void wxTimer::Notify()
  84 {
  85     //
  86     // The base class version generates an event if it has owner - which it
  87     // should because otherwise nobody can process timer events, but it does
  88     // not use the OS's ID, which OS/2 must have to figure out which timer fired
  89     //
  90     wxCHECK_RET( m_owner, _T("wxTimer::Notify() should be overridden.") );
  91
  92     wxTimerEvent                    vEvent( m_idTimer
  93                                            ,m_milli
  94                                           );
  95
  96     (void)m_owner->ProcessEvent(vEvent);
  97 } // end of wxTimer::Notify
  98
  99 bool wxTimer::Start( int nMilliseconds, bool bOneShot )
 100 {
 101     (void)wxTimerBase::Start( nMilliseconds, bOneShot );
 102
 103     wxCHECK_MSG( m_milli > 0L, false, wxT("invalid value for timer") );
 104
 105     wxWindow* pWin = NULL;
 106
 107     if (m_owner)
 108     {
 109         pWin = (wxWindow*)m_owner;
 110         m_ulId = ::WinStartTimer( m_Hab
 111                                  ,pWin->GetHWND()
 112                                  ,m_idTimer
 113                                  ,(ULONG)nMilliseconds
 114                                 );
 115     }
 116     else
 117         m_ulId = ::WinStartTimer( m_Hab
 118                                  ,NULLHANDLE
 119                                  ,0
 120                                  ,(ULONG)nMilliseconds
 121                                 );
 122     if (m_ulId > 0L)
 123     {
 124         // check that SetTimer() didn't reuse an existing id: according to
 125         // the MSDN this can happen and this would be catastrophic to us as
 126         // we rely on ids uniquely identifying the timers because we use
 127         // them as keys in the hash
 128         if ( TimerMap().find(m_ulId) != TimerMap().end() )
 129         {
 130             wxLogError(_("Timer creation failed."));
 131
 132             ::WinStopTimer(m_Hab, pWin?(pWin->GetHWND()):NULL, m_ulId);
 133             m_ulId = 0;
 134
 135             return false;
 136         }
 137
 138         TimerMap()[m_ulId] = this;
 139
 140         return true;
 141     }
 142     else
 143     {
 144         wxLogSysError(_("Couldn't create a timer"));
 145
 146         return false;
 147     }
 148 }
 149
 150 void wxTimer::Stop()
 151 {
 152     if ( m_ulId )
 153     {
 154         if (m_owner)
 155         {
 156             wxWindow*                   pWin = (wxWindow*)m_owner;
 157
 158             ::WinStopTimer(m_Hab, pWin->GetHWND(), m_ulId);
 159         }
 160         else
 161             ::WinStopTimer(m_Hab, NULLHANDLE, m_ulId);
 162
 163         TimerMap().erase(m_ulId);
 164     }
 165     m_ulId = 0L;
 166 }
 167
 168 // ----------------------------------------------------------------------------
 169 // private functions
 170 // ----------------------------------------------------------------------------
 171
 172 void wxProcessTimer(
 173   wxTimer&                          rTimer
 174 )
 175 {
 176     //
 177     // Avoid to process spurious timer events
 178     //
 179     if (rTimer.m_ulId == 0L)
 180         return;
 181
 182     if (rTimer.IsOneShot())
 183         rTimer.Stop();
 184
 185     rTimer.Notify();
 186 }
 187
 188 ULONG wxTimerProc(
 189   HWND                              WXUNUSED(hwnd)
 190 , ULONG
 191 , int                               nIdTimer
 192 , ULONG
 193 )
 194 {
 195     wxTimerMap::iterator node = TimerMap().find((ULONG)nIdTimer);
 196
 197     wxCHECK_MSG(node != TimerMap().end(), 0,
 198                 wxT("bogus timer id in wxTimerProc") );
 199     wxProcessTimer(*(node->second));
 200     return 0;
 201 }