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

novelwriter/core/buildsettings.py

@@ -25,21 +25,21 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 from __future__ import annotations
 
 import json
-import uuid
 import logging
+import uuid
 
+from collections.abc import Iterable
 from enum import Enum
 from pathlib import Path
-from collections.abc import Iterable
 
 from PyQt5.QtCore import QT_TRANSLATE_NOOP, QCoreApplication
 
 from novelwriter import CONFIG
-from novelwriter.enum import nwBuildFmt
-from novelwriter.error import logException
 from novelwriter.common import checkUuid, isHandle, jsonEncode
 from novelwriter.constants import nwFiles, nwHeadFmt
 from novelwriter.core.project import NWProject
+from novelwriter.enum import nwBuildFmt
+from novelwriter.error import logException
 
 logger = logging.getLogger(__name__)
 
@@ -76,12 +76,16 @@ SETTINGS_TEMPLATE = {
     "text.includeBodyText":    (bool, True),
     "text.ignoredKeywords":    (str, ""),
     "text.addNoteHeadings":    (bool, True),
-    "format.textFont":         (str, CONFIG.textFont),
-    "format.textSize":         (int, 12),
+    "format.textFont":         (str, CONFIG.textFont.toString()),
     "format.lineHeight":       (float, 1.15, 0.75, 3.0),
     "format.justifyText":      (bool, False),
     "format.stripUnicode":     (bool, False),
     "format.replaceTabs":      (bool, False),
+    "format.keepBreaks":       (bool, True),
+    "format.showDialogue":     (bool, False),
+    "format.firstLineIndent":  (bool, False),
+    "format.firstIndentWidth": (float, 1.4),
+    "format.indentFirstPar":   (bool, False),
     "format.pageUnit":         (str, "cm"),
     "format.pageSize":         (str, "A4"),
     "format.pageWidth":        (float, 21.0),
@@ -93,65 +97,66 @@ SETTINGS_TEMPLATE = {
     "odt.addColours":          (bool, True),
     "odt.pageHeader":          (str, nwHeadFmt.ODT_AUTO),
     "odt.pageCountOffset":     (int, 0),
-    "odt.firstLineIndent":     (bool, False),
-    "md.preserveBreaks":       (bool, True),
     "html.addStyles":          (bool, True),
     "html.preserveTabs":       (bool, False),
 }
 
 SETTINGS_LABELS = {
-    "filter":                 QT_TRANSLATE_NOOP("Builds", "Document Filters"),
-    "filter.includeNovel":    QT_TRANSLATE_NOOP("Builds", "Novel Documents"),
-    "filter.includeNotes":    QT_TRANSLATE_NOOP("Builds", "Project Notes"),
-    "filter.includeInactive": QT_TRANSLATE_NOOP("Builds", "Inactive Documents"),
-
-    "headings":               QT_TRANSLATE_NOOP("Builds", "Headings"),
-    "headings.fmtTitle":      QT_TRANSLATE_NOOP("Builds", "Partition Format"),
-    "headings.fmtChapter":    QT_TRANSLATE_NOOP("Builds", "Chapter Format"),
-    "headings.fmtUnnumbered": QT_TRANSLATE_NOOP("Builds", "Unnumbered Format"),
-    "headings.fmtScene":      QT_TRANSLATE_NOOP("Builds", "Scene Format"),
-    "headings.fmtAltScene":   QT_TRANSLATE_NOOP("Builds", "Alt. Scene Format"),
-    "headings.fmtSection":    QT_TRANSLATE_NOOP("Builds", "Section Format"),
-
-    "text.grpContent":        QT_TRANSLATE_NOOP("Builds", "Text Content"),
-    "text.includeSynopsis":   QT_TRANSLATE_NOOP("Builds", "Include Synopsis"),
-    "text.includeComments":   QT_TRANSLATE_NOOP("Builds", "Include Comments"),
-    "text.includeKeywords":   QT_TRANSLATE_NOOP("Builds", "Include Keywords"),
-    "text.includeBodyText":   QT_TRANSLATE_NOOP("Builds", "Include Body Text"),
-    "text.ignoredKeywords":   QT_TRANSLATE_NOOP("Builds", "Ignore These Keywords"),
-    "text.grpInsert":         QT_TRANSLATE_NOOP("Builds", "Insert Content"),
-    "text.addNoteHeadings":   QT_TRANSLATE_NOOP("Builds", "Add Titles for Notes"),
-
-    "format.grpFormat":       QT_TRANSLATE_NOOP("Builds", "Text Format"),
-    "format.textFont":        QT_TRANSLATE_NOOP("Builds", "Font Family"),
-    "format.textSize":        QT_TRANSLATE_NOOP("Builds", "Font Size"),
-    "format.lineHeight":      QT_TRANSLATE_NOOP("Builds", "Line Height"),
-    "format.grpOptions":      QT_TRANSLATE_NOOP("Builds", "Text Options"),
-    "format.justifyText":     QT_TRANSLATE_NOOP("Builds", "Justify Text Margins"),
-    "format.stripUnicode":    QT_TRANSLATE_NOOP("Builds", "Replace Unicode Characters"),
-    "format.replaceTabs":     QT_TRANSLATE_NOOP("Builds", "Replace Tabs with Spaces"),
-    "format.grpPage":         QT_TRANSLATE_NOOP("Builds", "Page Layout"),
-    "format.pageUnit":        QT_TRANSLATE_NOOP("Builds", "Unit"),
-    "format.pageSize":        QT_TRANSLATE_NOOP("Builds", "Page Size"),
-    "format.pageWidth":       QT_TRANSLATE_NOOP("Builds", "Page Width"),
-    "format.pageHeight":      QT_TRANSLATE_NOOP("Builds", "Page Height"),
-    "format.topMargin":       QT_TRANSLATE_NOOP("Builds", "Top Margin"),
-    "format.bottomMargin":    QT_TRANSLATE_NOOP("Builds", "Bottom Margin"),
-    "format.leftMargin":      QT_TRANSLATE_NOOP("Builds", "Left Margin"),
-    "format.rightMargin":     QT_TRANSLATE_NOOP("Builds", "Right Margin"),
-
-    "odt":                    QT_TRANSLATE_NOOP("Builds", "Open Document (.odt)"),
-    "odt.addColours":         QT_TRANSLATE_NOOP("Builds", "Add Highlight Colours"),
-    "odt.pageHeader":         QT_TRANSLATE_NOOP("Builds", "Page Header"),
-    "odt.pageCountOffset":    QT_TRANSLATE_NOOP("Builds", "Page Counter Offset"),
-    "odt.firstLineIndent":    QT_TRANSLATE_NOOP("Builds", "First Line Indent"),
-
-    "md":                     QT_TRANSLATE_NOOP("Builds", "Markdown (.md)"),
-    "md.preserveBreaks":      QT_TRANSLATE_NOOP("Builds", "Preserve Hard Line Breaks"),
-
-    "html":                   QT_TRANSLATE_NOOP("Builds", "HTML (.html)"),
-    "html.addStyles":         QT_TRANSLATE_NOOP("Builds", "Add CSS Styles"),
-    "html.preserveTabs":      QT_TRANSLATE_NOOP("Builds", "Preserve Tab Characters"),
+    "filter":                  QT_TRANSLATE_NOOP("Builds", "Document Filters"),
+    "filter.includeNovel":     QT_TRANSLATE_NOOP("Builds", "Novel Documents"),
+    "filter.includeNotes":     QT_TRANSLATE_NOOP("Builds", "Project Notes"),
+    "filter.includeInactive":  QT_TRANSLATE_NOOP("Builds", "Inactive Documents"),
+
+    "headings":                QT_TRANSLATE_NOOP("Builds", "Headings"),
+    "headings.fmtTitle":       QT_TRANSLATE_NOOP("Builds", "Partition Format"),
+    "headings.fmtChapter":     QT_TRANSLATE_NOOP("Builds", "Chapter Format"),
+    "headings.fmtUnnumbered":  QT_TRANSLATE_NOOP("Builds", "Unnumbered Format"),
+    "headings.fmtScene":       QT_TRANSLATE_NOOP("Builds", "Scene Format"),
+    "headings.fmtAltScene":    QT_TRANSLATE_NOOP("Builds", "Alt. Scene Format"),
+    "headings.fmtSection":     QT_TRANSLATE_NOOP("Builds", "Section Format"),
+
+    "text.grpContent":         QT_TRANSLATE_NOOP("Builds", "Text Content"),
+    "text.includeSynopsis":    QT_TRANSLATE_NOOP("Builds", "Include Synopsis"),
+    "text.includeComments":    QT_TRANSLATE_NOOP("Builds", "Include Comments"),
+    "text.includeKeywords":    QT_TRANSLATE_NOOP("Builds", "Include Keywords"),
+    "text.includeBodyText":    QT_TRANSLATE_NOOP("Builds", "Include Body Text"),
+    "text.ignoredKeywords":    QT_TRANSLATE_NOOP("Builds", "Ignore These Keywords"),
+    "text.grpInsert":          QT_TRANSLATE_NOOP("Builds", "Insert Content"),
+    "text.addNoteHeadings":    QT_TRANSLATE_NOOP("Builds", "Add Titles for Notes"),
+
+    "format.grpFormat":        QT_TRANSLATE_NOOP("Builds", "Text Format"),
+    "format.textFont":         QT_TRANSLATE_NOOP("Builds", "Text Font"),
+    "format.lineHeight":       QT_TRANSLATE_NOOP("Builds", "Line Height"),
+    "format.grpOptions":       QT_TRANSLATE_NOOP("Builds", "Text Options"),
+    "format.justifyText":      QT_TRANSLATE_NOOP("Builds", "Justify Text Margins"),
+    "format.stripUnicode":     QT_TRANSLATE_NOOP("Builds", "Replace Unicode Characters"),
+    "format.replaceTabs":      QT_TRANSLATE_NOOP("Builds", "Replace Tabs with Spaces"),
+    "format.keepBreaks":       QT_TRANSLATE_NOOP("Builds", "Preserve Hard Line Breaks"),
+    "format.showDialogue":     QT_TRANSLATE_NOOP("Builds", "Apply Dialogue Highlighting"),
+
+    "format.grpParIndent":     QT_TRANSLATE_NOOP("Builds", "First Line Indent"),
+    "format.firstLineIndent":  QT_TRANSLATE_NOOP("Builds", "Enable Indent"),
+    "format.firstIndentWidth": QT_TRANSLATE_NOOP("Builds", "Indent Width"),
+    "format.indentFirstPar":   QT_TRANSLATE_NOOP("Builds", "Indent First Paragraph"),
+
+    "format.grpPage":          QT_TRANSLATE_NOOP("Builds", "Page Layout"),
+    "format.pageUnit":         QT_TRANSLATE_NOOP("Builds", "Unit"),
+    "format.pageSize":         QT_TRANSLATE_NOOP("Builds", "Page Size"),
+    "format.pageWidth":        QT_TRANSLATE_NOOP("Builds", "Page Width"),
+    "format.pageHeight":       QT_TRANSLATE_NOOP("Builds", "Page Height"),
+    "format.topMargin":        QT_TRANSLATE_NOOP("Builds", "Top Margin"),
+    "format.bottomMargin":     QT_TRANSLATE_NOOP("Builds", "Bottom Margin"),
+    "format.leftMargin":       QT_TRANSLATE_NOOP("Builds", "Left Margin"),
+    "format.rightMargin":      QT_TRANSLATE_NOOP("Builds", "Right Margin"),
+
+    "odt":                     QT_TRANSLATE_NOOP("Builds", "Open Document (.odt)"),
+    "odt.addColours":          QT_TRANSLATE_NOOP("Builds", "Add Highlight Colours"),
+    "odt.pageHeader":          QT_TRANSLATE_NOOP("Builds", "Page Header"),
+    "odt.pageCountOffset":     QT_TRANSLATE_NOOP("Builds", "Page Counter Offset"),
+
+    "html":                    QT_TRANSLATE_NOOP("Builds", "HTML (.html)"),
+    "html.addStyles":          QT_TRANSLATE_NOOP("Builds", "Add CSS Styles"),
+    "html.preserveTabs":       QT_TRANSLATE_NOOP("Builds", "Preserve Tab Characters"),
 }
 
 
@@ -165,8 +170,6 @@ class FilterMode(Enum):
     SKIPPED  = 4
     ROOT     = 5
 
-# END Enum FilterMode
-
 
 class BuildSettings:
     """Core: Build Settings Class
@@ -216,7 +219,7 @@ class BuildSettings:
         return self._order
 
     @property
-    def lastPath(self) -> Path:
+    def lastBuildPath(self) -> Path:
         """The last used build path."""
         if self._path.is_dir():
             return self._path
@@ -290,7 +293,7 @@ class BuildSettings:
             self._order = value
         return
 
-    def setLastPath(self, path: Path | str | None) -> None:
+    def setLastBuildPath(self, path: Path | str | None) -> None:
         """Set the last used build path."""
         if isinstance(path, str):
             path = Path(path)
@@ -458,7 +461,7 @@ class BuildSettings:
         self.setName(data.get("name", ""))
         self.setBuildID(data.get("uuid", ""))
         self.setOrder(data.get("order", 0))
-        self.setLastPath(data.get("path", None))
+        self.setLastBuildPath(data.get("path", None))
         self.setLastBuildName(data.get("build", ""))
 
         buildFmt = str(data.get("format", ""))
@@ -481,8 +484,6 @@ class BuildSettings:
 
         return
 
-# END Class BuildSettings
-
 
 class BuildCollection:
     """Core: Build Collection Class
@@ -630,5 +631,3 @@ class BuildCollection:
             return False
 
         return True
-
-# END Class BuildCollection

novelwriter/core/coretools.py

@@ -104,7 +104,7 @@ class DocMerger:
         docText = self._project.storage.getDocumentText(srcHandle).rstrip("\n")
         if addComment:
             docInfo = srcItem.describeMe()
-            docSt, _ = srcItem.getImportStatus(incIcon=False)
+            docSt, _ = srcItem.getImportStatus()
             cmtLine = f"% {cmtPrefix} {docInfo}: {srcItem.itemName} [{docSt}]\n\n"
             docText = cmtLine + docText
 
@@ -129,8 +129,6 @@ class DocMerger:
 
         return status
 
-# END Class DocMerger
-
 
 class DocSplitter:
     """Document tool for splitting a document into a set of new
@@ -257,8 +255,6 @@ class DocSplitter:
 
         return
 
-# END Class DocSplitter
-
 
 class DocDuplicator:
     """A class that will duplicate all documents and folders starting
@@ -297,8 +293,6 @@ class DocDuplicator:
                 nHandle = None
         return
 
-# END Class DocDuplicator
-
 
 class DocSearch:
 
@@ -354,7 +348,9 @@ class DocSearch:
             rxMatch = rxItt.next()
             pos = rxMatch.capturedStart()
             num = rxMatch.capturedLength()
-            context = text[pos:pos+100].partition("\n")[0]
+            lim = text[:pos].rfind("\n") + 1
+            cut = text[lim:pos].rfind(" ") + lim + 1
+            context = text[cut:cut+100].partition("\n")[0]
             if context:
                 results.append((pos, num, context))
                 count += 1
@@ -370,23 +366,11 @@ class DocSearch:
     def _buildPattern(self, search: str) -> str:
         """Build the search pattern string."""
         if self._escape:
-            if CONFIG.verQtValue >= 0x050f00:
-                search = QRegularExpression.escape(search)
-            else:
-                # For older Qt versions, we escape manually
-                escaped = ""
-                for c in search:
-                    if c.isalnum() or c == "_":
-                        escaped += c
-                    else:
-                        escaped += f"\\{c}"
-                search = escaped
+            search = QRegularExpression.escape(search)
         if self._words:
             search = f"(?:^|\\b){search}(?:$|\\b)"
         return search
 
-# END Class DocSearch
-
 
 class ProjectBuilder:
     """A class to build a new project from a set of user-defined
@@ -619,5 +603,3 @@ class ProjectBuilder:
             return False
 
         return True
-
-# END Class ProjectBuilder

novelwriter/core/docbuild.py

@@ -25,22 +25,23 @@ from __future__ import annotations
 
 import logging
 
-from pathlib import Path
 from collections.abc import Iterable
+from pathlib import Path
 
-from PyQt5.QtGui import QFont, QFontInfo
+from PyQt5.QtGui import QFont
 
 from novelwriter import CONFIG
-from novelwriter.enum import nwBuildFmt
-from novelwriter.error import formatException, logException
 from novelwriter.constants import nwLabels
+from novelwriter.core.buildsettings import BuildSettings
 from novelwriter.core.item import NWItem
-from novelwriter.core.tomd import ToMarkdown
-from novelwriter.core.toodt import ToOdt
-from novelwriter.core.tohtml import ToHtml
 from novelwriter.core.project import NWProject
+from novelwriter.core.tohtml import ToHtml
 from novelwriter.core.tokenizer import Tokenizer
-from novelwriter.core.buildsettings import BuildSettings
+from novelwriter.core.tomarkdown import ToMarkdown
+from novelwriter.core.toodt import ToOdt
+from novelwriter.core.toqdoc import TextDocumentTheme, ToQTextDocument
+from novelwriter.enum import nwBuildFmt
+from novelwriter.error import formatException, logException
 
 logger = logging.getLogger(__name__)
 
@@ -54,7 +55,7 @@ class NWBuildDocument:
 
     __slots__ = (
         "_project", "_build", "_queue", "_error", "_cache", "_count",
-        "_outline", "_preview"
+        "_outline",
     )
 
     def __init__(self, project: NWProject, build: BuildSettings) -> None:
@@ -65,7 +66,6 @@ class NWBuildDocument:
         self._cache = None
         self._count = False
         self._outline = False
-        self._preview = False
         return
 
     ##
@@ -99,15 +99,6 @@ class NWBuildDocument:
         self._outline = state
         return
 
-    def setPreviewMode(self, state: bool) -> None:
-        """Set the preview mode of the build. This also enables stats
-        count and outline mode.
-        """
-        self._preview = state
-        self._outline = state
-        self._count = state
-        return
-
     ##
     #  Special Methods
     ##
@@ -134,6 +125,32 @@ class NWBuildDocument:
                 self._queue.append(item.itemHandle)
         return
 
+    def iterBuildPreview(self, theme: TextDocumentTheme) -> Iterable[tuple[int, bool]]:
+        """Build a preview QTextDocument."""
+        makeObj = ToQTextDocument(self._project)
+        filtered = self._setupBuild(makeObj)
+
+        self._outline = True
+        self._count = True
+
+        font = QFont()
+        font.fromString(self._build.getStr("format.textFont"))
+
+        makeObj.initDocument(font, theme)
+        for i, tHandle in enumerate(self._queue):
+            self._error = None
+            if filtered.get(tHandle, (False, 0))[0]:
+                yield i, self._doBuild(makeObj, tHandle)
+            else:
+                yield i, False
+
+        makeObj.appendFootnotes()
+
+        self._error = None
+        self._cache = makeObj
+
+        return
+
     def iterBuild(self, path: Path, bFormat: nwBuildFmt) -> Iterable[tuple[int, bool]]:
         """Wrapper for builders based on format."""
         if bFormat in (nwBuildFmt.ODT, nwBuildFmt.FODT):
@@ -182,8 +199,6 @@ class NWBuildDocument:
         makeObj = ToHtml(self._project)
         filtered = self._setupBuild(makeObj)
 
-        makeObj.setPreview(self._preview)
-        makeObj.setLinkHeadings(self._preview)
         for i, tHandle in enumerate(self._queue):
             self._error = None
             if filtered.get(tHandle, (False, 0))[0]:
@@ -191,7 +206,9 @@ class NWBuildDocument:
             else:
                 yield i, False
 
-        if not (self._build.getBool("html.preserveTabs") or self._preview):
+        makeObj.appendFootnotes()
+
+        if not self._build.getBool("html.preserveTabs"):
             makeObj.replaceTabs()
 
         self._error = None
@@ -214,16 +231,10 @@ class NWBuildDocument:
         makeObj = ToMarkdown(self._project)
         filtered = self._setupBuild(makeObj)
 
-        if extendedMd:
-            makeObj.setExtendedMarkdown()
-        else:
-            makeObj.setStandardMarkdown()
-
+        makeObj.setExtendedMarkdown(extendedMd)
         if self._build.getBool("format.replaceTabs"):
             makeObj.replaceTabs(nSpaces=4, spaceChar=" ")
 
-        makeObj.setPreserveBreaks(self._build.getBool("md.preserveBreaks"))
-
         for i, tHandle in enumerate(self._queue):
             self._error = None
             if filtered.get(tHandle, (False, 0))[0]:
@@ -231,6 +242,8 @@ class NWBuildDocument:
             else:
                 yield i, False
 
+        makeObj.appendFootnotes()
+
         self._error = None
         self._cache = makeObj
 
@@ -281,13 +294,9 @@ class NWBuildDocument:
     def _setupBuild(self, bldObj: Tokenizer) -> dict:
         """Configure the build object."""
         # Get Settings
-        textFont = self._build.getStr("format.textFont")
-        textSize = self._build.getInt("format.textSize")
-
-        fontFamily = textFont or CONFIG.textFont
-        bldFont = QFont(fontFamily, textSize)
-        fontInfo = QFontInfo(bldFont)
-        textFixed = fontInfo.fixedPitch()
+        textFont = QFont(CONFIG.textFont)
+        textFont.fromString(self._build.getStr("format.textFont"))
+        bldObj.setFont(textFont)
 
         bldObj.setTitleFormat(
             self._build.getStr("headings.fmtTitle"),
@@ -326,9 +335,15 @@ class NWBuildDocument:
             self._build.getBool("headings.breakScene")
         )
 
-        bldObj.setFont(fontFamily, textSize, textFixed)
         bldObj.setJustify(self._build.getBool("format.justifyText"))
         bldObj.setLineHeight(self._build.getFloat("format.lineHeight"))
+        bldObj.setKeepLineBreaks(self._build.getBool("format.keepBreaks"))
+        bldObj.setDialogueHighlight(self._build.getBool("format.showDialogue"))
+        bldObj.setFirstLineIndent(
+            self._build.getBool("format.firstLineIndent"),
+            self._build.getFloat("format.firstIndentWidth"),
+            self._build.getBool("format.indentFirstPar"),
+        )
 
         bldObj.setBodyText(self._build.getBool("text.includeBodyText"))
         bldObj.setSynopsis(self._build.getBool("text.includeSynopsis"))
@@ -346,7 +361,6 @@ class NWBuildDocument:
             bldObj.setHeaderFormat(
                 self._build.getStr("odt.pageHeader"), self._build.getInt("odt.pageCountOffset")
             )
-            bldObj.setFirstLineIndent(self._build.getBool("odt.firstLineIndent"))
 
             scale = nwLabels.UNIT_SCALE.get(self._build.getStr("format.pageUnit"), 1.0)
             pW, pH = nwLabels.PAPER_SIZE.get(self._build.getStr("format.pageSize"), (-1.0, -1.0))
@@ -397,5 +411,3 @@ class NWBuildDocument:
                 return False
 
         return True
-
-# END Class NWBuildDocument

novelwriter/core/document.py

@@ -26,14 +26,14 @@ from __future__ import annotations
 import hashlib
 import logging
 
+from pathlib import Path
 from time import time
 from typing import TYPE_CHECKING
-from pathlib import Path
 
-from novelwriter.enum import nwItemLayout, nwItemClass
-from novelwriter.error import formatException, logException
 from novelwriter.common import formatTimeStamp, isHandle
 from novelwriter.core.item import NWItem
+from novelwriter.enum import nwItemClass, nwItemLayout
+from novelwriter.error import formatException, logException
 
 if TYPE_CHECKING:  # pragma: no cover
     from novelwriter.core.project import NWProject
@@ -359,5 +359,3 @@ class NWDocument:
             logger.debug("Unknown meta data: '%s'", metaLine.strip())
 
         return
-
-# END Class NWDocument