bash - How to determine function name from inside a function

ID : 20246

viewed : 22

Tags : bashfunctionbash

Top 5 Answer for bash - How to determine function name from inside a function

vote vote


You can use ${FUNCNAME[0]} in bash to get the function name.

vote vote


From the Bash Reference Manual:


An array variable containing the names of all shell functions currently in the execution call stack. The element with index 0 is the name of any currently-executing shell function. The bottom-most element (the one with the highest index) is "main". This variable exists only when a shell function is executing. Assignments to FUNCNAME have no effect and return an error status. If FUNCNAME is unset, it loses its special properties, even if it is subsequently reset.

This variable can be used with BASH_LINENO and BASH_SOURCE. Each element of FUNCNAME has corresponding elements in BASH_LINENO and BASH_SOURCE to describe the call stack. For instance, ${FUNCNAME[$i]} was called from the file ${BASH_SOURCE[$i+1]} at line number ${BASH_LINENO[$i]}. The caller builtin displays the current call stack using this information.

When bash arrays are accessed without an index the first element of the array will be returned, so $FUNCNAME will work in simple cases to provide the name of the immediately current function, but it also contains all other functions in the call stack. For example:

# in a file "foobar" function foo {     echo foo     echo "In function $FUNCNAME: FUNCNAME=${FUNCNAME[*]}" >&2 }  function foobar {     echo "$(foo)bar"     echo "In function $FUNCNAME: FUNCNAME=${FUNCNAME[*]}" >&2 }  foobar 

Will output:

$ bash foobar In function foo: FUNCNAME=foo foobar main foobar In function foobar: FUNCNAME=foobar main 
vote vote


I use ${FUNCNAME[0]} to print current function name

vote vote


The simplest way to get the function name (from inside a function) is dependent on which shell you are using:

Zsh version

someFunctionName() {    echo $funcstack[1] } 

Bash version

someFunctionName() {    echo ${FUNCNAME[0]} } 


someFunctionName() {   currentShell=$(ps -p $$ | awk "NR==2" | awk '{ print $4 }' | tr -d '-')   if [[ $currentShell == 'bash' ]]; then     echo ${FUNCNAME[0]}   elif [[ $currentShell == 'zsh' ]]; then     echo $funcstack[1]   fi } 
vote vote


Another example:

# in a file "foobar" foo() {     echo "$FUNCNAME fuction begins" }  foobar() {     echo "$FUNCNAME fuction begins" }  echo 'begin main' foo foobar echo 'end main' 

Will output:

begin main foo fuction begins foobar fuction begins end main 

Top 3 video Explaining bash - How to determine function name from inside a function