home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PASCAL / T_REF.ZIP / T-REFHDR.DOC < prev   
Encoding:
Text File  |  1987-01-15  |  9.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.      TTTTTTTTTTT          RRRRRRRRRRRR     EEEEEEEEEEEE   FFFFFFFFFFFF
  14.          TTT               RRR      RRR     EEE       E    FFF       F
  15.          TTT               RRR       RRR    EEE            FFF
  16.          TTT               RRR      RRR     EEE            FFF
  17.          TTT     *******   RRRRRRRRRRR      EEEEEEE        FFFFFFF
  18.          TTT               RRR   RRR        EEE            FFF
  19.          TTT               RRR    RRR       EEE            FFF
  20.          TTT               RRR     RRR      EEE       E    FFF
  21.         TTTTT             RRRRR     RRRR   EEEEEEEEEEEE   FFFFF      (TM)
  22.  
  23.                     VERSION 1.0 - PUBLIC DOMAIN RELEASE
  24.  
  25.  
  26.  
  27.                A SOURCE LISTING AND CROSS REFERENCING PROGRAM
  28.  
  29.                               FOR TURBO PASCAL
  30.  
  31.  
  32.  
  33.             COPYRIGHT (C)  1986 BY SYNERGY SOFTWARE OF NEBRASKA
  34.  
  35.  
  36.             ALL PORTIONS OF T-REF, IN WHOLE OR IN PART, ARE THE
  37.               SOLE OWNERSHIP OF SYNERGY SOFTWARE OF NEBRASKA.
  38.  
  39.  
  40.            THIS PROGRAM AND DOCUMENTATION EDITION MAY BE FREELY
  41.            COPIED AND DISTRIBUTED WITHOUT FURTHER AUTHORIZATION
  42.            OR REQUEST FROM SYNERGY SOFTWARE OF NEBRASKA AS LONG
  43.            AS COPYRIGHT NOTICE AND DISCLAIMERS ARE REPRODUCED IN
  44.             FULL.  IF SOLD, THIS PRODUCT MAY NOT EXCEED $10 IN
  45.            COST TO THE PURCHASEE.  SYNERGY SOFTWARE OF NEBRASKA
  46.            RESERVES *ALL* OTHER RIGHTS OF THIS PROGRAM PACKAGE.
  47.  
  48.  
  49.                                Disclaimer
  50.  
  51. T-Ref is supplied as is and the author disclaims all warranties,  expressed or
  52. implied, including, without limitation,  the warranties of merchantability and
  53. the warranties of fitness for any purpose.
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                         Table of Contents
  71.  
  72.  
  73.     Preface . . . . . . . . . . . . . . . . . . . . . . . . . .   i
  74.     System Requirements . . . . . . . . . . . . . . . . . . . .  ii
  75.     Assumptions . . . . . . . . . . . . . . . . . . . . . . . .  ii
  76.     Limitations . . . . . . . . . . . . . . . . . . . . . . . .  ii
  77.  
  78. Chapter I - About T-Ref
  79.     What T-Ref can do . . . . . . . . . . . . . . . . . . . . .   1
  80.     The Main Screen . . . . . . . . . . . . . . . . . . . . . .   2
  81.     The Pop-Up Help Windows . . . . . . . . . . . . . . . . . .   4
  82.  
  83. Chapter II - The Source Listing
  84.     Reserve Words . . . . . . . . . . . . . . . . . . . . . . .   6
  85.     Identifiers . . . . . . . . . . . . . . . . . . . . . . . .   6
  86.     Line Numbering. . . . . . . . . . . . . . . . . . . . . . .   6
  87.     Lexical Level Numbering . . . . . . . . . . . . . . . . . .   7
  88.     Block Numbering . . . . . . . . . . . . . . . . . . . . . .   8
  89.     Displaying the Active Procedures/Functions. . . . . . . . .   8
  90.     Header. . . . . . . . . . . . . . . . . . . . . . . . . . .   9
  91.     Page Numbering. . . . . . . . . . . . . . . . . . . . . . .   9
  92.     Include Files . . . . . . . . . . . . . . . . . . . . . . .  10
  93.  
  94. Chapter III - The Cross Reference Listing
  95.     System Identifiers. . . . . . . . . . . . . . . . . . . . .  11
  96.     Data Types. . . . . . . . . . . . . . . . . . . . . . . . .  11
  97.     Basic Types . . . . . . . . . . . . . . . . . . . . . . . .  11
  98.     Cross Reference Lister. . . . . . . . . . . . . . . . . . .  12
  99.     Header. . . . . . . . . . . . . . . . . . . . . . . . . . .  12
  100.     Page Numbering. . . . . . . . . . . . . . . . . . . . . . .  12
  101.     Include Files . . . . . . . . . . . . . . . . . . . . . . .  13
  102.     Interpreting the Listing. . . . . . . . . . . . . . . . . .  14
  103.  
  104. Chapter IV - Other Features of T-Ref
  105.     Page Headers for the Listings . . . . . . . . . . . . . . .  17
  106.     Page Numbering. . . . . . . . . . . . . . . . . . . . . . .  17
  107.     Setting the Source Width. . . . . . . . . . . . . . . . . .  17
  108.     Setting the Page Length . . . . . . . . . . . . . . . . . .  18
  109.     Saving the Updated Parameters . . . . . . . . . . . . . . .  18
  110.  
  111. Chapter V - Using T-Ref
  112.     Program Data Trimming.  . . . . . . . . . . . . . . . . . .  19
  113.     Software Versions . . . . . . . . . . . . . . . . . . . . .  19
  114.     Portability Considerations. . . . . . . . . . . . . . . . .  19
  115.  
  116. Chapter VI - T-Ref Tutor
  117.     A Step by Step Tutorial . . . . . . . . . . . . . . . . . .  21
  118.  
  119. Appendix A - T-Ref System Defined Identifiers . . . . . . . . .  25
  120.  
  121. Appendix B - T-Ref Parser Error Messages. . . . . . . . . . . .  28
  122.  
  123. Appendix C - Backus-Naur Form of T-Ref's Parser . . . . . . . .  31
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.                                 Preface
  137.  
  138.      We  at Synergy Software of Nebraska have been involved with the  develop-
  139. ment of specialized Turbo  Pascal programs for some time.   These programs may
  140. be as short as several hundred lines of source code, or as long as 15000 lines
  141. and  more,  requiring several man-years to complete.   Furthermore,  we update
  142. these  programs on a regular basis,  producing as many as three and four  ver-
  143. sions in a single year.   Such maintenance requires extensive documentation of
  144. the source code.
  145.      However,  we  have discovered that even the most  extensively  documented
  146. code  neglects the primal flow of data and overall structure of the  programs.
  147. It  became  evident  to us that cross reference listings  were  imperative  to
  148. complete  the  crucial link between finalizing development and pursuing  main-
  149. tenance of a program.
  150.      T-Ref  was  borne  out  of more than just a need  for  a  detailed  cross
  151. referencing  program.   It  had  to  be  one  that  would  provide  an  almost
  152. "intelligent"  flexibility  and  selectivity.
  153.      In addition,  T-Ref had to have its own source lister program to work  in
  154. tandom  with  the referencing program.   Only a few keystrokes will get you  a
  155. quality  source  listing document (with page  headers,  line  numbering,  page
  156. numbering, and more) or an updated, usable source listing.
  157.      The enclosed  program is NOT a demo disk.  It is a fully operatable pack-
  158. age.  We believe the quality of  the program (both  user interface and output)
  159. exceeds any  program of its kind:  ESPECIALLY those found for as much as $100.
  160. We are marketing T-REF through the  user supported software concept because we
  161. believe a program's capabilities  should speak for  itself.   Of course, there
  162. is a savings for the user since we have little overhead; you pay primarily for
  163. the software and NOT for advertisements.
  164.      Make no mistake,  we are  committed to continuing  its development and to
  165. insuring a  bug-free program.  The file  "T-REF.UPD" is a text file containing
  166. all proposed  modifications to T-REF  over the next year.  The list may change
  167. slightly as items are added and problems corrected,  but we expect to have the
  168. program  expanded to a four-language  cross referencing package in 1988, hope-
  169. fully  with  the  support  we need from  the users to  continue this  project.
  170. Unfortunately, we  only have the  resources to dedicate our  efforts for those
  171. who support OUR time and efforts.
  172.  
  173.      As we are always looking for improvements,  write us and let us know what
  174. you think of our product.  Constructive criticism is always welcome.
  175.  
  176.  
  177.  
  178. - Thank you for your support.
  179.  
  180. Synergy Software of Nebraska
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                    i
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.                              System Requirements
  203.  
  204.      The following equipment is required to successfully run T-Ref:
  205.  
  206.           IBM-PC/XT/AT or compatible
  207.           A minimum of 256K of memory (512K - 640K is recommended)
  208.           A color (CGA) or monochrome monitor
  209.           MS-DOS Ver 2.11 (or greater) or PC-DOS Ver 2.0 (or greater)
  210.  
  211.               Assumptions made on the part of this document
  212.  
  213.      This document assumes the user has at least a  basic understanding of the
  214. operating  system  (MS-DOS  or  PC-DOS) under which  this  program  runs,  the
  215. language of Pascal,  and the extensions and limitations of Turbo  Pascal  over
  216. Standard  Pascal.   Synergy Software of Nebraska makes no guarantee that T-Ref
  217. will  successfully list and cross reference Pascal programs  not  specifically
  218. written  for or under consideration of Borland's Turbo  Pascal syntax descrip-
  219. tion.
  220.  
  221.               Limitations set by this version of T-Ref are:
  222.  
  223.      a.  The  maximum   length  of  an identifier is  20  characters.   If  an
  224.          identifier is longer than 20 characters, only the first 20 are saved.
  225.  
  226.      b.  The maximum number of columns on the input file is 132 characters.
  227.  
  228.      c.  The maximum number of columns on the output file is 200 characters.
  229.  
  230.      d.  The maximum length of a string is 130 characters.
  231.  
  232.      e.  The maximum lexical level depth is 20.
  233.  
  234.      f.  Page headers are limited to 5 lines by 75 columns each.
  235.  
  236.      g.  The  input  file's  size is limited only by the memory  available  to
  237.          store  referenced  identifiers and the disk space available to  store
  238.          the output file.   We have found that 320K of memory is sufficient to
  239.          handle as much as 1000 identifiers, having 20 to 40 references each.
  240.  
  241.      h.  A  cross reference listing of  identifiers will include both  identi-
  242.          fiers  specifically DECLARED within the scanning process of the  pro-
  243.          gram  as  well  as  those  NOT  declared.   However,  for  undeclared
  244.          identifiers,  T-Ref  makes no attempt to determine the basic type  or
  245.          data  type associated with the identifier (see Chapter  III).   Unde-
  246.          fined typed identifiers will always be printed in the cross reference
  247.          listing, since its type is unknown.
  248.  
  249. There is no limitation on the number of times an identifier can be referenced.
  250.  
  251.      Turbo Pascal is a trademark of Borland International, Inc;
  252.      IBM PC/XT/AT and PC-DOS are trademarks of International Business Machines
  253. Corp;
  254.      MS-DOS is a trademark of Microsoft Corp.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                   ii
  262.  
  263.  
  264.  
  265.