"""
novelWriter – Main GUI Editor Class Tester
==========================================

This file is a part of novelWriter
Copyright 2018–2024, Veronica Berglyd Olsen

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
"""
from __future__ import annotations

import pytest

from mocked import causeOSError
from tools import C, buildTestProject

from PyQt5.QtCore import QThreadPool, Qt
from PyQt5.QtGui import QClipboard, QTextBlock, QTextCursor, QTextOption
from PyQt5.QtWidgets import QAction, QApplication, QMenu

from novelwriter import CONFIG, SHARED
from novelwriter.constants import nwKeyWords, nwUnicode
from novelwriter.dialogs.editlabel import GuiEditLabel
from novelwriter.enum import (
    nwDocAction, nwDocInsert, nwItemClass, nwItemLayout, nwTrinary, nwWidget
)
from novelwriter.gui.doceditor import GuiDocEditor, GuiDocToolBar
from novelwriter.text.counting import standardCounter
from novelwriter.types import QtAlignJustify, QtAlignLeft, QtKeepAnchor, QtMouseLeft, QtMoveRight

KEY_DELAY = 1


@pytest.mark.gui
def testGuiEditor_Init(qtbot, nwGUI, projPath, ipsumText, mockRnd):
    """Test initialising the editor."""
    # Open project
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc)

    nwGUI.docEditor.setPlainText("### Lorem Ipsum\n\n%s" % ipsumText[0])
    nwGUI.saveDocument()

    # Check Defaults
    qDoc = nwGUI.docEditor.document()
    assert qDoc.defaultTextOption().alignment() == QtAlignLeft
    assert nwGUI.docEditor.verticalScrollBarPolicy() == Qt.ScrollBarAsNeeded
    assert nwGUI.docEditor.horizontalScrollBarPolicy() == Qt.ScrollBarAsNeeded
    assert nwGUI.docEditor._typPadChar == nwUnicode.U_NBSP
    assert nwGUI.docEditor.docHeader.itemTitle.text() == (
        "Novel  \u203a  New Chapter  \u203a  New Scene"
    )
    assert nwGUI.docEditor.docHeader._docOutline == {0: "### New Scene"}

    # Check that editor handles settings
    CONFIG.textFont = ""
    CONFIG.doJustify = True
    CONFIG.showTabsNSpaces = True
    CONFIG.showLineEndings = True
    CONFIG.hideVScroll = True
    CONFIG.hideHScroll = True
    CONFIG.fmtPadThin = True
    CONFIG.showFullPath = False

    nwGUI.docEditor.initEditor()

    qDoc = nwGUI.docEditor.document()
    assert CONFIG.textFont == qDoc.defaultFont().family()
    assert qDoc.defaultTextOption().alignment() == QtAlignJustify
    assert qDoc.defaultTextOption().flags() & QTextOption.ShowTabsAndSpaces
    assert qDoc.defaultTextOption().flags() & QTextOption.ShowLineAndParagraphSeparators
    assert nwGUI.docEditor.verticalScrollBarPolicy() == Qt.ScrollBarAlwaysOff
    assert nwGUI.docEditor.horizontalScrollBarPolicy() == Qt.ScrollBarAlwaysOff
    assert nwGUI.docEditor._typPadChar == nwUnicode.U_THNBSP
    assert nwGUI.docEditor.docHeader.itemTitle.text() == "New Scene"

    # Header
    # ======

    # Go to outline
    nwGUI.docEditor.setCursorLine(3)
    nwGUI.docEditor.docHeader.outlineMenu.actions()[0].trigger()
    assert nwGUI.docEditor.getCursorPosition() == 0

    # Select item from header
    with qtbot.waitSignal(nwGUI.docEditor.requestProjectItemSelected, timeout=1000) as signal:
        qtbot.mouseClick(nwGUI.docEditor.docHeader, QtMouseLeft)
        assert signal.args == [nwGUI.docEditor.docHeader._docHandle, True]

    # Close from header
    with qtbot.waitSignal(nwGUI.docEditor.docHeader.closeDocumentRequest, timeout=1000):
        nwGUI.docEditor.docHeader.closeButton.click()

    assert nwGUI.docEditor.docHeader.tbButton.isVisible() is False
    assert nwGUI.docEditor.docHeader.searchButton.isVisible() is False
    assert nwGUI.docEditor.docHeader.closeButton.isVisible() is False
    assert nwGUI.docEditor.docHeader.minmaxButton.isVisible() is False

    # Select item from header
    with qtbot.waitSignal(nwGUI.docEditor.requestProjectItemSelected, timeout=1000) as signal:
        qtbot.mouseClick(nwGUI.docEditor.docHeader, QtMouseLeft)
        assert signal.args == ["", True]

    # qtbot.stop()

# END Test testGuiEditor_Init


@pytest.mark.gui
def testGuiEditor_LoadText(qtbot, nwGUI, projPath, ipsumText, mockRnd):
    """Test loading text into the editor."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    longText = "### Lorem Ipsum\n\n%s" % "\n\n".join(ipsumText*20)
    nwGUI.docEditor.replaceText(longText)
    nwGUI.saveDocument()
    nwGUI.closeDocument()

    # Invalid handle
    assert nwGUI.docEditor.loadText("abcdefghijklm") is False

    # Regular open
    assert nwGUI.docEditor.loadText(C.hSceneDoc) is True

    # Regular open, with line number (1 indexed)
    assert nwGUI.docEditor.loadText(C.hSceneDoc, tLine=4) is True
    cursPos = nwGUI.docEditor.getCursorPosition()
    assert nwGUI.docEditor.document().findBlock(cursPos).blockNumber() == 3

    # Load empty document
    nwGUI.docEditor.replaceText("")
    nwGUI.saveDocument()
    assert nwGUI.docEditor.loadText(C.hSceneDoc) is True
    assert nwGUI.docEditor.toPlainText() == ""

    # qtbot.stop()

# END Test testGuiEditor_LoadText


@pytest.mark.gui
def testGuiEditor_SaveText(qtbot, monkeypatch, caplog, nwGUI, projPath, ipsumText, mockRnd):
    """Test saving text from the editor."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    longText = "### Lorem Ipsum\n\n%s" % "\n\n".join(ipsumText)
    nwGUI.docEditor.replaceText(longText)

    # Missing item
    nwItem = nwGUI.docEditor._nwItem
    nwGUI.docEditor._nwItem = None
    assert nwGUI.docEditor.saveText() is False
    nwGUI.docEditor._nwItem = nwItem

    # Unknown handle
    nwGUI.docEditor._docHandle = "0123456789abcdef"
    assert nwGUI.docEditor.saveText() is False
    nwGUI.docEditor._docHandle = C.hSceneDoc

    # Cause error when saving
    with monkeypatch.context() as mp:
        mp.setattr("builtins.open", causeOSError)
        assert nwGUI.docEditor.saveText() is False
        assert "Could not save document." in caplog.text

    # Change header level
    assert SHARED.project.tree[C.hSceneDoc].itemLayout == nwItemLayout.DOCUMENT  # type: ignore
    nwGUI.docEditor.replaceText(longText[1:])
    assert nwGUI.docEditor.saveText() is True
    assert SHARED.project.tree[C.hSceneDoc].itemLayout == nwItemLayout.DOCUMENT  # type: ignore

    # Regular save
    assert nwGUI.docEditor.saveText() is True

    # qtbot.stop()

# END Test testGuiEditor_SaveText


@pytest.mark.gui
def testGuiEditor_MetaData(qtbot, nwGUI, projPath, mockRnd):
    """Test extracting various meta data and other values."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    # Get Text
    # This should replace line and paragraph separators, but preserve
    # non-breaking spaces.
    newText = (
        "### New Scene\u2029\u2029"
        "Some\u2028text.\u2029"
        "More\u00a0text.\u2029"
    )
    nwGUI.docEditor.replaceText(newText)
    assert nwGUI.docEditor.getText() == (
        "### New Scene\n\n"
        "Some\n"
        "text.\n"
        "More\u00a0text.\n"
    )

    # Check Properties
    assert nwGUI.docEditor.docChanged is True
    assert nwGUI.docEditor.docHandle == C.hSceneDoc
    assert nwGUI.docEditor.lastActive > 0.0
    assert nwGUI.docEditor.isEmpty is False

    # Cursor Position
    nwGUI.docEditor.setCursorPosition(10)
    assert nwGUI.docEditor.getCursorPosition() == 10
    assert SHARED.project.tree[C.hSceneDoc].cursorPos != 10  # type: ignore
    nwGUI.docEditor.saveCursorPosition()
    assert SHARED.project.tree[C.hSceneDoc].cursorPos == 10  # type: ignore

    nwGUI.docEditor.setCursorLine(None)
    assert nwGUI.docEditor.getCursorPosition() == 10
    nwGUI.docEditor.setCursorLine(3)
    assert nwGUI.docEditor.getCursorPosition() == 15

    # Document Changed Signal
    nwGUI.docEditor._docChanged = False
    with qtbot.waitSignal(nwGUI.docEditor.editedStatusChanged, raising=True, timeout=100):
        nwGUI.docEditor.setDocumentChanged(True)
    assert nwGUI.docEditor._docChanged is True

    # qtbot.stop()

# END Test testGuiEditor_MetaData


@pytest.mark.gui
def testGuiEditor_ContextMenu(monkeypatch, qtbot, nwGUI, projPath, mockRnd):
    """Test the editor context menu."""
    monkeypatch.setattr(QMenu, "exec", lambda *a: None)

    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True
    docEditor = nwGUI.docEditor
    sceneItem = SHARED.project.tree[C.hSceneDoc]
    assert sceneItem is not None

    def getMenuForPos(pos: int, select: bool = False) -> QMenu | None:
        nonlocal docEditor
        cursor = docEditor.textCursor()
        cursor.setPosition(pos)
        if select:
            cursor.select(QTextCursor.SelectionType.WordUnderCursor)
        docEditor.setTextCursor(cursor)
        docEditor._openContextMenu(docEditor.cursorRect().center())
        for obj in docEditor.children():
            if isinstance(obj, QMenu) and obj.objectName() == "ContextMenu":
                return obj
        return None

    docText = (
        "### A Scene\n\n"
        "@pov: Jane\n"
        "Some text ..."
    )
    docEditor.setPlainText(docText)
    assert docEditor.getText() == docText

    # Rename Item from Heading
    ctxMenu = getMenuForPos(1)
    assert ctxMenu is not None
    actions = [x.text() for x in ctxMenu.actions() if x.text()]
    assert actions == [
        "Set as Document Name", "Paste",
        "Select All", "Select Word", "Select Paragraph"
    ]
    with monkeypatch.context() as mp:
        mp.setattr(GuiEditLabel, "getLabel", lambda a, text: (text, True))
        assert sceneItem.itemName == "New Scene"
        ctxMenu.actions()[0].trigger()
        assert sceneItem.itemName == "A Scene"
    ctxMenu.setObjectName("")
    ctxMenu.deleteLater()

    # Create Character
    ctxMenu = getMenuForPos(21)
    assert ctxMenu is not None
    actions = [x.text() for x in ctxMenu.actions() if x.text()]
    assert actions == [
        "Create Note for Tag", "Paste",
        "Select All", "Select Word", "Select Paragraph"
    ]
    ctxMenu.actions()[0].trigger()
    janeItem = SHARED.project.tree["0000000000010"]
    assert janeItem is not None
    assert janeItem.itemName == "Jane"
    ctxMenu.setObjectName("")
    ctxMenu.deleteLater()

    # Follow Character Tag
    ctxMenu = getMenuForPos(21)
    assert ctxMenu is not None
    actions = [x.text() for x in ctxMenu.actions() if x.text()]
    assert actions == [
        "Follow Tag", "Paste",
        "Select All", "Select Word", "Select Paragraph"
    ]
    ctxMenu.actions()[0].trigger()
    assert nwGUI.docViewer.docHandle == "0000000000010"
    ctxMenu.setObjectName("")
    ctxMenu.deleteLater()

    # Select Word
    ctxMenu = getMenuForPos(31)
    assert ctxMenu is not None
    actions = [x.text() for x in ctxMenu.actions() if x.text()]
    assert actions == [
        "Paste", "Select All", "Select Word", "Select Paragraph"
    ]
    ctxMenu.actions()[3].trigger()
    assert docEditor.textCursor().selectedText() == "text"
    ctxMenu.setObjectName("")
    ctxMenu.deleteLater()

    # Select Paragraph
    ctxMenu = getMenuForPos(31)
    assert ctxMenu is not None
    actions = [x.text() for x in ctxMenu.actions() if x.text()]
    assert actions == [
        "Paste", "Select All", "Select Word", "Select Paragraph"
    ]
    ctxMenu.actions()[4].trigger()
    assert docEditor.textCursor().selectedText() == "Some text ..."
    ctxMenu.setObjectName("")
    ctxMenu.deleteLater()

    # Select All
    ctxMenu = getMenuForPos(31)
    assert ctxMenu is not None
    actions = [x.text() for x in ctxMenu.actions() if x.text()]
    assert actions == [
        "Paste", "Select All", "Select Word", "Select Paragraph"
    ]
    ctxMenu.actions()[2].trigger()
    assert docEditor.textCursor().selectedText() == docEditor.document().toRawText()
    ctxMenu.setObjectName("")
    ctxMenu.deleteLater()

    # Copy Text
    ctxMenu = getMenuForPos(31, True)
    assert ctxMenu is not None
    assert docEditor.textCursor().selectedText() == "text"
    actions = [x.text() for x in ctxMenu.actions() if x.text()]
    assert actions == [
        "Cut", "Copy", "Paste", "Select All", "Select Word", "Select Paragraph"
    ]
    QApplication.clipboard().clear()
    ctxMenu.actions()[1].trigger()
    assert QApplication.clipboard().text(QClipboard.Mode.Clipboard) == "text"

    # Cut Text
    QApplication.clipboard().clear()
    ctxMenu.actions()[0].trigger()
    assert QApplication.clipboard().text(QClipboard.Mode.Clipboard) == "text"
    assert "text" not in docEditor.getText()

    # Paste Text
    ctxMenu.actions()[2].trigger()
    assert docEditor.getText() == docText

    ctxMenu.setObjectName("")
    ctxMenu.deleteLater()

    # qtbot.stop()

# END Test testGuiEditor_ContextMenu


@pytest.mark.gui
def testGuiEditor_Actions(qtbot, nwGUI, projPath, ipsumText, mockRnd):
    """Test the document actions. This is not an extensive test of the
    action features, just that the actions are actually called. The
    various action features are tested when their respective functions
    are tested.
    """
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    text = "### A Scene\n\n%s" % "\n\n".join(ipsumText)
    nwGUI.docEditor.replaceText(text)
    doc = nwGUI.docEditor.document()

    # Select/Cut/Copy/Paste/Undo/Redo
    # ===============================

    QApplication.clipboard().clear()

    # Select All
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_ALL) is True
    cursor = nwGUI.docEditor.textCursor()
    assert cursor.hasSelection() is True
    assert cursor.selectedText() == text.replace("\n", "\u2029")
    cursor.clearSelection()

    # Select Paragraph
    nwGUI.docEditor.setCursorPosition(1000)
    assert nwGUI.docEditor.getCursorPosition() == 1000
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_PARA) is True
    cursor = nwGUI.docEditor.textCursor()
    assert cursor.selectedText() == ipsumText[1]

    # Cut Selected Text
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(1000)
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_PARA) is True
    assert nwGUI.docEditor.docAction(nwDocAction.CUT) is True

    newText = nwGUI.docEditor.getText()
    newPara = list(filter(str.strip, newText.split("\n")))
    assert newPara[0] == "### A Scene"
    assert newPara[1] == ipsumText[0]
    assert newPara[2] == ipsumText[2]
    assert newPara[3] == ipsumText[3]
    assert newPara[4] == ipsumText[4]

    # Paste Back In
    assert nwGUI.docEditor.docAction(nwDocAction.PASTE) is True
    assert nwGUI.docEditor.getText() == text

    # Copy Next Paragraph
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(1500)
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_PARA) is True
    assert nwGUI.docEditor.docAction(nwDocAction.COPY) is True

    # Paste at End
    nwGUI.docEditor.setCursorPosition(doc.characterCount())
    cursor = nwGUI.docEditor.textCursor()
    cursor.insertBlock()
    cursor.insertBlock()

    assert nwGUI.docEditor.docAction(nwDocAction.PASTE) is True
    newText = nwGUI.docEditor.getText()
    newPara = list(filter(str.strip, newText.split("\n")))
    assert newPara[5] == ipsumText[4]
    assert newPara[6] == ipsumText[2]

    QApplication.clipboard().clear()

    # Emphasis/Undo/Redo
    # ==================

    text = "### A Scene\n\n%s" % ipsumText[0]
    nwGUI.docEditor.replaceText(text)

    # Emphasis
    nwGUI.docEditor.setCursorPosition(50)
    assert nwGUI.docEditor.docAction(nwDocAction.MD_ITALIC) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "_consectetur_")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Strong
    nwGUI.docEditor.setCursorPosition(50)
    assert nwGUI.docEditor.docAction(nwDocAction.MD_BOLD) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "**consectetur**")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Strikeout
    nwGUI.docEditor.setCursorPosition(50)
    assert nwGUI.docEditor.docAction(nwDocAction.MD_STRIKE) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "~~consectetur~~")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Redo
    assert nwGUI.docEditor.docAction(nwDocAction.REDO) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "~~consectetur~~")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Shortcodes
    # ==========

    text = "### A Scene\n\n%s" % ipsumText[0]
    nwGUI.docEditor.replaceText(text)

    # Italic
    nwGUI.docEditor.setCursorPosition(46)
    assert nwGUI.docEditor.docAction(nwDocAction.SC_ITALIC) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "[i]consectetur[/i]")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Bold
    nwGUI.docEditor.setCursorPosition(46)
    assert nwGUI.docEditor.docAction(nwDocAction.SC_BOLD) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "[b]consectetur[/b]")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Strikethrough
    nwGUI.docEditor.setCursorPosition(46)
    assert nwGUI.docEditor.docAction(nwDocAction.SC_STRIKE) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "[s]consectetur[/s]")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Underline
    nwGUI.docEditor.setCursorPosition(46)
    assert nwGUI.docEditor.docAction(nwDocAction.SC_ULINE) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "[u]consectetur[/u]")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Mark
    nwGUI.docEditor.setCursorPosition(46)
    assert nwGUI.docEditor.docAction(nwDocAction.SC_MARK) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "[m]consectetur[/m]")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Superscript
    nwGUI.docEditor.setCursorPosition(46)
    assert nwGUI.docEditor.docAction(nwDocAction.SC_SUP) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "[sup]consectetur[/sup]")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Subscript
    nwGUI.docEditor.setCursorPosition(46)
    assert nwGUI.docEditor.docAction(nwDocAction.SC_SUB) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "[sub]consectetur[/sub]")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Quotes
    # ======

    text = "### A Scene\n\n%s" % ipsumText[0]
    nwGUI.docEditor.replaceText(text)

    # Add Single Quotes
    nwGUI.docEditor.setCursorPosition(50)
    assert nwGUI.docEditor.docAction(nwDocAction.S_QUOTE) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "\u2018consectetur\u2019")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Add Double Quotes
    nwGUI.docEditor.setCursorPosition(50)
    assert nwGUI.docEditor.docAction(nwDocAction.D_QUOTE) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "\u201cconsectetur\u201d")
    assert nwGUI.docEditor.docAction(nwDocAction.UNDO) is True
    assert nwGUI.docEditor.getText() == text

    # Replace Single Quotes
    repText = text.replace("consectetur", "'consectetur'")
    nwGUI.docEditor.replaceText(repText)
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_ALL) is True
    assert nwGUI.docEditor.docAction(nwDocAction.REPL_SNG) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "\u2018consectetur\u2019")

    # Replace Double Quotes
    repText = text.replace("consectetur", "\"consectetur\"")
    nwGUI.docEditor.replaceText(repText)
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_ALL) is True
    assert nwGUI.docEditor.docAction(nwDocAction.REPL_DBL) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "\u201cconsectetur\u201d")

    # Remove Line Breaks
    # ==================

    text = "### A Scene\n\n%s" % ipsumText[0]
    repText = text[:100] + text[100:].replace(" ", "\n", 3)
    nwGUI.docEditor.replaceText(repText)
    assert nwGUI.docEditor.docAction(nwDocAction.RM_BREAKS) is True
    assert nwGUI.docEditor.getText().strip() == text.strip()

    # Format Block
    # ============

    text = "## Scene Title\n\nScene text.\n\n"
    nwGUI.docEditor.replaceText(text)

    # Header 1
    nwGUI.docEditor.setCursorPosition(0)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_H1) is True
    assert nwGUI.docEditor.getText() == "# Scene Title\n\nScene text.\n\n"

    # Header 2
    nwGUI.docEditor.setCursorPosition(0)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_H2) is True
    assert nwGUI.docEditor.getText() == "## Scene Title\n\nScene text.\n\n"

    # Header 3
    nwGUI.docEditor.setCursorPosition(0)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_H3) is True
    assert nwGUI.docEditor.getText() == "### Scene Title\n\nScene text.\n\n"

    # Header 4
    nwGUI.docEditor.setCursorPosition(0)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_H4) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\nScene text.\n\n"

    # Comment
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_COM) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\n% Scene text.\n\n"

    # Ignore Text
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_IGN) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\n%~ Scene text.\n\n"

    # Text
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\nScene text.\n\n"

    # Align Left
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.ALIGN_L) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\nScene text. <<\n\n"

    # Align Right
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.ALIGN_R) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\n>> Scene text.\n\n"

    # Align Centre
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.ALIGN_C) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\n>> Scene text. <<\n\n"

    # Indent Left
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.INDENT_L) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\n> Scene text.\n\n"

    # Indent Right
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.INDENT_R) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\n> Scene text. <\n\n"

    # Text (Reset)
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "#### Scene Title\n\nScene text.\n\n"

    # Invalid Actions
    # ===============

    # No Document Handle
    nwGUI.docEditor._docHandle = None
    assert nwGUI.docEditor.docAction(nwDocAction.BLOCK_TXT) is False
    nwGUI.docEditor._docHandle = C.hSceneDoc

    # Wrong Action Type
    assert nwGUI.docEditor.docAction(None) is False

    # Unknown Action
    assert nwGUI.docEditor.docAction(nwDocAction.NO_ACTION) is False

    # qtbot.stop()

# END Test testGuiEditor_Actions


@pytest.mark.gui
def testGuiEditor_ToolBar(qtbot, nwGUI, projPath, mockRnd):
    """Test the document actions. This is not an extensive test of the
    action features, just that the actions are actually called. The
    various action features are tested when their respective functions
    are tested.
    """
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    docEditor: GuiDocEditor = nwGUI.docEditor
    docToolBar: GuiDocToolBar = docEditor.docToolBar

    text = (
        "### A Scene\n\n"
        "Text bold one\n\n"
        "Text bold two\n\n"
        "Text italic one\n\n"
        "Text italic two\n\n"
        "Text strikethrough one\n\n"
        "Text strikethrough two\n\n"
        "Text underline one\n\n"
        "Text superscript one\n\n"
        "Text subscript one\n\n"
    )
    length = len(text)
    docEditor.replaceText(text)
    assert len(docEditor.getText()) == length

    # Show the ToolBar
    assert docToolBar.isVisible() is False
    docEditor._toggleToolBarVisibility()
    assert docToolBar.isVisible() is True

    # Markdown
    # ========

    # Click Bold
    docEditor.setCursorPosition(20)
    docToolBar.tbBoldMD.click()
    assert len(docEditor.getText()) == length + 4

    # Click Italic
    docEditor.setCursorPosition(54)
    docToolBar.tbItalicMD.click()
    assert len(docEditor.getText()) == length + 6

    # Click Strikethrough
    docEditor.setCursorPosition(90)
    docToolBar.tbStrikeMD.click()
    assert len(docEditor.getText()) == length + 10

    # Shortcodes
    # ==========

    # Click Bold
    docEditor.setCursorPosition(39)
    docToolBar.tbBold.click()
    assert len(docEditor.getText()) == length + 17

    # Click Italic
    docEditor.setCursorPosition(80)
    docToolBar.tbItalic.click()
    assert len(docEditor.getText()) == length + 24

    # Click Strikethrough
    docEditor.setCursorPosition(132)
    docToolBar.tbStrike.click()
    assert len(docEditor.getText()) == length + 31

    # Click Underline
    docEditor.setCursorPosition(163)
    docToolBar.tbUnderline.click()
    assert len(docEditor.getText()) == length + 38

    # Click Superscript
    docEditor.setCursorPosition(190)
    docToolBar.tbSuperscript.click()
    assert len(docEditor.getText()) == length + 49

    # Click Subscript
    docEditor.setCursorPosition(223)
    docToolBar.tbSubscript.click()
    assert len(docEditor.getText()) == length + 60

    # Check Result
    assert docEditor.getText() == (
        "### A Scene\n\n"
        "Text **bold** one\n\n"
        "Text [b]bold[/b] two\n\n"
        "Text _italic_ one\n\n"
        "Text [i]italic[/i] two\n\n"
        "Text ~~strikethrough~~ one\n\n"
        "Text [s]strikethrough[/s] two\n\n"
        "Text [u]underline[/u] one\n\n"
        "Text [sup]superscript[/sup] one\n\n"
        "Text [sub]subscript[/sub] one\n\n"
    )

    # qtbot.stop()

# END Test testGuiEditor_ToolBar


@pytest.mark.gui
def testGuiEditor_Insert(qtbot, monkeypatch, nwGUI, projPath, ipsumText, mockRnd):
    """Test the document insert functions."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    text = "### A Scene\n\n%s" % "\n\n".join(ipsumText)
    nwGUI.docEditor.replaceText(text)

    # Insert Text
    # ===========

    text = "### A Scene\n\n%s" % ipsumText[0]
    nwGUI.docEditor.replaceText(text)

    # No Document Handle
    nwGUI.docEditor._docHandle = None
    nwGUI.docEditor.setCursorPosition(24)
    assert nwGUI.docEditor.insertText("Stuff") is False
    nwGUI.docEditor._docHandle = C.hSceneDoc

    # Insert String
    nwGUI.docEditor.setCursorPosition(24)
    assert nwGUI.docEditor.insertText(", ipsumer,") is True
    assert nwGUI.docEditor.getText() == text[:24] + ", ipsumer," + text[24:]

    # Single Quotes
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(41)
    assert nwGUI.docEditor.insertText(nwDocInsert.QUOTE_LS) is True
    nwGUI.docEditor.setCursorPosition(53)
    assert nwGUI.docEditor.insertText(nwDocInsert.QUOTE_RS) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "\u2018consectetur\u2019")

    # Double Quotes
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(41)
    assert nwGUI.docEditor.insertText(nwDocInsert.QUOTE_LD) is True
    nwGUI.docEditor.setCursorPosition(53)
    assert nwGUI.docEditor.insertText(nwDocInsert.QUOTE_RD) is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "\u201cconsectetur\u201d")

    # Invalid Inserts
    assert nwGUI.docEditor.insertText(nwDocInsert.NO_INSERT) is False
    assert nwGUI.docEditor.insertText(123) is False

    # Insert KeyWords
    # ===============

    text = "### A Scene\n\n\n%s" % ipsumText[0]
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorLine(3)

    # Invalid Keyword
    assert nwGUI.docEditor.insertKeyWord("stuff") is False
    assert nwGUI.docEditor.getText() == text

    # Valid Keyword
    assert nwGUI.docEditor.insertKeyWord(nwKeyWords.POV_KEY) is True
    assert nwGUI.docEditor.insertText("Jane\n")
    assert nwGUI.docEditor.getText() == text.replace(
        "\n\n\n", "\n\n@pov: Jane\n\n", 1
    )

    # Invalid Block
    with monkeypatch.context() as mp:
        mp.setattr(QTextBlock, "isValid", lambda *a, **k: False)
        assert nwGUI.docEditor.insertKeyWord(nwKeyWords.POV_KEY) is False

    # Insert In-Block
    nwGUI.docEditor.setCursorPosition(20)
    assert nwGUI.docEditor.insertKeyWord(nwKeyWords.CHAR_KEY) is True
    assert nwGUI.docEditor.insertText("John")
    assert nwGUI.docEditor.getText() == text.replace(
        "\n\n\n", "\n\n@pov: Jane\n@char: John\n\n", 1
    )

    # qtbot.stop()

# END Test testGuiEditor_Insert


@pytest.mark.gui
def testGuiEditor_TextManipulation(qtbot, nwGUI, projPath, ipsumText, mockRnd):
    """Test the text manipulation functions."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    text = "### A Scene\n\n%s" % "\n\n".join(ipsumText)
    nwGUI.docEditor.replaceText(text)

    # Wrap Selection
    # ==============

    text = "### A Scene\n\n%s" % "\n\n".join(ipsumText[0:2])
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)

    # Wrap Equal
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._wrapSelection("=") is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "=consectetur=")

    # Wrap Unequal
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._wrapSelection("=", "*") is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "=consectetur*")

    # Past Paragraph
    nwGUI.docEditor.replaceText(text)
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(13, QTextCursor.MoveAnchor)
    cursor.setPosition(1000, QTextCursor.KeepAnchor)
    nwGUI.docEditor.setTextCursor(cursor)
    assert nwGUI.docEditor._wrapSelection("=") is True

    newText = nwGUI.docEditor.getText()
    newPara = list(filter(str.strip, newText.split("\n")))
    assert newPara[1] == "="+ipsumText[0]+"="
    assert newPara[2] == ipsumText[1]

    # Toggle Format
    # =============

    text = "### A Scene\n\n%s" % "\n\n".join(ipsumText[0:2])

    # Block format repetition
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(39)
    assert nwGUI.docEditor._toggleFormat(1, "=") is True
    assert nwGUI.docEditor.getText() == text.replace("amet", "=amet=", 1)
    assert nwGUI.docEditor._toggleFormat(1, "=") is False

    # Wrap Single Equal
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._toggleFormat(1, "=") is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "=consectetur=")

    # Past Paragraph
    nwGUI.docEditor.replaceText(text)
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(13, QTextCursor.MoveAnchor)
    cursor.setPosition(1000, QTextCursor.KeepAnchor)
    nwGUI.docEditor.setTextCursor(cursor)
    assert nwGUI.docEditor._toggleFormat(1, "=") is True

    newText = nwGUI.docEditor.getText()
    newPara = list(filter(str.strip, newText.split("\n")))
    assert newPara[1] == "="+ipsumText[0]+"="
    assert newPara[2] == ipsumText[1]

    # Wrap Double Equal
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._toggleFormat(2, "=") is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "==consectetur==")

    # Toggle Double Equal
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._toggleFormat(2, "=") is True
    assert nwGUI.docEditor._toggleFormat(2, "=") is True
    assert nwGUI.docEditor.getText() == text

    # Toggle Triple+Double Equal
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._toggleFormat(3, "=") is True
    assert nwGUI.docEditor._toggleFormat(2, "=") is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "=consectetur=")

    # Toggle Unequal
    repText = text.replace("consectetur", "=consectetur==")
    nwGUI.docEditor.replaceText(repText)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._toggleFormat(1, "=") is True
    assert nwGUI.docEditor.getText() == text.replace("consectetur", "consectetur=")
    assert nwGUI.docEditor._toggleFormat(1, "=") is True
    assert nwGUI.docEditor.getText() == repText

    # Replace Quotes
    # ==============

    # No Selection
    text = "### A Scene\n\n%s" % ipsumText[0].replace("consectetur", "=consectetur=")
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor._replaceQuotes("=", "<", ">") is False

    # First Paragraph Selected
    # This should not replace anything in second paragraph
    text = "### A Scene\n\n%s" % "\n\n".join(ipsumText[0:2]).replace("ipsum", "=ipsum=")
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_PARA)
    assert nwGUI.docEditor._replaceQuotes("=", "<", ">") is True

    newText = nwGUI.docEditor.getText()
    newPara = list(filter(str.strip, newText.split("\n")))
    assert newPara[1] == ipsumText[0].replace("ipsum", "<ipsum>")
    assert newPara[2] == ipsumText[1].replace("ipsum", "=ipsum=")

    # Edge of Document
    text = ipsumText[0].replace("Lorem", "=Lorem=")
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert nwGUI.docEditor.docAction(nwDocAction.SEL_ALL)
    assert nwGUI.docEditor._replaceQuotes("=", "<", ">") is True
    assert nwGUI.docEditor.getText() == text.replace("=Lorem=", "<Lorem>")

    # Remove Line Breaks
    # ==================

    parOne = ipsumText[0].replace(" ", "\n", 5)
    parTwo = ipsumText[1].replace(" ", "\n", 5)

    # Check Blocks
    cursor = nwGUI.docEditor.textCursor()
    cursor.clearSelection()
    text = "### A Scene\n\n%s\n\n%s" % (parOne, parTwo)
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    assert len(nwGUI.docEditor._selectedBlocks(cursor)) == 0

    cursor.select(QTextCursor.SelectionType.Document)
    assert len(nwGUI.docEditor._selectedBlocks(cursor)) == 15

    # Remove All
    text = "### A Scene\n\n%s\n\n%s" % (parOne, parTwo)
    nwGUI.docEditor.replaceText(text)
    nwGUI.docEditor.setCursorPosition(45)
    nwGUI.docEditor._removeInParLineBreaks()
    assert nwGUI.docEditor.getText() == "### A Scene\n\n%s\n" % "\n\n".join(ipsumText[0:2])

    # Remove in First Paragraph
    # Second paragraphs should remain unchanged
    text = "### A Scene\n\n%s\n\n%s" % (parOne, parTwo)
    nwGUI.docEditor.replaceText(text)
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(16, QTextCursor.MoveAnchor)
    cursor.setPosition(680, QTextCursor.KeepAnchor)
    nwGUI.docEditor.setTextCursor(cursor)
    nwGUI.docEditor._removeInParLineBreaks()

    newText = nwGUI.docEditor.getText()
    newPara = list(filter(str.strip, newText.split("\n")))
    twoBits = parTwo.split()
    assert newPara[1] == ipsumText[0]
    assert newPara[2] == twoBits[0]
    assert newPara[3] == twoBits[1]
    assert newPara[4] == twoBits[2]
    assert newPara[5] == twoBits[3]
    assert newPara[6] == twoBits[4]
    assert newPara[7] == " ".join(twoBits[5:])

    # Key Press Events
    # ================
    text = "### A Scene\n\n%s\n\n%s" % (parOne, parTwo)
    nwGUI.docEditor.replaceText(text)
    assert nwGUI.docEditor.getText() == text

    # Select All
    qtbot.keyClick(nwGUI.docEditor, Qt.Key_A, modifier=Qt.ControlModifier, delay=KEY_DELAY)
    qtbot.keyClick(nwGUI.docEditor, Qt.Key_Delete, delay=KEY_DELAY)
    assert nwGUI.docEditor.getText() == ""

    # Undo
    qtbot.keyClick(nwGUI.docEditor, Qt.Key_Z, modifier=Qt.ControlModifier, delay=KEY_DELAY)
    assert nwGUI.docEditor.getText() == text

    # Redo
    qtbot.keyClick(nwGUI.docEditor, Qt.Key_Y, modifier=Qt.ControlModifier, delay=KEY_DELAY)
    assert nwGUI.docEditor.getText() == ""

    # qtbot.stop()

# END Test testGuiEditor_TextManipulation


@pytest.mark.gui
def testGuiEditor_BlockFormatting(qtbot, monkeypatch, nwGUI, projPath, ipsumText, mockRnd):
    """Test the block formatting function."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    # Invalid and Generic
    # ===================

    text = "### A Scene\n\n%s" % ipsumText[0]
    nwGUI.docEditor.replaceText(text)

    # Invalid Block
    nwGUI.docEditor.setCursorPosition(0)
    with monkeypatch.context() as mp:
        mp.setattr(QTextBlock, "isValid", lambda *a, **k: False)
        assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is False

    # Keyword
    nwGUI.docEditor.replaceText("@pov: Jane\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is False
    assert nwGUI.docEditor.getText() == "@pov: Jane\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Unsupported Format
    nwGUI.docEditor.replaceText("% Comment\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.NO_ACTION) is False

    # Block Stripping : Left Side
    # ===========================

    # Strip Comment w/Space
    nwGUI.docEditor.replaceText("% Comment\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Comment\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 3

    # Strip Comment wo/Space
    nwGUI.docEditor.replaceText("%Comment\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Comment\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 4

    # Strip Header 1
    nwGUI.docEditor.replaceText("# Title\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 3

    # Strip Header 2
    nwGUI.docEditor.replaceText("## Title\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 2

    # Strip Header 3
    nwGUI.docEditor.replaceText("### Title\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 1

    # Strip Header 4
    nwGUI.docEditor.replaceText("#### Title\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 0

    # Strip Novel Title
    nwGUI.docEditor.replaceText("#! Title\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 2

    # Strip Unnumbered Chapter
    nwGUI.docEditor.replaceText("##! Title\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 1

    # Strip Hard Scene
    nwGUI.docEditor.replaceText("###! Title\n\n")
    nwGUI.docEditor.setCursorPosition(6)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 1

    # Strip Text
    nwGUI.docEditor.replaceText("Generic text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Generic text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Strip Left Angle Brackets : Double w/Space
    nwGUI.docEditor.replaceText(">> Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 2

    # Strip Left Angle Brackets : Single w/Space
    nwGUI.docEditor.replaceText("> Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 3

    # Strip Left Angle Brackets : Double wo/Space
    nwGUI.docEditor.replaceText(">>Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 3

    # Strip Left Angle Brackets : Single wo/Space
    nwGUI.docEditor.replaceText(">Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 4

    # Block Stripping : Right Side
    # ============================

    # Strip Right Angle Brackets : Double w/Space
    nwGUI.docEditor.replaceText("Some text <<\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Strip Right Angle Brackets : Single w/Space
    nwGUI.docEditor.replaceText("Some text <\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Strip Right Angle Brackets : Double wo/Space
    nwGUI.docEditor.replaceText("Some text<<\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Strip Right Angle Brackets : Single wo/Space
    nwGUI.docEditor.replaceText("Some text<\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Block Stripping : Both Sides
    # ============================

    nwGUI.docEditor.replaceText(">> Some text <<\n\n")
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"

    nwGUI.docEditor.replaceText(">Some text <<\n\n")
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"

    nwGUI.docEditor.replaceText(">Some text<\n\n")
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"

    # New Formats
    # ===========

    # Comment
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_COM) is True
    assert nwGUI.docEditor.getText() == "% Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 7

    # Toggle Comment w/Space
    nwGUI.docEditor.replaceText("% Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_COM) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 3

    # Toggle Comment wo/Space
    nwGUI.docEditor.replaceText("%Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_COM) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 4

    # Toggle Ignore Text w/Space
    nwGUI.docEditor.replaceText("%~ Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_IGN) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 2

    # Toggle Ignore Text wo/Space
    nwGUI.docEditor.replaceText("%~Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_IGN) is True
    assert nwGUI.docEditor.getText() == "Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 3

    # Header 1
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_H1) is True
    assert nwGUI.docEditor.getText() == "# Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 7

    # Header 2
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_H2) is True
    assert nwGUI.docEditor.getText() == "## Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 8

    # Header 3
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_H3) is True
    assert nwGUI.docEditor.getText() == "### Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 9

    # Header 4
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_H4) is True
    assert nwGUI.docEditor.getText() == "#### Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 10

    # Novel Title
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TTL) is True
    assert nwGUI.docEditor.getText() == "#! Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 8

    # Unnumbered Chapter
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_UNN) is True
    assert nwGUI.docEditor.getText() == "##! Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 9

    # Hard Scene
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_HSC) is True
    assert nwGUI.docEditor.getText() == "###! Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 10

    # Left Indent
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.INDENT_L) is True
    assert nwGUI.docEditor.getText() == "> Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 7

    # Right Indent
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.INDENT_R) is True
    assert nwGUI.docEditor.getText() == "Some text <\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Right/Left Indent
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.INDENT_L) is True
    assert nwGUI.docEditor._formatBlock(nwDocAction.INDENT_R) is True
    assert nwGUI.docEditor.getText() == "> Some text <\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 7

    # Left Align
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.ALIGN_L) is True
    assert nwGUI.docEditor.getText() == "Some text <<\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Right Align
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.ALIGN_R) is True
    assert nwGUI.docEditor.getText() == ">> Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 8

    # Centre Align
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.ALIGN_C) is True
    assert nwGUI.docEditor.getText() == ">> Some text <<\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 8

    # Left/Right Align (Overrides)
    nwGUI.docEditor.replaceText("Some text\n\n")
    nwGUI.docEditor.setCursorPosition(5)
    assert nwGUI.docEditor._formatBlock(nwDocAction.ALIGN_L) is True
    assert nwGUI.docEditor._formatBlock(nwDocAction.ALIGN_R) is True
    assert nwGUI.docEditor.getText() == ">> Some text\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 8

    # Other Checks
    # ============

    # Final Cursor Position Out of Range
    nwGUI.docEditor.replaceText("#### Title\n\n")
    nwGUI.docEditor.setCursorPosition(3)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_TXT) is True
    assert nwGUI.docEditor.getText() == "Title\n\n"
    assert nwGUI.docEditor.getCursorPosition() == 5

    # Third Line
    # This also needs to add a new block
    nwGUI.docEditor.replaceText("#### Title\n\nThe Text\n\n")
    nwGUI.docEditor.setCursorLine(3)
    assert nwGUI.docEditor._formatBlock(nwDocAction.BLOCK_COM) is True
    assert nwGUI.docEditor.getText() == "#### Title\n\n% The Text\n\n"

    # qtbot.stop()

# END Test testGuiEditor_BlockFormatting


@pytest.mark.gui
def testGuiEditor_MultiBlockFormatting(qtbot, nwGUI, projPath, ipsumText, mockRnd):
    """Test the block formatting function."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    text = "### A Scene\n\n@char: Jane, John\n\n" + "\n\n".join(ipsumText) + "\n\n"
    nwGUI.docEditor.replaceText(text)
    assert [x[:5] for x in nwGUI.docEditor.getText().splitlines()] == [
        "### A", "", "@char", "", "Lorem", "", "Nulla", "", "Nulla", "", "Pelle", "", "Integ", ""
    ]

    # Toggle Comment
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(50)
    cursor.movePosition(QtMoveRight, QtKeepAnchor, 2000)
    nwGUI.docEditor.setTextCursor(cursor)

    nwGUI.docEditor._iterFormatBlocks(nwDocAction.BLOCK_COM)
    assert [x[:5] for x in nwGUI.docEditor.getText().splitlines()] == [
        "### A", "", "@char", "", "% Lor", "", "% Nul", "", "% Nul", "", "% Pel", "", "Integ", ""
    ]

    # Un-toggle the second
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(800)
    nwGUI.docEditor.setTextCursor(cursor)

    nwGUI.docEditor._iterFormatBlocks(nwDocAction.BLOCK_COM)
    assert [x[:5] for x in nwGUI.docEditor.getText().splitlines()] == [
        "### A", "", "@char", "", "% Lor", "", "Nulla", "", "% Nul", "", "% Pel", "", "Integ", ""
    ]

    # Un-toggle all
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(50)
    cursor.movePosition(QtMoveRight, QtKeepAnchor, 3000)
    nwGUI.docEditor.setTextCursor(cursor)

    nwGUI.docEditor._iterFormatBlocks(nwDocAction.BLOCK_COM)
    assert [x[:5] for x in nwGUI.docEditor.getText().splitlines()] == [
        "### A", "", "@char", "", "Lorem", "", "Nulla", "", "Nulla", "", "Pelle", "", "Integ", ""
    ]

    # Toggle Ignore Text
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(50)
    cursor.movePosition(QtMoveRight, QtKeepAnchor, 2000)
    nwGUI.docEditor.setTextCursor(cursor)

    nwGUI.docEditor._iterFormatBlocks(nwDocAction.BLOCK_IGN)
    assert [x[:5] for x in nwGUI.docEditor.getText().splitlines()] == [
        "### A", "", "@char", "", "%~ Lo", "", "%~ Nu", "", "%~ Nu", "", "%~ Pe", "", "Integ", ""
    ]

    # Clear all paragraphs
    cursor = nwGUI.docEditor.textCursor()
    cursor.setPosition(50)
    cursor.movePosition(QtMoveRight, QtKeepAnchor, 3000)
    nwGUI.docEditor.setTextCursor(cursor)

    nwGUI.docEditor._iterFormatBlocks(nwDocAction.BLOCK_TXT)
    assert [x[:5] for x in nwGUI.docEditor.getText().splitlines()] == [
        "### A", "", "@char", "", "Lorem", "", "Nulla", "", "Nulla", "", "Pelle", "", "Integ", ""
    ]

    # Final text should be identical to initial text
    assert nwGUI.docEditor.getText() == text

    # qtbot.stop()

# END Test testGuiEditor_MultiBlockFormatting


@pytest.mark.gui
def testGuiEditor_Tags(qtbot, nwGUI, projPath, ipsumText, mockRnd):
    """Test the document editor tags functionality."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    # Create Scene
    text = "### A Scene\n\n@char: Jane, John\n\n@object: Gun\n\n@:\n\n" + ipsumText[0] + "\n\n"
    nwGUI.docEditor.replaceText(text)

    # Create Character
    text = "### Jane Doe\n\n@tag: Jane\n\n" + ipsumText[1] + "\n\n"
    cHandle = SHARED.project.newFile("Jane Doe", C.hCharRoot)
    assert nwGUI.openDocument(cHandle) is True
    nwGUI.docEditor.replaceText(text)
    nwGUI.saveDocument()
    assert nwGUI.projView.projTree.revealNewTreeItem(cHandle)
    nwGUI.docEditor.updateTagHighLighting()

    # Follow Tag
    # ==========
    assert nwGUI.openDocument(C.hSceneDoc) is True

    # Empty Block
    nwGUI.docEditor.setCursorLine(2)
    assert nwGUI.docEditor._processTag() is nwTrinary.NEUTRAL

    # Not On Tag
    nwGUI.docEditor.setCursorLine(1)
    assert nwGUI.docEditor._processTag() is nwTrinary.NEUTRAL

    # On Tag Keyword
    nwGUI.docEditor.setCursorPosition(15)
    assert nwGUI.docEditor._processTag() is nwTrinary.NEUTRAL

    # On Known Tag, No Follow
    nwGUI.docEditor.setCursorPosition(22)
    assert nwGUI.docEditor._processTag(follow=False) is nwTrinary.POSITIVE
    assert nwGUI.docViewer._docHandle is None

    # On Known Tag, Follow
    nwGUI.docEditor.setCursorPosition(22)
    assert nwGUI.docViewer._docHandle is None
    assert nwGUI.docEditor._processTag(follow=True) is nwTrinary.POSITIVE
    assert nwGUI.docViewer._docHandle == cHandle
    assert nwGUI.closeViewerPanel() is True
    assert nwGUI.docViewer._docHandle is None

    # On Unknown Tag, Create It
    assert "0000000000011" not in SHARED.project.tree
    nwGUI.docEditor.setCursorPosition(28)
    assert nwGUI.docEditor._processTag(create=True) is nwTrinary.NEGATIVE
    assert "0000000000011" in SHARED.project.tree

    # On Unknown Tag, Missing Root
    assert "0000000000012" not in SHARED.project.tree
    nwGUI.docEditor.setCursorPosition(42)
    assert nwGUI.docEditor._processTag(create=True) is nwTrinary.NEGATIVE
    oHandle = SHARED.project.tree.findRoot(nwItemClass.OBJECT)
    assert oHandle == "0000000000012"

    oItem = SHARED.project.tree["0000000000013"]
    assert oItem is not None
    assert oItem.itemParent == "0000000000012"

    nwGUI.docEditor.setCursorPosition(47)
    assert nwGUI.docEditor._processTag() is nwTrinary.NEUTRAL

    # qtbot.stop()

# END Test testGuiEditor_Tags


@pytest.mark.gui
def testGuiEditor_Completer(qtbot, nwGUI, projPath, mockRnd):
    """Test the document editor meta completer functionality."""
    buildTestProject(nwGUI, projPath)
    assert nwGUI.openDocument(C.hSceneDoc) is True

    # Create Character
    text = (
        "# Jane Doe\n\n"
        "@tag: Jane\n\n"
        "# John Doe\n\n"
        "@tag: John\n\n"
    )
    cHandle = SHARED.project.newFile("People", C.hCharRoot)
    assert nwGUI.openDocument(cHandle) is True
    nwGUI.docEditor.replaceText(text)
    nwGUI.saveDocument()
    assert nwGUI.projView.projTree.revealNewTreeItem(cHandle)

    docEditor = nwGUI.docEditor
    docEditor.replaceText("")
    completer = docEditor._completer

    # Create Scene
    nwGUI.switchFocus(nwWidget.EDITOR)
    for c in "### Scene One":
        qtbot.keyClick(docEditor, c, delay=KEY_DELAY)
    qtbot.keyClick(docEditor, Qt.Key_Return, delay=KEY_DELAY)
    qtbot.keyClick(docEditor, Qt.Key_Return, delay=KEY_DELAY)

    # Type Keyword @
    qtbot.keyClick(docEditor, "@", delay=KEY_DELAY)
    assert len(completer.actions()) == len(nwKeyWords.VALID_KEYS)

    # Type "c" to filer list to 2
    qtbot.keyClick(docEditor, "c", delay=KEY_DELAY)
    assert len(completer.actions()) == 2

    # Type "q" to filer list to 0
    qtbot.keyClick(docEditor, "q", delay=KEY_DELAY)
    assert len(completer.actions()) == 0

    # Delete character and go select @char
    qtbot.keyClick(docEditor, Qt.Key_Backspace, delay=KEY_DELAY)
    assert len(completer.actions()) == 2
    completer.actions()[0].trigger()
    assert docEditor.getText() == (
        "### Scene One\n\n"
        "@char:"
    )

    # The list of Characters should show up automatically
    qtbot.keyClick(docEditor, " ", delay=KEY_DELAY)
    assert [a.text() for a in completer.actions()] == ["Jane", "John"]

    # Typing "q" should clear the list
    qtbot.keyClick(docEditor, "q", delay=KEY_DELAY)
    assert [a.text() for a in completer.actions()] == []

    # Deleting it and typing "a", should leave "Jane"
    qtbot.keyClick(docEditor, Qt.Key_Backspace, delay=KEY_DELAY)
    qtbot.keyClick(docEditor, "a", delay=KEY_DELAY)
    assert [a.text() for a in completer.actions()] == ["Jane"]

    # Selecting "Jane" should insert it
    completer.actions()[0].trigger()
    qtbot.keyClick(docEditor, Qt.Key_Return, delay=KEY_DELAY)
    assert docEditor.getText() == (
        "### Scene One\n\n"
        "@char: Jane\n"
    )

    # Start a new line with a nonsense keyword, which should be handled
    for c in "@: ":
        qtbot.keyClick(docEditor, c, delay=KEY_DELAY)
    qtbot.keyClick(docEditor, Qt.Key_Backspace, delay=KEY_DELAY)
    qtbot.keyClick(docEditor, Qt.Key_Backspace, delay=KEY_DELAY)
    qtbot.keyClick(docEditor, Qt.Key_Backspace, delay=KEY_DELAY)

    # Send keypresses to the completer object
    qtbot.keyClick(docEditor, "@", delay=KEY_DELAY)
    assert len(completer.actions()) == len(nwKeyWords.VALID_KEYS)
    qtbot.keyClick(completer, "f", delay=KEY_DELAY)
    qtbot.keyClick(completer, Qt.Key_Down, delay=KEY_DELAY)
    qtbot.keyClick(completer, Qt.Key_Return, delay=KEY_DELAY)
    qtbot.keyClick(completer, " ", delay=KEY_DELAY)
    qtbot.keyClick(completer, "h", delay=KEY_DELAY)
    qtbot.keyClick(completer, Qt.Key_Down, delay=KEY_DELAY)
    qtbot.keyClick(completer, Qt.Key_Return, delay=KEY_DELAY)
    qtbot.keyClick(completer, Qt.Key_Escape, delay=KEY_DELAY)
    assert docEditor.getText() == (
        "### Scene One\n\n"
        "@char: Jane\n"
        "@focus: John"
    )

    # qtbot.stop()

# END Test testGuiEditor_Completer


@pytest.mark.gui
def testGuiEditor_CursorVisibility(qtbot, monkeypatch, nwGUI, projPath, mockRnd):
    """Test the custom ensure cursor visible feature."""
    buildTestProject(nwGUI, projPath)
    nwGUI.openDocument(C.hSceneDoc)
    docEditor = nwGUI.docEditor

    docEditor.setPlainText(
        "### Scene\n\n" + "".join(["Text\n\n"]*100)
    )
    assert docEditor.cursorIsVisible() is True
    docEditor.setCenterOnScroll(False)

    # Scroll Down
    cursor = docEditor.textCursor()
    cursor.setPosition(605)
    docEditor.setTextCursor(cursor)
    docEditor.verticalScrollBar().setValue(0)
    assert docEditor.verticalScrollBar().value() == 0
    docEditor.ensureCursorVisibleNoCentre()
    assert docEditor.verticalScrollBar().value() > 0
    assert docEditor.cursorIsVisible() is True

    # Scroll Up
    cursor = docEditor.textCursor()
    cursor.setPosition(0)
    docEditor.setTextCursor(cursor)
    docEditor.verticalScrollBar().setValue(200)
    assert docEditor.verticalScrollBar().value() > 100
    docEditor.ensureCursorVisibleNoCentre()
    assert docEditor.verticalScrollBar().value() == 0
    assert docEditor.cursorIsVisible() is True

    # qtbot.stop()

# END Test testGuiEditor_CursorVisibility


@pytest.mark.gui
def testGuiEditor_WordCounters(qtbot, monkeypatch, nwGUI, projPath, ipsumText, mockRnd):
    """Test the word counter."""
    class MockThreadPool:

        def __init__(self):
            self._objID = None

        def start(self, runObj, priority=0):
            self._objID = id(runObj)

        def objectID(self):
            return self._objID

    threadPool = MockThreadPool()
    monkeypatch.setattr(QThreadPool, "globalInstance", lambda *a: threadPool)
    nwGUI.docEditor.timerDoc.blockSignals(True)
    nwGUI.docEditor.timerSel.blockSignals(True)

    buildTestProject(nwGUI, projPath)

    # Run on an empty document
    nwGUI.docEditor._runDocumentTasks()
    assert nwGUI.docEditor.docFooter.wordsText.text() == "Words: 0 (+0)"
    nwGUI.docEditor._updateDocCounts(0, 0, 0)
    assert nwGUI.docEditor.docFooter.wordsText.text() == "Words: 0 (+0)"

    nwGUI.docEditor._runSelCounter()
    assert nwGUI.docEditor.docFooter.wordsText.text() == "Words: 0 (+0)"
    nwGUI.docEditor._updateSelCounts(0, 0, 0)
    assert nwGUI.docEditor.docFooter.wordsText.text() == "Words: 0 (+0)"

    # Open a document and populate it
    SHARED.project.tree[C.hSceneDoc]._initCount = 0  # type: ignore
    SHARED.project.tree[C.hSceneDoc]._wordCount = 0  # type: ignore
    assert nwGUI.openDocument(C.hSceneDoc) is True

    text = "\n\n".join(ipsumText)
    cC, wC, pC = standardCounter(text)
    nwGUI.docEditor.replaceText(text)

    # Check that a busy counter is blocked
    with monkeypatch.context() as mp:
        mp.setattr(nwGUI.docEditor.wCounterDoc, "isRunning", lambda *a: True)
        nwGUI.docEditor._runDocumentTasks()
        assert nwGUI.docEditor.docFooter.wordsText.text() == "Words: 0 (+0)"

    with monkeypatch.context() as mp:
        mp.setattr(nwGUI.docEditor.wCounterSel, "isRunning", lambda *a: True)
        nwGUI.docEditor._runSelCounter()
        assert nwGUI.docEditor.docFooter.wordsText.text() == "Words: 0 (+0)"

    # Run the full word counter
    nwGUI.docEditor._runDocumentTasks()
    assert threadPool.objectID() == id(nwGUI.docEditor.wCounterDoc)

    nwGUI.docEditor.wCounterDoc.run()
    # nwGUI.docEditor._updateDocCounts(cC, wC, pC)
    assert SHARED.project.tree[C.hSceneDoc]._charCount == cC  # type: ignore
    assert SHARED.project.tree[C.hSceneDoc]._wordCount == wC  # type: ignore
    assert SHARED.project.tree[C.hSceneDoc]._paraCount == pC  # type: ignore
    assert nwGUI.docEditor.docFooter.wordsText.text() == f"Words: {wC} (+{wC})"

    # Select all text and run the selection word counter
    nwGUI.docEditor.docAction(nwDocAction.SEL_ALL)
    nwGUI.docEditor._runSelCounter()
    assert threadPool.objectID() == id(nwGUI.docEditor.wCounterSel)

    nwGUI.docEditor.wCounterSel.run()
    assert nwGUI.docEditor.docFooter.wordsText.text() == f"Words: {wC} selected"

    # qtbot.stop()

# END Test testGuiEditor_WordCounters


@pytest.mark.gui
def testGuiEditor_Search(qtbot, monkeypatch, nwGUI, prjLipsum):
    """Test the document editor search functionality."""
    monkeypatch.setattr(GuiDocEditor, "hasFocus", lambda *a: True)

    assert nwGUI.openProject(prjLipsum) is True
    assert nwGUI.openDocument("4c4f28287af27") is True
    docEditor = nwGUI.docEditor
    docSearch = docEditor.docSearch
    origText = docEditor.getText()

    # Select the Word "est"
    docEditor.setCursorPosition(645)
    docEditor._makeSelection(QTextCursor.WordUnderCursor)
    cursor = docEditor.textCursor()
    assert cursor.selectedText() == "est"

    # Activate search
    nwGUI.mainMenu.aFind.activate(QAction.Trigger)
    assert docSearch.isVisible()
    assert docSearch.searchText == "est"

    # Find next by enter key
    monkeypatch.setattr(docSearch.searchBox, "hasFocus", lambda: True)
    qtbot.keyClick(docSearch.searchBox, Qt.Key_Return, delay=KEY_DELAY)
    assert abs(docEditor.getCursorPosition() - 1299) < 3

    # Find next by button
    qtbot.mouseClick(docSearch.searchButton, QtMouseLeft, delay=KEY_DELAY)
    assert abs(docEditor.getCursorPosition() - 1513) < 3

    # Activate loop search
    docSearch.toggleLoop.activate(QAction.Trigger)
    assert docSearch.toggleLoop.isChecked()
    assert CONFIG.searchLoop is True

    # Find next by menu Search > Find Next
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 647) < 3

    # Close search
    docSearch.cancelSearch.activate(QAction.Trigger)
    assert docSearch.isVisible() is False
    docEditor.setCursorPosition(15)

    # Toggle search again with header button
    qtbot.mouseClick(docEditor.docHeader.searchButton, QtMouseLeft, delay=KEY_DELAY)
    docSearch.setSearchText("")
    assert docSearch.isVisible() is True

    # Search for non-existing
    docEditor.setCursorPosition(0)
    docSearch.setSearchText("abcdef")
    qtbot.mouseClick(docSearch.searchButton, QtMouseLeft, delay=KEY_DELAY)
    assert docEditor.getCursorPosition() < 3  # No result

    # Enable RegEx search
    docSearch.toggleRegEx.activate(QAction.Trigger)
    assert docSearch.toggleRegEx.isChecked()
    assert CONFIG.searchRegEx is True

    # Set invalid RegEx
    docEditor.setCursorPosition(0)
    docSearch.setSearchText(r"\bSus[")
    qtbot.mouseClick(docSearch.searchButton, QtMouseLeft, delay=KEY_DELAY)
    assert docEditor.getCursorPosition() < 3  # No result

    # Set dangerous RegEx (issue #1015)
    # If this doesn't get caught, the app will hang
    docEditor.setCursorPosition(0)
    docSearch.setSearchText(r".*")
    qtbot.mouseClick(docSearch.searchButton, QtMouseLeft, delay=KEY_DELAY)
    assert abs(docEditor.getCursorPosition() - 14) < 3

    # Set valid RegEx
    docSearch.setSearchText(r"\bSus")
    qtbot.mouseClick(docSearch.searchButton, QtMouseLeft, delay=KEY_DELAY)
    assert abs(docEditor.getCursorPosition() - 223) < 3

    # Find next and then prev
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 324) < 3
    nwGUI.mainMenu.aFindPrev.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 223) < 3

    # Make RegEx case sensitive
    docSearch.toggleCase.activate(QAction.Trigger)
    assert docSearch.toggleCase.isChecked()
    assert CONFIG.searchCase is True

    # Find next/prev (one result)
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 626) < 3
    nwGUI.mainMenu.aFindPrev.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 626) < 3
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 626) < 3

    # Trigger replace
    nwGUI.mainMenu.aReplace.activate(QAction.Trigger)
    docSearch.setReplaceText("foo")

    # Disable RegEx case sensitive
    docSearch.toggleCase.activate(QAction.Trigger)
    assert docSearch.toggleCase.isChecked() is False
    assert CONFIG.searchCase is False

    # Toggle replace preserve case
    docSearch.toggleMatchCap.activate(QAction.Trigger)
    assert docSearch.toggleMatchCap.isChecked()
    assert CONFIG.searchMatchCap is True

    # Replace "Sus" with "Foo" via menu
    docEditor.setCursorPosition(605)
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    nwGUI.mainMenu.aReplaceNext.activate(QAction.Trigger)
    assert docEditor.getText()[623:634] == "Foopendisse"

    # Find next/prev to loop file
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 223) < 3
    nwGUI.mainMenu.aFindPrev.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 1805) < 3
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 223) < 3

    # Replace "sus" with "foo" via replace button
    qtbot.mouseClick(docSearch.replaceButton, QtMouseLeft, delay=KEY_DELAY)
    assert docEditor.getText()[220:228] == "foocipit"

    # Revert last two replaces
    assert docEditor.docAction(nwDocAction.UNDO)
    assert docEditor.docAction(nwDocAction.UNDO)
    assert docEditor.getText() == origText

    # Disable RegEx search
    docSearch.toggleRegEx.activate(QAction.Trigger)
    assert not docSearch.toggleRegEx.isChecked()
    assert CONFIG.searchRegEx is False

    # Close search and select "est" again
    docSearch.cancelSearch.activate(QAction.Trigger)
    docEditor.setCursorPosition(645)
    docEditor._makeSelection(QTextCursor.WordUnderCursor)
    cursor = docEditor.textCursor()
    assert cursor.selectedText() == "est"

    # Activate search again
    nwGUI.mainMenu.aFind.activate(QAction.Trigger)
    assert docSearch.isVisible()
    assert docSearch.searchText == "est"

    # Enable full word search
    docSearch.toggleWord.activate(QAction.Trigger)
    assert docSearch.toggleWord.isChecked()
    assert CONFIG.searchWord is True

    # Only one match
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 647) < 3
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 647) < 3

    # Enable next doc search
    docSearch.toggleProject.activate(QAction.Trigger)
    assert docSearch.toggleProject.isChecked()
    assert CONFIG.searchNextFile is True

    # Next match
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert docEditor.docHandle == "2426c6f0ca922"  # Next document
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 620) < 3
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert abs(docEditor.getCursorPosition() - 1127) < 3

    # Next doc, no match
    assert CONFIG.searchNextFile is True
    docSearch.setSearchText("abcdef")
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert docEditor.docHandle != "2426c6f0ca922"
    assert docEditor.docHandle == "04468803b92e1"
    nwGUI.mainMenu.aFindNext.activate(QAction.Trigger)
    assert docEditor.docHandle != "04468803b92e1"
    assert docEditor.docHandle == "7a992350f3eb6"

    # Toggle Replace
    docEditor.beginReplace()

    # MonkeyPatch the focus cycle. We can't really test this very well, other than
    # check that the tabs aren't captured when the main editor has focus
    with monkeypatch.context() as mp:
        mp.setattr(docEditor, "hasFocus", lambda: True)
        mp.setattr(docSearch.searchBox, "hasFocus", lambda: False)
        mp.setattr(docSearch.replaceBox, "hasFocus", lambda: False)
        assert docEditor.focusNextPrevChild(True) is False
        assert docSearch.cycleFocus() is False

    with monkeypatch.context() as mp:
        mp.setattr(docEditor, "hasFocus", lambda: False)
        mp.setattr(docSearch.searchBox, "hasFocus", lambda: True)
        mp.setattr(docSearch.replaceBox, "hasFocus", lambda: False)
        assert docEditor.focusNextPrevChild(True) is True
        assert docSearch.cycleFocus() is True

    with monkeypatch.context() as mp:
        mp.setattr(docEditor, "hasFocus", lambda: False)
        mp.setattr(docSearch.searchBox, "hasFocus", lambda: False)
        mp.setattr(docSearch.replaceBox, "hasFocus", lambda: True)
        assert docEditor.focusNextPrevChild(True) is True
        assert docSearch.cycleFocus() is True
        docSearch.closeSearch()
        assert docSearch.isVisible() is False
        assert docEditor.focusNextPrevChild(True) is True

    # Replace Text
    # ============
    docSearch.toggleCase.setChecked(True)
    docSearch.toggleWord.setChecked(False)
    docSearch.toggleRegEx.setChecked(False)
    docSearch.toggleLoop.setChecked(False)
    docSearch.toggleProject.setChecked(False)
    docEditor.setCursorPosition(0)

    # Replace Next
    docSearch.searchBox.setText("a")
    docSearch.replaceBox.setText("A")

    # No focus
    with monkeypatch.context() as mp:
        mp.setattr(docEditor, "anyFocus", lambda: False)
        docEditor.findNext()
        assert docEditor.textCursor().selectedText() == ""
        docEditor.replaceNext()
        assert docEditor.textCursor().selectedText() == ""

    # Search not open
    docSearch.closeSearch()
    assert docSearch.isVisible() is False
    docEditor.findNext()
    assert docSearch.isVisible() is True
    docSearch.closeSearch()
    assert docSearch.isVisible() is False
    docEditor.replaceNext()
    assert docSearch.isVisible() is True
    docEditor.toggleSearch()
    assert docSearch.isVisible() is False
    docEditor.toggleSearch()
    assert docSearch.isVisible() is True

    # Find first entry
    docEditor.replaceNext()
    assert docEditor.textCursor().selectedText() == "a"
    assert docEditor.getCursorPosition() == 64

    # Treat the search as a user selection
    docEditor._lastFind = None
    docEditor.replaceNext()
    assert docEditor.textCursor().selectedText() == "a"
    assert docEditor.getCursorPosition() == 92

    # Iterate through the rest
    finds = [104, 123, 175, 197, 206, 211, 220, 238, 250, 250]
    for i in range(10):
        docEditor.replaceNext()
        assert docEditor.textCursor().selectedText() == "a"
        assert docEditor.getCursorPosition() == finds[i]
    assert docEditor._lastFind == (249, 250)

    # Search for something that doesn't exist
    docSearch.searchBox.setText("x")
    docEditor._lastFind = None
    docEditor.replaceNext()
    assert docEditor.textCursor().selectedText() == ""

    # qtbot.stop()

# END Test testGuiEditor_Search


@pytest.mark.gui
def testGuiEditor_StaticMethods():
    """Test the document editor's static methods."""
    # Check the method that decides if it is allowed to insert a space
    # before a colon using the French, Spanish, etc language feature
    assert GuiDocEditor._allowSpaceBeforeColon("", "") is True
    assert GuiDocEditor._allowSpaceBeforeColon("", ":") is True
    assert GuiDocEditor._allowSpaceBeforeColon("some text", ":") is True

    assert GuiDocEditor._allowSpaceBeforeColon("@:", ":") is False
    assert GuiDocEditor._allowSpaceBeforeColon("@>", ">") is True

    assert GuiDocEditor._allowSpaceBeforeColon("%", ":") is True
    assert GuiDocEditor._allowSpaceBeforeColon("%:", ":") is True
    assert GuiDocEditor._allowSpaceBeforeColon("%synopsis:", ":") is False
    assert GuiDocEditor._allowSpaceBeforeColon("%Synopsis:", ":") is False
    assert GuiDocEditor._allowSpaceBeforeColon("% synopsis:", ":") is False
    assert GuiDocEditor._allowSpaceBeforeColon("% Synopsis:", ":") is False
    assert GuiDocEditor._allowSpaceBeforeColon("%  synopsis:", ":") is False
    assert GuiDocEditor._allowSpaceBeforeColon("%  Synopsis:", ":") is False
    assert GuiDocEditor._allowSpaceBeforeColon("%synopsis :", ":") is True
    assert GuiDocEditor._allowSpaceBeforeColon("%Synopsis :", ":") is True

# END Test testGuiEditor_StaticMethods