为Tcl prompt1添加颜色导致命令历史显示异常

问题场景 #

为给Tcl提示符添加颜色，定义了如下::tclreadline::prompt1过程：

proc ::tclreadline::prompt1 {} {
    return "\033\[31m Test \033\[0m" 
}

执行两条长命令后：

Test 11111111111111111111
invalid command name "11111111111111111111"
while evaluating 11111111111111111111
 Test 22222222222222222222222222222222222222222222222222222222
invalid command name "22222222222222222222222222222222222222222222222222222222"
while evaluating 22222222222222222222222222222222222222222222222222222222

按↑键两次调出历史命令执行，出现异常：

Test 22222222211111111111111111111
invalid command name "11111111111111111111"
while evaluating 11111111111111111111

可见222222错误出现在111111之前，且不属于该历史命令的内容。

原因分析 #

这是因为你在提示符中使用的ANSI颜色转义序列（如\033[31m）没有被tclreadline识别为非打印字符。tclreadline在计算提示符的显示长度时，会把转义序列的字符数计入总长度，但实际上这些字符不会在终端显示出来，导致命令行的位置计算出现偏差。当命令内容较长、换行显示时，这种偏差会引发历史命令内容重叠的异常。

解决方法 #

用\001（SOH，ASCII起始字符）和\002（STX，ASCII文本起始字符）包裹ANSI转义序列，让tclreadline知道这些是不可打印的控制字符，从而忽略它们的长度计算：

proc ::tclreadline::prompt1 {} {
    return "\001\033\[31m\002 Test \001\033\[0m\002" 
}

这样修改后，tclreadline就能正确计算提示符的实际显示长度，历史命令的调用和显示就会恢复正常。

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