...

range = SelectionRef().GetRangeAt(0); if (NS_WARN_IF(!range)) { return NS_ERROR_FAILURE; } ErrorResult error; RefPtr documentFragment = range->CreateContextualFragment(bodyTag, error); if (error.Failed()) { NS_WARNING("nsRange::CreateContextualFragment() failed"); return error.StealNSResult(); } if (!documentFragment) { NS_WARNING( "nsRange::CreateContextualFragment() didn't create DocumentFagement"); return NS_ERROR_FAILURE; } nsCOMPtr firstChild = documentFragment->GetFirstChild(); if (!firstChild || !firstChild->IsElement()) { NS_WARNING("First child of DocumentFragment was not an Element node"); return NS_ERROR_FAILURE; } // Copy all attributes from the div child to current body element CloneAttributesWithTransaction(*rootElement, MOZ_KnownLive(*firstChild->AsElement())); // place selection at first editable content rv = MaybeCollapseSelectionAtFirstEditableNode(false); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::MaybeCollapseSelectionAtFirstEditableNode(false) failed"); return rv; } NS_IMETHODIMP HTMLEditor::InsertElementAtSelection(Element* aElement, bool aDeleteSelection) { nsresult rv = InsertElementAtSelectionAsAction(aElement, aDeleteSelection); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::InsertElementAtSelectionAsAction() failed"); return rv; } nsresult HTMLEditor::InsertElementAtSelectionAsAction( Element* aElement, bool aDeleteSelection, nsIPrincipal* aPrincipal) { if (NS_WARN_IF(!aElement)) { return NS_ERROR_INVALID_ARG; } if (IsReadonly()) { return NS_OK; } AutoEditActionDataSetter editActionData( *this, HTMLEditUtils::GetEditActionForInsert(*aElement), aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } DebugOnly rvIgnored = CommitComposition(); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "EditorBase::CommitComposition() failed, but ignored"); { Result result = CanHandleHTMLEditSubAction(); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::CanHandleHTMLEditSubAction() failed"); return EditorBase::ToGenericNSResult(result.unwrapErr()); } if (result.inspect().Canceled()) { return NS_OK; } } UndefineCaretBidiLevel(); AutoPlaceholderBatch treatAsOneTransaction( *this, ScrollSelectionIntoView::Yes, __FUNCTION__); IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eInsertElement, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return ignoredError.StealNSResult(); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); rv = EnsureNoPaddingBRElementForEmptyEditor(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return EditorBase::ToGenericNSResult(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::EnsureNoPaddingBRElementForEmptyEditor() " "failed, but ignored"); if (NS_SUCCEEDED(rv) && SelectionRef().IsCollapsed()) { nsresult rv = EnsureCaretNotAfterInvisibleBRElement(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return EditorBase::ToGenericNSResult(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::EnsureCaretNotAfterInvisibleBRElement() " "failed, but ignored"); if (NS_SUCCEEDED(rv)) { nsresult rv = PrepareInlineStylesForCaret(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return EditorBase::ToGenericNSResult(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::PrepareInlineStylesForCaret() failed, but ignored"); } } if (aDeleteSelection) { if (!HTMLEditUtils::IsBlockElement( *aElement, BlockInlineCheck::UseComputedDisplayOutsideStyle)) { // E.g., inserting an image. In this case we don't need to delete any // inline wrappers before we do the insertion. Otherwise we let // DeleteSelectionAndPrepareToCreateNode do the deletion for us, which // calls DeleteSelection with aStripWrappers = eStrip. nsresult rv = DeleteSelectionAsSubAction(eNone, eNoStrip); if (NS_FAILED(rv)) { NS_WARNING( "EditorBase::DeleteSelectionAsSubAction(eNone, eNoStrip) failed"); return EditorBase::ToGenericNSResult(rv); } } nsresult rv = DeleteSelectionAndPrepareToCreateNode(); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::DeleteSelectionAndPrepareToCreateNode() failed"); return rv; } } // If deleting, selection will be collapsed. // so if not, we collapse it else { // Named Anchor is a special case, // We collapse to insert element BEFORE the selection // For all other tags, we insert AFTER the selection if (HTMLEditUtils::IsNamedAnchor(aElement)) { IgnoredErrorResult ignoredError; SelectionRef().CollapseToStart(ignoredError); if (NS_WARN_IF(Destroyed())) { return EditorBase::ToGenericNSResult(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION(!ignoredError.Failed(), "Selection::CollapseToStart() failed, but ignored"); } else { IgnoredErrorResult ignoredError; SelectionRef().CollapseToEnd(ignoredError); if (NS_WARN_IF(Destroyed())) { return EditorBase::ToGenericNSResult(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION(!ignoredError.Failed(), "Selection::CollapseToEnd() failed, but ignored"); } } if (!SelectionRef().GetAnchorNode()) { return NS_OK; } Element* editingHost = ComputeEditingHost(LimitInBodyElement::No); if (NS_WARN_IF(!editingHost)) { return EditorBase::ToGenericNSResult(NS_ERROR_FAILURE); } EditorRawDOMPoint atAnchor(SelectionRef().AnchorRef()); // Adjust position based on the node we are going to insert. EditorDOMPoint pointToInsert = HTMLEditUtils::GetBetterInsertionPointFor( *aElement, atAnchor, *editingHost); if (!pointToInsert.IsSet()) { NS_WARNING("HTMLEditUtils::GetBetterInsertionPointFor() failed"); return NS_ERROR_FAILURE; } { Result insertElementResult = InsertNodeIntoProperAncestorWithTransaction( *aElement, pointToInsert, SplitAtEdges::eAllowToCreateEmptyContainer); if (MOZ_UNLIKELY(insertElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertNodeIntoProperAncestorWithTransaction(" "SplitAtEdges::eAllowToCreateEmptyContainer) failed"); return EditorBase::ToGenericNSResult(insertElementResult.unwrapErr()); } insertElementResult.inspect().IgnoreCaretPointSuggestion(); } // Set caret after element, but check for special case // of inserting table-related elements: set in first cell instead if (!SetCaretInTableCell(aElement)) { if (NS_WARN_IF(Destroyed())) { return EditorBase::ToGenericNSResult(NS_ERROR_EDITOR_DESTROYED); } nsresult rv = CollapseSelectionTo(EditorRawDOMPoint::After(*aElement)); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::CollapseSelectionTo() failed"); return EditorBase::ToGenericNSResult(rv); } } // check for inserting a whole table at the end of a block. If so insert // a br after it. if (!HTMLEditUtils::IsTable(aElement) || !HTMLEditUtils::IsLastChild(*aElement, {WalkTreeOption::IgnoreNonEditableNode})) { return NS_OK; } const auto afterElement = EditorDOMPoint::After(*aElement); // Collapse selection to the new `
` element node after creating it. Result insertBRElementResult = InsertBRElement(WithTransaction::Yes, afterElement, ePrevious); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertBRElement(WithTransaction::Yes, ePrevious) failed"); return EditorBase::ToGenericNSResult(insertBRElementResult.unwrapErr()); } rv = insertBRElementResult.inspect().SuggestCaretPointTo(*this, {}); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionTo() failed"); MOZ_ASSERT(insertBRElementResult.inspect().GetNewNode()); return EditorBase::ToGenericNSResult(rv); } template Result, nsresult> HTMLEditor::InsertNodeIntoProperAncestorWithTransaction( NodeType& aContentToInsert, const EditorDOMPoint& aPointToInsert, SplitAtEdges aSplitAtEdges) { MOZ_ASSERT(aPointToInsert.IsSetAndValidInComposedDoc()); if (NS_WARN_IF(!aPointToInsert.IsSet())) { return Err(NS_ERROR_FAILURE); } MOZ_ASSERT(aPointToInsert.IsSetAndValid()); if (aContentToInsert.NodeType() == nsINode::DOCUMENT_TYPE_NODE || aContentToInsert.NodeType() == nsINode::PROCESSING_INSTRUCTION_NODE) { return CreateNodeResultBase::NotHandled(); } // Search up the parent chain to find a suitable container. EditorDOMPoint pointToInsert(aPointToInsert); MOZ_ASSERT(pointToInsert.IsSet()); while (!HTMLEditUtils::CanNodeContain(*pointToInsert.GetContainer(), aContentToInsert)) { // If the current parent is a root (body or table element) // then go no further - we can't insert. if (MOZ_UNLIKELY( pointToInsert.IsContainerHTMLElement(nsGkAtoms::body) || HTMLEditUtils::IsAnyTableElement(pointToInsert.GetContainer()))) { NS_WARNING( "There was no proper container element to insert the content node in " "the document"); return Err(NS_ERROR_FAILURE); } // Get the next point. pointToInsert = pointToInsert.ParentPoint(); if (MOZ_UNLIKELY( !pointToInsert.IsInContentNode() || !EditorUtils::IsEditableContent( *pointToInsert.ContainerAs(), EditorType::HTML))) { NS_WARNING( "There was no proper container element to insert the content node in " "the editing host"); return Err(NS_ERROR_FAILURE); } } if (pointToInsert != aPointToInsert) { // We need to split some levels above the original selection parent. MOZ_ASSERT(pointToInsert.GetChild()); Result splitNodeResult = SplitNodeDeepWithTransaction(MOZ_KnownLive(*pointToInsert.GetChild()), aPointToInsert, aSplitAtEdges); if (MOZ_UNLIKELY(splitNodeResult.isErr())) { NS_WARNING("HTMLEditor::SplitNodeDeepWithTransaction() failed"); return splitNodeResult.propagateErr(); } pointToInsert = splitNodeResult.inspect().template AtSplitPoint(); MOZ_ASSERT(pointToInsert.IsSetAndValidInComposedDoc()); // Caret should be set by the caller of this method so that we don't // need to handle it here. splitNodeResult.inspect().IgnoreCaretPointSuggestion(); } // Now we can insert the new node. Result, nsresult> insertContentNodeResult = InsertNodeWithTransaction(aContentToInsert, pointToInsert); if (MOZ_LIKELY(insertContentNodeResult.isOk()) && MOZ_UNLIKELY(NS_WARN_IF(!aContentToInsert.GetParentNode()) || NS_WARN_IF(aContentToInsert.GetParentNode() != pointToInsert.GetContainer()))) { NS_WARNING( "EditorBase::InsertNodeWithTransaction() succeeded, but the inserted " "node was moved or removed by the web app"); insertContentNodeResult.inspect().IgnoreCaretPointSuggestion(); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } NS_WARNING_ASSERTION(insertContentNodeResult.isOk(), "EditorBase::InsertNodeWithTransaction() failed"); return insertContentNodeResult; } NS_IMETHODIMP HTMLEditor::SelectElement(Element* aElement) { if (NS_WARN_IF(!aElement)) { return NS_ERROR_INVALID_ARG; } AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } nsresult rv = SelectContentInternal(MOZ_KnownLive(*aElement)); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::SelectContentInternal() failed"); return rv; } nsresult HTMLEditor::SelectContentInternal(nsIContent& aContentToSelect) { MOZ_ASSERT(IsEditActionDataAvailable()); // Must be sure that element is contained in the editing host const RefPtr editingHost = ComputeEditingHost(); if (NS_WARN_IF(!editingHost) || NS_WARN_IF(!aContentToSelect.IsInclusiveDescendantOf(editingHost))) { return NS_ERROR_FAILURE; } EditorRawDOMPoint newSelectionStart(&aContentToSelect); if (NS_WARN_IF(!newSelectionStart.IsSet())) { return NS_ERROR_FAILURE; } EditorRawDOMPoint newSelectionEnd(EditorRawDOMPoint::After(aContentToSelect)); MOZ_ASSERT(newSelectionEnd.IsSet()); ErrorResult error; SelectionRef().SetStartAndEndInLimiter(newSelectionStart, newSelectionEnd, error); NS_WARNING_ASSERTION(!error.Failed(), "Selection::SetStartAndEndInLimiter() failed"); return error.StealNSResult(); } nsresult HTMLEditor::AppendContentToSelectionAsRange(nsIContent& aContent) { MOZ_ASSERT(IsEditActionDataAvailable()); EditorRawDOMPoint atContent(&aContent); if (NS_WARN_IF(!atContent.IsSet())) { return NS_ERROR_FAILURE; } RefPtr range = nsRange::Create( atContent.ToRawRangeBoundary(), atContent.NextPoint().ToRawRangeBoundary(), IgnoreErrors()); if (NS_WARN_IF(!range)) { NS_WARNING("nsRange::Create() failed"); return NS_ERROR_FAILURE; } ErrorResult error; SelectionRef().AddRangeAndSelectFramesAndNotifyListeners(*range, error); if (NS_WARN_IF(Destroyed())) { if (error.Failed()) { error.SuppressException(); } return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(!error.Failed(), "Failed to add range to Selection"); return error.StealNSResult(); } nsresult HTMLEditor::ClearSelection() { MOZ_ASSERT(IsEditActionDataAvailable()); ErrorResult error; SelectionRef().RemoveAllRanges(error); if (NS_WARN_IF(Destroyed())) { if (error.Failed()) { error.SuppressException(); } return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(!error.Failed(), "Selection::RemoveAllRanges() failed"); return error.StealNSResult(); } nsresult HTMLEditor::FormatBlockAsAction(const nsAString& aParagraphFormat, nsIPrincipal* aPrincipal) { AutoEditActionDataSetter editActionData( *this, EditAction::eInsertBlockElement, aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } if (NS_WARN_IF(aParagraphFormat.IsEmpty())) { return NS_ERROR_INVALID_ARG; } RefPtr tagName = NS_Atomize(aParagraphFormat); MOZ_ASSERT(tagName); if (NS_WARN_IF(!tagName->IsStatic()) || NS_WARN_IF(!HTMLEditUtils::IsFormatTagForFormatBlockCommand( *tagName->AsStatic()))) { return NS_ERROR_INVALID_ARG; } if (tagName == nsGkAtoms::dd || tagName == nsGkAtoms::dt) { // MOZ_KnownLive(tagName->AsStatic()) because nsStaticAtom instances live // while the process is running. Result result = MakeOrChangeListAndListItemAsSubAction( MOZ_KnownLive(*tagName->AsStatic()), u""_ns, SelectAllOfCurrentList::No); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING( "HTMLEditor::MakeOrChangeListAndListItemAsSubAction(" "SelectAllOfCurrentList::No) failed"); return EditorBase::ToGenericNSResult(result.unwrapErr()); } return NS_OK; } rv = FormatBlockContainerAsSubAction(MOZ_KnownLive(*tagName->AsStatic()), FormatBlockMode::HTMLFormatBlockCommand); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::FormatBlockContainerAsSubAction() failed"); return EditorBase::ToGenericNSResult(rv); } nsresult HTMLEditor::SetParagraphStateAsAction( const nsAString& aParagraphFormat, nsIPrincipal* aPrincipal) { AutoEditActionDataSetter editActionData( *this, EditAction::eInsertBlockElement, aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } // TODO: Computing the editing host here makes the `execCommand` in // docshell/base/crashtests/file_432114-2.xhtml cannot run // `DOMNodeRemoved` event listener with deleting the bogus
element. // So that it should be rewritten with different mutation event listener // since we'd like to stop using it. nsAutoString lowerCaseTagName(aParagraphFormat); ToLowerCase(lowerCaseTagName); RefPtr tagName = NS_Atomize(lowerCaseTagName); MOZ_ASSERT(tagName); if (NS_WARN_IF(!tagName->IsStatic())) { return NS_ERROR_INVALID_ARG; } if (tagName == nsGkAtoms::dd || tagName == nsGkAtoms::dt) { // MOZ_KnownLive(tagName->AsStatic()) because nsStaticAtom instances live // while the process is running. Result result = MakeOrChangeListAndListItemAsSubAction( MOZ_KnownLive(*tagName->AsStatic()), u""_ns, SelectAllOfCurrentList::No); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING( "HTMLEditor::MakeOrChangeListAndListItemAsSubAction(" "SelectAllOfCurrentList::No) failed"); return EditorBase::ToGenericNSResult(result.unwrapErr()); } return NS_OK; } rv = FormatBlockContainerAsSubAction( MOZ_KnownLive(*tagName->AsStatic()), FormatBlockMode::XULParagraphStateCommand); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::FormatBlockContainerAsSubAction() failed"); return EditorBase::ToGenericNSResult(rv); } // static bool HTMLEditor::IsFormatElement(FormatBlockMode aFormatBlockMode, const nsIContent& aContent) { // FYI: Optimize for HTML command because it may run too many times. return MOZ_LIKELY(aFormatBlockMode == FormatBlockMode::HTMLFormatBlockCommand) ? HTMLEditUtils::IsFormatElementForFormatBlockCommand(aContent) : (HTMLEditUtils::IsFormatElementForParagraphStateCommand( aContent) && // XXX The XUL paragraph state command treats

and //
elements but all handlers do not treat them as a format // node. Therefore, we keep the traditional behavior here. !aContent.IsAnyOfHTMLElements(nsGkAtoms::dd, nsGkAtoms::dl, nsGkAtoms::dt)); } NS_IMETHODIMP HTMLEditor::GetParagraphState(bool* aMixed, nsAString& aFirstParagraphState) { if (NS_WARN_IF(!aMixed)) { return NS_ERROR_INVALID_ARG; } if (!mInitSucceeded) { return NS_ERROR_NOT_INITIALIZED; } ErrorResult error; ParagraphStateAtSelection paragraphState( *this, FormatBlockMode::XULParagraphStateCommand, error); if (error.Failed()) { NS_WARNING("ParagraphStateAtSelection failed"); return error.StealNSResult(); } *aMixed = paragraphState.IsMixed(); if (NS_WARN_IF(!paragraphState.GetFirstParagraphStateAtSelection())) { // XXX Odd result, but keep this behavior for now... aFirstParagraphState.AssignASCII("x"); } else { paragraphState.GetFirstParagraphStateAtSelection()->ToString( aFirstParagraphState); } return NS_OK; } nsresult HTMLEditor::GetBackgroundColorState(bool* aMixed, nsAString& aOutColor) { if (NS_WARN_IF(!aMixed)) { return NS_ERROR_INVALID_ARG; } AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } if (IsCSSEnabled()) { // if we are in CSS mode, we have to check if the containing block defines // a background color nsresult rv = GetCSSBackgroundColorState(aMixed, aOutColor, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::GetCSSBackgroundColorState() failed"); return EditorBase::ToGenericNSResult(rv); } // in HTML mode, we look only at page's background nsresult rv = GetHTMLBackgroundColorState(aMixed, aOutColor); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::GetCSSBackgroundColorState() failed"); return EditorBase::ToGenericNSResult(rv); } NS_IMETHODIMP HTMLEditor::GetHighlightColorState(bool* aMixed, nsAString& aOutColor) { if (NS_WARN_IF(!aMixed)) { return NS_ERROR_INVALID_ARG; } *aMixed = false; aOutColor.AssignLiteral("transparent"); if (!IsCSSEnabled()) { return NS_OK; } AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } // in CSS mode, text background can be added by the Text Highlight button // we need to query the background of the selection without looking for // the block container of the ranges in the selection nsresult rv = GetCSSBackgroundColorState(aMixed, aOutColor, false); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::GetCSSBackgroundColorState() failed"); return rv; } nsresult HTMLEditor::GetCSSBackgroundColorState(bool* aMixed, nsAString& aOutColor, bool aBlockLevel) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!aMixed)) { return NS_ERROR_INVALID_ARG; } *aMixed = false; // the default background color is transparent aOutColor.AssignLiteral("transparent"); RefPtr firstRange = SelectionRef().GetRangeAt(0); if (NS_WARN_IF(!firstRange)) { return NS_ERROR_FAILURE; } nsCOMPtr startContainer = firstRange->GetStartContainer(); if (NS_WARN_IF(!startContainer) || NS_WARN_IF(!startContainer->IsContent())) { return NS_ERROR_FAILURE; } // is the selection collapsed? nsIContent* contentToExamine; if (SelectionRef().IsCollapsed() || startContainer->IsText()) { if (NS_WARN_IF(!startContainer->IsContent())) { return NS_ERROR_FAILURE; } // we want to look at the startContainer and ancestors contentToExamine = startContainer->AsContent(); } else { // otherwise we want to look at the first editable node after // {startContainer,offset} and its ancestors for divs with alignment on them contentToExamine = firstRange->GetChildAtStartOffset(); // GetNextNode(startContainer, offset, true, address_of(contentToExamine)); } if (NS_WARN_IF(!contentToExamine)) { return NS_ERROR_FAILURE; } if (aBlockLevel) { // we are querying the block background (and not the text background), let's // climb to the block container. Note that background color of ancestor // of editing host may be what the caller wants to know. Therefore, we // should ignore the editing host boundaries. Element* const closestBlockElement = HTMLEditUtils::GetInclusiveAncestorElement( *contentToExamine, HTMLEditUtils::ClosestBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (NS_WARN_IF(!closestBlockElement)) { return NS_OK; } for (RefPtr blockElement = closestBlockElement; blockElement;) { RefPtr nextBlockElement = HTMLEditUtils::GetAncestorElement( *blockElement, HTMLEditUtils::ClosestBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); DebugOnly rvIgnored = CSSEditUtils::GetComputedProperty( *blockElement, *nsGkAtoms::backgroundColor, aOutColor); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (MayHaveMutationEventListeners() && NS_WARN_IF(nextBlockElement != HTMLEditUtils::GetAncestorElement( *blockElement, HTMLEditUtils::ClosestBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle))) { return NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "CSSEditUtils::GetComputedProperty(nsGkAtoms::" "backgroundColor) failed, but ignored"); // look at parent if the queried color is transparent and if the node to // examine is not the root of the document if (!aOutColor.EqualsLiteral("transparent") && !aOutColor.EqualsLiteral("rgba(0, 0, 0, 0)")) { break; } blockElement = std::move(nextBlockElement); } if (aOutColor.EqualsLiteral("transparent") || aOutColor.EqualsLiteral("rgba(0, 0, 0, 0)")) { // we have hit the root of the document and the color is still transparent // ! Grumble... Let's look at the default background color because that's // the color we are looking for CSSEditUtils::GetDefaultBackgroundColor(aOutColor); } } else { // no, we are querying the text background for the Text Highlight button if (contentToExamine->IsText()) { // if the node of interest is a text node, let's climb a level contentToExamine = contentToExamine->GetParent(); } // Return default value due to no parent node if (!contentToExamine) { return NS_OK; } for (RefPtr element = contentToExamine->GetAsElementOrParentElement(); element; element = element->GetParentElement()) { // is the node to examine a block ? if (HTMLEditUtils::IsBlockElement( *element, BlockInlineCheck::UseComputedDisplayOutsideStyle)) { // yes it is a block; in that case, the text background color is // transparent aOutColor.AssignLiteral("transparent"); break; } // no, it's not; let's retrieve the computed style of background-color // for the node to examine nsCOMPtr parentNode = element->GetParentNode(); DebugOnly rvIgnored = CSSEditUtils::GetComputedProperty( *element, *nsGkAtoms::backgroundColor, aOutColor); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (NS_WARN_IF(parentNode != element->GetParentNode())) { return NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "CSSEditUtils::GetComputedProperty(nsGkAtoms::" "backgroundColor) failed, but ignored"); if (!aOutColor.EqualsLiteral("transparent")) { break; } } } return NS_OK; } nsresult HTMLEditor::GetHTMLBackgroundColorState(bool* aMixed, nsAString& aOutColor) { MOZ_ASSERT(IsEditActionDataAvailable()); // TODO: We don't handle "mixed" correctly! if (NS_WARN_IF(!aMixed)) { return NS_ERROR_INVALID_ARG; } *aMixed = false; aOutColor.Truncate(); Result, nsresult> cellOrRowOrTableElementOrError = GetSelectedOrParentTableElement(); if (cellOrRowOrTableElementOrError.isErr()) { NS_WARNING("HTMLEditor::GetSelectedOrParentTableElement() returned error"); return cellOrRowOrTableElementOrError.unwrapErr(); } for (RefPtr element = cellOrRowOrTableElementOrError.unwrap(); element; element = element->GetParentElement()) { // We are in a cell or selected table element->GetAttr(nsGkAtoms::bgcolor, aOutColor); // Done if we have a color explicitly set if (!aOutColor.IsEmpty()) { return NS_OK; } // Once we hit the body, we're done if (element->IsHTMLElement(nsGkAtoms::body)) { return NS_OK; } // No color is set, but we need to report visible color inherited // from nested cells/tables, so search up parent chain so that // let's keep checking the ancestors. } // If no table or cell found, get page body Element* rootElement = GetRoot(); if (NS_WARN_IF(!rootElement)) { return NS_ERROR_FAILURE; } rootElement->GetAttr(nsGkAtoms::bgcolor, aOutColor); return NS_OK; } NS_IMETHODIMP HTMLEditor::GetListState(bool* aMixed, bool* aOL, bool* aUL, bool* aDL) { if (NS_WARN_IF(!aMixed) || NS_WARN_IF(!aOL) || NS_WARN_IF(!aUL) || NS_WARN_IF(!aDL)) { return NS_ERROR_INVALID_ARG; } if (!mInitSucceeded) { return NS_ERROR_NOT_INITIALIZED; } ErrorResult error; ListElementSelectionState state(*this, error); if (error.Failed()) { NS_WARNING("ListElementSelectionState failed"); return error.StealNSResult(); } *aMixed = state.IsNotOneTypeListElementSelected(); *aOL = state.IsOLElementSelected(); *aUL = state.IsULElementSelected(); *aDL = state.IsDLElementSelected(); return NS_OK; } NS_IMETHODIMP HTMLEditor::GetListItemState(bool* aMixed, bool* aLI, bool* aDT, bool* aDD) { if (NS_WARN_IF(!aMixed) || NS_WARN_IF(!aLI) || NS_WARN_IF(!aDT) || NS_WARN_IF(!aDD)) { return NS_ERROR_INVALID_ARG; } if (!mInitSucceeded) { return NS_ERROR_NOT_INITIALIZED; } ErrorResult error; ListItemElementSelectionState state(*this, error); if (error.Failed()) { NS_WARNING("ListItemElementSelectionState failed"); return error.StealNSResult(); } // XXX Why do we ignore `
` element selected state? *aMixed = state.IsNotOneTypeDefinitionListItemElementSelected(); *aLI = state.IsLIElementSelected(); *aDT = state.IsDTElementSelected(); *aDD = state.IsDDElementSelected(); return NS_OK; } NS_IMETHODIMP HTMLEditor::GetAlignment(bool* aMixed, nsIHTMLEditor::EAlignment* aAlign) { if (NS_WARN_IF(!aMixed) || NS_WARN_IF(!aAlign)) { return NS_ERROR_INVALID_ARG; } if (!mInitSucceeded) { return NS_ERROR_NOT_INITIALIZED; } ErrorResult error; AlignStateAtSelection state(*this, error); if (error.Failed()) { NS_WARNING("AlignStateAtSelection failed"); return error.StealNSResult(); } *aMixed = false; *aAlign = state.AlignmentAtSelectionStart(); return NS_OK; } NS_IMETHODIMP HTMLEditor::MakeOrChangeList(const nsAString& aListType, bool aEntireList, const nsAString& aBulletType) { RefPtr listTagName = NS_Atomize(aListType); if (NS_WARN_IF(!listTagName) || NS_WARN_IF(!listTagName->IsStatic())) { return NS_ERROR_INVALID_ARG; } // MOZ_KnownLive(listTagName->AsStatic()) because nsStaticAtom instances live // while the process is running. nsresult rv = MakeOrChangeListAsAction( MOZ_KnownLive(*listTagName->AsStatic()), aBulletType, aEntireList ? SelectAllOfCurrentList::Yes : SelectAllOfCurrentList::No); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::MakeOrChangeListAsAction() failed"); return rv; } nsresult HTMLEditor::MakeOrChangeListAsAction( const nsStaticAtom& aListElementTagName, const nsAString& aBulletType, SelectAllOfCurrentList aSelectAllOfCurrentList, nsIPrincipal* aPrincipal) { if (NS_WARN_IF(!mInitSucceeded)) { return NS_ERROR_NOT_INITIALIZED; } AutoEditActionDataSetter editActionData( *this, HTMLEditUtils::GetEditActionForInsert(aListElementTagName), aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } Result result = MakeOrChangeListAndListItemAsSubAction(aListElementTagName, aBulletType, aSelectAllOfCurrentList); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::MakeOrChangeListAndListItemAsSubAction() failed"); return EditorBase::ToGenericNSResult(result.unwrapErr()); } return NS_OK; } NS_IMETHODIMP HTMLEditor::RemoveList(const nsAString& aListType) { nsresult rv = RemoveListAsAction(aListType); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::RemoveListAsAction() failed"); return rv; } nsresult HTMLEditor::RemoveListAsAction(const nsAString& aListType, nsIPrincipal* aPrincipal) { if (NS_WARN_IF(!mInitSucceeded)) { return NS_ERROR_NOT_INITIALIZED; } // Note that we ignore aListType when we actually remove parent list elements. // However, we need to set InputEvent.inputType to "insertOrderedList" or // "insertedUnorderedList" when this is called for // execCommand("insertorderedlist") or execCommand("insertunorderedlist"). // Otherwise, comm-central UI may call this methods with "dl" or "". // So, it's okay to use mismatched EditAction here if this is called in // comm-central. RefPtr listAtom = NS_Atomize(aListType); if (NS_WARN_IF(!listAtom)) { return NS_ERROR_INVALID_ARG; } AutoEditActionDataSetter editActionData( *this, HTMLEditUtils::GetEditActionForRemoveList(*listAtom), aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } const RefPtr editingHost = ComputeEditingHost(); if (!editingHost) { return NS_SUCCESS_DOM_NO_OPERATION; } rv = RemoveListAtSelectionAsSubAction(*editingHost); NS_WARNING_ASSERTION(NS_FAILED(rv), "HTMLEditor::RemoveListAtSelectionAsSubAction() failed"); return rv; } nsresult HTMLEditor::FormatBlockContainerAsSubAction( const nsStaticAtom& aTagName, FormatBlockMode aFormatBlockMode) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!mInitSucceeded)) { return NS_ERROR_NOT_INITIALIZED; } MOZ_ASSERT(&aTagName != nsGkAtoms::dd && &aTagName != nsGkAtoms::dt); AutoPlaceholderBatch treatAsOneTransaction( *this, ScrollSelectionIntoView::Yes, __FUNCTION__); IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eCreateOrRemoveBlock, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return ignoredError.StealNSResult(); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); { Result result = CanHandleHTMLEditSubAction(); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::CanHandleHTMLEditSubAction() failed"); return result.unwrapErr(); } if (result.inspect().Canceled()) { return NS_OK; } } if (IsSelectionRangeContainerNotContent()) { return NS_SUCCESS_DOM_NO_OPERATION; } nsresult rv = EnsureNoPaddingBRElementForEmptyEditor(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::EnsureNoPaddingBRElementForEmptyEditor() " "failed, but ignored"); if (NS_SUCCEEDED(rv) && SelectionRef().IsCollapsed()) { nsresult rv = EnsureCaretNotAfterInvisibleBRElement(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::EnsureCaretNotAfterInvisibleBRElement() " "failed, but ignored"); if (NS_SUCCEEDED(rv)) { nsresult rv = PrepareInlineStylesForCaret(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::PrepareInlineStylesForCaret() failed, but ignored"); } } // FormatBlockContainerWithTransaction() creates AutoSelectionRestorer. // Therefore, even if it returns NS_OK, editor might have been destroyed // at restoring Selection. const RefPtr editingHost = ComputeEditingHost(); if (MOZ_UNLIKELY(!editingHost)) { return NS_SUCCESS_DOM_NO_OPERATION; } AutoRangeArray selectionRanges(SelectionRef()); Result, nsresult> suggestBlockElementToPutCaretOrError = FormatBlockContainerWithTransaction(selectionRanges, aTagName, aFormatBlockMode, *editingHost); if (suggestBlockElementToPutCaretOrError.isErr()) { NS_WARNING("HTMLEditor::FormatBlockContainerWithTransaction() failed"); return suggestBlockElementToPutCaretOrError.unwrapErr(); } if (selectionRanges.HasSavedRanges()) { selectionRanges.RestoreFromSavedRanges(); } rv = selectionRanges.ApplyTo(SelectionRef()); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (NS_FAILED(rv)) { NS_WARNING("AutoRangeArray::ApplyTo(SelectionRef()) failed, but ignored"); return rv; } rv = MaybeInsertPaddingBRElementForEmptyLastLineAtSelection(); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::MaybeInsertPaddingBRElementForEmptyLastLineAtSelection() " "failed"); if (!suggestBlockElementToPutCaretOrError.inspect() || !SelectionRef().IsCollapsed()) { return rv; } const auto firstSelectionStartPoint = GetFirstSelectionStartPoint(); if (MOZ_UNLIKELY(!firstSelectionStartPoint.IsSet())) { return rv; } Result pointInBlockElementOrError = HTMLEditUtils::ComputePointToPutCaretInElementIfOutside< EditorRawDOMPoint>(*suggestBlockElementToPutCaretOrError.inspect(), firstSelectionStartPoint); if (MOZ_UNLIKELY(pointInBlockElementOrError.isErr())) { NS_WARNING( "HTMLEditUtils::ComputePointToPutCaretInElementIfOutside() failed, but " "ignored"); return rv; } // Note that if the point is unset, it means that firstSelectionStartPoint is // in the block element. if (pointInBlockElementOrError.inspect().IsSet()) { nsresult rvOfCollapseSelection = CollapseSelectionTo(pointInBlockElementOrError.inspect()); if (MOZ_UNLIKELY(rvOfCollapseSelection == NS_ERROR_EDITOR_DESTROYED)) { NS_WARNING("EditorBase::CollapseSelectionTo() failed"); return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rvOfCollapseSelection), "EditorBase::CollapseSelectionTo() failed, but ignored"); } return rv; } nsresult HTMLEditor::IndentAsAction(nsIPrincipal* aPrincipal) { if (NS_WARN_IF(!mInitSucceeded)) { return NS_ERROR_NOT_INITIALIZED; } AutoEditActionDataSetter editActionData(*this, EditAction::eIndent, aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } const RefPtr editingHost = ComputeEditingHost(); if (!editingHost) { return NS_SUCCESS_DOM_NO_OPERATION; } Result result = IndentAsSubAction(*editingHost); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::IndentAsSubAction() failed"); return EditorBase::ToGenericNSResult(result.unwrapErr()); } return NS_OK; } nsresult HTMLEditor::OutdentAsAction(nsIPrincipal* aPrincipal) { if (NS_WARN_IF(!mInitSucceeded)) { return NS_ERROR_NOT_INITIALIZED; } AutoEditActionDataSetter editActionData(*this, EditAction::eOutdent, aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } const RefPtr editingHost = ComputeEditingHost(); if (!editingHost) { return NS_SUCCESS_DOM_NO_OPERATION; } Result result = OutdentAsSubAction(*editingHost); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::OutdentAsSubAction() failed"); return EditorBase::ToGenericNSResult(result.unwrapErr()); } return NS_OK; } // TODO: IMPLEMENT ALIGNMENT! nsresult HTMLEditor::AlignAsAction(const nsAString& aAlignType, nsIPrincipal* aPrincipal) { AutoEditActionDataSetter editActionData( *this, HTMLEditUtils::GetEditActionForAlignment(aAlignType), aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } const RefPtr editingHost = ComputeEditingHost(); if (!editingHost) { return NS_SUCCESS_DOM_NO_OPERATION; } Result result = AlignAsSubAction(aAlignType, *editingHost); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::AlignAsSubAction() failed"); return EditorBase::ToGenericNSResult(result.unwrapErr()); } return NS_OK; } Element* HTMLEditor::GetInclusiveAncestorByTagName(const nsStaticAtom& aTagName, nsIContent& aContent) const { MOZ_ASSERT(&aTagName != nsGkAtoms::_empty); AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return nullptr; } return GetInclusiveAncestorByTagNameInternal(aTagName, aContent); } Element* HTMLEditor::GetInclusiveAncestorByTagNameAtSelection( const nsStaticAtom& aTagName) const { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(&aTagName != nsGkAtoms::_empty); // If no node supplied, get it from anchor node of current selection const EditorRawDOMPoint atAnchor(SelectionRef().AnchorRef()); if (NS_WARN_IF(!atAnchor.IsInContentNode())) { return nullptr; } // Try to get the actual selected node nsIContent* content = nullptr; if (atAnchor.GetContainer()->HasChildNodes() && atAnchor.ContainerAs()) { content = atAnchor.GetChild(); } // Anchor node is probably a text node - just use that if (!content) { content = atAnchor.ContainerAs(); if (NS_WARN_IF(!content)) { return nullptr; } } return GetInclusiveAncestorByTagNameInternal(aTagName, *content); } Element* HTMLEditor::GetInclusiveAncestorByTagNameInternal( const nsStaticAtom& aTagName, const nsIContent& aContent) const { MOZ_ASSERT(&aTagName != nsGkAtoms::_empty); Element* currentElement = aContent.GetAsElementOrParentElement(); if (NS_WARN_IF(!currentElement)) { MOZ_ASSERT(!aContent.GetParentNode()); return nullptr; } bool lookForLink = IsLinkTag(aTagName); bool lookForNamedAnchor = IsNamedAnchorTag(aTagName); for (Element* element : currentElement->InclusiveAncestorsOfType()) { // Stop searching if parent is a body element. Note: Originally used // IsRoot() to/ stop at table cells, but that's too messy when you are // trying to find the parent table. if (element->IsHTMLElement(nsGkAtoms::body)) { return nullptr; } if (lookForLink) { // Test if we have a link (an anchor with href set) if (HTMLEditUtils::IsLink(element)) { return element; } } else if (lookForNamedAnchor) { // Test if we have a named anchor (an anchor with name set) if (HTMLEditUtils::IsNamedAnchor(element)) { return element; } } else if (&aTagName == nsGkAtoms::list_) { // Match "ol", "ul", or "dl" for lists if (HTMLEditUtils::IsAnyListElement(element)) { return element; } } else if (&aTagName == nsGkAtoms::td) { // Table cells are another special case: match either "td" or "th" if (HTMLEditUtils::IsTableCell(element)) { return element; } } else if (&aTagName == element->NodeInfo()->NameAtom()) { return element; } } return nullptr; } NS_IMETHODIMP HTMLEditor::GetElementOrParentByTagName(const nsAString& aTagName, nsINode* aNode, Element** aReturn) { if (NS_WARN_IF(aTagName.IsEmpty()) || NS_WARN_IF(!aReturn)) { return NS_ERROR_INVALID_ARG; } nsStaticAtom* tagName = EditorUtils::GetTagNameAtom(aTagName); if (NS_WARN_IF(!tagName)) { // We don't need to support custom elements since this is an internal API. return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND; } if (NS_WARN_IF(tagName == nsGkAtoms::_empty)) { return NS_ERROR_INVALID_ARG; } if (!aNode) { AutoEditActionDataSetter dummyEditAction(*this, EditAction::eNotEditing); if (NS_WARN_IF(!dummyEditAction.CanHandle())) { return NS_ERROR_NOT_AVAILABLE; } RefPtr parentElement = GetInclusiveAncestorByTagNameAtSelection(*tagName); if (!parentElement) { return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND; } parentElement.forget(aReturn); return NS_OK; } if (!aNode->IsContent() || !aNode->GetAsElementOrParentElement()) { return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND; } RefPtr parentElement = GetInclusiveAncestorByTagName(*tagName, *aNode->AsContent()); if (!parentElement) { return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND; } parentElement.forget(aReturn); return NS_OK; } NS_IMETHODIMP HTMLEditor::GetSelectedElement(const nsAString& aTagName, nsISupports** aReturn) { if (NS_WARN_IF(!aReturn)) { return NS_ERROR_INVALID_ARG; } *aReturn = nullptr; AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } ErrorResult error; nsStaticAtom* tagName = EditorUtils::GetTagNameAtom(aTagName); if (!aTagName.IsEmpty() && !tagName) { // We don't need to support custom elements becaus of internal API. return NS_OK; } RefPtr selectedNode = GetSelectedElement(tagName, error); NS_WARNING_ASSERTION(!error.Failed(), "HTMLEditor::GetSelectedElement() failed"); selectedNode.forget(aReturn); return error.StealNSResult(); } already_AddRefed HTMLEditor::GetSelectedElement(const nsAtom* aTagName, ErrorResult& aRv) { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(!aRv.Failed()); // If there is no Selection or two or more selection ranges, that means that // not only one element is selected so that return nullptr. if (SelectionRef().RangeCount() != 1) { return nullptr; } bool isLinkTag = aTagName && IsLinkTag(*aTagName); bool isNamedAnchorTag = aTagName && IsNamedAnchorTag(*aTagName); RefPtr firstRange = SelectionRef().GetRangeAt(0); MOZ_ASSERT(firstRange); const RangeBoundary& startRef = firstRange->StartRef(); if (NS_WARN_IF(!startRef.IsSet())) { aRv.Throw(NS_ERROR_FAILURE); return nullptr; } const RangeBoundary& endRef = firstRange->EndRef(); if (NS_WARN_IF(!endRef.IsSet())) { aRv.Throw(NS_ERROR_FAILURE); return nullptr; } // Optimization for a single selected element if (startRef.Container() == endRef.Container()) { nsIContent* startContent = startRef.GetChildAtOffset(); nsIContent* endContent = endRef.GetChildAtOffset(); if (startContent && endContent && startContent->GetNextSibling() == endContent) { if (!aTagName) { if (!startContent->IsElement()) { // This means only a text node or something is selected. We should // return nullptr in this case since no other elements are selected. return nullptr; } return do_AddRef(startContent->AsElement()); } // Test for appropriate node type requested if (aTagName == startContent->NodeInfo()->NameAtom() || (isLinkTag && HTMLEditUtils::IsLink(startContent)) || (isNamedAnchorTag && HTMLEditUtils::IsNamedAnchor(startContent))) { MOZ_ASSERT(startContent->IsElement()); return do_AddRef(startContent->AsElement()); } } } if (isLinkTag && startRef.Container()->IsContent() && endRef.Container()->IsContent()) { // Link node must be the same for both ends of selection. Element* parentLinkOfStart = GetInclusiveAncestorByTagNameInternal( *nsGkAtoms::href, *startRef.Container()->AsContent()); if (parentLinkOfStart) { if (SelectionRef().IsCollapsed()) { // We have just a caret in the link. return do_AddRef(parentLinkOfStart); } // Link node must be the same for both ends of selection. Element* parentLinkOfEnd = GetInclusiveAncestorByTagNameInternal( *nsGkAtoms::href, *endRef.Container()->AsContent()); if (parentLinkOfStart == parentLinkOfEnd) { return do_AddRef(parentLinkOfStart); } } } if (SelectionRef().IsCollapsed()) { return nullptr; } PostContentIterator postOrderIter; postOrderIter.Init(firstRange); RefPtr lastElementInRange; for (nsINode* lastNodeInRange = nullptr; !postOrderIter.IsDone(); postOrderIter.Next()) { if (lastElementInRange) { // When any node follows an element node, not only one element is // selected so that return nullptr. return nullptr; } // This loop ignors any non-element nodes before first element node. // Its purpose must be that this method treats this case as selecting // the element: // -
abc d[ef}
// because children of an element node is listed up before the element. // However, this case must not be expected by the initial developer: // -
a[bc def}
// When we meet non-parent and non-next-sibling node of previous node, // it means that the range across element boundary (open tag in HTML // source). So, in this case, we should not say only the following // element is selected. nsINode* currentNode = postOrderIter.GetCurrentNode(); MOZ_ASSERT(currentNode); if (lastNodeInRange && lastNodeInRange->GetParentNode() != currentNode && lastNodeInRange->GetNextSibling() != currentNode) { return nullptr; } lastNodeInRange = currentNode; lastElementInRange = Element::FromNodeOrNull(lastNodeInRange); if (!lastElementInRange) { continue; } // And also, if it's followed by a
element, we shouldn't treat the // the element is selected like this case: // -
[def}
// Note that we don't need special handling for because double // clicking it selects the element and we use the first path to handle it. // Additionally, we have this case too: // -
[def}
// In these cases, the
element is not listed up by PostContentIterator. // So, we should return nullptr if next sibling is a `
` element or // next sibling starts with `
` element. if (nsIContent* nextSibling = lastElementInRange->GetNextSibling()) { if (nextSibling->IsHTMLElement(nsGkAtoms::br)) { return nullptr; } nsIContent* firstEditableLeaf = HTMLEditUtils::GetFirstLeafContent( *nextSibling, {LeafNodeType::OnlyLeafNode}); if (firstEditableLeaf && firstEditableLeaf->IsHTMLElement(nsGkAtoms::br)) { return nullptr; } } if (!aTagName) { continue; } if (isLinkTag && HTMLEditUtils::IsLink(lastElementInRange)) { continue; } if (isNamedAnchorTag && HTMLEditUtils::IsNamedAnchor(lastElementInRange)) { continue; } if (aTagName == lastElementInRange->NodeInfo()->NameAtom()) { continue; } // First element in the range does not match what the caller is looking // for. return nullptr; } return lastElementInRange.forget(); } Result HTMLEditor::CreateAndInsertElement( WithTransaction aWithTransaction, const nsAtom& aTagName, const EditorDOMPoint& aPointToInsert, const InitializeInsertingElement& aInitializer) { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(aPointToInsert.IsSetAndValid()); // XXX We need offset at new node for RangeUpdaterRef(). Therefore, we need // to compute the offset now but this is expensive. So, if it's possible, // we need to redesign RangeUpdaterRef() as avoiding using indices. Unused << aPointToInsert.Offset(); IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eCreateNode, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); // TODO: This method should have a callback function which is called // immediately after creating an element but before it's inserted into // the DOM tree. Then, caller can init the new element's attributes // and children **without** transactions (it'll reduce the number of // legacy mutation events). Finally, we can get rid of // CreatElementTransaction since we can use InsertNodeTransaction // instead. auto createNewElementResult = [&]() MOZ_CAN_RUN_SCRIPT -> Result { RefPtr newElement = CreateHTMLContent(&aTagName); if (MOZ_UNLIKELY(!newElement)) { NS_WARNING("EditorBase::CreateHTMLContent() failed"); return Err(NS_ERROR_FAILURE); } nsresult rv = MarkElementDirty(*newElement); if (MOZ_UNLIKELY(rv == NS_ERROR_EDITOR_DESTROYED)) { NS_WARNING("EditorBase::MarkElementDirty() caused destroying the editor"); return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::MarkElementDirty() failed, but ignored"); rv = aInitializer(*this, *newElement, aPointToInsert); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "aInitializer failed"); if (NS_WARN_IF(Destroyed())) { return Err(NS_ERROR_EDITOR_DESTROYED); } RefPtr transaction = InsertNodeTransaction::Create(*this, *newElement, aPointToInsert); rv = aWithTransaction == WithTransaction::Yes ? DoTransactionInternal(transaction) : transaction->DoTransaction(); // FYI: Transaction::DoTransaction never returns NS_ERROR_EDITOR_*. if (MOZ_UNLIKELY(Destroyed())) { NS_WARNING( "InsertNodeTransaction::DoTransaction() caused destroying the " "editor"); return Err(NS_ERROR_EDITOR_DESTROYED); } if (NS_FAILED(rv)) { NS_WARNING("InsertNodeTransaction::DoTransaction() failed"); return Err(rv); } // Override the success code if new element was moved by the web apps. if (newElement && newElement->GetParentNode() != aPointToInsert.GetContainer()) { NS_WARNING("The new element was not inserted into the expected node"); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } return CreateElementResult( std::move(newElement), transaction->SuggestPointToPutCaret()); }(); if (MOZ_UNLIKELY(createNewElementResult.isErr())) { NS_WARNING("EditorBase::DoTransactionInternal() failed"); // XXX Why do we do this even when DoTransaction() returned error? DebugOnly rvIgnored = RangeUpdaterRef().SelAdjCreateNode(aPointToInsert); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "RangeUpdater::SelAdjCreateNode() failed"); return createNewElementResult; } // If we succeeded to create and insert new element, we need to adjust // ranges in RangeUpdaterRef(). It currently requires offset of the new // node. So, let's call it with original offset. Note that if // aPointToInsert stores child node, it may not be at the offset since new // element must be inserted before the old child. Although, mutation // observer can do anything, but currently, we don't check it. DebugOnly rvIgnored = RangeUpdaterRef().SelAdjCreateNode(EditorRawDOMPoint( aPointToInsert.GetContainer(), aPointToInsert.Offset())); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "RangeUpdater::SelAdjCreateNode() failed, but ignored"); if (MOZ_LIKELY(createNewElementResult.inspect().GetNewNode())) { TopLevelEditSubActionDataRef().DidCreateElement( *this, *createNewElementResult.inspect().GetNewNode()); } return createNewElementResult; } nsresult HTMLEditor::CopyAttributes(WithTransaction aWithTransaction, Element& aDestElement, Element& aSrcElement, const AttributeFilter& aFilterFunc) { RefPtr srcAttributes = aSrcElement.Attributes(); if (!srcAttributes->Length()) { return NS_OK; } AutoTArray, 16> srcAttrs; srcAttrs.SetCapacity(srcAttributes->Length()); for (uint32_t i = 0; i < srcAttributes->Length(); i++) { RefPtr attr = srcAttributes->Item(i); if (!attr) { break; } srcAttrs.AppendElement(std::move(attr)); } if (aWithTransaction == WithTransaction::No) { for (const OwningNonNull& attr : srcAttrs) { nsString value; attr->GetValue(value); if (!aFilterFunc(*this, aSrcElement, aDestElement, attr, value)) { continue; } DebugOnly rvIgnored = aDestElement.SetAttr(attr->NodeInfo()->NamespaceID(), attr->NodeInfo()->NameAtom(), value, false); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "Element::SetAttr() failed, but ignored"); } if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } return NS_OK; } MOZ_ASSERT_UNREACHABLE("Not implemented yet, but you try to use this"); return NS_ERROR_NOT_IMPLEMENTED; } already_AddRefed HTMLEditor::CreateElementWithDefaults( const nsAtom& aTagName) { // NOTE: Despite of public method, this can be called for internal use. // Although this creates an element, but won't change the DOM tree nor // transaction. So, EditAtion::eNotEditing is proper value here. If // this is called for internal when there is already AutoEditActionDataSetter // instance, this would be initialized with its EditAction value. AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return nullptr; } const nsAtom* realTagName = IsLinkTag(aTagName) || IsNamedAnchorTag(aTagName) ? nsGkAtoms::a : &aTagName; // We don't use editor's CreateElement because we don't want to go through // the transaction system // New call to use instead to get proper HTML element, bug 39919 RefPtr newElement = CreateHTMLContent(realTagName); if (!newElement) { return nullptr; } // Mark the new element dirty, so it will be formatted // XXX Don't we need to check the error result of setting _moz_dirty attr? IgnoredErrorResult ignoredError; newElement->SetAttribute(u"_moz_dirty"_ns, u""_ns, ignoredError); NS_WARNING_ASSERTION(!ignoredError.Failed(), "Element::SetAttribute(_moz_dirty) failed, but ignored"); ignoredError.SuppressException(); // Set default values for new elements if (realTagName == nsGkAtoms::table) { newElement->SetAttr(nsGkAtoms::cellpadding, u"2"_ns, ignoredError); if (ignoredError.Failed()) { NS_WARNING("Element::SetAttr(nsGkAtoms::cellpadding, 2) failed"); return nullptr; } ignoredError.SuppressException(); newElement->SetAttr(nsGkAtoms::cellspacing, u"2"_ns, ignoredError); if (ignoredError.Failed()) { NS_WARNING("Element::SetAttr(nsGkAtoms::cellspacing, 2) failed"); return nullptr; } ignoredError.SuppressException(); newElement->SetAttr(nsGkAtoms::border, u"1"_ns, ignoredError); if (ignoredError.Failed()) { NS_WARNING("Element::SetAttr(nsGkAtoms::border, 1) failed"); return nullptr; } } else if (realTagName == nsGkAtoms::td) { nsresult rv = SetAttributeOrEquivalent(newElement, nsGkAtoms::valign, u"top"_ns, true); if (NS_FAILED(rv)) { NS_WARNING( "HTMLEditor::SetAttributeOrEquivalent(nsGkAtoms::valign, top) " "failed"); return nullptr; } } // ADD OTHER TAGS HERE return newElement.forget(); } NS_IMETHODIMP HTMLEditor::CreateElementWithDefaults(const nsAString& aTagName, Element** aReturn) { if (NS_WARN_IF(aTagName.IsEmpty()) || NS_WARN_IF(!aReturn)) { return NS_ERROR_INVALID_ARG; } *aReturn = nullptr; nsStaticAtom* tagName = EditorUtils::GetTagNameAtom(aTagName); if (NS_WARN_IF(!tagName)) { return NS_ERROR_INVALID_ARG; } RefPtr newElement = CreateElementWithDefaults(MOZ_KnownLive(*tagName)); if (!newElement) { NS_WARNING("HTMLEditor::CreateElementWithDefaults() failed"); return NS_ERROR_FAILURE; } newElement.forget(aReturn); return NS_OK; } NS_IMETHODIMP HTMLEditor::InsertLinkAroundSelection(Element* aAnchorElement) { nsresult rv = InsertLinkAroundSelectionAsAction(aAnchorElement); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::InsertLinkAroundSelectionAsAction() failed"); return rv; } nsresult HTMLEditor::InsertLinkAroundSelectionAsAction( Element* aAnchorElement, nsIPrincipal* aPrincipal) { if (NS_WARN_IF(!aAnchorElement)) { return NS_ERROR_INVALID_ARG; } AutoEditActionDataSetter editActionData(*this, EditAction::eInsertLinkElement, aPrincipal); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } if (SelectionRef().IsCollapsed()) { NS_WARNING("Selection was collapsed"); return NS_OK; } // Be sure we were given an anchor element RefPtr anchor = HTMLAnchorElement::FromNodeOrNull(aAnchorElement); if (!anchor) { return NS_OK; } nsAutoString rawHref; anchor->GetAttr(nsGkAtoms::href, rawHref); editActionData.SetData(rawHref); nsresult rv = editActionData.MaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "MaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } nsAutoString href; anchor->GetHref(href); if (href.IsEmpty()) { return NS_OK; } AutoPlaceholderBatch treatAsOneTransaction( *this, ScrollSelectionIntoView::Yes, __FUNCTION__); // Set all attributes found on the supplied anchor element RefPtr attributeMap = anchor->Attributes(); if (NS_WARN_IF(!attributeMap)) { return NS_ERROR_FAILURE; } // TODO: We should stop using this loop for adding attributes to newly created // `` elements. Then, we can avoid to increate the ref- // counter of attribute names since we can use nsStaticAtom if we don't // need to support unknown attributes. AutoTArray stylesToSet; stylesToSet.SetCapacity(attributeMap->Length()); nsString value; for (uint32_t i : IntegerRange(attributeMap->Length())) { RefPtr attribute = attributeMap->Item(i); if (!attribute) { continue; } RefPtr attributeName = attribute->NodeInfo()->NameAtom(); MOZ_ASSERT(value.IsEmpty()); attribute->GetValue(value); stylesToSet.AppendElement(EditorInlineStyleAndValue( *nsGkAtoms::a, std::move(attributeName), std::move(value))); } rv = SetInlinePropertiesAsSubAction(stylesToSet); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::SetInlinePropertiesAsSubAction() failed"); return rv; } nsresult HTMLEditor::SetHTMLBackgroundColorWithTransaction( const nsAString& aColor) { MOZ_ASSERT(IsEditActionDataAvailable()); // Find a selected or enclosing table element to set background on bool isCellSelected = false; Result, nsresult> cellOrRowOrTableElementOrError = GetSelectedOrParentTableElement(&isCellSelected); if (cellOrRowOrTableElementOrError.isErr()) { NS_WARNING("HTMLEditor::GetSelectedOrParentTableElement() failed"); return cellOrRowOrTableElementOrError.unwrapErr(); } bool setColor = !aColor.IsEmpty(); RefPtr rootElementOfBackgroundColor = cellOrRowOrTableElementOrError.unwrap(); if (rootElementOfBackgroundColor) { // Needs to set or remove background color of each selected cell elements. // Therefore, just the cell contains selection range, we don't need to // do this. Note that users can select each cell, but with Selection API, // web apps can select and at same time. With , looks // odd, though. if (isCellSelected || rootElementOfBackgroundColor->IsAnyOfHTMLElements( nsGkAtoms::table, nsGkAtoms::tr)) { SelectedTableCellScanner scanner(SelectionRef()); if (scanner.IsInTableCellSelectionMode()) { if (setColor) { for (const OwningNonNull& cellElement : scanner.ElementsRef()) { // `MOZ_KnownLive(cellElement)` is safe because of `scanner` // is stack only class and keeps grabbing it until it's destroyed. nsresult rv = SetAttributeWithTransaction( MOZ_KnownLive(cellElement), *nsGkAtoms::bgcolor, aColor); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (NS_FAILED(rv)) { NS_WARNING( "EditorBase::::SetAttributeWithTransaction(nsGkAtoms::" "bgcolor) failed"); return rv; } } return NS_OK; } for (const OwningNonNull& cellElement : scanner.ElementsRef()) { // `MOZ_KnownLive(cellElement)` is safe because of `scanner` // is stack only class and keeps grabbing it until it's destroyed. nsresult rv = RemoveAttributeWithTransaction( MOZ_KnownLive(cellElement), *nsGkAtoms::bgcolor); if (NS_FAILED(rv)) { NS_WARNING( "EditorBase::RemoveAttributeWithTransaction(nsGkAtoms::bgcolor)" " failed"); return rv; } } return NS_OK; } } // If we failed to find a cell, fall through to use originally-found element } else { // No table element -- set the background color on the body tag rootElementOfBackgroundColor = GetRoot(); if (NS_WARN_IF(!rootElementOfBackgroundColor)) { return NS_ERROR_FAILURE; } } // Use the editor method that goes through the transaction system if (setColor) { nsresult rv = SetAttributeWithTransaction(*rootElementOfBackgroundColor, *nsGkAtoms::bgcolor, aColor); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::SetAttributeWithTransaction(nsGkAtoms::bgcolor) failed"); return rv; } nsresult rv = RemoveAttributeWithTransaction(*rootElementOfBackgroundColor, *nsGkAtoms::bgcolor); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::RemoveAttributeWithTransaction(nsGkAtoms::bgcolor) failed"); return rv; } nsresult HTMLEditor::RemoveEmptyInclusiveAncestorInlineElements( nsIContent& aContent) { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(!aContent.Length()); Element* editingHost = aContent.GetEditingHost(); if (NS_WARN_IF(!editingHost)) { return NS_ERROR_FAILURE; } if (&aContent == editingHost || HTMLEditUtils::IsBlockElement( aContent, BlockInlineCheck::UseComputedDisplayOutsideStyle) || !EditorUtils::IsEditableContent(aContent, EditorType::HTML) || !aContent.GetParent()) { return NS_OK; } // Don't strip wrappers if this is the only wrapper in the block. Then we'll // add a
later, so it won't be an empty wrapper in the end. // XXX This is different from Blink. We should delete empty inline element // even if it's only child of the block element. { const Element* editableBlockElement = HTMLEditUtils::GetAncestorElement( aContent, HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (!editableBlockElement || HTMLEditUtils::IsEmptyNode( *editableBlockElement, {EmptyCheckOption::TreatSingleBRElementAsVisible, EmptyCheckOption::TreatNonEditableContentAsInvisible})) { return NS_OK; } } OwningNonNull content = aContent; for (nsIContent* parentContent : aContent.AncestorsOfType()) { if (HTMLEditUtils::IsBlockElement( *parentContent, BlockInlineCheck::UseComputedDisplayOutsideStyle) || parentContent->Length() != 1 || !EditorUtils::IsEditableContent(*parentContent, EditorType::HTML) || parentContent == editingHost) { break; } content = *parentContent; } nsresult rv = DeleteNodeWithTransaction(content); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::DeleteNodeWithTransaction() failed"); return rv; } nsresult HTMLEditor::DeleteAllChildrenWithTransaction(Element& aElement) { MOZ_ASSERT(IsEditActionDataAvailable()); // Prevent rules testing until we're done IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eDeleteNode, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return ignoredError.StealNSResult(); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "OnStartToHandleTopLevelEditSubAction() failed, but ignored"); while (nsCOMPtr child = aElement.GetLastChild()) { nsresult rv = DeleteNodeWithTransaction(*child); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteNodeWithTransaction() failed"); return rv; } } return NS_OK; } NS_IMETHODIMP HTMLEditor::DeleteNode(nsINode* aNode, bool aPreserveSelection, uint8_t aOptionalArgCount) { if (NS_WARN_IF(!aNode) || NS_WARN_IF(!aNode->IsContent())) { return NS_ERROR_INVALID_ARG; } AutoEditActionDataSetter editActionData(*this, EditAction::eRemoveNode); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } // Make dispatch `input` event after stopping preserving selection. AutoPlaceholderBatch treatAsOneTransaction( *this, ScrollSelectionIntoView::No, // not a user interaction __FUNCTION__); Maybe preserveSelection; if (aOptionalArgCount && aPreserveSelection) { preserveSelection.emplace(*this); } rv = DeleteNodeWithTransaction(MOZ_KnownLive(*aNode->AsContent())); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::DeleteNodeWithTransaction() failed"); return rv; } Result HTMLEditor::DeleteTextWithTransaction( Text& aTextNode, uint32_t aOffset, uint32_t aLength) { if (NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode(aTextNode))) { return Err(NS_ERROR_FAILURE); } Result caretPointOrError = EditorBase::DeleteTextWithTransaction(aTextNode, aOffset, aLength); NS_WARNING_ASSERTION(caretPointOrError.isOk(), "EditorBase::DeleteTextWithTransaction() failed"); return caretPointOrError; } Result HTMLEditor::ReplaceTextWithTransaction( Text& aTextNode, uint32_t aOffset, uint32_t aLength, const nsAString& aStringToInsert) { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(aLength > 0 || !aStringToInsert.IsEmpty()); if (aStringToInsert.IsEmpty()) { Result caretPointOrError = DeleteTextWithTransaction(aTextNode, aOffset, aLength); if (MOZ_UNLIKELY(caretPointOrError.isErr())) { NS_WARNING("HTMLEditor::DeleteTextWithTransaction() failed"); return caretPointOrError.propagateErr(); } return InsertTextResult(EditorDOMPointInText(&aTextNode, aOffset), caretPointOrError.unwrap()); } if (!aLength) { RefPtr document = GetDocument(); if (NS_WARN_IF(!document)) { return Err(NS_ERROR_NOT_INITIALIZED); } Result insertTextResult = InsertTextWithTransaction(*document, aStringToInsert, EditorDOMPoint(&aTextNode, aOffset)); NS_WARNING_ASSERTION(insertTextResult.isOk(), "HTMLEditor::InsertTextWithTransaction() failed"); return insertTextResult; } if (NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode(aTextNode))) { return Err(NS_ERROR_FAILURE); } // This should emulates inserting text for better undo/redo behavior. IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eInsertText, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); // FYI: Create the insertion point before changing the DOM tree because // the point may become invalid offset after that. EditorDOMPointInText pointToInsert(&aTextNode, aOffset); RefPtr transaction = ReplaceTextTransaction::Create( *this, aStringToInsert, aTextNode, aOffset, aLength); MOZ_ASSERT(transaction); if (aLength && !mActionListeners.IsEmpty()) { for (auto& listener : mActionListeners.Clone()) { DebugOnly rvIgnored = listener->WillDeleteText(&aTextNode, aOffset, aLength); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "nsIEditActionListener::WillDeleteText() failed, but ignored"); } } nsresult rv = DoTransactionInternal(transaction); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::DoTransactionInternal() failed"); // Don't check whether we've been destroyed here because we need to notify // listeners and observers below even if we've already destroyed. EditorDOMPointInText endOfInsertedText(&aTextNode, aOffset + aStringToInsert.Length()); if (pointToInsert.IsSet()) { auto [begin, end] = ComputeInsertedRange(pointToInsert, aStringToInsert); if (begin.IsSet() && end.IsSet()) { TopLevelEditSubActionDataRef().DidDeleteText( *this, begin.To()); TopLevelEditSubActionDataRef().DidInsertText( *this, begin.To(), end.To()); } // XXX Should we update endOfInsertedText here? } if (!mActionListeners.IsEmpty()) { for (auto& listener : mActionListeners.Clone()) { DebugOnly rvIgnored = listener->DidInsertText(&aTextNode, aOffset, aStringToInsert, rv); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "nsIEditActionListener::DidInsertText() failed, but ignored"); } } if (NS_WARN_IF(Destroyed())) { return Err(NS_ERROR_EDITOR_DESTROYED); } return InsertTextResult( std::move(endOfInsertedText), transaction->SuggestPointToPutCaret()); } Result HTMLEditor::InsertTextWithTransaction( Document& aDocument, const nsAString& aStringToInsert, const EditorDOMPoint& aPointToInsert) { if (NS_WARN_IF(!aPointToInsert.IsSet())) { return Err(NS_ERROR_INVALID_ARG); } // Do nothing if the node is read-only if (MOZ_UNLIKELY(NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode( *aPointToInsert.GetContainer())))) { return Err(NS_ERROR_FAILURE); } return EditorBase::InsertTextWithTransaction(aDocument, aStringToInsert, aPointToInsert); } Result HTMLEditor::PrepareToInsertBRElement( const EditorDOMPoint& aPointToInsert) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!aPointToInsert.IsSet())) { return Err(NS_ERROR_FAILURE); } if (!aPointToInsert.IsInTextNode()) { return aPointToInsert; } if (aPointToInsert.IsStartOfContainer()) { // Insert before the text node. EditorDOMPoint pointInContainer(aPointToInsert.GetContainer()); if (!pointInContainer.IsSet()) { NS_WARNING("Failed to climb up the DOM tree from text node"); return Err(NS_ERROR_FAILURE); } return pointInContainer; } if (aPointToInsert.IsEndOfContainer()) { // Insert after the text node. EditorDOMPoint pointInContainer(aPointToInsert.GetContainer()); if (NS_WARN_IF(!pointInContainer.IsSet())) { NS_WARNING("Failed to climb up the DOM tree from text node"); return Err(NS_ERROR_FAILURE); } MOZ_ALWAYS_TRUE(pointInContainer.AdvanceOffset()); return pointInContainer; } MOZ_DIAGNOSTIC_ASSERT(aPointToInsert.IsSetAndValid()); // Unfortunately, we need to split the text node at the offset. Result splitTextNodeResult = SplitNodeWithTransaction(aPointToInsert); if (MOZ_UNLIKELY(splitTextNodeResult.isErr())) { NS_WARNING("HTMLEditor::SplitNodeWithTransaction() failed"); return splitTextNodeResult.propagateErr(); } nsresult rv = splitTextNodeResult.inspect().SuggestCaretPointTo( *this, {SuggestCaret::OnlyIfTransactionsAllowedToDoIt}); if (NS_FAILED(rv)) { NS_WARNING("SplitNodeResult::SuggestCaretPointTo() failed"); return Err(rv); } // Insert new
before the right node. auto atNextContent = splitTextNodeResult.inspect().AtNextContent(); if (MOZ_UNLIKELY(!atNextContent.IsSet())) { NS_WARNING("The next node seems not in the DOM tree"); return Err(NS_ERROR_FAILURE); } return atNextContent; } Result HTMLEditor::InsertBRElement( WithTransaction aWithTransaction, const EditorDOMPoint& aPointToInsert, EDirection aSelect /* = eNone */) { MOZ_ASSERT(IsEditActionDataAvailable()); Result maybePointToInsert = PrepareToInsertBRElement(aPointToInsert); if (maybePointToInsert.isErr()) { NS_WARNING( nsPrintfCString("HTMLEditor::PrepareToInsertBRElement(%s) failed", ToString(aWithTransaction).c_str()) .get()); return maybePointToInsert.propagateErr(); } MOZ_ASSERT(maybePointToInsert.inspect().IsSetAndValid()); Result createNewBRElementResult = CreateAndInsertElement(aWithTransaction, *nsGkAtoms::br, maybePointToInsert.inspect()); if (MOZ_UNLIKELY(createNewBRElementResult.isErr())) { NS_WARNING(nsPrintfCString("HTMLEditor::CreateAndInsertElement(%s) failed", ToString(aWithTransaction).c_str()) .get()); return createNewBRElementResult.propagateErr(); } CreateElementResult unwrappedCreateNewBRElementResult = createNewBRElementResult.unwrap(); RefPtr newBRElement = unwrappedCreateNewBRElementResult.UnwrapNewNode(); MOZ_ASSERT(newBRElement); unwrappedCreateNewBRElementResult.IgnoreCaretPointSuggestion(); switch (aSelect) { case eNext: { const auto pointToPutCaret = EditorDOMPoint::After( *newBRElement, Selection::InterlinePosition::StartOfNextLine); return CreateElementResult(std::move(newBRElement), pointToPutCaret); } case ePrevious: { const auto pointToPutCaret = EditorDOMPoint( newBRElement, Selection::InterlinePosition::StartOfNextLine); return CreateElementResult(std::move(newBRElement), pointToPutCaret); } default: NS_WARNING( "aSelect has invalid value, the caller need to set selection " "by itself"); [[fallthrough]]; case eNone: return CreateElementResult( std::move(newBRElement), unwrappedCreateNewBRElementResult.UnwrapCaretPoint()); } } Result HTMLEditor::InsertContainerWithTransaction( nsIContent& aContentToBeWrapped, const nsAtom& aWrapperTagName, const InitializeInsertingElement& aInitializer) { EditorDOMPoint pointToInsertNewContainer(&aContentToBeWrapped); if (NS_WARN_IF(!pointToInsertNewContainer.IsSet())) { return Err(NS_ERROR_FAILURE); } // aContentToBeWrapped will be moved to the new container before inserting the // new container. So, when we insert the container, the insertion point is // before the next sibling of aContentToBeWrapped. // XXX If pointerToInsertNewContainer stores offset here, the offset and // referring child node become mismatched. Although, currently this // is not a problem since InsertNodeTransaction refers only child node. MOZ_ALWAYS_TRUE(pointToInsertNewContainer.AdvanceOffset()); // Create new container. RefPtr newContainer = CreateHTMLContent(&aWrapperTagName); if (NS_WARN_IF(!newContainer)) { return Err(NS_ERROR_FAILURE); } if (&aInitializer != &HTMLEditor::DoNothingForNewElement) { nsresult rv = aInitializer(*this, *newContainer, EditorDOMPoint(&aContentToBeWrapped)); if (NS_WARN_IF(Destroyed())) { return Err(NS_ERROR_EDITOR_DESTROYED); } if (NS_FAILED(rv)) { NS_WARNING("aInitializer() failed"); return Err(rv); } } // Notify our internal selection state listener AutoInsertContainerSelNotify selNotify(RangeUpdaterRef()); // Put aNode in the new container, first. // XXX Perhaps, we should not remove the container if it's not editable. nsresult rv = DeleteNodeWithTransaction(aContentToBeWrapped); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteNodeWithTransaction() failed"); return Err(rv); } { // TODO: Remove AutoTransactionsConserveSelection here. It's not necessary // in normal cases. However, it may be required for nested edit // actions which may be caused by legacy mutation event listeners or // chrome script. AutoTransactionsConserveSelection conserveSelection(*this); Result insertContentNodeResult = InsertNodeWithTransaction(aContentToBeWrapped, EditorDOMPoint(newContainer, 0u)); if (MOZ_UNLIKELY(insertContentNodeResult.isErr())) { NS_WARNING("EditorBase::InsertNodeWithTransaction() failed"); return insertContentNodeResult.propagateErr(); } insertContentNodeResult.inspect().IgnoreCaretPointSuggestion(); } // Put the new container where aNode was. Result insertNewContainerElementResult = InsertNodeWithTransaction(*newContainer, pointToInsertNewContainer); NS_WARNING_ASSERTION(insertNewContainerElementResult.isOk(), "EditorBase::InsertNodeWithTransaction() failed"); return insertNewContainerElementResult; } Result HTMLEditor::ReplaceContainerWithTransactionInternal( Element& aOldContainer, const nsAtom& aTagName, const nsAtom& aAttribute, const nsAString& aAttributeValue, bool aCloneAllAttributes) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!HTMLEditUtils::IsRemovableNode(aOldContainer)) || NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode(aOldContainer))) { return Err(NS_ERROR_FAILURE); } // If we're replacing
or
with different type of element, we need to // split the parent
. OwningNonNull containerElementToDelete = aOldContainer; if (aOldContainer.IsAnyOfHTMLElements(nsGkAtoms::dd, nsGkAtoms::dt) && &aTagName != nsGkAtoms::dt && &aTagName != nsGkAtoms::dd && // aOldContainer always has a parent node because of removable. aOldContainer.GetParentNode()->IsHTMLElement(nsGkAtoms::dl)) { OwningNonNull const dlElement = *aOldContainer.GetParentElement(); if (NS_WARN_IF(!HTMLEditUtils::IsRemovableNode(dlElement)) || NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode(dlElement))) { return Err(NS_ERROR_FAILURE); } Result splitDLElementResult = SplitRangeOffFromElement(dlElement, aOldContainer, aOldContainer); if (MOZ_UNLIKELY(splitDLElementResult.isErr())) { NS_WARNING("HTMLEditor::SplitRangeOffFromElement() failed"); return splitDLElementResult.propagateErr(); } splitDLElementResult.inspect().IgnoreCaretPointSuggestion(); RefPtr middleDLElement = aOldContainer.GetParentElement(); if (NS_WARN_IF(!middleDLElement) || NS_WARN_IF(!middleDLElement->IsHTMLElement(nsGkAtoms::dl)) || NS_WARN_IF(!HTMLEditUtils::IsRemovableNode(*middleDLElement))) { NS_WARNING("The parent
was lost at splitting it"); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } containerElementToDelete = std::move(middleDLElement); } const RefPtr newContainer = CreateHTMLContent(&aTagName); if (NS_WARN_IF(!newContainer)) { return Err(NS_ERROR_FAILURE); } // Set or clone attribute if needed. // FIXME: What should we do attributes of
elements if we removed it // above? if (aCloneAllAttributes) { MOZ_ASSERT(&aAttribute == nsGkAtoms::_empty); CloneAttributesWithTransaction(*newContainer, aOldContainer); } else if (&aAttribute != nsGkAtoms::_empty) { nsresult rv = newContainer->SetAttr(kNameSpaceID_None, const_cast(&aAttribute), aAttributeValue, true); if (NS_FAILED(rv)) { NS_WARNING("Element::SetAttr() failed"); return Err(NS_ERROR_FAILURE); } } const OwningNonNull parentNode = *containerElementToDelete->GetParentNode(); const nsCOMPtr referenceNode = containerElementToDelete->GetNextSibling(); AutoReplaceContainerSelNotify selStateNotify(RangeUpdaterRef(), aOldContainer, *newContainer); { AutoTArray, 32> arrayOfChildren; HTMLEditUtils::CollectChildren( aOldContainer, arrayOfChildren, 0u, // Move non-editable children too because its container, aElement, is // editable so that all children must be removable node. {}); // TODO: Remove AutoTransactionsConserveSelection here. It's not necessary // in normal cases. However, it may be required for nested edit // actions which may be caused by legacy mutation event listeners or // chrome script. AutoTransactionsConserveSelection conserveSelection(*this); // Move all children from the old container to the new container. // For making all MoveNodeTransactions have a reference node in the current // parent, move nodes from last one to preceding ones. for (const OwningNonNull& child : Reversed(arrayOfChildren)) { Result moveChildResult = MoveNodeWithTransaction(MOZ_KnownLive(child), // due to bug 1622253. EditorDOMPoint(newContainer, 0u)); if (MOZ_UNLIKELY(moveChildResult.isErr())) { NS_WARNING("HTMLEditor::MoveNodeWithTransaction() failed"); return moveChildResult.propagateErr(); } // We'll suggest new caret point which is suggested by new container // element insertion result. Therefore, we need to do nothing here. moveChildResult.inspect().IgnoreCaretPointSuggestion(); } } // Delete containerElementToDelete from the DOM tree to make it not referred // by InsertNodeTransaction. nsresult rv = DeleteNodeWithTransaction(containerElementToDelete); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteNodeWithTransaction() failed"); return Err(rv); } if (referenceNode && (!referenceNode->GetParentNode() || parentNode != referenceNode->GetParentNode())) { NS_WARNING( "The reference node for insertion has been moved to different parent, " "so we got lost the insertion point"); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } // Finally, insert the new node to where probably aOldContainer was. Result insertNewContainerElementResult = InsertNodeWithTransaction( *newContainer, referenceNode ? EditorDOMPoint(referenceNode) : EditorDOMPoint::AtEndOf(*parentNode)); NS_WARNING_ASSERTION(insertNewContainerElementResult.isOk(), "EditorBase::InsertNodeWithTransaction() failed"); MOZ_ASSERT_IF( insertNewContainerElementResult.isOk(), insertNewContainerElementResult.inspect().GetNewNode() == newContainer); return insertNewContainerElementResult; } Result HTMLEditor::RemoveContainerWithTransaction( Element& aElement) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!HTMLEditUtils::IsRemovableNode(aElement)) || NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode(aElement))) { return Err(NS_ERROR_FAILURE); } // Notify our internal selection state listener. AutoRemoveContainerSelNotify selNotify(RangeUpdaterRef(), EditorRawDOMPoint(&aElement)); AutoTArray, 32> arrayOfChildren; HTMLEditUtils::CollectChildren( aElement, arrayOfChildren, 0u, // Move non-editable children too because its container, aElement, is // editable so that all children must be removable node. {}); const OwningNonNull parentNode = *aElement.GetParentNode(); nsCOMPtr previousChild = aElement.GetPreviousSibling(); // For making all MoveNodeTransactions have a referenc node in the current // parent, move nodes from last one to preceding ones. for (const OwningNonNull& child : Reversed(arrayOfChildren)) { if (MOZ_UNLIKELY(!HTMLEditUtils::IsRemovableNode(child))) { continue; } Result moveChildResult = MoveNodeWithTransaction( MOZ_KnownLive(child), // due to bug 1622253. previousChild ? EditorDOMPoint::After(previousChild) : EditorDOMPoint(parentNode, 0u)); if (MOZ_UNLIKELY(moveChildResult.isErr())) { NS_WARNING("HTMLEditor::MoveNodeWithTransaction() failed"); return moveChildResult.propagateErr(); } // If the reference node was moved to different container, try to recover // the original position. if (previousChild && MOZ_UNLIKELY(previousChild->GetParentNode() != parentNode)) { if (MOZ_UNLIKELY(child->GetParentNode() != parentNode)) { NS_WARNING( "Neither the reference (previous) sibling nor the moved child was " "in the expected parent node"); moveChildResult.inspect().IgnoreCaretPointSuggestion(); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } previousChild = child->GetPreviousSibling(); } // We'll need to put caret at next sibling of aElement if nobody moves // content nodes under the parent node except us. moveChildResult.inspect().IgnoreCaretPointSuggestion(); } if (aElement.GetParentNode() && aElement.GetParentNode() != parentNode) { NS_WARNING( "The removing element has already been moved to another element"); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } NS_WARNING_ASSERTION(!aElement.GetFirstChild(), "The removing container still has some children, but " "they are removed by removing the container"); auto GetNextSiblingOf = [](const nsTArray>& aArrayOfMovedContent, const nsINode& aExpectedParentNode) -> nsIContent* { for (const OwningNonNull& movedChild : Reversed(aArrayOfMovedContent)) { if (movedChild != &aExpectedParentNode) { continue; // Ignore moved node which was moved to different place } return movedChild->GetNextSibling(); } // XXX If all nodes were moved by web apps, we cannot suggest "collect" // position without computing the index of aElement. However, I // don't think that it's necessary for the web apps in the wild. return nullptr; }; nsCOMPtr nextSibling = aElement.GetParentNode() ? aElement.GetNextSibling() : GetNextSiblingOf(arrayOfChildren, *parentNode); nsresult rv = DeleteNodeWithTransaction(aElement); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::DeleteNodeTransaction() failed"); return Err(rv); } if (nextSibling && nextSibling->GetParentNode() != parentNode) { nextSibling = GetNextSiblingOf(arrayOfChildren, *parentNode); } return nextSibling ? EditorDOMPoint(nextSibling) : EditorDOMPoint::AtEndOf(*parentNode); } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::ContentAppended( nsIContent* aFirstNewContent) { DoContentInserted(aFirstNewContent, ContentNodeIs::Appended); } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::ContentInserted( nsIContent* aChild) { DoContentInserted(aChild, ContentNodeIs::Inserted); } bool HTMLEditor::IsInObservedSubtree(nsIContent* aChild) { if (!aChild) { return false; } // FIXME(emilio, bug 1596856): This should probably work if the root is in the // same shadow tree as the child, probably? I don't know what the // contenteditable-in-shadow-dom situation is. if (Element* root = GetRoot()) { // To be super safe here, check both ChromeOnlyAccess and NAC / Shadow DOM. // That catches (also unbound) native anonymous content and ShadowDOM. if (root->ChromeOnlyAccess() != aChild->ChromeOnlyAccess() || root->IsInNativeAnonymousSubtree() != aChild->IsInNativeAnonymousSubtree() || root->IsInShadowTree() != aChild->IsInShadowTree()) { return false; } } return !aChild->ChromeOnlyAccess() && !aChild->IsInShadowTree() && !aChild->IsInNativeAnonymousSubtree(); } void HTMLEditor::DoContentInserted(nsIContent* aChild, ContentNodeIs aContentNodeIs) { MOZ_ASSERT(aChild); nsINode* container = aChild->GetParentNode(); MOZ_ASSERT(container); if (!IsInObservedSubtree(aChild)) { return; } // XXX Why do we need this? This method is a helper of mutation observer. // So, the callers of mutation observer should guarantee that this won't // be deleted at least during the call. RefPtr kungFuDeathGrip(this); AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } if (ShouldReplaceRootElement()) { UpdateRootElement(); if (mPendingRootElementUpdatedRunner) { return; } mPendingRootElementUpdatedRunner = NewRunnableMethod( "HTMLEditor::NotifyRootChanged", this, &HTMLEditor::NotifyRootChanged); nsContentUtils::AddScriptRunner( do_AddRef(mPendingRootElementUpdatedRunner)); return; } // We don't need to handle our own modifications if (!GetTopLevelEditSubAction() && container->IsEditable()) { if (EditorUtils::IsPaddingBRElementForEmptyEditor(*aChild)) { // Ignore insertion of the padding
element. return; } nsresult rv = OnDocumentModified(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::OnDocumentModified() failed, but ignored"); // Update spellcheck for only the newly-inserted node (bug 743819) if (mInlineSpellChecker) { nsIContent* endContent = aChild; if (aContentNodeIs == ContentNodeIs::Appended) { nsIContent* child = nullptr; for (child = aChild; child; child = child->GetNextSibling()) { if (child->InclusiveDescendantMayNeedSpellchecking(this)) { break; } } if (!child) { // No child needed spellchecking, return. return; } // Maybe more than 1 child was appended. endContent = container->GetLastChild(); } else if (!aChild->InclusiveDescendantMayNeedSpellchecking(this)) { return; } RefPtr range = nsRange::Create(aChild); range->SelectNodesInContainer(container, aChild, endContent); DebugOnly rvIgnored = mInlineSpellChecker->SpellCheckRange(range); NS_WARNING_ASSERTION( rvIgnored == NS_ERROR_NOT_INITIALIZED || NS_SUCCEEDED(rvIgnored), "mozInlineSpellChecker::SpellCheckRange() failed, but ignored"); } } } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::ContentRemoved( nsIContent* aChild, nsIContent* aPreviousSibling) { if (!IsInObservedSubtree(aChild)) { return; } // XXX Why do we need to do this? This method is a mutation observer's // method. Therefore, the caller should guarantee that this won't be // deleted during the call. RefPtr kungFuDeathGrip(this); AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } if (SameCOMIdentity(aChild, mRootElement)) { mRootElement = nullptr; if (mPendingRootElementUpdatedRunner) { return; } mPendingRootElementUpdatedRunner = NewRunnableMethod( "HTMLEditor::NotifyRootChanged", this, &HTMLEditor::NotifyRootChanged); nsContentUtils::AddScriptRunner( do_AddRef(mPendingRootElementUpdatedRunner)); return; } // We don't need to handle our own modifications if (!GetTopLevelEditSubAction() && aChild->GetParentNode()->IsEditable()) { if (aChild && EditorUtils::IsPaddingBRElementForEmptyEditor(*aChild)) { // Ignore removal of the padding
element for empty editor. return; } nsresult rv = OnDocumentModified(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::OnDocumentModified() failed, but ignored"); } } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::CharacterDataChanged( nsIContent* aContent, const CharacterDataChangeInfo& aInfo) { if (!mInlineSpellChecker || !aContent->IsEditable() || !IsInObservedSubtree(aContent) || GetTopLevelEditSubAction() != EditSubAction::eNone) { return; } nsIContent* parent = aContent->GetParent(); if (!parent || !parent->InclusiveDescendantMayNeedSpellchecking(this)) { return; } RefPtr range = nsRange::Create(aContent); range->SelectNodesInContainer(parent, aContent, aContent); DebugOnly rvIgnored = mInlineSpellChecker->SpellCheckRange(range); } nsresult HTMLEditor::SelectEntireDocument() { MOZ_ASSERT(IsEditActionDataAvailable()); if (!mInitSucceeded) { return NS_ERROR_NOT_INITIALIZED; } // XXX It's odd to select all of the document body if an contenteditable // element has focus. RefPtr bodyOrDocumentElement = GetRoot(); if (NS_WARN_IF(!bodyOrDocumentElement)) { return NS_ERROR_NOT_INITIALIZED; } // If we're empty, don't select all children because that would select the // padding
element for empty editor. if (IsEmpty()) { nsresult rv = CollapseSelectionToStartOf(*bodyOrDocumentElement); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionToStartOf() failed"); return rv; } // Otherwise, select all children. ErrorResult error; SelectionRef().SelectAllChildren(*bodyOrDocumentElement, error); if (NS_WARN_IF(Destroyed())) { error.SuppressException(); return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(!error.Failed(), "Selection::SelectAllChildren() failed"); return error.StealNSResult(); } nsresult HTMLEditor::SelectAllInternal() { MOZ_ASSERT(IsEditActionDataAvailable()); CommitComposition(); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } auto GetBodyElementIfElementIsParentOfHTMLBody = [](const Element& aElement) -> Element* { if (!aElement.OwnerDoc()->IsHTMLDocument()) { return const_cast(&aElement); } HTMLBodyElement* bodyElement = aElement.OwnerDoc()->GetBodyElement(); return bodyElement && nsContentUtils::ContentIsFlattenedTreeDescendantOf( bodyElement, &aElement) ? bodyElement : const_cast(&aElement); }; nsCOMPtr selectionRootContent = [&]() MOZ_CAN_RUN_SCRIPT -> nsIContent* { RefPtr elementToBeSelected = [&]() -> Element* { // If there is at least one selection range, we should compute the // selection root from the anchor node. if (SelectionRef().RangeCount()) { if (nsIContent* content = nsIContent::FromNodeOrNull(SelectionRef().GetAnchorNode())) { if (content->IsElement()) { return content->AsElement(); } if (Element* parentElement = content->GetParentElementCrossingShadowRoot()) { return parentElement; } } } // If no element contains a selection range, we should select all children // of the focused element at least. if (Element* focusedElement = GetFocusedElement()) { return focusedElement; } // of the body or document element. Element* bodyOrDocumentElement = GetRoot(); NS_WARNING_ASSERTION(bodyOrDocumentElement, "There was no element in the document"); return bodyOrDocumentElement; }(); // If the element to be selected is or , // GetSelectionRootContent() returns its anonymous <div> element, but we // want to select all of the document or selection limiter. Therefore, // we should use its parent to compute the selection root. if (elementToBeSelected->HasIndependentSelection()) { Element* parentElement = elementToBeSelected->GetParentElement(); if (MOZ_LIKELY(parentElement)) { elementToBeSelected = parentElement; } } // Then, compute the selection root content to select all including // elementToBeSelected. RefPtr<PresShell> presShell = GetPresShell(); nsIContent* computedSelectionRootContent = elementToBeSelected->GetSelectionRootContent(presShell); if (NS_WARN_IF(!computedSelectionRootContent)) { return nullptr; } if (MOZ_UNLIKELY(!computedSelectionRootContent->IsElement())) { return computedSelectionRootContent; } return GetBodyElementIfElementIsParentOfHTMLBody( *computedSelectionRootContent->AsElement()); }(); if (NS_WARN_IF(!selectionRootContent)) { return NS_ERROR_FAILURE; } Maybe<Selection::AutoUserInitiated> userSelection; // XXX Do we need to mark it as "user initiated" for // `Document.execCommand("selectAll")`? if (!selectionRootContent->IsEditable()) { userSelection.emplace(SelectionRef()); } ErrorResult error; SelectionRef().SelectAllChildren(*selectionRootContent, error); NS_WARNING_ASSERTION(!error.Failed(), "Selection::SelectAllChildren() failed"); return error.StealNSResult(); } bool HTMLEditor::SetCaretInTableCell(Element* aElement) { MOZ_ASSERT(IsEditActionDataAvailable()); if (!aElement || !aElement->IsHTMLElement() || !HTMLEditUtils::IsAnyTableElement(aElement)) { return false; } const RefPtr<Element> editingHost = ComputeEditingHost(); if (!editingHost || !aElement->IsInclusiveDescendantOf(editingHost)) { return false; } nsCOMPtr<nsIContent> deepestFirstChild = aElement; while (deepestFirstChild->HasChildren()) { deepestFirstChild = deepestFirstChild->GetFirstChild(); } // Set selection at beginning of the found node nsresult rv = CollapseSelectionToStartOf(*deepestFirstChild); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionToStartOf() failed"); return NS_SUCCEEDED(rv); } /** * This method scans the selection for adjacent text nodes * and collapses them into a single text node. * "adjacent" means literally adjacent siblings of the same parent. * Uses HTMLEditor::JoinNodesWithTransaction() so action is undoable. * Should be called within the context of a batch transaction. */ nsresult HTMLEditor::CollapseAdjacentTextNodes(nsRange& aInRange) { AutoTransactionsConserveSelection dontChangeMySelection(*this); // we can't actually do anything during iteration, so store the text nodes in // an array first. DOMSubtreeIterator subtreeIter; if (NS_FAILED(subtreeIter.Init(aInRange))) { NS_WARNING("DOMSubtreeIterator::Init() failed"); return NS_ERROR_FAILURE; } AutoTArray<OwningNonNull<Text>, 8> textNodes; subtreeIter.AppendNodesToArray( +[](nsINode& aNode, void*) -> bool { return EditorUtils::IsEditableContent(*aNode.AsText(), EditorType::HTML); }, textNodes); // now that I have a list of text nodes, collapse adjacent text nodes while (textNodes.Length() > 1u) { OwningNonNull<Text>& leftTextNode = textNodes[0u]; OwningNonNull<Text>& rightTextNode = textNodes[1u]; // If the text nodes are not direct siblings, we shouldn't join them, and // we don't need to handle the left one anymore. if (rightTextNode->GetPreviousSibling() != leftTextNode) { textNodes.RemoveElementAt(0u); continue; } Result<JoinNodesResult, nsresult> joinNodesResult = JoinNodesWithTransaction(MOZ_KnownLive(*leftTextNode), MOZ_KnownLive(*rightTextNode)); if (MOZ_UNLIKELY(joinNodesResult.isErr())) { NS_WARNING("HTMLEditor::JoinNodesWithTransaction() failed"); return joinNodesResult.unwrapErr(); } if (MOZ_LIKELY(joinNodesResult.inspect().RemovedContent() == leftTextNode)) { textNodes.RemoveElementAt(0u); } else if (MOZ_LIKELY(joinNodesResult.inspect().RemovedContent() == rightTextNode)) { textNodes.RemoveElementAt(1u); } else { MOZ_ASSERT_UNREACHABLE( "HTMLEditor::JoinNodesWithTransaction() removed unexpected node"); return NS_ERROR_UNEXPECTED; } } return NS_OK; } nsresult HTMLEditor::SetSelectionAtDocumentStart() { MOZ_ASSERT(IsEditActionDataAvailable()); RefPtr<Element> rootElement = GetRoot(); if (NS_WARN_IF(!rootElement)) { return NS_ERROR_FAILURE; } nsresult rv = CollapseSelectionToStartOf(*rootElement); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionToStartOf() failed"); return rv; } /** * Remove aNode, reparenting any children into the parent of aNode. In * addition, insert any br's needed to preserve identity of removed block. */ Result<EditorDOMPoint, nsresult> HTMLEditor::RemoveBlockContainerWithTransaction(Element& aElement) { MOZ_ASSERT(IsEditActionDataAvailable()); // Two possibilities: the container could be empty of editable content. If // that is the case, we need to compare what is before and after aNode to // determine if we need a br. // // Or it could be not empty, in which case we have to compare previous // sibling and first child to determine if we need a leading br, and compare // following sibling and last child to determine if we need a trailing br. EditorDOMPoint pointToPutCaret; if (nsCOMPtr<nsIContent> child = HTMLEditUtils::GetFirstChild( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { // The case of aNode not being empty. We need a br at start unless: // 1) previous sibling of aNode is a block, OR // 2) previous sibling of aNode is a br, OR // 3) first child of aNode is a block OR // 4) either is null if (nsIContent* previousSibling = HTMLEditUtils::GetPreviousSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { if (!HTMLEditUtils::IsBlockElement( *previousSibling, BlockInlineCheck::UseComputedDisplayOutsideStyle) && !previousSibling->IsHTMLElement(nsGkAtoms::br) && !HTMLEditUtils::IsBlockElement( *child, BlockInlineCheck::UseComputedDisplayOutsideStyle)) { // Insert br node Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement(WithTransaction::Yes, EditorDOMPoint(&aElement, 0u)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } CreateElementResult unwrappedInsertBRElementResult = insertBRElementResult.unwrap(); unwrappedInsertBRElementResult.MoveCaretPointTo( pointToPutCaret, {SuggestCaret::OnlyIfHasSuggestion}); MOZ_ASSERT(unwrappedInsertBRElementResult.GetNewNode()); } } // We need a br at end unless: // 1) following sibling of aNode is a block, OR // 2) last child of aNode is a block, OR // 3) last child of aNode is a br OR // 4) either is null if (nsIContent* nextSibling = HTMLEditUtils::GetNextSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { if (nextSibling && !HTMLEditUtils::IsBlockElement( *nextSibling, BlockInlineCheck::UseComputedDisplayStyle)) { if (nsIContent* lastChild = HTMLEditUtils::GetLastChild( aElement, {WalkTreeOption::IgnoreNonEditableNode}, BlockInlineCheck::Unused)) { if (!HTMLEditUtils::IsBlockElement( *lastChild, BlockInlineCheck::UseComputedDisplayStyle) && !lastChild->IsHTMLElement(nsGkAtoms::br)) { Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement(WithTransaction::Yes, EditorDOMPoint::AtEndOf(aElement)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } CreateElementResult unwrappedInsertBRElementResult = insertBRElementResult.unwrap(); unwrappedInsertBRElementResult.MoveCaretPointTo( pointToPutCaret, {SuggestCaret::OnlyIfHasSuggestion}); MOZ_ASSERT(unwrappedInsertBRElementResult.GetNewNode()); } } } } } else if (nsIContent* previousSibling = HTMLEditUtils::GetPreviousSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { // The case of aNode being empty. We need a br at start unless: // 1) previous sibling of aNode is a block, OR // 2) previous sibling of aNode is a br, OR // 3) following sibling of aNode is a block, OR // 4) following sibling of aNode is a br OR // 5) either is null if (!HTMLEditUtils::IsBlockElement( *previousSibling, BlockInlineCheck::UseComputedDisplayStyle) && !previousSibling->IsHTMLElement(nsGkAtoms::br)) { if (nsIContent* nextSibling = HTMLEditUtils::GetNextSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { if (!HTMLEditUtils::IsBlockElement( *nextSibling, BlockInlineCheck::UseComputedDisplayStyle) && !nextSibling->IsHTMLElement(nsGkAtoms::br)) { Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement(WithTransaction::Yes, EditorDOMPoint(&aElement, 0u)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } CreateElementResult unwrappedInsertBRElementResult = insertBRElementResult.unwrap(); unwrappedInsertBRElementResult.MoveCaretPointTo( pointToPutCaret, {SuggestCaret::OnlyIfHasSuggestion}); MOZ_ASSERT(unwrappedInsertBRElementResult.GetNewNode()); } } } } // Now remove container Result<EditorDOMPoint, nsresult> unwrapBlockElementResult = RemoveContainerWithTransaction(aElement); if (MOZ_UNLIKELY(unwrapBlockElementResult.isErr())) { NS_WARNING("HTMLEditor::RemoveContainerWithTransaction() failed"); return unwrapBlockElementResult; } if (AllowsTransactionsToChangeSelection() && unwrapBlockElementResult.inspect().IsSet()) { pointToPutCaret = unwrapBlockElementResult.unwrap(); } return pointToPutCaret; // May be unset } Result<SplitNodeResult, nsresult> HTMLEditor::SplitNodeWithTransaction( const EditorDOMPoint& aStartOfRightNode) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!aStartOfRightNode.IsInContentNode())) { return Err(NS_ERROR_INVALID_ARG); } MOZ_ASSERT(aStartOfRightNode.IsSetAndValid()); if (NS_WARN_IF(!HTMLEditUtils::IsSplittableNode( *aStartOfRightNode.ContainerAs<nsIContent>()))) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eSplitNode, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "OnStartToHandleTopLevelEditSubAction() failed, but ignored"); RefPtr<SplitNodeTransaction> transaction = SplitNodeTransaction::Create(*this, aStartOfRightNode); nsresult rv = DoTransactionInternal(transaction); if (NS_WARN_IF(Destroyed())) { NS_WARNING( "EditorBase::DoTransactionInternal() caused destroying the editor"); return Err(NS_ERROR_EDITOR_DESTROYED); } if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DoTransactionInternal() failed"); return Err(rv); } nsIContent* newContent = transaction->GetNewContent(); nsIContent* splitContent = transaction->GetSplitContent(); if (NS_WARN_IF(!newContent) || NS_WARN_IF(!splitContent)) { return Err(NS_ERROR_FAILURE); } TopLevelEditSubActionDataRef().DidSplitContent(*this, *splitContent, *newContent); if (NS_WARN_IF(!newContent->IsInComposedDoc()) || NS_WARN_IF(!splitContent->IsInComposedDoc())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } return SplitNodeResult(*newContent, *splitContent); } Result<SplitNodeResult, nsresult> HTMLEditor::SplitNodeDeepWithTransaction( nsIContent& aMostAncestorToSplit, const EditorDOMPoint& aDeepestStartOfRightNode, SplitAtEdges aSplitAtEdges) { MOZ_ASSERT(aDeepestStartOfRightNode.IsSetAndValidInComposedDoc()); MOZ_ASSERT( aDeepestStartOfRightNode.GetContainer() == &aMostAncestorToSplit || EditorUtils::IsDescendantOf(*aDeepestStartOfRightNode.GetContainer(), aMostAncestorToSplit)); if (NS_WARN_IF(!aDeepestStartOfRightNode.IsInComposedDoc())) { return Err(NS_ERROR_INVALID_ARG); } nsCOMPtr<nsIContent> newLeftNodeOfMostAncestor; EditorDOMPoint atStartOfRightNode(aDeepestStartOfRightNode); // lastResult is as explained by its name, the last result which may not be // split a node actually. SplitNodeResult lastResult = SplitNodeResult::NotHandled(atStartOfRightNode); MOZ_ASSERT(lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsSetAndValidInComposedDoc()); while (true) { // Need to insert rules code call here to do things like not split a list // if you are after the last <li> or before the first, etc. For now we // just have some smarts about unnecessarily splitting text nodes, which // should be universal enough to put straight in this EditorBase routine. auto* splittingContent = atStartOfRightNode.GetContainerAs<nsIContent>(); if (NS_WARN_IF(!splittingContent)) { lastResult.IgnoreCaretPointSuggestion(); return Err(NS_ERROR_FAILURE); } // If we meet an orphan node before meeting aMostAncestorToSplit, we need // to stop splitting. This is a bug of the caller. if (NS_WARN_IF(splittingContent != &aMostAncestorToSplit && !atStartOfRightNode.GetContainerParentAs<nsIContent>())) { lastResult.IgnoreCaretPointSuggestion(); return Err(NS_ERROR_FAILURE); } // If the container is not splitable node such as comment node, atomic // element, etc, we should keep it as-is, and try to split its parents. if (!HTMLEditUtils::IsSplittableNode(*splittingContent)) { if (splittingContent == &aMostAncestorToSplit) { return lastResult; } atStartOfRightNode.Set(splittingContent); continue; } // If the split point is middle of the node or the node is not a text node // and we're allowed to create empty element node, split it. if ((aSplitAtEdges == SplitAtEdges::eAllowToCreateEmptyContainer && !atStartOfRightNode.IsInTextNode()) || (!atStartOfRightNode.IsStartOfContainer() && !atStartOfRightNode.IsEndOfContainer())) { Result<SplitNodeResult, nsresult> splitNodeResult = SplitNodeWithTransaction(atStartOfRightNode); if (MOZ_UNLIKELY(splitNodeResult.isErr())) { lastResult.IgnoreCaretPointSuggestion(); return splitNodeResult; } lastResult = SplitNodeResult::MergeWithDeeperSplitNodeResult( splitNodeResult.unwrap(), lastResult); if (NS_WARN_IF(!lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsInComposedDoc())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } MOZ_ASSERT(lastResult.HasCaretPointSuggestion()); MOZ_ASSERT(lastResult.GetOriginalContent() == splittingContent); if (splittingContent == &aMostAncestorToSplit) { // Actually, we split aMostAncestorToSplit. return lastResult; } // Then, try to split its parent before current node. atStartOfRightNode = lastResult.AtNextContent<EditorDOMPoint>(); } // If the split point is end of the node and it is a text node or we're not // allowed to create empty container node, try to split its parent after it. else if (!atStartOfRightNode.IsStartOfContainer()) { lastResult = SplitNodeResult::HandledButDidNotSplitDueToEndOfContainer( *splittingContent, &lastResult); MOZ_ASSERT(lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsSetAndValidInComposedDoc()); if (splittingContent == &aMostAncestorToSplit) { return lastResult; } // Try to split its parent after current node. atStartOfRightNode.SetAfter(splittingContent); } // If the split point is start of the node and it is a text node or we're // not allowed to create empty container node, try to split its parent. else { if (splittingContent == &aMostAncestorToSplit) { return SplitNodeResult::HandledButDidNotSplitDueToStartOfContainer( *splittingContent, &lastResult); } // Try to split its parent before current node. // XXX This is logically wrong. If we've already split something but // this is the last splitable content node in the limiter, this // method will return "not handled". lastResult = SplitNodeResult::NotHandled(atStartOfRightNode, &lastResult); MOZ_ASSERT(lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsSetAndValidInComposedDoc()); atStartOfRightNode.Set(splittingContent); MOZ_ASSERT(atStartOfRightNode.IsSetAndValidInComposedDoc()); } } // Not reached because while (true) loop never breaks. } Result<SplitNodeResult, nsresult> HTMLEditor::DoSplitNode( const EditorDOMPoint& aStartOfRightNode, nsIContent& aNewNode) { // Ensure computing the offset if it's initialized with a child content node. Unused << aStartOfRightNode.Offset(); // XXX Perhaps, aStartOfRightNode may be invalid if this is a redo // operation after modifying DOM node with JS. if (NS_WARN_IF(!aStartOfRightNode.IsInContentNode())) { return Err(NS_ERROR_INVALID_ARG); } MOZ_ASSERT(aStartOfRightNode.IsSetAndValid()); // Remember all selection points. AutoTArray<SavedRange, 10> savedRanges; for (SelectionType selectionType : kPresentSelectionTypes) { SavedRange savingRange; savingRange.mSelection = GetSelection(selectionType); if (NS_WARN_IF(!savingRange.mSelection && selectionType == SelectionType::eNormal)) { return Err(NS_ERROR_FAILURE); } if (!savingRange.mSelection) { // For non-normal selections, skip over the non-existing ones. continue; } for (uint32_t j : IntegerRange(savingRange.mSelection->RangeCount())) { const nsRange* r = savingRange.mSelection->GetRangeAt(j); MOZ_ASSERT(r); MOZ_ASSERT(r->IsPositioned()); // XXX Looks like that SavedRange should have mStart and mEnd which // are RangeBoundary. Then, we can avoid to compute offset here. savingRange.mStartContainer = r->GetStartContainer(); savingRange.mStartOffset = r->StartOffset(); savingRange.mEndContainer = r->GetEndContainer(); savingRange.mEndOffset = r->EndOffset(); savedRanges.AppendElement(savingRange); } } nsCOMPtr<nsINode> parent = aStartOfRightNode.GetContainerParent(); if (NS_WARN_IF(!parent)) { return Err(NS_ERROR_FAILURE); } // Fix the child before mutation observer may touch the DOM tree. nsIContent* firstChildOfRightNode = aStartOfRightNode.GetChild(); IgnoredErrorResult error; parent->InsertBefore( aNewNode, aStartOfRightNode.GetContainer()->GetNextSibling(), error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING("nsINode::InsertBefore() failed"); return Err(error.StealNSResult()); } MOZ_DIAGNOSTIC_ASSERT_IF(aStartOfRightNode.IsInTextNode(), aNewNode.IsText()); MOZ_DIAGNOSTIC_ASSERT_IF(!aStartOfRightNode.IsInTextNode(), !aNewNode.IsText()); // If we are splitting a text node, we need to move its some data to the // new text node. if (aStartOfRightNode.IsInTextNode()) { if (!aStartOfRightNode.IsEndOfContainer()) { Text* originalTextNode = aStartOfRightNode.ContainerAs<Text>(); Text* newTextNode = aNewNode.AsText(); nsAutoString movingText; const uint32_t cutStartOffset = aStartOfRightNode.Offset(); const uint32_t cutLength = originalTextNode->Length() - aStartOfRightNode.Offset(); IgnoredErrorResult error; originalTextNode->SubstringData(cutStartOffset, cutLength, movingText, error); NS_WARNING_ASSERTION(!error.Failed(), "Text::SubstringData() failed, but ignored"); error.SuppressException(); // XXX This call may destroy us. DoDeleteText(MOZ_KnownLive(*originalTextNode), cutStartOffset, cutLength, error); NS_WARNING_ASSERTION(!error.Failed(), "EditorBase::DoDeleteText() failed, but ignored"); error.SuppressException(); // XXX This call may destroy us. DoSetText(MOZ_KnownLive(*newTextNode), movingText, error); NS_WARNING_ASSERTION(!error.Failed(), "EditorBase::DoSetText() failed, but ignored"); } } // If the node has been moved to different parent, we should do nothing // since web apps should handle everything in such case. else if (firstChildOfRightNode && aStartOfRightNode.GetContainer() != firstChildOfRightNode->GetParentNode()) { NS_WARNING( "The web app interrupted us and touched the DOM tree, we stopped " "splitting anything"); } else { // If the right node is new one and there is no children or splitting at // end of the node, we need to do nothing. if (!firstChildOfRightNode) { // Do nothing. } // If the right node is new one and splitting at start of the container, // we need to move all children to the new right node. else if (!firstChildOfRightNode->GetPreviousSibling()) { // XXX Why do we ignore an error while moving nodes from the right // node to the left node? nsresult rv = MoveAllChildren(*aStartOfRightNode.GetContainer(), EditorRawDOMPoint(&aNewNode, 0u)); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::MoveAllChildren() failed, but ignored"); } // If the right node is new one and splitting at middle of the node, we need // to move inclusive next siblings of the split point to the new right node. else { // XXX Why do we ignore an error while moving nodes from the right node // to the left node? nsresult rv = MoveInclusiveNextSiblings(*firstChildOfRightNode, EditorRawDOMPoint(&aNewNode, 0u)); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::MoveInclusiveNextSiblings() failed, but ignored"); } } // Handle selection // TODO: Stop doing this, this shouldn't be necessary to update selection. if (RefPtr<PresShell> presShell = GetPresShell()) { presShell->FlushPendingNotifications(FlushType::Frames); } NS_WARNING_ASSERTION(!Destroyed(), "The editor is destroyed during splitting a node"); const bool allowedTransactionsToChangeSelection = AllowsTransactionsToChangeSelection(); RefPtr<Selection> previousSelection; for (SavedRange& savedRange : savedRanges) { // If we have not seen the selection yet, clear all of its ranges. if (savedRange.mSelection != previousSelection) { MOZ_KnownLive(savedRange.mSelection)->RemoveAllRanges(error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING("Selection::RemoveAllRanges() failed"); return Err(error.StealNSResult()); } previousSelection = savedRange.mSelection; } // XXX Looks like that we don't need to modify normal selection here // because selection will be modified by the caller if // AllowsTransactionsToChangeSelection() will return true. if (allowedTransactionsToChangeSelection && savedRange.mSelection->Type() == SelectionType::eNormal) { // If the editor should adjust the selection, don't bother restoring // the ranges for the normal selection here. continue; } auto AdjustDOMPoint = [&](nsCOMPtr<nsINode>& aContainer, uint32_t& aOffset) { if (aContainer != aStartOfRightNode.GetContainer()) { return; } // If the container is the left node and offset is after the split // point, the content was moved from the right node to aNewNode. // So, we need to change the container to aNewNode and decrease the // offset. if (aOffset >= aStartOfRightNode.Offset()) { aContainer = &aNewNode; aOffset -= aStartOfRightNode.Offset(); } }; AdjustDOMPoint(savedRange.mStartContainer, savedRange.mStartOffset); AdjustDOMPoint(savedRange.mEndContainer, savedRange.mEndOffset); RefPtr<nsRange> newRange = nsRange::Create(savedRange.mStartContainer, savedRange.mStartOffset, savedRange.mEndContainer, savedRange.mEndOffset, error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING("nsRange::Create() failed"); return Err(error.StealNSResult()); } // The `MOZ_KnownLive` annotation is only necessary because of a bug // (https://bugzilla.mozilla.org/show_bug.cgi?id=1622253) in the // static analyzer. MOZ_KnownLive(savedRange.mSelection) ->AddRangeAndSelectFramesAndNotifyListeners(*newRange, error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING( "Selection::AddRangeAndSelectFramesAndNotifyListeners() failed"); return Err(error.StealNSResult()); } } // We don't need to set selection here because the caller should do that // in any case. // If splitting the node causes running mutation event listener and we've // got unexpected result, we should return error because callers will // continue to do their work without complicated DOM tree result. // NOTE: Perhaps, we shouldn't do this immediately after each DOM tree change // because stopping handling it causes some data loss. E.g., user // may loose the text which is moved to the new text node. // XXX We cannot check all descendants in the right node and the new left // node for performance reason. I think that if caller needs to access // some of the descendants, they should check by themselves. if (NS_WARN_IF(parent != aStartOfRightNode.GetContainer()->GetParentNode()) || NS_WARN_IF(parent != aNewNode.GetParentNode()) || NS_WARN_IF(aNewNode.GetPreviousSibling() != aStartOfRightNode.GetContainer())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } DebugOnly<nsresult> rvIgnored = RangeUpdaterRef().SelAdjSplitNode( *aStartOfRightNode.ContainerAs<nsIContent>(), aStartOfRightNode.Offset(), aNewNode); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "RangeUpdater::SelAdjSplitNode() failed, but ignored"); return SplitNodeResult(aNewNode, *aStartOfRightNode.ContainerAs<nsIContent>()); } Result<JoinNodesResult, nsresult> HTMLEditor::JoinNodesWithTransaction( nsIContent& aLeftContent, nsIContent& aRightContent) { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(&aLeftContent != &aRightContent); MOZ_ASSERT(aLeftContent.GetParentNode()); MOZ_ASSERT(aRightContent.GetParentNode()); MOZ_ASSERT(aLeftContent.GetParentNode() == aRightContent.GetParentNode()); IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eJoinNodes, nsIEditor::ePrevious, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(ignoredError.StealNSResult()); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); if (NS_WARN_IF(!aRightContent.GetParentNode())) { return Err(NS_ERROR_FAILURE); } RefPtr<JoinNodesTransaction> transaction = JoinNodesTransaction::MaybeCreate(*this, aLeftContent, aRightContent); if (MOZ_UNLIKELY(!transaction)) { NS_WARNING("JoinNodesTransaction::MaybeCreate() failed"); return Err(NS_ERROR_FAILURE); } const nsresult rv = DoTransactionInternal(transaction); // FYI: Now, DidJoinNodesTransaction() must have been run if succeeded. if (NS_WARN_IF(Destroyed())) { return Err(NS_ERROR_EDITOR_DESTROYED); } // This shouldn't occur unless the cycle collector runs by chrome script // forcibly. if (NS_WARN_IF(!transaction->GetRemovedContent()) || NS_WARN_IF(!transaction->GetExistingContent())) { return Err(NS_ERROR_UNEXPECTED); } // If joined node is moved to different place, offset may not have any // meaning. In this case, the web app modified the DOM tree takes on the // responsibility for the remaning things. if (NS_WARN_IF(transaction->GetExistingContent()->GetParent() != transaction->GetParentNode())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DoTransactionInternal() failed"); return Err(rv); } return JoinNodesResult(transaction->CreateJoinedPoint<EditorDOMPoint>(), *transaction->GetRemovedContent()); } void HTMLEditor::DidJoinNodesTransaction( const JoinNodesTransaction& aTransaction, nsresult aDoJoinNodesResult) { // This shouldn't occur unless the cycle collector runs by chrome script // forcibly. if (MOZ_UNLIKELY(NS_WARN_IF(!aTransaction.GetRemovedContent()) || NS_WARN_IF(!aTransaction.GetExistingContent()))) { return; } // If joined node is moved to different place, offset may not have any // meaning. In this case, the web app modified the DOM tree takes on the // responsibility for the remaning things. if (MOZ_UNLIKELY(aTransaction.GetExistingContent()->GetParentNode() != aTransaction.GetParentNode())) { return; } // Be aware, the joined point should be created for each call because // they may refer the child node, but some of them may change the DOM tree // after that, thus we need to avoid invalid point (Although it shouldn't // occur). TopLevelEditSubActionDataRef().DidJoinContents( *this, aTransaction.CreateJoinedPoint<EditorRawDOMPoint>()); if (NS_SUCCEEDED(aDoJoinNodesResult)) { if (RefPtr<TextServicesDocument> textServicesDocument = mTextServicesDocument) { textServicesDocument->DidJoinContents( aTransaction.CreateJoinedPoint<EditorRawDOMPoint>(), *aTransaction.GetRemovedContent()); } } if (!mActionListeners.IsEmpty()) { for (auto& listener : mActionListeners.Clone()) { DebugOnly<nsresult> rvIgnored = listener->DidJoinContents( aTransaction.CreateJoinedPoint<EditorRawDOMPoint>(), aTransaction.GetRemovedContent()); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "nsIEditActionListener::DidJoinContents() failed, but ignored"); } } } nsresult HTMLEditor::DoJoinNodes(nsIContent& aContentToKeep, nsIContent& aContentToRemove) { MOZ_ASSERT(IsEditActionDataAvailable()); const uint32_t keepingContentLength = aContentToKeep.Length(); const EditorDOMPoint oldPointAtRightContent(&aContentToRemove); if (MOZ_LIKELY(oldPointAtRightContent.IsSet())) { Unused << oldPointAtRightContent.Offset(); // Fix the offset } // Remember all selection points. // XXX Do we need to restore all types of selections by ourselves? Normal // selection should be modified later as result of handling edit action. // IME selections shouldn't be there when nodes are joined. Spellcheck // selections should be recreated with newer text. URL selections // shouldn't be there because of used only by the URL bar. AutoTArray<SavedRange, 10> savedRanges; { EditorRawDOMPoint atRemovingNode(&aContentToRemove); EditorRawDOMPoint atNodeToKeep(&aContentToKeep); for (SelectionType selectionType : kPresentSelectionTypes) { SavedRange savingRange; savingRange.mSelection = GetSelection(selectionType); if (selectionType == SelectionType::eNormal) { if (NS_WARN_IF(!savingRange.mSelection)) { return NS_ERROR_FAILURE; } } else if (!savingRange.mSelection) { // For non-normal selections, skip over the non-existing ones. continue; } const uint32_t rangeCount = savingRange.mSelection->RangeCount(); for (const uint32_t j : IntegerRange(rangeCount)) { MOZ_ASSERT(savingRange.mSelection->RangeCount() == rangeCount); const RefPtr<nsRange> r = savingRange.mSelection->GetRangeAt(j); MOZ_ASSERT(r); MOZ_ASSERT(r->IsPositioned()); savingRange.mStartContainer = r->GetStartContainer(); savingRange.mStartOffset = r->StartOffset(); savingRange.mEndContainer = r->GetEndContainer(); savingRange.mEndOffset = r->EndOffset(); // If selection endpoint is between the nodes, remember it as being // in the one that is going away instead. This simplifies later // selection adjustment logic at end of this method. if (savingRange.mStartContainer) { MOZ_ASSERT(savingRange.mEndContainer); auto AdjustDOMPoint = [&](nsCOMPtr<nsINode>& aContainer, uint32_t& aOffset) { // If range boundary points aContentToRemove and aContentToKeep is // its left node, remember it as being at end of aContentToKeep. // Then, it will point start of the first content of moved content // from aContentToRemove. if (aContainer == atRemovingNode.GetContainer() && atNodeToKeep.Offset() < aOffset && aOffset <= atRemovingNode.Offset()) { aContainer = &aContentToKeep; aOffset = keepingContentLength; } }; AdjustDOMPoint(savingRange.mStartContainer, savingRange.mStartOffset); AdjustDOMPoint(savingRange.mEndContainer, savingRange.mEndOffset); } savedRanges.AppendElement(savingRange); } } } // OK, ready to do join now. nsresult rv = [&]() MOZ_CAN_RUN_SCRIPT { // If it's a text node, just shuffle around some text. if (aContentToKeep.IsText() && aContentToRemove.IsText()) { nsAutoString rightText; nsAutoString leftText; aContentToRemove.AsText()->GetData(rightText); aContentToKeep.AsText()->GetData(leftText); leftText += rightText; IgnoredErrorResult ignoredError; DoSetText(MOZ_KnownLive(*aContentToKeep.AsText()), leftText, ignoredError); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(!ignoredError.Failed(), "EditorBase::DoSetText() failed, but ignored"); return NS_OK; } // Otherwise it's an interior node, so shuffle around the children. AutoTArray<OwningNonNull<nsIContent>, 64> arrayOfChildContents; HTMLEditUtils::CollectAllChildren(aContentToRemove, arrayOfChildContents); for (const OwningNonNull<nsIContent>& child : arrayOfChildContents) { IgnoredErrorResult error; aContentToKeep.AppendChild(child, error); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (error.Failed()) { NS_WARNING("nsINode::AppendChild() failed"); return error.StealNSResult(); } } return NS_OK; }(); // Delete the extra node. if (NS_SUCCEEDED(rv)) { aContentToRemove.Remove(); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } } if (MOZ_LIKELY(oldPointAtRightContent.IsSet())) { DebugOnly<nsresult> rvIgnored = RangeUpdaterRef().SelAdjJoinNodes( EditorRawDOMPoint(&aContentToKeep, std::min(keepingContentLength, aContentToKeep.Length())), aContentToRemove, oldPointAtRightContent); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "RangeUpdater::SelAdjJoinNodes() failed, but ignored"); } if (MOZ_UNLIKELY(NS_FAILED(rv))) { return rv; } const bool allowedTransactionsToChangeSelection = AllowsTransactionsToChangeSelection(); // And adjust the selection if needed. RefPtr<Selection> previousSelection; for (SavedRange& savedRange : savedRanges) { // If we have not seen the selection yet, clear all of its ranges. if (savedRange.mSelection != previousSelection) { IgnoredErrorResult error; MOZ_KnownLive(savedRange.mSelection)->RemoveAllRanges(error); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (error.Failed()) { NS_WARNING("Selection::RemoveAllRanges() failed"); return error.StealNSResult(); } previousSelection = savedRange.mSelection; } if (allowedTransactionsToChangeSelection && savedRange.mSelection->Type() == SelectionType::eNormal) { // If the editor should adjust the selection, don't bother restoring // the ranges for the normal selection here. continue; } auto AdjustDOMPoint = [&](nsCOMPtr<nsINode>& aContainer, uint32_t& aOffset) { // Now, all content of aContentToRemove are moved to end of // aContentToKeep. Therefore, if a range boundary was in // aContentToRemove, we need to change the container to aContentToKeep and // adjust the offset to after the original content of aContentToKeep. if (aContainer == &aContentToRemove) { aContainer = &aContentToKeep; aOffset += keepingContentLength; } }; AdjustDOMPoint(savedRange.mStartContainer, savedRange.mStartOffset); AdjustDOMPoint(savedRange.mEndContainer, savedRange.mEndOffset); const RefPtr<nsRange> newRange = nsRange::Create( savedRange.mStartContainer, savedRange.mStartOffset, savedRange.mEndContainer, savedRange.mEndOffset, IgnoreErrors()); if (!newRange) { NS_WARNING("nsRange::Create() failed"); return NS_ERROR_FAILURE; } IgnoredErrorResult error; // The `MOZ_KnownLive` annotation is only necessary because of a bug // (https://bugzilla.mozilla.org/show_bug.cgi?id=1622253) in the // static analyzer. MOZ_KnownLive(savedRange.mSelection) ->AddRangeAndSelectFramesAndNotifyListeners(*newRange, error); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (NS_WARN_IF(error.Failed())) { return error.StealNSResult(); } } if (allowedTransactionsToChangeSelection) { // Editor wants us to set selection at join point. DebugOnly<nsresult> rvIgnored = CollapseSelectionToStartOf(aContentToKeep); if (MOZ_UNLIKELY(rv == NS_ERROR_EDITOR_DESTROYED)) { NS_WARNING( "EditorBase::CollapseSelectionTo() caused destroying the editor"); return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBases::CollapseSelectionTos() failed, but ignored"); } return NS_OK; } Result<MoveNodeResult, nsresult> HTMLEditor::MoveNodeWithTransaction( nsIContent& aContentToMove, const EditorDOMPoint& aPointToInsert) { MOZ_ASSERT(aPointToInsert.IsSetAndValid()); EditorDOMPoint oldPoint(&aContentToMove); if (NS_WARN_IF(!oldPoint.IsSet())) { return Err(NS_ERROR_FAILURE); } // Don't do anything if it's already in right place. if (aPointToInsert == oldPoint) { return MoveNodeResult::IgnoredResult(aPointToInsert.NextPoint()); } RefPtr<MoveNodeTransaction> moveNodeTransaction = MoveNodeTransaction::MaybeCreate(*this, aContentToMove, aPointToInsert); if (MOZ_UNLIKELY(!moveNodeTransaction)) { NS_WARNING("MoveNodeTransaction::MaybeCreate() failed"); return Err(NS_ERROR_FAILURE); } IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eMoveNode, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(ignoredError.StealNSResult()); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "TextEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); TopLevelEditSubActionDataRef().WillDeleteContent(*this, aContentToMove); nsresult rv = DoTransactionInternal(moveNodeTransaction); if (NS_SUCCEEDED(rv)) { if (mTextServicesDocument) { const OwningNonNull<TextServicesDocument> textServicesDocument = *mTextServicesDocument; textServicesDocument->DidDeleteContent(aContentToMove); } } if (!mActionListeners.IsEmpty()) { for (auto& listener : mActionListeners.Clone()) { DebugOnly<nsresult> rvIgnored = listener->DidDeleteNode(&aContentToMove, rv); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "nsIEditActionListener::DidDeleteNode() failed, but ignored"); } } if (MOZ_UNLIKELY(Destroyed())) { NS_WARNING( "MoveNodeTransaction::DoTransaction() caused destroying the editor"); return Err(NS_ERROR_EDITOR_DESTROYED); } if (NS_FAILED(rv)) { NS_WARNING("MoveNodeTransaction::DoTransaction() failed"); return Err(rv); } TopLevelEditSubActionDataRef().DidInsertContent(*this, aContentToMove); return MoveNodeResult::HandledResult( moveNodeTransaction->SuggestNextInsertionPoint<EditorDOMPoint>(), moveNodeTransaction->SuggestPointToPutCaret<EditorDOMPoint>()); } Result<RefPtr<Element>, nsresult> HTMLEditor::DeleteSelectionAndCreateElement( nsAtom& aTag, const InitializeInsertingElement& aInitializer) { MOZ_ASSERT(IsEditActionDataAvailable()); nsresult rv = DeleteSelectionAndPrepareToCreateNode(); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::DeleteSelectionAndPrepareToCreateNode() failed"); return Err(rv); } EditorDOMPoint pointToInsert(SelectionRef().AnchorRef()); if (!pointToInsert.IsSet()) { return Err(NS_ERROR_FAILURE); } Result<CreateElementResult, nsresult> createNewElementResult = CreateAndInsertElement(WithTransaction::Yes, aTag, pointToInsert, aInitializer); if (MOZ_UNLIKELY(createNewElementResult.isErr())) { NS_WARNING( "HTMLEditor::CreateAndInsertElement(WithTransaction::Yes) failed"); return createNewElementResult.propagateErr(); } MOZ_ASSERT(createNewElementResult.inspect().GetNewNode()); // We want the selection to be just after the new node createNewElementResult.inspect().IgnoreCaretPointSuggestion(); rv = CollapseSelectionTo( EditorRawDOMPoint::After(*createNewElementResult.inspect().GetNewNode())); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::CollapseSelectionTo() failed"); return Err(rv); } return createNewElementResult.unwrap().UnwrapNewNode(); } nsresult HTMLEditor::DeleteSelectionAndPrepareToCreateNode() { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!SelectionRef().GetAnchorFocusRange())) { return NS_OK; } if (!SelectionRef().GetAnchorFocusRange()->Collapsed()) { nsresult rv = DeleteSelectionAsSubAction(nsIEditor::eNone, nsIEditor::eStrip); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteSelectionAsSubAction() failed"); return rv; } MOZ_ASSERT(SelectionRef().GetAnchorFocusRange() && SelectionRef().GetAnchorFocusRange()->Collapsed(), "Selection not collapsed after delete"); } // If the selection is a chardata node, split it if necessary and compute // where to put the new node EditorDOMPoint atAnchor(SelectionRef().AnchorRef()); if (NS_WARN_IF(!atAnchor.IsSet()) || !atAnchor.IsInDataNode()) { return NS_OK; } if (NS_WARN_IF(!atAnchor.GetContainerParent())) { return NS_ERROR_FAILURE; } if (atAnchor.IsStartOfContainer()) { const EditorRawDOMPoint atAnchorContainer(atAnchor.GetContainer()); if (NS_WARN_IF(!atAnchorContainer.IsSetAndValid())) { return NS_ERROR_FAILURE; } nsresult rv = CollapseSelectionTo(atAnchorContainer); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionTo() failed"); return rv; } if (atAnchor.IsEndOfContainer()) { EditorRawDOMPoint afterAnchorContainer(atAnchor.GetContainer()); if (NS_WARN_IF(!afterAnchorContainer.AdvanceOffset())) { return NS_ERROR_FAILURE; } nsresult rv = CollapseSelectionTo(afterAnchorContainer); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionTo() failed"); return rv; } Result<SplitNodeResult, nsresult> splitAtAnchorResult = SplitNodeWithTransaction(atAnchor); if (MOZ_UNLIKELY(splitAtAnchorResult.isErr())) { NS_WARNING("HTMLEditor::SplitNodeWithTransaction() failed"); return splitAtAnchorResult.unwrapErr(); } splitAtAnchorResult.inspect().IgnoreCaretPointSuggestion(); const auto atRightContent = splitAtAnchorResult.inspect().AtNextContent<EditorRawDOMPoint>(); if (NS_WARN_IF(!atRightContent.IsSet())) { return NS_ERROR_FAILURE; } MOZ_ASSERT(atRightContent.IsSetAndValid()); nsresult rv = CollapseSelectionTo(atRightContent); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionTo() failed"); return rv; } bool HTMLEditor::IsEmpty() const { if (mPaddingBRElementForEmptyEditor) { return true; } // XXX Oddly, we check body or document element's state instead of // active editing host. Must be a bug. Element* bodyOrDocumentElement = GetRoot(); if (!bodyOrDocumentElement) { return true; } for (nsIContent* childContent = bodyOrDocumentElement->GetFirstChild(); childContent; childContent = childContent->GetNextSibling()) { if (!childContent->IsText() || childContent->Length()) { return false; } } return true; } // add to aElement the CSS inline styles corresponding to the HTML attribute // aAttribute with its value aValue nsresult HTMLEditor::SetAttributeOrEquivalent(Element* aElement, nsAtom* aAttribute, const nsAString& aValue, bool aSuppressTransaction) { MOZ_ASSERT(aElement); MOZ_ASSERT(aAttribute); nsAutoScriptBlocker scriptBlocker; nsStyledElement* styledElement = nsStyledElement::FromNodeOrNull(aElement); if (!IsCSSEnabled()) { // we are not in an HTML+CSS editor; let's set the attribute the HTML way if (EditorElementStyle::IsHTMLStyle(aAttribute)) { const EditorElementStyle elementStyle = EditorElementStyle::Create(*aAttribute); if (styledElement && elementStyle.IsCSSRemovable(*styledElement)) { // MOZ_KnownLive(*styledElement): It's aElement and its lifetime must // be guaranteed by the caller because of MOZ_CAN_RUN_SCRIPT method. nsresult rv = CSSEditUtils::RemoveCSSEquivalentToStyle( aSuppressTransaction ? WithTransaction::No : WithTransaction::Yes, *this, MOZ_KnownLive(*styledElement), elementStyle, nullptr); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "CSSEditUtils::RemoveCSSEquivalentToStyle() failed, but ignored"); } } if (aSuppressTransaction) { nsresult rv = aElement->SetAttr(kNameSpaceID_None, aAttribute, aValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr() failed"); return rv; } nsresult rv = SetAttributeWithTransaction(*aElement, *aAttribute, aValue); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::SetAttributeWithTransaction() failed"); return rv; } if (EditorElementStyle::IsHTMLStyle(aAttribute)) { const EditorElementStyle elementStyle = EditorElementStyle::Create(*aAttribute); if (styledElement && elementStyle.IsCSSSettable(*styledElement)) { // MOZ_KnownLive(*styledElement): It's aElement and its lifetime must // be guaranteed by the caller because of MOZ_CAN_RUN_SCRIPT method. Result<size_t, nsresult> count = CSSEditUtils::SetCSSEquivalentToStyle( aSuppressTransaction ? WithTransaction::No : WithTransaction::Yes, *this, MOZ_KnownLive(*styledElement), elementStyle, &aValue); if (MOZ_UNLIKELY(count.isErr())) { if (NS_WARN_IF(count.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle() failed, but ignored"); } if (count.inspect()) { // we found an equivalence ; let's remove the HTML attribute itself if // it is set nsAutoString existingValue; if (!aElement->GetAttr(aAttribute, existingValue)) { return NS_OK; } if (aSuppressTransaction) { nsresult rv = aElement->UnsetAttr(kNameSpaceID_None, aAttribute, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::UnsetAttr() failed"); return rv; } nsresult rv = RemoveAttributeWithTransaction(*aElement, *aAttribute); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::RemoveAttributeWithTransaction() failed"); return rv; } } } // count is an integer that represents the number of CSS declarations // applied to the element. If it is zero, we found no equivalence in this // implementation for the attribute if (aAttribute == nsGkAtoms::style) { // if it is the style attribute, just add the new value to the existing // style attribute's value nsString existingValue; // Use nsString to avoid copying the string // buffer at setting the attribute below. aElement->GetAttr(nsGkAtoms::style, existingValue); if (!existingValue.IsEmpty()) { existingValue.Append(HTMLEditUtils::kSpace); } existingValue.Append(aValue); if (aSuppressTransaction) { nsresult rv = aElement->SetAttr(kNameSpaceID_None, nsGkAtoms::style, existingValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr(nsGkAtoms::style) failed"); return rv; } nsresult rv = SetAttributeWithTransaction(*aElement, *nsGkAtoms::style, existingValue); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::SetAttributeWithTransaction(nsGkAtoms::style) failed"); return rv; } // we have no CSS equivalence for this attribute and it is not the style // attribute; let's set it the good'n'old HTML way if (aSuppressTransaction) { nsresult rv = aElement->SetAttr(kNameSpaceID_None, aAttribute, aValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr() failed"); return rv; } nsresult rv = SetAttributeWithTransaction(*aElement, *aAttribute, aValue); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::SetAttributeWithTransaction() failed"); return rv; } nsresult HTMLEditor::RemoveAttributeOrEquivalent(Element* aElement, nsAtom* aAttribute, bool aSuppressTransaction) { MOZ_ASSERT(aElement); MOZ_ASSERT(aAttribute); if (IsCSSEnabled() && EditorElementStyle::IsHTMLStyle(aAttribute)) { const EditorElementStyle elementStyle = EditorElementStyle::Create(*aAttribute); if (elementStyle.IsCSSRemovable(*aElement)) { // XXX It might be keep handling attribute even if aElement is not // an nsStyledElement instance. nsStyledElement* styledElement = nsStyledElement::FromNodeOrNull(aElement); if (NS_WARN_IF(!styledElement)) { return NS_ERROR_INVALID_ARG; } // MOZ_KnownLive(*styledElement): It's aElement and its lifetime must // be guaranteed by the caller because of MOZ_CAN_RUN_SCRIPT method. nsresult rv = CSSEditUtils::RemoveCSSEquivalentToStyle( aSuppressTransaction ? WithTransaction::No : WithTransaction::Yes, *this, MOZ_KnownLive(*styledElement), elementStyle, nullptr); if (NS_FAILED(rv)) { NS_WARNING("CSSEditUtils::RemoveCSSEquivalentToStyle() failed"); return rv; } } } if (!aElement->HasAttr(aAttribute)) { return NS_OK; } if (aSuppressTransaction) { nsresult rv = aElement->UnsetAttr(kNameSpaceID_None, aAttribute, /* aNotify = */ true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::UnsetAttr() failed"); return rv; } nsresult rv = RemoveAttributeWithTransaction(*aElement, *aAttribute); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::RemoveAttributeWithTransaction() failed"); return rv; } NS_IMETHODIMP HTMLEditor::SetIsCSSEnabled(bool aIsCSSPrefChecked) { AutoEditActionDataSetter editActionData(*this, EditAction::eEnableOrDisableCSS); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } mIsCSSPrefChecked = aIsCSSPrefChecked; return NS_OK; } // Set the block background color nsresult HTMLEditor::SetBlockBackgroundColorWithCSSAsSubAction( const nsAString& aColor) { MOZ_ASSERT(IsEditActionDataAvailable()); // background-color change and committing composition should be undone // together AutoPlaceholderBatch treatAsOneTransaction( *this, ScrollSelectionIntoView::Yes, __FUNCTION__); CommitComposition(); // XXX Shouldn't we do this before calling `CommitComposition()`? if (IsPlaintextMailComposer()) { return NS_OK; } { Result<EditActionResult, nsresult> result = CanHandleHTMLEditSubAction(); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::CanHandleHTMLEditSubAction() failed"); return result.unwrapErr(); } if (result.inspect().Canceled()) { return NS_OK; } } IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eInsertElement, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return ignoredError.StealNSResult(); } NS_WARNING_ASSERTION(!ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() " "failed, but ignored"); // TODO: We don't need AutoTransactionsConserveSelection here in the normal // cases, but removing this may cause the behavior with the legacy // mutation event listeners. We should try to delete this in a bug. AutoTransactionsConserveSelection dontChangeMySelection(*this); AutoRangeArray selectionRanges(SelectionRef()); MOZ_ALWAYS_TRUE(selectionRanges.SaveAndTrackRanges(*this)); for (const OwningNonNull<nsRange>& domRange : selectionRanges.Ranges()) { EditorDOMRange range(domRange); if (NS_WARN_IF(!range.IsPositioned())) { continue; } if (range.InSameContainer()) { // If the range is in a text node, set background color of its parent // block. if (range.StartRef().IsInTextNode()) { const RefPtr<nsStyledElement> editableBlockStyledElement = nsStyledElement::FromNodeOrNull(HTMLEditUtils::GetAncestorElement( *range.StartRef().ContainerAs<Text>(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle)); if (!editableBlockStyledElement || !EditorElementStyle::BGColor().IsCSSSettable( *editableBlockStyledElement)) { continue; } Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *editableBlockStyledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } continue; } // If `Selection` is collapsed in a `<body>` element, set background // color of the `<body>` element. if (range.Collapsed() && range.StartRef().IsContainerHTMLElement(nsGkAtoms::body)) { const RefPtr<nsStyledElement> styledElement = range.StartRef().GetContainerAs<nsStyledElement>(); if (!styledElement || !EditorElementStyle::BGColor().IsCSSSettable(*styledElement)) { continue; } Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *styledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } continue; } // If one node is selected, set background color of it if it's a // block, or of its parent block otherwise. if ((range.StartRef().IsStartOfContainer() && range.EndRef().IsStartOfContainer()) || range.StartRef().Offset() + 1 == range.EndRef().Offset()) { if (NS_WARN_IF(range.StartRef().IsInDataNode())) { continue; } const RefPtr<nsStyledElement> editableBlockStyledElement = nsStyledElement::FromNodeOrNull( HTMLEditUtils::GetInclusiveAncestorElement( *range.StartRef().GetChild(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle)); if (!editableBlockStyledElement || !EditorElementStyle::BGColor().IsCSSSettable( *editableBlockStyledElement)) { continue; } Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *editableBlockStyledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } continue; } } // if (range.InSameContainer()) // Collect editable nodes which are entirely contained in the range. AutoTArray<OwningNonNull<nsIContent>, 64> arrayOfContents; { ContentSubtreeIterator subtreeIter; // If there is no node which is entirely in the range, // `ContentSubtreeIterator::Init()` fails, but this is possible case, // don't warn it. nsresult rv = subtreeIter.Init(range.StartRef().ToRawRangeBoundary(), range.EndRef().ToRawRangeBoundary()); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "ContentSubtreeIterator::Init() failed, but ignored"); if (NS_SUCCEEDED(rv)) { for (; !subtreeIter.IsDone(); subtreeIter.Next()) { nsINode* node = subtreeIter.GetCurrentNode(); if (NS_WARN_IF(!node)) { return NS_ERROR_FAILURE; } if (node->IsContent() && EditorUtils::IsEditableContent( *node->AsContent(), EditorType::HTML)) { arrayOfContents.AppendElement(*node->AsContent()); } } } } // This caches block parent if we set its background color. RefPtr<Element> handledBlockParent; // If start node is a text node, set background color of its parent // block. if (range.StartRef().IsInTextNode() && EditorUtils::IsEditableContent(*range.StartRef().ContainerAs<Text>(), EditorType::HTML)) { Element* const editableBlockElement = HTMLEditUtils::GetAncestorElement( *range.StartRef().ContainerAs<Text>(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (editableBlockElement && handledBlockParent != editableBlockElement) { handledBlockParent = editableBlockElement; nsStyledElement* const blockStyledElement = nsStyledElement::FromNode(handledBlockParent); if (blockStyledElement && EditorElementStyle::BGColor().IsCSSSettable(*blockStyledElement)) { // MOZ_KnownLive(*blockStyledElement): It's handledBlockParent // whose type is RefPtr. Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, MOZ_KnownLive(*blockStyledElement), EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } } } } // Then, set background color of each block or block parent of all nodes // in the range entirely. for (OwningNonNull<nsIContent>& content : arrayOfContents) { Element* const editableBlockElement = HTMLEditUtils::GetInclusiveAncestorElement( content, HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (editableBlockElement && handledBlockParent != editableBlockElement) { handledBlockParent = editableBlockElement; nsStyledElement* const blockStyledElement = nsStyledElement::FromNode(handledBlockParent); if (blockStyledElement && EditorElementStyle::BGColor().IsCSSSettable(*blockStyledElement)) { // MOZ_KnownLive(*blockStyledElement): It's handledBlockParent whose // type is RefPtr. Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, MOZ_KnownLive(*blockStyledElement), EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } } } } // Finally, if end node is a text node, set background color of its // parent block. if (range.EndRef().IsInTextNode() && EditorUtils::IsEditableContent(*range.EndRef().ContainerAs<Text>(), EditorType::HTML)) { Element* const editableBlockElement = HTMLEditUtils::GetAncestorElement( *range.EndRef().ContainerAs<Text>(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (editableBlockElement && handledBlockParent != editableBlockElement) { const RefPtr<nsStyledElement> blockStyledElement = nsStyledElement::FromNode(editableBlockElement); if (blockStyledElement && EditorElementStyle::BGColor().IsCSSSettable(*blockStyledElement)) { Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *blockStyledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } } } } } // for-loop of selectionRanges MOZ_ASSERT(selectionRanges.HasSavedRanges()); selectionRanges.RestoreFromSavedRanges(); nsresult rv = selectionRanges.ApplyTo(SelectionRef()); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "AutoRangeArray::ApplyTo() failed"); return rv; } NS_IMETHODIMP HTMLEditor::SetBackgroundColor(const nsAString& aColor) { nsresult rv = SetBackgroundColorAsAction(aColor); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::SetBackgroundColorAsAction() failed"); return rv; } nsresult HTMLEditor::SetBackgroundColorAsAction(const nsAString& aColor, nsIPrincipal* aPrincipal) { AutoEditActionDataSetter editActionData( *this, EditAction::eSetBackgroundColor, aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } if (IsCSSEnabled()) { // if we are in CSS mode, we have to apply the background color to the // containing block (or the body if we have no block-level element in // the document) nsresult rv = SetBlockBackgroundColorWithCSSAsSubAction(aColor); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::SetBlockBackgroundColorWithCSSAsSubAction() failed"); return EditorBase::ToGenericNSResult(rv); } // but in HTML mode, we can only set the document's background color rv = SetHTMLBackgroundColorWithTransaction(aColor); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::SetHTMLBackgroundColorWithTransaction() failed"); return EditorBase::ToGenericNSResult(rv); } Result<EditorDOMPoint, nsresult> HTMLEditor::CopyLastEditableChildStylesWithTransaction( Element& aPreviousBlock, Element& aNewBlock, const Element& aEditingHost) { MOZ_ASSERT(IsEditActionDataAvailable()); // First, clear out aNewBlock. Contract is that we want only the styles // from aPreviousBlock. AutoTArray<OwningNonNull<nsIContent>, 32> newBlockChildren; HTMLEditUtils::CollectAllChildren(aNewBlock, newBlockChildren); for (const OwningNonNull<nsIContent>& child : newBlockChildren) { // MOZ_KNownLive(child) because of bug 1622253 nsresult rv = DeleteNodeWithTransaction(MOZ_KnownLive(child)); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteNodeWithTransaction() failed"); return Err(rv); } } if (MOZ_UNLIKELY(aNewBlock.GetFirstChild())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } // XXX aNewBlock may be moved or removed. Even in such case, we should // keep cloning the styles? // Look for the deepest last editable leaf node in aPreviousBlock. // Then, if found one is a <br> element, look for non-<br> element. nsIContent* deepestEditableContent = nullptr; for (nsCOMPtr<nsIContent> child = &aPreviousBlock; child; child = HTMLEditUtils::GetLastChild( *child, {WalkTreeOption::IgnoreNonEditableNode})) { deepestEditableContent = child; } while (deepestEditableContent && deepestEditableContent->IsHTMLElement(nsGkAtoms::br)) { deepestEditableContent = HTMLEditUtils::GetPreviousContent( *deepestEditableContent, {WalkTreeOption::IgnoreNonEditableNode}, BlockInlineCheck::UseComputedDisplayOutsideStyle, &aEditingHost); } if (!deepestEditableContent) { return EditorDOMPoint(&aNewBlock, 0u); } Element* deepestVisibleEditableElement = deepestEditableContent->GetAsElementOrParentElement(); if (!deepestVisibleEditableElement) { return EditorDOMPoint(&aNewBlock, 0u); } // Clone inline elements to keep current style in the new block. // XXX Looks like that this is really slow if lastEditableDescendant is // far from aPreviousBlock. Probably, we should clone inline containers // from ancestor to descendants without transactions, then, insert it // after that with transaction. RefPtr<Element> lastClonedElement, firstClonedElement; for (RefPtr<Element> elementInPreviousBlock = deepestVisibleEditableElement; elementInPreviousBlock && elementInPreviousBlock != &aPreviousBlock; elementInPreviousBlock = elementInPreviousBlock->GetParentElement()) { if (!HTMLEditUtils::IsInlineStyle(elementInPreviousBlock) && !elementInPreviousBlock->IsHTMLElement(nsGkAtoms::span)) { continue; } OwningNonNull<nsAtom> tagName = *elementInPreviousBlock->NodeInfo()->NameAtom(); // At first time, just create the most descendant inline container // element. if (!firstClonedElement) { Result<CreateElementResult, nsresult> createNewElementResult = CreateAndInsertElement( WithTransaction::Yes, tagName, EditorDOMPoint(&aNewBlock, 0u), // MOZ_CAN_RUN_SCRIPT_BOUNDARY due to bug 1758868 [&elementInPreviousBlock]( HTMLEditor& aHTMLEditor, Element& aNewElement, const EditorDOMPoint&) MOZ_CAN_RUN_SCRIPT_BOUNDARY { // Clone all attributes. Note that despite the method name, // CloneAttributesWithTransaction does not create // transactions in this case because aNewElement has not // been connected yet. // XXX Looks like that this clones id attribute too. aHTMLEditor.CloneAttributesWithTransaction( aNewElement, *elementInPreviousBlock); return NS_OK; }); if (MOZ_UNLIKELY(createNewElementResult.isErr())) { NS_WARNING( "HTMLEditor::CreateAndInsertElement(WithTransaction::Yes) failed"); return createNewElementResult.propagateErr(); } CreateElementResult unwrappedCreateNewElementResult = createNewElementResult.unwrap(); // We'll return with a point suggesting new caret position and the // following path does not require an update of selection here. // Therefore, we don't need to update selection here. unwrappedCreateNewElementResult.IgnoreCaretPointSuggestion(); firstClonedElement = lastClonedElement = unwrappedCreateNewElementResult.UnwrapNewNode(); continue; } // Otherwise, inserts new parent inline container to the previous inserted // inline container. Result<CreateElementResult, nsresult> wrapClonedElementResult = InsertContainerWithTransaction(*lastClonedElement, tagName); if (MOZ_UNLIKELY(wrapClonedElementResult.isErr())) { NS_WARNING("HTMLEditor::InsertContainerWithTransaction() failed"); return wrapClonedElementResult.propagateErr(); } CreateElementResult unwrappedWrapClonedElementResult = wrapClonedElementResult.unwrap(); // We'll return with a point suggesting new caret so that we don't need to // update selection here. unwrappedWrapClonedElementResult.IgnoreCaretPointSuggestion(); MOZ_ASSERT(unwrappedWrapClonedElementResult.GetNewNode()); lastClonedElement = unwrappedWrapClonedElementResult.UnwrapNewNode(); CloneAttributesWithTransaction(*lastClonedElement, *elementInPreviousBlock); if (NS_WARN_IF(Destroyed())) { return Err(NS_ERROR_EDITOR_DESTROYED); } } if (!firstClonedElement) { // XXX Even if no inline elements are cloned, shouldn't we create new // <br> element for aNewBlock? return EditorDOMPoint(&aNewBlock, 0u); } Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement( WithTransaction::Yes, EditorDOMPoint(firstClonedElement, 0u)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING("HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } insertBRElementResult.inspect().IgnoreCaretPointSuggestion(); MOZ_ASSERT(insertBRElementResult.inspect().GetNewNode()); return EditorDOMPoint(insertBRElementResult.inspect().GetNewNode()); } nsresult HTMLEditor::GetElementOrigin(Element& aElement, int32_t& aX, int32_t& aY) { aX = 0; aY = 0; if (NS_WARN_IF(!IsInitialized())) { return NS_ERROR_NOT_INITIALIZED; } PresShell* presShell = GetPresShell(); if (NS_WARN_IF(!presShell)) { return NS_ERROR_NOT_INITIALIZED; } nsIFrame* frame = aElement.GetPrimaryFrame(); if (NS_WARN_IF(!frame)) { return NS_OK; } nsIFrame* absoluteContainerBlockFrame = presShell->GetAbsoluteContainingBlock(frame); if (NS_WARN_IF(!absoluteContainerBlockFrame)) { return NS_OK; } nsPoint off = frame->GetOffsetTo(absoluteContainerBlockFrame); aX = nsPresContext::AppUnitsToIntCSSPixels(off.x); aY = nsPresContext::AppUnitsToIntCSSPixels(off.y); return NS_OK; } Element* HTMLEditor::GetSelectionContainerElement() const { MOZ_ASSERT(IsEditActionDataAvailable()); nsINode* focusNode = nullptr; if (SelectionRef().IsCollapsed()) { focusNode = SelectionRef().GetFocusNode(); if (NS_WARN_IF(!focusNode)) { return nullptr; } } else { const uint32_t rangeCount = SelectionRef().RangeCount(); MOZ_ASSERT(rangeCount, "If 0, Selection::IsCollapsed() should return true"); if (rangeCount == 1) { const nsRange* range = SelectionRef().GetRangeAt(0); const RangeBoundary& startRef = range->StartRef(); const RangeBoundary& endRef = range->EndRef(); // This method called GetSelectedElement() to retrieve proper container // when only one node is selected. However, it simply returns start // node of Selection with additional cost. So, we do not need to call // it anymore. if (startRef.Container()->IsElement() && startRef.Container() == endRef.Container() && startRef.GetChildAtOffset() && startRef.GetChildAtOffset()->GetNextSibling() == endRef.GetChildAtOffset()) { focusNode = startRef.GetChildAtOffset(); MOZ_ASSERT(focusNode, "Start container must not be nullptr"); } else { focusNode = range->GetClosestCommonInclusiveAncestor(); if (!focusNode) { NS_WARNING( "AbstractRange::GetClosestCommonInclusiveAncestor() returned " "nullptr"); return nullptr; } } } else { for (const uint32_t i : IntegerRange(rangeCount)) { MOZ_ASSERT(SelectionRef().RangeCount() == rangeCount); const nsRange* range = SelectionRef().GetRangeAt(i); MOZ_ASSERT(range); nsINode* startContainer = range->GetStartContainer(); if (!focusNode) { focusNode = startContainer; } else if (focusNode != startContainer) { // XXX Looks odd to use parent of startContainer because previous // range may not be in the parent node of current // startContainer. focusNode = startContainer->GetParentNode(); // XXX Looks odd to break the for-loop here because we refer only // first range and another range which starts from different // container, and the latter range is preferred. Why? break; } } if (!focusNode) { NS_WARNING("Focused node of selection was not found"); return nullptr; } } } if (focusNode->IsText()) { focusNode = focusNode->GetParentNode(); if (NS_WARN_IF(!focusNode)) { return nullptr; } } if (NS_WARN_IF(!focusNode->IsElement())) { return nullptr; } return focusNode->AsElement(); } NS_IMETHODIMP HTMLEditor::IsAnonymousElement(Element* aElement, bool* aReturn) { if (NS_WARN_IF(!aElement)) { return NS_ERROR_INVALID_ARG; } *aReturn = aElement->IsRootOfNativeAnonymousSubtree(); return NS_OK; } nsresult HTMLEditor::SetReturnInParagraphCreatesNewParagraph( bool aCreatesNewParagraph) { mCRInParagraphCreatesParagraph = aCreatesNewParagraph; return NS_OK; } bool HTMLEditor::GetReturnInParagraphCreatesNewParagraph() const { return mCRInParagraphCreatesParagraph; } nsresult HTMLEditor::GetReturnInParagraphCreatesNewParagraph( bool* aCreatesNewParagraph) { *aCreatesNewParagraph = mCRInParagraphCreatesParagraph; return NS_OK; } NS_IMETHODIMP HTMLEditor::GetWrapWidth(int32_t* aWrapColumn) { if (NS_WARN_IF(!aWrapColumn)) { return NS_ERROR_INVALID_ARG; } *aWrapColumn = WrapWidth(); return NS_OK; } // // See if the style value includes this attribute, and if it does, // cut out everything from the attribute to the next semicolon. // static void CutStyle(const char* stylename, nsString& styleValue) { // Find the current wrapping type: int32_t styleStart = styleValue.LowerCaseFindASCII(stylename); if (styleStart >= 0) { int32_t styleEnd = styleValue.Find(u";", styleStart); if (styleEnd > styleStart) { styleValue.Cut(styleStart, styleEnd - styleStart + 1); } else { styleValue.Cut(styleStart, styleValue.Length() - styleStart); } } } NS_IMETHODIMP HTMLEditor::SetWrapWidth(int32_t aWrapColumn) { AutoEditActionDataSetter editActionData(*this, EditAction::eSetWrapWidth); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } mWrapColumn = aWrapColumn; // Make sure we're a plaintext editor, otherwise we shouldn't // do the rest of this. if (!IsPlaintextMailComposer()) { return NS_OK; } // Ought to set a style sheet here... RefPtr<Element> rootElement = GetRoot(); if (NS_WARN_IF(!rootElement)) { return NS_ERROR_NOT_INITIALIZED; } // Get the current style for this root element: nsAutoString styleValue; rootElement->GetAttr(nsGkAtoms::style, styleValue); // We'll replace styles for these values: CutStyle("white-space", styleValue); CutStyle("width", styleValue); CutStyle("font-family", styleValue); // If we have other style left, trim off any existing semicolons // or white-space, then add a known semicolon-space: if (!styleValue.IsEmpty()) { styleValue.Trim("; \t", false, true); styleValue.AppendLiteral("; "); } // Make sure we have fixed-width font. This should be done for us, // but it isn't, see bug 22502, so we have to add "font: -moz-fixed;". // Only do this if we're wrapping. if (IsWrapHackEnabled() && aWrapColumn >= 0) { styleValue.AppendLiteral("font-family: -moz-fixed; "); } // and now we're ready to set the new white-space/wrapping style. if (aWrapColumn > 0) { // Wrap to a fixed column. styleValue.AppendLiteral("white-space: pre-wrap; width: "); styleValue.AppendInt(aWrapColumn); styleValue.AppendLiteral("ch;"); } else if (!aWrapColumn) { styleValue.AppendLiteral("white-space: pre-wrap;"); } else { styleValue.AppendLiteral("white-space: pre;"); } nsresult rv = rootElement->SetAttr(kNameSpaceID_None, nsGkAtoms::style, styleValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr(nsGkAtoms::style) failed"); return rv; } Element* HTMLEditor::GetFocusedElement() const { nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); if (NS_WARN_IF(!focusManager)) { return nullptr; } Element* const focusedElement = focusManager->GetFocusedElement(); Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return nullptr; } const bool inDesignMode = IsInDesignMode(); if (!focusedElement) { // in designMode, nobody gets focus in most cases. if (inDesignMode && OurWindowHasFocus()) { return document->GetRootElement(); } return nullptr; } if (inDesignMode) { return OurWindowHasFocus() && focusedElement->IsInclusiveDescendantOf(document) ? focusedElement : nullptr; } // We're HTML editor for contenteditable // If the focused content isn't editable, or it has independent selection, // we don't have focus. if (!focusedElement->HasFlag(NODE_IS_EDITABLE) || focusedElement->HasIndependentSelection()) { return nullptr; } // If our window is focused, we're focused. return OurWindowHasFocus() ? focusedElement : nullptr; } bool HTMLEditor::IsActiveInDOMWindow() const { nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); if (NS_WARN_IF(!focusManager)) { return false; } Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return false; } const bool inDesignMode = IsInDesignMode(); // If we're in designMode, we're always active in the DOM window. if (inDesignMode) { return true; } nsPIDOMWindowOuter* ourWindow = document->GetWindow(); nsCOMPtr<nsPIDOMWindowOuter> win; nsIContent* content = nsFocusManager::GetFocusedDescendant( ourWindow, nsFocusManager::eOnlyCurrentWindow, getter_AddRefs(win)); if (!content) { return false; } // We're HTML editor for contenteditable // If the active content isn't editable, or it has independent selection, // we're not active). if (!content->HasFlag(NODE_IS_EDITABLE) || content->HasIndependentSelection()) { return false; } return true; } Element* HTMLEditor::ComputeEditingHostInternal( const nsIContent* aContent, LimitInBodyElement aLimitInBodyElement) const { Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return nullptr; } auto MaybeLimitInBodyElement = [&](const Element* aCandidiateEditingHost) -> Element* { if (!aCandidiateEditingHost) { return nullptr; } if (aLimitInBodyElement != LimitInBodyElement::Yes) { return const_cast<Element*>(aCandidiateEditingHost); } // By default, we should limit editing host to the <body> element for // avoiding deleting or creating unexpected elements outside the <body>. // However, this is incompatible with Chrome so that we should stop // doing this with adding safety checks more. if (document->GetBodyElement() && nsContentUtils::ContentIsFlattenedTreeDescendantOf( aCandidiateEditingHost, document->GetBodyElement())) { return const_cast<Element*>(aCandidiateEditingHost); } // XXX If aContent is an editing host and has no parent node, we reach here, // but returing the <body> which is not connected to aContent is odd. return document->GetBodyElement(); }; if (IsInDesignMode()) { // TODO: In this case, we need to compute editing host from aContent or the // focus node of selection, and it may be in an editing host in a // shadow DOM tree etc. We need to do more complicated things. // See also InDesignMode(). return document->GetBodyElement(); } // We're HTML editor for contenteditable AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return nullptr; } const nsIContent* const content = aContent ? aContent : nsIContent::FromNodeOrNull(SelectionRef().GetFocusNode()); if (NS_WARN_IF(!content)) { return nullptr; } // If the active content isn't editable, we're not active. if (!content->HasFlag(NODE_IS_EDITABLE)) { return nullptr; } // Although the content shouldn't be in a native anonymous subtree, but // perhaps due to a bug of Selection or Range API, it may occur. HTMLEditor // shouldn't touch native anonymous subtree so that return nullptr in such // case. if (MOZ_UNLIKELY(content->IsInNativeAnonymousSubtree())) { return nullptr; } // Note that `Selection` can be in <input> or <textarea>. In the case, we // need to look for an ancestor which does not have editable parent. return MaybeLimitInBodyElement( const_cast<nsIContent*>(content)->GetEditingHost()); } void HTMLEditor::NotifyEditingHostMaybeChanged() { // Note that even if the document is in design mode, a contenteditable element // in a shadow tree is focusable. Therefore, we may need to update editing // host even when the document is in design mode. if (MOZ_UNLIKELY(NS_WARN_IF(!GetDocument()))) { return; } // We're HTML editor for contenteditable AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } // Get selection ancestor limit which may be old editing host. nsIContent* ancestorLimiter = SelectionRef().GetAncestorLimiter(); if (!ancestorLimiter) { // If we've not initialized selection ancestor limit, we should wait focus // event to set proper limiter. return; } // Compute current editing host. nsIContent* editingHost = ComputeEditingHost(); if (NS_WARN_IF(!editingHost)) { return; } // Update selection ancestor limit if current editing host includes the // previous editing host. // Additionally, the editing host may be an element in shadow DOM and the // shadow host is in designMode. In this case, we need to set the editing // host as the new selection limiter. if (ancestorLimiter->IsInclusiveDescendantOf(editingHost) || (ancestorLimiter->IsInDesignMode() != editingHost->IsInDesignMode())) { // Note that don't call HTMLEditor::InitializeSelectionAncestorLimit() // here because it may collapse selection to the first editable node. EditorBase::InitializeSelectionAncestorLimit(*editingHost); } } EventTarget* HTMLEditor::GetDOMEventTarget() const { // Don't use getDocument here, because we have no way of knowing // whether Init() was ever called. So we need to get the document // ourselves, if it exists. Document* doc = GetDocument(); MOZ_ASSERT(doc, "The HTMLEditor has not been initialized yet"); if (!doc) { return nullptr; } // Register the EditorEventListener to the parent of window. // // The advantage of this approach is HTMLEditor can still // receive events when shadow dom is involved. if (nsPIDOMWindowOuter* win = doc->GetWindow()) { return win->GetParentTarget(); } return nullptr; } bool HTMLEditor::ShouldReplaceRootElement() const { if (!mRootElement) { // If we don't know what is our root element, we should find our root. return true; } // If we temporary set document root element to mRootElement, but there is // body element now, we should replace the root element by the body element. return mRootElement != GetBodyElement(); } void HTMLEditor::NotifyRootChanged() { MOZ_ASSERT(mPendingRootElementUpdatedRunner, "HTMLEditor::NotifyRootChanged() should be called via a runner"); mPendingRootElementUpdatedRunner = nullptr; nsCOMPtr<nsIMutationObserver> kungFuDeathGrip(this); AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } RemoveEventListeners(); nsresult rv = InstallEventListeners(); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::InstallEventListeners() failed, but ignored"); return; } UpdateRootElement(); if (!mRootElement) { return; } rv = MaybeCollapseSelectionAtFirstEditableNode(false); if (NS_FAILED(rv)) { NS_WARNING( "HTMLEditor::MaybeCollapseSelectionAtFirstEditableNode(false) " "failed, " "but ignored"); return; } // When this editor has focus, we need to reset the selection limiter to // new root. Otherwise, that is going to be done when this gets focus. nsCOMPtr<nsINode> node = GetFocusedNode(); if (node) { DebugOnly<nsresult> rvIgnored = InitializeSelection(*node); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "EditorBase::InitializeSelection() failed, but ignored"); } SyncRealTimeSpell(); } Element* HTMLEditor::GetBodyElement() const { Document* document = GetDocument(); MOZ_ASSERT(document, "The HTMLEditor hasn't been initialized yet"); if (NS_WARN_IF(!document)) { return nullptr; } return document->GetBody(); } nsINode* HTMLEditor::GetFocusedNode() const { Element* focusedElement = GetFocusedElement(); if (!focusedElement) { return nullptr; } // focusedElement might be non-null even focusManager->GetFocusedElement() // is null. That's the designMode case, and in that case our // FocusedContent() returns the root element, but we want to return // the document. nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); NS_ASSERTION(focusManager, "Focus manager is null"); if ((focusedElement = focusManager->GetFocusedElement())) { return focusedElement; } return GetDocument(); } bool HTMLEditor::OurWindowHasFocus() const { nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); if (NS_WARN_IF(!focusManager)) { return false; } nsPIDOMWindowOuter* focusedWindow = focusManager->GetFocusedWindow(); if (!focusedWindow) { return false; } Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return false; } nsPIDOMWindowOuter* ourWindow = document->GetWindow(); return ourWindow == focusedWindow; } bool HTMLEditor::IsAcceptableInputEvent(WidgetGUIEvent* aGUIEvent) const { if (!EditorBase::IsAcceptableInputEvent(aGUIEvent)) { return false; } // While there is composition, all composition events in its top level // window are always fired on the composing editor. Therefore, if this // editor has composition, the composition events should be handled in this // editor. if (mComposition && aGUIEvent->AsCompositionEvent()) { return true; } nsCOMPtr<nsINode> eventTargetNode = nsINode::FromEventTargetOrNull(aGUIEvent->GetOriginalDOMEventTarget()); if (NS_WARN_IF(!eventTargetNode)) { return false; } if (eventTargetNode->IsContent()) { eventTargetNode = eventTargetNode->AsContent()->FindFirstNonChromeOnlyAccessContent(); if (NS_WARN_IF(!eventTargetNode)) { return false; } } RefPtr<Document> document = GetDocument(); if (NS_WARN_IF(!document)) { return false; } if (IsInDesignMode()) { // If this editor is in designMode and the event target is the document, // the event is for this editor. if (eventTargetNode->IsDocument()) { return eventTargetNode == document; } // Otherwise, check whether the event target is in this document or not. if (NS_WARN_IF(!eventTargetNode->IsContent())) { return false; } if (document == eventTargetNode->GetUncomposedDoc()) { return true; } // If the event target is in a shadow tree, the content is not editable // by default, but if the focused content is an editing host, we need to // handle it as contenteditable mode. if (!eventTargetNode->IsInShadowTree()) { return false; } } // Space event for <button> and <summary> with contenteditable // should be handle by the themselves. if (aGUIEvent->mMessage == eKeyPress && aGUIEvent->AsKeyboardEvent()->ShouldWorkAsSpaceKey()) { nsGenericHTMLElement* element = HTMLButtonElement::FromNode(eventTargetNode); if (!element) { element = HTMLSummaryElement::FromNode(eventTargetNode); } if (element && element->IsContentEditable()) { return false; } } // This HTML editor is for contenteditable. We need to check the validity // of the target. if (NS_WARN_IF(!eventTargetNode->IsContent())) { return false; } // If the event is a mouse event, we need to check if the target content is // the focused editing host or its descendant. if (aGUIEvent->AsMouseEventBase()) { nsIContent* editingHost = ComputeEditingHost(); // If there is no active editing host, we cannot handle the mouse event // correctly. if (!editingHost) { return false; } // If clicked on non-editable root element but the body element is the // active editing host, we should assume that the click event is // targetted. if (eventTargetNode == document->GetRootElement() && !eventTargetNode->HasFlag(NODE_IS_EDITABLE) && editingHost == document->GetBodyElement()) { eventTargetNode = editingHost; } // If the target element is neither the active editing host nor a // descendant of it, we may not be able to handle the event. if (!eventTargetNode->IsInclusiveDescendantOf(editingHost)) { return false; } // If the clicked element has an independent selection, we shouldn't // handle this click event. if (eventTargetNode->AsContent()->HasIndependentSelection()) { return false; } // If the target content is editable, we should handle this event. return eventTargetNode->HasFlag(NODE_IS_EDITABLE); } // If the target of the other events which target focused element isn't // editable or has an independent selection, this editor shouldn't handle // the event. if (!eventTargetNode->HasFlag(NODE_IS_EDITABLE) || eventTargetNode->AsContent()->HasIndependentSelection()) { return false; } // Finally, check whether we're actually focused or not. When we're not // focused, we should ignore the dispatched event by script (or something) // because content editable element needs selection in itself for editing. // However, when we're not focused, it's not guaranteed. return IsActiveInDOMWindow(); } nsresult HTMLEditor::GetPreferredIMEState(IMEState* aState) { // HTML editor don't prefer the CSS ime-mode because IE didn't do so too. aState->mOpen = IMEState::DONT_CHANGE_OPEN_STATE; if (IsReadonly()) { aState->mEnabled = IMEEnabled::Disabled; } else { aState->mEnabled = IMEEnabled::Enabled; } return NS_OK; } already_AddRefed<Element> HTMLEditor::GetInputEventTargetElement() const { RefPtr<Element> target = ComputeEditingHost(LimitInBodyElement::No); if (target) { return target.forget(); } // When there is no active editing host due to focus node is a // non-editable node, we should look for its editable parent to // dispatch `beforeinput` event. nsIContent* focusContent = nsIContent::FromNodeOrNull(SelectionRef().GetFocusNode()); if (!focusContent || focusContent->IsEditable()) { return nullptr; } for (Element* element : focusContent->AncestorsOfType<Element>()) { if (element->IsEditable()) { target = element->GetEditingHost(); return target.forget(); } } return nullptr; } nsresult HTMLEditor::OnModifyDocument() { MOZ_ASSERT(mPendingDocumentModifiedRunner, "HTMLEditor::OnModifyDocument() should be called via a runner"); mPendingDocumentModifiedRunner = nullptr; if (IsEditActionDataAvailable()) { return OnModifyDocumentInternal(); } AutoEditActionDataSetter editActionData( *this, EditAction::eCreatePaddingBRElementForEmptyEditor); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_AVAILABLE; } nsresult rv = OnModifyDocumentInternal(); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::OnModifyDocumentInternal() failed"); return rv; } nsresult HTMLEditor::OnModifyDocumentInternal() { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(!mPendingDocumentModifiedRunner); // EnsureNoPaddingBRElementForEmptyEditor() below may cause a flush, which // could destroy the editor nsAutoScriptBlockerSuppressNodeRemoved scriptBlocker; // Delete our padding <br> element for empty editor, if we have one, since // the document might not be empty any more. nsresult rv = EnsureNoPaddingBRElementForEmptyEditor(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return rv; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::EnsureNoPaddingBRElementForEmptyEditor() " "failed, but ignored"); // Try to recreate the padding <br> element for empty editor if needed. rv = MaybeCreatePaddingBRElementForEmptyEditor(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::MaybeCreatePaddingBRElementForEmptyEditor() failed"); return rv; } } // namespace mozilla: or
with different type of element, we need to // split the parent
. OwningNonNull containerElementToDelete = aOldContainer; if (aOldContainer.IsAnyOfHTMLElements(nsGkAtoms::dd, nsGkAtoms::dt) && &aTagName != nsGkAtoms::dt && &aTagName != nsGkAtoms::dd && // aOldContainer always has a parent node because of removable. aOldContainer.GetParentNode()->IsHTMLElement(nsGkAtoms::dl)) { OwningNonNull const dlElement = *aOldContainer.GetParentElement(); if (NS_WARN_IF(!HTMLEditUtils::IsRemovableNode(dlElement)) || NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode(dlElement))) { return Err(NS_ERROR_FAILURE); } Result splitDLElementResult = SplitRangeOffFromElement(dlElement, aOldContainer, aOldContainer); if (MOZ_UNLIKELY(splitDLElementResult.isErr())) { NS_WARNING("HTMLEditor::SplitRangeOffFromElement() failed"); return splitDLElementResult.propagateErr(); } splitDLElementResult.inspect().IgnoreCaretPointSuggestion(); RefPtr middleDLElement = aOldContainer.GetParentElement(); if (NS_WARN_IF(!middleDLElement) || NS_WARN_IF(!middleDLElement->IsHTMLElement(nsGkAtoms::dl)) || NS_WARN_IF(!HTMLEditUtils::IsRemovableNode(*middleDLElement))) { NS_WARNING("The parent
was lost at splitting it"); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } containerElementToDelete = std::move(middleDLElement); } const RefPtr newContainer = CreateHTMLContent(&aTagName); if (NS_WARN_IF(!newContainer)) { return Err(NS_ERROR_FAILURE); } // Set or clone attribute if needed. // FIXME: What should we do attributes of
elements if we removed it // above? if (aCloneAllAttributes) { MOZ_ASSERT(&aAttribute == nsGkAtoms::_empty); CloneAttributesWithTransaction(*newContainer, aOldContainer); } else if (&aAttribute != nsGkAtoms::_empty) { nsresult rv = newContainer->SetAttr(kNameSpaceID_None, const_cast(&aAttribute), aAttributeValue, true); if (NS_FAILED(rv)) { NS_WARNING("Element::SetAttr() failed"); return Err(NS_ERROR_FAILURE); } } const OwningNonNull parentNode = *containerElementToDelete->GetParentNode(); const nsCOMPtr referenceNode = containerElementToDelete->GetNextSibling(); AutoReplaceContainerSelNotify selStateNotify(RangeUpdaterRef(), aOldContainer, *newContainer); { AutoTArray, 32> arrayOfChildren; HTMLEditUtils::CollectChildren( aOldContainer, arrayOfChildren, 0u, // Move non-editable children too because its container, aElement, is // editable so that all children must be removable node. {}); // TODO: Remove AutoTransactionsConserveSelection here. It's not necessary // in normal cases. However, it may be required for nested edit // actions which may be caused by legacy mutation event listeners or // chrome script. AutoTransactionsConserveSelection conserveSelection(*this); // Move all children from the old container to the new container. // For making all MoveNodeTransactions have a reference node in the current // parent, move nodes from last one to preceding ones. for (const OwningNonNull& child : Reversed(arrayOfChildren)) { Result moveChildResult = MoveNodeWithTransaction(MOZ_KnownLive(child), // due to bug 1622253. EditorDOMPoint(newContainer, 0u)); if (MOZ_UNLIKELY(moveChildResult.isErr())) { NS_WARNING("HTMLEditor::MoveNodeWithTransaction() failed"); return moveChildResult.propagateErr(); } // We'll suggest new caret point which is suggested by new container // element insertion result. Therefore, we need to do nothing here. moveChildResult.inspect().IgnoreCaretPointSuggestion(); } } // Delete containerElementToDelete from the DOM tree to make it not referred // by InsertNodeTransaction. nsresult rv = DeleteNodeWithTransaction(containerElementToDelete); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteNodeWithTransaction() failed"); return Err(rv); } if (referenceNode && (!referenceNode->GetParentNode() || parentNode != referenceNode->GetParentNode())) { NS_WARNING( "The reference node for insertion has been moved to different parent, " "so we got lost the insertion point"); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } // Finally, insert the new node to where probably aOldContainer was. Result insertNewContainerElementResult = InsertNodeWithTransaction( *newContainer, referenceNode ? EditorDOMPoint(referenceNode) : EditorDOMPoint::AtEndOf(*parentNode)); NS_WARNING_ASSERTION(insertNewContainerElementResult.isOk(), "EditorBase::InsertNodeWithTransaction() failed"); MOZ_ASSERT_IF( insertNewContainerElementResult.isOk(), insertNewContainerElementResult.inspect().GetNewNode() == newContainer); return insertNewContainerElementResult; } Result HTMLEditor::RemoveContainerWithTransaction( Element& aElement) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!HTMLEditUtils::IsRemovableNode(aElement)) || NS_WARN_IF(!HTMLEditUtils::IsSimplyEditableNode(aElement))) { return Err(NS_ERROR_FAILURE); } // Notify our internal selection state listener. AutoRemoveContainerSelNotify selNotify(RangeUpdaterRef(), EditorRawDOMPoint(&aElement)); AutoTArray, 32> arrayOfChildren; HTMLEditUtils::CollectChildren( aElement, arrayOfChildren, 0u, // Move non-editable children too because its container, aElement, is // editable so that all children must be removable node. {}); const OwningNonNull parentNode = *aElement.GetParentNode(); nsCOMPtr previousChild = aElement.GetPreviousSibling(); // For making all MoveNodeTransactions have a referenc node in the current // parent, move nodes from last one to preceding ones. for (const OwningNonNull& child : Reversed(arrayOfChildren)) { if (MOZ_UNLIKELY(!HTMLEditUtils::IsRemovableNode(child))) { continue; } Result moveChildResult = MoveNodeWithTransaction( MOZ_KnownLive(child), // due to bug 1622253. previousChild ? EditorDOMPoint::After(previousChild) : EditorDOMPoint(parentNode, 0u)); if (MOZ_UNLIKELY(moveChildResult.isErr())) { NS_WARNING("HTMLEditor::MoveNodeWithTransaction() failed"); return moveChildResult.propagateErr(); } // If the reference node was moved to different container, try to recover // the original position. if (previousChild && MOZ_UNLIKELY(previousChild->GetParentNode() != parentNode)) { if (MOZ_UNLIKELY(child->GetParentNode() != parentNode)) { NS_WARNING( "Neither the reference (previous) sibling nor the moved child was " "in the expected parent node"); moveChildResult.inspect().IgnoreCaretPointSuggestion(); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } previousChild = child->GetPreviousSibling(); } // We'll need to put caret at next sibling of aElement if nobody moves // content nodes under the parent node except us. moveChildResult.inspect().IgnoreCaretPointSuggestion(); } if (aElement.GetParentNode() && aElement.GetParentNode() != parentNode) { NS_WARNING( "The removing element has already been moved to another element"); return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } NS_WARNING_ASSERTION(!aElement.GetFirstChild(), "The removing container still has some children, but " "they are removed by removing the container"); auto GetNextSiblingOf = [](const nsTArray>& aArrayOfMovedContent, const nsINode& aExpectedParentNode) -> nsIContent* { for (const OwningNonNull& movedChild : Reversed(aArrayOfMovedContent)) { if (movedChild != &aExpectedParentNode) { continue; // Ignore moved node which was moved to different place } return movedChild->GetNextSibling(); } // XXX If all nodes were moved by web apps, we cannot suggest "collect" // position without computing the index of aElement. However, I // don't think that it's necessary for the web apps in the wild. return nullptr; }; nsCOMPtr nextSibling = aElement.GetParentNode() ? aElement.GetNextSibling() : GetNextSiblingOf(arrayOfChildren, *parentNode); nsresult rv = DeleteNodeWithTransaction(aElement); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::DeleteNodeTransaction() failed"); return Err(rv); } if (nextSibling && nextSibling->GetParentNode() != parentNode) { nextSibling = GetNextSiblingOf(arrayOfChildren, *parentNode); } return nextSibling ? EditorDOMPoint(nextSibling) : EditorDOMPoint::AtEndOf(*parentNode); } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::ContentAppended( nsIContent* aFirstNewContent) { DoContentInserted(aFirstNewContent, ContentNodeIs::Appended); } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::ContentInserted( nsIContent* aChild) { DoContentInserted(aChild, ContentNodeIs::Inserted); } bool HTMLEditor::IsInObservedSubtree(nsIContent* aChild) { if (!aChild) { return false; } // FIXME(emilio, bug 1596856): This should probably work if the root is in the // same shadow tree as the child, probably? I don't know what the // contenteditable-in-shadow-dom situation is. if (Element* root = GetRoot()) { // To be super safe here, check both ChromeOnlyAccess and NAC / Shadow DOM. // That catches (also unbound) native anonymous content and ShadowDOM. if (root->ChromeOnlyAccess() != aChild->ChromeOnlyAccess() || root->IsInNativeAnonymousSubtree() != aChild->IsInNativeAnonymousSubtree() || root->IsInShadowTree() != aChild->IsInShadowTree()) { return false; } } return !aChild->ChromeOnlyAccess() && !aChild->IsInShadowTree() && !aChild->IsInNativeAnonymousSubtree(); } void HTMLEditor::DoContentInserted(nsIContent* aChild, ContentNodeIs aContentNodeIs) { MOZ_ASSERT(aChild); nsINode* container = aChild->GetParentNode(); MOZ_ASSERT(container); if (!IsInObservedSubtree(aChild)) { return; } // XXX Why do we need this? This method is a helper of mutation observer. // So, the callers of mutation observer should guarantee that this won't // be deleted at least during the call. RefPtr kungFuDeathGrip(this); AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } if (ShouldReplaceRootElement()) { UpdateRootElement(); if (mPendingRootElementUpdatedRunner) { return; } mPendingRootElementUpdatedRunner = NewRunnableMethod( "HTMLEditor::NotifyRootChanged", this, &HTMLEditor::NotifyRootChanged); nsContentUtils::AddScriptRunner( do_AddRef(mPendingRootElementUpdatedRunner)); return; } // We don't need to handle our own modifications if (!GetTopLevelEditSubAction() && container->IsEditable()) { if (EditorUtils::IsPaddingBRElementForEmptyEditor(*aChild)) { // Ignore insertion of the padding
element. return; } nsresult rv = OnDocumentModified(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::OnDocumentModified() failed, but ignored"); // Update spellcheck for only the newly-inserted node (bug 743819) if (mInlineSpellChecker) { nsIContent* endContent = aChild; if (aContentNodeIs == ContentNodeIs::Appended) { nsIContent* child = nullptr; for (child = aChild; child; child = child->GetNextSibling()) { if (child->InclusiveDescendantMayNeedSpellchecking(this)) { break; } } if (!child) { // No child needed spellchecking, return. return; } // Maybe more than 1 child was appended. endContent = container->GetLastChild(); } else if (!aChild->InclusiveDescendantMayNeedSpellchecking(this)) { return; } RefPtr range = nsRange::Create(aChild); range->SelectNodesInContainer(container, aChild, endContent); DebugOnly rvIgnored = mInlineSpellChecker->SpellCheckRange(range); NS_WARNING_ASSERTION( rvIgnored == NS_ERROR_NOT_INITIALIZED || NS_SUCCEEDED(rvIgnored), "mozInlineSpellChecker::SpellCheckRange() failed, but ignored"); } } } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::ContentRemoved( nsIContent* aChild, nsIContent* aPreviousSibling) { if (!IsInObservedSubtree(aChild)) { return; } // XXX Why do we need to do this? This method is a mutation observer's // method. Therefore, the caller should guarantee that this won't be // deleted during the call. RefPtr kungFuDeathGrip(this); AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } if (SameCOMIdentity(aChild, mRootElement)) { mRootElement = nullptr; if (mPendingRootElementUpdatedRunner) { return; } mPendingRootElementUpdatedRunner = NewRunnableMethod( "HTMLEditor::NotifyRootChanged", this, &HTMLEditor::NotifyRootChanged); nsContentUtils::AddScriptRunner( do_AddRef(mPendingRootElementUpdatedRunner)); return; } // We don't need to handle our own modifications if (!GetTopLevelEditSubAction() && aChild->GetParentNode()->IsEditable()) { if (aChild && EditorUtils::IsPaddingBRElementForEmptyEditor(*aChild)) { // Ignore removal of the padding
element for empty editor. return; } nsresult rv = OnDocumentModified(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::OnDocumentModified() failed, but ignored"); } } MOZ_CAN_RUN_SCRIPT_BOUNDARY void HTMLEditor::CharacterDataChanged( nsIContent* aContent, const CharacterDataChangeInfo& aInfo) { if (!mInlineSpellChecker || !aContent->IsEditable() || !IsInObservedSubtree(aContent) || GetTopLevelEditSubAction() != EditSubAction::eNone) { return; } nsIContent* parent = aContent->GetParent(); if (!parent || !parent->InclusiveDescendantMayNeedSpellchecking(this)) { return; } RefPtr range = nsRange::Create(aContent); range->SelectNodesInContainer(parent, aContent, aContent); DebugOnly rvIgnored = mInlineSpellChecker->SpellCheckRange(range); } nsresult HTMLEditor::SelectEntireDocument() { MOZ_ASSERT(IsEditActionDataAvailable()); if (!mInitSucceeded) { return NS_ERROR_NOT_INITIALIZED; } // XXX It's odd to select all of the document body if an contenteditable // element has focus. RefPtr bodyOrDocumentElement = GetRoot(); if (NS_WARN_IF(!bodyOrDocumentElement)) { return NS_ERROR_NOT_INITIALIZED; } // If we're empty, don't select all children because that would select the // padding
element for empty editor. if (IsEmpty()) { nsresult rv = CollapseSelectionToStartOf(*bodyOrDocumentElement); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionToStartOf() failed"); return rv; } // Otherwise, select all children. ErrorResult error; SelectionRef().SelectAllChildren(*bodyOrDocumentElement, error); if (NS_WARN_IF(Destroyed())) { error.SuppressException(); return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(!error.Failed(), "Selection::SelectAllChildren() failed"); return error.StealNSResult(); } nsresult HTMLEditor::SelectAllInternal() { MOZ_ASSERT(IsEditActionDataAvailable()); CommitComposition(); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } auto GetBodyElementIfElementIsParentOfHTMLBody = [](const Element& aElement) -> Element* { if (!aElement.OwnerDoc()->IsHTMLDocument()) { return const_cast(&aElement); } HTMLBodyElement* bodyElement = aElement.OwnerDoc()->GetBodyElement(); return bodyElement && nsContentUtils::ContentIsFlattenedTreeDescendantOf( bodyElement, &aElement) ? bodyElement : const_cast(&aElement); }; nsCOMPtr selectionRootContent = [&]() MOZ_CAN_RUN_SCRIPT -> nsIContent* { RefPtr elementToBeSelected = [&]() -> Element* { // If there is at least one selection range, we should compute the // selection root from the anchor node. if (SelectionRef().RangeCount()) { if (nsIContent* content = nsIContent::FromNodeOrNull(SelectionRef().GetAnchorNode())) { if (content->IsElement()) { return content->AsElement(); } if (Element* parentElement = content->GetParentElementCrossingShadowRoot()) { return parentElement; } } } // If no element contains a selection range, we should select all children // of the focused element at least. if (Element* focusedElement = GetFocusedElement()) { return focusedElement; } // of the body or document element. Element* bodyOrDocumentElement = GetRoot(); NS_WARNING_ASSERTION(bodyOrDocumentElement, "There was no element in the document"); return bodyOrDocumentElement; }(); // If the element to be selected is or , // GetSelectionRootContent() returns its anonymous <div> element, but we // want to select all of the document or selection limiter. Therefore, // we should use its parent to compute the selection root. if (elementToBeSelected->HasIndependentSelection()) { Element* parentElement = elementToBeSelected->GetParentElement(); if (MOZ_LIKELY(parentElement)) { elementToBeSelected = parentElement; } } // Then, compute the selection root content to select all including // elementToBeSelected. RefPtr<PresShell> presShell = GetPresShell(); nsIContent* computedSelectionRootContent = elementToBeSelected->GetSelectionRootContent(presShell); if (NS_WARN_IF(!computedSelectionRootContent)) { return nullptr; } if (MOZ_UNLIKELY(!computedSelectionRootContent->IsElement())) { return computedSelectionRootContent; } return GetBodyElementIfElementIsParentOfHTMLBody( *computedSelectionRootContent->AsElement()); }(); if (NS_WARN_IF(!selectionRootContent)) { return NS_ERROR_FAILURE; } Maybe<Selection::AutoUserInitiated> userSelection; // XXX Do we need to mark it as "user initiated" for // `Document.execCommand("selectAll")`? if (!selectionRootContent->IsEditable()) { userSelection.emplace(SelectionRef()); } ErrorResult error; SelectionRef().SelectAllChildren(*selectionRootContent, error); NS_WARNING_ASSERTION(!error.Failed(), "Selection::SelectAllChildren() failed"); return error.StealNSResult(); } bool HTMLEditor::SetCaretInTableCell(Element* aElement) { MOZ_ASSERT(IsEditActionDataAvailable()); if (!aElement || !aElement->IsHTMLElement() || !HTMLEditUtils::IsAnyTableElement(aElement)) { return false; } const RefPtr<Element> editingHost = ComputeEditingHost(); if (!editingHost || !aElement->IsInclusiveDescendantOf(editingHost)) { return false; } nsCOMPtr<nsIContent> deepestFirstChild = aElement; while (deepestFirstChild->HasChildren()) { deepestFirstChild = deepestFirstChild->GetFirstChild(); } // Set selection at beginning of the found node nsresult rv = CollapseSelectionToStartOf(*deepestFirstChild); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionToStartOf() failed"); return NS_SUCCEEDED(rv); } /** * This method scans the selection for adjacent text nodes * and collapses them into a single text node. * "adjacent" means literally adjacent siblings of the same parent. * Uses HTMLEditor::JoinNodesWithTransaction() so action is undoable. * Should be called within the context of a batch transaction. */ nsresult HTMLEditor::CollapseAdjacentTextNodes(nsRange& aInRange) { AutoTransactionsConserveSelection dontChangeMySelection(*this); // we can't actually do anything during iteration, so store the text nodes in // an array first. DOMSubtreeIterator subtreeIter; if (NS_FAILED(subtreeIter.Init(aInRange))) { NS_WARNING("DOMSubtreeIterator::Init() failed"); return NS_ERROR_FAILURE; } AutoTArray<OwningNonNull<Text>, 8> textNodes; subtreeIter.AppendNodesToArray( +[](nsINode& aNode, void*) -> bool { return EditorUtils::IsEditableContent(*aNode.AsText(), EditorType::HTML); }, textNodes); // now that I have a list of text nodes, collapse adjacent text nodes while (textNodes.Length() > 1u) { OwningNonNull<Text>& leftTextNode = textNodes[0u]; OwningNonNull<Text>& rightTextNode = textNodes[1u]; // If the text nodes are not direct siblings, we shouldn't join them, and // we don't need to handle the left one anymore. if (rightTextNode->GetPreviousSibling() != leftTextNode) { textNodes.RemoveElementAt(0u); continue; } Result<JoinNodesResult, nsresult> joinNodesResult = JoinNodesWithTransaction(MOZ_KnownLive(*leftTextNode), MOZ_KnownLive(*rightTextNode)); if (MOZ_UNLIKELY(joinNodesResult.isErr())) { NS_WARNING("HTMLEditor::JoinNodesWithTransaction() failed"); return joinNodesResult.unwrapErr(); } if (MOZ_LIKELY(joinNodesResult.inspect().RemovedContent() == leftTextNode)) { textNodes.RemoveElementAt(0u); } else if (MOZ_LIKELY(joinNodesResult.inspect().RemovedContent() == rightTextNode)) { textNodes.RemoveElementAt(1u); } else { MOZ_ASSERT_UNREACHABLE( "HTMLEditor::JoinNodesWithTransaction() removed unexpected node"); return NS_ERROR_UNEXPECTED; } } return NS_OK; } nsresult HTMLEditor::SetSelectionAtDocumentStart() { MOZ_ASSERT(IsEditActionDataAvailable()); RefPtr<Element> rootElement = GetRoot(); if (NS_WARN_IF(!rootElement)) { return NS_ERROR_FAILURE; } nsresult rv = CollapseSelectionToStartOf(*rootElement); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionToStartOf() failed"); return rv; } /** * Remove aNode, reparenting any children into the parent of aNode. In * addition, insert any br's needed to preserve identity of removed block. */ Result<EditorDOMPoint, nsresult> HTMLEditor::RemoveBlockContainerWithTransaction(Element& aElement) { MOZ_ASSERT(IsEditActionDataAvailable()); // Two possibilities: the container could be empty of editable content. If // that is the case, we need to compare what is before and after aNode to // determine if we need a br. // // Or it could be not empty, in which case we have to compare previous // sibling and first child to determine if we need a leading br, and compare // following sibling and last child to determine if we need a trailing br. EditorDOMPoint pointToPutCaret; if (nsCOMPtr<nsIContent> child = HTMLEditUtils::GetFirstChild( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { // The case of aNode not being empty. We need a br at start unless: // 1) previous sibling of aNode is a block, OR // 2) previous sibling of aNode is a br, OR // 3) first child of aNode is a block OR // 4) either is null if (nsIContent* previousSibling = HTMLEditUtils::GetPreviousSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { if (!HTMLEditUtils::IsBlockElement( *previousSibling, BlockInlineCheck::UseComputedDisplayOutsideStyle) && !previousSibling->IsHTMLElement(nsGkAtoms::br) && !HTMLEditUtils::IsBlockElement( *child, BlockInlineCheck::UseComputedDisplayOutsideStyle)) { // Insert br node Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement(WithTransaction::Yes, EditorDOMPoint(&aElement, 0u)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } CreateElementResult unwrappedInsertBRElementResult = insertBRElementResult.unwrap(); unwrappedInsertBRElementResult.MoveCaretPointTo( pointToPutCaret, {SuggestCaret::OnlyIfHasSuggestion}); MOZ_ASSERT(unwrappedInsertBRElementResult.GetNewNode()); } } // We need a br at end unless: // 1) following sibling of aNode is a block, OR // 2) last child of aNode is a block, OR // 3) last child of aNode is a br OR // 4) either is null if (nsIContent* nextSibling = HTMLEditUtils::GetNextSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { if (nextSibling && !HTMLEditUtils::IsBlockElement( *nextSibling, BlockInlineCheck::UseComputedDisplayStyle)) { if (nsIContent* lastChild = HTMLEditUtils::GetLastChild( aElement, {WalkTreeOption::IgnoreNonEditableNode}, BlockInlineCheck::Unused)) { if (!HTMLEditUtils::IsBlockElement( *lastChild, BlockInlineCheck::UseComputedDisplayStyle) && !lastChild->IsHTMLElement(nsGkAtoms::br)) { Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement(WithTransaction::Yes, EditorDOMPoint::AtEndOf(aElement)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } CreateElementResult unwrappedInsertBRElementResult = insertBRElementResult.unwrap(); unwrappedInsertBRElementResult.MoveCaretPointTo( pointToPutCaret, {SuggestCaret::OnlyIfHasSuggestion}); MOZ_ASSERT(unwrappedInsertBRElementResult.GetNewNode()); } } } } } else if (nsIContent* previousSibling = HTMLEditUtils::GetPreviousSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { // The case of aNode being empty. We need a br at start unless: // 1) previous sibling of aNode is a block, OR // 2) previous sibling of aNode is a br, OR // 3) following sibling of aNode is a block, OR // 4) following sibling of aNode is a br OR // 5) either is null if (!HTMLEditUtils::IsBlockElement( *previousSibling, BlockInlineCheck::UseComputedDisplayStyle) && !previousSibling->IsHTMLElement(nsGkAtoms::br)) { if (nsIContent* nextSibling = HTMLEditUtils::GetNextSibling( aElement, {WalkTreeOption::IgnoreNonEditableNode})) { if (!HTMLEditUtils::IsBlockElement( *nextSibling, BlockInlineCheck::UseComputedDisplayStyle) && !nextSibling->IsHTMLElement(nsGkAtoms::br)) { Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement(WithTransaction::Yes, EditorDOMPoint(&aElement, 0u)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING( "HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } CreateElementResult unwrappedInsertBRElementResult = insertBRElementResult.unwrap(); unwrappedInsertBRElementResult.MoveCaretPointTo( pointToPutCaret, {SuggestCaret::OnlyIfHasSuggestion}); MOZ_ASSERT(unwrappedInsertBRElementResult.GetNewNode()); } } } } // Now remove container Result<EditorDOMPoint, nsresult> unwrapBlockElementResult = RemoveContainerWithTransaction(aElement); if (MOZ_UNLIKELY(unwrapBlockElementResult.isErr())) { NS_WARNING("HTMLEditor::RemoveContainerWithTransaction() failed"); return unwrapBlockElementResult; } if (AllowsTransactionsToChangeSelection() && unwrapBlockElementResult.inspect().IsSet()) { pointToPutCaret = unwrapBlockElementResult.unwrap(); } return pointToPutCaret; // May be unset } Result<SplitNodeResult, nsresult> HTMLEditor::SplitNodeWithTransaction( const EditorDOMPoint& aStartOfRightNode) { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!aStartOfRightNode.IsInContentNode())) { return Err(NS_ERROR_INVALID_ARG); } MOZ_ASSERT(aStartOfRightNode.IsSetAndValid()); if (NS_WARN_IF(!HTMLEditUtils::IsSplittableNode( *aStartOfRightNode.ContainerAs<nsIContent>()))) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eSplitNode, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "OnStartToHandleTopLevelEditSubAction() failed, but ignored"); RefPtr<SplitNodeTransaction> transaction = SplitNodeTransaction::Create(*this, aStartOfRightNode); nsresult rv = DoTransactionInternal(transaction); if (NS_WARN_IF(Destroyed())) { NS_WARNING( "EditorBase::DoTransactionInternal() caused destroying the editor"); return Err(NS_ERROR_EDITOR_DESTROYED); } if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DoTransactionInternal() failed"); return Err(rv); } nsIContent* newContent = transaction->GetNewContent(); nsIContent* splitContent = transaction->GetSplitContent(); if (NS_WARN_IF(!newContent) || NS_WARN_IF(!splitContent)) { return Err(NS_ERROR_FAILURE); } TopLevelEditSubActionDataRef().DidSplitContent(*this, *splitContent, *newContent); if (NS_WARN_IF(!newContent->IsInComposedDoc()) || NS_WARN_IF(!splitContent->IsInComposedDoc())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } return SplitNodeResult(*newContent, *splitContent); } Result<SplitNodeResult, nsresult> HTMLEditor::SplitNodeDeepWithTransaction( nsIContent& aMostAncestorToSplit, const EditorDOMPoint& aDeepestStartOfRightNode, SplitAtEdges aSplitAtEdges) { MOZ_ASSERT(aDeepestStartOfRightNode.IsSetAndValidInComposedDoc()); MOZ_ASSERT( aDeepestStartOfRightNode.GetContainer() == &aMostAncestorToSplit || EditorUtils::IsDescendantOf(*aDeepestStartOfRightNode.GetContainer(), aMostAncestorToSplit)); if (NS_WARN_IF(!aDeepestStartOfRightNode.IsInComposedDoc())) { return Err(NS_ERROR_INVALID_ARG); } nsCOMPtr<nsIContent> newLeftNodeOfMostAncestor; EditorDOMPoint atStartOfRightNode(aDeepestStartOfRightNode); // lastResult is as explained by its name, the last result which may not be // split a node actually. SplitNodeResult lastResult = SplitNodeResult::NotHandled(atStartOfRightNode); MOZ_ASSERT(lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsSetAndValidInComposedDoc()); while (true) { // Need to insert rules code call here to do things like not split a list // if you are after the last <li> or before the first, etc. For now we // just have some smarts about unnecessarily splitting text nodes, which // should be universal enough to put straight in this EditorBase routine. auto* splittingContent = atStartOfRightNode.GetContainerAs<nsIContent>(); if (NS_WARN_IF(!splittingContent)) { lastResult.IgnoreCaretPointSuggestion(); return Err(NS_ERROR_FAILURE); } // If we meet an orphan node before meeting aMostAncestorToSplit, we need // to stop splitting. This is a bug of the caller. if (NS_WARN_IF(splittingContent != &aMostAncestorToSplit && !atStartOfRightNode.GetContainerParentAs<nsIContent>())) { lastResult.IgnoreCaretPointSuggestion(); return Err(NS_ERROR_FAILURE); } // If the container is not splitable node such as comment node, atomic // element, etc, we should keep it as-is, and try to split its parents. if (!HTMLEditUtils::IsSplittableNode(*splittingContent)) { if (splittingContent == &aMostAncestorToSplit) { return lastResult; } atStartOfRightNode.Set(splittingContent); continue; } // If the split point is middle of the node or the node is not a text node // and we're allowed to create empty element node, split it. if ((aSplitAtEdges == SplitAtEdges::eAllowToCreateEmptyContainer && !atStartOfRightNode.IsInTextNode()) || (!atStartOfRightNode.IsStartOfContainer() && !atStartOfRightNode.IsEndOfContainer())) { Result<SplitNodeResult, nsresult> splitNodeResult = SplitNodeWithTransaction(atStartOfRightNode); if (MOZ_UNLIKELY(splitNodeResult.isErr())) { lastResult.IgnoreCaretPointSuggestion(); return splitNodeResult; } lastResult = SplitNodeResult::MergeWithDeeperSplitNodeResult( splitNodeResult.unwrap(), lastResult); if (NS_WARN_IF(!lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsInComposedDoc())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } MOZ_ASSERT(lastResult.HasCaretPointSuggestion()); MOZ_ASSERT(lastResult.GetOriginalContent() == splittingContent); if (splittingContent == &aMostAncestorToSplit) { // Actually, we split aMostAncestorToSplit. return lastResult; } // Then, try to split its parent before current node. atStartOfRightNode = lastResult.AtNextContent<EditorDOMPoint>(); } // If the split point is end of the node and it is a text node or we're not // allowed to create empty container node, try to split its parent after it. else if (!atStartOfRightNode.IsStartOfContainer()) { lastResult = SplitNodeResult::HandledButDidNotSplitDueToEndOfContainer( *splittingContent, &lastResult); MOZ_ASSERT(lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsSetAndValidInComposedDoc()); if (splittingContent == &aMostAncestorToSplit) { return lastResult; } // Try to split its parent after current node. atStartOfRightNode.SetAfter(splittingContent); } // If the split point is start of the node and it is a text node or we're // not allowed to create empty container node, try to split its parent. else { if (splittingContent == &aMostAncestorToSplit) { return SplitNodeResult::HandledButDidNotSplitDueToStartOfContainer( *splittingContent, &lastResult); } // Try to split its parent before current node. // XXX This is logically wrong. If we've already split something but // this is the last splitable content node in the limiter, this // method will return "not handled". lastResult = SplitNodeResult::NotHandled(atStartOfRightNode, &lastResult); MOZ_ASSERT(lastResult.AtSplitPoint<EditorRawDOMPoint>() .IsSetAndValidInComposedDoc()); atStartOfRightNode.Set(splittingContent); MOZ_ASSERT(atStartOfRightNode.IsSetAndValidInComposedDoc()); } } // Not reached because while (true) loop never breaks. } Result<SplitNodeResult, nsresult> HTMLEditor::DoSplitNode( const EditorDOMPoint& aStartOfRightNode, nsIContent& aNewNode) { // Ensure computing the offset if it's initialized with a child content node. Unused << aStartOfRightNode.Offset(); // XXX Perhaps, aStartOfRightNode may be invalid if this is a redo // operation after modifying DOM node with JS. if (NS_WARN_IF(!aStartOfRightNode.IsInContentNode())) { return Err(NS_ERROR_INVALID_ARG); } MOZ_ASSERT(aStartOfRightNode.IsSetAndValid()); // Remember all selection points. AutoTArray<SavedRange, 10> savedRanges; for (SelectionType selectionType : kPresentSelectionTypes) { SavedRange savingRange; savingRange.mSelection = GetSelection(selectionType); if (NS_WARN_IF(!savingRange.mSelection && selectionType == SelectionType::eNormal)) { return Err(NS_ERROR_FAILURE); } if (!savingRange.mSelection) { // For non-normal selections, skip over the non-existing ones. continue; } for (uint32_t j : IntegerRange(savingRange.mSelection->RangeCount())) { const nsRange* r = savingRange.mSelection->GetRangeAt(j); MOZ_ASSERT(r); MOZ_ASSERT(r->IsPositioned()); // XXX Looks like that SavedRange should have mStart and mEnd which // are RangeBoundary. Then, we can avoid to compute offset here. savingRange.mStartContainer = r->GetStartContainer(); savingRange.mStartOffset = r->StartOffset(); savingRange.mEndContainer = r->GetEndContainer(); savingRange.mEndOffset = r->EndOffset(); savedRanges.AppendElement(savingRange); } } nsCOMPtr<nsINode> parent = aStartOfRightNode.GetContainerParent(); if (NS_WARN_IF(!parent)) { return Err(NS_ERROR_FAILURE); } // Fix the child before mutation observer may touch the DOM tree. nsIContent* firstChildOfRightNode = aStartOfRightNode.GetChild(); IgnoredErrorResult error; parent->InsertBefore( aNewNode, aStartOfRightNode.GetContainer()->GetNextSibling(), error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING("nsINode::InsertBefore() failed"); return Err(error.StealNSResult()); } MOZ_DIAGNOSTIC_ASSERT_IF(aStartOfRightNode.IsInTextNode(), aNewNode.IsText()); MOZ_DIAGNOSTIC_ASSERT_IF(!aStartOfRightNode.IsInTextNode(), !aNewNode.IsText()); // If we are splitting a text node, we need to move its some data to the // new text node. if (aStartOfRightNode.IsInTextNode()) { if (!aStartOfRightNode.IsEndOfContainer()) { Text* originalTextNode = aStartOfRightNode.ContainerAs<Text>(); Text* newTextNode = aNewNode.AsText(); nsAutoString movingText; const uint32_t cutStartOffset = aStartOfRightNode.Offset(); const uint32_t cutLength = originalTextNode->Length() - aStartOfRightNode.Offset(); IgnoredErrorResult error; originalTextNode->SubstringData(cutStartOffset, cutLength, movingText, error); NS_WARNING_ASSERTION(!error.Failed(), "Text::SubstringData() failed, but ignored"); error.SuppressException(); // XXX This call may destroy us. DoDeleteText(MOZ_KnownLive(*originalTextNode), cutStartOffset, cutLength, error); NS_WARNING_ASSERTION(!error.Failed(), "EditorBase::DoDeleteText() failed, but ignored"); error.SuppressException(); // XXX This call may destroy us. DoSetText(MOZ_KnownLive(*newTextNode), movingText, error); NS_WARNING_ASSERTION(!error.Failed(), "EditorBase::DoSetText() failed, but ignored"); } } // If the node has been moved to different parent, we should do nothing // since web apps should handle everything in such case. else if (firstChildOfRightNode && aStartOfRightNode.GetContainer() != firstChildOfRightNode->GetParentNode()) { NS_WARNING( "The web app interrupted us and touched the DOM tree, we stopped " "splitting anything"); } else { // If the right node is new one and there is no children or splitting at // end of the node, we need to do nothing. if (!firstChildOfRightNode) { // Do nothing. } // If the right node is new one and splitting at start of the container, // we need to move all children to the new right node. else if (!firstChildOfRightNode->GetPreviousSibling()) { // XXX Why do we ignore an error while moving nodes from the right // node to the left node? nsresult rv = MoveAllChildren(*aStartOfRightNode.GetContainer(), EditorRawDOMPoint(&aNewNode, 0u)); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::MoveAllChildren() failed, but ignored"); } // If the right node is new one and splitting at middle of the node, we need // to move inclusive next siblings of the split point to the new right node. else { // XXX Why do we ignore an error while moving nodes from the right node // to the left node? nsresult rv = MoveInclusiveNextSiblings(*firstChildOfRightNode, EditorRawDOMPoint(&aNewNode, 0u)); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return Err(NS_ERROR_EDITOR_DESTROYED); } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::MoveInclusiveNextSiblings() failed, but ignored"); } } // Handle selection // TODO: Stop doing this, this shouldn't be necessary to update selection. if (RefPtr<PresShell> presShell = GetPresShell()) { presShell->FlushPendingNotifications(FlushType::Frames); } NS_WARNING_ASSERTION(!Destroyed(), "The editor is destroyed during splitting a node"); const bool allowedTransactionsToChangeSelection = AllowsTransactionsToChangeSelection(); RefPtr<Selection> previousSelection; for (SavedRange& savedRange : savedRanges) { // If we have not seen the selection yet, clear all of its ranges. if (savedRange.mSelection != previousSelection) { MOZ_KnownLive(savedRange.mSelection)->RemoveAllRanges(error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING("Selection::RemoveAllRanges() failed"); return Err(error.StealNSResult()); } previousSelection = savedRange.mSelection; } // XXX Looks like that we don't need to modify normal selection here // because selection will be modified by the caller if // AllowsTransactionsToChangeSelection() will return true. if (allowedTransactionsToChangeSelection && savedRange.mSelection->Type() == SelectionType::eNormal) { // If the editor should adjust the selection, don't bother restoring // the ranges for the normal selection here. continue; } auto AdjustDOMPoint = [&](nsCOMPtr<nsINode>& aContainer, uint32_t& aOffset) { if (aContainer != aStartOfRightNode.GetContainer()) { return; } // If the container is the left node and offset is after the split // point, the content was moved from the right node to aNewNode. // So, we need to change the container to aNewNode and decrease the // offset. if (aOffset >= aStartOfRightNode.Offset()) { aContainer = &aNewNode; aOffset -= aStartOfRightNode.Offset(); } }; AdjustDOMPoint(savedRange.mStartContainer, savedRange.mStartOffset); AdjustDOMPoint(savedRange.mEndContainer, savedRange.mEndOffset); RefPtr<nsRange> newRange = nsRange::Create(savedRange.mStartContainer, savedRange.mStartOffset, savedRange.mEndContainer, savedRange.mEndOffset, error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING("nsRange::Create() failed"); return Err(error.StealNSResult()); } // The `MOZ_KnownLive` annotation is only necessary because of a bug // (https://bugzilla.mozilla.org/show_bug.cgi?id=1622253) in the // static analyzer. MOZ_KnownLive(savedRange.mSelection) ->AddRangeAndSelectFramesAndNotifyListeners(*newRange, error); if (MOZ_UNLIKELY(error.Failed())) { NS_WARNING( "Selection::AddRangeAndSelectFramesAndNotifyListeners() failed"); return Err(error.StealNSResult()); } } // We don't need to set selection here because the caller should do that // in any case. // If splitting the node causes running mutation event listener and we've // got unexpected result, we should return error because callers will // continue to do their work without complicated DOM tree result. // NOTE: Perhaps, we shouldn't do this immediately after each DOM tree change // because stopping handling it causes some data loss. E.g., user // may loose the text which is moved to the new text node. // XXX We cannot check all descendants in the right node and the new left // node for performance reason. I think that if caller needs to access // some of the descendants, they should check by themselves. if (NS_WARN_IF(parent != aStartOfRightNode.GetContainer()->GetParentNode()) || NS_WARN_IF(parent != aNewNode.GetParentNode()) || NS_WARN_IF(aNewNode.GetPreviousSibling() != aStartOfRightNode.GetContainer())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } DebugOnly<nsresult> rvIgnored = RangeUpdaterRef().SelAdjSplitNode( *aStartOfRightNode.ContainerAs<nsIContent>(), aStartOfRightNode.Offset(), aNewNode); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "RangeUpdater::SelAdjSplitNode() failed, but ignored"); return SplitNodeResult(aNewNode, *aStartOfRightNode.ContainerAs<nsIContent>()); } Result<JoinNodesResult, nsresult> HTMLEditor::JoinNodesWithTransaction( nsIContent& aLeftContent, nsIContent& aRightContent) { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(&aLeftContent != &aRightContent); MOZ_ASSERT(aLeftContent.GetParentNode()); MOZ_ASSERT(aRightContent.GetParentNode()); MOZ_ASSERT(aLeftContent.GetParentNode() == aRightContent.GetParentNode()); IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eJoinNodes, nsIEditor::ePrevious, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(ignoredError.StealNSResult()); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); if (NS_WARN_IF(!aRightContent.GetParentNode())) { return Err(NS_ERROR_FAILURE); } RefPtr<JoinNodesTransaction> transaction = JoinNodesTransaction::MaybeCreate(*this, aLeftContent, aRightContent); if (MOZ_UNLIKELY(!transaction)) { NS_WARNING("JoinNodesTransaction::MaybeCreate() failed"); return Err(NS_ERROR_FAILURE); } const nsresult rv = DoTransactionInternal(transaction); // FYI: Now, DidJoinNodesTransaction() must have been run if succeeded. if (NS_WARN_IF(Destroyed())) { return Err(NS_ERROR_EDITOR_DESTROYED); } // This shouldn't occur unless the cycle collector runs by chrome script // forcibly. if (NS_WARN_IF(!transaction->GetRemovedContent()) || NS_WARN_IF(!transaction->GetExistingContent())) { return Err(NS_ERROR_UNEXPECTED); } // If joined node is moved to different place, offset may not have any // meaning. In this case, the web app modified the DOM tree takes on the // responsibility for the remaning things. if (NS_WARN_IF(transaction->GetExistingContent()->GetParent() != transaction->GetParentNode())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DoTransactionInternal() failed"); return Err(rv); } return JoinNodesResult(transaction->CreateJoinedPoint<EditorDOMPoint>(), *transaction->GetRemovedContent()); } void HTMLEditor::DidJoinNodesTransaction( const JoinNodesTransaction& aTransaction, nsresult aDoJoinNodesResult) { // This shouldn't occur unless the cycle collector runs by chrome script // forcibly. if (MOZ_UNLIKELY(NS_WARN_IF(!aTransaction.GetRemovedContent()) || NS_WARN_IF(!aTransaction.GetExistingContent()))) { return; } // If joined node is moved to different place, offset may not have any // meaning. In this case, the web app modified the DOM tree takes on the // responsibility for the remaning things. if (MOZ_UNLIKELY(aTransaction.GetExistingContent()->GetParentNode() != aTransaction.GetParentNode())) { return; } // Be aware, the joined point should be created for each call because // they may refer the child node, but some of them may change the DOM tree // after that, thus we need to avoid invalid point (Although it shouldn't // occur). TopLevelEditSubActionDataRef().DidJoinContents( *this, aTransaction.CreateJoinedPoint<EditorRawDOMPoint>()); if (NS_SUCCEEDED(aDoJoinNodesResult)) { if (RefPtr<TextServicesDocument> textServicesDocument = mTextServicesDocument) { textServicesDocument->DidJoinContents( aTransaction.CreateJoinedPoint<EditorRawDOMPoint>(), *aTransaction.GetRemovedContent()); } } if (!mActionListeners.IsEmpty()) { for (auto& listener : mActionListeners.Clone()) { DebugOnly<nsresult> rvIgnored = listener->DidJoinContents( aTransaction.CreateJoinedPoint<EditorRawDOMPoint>(), aTransaction.GetRemovedContent()); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "nsIEditActionListener::DidJoinContents() failed, but ignored"); } } } nsresult HTMLEditor::DoJoinNodes(nsIContent& aContentToKeep, nsIContent& aContentToRemove) { MOZ_ASSERT(IsEditActionDataAvailable()); const uint32_t keepingContentLength = aContentToKeep.Length(); const EditorDOMPoint oldPointAtRightContent(&aContentToRemove); if (MOZ_LIKELY(oldPointAtRightContent.IsSet())) { Unused << oldPointAtRightContent.Offset(); // Fix the offset } // Remember all selection points. // XXX Do we need to restore all types of selections by ourselves? Normal // selection should be modified later as result of handling edit action. // IME selections shouldn't be there when nodes are joined. Spellcheck // selections should be recreated with newer text. URL selections // shouldn't be there because of used only by the URL bar. AutoTArray<SavedRange, 10> savedRanges; { EditorRawDOMPoint atRemovingNode(&aContentToRemove); EditorRawDOMPoint atNodeToKeep(&aContentToKeep); for (SelectionType selectionType : kPresentSelectionTypes) { SavedRange savingRange; savingRange.mSelection = GetSelection(selectionType); if (selectionType == SelectionType::eNormal) { if (NS_WARN_IF(!savingRange.mSelection)) { return NS_ERROR_FAILURE; } } else if (!savingRange.mSelection) { // For non-normal selections, skip over the non-existing ones. continue; } const uint32_t rangeCount = savingRange.mSelection->RangeCount(); for (const uint32_t j : IntegerRange(rangeCount)) { MOZ_ASSERT(savingRange.mSelection->RangeCount() == rangeCount); const RefPtr<nsRange> r = savingRange.mSelection->GetRangeAt(j); MOZ_ASSERT(r); MOZ_ASSERT(r->IsPositioned()); savingRange.mStartContainer = r->GetStartContainer(); savingRange.mStartOffset = r->StartOffset(); savingRange.mEndContainer = r->GetEndContainer(); savingRange.mEndOffset = r->EndOffset(); // If selection endpoint is between the nodes, remember it as being // in the one that is going away instead. This simplifies later // selection adjustment logic at end of this method. if (savingRange.mStartContainer) { MOZ_ASSERT(savingRange.mEndContainer); auto AdjustDOMPoint = [&](nsCOMPtr<nsINode>& aContainer, uint32_t& aOffset) { // If range boundary points aContentToRemove and aContentToKeep is // its left node, remember it as being at end of aContentToKeep. // Then, it will point start of the first content of moved content // from aContentToRemove. if (aContainer == atRemovingNode.GetContainer() && atNodeToKeep.Offset() < aOffset && aOffset <= atRemovingNode.Offset()) { aContainer = &aContentToKeep; aOffset = keepingContentLength; } }; AdjustDOMPoint(savingRange.mStartContainer, savingRange.mStartOffset); AdjustDOMPoint(savingRange.mEndContainer, savingRange.mEndOffset); } savedRanges.AppendElement(savingRange); } } } // OK, ready to do join now. nsresult rv = [&]() MOZ_CAN_RUN_SCRIPT { // If it's a text node, just shuffle around some text. if (aContentToKeep.IsText() && aContentToRemove.IsText()) { nsAutoString rightText; nsAutoString leftText; aContentToRemove.AsText()->GetData(rightText); aContentToKeep.AsText()->GetData(leftText); leftText += rightText; IgnoredErrorResult ignoredError; DoSetText(MOZ_KnownLive(*aContentToKeep.AsText()), leftText, ignoredError); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(!ignoredError.Failed(), "EditorBase::DoSetText() failed, but ignored"); return NS_OK; } // Otherwise it's an interior node, so shuffle around the children. AutoTArray<OwningNonNull<nsIContent>, 64> arrayOfChildContents; HTMLEditUtils::CollectAllChildren(aContentToRemove, arrayOfChildContents); for (const OwningNonNull<nsIContent>& child : arrayOfChildContents) { IgnoredErrorResult error; aContentToKeep.AppendChild(child, error); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (error.Failed()) { NS_WARNING("nsINode::AppendChild() failed"); return error.StealNSResult(); } } return NS_OK; }(); // Delete the extra node. if (NS_SUCCEEDED(rv)) { aContentToRemove.Remove(); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } } if (MOZ_LIKELY(oldPointAtRightContent.IsSet())) { DebugOnly<nsresult> rvIgnored = RangeUpdaterRef().SelAdjJoinNodes( EditorRawDOMPoint(&aContentToKeep, std::min(keepingContentLength, aContentToKeep.Length())), aContentToRemove, oldPointAtRightContent); NS_WARNING_ASSERTION(NS_SUCCEEDED(rvIgnored), "RangeUpdater::SelAdjJoinNodes() failed, but ignored"); } if (MOZ_UNLIKELY(NS_FAILED(rv))) { return rv; } const bool allowedTransactionsToChangeSelection = AllowsTransactionsToChangeSelection(); // And adjust the selection if needed. RefPtr<Selection> previousSelection; for (SavedRange& savedRange : savedRanges) { // If we have not seen the selection yet, clear all of its ranges. if (savedRange.mSelection != previousSelection) { IgnoredErrorResult error; MOZ_KnownLive(savedRange.mSelection)->RemoveAllRanges(error); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (error.Failed()) { NS_WARNING("Selection::RemoveAllRanges() failed"); return error.StealNSResult(); } previousSelection = savedRange.mSelection; } if (allowedTransactionsToChangeSelection && savedRange.mSelection->Type() == SelectionType::eNormal) { // If the editor should adjust the selection, don't bother restoring // the ranges for the normal selection here. continue; } auto AdjustDOMPoint = [&](nsCOMPtr<nsINode>& aContainer, uint32_t& aOffset) { // Now, all content of aContentToRemove are moved to end of // aContentToKeep. Therefore, if a range boundary was in // aContentToRemove, we need to change the container to aContentToKeep and // adjust the offset to after the original content of aContentToKeep. if (aContainer == &aContentToRemove) { aContainer = &aContentToKeep; aOffset += keepingContentLength; } }; AdjustDOMPoint(savedRange.mStartContainer, savedRange.mStartOffset); AdjustDOMPoint(savedRange.mEndContainer, savedRange.mEndOffset); const RefPtr<nsRange> newRange = nsRange::Create( savedRange.mStartContainer, savedRange.mStartOffset, savedRange.mEndContainer, savedRange.mEndOffset, IgnoreErrors()); if (!newRange) { NS_WARNING("nsRange::Create() failed"); return NS_ERROR_FAILURE; } IgnoredErrorResult error; // The `MOZ_KnownLive` annotation is only necessary because of a bug // (https://bugzilla.mozilla.org/show_bug.cgi?id=1622253) in the // static analyzer. MOZ_KnownLive(savedRange.mSelection) ->AddRangeAndSelectFramesAndNotifyListeners(*newRange, error); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } if (NS_WARN_IF(error.Failed())) { return error.StealNSResult(); } } if (allowedTransactionsToChangeSelection) { // Editor wants us to set selection at join point. DebugOnly<nsresult> rvIgnored = CollapseSelectionToStartOf(aContentToKeep); if (MOZ_UNLIKELY(rv == NS_ERROR_EDITOR_DESTROYED)) { NS_WARNING( "EditorBase::CollapseSelectionTo() caused destroying the editor"); return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBases::CollapseSelectionTos() failed, but ignored"); } return NS_OK; } Result<MoveNodeResult, nsresult> HTMLEditor::MoveNodeWithTransaction( nsIContent& aContentToMove, const EditorDOMPoint& aPointToInsert) { MOZ_ASSERT(aPointToInsert.IsSetAndValid()); EditorDOMPoint oldPoint(&aContentToMove); if (NS_WARN_IF(!oldPoint.IsSet())) { return Err(NS_ERROR_FAILURE); } // Don't do anything if it's already in right place. if (aPointToInsert == oldPoint) { return MoveNodeResult::IgnoredResult(aPointToInsert.NextPoint()); } RefPtr<MoveNodeTransaction> moveNodeTransaction = MoveNodeTransaction::MaybeCreate(*this, aContentToMove, aPointToInsert); if (MOZ_UNLIKELY(!moveNodeTransaction)) { NS_WARNING("MoveNodeTransaction::MaybeCreate() failed"); return Err(NS_ERROR_FAILURE); } IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eMoveNode, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return Err(ignoredError.StealNSResult()); } NS_WARNING_ASSERTION( !ignoredError.Failed(), "TextEditor::OnStartToHandleTopLevelEditSubAction() failed, but ignored"); TopLevelEditSubActionDataRef().WillDeleteContent(*this, aContentToMove); nsresult rv = DoTransactionInternal(moveNodeTransaction); if (NS_SUCCEEDED(rv)) { if (mTextServicesDocument) { const OwningNonNull<TextServicesDocument> textServicesDocument = *mTextServicesDocument; textServicesDocument->DidDeleteContent(aContentToMove); } } if (!mActionListeners.IsEmpty()) { for (auto& listener : mActionListeners.Clone()) { DebugOnly<nsresult> rvIgnored = listener->DidDeleteNode(&aContentToMove, rv); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "nsIEditActionListener::DidDeleteNode() failed, but ignored"); } } if (MOZ_UNLIKELY(Destroyed())) { NS_WARNING( "MoveNodeTransaction::DoTransaction() caused destroying the editor"); return Err(NS_ERROR_EDITOR_DESTROYED); } if (NS_FAILED(rv)) { NS_WARNING("MoveNodeTransaction::DoTransaction() failed"); return Err(rv); } TopLevelEditSubActionDataRef().DidInsertContent(*this, aContentToMove); return MoveNodeResult::HandledResult( moveNodeTransaction->SuggestNextInsertionPoint<EditorDOMPoint>(), moveNodeTransaction->SuggestPointToPutCaret<EditorDOMPoint>()); } Result<RefPtr<Element>, nsresult> HTMLEditor::DeleteSelectionAndCreateElement( nsAtom& aTag, const InitializeInsertingElement& aInitializer) { MOZ_ASSERT(IsEditActionDataAvailable()); nsresult rv = DeleteSelectionAndPrepareToCreateNode(); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::DeleteSelectionAndPrepareToCreateNode() failed"); return Err(rv); } EditorDOMPoint pointToInsert(SelectionRef().AnchorRef()); if (!pointToInsert.IsSet()) { return Err(NS_ERROR_FAILURE); } Result<CreateElementResult, nsresult> createNewElementResult = CreateAndInsertElement(WithTransaction::Yes, aTag, pointToInsert, aInitializer); if (MOZ_UNLIKELY(createNewElementResult.isErr())) { NS_WARNING( "HTMLEditor::CreateAndInsertElement(WithTransaction::Yes) failed"); return createNewElementResult.propagateErr(); } MOZ_ASSERT(createNewElementResult.inspect().GetNewNode()); // We want the selection to be just after the new node createNewElementResult.inspect().IgnoreCaretPointSuggestion(); rv = CollapseSelectionTo( EditorRawDOMPoint::After(*createNewElementResult.inspect().GetNewNode())); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::CollapseSelectionTo() failed"); return Err(rv); } return createNewElementResult.unwrap().UnwrapNewNode(); } nsresult HTMLEditor::DeleteSelectionAndPrepareToCreateNode() { MOZ_ASSERT(IsEditActionDataAvailable()); if (NS_WARN_IF(!SelectionRef().GetAnchorFocusRange())) { return NS_OK; } if (!SelectionRef().GetAnchorFocusRange()->Collapsed()) { nsresult rv = DeleteSelectionAsSubAction(nsIEditor::eNone, nsIEditor::eStrip); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteSelectionAsSubAction() failed"); return rv; } MOZ_ASSERT(SelectionRef().GetAnchorFocusRange() && SelectionRef().GetAnchorFocusRange()->Collapsed(), "Selection not collapsed after delete"); } // If the selection is a chardata node, split it if necessary and compute // where to put the new node EditorDOMPoint atAnchor(SelectionRef().AnchorRef()); if (NS_WARN_IF(!atAnchor.IsSet()) || !atAnchor.IsInDataNode()) { return NS_OK; } if (NS_WARN_IF(!atAnchor.GetContainerParent())) { return NS_ERROR_FAILURE; } if (atAnchor.IsStartOfContainer()) { const EditorRawDOMPoint atAnchorContainer(atAnchor.GetContainer()); if (NS_WARN_IF(!atAnchorContainer.IsSetAndValid())) { return NS_ERROR_FAILURE; } nsresult rv = CollapseSelectionTo(atAnchorContainer); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionTo() failed"); return rv; } if (atAnchor.IsEndOfContainer()) { EditorRawDOMPoint afterAnchorContainer(atAnchor.GetContainer()); if (NS_WARN_IF(!afterAnchorContainer.AdvanceOffset())) { return NS_ERROR_FAILURE; } nsresult rv = CollapseSelectionTo(afterAnchorContainer); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionTo() failed"); return rv; } Result<SplitNodeResult, nsresult> splitAtAnchorResult = SplitNodeWithTransaction(atAnchor); if (MOZ_UNLIKELY(splitAtAnchorResult.isErr())) { NS_WARNING("HTMLEditor::SplitNodeWithTransaction() failed"); return splitAtAnchorResult.unwrapErr(); } splitAtAnchorResult.inspect().IgnoreCaretPointSuggestion(); const auto atRightContent = splitAtAnchorResult.inspect().AtNextContent<EditorRawDOMPoint>(); if (NS_WARN_IF(!atRightContent.IsSet())) { return NS_ERROR_FAILURE; } MOZ_ASSERT(atRightContent.IsSetAndValid()); nsresult rv = CollapseSelectionTo(atRightContent); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::CollapseSelectionTo() failed"); return rv; } bool HTMLEditor::IsEmpty() const { if (mPaddingBRElementForEmptyEditor) { return true; } // XXX Oddly, we check body or document element's state instead of // active editing host. Must be a bug. Element* bodyOrDocumentElement = GetRoot(); if (!bodyOrDocumentElement) { return true; } for (nsIContent* childContent = bodyOrDocumentElement->GetFirstChild(); childContent; childContent = childContent->GetNextSibling()) { if (!childContent->IsText() || childContent->Length()) { return false; } } return true; } // add to aElement the CSS inline styles corresponding to the HTML attribute // aAttribute with its value aValue nsresult HTMLEditor::SetAttributeOrEquivalent(Element* aElement, nsAtom* aAttribute, const nsAString& aValue, bool aSuppressTransaction) { MOZ_ASSERT(aElement); MOZ_ASSERT(aAttribute); nsAutoScriptBlocker scriptBlocker; nsStyledElement* styledElement = nsStyledElement::FromNodeOrNull(aElement); if (!IsCSSEnabled()) { // we are not in an HTML+CSS editor; let's set the attribute the HTML way if (EditorElementStyle::IsHTMLStyle(aAttribute)) { const EditorElementStyle elementStyle = EditorElementStyle::Create(*aAttribute); if (styledElement && elementStyle.IsCSSRemovable(*styledElement)) { // MOZ_KnownLive(*styledElement): It's aElement and its lifetime must // be guaranteed by the caller because of MOZ_CAN_RUN_SCRIPT method. nsresult rv = CSSEditUtils::RemoveCSSEquivalentToStyle( aSuppressTransaction ? WithTransaction::No : WithTransaction::Yes, *this, MOZ_KnownLive(*styledElement), elementStyle, nullptr); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "CSSEditUtils::RemoveCSSEquivalentToStyle() failed, but ignored"); } } if (aSuppressTransaction) { nsresult rv = aElement->SetAttr(kNameSpaceID_None, aAttribute, aValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr() failed"); return rv; } nsresult rv = SetAttributeWithTransaction(*aElement, *aAttribute, aValue); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::SetAttributeWithTransaction() failed"); return rv; } if (EditorElementStyle::IsHTMLStyle(aAttribute)) { const EditorElementStyle elementStyle = EditorElementStyle::Create(*aAttribute); if (styledElement && elementStyle.IsCSSSettable(*styledElement)) { // MOZ_KnownLive(*styledElement): It's aElement and its lifetime must // be guaranteed by the caller because of MOZ_CAN_RUN_SCRIPT method. Result<size_t, nsresult> count = CSSEditUtils::SetCSSEquivalentToStyle( aSuppressTransaction ? WithTransaction::No : WithTransaction::Yes, *this, MOZ_KnownLive(*styledElement), elementStyle, &aValue); if (MOZ_UNLIKELY(count.isErr())) { if (NS_WARN_IF(count.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle() failed, but ignored"); } if (count.inspect()) { // we found an equivalence ; let's remove the HTML attribute itself if // it is set nsAutoString existingValue; if (!aElement->GetAttr(aAttribute, existingValue)) { return NS_OK; } if (aSuppressTransaction) { nsresult rv = aElement->UnsetAttr(kNameSpaceID_None, aAttribute, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::UnsetAttr() failed"); return rv; } nsresult rv = RemoveAttributeWithTransaction(*aElement, *aAttribute); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::RemoveAttributeWithTransaction() failed"); return rv; } } } // count is an integer that represents the number of CSS declarations // applied to the element. If it is zero, we found no equivalence in this // implementation for the attribute if (aAttribute == nsGkAtoms::style) { // if it is the style attribute, just add the new value to the existing // style attribute's value nsString existingValue; // Use nsString to avoid copying the string // buffer at setting the attribute below. aElement->GetAttr(nsGkAtoms::style, existingValue); if (!existingValue.IsEmpty()) { existingValue.Append(HTMLEditUtils::kSpace); } existingValue.Append(aValue); if (aSuppressTransaction) { nsresult rv = aElement->SetAttr(kNameSpaceID_None, nsGkAtoms::style, existingValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr(nsGkAtoms::style) failed"); return rv; } nsresult rv = SetAttributeWithTransaction(*aElement, *nsGkAtoms::style, existingValue); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::SetAttributeWithTransaction(nsGkAtoms::style) failed"); return rv; } // we have no CSS equivalence for this attribute and it is not the style // attribute; let's set it the good'n'old HTML way if (aSuppressTransaction) { nsresult rv = aElement->SetAttr(kNameSpaceID_None, aAttribute, aValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr() failed"); return rv; } nsresult rv = SetAttributeWithTransaction(*aElement, *aAttribute, aValue); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::SetAttributeWithTransaction() failed"); return rv; } nsresult HTMLEditor::RemoveAttributeOrEquivalent(Element* aElement, nsAtom* aAttribute, bool aSuppressTransaction) { MOZ_ASSERT(aElement); MOZ_ASSERT(aAttribute); if (IsCSSEnabled() && EditorElementStyle::IsHTMLStyle(aAttribute)) { const EditorElementStyle elementStyle = EditorElementStyle::Create(*aAttribute); if (elementStyle.IsCSSRemovable(*aElement)) { // XXX It might be keep handling attribute even if aElement is not // an nsStyledElement instance. nsStyledElement* styledElement = nsStyledElement::FromNodeOrNull(aElement); if (NS_WARN_IF(!styledElement)) { return NS_ERROR_INVALID_ARG; } // MOZ_KnownLive(*styledElement): It's aElement and its lifetime must // be guaranteed by the caller because of MOZ_CAN_RUN_SCRIPT method. nsresult rv = CSSEditUtils::RemoveCSSEquivalentToStyle( aSuppressTransaction ? WithTransaction::No : WithTransaction::Yes, *this, MOZ_KnownLive(*styledElement), elementStyle, nullptr); if (NS_FAILED(rv)) { NS_WARNING("CSSEditUtils::RemoveCSSEquivalentToStyle() failed"); return rv; } } } if (!aElement->HasAttr(aAttribute)) { return NS_OK; } if (aSuppressTransaction) { nsresult rv = aElement->UnsetAttr(kNameSpaceID_None, aAttribute, /* aNotify = */ true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::UnsetAttr() failed"); return rv; } nsresult rv = RemoveAttributeWithTransaction(*aElement, *aAttribute); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::RemoveAttributeWithTransaction() failed"); return rv; } NS_IMETHODIMP HTMLEditor::SetIsCSSEnabled(bool aIsCSSPrefChecked) { AutoEditActionDataSetter editActionData(*this, EditAction::eEnableOrDisableCSS); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } mIsCSSPrefChecked = aIsCSSPrefChecked; return NS_OK; } // Set the block background color nsresult HTMLEditor::SetBlockBackgroundColorWithCSSAsSubAction( const nsAString& aColor) { MOZ_ASSERT(IsEditActionDataAvailable()); // background-color change and committing composition should be undone // together AutoPlaceholderBatch treatAsOneTransaction( *this, ScrollSelectionIntoView::Yes, __FUNCTION__); CommitComposition(); // XXX Shouldn't we do this before calling `CommitComposition()`? if (IsPlaintextMailComposer()) { return NS_OK; } { Result<EditActionResult, nsresult> result = CanHandleHTMLEditSubAction(); if (MOZ_UNLIKELY(result.isErr())) { NS_WARNING("HTMLEditor::CanHandleHTMLEditSubAction() failed"); return result.unwrapErr(); } if (result.inspect().Canceled()) { return NS_OK; } } IgnoredErrorResult ignoredError; AutoEditSubActionNotifier startToHandleEditSubAction( *this, EditSubAction::eInsertElement, nsIEditor::eNext, ignoredError); if (NS_WARN_IF(ignoredError.ErrorCodeIs(NS_ERROR_EDITOR_DESTROYED))) { return ignoredError.StealNSResult(); } NS_WARNING_ASSERTION(!ignoredError.Failed(), "HTMLEditor::OnStartToHandleTopLevelEditSubAction() " "failed, but ignored"); // TODO: We don't need AutoTransactionsConserveSelection here in the normal // cases, but removing this may cause the behavior with the legacy // mutation event listeners. We should try to delete this in a bug. AutoTransactionsConserveSelection dontChangeMySelection(*this); AutoRangeArray selectionRanges(SelectionRef()); MOZ_ALWAYS_TRUE(selectionRanges.SaveAndTrackRanges(*this)); for (const OwningNonNull<nsRange>& domRange : selectionRanges.Ranges()) { EditorDOMRange range(domRange); if (NS_WARN_IF(!range.IsPositioned())) { continue; } if (range.InSameContainer()) { // If the range is in a text node, set background color of its parent // block. if (range.StartRef().IsInTextNode()) { const RefPtr<nsStyledElement> editableBlockStyledElement = nsStyledElement::FromNodeOrNull(HTMLEditUtils::GetAncestorElement( *range.StartRef().ContainerAs<Text>(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle)); if (!editableBlockStyledElement || !EditorElementStyle::BGColor().IsCSSSettable( *editableBlockStyledElement)) { continue; } Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *editableBlockStyledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } continue; } // If `Selection` is collapsed in a `<body>` element, set background // color of the `<body>` element. if (range.Collapsed() && range.StartRef().IsContainerHTMLElement(nsGkAtoms::body)) { const RefPtr<nsStyledElement> styledElement = range.StartRef().GetContainerAs<nsStyledElement>(); if (!styledElement || !EditorElementStyle::BGColor().IsCSSSettable(*styledElement)) { continue; } Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *styledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } continue; } // If one node is selected, set background color of it if it's a // block, or of its parent block otherwise. if ((range.StartRef().IsStartOfContainer() && range.EndRef().IsStartOfContainer()) || range.StartRef().Offset() + 1 == range.EndRef().Offset()) { if (NS_WARN_IF(range.StartRef().IsInDataNode())) { continue; } const RefPtr<nsStyledElement> editableBlockStyledElement = nsStyledElement::FromNodeOrNull( HTMLEditUtils::GetInclusiveAncestorElement( *range.StartRef().GetChild(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle)); if (!editableBlockStyledElement || !EditorElementStyle::BGColor().IsCSSSettable( *editableBlockStyledElement)) { continue; } Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *editableBlockStyledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } continue; } } // if (range.InSameContainer()) // Collect editable nodes which are entirely contained in the range. AutoTArray<OwningNonNull<nsIContent>, 64> arrayOfContents; { ContentSubtreeIterator subtreeIter; // If there is no node which is entirely in the range, // `ContentSubtreeIterator::Init()` fails, but this is possible case, // don't warn it. nsresult rv = subtreeIter.Init(range.StartRef().ToRawRangeBoundary(), range.EndRef().ToRawRangeBoundary()); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "ContentSubtreeIterator::Init() failed, but ignored"); if (NS_SUCCEEDED(rv)) { for (; !subtreeIter.IsDone(); subtreeIter.Next()) { nsINode* node = subtreeIter.GetCurrentNode(); if (NS_WARN_IF(!node)) { return NS_ERROR_FAILURE; } if (node->IsContent() && EditorUtils::IsEditableContent( *node->AsContent(), EditorType::HTML)) { arrayOfContents.AppendElement(*node->AsContent()); } } } } // This caches block parent if we set its background color. RefPtr<Element> handledBlockParent; // If start node is a text node, set background color of its parent // block. if (range.StartRef().IsInTextNode() && EditorUtils::IsEditableContent(*range.StartRef().ContainerAs<Text>(), EditorType::HTML)) { Element* const editableBlockElement = HTMLEditUtils::GetAncestorElement( *range.StartRef().ContainerAs<Text>(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (editableBlockElement && handledBlockParent != editableBlockElement) { handledBlockParent = editableBlockElement; nsStyledElement* const blockStyledElement = nsStyledElement::FromNode(handledBlockParent); if (blockStyledElement && EditorElementStyle::BGColor().IsCSSSettable(*blockStyledElement)) { // MOZ_KnownLive(*blockStyledElement): It's handledBlockParent // whose type is RefPtr. Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, MOZ_KnownLive(*blockStyledElement), EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } } } } // Then, set background color of each block or block parent of all nodes // in the range entirely. for (OwningNonNull<nsIContent>& content : arrayOfContents) { Element* const editableBlockElement = HTMLEditUtils::GetInclusiveAncestorElement( content, HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (editableBlockElement && handledBlockParent != editableBlockElement) { handledBlockParent = editableBlockElement; nsStyledElement* const blockStyledElement = nsStyledElement::FromNode(handledBlockParent); if (blockStyledElement && EditorElementStyle::BGColor().IsCSSSettable(*blockStyledElement)) { // MOZ_KnownLive(*blockStyledElement): It's handledBlockParent whose // type is RefPtr. Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, MOZ_KnownLive(*blockStyledElement), EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } } } } // Finally, if end node is a text node, set background color of its // parent block. if (range.EndRef().IsInTextNode() && EditorUtils::IsEditableContent(*range.EndRef().ContainerAs<Text>(), EditorType::HTML)) { Element* const editableBlockElement = HTMLEditUtils::GetAncestorElement( *range.EndRef().ContainerAs<Text>(), HTMLEditUtils::ClosestEditableBlockElement, BlockInlineCheck::UseComputedDisplayOutsideStyle); if (editableBlockElement && handledBlockParent != editableBlockElement) { const RefPtr<nsStyledElement> blockStyledElement = nsStyledElement::FromNode(editableBlockElement); if (blockStyledElement && EditorElementStyle::BGColor().IsCSSSettable(*blockStyledElement)) { Result<size_t, nsresult> result = CSSEditUtils::SetCSSEquivalentToStyle( WithTransaction::Yes, *this, *blockStyledElement, EditorElementStyle::BGColor(), &aColor); if (MOZ_UNLIKELY(result.isErr())) { if (NS_WARN_IF(result.inspectErr() == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING( "CSSEditUtils::SetCSSEquivalentToStyle(EditorElementStyle::" "BGColor()) failed, but ignored"); } } } } } // for-loop of selectionRanges MOZ_ASSERT(selectionRanges.HasSavedRanges()); selectionRanges.RestoreFromSavedRanges(); nsresult rv = selectionRanges.ApplyTo(SelectionRef()); if (NS_WARN_IF(Destroyed())) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "AutoRangeArray::ApplyTo() failed"); return rv; } NS_IMETHODIMP HTMLEditor::SetBackgroundColor(const nsAString& aColor) { nsresult rv = SetBackgroundColorAsAction(aColor); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::SetBackgroundColorAsAction() failed"); return rv; } nsresult HTMLEditor::SetBackgroundColorAsAction(const nsAString& aColor, nsIPrincipal* aPrincipal) { AutoEditActionDataSetter editActionData( *this, EditAction::eSetBackgroundColor, aPrincipal); nsresult rv = editActionData.CanHandleAndMaybeDispatchBeforeInputEvent(); if (NS_FAILED(rv)) { NS_WARNING_ASSERTION(rv == NS_ERROR_EDITOR_ACTION_CANCELED, "CanHandleAndMaybeDispatchBeforeInputEvent(), failed"); return EditorBase::ToGenericNSResult(rv); } if (IsCSSEnabled()) { // if we are in CSS mode, we have to apply the background color to the // containing block (or the body if we have no block-level element in // the document) nsresult rv = SetBlockBackgroundColorWithCSSAsSubAction(aColor); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::SetBlockBackgroundColorWithCSSAsSubAction() failed"); return EditorBase::ToGenericNSResult(rv); } // but in HTML mode, we can only set the document's background color rv = SetHTMLBackgroundColorWithTransaction(aColor); NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "HTMLEditor::SetHTMLBackgroundColorWithTransaction() failed"); return EditorBase::ToGenericNSResult(rv); } Result<EditorDOMPoint, nsresult> HTMLEditor::CopyLastEditableChildStylesWithTransaction( Element& aPreviousBlock, Element& aNewBlock, const Element& aEditingHost) { MOZ_ASSERT(IsEditActionDataAvailable()); // First, clear out aNewBlock. Contract is that we want only the styles // from aPreviousBlock. AutoTArray<OwningNonNull<nsIContent>, 32> newBlockChildren; HTMLEditUtils::CollectAllChildren(aNewBlock, newBlockChildren); for (const OwningNonNull<nsIContent>& child : newBlockChildren) { // MOZ_KNownLive(child) because of bug 1622253 nsresult rv = DeleteNodeWithTransaction(MOZ_KnownLive(child)); if (NS_FAILED(rv)) { NS_WARNING("EditorBase::DeleteNodeWithTransaction() failed"); return Err(rv); } } if (MOZ_UNLIKELY(aNewBlock.GetFirstChild())) { return Err(NS_ERROR_EDITOR_UNEXPECTED_DOM_TREE); } // XXX aNewBlock may be moved or removed. Even in such case, we should // keep cloning the styles? // Look for the deepest last editable leaf node in aPreviousBlock. // Then, if found one is a <br> element, look for non-<br> element. nsIContent* deepestEditableContent = nullptr; for (nsCOMPtr<nsIContent> child = &aPreviousBlock; child; child = HTMLEditUtils::GetLastChild( *child, {WalkTreeOption::IgnoreNonEditableNode})) { deepestEditableContent = child; } while (deepestEditableContent && deepestEditableContent->IsHTMLElement(nsGkAtoms::br)) { deepestEditableContent = HTMLEditUtils::GetPreviousContent( *deepestEditableContent, {WalkTreeOption::IgnoreNonEditableNode}, BlockInlineCheck::UseComputedDisplayOutsideStyle, &aEditingHost); } if (!deepestEditableContent) { return EditorDOMPoint(&aNewBlock, 0u); } Element* deepestVisibleEditableElement = deepestEditableContent->GetAsElementOrParentElement(); if (!deepestVisibleEditableElement) { return EditorDOMPoint(&aNewBlock, 0u); } // Clone inline elements to keep current style in the new block. // XXX Looks like that this is really slow if lastEditableDescendant is // far from aPreviousBlock. Probably, we should clone inline containers // from ancestor to descendants without transactions, then, insert it // after that with transaction. RefPtr<Element> lastClonedElement, firstClonedElement; for (RefPtr<Element> elementInPreviousBlock = deepestVisibleEditableElement; elementInPreviousBlock && elementInPreviousBlock != &aPreviousBlock; elementInPreviousBlock = elementInPreviousBlock->GetParentElement()) { if (!HTMLEditUtils::IsInlineStyle(elementInPreviousBlock) && !elementInPreviousBlock->IsHTMLElement(nsGkAtoms::span)) { continue; } OwningNonNull<nsAtom> tagName = *elementInPreviousBlock->NodeInfo()->NameAtom(); // At first time, just create the most descendant inline container // element. if (!firstClonedElement) { Result<CreateElementResult, nsresult> createNewElementResult = CreateAndInsertElement( WithTransaction::Yes, tagName, EditorDOMPoint(&aNewBlock, 0u), // MOZ_CAN_RUN_SCRIPT_BOUNDARY due to bug 1758868 [&elementInPreviousBlock]( HTMLEditor& aHTMLEditor, Element& aNewElement, const EditorDOMPoint&) MOZ_CAN_RUN_SCRIPT_BOUNDARY { // Clone all attributes. Note that despite the method name, // CloneAttributesWithTransaction does not create // transactions in this case because aNewElement has not // been connected yet. // XXX Looks like that this clones id attribute too. aHTMLEditor.CloneAttributesWithTransaction( aNewElement, *elementInPreviousBlock); return NS_OK; }); if (MOZ_UNLIKELY(createNewElementResult.isErr())) { NS_WARNING( "HTMLEditor::CreateAndInsertElement(WithTransaction::Yes) failed"); return createNewElementResult.propagateErr(); } CreateElementResult unwrappedCreateNewElementResult = createNewElementResult.unwrap(); // We'll return with a point suggesting new caret position and the // following path does not require an update of selection here. // Therefore, we don't need to update selection here. unwrappedCreateNewElementResult.IgnoreCaretPointSuggestion(); firstClonedElement = lastClonedElement = unwrappedCreateNewElementResult.UnwrapNewNode(); continue; } // Otherwise, inserts new parent inline container to the previous inserted // inline container. Result<CreateElementResult, nsresult> wrapClonedElementResult = InsertContainerWithTransaction(*lastClonedElement, tagName); if (MOZ_UNLIKELY(wrapClonedElementResult.isErr())) { NS_WARNING("HTMLEditor::InsertContainerWithTransaction() failed"); return wrapClonedElementResult.propagateErr(); } CreateElementResult unwrappedWrapClonedElementResult = wrapClonedElementResult.unwrap(); // We'll return with a point suggesting new caret so that we don't need to // update selection here. unwrappedWrapClonedElementResult.IgnoreCaretPointSuggestion(); MOZ_ASSERT(unwrappedWrapClonedElementResult.GetNewNode()); lastClonedElement = unwrappedWrapClonedElementResult.UnwrapNewNode(); CloneAttributesWithTransaction(*lastClonedElement, *elementInPreviousBlock); if (NS_WARN_IF(Destroyed())) { return Err(NS_ERROR_EDITOR_DESTROYED); } } if (!firstClonedElement) { // XXX Even if no inline elements are cloned, shouldn't we create new // <br> element for aNewBlock? return EditorDOMPoint(&aNewBlock, 0u); } Result<CreateElementResult, nsresult> insertBRElementResult = InsertBRElement( WithTransaction::Yes, EditorDOMPoint(firstClonedElement, 0u)); if (MOZ_UNLIKELY(insertBRElementResult.isErr())) { NS_WARNING("HTMLEditor::InsertBRElement(WithTransaction::Yes) failed"); return insertBRElementResult.propagateErr(); } insertBRElementResult.inspect().IgnoreCaretPointSuggestion(); MOZ_ASSERT(insertBRElementResult.inspect().GetNewNode()); return EditorDOMPoint(insertBRElementResult.inspect().GetNewNode()); } nsresult HTMLEditor::GetElementOrigin(Element& aElement, int32_t& aX, int32_t& aY) { aX = 0; aY = 0; if (NS_WARN_IF(!IsInitialized())) { return NS_ERROR_NOT_INITIALIZED; } PresShell* presShell = GetPresShell(); if (NS_WARN_IF(!presShell)) { return NS_ERROR_NOT_INITIALIZED; } nsIFrame* frame = aElement.GetPrimaryFrame(); if (NS_WARN_IF(!frame)) { return NS_OK; } nsIFrame* absoluteContainerBlockFrame = presShell->GetAbsoluteContainingBlock(frame); if (NS_WARN_IF(!absoluteContainerBlockFrame)) { return NS_OK; } nsPoint off = frame->GetOffsetTo(absoluteContainerBlockFrame); aX = nsPresContext::AppUnitsToIntCSSPixels(off.x); aY = nsPresContext::AppUnitsToIntCSSPixels(off.y); return NS_OK; } Element* HTMLEditor::GetSelectionContainerElement() const { MOZ_ASSERT(IsEditActionDataAvailable()); nsINode* focusNode = nullptr; if (SelectionRef().IsCollapsed()) { focusNode = SelectionRef().GetFocusNode(); if (NS_WARN_IF(!focusNode)) { return nullptr; } } else { const uint32_t rangeCount = SelectionRef().RangeCount(); MOZ_ASSERT(rangeCount, "If 0, Selection::IsCollapsed() should return true"); if (rangeCount == 1) { const nsRange* range = SelectionRef().GetRangeAt(0); const RangeBoundary& startRef = range->StartRef(); const RangeBoundary& endRef = range->EndRef(); // This method called GetSelectedElement() to retrieve proper container // when only one node is selected. However, it simply returns start // node of Selection with additional cost. So, we do not need to call // it anymore. if (startRef.Container()->IsElement() && startRef.Container() == endRef.Container() && startRef.GetChildAtOffset() && startRef.GetChildAtOffset()->GetNextSibling() == endRef.GetChildAtOffset()) { focusNode = startRef.GetChildAtOffset(); MOZ_ASSERT(focusNode, "Start container must not be nullptr"); } else { focusNode = range->GetClosestCommonInclusiveAncestor(); if (!focusNode) { NS_WARNING( "AbstractRange::GetClosestCommonInclusiveAncestor() returned " "nullptr"); return nullptr; } } } else { for (const uint32_t i : IntegerRange(rangeCount)) { MOZ_ASSERT(SelectionRef().RangeCount() == rangeCount); const nsRange* range = SelectionRef().GetRangeAt(i); MOZ_ASSERT(range); nsINode* startContainer = range->GetStartContainer(); if (!focusNode) { focusNode = startContainer; } else if (focusNode != startContainer) { // XXX Looks odd to use parent of startContainer because previous // range may not be in the parent node of current // startContainer. focusNode = startContainer->GetParentNode(); // XXX Looks odd to break the for-loop here because we refer only // first range and another range which starts from different // container, and the latter range is preferred. Why? break; } } if (!focusNode) { NS_WARNING("Focused node of selection was not found"); return nullptr; } } } if (focusNode->IsText()) { focusNode = focusNode->GetParentNode(); if (NS_WARN_IF(!focusNode)) { return nullptr; } } if (NS_WARN_IF(!focusNode->IsElement())) { return nullptr; } return focusNode->AsElement(); } NS_IMETHODIMP HTMLEditor::IsAnonymousElement(Element* aElement, bool* aReturn) { if (NS_WARN_IF(!aElement)) { return NS_ERROR_INVALID_ARG; } *aReturn = aElement->IsRootOfNativeAnonymousSubtree(); return NS_OK; } nsresult HTMLEditor::SetReturnInParagraphCreatesNewParagraph( bool aCreatesNewParagraph) { mCRInParagraphCreatesParagraph = aCreatesNewParagraph; return NS_OK; } bool HTMLEditor::GetReturnInParagraphCreatesNewParagraph() const { return mCRInParagraphCreatesParagraph; } nsresult HTMLEditor::GetReturnInParagraphCreatesNewParagraph( bool* aCreatesNewParagraph) { *aCreatesNewParagraph = mCRInParagraphCreatesParagraph; return NS_OK; } NS_IMETHODIMP HTMLEditor::GetWrapWidth(int32_t* aWrapColumn) { if (NS_WARN_IF(!aWrapColumn)) { return NS_ERROR_INVALID_ARG; } *aWrapColumn = WrapWidth(); return NS_OK; } // // See if the style value includes this attribute, and if it does, // cut out everything from the attribute to the next semicolon. // static void CutStyle(const char* stylename, nsString& styleValue) { // Find the current wrapping type: int32_t styleStart = styleValue.LowerCaseFindASCII(stylename); if (styleStart >= 0) { int32_t styleEnd = styleValue.Find(u";", styleStart); if (styleEnd > styleStart) { styleValue.Cut(styleStart, styleEnd - styleStart + 1); } else { styleValue.Cut(styleStart, styleValue.Length() - styleStart); } } } NS_IMETHODIMP HTMLEditor::SetWrapWidth(int32_t aWrapColumn) { AutoEditActionDataSetter editActionData(*this, EditAction::eSetWrapWidth); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_INITIALIZED; } mWrapColumn = aWrapColumn; // Make sure we're a plaintext editor, otherwise we shouldn't // do the rest of this. if (!IsPlaintextMailComposer()) { return NS_OK; } // Ought to set a style sheet here... RefPtr<Element> rootElement = GetRoot(); if (NS_WARN_IF(!rootElement)) { return NS_ERROR_NOT_INITIALIZED; } // Get the current style for this root element: nsAutoString styleValue; rootElement->GetAttr(nsGkAtoms::style, styleValue); // We'll replace styles for these values: CutStyle("white-space", styleValue); CutStyle("width", styleValue); CutStyle("font-family", styleValue); // If we have other style left, trim off any existing semicolons // or white-space, then add a known semicolon-space: if (!styleValue.IsEmpty()) { styleValue.Trim("; \t", false, true); styleValue.AppendLiteral("; "); } // Make sure we have fixed-width font. This should be done for us, // but it isn't, see bug 22502, so we have to add "font: -moz-fixed;". // Only do this if we're wrapping. if (IsWrapHackEnabled() && aWrapColumn >= 0) { styleValue.AppendLiteral("font-family: -moz-fixed; "); } // and now we're ready to set the new white-space/wrapping style. if (aWrapColumn > 0) { // Wrap to a fixed column. styleValue.AppendLiteral("white-space: pre-wrap; width: "); styleValue.AppendInt(aWrapColumn); styleValue.AppendLiteral("ch;"); } else if (!aWrapColumn) { styleValue.AppendLiteral("white-space: pre-wrap;"); } else { styleValue.AppendLiteral("white-space: pre;"); } nsresult rv = rootElement->SetAttr(kNameSpaceID_None, nsGkAtoms::style, styleValue, true); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Element::SetAttr(nsGkAtoms::style) failed"); return rv; } Element* HTMLEditor::GetFocusedElement() const { nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); if (NS_WARN_IF(!focusManager)) { return nullptr; } Element* const focusedElement = focusManager->GetFocusedElement(); Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return nullptr; } const bool inDesignMode = IsInDesignMode(); if (!focusedElement) { // in designMode, nobody gets focus in most cases. if (inDesignMode && OurWindowHasFocus()) { return document->GetRootElement(); } return nullptr; } if (inDesignMode) { return OurWindowHasFocus() && focusedElement->IsInclusiveDescendantOf(document) ? focusedElement : nullptr; } // We're HTML editor for contenteditable // If the focused content isn't editable, or it has independent selection, // we don't have focus. if (!focusedElement->HasFlag(NODE_IS_EDITABLE) || focusedElement->HasIndependentSelection()) { return nullptr; } // If our window is focused, we're focused. return OurWindowHasFocus() ? focusedElement : nullptr; } bool HTMLEditor::IsActiveInDOMWindow() const { nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); if (NS_WARN_IF(!focusManager)) { return false; } Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return false; } const bool inDesignMode = IsInDesignMode(); // If we're in designMode, we're always active in the DOM window. if (inDesignMode) { return true; } nsPIDOMWindowOuter* ourWindow = document->GetWindow(); nsCOMPtr<nsPIDOMWindowOuter> win; nsIContent* content = nsFocusManager::GetFocusedDescendant( ourWindow, nsFocusManager::eOnlyCurrentWindow, getter_AddRefs(win)); if (!content) { return false; } // We're HTML editor for contenteditable // If the active content isn't editable, or it has independent selection, // we're not active). if (!content->HasFlag(NODE_IS_EDITABLE) || content->HasIndependentSelection()) { return false; } return true; } Element* HTMLEditor::ComputeEditingHostInternal( const nsIContent* aContent, LimitInBodyElement aLimitInBodyElement) const { Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return nullptr; } auto MaybeLimitInBodyElement = [&](const Element* aCandidiateEditingHost) -> Element* { if (!aCandidiateEditingHost) { return nullptr; } if (aLimitInBodyElement != LimitInBodyElement::Yes) { return const_cast<Element*>(aCandidiateEditingHost); } // By default, we should limit editing host to the <body> element for // avoiding deleting or creating unexpected elements outside the <body>. // However, this is incompatible with Chrome so that we should stop // doing this with adding safety checks more. if (document->GetBodyElement() && nsContentUtils::ContentIsFlattenedTreeDescendantOf( aCandidiateEditingHost, document->GetBodyElement())) { return const_cast<Element*>(aCandidiateEditingHost); } // XXX If aContent is an editing host and has no parent node, we reach here, // but returing the <body> which is not connected to aContent is odd. return document->GetBodyElement(); }; if (IsInDesignMode()) { // TODO: In this case, we need to compute editing host from aContent or the // focus node of selection, and it may be in an editing host in a // shadow DOM tree etc. We need to do more complicated things. // See also InDesignMode(). return document->GetBodyElement(); } // We're HTML editor for contenteditable AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return nullptr; } const nsIContent* const content = aContent ? aContent : nsIContent::FromNodeOrNull(SelectionRef().GetFocusNode()); if (NS_WARN_IF(!content)) { return nullptr; } // If the active content isn't editable, we're not active. if (!content->HasFlag(NODE_IS_EDITABLE)) { return nullptr; } // Although the content shouldn't be in a native anonymous subtree, but // perhaps due to a bug of Selection or Range API, it may occur. HTMLEditor // shouldn't touch native anonymous subtree so that return nullptr in such // case. if (MOZ_UNLIKELY(content->IsInNativeAnonymousSubtree())) { return nullptr; } // Note that `Selection` can be in <input> or <textarea>. In the case, we // need to look for an ancestor which does not have editable parent. return MaybeLimitInBodyElement( const_cast<nsIContent*>(content)->GetEditingHost()); } void HTMLEditor::NotifyEditingHostMaybeChanged() { // Note that even if the document is in design mode, a contenteditable element // in a shadow tree is focusable. Therefore, we may need to update editing // host even when the document is in design mode. if (MOZ_UNLIKELY(NS_WARN_IF(!GetDocument()))) { return; } // We're HTML editor for contenteditable AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } // Get selection ancestor limit which may be old editing host. nsIContent* ancestorLimiter = SelectionRef().GetAncestorLimiter(); if (!ancestorLimiter) { // If we've not initialized selection ancestor limit, we should wait focus // event to set proper limiter. return; } // Compute current editing host. nsIContent* editingHost = ComputeEditingHost(); if (NS_WARN_IF(!editingHost)) { return; } // Update selection ancestor limit if current editing host includes the // previous editing host. // Additionally, the editing host may be an element in shadow DOM and the // shadow host is in designMode. In this case, we need to set the editing // host as the new selection limiter. if (ancestorLimiter->IsInclusiveDescendantOf(editingHost) || (ancestorLimiter->IsInDesignMode() != editingHost->IsInDesignMode())) { // Note that don't call HTMLEditor::InitializeSelectionAncestorLimit() // here because it may collapse selection to the first editable node. EditorBase::InitializeSelectionAncestorLimit(*editingHost); } } EventTarget* HTMLEditor::GetDOMEventTarget() const { // Don't use getDocument here, because we have no way of knowing // whether Init() was ever called. So we need to get the document // ourselves, if it exists. Document* doc = GetDocument(); MOZ_ASSERT(doc, "The HTMLEditor has not been initialized yet"); if (!doc) { return nullptr; } // Register the EditorEventListener to the parent of window. // // The advantage of this approach is HTMLEditor can still // receive events when shadow dom is involved. if (nsPIDOMWindowOuter* win = doc->GetWindow()) { return win->GetParentTarget(); } return nullptr; } bool HTMLEditor::ShouldReplaceRootElement() const { if (!mRootElement) { // If we don't know what is our root element, we should find our root. return true; } // If we temporary set document root element to mRootElement, but there is // body element now, we should replace the root element by the body element. return mRootElement != GetBodyElement(); } void HTMLEditor::NotifyRootChanged() { MOZ_ASSERT(mPendingRootElementUpdatedRunner, "HTMLEditor::NotifyRootChanged() should be called via a runner"); mPendingRootElementUpdatedRunner = nullptr; nsCOMPtr<nsIMutationObserver> kungFuDeathGrip(this); AutoEditActionDataSetter editActionData(*this, EditAction::eNotEditing); if (NS_WARN_IF(!editActionData.CanHandle())) { return; } RemoveEventListeners(); nsresult rv = InstallEventListeners(); if (NS_FAILED(rv)) { NS_WARNING("HTMLEditor::InstallEventListeners() failed, but ignored"); return; } UpdateRootElement(); if (!mRootElement) { return; } rv = MaybeCollapseSelectionAtFirstEditableNode(false); if (NS_FAILED(rv)) { NS_WARNING( "HTMLEditor::MaybeCollapseSelectionAtFirstEditableNode(false) " "failed, " "but ignored"); return; } // When this editor has focus, we need to reset the selection limiter to // new root. Otherwise, that is going to be done when this gets focus. nsCOMPtr<nsINode> node = GetFocusedNode(); if (node) { DebugOnly<nsresult> rvIgnored = InitializeSelection(*node); NS_WARNING_ASSERTION( NS_SUCCEEDED(rvIgnored), "EditorBase::InitializeSelection() failed, but ignored"); } SyncRealTimeSpell(); } Element* HTMLEditor::GetBodyElement() const { Document* document = GetDocument(); MOZ_ASSERT(document, "The HTMLEditor hasn't been initialized yet"); if (NS_WARN_IF(!document)) { return nullptr; } return document->GetBody(); } nsINode* HTMLEditor::GetFocusedNode() const { Element* focusedElement = GetFocusedElement(); if (!focusedElement) { return nullptr; } // focusedElement might be non-null even focusManager->GetFocusedElement() // is null. That's the designMode case, and in that case our // FocusedContent() returns the root element, but we want to return // the document. nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); NS_ASSERTION(focusManager, "Focus manager is null"); if ((focusedElement = focusManager->GetFocusedElement())) { return focusedElement; } return GetDocument(); } bool HTMLEditor::OurWindowHasFocus() const { nsFocusManager* focusManager = nsFocusManager::GetFocusManager(); if (NS_WARN_IF(!focusManager)) { return false; } nsPIDOMWindowOuter* focusedWindow = focusManager->GetFocusedWindow(); if (!focusedWindow) { return false; } Document* document = GetDocument(); if (NS_WARN_IF(!document)) { return false; } nsPIDOMWindowOuter* ourWindow = document->GetWindow(); return ourWindow == focusedWindow; } bool HTMLEditor::IsAcceptableInputEvent(WidgetGUIEvent* aGUIEvent) const { if (!EditorBase::IsAcceptableInputEvent(aGUIEvent)) { return false; } // While there is composition, all composition events in its top level // window are always fired on the composing editor. Therefore, if this // editor has composition, the composition events should be handled in this // editor. if (mComposition && aGUIEvent->AsCompositionEvent()) { return true; } nsCOMPtr<nsINode> eventTargetNode = nsINode::FromEventTargetOrNull(aGUIEvent->GetOriginalDOMEventTarget()); if (NS_WARN_IF(!eventTargetNode)) { return false; } if (eventTargetNode->IsContent()) { eventTargetNode = eventTargetNode->AsContent()->FindFirstNonChromeOnlyAccessContent(); if (NS_WARN_IF(!eventTargetNode)) { return false; } } RefPtr<Document> document = GetDocument(); if (NS_WARN_IF(!document)) { return false; } if (IsInDesignMode()) { // If this editor is in designMode and the event target is the document, // the event is for this editor. if (eventTargetNode->IsDocument()) { return eventTargetNode == document; } // Otherwise, check whether the event target is in this document or not. if (NS_WARN_IF(!eventTargetNode->IsContent())) { return false; } if (document == eventTargetNode->GetUncomposedDoc()) { return true; } // If the event target is in a shadow tree, the content is not editable // by default, but if the focused content is an editing host, we need to // handle it as contenteditable mode. if (!eventTargetNode->IsInShadowTree()) { return false; } } // Space event for <button> and <summary> with contenteditable // should be handle by the themselves. if (aGUIEvent->mMessage == eKeyPress && aGUIEvent->AsKeyboardEvent()->ShouldWorkAsSpaceKey()) { nsGenericHTMLElement* element = HTMLButtonElement::FromNode(eventTargetNode); if (!element) { element = HTMLSummaryElement::FromNode(eventTargetNode); } if (element && element->IsContentEditable()) { return false; } } // This HTML editor is for contenteditable. We need to check the validity // of the target. if (NS_WARN_IF(!eventTargetNode->IsContent())) { return false; } // If the event is a mouse event, we need to check if the target content is // the focused editing host or its descendant. if (aGUIEvent->AsMouseEventBase()) { nsIContent* editingHost = ComputeEditingHost(); // If there is no active editing host, we cannot handle the mouse event // correctly. if (!editingHost) { return false; } // If clicked on non-editable root element but the body element is the // active editing host, we should assume that the click event is // targetted. if (eventTargetNode == document->GetRootElement() && !eventTargetNode->HasFlag(NODE_IS_EDITABLE) && editingHost == document->GetBodyElement()) { eventTargetNode = editingHost; } // If the target element is neither the active editing host nor a // descendant of it, we may not be able to handle the event. if (!eventTargetNode->IsInclusiveDescendantOf(editingHost)) { return false; } // If the clicked element has an independent selection, we shouldn't // handle this click event. if (eventTargetNode->AsContent()->HasIndependentSelection()) { return false; } // If the target content is editable, we should handle this event. return eventTargetNode->HasFlag(NODE_IS_EDITABLE); } // If the target of the other events which target focused element isn't // editable or has an independent selection, this editor shouldn't handle // the event. if (!eventTargetNode->HasFlag(NODE_IS_EDITABLE) || eventTargetNode->AsContent()->HasIndependentSelection()) { return false; } // Finally, check whether we're actually focused or not. When we're not // focused, we should ignore the dispatched event by script (or something) // because content editable element needs selection in itself for editing. // However, when we're not focused, it's not guaranteed. return IsActiveInDOMWindow(); } nsresult HTMLEditor::GetPreferredIMEState(IMEState* aState) { // HTML editor don't prefer the CSS ime-mode because IE didn't do so too. aState->mOpen = IMEState::DONT_CHANGE_OPEN_STATE; if (IsReadonly()) { aState->mEnabled = IMEEnabled::Disabled; } else { aState->mEnabled = IMEEnabled::Enabled; } return NS_OK; } already_AddRefed<Element> HTMLEditor::GetInputEventTargetElement() const { RefPtr<Element> target = ComputeEditingHost(LimitInBodyElement::No); if (target) { return target.forget(); } // When there is no active editing host due to focus node is a // non-editable node, we should look for its editable parent to // dispatch `beforeinput` event. nsIContent* focusContent = nsIContent::FromNodeOrNull(SelectionRef().GetFocusNode()); if (!focusContent || focusContent->IsEditable()) { return nullptr; } for (Element* element : focusContent->AncestorsOfType<Element>()) { if (element->IsEditable()) { target = element->GetEditingHost(); return target.forget(); } } return nullptr; } nsresult HTMLEditor::OnModifyDocument() { MOZ_ASSERT(mPendingDocumentModifiedRunner, "HTMLEditor::OnModifyDocument() should be called via a runner"); mPendingDocumentModifiedRunner = nullptr; if (IsEditActionDataAvailable()) { return OnModifyDocumentInternal(); } AutoEditActionDataSetter editActionData( *this, EditAction::eCreatePaddingBRElementForEmptyEditor); if (NS_WARN_IF(!editActionData.CanHandle())) { return NS_ERROR_NOT_AVAILABLE; } nsresult rv = OnModifyDocumentInternal(); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "HTMLEditor::OnModifyDocumentInternal() failed"); return rv; } nsresult HTMLEditor::OnModifyDocumentInternal() { MOZ_ASSERT(IsEditActionDataAvailable()); MOZ_ASSERT(!mPendingDocumentModifiedRunner); // EnsureNoPaddingBRElementForEmptyEditor() below may cause a flush, which // could destroy the editor nsAutoScriptBlockerSuppressNodeRemoved scriptBlocker; // Delete our padding <br> element for empty editor, if we have one, since // the document might not be empty any more. nsresult rv = EnsureNoPaddingBRElementForEmptyEditor(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return rv; } NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "EditorBase::EnsureNoPaddingBRElementForEmptyEditor() " "failed, but ignored"); // Try to recreate the padding <br> element for empty editor if needed. rv = MaybeCreatePaddingBRElementForEmptyEditor(); if (NS_WARN_IF(rv == NS_ERROR_EDITOR_DESTROYED)) { return NS_ERROR_EDITOR_DESTROYED; } NS_WARNING_ASSERTION( NS_SUCCEEDED(rv), "EditorBase::MaybeCreatePaddingBRElementForEmptyEditor() failed"); return rv; } } // namespace mozilla