Emacsのmode-lineを触っていてハマったので整理。
テキストプロパティが分かれば、色付けたり、マウスインタラクション付けたりできて便利。
Emacsのstringには、平文情報以外に、書式情報も含まれている。
例えば、all-the-iconでmode-lineに表示するアイコンはこんな感じ。
(all-the-icons--icon-info-for-buffer)
;;=> #("" 0 1 (face (:family "file-icons" :height 1.0 :inherit all-the-icons-orange) font-lock-face (:family "file-icons" :height 1.0 :inherit all-the-icons-orange) display (raise -0.1) rear-nonsticky t))
(type-of (all-the-icons--icon-info-for-buffer))
;;=> string
stringは文字、start、end、プロパティで構成されていることがわかる。
テキストプロパティを制御しようと思ってハマったので整理する。
Emacsで扱うデータ構造は、基本はlist。これはわかりやすい。
'(1 2 3)
次に、key-valueストアとして使えるlistがalist（連想配列）。
仕組みとしては、コンスセルのリストになっている。
'((one . 1)
(two . 2)
(three . 3))
最後に、今回ハマったplist（属性リスト）。
こちらはalistと違って、keyとvalueをそのまま順番に連結したものとなる。
別に縛りではないが、キーワード（コロン付きの）シンボルが使われる傾向にある。
'(:one 1
:two 2
:three 3)
これら3つのリストごとに操作関数が分かれている。
詳しくはテキストプロパティの変更。
テキストプロパティの操作関数は、bufferもしくはstringを受け入れるようになっている。
そして、操作は副作用を起こす形で実行される。bufferに対しては、この仕様は便利だが、stringに対しては不便。
なので、properize()という関数があって、これがテキストプロパティを反映したstringを返すようになっている。
properize()の厄介なところは、元のテキストプロパティが全部消えてしまうこと。get-text-property()で元のテキストプロパティを取り出しておく必要がある。
何かもっといい方法があれば知りたい。
日本語翻訳されたドキュメントもあって、ネットの検索でも引っかかるのでヒントは多かったが、結局コードを動かして理解するのが一番早かった。