liberime [开发中]

Introduce

A emacs dynamic module provide librime bindings for emacs

目前只实现了几个方法，理想情况是暴露所有 librime 的 API 到 emacs-lisp.

Require

emacs 需要启用支持动态模块，在编译的时候使用 –with-modules 选项。
librime 版本 > 1.3.2

Build

Build On Linux:

make liberime-core
ls build/

# try
make test

Build On Darwin

Build librime following this instruction, you will need xcode (good luck).
Setup environment variable RIME_PATH to librime project dir, for example:
```
export RIME_PATH=~/Develop/others/librime
    
```

Build just like on Linux

make liberime-core
ls build/

# try
make test

Build On Windows (Msys2)

打开 MSYS2 MinGW 终端
切换到 liberime 所在的目录
运行下面的命令
```
./msys2-build.sh
    
```
./msys2-build.sh 命令有许多选项，可以使用下面的命令获取帮助
```
./msys2-build.sh --help
    
```

注意事项：=liberime-core.dll= 加载有时候会报错，遇到这种情况，首先应该检查环境变量 PATH 的设置，确保 librime.dll 可以通过 PATH 找到。

如果用户不想自己编译，可以从 release 区下载 liberime-archive 预编译包尝鲜，预编译包主要用于测试，还是建议用户直接使用msys2-build 编译安装。

Usage

Initialize

需要配合 pyim 使用。

shared_data_dir: librime 安装后提供的共享数据，里面会有预置的 schema 等各平台所在位置详情。

注意：如果你用的是 Windows msys2 版本，不要将 shared_data_dir 设置为小狼毫的 data 目录，因为小狼毫使用 MSVC 编译的，OpenCC 的 .ocd 文件格式不同。你可以设置为 build 目录下的 data 目录。

user_data_dir: 推荐放在 “~/.emacs.d/rime”,

通过 use-package + quelpa 加载注意 add-hook 一定要放在:init block 里面

使用 GitHub Repo

(use-package liberime
  :quelpa (liberime
           :fetcher github
           :repo "merrickluo/liberime"
           :files ("CMakeLists.txt" "Makefile" "src" "liberime*.el" "liberime-config.el"))
  :init
  (add-hook 'liberime-after-start-hook
            (lambda ()
              ;; Select schema delay 5 second, make sure
              ;; `liberime-load' run finish.
              (run-with-timer
               5 1
               (liberime-select-schema "luna_pinyin_simp")))))

使用本地文件

(use-package liberime
  :quelpa (liberime
           :fetcher file
           :path "~/Develop/emacs/liberime"
           :files ("CMakeLists.txt" "Makefile" "src" "liberime.el" "liberime-config.el"))
  :init
  (add-hook 'after-liberime-load-hook
            (lambda ()
              ;; Select schema delay 5 second, make sure
              ;; `liberime-load' run finish.
              (run-with-timer
               5 1
               (liberime-select-schema "luna_pinyin_simp")))))

注意，使用 hook 修改输入方案会有一些问题，由于 liberime 在执行 sync 等操作之后会重新部署，由于目前的技术限制，重新部署的通知在 elisp 环境无法收到，所以无法重新执行这些 hooks,如果需要设置指定的输入方案，建议直接在 /.emacs.d/rime/default.custom.yaml 配置。see example

#+NAME setup pyim

(use-package pyim
  :after liberime
  :config
  (setq default-input-method "pyim")
  (setq pyim-default-scheme 'rime))

Deploy

在手动修改了 librime 的配置后，可以手动调用 (liberime-deploy) 进行重新部署。

Sync

使用 liberime 会导致一个问题，就是在 Emacs 中输入中文时，词库跟系统输入法不一致，无论是你在使用 fcitx-rime, ibus-rime, 或者是 squirrel。不过 librime 提供了方法让我们保持词库同步。参考：Rime 同步用户资料。

默认情况下 liberime 的 installation.yaml 在 $HOME/.emacs.d/rime/installation.yaml，用户只需要在里面添加 sync_dir ，就可以使用 liberime 提供的 (liberime-sync) 方法进行同步了。还可以将其加入到 emacs 的 after-init-hook 中自动进行同步。

(add-hook 'after-init-hook #'liberime-sync)

Available methods

(liberime-start shared_data_dir user_data_dir)

initialize deploy and started a session with librime returns t if success report error otherwise

(liberime-get-schema-list)

returns list of pairs(list of (schema_id, schema_name) ) avaliable schema

Example output(prebuilt schemas)

(liberime-get-schema-list)
;; (("luna_pinyin" "朙月拼音") ("luna_pinyin_simp" "朙月拼音·简化字") ("luna_pinyin_fluency" "朙月拼音·語句流") ("bopomofo" "注音") ("bopomofo_tw" "注音·臺灣正體") ("cangjie5" "倉頡五代") ("stroke" "五筆畫") ("terra_pinyin" "地球拼音"))

(liberime-select-schema schema_id)

should use schema_id returns from libeliberime-get-schema-list returns t if success, report error otherwise

Example output:

(liberime-select-schema "luna_pinyin_simp")
;; t

uiryuu / liberime