dom/base/DOMRect.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef MOZILLA_DOMRECT_H_
   7 #define MOZILLA_DOMRECT_H_
   8
   9 #include "nsIDOMClientRect.h"
  10 #include "nsIDOMClientRectList.h"
  11 #include "nsTArray.h"
  12 #include "nsCOMPtr.h"
  13 #include "nsAutoPtr.h"
  14 #include "nsWrapperCache.h"
  15 #include "nsCycleCollectionParticipant.h"
  16 #include "mozilla/Attributes.h"
  17 #include "mozilla/dom/BindingDeclarations.h"
  18 #include "mozilla/ErrorResult.h"
  19 #include <algorithm>
  20
  21 struct nsRect;
  22
  23 namespace mozilla {
  24 namespace dom {
  25
  26 class DOMRectReadOnly : public nsISupports
  27                       , public nsWrapperCache
  28 {
  29 protected:
  30   virtual ~DOMRectReadOnly() {}
  31
  32 public:
  33   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  34   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(DOMRectReadOnly)
  35
  36   explicit DOMRectReadOnly(nsISupports* aParent)
  37     : mParent(aParent)
  38   {
  39   }
  40
  41   nsISupports* GetParentObject() const
  42   {
  43     MOZ_ASSERT(mParent);
  44     return mParent;
  45   }
  46   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  47
  48   virtual double X() const = 0;
  49   virtual double Y() const = 0;
  50   virtual double Width() const = 0;
  51   virtual double Height() const = 0;
  52
  53   double Left() const
  54   {
  55     double x = X(), w = Width();
  56     return std::min(x, x + w);
  57   }
  58   double Top() const
  59   {
  60     double y = Y(), h = Height();
  61     return std::min(y, y + h);
  62   }
  63   double Right() const
  64   {
  65     double x = X(), w = Width();
  66     return std::max(x, x + w);
  67   }
  68   double Bottom() const
  69   {
  70     double y = Y(), h = Height();
  71     return std::max(y, y + h);
  72   }
  73
  74 protected:
  75   nsCOMPtr<nsISupports> mParent;
  76 };
  77
  78 class DOMRect MOZ_FINAL : public DOMRectReadOnly
  79                         , public nsIDOMClientRect
  80 {
  81 public:
  82   explicit DOMRect(nsISupports* aParent, double aX = 0, double aY = 0,
  83                    double aWidth = 0, double aHeight = 0)
  84     : DOMRectReadOnly(aParent)
  85     , mX(aX)
  86     , mY(aY)
  87     , mWidth(aWidth)
  88     , mHeight(aHeight)
  89   {
  90   }
  91
  92   NS_DECL_ISUPPORTS_INHERITED
  93   NS_DECL_NSIDOMCLIENTRECT
  94
  95   static already_AddRefed<DOMRect>
  96   Constructor(const GlobalObject& aGlobal, ErrorResult& aRV);
  97   static already_AddRefed<DOMRect>
  98   Constructor(const GlobalObject& aGlobal, double aX, double aY,
  99               double aWidth, double aHeight, ErrorResult& aRV);
 100
 101   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
 102
 103   void SetRect(float aX, float aY, float aWidth, float aHeight) {
 104     mX = aX; mY = aY; mWidth = aWidth; mHeight = aHeight;
 105   }
 106   void SetLayoutRect(const nsRect& aLayoutRect);
 107
 108   virtual double X() const MOZ_OVERRIDE
 109   {
 110     return mX;
 111   }
 112   virtual double Y() const MOZ_OVERRIDE
 113   {
 114     return mY;
 115   }
 116   virtual double Width() const MOZ_OVERRIDE
 117   {
 118     return mWidth;
 119   }
 120   virtual double Height() const MOZ_OVERRIDE
 121   {
 122     return mHeight;
 123   }
 124
 125   void SetX(double aX)
 126   {
 127     mX = aX;
 128   }
 129   void SetY(double aY)
 130   {
 131     mY = aY;
 132   }
 133   void SetWidth(double aWidth)
 134   {
 135     mWidth = aWidth;
 136   }
 137   void SetHeight(double aHeight)
 138   {
 139     mHeight = aHeight;
 140   }
 141
 142 protected:
 143   double mX, mY, mWidth, mHeight;
 144
 145 private:
 146   ~DOMRect() {};
 147 };
 148
 149 class DOMRectList MOZ_FINAL : public nsIDOMClientRectList,
 150                               public nsWrapperCache
 151 {
 152   ~DOMRectList() {}
 153
 154 public:
 155   explicit DOMRectList(nsISupports *aParent) : mParent(aParent)
 156   {
 157   }
 158
 159   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
 160   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(DOMRectList)
 161
 162   NS_DECL_NSIDOMCLIENTRECTLIST
 163
 164   virtual JSObject* WrapObject(JSContext *cx) MOZ_OVERRIDE;
 165
 166   nsISupports* GetParentObject()
 167   {
 168     return mParent;
 169   }
 170
 171   void Append(DOMRect* aElement) { mArray.AppendElement(aElement); }
 172
 173   static DOMRectList* FromSupports(nsISupports* aSupports)
 174   {
 175 #ifdef DEBUG
 176     {
 177       nsCOMPtr<nsIDOMClientRectList> list_qi = do_QueryInterface(aSupports);
 178
 179       // If this assertion fires the QI implementation for the object in
 180       // question doesn't use the nsIDOMClientRectList pointer as the nsISupports
 181       // pointer. That must be fixed, or we'll crash...
 182       NS_ASSERTION(list_qi == static_cast<nsIDOMClientRectList*>(aSupports),
 183                    "Uh, fix QI!");
 184     }
 185 #endif
 186
 187     return static_cast<DOMRectList*>(aSupports);
 188   }
 189
 190   uint32_t Length()
 191   {
 192     return mArray.Length();
 193   }
 194   DOMRect* Item(uint32_t aIndex)
 195   {
 196     return mArray.SafeElementAt(aIndex);
 197   }
 198   DOMRect* IndexedGetter(uint32_t aIndex, bool& aFound)
 199   {
 200     aFound = aIndex < mArray.Length();
 201     if (!aFound) {
 202       return nullptr;
 203     }
 204     return mArray[aIndex];
 205   }
 206
 207 protected:
 208   nsTArray<nsRefPtr<DOMRect> > mArray;
 209   nsCOMPtr<nsISupports> mParent;
 210 };
 211
 212 }
 213
 214 }
 215
 216 #endif /*MOZILLA_DOMRECT_H_*/