home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / style / checkrd.me < prev    next >
Encoding:
Text File  |  1988-05-03  |  4.0 KB  |  172 lines
  1. The Ada STYLE CHECKER
  2. AAREADME file
  3.  
  4. This is a brief introduction to the STYLE CHECKER tool.  The tool is
  5. contained here in three subdirectories whose structures are described
  6. below.
  7.  
  8. INSTALLATION
  9.   The installation instructions are imbedded in the HELP file.  Unfortunately
  10. the HELP system runs under the STYLE-CHECKER so you cannot 'browse' help
  11. until the system is in operation.  Print the STYLE_HELP.INI file and
  12. read the installation instructions.  Basically this involves changing
  13. two file names, rewriting the invoking command procedure for your host
  14. command language, and recompiling.
  15.  
  16. INVOKING
  17.   To invoke the tool, type
  18. STYLE filename[, filename]
  19. or
  20. STYLE ? to invoke style help.
  21.  
  22. MAINTENANCE
  23.     Maintenance is described in the maintenance manual contained in the DOC
  24. subdirectory
  25.  
  26.  
  27. Directories
  28.  
  29. _____________________________WITHIN THE [.DOC] SUBDIRECTORY_________
  30.  
  31. MAINTMAN.MEM
  32.  
  33. _____________________________WITHIN THE [.SRC] SUBDIRECTORY_________
  34.  
  35.         The sources - listed in compilation order
  36.  
  37. --
  38. --    Compilation order for STYLE_CHECKER
  39. --
  40. --
  41. --    DYN (dynamic string) package (specification and body)
  42. dyn.ada
  43. --    FILE_HANDLING package specification
  44. file_spec.ada
  45. --    TOKENIZER package specification
  46. tokenizer_spec.ada
  47. --    STYLE_PARAMETERS package specification
  48. style_param_spec.ada
  49. --    REPORT_GENERATOR package specification
  50. report_gen_spec.ada
  51. --    STACK_PACKAGE package (specification and body)
  52. stack_package.ada
  53. --    two packages from spelling checker
  54. --       TOKEN_DEFINITION package (specification and body)
  55. token_definition.ada
  56. --       MANAGER package (specification and body)
  57. manager.ada
  58. --    HELP package specification
  59. help_file_spec.ada
  60. --    COMMAND_LINE_HANDLER package (specification and body)
  61. command_line.ada
  62. --    HELP_UTILITY packages
  63. HELP_SPEC.ADA
  64. HELP_BODY.ADA
  65. HELP_DIS_ALL.ADA
  66. HELP_EXIT.ADA
  67. HELP_FIND.ADA
  68. HELP_GET.ADA
  69. HELP_INIT.ADA
  70. HELP_ME.ADA
  71. HELP_MENU.ADA
  72. HELP_PROMPT.ADA
  73. HELP_RESET.ADA
  74. HELP_TEXT.ADA
  75. --
  76. --
  77. -- And now the bodies...
  78. --
  79. --    HELP package body
  80. help_file_body.ada
  81. --    FILE_HANDLING package body
  82. file_body.ada
  83. --    TOKENIZER package body and all its seperate files
  84. tokenizer_body.ada
  85. insert.ada
  86. is_a_reserved_word.ada
  87. reserved_word.ada
  88. next_character.ada
  89. next_identifier.ada
  90. build_tokens.ada
  91. line_containing.ada
  92. tree_root.ada
  93. --    STYLE_PARAMETERS package body
  94. style_param_body.ada
  95. --    REPORT_GENERATOR package body
  96. report_gen_body.ada
  97. --    Main procedure (STYLE_CHECKER) and all its seperate files
  98. style_checker.ada
  99. begin_of_line_indent.ada
  100. check_statements.ada
  101. check_end_of_blocks.ada
  102. check_the_style.ada
  103. check_for_attribute.ada
  104. check_object_names.ada
  105. check_universal.ada
  106. comment_token.ada
  107. current_token.ada
  108. entering_block.ada
  109. entering_sub_block.ada
  110. exiting_block.ada
  111. get_next_token.ada
  112. is_statement.ada
  113. literal.ada
  114. new_line_token.ada
  115. non_trivial_token.ada
  116. object_name.ada
  117. reserve_word.ada
  118. search_backward.ada
  119. search_back_one_of.ada
  120. search_forward.ada
  121. search_fore_one_of.ada
  122. type_declaration.ada
  123.  
  124. _____________________________________________________
  125.  
  126. The support files:
  127. STYLE_HELP.INI                  The Style checker help file
  128. STYLE_CHECKER_CMP.cli           The 'compile' file.  A list of
  129.                                 the style-checker files, in
  130.                                 compile order.
  131. STYLE.CLI                       This is the command file which
  132.                                 invokes the style checker
  133.  
  134.  
  135.  
  136. _____________________________WITHIN THE [.TEST] SUBDIRECTORY_________
  137.  
  138. These are the sources for the acceptance tests, and the last run of
  139. the acceptance tests.
  140.  
  141. test1.ada
  142. test1.flw
  143. test1.sty
  144. test1a.ada
  145. test1a.flw
  146. test1a.sty
  147. test1b.ada
  148. test1b.flw
  149. test1b.sty
  150. test2.ada
  151. test2.flw
  152. test2.sty
  153. test3a.ada
  154. test3a.flw
  155. test3a.sty
  156. test4.ada
  157. test4.flw
  158. test4.sty
  159. test5.ada
  160. test5.flw
  161. test5.sty
  162. test6.ada
  163. test6.flw
  164. test6.sty
  165. test7.ada
  166. test7.flw
  167. test7.sty
  168.  
  169.   The acceptance test procedures documentation.
  170.  
  171. PROCEDURES.MEM
  172.