Debugger Functions

The following is a list of available debugger functions, how they are accessed, and their descriptions:

Command	Shortest Form	Key	Menu	Description
n/a	n/a	n/a	Help / About	Displays information about the current version of isCOBOL.
n/a	n/a	n/a	Run / Set parameters	Displays a window that allows the user to alter the parameters that were specified on the command line.
n/a	n/a	n/a	Settings / Data	Displays a window that allows to configure settings for data-items management. • Display data as hexadecimal sets the default value for the Hex flag in the following dialogs: o Data / Display o Data / Set Monitor o Quickwatch • Monitor default enabled state specifies if new monitors will be enabled or not by default. • Variable hint delay sets the delay in milliseconds for the tool-tip on data-item values.
n/a	n/a	n/a	Settings / Source / Format	Tells the Debugger which source format is used by the current program. This setting is useful only when the Debugger doesn’t automatically recognize the source format and fails to color keywords and comments.
			Settings / Source / Expand copy books when loading source	Tells the Debugger to automatically expand the copy books included in the program source code.
n/a	n/a	[Ctrl++] [Ctrl+-]	Settings / Font size	Sets the size of the font used to display the source code.
n/a	n/a	n/a	Settings / Customize / Commands	Displays a window that allows the user to create an alias for every Debugger command.
n/a	n/a	n/a	Settings / Customize / Shortcuts	Displays a window that allows the user to customize the keyboard shortuct for every Debugger command.
n/a	n/a	n/a	Settings / Customize / Fonts And Colors	Displays a window that allows the user to customize the appearance of the various elements of the debugger window.
n/a	n/a	n/a	Settings / Session	Displays a window that allows the user to customize the debugger session.
n/a	n/a	[F1]	Help / Commands	Displays a window containing a list of debugger commands and their use.
n/a	n/a	[F2]	Data / Display variables on selected line	Displays all variables that appear in the selected source line along with their current value.
n/a	n/a	[F3]	Edit / Clear output	Clears the Output Window.
n/a	n/a	[F4]	Breakpoints / Toggle at current line	Toggles a breakpoint at the current line of the current source code.
n/a	n/a	[F9]	Run / Go to cursor line	Starts or continues the program execution until the line where the cursor is located is reached.
n/a	n/a	[Ctrl+F8]	Edit / Last command	Repeats the last command entered in the Command Area. The command is not immediately executed, so the user can change it before executing.
n/a	n/a	[Ctrl+F]	Edit / Find	Displays a window that searches text in the current source code.
n/a	n/a	n/a	Edit / Expand all copy books	Expands all the copybooks in the current source file
n/a	n/a	n/a	Edit / Collapse all copy books	Collapses all the copybooks in the current source file
n/a	n/a	[Ctrl+G]	Edit / Go To	Displays a window that jumps to a specific part of one of the currently loaded programs.
n/a	n/a	[F12]	Edit / Go to declaration	Having a variable selected in any part of the source, moves the cursor to the variable declaration in Data Division.
n/a	n/a	[Alt+Left]	Edit / Back	Moves the cursor to the previous occurrence of the selected variable in the source.
n/a	n/a	[Alt+Right]	Edit / Forward	Moves the cursor to the next occurrence of the selected variable in the source.
n/a	n/a	[F3]	Edit / Clear output	Clears the content of the output window.
n/a	n/a	[Ctrl+L]	File / Load file	Loads a source file. The purpose of loading a source file is to set breakpoints in that file before executing it.
n/a	n/a	[Ctrl+U]	File / Unload current file	Releases a previously loaded source file.
b0	n/a	n/a	n/a	Usage: b0 [-d] ProgramName   Sets a breakpoint at the beginning of the program ProgramName.   [-d: disable the breakpoint]
break	br	[Ctrl+B]	Breakpoints / Set	Usage: break   Displays a window that allows the user to set breakpoints.
		n/a	n/a	Usage: break [-d] { LineNumber | ParagraphName } [SourceCode] [when WhenConditions]   Sets a breakpoint. When "-d" is specified, the breakpoint is disabled.   LineNumber is the line number to which the breakpoint refers. That line must contain a statement. If a statement is split between several lines, the breakpoint can only be set at the first line.   ParagraphName is the name of a paragraph. The breakpoint will refer to its first line.   SourceCode is the optional name of the source code to which LineNumber and ParagraphName refer. If SourceCode is not specified, the current source code is implied.   WhenConditions is: [-x][-env] VariableName Operator Value [LogicalOperator VariableName Operator Value] ... Where:        VariableName is the data item to monitor.        Operator can be =, !=, <, >, <=, >=.        LogicalOperator can be either && or II.        Value is the value to be tested.        if -x is used, the value is hexadecimal        if -env is used, the variable is searched for amongst configuration properties
		n/a	View / Breakpoints	Usage: break -l   Activates the Breakpoint view in the Information Window. All breakpoints currently set are listed.
clear	cl	n/a	n/a	Usage: clear { LineNumber | ParagraphName } [SourceCode]   Clears a breakpoint.   LineNumber is the line number where the breakpoint is set.   ParagraphName is the name of the paragraph where a breakpoint is set.   SourceCode is the optional name of the source code that LineNumber and ParagraphName refer to. If SourceCode is not specified, the current source code is implied.
		n/a	Breakpoints / Clear all	Usage: clear -l   Clears all breakpoints.
continue	co	[Ctrl+F5]	Run / Continue	Usage: continue   Starts or continues program execution.
directory	dir	n/a	n/a	Usage: directory [DirectoryName]   If DirectoryName is omitted, then the current debugger code prefix is shown. Otherwise, the directory specified by DirectoryName is added to the debugger code prefix. See iscobol.debug.code_prefix for more information on the debugger code prefix.
display	dis	[Ctrl+D]	Data / Display	Usage: display   Opens a window that displays the value of a variable. Refer to the usages below for details.
		n/a	n/a	Usage: display [-x] [-tree] VariableName   Displays the value of a data item.   When "-x" is specified, the hexadecimal value is shown.   When "-tree" is specified, a new tab is added to the information window. It will show the data item and all its sub-levels in a hierarchical structure. It can be updated or removed by right-clicking in the tab to display a contextual menu.   When "-x" and "-tree" are specified in the same command, their effects are combined.   VariableName is the data item whose value will be displayed.
		n/a	n/a	Usage: display ControlHandle [ property | prop ] PropertyName   Displays the current value of a control property.   ControlHandle must refer to a valid handle.   PropertyName is a the name of a property of ControlHandle.
display -classversion	dis -classversi on	n/a	Run / Display isCOBOL version	Usage: display -classversion   Prints the version of the Compiler that produced the current class.
display -env	dis -env	n/a	Run / Display Environment variable	Usage: display -env VariableName   Displays the value of an environment variable.   VariableName is the name of the environment variable to be displayed.
down	do	n/a	n/a	Usage: down   Shows the next lower stack frame.
env	en	n/a	Run / Display environment variable	Usage: env   Opens a window that allows the user to enter the name of the environment variable to be displayed.
		n/a	n/a	Usage: env VariableName   Displays the value of an environment variable.   VariableName is the name of the environment variable to be displayed.
exit	ex	[Alt+F4]	File / Exit	Usage: exit   Terminates the debugging session and exits.
f	n/a	n/a	Edit / Repeat find	Usage: f   Repeats the last search, with the same options
fb	n/a	n/a	Edit / Find backwards	Usage: fb SearchText   Searches backwards for specific text.   SearchText is the text to be searched for.
ff	n/a	n/a	Edit / Find forwards	Usage: ff SearchText   Searches forward for specific text.   SearchText is the text to be searched for.
ft	n/a	n/a	Edit / Find from top	Usage: ft SearchText   Searches for specific text from the beginning of the source.   SearchText is the text to be searched for.
gc	g	n/a	n/a	Usage: gc   Forces the garbage collector to release unreferenced resources and compact the memory heap.
help	h	n/a	n/a	Usage: help   Lists all the available debugger commands.
		n/a	n/a	Usage: help DebuggerCommand   Displays the usage of a specific debugger command.   DebuggerCommand is the command to be searched for.
infostack	i	n/a	View / Perform stack	Activates the "Perform stack" tab in the Information window.
jump                         Note - this is supported only in programs compiled with -dx option	j	[Ctrl+J]	Run / Jump to	Usage: jump   Opens a window that allows the user to jump to a specific line by skipping the code between the current line and the destination line.
		n/a	n/a	Usage: jump line-number [filename]   Jump to a specific line by skipping the code between the current line and the destination line.   Note: Jumping to lines that are inside blocks is not allowed. In this case the Debugger jumps to the beginning of the block.
		n/a	n/a	Usage: jump paragraph-name   Jump to a specific paragraph by skipping the code between the current line and the destination line.
		n/a	n/a	Usage: jump -outpar   Jump out of the current paragraph skipping all the remaining statements in the paragraph.
		n/a	n/a	Usage: jump -outprog   Jump out of the current program skipping all the remaining statements in the program.
length	len	n/a	Data / Length...	Usage: length variable-name   Displays the lenght in bytes of a data item.
let	le	[Ctrl+Shift+A]	Data / Accept	Usage: let   Opens a window that allows the user to change the value of a variable. Refer to the usages below for details.
		n/a	n/a	Usage: let [-x] VariableName=VariableValue   Changes the value of a data item.   When "-x" is specified, a hexadecimal value must be entered.   VariableName is the data item whose value will be changed.   VariableValue is the value that will be set to VariableName.
		n/a	n/a	Usage: let ControlHandle [ property | prop ] PropertyName=PropertyValue   Changes the current value of a control property.   ControlHandle must refer to a valid handle.   PropertyName is a the name of a property of ControlHandle.   PropertyValue is the value that will be set to PropertyName.
		n/a	Run / Accept environment variable	Usage: let -env VariableName=VariableValue   Changes the value of a configuration property.   VariableName is the data item whose value will be changed.   VariableValue is the value that will be set to VariableName.
line	lin	n/a	n/a	Shows information about the current line.
list	lis	n/a	n/a	Shows some lines of code, starting at the current line.
m0	n/a	n/a	n/a	Usage: m0 [-d][classname][methodname]([signature])   Sets a breakpoint at the first executable line of classename.methodname. If classname is not specified, the breakpoint is set on the current debugged class. If signature is not specified and there is only a method named methodname, the breakpoint is set on that method. signature is a comma separated list of class names or primitive types names, e.g. (java.lang.String,int,java.awt.Rectangle,boolean)   [-d: disable the breakpoint]
memory	me	n/a	n/a	Shows information about memory usage.
monitor	mo	[Ctrl+M]	Data / Set monitor	Usage: monitor   Opens a window that allows the user to enter the parameters needed to set a new monitor   Note - the content of the Value field is trimmed, unless you delimit it by quotes.
		n/a	n/a	Usage: monitor [-d] [-e] [-x] VariableName [ when Operator Value | always | never ]   Monitors a data item. When its value changes or matches a condition, the execution of the program is suspended and the debugger is activated.   VariableName is the data item to monitor.   Operator can be =, !=, <, >, <=, >=.   Value is the value to be tested. If you need to include leading or trailing spaces in the value, delimit it by quotes.     When "-d" is specified, the monitor is disabled and its value in the Information Window is not updated. When "-e" is specified, the monitor is enabled and its value in the Information Window is updated.   When "-x" is specified, the value is hexadecimal.   When the "always" phrase is specified, the debugger is activated each time the value changes.   When the "never" phrase is specified, the debugger is never activated, but the value in the Information Window is always updated.
				Usage: monitor [-d][-e] ControlHandle [ property | prop ] PropertyName [ when Operator PropertyValue | always | never ]   Monitors a property of a control. When its value changes or matches a condition, the execution of the program is suspended and the debugger is activated.   ControlHandle must refer to a valid handle.   PropertyName is a the name of the property of ControlHandle to monitor.   Operator can be =, !=, <, >, <=, >=.   PropertyValue is the value to be tested.     When "-d" is specified, the monitor is disabled and its value in the Information Window is not updated. When "-e" is specified, the monitor is enabled and its value in the Information Window is updated.   When the "always" phrase is specified, the debugger is activated each time the value changes.   When the "never" phrase is specified, the debugger is never activated, but the value in the Information Window is always updated.
		n/a	n/a	Usage: monitor [-d][-e] -env VariableName   Monitors an environment variable.   When "-d" is specified, the monitor is disabled and its value in the Information Window is not updated. When "-e" is specified, the monitor is enabled and its value in the Information Window is updated.   VariableName is the name of the environment variable to monitor.
		n/a	View / Monitors	Usage: monitor -l   Activates the Monitors view in the Information Window. All monitors currently set are listed.
next	n	[Shift+F7]	Run / Step over	Usage: next   Executes the current statement. If it is a PERFORM statement, it is entirely executed.
offset	of	n/a	Data / Offset...	Usage: offset variable-name   Displays the offset of a data item.
outpar	outpa	[Alt+Shift+ F7]	Run / Step out paragraph	Usage: outpar   Continues execution until current paragraph exits.
outprog	outpr	[Alt+Shift+ F8]	Run / Step out current program	Usage: outprog   Continues execution until current program exits.
pause	p	n/a	Run / Pause	Usage: pause   Suspends the program execution.
quit	q	[Shift+F5]	Run / Finish session	Usage: quit   Stops the execution of the program. The debugging session is still valid and the program can be restarted with the run command.
readsession	re	n/a	File / Load debugger session	Usage: readsession [FileName]   Loads monitors and breakpoints from a previously saved debugging session.   FileName is the name of the file that contains the debugger configuration. If it is not specified, 'ISCONTROLSET.isd' is implied.
run	ru	[Ctrl+F6]	Run / Start session	Usage: run   Starts the execution of the program. No COBOL statements are executed.
step	s	[F7]	Run / Step into	Usage: step [n] Executes the current statement. If it is a PERFORM statement, the first statement of the paragraph or session that it refers to becomes current. If n is specified and it’s greater than 1, the step command is automatically repeated n times.
stoff	n/a	[Ctrl+F4]	Run / Stop autostep	Usage: stoff   Deactivates the autostep function.
ston	n/a	[Ctrl+F3]	Run / Start autostep	Activates the autostep function.   Statements are automatically executed at regular intervals. The function can be changed with the selector on right side of the toolbar.
thread	th	n/a	Run / ThreadName	Usage: thread ThreadName   Activates a specific thread.   ThreadName is the name of the thread to activate.
		n/a	View / Threads	Usage: thread -l   Activates the Threads view in the Information Window. All monitors currently set are listed.
to	to	[Ctrl+F9]	Run / Continue to line number	Usage: to LineNumber [SourceCode]   Starts or continues the program execution until a certain line is reached.   LineNumber is the line to reach.   SourceCode is the optional name of the source code to which LineNumber refers. If it is not specified, the current source code is implied.
troff	trof	[Shift+F4]	Trace Off	Usage: troff   Tracing is suspended.
tron	n/a	[Shift+F3]	Trace On	Usage: tron   Tracing is activated. A trace line is appended each time a paragraph starts or ends and each time a program starts or ends. Information is stored in a file called debugger.log, created in the current directory.
unmonitor	u	n/a	n/a	Usage: unmonitor VariableName   Removes the monitor on a data item.   VariableName is a monitored data item.
		n/a	n/a	Usage: unmonitor [-env] VariableName   Removes a monitor on an environment variable.   VariableName is a monitored environment variable .
		n/a	Data / Clear all monitors	Usage: unmonitor -a   Clears all monitors.
up	up	n/a	n/a	Usage: up   Shows the higher stack frame.
w0	n/a	n/a	Edit / First executable line	Usage: w0   Moves the cursor to the first executable line.
w@	n/a	n/a	Edit / Current line	Usage: w@   Moves the cursor to the current line.
wb	n/a	[Ctrl+Home]	Edit / Last line	Usage: wb   Moves the cursor to the last line of the current source.
wt	n/a	[Ctrl+End]	Edit / First line	Usage: wt   Moves the cursor to the first line of the current source.
writesession	w	n/a	File / Save debugger session	Usage: writesession [FileName]   Saves monitors and breakpoints to a file.   FileName is the name of the file that contains the debugger configuration. If it is not specified, 'ISCONTROLSET.isd' is implied.

Enter Debugger

If a program compiled in debug mode is performing ACCEPT of user input on a graphical window, if you press Pause/Break on the keyboard, you will enter Debugger at the next ACCEPT interruption. For example, if you want to debug what happens when you click on a specific push-button of your window,

1.	start the Debugger

2.	issue the run command

3.	issue the continue command

4.	wait for the window with the push-button to appear

5.	press Pause/Break on the keyboard

6.	click on the push-button

On some keyboards the Pause/Break key is not available. In order to have the same feature associated to another key, set the exception value of that key to 65535. For example, if you want to enter debugger using F6, start the Debugger as follows:

iscrun -d -Discobol.key.f6=exception=65535 MYPROGRAM