novelWriter 2.3.1__py3-none-any.whl → 2.4b1__py3-none-any.whl

novelwriter/assets/syntax/tomorrow_night_blue.conf

@@ -45,3 +45,4 @@ spellcheckline = 255, 157, 164
 errorline      = 209, 241, 169
 replacetag     = 153, 255, 255
 modifier       = 255, 197, 143
+texthighlight  = 255, 238, 173, 96

novelwriter/assets/syntax/tomorrow_night_bright.conf

@@ -45,3 +45,4 @@ spellcheckline = 213,  78,  83
 errorline      = 185, 202,  74
 replacetag     = 112, 192, 177
 modifier       = 231, 140,  69
+texthighlight  = 231, 197,  71, 128

novelwriter/assets/syntax/tomorrow_night_eighties.conf

@@ -45,3 +45,4 @@ spellcheckline = 242, 119, 122
 errorline      = 153, 204, 153
 replacetag     = 102, 204, 204
 modifier       = 249, 145,  57
+texthighlight  = 255, 204, 102, 96

novelwriter/assets/text/credits_en.htm

@@ -8,9 +8,9 @@
 <h3>Contributors</h3>
 
 <p>
-  <b>Concept:</b> Marian Lückhof (<a href="https://github.com/Number042">@Number042</a>)<br>
-  <b>Internationalisation:</b> Bruno Meneguello (<a href="https://github.com/bkmeneguello">@bkmeneguello</a>)<br>
-  <b>Setup and Packaging:</b> Rachel Powers (<a href="https://github.com/Ryex">@Ryex</a>)
+&nbsp;&bull;&nbsp;<b>Concept:</b> Marian Lückhof (<a href="https://github.com/Number042">@Number042</a>)<br>
+&nbsp;&bull;&nbsp;<b>Internationalisation:</b> Bruno Meneguello (<a href="https://github.com/bkmeneguello">@bkmeneguello</a>)<br>
+&nbsp;&bull;&nbsp;<b>Setup and Packaging:</b> Rachel Powers (<a href="https://github.com/Ryex">@Ryex</a>)
 </p>
 <p>For other contributions, see the project's
 <a href="https://github.com/vkbo/novelWriter/graphs/contributors">Contributors</a> page.</p>
@@ -24,20 +24,20 @@
 <p>The default language is English (UK) with English (US) as an option. These are the original
 translators for the languages currently available:</p>
 <p>
-  <b>Dutch:</b> Martijn van der Kleijn (<a href="https://github.com/mvdkleijn">@mvdkleijn</a>)<br>
-  <b>French:</b> Jan Lüdke (<a href="https://github.com/jyhelle">@jyhelle</a>)<br>
-  <b>German:</b> Myian (<a href="https://github.com/heymyian">@heymyian</a>)<br>
-  <b>Italian:</b> Riccardo Mangili<br>
-  <b>Japanese:</b> hebekeg (<a href="https://github.com/hebekeg">@hebekeg</a>)<br>
-  <b>Latin American Spanish:</b> Tommy Marplatt (<a href="https://github.com/tmarplatt">@tmarplatt</a>)<br>
-  <b>Norwegian:</b> Veronica Berglyd Olsen (<a href="https://github.com/vkbo">@vkbo</a>)<br>
-  <b>Portuguese:</b> Bruno Meneguello (<a href="https://github.com/bkmeneguello">@bkmeneguello</a>)<br>
-  <b>Simplified Chinese:</b> Qianzhi Long (<a href="https://github.com/longqzh">@longqzh</a>)
+&nbsp;&bull;&nbsp;<b>Dutch:</b> Martijn van der Kleijn (<a href="https://github.com/mvdkleijn">@mvdkleijn</a>)<br>
+&nbsp;&bull;&nbsp;<b>French:</b> Jan Lüdke (<a href="https://github.com/jyhelle">@jyhelle</a>)<br>
+&nbsp;&bull;&nbsp;<b>German:</b> Myian (<a href="https://github.com/heymyian">@heymyian</a>)<br>
+&nbsp;&bull;&nbsp;<b>Italian:</b> Riccardo Mangili<br>
+&nbsp;&bull;&nbsp;<b>Japanese:</b> hebekeg (<a href="https://github.com/hebekeg">@hebekeg</a>)<br>
+&nbsp;&bull;&nbsp;<b>Latin American Spanish:</b> Tommy Marplatt (<a href="https://github.com/tmarplatt">@tmarplatt</a>)<br>
+&nbsp;&bull;&nbsp;<b>Norwegian:</b> Veronica Berglyd Olsen (<a href="https://github.com/vkbo">@vkbo</a>)<br>
+&nbsp;&bull;&nbsp;<b>Portuguese:</b> Bruno Meneguello (<a href="https://github.com/bkmeneguello">@bkmeneguello</a>)<br>
+&nbsp;&bull;&nbsp;<b>Simplified Chinese:</b> Qianzhi Long (<a href="https://github.com/longqzh">@longqzh</a>)
 </p>
 
 <p>Additional larger translation contributions:</p>
 <p>
-  <b>French:</b> Albert Aribaud (<a href="https://github.com/aaribaud">@aaribaud</a>)
+&nbsp;&bull;&nbsp;<b>French:</b> Albert Aribaud (<a href="https://github.com/aaribaud">@aaribaud</a>)
 </p>
 
 <p>Translations are managed on <a href="https://crowdin.com/project/novelwriter">Crowdin</a>, and
@@ -47,27 +47,29 @@ more contributions are listed on the project's <a href="https://crowdin.com/proj
 
 <p>The following libraries are dependencies of novelWriter:</p>
 <p>
-  <a href="https://www.qt.io">Qt5</a> by Qt Company<br>
-  <a href="https://www.riverbankcomputing.com/software/pyqt">PyQt5</a> by Riverbank Computing<br>
-  <a href="https://abiword.github.io/enchant">Enchant</a> by Dom Lachowicz<br>
-  <a href="https://pyenchant.github.io/pyenchant">PyEnchant</a> by Dimitri Merejkowsky
+&nbsp;&bull;&nbsp;<a href="https://www.qt.io">Qt5</a> by Qt Company<br>
+&nbsp;&bull;&nbsp;<a href="https://www.riverbankcomputing.com/software/pyqt">PyQt5</a> by Riverbank Computing<br>
+&nbsp;&bull;&nbsp;<a href="https://abiword.github.io/enchant">Enchant</a> by Dom Lachowicz<br>
+&nbsp;&bull;&nbsp;<a href="https://pyenchant.github.io/pyenchant">PyEnchant</a> by Dimitri Merejkowsky
 </p>
 
 <h3>Assets</h3>
 
 <p>Some of the assets bundled with novelWriter were adapted from the following sources:</p>
 <p>
-  <a href="https://github.com/stephenhutchings/typicons.font">Typicons</a> icons by Stephen Hutchings (CC BY-SA 4.0)<br>
-  <a href="https://github.com/chriskempson/base16">Tomorrow</a> syntax themes by Chris Kempson (MIT License)<br>
-  <a href="https://github.com/sdras/night-owl-vscode-theme">Owl</a> syntax themes by Sarah Drasner (MIT License)<br>
-  <a href="https://github.com/altercation/solarized">Solarized</a> themes by Ethan Schoonover (MIT License)
+&nbsp;&bull;&nbsp;<a href="https://github.com/stephenhutchings/typicons.font">Typicons</a> icons by Stephen Hutchings (CC BY-SA 4.0)<br>
+&nbsp;&bull;&nbsp;<a href="https://github.com/chriskempson/base16">Tomorrow</a> syntax themes by Chris Kempson (MIT License)<br>
+&nbsp;&bull;&nbsp;<a href="https://github.com/sdras/night-owl-vscode-theme">Owl</a> syntax themes by Sarah Drasner (MIT License)<br>
+&nbsp;&bull;&nbsp;<a href="https://github.com/altercation/solarized">Solarized</a> themes by Ethan Schoonover (MIT License)
 </p>
 
 <h3>Fonts</h3>
 
-<p>The font used for the main novelWriter logo, mimetype and text banners is:</p>
+<p>The font used for the main novelWriter logo, mimetype and text banners is Pridi. Other fonts are
+used on buttons and icons.</p>
 <p>
-  Pridi by Cadson Demak (Open Font License, Version 1.1)
+&nbsp;&bull;&nbsp;Pridi by Cadson Demak (Open Font License, Version 1.1)<br>
+&nbsp;&bull;&nbsp;Source Sans Pro by Paul D. Hunt (SIL Open Font License)
 </p>
 
 <h3>Special Mentions</h3>

novelwriter/common.py

@@ -255,7 +255,7 @@ def formatFileFilter(extensions: list[str | tuple[str, str]]) -> str:
     result = []
     for ext in extensions:
         if isinstance(ext, str):
-            result.append(f"{trConst(nwLabels.FILE_FILTERS.get(ext))} ({ext})")
+            result.append(f"{trConst(nwLabels.FILE_FILTERS.get(ext, 'ERR'))} ({ext})")
         elif isinstance(ext, tuple) and len(ext) == 2:
             result.append(f"{ext[0]} ({ext[1]})")
     return ";;".join(result)

novelwriter/config.py

@@ -30,6 +30,7 @@ import logging
 
 from time import time
 from pathlib import Path
+from datetime import datetime
 
 from PyQt5.QtGui import QFontDatabase
 from PyQt5.QtCore import (
@@ -84,8 +85,11 @@ class Config:
         self._nwLangPath = self._appPath / "assets" / "i18n"
         self._qtLangPath = QLibraryInfo.location(QLibraryInfo.TranslationsPath)
 
-        wantedLocale = self._nwLangPath / f"nw_{QLocale.system().name()}.qm"
-        self._qLocale = QLocale.system() if wantedLocale.exists() else QLocale("en_GB")
+        hasLocale = (self._nwLangPath / f"nw_{QLocale.system().name()}.qm").exists()
+        self._qLocale = QLocale.system() if hasLocale else QLocale("en_GB")
+        self._dLocale = QLocale.system()
+        self._dShortDate = self._dLocale.dateFormat(QLocale.FormatType.ShortFormat)
+        self._dShortDateTime = self._dLocale.dateTimeFormat(QLocale.FormatType.ShortFormat)
         self._qtTrans = {}
 
         # PDF Manual
@@ -179,17 +183,19 @@ class Config:
         # State
         self.showViewerPanel = True   # The panel for the viewer is visible
         self.showEditToolBar = False  # The document editor toolbar visibility
-        self.useShortcodes   = False  # Use shortcodes for basic formatting
         self.viewComments    = True   # Comments are shown in the viewer
         self.viewSynopsis    = True   # Synopsis is shown in the viewer
 
-        # Search Bar Switches
-        self.searchCase     = False
-        self.searchWord     = False
-        self.searchRegEx    = False
-        self.searchLoop     = False
-        self.searchNextFile = False
-        self.searchMatchCap = False
+        # Search Box States
+        self.searchCase      = False
+        self.searchWord      = False
+        self.searchRegEx     = False
+        self.searchLoop      = False
+        self.searchNextFile  = False
+        self.searchMatchCap  = False
+        self.searchProjCase  = False
+        self.searchProjWord  = False
+        self.searchProjRegEx = False
 
         # System and App Information
         # ==========================
@@ -414,6 +420,14 @@ class Config:
         self._errData = []
         return message
 
+    def localDate(self, value: datetime) -> str:
+        """Return a localised date format."""
+        return self._dLocale.toString(value, self._dShortDate)
+
+    def localDateTime(self, value: datetime) -> str:
+        """Return a localised datetime format."""
+        return self._dLocale.toString(value, self._dShortDateTime)
+
     def listLanguages(self, lngSet: int) -> list[tuple[str, str]]:
         """List localisation files in the i18n folder. The default GUI
         language is British English (en_GB).
@@ -496,6 +510,11 @@ class Config:
         QLocale.setDefault(self._qLocale)
         self._qtTrans = {}
 
+        hasLocale = (self._nwLangPath / f"nw_{self._qLocale.name()}.qm").exists()
+        self._dLocale = self._qLocale if hasLocale else QLocale.system()
+        self._dShortDate = self._dLocale.dateFormat(QLocale.FormatType.ShortFormat)
+        self._dShortDateTime = self._dLocale.dateTimeFormat(QLocale.FormatType.ShortFormat)
+
         langList = [
             (self._qtLangPath, "qtbase"),   # Qt 5.x
             (str(self._nwLangPath), "nw"),  # novelWriter
@@ -602,7 +621,6 @@ class Config:
         sec = "State"
         self.showViewerPanel = conf.rdBool(sec, "showviewerpanel", self.showViewerPanel)
         self.showEditToolBar = conf.rdBool(sec, "showedittoolbar", self.showEditToolBar)
-        self.useShortcodes   = conf.rdBool(sec, "useshortcodes", self.useShortcodes)
         self.viewComments    = conf.rdBool(sec, "viewcomments", self.viewComments)
         self.viewSynopsis    = conf.rdBool(sec, "viewsynopsis", self.viewSynopsis)
         self.searchCase      = conf.rdBool(sec, "searchcase", self.searchCase)
@@ -611,6 +629,9 @@ class Config:
         self.searchLoop      = conf.rdBool(sec, "searchloop", self.searchLoop)
         self.searchNextFile  = conf.rdBool(sec, "searchnextfile", self.searchNextFile)
         self.searchMatchCap  = conf.rdBool(sec, "searchmatchcap", self.searchMatchCap)
+        self.searchProjCase  = conf.rdBool(sec, "searchprojcase", self.searchProjCase)
+        self.searchProjWord  = conf.rdBool(sec, "searchprojword", self.searchProjWord)
+        self.searchProjRegEx = conf.rdBool(sec, "searchprojregex", self.searchProjRegEx)
 
         # Check Values
         # ============
@@ -708,7 +729,6 @@ class Config:
         conf["State"] = {
             "showviewerpanel": str(self.showViewerPanel),
             "showedittoolbar": str(self.showEditToolBar),
-            "useshortcodes":   str(self.useShortcodes),
             "viewcomments":    str(self.viewComments),
             "viewsynopsis":    str(self.viewSynopsis),
             "searchcase":      str(self.searchCase),
@@ -717,6 +737,9 @@ class Config:
             "searchloop":      str(self.searchLoop),
             "searchnextfile":  str(self.searchNextFile),
             "searchmatchcap":  str(self.searchMatchCap),
+            "searchprojcase":  str(self.searchProjCase),
+            "searchprojword":  str(self.searchProjWord),
+            "searchprojregex": str(self.searchProjRegEx),
         }
 
         # Write config file

novelwriter/constants.py

@@ -23,8 +23,6 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-import re
-
 from PyQt5.QtCore import QCoreApplication, QT_TRANSLATE_NOOP
 
 from novelwriter.enum import nwBuildFmt, nwItemClass, nwItemLayout, nwOutline
@@ -55,6 +53,7 @@ class nwConst:
 
     # Gui Settings
     STATUS_MSG_TIMEOUT = 15000  # milliseconds
+    MAX_SEARCH_RESULT = 1000
 
     # Dialogs
     DLG_FINISHED = 2
@@ -67,12 +66,9 @@ class nwRegEx:
     FMT_EI = r"(?<![\w\\])(_)(?![\s_])(.+?)(?<![\s\\])(\1)(?!\w)"
     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|sup|sub)\])"
+    FMT_SC = r"(?i)(?<!\\)(\[[\/\!]?(?:i|b|s|u|m|sup|sub)\])"
     FMT_SV = r"(?<!\\)(\[(?i)(?:fn|footnote):)(.+?)(?<!\\)(\])"
 
-    # Pre-Compiled RegEx
-    RX_SC = re.compile(FMT_SC)
-
 # END Class nwRegEx
 
 
@@ -86,6 +82,8 @@ class nwShortcode:
     STRIKE_C = "[/s]"
     ULINE_O  = "[u]"
     ULINE_C  = "[/u]"
+    MARK_O   = "[m]"
+    MARK_C   = "[/m]"
     SUP_O    = "[sup]"
     SUP_C    = "[/sup]"
     SUB_O    = "[sub]"
@@ -408,6 +406,7 @@ class nwUnicode:
     U_THNBSP = "\u202f"  # Thin non-breaking space
     U_ENSP   = "\u2002"  # Short (en) space
     U_EMSP   = "\u2003"  # Long (em) space
+    U_MMSP   = "\u205f"  # Medium mathematical space
     U_LSEP   = "\u2028"  # Line separator
     U_PSEP   = "\u2029"  # Paragraph separator
 

novelwriter/core/buildsettings.py

@@ -49,39 +49,54 @@ logger = logging.getLogger(__name__)
 # (type, default, [min value, max value])
 
 SETTINGS_TEMPLATE = {
-    "filter.includeNovel":    (bool, True),
-    "filter.includeNotes":    (bool, False),
-    "filter.includeInactive": (bool, False),
-    "headings.fmtTitle":      (str, nwHeadFmt.TITLE),
-    "headings.fmtChapter":    (str, nwHeadFmt.TITLE),
-    "headings.fmtUnnumbered": (str, nwHeadFmt.TITLE),
-    "headings.fmtScene":      (str, "* * *"),
-    "headings.fmtSection":    (str, ""),
-    "headings.hideScene":     (bool, False),
-    "headings.hideSection":   (bool, True),
-    "text.includeSynopsis":   (bool, False),
-    "text.includeComments":   (bool, False),
-    "text.includeKeywords":   (bool, False),
-    "text.includeBodyText":   (bool, True),
-    "text.addNoteHeadings":   (bool, True),
-    "format.textFont":        (str, CONFIG.textFont),
-    "format.textSize":        (int, 12),
-    "format.lineHeight":      (float, 1.15, 0.75, 3.0),
-    "format.justifyText":     (bool, False),
-    "format.stripUnicode":    (bool, False),
-    "format.replaceTabs":     (bool, False),
-    "format.pageUnit":        (str, "cm"),
-    "format.pageSize":        (str, "A4"),
-    "format.pageWidth":       (float, 21.0),
-    "format.pageHeight":      (float, 29.7),
-    "format.topMargin":       (float, 2.0),
-    "format.bottomMargin":    (float, 2.0),
-    "format.leftMargin":      (float, 2.0),
-    "format.rightMargin":     (float, 2.0),
-    "odt.addColours":         (bool, True),
-    "odt.pageHeader":         (str, nwHeadFmt.ODT_AUTO),
-    "odt.pageCountOffset":    (int, 0),
-    "html.addStyles":         (bool, True),
+    "filter.includeNovel":     (bool, True),
+    "filter.includeNotes":     (bool, False),
+    "filter.includeInactive":  (bool, False),
+    "headings.fmtTitle":       (str, nwHeadFmt.TITLE),
+    "headings.fmtChapter":     (str, nwHeadFmt.TITLE),
+    "headings.fmtUnnumbered":  (str, nwHeadFmt.TITLE),
+    "headings.fmtScene":       (str, "* * *"),
+    "headings.fmtHardScene":   (str, ""),
+    "headings.fmtSection":     (str, ""),
+    "headings.hideTitle":      (bool, False),
+    "headings.hideChapter":    (bool, False),
+    "headings.hideUnnumbered": (bool, False),
+    "headings.hideScene":      (bool, False),
+    "headings.hideHardScene":  (bool, False),
+    "headings.hideSection":    (bool, True),
+    "headings.centerTitle":    (bool, True),
+    "headings.centerChapter":  (bool, False),
+    "headings.centerScene":    (bool, False),
+    "headings.breakTitle":     (bool, True),
+    "headings.breakChapter":   (bool, True),
+    "headings.breakScene":     (bool, False),
+    "text.includeSynopsis":    (bool, False),
+    "text.includeComments":    (bool, False),
+    "text.includeKeywords":    (bool, False),
+    "text.includeBodyText":    (bool, True),
+    "text.ignoredKeywords":    (str, ""),
+    "text.addNoteHeadings":    (bool, True),
+    "format.textFont":         (str, CONFIG.textFont),
+    "format.textSize":         (int, 12),
+    "format.lineHeight":       (float, 1.15, 0.75, 3.0),
+    "format.justifyText":      (bool, False),
+    "format.stripUnicode":     (bool, False),
+    "format.replaceTabs":      (bool, False),
+    "format.pageUnit":         (str, "cm"),
+    "format.pageSize":         (str, "A4"),
+    "format.pageWidth":        (float, 21.0),
+    "format.pageHeight":       (float, 29.7),
+    "format.topMargin":        (float, 2.0),
+    "format.bottomMargin":     (float, 2.0),
+    "format.leftMargin":       (float, 2.0),
+    "format.rightMargin":      (float, 2.0),
+    "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 = {
@@ -91,19 +106,19 @@ SETTINGS_LABELS = {
     "filter.includeInactive": QT_TRANSLATE_NOOP("Builds", "Inactive Documents"),
 
     "headings":               QT_TRANSLATE_NOOP("Builds", "Headings"),
-    "headings.fmtTitle":      QT_TRANSLATE_NOOP("Builds", "Title Headings"),
-    "headings.fmtChapter":    QT_TRANSLATE_NOOP("Builds", "Chapter Headings"),
-    "headings.fmtUnnumbered": QT_TRANSLATE_NOOP("Builds", "Unnumbered Headings"),
-    "headings.fmtScene":      QT_TRANSLATE_NOOP("Builds", "Scene Headings"),
-    "headings.fmtSection":    QT_TRANSLATE_NOOP("Builds", "Section Headings"),
-    "headings.hideScene":     QT_TRANSLATE_NOOP("Builds", "Hide Scene Headings"),
-    "headings.hideSection":   QT_TRANSLATE_NOOP("Builds", "Hide Section 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.fmtHardScene":  QT_TRANSLATE_NOOP("Builds", "Hard 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"),
 
@@ -129,9 +144,14 @@ SETTINGS_LABELS = {
     "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"),
 }
 
 

novelwriter/core/coretools.py

@@ -26,19 +26,19 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-import shutil
 import logging
+import shutil
 
-from pathlib import Path
+from collections.abc import Iterable
 from functools import partial
+from pathlib import Path
 from zipfile import ZipFile, is_zipfile
-from collections.abc import Iterable
 
-from PyQt5.QtCore import QCoreApplication
+from PyQt5.QtCore import QCoreApplication, QRegularExpression
 
 from novelwriter import CONFIG, SHARED
 from novelwriter.common import isHandle, minmax, simplified
-from novelwriter.constants import nwFiles, nwItemClass
+from novelwriter.constants import nwConst, nwFiles, nwItemClass
 from novelwriter.core.item import NWItem
 from novelwriter.core.project import NWProject
 from novelwriter.core.storage import NWStorageCreate
@@ -101,9 +101,7 @@ class DocMerger:
         if srcItem is None:
             return False
 
-        inDoc = self._project.storage.getDocument(srcHandle)
-        docText = (inDoc.readDocument() or "").rstrip("\n")
-
+        docText = self._project.storage.getDocumentText(srcHandle).rstrip("\n")
         if addComment:
             docInfo = srcItem.describeMe()
             docSt, _ = srcItem.getImportStatus(incIcon=False)
@@ -122,9 +120,8 @@ class DocMerger:
             return False
 
         outDoc = self._project.storage.getDocument(self._targetDoc)
-        docText = (outDoc.readDocument() or "").rstrip("\n")
-        if docText:
-            self._targetText.insert(0, docText)
+        if text := (outDoc.readDocument() or "").rstrip("\n"):
+            self._targetText.insert(0, text)
 
         status = outDoc.writeDocument("\n\n".join(self._targetText) + "\n\n")
         if not status:
@@ -292,11 +289,10 @@ class DocDuplicator:
                     newItem.setParent(hMap[newItem.itemParent])
                     self._project.tree.updateItemData(newItem.itemHandle)
                 if newItem.isFileType():
-                    oldDoc = self._project.storage.getDocument(tHandle)
                     newDoc = self._project.storage.getDocument(newItem.itemHandle)
                     if newDoc.fileExists():
                         return
-                    newDoc.writeDocument(oldDoc.readDocument() or "")
+                    newDoc.writeDocument(self._project.storage.getDocumentText(tHandle))
                 yield newItem.itemHandle, nHandle
                 nHandle = None
         return
@@ -304,6 +300,95 @@ class DocDuplicator:
 # END Class DocDuplicator
 
 
+class DocSearch:
+
+    def __init__(self) -> None:
+        self._regEx = QRegularExpression()
+        self.setCaseSensitive(False)
+        self._words = False
+        self._escape = True
+        return
+
+    ##
+    #  Methods
+    ##
+
+    def setCaseSensitive(self, state: bool) -> None:
+        """Set the case sensitive search flag."""
+        opts = QRegularExpression.PatternOption.UseUnicodePropertiesOption
+        if not state:
+            opts |= QRegularExpression.PatternOption.CaseInsensitiveOption
+        self._regEx.setPatternOptions(opts)
+        return
+
+    def setWholeWords(self, state: bool) -> None:
+        """Set the whole words search flag."""
+        self._words = state
+        return
+
+    def setUserRegEx(self, state: bool) -> None:
+        """Set the escape flag to the opposite state."""
+        self._escape = not state
+        return
+
+    def iterSearch(
+        self, project: NWProject, search: str
+    ) -> Iterable[tuple[NWItem, list[tuple[int, int, str]], bool]]:
+        """Iteratively search through documents in a project."""
+        self._regEx.setPattern(self._buildPattern(search))
+        logger.debug("Searching with pattern '%s'", self._regEx.pattern())
+
+        num = len(search)
+        storage = project.storage
+        for item in project.tree:
+            if item.isFileType():
+                text = storage.getDocumentText(item.itemHandle)
+                rxItt = self._regEx.globalMatch(text)
+                count = 0
+                capped = False
+                results = []
+                while rxItt.hasNext():
+                    rxMatch = rxItt.next()
+                    pos = rxMatch.capturedStart()
+                    num = rxMatch.capturedLength()
+                    context = text[pos:pos+100].partition("\n")[0]
+                    if context:
+                        results.append((pos, num, context))
+                        count += 1
+                        if count >= nwConst.MAX_SEARCH_RESULT:
+                            capped = True
+                            break
+
+                yield item, results, capped
+
+        return
+
+    ##
+    #  Internal Functions
+    ##
+
+    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
+        if self._words:
+            search = search if search.startswith("\\b") else f"\\b{search}"
+            search = search if search.endswith("\\b") else f"{search}\\b"
+        return search
+
+# END Class DocSearch
+
+
 class ProjectBuilder:
     """A class to build a new project from a set of user-defined
     parameter provided by the New Project Wizard.