You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

115 lines
5.0KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Free Software" and "Free Software Needs
  8. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"
  9. and with the Back-Cover Texts as in (a) below.
  10. (a) The FSF's Back-Cover Text is: "You are free to copy and modify
  11. this GNU Manual. Buying copies from GNU Press supports the FSF in
  12. developing GNU and promoting software freedom." -->
  13. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  16. <title>gdb.printing (Debugging with GDB)</title>
  17. <meta name="description" content="gdb.printing (Debugging with GDB)">
  18. <meta name="keywords" content="gdb.printing (Debugging with GDB)">
  19. <meta name="resource-type" content="document">
  20. <meta name="distribution" content="global">
  21. <meta name="Generator" content="makeinfo">
  22. <link href="index.html#Top" rel="start" title="Top">
  23. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
  24. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  25. <link href="Python-modules.html#Python-modules" rel="up" title="Python modules">
  26. <link href="gdb_002etypes.html#gdb_002etypes" rel="next" title="gdb.types">
  27. <link href="Python-modules.html#Python-modules" rel="prev" title="Python modules">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.indentedblock {margin-right: 0em}
  32. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  33. blockquote.smallquotation {font-size: smaller}
  34. div.display {margin-left: 3.2em}
  35. div.example {margin-left: 3.2em}
  36. div.lisp {margin-left: 3.2em}
  37. div.smalldisplay {margin-left: 3.2em}
  38. div.smallexample {margin-left: 3.2em}
  39. div.smalllisp {margin-left: 3.2em}
  40. kbd {font-style: oblique}
  41. pre.display {font-family: inherit}
  42. pre.format {font-family: inherit}
  43. pre.menu-comment {font-family: serif}
  44. pre.menu-preformatted {font-family: serif}
  45. pre.smalldisplay {font-family: inherit; font-size: smaller}
  46. pre.smallexample {font-size: smaller}
  47. pre.smallformat {font-family: inherit; font-size: smaller}
  48. pre.smalllisp {font-size: smaller}
  49. span.nolinebreak {white-space: nowrap}
  50. span.roman {font-family: initial; font-weight: normal}
  51. span.sansserif {font-family: sans-serif; font-weight: normal}
  52. ul.no-bullet {list-style: none}
  53. -->
  54. </style>
  55. </head>
  56. <body lang="en">
  57. <a name="gdb_002eprinting"></a>
  58. <div class="header">
  59. <p>
  60. Next: <a href="gdb_002etypes.html#gdb_002etypes" accesskey="n" rel="next">gdb.types</a>, Up: <a href="Python-modules.html#Python-modules" accesskey="u" rel="up">Python modules</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  61. </div>
  62. <hr>
  63. <a name="gdb_002eprinting-1"></a>
  64. <h4 class="subsubsection">23.2.4.1 gdb.printing</h4>
  65. <a name="index-gdb_002eprinting"></a>
  66. <p>This module provides a collection of utilities for working with
  67. pretty-printers.
  68. </p>
  69. <dl compact="compact">
  70. <dt><code>PrettyPrinter (<var>name</var>, <var>subprinters</var>=None)</code></dt>
  71. <dd><p>This class specifies the API that makes &lsquo;<samp>info pretty-printer</samp>&rsquo;,
  72. &lsquo;<samp>enable pretty-printer</samp>&rsquo; and &lsquo;<samp>disable pretty-printer</samp>&rsquo; work.
  73. Pretty-printers should generally inherit from this class.
  74. </p>
  75. </dd>
  76. <dt><code>SubPrettyPrinter (<var>name</var>)</code></dt>
  77. <dd><p>For printers that handle multiple types, this class specifies the
  78. corresponding API for the subprinters.
  79. </p>
  80. </dd>
  81. <dt><code>RegexpCollectionPrettyPrinter (<var>name</var>)</code></dt>
  82. <dd><p>Utility class for handling multiple printers, all recognized via
  83. regular expressions.
  84. See <a href="Writing-a-Pretty_002dPrinter.html#Writing-a-Pretty_002dPrinter">Writing a Pretty-Printer</a>, for an example.
  85. </p>
  86. </dd>
  87. <dt><code>FlagEnumerationPrinter (<var>name</var>)</code></dt>
  88. <dd><p>A pretty-printer which handles printing of <code>enum</code> values. Unlike
  89. <small>GDB</small>&rsquo;s built-in <code>enum</code> printing, this printer attempts to
  90. work properly when there is some overlap between the enumeration
  91. constants. The argument <var>name</var> is the name of the printer and
  92. also the name of the <code>enum</code> type to look up.
  93. </p>
  94. </dd>
  95. <dt><code>register_pretty_printer (<var>obj</var>, <var>printer</var>, <var>replace</var>=False)</code></dt>
  96. <dd><p>Register <var>printer</var> with the pretty-printer list of <var>obj</var>.
  97. If <var>replace</var> is <code>True</code> then any existing copy of the printer
  98. is replaced. Otherwise a <code>RuntimeError</code> exception is raised
  99. if a printer with the same name already exists.
  100. </p></dd>
  101. </dl>
  102. </body>
  103. </html>