forked from mirrors/gecko-dev
130 lines
4 KiB
C++
130 lines
4 KiB
C++
/* -*- 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_AbstractRange_h
|
|
#define mozilla_dom_AbstractRange_h
|
|
|
|
#include <cstdint>
|
|
#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;
|
|
struct JSContext;
|
|
|
|
namespace mozilla::dom {
|
|
|
|
class Document;
|
|
|
|
class AbstractRange : public nsISupports, public nsWrapperCache {
|
|
protected:
|
|
explicit AbstractRange(nsINode* aNode);
|
|
virtual ~AbstractRange();
|
|
|
|
public:
|
|
AbstractRange() = delete;
|
|
explicit AbstractRange(const AbstractRange& aOther) = delete;
|
|
|
|
/**
|
|
* Called when the process is shutting down.
|
|
*/
|
|
static void Shutdown();
|
|
|
|
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
|
|
NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(AbstractRange)
|
|
|
|
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; }
|
|
/**
|
|
* https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
|
|
*/
|
|
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(); }
|
|
|
|
// FYI: Returns 0 if it's not positioned.
|
|
uint32_t StartOffset() const {
|
|
return static_cast<uint32_t>(
|
|
*mStart.Offset(RangeBoundary::OffsetFilter::kValidOrInvalidOffsets));
|
|
}
|
|
|
|
// FYI: Returns 0 if it's not positioned.
|
|
uint32_t EndOffset() const {
|
|
return static_cast<uint32_t>(
|
|
*mEnd.Offset(RangeBoundary::OffsetFilter::kValidOrInvalidOffsets));
|
|
}
|
|
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);
|
|
}
|
|
|
|
protected:
|
|
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);
|
|
|
|
private:
|
|
void ClearForReuse();
|
|
|
|
protected:
|
|
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;
|
|
|
|
static bool sHasShutDown;
|
|
};
|
|
|
|
} // namespace mozilla::dom
|
|
|
|
#endif // #ifndef mozilla_dom_AbstractRange_h
|