Finish-Breakpoints-in-Python.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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: Finish Breakpoints in Python</title>
  16. <meta name="description" content="Debugging with GDB: Finish Breakpoints in Python">
  17. <meta name="keywords" content="Debugging with GDB: Finish Breakpoints in Python">
  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="Python-API.html#Python-API" rel="up" title="Python API">
  26. <link href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python" rel="next" title="Lazy Strings In Python">
  27. <link href="Breakpoints-In-Python.html#Breakpoints-In-Python" rel="previous" title="Breakpoints In Python">
  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="Finish-Breakpoints-in-Python"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python" accesskey="n" rel="next">Lazy Strings In Python</a>, Previous: <a href="Breakpoints-In-Python.html#Breakpoints-In-Python" accesskey="p" rel="previous">Breakpoints In Python</a>, Up: <a href="Python-API.html#Python-API" accesskey="u" rel="up">Python API</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="Finish-Breakpoints"></a>
  65. <h4 class="subsubsection">23.2.2.31 Finish Breakpoints</h4>
  66. <a name="index-python-finish-breakpoints"></a>
  67. <a name="index-gdb_002eFinishBreakpoint"></a>
  68. <p>A finish breakpoint is a temporary breakpoint set at the return address of
  69. a frame, based on the <code>finish</code> command. <code>gdb.FinishBreakpoint</code>
  70. extends <code>gdb.Breakpoint</code>. The underlying breakpoint will be disabled
  71. and deleted when the execution will run out of the breakpoint scope (i.e.
  72. <code>Breakpoint.stop</code> or <code>FinishBreakpoint.out_of_scope</code> triggered).
  73. Finish breakpoints are thread specific and must be create with the right
  74. thread selected.
  75. </p>
  76. <dl>
  77. <dt><a name="index-FinishBreakpoint_002e_005f_005finit_005f_005f"></a>Function: <strong>FinishBreakpoint.__init__</strong> <em>(<span class="roman">[</span>frame<span class="roman">]</span> <span class="roman">[</span>, internal<span class="roman">]</span>)</em></dt>
  78. <dd><p>Create a finish breakpoint at the return address of the <code>gdb.Frame</code>
  79. object <var>frame</var>. If <var>frame</var> is not provided, this defaults to the
  80. newest frame. The optional <var>internal</var> argument allows the breakpoint to
  81. become invisible to the user. See <a href="Breakpoints-In-Python.html#Breakpoints-In-Python">Breakpoints In Python</a>, for further
  82. details about this argument.
  83. </p></dd></dl>
  84. <dl>
  85. <dt><a name="index-FinishBreakpoint_002eout_005fof_005fscope"></a>Function: <strong>FinishBreakpoint.out_of_scope</strong> <em>(self)</em></dt>
  86. <dd><p>In some circumstances (e.g. <code>longjmp</code>, C<tt>++</tt> exceptions, <small>GDB</small>
  87. <code>return</code> command, &hellip;), a function may not properly terminate, and
  88. thus never hit the finish breakpoint. When <small>GDB</small> notices such a
  89. situation, the <code>out_of_scope</code> callback will be triggered.
  90. </p>
  91. <p>You may want to sub-class <code>gdb.FinishBreakpoint</code> and override this
  92. method:
  93. </p>
  94. <div class="smallexample">
  95. <pre class="smallexample">class MyFinishBreakpoint (gdb.FinishBreakpoint)
  96. def stop (self):
  97. print &quot;normal finish&quot;
  98. return True
  99. def out_of_scope ():
  100. print &quot;abnormal finish&quot;
  101. </pre></div>
  102. </dd></dl>
  103. <dl>
  104. <dt><a name="index-FinishBreakpoint_002ereturn_005fvalue"></a>Variable: <strong>FinishBreakpoint.return_value</strong></dt>
  105. <dd><p>When <small>GDB</small> is stopped at a finish breakpoint and the frame
  106. used to build the <code>gdb.FinishBreakpoint</code> object had debug symbols, this
  107. attribute will contain a <code>gdb.Value</code> object corresponding to the return
  108. value of the function. The value will be <code>None</code> if the function return
  109. type is <code>void</code> or if the return value was not computable. This attribute
  110. is not writable.
  111. </p></dd></dl>
  112. <hr>
  113. <div class="header">
  114. <p>
  115. Next: <a href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python" accesskey="n" rel="next">Lazy Strings In Python</a>, Previous: <a href="Breakpoints-In-Python.html#Breakpoints-In-Python" accesskey="p" rel="previous">Breakpoints In Python</a>, Up: <a href="Python-API.html#Python-API" accesskey="u" rel="up">Python API</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>
  116. </div>
  117. </body>
  118. </html>