Crossline

Crossline是一个很小的跨平台命令行工具库，类似Linux上的readline。

项目地址：https://github.com/JunchuanWang80/Crossline

因为开发一个项目需要支持跨平台命令行，在Linux上readline是首选，bash/gdb/ftp都使用了这个库，但是Windows上没法直接用。后来搜到了一个开源项目linenoise，这个命令行工具库是Redis的作者开发的，Redis，Andriod和MongoDB都使用了。这个工具库很小，只有1100行左右代码（readline超过3万行代码，并且还依赖ncurses库），但是它只能在Linux上运行，支持的快捷键也很少，功能也少。后来搜到了linenoise-ng，这个项目是ArangoDB开源的，最初是从MongoDB版本的linenoise移植出来的。这个开源项目非常强大，支持Windows/Linux，支持很多快捷键和功能，并且支持Unicode。起初打算用这个库，后来发现这个库依然挺大的，代码大约有4,300行并且挺复杂的，还混合使用了C++和C，还有不少动态内存操作（linenoise也有）。我觉得一个跨平台命令行工具库可以实现的更简单，于是做了原型验证，然后使用了不同的方式实现了这个全新的很小但是功能很多的夸平台命令行工具库。

功能和特色

• 支持Windows，Linux，vt100和xterm。
• 支持79个快捷键和37个功能。
• 支持大部分readline快捷键(Emacs标准绑定): 移动，修改，剪切粘贴，自动补齐，历史命令行，控制。
• 支持部分Windows命令行快捷键，增加一些新的方便使用的快捷键。
• 支持历史命令行浏览，显示，清空，保存到文件以及从文件加载。
• 支持自动补齐，关键字及帮助显示和语法提示。
• 支持强大的交互式历史命令行搜索，支持匹配多个包含和排除规则，匹配不区分大小写。
• 在命令行搜素模式下支持除了自动补齐和历史命令行外的所有快捷键。
• 支持自动分页功能，用于自动补齐显示，历史命令行显示和搜索显示，帮助信息显示，会根据窗口大小自动调整。
• 支持方便的内置F1帮助功能，可以在编辑模式和命令行搜索模式下使用，可以随时使用不影响当前已输入命令行。
• 支持方便的Ctrl-^键盘调试功能，可以看到按下的键产生的字符序列。
• 支持Ctrl-C退出编辑，Linux下支持Ctrl-Z挂起并恢复编辑，这2个快捷键在编辑模式和命令行搜索模式下都适用。
• 支持管道作为输入。
• 纯C代码，没有第三方库依赖。
• 没有动态内存操作: malloc/free/realloc/new/delete/strdup/etc。
• 非常小，只有1000行左右代码，逻辑简单容易阅读。
• 可以很容易的扩展支持新的快捷键和功能。
• 以后会支持Unicode。

快捷键列表

其他命令

移动命令

编辑命令

剪切粘贴

自动补齐命令

历史命令

控制命令

历史命令行搜索功能

原始的readline支持增量搜索(Ctrl-R,Ctrl-S)和非增量搜索(Alt-N,Alt-P)。这2种方式都不方便，效率也不高，所以实现了全新的交互式命令行搜索功能。

匹配语法
使用空格分开多个匹配项，每个匹配项都不区分大小写（小技巧：可以使用Insert插入上次搜索关键字继续编辑）

• select: 选择包含select的命令行
• -select: 选择不包含select的命令行
• "select from": 选择包含select from的命令行
• -"select from": 选择不包含select from的命令行
• "select from" where -"order by" -limit : 选择包含select from以及where，但不包含order by或者limit的命令行

例子

SQL> <F2> // show history
   1 hello world
   2 select from user
   3 from select table
   4 SELECT from student
   5 Select from teacher

SQL> <Ctrl+R>
Input Patterns <F1> help: select from
   1 select from user
   2 from select table
   3 SELECT from student
   4 Select from teacher
Input history id: 3
SQL> SELECT from student<Alt+R> // Revert line

SQL> <F4>
Input Patterns <F1> help: <Insert> // paste last history pattern: select from
Input Patterns <F1> help: "select from"
   1 select from user
   2 SELECT from student
   3 Select from teacher
Input history id: 3
SQL> Select from teacher<Alt+R>

SQL> SELECT from<F4> // search with pattern: Select from
Input Patterns <F1> help: SELECT from
Input Patterns <F1> help: "SELECT from" -user -teacher
   1 SELECT from student
Input history id: 1
SQL> SELECT from student

Crossline APIs

// Main API to read a line，return buf if get line，return NULL if EOF。
char* crossline_readline (char *buf，int size，const char *prompt);
// Set move/cut word delimiter，default is all not digital and alphabetic characters
void crossline_delimiter_set (const char *delim);

// History APIs
int crossline_history_save (const char *filename);
int crossline_history_load (const char *filename);
void crossline_history_show (void);
void crossline_history_clear (void);

/* Completion APIs */
// Register completion callback
void crossline_completion_register (crossline_completion_callback pCbFunc);
// Add completion in callback。 Word is must，help for word is optional。
void crossline_completion_add (crossline_completions_t *pCompletions，const char *word，const char *help);
// Set syntax hints in callback
void crossline_hints_set (crossline_completions_t *pCompletions，const char *hints);

简单例子

代码在example.c

static void completion_hook (char const *buf，crossline_completions_t *pCompletion)
{
    int i;
    static const char *cmd[] = {"insert"，"select"，"update"，"delete"，"create"，"drop"，"show"，"describe"，"help"，"exit"，"history"，NULL};

    for (i = 0; NULL != cmd[i]; ++i) {
        if (0 == strncmp(buf，cmd[i]，strlen(buf))) {
            crossline_completion_add (pCompletion，cmd[i]，NULL);
        }
    }

}

int main ()
{
    char buf[256];
    
    crossline_completion_register (completion_hook);
    crossline_history_load ("history.txt");

    while (NULL != crossline_readline (buf，sizeof(buf)，"Crossline> ")) {
        printf ("Read line: \"%s\"\n"，buf);
    }    

    crossline_history_save ("history.txt");
    return 0;
}

SQL解析器例子

代码在example_sql.c，这个例子实现了一个简单的SQL语法分析器，可以解析如下语法，代码较多这里就不放了。

insert into <table> set column1=value1,column2=value2,...
select <* | column1,columnm2,...> from <table> [where] [order by] [limit] [offset]
update <table> set column1=value1,column2=value2 [where] [order by] [limit] [offset]
delete from <table> [where] [order by] [limit] [offset]
create [unique] index <name> on <table> (column1,column2,...)
drop {table | index} <name>
show {tables | databases}
describe <table>
help {insert | select | update | delete | create | drop | show | describe | help | exit | history}

可以用这个例子来测试上面的快捷键

SQL> <TAB> // show autocomplete words and help
insert     Insert a record to table
select     Select records from table
update     Update records in table
delete     Delete records from table
create     Create index on table
drop       Drop index or table
show       Show tables or databases
describe   Show table schema
help       Show help for topic
exit       Exit shell
history    Show history
 *** Press <Space> or <Enter> to continue . . .

SQL> help <TAB> // show autocomplete words list
insert select update delete create drop show
describe help exit history

SQL> create index <TAB> // show autocomplete hints
Please input: index name

编译与测试

Windows MSVC

cl -D_CRT_SECURE_NO_WARNINGS -W4 User32.Lib crossline.c example.c /Feexample.exe
cl -D_CRT_SECURE_NO_WARNINGS -W4 User32.Lib crossline.c example_sql.c /Feexample_sql.exe

Windows Clang

clang -D_CRT_SECURE_NO_WARNINGS -Wall -lUser32 crossline.c example.c -o example.exe
clang -D_CRT_SECURE_NO_WARNINGS -Wall -lUser32 crossline.c example_sql.c -o example_sql.exe

Linux Clang

clang -Wall crossline.c example.c -o example
clang -Wall crossline.c example_sql.c -o example_sql

GCC(Linux, MinGW, Cygwin, MSYS2)

gcc -Wall crossline.c example.c -o example
gcc -Wall crossline.c example_sql.c -o example_sql

其它

这里只列出了部分内容，详细信息请参考项目的README.md
项目地址：https://github.com/JunchuanWang80/Crossline