Ekern at 18:56, 13 December 2022

2022-12-13T18:56:28Z

← Older revision		Revision as of 18:56, 13 December 2022
Line 1:		Line 1:
	__TOC__		__TOC__
	<span class="f_Para">If you set a </span>'''breakpoint'''<span class="f_Para"> on a line on the </span><var>Source Code</~~span~~><span class="f_Para"> tab (or [[Debugging requests that spawn daemons\|Daemon tab]]), then run the program, program execution is paused just before that line is to be executed (if that line is to be executed). When you set a breakpoint:</span>		<span class="f_Para">If you set a </span>'''breakpoint'''<span class="f_Para"> on a line on the </span><var>Source Code</var><span class="f_Para"> tab (or [[Debugging requests that spawn daemons\|Daemon tab]]), then run the program, program execution is paused just before that line is to be executed (if that line is to be executed). When you set a breakpoint:</span>

	* <span class="f_ListBul1">Execution will be paused immediately before the execution of the line for which the breakpoint is set.</span>		* <span class="f_ListBul1">Execution will be paused immediately before the execution of the line for which the breakpoint is set.</span>

Ekern: Created page with "TOC If you set a '''breakpoint''' on a line on the `Source Code tab (or Debugging..."`

2022-11-08T03:28:27Z

Created page with "__TOC__ If you set a '''breakpoint''' on a line on the <var>Source Code tab (or Debugging..."

New page

__TOC__
If you set a '''breakpoint''' on a line on the <var>Source Code tab (or [[Debugging requests that spawn daemons|Daemon tab]]), then run the program, program execution is paused just before that line is to be executed (if that line is to be executed). When you set a breakpoint:

* Execution will be paused immediately before the execution of the line for which the breakpoint is set.

* The line with the breakpoint is highlighted.

* Breakpoint set is displayed in the status bar.

These subtopics follow:

[[Using breakpoints#Setting a single breakpoint|Setting a single breakpoint]]

[[Using breakpoints#Setting multiple breakpoints at once|Setting multiple breakpoints at once]]

[[Using breakpoints#Clearing a breakpoint|Clearing a breakpoint]]

[[Using breakpoints#Clearing all breakpoints|Clearing all breakpoints]]

[[Using breakpoints#Hitting a breakpoint|Hitting breakpoints]]

=== Setting a single breakpoint ===
To set a breakpoint on a line, you can simply double click the desired line. Alternatively, you can right click the line and select <var>Toggle BreakPoint from the context menu:

[[File:togbreak5_zoom70.gif|792x510px|togBreak5]]

Other ways to set this breakpoint are: 

* Select <var>Toggle Breakpoint on Current Line from the <var>Breakpoints menu.

* Use the [[setBreakpointOnCurrentLine command|setBreakpointOnCurrentLine]] or the [[ToggleBreakpointOnCurrentLine command|toggleBreakpointOn]] [[Introducing the configurable components|mappable]] Client command.

Once a breakpoint is set, the UL> at the beginning of the source code line changes to BR>, the highlight color changes, Breakpoint set is displayed in the [[Status bar|status bar]], and the Debugger Client is made the topmost window on the browser screen:

[[File:togbreak5b2_zoom70.gif|506x461px|togBreak5b2]] 

Only executable statements may be breakpoints: if you try to make a non-executable statement a breakpoint, the Debugger sets a breakpoint on the next executable statement below the line you selected.

You can set as many as 1000 breakpoints in a single request. Attempting to set more than the maximum is not allowed (results in an error message). 

=== Setting multiple breakpoints at once ===
You can set multiple breakpoints at once, using either of two approaches: 

* With a search string, set breakpoints on all matching lines

* With a CTRL-B keystroke (if using the [[Default settings of buttons and hot keys|default assignments]]), set breakpoints on executable statements that follow "*break" comment lines in the source code


=== Using a search string: ===
# In the [[Button Bar|Search text box]], specify a search string or a [[Search facility#The Search Button|regular expression]] (regex). 
# Press the ALT-B key combination (if using the default assignments), or use the <var>Breakpoints</var> menu <var>Breaks At</var> option. 

A breakpoint is set on each executable line in the request (from the beginning of the request) that contains a case insensitive match of the string or regex. 

No Breakpoints are set in code that is not currently displayed in the <var>Source Code</var> page (for example, in daemons called by the current request). 

Your current execution point in the request is not affected. 

The mappable Client command that sets multiple breakpoints based on a search string is [[breaksAt command|breaksAt.]] 


=== Using CTRL-B: ===

When you click CTRL-B (if using the default assignments), or when you use the <var>Breakpoints</var> menu <var>Breaks</var> option, the Client scans the current request from the beginning to the end for comments beginning with the string *break. Whenever such a line is found, a breakpoint is set on the next line if it is an executable statement. 

No breakpoint is set after an occurrence of *break unless the following is true: 

* *break (case not important) must be the first non-blank characters on the line. Any other characters may follow.

* The line immediately following the *break comment must be an executable statement. 

The Client command that sets multiple breakpoints based on *break is [[breaks command|breaks.]] 

=== Clearing a breakpoint ===

To remove a single breakpoint, do any of the following: 

* double click the line. 

* Right click the line and select <var>Toggle Breakpoint</var>. 

* Select <var>Toggle Breakpoint on Current Line</var> from the <var>Breakpoints</var> menu. 

* Use the [[clearBreakpointOnCurrentLine command|clearBreakpointOnCurrentLine]] or the [[ToggleBreakpointOnCurrentLine command|toggleBreakpointOnCurrentLine]] mappable Client command. 

As a result, the BR> indicator changes back to UL> to indicate successful removal, the highlight color changes, and Breakpoint cleared is displayed in the status box. 

=== Clearing all breakpoints ===

To clear all the breakpoints that are set, click the <var>Clear Breaks</var> button or use the <var>Breakpoints</var> menu <var>Clear All Breakpoints</var> option. All breakpoints get cleared, and all breakpoint indicators in the source display are changed back. 

The mappable Client command that clears all breakpoints is [[clearBreaks command|clearBreaks.]] 

=== Hitting a breakpoint ===

When a breakpoint is hit, the procedure, file, and routine or method that contain the breakpoint are identified.

[[File:breakpointhit78.png|482x356px|breakPointHit78]]

 

'''See Also:'''
: [[Using the DebuggerTools class methods#Break method|Break method]]
: [[Running to a specific procedure|Running to a specific procedure]]
: [[Step, Step Over, and Run|Stepping out]]

[[Category:Debugger Home]]

Using breakpoints - Revision history

Ekern at 18:56, 13 December 2022

Ekern: Created page with "__TOC__ If you set a '''breakpoint''' on a line on the Source Code tab (or Debugging..."

Ekern: Created page with "TOC If you set a '''breakpoint''' on a line on the `Source Code tab (or Debugging..."`