Reflow comments in core/loader

third_party/WebKit/Source/core/loader/ImageLoader.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
- * Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010 Apple Inc. All rights reserved.
+ * Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010 Apple Inc. All rights
+ * reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Library General Public License for more details.
@@ skipping 165 matching lines @@
 }
 
 DEFINE_TRACE(ImageLoader) {
   visitor->trace(m_image);
   visitor->trace(m_element);
 }
 
 void ImageLoader::setImage(ImageResource* newImage) {
   setImageWithoutConsideringPendingLoadEvent(newImage);
 
-  // Only consider updating the protection ref-count of the Element immediately before returning
-  // from this function as doing so might result in the destruction of this ImageLoader.
+  // Only consider updating the protection ref-count of the Element immediately
+  // before returning from this function as doing so might result in the
+  // destruction of this ImageLoader.
   updatedHasPendingEvent();
 }
 
 void ImageLoader::setImageWithoutConsideringPendingLoadEvent(
     ImageResource* newImage) {
   DCHECK(m_failedLoadURL.isEmpty());
   ImageResource* oldImage = m_image.get();
   if (newImage != oldImage) {
     m_image = newImage;
     if (m_hasPendingLoadEvent) {
@@ skipping 60 matching lines @@
   m_loadDelayCounter =
       IncrementLoadEventDelayCount::create(m_element->document());
 }
 
 void ImageLoader::doUpdateFromElement(BypassMainWorldBehavior bypassBehavior,
                                       UpdateFromElementBehavior updateBehavior,
                                       const KURL& url,
                                       ReferrerPolicy referrerPolicy) {
   // FIXME: According to
   // http://www.whatwg.org/specs/web-apps/current-work/multipage/embedded-content.html#the-img-element:the-img-element-55
-  // When "update image" is called due to environment changes and the load fails, onerror should not be called.
-  // That is currently not the case.
+  // When "update image" is called due to environment changes and the load
+  // fails, onerror should not be called. That is currently not the case.
   //
   // We don't need to call clearLoader here: Either we were called from the
   // task, or our caller updateFromElement cleared the task's loader (and set
   // m_pendingTask to null).
   m_pendingTask.reset();
   // Make sure to only decrement the count when we exit this function
   std::unique_ptr<IncrementLoadEventDelayCount> loadDelayCounter;
   loadDelayCounter.swap(m_loadDelayCounter);
 
   Document& document = m_element->document();
   if (!document.isActive())
     return;
 
   AtomicString imageSourceURL = m_element->imageSourceURL();
   ImageResource* newImage = nullptr;
   if (!url.isNull()) {
-    // Unlike raw <img>, we block mixed content inside of <picture> or <img srcset>.
+    // Unlike raw <img>, we block mixed content inside of <picture> or
+    // <img srcset>.
     ResourceLoaderOptions resourceLoaderOptions =
         ResourceFetcher::defaultResourceOptions();
     ResourceRequest resourceRequest(url);
     if (updateBehavior == UpdateForcedReload) {
       resourceRequest.setCachePolicy(WebCachePolicy::BypassingCache);
       resourceRequest.setLoFiState(WebURLRequest::LoFiOff);
     }
 
     if (referrerPolicy != ReferrerPolicyDefault)
       resourceRequest.setHTTPReferrer(SecurityPolicy::generateReferrer(
@@ skipping 26 matching lines @@
   ImageResource* oldImage = m_image.get();
   if (updateBehavior == UpdateSizeChanged && m_element->layoutObject() &&
       m_element->layoutObject()->isImage() && newImage == oldImage) {
     toLayoutImage(m_element->layoutObject())->intrinsicSizeChanged();
   } else {
     if (m_hasPendingLoadEvent) {
       loadEventSender().cancelEvent(this);
       m_hasPendingLoadEvent = false;
     }
 
-    // Cancel error events that belong to the previous load, which is now cancelled by changing the src attribute.
-    // If newImage is null and m_hasPendingErrorEvent is true, we know the error event has been just posted by
-    // this load and we should not cancel the event.
-    // FIXME: If both previous load and this one got blocked with an error, we can receive one error event instead of two.
+    // Cancel error events that belong to the previous load, which is now
+    // cancelled by changing the src attribute. If newImage is null and
+    // m_hasPendingErrorEvent is true, we know the error event has been just
+    // posted by this load and we should not cancel the event.
+    // FIXME: If both previous load and this one got blocked with an error, we
+    // can receive one error event instead of two.
     if (m_hasPendingErrorEvent && newImage) {
       errorEventSender().cancelEvent(this);
       m_hasPendingErrorEvent = false;
     }
 
     m_image = newImage;
     m_hasPendingLoadEvent = newImage;
     m_imageComplete = !newImage;
 
     updateLayoutObject();
-    // If newImage exists and is cached, addObserver() will result in the load event
-    // being queued to fire. Ensure this happens after beforeload is dispatched.
+    // If newImage exists and is cached, addObserver() will result in the load
+    // event being queued to fire. Ensure this happens after beforeload is
+    // dispatched.
     if (newImage) {
       newImage->addObserver(this);
     }
     if (oldImage) {
       oldImage->removeObserver(this);
     }
   }
 
   if (LayoutImageResource* imageResource = layoutImageResource())
     imageResource->resetAnimation();
 
-  // Only consider updating the protection ref-count of the Element immediately before returning
-  // from this function as doing so might result in the destruction of this ImageLoader.
+  // Only consider updating the protection ref-count of the Element immediately
+  // before returning from this function as doing so might result in the
+  // destruction of this ImageLoader.
   updatedHasPendingEvent();
 }
 
 void ImageLoader::updateFromElement(UpdateFromElementBehavior updateBehavior,
                                     ReferrerPolicy referrerPolicy) {
   AtomicString imageSourceURL = m_element->imageSourceURL();
   m_suppressErrorEvents = (updateBehavior == UpdateSizeChanged);
 
   if (updateBehavior == UpdateIgnorePreviousError)
     clearFailedLoadURL();
 
   if (!m_failedLoadURL.isEmpty() && imageSourceURL == m_failedLoadURL)
     return;
 
-  // Prevent the creation of a ResourceLoader (and therefore a network
-  // request) for ImageDocument loads. In this case, the image contents have already
-  // been requested as a main resource and ImageDocumentParser will take care of
-  // funneling the main resource bytes into m_image, so just create an ImageResource
-  // to be populated later.
+  // Prevent the creation of a ResourceLoader (and therefore a network request)
+  // for ImageDocument loads. In this case, the image contents have already been
+  // requested as a main resource and ImageDocumentParser will take care of
+  // funneling the main resource bytes into m_image, so just create an
+  // ImageResource to be populated later.
   if (m_loadingImageDocument && updateBehavior != UpdateForcedReload) {
     setImage(
         ImageResource::create(imageSourceToKURL(m_element->imageSourceURL())));
     m_image->setStatus(Resource::Pending);
     return;
   }
 
-  // If we have a pending task, we have to clear it -- either we're
-  // now loading immediately, or we need to reset the task's state.
+  // If we have a pending task, we have to clear it -- either we're now loading
+  // immediately, or we need to reset the task's state.
   if (m_pendingTask) {
     m_pendingTask->clearLoader();
     m_pendingTask.reset();
   }
 
   KURL url = imageSourceToKURL(imageSourceURL);
   if (shouldLoadImmediately(url)) {
     doUpdateFromElement(DoNotBypassMainWorldCSP, updateBehavior, url,
                         referrerPolicy);
     return;
   }
-  // Allow the idiom "img.src=''; img.src='.." to clear down the image before
-  // an asynchronous load completes.
+  // Allow the idiom "img.src=''; img.src='.." to clear down the image before an
+  // asynchronous load completes.
   if (imageSourceURL.isEmpty()) {
     ImageResource* image = m_image.get();
     if (image) {
       image->removeObserver(this);
     }
     m_image = nullptr;
   }
 
   // Don't load images for inactive documents. We don't want to slow down the
   // raw HTML parsing case by loading images we don't intend to display.
@@ skipping 16 matching lines @@
   if (!imageSourceURL.isNull()) {
     String strippedImageSourceURL =
         stripLeadingAndTrailingHTMLSpaces(imageSourceURL);
     if (!strippedImageSourceURL.isEmpty())
       url = document.completeURL(strippedImageSourceURL);
   }
   return url;
 }
 
 bool ImageLoader::shouldLoadImmediately(const KURL& url) const {
-  // We force any image loads which might require alt content through the asynchronous path so that we can add the shadow DOM
-  // for the alt-text content when style recalc is over and DOM mutation is allowed again.
+  // We force any image loads which might require alt content through the
+  // asynchronous path so that we can add the shadow DOM for the alt-text
+  // content when style recalc is over and DOM mutation is allowed again.
   if (!url.isNull()) {
     Resource* resource = memoryCache()->resourceForURL(
         url, m_element->document().fetcher()->getCacheIdentifier());
     if (resource && !resource->errorOccurred())
       return true;
   }
   return (isHTMLObjectElement(m_element) || isHTMLEmbedElement(m_element) ||
           url.protocolIsData());
 }
 
@@ skipping 20 matching lines @@
     return;
 
   if (resource->errorOccurred()) {
     loadEventSender().cancelEvent(this);
     m_hasPendingLoadEvent = false;
 
     if (resource->resourceError().isAccessCheck())
       crossSiteOrCSPViolationOccurred(
           AtomicString(resource->resourceError().failingURL()));
 
-    // The error event should not fire if the image data update is a result of environment change.
+    // The error event should not fire if the image data update is a result of
+    // environment change.
     // https://html.spec.whatwg.org/multipage/embedded-content.html#the-img-element:the-img-element-55
     if (!m_suppressErrorEvents)
       dispatchErrorEvent();
 
-    // Only consider updating the protection ref-count of the Element immediately before returning
-    // from this function as doing so might result in the destruction of this ImageLoader.
+    // Only consider updating the protection ref-count of the Element
+    // immediately before returning from this function as doing so might result
+    // in the destruction of this ImageLoader.
     updatedHasPendingEvent();
     return;
   }
   if (resource->wasCanceled()) {
     m_hasPendingLoadEvent = false;
-    // Only consider updating the protection ref-count of the Element immediately before returning
-    // from this function as doing so might result in the destruction of this ImageLoader.
+    // Only consider updating the protection ref-count of the Element
+    // immediately before returning

[yhirano, 2016/10/03 08:37:34]

Why don't you put more words on this line?

[Charlie Harrison, 2016/10/03 12:30:05]

Good catch, I must have missed this comment. Done.

+    // from this function as doing so might result in the destruction of this
+    // ImageLoader.
     updatedHasPendingEvent();
     return;
   }
   loadEventSender().dispatchEventSoon(this);
 }
 
 LayoutImageResource* ImageLoader::layoutImageResource() {
   LayoutObject* layoutObject = m_element->layoutObject();
 
   if (!layoutObject)
     return 0;
 
-  // We don't return style generated image because it doesn't belong to the ImageLoader.
-  // See <https://bugs.webkit.org/show_bug.cgi?id=42840>
+  // We don't return style generated image because it doesn't belong to the
+  // ImageLoader. See <https://bugs.webkit.org/show_bug.cgi?id=42840>
   if (layoutObject->isImage() &&
       !static_cast<LayoutImage*>(layoutObject)->isGeneratedContent())
     return toLayoutImage(layoutObject)->imageResource();
 
   if (layoutObject->isSVGImage())
     return toLayoutSVGImage(layoutObject)->imageResource();
 
   if (layoutObject->isVideo())
     return toLayoutVideo(layoutObject)->imageResource();
 
   return 0;
 }
 
 void ImageLoader::updateLayoutObject() {
   LayoutImageResource* imageResource = layoutImageResource();
 
   if (!imageResource)
     return;
 
   // Only update the layoutObject if it doesn't have an image or if what we have
   // is a complete image.  This prevents flickering in the case where a dynamic
   // change is happening between two images.
   ImageResource* cachedImage = imageResource->cachedImage();
   if (m_image != cachedImage && (m_imageComplete || !cachedImage))
     imageResource->setImageResource(m_image.get());
 }
 
 void ImageLoader::updatedHasPendingEvent() {
-  // If an Element that does image loading is removed from the DOM the load/error event for the image is still observable.
-  // As long as the ImageLoader is actively loading, the Element itself needs to be ref'ed to keep it from being
-  // destroyed by DOM manipulation or garbage collection.
-  // If such an Element wishes for the load to stop when removed from the DOM it needs to stop the ImageLoader explicitly.
+  // If an Element that does image loading is removed from the DOM the
+  // load/error event for the image is still observable. As long as the
+  // ImageLoader is actively loading, the Element itself needs to be ref'ed to
+  // keep it from being destroyed by DOM manipulation or garbage collection. If
+  // such an Element wishes for the load to stop when removed from the DOM it
+  // needs to stop the ImageLoader explicitly.
   bool wasProtected = m_elementIsProtected;
   m_elementIsProtected = m_hasPendingLoadEvent || m_hasPendingErrorEvent;
   if (wasProtected == m_elementIsProtected)
     return;
 
   if (m_elementIsProtected) {
     if (m_derefElementTimer.isActive())
       m_derefElementTimer.stop();
     else
       m_keepAlive = m_element;
@@ skipping 20 matching lines @@
 
 void ImageLoader::dispatchPendingLoadEvent() {
   if (!m_hasPendingLoadEvent)
     return;
   if (!m_image)
     return;
   m_hasPendingLoadEvent = false;
   if (element()->document().frame())
     dispatchLoadEvent();
 
-  // Only consider updating the protection ref-count of the Element immediately before returning
-  // from this function as doing so might result in the destruction of this ImageLoader.
+  // Only consider updating the protection ref-count of the Element immediately
+  // before returning from this function as doing so might result in the
+  // destruction of this ImageLoader.
   updatedHasPendingEvent();
 }
 
 void ImageLoader::dispatchPendingErrorEvent() {
   if (!m_hasPendingErrorEvent)
     return;
   m_hasPendingErrorEvent = false;
 
   if (element()->document().frame())
     element()->dispatchEvent(Event::create(EventTypeNames::error));
 
-  // Only consider updating the protection ref-count of the Element immediately before returning
-  // from this function as doing so might result in the destruction of this ImageLoader.
+  // Only consider updating the protection ref-count of the Element immediately
+  // before returning from this function as doing so might result in the
+  // destruction of this ImageLoader.
   updatedHasPendingEvent();
 }
 
 bool ImageLoader::getImageAnimationPolicy(ImageAnimationPolicy& policy) {
   if (!element()->document().settings())
     return false;
 
   policy = element()->document().settings()->imageAnimationPolicy();
   return true;
 }
 
 void ImageLoader::dispatchPendingLoadEvents() {
   loadEventSender().dispatchPendingEvents();
 }
 
 void ImageLoader::dispatchPendingErrorEvents() {
   errorEventSender().dispatchPendingEvents();
 }
 
 void ImageLoader::elementDidMoveToNewDocument() {
   if (m_loadDelayCounter)
     m_loadDelayCounter->documentChanged(m_element->document());
   clearFailedLoadURL();
   setImage(0);
 }
 
 }  // namespace blink