UED - Line-Oriented Source Editor Utility

UED is an online utility with which you can edit source text using any available terminal device type with both input and output capability. Specifically, UED can be used with hard copy type terminals such as TTY devices and 2741 terminals.

With UED, all editing operations are performed in editor work files allocated within Com-plete SD files. First, an SD file is allocated; then the library or member is read into the SD file. Next, you edit the data in the SD file, and finally use the SAVE command to write the data back to the indicated library member.

In addition to dynamic allocation of sequential or partitioned data sets, the UED utility includes these features:

• You can use any library containing source text as input or output to UED.

• For z/OS, input and output data sets are restricted to the following DCB conventions:

  RECFM=F or RECFM=FB 
  DSORG=PS or DSORG=PO 
  

• In z/OS, BLKSIZE value of any input or output library is restricted only by the size of the thread in which UED is to execute. If files with large BLKSIZE are encountered while using UED, editing may not be possible. In this situation, you will need the assistance of the system programmer responsible for Com-plete maintenance.

• In z/OS, you can use any sequential data set containing source text as input or output to UED. The record size is limited to 255 bytes.

• You can select statements from other members and other libraries for insertion into the text you're editing.

• Editing is either statement number-oriented or tag-oriented, depending upon your selection.

• You may use a full range of editing commands using a well-defined syntax structure.

• A user-written subroutine can be used for establishing security restrictions.

• A table of library identification codes enables you to use a two-character reference instead of entering the full file name.

This document covers the following topics:

• Command Format

• UED Commands

Command Format

UED is a fully conversational online utility program. This means that you can select one of the various functions available when you invoke UED, or any time thereafter.

The basic command format is:

 *UED  

Once you have entered this command, conversation is established with UED and you can then enter the various command functions.

Optionally, you can use the command format:

*UED function  

where function is any of the command functions defined for UED.

UED Commands

You can abbreviate all UED commands. In the command descriptions that follow, the minimum abbreviations allowed are indicated by an underscore.

Note that you can request more than one command function at a time, provided that each function is separated by the command delimiter.

You can dynamically change most default values used by UED, including the command delimiter (the default is a semicolon), at any time during execution of UED or at invocation of UED by using the DEFINE command.

The descriptions of the various UED commands in the following sections refer to subscripted items such as num, addr, and st. Note that the following definitions apply to all such references unless otherwise specifically stated:

Note that several arguments in the following command descriptions are defined as addr arguments but their descriptions indicate that they may be num (numbers) as well. Such arguments must be preceded by the default number identifier # in order to ensure that the number attribute is attached.

Note also that all commands except DEFINE have positional arguments. You must replace any intermediate argument that is to be omitted for a given command by an operand delimiter (for example, comma). If you omit trailing arguments, however, a replacement operand delimiter is not required.

You can use the SAVE command to replace an existing member of a source library. If the member does not exist, a new member is created.

In z/OS, you can overwrite an existing sequential file with the SAVE command.

CHANGE Command

The CHANGE command enables you to change one or more occurrences of a given character string within a statement to another character string. You can define the number of occurrences per statement (one line) as well as the number of statements.

The command format is:

CHANGE st1,st2[,num][,addr1][,addr2]

The arguments are:

Note that you can only change a character string when the entire string is contained within the following ranges:

• Before the sequence columns;

• In the sequence columns;

• After the sequence columns.
  

COPY Command

The COPY command enables you to copy one or more statements.

The command format is:

COPY [addr1][,addr2][,addr3][,num]

The arguments are:

Note that the COPY command uses the currently allocated SD work file to capacity before generating an error message. For example, if you request 10 copies of 8 lines and there is only space for 60 lines, the 60 lines will be created, after which an error message is generated: "SD FILE TOO SMALL".

DEFINE Command

The DEFINE command enables you to change the default edit characteristics assumed by UED (as opposed to the QUERY command, which is used to display existing default values).

The command format is:

DEFINE key1=[value1][,key2=[value2]]...[,keyn=[valuen]]

where each keyn is one of the keywords described in the following text. Note that if you give a keyword argument with no value specified, the keyword is initialized to the standard default value.

Available keywords and their default values are:

DELETE Command

The DELETE command enables you to delete one or more of the data statements that you are editing.

The command format is:

DELETE [addr1][,addr2]

The arguments are:

If the current line is not deleted, the current line pointer is not changed; otherwise, the current line pointer is set to the address of the line immediately following the second argument address. One exception is when the second argument specifies the address of the last line; in this case, the current line pointer is set to the new last line.

To clear the SD work file without terminating UED, specify:

DELETE --,++ 

END Command

The END command enables you to terminate the UED utility program.

The command format is:

END [n]

where n is an optional argument with one of the following values:

If you use the END command function with no arguments, UED is terminated only if the SD work file has not been modified since the last SAVE or SUBMIT function.

Note that use of either the CLEAR key on a 3270-type terminal, "control/D" on a TTY-type terminal, or the Com-plete program termination command *EOJ is identical in function to use of the END command with no arguments.

FIND Command

The FIND command enables you to find or locate one or more occurrences of a designated character string.

The command format is:

FIND st[,num][,addr1][,addr2]

The arguments are:

The FIND command sets the current line pointer to the line where the last occurrence of the designated string was found. If the string is not found, no change in the line pointer will occur.

HALT Command

The HALT command enables you to terminate command execution within UED or terminate output of UED (for example, at a hard copy terminal).

The command format is:

HALT [xxx]

where the argument xxx can be:

If you do not enter any arguments with the HALT command, the TYPING argument is taken as default.

If you specify CON=YES with the DEFINE command function, the HALT command is the only command function that terminates command execution at the end of one screen of terminal output when more output is to be displayed.

HELP Command

The HELP command enables you to display syntax information about a given command or display a list of all commands available for use with UED.

The command format is:

HELP [command]

where the optional argument command represents any command name recognized by UED. If you enter a command name, a syntax description of that command is displayed. If you do not specify argument, a list of available command function names is generated.

You can optionally execute the HELP command by using the format:

? [command]  

where the functions performed and the description of the command are the same as described above. The question mark (?) is a synonym of the character string HELP.

INSERT Command

The INSERT command enables you to insert one or more lines after a designated line.

When you enter the INSERT command, you are placed in INSERT mode and remain in this mode until you enter a null statement (that is, press ENTER without entering additional data).

The command format is:

INSERT [addr][,S]

The arguments are:

LIST Command

The LIST command enables you to display one or more statements without changing the current line pointer.

The command format is:

LIST [addr1][,addr2]

The arguments are:

MACRO Command

The MACRO command enables you to define a string of commands that are to be executed each time you enter the name of the macro definition.

Each macro definition must fully reside in one statement. If you wish to use more than one statement, you must create multiple macro definitions.

Macro statements, by definition, specify UED commands to be executed when the macro statement is issued by name. Since a macro statement is also a UED command, it can issue another macro statement, or even issue itself. Thus, you can chain macro statements together by having each macro execute one or more other macro statements.

Three command formats are available for a macro definition.

DEFINE

The first MACRO command format enables you to define a specific macro statement.

The command format is:

MACRO DEFINE name cmd1[;cmd2]...[;cmdn];MEND

The arguments are:

Example:

The following example defines a macro command that, when executed, will list statements 200 through 400. In addition, 800 statements will be scanned beginning with statement 500, and a listing of those statements will be given for those containing the character string "programmer":

MACRO DEFINE A L 200,400;F PROGRAMMER,1,500,#800;MEND  

You could then execute this macro command simply by entering:

A

LIST

The second format for the MACRO command enables you to obtain a listing of all currently defined macro names or a listing of one or more macro definitions.

The command format is:

MACRO LIST [name1][,name2]...[,namen]

The arguments are:

Example:

To obtain a list of all currently defined macro statements, you would enter:

MACRO LIST  

The output of this request lists the macros currently defined by name.

To obtain a display of a specific macro definition (macro A in this example), issue the command:

MACRO LIST A  

DELETE

The third format for the MACRO command function enables you to delete a previously entered macro definition.

The command format is:

MACRO DELETE name[,namen]...

The arguments are:

MOVE Command

The MOVE command enables you to move one or more statements within the data being edited.

The command format is:

MOVE [addr1][,addr2][,addr3]

The arguments are:

If the current line address is not included in the range of statements you are moving, the current line address is not changed; otherwise, the current line address becomes that of the statement following the last statement indicated by the second argument (addr2).

NUMBER Command

The NUMBER command enables you to change the statement sequence numbers for the statements being edited.

The command format is:

NUMBER [num1][,num2][,label][,N][,addr1][,addr2]

The arguments are:

PRINT Command

The PRINT command enables you to obtain a hard copy printout of the data being edited.

The command format is:

PRINT [code][,format][,addr1][,addr2]

The arguments are:

QUERY Command

The QUERY command enables you to display the default UED editing characteristics as defined or defaulted by the DEFINE command.

The command format is:

QUERY [key][,key]...

The arguments are:

READ Command

The READ command enables you to read or obtain data statements from a library for editing purposes.

The data being read can be a member of a source library or (in z/OS) a sequential file. Note that if you specify a source library, you must either specify a member or default to the member initialized with the MEMB keyword in the DEFINE command.

You can read an entire member or portions thereof. All data read is placed in the SD work file, if it already exists, in the location that you specify. If the SD work file does not currently exist, a new one is created.

Before using the READ command, you must be familiar with the DSN, MEMB, and VOL keyword options of the DEFINE command function.

The format of the READ function is:

READ [library][(member)][/volume][,num1][,num2][,addr]

Note that the first three argument values (library, member, and volume), if entered, must not be separated by spaces or commas.

The arguments are:

Example

The following example illustrates the use of the READ command. In this example, the Com-plete initialization procedure "COMPLETE" is read from the library SYS1.PROCLIB and only the first three statements of the procedure are to be read:

READ SYS1.PROCLIB(COMPLETE),1,3 

RECOVER Command

The RECOVER command enables you to resume editing of the data in a specific SD work file after either a system failure occurs or after UED terminates with the H option of the END command function.

If you log onto Com-plete before the initial editing session, the SD work file is recovered based upon your user ID.

If you do not log on to Com-plete before the initial editing session, the SD work file is recovered based upon the Terminal Identification (TID) number. In this situation, you can only recover from the original terminal.

The command format is:

RECOVER

REPEAT Command

The REPEAT command enables you to repeat the execution of the previously entered command line.

The command format is:

REPEAT

RESUME Command

The RESUME command enables you to resume output or typing after it has been halted by a HALT command.

The command format is:

RESUME

SAVE Command

The SAVE command enables you to save or write the data being edited to an output source library member or library. All or some of the statements being edited may be saved.

The command format is:

SAVE [library][(member)][/volume][,addr1][,addr2]

The arguments are:

SUBMIT Command

The SUBMIT command enables you to submit a range of statements via the RJE facility of Com-plete to be scheduled for batch execution.

You can submit either the entire SD work file or portions thereof for scheduling.

The command format is:

SUBMIT [addr1][,addr2]

The arguments are:

TAB Command

The TAB command enables you to display an edit scale that indicates the available columns in which you can perform editing. This scale also contains the character T in every tab position.

The command format is:

TAB 

No arguments are required or provided.

The output displayed by this command is illustrated in the following figure:

T.|...8 |...|...1T0...T..2|0...|...3|0... (...)

The following notes apply to the items in the preceding display:

• Columns 72-80 are listed first. These are the sequence number columns that normally appear in the output of a LIST command.

• A space separates the sequence columns from the data columns.

• The character T is entered in every column for which a tab is set; in this example, columns 72, 10, and 16.

• Column numbers divisible by five are indicated with a vertical bar (|). Column numbers divisible by ten are indicated by having the numerical digits representing those columns separated by a vertical bar (e.g., column 30 is represented as "3|0", where the 3 is actually in column 29 and the 0 is actually in column 31).

Forward Paging Command

The Forward Paging command enables you to advance the current line pointer address forward a designated number of lines.

The command format is:

+num

where num is any integer larger than zero.

This command causes the current line pointer address to move forward the indicated number of lines.

Backward Paging Command

The Backward Paging command enables you to decrement the current line address a designated number of lines.

The command format is:

-num 

where num is any integer larger than zero.

This command causes the current line pointer address to move backward the indicated number of lines.

Last Statement Paging Command

The Last Statement Paging command enables you to advance the current line pointer address to the last statement.

The command format is:

++[-num]

Use of the -num argument positions to "num" lines before the last statement (e.g., ++-5 would position to five lines before the end of file).

First Statement Paging Command

The First Statement Paging command enables you to change the current line pointer address to the first statement.

The command format is:

--[+num] 

Use of the +num argument positions you to "num" lines after the first statement (e.g., --+5 would position to five lines after the top of file).

Tag Paging Command

The Tag Paging command enables you to change the current line pointer address to that of the statement containing a designated tag. A tag is a character string ranging from 1 to n characters.

The search for a tag is normally in columns one through eight of each statement; however, you may override this with the TAGCOL keyword option of the DEFINE command function.

The command format is:

/tag[+num]

where you must enter the slash (/) before the tag itself.

Use of the +num or -num argument positions you to "num" lines after or before, respectively, the tag statement (e.g., /tag+5, /tag-5).

Statement Modification Command

The Statement Modification command enables you to advance the current line pointer address forward to a designated statement and optionally modify the contents of that statement.

The command format is:

num[data] 

where num is any string representing the desired statement sequence number.

Note that data (that is, any characters specified after the sequence number) will replace the data currently contained in the statement identified by the specified statement number.