Convert FullscreenController to use WebCallbacks

third_party/WebKit/Source/core/dom/Fullscreen.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All
  * rights reserved.
  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
  * (http://www.torchmobile.com/)
  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
@@ skipping 30 matching lines @@
 #include "core/html/HTMLIFrameElement.h"
 #include "core/input/EventHandler.h"
 #include "core/inspector/ConsoleMessage.h"
 #include "core/layout/LayoutBlockFlow.h"
 #include "core/layout/LayoutFullScreen.h"
 #include "core/layout/api/LayoutFullScreenItem.h"
 #include "core/page/ChromeClient.h"
 #include "core/svg/SVGSVGElement.h"
 #include "platform/ScopedOrientationChangeIndicator.h"
 #include "platform/UserGestureIndicator.h"
+#include "public/platform/WebFullscreenCallbacks.h"
 
 namespace blink {
 
 namespace {
 
 // https://html.spec.whatwg.org/multipage/embedded-content.html#allowed-to-use
 bool allowedToUseFullscreen(const Frame* frame) {
   // To determine whether a Document object |document| is allowed to use the
   // feature indicated by attribute name |allowattribute|, run these steps:
 
@@ skipping 118 matching lines @@
 // works even in OOPIF scenarios like A-B-A, where there may be remote frames
 // in between |doc| and |descendant|.
 HTMLFrameOwnerElement* findContainerForDescendant(const Document& doc,
                                                   const Document& descendant) {
   Frame* frame = descendant.frame();
   while (frame->tree().parent() != doc.frame())
     frame = frame->tree().parent();
   return toHTMLFrameOwnerElement(frame->owner());
 }
 
+class FullscreenCallbacks final : public WebFullscreenCallbacks {
+  // FIXME(tasak): When making public/platform classes to use PartitionAlloc,
+  // the following macro should be moved to WebCallbacks defined in
+  // public/platform/WebCallbacks.h.
+  USING_FAST_MALLOC(FullscreenCallbacks);
+  WTF_MAKE_NONCOPYABLE(FullscreenCallbacks);
+
+ public:
+  FullscreenCallbacks(std::unique_ptr<WTF::Closure> success,
+                      std::unique_ptr<WTF::Closure> error)
+      : m_success(std::move(success)), m_error(std::move(error)) {}
+  void onSuccess() override { (*m_success)(); }
+  void onError() override { (*m_error)(); }
+
+ private:
+  std::unique_ptr<WTF::Closure> m_success;
+  std::unique_ptr<WTF::Closure> m_error;
+};
+
 }  // anonymous namespace
 
 const char* Fullscreen::supplementName() {
   return "Fullscreen";
 }
 
 Fullscreen& Fullscreen::from(Document& document) {
   Fullscreen* fullscreen = fromIfExists(document);
   if (!fullscreen) {
     fullscreen = new Fullscreen(document);
@@ skipping 92 matching lines @@
   if (!forCrossProcessDescendant) {
     if (document.isSecureContext()) {
       UseCounter::count(document, UseCounter::FullscreenSecureOrigin);
     } else {
       UseCounter::count(document, UseCounter::FullscreenInsecureOrigin);
       HostsUsingFeatures::countAnyWorld(
           document, HostsUsingFeatures::Feature::FullscreenInsecureHost);
     }
   }
 
-  // Ignore this request if the document is not in a live frame.
-  if (!document.isActive())
+  // Ignore this call if the document is not in a live frame.
+  if (!document.isActive() || !document.frame())
     return;
 
   // If |element| is on top of |doc|'s fullscreen element stack, terminate these
   // substeps.
   if (&element == fullscreenElementFrom(document))
     return;
 
   do {
     // 1. If any of the following conditions are false, then terminate these
     // steps and queue a task to fire an event named fullscreenerror with its
@@ skipping 79 matching lines @@
         continue;
       }
 
       // 4. Otherwise, do nothing for this document. It stays the same.
     } while (++current != docs.end());
 
     from(document).m_forCrossProcessDescendant = forCrossProcessDescendant;
 
     // 5. Return, and run the remaining steps asynchronously.
     // 6. Optionally, perform some animation.
-    document.frameHost()->chromeClient().enterFullscreenForElement(&element);
+    document.frameHost()->chromeClient().enterFullscreen(
+        *document.frame(),
+        wrapUnique(new FullscreenCallbacks(

[mlamouri (slow - plz ping), 2016/11/30 09:24:57]

Any particular reason why not keepinp track of `document` and `element` in
`FullscreenCallbacks` and call the right method instead of creating two bind?

[foolip, 2016/11/30 10:23:52]

This is a wart from before when I was using callbacks for exit as well, and I
didn't simplify. I'll see about having FullscreenCallbacks have
Persistent<Document>, Persistent<Element> and a RequestType instead. (One
original reason for this refactoring was that I didn't want to make
FullscreenController keep track of three things like that.)

+            WTF::bind(&Fullscreen::didEnterFullscreenForElement,
+                      wrapPersistent(&from(document)),
+                      wrapPersistent(&element)),
+            WTF::bind(&Fullscreen::enqueueErrorEvent,
+                      wrapPersistent(&from(document)), wrapPersistent(&element),
+                      requestType))));
 
     // 7. Optionally, display a message indicating how the user can exit
     // displaying the context object fullscreen.
     return;
   } while (false);
 
-  from(document).enqueueErrorEvent(element, requestType);
+  from(document).enqueueErrorEvent(&element, requestType);
 }
 
 // https://fullscreen.spec.whatwg.org/#fully-exit-fullscreen
 void Fullscreen::fullyExitFullscreen(Document& document) {
   // To fully exit fullscreen, run these steps:
 
   // 1. Let |doc| be the top-level browsing context's document.
   //
   // Since the top-level browsing context's document might be unavailable in
   // OOPIF scenarios (i.e., when the top frame is remote), this actually uses
@@ skipping 14 matching lines @@
   DCHECK_EQ(from(doc).m_fullscreenElementStack.size(), 1u);
 
   // 4. Act as if the exitFullscreen() method was invoked on |doc|.
   exitFullscreen(doc);
 }
 
 // https://fullscreen.spec.whatwg.org/#exit-fullscreen
 void Fullscreen::exitFullscreen(Document& document) {
   // The exitFullscreen() method must run these steps:
 
-  // 1. Let doc be the context object. (i.e. "this")
-  if (!document.isActive())
+  // Ignore this call if the document is not in a live frame.
+  if (!document.isActive() || !document.frame())
     return;
 
+  // 1. Let doc be the context object. (i.e. "this")
   // 2. If doc's fullscreen element stack is empty, terminate these steps.
   if (!fullscreenElementFrom(document))
     return;
 
   // 3. Let descendants be all the doc's descendant browsing context's documents
   // with a non-empty fullscreen element stack (if any), ordered so that the
   // child of the doc is last and the document furthest away from the doc is
   // first.
   HeapDeque<Member<Document>> descendants;
-  for (Frame* descendant =
-           document.frame() ? document.frame()->tree().traverseNext() : nullptr;
-       descendant; descendant = descendant->tree().traverseNext()) {
+  for (Frame* descendant = document.frame()->tree().traverseNext(); descendant;
+       descendant = descendant->tree().traverseNext()) {
     if (!descendant->isLocalFrame())
       continue;
     DCHECK(toLocalFrame(descendant)->document());
     if (fullscreenElementFrom(*toLocalFrame(descendant)->document()))
       descendants.prepend(toLocalFrame(descendant)->document());
   }
 
   // 4. For each descendant in descendants, empty descendant's fullscreen
   // element stack, and queue a task to fire an event named fullscreenchange
   // with its bubbles attribute set to true on descendant.
@@ skipping 52 matching lines @@
   // 7. Optionally, perform some animation.
 
   FrameHost* host = document.frameHost();
 
   // Speculative fix for engaget.com/videos per crbug.com/336239.
   // FIXME: This check is wrong. We DCHECK(document->isActive()) above
   // so this should be redundant and should be removed!
   if (!host)
     return;
 
-  // Only exit out of full screen window mode if there are no remaining elements
-  // in the full screen stack.
+  // Only exit fullscreen mode if the fullscreen element stack is empty.
   if (!newTop) {
-    host->chromeClient().exitFullscreen(document.frame());
+    host->chromeClient().exitFullscreen(*document.frame());
     return;
   }
 
-  // Otherwise, notify the chrome of the new full screen element.
-  host->chromeClient().enterFullscreenForElement(newTop);
+  // Otherwise, enter fullscreen for the fullscreen element stack's top element.
+  from(document).didEnterFullscreenForElement(newTop);
 }
 
 // https://fullscreen.spec.whatwg.org/#dom-document-fullscreenenabled
 bool Fullscreen::fullscreenEnabled(Document& document) {
   // The fullscreenEnabled attribute's getter must return true if the context
   // object is allowed to use the feature indicated by attribute name
   // allowfullscreen and fullscreen is supported, and false otherwise.
   return allowedToUseFullscreen(document.frame()) &&
          fullscreenIsSupported(document);
 }
@@ skipping 58 matching lines @@
                                                                element);
 }
 
 void Fullscreen::didExitFullscreen() {
   if (!document()->isActive() || !document()->frame())
     return;
 
   if (!m_currentFullScreenElement)
     return;
 
+  // If fullscreen was canceled by the browser, e.g. if the user pressed Esc,
+  // then |exitFullscreen()| was never called. Let |fullyExitFullscreen()| clear
+  // the fullscreen element stack and fire any events as necessary.
+  // TODO(foolip): Remove this when state changes and events are synchronized
+  // with animation frames. https://crbug.com/402376
+  fullyExitFullscreen(*document());
+
   if (m_forCrossProcessDescendant)
     m_currentFullScreenElement->setContainsFullScreenElement(false);
 
   m_currentFullScreenElement
       ->setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(false);
 
   if (m_fullScreenLayoutObject)
     LayoutFullScreenItem(m_fullScreenLayoutObject).unwrapLayoutObject();
 
   document()->styleEngine().ensureUAStyleForFullscreen();
@@ skipping 57 matching lines @@
       target = fullscreen.currentFullScreenElement();
     if (!target)
       target = &document;
     event = createEvent(EventTypeNames::webkitfullscreenchange, *target);
   }
   m_eventQueue.append(event);
   // NOTE: The timer is started in
   // didEnterFullscreenForElement/didExitFullscreen.
 }
 
-void Fullscreen::enqueueErrorEvent(Element& element, RequestType requestType) {
+void Fullscreen::enqueueErrorEvent(Element* element, RequestType requestType) {
+  DCHECK(element);
+
   Event* event;
   if (requestType == UnprefixedRequest)
-    event = createEvent(EventTypeNames::fullscreenerror, element.document());
+    event = createEvent(EventTypeNames::fullscreenerror, element->document());
   else
-    event = createEvent(EventTypeNames::webkitfullscreenerror, element);
+    event = createEvent(EventTypeNames::webkitfullscreenerror, *element);
   m_eventQueue.append(event);
   m_eventQueueTimer.startOneShot(0, BLINK_FROM_HERE);
 }
 
 void Fullscreen::eventQueueTimerFired(TimerBase*) {
   HeapDeque<Member<Event>> eventQueue;
   m_eventQueue.swap(eventQueue);
 
   while (!eventQueue.isEmpty()) {
     Event* event = eventQueue.takeFirst();
@@ skipping 52 matching lines @@
 
 DEFINE_TRACE(Fullscreen) {
   visitor->trace(m_currentFullScreenElement);
   visitor->trace(m_fullscreenElementStack);
   visitor->trace(m_eventQueue);
   Supplement<Document>::trace(visitor);
   ContextLifecycleObserver::trace(visitor);
 }
 
 }  // namespace blink