GUI: Side By Side Source Listing

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

GUI Reference: Side By Side Source Listing

The Side By Side Source Listing contains multiple panels, each containing a source listing scrolled to a particular function. This feature allows users to explore call paths in greater detail by examining the code involved.

Navigating To
Page Contents
Panel Ordering and Call Site Highlighting
Navigating From

Important Note: the CodeSonar GUI makes extensive use of JavaScript. Make sure JavaScript is enabled in your web browser.

Navigating To

From Explore Callers	Click Show Procedures to procname in the pop-up menu for a call tree node.
From Search Callers results	Click side-by-side (on the View Path line) in an expanded path entry.

Page Properties

Output formats

none

Visibility Filter Applied

none

RBAC Permissions Needed

Page Access	ANALYSIS_READ ANALYSIS_WARNING_READ
Page Contents/Functionality	ANALYSIS_WARNING_EXISTS

Page Contents

The following annotated screenshot shows the various parts of the side by side source listing.

annotated screenshot: side by side view

Panel Ordering and Call Site Highlighting

The number of panels in the view will depend on the number of function nodes selected when the view was invoked: each function appears in its own panel. Panel boundaries can be adjusted by dragging, and each panel scrolls independently.

The name of the function appears in the panel header.
The panel contains a code excerpt from the file containing the function, scrolled to the function definition. The excerpt may be elided, in which case and links allow you to extend the excerpt further back and forward, respectively.
The full path name of the file is provided at the top of the excerpt. Click to navigate to the Source Listing for the file.
Each code excerpt has the same interaction and navigation functionality as a Source Listing page.
- Source coloring and navigation: for full details, see Source Coloring and Interaction.
- The Information Window is available and will interact with any function, variable, macro, or type name in the listing.

In most cases, the side by side view is used to examine a call sequence, as in the diagram below. The left-to-right ordering of the panels is the same as the call order in the sequence.

The call site to the next function in the selected path is highlighted. There may be multiple such call sites, in which case they are all highlighted.

(If the selected functions form a call cycle, the tool will choose one function to be the start of the sequence.)

schematic: select a path; view side by side

If the selected function nodes do not form a single call sequence, the tool will assemble path fragments to the extent possible.

Navigating From

view a source listing	Click a line number in any panel, or click the file name at the top of any file listing.

To report problems with this documentation, please visit https://support.codesecure.com/.