image/imgIRequest.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8 #include "nsIRequest.idl"
   9 #include "imgIContainer.idl"
  10
  11 //interface imgIContainer;
  12 interface imgINotificationObserver;
  13 interface nsIURI;
  14 interface nsIPrincipal;
  15
  16 /**
  17  * imgIRequest interface
  18  *
  19  * @author Stuart Parmenter <stuart@mozilla.com>
  20  * @version 0.1
  21  * @see imagelib2
  22  */
  23 [scriptable, builtinclass, uuid(db0a945c-3883-424a-98d0-2ee0523b0255)]
  24 interface imgIRequest : nsIRequest
  25 {
  26   /**
  27    * the image container...
  28    * @return the image object associated with the request.
  29    * @attention NEED DOCS
  30    */
  31   readonly attribute imgIContainer image;
  32
  33   /**
  34    * Producer ID for image containers created by this image.
  35    */
  36   [infallible] readonly attribute unsigned long producerId;
  37
  38   /**
  39    * Bits set in the return value from imageStatus
  40    * @name statusflags
  41    *
  42    * Meanings:
  43    *
  44    * STATUS_NONE: Nothing to report.
  45    *
  46    * STATUS_SIZE_AVAILABLE: We received enough image data
  47    * from the network or filesystem that we know the width
  48    * and height of the image, and have thus called SetSize()
  49    * on the container.
  50    *
  51    * STATUS_LOAD_COMPLETE: The data has been fully loaded
  52    * to memory, but not necessarily fully decoded.
  53    *
  54    * STATUS_ERROR: An error occurred loading the image.
  55    *
  56    * STATUS_FRAME_COMPLETE: The first frame has been
  57    * completely decoded.
  58    *
  59    * STATUS_DECODE_COMPLETE: The whole image has been decoded.
  60    *
  61    * STATUS_IS_ANIMATED: The image is animated.
  62    *
  63    * STATUS_HAS_TRANSPARENCY: The image is partially or completely transparent.
  64    */
  65   //@{
  66   const long STATUS_NONE             = 0x0;
  67   const long STATUS_SIZE_AVAILABLE   = 0x1;
  68   const long STATUS_LOAD_COMPLETE    = 0x2;
  69   const long STATUS_ERROR            = 0x4;
  70   const long STATUS_FRAME_COMPLETE   = 0x8;
  71   const long STATUS_DECODE_COMPLETE  = 0x10;
  72   const long STATUS_IS_ANIMATED      = 0x20;
  73   const long STATUS_HAS_TRANSPARENCY = 0x40;
  74   //@}
  75
  76   /**
  77    * Status flags of the STATUS_* variety.
  78    */
  79   readonly attribute unsigned long imageStatus;
  80
  81   /*
  82    * Actual error code that generated a STATUS_ERROR imageStatus
  83    * (see xpcom/base/ErrorList.h)
  84    */
  85   [noscript] readonly attribute nsresult imageErrorCode;
  86
  87   /**
  88    * The URI the image load was started with.  Note that this might not be the
  89    * actual URI for the image (e.g. if HTTP redirects happened during the
  90    * load).
  91    */
  92   readonly attribute nsIURI URI;
  93
  94   /**
  95    * The URI of the resource we ended up loading after all redirects, etc.
  96    */
  97   readonly attribute nsIURI finalURI;
  98
  99   readonly attribute imgINotificationObserver notificationObserver;
 100
 101   readonly attribute string mimeType;
 102
 103   /**
 104    * Clone this request; the returned request will have aObserver as the
 105    * observer.  aObserver will be notified synchronously (before the clone()
 106    * call returns) with all the notifications that have already been dispatched
 107    * for this image load.
 108    */
 109   imgIRequest clone(in imgINotificationObserver aObserver);
 110
 111   /**
 112    * The principal gotten from the channel the image was loaded from.
 113    */
 114   readonly attribute nsIPrincipal imagePrincipal;
 115
 116   /**
 117    * true if the loading of the image required cross-origin redirects.
 118    */
 119   readonly attribute bool hadCrossOriginRedirects;
 120
 121   /**
 122    * Whether the request is multipart (ie, multipart/x-mixed-replace)
 123    */
 124   readonly attribute bool multipart;
 125
 126   /**
 127    * CORS modes images can be loaded with.
 128    *
 129    * By default, all images are loaded with CORS_NONE and cannot be used
 130    * cross-origin in context like WebGL.
 131    *
 132    * If an HTML img element has the crossorigin attribute set, the imgIRequest
 133    * will be validated for cross-origin usage with CORS, and, if successful,
 134    * will have its CORS mode set to the relevant type.
 135    */
 136   //@{
 137   const long CORS_NONE = 1;
 138   const long CORS_ANONYMOUS = 2;
 139   const long CORS_USE_CREDENTIALS = 3;
 140   //@}
 141
 142   /**
 143    * The CORS mode that this image was loaded with.
 144    */
 145   readonly attribute long CORSMode;
 146
 147   /**
 148    * Cancels this request as in nsIRequest::Cancel(); further, also nulls out
 149    * decoderObserver so it gets no further notifications from us.
 150    *
 151    * NOTE: You should not use this in any new code; instead, use cancel(). Note
 152    * that cancel() is asynchronous, which means that some time after you call
 153    * it, the listener/observer will get an OnStopRequest(). This means that, if
 154    * you're the observer, you can't call cancel() from your destructor.
 155    */
 156   void cancelAndForgetObserver(in nsresult aStatus);
 157
 158   /**
 159    * Requests a synchronous decode for the image.
 160    *
 161    * imgIContainer has a startDecoding() method, but callers may want to request
 162    * a decode before the container has necessarily been instantiated. Calling
 163    * startDecoding() on the imgIRequest simply forwards along the request if the
 164    * container already exists, or calls it once the container becomes available
 165    * if it does not yet exist.
 166    */
 167   void startDecoding(in uint32_t aFlags);
 168
 169   /**
 170    * Exactly like startDecoding above except returns whether the current frame
 171    * of the image is complete or not.
 172    *
 173    * @param aFlags Flags of the FLAG_* variety. Only FLAG_ASYNC_NOTIFY
 174    *               is accepted; all others are ignored.
 175    */
 176   [noscript, notxpcom] boolean startDecodingWithResult(in uint32_t aFlags);
 177
 178   /**
 179    * This method triggers decoding for an image, but unlike startDecoding() it
 180    * enables the caller to provide more detailed information about the decode
 181    * request.
 182    *
 183    * @param aFlags Flags of the FLAG_* variety.
 184    * @return DECODE_SURFACE_AVAILABLE if is a surface that satisfies the
 185    *         request and it is fully decoded.
 186    *         DECODE_REQUESTED if we requested a decode.
 187    *         DECODE_REQUEST_FAILED if we failed to request a decode. This means
 188    *         that either there is an error in the image or we cannot allocate a
 189    *         surface that big.
 190    */
 191   [noscript, notxpcom] imgIContainer_DecodeResult requestDecodeWithResult(in uint32_t aFlags);
 192 /*%{C++
 193   DecodeResult RequestDecodeWithResult(uint32_t aFlags);
 194 %}*/
 195
 196
 197   /**
 198    * Locks an image. If the image does not exist yet, locks it once it becomes
 199    * available. The lock persists for the lifetime of the imgIRequest (until
 200    * unlockImage is called) even if the underlying image changes.
 201    *
 202    * If you don't call unlockImage() by the time this imgIRequest goes away, it
 203    * will be called for you automatically.
 204    *
 205    * @see imgIContainer::lockImage for documentation of the underlying call.
 206    */
 207   void lockImage();
 208
 209   /**
 210    * Unlocks an image.
 211    *
 212    * @see imgIContainer::unlockImage for documentation of the underlying call.
 213    */
 214   void unlockImage();
 215
 216   /**
 217    * If this image is unlocked, discard the image's decoded data.  If the image
 218    * is locked or is already discarded, do nothing.
 219    */
 220   void requestDiscard();
 221
 222   /**
 223    * If this request is for an animated image, the method creates a new
 224    * request which contains the current frame of the image.
 225    * Otherwise returns the same request.
 226    */
 227   imgIRequest getStaticRequest();
 228
 229   /**
 230    * Requests that the image animate (if it has an animation).
 231    *
 232    * @see Image::IncrementAnimationConsumers for documentation of the
 233    * underlying call.
 234    */
 235   void incrementAnimationConsumers();
 236
 237   /**
 238    * Tell the image it can forget about a request that the image animate.
 239    *
 240    * @see Image::DecrementAnimationConsumers for documentation of the
 241    * underlying call.
 242    */
 243   void decrementAnimationConsumers();
 244
 245   /**
 246    * Request loading priority boost to requested category, each category
 247    * of request increases priority only one time.
 248    *
 249    * CATEGORY_FRAME_INIT: increase priority when the imgRequest is associated
 250    * with an nsImageFrame.
 251    *
 252    * CATEGORY_FRAME_STYLE: increase priority when the imgRequest is for a CSS
 253    * background-image, list-style-image, etc. on a ComputedStyle, and a frame
 254    * has been assigned this ComputedStyle.
 255    *
 256    * CATEGORY_SIZE_QUERY: increase priority when size decoding is necessary to
 257    * determine the layout size of an associated nsImageFrame.
 258    *
 259    * CATEGORY_DISPLAY: increase priority when the image is about to be displayed
 260    * in the viewport.
 261    */
 262   const uint32_t CATEGORY_FRAME_INIT  = 1 << 0;
 263   const uint32_t CATEGORY_FRAME_STYLE = 1 << 1;
 264   const uint32_t CATEGORY_SIZE_QUERY  = 1 << 2;
 265   const uint32_t CATEGORY_DISPLAY     = 1 << 3;
 266   void boostPriority(in uint32_t aCategory);
 267 };
 268