novelWriter 2.4.3__py3-none-any.whl → 2.5__py3-none-any.whl

novelwriter/gui/doceditor.py

@@ -36,11 +36,10 @@ import logging
 
 from enum import Enum
 from time import time
-from typing import TYPE_CHECKING
 
 from PyQt5.QtCore import (
-    QObject, QPoint, QRegExp, QRegularExpression, QRunnable, Qt, QTimer,
-    pyqtSignal, pyqtSlot
+    QObject, QPoint, QRegularExpression, QRunnable, Qt, QTimer, pyqtSignal,
+    pyqtSlot
 )
 from PyQt5.QtGui import (
     QColor, QCursor, QKeyEvent, QKeySequence, QMouseEvent, QPalette, QPixmap,
@@ -55,7 +54,8 @@ from novelwriter import CONFIG, SHARED
 from novelwriter.common import minmax, transferCase
 from novelwriter.constants import nwConst, nwKeyWords, nwShortcode, nwUnicode
 from novelwriter.core.document import NWDocument
-from novelwriter.enum import nwDocAction, nwDocInsert, nwDocMode, nwItemClass, nwTrinary
+from novelwriter.enum import nwComment, nwDocAction, nwDocInsert, nwDocMode, nwItemClass, nwTrinary
+from novelwriter.extensions.configlayout import NColourLabel
 from novelwriter.extensions.eventfilters import WheelEventFilter
 from novelwriter.extensions.modified import NIconToggleButton, NIconToolButton
 from novelwriter.gui.dochighlight import BLOCK_META, BLOCK_TITLE
@@ -65,13 +65,10 @@ from novelwriter.text.counting import standardCounter
 from novelwriter.tools.lipsum import GuiLipsum
 from novelwriter.types import (
     QtAlignCenterTop, QtAlignJustify, QtAlignLeft, QtAlignLeftTop,
-    QtAlignRight, QtKeepAnchor, QtModCtrl, QtModeNone, QtModShift, QtMouseLeft,
+    QtAlignRight, QtKeepAnchor, QtModCtrl, QtModNone, QtModShift, QtMouseLeft,
     QtMoveAnchor, QtMoveLeft, QtMoveRight
 )
 
-if TYPE_CHECKING:  # pragma: no cover
-    from novelwriter.guimain import GuiMain
-
 logger = logging.getLogger(__name__)
 
 
@@ -82,8 +79,6 @@ class _SelectAction(Enum):
     KEEP_POSITION  = 2
     MOVE_AFTER     = 3
 
-# END Class _SelectAction
-
 
 class GuiDocEditor(QPlainTextEdit):
     """Gui Widget: Main Document Editor"""
@@ -107,15 +102,14 @@ class GuiDocEditor(QPlainTextEdit):
     requestProjectItemSelected = pyqtSignal(str, bool)
     requestProjectItemRenamed = pyqtSignal(str, str)
     requestNewNoteCreation = pyqtSignal(str, nwItemClass)
+    requestNextDocument = pyqtSignal(str, bool)
 
-    def __init__(self, mainGui: GuiMain) -> None:
-        super().__init__(parent=mainGui)
+    def __init__(self, parent: QWidget) -> None:
+        super().__init__(parent=parent)
 
         logger.debug("Create: GuiDocEditor")
 
         # Class Variables
-        self.mainGui = mainGui
-
         self._nwDocument = None
         self._nwItem     = None
 
@@ -217,6 +211,7 @@ class GuiDocEditor(QPlainTextEdit):
         # Function Mapping
         self.closeSearch = self.docSearch.closeSearch
         self.searchVisible = self.docSearch.isVisible
+        self.changeFocusState = self.docHeader.changeFocusState
 
         # Finalise
         self.updateSyntaxColours()
@@ -328,8 +323,11 @@ class GuiDocEditor(QPlainTextEdit):
         # Reload spell check and dictionaries
         SHARED.updateSpellCheckLanguage()
 
-        # Set font
-        self.initFont()
+        # Set the font. See issues #1862 and #1875.
+        self.setFont(CONFIG.textFont)
+        self.docHeader.updateFont()
+        self.docFooter.updateFont()
+        self.docSearch.updateFont()
 
         # Update highlighter settings
         self._qDocument.syntaxHighlighter.initHighlighter()
@@ -379,23 +377,6 @@ class GuiDocEditor(QPlainTextEdit):
 
         return
 
-    def initFont(self) -> None:
-        """Set the font of the main widget and sub-widgets. This needs
-        special attention since there appears to be a bug in Qt 5.15.3.
-        See issues #1862 and #1875.
-        """
-        font = self.font()
-        font.setFamily(CONFIG.textFont)
-        font.setPointSize(CONFIG.textSize)
-        self.setFont(font)
-
-        # Reset sub-widget font to GUI font
-        self.docHeader.updateFont()
-        self.docFooter.updateFont()
-        self.docSearch.updateFont()
-
-        return
-
     def loadText(self, tHandle: str, tLine: int | None = None) -> bool:
         """Load text from a document into the editor. If we have an I/O
         error, we must handle this and clear the editor so that we don't
@@ -457,11 +438,6 @@ class GuiDocEditor(QPlainTextEdit):
 
         return True
 
-    def updateTagHighLighting(self) -> None:
-        """Rerun the syntax highlighter on all meta data lines."""
-        self._qDocument.syntaxHighlighter.rehighlightByType(BLOCK_META)
-        return
-
     def replaceText(self, text: str) -> None:
         """Replace the text of the current document with the provided
         text. This also clears undo history.
@@ -492,7 +468,6 @@ class GuiDocEditor(QPlainTextEdit):
         cC, wC, pC = standardCounter(docText)
         self._updateDocCounts(cC, wC, pC)
 
-        self.saveCursorPosition()
         if not self._nwDocument.writeDocument(docText):
             saveOk = False
             if self._nwDocument.hashError:
@@ -855,14 +830,15 @@ class GuiDocEditor(QPlainTextEdit):
             )
         return
 
-    def insertText(self, insert: str | nwDocInsert) -> bool:
+    def insertText(self, insert: str | nwDocInsert) -> None:
         """Insert a specific type of text at the cursor position."""
         if self._docHandle is None:
             logger.error("No document open")
-            return False
+            return
 
-        newBlock = False
-        goAfter = False
+        text = ""
+        block = False
+        after = False
 
         if isinstance(insert, str):
             text = insert
@@ -877,43 +853,41 @@ class GuiDocEditor(QPlainTextEdit):
                 text = self._typDQuoteC
             elif insert == nwDocInsert.SYNOPSIS:
                 text = "%Synopsis: "
-                newBlock = True
-                goAfter = True
+                block = True
+                after = True
             elif insert == nwDocInsert.SHORT:
                 text = "%Short: "
-                newBlock = True
-                goAfter = True
+                block = True
+                after = True
             elif insert == nwDocInsert.NEW_PAGE:
                 text = "[newpage]"
-                newBlock = True
-                goAfter = False
+                block = True
+                after = False
             elif insert == nwDocInsert.VSPACE_S:
                 text = "[vspace]"
-                newBlock = True
-                goAfter = False
+                block = True
+                after = False
             elif insert == nwDocInsert.VSPACE_M:
                 text = "[vspace:2]"
-                newBlock = True
-                goAfter = False
+                block = True
+                after = False
             elif insert == nwDocInsert.LIPSUM:
                 text = GuiLipsum.getLipsum(self)
-                newBlock = True
-                goAfter = False
-            else:
-                return False
-        else:
-            return False
+                block = True
+                after = False
+            elif insert == nwDocInsert.FOOTNOTE:
+                self._insertCommentStructure(nwComment.FOOTNOTE)
 
         if text:
-            if newBlock:
-                self.insertNewBlock(text, defaultAfter=goAfter)
+            if block:
+                self.insertNewBlock(text, defaultAfter=after)
             else:
                 cursor = self.textCursor()
                 cursor.beginEditBlock()
                 cursor.insertText(text)
                 cursor.endEditBlock()
 
-        return True
+        return
 
     def insertNewBlock(self, text: str, defaultAfter: bool = True) -> bool:
         """Insert a piece of text on a blank line."""
@@ -979,7 +953,7 @@ class GuiDocEditor(QPlainTextEdit):
             super().keyPressEvent(event)
             nPos = self.cursorRect().topLeft().y()
             kMod = event.modifiers()
-            okMod = kMod in (QtModeNone, QtModShift)
+            okMod = kMod in (QtModNone, QtModShift)
             okKey = event.key() not in self.MOVE_KEYS
             if nPos != cPos and okMod and okKey:
                 mPos = CONFIG.autoScrollPos*0.01 * self.viewport().height()
@@ -1057,6 +1031,13 @@ class GuiDocEditor(QPlainTextEdit):
             self.beginSearch()
         return
 
+    @pyqtSlot(list, list)
+    def updateChangedTags(self, updated: list[str], deleted: list[str]) -> None:
+        """Tags have changed, so just in case we rehighlight them."""
+        if updated or deleted:
+            self._qDocument.syntaxHighlighter.rehighlightByType(BLOCK_META)
+        return
+
     ##
     #  Private Slots
     ##
@@ -1179,7 +1160,8 @@ class GuiDocEditor(QPlainTextEdit):
                             lambda _, option=option: self._correctWord(sCursor, option)
                         )
                 else:
-                    ctxMenu.addAction("%s %s" % (nwUnicode.U_ENDASH, self.tr("No Suggestions")))
+                    trNone = self.tr("No Suggestions")
+                    ctxMenu.addAction(f"{nwUnicode.U_ENDASH} {trNone}")
 
                 ctxMenu.addSeparator()
                 action = ctxMenu.addAction(self.tr("Add Word to Dictionary"))
@@ -1335,9 +1317,8 @@ class GuiDocEditor(QPlainTextEdit):
             self.docSearch.setResultCount(0, 0)
             self._lastFind = None
             if CONFIG.searchNextFile and not goBack:
-                self.mainGui.openNextDocument(
-                    self._docHandle, wrapAround=CONFIG.searchLoop
-                )
+                self.requestNextDocument.emit(self._docHandle, CONFIG.searchLoop)
+                QApplication.processEvents()
                 self.beginSearch()
                 self.setFocus()
             return
@@ -1356,9 +1337,8 @@ class GuiDocEditor(QPlainTextEdit):
 
         if resIdx > maxIdx and self._docHandle:
             if CONFIG.searchNextFile and not goBack:
-                self.mainGui.openNextDocument(
-                    self._docHandle, wrapAround=CONFIG.searchLoop
-                )
+                self.requestNextDocument.emit(self._docHandle, CONFIG.searchLoop)
+                QApplication.processEvents()
                 self.beginSearch()
                 self.setFocus()
                 return
@@ -1865,6 +1845,32 @@ class GuiDocEditor(QPlainTextEdit):
 
         return
 
+    def _insertCommentStructure(self, style: nwComment) -> None:
+        """Insert a shortcut/comment combo."""
+        if self._docHandle and style == nwComment.FOOTNOTE:
+            self.saveText()  # Index must be up to date
+            key = SHARED.project.index.newCommentKey(self._docHandle, style)
+            code = nwShortcode.COMMENT_STYLES[nwComment.FOOTNOTE]
+
+            cursor = self.textCursor()
+            block = cursor.block()
+            text = block.text().rstrip()
+            if not text or text.startswith("@"):
+                logger.error("Invalid footnote location")
+                return
+
+            cursor.beginEditBlock()
+            cursor.insertText(code.format(key))
+            cursor.setPosition(block.position() + block.length() - 1)
+            cursor.insertBlock()
+            cursor.insertBlock()
+            cursor.insertText(f"%Footnote.{key}: ")
+            cursor.endEditBlock()
+
+            self.setTextCursor(cursor)
+
+        return
+
     ##
     #  Internal Functions
     ##
@@ -1920,8 +1926,6 @@ class GuiDocEditor(QPlainTextEdit):
                 ).format(tag)):
                     itemClass = nwKeyWords.KEY_CLASS.get(tBits[0], nwItemClass.NO_CLASS)
                     self.requestNewNoteCreation.emit(tag, itemClass)
-                    QApplication.processEvents()
-                    self._qDocument.syntaxHighlighter.rehighlightBlock(block)
 
             return nwTrinary.POSITIVE if exist else nwTrinary.NEGATIVE
 
@@ -2028,6 +2032,9 @@ class GuiDocEditor(QPlainTextEdit):
             cursor.movePosition(QtMoveLeft, QtKeepAnchor, nDelete)
             cursor.insertText(tInsert)
 
+        # Re-highlight, since the auto-replace sometimes interferes with it
+        self._qDocument.syntaxHighlighter.rehighlightBlock(cursor.block())
+
         return
 
     @staticmethod
@@ -2128,8 +2135,6 @@ class GuiDocEditor(QPlainTextEdit):
             self._doReplace = False
         return
 
-# END Class GuiDocEditor
-
 
 class MetaCompleter(QMenu):
     """GuiWidget: Meta Completer Menu
@@ -2207,15 +2212,13 @@ class MetaCompleter(QMenu):
         self.complete.emit(pos, length, value)
         return
 
-# END Class MetaCompleter
-
-
-# =============================================================================================== #
-#  The Off-GUI Thread Word Counter
-#  A runnable for the word counter to be run in the thread pool off the main GUI thread.
-# =============================================================================================== #
 
 class BackgroundWordCounter(QRunnable):
+    """The Off-GUI Thread Word Counter
+
+    A runnable for the word counter to be run in the thread pool off the
+    main GUI thread.
+    """
 
     def __init__(self, docEditor: GuiDocEditor, forSelection: bool = False) -> None:
         super().__init__()
@@ -2248,8 +2251,6 @@ class BackgroundWordCounter(QRunnable):
 
         return
 
-# END Class BackgroundWordCounter
-
 
 class BackgroundWordCounterSignals(QObject):
     """The QRunnable cannot emit a signal, so we need a simple QObject
@@ -2257,15 +2258,13 @@ class BackgroundWordCounterSignals(QObject):
     """
     countsReady = pyqtSignal(int, int, int)
 
-# END Class BackgroundWordCounterSignals
-
-
-# =============================================================================================== #
-#  The Formatting and Options Fold Out Menu
-#  Only used by DocEditor, and is opened by the first button in the header
-# =============================================================================================== #
 
 class GuiDocToolBar(QWidget):
+    """The Formatting and Options Fold Out Menu
+
+    Only used by DocEditor, and is opened by the first button in the
+    header.
+    """
 
     requestDocAction = pyqtSignal(nwDocAction)
 
@@ -2390,15 +2389,13 @@ class GuiDocToolBar(QWidget):
 
         return
 
-# END Class GuiDocToolBar
-
-
-# =============================================================================================== #
-#  The Embedded Document Search/Replace Feature
-#  Only used by DocEditor, and is at a fixed position in the QTextEdit's viewport
-# =============================================================================================== #
 
 class GuiDocEditSearch(QFrame):
+    """The Embedded Document Search/Replace Feature
+
+    Only used by DocEditor, and is at a fixed position in the
+    QTextEdit's viewport.
+    """
 
     def __init__(self, docEditor: GuiDocEditor) -> None:
         super().__init__(parent=docEditor)
@@ -2546,32 +2543,18 @@ class GuiDocEditSearch(QFrame):
     #  Getters
     ##
 
-    def getSearchObject(self) -> str | QRegularExpression | QRegExp:
+    def getSearchObject(self) -> str | QRegularExpression:
         """Return the current search text either as text or as a regular
         expression object.
         """
         text = self.searchBox.text()
         if CONFIG.searchRegEx:
-            # Using the Unicode-capable QRegularExpression class was
-            # only added in Qt 5.13. Otherwise, 5.3 and up supports
-            # only the QRegExp class.
-            if CONFIG.verQtValue >= 0x050d00:
-                rxOpt = QRegularExpression.PatternOption.UseUnicodePropertiesOption
-                if not CONFIG.searchCase:
-                    rxOpt |= QRegularExpression.PatternOption.CaseInsensitiveOption
-                regEx = QRegularExpression(text, rxOpt)
-                self._alertSearchValid(regEx.isValid())
-                return regEx
-            else:  # pragma: no cover
-                # >= 50300 to < 51300
-                if CONFIG.searchCase:
-                    rxOpt = Qt.CaseSensitivity.CaseSensitive
-                else:
-                    rxOpt = Qt.CaseSensitivity.CaseInsensitive
-                regEx = QRegExp(text, rxOpt)
-                self._alertSearchValid(regEx.isValid())
-                return regEx
-
+            rxOpt = QRegularExpression.PatternOption.UseUnicodePropertiesOption
+            if not CONFIG.searchCase:
+                rxOpt |= QRegularExpression.PatternOption.CaseInsensitiveOption
+            regEx = QRegularExpression(text, rxOpt)
+            self._alertSearchValid(regEx.isValid())
+            return regEx
         return text
 
     ##
@@ -2775,15 +2758,13 @@ class GuiDocEditSearch(QFrame):
         self.searchBox.setPalette(qPalette)
         return
 
-# END Class GuiDocEditSearch
-
-
-# =============================================================================================== #
-#  The Embedded Document Header
-#  Only used by DocEditor, and is at a fixed position in the QTextEdit's viewport
-# =============================================================================================== #
 
 class GuiDocEditHeader(QWidget):
+    """The Embedded Document Header
+
+    Only used by DocEditor, and is at a fixed position in the
+    QTextEdit's viewport.
+    """
 
     closeDocumentRequest = pyqtSignal()
     toggleToolBarRequest = pyqtSignal()
@@ -2806,8 +2787,7 @@ class GuiDocEditHeader(QWidget):
         self.setAutoFillBackground(True)
 
         # Title Label
-        self.itemTitle = QLabel("", self)
-        self.itemTitle.setIndent(0)
+        self.itemTitle = NColourLabel("", self, faded=SHARED.theme.fadedText)
         self.itemTitle.setMargin(0)
         self.itemTitle.setContentsMargins(0, 0, 0, 0)
         self.itemTitle.setAutoFillBackground(True)
@@ -2939,10 +2919,15 @@ class GuiDocEditHeader(QWidget):
         palette.setColor(QPalette.ColorRole.Window, SHARED.theme.colBack)
         palette.setColor(QPalette.ColorRole.WindowText, SHARED.theme.colText)
         palette.setColor(QPalette.ColorRole.Text, SHARED.theme.colText)
-
         self.setPalette(palette)
-        self.itemTitle.setPalette(palette)
+        self.itemTitle.setTextColors(
+            color=palette.windowText().color(), faded=SHARED.theme.fadedText
+        )
+        return
 
+    def changeFocusState(self, state: bool) -> None:
+        """Toggle focus state."""
+        self.itemTitle.setColorState(state)
         return
 
     def setHandle(self, tHandle: str) -> None:
@@ -3001,15 +2986,13 @@ class GuiDocEditHeader(QWidget):
             self.docEditor.requestProjectItemSelected.emit(self._docHandle or "", True)
         return
 
-# END Class GuiDocEditHeader
-
-
-# =============================================================================================== #
-#  The Embedded Document Footer
-#  Only used by DocEditor, and is at a fixed position in the QTextEdit's viewport
-# =============================================================================================== #
 
 class GuiDocEditFooter(QWidget):
+    """The Embedded Document Footer
+
+    Only used by DocEditor, and is at a fixed position in the
+    QTextEdit's viewport.
+    """
 
     def __init__(self, parent: QWidget) -> None:
         super().__init__(parent=parent)
@@ -3164,7 +3147,7 @@ class GuiDocEditFooter(QWidget):
             sText = ""
         else:
             iPx = round(0.9*SHARED.theme.baseIconHeight)
-            status, icon = self._tItem.getImportStatus(incIcon=True)
+            status, icon = self._tItem.getImportStatus()
             sIcon = icon.pixmap(iPx, iPx)
             sText = f"{status} / {self._tItem.describeMe()}"
 
@@ -3195,5 +3178,3 @@ class GuiDocEditFooter(QWidget):
             wText = self._trWordCount.format("0", "+0")
         self.wordsText.setText(wText)
         return
-
-# END Class GuiDocEditFooter