"""
novelWriter – ToDocX Class Tester
=================================

This file is a part of novelWriter
Copyright (C) 2024 Veronica Berglyd Olsen and novelWriter contributors

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/>.
"""  # noqa
from __future__ import annotations

import xml.etree.ElementTree as ET
import zipfile

import pytest

from novelwriter.common import xmlIndent
from novelwriter.constants import nwHeadFmt
from novelwriter.core.buildsettings import BuildSettings
from novelwriter.core.docbuild import NWBuildDocument
from novelwriter.core.project import NWProject
from novelwriter.enum import nwBuildFmt, nwComment
from novelwriter.formats.shared import BlockFmt, BlockTyp
from novelwriter.formats.todocx import OOXML_SCM, ToDocX, _mkTag, _wTag

from tests.tools import DOCX_IGNORE, cmpFiles, xmlToText


@pytest.mark.core
def testFmtToDocX_NovelHeadingStyles(mockGUI):
    """Test formatting of novel headings."""
    project = NWProject()
    doc = ToDocX(project)
    doc._isNovel = True
    doc.initDocument()

    # Title
    # =====

    xTest = ET.Element(_wTag("body"))
    doc._text = "#! Hello World"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Title" /><w:jc w:val="center" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Partition
    # =========
    doc._text = "# Hello World"

    # Plain
    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Title" /><w:jc w:val="center" /></w:pPr>'
        '<w:r><w:br w:type="page" /></w:r>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Formatted
    xTest = ET.Element(_wTag("body"))
    doc.setPartitionFormat(f"Part{nwHeadFmt.BR}{nwHeadFmt.TITLE}")
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Title" /><w:jc w:val="center" /></w:pPr>'
        '<w:r><w:br w:type="page" /></w:r>'
        '<w:r><w:rPr /><w:t>Part</w:t><w:br /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Chapter
    # =======
    doc._text = "## Hello World"

    # Plain
    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading1" /></w:pPr>'
        '<w:r><w:br w:type="page" /></w:r>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Formatted
    xTest = ET.Element(_wTag("body"))
    doc.setChapterFormat(f"Chapter {nwHeadFmt.CH_NUM}{nwHeadFmt.BR}{nwHeadFmt.TITLE}")
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading1" /></w:pPr>'
        '<w:r><w:br w:type="page" /></w:r>'
        '<w:r><w:rPr /><w:t>Chapter 2</w:t><w:br /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Scene
    # =====
    doc._text = "### Hello World"

    # Plain
    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading2" /></w:pPr><w:r><w:rPr />'
        '<w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Formatted
    xTest = ET.Element(_wTag("body"))
    doc.setSceneFormat(f"Scene {nwHeadFmt.SC_ABS}{nwHeadFmt.BR}{nwHeadFmt.TITLE}")
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading2" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Scene 2</w:t><w:br /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Section
    # =======
    doc._text = "#### Hello World"

    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading3" /></w:pPr><w:r><w:rPr />'
        '<w:t>Hello World</w:t></w:r></w:p></w:body>'
    )


@pytest.mark.core
def testFmtToDocX_NotesHeadingStyles(mockGUI):
    """Test formatting of notes headings."""
    project = NWProject()
    doc = ToDocX(project)
    doc._isNovel = False
    doc.initDocument()

    # Title
    # =====

    xTest = ET.Element(_wTag("body"))
    doc._text = "#! Hello World"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Title" /><w:jc w:val="center" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Heading 1
    # =========
    doc._text = "# Hello World"
    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading1" /></w:pPr><w:r><w:rPr />'
        '<w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Heading 2
    # =========
    doc._text = "## Hello World"
    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading2" /></w:pPr><w:r><w:rPr />'
        '<w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Heading 3
    # =========
    doc._text = "### Hello World"
    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading3" /></w:pPr><w:r><w:rPr />'
        '<w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Heading 4
    # =========
    doc._text = "#### Hello World"
    xTest = ET.Element(_wTag("body"))
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Heading4" /></w:pPr><w:r><w:rPr />'
        '<w:t>Hello World</w:t></w:r></w:p></w:body>'
    )


@pytest.mark.core
def testFmtToDocX_ParagraphStyles(mockGUI):
    """Test formatting of paragraphs."""
    project = NWProject()
    doc = ToDocX(project)
    doc.setCommentType(nwComment.PLAIN, True)
    doc.setCommentType(nwComment.SYNOPSIS, True)
    doc.setCommentType(nwComment.SHORT, True)
    doc.setKeywords(True)
    doc.initDocument()

    # Normal Text
    xTest = ET.Element(_wTag("body"))
    doc._text = "Hello World"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr><w:r><w:rPr />'
        '<w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Separator
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.SEP, "", "* * *", [], BlockFmt.NONE)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Separator" /></w:pPr><w:r><w:rPr />'
        '<w:t>* * *</w:t></w:r></w:p></w:body>'
    )

    # Empty Paragraph
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.SKIP, "", "* * *", [], BlockFmt.NONE)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr></w:p></w:body>'
    )

    # Synopsis
    xTest = ET.Element(_wTag("body"))
    doc._text = "%Synopsis: Hello World\n\n"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="MetaText" /></w:pPr>'
        '<w:r><w:rPr><w:b /><w:color w:val="813709" /></w:rPr><w:t>Synopsis:</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> </w:t></w:r>'
        '<w:r><w:rPr><w:color w:val="813709" /></w:rPr><w:t>Hello World</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Short
    xTest = ET.Element(_wTag("body"))
    doc._text = "%Short: Hello World\n\n"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="MetaText" /></w:pPr>'
        '<w:r><w:rPr><w:b /><w:color w:val="813709" /></w:rPr><w:t>Short Description:</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> </w:t></w:r>'
        '<w:r><w:rPr><w:color w:val="813709" /></w:rPr><w:t>Hello World</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Comment
    xTest = ET.Element(_wTag("body"))
    doc._text = "% Hello World\n\n"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="MetaText" /></w:pPr>'
        '<w:r><w:rPr><w:b /><w:color w:val="646464" /></w:rPr><w:t>Comment:</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> </w:t></w:r>'
        '<w:r><w:rPr><w:color w:val="646464" /></w:rPr><w:t>Hello World</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Tags and References (Single)
    xTest = ET.Element(_wTag("body"))
    doc._text = "@tag: Stuff"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="MetaText" /></w:pPr>'
        '<w:r><w:rPr><w:b /><w:color w:val="f5871f" /></w:rPr><w:t>Tag:</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> </w:t></w:r>'
        '<w:r><w:rPr><w:color w:val="4271ae" /></w:rPr><w:t>Stuff</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Tags and References (Multiple)
    xTest = ET.Element(_wTag("body"))
    doc._text = "@char: Jane, John"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="MetaText" /></w:pPr>'
        '<w:r><w:rPr><w:b /><w:color w:val="f5871f" /></w:rPr><w:t>Characters:</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> </w:t></w:r>'
        '<w:r><w:rPr><w:color w:val="4271ae" /></w:rPr><w:t>Jane</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve">, </w:t></w:r>'
        '<w:r><w:rPr><w:color w:val="4271ae" /></w:rPr><w:t>John</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Tags and References (Invalid)
    xTest = ET.Element(_wTag("body"))
    doc._text = "@stuff: Stuff"
    doc._pars = []
    doc.tokenizeText()
    doc.doConvert()
    assert doc._pars == []


@pytest.mark.core
def testFmtToDocX_Links(mockGUI):
    """Test formatting of links."""
    project = NWProject()
    doc = ToDocX(project)
    doc.initDocument()

    # Register 2 links
    rd1 = doc._appendExternalRel("http://example.com")
    rd2 = doc._appendExternalRel("https://example.com")
    assert rd1 == "rId1"
    assert rd2 == "rId2"

    # Link 1
    xTest = ET.Element(_wTag("body"))
    doc._text = "Foo http://example.com bar"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t xml:space="preserve">Foo </w:t></w:r>'
        '<w:hyperlink r:id="rId1"><w:r><w:rPr><w:rStyle w:val="InternetLink" /></w:rPr>'
        '<w:t>http://example.com</w:t></w:r></w:hyperlink>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> bar</w:t></w:r></w:p></w:body>'
    )

    # Link 2
    xTest = ET.Element(_wTag("body"))
    doc._text = "Foo https://example.com bar"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t xml:space="preserve">Foo </w:t></w:r>'
        '<w:hyperlink r:id="rId2"><w:r><w:rPr><w:rStyle w:val="InternetLink" /></w:rPr>'
        '<w:t>https://example.com</w:t></w:r></w:hyperlink>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> bar</w:t></w:r></w:p></w:body>'
    )


@pytest.mark.core
def testFmtToDocX_ParagraphFormatting(mockGUI):
    """Test formatting of paragraphs."""
    project = NWProject()
    doc = ToDocX(project)
    doc.setCommentType(nwComment.PLAIN, True)
    doc.setCommentType(nwComment.SYNOPSIS, True)
    doc.setKeywords(True)
    doc.initDocument()

    # Left Align
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.LEFT)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /><w:jc w:val="left" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Right Align
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.RIGHT)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /><w:jc w:val="right" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Center Align
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.CENTRE)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /><w:jc w:val="center" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Justify
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.JUSTIFY)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /><w:jc w:val="both" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Page Break Before
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.PBB)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:br w:type="page" /></w:r>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Page Break After
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.PBA)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r>'
        '<w:r><w:br w:type="page" /></w:r>'
        '</w:p></w:body>'
    )

    # Zero Margins
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.Z_TOP | BlockFmt.Z_BTM)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" />'
        '<w:spacing w:before="0" w:after="0" w:line="252" w:lineRule="auto" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # Indent
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.IND_L | BlockFmt.IND_R)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" />'
        '<w:ind w:left="880" w:right="880" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )

    # First Line Indent
    xTest = ET.Element(_wTag("body"))
    doc._blocks = [(BlockTyp.TEXT, "", "Hello World", [], BlockFmt.IND_T)]
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" />'
        '<w:ind w:firstLine="308" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Hello World</w:t></w:r></w:p></w:body>'
    )


@pytest.mark.core
def testFmtToDocX_TextFormatting(mockGUI):
    """Test formatting of text."""
    project = NWProject()
    doc = ToDocX(project)
    doc.initDocument()

    # Markdown
    xTest = ET.Element(_wTag("body"))
    doc._text = "Text **bold**, _italic_, ~~strike~~."
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t xml:space="preserve">Text </w:t></w:r>'
        '<w:r><w:rPr><w:b /></w:rPr><w:t>bold</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve">, </w:t></w:r>'
        '<w:r><w:rPr><w:i /></w:rPr><w:t>italic</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve">, </w:t></w:r>'
        '<w:r><w:rPr><w:strike /></w:rPr><w:t>strike</w:t></w:r>'
        '<w:r><w:rPr /><w:t>.</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Nested Shortcode Text, Emphasis
    xTest = ET.Element(_wTag("body"))
    doc._text = "Some [s]nested [b]bold[/b] [u]and[/u] [i]italics[/i] text[/s] text."
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t xml:space="preserve">Some </w:t></w:r>'
        '<w:r><w:rPr><w:strike /></w:rPr><w:t xml:space="preserve">nested </w:t></w:r>'
        '<w:r><w:rPr><w:b /><w:strike /></w:rPr><w:t>bold</w:t></w:r>'
        '<w:r><w:rPr><w:strike /></w:rPr><w:t xml:space="preserve"> </w:t></w:r>'
        '<w:r><w:rPr><w:u w:val="single" /><w:strike /></w:rPr><w:t>and</w:t></w:r>'
        '<w:r><w:rPr><w:strike /></w:rPr><w:t xml:space="preserve"> </w:t></w:r>'
        '<w:r><w:rPr><w:i /><w:strike /></w:rPr><w:t>italics</w:t></w:r>'
        '<w:r><w:rPr><w:strike /></w:rPr><w:t xml:space="preserve"> text</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> text.</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Shortcode Text, Super/Subscript
    xTest = ET.Element(_wTag("body"))
    doc._text = "Some super[sup]script[/sup] and sub[sub]script[/sub] text."
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Some super</w:t></w:r>'
        '<w:r><w:rPr><w:vertAlign w:val="superscript" /></w:rPr><w:t>script</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> and sub</w:t></w:r>'
        '<w:r><w:rPr><w:vertAlign w:val="subscript" /></w:rPr><w:t>script</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> text.</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Shortcode Text, Underline/Highlight
    xTest = ET.Element(_wTag("body"))
    doc._text = "Some [u]underlined and [m]highlighted[/m][/u] text."
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t xml:space="preserve">Some </w:t></w:r>'
        '<w:r><w:rPr><w:u w:val="single" /></w:rPr>'
        '<w:t xml:space="preserve">underlined and </w:t></w:r>'
        '<w:r><w:rPr><w:u w:val="single" /><w:shd w:fill="ffffa6" w:val="clear" /></w:rPr>'
        '<w:t>highlighted</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> text.</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Hard Break
    xTest = ET.Element(_wTag("body"))
    doc._text = "Some text.\nNext line\n"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Some text.</w:t><w:br /><w:t>Next line</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Tab
    xTest = ET.Element(_wTag("body"))
    doc._text = "\tItem 1\tItem 2\n"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:tab /><w:t>Item 1</w:t><w:tab /><w:t>Item 2</w:t></w:r>'
        '</w:p></w:body>'
    )

    # Tab in Format
    xTest = ET.Element(_wTag("body"))
    doc._text = "Some **bold\ttext**"
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t xml:space="preserve">Some </w:t></w:r>'
        '<w:r><w:rPr><w:b /></w:rPr><w:t>bold</w:t><w:tab /><w:t>text</w:t></w:r>'
        '</w:p></w:body>'
    )


@pytest.mark.core
def testFmtToDocX_Footnotes(mockGUI):
    """Test formatting of footnotes."""
    project = NWProject()
    doc = ToDocX(project)
    doc.initDocument()

    # Text
    xTest = ET.Element(_wTag("body"))
    doc._text = (
        "Text with one[footnote:fa], **two**[footnote:fd], "
        "or three[footnote:fb] footnotes.[footnote:fe]\n\n"
        "%footnote.fa: Footnote text A.[footnote:fc]\n\n"
        "%footnote.fc: This footnote is skipped.\n\n"
        "%footnote.fd: Another footnote.\n\n"
        "%footnote.fe: Again?\n\n"
    )
    doc.tokenizeText()
    doc.doConvert()
    doc._pars[-1].toXml(xTest)
    assert xmlToText(xTest) == (
        '<w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t>Text with one</w:t></w:r>'
        '<w:r><w:rPr><w:vertAlign w:val="superscript" /></w:rPr>'
        '<w:footnoteReference w:id="1" /></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve">, </w:t></w:r>'
        '<w:r><w:rPr><w:b /></w:rPr><w:t>two</w:t></w:r>'
        '<w:r><w:rPr><w:vertAlign w:val="superscript" /></w:rPr>'
        '<w:footnoteReference w:id="2" /></w:r>'
        '<w:r><w:rPr /><w:t>, or three</w:t></w:r>'
        '<w:r><w:rPr /><w:t xml:space="preserve"> footnotes.</w:t></w:r>'
        '<w:r><w:rPr><w:vertAlign w:val="superscript" /></w:rPr>'
        '<w:footnoteReference w:id="3" /></w:r>'
        '</w:p></w:body>'
    )

    # Footnotes
    doc._footnotesXml()
    assert xmlToText(doc._files["footnotes.xml"].xml) == (
        '<w:footnotes>'
        '<w:footnote w:id="1"><w:p><w:pPr><w:pStyle w:val="FootnoteText" /></w:pPr>'
        '<w:r><w:rPr><w:vertAlign w:val="superscript" /></w:rPr><w:footnoteRef /></w:r>'
        '<w:r><w:rPr /><w:t>Footnote text A.</w:t></w:r></w:p></w:footnote>'
        '<w:footnote w:id="2"><w:p><w:pPr><w:pStyle w:val="FootnoteText" /></w:pPr>'
        '<w:r><w:rPr><w:vertAlign w:val="superscript" /></w:rPr><w:footnoteRef /></w:r>'
        '<w:r><w:rPr /><w:t>Another footnote.</w:t></w:r></w:p></w:footnote>'
        '<w:footnote w:id="3"><w:p><w:pPr><w:pStyle w:val="FootnoteText" /></w:pPr>'
        '<w:r><w:rPr><w:vertAlign w:val="superscript" /></w:rPr><w:footnoteRef /></w:r>'
        '<w:r><w:rPr /><w:t>Again?</w:t></w:r></w:p></w:footnote>'
        '</w:footnotes>'
    )


@pytest.mark.core
def testFmtToDocX_Fields(mockGUI):
    """Test formatting of footnotes."""
    project = NWProject()
    doc = ToDocX(project)
    doc.initDocument()

    # Field Builder
    xNode = doc._generateField("a:b", 0x00)
    assert isinstance(xNode, ET.Element)
    assert xmlToText(xNode) == "<w:r><w:rPr /><w:t>0</w:t></w:r>"
    assert doc._usedFields == [(xNode.find(_wTag("t")), "b")]

    assert doc._generateField("a", 0x00) is None

    # Full Processing
    doc._text = (
        "Word Count: [field:allWords]\n"
        "Character Count: [field:allChars]\n"
        "Chicken Count: [field:allChickens]\n"
    )
    doc.tokenizeText()
    doc.doConvert()
    doc.countStats()
    doc._documentXml(None, None)
    assert xmlToText(doc._files["document.xml"].xml) == (
        '<w:document><w:body><w:p><w:pPr><w:pStyle w:val="Normal" /></w:pPr>'
        '<w:r><w:rPr /><w:t xml:space="preserve">Word Count: </w:t></w:r>'
        '<w:r><w:rPr /><w:t>6</w:t></w:r>'
        '<w:r><w:rPr /><w:br /><w:t xml:space="preserve">Character Count: </w:t></w:r>'
        '<w:r><w:rPr /><w:t>46</w:t></w:r>'
        '<w:r><w:rPr /><w:br /><w:t xml:space="preserve">Chicken Count: </w:t></w:r>'
        '<w:r><w:rPr /><w:t>0</w:t></w:r>'
        '</w:p><w:sectPr>'
        '<w:footnotePr><w:numFmt w:val="decimal" /></w:footnotePr>'
        '<w:pgSz w:w="11905" w:h="16837" w:orient="portrait" />'
        '<w:pgMar w:top="1133" w:right="1133" w:bottom="1133" w:left="1133" '
        'w:header="748" w:footer="0" w:gutter="0" />'
        '<w:pgNumType w:start="1" w:fmt="decimal" /><w:titlePg />'
        '</w:sectPr></w:body></w:document>'
    )


@pytest.mark.core
def testFmtToDocX_SaveDocument(mockGUI, prjLipsum, fncPath, tstPaths):
    """Test document output."""
    project = NWProject()
    project.openProject(prjLipsum)

    pageHeader = f"Page {nwHeadFmt.DOC_PAGE} - {nwHeadFmt.DOC_PROJECT} ({nwHeadFmt.DOC_AUTHOR})"

    build = BuildSettings()
    build.setValue("filter.includeNovel", True)
    build.setValue("filter.includeNotes", True)
    build.setValue("filter.includeInactive", False)
    build.setValue("text.includeSynopsis", True)
    build.setValue("text.includeComments", True)
    build.setValue("text.includeKeywords", True)
    build.setValue("format.textFont", "Source Sans Pro,12")
    build.setValue("format.firstLineIndent", True)
    build.setValue("doc.pageHeader", pageHeader)

    docBuild = NWBuildDocument(project, build)
    docBuild.queueAll()

    docPath = fncPath / "document.docx"
    assert list(docBuild.iterBuildDocument(docPath, nwBuildFmt.DOCX)) == [
        (0, True), (1, True), (2, True), (3, True), (4, True), (5, False),
        (6, True), (7, True), (8, True), (9, False), (10, False), (11, True),
        (12, True), (13, True), (14, True), (15, True), (16, True), (17, True),
        (18, True), (19, True), (20, True), (21, False),
    ]

    assert docPath.exists()
    assert zipfile.is_zipfile(docPath)

    with zipfile.ZipFile(docPath, mode="r") as zipObj:
        zipObj.extractall(fncPath / "extract")

    def prettifyXml(inFile, outFile):
        with open(outFile, mode="wb") as fStream:
            xml = ET.parse(inFile)
            xmlIndent(xml)  # type: ignore
            xml.write(fStream, encoding="utf-8", xml_declaration=True)

    expected = [
        fncPath / "extract" / "[Content_Types].xml",
        fncPath / "extract" / "_rels" / ".rels",
        fncPath / "extract" / "docProps" / "app.xml",
        fncPath / "extract" / "docProps" / "core.xml",
        fncPath / "extract" / "word" / "_rels" / "document.xml.rels",
        fncPath / "extract" / "word" / "document.xml",
        fncPath / "extract" / "word" / "footnotes.xml",
        fncPath / "extract" / "word" / "header1.xml",
        fncPath / "extract" / "word" / "header2.xml",
        fncPath / "extract" / "word" / "settings.xml",
        fncPath / "extract" / "word" / "styles.xml",
        fncPath / "extract" / "word" / "fontTable.xml",
    ]

    outDir = tstPaths.outDir / "fmtToDocX_SaveDocument"
    outDir.mkdir()
    for file in expected:
        assert file.is_file()
        name = file.name.replace("[", "").replace("]", "").lstrip(".")
        outFile = outDir / name
        refFile = tstPaths.refDir / f"fmtToDocX_SaveDocument_{name}"
        prettifyXml(file, outFile)
        assert cmpFiles(outFile, refFile, ignoreStart=DOCX_IGNORE)


@pytest.mark.core
def testFmtToDocX_MkTag():
    """Test the tag maker function."""
    assert _mkTag("r", "id") == f"{{{OOXML_SCM}/officeDocument/2006/relationships}}id"
    assert _mkTag("w", "t") == f"{{{OOXML_SCM}/wordprocessingml/2006/main}}t"
    assert _mkTag("q", "t") == "t"