Contents Contents CHAPTER 1 INTRODUCTION ........................................................................................ 1 The Big Picture ................................................................................................. 2 Feature Highlights............................................................................................ 3 System Requirements:.............................................................................................14 Technical Support .......................................................................................... 14 CHAPTER 2 SETUP AND QUICK START........................................................................ 15 Installing Source Insight................................................................................. 15 Installing on Windows NT/2000/XP .........................................................................15 Upgrading from Version 2.......................................................................................15 Upgrading from Version 3.0 and 3.1 ........................................................................16 Insert the CD-ROM..................................................................................................16 Choosing a Drive for the Installation .......................................................................16 Using Version 3 and Version 2 Together ...................................................................17 Configuring Source Insight .....................................................................................17 Entering Your Serial Number ...................................................................................17 Creating Common Projects .....................................................................................17 Creating a Project...................................................................................................18 CHAPTER 3 WINDOW TOUR ...................................................................................... 21 Source Insight Application Window............................................................... 21 Toolbars ......................................................................................................... 22 Source File Windows ...................................................................................... 26 Symbol Windows ........................................................................................... 27 Floating Windows .......................................................................................... 29 Project Window.............................................................................................. 30 Opening Files Quickly .............................................................................................31 Project Window Views.............................................................................................31 Context Window ............................................................................................ 34 Previewing Files......................................................................................................35 Showing Declarations and Definitions ....................................................................35 Decoding Base Types to Show Structures.................................................................37 Customizing the Context Window ..........................................................................38 Source Insight User Manual i Contents Relation Window............................................................................................ 39 Outline and Graph Views........................................................................................ 40 Relationship Types ................................................................................................. 40 Relation Window Performance............................................................................... 40 Relationship Rules.................................................................................................. 41 Call Graphs............................................................................................................ 41 Multiple Relation Windows..................................................................................... 41 Customizing the Relation Window.......................................................................... 41 Clip Window................................................................................................... 42 What Is A Clip? ....................................................................................................... 42 Creating a New Clip ............................................................................................... 42 Clip Storage ........................................................................................................... 43 Search Results Window.................................................................................. 43 CHAPTER 4 SOURCE INSIGHT CONCEPTS .................................................................... 45 Projects .......................................................................................................... 45 Project Features ..................................................................................................... 47 Creating a Project .................................................................................................. 47 Project Directories.................................................................................................. 47 Normalized File Names .......................................................................................... 48 The Project List....................................................................................................... 49 Adding Files to a Project ......................................................................................... 49 Removing Files from a Project................................................................................. 50 Closing Projects ..................................................................................................... 50 Opening Projects.................................................................................................... 50 Removing a Project ................................................................................................ 51 Changing Project Settings ...................................................................................... 51 Working in a Team Environment.................................................................... 51 Using a Network .................................................................................................... 52 Adding Remote Files to a Project............................................................................. 52 Using Source Control.............................................................................................. 53 Understanding Symbols and Projects............................................................ 54 Languages Used to Parse Source Files..................................................................... 54 Symbol Naming..................................................................................................... 54 Updating the Symbol Database ............................................................................. 55 File Names Are Like Symbols................................................................................... 55 Synchronizing Project Files ..................................................................................... 55 Using Common Projects: The Project Symbol Path................................................... 56 Searching the Project Symbol Path ......................................................................... 57 Working With No Project Open ............................................................................... 57 The Base Project..................................................................................................... 57 Programming Languages .............................................................................. 58 Built-In Languages................................................................................................. 58 Custom Languages ................................................................................................ 58 .Net Framework Support ........................................................................................ 59 ii Source Insight User Manual Contents Using HTML............................................................................................................59 Using HTML and ASP Compound Languages...........................................................59 Java Language Editing ...........................................................................................60 C/C++ Language Features.............................................................................. 60 Working with Inactive Code - ifdef Support..............................................................60 Conditional Parsing................................................................................................61 Preprocessor Token Macros.....................................................................................62 Parsing Considerations ...........................................................................................65 Coding Tips for Good Parsing Results ......................................................................65