⟦c62b7c9df⟧

TextFile

         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 1▶02◀\r
\r
PASCFORM takes as input a syntactically-correct Pascal program and\r
produces as output an equivalent but reformatted Pascal program.\r
The resulting program consists of the same sequence of Pascal symbols\r
and comments, but they are rearranged with respect to line boundaries\r
and Columns for readability.\r
It makes a syntax analysis, and reformats the source based on formatting\r
directives. The directives can be imbedded in the source, and thus\r
altered by the user. If not provided by the user, a set of default\r
values are used for the formatting directives.\r
\r
▶02◀PASCFORM▶02◀ is called as follows:\r
\r
   PASCFORM <source file> [<list file>] [<option> ... ]\r
\r
where\r
\r
<source file>:   is the name of the file containing the Pascal program\r
                 to be formatted.\r
                 If the file name is omitted, current input is assumed.\r
                                                             \r
<list file>:     is the name of the file to receive the result.\r
                 If omitted, current output is assumed.\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 2▶02◀\r
\r
Options are specified as follows:\r
\r
                 ▶02◀/<option letter>:<option value>▶02◀\r
\r
The following option is available:\r
\r
/V:   Compiler ▶02◀V▶02◀ersion.\r
      with numeric values. This option is used to specify the\r
      Pascal compiler version to use (when identifying reserved\r
      words). Possible values are:\r
      1 = Poly Pascal\r
      2 = Real Time Pascal\r
      3 = Turbo Pascal v. 3 \r
      4 = Turbo Pascal v. 4  and  v. 5\r
      Default  /V:4\r
\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 3▶02◀\r
\r
▶02◀Directives.▶02◀\r
\r
Directives to PASCFORM may always be specified in the program itself\r
inside comments with a special syntax. Thus the first line of a\r
program is an ideal spot for a comment containing directives.\r
Subsequent use of embedded directives allows you to change the kind\r
of formatting for different sections of your program. The syntax of\r
these special comments is given below.\r
\r
Experience with PASCFORM has shown that most users can find a set of\r
values for the directives which produce satisfactory results. The \r
default values are typical.\r
\r
The folowing are examples of valid directives to PASCFORM.\r
\r
    {[W=1-120,S=4,P=1] set line width et c.}\r
    (*[E=3,B+] *)\r
 \r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 4▶02◀\r
\r
▶02◀Directives to PASCFORM▶02◀\r
\r
▶02◀N.B.▶02◀ Only ▶02◀upper case▶02◀ letters are recognized as directives.\r
\r
A=n  Align declarations.\r
   The A directive forces the alignment of ":" and "=" in declarations.\r
   The parameter "n" should hold the length of the longest declaration-\r
   name.\r
   The A directive visually clarifies the declaration part of your program.\r
   Default: A=0 (no alignment).\r
\r
B+ or B- Bunch statements and declarations reasonably.\r
   B+ will place as many statements or declarations onto one line as\r
   will fit within the specified write margins (W directive) subject\r
   to readability constraints. Bunching (B+) when the display is off\r
   (D-) has no effect. In general, B+ saves paper and prevents your\r
   program from becomming overly stretched in the vertical direction.\r
   Default: B- (one statement or statementpart per line).\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 5▶02◀\r
\r
C+ or C- Fully compress program.\r
   C+ removes all non-essential blanks, end-of-lines, and comments\r
   from your program.  A comppileable, packed program will be written\r
   within the specified write margins (W directive).  The number of\r
   spaces specified by the G directive will still be written between\r
   symbols.  C+ might save some space on long-term storage media such\r
   as disk; you might store a program in compressed form and expand it\r
   later by reformatting with C-.\r
   Default: C-.\r
\r
D+ or D- Turn display on or off.\r
   D allows you to selectively display portions of your program during\r
   formatting.  Therefore, D must be switched on and off with\r
   directives which are appropriately placed in your program.  D is\r
   perhaps useful to obtain program fragments for publication (such as\r
   one or more procedures) without having to print the whole program.\r
   Default: D+.\r
\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 6▶02◀\r
\r
E=n Supply END comments.\r
   The E directive generates comments after "END" symbols if none are\r
   already there.  Common Pascal coding styles frequently employ\r
   these comments.  E=1 creates comments after the "END" symbol in \r
   compound statements which are within structured statements, as well\r
   as those constituting procedure and function bodies.  The comment\r
   takes the form: (*StatementPart*) or (*ProcedureName*).  E=2 creates\r
   comments after the "BEGIN" and "END" symbols constituting procedure\r
   and function bodies only.  E=0 creates no comments at all.\r
   E=3 means E=1 and E=2.\r
   Default: E=2.\r
\r
F+ or F- Turn formatting on or off.\r
   F allows you to format selected portions of your program.  F- causes\r
   PASCFORM to copy the input program directly with no changes.\r
   Therefore by switching F on and off with directives which are\r
   appropriately placed in your program, you can preserve text which\r
   is already properly formatted (such as comments).\r
   Default: F+ (of course!).\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 7▶02◀\r
\r
G=n Specify symbol gap.\r
   The G directive determines the number of spaces placed between\r
   Pascal symbols during formatting.  G=0 still places one space\r
   between two identifiers and reserved words.\r
   The symbols [ ] ( ) , and : are handled independently of G.\r
   Default: G=1.\r
\r
I=n Specify Indent tab.\r
   I indents each nesting level of statements and declarations a\r
   given number of columns.  Using I=2 or I=1 helps prevent\r
   excessively-narrow lines within the specified write margins\r
   (W directive) where there are heavily-nested constructs.\r
   Default: I=3.\r
\r
L=n Specify Line-wraparound indent tab.\r
   L determines the indentation of the remainder of statements or\r
   declarations which are to long to fit one line.\r
   Default: L=3.\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 8▶02◀\r
\r
N=x-y\r
   If y > 0 then line-numbers are written outside the spedified write\r
   margins for the formatted program in sequential order starting at\r
   x; Y = 0 shuts off line-numbering. ">" writes up to 4-digit, right-\r
   justified line-numbers together with a trailing space to the left\r
   of each line.  ">" writes 6-digit, zerofilled line-numbers to the\r
   right of each line.\r
   Use the N directive along with the W directive.\r
   Default N=0-0 (no line-numbers).\r
\r
P=n Specify spacing between Procedure and Function declarations.\r
   The P directive determines the number of blank lines to be placed\r
   between procedure and function declarations. N>2 makes procedures\r
   and functions visually stand out.\r
   Default: P=2.\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 9▶02◀\r
\r
R=x-y Specify Read margins.\r
   The R directive indicates which columns are significant when Format\r
   reads from input file. R allows PASCFORM to accept files which have\r
   line-numbers in the first (x-1) columns or after the yth column.\r
   Default: R=1-140 (large enough to read to end-of-line in most cases).\r
\r
S=n  Specify Statement separation.\r
   The S directive determines the number of spaces between statements\r
   bunched on the same line by the use of the B+ directive. Note that\r
   this directive is only in effect if B+ is used.\r
   Default: S=3.\r
\r
W=x-y Specify Write margins.\r
   The w directive indicates which columns are used for writing the \r
   reformatted program on the outputfile. Any line-numbers generated\r
   (N directive) are written outside these margins.\r
   Default:  W=1-72.\r
.PA\r
         ▶02◀PASCFORM Pascal Source Code Formatter▶02◀            ▶02◀Page 10▶02◀\r
 \r
\r
*** END OF PASCFORM HELP FILE ***\r
«eof»
DataMuseum.dk

DANOSI

⟦c62b7c9df⟧ TextFile

Derivation

TextFile
