dom/base/DOMRect.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 MOZILLA_DOMRECT_H_
   8 #define MOZILLA_DOMRECT_H_
   9
  10 #include <algorithm>
  11 #include <cstdint>
  12 #include <new>
  13 #include <utility>
  14 #include "js/TypeDecls.h"
  15 #include "mozilla/AlreadyAddRefed.h"
  16 #include "mozilla/Assertions.h"
  17 #include "mozilla/FloatingPoint.h"
  18 #include "mozilla/RefPtr.h"
  19 #include "nsCOMPtr.h"
  20 #include "nsCycleCollectionParticipant.h"
  21 #include "nsISupports.h"
  22 #include "nsTArray.h"
  23 #include "nsWrapperCache.h"
  24
  25 class JSObject;
  26 class nsIGlobalObject;
  27 struct JSContext;
  28 struct JSStructuredCloneReader;
  29 struct JSStructuredCloneWriter;
  30 struct nsRect;
  31
  32 namespace mozilla::dom {
  33
  34 class GlobalObject;
  35 struct DOMRectInit;
  36
  37 class DOMRectReadOnly : public nsISupports, public nsWrapperCache {
  38  protected:
  39   virtual ~DOMRectReadOnly() = default;
  40
  41  public:
  42   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  43   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(DOMRectReadOnly)
  44
  45   explicit DOMRectReadOnly(nsISupports* aParent, double aX = 0, double aY = 0,
  46                            double aWidth = 0, double aHeight = 0)
  47       : mParent(aParent), mX(aX), mY(aY), mWidth(aWidth), mHeight(aHeight) {}
  48
  49   nsISupports* GetParentObject() const {
  50     MOZ_ASSERT(mParent);
  51     return mParent;
  52   }
  53
  54   virtual JSObject* WrapObject(JSContext* aCx,
  55                                JS::Handle<JSObject*> aGivenProto) override;
  56
  57   static already_AddRefed<DOMRectReadOnly> FromRect(const GlobalObject& aGlobal,
  58                                                     const DOMRectInit& aInit);
  59
  60   static already_AddRefed<DOMRectReadOnly> Constructor(
  61       const GlobalObject& aGlobal, double aX, double aY, double aWidth,
  62       double aHeight);
  63
  64   double X() const { return mX; }
  65   double Y() const { return mY; }
  66   double Width() const { return mWidth; }
  67   double Height() const { return mHeight; }
  68
  69   double Left() const {
  70     double x = X(), w = Width();
  71     return NaNSafeMin(x, x + w);
  72   }
  73   double Top() const {
  74     double y = Y(), h = Height();
  75     return NaNSafeMin(y, y + h);
  76   }
  77   double Right() const {
  78     double x = X(), w = Width();
  79     return NaNSafeMax(x, x + w);
  80   }
  81   double Bottom() const {
  82     double y = Y(), h = Height();
  83     return NaNSafeMax(y, y + h);
  84   }
  85
  86   bool WriteStructuredClone(JSContext* aCx,
  87                             JSStructuredCloneWriter* aWriter) const;
  88
  89   static already_AddRefed<DOMRectReadOnly> ReadStructuredClone(
  90       JSContext* aCx, nsIGlobalObject* aGlobal,
  91       JSStructuredCloneReader* aReader);
  92
  93  protected:
  94   // Shared implementation of ReadStructuredClone for DOMRect and
  95   // DOMRectReadOnly.
  96   bool ReadStructuredClone(JSStructuredCloneReader* aReader);
  97
  98   nsCOMPtr<nsISupports> mParent;
  99   double mX, mY, mWidth, mHeight;
 100 };
 101
 102 class DOMRect final : public DOMRectReadOnly {
 103  public:
 104   explicit DOMRect(nsISupports* aParent, double aX = 0, double aY = 0,
 105                    double aWidth = 0, double aHeight = 0)
 106       : DOMRectReadOnly(aParent, aX, aY, aWidth, aHeight) {}
 107
 108   NS_INLINE_DECL_REFCOUNTING_INHERITED(DOMRect, DOMRectReadOnly)
 109
 110   static already_AddRefed<DOMRect> FromRect(const GlobalObject& aGlobal,
 111                                             const DOMRectInit& aInit);
 112
 113   static already_AddRefed<DOMRect> Constructor(const GlobalObject& aGlobal,
 114                                                double aX, double aY,
 115                                                double aWidth, double aHeight);
 116
 117   virtual JSObject* WrapObject(JSContext* aCx,
 118                                JS::Handle<JSObject*> aGivenProto) override;
 119
 120   static already_AddRefed<DOMRect> ReadStructuredClone(
 121       JSContext* aCx, nsIGlobalObject* aGlobal,
 122       JSStructuredCloneReader* aReader);
 123   using DOMRectReadOnly::ReadStructuredClone;
 124
 125   void SetRect(float aX, float aY, float aWidth, float aHeight) {
 126     mX = aX;
 127     mY = aY;
 128     mWidth = aWidth;
 129     mHeight = aHeight;
 130   }
 131   void SetLayoutRect(const nsRect& aLayoutRect);
 132
 133   void SetX(double aX) { mX = aX; }
 134   void SetY(double aY) { mY = aY; }
 135   void SetWidth(double aWidth) { mWidth = aWidth; }
 136   void SetHeight(double aHeight) { mHeight = aHeight; }
 137
 138   static DOMRect* FromSupports(nsISupports* aSupports) {
 139     return static_cast<DOMRect*>(aSupports);
 140   }
 141
 142  private:
 143   ~DOMRect() = default;
 144 };
 145
 146 class DOMRectList final : public nsISupports, public nsWrapperCache {
 147   ~DOMRectList() = default;
 148
 149  public:
 150   explicit DOMRectList(nsISupports* aParent) : mParent(aParent) {}
 151
 152   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
 153   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(DOMRectList)
 154
 155   virtual JSObject* WrapObject(JSContext* cx,
 156                                JS::Handle<JSObject*> aGivenProto) override;
 157
 158   nsISupports* GetParentObject() { return mParent; }
 159
 160   void Append(RefPtr<DOMRect>&& aElement) {
 161     mArray.AppendElement(std::move(aElement));
 162   }
 163
 164   uint32_t Length() { return mArray.Length(); }
 165   DOMRect* Item(uint32_t aIndex) { return mArray.SafeElementAt(aIndex); }
 166   DOMRect* IndexedGetter(uint32_t aIndex, bool& aFound) {
 167     aFound = aIndex < mArray.Length();
 168     if (!aFound) {
 169       return nullptr;
 170     }
 171     return mArray[aIndex];
 172   }
 173
 174  protected:
 175   nsTArray<RefPtr<DOMRect> > mArray;
 176   nsCOMPtr<nsISupports> mParent;
 177 };
 178
 179 }  // namespace mozilla::dom
 180
 181 #endif /*MOZILLA_DOMRECT_H_*/