TO: Troy Pearse
FROM: Noah Sutherland (UI CS481 Team B)
SUBJECT: Textual Summary Report Format
DATE: October 3, 1996
Mr. Pearse,
I'd like to show you the output format our team has developed for the
textual summary report. We would like to know whether you approve of
this format.
The following is a complete list of everything that *could* be included
in a summary report:
===========================================================================
Summary Report for ../test/Text.h :
Analysis options specified:
C : Display Comprehensive Conditional Logic Listing
D : Display Conditional Directive Summary
E : Display Conditional Expression Summary
L : Display Total Lines of Code
T : Display Total Lines of Conditional Compilation Logic
V : Display V(g) and V'(g) for Conditional Logic
Code Analysis Summary:
Total Lines of Code: 310
Total Lines of CC Logic: 44
Total V(g) for CCDs: 22
Total V'(g) for CCDs: 22
Directive Use Summary:
2 #else
21 #endif
19 #if
2 #ifndef
Expression Use Summary:
17 NeedFunctionPrototypes
2 NeedWidePrototypes
1 _XawText_h
1 _XtStringDefs_h_
Complete Conditional Logic Listing:
Line# CCD Expression
----------------------------------------------
51 #ifndef _XawText_h
143 #ifndef _XtStringDefs_h_
148 #endif
175 #if NeedFunctionPrototypes
177 #endif
181 #if NeedFunctionPrototypes
183 #endif
187 #if NeedFunctionPrototypes
189 #endif
193 #if NeedFunctionPrototypes
195 #endif
199 #if NeedFunctionPrototypes
202 #endif
206 #if NeedFunctionPrototypes
210 #endif
214 #if NeedFunctionPrototypes
218 #endif
222 #if NeedFunctionPrototypes
227 #endif
231 #if NeedFunctionPrototypes
233 #endif
237 #if NeedFunctionPrototypes
240 #endif
244 #if NeedFunctionPrototypes
246 #endif
250 #if NeedFunctionPrototypes
252 #endif
256 #if NeedFunctionPrototypes
260 #endif
264 #if NeedFunctionPrototypes
268 #endif
272 #if NeedFunctionPrototypes
274 #endif
278 #if NeedFunctionPrototypes
280 #if NeedWidePrototypes
282 #else
284 #endif
286 #endif
290 #if NeedFunctionPrototypes
292 #if NeedWidePrototypes
294 #else
296 #endif
297 #endif
309 #endif
*** End of Analysis Summary ***
===========================================================================
By default, however, the expression summary data and the complete
conditional logic listing will not be displayed. The complete list,
we feel, is simply too much info to be provided by default. When Gerry
saw our format, he suggested that the expression use summary also not
be printed by default. The expression summary could get several pages
long if there were a lot of unique expressions in a file.
The default summary report for the same input file would look like the
following:
===========================================================================
Summary Report for ../test/Text.h :
Analysis options specified:
D : Display Conditional Directive Summary
L : Display Total Lines of Code
T : Display Total Lines of Conditional Compilation Logic
V : Display V(g) and V'(g) for Conditional Logic
Code Analysis Summary:
Total Lines of Code: 310
Total Lines of CC Logic: 44
Total V(g) for CCDs: 22
Total V'(g) for CCDs: 22
Directive Use Summary:
2 #else
21 #endif
19 #if
2 #ifndef
*** End of Analysis Summary ***
===========================================================================
The Analysis Options section of the summary displays the command line
options selected when the program was run. These may have been explicitly
specified or selected by default. Notice that in the second example, the
C and E options are no longer specified. This information could remain or
not in our opinion. If you would like to be able to look at a result summary
and immediately be able to tell what options you specified when you ran
the analysis, then this data would be useful. This could be useful if
different people are viewing results than those that actually generated
them, as an example. Let us know whether you'd like to see this information
in the future.
Gerry has reviewed this report format and feels that it is both easy
to understand and contains the relevant data that is required. He supports
the above displayed default data format, also.
Please let us know whether this summary report format meets with your
approval or whether there are additions / changes you would like to
see.
Sincerely,
Noah Sutherland
Team Leader
CS481 Team B
University of Idaho