author Ed Morley <>
Tue, 30 Oct 2012 17:02:31 +0000
changeset 120431 ad1d720d82b7f84d3c7e50f4b02b7c3201662ddb
parent 113574 c4f83d9d8243f3f853a5356188164a5fddee2b5a
child 126822 5244caae8c4606ef62ad9c46ef4a944a87ba4196
permissions -rw-r--r--
Backout a145ded68994, e0cf397089ec & 1545e91c658e (bug 798491) for bustage on a CLOSED TREE

/* -*- 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 */

/* This class wraps an SVG document, for use by VectorImage objects. */

#ifndef mozilla_imagelib_SVGDocumentWrapper_h_
#define mozilla_imagelib_SVGDocumentWrapper_h_

#include "mozilla/Attributes.h"

#include "nsCOMPtr.h"
#include "nsIStreamListener.h"
#include "nsIObserver.h"
#include "nsIContentViewer.h"
#include "nsWeakReference.h"

class nsIAtom;
class nsIPresShell;
class nsIRequest;
class nsILoadGroup;
class nsIFrame;
struct nsIntSize;
class nsSVGSVGElement;

#define SVG_MIMETYPE     "image/svg+xml"
#define OBSERVER_SVC_CID ";1"

namespace mozilla {
namespace image {

class SVGDocumentWrapper MOZ_FINAL : public nsIStreamListener,
                                     public nsIObserver,


  enum Dimension {

   * Looks up the value of the wrapped SVG document's |width| or |height|
   * attribute in CSS pixels, and returns it by reference.  If the document has
   * a percent value for the queried attribute, then this method fails
   * (returns false).
   * @param aDimension    Indicates whether the width or height is desired.
   * @param[out] aResult  If this method succeeds, then this outparam will be
                          populated with the width or height in CSS pixels.
   * @return false to indicate failure, if the queried attribute has a
   *         percent value.  Otherwise, true.
  bool      GetWidthOrHeight(Dimension aDimension, int32_t& aResult);

   * Returns the root <svg> element for the wrapped document, or nullptr on
   * failure.
  nsSVGSVGElement* GetRootSVGElem();

   * Returns the root nsIFrame* for the wrapped document, or nullptr on failure.
   * @return the root nsIFrame* for the wrapped document, or nullptr on failure.
  nsIFrame* GetRootLayoutFrame();

   * Returns (by reference) the nsIPresShell for the wrapped document.
   * @param[out] aPresShell On success, this will be populated with a pointer
   *                        to the wrapped document's nsIPresShell.
   * @return NS_OK on success, or an error code on failure.
  inline nsresult  GetPresShell(nsIPresShell** aPresShell)
    { return mViewer->GetPresShell(aPresShell); }

   * Returns a bool indicating whether the wrapped document has been parsed
   * successfully.
   * @return true if the document has been parsed successfully,
   *         false otherwise (e.g. if there's a syntax error in the SVG).
  inline bool      ParsedSuccessfully()  { return !!GetRootSVGElem(); }

   * Modifier to update the viewport dimensions of the wrapped document. This
   * method performs a synchronous "Flush_Layout" on the wrapped document,
   * since a viewport-change affects layout.
   * @param aViewportSize The new viewport dimensions.
  void UpdateViewportBounds(const nsIntSize& aViewportSize);

   * If an SVG image's helper document has a pending notification for an
   * override on the root node's "preserveAspectRatio" attribute, then this
   * method will flush that notification so that the image can paint correctly.
   * (First, though, it sets the mIgnoreInvalidation flag so that we won't
   * notify the image's observers and trigger unwanted repaint-requests.)
  void FlushImageTransformInvalidation();

   * Returns a bool indicating whether the document has any SMIL animations.
   * @return true if the document has any SMIL animations. Else, false.
  bool      IsAnimated();

   * Indicates whether we should currently ignore rendering invalidations sent
   * from the wrapped SVG doc.
   * @return true if we should ignore invalidations sent from this SVG doc.
  bool ShouldIgnoreInvalidation() { return mIgnoreInvalidation; }

   * Methods to control animation.
  void StartAnimation();
  void StopAnimation();
  void ResetAnimation();

  nsresult SetupViewer(nsIRequest *aRequest,
                       nsIContentViewer** aViewer,
                       nsILoadGroup** aLoadGroup);
  void     DestroyViewer();
  void     RegisterForXPCOMShutdown();
  void     UnregisterForXPCOMShutdown();

  void     FlushLayout();

  nsCOMPtr<nsIContentViewer>  mViewer;
  nsCOMPtr<nsILoadGroup>      mLoadGroup;
  nsCOMPtr<nsIStreamListener> mListener;
  bool                        mIgnoreInvalidation;
  bool                        mRegisteredForXPCOMShutdown;

} // namespace image
} // namespace mozilla

#endif // mozilla_imagelib_SVGDocumentWrapper_h_