home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / order / coread.me < prev   
Encoding:
Text File  |  1988-05-03  |  4.7 KB  |  122 lines
  1. To build the compile order tool:
  2.  
  3.  1. Compile all the abstractions into a program library (see READ.ME in
  4.     abstractions directory for details).
  5.  
  6.  2. Compile everything named in the COMPORD.CO file into the program 
  7.     library containing the abstractions or a sublibrary whose parent 
  8.     library contains all the abstractions.  COMPORD.CO lists file names 
  9.     in the correct compilation order.
  10.  
  11.  3. Link compile_order with the program library where everything was 
  12.     compiled.  To do this using the DEC Ada compiler type:
  13.     $ acs link compile_order
  14.  
  15. To run the tool on VMS:
  16.  
  17.  1. Define a logical symbol for the executable of compile_order.
  18.     For example,
  19.  
  20.     compile_order :== $DRB1:[NOSC.TOOLS.COMPORD]COMPORD.EXE
  21.  
  22.      NOTE: The full path name of the executable is required in the 
  23.      definition of the symbol.   The pathname given here is just an 
  24.      example and will be different on your system.
  25.  
  26.  2. Enter the command with appropriate parameters.
  27.  
  28.     compile_order ( Source_list=>("test_filename") [, Output=>"output_file"] 
  29.           [, Units_File=>"unit_file"] [, Which_Report=>report_type] );
  30.  
  31.     Entering the command compile_order with no parameters gives a brief
  32.     description of how to use the tool.
  33.  
  34.     For example,
  35.  
  36.     compile_order ( Source_List=>("test1.tst"), Which_Report=>raw);
  37.  
  38.  -- In this case the input file is test1.tst, and the output will go to the
  39.  -- default output.  The report will be in raw form.
  40.  -- More than one file is allowed in the Source_List, as are wildcards.
  41.  
  42.     compile_order ( Source_List=>("test1.tst", "test.*"), Output=>"report.rpt")
  43.  
  44.  -- In this case there are a list of files for input and the report defaults
  45.  -- to be in full format.
  46.  
  47. Files contained in this directory:
  48.  
  49. COMPORD.CO   -- Compilation order for compile order sources
  50. COMPORD.EXE  -- VMS 4.0 compile order executable
  51.  
  52. The [.SOURCE] subdirectory contains most of the sources that make up the 
  53. compile order tool.  Other sources are contained in the abstractions
  54. directory.
  55.  
  56. Files in [.SOURCE]:
  57.  
  58. The source files that make up the compile order tool are as follows:
  59.  
  60. CDRIVER.ADA -- the driver which deals with the command line
  61. COMPORD.SPC -- the main procedure of the program
  62. COMPORD.BDY
  63. CMPUTIL.SPC -- the procedures which control the actions done by the parser
  64. MPUTIL.BDY 
  65. REPORT.SPC  -- the procedures which output the reports from the information
  66. REPORT.BDY  -- gathered
  67. LOOKUP.SPC  -- the data structure and procedures for looking up additional
  68. LOOKUP.BDY  -- file information supplied in units_file.
  69. UNITDAG.SPC -- instantiations of the dags and other things used by the dags
  70.             -- like the node types, and hash function
  71. MINIDAG.SPC -- instantiation of another dag
  72. COPKG.DAT   -- global variables for the program
  73.  
  74. The tool runs using the parser.  Most of the sources needed for the parser 
  75. are in the parser abstraction.  The four units that are unique to this tool
  76. are as follows:
  77.  
  78. APPLYACT.SUB -- A subunit of the parser which calls the action routines.
  79. GETNEXT.SUB  -- A subunit of the lexer which gets each token and only
  80.          -- returns non comment tokens to the lexer.
  81. PTBLS.BDY    -- The parse tables body.
  82. GRMCONST.BDY -- Grammar constants for the parse tables.
  83.  
  84. The [.TEST] subdirectory contains the tests used in testing compile order.
  85.  
  86. Files in [.TEST]:
  87.  
  88. Test files end in the extension ".tst"
  89.  
  90. TEST1.TST:    tests wrap around by nesting withs very deeply.
  91. TEST2.TST:    tests handling of a syntax error.
  92. TEST3.TST:    has no errors tests normal operation.
  93. TEST4.TST:    tests handling of separate bodies and inlines.
  94. TEST5.TST:    tests the handling of incorrect order within a file.
  95. TEST6.TST:    tests handling of a cycle between units.
  96. TEST7.TST:      test7, and test8 together test units having the
  97. TEST8.TST:        same name.
  98. CYCLE1.TST:    together with fcycle2 tests handling of a cycle
  99. FCYCLE2.TST:      between files.
  100.  
  101. The result files that were generated have an extension ".rpt"
  102. Report files using everything other than full report format were
  103. generated from test3.tst (the normal input).
  104. These are: raw.rpt, depend.rpt, rawdep.rpt, comp.rpt, rawcomp.rpt,
  105. file.rpt, units.rpt.
  106.  
  107. In the cases of files which tested errors the output files may be empty or
  108. incomplete.
  109.  
  110. The [.DOC] subdirectory contains the documentation for compile order.
  111.  
  112. Files in [.DOC]:
  113.  
  114.     USERMAN.MEM -- Compile order user's manual
  115.     USERMAN.RNO -- Runoff input for user's manual
  116.     RELEASE.NTS -- Release notes
  117.     COMPGRM.LIS -- Listing of compile order grammar.  The rule numbers
  118.                    in this file may be used to make changes to the case
  119.                    statement in the Apply_Actions subunit.
  120.     COMPORD.CNT -- Statement counts and line counts of compile order 
  121.                    source files.
  122.