home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ctb_291.zip / readme.eng next >
Text File  |  1996-08-14  |  4KB  |  102 lines
  1.          Class Tree Builder Version 2.91
  2.            (C) Sergey I. Yevtushenko.
  3.  
  4. 1. Description.
  5.  The main purpose of Class Tree Builder utility is displaying the
  6. inheritance of C++ classes. Utility scans header files for declaration of
  7. classes and builds the tree. Another useful features is displaing pairs
  8. (file,line) where class declared and class methods with short descriptions
  9. (like 'constructor', 'destructor', 'virtual', 'static', etc.)
  10.  Utility is very fast: scanning OWL 2.0 (From Borland C++ for OS/2 Version 2.0)
  11. needs as many as 6-8 seconds on my P-120.
  12.  
  13. 2. Supported platforms.
  14.  The first versions was written for DOS. Now support and maintenance of
  15. DOS dropped (because of lack of any DOS compiler on my computer, and I hope
  16. never be). Current version is OS/2 only. Future versions may also support
  17. Linux. Windows means DOS ;)
  18.  
  19. 3. Distribution
  20.  Utility can be free distributed as long as this file and copyright notice
  21. is a part of distribution package.
  22.  
  23. 3. Limitations.
  24.  Because of lack of built-in full C preprocessor mistakes are possible :(
  25.  Also possible existance of number of bugs. Anyway if you find them
  26. let me know. See addresses below.
  27.  
  28. 4. Command line switches.
  29.     CTB [-{iwsnma} [-Ipath{;path}] [-Sname] [-oname[.def]] [path\]filespec[.h]
  30.  
  31. -i      Ignore #include directives in processed files.
  32. -w      Disable printing of warning messages
  33. -s      Enables printing of pairs (file,line) for classes
  34. -Ipath  Include files search path. Several paths can be separated by ';'
  35. -Sname  Print only subtree which begins from class <name>
  36. -oname  Redirect output into file <name>. If extension not specified CTB
  37.         assumes .DEF
  38. -c      Threat 'struct' and 'union' as 'class'
  39. -a      Print all found declarations. If this option not specified CTB prints
  40.         only classes with childrens.
  41. -n      Desable print of tree of classes. Useful with -a and -m
  42. -m      Print methods of classes.
  43.  
  44. 5. Warrantyes.
  45.  Class Tree Builder is distributed with no warranty whatever. The author and
  46. any other contributors take no responsibility for the consequences of its use.
  47.  
  48. 6. Author
  49.  This utility designed and coded by Sergey I. Yevtushenko.
  50.  Author can be reached
  51.     E-mail: es@noos.kiev.ua
  52.     FIDO: 2:463/114.69@fidonet
  53.  
  54.  Suggestions, comments, contributions and donations are welcome ;)
  55.  No support for flames ;)
  56.  
  57. 7. Future of CTB
  58.  I hope that the version 3.0 will be true C++ Browser utility, with GUI and
  59.  with true C++ preprocessor and parser (this can reduce the risk of
  60.  mistake when parsing code). Maybe with built-in class editor.
  61.  
  62. 8. History
  63.    Note: there is lack of implementation history for versions prior to 2.5,
  64.    because I simply forget it ;)
  65.  
  66.   V 2.91 vs 2.9
  67.  
  68.   1. Changes for more clean long file names support.
  69.   1. English documentation.
  70.  
  71.   V 2.9 vs 2.8
  72.  
  73.   1. Fixed problems with -I switch.
  74.   2. Fixed check of parenthese balance.
  75.  
  76.   V 2.8 vs 2.7
  77.  
  78.   1. Added printiong of class methods.
  79.      Added command line switches -n, -m.
  80.   2. Some minor fixes (compiler independence).
  81.  
  82.   V 2.7 vs 2.6
  83.  
  84.   1. Added sorting of class names
  85.     (Used alghorithm of sigle-linked lists sorting from SNIPPETS.)
  86.  
  87.   V 2.6 vs V 2.5
  88.  
  89.   1. Fixed bug in parsing file name when processing include statements
  90.   2. Changed parser algorithm
  91.   3. Fixed bug in include paths parsing code
  92.   4. Overloaded operator new
  93.  
  94.   V 2.5 vs previous versions
  95.  
  96.   1. Fixed bugs in command line parsing code.
  97.   2. Changed purpose of switch -s
  98.   3. Added printing of file name and line number where class is declared
  99.   4. 'struct' and 'union' can be processed as 'class'.
  100.   5. Fixed printing of base classes in case of multiple inheritance.
  101.  
  102.