support spell check (#1754)

src/core/configmgr.cpp

@@ -219,6 +219,12 @@ void ConfigMgr::checkAppConfig()
     FileUtils::copyDir(extraDataRoot + QStringLiteral("/web"),
                        appConfigDir.filePath(QStringLiteral("web")));
 
+    // Copy dicts.
+    qApp->processEvents();
+    splash->showMessage("Copying dicts");
+    FileUtils::copyDir(extraDataRoot + QStringLiteral("/dicts"),
+                       appConfigDir.filePath(QStringLiteral("dicts")));
+
     // Main config file.
     FileUtils::copyFile(getConfigFilePath(Source::Default), appConfigDir.filePath(c_configFileName));
 
@@ -356,8 +362,24 @@ QString ConfigMgr::getAppSyntaxHighlightingFolder() const
 
 QString ConfigMgr::getUserSyntaxHighlightingFolder() const
 {
-    return PathUtils::concatenateFilePath(m_userConfigFolderPath,
-                                          QStringLiteral("syntax-highlighting"));
+    auto folderPath = PathUtils::concatenateFilePath(m_userConfigFolderPath,
+                                                     QStringLiteral("syntax-highlighting"));
+    QDir().mkpath(folderPath);
+    return folderPath;
+}
+
+QString ConfigMgr::getAppDictsFolder() const
+{
+    return PathUtils::concatenateFilePath(m_appConfigFolderPath,
+                                          QStringLiteral("dicts"));
+}
+
+QString ConfigMgr::getUserDictsFolder() const
+{
+    auto folderPath = PathUtils::concatenateFilePath(m_userConfigFolderPath,
+                                                     QStringLiteral("dicts"));
+    QDir().mkpath(folderPath);
+    return folderPath;
 }
 
 QString ConfigMgr::getUserOrAppFile(const QString &p_filePath) const

src/core/configmgr.h

@@ -89,6 +89,9 @@ namespace vnotex
 
         QString getUserSyntaxHighlightingFolder() const;
 
+        QString getAppDictsFolder() const;
+        QString getUserDictsFolder() const;
+
         // If @p_filePath is absolute, just return it.
         // Otherwise, first try to find it in user folder, then in app folder.
         QString getUserOrAppFile(const QString &p_filePath) const;

src/core/editorconfig.cpp

@@ -10,6 +10,7 @@ using namespace vnotex;
 
 #define READINT(key) readInt(appObj, userObj, (key))
 #define READSTR(key) readString(appObj, userObj, (key))
+#define READBOOL(key) readBool(appObj, userObj, (key))
 
 EditorConfig::EditorConfig(ConfigMgr *p_mgr, IConfig *p_topConfig)
     : IConfig(p_mgr, p_topConfig),
@@ -57,6 +58,12 @@ void EditorConfig::loadCore(const QJsonObject &p_app, const QJsonObject &p_user)
     m_backupFileExtension = READSTR(QStringLiteral("backup_file_extension"));
 
     loadShortcuts(appObj, userObj);
+
+    m_spellCheckAutoDetectLanguageEnabled = READBOOL(QStringLiteral("spell_check_auto_detect_language"));
+    m_spellCheckDefaultDictionary = READSTR(QStringLiteral("spell_check_default_dictionary"));
+    if (m_spellCheckDefaultDictionary.isEmpty()) {
+        m_spellCheckDefaultDictionary = QStringLiteral("en_US");
+    }
 }
 
 QJsonObject EditorConfig::saveCore() const
@@ -67,6 +74,8 @@ QJsonObject EditorConfig::saveCore() const
     obj[QStringLiteral("backup_file_directory")] = m_backupFileDirectory;
     obj[QStringLiteral("backup_file_extension")] = m_backupFileExtension;
     obj[QStringLiteral("shortcuts")] = saveShortcuts();
+    obj[QStringLiteral("spell_check_auto_detect_language")] = m_spellCheckAutoDetectLanguageEnabled;
+    obj[QStringLiteral("spell_check_default_dictionary")] = m_spellCheckDefaultDictionary;
     return obj;
 }
 
@@ -188,3 +197,18 @@ const QString &EditorConfig::getBackupFileExtension() const
 {
     return m_backupFileExtension;
 }
+
+bool EditorConfig::isSpellCheckAutoDetectLanguageEnabled() const
+{
+    return m_spellCheckAutoDetectLanguageEnabled;
+}
+
+const QString &EditorConfig::getSpellCheckDefaultDictionary() const
+{
+    return m_spellCheckDefaultDictionary;
+}
+
+void EditorConfig::setSpellCheckDefaultDictionary(const QString &p_dict)
+{
+    updateConfig(m_spellCheckDefaultDictionary, p_dict, this);
+}

src/core/editorconfig.h

@@ -87,6 +87,11 @@ namespace vnotex
 
         const QString &getShortcut(Shortcut p_shortcut) const;
 
+        bool isSpellCheckAutoDetectLanguageEnabled() const;
+
+        const QString &getSpellCheckDefaultDictionary() const;
+        void setSpellCheckDefaultDictionary(const QString &p_dict);
+
     private:
         void loadCore(const QJsonObject &p_app, const QJsonObject &p_user);
 
@@ -116,6 +121,10 @@ namespace vnotex
         QSharedPointer<TextEditorConfig> m_textEditorConfig;
 
         QScopedPointer<MarkdownEditorConfig> m_markdownEditorConfig;
+
+        bool m_spellCheckAutoDetectLanguageEnabled = false;
+
+        QString m_spellCheckDefaultDictionary;
     };
 }
 

src/core/markdowneditorconfig.cpp

@@ -53,6 +53,8 @@ void MarkdownEditorConfig::init(const QJsonObject &p_app, const QJsonObject &p_u
 
     m_smartTableEnabled = READBOOL(QStringLiteral("smart_table"));
     m_smartTableInterval = READINT(QStringLiteral("smart_table_interval"));
+
+    m_spellCheckEnabled = READBOOL(QStringLiteral("spell_check"));
 }
 
 QJsonObject MarkdownEditorConfig::toJson() const
@@ -81,6 +83,7 @@ QJsonObject MarkdownEditorConfig::toJson() const
     obj[QStringLiteral("indent_first_line")] = m_indentFirstLineEnabled;
     obj[QStringLiteral("smart_table")] = m_smartTableEnabled;
     obj[QStringLiteral("smart_table_interval")] = m_smartTableInterval;
+    obj[QStringLiteral("spell_check")] = m_spellCheckEnabled;
     return obj;
 }
 
@@ -373,3 +376,12 @@ int MarkdownEditorConfig::getSmartTableInterval() const
     return m_smartTableInterval;
 }
 
+bool MarkdownEditorConfig::isSpellCheckEnabled() const
+{
+    return m_spellCheckEnabled;
+}
+
+void MarkdownEditorConfig::setSpellCheckEnabled(bool p_enabled)
+{
+    updateConfig(m_spellCheckEnabled, p_enabled, this);
+}

src/core/markdowneditorconfig.h

@@ -99,6 +99,9 @@ namespace vnotex
 
         int getSmartTableInterval() const;
 
+        bool isSpellCheckEnabled() const;
+        void setSpellCheckEnabled(bool p_enabled);
+
     private:
         QString sectionNumberModeToString(SectionNumberMode p_mode) const;
         SectionNumberMode stringToSectionNumberMode(const QString &p_str) const;
@@ -171,6 +174,9 @@ namespace vnotex
 
         // Interval time to do smart table format.
         int m_smartTableInterval = 2000;
+
+        // Override the config in TextEditorConfig.
+        bool m_spellCheckEnabled = true;
     };
 }
 

src/core/texteditorconfig.cpp

@@ -45,6 +45,8 @@ void TextEditorConfig::init(const QJsonObject &p_app,
     m_tabStopWidth = READINT(QStringLiteral("tab_stop_width"));
 
     m_zoomDelta = READINT(QStringLiteral("zoom_delta"));
+
+    m_spellCheckEnabled = READBOOL(QStringLiteral("spell_check"));
 }
 
 QJsonObject TextEditorConfig::toJson() const
@@ -58,6 +60,7 @@ QJsonObject TextEditorConfig::toJson() const
     obj[QStringLiteral("expand_tab")] = m_expandTab;
     obj[QStringLiteral("tab_stop_width")] = m_tabStopWidth;
     obj[QStringLiteral("zoom_delta")] = m_zoomDelta;
+    obj[QStringLiteral("spell_check")] = m_spellCheckEnabled;
     return obj;
 }
 
@@ -244,3 +247,13 @@ void TextEditorConfig::setZoomDelta(int p_delta)
 {
     updateConfig(m_zoomDelta, p_delta, this);
 }
+
+bool TextEditorConfig::isSpellCheckEnabled() const
+{
+    return m_spellCheckEnabled;
+}
+
+void TextEditorConfig::setSpellCheckEnabled(bool p_enabled)
+{
+    updateConfig(m_spellCheckEnabled, p_enabled, this);
+}

src/core/texteditorconfig.h

@@ -66,6 +66,9 @@ namespace vnotex
         int getZoomDelta() const;
         void setZoomDelta(int p_delta);
 
+        bool isSpellCheckEnabled() const;
+        void setSpellCheckEnabled(bool p_enabled);
+
     private:
         QString lineNumberTypeToString(LineNumberType p_type) const;
         LineNumberType stringToLineNumberType(const QString &p_str) const;
@@ -94,6 +97,8 @@ namespace vnotex
         int m_tabStopWidth = 4;
 
         int m_zoomDelta = 0;
+
+        bool m_spellCheckEnabled = false;
     };
 }