image/ImageFactory.h
author Mike Hommey <mh+mozilla@glandium.org>
Tue, 26 Mar 2019 16:29:17 +0000
changeset 466239 12b301ea0f924424f0a5057f1ebccc7cd8098e8e
parent 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1537641 - Make MIDL use clang-cl as a preprocessor. r=dmajor Using clang-cl as a preprocessor fails with: ``` In file included from z:\build\build\src\accessible\ipc\win\handler\HandlerData.idl:8: z:\build\build\src\accessible\ipc\win\handler/AccessibleHandler.h(27,8): error: pasting formed 'Accessible2_3.', an invalid preprocessing token [-Winvalid-token-paste] import NEWEST_IA2_IDL; ^ z:\build\build\src\accessible\ipc\win\handler/AccessibleHandler.h(15,24): note: expanded from macro 'NEWEST_IA2_IDL' ^ z:\build\build\src\accessible\ipc\win\handler/AccessibleHandler.h(14,22): note: expanded from macro 'IDLFOR' ^ z:\build\build\src\accessible\ipc\win\handler/AccessibleHandler.h(13,36): note: expanded from macro '__GENIDL' ^ 1 error generated. midl : command line error MIDL1003 : error returned by the C preprocessor (1) ``` There's only one place using the NEWEST_IA2_IDL and accompanying macros, we can just avoid the issue altogether by expanding it manually (and it's not like the macro buys much, the other arm of the __midl ifdef has a #include "Accessible2_3.h" that doesn't use the macro either, presumably for the same reason). Differential Revision: https://phabricator.services.mozilla.com/D24868

/* -*- 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_image_ImageFactory_h
#define mozilla_image_ImageFactory_h

#include "nsCOMPtr.h"
#include "nsProxyRelease.h"
#include "nsStringFwd.h"

class nsIRequest;
class nsIURI;

namespace mozilla {
namespace image {

class Image;
class MultipartImage;
class ProgressTracker;

class ImageFactory {
 public:
  /**
   * Registers vars with Preferences. Should only be called on the main thread.
   */
  static void Initialize();

  /**
   * Creates a new image with the given properties.
   * Can be called on or off the main thread.
   *
   * @param aRequest         The associated request.
   * @param aProgressTracker 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,
                                             ProgressTracker* aProgressTracker,
                                             const nsCString& aMimeType,
                                             nsIURI* 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.
   * @param aSizeHint      The length of the source data for the image.
   */
  static already_AddRefed<Image> CreateAnonymousImage(
      const nsCString& aMimeType, uint32_t aSizeHint = 0);

  /**
   * Creates a new multipart/x-mixed-replace image wrapper, and initializes it
   * with the first part. Subsequent parts should be passed to the existing
   * MultipartImage via MultipartImage::BeginTransitionToPart().
   *
   * @param aFirstPart       An image containing the first part of the multipart
   *                         stream.
   * @param aProgressTracker A progress tracker for the multipart image.
   */
  static already_AddRefed<MultipartImage> CreateMultipartImage(
      Image* aFirstPart, ProgressTracker* aProgressTracker);

 private:
  // Factory functions that create specific types of image containers.
  static already_AddRefed<Image> CreateRasterImage(
      nsIRequest* aRequest, ProgressTracker* aProgressTracker,
      const nsCString& aMimeType, nsIURI* aURI, uint32_t aImageFlags,
      uint32_t aInnerWindowId);

  static already_AddRefed<Image> CreateVectorImage(
      nsIRequest* aRequest, ProgressTracker* aProgressTracker,
      const nsCString& aMimeType, nsIURI* 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_image_ImageFactory_h