home *** CD-ROM | disk | FTP | other *** search
Text File | 1988-05-03 | 73.4 KB | 2,456 lines |
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
- --read.me
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
- To build the compile order tool:
-
- 1. Compile all the abstractions into a program library (see READ.ME in
- abstractions directory for details).
-
- 2. Compile everything named in the COMPORD.CO file into the program
- library containing the abstractions or a sublibrary whose parent
- library contains all the abstractions. COMPORD.CO lists file names
- in the correct compilation order.
-
- 3. Link compile_order with the program library where everything was
- compiled. To do this using the DEC Ada compiler type:
- $ acs link compile_order
-
- To run the tool on VMS:
-
- 1. Define a logical symbol for the executable of compile_order.
- For example,
-
- compile_order :== $DRB1:[NOSC.TOOLS.COMPORD]COMPORD.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.
-
- compile_order ( Source_list=>("test_filename") [, Output=>"output_file"]
- [, Units_File=>"unit_file"] [, Which_Report=>report_type] );
-
- Entering the command compile_order with no parameters gives a brief
- description of how to use the tool.
-
- For example,
-
- compile_order ( Source_List=>("test1.tst"), Which_Report=>raw);
-
- -- In this case the input file is test1.tst, and the output will go to the
- -- default output. The report will be in raw form.
- -- More than one file is allowed in the Source_List, as are wildcards.
-
- compile_order ( Source_List=>("test1.tst", "test.*"), Output=>"report.rpt")
-
- -- In this case there are a list of files for input and the report defaults
- -- to be in full format.
-
- Files contained in this directory:
-
- COMPORD.CO -- Compilation order for compile order sources
- COMPORD.EXE -- VMS 4.0 compile order executable
-
- The [.SOURCE] subdirectory contains most of the sources that make up the
- compile order tool. Other sources are contained in the abstractions
- directory.
-
- Files in [.SOURCE]:
-
- The source files that make up the compile order tool are as follows:
-
- CDRIVER.ADA -- the driver which deals with the command line
- COMPORD.SPC -- the main procedure of the program
- COMPORD.BDY
- CMPUTIL.SPC -- the procedures which control the actions done by the parser
- MPUTIL.BDY
- REPORT.SPC -- the procedures which output the reports from the information
- REPORT.BDY -- gathered
- LOOKUP.SPC -- the data structure and procedures for looking up additional
- LOOKUP.BDY -- file information supplied in units_file.
- UNITDAG.SPC -- instantiations of the dags and other things used by the dags
- -- like the node types, and hash function
- MINIDAG.SPC -- instantiation of another dag
- COPKG.DAT -- global variables for the program
-
- The tool runs using the parser. Most of the sources needed for the parser
- are in the parser abstraction. The four units that are unique to this tool
- are as follows:
-
- APPLYACT.SUB -- A subunit of the parser which calls the action routines.
- GETNEXT.SUB -- A subunit of the lexer which gets each token and only
- -- returns non comment tokens to the lexer.
- PTBLS.BDY -- The parse tables body.
- GRMCONST.BDY -- Grammar constants for the parse tables.
-
- The [.TEST] subdirectory contains the tests used in testing compile order.
-
- Files in [.TEST]:
-
- Test files end in the extension ".tst"
-
- TEST1.TST: tests wrap around by nesting withs very deeply.
- TEST2.TST: tests handling of a syntax error.
- TEST3.TST: has no errors tests normal operation.
- TEST4.TST: tests handling of separate bodies and inlines.
- TEST5.TST: tests the handling of incorrect order within a file.
- TEST6.TST: tests handling of a cycle between units.
- TEST7.TST: test7, and test8 together test units having the
- TEST8.TST: same name.
- CYCLE1.TST: together with fcycle2 tests handling of a cycle
- FCYCLE2.TST: between files.
-
- The result files that were generated have an extension ".rpt"
- Report files using everything other than full report format were
- generated from test3.tst (the normal input).
- These are: raw.rpt, depend.rpt, rawdep.rpt, comp.rpt, rawcomp.rpt,
- file.rpt, units.rpt.
-
- In the cases of files which tested errors the output files may be empty or
- incomplete.
-
- The [.DOC] subdirectory contains the documentation for compile order.
-
- Files in [.DOC]:
-
- USERMAN.MEM -- Compile order user's manual
- USERMAN.RNO -- Runoff input for user's manual
- RELEASE.NTS -- Release notes
- COMPGRM.LIS -- Listing of compile order grammar. The rule numbers
- in this file may be used to make changes to the case
- statement in the Apply_Actions subunit.
- COMPORD.CNT -- Statement counts and line counts of compile order
- source files.
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
- --userman.mem
- --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::