1572375 - Move `TextEditRules::mPaddingBRElementForEmptyEditor` to `EditorBase`

Status: RESOLVED FIXED

(Core :: DOM: Editor, task, P3)

Description

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

We should move TextEditRules::mPaddingBRElementForEmptyEditor to EditorBase for first step of moving all members in TextEditRules and HTMLEditRules to editor classes.

Comment 1

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 1: Move `TextEditRules::mPaddingBRElementForEmptyEditor` to `EditorBase`

TextEditRules::mPaddingBRElementForEmptyEditor are used by both TextEditor
and HTMLEditor. Therefore, it should be in EditorBase.

This patch makes TextEditRules and HTMLEditRules directly access the
private member of EditorBase temporarily. It'll be fixed by the following
patches.

Comment 2

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 2: Split `TextEditRules::WillInsert()`

TextEditRules::WillInsert() is not used with initial purpose since
HTMLEditor always works with HTMLEditRules and its WillDoAction()
always handles EditSubAction::eInsertElement.

Additionally, its name is too generic since it does non-related 3 things.

One is checking whether the editor is readonly or disabled. However, this
may not be necessary since its callers may have already checked it or
just ignored the result. So, this should be check by each caller.

Next one is masking password if auto-masking is enabled. This is TextEditor
specific feature so that this patch moves the code into
TextEditor::MaybeDoAutoPasswordMasking().

Final one is removing empty <br> element for empty editor if there is.
This is common feature so that this patch moves this code into
EditorBase::EnsureNoPaddingBRElementForEmptyEditor().

Comment 3

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 3: Get rid of `TextEditRules::WillUndo()`, `TextEditRules::DidUndo()`, `TextEditRules::WillRedo()` and `TextEditRules::DidRedo()`

TextEditRules::WillUndo() and TextEditRules::WillRedo() only check whether
the editor is readonly/disabled or not. So, TextEditor::UndoAsAction() and
TextEditor::RedoAsAction() should do it first.

TextEditRules::DidUndo() and TextEditRules::DidRedo() only set or unset
mPaddingBRElementForEmptyEditor if it's restored by undo or redo.
Therefore, we can move the code into TextEditor::UndoAsAction() and
TextEditor::RedoAsAction().

Note that this patch makes TextEditor::UndoAsAction() discard the result of
TransactionManager::Undo() because this is inconsistent from what
TextEditor::RedoAsAction() does and this was changed by part 5 of bug 1447924.
https://hg.mozilla.org/mozilla-central/rev/869a1445816be7f43f54f7c97f28e4c6273fa75f

Comment 4

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 4: Move `TextEditRules::RemoveRedundantTrailingBR()` into `TextEditor`

TextEditRules::RemoveRedundantTrailingBR() is used only by multiline text
editor (i.e., <textarea>). Therefore, it should be moved into TextEditor.

Comment 5

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 5: Move `TextEditRules::CreatePaddingBRElementForEmptyEditorIfNeeded()` into `EditorBase`

TextEditRules::CreatePaddingBRElementForEmptyEditorIfNeeded() is used by
both TextEditor and HTMLEditor so that this moves it into EditorBase.

Additionally, making TextEditor::MaybeChangePaddingBRElementForEmptyEditor()
call it if there is no content. Then, we can avoid the dependency of them.

Comment 6

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 6: Get rid of `HTMLEditRules::WillLoadHTML()`

HTMLEditRules::WillLoadHTML() does exactly same thing as
EditorBase::EnsureNoPaddingBRElementForEmptyEditor(). Therefore, we can
get rid of it and make HTMLEditor::LoadHTML() not use HTMLEditRules.

Comment 7

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 7: Get rid of `HTMLEditRules::OnModifyDocument()`

HTMLEditRules::OnModifyDocument() is same as just calling
EditorBase::EnsureNoPaddingBRElementForEmptyEditor() and
EditorBase::MaybeCreatePaddingBRElementForEmptyEditor() so that this patch
gets rid of the method, then, creates HTMLEditor::OnModifyDocumentInternal()
and makes it do same thing.

Comment 8

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1572375 - part 8: Wrap `EditorBase::mPaddingBRElementForEmptyEditor` with an inline method

TextEditRules and HTMLEditRules still refer
EditorBase::mPaddingBRElementForEmptyEditor directly but this is really ugly.
Therefore, this patch creates EditorBase::HasPaddingBRElementForEmptyEditor()
for wrapping its access.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/235c10b6af84
part 1: Move `TextEditRules::mPaddingBRElementForEmptyEditor` to `EditorBase` r=m_kato
https://hg.mozilla.org/integration/autoland/rev/94b4e63c71df
part 2: Split `TextEditRules::WillInsert()` r=m_kato
https://hg.mozilla.org/integration/autoland/rev/e7d953d0be6c
part 3: Get rid of `TextEditRules::WillUndo()`, `TextEditRules::DidUndo()`, `TextEditRules::WillRedo()` and `TextEditRules::DidRedo()` r=m_kato
https://hg.mozilla.org/integration/autoland/rev/8059efaac8ca
part 4: Move `TextEditRules::RemoveRedundantTrailingBR()` into `TextEditor` r=m_kato
https://hg.mozilla.org/integration/autoland/rev/8c7339d7cd3b
part 5: Move `TextEditRules::CreatePaddingBRElementForEmptyEditorIfNeeded()` into `EditorBase` r=m_kato
https://hg.mozilla.org/integration/autoland/rev/e14e02842d3e
part 6: Get rid of `HTMLEditRules::WillLoadHTML()` r=m_kato
https://hg.mozilla.org/integration/autoland/rev/571000b4df5b
part 7: Get rid of `HTMLEditRules::OnModifyDocument()` r=m_kato
https://hg.mozilla.org/integration/autoland/rev/3a07d2f4b955
part 8: Wrap `EditorBase::mPaddingBRElementForEmptyEditor` with an inline method r=m_kato

Comment 10

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/235c10b6af84
https://hg.mozilla.org/mozilla-central/rev/94b4e63c71df
https://hg.mozilla.org/mozilla-central/rev/e7d953d0be6c
https://hg.mozilla.org/mozilla-central/rev/8059efaac8ca
https://hg.mozilla.org/mozilla-central/rev/8c7339d7cd3b
https://hg.mozilla.org/mozilla-central/rev/e14e02842d3e
https://hg.mozilla.org/mozilla-central/rev/571000b4df5b
https://hg.mozilla.org/mozilla-central/rev/3a07d2f4b955