dom/base/DOMPoint.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_DOMPOINT_H_
   8 #define MOZILLA_DOMPOINT_H_
   9
  10 #include "js/TypeDecls.h"
  11 #include "mozilla/AlreadyAddRefed.h"
  12 #include "mozilla/Assertions.h"
  13 #include "nsCOMPtr.h"
  14 #include "nsCycleCollectionParticipant.h"
  15 #include "nsISupports.h"
  16 #include "nsWrapperCache.h"
  17
  18 class JSObject;
  19 class nsIGlobalObject;
  20 struct JSContext;
  21 struct JSStructuredCloneReader;
  22 struct JSStructuredCloneWriter;
  23
  24 namespace mozilla {
  25 class ErrorResult;
  26
  27 namespace dom {
  28
  29 class GlobalObject;
  30 class DOMPoint;
  31 struct DOMPointInit;
  32 struct DOMMatrixInit;
  33
  34 class DOMPointReadOnly : public nsWrapperCache {
  35  public:
  36   explicit DOMPointReadOnly(nsISupports* aParent, double aX = 0.0,
  37                             double aY = 0.0, double aZ = 0.0, double aW = 1.0)
  38       : mParent(aParent), mX(aX), mY(aY), mZ(aZ), mW(aW) {}
  39
  40   static already_AddRefed<DOMPointReadOnly> FromPoint(
  41       const GlobalObject& aGlobal, const DOMPointInit& aParams);
  42   static already_AddRefed<DOMPointReadOnly> Constructor(
  43       const GlobalObject& aGlobal, double aX, double aY, double aZ, double aW);
  44
  45   NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(DOMPointReadOnly)
  46   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(DOMPointReadOnly)
  47
  48   double X() const { return mX; }
  49   double Y() const { return mY; }
  50   double Z() const { return mZ; }
  51   double W() const { return mW; }
  52
  53   already_AddRefed<DOMPoint> MatrixTransform(const DOMMatrixInit& aInit,
  54                                              ErrorResult& aRv);
  55
  56   nsISupports* GetParentObject() const { return mParent; }
  57   virtual JSObject* WrapObject(JSContext* aCx,
  58                                JS::Handle<JSObject*> aGivenProto) override;
  59
  60   bool WriteStructuredClone(JSContext* aCx,
  61                             JSStructuredCloneWriter* aWriter) const;
  62
  63   static already_AddRefed<DOMPointReadOnly> ReadStructuredClone(
  64       JSContext* aCx, nsIGlobalObject* aGlobal,
  65       JSStructuredCloneReader* aReader);
  66
  67  protected:
  68   virtual ~DOMPointReadOnly() = default;
  69
  70   // Shared implementation of ReadStructuredClone for DOMPoint and
  71   // DOMPointReadOnly.
  72   bool ReadStructuredClone(JSStructuredCloneReader* aReader);
  73
  74   nsCOMPtr<nsISupports> mParent;
  75   double mX, mY, mZ, mW;
  76 };
  77
  78 class DOMPoint final : public DOMPointReadOnly {
  79  public:
  80   explicit DOMPoint(nsISupports* aParent, double aX = 0.0, double aY = 0.0,
  81                     double aZ = 0.0, double aW = 1.0)
  82       : DOMPointReadOnly(aParent, aX, aY, aZ, aW) {}
  83
  84   static already_AddRefed<DOMPoint> FromPoint(const GlobalObject& aGlobal,
  85                                               const DOMPointInit& aParams);
  86   static already_AddRefed<DOMPoint> Constructor(const GlobalObject& aGlobal,
  87                                                 double aX, double aY, double aZ,
  88                                                 double aW);
  89
  90   virtual JSObject* WrapObject(JSContext* aCx,
  91                                JS::Handle<JSObject*> aGivenProto) override;
  92
  93   static already_AddRefed<DOMPoint> ReadStructuredClone(
  94       JSContext* aCx, nsIGlobalObject* aGlobal,
  95       JSStructuredCloneReader* aReader);
  96   using DOMPointReadOnly::ReadStructuredClone;
  97
  98   void SetX(double aX) { mX = aX; }
  99   void SetY(double aY) { mY = aY; }
 100   void SetZ(double aZ) { mZ = aZ; }
 101   void SetW(double aW) { mW = aW; }
 102 };
 103
 104 }  // namespace dom
 105 }  // namespace mozilla
 106
 107 #endif /*MOZILLA_DOMPOINT_H_*/