Breakpoints can be set in any m-file function by using the
Set breakpoints for the built-in debugger.
func is the name of a function on the current
already in debug mode the func argument can be omitted and the current
function will be used. Breakpoints at subfunctions are set with the scope
operator ‘>’. For example, If file.m has a subfunction
func2, then a breakpoint in
func2 can be specified by
line is the line number at which to break. If line is not
specified, it defaults to the first executable line in the file
func.m. Multiple lines can be specified in a single command; when
function syntax is used, the lines may also be passed as a single vector
[line1, line2, …]).
condition is any Octave expression that can be evaluated in the code
context that exists at the breakpoint. When the breakpoint is encountered,
condition will be evaluated, and execution will stop if
condition is true. If condition cannot be evaluated, for
example because it refers to an undefined variable, an error will be thrown.
Expressions with side effects (such as
y++ > 1) will alter
variables, and should generally be avoided. Conditions containing quotes
(‘"’, ‘'’) or comment characters (‘#’, ‘%’) must be
enclosed in quotes. (This does not apply to conditions entered from the
editor’s context menu.) For example:
dbstop in axis at 246 if 'any (opt == "x")'
The form specifying event does not cause a specific breakpoint at a given function and line number. Instead it causes debug mode to be entered when certain unexpected events are encountered. Possible values are
Stop when an error is reported. This is equivalent to specifying
debug_on_error (true) and
Stop when an error is caught by a try-catch block (not yet implemented).
Stop when an interrupt (Ctrl-C) occurs.
Stop when code returns a non-finite value (not yet implemented).
Stop when a warning is reported. This is equivalent to specifying
caught error, and
warning can all be
followed by a string specifying an error ID or warning ID. If that is
done, only errors with the specified ID will cause execution to stop. To
stop on one of a set of IDs, multiple
dbstop commands must be
Breakpoints and events can be removed using the
dbclear command with
the same syntax.
It is possible to save all breakpoints and restore them at once by issuing
bp_state = dbstatus; …; dbstop (bp_state).
The optional output rline is the real line number where the breakpoint was set. This can differ from the specified line if the line is not executable. For example, if a breakpoint attempted on a blank line then Octave will set the real breakpoint at the next executable line.
When a file is re-parsed, such as when it is modified outside the GUI, all breakpoints within the file are cleared.
Breakpoints in class methods are also supported (e.g.,
dbstop ("@class/method")). However, breakpoints cannot be set in
built-in functions (e.g.,
sin, etc.) or dynamically loaded functions
To set a breakpoint immediately upon entering a function use line number 1, or omit the line number entirely and just give the function name. When setting the breakpoint Octave will ignore the leading comment block, and the breakpoint will be set on the first executable statement in the function. For example:
dbstop ("asind", 1) ⇒ 29
Note that the return value of
29 means that the breakpoint was
effectively set to line 29. The status of breakpoints in a function can
be queried with
Report the location of active breakpoints.
When called with no input or output arguments, print the list of all functions with breakpoints and the line numbers where those breakpoints are set.
If a function name func is specified then only report breakpoints for the named function and its subfunctions.
The optional return argument bp_list is a struct array with the following fields.
The name of the function with a breakpoint. A subfunction, say
within an m-file, say file.m, is specified as
The name of the m-file where the function code is located.
The line number with the breakpoint.
The condition that must be satisfied for the breakpoint to be active, or the empty string for unconditional breakpoints.
dbstop if error is true but no explicit IDs are specified, the
return value will have an empty field called
"errs". If IDs are
errs field will have one row per ID. If
dbstop if error is false, there is no
"warn" field is set similarly by
dbstop if warning.
Reusing the previous example,
dbstatus ("asind") will return
29. The breakpoints listed can then be cleared with the
Delete a breakpoint at line number line in the function func.
Function name as a string variable. When already in debug mode this argument can be omitted and the current function will be used.
Line number from which to remove a breakpoint. Multiple lines may be given as separate arguments or as a vector.
An event such as
dbstop for details).
When called without a line number specification all breakpoints in the named function are cleared.
If the requested line is not a breakpoint no action is performed.
The special keyword
"all" will clear all breakpoints from all
A breakpoint may also be set in a subfunction. For example, if a file contains the functions
function y = func1 (x) y = func2 (x); endfunction function y = func2 (x) y = x + 1; endfunction
then a breakpoint can be set at the start of the subfunction directly with
dbstop func1>func2 ⇒ 5
Note that ‘>’ is the character that distinguishes subfunctions from the m-file containing them.
Another simple way of setting a breakpoint in an Octave script is the
use of the
Stop m-file execution and enter debug mode.
keyboard function is executed, Octave prints a prompt and
waits for user input. The input strings are then evaluated and the results
are printed. This makes it possible to examine the values of variables
within a function, and to assign new values if necessary. To leave the
prompt and return to normal execution type ‘return’ or ‘dbcont’.
keyboard function does not return an exit status.
keyboard is invoked without arguments, a default prompt of
‘debug> ’ is used.
keyboard function is placed in a script at the point where the user
desires that the execution be stopped. It automatically sets the running
script into the debug mode.