意味の色とカラーテーマ

[Emacs Advent Calendar 2020](https://qiita.com/advent-calendar/2020/emacs) の 9 日目の記事です。

[おととしの Advent Calendar](https://qiita.com/zk_phi/items/ec998eaff72989b05b0a) でカラーテーマについての話を書いたのですが、その後２年、実際に自分で使ってみて色々と考えが整理された＆実装も進化したので改めて紹介させてください。

当時の記事と重なる箇所もありますが、ご了承ください mm

## tl;dr

![hoge.gif](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/54240/35e246ef-15cd-cdd7-99d5-e9d11d2b3217.gif)

「色を持たない」カラーテーマによって、 Emacs の外観を簡単に、一貫性を保ってコントロールできるようにしました。

## カラーテーマの責務
### Emacs の Basic Faces

Emacs には Basic Faces と呼ばれる、いくつかの特別な face があります。

- `default`
- `bold`
- `italic`
- `bold-italic`
- `underline`
- `fixed-pitch`
- `fixed-pitch-serif`
- `variable-pitch`
- `shadow`
- `link`
- `link-visited`
- `highlight`
- `match`
- `isearch`
- `lazy-highlight`
- `error`
- `warning`
- `success`

マニュアルによれば、他の Face たちはこれら Basic Faces を継承して定義することが推奨されており、「Basic Faces をカスタマイズするだけで Emacs 全体をカスタマイズできる」ことを理想としているように読めます。

しかしその後リッチなテーマ機構が実装されたことなどからも、この思想には限界があったように思えます。

### なにがしんどいのか

私の考える Emacs の face の問題 (限界) は以下の二点です：

1. Basic Face が圧倒的に足りていないこと

2. 「意味」の face と「見た目」の face が混在していること

1 について、いろいろなパッケージがそれぞれ独自に、 Basic Faces を継承しない face を定義していることから、 Basic Faces は現実のアプリにはかなり不足していることがわかると思います。

たとえば組み込みのシンタックスハイライトですら大量に独自 face を定義しています:

- `font-lock-comment-face`
- `font-lock-comment-delimiter-face`
- `font-lock-string-face`
- `font-lock-doc-face`
- `font-lock-keyword-face`
- `font-lock-builtin-face`
- `font-lock-function-name-face`
- `font-lock-variable-name-face`
- `font-lock-type-face`
- `font-lock-constant-face`
- `font-lock-warning-face`
- `font-lock-negation-char-face`
- `font-lock-preprocessor-face`
- `font-lock-regexp-grouping-backslash`
- `font-lock-regexp-grouping-construct`

さらに悪いことには、これらの face たちは「その見た目のためだけに」また別のパッケージでさまざまに利用されています。

たとえば Emacs でディレクトリを開いたときの画面 (`dired`) では、ディレクトリのパスが表示されるヘッダ行に `font-lock-type-face` が使われています。 face 名からして本来は「型の名前をハイライトするための face」だったものを、ここではその「見た目だけ」を拝借するために使用していると考えられます。

これが 2 の問題で、「名前が用途を表している face」を、見た目のためだけに用途外の場所で使用してしまうと、全体の一貫性がなくなってしまいやすく、結果的にカラーテーマの実装もしづらくなってしまうと感じます。

![スクリーンショット 2020-12-04 13.13.52.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/54240/6326a149-30ed-da38-f724-10d24873e3d9.png)

たとえば `dired` に似た、たくさんの項目が並んだリスト状の画面を表示するための別のモード `tabulated-list-mode` では、ヘッダの表示に `tabulated-list-fake-header` というまた別の face が使われていて、これはこれで `font-lock-type-face` とは別の見た目をしていたりします。

### カラーテーマのもう一つの責務

現状の Emacs では、このようなチグハグ状態をなんとかするのもカラースキームの責務になってしまっているように感じています。各々のパッケージが自由に独自 face を定義して、そのルールに一貫性があまりないので、カラーテーマ側であらゆるパッケージの face の色をいい感じに設定して回る必要があります。

たんにエディタの画面全体の色合いを衣替えしたいだけの場合、これはちょっと大変すぎかなと思います。

## elemental-theme の設計

そこで私は、この「カラーテーマのもう一つの責務」だけを上手にこなして、カラーパレットの選定はユーザーに開いたままにしておく、「色を持たない」カラーテーマ elemental-theme を実装しました（便宜上、デフォルトのスタイルは定義されていますが）。

以下、その設計思想を紹介したいと思います。

### Elemental Faces

elemental-theme はまず、「見た目だけ」を表す face を必要十分な数だけ定義します。

elemental-theme ではこれらを elemental (根本の, 要素の) face と呼んでいます。 Atomic Design の atoms みたいなイメージです。

![スクリーンショット 2020-12-04 19.56.33.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/54240/ce1f2df5-5c7f-e55b-38f2-1a24098b7b89.png)

core

- `default` (built-in)
- `cursor` (built-in)

濃淡

- `elemental-bright-bg-face`
- `elemental-brighter-bg-face`
- `elemental-bright-fg-face`
- `elemental-dark-fg-face`
- `elemental-darker-fg-face`

アクセント

- `elemental-accent-fg-1-face`
- `elemental-accent-fg-2-face`
- `elemental-accent-fg-3-face`
- `elemental-accent-fg-4-face`

**他のすべての face はこれらの elemental な face を継承して定義されるので、 elemental-theme で使われるスタイルはこれで全部です。** 逆に、ここを調整するだけで、 Emacs 全体の見た目を一貫性を保ってコントロールできるというのがこのカラーテーマのコンセプトになります。

このあたりはおととしの記事時点でも同じような考えでしたが、「必要十分な」face のセットという点については考察が進んで、実装も変わっています。

#### 命名について

名前に `-fg-` とつく face は主に単語などのハイライトに、 `-bg-` とつく face は主に一定の大きさを持ったエリア全体のハイライトに使われます。そのため、 `-fg-` face には前景色を、 `-bg-` face には背景色を設定するとうまくいくことが多いです。また `-fg-` と `-bg-` face は適宜組み合わせて使われるので、互いにコンフリクトしないようにする必要があります。

アクセント色については、 `-1-` から順に高い頻度で使われます。たとえば、 `accent-fg-1` にはそのカラーテーマのメインとなるアクセント色、ブランド色を適用するといい感じになることが多いです。

#### 色相 face

![スクリーンショット 2020-12-04 19.58.46.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/54240/40c77f01-19c9-1221-b1ca-f7ce8f562ca3.png)

一部の色については UI 上で特別な意味を持つことがある（たとえば、エラーは暖色系、成功は寒色系）ので、専用の face を設けています。色数を減らしたいテーマでは、他の elemental face に使われている色の中から適当な色を選んで選んで流用してもよいとしています。

- `elemental-red-fg-face`
- `elemental-blue-fg-face`
- `elemental-green-fg-face`
- `elemental-orange-fg-face`

### Semantic Faces

elemental-theme は次に、「用途だけ」を表す face を必要十分な数だけ定義します。ここが一番大きなアップデートです。

elemental-theme ではこれらを semantic (意味的な) face と呼んでいます。

basic

- `elemental-caution`
- `elemental-diminished`
- `elemental-highlight`
- `elemental-inappropreate`
- `elemental-incorrect`
- `elemental-key`
- `elemental-match`
- `elemental-match-interactive`
- `elemental-reference`
- `elemental-selected`

増減、追加削除

- `elemental-diff-added`
- `elemental-diff-changed`
- `elemental-diff-refine-added`
- `elemental-diff-refine-changed`
- `elemental-diff-refine-removed`
- `elemental-diff-removed`

ファイル

- `elemental-file-executable`
- `elemental-file-name`
- `elemental-file-special`

アラート

- `elemental-indicator-error`
- `elemental-indicator-info`
- `elemental-indicator-success`
- `elemental-indicator-warning`

階層構造

- `elemental-level-1`
- `elemental-level-2`
- `elemental-level-3`
- `elemental-level-4`
- `elemental-stage-1`
- `elemental-stage-higher`
- `elemental-stage-negative`

マークアップ言語の構文

- `elemental-markup-code`
- `elemental-markup-table`

プログラミング言語の構文

- `elemental-syntax-builtin`
- `elemental-syntax-literal`
- `elemental-syntax-symbol`
- `elemental-syntax-type`

その他 UI 部品

- `elemental-ui-component`
- `elemental-ui-component-diminished`
- `elemental-ui-component-transparent`
- `elemental-ui-ghost`
- `elemental-ui-prompt`

これらの face はすべて elemental face を継承して定義されており、ここで「見た目」のパレットと「意味」のパレットを分離しています。elemental-theme では、各パッケージの face に色を塗る際、 elemental face を直接使うことはいっさいせず、必ず「意味」のパレットから選ぶようにします。

![-consistency.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/54240/666c652d-c665-260a-e9d9-277faa604ca0.png)

たとえば `region` (バッファの選択範囲)、 `ido-first-match` (ミニバッファのメニューで選択されている項目)、 `company-tooltip-selection` (選択されている補完候補) などはどれも「選択されている」という概念を表しているので、すべて `elemental-selected` semantic face を継承させます。

これは一貫性を保ちつつ対応パッケージを増やしていくために役立ちます。

また elemental-theme では semantic face のカスタマイズも禁止していないので、たとえば同じ意味を持つ要素の見た目をまとめて変更したい場合は、ユーザーはこのレイヤーに手を入れることもできます。

ところで semantic face は elemental face よりもたくさんあるので、いくつかの semantic face は同じ見た目になる場合があります。また対応プラグインを増やせば増やすほど、そのようなケースは増えていくと思われます。そこで elemental-theme では以下のポリシーで sematnic face を定義していくことにしています。

#### 1. 一貫性

![-architecture.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/54240/9015e276-a71a-e9a3-88bb-3863dbdaca5d.png)

同じ機能を持つ部分はすべて同じ見た目になるようにします。

もし新しいパッケージをサポートする際は、極力既存の「意味」のパレットから適切なものを選ぶようにします。ただし、 適切な「意味」の face がパレットにない場合は、無理に他のもので代用することはせず、新たに追加することにします。

#### 2. 区別できること

同じ見た目の要素が異なる機能を持つことを、次の場合に限って認めます: それらが同じバッファや UI 部品の中で使われない場合。

たとえば `elemental-markup-table` と `elemental-syntax-literal` は（デフォルトでは）同じ見た目をしています。これらはそれぞれ「マークアップ言語 (markdown, org など) の表」と「プログラミング言語の定数」をハイライトするために使われる face なので、一つのバッファに同時に出現することはありません。したがって、これらは同じ見た目をしていても問題ありません。

一方、たとえば `elemental-markup-code` (マークアップ言語の引用・コード部分) を `elemental-markup-table` と同じ見た目にするのはまずいです。なぜなら、どちらもマークアップ言語のシンタックスハイライトに使用されるので、同じ見た目をしていると区別できなくなってしまいます。

## まとめ

face に「見た目」と「意味」それぞれの抽象化レイヤーを導入することで、 Emacs の face 周りのツラみを解決しようとしてみました。またその仕組みをいい感じに維持するための運用ポリシーを考えてみました。

今のところ快適に使えているので、よかったら試してみてください！ (アイデアだけ他のカラーテーマに援用するのも歓迎です)

https://github.com/zk-phi/elemental-theme

### おまけ

elemental-theme はカラーテーマジェネレータではなく「継承関係のよく整理されたただのカラーテーマ」なので、 `set-face-foreground` などでリアルタイムにいじることもできます。

悪用するとゲーミング Emacs (？) などもつくれます

<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">ゲーミング LISP かなり最悪感ある <a href="https://t.co/2anF9gnY1X">pic.twitter.com/2anF9gnY1X</a></p>&mdash; ぜろけー🎄 (@zk_phi) <a href="https://twitter.com/zk_phi/status/1329397402445352960?ref_src=twsrc%5Etfw">November 19, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>