gdb/python: have UnwindInfo.add_saved_register accept named args
authorAndrew Burgess <aburgess@redhat.com>
Tue, 14 Mar 2023 11:22:35 +0000 (11:22 +0000)
committerAndrew Burgess <aburgess@redhat.com>
Thu, 6 Apr 2023 13:57:32 +0000 (14:57 +0100)
commitd2d62da62ec9c5486b19d8ffc7b4ef4070e8df7a
tree2186c1226037e7937600edd7c01b19c5592ea50d
parentcf141dd8ccd36efe833aae3ccdb060b517cc1112
gdb/python: have UnwindInfo.add_saved_register accept named args

Update gdb.UnwindInfo.add_saved_register to accept named keyword
arguments.

As part of this update we now use gdb_PyArg_ParseTupleAndKeywords
instead of PyArg_UnpackTuple to parse the function arguments.

By switching to gdb_PyArg_ParseTupleAndKeywords, we can now use 'O!'
as the argument format for the function's value argument.  This means
that we can check the argument type (is gdb.Value) as part of the
argument processing rather than manually performing the check later in
the function.  One result of this is that we now get a better error
message (at least, I think so).  Previously we would get something
like:

  ValueError: Bad register value

Now we get:

  TypeError: argument 2 must be gdb.Value, not XXXX

It's unfortunate that the exception type changed, but I think the new
exception type actually makes more sense.

My preference for argument names is to use full words where that's not
too excessive.  As such, I've updated the name of the argument from
'reg' to 'register' in the documentation, which is the argument name
I've made GDB look for here.

For existing unwinder code that doesn't throw any exceptions nothing
should change with this commit.  It is possible that a user has some
code that throws and catches the ValueError, and this code will break
after this commit, but I think this is going to be sufficiently rare
that we can take the risk here.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>
Reviewed-By: Tom Tromey <tom@tromey.com>
gdb/doc/python.texi
gdb/python/py-unwind.c
gdb/testsuite/gdb.python/py-unwind.exp
gdb/testsuite/gdb.python/py-unwind.py