更改 bash 中内置读取的制表符补全
Changing tab-completion for read builtin in bash
当 "read -e" 在 bash 中处于活动状态时,当前的制表符补全似乎只匹配文件名:
read -e
[[TabTab]]
abc.txt bcd.txt cde.txt
我希望补全是我定义的一组字符串,而 file/dir/hostname-completion 等应在 "read -e" 期间停用。
脚本之外
complete -W 'string1 string2 string3' -E
效果很好,但我无法在使用 "read -e".
时让这种完成在脚本中工作
虽然这似乎是一个合理的要求,但我认为这是不可能的。
read
内置函数的现有实现在调用 readline 处理 -e
输入之前将 readline 完成环境设置为相当基本的配置。
在 readline
的调用期间,您可以在 builtins/read.def
, in the edit_line
function: it sets rl_attempted_completion_function
到 NULL
中看到代码。 readline
有几个完成覆盖,所以这不是 100% 明显重置整个完成环境,但据我所知,这是用于根据 complete
命令实现可编程完成的功能.
通过一些工作,您可能可以修改 read
命令的定义,以允许使用特定的完成函数来代替 readline 标准文件名完成函数,或者除此之外。这将需要 non-trivial 了解 bash 内部结构,但如果您想熟悉这些内部结构,这将是一个合理的项目。
作为一种更简单但效率较低的替代方法,您可以编写自己的小实用程序,它只接受一行带有 readline
的键盘输入并将其回显到标准输出。然后调用 read
将其标准输入重定向到您的实用程序:
read -r < <(my_reader string1 string2 string3)
(假设 my_reader
使用它的 command-line 参数来构建 readline
库的潜在完成列表。您可能还希望该选项显示提示.)
readline 文档包括 an example of an application,它可以完成简单的自定义完成;一旦您从 K&R 函数原型语法翻译它,它可能很容易适应您的需要。
编辑: 再次看那个例子后,我认为它有很多不必要的细节,所以我写了下面的例子,减少了不必要的细节。我可能会上传它到 github,但现在它在这里,即使它有将近 100 行:
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <readline/readline.h>
static void version(const char* progname) {
fprintf(stderr, "%s 0.1\n", progname);
}
static void usage(const char* progname) {
fprintf(stderr, "Usage: %s [-fhv] [-p PROMPT] [-n PROGNAME] [COMPLETION...]\n", progname);
fprintf(stderr,
"Reads one line using readline, and prints it to stdout.\n"
"Returns success if a line was read.\n"
" -p PROMPT Output PROMPT before requesting input.\n"
" -n PROGNAME Set application name to PROGNAME for readline config file\n"
" (Default: %s).\n"
" -f Use filename completion as well as specified completions.\n"
" -h Print this help text and exit.\n"
" -v Print version number and exit.\n"
" COMPLETION word to add to the list of possible completions.\n",
progname);
}
/* Readline really likes globals, so none of its hooks take a context parameter. */
static char** completions = NULL;
static char* generate_next_completion(const char* text, int state) {
static int index = 0;
if (state == 0) index = 0; /* reset index if we're starting */
size_t textlen = strlen(text);
while (completions[index++])
if (strncmp(completions[index - 1], text, textlen) == 0)
return strdup(completions[index - 1]);
return NULL;
}
/* We use this if we will fall back to filename completion */
static char** generate_completions(const char* text, int start, int end) {
return rl_completion_matches(text, generate_next_completion);
}
int main (int argc, char **argv) {
const char* prompt = "";
const char* progname = strrchr(argv[0], '/');
progname = progname ? progname + 1 : argv[0];
rl_readline_name = progname;
bool use_file_completion = false;
for (;;) {
int opt = getopt(argc, argv, "+fp:n:hv");
switch (opt) {
case -1: break;
case 'f': use_file_completion = true; continue;
case 'p': prompt = optarg; continue;
case 'n': rl_readline_name = optarg; continue;
case 'h': usage(progname); return 0;
case 'v': version(progname); return 0;
default: usage(progname); return 2;
}
break;
}
/* The default is stdout, which would interfere with capturing output. */
rl_outstream = stderr;
completions = argv + optind;
rl_completion_entry_function = rl_filename_completion_function;
if (*completions) {
if (use_file_completion)
rl_attempted_completion_function = generate_completions;
else
rl_completion_entry_function = generate_next_completion;
} else {
/* No specified strings */
if (!use_file_completion)
rl_inhibit_completion = true;
}
char* line = readline(prompt);
if (line) {
puts(line);
free(line);
return 0;
} else {
fputc('\n', rl_outstream);
return 1;
}
}
当 "read -e" 在 bash 中处于活动状态时,当前的制表符补全似乎只匹配文件名:
read -e
[[TabTab]]
abc.txt bcd.txt cde.txt
我希望补全是我定义的一组字符串,而 file/dir/hostname-completion 等应在 "read -e" 期间停用。
脚本之外
complete -W 'string1 string2 string3' -E
效果很好,但我无法在使用 "read -e".
时让这种完成在脚本中工作虽然这似乎是一个合理的要求,但我认为这是不可能的。
read
内置函数的现有实现在调用 readline 处理 -e
输入之前将 readline 完成环境设置为相当基本的配置。
在 readline
的调用期间,您可以在 builtins/read.def
, in the edit_line
function: it sets rl_attempted_completion_function
到 NULL
中看到代码。 readline
有几个完成覆盖,所以这不是 100% 明显重置整个完成环境,但据我所知,这是用于根据 complete
命令实现可编程完成的功能.
通过一些工作,您可能可以修改 read
命令的定义,以允许使用特定的完成函数来代替 readline 标准文件名完成函数,或者除此之外。这将需要 non-trivial 了解 bash 内部结构,但如果您想熟悉这些内部结构,这将是一个合理的项目。
作为一种更简单但效率较低的替代方法,您可以编写自己的小实用程序,它只接受一行带有 readline
的键盘输入并将其回显到标准输出。然后调用 read
将其标准输入重定向到您的实用程序:
read -r < <(my_reader string1 string2 string3)
(假设 my_reader
使用它的 command-line 参数来构建 readline
库的潜在完成列表。您可能还希望该选项显示提示.)
readline 文档包括 an example of an application,它可以完成简单的自定义完成;一旦您从 K&R 函数原型语法翻译它,它可能很容易适应您的需要。
编辑: 再次看那个例子后,我认为它有很多不必要的细节,所以我写了下面的例子,减少了不必要的细节。我可能会上传它到 github,但现在它在这里,即使它有将近 100 行:
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <readline/readline.h>
static void version(const char* progname) {
fprintf(stderr, "%s 0.1\n", progname);
}
static void usage(const char* progname) {
fprintf(stderr, "Usage: %s [-fhv] [-p PROMPT] [-n PROGNAME] [COMPLETION...]\n", progname);
fprintf(stderr,
"Reads one line using readline, and prints it to stdout.\n"
"Returns success if a line was read.\n"
" -p PROMPT Output PROMPT before requesting input.\n"
" -n PROGNAME Set application name to PROGNAME for readline config file\n"
" (Default: %s).\n"
" -f Use filename completion as well as specified completions.\n"
" -h Print this help text and exit.\n"
" -v Print version number and exit.\n"
" COMPLETION word to add to the list of possible completions.\n",
progname);
}
/* Readline really likes globals, so none of its hooks take a context parameter. */
static char** completions = NULL;
static char* generate_next_completion(const char* text, int state) {
static int index = 0;
if (state == 0) index = 0; /* reset index if we're starting */
size_t textlen = strlen(text);
while (completions[index++])
if (strncmp(completions[index - 1], text, textlen) == 0)
return strdup(completions[index - 1]);
return NULL;
}
/* We use this if we will fall back to filename completion */
static char** generate_completions(const char* text, int start, int end) {
return rl_completion_matches(text, generate_next_completion);
}
int main (int argc, char **argv) {
const char* prompt = "";
const char* progname = strrchr(argv[0], '/');
progname = progname ? progname + 1 : argv[0];
rl_readline_name = progname;
bool use_file_completion = false;
for (;;) {
int opt = getopt(argc, argv, "+fp:n:hv");
switch (opt) {
case -1: break;
case 'f': use_file_completion = true; continue;
case 'p': prompt = optarg; continue;
case 'n': rl_readline_name = optarg; continue;
case 'h': usage(progname); return 0;
case 'v': version(progname); return 0;
default: usage(progname); return 2;
}
break;
}
/* The default is stdout, which would interfere with capturing output. */
rl_outstream = stderr;
completions = argv + optind;
rl_completion_entry_function = rl_filename_completion_function;
if (*completions) {
if (use_file_completion)
rl_attempted_completion_function = generate_completions;
else
rl_completion_entry_function = generate_next_completion;
} else {
/* No specified strings */
if (!use_file_completion)
rl_inhibit_completion = true;
}
char* line = readline(prompt);
if (line) {
puts(line);
free(line);
return 0;
} else {
fputc('\n', rl_outstream);
return 1;
}
}