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 struct value
*value
= NULL
;
63 /* 'result' must be set to NULL, this initially indicates whether
64 the function was called, or not. */
65 PyObject
*result
= NULL
;
66 PyObject
*callable
, *args
;
67 struct cleanup
*cleanup
;
69 cleanup
= ensure_python_env (gdbarch
, language
);
71 args
= convert_values_to_python (argc
, argv
);
72 /* convert_values_to_python can return NULL on error. If we
73 encounter this, do not call the function, but allow the Python ->
74 error code conversion below to deal with the Python exception.
75 Note, that this is different if the function simply does not
80 callable
= PyObject_GetAttrString ((PyObject
*) cookie
, "invoke");
84 error (_("No method named 'invoke' in object."));
87 result
= PyObject_Call (callable
, args
, NULL
);
94 PyObject
*ptype
, *pvalue
, *ptraceback
;
96 PyErr_Fetch (&ptype
, &pvalue
, &ptraceback
);
98 /* Try to fetch an error message contained within ptype, pvalue.
99 When fetching the error message we need to make our own copy,
100 we no longer own ptype, pvalue after the call to PyErr_Restore. */
102 gdb::unique_xmalloc_ptr
<char>
103 msg (gdbpy_exception_to_string (ptype
, pvalue
));
107 /* An error occurred computing the string representation of the
108 error message. This is rare, but we should inform the user. */
110 printf_filtered (_("An error occurred in a Python "
111 "convenience function\n"
112 "and then another occurred computing the "
113 "error message.\n"));
114 gdbpy_print_stack ();
117 /* Don't print the stack for gdb.GdbError exceptions.
118 It is generally used to flag user errors.
120 We also don't want to print "Error occurred in Python command"
121 for user errors. However, a missing message for gdb.GdbError
122 exceptions is arguably a bug, so we flag it as such. */
124 if (!PyErr_GivenExceptionMatches (ptype
, gdbpy_gdberror_exc
)
125 || msg
== NULL
|| *msg
== '\0')
127 PyErr_Restore (ptype
, pvalue
, ptraceback
);
128 gdbpy_print_stack ();
129 if (msg
!= NULL
&& *msg
!= '\0')
130 error (_("Error occurred in Python convenience function: %s"),
133 error (_("Error occurred in Python convenience function."));
139 Py_XDECREF (ptraceback
);
140 error ("%s", msg
.get ());
144 value
= convert_value_from_python (result
);
148 gdbpy_print_stack ();
149 error (_("Error while executing Python code."));
153 do_cleanups (cleanup
);
158 /* Initializer for a Function object. It takes one argument, the name
162 fnpy_init (PyObject
*self
, PyObject
*args
, PyObject
*kwds
)
165 gdb::unique_xmalloc_ptr
<char> docstring
;
167 if (! PyArg_ParseTuple (args
, "s", &name
))
171 if (PyObject_HasAttrString (self
, "__doc__"))
173 gdbpy_ref
ds_obj (PyObject_GetAttrString (self
, "__doc__"));
176 if (gdbpy_is_string (ds_obj
.get ()))
178 docstring
= python_string_to_host_string (ds_obj
.get ());
179 if (docstring
== NULL
)
188 docstring
.reset (xstrdup (_("This function is not documented.")));
190 add_internal_function (name
, docstring
.release (), fnpy_call
, self
);
194 /* Initialize internal function support. */
197 gdbpy_initialize_functions (void)
199 fnpy_object_type
.tp_new
= PyType_GenericNew
;
200 if (PyType_Ready (&fnpy_object_type
) < 0)
203 return gdb_pymodule_addobject (gdb_module
, "Function",
204 (PyObject
*) &fnpy_object_type
);
209 PyTypeObject fnpy_object_type
=
211 PyVarObject_HEAD_INIT (NULL
, 0)
212 "gdb.Function", /*tp_name*/
213 sizeof (PyObject
), /*tp_basicsize*/
222 0, /*tp_as_sequence*/
230 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
, /*tp_flags*/
231 "GDB function object", /* tp_doc */
234 0, /* tp_richcompare */
235 0, /* tp_weaklistoffset */
243 0, /* tp_descr_get */
244 0, /* tp_descr_set */
245 0, /* tp_dictoffset */
246 fnpy_init
, /* tp_init */