1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>DB - perldoc.perl.org</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en-gb">
<link rel="search" type="application/opensearchdescription+xml" title="Search perldoc.perl.org" href="/static/search.xml"/>
<link href="static/css-20100830.css" rel="stylesheet" rev="stylesheet" type="text/css" media="screen">
<link href="static/exploreperl.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>
<body onLoad="perldoc.startup();" onPageShow="if (event.persisted) perldoc.startup();">
<div id="page">
<div id="header">
<div id="homepage_link">
<a href="index.html"></a>
</div>
<div id="strapline">
Perl Programming Documentation
</div>
<div id="download_link" class="download">
<a href="http://www.perl.org/get.html">Download Perl</a>
</div>
<div id="explore_link" class="download">
<a id="explore_anchor" href="#">Explore</a>
</div>
</div>
<div id="body">
<div id="left_column">
<div class="side_group">
<div class="side_panel doc_panel">
<p>Manual</p>
<ul>
<li><a href="index-overview.html">Overview</a>
<li><a href="index-tutorials.html">Tutorials</a>
<li><a href="index-faq.html">FAQs</a>
<li><a href="index-history.html">History / Changes</a>
<li><a href="index-licence.html">License</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Reference</p>
<ul>
<li><a href="index-language.html">Language</a>
<li><a href="index-functions.html">Functions</a>
<li><a href="perlop.html">Operators</a>
<li><a href="perlvar.html">Special Variables</a>
<li><a href="index-pragmas.html">Pragmas</a>
<li><a href="index-utilities.html">Utilities</a>
<li><a href="index-internals.html">Internals</a>
<li><a href="index-platforms.html">Platform Specific</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Modules</p>
<ul>
<li>
<a href="index-modules-A.html">A</a>
•
<a href="index-modules-B.html">B</a>
•
<a href="index-modules-C.html">C</a>
•
<a href="index-modules-D.html">D</a>
•
<a href="index-modules-E.html">E</a>
<li>
<a href="index-modules-F.html">F</a>
•
<a href="index-modules-G.html">G</a>
•
<a href="index-modules-H.html">H</a>
•
<a href="index-modules-I.html">I</a>
•
<a href="index-modules-L.html">L</a>
<li>
<a href="index-modules-M.html">M</a>
•
<a href="index-modules-N.html">N</a>
•
<a href="index-modules-O.html">O</a>
•
<a href="index-modules-P.html">P</a>
•
<a href="index-modules-S.html">S</a>
<li>
<a href="index-modules-T.html">T</a>
•
<a href="index-modules-U.html">U</a>
•
<a href="index-modules-X.html">X</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Tools</p>
<ul>
<li><a href="preferences.html">Preferences</a>
</ul>
</div>
</div>
</div>
<div id="centre_column">
<div id="content_header">
<div id="title_bar">
<div id="page_name">
<h1>DB</h1>
</div>
<div id="perl_version">
Perl 5 version 14.0 documentation
</div>
<div class="page_links" id="page_links_top">
<a href="#" onClick="toolbar.goToTop();return false;">Go to top</a>
</div>
<div class="page_links" id="page_links_bottom">
<a href="#" id="page_index_toggle">Show page index</a> •
<a href="#" id="recent_pages_toggle">Show recent pages</a>
</div>
<div id="search_form">
<form action="search.html" method="GET" id="search">
<input type="text" name="q" id="search_box" alt="Search">
</form>
</div>
</div>
<div id="breadcrumbs">
<a href="index.html">Home</a> >
<a href="index-modules-D.html">Core modules (D)</a> >
DB
</div>
</div>
<div id="content_body">
<!--[if lt IE 7]>
<div class="noscript">
<p>
<strong>It looks like you're using Internet Explorer 6. This is a very old
browser which does not offer full support for modern websites.</strong>
</p>
<p>
Unfortunately this means that this website will not work on
your computer.
</p>
<p>
Don't miss out though! To view the site (and get a better experience from
many other websites), simply upgrade to
<a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet
Explorer 8</a>
or download an alternative browser such as
<a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>,
<a href="http://www.apple.com/safari/download/">Safari</a>, or
<a href="http://www.google.co.uk/chrome">Google Chrome</a>.
</p>
<p>
All of these browsers are free. If you're using a PC at work, you may
need to contact your IT administrator.
</p>
</div>
<![endif]-->
<noscript>
<div class="noscript">
<p>
<strong>Please note: Many features of this site require JavaScript. You appear to have JavaScript disabled,
or are running a non-JavaScript capable web browser.</strong>
</p>
<p>
To get the best experience, please enable JavaScript or download a modern web browser such as <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet Explorer 8</a>, <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>, <a href="http://www.apple.com/safari/download/">Safari</a>, or <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
</p>
</div>
</noscript>
<div id="recent_pages" class="hud_container">
<div id="recent_pages_header" class="hud_header">
<div id="recent_pages_close" class="hud_close"><a href="#" onClick="recentPages.hide();return false;"></a></div>
<div id="recent_pages_title" class="hud_title"><span class="hud_span_top">Recently read</span></div>
<div id="recent_pages_topright" class="hud_topright"></div>
</div>
<div id="recent_pages_content" class="hud_content">
</div>
<div id="recent_pages_footer" class="hud_footer">
<div id="recent_pages_bottomleft" class="hud_bottomleft"></div>
<div id="recent_pages_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
<div id="recent_pages_resize" class="hud_resize"></div>
</div>
</div>
<div id="from_search"></div>
<h1>DB</h1>
<!-- -->
<ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Global-Variables">Global Variables</a><li><a href="#API-Methods">API Methods</a><li><a href="#Client-Callback-Methods">Client Callback Methods</a></ul><li><a href="#BUGS">BUGS</a><li><a href="#AUTHOR">AUTHOR</a></ul><a name="NAME"></a><h1>NAME</h1>
<p>DB - programmatic interface to the Perl debugging API</p>
<a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>
<pre class="verbatim"><ol><li> package CLIENT;</li><li> use DB;</li><li> @ISA = qw(DB);</li><li></li><li> # these (inherited) methods can be called by the client</li><li></li><li> CLIENT->register() # register a client package name</li><li> CLIENT->done() # de-register from the debugging API</li><li> CLIENT->skippkg('hide::hide') # ask DB not to stop in this package</li><li> CLIENT->cont([WHERE]) # run some more (until BREAK or another breakpt)</li><li> CLIENT->step() # single step</li><li> CLIENT->next() # step over</li><li> CLIENT->ret() # return from current subroutine</li><li> CLIENT->backtrace() # return the call stack description</li><li> CLIENT->ready() # call when client setup is done</li><li> CLIENT->trace_toggle() # toggle subroutine call trace mode</li><li> CLIENT->subs([SUBS]) # return subroutine information</li><li> CLIENT->files() # return list of all files known to DB</li><li> CLIENT->lines() # return lines in currently loaded file</li><li> CLIENT->loadfile(FILE,LINE) # load a file and let other clients know</li><li> CLIENT->lineevents() # return info on lines with actions</li><li> CLIENT->set_break([WHERE],[COND])</li><li> CLIENT->set_tbreak([WHERE])</li><li> CLIENT->clr_breaks([LIST])</li><li> CLIENT->set_action(WHERE,ACTION)</li><li> CLIENT->clr_actions([LIST])</li><li> CLIENT->evalcode(STRING) # eval STRING in executing code's context</li><li> CLIENT->prestop([STRING]) # execute in code context before stopping</li><li> CLIENT->poststop([STRING])# execute in code context before resuming</li><li></li><li> # These methods will be called at the appropriate times.</li><li> # Stub versions provided do nothing.</li><li> # None of these can block.</li><li></li><li> CLIENT->init() # called when debug API inits itself</li><li> CLIENT->stop(FILE,LINE) # when execution stops</li><li> CLIENT->idle() # while stopped (can be a client event loop)</li><li> CLIENT->cleanup() # just before exit</li><li> CLIENT->output(LIST) # called to print any output that API must show</li></ol></pre><a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p>Perl debug information is frequently required not just by debuggers,
but also by modules that need some "special" information to do their
job properly, like profilers.</p>
<p>This module abstracts and provides all of the hooks into Perl internal
debugging functionality, so that various implementations of Perl debuggers
(or packages that want to simply get at the "privileged" debugging data)
can all benefit from the development of this common code. Currently used
by Swat, the perl/Tk GUI debugger.</p>
<p>Note that multiple "front-ends" can latch into this debugging API
simultaneously. This is intended to facilitate things like
debugging with a command line and GUI at the same time, debugging
debuggers etc. [Sounds nice, but this needs some serious support -- GSAR]</p>
<p>In particular, this API does <b>not</b> provide the following functions:</p>
<ul>
<li>
<p>data display</p>
</li>
<li>
<p>command processing</p>
</li>
<li>
<p>command alias management</p>
</li>
<li>
<p>user interface (tty or graphical)</p>
</li>
</ul>
<p>These are intended to be services performed by the clients of this API.</p>
<p>This module attempts to be squeaky clean w.r.t <code class="inline"><a class="l_k" href="functions/use.html">use</a> <span class="w">strict</span><span class="sc">;</span></code>
and when
warnings are enabled.</p>
<a name="Global-Variables"></a><h2>Global Variables</h2>
<p>The following "public" global names can be read by clients of this API.
Beware that these should be considered "readonly".</p>
<ul>
<li><a name="%24DB%3a%3asub"></a><b>$DB::sub</b>
<p>Name of current executing subroutine.</p>
</li>
<li><a name="%25DB%3a%3asub"></a><b>%DB::sub</b>
<p>The keys of this hash are the names of all the known subroutines. Each value
is an encoded string that has the sprintf(3) format
<code class="inline"><span class="s">(</span><span class="q">"%s:%d-%d"</span><span class="cm">,</span> <span class="w">filename</span><span class="cm">,</span> <span class="w">fromline</span><span class="cm">,</span> <span class="w">toline</span><span class="s">)</span></code>
.</p>
</li>
<li><a name="%24DB%3a%3asingle"></a><b>$DB::single</b>
<p>Single-step flag. Will be true if the API will stop at the next statement.</p>
</li>
<li><a name="%24DB%3a%3asignal"></a><b>$DB::signal</b>
<p>Signal flag. Will be set to a true value if a signal was caught. Clients may
check for this flag to abort time-consuming operations.</p>
</li>
<li><a name="%24DB%3a%3atrace"></a><b>$DB::trace</b>
<p>This flag is set to true if the API is tracing through subroutine calls.</p>
</li>
<li><a name="%40DB%3a%3aargs"></a><b>@DB::args</b>
<p>Contains the arguments of current subroutine, or the <code class="inline"><span class="i">@ARGV</span></code>
array if in the
toplevel context.</p>
</li>
<li><a name="%40DB%3a%3adbline"></a><b>@DB::dbline</b>
<p>List of lines in currently loaded file.</p>
</li>
<li><a name="%25DB%3a%3adbline"></a><b>%DB::dbline</b>
<p>Actions in current file (keys are line numbers). The values are strings that
have the sprintf(3) format <code class="inline"><span class="s">(</span><span class="q">"%s\000%s"</span><span class="cm">,</span> <span class="w">breakcondition</span><span class="cm">,</span> <span class="w">actioncode</span><span class="s">)</span></code>
.</p>
</li>
<li><a name="%24DB%3a%3apackage"></a><b>$DB::package</b>
<p>Package namespace of currently executing code.</p>
</li>
<li><a name="%24DB%3a%3afilename"></a><b>$DB::filename</b>
<p>Currently loaded filename.</p>
</li>
<li><a name="%24DB%3a%3asubname"></a><b>$DB::subname</b>
<p>Fully qualified name of currently executing subroutine.</p>
</li>
<li><a name="%24DB%3a%3alineno"></a><b>$DB::lineno</b>
<p>Line number that will be executed next.</p>
</li>
</ul>
<a name="API-Methods"></a><h2>API Methods</h2>
<p>The following are methods in the DB base class. A client must
access these methods by inheritance (*not* by calling them directly),
since the API keeps track of clients through the inheritance
mechanism.</p>
<ul>
<li><a name="CLIENT-%3eregister()"></a><b>CLIENT->register()</b>
<p>register a client object/package</p>
</li>
<li><a name="CLIENT-%3eevalcode(STRING)"></a><b>CLIENT->evalcode(STRING)</b>
<p>eval STRING in executing code context</p>
</li>
<li><a name="CLIENT-%3eskippkg('D%3a%3ahide')"></a><b>CLIENT->skippkg('D::hide')</b>
<p>ask DB not to stop in these packages</p>
</li>
<li><a name="CLIENT-%3erun()"></a><b>CLIENT->run()</b>
<p>run some more (until a breakpt is reached)</p>
</li>
<li><a name="CLIENT-%3estep()"></a><b>CLIENT->step()</b>
<p>single step</p>
</li>
<li><a name="CLIENT-%3enext()"></a><b>CLIENT->next()</b>
<p>step over</p>
</li>
<li><a name="CLIENT-%3edone()"></a><b>CLIENT->done()</b>
<p>de-register from the debugging API</p>
</li>
</ul>
<a name="Client-Callback-Methods"></a><h2>Client Callback Methods</h2>
<p>The following "virtual" methods can be defined by the client. They will
be called by the API at appropriate points. Note that unless specified
otherwise, the debug API only defines empty, non-functional default versions
of these methods.</p>
<ul>
<li><a name="CLIENT-%3einit()"></a><b>CLIENT->init()</b>
<p>Called after debug API inits itself.</p>
</li>
<li><a name="CLIENT-%3eprestop(%5bSTRING%5d)"></a><b>CLIENT->prestop([STRING])</b>
<p>Usually inherited from DB package. If no arguments are passed,
returns the prestop action string.</p>
</li>
<li><a name="CLIENT-%3estop()"></a><b>CLIENT->stop()</b>
<p>Called when execution stops (w/ args file, line).</p>
</li>
<li><a name="CLIENT-%3eidle()"></a><b>CLIENT->idle()</b>
<p>Called while stopped (can be a client event loop).</p>
</li>
<li><a name="CLIENT-%3epoststop(%5bSTRING%5d)"></a><b>CLIENT->poststop([STRING])</b>
<p>Usually inherited from DB package. If no arguments are passed,
returns the poststop action string.</p>
</li>
<li><a name="CLIENT-%3eevalcode(STRING)"></a><b>CLIENT->evalcode(STRING)</b>
<p>Usually inherited from DB package. Ask for a STRING to be <code class="inline"><a class="l_k" href="functions/eval.html">eval</a></code>-ed
in executing code context.</p>
</li>
<li><a name="CLIENT-%3ecleanup()"></a><b>CLIENT->cleanup()</b>
<p>Called just before exit.</p>
</li>
<li><a name="CLIENT-%3eoutput(LIST)"></a><b>CLIENT->output(LIST)</b>
<p>Called when API must show a message (warnings, errors etc.).</p>
</li>
</ul>
<a name="BUGS"></a><h1>BUGS</h1>
<p>The interface defined by this module is missing some of the later additions
to perl's debugging functionality. As such, this interface should be considered
highly experimental and subject to change.</p>
<a name="AUTHOR"></a><h1>AUTHOR</h1>
<p>Gurusamy Sarathy gsar@activestate.com</p>
<p>This code heavily adapted from an early version of perl5db.pl attributable
to Larry Wall and the Perl Porters.</p>
<div id="page_index" class="hud_container">
<div id="page_index_header" class="hud_header">
<div id="page_index_close" class="hud_close"><a href="#" onClick="pageIndex.hide();return false;"></a></div>
<div id="page_index_title" class="hud_title"><span class="hud_span_top">Page index</span></div>
<div id="page_index_topright" class="hud_topright"></div>
</div>
<div id="page_index_content" class="hud_content">
<ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Global-Variables">Global Variables</a><li><a href="#API-Methods">API Methods</a><li><a href="#Client-Callback-Methods">Client Callback Methods</a></ul><li><a href="#BUGS">BUGS</a><li><a href="#AUTHOR">AUTHOR</a></ul>
</div>
<div id="page_index_footer" class="hud_footer">
<div id="page_index_bottomleft" class="hud_bottomleft"></div>
<div id="page_index_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
<div id="page_index_resize" class="hud_resize"></div>
</div>
</div>
</div>
<div id="content_footer">
</div>
</div>
<div class="clear"></div>
</div>
<div id="footer">
<div id="footer_content">
<div id="footer_strapline">
perldoc.perl.org - Official documentation for the Perl programming language
</div>
<div id="footer_links">
<div id="address">
<p class="name">Contact details</p>
<p class="address">
Site maintained by <a href="http://perl.jonallen.info">Jon Allen (JJ)</a><br>
See the <a href="http://perl.jonallen.info/projects/perldoc">project page</a> for more details
</p>
<p class="contact">
Documentation maintained by the <a href="http://lists.cpan.org/showlist.cgi?name=perl5-porters">Perl 5 Porters</a>
</p>
</div>
<ul class="f1">
<li>Manual
<ul class="f2">
<li><a href="index-overview.html">Overview</a>
<li><a href="index-tutorials.html">Tutorials</a>
<li><a href="index-faq.html">FAQs</a>
<li><a href="index-history.html">Changes</a>
</ul>
<li>Reference
<ul class="f2">
<li><a href="index-language.html">Language</a>
<li><a href="index-functions.html">Functions</a>
<li><a href="perlop.html">Operators</a>
<li><a href="perlvar.html">Variables</a>
</ul>
<li>Modules
<ul class="f2">
<li><a href="index-modules-A.html">Modules</a>
<li><a href="index-pragmas.html">Pragmas</a>
<li><a href="index-utilities.html">Utilities</a>
</ul>
<li>Misc
<ul class="f2">
<li><a href="index-licence.html">License</a>
<li><a href="index-internals.html">Internals</a>
<li><a href="index-platforms.html">Platforms</a>
</ul> </ul>
<div class="clear"></div>
</div>
</div>
<div id="footer_end">
</div>
</div>
</div>
<script language="JavaScript" type="text/javascript" src="static/exploreperl.js"></script>
<script language="JavaScript" src="static/combined-20100403.js" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
perldoc.setPath(0);
perldoc.pageName = 'DB';
perldoc.pageAddress = 'DB.html';
perldoc.contentPage = 1;
explorePerl.render();
explorePerl.addEvents('explore_anchor');
</script>
</body>
</html>
|
