""" novelWriter – GUI Manuscript Tool ================================= File History: Created: 2023-05-13 [2.1b1] GuiManuscript This file is a part of novelWriter Copyright 2018–2023, 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 . """ from __future__ import annotations import json import logging from time import time from typing import TYPE_CHECKING from datetime import datetime from PyQt5.QtGui import QColor, QCursor, QFont, QPalette, QResizeEvent from PyQt5.QtCore import QTimer, Qt, pyqtSlot from PyQt5.QtWidgets import ( QDialog, QHBoxLayout, QLabel, QListWidget, QListWidgetItem, QMenu, QProgressBar, QPushButton, QSplitter, QTextBrowser, QVBoxLayout, QWidget, qApp ) from novelwriter import CONFIG from novelwriter.error import logException from novelwriter.common import checkInt, fuzzyTime from novelwriter.core.tohtml import ToHtml from novelwriter.core.docbuild import NWBuildDocument from novelwriter.core.buildsettings import BuildCollection, BuildSettings from novelwriter.tools.manussettings import GuiBuildSettings if TYPE_CHECKING: # pragma: no cover from novelwriter.guimain import GuiMain logger = logging.getLogger(__name__) class GuiManuscript(QDialog): """GUI Tools: Manuscript Tool The dialog displays all the users build definitions, a preview panel for the manuscript, and can trigger the actual build dialog to build a document directly to disk. """ def __init__(self, mainGui: GuiMain): super().__init__(parent=mainGui) logger.debug("Create: GuiManuscript") self.setObjectName("GuiManuscript") self.mainGui = mainGui self.mainTheme = mainGui.mainTheme self.theProject = mainGui.theProject self._builds = BuildCollection(self.theProject) self._buildMap = {} self.setWindowTitle(self.tr("Build Manuscript")) self.setMinimumWidth(CONFIG.pxInt(600)) self.setMinimumHeight(CONFIG.pxInt(500)) wWin = CONFIG.pxInt(900) hWin = CONFIG.pxInt(600) pOptions = self.theProject.options self.resize( CONFIG.pxInt(pOptions.getInt("GuiManuscript", "winWidth", wWin)), CONFIG.pxInt(pOptions.getInt("GuiManuscript", "winHeight", hWin)) ) # Build Controls # ============== self.buildList = QListWidget() self.btnNew = QPushButton(self.tr("New")) self.btnNew.clicked.connect(self._createNewBuild) self.btnEdit = QPushButton(self.tr("Edit")) self.btnEdit.clicked.connect(self._editSelectedBuild) self.btnDelete = QPushButton(self.tr("Delete")) # Process Controls # ================ self.buildProgress = QProgressBar() self.btnPreview = QPushButton(self.tr("Build Preview")) self.btnPreview.clicked.connect(self._generatePreview) self.manPreview = _PreviewWidget(self.mainGui) self.menuPrint = QMenu(self) self.aPrintSend = self.menuPrint.addAction(self.tr("Print Preview")) self.aPrintFile = self.menuPrint.addAction(self.tr("Print to PDF")) self.menuSave = QMenu(self) self.aSaveODT = self.menuSave.addAction(self.tr("Open Document (.odt)")) self.aSaveFODT = self.menuSave.addAction(self.tr("Flat Open Document (.fodt)")) self.aSaveHTM = self.menuSave.addAction(self.tr("novelWriter HTML (.htm)")) self.aSaveNWD = self.menuSave.addAction(self.tr("novelWriter Markdown (.nwd)")) self.aSaveMD = self.menuSave.addAction(self.tr("Standard Markdown (.md)")) self.aSaveGH = self.menuSave.addAction(self.tr("GitHub Markdown (.md)")) self.aSaveJsonH = self.menuSave.addAction(self.tr("JSON + novelWriter HTML (.json)")) self.aSaveJsonM = self.menuSave.addAction(self.tr("JSON + novelWriter Markdown (.json)")) self.btnPrint = QPushButton(self.tr("Print")) self.btnPrint.setMenu(self.menuPrint) self.btnSave = QPushButton(self.tr("Save As")) self.btnSave.setMenu(self.menuSave) self.btnClose = QPushButton(self.tr("Close")) self.btnClose.clicked.connect(self._doClose) # Assemble GUI # ============ self.buildBox = QHBoxLayout() self.buildBox.addWidget(self.btnNew) self.buildBox.addWidget(self.btnEdit) self.buildBox.addWidget(self.btnDelete) self.processBox = QHBoxLayout() self.processBox.addWidget(self.btnSave) self.processBox.addWidget(self.btnPrint) self.processBox.addWidget(self.btnClose) self.controlBox = QVBoxLayout() self.controlBox.addWidget(self.buildList) self.controlBox.addLayout(self.buildBox) self.controlBox.addWidget(self.buildProgress) self.controlBox.addWidget(self.btnPreview) self.controlBox.addLayout(self.processBox) self.controlBox.setContentsMargins(0, 0, 0, 0) self.optsWidget = QWidget() self.optsWidget.setLayout(self.controlBox) self.mainSplit = QSplitter() self.mainSplit.addWidget(self.optsWidget) self.mainSplit.addWidget(self.manPreview) self.mainSplit.setSizes([ CONFIG.pxInt(pOptions.getInt("GuiManuscript", "optsWidth", wWin//3)), CONFIG.pxInt(pOptions.getInt("GuiManuscript", "viewWidth", 2*wWin//3)), ]) self.outerBox = QVBoxLayout() self.outerBox.addWidget(self.mainSplit) self.setLayout(self.outerBox) self.setSizeGripEnabled(True) logger.debug("Ready: GuiManuscript") return def __del__(self): """For debug use only.""" logger.debug("Delete: GuiManuscript") return def loadContent(self): """Load dialog content from project data.""" self._builds.loadCollection() self._updateBuildsList() logger.debug("Loading build cache") cache = CONFIG.dataPath("cache") / f"build_{self.theProject.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 save build cache") logException() return return ## # Events ## def closeEvent(self, event): """Capture the user closing the window so we can save GUI settings. We also check that we don't have a build settings diralog open. """ self._saveSettings() for obj in self.children(): # Make sure we don't have any settings windows open if isinstance(obj, GuiBuildSettings) and obj.isVisible(): obj.close() event.accept() self.deleteLater() return ## # Private Slots ## @pyqtSlot() def _createNewBuild(self): """Open the build settings dialog for a new build.""" build = BuildSettings() build.setName(self.tr("My Manuscript")) self._openSettingsDialog(build) return @pyqtSlot() def _editSelectedBuild(self): """Edit the currently selected build settings entry.""" build = self._getSelectedBuild() if build is not None: self._openSettingsDialog(build) return @pyqtSlot(BuildSettings) def _processNewSettings(self, build: BuildSettings): """Process new build settings from the settings dialog.""" self._builds.setBuild(build) self._builds.saveCollection() self._updateBuildItem(build) return @pyqtSlot() def _generatePreview(self): """Run the document builder on the current build settings for the preview widget. """ build = self._getSelectedBuild() if build is None: return docBuild = NWBuildDocument(self.theProject, build) docBuild.queueAll() self.buildProgress.setMaximum(len(docBuild)) for step, status in docBuild.iterBuildHTML(None): self.buildProgress.setValue(step + 1) buildObj = docBuild.lastBuild assert isinstance(buildObj, ToHtml) result = { "uuid": build.buildID, "time": int(time()), "styles": buildObj.getStyleSheet(), "html": buildObj.fullHTML, } self._updatePreview(result, build) logger.debug("Saving build cache") cache = CONFIG.dataPath("cache") / f"build_{self.theProject.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 return @pyqtSlot() def _doClose(self): """Forward the close button to the default close method.""" self.close() return ## # Internal Functions ## def _updatePreview(self, data: dict, build: BuildSettings): """Update the preview widget and set relevant values.""" self.manPreview.setContent(data) self.manPreview.setBuildName(build.name) self.manPreview.setTextFont( build.getStr("format.textFont"), build.getInt("format.textSize") ) self.manPreview.setJustify( build.getBool("format.justifyText") ) return def _getSelectedBuild(self) -> BuildSettings | None: """Get the currently selected build.""" bItems = self.buildList.selectedItems() if bItems: build = self._builds.getBuild(bItems[0].data(Qt.UserRole)) if isinstance(build, BuildSettings): return build return None def _saveManuscript(self, outFormat: int): """Save the manuscript file or files.""" return def _saveSettings(self): """Save the user GUI settings.""" logger.debug("Saving GuiManuscript settings") winWidth = CONFIG.rpxInt(self.width()) winHeight = CONFIG.rpxInt(self.height()) mainSplit = self.mainSplit.sizes() optsWidth = CONFIG.rpxInt(mainSplit[0]) viewWidth = CONFIG.rpxInt(mainSplit[1]) pOptions = self.theProject.options pOptions.setValue("GuiManuscript", "winWidth", winWidth) pOptions.setValue("GuiManuscript", "winHeight", winHeight) pOptions.setValue("GuiManuscript", "optsWidth", optsWidth) pOptions.setValue("GuiManuscript", "viewWidth", viewWidth) pOptions.saveSettings() return def _openSettingsDialog(self, build: BuildSettings): """Open the build settings dialog.""" dlgSettings = GuiBuildSettings(self, self.mainGui, build) dlgSettings.setModal(False) dlgSettings.show() dlgSettings.raise_() qApp.processEvents() dlgSettings.loadContent() dlgSettings.newSettingsReady.connect(self._processNewSettings) return def _updateBuildsList(self): """Update the list of available builds.""" self.buildList.clear() for key, name in self._builds.builds(): bItem = QListWidgetItem() bItem.setText(name) bItem.setData(Qt.UserRole, key) self.buildList.addItem(bItem) self._buildMap[key] = bItem return def _updateBuildItem(self, build: BuildSettings): """Update the entry of a specific build item.""" bItem = self._buildMap.get(build.buildID, None) if isinstance(bItem, QListWidgetItem): bItem.setText(build.name) else: # Propbably a new item self._updateBuildsList() return # END Class GuiManuscript class _PreviewWidget(QTextBrowser): def __init__(self, mainGui: GuiMain): super().__init__(parent=mainGui) self.mainGui = mainGui self.mainTheme = mainGui.mainTheme self.theProject = mainGui.theProject self._docTime = 0 self._buildName = "" # Document Setup dPalette = self.palette() dPalette.setColor(QPalette.Base, QColor(255, 255, 255)) dPalette.setColor(QPalette.Text, QColor(0, 0, 0)) self.setPalette(dPalette) self.setMinimumWidth(40*self.mainGui.mainTheme.textNWidth) self.setTextFont(CONFIG.textFont, CONFIG.textSize) self.setTabStopDistance(CONFIG.getTabWidth()) self.setOpenExternalLinks(False) self.document().setDocumentMargin(CONFIG.getTextMargin()) self.setPlaceholderText(self.tr( "Press the \"Build Preview\" button to generate ..." )) # Document Age aPalette = self.palette() aPalette.setColor(QPalette.Background, aPalette.toolTipBase().color()) aPalette.setColor(QPalette.Foreground, aPalette.toolTipText().color()) aFont = self.font() aFont.setPointSizeF(0.9*self.mainTheme.fontPointSize) self.ageLabel = QLabel("", self) self.ageLabel.setIndent(0) self.ageLabel.setFont(aFont) self.ageLabel.setPalette(aPalette) self.ageLabel.setAutoFillBackground(True) self.ageLabel.setAlignment(Qt.AlignCenter) self.ageLabel.setFixedHeight(int(2.1*self.mainTheme.fontPixelSize)) self._updateDocMargins() self._updateBuildAge() # Age Timer self.ageTimer = QTimer() self.ageTimer.setInterval(10) self.ageTimer.timeout.connect(self._updateBuildAge) self.ageTimer.start() return ## # Setters ## def setBuildName(self, name: str): """Set the build name for the document label.""" self._buildName = name self._updateBuildAge() return def setJustify(self, state: bool): """Enable/disable the justify text option.""" options = self.document().defaultTextOption() if state: options.setAlignment(Qt.AlignJustify) else: options.setAlignment(Qt.AlignAbsolute) self.document().setDefaultTextOption(options) return def setTextFont(self, family: str, size: int): """Set the text font properties.""" font = QFont() font.setFamily(family) font.setPointSize(size) self.setFont(font) return ## # Methods ## def setContent(self, data: dict): """Set the content of the preview widget.""" sPos = self.verticalScrollBar().value() qApp.setOverrideCursor(QCursor(Qt.WaitCursor)) styles = "\n".join(data.get("styles", [ "h1, h2 {color: rgb(66, 113, 174);}", "h3, h4 {color: rgb(50, 50, 50);}", "a {color: rgb(66, 113, 174);}", ".tags {color: rgb(245, 135, 31); font-weight: bold;}", ])) self.document().setDefaultStyleSheet(styles) html = "".join(data.get("html", [])) html = html.replace("\t", "!!tab!!") html = html.replace("", "") html = html.replace("", "") self.setHtml(html) qApp.processEvents() while self.find("!!tab!!"): theCursor = self.textCursor() theCursor.insertText("\t") self.verticalScrollBar().setValue(sPos) self._docTime = checkInt(data.get("time"), 0) self._updateBuildAge() # Since we change the content while it may still be rendering, we mark # the document dirty again to make sure it's re-rendered properly. self.document().markContentsDirty(0, self.document().characterCount()) qApp.restoreOverrideCursor() return ## # Events ## def resizeEvent(self, event: QResizeEvent): """Capture resize and update the document margins.""" super().resizeEvent(event) self._updateDocMargins() return ## # Private Slots ## @pyqtSlot() def _updateBuildAge(self): """Update the build time and the fuzzy age.""" if self._docTime > 0: strBuildTime = "%s (%s)" % ( datetime.fromtimestamp(self._docTime).strftime("%x %X"), fuzzyTime(time() - self._docTime) ) else: strBuildTime = self.tr("Unknown") text = "{0} {1}".format(self.tr("Built"), strBuildTime) if self._buildName: text = "{0}
{1}".format(self._buildName, text) self.ageLabel.setText(text) return ## # Internal Functions ## def _updateDocMargins(self): """Automatically adjust the header to fill the top of the document within the viewport. """ vBar = self.verticalScrollBar() sW = vBar.width() if vBar.isVisible() else 0 tB = self.frameWidth() tW = self.width() - 2*tB - sW tH = self.ageLabel.height() self.ageLabel.setGeometry(tB, tB, tW, tH) self.setViewportMargins(0, tH, 0, 0) return # END Class _PreviewWidget