Associating Code with Annotations

Chapter 10: Exploring, Documenting, and Measuring

This tutorial describes

You need to have read the chapter Start Here for the Tutorials! and worked through the first session, Creating and Loading Projects, before you do this session.

In this session, we assume that you have created Sample.prj.

10.1 Overview

You can use Revolve to explore the structure of an existing system. Through the use of Views you can actually move step-by-step through an illustration of data movements in your source code. In this exercise you will learn how to use various Views in conjunction with the Integrated Editorand the Execution Simulator to find a JCL job and make modifications.

10.1.1 Views

Views provide graphical overviews of your system and different modules in your source code. They enable you to study your application to navigate the execution sequence. Views are good resources for system reference when you're not quite sure where to start or what information you need.

10.2 Preparation

You will apply the procedures in this session to the sample project created in Creating and Loading Projects. If Revolve and sample.prj are closed, open them like before.

10.3 Sample Session

In this session you:

• Explore your system
• Explore source code logic
• Apply metrics to you project

10.3.1 Exploring Your System

To do this:

1. Click Tools > Views > System.

   The System view illustrates the calls that link programs in the project together. It displays icons that depict the project's different programs as well as other system items. Between the icons are the links that connect them. The icons and links are representatives of actual source code entities.

   This system contains a JCL job.

2. To isolate the JCL job, click Find.

   The Find dialog enables you to isolate information in the System view.

3. Uncheck everything except JCL jobs.

4. Select job P00045R (REP1.JCL) from the list.

5. Click OK.

   The JCL job card icon represents the JCL job.

6. Click Expand One Level to expand the JCL.

   
   Figure 10-1:System View

7. With the JCL selected, click View Source Code .

   This opens the Split Screen Editor where the source code for the JCL job is displayed.

8. In the Split Screen Editor, click Inventory View.

   The Inventory view graphically depicts the steps, DDs, executables, and databases in the JCL job.

   
   Figure 10-2: Viewing Graphically in the Information Window and Editor

9. To zoom-in or out on the illustration, click Overview Panel.

10. Scroll down and right click the BATCH1 icon .

11. Click Select.

    BATCH1.CBL is the selected element. Notice it is selected in the System view.

12. Click Inventory View again.

    The Inventory view closes and is replaced by the Split Screen Editor displaying the source code for the program BATCH1.CBL.

You have isolated a program by using the graphical views. Continue on in the analysis of BATCH1.CBL in the next tutorial. Do not close any windows or tools.

10.3.2 Exploring Source Code Logic

To explore the logical steps of BATCH1.CBL as identified in the previous tutorial:

1. In the Split Screen Editor, click Execution Simulator.

   The Execution Simulator tool bar appears. This indicates that the Execution Simulator is invoked and ready.

2. Click Run.

   The code executes slowly, while displaying the logical procedural flow. Notice the walk through is displayed, item by item, in the Execution Path display.

   
   Figure 10-3: Execution Simulator Condition Prompt

   The Execution Simulator Condition prompt appears when an IF statement in the code is encountered.

3. Click the Cancel button in the Execution Simulator Condition dialog box.

4. From the Windows menu, select the Close All Windows menu option.

10.3.3 Applying Metrics to Your Project

To measure the metrics for your program:

1. Select Metrics from the Tools menu.

2. Click Options....

3. Select McCabe in the drop down list.

5. Click Match.

   The window fills with programs.

6. Double click BATCH1.

   The window fills with paragraphs.

   
   Figure 10-4: Metrics Tool

   Sort the paragraphs by the number of branches.

7. Click Options....

8. ClickCyclomatic .

9. Uncheck Ascend .

   The Metrics window updates to display the complexity measures for each item in the program.

10. Double click BATCH1.

    The paragraph A300-TERMINATION-RTN has a Cyclomatic measurement of 10, anExtended measurement of 10, and an Essential measurement of 1.

    To see how the selected paragraph is called, create a flow chart of the program:

11. Select the paragraph A300-TERMINATION-RTN.

12. Click View Source Code.

    The Split Screen Editor displays the source code for the selected paragraph.

13. Click Code Flow.

14. Click Overview Panel to see the entire Code Flow.

    The paragraph A300-TERMINATION-RTN is outlined everywhere it is called.

    
    Figure 10-5: Code Flow in Editor

    The Code Flow view represents paragraphs as rectangles, PERFORMs as black squares, GO TOs as black arrows, and "fall-throughs" with vertical lines. As with any other view, code flows can be printed.

15. Click Print.

    The Print dialog is invoked. Print outs include indices and can be valuable for system documentation. The Legend check box gives you the option of printing a legend that describes the icons used in the view.

    Along with Code Flow, all of the windows, Metrics, Inventory, etc., can be printed in a similar fashion.

16. Click OK to send the report to the printer, or Cancel to close the Print dialog.

17. From the Windows menu, select Close All Windows.

10.3.4 Before Continuing

You can close Revolve, if you want to stop for now. The project that you have created and loaded is automatically saved.

You can continue with the next tutorial later, by simply reopening the project.

Associating Code with Annotations