This site is underconstruction

What is Source Reporter?

Source Reporter is a program to collect the information of your source code ( C/C++ ) and integrates them into a HTML file with sytax hilighting. To see a possible result of Source Reporter, check out the result it works on the HOC program from 'Unix Programming Enviroment'.

What exactly it does?

It will look for C/C++ source files ( including header files ) in your current directory and list them in a alphabetic order. It also makes up a content and alows you to navigate between files. And all the source files are decorated with color according to the syntax function it acts as. You also can setup your own color schem like color of keywords , color of background , etc, etc by having an resource file calld ".sourcereportrc" in your home directory. For example, take a look here

What does it require?

Well, this programm is written in C++. I tried to use ANSI C++ anyway. But since it involed directory and file manipulation, unix system calls are neccesary. So this software will work on Unix box only. And I don't have a plan to port it onto DOS or Win32 platform shortly though I'd like to do so. You need a compiler supporing ANSI C++. You don't need some super-duper fancy machine ( sorry to those who has Pentium III 1000Mhz and Geforce 256, bla, bla ). It should work on all class of machines. Of course, to view the result, you need a web browser with color support alright.

Your copy

The program is written in ANSI C++ under a Solaris system. It is a freeware. The source is available for download from here. I also included a precompiled executable program(Solairs) here for your interest.

Currently, this program is still under test. Though it is fairly robust, it is recommended to have it run on validated C/C++ code and this is rational afterall.

How to install?

After you downloaded the compressed file, uncompress it and simply type 'make install' to install it to your '$HOME/bin' directory. This will work if you have a copy of g++ installed on your system. You can change the 'makefile' for your own convenience if you like.

How to use it?

Simple enough. Just go to the directory where your source files are located and type 'sr' and then a file named 'source_report.html' will be generated. Well, if you are so luck that you already have a file with the same name there, yours will be gone after that.

Known bug

This program will hang when it happens to be working on a DOS formatted file, i.e, files which contains control sequences like ^M.

Also, if a source file happens to have such a code segment

/* this 
will be the comment at the 
end of a file
and no trailing empty lines
*/
at the end, the program will report that there is a syntax error.

Contact me

mail me for more information. Also, my CV is availble here.
Google
Search WWW Search None






FastCounter by bCentral