Veronica Berglyd Olsen
f6845a9820
* Delete simple spell checker * Clean up the spell checker code * Update tests * Delete the bundled dictionaries * Update documentation * Use set() for user word list * Fix tests so they pass also without dictionaries installed
431 lines
16 KiB
Python
431 lines
16 KiB
Python
"""
|
||
novelWriter – Constants
|
||
=======================
|
||
Constants and maps for translating flags and enums to text
|
||
|
||
File History:
|
||
Created: 2019-04-28 [0.0.1]
|
||
|
||
This file is a part of novelWriter
|
||
Copyright 2018–2021, 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 PyQt5.QtCore import QCoreApplication, QT_TRANSLATE_NOOP
|
||
|
||
from novelwriter.enum import nwItemClass, nwItemLayout, nwItemType, nwOutline
|
||
|
||
|
||
def trConst(tString):
|
||
"""Wrapper function for locally translating constants.
|
||
"""
|
||
return QCoreApplication.translate("Constant", tString)
|
||
|
||
|
||
class nwConst():
|
||
|
||
# Date and Time Formats
|
||
FMT_TSTAMP = "%Y-%m-%d %H:%M:%S" # Default format
|
||
FMT_FSTAMP = "%Y-%m-%d %H.%M.%S" # FileName safe format
|
||
FMT_DSTAMP = "%Y-%m-%d" # Date only format
|
||
|
||
# Various Hard Limits
|
||
MAX_DEPTH = 30 # Maximum folder depth of a project
|
||
MAX_DOCSIZE = 5000000 # Maxium size of a single document
|
||
MAX_BUILDSIZE = 10000000 # Maxium size of a project build
|
||
|
||
# END Class nwConst
|
||
|
||
|
||
class nwLists():
|
||
"""Lists used for grouping various other constants.
|
||
"""
|
||
# Regular user-accessible item types
|
||
REG_TYPES = {nwItemType.ROOT, nwItemType.FOLDER, nwItemType.FILE}
|
||
|
||
# Item classes where the full list of novel layouts are allowed
|
||
CLS_NOVEL = {nwItemClass.NOVEL, nwItemClass.ARCHIVE}
|
||
|
||
# Item classes which do not require items to have same class
|
||
FREE_CLASS = {nwItemClass.ARCHIVE, nwItemClass.TRASH}
|
||
|
||
# Deprecated nwItemLayout entries
|
||
DEP_LAYOUT = ("TITLE", "PAGE", "BOOK", "PARTITION", "UNNUMBERED", "CHAPTER", "SCENE")
|
||
|
||
# END Class nwLists
|
||
|
||
|
||
class nwRegEx():
|
||
|
||
FMT_EI = r"(?<![\w\\])(_)(?![\s_])(.+?)(?<![\s\\])(\1)(?!\w)"
|
||
FMT_EB = r"(?<![\w\\])([\*]{2})(?![\s\*])(.+?)(?<![\s\\])(\1)(?!\w)"
|
||
FMT_ST = r"(?<![\w\\])([~]{2})(?![\s~])(.+?)(?<![\s\\])(\1)(?!\w)"
|
||
|
||
# END Class nwRegEx
|
||
|
||
|
||
class nwFiles():
|
||
|
||
PROJ_FILE = "nwProject.nwx"
|
||
PROJ_DICT = "wordlist.txt"
|
||
PROJ_LOCK = "nwProject.lock"
|
||
TOC_TXT = "ToC.txt"
|
||
SESS_STATS = "sessionStats.log"
|
||
INDEX_FILE = "tagsIndex.json"
|
||
OPTS_FILE = "guiOptions.json"
|
||
RECENT_FILE = "recentProjects.json"
|
||
BUILD_CACHE = "prevBuild.json"
|
||
|
||
# END Class nwFiles
|
||
|
||
|
||
class nwKeyWords:
|
||
|
||
TAG_KEY = "@tag"
|
||
POV_KEY = "@pov"
|
||
FOCUS_KEY = "@focus"
|
||
CHAR_KEY = "@char"
|
||
PLOT_KEY = "@plot"
|
||
TIME_KEY = "@time"
|
||
WORLD_KEY = "@location"
|
||
OBJECT_KEY = "@object"
|
||
ENTITY_KEY = "@entity"
|
||
CUSTOM_KEY = "@custom"
|
||
|
||
# Set of Valid Keys
|
||
VALID_KEYS = {
|
||
TAG_KEY, POV_KEY, FOCUS_KEY, CHAR_KEY, PLOT_KEY, TIME_KEY,
|
||
WORLD_KEY, OBJECT_KEY, ENTITY_KEY, CUSTOM_KEY
|
||
}
|
||
|
||
# Map from Keys to Item Class
|
||
KEY_CLASS = {
|
||
POV_KEY: nwItemClass.CHARACTER,
|
||
FOCUS_KEY: nwItemClass.CHARACTER,
|
||
CHAR_KEY: nwItemClass.CHARACTER,
|
||
PLOT_KEY: nwItemClass.PLOT,
|
||
TIME_KEY: nwItemClass.TIMELINE,
|
||
WORLD_KEY: nwItemClass.WORLD,
|
||
OBJECT_KEY: nwItemClass.OBJECT,
|
||
ENTITY_KEY: nwItemClass.ENTITY,
|
||
CUSTOM_KEY: nwItemClass.CUSTOM,
|
||
}
|
||
|
||
# END Class nwKeyWords
|
||
|
||
|
||
class nwLabels():
|
||
|
||
CLASS_NAME = {
|
||
nwItemClass.NO_CLASS: QT_TRANSLATE_NOOP("Constant", "None"),
|
||
nwItemClass.NOVEL: QT_TRANSLATE_NOOP("Constant", "Novel"),
|
||
nwItemClass.PLOT: QT_TRANSLATE_NOOP("Constant", "Plot"),
|
||
nwItemClass.CHARACTER: QT_TRANSLATE_NOOP("Constant", "Characters"),
|
||
nwItemClass.WORLD: QT_TRANSLATE_NOOP("Constant", "Locations"),
|
||
nwItemClass.TIMELINE: QT_TRANSLATE_NOOP("Constant", "Timeline"),
|
||
nwItemClass.OBJECT: QT_TRANSLATE_NOOP("Constant", "Objects"),
|
||
nwItemClass.ENTITY: QT_TRANSLATE_NOOP("Constant", "Entity"),
|
||
nwItemClass.CUSTOM: QT_TRANSLATE_NOOP("Constant", "Custom"),
|
||
nwItemClass.ARCHIVE: QT_TRANSLATE_NOOP("Constant", "Outtakes"),
|
||
nwItemClass.TRASH: QT_TRANSLATE_NOOP("Constant", "Trash"),
|
||
}
|
||
CLASS_ICON = {
|
||
nwItemClass.NO_CLASS: "cls_none",
|
||
nwItemClass.NOVEL: "cls_novel",
|
||
nwItemClass.PLOT: "cls_plot",
|
||
nwItemClass.CHARACTER: "cls_character",
|
||
nwItemClass.WORLD: "cls_world",
|
||
nwItemClass.TIMELINE: "cls_timeline",
|
||
nwItemClass.OBJECT: "cls_object",
|
||
nwItemClass.ENTITY: "cls_entity",
|
||
nwItemClass.CUSTOM: "cls_custom",
|
||
nwItemClass.ARCHIVE: "cls_archive",
|
||
nwItemClass.TRASH: "cls_trash",
|
||
}
|
||
LAYOUT_NAME = {
|
||
nwItemLayout.NO_LAYOUT: QT_TRANSLATE_NOOP("Constant", "None"),
|
||
nwItemLayout.DOCUMENT: QT_TRANSLATE_NOOP("Constant", "Novel Document"),
|
||
nwItemLayout.NOTE: QT_TRANSLATE_NOOP("Constant", "Project Note"),
|
||
}
|
||
ITEM_DESCRIPTION = {
|
||
"none": QT_TRANSLATE_NOOP("Constant", "None"),
|
||
"root": QT_TRANSLATE_NOOP("Constant", "Root Folder"),
|
||
"folder": QT_TRANSLATE_NOOP("Constant", "Folder"),
|
||
"document": QT_TRANSLATE_NOOP("Constant", "Novel Document"),
|
||
"doc_h1": QT_TRANSLATE_NOOP("Constant", "Novel Title Page"),
|
||
"doc_h2": QT_TRANSLATE_NOOP("Constant", "Novel Chapter"),
|
||
"doc_h3": QT_TRANSLATE_NOOP("Constant", "Novel Scene"),
|
||
"note": QT_TRANSLATE_NOOP("Constant", "Project Note"),
|
||
}
|
||
KEY_NAME = {
|
||
nwKeyWords.TAG_KEY: QT_TRANSLATE_NOOP("Constant", "Tag"),
|
||
nwKeyWords.POV_KEY: QT_TRANSLATE_NOOP("Constant", "Point of View"),
|
||
nwKeyWords.FOCUS_KEY: QT_TRANSLATE_NOOP("Constant", "Focus"),
|
||
nwKeyWords.CHAR_KEY: QT_TRANSLATE_NOOP("Constant", "Characters"),
|
||
nwKeyWords.PLOT_KEY: QT_TRANSLATE_NOOP("Constant", "Plot"),
|
||
nwKeyWords.TIME_KEY: QT_TRANSLATE_NOOP("Constant", "Timeline"),
|
||
nwKeyWords.WORLD_KEY: QT_TRANSLATE_NOOP("Constant", "Locations"),
|
||
nwKeyWords.OBJECT_KEY: QT_TRANSLATE_NOOP("Constant", "Objects"),
|
||
nwKeyWords.ENTITY_KEY: QT_TRANSLATE_NOOP("Constant", "Entities"),
|
||
nwKeyWords.CUSTOM_KEY: QT_TRANSLATE_NOOP("Constant", "Custom"),
|
||
}
|
||
OUTLINE_COLS = {
|
||
nwOutline.TITLE: QT_TRANSLATE_NOOP("Constant", "Title"),
|
||
nwOutline.LEVEL: QT_TRANSLATE_NOOP("Constant", "Level"),
|
||
nwOutline.LABEL: QT_TRANSLATE_NOOP("Constant", "Document"),
|
||
nwOutline.LINE: QT_TRANSLATE_NOOP("Constant", "Line"),
|
||
nwOutline.CCOUNT: QT_TRANSLATE_NOOP("Constant", "Chars"),
|
||
nwOutline.WCOUNT: QT_TRANSLATE_NOOP("Constant", "Words"),
|
||
nwOutline.PCOUNT: QT_TRANSLATE_NOOP("Constant", "Pars"),
|
||
nwOutline.POV: QT_TRANSLATE_NOOP("Constant", "POV"),
|
||
nwOutline.FOCUS: QT_TRANSLATE_NOOP("Constant", "Focus"),
|
||
nwOutline.CHAR: KEY_NAME[nwKeyWords.CHAR_KEY],
|
||
nwOutline.PLOT: KEY_NAME[nwKeyWords.PLOT_KEY],
|
||
nwOutline.TIME: KEY_NAME[nwKeyWords.TIME_KEY],
|
||
nwOutline.WORLD: KEY_NAME[nwKeyWords.WORLD_KEY],
|
||
nwOutline.OBJECT: KEY_NAME[nwKeyWords.OBJECT_KEY],
|
||
nwOutline.ENTITY: KEY_NAME[nwKeyWords.ENTITY_KEY],
|
||
nwOutline.CUSTOM: KEY_NAME[nwKeyWords.CUSTOM_KEY],
|
||
nwOutline.SYNOP: QT_TRANSLATE_NOOP("Constant", "Synopsis"),
|
||
}
|
||
|
||
# END Class nwLabels
|
||
|
||
|
||
class nwQuotes():
|
||
"""Allowed quotation marks.
|
||
Source: https://en.wikipedia.org/wiki/Quotation_mark
|
||
"""
|
||
SYMBOLS = {
|
||
"\u0027": QT_TRANSLATE_NOOP("Constant", "Straight single quotation mark"),
|
||
"\u0022": QT_TRANSLATE_NOOP("Constant", "Straight double quotation mark"),
|
||
|
||
"\u2018": QT_TRANSLATE_NOOP("Constant", "Left single quotation mark"),
|
||
"\u2019": QT_TRANSLATE_NOOP("Constant", "Right single quotation mark"),
|
||
"\u201a": QT_TRANSLATE_NOOP("Constant", "Single low-9 quotation mark"),
|
||
"\u201b": QT_TRANSLATE_NOOP("Constant", "Single high-reversed-9 quotation mark"),
|
||
"\u201c": QT_TRANSLATE_NOOP("Constant", "Left double quotation mark"),
|
||
"\u201d": QT_TRANSLATE_NOOP("Constant", "Right double quotation mark"),
|
||
"\u201e": QT_TRANSLATE_NOOP("Constant", "Double low-9 quotation mark"),
|
||
"\u201f": QT_TRANSLATE_NOOP("Constant", "Double high-reversed-9 quotation mark"),
|
||
"\u2e42": QT_TRANSLATE_NOOP("Constant", "Double low-reversed-9 quotation mark"),
|
||
|
||
"\u2039": QT_TRANSLATE_NOOP("Constant", "Single left-pointing angle quotation mark"),
|
||
"\u203a": QT_TRANSLATE_NOOP("Constant", "Single right-pointing angle quotation mark"),
|
||
"\u00ab": QT_TRANSLATE_NOOP("Constant", "Double left-pointing angle quotation mark"),
|
||
"\u00bb": QT_TRANSLATE_NOOP("Constant", "Double right-pointing angle quotation mark"),
|
||
|
||
"\u300c": QT_TRANSLATE_NOOP("Constant", "Left corner bracket"),
|
||
"\u300d": QT_TRANSLATE_NOOP("Constant", "Right corner bracket"),
|
||
"\u300e": QT_TRANSLATE_NOOP("Constant", "Left white corner bracket"),
|
||
"\u300f": QT_TRANSLATE_NOOP("Constant", "Right white corner bracket"),
|
||
}
|
||
|
||
# END Class nwQuotes
|
||
|
||
|
||
class nwUnicode:
|
||
"""Supported unicode character constants and their HTML equivalents.
|
||
"""
|
||
# Unicode Constants
|
||
# =================
|
||
|
||
# Quotation Marks
|
||
U_QUOT = "\u0022" # Quotation mark
|
||
U_APOS = "\u0027" # Apostrophe
|
||
U_LAQUO = "\u00ab" # Left-pointing double angle quotation mark
|
||
U_RAQUO = "\u00bb" # Right-pointing double angle quotation mark
|
||
U_LSQUO = "\u2018" # Left single quotation mark
|
||
U_RSQUO = "\u2019" # Right single quotation mark
|
||
U_SBQUO = "\u201a" # Single low-9 quotation mark
|
||
U_SUQUO = "\u201b" # Single high-reversed-9 quotation mark
|
||
U_LDQUO = "\u201c" # Left double quotation mark
|
||
U_RDQUO = "\u201d" # Right double quotation mark
|
||
U_BDQUO = "\u201e" # Double low-9 quotation mark
|
||
U_UDQUO = "\u201f" # Double high-reversed-9 quotation mark
|
||
U_LSAQUO = "\u2039" # Single left-pointing angle quotation mark
|
||
U_RSAQUO = "\u203a" # Single right-pointing angle quotation mark
|
||
U_BDRQUO = "\u2e42" # Double low-reversed-9 quotation mark
|
||
U_LCQUO = "\u300c" # Left corner bracket
|
||
U_RCQUO = "\u300d" # Right corner bracket
|
||
U_LWCQUO = "\u300e" # Left white corner bracket
|
||
U_RWCQUO = "\u300f" # Right white corner bracket
|
||
|
||
# Punctuation
|
||
U_FGDASH = "\u2012" # Figure dash
|
||
U_ENDASH = "\u2013" # Short dash
|
||
U_EMDASH = "\u2014" # Long dash
|
||
U_HBAR = "\u2015" # Horizontal bar
|
||
U_HELLIP = "\u2026" # Ellipsis
|
||
U_MAPOSS = "\u02bc" # Modifier letter single apostrophe
|
||
U_PRIME = "\u2032" # Prime
|
||
U_DPRIME = "\u2033" # Double prime
|
||
|
||
# Spaces and Lines
|
||
U_NBSP = "\u00a0" # Non-breaking space
|
||
U_THSP = "\u2009" # Thin space
|
||
U_THNBSP = "\u202f" # Thin non-breaking space
|
||
U_ENSP = "\u2002" # Short (en) space
|
||
U_EMSP = "\u2003" # Long (em) space
|
||
U_LSEP = "\u2028" # Line separator
|
||
U_PSEP = "\u2029" # Paragraph separator
|
||
|
||
# Symbols
|
||
U_CHECK = "\u2714" # Heavy check mark
|
||
U_CROSS = "\u2715" # Heavy cross mark
|
||
U_BULL = "\u2022" # List bullet
|
||
U_TRBULL = "\u2023" # Triangle bullet
|
||
U_HYBULL = "\u2043" # Hyphen bullet
|
||
U_FLOWER = "\u2055" # Flower punctuation mark
|
||
U_PERMIL = "\u2030" # Per mille sign
|
||
U_DEGREE = "\u00b0" # Degree symbol
|
||
U_MINUS = "\u2212" # Minus sign
|
||
U_TIMES = "\u00d7" # Multiplaction sign
|
||
U_DIVIDE = "\u00f7" # Division sign
|
||
|
||
# Arrows
|
||
U_UTRI = "\u25b2" # Up-pointing triangle
|
||
U_UTRIS = "\u25b4" # Up-pointing triangle, small
|
||
U_RTRI = "\u25b6" # Right-pointing triangle
|
||
U_RTRIS = "\u25b8" # Right-pointing triangle, small
|
||
U_DTRI = "\u25bc" # Down-pointing triangle
|
||
U_DTRIS = "\u25be" # Down-pointing triangle, small
|
||
U_LTRI = "\u25c0" # Left-pointing triangle
|
||
U_LTRIS = "\u25c2" # Left-pointing triangle, small
|
||
|
||
# HTML Equivalents
|
||
# ================
|
||
|
||
# Quotes
|
||
H_QUOT = """
|
||
H_APOS = "'"
|
||
H_LAQUO = "«"
|
||
H_RAQUO = "»"
|
||
H_LSQUO = "‘"
|
||
H_RSQUO = "’"
|
||
H_SBQUO = "‚"
|
||
H_SUQUO = "‛"
|
||
H_LDQUO = "“"
|
||
H_RDQUO = "”"
|
||
H_BDQUO = "„"
|
||
H_UDQUO = "‟"
|
||
H_LSAQUO = "‹"
|
||
H_RSAQUO = "›"
|
||
H_BDRQUO = "⹂"
|
||
H_LCQUO = "「"
|
||
H_RCQUO = "」"
|
||
H_LWCQUO = "『"
|
||
H_RWCQUO = "』"
|
||
|
||
# Punctuation
|
||
H_FGDASH = "‒"
|
||
H_ENDASH = "–"
|
||
H_EMDASH = "—"
|
||
H_HBAR = "―"
|
||
H_HELLIP = "…"
|
||
H_MAPOSS = "ʼ"
|
||
H_PRIME = "′"
|
||
H_DPRIME = "″"
|
||
|
||
# Spaces
|
||
H_NBSP = " "
|
||
H_THSP = " "
|
||
H_THNBSP = " "
|
||
H_ENSP = " "
|
||
H_EMSP = " "
|
||
|
||
# Symbols
|
||
H_CHECK = "✔"
|
||
H_CROSS = "✕"
|
||
H_BULL = "•"
|
||
H_TRBULL = "‣"
|
||
H_HYBULL = "⁃"
|
||
H_FLOWER = "⁕"
|
||
H_PERMIL = "‰"
|
||
H_DEGREE = "°"
|
||
H_MINUS = "−"
|
||
H_TIMES = "×"
|
||
H_DIVIDE = "÷"
|
||
|
||
# Arrows
|
||
H_UTRI = "▲"
|
||
H_UTRIS = "▴"
|
||
H_RTRI = "▶"
|
||
H_RTRIS = "▸"
|
||
H_DTRI = "▼"
|
||
H_DTRIS = "▾"
|
||
H_LTRI = "◀"
|
||
H_LTRIS = "◂"
|
||
|
||
# END Class nwUnicode
|
||
|
||
|
||
class nwHtmlUnicode():
|
||
|
||
U_TO_H = {
|
||
# Quotes
|
||
nwUnicode.U_QUOT: nwUnicode.H_QUOT,
|
||
nwUnicode.U_APOS: nwUnicode.H_APOS,
|
||
nwUnicode.U_LAQUO: nwUnicode.H_LAQUO,
|
||
nwUnicode.U_RAQUO: nwUnicode.H_RAQUO,
|
||
nwUnicode.U_LSQUO: nwUnicode.H_LSQUO,
|
||
nwUnicode.U_RSQUO: nwUnicode.H_RSQUO,
|
||
nwUnicode.U_SBQUO: nwUnicode.H_SBQUO,
|
||
nwUnicode.U_SUQUO: nwUnicode.H_SUQUO,
|
||
nwUnicode.U_LDQUO: nwUnicode.H_LDQUO,
|
||
nwUnicode.U_RDQUO: nwUnicode.H_RDQUO,
|
||
nwUnicode.U_BDQUO: nwUnicode.H_BDQUO,
|
||
nwUnicode.U_UDQUO: nwUnicode.H_UDQUO,
|
||
nwUnicode.U_LSAQUO: nwUnicode.H_LSAQUO,
|
||
nwUnicode.U_RSAQUO: nwUnicode.H_RSAQUO,
|
||
nwUnicode.U_BDRQUO: nwUnicode.H_BDRQUO,
|
||
nwUnicode.U_LCQUO: nwUnicode.H_LCQUO,
|
||
nwUnicode.U_RCQUO: nwUnicode.H_RCQUO,
|
||
nwUnicode.U_LWCQUO: nwUnicode.H_LWCQUO,
|
||
nwUnicode.U_RWCQUO: nwUnicode.H_RWCQUO,
|
||
|
||
# Punctuation
|
||
nwUnicode.U_FGDASH: nwUnicode.H_FGDASH,
|
||
nwUnicode.U_ENDASH: nwUnicode.H_ENDASH,
|
||
nwUnicode.U_EMDASH: nwUnicode.H_EMDASH,
|
||
nwUnicode.U_HBAR: nwUnicode.H_HBAR,
|
||
nwUnicode.U_HELLIP: nwUnicode.H_HELLIP,
|
||
nwUnicode.U_MAPOSS: nwUnicode.H_MAPOSS,
|
||
nwUnicode.U_PRIME: nwUnicode.H_PRIME,
|
||
nwUnicode.U_DPRIME: nwUnicode.H_DPRIME,
|
||
|
||
# Spaces
|
||
nwUnicode.U_NBSP: nwUnicode.H_NBSP,
|
||
nwUnicode.U_THSP: nwUnicode.H_THSP,
|
||
nwUnicode.U_THNBSP: nwUnicode.H_THNBSP,
|
||
nwUnicode.U_ENSP: nwUnicode.H_ENSP,
|
||
nwUnicode.U_EMSP: nwUnicode.H_EMSP,
|
||
|
||
# Symbols
|
||
nwUnicode.U_CHECK: nwUnicode.H_CHECK,
|
||
nwUnicode.U_CROSS: nwUnicode.H_CROSS,
|
||
nwUnicode.U_BULL: nwUnicode.H_BULL,
|
||
nwUnicode.U_TRBULL: nwUnicode.H_TRBULL,
|
||
nwUnicode.U_HYBULL: nwUnicode.H_HYBULL,
|
||
nwUnicode.U_FLOWER: nwUnicode.H_FLOWER,
|
||
nwUnicode.U_PERMIL: nwUnicode.H_PERMIL,
|
||
nwUnicode.U_DEGREE: nwUnicode.H_DEGREE,
|
||
nwUnicode.U_MINUS: nwUnicode.H_MINUS,
|
||
nwUnicode.U_TIMES: nwUnicode.H_TIMES,
|
||
nwUnicode.U_DIVIDE: nwUnicode.H_DIVIDE,
|
||
}
|
||
|
||
# END Class nwHtmlUnicode
|