Source code

Revision control

Other Tools

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
#include "HTMLEditUtils.h"
#include "CSSEditUtils.h" // for CSSEditUtils
#include "WSRunObject.h" // for WSRunScanner
#include "mozilla/ArrayUtils.h" // for ArrayLength
#include "mozilla/Assertions.h" // for MOZ_ASSERT, etc.
#include "mozilla/EditAction.h" // for EditAction
#include "mozilla/EditorBase.h" // for EditorBase, EditorType
#include "mozilla/EditorDOMPoint.h" // for EditorDOMPoint, etc.
#include "mozilla/EditorUtils.h" // for EditorUtils
#include "mozilla/dom/Element.h" // for Element, nsINode
#include "mozilla/dom/HTMLAnchorElement.h"
#include "mozilla/dom/HTMLInputElement.h"
#include "mozilla/dom/Text.h" // for Text
#include "nsAString.h" // for nsAString::IsEmpty
#include "nsAtom.h" // for nsAtom
#include "nsCaseTreatment.h"
#include "nsCOMPtr.h" // for nsCOMPtr, operator==, etc.
#include "nsComputedDOMStyle.h" // for nsComputedDOMStyle
#include "nsDebug.h" // for NS_ASSERTION, etc.
#include "nsElementTable.h" // for nsHTMLElement
#include "nsError.h" // for NS_SUCCEEDED
#include "nsGkAtoms.h" // for nsGkAtoms, nsGkAtoms::a, etc.
#include "nsHTMLTags.h"
#include "nsLiteralString.h" // for NS_LITERAL_STRING
#include "nsNameSpaceManager.h" // for kNameSpaceID_None
#include "nsString.h" // for nsAutoString
#include "nsStyledElement.h"
#include "nsTextFragment.h" // for nsTextFragment
namespace mozilla {
using namespace dom;
using EditorType = EditorBase::EditorType;
template nsIContent* HTMLEditUtils::GetPreviousContent(
const EditorDOMPoint& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template nsIContent* HTMLEditUtils::GetPreviousContent(
const EditorRawDOMPoint& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template nsIContent* HTMLEditUtils::GetPreviousContent(
const EditorDOMPointInText& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template nsIContent* HTMLEditUtils::GetPreviousContent(
const EditorRawDOMPointInText& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template nsIContent* HTMLEditUtils::GetNextContent(
const EditorDOMPoint& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template nsIContent* HTMLEditUtils::GetNextContent(
const EditorRawDOMPoint& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template nsIContent* HTMLEditUtils::GetNextContent(
const EditorDOMPointInText& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template nsIContent* HTMLEditUtils::GetNextContent(
const EditorRawDOMPointInText& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter);
template EditorDOMPoint HTMLEditUtils::GetPreviousEditablePoint(
nsIContent& aContent, const Element* aAncestorLimiter,
InvisibleWhiteSpaces aInvisibleWhiteSpaces,
TableBoundary aHowToTreatTableBoundary);
template EditorRawDOMPoint HTMLEditUtils::GetPreviousEditablePoint(
nsIContent& aContent, const Element* aAncestorLimiter,
InvisibleWhiteSpaces aInvisibleWhiteSpaces,
TableBoundary aHowToTreatTableBoundary);
template EditorDOMPoint HTMLEditUtils::GetNextEditablePoint(
nsIContent& aContent, const Element* aAncestorLimiter,
InvisibleWhiteSpaces aInvisibleWhiteSpaces,
TableBoundary aHowToTreatTableBoundary);
template EditorRawDOMPoint HTMLEditUtils::GetNextEditablePoint(
nsIContent& aContent, const Element* aAncestorLimiter,
InvisibleWhiteSpaces aInvisibleWhiteSpaces,
TableBoundary aHowToTreatTableBoundary);
template EditorDOMPoint HTMLEditUtils::GetBetterInsertionPointFor(
const nsIContent& aContentToInsert, const EditorDOMPoint& aPointToInsert,
const Element& aEditingHost);
template EditorRawDOMPoint HTMLEditUtils::GetBetterInsertionPointFor(
const nsIContent& aContentToInsert, const EditorRawDOMPoint& aPointToInsert,
const Element& aEditingHost);
template EditorDOMPoint HTMLEditUtils::GetBetterInsertionPointFor(
const nsIContent& aContentToInsert, const EditorRawDOMPoint& aPointToInsert,
const Element& aEditingHost);
template EditorRawDOMPoint HTMLEditUtils::GetBetterInsertionPointFor(
const nsIContent& aContentToInsert, const EditorDOMPoint& aPointToInsert,
const Element& aEditingHost);
bool HTMLEditUtils::CanContentsBeJoined(const nsIContent& aLeftContent,
const nsIContent& aRightContent,
StyleDifference aStyleDifference) {
if (aLeftContent.NodeInfo()->NameAtom() !=
aRightContent.NodeInfo()->NameAtom()) {
return false;
}
if (aStyleDifference == StyleDifference::Ignore ||
!aLeftContent.IsElement()) {
return true;
}
if (aStyleDifference == StyleDifference::CompareIfSpanElements &&
!aLeftContent.IsHTMLElement(nsGkAtoms::span)) {
return true;
}
if (!aLeftContent.IsElement() || !aRightContent.IsElement()) {
return false;
}
nsStyledElement* leftStyledElement =
nsStyledElement::FromNode(const_cast<nsIContent*>(&aLeftContent));
if (!leftStyledElement) {
return false;
}
nsStyledElement* rightStyledElement =
nsStyledElement::FromNode(const_cast<nsIContent*>(&aRightContent));
if (!rightStyledElement) {
return false;
}
return CSSEditUtils::DoStyledElementsHaveSameStyle(*leftStyledElement,
*rightStyledElement);
}
bool HTMLEditUtils::IsBlockElement(const nsIContent& aContent) {
if (!aContent.IsElement()) {
return false;
}
if (aContent.IsHTMLElement(nsGkAtoms::br)) { // shortcut for TextEditor
MOZ_ASSERT(!nsHTMLElement::IsBlock(nsHTMLTags::AtomTagToId(nsGkAtoms::br)));
return false;
}
// We want to treat these as block nodes even though nsHTMLElement says
// they're not.
if (aContent.IsAnyOfHTMLElements(
nsGkAtoms::body, nsGkAtoms::head, nsGkAtoms::tbody, nsGkAtoms::thead,
nsGkAtoms::tfoot, nsGkAtoms::tr, nsGkAtoms::th, nsGkAtoms::td,
nsGkAtoms::dt, nsGkAtoms::dd)) {
return true;
}
return nsHTMLElement::IsBlock(
nsHTMLTags::AtomTagToId(aContent.NodeInfo()->NameAtom()));
}
/**
* IsInlineStyle() returns true if aNode is an inline style.
*/
bool HTMLEditUtils::IsInlineStyle(nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(
nsGkAtoms::b, nsGkAtoms::i, nsGkAtoms::u, nsGkAtoms::tt, nsGkAtoms::s,
nsGkAtoms::strike, nsGkAtoms::big, nsGkAtoms::small, nsGkAtoms::sub,
nsGkAtoms::sup, nsGkAtoms::font);
}
bool HTMLEditUtils::IsDisplayOutsideInline(const Element& aElement) {
RefPtr<ComputedStyle> elementStyle =
nsComputedDOMStyle::GetComputedStyleNoFlush(&aElement);
if (!elementStyle) {
return false;
}
return elementStyle->StyleDisplay()->DisplayOutside() ==
StyleDisplayOutside::Inline;
}
bool HTMLEditUtils::IsRemovableInlineStyleElement(Element& aElement) {
if (!aElement.IsHTMLElement()) {
return false;
}
if (aElement.IsAnyOfHTMLElements(
nsGkAtoms::abbr, // Chrome ignores, but does not make sense.
nsGkAtoms::acronym, nsGkAtoms::b,
nsGkAtoms::bdi, // Chrome ignores, but does not make sense.
nsGkAtoms::bdo, nsGkAtoms::big, nsGkAtoms::cite, nsGkAtoms::code,
// nsGkAtoms::del, Chrome ignores, but does not make sense but
// execCommand unofficial draft excludes this. Spec issue:
nsGkAtoms::dfn, nsGkAtoms::em, nsGkAtoms::font, nsGkAtoms::i,
nsGkAtoms::ins, nsGkAtoms::kbd,
nsGkAtoms::mark, // Chrome ignores, but does not make sense.
nsGkAtoms::nobr, nsGkAtoms::q, nsGkAtoms::s, nsGkAtoms::samp,
nsGkAtoms::small, nsGkAtoms::span, nsGkAtoms::strike,
nsGkAtoms::strong, nsGkAtoms::sub, nsGkAtoms::sup, nsGkAtoms::tt,
nsGkAtoms::u, nsGkAtoms::var)) {
return true;
}
// If it's a <blink> element, we can remove it.
nsAutoString tagName;
aElement.GetTagName(tagName);
return tagName.LowerCaseEqualsASCII("blink");
}
/**
* IsFormatNode() returns true if aNode is a format node.
*/
bool HTMLEditUtils::IsFormatNode(const nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(
nsGkAtoms::p, nsGkAtoms::pre, nsGkAtoms::h1, nsGkAtoms::h2, nsGkAtoms::h3,
nsGkAtoms::h4, nsGkAtoms::h5, nsGkAtoms::h6, nsGkAtoms::address);
}
/**
* IsNodeThatCanOutdent() returns true if aNode is a list, list item or
* blockquote.
*/
bool HTMLEditUtils::IsNodeThatCanOutdent(nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(nsGkAtoms::ul, nsGkAtoms::ol, nsGkAtoms::dl,
nsGkAtoms::li, nsGkAtoms::dd, nsGkAtoms::dt,
nsGkAtoms::blockquote);
}
/**
* IsHeader() returns true if aNode is an html header.
*/
bool HTMLEditUtils::IsHeader(nsINode& aNode) {
return aNode.IsAnyOfHTMLElements(nsGkAtoms::h1, nsGkAtoms::h2, nsGkAtoms::h3,
nsGkAtoms::h4, nsGkAtoms::h5, nsGkAtoms::h6);
}
/**
* IsListItem() returns true if aNode is an html list item.
*/
bool HTMLEditUtils::IsListItem(const nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(nsGkAtoms::li, nsGkAtoms::dd,
nsGkAtoms::dt);
}
/**
* IsAnyTableElement() returns true if aNode is an html table, td, tr, ...
*/
bool HTMLEditUtils::IsAnyTableElement(const nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(
nsGkAtoms::table, nsGkAtoms::tr, nsGkAtoms::td, nsGkAtoms::th,
nsGkAtoms::thead, nsGkAtoms::tfoot, nsGkAtoms::tbody, nsGkAtoms::caption);
}
/**
* IsAnyTableElementButNotTable() returns true if aNode is an html td, tr, ...
* (doesn't include table)
*/
bool HTMLEditUtils::IsAnyTableElementButNotTable(nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(nsGkAtoms::tr, nsGkAtoms::td, nsGkAtoms::th,
nsGkAtoms::thead, nsGkAtoms::tfoot,
nsGkAtoms::tbody, nsGkAtoms::caption);
}
/**
* IsTable() returns true if aNode is an html table.
*/
bool HTMLEditUtils::IsTable(nsINode* aNode) {
return aNode && aNode->IsHTMLElement(nsGkAtoms::table);
}
/**
* IsTableRow() returns true if aNode is an html tr.
*/
bool HTMLEditUtils::IsTableRow(nsINode* aNode) {
return aNode && aNode->IsHTMLElement(nsGkAtoms::tr);
}
/**
* IsTableCell() returns true if aNode is an html td or th.
*/
bool HTMLEditUtils::IsTableCell(const nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(nsGkAtoms::td, nsGkAtoms::th);
}
/**
* IsTableCellOrCaption() returns true if aNode is an html td or th or caption.
*/
bool HTMLEditUtils::IsTableCellOrCaption(nsINode& aNode) {
return aNode.IsAnyOfHTMLElements(nsGkAtoms::td, nsGkAtoms::th,
nsGkAtoms::caption);
}
/**
* IsAnyListElement() returns true if aNode is an html list.
*/
bool HTMLEditUtils::IsAnyListElement(const nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(nsGkAtoms::ul, nsGkAtoms::ol,
nsGkAtoms::dl);
}
/**
* IsPre() returns true if aNode is an html pre node.
*/
bool HTMLEditUtils::IsPre(const nsINode* aNode) {
return aNode && aNode->IsHTMLElement(nsGkAtoms::pre);
}
/**
* IsImage() returns true if aNode is an html image node.
*/
bool HTMLEditUtils::IsImage(nsINode* aNode) {
return aNode && aNode->IsHTMLElement(nsGkAtoms::img);
}
bool HTMLEditUtils::IsLink(nsINode* aNode) {
MOZ_ASSERT(aNode);
if (!aNode->IsContent()) {
return false;
}
RefPtr<dom::HTMLAnchorElement> anchor =
dom::HTMLAnchorElement::FromNodeOrNull(aNode->AsContent());
if (!anchor) {
return false;
}
nsAutoString tmpText;
anchor->GetHref(tmpText);
return !tmpText.IsEmpty();
}
bool HTMLEditUtils::IsNamedAnchor(const nsINode* aNode) {
MOZ_ASSERT(aNode);
if (!aNode->IsHTMLElement(nsGkAtoms::a)) {
return false;
}
nsAutoString text;
return aNode->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::name,
text) &&
!text.IsEmpty();
}
/**
* IsMozDiv() returns true if aNode is an html div node with |type = _moz|.
*/
bool HTMLEditUtils::IsMozDiv(nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsHTMLElement(nsGkAtoms::div) &&
aNode->AsElement()->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
u"_moz"_ns, eIgnoreCase);
}
/**
* IsMailCite() returns true if aNode is an html blockquote with |type=cite|.
*/
bool HTMLEditUtils::IsMailCite(nsINode* aNode) {
MOZ_ASSERT(aNode);
// don't ask me why, but our html mailcites are id'd by "type=cite"...
if (aNode->IsElement() &&
aNode->AsElement()->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
u"cite"_ns, eIgnoreCase)) {
return true;
}
// ... but our plaintext mailcites by "_moz_quote=true". go figure.
if (aNode->IsElement() &&
aNode->AsElement()->AttrValueIs(kNameSpaceID_None, nsGkAtoms::mozquote,
u"true"_ns, eIgnoreCase)) {
return true;
}
return false;
}
/**
* IsFormWidget() returns true if aNode is a form widget of some kind.
*/
bool HTMLEditUtils::IsFormWidget(const nsINode* aNode) {
MOZ_ASSERT(aNode);
return aNode->IsAnyOfHTMLElements(nsGkAtoms::textarea, nsGkAtoms::select,
nsGkAtoms::button, nsGkAtoms::output,
nsGkAtoms::progress, nsGkAtoms::meter,
nsGkAtoms::input);
}
bool HTMLEditUtils::SupportsAlignAttr(nsINode& aNode) {
return aNode.IsAnyOfHTMLElements(
nsGkAtoms::hr, nsGkAtoms::table, nsGkAtoms::tbody, nsGkAtoms::tfoot,
nsGkAtoms::thead, nsGkAtoms::tr, nsGkAtoms::td, nsGkAtoms::th,
nsGkAtoms::div, nsGkAtoms::p, nsGkAtoms::h1, nsGkAtoms::h2, nsGkAtoms::h3,
nsGkAtoms::h4, nsGkAtoms::h5, nsGkAtoms::h6);
}
bool HTMLEditUtils::IsVisibleTextNode(const Text& aText) {
if (!aText.TextDataLength()) {
return false;
}
Maybe<uint32_t> visibleCharOffset =
HTMLEditUtils::GetInclusiveNextNonCollapsibleCharOffset(
EditorDOMPointInText(&aText, 0));
if (visibleCharOffset.isSome()) {
return true;
}
// Now, all characters in aText is collapsible white-spaces. The node is
// invisible if next to block boundary.
return !HTMLEditUtils::GetElementOfImmediateBlockBoundary(
aText, WalkTreeDirection::Forward) &&
!HTMLEditUtils::GetElementOfImmediateBlockBoundary(
aText, WalkTreeDirection::Backward);
}
bool HTMLEditUtils::IsInVisibleTextFrames(nsPresContext* aPresContext,
const Text& aText) {
MOZ_ASSERT(aPresContext);
nsIFrame* frame = aText.GetPrimaryFrame();
if (!frame) {
return false;
}
nsCOMPtr<nsISelectionController> selectionController;
nsresult rv = frame->GetSelectionController(
aPresContext, getter_AddRefs(selectionController));
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv),
"nsIFrame::GetSelectionController() failed");
if (NS_FAILED(rv) || !selectionController) {
return false;
}
if (!aText.TextDataLength()) {
return false;
}
// Ask the selection controller for information about whether any of the
// data in the node is really rendered. This is really something that
// frames know about, but we aren't supposed to talk to frames. So we put
// a call in the selection controller interface, since it's already in bed
// with frames anyway. (This is a fix for bug 22227, and a partial fix for
// bug 46209.)
bool isVisible = false;
rv = selectionController->CheckVisibilityContent(
const_cast<Text*>(&aText), 0, aText.TextDataLength(), &isVisible);
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rv),
"nsISelectionController::CheckVisibilityContent() failed");
return NS_SUCCEEDED(rv) && isVisible;
}
Element* HTMLEditUtils::GetElementOfImmediateBlockBoundary(
const nsIContent& aContent, const WalkTreeDirection aDirection) {
MOZ_ASSERT(aContent.IsHTMLElement(nsGkAtoms::br) || aContent.IsText());
// First, we get a block container. This is not designed for reaching
// no block boundaries in the tree.
Element* maybeNonEditableAncestorBlock = HTMLEditUtils::GetAncestorElement(
aContent, HTMLEditUtils::ClosestBlockElement);
if (NS_WARN_IF(!maybeNonEditableAncestorBlock)) {
return nullptr;
}
auto getNextContent = [&aDirection, &maybeNonEditableAncestorBlock](
const nsIContent& aContent) -> nsIContent* {
return aDirection == WalkTreeDirection::Forward
? HTMLEditUtils::GetNextContent(
aContent,
{WalkTreeOption::IgnoreDataNodeExceptText,
WalkTreeOption::StopAtBlockBoundary},
maybeNonEditableAncestorBlock)
: HTMLEditUtils::GetPreviousContent(
aContent,
{WalkTreeOption::IgnoreDataNodeExceptText,
WalkTreeOption::StopAtBlockBoundary},
maybeNonEditableAncestorBlock);
};
// Then, scan block element boundary while we don't see visible things.
const bool isBRElement = aContent.IsHTMLElement(nsGkAtoms::br);
for (nsIContent* nextContent = getNextContent(aContent); nextContent;
nextContent = getNextContent(*nextContent)) {
if (nextContent->IsElement()) {
// Break is right before a child block, it's not visible
if (HTMLEditUtils::IsBlockElement(*nextContent)) {
return nextContent->AsElement();
}
// XXX How about other non-HTML elements? Assume they are styled as
// blocks for now.
if (!nextContent->IsHTMLElement()) {
return nextContent->AsElement();
}
// If there is a visible content which generates something visible,
// stop scanning.
if (nextContent->IsAnyOfHTMLElements(
nsGkAtoms::applet, nsGkAtoms::iframe, nsGkAtoms::img,
nsGkAtoms::meter, nsGkAtoms::progress, nsGkAtoms::select,
nsGkAtoms::textarea)) {
return nullptr;
}
if (nextContent->IsHTMLElement(nsGkAtoms::br)) {
// If aContent is a <br> element, another <br> element prevents the
// block boundary special handling.
if (isBRElement) {
return nullptr;
}
MOZ_ASSERT(aContent.IsText());
// Following <br> element always hides its following block boundary.
// I.e., white-spaces is at end of the text node is visible.
if (aDirection == WalkTreeDirection::Forward) {
return nullptr;
}
// Otherwise, if text node follows <br> element, its white-spaces at
// start of the text node are invisible. In this case, we return
// the found <br> element.
return nextContent->AsElement();
}
if (HTMLInputElement* inputElement =
HTMLInputElement::FromNode(nextContent)) {
if (inputElement->ControlType() == FormControlType::InputHidden) {
continue; // Keep scanning next one due to invisible form control.
}
return nullptr; // Followed by a visible form control so that visible
// <br>.
}
continue;
}
Text* textNode = Text::FromNode(nextContent);
if (NS_WARN_IF(!textNode)) {
continue; // XXX Is this possible?
}
if (!textNode->TextLength()) {
continue; // empty invisible text node, keep scanning next one.
}
if (!textNode->TextIsOnlyWhitespace()) {
return nullptr; // found a visible text node.
}
const nsTextFragment& textFragment = textNode->TextFragment();
const bool isWhiteSpacePreformatted =
EditorUtils::IsWhiteSpacePreformatted(*textNode);
const bool isNewLinePreformatted =
EditorUtils::IsNewLinePreformatted(*textNode);
if (!isWhiteSpacePreformatted && !isNewLinePreformatted) {
// if the white-space only text node is not preformatted, ignore it.
continue;
}
for (uint32_t i = 0; i < textFragment.GetLength(); i++) {
if (textFragment.CharAt(AssertedCast<int32_t>(i)) ==
HTMLEditUtils::kNewLine) {
if (isNewLinePreformatted) {
return nullptr; // found a visible text node.
}
continue;
}
if (isWhiteSpacePreformatted) {
return nullptr; // found a visible text node.
}
}
// All white-spaces in the text node is invisible, keep scanning next one.
}
// There is no visible content and reached current block boundary. Then,
// the <br> element is the last content in the block and invisible.
// XXX Should we treat it visible if it's the only child of a block?
return maybeNonEditableAncestorBlock;
}
bool HTMLEditUtils::IsEmptyNode(nsPresContext* aPresContext,
const nsINode& aNode,
const EmptyCheckOptions& aOptions /* = {} */,
bool* aSeenBR /* = nullptr */) {
MOZ_ASSERT_IF(aOptions.contains(EmptyCheckOption::SafeToAskLayout),
aPresContext);
if (aSeenBR) {
*aSeenBR = false;
}
if (const Text* text = Text::FromNode(&aNode)) {
return aOptions.contains(EmptyCheckOption::SafeToAskLayout)
? !IsInVisibleTextFrames(aPresContext, *text)
: !IsVisibleTextNode(*text);
}
// if it's not a text node (handled above) and it's not a container,
// then we don't call it empty (it's an <hr>, or <br>, etc.).
// Also, if it's an anchor then don't treat it as empty - even though
// anchors are containers, named anchors are "empty" but we don't
// want to treat them as such. Also, don't call ListItems or table
// cells empty if caller desires. Form Widgets not empty.
// XXX Why do we treat non-content node is not empty?
// XXX Why do we treat non-text data node may be not empty?
if (!aNode.IsContent() || !IsContainerNode(*aNode.AsContent()) ||
IsNamedAnchor(&aNode) || IsFormWidget(&aNode) ||
(aOptions.contains(EmptyCheckOption::TreatListItemAsVisible) &&
IsListItem(&aNode)) ||
(aOptions.contains(EmptyCheckOption::TreatTableCellAsVisible) &&
IsTableCell(&aNode))) {
return false;
}
const bool isListItem = IsListItem(&aNode);
const bool isTableCell = IsTableCell(&aNode);
// loop over children of node. if no children, or all children are either
// empty text nodes or non-editable, then node qualifies as empty
bool seenBR = aSeenBR && *aSeenBR;
for (nsIContent* childContent = aNode.GetFirstChild(); childContent;
childContent = childContent->GetNextSibling()) {
// Is the child editable and non-empty? if so, return false
if (!EditorUtils::IsEditableContent(*childContent, EditorType::HTML)) {
continue;
}
if (Text* text = Text::FromNode(childContent)) {
// break out if we find we aren't empty
if (aOptions.contains(EmptyCheckOption::SafeToAskLayout)
? IsInVisibleTextFrames(aPresContext, *text)
: IsVisibleTextNode(*text)) {
return false;
}
continue;
}
// An editable, non-text node. We need to check its content.
// Is it the node we are iterating over?
if (childContent == &aNode) {
break;
}
if (!aOptions.contains(EmptyCheckOption::TreatSingleBRElementAsVisible) &&
!seenBR && childContent->IsHTMLElement(nsGkAtoms::br)) {
// Ignore first <br> element in it if caller wants so because it's
// typically a padding <br> element of for a parent block.
seenBR = true;
if (aSeenBR) {
*aSeenBR = true;
}
continue;
}
// is it an empty node of some sort?
// note: list items or table cells are not considered empty
// if they contain other lists or tables
if (childContent->IsElement()) {
if (isListItem || isTableCell) {
if (IsAnyListElement(childContent) ||
childContent->IsHTMLElement(nsGkAtoms::table)) {
// break out if we find we aren't empty
return false;
}
} else if (IsFormWidget(childContent)) {
// is it a form widget?
// break out if we find we aren't empty
return false;
}
}
if (!IsEmptyNode(aPresContext, *childContent, aOptions, &seenBR)) {
if (aSeenBR) {
*aSeenBR = seenBR;
}
return false;
}
}
if (aSeenBR) {
*aSeenBR = seenBR;
}
return true;
}
bool HTMLEditUtils::ShouldInsertLinefeedCharacter(
EditorDOMPoint& aPointToInsert, const Element& aEditingHost) {
MOZ_ASSERT(aPointToInsert.IsSetAndValid());
if (!aPointToInsert.IsInContentNode()) {
return false;
}
// closestEditableBlockElement can be nullptr if aEditingHost is an inline
// element.
Element* closestEditableBlockElement =
HTMLEditUtils::GetInclusiveAncestorElement(
*aPointToInsert.ContainerAsContent(),
HTMLEditUtils::ClosestEditableBlockElement);
// If and only if the nearest block is the editing host or its parent,
// and the outer display value of the editing host is inline, and new
// line character is preformatted, we should insert a linefeed.
return (!closestEditableBlockElement ||
closestEditableBlockElement == &aEditingHost) &&
HTMLEditUtils::IsDisplayOutsideInline(aEditingHost) &&
EditorUtils::IsNewLinePreformatted(
*aPointToInsert.ContainerAsContent());
}
// We use bitmasks to test containment of elements. Elements are marked to be
// in certain groups by setting the mGroup member of the `ElementInfo` struct
// to the corresponding GROUP_ values (OR'ed together). Similarly, elements are
// marked to allow containment of certain groups by setting the
// mCanContainGroups member of the `ElementInfo` struct to the corresponding
// GROUP_ values (OR'ed together).
// Testing containment then simply consists of checking whether the
// mCanContainGroups bitmask of an element and the mGroup bitmask of a
// potential child overlap.
#define GROUP_NONE 0
// body, head, html
#define GROUP_TOPLEVEL (1 << 1)
// base, link, meta, script, style, title
#define GROUP_HEAD_CONTENT (1 << 2)
// b, big, i, s, small, strike, tt, u
#define GROUP_FONTSTYLE (1 << 3)
// abbr, acronym, cite, code, datalist, del, dfn, em, ins, kbd, mark, rb, rp
// rt, rtc, ruby, samp, strong, var
#define GROUP_PHRASE (1 << 4)
// a, applet, basefont, bdi, bdo, br, font, iframe, img, map, meter, object,
// output, picture, progress, q, script, span, sub, sup
#define GROUP_SPECIAL (1 << 5)
// button, form, input, label, select, textarea
#define GROUP_FORMCONTROL (1 << 6)
// address, applet, article, aside, blockquote, button, center, del, details,
// dialog, dir, div, dl, fieldset, figure, footer, form, h1, h2, h3, h4, h5,
// h6, header, hgroup, hr, iframe, ins, main, map, menu, nav, noframes,
// noscript, object, ol, p, pre, table, section, summary, ul
#define GROUP_BLOCK (1 << 7)
// frame, frameset
#define GROUP_FRAME (1 << 8)
// col, tbody
#define GROUP_TABLE_CONTENT (1 << 9)
// tr
#define GROUP_TBODY_CONTENT (1 << 10)
// td, th
#define GROUP_TR_CONTENT (1 << 11)
// col
#define GROUP_COLGROUP_CONTENT (1 << 12)
// param
#define GROUP_OBJECT_CONTENT (1 << 13)
// li
#define GROUP_LI (1 << 14)
// area
#define GROUP_MAP_CONTENT (1 << 15)
// optgroup, option
#define GROUP_SELECT_CONTENT (1 << 16)
// option
#define GROUP_OPTIONS (1 << 17)
// dd, dt
#define GROUP_DL_CONTENT (1 << 18)
// p
#define GROUP_P (1 << 19)
// text, white-space, newline, comment
#define GROUP_LEAF (1 << 20)
// XXX This is because the editor does sublists illegally.
// ol, ul
#define GROUP_OL_UL (1 << 21)
// h1, h2, h3, h4, h5, h6
#define GROUP_HEADING (1 << 22)
// figcaption
#define GROUP_FIGCAPTION (1 << 23)
// picture members (img, source)
#define GROUP_PICTURE_CONTENT (1 << 24)
#define GROUP_INLINE_ELEMENT \
(GROUP_FONTSTYLE | GROUP_PHRASE | GROUP_SPECIAL | GROUP_FORMCONTROL | \
GROUP_LEAF)
#define GROUP_FLOW_ELEMENT (GROUP_INLINE_ELEMENT | GROUP_BLOCK)
struct ElementInfo final {
#ifdef DEBUG
nsHTMLTag mTag;
#endif
// See `GROUP_NONE`'s comment.
uint32_t mGroup;
// See `GROUP_NONE`'s comment.
uint32_t mCanContainGroups;
bool mIsContainer;
bool mCanContainSelf;
};
#ifdef DEBUG
# define ELEM(_tag, _isContainer, _canContainSelf, _group, _canContainGroups) \
{ \
eHTMLTag_##_tag, _group, _canContainGroups, _isContainer, \
_canContainSelf \
}
#else
# define ELEM(_tag, _isContainer, _canContainSelf, _group, _canContainGroups) \
{ _group, _canContainGroups, _isContainer, _canContainSelf }
#endif
static const ElementInfo kElements[eHTMLTag_userdefined] = {
ELEM(a, true, false, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(abbr, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(acronym, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(address, true, true, GROUP_BLOCK, GROUP_INLINE_ELEMENT | GROUP_P),
// While applet is no longer a valid tag, removing it here breaks the editor
// (compiles, but causes many tests to fail in odd ways). This list is
// tracked against the main HTML Tag list, so any changes will require more
// than just removing entries.
ELEM(applet, true, true, GROUP_SPECIAL | GROUP_BLOCK,
GROUP_FLOW_ELEMENT | GROUP_OBJECT_CONTENT),
ELEM(area, false, false, GROUP_MAP_CONTENT, GROUP_NONE),
ELEM(article, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(aside, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(audio, false, false, GROUP_NONE, GROUP_NONE),
ELEM(b, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
ELEM(base, false, false, GROUP_HEAD_CONTENT, GROUP_NONE),
ELEM(basefont, false, false, GROUP_SPECIAL, GROUP_NONE),
ELEM(bdi, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(bdo, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(bgsound, false, false, GROUP_NONE, GROUP_NONE),
ELEM(big, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
ELEM(blockquote, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(body, true, true, GROUP_TOPLEVEL, GROUP_FLOW_ELEMENT),
ELEM(br, false, false, GROUP_SPECIAL, GROUP_NONE),
ELEM(button, true, true, GROUP_FORMCONTROL | GROUP_BLOCK,
GROUP_FLOW_ELEMENT),
ELEM(canvas, false, false, GROUP_NONE, GROUP_NONE),
ELEM(caption, true, true, GROUP_NONE, GROUP_INLINE_ELEMENT),
ELEM(center, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(cite, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(code, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(col, false, false, GROUP_TABLE_CONTENT | GROUP_COLGROUP_CONTENT,
GROUP_NONE),
ELEM(colgroup, true, false, GROUP_NONE, GROUP_COLGROUP_CONTENT),
ELEM(data, true, false, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(datalist, true, false, GROUP_PHRASE,
GROUP_OPTIONS | GROUP_INLINE_ELEMENT),
ELEM(dd, true, false, GROUP_DL_CONTENT, GROUP_FLOW_ELEMENT),
ELEM(del, true, true, GROUP_PHRASE | GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(details, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(dfn, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(dialog, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(dir, true, false, GROUP_BLOCK, GROUP_LI),
ELEM(div, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(dl, true, false, GROUP_BLOCK, GROUP_DL_CONTENT),
ELEM(dt, true, true, GROUP_DL_CONTENT, GROUP_INLINE_ELEMENT),
ELEM(em, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(embed, false, false, GROUP_NONE, GROUP_NONE),
ELEM(fieldset, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(figcaption, true, false, GROUP_FIGCAPTION, GROUP_FLOW_ELEMENT),
ELEM(figure, true, true, GROUP_BLOCK,
GROUP_FLOW_ELEMENT | GROUP_FIGCAPTION),
ELEM(font, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(footer, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(form, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(frame, false, false, GROUP_FRAME, GROUP_NONE),
ELEM(frameset, true, true, GROUP_FRAME, GROUP_FRAME),
ELEM(h1, true, false, GROUP_BLOCK | GROUP_HEADING, GROUP_INLINE_ELEMENT),
ELEM(h2, true, false, GROUP_BLOCK | GROUP_HEADING, GROUP_INLINE_ELEMENT),
ELEM(h3, true, false, GROUP_BLOCK | GROUP_HEADING, GROUP_INLINE_ELEMENT),
ELEM(h4, true, false, GROUP_BLOCK | GROUP_HEADING, GROUP_INLINE_ELEMENT),
ELEM(h5, true, false, GROUP_BLOCK | GROUP_HEADING, GROUP_INLINE_ELEMENT),
ELEM(h6, true, false, GROUP_BLOCK | GROUP_HEADING, GROUP_INLINE_ELEMENT),
ELEM(head, true, false, GROUP_TOPLEVEL, GROUP_HEAD_CONTENT),
ELEM(header, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(hgroup, true, false, GROUP_BLOCK, GROUP_HEADING),
ELEM(hr, false, false, GROUP_BLOCK, GROUP_NONE),
ELEM(html, true, false, GROUP_TOPLEVEL, GROUP_TOPLEVEL),
ELEM(i, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
ELEM(iframe, true, true, GROUP_SPECIAL | GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(image, false, false, GROUP_NONE, GROUP_NONE),
ELEM(img, false, false, GROUP_SPECIAL | GROUP_PICTURE_CONTENT, GROUP_NONE),
ELEM(input, false, false, GROUP_FORMCONTROL, GROUP_NONE),
ELEM(ins, true, true, GROUP_PHRASE | GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(kbd, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(keygen, false, false, GROUP_NONE, GROUP_NONE),
ELEM(label, true, false, GROUP_FORMCONTROL, GROUP_INLINE_ELEMENT),
ELEM(legend, true, true, GROUP_NONE, GROUP_INLINE_ELEMENT),
ELEM(li, true, false, GROUP_LI, GROUP_FLOW_ELEMENT),
ELEM(link, false, false, GROUP_HEAD_CONTENT, GROUP_NONE),
ELEM(listing, true, true, GROUP_BLOCK, GROUP_INLINE_ELEMENT),
ELEM(main, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(map, true, true, GROUP_SPECIAL, GROUP_BLOCK | GROUP_MAP_CONTENT),
ELEM(mark, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(marquee, true, false, GROUP_NONE, GROUP_NONE),
ELEM(menu, true, true, GROUP_BLOCK, GROUP_LI | GROUP_FLOW_ELEMENT),
ELEM(menuitem, false, false, GROUP_NONE, GROUP_NONE),
ELEM(meta, false, false, GROUP_HEAD_CONTENT, GROUP_NONE),
ELEM(meter, true, false, GROUP_SPECIAL, GROUP_FLOW_ELEMENT),
ELEM(multicol, false, false, GROUP_NONE, GROUP_NONE),
ELEM(nav, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(nobr, true, false, GROUP_NONE, GROUP_NONE),
ELEM(noembed, false, false, GROUP_NONE, GROUP_NONE),
ELEM(noframes, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(noscript, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(object, true, true, GROUP_SPECIAL | GROUP_BLOCK,
GROUP_FLOW_ELEMENT | GROUP_OBJECT_CONTENT),
// XXX Can contain self and ul because editor does sublists illegally.
ELEM(ol, true, true, GROUP_BLOCK | GROUP_OL_UL, GROUP_LI | GROUP_OL_UL),
ELEM(optgroup, true, false, GROUP_SELECT_CONTENT, GROUP_OPTIONS),
ELEM(option, true, false, GROUP_SELECT_CONTENT | GROUP_OPTIONS, GROUP_LEAF),
ELEM(output, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(p, true, false, GROUP_BLOCK | GROUP_P, GROUP_INLINE_ELEMENT),
ELEM(param, false, false, GROUP_OBJECT_CONTENT, GROUP_NONE),
ELEM(picture, true, false, GROUP_SPECIAL, GROUP_PICTURE_CONTENT),
ELEM(plaintext, false, false, GROUP_NONE, GROUP_NONE),
ELEM(pre, true, true, GROUP_BLOCK, GROUP_INLINE_ELEMENT),
ELEM(progress, true, false, GROUP_SPECIAL, GROUP_FLOW_ELEMENT),
ELEM(q, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(rb, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(rp, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(rt, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(rtc, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(ruby, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(s, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
ELEM(samp, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(script, true, false, GROUP_HEAD_CONTENT | GROUP_SPECIAL, GROUP_LEAF),
ELEM(section, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(select, true, false, GROUP_FORMCONTROL, GROUP_SELECT_CONTENT),
ELEM(small, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
ELEM(slot, true, false, GROUP_NONE, GROUP_FLOW_ELEMENT),
ELEM(source, false, false, GROUP_PICTURE_CONTENT, GROUP_NONE),
ELEM(span, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(strike, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
ELEM(strong, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(style, true, false, GROUP_HEAD_CONTENT, GROUP_LEAF),
ELEM(sub, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(summary, true, true, GROUP_BLOCK, GROUP_FLOW_ELEMENT),
ELEM(sup, true, true, GROUP_SPECIAL, GROUP_INLINE_ELEMENT),
ELEM(table, true, false, GROUP_BLOCK, GROUP_TABLE_CONTENT),
ELEM(tbody, true, false, GROUP_TABLE_CONTENT, GROUP_TBODY_CONTENT),
ELEM(td, true, false, GROUP_TR_CONTENT, GROUP_FLOW_ELEMENT),
ELEM(textarea, true, false, GROUP_FORMCONTROL, GROUP_LEAF),
ELEM(tfoot, true, false, GROUP_NONE, GROUP_TBODY_CONTENT),
ELEM(th, true, false, GROUP_TR_CONTENT, GROUP_FLOW_ELEMENT),
ELEM(thead, true, false, GROUP_NONE, GROUP_TBODY_CONTENT),
ELEM(template, false, false, GROUP_NONE, GROUP_NONE),
ELEM(time, true, false, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(title, true, false, GROUP_HEAD_CONTENT, GROUP_LEAF),
ELEM(tr, true, false, GROUP_TBODY_CONTENT, GROUP_TR_CONTENT),
ELEM(track, false, false, GROUP_NONE, GROUP_NONE),
ELEM(tt, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
ELEM(u, true, true, GROUP_FONTSTYLE, GROUP_INLINE_ELEMENT),
// XXX Can contain self and ol because editor does sublists illegally.
ELEM(ul, true, true, GROUP_BLOCK | GROUP_OL_UL, GROUP_LI | GROUP_OL_UL),
ELEM(var, true, true, GROUP_PHRASE, GROUP_INLINE_ELEMENT),
ELEM(video, false, false, GROUP_NONE, GROUP_NONE),
ELEM(wbr, false, false, GROUP_NONE, GROUP_NONE),
ELEM(xmp, true, false, GROUP_BLOCK, GROUP_NONE),
// These aren't elements.
ELEM(text, false, false, GROUP_LEAF, GROUP_NONE),
ELEM(whitespace, false, false, GROUP_LEAF, GROUP_NONE),
ELEM(newline, false, false, GROUP_LEAF, GROUP_NONE),
ELEM(comment, false, false, GROUP_LEAF, GROUP_NONE),
ELEM(entity, false, false, GROUP_NONE, GROUP_NONE),
ELEM(doctypeDecl, false, false, GROUP_NONE, GROUP_NONE),
ELEM(markupDecl, false, false, GROUP_NONE, GROUP_NONE),
ELEM(instruction, false, false, GROUP_NONE, GROUP_NONE),
ELEM(userdefined, true, false, GROUP_NONE, GROUP_FLOW_ELEMENT)};
bool HTMLEditUtils::CanNodeContain(nsHTMLTag aParentTagId,
nsHTMLTag aChildTagId) {
NS_ASSERTION(
aParentTagId > eHTMLTag_unknown && aParentTagId <= eHTMLTag_userdefined,
"aParentTagId out of range!");
NS_ASSERTION(
aChildTagId > eHTMLTag_unknown && aChildTagId <= eHTMLTag_userdefined,
"aChildTagId out of range!");
#ifdef DEBUG
static bool checked = false;
if (!checked) {
checked = true;
int32_t i;
for (i = 1; i <= eHTMLTag_userdefined; ++i) {
NS_ASSERTION(kElements[i - 1].mTag == i,
"You need to update kElements (missing tags).");
}
}
#endif
// Special-case button.
if (aParentTagId == eHTMLTag_button) {
static const nsHTMLTag kButtonExcludeKids[] = {
eHTMLTag_a, eHTMLTag_fieldset, eHTMLTag_form, eHTMLTag_iframe,
eHTMLTag_input, eHTMLTag_select, eHTMLTag_textarea};
uint32_t j;
for (j = 0; j < ArrayLength(kButtonExcludeKids); ++j) {
if (kButtonExcludeKids[j] == aChildTagId) {
return false;
}
}
}
// Deprecated elements.
if (aChildTagId == eHTMLTag_bgsound) {
return false;
}
// Bug #67007, dont strip userdefined tags.
if (aChildTagId == eHTMLTag_userdefined) {
return true;
}
const ElementInfo& parent = kElements[aParentTagId - 1];
if (aParentTagId == aChildTagId) {
return parent.mCanContainSelf;
}
const ElementInfo& child = kElements[aChildTagId - 1];
return !!(parent.mCanContainGroups & child.mGroup);
}
bool HTMLEditUtils::IsContainerNode(nsHTMLTag aTagId) {
NS_ASSERTION(aTagId > eHTMLTag_unknown && aTagId <= eHTMLTag_userdefined,
"aTagId out of range!");
return kElements[aTagId - 1].mIsContainer;
}
bool HTMLEditUtils::IsNonListSingleLineContainer(nsINode& aNode) {
return aNode.IsAnyOfHTMLElements(
nsGkAtoms::address, nsGkAtoms::div, nsGkAtoms::h1, nsGkAtoms::h2,
nsGkAtoms::h3, nsGkAtoms::h4, nsGkAtoms::h5, nsGkAtoms::h6,
nsGkAtoms::listing, nsGkAtoms::p, nsGkAtoms::pre, nsGkAtoms::xmp);
}
bool HTMLEditUtils::IsSingleLineContainer(nsINode& aNode) {
return IsNonListSingleLineContainer(aNode) ||
aNode.IsAnyOfHTMLElements(nsGkAtoms::li, nsGkAtoms::dt, nsGkAtoms::dd);
}
// static
template <typename PT, typename CT>
nsIContent* HTMLEditUtils::GetPreviousContent(
const EditorDOMPointBase<PT, CT>& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter /* = nullptr */) {
MOZ_ASSERT(aPoint.IsSetAndValid());
NS_WARNING_ASSERTION(
!aPoint.IsInDataNode() || aPoint.IsInTextNode(),
"GetPreviousContent() doesn't assume that the start point is a "
"data node except text node");
// If we are at the beginning of the node, or it is a text node, then just
// look before it.
if (aPoint.IsStartOfContainer() || aPoint.IsInTextNode()) {
if (aOptions.contains(WalkTreeOption::StopAtBlockBoundary) &&
aPoint.IsInContentNode() &&
HTMLEditUtils::IsBlockElement(*aPoint.ContainerAsContent())) {
// If we aren't allowed to cross blocks, don't look before this block.
return nullptr;
}
return HTMLEditUtils::GetPreviousContent(*aPoint.GetContainer(), aOptions,
aAncestorLimiter);
}
// else look before the child at 'aOffset'
if (aPoint.GetChild()) {
return HTMLEditUtils::GetPreviousContent(*aPoint.GetChild(), aOptions,
aAncestorLimiter);
}
// unless there isn't one, in which case we are at the end of the node
// and want the deep-right child.
nsIContent* lastLeafContent = HTMLEditUtils::GetLastLeafContent(
*aPoint.GetContainer(),
{aOptions.contains(WalkTreeOption::StopAtBlockBoundary)
? LeafNodeType::LeafNodeOrChildBlock
: LeafNodeType::OnlyLeafNode});
if (!lastLeafContent) {
return nullptr;
}
if (!HTMLEditUtils::IsContentIgnored(*lastLeafContent, aOptions)) {
return lastLeafContent;
}
// restart the search from the non-editable node we just found
return HTMLEditUtils::GetPreviousContent(*lastLeafContent, aOptions,
aAncestorLimiter);
}
// static
template <typename PT, typename CT>
nsIContent* HTMLEditUtils::GetNextContent(
const EditorDOMPointBase<PT, CT>& aPoint, const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter /* = nullptr */) {
MOZ_ASSERT(aPoint.IsSetAndValid());
NS_WARNING_ASSERTION(
!aPoint.IsInDataNode() || aPoint.IsInTextNode(),
"GetNextContent() doesn't assume that the start point is a "
"data node except text node");
EditorRawDOMPoint point(aPoint);
// if the container is a text node, use its location instead
if (point.IsInTextNode()) {
point.SetAfter(point.GetContainer());
if (NS_WARN_IF(!point.IsSet())) {
return nullptr;
}
}
if (point.GetChild()) {
if (aOptions.contains(WalkTreeOption::StopAtBlockBoundary) &&
HTMLEditUtils::IsBlockElement(*point.GetChild())) {
return point.GetChild();
}
nsIContent* firstLeafContent = HTMLEditUtils::GetFirstLeafContent(
*point.GetChild(),
{aOptions.contains(WalkTreeOption::StopAtBlockBoundary)
? LeafNodeType::LeafNodeOrChildBlock
: LeafNodeType::OnlyLeafNode});
if (!firstLeafContent) {
return point.GetChild();
}
// XXX Why do we need to do this check? The leaf node must be a descendant
// of `point.GetChild()`.
if (aAncestorLimiter &&
(firstLeafContent == aAncestorLimiter ||
!firstLeafContent->IsInclusiveDescendantOf(aAncestorLimiter))) {
return nullptr;
}
if (!HTMLEditUtils::IsContentIgnored(*firstLeafContent, aOptions)) {
return firstLeafContent;
}
// restart the search from the non-editable node we just found
return HTMLEditUtils::GetNextContent(*firstLeafContent, aOptions,
aAncestorLimiter);
}
// unless there isn't one, in which case we are at the end of the node
// and want the next one.
if (aOptions.contains(WalkTreeOption::StopAtBlockBoundary) &&
point.IsInContentNode() &&
HTMLEditUtils::IsBlockElement(*point.ContainerAsContent())) {
// don't cross out of parent block
return nullptr;
}
return HTMLEditUtils::GetNextContent(*point.GetContainer(), aOptions,
aAncestorLimiter);
}
// static
nsIContent* HTMLEditUtils::GetAdjacentLeafContent(
const nsINode& aNode, WalkTreeDirection aWalkTreeDirection,
const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter /* = nullptr */) {
// called only by GetPriorNode so we don't need to check params.
MOZ_ASSERT(&aNode != aAncestorLimiter);
MOZ_ASSERT_IF(aAncestorLimiter,
aAncestorLimiter->IsInclusiveDescendantOf(aAncestorLimiter));
const nsINode* node = &aNode;
for (;;) {
// if aNode has a sibling in the right direction, return
// that sibling's closest child (or itself if it has no children)
nsIContent* sibling = aWalkTreeDirection == WalkTreeDirection::Forward
? node->GetNextSibling()
: node->GetPreviousSibling();
if (sibling) {
if (aOptions.contains(WalkTreeOption::StopAtBlockBoundary) &&
HTMLEditUtils::IsBlockElement(*sibling)) {
// don't look inside prevsib, since it is a block
return sibling;
}
const LeafNodeTypes leafNodeTypes = {
aOptions.contains(WalkTreeOption::StopAtBlockBoundary)
? LeafNodeType::LeafNodeOrChildBlock
: LeafNodeType::OnlyLeafNode};
nsIContent* leafContent =
aWalkTreeDirection == WalkTreeDirection::Forward
? HTMLEditUtils::GetFirstLeafContent(*sibling, leafNodeTypes)
: HTMLEditUtils::GetLastLeafContent(*sibling, leafNodeTypes);
return leafContent ? leafContent : sibling;
}
nsIContent* parent = node->GetParent();
if (!parent) {
return nullptr;
}
if (parent == aAncestorLimiter ||
(aOptions.contains(WalkTreeOption::StopAtBlockBoundary) &&
HTMLEditUtils::IsBlockElement(*parent))) {
return nullptr;
}
node = parent;
}
MOZ_ASSERT_UNREACHABLE("What part of for(;;) do you not understand?");
return nullptr;
}
// static
nsIContent* HTMLEditUtils::GetAdjacentContent(
const nsINode& aNode, WalkTreeDirection aWalkTreeDirection,
const WalkTreeOptions& aOptions,
const Element* aAncestorLimiter /* = nullptr */) {
if (&aNode == aAncestorLimiter) {
// Don't allow traversal above the root node! This helps
// prevent us from accidentally editing browser content
// when the editor is in a text widget.
return nullptr;
}
nsIContent* leafContent = HTMLEditUtils::GetAdjacentLeafContent(
aNode, aWalkTreeDirection, aOptions, aAncestorLimiter);
if (!leafContent) {
return nullptr;
}
if (!HTMLEditUtils::IsContentIgnored(*leafContent, aOptions)) {
return leafContent;
}
return HTMLEditUtils::GetAdjacentContent(*leafContent, aWalkTreeDirection,
aOptions, aAncestorLimiter);
}
// static
template <typename EditorDOMPointType>
EditorDOMPointType HTMLEditUtils::GetPreviousEditablePoint(
nsIContent& aContent, const Element* aAncestorLimiter,
InvisibleWhiteSpaces aInvisibleWhiteSpaces,
TableBoundary aHowToTreatTableBoundary) {
MOZ_ASSERT(HTMLEditUtils::IsSimplyEditableNode(aContent));
NS_ASSERTION(!HTMLEditUtils::IsAnyTableElement(&aContent) ||
HTMLEditUtils::IsTableCellOrCaption(aContent),
"HTMLEditUtils::GetPreviousEditablePoint() may return a point "
"between table structure elements");
// First, look for previous content.
nsIContent* previousContent = aContent.GetPreviousSibling();
if (!previousContent) {
if (!aContent.GetParentElement()) {
return EditorDOMPointType();
}
nsIContent* inclusiveAncestor = &aContent;
for (Element* parentElement : aContent.AncestorsOfType<Element>()) {
previousContent = parentElement->GetPreviousSibling();
if (!previousContent &&
(parentElement == aAncestorLimiter ||
!HTMLEditUtils::IsSimplyEditableNode(*parentElement) ||
!HTMLEditUtils::CanCrossContentBoundary(*parentElement,
aHowToTreatTableBoundary))) {
// If cannot cross the parent element boundary, return the point of
// last inclusive ancestor point.
return EditorDOMPointType(inclusiveAncestor);
}
// Start of the parent element is a next editable point if it's an
// element which is not a table structure element.
if (!HTMLEditUtils::IsAnyTableElement(parentElement) ||
HTMLEditUtils::IsTableCellOrCaption(*parentElement)) {
inclusiveAncestor = parentElement;
}
if (!previousContent) {
continue; // Keep looking for previous sibling of an ancestor.
}
// XXX Should we ignore data node like CDATA, Comment, etc?
// If previous content is not editable, let's return the point after it.
if (!HTMLEditUtils::IsSimplyEditableNode(*previousContent)) {
return EditorDOMPointType::After(*previousContent);
}
// If cannot cross previous content boundary, return start of last
// inclusive ancestor.
if (!HTMLEditUtils::CanCrossContentBoundary(*previousContent,
aHowToTreatTableBoundary)) {
return inclusiveAncestor == &aContent
? EditorDOMPointType(inclusiveAncestor)
: EditorDOMPointType(inclusiveAncestor, 0);
}
break;
}
if (!previousContent) {
return EditorDOMPointType(inclusiveAncestor);
}
} else if (!HTMLEditUtils::IsSimplyEditableNode(*previousContent)) {
return EditorDOMPointType::After(*previousContent);
} else if (!HTMLEditUtils::CanCrossContentBoundary(
*previousContent, aHowToTreatTableBoundary)) {
return EditorDOMPointType(&aContent);
}
// Next, look for end of the previous content.
nsIContent* leafContent = previousContent;
if (previousContent->GetChildCount() &&
HTMLEditUtils::IsContainerNode(*previousContent)) {
for (nsIContent* maybeLeafContent = previousContent->GetLastChild();
maybeLeafContent;
maybeLeafContent = maybeLeafContent->GetLastChild()) {
// If it's not an editable content or cannot cross the boundary,
// return the point after the content. Note that in this case,
// the content must not be any table elements except `<table>`
// because we've climbed down the tree.
if (!HTMLEditUtils::IsSimplyEditableNode(*maybeLeafContent) ||
!HTMLEditUtils::CanCrossContentBoundary(*maybeLeafContent,
aHowToTreatTableBoundary)) {
return EditorDOMPointType::After(*maybeLeafContent);
}
leafContent = maybeLeafContent;
if (!HTMLEditUtils::IsContainerNode(*leafContent)) {
break;
}
}
}
if (leafContent->IsText()) {
Text* textNode = leafContent->AsText();
if (aInvisibleWhiteSpaces == InvisibleWhiteSpaces::Preserve) {
return EditorDOMPointType::AtEndOf(*textNode);
}
// There may be invisible trailing white-spaces which should be
// ignored. Let's scan its start.
return WSRunScanner::GetAfterLastVisiblePoint<EditorDOMPointType>(
*textNode, aAncestorLimiter);
}
// If it's a container element, return end of it. Otherwise, return
// the point after the non-container element.
return HTMLEditUtils::IsContainerNode(*leafContent)
? EditorDOMPointType::AtEndOf(*leafContent)
: EditorDOMPointType::After(*leafContent);
}
// static
template <typename EditorDOMPointType>
EditorDOMPointType HTMLEditUtils::GetNextEditablePoint(
nsIContent& aContent, const Element* aAncestorLimiter,
InvisibleWhiteSpaces aInvisibleWhiteSpaces,
TableBoundary aHowToTreatTableBoundary) {
MOZ_ASSERT(HTMLEditUtils::IsSimplyEditableNode(aContent));
NS_ASSERTION(!HTMLEditUtils::IsAnyTableElement(&aContent) ||
HTMLEditUtils::IsTableCellOrCaption(aContent),
"HTMLEditUtils::GetPreviousEditablePoint() may return a point "
"between table structure elements");
// First, look for next content.
nsIContent* nextContent = aContent.GetNextSibling();
if (!nextContent) {
if (!aContent.GetParentElement()) {
return EditorDOMPointType();
}
nsIContent* inclusiveAncestor = &aContent;
for (Element* parentElement : aContent.AncestorsOfType<Element>()) {
// End of the parent element is a next editable point if it's an
// element which is not a table structure element.
if (!HTMLEditUtils::IsAnyTableElement(parentElement) ||
HTMLEditUtils::IsTableCellOrCaption(*parentElement)) {
inclusiveAncestor = parentElement;
}
nextContent = parentElement->GetNextSibling();
if (!nextContent &&
(parentElement == aAncestorLimiter ||
!HTMLEditUtils::IsSimplyEditableNode(*parentElement) ||
!HTMLEditUtils::CanCrossContentBoundary(*parentElement,
aHowToTreatTableBoundary))) {
// If cannot cross the parent element boundary, return the point of
// last inclusive ancestor point.
return EditorDOMPointType(inclusiveAncestor);
}
// End of the parent element is a next editable point if it's an
// element which is not a table structure element.
if (!HTMLEditUtils::IsAnyTableElement(parentElement) ||
HTMLEditUtils::IsTableCellOrCaption(*parentElement)) {
inclusiveAncestor = parentElement;
}
if (!nextContent) {
continue; // Keep looking for next sibling of an ancestor.
}
// XXX Should we ignore data node like CDATA, Comment, etc?
// If next content is not editable, let's return the point after
// the last inclusive ancestor.
if (!HTMLEditUtils::IsSimplyEditableNode(*nextContent)) {
return EditorDOMPointType::After(*parentElement);
}
// If cannot cross next content boundary, return after the last
// inclusive ancestor.
if (!HTMLEditUtils::CanCrossContentBoundary(*nextContent,
aHowToTreatTableBoundary)) {
return EditorDOMPointType::After(*inclusiveAncestor);
}
break;
}
if (!nextContent) {
return EditorDOMPointType::After(*inclusiveAncestor);
}
} else if (!HTMLEditUtils::IsSimplyEditableNode(*nextContent)) {
return EditorDOMPointType::After(aContent);
} else if (!HTMLEditUtils::CanCrossContentBoundary(
*nextContent, aHowToTreatTableBoundary)) {
return EditorDOMPointType::After(aContent);
}
// Next, look for start of the next content.
nsIContent* leafContent = nextContent;
if (nextContent->GetChildCount() &&
HTMLEditUtils::IsContainerNode(*nextContent)) {
for (nsIContent* maybeLeafContent = nextContent->GetFirstChild();
maybeLeafContent;
maybeLeafContent = maybeLeafContent->GetFirstChild()) {
// If it's not an editable content or cannot cross the boundary,
// return the point at the content (i.e., start of its parent). Note
// that in this case, the content must not be any table elements except
// `<table>` because we've climbed down the tree.
if (!HTMLEditUtils::IsSimplyEditableNode(*maybeLeafContent) ||
!HTMLEditUtils::CanCrossContentBoundary(*maybeLeafContent,
aHowToTreatTableBoundary)) {
return EditorDOMPointType(maybeLeafContent);
}
leafContent = maybeLeafContent;
if (!HTMLEditUtils::IsContainerNode(*leafContent)) {
break;
}
}
}
if (leafContent->IsText()) {
Text* textNode = leafContent->AsText();
if (aInvisibleWhiteSpaces == InvisibleWhiteSpaces::Preserve) {
return EditorDOMPointType(textNode, 0);
}
// There may be invisible leading white-spaces which should be
// ignored. Let's scan its start.
return WSRunScanner::GetFirstVisiblePoint<EditorDOMPointType>(
*textNode, aAncestorLimiter);
}
// If it's a container element, return start of it. Otherwise, return
// the point at the non-container element (i.e., start of its parent).
return HTMLEditUtils::IsContainerNode(*leafContent)
? EditorDOMPointType(leafContent, 0)
: EditorDOMPointType(leafContent);
}
// static
Element* HTMLEditUtils::GetAncestorElement(
const nsIContent& aContent, const AncestorTypes& aAncestorTypes,
const Element* aAncestorLimiter /* = nullptr */) {
MOZ_ASSERT(
aAncestorTypes.contains(AncestorType::ClosestBlockElement) ||
aAncestorTypes.contains(AncestorType::MostDistantInlineElementInBlock));
if (&aContent == aAncestorLimiter) {
return nullptr;
}
const Element* theBodyElement = aContent.OwnerDoc()->GetBody();
const Element* theDocumentElement = aContent.OwnerDoc()->GetDocumentElement();
Element* lastAncestorElement = nullptr;
const bool editableElementOnly =
aAncestorTypes.contains(AncestorType::EditableElement);
const bool lookingForClosesetBlockElement =
aAncestorTypes.contains(AncestorType::ClosestBlockElement);
const bool lookingForMostDistantInlineElementInBlock =
aAncestorTypes.contains(AncestorType::MostDistantInlineElementInBlock);
const bool ignoreHRElement =
aAncestorTypes.contains(AncestorType::IgnoreHRElement);
auto isSerachingElementType = [&](const nsIContent& aContent) -> bool {
if (!aContent.IsElement() ||
(ignoreHRElement && aContent.IsHTMLElement(nsGkAtoms::hr))) {
return false;
}
if (editableElementOnly &&
!EditorUtils::IsEditableContent(aContent, EditorType::HTML)) {
return false;
}