Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) Standard preamble: ========================================================================
NAMEDB - programmatic interface to the Perl debugging API
package CLIENT; use DB; @ISA = qw(DB); # these (inherited) methods can be called by the client CLIENT->register() # register a client package name CLIENT->done() # de-register from the debugging API CLIENT->skippkg('hide::hide') # ask DB not to stop in this package CLIENT->cont([WHERE]) # run some more (until BREAK or # another breakpointt) CLIENT->step() # single step CLIENT->next() # step over CLIENT->ret() # return from current subroutine CLIENT->backtrace() # return the call stack description CLIENT->ready() # call when client setup is done CLIENT->trace_toggle() # toggle subroutine call trace mode CLIENT->subs([SUBS]) # return subroutine information CLIENT->files() # return list of all files known to DB CLIENT->lines() # return lines in currently loaded file CLIENT->loadfile(FILE,LINE) # load a file and let other clients know CLIENT->lineevents() # return info on lines with actions CLIENT->set_break([WHERE],[COND]) CLIENT->set_tbreak([WHERE]) CLIENT->clr_breaks([LIST]) CLIENT->set_action(WHERE,ACTION) CLIENT->clr_actions([LIST]) CLIENT->evalcode(STRING) # eval STRING in executing code's context CLIENT->prestop([STRING]) # execute in code context before stopping CLIENT->poststop([STRING])# execute in code context before resuming # These methods will be called at the appropriate times. # Stub versions provided do nothing. # None of these can block. CLIENT->init() # called when debug API inits itself CLIENT->stop(FILE,LINE) # when execution stops CLIENT->idle() # while stopped (can be a client event loop) CLIENT->cleanup() # just before exit CLIENT->output(LIST) # called to print any output that # the API must show
DESCRIPTIONPerl 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.
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
Note that multiple ``front-ends'' can latch into this debugging
In particular, this
- data display
- command processing
- command alias management
- user interface (tty or graphical)
These are intended to be services performed by the clients of this
This module attempts to be squeaky clean w.r.t "use strict;" and when warnings are enabled.
Global VariablesThe following ``public'' global names can be read by clients of this
- Name of current executing subroutine.
- 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 "("%s:%d-%d", filename, fromline, toline)".
Single-step flag. Will be true if the APIwill stop at the next statement.
- 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.
This flag is set to true if the APIis tracing through subroutine calls.
- Contains the arguments of current subroutine, or the @ARGV array if in the toplevel context.
- List of lines in currently loaded file.
- Actions in current file (keys are line numbers). The values are strings that have the sprintf(3) format "("%s\000%s", breakcondition, actioncode)".
- Package namespace of currently executing code.
- Currently loaded filename.
- Fully qualified name of currently executing subroutine.
- Line number that will be executed next.
The following are methods in the
- register a client object/package
eval STRINGin executing code context
ask DBnot to stop in these packages
- run some more (until a breakpt is reached)
- single step
- step over
de-register from the debugging API
Client Callback MethodsThe following ``virtual'' methods can be defined by the client. They will be called by the
Called after debug APIinits itself.
Usually inherited from DBpackage. If no arguments are passed, returns the prestop action string.
- Called when execution stops (w/ args file, line).
- Called while stopped (can be a client event loop).
Usually inherited from DBpackage. If no arguments are passed, returns the poststop action string.
Usually inherited from DBpackage. Ask for aSTRINGto be "eval"-ed in executing code context.
- Called just before exit.
Called when APImust show a message (warnings, errors etc.).
BUGSThe 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.
AUTHORGurusamy Sarathy firstname.lastname@example.org
This code heavily adapted from an early version of perl5db.pl attributable to Larry Wall and the Perl Porters.