active method name

PaulS

Problem

When an error occurs I want to have return the active method where the error occurs.
Xojo has "CurrentMethodName" which returns the active method as App.Method (e.g. App.Opening) or Class.Method (e.g. clsQueryDb.ConnectDb).

Proposed Solution

Example Workflow

Alternatives Considered

Who Would This Help?

This help a lot in pinpointing where a problem in the app occurs.

rgb

PaulS

Hi @PaulS

You can use this:

Try

Throw New RuntimeException("something went wrong")

Catch e As RuntimeException

Print("Error: " + e.Message)

For Each frame As StackFrame In e.StackFrames

Print("  " + frame.Name + " (" + frame.FileName + ":" + frame.LineNumber.ToString() + ")")

Next

End Try

bgrommes

I think this could probably come off the Introspection scaffolding.

In .NET, one would do:

System.Reflection.MethodBase.GetCurrentMethod().Name

Perhaps something like:

Introspection.GetCurrentMethod().Name

... where GetCurrentMethod() returns a MethodInfo.

Of course, there could be a convenience built-in such as CurrentMethodName().

bgrommes

rgb Good solution for exception logging but someone wanting to log execution and/or timings in non-exception situations would have to catch a purposely-thrown exception to get at this. Depends on whether you're exception logging or doing some sort of discoverability / tracing / benchmarking operation.

rgb

bgrommes

True, it's a hack when wait for have better solutions....

Garry

I’ve added a new global function for this:

CurrentMethodName() As String

It returns the currently executing ObjoBasic method, function, event, or script frame name without needing to raise an exception.

For example:

Class App Inherits CommandLineApplication
  Event Run(args() As String) As Integer
    Print(CurrentMethodName())  # App.Run
    Return 0
  End Event
End Class

And inside a normal class method:

Class Worker
  Function Trace() As String
    Return CurrentMethodName()
  End Function
End Class

Var worker As New Worker
Print(worker.Trace())  # Worker.Trace

This is intended for tracing, timing, logging, and diagnostics where you want the active method name during normal execution.

RuntimeException.StackFrames is still the right API when you are handling an exception and want the full call stack at the throw site. As part of this work, stack frame names now also use the same qualified, user-facing names where possible.

This has been implemented and will be available in the next build: https://feedback.objo.dev/feature/515