gecko-dev/editor/libeditor/HTMLTableEditor.cpp
Masayuki Nakano cb95d44ffc Bug 1500862 - part 3: Change all stack base helper classes which access protected members of EditorBase to nested classes of EditorBase r=m_kato
AutoTransactionBatch, AutoPlaceholderBatch, AutoSelectionRestorer,
AutoTopLevelEditSubActionNotifier, AutoTransactionsConserveSelection and
AutoUpdateViewBatch access protected members of EditorBase.  The access
scope management assume that they are used only by EditorBase or its
subclasses or TextEditRules or its inherited class (i.e., HTMLEditRules).

For guaranteeing this at build-time, we should change them to nested classes
of EditorBase.  Then, EditorBase and its subclasses and friends can use them.

Differential Revision: https://phabricator.services.mozilla.com/D9479

--HG--
extra : moz-landing-system : lando
2018-10-24 09:42:06 +00:00

4345 lines
140 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include <stdio.h>
#include "mozilla/HTMLEditor.h"
#include "HTMLEditUtils.h"
#include "mozilla/Assertions.h"
#include "mozilla/EditAction.h"
#include "mozilla/EditorDOMPoint.h"
#include "mozilla/EditorUtils.h"
#include "mozilla/FlushType.h"
#include "mozilla/dom/Selection.h"
#include "mozilla/dom/Element.h"
#include "nsAString.h"
#include "nsAlgorithm.h"
#include "nsCOMPtr.h"
#include "nsDebug.h"
#include "nsError.h"
#include "nsFrameSelection.h"
#include "nsGkAtoms.h"
#include "nsAtom.h"
#include "nsIContent.h"
#include "nsIFrame.h"
#include "nsINode.h"
#include "nsIPresShell.h"
#include "nsISupportsUtils.h"
#include "nsITableCellLayout.h" // For efficient access to table cell
#include "nsLiteralString.h"
#include "nsQueryFrame.h"
#include "nsRange.h"
#include "nsString.h"
#include "nsTArray.h"
#include "nsTableCellFrame.h"
#include "nsTableWrapperFrame.h"
#include "nscore.h"
#include <algorithm>
namespace mozilla {
using namespace dom;
/**
* Stack based helper class for restoring selection after table edit.
*/
class MOZ_STACK_CLASS AutoSelectionSetterAfterTableEdit final
{
private:
RefPtr<HTMLEditor> mHTMLEditor;
RefPtr<Element> mTable;
int32_t mCol, mRow, mDirection, mSelected;
public:
AutoSelectionSetterAfterTableEdit(HTMLEditor& aHTMLEditor,
Element* aTable,
int32_t aRow,
int32_t aCol,
int32_t aDirection,
bool aSelected)
: mHTMLEditor(&aHTMLEditor)
, mTable(aTable)
, mCol(aCol)
, mRow(aRow)
, mDirection(aDirection)
, mSelected(aSelected)
{
}
~AutoSelectionSetterAfterTableEdit()
{
if (mHTMLEditor) {
mHTMLEditor->SetSelectionAfterTableEdit(mTable, mRow, mCol, mDirection,
mSelected);
}
}
// This is needed to abort the caret reset in the destructor
// when one method yields control to another
void CancelSetCaret()
{
mHTMLEditor = nullptr;
mTable = nullptr;
}
};
nsresult
HTMLEditor::InsertCell(Element* aCell,
int32_t aRowSpan,
int32_t aColSpan,
bool aAfter,
bool aIsHeader,
Element** aNewCell)
{
if (aNewCell) {
*aNewCell = nullptr;
}
if (NS_WARN_IF(!aCell)) {
return NS_ERROR_NULL_POINTER;
}
// And the parent and offsets needed to do an insert
EditorDOMPoint pointToInsert(aCell);
if (NS_WARN_IF(!pointToInsert.IsSet())) {
return NS_ERROR_INVALID_ARG;
}
RefPtr<Element> newCell =
CreateElementWithDefaults(aIsHeader ? *nsGkAtoms::th : *nsGkAtoms::td);
if (NS_WARN_IF(!newCell)) {
return NS_ERROR_FAILURE;
}
//Optional: return new cell created
if (aNewCell) {
*aNewCell = do_AddRef(newCell).take();
}
if (aRowSpan > 1) {
// Note: Do NOT use editor transaction for this
nsAutoString newRowSpan;
newRowSpan.AppendInt(aRowSpan, 10);
newCell->SetAttr(kNameSpaceID_None, nsGkAtoms::rowspan, newRowSpan, true);
}
if (aColSpan > 1) {
// Note: Do NOT use editor transaction for this
nsAutoString newColSpan;
newColSpan.AppendInt(aColSpan, 10);
newCell->SetAttr(kNameSpaceID_None, nsGkAtoms::colspan, newColSpan, true);
}
if (aAfter) {
DebugOnly<bool> advanced = pointToInsert.AdvanceOffset();
NS_WARNING_ASSERTION(advanced,
"Failed to advance offset to after the old cell");
}
// Don't let Rules System change the selection.
AutoTransactionsConserveSelection dontChangeSelection(*this);
return InsertNodeWithTransaction(*newCell, pointToInsert);
}
nsresult
HTMLEditor::SetColSpan(Element* aCell,
int32_t aColSpan)
{
if (NS_WARN_IF(!aCell)) {
return NS_ERROR_INVALID_ARG;
}
nsAutoString newSpan;
newSpan.AppendInt(aColSpan, 10);
return SetAttributeWithTransaction(*aCell, *nsGkAtoms::colspan, newSpan);
}
nsresult
HTMLEditor::SetRowSpan(Element* aCell,
int32_t aRowSpan)
{
if (NS_WARN_IF(!aCell)) {
return NS_ERROR_INVALID_ARG;
}
nsAutoString newSpan;
newSpan.AppendInt(aRowSpan, 10);
return SetAttributeWithTransaction(*aCell, *nsGkAtoms::rowspan, newSpan);
}
NS_IMETHODIMP
HTMLEditor::InsertTableCell(int32_t aNumberOfCellsToInsert,
bool aInsertAfterSelectedCell)
{
nsresult rv =
InsertTableCellsWithTransaction(aNumberOfCellsToInsert,
aInsertAfterSelectedCell ? InsertPosition::eAfterSelectedCell :
InsertPosition::eBeforeSelectedCell);
if (NS_WARN_IF(NS_FAILED(rv))) {
return NS_ERROR_FAILURE;
}
return NS_OK;
}
nsresult
HTMLEditor::InsertTableCellsWithTransaction(int32_t aNumberOfCellsToInsert,
InsertPosition aInsertPosition)
{
RefPtr<Element> table;
RefPtr<Element> curCell;
nsCOMPtr<nsINode> cellParent;
int32_t cellOffset, startRowIndex, startColIndex;
nsresult rv = GetCellContext(nullptr,
getter_AddRefs(table),
getter_AddRefs(curCell),
getter_AddRefs(cellParent), &cellOffset,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!table) || NS_WARN_IF(!curCell)) {
// Don't fail if no cell found.
return NS_OK;
}
// Get more data for current cell in row we are inserting at since we need
// colspan value.
IgnoredErrorResult ignoredError;
CellData cellDataAtSelection(*this, *table, startRowIndex, startColIndex,
ignoredError);
if (NS_WARN_IF(cellDataAtSelection.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
MOZ_ASSERT(curCell == cellDataAtSelection.mElement);
int32_t newCellIndex;
switch (aInsertPosition) {
case InsertPosition::eBeforeSelectedCell:
newCellIndex = cellDataAtSelection.mCurrent.mColumn;
break;
case InsertPosition::eAfterSelectedCell:
MOZ_ASSERT(!cellDataAtSelection.IsSpannedFromOtherRowOrColumn());
newCellIndex = cellDataAtSelection.NextColumnIndex();
break;
default:
MOZ_ASSERT_UNREACHABLE("Invalid InsertPosition");
}
// We control selection resetting after the insert.
AutoSelectionSetterAfterTableEdit setCaret(*this, table,
cellDataAtSelection.mCurrent.mRow,
newCellIndex, ePreviousColumn,
false);
// So, suppress Rules System selection munging.
AutoTransactionsConserveSelection dontChangeSelection(*this);
EditorDOMPoint pointToInsert(cellParent, cellOffset);
if (NS_WARN_IF(!pointToInsert.IsSet())) {
return NS_ERROR_FAILURE;
}
if (aInsertPosition == InsertPosition::eAfterSelectedCell) {
DebugOnly<bool> advanced = pointToInsert.AdvanceOffset();
NS_WARNING_ASSERTION(advanced,
"Faild to move insertion point after the cell");
}
for (int32_t i = 0; i < aNumberOfCellsToInsert; i++) {
RefPtr<Element> newCell = CreateElementWithDefaults(*nsGkAtoms::td);
if (NS_WARN_IF(!newCell)) {
return NS_ERROR_FAILURE;
}
AutoEditorDOMPointChildInvalidator lockOffset(pointToInsert);
rv = InsertNodeWithTransaction(*newCell, pointToInsert);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::GetFirstRow(Element* aTableOrElementInTable,
Element** aFirstRowElement)
{
if (NS_WARN_IF(!aTableOrElementInTable) || NS_WARN_IF(!aFirstRowElement)) {
return NS_ERROR_INVALID_ARG;
}
ErrorResult error;
RefPtr<Element> firstRowElement =
GetFirstTableRowElement(*aTableOrElementInTable, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
firstRowElement.forget(aFirstRowElement);
return NS_OK;
}
Element*
HTMLEditor::GetFirstTableRowElement(Element& aTableOrElementInTable,
ErrorResult& aRv) const
{
MOZ_ASSERT(!aRv.Failed());
Element* tableElement =
GetElementOrParentByTagNameInternal(*nsGkAtoms::table,
aTableOrElementInTable);
// If the element is not in <table>, return error.
if (NS_WARN_IF(!tableElement)) {
aRv.Throw(NS_ERROR_FAILURE);
return nullptr;
}
for (nsIContent* tableChild = tableElement->GetFirstChild();
tableChild;
tableChild = tableChild->GetNextSibling()) {
if (tableChild->IsHTMLElement(nsGkAtoms::tr)) {
// Found a row directly under <table>
return tableChild->AsElement();
}
// <table> can have table section elements like <tbody>. <tr> elements
// may be children of them.
if (tableChild->IsAnyOfHTMLElements(nsGkAtoms::tbody,
nsGkAtoms::thead,
nsGkAtoms::tfoot)) {
for (nsIContent* tableSectionChild = tableChild->GetFirstChild();
tableSectionChild;
tableSectionChild = tableSectionChild->GetNextSibling()) {
if (tableSectionChild->IsHTMLElement(nsGkAtoms::tr)) {
return tableSectionChild->AsElement();
}
}
}
}
// Don't return error when there is no <tr> element in the <table>.
return nullptr;
}
Element*
HTMLEditor::GetNextTableRowElement(Element& aTableRowElement,
ErrorResult& aRv) const
{
MOZ_ASSERT(!aRv.Failed());
if (NS_WARN_IF(!aTableRowElement.IsHTMLElement(nsGkAtoms::tr))) {
aRv.Throw(NS_ERROR_FAILURE);
return nullptr;
}
for (nsIContent* maybeNextRow = aTableRowElement.GetNextSibling();
maybeNextRow;
maybeNextRow = maybeNextRow->GetNextSibling()) {
if (maybeNextRow->IsHTMLElement(nsGkAtoms::tr)) {
return maybeNextRow->AsElement();
}
}
// In current table section (e.g., <tbody>), there is no <tr> element.
// Then, check the following table sections.
Element* parentElementOfRow = aTableRowElement.GetParentElement();
if (NS_WARN_IF(!parentElementOfRow)) {
aRv.Throw(NS_ERROR_FAILURE);
return nullptr;
}
// Basically, <tr> elements should be in table section elements even if
// they are not written in the source explicitly. However, for preventing
// cross table boundary, check it now.
if (parentElementOfRow->IsHTMLElement(nsGkAtoms::table)) {
// Don't return error since this means just not found.
return nullptr;
}
for (nsIContent* maybeNextTableSection = parentElementOfRow->GetNextSibling();
maybeNextTableSection;
maybeNextTableSection = maybeNextTableSection->GetNextSibling()) {
// If the sibling of parent of given <tr> is a table section element,
// check its children.
if (maybeNextTableSection->IsAnyOfHTMLElements(nsGkAtoms::tbody,
nsGkAtoms::thead,
nsGkAtoms::tfoot)) {
for (nsIContent* maybeNextRow = maybeNextTableSection->GetFirstChild();
maybeNextRow;
maybeNextRow = maybeNextRow->GetNextSibling()) {
if (maybeNextRow->IsHTMLElement(nsGkAtoms::tr)) {
return maybeNextRow->AsElement();
}
}
}
// I'm not sure whether this is a possible case since table section
// elements are created automatically. However, DOM API may create
// <tr> elements without table section elements. So, let's check it.
else if (maybeNextTableSection->IsHTMLElement(nsGkAtoms::tr)) {
return maybeNextTableSection->AsElement();
}
}
// Don't return error when the given <tr> element is the last <tr> element in
// the <table>.
return nullptr;
}
nsresult
HTMLEditor::GetLastCellInRow(nsINode* aRowNode,
nsINode** aCellNode)
{
NS_ENSURE_TRUE(aCellNode, NS_ERROR_NULL_POINTER);
*aCellNode = nullptr;
NS_ENSURE_TRUE(aRowNode, NS_ERROR_NULL_POINTER);
nsCOMPtr<nsINode> rowChild = aRowNode->GetLastChild();
while (rowChild && !HTMLEditUtils::IsTableCell(rowChild)) {
// Skip over textnodes
rowChild = rowChild->GetPreviousSibling();
}
if (rowChild) {
rowChild.forget(aCellNode);
return NS_OK;
}
// If here, cell was not found
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
NS_IMETHODIMP
HTMLEditor::InsertTableColumn(int32_t aNumberOfColumnsToInsert,
bool aInsertAfterSelectedCell)
{
nsresult rv =
InsertTableColumnsWithTransaction(aNumberOfColumnsToInsert,
aInsertAfterSelectedCell ? InsertPosition::eAfterSelectedCell :
InsertPosition::eBeforeSelectedCell);
if (NS_WARN_IF(NS_FAILED(rv))) {
return NS_ERROR_FAILURE;
}
return NS_OK;
}
nsresult
HTMLEditor::InsertTableColumnsWithTransaction(int32_t aNumberOfColumnsToInsert,
InsertPosition aInsertPosition)
{
RefPtr<Selection> selection;
RefPtr<Element> table;
RefPtr<Element> curCell;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(getter_AddRefs(selection),
getter_AddRefs(table),
getter_AddRefs(curCell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!table) || NS_WARN_IF(!curCell)) {
// Don't fail if no cell found.
return NS_OK;
}
// Get more data for current cell, we need rowspan value.
IgnoredErrorResult ignoredError;
CellData cellDataAtSelection(*this, *table, startRowIndex, startColIndex,
ignoredError);
if (NS_WARN_IF(cellDataAtSelection.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
MOZ_ASSERT(curCell == cellDataAtSelection.mElement);
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Should not be empty since we've already found a cell.
MOZ_ASSERT(!tableSize.IsEmpty());
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent auto insertion of <br> element in new cell until we're done.
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eInsertNode,
nsIEditor::eNext);
switch (aInsertPosition) {
case InsertPosition::eBeforeSelectedCell:
break;
case InsertPosition::eAfterSelectedCell:
// Use column after current cell.
startColIndex += cellDataAtSelection.mEffectiveColSpan;
// Detect when user is adding after a colspan=0 case.
// Assume they want to stop the "0" behavior and really add a new column.
// Thus we set the colspan to its true value.
if (!cellDataAtSelection.mColSpan) {
SetColSpan(cellDataAtSelection.mElement,
cellDataAtSelection.mEffectiveColSpan);
}
break;
default:
MOZ_ASSERT_UNREACHABLE("Invalid InsertPosition");
}
// We control selection resetting after the insert.
AutoSelectionSetterAfterTableEdit setCaret(*this, table,
cellDataAtSelection.mCurrent.mRow,
startColIndex, ePreviousRow,
false);
// Suppress Rules System selection munging.
AutoTransactionsConserveSelection dontChangeSelection(*this);
// If we are inserting after all existing columns, make sure table is
// "well formed" before appending new column.
// XXX As far as I've tested, NormalizeTable() always fails to normalize
// non-rectangular table. So, the following CellData will fail if
// the table is not rectangle.
if (startColIndex >= tableSize.mColumnCount) {
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
DebugOnly<nsresult> rv = NormalizeTable(*selection, *table);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Failed to normalize the table");
}
RefPtr<Element> rowElement;
for (int32_t rowIndex = 0; rowIndex < tableSize.mRowCount; rowIndex++) {
if (startColIndex < tableSize.mColumnCount) {
// We are inserting before an existing column.
CellData cellData(*this, *table, rowIndex, startColIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// Don't fail entire process if we fail to find a cell (may fail just in
// particular rows with < adequate cells per row).
// XXX So, here wants to know whether the CellData actually failed above.
// Fix this later.
if (!cellData.mElement) {
continue;
}
if (cellData.IsSpannedFromOtherColumn()) {
// If we have a cell spanning this location, simply increase its
// colspan to keep table rectangular.
// Note: we do nothing if colsspan=0, since it should automatically
// span the new column.
if (cellData.mColSpan > 0) {
SetColSpan(cellData.mElement,
cellData.mColSpan + aNumberOfColumnsToInsert);
}
continue;
}
// Simply set selection to the current cell. So, we can let
// InsertTableCellsWithTransaction() do the work. Insert a new cell
// before current one.
selection->Collapse(RawRangeBoundary(cellData.mElement, 0), ignoredError);
NS_WARNING_ASSERTION(!ignoredError.Failed(),
"Failed to collapse Selection into the cell");
rv = InsertTableCellsWithTransaction(aNumberOfColumnsToInsert,
InsertPosition::eBeforeSelectedCell);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Failed to insert a cell element");
continue;
}
// Get current row and append new cells after last cell in row
if (!rowIndex) {
rowElement = GetFirstTableRowElement(*table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (NS_WARN_IF(!rowElement)) {
continue;
}
} else {
if (NS_WARN_IF(!rowElement)) {
// XXX Looks like that when rowIndex is 0, startColIndex is always
// same as or larger than tableSize.mColumnCount. Is it true?
return NS_ERROR_FAILURE;
}
rowElement = GetNextTableRowElement(*rowElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (NS_WARN_IF(!rowElement)) {
continue;
}
}
nsCOMPtr<nsINode> lastCellNode;
rv = GetLastCellInRow(rowElement, getter_AddRefs(lastCellNode));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!lastCellNode)) {
return NS_ERROR_FAILURE;
}
// Simply add same number of cells to each row. Although tempted to check
// cell indexes for current cell, the effects of colspan > 1 in some cells
// makes this futile. We must use NormalizeTable first to assure that
// there are cells in each cellmap location.
selection->Collapse(RawRangeBoundary(lastCellNode, 0), ignoredError);
NS_WARNING_ASSERTION(!ignoredError.Failed(),
"Failed to collapse Selection into the cell");
rv = InsertTableCellsWithTransaction(aNumberOfColumnsToInsert,
InsertPosition::eAfterSelectedCell);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Failed to insert a cell element");
}
// XXX This is perhaps the result of the last call of
// InsertTableCellsWithTransaction().
return rv;
}
NS_IMETHODIMP
HTMLEditor::InsertTableRow(int32_t aNumberOfRowsToInsert,
bool aInsertAfterSelectedCell)
{
nsresult rv =
InsertTableRowsWithTransaction(aNumberOfRowsToInsert,
aInsertAfterSelectedCell ? InsertPosition::eAfterSelectedCell :
InsertPosition::eBeforeSelectedCell);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::InsertTableRowsWithTransaction(int32_t aNumberOfRowsToInsert,
InsertPosition aInsertPosition)
{
RefPtr<Element> table;
RefPtr<Element> curCell;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(nullptr,
getter_AddRefs(table),
getter_AddRefs(curCell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!table) || NS_WARN_IF(!curCell)) {
// Don't fail if no cell found.
return NS_OK;
}
// Get more data for current cell in row we are inserting at because we need
// colspan.
IgnoredErrorResult ignoredError;
CellData cellDataAtSelection(*this, *table, startRowIndex, startColIndex,
ignoredError);
if (NS_WARN_IF(cellDataAtSelection.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
MOZ_ASSERT(curCell == cellDataAtSelection.mElement);
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Should not be empty since we've already found a cell.
MOZ_ASSERT(!tableSize.IsEmpty());
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent auto insertion of BR in new cell until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eInsertNode,
nsIEditor::eNext);
switch (aInsertPosition) {
case InsertPosition::eBeforeSelectedCell:
break;
case InsertPosition::eAfterSelectedCell:
// Use row after current cell.
startRowIndex += cellDataAtSelection.mEffectiveRowSpan;
// Detect when user is adding after a rowspan=0 case.
// Assume they want to stop the "0" behavior and really add a new row.
// Thus we set the rowspan to its true value.
if (!cellDataAtSelection.mRowSpan) {
SetRowSpan(cellDataAtSelection.mElement,
cellDataAtSelection.mEffectiveRowSpan);
}
break;
default:
MOZ_ASSERT_UNREACHABLE("Invalid InsertPosition");
}
// We control selection resetting after the insert.
AutoSelectionSetterAfterTableEdit setCaret(
*this, table, startRowIndex, cellDataAtSelection.mCurrent.mColumn,
ePreviousColumn, false);
// Suppress Rules System selection munging.
AutoTransactionsConserveSelection dontChangeSelection(*this);
RefPtr<Element> cellForRowParent;
int32_t cellsInRow = 0;
if (startRowIndex < tableSize.mRowCount) {
// We are inserting above an existing row. Get each cell in the insert
// row to adjust for colspan effects while we count how many cells are
// needed.
CellData cellData;
for (int32_t colIndex = 0;; colIndex = cellData.NextColumnIndex()) {
cellData.Update(*this, *table, startRowIndex, colIndex, ignoredError);
if (cellData.FailedOrNotFound()) {
break; // Perhaps, we reach end of the row.
}
// XXX So, this is impossible case. Will be removed.
if (NS_WARN_IF(!cellData.mElement)) {
break;
}
if (cellData.IsSpannedFromOtherRow()) {
// We have a cell spanning this location. Increase its rowspan.
// Note that if rowspan is 0, we do nothing since that cell should
// automatically extend into the new row.
if (cellData.mRowSpan > 0) {
SetRowSpan(cellData.mElement,
cellData.mRowSpan + aNumberOfRowsToInsert);
}
continue;
}
cellsInRow += cellData.mEffectiveColSpan;
if (!cellForRowParent) {
// FYI: Don't use std::move() here since NextColumnIndex() needs it.
cellForRowParent = cellData.mElement;
}
MOZ_ASSERT(colIndex < cellData.NextColumnIndex());
}
} else {
// We are adding a new row after all others. If it weren't for colspan=0
// effect, we could simply use tableSize.mColumnCount for number of new
// cells...
// XXX colspan=0 support has now been removed in table layout so maybe this
// can be cleaned up now? (bug 1243183)
cellsInRow = tableSize.mColumnCount;
// but we must compensate for all cells with rowspan = 0 in the last row.
const int32_t kLastRowIndex = tableSize.mRowCount - 1;
CellData cellData;
for (int32_t colIndex = 0;; colIndex = cellData.NextColumnIndex()) {
cellData.Update(*this, *table, kLastRowIndex, colIndex, ignoredError);
if (cellData.FailedOrNotFound()) {
break; // Perhaps, we reach end of the row.
}
if (!cellData.mRowSpan) {
MOZ_ASSERT(cellsInRow >= cellData.mEffectiveColSpan);
cellsInRow -= cellData.mEffectiveColSpan;
}
// Save cell from the last row that we will use below
if (!cellForRowParent && !cellData.IsSpannedFromOtherRow()) {
// FYI: Don't use std::move() here since NextColumnIndex() needs it.
cellForRowParent = cellData.mElement;
}
MOZ_ASSERT(colIndex < cellData.NextColumnIndex());
}
}
if (NS_WARN_IF(!cellsInRow)) {
// There is no cell element in the last row??
return NS_OK;
}
if (NS_WARN_IF(!cellForRowParent)) {
return NS_ERROR_FAILURE;
}
Element* parentRow =
GetElementOrParentByTagNameInternal(*nsGkAtoms::tr, *cellForRowParent);
if (NS_WARN_IF(!parentRow)) {
return NS_ERROR_FAILURE;
}
// The row parent and offset where we will insert new row.
EditorDOMPoint pointToInsert(parentRow);
if (NS_WARN_IF(!pointToInsert.IsSet())) {
return NS_ERROR_FAILURE;
}
// Adjust for when adding past the end.
if (aInsertPosition == InsertPosition::eAfterSelectedCell &&
startRowIndex >= tableSize.mRowCount) {
DebugOnly<bool> advanced = pointToInsert.AdvanceOffset();
NS_WARNING_ASSERTION(advanced, "Failed to advance offset");
}
for (int32_t row = 0; row < aNumberOfRowsToInsert; row++) {
// Create a new row
RefPtr<Element> newRow = CreateElementWithDefaults(*nsGkAtoms::tr);
if (NS_WARN_IF(!newRow)) {
return NS_ERROR_FAILURE;
}
for (int32_t i = 0; i < cellsInRow; i++) {
RefPtr<Element> newCell = CreateElementWithDefaults(*nsGkAtoms::td);
if (NS_WARN_IF(!newCell)) {
return NS_ERROR_FAILURE;
}
newRow->AppendChild(*newCell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
}
AutoEditorDOMPointChildInvalidator lockOffset(pointToInsert);
rv = InsertNodeWithTransaction(*newRow, pointToInsert);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
// SetSelectionAfterTableEdit from AutoSelectionSetterAfterTableEdit will
// access frame selection, so we need reframe.
// Because GetTableCellElementAt() depends on frame.
nsCOMPtr<nsIPresShell> presShell = GetPresShell();
if (presShell) {
presShell->FlushPendingNotifications(FlushType::Frames);
}
return NS_OK;
}
nsresult
HTMLEditor::DeleteTableElementAndChildrenWithTransaction(Selection& aSelection,
Element& aTableElement)
{
// Block selectionchange event. It's enough to dispatch selectionchange
// event immediately after removing the table element.
{
AutoHideSelectionChanges hideSelection(&aSelection);
// Select the <table> element after clear current selection.
if (aSelection.RangeCount()) {
nsresult rv = aSelection.RemoveAllRangesTemporarily();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
RefPtr<nsRange> range = new nsRange(&aTableElement);
ErrorResult error;
range->SelectNode(aTableElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
aSelection.AddRange(*range, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
#ifdef DEBUG
range = aSelection.GetRangeAt(0);
MOZ_ASSERT(range);
MOZ_ASSERT(range->GetStartContainer() == aTableElement.GetParent());
MOZ_ASSERT(range->GetEndContainer() == aTableElement.GetParent());
MOZ_ASSERT(range->GetChildAtStartOffset() == &aTableElement);
MOZ_ASSERT(range->GetChildAtEndOffset() == aTableElement.GetNextSibling());
#endif // #ifdef DEBUG
}
nsresult rv = DeleteSelectionAsSubAction(eNext, eStrip);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::DeleteTable()
{
RefPtr<Selection> selection;
RefPtr<Element> table;
nsresult rv = GetCellContext(getter_AddRefs(selection),
getter_AddRefs(table),
nullptr, nullptr, nullptr, nullptr, nullptr);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!selection) || NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
rv = DeleteTableElementAndChildrenWithTransaction(*selection, *table);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::DeleteTableCell(int32_t aNumberOfCellsToDelete)
{
nsresult rv = DeleteTableCellWithTransaction(aNumberOfCellsToDelete);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::DeleteTableCellWithTransaction(int32_t aNumberOfCellsToDelete)
{
RefPtr<Selection> selection;
RefPtr<Element> table;
RefPtr<Element> cell;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(getter_AddRefs(selection),
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!table) || NS_WARN_IF(!cell)) {
// Don't fail if we didn't find a table or cell.
return NS_OK;
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent rules testing until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eDeleteNode,
nsIEditor::eNext);
ErrorResult error;
RefPtr<Element> firstSelectedCellElement =
GetFirstSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
MOZ_ASSERT(selection->RangeCount());
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
MOZ_ASSERT(!tableSize.IsEmpty());
// If only one cell is selected or no cell is selected, remove cells
// starting from the first selected cell or a cell containing first
// selection range.
if (!firstSelectedCellElement || selection->RangeCount() == 1) {
for (int32_t i = 0; i < aNumberOfCellsToDelete; i++) {
rv = GetCellContext(getter_AddRefs(selection),
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!table) || NS_WARN_IF(!cell)) {
// Don't fail if no cell found
return NS_OK;
}
int32_t numberOfCellsInRow = GetNumberOfCellsInRow(*table, startRowIndex);
NS_WARNING_ASSERTION(numberOfCellsInRow >= 0,
"Failed to count number of cells in the row");
if (numberOfCellsInRow == 1) {
// Remove <tr> or <table> if we're removing all cells in the row or
// the table.
if (tableSize.mRowCount == 1) {
rv = DeleteTableElementAndChildrenWithTransaction(*selection, *table);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
// We need to call DeleteSelectedTableRowsWithTransaction() to handle
// cells with rowspan attribute.
rv = DeleteSelectedTableRowsWithTransaction(1);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Adjust table rows simply. In strictly speaking, we should
// recompute table size with the latest layout information since
// mutation event listener may have changed the DOM tree. However,
// this is not in usual path of Firefox. So, we can assume that
// there are no mutation event listeners.
MOZ_ASSERT(tableSize.mRowCount);
tableSize.mRowCount--;
continue;
}
// The setCaret object will call AutoSelectionSetterAfterTableEdit in its
// destructor
AutoSelectionSetterAfterTableEdit setCaret(*this, table, startRowIndex,
startColIndex,
ePreviousColumn, false);
AutoTransactionsConserveSelection dontChangeSelection(*this);
// XXX Removing cell element causes not adjusting colspan.
rv = DeleteNodeWithTransaction(*cell);
// If we fail, don't try to delete any more cells???
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Note that we don't refer column number in this loop. So, it must
// be safe not to recompute table size since number of row is synced
// above.
}
return NS_OK;
}
// When 2 or more cells are selected, ignore aNumberOfCellsToRemove and
// remove all selected cells.
CellIndexes firstCellIndexes(*firstSelectedCellElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
cell = firstSelectedCellElement;
startRowIndex = firstCellIndexes.mRow;
startColIndex = firstCellIndexes.mColumn;
// The setCaret object will call AutoSelectionSetterAfterTableEdit in its
// destructor
AutoSelectionSetterAfterTableEdit setCaret(*this, table, startRowIndex,
startColIndex, ePreviousColumn,
false);
AutoTransactionsConserveSelection dontChangeSelection(*this);
bool checkToDeleteRow = true;
bool checkToDeleteColumn = true;
while (cell) {
if (checkToDeleteRow) {
// Optimize to delete an entire row
// Clear so we don't repeat AllCellsInRowSelected within the same row
checkToDeleteRow = false;
if (AllCellsInRowSelected(table, startRowIndex, tableSize.mColumnCount)) {
// First, find the next cell in a different row to continue after we
// delete this row.
int32_t nextRow = startRowIndex;
while (nextRow == startRowIndex) {
cell = GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!cell) {
break;
}
CellIndexes nextSelectedCellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
nextRow = nextSelectedCellIndexes.mRow;
startColIndex = nextSelectedCellIndexes.mColumn;
}
if (tableSize.mRowCount == 1) {
rv = DeleteTableElementAndChildrenWithTransaction(*selection, *table);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
rv = DeleteTableRowWithTransaction(*table, startRowIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Adjust table rows simply. In strictly speaking, we should
// recompute table size with the latest layout information since
// mutation event listener may have changed the DOM tree. However,
// this is not in usual path of Firefox. So, we can assume that
// there are no mutation event listeners.
MOZ_ASSERT(tableSize.mRowCount);
tableSize.mRowCount--;
if (!cell) {
break;
}
// For the next cell: Subtract 1 for row we deleted
startRowIndex = nextRow - 1;
// Set true since we know we will look at a new row next
checkToDeleteRow = true;
continue;
}
}
if (checkToDeleteColumn) {
// Optimize to delete an entire column
// Clear this so we don't repeat AllCellsInColSelected within the same Col
checkToDeleteColumn = false;
if (AllCellsInColumnSelected(table, startColIndex,
tableSize.mColumnCount)) {
// First, find the next cell in a different column to continue after
// we delete this column.
int32_t nextCol = startColIndex;
while (nextCol == startColIndex) {
cell = GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!cell) {
break;
}
CellIndexes nextSelectedCellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
startRowIndex = nextSelectedCellIndexes.mRow;
nextCol = nextSelectedCellIndexes.mColumn;
}
// Delete all cells which belong to the column.
rv = DeleteTableColumnWithTransaction(*table, startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Adjust table columns simply. In strictly speaking, we should
// recompute table size with the latest layout information since
// mutation event listener may have changed the DOM tree. However,
// this is not in usual path of Firefox. So, we can assume that
// there are no mutation event listeners.
MOZ_ASSERT(tableSize.mColumnCount);
tableSize.mColumnCount--;
if (!cell) {
break;
}
// For the next cell, subtract 1 for col. deleted
startColIndex = nextCol - 1;
// Set true since we know we will look at a new column next
checkToDeleteColumn = true;
continue;
}
}
// First get the next cell to delete
RefPtr<Element> nextCell =
GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Then delete the cell
rv = DeleteNodeWithTransaction(*cell);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (!nextCell) {
return NS_OK;
}
CellIndexes nextCellIndexes(*nextCell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
startRowIndex = nextCellIndexes.mRow;
startColIndex = nextCellIndexes.mColumn;
cell = std::move(nextCell);
// When table cell is removed, table size of column may be changed.
// For example, if there are 2 rows, one has 2 cells, the other has
// 3 cells, tableSize.mColumnCount is 3. When this removes a cell
// in the latter row, mColumnCount should be come 2. However, we
// don't use mColumnCount in this loop, so, this must be okay for now.
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::DeleteTableCellContents()
{
nsresult rv = DeleteTableCellContentsWithTransaction();
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::DeleteTableCellContentsWithTransaction()
{
RefPtr<Selection> selection;
RefPtr<Element> table;
RefPtr<Element> cell;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(getter_AddRefs(selection),
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!selection) || NS_WARN_IF(!cell)) {
// Don't fail if no cell found.
return NS_OK;
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent rules testing until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eDeleteNode,
nsIEditor::eNext);
// Don't let Rules System change the selection
AutoTransactionsConserveSelection dontChangeSelection(*this);
ErrorResult error;
RefPtr<Element> firstSelectedCellElement =
GetFirstSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (firstSelectedCellElement) {
CellIndexes firstCellIndexes(*firstSelectedCellElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
cell = firstSelectedCellElement;
startRowIndex = firstCellIndexes.mRow;
startColIndex = firstCellIndexes.mColumn;
}
AutoSelectionSetterAfterTableEdit setCaret(*this, table, startRowIndex,
startColIndex, ePreviousColumn,
false);
while (cell) {
DebugOnly<nsresult> rv = DeleteAllChildrenWithTransaction(*cell);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv),
"Failed to remove all children of the cell element");
// If selection is not in cell-select mode, we should remove only the cell
// which contains first selection range.
if (!firstSelectedCellElement) {
return NS_OK;
}
// If there are 2 or more selected cells, keep handling the other selected
// cells.
cell = GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::DeleteTableColumn(int32_t aNumberOfColumnsToDelete)
{
nsresult rv =
DeleteSelectedTableColumnsWithTransaction(aNumberOfColumnsToDelete);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::DeleteSelectedTableColumnsWithTransaction(
int32_t aNumberOfColumnsToDelete)
{
RefPtr<Selection> selection;
RefPtr<Element> table;
RefPtr<Element> cell;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(getter_AddRefs(selection),
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!selection) || NS_WARN_IF(!table) || NS_WARN_IF(!cell)) {
// Don't fail if no cell found.
return NS_OK;
}
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent rules testing until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eDeleteNode,
nsIEditor::eNext);
// Shortcut the case of deleting all columns in table
if (!startColIndex && aNumberOfColumnsToDelete >= tableSize.mColumnCount) {
rv = DeleteTableElementAndChildrenWithTransaction(*selection, *table);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
// Test if deletion is controlled by selected cells
RefPtr<Element> firstSelectedCellElement =
GetFirstSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
MOZ_ASSERT(selection->RangeCount());
if (firstSelectedCellElement && selection->RangeCount() > 1) {
CellIndexes firstCellIndexes(*firstSelectedCellElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
startRowIndex = firstCellIndexes.mRow;
startColIndex = firstCellIndexes.mColumn;
}
// We control selection resetting after the insert...
AutoSelectionSetterAfterTableEdit setCaret(*this, table, startRowIndex,
startColIndex, ePreviousRow,
false);
// If 2 or more cells are not selected, removing columns starting from
// a column which contains first selection range.
if (!firstSelectedCellElement || selection->RangeCount() == 1) {
int32_t columnCountToRemove =
std::min(aNumberOfColumnsToDelete,
tableSize.mColumnCount - startColIndex);
for (int32_t i = 0; i < columnCountToRemove; i++) {
rv = DeleteTableColumnWithTransaction(*table, startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return NS_OK;
}
// If 2 or more cells are selected, remove all columns which contain selected
// cells. I.e., we ignore aNumberOfColumnsToDelete in this case.
for (cell = firstSelectedCellElement; cell;) {
if (cell != firstSelectedCellElement) {
CellIndexes cellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
startRowIndex = cellIndexes.mRow;
startColIndex = cellIndexes.mColumn;
}
// Find the next cell in a different column
// to continue after we delete this column
int32_t nextCol = startColIndex;
while (nextCol == startColIndex) {
cell = GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!cell) {
break;
}
CellIndexes cellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
startRowIndex = cellIndexes.mRow;
nextCol = cellIndexes.mColumn;
}
rv = DeleteTableColumnWithTransaction(*table, startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return NS_OK;
}
nsresult
HTMLEditor::DeleteTableColumnWithTransaction(Element& aTableElement,
int32_t aColumnIndex)
{
// XXX Why don't this method remove proper <col> (and <colgroup>)?
ErrorResult error;
IgnoredErrorResult ignoredError;
for (int32_t rowIndex = 0;; rowIndex++) {
CellData cellData(*this, aTableElement, rowIndex, aColumnIndex,
ignoredError);
// Failure means that there is no more row in the table. In this case,
// we shouldn't return error since we just reach the end of the table.
// XXX Should distinguish whether CellData returns error or just not found
// later.
if (cellData.FailedOrNotFound()) {
return NS_OK;
}
// Find cells that don't start in column we are deleting.
MOZ_ASSERT(cellData.mColSpan >= 0);
if (cellData.IsSpannedFromOtherColumn() || cellData.mColSpan != 1) {
// If we have a cell spanning this location, decrease its colspan to
// keep table rectangular, but if colspan is 0, it'll be adjusted
// automatically.
if (cellData.mColSpan > 0) {
NS_WARNING_ASSERTION(cellData.mColSpan > 1,
"colspan should be 2 or larger");
SetColSpan(cellData.mElement, cellData.mColSpan - 1);
}
if (!cellData.IsSpannedFromOtherColumn()) {
// Cell is in column to be deleted, but must have colspan > 1,
// so delete contents of cell instead of cell itself (We must have
// reset colspan above).
DebugOnly<nsresult> rv =
DeleteAllChildrenWithTransaction(*cellData.mElement);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv),
"Failed to remove all children of the cell element");
}
// Skip rows which the removed cell spanned.
rowIndex += cellData.NumberOfFollowingRows();
continue;
}
// Delete the cell
int32_t numberOfCellsInRow =
GetNumberOfCellsInRow(aTableElement, cellData.mCurrent.mRow);
NS_WARNING_ASSERTION(numberOfCellsInRow > 0,
"Failed to count existing cells in the row");
if (numberOfCellsInRow != 1) {
// If removing cell is not the last cell of the row, we can just remove
// it.
nsresult rv = DeleteNodeWithTransaction(*cellData.mElement);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Skip rows which the removed cell spanned.
rowIndex += cellData.NumberOfFollowingRows();
continue;
}
// When the cell is the last cell in the row, remove the row instead.
Element* parentRow =
GetElementOrParentByTagNameInternal(*nsGkAtoms::tr, *cellData.mElement);
if (NS_WARN_IF(!parentRow)) {
return NS_ERROR_FAILURE;
}
// Check if its the only row left in the table. If so, we can delete
// the table instead.
TableSize tableSize(*this, aTableElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (tableSize.mRowCount == 1) {
// We're deleting the last row. So, let's remove the <table> now.
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
nsresult rv =
DeleteTableElementAndChildrenWithTransaction(*selection, aTableElement);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
// Delete the row by placing caret in cell we were to delete. We need
// to call DeleteTableRowWithTransaction() to handle cells with rowspan.
nsresult rv =
DeleteTableRowWithTransaction(aTableElement, cellData.mFirst.mRow);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Note that we decrement rowIndex since a row was deleted.
rowIndex--;
}
}
NS_IMETHODIMP
HTMLEditor::DeleteTableRow(int32_t aNumberOfRowsToDelete)
{
nsresult rv = DeleteSelectedTableRowsWithTransaction(aNumberOfRowsToDelete);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::DeleteSelectedTableRowsWithTransaction(
int32_t aNumberOfRowsToDelete)
{
RefPtr<Selection> selection;
RefPtr<Element> table;
RefPtr<Element> cell;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(getter_AddRefs(selection),
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!selection) || NS_WARN_IF(!table) || NS_WARN_IF(!cell)) {
// Don't fail if no cell found.
return NS_OK;
}
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent rules testing until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eDeleteNode,
nsIEditor::eNext);
// Shortcut the case of deleting all rows in table
if (!startRowIndex && aNumberOfRowsToDelete >= tableSize.mRowCount) {
rv = DeleteTableElementAndChildrenWithTransaction(*selection, *table);
if (NS_WARN_IF(NS_FAILED(rv))) {
return NS_ERROR_FAILURE;
}
return NS_OK;
}
RefPtr<Element> firstSelectedCellElement =
GetFirstSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
MOZ_ASSERT(selection->RangeCount());
if (firstSelectedCellElement && selection->RangeCount() > 1) {
// Fetch indexes again - may be different for selected cells
CellIndexes firstCellIndexes(*firstSelectedCellElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
startRowIndex = firstCellIndexes.mRow;
startColIndex = firstCellIndexes.mColumn;
}
//We control selection resetting after the insert...
AutoSelectionSetterAfterTableEdit setCaret(*this, table, startRowIndex,
startColIndex, ePreviousRow,
false);
// Don't change selection during deletions
AutoTransactionsConserveSelection dontChangeSelection(*this);
// XXX Perhaps, the following loops should collect <tr> elements to remove
// first, then, remove them from the DOM tree since mutation event
// listener may change the DOM tree during the loops.
// If 2 or more cells are not selected, removing rows starting from
// a row which contains first selection range.
if (!firstSelectedCellElement || selection->RangeCount() == 1) {
int32_t rowCountToRemove =
std::min(aNumberOfRowsToDelete, tableSize.mRowCount - startRowIndex);
for (int32_t i = 0; i < rowCountToRemove; i++) {
nsresult rv = DeleteTableRowWithTransaction(*table, startRowIndex);
// If failed in current row, try the next
if (NS_WARN_IF(NS_FAILED(rv))) {
startRowIndex++;
}
// Check if there's a cell in the "next" row.
cell = GetTableCellElementAt(*table, startRowIndex, startColIndex);
if (!cell) {
return NS_OK;
}
}
return NS_OK;
}
// If 2 or more cells are selected, remove all rows which contain selected
// cells. I.e., we ignore aNumberOfRowsToDelete in this case.
for (cell = firstSelectedCellElement; cell;) {
if (cell != firstSelectedCellElement) {
CellIndexes cellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
startRowIndex = cellIndexes.mRow;
startColIndex = cellIndexes.mColumn;
}
// Find the next cell in a different row
// to continue after we delete this row
int32_t nextRow = startRowIndex;
while (nextRow == startRowIndex) {
cell = GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!cell) {
break;
}
CellIndexes cellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
nextRow = cellIndexes.mRow;
startColIndex = cellIndexes.mColumn;
}
// Delete the row containing selected cell(s).
rv = DeleteTableRowWithTransaction(*table, startRowIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return NS_OK;
}
// Helper that doesn't batch or change the selection
nsresult
HTMLEditor::DeleteTableRowWithTransaction(Element& aTableElement,
int32_t aRowIndex)
{
ErrorResult error;
TableSize tableSize(*this, aTableElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Prevent rules testing until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(*
this, EditSubAction::eDeleteNode,
nsIEditor::eNext);
// Scan through cells in row to do rowspan adjustments
// Note that after we delete row, startRowIndex will point to the cells in
// the next row to be deleted.
// The list of cells we will change rowspan in and the new rowspan values
// for each.
struct MOZ_STACK_CLASS SpanCell final
{
RefPtr<Element> mElement;
int32_t mNewRowSpanValue;
SpanCell(Element* aSpanCellElement,
int32_t aNewRowSpanValue)
: mElement(aSpanCellElement)
, mNewRowSpanValue(aNewRowSpanValue)
{
}
};
AutoTArray<SpanCell, 10> spanCellArray;
RefPtr<Element> cellInDeleteRow;
int32_t columnIndex = 0;
IgnoredErrorResult ignoredError;
while (aRowIndex < tableSize.mRowCount &&
columnIndex < tableSize.mColumnCount) {
CellData cellData(*this, aTableElement, aRowIndex, columnIndex,
ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// XXX So, we should distinguish if CellDate returns error or just not
// found later.
if (!cellData.mElement) {
break;
}
// Compensate for cells that don't start or extend below the row we are
// deleting.
if (cellData.IsSpannedFromOtherRow()) {
// If a cell starts in row above us, decrease its rowspan to keep table
// rectangular but we don't need to do this if rowspan=0, since it will
// be automatically adjusted.
if (cellData.mRowSpan > 0) {
// Build list of cells to change rowspan. We can't do it now since
// it upsets cell map, so we will do it after deleting the row.
int32_t newRowSpanValue =
std::max(cellData.NumberOfPrecedingRows(),
cellData.NumberOfFollowingRows());
spanCellArray.AppendElement(
SpanCell(cellData.mElement, newRowSpanValue));
}
} else {
if (cellData.mRowSpan > 1) {
// Cell spans below row to delete, so we must insert new cells to
// keep rows below. Note that we test "rowSpan" so we don't do this
// if rowSpan = 0 (automatic readjustment).
int32_t aboveRowToInsertNewCellInto =
cellData.NumberOfPrecedingRows() + 1;
nsresult rv =
SplitCellIntoRows(&aTableElement,
cellData.mFirst.mRow, cellData.mFirst.mColumn,
aboveRowToInsertNewCellInto,
cellData.NumberOfFollowingRows(), nullptr);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
if (!cellInDeleteRow) {
// Reference cell to find row to delete.
cellInDeleteRow = std::move(cellData.mElement);
}
}
// Skip over other columns spanned by this cell
columnIndex += cellData.mEffectiveColSpan;
}
// Things are messed up if we didn't find a cell in the row!
if (NS_WARN_IF(!cellInDeleteRow)) {
return NS_ERROR_FAILURE;
}
// Delete the entire row.
RefPtr<Element> parentRow =
GetElementOrParentByTagNameInternal(*nsGkAtoms::tr, *cellInDeleteRow);
if (parentRow) {
nsresult rv = DeleteNodeWithTransaction(*parentRow);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
// Now we can set new rowspans for cells stored above.
for (SpanCell& spanCell : spanCellArray) {
if (NS_WARN_IF(!spanCell.mElement)) {
continue;
}
nsresult rv = SetRowSpan(spanCell.mElement, spanCell.mNewRowSpanValue);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::SelectTable()
{
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_OK; // Don't fail if we didn't find a table.
}
RefPtr<Element> table =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::table);
if (NS_WARN_IF(!table)) {
return NS_OK; // Don't fail if we didn't find a table.
}
nsresult rv = ClearSelection();
if (NS_FAILED(rv)) {
return rv;
}
return AppendNodeToSelectionAsRange(table);
}
NS_IMETHODIMP
HTMLEditor::SelectTableCell()
{
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
RefPtr<Element> cell =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::td);
if (NS_WARN_IF(!cell)) {
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
nsresult rv = ClearSelection();
if (NS_FAILED(rv)) {
return rv;
}
return AppendNodeToSelectionAsRange(cell);
}
NS_IMETHODIMP
HTMLEditor::SelectBlockOfCells(Element* aStartCell,
Element* aEndCell)
{
if (NS_WARN_IF(!aStartCell) || NS_WARN_IF(!aEndCell)) {
return NS_ERROR_INVALID_ARG;
}
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
RefPtr<Element> table =
GetElementOrParentByTagNameInternal(*nsGkAtoms::table, *aStartCell);
if (NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
RefPtr<Element> endTable =
GetElementOrParentByTagNameInternal(*nsGkAtoms::table, *aEndCell);
if (NS_WARN_IF(!endTable)) {
return NS_ERROR_FAILURE;
}
// We can only select a block if within the same table,
// so do nothing if not within one table
if (table != endTable) {
return NS_OK;
}
ErrorResult error;
CellIndexes startCellIndexes(*aStartCell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
CellIndexes endCellIndexes(*aEndCell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Suppress nsISelectionListener notification
// until all selection changes are finished
SelectionBatcher selectionBatcher(selection);
// Examine all cell nodes in current selection and
// remove those outside the new block cell region
int32_t minColumn =
std::min(startCellIndexes.mColumn, endCellIndexes.mColumn);
int32_t minRow =
std::min(startCellIndexes.mRow, endCellIndexes.mRow);
int32_t maxColumn =
std::max(startCellIndexes.mColumn, endCellIndexes.mColumn);
int32_t maxRow =
std::max(startCellIndexes.mRow, endCellIndexes.mRow);
RefPtr<Element> cell;
cell = GetFirstSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!cell) {
return NS_OK;
}
RefPtr<nsRange> range = selection->GetRangeAt(0);
MOZ_ASSERT(range);
while (cell) {
CellIndexes currentCellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (currentCellIndexes.mRow < maxRow ||
currentCellIndexes.mRow > maxRow ||
currentCellIndexes.mColumn < maxColumn ||
currentCellIndexes.mColumn > maxColumn) {
selection->RemoveRange(*range, IgnoreErrors());
// Since we've removed the range, decrement pointer to next range
MOZ_ASSERT(mSelectedCellIndex > 0);
mSelectedCellIndex--;
}
cell = GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (cell) {
MOZ_ASSERT(mSelectedCellIndex > 0);
range = selection->GetRangeAt(mSelectedCellIndex - 1);
}
}
nsresult rv = NS_OK;
IgnoredErrorResult ignoredError;
for (int32_t row = minRow; row <= maxRow; row++) {
CellData cellData;
for (int32_t col = minColumn;
col <= maxColumn;
col = cellData.NextColumnIndex()) {
cellData.Update(*this, *table, row, col, ignoredError);
if (cellData.FailedOrNotFound()) {
return NS_ERROR_FAILURE;
}
// Skip cells that already selected or are spanned from previous locations
// XXX So, we should distinguish whether CellData returns error or just
// not found later.
if (!cellData.mIsSelected && cellData.mElement &&
!cellData.IsSpannedFromOtherRowOrColumn()) {
rv = AppendNodeToSelectionAsRange(cellData.mElement);
if (NS_FAILED(rv)) {
break;
}
}
MOZ_ASSERT(col < cellData.NextColumnIndex());
}
}
// NS_OK, otherwise, the last failure of AppendNodeToSelectionAsRange().
return rv;
}
NS_IMETHODIMP
HTMLEditor::SelectAllTableCells()
{
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
RefPtr<Element> cell =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::td);
if (NS_WARN_IF(!cell)) {
// Don't fail if we didn't find a cell.
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
RefPtr<Element> startCell = cell;
// Get parent table
RefPtr<Element> table =
GetElementOrParentByTagNameInternal(*nsGkAtoms::table, *cell);
if (NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Suppress nsISelectionListener notification
// until all selection changes are finished
SelectionBatcher selectionBatcher(selection);
// It is now safe to clear the selection
// BE SURE TO RESET IT BEFORE LEAVING!
nsresult rv = ClearSelection();
// Select all cells in the same column as current cell
bool cellSelected = false;
IgnoredErrorResult ignoredError;
for (int32_t row = 0; row < tableSize.mRowCount; row++) {
CellData cellData;
for (int32_t col = 0;
col < tableSize.mColumnCount;
col = cellData.NextColumnIndex()) {
cellData.Update(*this, *table, row, col, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
rv = NS_ERROR_FAILURE;
break;
}
// Skip cells that are spanned from previous rows or columns
// XXX So, we should distinguish whether CellData returns error or just
// not found later.
if (cellData.mElement &&
!cellData.IsSpannedFromOtherRowOrColumn()) {
rv = AppendNodeToSelectionAsRange(cellData.mElement);
if (NS_FAILED(rv)) {
break;
}
cellSelected = true;
}
MOZ_ASSERT(col < cellData.NextColumnIndex());
}
}
// Safety code to select starting cell if nothing else was selected
if (!cellSelected) {
return AppendNodeToSelectionAsRange(startCell);
}
// NS_OK, otherwise, the error of ClearSelection() when there is no column or
// the last failure of CellData or AppendNodeToSelectionAsRange().
return rv;
}
NS_IMETHODIMP
HTMLEditor::SelectTableRow()
{
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
// Don't fail if we didn't find a cell.
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
RefPtr<Element> cell =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::td);
if (NS_WARN_IF(!cell)) {
// Don't fail if we didn't find a cell.
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
RefPtr<Element> startCell = cell;
// Get table and location of cell:
RefPtr<Element> table;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(nullptr,
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
//Note: At this point, we could get first and last cells in row,
// then call SelectBlockOfCells, but that would take just
// a little less code, so the following is more efficient
// Suppress nsISelectionListener notification
// until all selection changes are finished
SelectionBatcher selectionBatcher(selection);
// It is now safe to clear the selection
// BE SURE TO RESET IT BEFORE LEAVING!
rv = ClearSelection();
// Select all cells in the same row as current cell
bool cellSelected = false;
IgnoredErrorResult ignoredError;
CellData cellData;
for (int32_t col = 0;
col < tableSize.mColumnCount;
col = cellData.NextColumnIndex()) {
cellData.Update(*this, *table, startRowIndex, col, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
rv = NS_ERROR_FAILURE;
break;
}
// Skip cells that are spanned from previous rows or columns
// XXX So, we should distinguish whether CellData returns error or just
// not found later.
if (cellData.mElement &&
!cellData.IsSpannedFromOtherRowOrColumn()) {
rv = AppendNodeToSelectionAsRange(cellData.mElement);
if (NS_FAILED(rv)) {
break;
}
cellSelected = true;
}
MOZ_ASSERT(col < cellData.NextColumnIndex());
}
// Safety code to select starting cell if nothing else was selected
if (!cellSelected) {
return AppendNodeToSelectionAsRange(startCell);
}
// NS_OK, otherwise, the error of ClearSelection() when there is no column or
// the last failure of CellData or AppendNodeToSelectionAsRange().
return rv;
}
NS_IMETHODIMP
HTMLEditor::SelectTableColumn()
{
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
// Don't fail if we didn't find a cell.
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
RefPtr<Element> cell =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::td);
if (NS_WARN_IF(!cell)) {
// Don't fail if we didn't find a cell.
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
RefPtr<Element> startCell = cell;
// Get location of cell:
RefPtr<Element> table;
int32_t startRowIndex, startColIndex;
nsresult rv = GetCellContext(nullptr,
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Suppress nsISelectionListener notification
// until all selection changes are finished
SelectionBatcher selectionBatcher(selection);
// It is now safe to clear the selection
// BE SURE TO RESET IT BEFORE LEAVING!
rv = ClearSelection();
// Select all cells in the same column as current cell
bool cellSelected = false;
IgnoredErrorResult ignoredError;
CellData cellData;
for (int32_t row = 0;
row < tableSize.mRowCount;
row = cellData.NextRowIndex()) {
cellData.Update(*this, *table, row, startColIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
rv = NS_ERROR_FAILURE;
break;
}
// Skip cells that are spanned from previous rows or columns
// XXX So, we should distinguish whether CellData returns error or just
// not found later.
if (cellData.mElement &&
!cellData.IsSpannedFromOtherRowOrColumn()) {
rv = AppendNodeToSelectionAsRange(cellData.mElement);
if (NS_FAILED(rv)) {
break;
}
cellSelected = true;
}
MOZ_ASSERT(row < cellData.NextRowIndex());
}
// Safety code to select starting cell if nothing else was selected
if (!cellSelected) {
return AppendNodeToSelectionAsRange(startCell);
}
// NS_OK, otherwise, the error of ClearSelection() when there is no row or
// the last failure of CellData or AppendNodeToSelectionAsRange().
return rv;
}
NS_IMETHODIMP
HTMLEditor::SplitTableCell()
{
RefPtr<Element> table;
RefPtr<Element> cell;
int32_t startRowIndex, startColIndex, actualRowSpan, actualColSpan;
// Get cell, table, etc. at selection anchor node
nsresult rv = GetCellContext(nullptr,
getter_AddRefs(table),
getter_AddRefs(cell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
NS_ENSURE_SUCCESS(rv, rv);
if (!table || !cell) {
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
// We need rowspan and colspan data
rv = GetCellSpansAt(table, startRowIndex, startColIndex,
actualRowSpan, actualColSpan);
NS_ENSURE_SUCCESS(rv, rv);
// Must have some span to split
if (actualRowSpan <= 1 && actualColSpan <= 1) {
return NS_OK;
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent auto insertion of BR in new cell until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eInsertNode,
nsIEditor::eNext);
// We reset selection
AutoSelectionSetterAfterTableEdit setCaret(*this, table, startRowIndex,
startColIndex, ePreviousColumn,
false);
//...so suppress Rules System selection munging
AutoTransactionsConserveSelection dontChangeSelection(*this);
RefPtr<Element> newCell;
int32_t rowIndex = startRowIndex;
int32_t rowSpanBelow, colSpanAfter;
// Split up cell row-wise first into rowspan=1 above, and the rest below,
// whittling away at the cell below until no more extra span
for (rowSpanBelow = actualRowSpan-1; rowSpanBelow >= 0; rowSpanBelow--) {
// We really split row-wise only if we had rowspan > 1
if (rowSpanBelow > 0) {
rv = SplitCellIntoRows(table, rowIndex, startColIndex, 1, rowSpanBelow,
getter_AddRefs(newCell));
NS_ENSURE_SUCCESS(rv, rv);
CopyCellBackgroundColor(newCell, cell);
}
int32_t colIndex = startColIndex;
// Now split the cell with rowspan = 1 into cells if it has colSpan > 1
for (colSpanAfter = actualColSpan-1; colSpanAfter > 0; colSpanAfter--) {
rv = SplitCellIntoColumns(table, rowIndex, colIndex, 1, colSpanAfter,
getter_AddRefs(newCell));
NS_ENSURE_SUCCESS(rv, rv);
CopyCellBackgroundColor(newCell, cell);
colIndex++;
}
// Point to the new cell and repeat
rowIndex++;
}
return NS_OK;
}
nsresult
HTMLEditor::CopyCellBackgroundColor(Element* aDestCell,
Element* aSourceCell)
{
if (NS_WARN_IF(!aDestCell) || NS_WARN_IF(!aSourceCell)) {
return NS_ERROR_INVALID_ARG;
}
// Copy backgournd color to new cell.
nsAutoString color;
bool isSet;
nsresult rv =
GetAttributeValue(aSourceCell, NS_LITERAL_STRING("bgcolor"),
color, &isSet);
if (NS_FAILED(rv)) {
return rv;
}
if (!isSet) {
return NS_OK;
}
return SetAttributeWithTransaction(*aDestCell, *nsGkAtoms::bgcolor, color);
}
nsresult
HTMLEditor::SplitCellIntoColumns(Element* aTable,
int32_t aRowIndex,
int32_t aColIndex,
int32_t aColSpanLeft,
int32_t aColSpanRight,
Element** aNewCell)
{
if (NS_WARN_IF(!aTable)) {
return NS_ERROR_INVALID_ARG;
}
if (aNewCell) {
*aNewCell = nullptr;
}
IgnoredErrorResult ignoredError;
CellData cellData(*this, *aTable, aRowIndex, aColIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// We can't split!
if (cellData.mEffectiveColSpan <= 1 ||
aColSpanLeft + aColSpanRight > cellData.mEffectiveColSpan) {
return NS_OK;
}
// Reduce colspan of cell to split
nsresult rv = SetColSpan(cellData.mElement, aColSpanLeft);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Insert new cell after using the remaining span
// and always get the new cell so we can copy the background color;
RefPtr<Element> newCellElement;
rv = InsertCell(cellData.mElement,
cellData.mEffectiveRowSpan, aColSpanRight, true, false,
getter_AddRefs(newCellElement));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (!newCellElement) {
return NS_OK;
}
if (aNewCell) {
NS_ADDREF(*aNewCell = newCellElement.get());
}
rv = CopyCellBackgroundColor(newCellElement, cellData.mElement);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::SplitCellIntoRows(Element* aTable,
int32_t aRowIndex,
int32_t aColIndex,
int32_t aRowSpanAbove,
int32_t aRowSpanBelow,
Element** aNewCell)
{
if (NS_WARN_IF(!aTable)) {
return NS_ERROR_INVALID_ARG;
}
if (aNewCell) {
*aNewCell = nullptr;
}
IgnoredErrorResult ignoredError;
CellData cellData(*this, *aTable, aRowIndex, aColIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// We can't split!
if (cellData.mEffectiveRowSpan <= 1 ||
aRowSpanAbove + aRowSpanBelow > cellData.mEffectiveRowSpan) {
return NS_OK;
}
ErrorResult error;
TableSize tableSize(*this, *aTable, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Find a cell to insert before or after
RefPtr<Element> cellElementAtInsertionPoint;
RefPtr<Element> lastCellFound;
bool insertAfter = (cellData.mFirst.mColumn > 0);
CellData cellDataAtInsertionPoint;
for (int32_t colIndex = 0,
rowBelowIndex = cellData.mFirst.mRow + aRowSpanAbove;
colIndex <= tableSize.mColumnCount;
colIndex = cellData.NextColumnIndex()) {
cellDataAtInsertionPoint.Update(*this, *aTable, rowBelowIndex, colIndex,
ignoredError);
// If we fail here, it could be because row has bad rowspan values,
// such as all cells having rowspan > 1 (Call FixRowSpan first!).
// XXX According to the comment, this does not assume that
// FixRowSpan() doesn't work well and user can create non-rectangular
// table. So, we should not return error when CellData cannot find
// a cell.
if (NS_WARN_IF(cellDataAtInsertionPoint.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// FYI: Don't use std::move() here since the following checks will use
// utility methods of cellDataAtInsertionPoint, but some of them
// check whether its mElement is not nullptr.
cellElementAtInsertionPoint = cellDataAtInsertionPoint.mElement;
// Skip over cells spanned from above (like the one we are splitting!)
if (cellDataAtInsertionPoint.mElement &&
!cellDataAtInsertionPoint.IsSpannedFromOtherRow()) {
if (!insertAfter) {
// Inserting before, so stop at first cell in row we want to insert
// into.
break;
}
// New cell isn't first in row,
// so stop after we find the cell just before new cell's column
if (cellDataAtInsertionPoint.NextColumnIndex() ==
cellData.mFirst.mColumn) {
break;
}
// If cell found is AFTER desired new cell colum,
// we have multiple cells with rowspan > 1 that
// prevented us from finding a cell to insert after...
if (cellDataAtInsertionPoint.mFirst.mColumn > cellData.mFirst.mColumn) {
// ... so instead insert before the cell we found
insertAfter = false;
break;
}
// FYI: Don't use std::move() here since
// cellDataAtInsertionPoint.NextColumnIndex() needs it.
lastCellFound = cellDataAtInsertionPoint.mElement;
}
MOZ_ASSERT(colIndex < cellDataAtInsertionPoint.NextColumnIndex());
}
if (!cellElementAtInsertionPoint && lastCellFound) {
// Edge case where we didn't find a cell to insert after
// or before because column(s) before desired column
// and all columns after it are spanned from above.
// We can insert after the last cell we found
cellElementAtInsertionPoint = std::move(lastCellFound);
insertAfter = true; // Should always be true, but let's be sure
}
// Reduce rowspan of cell to split
nsresult rv = SetRowSpan(cellData.mElement, aRowSpanAbove);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Insert new cell after using the remaining span
// and always get the new cell so we can copy the background color;
RefPtr<Element> newCell;
rv = InsertCell(cellElementAtInsertionPoint,
aRowSpanBelow, cellData.mEffectiveColSpan,
insertAfter, false, getter_AddRefs(newCell));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (!newCell) {
return NS_OK;
}
if (aNewCell) {
NS_ADDREF(*aNewCell = newCell.get());
}
rv = CopyCellBackgroundColor(newCell, cellElementAtInsertionPoint);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::SwitchTableCellHeaderType(Element* aSourceCell,
Element** aNewCell)
{
if (NS_WARN_IF(!aSourceCell)) {
return NS_ERROR_INVALID_ARG;
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent auto insertion of BR in new cell created by
// ReplaceContainerAndCloneAttributesWithTransaction().
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eInsertNode,
nsIEditor::eNext);
// Save current selection to restore when done.
// This is needed so ReplaceContainerAndCloneAttributesWithTransaction()
// can monitor selection when replacing nodes.
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
AutoSelectionRestorer restoreSelectionLater(*selection, *this);
// Set to the opposite of current type
nsAtom* newCellName =
aSourceCell->IsHTMLElement(nsGkAtoms::td) ? nsGkAtoms::th : nsGkAtoms::td;
// This creates new node, moves children, copies attributes (true)
// and manages the selection!
RefPtr<Element> newCell =
ReplaceContainerAndCloneAttributesWithTransaction(*aSourceCell,
*newCellName);
if (NS_WARN_IF(!newCell)) {
return NS_ERROR_FAILURE;
}
// Return the new cell
if (aNewCell) {
newCell.forget(aNewCell);
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::JoinTableCells(bool aMergeNonContiguousContents)
{
RefPtr<Element> table;
RefPtr<Element> targetCell;
int32_t startRowIndex, startColIndex;
// Get cell, table, etc. at selection anchor node
nsresult rv = GetCellContext(nullptr,
getter_AddRefs(table),
getter_AddRefs(targetCell),
nullptr, nullptr,
&startRowIndex, &startColIndex);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (!table || !targetCell) {
return NS_OK;
}
AutoPlaceholderBatch treateAsOneTransaction(*this);
//Don't let Rules System change the selection
AutoTransactionsConserveSelection dontChangeSelection(*this);
// Note: We dont' use AutoSelectionSetterAfterTableEdit here so the selection
// is retained after joining. This leaves the target cell selected
// as well as the "non-contiguous" cells, so user can see what happened.
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
CellAndIndexes firstSelectedCell(*this, *selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
bool joinSelectedCells = false;
if (firstSelectedCell.mElement) {
RefPtr<Element> secondCell =
GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// If only one cell is selected, join with cell to the right
joinSelectedCells = (secondCell != nullptr);
}
if (joinSelectedCells) {
// We have selected cells: Join just contiguous cells
// and just merge contents if not contiguous
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Get spans for cell we will merge into
int32_t firstRowSpan, firstColSpan;
rv = GetCellSpansAt(table,
firstSelectedCell.mIndexes.mRow,
firstSelectedCell.mIndexes.mColumn,
firstRowSpan, firstColSpan);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// This defines the last indexes along the "edges"
// of the contiguous block of cells, telling us
// that we can join adjacent cells to the block
// Start with same as the first values,
// then expand as we find adjacent selected cells
int32_t lastRowIndex = firstSelectedCell.mIndexes.mRow;
int32_t lastColIndex = firstSelectedCell.mIndexes.mColumn;
// First pass: Determine boundaries of contiguous rectangular block that
// we will join into one cell, favoring adjacent cells in the same row.
IgnoredErrorResult ignoredError;
for (int32_t rowIndex = firstSelectedCell.mIndexes.mRow;
rowIndex <= lastRowIndex;
rowIndex++) {
int32_t currentRowCount = tableSize.mRowCount;
// Be sure each row doesn't have rowspan errors
rv = FixBadRowSpan(table, rowIndex, tableSize.mRowCount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Adjust rowcount by number of rows we removed
lastRowIndex -= currentRowCount - tableSize.mRowCount;
bool cellFoundInRow = false;
bool lastRowIsSet = false;
int32_t lastColInRow = 0;
int32_t firstColInRow = firstSelectedCell.mIndexes.mColumn;
int32_t colIndex = firstSelectedCell.mIndexes.mColumn;
for (CellData cellData;
colIndex < tableSize.mColumnCount;
colIndex = cellData.NextColumnIndex()) {
cellData.Update(*this, *table, rowIndex, colIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
if (cellData.mIsSelected) {
if (!cellFoundInRow) {
// We've just found the first selected cell in this row
firstColInRow = cellData.mCurrent.mColumn;
}
if (cellData.mCurrent.mRow > firstSelectedCell.mIndexes.mRow &&
firstColInRow != firstSelectedCell.mIndexes.mColumn) {
// We're in at least the second row,
// but left boundary is "ragged" (not the same as 1st row's start)
//Let's just end block on previous row
// and keep previous lastColIndex
//TODO: We could try to find the Maximum firstColInRow
// so our block can still extend down more rows?
lastRowIndex = std::max(0, cellData.mCurrent.mRow - 1);
lastRowIsSet = true;
break;
}
// Save max selected column in this row, including extra colspan
lastColInRow = cellData.LastColumnIndex();
cellFoundInRow = true;
} else if (cellFoundInRow) {
// No cell or not selected, but at least one cell in row was found
if (cellData.mCurrent.mRow > firstSelectedCell.mIndexes.mRow + 1 &&
cellData.mCurrent.mColumn <= lastColIndex) {
// Cell is in a column less than current right border in
// the third or higher selected row, so stop block at the previous row
lastRowIndex = std::max(0, cellData.mCurrent.mRow - 1);
lastRowIsSet = true;
}
// We're done with this row
break;
}
MOZ_ASSERT(colIndex < cellData.NextColumnIndex());
} // End of column loop
// Done with this row
if (cellFoundInRow) {
if (rowIndex == firstSelectedCell.mIndexes.mRow) {
// First row always initializes the right boundary
lastColIndex = lastColInRow;
}
// If we didn't determine last row above...
if (!lastRowIsSet) {
if (colIndex < lastColIndex) {
// (don't think we ever get here?)
// Cell is in a column less than current right boundary,
// so stop block at the previous row
lastRowIndex = std::max(0, rowIndex - 1);
} else {
// Go on to examine next row
lastRowIndex = rowIndex + 1;
}
}
// Use the minimum col we found so far for right boundary
lastColIndex = std::min(lastColIndex, lastColInRow);
} else {
// No selected cells in this row -- stop at row above
// and leave last column at its previous value
lastRowIndex = std::max(0, rowIndex - 1);
}
}
// The list of cells we will delete after joining
nsTArray<RefPtr<Element>> deleteList;
// 2nd pass: Do the joining and merging
for (int32_t rowIndex = 0; rowIndex < tableSize.mRowCount; rowIndex++) {
CellData cellData;
for (int32_t colIndex = 0;
colIndex < tableSize.mColumnCount;
colIndex = cellData.NextColumnIndex()) {
cellData.Update(*this, *table, rowIndex, colIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// If this is 0, we are past last cell in row, so exit the loop
if (!cellData.mEffectiveColSpan) {
break;
}
// Merge only selected cells (skip cell we're merging into, of course)
if (cellData.mIsSelected &&
cellData.mElement != firstSelectedCell.mElement) {
if (cellData.mCurrent.mRow >= firstSelectedCell.mIndexes.mRow &&
cellData.mCurrent.mRow <= lastRowIndex &&
cellData.mCurrent.mColumn >= firstSelectedCell.mIndexes.mColumn &&
cellData.mCurrent.mColumn <= lastColIndex) {
// We are within the join region
// Problem: It is very tricky to delete cells as we merge,
// since that will upset the cellmap
// Instead, build a list of cells to delete and do it later
NS_ASSERTION(!cellData.IsSpannedFromOtherRow(),
"JoinTableCells: StartRowIndex is in row above");
if (cellData.mEffectiveColSpan > 1) {
//Check if cell "hangs" off the boundary because of colspan > 1
// Use split methods to chop off excess
int32_t extraColSpan =
cellData.mFirst.mColumn + cellData.mEffectiveColSpan -
(lastColIndex + 1);
if ( extraColSpan > 0) {
rv = SplitCellIntoColumns(
table,
cellData.mFirst.mRow, cellData.mFirst.mColumn,
cellData.mEffectiveColSpan - extraColSpan,
extraColSpan, nullptr);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
}
rv =
MergeCells(firstSelectedCell.mElement, cellData.mElement, false);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Add cell to list to delete
deleteList.AppendElement(cellData.mElement.get());
} else if (aMergeNonContiguousContents) {
// Cell is outside join region -- just merge the contents
rv =
MergeCells(firstSelectedCell.mElement, cellData.mElement, false);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
}
MOZ_ASSERT(colIndex < cellData.NextColumnIndex());
}
}
// All cell contents are merged. Delete the empty cells we accumulated
// Prevent rules testing until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eDeleteNode,
nsIEditor::eNext);
for (uint32_t i = 0, n = deleteList.Length(); i < n; i++) {
RefPtr<Element> nodeToBeRemoved = deleteList[i];
if (nodeToBeRemoved) {
rv = DeleteNodeWithTransaction(*nodeToBeRemoved);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
}
// Cleanup selection: remove ranges where cells were deleted
RefPtr<Selection> selection = GetSelection();
NS_ENSURE_TRUE(selection, NS_ERROR_FAILURE);
uint32_t rangeCount = selection->RangeCount();
RefPtr<nsRange> range;
for (uint32_t i = 0; i < rangeCount; i++) {
range = selection->GetRangeAt(i);
NS_ENSURE_TRUE(range, NS_ERROR_FAILURE);
RefPtr<Element> deletedCell;
HTMLEditor::GetCellFromRange(range, getter_AddRefs(deletedCell));
if (!deletedCell) {
selection->RemoveRange(*range, IgnoreErrors());
rangeCount--;
i--;
}
}
// Set spans for the cell everything merged into
rv = SetRowSpan(firstSelectedCell.mElement,
lastRowIndex - firstSelectedCell.mIndexes.mRow + 1);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = SetColSpan(firstSelectedCell.mElement,
lastColIndex - firstSelectedCell.mIndexes.mColumn + 1);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Fixup disturbances in table layout
DebugOnly<nsresult> rv = NormalizeTable(*selection, *table);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Failed to normalize the table");
} else {
// Joining with cell to the right -- get rowspan and colspan data of target
// cell.
IgnoredErrorResult ignoredError;
CellData leftCellData(*this, *table, startRowIndex, startColIndex,
ignoredError);
if (NS_WARN_IF(leftCellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// Get data for cell to the right.
CellData rightCellData(
*this, *table,
leftCellData.mFirst.mRow,
leftCellData.mFirst.mColumn + leftCellData.mEffectiveColSpan,
ignoredError);
if (NS_WARN_IF(rightCellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// XXX So, this does not assume that CellData returns error when just not
// found. We need to fix this later.
if (!rightCellData.mElement) {
return NS_OK; // Don't fail if there's no cell
}
// sanity check
NS_ASSERTION(rightCellData.mCurrent.mRow >= rightCellData.mFirst.mRow,
"JoinCells: rightCellData.mCurrent.mRow < rightCellData.mFirst.mRow");
// Figure out span of merged cell starting from target's starting row
// to handle case of merged cell starting in a row above
int32_t spanAboveMergedCell = rightCellData.NumberOfPrecedingRows();
int32_t effectiveRowSpan2 =
rightCellData.mEffectiveRowSpan - spanAboveMergedCell;
if (effectiveRowSpan2 > leftCellData.mEffectiveRowSpan) {
// Cell to the right spans into row below target
// Split off portion below target cell's bottom-most row
rv =
SplitCellIntoRows(table,
rightCellData.mFirst.mRow,
rightCellData.mFirst.mColumn,
spanAboveMergedCell + leftCellData.mEffectiveRowSpan,
effectiveRowSpan2 - leftCellData.mEffectiveRowSpan,
nullptr);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
// Move contents from cell to the right
// Delete the cell now only if it starts in the same row
// and has enough row "height"
rv = MergeCells(leftCellData.mElement, rightCellData.mElement,
!rightCellData.IsSpannedFromOtherRow() &&
effectiveRowSpan2 >= leftCellData.mEffectiveRowSpan);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (effectiveRowSpan2 < leftCellData.mEffectiveRowSpan) {
// Merged cell is "shorter"
// (there are cells(s) below it that are row-spanned by target cell)
// We could try splitting those cells, but that's REAL messy,
// so the safest thing to do is NOT really join the cells
return NS_OK;
}
if (spanAboveMergedCell > 0) {
// Cell we merged started in a row above the target cell
// Reduce rowspan to give room where target cell will extend its colspan
rv = SetRowSpan(rightCellData.mElement, spanAboveMergedCell);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
// Reset target cell's colspan to encompass cell to the right
rv = SetColSpan(leftCellData.mElement,
leftCellData.mEffectiveColSpan +
rightCellData.mEffectiveColSpan);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
return NS_OK;
}
nsresult
HTMLEditor::MergeCells(RefPtr<Element> aTargetCell,
RefPtr<Element> aCellToMerge,
bool aDeleteCellToMerge)
{
NS_ENSURE_TRUE(aTargetCell && aCellToMerge, NS_ERROR_NULL_POINTER);
// Prevent rules testing until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eDeleteNode,
nsIEditor::eNext);
// Don't need to merge if cell is empty
if (!IsEmptyCell(aCellToMerge)) {
// Get index of last child in target cell
// If we fail or don't have children,
// we insert at index 0
int32_t insertIndex = 0;
// Start inserting just after last child
uint32_t len = aTargetCell->GetChildCount();
if (len == 1 && IsEmptyCell(aTargetCell)) {
// Delete the empty node
nsIContent* cellChild = aTargetCell->GetFirstChild();
if (NS_WARN_IF(!cellChild)) {
return NS_ERROR_FAILURE;
}
nsresult rv = DeleteNodeWithTransaction(*cellChild);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
insertIndex = 0;
} else {
insertIndex = (int32_t)len;
}
// Move the contents
while (aCellToMerge->HasChildren()) {
nsCOMPtr<nsIContent> cellChild = aCellToMerge->GetLastChild();
if (NS_WARN_IF(!cellChild)) {
return NS_ERROR_FAILURE;
}
nsresult rv = DeleteNodeWithTransaction(*cellChild);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
rv = InsertNodeWithTransaction(*cellChild,
EditorRawDOMPoint(aTargetCell,
insertIndex));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
}
if (!aDeleteCellToMerge) {
return NS_OK;
}
// Delete cells whose contents were moved.
nsresult rv = DeleteNodeWithTransaction(*aCellToMerge);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::FixBadRowSpan(Element* aTable,
int32_t aRowIndex,
int32_t& aNewRowCount)
{
if (NS_WARN_IF(!aTable)) {
return NS_ERROR_INVALID_ARG;
}
ErrorResult error;
TableSize tableSize(*this, *aTable, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
int32_t minRowSpan = -1;
IgnoredErrorResult ignoredError;
CellData cellData;
for (int32_t colIndex = 0;
colIndex < tableSize.mColumnCount;
colIndex = cellData.NextColumnIndex()) {
cellData.Update(*this, *aTable, aRowIndex, colIndex, ignoredError);
// NOTE: This is a *real* failure.
// CellData passes if cell is missing from cellmap
// XXX If <table> has large rowspan value or colspan value than actual
// cells, we may hit error. So, this method is always failed to
// "fix" the rowspan...
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// XXX So, this does not assume that CellData returns error when just not
// found. We need to fix this later.
if (!cellData.mElement) {
break;
}
if (cellData.mRowSpan > 0 &&
!cellData.IsSpannedFromOtherRow() &&
(cellData.mRowSpan < minRowSpan || minRowSpan == -1)) {
minRowSpan = cellData.mRowSpan;
}
MOZ_ASSERT(colIndex < cellData.NextColumnIndex());
}
if (minRowSpan > 1) {
// The amount to reduce everyone's rowspan
// so at least one cell has rowspan = 1
int32_t rowsReduced = minRowSpan - 1;
CellData cellData;
for (int32_t colIndex = 0;
colIndex < tableSize.mColumnCount;
colIndex = cellData.NextColumnIndex()) {
cellData.Update(*this, *aTable, aRowIndex, colIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// Fixup rowspans only for cells starting in current row
// XXX So, this does not assume that CellData returns error when just
// not found a cell. Fix this later.
if (cellData.mElement && cellData.mRowSpan > 0 &&
!cellData.IsSpannedFromOtherRowOrColumn()) {
nsresult rv =
SetRowSpan(cellData.mElement, cellData.mRowSpan - rowsReduced);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
MOZ_ASSERT(colIndex < cellData.NextColumnIndex());
}
}
tableSize.Update(*this, *aTable, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
aNewRowCount = tableSize.mRowCount;
return NS_OK;
}
nsresult
HTMLEditor::FixBadColSpan(Element* aTable,
int32_t aColIndex,
int32_t& aNewColCount)
{
if (NS_WARN_IF(!aTable)) {
return NS_ERROR_INVALID_ARG;
}
ErrorResult error;
TableSize tableSize(*this, *aTable, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
int32_t minColSpan = -1;
IgnoredErrorResult ignoredError;
CellData cellData;
for (int32_t rowIndex = 0;
rowIndex < tableSize.mRowCount;
rowIndex = cellData.NextRowIndex()) {
cellData.Update(*this, *aTable, rowIndex, aColIndex, ignoredError);
// NOTE: This is a *real* failure.
// CellData passes if cell is missing from cellmap
// XXX If <table> has large rowspan value or colspan value than actual
// cells, we may hit error. So, this method is always failed to
// "fix" the colspan...
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// XXX So, this does not assume that CellData returns error when just
// not found a cell. Fix this later.
if (!cellData.mElement) {
break;
}
if (cellData.mColSpan > 0 &&
!cellData.IsSpannedFromOtherColumn() &&
(cellData.mColSpan < minColSpan || minColSpan == -1)) {
minColSpan = cellData.mColSpan;
}
MOZ_ASSERT(rowIndex < cellData.NextRowIndex());
}
if (minColSpan > 1) {
// The amount to reduce everyone's colspan
// so at least one cell has colspan = 1
int32_t colsReduced = minColSpan - 1;
CellData cellData;
for (int32_t rowIndex = 0;
rowIndex < tableSize.mRowCount;
rowIndex = cellData.NextRowIndex()) {
cellData.Update(*this, *aTable, rowIndex, aColIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
// Fixup colspans only for cells starting in current column
// XXX So, this does not assume that CellData returns error when just
// not found a cell. Fix this later.
if (cellData.mElement && cellData.mColSpan > 0 &&
!cellData.IsSpannedFromOtherRowOrColumn()) {
nsresult rv =
SetColSpan(cellData.mElement, cellData.mColSpan - colsReduced);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
MOZ_ASSERT(rowIndex < cellData.NextRowIndex());
}
}
tableSize.Update(*this, *aTable, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
aNewColCount = tableSize.mColumnCount;
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::NormalizeTable(Element* aTableOrElementInTable)
{
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
if (!aTableOrElementInTable) {
aTableOrElementInTable =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::table);
if (!aTableOrElementInTable) {
return NS_OK; // Don't throw error even if the element is not in <table>.
}
}
nsresult rv = NormalizeTable(*selection, *aTableOrElementInTable);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
return NS_OK;
}
nsresult
HTMLEditor::NormalizeTable(Selection& aSelection,
Element& aTableOrElementInTable)
{
RefPtr<Element> tableElement;
if (aTableOrElementInTable.NodeInfo()->NameAtom() == nsGkAtoms::table) {
tableElement = &aTableOrElementInTable;
} else {
tableElement =
GetElementOrParentByTagNameInternal(*nsGkAtoms::table,
aTableOrElementInTable);
if (!tableElement) {
return NS_OK; // Don't throw error even if the element is not in <table>.
}
}
ErrorResult error;
TableSize tableSize(*this, *tableElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Save current selection
AutoSelectionRestorer restoreSelectionLater(aSelection, *this);
AutoPlaceholderBatch treateAsOneTransaction(*this);
// Prevent auto insertion of BR in new cell until we're done
AutoTopLevelEditSubActionNotifier maybeTopLevelEditSubAction(
*this, EditSubAction::eInsertNode,
nsIEditor::eNext);
// XXX If there is a cell which has bigger or smaller "rowspan" or "colspan"
// values, FixBadRowSpan() will return error. So, we can do nothing
// if the table needs normalization...
// Scan all cells in each row to detect bad rowspan values
for (int32_t rowIndex = 0; rowIndex < tableSize.mRowCount; rowIndex++) {
nsresult rv = FixBadRowSpan(tableElement, rowIndex, tableSize.mRowCount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
// and same for colspans
for (int32_t colIndex = 0; colIndex < tableSize.mColumnCount; colIndex++) {
nsresult rv = FixBadColSpan(tableElement, colIndex, tableSize.mColumnCount);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
}
// Fill in missing cellmap locations with empty cells
IgnoredErrorResult ignoredError;
for (int32_t rowIndex = 0; rowIndex < tableSize.mRowCount; rowIndex++) {
RefPtr<Element> previousCellElementInRow;
for (int32_t colIndex = 0; colIndex < tableSize.mColumnCount; colIndex++) {
CellData cellData(*this, *tableElement, rowIndex, colIndex, ignoredError);
// NOTE: This is a *real* failure.
// CellData passes if cell is missing from cellmap
// XXX So, this method assumes that CellData won't return error when
// just not found. Fix this later.
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
if (cellData.mElement) {
// Save the last cell found in the same row we are scanning
if (!cellData.IsSpannedFromOtherRow()) {
previousCellElementInRow = std::move(cellData.mElement);
}
continue;
}
// We are missing a cell at a cellmap location.
// Add a cell after the previous cell element in the current row.
if (NS_WARN_IF(!previousCellElementInRow)) {
// We don't have any cells in this row -- We are really messed up!
return NS_ERROR_FAILURE;
}
// Insert a new cell after (true), and return the new cell to us
RefPtr<Element> newCellElement;
nsresult rv =
InsertCell(previousCellElementInRow, 1, 1, true, false,
getter_AddRefs(newCellElement));
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
if (newCellElement) {
previousCellElementInRow = std::move(newCellElement);
}
}
}
return NS_OK;
}
NS_IMETHODIMP
HTMLEditor::GetCellIndexes(Element* aCellElement,
int32_t* aRowIndex,
int32_t* aColumnIndex)
{
if (NS_WARN_IF(!aRowIndex) || NS_WARN_IF(!aColumnIndex)) {
return NS_ERROR_INVALID_ARG;
}
*aRowIndex = 0;
*aColumnIndex = 0;
if (!aCellElement) {
// Use cell element which contains anchor of Selection when aCellElement is
// nullptr.
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
CellIndexes cellIndexes(*this, *selection, error);
if (error.Failed()) {
return error.StealNSResult();
}
*aRowIndex = cellIndexes.mRow;
*aColumnIndex = cellIndexes.mColumn;
return NS_OK;
}
ErrorResult error;
CellIndexes cellIndexes(*aCellElement, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
*aRowIndex = cellIndexes.mRow;
*aColumnIndex = cellIndexes.mColumn;
return NS_OK;
}
void
HTMLEditor::CellIndexes::Update(HTMLEditor& aHTMLEditor,
Selection& aSelection,
ErrorResult& aRv)
{
MOZ_ASSERT(!aRv.Failed());
// Guarantee the life time of the cell element since Init() will access
// layout methods.
RefPtr<Element> cellElement =
aHTMLEditor.GetElementOrParentByTagNameAtSelection(aSelection,
*nsGkAtoms::td);
if (!cellElement) {
aRv.Throw(NS_ERROR_FAILURE);
return;
}
Update(*cellElement, aRv);
}
void
HTMLEditor::CellIndexes::Update(Element& aCellElement,
ErrorResult& aRv)
{
MOZ_ASSERT(!aRv.Failed());
// XXX If the table cell is created immediately before this call, e.g.,
// using innerHTML, frames have not been created yet. In such case,
// shouldn't we flush pending layout?
nsIFrame* frameOfCell = aCellElement.GetPrimaryFrame();
if (NS_WARN_IF(!frameOfCell)) {
aRv.Throw(NS_ERROR_FAILURE);
return;
}
nsITableCellLayout* tableCellLayout = do_QueryFrame(frameOfCell);
if (!tableCellLayout) {
aRv.Throw(NS_ERROR_FAILURE); // not a cell element.
return;
}
aRv = tableCellLayout->GetCellIndexes(mRow, mColumn);
NS_WARNING_ASSERTION(!aRv.Failed(), "Failed to get cell indexes");
}
// static
nsTableWrapperFrame*
HTMLEditor::GetTableFrame(Element* aTableElement)
{
if (NS_WARN_IF(!aTableElement)) {
return nullptr;
}
return do_QueryFrame(aTableElement->GetPrimaryFrame());
}
//Return actual number of cells (a cell with colspan > 1 counts as just 1)
int32_t
HTMLEditor::GetNumberOfCellsInRow(Element& aTableElement,
int32_t aRowIndex)
{
IgnoredErrorResult ignoredError;
TableSize tableSize(*this, aTableElement, ignoredError);
if (NS_WARN_IF(ignoredError.Failed())) {
return -1;
}
int32_t numberOfCells = 0;
CellData cellData;
for (int32_t columnIndex = 0;
columnIndex < tableSize.mColumnCount;
columnIndex = cellData.NextColumnIndex()) {
cellData.Update(*this, aTableElement, aRowIndex, columnIndex, ignoredError);
// Failure means that there is no more cell in the row. In this case,
// we shouldn't return error since we just reach the end of the row.
// XXX So, this method assumes that CellData won't return error when
// just not found. Fix this later.
if (cellData.FailedOrNotFound()) {
break;
}
// Only count cells that start in row we are working with
if (cellData.mElement && !cellData.IsSpannedFromOtherRow()) {
numberOfCells++;
}
MOZ_ASSERT(columnIndex < cellData.NextColumnIndex());
}
return numberOfCells;
}
NS_IMETHODIMP
HTMLEditor::GetTableSize(Element* aTableOrElementInTable,
int32_t* aRowCount,
int32_t* aColumnCount)
{
if (NS_WARN_IF(!aRowCount) || NS_WARN_IF(!aColumnCount)) {
return NS_ERROR_INVALID_ARG;
}
*aRowCount = 0;
*aColumnCount = 0;
Element* tableOrElementInTable = aTableOrElementInTable;
if (!tableOrElementInTable) {
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
tableOrElementInTable =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::table);
if (NS_WARN_IF(!tableOrElementInTable)) {
return NS_ERROR_FAILURE;
}
}
ErrorResult error;
TableSize tableSize(*this, *tableOrElementInTable, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
*aRowCount = tableSize.mRowCount;
*aColumnCount = tableSize.mColumnCount;
return NS_OK;
}
void
HTMLEditor::TableSize::Update(HTMLEditor& aHTMLEditor,
Element& aTableOrElementInTable,
ErrorResult& aRv)
{
MOZ_ASSERT(!aRv.Failed());
// Currently, nsTableWrapperFrame::GetRowCount() and
// nsTableWrapperFrame::GetColCount() are safe to use without grabbing
// <table> element. However, editor developers may not watch layout API
// changes. So, for keeping us safer, we should use RefPtr here.
RefPtr<Element> tableElement =
aHTMLEditor.GetElementOrParentByTagNameInternal(*nsGkAtoms::table,
aTableOrElementInTable);
if (NS_WARN_IF(!tableElement)) {
aRv.Throw(NS_ERROR_FAILURE);
return;
}
nsTableWrapperFrame* tableFrame =
do_QueryFrame(tableElement->GetPrimaryFrame());
if (NS_WARN_IF(!tableFrame)) {
aRv.Throw(NS_ERROR_FAILURE);
return;
}
mRowCount = tableFrame->GetRowCount();
mColumnCount = tableFrame->GetColCount();
}
NS_IMETHODIMP
HTMLEditor::GetCellDataAt(Element* aTableElement,
int32_t aRowIndex,
int32_t aColumnIndex,
Element** aCellElement,
int32_t* aStartRowIndex,
int32_t* aStartColumnIndex,
int32_t* aRowSpan,
int32_t* aColSpan,
int32_t* aEffectiveRowSpan,
int32_t* aEffectiveColSpan,
bool* aIsSelected)
{
if (NS_WARN_IF(!aCellElement) ||
NS_WARN_IF(!aStartRowIndex) || NS_WARN_IF(!aStartColumnIndex) ||
NS_WARN_IF(!aRowSpan) || NS_WARN_IF(!aColSpan) ||
NS_WARN_IF(!aEffectiveRowSpan) || NS_WARN_IF(!aEffectiveColSpan) ||
NS_WARN_IF(!aIsSelected)) {
return NS_ERROR_INVALID_ARG;
}
*aStartRowIndex = 0;
*aStartColumnIndex = 0;
*aRowSpan = 0;
*aColSpan = 0;
*aEffectiveRowSpan = 0;
*aEffectiveColSpan = 0;
*aIsSelected = false;
*aCellElement = nullptr;
// Let's keep the table element with strong pointer since editor developers
// may not handle layout code of <table>, however, this method depends on
// them.
RefPtr<Element> table = aTableElement;
if (!table) {
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
// Get the selected table or the table enclosing the selection anchor.
table =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::table);
if (NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
}
IgnoredErrorResult ignoredError;
CellData cellData(*this, *table, aRowIndex, aColumnIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return NS_ERROR_FAILURE;
}
cellData.mElement.forget(aCellElement);
*aIsSelected = cellData.mIsSelected;
*aStartRowIndex = cellData.mFirst.mRow;
*aStartColumnIndex = cellData.mFirst.mColumn;
*aRowSpan = cellData.mRowSpan;
*aColSpan = cellData.mColSpan;
*aEffectiveRowSpan = cellData.mEffectiveRowSpan;
*aEffectiveColSpan = cellData.mEffectiveColSpan;
return NS_OK;
}
void
HTMLEditor::CellData::Update(HTMLEditor& aHTMLEditor,
Element& aTableElement,
ErrorResult& aRv)
{
MOZ_ASSERT(!aRv.Failed());
mElement = nullptr;
mIsSelected = false;
mFirst.mRow = -1;
mFirst.mColumn = -1;
mRowSpan = -1;
mColSpan = -1;
mEffectiveRowSpan = -1;
mEffectiveColSpan = -1;
nsTableWrapperFrame* tableFrame = HTMLEditor::GetTableFrame(&aTableElement);
if (NS_WARN_IF(!tableFrame)) {
aRv.Throw(NS_ERROR_FAILURE);
return;
}
// If there is no cell at the indexes. Don't return error.
// XXX If we have pending layout and that causes the cell frame hasn't been
// created, we should return error, but how can we do it?
nsTableCellFrame* cellFrame =
tableFrame->GetCellFrameAt(mCurrent.mRow, mCurrent.mColumn);
if (!cellFrame) {
return;
}
mElement = cellFrame->GetContent()->AsElement();
if (NS_WARN_IF(!mElement)) {
aRv.Throw(NS_ERROR_FAILURE);
return;
}
mIsSelected = cellFrame->IsSelected();
mFirst.mRow = cellFrame->RowIndex();
mFirst.mColumn = cellFrame->ColIndex();
mRowSpan = cellFrame->GetRowSpan();
mColSpan = cellFrame->GetColSpan();
mEffectiveRowSpan =
tableFrame->GetEffectiveRowSpanAt(mCurrent.mRow, mCurrent.mColumn);
mEffectiveColSpan =
tableFrame->GetEffectiveColSpanAt(mCurrent.mRow, mCurrent.mColumn);
}
NS_IMETHODIMP
HTMLEditor::GetCellAt(Element* aTableElement,
int32_t aRowIndex,
int32_t aColumnIndex,
Element** aCellElement)
{
if (NS_WARN_IF(!aCellElement)) {
return NS_ERROR_INVALID_ARG;
}
*aCellElement = nullptr;
Element* tableElement = aTableElement;
if (!tableElement) {
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
// Get the selected table or the table enclosing the selection anchor.
tableElement =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::table);
if (NS_WARN_IF(!tableElement)) {
return NS_ERROR_FAILURE;
}
}
RefPtr<Element> cellElement =
GetTableCellElementAt(*tableElement, aRowIndex, aColumnIndex);
cellElement.forget(aCellElement);
return NS_OK;
}
Element*
HTMLEditor::GetTableCellElementAt(Element& aTableElement,
int32_t aRowIndex,
int32_t aColumnIndex) const
{
// Let's grab the <table> element while we're retrieving layout API since
// editor developers do not watch all layout API changes. So, it may
// become unsafe.
OwningNonNull<Element> tableElement(aTableElement);
nsTableWrapperFrame* tableFrame = HTMLEditor::GetTableFrame(tableElement);
if (!tableFrame) {
return nullptr;
}
nsIContent* cell = tableFrame->GetCellAt(aRowIndex, aColumnIndex);
return Element::FromNodeOrNull(cell);
}
// When all you want are the rowspan and colspan (not exposed in nsITableEditor)
nsresult
HTMLEditor::GetCellSpansAt(Element* aTable,
int32_t aRowIndex,
int32_t aColIndex,
int32_t& aActualRowSpan,
int32_t& aActualColSpan)
{
nsTableWrapperFrame* tableFrame = HTMLEditor::GetTableFrame(aTable);
if (!tableFrame) {
return NS_ERROR_FAILURE;
}
aActualRowSpan = tableFrame->GetEffectiveRowSpanAt(aRowIndex, aColIndex);
aActualColSpan = tableFrame->GetEffectiveColSpanAt(aRowIndex, aColIndex);
return NS_OK;
}
nsresult
HTMLEditor::GetCellContext(Selection** aSelection,
Element** aTable,
Element** aCell,
nsINode** aCellParent,
int32_t* aCellOffset,
int32_t* aRowIndex,
int32_t* aColumnIndex)
{
// Initialize return pointers
if (aSelection) {
*aSelection = nullptr;
}
if (aTable) {
*aTable = nullptr;
}
if (aCell) {
*aCell = nullptr;
}
if (aCellParent) {
*aCellParent = nullptr;
}
if (aCellOffset) {
*aCellOffset = 0;
}
if (aRowIndex) {
*aRowIndex = 0;
}
if (aColumnIndex) {
*aColumnIndex = 0;
}
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
if (aSelection) {
*aSelection = selection.get();
NS_ADDREF(*aSelection);
}
RefPtr<Element> table;
RefPtr<Element> cell;
// Caller may supply the cell...
if (aCell && *aCell) {
cell = *aCell;
}
// ...but if not supplied,
// get cell if it's the child of selection anchor node,
// or get the enclosing by a cell
if (!cell) {
// Find a selected or enclosing table element
ErrorResult error;
RefPtr<Element> cellOrRowOrTableElement =
GetSelectedOrParentTableElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!cellOrRowOrTableElement) {
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
if (cellOrRowOrTableElement->IsHTMLElement(nsGkAtoms::table)) {
// We have a selected table, not a cell
if (aTable) {
cellOrRowOrTableElement.forget(aTable);
}
return NS_OK;
}
if (!cellOrRowOrTableElement->IsAnyOfHTMLElements(nsGkAtoms::td,
nsGkAtoms::th)) {
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
// We found a cell
cell = std::move(cellOrRowOrTableElement);
}
if (aCell) {
// we don't want to cell.forget() here, because we use it below.
*aCell = do_AddRef(cell).take();
}
// Get containing table
table = GetElementOrParentByTagNameInternal(*nsGkAtoms::table, *cell);
if (NS_WARN_IF(!table)) {
// Cell must be in a table, so fail if not found
return NS_ERROR_FAILURE;
}
if (aTable) {
table.forget(aTable);
}
// Get the rest of the related data only if requested
if (aRowIndex || aColumnIndex) {
ErrorResult error;
CellIndexes cellIndexes(*cell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (aRowIndex) {
*aRowIndex = cellIndexes.mRow;
}
if (aColumnIndex) {
*aColumnIndex = cellIndexes.mColumn;
}
}
if (aCellParent) {
// Get the immediate parent of the cell
nsCOMPtr<nsINode> cellParent = cell->GetParentNode();
// Cell has to have a parent, so fail if not found
NS_ENSURE_TRUE(cellParent, NS_ERROR_FAILURE);
if (aCellOffset) {
*aCellOffset = GetChildOffset(cell, cellParent);
}
// Now it's safe to hand over the reference to cellParent, since
// we don't need it anymore.
cellParent.forget(aCellParent);
}
return NS_OK;
}
// static
nsresult
HTMLEditor::GetCellFromRange(nsRange* aRange,
Element** aCell)
{
// Note: this might return a node that is outside of the range.
// Use carefully.
NS_ENSURE_TRUE(aRange && aCell, NS_ERROR_NULL_POINTER);
*aCell = nullptr;
nsCOMPtr<nsINode> startContainer = aRange->GetStartContainer();
if (NS_WARN_IF(!startContainer)) {
return NS_ERROR_FAILURE;
}
uint32_t startOffset = aRange->StartOffset();
nsCOMPtr<nsINode> childNode = aRange->GetChildAtStartOffset();
// This means selection is probably at a text node (or end of doc?)
if (!childNode) {
return NS_ERROR_FAILURE;
}
nsCOMPtr<nsINode> endContainer = aRange->GetEndContainer();
if (NS_WARN_IF(!endContainer)) {
return NS_ERROR_FAILURE;
}
// If a cell is deleted, the range is collapse
// (startOffset == aRange->EndOffset())
// so tell caller the cell wasn't found
if (startContainer == endContainer &&
aRange->EndOffset() == startOffset+1 &&
HTMLEditUtils::IsTableCell(childNode)) {
// Should we also test if frame is selected? (Use CellData)
// (Let's not for now -- more efficient)
RefPtr<Element> cellElement = childNode->AsElement();
cellElement.forget(aCell);
return NS_OK;
}
return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND;
}
NS_IMETHODIMP
HTMLEditor::GetFirstSelectedCell(nsRange** aFirstSelectedRange,
Element** aFirstSelectedCellElement)
{
if (NS_WARN_IF(!aFirstSelectedCellElement)) {
return NS_ERROR_INVALID_ARG;
}
*aFirstSelectedCellElement = nullptr;
if (aFirstSelectedRange) {
*aFirstSelectedRange = nullptr;
}
// XXX Oddly, when there is no ranges of Selection, we return error.
// However, despite of that we return NS_SUCCESS_EDITOR_ELEMENT_NOT_FOUND
// when first range of Selection does not select a table cell element.
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
RefPtr<Element> firstSelectedCellElement =
GetFirstSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!firstSelectedCellElement) {
// Just not found. Don't return error.
return NS_OK;
}
firstSelectedCellElement.forget(aFirstSelectedCellElement);
if (aFirstSelectedRange) {
// Returns the first range only when the caller requested the range.
RefPtr<nsRange> firstRange = selection->GetRangeAt(0);
MOZ_ASSERT(firstRange);
firstRange.forget(aFirstSelectedRange);
}
return NS_OK;
}
already_AddRefed<Element>
HTMLEditor::GetFirstSelectedTableCellElement(Selection& aSelection,
ErrorResult& aRv) const
{
MOZ_ASSERT(!aRv.Failed());
nsRange* firstRange = aSelection.GetRangeAt(0);
if (NS_WARN_IF(!firstRange)) {
// XXX Why don't we treat "not found" in this case?
aRv.Throw(NS_ERROR_FAILURE);
return nullptr;
}
// XXX It must be unclear when this is reset...
mSelectedCellIndex = 0;
RefPtr<Element> selectedCell;
nsresult rv =
HTMLEditor::GetCellFromRange(firstRange, getter_AddRefs(selectedCell));
if (NS_FAILED(rv)) {
// This case occurs only when Selection is in a text node in normal cases.
return nullptr;
}
if (!selectedCell) {
// This case means that the range does not select only a cell.
// E.g., selects non-table cell element, selects two or more cells, or
// does not select any cell element.
return nullptr;
}
// Setup for GetNextSelectedTableCellElement()
// XXX Oh, increment it now? Rather than when
// GetNextSelectedTableCellElement() is called?
mSelectedCellIndex = 1;
return selectedCell.forget();
}
NS_IMETHODIMP
HTMLEditor::GetNextSelectedCell(nsRange** aNextSelectedCellRange,
Element** aNextSelectedCellElement)
{
if (NS_WARN_IF(!aNextSelectedCellElement)) {
return NS_ERROR_INVALID_ARG;
}
*aNextSelectedCellElement = nullptr;
if (aNextSelectedCellRange) {
*aNextSelectedCellRange = nullptr;
}
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
RefPtr<Element> nextSelectedCellElement =
GetNextSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!nextSelectedCellElement) {
// not more range, or met a range which does not select <td> nor <th>.
return NS_OK;
}
if (aNextSelectedCellRange) {
MOZ_ASSERT(mSelectedCellIndex > 0);
*aNextSelectedCellRange =
do_AddRef(selection->GetRangeAt(mSelectedCellIndex - 1)).take();
}
nextSelectedCellElement.forget(aNextSelectedCellElement);
return NS_OK;
}
already_AddRefed<Element>
HTMLEditor::GetNextSelectedTableCellElement(Selection& aSelection,
ErrorResult& aRv) const
{
MOZ_ASSERT(!aRv.Failed());
if (mSelectedCellIndex >= aSelection.RangeCount()) {
// We've already returned all selected cells.
return nullptr;
}
MOZ_ASSERT(mSelectedCellIndex > 0);
for (; mSelectedCellIndex < aSelection.RangeCount(); mSelectedCellIndex++) {
nsRange* range = aSelection.GetRangeAt(mSelectedCellIndex);
if (NS_WARN_IF(!range)) {
aRv.Throw(NS_ERROR_FAILURE);
return nullptr;
}
RefPtr<Element> nextSelectedCellElement;
nsresult rv =
HTMLEditor::GetCellFromRange(range,
getter_AddRefs(nextSelectedCellElement));
if (NS_FAILED(rv)) {
// Failure means that the range is in non-element node, e.g., a text node.
// Returns nullptr without error if not found.
// XXX Why don't we just skip such range or incrementing
// mSelectedCellIndex for next call?
return nullptr;
}
if (nextSelectedCellElement) {
mSelectedCellIndex++;
return nextSelectedCellElement.forget();
}
}
// Returns nullptr without error if not found.
return nullptr;
}
NS_IMETHODIMP
HTMLEditor::GetFirstSelectedCellInTable(int32_t* aRowIndex,
int32_t* aColumnIndex,
Element** aCellElement)
{
if (NS_WARN_IF(!aRowIndex) || NS_WARN_IF(!aColumnIndex) ||
NS_WARN_IF(!aCellElement)) {
return NS_ERROR_INVALID_ARG;
}
*aRowIndex = 0;
*aColumnIndex = 0;
*aCellElement = nullptr;
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
ErrorResult error;
CellAndIndexes result(*this, *selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
result.mElement.forget(aCellElement);
*aRowIndex = std::max(result.mIndexes.mRow, 0);
*aColumnIndex = std::max(result.mIndexes.mColumn, 0);
return NS_OK;
}
void
HTMLEditor::CellAndIndexes::Update(HTMLEditor& aHTMLEditor,
Selection& aSelection,
ErrorResult& aRv)
{
MOZ_ASSERT(!aRv.Failed());
mIndexes.mRow = -1;
mIndexes.mColumn = -1;
mElement = aHTMLEditor.GetFirstSelectedTableCellElement(aSelection, aRv);
if (NS_WARN_IF(aRv.Failed())) {
return;
}
if (!mElement) {
return;
}
mIndexes.Update(*mElement, aRv);
NS_WARNING_ASSERTION(!aRv.Failed(),
"Selected element is found, but failed to compute its indexes");
}
void
HTMLEditor::SetSelectionAfterTableEdit(Element* aTable,
int32_t aRow,
int32_t aCol,
int32_t aDirection,
bool aSelected)
{
if (NS_WARN_IF(!aTable) || Destroyed()) {
return;
}
RefPtr<Selection> selection = GetSelection();
if (!selection) {
return;
}
RefPtr<Element> cell;
bool done = false;
do {
cell = GetTableCellElementAt(*aTable, aRow, aCol);
if (cell) {
if (aSelected) {
// Reselect the cell
DebugOnly<nsresult> rv = SelectContentInternal(*selection, *cell);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv),
"Failed to select the cell");
return;
}
// Set the caret to deepest first child
// but don't go into nested tables
// TODO: Should we really be placing the caret at the END
// of the cell content?
CollapseSelectionToDeepestNonTableFirstChild(selection, cell);
return;
}
// Setup index to find another cell in the
// direction requested, but move in other direction if already at
// beginning of row or column
switch (aDirection) {
case ePreviousColumn:
if (!aCol) {
if (aRow > 0) {
aRow--;
} else {
done = true;
}
} else {
aCol--;
}
break;
case ePreviousRow:
if (!aRow) {
if (aCol > 0) {
aCol--;
} else {
done = true;
}
} else {
aRow--;
}
break;
default:
done = true;
}
} while (!done);
// We didn't find a cell
// Set selection to just before the table
if (aTable->GetParentNode()) {
EditorRawDOMPoint atTable(aTable);
if (NS_WARN_IF(!atTable.IsSetAndValid())) {
return;
}
selection->Collapse(atTable);
return;
}
// Last resort: Set selection to start of doc
// (it's very bad to not have a valid selection!)
SetSelectionAtDocumentStart(selection);
}
NS_IMETHODIMP
HTMLEditor::GetSelectedOrParentTableElement(nsAString& aTagName,
int32_t* aSelectedCount,
Element** aCellOrRowOrTableElement)
{
if (NS_WARN_IF(!aSelectedCount) || NS_WARN_IF(!aCellOrRowOrTableElement)) {
return NS_ERROR_INVALID_ARG;
}
aTagName.Truncate();
*aCellOrRowOrTableElement = nullptr;
*aSelectedCount = 0;
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
bool isCellSelected = false;
ErrorResult aRv;
RefPtr<Element> cellOrRowOrTableElement =
GetSelectedOrParentTableElement(*selection, aRv, &isCellSelected);
if (NS_WARN_IF(aRv.Failed())) {
return aRv.StealNSResult();
}
if (!cellOrRowOrTableElement) {
return NS_OK;
}
if (isCellSelected) {
aTagName.AssignLiteral("td");
*aSelectedCount = selection->RangeCount();
cellOrRowOrTableElement.forget(aCellOrRowOrTableElement);
return NS_OK;
}
if (cellOrRowOrTableElement->IsAnyOfHTMLElements(nsGkAtoms::td,
nsGkAtoms::th)) {
aTagName.AssignLiteral("td");
// Keep *aSelectedCount as 0.
cellOrRowOrTableElement.forget(aCellOrRowOrTableElement);
return NS_OK;
}
if (cellOrRowOrTableElement->IsHTMLElement(nsGkAtoms::table)) {
aTagName.AssignLiteral("table");
*aSelectedCount = 1;
cellOrRowOrTableElement.forget(aCellOrRowOrTableElement);
return NS_OK;
}
if (cellOrRowOrTableElement->IsHTMLElement(nsGkAtoms::tr)) {
aTagName.AssignLiteral("tr");
*aSelectedCount = 1;
cellOrRowOrTableElement.forget(aCellOrRowOrTableElement);
return NS_OK;
}
MOZ_ASSERT_UNREACHABLE("Which element was returned?");
return NS_ERROR_UNEXPECTED;
}
already_AddRefed<Element>
HTMLEditor::GetSelectedOrParentTableElement(
Selection& aSelection,
ErrorResult& aRv,
bool* aIsCellSelected /* = nullptr */) const
{
MOZ_ASSERT(!aRv.Failed());
if (aIsCellSelected) {
*aIsCellSelected = false;
}
// Try to get the first selected cell, first.
RefPtr<Element> cellElement =
GetFirstSelectedTableCellElement(aSelection, aRv);
if (NS_WARN_IF(aRv.Failed())) {
return nullptr;
}
if (cellElement) {
if (aIsCellSelected) {
*aIsCellSelected = true;
}
return cellElement.forget();
}
const RangeBoundary& anchorRef = aSelection.AnchorRef();
if (NS_WARN_IF(!anchorRef.IsSet())) {
aRv.Throw(NS_ERROR_FAILURE);
return nullptr;
}
// If anchor selects a <td>, <table> or <tr>, return it.
if (anchorRef.Container()->HasChildNodes()) {
nsIContent* selectedContent = anchorRef.GetChildAtOffset();
if (selectedContent) {
// XXX Why do we ignore <th> element in this case?
if (selectedContent->IsHTMLElement(nsGkAtoms::td)) {
// FYI: If first range selects a <tr> element, but the other selects
// a <td> element, you can reach here.
// Each cell is in its own selection range in this case.
// XXX Although, other ranges may not select cells, though.
if (aIsCellSelected) {
*aIsCellSelected = true;
}
return do_AddRef(selectedContent->AsElement());
}
if (selectedContent->IsAnyOfHTMLElements(nsGkAtoms::table,
nsGkAtoms::tr)) {
return do_AddRef(selectedContent->AsElement());
}
}
}
// Then, look for a cell element (either <td> or <th>) which contains
// the anchor container.
cellElement = GetElementOrParentByTagNameInternal(*nsGkAtoms::td,
*anchorRef.Container());
if (!cellElement) {
return nullptr; // Not in table.
}
// Don't set *aIsCellSelected to true in this case because it does NOT
// select a cell, just in a cell.
return cellElement.forget();
}
NS_IMETHODIMP
HTMLEditor::GetSelectedCellsType(Element* aElement,
uint32_t* aSelectionType)
{
NS_ENSURE_ARG_POINTER(aSelectionType);
*aSelectionType = 0;
RefPtr<Selection> selection = GetSelection();
if (NS_WARN_IF(!selection)) {
return NS_ERROR_FAILURE;
}
// Be sure we have a table element
// (if aElement is null, this uses selection's anchor node)
RefPtr<Element> table;
if (aElement) {
table = GetElementOrParentByTagNameInternal(*nsGkAtoms::table, *aElement);
if (NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
} else {
table =
GetElementOrParentByTagNameAtSelection(*selection, *nsGkAtoms::table);
if (NS_WARN_IF(!table)) {
return NS_ERROR_FAILURE;
}
}
ErrorResult error;
TableSize tableSize(*this, *table, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
// Traverse all selected cells
RefPtr<Element> selectedCell =
GetFirstSelectedTableCellElement(*selection, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!selectedCell) {
return NS_OK;
}
// We have at least one selected cell, so set return value
*aSelectionType = static_cast<uint32_t>(TableSelection::Cell);
// Store indexes of each row/col to avoid duplication of searches
nsTArray<int32_t> indexArray;
bool allCellsInRowAreSelected = false;
bool allCellsInColAreSelected = false;
IgnoredErrorResult ignoredError;
while (selectedCell) {
CellIndexes selectedCellIndexes(*selectedCell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!indexArray.Contains(selectedCellIndexes.mColumn)) {
indexArray.AppendElement(selectedCellIndexes.mColumn);
allCellsInRowAreSelected =
AllCellsInRowSelected(table, selectedCellIndexes.mRow,
tableSize.mColumnCount);
// We're done as soon as we fail for any row
if (!allCellsInRowAreSelected) {
break;
}
}
selectedCell = GetNextSelectedTableCellElement(*selection, ignoredError);
NS_WARNING_ASSERTION(!ignoredError.Failed(),
"Failed to get next selected table cell element");
}
if (allCellsInRowAreSelected) {
*aSelectionType = static_cast<uint32_t>(TableSelection::Row);
return NS_OK;
}
// Test for columns
// Empty the indexArray
indexArray.Clear();
// Start at first cell again
selectedCell = GetFirstSelectedTableCellElement(*selection, ignoredError);
while (selectedCell) {
CellIndexes selectedCellIndexes(*selectedCell, error);
if (NS_WARN_IF(error.Failed())) {
return error.StealNSResult();
}
if (!indexArray.Contains(selectedCellIndexes.mRow)) {
indexArray.AppendElement(selectedCellIndexes.mColumn);
allCellsInColAreSelected =
AllCellsInColumnSelected(table, selectedCellIndexes.mColumn,
tableSize.mRowCount);
// We're done as soon as we fail for any column
if (!allCellsInRowAreSelected) {
break;
}
}
selectedCell = GetNextSelectedTableCellElement(*selection, ignoredError);
NS_WARNING_ASSERTION(!ignoredError.Failed(),
"Failed to get next selected table cell element");
}
if (allCellsInColAreSelected) {
*aSelectionType = static_cast<uint32_t>(TableSelection::Column);
}
return NS_OK;
}
bool
HTMLEditor::AllCellsInRowSelected(Element* aTable,
int32_t aRowIndex,
int32_t aNumberOfColumns)
{
if (NS_WARN_IF(!aTable)) {
return false;
}
IgnoredErrorResult ignoredError;
CellData cellData;
for (int32_t col = 0;
col < aNumberOfColumns;
col = cellData.NextColumnIndex()) {
cellData.Update(*this, *aTable, aRowIndex, col, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return false;
}
// If no cell, we may have a "ragged" right edge, so return TRUE only if
// we already found a cell in the row.
// XXX So, this does not assume that CellData returns error when just
// not found a cell. Fix this later.
if (NS_WARN_IF(!cellData.mElement)) {
return cellData.mCurrent.mColumn > 0;
}
// Return as soon as a non-selected cell is found.
// XXX Odd, this is testing if each cell element is selected. Why do
// we need to warn if it's false??
if (NS_WARN_IF(!cellData.mIsSelected)) {
return false;
}
MOZ_ASSERT(col < cellData.NextColumnIndex());
}
return true;
}
bool
HTMLEditor::AllCellsInColumnSelected(Element* aTable,
int32_t aColIndex,
int32_t aNumberOfRows)
{
if (NS_WARN_IF(!aTable)) {
return false;
}
IgnoredErrorResult ignoredError;
CellData cellData;
for (int32_t row = 0;
row < aNumberOfRows;
row = cellData.NextRowIndex()) {
cellData.Update(*this, *aTable, row, aColIndex, ignoredError);
if (NS_WARN_IF(cellData.FailedOrNotFound())) {
return false;
}
// If no cell, we must have a "ragged" right edge on the last column so
// return TRUE only if we already found a cell in the row.
// XXX So, this does not assume that CellData returns error when just
// not found a cell. Fix this later.
if (NS_WARN_IF(!cellData.mElement)) {
return cellData.mCurrent.mRow > 0;
}
// Return as soon as a non-selected cell is found.
// XXX Odd, this is testing if each cell element is selected. Why do
// we need to warn if it's false??
if (NS_WARN_IF(!cellData.mIsSelected)) {
return false;
}
MOZ_ASSERT(row < cellData.NextRowIndex());
}
return true;
}
bool
HTMLEditor::IsEmptyCell(dom::Element* aCell)
{
MOZ_ASSERT(aCell);
// Check if target only contains empty text node or <br>
nsCOMPtr<nsINode> cellChild = aCell->GetFirstChild();
if (!cellChild) {
return false;
}
nsCOMPtr<nsINode> nextChild = cellChild->GetNextSibling();
if (nextChild) {
return false;
}
// We insert a single break into a cell by default
// to have some place to locate a cursor -- it is dispensable
if (cellChild->IsHTMLElement(nsGkAtoms::br)) {
return true;
}
bool isEmpty;
// Or check if no real content
nsresult rv = IsEmptyNode(cellChild, &isEmpty, false, false);
NS_ENSURE_SUCCESS(rv, false);
return isEmpty;
}
} // namespace mozilla