Source code
Revision control
Copy as Markdown
Other Tools
/* -*- 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
#ifndef mozilla_dom_StaticRange_h
#define mozilla_dom_StaticRange_h
#include "mozilla/RangeBoundary.h"
#include "mozilla/RangeUtils.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 : public AbstractRange {
public:
StaticRange() = delete;
explicit StaticRange(const StaticRange& aOther) = delete;
static already_AddRefed<StaticRange> 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<StaticRange> 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<StaticRange> Create(
const AbstractRange* aAbstractRange, ErrorResult& aRv) {
MOZ_ASSERT(aAbstractRange);
return StaticRange::Create(aAbstractRange->StartRef(),
aAbstractRange->EndRef(), aRv);
}
static already_AddRefed<StaticRange> 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 <typename SPT, typename SRT, typename EPT, typename ERT>
static already_AddRefed<StaticRange> Create(
const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& aEndBoundary, ErrorResult& aRv);
/**
* Returns true if the range is valid.
*
*/
bool IsValid() const;
private:
// Whether the start and end points are in the same tree.
// They could be in different trees, i.e, cross shadow boundaries.
bool mAreStartAndEndInSameTree = false;
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<JSObject*> 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 <typename SPT, typename SRT, typename EPT, typename ERT>
nsresult SetStartAndEnd(const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& 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 <typename SPT, typename SRT, typename EPT, typename ERT>
void DoSetRange(const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& aEndBoundary,
nsINode* aRootNode);
static nsTArray<RefPtr<StaticRange>>* sCachedRanges;
friend class AbstractRange;
};
inline StaticRange* AbstractRange::AsStaticRange() {
MOZ_ASSERT(IsStaticRange());
return static_cast<StaticRange*>(this);
}
inline const StaticRange* AbstractRange::AsStaticRange() const {
MOZ_ASSERT(IsStaticRange());
return static_cast<const StaticRange*>(this);
}
} // namespace dom
} // namespace mozilla
#endif // #ifndef mozilla_dom_StaticRange_h