home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / INFO / TURBOPAS / TURBOPR2.ZIP / TURBOPR2.DOC < prev    next >
Encoding:
Text File  |  1985-11-06  |  6.5 KB  |  127 lines
  1. TURBOPR2.DOC
  2. DOCUMENTATION FILE for TURBOPR2.PAS
  3. 11/6/85
  4.  
  5. HISTORICAL PERSPECTIVE:
  6. As promissed in the program comments, here are the original comments from
  7. the people who wrote and modified the program before me.
  8.  .  program PLIST;
  9.  .  (*
  10.  .    Written by: Rick Schaeffer
  11.  .                E. 13611 26th Av.
  12.  .                Spokane, Wa.  99216
  13.  .  
  14.  .    modifications (7/8/84  by Len Whitten, CIS: [73545,1006])
  15.  .       1) added error handling if file not found
  16.  .       2) added default extension of .PAS to main & include files
  17.  .       3) added "WhenCreated" procedure to extract file
  18.  .          creation date & time from TURBO FIB
  19.  .       4) added demarcation of where include file ends
  20.  .       5) added upper char. conversion to include file
  21.  .       6) increased left margin to 5 spaces (80 char. line just fits @ 10cpi)
  22.  .       7) added listing control: {.L-} turns it off, {.L+} turns it back on,
  23.  .          must be in column 1
  24.  .       
  25.  .    further modifications (7/12/84 by Rick Schaeffer)
  26.  .       1) cleaned up the command line parsing routines and put them in
  27.  .          separate procedures.  Now permits any number of command line
  28.  .          arguments, each argument separated with at least one space.
  29.  .       2) added support for an optional second command line parameter
  30.  .          which specifies whether include files will be listed or not.
  31.  .          The command is invoked by placing "/i" on the command line
  32.  .          at least one space after the file name to be listed.  For
  33.  .          instance, to list MYPROG.PAS as well as any "included" files,
  34.  .          the command line would be: PLIST MYPROG /I
  35.  .  
  36.  .     further modification (8/28/84) by Jay Kadashaw)
  37.  .        1) Restored filedate and filetime after listing an included
  38.  .           file.
  39.  .        2) Added comment counter and begin/end counter.
  40.  .        3) Output can be routed to either the printer or console.
  41.  .        4) After listing first file the user is prompted for next
  42.  .           file if any.
  43.  .  
  44.  .     Still more modifications! (10/30/84) by Michael Roberts
  45.  .           1) Cleaned Up various problems I encountered
  46.  .           2) Removed Comment counter in order to add line numbers
  47.  .           3) Added Cross-Referencing facility
  48.  .              a) IMPORTANT!! Make sure when you create COM file you assign
  49.  .                 The minimum segment sizes given in a MEM compile
  50.  .                 (Particularly allow a minimum Stack Size Of 1300)
  51.  .              b) The file 'TURBOPAS.RES' contains the reserved words for
  52.  .                 the TURBO Pascal compiler release 2.0.  If new reserved
  53.  .                 words are implemented in future releases, add the new
  54.  .                 words to this file.
  55.  .  
  56.  .              Please let me know if you run into any problems!
  57.  .                     Michael Roberts  [CIS 74226,3045]
  58.  .                     3103 Glenview
  59.  .                     Royal Oak, MI 48073
  60.  .  
  61.  .  
  62.  .  (* Supported pseudo operations:
  63.  .      1) Listing control: {.L-} turns it off, {.L+} turns it back on,
  64.  .         must be in column 1
  65.  .      2. Page ejection: {.PAGE}, must be in column 1.
  66.  .      *)
  67.  .  
  68.  .   { When program is first run will check for a file
  69.  .     name passed by DOS, and will try to open that file.  If no name is
  70.  .     passed, will ask operator for a file name to open.  Proc will tell
  71.  .     operator if file doesn't exist and will allow multiple retrys.
  72.  .  
  73.  .     Included files will be expanded only if the program is invoked as
  74.  .     follows:
  75.  .       TurboPrt filename /i
  76.  .     The default is not to expand included files.
  77.  .  
  78.  .     On 2nd and later executions, proc will not check for DOS passed file
  79.  .     name.  In all cases, proc will assume a file type of .PAS if file
  80.  .     type is not specified.
  81.  .     PROGRAM EXIT from this proc when a null string is encountered in
  82.  .     response to a file name request. }
  83.  .  
  84.  This program was downloaded from the High Sierra Bulletin Board, run by
  85.  Dave Carroll at 209-296-3534, about 10/29/85.  It was restructured to 
  86.  have more options and to expect all options on the command line.  Line
  87.  numbering was changed to correspond with input file record numbers to
  88.  make editing large programs from listings easier.  A couple of bugs were
  89.  fixed.  Allowable file names were expanded to allow for paths.  TURBOPAS.RES
  90.  was updated with IBM PC Turbo Pascal 3.0 reserved words.
  91.  
  92. GENERAL COMMENTS:
  93.  
  94.   The X option still runs slowly.  At least it is optional.  I think the
  95.   routine ScanLine could be speeded up some to help that.  I'll keep working
  96.   on it.
  97.  
  98.   The cross referencing function does not recognize the scope of identifiers.
  99.   If the same name is used in several places, all references will show up
  100.   in the same place in the listing.  It also does not recognize numeric
  101.   constants.  A constant like $0A will cause the name A to be listed in the
  102.   cross reference listing.  Also, the standard name list is used to exclude
  103.   names.  Shortening that list would cause standard names to be cross 
  104.   referenced also, as possible advantage.  Only the first twenty characters
  105.   are considered when matching identifiers, enough for most of us.
  106.  
  107.   Line numbering was changed to correspond to editor line numbers because
  108.   my prime use of listings is to make notes for later changes.  With a large
  109.   program, the real editor line numbers on the listing make it easier to find
  110.   my way around.  One problem with this when used in a cross referencing
  111.   system is that line numbers show up more than once if included files are
  112.   listed.  Usually this is tolerable.  I will be looking at changes to the
  113.   cross referencing system to add page numbers or something similar to relieve
  114.   the ambiguity.
  115.    
  116.   The original program asked the user for file names to list and other options.
  117.   I have taken that out in favor of the command line approach.  With the
  118.   ParamStr and ParamCount features of Turbo, this was too easy to pass up.
  119.  
  120.      Don Mackenzie
  121.      11065 La Paloma
  122.      Cupertino, CA  95014
  123.      11/6/85
  124.  
  125.  
  126.  
  127.