1 /* Convenience functions implemented in Python.
3 Copyright (C) 2008-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "python-internal.h"
26 #include "cli/cli-decode.h"
27 #include "completer.h"
28 #include "expression.h"
32 extern PyTypeObject fnpy_object_type
33 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("PyObject");
38 convert_values_to_python (int argc
, struct value
**argv
)
41 gdbpy_ref
<> result (PyTuple_New (argc
));
46 for (i
= 0; i
< argc
; ++i
)
48 gdbpy_ref
<> elt (value_to_value_object (argv
[i
]));
51 PyTuple_SetItem (result
.get (), i
, elt
.release ());
53 return result
.release ();
56 /* Call a Python function object's invoke method. */
59 fnpy_call (struct gdbarch
*gdbarch
, const struct language_defn
*language
,
60 void *cookie
, int argc
, struct value
**argv
)
62 /* The gdbpy_enter object needs to be placed first, so that it's the last to
64 gdbpy_enter
enter_py (gdbarch
, language
);
67 gdbpy_ref
<> args (convert_values_to_python (argc
, argv
));
69 /* convert_values_to_python can return NULL on error. If we
70 encounter this, do not call the function, but allow the Python ->
71 error code conversion below to deal with the Python exception.
72 Note, that this is different if the function simply does not
77 gdbpy_ref
<> callable (PyObject_GetAttrString ((PyObject
*) cookie
,
80 error (_("No method named 'invoke' in object."));
82 result
.reset (PyObject_Call (callable
.get (), args
.get (), NULL
));
87 PyObject
*ptype
, *pvalue
, *ptraceback
;
89 PyErr_Fetch (&ptype
, &pvalue
, &ptraceback
);
91 /* Try to fetch an error message contained within ptype, pvalue.
92 When fetching the error message we need to make our own copy,
93 we no longer own ptype, pvalue after the call to PyErr_Restore. */
95 gdb::unique_xmalloc_ptr
<char>
96 msg (gdbpy_exception_to_string (ptype
, pvalue
));
100 /* An error occurred computing the string representation of the
101 error message. This is rare, but we should inform the user. */
103 printf_filtered (_("An error occurred in a Python "
104 "convenience function\n"
105 "and then another occurred computing the "
106 "error message.\n"));
107 gdbpy_print_stack ();
110 /* Don't print the stack for gdb.GdbError exceptions.
111 It is generally used to flag user errors.
113 We also don't want to print "Error occurred in Python command"
114 for user errors. However, a missing message for gdb.GdbError
115 exceptions is arguably a bug, so we flag it as such. */
117 if (!PyErr_GivenExceptionMatches (ptype
, gdbpy_gdberror_exc
)
118 || msg
== NULL
|| *msg
== '\0')
120 PyErr_Restore (ptype
, pvalue
, ptraceback
);
121 gdbpy_print_stack ();
122 if (msg
!= NULL
&& *msg
!= '\0')
123 error (_("Error occurred in Python convenience function: %s"),
126 error (_("Error occurred in Python convenience function."));
132 Py_XDECREF (ptraceback
);
133 error ("%s", msg
.get ());
137 value
= convert_value_from_python (result
.get ());
140 gdbpy_print_stack ();
141 error (_("Error while executing Python code."));
147 /* Initializer for a Function object. It takes one argument, the name
151 fnpy_init (PyObject
*self
, PyObject
*args
, PyObject
*kwds
)
154 gdb::unique_xmalloc_ptr
<char> docstring
;
156 if (! PyArg_ParseTuple (args
, "s", &name
))
160 if (PyObject_HasAttrString (self
, "__doc__"))
162 gdbpy_ref
<> ds_obj (PyObject_GetAttrString (self
, "__doc__"));
165 if (gdbpy_is_string (ds_obj
.get ()))
167 docstring
= python_string_to_host_string (ds_obj
.get ());
168 if (docstring
== NULL
)
177 docstring
.reset (xstrdup (_("This function is not documented.")));
179 add_internal_function (name
, docstring
.release (), fnpy_call
, self
);
183 /* Initialize internal function support. */
186 gdbpy_initialize_functions (void)
188 fnpy_object_type
.tp_new
= PyType_GenericNew
;
189 if (PyType_Ready (&fnpy_object_type
) < 0)
192 return gdb_pymodule_addobject (gdb_module
, "Function",
193 (PyObject
*) &fnpy_object_type
);
198 PyTypeObject fnpy_object_type
=
200 PyVarObject_HEAD_INIT (NULL
, 0)
201 "gdb.Function", /*tp_name*/
202 sizeof (PyObject
), /*tp_basicsize*/
211 0, /*tp_as_sequence*/
219 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
, /*tp_flags*/
220 "GDB function object", /* tp_doc */
223 0, /* tp_richcompare */
224 0, /* tp_weaklistoffset */
232 0, /* tp_descr_get */
233 0, /* tp_descr_set */
234 0, /* tp_dictoffset */
235 fnpy_init
, /* tp_init */