Merge 2.8.1 into main (#2629)

Author: vkbo

CHANGELOG.md

@@ -1,5 +1,28 @@
 # novelWriter Changelog
 
+## Version 2.8.1 [2025-12-28]
+
+### Release Notes
+
+This is a patch release that fixes an issue where the application could crash due to a change in
+PyQt/Qt 6.10. The issue is related to certain input methods, and is at least triggered when using
+Spotlight on MacOS.
+
+### Detailed Changelog
+
+**Bugfixes**
+
+* Fix an issue where the inputMethodQuery call to the Qt library returns an object that PyQt6
+  cannot convert to a Python object. The fix just disables the conversion since the return value is
+  passed back to the Qt library anyway. The problem affects Qt/PyQt 6.10 and is triggered in MacOS
+  at least, but it is not known if it affects other platforms. Issue #2622. PR #2623.
+
+**Documentation**
+
+* Removed references to the old colour theme system in the documentation. Issue #2619. PR #2625.
+
+----
+
 ## Version 2.8 [2025-12-14]
 
 ### Release Notes

docs/source/conf.py

@@ -14,23 +14,25 @@
 project = "novelWriter"
 copyright = f"{datetime.date.today().year}"  # noqa: A001
 
-tmp_authors = ["Veronica Berglyd Olsen"]
-if additional := os.environ.get("SPHINX_I18N_AUTHORS"):
-    tmp_authors.extend(a.strip() for a in additional.split(","))
+if override_authors := os.environ.get("SPHINX_I18N_AUTHORS"):
+    author = override_authors
+else:
+    author = "Veronica Berglyd Olsen"
 
-author = ", ".join(tmp_authors)
-
-initFile = os.path.join(
-    os.path.dirname(__file__), os.pardir, os.pardir,
-    "novelwriter", "__init__.py"
-)
-with open(initFile, encoding="utf-8") as inFile:
-    for aLine in inFile:
-        if aLine.startswith("__version__"):
-            release = aLine.split('"')[1].strip()
-            break
-    else:
-        release = "unknown"
+if override_version := os.environ.get("SPHINX_I18N_VERSION"):
+    release = override_version
+else:
+    initFile = os.path.join(
+        os.path.dirname(__file__), os.pardir, os.pardir,
+        "novelwriter", "__init__.py"
+    )
+    with open(initFile, encoding="utf-8") as inFile:
+        for aLine in inFile:
+            if aLine.startswith("__version__"):
+                release = aLine.split('"')[1].strip()
+                break
+        else:
+            release = "unknown"
 
 version = release.partition("-")[0]
 
@@ -42,7 +44,7 @@
 needs_sphinx = "5.0"
 extensions = ["sphinx_design", "sphinx_copybutton"]
 templates_path = ["_templates"]
-source_suffix = ".rst"
+source_suffix = {".rst": "restructuredtext"}
 master_doc = "index"
 today_fmt = "%A, %d %B %Y at %H:%M"
 language = "en"
@@ -67,8 +69,8 @@
     "navigation_with_keys": True,
     "use_repository_button": True,
     "use_issues_button": True,
-    "pygment_light_style": "tango",
-    "pygment_dark_style": "dracula",
+    "pygments_light_style": "tango",
+    "pygments_dark_style": "dracula",
 }
 html_sidebars = {
     "**": ["navbar-logo", "sidebar-title", "sbt-sidebar-nav"],

docs/source/locales/authors_fr.conf

@@ -0,0 +1,3 @@
+[fr]
+version = "2.7"
+authors = ["Jean-Michel Heras", "Veronica Berglyd Olsen"]

docs/source/locales/config.toml

@@ -186,17 +186,11 @@ See :ref:`docs_features_shortcuts` for more details.
 Colour Themes
 =============
 
-By default, novelWriter uses a light colour theme. You can also choose between a standard dark
-theme that have neutral colours, or a series of other included themes, from **Preferences**. 
+By default, novelWriter should pick a dark or light theme based on the colour mode of your
+operating system. You can select which colour mode to use from the application sidebar.
+
+The default light and dark theme can be changed from **Preferences**. There are a number of themes
+to choose from. There are also some high contrast themes available.
 
 If you wish, you *can* create your own colour themes, and even have them added to the application.
 See :ref:`docs_more_custom_theme` for more details.
-
-Switching the GUI colour theme does not affect the colours of the editor and viewer. They have
-separate themes selectable from the "Document colour theme" setting in **Preferences**. They are
-separated because there are a lot more options to choose from for the editor and viewer.
-
-.. note::
-
-   If you switch between light and dark mode on the GUI, you should also switch editor theme to
-   match, otherwise icons may be hard to see in the editor and viewer.

docs/source/user_interface/main_window.rst

@@ -39,6 +39,7 @@
 from enum import Enum, IntFlag
 from time import time
 
+from PyQt6 import sip
 from PyQt6.QtCore import (
     QMimeData, QObject, QPoint, QRect, QRegularExpression, QRunnable, Qt,
     QTimer, QVariant, pyqtSignal, pyqtSlot
@@ -76,12 +77,13 @@
 from novelwriter.tools.lipsum import GuiLipsum
 from novelwriter.types import (
     QtAlignCenterTop, QtAlignJustify, QtAlignLeft, QtAlignLeftTop,
-    QtAlignRight, QtBlack, QtImCursorRectangle, QtKeepAnchor, QtModCtrl,
-    QtModNone, QtModShift, QtMouseLeft, QtMoveAnchor, QtMoveDown, QtMoveEnd,
-    QtMoveEndOfLine, QtMoveEndOfWord, QtMoveLeft, QtMoveNextChar,
-    QtMoveNextWord, QtMovePreviousWord, QtMoveRight, QtMoveStart,
-    QtMoveStartOfLine, QtMoveUp, QtScrollAlwaysOff, QtScrollAsNeeded,
-    QtSelectBlock, QtSelectDocument, QtSelectLine, QtSelectWord, QtTransparent
+    QtAlignRight, QtBlack, QtImCurrentSelection, QtImCursorRectangle,
+    QtKeepAnchor, QtModCtrl, QtModNone, QtModShift, QtMouseLeft, QtMoveAnchor,
+    QtMoveDown, QtMoveEnd, QtMoveEndOfLine, QtMoveEndOfWord, QtMoveLeft,
+    QtMoveNextChar, QtMoveNextWord, QtMovePreviousWord, QtMoveRight,
+    QtMoveStart, QtMoveStartOfLine, QtMoveUp, QtScrollAlwaysOff,
+    QtScrollAsNeeded, QtSelectBlock, QtSelectDocument, QtSelectLine,
+    QtSelectWord, QtTransparent
 )
 
 logger = logging.getLogger(__name__)
@@ -1070,6 +1072,12 @@ def inputMethodQuery(self, query: Qt.InputMethodQuery) -> QRect | QVariant:
             rect = self.cursorRect()
             rect.translate(vM.left(), vM.top())
             return rect
+        elif query == QtImCurrentSelection:
+            # See issue #2622
+            ac = sip.enableautoconversion(QVariant, False)  # type: ignore
+            variant = super().inputMethodQuery(query)
+            sip.enableautoconversion(QVariant, ac)  # type: ignore
+            return variant
         return super().inputMethodQuery(query)
 
     def insertFromMimeData(self, source: QMimeData | None) -> None:

novelwriter/gui/doceditor.py

@@ -131,6 +131,7 @@
 QtSelectDocument = QTextCursor.SelectionType.Document
 
 QtImCursorRectangle = Qt.InputMethodQuery.ImCursorRectangle
+QtImCurrentSelection = Qt.InputMethodQuery.ImCurrentSelection
 
 # Size Policy
 

novelwriter/types.py

@@ -24,7 +24,7 @@
 
 import pytest
 
-from PyQt6.QtCore import QEvent, QMimeData, QPointF, Qt, QThreadPool, QUrl
+from PyQt6.QtCore import QEvent, QMimeData, QPointF, QRect, Qt, QThreadPool, QUrl, QVariant
 from PyQt6.QtGui import (
     QAction, QClipboard, QDesktopServices, QDragEnterEvent, QDragMoveEvent,
     QDropEvent, QFont, QInputMethodEvent, QMouseEvent, QTextBlock, QTextCursor,
@@ -41,9 +41,9 @@
 from novelwriter.gui.dochighlight import TextBlockData
 from novelwriter.text.counting import standardCounter
 from novelwriter.types import (
-    QtAlignJustify, QtAlignLeft, QtKeepAnchor, QtModCtrl, QtModNone,
-    QtMouseLeft, QtMoveAnchor, QtMoveRight, QtScrollAlwaysOff,
-    QtScrollAsNeeded, QtSelectDocument, QtSelectWord
+    QtAlignJustify, QtAlignLeft, QtImCurrentSelection, QtImCursorRectangle,
+    QtKeepAnchor, QtModCtrl, QtModNone, QtMouseLeft, QtMoveAnchor, QtMoveRight,
+    QtScrollAlwaysOff, QtScrollAsNeeded, QtSelectDocument, QtSelectWord
 )
 
 from tests.mocked import causeOSError
@@ -2553,6 +2553,23 @@ def prep(text: str) -> tuple[str, QTextCursor]:
     assert doc.toRawText() == "Text «\u202f"
 
 
+@pytest.mark.gui
+def testGuiEditor_BigFixes(qtbot, nwGUI):
+    """Test specific bug fixes in the editor."""
+    docEditor = nwGUI.docEditor
+
+    # Cursor rectangle should take into account viewport margins (Issues #2267 and #2517)
+    vM = docEditor.viewportMargins()
+    cR = docEditor.inputMethodQuery(QtImCursorRectangle)
+    assert isinstance(cR, QRect)
+    assert cR.left() >= vM.left()
+    assert cR.top() >= vM.top()
+
+    # This one should simply not crash, and return a plain QVariant (Issue #2622)
+    cV = docEditor.inputMethodQuery(QtImCurrentSelection)
+    assert isinstance(cV, QVariant)
+
+
 @pytest.mark.gui
 def testGuiEditor_Vim_EnableVimMode(qtbot, nwGUI, projPath, mockRnd):
     """Test that enabling CONFIG.vimMode activates vim behavior."""

tests/test_gui/test_gui_doceditor.py

@@ -89,9 +89,9 @@ def makeDebianPackage(
     else:
         pkgVers = numVers
         if debianVersion < DEB_STABLE:
-            pkgDist = "oldstable"
+            pkgDist = "-oldstable"
         elif debianVersion > DEB_STABLE:
-            pkgDist = "testing"
+            pkgDist = "-testing"
     pkgVers = f"{pkgVers}+{buildName}" if buildName else pkgVers
 
     # Set Up Folder

utils/build_debian.py

@@ -24,6 +24,7 @@
 import os
 import shutil
 import subprocess
+import tomllib
 
 from utils.common import ROOT_DIR, systemCall
 
@@ -74,6 +75,7 @@ def buildHtmlDocs(args: argparse.Namespace | None = None) -> None:
     locsDir = ROOT_DIR / "docs" / "source" / "locales"
     locsDir.mkdir(exist_ok=True)
     bldRoot.mkdir(exist_ok=True, parents=True)
+    locConf = tomllib.loads((locsDir / "config.toml").read_text(encoding="utf-8"))
 
     lang = args.lang if args else ["all"]
     build = []
@@ -87,9 +89,10 @@ def buildHtmlDocs(args: argparse.Namespace | None = None) -> None:
         env = os.environ.copy()
         cmd = "make clean html"
         if code != "en":
-            data = (locsDir / f"authors_{code}.conf").read_text(encoding="utf-8")
-            authors = [x for x in data.splitlines() if x and not x.startswith("#")]
-            env["SPHINX_I18N_AUTHORS"] = ", ".join(authors)
+            if code not in locConf:
+                print(f"ERROR: No config for language code '{code}' in config.toml")
+            env["SPHINX_I18N_VERSION"] = locConf[code].get("version", "")
+            env["SPHINX_I18N_AUTHORS"] = ", ".join(locConf[code].get("authors", []))
             cmd += f" -e SPHINXOPTS=\"-D language='{code}'\""
 
         if (ex := subprocess.call(cmd, cwd=docsDir, env=env, shell=True)) == 0:
@@ -114,6 +117,7 @@ def buildPdfDocAssets(args: argparse.Namespace | None = None) -> None:
     locsDir = ROOT_DIR / "docs" / "source" / "locales"
     pdfFile = ROOT_DIR / "docs" / "build" / "latex" / "manual.pdf"
     locsDir.mkdir(exist_ok=True)
+    locConf = tomllib.loads((locsDir / "config.toml").read_text(encoding="utf-8"))
 
     lang = args.lang if args else ["all"]
     build = []
@@ -127,9 +131,10 @@ def buildPdfDocAssets(args: argparse.Namespace | None = None) -> None:
         cmd = "make clean latexpdf"
         name = "manual.pdf"
         if code != "en":
-            data = (locsDir / f"authors_{code}.conf").read_text(encoding="utf-8")
-            authors = [x for x in data.splitlines() if x and not x.startswith("#")]
-            env["SPHINX_I18N_AUTHORS"] = ", ".join(authors)
+            if code not in locConf:
+                print(f"ERROR: No config for language code '{code}' in config.toml")
+            env["SPHINX_I18N_VERSION"] = locConf[code].get("version", "")
+            env["SPHINX_I18N_AUTHORS"] = ", ".join(locConf[code].get("authors", []))
             cmd += f" -e SPHINXOPTS=\"-D language='{code}'\""
             name = f"manual_{code}.pdf"