Panorama C/C++ automatically produces more than one hundred reports and charts. They document class definitions, constructors and destructors, data members, member functions, nested classes, class cross-references, overloaded function, function cross references, size, compactness, complexity, test coverage, and run-time performance, along with information about goto statements, unreferenced labels, global variables, static variables, etc.
These reports can be accessed individually or in groups using Panorama C/C++ interface. In the REPORT window, you can search for strings or jump from a table of contents to a particular page. Reports can be viewed on-screen or printed on PostScript or ASCII printers, or printed to files in PostScript or ASCII formats. They can also be saved from the screen for later reloading. A pull-down menu in the REPORT window provides access to FIND, SAVE, and PRINT capabilities. You can also adjust the line width and page size of reports both on the screen and in an file.
After the code is edited, Panorama can update charts, diagrams, and documentation.
This section covers:
Activating Panorama OO-Analyzer
To invoke OO-Analyzer from the Panorama C/C++ MAIN menu:
Alternatively, you may click the TOOLS menu, then click OO-Analyzer option.
The OO-Analyzer menu bar will pop up.
In the menu bar, the FOLLOW SUBSET check button is set by default. You can unselect it by clicking on the button.
If you select FOLLOW SUBSET, OO-Analyzer will show the information of only the files you have selected in the Panorama C/C++ MAIN Menu. (See "SUBSET pull-down menu".) If you unselect FOLLOW SUBSET, OO-Analyzer will show the information of all the files in the project.
To generate all available reports about your code:
In the dialog box, you may notice that the tables and charts are divided into seven groups. Each group contains a number of reports. These groups are:
Group Name | total tables and/or charts |
---|---|
Basic Group | |
Class Group | |
Function Group | |
Variable Group | |
Complexity Group | |
Performance Group | |
Test Group |
For each group, click the corresponding SELECTION option button in the middle column to select the table and chart in the group to be included.
For each SELECTION option button, there are three selections: DEFAULT, ALL or CHOICE. If DEFAULT is selected, only the default tables and charts will be generated. If ALL is selected, all the tables and charts in the group will be generated. If CHOICE is selected, a selection dialog box for the group will pop up for your specification. For example, the BASIC REPORT CHOICE dialog box is shown below:
In the dialog box above, make your selections by clicking the check buttons or using the push buttons, then click OK. The number of tables and charts selected for the group will be shown in the SELECTED column in the right.
Panorama needs to know the program’s executable file name and the profile name so that it can find the performance data files. Enter the program’s executable file name and the profile name, then click OK.
The report specified will be generated. The table of contents is shown below:
The report generated consists of a table of content, the tables and charts. Depending on the selections in REPORT OPTIONS dialog box, the report may contains more than 150 tables and charts. However, if OO-Test is not available, the dynamic test data will not be available in the report.
In the table of content, the date and time of generation are included for identifying the report. Each table and chart is given an identification number in the left and a page number in the right. Click the left mouth button at a page number will jump to that table or chart. For example, click at the page number of 5. CLASS DEFINITION REPORT will jump to the table shown below:
As shown in the above window, each table or chart is displayed with the identification number and a title. The page number of the table or chart is listed to the top right of the content. To make full use of the page space, each page is divided into four to six paragraphs depending on the lines of page specified in the REPORT option dialog box. The page number is thus preceded by a letter A through G.
In addition to scroll bars, the report is specially designed and furnished with click-jump function so that it is easy for you to go through.
To jump to a report:
The page numbers are listed to the right of the Table of Contents.
Alternatively, if the current display is not the Table of Contents, clicking the left mouse button at the page number of another table or chart will jump to that table or chart.
To jump back to the previous position or to table of contents:
Click the middle mouse button, or press the key RETURN will jump back to the previous clicked position.
Click HOME key will jump back to the Table of Contents.
Panorama updates reports automatically whenever you create a new database and then generate a report. You can also run the command line version of Panorama directly from a script or makefile to update technical documentation each time you recompile or test your software.
The menu bar of the report window provides access to FILE, OPTION and TAG operations. You can search for a character string in the report window, or save a report to a file for reviewing in the future, print all or part of the tables and charts generated, change the color of different parts in the report, set tags in various locations in the report window, etc.
To find a string in report:
The REPORT FIND dialog box will pop up.
Type the string you want to find in the SEARCH FOR text field.
Press NEXT to search toward the end of file; press PREVIOUS to search toward the beginning of the file.
The next occurrence of the specified string will be highlighted.
The next occurrence of the specified string will be highlighted.
Reports can be saved in Panorama report (.rpt) files.
To save reports:
The report SAVE dialog box will pop up.
If the directory is not specified, the default value is the current directory.
Report file names should end with.rpt extension.
To save the report in an existing file, click BROWSE. A BROWSE dialog box pops up.
In this dialog box, you may select a proper directory in the DIRECTORIES field, then click a filename, the filename will appear in the SELECTION field. Click OK, this filename will be loaded into the SAVE dialog box.
The report will be saved to files in ASCII format.
The contents in REPORT window can be printed directly or can be saved into a file in either ASCII or PostScript format.
To use the print function:
If TO PRINTER is selected, you may type the printer ID into this field. If the TO PRINTER field is left blank when it is selected, system default printer will be used.
If TO FILE is selected, a file name with full path is expected.
You may click BROWSE to select a file and load the filename into the TO FILE field. By clicking BROWSE, a BROWSE dialog box pops up:
In this dialog box, you may select a proper directory in the DIRECTORIES field, then click the filename, the filename will appear in the SELECTION field. Click OK, this filename will be loaded into the TO FILE field of the PRINT dialog box.
This selection determines the format of the printout or the format in the specified file.
When ALL is selected, the contents of the whole window will be printed out or be saved into the specified file.
When HIGHLIGHTED is selected, only the highlighted part will be printed out or be saved into the specified file.
To highlight a part of content for printing, click the left mouse button at the beginning, then click the right mouse button at the end of the part to be printed.
When LINE is selected, the range of lines should be specified to the right of the selection:
If PAPER is selected, the paper size in inches is to be specified in the WIDTH and HEIGHT fields to the right of the paper format fields.
The specified contents will be printed or be saved in the file.
The colors of the tables and charts can be changed.
The COLOR Property dialog box will pop up.
Click OK to accept new setting and close the dialog box.
Click DEFAULT to restore the default colors.
Click CANCEL to close the dialog box and discard the modifications of the colors.
Click SAVE to open a dialog box in which you may enter the directory and name of a file for storing the current color settings. The file name must have .col extension.
Click LOAD to open a file selection dialog box for loading a set of colors from a .col file.
Click HELP to activate on-line help function.
You can set tags in report. Tags can be attached at different locations of interest. You can even write a few comments as a tag which is helpful for your later reviewing.
To attach a tag:
In the box, the top row number in the current window is provided. This number is the unique identification of this row in a window. In each window, the row number starts at zero with the increment of one for each succeeding row.
In the same way, you can attach tags to other locations in the windows.
To jump to a location marked with a tag:
To clear a tag:
Click CLEAR ALL will remove all the tags set.
Close a window will delete the attached tag list for the window.
Saved reports can be reloaded for later viewing. Note that reloaded reports may have no relation to the current input bin or database.
To review an previously saved report:
The VIEW FILE SELECTION dialog box will pop up.
Or, you may click BROWSE to search for an existing file.
If you click BROWSE, a dialog box pops up:
In this dialog box, you may select a proper directory in the DIRECTORIES field, then click the filename, the filename will appear in the SELECTION field. Click OK, this filename will be loaded into the FILE NAME field of the VIEW FILE SELECTION dialog box.
The report specified will pop up.
To exit from the reports:
To exit OO-Analyzer:
Click QUIT on OO-ANALYZER menu bar.