novelWriter 2.2b1__py3-none-any.whl → 2.2rc1__py3-none-any.whl

novelwriter/tools/dictionaries.py

@@ -0,0 +1,268 @@
+"""
+novelWriter – GUI Dictionary Downloader
+=======================================
+
+File History:
+Created: 2023-11-19 [2.2rc1]
+
+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 <https://www.gnu.org/licenses/>.
+"""
+from __future__ import annotations
+
+import logging
+
+from pathlib import Path
+from zipfile import ZipFile
+
+from PyQt5.QtGui import QCloseEvent, QTextCursor
+from PyQt5.QtCore import pyqtSlot
+from PyQt5.QtWidgets import (
+    QDialog, QDialogButtonBox, QFileDialog, QFrame, QHBoxLayout, QLabel,
+    QLineEdit, QPlainTextEdit, QPushButton, QVBoxLayout, QWidget, qApp
+)
+
+from novelwriter import CONFIG, SHARED
+from novelwriter.error import formatException
+from novelwriter.common import openExternalPath, formatInt, getFileSize
+
+logger = logging.getLogger(__name__)
+
+
+class GuiDictionaries(QDialog):
+
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
+
+        logger.debug("Create: GuiDictionaries")
+        self.setObjectName("GuiDictionaries")
+        self.setWindowTitle(self.tr("Add Dictionaries"))
+
+        self._installPath = None
+        self._currDicts = set()
+
+        iPx = CONFIG.pxInt(4)
+        mPx = CONFIG.pxInt(8)
+        sPx = CONFIG.pxInt(16)
+
+        self.setMinimumWidth(CONFIG.pxInt(500))
+        self.setMinimumHeight(CONFIG.pxInt(300))
+
+        # Hunspell Dictionaries
+        foUrl = "https://www.freeoffice.com/en/download/dictionaries"
+        loUrl = "https://extensions.libreoffice.org"
+        self.huInfo = QLabel("<br>".join([
+            self.tr("Download a dictionary from one of the links, and add it below."),
+            f"&nbsp;\u203a <a href='{foUrl}'>{foUrl}</a>",
+            f"&nbsp;\u203a <a href='{loUrl}'>{loUrl}</a>",
+        ]))
+        self.huInfo.setOpenExternalLinks(True)
+        self.huInfo.setWordWrap(True)
+        self.huInput = QLineEdit(self)
+        self.huBrowse = QPushButton(self)
+        self.huBrowse.setIcon(SHARED.theme.getIcon("browse"))
+        self.huBrowse.clicked.connect(self._doBrowseHunspell)
+        self.huImport = QPushButton(self.tr("Add Dictionary"), self)
+        self.huImport.setIcon(SHARED.theme.getIcon("add"))
+        self.huImport.clicked.connect(self._doImportHunspell)
+
+        self.huPathBox = QHBoxLayout()
+        self.huPathBox.addWidget(self.huInput)
+        self.huPathBox.addWidget(self.huBrowse)
+        self.huPathBox.setSpacing(iPx)
+        self.huAddBox = QHBoxLayout()
+        self.huAddBox.addStretch(1)
+        self.huAddBox.addWidget(self.huImport)
+
+        # Install Path
+        self.inInfo = QLabel(self.tr("Dictionary install location"))
+        self.inPath = QLineEdit(self)
+        self.inPath.setReadOnly(True)
+        self.inBrowse = QPushButton(self)
+        self.inBrowse.setIcon(SHARED.theme.getIcon("browse"))
+        self.inBrowse.clicked.connect(self._doOpenInstallLocation)
+
+        self.inBox = QHBoxLayout()
+        self.inBox.addWidget(self.inPath)
+        self.inBox.addWidget(self.inBrowse)
+        self.inBox.setSpacing(iPx)
+
+        # Info Box
+        self.infoBox = QPlainTextEdit(self)
+        self.infoBox.setReadOnly(True)
+        self.infoBox.setFixedHeight(4*SHARED.theme.fontPixelSize)
+        self.infoBox.setFrameStyle(QFrame.Shape.NoFrame)
+
+        # Buttons
+        self.buttonBox = QDialogButtonBox(QDialogButtonBox.Close)
+        self.buttonBox.rejected.connect(self._doClose)
+
+        # Assemble
+        self.innerBox = QVBoxLayout()
+        self.innerBox.addWidget(self.huInfo)
+        self.innerBox.addLayout(self.huPathBox)
+        self.innerBox.addLayout(self.huAddBox)
+        self.innerBox.addSpacing(mPx)
+        self.innerBox.addWidget(self.inInfo)
+        self.innerBox.addLayout(self.inBox)
+        self.innerBox.addWidget(self.infoBox)
+        self.innerBox.setSpacing(iPx)
+
+        self.outerBox = QVBoxLayout()
+        self.outerBox.addLayout(self.innerBox, 0)
+        self.outerBox.addStretch(1)
+        self.outerBox.addWidget(self.buttonBox, 0)
+        self.outerBox.setSpacing(sPx)
+
+        self.setLayout(self.outerBox)
+
+        logger.debug("Ready: GuiDictionaries")
+
+        return
+
+    def __del__(self) -> None:  # pragma: no cover
+        logger.debug("Delete: GuiDictionaries")
+        return
+
+    def initDialog(self) -> bool:
+        """Prepare and check that we can proceed."""
+        try:
+            import enchant
+            path = Path(enchant.get_user_config_dir())
+        except Exception:
+            logger.error("Could not get enchant path")
+            return False
+
+        self._installPath = Path(path).resolve()
+        if path.is_dir():
+            self.inPath.setText(str(path))
+            hunspell = path / "hunspell"
+            if hunspell.is_dir():
+                self._currDicts = set(
+                    i.stem for i in hunspell.iterdir() if i.is_file() and i.suffix == ".aff"
+                )
+            self._appendLog(self.tr(
+                "Additional dictionaries found: {0}"
+            ).format(len(self._currDicts)))
+
+        qApp.processEvents()
+        self.adjustSize()
+
+        return True
+
+    ##
+    #  Events
+    ##
+
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Capture the user closing the window."""
+        event.accept()
+        self.deleteLater()
+        return
+
+    ##
+    #  Private Slots
+    ##
+
+    @pyqtSlot()
+    def _doBrowseHunspell(self):
+        """Browse for a Free/Libre Office dictionary."""
+        extFilter = [
+            self.tr("Free or Libre Office extension ({0})").format("*.sox *.oxt"),
+            self.tr("All files ({0})").format("*"),
+        ]
+        soxFile, _ = QFileDialog.getOpenFileName(
+            self, self.tr("Browse Files"), "", filter=";;".join(extFilter)
+        )
+        if soxFile:
+            path = Path(soxFile).absolute()
+            self.huInput.setText(str(path))
+        return
+
+    @pyqtSlot()
+    def _doImportHunspell(self):
+        """Import a hunspell dictionary from .sox or .oxt file."""
+        procErr = self.tr("Could not process dictionary file")
+        if self._installPath:
+            temp = self.huInput.text()
+            if temp and (path := Path(temp)).is_file():
+                hunspell = self._installPath / "hunspell"
+                hunspell.mkdir(exist_ok=True)
+                try:
+                    nAff, nDic = self._extractDicts(path, hunspell)
+                    if nAff == 0 or nDic == 0:
+                        self._appendLog(procErr, err=True)
+                except Exception as exc:
+                    self._appendLog(procErr, err=True)
+                    self._appendLog(formatException(exc), err=True)
+            else:
+                self._appendLog(procErr, err=True)
+        return
+
+    @pyqtSlot()
+    def _doOpenInstallLocation(self) -> None:
+        """Open the dictionary folder."""
+        if not openExternalPath(Path(self.inPath.text())):
+            SHARED.error("Path not found.")
+        return
+
+    @pyqtSlot()
+    def _doClose(self) -> None:
+        """Close the dialog."""
+        self.close()
+        return
+
+    ##
+    #  Internal Functions
+    ##
+
+    def _extractDicts(self, path: Path, output: Path) -> tuple[int, int]:
+        """Extract a zip archive and return the number of .aff and .dic
+        files found in it.
+        """
+        nAff = nDic = 0
+        with ZipFile(path, mode="r") as zipObj:
+            for item in zipObj.namelist():
+                zPath = Path(item)
+                if zPath.suffix not in (".aff", ".dic"):
+                    continue
+                nAff += 1 if zPath.suffix == ".aff" else 0
+                nDic += 1 if zPath.suffix == ".dic" else 0
+                with zipObj.open(item) as zF:
+                    oPath = output / zPath.name
+                    oPath.write_bytes(zF.read())
+                    size = getFileSize(oPath)
+                    self._appendLog(self.tr(
+                        "Added: {0} [{1}B]"
+                    ).format(zPath.name, formatInt(size)))
+        return nAff, nDic
+
+    def _appendLog(self, text: str, err: bool = False) -> None:
+        """Append a line to the log output."""
+        cursor = self.infoBox.textCursor()
+        cursor.movePosition(QTextCursor.MoveOperation.End)
+        if cursor.position() > 0:
+            cursor.insertText("\n")
+        if err:
+            cursor.insertHtml(f"<font color='red'>{text}</font>")
+        else:
+            cursor.insertText(text)
+        cursor.movePosition(QTextCursor.MoveOperation.End)
+        cursor.deleteChar()
+        self.infoBox.setTextCursor(cursor)
+        return
+
+# END Class GuiDictionaries

novelwriter/tools/manusbuild.py

@@ -27,6 +27,7 @@ import logging
 
 from pathlib import Path
 
+from PyQt5.QtGui import QCloseEvent
 from PyQt5.QtCore import QSize, QTimer, Qt, pyqtSlot
 from PyQt5.QtWidgets import (
     QAbstractButton, QAbstractItemView, QDialog, QDialogButtonBox, QFileDialog,
@@ -36,7 +37,7 @@ from PyQt5.QtWidgets import (
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.enum import nwBuildFmt
-from novelwriter.common import makeFileNameSafe
+from novelwriter.common import makeFileNameSafe, openExternalPath
 from novelwriter.constants import nwLabels
 from novelwriter.core.item import NWItem
 from novelwriter.core.docbuild import NWBuildDocument
@@ -175,9 +176,11 @@ class GuiManuscriptBuild(QDialog):
         self.buildBox.setVerticalSpacing(sp4)
 
         # Dialog Buttons
+        self.btnOpen = QPushButton(SHARED.theme.getIcon("browse"), self.tr("Open Folder"))
         self.btnBuild = QPushButton(SHARED.theme.getIcon("export"), self.tr("&Build"))
-        self.dlgButtons = QDialogButtonBox(QDialogButtonBox.Close)
-        self.dlgButtons.addButton(self.btnBuild, QDialogButtonBox.ActionRole)
+        self.dlgButtons = QDialogButtonBox(QDialogButtonBox.StandardButton.Close)
+        self.dlgButtons.addButton(self.btnOpen, QDialogButtonBox.ButtonRole.ActionRole)
+        self.dlgButtons.addButton(self.btnBuild, QDialogButtonBox.ButtonRole.ActionRole)
 
         # Assemble GUI
         # ============
@@ -227,7 +230,7 @@ class GuiManuscriptBuild(QDialog):
 
         return
 
-    def __del__(self):  # pragma: no cover
+    def __del__(self) -> None:  # pragma: no cover
         logger.debug("Delete: GuiManuscriptBuild")
         return
 
@@ -235,7 +238,7 @@ class GuiManuscriptBuild(QDialog):
     #  Events
     ##
 
-    def closeEvent(self, event):
+    def closeEvent(self, event: QCloseEvent) -> None:
         """Capture the user closing the window so we can save GUI
         settings.
         """
@@ -253,7 +256,10 @@ class GuiManuscriptBuild(QDialog):
         """Handle button clicks from the dialog button box."""
         role = self.dlgButtons.buttonRole(button)
         if role == QDialogButtonBox.ActionRole:
-            self._runBuild()
+            if button == self.btnBuild:
+                self._runBuild()
+            elif button == self.btnOpen:
+                self._openOutputFolder()
         elif role == QDialogButtonBox.RejectRole:
             self.close()
         return
@@ -385,4 +391,9 @@ class GuiManuscriptBuild(QDialog):
 
         return
 
+    def _openOutputFolder(self):
+        """Open the build folder in the system's file explorer."""
+        openExternalPath(Path(self.buildPath.text()))
+        return
+
 # END Class GuiManuscriptBuild

novelwriter/tools/manuscript.py

@@ -507,7 +507,7 @@ class _DetailsWidget(QWidget):
 
         self._initExpanded = True
 
-        # Tree Vidget
+        # Tree Widget
         self.listView = QTreeWidget(self)
         self.listView.setHeaderLabels([self.tr("Setting"), self.tr("Value")])
         self.listView.setIndentation(SHARED.theme.baseIconSize)

novelwriter/tools/writingstats.py

@@ -125,7 +125,7 @@ class GuiWritingStats(QDialog):
             pOptions.getInt("GuiWritingStats", "sortOrder", Qt.DescendingOrder),
             (Qt.AscendingOrder, Qt.DescendingOrder), Qt.DescendingOrder
         )
-        self.listBox.sortByColumn(sortCol, sortOrder)
+        self.listBox.sortByColumn(sortCol, sortOrder)  # type: ignore
         self.listBox.setSortingEnabled(True)
 
         # Word Bar

novelwriter/assets/icons/typicons_dark/typ_at.svg

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="24" height="24" version="1.2" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
- <path d="m12 2c-5.5138 0-10 4.4862-10 10s4.4862 10 10 10c2.02 0 3.965-0.59875 5.6238-1.73 0.57-0.39 0.7175-1.1675 0.32875-1.7375-0.38875-0.57125-1.165-0.715-1.7375-0.32875-1.2425 0.84875-2.7 1.2962-4.215 1.2962-4.1362 0-7.5-3.3638-7.5-7.5s3.3638-7.5 7.5-7.5 7.5 3.3638 7.5 7.5v0.625c0 0.69-0.56 1.25-1.25 1.25s-1.25-0.56-1.25-1.25v-3.75c0-0.69125-0.55875-1.25-1.25-1.25-0.55125 0-1.0062 0.3625-1.1725 0.86-0.725-0.53375-1.6112-0.86-2.5775-0.86-2.4125 0-4.375 1.9625-4.375 4.375s1.9625 4.375 4.375 4.375c1.3062 0 2.4688-0.5875 3.27-1.4988 0.685 0.90375 1.76 1.4988 2.98 1.4988 2.0675 0 3.75-1.6825 3.75-3.75v-0.625c0-5.5138-4.4862-10-10-10zm0 11.875c-1.0338 0-1.875-0.84125-1.875-1.875s0.84125-1.875 1.875-1.875 1.875 0.84125 1.875 1.875-0.84125 1.875-1.875 1.875z" fill="#69c" stroke-width="1.25"/>
-</svg>

novelwriter/assets/icons/typicons_light/typ_at.svg

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="24" height="24" version="1.2" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
- <path d="m12 2c-5.5138 0-10 4.4862-10 10s4.4862 10 10 10c2.02 0 3.965-0.59875 5.6238-1.73 0.57-0.39 0.7175-1.1675 0.32875-1.7375-0.38875-0.57125-1.165-0.715-1.7375-0.32875-1.2425 0.84875-2.7 1.2962-4.215 1.2962-4.1362 0-7.5-3.3638-7.5-7.5s3.3638-7.5 7.5-7.5 7.5 3.3638 7.5 7.5v0.625c0 0.69-0.56 1.25-1.25 1.25s-1.25-0.56-1.25-1.25v-3.75c0-0.69125-0.55875-1.25-1.25-1.25-0.55125 0-1.0062 0.3625-1.1725 0.86-0.725-0.53375-1.6112-0.86-2.5775-0.86-2.4125 0-4.375 1.9625-4.375 4.375s1.9625 4.375 4.375 4.375c1.3062 0 2.4688-0.5875 3.27-1.4988 0.685 0.90375 1.76 1.4988 2.98 1.4988 2.0675 0 3.75-1.6825 3.75-3.75v-0.625c0-5.5138-4.4862-10-10-10zm0 11.875c-1.0338 0-1.875-0.84125-1.875-1.875s0.84125-1.875 1.875-1.875 1.875 0.84125 1.875 1.875-0.84125 1.875-1.875 1.875z" fill="#4271ae" stroke-width="1.25"/>
-</svg>