reflow comments in core/html/shadow

third_party/WebKit/Source/core/html/shadow/MediaControls.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 126 matching lines @@
 
 MediaControls* MediaControls::create(HTMLMediaElement& mediaElement) {
   MediaControls* controls = new MediaControls(mediaElement);
   controls->setShadowPseudoId(AtomicString("-webkit-media-controls"));
   controls->initializeControls();
   return controls;
 }
 
 // The media controls DOM structure looks like:
 //
-// MediaControls                                       (-webkit-media-controls)
-// +-MediaControlOverlayEnclosureElement               (-webkit-media-controls-overlay-enclosure)
-// | +-MediaControlOverlayPlayButtonElement            (-webkit-media-controls-overlay-play-button)
+// MediaControls
+//     (-webkit-media-controls)
+// +-MediaControlOverlayEnclosureElement
+// |    (-webkit-media-controls-overlay-enclosure)
+// | +-MediaControlOverlayPlayButtonElement
+// | |    (-webkit-media-controls-overlay-play-button)
 // | | {if mediaControlsOverlayPlayButtonEnabled}
-// | \-MediaControlCastButtonElement                   (-internal-media-controls-overlay-cast-button)
-// \-MediaControlPanelEnclosureElement                 (-webkit-media-controls-enclosure)
-//   \-MediaControlPanelElement                        (-webkit-media-controls-panel)
-//     +-MediaControlPlayButtonElement                 (-webkit-media-controls-play-button)
+// | \-MediaControlCastButtonElement
+// |     (-internal-media-controls-overlay-cast-button)
+// \-MediaControlPanelEnclosureElement
+//   |    (-webkit-media-controls-enclosure)
+//   \-MediaControlPanelElement
+//     |    (-webkit-media-controls-panel)
+//     +-MediaControlPlayButtonElement
+//     |    (-webkit-media-controls-play-button)
 //     | {if !RTE::newMediaPlaybackUi()}
-//     +-MediaControlTimelineElement                   (-webkit-media-controls-timeline)
-//     +-MediaControlCurrentTimeDisplayElement         (-webkit-media-controls-current-time-display)
-//     +-MediaControlTimeRemainingDisplayElement       (-webkit-media-controls-time-remaining-display)
+//     +-MediaControlTimelineElement
+//     |    (-webkit-media-controls-timeline)
+//     +-MediaControlCurrentTimeDisplayElement
+//     |    (-webkit-media-controls-current-time-display)
+//     +-MediaControlTimeRemainingDisplayElement
+//     |    (-webkit-media-controls-time-remaining-display)
 //     | {if RTE::newMediaPlaybackUi()}
-//     +-MediaControlTimelineElement                   (-webkit-media-controls-timeline)
-//     +-MediaControlMuteButtonElement                 (-webkit-media-controls-mute-button)
-//     +-MediaControlVolumeSliderElement               (-webkit-media-controls-volume-slider)
-//     +-MediaControlFullscreenButtonElement           (-webkit-media-controls-fullscreen-button)
-//     +-MediaControlDownloadButtonElement             (-internal-media-controls-download-button)
-//     +-MediaControlToggleClosedCaptionsButtonElement (-webkit-media-controls-toggle-closed-captions-button)
-//     \-MediaControlCastButtonElement                 (-internal-media-controls-cast-button)
-// +-MediaControlTextTrackListElement                (-internal-media-controls-text-track-list)
+//     +-MediaControlTimelineElement
+//     |    (-webkit-media-controls-timeline)
+//     +-MediaControlMuteButtonElement
+//     |    (-webkit-media-controls-mute-button)
+//     +-MediaControlVolumeSliderElement
+//     |    (-webkit-media-controls-volume-slider)
+//     +-MediaControlFullscreenButtonElement
+//     |    (-webkit-media-controls-fullscreen-button)
+//     +-MediaControlDownloadButtonElement
+//     |    (-internal-media-controls-download-button)
+//     +-MediaControlToggleClosedCaptionsButtonElement
+//     |    (-webkit-media-controls-toggle-closed-captions-button)
+//     \-MediaControlCastButtonElement
+//         (-internal-media-controls-cast-button)
+// +-MediaControlTextTrackListElement
+// |    (-internal-media-controls-text-track-list)
 // | {for each renderable text track}
-//  \-MediaControlTextTrackListItem                 (-internal-media-controls-text-track-list-item)
-//  +-MediaControlTextTrackListItemInput            (-internal-media-controls-text-track-list-item-input)
-//  +-MediaControlTextTrackListItemCaptions         (-internal-media-controls-text-track-list-kind-captions)
-//  +-MediaControlTextTrackListItemSubtitles        (-internal-media-controls-text-track-list-kind-subtitles)
+//  \-MediaControlTextTrackListItem
+//  |   (-internal-media-controls-text-track-list-item)
+//  +-MediaControlTextTrackListItemInput
+//  |    (-internal-media-controls-text-track-list-item-input)
+//  +-MediaControlTextTrackListItemCaptions
+//  |    (-internal-media-controls-text-track-list-kind-captions)
+//  +-MediaControlTextTrackListItemSubtitles
+//  |    (-internal-media-controls-text-track-list-kind-subtitles)

[fs, 2016/10/05 20:52:08]

uNit: Could drop this pipe

[Nico, 2016/10/05 21:19:10]

Done.

 void MediaControls::initializeControls() {
   const bool useNewUi = RuntimeEnabledFeatures::newMediaPlaybackUiEnabled();
   MediaControlOverlayEnclosureElement* overlayEnclosure =
       MediaControlOverlayEnclosureElement::create(*this);
 
   if (document().settings() &&
       document().settings()->mediaControlsOverlayPlayButtonEnabled()) {
     MediaControlOverlayPlayButtonElement* overlayPlayButton =
         MediaControlOverlayPlayButtonElement::create(*this);
     m_overlayPlayButton = overlayPlayButton;
     overlayEnclosure->appendChild(overlayPlayButton);
   }
 
   MediaControlCastButtonElement* overlayCastButton =
       MediaControlCastButtonElement::create(*this, true);
   m_overlayCastButton = overlayCastButton;
   overlayEnclosure->appendChild(overlayCastButton);
 
   m_overlayEnclosure = overlayEnclosure;
   appendChild(overlayEnclosure);
 
-  // Create an enclosing element for the panel so we can visually offset the controls correctly.
+  // Create an enclosing element for the panel so we can visually offset the
+  // controls correctly.
   MediaControlPanelEnclosureElement* enclosure =
       MediaControlPanelEnclosureElement::create(*this);
 
   MediaControlPanelElement* panel = MediaControlPanelElement::create(*this);
 
   MediaControlPlayButtonElement* playButton =
       MediaControlPlayButtonElement::create(*this);
   m_playButton = playButton;
   panel->appendChild(playButton);
 
@@ skipping 67 matching lines @@
       MediaControlOverflowMenuButtonElement::create(*this);
   m_overflowMenu = overflowMenu;
   panel->appendChild(overflowMenu);
 
   MediaControlOverflowMenuListElement* overflowList =
       MediaControlOverflowMenuListElement::create(*this);
   m_overflowList = overflowList;
   appendChild(overflowList);
 
   // The order in which we append elements to the overflow list is significant
-  // because it determines how the elements show up in the overflow menu relative to each other.
-  // The first item appended appears at the top of the overflow menu.
+  // because it determines how the elements show up in the overflow menu
+  // relative to each other.  The first item appended appears at the top of the
+  // overflow menu.
   m_overflowList->appendChild(m_playButton->createOverflowElement(
       *this, MediaControlPlayButtonElement::create(*this)));
   m_overflowList->appendChild(m_fullscreenButton->createOverflowElement(
       *this, MediaControlFullscreenButtonElement::create(*this)));
   m_overflowList->appendChild(m_downloadButton->createOverflowElement(
       *this, MediaControlDownloadButtonElement::create(*this)));
   m_overflowList->appendChild(m_muteButton->createOverflowElement(
       *this, MediaControlMuteButtonElement::create(*this)));
   m_overflowList->appendChild(m_castButton->createOverflowElement(
       *this, MediaControlCastButtonElement::create(*this, false)));
@@ skipping 176 matching lines @@
 
   // Allow the theme to format the time.
   m_currentTimeDisplay->setInnerText(
       LayoutTheme::theme().formatMediaControlsCurrentTime(now, duration),
       IGNORE_EXCEPTION);
   m_currentTimeDisplay->setCurrentValue(now);
 }
 
 void MediaControls::updateVolume() {
   m_muteButton->updateDisplayType();
-  // Invalidate the mute button because it paints differently according to volume.
+  // Invalidate the mute button because it paints differently according to
+  // volume.
   invalidate(m_muteButton);
 
   if (mediaElement().muted())
     m_volumeSlider->setVolume(0);
   else
     m_volumeSlider->setVolume(mediaElement().volume());
 
   // Update the visibility of our audio elements.
   // We never want the volume slider if there's no audio.
   // If there is audio, then we want it unless hiding audio is enabled and
   // we prefer to hide it.
   BatchedControlUpdate batch(this);
   m_volumeSlider->setIsWanted(
       mediaElement().hasAudio() &&
       !(m_allowHiddenVolumeControls && preferHiddenVolumeControls(document())));
 
   // The mute button is a little more complicated.  If enableNewMediaPlaybackUi
   // is true, then we choose to hide or show the mute button to save space.
   // If enableNew* is not set, then we never touch the mute button, and
   // instead leave it to the CSS.
-  // Note that this is why m_allowHiddenVolumeControls isn't rolled into prefer...().
+  // Note that this is why m_allowHiddenVolumeControls isn't rolled into
+  // prefer...().
   if (m_allowHiddenVolumeControls) {
     // If there is no audio track, then hide the mute button.
     m_muteButton->setIsWanted(mediaElement().hasAudio());
   }
 
-  // Invalidate the volume slider because it paints differently according to volume.
+  // Invalidate the volume slider because it paints differently according to
+  // volume.
   invalidate(m_volumeSlider);
 }
 
 void MediaControls::changedClosedCaptionsVisibility() {
   m_toggleClosedCaptionsButton->updateDisplayType();
 }
 
 void MediaControls::refreshClosedCaptionsButtonVisibility() {
   m_toggleClosedCaptionsButton->setIsWanted(mediaElement().hasClosedCaptions());
   BatchedControlUpdate batch(this);
@@ skipping 16 matching lines @@
   BatchedControlUpdate batch(this);
 }
 
 void MediaControls::refreshCastButtonVisibilityWithoutUpdate() {
   if (!shouldShowCastButton(mediaElement())) {
     m_castButton->setIsWanted(false);
     m_overlayCastButton->setIsWanted(false);
     return;
   }
 
-  // The reason for the autoplay test is that some pages (e.g. vimeo.com) have an autoplay background video, which
-  // doesn't autoplay on Chrome for Android (we prevent it) so starts paused. In such cases we don't want to automatically
-  // show the cast button, since it looks strange and is unlikely to correspond with anything the user wants to do.
-  // If a user does want to cast a paused autoplay video then they can still do so by touching or clicking on the
-  // video, which will cause the cast button to appear.
+  // The reason for the autoplay test is that some pages (e.g. vimeo.com) have
+  // an autoplay background video, which doesn't autoplay on Chrome for Android
+  // (we prevent it) so starts paused. In such cases we don't want to
+  // automatically show the cast button, since it looks strange and is unlikely
+  // to correspond with anything the user wants to do.  If a user does want to
+  // cast a paused autoplay video then they can still do so by touching or
+  // clicking on the video, which will cause the cast button to appear.
   if (!mediaElement().shouldShowControls() && !mediaElement().autoplay() &&
       mediaElement().paused()) {
     // Note that this is a case where we add the overlay cast button
     // without wanting the panel cast button.  We depend on the fact
     // that computeWhichControlsFit() won't change overlay cast button
     // visibility in the case where the cast button isn't wanted.
     // We don't call compute...() here, but it will be called as
     // non-cast changes (e.g., resize) occur.  If the panel button
     // is shown, however, compute...() will take control of the
     // overlay cast button if it needs to hide it from the panel.
@@ skipping 41 matching lines @@
 }
 
 void MediaControls::stoppedCasting() {
   m_castButton->setIsPlayingRemotely(false);
   m_overlayCastButton->setIsPlayingRemotely(false);
 }
 
 void MediaControls::defaultEventHandler(Event* event) {
   HTMLDivElement::defaultEventHandler(event);
 
-  // Add IgnoreControlsHover to m_hideTimerBehaviorFlags when we see a touch event,
-  // to allow the hide-timer to do the right thing when it fires.
-  // FIXME: Preferably we would only do this when we're actually handling the event
-  // here ourselves.
+  // Add IgnoreControlsHover to m_hideTimerBehaviorFlags when we see a touch
+  // event, to allow the hide-timer to do the right thing when it fires.
+  // FIXME: Preferably we would only do this when we're actually handling the
+  // event here ourselves.
   bool wasLastEventTouch =
       event->isTouchEvent() || event->isGestureEvent() ||
       (event->isMouseEvent() && toMouseEvent(event)->fromTouch());
   m_hideTimerBehaviorFlags |=
       wasLastEventTouch ? IgnoreControlsHover : IgnoreNone;
 
   if (event->type() == EventTypeNames::mouseover) {
     if (!containsRelatedTarget(event)) {
       m_isMouseOverControls = true;
       if (!mediaElement().paused()) {
@@ skipping 266 matching lines @@
   visitor->trace(m_textTrackList);
   visitor->trace(m_overflowMenu);
   visitor->trace(m_overflowList);
   visitor->trace(m_castButton);
   visitor->trace(m_overlayCastButton);
   visitor->trace(m_windowEventListener);
   HTMLDivElement::trace(visitor);
 }
 
 }  // namespace blink