dom/svg/SVGSVGElement.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   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 #ifndef DOM_SVG_SVGSVGELEMENT_H_
   8 #define DOM_SVG_SVGSVGELEMENT_H_
   9
  10 #include "SVGAnimatedEnumeration.h"
  11 #include "SVGViewportElement.h"
  12
  13 nsresult NS_NewSVGSVGElement(
  14     nsIContent** aResult, already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo,
  15     mozilla::dom::FromParser aFromParser);
  16
  17 // {4b83982c-e5e9-4ca1-abd4-14d27e8b3531}
  18 #define MOZILLA_SVGSVGELEMENT_IID                    \
  19   {                                                  \
  20     0x4b83982c, 0xe5e9, 0x4ca1, {                    \
  21       0xab, 0xd4, 0x14, 0xd2, 0x7e, 0x8b, 0x35, 0x31 \
  22     }                                                \
  23   }
  24
  25 namespace mozilla {
  26 class AutoSVGViewHandler;
  27 class SMILTimeContainer;
  28 class SVGFragmentIdentifier;
  29 class EventChainPreVisitor;
  30
  31 namespace dom {
  32 struct DOMMatrix2DInit;
  33 class DOMSVGAngle;
  34 class DOMSVGLength;
  35 class DOMSVGNumber;
  36 class DOMSVGPoint;
  37 class SVGMatrix;
  38 class SVGRect;
  39 class SVGSVGElement;
  40
  41 // Stores svgView arguments of SVG fragment identifiers.
  42 class SVGView {
  43  public:
  44   SVGView();
  45
  46   SVGAnimatedEnumeration mZoomAndPan;
  47   SVGAnimatedViewBox mViewBox;
  48   SVGAnimatedPreserveAspectRatio mPreserveAspectRatio;
  49   UniquePtr<SVGAnimatedTransformList> mTransforms;
  50 };
  51
  52 using SVGSVGElementBase = SVGViewportElement;
  53
  54 class SVGSVGElement final : public SVGSVGElementBase {
  55   friend class mozilla::SVGFragmentIdentifier;
  56   friend class mozilla::SVGOuterSVGFrame;
  57   friend class mozilla::AutoSVGViewHandler;
  58   friend class mozilla::AutoPreserveAspectRatioOverride;
  59   friend class mozilla::dom::SVGView;
  60
  61  protected:
  62   SVGSVGElement(already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo,
  63                 FromParser aFromParser);
  64   JSObject* WrapNode(JSContext* aCx,
  65                      JS::Handle<JSObject*> aGivenProto) override;
  66
  67   friend nsresult(::NS_NewSVGSVGElement(
  68       nsIContent** aResult,
  69       already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo,
  70       mozilla::dom::FromParser aFromParser));
  71
  72   ~SVGSVGElement() = default;
  73
  74  public:
  75   NS_IMPL_FROMNODE_WITH_TAG(SVGSVGElement, kNameSpaceID_SVG, svg)
  76
  77   // interfaces:
  78   NS_DECLARE_STATIC_IID_ACCESSOR(MOZILLA_SVGSVGELEMENT_IID)
  79   NS_DECL_ISUPPORTS_INHERITED
  80   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(SVGSVGElement, SVGSVGElementBase)
  81
  82   /*
  83    * Send appropriate events and updates if our root translate
  84    * has changed.
  85    */
  86   MOZ_CAN_RUN_SCRIPT
  87   void DidChangeTranslate();
  88
  89   // nsIContent interface
  90   void GetEventTargetParent(EventChainPreVisitor& aVisitor) override;
  91   bool IsEventAttributeNameInternal(nsAtom* aName) override;
  92
  93   // nsINode methods:
  94   nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;
  95
  96   // WebIDL
  97   already_AddRefed<DOMSVGAnimatedLength> X();
  98   already_AddRefed<DOMSVGAnimatedLength> Y();
  99   already_AddRefed<DOMSVGAnimatedLength> Width();
 100   already_AddRefed<DOMSVGAnimatedLength> Height();
 101   bool UseCurrentView() const;
 102   float CurrentScale() const;
 103   void SetCurrentScale(float aCurrentScale);
 104   already_AddRefed<DOMSVGPoint> CurrentTranslate();
 105   uint32_t SuspendRedraw(uint32_t max_wait_milliseconds);
 106   void UnsuspendRedraw(uint32_t suspend_handle_id);
 107   void UnsuspendRedrawAll();
 108   void ForceRedraw();
 109   void PauseAnimations();
 110   void UnpauseAnimations();
 111   bool AnimationsPaused();
 112   float GetCurrentTimeAsFloat();
 113   void SetCurrentTime(float seconds);
 114   void DeselectAll();
 115   already_AddRefed<DOMSVGNumber> CreateSVGNumber();
 116   already_AddRefed<DOMSVGLength> CreateSVGLength();
 117   already_AddRefed<DOMSVGAngle> CreateSVGAngle();
 118   already_AddRefed<DOMSVGPoint> CreateSVGPoint();
 119   already_AddRefed<SVGMatrix> CreateSVGMatrix();
 120   already_AddRefed<SVGRect> CreateSVGRect();
 121   already_AddRefed<DOMSVGTransform> CreateSVGTransform();
 122   already_AddRefed<DOMSVGTransform> CreateSVGTransformFromMatrix(
 123       const DOMMatrix2DInit& matrix, ErrorResult& rv);
 124   using nsINode::GetElementById;  // This does what we want
 125   uint16_t ZoomAndPan() const;
 126   void SetZoomAndPan(uint16_t aZoomAndPan, ErrorResult& rv);
 127
 128   // SVGElement overrides
 129
 130   nsresult BindToTree(BindContext&, nsINode& aParent) override;
 131   void UnbindFromTree(UnbindContext&) override;
 132   SVGAnimatedTransformList* GetAnimatedTransformList(
 133       uint32_t aFlags = 0) override;
 134
 135   // SVGSVGElement methods:
 136
 137   // Returns true IFF our attributes are currently overridden by a <view>
 138   // element and that element's ID matches the passed-in string.
 139   bool IsOverriddenBy(const nsAString& aViewID) const {
 140     return mCurrentViewID && mCurrentViewID->Equals(aViewID);
 141   }
 142
 143   SMILTimeContainer* GetTimedDocumentRoot();
 144
 145   // public helpers:
 146
 147   const SVGPoint& GetCurrentTranslate() const { return mCurrentTranslate; }
 148   bool IsScaledOrTranslated() const {
 149     return mCurrentTranslate != SVGPoint() || mCurrentScale != 1.0f;
 150   }
 151
 152   LengthPercentage GetIntrinsicWidth();
 153   LengthPercentage GetIntrinsicHeight();
 154
 155   // This services any pending notifications for the transform on on this root
 156   // <svg> node needing to be recalculated.  (Only applicable in
 157   // SVG-as-an-image documents.)
 158   virtual void FlushImageTransformInvalidation();
 159
 160  private:
 161   // SVGViewportElement methods:
 162
 163   virtual SVGViewElement* GetCurrentViewElement() const;
 164   SVGPreserveAspectRatio GetPreserveAspectRatioWithOverride() const override;
 165
 166   // implementation helpers:
 167
 168   /*
 169    * While binding to the tree we need to determine if we will be the outermost
 170    * <svg> element _before_ the children are bound (as they want to know what
 171    * timed document root to register with) and therefore _before_ our parent is
 172    * set (both actions are performed by Element::BindToTree) so we
 173    * can't use GetOwnerSVGElement() as it relies on GetParent(). This code is
 174    * basically a simplified version of GetOwnerSVGElement that uses the parent
 175    * parameters passed in instead.
 176    *
 177    * FIXME(bug 1596690): GetOwnerSVGElement() uses the flattened tree parent
 178    * rather than the DOM tree parent nowadays.
 179    */
 180   bool WillBeOutermostSVG(nsINode& aParent) const;
 181
 182   LengthPercentage GetIntrinsicWidthOrHeight(int aAttr);
 183
 184   // invalidate viewbox -> viewport xform & inform frames
 185   void InvalidateTransformNotifyFrame();
 186
 187   // Methods for <image> elements to override my "PreserveAspectRatio" value.
 188   // These are private so that only our friends
 189   // (AutoPreserveAspectRatioOverride in particular) have access.
 190   void SetImageOverridePreserveAspectRatio(const SVGPreserveAspectRatio& aPAR);
 191   void ClearImageOverridePreserveAspectRatio();
 192
 193   // Set/Clear properties to hold old version of preserveAspectRatio
 194   // when it's being overridden by an <image> element that we are inside of.
 195   bool SetPreserveAspectRatioProperty(const SVGPreserveAspectRatio& aPAR);
 196   const SVGPreserveAspectRatio* GetPreserveAspectRatioProperty() const;
 197   bool ClearPreserveAspectRatioProperty();
 198
 199   const SVGAnimatedViewBox& GetViewBoxInternal() const override;
 200   SVGAnimatedTransformList* GetTransformInternal() const override;
 201
 202   EnumAttributesInfo GetEnumInfo() override;
 203
 204   enum { ZOOMANDPAN };
 205   SVGAnimatedEnumeration mEnumAttributes[1];
 206   static SVGEnumMapping sZoomAndPanMap[];
 207   static EnumInfo sEnumInfo[1];
 208
 209   // The time container for animations within this SVG document fragment. Set
 210   // for all outermost <svg> elements (not nested <svg> elements).
 211   UniquePtr<SMILTimeContainer> mTimedDocumentRoot;
 212
 213   SVGPoint mCurrentTranslate;
 214   float mCurrentScale;
 215
 216   // For outermost <svg> elements created from parsing, animation is started by
 217   // the onload event in accordance with the SVG spec, but for <svg> elements
 218   // created by script or promoted from inner <svg> to outermost <svg> we need
 219   // to manually kick off animation when they are bound to the tree.
 220   bool mStartAnimationOnBindToTree;
 221
 222   bool mImageNeedsTransformInvalidation;
 223
 224   // mCurrentViewID and mSVGView are mutually exclusive; we can have
 225   // at most one non-null.
 226   UniquePtr<nsString> mCurrentViewID;
 227   UniquePtr<SVGView> mSVGView;
 228 };
 229
 230 NS_DEFINE_STATIC_IID_ACCESSOR(SVGSVGElement, MOZILLA_SVGSVGELEMENT_IID)
 231
 232 }  // namespace dom
 233
 234 class MOZ_RAII AutoSVGTimeSetRestore {
 235  public:
 236   AutoSVGTimeSetRestore(dom::SVGSVGElement* aRootElem, float aFrameTime)
 237       : mRootElem(aRootElem),
 238         mOriginalTime(mRootElem->GetCurrentTimeAsFloat()) {
 239     mRootElem->SetCurrentTime(
 240         aFrameTime);  // Does nothing if there's no change.
 241   }
 242
 243   ~AutoSVGTimeSetRestore() { mRootElem->SetCurrentTime(mOriginalTime); }
 244
 245  private:
 246   const RefPtr<dom::SVGSVGElement> mRootElem;
 247   const float mOriginalTime;
 248 };
 249
 250 class MOZ_RAII AutoPreserveAspectRatioOverride {
 251  public:
 252   AutoPreserveAspectRatioOverride(const SVGImageContext& aSVGContext,
 253                                   dom::SVGSVGElement* aRootElem)
 254       : mRootElem(aRootElem), mDidOverride(false) {
 255     MOZ_ASSERT(mRootElem, "No SVG/Symbol node to manage?");
 256
 257     if (aSVGContext.GetPreserveAspectRatio().isSome()) {
 258       // Override preserveAspectRatio in our helper document.
 259       // XXXdholbert We should technically be overriding the helper doc's clip
 260       // and overflow properties here, too. See bug 272288 comment 36.
 261       mRootElem->SetImageOverridePreserveAspectRatio(
 262           *aSVGContext.GetPreserveAspectRatio());
 263       mDidOverride = true;
 264     }
 265   }
 266
 267   ~AutoPreserveAspectRatioOverride() {
 268     if (mDidOverride) {
 269       mRootElem->ClearImageOverridePreserveAspectRatio();
 270     }
 271   }
 272
 273  private:
 274   const RefPtr<dom::SVGSVGElement> mRootElem;
 275   bool mDidOverride;
 276 };
 277
 278 }  // namespace mozilla
 279
 280 #endif  // DOM_SVG_SVGSVGELEMENT_H_