aboutsummaryrefslogtreecommitdiff
path: root/gdb/python/python-prettyprint.c
diff options
context:
space:
mode:
authorJoel Brobecker <brobecker@gnat.com>2009-09-09 17:45:42 +0000
committerJoel Brobecker <brobecker@gnat.com>2009-09-09 17:45:42 +0000
commit5172aecbd2b65e71aedbd21c46253ca6a20227aa (patch)
tree879124432741656573e3a6f6a4c7b3a9dfb2ca8a /gdb/python/python-prettyprint.c
parentb83e9eb71cb4a21b31f8f47782da821a5a0ddb32 (diff)
downloadbinutils-5172aecbd2b65e71aedbd21c46253ca6a20227aa.zip
binutils-5172aecbd2b65e71aedbd21c46253ca6a20227aa.tar.gz
binutils-5172aecbd2b65e71aedbd21c46253ca6a20227aa.tar.bz2
Checking in this patch for Thiago: Rename python-* files into py-*,
more 8+3 friendly. gdb/ * Makefile.in (py-cmd.o): Renamed from python-cmd.o. Updated references. (py-frame.o): Renamed from python-frame.o. Updated references. (py-function.o): Renamed from python-function.o. Updated references. (py-objfile.o): Renamed from python-objfile.o. Updated references. (py-prettyprint.o): Renamed from python-prettyprint.o. Updated +references. (py-type.o): Renamed from python-type.o. Updated references. (py-utils.o): Renamed from python-utils.o. Updated references. (py-value.o): Renamed from python-value.o. Updated references. * py-cmd.o: Renamed from python-cmd.o. * py-frame.o: Renamed from python-frame.o. * py-function.o: Renamed from python-function.o. * py-objfile.o: Renamed from python-objfile.o. * py-prettyprint.o: Renamed from python-prettyprint.o. * py-type.o: Renamed from python-type.o. * py-utils.o: Renamed from python-utils.o. * py-value.o: Renamed from python-value.o. gdb/testsuite/ * gdb.python/Makefile.in (EXECUTABLES): Adjust to new executable names, add missing ones. * gdb.python/py-cmd.exp: Rename from python-cmd.exp. * gdb.python/py-frame.c: Rename from python-frame.c. * gdb.python/py-frame.exp: Rename from python-frame.exp. Adjust testfile name. * gdb.python/py-function.exp: Rename from python-function.exp. * gdb.python/py-mi.exp: Rename from python-mi.exp. Adjust testfile name. * gdb.python/py-prettyprint.c: Rename from python-prettyprint.c. * gdb.python/py-prettyprint.exp: Rename from python-prettyprint.exp. Adjust testfile name. * gdb.python/py-prettyprint.py: Rename from python-prettyprint.py. * gdb.python/py-template.cc: Rename from python-template.cc. * gdb.python/py-template.exp: Rename from python-template.exp. Adjust testfile name. * gdb.python/py-value.c: Rename from python-value.c. * gdb.python/py-value.exp: Rename from python-value.exp. Adjust testfile name.
Diffstat (limited to 'gdb/python/python-prettyprint.c')
-rw-r--r--gdb/python/python-prettyprint.c612
1 files changed, 0 insertions, 612 deletions
diff --git a/gdb/python/python-prettyprint.c b/gdb/python/python-prettyprint.c
deleted file mode 100644
index 5d696c8..0000000
--- a/gdb/python/python-prettyprint.c
+++ /dev/null
@@ -1,612 +0,0 @@
-/* Python pretty-printing
-
- Copyright (C) 2008, 2009 Free Software Foundation, Inc.
-
- This file is part of GDB.
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- 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 "python.h"
-
-#ifdef HAVE_PYTHON
-#include "python-internal.h"
-
-
-/* Helper function for find_pretty_printer which iterates over a list,
- calls each function and inspects output. This will return a
- printer object if one recognizes VALUE. If no printer is found, it
- will return None. On error, it will set the Python error and
- return NULL. */
-static PyObject *
-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);
- if (! function)
- return NULL;
-
- printer = PyObject_CallFunctionObjArgs (function, value, NULL);
- if (! printer)
- return NULL;
- else if (printer != Py_None)
- return printer;
-
- Py_DECREF (printer);
- }
-
- Py_RETURN_NONE;
-}
-
-/* Find the pretty-printing constructor function for VALUE. If no
- pretty-printer exists, return None. If one exists, return a new
- reference. On error, set the Python error and return NULL. */
-static PyObject *
-find_pretty_printer (PyObject *value)
-{
- PyObject *pp_list = NULL;
- PyObject *function = NULL;
- struct objfile *obj;
- volatile struct gdb_exception except;
-
- /* Look at the pretty-printer dictionary for each objfile. */
- ALL_OBJFILES (obj)
- {
- PyObject *objf = objfile_to_objfile_object (obj);
- if (!objf)
- {
- /* Ignore the error and continue. */
- PyErr_Clear ();
- continue;
- }
-
- pp_list = objfpy_get_printers (objf, NULL);
- function = search_pp_list (pp_list, value);
-
- /* If there is an error in any objfile list, abort the search and
- exit. */
- if (! function)
- {
- Py_XDECREF (pp_list);
- return NULL;
- }
-
- if (function != Py_None)
- goto done;
-
- Py_DECREF (function);
- Py_XDECREF (pp_list);
- }
-
- pp_list = NULL;
- /* Fetch the global pretty printer dictionary. */
- if (! PyObject_HasAttrString (gdb_module, "pretty_printers"))
- {
- function = Py_None;
- Py_INCREF (function);
- goto done;
- }
- pp_list = PyObject_GetAttrString (gdb_module, "pretty_printers");
- if (! pp_list)
- goto done;
- if (! PyList_Check (pp_list))
- goto done;
-
- function = search_pp_list (pp_list, value);
-
- done:
- Py_XDECREF (pp_list);
-
- return function;
-}
-/* Pretty-print a single value, via the printer object PRINTER.
- If the function returns a string, a PyObject containing the string
- is returned. Otherwise, if the function returns a value,
- *OUT_VALUE is set to the value, and NULL is returned. On error,
- *OUT_VALUE is set to NULL, and NULL is returned. */
-static PyObject *
-pretty_print_one_value (PyObject *printer, struct value **out_value)
-{
- volatile struct gdb_exception except;
- PyObject *result = NULL;
-
- *out_value = NULL;
- TRY_CATCH (except, RETURN_MASK_ALL)
- {
- result = PyObject_CallMethodObjArgs (printer, gdbpy_to_string_cst, NULL);
- if (result)
- {
- if (! gdbpy_is_string (result))
- {
- *out_value = convert_value_from_python (result);
- if (PyErr_Occurred ())
- *out_value = NULL;
- Py_DECREF (result);
- result = NULL;
- }
- }
- }
-
- return result;
-}
-
-/* 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 *
-gdbpy_get_display_hint (PyObject *printer)
-{
- PyObject *hint;
- char *result = NULL;
-
- if (! PyObject_HasAttr (printer, gdbpy_display_hint_cst))
- return NULL;
-
- hint = PyObject_CallMethodObjArgs (printer, gdbpy_display_hint_cst, NULL);
- if (gdbpy_is_string (hint))
- result = python_string_to_host_string (hint);
- if (hint)
- Py_DECREF (hint);
- else
- gdbpy_print_stack ();
-
- return result;
-}
-
-/* Helper for apply_val_pretty_printer which calls to_string and
- formats the result. */
-static void
-print_string_repr (PyObject *printer, const char *hint,
- struct ui_file *stream, int recurse,
- const struct value_print_options *options,
- const struct language_defn *language,
- struct gdbarch *gdbarch)
-{
- struct value *replacement = NULL;
- PyObject *py_str = NULL;
-
- py_str = pretty_print_one_value (printer, &replacement);
- if (py_str)
- {
- PyObject *string = python_string_to_target_python_string (py_str);
- if (string)
- {
- gdb_byte *output = PyString_AsString (string);
- int len = PyString_Size (string);
-
- if (hint && !strcmp (hint, "string"))
- LA_PRINT_STRING (stream, builtin_type (gdbarch)->builtin_char,
- output, len, 0, options);
- else
- fputs_filtered (output, stream);
- Py_DECREF (string);
- }
- else
- gdbpy_print_stack ();
- Py_DECREF (py_str);
- }
- else if (replacement)
- common_val_print (replacement, stream, recurse, options, language);
- else
- gdbpy_print_stack ();
-}
-
-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 ()
-{
- PyObject *empty_string, *null_tuple, *globals;
- PyCodeObject *code;
- PyFrameObject *frame;
- PyThreadState *tstate;
-
- empty_string = PyString_FromString ("");
- if (!empty_string)
- return NULL;
-
- null_tuple = PyTuple_New (0);
- if (!null_tuple)
- {
- Py_DECREF (empty_string);
- return NULL;
- }
-
- 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 */
- );
-
- Py_DECREF (empty_string);
- Py_DECREF (null_tuple);
-
- if (!code)
- return NULL;
-
- globals = PyDict_New ();
- if (!globals)
- {
- Py_DECREF (code);
- return NULL;
- }
-
- tstate = PyThreadState_GET ();
-
- frame = PyFrame_New (tstate, code, globals, NULL);
-
- Py_DECREF (globals);
- Py_DECREF (code);
-
- if (!frame)
- return NULL;
-
- tstate->frame = frame;
- make_cleanup (py_restore_tstate, frame->f_back);
- return (PyObject *) frame;
-}
-
-/* Helper for apply_val_pretty_printer that formats children of the
- printer, if any exist. */
-static void
-print_children (PyObject *printer, const char *hint,
- struct ui_file *stream, int recurse,
- const struct value_print_options *options,
- const struct language_defn *language)
-{
- int is_map, is_array, done_flag, pretty;
- unsigned int i;
- PyObject *children, *iter, *frame;
- struct cleanup *cleanups;
-
- if (! PyObject_HasAttr (printer, gdbpy_children_cst))
- return;
-
- /* If we are printing a map or an array, we want some special
- formatting. */
- is_map = hint && ! strcmp (hint, "map");
- is_array = hint && ! strcmp (hint, "array");
-
- children = PyObject_CallMethodObjArgs (printer, gdbpy_children_cst,
- NULL);
- if (! children)
- {
- gdbpy_print_stack ();
- return;
- }
-
- cleanups = make_cleanup_py_decref (children);
-
- iter = PyObject_GetIter (children);
- if (!iter)
- {
- gdbpy_print_stack ();
- goto done;
- }
- make_cleanup_py_decref (iter);
-
- /* Use the prettyprint_arrays option if we are printing an array,
- and the pretty option otherwise. */
- pretty = is_array ? options->prettyprint_arrays : options->pretty;
-
- /* Manufacture a dummy Python frame to work around Python 2.4 bug,
- where it insists on having a non-NULL tstate->frame when
- a generator is called. */
- frame = push_dummy_python_frame ();
- if (!frame)
- {
- gdbpy_print_stack ();
- goto done;
- }
- make_cleanup_py_decref (frame);
-
- done_flag = 0;
- for (i = 0; i < options->print_max; ++i)
- {
- PyObject *py_v, *item = PyIter_Next (iter);
- char *name;
- struct cleanup *inner_cleanup;
-
- if (! item)
- {
- if (PyErr_Occurred ())
- gdbpy_print_stack ();
- /* Set a flag so we can know whether we printed all the
- available elements. */
- else
- done_flag = 1;
- break;
- }
-
- if (! PyArg_ParseTuple (item, "sO", &name, &py_v))
- {
- gdbpy_print_stack ();
- Py_DECREF (item);
- continue;
- }
- inner_cleanup = make_cleanup_py_decref (item);
-
- /* Print initial "{". For other elements, there are three
- cases:
- 1. Maps. Print a "," after each value element.
- 2. Arrays. Always print a ",".
- 3. Other. Always print a ",". */
- if (i == 0)
- fputs_filtered (" = {", stream);
- else if (! is_map || i % 2 == 0)
- fputs_filtered (pretty ? "," : ", ", stream);
-
- /* In summary mode, we just want to print "= {...}" if there is
- a value. */
- if (options->summary)
- {
- /* This increment tricks the post-loop logic to print what
- we want. */
- ++i;
- /* Likewise. */
- pretty = 0;
- break;
- }
-
- if (! is_map || i % 2 == 0)
- {
- if (pretty)
- {
- fputs_filtered ("\n", stream);
- print_spaces_filtered (2 + 2 * recurse, stream);
- }
- else
- wrap_here (n_spaces (2 + 2 *recurse));
- }
-
- if (is_map && i % 2 == 0)
- fputs_filtered ("[", stream);
- else if (is_array)
- {
- /* We print the index, not whatever the child method
- returned as the name. */
- if (options->print_array_indexes)
- fprintf_filtered (stream, "[%d] = ", i);
- }
- else if (! is_map)
- {
- fputs_filtered (name, stream);
- fputs_filtered (" = ", stream);
- }
-
- if (gdbpy_is_string (py_v))
- {
- char *text = python_string_to_host_string (py_v);
- if (! text)
- gdbpy_print_stack ();
- else
- {
- fputs_filtered (text, stream);
- xfree (text);
- }
- }
- else
- {
- struct value *value = convert_value_from_python (py_v);
-
- if (value == NULL)
- {
- gdbpy_print_stack ();
- error (_("Error while executing Python code."));
- }
- else
- common_val_print (value, stream, recurse + 1, options, language);
- }
-
- if (is_map && i % 2 == 0)
- fputs_filtered ("] = ", stream);
-
- do_cleanups (inner_cleanup);
- }
-
- if (i)
- {
- if (!done_flag)
- {
- if (pretty)
- {
- fputs_filtered ("\n", stream);
- print_spaces_filtered (2 + 2 * recurse, stream);
- }
- fputs_filtered ("...", stream);
- }
- if (pretty)
- {
- fputs_filtered ("\n", stream);
- print_spaces_filtered (2 * recurse, stream);
- }
- 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_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;
-
- cleanups = ensure_python_env (gdbarch, language);
-
- /* Instantiate the printer. */
- if (valaddr)
- valaddr += embedded_offset;
- value = value_from_contents_and_address (type, valaddr, address);
-
- 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);
- make_cleanup_py_decref (printer);
- if (! printer || printer == Py_None)
- goto done;
-
- /* If we are printing a map, we want some special formatting. */
- hint = gdbpy_get_display_hint (printer);
- make_cleanup (free_current_contents, &hint);
-
- /* Print the section */
- print_string_repr (printer, hint, stream, recurse, options, language,
- gdbarch);
- print_children (printer, hint, stream, recurse, options, language);
- result = 1;
-
-
- done:
- if (PyErr_Occurred ())
- gdbpy_print_stack ();
- do_cleanups (cleanups);
- return result;
-}
-
-
-/* Apply a pretty-printer for the varobj code. PRINTER_OBJ is the
- print object. It must have a 'to_string' method (but this is
- checked by varobj, not here) which takes no arguments and
- returns a string. The printer will return a value and in the case
- of a Python string being returned, this function will return a
- PyObject containing the string. For any other type, *REPLACEMENT is
- set to the replacement value and this function returns NULL. On
- error, *REPLACEMENT is set to NULL and this function also returns
- NULL. */
-PyObject *
-apply_varobj_pretty_printer (PyObject *printer_obj,
- struct value **replacement)
-{
- int size = 0;
- PyObject *py_str = NULL;
-
- *replacement = NULL;
- py_str = pretty_print_one_value (printer_obj, replacement);
-
- if (*replacement == NULL && py_str == NULL)
- gdbpy_print_stack ();
-
- return py_str;
-}
-
-/* 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
- 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)
- {
- value = value_copy (value);
- }
- GDB_PY_HANDLE_EXCEPTION (except);
-
- val_obj = value_to_value_object (value);
- if (! val_obj)
- return NULL;
-
- pretty_printer = find_pretty_printer (val_obj);
- Py_DECREF (val_obj);
- return pretty_printer;
-}
-
-/* A Python function which wraps find_pretty_printer and instantiates
- the resulting class. This accepts a Value argument and returns a
- pretty printer instance, or None. This function is useful as an
- argument to the MI command -var-set-visualizer. */
-PyObject *
-gdbpy_default_visualizer (PyObject *self, PyObject *args)
-{
- PyObject *val_obj;
- PyObject *cons, *printer = NULL;
- struct value *value;
-
- if (! PyArg_ParseTuple (args, "O", &val_obj))
- return NULL;
- value = value_object_to_value (val_obj);
- if (! value)
- {
- 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_print_options *options,
- const struct language_defn *language)
-{
- return 0;
-}
-
-#endif /* HAVE_PYTHON */