tcl.blist Verb: Access/TCL


Command tcl.blist Verb: Access/TCL
Applicable release versions: AP 6.1, R83 3.1
Category TCL (746)
Description formats and outputs Pick/BASIC source code listings, according to the options chosen. It may also be used to format a Pick/BASIC source program and write it back to the file from which it came.

The AP version of blist can be customized. The blist verb is table driven. The table is stored in the messages file. The item-id of the control table is "BL" followed by a 4 character hexadecimal number. The table number is contained in line 4 of the verb definition. The default table number is 0, thus the default table item-id is "BL0000".

Line one of the control table defines the left margin, number of spaces to indent for each construct, and the default options. Each of these is separated by a comma. The default control table contains "7,3,(BS)" on line 1, designating a left margin of 7 (statement label area), 3 spaces to indent for each construct, and the options B and S are used by default.

Line two of the control table defines the key words used at the beginning of a statement which may begin or end a construct or which may begin a comment. Each value on this line contains the key word followed by a subvalue mark, followed by a type character (* for comment, ; for statement), followed by two digits. The first digit specifies the number of outdents for the statement, the second digit specifies the number of indents for the statement. Note that some statements may contain a value in each digit (such as WHILE, which will outdent the statement containing the WHILE, and then indent the following statements).

Line three of the control table defines the key words used at the end of a statement which may begin or end a construct. The format is the same as line two.
Syntax blist file.reference itemlist* {(options}
Options B Expand lines containing only an exclamation point (!) into a line of asterisks.

C Do not indent comment lines.

D Double space the listing.

L Suppress the editor line number.

N No wait at end of page (on CRT listings).

P Output to the spooler.

S Draw vertical structure lines.

If the S option is specified, then vertical lines will be drawn between the beginning of a structured construct and the end of the construct. This option is useful when constructs span pages or are nested many levels deep.

T Output to the terminal.

If a line is too long to fit into the page width (as setup with the TERM command), an attempt is made to fold the line at blanks, commas, or other delimiters. The folded portion of the line is indented to the same level as the original line. Any control characters encountered are displayed as periods.

The T option is intended for use when the P option has been included in the default options (see next section). The T option overrides the P option and should never be included in the default options (else output to the spooler will be impossible).

u (R83 only) Updates source item(s). See the "BLIST" PROC in the MD of the account. Attribute 2 contains a number that determines how many spaces to indent from the left margin. The default is 2. On AP, this functionality is provided by the bformat command.
Related tcl.b/list