Linux Bash shell：在函数调用中保留一些 ANSI 代码（主要是颜色）而不从字符串中解释其他一些代码

Question

这是我的案例功能的一个例子：

function SendToScreen(){
echo -e "$*"
}

所以我叫它：

SendToScreen "Hello"

如果我想添加颜色代码：

VioletForeGroundColor="\033[38;5;99m"
NormalColor="\033[0m"
SendToScreen "Hello"$VioletForeGroundColor" violet "$NormalColor" word."

这给了我一个正确的答案：

但是如果我想发送一些 DOS 类型的路径（包括\ 斜杠），就会出现问题：

VioletForeGroundColor="\033[38;5;99m"
NormalColor="\033[0m"
MyDOSPath="d:\vivisector"
SendToScreen "Hello"$VioletForeGroundColor" violet "$NormalColor" word. The path is $MyDOSPath"

因为\v是某种ANSI代码，所以这次我得到：

我需要我的函数来输出彩色文本（粗体、草书、下划线......等），所以我必须使用echo -e。

我如何解决问题，让这种烦人的控制代码与\v 这样的字符发生冲突（我想还会有其他的）？

我想通过修改函数来修复这个问题，但我不确定这是不是正确的方法。

谢谢。

EDIT-1：我们将选择 \033 也称为 \e 作为唯一需要保留的 ANSI 代码。

Answer 1

新答案：

function SendToScreen() {
    echo -e $(echo "${*//\\/\\\\}" | sed 's/\\\\033\[/\\033\[/g');
}

这个会转义所有内容，然后取消转义任何看起来像颜色序列的内容 (\033[)。将文件名作为颜色序列发送的可能性大大降低。您可以通过仅将您希望允许的颜色序列列入白名单并将 sed 命令更改为不转义这些确切序列的 sed 命令序列来进一步减少它。

旧答案： 假设你想逃避 \v 和 \n，你可以这样做：

function SendToScreen(){
    a="${*//\\v/\\\\v}"
    a="${a//\\n/\\\\n}"
    echo -e "$a"
}

您可以使用您不想处理的任何其他转义来扩展它。

Answer 2

echo -e 仅解释以反斜杠开头的序列，因此您只需确保 $MyDOSPath 参数的所有反斜杠都加倍。那可能是：

SendToScreen "Hello ${VioletForeGroundColor}violet${NormalColor} word." \
             "The path is ${MyDOSPath//\\/\\\\}"

使用'substitute' parameter expansion。 // 表示“将每个反斜杠更改为双反斜杠”。

---

正如各种 cmets 中所讨论的，SendToScreen 的设计可能不是最佳的。一种可能的替代设计用途：

SendToScreen [-e "string-to-expand"][-p "plain-string"] [-- "plain strings"]

需要扩展的参数是，不应该扩展的参数不是。默认情况下，它们不是。所以，示例用法：

$ VioletForeGroundColor="\033[38;5;99m"
$ NormalColor="\033[0m"
$ MyDOSPath="C:\new\table\value\alert\form\033.txt"
$ echo "$MyDOSPath"
C:\new\table\value\alert\form\033.txt
$ bash SendToScreen.sh -e "${VioletForeGroundColor}violet${NormalColor}" -e "The path is ${MyDOSPath//\\/\\\\}" -p "Or $MyDOSPath" "Plain $MyDOSPath"
violet The path is C:\new\table\value\alert\form\033.txt Or C:\new\table\value\alert\form\033.txt Plain C:\new\table\value\alert\form\033.txt
$  bash SendToScreen.sh -e "${VioletForeGroundColor}violet${NormalColor}" -e "The path is ${MyDOSPath//\\/\\\\}" -p "Or $MyDOSPath" -e "Oops! $MyDOSPath" "Plain $MyDOSPath"
violet The path is C:\new\table\value\alert\form\033.txt Or C:\new\table\value\alert\form\033.txt Oops! C: ew able
              aluelert
                      orm.txt Plain C:\new\table\value\alert\form\033.txt
$

最后一批输出的十六进制转储是：

0x0000: 1B 5B 33 38 3B 35 3B 39 39 6D 76 69 6F 6C 65 74   .[38;5;99mviolet
0x0010: 1B 5B 30 6D 20 54 68 65 20 70 61 74 68 20 69 73   .[0m The path is
0x0020: 20 43 3A 5C 6E 65 77 5C 74 61 62 6C 65 5C 76 61    C:\new\table\va
0x0030: 6C 75 65 5C 61 6C 65 72 74 5C 66 6F 72 6D 5C 30   lue\alert\form\0
0x0040: 33 33 2E 74 78 74 20 4F 72 20 43 3A 5C 6E 65 77   33.txt Or C:\new
0x0050: 5C 74 61 62 6C 65 5C 76 61 6C 75 65 5C 61 6C 65   \table\value\ale
0x0060: 72 74 5C 66 6F 72 6D 5C 30 33 33 2E 74 78 74 20   rt\form\033.txt 
0x0070: 4F 6F 70 73 21 20 43 3A 20 65 77 20 61 62 6C 65   Oops! C: ew able
0x0080: 0B 61 6C 75 65 07 6C 65 72 74 0C 6F 72 6D 1B 2E   .alue.lert.orm..
0x0090: 74 78 74 20 50 6C 61 69 6E 20 43 3A 5C 6E 65 77   txt Plain C:\new
0x00A0: 5C 74 61 62 6C 65 5C 76 61 6C 75 65 5C 61 6C 65   \table\value\ale
0x00B0: 72 74 5C 66 6F 72 6D 5C 30 33 33 2E 74 78 74 0A   rt\form\033.txt.
0x00C0:

violet 出现在紫罗兰色中，你必须相信我的话。

显然，SendToScreen 的用户（调用者）必须知道哪些参数应该扩展，哪些不应该扩展。但是，它使它非常明确。

这是我用作脚本的代码。将重新包装为函数留给读者作为练习。扩展它以添加-c colour（或者可能是-f foreground 和-b background）是读者的练习。

#!/bin/bash

output=()

while getopts "p:e:" opt
do
  case "$opt" in
    (e) output+=( $(echo -e "$OPTARG") );;
    (p) output+=( "$OPTARG" );;
  esac
done

shift $(($OPTIND - 1))

echo "${output[@]}" "$@"

玩得开心！