home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / style / stndread.me < prev    next >
Encoding:
Text File  |  1988-05-03  |  3.8 KB  |  102 lines
  1. To build the standards checker 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 STANDARDS.CO file into the program 
  7.     library containing the abstractions or a sublibrary whose parent 
  8.     library contains all the abstractions.  STANDARDS.CO lists file names 
  9.     in the correct compilation order.
  10.  
  11.  3. Link stndcheck with the program library where everything was 
  12.     compiled.  To do this using the DEC Ada compiler type:
  13.     $ acs link stndcheck
  14.  
  15. To run the tool on VMS:
  16.  
  17.  1. Define a logical symbol for the executable of stndcheck
  18.     For example,
  19.  
  20.     check :== $$DRB1:[NOSC.TOOLS.STANDARDS]STNDCHECK.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.     check ( Source=>"filename" [, Output=>"output_file"] 
  29.            [,Print=>print_type] [, 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.     check ( Source=> "testfile.ada", Print=>SOURCE);
  37.  
  38.   -- In this example the input file to be checked is testfile.ada and
  39.   -- the output will go to the default output.  The report will be
  40.   -- the source combined with the violation warnings, and all violations
  41.  
  42.     check ( Source=> "foo.ada", Output=>"report.out", Report=>FIRST);
  43.  
  44.   -- This example shows a source file of foo.ada with the report being
  45.   -- put in the file report.out.  The report will show only the violations
  46.   -- without the source code and only the first of each type of 
  47.   -- violation will be reported
  48.  
  49. Files contained in this directory:
  50.  
  51. STANDARDS.CO   -- Compilation order for standards checker sources
  52. STANDARDS.EXE  -- VMS 4.0 standards checker executable
  53.  
  54. The [.SOURCE] subdirectory contains most of the sources that make up the 
  55. standards checker tool.  Other sources are contained in the abstractions
  56. directory.
  57.  
  58. Files in [.SOURCE]:
  59.  
  60. The source files that make up the standards checker tool are as follows:
  61.  
  62. STNDCHECK.ADA     -- the driver which deals with the command line, and 
  63.         -- main procedure
  64. SCUTILS.SPC    -- the procedures which control the actions done by the parser
  65. SCUTILS.BDY
  66. SCDECLS.DAT    -- the package which contains all the structures to 
  67.         -- customize the checker
  68.  
  69. The tool runs using the parser.  Most of the sources needed for the parser 
  70. are in the parser abstraction.  The five units that are unique to this tool
  71. are below:
  72.  
  73. APPLYACT.SUB  -- A subunit of the parser which calls the action routines.
  74. GETNEXT.SUB   -- A subunit of the lexer which gets each token and only
  75.           -- returns non comment tokens to the lexer.
  76. PTBLS.BDY     -- The parse tables body.
  77. GRMCONST.BDY  -- Grammar constants for the parse tables.
  78. WRITELINE.SUB -- Writes a line of source code out as it's read in when
  79.           -- print=>source
  80.  
  81. The [.TEST] subdirectory contains the tests used in testing standards checker 
  82.  
  83. Files in [.TEST]:
  84.  
  85. Test this tool using the acvc a tests.
  86. The only construct not tested by the acvcs is a code statement and
  87. for that there is the file code.tst.
  88.  
  89. The [.DOC] subdirectory contains the documentation for standards checker.
  90.  
  91. Files in [.DOC]:
  92.  
  93.     USERMAN.MEM  -- Standards checker user's manual
  94.     USERMAN.RNO  -- Runoff input for user's manual
  95.     RELEASE.NTS  -- Release notes
  96.     STDCKGRM.LIS -- Listing of standards checker grammar.  The rule numbers
  97.                     in this file may be used to make changes to the case
  98.                     statement in the Apply_Actions subunit.
  99.     STANDARDS.CNT-- Statement counts and line counts of standards checker 
  100.                     source files.
  101.  
  102.