home *** CD-ROM | disk | FTP | other *** search
Text File | 1988-05-03 | 71.8 KB | 2,431 lines |
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
- --read.me
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
-
- To build the pretty printer tool:
-
- 1. Compile all the abstractions into a program library (see READ.ME in
- abstractions directory for details).
-
- 2. Compile everything named in the PRETTY.CO file into the program library
- containing the abstractions or a sublibrary whose parent library contains
- all the abstractions. PRETTY.CO lists file names in the correct compilation
- order.
-
- 3. Link Pretty_Print_Driver with the program library where everything was
- compiled. To do this using the DEC Ada compiler type:
- $ acs link pretty_printer_driver
-
- To run the tool on VMS:
-
- 1. Define a logical symbol for the executable of PRETTY_PRINT. For example,
-
- PRETTY_PRINT :== $DRB1:[NOSC.TOOLS.PRETTY]PRETTY.EXE
-
- NOTE: The full path name of the executable is required in the
- definition of the symbol. The pathname given here is just an example
- and will be different on your system.
-
- 2. Enter the command with appropriate parameters. For example,
-
- PRETTY_PRINT (SOURCE=>"test.ada", OUTPUT=>"test.out");
-
- Entering the command PRETTY_PRINT with no parameters gives a brief
- description of how to use the tool.
-
- Files contained in this directory:
-
- PRETTY.CO -- Compilation order for pretty printer sources
- PRETTY.EXE -- VMS 4.0 pretty printer executable
-
- The [.SOURCE] subdirectory contains most of the sources that make up the
- pretty printer tool. Other sources are contained in the abstractions
- directory.
-
- Files in [.SOURCE]:
-
- Most of the sources for the parser which the pretty printer tool uses are
- in the abstractions directory. The four units which are unique to this tool
- are as follows:
-
- PARSE.BDY -- The body of the parser, with a call to the Put subprogram
- which outputs Tokens
- APPLYACT.SUB -- A subunit of the parser which calls the action subprograms
- GETNEXT.SUB -- A subunit of the lexer which returns non-comment tokens
- to the lexer and buffers comments
- GRMCONST.BDY -- Grammar constants for the parse tables
- PTBLS.BDY -- The parse tables.
-
- The other source files which make up the pretty printer are as follows:
-
- PPRDECLS.DAT -- Declarations for pretty printer
- PPRUTILS.SPC -- Utilities for pretty printer, called from
- Parser.Apply_Actions (specification)
- PPRUTILS.BDY -- Utilities for pretty printer, called from
- Parser.Apply_Actions (body)
- CHANGE.SPC -- Subprograms for the manipulation of source text
- (specification)
- CHANGE.BDY -- Subprograms for the manipulation of source text (body)
- PRETTY.SPC -- Main procedure of pretty printer (specification)
- PRETTY.BDY -- Main procedure of pretty printer (body)
- DRIVER.ADA -- Decodes command line and calls Pretty_Print
-
- The [.TEST] subdirectory contains the tests used in testing the pretty printer.
- The ACVC A tests and the pretty printer sources were used in testing as well.
-
- Files in [.TEST]:
-
- ALL.IN -- Tests a variety of constructs
- ANDTHEN.IN -- Tests spacing of tokens for "and then" and "or else"
- BINOP.IN -- Tests binary vs. unary operators
- BLANKS.IN -- Tests that blanks in the source are printed
- CLOSEID.IN -- Tests that closing identifiers are printed out
- COLON.IN -- Tests that colons are lined up
- COMMENT.IN -- Tests handling off comments with formatting on and off
- DEEPIF.IN -- Tests nesting of very deep if statements
- DELIM.IN -- Tests basic vs. extended set delimiters
- DEPTH.IN -- Contains several levels of nested units to test the DEPTH
- parameter
- ERROR.IN -- Tests handling of syntax errors
- GENERIC.IN -- Tests indentation of generic specifications
- MULTIPLE.IN -- Tests multiple units in one file
- TASK.IN -- Tests task constructs
-
- The [.DOC] subdirectory contains the documentation for the pretty printer.
-
- Files in [.DOC]:
-
- USERMAN.MEM -- Pretty Printer user's manual
- USERMAN.RNO -- Runoff input for user's manual
- INSTALL.MEM -- Pretty Printer installation guide
- INSTALL.RNO -- Runoff input for installation guide
- RELEASE.NTS -- Release notes
- PPRGRM.LIS -- Listing of pretty printer grammar. The rule numbers
- in this file may be used to make changes to the case
- statement in the Apply_Actions subunit.
- PRETTY.CNT -- Statement counts and line counts of pretty printer
- source files
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
- --userman.mem
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::