Add a setting for using character count as main count (#2323)

Author: vkbo

novelwriter/config.py

@@ -919,9 +919,10 @@ def loadCache(self) -> bool:
                     puuid = str(entry.get("uuid", ""))
                     title = str(entry.get("title", ""))
                     words = checkInt(entry.get("words", 0), 0)
+                    chars = checkInt(entry.get("chars", 0), 0)
                     saved = checkInt(entry.get("time", 0), 0)
                     if path and title:
-                        self._setEntry(puuid, path, title, words, saved)
+                        self._setEntry(puuid, path, title, words, chars, saved)
             except Exception:
                 logger.error("Could not load recent project cache")
                 logException()
@@ -954,7 +955,14 @@ def update(self, path: str | Path, data: NWProjectData, saved: float | int) -> N
         try:
             if (remove := self._map.get(data.uuid)) and (remove != str(path)):
                 self.remove(remove)
-            self._setEntry(data.uuid, str(path), data.name, sum(data.currCounts), int(saved))
+            self._setEntry(
+                data.uuid,
+                str(path),
+                data.name,
+                sum(data.currCounts[:2]),
+                sum(data.currCounts[2:]),
+                int(saved),
+            )
             self.saveCache()
         except Exception:
             pass
@@ -967,9 +975,17 @@ def remove(self, path: str | Path) -> None:
             self.saveCache()
         return
 
-    def _setEntry(self, puuid: str, path: str, title: str, words: int, saved: int) -> None:
+    def _setEntry(
+        self, puuid: str, path: str, title: str, words: int, chars: int, saved: int
+    ) -> None:
         """Set an entry in the recent projects record."""
-        self._data[path] = {"uuid": puuid, "title": title, "words": words, "time": saved}
+        self._data[path] = {
+            "uuid": puuid,
+            "title": title,
+            "words": words,
+            "chars": chars,
+            "time": saved,
+        }
         if puuid:
             self._map[puuid] = path
         return

novelwriter/constants.py

@@ -352,6 +352,10 @@ class nwLabels:
         nwStats.WORDS_TEXT:   QT_TRANSLATE_NOOP("Stats", "Words in Text"),
         nwStats.WORDS_TITLE:  QT_TRANSLATE_NOOP("Stats", "Words in Headings"),
     }
+    STATS_DISPLAY: Final[dict[str, str]] = {
+        nwStats.CHARS: QT_TRANSLATE_NOOP("Stats", "Characters: {0} ({1})"),
+        nwStats.WORDS: QT_TRANSLATE_NOOP("Stats", "Words: {0} ({1})"),
+    }
     BUILD_FMT: Final[dict[nwBuildFmt, str]] = {
         nwBuildFmt.ODT:    QT_TRANSLATE_NOOP("Constant", "Open Document (.odt)"),
         nwBuildFmt.FODT:   QT_TRANSLATE_NOOP("Constant", "Flat Open Document (.fodt)"),

novelwriter/core/item.py

@@ -53,10 +53,10 @@ class NWItem:
     """
 
     __slots__ = (
-        "_active", "_charCount", "_class", "_cursorPos", "_expanded",
-        "_handle", "_heading", "_import", "_initCount", "_layout", "_name",
+        "_active", "_charCount", "_charInit", "_class", "_cursorPos",
+        "_expanded", "_handle", "_heading", "_import", "_layout", "_name",
         "_order", "_paraCount", "_parent", "_project", "_root", "_status",
-        "_type", "_wordCount",
+        "_type", "_wordCount", "_wordInit",
     )
 
     def __init__(self, project: NWProject, handle: str) -> None:
@@ -81,7 +81,8 @@ def __init__(self, project: NWProject, handle: str) -> None:
         self._wordCount = 0     # Current word count
         self._paraCount = 0     # Current paragraph count
         self._cursorPos = 0     # Last cursor position
-        self._initCount = 0     # Initial word count
+        self._wordInit  = 0     # Initial character count
+        self._charInit  = 0     # Initial word count
 
         return
 
@@ -164,9 +165,13 @@ def wordCount(self) -> int:
     def paraCount(self) -> int:
         return self._paraCount
 
+    @property
+    def mainCount(self) -> int:
+        return self._charCount if CONFIG.useCharCount else self._wordCount
+
     @property
     def initCount(self) -> int:
-        return self._initCount
+        return self._wordInit if CONFIG.useCharCount else self._charInit
 
     @property
     def cursorPos(self) -> int:
@@ -257,31 +262,33 @@ def unpack(self, data: dict) -> bool:
             self._paraCount = 0
             self._cursorPos = 0
 
-        self._initCount = self._wordCount
+        self._wordInit = self._charCount
+        self._charInit = self._wordCount
 
         return True
 
     @classmethod
     def duplicate(cls, source: NWItem, handle: str) -> NWItem:
         """Make a copy of an item."""
         new = cls(source._project, handle)
-        new._name      = source._name
-        new._parent    = source._parent
-        new._root      = source._root
-        new._order     = source._order
-        new._type      = source._type
-        new._class     = source._class
-        new._layout    = source._layout
-        new._status    = source._status
-        new._import    = source._import
-        new._active    = source._active
-        new._expanded  = source._expanded
-        new._heading   = source._heading
-        new._charCount = source._charCount
-        new._wordCount = source._wordCount
-        new._paraCount = source._paraCount
-        new._cursorPos = source._cursorPos
-        new._initCount = source._initCount
+        new._name       = source._name
+        new._parent     = source._parent
+        new._root       = source._root
+        new._order      = source._order
+        new._type       = source._type
+        new._class      = source._class
+        new._layout     = source._layout
+        new._status     = source._status
+        new._import     = source._import
+        new._active     = source._active
+        new._expanded   = source._expanded
+        new._heading    = source._heading
+        new._charCount  = source._charCount
+        new._wordCount  = source._wordCount
+        new._paraCount  = source._paraCount
+        new._cursorPos  = source._cursorPos
+        new._wordInit = source._wordInit
+        new._charInit = source._charInit
         return new
 
     ##

novelwriter/core/itemmodel.py

@@ -166,7 +166,7 @@ def refresh(self) -> None:
 
     def updateCount(self, propagate: bool = True) -> None:
         """Update counts, and propagate upwards in the tree."""
-        self._count = self._item.wordCount + sum(c._count for c in self._children)  # noqa: SLF001
+        self._count = self._item.mainCount + sum(c._count for c in self._children)  # noqa: SLF001
         self._cache[C_COUNT_TEXT] = f"{self._count:n}"
         if propagate and (parent := self._parent):
             parent.updateCount()

novelwriter/core/project.py

@@ -367,7 +367,7 @@ def openProject(self, projPath: str | Path, clearLock: bool = False) -> bool:
             # Often, the index needs to be rebuilt when updating format
             self._index.rebuild()
 
-        self.updateWordCounts()
+        self.updateCounts()
         self._session.startSession()
         self.setProjectChanged(False)
         self._valid = True
@@ -397,7 +397,7 @@ def saveProject(self, autoSave: bool = False) -> bool:
         else:
             self._data.incSaveCount()
 
-        self.updateWordCounts()
+        self.updateCounts()
         self.countStatus()
 
         xmlWriter = self._storage.getXmlWriter()
@@ -515,10 +515,10 @@ def setProjectChanged(self, status: bool) -> bool:
     #  Class Methods
     ##
 
-    def updateWordCounts(self) -> None:
-        """Update the total word count values."""
-        novel, notes = self._tree.sumWords()
-        self._data.setCurrCounts(novel=novel, notes=notes)
+    def updateCounts(self) -> None:
+        """Update the total word and character count values."""
+        wNovel, wNotes, cNovel, cNotes = self._tree.sumCounts()
+        self._data.setCurrCounts(wNovel=wNovel, wNotes=wNotes, cNovel=cNovel, cNotes=cNotes)
         return
 
     def countStatus(self) -> None:

novelwriter/core/projectdata.py

@@ -66,8 +66,8 @@ def __init__(self, project: NWProject) -> None:
         self._spellLang = None
 
         # Project Dictionaries
-        self._initCounts = [0, 0]
-        self._currCounts = [0, 0]
+        self._initCounts = [0, 0, 0, 0]
+        self._currCounts = [0, 0, 0, 0]
         self._lastHandle: dict[str, str | None] = {
             "editor":  None,
             "viewer":  None,
@@ -148,18 +148,18 @@ def spellLang(self) -> str | None:
         return self._spellLang
 
     @property
-    def initCounts(self) -> tuple[int, int]:
-        """Return the initial count of words for novel and note
-        documents.
+    def initCounts(self) -> tuple[int, int, int, int]:
+        """Return the initial count of words and characters for novel
+        and note documents.
         """
-        return self._initCounts[0], self._initCounts[1]
+        return self._initCounts[0], self._initCounts[1], self._initCounts[2], self._initCounts[3]
 
     @property
-    def currCounts(self) -> tuple[int, int]:
-        """Return the current count of words for novel and note
-        documents.
+    def currCounts(self) -> tuple[int, int, int, int]:
+        """Return the current count of words and characters for novel
+        and note documents.
         """
-        return self._currCounts[0], self._currCounts[1]
+        return self._currCounts[0], self._currCounts[1], self._currCounts[2], self._currCounts[3]
 
     @property
     def lastHandle(self) -> dict[str, str | None]:
@@ -301,22 +301,40 @@ def setLastHandles(self, value: dict) -> None:
             self._project.setProjectChanged(True)
         return
 
-    def setInitCounts(self, novel: Any = None, notes: Any = None) -> None:
-        """Set the word count totals for novel and note files."""
-        if novel is not None:
-            self._initCounts[0] = checkInt(novel, 0)
-            self._currCounts[0] = checkInt(novel, 0)
-        if notes is not None:
-            self._initCounts[1] = checkInt(notes, 0)
-            self._currCounts[1] = checkInt(notes, 0)
+    def setInitCounts(
+        self, wNovel: Any = None, wNotes: Any = None, cNovel: Any = None, cNotes: Any = None
+    ) -> None:
+        """Set the count totals for novel and note files."""
+        if wNovel is not None:
+            count = checkInt(wNovel, 0)
+            self._initCounts[0] = count
+            self._currCounts[0] = count
+        if wNotes is not None:
+            count = checkInt(wNotes, 0)
+            self._initCounts[1] = count
+            self._currCounts[1] = count
+        if cNovel is not None:
+            count = checkInt(cNovel, 0)
+            self._initCounts[2] = count
+            self._currCounts[2] = count
+        if cNotes is not None:
+            count = checkInt(cNotes, 0)
+            self._initCounts[3] = count
+            self._currCounts[3] = count
         return
 
-    def setCurrCounts(self, novel: Any = None, notes: Any = None) -> None:
-        """Set the word count totals for novel and note files."""
-        if novel is not None:
-            self._currCounts[0] = checkInt(novel, 0)
-        if notes is not None:
-            self._currCounts[1] = checkInt(notes, 0)
+    def setCurrCounts(
+        self, wNovel: Any = None, wNotes: Any = None, cNovel: Any = None, cNotes: Any = None
+    ) -> None:
+        """Set the count totals for novel and note files."""
+        if wNovel is not None:
+            self._currCounts[0] = checkInt(wNovel, 0)
+        if wNotes is not None:
+            self._currCounts[1] = checkInt(wNotes, 0)
+        if cNovel is not None:
+            self._currCounts[2] = checkInt(cNovel, 0)
+        if cNotes is not None:
+            self._currCounts[3] = checkInt(cNotes, 0)
         return
 
     def setAutoReplace(self, value: dict) -> None:

novelwriter/core/projectxml.py

@@ -46,7 +46,7 @@
 logger = logging.getLogger(__name__)
 
 FILE_VERSION = "1.5"  # The current project file format version
-FILE_REVISION = "4"   # The current project file format revision
+FILE_REVISION = "5"   # The current project file format revision
 HEX_VERSION = 0x0105
 
 NUM_VERSION = {
@@ -109,6 +109,8 @@ class for items. 2.3 Beta 1.
         Rev 3: Added TEMPLATE class. 2.3.
         Rev 4: Added shape attribute to status and importance entry
                nodes. 2.5.
+        Rev 5: Added novelChars and notesChars attributes to content
+               node. 2.7 RC 1.
     """
 
     def __init__(self, path: str | Path) -> None:
@@ -286,9 +288,9 @@ def _parseProjectSettings(self, xSection: ET.Element, data: NWProjectData) -> No
                 elif xItem.tag == "spellLang":  # Changed to spellChecking in 1.5
                     data.setSpellLang(xItem.text)
                 elif xItem.tag == "novelWordCount":  # Moved to content attribute in 1.5
-                    data.setInitCounts(novel=xItem.text)
+                    data.setInitCounts(wNovel=xItem.text)
                 elif xItem.tag == "notesWordCount":  # Moved to content attribute in 1.5
-                    data.setInitCounts(notes=xItem.text)
+                    data.setInitCounts(wNotes=xItem.text)
 
         return
 
@@ -298,8 +300,13 @@ def _parseProjectContent(
         """Parse the content section of the XML file."""
         logger.debug("Parsing <content> section")
 
-        data.setInitCounts(novel=xSection.attrib.get("novelWords", None))  # Moved in 1.5
-        data.setInitCounts(notes=xSection.attrib.get("notesWords", None))  # Moved in 1.5
+        # Moved in 1.5
+        data.setInitCounts(
+            wNovel=xSection.attrib.get("novelWords", None),
+            wNotes=xSection.attrib.get("notesWords", None),
+            cNovel=xSection.attrib.get("novelChars", None),
+            cNotes=xSection.attrib.get("notesChars", None),
+        )
 
         for xItem in xSection:
             if xItem.tag != "item":
@@ -527,10 +534,13 @@ def write(self, data: NWProjectData, content: list, saveTime: float, editTime: i
             self._packSingleValue(xImport, "entry", label, attrib=attrib)
 
         # Save Tree Content
+        counts = data.currCounts
         contAttr = {
             "items": str(len(content)),
-            "novelWords": str(data.currCounts[0]),
-            "notesWords": str(data.currCounts[1]),
+            "novelWords": str(counts[0]),
+            "notesWords": str(counts[1]),
+            "novelChars": str(counts[2]),
+            "notesChars": str(counts[3]),
         }
 
         xContent = ET.SubElement(xRoot, "content", attrib=contAttr)