Generalize and refactor DeviceSensorEvent* architecture to support multi-event type targets.

Source/modules/device_orientation/DeviceOrientationController.cpp

 /*
- * Copyright 2010 Apple Inc. All rights reserved.
- * Copyright (C) 2012 Samsung Electronics. All rights reserved.
+ * Copyright (C) 2013 Google Inc. All rights reserved.

[tkent, 2014/06/05 16:06:18]

Ditto.

[timvolodine, 2014/06/05 17:29:04]

Done.

  *
  * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *  * Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- *  * Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
+ * modification, are permitted provided that the following conditions are
+ * met:
  *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
- * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "modules/device_orientation/DeviceOrientationController.h"
 
 #include "core/dom/Document.h"
-#include "core/frame/DOMWindow.h"
-#include "core/page/Page.h"
+#include "modules/EventModules.h"
 #include "modules/device_orientation/DeviceOrientationData.h"
 #include "modules/device_orientation/DeviceOrientationDispatcher.h"
 #include "modules/device_orientation/DeviceOrientationEvent.h"
 
 namespace WebCore {
 
 DeviceOrientationController::DeviceOrientationController(Document& document)
-    : DeviceSensorEventController(document.page())
-    , DOMWindowLifecycleObserver(document.domWindow())
-    , m_document(document)
+    : DeviceSingleWindowEventController(document)
 {
 }
 
 DeviceOrientationController::~DeviceOrientationController()
 {
     stopUpdating();
 }
 
-void DeviceOrientationController::didChangeDeviceOrientation(DeviceOrientationData* deviceOrientationData)
+void DeviceOrientationController::didUpdateData()
 {
     if (m_overrideOrientationData)
         return;
-    dispatchDeviceEvent(DeviceOrientationEvent::create(EventTypeNames::deviceorientation, deviceOrientationData));
+    dispatchDeviceEvent(lastEvent());
 }
 
 const char* DeviceOrientationController::supplementName()
 {
     return "DeviceOrientationController";
 }
 
 DeviceOrientationController& DeviceOrientationController::from(Document& document)
 {
     DeviceOrientationController* controller = static_cast<DeviceOrientationController*>(DocumentSupplement::from(document, supplementName()));
     if (!controller) {
         controller = new DeviceOrientationController(document);
         DocumentSupplement::provideTo(document, supplementName(), adoptPtrWillBeNoop(controller));
     }
     return *controller;
 }
 
-DeviceOrientationData* DeviceOrientationController::lastData()
+DeviceOrientationData* DeviceOrientationController::lastData() const
 {
     return m_overrideOrientationData ? m_overrideOrientationData.get() : DeviceOrientationDispatcher::instance().latestDeviceOrientationData();
 }
 
 bool DeviceOrientationController::hasLastData()
 {
     return lastData();
 }
 
-PassRefPtrWillBeRawPtr<Event> DeviceOrientationController::getLastEvent()
-{
-    return DeviceOrientationEvent::create(EventTypeNames::deviceorientation, lastData());
-}
-
 void DeviceOrientationController::registerWithDispatcher()
 {
-    DeviceOrientationDispatcher::instance().addDeviceOrientationController(this);
+    DeviceOrientationDispatcher::instance().addController(this);
 }
 
 void DeviceOrientationController::unregisterWithDispatcher()
 {
-    DeviceOrientationDispatcher::instance().removeDeviceOrientationController(this);
+    DeviceOrientationDispatcher::instance().removeController(this);
 }
 
-bool DeviceOrientationController::isNullEvent(Event* event)
+PassRefPtrWillBeRawPtr<Event> DeviceOrientationController::lastEvent() const
+{
+    return DeviceOrientationEvent::create(eventTypeName(), lastData());
+}
+
+bool DeviceOrientationController::isNullEvent(Event* event) const
 {
     DeviceOrientationEvent* orientationEvent = toDeviceOrientationEvent(event);
     return !orientationEvent->orientation()->canProvideEventData();
 }
 
-Document* DeviceOrientationController::document()
+const AtomicString& DeviceOrientationController::eventTypeName() const
 {
-    return &m_document;
-}
-
-void DeviceOrientationController::didAddEventListener(DOMWindow* window, const AtomicString& eventType)
-{
-    if (eventType != EventTypeNames::deviceorientation)
-        return;
-
-    if (page() && page()->visibilityState() == PageVisibilityStateVisible)
-        startUpdating();
-
-    m_hasEventListener = true;
-}
-
-void DeviceOrientationController::didRemoveEventListener(DOMWindow* window, const AtomicString& eventType)
-{
-    if (eventType != EventTypeNames::deviceorientation || window->hasEventListeners(EventTypeNames::deviceorientation))
-        return;
-
-    stopUpdating();
-    m_hasEventListener = false;
-}
-
-void DeviceOrientationController::didRemoveAllEventListeners(DOMWindow* window)
-{
-    stopUpdating();
-    m_hasEventListener = false;
+    return EventTypeNames::deviceorientation;
 }
 
 void DeviceOrientationController::setOverride(DeviceOrientationData* deviceOrientationData)
 {
-    m_overrideOrientationData.clear();
-    didChangeDeviceOrientation(deviceOrientationData);
+    ASSERT(deviceOrientationData);
     m_overrideOrientationData = deviceOrientationData;
+    dispatchDeviceEvent(lastEvent());
 }
 
 void DeviceOrientationController::clearOverride()
 {
     if (!m_overrideOrientationData)
         return;
     m_overrideOrientationData.clear();
-    DeviceOrientationData* orientation = lastData();
-    if (orientation)
-        didChangeDeviceOrientation(orientation);
+    if (lastData())
+        didUpdateData();
 }
 
 void DeviceOrientationController::trace(Visitor* visitor)
 {
     visitor->trace(m_overrideOrientationData);
     DocumentSupplement::trace(visitor);
 }
 
 } // namespace WebCore