From 36d22d82aa202bb199967e9512281e9a53db42c9 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 21:33:14 +0200 Subject: Adding upstream version 115.7.0esr. Signed-off-by: Daniel Baumann --- dom/base/StaticRange.h | 140 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 140 insertions(+) create mode 100644 dom/base/StaticRange.h (limited to 'dom/base/StaticRange.h') diff --git a/dom/base/StaticRange.h b/dom/base/StaticRange.h new file mode 100644 index 0000000000..92fcb49224 --- /dev/null +++ b/dom/base/StaticRange.h @@ -0,0 +1,140 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#ifndef mozilla_dom_StaticRange_h +#define mozilla_dom_StaticRange_h + +#include "mozilla/RangeBoundary.h" +#include "mozilla/dom/AbstractRange.h" +#include "mozilla/dom/StaticRangeBinding.h" +#include "nsTArray.h" +#include "nsWrapperCache.h" + +namespace mozilla { +class ErrorResult; + +namespace dom { + +class StaticRange final : public AbstractRange { + public: + StaticRange() = delete; + explicit StaticRange(const StaticRange& aOther) = delete; + + static already_AddRefed Constructor(const GlobalObject& global, + const StaticRangeInit& init, + ErrorResult& aRv); + + /** + * The following Create() returns `nsRange` instance which is initialized + * only with aNode. The result is never positioned. + */ + static already_AddRefed Create(nsINode* aNode); + + /** + * Create() may return `StaticRange` instance which is initialized with + * given range or points. If it fails initializing new range with the + * arguments, returns `nullptr`. `ErrorResult` is set to an error only + * when this returns `nullptr`. The error code indicates the reason why + * it couldn't initialize the instance. + */ + static already_AddRefed Create( + const AbstractRange* aAbstractRange, ErrorResult& aRv) { + MOZ_ASSERT(aAbstractRange); + return StaticRange::Create(aAbstractRange->StartRef(), + aAbstractRange->EndRef(), aRv); + } + static already_AddRefed Create(nsINode* aStartContainer, + uint32_t aStartOffset, + nsINode* aEndContainer, + uint32_t aEndOffset, + ErrorResult& aRv) { + return StaticRange::Create( + RawRangeBoundary(aStartContainer, aStartOffset, + RangeBoundaryIsMutationObserved::No), + RawRangeBoundary(aEndContainer, aEndOffset, + RangeBoundaryIsMutationObserved::No), + aRv); + } + template + static already_AddRefed Create( + const RangeBoundaryBase& aStartBoundary, + const RangeBoundaryBase& aEndBoundary, ErrorResult& aRv); + + /** + * Returns true if the range is valid. + * + * @see https://dom.spec.whatwg.org/#staticrange-valid + */ + bool IsValid() const { + return mStart.IsSetAndValid() && mEnd.IsSetAndValid(); + } + + protected: + explicit StaticRange(nsINode* aNode) + : AbstractRange(aNode, /* aIsDynamicRange = */ false) {} + virtual ~StaticRange(); + + public: + NS_DECL_ISUPPORTS_INHERITED + NS_IMETHODIMP_(void) DeleteCycleCollectable(void) override; + NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(StaticRange, + AbstractRange) + + JSObject* WrapObject(JSContext* aCx, JS::Handle aGivenProto) final; + + /** + * SetStartAndEnd() works similar to call both SetStart() and SetEnd(). + * Different from calls them separately, this does nothing if either + * the start point or the end point is invalid point. + * If the specified start point is after the end point, the range will be + * collapsed at the end point. Similarly, if they are in different root, + * the range will be collapsed at the end point. + */ + nsresult SetStartAndEnd(nsINode* aStartContainer, uint32_t aStartOffset, + nsINode* aEndContainer, uint32_t aEndOffset) { + return SetStartAndEnd(RawRangeBoundary(aStartContainer, aStartOffset), + RawRangeBoundary(aEndContainer, aEndOffset)); + } + template + nsresult SetStartAndEnd(const RangeBoundaryBase& aStartBoundary, + const RangeBoundaryBase& aEndBoundary) { + return AbstractRange::SetStartAndEndInternal(aStartBoundary, aEndBoundary, + this); + } + + protected: + /** + * DoSetRange() is called when `AbstractRange::SetStartAndEndInternal()` sets + * mStart and mEnd. + * + * @param aStartBoundary Computed start point. This must equals or be before + * aEndBoundary in the DOM tree order. + * @param aEndBoundary Computed end point. + * @param aRootNode The root node. + */ + template + void DoSetRange(const RangeBoundaryBase& aStartBoundary, + const RangeBoundaryBase& aEndBoundary, + nsINode* aRootNode); + + static nsTArray>* sCachedRanges; + + friend class AbstractRange; +}; + +inline StaticRange* AbstractRange::AsStaticRange() { + MOZ_ASSERT(IsStaticRange()); + return static_cast(this); +} +inline const StaticRange* AbstractRange::AsStaticRange() const { + MOZ_ASSERT(IsStaticRange()); + return static_cast(this); +} + +} // namespace dom +} // namespace mozilla + +#endif // #ifndef mozilla_dom_StaticRange_h -- cgit v1.2.3