14.2 Examining functions using the graph views

There are two graph views in the Function Call Browser. The Called By view is the default view. The Function Call Browser appears as in Viewing functions using the "Called By" view.

Viewing functions using the "Called By" view

In this view, the Function Call Browser has five areas.

14.2.1 Function area

The Function area displays the name of the function being examined, and here you can enter the name of another function to examine. You can use completion to reduce typing. This allows you to select from a list of all functions in the current package whose names begin with the partial input you have entered. Invoke completion by Up, Down or click the button. See 3.14 Completion for detailed instructions. When you have entered the complete function name, click to confirm your choice.

14.2.2 Show functions control

The popup list Show functions from packages allows you to restrict the functions displayed based on their package. It affects the display in all views. Below, the current package means the symbol-package of the function currently being examined in the Function Call Browser. The options are:

All	Display all the functions known to the compiler.
Current and Used	Display only those functions in the current package or packages on the package use list of the current package.
Current and Standard	Display only those functions in the current package or the standard packages `COMMON-LISP`, `HCL` and `LISPWORKS`.
Current	Display only functions in the current package.

14.2.3 Graph area

A graph of all the callers of the function is displayed in a graph in the Called By view. The graph area of the Calls Into view is similar, but the graph displayed is of the functions called by the function being browsed.

Note that if source level debugging is off, or the function was not compiled, there is no information to display here. To turn on source level debugging, call:

(toggle-source-debugging t)

The generic facilities available to all graph views in the LispWorks IDE are available here; see 6 Manipulating Graphs for details.

14.2.4 Echo area

The echo area of the Function Call Browser is similar to the echo area of the podium. It displays messages concerning the Function Call Browser.

14.2.5 The function description button

Clicking on Function Description >> changes the view of the Function Call Browser to include more information on the function being browsed. The browser appears as in The Function Call Browser in function description mode.

The Function Call Browser in function description mode

Two further panes appear. Note that the function description button has now changed to Function Description << and that clicking on it restores the view of the Function Call Browser.

The extra panes are a function description area, and a documentation area.

14.2.5.1 Function description area

The Function Description area gives a description of the function selected in the main area, or, if nothing is selected, the current function (as displayed in the Function area). The following items of information are displayed:

Name	The name of the function.
Function	The function object.
Lambda List	The lambda list of the function.
Source Files	The source file in which the function is defined, if any.

You can operate on any of the items in this area using the commands in the Description menu, which is also available as the context menu. This contains the standard actions described in 3.8 Performing operations on selected objects.

14.2.5.2 Documentation area

The Documentation area shows the documentation for the function selected in the main area as returned by the Common Lisp function documentation. If no function is selected, the documentation for the current function is shown.