dom/base/StaticRange.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_dom_StaticRange_h
   8 #define mozilla_dom_StaticRange_h
   9
  10 #include "mozilla/RangeBoundary.h"
  11 #include "mozilla/dom/AbstractRange.h"
  12 #include "mozilla/dom/StaticRangeBinding.h"
  13 #include "nsTArray.h"
  14 #include "nsWrapperCache.h"
  15
  16 namespace mozilla {
  17 class ErrorResult;
  18
  19 namespace dom {
  20
  21 class StaticRange final : public AbstractRange {
  22  public:
  23   StaticRange() = delete;
  24   explicit StaticRange(const StaticRange& aOther) = delete;
  25
  26   static already_AddRefed<StaticRange> Constructor(const GlobalObject& global,
  27                                                    const StaticRangeInit& init,
  28                                                    ErrorResult& aRv);
  29
  30   /**
  31    * The following Create() returns `nsRange` instance which is initialized
  32    * only with aNode.  The result is never positioned.
  33    */
  34   static already_AddRefed<StaticRange> Create(nsINode* aNode);
  35
  36   /**
  37    * Create() may return `StaticRange` instance which is initialized with
  38    * given range or points.  If it fails initializing new range with the
  39    * arguments, returns `nullptr`.  `ErrorResult` is set to an error only
  40    * when this returns `nullptr`.  The error code indicates the reason why
  41    * it couldn't initialize the instance.
  42    */
  43   static already_AddRefed<StaticRange> Create(
  44       const AbstractRange* aAbstractRange, ErrorResult& aRv) {
  45     MOZ_ASSERT(aAbstractRange);
  46     return StaticRange::Create(aAbstractRange->StartRef(),
  47                                aAbstractRange->EndRef(), aRv);
  48   }
  49   static already_AddRefed<StaticRange> Create(nsINode* aStartContainer,
  50                                               uint32_t aStartOffset,
  51                                               nsINode* aEndContainer,
  52                                               uint32_t aEndOffset,
  53                                               ErrorResult& aRv) {
  54     return StaticRange::Create(RawRangeBoundary(aStartContainer, aStartOffset),
  55                                RawRangeBoundary(aEndContainer, aEndOffset),
  56                                aRv);
  57   }
  58   template <typename SPT, typename SRT, typename EPT, typename ERT>
  59   static already_AddRefed<StaticRange> Create(
  60       const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
  61       const RangeBoundaryBase<EPT, ERT>& aEndBoundary, ErrorResult& aRv);
  62
  63  protected:
  64   explicit StaticRange(nsINode* aNode) : AbstractRange(aNode) {}
  65   virtual ~StaticRange() = default;
  66
  67  public:
  68   NS_DECL_ISUPPORTS_INHERITED
  69   NS_IMETHODIMP_(void) DeleteCycleCollectable(void) override;
  70   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(StaticRange,
  71                                                          AbstractRange)
  72
  73   JSObject* WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) final;
  74
  75   /**
  76    * SetStartAndEnd() works similar to call both SetStart() and SetEnd().
  77    * Different from calls them separately, this does nothing if either
  78    * the start point or the end point is invalid point.
  79    * If the specified start point is after the end point, the range will be
  80    * collapsed at the end point.  Similarly, if they are in different root,
  81    * the range will be collapsed at the end point.
  82    */
  83   nsresult SetStartAndEnd(nsINode* aStartContainer, uint32_t aStartOffset,
  84                           nsINode* aEndContainer, uint32_t aEndOffset) {
  85     return SetStartAndEnd(RawRangeBoundary(aStartContainer, aStartOffset),
  86                           RawRangeBoundary(aEndContainer, aEndOffset));
  87   }
  88   template <typename SPT, typename SRT, typename EPT, typename ERT>
  89   nsresult SetStartAndEnd(const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
  90                           const RangeBoundaryBase<EPT, ERT>& aEndBoundary) {
  91     return AbstractRange::SetStartAndEndInternal(aStartBoundary, aEndBoundary,
  92                                                  this);
  93   }
  94
  95  protected:
  96   /**
  97    * DoSetRange() is called when `AbstractRange::SetStartAndEndInternal()` sets
  98    * mStart and mEnd.
  99    *
 100    * @param aStartBoundary  Computed start point.  This must equals or be before
 101    *                        aEndBoundary in the DOM tree order.
 102    * @param aEndBoundary    Computed end point.
 103    * @param aRootNode       The root node.
 104    */
 105   template <typename SPT, typename SRT, typename EPT, typename ERT>
 106   void DoSetRange(const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
 107                   const RangeBoundaryBase<EPT, ERT>& aEndBoundary,
 108                   nsINode* aRootNode);
 109
 110   static nsTArray<RefPtr<StaticRange>>* sCachedRanges;
 111
 112   friend class AbstractRange;
 113 };
 114
 115 }  // namespace dom
 116 }  // namespace mozilla
 117
 118 #endif  // #ifndef mozilla_dom_StaticRange_h