src/msw/timer.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/timer.cpp
   3 // Purpose:     wxTimer implementation
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin (use hash map instead of list, global rewrite)
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_TIMER
  20
  21 #include "wx/msw/private/timer.h"
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/list.h"
  25     #include "wx/event.h"
  26     #include "wx/app.h"
  27     #include "wx/intl.h"
  28     #include "wx/log.h"
  29     #include "wx/hashmap.h"
  30     #include "wx/module.h"
  31 #endif
  32
  33 #include "wx/msw/private.h"
  34
  35 // ----------------------------------------------------------------------------
  36 // private globals
  37 // ----------------------------------------------------------------------------
  38
  39 // define a hash containing all the timers: it is indexed by timer id and
  40 // contains the corresponding timer
  41 WX_DECLARE_HASH_MAP(WPARAM, wxMSWTimerImpl *, wxIntegerHash, wxIntegerEqual,
  42                     wxTimerMap);
  43
  44 // instead of using a global here, wrap it in a static function as otherwise it
  45 // could have been used before being initialized if a timer object were created
  46 // globally
  47 static wxTimerMap& TimerMap()
  48 {
  49     static wxTimerMap s_timerMap;
  50
  51     return s_timerMap;
  52 }
  53
  54 // This gets a unique, non-zero timer ID and creates an entry in the TimerMap
  55 UINT_PTR GetNewTimerId(wxMSWTimerImpl *t)
  56 {
  57     static UINT_PTR lastTimerId = 0;
  58
  59     while (lastTimerId == 0 ||
  60             TimerMap().find(lastTimerId) != TimerMap().end())
  61     {
  62         lastTimerId = lastTimerId + 1;
  63     }
  64
  65     TimerMap()[lastTimerId] = t;
  66
  67     return lastTimerId;
  68 }
  69
  70
  71
  72 // ----------------------------------------------------------------------------
  73 // private functions
  74 // ----------------------------------------------------------------------------
  75
  76 LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
  77                                         WPARAM wParam, LPARAM lParam);
  78
  79 // implemented in utils.cpp
  80 extern "C" WXDLLIMPEXP_BASE HWND
  81 wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
  82
  83
  84 // ----------------------------------------------------------------------------
  85 // wxTimerHiddenWindowModule: used to manage the hidden window used for
  86 // catching timer messages (we need a module to ensure that the window is
  87 // always deleted)
  88 // ----------------------------------------------------------------------------
  89
  90 class wxTimerHiddenWindowModule : public wxModule
  91 {
  92 public:
  93     // module init/finalize
  94     virtual bool OnInit();
  95     virtual void OnExit();
  96
  97     // get the hidden window (creates on demand)
  98     static HWND GetHWND();
  99
 100 private:
 101     // the HWND of the hidden window
 102     static HWND ms_hwnd;
 103
 104     // the class used to create it
 105     static const wxChar *ms_className;
 106
 107     DECLARE_DYNAMIC_CLASS(wxTimerHiddenWindowModule)
 108 };
 109
 110 IMPLEMENT_DYNAMIC_CLASS(wxTimerHiddenWindowModule, wxModule)
 111
 112 // ============================================================================
 113 // implementation
 114 // ============================================================================
 115
 116
 117 // ----------------------------------------------------------------------------
 118 // wxMSWTimerImpl class
 119 // ----------------------------------------------------------------------------
 120
 121 bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
 122 {
 123     if ( !wxTimerImpl::Start(milliseconds, oneShot) )
 124         return false;
 125
 126     m_id = GetNewTimerId(this);
 127     // SetTimer() normally returns just idTimer but this might change in the
 128     // future so use its return value to be safe
 129     UINT_PTR ret = ::SetTimer
 130              (
 131               wxTimerHiddenWindowModule::GetHWND(),  // window for WM_TIMER
 132               m_id,                                  // timer ID to create
 133               (UINT)m_milli,                         // delay
 134               NULL                                   // timer proc (unused)
 135              );
 136
 137     if ( ret == 0 )
 138     {
 139         wxLogSysError(_("Couldn't create a timer"));
 140
 141         return false;
 142     }
 143
 144     return true;
 145 }
 146
 147 void wxMSWTimerImpl::Stop()
 148 {
 149     ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
 150     TimerMap().erase(m_id);
 151     m_id = 0;
 152 }
 153
 154 // ----------------------------------------------------------------------------
 155 // private functions
 156 // ----------------------------------------------------------------------------
 157
 158 void wxProcessTimer(wxMSWTimerImpl& timer)
 159 {
 160     wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") );
 161
 162     if ( timer.IsOneShot() )
 163         timer.Stop();
 164
 165     timer.Notify();
 166 }
 167
 168
 169 LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
 170                                         WPARAM wParam, LPARAM lParam)
 171 {
 172     if ( message == WM_TIMER )
 173     {
 174         wxTimerMap::iterator node = TimerMap().find(wParam);
 175
 176         if ( node != TimerMap().end() )
 177         {
 178             wxProcessTimer(*(node->second));
 179
 180             return 0;
 181         }
 182         //else: Unknown timer, probably one of our timers that had fired just
 183         //      before being removed from the timers map by Stop().
 184     }
 185
 186     return ::DefWindowProc(hWnd, message, wParam, lParam);
 187 }
 188
 189 // ----------------------------------------------------------------------------
 190 // wxTimerHiddenWindowModule functions
 191 // ----------------------------------------------------------------------------
 192
 193
 194 HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;
 195
 196 const wxChar *wxTimerHiddenWindowModule::ms_className = NULL;
 197
 198 bool wxTimerHiddenWindowModule::OnInit()
 199 {
 200     // do not initialize ms_hwnd to ms_className to NULL here: it may happen
 201     // that our GetHWND() is called before the modules are initialized if a
 202     // timer is created from wxApp-derived class ctor and in this case we
 203     // shouldn't overwrite it
 204
 205     return true;
 206 }
 207
 208 void wxTimerHiddenWindowModule::OnExit()
 209 {
 210     if ( ms_hwnd )
 211     {
 212         if ( !::DestroyWindow(ms_hwnd) )
 213         {
 214             wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)"));
 215         }
 216
 217         ms_hwnd = NULL;
 218     }
 219
 220     if ( ms_className )
 221     {
 222         if ( !::UnregisterClass(ms_className, wxGetInstance()) )
 223         {
 224             wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")"));
 225         }
 226
 227         ms_className = NULL;
 228     }
 229 }
 230
 231 /* static */
 232 HWND wxTimerHiddenWindowModule::GetHWND()
 233 {
 234     static const wxChar *HIDDEN_WINDOW_CLASS = wxT("wxTimerHiddenWindow");
 235     if ( !ms_hwnd )
 236     {
 237         ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS,
 238                                      wxTimerWndProc);
 239     }
 240
 241     return ms_hwnd;
 242 }
 243
 244 #endif // wxUSE_TIMER