參考:Learning GNU
Emacs 3/e,9.8.The Lisp Modes,11.Emacs Lisp Programming
Emacs有三種Lisp模式,其命令名稱如下:
emacs-lisp-mode | 用于Emacs Lisp代碼的編輯(文件名.emacs或后綴.el) |
lisp-mode | 用來編輯另一個(gè)Lisp系統(tǒng)的Lisp代碼(后綴.l或.lisp) |
lisp-interaction-mode | 用來編輯和運(yùn)行Emacs Lisp代碼(交互模式) |
本文只討論 lisp-interaction-mode模式。
缺省情況下*scratch*就是處于這種模式,無后綴的文件名一般也會(huì)讓Emacs進(jìn)入Lisp交互模式,當(dāng)然你可以使用變量auto-mode-alist進(jìn)行設(shè)置。
鍵
入 M-x lisp-interaction-mode
Enter(回車)可以讓任何buffer進(jìn)入Lisp交互模式;如要新建一個(gè)Lisp交互buffer,只需鍵入C-x
b(即switch-to-buffer命令),輸入buffer名,然后令該buffer進(jìn)入Lisp交互模式。
Lisp交互模式和
Emacs
Lisp模式完全一致,除一個(gè)重要特性外:C-j已綁定到eval-print-last-sexp命令上。該命令提取point之前的那個(gè)S-
expression,對其進(jìn)行評(píng)估,然后在buffer里打印結(jié)果。如果要使用其它模式里綁定到C-j的常見功能newline-and-
indent,你必須按下Enter,并緊跟Tab鍵。
記住
S-expression是任何符合Lisp語法的表達(dá)式。因此,可以使用
Lisp交互模式的C-j來檢查變量的值,確認(rèn)函數(shù)定義,運(yùn)行函數(shù)等等。比如,如果你輸入auto-save-interval并按下C-j,就會(huì)顯示該
變量的值(缺省為300)。如果你輸入一個(gè)defun并在其最右邊的括號(hào)后按下C-j,Emacs會(huì)保存所定義的函數(shù)(供以后調(diào)用)并輸出其名稱;這種情
況下,C-j類似C-M-x(即eval-defun命令),不過光標(biāo)必須位于所定義的函數(shù)之后(因?yàn)橛锌赡茉诙x前或中間)。如果你調(diào)用了一個(gè)函數(shù),
Emacs就會(huì)評(píng)估(運(yùn)行)該表達(dá)式并顯示函數(shù)的所有返回值。
Lisp交互模式的C-j提供了很棒的功能,你可以用它來增量方式開發(fā)和調(diào)試Emacs Lisp代碼;因?yàn)镋macs Lisp是種“真正的”Lisp,它甚至可用來開發(fā)其它Lisp系統(tǒng)的代碼片斷。
基本Lisp實(shí)體
你需要熟悉Lisp基本元素包括函數(shù)、變量和atom(原子)。函數(shù)是Lisp的唯一程序單元(program unit),涵蓋了其它語言的過程、子程序、程序甚至操作符等標(biāo)記。
函
數(shù)被定義作上述實(shí)體的列表(list),通常是對其它現(xiàn)存函數(shù)調(diào)用的列表。所有函數(shù)都有返回值(return
value)(類似Perl函數(shù)和non-void
Java函數(shù));函數(shù)的返回值就是list里最后一項(xiàng)的值,一般是最后調(diào)用的函數(shù)返回的值。在其它函數(shù)里的函數(shù)調(diào)用等價(jià)于其它語言的語句
(statement),函數(shù)的語法如下:
(function-name argument1 argument2 ...)等價(jià)于Java的:
method_name (argument1, argument2, ...);這一語法用于所有函數(shù),包括那些等價(jià)于其它語言的算術(shù)或比較運(yùn)算符。例如,在Java或Perl里2加4,你會(huì)用表達(dá)式2+4,而在Lisp里你會(huì)使用如下寫法:
(+ 2 4)類似的,4 >= 2的Lisp方式:
(>= 4 2)Lisp中的變量和其它語言的相似,不過沒有類型。Lisp變量能夠推測任何類型的值(值本身沒有類型,不過變量對其能存放的內(nèi)容不加任何限制)。
原子(atom)是個(gè)任意類型的值,包括整數(shù)、浮點(diǎn)(實(shí))數(shù)、字符、字符串、布爾值、符號(hào)(symbol)和Emacs特殊類型如buffer、window和process。各種atom的語法如下:
- 整數(shù):和你常用的一樣,有符號(hào),范圍-2+27至2+27 - 1;
- 浮點(diǎn)數(shù):可用十進(jìn)制和科學(xué)計(jì)數(shù)法表示的實(shí)數(shù)。例如5489可寫成5489、5.489e3、546.9e1等;
- 字符:以問號(hào)開頭,如 ?a 。Esc、Newline和Tab可分別簡寫為\e、\n和\t;其它控制字符可以加\C-前綴來表示,例如C-a表示為?\C-a。整數(shù)也可用來表示字符,如ASCII表等。
- 字符串:用雙引號(hào)包圍;字符串里的引號(hào)標(biāo)記和\需要加上\,"Jane said, \"See Dick run.\""是個(gè)合法字符串。字符串可以分割成多行,不需特殊語法。結(jié)束引號(hào)前的所有內(nèi)容包括所有斷行符都是字符串值的一部分。
- 布爾值:大部分情況下真值為t,假值為nil,如果能預(yù)估到布爾值,則任何非nil值都被看作真值。nil也被用作null或nonvalue。
- 符號(hào):Lisp實(shí)體名,如變量或函數(shù)名。有時(shí)需要引用實(shí)體的名字而非其值,這時(shí)可以在名字前加上單引號(hào)(')。
setq用來賦值給變量,是個(gè)函數(shù),而不象其它語言里用來賦值的專門語法=或:=。setq接收兩個(gè)參數(shù):一個(gè)變量名和一個(gè)值。也可以進(jìn)行多次賦值,如:
(setq thisvar thisvalue
thatvar thatvalue
theothervar theothervalue)
也可用其它方法設(shè)置值或變量,不過setq是使用最廣的方法。
函數(shù)定義
首先熟悉一下Lisp語法的特殊表示。- 用作“割斷”字符用來分隔變量、函數(shù)等名稱里的字(word),這是Lisp編程慣用法,類似C和Ada里的“_”。
A
more important issue has to do with all of the parentheses in Lisp
code. Lisp is an old language that was designed before anyone gave much
thought to language syntax (it was still considered amazing that you
could use any language other than the native processor's binary
instruction set), so its syntax is not exactly programmer-friendly. Yet
Lisp's heavy use of lists?aand thus its heavy use of parentheses?ahas
its advantages, as we'll see toward the end of this chapter.
讓我們從一個(gè)實(shí)例開始。
1 (defun count-words-buffer ( )
2 (let ((count 0))
3 (save-excursion
4 (goto-char (point-min))
5 (while (< (point) (point-max))
6 (forward-word 1)
7 (setq count (1+ count)))
8 (message "buffer contains %d words." count))))
defun:
指定函數(shù)名和參數(shù)來定義函數(shù)。注意defun本身是一個(gè)函數(shù)――被調(diào)用時(shí),定義一個(gè)新函數(shù)。(defun返回把所定義的函數(shù)作為一個(gè)symbol返回。)
函數(shù)的參數(shù)顯示為在括號(hào)內(nèi)的一個(gè)名字list;本例,函數(shù)沒有參數(shù)。如果在參數(shù)前加關(guān)鍵字&optional就表示參數(shù)是optional(可選
的)。如果參數(shù)是optional的,在函數(shù)調(diào)用時(shí)未指定該參數(shù),則認(rèn)為其值為nil。
(let ((var1 value1) (var2 value2) ... )
statement-block)
let:1.定義(或聲明)一個(gè)變量list;2.變量設(shè)置初始值,同setq;3.創(chuàng)建一個(gè)語句塊(類似函數(shù)體),在此塊內(nèi)這些變量可用,let塊即這些變量的scope(作用域)。let里定義的變量可用setq改變其值,不過要小心使用setq。
save
-excursion:Emacs內(nèi)建函數(shù),保存光標(biāo)原來的位置(因?yàn)?count-words-buffer函數(shù)要移動(dòng)光標(biāo)以便計(jì)算字?jǐn)?shù))。調(diào)用
save-excursion就是要求Emacs記住實(shí)例函數(shù)開始執(zhí)行時(shí)的光標(biāo)位置,并在執(zhí)行完函數(shù)體內(nèi)的所有語句后返回至初始光標(biāo)位置。
goto
-char:Emacs內(nèi)建函數(shù),其參數(shù)是個(gè)(內(nèi)嵌)函數(shù)調(diào)用,調(diào)用內(nèi)建函數(shù)point-min。point是Emacs內(nèi)部名稱,表示光標(biāo)的當(dāng)前位置。
point-min返回當(dāng)前buffer里第一個(gè)字符的位置值,幾乎總是1;這樣goto-char調(diào)用時(shí)其參數(shù)值為1,效果等同于把point移至
buffer起始處。
(while condition statement-block)和let
及save-excursion一樣,while也建立了一個(gè)語句塊。condition是個(gè)值(atom、變量或返回一個(gè)值的函數(shù))。while對這個(gè)
值進(jìn)行測試,如果其值不是nil,則認(rèn)為條件(condition)為真,語句塊得以執(zhí)行,然后condition再次被測試,之后重復(fù)上述過程。當(dāng)然也
可以寫個(gè)無限循環(huán),如果你試圖執(zhí)行這樣的語句,Emacs會(huì)掛起,鍵入C-g終止。
在實(shí)例函數(shù)中,condition是函數(shù) <
,即帶兩個(gè)參數(shù)的小于函數(shù),類似Java或Perl里的<運(yùn)算符。第一個(gè)參數(shù)是另一個(gè)函數(shù),它返回point的當(dāng)前字符位置;第二個(gè)參數(shù)返回 buffer里的最大(最后)字符位置,即buffer的長度。函數(shù)="">< (和其它關(guān)系函數(shù))返回一個(gè)布爾值,t 或 nil。
上
述循環(huán)的語句塊由兩條語句組成。第6行會(huì)把point往前移動(dòng)一個(gè)字(word,即相當(dāng)于M-f)。第7行,循環(huán)計(jì)數(shù)器加一;函數(shù) 1+ 是(+ 1
variable-name)的簡寫方式。注意第三個(gè)右括號(hào)(第7行)和while前面的左括號(hào)匹配。這樣,在計(jì)算字?jǐn)?shù)時(shí),while循環(huán)會(huì)讓Emacs
一次一個(gè)字(word)遍歷整個(gè)當(dāng)前buffer。
實(shí)例函數(shù)的最后一個(gè)語句使用內(nèi)建函數(shù)message在minibuffer里打印一行信息,提示buffer所含的字?jǐn)?shù)。message函數(shù)的格式類似C語言。
Message格式字符串 格式字符串 | 含義 |
---|
%s | 字符串或symbol |
%c | 字符 |
%d | 整數(shù) |
%e | 科學(xué)計(jì)數(shù)法表示的浮點(diǎn)數(shù) |
%f | 十進(jìn)制表示的浮點(diǎn)數(shù) |
%g | 任意格式的浮點(diǎn)數(shù),產(chǎn)生最短的字符串 |
將Lisp函數(shù)變?yōu)镋macs命令
函
數(shù)
count-words-buffer已編寫完成,接下來該如何運(yùn)行?在交互模式中,可以把光標(biāo)移到函數(shù)的結(jié)束括號(hào),然后鍵入C-j(或
Linefeed),讓Emacs執(zhí)行函數(shù)定義。你應(yīng)該看到該函數(shù)的名字會(huì)再次出現(xiàn)在buffer里;defun函數(shù)的返回值就是已定義的符號(hào)(即函數(shù)名
稱)。
函數(shù)定義之后,可以在Lisp交互窗口中輸入一行 (count-words-buffer) ,然后在結(jié)束括號(hào)后再次按下 C-j 。
如
果你象其它Emacs命令一樣用M-x來執(zhí)行上述函數(shù),M-x count-words-buffer Enter,會(huì)得到錯(cuò)誤提示信息 [No
match]。這是因?yàn)槟悴⑽丛贓macs中“注冊”該函數(shù),使其可供交互(interactive)使用。實(shí)現(xiàn)這一功能的函數(shù)是
interactive ,形式如下:
(interactive "prompt-string")上述語句必須出現(xiàn)在函數(shù)開始處,即緊隨defun和文檔說明字符串所在行之后。使用 interactive 會(huì)讓Emacs把函數(shù)注冊為一個(gè)命令,并提示用戶輸入defun語句中聲明的參數(shù)。提示字符串為可選。
提示字符串有一個(gè)特殊的格式:你要為想提示用戶輸入的每個(gè)參數(shù)都提供一段提示字符串,這些段用“\n”分隔。
用于interactive函數(shù)的參數(shù)代碼代 碼
| 提示用戶輸入 |
---|
b
| 現(xiàn)存buffer的名稱 |
e
| 事件(鼠標(biāo)動(dòng)作或 function key press) |
f
| 現(xiàn)存文件的名稱 |
n
| 數(shù)字(整數(shù)) |
s
| 字符串 |
| 上述代碼都有一個(gè)大寫的變種 |
B | 可能不存在的buffer名稱 |
F | 可能不存在的文件名稱 |
N
| 數(shù)字,unless command is invoked with a prefix argument, in which case use the prefix argument and skip this prompt |
S | 符號(hào) |
示例:
(defun replace-string (from to)
(interactive "sReplace string: \nsReplace string %s with: ")
...)
回
到 count-words-buffer 命令:它不需參數(shù),因此 interactive
命令不需要提示字符串。另外可以再給我們的命令添加一個(gè)文檔說明字符串(doc
string),它會(huì)顯示在describe-function(C-h f)之類的在線幫助工具中。Doc
string是普通的Lisp字符串,可選,行數(shù)長度任意,不過一般來說,第一行是個(gè)簡要完整的句子,說明命令的功能。注意字符串里的任意雙引號(hào)前必須加
上 \ 。
(defun count-words-buffer ( )
"Count the number of words in the current buffer;
print a message in the minibuffer with the result."
(interactive)
(save-excursion
(let ((count 0))
(goto-char (point-min))
(while (< (point) (point-max))
(forward-word 1)
(setq count (1+ count)))
(message "buffer contains %d words." count))))
運(yùn)算符。第一個(gè)參數(shù)是另一個(gè)函數(shù),它返回point的當(dāng)前字符位置;第二個(gè)參數(shù)返回>