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(unsigned long, 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 // ----------------------------------------------------------------------------
  55 // private functions
  56 // ----------------------------------------------------------------------------
  57
  58 LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
  59                                         WPARAM wParam, LPARAM lParam);
  60
  61 // implemented in utils.cpp
  62 extern "C" WXDLLIMPEXP_BASE HWND
  63 wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
  64
  65
  66 // ----------------------------------------------------------------------------
  67 // wxTimerHiddenWindowModule: used to manage the hidden window used for
  68 // catching timer messages (we need a module to ensure that the window is
  69 // always deleted)
  70 // ----------------------------------------------------------------------------
  71
  72 class wxTimerHiddenWindowModule : public wxModule
  73 {
  74 public:
  75     // module init/finalize
  76     virtual bool OnInit();
  77     virtual void OnExit();
  78
  79     // get the hidden window (creates on demand)
  80     static HWND GetHWND();
  81
  82 private:
  83     // the HWND of the hidden window
  84     static HWND ms_hwnd;
  85
  86     // the class used to create it
  87     static const wxChar *ms_className;
  88
  89     DECLARE_DYNAMIC_CLASS(wxTimerHiddenWindowModule)
  90 };
  91
  92 IMPLEMENT_DYNAMIC_CLASS(wxTimerHiddenWindowModule, wxModule)
  93
  94 // ============================================================================
  95 // implementation
  96 // ============================================================================
  97
  98
  99 // ----------------------------------------------------------------------------
 100 // wxMSWTimerImpl class
 101 // ----------------------------------------------------------------------------
 102
 103 bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
 104 {
 105     if ( !wxTimerImpl::Start(milliseconds, oneShot) )
 106         return false;
 107
 108     m_id = ::SetTimer(
 109         wxTimerHiddenWindowModule::GetHWND(),  // window to send the messages to
 110         GetId(),                               // timer ID
 111         (UINT)m_milli,                         // delay
 112         NULL                                   // timer proc.  Not used since we pass hwnd
 113         );
 114
 115     if ( !m_id )
 116     {
 117         wxLogSysError(_("Couldn't create a timer"));
 118
 119         return false;
 120     }
 121
 122     // check that SetTimer() didn't reuse an existing id: according to the MSDN
 123     // this can happen and this would be catastrophic to us as we rely on ids
 124     // uniquely identifying the timers because we use them as keys in the hash
 125     if ( TimerMap().find(m_id) != TimerMap().end() )
 126     {
 127         wxLogError(_("Timer creation failed."));
 128
 129         ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
 130         m_id = 0;
 131
 132         return false;
 133     }
 134
 135     TimerMap()[m_id] = this;
 136
 137     return true;
 138 }
 139
 140 void wxMSWTimerImpl::Stop()
 141 {
 142     wxASSERT_MSG( m_id, _T("should be running") );
 143
 144     ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
 145
 146     TimerMap().erase(m_id);
 147
 148     m_id = 0;
 149 }
 150
 151 // ----------------------------------------------------------------------------
 152 // private functions
 153 // ----------------------------------------------------------------------------
 154
 155 void wxProcessTimer(wxMSWTimerImpl& timer)
 156 {
 157     wxASSERT_MSG( timer.IsRunning(), _T("bogus timer id") );
 158
 159     if ( timer.IsOneShot() )
 160         timer.Stop();
 161
 162     timer.Notify();
 163 }
 164
 165
 166 LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
 167                                         WPARAM wParam, LPARAM lParam)
 168 {
 169     if ( message == WM_TIMER )
 170     {
 171         wxTimerMap::iterator node = TimerMap().find((unsigned long)wParam);
 172
 173         wxCHECK_MSG( node != TimerMap().end(), 0, wxT("bogus timer id in wxTimerProc") );
 174
 175         wxProcessTimer(*(node->second));
 176     }
 177     else
 178     {
 179         return ::DefWindowProc(hWnd, message, wParam, lParam);
 180     }
 181     return 0;
 182 }
 183
 184 // ----------------------------------------------------------------------------
 185 // wxTimerHiddenWindowModule functions
 186 // ----------------------------------------------------------------------------
 187
 188
 189 HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;
 190
 191 const wxChar *wxTimerHiddenWindowModule::ms_className = NULL;
 192
 193 bool wxTimerHiddenWindowModule::OnInit()
 194 {
 195     // do not initialize ms_hwnd to ms_className to NULL here: it may happen
 196     // that our GetHWND() is called before the modules are initialized if a
 197     // timer is created from wxApp-derived class ctor and in this case we
 198     // shouldn't overwrite it
 199
 200     return true;
 201 }
 202
 203 void wxTimerHiddenWindowModule::OnExit()
 204 {
 205     if ( ms_hwnd )
 206     {
 207         if ( !::DestroyWindow(ms_hwnd) )
 208         {
 209             wxLogLastError(_T("DestroyWindow(wxTimerHiddenWindow)"));
 210         }
 211
 212         ms_hwnd = NULL;
 213     }
 214
 215     if ( ms_className )
 216     {
 217         if ( !::UnregisterClass(ms_className, wxGetInstance()) )
 218         {
 219             wxLogLastError(_T("UnregisterClass(\"wxTimerHiddenWindow\")"));
 220         }
 221
 222         ms_className = NULL;
 223     }
 224 }
 225
 226 /* static */
 227 HWND wxTimerHiddenWindowModule::GetHWND()
 228 {
 229     static const wxChar *HIDDEN_WINDOW_CLASS = _T("wxTimerHiddenWindow");
 230     if ( !ms_hwnd )
 231     {
 232         ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS,
 233                                      wxTimerWndProc);
 234     }
 235
 236     return ms_hwnd;
 237 }
 238
 239 #endif // wxUSE_TIMER