novelWriter 2.4.2__py3-none-any.whl → 2.5b1__py3-none-any.whl

novelwriter/config.py

@@ -24,24 +24,24 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-import sys
 import json
 import logging
+import sys
 
-from time import time
-from pathlib import Path
 from datetime import datetime
+from pathlib import Path
+from time import time
 
-from PyQt5.QtGui import QFontDatabase
 from PyQt5.QtCore import (
     PYQT_VERSION, PYQT_VERSION_STR, QT_VERSION, QT_VERSION_STR, QLibraryInfo,
     QLocale, QStandardPaths, QSysInfo, QTranslator
 )
+from PyQt5.QtGui import QFont, QFontDatabase
 from PyQt5.QtWidgets import QApplication
 
-from novelwriter.error import formatException, logException
-from novelwriter.common import NWConfigParser, checkInt, checkPath, formatTimeStamp
+from novelwriter.common import NWConfigParser, checkInt, checkPath, describeFont, formatTimeStamp
 from novelwriter.constants import nwFiles, nwUnicode
+from novelwriter.error import formatException, logException
 
 logger = logging.getLogger(__name__)
 
@@ -106,15 +106,15 @@ class Config:
         self._recentObj = RecentProjects(self)
 
         # General GUI Settings
-        self.guiLocale   = self._qLocale.name()
-        self.guiTheme    = "default"        # GUI theme
-        self.guiSyntax   = "default_light"  # Syntax theme
-        self.guiFont     = ""               # Defaults to system default font in theme class
-        self.guiFontSize = 11               # Is overridden if system default is loaded
-        self.guiScale    = 1.0              # Set automatically by Theme class
-        self.hideVScroll = False            # Hide vertical scroll bars on main widgets
-        self.hideHScroll = False            # Hide horizontal scroll bars on main widgets
-        self.lastNotes   = "0x0"            # The latest release notes that have been shown
+        self.guiLocale    = self._qLocale.name()
+        self.guiTheme     = "default"        # GUI theme
+        self.guiSyntax    = "default_light"  # Syntax theme
+        self.guiFont      = QFont()          # Main GUI font
+        self.guiScale     = 1.0              # Set automatically by Theme class
+        self.hideVScroll  = False            # Hide vertical scroll bars on main widgets
+        self.hideHScroll  = False            # Hide horizontal scroll bars on main widgets
+        self.lastNotes    = "0x0"            # The latest release notes that have been shown
+        self.nativeFont   = True             # Use native font dialog
 
         # Size Settings
         self._mainWinSize  = [1200, 650]     # Last size of the main GUI window
@@ -132,40 +132,42 @@ class Config:
         self.askBeforeBackup = True   # Flag for asking before running automatic backup
 
         # Text Editor Settings
-        self.textFont        = ""     # Editor font
-        self.textSize        = 12     # Editor font size
-        self.textWidth       = 700    # Editor text width
-        self.textMargin      = 40     # Editor/viewer text margin
-        self.tabWidth        = 40     # Editor tabulator width
-
-        self.focusWidth      = 800    # Focus Mode text width
-        self.hideFocusFooter = False  # Hide document footer in Focus Mode
-        self.showFullPath    = True   # Show full document path in editor header
-        self.autoSelect      = True   # Auto-select word when applying format with no selection
-
-        self.doJustify       = False  # Justify text
-        self.showTabsNSpaces = False  # Show tabs and spaces in editor
-        self.showLineEndings = False  # Show line endings in editor
-        self.showMultiSpaces = True   # Highlight multiple spaces in the text
-
-        self.doReplace       = True   # Enable auto-replace as you type
-        self.doReplaceSQuote = True   # Smart single quotes
-        self.doReplaceDQuote = True   # Smart double quotes
-        self.doReplaceDash   = True   # Replace multiple hyphens with dashes
-        self.doReplaceDots   = True   # Replace three dots with ellipsis
-
-        self.autoScroll      = False  # Typewriter-like scrolling
-        self.autoScrollPos   = 30     # Start point for typewriter-like scrolling
-        self.scrollPastEnd   = True   # Scroll past end of document, and centre cursor
-
-        self.highlightQuotes = True   # Highlight text in quotes
-        self.allowOpenSQuote = False  # Allow open-ended single quotes
-        self.allowOpenDQuote = True   # Allow open-ended double quotes
-        self.highlightEmph   = True   # Add colour to text emphasis
-
-        self.stopWhenIdle    = True   # Stop the status bar clock when the user is idle
-        self.userIdleTime    = 300    # Time of inactivity to consider user idle
-        self.incNotesWCount  = True   # The status bar word count includes notes
+        self.textFont        = QFont()  # Editor font
+        self.textWidth       = 700      # Editor text width
+        self.textMargin      = 40       # Editor/viewer text margin
+        self.tabWidth        = 40       # Editor tabulator width
+
+        self.focusWidth      = 800      # Focus Mode text width
+        self.hideFocusFooter = False    # Hide document footer in Focus Mode
+        self.showFullPath    = True     # Show full document path in editor header
+        self.autoSelect      = True     # Auto-select word when applying format with no selection
+
+        self.doJustify       = False    # Justify text
+        self.showTabsNSpaces = False    # Show tabs and spaces in editor
+        self.showLineEndings = False    # Show line endings in editor
+        self.showMultiSpaces = True     # Highlight multiple spaces in the text
+
+        self.doReplace       = True     # Enable auto-replace as you type
+        self.doReplaceSQuote = True     # Smart single quotes
+        self.doReplaceDQuote = True     # Smart double quotes
+        self.doReplaceDash   = True     # Replace multiple hyphens with dashes
+        self.doReplaceDots   = True     # Replace three dots with ellipsis
+
+        self.autoScroll      = False    # Typewriter-like scrolling
+        self.autoScrollPos   = 30       # Start point for typewriter-like scrolling
+        self.scrollPastEnd   = True     # Scroll past end of document, and centre cursor
+
+        self.dialogStyle     = 2        # Quote type to use for dialogue
+        self.allowOpenDial   = True     # Allow open-ended dialogue quotes
+        self.narratorBreak   = ""       # Symbol to use for narrator break
+        self.dialogLine      = ""       # Symbol to use for dialogue line
+        self.altDialogOpen   = ""       # Alternative dialog symbol, open
+        self.altDialogClose  = ""       # Alternative dialog symbol, close
+        self.highlightEmph   = True     # Add colour to text emphasis
+
+        self.stopWhenIdle    = True     # Stop the status bar clock when the user is idle
+        self.userIdleTime    = 300      # Time of inactivity to consider user idle
+        self.incNotesWCount  = True     # The status bar word count includes notes
 
         # User-Selected Symbol Settings
         self.fmtApostrophe   = nwUnicode.U_RSQUO
@@ -359,23 +361,53 @@ class Config:
         self._backupPath = checkPath(path, self._backPath)
         return
 
-    def setTextFont(self, family: str | None, pointSize: int = 12) -> None:
+    def setGuiFont(self, value: QFont | str | None) -> None:
+        """Update the GUI's font style from settings."""
+        if isinstance(value, QFont):
+            self.guiFont = value
+        elif value and isinstance(value, str):
+            self.guiFont = QFont()
+            self.guiFont.fromString(value)
+        else:
+            font = QFont()
+            fontDB = QFontDatabase()
+            if self.osWindows and "Arial" in fontDB.families():
+                # On Windows we default to Arial if possible
+                font.setFamily("Arial")
+                font.setPointSize(10)
+            else:
+                font = fontDB.systemFont(QFontDatabase.SystemFont.GeneralFont)
+            self.guiFont = font
+            logger.debug("GUI font set to: %s", describeFont(font))
+
+        QApplication.setFont(self.guiFont)
+
+        return
+
+    def setTextFont(self, value: QFont | str | None) -> None:
         """Set the text font if it exists. If it doesn't, or is None,
         set to default font.
         """
-        fontDB = QFontDatabase()
-        fontFam = fontDB.families()
-        self.textSize = pointSize
-        if family is None or family not in fontFam:
-            logger.warning("Unknown font '%s'", family)
+        if isinstance(value, QFont):
+            self.textFont = value
+        elif value and isinstance(value, str):
+            self.textFont = QFont()
+            self.textFont.fromString(value)
+        else:
+            fontDB = QFontDatabase()
+            fontFam = fontDB.families()
             if self.osWindows and "Arial" in fontFam:
-                self.textFont = "Arial"
+                font = QFont()
+                font.setFamily("Arial")
+                font.setPointSize(12)
             elif self.osDarwin and "Helvetica" in fontFam:
-                self.textFont = "Helvetica"
+                font = QFont()
+                font.setFamily("Helvetica")
+                font.setPointSize(12)
             else:
-                self.textFont = fontDB.systemFont(QFontDatabase.SystemFont.GeneralFont).family()
-        else:
-            self.textFont = family
+                font = fontDB.systemFont(QFontDatabase.SystemFont.GeneralFont)
+            self.textFont = font
+            logger.debug("Text font set to: %s", describeFont(font))
         return
 
     ##
@@ -499,12 +531,6 @@ class Config:
             (self._dataPath / "syntax").mkdir(exist_ok=True)
             (self._dataPath / "themes").mkdir(exist_ok=True)
 
-        # Check if config file exists, and load it. If not, we save defaults
-        if (self._confPath / nwFiles.CONF_FILE).is_file():
-            self.loadConfig()
-        else:
-            self.saveConfig()
-
         self._recentObj.loadCache()
         self._checkOptionalPackages()
 
@@ -545,6 +571,14 @@ class Config:
 
         conf = NWConfigParser()
         cnfPath = self._confPath / nwFiles.CONF_FILE
+
+        if not cnfPath.exists():
+            # Initial file, so we just create one from defaults
+            self.setGuiFont(None)
+            self.setTextFont(None)
+            self.saveConfig()
+            return True
+
         try:
             with open(cnfPath, mode="r", encoding="utf-8") as inFile:
                 conf.read_file(inFile)
@@ -558,14 +592,14 @@ class Config:
 
         # Main
         sec = "Main"
+        self.setGuiFont(conf.rdStr(sec, "font", ""))
         self.guiTheme    = conf.rdStr(sec, "theme", self.guiTheme)
         self.guiSyntax   = conf.rdStr(sec, "syntax", self.guiSyntax)
-        self.guiFont     = conf.rdStr(sec, "font", self.guiFont)
-        self.guiFontSize = conf.rdInt(sec, "fontsize", self.guiFontSize)
         self.guiLocale   = conf.rdStr(sec, "localisation", self.guiLocale)
         self.hideVScroll = conf.rdBool(sec, "hidevscroll", self.hideVScroll)
         self.hideHScroll = conf.rdBool(sec, "hidehscroll", self.hideHScroll)
         self.lastNotes   = conf.rdStr(sec, "lastnotes", self.lastNotes)
+        self.nativeFont  = conf.rdBool(sec, "nativefont", self.nativeFont)
         self._lastPath   = conf.rdPath(sec, "lastpath", self._lastPath)
 
         # Sizes
@@ -588,8 +622,7 @@ class Config:
 
         # Editor
         sec = "Editor"
-        self.textFont        = conf.rdStr(sec, "textfont", self.textFont)
-        self.textSize        = conf.rdInt(sec, "textsize", self.textSize)
+        self.setTextFont(conf.rdStr(sec, "textfont", ""))
         self.textWidth       = conf.rdInt(sec, "width", self.textWidth)
         self.textMargin      = conf.rdInt(sec, "margin", self.textMargin)
         self.tabWidth        = conf.rdInt(sec, "tabwidth", self.tabWidth)
@@ -618,9 +651,12 @@ class Config:
         self.showMultiSpaces = conf.rdBool(sec, "showmultispaces", self.showMultiSpaces)
         self.incNotesWCount  = conf.rdBool(sec, "incnoteswcount", self.incNotesWCount)
         self.showFullPath    = conf.rdBool(sec, "showfullpath", self.showFullPath)
-        self.highlightQuotes = conf.rdBool(sec, "highlightquotes", self.highlightQuotes)
-        self.allowOpenSQuote = conf.rdBool(sec, "allowopensquote", self.allowOpenSQuote)
-        self.allowOpenDQuote = conf.rdBool(sec, "allowopendquote", self.allowOpenDQuote)
+        self.dialogStyle     = conf.rdInt(sec, "dialogstyle", self.dialogStyle)
+        self.allowOpenDial   = conf.rdBool(sec, "allowopendial", self.allowOpenDial)
+        self.narratorBreak   = conf.rdStr(sec, "narratorbreak", self.narratorBreak)
+        self.altDialogOpen   = conf.rdStr(sec, "altdialogopen", self.altDialogOpen)
+        self.altDialogClose  = conf.rdStr(sec, "altdialogclose", self.altDialogClose)
+        self.dialogLine      = conf.rdStr(sec, "dialogline", self.dialogLine)
         self.highlightEmph   = conf.rdBool(sec, "highlightemph", self.highlightEmph)
         self.stopWhenIdle    = conf.rdBool(sec, "stopwhenidle", self.stopWhenIdle)
         self.userIdleTime    = conf.rdInt(sec, "useridletime", self.userIdleTime)
@@ -666,14 +702,14 @@ class Config:
         }
 
         conf["Main"] = {
+            "font":         self.guiFont.toString(),
             "theme":        str(self.guiTheme),
             "syntax":       str(self.guiSyntax),
-            "font":         str(self.guiFont),
-            "fontsize":     str(self.guiFontSize),
             "localisation": str(self.guiLocale),
             "hidevscroll":  str(self.hideVScroll),
             "hidehscroll":  str(self.hideHScroll),
             "lastnotes":    str(self.lastNotes),
+            "nativefont":   str(self.nativeFont),
             "lastpath":     str(self._lastPath),
         }
 
@@ -696,8 +732,7 @@ class Config:
         }
 
         conf["Editor"] = {
-            "textfont":        str(self.textFont),
-            "textsize":        str(self.textSize),
+            "textfont":        self.textFont.toString(),
             "width":           str(self.textWidth),
             "margin":          str(self.textMargin),
             "tabwidth":        str(self.tabWidth),
@@ -726,9 +761,12 @@ class Config:
             "showmultispaces": str(self.showMultiSpaces),
             "incnoteswcount":  str(self.incNotesWCount),
             "showfullpath":    str(self.showFullPath),
-            "highlightquotes": str(self.highlightQuotes),
-            "allowopensquote": str(self.allowOpenSQuote),
-            "allowopendquote": str(self.allowOpenDQuote),
+            "dialogstyle":     str(self.dialogStyle),
+            "allowopendial":   str(self.allowOpenDial),
+            "narratorbreak":   str(self.narratorBreak),
+            "altdialogopen":   str(self.altDialogOpen),
+            "altdialogclose":  str(self.altDialogClose),
+            "dialogline":      str(self.dialogLine),
             "highlightemph":   str(self.highlightEmph),
             "stopwhenidle":    str(self.stopWhenIdle),
             "useridletime":    str(self.userIdleTime),
@@ -787,8 +825,6 @@ class Config:
             logger.debug("Checking package 'pyenchant': OK")
         return
 
-# END Class Config
-
 
 class RecentProjects:
 
@@ -857,5 +893,3 @@ class RecentProjects:
             logger.debug("Removed recent: %s", path)
             self.saveCache()
         return
-
-# END Class RecentProjects

novelwriter/constants.py

@@ -23,9 +23,11 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtCore import QCoreApplication, QT_TRANSLATE_NOOP
+from PyQt5.QtCore import QT_TRANSLATE_NOOP, QCoreApplication
 
-from novelwriter.enum import nwBuildFmt, nwItemClass, nwItemLayout, nwOutline
+from novelwriter.enum import (
+    nwBuildFmt, nwComment, nwItemClass, nwItemLayout, nwOutline, nwStatusShape
+)
 
 
 def trConst(text: str) -> str:
@@ -58,8 +60,6 @@ class nwConst:
     # Dialogs
     DLG_FINISHED = 2
 
-# END Class nwConst
-
 
 class nwRegEx:
 
@@ -67,9 +67,7 @@ class nwRegEx:
     FMT_EB = r"(?<![\w\\])([\*]{2})(?![\s\*])(.+?)(?<![\s\\])(\1)(?!\w)"
     FMT_ST = r"(?<![\w\\])([~]{2})(?![\s~])(.+?)(?<![\s\\])(\1)(?!\w)"
     FMT_SC = r"(?i)(?<!\\)(\[[\/\!]?(?:i|b|s|u|m|sup|sub)\])"
-    FMT_SV = r"(?<!\\)(\[(?i)(?:fn|footnote):)(.+?)(?<!\\)(\])"
-
-# END Class nwRegEx
+    FMT_SV = r"(?<!\\)(\[(?i)(?:footnote):)(.+?)(?<!\\)(\])"
 
 
 class nwShortcode:
@@ -89,15 +87,19 @@ class nwShortcode:
     SUB_O    = "[sub]"
     SUB_C    = "[/sub]"
 
-# END Class nwShortcode
+    FOOTNOTE_B = "[footnote:"
+
+    COMMENT_STYLES = {
+        nwComment.FOOTNOTE: "[footnote:{0}]",
+        nwComment.COMMENT:  "[comment:{0}]",
+    }
 
 
 class nwHeaders:
 
     H_VALID = ("H0", "H1", "H2", "H3", "H4")
     H_LEVEL = {"H0": 0, "H1": 1, "H2": 2, "H3": 3, "H4": 4}
-
-# END Class nwHeaders
+    H_SIZES = {0: 2.50, 1: 2.00, 2: 1.75, 3: 1.50, 4: 1.25}
 
 
 class nwFiles:
@@ -118,8 +120,6 @@ class nwFiles:
     DICT_FILE   = "userdict.json"
     SESS_FILE   = "sessions.jsonl"
 
-# END Class nwFiles
-
 
 class nwKeyWords:
 
@@ -153,8 +153,6 @@ class nwKeyWords:
         CUSTOM_KEY: nwItemClass.CUSTOM,
     }
 
-# END Class nwKeyWords
-
 
 class nwLists:
 
@@ -168,8 +166,6 @@ class nwLists:
         nwItemClass.CUSTOM,
     ]
 
-# END Class nwLists
-
 
 class nwLabels:
 
@@ -268,6 +264,34 @@ class nwLabels:
         nwBuildFmt.J_HTML: ".json",
         nwBuildFmt.J_NWD:  ".json",
     }
+    SHAPES_PLAIN = {
+        nwStatusShape.SQUARE:   QT_TRANSLATE_NOOP("Constant", "Square"),
+        nwStatusShape.TRIANGLE: QT_TRANSLATE_NOOP("Constant", "Triangle"),
+        nwStatusShape.NABLA:    QT_TRANSLATE_NOOP("Constant", "Nabla"),
+        nwStatusShape.DIAMOND:  QT_TRANSLATE_NOOP("Constant", "Diamond"),
+        nwStatusShape.PENTAGON: QT_TRANSLATE_NOOP("Constant", "Pentagon"),
+        nwStatusShape.HEXAGON:  QT_TRANSLATE_NOOP("Constant", "Hexagon"),
+        nwStatusShape.STAR:     QT_TRANSLATE_NOOP("Constant", "Star"),
+        nwStatusShape.PACMAN:   QT_TRANSLATE_NOOP("Constant", "Pacman"),
+    }
+    SHAPES_CIRCLE = {
+        nwStatusShape.CIRCLE_Q: QT_TRANSLATE_NOOP("Constant", "1/4 Circle"),
+        nwStatusShape.CIRCLE_H: QT_TRANSLATE_NOOP("Constant", "Half Circle"),
+        nwStatusShape.CIRCLE_T: QT_TRANSLATE_NOOP("Constant", "3/4 Circle"),
+        nwStatusShape.CIRCLE:   QT_TRANSLATE_NOOP("Constant", "Full Circle"),
+    }
+    SHAPES_BARS = {
+        nwStatusShape.BARS_1: QT_TRANSLATE_NOOP("Constant", "1 Bar"),
+        nwStatusShape.BARS_2: QT_TRANSLATE_NOOP("Constant", "2 Bars"),
+        nwStatusShape.BARS_3: QT_TRANSLATE_NOOP("Constant", "3 Bars"),
+        nwStatusShape.BARS_4: QT_TRANSLATE_NOOP("Constant", "4 Bars"),
+    }
+    SHAPES_BLOCKS = {
+        nwStatusShape.BLOCK_1: QT_TRANSLATE_NOOP("Constant", "1 Block"),
+        nwStatusShape.BLOCK_2: QT_TRANSLATE_NOOP("Constant", "2 Blocks"),
+        nwStatusShape.BLOCK_3: QT_TRANSLATE_NOOP("Constant", "3 Blocks"),
+        nwStatusShape.BLOCK_4: QT_TRANSLATE_NOOP("Constant", "4 Blocks"),
+    }
     FILE_FILTERS = {
         "*.txt": QT_TRANSLATE_NOOP("Constant", "Text files"),
         "*.md":  QT_TRANSLATE_NOOP("Constant", "Markdown files"),
@@ -302,8 +326,6 @@ class nwLabels:
         "Custom": (-1.0, -1.0),
     }
 
-# END Class nwLabels
-
 
 class nwHeadFmt:
 
@@ -329,8 +351,6 @@ class nwHeadFmt:
     ODT_PAGE = "{Page}"
     ODT_AUTO = "{Project} / {Author} / {Page}"
 
-# END Class nwHeadFmt
-
 
 class nwQuotes:
     """Allowed quotation marks.
@@ -361,8 +381,6 @@ class nwQuotes:
         "\u300f": QT_TRANSLATE_NOOP("Constant", "Right white corner bracket"),
     }
 
-# END Class nwQuotes
-
 
 class nwUnicode:
     """Supported unicode character constants and their HTML equivalents."""
@@ -497,8 +515,6 @@ class nwUnicode:
     H_LTRI   = "&#9664;"
     H_LTRIS  = "&#9666;"
 
-# END Class nwUnicode
-
 
 class nwHtmlUnicode():
 
@@ -554,5 +570,3 @@ class nwHtmlUnicode():
         nwUnicode.U_TIMES:  nwUnicode.H_TIMES,
         nwUnicode.U_DIVIDE: nwUnicode.H_DIVIDE,
     }
-
-# END Class nwHtmlUnicode