Eclipse插件多行Inline Completion渲染实现问题求助

你的核心问题是：直接通过PaintListener绘制多行补全内容时，只是在现有文本之上叠加绘制，并没有修改StyledText的布局逻辑，所以原有文本不会自动被推到补全文本之后。GlyphMetrics依赖StyleRange生效，空文本没有对应的StyleRange，所以无法撑开行高。以下是可行的解决思路：

方案一：直接调整行高（简单高效） #

利用StyledText的setLineHeight方法，直接修改当前行的高度，让它能容纳所有补全行，这样后续行的文本会自动下移。

修改代码要点： #

1. 在InlineCompletion构造函数中计算补全行数，调整当前行高：

public InlineCompletion(int offset, Completion completion, ITextViewer textViewer, IDocument document) {
    this.widget = textViewer.getTextWidget();
    this.completion = completion;
    this.offset = offset;

    // 计算补全内容的总行数
    int totalCompletionLines = completion.text.split("\\n").length;
    int currentLine = widget.getLineAtOffset(offset);
    int defaultLineHeight = widget.getLineHeight();

    // 把当前行高设置为默认行高 × 补全行数
    widget.setLineHeight(currentLine, defaultLineHeight * totalCompletionLines);

    widget.addPaintListener(this);
}

2. 修正paintControl中的多行绘制逻辑，按行偏移绘制：

@Override
public void paintControl(PaintEvent e) {
    String[] completionLines = completion.text.split("\\n");
    Point startPoint = widget.getLocationAtOffset(this.offset);
    e.gc.setForeground(new Color(128, 128, 128));
    int currentY = startPoint.y;
    int lineHeight = widget.getLineHeight() / completionLines.length; // 均分行高

    // 逐行绘制补全内容
    for (String line : completionLines) {
        String formattedLine = line.replace("\\t", "    ");
        // 第一行从当前光标位置开始，后续行对齐当前行缩进
        int drawX = completionLines[0].equals(line) ? startPoint.x : widget.getLocationAtOffset(widget.getOffsetAtLine(widget.getLineAtOffset(offset))).x;
        e.gc.drawText(formattedLine, drawX, currentY, true);
        currentY += lineHeight;
    }
}

3. 关键补充：当补全失效（比如用户输入新内容、取消补全）时，必须恢复当前行的默认行高，避免影响正常编辑：

// 在取消补全的逻辑中调用
public void dispose() {
    int currentLine = widget.getLineAtOffset(offset);
    widget.setLineHeight(currentLine, widget.getLineHeight()); // 恢复默认行高
    widget.removePaintListener(this);
}

方案二：插入占位符适配布局（更贴合Eclipse编辑器机制） #

如果方案一的行高调整导致排版不够自然，可以插入不可见的占位符文本，配合GlyphMetrics让StyledText自动计算布局，把原有文本推下去。

核心逻辑： #

• 在当前行末尾插入n-1个换行+零宽度空格（\u200B），作为占位行
• 给这些零宽度空格设置StyleRange，用GlyphMetrics撑开行高
• 绘制补全内容到占位行的位置
• 补全失效时删除占位符，恢复文档

示例代码片段： #

public InlineCompletion(int offset, Completion completion, ITextViewer textViewer, IDocument document) {
    this.widget = textViewer.getTextWidget();
    this.completion = completion;
    this.offset = offset;
    this.document = document;

    int completionLineCount = completion.text.split("\\n").length;
    if (completionLineCount > 1) {
        try {
            int currentLineEnd = widget.getOffsetAtLine(widget.getLineAtOffset(offset) + 1);
            StringBuilder placeholder = new StringBuilder();
            // 插入n-1个占位行
            for (int i = 1; i < completionLineCount; i++) {
                placeholder.append("\n\u200B");
            }
            // 插入占位符到文档
            document.replace(currentLineEnd, 0, placeholder.toString());
            // 给占位符设置StyleRange
            int placeholderStart = currentLineEnd + 1;
            int defaultLineHeight = widget.getLineHeight();
            for (int i = 0; i < completionLineCount - 1; i++) {
                StyleRange range = new StyleRange();
                range.start = placeholderStart;
                range.length = 1;
                range.metrics = new GlyphMetrics(0, defaultLineHeight, 0);
                widget.setStyleRange(range);
                placeholderStart += 2; // 换行+零宽度空格占2个字符位置
            }
        } catch (BadLocationException e) {
            e.printStackTrace();
        }
    }

    widget.addPaintListener(this);
}

// 补全失效时清理占位符
public void dispose() {
    int completionLineCount = completion.text.split("\\n").length;
    if (completionLineCount > 1) {
        try {
            int currentLineEnd = widget.getOffsetAtLine(widget.getLineAtOffset(offset) + 1);
            document.replace(currentLineEnd, 2 * (completionLineCount - 1), "");
        } catch (BadLocationException e) {
            e.printStackTrace();
        }
    }
    widget.removePaintListener(this);
}

额外注意事项 #

• 监听StyledText的滚动、窗口大小变化事件，在这些事件触发时重新绘制补全内容，避免错位
• 处理补全内容的缩进对齐，确保后续行和当前行的缩进一致
• 注意内存泄漏：补全失效时必须移除PaintListener，恢复文档和行高设置

内容的提问来源于stack exchange，提问作者Yair Cohen