|
1 |
| -CCCC |
2 |
| -==== |
| 1 | +README.TXT for CCCC version 3.1.5-alert |
| 2 | +======================================== |
| 3 | + |
| 4 | +This is a fork of the program CCCC (C and C++ Code Counter) for |
| 5 | +the ALERT project. It includes minor modifications that allow to |
| 6 | +the platform to retrieve information about modules/classes and |
| 7 | +functions/methods. |
| 8 | +For more information about ALERT project please visit: http://www.alert-project.eu |
| 9 | + |
| 10 | +This program exists to analyze and report measurements on |
| 11 | +source code in C, C++ and Java. The languages Ada83 and Ada95, which were |
| 12 | +supported in previous versions are presently not supported. |
| 13 | + |
| 14 | +CCCC is a command line tool, originally implemented for Linux and other |
| 15 | +POSIX-style platforms, but also buildable on the Win32 platform. |
| 16 | +Files to be analyzed are listed (typically on the command line, although |
| 17 | +support does exist for the list of files to be read from standard input. |
| 18 | +The program analyzes the files and generates a one or more reports in HTML |
| 19 | +or XML format on the content. |
| 20 | + |
| 21 | +This distribution is intended to be a single package containing everything |
| 22 | +which is required to compile and install CCCC on either a POSIX or Win32 |
| 23 | +platform. Whereas previous distributions contained only a single directory, |
| 24 | +containing the source code of CCCC, this distribution is divided into a |
| 25 | +number of subdirectories, with the following contents: |
| 26 | +* A full distribution of the Purdue Compiler Construction Toolset (PCCTS) by |
| 27 | + Terence Parr and others, now maintained by Tom Moog of Polhode Inc. |
| 28 | + PCCTS is required to compile CCCC: in the past the distribution has relied |
| 29 | + on the existence of a PCCTS package on the compilation platform, while this |
| 30 | + distribution chooses to include it as part of CCCC's own package. |
| 31 | +* The source of a new version of CCCC, which I hope will turn out to be more |
| 32 | + efficient, accurate and useful than previous versions, although it is very |
| 33 | + similar in spirit and interface. |
| 34 | +* The source of an accessory program called CcccDevStudioAddIn.dll which |
| 35 | + provides integration between the command line CCCC program and the |
| 36 | + Microsoft Visual Studio IDE (version 5.0 or 6.0). |
| 37 | +* A directory of minimal test cases for the command line CCCC tool. |
| 38 | +* Miscellaneous batch files, makefiles and Microsoft Visual Studio workspace |
| 39 | + and project files to support building, testing and installing the software |
| 40 | + under POSIX and Win32. |
| 41 | + |
| 42 | +The pccts directory contains software for which I am not the original |
| 43 | +author. The software has been placed in the public domain, with |
| 44 | +the expectation that appropriate credit will be given for use. |
| 45 | + |
| 46 | +Since version 3.pre63, the recommended way of building the software is by |
| 47 | +using the BAT and SH scripts in the top directory of the distribution as |
| 48 | +appropriate for your platform. On Win32, the script build_w32vc.bat |
| 49 | +builds the software with Microsoft Visual C++ version 5 or 6 (locations |
| 50 | +within the script may need to be modified according to which you have |
| 51 | +and whether it is installed at the default position in the filesystem). |
| 52 | +On Linux and similar platforms the shell script build_posixgcc.sh should work. |
| 53 | + |
| 54 | +Previous versions of CCCC have been released like PCCTS into the public |
| 55 | +domain with no restrictions, other than the pious hope that should anyone |
| 56 | +base a derivative work on it I will be given due credit. The current version |
| 57 | +is released under the GNU Public License. |
| 58 | + |
| 59 | +CCCC was originally developed as a proof-of-concept tool for some ideas |
| 60 | +relating to software metrics which I was investigating as an academic |
| 61 | +research project. I have now completed the project and been awarded |
| 62 | +my PhD. |
| 63 | + |
| 64 | +With this release, I am choosing to declare the project in a dormant |
| 65 | +state. I have no plans to do further releases, either to add new features |
| 66 | +or to correct existing defects. I am happy to provide advice to users of |
| 67 | +CCCC via email, and I encourage all users to exercise the rights granted |
| 68 | +them under the GPL to tinker with the code if this helps the software |
| 69 | +to meet their needs better. |
| 70 | + |
| 71 | +I am grateful to a number of people for assistance on this project, including |
| 72 | +Terence Parr and his co-workers, and Tom Moog for the development and ongoing |
| 73 | +maintenance of the excellent PCCTS tool; my academic supervisor, Dr Thomas |
| 74 | +O'Neill; a number of developers who have contributed source patches; and |
| 75 | +many people who have mailed me with constructive suggestions or merely to |
| 76 | +confirm that they were using the tool. Feedback on the value or otherwise |
| 77 | +of CCCC will always be welcome. |
| 78 | + |
| 79 | + |
| 80 | +Tim Littlefair (tim_littlefair@hotmail.com) |
| 81 | +updated January 2005 |
| 82 | +-------------- |
| 83 | + |
| 84 | +Santiago Dueñas (sduenas@libresoft.es) |
| 85 | +updated January 2013 |
| 86 | +-------------- |
| 87 | +This distribution of CCCC is available from |
| 88 | +http://github.com/AlertProject/CCCC |
| 89 | + |
| 90 | +Past distributions of CCCC and related tools should be |
| 91 | +available for the forseeable future from http://cccc.sourceforge.net |
| 92 | +The Internet site for the original CCCC development is: http://cccc.sourceforge.net. |
3 | 93 |
|
4 |
| -C and C++ Code Counter, a software metrics tool. This is a fork of the original CCCC for ALERT project. |
|
0 commit comments