GNU Readline库函数的应用示例

说明

GNU Readline是一个跨平台开源程序库，提供交互式的文本编辑功能。应用程序借助该库函数，允许用户编辑键入的命令行，并提供自动补全和命令历史等功能。Bash(Bourne Again Shell)、GDB、ftp 和mail等程序就使用Readline库提供其命令行界面。

Readline是GNU通用公共许可证版本3(GNU GPLv3)下的自由软件。这意味着若发布或分发的程序使用Readline库，则该程序必须是自由软件，并持有GPL-兼容的许可证。当然，用户也可使用自己的实现替代库的行为。

本文将基于若干典型的Readline库函数，给出一个简单的交互式调测器示例。示例代码的运行环境如下：

一  函数介绍

本节简要介绍后文将要用到的几个Readline库函数，如用来替代fgets()的readline()函数。关于库函数的更多描述可参考http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html。

readline()函数的ANSI C声明如下：

char *readline(const char *prompt);

该函数打印参数prompt 所指的提示字符串，然后读取并返回用户输入的单行文本(剔除换行符)。若prompt 为空指针或指向空字符串，则不显示任何提示。若尚未读取到字符就遇到EOF，则该函数返回NULL；否则返回由malloc()分配的命令行内存，故调用结束后应通过free()显式地释放内存。

读取命令行后，可调用add_history()函数将该行存入命令行历史列表中，以便后续重取。

void add_history(const char *string);

rl_completion_matches()函数用于自动补全：

typedef char *rl_compentry_func_t(const char *text, int state);

char **rl_completion_matches(const char *text, rl_compentry_func_t *entry_func);

该函数返回一个字符串数组，即参数text的补全列表；若没有补全项，则函数返回NULL。该数组以空指针结尾，首个条目将替换text，其余条目为可能的补全项。函数指针entry_func指向一个具有两个参数的函数。其中参数state在首次调用时为零，后续调用时为非零。未匹配到text时，entry_func返回空指针。

函数指针rl_completion_entry_function指向rl_completion_matches()所使用的补全生成函数：

rl_compentry_func_t *rl_completion_entry_function;

若其值为空，则使用默认的文件名补全生成函数，即rl_filename_completion_function()。

应用程序可通过函数指针rl_attempted_completion_function自定义补全函数：

typedef char **rl_completion_func_t(const char *text, int start, int end);

rl_completion_func_t * rl_attempted_completion_function;

该变量指向创建匹配补全的替代函数。函数参数 start和 end为字符串缓冲区rl_line_buffer的下标，以定义参数text的边界。若该函数存在且返回NULL，或者该变量值被设置为NULL，则rl_complete()将调用rl_completion_entry_function指向的函数来生成匹配结果；除此之外，程序使用该变量所指函数返回的字符串数组。若该变量所指函数将变量rl_attempted_completion_over设置为非零值，则Readline将不执行默认的文件名补全(即使自定义补全函数匹配失败)。

二  示例代码

首先，自定义用户命令结构及其执行函数(为简化实现，执行函数仅打印函数名)：

 //命令结构体
 typedef int (*CmdProcFunc)(void);
 typedef struct{
     char         *pszCmd;
     CmdProcFunc  fpCmd;
 }CMD_PROC;

 //命令处理函数定义
 #define MOCK_FUNC(funcName) \
     int funcName(void){printf("  Enter "#funcName"!\n"); return ;}

 MOCK_FUNC(ShowMeInfo);
 MOCK_FUNC(SetLogCtrl);
 MOCK_FUNC(TestBatch);
 MOCK_FUNC(TestEndianOper);

基于上述定义，创建命令列表如下：

 //命令表项宏，用于简化书写
 #define CMD_ENTRY(cmdStr, func)     {cmdStr, func}
 #define CMD_ENTRY_END               {NULL,   NULL}

 //命令表
 static CMD_PROC gCmdMap[] = {
     CMD_ENTRY("ShowMeInfo",       ShowMeInfo),
     CMD_ENTRY("SetLogCtrl",       SetLogCtrl),
     CMD_ENTRY("TestBatch",        TestBatch),
     CMD_ENTRY("TestEndian",       TestEndianOper),

     CMD_ENTRY_END
 };
 #define CMD_MAP_NUM     (sizeof(gCmdMap)/sizeof(CMD_PROC)) - 1/*End*/

然后，提供两个检索命令列表的函数：

 //返回gCmdMap中的CmdStr列(必须为只读字符串)，以供CmdGenerator使用
 static char *GetCmdByIndex(unsigned int dwCmdIndex)
 {
     if(dwCmdIndex >=  CMD_MAP_NUM)
         return NULL;
     return gCmdMap[dwCmdIndex].pszCmd;
 }

 //执行命令
 static int ExecCmd(char *pszCmdLine)
 {
     if(NULL == pszCmdLine)
         return -;

     unsigned int dwCmdIndex = ;
     for(; dwCmdIndex < CMD_MAP_NUM; dwCmdIndex++)
     {
         if(!strcmp(pszCmdLine, gCmdMap[dwCmdIndex].pszCmd))
             break;
     }
     if(CMD_MAP_NUM == dwCmdIndex)
         return -;
     gCmdMap[dwCmdIndex].fpCmd(); //调用相应的函数

     return ;
 }

     以上代码独立于Readline库，接下来将编写与该库相关的代码。

考虑到实际应用中，程序运行平台不一定包含Readline库，因此需要用__READLINE_DEBUG条件编译控制库的使用。

 #ifdef __READLINE_DEBUG
 #include <readline/readline.h>
 #include <readline/history.h>

 static const char * const pszCmdPrompt = "clover>>";

 //退出交互式调测器的命令(不区分大小写)
 static const char *pszQuitCmd[] = {"Quit", "Exit", "End", "Bye", "Q", "E", "B"};
 static const unsigned char ucQuitCmdNum = sizeof(pszQuitCmd) / sizeof(pszQuitCmd[]);
 static int IsUserQuitCmd(char *pszCmd)
 {
     unsigned char ucQuitCmdIdx = ;
     for(; ucQuitCmdIdx < ucQuitCmdNum; ucQuitCmdIdx++)
     {
         if(!strcasecmp(pszCmd, pszQuitCmd[ucQuitCmdIdx]))
             return ;
     }

     return ;
 }

 //剔除字符串首尾的空白字符(含空格)
 static char *StripWhite(char *pszOrig)
 {
     if(NULL == pszOrig)
         return "NUL";

     char *pszStripHead = pszOrig;
     while(isspace(*pszStripHead))
         pszStripHead++;

     if('\0' == *pszStripHead)
         return pszStripHead;

     char *pszStripTail = pszStripHead + strlen(pszStripHead) - ;
     while(pszStripTail > pszStripHead && isspace(*pszStripTail))
         pszStripTail--;
     *(++pszStripTail) = '\0';

     return pszStripHead;
 }

 static char *pszLineRead = NULL;  //终端输入字符串
 static char *pszStripLine = NULL; //剔除前端空格的输入字符串
 char *ReadCmdLine()
 {
      //若已分配命令行缓冲区，则将其释放
     if(pszLineRead)
     {
         free(pszLineRead);
         pszLineRead = NULL;
     }
     //读取用户输入的命令行
     pszLineRead = readline(pszCmdPrompt);

     //剔除命令行首尾的空白字符。若剔除后的命令不为空，则存入历史列表
     pszStripLine = StripWhite(pszLineRead);
     if(pszStripLine && *pszStripLine)
         add_history(pszStripLine);

     return pszStripLine;
 }

 static char *CmdGenerator(const char *pszText, int dwState)
 {
     static int dwListIdx = , dwTextLen = ;
     if(!dwState)
     {
         dwListIdx = ;
         dwTextLen = strlen(pszText);
     }

     //当输入字符串与命令列表中某命令部分匹配时，返回该命令字符串
     const char *pszName = NULL;
     while((pszName = GetCmdByIndex(dwListIdx)))
     {
         dwListIdx++;

         if(!strncmp (pszName, pszText, dwTextLen))
             return strdup(pszName);
     }

     return NULL;
 }

 static char **CmdCompletion (const char *pszText, int dwStart, int dwEnd)
 {
     //rl_attempted_completion_over = 1;
     char **pMatches = NULL;
     if( == dwStart)
         pMatches = rl_completion_matches(pszText, CmdGenerator);

     return pMatches;
 }

 //初始化Tab键能补齐的Command函数
 static void InitReadLine(void)
 {
     rl_attempted_completion_function = CmdCompletion;
 }

 #endif

自动补全后的命令字符串结尾多出一个空格，故需调用StripWhite将该空格剔除。

最后，可编写交互式调测函数如下：

 int main(void)
 {
 #ifndef __READLINE_DEBUG
     printf("Note: Macro __READLINE_DEBUG is Undefined, thus InteractiveCmd is Unavailable!!!\n\n");
 #else
     printf("Note: Welcome to Interactive Command!\n");
     printf("      Press 'Quit'/'Exit'/'End'/'Bye'/'Q'/'E'/'B' to quit!\n\n");
     InitReadLine();
     while()
     {//也可加入超时机制以免忘记退出
         char *pszCmdLine = ReadCmdLine();
         if(IsUserQuitCmd(pszCmdLine))
         {
             free(pszLineRead);
             break;
         }

         ExecCmd(pszCmdLine);
     }
 #endif

     return ;
 }

该函数用法类似Shell，便于定制调测命令的随机执行。命令中首个参数(本文参数唯一)支持自动补全，但参数区分大小写。

编译链接时需加载readline库和termcap(或ncurses)库。ncurses库通常使用terminfo(终端信息)，少数实现会使用termcap(终端能力)。启用Readline库时，执行结果如下：

 [wangxiaoyuan_@localhost test1]$ gcc -Wall -o ReadLine ReadLine.c -D__READLINE_DEBUG -lreadline -lncurses
 [wangxiaoyuan_@localhost test1]$ ./ReadLine
 Note: Welcome to Interactive Command!
       Press 'Quit'/'Exit'/'End'/'Bye'/'Q'/'E'/'B' to quit!

 clover>>ShowMeInfo(完整输入)
   Enter ShowMeInfo!
 clover>>ShowMeInfo(UP键调出历史命令)
   Enter ShowMeInfo!
 clover>>SetLogCtrl (输入'Se'自动补全)
   Enter SetLogCtrl!
 clover>>   TestEndianOper(错误输入)
 clover>>TestEndian  (输入'T'自动补全为"Test"，再输入'E'自动补全为"TestEndian ")
   Enter TestEndianOper!
 clover>>  TestBatch   (命令首尾加空格，无法自动补全)
   Enter TestBatch!
 clover>>ReadLine (输入'R'自动补全文件名)
 clover>>quit
 [wangxiaoyuan_@localhost test1]$

不启用Readline库时，执行结果如下：

 [wangxiaoyuan_@localhost test1]$ gcc -Wall -o ReadLine ReadLine.c
 ReadLine.c:41: warning: 'GetCmdByIndex' defined but not used
 ReadLine.c:49: warning: 'ExecCmd' defined but not used
 [wangxiaoyuan_@localhost test1]$ ./ReadLine
 Note: Macro __READLINE_DEBUG is Undefined, thus InteractiveCmd is Unavailable!!!