® 0LispWorks Reference Manual Version 5.1 Copyright and Trademarks LispWorks Reference Manual Version 5.1 March 2008 Copyright © 2008 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: 305 468 5262 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 xxvii 1 The CLOS Package 1 break-new-instances-on-access 1 break-on-access 2 class-extra-initargs 3 compute-class-potential-initargs 4 compute-discriminating-function 6 funcallable-standard-object 6 process-a-class-option 7 process-a-slot-option 9 set-make-instance-argument-checking 11 slot-boundp-using-class 12 slot-makunbound-using-class 13 slot-value-using-class 13 trace-new-instances-on-access 14 trace-on-access 16 unbreak-new-instances-on-access 18 unbreak-on-access 19 untrace-new-instances-on-access 19 untrace-on-access 20 2 The COMM Package 21 attach-ssl 21 iii Contents destroy-ssl 23 destroy-ssl-ctx 23 detach-ssl 24 do-rand-seed 25 ensure-ssl 25 get-host-entry 26 get-socket-address 28 get-socket-peer-address 29 get-verification-mode 29 ip-address-string 30 make-ssl-ctx 31 open-tcp-stream 32 openssl-version 35 pem-read 36 read-dhparams 37 set-verification-mode 38 set-ssl-ctx-dh 40 set-ssl-ctx-options 42 set-ssl-ctx-password-callback 43 set-ssl-library-path 44 socket-error 45 socket-stream 45 socket-stream-address 50 socket-stream-ctx 50 socket-stream-peer-address 51 socket-stream-ssl 52 ssl-cipher-pointer 52 ssl-cipher-pointer-stack 52 ssl-closed 53 ssl-condition 53 ssl-ctx-pointer 53 ssl-error 54 ssl-failure 54 ssl-new 54 ssl-pointer 55 ssl-x509-lookup 55 start-up-server 56 iv Contents start-up-server-and-mp 60 string-ip-address 61 with-noticed-socket-stream 62 3 The COMMON-LISP Package 63 apropos 63 apropos-list 64 base-string 65 close 65 coerce 66 compile 67 compile-file 68 concatenate 72 declaim 73 declare 74 defclass 77 defpackage 81 describe 82 directory 83 disassemble 87 documentation 88 double-float 89 *features* 89 input-stream-p 92 interactive-stream-p 93 load-logical-pathname-translations 94 long-float 94 long-site-name 95 loop 95 make-array 97 make-hash-table 98 make-instance 99 make-sequence 100 map 101 merge 102 open 102 open-stream-p 104 v Contents output-stream-p 105 proclaim 106 restart-case 107 room 108 short-float 112 short-site-name 113 simple-base-string 113 single-float 113 software-type 114 software-version 115 step 116 stream-element-type 119 string 120 time 121 trace 122 truename 129 untrace 129 with-output-to-string 131 4 The COMPILER Package 133 deftransform 133 5 The DBG Package 137 *debug-print-length* 137 *debug-print-level* 138 *hidden-packages* 139 *print-binding-frames* 140 *print-catch-frames* 143 *print-handler-frames* 144 *print-open-frames* 145 *print-restart-frames* 146 *terminal-debugger-block-multiprocessing* 147 6 The DSPEC Package 151 *active-finders* 151 at-location 152 vi Contents canonicalize-dspec 153 def 154 define-dspec-alias 155 define-dspec-class 156 define-form-parser 159 dspec-class 163 *dspec-classes* 163 dspec-defined-p 164 dspec-definition-locations 164 dspec-equal 165 dspec-name 166 dspec-primary-name 166 dspec-progenitor 167 dspec-subclass-p 168 dspec-undefiner 168 discard-source-info 169 find-dspec-locations 169 find-name-locations 170 get-form-parser 171 local-dspec-p 172 location 173 name-defined-dspecs 173 name-definition-locations 174 name-only-form-parser 175 parse-form-dspec 176 record-definition 176 *record-source-files* 177 *redefinition-action* 178 save-tags-database 179 single-form-form-parser 179 single-form-with-options-form-parser 180 traceable-dspec-p 181 tracing-enabled-p 182 tracing-state 182 7 The EXTERNAL-FORMAT Package 185 char-external-code 185 vii Contents decode-external-string 186 encode-lisp-string 187 external-format-error 188 external-format-foreign-type 188 external-format-type 189 find-external-char 189 valid-external-format-p 190 8 The HCL Package 193 add-special-free-action 193 add-symbol-profiler 194 allocation-in-gen-num 195 avoid-gc 196 binds-who 197 block-promotion 197 building-universal-intermediate-p 199 calls-who 200 cd 200 change-directory 201 check-fragmentation 202 clean-down 203 clean-generation-0 204 collect-generation-2 205 collect-highest-generation 205 *compiler-break-on-error* 206 compile-file-if-needed 207 copy-to-weak-simple-vector 208 create-universal-binary 209 current-stack-length 210 *default-package-use-list* 211 *default-profiler-collapse* 211 *default-profiler-cutoff* 212 *default-profiler-limit* 212 *default-profiler-sort* 213 delete-advice 213 *disable-trace* 215 dump-form 215 viii Contents dump-forms-to-file 216 enlarge-generation 217 enlarge-static 218 expand-generation-1 219 extend-current-stack 220 extended-time 221 file-string 223 file-writable-p 224 find-object-size 224 finish-heavy-allocation 225 flag-not-special-free-action