Text and HTML Reports

prevnext

Analysis and Quality Reports Overview


Understand for Ada generates a variety of analysis and quality reports. The reports fall into these categories:

· Cross Reference reports show much the same information as the References section in the Info Browswer, except that all entities are shown together in alphabetic order. Cross Reference reports include the Data Dictionary, Program Unit, Object, Type, Exception, and Unused Objects, Unused Types, Unused Program Units, and Withs Not Needed.
· Structure reports show the structure of the analyzed program(s). Examples include the Invocation Tree, Declaration Tree, and With Tree Reports.
· Quality reports show areas where code might need to be looked at more closely.The Program Unit Complexity reports cyclomatic complexity metrics for each program unit.
· Metrics reports show basic metric information for functions and files such as number of lines of code and comments. Examples include Project Metrics, File Metrics, Program Unit Metrics, and Program Unit Inclusive Metrics.

Output Formats

Understand for Ada reports are generated either as Text or as HTML files. On Windows 95/NT the ASCII text follows the DOS text file format (carriage return and line feed at the end of each line). On Unix and VMS text files are created according to the Unix convention with lines ending with just a carriage return.

When HTML reports are generated they are stored in the HTML 3.0 format. The generated HTML is not complex, the only HTML 3.0 (versus earlier versions) feature used is Frames. The Netscape browser version 2.0 and higher, and Internet Explorer 3.0 and higher are able to browse the files.

If you have specified multiple HTML files be generated per report in the Report Configuration dialog, the top of the HTML report will show the index of the report sections by displaying the first one or two characters of the entity name in that section. These are also links to those files, so clicking on the desired index entry will take you directly to that page.

Report File Naming Conventions

File names of reports generated vary based on the type and format of the report generated.

For text files, a single text file containing all selected reports may be generated or separate files for each type of report may be generated. A single text file is named <project_name>.txt. For separate text files, the root of the file name is <project_name> with varying suffixes added to the file name to distinguish the type of report. A .pcn file is also created as in index to every program unit, listing it's parameters and file/line declaration.

For HTML files, a single HTML file containing all selected reports may be generated or separate files for each type of report may be generated. HTML files are further broken down into separate files, either alphabetically by entity name or in groups of N number of entities. An index file is also generated and contains links to all the other HTML reports generated. The report index file is named index.html.

The following table shows the file names used for each separate HTML and Text report.

Separate alpha or numeric HTML Reports Text Reports
Report Type Alphabetic (A - Z) X-Number (0..n) Separate
Data Dictionary dictionary_A.html dictionary_0.html project.dic
Declaration Trees decltree_A.html decltree_0.html project.dct
Exception Cross Reference exception_xref_A.html exception_xref_0.html project.exx
File Metrics file_metrics_A.html file_metrics_0.html project.fmx
Generic Instantiation Report Gen_inst_A.html Gen_inst_0.html project.gnx
Invocation Report invocation_A.html invocation_0.html project.nvt
Object Cross Reference object_xref_A.html object_xref_0.html project.obx
Program Unit Complexity progunitcomp_metrics_A.html progunitcomp_metrics_0.html project.cmx
Program Unit Cross Reference progunit_xref_A.html progunit_xref_0.html project.pux
Program Unit Inclusive Metrics progunitincc_metrics_A.html progunitincc_metrics_0.html project.pmi
Program Unit Metrics progunit_metris_A.html progunit_metris_0.html project.pmx
Project Metrics projmetrics_A.html projmetrics_0.html project.jme
Renames Report renames_A.html renames_0.html project.rnx
Simple Invocation Tree simpleinvtree_A.html simpleinvtree_0.html project.sit
Simple With Tree simplewithtree_A.html simplewithtree_0.html project.swt
Type Cross Reference type_xref_A.html type_xref_0.html project.tyx
Unused Objects unusedobject_A.html unusedobject_0.html project.qno
Unused Program Units unusedprogunit_A.html unusedprogunit_0.html project.qnu
Unused Types unusedtype_A.html unusedtype_0.html project.qnt
Withs Not Needed withsnotneeded_A.html withsnotneeded_0.html project.qwn
With Tree withtree_A.html withtree_0.html project.wit

Searchable Entity Index

For HTML reports only, there is a single index file containing an alphabetical list of all entities found in all other generated HTML reports. The entities listed in the index have hyper links to the Data Dictionary report for that entity. The entity index file is named entity_index.html and can be accessed from the "index" link on the main HTML page. Following is an example of the entity index.

Generating Reports from the Command Line

HTML, text, and project metrics reports may be generated with the command line program "repada". Refer to Generating Reports for details on using "repada".

prevnext


Scientific Toolworks, Inc.
http://www.scitools.com
Voice: (802) 763-2995
Fax: (802) 763-3066
support@scitools.com
sales@scitools.com