LispWorks® for Macintosh IDE User Guide Version 6.1 Copyright and Trademarks LispWorks IDE User Guide (Macintosh version) Version 6.1 November 2011 Copyright © 2011 by LispWorks Ltd. All Rights Reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of LispWorks Ltd. The information in this publication is provided for information only, is subject to change without notice, and should not be construed as a commitment by LispWorks Ltd. LispWorks Ltd assumes no responsibility or liability for any errors or inaccuracies that may appear in this publication. The software described in this book is furnished under license and may only be used or copied in accordance with the terms of that license. LispWorks and KnowledgeWorks are registered trademarks of LispWorks Ltd. Adobe and PostScript are registered trademarks of Adobe Systems Incorporated. Other brand or product names are the registered trade- marks or trademarks of their respective holders. The code for walker.lisp and compute-combination-points is excerpted with permission from PCL, Copyright © 1985, 1986, 1987, 1988 Xerox Corporation. The XP Pretty Printer bears the following copyright notice, which applies to the parts of LispWorks derived therefrom: Copyright © 1989 by the Massachusetts Institute of Technology, Cambridge, Massachusetts. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, pro- vided that this copyright and permission notice appear in all copies and supporting documentation, and that the name of M.I.T. not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. M.I.T. makes no representa- tion about the suitability of this software for any purpose. It is provided “as is” without express or implied warranty. M.I.T. disclaims all war- ranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall M.I.T. be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of con- tract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. LispWorks contains part of ICU software obtained from http://source.icu-project.org and which bears the following copyright and permis- sion notice: ICU License - ICU 1.8.1 and later COPYRIGHT AND PERMISSION NOTICE Copyright © 1995-2006 International Business Machines Corporation and others. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Soft- ware"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIM- ITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder. All trademarks and registered trademarks men- tioned herein are the property of their respective owners. US Government Restricted Rights The LispWorks Software is a commercial computer software program developed at private expense and is provided with restricted rights. The LispWorks Software may not be used, reproduced, or disclosed by the Government except as set forth in the accompanying End User License Agreement and as provided in DFARS 227.7202-1(a), 227.7202-3(a) (1995), FAR 12.212(a)(1995), FAR 52.227-19, and/or FAR 52.227-14 Alt III, as applicable. Rights reserved under the copyright laws of the United States. Address Telephone Fax LispWorks Ltd From North America: 877 759 8839 From North America: 617 812 8283 St. John’s Innovation Centre Cowley Road (toll-free) From elsewhere: +44 870 2206189 Cambridge CB4 0WS From elsewhere: +44 1223 421860 England www.lispworks.com Contents Preface xi 1 Introduction 1 Major tools 2 2 A Short Tutorial 5 Starting the environment 5 Creating a Listener 6 Using the Debugger 8 Viewing output 10 Inspecting objects using the Inspector 11 Examining classes in the Class Browser 13 Switching between windows 15 Summary 16 3 Common Features 17 Displaying tool windows 18 Setting preferences 24 Performing editing functions 35 The Break gesture 39 The history list 39 Operating on files 40 Displaying packages 41 Performing operations on selected objects 44 iii Using different views 47 Tracing symbols from tools 51 Linking tools together 51 Filtering information 52 Regexp matching 55 Completion 57 Examining a window 61 System preferences affecting the IDE tools 62 4 Getting Help 63 Online manuals in HTML format 63 Online help for editor commands 66 Browsing manuals online using Adobe Reader 66 Reporting bugs 67 5 Session Saving 69 What session saving does 69 The default session 70 What is saved and what is not saved 70 Saving sessions 71 Redirecting images to a Saved Session image 76 Non-IDE interfaces and session saving 77 6 Manipulating Graphs 79 An overview of graphs 79 Searching graphs 80 Expanding and collapsing graphs 81 Moving nodes in graphs 82 Displaying plans of graphs 83 Preferences for graphs 85 Using graphs in your programs 89 7 LispWorks menus and the toolbar 91 LispWorks menus 91 The LispWorks toolbar 92 Specifying the initial tools 92 iv 8 The Class Browser 95 Simple use of the Class Browser 96 Examining slot information 103 Examining superclasses and subclasses 105 Examining classes graphically 108 Examining generic functions and methods 112 Examining initargs 115 Examining class precedences 117 9 The Object Clipboard 121 Placing objects on the Object Clipboard 122 Browsing clipped objects 124 Removing objects 125 Filtering 126 Using the Object Clipboard with a Listener 126 10 The Compilation Conditions Browser 131 Introduction 131 Examining conditions 132 Configuring the display 134 Access to other tools 135 11 The Debugger Tool 137 Description of the Debugger 139 What the Debugger tool does 143 Simple use of the Debugger tool 144 The stack in the Debugger 145 An example debugging session 146 Performing operations on the error condition 148 Performing operations on stack frames 148 Performing operations on frame variables 150 Configuring the debugger tool 150 The Notifier window 153 Errors in CAPI display callbacks 154 12 The Tracer 157 Introduction 157 v Tracing and Untracing functions 157 Examining the output of tracing 158 Example 160 13 The Editor 165 Displaying and editing files 167 Displaying output messages in the Editor 171 Displaying and swapping between buffers 171 Displaying Common Lisp definitions 175 Changed definitions 176 Finding definitions 178 Setting Editor preferences 179 Basic Editor commands 182 Other essential commands 188 Cutting, copying and pasting using the clipboard 188 Cutting, copying and pasting using the kill ring 189 Searching and replacing text 193 Using Lisp-specific commands 197 Help with editing 205 14 The Function Call Browser 207 Introduction 207 Examining functions using the graph views 208 Examining functions using the text view 211 Configuring the function call browser 213 Configuring graph displays 214 Performing operations on functions 215 15 The Generic Function Browser 217 Examining information about methods 218 Examining information about combined methods 221 Configuring the Generic Function Browser 227 16 The Search Files tool 229 Introduction 229 Performing searches 231 Viewing the results 239 vi Modifying the matched lines 240 Configuring the Search Files tool 241 17 The Inspector 247 Inspecting the current object 247 Description of the Inspector tool 248 Filtering the display 249 Examining objects 251 Operating upon objects and items 252 Configuring the Inspector 258 Customizing the Inspector 260 Creating new inspection formats 261 18 The Symbol Browser 265 Introduction 265 Description of the Symbol Browser 266 Configuring the Symbol Browser 269 19 The Listener 271 The basic features of a Listener 272 Evaluating simple forms 273 Re-evaluating forms 274 The debugger prompt and debugger level 275 Interrupting evaluation 276 The History menu 277 The Expression menu 277 The Values menu 279 The Debug menu 279 Execute mode 280 Setting Listener preferences 284 Running Editor forms in the Listener 285 Switching to and from other tools 285 Help with editing in the Listener 285 20 The Output Browser 287 Interactive