| UNIX Session Recorder | UNIX Key Usage Chart | |
This chapter describes the Animator directives you can use to control the animation of your program.
The following Animator directives are available:
| Directive |
Function |
|---|---|
| 8BITCHAR | Control display of extended ASCII characters |
| BREAK | Set a breakpoint |
| BREAKPOINTS | Set limit on breakpoints |
| COBAIF | Load/save Animator session information |
| CHECK-CLEAR-BREAKS | Clear all breakpoints when a program has been re-checked |
| COMMSTYPE | Set communications type for cooperative animation |
| END | Begin directives for user program |
| FILECASE | Convert characters to upper-case |
| FLASH | Set when to display user screen |
| FLASH-CALLS | Make Animator display user screen on CALLs |
| HIGHLIGHT | Control highlight of current line |
| HOLDVIEW | Set how long to display user screen |
| INSTALL | Pre-install programs |
| PARMPASS | Animate progam under Parmpass |
| PRELOADIDY | Ensure all .idy files are loaded |
| RESEQ | Make Animator display sequence numbers |
| SCREENPAGE | Make screen page when scrolling |
| USER-MACHINE | Specify machine where program runs |
| USER-SESSION | Specify session where program runs |
| ZOOM | Make Animator zoom |
Descriptions for all of the Animator directives appear alphabetically. Each description contains the following entries.
A brief description of the function of DIRECTIVE-NAME.
>>-.---.-.-------DIRECTIVE-NAME-"parameter(s)".-><
.-/-+ ..----.-DIRECTIVE-NAME---------------+
.-NO-+
The syntax of the Animator directives is shown using diagrams called "railroad
tracks". These show a directive and its parameters joined by lines
indicating the order in which they should be written. You read these diagrams
from left to right. Each diagram starts with >> and ends
with >< . Sometimes the track forks to show alternatives and
then joins up again. The length of a track has no significance.
Parameters for directives are shown in quotation marks, although parentheses can be used instead unless otherwise stated. When quotation marks are used the parameter can contain spaces, whereas no spaces are allowed in a parameter surrounded by parentheses.
On UNIX environments, the optional slash is not required and should not be used. Instead of enclosing the parameter to a directive in quotes, it can follow an equals sign following the directive. For example:
FLASH=ZOOM.
Lists and describes valid parameter(s), if any, for the directive.
| Default: Environment: |
Indicates the directive's default setting Specifies the environments in which this directive can be used. |
Contains any additional information about the directive.
This directive is maintained for compatibility with older products on UNIX. It has no effect in this system. It will be removed in a future release.
>>-.---.-.----.--8BITCHAR------------------><
.-/-+ .-NO-+
None
| Default: Environment: |
NO8BITCHAR All |
This directive is included for compatibility with older products on UNIX. It is not required with this product.
Sets a breakpoint at the specified paragraph or section, and causes Animator to zoom to that point.
>>-.---.-.-----BREAK--"proc-name"-----.----><
.-/-+ .-NO--BREAK------------------+
proc-name |
Name of a paragraph or section in the program being animated. |
| Default: Environment: |
NOBREAK All |
Specifies the number of breakpoints that can be set in any one program.
>>-.---.--BREAKPOINTS--"integer"-----------><
.-/-+
integer |
Integer between 4 and 100 defining the number of breakpoints allowed. |
| Default: Environment: |
BREAKPOINTS"100" All |
Only 12 bytes are allocated for each breakpoint you allow for, so you need only change this value if you are very short of memory.
With cross-session or cooperative animation, the number of breakpoints allowed defaults to four and cannot be changed.
Causes all breakpoints to be cleared when a program is rechecked.
>>-.---.-.----.--CHECK-CLEAR-BREAKS--------><
.-/-+ .-NO-+
None
| Default: Environment: |
NOCHECK-CLEAR-BREAKS All |
If this directive is not set, Animator remembers the breakpoints set for a program, and restores them whenever Animator is restarted.
Specifies whether to load and save Animator session information.
>>-.---.-.-------COBAIF--"path-name"--.----><
.-/-+ ..----.-COBAIF---------------+
.-NO-+
path-name |
The location of the Animator information file. |
| Default: Environment: |
COBAIF"idy-path" All |
The Animator information file contains details of breakpoints and monitors. Its extension is .aif.
If no COBAIF directive is specified, the default behavior is to save and load the information files in the directory where the .idy file is found.
If NOCOBAIF is specified, no information files are loaded or saved.
If COBAIF is specified with no path-name, the information files are saved and loaded in the directory specified by the COBAIF environment variable. If the COBAIF environment variable does not exist, the current directory is used.
If COBAIF is specified with path-name, the information files are saved and loaded from the directory specified.
Specifies the type of communications to be used with cooperative or cross-session animation.
>>-.---.-.-------COMMSTYPE--"comms-type"--.----><
.-/-+ ..----.-COMMSTYPE----------------+
.-NO-+
comms-type |
The name of the CCI module to use. For example, ccinetb or cciipx. |
| Default: Environment: |
COMMSTYPE"ccinetb" for cooperative animation
(USER-MACHINE) COMMSTYPE"ccinamp" for cross-session animation (USER-SESSION) 16-bit COBOL system |
USER-MACHINE Animator directive
USER-SESSION Animator directive
Indicates the end of directives to Animator and start of command line parameters to your program.
>>-.---.--END------------------------------><
.-/-+
None
| Default: Environment: |
Not present All |
This directive can be followed by text for use in ACCEPT ... FROM COMMAND-LINE.
Controls whether or not Animator converts file-names to upper case for use in internal comparisons.
>>-.---.-.----.--FILECASE------------------><
.-/-+ .-NO-+
None
| Default: | NOFILECASE on UNIX FILECASE on DOS, Windows and OS/2 |
| Environment: | All |
Sets the default condition under which Animator automatically displays the user screen.
>>-.---.--FLASH--"mode"--------------------><
.-/-+
mode |
The mode in which Animator displays the user screen. |
| Default: Environment: |
FLASH"ZOOM" All |
The possible values of mode are:
| STEP | Display user screen before executing each statement. |
| ZOOM | Display user screen before zooming. |
The setting can be altered from within Animator.
Using FLASH you can make Animator display the user screen before it calls a subprogram written in another language. This prevents the subprogram's output overwriting the Animator screen.
Makes Animator display the user screen at every CALL statement and whenever a PERFORM statement is stepped over.
>>-.---.-.----.--FLASH-CALLS---------------><
.-/-+ .-NO-+
None
| Default: Environment: |
NOFLASH-CALLS All |
This should be used when the program being animated makes calls to non-COBOL programs that write to the screen; for example, OS/2 VIO API function calls.
Specifies whether or not to highlight the line that Animator is currently on.
>>-.---.-.----.-.-HIGHLIGHT-.--------------><
.-/-+ .-NO-+ .-HILITE----+
None
| Default: Environment: |
HIGHLIGHT All |
With cross-session animation, specifies how long the user screen is displayed before returning to Animator.
>>-.---.--HOLDVIEW-.-----------.-----------><
.-/-+ .-"integer"-+
integer |
The length of time, in seconds. |
| Default: Environment: |
HOLDVIEW HOLDVIEW"4" (if USER-SESSION"PM" is also specified) DOS, Windows and OS/2 |
HOLDVIEW with no parameter specifies an infinite time. In this case, any keystroke causes control to be returned to the Animator. If specified, integer indicates the number of seconds before control is automatically returned to Animator.
HOLDVIEW is needed when the user program is running in a different session, as Animator no longer has control and keystrokes on the user session cannot be detected by Animator.
Specifies a program to install before starting the animation session.
>>-.---.--INSTALL--"program"------------><
.-/-+
program |
The name of the program to install. |
| Default: Environment: |
None present. All |
Enables the use of programs like the External File Mapper when invoking Animator from the command line.
INSTALL"$COBDIR\MFEXTMAP"
Invokes the program being animated under the control of PARMPASS.
>>-.---.-.----.--PARMPASS------------------><
.-/-+ .-NO-+
None
| Default: | NOPARMPASS |
| Environment: | All |
Specifies whether to load and save Animator session information.
>>-.---.-.----.--PRELOADIDY----------------><
.-/-+ .-NO-+
None
| Default: Environment: |
PRELOADIDY DOS, Windows and OS/2 |
This directive is for compatibility with earlier versions of this system. Its behavior can be achieved by using the COBAIF directive.
COBAIF
Makes COBOL line sequence numbers appear on Animator's display of the source.
>>-.---.-.----.--RESEQ---------------------><
.-/-+ .-NO-+
None
| Default: Environment: |
RESEQ All |
Do not use RESEQ if the program contains ++INCLUDE or -INC statements.
Causes the screen to page up or down when you scroll or Step to a line of code not currently displayed on the screen.
>>-.---.-.----.--SCREENPAGE----------------><
.-/-+ .-NO-+
None
| Default: Environment: |
NOSCREENPAGE on DOS, Windows and OS/2 SCREENPAGE on UNIX All |
If this directive is not set, you can scroll or Step continuously through your source code.
If this directive is set, the current line appears as either the third line from the top of the next screen or the third line from the bottom of the previous screen.
With cooperative animation, specifies the machine where the user program runs.
>>-.---.-.-----USER-MACHINE--"netname"-.---><
.-/-+ .-NO--USER-MACHINE------------+
netname |
Network name. An alphanumeric string of up to eight characters. |
| Default: Environment: |
NOUSER-MACHINE 16-bit COBOL system |
Animator and the cooperative program Animuser communicate using a network name, netname. The default network name is COOPANIM. If more than one cooperative animation is likely to take place on the same network at the same time, each must use a different network name. In this case you must specify a unique name with this directive when starting Animator and Animuser.
COMMSTYPE Animator directive
With cross-session animation, specifies the session to be used for the user program.
>>-.---.--USER-SESSION--"session"----------><
.-/-+
session |
The session to use for the user program. |
| Default: Environment: |
USER-SESSION"CURRENT" 16-bit COBOL system on OS/2 |
The possible values of session are:
| CURRENT | Same session as Animator. |
| FULL-SCREEN | Separate OS/2 full screen session |
| PM | As a Presentation Manager application. |
| WINDOWED | Separate OS/2 windowed session. |
| HARDMODE | A Presentation Manager or native Windows application in hard
mode.
This is a form of debugging that prevents the desktop from freezing when debugging programs using the Presentation Manager or Windows API. When you are stopped in Animator, you cannot switch to any other application. |
If the selected session is not "current" and NOUSER-MACHINE is specified (or default), this directive makes Animator start a cross-session animation. If USER-MACHINE is specified, this directive specifies the session to be activated on the user machine. For any session other than "current" the user machine must be running OS/2.
In all cases, the user program is started by Animator. If it is running in a different session, the session is also started by Animator.
With USER-SESSION"PM" the default for HOLDVIEW is HOLDVIEW"4".
COMMSTYPE Animator directive
HOLDVIEW Animator directive
Invokes Animator in zoom mode.
>>-.---.-.-------ZOOM--"program-name"-.----><
.-/-+ ..----.-ZOOM-----------------+
.-NO-+
program-name |
Zoom until this subprogram is entered. |
| Default: Environment: |
NOZOOM All |
In zoom mode, Animator executes the program at full speed, displaying the user screen rather than the source code.
Copyright © 1998 Micro Focus Limited. All rights reserved.
This document and the proprietary marks and names
used herein are protected by international law.
| UNIX Session Recorder | UNIX Key Usage Chart | |