1 /* General utility routines for GDB/Python.
3 Copyright (C) 2008-2019 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"
25 /* Converts a Python 8-bit string to a unicode string object. Assumes the
26 8-bit string is in the host charset. If an error occurs during conversion,
27 returns NULL with a python exception set.
29 As an added bonus, the functions accepts a unicode string and returns it
30 right away, so callers don't need to check which kind of string they've
31 got. In Python 3, all strings are Unicode so this case is always the
34 If the given object is not one of the mentioned string types, NULL is
35 returned, with the TypeError python exception set. */
37 python_string_to_unicode (PyObject
*obj
)
39 PyObject
*unicode_str
;
41 /* If obj is already a unicode string, just return it.
42 I wish life was always that simple... */
43 if (PyUnicode_Check (obj
))
49 else if (PyString_Check (obj
))
50 unicode_str
= PyUnicode_FromEncodedObject (obj
, host_charset (), NULL
);
54 PyErr_SetString (PyExc_TypeError
,
55 _("Expected a string or unicode object."));
59 return gdbpy_ref
<> (unicode_str
);
62 /* Returns a newly allocated string with the contents of the given unicode
63 string object converted to CHARSET. If an error occurs during the
64 conversion, NULL will be returned and a python exception will be
66 static gdb::unique_xmalloc_ptr
<char>
67 unicode_to_encoded_string (PyObject
*unicode_str
, const char *charset
)
69 /* Translate string to named charset. */
70 gdbpy_ref
<> string (PyUnicode_AsEncodedString (unicode_str
, charset
, NULL
));
74 return gdb::unique_xmalloc_ptr
<char>
75 (xstrdup (PyBytes_AsString (string
.get ())));
78 /* Returns a PyObject with the contents of the given unicode string
79 object converted to a named charset. If an error occurs during
80 the conversion, NULL will be returned and a python exception will
83 unicode_to_encoded_python_string (PyObject
*unicode_str
, const char *charset
)
85 /* Translate string to named charset. */
86 return gdbpy_ref
<> (PyUnicode_AsEncodedString (unicode_str
, charset
, NULL
));
89 /* Returns a newly allocated string with the contents of the given
90 unicode string object converted to the target's charset. If an
91 error occurs during the conversion, NULL will be returned and a
92 python exception will be set. */
93 gdb::unique_xmalloc_ptr
<char>
94 unicode_to_target_string (PyObject
*unicode_str
)
96 return unicode_to_encoded_string (unicode_str
,
97 target_charset (python_gdbarch
));
100 /* Returns a PyObject with the contents of the given unicode string
101 object converted to the target's charset. If an error occurs
102 during the conversion, NULL will be returned and a python exception
105 unicode_to_target_python_string (PyObject
*unicode_str
)
107 return unicode_to_encoded_python_string (unicode_str
,
108 target_charset (python_gdbarch
));
111 /* Converts a python string (8-bit or unicode) to a target string in
112 the target's charset. Returns NULL on error, with a python
114 gdb::unique_xmalloc_ptr
<char>
115 python_string_to_target_string (PyObject
*obj
)
117 gdbpy_ref
<> str
= python_string_to_unicode (obj
);
121 return unicode_to_target_string (str
.get ());
124 /* Converts a python string (8-bit or unicode) to a target string in the
125 target's charset. Returns NULL on error, with a python exception
128 In Python 3, the returned object is a "bytes" object (not a string). */
130 python_string_to_target_python_string (PyObject
*obj
)
132 gdbpy_ref
<> str
= python_string_to_unicode (obj
);
136 return unicode_to_target_python_string (str
.get ());
139 /* Converts a python string (8-bit or unicode) to a target string in
140 the host's charset. Returns NULL on error, with a python exception
142 gdb::unique_xmalloc_ptr
<char>
143 python_string_to_host_string (PyObject
*obj
)
145 gdbpy_ref
<> str
= python_string_to_unicode (obj
);
149 return unicode_to_encoded_string (str
.get (), host_charset ());
152 /* Convert a host string to a python string. */
155 host_string_to_python_string (const char *str
)
157 return gdbpy_ref
<> (PyString_Decode (str
, strlen (str
), host_charset (),
161 /* Return true if OBJ is a Python string or unicode object, false
165 gdbpy_is_string (PyObject
*obj
)
168 return PyUnicode_Check (obj
);
170 return PyString_Check (obj
) || PyUnicode_Check (obj
);
174 /* Return the string representation of OBJ, i.e., str (obj).
175 If the result is NULL a python error occurred, the caller must clear it. */
177 gdb::unique_xmalloc_ptr
<char>
178 gdbpy_obj_to_string (PyObject
*obj
)
180 gdbpy_ref
<> str_obj (PyObject_Str (obj
));
184 gdb::unique_xmalloc_ptr
<char> msg
;
187 msg
= python_string_to_host_string (str_obj
.get ());
189 msg
.reset (xstrdup (PyString_AsString (str_obj
.get ())));
198 /* See python-internal.h. */
200 gdb::unique_xmalloc_ptr
<char>
201 gdbpy_err_fetch::to_string () const
203 /* There are a few cases to consider.
205 value is a string when PyErr_SetString is used.
206 value is not a string when raise "foo" is used, instead it is None
208 So the algorithm we use is to print `str (value)' if it's not
209 None, otherwise we print `str (type)'.
210 Using str (aka PyObject_Str) will fetch the error message from
211 gdb.GdbError ("message"). */
213 if (m_error_value
&& m_error_value
!= Py_None
)
214 return gdbpy_obj_to_string (m_error_value
);
216 return gdbpy_obj_to_string (m_error_type
);
219 /* See python-internal.h. */
221 gdb::unique_xmalloc_ptr
<char>
222 gdbpy_err_fetch::type_to_string () const
224 return gdbpy_obj_to_string (m_error_type
);
227 /* Convert a GDB exception to the appropriate Python exception.
229 This sets the Python error indicator. */
232 gdbpy_convert_exception (struct gdb_exception exception
)
236 if (exception
.reason
== RETURN_QUIT
)
237 exc_class
= PyExc_KeyboardInterrupt
;
238 else if (exception
.error
== MEMORY_ERROR
)
239 exc_class
= gdbpy_gdb_memory_error
;
241 exc_class
= gdbpy_gdb_error
;
243 PyErr_Format (exc_class
, "%s", exception
.message
);
246 /* Converts OBJ to a CORE_ADDR value.
248 Returns 0 on success or -1 on failure, with a Python exception set.
252 get_addr_from_python (PyObject
*obj
, CORE_ADDR
*addr
)
254 if (gdbpy_is_value_object (obj
))
259 *addr
= value_as_address (value_object_to_value (obj
));
261 CATCH (except
, RETURN_MASK_ALL
)
263 GDB_PY_SET_HANDLE_EXCEPTION (except
);
269 gdbpy_ref
<> num (PyNumber_Long (obj
));
275 val
= gdb_py_long_as_ulongest (num
.get ());
276 if (PyErr_Occurred ())
279 if (sizeof (val
) > sizeof (CORE_ADDR
) && ((CORE_ADDR
) val
) != val
)
281 PyErr_SetString (PyExc_ValueError
,
282 _("Overflow converting to address."));
292 /* Convert a LONGEST to the appropriate Python object -- either an
293 integer object or a long object, depending on its value. */
296 gdb_py_object_from_longest (LONGEST l
)
299 if (sizeof (l
) > sizeof (long))
300 return gdbpy_ref
<> (PyLong_FromLongLong (l
));
301 return gdbpy_ref
<> (PyLong_FromLong (l
));
303 #ifdef HAVE_LONG_LONG /* Defined by Python. */
304 /* If we have 'long long', and the value overflows a 'long', use a
305 Python Long; otherwise use a Python Int. */
306 if (sizeof (l
) > sizeof (long)
307 && (l
> PyInt_GetMax () || l
< (- (LONGEST
) PyInt_GetMax ()) - 1))
308 return gdbpy_ref
<> (PyLong_FromLongLong (l
));
310 return gdbpy_ref
<> (PyInt_FromLong (l
));
314 /* Convert a ULONGEST to the appropriate Python object -- either an
315 integer object or a long object, depending on its value. */
318 gdb_py_object_from_ulongest (ULONGEST l
)
321 if (sizeof (l
) > sizeof (unsigned long))
322 return gdbpy_ref
<> (PyLong_FromUnsignedLongLong (l
));
323 return gdbpy_ref
<> (PyLong_FromUnsignedLong (l
));
325 #ifdef HAVE_LONG_LONG /* Defined by Python. */
326 /* If we have 'long long', and the value overflows a 'long', use a
327 Python Long; otherwise use a Python Int. */
328 if (sizeof (l
) > sizeof (unsigned long) && l
> PyInt_GetMax ())
329 return gdbpy_ref
<> (PyLong_FromUnsignedLongLong (l
));
332 if (l
> PyInt_GetMax ())
333 return gdbpy_ref
<> (PyLong_FromUnsignedLong (l
));
335 return gdbpy_ref
<> (PyInt_FromLong (l
));
339 /* Like PyInt_AsLong, but returns 0 on failure, 1 on success, and puts
340 the value into an out parameter. */
343 gdb_py_int_as_long (PyObject
*obj
, long *result
)
345 *result
= PyInt_AsLong (obj
);
346 return ! (*result
== -1 && PyErr_Occurred ());
351 /* Generic implementation of the __dict__ attribute for objects that
352 have a dictionary. The CLOSURE argument should be the type object.
353 This only handles positive values for tp_dictoffset. */
356 gdb_py_generic_dict (PyObject
*self
, void *closure
)
359 PyTypeObject
*type_obj
= (PyTypeObject
*) closure
;
362 raw_ptr
= (char *) self
+ type_obj
->tp_dictoffset
;
363 result
= * (PyObject
**) raw_ptr
;
369 /* Like PyModule_AddObject, but does not steal a reference to
373 gdb_pymodule_addobject (PyObject
*module
, const char *name
, PyObject
*object
)
378 result
= PyModule_AddObject (module
, name
, object
);
384 /* Handle a Python exception when the special gdb.GdbError treatment
385 is desired. This should only be called when an exception is set.
386 If the exception is a gdb.GdbError, throw a gdb exception with the
387 exception text. For other exceptions, print the Python stack and
388 then throw a gdb exception. */
391 gdbpy_handle_exception ()
393 gdbpy_err_fetch fetched_error
;
394 gdb::unique_xmalloc_ptr
<char> msg
= fetched_error
.to_string ();
398 /* An error occurred computing the string representation of the
399 error message. This is rare, but we should inform the user. */
400 printf_filtered (_("An error occurred in Python "
401 "and then another occurred computing the "
402 "error message.\n"));
403 gdbpy_print_stack ();
406 /* Don't print the stack for gdb.GdbError exceptions.
407 It is generally used to flag user errors.
409 We also don't want to print "Error occurred in Python command"
410 for user errors. However, a missing message for gdb.GdbError
411 exceptions is arguably a bug, so we flag it as such. */
413 if (fetched_error
.type_matches (PyExc_KeyboardInterrupt
))
415 else if (! fetched_error
.type_matches (gdbpy_gdberror_exc
)
416 || msg
== NULL
|| *msg
== '\0')
418 fetched_error
.restore ();
419 gdbpy_print_stack ();
420 if (msg
!= NULL
&& *msg
!= '\0')
421 error (_("Error occurred in Python: %s"), msg
.get ());
423 error (_("Error occurred in Python."));
426 error ("%s", msg
.get ());