获取shell脚本中的函数名列表

Question

我有一个Bourne Shell脚本,其中包含多个函数,并允许以下列方式调用:

func_name()

将使用param1和param2调用func_name()内部.

我想创建一个"帮助"功能,只列出所有可用的功能,即使没有参数.

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

我想避免解析它并寻找功能模式.太容易出错了.

谢谢,亚历克斯

更新:代码.想要我的help()函数就像main() - 添加到代码中的函数会自动添加到帮助中.

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

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[@]}";