home *** CD-ROM | disk | FTP | other *** search
/ Borland Programmer's Resource / Borland_Programmers_Resource_CD_1995.iso / utils / cxtw104 / readme.doc < prev    next >
Encoding:
Text File  |  1995-05-19  |  5.5 KB  |  123 lines
  1.  
  2.  
  3.         README.DOC                                         September 1994
  4.  
  5.         Welcome to CXT - the C EXPLORATION TOOLS!
  6.  
  7.         The C Function Tree Generator (CFT)  and  the  C  Structure  Tree
  8.         Generator (CST) are powerful program development, maintenance and
  9.         documentation  tools.  They provide the programmer the ability to
  10.         analyse the C or C++ source code of applications,  no matter  how
  11.         big  or complex they are.  CFT and CST are very useful to explore
  12.         new,   unknown  software  and  to  support  software  reuse   and
  13.         maintenance.
  14.  
  15.         By preprocessing, scanning and analyzing the program source code,
  16.         these  programs  build an internal representation of the function
  17.         call hierarchy (CFT) and of the data structure  (CST)  relations.
  18.         The analysis is done with the original source code, no additional
  19.         editing  to  mark  functions  or data types in the source code is
  20.         necessary.  Several  features  and  options  allow  the  user  to
  21.         customize  the generated hierarchy tree chart output and to get a
  22.         large set of useful informations about the source code.
  23.  
  24.         An important feature is the database generation which allows  the
  25.         recalling  of informations without reprocessing the source.  This
  26.         database can again be read from CFT and CST to produce  different
  27.         outputs or to add new files to the database.  The database format
  28.         is dBASE compatible. Special recall programs called CFTN and CSTN
  29.         allow fast searching for items in the  database.  These  programs
  30.         can  be  used  within  any  environment,  for example from inside
  31.         editors  like  BRIEF,   QEDIT  or  MicroEMACS  (DOS  and  WINDOWS
  32.         version),  to  provide  a full software project management system
  33.         with  access  to  all  functions  and  data  types  with  just  a
  34.         keystroke.  This  feature  makes  a comfortable "hypertext source
  35.         code browser and locator" system out of the editor.
  36.  
  37.         Other features are the calculation of the critical function  call
  38.         path  and deepest structure nesting level or the support for byte
  39.         offset calculation for selected structures/unions by CST. For C++
  40.         code a class inheritance graph can be generated.  It is  possible
  41.         to  generate  formatted  ASCII  text  files  with  lists  of  the
  42.         functions/data types and the scanned files which can be  used  as
  43.         input  for  other  programs  like  wordprocessors  or spreadsheet
  44.         calculators.
  45.  
  46.         This  software  package  is  provided  either  as  a   compressed
  47.         self-extracting  archive  file  CXTnmm.EXE  (C  EXPLORATION TOOLS
  48.         version n.mm) or as a ZIPped archive file CXTnmm.ZIP and contains
  49.         the following files:
  50.  
  51.         CFT.EXE        The C Function Tree Generator
  52.         CST.EXE        The C Structure Tree Generator
  53.         CFTN.EXE       The C Function Tree Navigator
  54.         CSTN.EXE       The C Structure Tree Navigator
  55.         CXT.CM         The BRIEF macro file
  56.         CXTKEYS.CM     The BRIEF macro key definition file
  57.         CXTKEYS.CB     The source code for the BRIEF key definition file
  58.         CXT_QEDT.DAT   The QEDIT macro source code
  59.  
  60.  
  61.                                       - 1 -
  62.  
  63.  
  64.         CXT_ME.CMD     The MicroEMACS macro source code
  65.         CFTIDE.BAT     The Borland IDE transfer batch file for CFT
  66.         CSTIDE.BAT     The Borland IDE transfer batch file for CST
  67.         SXT.DOC        The complete SXT documentation
  68.         INSTALL.DOC    The installation instructions
  69.         EXAMPLE.DOC    The example for a CFT and CST session
  70.         PRODUCTS.DOC   The SXT product overview
  71.         REGISTER.US    The INTERNATIONAL registration informations
  72.         REGISTER.GER   The GERMAN registration informations
  73.         NEWnmm.DOC     The new features and changes for version n.mm
  74.         HISTORY.DOC    The revision history
  75.         README.DOC     The file that you are currently reading
  76.  
  77.         Similar to the DOS version is the WINDOWS version available as  a
  78.         compressed    self-extracting   archive   file   CXTWnmm.EXE   (C
  79.         EXPLORATION TOOLS version  n.mm  for  Windows)  or  as  a  ZIPped
  80.         archive file CXTWnmm.ZIP.  The archive contains the same files as
  81.         listed above except  that  the  files  CFT.EXE  and  CST.EXE  are
  82.         replaced  by  the  Windows versions CFTWIN.EXE and CSTWIN.EXE and
  83.         the files SXTWIN.DOC and NEWnmm.WIN have been added.
  84.  
  85.         If you find any other than the above listed files,  then you know
  86.         that  this  is  not  the official shareware distribution diskette
  87.         and/or archive.  All documentation  files  are  ASCII  files  and
  88.         should be printable on every printer.
  89.  
  90.         For  more informations about usage,  hardware and software system
  91.         requirements, installation, trademarks,  warranties,  license and
  92.         registration   details   see   the   appropriate   documentation,
  93.         especially   SXT.DOC,    INSTALL.DOC   and   REGISTER.US    resp.
  94.         REGISTER.GER.
  95.  
  96.         This  software  is  Copyright  (C)  1988-1994 by Juergen Mueller,
  97.         Aldingerstrasse 22, D-70806 Kornwestheim, GERMANY.  This software
  98.         is  NOT public domain or free software,  but is being distributed
  99.         as SHAREWARE.
  100.  
  101.  
  102.                            (THIS DOCUMENT HAS 2 PAGES)
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.                                       - 2 -
  123.