Contents of the README.DOC file

README.DOC July 1993

Welcome to CXT 2.12 - the C EXPLORATION TOOLS!

CFT (C Function Tree Generator) and CST (C Structure Tree Generator) and their 32 bit protected mode versions CFT386 and CST386 are powerful program development, maintenance and documentation tools. They provide the programmer the ability to analyse the C source code of applications, no matter how big or complex they are. CFT and CST are very useful to explore new, unknown software and to support software reuse, maintenance and re-engineering.

By preprocessing, scanning and analyzing the program source code, these programs build an internal representation of the function call hierarchy (CFT) and of the data structure (CST) relations. The analysis is done with the original source code, no additional editing to mark functions or data types in the source code is necessary. Several features and options allow the user to customize the generated hierarchy tree chart output and to get a large set of useful informations about the source code.

An important feature is the database generation which allows the recalling of informations without reprocessing the source. This database can again be read from CFT and CST to produce different outputs or to add new files to the database. The database format is dBASE compatible. Special recall programs called CFTN and CSTN allow fast searching for items in the database. These programs can be used within any environment, for example from inside editors like BRIEF, QEDIT or MicroEMACS (DOS and WINDOWS version), to provide a full software project management system with access to all functions and data types with just a keystroke. This feature makes a comfortable "hypertext source code browser and locator" system out of the editor.

Other features are the calculation of the critical function call path and deepest structure nesting level or the support for byte offset calculation for selected structures/unions by CST. For C++ code a class inheritance graph can be generated. It is possible to generate formatted ASCII text files with lists of the functions/data types and the scanned files which can be used as input for other programs like wordprocessors or spreadsheet calculators.

This software package contains the following files as a compressed self-extracting archive file CXTnmm.EXE (C EXPLORATION TOOLS version n.mm) or as a ZIPped archive file CXTnmm.ZIP:

CXT_ME.CMD The MicroEMACS macro source code CFTIDE.BAT The Borland IDE transfer batch file for CFT CSTIDE.BAT The Borland IDE transfer batch file for CST CFT_CST.DOC The complete documentation CFT_CST.QRF The command quick reference EXAMPLE.DOC The example for a CFT and CST session REGISTER.DOC The registration informations NEWnmm.DOC The new features and changes for version n.mm HISTORY.DOC The revision history README.DOC The file that you are currently reading

Registered user will additionally find the following files in the self-extracting archive file CXTnmmAD.EXE:

CFT386.EXE The protected mode version of CFT CST386.EXE The protected mode version of CST CXT.CB The source code for the BRIEF macro file

Additionally, the source code for the DOS extender GO32 from the DJ Delorie GNU C (DJGPP) package is in the self-extracting archive file GO32JM.EXE. The DOS extender is used by CFT386 and CST386.

All files are tested for known viruses. If you find any other than the above listed files, then you know that this is not the official shareware distribution diskette and/or archive. All documentation files are ASCII files and should be printable on every printer.

To install this software, copy all files into one directory, for example into your 'utility'-directory or create a separate directory like 'C:\CXT', and add, if necessary, this directory to your system path. This is necessary so that you can invoke the programs directly from other directories. Note that especially for using the BRIEF macros this path must be set to access CFTN and CSTN. You should also copy the BRIEF macro files CXT.CM and CXTKEYS.CM to the BRIEF macro directory and the MicroEMACS macro file CXT_ME.CMD to the editor directory, so that you must not specify the complete path when you want to load them.

For more informations about usage, hardware and software system requirements, trademarks, warranties, licence and registration details see the appropriate documentation, especially CFT_CST.DOC and REGISTER.DOC.

This software is Copyright (C) 1988-1993 by Juergen Mueller, Aldingerstrasse 22, D-70806 Kornwestheim, GERMANY. This software is NOT public domain or free software, but is being distributed as SHAREWARE.