Contents

Preface

Chapter 1: Getting Started

Installation

Command Execution

Parameter Options

Command Execution through the GUI

Command Logs

Warning and Error Messages

Token Management

Hypertable Report Output

Viewing Hypertable Reports with the Report Editor

Traversal and Explanation

Image Manipulation with the Report Editor

Merging and Comparing Reports

Acceptable Report Entries

Printing Reports

Saving Reports

Online Documentation

Configuring the Ada Analyzer

Configuration Structure and Content

Multiple Configuration Policies

Determining the Currently Active Configuration Policy

Customized Titles Explanation Text

Analysis Switches

Editing Analysis Switches

Environment-Variable Switches

Configuration-Policy Files

Chapter 2: Quality-Improvement Objectives

Overview

Analysis Methods

Online Analysis

Code Reviews

Validation of Coding Standards

Generation of Project Information

Analyzing Program Structure and Content

Locating Key Constructs

Unit Partitioning and Dependencies

Subsystem Partitioning and Dependencies

Dynamic Analysis

Counting

Construct Location

Metrics Collection

Analyzing Readability

Name Selection

Use of Use Clauses

Comment Correctness

Program Complexity

Unit/Subprogram Partitioning

Analyzing Portability and Reusability

Target-Dependent Constructs (Compiler Compatibility)

Host-Development Dependencies

Reusable Units

Checking for Programming Errors

Object Sets and Uses

Subprogram Execution Problems

Misspellings

Use of Error-Prone Constructs

Representation Specifications

Static Constraint Violations

Use of System.Address

Inconsistencies

Checking Standards Conformance

Formal Coding Standards

Naming Standards

Reducing Compilation Time

Unused Constructs

Dependency Reduction

Redundancy

Use of Use Clauses

Optimizing Software

Inlining

Object References

Object Size

Generics

Redundancy

Expensive Constructs

Operator Selection

Loop Nesting

Object Initialization

Use of Text_Io

Compiler Dependencies

Miscellaneous Objectives

Unit-Testing Support

Documentation Support

Elaboration Problems

Null Statements

Hard-Copy Listings

Chapter 3: Command Descriptions

Check_Consistency

Check_Reports_Up_To_Date

Collect_Metrics

Collect_Statistics

Compare_Metrics

Compare_Reports

Compare_Unit_Construct_Counts

Count_Lines_Of_Code

Create_New_Configuration_Policy

Display_Call_Tree

Display_Expanded_Type_Structure

Display_Inter_Subsystem_References

Display_Set_Twice_Before_Use

Display_Set_Use_Problems

Display_Subprogram_Branch_Points

Display_Subprogram_Execution_Problems

Display_Subsystem_Import_Closure

Display_Unit_Construct_Counts

Display_Unit_Declarations

Display_Unit_Relationships

Display_With_Closure

Generate_Listing

Locate_Aliasing

Locate_Annotations

Locate_Attributes

Locate_Calling_Relationships

Locate_Calling_Thread_Sets_And_Uses

Locate_Class_Hierarchies

Locate_Coding_Violations

Locate_Coding_Violations_Interactively

Locate_Compatibility_Problems

Locate_Complex_Expressions

Locate_Constants

Locate_Data_Synchronization_Points

Locate_Default_Initialization

Locate_Elaboration_Impacts

Locate_Elements_Containing_Text

Locate_Exceptions

Locate_Expensive_Types

Locate_Expressions

Locate_External_Dependencies

Locate_Generic_Complexities

Locate_Generic_Formal_Dependencies

Locate_Generics

Locate_Inline_Candidates

Locate_Loop_Nesting

Locate_Misspellings

Locate_Name_Anomalies

Locate_Named_Declarations

Locate_Objects_By_Size

Locate_Objects_Set_And_Used

Locate_Obsolescent_Ada83_Features

Locate_Operators

Locate_Others_Clauses

Locate_Packages_With_State

Locate_Potential_Programming_Errors

Locate_Pragmas

Locate_Recursive_Subprograms

Locate_Renames

Locate_Rep_Spec_Inconsistencies

Locate_Rep_Specs

Locate_Short_Circuit_Opportunities

Locate_Similar_Record_Structures

Locate_Specific_Coding_Violations

Locate_Ada95_Coding_Violations

Locate_Statements

Locate_Static_Constraint_Violations

Locate_Subprogram_Complexities

Locate_Subprograms_Propagating_Exceptions

Locate_Subprogram_References

Locate_Subunit_Candidates

Locate_System_Address_Usage

Locate_Tasking

Locate_Type_Declarations

Locate_Unused_Declarations

Locate_Unused_With_Clauses

Locate_Use_Clauses

Merge_Reports

Release_Token

Separate_Reports_By_Subsystem

Visit_Current_Configuration_Policy

Write_To_Ascii_File

Chapter 4: Customization

Organization of Delivered Source Code

Locator Templates

Simple Locator Customization

Full Locator Customization

Multiple-Table Locator Customization

Building Reports with Multiple Analysis Tables

Adding New Compatibility and Standards-Conformance Rules

Adding New Metrics to the Metrics Library

Creating Individual Metric Reports

Relinking the Ada Analyzer

Adding New Commands to the Ada Analyzer User Interface

Updating the Command-Line Parser

Adding a New Dialog Box Definition

Adding New Items to the Analyzer Menu

Adding Menu Actions

Changing Report Colors

Creating Command-Line Scripts

General ASIS Programming

Elements and Element Kinds

Processing Specific Constructs

Element Lists and Iterators

Operations That Apply to All Elements

Semantic References

Summary

Chapter 5: Command Cross-Reference

Quality-Improvement Objectives and Command to Use

Analyzing Program Structure and Content

Analyzing Readability

Analyzing Portability and Reusability

Checking for Programming Errors

Checking Standards Conformance

Reducing Compilation Time

Optimizing Software

Miscellaneous Objectives

Command-Line Summary

Standards-Conformance and Compatibility Rule Libraries

Ada 95 Rules

Rational Target-Compatibility Rules

Little Tree Consulting's Software-Quality Guidelines

Little Tree Consulting's Metrics Library

Chapter 6: Ada Repair

Repairing Violations

Supported Updates

The Update Process

Managing Change

Conflicting Updates

Repair_Violations

Declaration Renaming

Command-Line Interface

Nonstandard Parameters

Specifying Declarations to Rename or Move

Renaming Compilation Units

Index