Emacsでは、すべてがサービスのように見える
In Emacs, Everything Looks Like a Service (yummymelon.com)
要約
この記事は、Emacsが単なるテキストエディタではなく、OSカーネルレベルを超えてアプリケーションやユーティリティを連携させる能力を持つため、オペレーティングシステム(OS)と比較される理由を解説しています。Emacsは、ファイルシステムやネットワークなどのOSサービスへの組み込みアクセスと、他のプログラムを実行する能力を組み合わせることで、ユーザーが計算ニーズの多くをEmacs内で実現できる「Emacs内で生きる」という概念を支持しています。クライアント・サーバーモデルの定義と、EmacsがUI、クライアントエッジ、ローカルデータベースといったクライアントの責任を果たすために提供する豊富なライブラリ(Minibuffers、Buffers、URL、Socket、JSON、XMLなど)について説明し、wttr.inのような外部サービスをElispで統合する具体的な例を示しています。
全文翻訳
Emacsでは、すべてがサービスのように見える
Emacsはオペレーティングシステム(OS)であるという意見はよく聞かれます。これは事実ではありませんが、OSと比較される所以は、OSカーネルレベルを超えてアプリケーションやユーティリティをオーケストレーションする能力にあります。以下の図は、EmacsがOSとその能力とどのように関連しているかをより正確に示唆しています。
[画像: img]
EmacsはOSのシステムサービス(ファイルシステム、ネットワークなど)への組み込みアクセスと、他のプログラムを実行する能力を兼ね備えているため、その中でクライアントの動作を即興で作り上げることが日常的になっています。このため、Emacsユーザーは、それ用に作られた様々なクライアントモードから、多くのコンピューティングニーズを満たすことができます。これは「Emacsだけで生活する」という考え方に信憑性を与えます。
この記事では、Emacsがクライアントを構築する方法をいくつか調べます。この記事の終わりまでには、Emacs内からは、すべてがサービスのように見えると確信していただけるでしょう。
クライアント・サーバーモデル
まず、いくつかの定義を提供しましょう。
クライアント・サーバーモデルは、リソースの提供者(サービス)とリソースの要求者(クライアント)の間でタスクが分割される一般的なコンピューターインタラクションパターンです。クライアントはサーバーにリクエストを発行し、サーバーは以下の図に示すようにレスポンスを返します。
[画像: img]
実装によっては、トランザクション(リクエスト+レスポンス)はネットワークを介して発生するか、システムローカルで行われます。ネットワークを使用したクライアント・サーバーモデルは、RESTスタイルソフトウェアアーキテクチャで最も詳細に説明されています。上記のシーケンス図に示すのは、RESTスタイルのクライアント・サーバーアーキテクチャの一般的な実装パターンです。
[画像: img]
Emacsをクライアントとして
上記の図から、クライアントが通常担当する3つの懸念事項があります。
- UI: ユーザーインターフェース(もしあれば)。
- クライアントエッジ: サービスとの通信を担当するサブシステム。ネットワーククライアントの場合、これはネットワークサブシステムです。
- ローカルデータベース: サーバーと交換または同期されるデータの表現。このデータの管理方法は、実装要件によります。
これらの懸念事項について、Emacsは組み込みおよびサードパーティの両方で多数のライブラリを提供しており、これらを使用してクライアントを実装できます。以下に、いくつかの組み込みライブラリとその詳細を読むためのリンクを示します。
- UI
- クライアントエッジ
- URL
- Socket (TCP/UDP)
- SMTP
- シリアライズ/デシリアライズ
- ローカルデータベース
要件によって、Emacsクライアントの実装に必要な複雑さは異なります。既存のコマンドラインユーティリティが「重い処理」を実行できる場合、そのユーティリティはシェル呼び出しを介してアクセスできる「サービス」として再構築できます。
[画像: img]
Elisp
上記で言及されたすべてのライブラリは、Emacs Lisp(Elisp)プログラミング言語を通じてアクセスされます。Elispは動的プログラミング言語であり、実行時に高いレベルの即興性を可能にします。この機能により、Elisp関数からシェルコマンドまで、Emacsで利用可能なあらゆる動作の複雑なオーケストレーションが可能になります。
wttr.inクライアントの例
wttr.inは、コンソール指向の天気予報ウェブサービスです。JSON出力をサポートしているため、場所を尋ね、HTTPリクエストを行い、JSONレスポンスを処理し、結果をミニバッファに表示するEmacsのwttrコマンドを構築できます。
トップレベルコマンドwttrを以下に示します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
(defun wttr (location)
"Show weather conditions for LOCATION from `https://wttr.in' in mini-buffer.
Result is also stored in `kill-ring'."
(interactive "sWhere (default: local): ")
(condition-case err
(let* ((url (wttr--request-url location))
(jsondb (fetch-json-as-hash-table url))
(msg (wttr--report-message jsondb)))
(kill-new msg)
(message "%s" msg))
(error (message "ERROR: %s" (cdr err)))))
wttr.inのURLは、以下に示すwttr--request-url関数によって構築されます。
1
2
3
4
5
6
7
(defun wttr--request-url (location)
"Construct wttr.in URL with LOCATION."
(let* ((base-url (url-generic-parse-url "https://wttr.in"))
(encoded-location (string-replace " " "+" location))
(query (format "/%s?0&format=j1" encoded-location))
(_dummy (setf (url-filename base-url) query)))
(url-recreate-url base-url)))
次に、そのURLをfetch-json-as-hash-tableに渡すことができます。これはURLの取得とJSONレスポンスをElispのhash-tableへの解析という重い処理を行います。
1
2
3
4
5
6
7
8
9
10
11
12
13
(defun fetch-json-as-hash-table (url)
"Fetch URL with expected JSON response and return a `hash-table'."
(let ((data-buffer (url-retrieve-synchronously url)))
(if (not data-buffer)
(error "Failed to fetch data from %s" url)
(unwind-protect
(with-current-buffer data-buffer
;; Move point past the HTTP metadata headers
(goto-char url-http-end-of-headers)
;; Parse the remaining JSON buffer into a hash-table
(json-parse-buffer :object-type 'hash-table))
;; Always kill the downloaded network buffer to prevent memory leaks
(kill-buffer data-buffer)))))
最後に、JSONレスポンス(jsondb)から必要な値を取り出して、ミニバッファに送信されるメッセージを生成できます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
(defun wttr--report-message (jsondb)
"Generate weather report message from JSONDB."
(let* ((area-buflist ())
(nearest-area
(wttr--get-first jsondb "nearest_area"))
(area-name
(map-elt (wttr--get-first nearest-area "areaName") "value"))
(region
(map-elt (wttr--get-first nearest-area "region") "value"))
(country
(map-elt (wttr--get-first nearest-area "country") "value"))
(current-condition (wttr--get-first jsondb "current_condition"))
(temp_c (map-elt current-condition "temp_C"))
(temp_f (map-elt current-condition "temp_F"))
(weather-description
(map-elt
(wttr--get-first current-condition "weatherDesc") "value")))
(mapc (lambda (x)
(if (and x (not (string-equal x "")))
(push x area-buflist)))
(list area-name region country))
(format "%s: %s°C, %s°F %s"
(string-join (reverse area-buflist) ", ")
temp_c
temp_f
weather-description)))
締めくくり
この時点で、Emacs内からはすべてがサービスのように見えるというタイトルの主張に納得していただけたことを願っています。さらに、Emacsが提供するAPIの多くは高レベルの抽象化で機能します。wttr.elのコード行数が67行(clocユーティリティを使用した結果)であることを考えてみてください。
それでも多すぎると思うなら、実際のネットワークリクエストとJSON処理をweatherというPythonスクリプトで行う代替実装を想像してみてください。その場合、それを呼び出すElispコマンドは、以下のコードのみになります。
1
2
3
4
5
6
7
8
9
(defun weather (location)
"Call weather script with LOCATION and show result in minibuffer."
(interactive "sWhere (default: local): ")
(let* ((weather-cmd "weather")
(cmd (if location (format "%s %s" weather-cmd location) weather-cmd))
(result (shell-command-to-string cmd)))
(kill-new result)
(message result)))
上記の実際の実装では、シェルコマンドはリクエストを行うための「サービス」として効果的に機能します。
Elispは動的プログラミング言語であるため、Elispライブラリとコマンドラインユーティリティを即興で統合することができます。
この機能は、それが提供する機会を認識するユーザーにとって魅力的です。