User Guide and
Reference Manual
Version 2.5
July 2010
Scientific Toolworks, Inc.
230 N 1680 E, Ste. OP1
St George, UT 84790
Copyright © 7/22/10 Scientific Toolworks, Inc. All rights reserved.
The information in this document is subject to change without notice.
Scientific Toolworks, Inc., makes no warranty of any kind regarding this
material and assumes no responsibility for any errors that may appear
in this document.
RESTRICTED RIGHTS: Use, duplication, or disclosure by the Govern-
ment is subject to restrictions as set forth in subparagraph (c)(1)(ii) of
the Rights in Technical Data and Computer Software clause at DFAR
252.227-7013 (48 CFR). Contractor/Manufacturer is Scientific Tool
-
works, Inc., 230 N 1680 E, Ste. OP1, St. George, UT 84790.
NOTICE: Notwithstanding any other lease or license agreement that
may pertain to or accompany the delivery of this restricted computer
software, the rights of the Government regarding use, reproduction, and
disclosure are as set forth in subparagraph (c)(1) and (2) of Commercial
Computer Software-Restricted Rights clause at FAR 52.227-19.
Part Number: USTAND2.5-GEN-UG-522 (7/10)
Understand 2.5 User Guide and Reference Manual iii
Contents
Chapter 1 Introduction
What is Understand 2.5? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
Licensing Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
Languages Supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
For Those Who Don’t Like to Read Manuals . . . . . . . . . . . . . 1–5
Chapter 2 Parts and Terminology
Using Understand 2.5 Windows . . . . . . . . . . . . . . . . . . . . . . . 2–2
Understand 2.5 Terminology. . . . . . . . . . . . . . . . . . . . . . . . . . 2–3
Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
Starting Understand 2.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–5
Other Ways to Run Understand 2.5 . . . . . . . . . . . . . . . . 2–6
Right-Click Menus Are Everywhere . . . . . . . . . . . . . . . . . . . . 2–7
Quickly Find Things in Your Source . . . . . . . . . . . . . . . . . . . . 2–9
Entity Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–9
Entity Locator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–10
Instant Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–10
Find in Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–11
Favorites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–11
Information Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–12
Source Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–13
Architecture Browser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–14
Graphical Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–15
ASCII and HTML Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–16
Perl and C APIs for Custom Reporting . . . . . . . . . . . . . . . . . 2–17
Chapter 3 Configuring Your Project
About Understand 2.5 Projects . . . . . . . . . . . . . . . . . . . . . . . . 3–2
The Understand 2.5 Project Database . . . . . . . . . . . . . . 3–2
Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3
New Project Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–4
Project Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . 3–8
Languages Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10
Files Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–11
Adding Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–12
Adding Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–14
Deleting Directories and Files . . . . . . . . . . . . . . . . . . . 3–14
Setting Overrides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–14
Contents
iv Understand 2.5 User Guide and Reference Manual
Scanning Watched Directories . . . . . . . . . . . . . . . . . . . 3–16
Setting File Portability. . . . . . . . . . . . . . . . . . . . . . . . . . 3–16
File Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–18
File Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–19
Scheduled Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–20
Metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–23
Metrics > Selected Category . . . . . . . . . . . . . . . . . . . . 3–24
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–25
Reports > Output Category. . . . . . . . . . . . . . . . . . . . . . 3–25
Reports > Options Category . . . . . . . . . . . . . . . . . . . . . 3–26
Reports > Selected Category . . . . . . . . . . . . . . . . . . . . 3–26
Visual Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–27
Ada Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–29
Ada > Macros Category . . . . . . . . . . . . . . . . . . . . . . . . 3–31
C++ Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–33
C++ > Includes Category . . . . . . . . . . . . . . . . . . . . . . . 3–35
C++ > Includes > Auto Category . . . . . . . . . . . . . . . . . 3–37
C++ > Includes > Ignore Category . . . . . . . . . . . . . . . . 3–37
C++ > Includes > Replacement Text . . . . . . . . . . . . . . 3–37
C++ > Macros Category . . . . . . . . . . . . . . . . . . . . . . . . 3–38
C++ > Macros > Undefines Category . . . . . . . . . . . . . . 3–40
C# Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–41
FORTRAN Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–42
Fortran>Includes Category . . . . . . . . . . . . . . . . . . . . . . 3–44
Other Fortran Categories . . . . . . . . . . . . . . . . . . . . . . . 3–45
Java Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–46
Java > Class Paths Category . . . . . . . . . . . . . . . . . . . . 3–47
JOVIAL Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–48
Jovial > !Copy Category . . . . . . . . . . . . . . . . . . . . . . . . 3–49
Pascal Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–50
Pascal > Macros Category . . . . . . . . . . . . . . . . . . . . . . 3–51
Pascal > Namespaces Category . . . . . . . . . . . . . . . . . 3–51
Pascal > Standard Library Paths Category . . . . . . . . . 3–52
Pascal > Search Paths Category . . . . . . . . . . . . . . . . . 3–52
PL/M Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–53
PL/M>Includes Category . . . . . . . . . . . . . . . . . . . . . . . 3–53
VHDL Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–54
Web Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–54
Setting General Preferences. . . . . . . . . . . . . . . . . . . . . . . . . 3–55
General Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–56
User Interface Category . . . . . . . . . . . . . . . . . . . . . . . . 3–58
User Interface > Lists Category . . . . . . . . . . . . . . . . . . 3–59
Contents
Understand 2.5 User Guide and Reference Manual v
User Interface > Alerts Category . . . . . . . . . . . . . . . . . 3–60
User Interface > Windows Category. . . . . . . . . . . . . . . 3–61
Key Bindings Category. . . . . . . . . . . . . . . . . . . . . . . . . 3–62
Analyze Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–63
Configure Category . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–64
Command Window Category . . . . . . . . . . . . . . . . . . . . 3–64
Portability Category . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–65
Dependency Category . . . . . . . . . . . . . . . . . . . . . . . . . 3–66
Editor Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–67
Editor > Advanced Category . . . . . . . . . . . . . . . . . . . . 3–70
Editor > Styles Category. . . . . . . . . . . . . . . . . . . . . . . . 3–73
Editor > Browse Category . . . . . . . . . . . . . . . . . . . . . . 3–74
Editor > External Editor Category. . . . . . . . . . . . . . . . . 3–75
Analyzing the Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–77
Converting an Understand 1.4 Project . . . . . . . . . . . . . . . . . 3–79
Chapter 4 Exploring Your Codebase
PLEASE RIGHT CLICK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–2
Various Windows Explained... . . . . . . . . . . . . . . . . . . . . . . . . 4–3
Entity Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–4
Using the Filter Field . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–5
Customizing the Display. . . . . . . . . . . . . . . . . . . . . . . . . 4–5
Root Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–6
Information Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–7
Drilling Down A Relationship . . . . . . . . . . . . . . . . . . . . . 4–8
Displaying More or Less Information . . . . . . . . . . . . . . . 4–9
Searching the Information Browser . . . . . . . . . . . . . . . . 4–9
Syncing the Information Browser . . . . . . . . . . . . . . . . . . 4–9
Visiting Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . 4–10
Visiting References . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–11
Viewing Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–11
Saving and Printing Information Browser Text . . . . . . . 4–12
Entity History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–12
Project Browser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–13
Exploring a Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–15
Dependency Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–16
Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–19
Creating a Favorite. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–19
Using the Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–20
Chapter 5 Searching Your Source
Searching: An Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–2
Instant Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–2
