學習 Elisp 是如何處理變數的,以及如何在你的指令碼與設定中使用它們。
GNU Emacs 是由 C 和 Emacs Lisp(Elisp,Lisp 程式語言的一種方言)寫成,它是一個編輯器的同時,又碰巧是 Elisp 的沙盒。因此,理解 Elisp 中的一些基本程式設計概念會對你有一些幫助。
如果你是 Emacs 新手,請先閱讀 Sacha Chua 的《給 Emacs 新手的資源》精品帖。本篇文章假定你熟悉常見的 Emacs 術語,並且能夠閱讀並求值 Elisp 程式碼的簡單片段。最好你也聽說過變數作用域的概念,知道它在其它程式語言中的作用。本篇文章中的範例假定你使用的是相對較新的 Emacs 版本(v.25 之後的版本)。
Elisp 手冊 包含了 Elisp 的方方面面,但它是寫給那些有明確查詢目標的人們的(它在這方面也做得相當棒)。但是很多人想要能夠在更高的層次上解釋 Elisp 概念的材料,同時將資訊壓縮成最精華的部分。本篇文章也正是我回應這種呼聲的一次嘗試,為讀者描繪基礎的大體輪廓。使他們能在設定中用上這些技巧,也讓他們在手冊中查詢細節變得更容易。
用 defcustom
定義的使用者設定和用 defvar
或 defconst
定義的變數是全域性的。使用 defcustom
或 defvar
宣告變數的一個非常重要的原因是,當一個變數已經被係結,對它們進行重新求值不會覆蓋掉已有的值。舉個栗子,如果你在初始化檔案中對 my-var
進行如下系結:
(setq my-var nil)
對如下表示式求值不會將變數覆蓋為 t
:
(defvar my-var t)
注意此處有一個例外:如果你用 C-M-x
快捷鍵對上述宣告求值,它將呼叫 eval-defun
函數,並將變數覆蓋為 t
。通過此方式,你可以按需將變數強制覆蓋。這種行為是刻意而為之的:你可能知道,Emacs 中的許多特性是按需載入的,也可以稱為自動載入。如果那些檔案中的宣告將變數覆蓋為它們的預設值,那它也就覆蓋了你初始化檔案中的設定。
使用者選項就是使用 defcustom
宣告的全域性變數。與使用 defvar
宣告的變數不同,這些變數可以用 M-x customize
介面來設定。據我所知,大部分人因為覺得它開銷較大而不經常使用。一旦你知道如何在你的初始化檔案中設定變數,也就沒有理由一定要去使用它了。許多使用者沒有意識到的一個細節是,通過 customize
的方式設定使用者選項能夠執行程式碼,有的時間可用來執行一些附加的設定說明:
(defcustom my-option t "My user option." :set (lambda (sym val) (set-default sym val) (message "Set %s to %s" sym val)))
若你對這段程式碼求值,並鍵入 M-x customize-option RET my-option RET
執行 customize
介面,lambda 匿名函數就會被呼叫,回顯區域就會顯示出該選項的符號名與值。
如果你在初始化檔案中使用 setq
改變該選項的值,那麼匿名函數不會執行。要想在 Elisp 中正確設定一個選項,你需要使用函數 customize-set-variable
。或者,人們在他們的組態檔中使用了各種版本的 csetq
宏來自動處理(如你所願,你可以通過 GitHub 的程式碼搜尋發現更複雜的變體)。
(defmacro csetq (sym val) `(funcall (or (get ',sym 'custom-set) 'set-default) ',sym ,val))
若你正在使用 use-package 宏,:custom
關鍵字會替你處理好以上這些。
在你將以上程式碼放入到你的初始化檔案中之後,你便可以使用 csetq
宏在設定變數的同時執行任何現存的 setter
函數。要證明這點,你可以使用此宏來改變上面定義的選項,並觀察回顯區域的訊息輸出。
(csetq my-option nil)
當你在使用其它程式語言時,你可能不會意識到動態系結與詞法系結的區別。當今的大部分程式語言使用詞法系結,並且在學習變數作用域與變數查詢時也沒有必要去了解它們之間的區別。
如此看來,Emacs Lisp 比較特殊因為動態系結是預設選項,詞法系結需要顯式啟用。這裡有一些歷史遺留原因,但在實際使用中,你應該時刻啟用詞法系結,因為它更快並且不容易出錯。要啟用詞法系結,只需將如下的註釋行作為你的 Emacs Lisp 檔案的第一行:
;;; -*- lexical-binding: t; -*-
另一種方式,你可以呼叫 add-file-local-variable-prop-line
,在你選擇將變數 lexical-binding
置為 t
後,會自動插入如上的注釋行。
在載入包含如上特殊格式行的檔案時,Emacs 會相應地設定變數,這意味著該緩衝區中的程式碼載入時啟用了詞法系結。若要採用互動式的方式,你可以呼叫 M-x eval-buffer
命令,它會將詞法系結考慮在內。
既然你已經知道了如何啟用詞法系結,那麼了解這些術語的含義就很明智了。對於動態系結,在程式執行期間建立的最後一個系結將用於變數查詢。你可以通過將以下程式碼放入空緩衝區並執行 M-x eval buffer
,以對此進行測試:
(defun a-exists-only-in-my-body (a) (other-function))(defun other-function () (message "I see `a', its value is %s" a))(a-exists-only-in-my-body t)
你可能會很驚訝地發現,在 other-function
中查詢變數 a
竟然成功了。
若你在頂部新增了特殊的詞法系結註釋後,重新執行前面的範例,這段程式碼將丟擲 variable is void
錯誤,因為 other-functioin
無法識別變數 a
。如果你使用的是其它程式語言,這才是你所期望的行為。
啟用詞法系結後,作用域會由周圍的程式碼所定義。這並不單單是效能原因,時間也已經表明了詞法系結才是更受喜愛的。
如你所知,let
用於臨時建立區域性系結:
(let ((a "I'm a") (b "I'm b")) (message "Hello, %s. Hello %s" a b))
接下來有趣的是——使用 defcustom
、defvar
以及 defconst
定義的變數被稱為特殊變數,不論詞法系結是否啟用,它們都將使用動態系結:
;;; -*- lexical-binding: t; -*-(defun some-other-function () (message "I see `c', its value is: %s" c))(defvar c t)(let ((a "I'm lexically bound") (c "I'm special and therefore dynamically bound")) (some-other-function) (message "I see `a', its values is: %s" a))
通過 C-h e
切換至 Messages
緩衝區,檢視上述範例輸出的訊息。
使用 let
或者函數引數系結的區域性變數會遵循由 lexical-binding
變數定義的查詢規則,但使用 defvar
、defconst
或 defcustom
定義的全域性變數,能夠沿著呼叫棧在 let
表示式中被修改。
這種技巧允許方便地進行特殊客製化,並且經常在 Emacs 中被使用。這並不奇怪,畢竟 Emacs Lisp 最開始只提供動態系結作為唯一選擇。下面是一個常見的範例,說明如何向唯讀緩衝區臨時寫入資料:
(let ((inhibit-read-only t)) (insert ...))
這是另一個常見的範例,如何進行大小寫敏感的搜尋:
(let ((case-fold-search nil)) (some-function-which-uses-search ...))
動態系結允許你採用作者未曾預料的方式對函數進行修改。對於像 Emacs 這樣設計使用的程式來說,這是個強大的工具與特性。
有一點需要注意:你可能會意外地使用區域性變數名,該變數在其他地方被宣告為特殊變數。防止這種衝突的一個技巧是避免在區域性變數名中使用下劃線。在我當前的 Emacs 對談中,以下程式碼只留下少數潛在衝突的候選:
(let ((vars ())) (mapatoms (lambda (cand) (when (and (boundp cand) (not (keywordp cand)) (special-variable-p cand) (not (string-match "-" (symbol-name cand)))) (push cand vars)))) vars) ;; => (t obarray noninteractive debugger nil)
每個緩衝區都能夠擁有變數的一個區域性系結。這就意味著對於任何變數,都會首先在當前緩衝區中查詢緩衝區區域性變數取代預設值。區域性變數是 Emacs 中一個非常重要的特性,比如它們被主模式用來建立緩衝區範圍內的行為與設定。
事實上你已經在本文中見過緩衝區區域性變數——也就是將 lexical-binding
在緩衝區範圍內設定為 t
的特殊注釋行。在 Emacs 中,在特殊注釋行中定義的緩衝區區域性變數也被稱為檔案區域性變數。
任何的全域性變數都可以用緩衝區區域性變數來遮掩,比如上面定義的變數 my-var
,你可用如下方式設定區域性變數:
(setq-local my-var t);; or (set (make-local-variable 'my-var) t)
此時 my-var
對於你在對上述程式碼進行求值時對應的緩衝區來說就是區域性變數。若你對它呼叫 describe-variable
,文件會同時告訴你區域性與全域性的值。從程式設計的角度來講,你可以分別用 buffer-local-value
獲取區域性值,用 default-value
獲取全域性值。若要移除區域性值,你可以呼叫 kill-local-variable
。
另一個需要注意的重要性質就是,一旦一個變數成為緩衝區區域性變數,後續在該緩衝區中使用的 setq
都將只能設定區域性的值。要想設定預設值,你需要使用 setq-default
。
因為區域性變數意味著對緩衝區的客製化,它們也就經常被用於模式勾點中。一個典型的例子如下所示:
(add-hook 'go-mode-hook (defun go-setup+ () (setq-local compile-command (if (string-suffix-p "_test.go" buffer-file-name) "go test -v" (format "go run %s" (shell-quote-argument (file-name-nondirectory buffer-file-name)))))))
這將設定 go-mode
緩衝區中 M-x compile
使用的編譯命令。
另一個重要的方面就是一些變數會自動成為緩衝區區域性變數。這也就意味著當你使用 setq
設定這樣一個變數時,它會針對當前緩衝區設定區域性系結。這個特性不應該被經常使用,因為這種隱式的行為並不好。不過如果你想的話,你可以使用如下方法建立自動區域性變數:
(defvar-local my-automatical-local-var t);; or (make-variable-buffer-local 'my-automatical-local-var)
變數 indent-tabs-mode
就是 Emacs 內建的一個例子。如果你在初始化檔案中使用 setq
改變變數的值,根本不會影響預設值。只有在你載入初始化檔案時正處在當前的緩衝區的區域性值會被改變。因此,你需要使用 setq-default
來改變 indent-tabs-mode
的預設值。
Emacs 是一個強大的編輯器,並且隨著你的客製化它將變得更加強大。現在,你知道了 Elisp 是如何處理變數的,以及你應如何在你自己的指令碼與設定中使用它們。
本篇文章此前採用 CC BY-NC-SA 4.0 許可證發布在 With-Emacs 上,經過修改(帶有合併請求)並在作者允許的情況下重新發布。