[DevTools] Implement screen orientation override.

Source/modules/screen_orientation/ScreenOrientationController.cpp

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "config.h"
 #include "modules/screen_orientation/ScreenOrientationController.h"
 
 #include "core/events/Event.h"
 #include "core/frame/FrameHost.h"
 #include "core/frame/FrameView.h"
@@ skipping 23 matching lines @@
 ScreenOrientationController* ScreenOrientationController::from(LocalFrame& frame)
 {
     return static_cast<ScreenOrientationController*>(WillBeHeapSupplement<LocalFrame>::from(frame, supplementName()));
 }
 
 ScreenOrientationController::ScreenOrientationController(LocalFrame& frame, WebScreenOrientationClient* client)
     : LocalFrameLifecycleObserver(&frame)
     , PlatformEventController(frame.page())
     , m_client(client)
     , m_dispatchEventTimer(this, &ScreenOrientationController::dispatchEventTimerFired)
+    , m_override(false)
+    , m_overrideType(WebScreenOrientationUndefined)
+    , m_overrideAngle(0)
 {
 }
 
 const char* ScreenOrientationController::supplementName()
 {
     return "ScreenOrientationController";
 }
 
 // Compute the screen orientation using the orientation angle and the screen width / height.
-WebScreenOrientationType ScreenOrientationController::computeOrientation(ChromeClient& chromeClient)
+WebScreenOrientationType ScreenOrientationController::computeOrientation(const IntRect& rect, uint16_t rotation)

[mlamouri (slow - plz ping), 2015/06/26 10:10:53]

I'm not sure why you are changing this. You could take chromeClient and get the
effectiveAngle() from there. Is there a reason I'm missing?

[dgozman, 2015/06/26 10:18:39]

This is a static method, and we need m_overrideXXX fields for effectiveAngle.

 {
     // Bypass orientation detection in layout tests to get consistent results.
     // FIXME: The screen dimension should be fixed when running the layout tests to avoid such
     // issues.
     if (LayoutTestSupport::isRunningLayoutTest())
         return WebScreenOrientationPortraitPrimary;
 
-    IntRect rect = chromeClient.screenInfo().rect;
-    uint16_t rotation = chromeClient.screenInfo().orientationAngle;
     bool isTallDisplay = rotation % 180 ? rect.height() < rect.width() : rect.height() > rect.width();
     switch (rotation) {
     case 0:
         return isTallDisplay ? WebScreenOrientationPortraitPrimary : WebScreenOrientationLandscapePrimary;
     case 90:
         return isTallDisplay ? WebScreenOrientationLandscapePrimary : WebScreenOrientationPortraitSecondary;
     case 180:
         return isTallDisplay ? WebScreenOrientationPortraitSecondary : WebScreenOrientationLandscapeSecondary;
     case 270:
         return isTallDisplay ? WebScreenOrientationLandscapeSecondary : WebScreenOrientationPortraitPrimary;
     default:
         ASSERT_NOT_REACHED();
         return WebScreenOrientationPortraitPrimary;
     }
 }
 
+unsigned short ScreenOrientationController::effectiveAngle(ChromeClient& chromeClient)
+{
+    return m_override ? m_overrideAngle : chromeClient.screenInfo().orientationAngle;
+}
+
+WebScreenOrientationType ScreenOrientationController::effectiveType(ChromeClient& chromeClient)
+{
+    return m_override ? m_overrideType : chromeClient.screenInfo().orientationType;
+}
+
 void ScreenOrientationController::updateOrientation()
 {
     ASSERT(m_orientation);
     ASSERT(frame());
     ASSERT(frame()->host());
 
     ChromeClient& chromeClient = frame()->host()->chromeClient();
-    WebScreenOrientationType orientationType = chromeClient.screenInfo().orientationType;
+    WebScreenOrientationType orientationType = effectiveType(chromeClient);
     if (orientationType == WebScreenOrientationUndefined) {
         // The embedder could not provide us with an orientation, deduce it ourselves.
-        orientationType = computeOrientation(chromeClient);
+        orientationType = computeOrientation(chromeClient.screenInfo().rect, effectiveAngle(chromeClient));
     }
     ASSERT(orientationType != WebScreenOrientationUndefined);
 
     m_orientation->setType(orientationType);
-    m_orientation->setAngle(chromeClient.screenInfo().orientationAngle);
+    m_orientation->setAngle(effectiveAngle(chromeClient));
 }
 
 bool ScreenOrientationController::isActiveAndVisible() const
 {
     return m_orientation && frame() && page() && page()->visibilityState() == PageVisibilityStateVisible;
 }
 
 void ScreenOrientationController::pageVisibilityChanged()
 {
     notifyDispatcher();
 
     if (!isActiveAndVisible())
         return;
 
     // The orientation type and angle are tied in a way that if the angle has
     // changed, the type must have changed.
-    unsigned short currentAngle = frame()->host()->chromeClient().screenInfo().orientationAngle;
+    unsigned short currentAngle = effectiveAngle(frame()->host()->chromeClient());
 
     // FIXME: sendOrientationChangeEvent() currently send an event all the
     // children of the frame, so it should only be called on the frame on
     // top of the tree. We would need the embedder to call
     // sendOrientationChangeEvent on every WebFrame part of a WebView to be
     // able to remove this.
     if (frame() == frame()->localFrameRoot() && m_orientation->angle() != currentAngle)
         notifyOrientationChanged();
 }
 
@@ skipping 43 matching lines @@
 }
 
 void ScreenOrientationController::unlock()
 {
     // When detached, the client is no longer valid.
     if (!m_client)
         return;
     m_client->unlockOrientation();
 }
 
+void ScreenOrientationController::setOverride(WebScreenOrientationType type, unsigned short angle)
+{
+    m_override = true;
+    m_overrideType = type;
+    m_overrideAngle = angle;
+    notifyOrientationChanged();
+}
+
+void ScreenOrientationController::clearOverride()
+{
+    m_override = false;
+    notifyOrientationChanged();
+}
+
 void ScreenOrientationController::dispatchEventTimerFired(Timer<ScreenOrientationController>*)
 {
     if (!m_orientation)
         return;
     m_orientation->dispatchEvent(Event::create(EventTypeNames::change));
 }
 
 void ScreenOrientationController::didUpdateData()
 {
     // Do nothing.
@@ skipping 29 matching lines @@
 
 DEFINE_TRACE(ScreenOrientationController)
 {
     visitor->trace(m_orientation);
     LocalFrameLifecycleObserver::trace(visitor);
     WillBeHeapSupplement<LocalFrame>::trace(visitor);
     PlatformEventController::trace(visitor);
 }
 
 } // namespace blink