1 /* Python pretty-printing
3 Copyright (C) 2008-2018 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/>. */
25 #include "extension-priv.h"
27 #include "python-internal.h"
30 /* Return type of print_string_repr. */
32 enum string_repr_result
34 /* The string method returned None. */
36 /* The string method had an error. */
42 /* Helper function for find_pretty_printer which iterates over a list,
43 calls each function and inspects output. This will return a
44 printer object if one recognizes VALUE. If no printer is found, it
45 will return None. On error, it will set the Python error and
49 search_pp_list (PyObject
*list
, PyObject
*value
)
51 Py_ssize_t pp_list_size
, list_index
;
53 pp_list_size
= PyList_Size (list
);
54 for (list_index
= 0; list_index
< pp_list_size
; list_index
++)
56 PyObject
*function
= PyList_GetItem (list
, list_index
);
60 /* Skip if disabled. */
61 if (PyObject_HasAttr (function
, gdbpy_enabled_cst
))
63 gdbpy_ref
<> attr (PyObject_GetAttr (function
, gdbpy_enabled_cst
));
68 cmp
= PyObject_IsTrue (attr
.get ());
76 gdbpy_ref
<> printer (PyObject_CallFunctionObjArgs (function
, value
,
80 else if (printer
!= Py_None
)
81 return printer
.release ();
87 /* Subroutine of find_pretty_printer to simplify it.
88 Look for a pretty-printer to print VALUE in all objfiles.
89 The result is NULL if there's an error and the search should be terminated.
90 The result is Py_None, suitably inc-ref'd, if no pretty-printer was found.
91 Otherwise the result is the pretty-printer function, suitably inc-ref'd. */
94 find_pretty_printer_from_objfiles (PyObject
*value
)
100 PyObject
*objf
= objfile_to_objfile_object (obj
);
103 /* Ignore the error and continue. */
108 gdbpy_ref
<> pp_list (objfpy_get_printers (objf
, NULL
));
109 gdbpy_ref
<> function (search_pp_list (pp_list
.get (), value
));
111 /* If there is an error in any objfile list, abort the search and exit. */
112 if (function
== NULL
)
115 if (function
!= Py_None
)
116 return function
.release ();
122 /* Subroutine of find_pretty_printer to simplify it.
123 Look for a pretty-printer to print VALUE in the current program space.
124 The result is NULL if there's an error and the search should be terminated.
125 The result is Py_None, suitably inc-ref'd, if no pretty-printer was found.
126 Otherwise the result is the pretty-printer function, suitably inc-ref'd. */
129 find_pretty_printer_from_progspace (PyObject
*value
)
131 PyObject
*obj
= pspace_to_pspace_object (current_program_space
);
135 gdbpy_ref
<> pp_list (pspy_get_printers (obj
, NULL
));
136 return search_pp_list (pp_list
.get (), value
);
139 /* Subroutine of find_pretty_printer to simplify it.
140 Look for a pretty-printer to print VALUE in the gdb module.
141 The result is NULL if there's an error and the search should be terminated.
142 The result is Py_None, suitably inc-ref'd, if no pretty-printer was found.
143 Otherwise the result is the pretty-printer function, suitably inc-ref'd. */
146 find_pretty_printer_from_gdb (PyObject
*value
)
148 /* Fetch the global pretty printer list. */
149 if (gdb_python_module
== NULL
150 || ! PyObject_HasAttrString (gdb_python_module
, "pretty_printers"))
152 gdbpy_ref
<> pp_list (PyObject_GetAttrString (gdb_python_module
,
154 if (pp_list
== NULL
|| ! PyList_Check (pp_list
.get ()))
157 return search_pp_list (pp_list
.get (), value
);
160 /* Find the pretty-printing constructor function for VALUE. If no
161 pretty-printer exists, return None. If one exists, return a new
162 reference. On error, set the Python error and return NULL. */
165 find_pretty_printer (PyObject
*value
)
167 /* Look at the pretty-printer list for each objfile
168 in the current program-space. */
169 gdbpy_ref
<> function (find_pretty_printer_from_objfiles (value
));
170 if (function
== NULL
|| function
!= Py_None
)
171 return function
.release ();
173 /* Look at the pretty-printer list for the current program-space. */
174 function
.reset (find_pretty_printer_from_progspace (value
));
175 if (function
== NULL
|| function
!= Py_None
)
176 return function
.release ();
178 /* Look at the pretty-printer list in the gdb module. */
179 return find_pretty_printer_from_gdb (value
);
182 /* Pretty-print a single value, via the printer object PRINTER.
183 If the function returns a string, a PyObject containing the string
184 is returned. If the function returns Py_NONE that means the pretty
185 printer returned the Python None as a value. Otherwise, if the
186 function returns a value, *OUT_VALUE is set to the value, and NULL
187 is returned. On error, *OUT_VALUE is set to NULL, NULL is
188 returned, with a python exception set. */
191 pretty_print_one_value (PyObject
*printer
, struct value
**out_value
)
198 result
.reset (PyObject_CallMethodObjArgs (printer
, gdbpy_to_string_cst
,
202 if (! gdbpy_is_string (result
.get ())
203 && ! gdbpy_is_lazy_string (result
.get ())
204 && result
!= Py_None
)
206 *out_value
= convert_value_from_python (result
.get ());
207 if (PyErr_Occurred ())
213 CATCH (except
, RETURN_MASK_ALL
)
218 return result
.release ();
221 /* Return the display hint for the object printer, PRINTER. Return
222 NULL if there is no display_hint method, or if the method did not
223 return a string. On error, print stack trace and return NULL. On
224 success, return an xmalloc()d string. */
225 gdb::unique_xmalloc_ptr
<char>
226 gdbpy_get_display_hint (PyObject
*printer
)
228 gdb::unique_xmalloc_ptr
<char> result
;
230 if (! PyObject_HasAttr (printer
, gdbpy_display_hint_cst
))
233 gdbpy_ref
<> hint (PyObject_CallMethodObjArgs (printer
, gdbpy_display_hint_cst
,
237 if (gdbpy_is_string (hint
.get ()))
239 result
= python_string_to_host_string (hint
.get ());
241 gdbpy_print_stack ();
245 gdbpy_print_stack ();
250 /* A wrapper for gdbpy_print_stack that ignores MemoryError. */
253 print_stack_unless_memory_error (struct ui_file
*stream
)
255 if (PyErr_ExceptionMatches (gdbpy_gdb_memory_error
))
257 PyObject
*type
, *value
, *trace
;
259 PyErr_Fetch (&type
, &value
, &trace
);
261 gdbpy_ref
<> type_ref (type
);
262 gdbpy_ref
<> value_ref (value
);
263 gdbpy_ref
<> trace_ref (trace
);
265 gdb::unique_xmalloc_ptr
<char>
266 msg (gdbpy_exception_to_string (type
, value
));
268 if (msg
== NULL
|| *msg
== '\0')
269 fprintf_filtered (stream
, _("<error reading variable>"));
271 fprintf_filtered (stream
, _("<error reading variable: %s>"),
275 gdbpy_print_stack ();
278 /* Helper for gdbpy_apply_val_pretty_printer which calls to_string and
279 formats the result. */
281 static enum string_repr_result
282 print_string_repr (PyObject
*printer
, const char *hint
,
283 struct ui_file
*stream
, int recurse
,
284 const struct value_print_options
*options
,
285 const struct language_defn
*language
,
286 struct gdbarch
*gdbarch
)
288 struct value
*replacement
= NULL
;
289 enum string_repr_result result
= string_repr_ok
;
291 gdbpy_ref
<> py_str (pretty_print_one_value (printer
, &replacement
));
294 if (py_str
== Py_None
)
295 result
= string_repr_none
;
296 else if (gdbpy_is_lazy_string (py_str
.get ()))
301 gdb::unique_xmalloc_ptr
<char> encoding
;
302 struct value_print_options local_opts
= *options
;
304 gdbpy_extract_lazy_string (py_str
.get (), &addr
, &type
,
307 local_opts
.addressprint
= 0;
308 val_print_string (type
, encoding
.get (), addr
, (int) length
,
309 stream
, &local_opts
);
314 (python_string_to_target_python_string (py_str
.get ()));
322 output
= PyBytes_AS_STRING (string
.get ());
323 length
= PyBytes_GET_SIZE (string
.get ());
325 output
= PyString_AsString (string
.get ());
326 length
= PyString_Size (string
.get ());
328 type
= builtin_type (gdbarch
)->builtin_char
;
330 if (hint
&& !strcmp (hint
, "string"))
331 LA_PRINT_STRING (stream
, type
, (gdb_byte
*) output
,
332 length
, NULL
, 0, options
);
334 fputs_filtered (output
, stream
);
338 result
= string_repr_error
;
339 print_stack_unless_memory_error (stream
);
343 else if (replacement
)
345 struct value_print_options opts
= *options
;
347 opts
.addressprint
= 0;
348 common_val_print (replacement
, stream
, recurse
, &opts
, language
);
352 result
= string_repr_error
;
353 print_stack_unless_memory_error (stream
);
361 /* Create a dummy PyFrameObject, needed to work around
362 a Python-2.4 bug with generators. */
363 class dummy_python_frame
367 dummy_python_frame ();
369 ~dummy_python_frame ()
372 m_tstate
->frame
= m_saved_frame
;
383 PyFrameObject
*m_saved_frame
;
385 PyThreadState
*m_tstate
;
388 dummy_python_frame::dummy_python_frame ()
390 m_saved_frame (NULL
),
394 PyFrameObject
*frame
;
396 gdbpy_ref
<> empty_string (PyString_FromString (""));
397 if (empty_string
== NULL
)
400 gdbpy_ref
<> null_tuple (PyTuple_New (0));
401 if (null_tuple
== NULL
)
404 code
= PyCode_New (0, /* argcount */
408 empty_string
.get (), /* code */
409 null_tuple
.get (), /* consts */
410 null_tuple
.get (), /* names */
411 null_tuple
.get (), /* varnames */
412 #if PYTHON_API_VERSION >= 1010
413 null_tuple
.get (), /* freevars */
414 null_tuple
.get (), /* cellvars */
416 empty_string
.get (), /* filename */
417 empty_string
.get (), /* name */
419 empty_string
.get () /* lnotab */
423 gdbpy_ref
<> code_holder ((PyObject
*) code
);
425 gdbpy_ref
<> globals (PyDict_New ());
429 m_tstate
= PyThreadState_GET ();
430 frame
= PyFrame_New (m_tstate
, code
, globals
.get (), NULL
);
434 m_frame
.reset ((PyObject
*) frame
);
435 m_tstate
->frame
= frame
;
436 m_saved_frame
= frame
->f_back
;
441 /* Helper for gdbpy_apply_val_pretty_printer that formats children of the
442 printer, if any exist. If is_py_none is true, then nothing has
443 been printed by to_string, and format output accordingly. */
445 print_children (PyObject
*printer
, const char *hint
,
446 struct ui_file
*stream
, int recurse
,
447 const struct value_print_options
*options
,
448 const struct language_defn
*language
,
451 int is_map
, is_array
, done_flag
, pretty
;
454 if (! PyObject_HasAttr (printer
, gdbpy_children_cst
))
457 /* If we are printing a map or an array, we want some special
459 is_map
= hint
&& ! strcmp (hint
, "map");
460 is_array
= hint
&& ! strcmp (hint
, "array");
462 gdbpy_ref
<> children (PyObject_CallMethodObjArgs (printer
, gdbpy_children_cst
,
464 if (children
== NULL
)
466 print_stack_unless_memory_error (stream
);
470 gdbpy_ref
<> iter (PyObject_GetIter (children
.get ()));
473 print_stack_unless_memory_error (stream
);
477 /* Use the prettyformat_arrays option if we are printing an array,
478 and the pretty option otherwise. */
480 pretty
= options
->prettyformat_arrays
;
483 if (options
->prettyformat
== Val_prettyformat
)
486 pretty
= options
->prettyformat_structs
;
489 /* Manufacture a dummy Python frame to work around Python 2.4 bug,
490 where it insists on having a non-NULL tstate->frame when
491 a generator is called. */
493 dummy_python_frame frame
;
496 gdbpy_print_stack ();
502 for (i
= 0; i
< options
->print_max
; ++i
)
507 gdbpy_ref
<> item (PyIter_Next (iter
.get ()));
510 if (PyErr_Occurred ())
511 print_stack_unless_memory_error (stream
);
512 /* Set a flag so we can know whether we printed all the
513 available elements. */
519 if (! PyTuple_Check (item
.get ()) || PyTuple_Size (item
.get ()) != 2)
521 PyErr_SetString (PyExc_TypeError
,
522 _("Result of children iterator not a tuple"
523 " of two elements."));
524 gdbpy_print_stack ();
527 if (! PyArg_ParseTuple (item
.get (), "sO", &name
, &py_v
))
529 /* The user won't necessarily get a stack trace here, so provide
531 if (gdbpy_print_python_errors_p ())
532 fprintf_unfiltered (gdb_stderr
,
533 _("Bad result from children iterator.\n"));
534 gdbpy_print_stack ();
538 /* Print initial "{". For other elements, there are three
540 1. Maps. Print a "," after each value element.
541 2. Arrays. Always print a ",".
542 3. Other. Always print a ",". */
546 fputs_filtered ("{", stream
);
548 fputs_filtered (" = {", stream
);
551 else if (! is_map
|| i
% 2 == 0)
552 fputs_filtered (pretty
? "," : ", ", stream
);
554 /* In summary mode, we just want to print "= {...}" if there is
556 if (options
->summary
)
558 /* This increment tricks the post-loop logic to print what
566 if (! is_map
|| i
% 2 == 0)
570 fputs_filtered ("\n", stream
);
571 print_spaces_filtered (2 + 2 * recurse
, stream
);
574 wrap_here (n_spaces (2 + 2 *recurse
));
577 if (is_map
&& i
% 2 == 0)
578 fputs_filtered ("[", stream
);
581 /* We print the index, not whatever the child method
582 returned as the name. */
583 if (options
->print_array_indexes
)
584 fprintf_filtered (stream
, "[%d] = ", i
);
588 fputs_filtered (name
, stream
);
589 fputs_filtered (" = ", stream
);
592 if (gdbpy_is_lazy_string (py_v
))
597 gdb::unique_xmalloc_ptr
<char> encoding
;
598 struct value_print_options local_opts
= *options
;
600 gdbpy_extract_lazy_string (py_v
, &addr
, &type
, &length
, &encoding
);
602 local_opts
.addressprint
= 0;
603 val_print_string (type
, encoding
.get (), addr
, (int) length
, stream
,
606 else if (gdbpy_is_string (py_v
))
608 gdb::unique_xmalloc_ptr
<char> output
;
610 output
= python_string_to_host_string (py_v
);
612 gdbpy_print_stack ();
614 fputs_filtered (output
.get (), stream
);
618 struct value
*value
= convert_value_from_python (py_v
);
622 gdbpy_print_stack ();
623 error (_("Error while executing Python code."));
626 common_val_print (value
, stream
, recurse
+ 1, options
, language
);
629 if (is_map
&& i
% 2 == 0)
630 fputs_filtered ("] = ", stream
);
639 fputs_filtered ("\n", stream
);
640 print_spaces_filtered (2 + 2 * recurse
, stream
);
642 fputs_filtered ("...", stream
);
646 fputs_filtered ("\n", stream
);
647 print_spaces_filtered (2 * recurse
, stream
);
649 fputs_filtered ("}", stream
);
654 gdbpy_apply_val_pretty_printer (const struct extension_language_defn
*extlang
,
656 LONGEST embedded_offset
, CORE_ADDR address
,
657 struct ui_file
*stream
, int recurse
,
659 const struct value_print_options
*options
,
660 const struct language_defn
*language
)
662 struct gdbarch
*gdbarch
= get_type_arch (type
);
664 enum string_repr_result print_result
;
665 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
667 /* No pretty-printer support for unavailable values. */
668 if (!value_bytes_available (val
, embedded_offset
, TYPE_LENGTH (type
)))
669 return EXT_LANG_RC_NOP
;
671 if (!gdb_python_initialized
)
672 return EXT_LANG_RC_NOP
;
674 gdbpy_enter
enter_py (gdbarch
, language
);
676 /* Instantiate the printer. */
677 value
= value_from_component (val
, type
, embedded_offset
);
679 gdbpy_ref
<> val_obj (value_to_value_object (value
));
682 print_stack_unless_memory_error (stream
);
683 return EXT_LANG_RC_ERROR
;
686 /* Find the constructor. */
687 gdbpy_ref
<> printer (find_pretty_printer (val_obj
.get ()));
690 print_stack_unless_memory_error (stream
);
691 return EXT_LANG_RC_ERROR
;
694 if (printer
== Py_None
)
695 return EXT_LANG_RC_NOP
;
697 /* If we are printing a map, we want some special formatting. */
698 gdb::unique_xmalloc_ptr
<char> hint (gdbpy_get_display_hint (printer
.get ()));
700 /* Print the section */
701 print_result
= print_string_repr (printer
.get (), hint
.get (), stream
,
702 recurse
, options
, language
, gdbarch
);
703 if (print_result
!= string_repr_error
)
704 print_children (printer
.get (), hint
.get (), stream
, recurse
, options
,
705 language
, print_result
== string_repr_none
);
707 if (PyErr_Occurred ())
708 print_stack_unless_memory_error (stream
);
709 return EXT_LANG_RC_OK
;
713 /* Apply a pretty-printer for the varobj code. PRINTER_OBJ is the
714 print object. It must have a 'to_string' method (but this is
715 checked by varobj, not here) which takes no arguments and
716 returns a string. The printer will return a value and in the case
717 of a Python string being returned, this function will return a
718 PyObject containing the string. For any other type, *REPLACEMENT is
719 set to the replacement value and this function returns NULL. On
720 error, *REPLACEMENT is set to NULL and this function also returns
723 apply_varobj_pretty_printer (PyObject
*printer_obj
,
724 struct value
**replacement
,
725 struct ui_file
*stream
)
727 PyObject
*py_str
= NULL
;
730 py_str
= pretty_print_one_value (printer_obj
, replacement
);
732 if (*replacement
== NULL
&& py_str
== NULL
)
733 print_stack_unless_memory_error (stream
);
738 /* Find a pretty-printer object for the varobj module. Returns a new
739 reference to the object if successful; returns NULL if not. VALUE
740 is the value for which a printer tests to determine if it
741 can pretty-print the value. */
743 gdbpy_get_varobj_pretty_printer (struct value
*value
)
747 value
= value_copy (value
);
749 CATCH (except
, RETURN_MASK_ALL
)
751 GDB_PY_HANDLE_EXCEPTION (except
);
755 gdbpy_ref
<> val_obj (value_to_value_object (value
));
759 return find_pretty_printer (val_obj
.get ());
762 /* A Python function which wraps find_pretty_printer and instantiates
763 the resulting class. This accepts a Value argument and returns a
764 pretty printer instance, or None. This function is useful as an
765 argument to the MI command -var-set-visualizer. */
767 gdbpy_default_visualizer (PyObject
*self
, PyObject
*args
)
773 if (! PyArg_ParseTuple (args
, "O", &val_obj
))
775 value
= value_object_to_value (val_obj
);
778 PyErr_SetString (PyExc_TypeError
,
779 _("Argument must be a gdb.Value."));
783 cons
= find_pretty_printer (val_obj
);