chrome/blink: Add functionality for in-product help for media elements.

third_party/WebKit/Source/modules/media_controls/MediaControlsImpl.cpp

 /*
  * Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
  * Copyright (C) 2011, 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 11 matching lines @@
  * 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 "modules/media_controls/MediaControlsImpl.h"
 
 #include "bindings/core/v8/ExceptionState.h"
 #include "core/dom/ClientRect.h"
 #include "core/dom/Fullscreen.h"
+#include "core/dom/MediaIPHManager.h"
 #include "core/dom/MutationCallback.h"
 #include "core/dom/MutationObserver.h"
 #include "core/dom/MutationObserverInit.h"
 #include "core/dom/MutationRecord.h"
 #include "core/dom/ResizeObserver.h"
 #include "core/dom/ResizeObserverEntry.h"
 #include "core/dom/TaskRunnerHelper.h"
 #include "core/events/KeyboardEvent.h"
 #include "core/events/MouseEvent.h"
 #include "core/frame/Settings.h"
@@ skipping 594 matching lines @@
   const bool ignore_focus = behavior_flags & kIgnoreFocus;
   if (!ignore_focus && (MediaElement().IsFocused() ||
                         contains(GetDocument().FocusedElement()))) {
     return false;
   }
 
   // Don't hide the media controls when a panel is showing.
   if (text_track_list_->IsWanted() || overflow_list_->IsWanted())
     return false;
 
+  // Don't hide the media controls while the iph is showing.
+  if (iph_active_)
+    return false;
+
   return true;
 }
 
 void MediaControlsImpl::UpdatePlayState() {
   if (is_paused_for_scrubbing_)
     return;
 
   if (overlay_play_button_)
     overlay_play_button_->UpdateDisplayType();
   play_button_->UpdateDisplayType();
@@ skipping 308 matching lines @@
   UpdateCurrentTimeDisplay();
 
   // Update the timeline (the UI with the seek marker).
   timeline_->SetDuration(duration);
 }
 
 void MediaControlsImpl::OnPlay() {
   UpdatePlayState();
   timeline_->SetPosition(MediaElement().currentTime());
   UpdateCurrentTimeDisplay();
+  MaybeDispatchDownloadIPHTrigger();
 }
 
 void MediaControlsImpl::OnPlaying() {
   timeline_->OnPlaying();
 
   StartHideMediaControlsTimer();
 }
 
 void MediaControlsImpl::OnPause() {
   UpdatePlayState();
@@ skipping 225 matching lines @@
 
 void MediaControlsImpl::HideAllMenus() {
   window_event_listener_->Stop();
 
   if (overflow_list_->IsWanted())
     overflow_list_->SetIsWanted(false);
   if (text_track_list_->IsWanted())
     text_track_list_->SetVisible(false);
 }
 
+void MediaControlsImpl::MaybeDispatchDownloadIPHTrigger() {
+  if (!iph_trigger_observed_ && download_button_->IsWanted() &&
+      !MediaElement().paused() &&
+      MediaElement().GetDocument().GetMediaIPHManager() &&
+      MediaElement()
+          .GetDocument()
+          .GetMediaIPHManager()
+          ->IPHTriggerObservedOnElement(MediaElement())) {
+    iph_active_ = true;
+    iph_trigger_observed_ = true;
+    MaybeShow();

[chrishtr, 2017/06/23 00:39:44]

Why call MaybeShow and MakeOpaque?

[Khushal, 2017/06/23 02:11:06]

MakeOpaque is unnecessary. There should be an assert instead that MaybeShow does
show the controls.

[Khushal, 2017/06/28 05:32:38]

Done.

+    MakeOpaque();
+  }
+}
+
+bool MediaControlsImpl::GetDownloadButtonRect(IntRect& rect) {
+  if (!IsVisible())
+    return false;
+  if (!download_button_->IsWanted())
+    return false;
+
+  rect = download_button_->VisibleBoundsInVisualViewport();
+  return true;
+}
+
+void MediaControlsImpl::IPHDisabled() {
+  if (!iph_active_)
+    return;
+
+  iph_active_ = false;
+  if (ShouldHideMediaControls())
+    StartHideMediaControlsTimer();
+}
+
 DEFINE_TRACE(MediaControlsImpl) {
   visitor->Trace(element_mutation_callback_);
   visitor->Trace(resize_observer_);
   visitor->Trace(panel_);
   visitor->Trace(overlay_play_button_);
   visitor->Trace(overlay_enclosure_);
   visitor->Trace(play_button_);
   visitor->Trace(current_time_display_);
   visitor->Trace(timeline_);
   visitor->Trace(mute_button_);
@@ skipping 10 matching lines @@
   visitor->Trace(overlay_cast_button_);
   visitor->Trace(media_event_listener_);
   visitor->Trace(window_event_listener_);
   visitor->Trace(orientation_lock_delegate_);
   visitor->Trace(rotate_to_fullscreen_delegate_);
   MediaControls::Trace(visitor);
   HTMLDivElement::Trace(visitor);
 }
 
 }  // namespace blink