自定义 Bash 提示正在覆盖自身

Question

我正在使用自定义 bash 提示符来显示 git 分支。

一切都在/etc/bash/bashrc:

function formattedGitBranch {
    _branch="$(git branch 2>/dev/null | sed -e "/^\s/d" -e "s/^\*\s//")"
    # tried these:
    echo -e "\e[0;91m ($_branch)"                       
    echo -e "\e[0;91m ($_branch) \e[m"                  
    echo -e $'\e[0;91m'"($_branch)"
    echo "($_branch)"                                   
    echo "$(tput setaf 2) ($_branch) $(tput setaf 9)"
    printf "\e[0;91m ($_branch)"
}

# color is set before function call
PS1='\[\033[01;34m\] \[\033[0;91m\]$(formattedGitBranch) \$\[\033[00m\] '
# color is set inside function
PS1='\[\033[01;34m\] $(formattedGitBranch) \$\[\033[00m\] '

问题是当我在函数中为$_branch设置颜色时，到达EOL时我的提示将被覆盖：

尝试了所有可能的变体tput、printf、$'' 表示法。

我通过只在PS1中设置颜色解决了这个问题：

但是..

1. 我想知道为什么它会覆盖我的提示
2. 使用函数时如何解决此问题

我正在使用 Gentoo Linux。 GNU bash, verze 4.2.37(1)-release (i686-pc-linux-gnu)

Answer 1

1) 我想知道为什么它会覆盖我的提示

因为每个不可打印的字符都必须用\[ 和\] 转义，否则readline 无法正确跟踪光标位置。

您必须将\[ 和\] 放在提示符中的所有非打印转义序列周围。
如果没有\[ \]，bash 会认为构成颜色代码的转义序列的字节实际上会占用屏幕上的空间，因此 bash 将无法知道光标的实际位置。

\[ 开始一系列非打印字符。 （如颜色转义序列）。这 允许 bash 正确计算自动换行。

\] 结束一系列非打印字符。 -- BashFAQ

...注意非打印字符的转义，这些确保 readline 可以正确跟踪光标位置。 -- ss64.com

2) 使用function时如何解决此问题

如果您想在function 中设置颜色，其输出用于PS，您有两种选择。

• 要么转义整个函数调用：

  PS1='\[ $(formattedGitBranch) \] '

• 或replace the non-printing Escape 内的echo 序列。即替换：

  \[ 和 \] 与 \001 \002

  （感谢user grawity！）

• echo -e is not aware 的 bash 的 \[ \] 所以你必须用 \001 和 \002 ASCII 控制代码来替换这些字符，以将不可打印字符与可打印字符分隔：

  function formattedGitBranch { echo -e "\001\e[0;91m\002 ($_branch)"; } PS1='$(formattedGitBranch) '

Answer 2

像\e[0;91m 这样的字符串需要额外引用，以防止 bash 计算其长度。

将formattedGitBranch 中的这些字符串包含在\[ 和\] 中，如\[\e[0;91m\]

你在其他地方做得正确。只是在 formattedGitBranch 中错过了它。

Answer 3

您必须注意 [\ 和 /] 内的不可打印字符，否则您可能会将光标放在命令提示符的顶部，因为它本身是共享的，所以我找到了一些东西并分享了它：-

用于在同一行 PS1 输出后获取光标：

几个例子：

PS1='[\u@\h:\w]\$
PS1='[\[\033[0;32m\]\u@\h:\[\033[36m\]\W\[\033[0m\]]\$ '

参考链接：syntax for bash PS1