1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/layout/style/ImageLoader.cpp Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,491 @@
1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this file,
1.6 + * You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +
1.8 +/* A class that handles style system image loads (other image loads are handled
1.9 + * by the nodes in the content tree).
1.10 + */
1.11 +
1.12 +#include "mozilla/css/ImageLoader.h"
1.13 +#include "nsContentUtils.h"
1.14 +#include "nsLayoutUtils.h"
1.15 +#include "nsError.h"
1.16 +#include "nsDisplayList.h"
1.17 +#include "FrameLayerBuilder.h"
1.18 +#include "nsSVGEffects.h"
1.19 +#include "imgIContainer.h"
1.20 +
1.21 +namespace mozilla {
1.22 +namespace css {
1.23 +
1.24 +/* static */ PLDHashOperator
1.25 +ImageLoader::SetAnimationModeEnumerator(nsISupports* aKey, FrameSet* aValue,
1.26 + void* aClosure)
1.27 +{
1.28 + imgIRequest* request = static_cast<imgIRequest*>(aKey);
1.29 +
1.30 + uint16_t* mode = static_cast<uint16_t*>(aClosure);
1.31 +
1.32 +#ifdef DEBUG
1.33 + {
1.34 + nsCOMPtr<imgIRequest> debugRequest = do_QueryInterface(aKey);
1.35 + NS_ASSERTION(debugRequest == request, "This is bad");
1.36 + }
1.37 +#endif
1.38 +
1.39 + nsCOMPtr<imgIContainer> container;
1.40 + request->GetImage(getter_AddRefs(container));
1.41 + if (!container) {
1.42 + return PL_DHASH_NEXT;
1.43 + }
1.44 +
1.45 + // This can fail if the image is in error, and we don't care.
1.46 + container->SetAnimationMode(*mode);
1.47 +
1.48 + return PL_DHASH_NEXT;
1.49 +}
1.50 +
1.51 +static PLDHashOperator
1.52 +ClearImageHashSet(nsPtrHashKey<ImageLoader::Image>* aKey, void* aClosure)
1.53 +{
1.54 + nsIDocument* doc = static_cast<nsIDocument*>(aClosure);
1.55 + ImageLoader::Image* image = aKey->GetKey();
1.56 +
1.57 + imgIRequest* request = image->mRequests.GetWeak(doc);
1.58 + if (request) {
1.59 + request->CancelAndForgetObserver(NS_BINDING_ABORTED);
1.60 + }
1.61 +
1.62 + image->mRequests.Remove(doc);
1.63 +
1.64 + return PL_DHASH_REMOVE;
1.65 +}
1.66 +
1.67 +void
1.68 +ImageLoader::DropDocumentReference()
1.69 +{
1.70 + ClearFrames();
1.71 + mImages.EnumerateEntries(&ClearImageHashSet, mDocument);
1.72 + mDocument = nullptr;
1.73 +}
1.74 +
1.75 +void
1.76 +ImageLoader::AssociateRequestToFrame(imgIRequest* aRequest,
1.77 + nsIFrame* aFrame)
1.78 +{
1.79 + nsCOMPtr<imgINotificationObserver> observer;
1.80 + aRequest->GetNotificationObserver(getter_AddRefs(observer));
1.81 + if (!observer) {
1.82 + // The request has already been canceled, so ignore it. This is ok because
1.83 + // we're not going to get any more notifications from a canceled request.
1.84 + return;
1.85 + }
1.86 +
1.87 + MOZ_ASSERT(observer == this);
1.88 +
1.89 + FrameSet* frameSet = nullptr;
1.90 + if (mRequestToFrameMap.Get(aRequest, &frameSet)) {
1.91 + NS_ASSERTION(frameSet, "This should never be null!");
1.92 + }
1.93 +
1.94 + if (!frameSet) {
1.95 + nsAutoPtr<FrameSet> newFrameSet(new FrameSet());
1.96 +
1.97 + mRequestToFrameMap.Put(aRequest, newFrameSet);
1.98 + frameSet = newFrameSet.forget();
1.99 +
1.100 + nsPresContext* presContext = GetPresContext();
1.101 + if (presContext) {
1.102 + nsLayoutUtils::RegisterImageRequestIfAnimated(presContext,
1.103 + aRequest,
1.104 + nullptr);
1.105 + }
1.106 + }
1.107 +
1.108 + RequestSet* requestSet = nullptr;
1.109 + if (mFrameToRequestMap.Get(aFrame, &requestSet)) {
1.110 + NS_ASSERTION(requestSet, "This should never be null");
1.111 + }
1.112 +
1.113 + if (!requestSet) {
1.114 + nsAutoPtr<RequestSet> newRequestSet(new RequestSet());
1.115 +
1.116 + mFrameToRequestMap.Put(aFrame, newRequestSet);
1.117 + requestSet = newRequestSet.forget();
1.118 + }
1.119 +
1.120 + // Add these to the sets, but only if they're not already there.
1.121 + uint32_t i = frameSet->IndexOfFirstElementGt(aFrame);
1.122 + if (i == 0 || aFrame != frameSet->ElementAt(i-1)) {
1.123 + frameSet->InsertElementAt(i, aFrame);
1.124 + }
1.125 + i = requestSet->IndexOfFirstElementGt(aRequest);
1.126 + if (i == 0 || aRequest != requestSet->ElementAt(i-1)) {
1.127 + requestSet->InsertElementAt(i, aRequest);
1.128 + }
1.129 +}
1.130 +
1.131 +void
1.132 +ImageLoader::MaybeRegisterCSSImage(ImageLoader::Image* aImage)
1.133 +{
1.134 + NS_ASSERTION(aImage, "This should never be null!");
1.135 +
1.136 + bool found = false;
1.137 + aImage->mRequests.GetWeak(mDocument, &found);
1.138 + if (found) {
1.139 + // This document already has a request.
1.140 + return;
1.141 + }
1.142 +
1.143 + imgRequestProxy* canonicalRequest = aImage->mRequests.GetWeak(nullptr);
1.144 + if (!canonicalRequest) {
1.145 + // The image was blocked or something.
1.146 + return;
1.147 + }
1.148 +
1.149 + nsRefPtr<imgRequestProxy> request;
1.150 +
1.151 + // Ignore errors here. If cloning fails for some reason we'll put a null
1.152 + // entry in the hash and we won't keep trying to clone.
1.153 + mInClone = true;
1.154 + canonicalRequest->Clone(this, getter_AddRefs(request));
1.155 + mInClone = false;
1.156 +
1.157 + aImage->mRequests.Put(mDocument, request);
1.158 +
1.159 + AddImage(aImage);
1.160 +}
1.161 +
1.162 +void
1.163 +ImageLoader::DeregisterCSSImage(ImageLoader::Image* aImage)
1.164 +{
1.165 + RemoveImage(aImage);
1.166 +}
1.167 +
1.168 +void
1.169 +ImageLoader::DisassociateRequestFromFrame(imgIRequest* aRequest,
1.170 + nsIFrame* aFrame)
1.171 +{
1.172 + FrameSet* frameSet = nullptr;
1.173 + RequestSet* requestSet = nullptr;
1.174 +
1.175 +#ifdef DEBUG
1.176 + {
1.177 + nsCOMPtr<imgINotificationObserver> observer;
1.178 + aRequest->GetNotificationObserver(getter_AddRefs(observer));
1.179 + MOZ_ASSERT(!observer || observer == this);
1.180 + }
1.181 +#endif
1.182 +
1.183 + mRequestToFrameMap.Get(aRequest, &frameSet);
1.184 + mFrameToRequestMap.Get(aFrame, &requestSet);
1.185 +
1.186 + if (frameSet) {
1.187 + frameSet->RemoveElementSorted(aFrame);
1.188 + }
1.189 + if (requestSet) {
1.190 + requestSet->RemoveElementSorted(aRequest);
1.191 + }
1.192 +
1.193 + if (frameSet && !frameSet->Length()) {
1.194 + mRequestToFrameMap.Remove(aRequest);
1.195 +
1.196 + nsPresContext* presContext = GetPresContext();
1.197 + if (presContext) {
1.198 + nsLayoutUtils::DeregisterImageRequest(presContext,
1.199 + aRequest,
1.200 + nullptr);
1.201 + }
1.202 + }
1.203 +
1.204 + if (requestSet && !requestSet->Length()) {
1.205 + mFrameToRequestMap.Remove(aFrame);
1.206 + }
1.207 +}
1.208 +
1.209 +void
1.210 +ImageLoader::DropRequestsForFrame(nsIFrame* aFrame)
1.211 +{
1.212 + RequestSet* requestSet = nullptr;
1.213 + if (!mFrameToRequestMap.Get(aFrame, &requestSet)) {
1.214 + return;
1.215 + }
1.216 +
1.217 + NS_ASSERTION(requestSet, "This should never be null");
1.218 +
1.219 + RequestSet frozenRequestSet(*requestSet);
1.220 + for (RequestSet::size_type i = frozenRequestSet.Length(); i != 0; --i) {
1.221 + imgIRequest* request = frozenRequestSet.ElementAt(i - 1);
1.222 +
1.223 + DisassociateRequestFromFrame(request, aFrame);
1.224 + }
1.225 +}
1.226 +
1.227 +void
1.228 +ImageLoader::SetAnimationMode(uint16_t aMode)
1.229 +{
1.230 + NS_ASSERTION(aMode == imgIContainer::kNormalAnimMode ||
1.231 + aMode == imgIContainer::kDontAnimMode ||
1.232 + aMode == imgIContainer::kLoopOnceAnimMode,
1.233 + "Wrong Animation Mode is being set!");
1.234 +
1.235 + mRequestToFrameMap.EnumerateRead(SetAnimationModeEnumerator, &aMode);
1.236 +}
1.237 +
1.238 +void
1.239 +ImageLoader::ClearFrames()
1.240 +{
1.241 + mRequestToFrameMap.Clear();
1.242 + mFrameToRequestMap.Clear();
1.243 +}
1.244 +
1.245 +void
1.246 +ImageLoader::LoadImage(nsIURI* aURI, nsIPrincipal* aOriginPrincipal,
1.247 + nsIURI* aReferrer, ImageLoader::Image* aImage)
1.248 +{
1.249 + NS_ASSERTION(aImage->mRequests.Count() == 0, "Huh?");
1.250 +
1.251 + aImage->mRequests.Put(nullptr, nullptr);
1.252 +
1.253 + if (!aURI) {
1.254 + return;
1.255 + }
1.256 +
1.257 + if (!nsContentUtils::CanLoadImage(aURI, mDocument, mDocument,
1.258 + aOriginPrincipal)) {
1.259 + return;
1.260 + }
1.261 +
1.262 + nsRefPtr<imgRequestProxy> request;
1.263 + nsContentUtils::LoadImage(aURI, mDocument, aOriginPrincipal, aReferrer,
1.264 + nullptr, nsIRequest::LOAD_NORMAL,
1.265 + NS_LITERAL_STRING("css"),
1.266 + getter_AddRefs(request));
1.267 +
1.268 + if (!request) {
1.269 + return;
1.270 + }
1.271 +
1.272 + nsRefPtr<imgRequestProxy> clonedRequest;
1.273 + mInClone = true;
1.274 + nsresult rv = request->Clone(this, getter_AddRefs(clonedRequest));
1.275 + mInClone = false;
1.276 +
1.277 + if (NS_FAILED(rv)) {
1.278 + return;
1.279 + }
1.280 +
1.281 + aImage->mRequests.Put(nullptr, request);
1.282 + aImage->mRequests.Put(mDocument, clonedRequest);
1.283 +
1.284 + AddImage(aImage);
1.285 +}
1.286 +
1.287 +void
1.288 +ImageLoader::AddImage(ImageLoader::Image* aImage)
1.289 +{
1.290 + NS_ASSERTION(!mImages.Contains(aImage), "Huh?");
1.291 + if (!mImages.PutEntry(aImage)) {
1.292 + NS_RUNTIMEABORT("OOM");
1.293 + }
1.294 +}
1.295 +
1.296 +void
1.297 +ImageLoader::RemoveImage(ImageLoader::Image* aImage)
1.298 +{
1.299 + NS_ASSERTION(mImages.Contains(aImage), "Huh?");
1.300 + mImages.RemoveEntry(aImage);
1.301 +}
1.302 +
1.303 +nsPresContext*
1.304 +ImageLoader::GetPresContext()
1.305 +{
1.306 + if (!mDocument) {
1.307 + return nullptr;
1.308 + }
1.309 +
1.310 + nsIPresShell* shell = mDocument->GetShell();
1.311 + if (!shell) {
1.312 + return nullptr;
1.313 + }
1.314 +
1.315 + return shell->GetPresContext();
1.316 +}
1.317 +
1.318 +void InvalidateImagesCallback(nsIFrame* aFrame,
1.319 + FrameLayerBuilder::DisplayItemData* aItem)
1.320 +{
1.321 + nsDisplayItem::Type type = nsDisplayItem::GetDisplayItemTypeFromKey(aItem->GetDisplayItemKey());
1.322 + uint8_t flags = nsDisplayItem::GetDisplayItemFlagsForType(type);
1.323 +
1.324 + if (flags & nsDisplayItem::TYPE_RENDERS_NO_IMAGES) {
1.325 + return;
1.326 + }
1.327 +
1.328 + aItem->Invalidate();
1.329 +
1.330 + // Update ancestor rendering observers (-moz-element etc)
1.331 + nsIFrame *f = aFrame;
1.332 + while (f && !f->HasAnyStateBits(NS_FRAME_DESCENDANT_NEEDS_PAINT)) {
1.333 + nsSVGEffects::InvalidateDirectRenderingObservers(f);
1.334 + f = nsLayoutUtils::GetCrossDocParentFrame(f);
1.335 + }
1.336 +}
1.337 +
1.338 +void
1.339 +ImageLoader::DoRedraw(FrameSet* aFrameSet)
1.340 +{
1.341 + NS_ASSERTION(aFrameSet, "Must have a frame set");
1.342 + NS_ASSERTION(mDocument, "Should have returned earlier!");
1.343 +
1.344 + FrameSet::size_type length = aFrameSet->Length();
1.345 + for (FrameSet::size_type i = 0; i < length; i++) {
1.346 + nsIFrame* frame = aFrameSet->ElementAt(i);
1.347 +
1.348 + if (frame->StyleVisibility()->IsVisible()) {
1.349 + if (frame->IsFrameOfType(nsIFrame::eTablePart)) {
1.350 + // Tables don't necessarily build border/background display items
1.351 + // for the individual table part frames, so IterateRetainedDataFor
1.352 + // might not find the right display item.
1.353 + frame->InvalidateFrame();
1.354 + } else {
1.355 + FrameLayerBuilder::IterateRetainedDataFor(frame, InvalidateImagesCallback);
1.356 + frame->SchedulePaint();
1.357 + }
1.358 + }
1.359 + }
1.360 +}
1.361 +
1.362 +NS_IMPL_ADDREF(ImageLoader)
1.363 +NS_IMPL_RELEASE(ImageLoader)
1.364 +
1.365 +NS_INTERFACE_MAP_BEGIN(ImageLoader)
1.366 + NS_INTERFACE_MAP_ENTRY(imgINotificationObserver)
1.367 + NS_INTERFACE_MAP_ENTRY(imgIOnloadBlocker)
1.368 +NS_INTERFACE_MAP_END
1.369 +
1.370 +NS_IMETHODIMP
1.371 +ImageLoader::Notify(imgIRequest *aRequest, int32_t aType, const nsIntRect* aData)
1.372 +{
1.373 + if (aType == imgINotificationObserver::SIZE_AVAILABLE) {
1.374 + nsCOMPtr<imgIContainer> image;
1.375 + aRequest->GetImage(getter_AddRefs(image));
1.376 + return OnStartContainer(aRequest, image);
1.377 + }
1.378 +
1.379 + if (aType == imgINotificationObserver::IS_ANIMATED) {
1.380 + return OnImageIsAnimated(aRequest);
1.381 + }
1.382 +
1.383 + if (aType == imgINotificationObserver::LOAD_COMPLETE) {
1.384 + return OnStopFrame(aRequest);
1.385 + }
1.386 +
1.387 + if (aType == imgINotificationObserver::FRAME_UPDATE) {
1.388 + return FrameChanged(aRequest);
1.389 + }
1.390 +
1.391 + return NS_OK;
1.392 +}
1.393 +
1.394 +nsresult
1.395 +ImageLoader::OnStartContainer(imgIRequest* aRequest, imgIContainer* aImage)
1.396 +{
1.397 + nsPresContext* presContext = GetPresContext();
1.398 + if (!presContext) {
1.399 + return NS_OK;
1.400 + }
1.401 +
1.402 + aImage->SetAnimationMode(presContext->ImageAnimationMode());
1.403 +
1.404 + return NS_OK;
1.405 +}
1.406 +
1.407 +nsresult
1.408 +ImageLoader::OnImageIsAnimated(imgIRequest* aRequest)
1.409 +{
1.410 + if (!mDocument) {
1.411 + return NS_OK;
1.412 + }
1.413 +
1.414 + FrameSet* frameSet = nullptr;
1.415 + if (!mRequestToFrameMap.Get(aRequest, &frameSet)) {
1.416 + return NS_OK;
1.417 + }
1.418 +
1.419 + // Register with the refresh driver now that we are aware that
1.420 + // we are animated.
1.421 + nsPresContext* presContext = GetPresContext();
1.422 + if (presContext) {
1.423 + nsLayoutUtils::RegisterImageRequest(presContext,
1.424 + aRequest,
1.425 + nullptr);
1.426 + }
1.427 +
1.428 + return NS_OK;
1.429 +}
1.430 +
1.431 +nsresult
1.432 +ImageLoader::OnStopFrame(imgIRequest *aRequest)
1.433 +{
1.434 + if (!mDocument || mInClone) {
1.435 + return NS_OK;
1.436 + }
1.437 +
1.438 + FrameSet* frameSet = nullptr;
1.439 + if (!mRequestToFrameMap.Get(aRequest, &frameSet)) {
1.440 + return NS_OK;
1.441 + }
1.442 +
1.443 + NS_ASSERTION(frameSet, "This should never be null!");
1.444 +
1.445 + DoRedraw(frameSet);
1.446 +
1.447 + return NS_OK;
1.448 +}
1.449 +
1.450 +nsresult
1.451 +ImageLoader::FrameChanged(imgIRequest *aRequest)
1.452 +{
1.453 + if (!mDocument || mInClone) {
1.454 + return NS_OK;
1.455 + }
1.456 +
1.457 + FrameSet* frameSet = nullptr;
1.458 + if (!mRequestToFrameMap.Get(aRequest, &frameSet)) {
1.459 + return NS_OK;
1.460 + }
1.461 +
1.462 + NS_ASSERTION(frameSet, "This should never be null!");
1.463 +
1.464 + DoRedraw(frameSet);
1.465 +
1.466 + return NS_OK;
1.467 +}
1.468 +
1.469 +NS_IMETHODIMP
1.470 +ImageLoader::BlockOnload(imgIRequest* aRequest)
1.471 +{
1.472 + if (!mDocument) {
1.473 + return NS_OK;
1.474 + }
1.475 +
1.476 + mDocument->BlockOnload();
1.477 +
1.478 + return NS_OK;
1.479 +}
1.480 +
1.481 +NS_IMETHODIMP
1.482 +ImageLoader::UnblockOnload(imgIRequest* aRequest)
1.483 +{
1.484 + if (!mDocument) {
1.485 + return NS_OK;
1.486 + }
1.487 +
1.488 + mDocument->UnblockOnload(false);
1.489 +
1.490 + return NS_OK;
1.491 +}
1.492 +
1.493 +} // namespace css
1.494 +} // namespace mozilla
