【Emacs】defcustomの使用例を一つ調べた

ddskkパッケージで、defcustomの使用例を一つ調べました。
分からない点もありましたが、使い方は何となく分かりました。

背景

今、Emacsの設定ファイルを見直しています。
その一環で、カスタム変数について気になったので、今回の記事を作成に至りました。

defcustomとは

defcustomはカスタム変数を宣言するマクロです。

ヘルプの冒頭にはこのように記載されています。

(defcustom SYMBOL STANDARD DOC &rest ARGS)

使用例

使用例をddskk-20190423.1234/skk-vars.el(293-302行目)から拝借しました。

;;; skk.el related.
(defcustom skk-user-directory nil
  "*SKK の設定ファイルなどを置くディレクトリ名。
各種設定ファイルをひとつのディレクトリにまとめたい場合に設定する。

  (例) (setq skk-user-directory \"~/.ddskk\")
"
  :type '(radio (directory :tag "ディレクトリ名" "~/.ddskk")
        (const :tag "設定しない" nil))
  :group 'skk-basic)

ヘルプと対応付けると

  • SYMBOL: skk-user-directory
  • STANDARD: nil
  • DOC: “*SKK …”
  • ARGS: :type … :group: …

SYMBOLは変数名で、STANDARDが初期値ですかね。
DOCは変数の説明。
ARGSのところが明確に分からないですね。
ヘルプによると、:type の値はa widget typeとのことで、radioはラジオボタンのことだとすると、GUIと関係しているのかな。

とりあえず、ARGSについての理解は現状必要なさそうなので、深入りしないでおきます。

おわりに

defcustomの使用例を一つ調べました。
引き続き、設定の見直しを行っていきます。
Emacs深いですね…
では。


YouTube: ミサキさん

問い合わせ先
Mail: caprico.aries@gmail.com
Twitter: https://twitter.com/caprico_aries(無言フォローもお気軽に)

コメント

タイトルとURLをコピーしました