VisibleSelection.cpp [plain text]
#include "config.h"
#include "VisibleSelection.h"
#include "Document.h"
#include "Editing.h"
#include "Element.h"
#include "HTMLInputElement.h"
#include "Settings.h"
#include "ShadowRoot.h"
#include "TextIterator.h"
#include "VisibleUnits.h"
#include <stdio.h>
#include <wtf/Assertions.h>
#include <wtf/text/CString.h>
#include <wtf/text/StringBuilder.h>
#include <wtf/text/TextStream.h>
#include <wtf/unicode/CharacterNames.h>
namespace WebCore {
VisibleSelection::VisibleSelection()
: m_affinity(DOWNSTREAM)
, m_selectionType(NoSelection)
, m_baseIsFirst(true)
, m_isDirectional(false)
{
}
VisibleSelection::VisibleSelection(const Position& pos, EAffinity affinity, bool isDirectional)
: m_base(pos)
, m_extent(pos)
, m_affinity(affinity)
, m_isDirectional(isDirectional)
{
validate();
}
VisibleSelection::VisibleSelection(const Position& base, const Position& extent, EAffinity affinity, bool isDirectional)
: m_base(base)
, m_extent(extent)
, m_affinity(affinity)
, m_isDirectional(isDirectional)
{
validate();
}
VisibleSelection::VisibleSelection(const VisiblePosition& pos, bool isDirectional)
: m_base(pos.deepEquivalent())
, m_extent(pos.deepEquivalent())
, m_affinity(pos.affinity())
, m_isDirectional(isDirectional)
{
validate();
}
VisibleSelection::VisibleSelection(const VisiblePosition& base, const VisiblePosition& extent, bool isDirectional)
: m_base(base.deepEquivalent())
, m_extent(extent.deepEquivalent())
, m_affinity(base.affinity())
, m_isDirectional(isDirectional)
{
validate();
}
VisibleSelection::VisibleSelection(const SimpleRange& range, EAffinity affinity, bool isDirectional)
: m_base(createLegacyEditingPosition(&range.startContainer(), range.startOffset()))
, m_extent(createLegacyEditingPosition(&range.endContainer(), range.endOffset()))
, m_affinity(affinity)
, m_isDirectional(isDirectional)
{
ASSERT(&range.startContainer().treeScope() == &range.endContainer().treeScope());
validate();
}
VisibleSelection VisibleSelection::selectionFromContentsOfNode(Node* node)
{
ASSERT(!editingIgnoresContent(*node));
return VisibleSelection(firstPositionInNode(node), lastPositionInNode(node), DOWNSTREAM);
}
void VisibleSelection::setBase(const Position& position)
{
m_base = position;
validate();
}
void VisibleSelection::setBase(const VisiblePosition& visiblePosition)
{
m_base = visiblePosition.deepEquivalent();
validate();
}
void VisibleSelection::setExtent(const Position& position)
{
m_extent = position;
validate();
}
void VisibleSelection::setExtent(const VisiblePosition& visiblePosition)
{
m_extent = visiblePosition.deepEquivalent();
validate();
}
Optional<SimpleRange> VisibleSelection::firstRange() const
{
if (isNoneOrOrphaned())
return WTF::nullopt;
return makeSimpleRange(m_start.parentAnchoredEquivalent(), m_end.parentAnchoredEquivalent());
}
Optional<SimpleRange> VisibleSelection::toNormalizedRange() const
{
if (isNoneOrOrphaned())
return WTF::nullopt;
m_start.anchorNode()->document().updateLayout();
if (isNoneOrOrphaned())
return WTF::nullopt;
Position s, e;
if (isCaret()) {
s = m_start.upstream().parentAnchoredEquivalent();
e = s;
} else {
ASSERT(isRange());
s = m_start.downstream();
e = m_end.upstream();
if (comparePositions(s, e) > 0) {
std::swap(s, e);
}
s = s.parentAnchoredEquivalent();
e = e.parentAnchoredEquivalent();
}
return makeSimpleRange(s, e);
}
bool VisibleSelection::expandUsingGranularity(TextGranularity granularity)
{
if (isNone())
return false;
validate(granularity);
return true;
}
bool VisibleSelection::isAll(EditingBoundaryCrossingRule rule) const
{
return !nonBoundaryShadowTreeRootNode() && visibleStart().previous(rule).isNull() && visibleEnd().next(rule).isNull();
}
void VisibleSelection::appendTrailingWhitespace()
{
auto scope = deprecatedEnclosingBlockFlowElement(m_end.deprecatedNode());
if (!scope)
return;
CharacterIterator charIt(*makeSimpleRange(m_end, makeBoundaryPointAfterNodeContents(*scope)), TextIteratorEmitsCharactersBetweenAllVisiblePositions);
for (; !charIt.atEnd() && charIt.text().length(); charIt.advance(1)) {
UChar c = charIt.text()[0];
if ((!isSpaceOrNewline(c) && c != noBreakSpace) || c == '\n')
break;
m_end = createLegacyEditingPosition(charIt.range().end);
}
}
void VisibleSelection::setBaseAndExtentToDeepEquivalents()
{
bool baseAndExtentEqual = m_base == m_extent;
if (m_base.isNotNull()) {
m_base = VisiblePosition(m_base, m_affinity).deepEquivalent();
if (baseAndExtentEqual)
m_extent = m_base;
}
if (m_extent.isNotNull() && !baseAndExtentEqual)
m_extent = VisiblePosition(m_extent, m_affinity).deepEquivalent();
if (m_base.isNull() && m_extent.isNull())
m_baseIsFirst = true;
else if (m_base.isNull()) {
m_base = m_extent;
m_baseIsFirst = true;
} else if (m_extent.isNull()) {
m_extent = m_base;
m_baseIsFirst = true;
} else
m_baseIsFirst = comparePositions(m_base, m_extent) <= 0;
}
void VisibleSelection::setStartAndEndFromBaseAndExtentRespectingGranularity(TextGranularity granularity)
{
if (m_baseIsFirst) {
m_start = m_base;
m_end = m_extent;
} else {
m_start = m_extent;
m_end = m_base;
}
switch (granularity) {
case TextGranularity::CharacterGranularity:
break;
case TextGranularity::WordGranularity: {
VisiblePosition start = VisiblePosition(m_start, m_affinity);
VisiblePosition originalEnd(m_end, m_affinity);
EWordSide side = RightWordIfOnBoundary;
if (isEndOfEditableOrNonEditableContent(start) || (isEndOfLine(start) && !isStartOfLine(start) && !isEndOfParagraph(start)))
side = LeftWordIfOnBoundary;
m_start = startOfWord(start, side).deepEquivalent();
side = RightWordIfOnBoundary;
if (isEndOfEditableOrNonEditableContent(originalEnd) || (isEndOfLine(originalEnd) && !isStartOfLine(originalEnd) && !isEndOfParagraph(originalEnd)))
side = LeftWordIfOnBoundary;
VisiblePosition wordEnd(endOfWord(originalEnd, side));
VisiblePosition end(wordEnd);
if (isEndOfParagraph(originalEnd) && !isEmptyTableCell(m_start.deprecatedNode())) {
end = wordEnd.next();
if (auto* table = isFirstPositionAfterTable(end)) {
if (isBlock(table))
end = end.next(CannotCrossEditingBoundary);
else
end = wordEnd;
}
if (end.isNull())
end = wordEnd;
}
m_end = end.deepEquivalent();
if (m_start.deprecatedNode() == m_end.deprecatedNode() && m_start.deprecatedEditingOffset() > m_end.deprecatedEditingOffset()) {
Position swap(m_start);
m_start = m_end;
m_end = swap;
}
break;
}
case TextGranularity::SentenceGranularity: {
m_start = startOfSentence(VisiblePosition(m_start, m_affinity)).deepEquivalent();
m_end = endOfSentence(VisiblePosition(m_end, m_affinity)).deepEquivalent();
break;
}
case TextGranularity::LineGranularity: {
m_start = startOfLine(VisiblePosition(m_start, m_affinity)).deepEquivalent();
VisiblePosition end = endOfLine(VisiblePosition(m_end, m_affinity));
if (isEndOfParagraph(end)) {
VisiblePosition next = end.next();
if (next.isNotNull())
end = next;
}
m_end = end.deepEquivalent();
break;
}
case TextGranularity::LineBoundary:
m_start = startOfLine(VisiblePosition(m_start, m_affinity)).deepEquivalent();
m_end = endOfLine(VisiblePosition(m_end, m_affinity)).deepEquivalent();
break;
case TextGranularity::ParagraphGranularity: {
VisiblePosition pos(m_start, m_affinity);
if (isStartOfLine(pos) && isEndOfEditableOrNonEditableContent(pos))
pos = pos.previous();
m_start = startOfParagraph(pos).deepEquivalent();
VisiblePosition visibleParagraphEnd = endOfParagraph(VisiblePosition(m_end, m_affinity));
VisiblePosition end(visibleParagraphEnd.next());
if (Node* table = isFirstPositionAfterTable(end)) {
if (isBlock(table))
end = end.next(CannotCrossEditingBoundary);
else
end = visibleParagraphEnd;
}
if (end.isNull())
end = visibleParagraphEnd;
m_end = end.deepEquivalent();
break;
}
case TextGranularity::DocumentBoundary:
m_start = startOfDocument(m_start.document()).deepEquivalent();
m_end = endOfDocument(m_end.document()).deepEquivalent();
break;
case TextGranularity::ParagraphBoundary:
m_start = startOfParagraph(VisiblePosition(m_start, m_affinity)).deepEquivalent();
m_end = endOfParagraph(VisiblePosition(m_end, m_affinity)).deepEquivalent();
break;
case TextGranularity::SentenceBoundary:
m_start = startOfSentence(VisiblePosition(m_start, m_affinity)).deepEquivalent();
m_end = endOfSentence(VisiblePosition(m_end, m_affinity)).deepEquivalent();
break;
case TextGranularity::DocumentGranularity:
ASSERT_NOT_REACHED();
break;
}
if (m_start.isNull())
m_start = m_end;
if (m_end.isNull())
m_end = m_start;
}
void VisibleSelection::updateSelectionType()
{
if (m_start.isNull()) {
ASSERT(m_end.isNull());
m_selectionType = NoSelection;
} else if (m_start == m_end || m_start.upstream() == m_end.upstream()) {
m_selectionType = CaretSelection;
} else
m_selectionType = RangeSelection;
if (m_selectionType != CaretSelection)
m_affinity = DOWNSTREAM;
}
void VisibleSelection::validate(TextGranularity granularity)
{
setBaseAndExtentToDeepEquivalents();
setStartAndEndFromBaseAndExtentRespectingGranularity(granularity);
adjustSelectionToAvoidCrossingShadowBoundaries();
adjustSelectionToAvoidCrossingEditingBoundaries();
updateSelectionType();
if (selectionType() == RangeSelection) {
m_start = m_start.downstream();
m_end = m_end.upstream();
adjustSelectionToAvoidCrossingEditingBoundaries();
}
}
void VisibleSelection::setWithoutValidation(const Position& base, const Position& extent)
{
ASSERT(!base.isNull());
ASSERT(!extent.isNull());
ASSERT(m_affinity == DOWNSTREAM);
m_base = base;
m_extent = extent;
m_baseIsFirst = comparePositions(base, extent) <= 0;
if (m_baseIsFirst) {
m_start = base;
m_end = extent;
} else {
m_start = extent;
m_end = base;
}
m_selectionType = base == extent ? CaretSelection : RangeSelection;
}
Position VisibleSelection::adjustPositionForEnd(const Position& currentPosition, Node* startContainerNode)
{
TreeScope& treeScope = startContainerNode->treeScope();
ASSERT(¤tPosition.containerNode()->treeScope() != &treeScope);
if (Node* ancestor = treeScope.ancestorNodeInThisScope(currentPosition.containerNode())) {
if (ancestor->contains(startContainerNode))
return positionAfterNode(ancestor);
return positionBeforeNode(ancestor);
}
if (Node* lastChild = treeScope.rootNode().lastChild())
return positionAfterNode(lastChild);
return Position();
}
Position VisibleSelection::adjustPositionForStart(const Position& currentPosition, Node* endContainerNode)
{
TreeScope& treeScope = endContainerNode->treeScope();
ASSERT(¤tPosition.containerNode()->treeScope() != &treeScope);
if (Node* ancestor = treeScope.ancestorNodeInThisScope(currentPosition.containerNode())) {
if (ancestor->contains(endContainerNode))
return positionBeforeNode(ancestor);
return positionAfterNode(ancestor);
}
if (Node* firstChild = treeScope.rootNode().firstChild())
return positionBeforeNode(firstChild);
return Position();
}
static bool isInUserAgentShadowRootOrHasEditableShadowAncestor(Node& node)
{
auto* shadowRoot = node.containingShadowRoot();
if (!shadowRoot)
return false;
if (shadowRoot->mode() == ShadowRootMode::UserAgent)
return true;
for (RefPtr<Node> currentNode = &node; currentNode; currentNode = currentNode->parentOrShadowHostNode()) {
if (currentNode->hasEditableStyle())
return true;
}
return false;
}
void VisibleSelection::adjustSelectionToAvoidCrossingShadowBoundaries()
{
if (m_base.isNull() || m_start.isNull() || m_end.isNull())
return;
auto startNode = makeRef(*m_start.anchorNode());
auto endNode = makeRef(*m_end.anchorNode());
if (&startNode->treeScope() == &endNode->treeScope())
return;
if (startNode->document().settings().selectionAcrossShadowBoundariesEnabled()) {
if (!isInUserAgentShadowRootOrHasEditableShadowAncestor(startNode)
&& !isInUserAgentShadowRootOrHasEditableShadowAncestor(endNode))
return;
}
if (m_baseIsFirst) {
m_extent = adjustPositionForEnd(m_end, m_start.containerNode());
m_end = m_extent;
} else {
m_extent = adjustPositionForStart(m_start, m_end.containerNode());
m_start = m_extent;
}
}
void VisibleSelection::adjustSelectionToAvoidCrossingEditingBoundaries()
{
if (m_base.isNull() || m_start.isNull() || m_end.isNull())
return;
if (m_base == m_start && m_base == m_end)
return;
auto* baseRoot = highestEditableRoot(m_base);
auto* startRoot = highestEditableRoot(m_start);
auto* endRoot = highestEditableRoot(m_end);
auto* baseEditableAncestor = lowestEditableAncestor(m_base.containerNode());
if (baseRoot == startRoot && baseRoot == endRoot)
return;
if (baseRoot) {
if (startRoot != baseRoot) {
VisiblePosition first = firstEditablePositionAfterPositionInRoot(m_start, baseRoot);
m_start = first.deepEquivalent();
if (m_start.isNull()) {
ASSERT_NOT_REACHED();
m_start = m_end;
}
}
if (endRoot != baseRoot) {
VisiblePosition last = lastEditablePositionBeforePositionInRoot(m_end, baseRoot);
m_end = last.deepEquivalent();
if (m_end.isNull())
m_end = m_start;
}
} else {
auto* endEditableAncestor = lowestEditableAncestor(m_end.containerNode());
if (endRoot || endEditableAncestor != baseEditableAncestor) {
Position p = previousVisuallyDistinctCandidate(m_end);
Node* shadowAncestor = endRoot ? endRoot->shadowHost() : 0;
if (p.isNull() && shadowAncestor)
p = positionAfterNode(shadowAncestor);
while (p.isNotNull() && !(lowestEditableAncestor(p.containerNode()) == baseEditableAncestor && !isEditablePosition(p))) {
Node* root = editableRootForPosition(p);
shadowAncestor = root ? root->shadowHost() : 0;
p = isAtomicNode(p.containerNode()) ? positionInParentBeforeNode(p.containerNode()) : previousVisuallyDistinctCandidate(p);
if (p.isNull() && shadowAncestor)
p = positionAfterNode(shadowAncestor);
}
VisiblePosition previous(p);
if (previous.isNull()) {
ASSERT_NOT_REACHED();
m_base = Position();
m_extent = Position();
validate();
return;
}
m_end = previous.deepEquivalent();
}
auto* startEditableAncestor = lowestEditableAncestor(m_start.containerNode());
if (startRoot || startEditableAncestor != baseEditableAncestor) {
Position p = nextVisuallyDistinctCandidate(m_start);
Node* shadowAncestor = startRoot ? startRoot->shadowHost() : 0;
if (p.isNull() && shadowAncestor)
p = positionBeforeNode(shadowAncestor);
while (p.isNotNull() && !(lowestEditableAncestor(p.containerNode()) == baseEditableAncestor && !isEditablePosition(p))) {
Node* root = editableRootForPosition(p);
shadowAncestor = root ? root->shadowHost() : 0;
p = isAtomicNode(p.containerNode()) ? positionInParentAfterNode(p.containerNode()) : nextVisuallyDistinctCandidate(p);
if (p.isNull() && shadowAncestor)
p = positionBeforeNode(shadowAncestor);
}
VisiblePosition next(p);
if (next.isNull()) {
ASSERT_NOT_REACHED();
m_base = Position();
m_extent = Position();
validate();
return;
}
m_start = next.deepEquivalent();
}
}
if (baseEditableAncestor != lowestEditableAncestor(m_extent.containerNode()))
m_extent = m_baseIsFirst ? m_end : m_start;
}
bool VisibleSelection::isContentEditable() const
{
return isEditablePosition(start());
}
bool VisibleSelection::hasEditableStyle() const
{
if (Node* containerNode = start().containerNode())
return containerNode->hasEditableStyle();
return false;
}
bool VisibleSelection::isContentRichlyEditable() const
{
return isRichlyEditablePosition(start());
}
Element* VisibleSelection::rootEditableElement() const
{
return editableRootForPosition(start());
}
Node* VisibleSelection::nonBoundaryShadowTreeRootNode() const
{
return start().deprecatedNode() ? start().deprecatedNode()->nonBoundaryShadowTreeRootNode() : nullptr;
}
bool VisibleSelection::isInPasswordField() const
{
HTMLTextFormControlElement* textControl = enclosingTextFormControl(start());
return is<HTMLInputElement>(textControl) && downcast<HTMLInputElement>(*textControl).isPasswordField();
}
#if ENABLE(TREE_DEBUGGING)
void VisibleSelection::debugPosition() const
{
fprintf(stderr, "VisibleSelection ===============\n");
if (!m_start.anchorNode())
fputs("pos: null", stderr);
else if (m_start == m_end) {
fprintf(stderr, "pos: %s ", m_start.anchorNode()->nodeName().utf8().data());
m_start.showAnchorTypeAndOffset();
} else {
fprintf(stderr, "start: %s ", m_start.anchorNode()->nodeName().utf8().data());
m_start.showAnchorTypeAndOffset();
fprintf(stderr, "end: %s ", m_end.anchorNode()->nodeName().utf8().data());
m_end.showAnchorTypeAndOffset();
}
fprintf(stderr, "================================\n");
}
void VisibleSelection::formatForDebugger(char* buffer, unsigned length) const
{
StringBuilder result;
String s;
if (isNone()) {
result.appendLiteral("<none>");
} else {
const int FormatBufferSize = 1024;
char s[FormatBufferSize];
result.appendLiteral("from ");
start().formatForDebugger(s, FormatBufferSize);
result.append(s);
result.appendLiteral(" to ");
end().formatForDebugger(s, FormatBufferSize);
result.append(s);
}
strncpy(buffer, result.toString().utf8().data(), length - 1);
}
void VisibleSelection::showTreeForThis() const
{
if (start().anchorNode()) {
start().anchorNode()->showTreeAndMark(start().anchorNode(), "S", end().anchorNode(), "E");
fputs("start: ", stderr);
start().showAnchorTypeAndOffset();
fputs("end: ", stderr);
end().showAnchorTypeAndOffset();
}
}
#endif
TextStream& operator<<(TextStream& stream, const VisibleSelection& v)
{
TextStream::GroupScope scope(stream);
stream << "VisibleSelection " << &v;
stream.dumpProperty("base", v.base());
stream.dumpProperty("extent", v.extent());
stream.dumpProperty("start", v.start());
stream.dumpProperty("end", v.end());
return stream;
}
}
#if ENABLE(TREE_DEBUGGING)
void showTree(const WebCore::VisibleSelection& sel)
{
sel.showTreeForThis();
}
void showTree(const WebCore::VisibleSelection* sel)
{
if (sel)
sel->showTreeForThis();
}
#endif