home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / metric / mccabe.me < prev    next >
Encoding:
Text File  |  1988-05-03  |  4.9 KB  |  118 lines
  1.  
  2. To build the McCabe tool:
  3.  
  4.  1. Compile all the abstractions into a program library (see READ.ME in
  5.     abstractions directory for details).
  6.  
  7.  2. Compile everything named in the MCCABE.CO file into the program library
  8.     containing the abstractions or a sublibrary whose parent library contains 
  9.     all the abstractions.  MCCABE.CO lists file names in the correct 
  10.     compilation order.
  11.  
  12.  3. Link McCabe with the program library where everything was compiled.
  13.     To do this using the DEC Ada compiler type:
  14.  
  15.     $ acs link mccabe
  16.  
  17. To run the tool on VMS:
  18.  
  19.  1. Define logical symbol for the executables of the McCabe tool.
  20.     For example,
  21.  
  22.     MCCABE :== $DRB1:[NOSC.TOOLS.MCCABE]MCCABE.EXE
  23.  
  24.      NOTE: The full path name of the executable is required in the 
  25.      definition of the symbol.   The pathname given here is just an
  26.      example and will be different on your system.
  27.  
  28.  2. Enter a command with appropriate parameters.  For example,
  29.  
  30.     MCCABE ("myfile");
  31.  
  32.     Entering the command with no parameters gives a brief description
  33.     of how to use the tool.
  34.  
  35. Files contained in the MCCABE directory:
  36.  
  37. MCCABE.CO  -- Compilation order for McCabe sources
  38. MCCABE.EXE -- VMS 4.0 McCabe executable
  39. MCCABE.CNT -- Ada source statement count
  40. READ.ME    -- This file
  41.  
  42. The [.SOURCE] subdirectory contains most of the sources that make up the 
  43. McCabe tool.  Other sources are contained in the abstractions directory.
  44.  
  45. Files in [.SOURCE]:
  46.  
  47.     The source files which make up the McCabe tool are as follows:
  48.  
  49. MCCGRMCON.SPC    -- Grammar constants spec (generated from grammar)
  50. MCCPTBLS.SPC    -- Parser tables spec (generated from grammar)
  51. MCCLEXIDV.SPC    -- Lex ID Values (generated from grammar)
  52. MCCPDECLS.SPC    -- Parser Declarations spec (generated from grammar)
  53. MCCLEX.SPC    -- Lexer spec (generated from grammar)
  54. MCCLEX.BDY    -- Lexer body (generated from grammar)
  55. MCCWRITEL.SUB    -- Lexer subunit to list a source line -- this is a null
  56.            procedure for mcCabe
  57. MCCPTBLS.BDY    -- Parser tables body (generated from grammar)
  58. MCCSTATES.SPC    -- Parser state stack spec (generated from grammar)
  59. MCCSTATES.BDY    -- Parser state stack body (generated from grammar)
  60. MCCPDECLS.BDY    -- Parser declarations body (generated from grammar)
  61. MCCPARSES.SPC    -- Parse stack spec (generated from grammar)
  62. MCCPARSES.BDY    -- Parse stack body (generated from grammar)
  63. MCCLEXIDV.BDY    -- Lexer ID values body (generated from grammar)
  64. MCCGRMCON.BDY    -- Grammar constants body (generated from grammar)
  65. MCCDEFS.SPC    -- McCabe global definitions
  66. GETNEXT.SUB    -- Comment filter
  67. MCCPARSER.SPC    -- Parser spec (generated from grammar)
  68. MCCSTK.SPC    -- McCabe stack spec
  69. PARSE.BDY    -- Parser body 
  70. FLOWGRAPH.SPC    -- McCabe flow graph handling package (spec)
  71. STATEMENT.SPC    -- Ada statement processing (spec)
  72. MCCAPPLY.SUB    -- Grammar action routines (generated from grammar)
  73. STATEMENT.BDY    -- Statement processing (body)
  74. MCCSTK.BDY    -- McCabe stack body
  75. FLOWGRAPH.BDY    -- McCabe flow graph handling package (body)
  76. MCCABE.ADA    -- McCabe driver program
  77.  
  78. The [.TEST] subdirectory contains tests used in testing the mccabe tool.
  79.  
  80. Files in [.TEST]:
  81.  
  82.     TMCCABE.COM  -- COM file to run all test for McCabe tool
  83.     CHECKOUT.COM -- COM file to compare old result with the new 
  84.                     (after running TMCCABE.COM)
  85.     CLEANUP.COM  -- COM file to clean the [.TEST] directory
  86.  
  87. Files with file type .TST are inputs to the McCabe test.
  88.  
  89.     EXCEPT.TST    LABS.TST      LABS2.TST     LABS4.TST     LABS5.TST
  90.     LABS6.TST     LOOP.TST      MLABS.TST     MLABS5.TST    MLABS6.TST
  91.     SELECT.TST    SELECT1.TST   SELECT3.TST   TEST1.TST     TEST10.TST
  92.     TEST10A.TST   TEST11A.TST   TEST12.TST    TEST13.TST    TEST17.TST
  93.     TEST18.TST    TEST2.TST     TEST21.TST    TEST22.TST    TEST23.TST
  94.     TEST24.TST    TEST3.TST     TEST4.TST     TEST5.TST     TEST6.TST
  95.     TEST7.TST     TEST7A.TST    TEST8.TST     TEST9.TST
  96.  
  97. Files with file type .RPT are expected results of the McCabe test.
  98.  
  99.     EXCEPT.RPT    LABS.RPT      LABS2.RPT     LABS4.RPT     LABS5.RPT
  100.     LABS6.RPT     LOOP.RPT      MLABS.RPT     MLABS5.RPT    MLABS6.RPT
  101.     SELECT.RPT    SELECT1.RPT   SELECT3.RPT   TEST1.RPT     TEST10.RPT
  102.     TEST10A.RPT   TEST11A.RPT   TEST12.RPT    TEST13.RPT    TEST17.RPT
  103.     TEST18.RPT    TEST2.RPT     TEST21.RPT    TEST22.RPT    TEST23.RPT
  104.     TEST24.RPT    TEST3.RPT     TEST4.RPT     TEST5.RPT     TEST6.RPT
  105.     TEST7.RPT     TEST7A.RPT    TEST8.RPT     TEST9.RPT
  106.  
  107. The [.DOC] subdirectory contains the documentation for the McCabe tool.
  108.  
  109. Files in [.DOC]:
  110.  
  111.     MCCABE.MEM   -- McCabe tool user's manual
  112.     MCCABE.RNO   -- Runoff input for McCabe tool user's manual
  113.     MCCGRM.LIS   -- Listing of requirements reference grammar.  The rule 
  114.                     numbers in this file may be used to make changes to the
  115.                     case statement in the MCC_APPLY_ACTIONS subunit.
  116.     RELEASE.NTS  -- Release notes
  117.  
  118.