Merge branch 'main' into multi_root

novelwriter/core/document.py

@@ -89,9 +89,10 @@ class NWDoc():
 
         theText = ""
         self._docMeta = {}
-        self._prevHash = sha256sum(docPath)
+        self._prevHash = None
 
         if os.path.isfile(docPath):
+            self._prevHash = sha256sum(docPath)
             try:
                 with open(docPath, mode="r", encoding="utf-8") as inFile:
                     # Check the first <= 10 lines for metadata

novelwriter/core/index.py

@@ -112,8 +112,7 @@ class NWIndex():
 
         theDoc = NWDoc(self.theProject, tHandle)
         theText = theDoc.readDocument()
-        if theText:
-            self.scanText(tHandle, theText)
+        self.scanText(tHandle, theText if theText is not None else "")
 
         return True
 
@@ -217,18 +216,19 @@ class NWIndex():
         if theItem.itemType != nwItemType.FILE:
             logger.info("Not indexing non-file item '%s'", tHandle)
             return False
+
+        # Run word counter for the whole text
+        cC, wC, pC = countWords(theText)
+        self._fileMeta[tHandle] = ["H0", cC, wC, pC]
+
+        # If the file's meta data is missing, or the file is out of the
+        # main project, we don't index the content
         if theItem.itemLayout == nwItemLayout.NO_LAYOUT:
             logger.info("Not indexing no-layout item '%s'", tHandle)
             return False
         if theItem.itemParent is None:
             logger.info("Not indexing orphaned item '%s'", tHandle)
             return False
-
-        # Run word counter for the whole text
-        cC, wC, pC = countWords(theText)
-        self._fileMeta[tHandle] = ["H0", cC, wC, pC]
-
-        # If the file is archived or in trash, we don't index the content
         if self.theProject.projTree.isTrashRoot(theItem.itemParent):
             logger.debug("Not indexing trash item '%s'", tHandle)
             return False

novelwriter/core/item.py

@@ -139,24 +139,32 @@ class NWItem():
     def packXML(self, xParent):
         """Pack all the data in the class instance into an XML object.
         """
-        xPack = etree.SubElement(xParent, "item", attrib={
-            "handle": str(self._handle),
-            "order":  str(self._order),
-            "parent": str(self._parent),
-        })
-        self._subPack(xPack, "name",   text=str(self._name))
-        self._subPack(xPack, "type",   text=str(self._type.name))
-        self._subPack(xPack, "class",  text=str(self._class.name))
-        self._subPack(xPack, "status", text=str(self._status))
+        itemAttrib = {}
+        itemAttrib["handle"] = str(self._handle)
+        itemAttrib["parent"] = str(self._parent)
+        itemAttrib["order"]  = str(self._order)
+        itemAttrib["type"]   = str(self._type.name)
+        itemAttrib["class"]  = str(self._class.name)
         if self._type == nwItemType.FILE:
-            self._subPack(xPack, "exported",  text=str(self._exported))
-            self._subPack(xPack, "layout",    text=str(self._layout.name))
-            self._subPack(xPack, "charCount", text=str(self._charCount), none=False)
-            self._subPack(xPack, "wordCount", text=str(self._wordCount), none=False)
-            self._subPack(xPack, "paraCount", text=str(self._paraCount), none=False)
-            self._subPack(xPack, "cursorPos", text=str(self._cursorPos), none=False)
+            itemAttrib["layout"] = str(self._layout.name)
+
+        metaAttrib = {}
+        if self._type == nwItemType.FILE:
+            metaAttrib["charCount"] = str(self._charCount)
+            metaAttrib["wordCount"] = str(self._wordCount)
+            metaAttrib["paraCount"] = str(self._paraCount)
+            metaAttrib["cursorPos"] = str(self._cursorPos)
         else:
-            self._subPack(xPack, "expanded", text=str(self._expanded))
+            metaAttrib["expanded"]  = str(self._expanded)
+
+        nameAttrib = {}
+        nameAttrib["status"] = str(self._status)
+        if self._type == nwItemType.FILE:
+            nameAttrib["exported"]  = str(self._exported)
+
+        xPack = etree.SubElement(xParent, "item", attrib=itemAttrib)
+        self._subPack(xPack, "meta",   attrib=metaAttrib)
+        self._subPack(xPack, "name",   text=str(self._name), attrib=nameAttrib)
 
         return
 
@@ -175,19 +183,31 @@ class NWItem():
 
         self.setParent(xItem.attrib.get("parent", None))
         self.setOrder(xItem.attrib.get("order", 0))
+        self.setType(xItem.attrib.get("type", nwItemType.NO_TYPE))
+        self.setClass(xItem.attrib.get("class", nwItemClass.NO_CLASS))
+        self.setLayout(xItem.attrib.get("layout", nwItemLayout.NO_LAYOUT))
 
-        tmpStatus = ""
         for xValue in xItem:
-            if xValue.tag == "name":
+            if xValue.tag == "meta":
+                self.setExpanded(xValue.attrib.get("expanded", False))
+                self.setCharCount(xValue.attrib.get("charCount", 0))
+                self.setWordCount(xValue.attrib.get("wordCount", 0))
+                self.setParaCount(xValue.attrib.get("paraCount", 0))
+                self.setCursorPos(xValue.attrib.get("cursorPos", 0))
+            elif xValue.tag == "name":
                 self.setName(xValue.text)
+                self.setStatus(xValue.attrib.get("status", None))
+                self.setExported(xValue.attrib.get("exported", True))
+
+            # Legacy Format (1.3 and earlier)
+            elif xValue.tag == "status":
+                self.setStatus(xValue.text)
             elif xValue.tag == "type":
                 self.setType(xValue.text)
             elif xValue.tag == "class":
                 self.setClass(xValue.text)
             elif xValue.tag == "layout":
                 self.setLayout(xValue.text)
-            elif xValue.tag == "status":
-                tmpStatus = xValue.text
             elif xValue.tag == "expanded":
                 self.setExpanded(xValue.text)
             elif xValue.tag == "exported":
@@ -206,9 +226,6 @@ class NWItem():
                 # version of novelWriter that doesn't know the tag
                 logger.error("Unknown tag '%s'", xValue.tag)
 
-        # Guarantees that <status> is parsed after <class>
-        self.setStatus(tmpStatus)
-
         return True
 
     @staticmethod

novelwriter/core/project.py

@@ -53,7 +53,7 @@ logger = logging.getLogger(__name__)
 
 class NWProject():
 
-    FILE_VERSION = "1.3"
+    FILE_VERSION = "1.4"
 
     def __init__(self, theParent):
 
@@ -474,8 +474,11 @@ class NWProject():
         # 1.3 : Reduces the number of layouts to only two. One for novel
         #       documents and one for project notes. Introduced in
         #       version 1.5.
+        # 1.4 : Introduces a more compact format for storing items. All
+        #       settings aside from name are now attributes. Introduced
+        #       in version 1.7.
 
-        if fileVersion not in ("1.0", "1.1", "1.2", "1.3"):
+        if fileVersion not in ("1.0", "1.1", "1.2", "1.3", "1.4"):
             self.theParent.makeAlert(self.tr(
                 "Unknown or unsupported novelWriter project file format. "
                 "The project cannot be opened by this version of novelWriter. "

novelwriter/core/tokenizer.py

@@ -1,7 +1,7 @@
 """
 novelWriter – Text Tokenizer
 ============================
-Splits a piece of novelWriter markdown text into its elements
+Split novelWriter plain text into its elements
 
 File History:
 Created: 2019-05-05 [0.0.1]
@@ -27,6 +27,7 @@ import re
 import logging
 import novelwriter
 
+from abc import ABC, abstractmethod
 from operator import itemgetter
 from functools import partial
 
@@ -40,7 +41,7 @@ from novelwriter.core.document import NWDoc
 logger = logging.getLogger(__name__)
 
 
-class Tokenizer():
+class Tokenizer(ABC):
 
     # In-Text Format
     FMT_B_B = 1  # Begin bold
@@ -267,6 +268,10 @@ class Tokenizer():
     #  Class Methods
     ##
 
+    @abstractmethod
+    def doConvert(self):
+        raise NotImplementedError
+
     def addRootHeading(self, theHandle):
         """Add a heading at the start of a new root folder.
         """

novelwriter/core/toodt.py

@@ -330,7 +330,7 @@ class ToOdt(Tokenizer):
 
         # Meta Data
         xMeta = etree.SubElement(self._xMeta, _mkTag("meta", "creation-date"))
-        xMeta.text = datetime.now().strftime(r"%Y-%m-%dT%H:%M:%S")
+        xMeta.text = datetime.now().isoformat(sep="T", timespec="seconds")
 
         xMeta = etree.SubElement(self._xMeta, _mkTag("meta", "generator"))
         xMeta.text = f"novelWriter/{novelwriter.__version__}"