File: VibrationController.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (101 lines) | stat: -rw-r--r-- 3,374 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*
 *  Copyright (C) 2012 Samsung Electronics
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 */

#ifndef VibrationController_h
#define VibrationController_h

#include "core/dom/ContextLifecycleObserver.h"
#include "core/page/PageVisibilityObserver.h"
#include "device/vibration/vibration_manager.mojom-blink.h"
#include "modules/ModulesExport.h"
#include "platform/Timer.h"
#include "platform/heap/GarbageCollected.h"
#include "platform/heap/Handle.h"
#include "wtf/Noncopyable.h"
#include "wtf/Vector.h"

namespace blink {

class Document;
class UnsignedLongOrUnsignedLongSequence;

class MODULES_EXPORT VibrationController final
    : public GarbageCollectedFinalized<VibrationController>,
      public ContextLifecycleObserver,
      public PageVisibilityObserver {
  USING_GARBAGE_COLLECTED_MIXIN(VibrationController);
  WTF_MAKE_NONCOPYABLE(VibrationController);

 public:
  using VibrationPattern = Vector<unsigned>;

  explicit VibrationController(Document&);
  virtual ~VibrationController();

  static VibrationPattern sanitizeVibrationPattern(
      const UnsignedLongOrUnsignedLongSequence&);

  bool vibrate(const VibrationPattern&);
  void doVibrate(TimerBase*);
  void didVibrate();

  // Cancels the ongoing vibration if there is one.
  void cancel();
  void didCancel();

  // Whether a pattern is being processed. If this is true, the vibration
  // hardware may currently be active, but during a pause it may be inactive.
  bool isRunning() const { return m_isRunning; }

  VibrationPattern pattern() const { return m_pattern; }

  DECLARE_VIRTUAL_TRACE();

 private:
  // Inherited from ContextLifecycleObserver.
  void contextDestroyed(ExecutionContext*) override;

  // Inherited from PageVisibilityObserver.
  void pageVisibilityChanged() override;

  // The VibrationManager mojo service. This is reset in |contextDestroyed|
  // and must not be called or recreated after it is reset.
  device::blink::VibrationManagerPtr m_service;

  // Timer for calling |doVibrate| after a delay. It is safe to call
  // |startOneshot| when the timer is already running: it may affect the time
  // at which it fires, but |doVibrate| will still be called only once.
  Timer<VibrationController> m_timerDoVibrate;

  // Whether a pattern is being processed. The vibration hardware may
  // currently be active, or during a pause it may be inactive.
  bool m_isRunning;

  // Whether an async mojo call to cancel is pending.
  bool m_isCallingCancel;

  // Whether an async mojo call to vibrate is pending.
  bool m_isCallingVibrate;

  VibrationPattern m_pattern;
};

}  // namespace blink

#endif  // VibrationController_h