]> git.saurik.com Git - wxWidgets.git/blame - src/msw/timer.cpp
Handle the case of NSNotFound result properly.
[wxWidgets.git] / src / msw / timer.cpp
CommitLineData
2bda0e17 1/////////////////////////////////////////////////////////////////////////////
8ecff181 2// Name: src/msw/timer.cpp
2bda0e17
KB
3// Purpose: wxTimer implementation
4// Author: Julian Smart
6d20f7ae 5// Modified by: Vadim Zeitlin (use hash map instead of list, global rewrite)
2bda0e17
KB
6// Created: 04/01/98
7// RCS-ID: $Id$
6c9a19aa 8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
2bda0e17
KB
12// For compilers that support precompilation, includes "wx.h".
13#include "wx/wxprec.h"
14
15#ifdef __BORLANDC__
c085e333 16 #pragma hdrstop
2bda0e17
KB
17#endif
18
1e6feb95
VZ
19#if wxUSE_TIMER
20
c2ca375c 21#include "wx/msw/private/timer.h"
c0badb70 22
2bda0e17 23#ifndef WX_PRECOMP
c085e333 24 #include "wx/list.h"
2432b92d 25 #include "wx/event.h"
c085e333 26 #include "wx/app.h"
0470b1e6
VZ
27 #include "wx/intl.h"
28 #include "wx/log.h"
df69528b 29 #include "wx/hashmap.h"
0e16e5c3 30 #include "wx/module.h"
2bda0e17
KB
31#endif
32
0470b1e6 33#include "wx/msw/private.h"
2bda0e17 34
c085e333 35// ----------------------------------------------------------------------------
97f278b4 36// private globals
c085e333
VZ
37// ----------------------------------------------------------------------------
38
97f278b4
VZ
39// define a hash containing all the timers: it is indexed by timer id and
40// contains the corresponding timer
491acfc7 41WX_DECLARE_HASH_MAP(WPARAM, wxMSWTimerImpl *, wxIntegerHash, wxIntegerEqual,
3f5c62f9 42 wxTimerMap);
5b6c8794 43
ee1025a7
VZ
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
47static wxTimerMap& TimerMap()
48{
49 static wxTimerMap s_timerMap;
50
51 return s_timerMap;
52}
4676948b 53
c085e333 54// ----------------------------------------------------------------------------
97f278b4 55// private functions
eccd1992 56// ----------------------------------------------------------------------------
0e16e5c3 57
9cfc7f4f
RD
58LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
59 WPARAM wParam, LPARAM lParam);
eccd1992 60
9cfc7f4f
RD
61// implemented in utils.cpp
62extern "C" WXDLLIMPEXP_BASE HWND
63wxCreateHiddenWindow(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
72class wxTimerHiddenWindowModule : public wxModule
73{
74public:
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
82private:
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
92IMPLEMENT_DYNAMIC_CLASS(wxTimerHiddenWindowModule, wxModule)
eccd1992 93
c085e333
VZ
94// ============================================================================
95// implementation
96// ============================================================================
97
9cfc7f4f 98
c085e333 99// ----------------------------------------------------------------------------
c2ca375c 100// wxMSWTimerImpl class
c085e333 101// ----------------------------------------------------------------------------
73974df1 102
c2ca375c 103bool wxMSWTimerImpl::Start(int milliseconds, bool oneShot)
2bda0e17 104{
c2ca375c
VZ
105 if ( !wxTimerImpl::Start(milliseconds, oneShot) )
106 return false;
caa36aab 107
fe0c3289
VZ
108 // SetTimer() doesn't accept 0 timer id so use something else if the timer
109 // id at wx level is 0: as -1 (wxID_ANY) can't be used, we can safely
110 // replace 0 with it at MSW level
111 UINT idTimer = GetId();
112 if ( !idTimer )
113 idTimer = (UINT)-1;
114
115 // SetTimer() normally returns just idTimer but this might change in the
116 // future so use its return value to be safe
117 m_id = ::SetTimer
118 (
119 wxTimerHiddenWindowModule::GetHWND(), // window for WM_TIMER
120 idTimer, // timer ID to create
121 (UINT)m_milli, // delay
122 NULL // timer proc (unused)
123 );
eccd1992
VZ
124
125 if ( !m_id )
c085e333
VZ
126 {
127 wxLogSysError(_("Couldn't create a timer"));
128
04cd30de 129 return false;
c085e333 130 }
eccd1992 131
97f278b4
VZ
132 // check that SetTimer() didn't reuse an existing id: according to the MSDN
133 // this can happen and this would be catastrophic to us as we rely on ids
134 // uniquely identifying the timers because we use them as keys in the hash
7ca19ddb
VZ
135 //
136 // notice that this also happens if the same id is reused for multiple
137 // timers: this used to work in previous versions but was never supported
138 // and absolutely shouldn't be done, use wxID_ANY to assign an id to the
139 // timer automatically or ensure that all your timers have unique ids
ee1025a7 140 if ( TimerMap().find(m_id) != TimerMap().end() )
97f278b4
VZ
141 {
142 wxLogError(_("Timer creation failed."));
143
9cfc7f4f 144 ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
97f278b4
VZ
145 m_id = 0;
146
147 return false;
148 }
149
ee1025a7 150 TimerMap()[m_id] = this;
eccd1992
VZ
151
152 return true;
2bda0e17
KB
153}
154
c2ca375c 155void wxMSWTimerImpl::Stop()
2bda0e17 156{
9a83f860 157 wxASSERT_MSG( m_id, wxT("should be running") );
62f17a18 158
9cfc7f4f 159 ::KillTimer(wxTimerHiddenWindowModule::GetHWND(), m_id);
c2ca375c
VZ
160
161 TimerMap().erase(m_id);
0470b1e6
VZ
162
163 m_id = 0;
2bda0e17
KB
164}
165
c085e333
VZ
166// ----------------------------------------------------------------------------
167// private functions
168// ----------------------------------------------------------------------------
73974df1 169
c2ca375c 170void wxProcessTimer(wxMSWTimerImpl& timer)
2bda0e17 171{
9a83f860 172 wxASSERT_MSG( timer.IsRunning(), wxT("bogus timer id") );
c085e333 173
0470b1e6 174 if ( timer.IsOneShot() )
c085e333
VZ
175 timer.Stop();
176
177 timer.Notify();
2bda0e17
KB
178}
179
9cfc7f4f
RD
180
181LRESULT APIENTRY _EXPORT wxTimerWndProc(HWND hWnd, UINT message,
182 WPARAM wParam, LPARAM lParam)
183{
184 if ( message == WM_TIMER )
185 {
491acfc7 186 wxTimerMap::iterator node = TimerMap().find(wParam);
9cfc7f4f
RD
187
188 wxCHECK_MSG( node != TimerMap().end(), 0, wxT("bogus timer id in wxTimerProc") );
189
190 wxProcessTimer(*(node->second));
191 }
192 else
193 {
194 return ::DefWindowProc(hWnd, message, wParam, lParam);
195 }
196 return 0;
197}
198
199// ----------------------------------------------------------------------------
200// wxTimerHiddenWindowModule functions
201// ----------------------------------------------------------------------------
202
203
204HWND wxTimerHiddenWindowModule::ms_hwnd = NULL;
205
206const wxChar *wxTimerHiddenWindowModule::ms_className = NULL;
207
208bool wxTimerHiddenWindowModule::OnInit()
209{
24a21a5f
VZ
210 // do not initialize ms_hwnd to ms_className to NULL here: it may happen
211 // that our GetHWND() is called before the modules are initialized if a
212 // timer is created from wxApp-derived class ctor and in this case we
213 // shouldn't overwrite it
9cfc7f4f
RD
214
215 return true;
216}
217
218void wxTimerHiddenWindowModule::OnExit()
c085e333 219{
9cfc7f4f
RD
220 if ( ms_hwnd )
221 {
222 if ( !::DestroyWindow(ms_hwnd) )
223 {
9a83f860 224 wxLogLastError(wxT("DestroyWindow(wxTimerHiddenWindow)"));
9cfc7f4f
RD
225 }
226
227 ms_hwnd = NULL;
228 }
c085e333 229
9cfc7f4f
RD
230 if ( ms_className )
231 {
232 if ( !::UnregisterClass(ms_className, wxGetInstance()) )
233 {
9a83f860 234 wxLogLastError(wxT("UnregisterClass(\"wxTimerHiddenWindow\")"));
9cfc7f4f
RD
235 }
236
237 ms_className = NULL;
238 }
239}
240
241/* static */
242HWND wxTimerHiddenWindowModule::GetHWND()
243{
9a83f860 244 static const wxChar *HIDDEN_WINDOW_CLASS = wxT("wxTimerHiddenWindow");
9cfc7f4f
RD
245 if ( !ms_hwnd )
246 {
247 ms_hwnd = wxCreateHiddenWindow(&ms_className, HIDDEN_WINDOW_CLASS,
248 wxTimerWndProc);
249 }
c085e333 250
9cfc7f4f 251 return ms_hwnd;
c085e333 252}
1e6feb95
VZ
253
254#endif // wxUSE_TIMER