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

novelwriter/gui/dochighlight.py

@@ -44,16 +44,21 @@ logger = logging.getLogger(__name__)
 
 SPELLRX = QRegularExpression(r"\b[^\s\-\+\/–—\[\]:]+\b")
 SPELLRX.setPatternOptions(QRegularExpression.UseUnicodePropertiesOption)
+SPELLSC = QRegularExpression(nwRegEx.FMT_SC)
+SPELLSC.setPatternOptions(QRegularExpression.UseUnicodePropertiesOption)
+SPELLSV = QRegularExpression(nwRegEx.FMT_SV)
+SPELLSV.setPatternOptions(QRegularExpression.UseUnicodePropertiesOption)
 
+BLOCK_NONE  = 0
+BLOCK_TEXT  = 1
+BLOCK_META  = 2
+BLOCK_TITLE = 4
 
-class GuiDocHighlighter(QSyntaxHighlighter):
 
-    __slots__ = ("_tItem", "_tHandle", "_spellCheck", "_spellErr", "_hRules", "_hStyles")
+class GuiDocHighlighter(QSyntaxHighlighter):
 
-    BLOCK_NONE  = 0
-    BLOCK_TEXT  = 1
-    BLOCK_META  = 2
-    BLOCK_TITLE = 4
+    __slots__ = ("_tHandle", "_isInactive", "_spellCheck", "_spellErr",
+                 "_hRules", "_hStyles", "_rxRules")
 
     def __init__(self, document: QTextDocument) -> None:
         super().__init__(document)
@@ -67,6 +72,7 @@ class GuiDocHighlighter(QSyntaxHighlighter):
 
         self._hRules: list[tuple[str, dict]] = []
         self._hStyles: dict[str, QTextCharFormat] = {}
+        self._rxRules: list[tuple[QRegularExpression, dict[str, QTextCharFormat]]] = []
 
         self.initHighlighter()
 
@@ -90,10 +96,10 @@ class GuiDocHighlighter(QSyntaxHighlighter):
             "header2":   self._makeFormat(SHARED.theme.colHead, "bold", 1.6),
             "header3":   self._makeFormat(SHARED.theme.colHead, "bold", 1.4),
             "header4":   self._makeFormat(SHARED.theme.colHead, "bold", 1.2),
-            "header1h":  self._makeFormat(SHARED.theme.colHeadH, "bold", 1.8),
-            "header2h":  self._makeFormat(SHARED.theme.colHeadH, "bold", 1.6),
-            "header3h":  self._makeFormat(SHARED.theme.colHeadH, "bold", 1.4),
-            "header4h":  self._makeFormat(SHARED.theme.colHeadH, "bold", 1.2),
+            "head1h":    self._makeFormat(SHARED.theme.colHeadH, "bold", 1.8),
+            "head2h":    self._makeFormat(SHARED.theme.colHeadH, "bold", 1.6),
+            "head3h":    self._makeFormat(SHARED.theme.colHeadH, "bold", 1.4),
+            "head4h":    self._makeFormat(SHARED.theme.colHeadH, "bold", 1.2),
             "bold":      self._makeFormat(colEmph, "bold"),
             "italic":    self._makeFormat(colEmph, "italic"),
             "strike":    self._makeFormat(SHARED.theme.colHidden, "strike"),
@@ -116,7 +122,7 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         # Cache Spell Error Format
         self._spellErr = QTextCharFormat()
         self._spellErr.setUnderlineColor(SHARED.theme.colSpell)
-        self._spellErr.setUnderlineStyle(QTextCharFormat.SpellCheckUnderline)
+        self._spellErr.setUnderlineStyle(QTextCharFormat.UnderlineStyle.SpellCheckUnderline)
 
         # Multiple or Trailing Spaces
         if CONFIG.showMultiSpaces:
@@ -218,11 +224,11 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         ))
 
         # Build a QRegExp for each highlight pattern
-        self.rxRules = []
+        self._rxRules = []
         for regEx, regRules in self._hRules:
             hReg = QRegularExpression(regEx)
             hReg.setPatternOptions(QRegularExpression.UseUnicodePropertiesOption)
-            self.rxRules.append((hReg, regRules))
+            self._rxRules.append((hReg, regRules))
 
         return
 
@@ -272,12 +278,12 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         is significantly faster than running the regex checks used for
         text paragraphs.
         """
-        self.setCurrentBlockState(self.BLOCK_NONE)
+        self.setCurrentBlockState(BLOCK_NONE)
         if self._tHandle is None or not text:
             return
 
         if text.startswith("@"):  # Keywords and commands
-            self.setCurrentBlockState(self.BLOCK_META)
+            self.setCurrentBlockState(BLOCK_META)
             index = SHARED.project.index
             isValid, bits, pos = index.scanThis(text)
             isGood = index.checkThese(bits, self._tHandle)
@@ -300,35 +306,39 @@ class GuiDocHighlighter(QSyntaxHighlighter):
             # so we force a return here
             return
 
-        elif text.startswith(("# ", "#! ", "## ", "##! ", "### ", "#### ")):
-            self.setCurrentBlockState(self.BLOCK_TITLE)
+        elif text.startswith(("# ", "#! ", "## ", "##! ", "### ", "###! ", "#### ")):
+            self.setCurrentBlockState(BLOCK_TITLE)
 
-            if text.startswith("# "):  # Header 1
-                self.setFormat(0, 1, self._hStyles["header1h"])
+            if text.startswith("# "):  # Heading 1
+                self.setFormat(0, 1, self._hStyles["head1h"])
                 self.setFormat(1, len(text), self._hStyles["header1"])
 
-            elif text.startswith("## "):  # Header 2
-                self.setFormat(0, 2, self._hStyles["header2h"])
+            elif text.startswith("## "):  # Heading 2
+                self.setFormat(0, 2, self._hStyles["head2h"])
                 self.setFormat(2, len(text), self._hStyles["header2"])
 
-            elif text.startswith("### "):  # Header 3
-                self.setFormat(0, 3, self._hStyles["header3h"])
+            elif text.startswith("### "):  # Heading 3
+                self.setFormat(0, 3, self._hStyles["head3h"])
                 self.setFormat(3, len(text), self._hStyles["header3"])
 
-            elif text.startswith("#### "):  # Header 4
-                self.setFormat(0, 4, self._hStyles["header4h"])
+            elif text.startswith("#### "):  # Heading 4
+                self.setFormat(0, 4, self._hStyles["head4h"])
                 self.setFormat(4, len(text), self._hStyles["header4"])
 
             elif text.startswith("#! "):  # Title
-                self.setFormat(0, 2, self._hStyles["header1h"])
+                self.setFormat(0, 2, self._hStyles["head1h"])
                 self.setFormat(2, len(text), self._hStyles["header1"])
 
             elif text.startswith("##! "):  # Unnumbered
-                self.setFormat(0, 3, self._hStyles["header2h"])
+                self.setFormat(0, 3, self._hStyles["head2h"])
                 self.setFormat(3, len(text), self._hStyles["header2"])
 
+            elif text.startswith("###! "):  # Alternative Scene
+                self.setFormat(0, 4, self._hStyles["head3h"])
+                self.setFormat(4, len(text), self._hStyles["header3"])
+
         elif text.startswith("%"):  # Comments
-            self.setCurrentBlockState(self.BLOCK_TEXT)
+            self.setCurrentBlockState(BLOCK_TEXT)
             cStyle, _, cPos = processComment(text)
             if cStyle == nwComment.PLAIN:
                 self.setFormat(0, len(text), self._hStyles["hidden"])
@@ -353,8 +363,8 @@ class GuiDocHighlighter(QSyntaxHighlighter):
                     return
 
             # Regular Text
-            self.setCurrentBlockState(self.BLOCK_TEXT)
-            for rX, xFmt in self.rxRules:
+            self.setCurrentBlockState(BLOCK_TEXT)
+            for rX, xFmt in self._rxRules:
                 rxItt = rX.globalMatch(text, 0)
                 while rxItt.hasNext():
                     rxMatch = rxItt.next()
@@ -398,16 +408,16 @@ class GuiDocHighlighter(QSyntaxHighlighter):
         if style is not None:
             styles = style.split(",")
             if "bold" in styles:
-                charFormat.setFontWeight(QFont.Bold)
+                charFormat.setFontWeight(QFont.Weight.Bold)
             if "italic" in styles:
                 charFormat.setFontItalic(True)
             if "strike" in styles:
                 charFormat.setFontStrikeOut(True)
             if "errline" in styles:
                 charFormat.setUnderlineColor(SHARED.theme.colError)
-                charFormat.setUnderlineStyle(QTextCharFormat.SpellCheckUnderline)
+                charFormat.setUnderlineStyle(QTextCharFormat.UnderlineStyle.SpellCheckUnderline)
             if "background" in styles and color is not None:
-                charFormat.setBackground(QBrush(color, Qt.SolidPattern))
+                charFormat.setBackground(QBrush(color, Qt.BrushStyle.SolidPattern))
 
         if size is not None:
             charFormat.setFontPointSize(int(round(size*CONFIG.textSize)))
@@ -435,6 +445,17 @@ class TextBlockData(QTextBlockUserData):
         """Run the spell checker and cache the result, and return the
         list of spell check errors.
         """
+        if "[" in text:
+            # Strip shortcodes
+            for rX in [SPELLSC, SPELLSV]:
+                rxItt = rX.globalMatch(text, 0)
+                while rxItt.hasNext():
+                    rxMatch = rxItt.next()
+                    xPos = rxMatch.capturedStart(0)
+                    xLen = rxMatch.capturedLength(0)
+                    xEnd = rxMatch.capturedEnd(0)
+                    text = text[:xPos] + " "*xLen + text[xEnd:]
+
         self._spellErrors = []
         rxSpell = SPELLRX.globalMatch(text.replace("_", " "), 0)
         while rxSpell.hasNext():