用過 Bash 命令行的一定知道,Bash 有幾個特性:
-
TAB
鍵可以用來命令補全 -
↑
或↓
鍵可以用來快速輸入歷史命令 - 還有一些交互式行編輯快捷鍵:
-
C-A
/C-E
將光標移到行首/行尾 -
C-B
/C-F
將光標向左/向右移動一個位置 -
C-D
刪除光標下的一個字符 -
C-K
刪除光標及光標到行尾的所有字符 -
C-U
刪除光標到行首的所有字符 - ...
-
同樣的操作在很多交互式程序都有類似的操作玲献,例如 ftp表牢、gdb 等等忠怖,那么你是否想過這些是如何實現(xiàn)的呢圣贸?如果我們要做一個命令行下的交互式開源軟件巧还,是否希望也能有這些命令補全赖阻、搜索歷史命令框杜、行編輯快捷鍵等等這些人性化的交互方式呢浦楣?
要想實現(xiàn)這些,你有兩種途徑:可以自己寫程序實現(xiàn)咪辱,或者調用開源的庫 Readline Lib振劳。例如上面介紹的 bash、ftp油狂、gdb 等等軟件都使用了 GNU 的開源跨平臺庫历恐,為其提供交互式的文本編輯功能。當然需要注意的是专筷,Readline Library 是 GNU 自由軟件弱贼,在 GNU GPL V3 協(xié)議下發(fā)布,因此如果你的程序中需要用到該庫磷蛹,也必須遵守相關協(xié)議吮旅。
本文首先簡單介紹一下該庫的基本使用方法,后面會稍微詳細介紹下如何使用 Readline 來自定義命令補全功能味咳。
Readline 基本操作
很多命令行交互式程序交互方式都差不多庇勃,輸出提示符,等待用戶輸入命令槽驶,用戶輸入命令之后按回車责嚷,程序開始解析命令并執(zhí)行。那么這里面有個動作是讀入用戶的輸入掂铐,以前我們也許使用 gets()
這樣的函數(shù)來實現(xiàn)罕拂,當我們使用 Readline 庫時,可以使用 readline()
函數(shù)來替換它全陨,該函數(shù)在 ANSI C 中定義如下:
char *readline (char *prompt);
該函數(shù)帶有一個參數(shù) prompt爆班,表示命令提示符,例如 ftp 中就是 "ftp>"辱姨,用戶在后面可以輸入命令蛋济,當按下回車鍵時,程序讀入該行(不包括最后的換行符)存入字符緩沖區(qū)中炮叶,readline
的返回值就是該行文本的指針碗旅。注意:當該行文本不需要使用時渡处,需要釋放該指針指向的空間,防止內存泄漏祟辟。當讀入 EOF
時医瘫,如果還未讀入其它字符,則返回 (char *) NULL
旧困,否則讀入結束醇份,與讀入換行效果相同。
除了能讀入用戶的輸入吼具,我們有時希望交互更簡單些僚纷,例如命令補全。當有很多命令時拗盒,如果希望用戶都能準確記憶命令的拼寫是困難的怖竭,那么一般做法是按下 TAB
鍵進行命令提示及補全,如 ftp 下輸入一個字符c
之后按下 TAB
鍵陡蝇,會列出所有以 c
開頭的命令:
ftp> c
case cd cdup chmod close cr
readline
函數(shù)其實已經給用戶默認的 TAB
補全的功能:根據(jù)當前路徑下文件名來補全痊臭。
如果你不想 Readline 根據(jù)文件名補全,你可以通過 rl_bind_key()
函數(shù)來改變 TAB
鍵的行為登夫。該函數(shù)的原型為:
int rl_bind_key(int key, int (*function)());
該函數(shù)帶有兩個參數(shù):key 是你想綁定鍵的 ASCII 碼字符表示广匙,function 是當 key 鍵按下時觸發(fā)調用函數(shù)的地址。如果想按下 TAB
鍵就輸入一個制表符本身恼策,可以將 TAB
綁定到 rl_insert()
函數(shù)鸦致,這是 Readline 庫提供的函數(shù)。如果 key 不是有效的 ASCII 碼值(0~255之間)涣楷,rl_bind_key()
返回非 0分唾。
這樣,禁止 TAB
的默認行為总棵,下面這樣做就可以了:
rl_bind_key('\t', rl_insert);
這個代碼需要在你程序一開始就調用鳍寂;你可以寫一個函數(shù)叫 initialize_readline()
來執(zhí)行這個動作和其它一些必要的初始化改含,例如安裝用戶自定義補全情龄。
當我們希望輸入 TAB
時不是列出當前路徑下的所有文件,而是列出程序內置的一些命令捍壤,例如上面舉到 ftp 的例子骤视,這種行為稱為自定義補全。 該操作較復雜鹃觉,我們留在后面一節(jié)主要介紹专酗。
基本操作還有一個——搜索歷史。我們希望輸入過的命令行盗扇,還可以通過 C-p
或者 C-s
來搜索到祷肯,那么就需要將命令行加入到歷史列表中沉填,可以調用 add_history()
函數(shù)來完成。但盡量將空行也加入到歷史列表中佑笋,因為空行占用歷史列表的空間而且也毫無用處翼闹。綜上,我們可以寫出一個 Readline 版的 gets()
函數(shù) rl_gets()
:
/* A static variable for holding the line. */
static char *line_read = (char *)NULL;
/* Read a string, and return a pointer to it. Returns NULL on EOF. */
char *
rl_gets ()
{
/* If the buffer has already been allocated, return the memory
to the free pool. */
if (line_read)
{
free (line_read);
line_read = (char *)NULL;
}
/* Get a line from the user. */
line_read = readline ("");
/* If the line has any text in it, save it on the history. */
if (line_read && *line_read)
add_history (line_read);
return (line_read);
}
自定義補全
上面也提到了什么是自定義補全蒋纬,無疑這在命令行交互式程序中是非常重要的猎荠,直接影響到用戶體驗。Readline 庫提供了兩種比較常用的補全方式——按照文件名補全和按照用戶名補全蜀备,分別對應 Readline 中已經實現(xiàn)的兩個函數(shù) rl_filename_completion_function
和 rl_username_completion_function
关摇。如果我們既不希望按照文件名和用戶名來補全,希望按照程序的命令補全碾阁,應該怎么做呢输虱?也很容易想到,只要實現(xiàn)自己的補全函數(shù)就好了瓷蛙。
Readline 補全的工作原理如下:
- 用戶接口函數(shù)
rl_complete()
調用rl_completion_matches()
來產生可能的補全列表悼瓮; - 內部函數(shù)
rl_completion_matches()
使用程序提供的 generator 函數(shù)來產生補全列表,并返回這些匹配的數(shù)組艰猬,在此之前需要將 generator 函數(shù)的地址放到rl_completion_entry_function
變量中横堡,例如上面提到的按文件名或用戶名補全函數(shù)就是不同的 generators; -
generator 函數(shù)在
rl_completion_matches()
中不斷被調用冠桃,每次返回一個字符串命贴。generator 函數(shù)帶有兩個參數(shù):text 是需要補全的單詞的部分,state 在函數(shù)第一次調用時為 0食听,接下來調用時非 0胸蛛。generator 函數(shù)返回(char *)NULL
通知rl_completion_matches()
沒有剩下可能的匹配。
Readline 庫中有個變量 rl_attempted_completion_function
樱报,改變量類型是一個函數(shù)指針rl_completion_func_t *
葬项,我們可以將該變量設置我們自定義的產生匹配的函數(shù),該按下 TAB
鍵時會調用該函數(shù)迹蛤,函數(shù)具有三個參數(shù):
-
text: 該參數(shù)是待補全的單詞的部分民珍,例如在 Bash 提示符后輸入一個
c
字符,按下TAB
盗飒,此時 text指向的是 "c" 字符串的指針嚷量;在 Bash 提示符后輸入一個cd /home/gu
字符串,按下TAB
逆趣,此時 text指向的是 "/home/gu" 字符串的指針蝶溶; - start: text 字符串在該行輸入中的起始位置,例如對于上面的例子宣渗,第一種情況下是 0抖所,第二種情況下是 3梨州;
- end: text 字符串在該行輸入中的結束位置,例如對于上面的例子田轧,第一種情況下是 1摊唇,第二種情況下是 11。
我們自定義的補全函數(shù)可以根據(jù)傳入的參數(shù)來設置我們希望按照什么方式補全涯鲁,例如對于 Bash 下的 cd
命令巷查,我們希望開始是命令補全,當命令補全之后抹腿,后面接著跟的是文件名補全岛请,這樣可以使用rl_completion_matches()
來綁定使用哪種 generator,rl_completion_matches()
函數(shù)的原型是:
char ** rl_completion_matches (const char *text, rl_compentry_func_t *entry_func)
帶有兩個參數(shù):text 就是上面介紹的傳入的待補全的單詞警绩,第二個參數(shù) entry_func 是上面反復介紹的generator 函數(shù)的指針崇败。該函數(shù)的返回值是 generator 產生的可能匹配 text 的字符串數(shù)組指針,該數(shù)組的最后一項是 NULL
指針肩祥。
好了后室,上面說了這么多關于自定義補全的函數(shù)和變量,到底怎么用呢混狠,估計還是比較模糊岸霹,那么看一個例子估計就很清楚了,這個例子是 Readline 官方提供的示例程序将饺,由于比較長贡避,就不在這里貼出來了,你可以在 http://cnswww.cns.cwru.edu/php/chet/readline/readline.html#SEC49 找到予弧。
總結
其實刮吧,雖然說了很多,但還只是 Readline 庫的皮毛掖蛤,這個庫的功能遠遠比這強大的多杀捻,如果想深入了解并且運用,你必須要做三件事:
- Read The Fucking Manual:閱讀官方的 文檔
- Read The Fucking Source Code:閱讀官方提供的例子代碼蚓庭,如果想了解更深入可以去看 Readline 的源碼
- Show Your Code:自己動手寫幾個例子試試致讥,如果有機會運用到你的項目中。