LispWorks® IDE User Guide Version 6.1 Copyright and Trademarks LispWorks IDE User Guide (Unix 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 6 Creating a Listener 7 Using the Debugger 9 Viewing output 12 Inspecting objects using the Inspector 13 Examining classes in the Class Browser 15 Summary 18 3 Common Features 21 Displaying tool windows 22 Setting preferences 28 Performing editing functions 39 The Break gesture 42 The history list 43 Operating on files 44 Displaying packages 45 Performing operations on selected objects 48 Using different views 51 iii Tracing symbols from tools 55 Linking tools together 56 Filtering information 56 Regexp matching 59 Completion 61 Examining a window 66 4 Getting Help 69 Online manuals in HTML format 69 Online help for editor commands 72 Browsing manuals online using Adobe Reader 73 Reporting bugs 73 5 Session Saving 75 What session saving does 75 The default session 76 What is saved and what is not saved 76 Saving sessions 77 Redirecting images to a Saved Session image 82 Non-IDE interfaces and session saving 83 6 Manipulating Graphs 85 An overview of graphs 85 Searching graphs 87 Expanding and collapsing graphs 87 Moving nodes in graphs 88 Displaying plans of graphs 89 Preferences for graphs 91 Using graphs in your programs 96 7 The Podium 97 The podium window 97 Specifying the initial tools 98 8 The Class Browser 99 Simple use of the Class Browser 100 Examining slot information 107 iv Examining superclasses and subclasses 110 Examining classes graphically 112 Examining generic functions and methods 116 Examining initargs 120 Examining class precedences 122 9 The Object Clipboard 125 Placing objects on the Object Clipboard 126 Browsing clipped objects 129 Removing objects 130 Filtering 130 Using the Object Clipboard with a Listener 131 10 The Compilation Conditions Browser 135 Introduction 135 Examining conditions 137 Configuring the display 138 Access to other tools 140 11 The Debugger Tool 141 Description of the Debugger 143 What the Debugger tool does 148 Simple use of the Debugger tool 149 The stack in the Debugger 150 An example debugging session 151 Performing operations on the error condition 153 Performing operations on stack frames 153 Performing operations on frame variables 155 Configuring the debugger tool 155 The Notifier window 158 Errors in CAPI display callbacks 159 12 The Tracer 161 Introduction 161 Tracing and Untracing functions 161 Examining the output of tracing 162 Example 164 v 13 The Editor 169 Displaying and editing files 171 Displaying output messages in the Editor 175 Displaying and swapping between buffers 175 Displaying Common Lisp definitions 179 Changed definitions 181 Finding definitions 183 Setting Editor preferences 184 Basic Editor commands 187 Other essential commands 192 Cutting, copying and pasting using the clipboard 193 Cutting, copying and pasting using the kill ring 193 Searching and replacing text 197 Using Lisp-specific commands 201 Help with editing 209 14 The Function Call Browser 211 Introduction 211 Examining functions using the graph views 212 Examining functions using the text view 216 Configuring the function call browser 218 Configuring graph displays 219 Performing operations on functions 220 15 The Generic Function Browser 221 Examining information about methods 222 Examining information about combined methods 225 Configuring the Generic Function Browser 231 16 The Search Files tool 233 Introduction 233 Performing searches 235 Viewing the results 244 Modifying the matched lines 245 Configuring the Search Files tool 246 vi 17 The Inspector 253 Inspecting the current object 253 Description of the Inspector tool 254 Filtering the display 255 Examining objects 257 Operating upon objects and items 258 Configuring the Inspector 263 Customizing the Inspector 267 Creating new inspection formats 267 18 The Symbol Browser 273 Introduction 273 Description of the Symbol Browser 275 Configuring the Symbol Browser 279 19 The Interface Builder 281 Description of the Interface Builder 282 Creating or loading interfaces 283 Creating an interface layout 286 Creating a menu system 289 Editing and saving code 294 Performing operations on objects 298 Performing operations on the current interface 303 Performing operations on elements 305 20 Example: Using The Interface Builder 307 Creating the basic layout 309 Specifying attribute values 311 Creating the menu system 314 Specifying callbacks in the interface definition 317 Saving the interface 319 Defining the callbacks 319 Creating a system 323 Testing the example