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
/*
* Implementation of nsFrameSelection
*/
#include "nsFrameSelection.h"
#include "ErrorList.h"
#include "mozilla/intl/BidiEmbeddingLevel.h"
#include "mozilla/Attributes.h"
#include "mozilla/AutoRestore.h"
#include "mozilla/BasePrincipal.h"
#include "mozilla/HTMLEditor.h"
#include "mozilla/IntegerRange.h"
#include "mozilla/Logging.h"
#include "mozilla/PresShell.h"
#include "mozilla/PseudoStyleType.h"
#include "mozilla/ScrollContainerFrame.h"
#include "mozilla/ScrollTypes.h"
#include "mozilla/StaticAnalysisFunctions.h"
#include "mozilla/StaticPrefs_bidi.h"
#include "mozilla/StaticPrefs_dom.h"
#include "mozilla/StaticPrefs_layout.h"
#include "mozilla/Unused.h"
#include "nsCOMPtr.h"
#include "nsDebug.h"
#include "nsFrameTraversal.h"
#include "nsString.h"
#include "nsISelectionListener.h"
#include "nsDeviceContext.h"
#include "nsIContent.h"
#include "nsRange.h"
#include "nsITableCellLayout.h"
#include "nsTArray.h"
#include "nsTableWrapperFrame.h"
#include "nsTableCellFrame.h"
#include "nsCCUncollectableMarker.h"
#include "nsTextFragment.h"
#include <algorithm>
#include "nsContentUtils.h"
#include "nsCSSFrameConstructor.h"
#include "nsGkAtoms.h"
#include "nsLayoutUtils.h"
#include "nsBidiPresUtils.h"
#include "nsTextFrame.h"
#include "nsThreadUtils.h"
#include "mozilla/Preferences.h"
#include "mozilla/PresShell.h"
#include "nsPresContext.h"
#include "nsCaret.h"
#include "mozilla/MouseEvents.h"
#include "mozilla/TextEvents.h"
// notifications
#include "mozilla/dom/Document.h"
#include "nsISelectionController.h" //for the enums
#include "nsCopySupport.h"
#include "nsIClipboard.h"
#include "nsIFrameInlines.h"
#include "nsError.h"
#include "mozilla/AutoCopyListener.h"
#include "mozilla/dom/AncestorIterator.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/Highlight.h"
#include "mozilla/dom/Selection.h"
#include "mozilla/dom/ShadowRoot.h"
#include "mozilla/dom/StaticRange.h"
#include "mozilla/dom/Text.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/dom/SelectionBinding.h"
#include "mozilla/AsyncEventDispatcher.h"
#include "mozilla/Telemetry.h"
#include "nsFocusManager.h"
#include "nsPIDOMWindow.h"
#include "SelectionMovementUtils.h"
using namespace mozilla;
using namespace mozilla::dom;
static LazyLogModule sFrameSelectionLog("FrameSelection");
namespace mozilla {
extern LazyLogModule sSelectionAPILog;
extern void LogStackForSelectionAPI();
static void LogSelectionAPI(const dom::Selection* aSelection,
const char* aFuncName, const char* aArgName,
const nsIContent* aContent) {
MOZ_LOG(sSelectionAPILog, LogLevel::Info,
("%p nsFrameSelection::%s(%s=%s)", aSelection, aFuncName, aArgName,
aContent ? ToString(*aContent).c_str() : "<nullptr>"));
}
} // namespace mozilla
// #define DEBUG_TABLE 1
/**
* Add cells to the selection inside of the given cells range.
*
* @param aTable [in] HTML table element
* @param aStartRowIndex [in] row index where the cells range starts
* @param aStartColumnIndex [in] column index where the cells range starts
* @param aEndRowIndex [in] row index where the cells range ends
* @param aEndColumnIndex [in] column index where the cells range ends
*/
static nsresult AddCellsToSelection(const nsIContent* aTableContent,
int32_t aStartRowIndex,
int32_t aStartColumnIndex,
int32_t aEndRowIndex,
int32_t aEndColumnIndex,
Selection& aNormalSelection);
static nsAtom* GetTag(nsINode* aNode);
static nsINode* GetClosestInclusiveTableCellAncestor(nsINode* aDomNode);
MOZ_CAN_RUN_SCRIPT_BOUNDARY static nsresult CreateAndAddRange(
nsINode* aContainer, int32_t aOffset, Selection& aNormalSelection);
static nsresult SelectCellElement(nsIContent* aCellElement,
Selection& aNormalSelection);
#ifdef XP_MACOSX
static nsresult UpdateSelectionCacheOnRepaintSelection(Selection* aSel);
#endif // XP_MACOSX
#ifdef PRINT_RANGE
static void printRange(nsRange* aDomRange);
# define DEBUG_OUT_RANGE(x) printRange(x)
#else
# define DEBUG_OUT_RANGE(x)
#endif // PRINT_RANGE
/******************************************************************************
* mozilla::PeekOffsetStruct
******************************************************************************/
// #define DEBUG_SELECTION // uncomment for printf describing every collapse and
// extend. #define DEBUG_NAVIGATION
// #define DEBUG_TABLE_SELECTION 1
namespace mozilla {
PeekOffsetStruct::PeekOffsetStruct(
nsSelectionAmount aAmount, nsDirection aDirection, int32_t aStartOffset,
nsPoint aDesiredCaretPos, const PeekOffsetOptions aOptions,
EWordMovementType aWordMovementType /* = eDefaultBehavior */,
const Element* aAncestorLimiter /* = nullptr */)
: mAmount(aAmount),
mDirection(aDirection),
mStartOffset(aStartOffset),
mDesiredCaretPos(aDesiredCaretPos),
mWordMovementType(aWordMovementType),
mOptions(aOptions),
mAncestorLimiter(aAncestorLimiter),
mResultFrame(nullptr),
mContentOffset(0),
mAttach(CaretAssociationHint::Before) {}
} // namespace mozilla
// Array which contains index of each SelectionType in
// Selection::mDOMSelections. For avoiding using if nor switch to retrieve the
// index, this needs to have -1 for SelectionTypes which won't be created its
// Selection instance.
static const int8_t kIndexOfSelections[] = {
-1, // SelectionType::eInvalid
-1, // SelectionType::eNone
0, // SelectionType::eNormal
1, // SelectionType::eSpellCheck
2, // SelectionType::eIMERawClause
3, // SelectionType::eIMESelectedRawClause
4, // SelectionType::eIMEConvertedClause
5, // SelectionType::eIMESelectedClause
6, // SelectionType::eAccessibility
7, // SelectionType::eFind
8, // SelectionType::eURLSecondary
9, // SelectionType::eURLStrikeout
10, // SelectionType::eTargetText
-1, // SelectionType::eHighlight
};
inline int8_t GetIndexFromSelectionType(SelectionType aSelectionType) {
// The enum value of eInvalid is -1 and the others are sequential value
// starting from 0. Therefore, |SelectionType + 1| is the index of
// kIndexOfSelections.
return kIndexOfSelections[static_cast<int8_t>(aSelectionType) + 1];
}
/*
The limiter is used specifically for the text areas and textfields
In that case it is the DIV tag that is anonymously created for the text
areas/fields. Text nodes and BR nodes fall beneath it. In the case of a
BR node the limiter will be the parent and the offset will point before or
after the BR node. In the case of the text node the parent content is
the text node itself and the offset will be the exact character position.
The offset is not important to check for validity. Simply look at the
passed in content. If it equals the limiter then the selection point is valid.
If its parent it the limiter then the point is also valid. In the case of
NO limiter all points are valid since you are in a topmost iframe. (browser
or composer)
*/
bool nsFrameSelection::NodeIsInLimiters(const nsINode* aContainerNode) const {
return NodeIsInLimiters(aContainerNode, GetLimiter(), GetAncestorLimiter());
}
// static
bool nsFrameSelection::NodeIsInLimiters(
const nsINode* aContainerNode, const Element* aSelectionLimiter,
const Element* aSelectionAncestorLimiter) {
if (!aContainerNode) {
return false;
}
// If there is a selection limiter, it must be the anonymous <div> of a text
// control. The <div> should have only one Text and/or a <br>. Therefore,
// when it's non-nullptr, selection range containers must be the container or
// the Text in it.
if (aSelectionLimiter) {
MOZ_ASSERT(aSelectionLimiter->GetPseudoElementType() ==
PseudoStyleType::mozTextControlEditingRoot);
MOZ_ASSERT(aSelectionLimiter->IsHTMLElement(nsGkAtoms::div));
if (aSelectionLimiter == aContainerNode) {
return true;
}
if (aSelectionLimiter == aContainerNode->GetParent()) {
NS_WARNING_ASSERTION(aContainerNode->IsText(),
ToString(*aContainerNode).c_str());
MOZ_ASSERT(aContainerNode->IsText());
return true;
}
return false;
}
// XXX We might need to return `false` if aContainerNode is in a native
// anonymous subtree, but doing it will make it impossible to select the
// anonymous subtree text in <details>.
return !aSelectionAncestorLimiter ||
aContainerNode->IsInclusiveDescendantOf(aSelectionAncestorLimiter);
}
namespace mozilla {
struct MOZ_RAII AutoPrepareFocusRange {
AutoPrepareFocusRange(Selection* aSelection,
const bool aMultiRangeSelection) {
MOZ_ASSERT(aSelection);
MOZ_ASSERT(aSelection->GetType() == SelectionType::eNormal);
if (aSelection->mStyledRanges.mRanges.Length() <= 1) {
return;
}
if (aSelection->mFrameSelection->IsUserSelectionReason()) {
mUserSelect.emplace(aSelection);
}
nsTArray<StyledRange>& ranges = aSelection->mStyledRanges.mRanges;
if (!aSelection->mUserInitiated || aMultiRangeSelection) {
// Scripted command or the user is starting a new explicit multi-range
// selection.
for (StyledRange& entry : ranges) {
MOZ_ASSERT(entry.mRange->IsDynamicRange());
entry.mRange->AsDynamicRange()->SetIsGenerated(false);
}
return;
}
if (!IsAnchorRelativeOperation(
aSelection->mFrameSelection->mSelectionChangeReasons)) {
return;
}
// This operation is against the anchor but our current mAnchorFocusRange
// represents the focus in a multi-range selection. The anchor from a user
// perspective is the most distant generated range on the opposite side.
// Find that range and make it the mAnchorFocusRange.
nsRange* const newAnchorFocusRange =
FindGeneratedRangeMostDistantFromAnchor(*aSelection);
if (!newAnchorFocusRange) {
// There are no generated ranges - that's fine.
return;
}
// Setup the new mAnchorFocusRange and mark the old one as generated.
if (aSelection->mAnchorFocusRange) {
aSelection->mAnchorFocusRange->SetIsGenerated(true);
}
newAnchorFocusRange->SetIsGenerated(false);
aSelection->mAnchorFocusRange = newAnchorFocusRange;
RemoveGeneratedRanges(*aSelection);
if (aSelection->mFrameSelection) {
aSelection->mFrameSelection->InvalidateDesiredCaretPos();
}
}
private:
static nsRange* FindGeneratedRangeMostDistantFromAnchor(
const Selection& aSelection) {
const nsTArray<StyledRange>& ranges = aSelection.mStyledRanges.mRanges;
const size_t len = ranges.Length();
nsRange* result{nullptr};
if (aSelection.GetDirection() == eDirNext) {
for (size_t i = 0; i < len; ++i) {
// This function is only called for selections with type == eNormal.
// (see MOZ_ASSERT in constructor).
// Therefore, all ranges must be dynamic.
if (ranges[i].mRange->AsDynamicRange()->IsGenerated()) {
result = ranges[i].mRange->AsDynamicRange();
break;
}
}
} else {
size_t i = len;
while (i--) {
if (ranges[i].mRange->AsDynamicRange()->IsGenerated()) {
result = ranges[i].mRange->AsDynamicRange();
break;
}
}
}
return result;
}
static void RemoveGeneratedRanges(Selection& aSelection) {
RefPtr<nsPresContext> presContext = aSelection.GetPresContext();
nsTArray<StyledRange>& ranges = aSelection.mStyledRanges.mRanges;
size_t i = ranges.Length();
while (i--) {
// This function is only called for selections with type == eNormal.
// (see MOZ_ASSERT in constructor).
// Therefore, all ranges must be dynamic.
if (!ranges[i].mRange->IsDynamicRange()) {
continue;
}
nsRange* range = ranges[i].mRange->AsDynamicRange();
if (range->IsGenerated()) {
range->UnregisterSelection(aSelection);
aSelection.SelectFrames(presContext, *range, false);
ranges.RemoveElementAt(i);
}
}
}
/**
* @aParam aSelectionChangeReasons can be multiple of the reasons defined in
nsISelectionListener.idl.
*/
static bool IsAnchorRelativeOperation(const int16_t aSelectionChangeReasons) {
return aSelectionChangeReasons &
(nsISelectionListener::DRAG_REASON |
nsISelectionListener::MOUSEDOWN_REASON |
nsISelectionListener::MOUSEUP_REASON |
nsISelectionListener::COLLAPSETOSTART_REASON);
}
Maybe<Selection::AutoUserInitiated> mUserSelect;
};
} // namespace mozilla
////////////BEGIN nsFrameSelection methods
template Result<RefPtr<nsRange>, nsresult>
nsFrameSelection::CreateRangeExtendedToSomewhere(
PresShell& aPresShell,
const mozilla::LimitersAndCaretData& aLimitersAndCaretData,
const AbstractRange& aRange, nsDirection aRangeDirection,
nsDirection aExtendDirection, nsSelectionAmount aAmount,
CaretMovementStyle aMovementStyle);
template Result<RefPtr<StaticRange>, nsresult>
nsFrameSelection::CreateRangeExtendedToSomewhere(
PresShell& aPresShell,
const mozilla::LimitersAndCaretData& aLimitersAndCaretData,
const AbstractRange& aRange, nsDirection aRangeDirection,
nsDirection aExtendDirection, nsSelectionAmount aAmount,
CaretMovementStyle aMovementStyle);
nsFrameSelection::nsFrameSelection(
PresShell* aPresShell, const bool aAccessibleCaretEnabled,
Element* aEditorRootAnonymousDiv /* = nullptr */) {
for (size_t i = 0; i < std::size(mDomSelections); i++) {
mDomSelections[i] = new Selection(kPresentSelectionTypes[i], this);
}
Selection& sel = NormalSelection();
if (AutoCopyListener::IsEnabled()) {
sel.NotifyAutoCopy();
}
mPresShell = aPresShell;
mDragState = false;
MOZ_ASSERT_IF(aEditorRootAnonymousDiv,
aEditorRootAnonymousDiv->GetPseudoElementType() ==
PseudoStyleType::mozTextControlEditingRoot);
MOZ_ASSERT_IF(aEditorRootAnonymousDiv,
aEditorRootAnonymousDiv->IsHTMLElement(nsGkAtoms::div));
mLimiters.mLimiter = aEditorRootAnonymousDiv;
// This should only ever be initialized on the main thread, so we are OK here.
MOZ_ASSERT(NS_IsMainThread());
mAccessibleCaretEnabled = aAccessibleCaretEnabled;
if (mAccessibleCaretEnabled) {
sel.MaybeNotifyAccessibleCaretEventHub(aPresShell);
}
sel.EnableSelectionChangeEvent();
}
nsFrameSelection::~nsFrameSelection() = default;
NS_IMPL_CYCLE_COLLECTION_CLASS(nsFrameSelection)
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(nsFrameSelection)
for (size_t i = 0; i < std::size(tmp->mDomSelections); ++i) {
tmp->mDomSelections[i] = nullptr;
}
tmp->mHighlightSelections.Clear();
NS_IMPL_CYCLE_COLLECTION_UNLINK(
mTableSelection.mClosestInclusiveTableCellAncestor)
tmp->mTableSelection.mMode = TableSelectionMode::None;
tmp->mTableSelection.mDragSelectingCells = false;
NS_IMPL_CYCLE_COLLECTION_UNLINK(mTableSelection.mStartSelectedCell)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mTableSelection.mEndSelectedCell)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mTableSelection.mAppendStartSelectedCell)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mTableSelection.mUnselectCellOnMouseUp)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mMaintainedRange.mRange)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mLimiters.mLimiter)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mLimiters.mAncestorLimiter)
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(nsFrameSelection)
if (tmp->mPresShell && tmp->mPresShell->GetDocument() &&
nsCCUncollectableMarker::InGeneration(
cb, tmp->mPresShell->GetDocument()->GetMarkedCCGeneration())) {
return NS_SUCCESS_INTERRUPTED_TRAVERSE;
}
for (size_t i = 0; i < std::size(tmp->mDomSelections); ++i) {
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mDomSelections[i])
}
for (const auto& value : tmp->mHighlightSelections) {
CycleCollectionNoteChild(cb, value.second().get(),
"mHighlightSelections[]");
}
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(
mTableSelection.mClosestInclusiveTableCellAncestor)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mTableSelection.mStartSelectedCell)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mTableSelection.mEndSelectedCell)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mTableSelection.mAppendStartSelectedCell)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mTableSelection.mUnselectCellOnMouseUp)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mMaintainedRange.mRange)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mLimiters.mLimiter)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mLimiters.mAncestorLimiter)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
// static
bool nsFrameSelection::Caret::IsVisualMovement(
ExtendSelection aExtendSelection, CaretMovementStyle aMovementStyle) {
int32_t movementFlag = StaticPrefs::bidi_edit_caret_movement_style();
return aMovementStyle == eVisual ||
(aMovementStyle == eUsePrefStyle &&
(movementFlag == 1 ||
(movementFlag == 2 && aExtendSelection == ExtendSelection::No)));
}
// Get the x (or y, in vertical writing mode) position requested
// by the Key Handling for line-up/down
nsresult nsFrameSelection::DesiredCaretPos::FetchPos(
nsPoint& aDesiredCaretPos, const PresShell& aPresShell,
Selection& aNormalSelection) const {
MOZ_ASSERT(aNormalSelection.GetType() == SelectionType::eNormal);
if (mIsSet) {
aDesiredCaretPos = mValue;
return NS_OK;
}
RefPtr<nsCaret> caret = aPresShell.GetCaret();
if (!caret) {
return NS_ERROR_NULL_POINTER;
}
caret->SetSelection(&aNormalSelection);
nsRect coord;
nsIFrame* caretFrame = caret->GetGeometry(&coord);
if (!caretFrame) {
return NS_ERROR_FAILURE;
}
nsPoint viewOffset(0, 0);
nsView* view = nullptr;
caretFrame->GetOffsetFromView(viewOffset, &view);
if (view) {
coord += viewOffset;
}
aDesiredCaretPos = coord.TopLeft();
return NS_OK;
}
void nsFrameSelection::InvalidateDesiredCaretPos() // do not listen to
// mDesiredCaretPos.mValue;
// you must get another.
{
mDesiredCaretPos.Invalidate();
}
void nsFrameSelection::DesiredCaretPos::Invalidate() { mIsSet = false; }
void nsFrameSelection::DesiredCaretPos::Set(const nsPoint& aPos) {
mValue = aPos;
mIsSet = true;
}
nsresult nsFrameSelection::ConstrainFrameAndPointToAnchorSubtree(
nsIFrame* aFrame, const nsPoint& aPoint, nsIFrame** aRetFrame,
nsPoint& aRetPoint) const {
//
// The whole point of this method is to return a frame and point that
// that lie within the same valid subtree as the anchor node's frame,
// for use with the method GetContentAndOffsetsFromPoint().
//
// A valid subtree is defined to be one where all the content nodes in
// the tree have a valid parent-child relationship.
//
// If the anchor frame and aFrame are in the same subtree, aFrame will
// be returned in aRetFrame. If they are in different subtrees, we
// return the frame for the root of the subtree.
//
if (!aFrame || !aRetFrame) {
return NS_ERROR_NULL_POINTER;
}
*aRetFrame = aFrame;
aRetPoint = aPoint;
//
// Get the frame and content for the selection's anchor point!
//
const Selection& sel = NormalSelection();
nsCOMPtr<nsIContent> anchorContent =
nsIContent::FromNodeOrNull(sel.GetMayCrossShadowBoundaryAnchorNode());
if (!anchorContent) {
return NS_ERROR_FAILURE;
}
//
// Now find the root of the subtree containing the anchor's content.
//
NS_ENSURE_STATE(mPresShell);
RefPtr<PresShell> presShell = mPresShell;
nsIContent* anchorRoot =
anchorContent
->GetSelectionRootContent(
presShell,
StaticPrefs::dom_shadowdom_selection_across_boundary_enabled() /* aAllowCrossShadowBoundary */);
NS_ENSURE_TRUE(anchorRoot, NS_ERROR_UNEXPECTED);
//
// Now find the root of the subtree containing aFrame's content.
//
nsCOMPtr<nsIContent> content = aFrame->GetContent();
if (content) {
nsIContent* contentRoot =
content->GetSelectionRootContent(
presShell, StaticPrefs::
dom_shadowdom_selection_across_boundary_enabled() /* aAllowCrossShadowBoundary */);
NS_ENSURE_TRUE(contentRoot, NS_ERROR_UNEXPECTED);
if (anchorRoot == contentRoot) {
// If the aFrame's content isn't the capturing content, it should be
// a descendant. At this time, we can return simply.
nsIContent* capturedContent = PresShell::GetCapturingContent();
if (capturedContent != content) {
return NS_OK;
}
// Find the frame under the mouse cursor with the root frame.
// At this time, don't use the anchor's frame because it may not have
// fixed positioned frames.
nsIFrame* rootFrame = presShell->GetRootFrame();
nsPoint ptInRoot = aPoint + aFrame->GetOffsetTo(rootFrame);
nsIFrame* cursorFrame =
nsLayoutUtils::GetFrameForPoint(RelativeTo{rootFrame}, ptInRoot);
// If the mouse cursor in on a frame which is descendant of same
// selection root, we can expand the selection to the frame.
if (cursorFrame && cursorFrame->PresShell() == presShell) {
nsCOMPtr<nsIContent> cursorContent = cursorFrame->GetContent();
NS_ENSURE_TRUE(cursorContent, NS_ERROR_FAILURE);
nsIContent* cursorContentRoot = cursorContent->GetSelectionRootContent(
presShell, StaticPrefs::
dom_shadowdom_selection_across_boundary_enabled() /* aAllowCrossShadowBoundary */);
NS_ENSURE_TRUE(cursorContentRoot, NS_ERROR_UNEXPECTED);
if (cursorContentRoot == anchorRoot) {
*aRetFrame = cursorFrame;
aRetPoint = aPoint + aFrame->GetOffsetTo(cursorFrame);
return NS_OK;
}
}
// Otherwise, e.g., the cursor isn't on any frames (e.g., the mouse
// cursor is out of the window), we should use the frame of the anchor
// root.
}
}
//
// When we can't find a frame which is under the mouse cursor and has a same
// selection root as the anchor node's, we should return the selection root
// frame.
//
*aRetFrame = anchorRoot->GetPrimaryFrame();
if (!*aRetFrame) {
return NS_ERROR_FAILURE;
}
//
// Now make sure that aRetPoint is converted to the same coordinate
// system used by aRetFrame.
//
aRetPoint = aPoint + aFrame->GetOffsetTo(*aRetFrame);
return NS_OK;
}
void nsFrameSelection::SetCaretBidiLevelAndMaybeSchedulePaint(
mozilla::intl::BidiEmbeddingLevel aLevel) {
// If the current level is undefined, we have just inserted new text.
// In this case, we don't want to reset the keyboard language
mCaret.mBidiLevel = aLevel;
RefPtr<nsCaret> caret;
if (mPresShell && (caret = mPresShell->GetCaret())) {
caret->SchedulePaint();
}
}
mozilla::intl::BidiEmbeddingLevel nsFrameSelection::GetCaretBidiLevel() const {
return mCaret.mBidiLevel;
}
void nsFrameSelection::UndefineCaretBidiLevel() {
mCaret.mBidiLevel = mozilla::intl::BidiEmbeddingLevel(mCaret.mBidiLevel |
BIDI_LEVEL_UNDEFINED);
}
#ifdef PRINT_RANGE
void printRange(nsRange* aDomRange) {
if (!aDomRange) {
printf("NULL Range\n");
}
nsINode* startNode = aDomRange->GetStartContainer();
nsINode* endNode = aDomRange->GetEndContainer();
int32_t startOffset = aDomRange->StartOffset();
int32_t endOffset = aDomRange->EndOffset();
printf("range: 0x%lx\t start: 0x%lx %ld, \t end: 0x%lx,%ld\n",
(unsigned long)aDomRange, (unsigned long)startNode, (long)startOffset,
(unsigned long)endNode, (long)endOffset);
}
#endif /* PRINT_RANGE */
static nsAtom* GetTag(nsINode* aNode) {
nsCOMPtr<nsIContent> content = do_QueryInterface(aNode);
if (!content) {
MOZ_ASSERT_UNREACHABLE("bad node passed to GetTag()");
return nullptr;
}
return content->NodeInfo()->NameAtom();
}
/**
*/
static nsINode* GetClosestInclusiveTableCellAncestor(nsINode* aDomNode) {
if (!aDomNode) {
return nullptr;
}
nsINode* current = aDomNode;
// Start with current node and look for a table cell
while (current) {
nsAtom* tag = GetTag(current);
if (tag == nsGkAtoms::td || tag == nsGkAtoms::th) {
return current;
}
current = current->GetParent();
}
return nullptr;
}
static nsDirection GetCaretDirection(const nsIFrame& aFrame,
nsDirection aDirection,
bool aVisualMovement) {
const mozilla::intl::BidiDirection paragraphDirection =
nsBidiPresUtils::ParagraphDirection(&aFrame);
return (aVisualMovement &&
paragraphDirection == mozilla::intl::BidiDirection::RTL)
? nsDirection(1 - aDirection)
: aDirection;
}
nsresult nsFrameSelection::MoveCaret(nsDirection aDirection,
ExtendSelection aExtendSelection,
const nsSelectionAmount aAmount,
CaretMovementStyle aMovementStyle) {
NS_ENSURE_STATE(mPresShell);
// Flush out layout, since we need it to be up to date to do caret
// positioning.
OwningNonNull<PresShell> presShell(*mPresShell);
presShell->FlushPendingNotifications(FlushType::Layout);
if (!mPresShell) {
return NS_OK;
}
nsPresContext* context = mPresShell->GetPresContext();
if (!context) {
return NS_ERROR_FAILURE;
}
const RefPtr<Selection> sel = &NormalSelection();
auto scrollFlags = ScrollFlags::None;
if (sel->IsEditorSelection()) {
// If caret moves in editor, it should cause scrolling even if it's in
// overflow: hidden;.
scrollFlags |= ScrollFlags::ScrollOverflowHidden;
}
const bool doCollapse = [&] {
if (sel->IsCollapsed() || aExtendSelection == ExtendSelection::Yes) {
return false;
}
if (aAmount > eSelectLine) {
return false;
}
int32_t caretStyle = StaticPrefs::layout_selection_caret_style();
return caretStyle == 2 || (caretStyle == 0 && aAmount != eSelectLine);
}();
if (doCollapse) {
if (aDirection == eDirPrevious) {
SetChangeReasons(nsISelectionListener::COLLAPSETOSTART_REASON);
mCaret.mHint = CaretAssociationHint::After;
} else {
SetChangeReasons(nsISelectionListener::COLLAPSETOEND_REASON);
mCaret.mHint = CaretAssociationHint::Before;
}
} else {
SetChangeReasons(nsISelectionListener::KEYPRESS_REASON);
}
mCaretMoveAmount = aAmount;
AutoPrepareFocusRange prep(sel, false);
// we must keep this around and revalidate it when its just UP/DOWN
nsPoint desiredPos(0, 0);
if (aAmount == eSelectLine) {
nsresult result = mDesiredCaretPos.FetchPos(desiredPos, *mPresShell, *sel);
if (NS_FAILED(result)) {
return result;
}
mDesiredCaretPos.Set(desiredPos);
}
bool visualMovement =
Caret::IsVisualMovement(aExtendSelection, aMovementStyle);
const PrimaryFrameData frameForFocus =
sel->GetPrimaryFrameForCaretAtFocusNode(visualMovement);
if (!frameForFocus.mFrame) {
return NS_ERROR_FAILURE;
}
if (visualMovement) {
// FYI: This was done during a call of GetPrimaryFrameForCaretAtFocusNode.
// Therefore, this may not be intended by the original author.
SetHint(frameForFocus.mHint);
}
Result<bool, nsresult> isIntraLineCaretMove =
SelectionMovementUtils::IsIntraLineCaretMove(aAmount);
nsDirection direction{aDirection};
if (isIntraLineCaretMove.isErr()) {
return isIntraLineCaretMove.unwrapErr();
}
if (isIntraLineCaretMove.inspect()) {
// Forget old caret position for moving caret to different line since
// caret position may be changed.
mDesiredCaretPos.Invalidate();
direction =
GetCaretDirection(*frameForFocus.mFrame, aDirection, visualMovement);
}
if (doCollapse) {
const nsRange* anchorFocusRange = sel->GetAnchorFocusRange();
if (anchorFocusRange) {
RefPtr<nsINode> node;
uint32_t offset;
if (visualMovement &&
nsBidiPresUtils::IsReversedDirectionFrame(frameForFocus.mFrame)) {
direction = nsDirection(1 - direction);
}
if (direction == eDirPrevious) {
node = anchorFocusRange->GetStartContainer();
offset = anchorFocusRange->StartOffset();
} else {
node = anchorFocusRange->GetEndContainer();
offset = anchorFocusRange->EndOffset();
}
sel->CollapseInLimiter(node, offset);
}
sel->ScrollIntoView(nsISelectionController::SELECTION_FOCUS_REGION,
ScrollAxis(), ScrollAxis(), scrollFlags);
return NS_OK;
}
CaretAssociationHint tHint(
mCaret.mHint); // temporary variable so we dont set
// mCaret.mHint until it is necessary
Result<PeekOffsetOptions, nsresult> options =
CreatePeekOffsetOptionsForCaretMove(sel, aExtendSelection,
aMovementStyle);
if (options.isErr()) {
return options.propagateErr();
}
Result<const dom::Element*, nsresult> ancestorLimiter =
GetAncestorLimiterForCaretMove(sel);
if (ancestorLimiter.isErr()) {
return ancestorLimiter.propagateErr();
}
nsIContent* content = nsIContent::FromNodeOrNull(sel->GetFocusNode());
Result<PeekOffsetStruct, nsresult> result =
SelectionMovementUtils::PeekOffsetForCaretMove(
content, sel->FocusOffset(), direction, GetHint(),
GetCaretBidiLevel(), aAmount, desiredPos, options.unwrap(),
ancestorLimiter.unwrap());
nsresult rv;
if (result.isOk() && result.inspect().mResultContent) {
const PeekOffsetStruct& pos = result.inspect();
nsIFrame* theFrame;
int32_t frameStart, frameEnd;
if (aAmount <= eSelectWordNoSpace) {
// For left/right, PeekOffset() sets pos.mResultFrame correctly, but does
// not set pos.mAttachForward, so determine the hint here based on the
// result frame and offset: If we're at the end of a text frame, set the
// hint to ASSOCIATE_BEFORE to indicate that we want the caret displayed
// at the end of this frame, not at the beginning of the next one.
theFrame = pos.mResultFrame;
std::tie(frameStart, frameEnd) = theFrame->GetOffsets();
if (frameEnd == pos.mContentOffset &&
!(frameStart == 0 && frameEnd == 0)) {
tHint = CaretAssociationHint::Before;
} else {
tHint = CaretAssociationHint::After;
}
} else {
// For up/down and home/end, pos.mResultFrame might not be set correctly,
// or not at all. In these cases, get the frame based on the content and
// hint returned by PeekOffset().
tHint = pos.mAttach;
theFrame = SelectionMovementUtils::GetFrameForNodeOffset(
pos.mResultContent, pos.mContentOffset, tHint);
if (!theFrame) {
return NS_ERROR_FAILURE;
}
std::tie(frameStart, frameEnd) = theFrame->GetOffsets();
}
if (context->BidiEnabled()) {
switch (aAmount) {
case eSelectBeginLine:
case eSelectEndLine: {
// In Bidi contexts, PeekOffset calculates pos.mContentOffset
// differently depending on whether the movement is visual or logical.
// For visual movement, pos.mContentOffset depends on the direction-
// ality of the first/last frame on the line (theFrame), and the caret
// directionality must correspond.
FrameBidiData bidiData = theFrame->GetBidiData();
SetCaretBidiLevelAndMaybeSchedulePaint(
visualMovement ? bidiData.embeddingLevel : bidiData.baseLevel);
break;
}
default:
// If the current position is not a frame boundary, it's enough just
// to take the Bidi level of the current frame
if ((pos.mContentOffset != frameStart &&
pos.mContentOffset != frameEnd) ||
eSelectLine == aAmount) {
SetCaretBidiLevelAndMaybeSchedulePaint(
theFrame->GetEmbeddingLevel());
} else {
BidiLevelFromMove(mPresShell, pos.mResultContent,
pos.mContentOffset, aAmount, tHint);
}
}
}
// "pos" is on the stack, so pos.mResultContent has stack lifetime, so using
// MOZ_KnownLive is ok.
const FocusMode focusMode = aExtendSelection == ExtendSelection::Yes
? FocusMode::kExtendSelection
: FocusMode::kCollapseToNewPoint;
rv = TakeFocus(MOZ_KnownLive(*pos.mResultContent), pos.mContentOffset,
pos.mContentOffset, tHint, focusMode);
} else if (aAmount <= eSelectWordNoSpace && direction == eDirNext &&
aExtendSelection == ExtendSelection::No) {
// Collapse selection if PeekOffset failed, we either
bool isBRFrame = frameForFocus.mFrame->IsBrFrame();
RefPtr<nsINode> node = sel->GetFocusNode();
sel->CollapseInLimiter(node, sel->FocusOffset());
// Note: 'frameForFocus.mFrame' might be dead here.
if (!isBRFrame) {
mCaret.mHint = CaretAssociationHint::Before; // We're now at the end of
// the frame to the left.
}
rv = NS_OK;
} else {
rv = result.isErr() ? result.unwrapErr() : NS_OK;
}
if (NS_SUCCEEDED(rv)) {
rv = sel->ScrollIntoView(nsISelectionController::SELECTION_FOCUS_REGION,
ScrollAxis(), ScrollAxis(), scrollFlags);
}
return rv;
}
// static
Result<PeekOffsetOptions, nsresult>
nsFrameSelection::CreatePeekOffsetOptionsForCaretMove(
const Element* aSelectionLimiter, ForceEditableRegion aForceEditableRegion,
ExtendSelection aExtendSelection, CaretMovementStyle aMovementStyle) {
PeekOffsetOptions options;
// set data using aSelectionLimiter to stop on scroll views. If we have a
// limiter then we stop peeking when we hit scrollable views. If no limiter
// then just let it go ahead
if (aSelectionLimiter) {
options += PeekOffsetOption::StopAtScroller;
}
const bool visualMovement =
Caret::IsVisualMovement(aExtendSelection, aMovementStyle);
if (visualMovement) {
options += PeekOffsetOption::Visual;
}
if (aExtendSelection == ExtendSelection::Yes) {
options += PeekOffsetOption::Extend;
}
if (static_cast<bool>(aForceEditableRegion)) {
options += PeekOffsetOption::ForceEditableRegion;
}
return options;
}
Result<Element*, nsresult> nsFrameSelection::GetAncestorLimiterForCaretMove(
dom::Selection* aSelection) const {
if (!mPresShell) {
return Err(NS_ERROR_NULL_POINTER);
}
MOZ_ASSERT(aSelection);
nsIContent* content = nsIContent::FromNodeOrNull(aSelection->GetFocusNode());
if (!content) {
return Err(NS_ERROR_FAILURE);
}
MOZ_ASSERT(mPresShell->GetDocument() == content->GetComposedDoc());
Element* ancestorLimiter = GetAncestorLimiter();
if (aSelection->IsEditorSelection()) {
// If the editor has not receive `focus` event, it may have not set ancestor
// limiter. Then, we need to compute it here for the caret move.
if (!ancestorLimiter) {
// Editing hosts can be nested. Therefore, computing selection root from
// selection range may be different from the focused editing host.
// Therefore, we may need to use a non-closest inclusive ancestor editing
// host of selection range container. On the other hand, selection ranges
// may be outside of focused editing host. In such case, we should use
// the closest editing host as the ancestor limiter instead.
PresShell* const presShell = aSelection->GetPresShell();
const Document* const doc =
presShell ? presShell->GetDocument() : nullptr;
if (const nsPIDOMWindowInner* const win =
doc ? doc->GetInnerWindow() : nullptr) {
Element* const focusedElement = win->GetFocusedElement();
Element* closestEditingHost = nullptr;
for (Element* element : content->InclusiveAncestorsOfType<Element>()) {
if (element->IsEditingHost()) {
if (!closestEditingHost) {
closestEditingHost = element;
}
if (focusedElement == element) {
ancestorLimiter = focusedElement;
break;
}
}
}
if (!ancestorLimiter) {
ancestorLimiter = closestEditingHost;
}
}
// If it's the root element, we don't need to limit the new caret
// position.
if (ancestorLimiter && !ancestorLimiter->GetParent()) {
ancestorLimiter = nullptr;
}
}
}
return ancestorLimiter;
}
nsPrevNextBidiLevels nsFrameSelection::GetPrevNextBidiLevels(
nsIContent* aNode, uint32_t aContentOffset, bool aJumpLines) const {
return SelectionMovementUtils::GetPrevNextBidiLevels(
aNode, aContentOffset, mCaret.mHint, aJumpLines);
}
nsresult nsFrameSelection::MaintainSelection(nsSelectionAmount aAmount) {
const Selection& sel = NormalSelection();
mMaintainedRange.MaintainAnchorFocusRange(sel, aAmount);
return NS_OK;
}
void nsFrameSelection::BidiLevelFromMove(PresShell* aPresShell,
nsIContent* aNode,
uint32_t aContentOffset,
nsSelectionAmount aAmount,
CaretAssociationHint aHint) {
switch (aAmount) {
// Movement within the line: the new cursor Bidi level is the level of the
// last character moved over
case eSelectCharacter:
case eSelectCluster:
case eSelectWord:
case eSelectWordNoSpace:
case eSelectBeginLine:
case eSelectEndLine:
case eSelectNoAmount: {
nsPrevNextBidiLevels levels =
SelectionMovementUtils::GetPrevNextBidiLevels(aNode, aContentOffset,
aHint, false);
SetCaretBidiLevelAndMaybeSchedulePaint(
aHint == CaretAssociationHint::Before ? levels.mLevelBefore
: levels.mLevelAfter);
break;
}
/*
// Up and Down: the new cursor Bidi level is the smaller of the two
surrounding characters case eSelectLine: case eSelectParagraph:
GetPrevNextBidiLevels(aContext, aNode, aContentOffset, &firstFrame,
&secondFrame, &firstLevel, &secondLevel);
aPresShell->SetCaretBidiLevelAndMaybeSchedulePaint(std::min(firstLevel,
secondLevel)); break;
*/
default:
UndefineCaretBidiLevel();
}
}
void nsFrameSelection::BidiLevelFromClick(nsIContent* aNode,
uint32_t aContentOffset) {
nsIFrame* clickInFrame = nullptr;
clickInFrame = SelectionMovementUtils::GetFrameForNodeOffset(
aNode, aContentOffset, mCaret.mHint);
if (!clickInFrame) {
return;
}
SetCaretBidiLevelAndMaybeSchedulePaint(clickInFrame->GetEmbeddingLevel());
}
void nsFrameSelection::MaintainedRange::AdjustNormalSelection(
const nsIContent* aContent, const int32_t aOffset,
Selection& aNormalSelection) const {
MOZ_ASSERT(aNormalSelection.Type() == SelectionType::eNormal);
if (!mRange || !aContent) {
return;
}
nsINode* rangeStartNode = mRange->GetStartContainer();
nsINode* rangeEndNode = mRange->GetEndContainer();
const uint32_t rangeStartOffset = mRange->StartOffset();
const uint32_t rangeEndOffset = mRange->EndOffset();
NS_ASSERTION(aOffset >= 0, "aOffset should not be negative");
const Maybe<int32_t> relToStart =
nsContentUtils::ComparePoints_AllowNegativeOffsets(
rangeStartNode, rangeStartOffset, aContent, aOffset);
if (NS_WARN_IF(!relToStart)) {
// Potentially handle this properly when Selection across Shadow DOM
// boundary is implemented
return;
}
const Maybe<int32_t> relToEnd =
nsContentUtils::ComparePoints_AllowNegativeOffsets(
rangeEndNode, rangeEndOffset, aContent, aOffset);
if (NS_WARN_IF(!relToEnd)) {
// Potentially handle this properly when Selection across Shadow DOM
// boundary is implemented
return;
}
// If aContent/aOffset is inside (or at the edge of) the maintained
// selection, or if it is on the "anchor" side of the maintained selection,
// we need to do something.
if ((*relToStart <= 0 && *relToEnd >= 0) ||
(*relToStart > 0 && aNormalSelection.GetDirection() == eDirNext) ||
(*relToEnd < 0 && aNormalSelection.GetDirection() == eDirPrevious)) {
// Set the current range to the maintained range.
aNormalSelection.ReplaceAnchorFocusRange(mRange);
// Set the direction of the selection so that the anchor will be on the
// far side of the maintained selection, relative to aContent/aOffset.
aNormalSelection.SetDirection(*relToStart > 0 ? eDirPrevious : eDirNext);
}
}
void nsFrameSelection::MaintainedRange::AdjustContentOffsets(
nsIFrame::ContentOffsets& aOffsets, StopAtScroller aStopAtScroller) const {
// Adjust offsets according to maintained amount
if (mRange && mAmount != eSelectNoAmount) {
const Maybe<int32_t> relativePosition = nsContentUtils::ComparePoints(
mRange->StartRef(),
RawRangeBoundary(aOffsets.content, aOffsets.offset,
RangeBoundaryIsMutationObserved::No));
if (NS_WARN_IF(!relativePosition)) {
// Potentially handle this properly when Selection across Shadow DOM
// boundary is implemented
return;
}
nsDirection direction = *relativePosition > 0 ? eDirPrevious : eDirNext;
nsSelectionAmount amount = mAmount;
if (amount == eSelectBeginLine && direction == eDirNext) {
amount = eSelectEndLine;
}
uint32_t offset;
nsIFrame* frame = SelectionMovementUtils::GetFrameForNodeOffset(
aOffsets.content, aOffsets.offset, CaretAssociationHint::After,
&offset);
PeekOffsetOptions peekOffsetOptions{};
if (aStopAtScroller == StopAtScroller::Yes) {
peekOffsetOptions += PeekOffsetOption::StopAtScroller;
}
if (frame && amount == eSelectWord && direction == eDirPrevious) {
// To avoid selecting the previous word when at start of word,
// first move one character forward.
PeekOffsetStruct charPos(eSelectCharacter, eDirNext,
static_cast<int32_t>(offset), nsPoint(0, 0),
peekOffsetOptions);
if (NS_SUCCEEDED(frame->PeekOffset(&charPos))) {
frame = charPos.mResultFrame;
offset = charPos.mContentOffset;
}
}
PeekOffsetStruct pos(amount, direction, static_cast<int32_t>(offset),
nsPoint(0, 0), peekOffsetOptions);
if (frame && NS_SUCCEEDED(frame->PeekOffset(&pos)) && pos.mResultContent) {
aOffsets.content = pos.mResultContent;
aOffsets.offset = pos.mContentOffset;
}
}
}
void nsFrameSelection::MaintainedRange::MaintainAnchorFocusRange(
const Selection& aNormalSelection, const nsSelectionAmount aAmount) {
MOZ_ASSERT(aNormalSelection.Type() == SelectionType::eNormal);
mAmount = aAmount;
const nsRange* anchorFocusRange = aNormalSelection.GetAnchorFocusRange();
if (anchorFocusRange && aAmount != eSelectNoAmount) {
mRange = anchorFocusRange->CloneRange();
return;
}
mRange = nullptr;
}
nsresult nsFrameSelection::HandleClick(nsIContent* aNewFocus,
uint32_t aContentOffset,
uint32_t aContentEndOffset,
const FocusMode aFocusMode,
CaretAssociationHint aHint) {
if (!aNewFocus) {
return NS_ERROR_INVALID_ARG;
}
if (MOZ_LOG_TEST(sFrameSelectionLog, LogLevel::Debug)) {
const Selection& sel = NormalSelection();
MOZ_LOG(sFrameSelectionLog, LogLevel::Debug,
("%s: selection=%p, new focus=%p, offsets=(%u,%u), focus mode=%i",
__FUNCTION__, &sel, aNewFocus, aContentOffset, aContentEndOffset,
static_cast<int>(aFocusMode)));
}
mDesiredCaretPos.Invalidate();
if (aFocusMode != FocusMode::kExtendSelection) {
mMaintainedRange.mRange = nullptr;
if (!NodeIsInLimiters(aNewFocus)) {
mLimiters.mAncestorLimiter = nullptr;
}
}
// Don't take focus when dragging off of a table
if (!mTableSelection.mDragSelectingCells) {
BidiLevelFromClick(aNewFocus, aContentOffset);
SetChangeReasons(nsISelectionListener::MOUSEDOWN_REASON +
nsISelectionListener::DRAG_REASON);
RefPtr<Selection> selection = &NormalSelection();
if (aFocusMode == FocusMode::kExtendSelection) {
mMaintainedRange.AdjustNormalSelection(aNewFocus, aContentOffset,
*selection);
}
AutoPrepareFocusRange prep(selection,
aFocusMode == FocusMode::kMultiRangeSelection);
return