2021-07-13 GNU Readline 庫及編程簡介 [轉載]

用過 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_functionrl_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() 來綁定使用哪種 generatorrl_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:自己動手寫幾個例子試試致讥,如果有機會運用到你的項目中。
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末彪置,一起剝皮案震驚了整個濱河市拄踪,隨后出現(xiàn)的幾起案子蝇恶,更是在濱河造成了極大的恐慌拳魁,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,826評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件撮弧,死亡現(xiàn)場離奇詭異潘懊,居然都是意外死亡姚糊,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,968評論 3 395
  • 文/潘曉璐 我一進店門授舟,熙熙樓的掌柜王于貴愁眉苦臉地迎上來救恨,“玉大人,你說我怎么就攤上這事释树〕Σ郏” “怎么了?”我有些...
    開封第一講書人閱讀 164,234評論 0 354
  • 文/不壞的土叔 我叫張陵奢啥,是天一觀的道長秸仙。 經常有香客問我,道長桩盲,這世上最難降的妖魔是什么寂纪? 我笑而不...
    開封第一講書人閱讀 58,562評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮赌结,結果婚禮上捞蛋,老公的妹妹穿的比我還像新娘。我一直安慰自己柬姚,他們只是感情好拟杉,可當我...
    茶點故事閱讀 67,611評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著量承,像睡著了一般捣域。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上宴合,一...
    開封第一講書人閱讀 51,482評論 1 302
  • 那天焕梅,我揣著相機與錄音,去河邊找鬼卦洽。 笑死贞言,一個胖子當著我的面吹牛,可吹牛的內容都是我干的阀蒂。 我是一名探鬼主播该窗,決...
    沈念sama閱讀 40,271評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼蚤霞!你這毒婦竟也來了凌节?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,166評論 0 276
  • 序言:老撾萬榮一對情侶失蹤盯荤,失蹤者是張志新(化名)和其女友劉穎侯勉,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 45,608評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡拖刃,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,814評論 3 336
  • 正文 我和宋清朗相戀三年删壮,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片兑牡。...
    茶點故事閱讀 39,926評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡央碟,死狀恐怖,靈堂內的尸體忽然破棺而出均函,到底是詐尸還是另有隱情亿虽,我是刑警寧澤,帶...
    沈念sama閱讀 35,644評論 5 346
  • 正文 年R本政府宣布苞也,位于F島的核電站经柴,受9級特大地震影響,放射性物質發(fā)生泄漏墩朦。R本人自食惡果不足惜坯认,卻給世界環(huán)境...
    茶點故事閱讀 41,249評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望氓涣。 院中可真熱鬧牛哺,春花似錦、人聲如沸劳吠。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,866評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽痒玩。三九已至淳附,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間蠢古,已是汗流浹背奴曙。 一陣腳步聲響...
    開封第一講書人閱讀 32,991評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留草讶,地道東北人洽糟。 一個月前我還...
    沈念sama閱讀 48,063評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像堕战,于是被迫代替她去往敵國和親坤溃。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,871評論 2 354

推薦閱讀更多精彩內容

  • Node.js中文網的 v6.10.3 文檔提供了readline模塊嘱丢,可以從可讀流(process.stdin)...
    Evtion閱讀 5,463評論 0 4
  • require('readline') 模塊提供了一個接口薪介,用于從可讀流(如 process.stdin)讀取數(shù)據(jù)...
    imakan閱讀 10,124評論 0 1
  • https://nodejs.org/api/documentation.html 工具模塊 Assert 測試 ...
    KeKeMars閱讀 6,332評論 0 6
  • 官網 中文版本 好的網站 Content-type: text/htmlBASH Section: User ...
    不排版閱讀 4,381評論 0 5
  • 我是黑夜里大雨紛飛的人啊 1 “又到一年六月,有人笑有人哭越驻,有人歡樂有人憂愁汁政,有人驚喜有人失落道偷,有的覺得收獲滿滿有...
    陌忘宇閱讀 8,536評論 28 53