novelWriter 2.5.1__py3-none-any.whl → 2.6b1__py3-none-any.whl

novelwriter/dialogs/preferences.py

@@ -34,7 +34,7 @@ from PyQt5.QtWidgets import (
 )
 
 from novelwriter import CONFIG, SHARED
-from novelwriter.common import describeFont, uniqueCompact
+from novelwriter.common import compact, describeFont, uniqueCompact
 from novelwriter.constants import nwUnicode
 from novelwriter.dialogs.quotes import GuiQuoteSelect
 from novelwriter.extensions.configlayout import NColourLabel, NScrollableForm
@@ -133,7 +133,7 @@ class GuiPreferences(NDialog):
         """Build the settings form."""
         section = 0
         iSz = SHARED.theme.baseIconSize
-        boxFixed = 5*SHARED.theme.textNWidth
+        boxFixed = 6*SHARED.theme.textNWidth
         minWidth = CONFIG.pxInt(200)
         fontWidth = CONFIG.pxInt(162)
 
@@ -543,6 +543,23 @@ class GuiPreferences(NDialog):
             self.tr("Applies to the selected quote styles.")
         )
 
+        self.altDialogOpen = QLineEdit(self)
+        self.altDialogOpen.setMaxLength(4)
+        self.altDialogOpen.setFixedWidth(boxFixed)
+        self.altDialogOpen.setAlignment(QtAlignCenter)
+        self.altDialogOpen.setText(CONFIG.altDialogOpen)
+
+        self.altDialogClose = QLineEdit(self)
+        self.altDialogClose.setMaxLength(4)
+        self.altDialogClose.setFixedWidth(boxFixed)
+        self.altDialogClose.setAlignment(QtAlignCenter)
+        self.altDialogClose.setText(CONFIG.altDialogClose)
+
+        self.mainForm.addRow(
+            self.tr("Alternative dialogue symbols"), [self.altDialogOpen, self.altDialogClose],
+            self.tr("Custom highlighting of dialogue text.")
+        )
+
         self.allowOpenDial = NSwitch(self)
         self.allowOpenDial.setChecked(CONFIG.allowOpenDial)
         self.mainForm.addRow(
@@ -550,6 +567,16 @@ class GuiPreferences(NDialog):
             self.tr("Highlight dialogue line with no closing quote.")
         )
 
+        self.dialogLine = QLineEdit(self)
+        self.dialogLine.setMaxLength(4)
+        self.dialogLine.setFixedWidth(boxFixed)
+        self.dialogLine.setAlignment(QtAlignCenter)
+        self.dialogLine.setText(CONFIG.dialogLine)
+        self.mainForm.addRow(
+            self.tr("Dialogue line symbols"), self.dialogLine,
+            self.tr("Lines starting with these symbols are always dialogue.")
+        )
+
         self.narratorBreak = QLineEdit(self)
         self.narratorBreak.setMaxLength(1)
         self.narratorBreak.setFixedWidth(boxFixed)
@@ -557,34 +584,17 @@ class GuiPreferences(NDialog):
         self.narratorBreak.setText(CONFIG.narratorBreak)
         self.mainForm.addRow(
             self.tr("Dialogue narrator break symbol"), self.narratorBreak,
-            self.tr("Symbol to indicate injected narrator break.")
+            self.tr("Symbol to indicate injected narrator break in dialogue")
         )
 
-        self.dialogLine = QLineEdit(self)
-        self.dialogLine.setMaxLength(1)
-        self.dialogLine.setFixedWidth(boxFixed)
-        self.dialogLine.setAlignment(QtAlignCenter)
-        self.dialogLine.setText(CONFIG.dialogLine)
-        self.mainForm.addRow(
-            self.tr("Dialogue line symbol"), self.dialogLine,
-            self.tr("Lines starting with this symbol are dialogue.")
-        )
-
-        self.altDialogOpen = QLineEdit(self)
-        self.altDialogOpen.setMaxLength(4)
-        self.altDialogOpen.setFixedWidth(boxFixed)
-        self.altDialogOpen.setAlignment(QtAlignCenter)
-        self.altDialogOpen.setText(CONFIG.altDialogOpen)
-
-        self.altDialogClose = QLineEdit(self)
-        self.altDialogClose.setMaxLength(4)
-        self.altDialogClose.setFixedWidth(boxFixed)
-        self.altDialogClose.setAlignment(QtAlignCenter)
-        self.altDialogClose.setText(CONFIG.altDialogClose)
-
+        self.narratorDialog = QLineEdit(self)
+        self.narratorDialog.setMaxLength(1)
+        self.narratorDialog.setFixedWidth(boxFixed)
+        self.narratorDialog.setAlignment(QtAlignCenter)
+        self.narratorDialog.setText(CONFIG.narratorDialog)
         self.mainForm.addRow(
-            self.tr("Alternative dialogue symbols"), [self.altDialogOpen, self.altDialogClose],
-            self.tr("Custom highlighting of dialogue text.")
+            self.tr("Alternating dialogue/narration symbol"), self.narratorDialog,
+            self.tr("Alternates dialogue highlighting within any paragraph.")
         )
 
         self.highlightEmph = NSwitch(self)
@@ -952,17 +962,19 @@ class GuiPreferences(NDialog):
         # Text Highlighting
         dialogueStyle   = self.dialogStyle.currentData()
         allowOpenDial   = self.allowOpenDial.isChecked()
+        dialogueLine    = uniqueCompact(self.dialogLine.text())
         narratorBreak   = self.narratorBreak.text().strip()
-        dialogueLine    = self.dialogLine.text().strip()
-        altDialogOpen   = self.altDialogOpen.text()
-        altDialogClose  = self.altDialogClose.text()
+        narratorDialog  = self.narratorDialog.text().strip()
+        altDialogOpen   = compact(self.altDialogOpen.text())
+        altDialogClose  = compact(self.altDialogClose.text())
         highlightEmph   = self.highlightEmph.isChecked()
         showMultiSpaces = self.showMultiSpaces.isChecked()
 
         updateSyntax |= CONFIG.dialogStyle != dialogueStyle
         updateSyntax |= CONFIG.allowOpenDial != allowOpenDial
-        updateSyntax |= CONFIG.narratorBreak != narratorBreak
         updateSyntax |= CONFIG.dialogLine != dialogueLine
+        updateSyntax |= CONFIG.narratorBreak != narratorBreak
+        updateSyntax |= CONFIG.narratorDialog != narratorDialog
         updateSyntax |= CONFIG.altDialogOpen != altDialogOpen
         updateSyntax |= CONFIG.altDialogClose != altDialogClose
         updateSyntax |= CONFIG.highlightEmph != highlightEmph
@@ -970,8 +982,9 @@ class GuiPreferences(NDialog):
 
         CONFIG.dialogStyle     = dialogueStyle
         CONFIG.allowOpenDial   = allowOpenDial
-        CONFIG.narratorBreak   = narratorBreak
         CONFIG.dialogLine      = dialogueLine
+        CONFIG.narratorBreak   = narratorBreak
+        CONFIG.narratorDialog  = narratorDialog
         CONFIG.altDialogOpen   = altDialogOpen
         CONFIG.altDialogClose  = altDialogClose
         CONFIG.highlightEmph   = highlightEmph

novelwriter/dialogs/projectsettings.py

@@ -35,7 +35,7 @@ from PyQt5.QtWidgets import (
 )
 
 from novelwriter import CONFIG, SHARED
-from novelwriter.common import simplified
+from novelwriter.common import qtLambda, simplified
 from novelwriter.constants import nwLabels, trConst
 from novelwriter.core.status import NWStatus, StatusEntry
 from novelwriter.enum import nwStatusShape
@@ -365,10 +365,10 @@ class _StatusPage(NFixedPage):
         self.delButton.clicked.connect(self._delItem)
 
         self.upButton = NIconToolButton(self, iSz, "up")
-        self.upButton.clicked.connect(lambda: self._moveItem(-1))
+        self.upButton.clicked.connect(qtLambda(self._moveItem, -1))
 
         self.dnButton = NIconToolButton(self, iSz, "down")
-        self.dnButton.clicked.connect(lambda: self._moveItem(1))
+        self.dnButton.clicked.connect(qtLambda(self._moveItem, 1))
 
         # Edit Form
         self.editName = QLineEdit(self)

novelwriter/enum.py

@@ -137,6 +137,7 @@ class nwDocInsert(Enum):
     VSPACE_M  = 9
     LIPSUM    = 10
     FOOTNOTE  = 11
+    LINE_BRK  = 12
 
 
 class nwView(Enum):
@@ -157,35 +158,40 @@ class nwFocus(Enum):
 
 class nwOutline(Enum):
 
-    TITLE  = 0
-    LEVEL  = 1
-    LABEL  = 2
-    LINE   = 3
-    CCOUNT = 4
-    WCOUNT = 5
-    PCOUNT = 6
-    POV    = 7
-    FOCUS  = 8
-    CHAR   = 9
-    PLOT   = 10
-    TIME   = 11
-    WORLD  = 12
-    OBJECT = 13
-    ENTITY = 14
-    CUSTOM = 15
-    SYNOP  = 16
+    TITLE   = 0
+    LEVEL   = 1
+    LABEL   = 2
+    LINE    = 3
+    STATUS  = 4
+    CCOUNT  = 5
+    WCOUNT  = 6
+    PCOUNT  = 7
+    POV     = 8
+    FOCUS   = 9
+    CHAR    = 10
+    PLOT    = 11
+    TIME    = 12
+    WORLD   = 13
+    OBJECT  = 14
+    ENTITY  = 15
+    CUSTOM  = 16
+    STORY   = 17
+    MENTION = 18
+    SYNOP   = 19
 
 
 class nwBuildFmt(Enum):
 
     ODT    = 0
     FODT   = 1
-    HTML   = 2
-    NWD    = 3
-    STD_MD = 4
-    EXT_MD = 5
-    J_HTML = 6
-    J_NWD  = 7
+    DOCX   = 2
+    PDF    = 3
+    HTML   = 4
+    STD_MD = 5
+    EXT_MD = 6
+    NWD    = 7
+    J_HTML = 8
+    J_NWD  = 9
 
 
 class nwStatusShape(Enum):

novelwriter/extensions/configlayout.py

@@ -27,7 +27,6 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtCore import Qt
 from PyQt5.QtGui import QColor, QFont, QPalette
 from PyQt5.QtWidgets import (
     QAbstractButton, QFrame, QHBoxLayout, QLabel, QLayout, QScrollArea,
@@ -35,6 +34,7 @@ from PyQt5.QtWidgets import (
 )
 
 from novelwriter import CONFIG
+from novelwriter.types import QtScrollAsNeeded
 
 DEFAULT_SCALE = 0.9
 
@@ -76,8 +76,8 @@ class NScrollablePage(QScrollArea):
         self._widget = QWidget(self)
         self.setWidget(self._widget)
         self.setWidgetResizable(True)
-        self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
-        self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+        self.setHorizontalScrollBarPolicy(QtScrollAsNeeded)
+        self.setVerticalScrollBarPolicy(QtScrollAsNeeded)
         self.setFrameShadow(QFrame.Shadow.Sunken)
         self.setFrameShape(QFrame.Shape.StyledPanel)
         return
@@ -113,8 +113,8 @@ class NScrollableForm(QScrollArea):
 
         self.setWidget(self._widget)
         self.setWidgetResizable(True)
-        self.setHorizontalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
-        self.setVerticalScrollBarPolicy(Qt.ScrollBarPolicy.ScrollBarAsNeeded)
+        self.setHorizontalScrollBarPolicy(QtScrollAsNeeded)
+        self.setVerticalScrollBarPolicy(QtScrollAsNeeded)
         self.setFrameShadow(QFrame.Shadow.Sunken)
         self.setFrameShape(QFrame.Shape.StyledPanel)
 
@@ -180,9 +180,16 @@ class NScrollableForm(QScrollArea):
             self._sections[identifier] = qLabel
         return
 
-    def addRow(self, label: str, widget: QWidget | list[QWidget], helpText: str = "",
-               unit: str | None = None, button: QWidget | None = None, editable: str | None = None,
-               stretch: tuple[int, int] = (1, 0)) -> None:
+    def addRow(
+        self,
+        label: str | None,
+        widget: QWidget | list[QWidget | str | int],
+        helpText: str = "",
+        unit: str | None = None,
+        button: QWidget | None = None,
+        editable: str | None = None,
+        stretch: tuple[int, int] = (1, 0),
+    ) -> None:
         """Add a label and a widget as a new row of the form."""
         row = QHBoxLayout()
         row.setSpacing(CONFIG.pxInt(12))
@@ -191,13 +198,18 @@ class NScrollableForm(QScrollArea):
             wBox = QHBoxLayout()
             wBox.setContentsMargins(0, 0, 0, 0)
             for item in widget:
-                wBox.addWidget(item)
+                if isinstance(item, QWidget):
+                    wBox.addWidget(item)
+                elif isinstance(item, str):
+                    wBox.addWidget(QLabel(item, self))
+                elif isinstance(item, int):
+                    wBox.addSpacing(CONFIG.pxInt(item))
             qWidget = QWidget(self)
             qWidget.setLayout(wBox)
         else:
             qWidget = widget
 
-        qLabel = QLabel(label, self)
+        qLabel = QLabel(label or "", self)
         qLabel.setIndent(self._indent)
         qLabel.setBuddy(qWidget)
 
@@ -230,7 +242,8 @@ class NScrollableForm(QScrollArea):
             row.addWidget(qWidget, stretch[1])
 
         self._layout.addLayout(row)
-        self._index[label.strip()] = qWidget
+        if label:
+            self._index[label.strip()] = qWidget
         self._first = False
 
         return

novelwriter/extensions/modified.py

@@ -136,9 +136,21 @@ class NSpinBox(QSpinBox):
 
 class NDoubleSpinBox(QDoubleSpinBox):
 
-    def __init__(self, parent: QWidget | None = None) -> None:
+    def __init__(
+        self,
+        parent: QWidget | None = None,
+        *,
+        min: float = 0.0,
+        max: float = 15.0,
+        step: float = 0.1,
+        prec: int = 2,
+    ) -> None:
         super().__init__(parent=parent)
         self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
+        self.setMinimum(min)
+        self.setMaximum(max)
+        self.setSingleStep(step)
+        self.setDecimals(prec)
         return
 
     def wheelEvent(self, event: QWheelEvent) -> None:

novelwriter/extensions/pagedsidebar.py

@@ -52,7 +52,7 @@ class NPagedSideBar(QToolBar):
 
         self._labelCol = None
         self._spacerHeight = self.fontMetrics().height() // 2
-        self._buttons: dict[int, _NPagedToolButton] = {}
+        self._buttons: dict[int, _PagedToolButton] = {}
 
         self._group = QButtonGroup(self)
         self._group.setExclusive(True)
@@ -67,7 +67,7 @@ class NPagedSideBar(QToolBar):
 
         return
 
-    def button(self, buttonId: int) -> _NPagedToolButton:
+    def button(self, buttonId: int) -> _PagedToolButton:
         """Return a specific button."""
         return self._buttons[buttonId]
 
@@ -85,7 +85,7 @@ class NPagedSideBar(QToolBar):
 
     def addButton(self, text: str, buttonId: int = -1) -> QAction:
         """Add a new button to the toolbar."""
-        button = _NPagedToolButton(self)
+        button = _PagedToolButton(self)
         button.setText(text)
 
         action = self.insertWidget(self._stretchAction, button)
@@ -113,7 +113,7 @@ class NPagedSideBar(QToolBar):
         return
 
 
-class _NPagedToolButton(QToolButton):
+class _PagedToolButton(QToolButton):
 
     __slots__ = ("_bH", "_tM", "_lM", "_cR", "_aH")
 
@@ -154,7 +154,7 @@ class _NPagedToolButton(QToolButton):
         height = self.height()
         palette = self.palette()
 
-        if opt.state & QtMouseOver == QtMouseOver:
+        if opt.state & QtMouseOver == QtMouseOver:  # pragma: no cover
             backCol = palette.base()
             paint.setBrush(backCol)
             paint.setOpacity(0.75)

novelwriter/formats/shared.py

@@ -0,0 +1,155 @@
+"""
+novelWriter – Formats Shared
+============================
+
+File History:
+Created: 2024-10-21 [2.6b1]
+
+This file is a part of novelWriter
+Copyright 2018–2024, Veronica Berglyd Olsen
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+"""
+from __future__ import annotations
+
+import re
+
+from enum import Flag, IntEnum
+
+from PyQt5.QtGui import QColor
+
+ESCAPES = {r"\*": "*", r"\~": "~", r"\_": "_", r"\[": "[", r"\]": "]", r"\ ": ""}
+RX_ESC = re.compile("|".join([re.escape(k) for k in ESCAPES.keys()]), flags=re.DOTALL)
+
+
+def stripEscape(text: str) -> str:
+    """Strip escaped Markdown characters from paragraph text."""
+    if "\\" in text:
+        return RX_ESC.sub(lambda x: ESCAPES[x.group(0)], text)
+    return text
+
+
+class TextDocumentTheme:
+    """Default document theme."""
+
+    text:      QColor = QColor(0, 0, 0)
+    highlight: QColor = QColor(255, 255, 166)
+    head:      QColor = QColor(66, 113, 174)
+    link:      QColor = QColor(66, 113, 174)
+    comment:   QColor = QColor(100, 100, 100)
+    note:      QColor = QColor(129, 55, 9)
+    code:      QColor = QColor(66, 113, 174)
+    modifier:  QColor = QColor(129, 55, 9)
+    keyword:   QColor = QColor(245, 135, 31)
+    tag:       QColor = QColor(66, 113, 174)
+    optional:  QColor = QColor(66, 113, 174)
+    dialog:    QColor = QColor(66, 113, 174)
+    altdialog: QColor = QColor(129, 55, 9)
+
+
+# Enums
+# =====
+
+class TextFmt(IntEnum):
+    """Text Format.
+
+    An enum indicating the beginning or end of a text format region.
+    They must be paired with a position, and apply to locations in a
+    text block.
+    """
+
+    B_B   = 1   # Begin bold
+    B_E   = 2   # End bold
+    I_B   = 3   # Begin italics
+    I_E   = 4   # End italics
+    D_B   = 5   # Begin strikeout
+    D_E   = 6   # End strikeout
+    U_B   = 7   # Begin underline
+    U_E   = 8   # End underline
+    M_B   = 9   # Begin mark
+    M_E   = 10  # End mark
+    SUP_B = 11  # Begin superscript
+    SUP_E = 12  # End superscript
+    SUB_B = 13  # Begin subscript
+    SUB_E = 14  # End subscript
+    COL_B = 15  # Begin colour
+    COL_E = 16  # End colour
+    ANM_B = 17  # Begin anchor name
+    ANM_E = 18  # End anchor name
+    ARF_B = 19  # Begin anchor link
+    ARF_E = 20  # End anchor link
+    HRF_B = 21  # Begin href link
+    HRF_E = 22  # End href link
+    FNOTE = 23  # Footnote marker
+    FIELD = 24  # Data field
+    STRIP = 25  # Strip the format code
+
+
+class BlockTyp(IntEnum):
+    """Text Block Type.
+
+    An enum indicating the type of a text block.
+    """
+
+    EMPTY   = 1   # Empty line (new paragraph)
+    TITLE   = 2   # Title
+    HEAD1   = 3   # Heading 1
+    HEAD2   = 4   # Heading 2
+    HEAD3   = 5   # Heading 3
+    HEAD4   = 6   # Heading 4
+    TEXT    = 7   # Text line
+    SEP     = 8   # Scene separator
+    SKIP    = 9   # Paragraph break
+    SUMMARY = 10  # Synopsis/short comment
+    NOTE    = 11  # Note
+    COMMENT = 12  # Comment
+    KEYWORD = 13  # Tag/reference keywords
+
+
+class BlockFmt(Flag):
+    """Text Block Format.
+
+    An enum of flags that can be combined to format a text block.
+    """
+
+    NONE    = 0x0000  # No special style
+    LEFT    = 0x0001  # Left aligned
+    RIGHT   = 0x0002  # Right aligned
+    CENTRE  = 0x0004  # Centred
+    JUSTIFY = 0x0008  # Justified
+    PBB     = 0x0010  # Page break before
+    PBA     = 0x0020  # Page break after
+    Z_TOP   = 0x0040  # Zero top margin
+    Z_BTM   = 0x0080  # Zero bottom margin
+    IND_L   = 0x0100  # Left indentation
+    IND_R   = 0x0200  # Right indentation
+    IND_T   = 0x0400  # Text indentation
+
+    # Masks
+    ALIGNED = LEFT | RIGHT | CENTRE | JUSTIFY
+
+
+# Types
+# =====
+
+# A list of formats for a single text string, consisting of:
+# text position, text format, and meta data
+T_Formats = list[tuple[int, TextFmt, str]]
+
+# A note or comment with text and associated text formats
+T_Note = tuple[str, T_Formats]
+
+# A tokenized text block, consisting of:
+# type, header number, text, text formats, and block format
+T_Block = tuple[BlockTyp, str, str, T_Formats, BlockFmt]