LispWorks® for Macintosh IDE User Guide Version 7.1 Copyright and Trademarks LispWorks IDE User Guide (Macintosh version) Version 7.1 September 2017 Copyright © 2017 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 37 The Break gesture 41 The history list 41 Operating on files 42 Displaying packages 43 Performing operations on selected objects 46 iii Using different views 49 Tracing symbols from tools 53 Linking tools together 53 Filtering information 54 Regexp matching 57 Completion 59 Output and Input to/from the standard streams 63 Examining a window 64 System preferences affecting the IDE tools 64 4 Getting Help 65 Online manuals in HTML format 65 Online help for editor commands 68 Reporting bugs 68 Registering a new license key 69 Browsing manuals online using Adobe Reader 69 5 Session Saving 71 What session saving does 71 The default session 72 What is saved and what is not saved 72 Saving sessions 73 Redirecting images to a Saved Session image 78 Non-IDE interfaces and session saving 79 6 Manipulating Graphs 81 An overview of graphs 81 Searching graphs 82 Expanding and collapsing graphs 83 Moving nodes in graphs 84 Displaying plans of graphs 85 Preferences for graphs 87 Using graphs in your programs 91 7 LispWorks menus and the toolbar 93 LispWorks menus 93 The LispWorks toolbar 94 iv Specifying the initial tools 95 8 The Class Browser 97 Simple use of the Class Browser 98 Examining slot information 105 Examining superclasses and subclasses 107 Examining classes graphically 110 Examining generic functions and methods 114 Examining initargs 117 Examining class precedences 119 9 The Object Clipboard 123 Placing objects on the Object Clipboard 124 Browsing clipped objects 126 Removing objects 127 Filtering 128 Using the Object Clipboard with a Listener 128 10 The Compilation Conditions Browser 133 Introduction 133 Examining conditions 134 Configuring the display 136 Access to other tools 137 11 The Debugger Tool 139 Description of the Debugger 141 What the Debugger tool does 145 Simple use of the Debugger tool 146 The stack in the Debugger 147 An example debugging session 148 Performing operations on the error condition 150 Performing operations on stack frames 150 Performing operations on frame variables 152 Configuring the debugger tool 152 The Notifier window 155 Handling of Cocoa Event Loop hanging 157 Errors in CAPI display callbacks 158 v 12 The Tracer 161 Introduction 161 Tracing and Untracing functions 161 Examining the output of tracing 162 Example 164 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 Code Coverage Browser 211 Starting the Code Coverage Browser 211 Displaying a Code Coverage data 212 Code Coverage Files List Context Menu 214 Traverse 215 Using the internal data 216 Creating new Data 216 15 The Function Call Browser 219 Introduction 219 Examining functions using the graph views 220 Examining functions using the text view 223 Configuring the function call browser 225 Configuring graph displays 226 Performing operations on functions 227 vi 16 The Generic Function Browser 229 Examining information about methods 230 Examining information about combined methods 233 Configuring the Generic Function Browser 239 17 The Search Files tool 241 Introduction 241 Performing searches 243 Viewing the results 251 Modifying the matched lines 252 Configuring the Search Files tool 253 18 The Inspector 259 Inspecting the current object 259 Description of the Inspector tool 260 Filtering the display 261 Examining objects 263 Operating upon objects and items 264 Configuring the Inspector 270 Customizing the Inspector 272 Creating new inspection formats 273 19 The Symbol Browser 277 Introduction 277 Description of the Symbol Browser 278 Configuring the Symbol Browser 281 20 The Listener 283 The basic features of a Listener 284 Evaluating simple forms 285 Re-evaluating forms 286 The debugger