How to get the name of the current function

In Julia, there are several ways to get the name of the current function. Here, we will explore three different approaches to solve this problem.

Option 1: Using the @__FUNCTION__ macro

function get_current_function_name()
    return @__FUNCTION__
end

This approach uses the @__FUNCTION__ macro, which returns the name of the current function as a Symbol. By wrapping it in a function, we can easily retrieve the name of the current function.

Option 2: Using the nameof function

function get_current_function_name()
    return nameof(get_current_function_name)
end

The nameof function is another way to obtain the name of a function. In this case, we pass the function itself as an argument to nameof to retrieve its name.

Option 3: Using the backtrace function

function get_current_function_name()
    stack = backtrace()
    return stack[2].func
end

The backtrace function provides a stack trace of the current execution context. By accessing the second element of the stack trace, we can retrieve the name of the current function using the func field.

After analyzing these three options, the best approach depends on the specific use case. If you simply need the name of the current function as a Symbol, the @__FUNCTION__ macro is the most straightforward option. However, if you require the name as a string or need more flexibility in manipulating the stack trace, using nameof or backtrace may be more suitable.