# LibCSKK
[](https://travis-ci.com/naokiri/cskk)
[](https://github.com/naokiri/cskk/actions)
[English version](https://github.com/naokiri/cskk/blob/master/README.en.md)
Cobalt SKK ライブラリ.
CSKK はSKK(Simple Kana Kanji 変換)用ライブラリです。
CSKKはSKKと外延的に同値であるため、こう名付けられました。
参考
- ddskk: http://openlab.ring.gr.jp/skk/ddskk.html
- libskk: https://github.com/ueno/libskk
## 必要ライブラリ類
- libxkbcommon
Ubuntu等では以下のコマンドでインストール
```shell
sudo apt install libxkbcommon-dev
```
- cbindgen
```shell
cargo install --force cbindgen
```
- cargo-c
```shell
cargo install --force cargo-c
```
## インストール方法
以下を実行する
```shell
cargo cinstall --release
mkdir -p ~/.local/share/libcskk
cp -r ./shared/* ~/.local/share/libcskk
```
標準的なパス以外にインストールする場合は、以下のような引数を与える。
詳細は [cargo-c](https://github.com/lu-zero/cargo-c) を参照のこと。
```shell
cargo cinstall --release --prefix=/usr --includedir=/tmp/other/place
```
- prefix: libdir, includedir, pkgconfigdir 共通接頭部分。デフォルトは '/usr/local'
- libdir: ライブラリインストール先。デフォルトは '/lib'
- includedir: ヘッダファイルイストール先。デフォルトは '/include'
- pkgconfigdir: pkg-config用の.pcファイルインストール先。デフォルトは '/lib/pkgconfig'
## 開発者向け
開発中の確認は主に`cargo build` と `cargo test`でできるようにしています。
C ABI ライブラリを確認する場合、以下のような手作業です。
```shell
cargo cbuild
cp target/x86_64-unknown-linux-gnu/debug/libcskk.h ./tests/
$(CC) tests/c_shared_lib_test.c -L ./target/x86_64-unknown-linux-gnu/debug/ -lcskk -o tests/lib_test
LD_LIBRARY_PATH=./target/x86_64-unknown-linux-gnu/debug ./tests/lib_test
```
## 開発状況
### 基本機能・DDSKKの機能
- [x] ひらがな入力
- [x] カタカナ入力・カタカナモード
- [x] ｶﾀｶﾅ入力・ｶﾀｶﾅモード
- [x] Basic 漢字変換
- [x] static dictionary
- [x] user dictionary
- not ddskk compatible
- [ ] 接頭辞・接尾辞変換
- [ ] 数値変換
- [x] auto-start-henkan
- 実装見込が現在ないもの
- [ ] Kuten 変換
- [ ] 今日の日付入力
- [ ] 異字体変換
- [ ] SKK辞書サーバー対応
- [ ] 外部辞書
## ueno/libskk の機能
- [ ] 句読点設定
- [ ] AZIK rule
- [ ] Nicola rule
### C FFI + IME plugin
- [x] C ABI library for fcitx5-skk
最低限のみ。https://github.com/naokiri/fcitx5-cskk 参照。
### 開発環境・デプロイ環境
- [ ] github projects board や issue にこれらのリストを移す
- [ ] changelog
## 著作権表示
Copyright (C) 2018 Naoaki Iwakiri
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/>.