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
* file, You can obtain one at */
#ifndef mozilla_dom_AbstractRange_h
#define mozilla_dom_AbstractRange_h
#include <cstdint>
#include <ostream>
#include "ErrorList.h"
#include "js/RootingAPI.h"
#include "mozilla/Assertions.h"
#include "mozilla/Maybe.h"
#include "mozilla/RangeBoundary.h"
#include "mozilla/RefPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsISupports.h"
#include "nsWrapperCache.h"
class JSObject;
class nsIContent;
class nsINode;
class nsRange;
struct JSContext;
namespace mozilla::dom {
class StaticRange;
class Document;
class AbstractRange : public nsISupports, public nsWrapperCache {
explicit AbstractRange(nsINode* aNode, bool aIsDynamicRange);
virtual ~AbstractRange();
AbstractRange() = delete;
explicit AbstractRange(const AbstractRange& aOther) = delete;
* Called when the process is shutting down.
static void Shutdown();
const RangeBoundary& StartRef() const { return mStart; }
const RangeBoundary& EndRef() const { return mEnd; }
nsIContent* GetChildAtStartOffset() const {
return mStart.GetChildAtOffset();
nsIContent* GetChildAtEndOffset() const { return mEnd.GetChildAtOffset(); }
bool IsPositioned() const { return mIsPositioned; }
nsINode* GetClosestCommonInclusiveAncestor() const;
// WebIDL
// If Range is created from JS, it's initialized with Document.createRange()
// and it collaps the range to start of the Document. Therefore, the
// following WebIDL methods are called only when `mIsPositioned` is true.
// So, it does not make sense to take `ErrorResult` as their parameter
// since its destruction cost may appear in profile. If you create range
// object from C++ and needs to check whether it's positioned, should call
// `IsPositioned()` directly.
nsINode* GetStartContainer() const { return mStart.Container(); }
nsINode* GetEndContainer() const { return mEnd.Container(); }
Document* GetComposedDocOfContainers() const {
return mStart.Container() ? mStart.Container()->GetComposedDoc() : nullptr;
// FYI: Returns 0 if it's not positioned.
uint32_t StartOffset() const {
return static_cast<uint32_t>(
// FYI: Returns 0 if it's not positioned.
uint32_t EndOffset() const {
return static_cast<uint32_t>(
bool Collapsed() const {
return !mIsPositioned || (mStart.Container() == mEnd.Container() &&
StartOffset() == EndOffset());
nsINode* GetParentObject() const;
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
bool HasEqualBoundaries(const AbstractRange& aOther) const {
return (mStart == aOther.mStart) && (mEnd == aOther.mEnd);
bool IsDynamicRange() const { return mIsDynamicRange; }
bool IsStaticRange() const { return !mIsDynamicRange; }
inline nsRange* AsDynamicRange();
inline const nsRange* AsDynamicRange() const;
inline StaticRange* AsStaticRange();
inline const StaticRange* AsStaticRange() const;
template <typename SPT, typename SRT, typename EPT, typename ERT,
typename RangeType>
static nsresult SetStartAndEndInternal(
const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& aEndBoundary, RangeType* aRange);
template <class RangeType>
static bool MaybeCacheToReuse(RangeType& aInstance);
void Init(nsINode* aNode);
friend std::ostream& operator<<(std::ostream& aStream,
const AbstractRange& aRange) {
if (aRange.Collapsed()) {
aStream << "{ mStart=mEnd=" << aRange.mStart;
} else {
aStream << "{ mStart=" << aRange.mStart << ", mEnd=" << aRange.mEnd;
return aStream << ", mIsGenerated="
<< (aRange.mIsGenerated ? "true" : "false")
<< ", mCalledByJS="
<< (aRange.mIsPositioned ? "true" : "false")
<< ", mIsDynamicRange="
<< (aRange.mIsDynamicRange ? "true" : "false") << " }";
void ClearForReuse();
RefPtr<Document> mOwner;
RangeBoundary mStart;
RangeBoundary mEnd;
// `true` if `mStart` and `mEnd` are set for StaticRange or set and valid
// for nsRange.
bool mIsPositioned;
// Used by nsRange, but this should have this for minimizing the size.
bool mIsGenerated;
// Used by nsRange, but this should have this for minimizing the size.
bool mCalledByJS;
// true if this is an `nsRange` object.
const bool mIsDynamicRange;
static bool sHasShutDown;
} // namespace mozilla::dom
#endif // #ifndef mozilla_dom_AbstractRange_h