novelWriter 2.2rc1__py3-none-any.whl → 2.3__py3-none-any.whl

novelwriter/gui/sidebar.py

@@ -3,10 +3,10 @@ novelWriter – GUI Main Window SideBar
 =====================================
 
 File History:
-Created: 2022-05-10 [2.0rc1]
+Created: 2022-05-10 [2.0rc1] GuiSideBar
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, 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
@@ -27,12 +27,13 @@ import logging
 
 from typing import TYPE_CHECKING
 
-from PyQt5.QtCore import QEvent, QPoint, Qt, QSize, pyqtSignal
 from PyQt5.QtGui import QPalette
+from PyQt5.QtCore import QEvent, QPoint, Qt, QSize, pyqtSignal
 from PyQt5.QtWidgets import QMenu, QToolButton, QVBoxLayout, QWidget
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.enum import nwView
+from novelwriter.extensions.eventfilters import StatusTipFilter
 
 if TYPE_CHECKING:  # pragma: no cover
     from novelwriter.guimain import GuiMain
@@ -54,6 +55,7 @@ class GuiSideBar(QWidget):
         iPx = CONFIG.pxInt(24)
         iconSize = QSize(iPx, iPx)
         self.setContentsMargins(0, 0, 0, 0)
+        self.installEventFilter(StatusTipFilter(mainGui))
 
         # Buttons
         self.tbProject = QToolButton(self)
@@ -77,9 +79,9 @@ class GuiSideBar(QWidget):
         self.tbBuild.clicked.connect(self.mainGui.showBuildManuscriptDialog)
 
         self.tbDetails = QToolButton(self)
-        self.tbDetails.setToolTip("{0} [Shift+F6]".format(self.tr("Project Details")))
+        self.tbDetails.setToolTip("{0} [Shift+F6]".format(self.tr("Novel Details")))
         self.tbDetails.setIconSize(iconSize)
-        self.tbDetails.clicked.connect(self.mainGui.showProjectDetailsDialog)
+        self.tbDetails.clicked.connect(self.mainGui.showNovelDetailsDialog)
 
         self.tbStats = QToolButton(self)
         self.tbStats.setToolTip("{0} [F6]".format(self.tr("Writing Statistics")))
@@ -162,11 +164,10 @@ class GuiSideBar(QWidget):
 
 class _PopRightMenu(QMenu):
 
-    def event(self, event: QEvent):
+    def event(self, event: QEvent) -> bool:
         """Overload the show event and move the menu popup location."""
         if event.type() == QEvent.Show:
-            parent = self.parent()
-            if isinstance(parent, QWidget):
+            if isinstance(parent := self.parent(), QWidget):
                 offset = QPoint(parent.width(), parent.height() - self.height())
                 self.move(parent.mapToGlobal(offset))
         return super(_PopRightMenu, self).event(event)

novelwriter/gui/statusbar.py

@@ -3,10 +3,10 @@ novelWriter – GUI Main Window Status Bar
 ========================================
 
 File History:
-Created: 2019-04-20 [0.0.1]
+Created: 2019-04-20 [0.0.1] GuiMainStatus
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, 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
@@ -27,9 +27,9 @@ import logging
 
 from time import time
 from typing import TYPE_CHECKING, Literal
+from datetime import datetime
 
 from PyQt5.QtCore import pyqtSlot, QLocale
-from PyQt5.QtGui import QColor
 from PyQt5.QtWidgets import qApp, QStatusBar, QLabel
 
 from novelwriter import CONFIG, SHARED
@@ -50,12 +50,13 @@ class GuiMainStatus(QStatusBar):
 
         logger.debug("Create: GuiMainStatus")
 
-        self._refTime  = -1.0
+        self._refTime = -1.0
         self._userIdle = False
+        self._debugInfo = False
 
-        colNone = QColor(*SHARED.theme.statNone)
-        colSaved = QColor(*SHARED.theme.statSaved)
-        colUnsaved = QColor(*SHARED.theme.statUnsaved)
+        colNone = SHARED.theme.statNone
+        colSaved = SHARED.theme.statSaved
+        colUnsaved = SHARED.theme.statUnsaved
 
         iPx = SHARED.theme.baseIconSize
 
@@ -223,4 +224,45 @@ class GuiMainStatus(QStatusBar):
         self.setDocumentStatus(StatusLED.S_BAD if status else StatusLED.S_GOOD)
         return
 
+    ##
+    #  Debug
+    ##
+
+    def memInfo(self) -> None:  # pragma: no cover
+        """Display memory info on the status bar. This is used to
+        investigate memory usage and Qt widgets that get left in memory.
+        Enabled by the --meminfo command line flag.
+
+        By default, this tracks memory usage diff after launch. To track
+        full memory usage, set environment variable PYTHONTRACEMALLOC=1
+        before starting novelWriter.
+        """
+        import tracemalloc
+        from collections import Counter
+
+        widgets = qApp.allWidgets()
+        if not self._debugInfo:
+            if tracemalloc.is_tracing():
+                self._traceMallocRef = "Total"
+            else:
+                self._traceMallocRef = "Relative"
+                tracemalloc.start()
+            self._debugInfo = True
+            self._wCounts = Counter([type(x).__name__ for x in widgets])
+
+        if hasattr(self, "_wCounts"):
+            diff = Counter([type(x).__name__ for x in widgets]) - self._wCounts
+            for name, count in diff.items():
+                logger.debug("Widget '%s': +%d", name, count)
+
+        mem = tracemalloc.get_traced_memory()
+        stamp = datetime.now().strftime("%H:%M:%S")
+        self.showMessage((
+            f"Debug [{stamp}]"
+            f" \u2013 Widgets: {len(widgets)}"
+            f" \u2013 {self._traceMallocRef} Memory: {mem[0]:n}"
+            f" \u2013 Peak: {mem[1]:n}"
+        ), 6000)
+        return
+
 # END Class GuiMainStatus

novelwriter/gui/theme.py

@@ -7,7 +7,7 @@ Created: 2019-05-18 [0.1.3] GuiTheme
 Created: 2019-11-08 [0.4]   GuiIcons
 
 This file is a part of novelWriter
-Copyright 2018–2023, Veronica Berglyd Olsen
+Copyright 2018–2024, 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
@@ -67,12 +67,13 @@ class GuiTheme:
         self.themeLicense     = ""
         self.themeLicenseUrl  = ""
         self.themeIcons       = ""
+        self.isLightTheme     = True
 
         # GUI
-        self.statNone    = [120, 120, 120]
-        self.statUnsaved = [200, 15, 39]
-        self.statSaved   = [2, 133, 37]
-        self.helpText    = [0, 0, 0]
+        self.statNone    = QColor(120, 120, 120)
+        self.statUnsaved = QColor(200, 15, 39)
+        self.statSaved   = QColor(2, 133, 37)
+        self.helpText    = QColor(0, 0, 0)
 
         # Loaded Syntax Settings
         # ======================
@@ -87,23 +88,24 @@ class GuiTheme:
         self.syntaxLicenseUrl  = ""
 
         # Colours
-        self.colBack   = [255, 255, 255]
-        self.colText   = [0, 0, 0]
-        self.colLink   = [0, 0, 0]
-        self.colHead   = [0, 0, 0]
-        self.colHeadH  = [0, 0, 0]
-        self.colEmph   = [0, 0, 0]
-        self.colDialN  = [0, 0, 0]
-        self.colDialD  = [0, 0, 0]
-        self.colDialS  = [0, 0, 0]
-        self.colHidden = [0, 0, 0]
-        self.colCode   = [0, 0, 0]
-        self.colKey    = [0, 0, 0]
-        self.colVal    = [0, 0, 0]
-        self.colSpell  = [0, 0, 0]
-        self.colError  = [0, 0, 0]
-        self.colRepTag = [0, 0, 0]
-        self.colMod    = [0, 0, 0]
+        self.colBack   = QColor(255, 255, 255)
+        self.colText   = QColor(0, 0, 0)
+        self.colLink   = QColor(0, 0, 0)
+        self.colHead   = QColor(0, 0, 0)
+        self.colHeadH  = QColor(0, 0, 0)
+        self.colEmph   = QColor(0, 0, 0)
+        self.colDialN  = QColor(0, 0, 0)
+        self.colDialD  = QColor(0, 0, 0)
+        self.colDialS  = QColor(0, 0, 0)
+        self.colHidden = QColor(0, 0, 0)
+        self.colCode   = QColor(0, 0, 0)
+        self.colKey    = QColor(0, 0, 0)
+        self.colVal    = QColor(0, 0, 0)
+        self.colOpt    = QColor(0, 0, 0)
+        self.colSpell  = QColor(0, 0, 0)
+        self.colError  = QColor(0, 0, 0)
+        self.colRepTag = QColor(0, 0, 0)
+        self.colMod    = QColor(0, 0, 0)
 
         # Class Setup
         # ===========
@@ -112,7 +114,7 @@ class GuiTheme:
         self._setGuiFont()
 
         # Load Themes
-        self._guiPalette  = QPalette()
+        self._guiPalette = QPalette()
         self._themeList: list[tuple[str, str]] = []
         self._syntaxList: list[tuple[str, str]] = []
         self._availThemes: dict[str, Path] = {}
@@ -254,13 +256,13 @@ class GuiTheme:
 
         backLNess = backCol.lightnessF()
         textLNess = textCol.lightnessF()
-
-        if self.helpText == [0, 0, 0]:
-            if backLNess > textLNess:
+        self.isLightTheme = backLNess > textLNess
+        if self.helpText == QColor(0, 0, 0):
+            if self.isLightTheme:
                 helpLCol = textLNess + 0.35*(backLNess - textLNess)
             else:
                 helpLCol = backLNess + 0.65*(textLNess - backLNess)
-            self.helpText = [int(255*helpLCol)]*3
+            self.helpText = QColor.fromHsl(0, 0, int(255*helpLCol))
 
         # Icons
         defaultIcons = "typicons_light" if backLNess >= 0.5 else "typicons_dark"
@@ -322,6 +324,7 @@ class GuiTheme:
             self.colCode   = self._parseColour(confParser, cnfSec, "shortcode")
             self.colKey    = self._parseColour(confParser, cnfSec, "keyword")
             self.colVal    = self._parseColour(confParser, cnfSec, "value")
+            self.colOpt    = self._parseColour(confParser, cnfSec, "optional")
             self.colSpell  = self._parseColour(confParser, cnfSec, "spellcheckline")
             self.colError  = self._parseColour(confParser, cnfSec, "errorline")
             self.colRepTag = self._parseColour(confParser, cnfSec, "replacetag")
@@ -341,7 +344,7 @@ class GuiTheme:
             if themeName:
                 self._themeList.append((themeKey, themeName))
 
-        self._themeList = sorted(self._themeList, key=lambda x: x[1])
+        self._themeList = sorted(self._themeList, key=_sortTheme)
 
         return self._themeList
 
@@ -357,7 +360,7 @@ class GuiTheme:
             if syntaxName:
                 self._syntaxList.append((syntaxKey, syntaxName))
 
-        self._syntaxList = sorted(self._syntaxList, key=lambda x: x[1])
+        self._syntaxList = sorted(self._syntaxList, key=_sortTheme)
 
         return self._syntaxList
 
@@ -367,22 +370,22 @@ class GuiTheme:
 
     def _setGuiFont(self) -> None:
         """Update the GUI's font style from settings."""
-        theFont = QFont()
+        font = QFont()
         fontDB = QFontDatabase()
         if CONFIG.guiFont not in fontDB.families():
             if CONFIG.osWindows and "Arial" in fontDB.families():
                 # On Windows we default to Arial if possible
-                theFont.setFamily("Arial")
-                theFont.setPointSize(10)
+                font.setFamily("Arial")
+                font.setPointSize(10)
             else:
-                theFont = fontDB.systemFont(QFontDatabase.GeneralFont)
-            CONFIG.guiFont = theFont.family()
-            CONFIG.guiFontSize = theFont.pointSize()
+                font = fontDB.systemFont(QFontDatabase.GeneralFont)
+            CONFIG.guiFont = font.family()
+            CONFIG.guiFontSize = font.pointSize()
         else:
-            theFont.setFamily(CONFIG.guiFont)
-            theFont.setPointSize(CONFIG.guiFontSize)
+            font.setFamily(CONFIG.guiFont)
+            font.setPointSize(CONFIG.guiFontSize)
 
-        qApp.setFont(theFont)
+        qApp.setFont(font)
 
         return
 
@@ -397,29 +400,14 @@ class GuiTheme:
 
         return True
 
-    def _parseColour(self, parser: NWConfigParser, section: str, name: str) -> list[int]:
+    def _parseColour(self, parser: NWConfigParser, section: str, name: str) -> QColor:
         """Parse a colour value from a config string."""
-        if parser.has_option(section, name):
-            values = parser.get(section, name).split(",")
-            result = []
-            try:
-                result.append(minmax(int(values[0]), 0, 255))
-                result.append(minmax(int(values[1]), 0, 255))
-                result.append(minmax(int(values[2]), 0, 255))
-            except Exception:
-                logger.error("Could not load theme colours for '%s' from config file", name)
-                result = [0, 0, 0]
-        else:
-            logger.warning("Could not find theme colours for '%s' in config file", name)
-            result = [0, 0, 0]
-        return result
+        return QColor(*parser.rdIntList(section, name, [0, 0, 0, 255]))
 
     def _setPalette(self, parser: NWConfigParser, section: str,
                     name: str, value: QPalette.ColorRole) -> None:
         """Set a palette colour value from a config string."""
-        self._guiPalette.setColor(
-            value, QColor(*self._parseColour(parser, section, name))
-        )
+        self._guiPalette.setColor(value, self._parseColour(parser, section, name))
         return
 
 # End Class GuiTheme
@@ -443,7 +431,7 @@ class GuiIcons:
     missing, a blank icon is returned and a warning issued.
     """
 
-    ICON_KEYS = {
+    ICON_KEYS: set[str] = {
         # Project and GUI Icons
         "novelwriter", "alert_error", "alert_info", "alert_question", "alert_warn",
         "build_excluded", "build_filtered", "build_included", "proj_chapter", "proj_details",
@@ -453,20 +441,21 @@ class GuiIcons:
 
         # Class Icons
         "cls_archive", "cls_character", "cls_custom", "cls_entity", "cls_none", "cls_novel",
-        "cls_object", "cls_plot", "cls_timeline", "cls_trash", "cls_world",
+        "cls_object", "cls_plot", "cls_template", "cls_timeline", "cls_trash", "cls_world",
 
         # Search Icons
         "search_cancel", "search_case", "search_loop", "search_preserve", "search_project",
         "search_regex", "search_word",
 
         # Format Icons
-        "fmt_bold", "fmt_italic", "fmt_mode-md", "fmt_mode-sc", "fmt_strike", "fmt_subscript",
-        "fmt_superscript", "fmt_underline",
+        "fmt_bold", "fmt_bold-md", "fmt_italic", "fmt_italic-md", "fmt_strike", "fmt_strike-md",
+        "fmt_subscript", "fmt_superscript", "fmt_underline",
 
         # General Button Icons
-        "add", "backward", "bookmark", "browse", "checked", "close", "cross", "down", "edit",
-        "export", "forward", "maximise", "menu", "minimise", "noncheckable", "panel", "refresh",
-        "remove", "revert", "search_replace", "search", "settings", "unchecked", "up", "view",
+        "add", "add_document", "backward", "bookmark", "browse", "checked", "close", "cross",
+        "document", "down", "edit", "export", "forward", "import", "list", "maximise", "menu",
+        "minimise", "more", "noncheckable", "open", "panel", "refresh", "remove", "revert",
+        "search_replace", "search", "settings", "star", "unchecked", "up", "view",
 
         # Switches
         "sticky-on", "sticky-off",
@@ -478,14 +467,14 @@ class GuiIcons:
         "deco_doc_nt_n",
     }
 
-    TOGGLE_ICON_KEYS = {
-        "sticky":   ("sticky-on", "sticky-off"),
-        "bullet":   ("bullet-on", "bullet-off"),
-        "fmt_mode": ("fmt_mode-sc", "fmt_mode-md"),
+    TOGGLE_ICON_KEYS: dict[str, tuple[str, str]] = {
+        "sticky": ("sticky-on", "sticky-off"),
+        "bullet": ("bullet-on", "bullet-off"),
     }
 
-    IMAGE_MAP = {
-        "wiz-back": "wizard-back.jpg",
+    IMAGE_MAP: dict[str, tuple[str, str]] = {
+        "welcome":  ("welcome-light.jpg", "welcome-dark.jpg"),
+        "nw-text":  ("novelwriter-text-light.svg", "novelwriter-text-dark.svg"),
     }
 
     def __init__(self, mainTheme: GuiTheme) -> None:
@@ -599,7 +588,8 @@ class GuiIcons:
         if name in self._themeMap:
             imgPath = self._themeMap[name]
         elif name in self.IMAGE_MAP:
-            imgPath = CONFIG.assetPath("images") / self.IMAGE_MAP[name]
+            idx = 0 if self.mainTheme.isLightTheme else 1
+            imgPath = CONFIG.assetPath("images") / self.IMAGE_MAP[name][idx]
         else:
             logger.error("Decoration with name '%s' does not exist", name)
             return QPixmap()
@@ -609,12 +599,13 @@ class GuiIcons:
             return QPixmap()
 
         pixmap = QPixmap(str(imgPath))
+        tMode = Qt.TransformationMode.SmoothTransformation
         if w is not None and h is not None:
-            return pixmap.scaled(w, h, Qt.IgnoreAspectRatio, Qt.SmoothTransformation)
+            return pixmap.scaled(w, h, Qt.AspectRatioMode.IgnoreAspectRatio, tMode)
         elif w is None and h is not None:
-            return pixmap.scaledToHeight(h, Qt.SmoothTransformation)
+            return pixmap.scaledToHeight(h, tMode)
         elif w is not None and h is None:
-            return pixmap.scaledToWidth(w, Qt.SmoothTransformation)
+            return pixmap.scaledToWidth(w, tMode)
 
         return pixmap
 
@@ -633,8 +624,8 @@ class GuiIcons:
             pOne  = self.getPixmap(self.TOGGLE_ICON_KEYS[name][0], size)
             pTwo = self.getPixmap(self.TOGGLE_ICON_KEYS[name][1], size)
             icon = QIcon()
-            icon.addPixmap(pOne, QIcon.Normal, QIcon.On)
-            icon.addPixmap(pTwo, QIcon.Normal, QIcon.Off)
+            icon.addPixmap(pOne, QIcon.Mode.Normal, QIcon.State.On)
+            icon.addPixmap(pTwo, QIcon.Mode.Normal, QIcon.State.Off)
             return icon
         return QIcon()
 
@@ -642,7 +633,7 @@ class GuiIcons:
         """Return an icon from the icon buffer as a QPixmap. If it
         doesn't exist, return an empty QPixmap.
         """
-        return self.getIcon(name).pixmap(size[0], size[1], QIcon.Normal)
+        return self.getIcon(name).pixmap(size[0], size[1], QIcon.Mode.Normal)
 
     def getItemIcon(self, tType: nwItemType, tClass: nwItemClass,
                     tLayout: nwItemLayout, hLevel: str = "H0") -> QIcon:
@@ -734,6 +725,13 @@ class GuiIcons:
 #  Module Functions
 # =============================================================================================== #
 
+
+def _sortTheme(data: tuple[str, str]) -> str:
+    """Key function for theme sorting."""
+    key, name = data
+    return f"*{name}" if key.startswith("default_") else name
+
+
 def _loadInternalName(confParser: NWConfigParser, confFile: str | Path) -> str:
     """Open a conf file and read the 'name' setting."""
     try: