home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PASCAL / TPX.ZIP / TPX.TXT < prev   
Encoding:
Text File  |  1987-03-17  |  3.8 KB  |  101 lines
  1.            ┌─────────────────────────────────────────┐
  2.            └─────────────────────────────────────────┘
  3.            ┌─────────────────────────────────────────┐
  4.            │           T       P       X             │
  5.            ├─────────────────────────────────────────┤
  6.            │              Version 1.2                │
  7.            │                                         │
  8.            │  User note's for TPX, a Turbo Pascal    │
  9.            │  cross reference.                       │
  10.            │                                         │
  11.            │                                         │
  12.            └─────────────────────────────────────────┘
  13.              Copyright 1987 by Darren K. Henderson
  14.            ┌─────────────────────────────────────────┐
  15.            └─────────────────────────────────────────┘
  16.  
  17.  
  18. I have tried quite a few public domain cross reference generators 
  19. for Turbo Pascal. Most of them had some nice features but a good 
  20. many of them were also unreliable or out-dated. The most common 
  21. problem I had was a limitation on the size and complexity of the 
  22. source code. After a certain point they could no longer generate 
  23. a cross reference.
  24.  
  25. TPX makes extensive use of dynamic memory and data structures; it 
  26. is capable of handling very large programs. It produces a 
  27. compressed listing consisting of the line number, level number, 
  28. and source code reference line. This program was written for use 
  29. with an Okidata µ92 Plug 'n Play - it may not be compatible with 
  30. some other printers. 
  31.  
  32.  
  33.                          -METHOD-
  34.  
  35. Each line of the source file is read and then parsed. When a 
  36. reference word is found, (a word not reserved by Turbo Pascal), 
  37. it is inserted in a binary tree. Each node of the tree contains a 
  38. reference word and a pointer to a linked list. The linked list 
  39. contains a node for each line on which the referenced word is 
  40. found. When the file has been completely read and parsed an in-order
  41. transversal of the binary tree is performed  and the cross 
  42. reference is listed. 
  43.  
  44.  
  45.                           -USAGE-
  46.  
  47. The command structure is as follows:
  48.  
  49.                    TPX file-name [L|X]
  50.  
  51.                           or
  52.  
  53.                    TPX ?
  54.  
  55.                    Where:
  56.  
  57.                     file-name = source file
  58.  
  59.                             X = produce only the cross reference
  60.  
  61.                             L = produce only a source listing
  62.  
  63.                             ? = display an information screen
  64.  
  65. The program also checks for the following command strings (these 
  66. must begin in column 1):
  67.  
  68.                             {%P} = force a new page
  69.  
  70.                             {%H} = stop processing until the
  71.                                    {%H} is found
  72.                                   
  73.                     {%C "string"} = set comment string. This 
  74.                                    string is printed in the 
  75.                                    header following the 
  76.                                    file name. The string is
  77.                                    specified between the 
  78.                                    quotation marks.
  79.  
  80.  
  81.                           -License-
  82.  
  83. You are free to distribute this program and documentation as a 
  84. whole. You may not sell this package or any portion there in for 
  85. profit. No guarantees are made as to the suitability, utility, or 
  86. operation of this software. I will not be held responsible for 
  87. any damages caused by the use of this software. 
  88.  
  89.  
  90. If you find this program useful please drop me a post card, 
  91. (something with a picture on it people - regular postal cards are 
  92. so boring!), it would be appreciated and would indicate to me whether 
  93. further development of this program is warranted. 
  94.  
  95.  
  96.                      Darren K. Henderson
  97.                      PO Box 207
  98.                      Madison, Maine 04950
  99.  
  100.  
  101.