novelWriter 2.3rc1__py3-none-any.whl → 2.4b1__py3-none-any.whl

novelwriter/core/project.py

@@ -31,7 +31,7 @@ from time import time
 from typing import TYPE_CHECKING
 from pathlib import Path
 from functools import partial
-from collections.abc import Iterator
+from collections.abc import Iterable
 
 from PyQt5.QtCore import QCoreApplication
 
@@ -175,12 +175,10 @@ class NWProject:
         """Write content to a new document after it is created. This
         will not run if the file exists and is not empty.
         """
-        tItem = self._tree[tHandle]
-        if not (tItem and tItem.isFileType()):
+        if not ((tItem := self._tree[tHandle]) and tItem.isFileType()):
             return False
 
-        newDoc = self._storage.getDocument(tHandle)
-        if (newDoc.readDocument() or "").strip():
+        if self._storage.getDocumentText(tHandle).strip():
             return False
 
         indent = "#"*minmax(hLevel, 1, 4)
@@ -191,7 +189,7 @@ class NWProject:
         else:
             tItem.setLayout(nwItemLayout.NOTE)
 
-        newDoc.writeDocument(text)
+        self._storage.getDocument(tHandle).writeDocument(text)
         self._index.scanText(tHandle, text)
 
         return True
@@ -200,21 +198,18 @@ class NWProject:
         """Copy content to a new document after it is created. This
         will not run if the file exists and is not empty.
         """
-        tItem = self._tree[tHandle]
-        if not (tItem and tItem.isFileType()):
+        if not ((tItem := self._tree[tHandle]) and tItem.isFileType()):
             return False
 
-        sItem = self._tree[sHandle]
-        if not (sItem and sItem.isFileType()):
+        if not ((sItem := self._tree[sHandle]) and sItem.isFileType()):
             return False
 
-        newDoc = self._storage.getDocument(tHandle)
-        if (newDoc.readDocument() or "").strip():
+        if self._storage.getDocumentText(tHandle).strip():
             return False
 
         logger.debug("Populating '%s' with text from '%s'", tHandle, sHandle)
-        text = self._storage.getDocument(sHandle).readDocument() or ""
-        newDoc.writeDocument(text)
+        text = self._storage.getDocumentText(sHandle)
+        self._storage.getDocument(tHandle).writeDocument(text)
         sItem.setLayout(tItem.itemLayout)
         self._index.scanText(tHandle, text)
 
@@ -410,6 +405,7 @@ class NWProject:
     def closeProject(self, idleTime: float = 0.0) -> None:
         """Close the project."""
         logger.info("Closing project")
+        self._index.clearIndex()  # Triggers clear signal, see #1718
         self._options.saveSettings()
         self._tree.writeToCFile()
         self._session.appendSession(idleTime)
@@ -516,7 +512,7 @@ class NWProject:
     #  Class Methods
     ##
 
-    def iterProjectItems(self) -> Iterator[NWItem]:
+    def iterProjectItems(self) -> Iterable[NWItem]:
         """This function ensures that the item tree loaded is sent to
         the GUI tree view in such a way that the tree can be built. That
         is, the parent item must be sent before its child. In principle,

novelwriter/core/projectxml.py

@@ -46,7 +46,7 @@ if TYPE_CHECKING:  # pragma: no cover
 logger = logging.getLogger(__name__)
 
 FILE_VERSION = "1.5"  # The current project file format version
-FILE_REVISION = "2"   # The current project file format revision
+FILE_REVISION = "3"   # The current project file format revision
 HEX_VERSION = 0x0105
 
 NUM_VERSION = {
@@ -108,6 +108,7 @@ class ProjectXMLReader:
         Rev 1: Drops the titleFormat node from settings. 2.1 Beta 1.
         Rev 2: Drops the title node from project and adds the TEMPLATE
                class for items. 2.3 Beta 1.
+        Rev 3: Added TEMPLATE class. 2.3.
     """
 
     def __init__(self, path: str | Path) -> None:

novelwriter/core/sessions.py

@@ -29,7 +29,7 @@ import logging
 from time import time
 from typing import TYPE_CHECKING
 from pathlib import Path
-from collections.abc import Iterator
+from collections.abc import Iterable
 
 from novelwriter.error import logException
 from novelwriter.common import formatTimeStamp
@@ -110,7 +110,7 @@ class NWSessionLog:
 
         return True
 
-    def iterRecords(self) -> Iterator[dict]:
+    def iterRecords(self) -> Iterable[dict]:
         """Iterate through all records in the log."""
         sessFile = self._project.storage.getMetaFile(nwFiles.SESS_FILE)
         if isinstance(sessFile, Path) and sessFile.is_file():

novelwriter/core/status.py

@@ -28,10 +28,10 @@ import random
 import logging
 
 from typing import TYPE_CHECKING, Literal
-from collections.abc import ItemsView, Iterator, KeysView, ValuesView
+from collections.abc import ItemsView, Iterable, Iterator, KeysView, ValuesView
 
 from PyQt5.QtGui import QIcon, QPainter, QPainterPath, QPixmap, QColor
-from PyQt5.QtCore import QRectF, Qt
+from PyQt5.QtCore import QRectF
 
 from novelwriter import CONFIG
 from novelwriter.common import minmax, simplified
@@ -193,7 +193,7 @@ class NWStatus:
             self._store[key]["count"] += 1
         return
 
-    def pack(self) -> Iterator[tuple[str, dict]]:
+    def pack(self) -> Iterable[tuple[str, dict]]:
         """Pack the status entries into a dictionary."""
         for key, data in self._store.items():
             yield (data["name"], {
@@ -248,7 +248,7 @@ class NWStatus:
     def _createIcon(self, red: int, green: int, blue: int) -> QIcon:
         """Generate an icon for a status label."""
         pixmap = QPixmap(self._iPX, self._iPX)
-        pixmap.fill(Qt.transparent)
+        pixmap.fill(QColor(0, 0, 0, 0))
 
         painter = QPainter(pixmap)
         painter.setRenderHint(QPainter.Antialiasing)

novelwriter/core/storage.py

@@ -27,18 +27,18 @@ import json
 import logging
 
 from enum import Enum
+from pathlib import Path
 from time import time
 from typing import TYPE_CHECKING
-from pathlib import Path
 from zipfile import ZIP_DEFLATED, ZIP_STORED, ZipFile
 
 from novelwriter import CONFIG
-from novelwriter.error import logException
 from novelwriter.common import isHandle, minmax
 from novelwriter.constants import nwFiles
 from novelwriter.core.document import NWDocument
 from novelwriter.core.projectxml import ProjectXMLReader, ProjectXMLWriter
 from novelwriter.core.spellcheck import UserDictionary
+from novelwriter.error import logException
 
 if TYPE_CHECKING:  # pragma: no cover
     from novelwriter.core.project import NWProject
@@ -183,11 +183,15 @@ class NWStorage:
         # 2. A full path to an nwProject.nwx file
         if inPath.is_dir() and inPath != Path.home().resolve():
             nwxFile = inPath / nwFiles.PROJ_FILE
-        elif inPath.is_file() and inPath.name == nwFiles.PROJ_FILE:
-            nwxFile = inPath
+        elif inPath.is_file():
+            if inPath.name == nwFiles.PROJ_FILE:
+                nwxFile = inPath
+            else:
+                logger.error("Not a novelWriter project")
+                return NWStorageOpen.UNKOWN
         else:
-            logger.error("Not a novelWriter project")
-            return NWStorageOpen.UNKOWN
+            logger.error("Not found: %s", inPath)
+            return NWStorageOpen.NOT_FOUND
 
         if not nwxFile.exists():
             # The .nwx file must exist to continue
@@ -283,6 +287,12 @@ class NWStorage:
             return self._runtimePath / "meta" / fileName
         return None
 
+    def getDocumentText(self, tHandle: str) -> str:
+        """Return the text of a document in a fast and efficient way."""
+        if isinstance(self._runtimePath, Path):
+            return NWDocument.quickReadText(self._runtimePath / "content", tHandle)
+        return ""
+
     def scanContent(self) -> list[str]:
         """Scan the content folder and return the handle of all files
         found in it. Files that do not match the pattern are ignored.

novelwriter/core/tohtml.py

@@ -74,15 +74,9 @@ class ToHtml(Tokenizer):
     #  Setters
     ##
 
-    def setPreview(self, doComments: bool, doSynopsis: bool) -> None:
-        """If we're using this class to generate markdown preview, we
-        need to make a few changes to formatting, which is managed by
-        these flags.
-        """
-        self._genMode = self.M_PREVIEW
-        self._doKeywords = True
-        self._doComments = doComments
-        self._doSynopsis = doSynopsis
+    def setPreview(self, state: bool) -> None:
+        """Set to preview generator mode."""
+        self._genMode = self.M_PREVIEW if state else self.M_EXPORT
         return
 
     def setStyles(self, cssStyles: bool) -> None:
@@ -133,6 +127,8 @@ class ToHtml(Tokenizer):
                 self.FMT_D_E: "</span>",
                 self.FMT_U_B: "<u>",
                 self.FMT_U_E: "</u>",
+                self.FMT_M_B: "<mark>",
+                self.FMT_M_E: "</mark>",
             }
         else:
             htmlTags = {  # HTML5 (for export)
@@ -144,6 +140,8 @@ class ToHtml(Tokenizer):
                 self.FMT_D_E: "</del>",
                 self.FMT_U_B: "<span style='text-decoration: underline;'>",
                 self.FMT_U_E: "</span>",
+                self.FMT_M_B: "<mark>",
+                self.FMT_M_E: "</mark>",
             }
 
         htmlTags[self.FMT_SUP_B] = "<sup>"
@@ -171,6 +169,8 @@ class ToHtml(Tokenizer):
         pStyle = None
         lines = []
 
+        tHandle = self._handle
+
         for tType, nHead, tText, tFormat, tStyle in self._tokens:
 
             # Replace < and > with HTML entities
@@ -229,8 +229,8 @@ class ToHtml(Tokenizer):
             else:
                 hStyle = ""
 
-            if self._linkHeaders:
-                aNm = f"<a name='T{nHead:04d}'></a>"
+            if self._linkHeadings and tHandle:
+                aNm = f"<a name='{tHandle}:T{nHead:04d}'></a>"
             else:
                 aNm = ""
 
@@ -252,10 +252,6 @@ class ToHtml(Tokenizer):
                 tHead = tText.replace(nwHeadFmt.BR, "<br/>")
                 lines.append(f"<h1 class='title'{hStyle}>{aNm}{tHead}</h1>\n")
 
-            elif tType == self.T_UNNUM:
-                tHead = tText.replace(nwHeadFmt.BR, "<br/>")
-                lines.append(f"<{h2}{hStyle}>{aNm}{tHead}</{h2}>\n")
-
             elif tType == self.T_HEAD1:
                 tHead = tText.replace(nwHeadFmt.BR, "<br/>")
                 lines.append(f"<{h1}{h1Cl}{hStyle}>{aNm}{tHead}</{h1}>\n")
@@ -296,12 +292,13 @@ class ToHtml(Tokenizer):
                 lines.append(self._formatComments(tText))
 
             elif tType == self.T_KEYWORD and self._doKeywords:
-                tTemp = f"<p{hStyle}>{self._formatKeywords(tText)}</p>\n"
+                tag, text = self._formatKeywords(tText)
+                kClass = f" class='meta meta-{tag}'" if tag else ""
+                tTemp = f"<p{kClass}{hStyle}>{text}</p>\n"
                 lines.append(tTemp)
 
         self._result = "".join(lines)
-        if self._genMode != self.M_PREVIEW:
-            self._fullHTML.append(self._result)
+        self._fullHTML.append(self._result)
 
         return
 
@@ -364,13 +361,12 @@ class ToHtml(Tokenizer):
 
     def getStyleSheet(self) -> list[str]:
         """Generate a stylesheet for the current settings."""
-        styles = []
         if not self._cssStyles:
-            return styles
+            return []
 
         mScale = self._lineHeight/1.15
-        textAlign = "justify" if self._doJustify else "left"
 
+        styles = []
         styles.append("body {{font-family: '{0:s}'; font-size: {1:d}pt;}}".format(
             self._textFont, self._textSize
         ))
@@ -380,7 +376,7 @@ class ToHtml(Tokenizer):
             "margin-top: {2:.2f}em; margin-bottom: {3:.2f}em;"
             "}}"
         ).format(
-            textAlign,
+            "justify" if self._doJustify else "left",
             round(100 * self._lineHeight),
             mScale * self._marginText[0],
             mScale * self._marginText[1],
@@ -445,6 +441,7 @@ class ToHtml(Tokenizer):
         ))
 
         styles.append("a {color: rgb(66, 113, 174);}")
+        styles.append("mark {background: rgb(255, 255, 166);}")
         styles.append(".tags {color: rgb(245, 135, 31); font-weight: bold;}")
         styles.append(".break {text-align: left;}")
         styles.append(".synopsis {font-style: italic;}")
@@ -475,11 +472,11 @@ class ToHtml(Tokenizer):
             sComm = self._localLookup("Comment")
             return f"<p class='comment'><strong>{sComm}:</strong> {text}</p>\n"
 
-    def _formatKeywords(self, text: str) -> str:
+    def _formatKeywords(self, text: str) -> tuple[str, str]:
         """Apply HTML formatting to keywords."""
         valid, bits, _ = self._project.index.scanThis("@"+text)
         if not valid or not bits or bits[0] not in nwLabels.KEY_NAME:
-            return ""
+            return "", ""
 
         result = f"<span class='tags'>{self._localLookup(nwLabels.KEY_NAME[bits[0]])}:</span> "
         if len(bits) > 1:
@@ -494,6 +491,6 @@ class ToHtml(Tokenizer):
                 else:
                     result += ", ".join(f"<a href='#tag_{t}'>{t}</a>" for t in bits[1:])
 
-        return result
+        return bits[0][1:], result
 
 # END Class ToHtml