reflow comments in core/html/shadow

third_party/WebKit/Source/core/html/shadow/MediaControlElements.cpp

 /*
  * Copyright (C) 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
  * Copyright (C) 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.
@@ skipping 45 matching lines @@
 namespace blink {
 
 using namespace HTMLNames;
 
 namespace {
 
 // This is the duration from mediaControls.css
 const double fadeOutDuration = 0.3;
 
 const QualifiedName& trackIndexAttrName() {
-  // Save the track index in an attribute to avoid holding a pointer to the text track.
+  // Save the track index in an attribute to avoid holding a pointer to the text
+  // track.
   DEFINE_STATIC_LOCAL(QualifiedName, trackIndexAttr,
                       (nullAtom, "data-track-index", nullAtom));
   return trackIndexAttr;
 }
 
 // When specified as trackIndex, disable text tracks.
 const int trackIndexOffValue = -1;
 
 bool isUserInteractionEvent(Event* event) {
   const AtomicString& type = event->type();
   return type == EventTypeNames::mousedown || type == EventTypeNames::mouseup ||
          type == EventTypeNames::click || type == EventTypeNames::dblclick ||
          event->isKeyboardEvent() || event->isTouchEvent();
 }
 
-// Sliders (the volume control and timeline) need to capture some additional events used when dragging the thumb.
+// Sliders (the volume control and timeline) need to capture some additional
+// events used when dragging the thumb.
 bool isUserInteractionEventForSlider(Event* event, LayoutObject* layoutObject) {
   // It is unclear if this can be converted to isUserInteractionEvent(), since
   // mouse* events seem to be eaten during a drag anyway.  crbug.com/516416 .
   if (isUserInteractionEvent(event))
     return true;
 
   // Some events are only captured during a slider drag.
   LayoutSliderItem slider = LayoutSliderItem(toLayoutSlider(layoutObject));
   if (!slider.isNull() && !slider.inDragMode())
     return false;
 
   const AtomicString& type = event->type();
   return type == EventTypeNames::mouseover ||
          type == EventTypeNames::mouseout || type == EventTypeNames::mousemove;
 }
 
 Element* elementFromCenter(Element& element) {
   ClientRect* clientRect = element.getBoundingClientRect();
   int centerX =
       static_cast<int>((clientRect->left() + clientRect->right()) / 2);
   int centerY =
       static_cast<int>((clientRect->top() + clientRect->bottom()) / 2);
 
   return element.document().elementFromPoint(centerX, centerY);
 }
 
 bool hasDuplicateLabel(TextTrack* currentTrack) {
   DCHECK(currentTrack);
   TextTrackList* trackList = currentTrack->trackList();
-  // The runtime of this method is quadratic but since there are usually very few text tracks it won't
-  // affect the performance much.
+  // The runtime of this method is quadratic but since there are usually very
+  // few text tracks it won't affect the performance much.
   String currentTrackLabel = currentTrack->label();
   for (unsigned i = 0; i < trackList->length(); i++) {
     TextTrack* track = trackList->anonymousIndexedGetter(i);
     if (currentTrack != track && currentTrackLabel == track->label())
       return true;
   }
   return false;
 }
 
 }  // anonymous namespace
@@ skipping 84 matching lines @@
 }
 
 bool MediaControlPanelElement::keepEventInNode(Event* event) {
   return isUserInteractionEvent(event);
 }
 
 // ----------------------------
 
 MediaControlPanelEnclosureElement::MediaControlPanelEnclosureElement(
     MediaControls& mediaControls)
-    // Mapping onto same MediaControlElementType as panel element, since it has similar properties.
+    // Mapping onto same MediaControlElementType as panel element, since it has
+    // similar properties.
     : MediaControlDivElement(mediaControls, MediaControlsPanel) {}
 
 MediaControlPanelEnclosureElement* MediaControlPanelEnclosureElement::create(
     MediaControls& mediaControls) {
   MediaControlPanelEnclosureElement* enclosure =
       new MediaControlPanelEnclosureElement(mediaControls);
   enclosure->setShadowPseudoId(
       AtomicString("-webkit-media-controls-enclosure"));
   return enclosure;
 }
 
 // ----------------------------
 
 MediaControlOverlayEnclosureElement::MediaControlOverlayEnclosureElement(
     MediaControls& mediaControls)
-    // Mapping onto same MediaControlElementType as panel element, since it has similar properties.
+    // Mapping onto same MediaControlElementType as panel element, since it has
+    // similar properties.
     : MediaControlDivElement(mediaControls, MediaControlsPanel) {}
 
 MediaControlOverlayEnclosureElement*
 MediaControlOverlayEnclosureElement::create(MediaControls& mediaControls) {
   MediaControlOverlayEnclosureElement* enclosure =
       new MediaControlOverlayEnclosureElement(mediaControls);
   enclosure->setShadowPseudoId(
       AtomicString("-webkit-media-controls-overlay-enclosure"));
   return enclosure;
 }
 
 EventDispatchHandlingState*
 MediaControlOverlayEnclosureElement::preDispatchEventHandler(Event* event) {
-  // When the media element is clicked or touched we want to make the overlay cast button visible
-  // (if the other requirements are right) even if JavaScript is doing its own handling of the event.
-  // Doing it in preDispatchEventHandler prevents any interference from JavaScript.
-  // Note that we can't simply test for click, since JS handling of touch events can prevent their translation to click events.
+  // When the media element is clicked or touched we want to make the overlay
+  // cast button visible (if the other requirements are right) even if
+  // JavaScript is doing its own handling of the event.  Doing it in
+  // preDispatchEventHandler prevents any interference from JavaScript.
+  // Note that we can't simply test for click, since JS handling of touch events
+  // can prevent their translation to click events.
   if (event && (event->type() == EventTypeNames::click ||
                 event->type() == EventTypeNames::touchstart))
     mediaControls().showOverlayCastButtonIfNeeded();
   return MediaControlDivElement::preDispatchEventHandler(event);
 }
 
 // ----------------------------
 
 MediaControlMuteButtonElement::MediaControlMuteButtonElement(
     MediaControls& mediaControls)
@@ skipping 55 matching lines @@
 
 void MediaControlPlayButtonElement::defaultEventHandler(Event* event) {
   if (event->type() == EventTypeNames::click) {
     if (mediaElement().paused())
       Platform::current()->recordAction(
           UserMetricsAction("Media.Controls.Play"));
     else
       Platform::current()->recordAction(
           UserMetricsAction("Media.Controls.Pause"));
 
-    // Allow play attempts for plain src= media to force a reload in the error state. This allows potential
-    // recovery for transient network and decoder resource issues.
+    // Allow play attempts for plain src= media to force a reload in the error
+    // state. This allows potential recovery for transient network and decoder
+    // resource issues.
     const String& url = mediaElement().currentSrc().getString();
     if (mediaElement().error() && !HTMLMediaElement::isMediaStreamURL(url) &&
         !HTMLMediaSource::lookup(url))
       mediaElement().load();
 
     mediaElement().togglePlayState();
     updateDisplayType();
     event->setDefaultHandled();
   }
   MediaControlInputElement::defaultEventHandler(event);
@@ skipping 159 matching lines @@
 
   String trackLabel = track->label();
 
   if (trackLabel.isEmpty())
     trackLabel = String(mediaElement().locale().queryString(
         WebLocalizedString::TextTracksNoLabel));
 
   return trackLabel;
 }
 
-// TextTrack parameter when passed in as a nullptr, creates the "Off" list item in the track list.
+// TextTrack parameter when passed in as a nullptr, creates the "Off" list item
+// in the track list.
 Element* MediaControlTextTrackListElement::createTextTrackListItem(
     TextTrack* track) {
   int trackIndex = track ? track->trackIndex() : trackIndexOffValue;
   HTMLLabelElement* trackItem = HTMLLabelElement::create(document());
   trackItem->setShadowPseudoId(
       AtomicString("-internal-media-controls-text-track-list-item"));
   HTMLInputElement* trackItemInput =
       HTMLInputElement::create(document(), nullptr, false);
   trackItemInput->setShadowPseudoId(
       AtomicString("-internal-media-controls-text-track-list-item-input"));
   trackItemInput->setType(InputTypeNames::checkbox);
   trackItemInput->setIntegralAttribute(trackIndexAttrName(), trackIndex);
   if (!mediaElement().textTracksVisible()) {
     if (!track)
       trackItemInput->setChecked(true);
   } else {
     // If there are multiple text tracks set to showing, they must all have
     // checkmarks displayed.
     if (track && track->mode() == TextTrack::showingKeyword())
       trackItemInput->setChecked(true);
   }
 
   trackItem->appendChild(trackItemInput);
   String trackLabel = getTextTrackLabel(track);
   trackItem->appendChild(Text::create(document(), trackLabel));
-  // Add a track kind marker icon if there are multiple tracks with the same label or if the track has no label.
+  // Add a track kind marker icon if there are multiple tracks with the same
+  // label or if the track has no label.
   if (track && (track->label().isEmpty() || hasDuplicateLabel(track))) {
     HTMLSpanElement* trackKindMarker = HTMLSpanElement::create(document());
     if (track->kind() == track->captionsKeyword()) {
       trackKindMarker->setShadowPseudoId(AtomicString(
           "-internal-media-controls-text-track-list-kind-captions"));
     } else {
       DCHECK_EQ(track->kind(), track->subtitlesKeyword());
       trackKindMarker->setShadowPseudoId(AtomicString(
           "-internal-media-controls-text-track-list-kind-subtitles"));
     }
     trackItem->appendChild(trackKindMarker);
   }
   return trackItem;
 }
 
 void MediaControlTextTrackListElement::refreshTextTrackListMenu() {
   if (!mediaElement().hasClosedCaptions() ||
       !mediaElement().textTracksAreReady())
     return;
 
   EventDispatchForbiddenScope::AllowUserAgentEvents allowEvents;
   removeChildren(OmitSubtreeModifiedEvent);
 
-  // Construct a menu for subtitles and captions
-  // Pass in a nullptr to createTextTrackListItem to create the "Off" track item.
+  // Construct a menu for subtitles and captions.  Pass in a nullptr to
+  // createTextTrackListItem to create the "Off" track item.
   appendChild(createTextTrackListItem(nullptr));
 
   TextTrackList* trackList = mediaElement().textTracks();
   for (unsigned i = 0; i < trackList->length(); i++) {
     TextTrack* track = trackList->anonymousIndexedGetter(i);
     if (!track->canBeRendered())
       continue;
     appendChild(createTextTrackListItem(track));
   }
 }
@@ skipping 446 matching lines @@
 MediaControlCurrentTimeDisplayElement*
 MediaControlCurrentTimeDisplayElement::create(MediaControls& mediaControls) {
   MediaControlCurrentTimeDisplayElement* element =
       new MediaControlCurrentTimeDisplayElement(mediaControls);
   element->setShadowPseudoId(
       AtomicString("-webkit-media-controls-current-time-display"));
   return element;
 }
 
 }  // namespace blink