home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 351.lha / ProcCheck_v1.1 / ProcCheck.doc < prev    next >
Encoding:
Text File  |  1990-03-09  |  3.5 KB  |  54 lines
  1.  
  2.   ProcCheck is public domain. Use it any way you see fit, but please  
  3.   leave my name and E-Mail address in both the source code and        
  4.   executables throughout all revisions. If you make any enhancements, 
  5.   I would appreciate hearing about it. Thank you.                     
  6.                                     
  7.                                                                       
  8.   ProcCheck.mod   V1.0 (12-Sept-1989) by David Czaya                  
  9.                   V1.1 (15-Feb-1990)  cleaned up a bit and tried      
  10.                                       to make the code semi-generic   
  11.                                       for portability.                
  12.                                                                       
  13.                                 E-mail: CIS 73445,407                 
  14.                                         PeopleLink -Dave-             
  15.                                         GEnie DCzaya                  
  16.                                                                       
  17.   Originally written in "Benchmark Modula 2" for the Amiga! I tried   
  18.   to use standard Modula 2 procedures (with certain exceptions) so    
  19.   that this code could be easily ported to other implementations and  
  20.   machines. Most machine specifics are marked.                        
  21.                                     
  22.                                                                       
  23.    ProcCheck (PROCEDURE CHECK) is a PRE-COMPILE utility which         
  24.    scans through Modula 2 source code and attempts to pick out all    
  25.    the procedures that have been referenced. It then divides the      
  26.    procedures into the following categories:                          
  27.                                                                       
  28.    1) Undeclared Procedures - very useful before compiling. Tells     
  29.       you which procedures have been used, but not IMPORTed or        
  30.       defined.                                                        
  31.                                                                       
  32.    2) Unused Procedures - shows procedures which have been IMPORTed   
  33.       or defined, but never called. Excellent for cleaning up the     
  34.       code.                                                           
  35.                                                                       
  36.    3) Standard Identifiers, Internal procedures and IMPORTed          
  37.       procedures are all identified and the number of calls made to   
  38.    each is recorded. This is handy for optimizing your code. You can  
  39.    tell at a glance whether certain procedures are being overworked,  
  40.    etc.                                                               
  41.                                                                       
  42.    One of these days, I might make it parse out internal variables, 
  43.    constants, enumerations, etc. Let me know if you're interested.               
  44.                                                                       
  45.    Oh, and it timestamps the report file, of course.                  
  46.                                     
  47.                                                                       
  48.   Caveats: ProcCheck is not the greatest code parser in the world.    
  49.            It's not too difficult to confuse it into picking up or    
  50.            missing information depending on your style of writing.    
  51.            Nevertheless, it's output is not critical and it should    
  52.            be somewhat useful.                                        
  53.                                     
  54.