/* Python pretty-printing
- Copyright (C) 2008-2013 Free Software Foundation, Inc.
+ Copyright (C) 2008-2017 Free Software Foundation, Inc.
This file is part of GDB.
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
-#include "exceptions.h"
#include "objfiles.h"
#include "symtab.h"
#include "language.h"
#include "valprint.h"
-
+#include "extension-priv.h"
#include "python.h"
-
-#ifdef HAVE_PYTHON
#include "python-internal.h"
+#include "py-ref.h"
/* Return type of print_string_repr. */
search_pp_list (PyObject *list, PyObject *value)
{
Py_ssize_t pp_list_size, list_index;
- PyObject *function, *printer = NULL;
pp_list_size = PyList_Size (list);
for (list_index = 0; list_index < pp_list_size; list_index++)
{
- function = PyList_GetItem (list, list_index);
+ PyObject *function = PyList_GetItem (list, list_index);
if (! function)
return NULL;
/* Skip if disabled. */
if (PyObject_HasAttr (function, gdbpy_enabled_cst))
{
- PyObject *attr = PyObject_GetAttr (function, gdbpy_enabled_cst);
+ gdbpy_ref<> attr (PyObject_GetAttr (function, gdbpy_enabled_cst));
int cmp;
- if (!attr)
+ if (attr == NULL)
return NULL;
- cmp = PyObject_IsTrue (attr);
- Py_DECREF (attr);
+ cmp = PyObject_IsTrue (attr.get ());
if (cmp == -1)
return NULL;
continue;
}
- printer = PyObject_CallFunctionObjArgs (function, value, NULL);
- if (! printer)
+ gdbpy_ref<> printer (PyObject_CallFunctionObjArgs (function, value,
+ NULL));
+ if (printer == NULL)
return NULL;
else if (printer != Py_None)
- return printer;
-
- Py_DECREF (printer);
+ return printer.release ();
}
Py_RETURN_NONE;
static PyObject *
find_pretty_printer_from_objfiles (PyObject *value)
{
- PyObject *pp_list;
- PyObject *function;
struct objfile *obj;
ALL_OBJFILES (obj)
continue;
}
- pp_list = objfpy_get_printers (objf, NULL);
- function = search_pp_list (pp_list, value);
- Py_XDECREF (pp_list);
+ gdbpy_ref<> pp_list (objfpy_get_printers (objf, NULL));
+ gdbpy_ref<> function (search_pp_list (pp_list.get (), value));
/* If there is an error in any objfile list, abort the search and exit. */
- if (! function)
+ if (function == NULL)
return NULL;
if (function != Py_None)
- return function;
-
- Py_DECREF (function);
+ return function.release ();
}
Py_RETURN_NONE;
static PyObject *
find_pretty_printer_from_progspace (PyObject *value)
{
- PyObject *pp_list;
- PyObject *function;
PyObject *obj = pspace_to_pspace_object (current_program_space);
if (!obj)
return NULL;
- pp_list = pspy_get_printers (obj, NULL);
- function = search_pp_list (pp_list, value);
- Py_XDECREF (pp_list);
- return function;
+ gdbpy_ref<> pp_list (pspy_get_printers (obj, NULL));
+ return search_pp_list (pp_list.get (), value);
}
/* Subroutine of find_pretty_printer to simplify it.
static PyObject *
find_pretty_printer_from_gdb (PyObject *value)
{
- PyObject *pp_list;
- PyObject *function;
-
/* Fetch the global pretty printer list. */
if (gdb_python_module == NULL
|| ! PyObject_HasAttrString (gdb_python_module, "pretty_printers"))
Py_RETURN_NONE;
- pp_list = PyObject_GetAttrString (gdb_python_module, "pretty_printers");
- if (pp_list == NULL || ! PyList_Check (pp_list))
- {
- Py_XDECREF (pp_list);
- Py_RETURN_NONE;
- }
+ gdbpy_ref<> pp_list (PyObject_GetAttrString (gdb_python_module,
+ "pretty_printers"));
+ if (pp_list == NULL || ! PyList_Check (pp_list.get ()))
+ Py_RETURN_NONE;
- function = search_pp_list (pp_list, value);
- Py_XDECREF (pp_list);
- return function;
+ return search_pp_list (pp_list.get (), value);
}
/* Find the pretty-printing constructor function for VALUE. If no
static PyObject *
find_pretty_printer (PyObject *value)
{
- PyObject *function;
-
/* Look at the pretty-printer list for each objfile
in the current program-space. */
- function = find_pretty_printer_from_objfiles (value);
+ gdbpy_ref<> function (find_pretty_printer_from_objfiles (value));
if (function == NULL || function != Py_None)
- return function;
- Py_DECREF (function);
+ return function.release ();
/* Look at the pretty-printer list for the current program-space. */
- function = find_pretty_printer_from_progspace (value);
+ function.reset (find_pretty_printer_from_progspace (value));
if (function == NULL || function != Py_None)
- return function;
- Py_DECREF (function);
+ return function.release ();
/* Look at the pretty-printer list in the gdb module. */
- function = find_pretty_printer_from_gdb (value);
- return function;
+ return find_pretty_printer_from_gdb (value);
}
/* Pretty-print a single value, via the printer object PRINTER.
static PyObject *
pretty_print_one_value (PyObject *printer, struct value **out_value)
{
- volatile struct gdb_exception except;
- PyObject *result = NULL;
+ gdbpy_ref<> result;
*out_value = NULL;
- TRY_CATCH (except, RETURN_MASK_ALL)
+ TRY
{
- result = PyObject_CallMethodObjArgs (printer, gdbpy_to_string_cst, NULL);
- if (result)
+ result.reset (PyObject_CallMethodObjArgs (printer, gdbpy_to_string_cst,
+ NULL));
+ if (result != NULL)
{
- if (! gdbpy_is_string (result) && ! gdbpy_is_lazy_string (result)
+ if (! gdbpy_is_string (result.get ())
+ && ! gdbpy_is_lazy_string (result.get ())
&& result != Py_None)
{
- *out_value = convert_value_from_python (result);
+ *out_value = convert_value_from_python (result.get ());
if (PyErr_Occurred ())
*out_value = NULL;
- Py_DECREF (result);
result = NULL;
}
}
}
+ CATCH (except, RETURN_MASK_ALL)
+ {
+ }
+ END_CATCH
- return result;
+ return result.release ();
}
/* Return the display hint for the object printer, PRINTER. Return
NULL if there is no display_hint method, or if the method did not
return a string. On error, print stack trace and return NULL. On
success, return an xmalloc()d string. */
-char *
+gdb::unique_xmalloc_ptr<char>
gdbpy_get_display_hint (PyObject *printer)
{
- PyObject *hint;
- char *result = NULL;
+ gdb::unique_xmalloc_ptr<char> result;
if (! PyObject_HasAttr (printer, gdbpy_display_hint_cst))
return NULL;
- hint = PyObject_CallMethodObjArgs (printer, gdbpy_display_hint_cst, NULL);
- if (hint)
+ gdbpy_ref<> hint (PyObject_CallMethodObjArgs (printer, gdbpy_display_hint_cst,
+ NULL));
+ if (hint != NULL)
{
- if (gdbpy_is_string (hint))
+ if (gdbpy_is_string (hint.get ()))
{
- result = python_string_to_host_string (hint);
+ result = python_string_to_host_string (hint.get ());
if (result == NULL)
gdbpy_print_stack ();
}
- Py_DECREF (hint);
}
else
gdbpy_print_stack ();
{
if (PyErr_ExceptionMatches (gdbpy_gdb_memory_error))
{
- struct cleanup *cleanup;
PyObject *type, *value, *trace;
- char *msg;
PyErr_Fetch (&type, &value, &trace);
- cleanup = make_cleanup_py_decref (type);
- make_cleanup_py_decref (value);
- make_cleanup_py_decref (trace);
- msg = gdbpy_exception_to_string (type, value);
- make_cleanup (xfree, msg);
+ gdbpy_ref<> type_ref (type);
+ gdbpy_ref<> value_ref (value);
+ gdbpy_ref<> trace_ref (trace);
+
+ gdb::unique_xmalloc_ptr<char>
+ msg (gdbpy_exception_to_string (type, value));
if (msg == NULL || *msg == '\0')
fprintf_filtered (stream, _("<error reading variable>"));
else
- fprintf_filtered (stream, _("<error reading variable: %s>"), msg);
-
- do_cleanups (cleanup);
+ fprintf_filtered (stream, _("<error reading variable: %s>"),
+ msg.get ());
}
else
gdbpy_print_stack ();
}
-/* Helper for apply_val_pretty_printer which calls to_string and
+/* Helper for gdbpy_apply_val_pretty_printer which calls to_string and
formats the result. */
static enum string_repr_result
struct gdbarch *gdbarch)
{
struct value *replacement = NULL;
- PyObject *py_str = NULL;
enum string_repr_result result = string_repr_ok;
- py_str = pretty_print_one_value (printer, &replacement);
- if (py_str)
+ gdbpy_ref<> py_str (pretty_print_one_value (printer, &replacement));
+ if (py_str != NULL)
{
- struct cleanup *cleanup = make_cleanup_py_decref (py_str);
-
if (py_str == Py_None)
result = string_repr_none;
- else if (gdbpy_is_lazy_string (py_str))
+ else if (gdbpy_is_lazy_string (py_str.get ()))
{
CORE_ADDR addr;
long length;
struct type *type;
- char *encoding = NULL;
+ gdb::unique_xmalloc_ptr<char> encoding;
struct value_print_options local_opts = *options;
- make_cleanup (free_current_contents, &encoding);
- gdbpy_extract_lazy_string (py_str, &addr, &type,
+ gdbpy_extract_lazy_string (py_str.get (), &addr, &type,
&length, &encoding);
local_opts.addressprint = 0;
- val_print_string (type, encoding, addr, (int) length,
+ val_print_string (type, encoding.get (), addr, (int) length,
stream, &local_opts);
}
else
{
- PyObject *string;
-
- string = python_string_to_target_python_string (py_str);
- if (string)
+ gdbpy_ref<> string
+ (python_string_to_target_python_string (py_str.get ()));
+ if (string != NULL)
{
char *output;
long length;
struct type *type;
- make_cleanup_py_decref (string);
#ifdef IS_PY3K
- output = PyBytes_AS_STRING (string);
- length = PyBytes_GET_SIZE (string);
+ output = PyBytes_AS_STRING (string.get ());
+ length = PyBytes_GET_SIZE (string.get ());
#else
- output = PyString_AsString (string);
- length = PyString_Size (string);
+ output = PyString_AsString (string.get ());
+ length = PyString_Size (string.get ());
#endif
type = builtin_type (gdbarch)->builtin_char;
print_stack_unless_memory_error (stream);
}
}
-
- do_cleanups (cleanup);
}
else if (replacement)
{
}
#ifndef IS_PY3K
-static void
-py_restore_tstate (void *p)
-{
- PyFrameObject *frame = p;
- PyThreadState *tstate = PyThreadState_GET ();
-
- tstate->frame = frame;
-}
/* Create a dummy PyFrameObject, needed to work around
a Python-2.4 bug with generators. */
-static PyObject *
-push_dummy_python_frame (void)
+class dummy_python_frame
{
- PyObject *empty_string, *null_tuple, *globals;
- PyCodeObject *code;
- PyFrameObject *frame;
- PyThreadState *tstate;
+ public:
- empty_string = PyString_FromString ("");
- if (!empty_string)
- return NULL;
+ dummy_python_frame ();
- null_tuple = PyTuple_New (0);
- if (!null_tuple)
- {
- Py_DECREF (empty_string);
- return NULL;
- }
+ ~dummy_python_frame ()
+ {
+ if (m_valid)
+ m_tstate->frame = m_saved_frame;
+ }
- code = PyCode_New (0, /* argcount */
- 0, /* nlocals */
- 0, /* stacksize */
- 0, /* flags */
- empty_string, /* code */
- null_tuple, /* consts */
- null_tuple, /* names */
- null_tuple, /* varnames */
-#if PYTHON_API_VERSION >= 1010
- null_tuple, /* freevars */
- null_tuple, /* cellvars */
-#endif
- empty_string, /* filename */
- empty_string, /* name */
- 1, /* firstlineno */
- empty_string /* lnotab */
- );
+ bool failed () const
+ {
+ return !m_valid;
+ }
- Py_DECREF (empty_string);
- Py_DECREF (null_tuple);
+ private:
- if (!code)
- return NULL;
+ bool m_valid;
+ PyFrameObject *m_saved_frame;
+ gdbpy_ref<> m_frame;
+ PyThreadState *m_tstate;
+};
- globals = PyDict_New ();
- if (!globals)
- {
- Py_DECREF (code);
- return NULL;
- }
+dummy_python_frame::dummy_python_frame ()
+: m_valid (false),
+ m_saved_frame (NULL),
+ m_tstate (NULL)
+{
+ PyCodeObject *code;
+ PyFrameObject *frame;
- tstate = PyThreadState_GET ();
+ gdbpy_ref<> empty_string (PyString_FromString (""));
+ if (empty_string == NULL)
+ return;
- frame = PyFrame_New (tstate, code, globals, NULL);
+ gdbpy_ref<> null_tuple (PyTuple_New (0));
+ if (null_tuple == NULL)
+ return;
- Py_DECREF (globals);
- Py_DECREF (code);
+ code = PyCode_New (0, /* argcount */
+ 0, /* locals */
+ 0, /* stacksize */
+ 0, /* flags */
+ empty_string.get (), /* code */
+ null_tuple.get (), /* consts */
+ null_tuple.get (), /* names */
+ null_tuple.get (), /* varnames */
+#if PYTHON_API_VERSION >= 1010
+ null_tuple.get (), /* freevars */
+ null_tuple.get (), /* cellvars */
+#endif
+ empty_string.get (), /* filename */
+ empty_string.get (), /* name */
+ 1, /* firstlineno */
+ empty_string.get () /* lnotab */
+ );
+ if (code == NULL)
+ return;
+ gdbpy_ref<> code_holder ((PyObject *) code);
- if (!frame)
- return NULL;
+ gdbpy_ref<> globals (PyDict_New ());
+ if (globals == NULL)
+ return;
- tstate->frame = frame;
- make_cleanup (py_restore_tstate, frame->f_back);
- return (PyObject *) frame;
+ m_tstate = PyThreadState_GET ();
+ frame = PyFrame_New (m_tstate, code, globals.get (), NULL);
+ if (frame == NULL)
+ return;
+
+ m_frame.reset ((PyObject *) frame);
+ m_tstate->frame = frame;
+ m_saved_frame = frame->f_back;
+ m_valid = true;
}
#endif
-/* Helper for apply_val_pretty_printer that formats children of the
+/* Helper for gdbpy_apply_val_pretty_printer that formats children of the
printer, if any exist. If is_py_none is true, then nothing has
been printed by to_string, and format output accordingly. */
static void
{
int is_map, is_array, done_flag, pretty;
unsigned int i;
- PyObject *children, *iter;
-#ifndef IS_PY3K
- PyObject *frame;
-#endif
- struct cleanup *cleanups;
if (! PyObject_HasAttr (printer, gdbpy_children_cst))
return;
is_map = hint && ! strcmp (hint, "map");
is_array = hint && ! strcmp (hint, "array");
- children = PyObject_CallMethodObjArgs (printer, gdbpy_children_cst,
- NULL);
- if (! children)
+ gdbpy_ref<> children (PyObject_CallMethodObjArgs (printer, gdbpy_children_cst,
+ NULL));
+ if (children == NULL)
{
print_stack_unless_memory_error (stream);
return;
}
- cleanups = make_cleanup_py_decref (children);
-
- iter = PyObject_GetIter (children);
- if (!iter)
+ gdbpy_ref<> iter (PyObject_GetIter (children.get ()));
+ if (iter == NULL)
{
print_stack_unless_memory_error (stream);
- goto done;
+ return;
}
- make_cleanup_py_decref (iter);
/* Use the prettyformat_arrays option if we are printing an array,
and the pretty option otherwise. */
where it insists on having a non-NULL tstate->frame when
a generator is called. */
#ifndef IS_PY3K
- frame = push_dummy_python_frame ();
- if (!frame)
+ dummy_python_frame frame;
+ if (frame.failed ())
{
gdbpy_print_stack ();
- goto done;
+ return;
}
- make_cleanup_py_decref (frame);
#endif
done_flag = 0;
for (i = 0; i < options->print_max; ++i)
{
- PyObject *py_v, *item = PyIter_Next (iter);
+ PyObject *py_v;
const char *name;
- struct cleanup *inner_cleanup;
- if (! item)
+ gdbpy_ref<> item (PyIter_Next (iter.get ()));
+ if (item == NULL)
{
if (PyErr_Occurred ())
print_stack_unless_memory_error (stream);
/* Set a flag so we can know whether we printed all the
available elements. */
- else
+ else
done_flag = 1;
break;
}
- if (! PyArg_ParseTuple (item, "sO", &name, &py_v))
+ if (! PyTuple_Check (item.get ()) || PyTuple_Size (item.get ()) != 2)
+ {
+ PyErr_SetString (PyExc_TypeError,
+ _("Result of children iterator not a tuple"
+ " of two elements."));
+ gdbpy_print_stack ();
+ continue;
+ }
+ if (! PyArg_ParseTuple (item.get (), "sO", &name, &py_v))
{
+ /* The user won't necessarily get a stack trace here, so provide
+ more context. */
+ if (gdbpy_print_python_errors_p ())
+ fprintf_unfiltered (gdb_stderr,
+ _("Bad result from children iterator.\n"));
gdbpy_print_stack ();
- Py_DECREF (item);
continue;
}
- inner_cleanup = make_cleanup_py_decref (item);
/* Print initial "{". For other elements, there are three
cases:
CORE_ADDR addr;
struct type *type;
long length;
- char *encoding = NULL;
+ gdb::unique_xmalloc_ptr<char> encoding;
struct value_print_options local_opts = *options;
- make_cleanup (free_current_contents, &encoding);
gdbpy_extract_lazy_string (py_v, &addr, &type, &length, &encoding);
local_opts.addressprint = 0;
- val_print_string (type, encoding, addr, (int) length, stream,
+ val_print_string (type, encoding.get (), addr, (int) length, stream,
&local_opts);
}
else if (gdbpy_is_string (py_v))
{
- char *output;
+ gdb::unique_xmalloc_ptr<char> output;
output = python_string_to_host_string (py_v);
if (!output)
gdbpy_print_stack ();
else
- {
- fputs_filtered (output, stream);
- xfree (output);
- }
+ fputs_filtered (output.get (), stream);
}
else
{
if (is_map && i % 2 == 0)
fputs_filtered ("] = ", stream);
-
- do_cleanups (inner_cleanup);
}
if (i)
}
fputs_filtered ("}", stream);
}
-
- done:
- do_cleanups (cleanups);
}
-int
-apply_val_pretty_printer (struct type *type, const gdb_byte *valaddr,
- int embedded_offset, CORE_ADDR address,
- struct ui_file *stream, int recurse,
- const struct value *val,
- const struct value_print_options *options,
- const struct language_defn *language)
+enum ext_lang_rc
+gdbpy_apply_val_pretty_printer (const struct extension_language_defn *extlang,
+ struct type *type,
+ LONGEST embedded_offset, CORE_ADDR address,
+ struct ui_file *stream, int recurse,
+ struct value *val,
+ const struct value_print_options *options,
+ const struct language_defn *language)
{
struct gdbarch *gdbarch = get_type_arch (type);
- PyObject *printer = NULL;
- PyObject *val_obj = NULL;
struct value *value;
- char *hint = NULL;
- struct cleanup *cleanups;
- int result = 0;
enum string_repr_result print_result;
+ const gdb_byte *valaddr = value_contents_for_printing (val);
/* No pretty-printer support for unavailable values. */
if (!value_bytes_available (val, embedded_offset, TYPE_LENGTH (type)))
- return 0;
+ return EXT_LANG_RC_NOP;
if (!gdb_python_initialized)
- return 0;
+ return EXT_LANG_RC_NOP;
- cleanups = ensure_python_env (gdbarch, language);
+ gdbpy_enter enter_py (gdbarch, language);
/* Instantiate the printer. */
- if (valaddr)
- valaddr += embedded_offset;
- value = value_from_contents_and_address (type, valaddr,
- address + embedded_offset);
-
- set_value_component_location (value, val);
- /* set_value_component_location resets the address, so we may
- need to set it again. */
- if (VALUE_LVAL (value) != lval_internalvar
- && VALUE_LVAL (value) != lval_internalvar_component
- && VALUE_LVAL (value) != lval_computed)
- set_value_address (value, address + embedded_offset);
-
- val_obj = value_to_value_object (value);
- if (! val_obj)
- goto done;
-
- /* Find the constructor. */
- printer = find_pretty_printer (val_obj);
- Py_DECREF (val_obj);
+ value = value_from_component (val, type, embedded_offset);
+ gdbpy_ref<> val_obj (value_to_value_object (value));
+ if (val_obj == NULL)
+ {
+ print_stack_unless_memory_error (stream);
+ return EXT_LANG_RC_ERROR;
+ }
+
+ /* Find the constructor. */
+ gdbpy_ref<> printer (find_pretty_printer (val_obj.get ()));
if (printer == NULL)
- goto done;
+ {
+ print_stack_unless_memory_error (stream);
+ return EXT_LANG_RC_ERROR;
+ }
- make_cleanup_py_decref (printer);
if (printer == Py_None)
- goto done;
+ return EXT_LANG_RC_NOP;
/* If we are printing a map, we want some special formatting. */
- hint = gdbpy_get_display_hint (printer);
- make_cleanup (free_current_contents, &hint);
+ gdb::unique_xmalloc_ptr<char> hint (gdbpy_get_display_hint (printer.get ()));
/* Print the section */
- print_result = print_string_repr (printer, hint, stream, recurse,
- options, language, gdbarch);
+ print_result = print_string_repr (printer.get (), hint.get (), stream,
+ recurse, options, language, gdbarch);
if (print_result != string_repr_error)
- print_children (printer, hint, stream, recurse, options, language,
- print_result == string_repr_none);
-
- result = 1;
+ print_children (printer.get (), hint.get (), stream, recurse, options,
+ language, print_result == string_repr_none);
-
- done:
if (PyErr_Occurred ())
print_stack_unless_memory_error (stream);
- do_cleanups (cleanups);
- return result;
+ return EXT_LANG_RC_OK;
}
/* Find a pretty-printer object for the varobj module. Returns a new
reference to the object if successful; returns NULL if not. VALUE
- is the value for which a printer tests to determine if it
+ is the value for which a printer tests to determine if it
can pretty-print the value. */
PyObject *
gdbpy_get_varobj_pretty_printer (struct value *value)
{
- PyObject *val_obj;
- PyObject *pretty_printer = NULL;
- volatile struct gdb_exception except;
-
- TRY_CATCH (except, RETURN_MASK_ALL)
+ TRY
{
value = value_copy (value);
}
- GDB_PY_HANDLE_EXCEPTION (except);
-
- val_obj = value_to_value_object (value);
- if (! val_obj)
+ CATCH (except, RETURN_MASK_ALL)
+ {
+ GDB_PY_HANDLE_EXCEPTION (except);
+ }
+ END_CATCH
+
+ gdbpy_ref<> val_obj (value_to_value_object (value));
+ if (val_obj == NULL)
return NULL;
- pretty_printer = find_pretty_printer (val_obj);
- Py_DECREF (val_obj);
- return pretty_printer;
+ return find_pretty_printer (val_obj.get ());
}
/* A Python function which wraps find_pretty_printer and instantiates
value = value_object_to_value (val_obj);
if (! value)
{
- PyErr_SetString (PyExc_TypeError,
+ PyErr_SetString (PyExc_TypeError,
_("Argument must be a gdb.Value."));
return NULL;
}
cons = find_pretty_printer (val_obj);
return cons;
}
-
-#else /* HAVE_PYTHON */
-
-int
-apply_val_pretty_printer (struct type *type, const gdb_byte *valaddr,
- int embedded_offset, CORE_ADDR address,
- struct ui_file *stream, int recurse,
- const struct value *val,
- const struct value_print_options *options,
- const struct language_defn *language)
-{
- return 0;
-}
-
-#endif /* HAVE_PYTHON */