novelWriter 2.4.2__py3-none-any.whl → 2.5b1__py3-none-any.whl

novelwriter/tools/manuscript.py

@@ -23,37 +23,34 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-import json
 import logging
 
-from datetime import datetime
 from time import time
 from typing import TYPE_CHECKING
 
 from PyQt5.QtCore import Qt, QTimer, QUrl, pyqtSignal, pyqtSlot
-from PyQt5.QtGui import QCloseEvent, QColor, QCursor, QFont, QPalette, QResizeEvent
+from PyQt5.QtGui import QCloseEvent, QColor, QCursor, QFont, QPalette, QResizeEvent, QTextDocument
 from PyQt5.QtPrintSupport import QPrinter, QPrintPreviewDialog
 from PyQt5.QtWidgets import (
-    QAbstractItemView, QApplication, QDialog, QFormLayout, QGridLayout,
-    QHBoxLayout, QLabel, QListWidget, QListWidgetItem, QPushButton,
-    QSizePolicy, QSplitter, QStackedWidget, QTabWidget, QTextBrowser,
-    QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
+    QAbstractItemView, QApplication, QFormLayout, QGridLayout, QHBoxLayout,
+    QLabel, QListWidget, QListWidgetItem, QPushButton, QSplitter,
+    QStackedWidget, QTabWidget, QTextBrowser, QTreeWidget, QTreeWidgetItem,
+    QVBoxLayout, QWidget
 )
 
 from novelwriter import CONFIG, SHARED
-from novelwriter.common import checkInt, fuzzyTime
+from novelwriter.common import fuzzyTime
 from novelwriter.core.buildsettings import BuildCollection, BuildSettings
 from novelwriter.core.docbuild import NWBuildDocument
-from novelwriter.core.tohtml import ToHtml
 from novelwriter.core.tokenizer import HeadingFormatter
-from novelwriter.error import logException
+from novelwriter.core.toqdoc import TextDocumentTheme, ToQTextDocument
 from novelwriter.extensions.circularprogress import NProgressCircle
-from novelwriter.extensions.modified import NIconToggleButton, NIconToolButton
+from novelwriter.extensions.modified import NIconToggleButton, NIconToolButton, NToolDialog
 from novelwriter.gui.theme import STYLES_FLAT_TABS, STYLES_MIN_TOOLBUTTON
 from novelwriter.tools.manusbuild import GuiManuscriptBuild
 from novelwriter.tools.manussettings import GuiBuildSettings
 from novelwriter.types import (
-    QtAlignAbsolute, QtAlignCenter, QtAlignJustify, QtAlignRight, QtAlignTop,
+    QtAlignCenter, QtAlignRight, QtAlignTop, QtSizeExpanding, QtSizeIgnored,
     QtUserRole
 )
 
@@ -63,7 +60,7 @@ if TYPE_CHECKING:  # pragma: no cover
 logger = logging.getLogger(__name__)
 
 
-class GuiManuscript(QDialog):
+class GuiManuscript(NToolDialog):
     """GUI Tools: Manuscript Tool
 
     The dialog displays all the users build definitions, a preview panel
@@ -73,15 +70,11 @@ class GuiManuscript(QDialog):
 
     D_KEY = QtUserRole
 
-    def __init__(self, mainGui: GuiMain) -> None:
-        super().__init__(parent=mainGui)
+    def __init__(self, parent: GuiMain) -> None:
+        super().__init__(parent=parent)
 
         logger.debug("Create: GuiManuscript")
         self.setObjectName("GuiManuscript")
-        if CONFIG.osDarwin:
-            self.setWindowFlag(Qt.WindowType.Tool)
-
-        self.mainGui = mainGui
 
         self._builds = BuildCollection(SHARED.project)
         self._buildMap: dict[str, QListWidgetItem] = {}
@@ -253,20 +246,7 @@ class GuiManuscript(QDialog):
         self._updateBuildsList()
         if selected in self._buildMap:
             self.buildList.setCurrentItem(self._buildMap[selected])
-
-        logger.debug("Loading build cache")
-        cache = CONFIG.dataPath("cache") / f"build_{SHARED.project.data.uuid}.json"
-        if cache.is_file():
-            try:
-                with open(cache, mode="r", encoding="utf-8") as fObj:
-                    data = json.load(fObj)
-                build = self._builds.getBuild(data.get("uuid", ""))
-                if isinstance(build, BuildSettings):
-                    self._updatePreview(data, build)
-            except Exception:
-                logger.error("Failed to load build cache")
-                logException()
-                return
+            QTimer.singleShot(200, self._generatePreview)
 
         return
 
@@ -280,7 +260,7 @@ class GuiManuscript(QDialog):
         dialog open.
         """
         self._saveSettings()
-        for obj in self.mainGui.children():
+        for obj in SHARED.mainGui.children():
             # Make sure we don't have any settings windows open
             if isinstance(obj, GuiBuildSettings) and obj.isVisible():
                 obj.close()
@@ -343,39 +323,40 @@ class GuiManuscript(QDialog):
             return
 
         # Make sure editor content is saved before we start
-        SHARED.mainGui.saveDocument()
+        SHARED.saveDocument()
 
         docBuild = NWBuildDocument(SHARED.project, build)
-        docBuild.setPreviewMode(True)
         docBuild.queueAll()
 
+        theme = TextDocumentTheme()
+        theme.text      = QColor(0, 0, 0)
+        theme.highlight = QColor(255, 255, 166)
+        theme.head      = QColor(66, 113, 174)
+        theme.comment   = QColor(100, 100, 100)
+        theme.note      = QColor(129, 55, 9)
+        theme.code      = QColor(66, 113, 174)
+        theme.modifier  = QColor(129, 55, 9)
+        theme.keyword   = QColor(245, 135, 31)
+        theme.tag       = QColor(66, 113, 174)
+        theme.optional  = QColor(66, 113, 174)
+
         self.docPreview.beginNewBuild(len(docBuild))
-        for step, _ in docBuild.iterBuildHTML(None):
+        for step, _ in docBuild.iterBuildPreview(theme):
             self.docPreview.buildStep(step + 1)
             QApplication.processEvents()
 
         buildObj = docBuild.lastBuild
-        assert isinstance(buildObj, ToHtml)
-        result = {
-            "uuid": build.buildID,
-            "time": int(time()),
-            "stats": buildObj.textStats,
-            "outline": buildObj.textOutline,
-            "styles": buildObj.getStyleSheet(),
-            "html": buildObj.fullHTML,
-        }
-
-        self._updatePreview(result, build)
-
-        logger.debug("Saving build cache")
-        cache = CONFIG.dataPath("cache") / f"build_{SHARED.project.data.uuid}.json"
-        try:
-            with open(cache, mode="w+", encoding="utf-8") as outFile:
-                outFile.write(json.dumps(result, indent=2))
-        except Exception:
-            logger.error("Failed to save build cache")
-            logException()
-            return
+        assert isinstance(buildObj, ToQTextDocument)
+
+        font = QFont()
+        font.fromString(build.getStr("format.textFont"))
+
+        self.docPreview.setTextFont(font)
+        self.docPreview.setContent(buildObj.document)
+        self.docPreview.setBuildName(build.name)
+
+        self.docStats.updateStats(buildObj.textStats)
+        self.buildOutline.updateOutline(buildObj.textOutline)
 
         return
 
@@ -383,8 +364,8 @@ class GuiManuscript(QDialog):
     def _buildManuscript(self) -> None:
         """Open the build dialog and build the manuscript."""
         if build := self._getSelectedBuild():
-            dlgBuild = GuiManuscriptBuild(self, build)
-            dlgBuild.exec()
+            dialog = GuiManuscriptBuild(self, build)
+            dialog.exec()
 
             # After the build is done, save build settings changes
             if build.changed:
@@ -404,21 +385,6 @@ class GuiManuscript(QDialog):
     #  Internal Functions
     ##
 
-    def _updatePreview(self, data: dict, build: BuildSettings) -> None:
-        """Update the preview widget and set relevant values."""
-        self.docPreview.setContent(data)
-        self.docPreview.setBuildName(build.name)
-        self.docPreview.setTextFont(
-            build.getStr("format.textFont"),
-            build.getInt("format.textSize")
-        )
-        self.docPreview.setJustify(
-            build.getBool("format.justifyText")
-        )
-        self.docStats.updateStats(data.get("stats", {}))
-        self.buildOutline.updateOutline(data.get("outline", {}))
-        return
-
     def _getSelectedBuild(self) -> BuildSettings | None:
         """Get the currently selected build. If none are selected,
         automatically select the first one.
@@ -473,17 +439,13 @@ class GuiManuscript(QDialog):
     def _openSettingsDialog(self, build: BuildSettings) -> None:
         """Open the build settings dialog."""
         if dialog := self._findSettingsDialog(build.buildID):
-            dialog.show()
-            dialog.raise_()
+            dialog.activateDialog()
             return
 
-        dlgSettings = GuiBuildSettings(self.mainGui, build)
-        dlgSettings.setModal(False)
-        dlgSettings.show()
-        dlgSettings.raise_()
-        QApplication.processEvents()
-        dlgSettings.loadContent()
-        dlgSettings.newSettingsReady.connect(self._processNewSettings)
+        dialog = GuiBuildSettings(SHARED.mainGui, build)
+        dialog.activateDialog()
+        dialog.loadContent()
+        dialog.newSettingsReady.connect(self._processNewSettings)
 
         return
 
@@ -518,8 +480,6 @@ class GuiManuscript(QDialog):
                 return obj
         return None
 
-# END Class GuiManuscript
-
 
 class _DetailsWidget(QWidget):
 
@@ -661,8 +621,6 @@ class _DetailsWidget(QWidget):
 
         return
 
-# END Class _DetailsWidget
-
 
 class _OutlineWidget(QWidget):
 
@@ -742,8 +700,6 @@ class _OutlineWidget(QWidget):
         self.outlineEntryClicked.emit(str(item.data(0, self.D_LINE)))
         return
 
-# END Class _OutlineWidget
-
 
 class _PreviewWidget(QTextBrowser):
 
@@ -761,7 +717,6 @@ class _PreviewWidget(QTextBrowser):
         self.setPalette(dPalette)
 
         self.setMinimumWidth(40*SHARED.theme.textNWidth)
-        self.setTextFont(CONFIG.textFont, CONFIG.textSize)
         self.setTabStopDistance(CONFIG.getTabWidth())
         self.setOpenExternalLinks(False)
 
@@ -802,6 +757,8 @@ class _PreviewWidget(QTextBrowser):
         self._updateDocMargins()
         self._updateBuildAge()
 
+        self.setTextFont(CONFIG.textFont)
+
         # Age Timer
         self.ageTimer = QTimer(self)
         self.ageTimer.setInterval(10000)
@@ -820,23 +777,14 @@ class _PreviewWidget(QTextBrowser):
         self._updateBuildAge()
         return
 
-    def setJustify(self, state: bool) -> None:
-        """Enable/disable the justify text option."""
-        pOptions = self.document().defaultTextOption()
-        if state:
-            pOptions.setAlignment(QtAlignJustify)
-        else:
-            pOptions.setAlignment(QtAlignAbsolute)
-        self.document().setDefaultTextOption(pOptions)
-        return
-
-    def setTextFont(self, family: str, size: int) -> None:
-        """Set the text font properties."""
-        if family:
-            font = QFont()
-            font.setFamily(family)
-            font.setPointSize(size)
-            self.document().setDefaultFont(font)
+    def setTextFont(self, font: QFont) -> None:
+        """Set the text font properties and then reset for sub-widgets.
+        This needs special attention since there appears to be a bug in
+        Qt 5.15.3. See issues #1862 and #1875.
+        """
+        self.setFont(font)
+        self.buildProgress.setFont(SHARED.theme.guiFont)
+        self.ageLabel.setFont(SHARED.theme.guiFontSmall)
         return
 
     ##
@@ -860,31 +808,19 @@ class _PreviewWidget(QTextBrowser):
         QApplication.processEvents()
         return
 
-    def setContent(self, data: dict) -> None:
+    def setContent(self, document: QTextDocument) -> None:
         """Set the content of the preview widget."""
         QApplication.setOverrideCursor(QCursor(Qt.CursorShape.WaitCursor))
 
         self.buildProgress.setCentreText(self.tr("Processing ..."))
         QApplication.processEvents()
 
-        styles = "\n".join(data.get("styles", []))
-        self.document().setDefaultStyleSheet(styles)
-
-        html = "".join(data.get("html", []))
-        html = html.replace("\t", "!!tab!!")
-        self.setHtml(html)
-        QApplication.processEvents()
-        while self.find("!!tab!!"):
-            cursor = self.textCursor()
-            cursor.insertText("\t")
+        document.setDocumentMargin(CONFIG.getTextMargin())
+        self.setDocument(document)
 
-        self._docTime = checkInt(data.get("time"), 0)
+        self._docTime = int(time())
         self._updateBuildAge()
 
-        # Since we change the content while it may still be rendering, we mark
-        # the document as dirty again to make sure it's re-rendered properly.
-        self.document().markContentsDirty(0, self.document().characterCount())
-
         self.buildProgress.setCentreText(self.tr("Done"))
         QApplication.restoreOverrideCursor()
         QApplication.processEvents()
@@ -929,17 +865,14 @@ class _PreviewWidget(QTextBrowser):
     @pyqtSlot()
     def _updateBuildAge(self) -> None:
         """Update the build time and the fuzzy age."""
-        if self._docTime > 0:
-            strBuildTime = "%s (%s)" % (
-                CONFIG.localDateTime(datetime.fromtimestamp(self._docTime)),
-                fuzzyTime(int(time()) - self._docTime)
-            )
+        if self._buildName and self._docTime > 0:
+            self.ageLabel.setText("<b>{0}</b><br>{1}: {2}".format(
+                self._buildName,
+                self.tr("Built"),
+                fuzzyTime(int(time()) - self._docTime),
+            ))
         else:
-            strBuildTime = self.tr("Unknown")
-        text = "{0}: {1}".format(self.tr("Built"), strBuildTime)
-        if self._buildName:
-            text = "<b>{0}</b><br>{1}".format(self._buildName, text)
-        self.ageLabel.setText(text)
+            self.ageLabel.setText("<b>{0}</b>".format(self.tr("No Preview")))
         return
 
     @pyqtSlot()
@@ -969,8 +902,6 @@ class _PreviewWidget(QTextBrowser):
         self.buildProgress.move((vW-pS)//2, (vH-pS)//2)
         return
 
-# END Class _PreviewWidget
-
 
 class _StatsWidget(QWidget):
 
@@ -1035,16 +966,14 @@ class _StatsWidget(QWidget):
     @pyqtSlot(bool)
     def _toggleView(self, state: bool) -> None:
         """Toggle minimal or maximal view."""
-        ignored = QSizePolicy.Policy.Ignored
-        expanded = QSizePolicy.Policy.Expanding
         if state:
             self.mainStack.setCurrentWidget(self.maxWidget)
-            self.maxWidget.setSizePolicy(expanded, expanded)
-            self.minWidget.setSizePolicy(ignored, ignored)
+            self.maxWidget.setSizePolicy(QtSizeExpanding, QtSizeExpanding)
+            self.minWidget.setSizePolicy(QtSizeIgnored, QtSizeIgnored)
         else:
             self.mainStack.setCurrentWidget(self.minWidget)
-            self.maxWidget.setSizePolicy(ignored, ignored)
-            self.minWidget.setSizePolicy(expanded, expanded)
+            self.maxWidget.setSizePolicy(QtSizeIgnored, QtSizeIgnored)
+            self.minWidget.setSizePolicy(QtSizeExpanding, QtSizeExpanding)
         self.maxWidget.adjustSize()
         self.minWidget.adjustSize()
         self.mainStack.adjustSize()
@@ -1146,5 +1075,3 @@ class _StatsWidget(QWidget):
         self.maxWidget.setLayout(self.maxLayout)
 
         return
-
-# END Class _StatsWidget