获取shell脚本中的函数名称列表[重复]

Question

我有一个 Bourne Shell 脚本，其中包含多个函数，并允许通过以下方式调用：

my.sh <func_name> <param1> <param2>

在内部，func_name() 将被调用 param1 和 param2。

我想创建一个help 函数，它只列出所有可用的函数，即使没有参数。

问题：如何从脚本内部获取脚本中所有函数名的列表？

我想避免解析它并寻找函数模式。太容易出错了。

更新：代码。希望我的 help() 函数像 main() - 添加到代码中的函数会自动添加到帮助中。

#!/bin/sh

# must work with "set -e"

foo ()
{
    echo foo: -$1-$2-$3-
    return 0
}

# only runs if there are parameters
# exits
main ()
{
    local cmd="$1"
    shift
    local rc=0
    $cmd "$@" || rc=$?
    exit $rc
}

if [[ "$*" ]]
then
    main "$@"
    die "how did we get here?"
fi

Answer 1

您可以通过在自己的脚本上使用 grep 命令来获取脚本中的函数列表。为了使这种方法起作用，您需要以某种方式构造函数，以便 grep 可以找到它们。这是一个示例：

$ cat my.sh
#!/bin/sh

function func1() # Short description
{
    echo func1 parameters: $1 $2
}

function func2() # Short description
{
    echo func2 parameters: $1 $2
}

function help() # Show a list of functions
{
    grep "^function" $0
}

if [ "_$1" = "_" ]; then
    help
else
    "$@"
fi

这是一个交互式演示：

$ my.sh 
function func1() # Short description
function func2() # Short description
function help() # Show a list of functions


$ my.sh help
function func1() # Short description
function func2() # Short description
function help() # Show a list of functions


$ my.sh func1 a b
func1 parameters: a b

$ my.sh func2 x y
func2 parameters: x y

如果您不想在帮助中显示“私有”功能，则省略“功能”部分：

my_private_function()
{
    # Do something
}

Answer 2

typeset -f 返回带有函数体的函数，因此使用一个简单的 awk 脚本来提取函数名

f1 () { :; }
f2 () { :; }
f3 () { :; }
f4 () { :; }
help () {
    echo "functions available:"
    typeset -f | awk '/ \(\) $/ && !/^main / {print $1}'
}
main () { help; }
main

此脚本输出：

functions available:
f1
f2
f3
f4
help

Answer 3

你调用这个函数没有 争论，它吐出一个 “空格”分隔的列表 仅限函数名。

---

function script.functions () {
    local fncs=`declare -F -p | cut -d " " -f 3`; # Get function list
    echo $fncs; # not quoted here to create shell "argument list" of funcs.
}

将函数加载到数组中：

---

declare MyVar=($(script.functions));

当然，常识表明 任何尚未实现的功能 来源到当前文件之前 这被称为不会出现在 列表。

使列表只读并且 可用于导出到其他脚本 由该脚本调用：

---

declare -rx MyVar=($(script.functions));

将整个列表打印为换行符 分开：

---

printf "%s\n" "${MyVar[@]}";

Answer 4

最好的办法是创建一个数组（您正在使用 bash），其中包含您想要宣传的函数，并让您的帮助函数遍历并打印它们。

单独调用set 将生成函数，但会生成它们的全部。你仍然需要解析以 () 结尾的东西来获得众所周知的符号。

使用getopt 之类的东西将--function-name 转换为带有参数的function_name 也可能更明智。但是，好吧，理智是相对的，你还没有发布代码:)

您的另一个选择是创建一个loadable for bash（set 的一个分支）来完成此任务。老实说，我更喜欢在为此任务编写可加载项之前先进行解析。