gecko/image/src/ImageFactory.h
Seth Fowler 0d47a4402b Bug 967985 - Don't retarget OnDataAvailable when not storing source data. r=tn
--HG--
extra : rebase_source : d3048bf3d949650f01ae97786cb5ca2d54aa3087
2014-04-02 19:20:25 -07:00

88 lines
3.3 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef MOZILLA_IMAGELIB_IMAGEFACTORY_H_
#define MOZILLA_IMAGELIB_IMAGEFACTORY_H_
#include "nsCOMPtr.h"
#include "nsProxyRelease.h"
class nsCString;
class nsIRequest;
class imgStatusTracker;
namespace mozilla {
namespace image {
class Image;
class ImageURL;
class ImageFactory
{
public:
/**
* Registers vars with Preferences. Should only be called on the main thread.
*/
static void Initialize();
/**
* Determines whether it's safe to retarget OnDataAvailable for an image.
*
* @param aURI The URI of the image.
* @param aIsMultipart Whether the image is part of a multipart request.
*/
static bool CanRetargetOnDataAvailable(ImageURL* aURI, bool aIsMultiPart);
/**
* Creates a new image with the given properties.
* Can be called on or off the main thread.
*
* @param aRequest The associated request.
* @param aStatusTracker A status tracker for the image to use.
* @param aMimeType The mimetype of the image.
* @param aURI The URI of the image.
* @param aIsMultiPart Whether the image is part of a multipart request.
* @param aInnerWindowId The window this image belongs to.
*/
static already_AddRefed<Image> CreateImage(nsIRequest* aRequest,
imgStatusTracker* aStatusTracker,
const nsCString& aMimeType,
ImageURL* aURI,
bool aIsMultiPart,
uint32_t aInnerWindowId);
/**
* Creates a new image which isn't associated with a URI or loaded through
* the usual image loading mechanism.
*
* @param aMimeType The mimetype of the image.
*/
static already_AddRefed<Image> CreateAnonymousImage(const nsCString& aMimeType);
private:
// Factory functions that create specific types of image containers.
static already_AddRefed<Image> CreateRasterImage(nsIRequest* aRequest,
imgStatusTracker* aStatusTracker,
const nsCString& aMimeType,
ImageURL* aURI,
uint32_t aImageFlags,
uint32_t aInnerWindowId);
static already_AddRefed<Image> CreateVectorImage(nsIRequest* aRequest,
imgStatusTracker* aStatusTracker,
const nsCString& aMimeType,
ImageURL* aURI,
uint32_t aImageFlags,
uint32_t aInnerWindowId);
// This is a static factory class, so disallow instantiation.
virtual ~ImageFactory() = 0;
};
} // namespace image
} // namespace mozilla
#endif // MOZILLA_IMAGELIB_IMAGEFACTORY_H_