Pretty_002dPrinter-Introduction.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  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 5.1, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <title>Debugging with GDB: Pretty-Printer Introduction</title>
  16. <meta name="description" content="Debugging with GDB: Pretty-Printer Introduction">
  17. <meta name="keywords" content="Debugging with GDB: Pretty-Printer Introduction">
  18. <meta name="resource-type" content="document">
  19. <meta name="distribution" content="global">
  20. <meta name="Generator" content="makeinfo">
  21. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  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="Pretty-Printing.html#Pretty-Printing" rel="up" title="Pretty Printing">
  26. <link href="Pretty_002dPrinter-Example.html#Pretty_002dPrinter-Example" rel="next" title="Pretty-Printer Example">
  27. <link href="Pretty-Printing.html#Pretty-Printing" rel="previous" title="Pretty Printing">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.smallquotation {font-size: smaller}
  32. div.display {margin-left: 3.2em}
  33. div.example {margin-left: 3.2em}
  34. div.indentedblock {margin-left: 3.2em}
  35. div.lisp {margin-left: 3.2em}
  36. div.smalldisplay {margin-left: 3.2em}
  37. div.smallexample {margin-left: 3.2em}
  38. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  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.nocodebreak {white-space:nowrap}
  50. span.nolinebreak {white-space:nowrap}
  51. span.roman {font-family:serif; font-weight:normal}
  52. span.sansserif {font-family:sans-serif; font-weight:normal}
  53. ul.no-bullet {list-style: none}
  54. -->
  55. </style>
  56. </head>
  57. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  58. <a name="Pretty_002dPrinter-Introduction"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Pretty_002dPrinter-Example.html#Pretty_002dPrinter-Example" accesskey="n" rel="next">Pretty-Printer Example</a>, Up: <a href="Pretty-Printing.html#Pretty-Printing" accesskey="u" rel="up">Pretty Printing</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>
  62. </div>
  63. <hr>
  64. <a name="Pretty_002dPrinter-Introduction-1"></a>
  65. <h4 class="subsection">10.9.1 Pretty-Printer Introduction</h4>
  66. <p>When <small>GDB</small> prints a value, it first sees if there is a pretty-printer
  67. registered for the value. If there is then <small>GDB</small> invokes the
  68. pretty-printer to print the value. Otherwise the value is printed normally.
  69. </p>
  70. <p>Pretty-printers are normally named. This makes them easy to manage.
  71. The &lsquo;<samp>info pretty-printer</samp>&rsquo; command will list all the installed
  72. pretty-printers with their names.
  73. If a pretty-printer can handle multiple data types, then its
  74. <em>subprinters</em> are the printers for the individual data types.
  75. Each such subprinter has its own name.
  76. The format of the name is <var>printer-name</var>;<var>subprinter-name</var>.
  77. </p>
  78. <p>Pretty-printers are installed by <em>registering</em> them with <small>GDB</small>.
  79. Typically they are automatically loaded and registered when the corresponding
  80. debug information is loaded, thus making them available without having to
  81. do anything special.
  82. </p>
  83. <p>There are three places where a pretty-printer can be registered.
  84. </p>
  85. <ul>
  86. <li> Pretty-printers registered globally are available when debugging
  87. all inferiors.
  88. </li><li> Pretty-printers registered with a program space are available only
  89. when debugging that program.
  90. See <a href="Progspaces-In-Python.html#Progspaces-In-Python">Progspaces In Python</a>, for more details on program spaces in Python.
  91. </li><li> Pretty-printers registered with an objfile are loaded and unloaded
  92. with the corresponding objfile (e.g., shared library).
  93. See <a href="Objfiles-In-Python.html#Objfiles-In-Python">Objfiles In Python</a>, for more details on objfiles in Python.
  94. </li></ul>
  95. <p>See <a href="Selecting-Pretty_002dPrinters.html#Selecting-Pretty_002dPrinters">Selecting Pretty-Printers</a>, for further information on how
  96. pretty-printers are selected,
  97. </p>
  98. <p>See <a href="Writing-a-Pretty_002dPrinter.html#Writing-a-Pretty_002dPrinter">Writing a Pretty-Printer</a>, for implementing pretty printers
  99. for new types.
  100. </p>
  101. </body>
  102. </html>