Symbol Browser

Overview

Definition

Declarations

Uses Of

Assignments To

Calls To

Calls Within

Uses Within

Naming Convemtopn Rule

Global Functions

Global Variables

Global Constants

Global Types

Global Macros

Overview

The Symbol Browser provides a way of showing the declarations and uses of symbols, calls to, calls within and uses within functions, assignments to variables, as well as presenting global (project scope) functions, variables, constants, types, and macros. The Browser is also used by the Search / Find All and Search / Replace All functions for displaying search results. The Replace All function displays two source code lines for each replacement, where the first, beginning with "(old)", is the original one and the second, beginning with "(new)", is newly created.

The Browser provides two ways of presenting information. The first one shows the actual source code lines in connection with the desired information, while the second one shows the list of symbols of the specified type.

The first display type is used with the Browse >Declarations, Browse > Uses, Browse >Assignments, Browse > Calls To and Browse > Calls Within commands, as well as with the Search / Find All and Search / Replace All functions.

The second display type is used with the Browse >Uses Within, Browse > Global Functions, Browse >Global Variables, Browse > Global Constants, Browse > Global Types and Browse > Global Macros commands.

To locate the desired information in the lists of global functions, variables, constants, types and macros more easily, use the incremental search. The desired item in the list is found by means of the search string you type while working in a Browser.

Before the typed character is actually appended to the existing search string, the list is inspected for a symbol with a name beginning with the newly created string. If such a symbol exists, the character will be appended to the incremental search string, and the insertion point will be positioned at the appropriate symbol. Otherwise, a typed character will be ignored. An incremental search string can be deleted at any time by pressing the Escape key, while the character last entered can be removed by pressing the Backspace key. A non-empty search string will be displayed in the window title. The maximum length of the search string is 32 characters.

Right-clicking a symbol listed in a Browser activates the shortcut menu. See  "Shortcut Menu"

The contents of the Browser can be printed using the File > Print command.

Definition

The Browse > Definition command does not use the Browser; instead, it positions the insertion point directly where the definition is positioned in a source code file.

Browser - Definition command results (Editor window)

The Browse > Definition command results (Editor)

Declarations

Browser - Declarations command results

The Browse > Declarations command results

Uses Of

Browser - Uses command results

The Browse > Uses command results

For each source code file in which the desired information was found, a separate section (or sections) is created. Each section begins with a text line containing the name of the file and/or the function holding the desired information.

Double-clicking this line positions the insertion point at the beginning of the named file or function, while the same action in the source code lines positions the insertion point at the appropriate place in the program module. If the destination file already exists in an Editor, it becomes active. Otherwise, a new Editor is opened.

Assignments To

Browser - Assignments command results

The Browse > Assignments command results

Calls To

Browser - Calls To command results

The Browse > Calls To command results

Calls Within

Browser - Calls Within command results

The Browse > Calls Within command results

Uses Within

Browser - Uses Within command results

The Browse > Uses Within command results

Browser shows the list of symbols grouped according to the scope of definition (global, module, local) for the Uses Within command, or alphabetically sorted for all other commands. The list of symbols for the Uses Within command begins with a text line containing the name of the file and/or the function that is being examined. Double-clicking this line positions the insertion point at the beginning of the named file or function, while the same action in any other line positions the insertion point at the position of the definition of the named symbol in the corresponding program module.

Naming Convention Rule

Browser - Uses Within command results

Editor shows Naming Convention Rules file on the line with the corresponding rule.

Global Functions

Browser - Global Functions command results

The Browse > Global Functions command results

Global Variables

The Browse > Global Variables command results

The Browse > Global Variables command results

Global Constants

Browser - Global Constants command results

The Browse > Global Constants command results

Global Types

Browser - Global Types command results

The Browse > Global Types command results

Global Macros

Browser - Global Macros command results

The Browse > Global Macros command results