NextPrevTopIndex

Contents

Preface

1 Introduction

1.1 Major tools

1.1.1 The Listener

1.1.2 The Editor

1.1.3 The Class Browser

1.1.4 The Output Browser

1.1.5 The Inspector

1.1.6 The Object Clipboard

2 A Short Tutorial

2.1 Starting the environment

2.2 Creating a Listener

2.3 Using the Debugger

2.4 Viewing output

2.5 Inspecting objects using the Inspector

2.6 Examining classes in the Class Browser

2.7 Switching between windows

2.8 Summary

3 Common Features

3.1 Displaying tool windows

3.1.1 Displaying existing windows

3.1.2 Iconifying existing windows

3.1.3 Displaying tools

3.1.4 Re-using tool windows

3.1.4.1 Global control of re-use

3.1.4.2 Per-window control of re-use

3.1.5 Copying windows

3.1.6 Closing windows

3.1.7 Updating windows

3.2 Setting global preferences

3.2.1 The windows options

3.2.2 Initialization file

3.3 Quitting the environment

3.4 Performing editing functions

3.4.1 Undoing changes

3.4.2 Using the clipboard

3.4.3 Selecting text and objects

3.4.4 Searching for text and objects

3.5 The history list

3.5.1 Repeating events from the history list

3.5.2 Editing the history list

3.6 Operating on files

3.7 Displaying packages

3.7.1 Specifying a package

3.8 Performing operations on selected objects

3.8.1 Operations available

3.9 Using different views

3.9.1 Sorting items in views

3.10 Tracing symbols from tools

3.11 Linking tools together

3.12 Filtering information

3.13 Examining a window

4 Getting Help

4.1 Online manuals in HTML format

4.1.1 Browsing manuals online

4.1.2 Searching the online manuals

4.1.3 Getting help on the current tool

4.1.4 Getting help on the current symbol

4.1.5 Getting help from the LispWorks website

4.1.6 Getting patches from the LispWorks website

4.1.7 Configuring the browser used

4.2 Online help for editor commands

4.3 Browsing manuals online using Adobe Reader

4.4 Reporting bugs

5 Manipulating Graphs

5.1 An overview of graphs

5.2 Searching graphs

5.3 Expanding and collapsing graphs

5.3.1 Expanding and collapsing by clicking

5.3.2 Expanding and collapsing by menu commands

5.4 Moving nodes in graphs

5.5 Displaying plans of graphs

5.6 Preferences for graphs

5.6.1 Altering the depth and breadth of graphs

5.6.2 Displaying different graph layouts

5.7 Using graphs in your programs

6 LispWorks menus and the toolbar

6.1 LispWorks menus

6.2 The LispWorks toolbar

6.3 Specifying the initial tools

7 The Class Browser

7.1 Simple use of the Class Browser

7.1.1 Examining slots

7.1.2 Examining inherited slots

7.1.3 Filtering slot information

7.1.4 Examining other classes

7.1.5 Sorting information

7.2 Examining slot information

7.2.1 Class box

7.2.2 Filter box

7.2.3 Slots list

7.2.4 Description list

7.2.5 Performing operations on the current class

7.3 Examining superclasses and subclasses

7.3.1 Class box

7.3.2 Superclasses list

7.3.3 Subclasses list

7.3.4 Description list

7.3.5 Performing operations on the selected classes or the current class

7.4 Examining classes graphically

7.4.1 Class box

7.4.2 Subclasses and superclasses graphs

7.4.3 Description list

7.4.4 Performing operations on the selected classes or the current class

7.4.5 An example

7.5 Examining generic functions and methods

7.5.1 Class box

7.5.2 Filter box

7.5.3 List of functions or methods

7.5.4 Description list

7.5.5 Performing operations on the current class

7.5.6 Operations specific to the current function or method

7.6 Examining initargs

7.6.1 Class box

7.6.2 Filter box

7.6.3 List of initargs

7.6.4 Description list

7.6.5 Performing operations on the current class

7.7 Examining class precedences

7.7.1 Class box

7.7.2 Filter box

7.7.3 List of precedences

7.7.4 Description list

7.7.5 Performing operations on the selected classes or the current class

8 The Object Clipboard

8.1 Placing objects on the Object Clipboard

8.1.1 The Listener

8.1.2 The Class Browser

8.1.3 The Inspector

8.1.4 The Function Call Browser

8.1.5 The Generic Function Browser

8.1.6 The Debugger

8.1.7 The Stepper

8.1.8 The System Browser

8.1.9 General clipping

8.2 Browsing clipped objects

8.2.1 The Inspector

8.2.2 The Class Browser

8.2.3 The Listener

8.2.4 General browsing

8.2.5 Pasting of clipped objects

8.3 Removing objects

8.4 Filtering

8.5 Using the Object Clipboard with a Listener

9 The Compilation Conditions Browser

9.1 Introduction

9.2 Examining error conditions

9.3 Configuring the display

9.3.1 Package names preferences

9.3.2 Pathname preferences

9.3.3 Condition type preferences

9.4 Access to other tools

10 The Debugger Tool

10.1 Description of the Debugger

10.1.1 Condition box

10.1.2 Backtrace area

10.1.3 Toolbar buttons

10.2 What the Debugger tool does

10.3 Simple use of the Debugger tool

10.4 The stack in the Debugger

10.5 An example debugging session

10.6 Performing operations on the error condition

10.7 Performing operations on stack frames

10.7.1 Source location, documentation and method combination

10.7.2 Restarts and returning from the frame

10.7.3 Tracing the function in the frame

10.8 Performing operations on frame variables

10.9 Configuring the debugger tool

10.9.1 Configuring the call frames displayed

10.9.2 Displaying package information

10.9.3 Behavior on closing the Debugger

11 The Editor

11.1 Displaying and editing files

11.1.1 The toolbar

11.1.2 The editor window

11.1.3 The echo area

11.1.4 Using keyboard commands

11.2 Displaying output messages in the Editor

11.3 Displaying and swapping between buffers

11.3.1 Filter box

11.3.2 Buffers area

11.4 Displaying Common Lisp definitions

11.4.1 Filter box

11.4.2 Definitions area

11.5 Changed definitions

11.5.1 Setting the reference point for changed definitions

11.6 Finding definitions

11.7 Setting Editor preferences

11.7.1 Sorting items in lists

11.7.2 Displaying package information

11.7.3 Configuring editor key input

11.7.3.1 Choosing the key input style

11.7.3.2 Specifying a Meta key

11.7.3.3 Preserving your setting

11.7.4 Setting the editor font

11.7.5 Setting the text style attributes

11.7.6 Setting the default encodings

11.8 Basic Editor commands

11.8.1 Opening, saving and printing files

11.8.2 Moving around files

11.8.3 Inserting and deleting text

11.8.4 Using several buffers

11.9 Other essential commands

11.9.1 Aborting commands

11.9.2 Undoing commands

11.9.3 Repeating commands

11.10 Cutting, copying and pasting using the clipboard

11.11 Cutting, copying and pasting using the kill ring

11.11.1 Marking the region

11.11.2 Cutting or copying text

11.11.3 Pasting text

11.12 Searching and replacing text

11.12.1 Searching for text

11.12.2 Incremental searches

11.12.3 Replacing text

11.13 Using Lisp-specific commands

11.13.1 Lisp mode

11.13.2 Current buffers, definitions and expression

11.13.3 Evaluating code

11.13.4 Compiling code

11.13.4.1 Compiling in memory

11.13.4.2 Compiling to a file

11.13.5 Breakpoints

11.13.5.1 Setting breakpoints

11.13.5.2 Editing breakpoints

11.13.5.3 Removing breakpoints

11.13.6 Tracing symbols and functions

11.13.7 Packages

11.13.7.1 The primary package

11.13.7.2 The current package for Lisp operations

11.13.8 Indentation of forms

11.13.9 Other facilities

11.14 Help with editing

12 The Function Call Browser

12.1 Introduction

12.2 Examining functions using the graph views

12.2.1 Function area

12.2.2 Show functions control

12.2.3 Graph area

12.2.4 Echo area

12.2.5 The function description button

12.2.5.1 Function description area

12.2.5.2 Documentation area

12.3 Examining functions using the text view

12.3.1 Called By area

12.3.2 Calls Into area

12.4 Configuring the function call browser

12.4.1 Sorting entries

12.4.2 Displaying package information

12.5 Configuring graph displays

12.5.1 Graph layout settings

12.5.2 Graph expansion settings

12.5.3 Plan mode settings

12.6 Performing operations on functions

13 The Generic Function Browser

13.1 Examining information about methods

13.1.1 Function box

13.1.2 Filter box

13.1.3 Methods list

13.1.4 Description list

13.1.5 Performing operations on the current function or selected methods

13.2 Examining information about combined methods

13.2.1 Function box

13.2.2 Signatures button

13.2.3 Arguments types box

13.2.4 List of method combinations

13.2.5 Description list

13.2.6 Restricting displayed signatures by class

13.3 Configuring the Generic Function Browser

14 The Grep Browser

14.1 Introduction

14.2 Performing grep command searches

14.2.1 Grep arguments

14.2.2 Specifying the grep command manually

14.3 Displaying grep matches

14.4 The grep command history

14.5 Configuring the grep command

14.6 Configuring the display

14.6.1 Showing and hiding filenames

14.6.2 Showing and hiding line information

15 The Inspector

15.1 Description of the Inspector tool

15.1.1 Adding a Listener to the Inspector

15.2 Examining objects

15.3 Filtering the display

15.4 Operating upon objects and items

15.4.1 Examination operations

15.4.1.1 Example

15.4.1.2 Recursive inspection

15.4.2 Inspecting attributes

15.4.3 Tracing slot access

15.4.4 Manipulation operations

15.4.4.1 Example

15.4.5 Copying in the Inspector

15.5 Configuring the Inspector

15.6 Customizing the Inspector

15.7 Creating new inspection formats

15.7.1 Example

16 The Listener

16.1 The basic features of a Listener

16.2 Evaluating simple forms

16.3 Re-evaluating forms

16.4 Interrupting evaluation

16.5 The History menu

16.6 The Expression menu

16.7 The Values menu

16.8 The Debug menu

16.9 Execute mode

16.9.1 History commands

16.9.2 Debugger commands

16.9.3 Miscellaneous Listener commands

16.10 Setting Listener preferences

16.11 Switching to and from other tools

16.12 Help with editing in the Listener

17 The Output Browser

18 The Process Browser

18.1 The process list

18.2 Process control

18.3 Other ways of breaking processes

18.4 Updating the Process Browser

19 The Profiler

19.1 Introduction

19.2 Display of Profiler Data

19.2.1 Call Tree

19.2.2 Cumulative Results

19.3 A description of profiling

19.3.1 Description of call tree data

19.3.2 Description of cumulative data

19.4 Steps involved in profiling code

19.4.1 Choosing the functions to profile

19.4.1.1 Choosing individual functions

19.4.1.2 Choosing packages

19.4.2 Specifying the code to run while profiling

19.4.3 Performing the profile

19.5 Format of the cumulative results

19.6 Interpreting the cumulative results

19.7 Profiling pitfalls

19.7.1 Effects of random sampling

19.7.2 Recursive functions

19.7.3 Structure accessors

19.7.4 Consequences of restricted profiling

19.7.5 Effect of compiler optimizations

19.7.6 Effect of compiler transforms

19.8 Some examples

20 The Shell and Remote Shell Tools

20.1 Introduction

20.2 The Shell tool

20.3 Command history in the shell

20.4 Configuring the shell to run

20.5 The remote shell tool

21 The Stepper

21.1 Introduction

21.1.1 Stepper toolbar

21.1.2 Source area

21.1.3 Backtrace area

21.1.4 Listener area

21.2 Simple examples

21.2.1 Standalone use of the stepper

21.2.2 Invoking the Stepper via a breakpoint

21.3 The implementation of the Stepper

21.3.1 Requirements for stepping

21.3.2 Editing source code

21.3.3 Side-effects of stepping

21.3.4 Atomic and constant forms

21.4 Stepper controls

21.4.1 Shortcut keys for the Stepper

21.5 Stepper restarts

21.6 Breakpoints

21.6.1 Setting breakpoints

21.6.2 Conditional breakpoints

21.6.3 Printing breakpoints

21.6.4 Editing breakpoints

21.6.5 Removing breakpoints

21.7 Stepping macro forms

21.7.1 Interactive macroexpansion

21.7.2 Macroexpansion in the stepper

21.7.3 Collapsing macroexpansions

21.7.4 Controlling macroexpansion

21.8 Listener area

21.9 Configuring the Stepper

21.9.1 Operator preferences

21.9.2 Backtrace preferences

22 The System Browser

22.1 Introduction

22.2 A brief introduction to systems

22.2.1 Examples

22.3 The System Browser

22.4 A description of the System Browser

22.5 Examining the system graph

22.5.1 System area

22.5.2 Graph area

22.5.3 Description area

22.5.4 Performing operations on system members

22.6 Examining systems in the text view

22.6.1 System area

22.6.2 Parent system area

22.6.3 Subsystems area

22.6.4 Files area

22.6.5 File description area

22.7 Generating and executing plans in the preview view

22.7.1 System area

22.7.2 Actions area

22.7.3 Filter area

22.7.4 Plan area

22.7.5 File description area

22.7.6 Executing plans in the preview view

22.8 Examining output in the output view

22.8.1 System area

22.8.2 Output area

22.9 Configuring the display

22.9.1 Sorting entries

22.9.2 Displaying package information

22.9.3 Graph preferences

22.10 Setting options in the system browser

23 The Window Browser

23.1 Introduction

23.1.1 Graph box

23.1.2 Window graph

23.1.3 Description list

23.2 Configuring the Window Browser

23.2.1 Sorting entries

23.2.2 Displaying package information

23.2.3 Displaying different types of window

23.2.4 Displaying short or long names

23.3 Performing operations on windows

23.3.1 Navigating the window hierarchy

23.3.2 Window control

Index

 


Common LispWorks User Guide (Macintosh version) - 11 Apr 2005

NextPrevTopIndex