1/*
2 *  Copyright (C) 2012 Samsung Electronics
3 *
4 *  This library is free software; you can redistribute it and/or
5 *  modify it under the terms of the GNU Library General Public
6 *  License as published by the Free Software Foundation; either
7 *  version 2 of the License, or (at your option) any later version.
8 *
9 *  This library is distributed in the hope that it will be useful,
10 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 *  Library General Public License for more details.
13 *
14 *  You should have received a copy of the GNU Library General Public License
15 *  along with this library; see the file COPYING.LIB.  If not, write to
16 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 *  Boston, MA 02110-1301, USA.
18 */
19
20#ifndef Vibration_h
21#define Vibration_h
22
23#if ENABLE(VIBRATION)
24
25#include "Page.h"
26#include "Timer.h"
27
28namespace WebCore {
29
30class VibrationClient;
31
32class Vibration : public Supplement<Page> {
33public:
34    typedef Vector<unsigned> VibrationPattern;
35
36    explicit Vibration(VibrationClient*);
37    ~Vibration();
38
39    bool vibrate(const VibrationPattern&);
40    // FIXME: When a visibilitychange event is dispatched while vibrating, the vibration should be canceled.
41    void cancelVibration();
42
43    void timerFired(Timer<Vibration>*);
44
45    static const char* supplementName();
46    static Vibration* from(Page* page) { return static_cast<Vibration*>(Supplement<Page>::from(page, supplementName())); }
47
48    bool isVibrating() { return m_state != State::Idle; }
49
50private:
51    enum class State { Idle, Vibrating, Waiting };
52
53    VibrationClient* m_vibrationClient;
54    Timer<Vibration> m_timer;
55    State m_state;
56    VibrationPattern m_pattern;
57};
58
59} // namespace WebCore
60
61#endif // ENABLE(VIBRATION)
62
63#endif // Vibration_h
64
65