src/third_party/WebKit/Source/modules/gamepad/NavigatorGamepad.cpp

   1 /*
   2  * Copyright (C) 2011, Google 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 are met:
   6  *
   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'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  19  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  20  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  23  * DAMAGE.
  24  */
  25
  26 #include "config.h"
  27 #include "modules/gamepad/NavigatorGamepad.h"
  28
  29 #include "RuntimeEnabledFeatures.h"
  30 #include "core/dom/Document.h"
  31 #include "core/frame/DOMWindow.h"
  32 #include "core/frame/LocalFrame.h"
  33 #include "core/frame/Navigator.h"
  34 #include "core/page/Page.h"
  35 #include "modules/gamepad/GamepadDispatcher.h"
  36 #include "modules/gamepad/GamepadEvent.h"
  37 #include "modules/gamepad/GamepadList.h"
  38 #include "modules/gamepad/WebKitGamepadList.h"
  39
  40 namespace WebCore {
  41
  42 template<typename T>
  43 static void sampleGamepad(unsigned index, T& gamepad, const blink::WebGamepad& webGamepad)
  44 {
  45     gamepad.setId(webGamepad.id);
  46     gamepad.setIndex(index);
  47     gamepad.setConnected(webGamepad.connected);
  48     gamepad.setTimestamp(webGamepad.timestamp);
  49     gamepad.setMapping(webGamepad.mapping);
  50     gamepad.setAxes(webGamepad.axesLength, webGamepad.axes);
  51     gamepad.setButtons(webGamepad.buttonsLength, webGamepad.buttons);
  52 }
  53
  54 template<typename GamepadType, typename ListType>
  55 static void sampleGamepads(ListType* into)
  56 {
  57     blink::WebGamepads gamepads;
  58
  59     GamepadDispatcher::instance().sampleGamepads(gamepads);
  60
  61     for (unsigned i = 0; i < blink::WebGamepads::itemsLengthCap; ++i) {
  62         blink::WebGamepad& webGamepad = gamepads.items[i];
  63         if (i < gamepads.length && webGamepad.connected) {
  64             RefPtrWillBeRawPtr<GamepadType> gamepad = into->item(i);
  65             if (!gamepad)
  66                 gamepad = GamepadType::create();
  67             sampleGamepad(i, *gamepad, webGamepad);
  68             into->set(i, gamepad);
  69         } else {
  70             into->set(i, nullptr);
  71         }
  72     }
  73 }
  74
  75 NavigatorGamepad* NavigatorGamepad::from(Document& document)
  76 {
  77     if (!document.frame() || !document.frame()->domWindow())
  78         return 0;
  79     Navigator& navigator = document.frame()->domWindow()->navigator();
  80     return &from(navigator);
  81 }
  82
  83 NavigatorGamepad& NavigatorGamepad::from(Navigator& navigator)
  84 {
  85     NavigatorGamepad* supplement = static_cast<NavigatorGamepad*>(WillBeHeapSupplement<Navigator>::from(navigator, supplementName()));
  86     if (!supplement) {
  87         supplement = new NavigatorGamepad(*navigator.frame()->document());
  88         provideTo(navigator, supplementName(), adoptPtrWillBeNoop(supplement));
  89     }
  90     return *supplement;
  91 }
  92
  93 WebKitGamepadList* NavigatorGamepad::webkitGetGamepads(Navigator& navigator)
  94 {
  95     return NavigatorGamepad::from(navigator).webkitGamepads();
  96 }
  97
  98 GamepadList* NavigatorGamepad::getGamepads(Navigator& navigator)
  99 {
 100     return NavigatorGamepad::from(navigator).gamepads();
 101 }
 102
 103 WebKitGamepadList* NavigatorGamepad::webkitGamepads()
 104 {
 105     startUpdating();
 106     if (!m_webkitGamepads)
 107         m_webkitGamepads = WebKitGamepadList::create();
 108     sampleGamepads<WebKitGamepad>(m_webkitGamepads.get());
 109     return m_webkitGamepads.get();
 110 }
 111
 112 GamepadList* NavigatorGamepad::gamepads()
 113 {
 114     startUpdating();
 115     if (!m_gamepads)
 116         m_gamepads = GamepadList::create();
 117     sampleGamepads<Gamepad>(m_gamepads.get());
 118     return m_gamepads.get();
 119 }
 120
 121 void NavigatorGamepad::trace(Visitor* visitor)
 122 {
 123     visitor->trace(m_gamepads);
 124     visitor->trace(m_webkitGamepads);
 125 }
 126
 127 void NavigatorGamepad::didConnectOrDisconnectGamepad(unsigned index, const blink::WebGamepad& webGamepad, bool connected)
 128 {
 129     ASSERT(index < blink::WebGamepads::itemsLengthCap);
 130     ASSERT(connected == webGamepad.connected);
 131
 132     // We should stop listening once we detached.
 133     ASSERT(window());
 134
 135     // We register to the dispatcher before sampling gamepads so we need to check if we actually have an event listener.
 136     if (!m_hasEventListener)
 137         return;
 138
 139     if (window()->document()->activeDOMObjectsAreStopped() || window()->document()->activeDOMObjectsAreSuspended())
 140         return;
 141
 142     if (!m_gamepads)
 143         m_gamepads = GamepadList::create();
 144
 145     RefPtrWillBeRawPtr<Gamepad> gamepad = m_gamepads->item(index);
 146     if (!gamepad)
 147         gamepad = Gamepad::create();
 148     sampleGamepad(index, *gamepad, webGamepad);
 149     m_gamepads->set(index, gamepad);
 150
 151     const AtomicString& eventName = connected ? EventTypeNames::gamepadconnected : EventTypeNames::gamepaddisconnected;
 152     RefPtr<GamepadEvent> event = GamepadEvent::create(eventName, false, true, gamepad.get());
 153     window()->dispatchEvent(event);
 154 }
 155
 156 NavigatorGamepad::NavigatorGamepad(Document& document)
 157     : DOMWindowProperty(document.frame())
 158     , DeviceSensorEventController(document)
 159     , DOMWindowLifecycleObserver(document.frame()->domWindow())
 160 {
 161 }
 162
 163 NavigatorGamepad::~NavigatorGamepad()
 164 {
 165 }
 166
 167 const char* NavigatorGamepad::supplementName()
 168 {
 169     return "NavigatorGamepad";
 170 }
 171
 172 void NavigatorGamepad::willDestroyGlobalObjectInFrame()
 173 {
 174     stopUpdating();
 175     DOMWindowProperty::willDestroyGlobalObjectInFrame();
 176 }
 177
 178 void NavigatorGamepad::willDetachGlobalObjectFromFrame()
 179 {
 180     stopUpdating();
 181     DOMWindowProperty::willDetachGlobalObjectFromFrame();
 182 }
 183
 184 void NavigatorGamepad::registerWithDispatcher()
 185 {
 186     GamepadDispatcher::instance().addClient(this);
 187 }
 188
 189 void NavigatorGamepad::unregisterWithDispatcher()
 190 {
 191     GamepadDispatcher::instance().removeClient(this);
 192 }
 193
 194 bool NavigatorGamepad::hasLastData()
 195 {
 196     // Gamepad data is polled instead of pushed.
 197     return false;
 198 }
 199
 200 PassRefPtr<Event> NavigatorGamepad::getLastEvent()
 201 {
 202     // This is called only when hasLastData() is true.
 203     ASSERT_NOT_REACHED();
 204     return nullptr;
 205 }
 206
 207 bool NavigatorGamepad::isNullEvent(Event*)
 208 {
 209     // This is called only when hasLastData() is true.
 210     ASSERT_NOT_REACHED();
 211     return false;
 212 }
 213
 214 void NavigatorGamepad::didAddEventListener(DOMWindow*, const AtomicString& eventType)
 215 {
 216     if (RuntimeEnabledFeatures::gamepadEnabled() && (eventType == EventTypeNames::gamepadconnected || eventType == EventTypeNames::gamepaddisconnected)) {
 217         if (page() && page()->visibilityState() == PageVisibilityStateVisible)
 218             startUpdating();
 219         m_hasEventListener = true;
 220     }
 221 }
 222
 223 void NavigatorGamepad::didRemoveEventListener(DOMWindow*, const AtomicString& eventType)
 224 {
 225     if (eventType == EventTypeNames::gamepadconnected || eventType == EventTypeNames::gamepaddisconnected)
 226         m_hasEventListener = false;
 227 }
 228
 229 void NavigatorGamepad::didRemoveAllEventListeners(DOMWindow*)
 230 {
 231     m_hasEventListener = false;
 232 }
 233
 234 } // namespace WebCore