Editline 库使用与技术文档

本文档旨在帮助用户了解并使用 Editline 库，这是一个小巧的行编辑库，可以方便地集成到任何程序中，提供命令行编辑和历史功能。

1. 安装指南

Editline 库的安装非常简单，以下是详细的步骤：

1. 首先，下载 Editline 的最新版本。推荐从 GitHub 上的官方仓库或发布的 tarball 包中获取。

2. 解压下载的文件：

   tar xf editline-1.15.3.tar.xz
   

3. 进入解压后的目录：

   cd editline-1.15.3/
   

4. 运行配置脚本。你可以指定安装路径，默认为 /usr：

   ./configure --prefix=/usr
   

5. 编译库文件和示例：

   make all
   

6. 安装到系统中：

   sudo make install
   

7. 安装完成后，运行 ldconfig 更新链接器缓存：

   ldconfig
   

如果安装到非标准位置，你可能需要更新 /etc/ld.so.conf 或使用 pkg-config。

2. 项目的使用说明

以下是使用 Editline 库创建一个简单命令行界面 (CLI) 的步骤：

1. 在项目目录中创建源文件，例如 example.c，并添加以下代码：

   #include <stdio.h>
   #include <stdlib.h>
   #include <editline.h>
   
   int main(void)
   {
       char *p;
   
       while ((p = readline("CLI> ")) != NULL) {
           puts(p);
           free(p);
       }
   
       return 0;
   }
   

2. 编译源文件。可以使用隐式 make 规则或创建自己的 Makefile：

   cd ~/src/
   make LDLIBS=-leditline example
   

或者，如果你使用 pkg-config，可以在 Makefile 中添加以下内容：

CFLAGS    = $(shell pkg-config --cflags libeditline)
LDFLAGS   = $(shell pkg-config --libs-only-L libeditline)
LDLIBS    = $(shell pkg-config --libs-only-l libeditline)
EXEC      = example
OBJS      = example.o

all: $(EXEC)

$(EXEC): $(OBJS)

clean:
        $(RM) $(OBJS) $(EXEC)

distclean: clean
        $(RM) *.o *~ *.bak

然后，在 ~/src/ 目录中运行 make。

3. 项目 API 使用文档

Editline 库提供了一系列的函数和全局变量，以下是一些主要的接口：

• 全局变量：

  int el_no_echo;   // 不回显输入字符
  int el_no_hist;   // 禁用历史记录的自动保存和访问
  int el_hist_size; // 历史滚动缓冲区大小，默认：15
  

• 特定函数：

  char *el_find_word(void);        // 查找单词
  void el_print_columns(int ac, char **av); // 打印列
  el_status_t el_ring_bell(void);  // 发出响铃
  el_status_t el_del_char(void);   // 删除字符
  

• 回调函数绑定：

  typedef el_status_t el_keymap_func_t(void);
  
  el_status_t el_bind_key(int key, el_keymap_func_t function);
  el_status_t el_bind_key_in_metamap(int key, el_keymap_func_t function);
  

• 兼容 readline 的接口：

  int rl_point;
  int rl_mark;
  int rl_end;
  int rl_inhibit_complete;
  char *rl_line_buffer;
  const char *rl_readline_name;
  

以及更多其他函数和接口。

4. 项目安装方式

Editline 库的安装方式已在“安装指南”部分详细说明。以下是简要步骤：

1. 解压源码包。
2. 运行配置脚本，可选指定安装路径。
3. 编译库和示例。
4. 使用 make install 命令安装到系统。
5. 运行 ldconfig 更新链接器缓存。

确保根据你的系统和环境选择合适的安装路径和编译选项。