HP UX SoftBench Software manual

C and C++ SoftBench User's Guide

Manufacturing Part Number: B6454-97413

June 2000

Contents

C and C++ SoftBench User's Guide Page Page Page Table Convention Description boldface font menu Page 1. Maximizing Your Results with SoftBench 2. Using SoftBench 3. Using SoftBench Conﬁguration Manager 4. Using SoftBench Editors 5. Using SoftBench Class Graph/Editor 6. Using SoftBench CodeAdvisor 7. Using SoftBench Debugger Page 8. Using SoftBench Debugger Data Graph Window 9. Using SoftBench Static Analyzer 10. Using Static Graphs 11. Using SoftBench File Compare 12. Using SoftBench Message Monitor 13. Using SoftBench with SQL A. Using SoftBench Graph Windows B. Customizing SoftBench CM Conﬁguration C. Using Regular Expressions D. Customizing SoftBench for Native Language Support (NLS) Glossary Page Maximizing Your Results with SoftBench SoftBench Task Flow Figure Major Software Development Tasks Supported by SoftBench targets build conﬁgurations Understanding Projects Projects SoftBench Tools Interacting with Project and Files Subprojects Building Targets target Building Sources into Targets Using Project's Build Instructions Understanding Build Conﬁgurations and Packages build conﬁguration package transform Simpliﬁed Build Conﬁguration, Package, and Transform Series Choosing Between Project Build and External Build Models project build external build alternate source roots Sharing Projects with a Team project description subprojects One Project, One Author One Project, Many Authors Team Members Cloning the Project Deﬁnition Team Members Sharing the Project Deﬁnition One Project with Subprojects, Many Authors Team Members Using Subprojects Page Planning Your Project Using the SoftBench Integrated Environment Main SoftBench Window with Builder and SoftBench CodeAdvisor Editors Conﬁguration Management SoftBench Static Analyzer SoftBench Debugger SoftBench File Compare SoftBench Message Monitor Using SoftBench Tools Throughout Your Development Cycle Using SoftBench Tools Together Tools That Can Directly Invoke Other Tools Using SoftBench Tools on Multiple Projects Figure 1-10Iconize and Normalize Project Buttons Using SoftBench Tools as Standalone Tools Reusing Tool Windows Copying Data between SoftBench Tools An Example SoftBench Session project build Page Learning SoftBench Using SoftBench Prerequisites to Using SoftBench Shell Syntax Starting SoftBench Understanding SoftBench Window Areas Unexpanded SoftBench Window Description of SoftBench Window Areas Window Area local workspace root Page Understanding the Builder Page Expanded SoftBench Window Displaying Builder Page Understanding the SoftBench CodeAdvisor Page Expanded SoftBench Window Displaying SoftBench CodeAdvisor Page Page Setting Up a Project local workspace root Creating a Project Using Project Build Figure 2-4Create Project" Dialog Box Creating a Project Using External Build External build Figure 2-5"Create Project" Dialog Box for External Build Cloning a Project from an Existing Project Repartitioning an Existing Project subproject Creating a Subproject Modifying a Project Deﬁnition Creating Files within a Project Adding Existing Files to a Project "Add Files to Project" Dialog Box Page Deﬁning Targets for Project Build Creating a Target Figure 2-7"Deﬁne New Targets" Dialog Box Specifying Dependency Relationships Customizing Build Conﬁgurations packages Figure 2-8"Manage Build Conﬁguration" Dialog Box Using Build Packages build packages Deﬁning Targets for External Build Figure 2-9"External Build Command" Dialog Box Page Using the Target Graph Figure 2-10Target Graph in Builder Page Build Model Operations in the Target Graph Operation Project Build intermediate ﬁles Understanding the Graph intermediate ﬁles source Graph Node States Color Meaning Displaying Dependencies Controlling Graph Complexity Building a Selected Target Starting Your Conﬁgured Editor Building Projects and Targets Setting the Compile Mode Compile Mode Settings Compile Mode Default Compiler Flag Using the "External Build Command" Dialog Box Previewing the Build Compiling Instead of Building Building Subprojects Handling Errors Interpreting Error Messages Browsing and Correcting Build Errors Running the Build on a Remote System Checking Your Code Using SoftBench CodeAdvisor Running Other SoftBench Tools Managing Your SoftBench Environment Adding and Removing Tool Icons Choosing Tool Preferences Registering New Tools with SoftBench Customizing SoftBench by Setting Resources Accessing Distributed Data and Tools Running SoftBench on a Remote System Integrating with CDE Stopping SoftBench Restoring Your Previous SoftBench Session Getting Help Figure 2-11SoftBench Online Help Window Using the Help Menu Accessing On Item Help If Something Goes Wrong Condition or Explanation Message external For More Information Page Using SoftBench Conﬁguration Manager Understanding SoftBench CM Integration of SoftBench CM with SoftBench archives versioned ﬁles mapping Page Getting Started - A Brief Overview Page Page Managing the Archive System archive revisions mappings Browsing Local Network Servers and Archives Figure 3-2Viewing Local Servers and SoftBench CM Archives SoftBench CM Main Window Creating an Archive Directory Creating a Mapping between an Archive Directory and Local Directory SoftBench CM File Mapping Modifying Mappings between Local and Archive Directories symbolic names "Show / Modify Mappings" Dialog Box Page Managing Archive Files and Directories Creating Initial Archive Files Checking Out Archive Files ﬁle revision Cancelling Archive File Check Out Updating a Local Directory Viewing Contents of Archive Files Viewing an Archive File Deleting Archive Files and Directories Locking an Archive File Breaking a Lock on an Archive File "Break File Lock" Dialog Box Viewing the Revision History of Archive Files revision history "Show Revision History" Dialog Box for an Archive File Setting Archive Display Filters Managing Local Files Modifying Local Source Files Checking In Modiﬁed Files Page Creating a Default Symbolic Name for Archive Files revision symbolic name Understanding Symbolic Names Deﬁning Symbolic Names Symbolic Name Example Symbolic Names and Revision Numbers File File Y Revision Symbolic Name Using the SoftBench CM Command Line Interface SoftBench CM Command Line Man Pages Man Page Task Description Page Using SoftBench Editors Using Editors with Projects Conﬁguring an Editor Conﬁguring SoftBench vi Editor Conﬁguring SoftBench Program Editor Page Starting the Conﬁgured SoftBench Editor Editing with SoftBench XEmacs Editor Using SoftBench XEmacs SoftBench XEmacs Main Window Accessing Help Editing Multiple Files Page Editing with SoftBench vi Editor SoftBench vi Editor Window Using the Mouse Pointer Versus the Text Cursor If the vi autowrite SoftBench vi Editor's behavior option Reusing the Edit Window Status of "■ Reuse Window Selecting, Copying, and Pasting Text Calling Other SoftBench Tools from the Editors Compiling a Program File Building a Project Accessing SoftBench Static Analyzer from the Editor Setting Breakpoints in a Program File Using Conﬁguration Management Page Using SoftBench Class Graph/Editor Editing C++ Structures with SoftBench Class Graph/Editor Understanding the SoftBench Class Graph/Editor Use Model SoftBench Class Graph/Editor Use Model Using SoftBench Class Graph/Editor with Other SoftBench Editors Synchronizing Editor Views and the Static Database Page Using SoftBench Class Graph/Editor in Your Work Viewing the Existing Class Hierarchy Creating New Components Modifying Existing Components Deleting Existing Components Sample Use Models Creating a New Program Modifying an Existing Program Working with Class Templates Page Condition Page Using SoftBench CodeAdvisor Page Page Comparing SoftBench CodeAdvisor to Debuggers or Dynamic Analyzers Performing the "Check Code" Operation Preparing Your Program with Project Build Preparing Your Program with External Build Accessing SoftBench CodeAdvisor Selecting Rule Groups Checking Your Program Viewing Violations Violations Display Terminating SoftBench CodeAdvisor Filtering Rule Violations Page Page Using SoftBench Debugger Understanding SoftBench Debugger watchpoint Page Preparing Your Program for Debugging Using SoftBench Debugger Window Areas SoftBench Debugger Window Current Location breakpoint Tearing Apart the Main Toolface Tear Apart Main Toolface Page Loading or Rerunning an Executable Program Specifying the Runtime Environment "Load Executable" Dialog Box Specifying the Working Directory and Program Arguments Specifying Standard I/O Setting Environment Variables Specifying Source Locations Debugging Executables in a Project Adding Source Directories for External Builds "Add Source Directories" Dialog Box Stepping through Your Program single step Interrupting a Running Program Interrupting in System or Non-debuggableRoutines Page Interacting with Your Program Interacting with a Standard I/O Program Interacting with a Terminal-SmartProgram Interacting with a Window-SmartProgram synchronous mode keyboard focus Specifying Identiﬁer Locations Specifying Program Location location Specifying Variables Page Page Examining and Changing Data in Your Program Examining Data in Your Program Printing Hex or String Values Changing Data in Your Program Using Debugger Variables Using Expressions Using Constants Calling Functions Viewing the Call Stack "Stack View" Window Viewing Thread Stacks Understanding the Operation of Your Program monitors Setting and Using Breakpoints Debugging a Program Using Breakpoints Setting a Breakpoint Using the Editable Source Area "Break" Menu Using the Break Menu Using the Breakpoint Set/Change Dialog Box "Breakpoint Set/Change" Dialog Box Viewing and Modifying Breakpoints Changing Active / Suspend Status Changing Verbose / Silent Status Clearing a Breakpoint Executing DDE Commands at a Breakpoint Page Setting C++ Breakpoints Setting Group Breakpoints Viewing and Modifying Group Breakpoints Page Setting and Using Watchpoints Creating Watchpoints Using the Watch Menu Using the "Data Watchpoint Set/Change" Dialog Box Viewing and Modifying Watchpoints "Data Watchpoint" Window Clearing a Watchpoint Page Tracing Program Flow Creating Traces Using the Trace Menu Using the Trace Set/Change Dialog Box "Trace Set/Change" Dialog Box Viewing Traces Clearing Traces Correcting Errors in Your Program Editing Source Code Synchronizing Files Debugging Dynamic Libraries Page Viewing Assembly Language and CPU Registers Tracing Assembly Language Figure 7-11"Assembly Instructions" Window Tracing Registers Figure 7-12"Show Registers" Window (PA-RISC) Handling Signals and Events intercepts Viewing and Editing Intercepts Figure 7-13"Intercepts" Dialog Box Handling Signals Debugging After a Program Fails (Core Dump) Signal Error Message Text Name Debugging with a Core File Page Debugging Forked Processes Debugging Threaded Applications Viewing and Manipulating Threads Setting Breakpoints on Threads Attaching the Debugger to a Running Program Debugging C++ Programs Page Using Breakpoints for Exception Handling Accessing Inherited C++ Values Debugging Static Constructors Page Debugging Optimized Code In effect, optimization transforms a program into a different program Customizing SoftBench Debugger Specifying Debugger Options Customizing User Buttons Page Page Page Page Page Page Using SoftBench Debugger Data Graph Window Starting and Stopping the Data Graph Window Beginning a Browsing Session Stopping a Browsing Session Understanding Data Graph Window Areas Nodes Arcs Data Graph Window Areas Understanding the Layout Control Area Understanding the Display Control Area Understanding the Graph Area Data Graph Window Action Menus Object Selected Actions Allowed Reading Nodes Reading Arcs Using Dialog Boxes Understanding the Window Control Area Using the Graph Area Displaying New Nodes Using the "Node Values" Dialog Box "Node Values" Dialog Box Node Values Dialog Box Action Menu Displaying Data Members Setting Data Member Values Following Selected Pointers Suspending Graph Updates Deactivating the Graph Stopping a Graph Process Verifying Correct Data Structures Viewing btree Binary Tree Node Continuing Program Execution Binary Tree Node with Children Showing Nodes Dereferencing Particular Data Members Viewing Values of Data Members Viewing Values from Multiple Nodes Viewing Embedded Arrays Viewing Values from Embedded Arrays Showing Values On the Graph Viewing Data Members on The Graph Nodes Page Using SoftBench Static Analyzer Starting SoftBench Static Analyzer queries Page Preparing to Make Queries Generating Static Data Static database Updating Static Data without Building Specifying Static Data to Analyze analysis ﬁle set Using the Default Analysis File Set Including Subprojects and Parent Projects Static databases Customizing the File Set in Non-ProjectMode Keeping Analysis Files Current Filtering Queries by File Set Determining the File Set Status Using SoftBench Static Analyzer Window Areas scope query SoftBench Static Analyzer Window and Areas Making Textual Static Queries Making General Queries Making Queries Based on a Program Identiﬁer Selecting Text Understanding the Types of References Relationships among Reference Queries Determining Identiﬁer Classiﬁcation Troubleshooting Invalid Identiﬁers for Queries Using Pattern Matching Scoping Using Query Results Browsing the Query Result Editing the Source File Updating the Database Performing a Query Simplifying Query Results SoftBench Static Analyzer Display Options Command Filtering Results Using the File Set Unﬁltered Source File List Filtered Source File List Filtering C++ Query Results Using Scoping Scoping Prerequisites and Constraints Troubleshooting Scoping Information Scoping Example Page Redisplaying Past Queries Redisplaying Query Results Deleting a Query Result Saving and Printing a Query Result Page Using SoftBench Static Analyzer in Standalone Mode Generating Static Data from the Command Line Static data Searching Subdirectories Using the Staticﬁleset File Customizing SoftBench Static Analyzer Condition or Message Analysis ﬁle set (choose "File: Page Static database scoping Page Page Page Page 10 Using Static Graphs Page Starting SoftBench Static Analyzer Graphs Making Graphical Static Queries General Static Graph Features Finding Graph Nodes Operating on Static Graph Nodes Switching between Static Graphs Displaying Nodes on Another Graph Using Description Boxes Figure 10-1"Function Description" Dialog Box Setting Breakpoints for SoftBench Debugger Saving Static Graph Images to Files Page Simplifying Graph Displays Reducing Graph Complexity Filtering Sourceless Nodes Customizing Static Graphs Removing the Graph Legend Viewing Multiple Graphs 11 Using SoftBench File Compare Understanding the SoftBench File Compare Window Figure 11-1SoftBench File Compare Window Understanding the Menu Bar Understanding the "Working Directory" Input Box Using the "Left File" and "Right File" Input Boxes Using the "Merge File" Input Box Understanding the Text Areas Reading the Gutter Column Left Right Selection Column Selecting Lines for Merging Highlighting Differences Traversing by Single Line Comparing Two Files Merging Compared Files Page Page Page 12Using SoftBench Message Monitor Starting SoftBench Message Monitor Understanding the SoftBench Message Monitor Window Area Figure 12-1SoftBench Message Monitor Understanding Broadcast Messages Clearing the Broadcast Message Area Composing and Sending a Message Figure 12-2"Send Message" Dialog Box Page Logging Messages Specifying a Log File Starting and Stopping Message Logging Page 13 Using SoftBench with SQL Determining Supported Environments Conﬁguring SoftBench with SQL Using Default SQL File Types SQL File Extensions for C Language RDBMS Embedded SQL File Page Using SQL with External Build Updating RDBMS Versions Page Using SQL with SoftBench Tools Using SQL Preprocessor Wrappers Debugging with SQL Debugging Expanded SQL Statements Editing and Rebuilding with SQL for SoftBench Debugger Using SoftBench CodeAdvisor and SoftBench Static Analyzer with SQL Page A Using SoftBench Graph Windows Accessing SoftBench Graph Windows Table A-1 Accessing SoftBench Graphs Starting From Procedure Page Using Graph Window Areas Using Popup Menus Using Save Options for the Graph Image Table A-2 Graph Image File Formats Option Used for Figure A-1 Using Graph File Image Save Options Saving HP-GLand PostScript Images Saving xwd Images Using Vertical and Horizontal Scrolling arrows click Figure A-2 Using Scroll Bars Zooming In or Zooming Out Clearing the Graph Area Understanding Nodes and Arcs Reading Graph Area Nodes nodes arcs Table A-3 Figure A-3 Selecting Objects by Dragging the Pointer Table A-4 Methods for Selecting Multiple Objects Objects Moving Nodes Figure A-4 Moving Multiple Nodes Customizing SoftBench Graphs Controlling Graph Layout Controlling Graph Display Table A-5 Controlling the Graph Display Understanding Window Status Information Page B Customizing SoftBench CM Conﬁguration Modifying the Conﬁguration Files Table B-1 Server Conﬁguration Files File Name Conﬁguring Where Archive Files are Stored Figure B-1 File Mapping Between Local and Archive Files Deﬁning User Access to the Server Table B-2 Options Used in the cm.permission and cm.option Files Page Recommended Format for Permissions File Format 1. Place user ﬁeld ﬁrst and permissions ﬁeld second Format 2. Place path ﬁeld ﬁrst and permissions ﬁeld second Setting Logging and Debug Options Controlling Client Machine Access to the SoftBench CM Server on HP-UX Page Performing SoftBench CM Administrator Tasks Migrating Archive Files From RCS Migrating Archive Files From SCCS Modifying the Lockinfo File Creating Archive Backups Moving Archive Storage Locations Page Troubleshooting Using the Archive Status and Error Log Using the Archive Activity Log Page Using Regular Expressions Pattern Matching Table C-1 Description of Special Characters in Regular Expressions To… Use… Page Page Page Page Page Page D Customizing SoftBench for Native Language Support (NLS) Preparing to Use NLS in SoftBench Page Setting the LANG Environment Variable Table D-1 To have LANG apply to: Set LANG in: To have LANG apply to: Set LANG in: Converting from One Encoding Method to Another Rebinding Alt SoftBench Mnemonics and Non-USASCIICharacter Inputs Changing or Removing Menu Mnemonics Page SoftBench Keyboard Accelerators and Non-USASCIICharacter Inputs Customizing Keyboard Accelerators Page Starting Your Localized SoftBench Remote Execution Hosts and NLS Editing in SoftBench Character Input Example Page Accelerator Alternate Source Root local workspace Analysis File Set Archive Compile Build Conﬁguration Check In Check Out Child Process Click Clipboard Double-click Drag and drop Edit Area Embedded SQL Source Code Environment Variable Execution Host File Revision File Server File Set Files View project browser Filter Intermediate File Keyboard Focus Local Workspace Root Location Lock Makeﬁle Mapping Menu menu bar Menu Bar Package Popup Menus Primary Selection Project Project Browser Projects view Files view Project Description Data See also Project Root Push Buttons Query Radio Buttons Revision history Scope Subproject Synchronous Mode Target Toggle Buttons Token Tracepoint Transform Unlock Working Directory X Resources Symbols