C语言中如何为Readline自定义补全菜单项添加颜色？

要实现自定义补全项的着色，不能直接在返回给readline的匹配字符串中插入ANSI转义码（这些字符会被当作输入内容的一部分），正确的做法是利用Readline提供的匹配项显示钩子来自定义输出逻辑，这样既能给特定补全项着色，又不会影响输入缓冲区的内容。

核心思路 #

Readline的rl_completion_display_matches_hook是一个可自定义的函数指针，用于替代默认的匹配列表显示逻辑。通过注册自己的钩子函数，你可以完全控制每个补全项的输出格式，包括添加ANSI颜色转义码，且这些转义码只会在终端显示时生效，不会被写入输入缓冲区。

实现步骤与代码示例 #

1. 定义自定义显示钩子函数 #

这个函数负责遍历所有匹配项，判断哪些需要着色，并输出带颜色的文本，最后恢复终端默认颜色。

2. 注册钩子与补全函数 #

将自定义钩子赋值给rl_completion_display_matches_hook，替换默认的显示逻辑；同时保留你已实现的自定义补全函数。

#include <stdio.h>
#include <string.h>
#include <readline/readline.h>
#include <readline/history.h>

// ANSI颜色控制码
#define COLOR_HIGHLIGHT "\033[31m"  // 红色高亮，可根据需求修改
#define COLOR_RESET     "\033[0m"    // 恢复默认颜色

// 自定义匹配项显示钩子：处理着色与布局
void colored_display_matches(char **matches, int num_matches, int max_match_len) {
    const int cols_per_line = rl_get_screen_width() / (max_match_len + 2);  // 模仿默认列布局
    for (int i = 0; i < num_matches; ++i) {
        // 判断是否需要着色，这里以"int"为例
        if (strcmp(matches[i], "int") == 0) {
            printf("%s%s%s  ", COLOR_HIGHLIGHT, matches[i], COLOR_RESET);
        } else {
            printf("%s  ", matches[i]);
        }
        // 换行逻辑，保持和默认显示一致的列数
        if ((i + 1) % cols_per_line == 0) {
            putchar('\n');
        }
    }
    // 最后一行未填满时补换行
    if (num_matches % cols_per_line != 0) {
        putchar('\n');
    }
}

// 你的自定义补全函数（示例实现）
char** dsl_keyword_completion(const char *text, int start, int end) {
    rl_attempted_completion_over = 1;  // 告诉readline使用我们的补全结果
    static char *dsl_keywords[] = {"inline", "int", "if", "else", "return", NULL};
    // 按前缀匹配关键词，rl_completion_matches会自动处理前缀匹配
    return rl_completion_matches(text, (rl_compentry_func_t*)[](const char *text, int state) {
        static int idx = 0;
        char *match = NULL;
        if (!state) idx = 0;
        while (dsl_keywords[idx] != NULL) {
            if (strstr(dsl_keywords[idx], text) == dsl_keywords[idx]) {  // 前缀匹配
                match = strdup(dsl_keywords[idx]);
                idx++;
                return match;
            }
            idx++;
        }
        return NULL;
    });
}

int main() {
    // 注册自定义补全函数
    rl_attempted_completion_function = dsl_keyword_completion;
    // 注册自定义显示钩子，替换默认的rl_display_match_list
    rl_completion_display_matches_hook = colored_display_matches;

    char *input;
    while ((input = readline("> ")) != NULL) {
        if (*input != '\0') {
            add_history(input);
        }
        printf("输入内容: %s\n", input);
        free(input);
    }
    return 0;
}

关键细节说明 #

• 颜色转义码的作用范围：在钩子函数中输出颜色转义码后，必须用COLOR_RESET恢复默认颜色，避免后续终端输出都保持着色状态。
• 终端兼容性：确保终端支持ANSI颜色（现代终端如xterm、iTerm2、GNOME Terminal等都支持），如果需要兼容老旧终端，可以通过getenv("TERM")检查终端类型，或使用terminfo库判断颜色支持。
• 编译链接：编译时需要链接Readline库，命令示例：gcc -o dsl_shell dsl_shell.c -lreadline。

内容的提问来源于stack exchange，提问作者Paul J. Lucas