Make dictionary editable (#31)

* Make dictionary configurable

Author: naokiri

CMakeLists.txt

@@ -14,8 +14,25 @@ find_package(PkgConfig REQUIRED)
 find_package(Fcitx5Core 5.0.6 REQUIRED)
 pkg_check_modules(LIBCSKK REQUIRED "cskk>=0.6.0")
 
+option(ENABLE_QT "Enable Qt for GUI configuration" On)
+
 include("${FCITX_INSTALL_CMAKECONFIG_DIR}/Fcitx5Utils/Fcitx5CompilerSettings.cmake")
 
+# GUI related libs
+if (ENABLE_QT)
+    find_package(Qt5 5.7 REQUIRED COMPONENTS Core Gui Widgets)
+    find_package(Fcitx5Qt5WidgetsAddons REQUIRED)
+endif ()
+
+# make default value header searchable
+set(SKK_DICT_DEFAULT_PATH "/usr/share/skk/SKK-JISYO.L" CACHE STRING "Default path of SKK Dictionary file")
+set(SKK_DICT_DEFAULT_ENCODING "euc-jp" CACHE STRING "Default encoding of SKK Dictionary file")
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/skk_dict_config.h.in"
+        "${CMAKE_CURRENT_BINARY_DIR}/skk_dict_config.h"
+        IMMEDIATE @ONLY)
+include_directories(${CMAKE_CURRENT_BINARY_DIR})
+
+# Googletest submodule setup
 find_package(Git QUIET)
 if (GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git")
     enable_testing()
@@ -46,6 +63,8 @@ add_subdirectory(src)
 add_subdirectory(data)
 add_subdirectory(po)
 add_subdirectory(test)
+add_subdirectory(gui)
+
 
 fcitx5_translate_desktop_file(
         org.fcitx.Fcitx5.Addon.Cskk.metainfo.xml.in

README.md

@@ -43,13 +43,33 @@ GOOGLETESTフラグはキャッシュされるのでライブラリ生成時に
     - [x] 変換候補リストのサイズ
 
 ### 実装内容・予定不明
-- [ ] 優先度、読み書き可不可の辞書リスト設定
+- [x] 優先度、読み書き可不可の辞書リスト設定
+
+
+### 辞書
+辞書の形式は [skk-dev](https://skk-dev.github.io/dict/) で配布されているものを想定している。
+
+デフォルトでは/usr/share/skk/SKK-JISYO.L が euc-jp の読み取り専用辞書として使われる。
+
+辞書はfcitx5のconfigtoolから設定可能。
+
+
+直接編集する場合は `~/.local/share/fcitx5/cskk/dictionary_list` に保存されている。
+','区切りのkey=valueリストで、type,file,mode,encodingを指定する。
+例として、
+
+    type=file,file=/usr/share/skk/SKK-JISYO.L,mode=readonly,encoding=euc-jp
+    type=file,file=$FCITX_CONFIG_DIR/cskk/user.dict,mode=readwrite
+
+typeはfileのみ。必須。
+
+fileはファイルへのパスを指定する。必須。唯一文頭でのみ$FCITX_CONFIG_DIRのみ変数として使え、fcitx5の設定ディレクトリ(通常は~/.local/share/fcitx5)を指す。
+
+modeはreadonlyまたはreadwrite。必須。
+
+encodingに指定できる内容はlibcskkに準じる。必須。少なくとも"euc-jp"や"utf-8"が使える。
 
 
-### じしょ
-現在のところ $XDG_DATA_HOME/fcitx5-cskk/dictionary/\*.dict (多くの環境では$HOME/.local/share/fctix5-cskk/dictionary/\*.dict )  を読み書き可能な辞書として優先して読む。 
-$XDG_DATA_DIRS/fcitx5-cskk/dictionary/\* (/usr/local/share/fcitx5-cskk/dictionary/\* 等) を読みとり専用辞書とする。
-文字コードはUTF-8のみに対応。ファイル名順。
 
 ## 著作権表示
 

gui/CMakeLists.txt

@@ -0,0 +1,28 @@
+set(CSKK_CONFIG_SRCS
+  main.cpp
+  dictwidget.cpp
+  adddictdialog.cpp
+  dictmodel.cpp
+  )
+
+if(NOT ENABLE_QT)
+  return()
+endif()
+
+add_library(fcitx5-cskk-config
+  MODULE ${CSKK_CONFIG_SRCS})
+
+set_target_properties(fcitx5-cskk-config PROPERTIES
+                      AUTOMOC TRUE
+                      AUTOUIC TRUE
+                      AUTOUIC_OPTIONS "-tr=fcitx::tr2fcitx;--include=fcitxqti18nhelper.h"
+)
+target_link_libraries(fcitx5-cskk-config
+  Qt5::Core
+  Qt5::Widgets
+  Fcitx5Qt5::WidgetsAddons
+  Fcitx5::Utils
+  ${LIBCSKK_LIBRARIES}
+  )
+
+install(TARGETS fcitx5-cskk-config DESTINATION ${CMAKE_INSTALL_LIBDIR}/fcitx5/qt5)

gui/adddictdialog.cpp

@@ -0,0 +1,114 @@
+/*
+ * SPDX-FileCopyrightText: 2013~2020 CSSlayer <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#include "adddictdialog.h"
+#include "skk_dict_config.h"
+#include <QDebug>
+#include <QFileDialog>
+#include <fcitx-utils/standardpath.h>
+#include <fcitxqti18nhelper.h>
+
+#define FCITX_CONFIG_DIR "$FCITX_CONFIG_DIR"
+
+namespace fcitx {
+
+enum DictType { DictType_Static, DictType_User };
+
+AddDictDialog::AddDictDialog(QWidget *parent)
+    : QDialog(parent), m_ui(std::make_unique<Ui::AddDictDialog>()) {
+  m_ui->setupUi(this);
+  m_ui->typeComboBox->addItem(_("System"));
+  m_ui->typeComboBox->addItem(_("User"));
+  m_ui->typeComboBox->setCurrentIndex(1);
+
+  indexChanged(0);
+
+  connect(m_ui->browseButton, &QPushButton::clicked, this,
+          &AddDictDialog::browseClicked);
+  connect(m_ui->typeComboBox,
+          QOverload<int>::of(&QComboBox::currentIndexChanged), this,
+          &AddDictDialog::indexChanged);
+  connect(m_ui->urlLineEdit, &QLineEdit::textChanged, this,
+          &AddDictDialog::validate);
+}
+
+QMap<QString, QString> AddDictDialog::dictionary() {
+  int idx = m_ui->typeComboBox->currentIndex();
+  idx = idx < 0 ? 0 : idx;
+  idx = idx > 1 ? 0 : idx;
+
+  QMap<QString, QString> dict;
+  const char *type[] = {"readonly", "readwrite"};
+
+  dict["type"] = "file";
+  dict["file"] = m_ui->urlLineEdit->text();
+  dict["mode"] = type[idx];
+  dict["encoding"] = m_ui->encodingEdit->text();
+
+  return dict;
+}
+
+void AddDictDialog::indexChanged([[maybe_unused]] int _idx) {
+  validate();
+}
+
+void AddDictDialog::validate() {
+  const auto index = m_ui->typeComboBox->currentIndex();
+  bool valid = true;
+  switch (index) {
+  case DictType_Static:
+  case DictType_User:
+    if (m_ui->urlLineEdit->text().isEmpty() || m_ui->encodingEdit->text().isEmpty()) {
+      valid = false;
+    }
+    break;
+  }
+  m_ui->buttonBox->button(QDialogButtonBox::Ok)->setEnabled(valid);
+}
+
+void AddDictDialog::browseClicked() {
+  QString path = m_ui->urlLineEdit->text();
+  if (m_ui->typeComboBox->currentIndex() == DictType_Static) {
+    QString dir;
+    if (path.isEmpty()) {
+      path = SKK_DICT_DEFAULT_PATH;
+    }
+    QFileInfo info(path);
+    path = QFileDialog::getOpenFileName(this, _("Select Dictionary File"),
+                                        info.path());
+  } else {
+    auto fcitxBasePath = stringutils::joinPath(
+        StandardPath::global().userDirectory(StandardPath::Type::PkgData),
+        "cskk");
+    fs::makePath(fcitxBasePath);
+    QString fcitxConfigBasePath =
+        QDir::cleanPath(QString::fromStdString(fcitxBasePath));
+
+    if (path.isEmpty()) {
+      auto baseDataPath = stringutils::joinPath(
+          StandardPath::global().userDirectory(StandardPath::Type::Data), "fcitx5-cskk");
+      fs::makePath(baseDataPath);
+      QString basePath = QDir::cleanPath(QString::fromStdString(baseDataPath));
+      path = basePath;
+    } else if (path.startsWith(FCITX_CONFIG_DIR "/")) {
+
+      QDir dir(fcitxConfigBasePath);
+      path = dir.filePath(path.mid(strlen(FCITX_CONFIG_DIR) + 1));
+    }
+    path =
+        QFileDialog::getOpenFileName(this, _("Select Dictionary File"), path);
+    if (path.startsWith(fcitxConfigBasePath + "/")) {
+      path = FCITX_CONFIG_DIR + path.mid(fcitxConfigBasePath.length(), -1);
+    }
+  }
+
+  if (!path.isEmpty()) {
+    m_ui->urlLineEdit->setText(path);
+  }
+}
+
+} // namespace fcitx

gui/adddictdialog.h

@@ -0,0 +1,35 @@
+/*
+ * SPDX-FileCopyrightText: 2013~2020 CSSlayer <[email protected]>
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#ifndef ADDDICTDIALOG_H
+#define ADDDICTDIALOG_H
+
+#include <memory>
+#include <QDialog>
+#include <QMap>
+#include "ui_adddictdialog.h"
+
+namespace fcitx {
+
+class AddDictDialog : public QDialog {
+    Q_OBJECT
+public:
+    explicit AddDictDialog(QWidget *parent = 0);
+    QMap<QString, QString> dictionary();
+
+public Q_SLOTS:
+    void browseClicked();
+    void indexChanged([[maybe_unused]] int);
+    void validate();
+
+private:
+    std::unique_ptr<Ui::AddDictDialog> m_ui;
+};
+
+} // namespace fcitx
+
+#endif // ADDDICTDIALOG_H