Remove the Timer parameters from timer callbacks
[WebKit-https.git] / Source / WebCore / platform / HysteresisActivity.h
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef HysteresisActivity_h
27 #define HysteresisActivity_h
28
29 #include "Timer.h"
30
31 namespace WebCore {
32
33 static const double DefaultHysteresisSeconds = 5.0;
34
35 enum class HysteresisState {
36     Started,
37     WillStopPendingTimeout,
38     Stopped
39 };
40
41 template<typename Delegate>
42 class HysteresisActivity {
43 public:
44     explicit HysteresisActivity(Delegate& delegate, double hysteresisSeconds = DefaultHysteresisSeconds)
45         : m_delegate(delegate)
46         , m_hysteresisSeconds(hysteresisSeconds)
47         , m_active(false)
48         , m_timer(*this, &HysteresisActivity<Delegate>::hysteresisTimerFired)
49     {
50     }
51
52     void start()
53     {
54         if (m_active)
55             return;
56         m_active = true;
57
58         if (m_timer.isActive())
59             m_timer.stop();
60         else
61             m_delegate.started();
62     }
63
64     void stop()
65     {
66         if (!m_active)
67             return;
68         m_active = false;
69
70         m_timer.startOneShot(m_hysteresisSeconds);
71     }
72
73     void impulse()
74     {
75         if (!m_active) {
76             start();
77             stop();
78         }
79     }
80
81     HysteresisState state() const
82     {
83         if (m_active)
84             return HysteresisState::Started;
85         if (m_timer.isActive())
86             return HysteresisState::WillStopPendingTimeout;
87         return HysteresisState::Stopped;
88     }
89     
90 private:
91     void hysteresisTimerFired()
92     {
93         m_delegate.stopped();
94         m_timer.stop();
95     }
96
97     Delegate& m_delegate;
98     double m_hysteresisSeconds;
99     bool m_active;
100     Timer m_timer;
101 };
102
103 } // namespace WebCore
104
105 #endif // HysteresisActivity_h