/[slime]/slime/swank-backend.lisp
ViewVC logotype

Contents of /slime/swank-backend.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.175 - (hide annotations)
Wed Apr 29 22:20:25 2009 UTC (4 years, 11 months ago) by trittweiler
Branch: MAIN
Changes since 1.174: +2 -1 lines
	* swank-backend.lisp ([default] declaration-arglist): Add
	arglist of DECLARATION declaration.

	* swank-openmcl.lisp ([eql 'optimize] declaration-arglist):
	Implement it for CCL.
	(describe-symbol-for-emacs): Add :CLASS and :TYPE.
	(describe-definition): Add :TYPE.

	* swank-sbcl.lisp (describe-symbol-for-emacs): Add :CLASS.

	Adapted from patch by Stas Boukarev.
1 lgorrie 1.85 ;;; -*- Mode: lisp; indent-tabs-mode: nil; outline-regexp: ";;;;;*" -*-
2 lgorrie 1.1 ;;;
3 lgorrie 1.13 ;;; slime-backend.lisp --- SLIME backend interface.
4 lgorrie 1.1 ;;;
5 lgorrie 1.13 ;;; Created by James Bielman in 2003. Released into the public domain.
6 lgorrie 1.85 ;;;
7     ;;;; Frontmatter
8 lgorrie 1.1 ;;;
9 lgorrie 1.13 ;;; This file defines the functions that must be implemented
10     ;;; separately for each Lisp. Each is declared as a generic function
11     ;;; for which swank-<implementation>.lisp provides methods.
12 lgorrie 1.1
13 heller 1.36 (defpackage :swank-backend
14 lgorrie 1.1 (:use :common-lisp)
15 heller 1.36 (:export #:sldb-condition
16     #:original-condition
17     #:compiler-condition
18     #:message
19     #:short-message
20     #:condition
21     #:severity
22 heller 1.124 #:with-compilation-hooks
23 heller 1.36 #:location
24     #:location-p
25     #:location-buffer
26     #:location-position
27     #:position-p
28     #:position-pos
29     #:print-output-to-string
30 mbaringer 1.42 #:quit-lisp
31 crhodes 1.62 #:references
32 mbaringer 1.67 #:unbound-slot-filler
33 trittweiler 1.120 #:declaration-arglist
34     #:type-specifier-arglist
35 heller 1.140 ;; interrupt macro for the backend
36     #:*pending-slime-interrupts*
37     #:check-slime-interrupts
38 heller 1.172 #:*interrupt-queued-handler*
39 mbaringer 1.67 ;; inspector related symbols
40 heller 1.128 #:emacs-inspect
41 heller 1.70 #:label-value-line
42     #:label-value-line*
43 heller 1.136
44 mbaringer 1.115 #:with-struct
45 mbaringer 1.67 ))
46 lgorrie 1.1
47 mbaringer 1.65 (defpackage :swank-mop
48     (:use)
49     (:export
50     ;; classes
51     #:standard-generic-function
52     #:standard-slot-definition
53     #:standard-method
54     #:standard-class
55 mbaringer 1.68 #:eql-specializer
56     #:eql-specializer-object
57 mbaringer 1.65 ;; standard-class readers
58     #:class-default-initargs
59     #:class-direct-default-initargs
60     #:class-direct-slots
61     #:class-direct-subclasses
62     #:class-direct-superclasses
63     #:class-finalized-p
64     #:class-name
65     #:class-precedence-list
66     #:class-prototype
67     #:class-slots
68 mbaringer 1.68 #:specializer-direct-methods
69 mbaringer 1.65 ;; generic function readers
70     #:generic-function-argument-precedence-order
71     #:generic-function-declarations
72     #:generic-function-lambda-list
73     #:generic-function-methods
74     #:generic-function-method-class
75     #:generic-function-method-combination
76     #:generic-function-name
77     ;; method readers
78     #:method-generic-function
79     #:method-function
80     #:method-lambda-list
81     #:method-specializers
82     #:method-qualifiers
83     ;; slot readers
84     #:slot-definition-allocation
85     #:slot-definition-documentation
86     #:slot-definition-initargs
87     #:slot-definition-initform
88     #:slot-definition-initfunction
89     #:slot-definition-name
90     #:slot-definition-type
91     #:slot-definition-readers
92 lgorrie 1.79 #:slot-definition-writers
93 heller 1.95 #:slot-boundp-using-class
94     #:slot-value-using-class
95 alendvai 1.111 #:slot-makunbound-using-class
96 lgorrie 1.79 ;; generic function protocol
97 lgorrie 1.82 #:compute-applicable-methods-using-classes
98     #:finalize-inheritance))
99 mbaringer 1.65
100 heller 1.36 (in-package :swank-backend)
101 lgorrie 1.1
102    
103 lgorrie 1.21 ;;;; Metacode
104    
105     (defparameter *interface-functions* '()
106     "The names of all interface functions.")
107    
108     (defparameter *unimplemented-interfaces* '()
109     "List of interface functions that are not implemented.
110     DEFINTERFACE adds to this list and DEFIMPLEMENTATION removes.")
111    
112 heller 1.52 (defmacro definterface (name args documentation &rest default-body)
113 lgorrie 1.21 "Define an interface function for the backend to implement.
114 trittweiler 1.125 A function is defined with NAME, ARGS, and DOCUMENTATION. This
115     function first looks for a function to call in NAME's property list
116     that is indicated by 'IMPLEMENTATION; failing that, it looks for a
117     function indicated by 'DEFAULT. If neither is present, an error is
118     signaled.
119    
120     If a DEFAULT-BODY is supplied, then a function with the same body and
121     ARGS will be added to NAME's property list as the property indicated
122     by 'DEFAULT.
123 lgorrie 1.21
124     Backends implement these functions using DEFIMPLEMENTATION."
125 lgorrie 1.43 (check-type documentation string "a documentation string")
126 heller 1.101 (assert (every #'symbolp args) ()
127     "Complex lambda-list not supported: ~S ~S" name args)
128     (labels ((gen-default-impl ()
129     `(setf (get ',name 'default) (lambda ,args ,@default-body)))
130     (args-as-list (args)
131     (destructuring-bind (req opt key rest) (parse-lambda-list args)
132     `(,@req ,@opt
133     ,@(loop for k in key append `(,(kw k) ,k))
134     ,@(or rest '(())))))
135     (parse-lambda-list (args)
136     (parse args '(&optional &key &rest)
137     (make-array 4 :initial-element nil)))
138     (parse (args keywords vars)
139     (cond ((null args)
140     (reverse (map 'list #'reverse vars)))
141     ((member (car args) keywords)
142     (parse (cdr args) (cdr (member (car args) keywords)) vars))
143     (t (push (car args) (aref vars (length keywords)))
144     (parse (cdr args) keywords vars))))
145     (kw (s) (intern (string s) :keyword)))
146     `(progn
147     (defun ,name ,args
148     ,documentation
149     (let ((f (or (get ',name 'implementation)
150     (get ',name 'default))))
151     (cond (f (apply f ,@(args-as-list args)))
152     (t (error "~S not implementated" ',name)))))
153     (pushnew ',name *interface-functions*)
154     ,(if (null default-body)
155     `(pushnew ',name *unimplemented-interfaces*)
156     (gen-default-impl))
157     ;; see <http://www.franz.com/support/documentation/6.2/doc/pages/variables/compiler/s_cltl1-compile-file-toplevel-compatibility-p_s.htm>
158     (eval-when (:compile-toplevel :load-toplevel :execute)
159     (export ',name :swank-backend))
160     ',name)))
161 lgorrie 1.21
162     (defmacro defimplementation (name args &body body)
163 heller 1.101 (assert (every #'symbolp args) ()
164     "Complex lambda-list not supported: ~S ~S" name args)
165 heller 1.99 `(progn
166 heller 1.101 (setf (get ',name 'implementation) (lambda ,args ,@body))
167 heller 1.99 (if (member ',name *interface-functions*)
168     (setq *unimplemented-interfaces*
169     (remove ',name *unimplemented-interfaces*))
170     (warn "DEFIMPLEMENTATION of undefined interface (~S)" ',name))
171     ',name))
172 lgorrie 1.21
173     (defun warn-unimplemented-interfaces ()
174     "Warn the user about unimplemented backend features.
175     The portable code calls this function at startup."
176 trittweiler 1.174 (let ((*print-pretty* t))
177     (warn "These Swank interfaces are unimplemented:~% ~:<~{~A~^ ~:_~}~:>"
178     (list (sort (copy-list *unimplemented-interfaces*) #'string<)))))
179 lgorrie 1.21
180 heller 1.69 (defun import-to-swank-mop (symbol-list)
181     (dolist (sym symbol-list)
182     (let* ((swank-mop-sym (find-symbol (symbol-name sym) :swank-mop)))
183     (when swank-mop-sym
184     (unintern swank-mop-sym :swank-mop))
185     (import sym :swank-mop)
186     (export sym :swank-mop))))
187    
188     (defun import-swank-mop-symbols (package except)
189     "Import the mop symbols from PACKAGE to SWANK-MOP.
190     EXCEPT is a list of symbol names which should be ignored."
191     (do-symbols (s :swank-mop)
192     (unless (member s except :test #'string=)
193     (let ((real-symbol (find-symbol (string s) package)))
194 heller 1.76 (assert real-symbol () "Symbol ~A not found in package ~A" s package)
195 heller 1.69 (unintern s :swank-mop)
196     (import real-symbol :swank-mop)
197     (export real-symbol :swank-mop)))))
198    
199 heller 1.88 (defvar *gray-stream-symbols*
200     '(:fundamental-character-output-stream
201     :stream-write-char
202 heller 1.137 :stream-write-string
203 heller 1.88 :stream-fresh-line
204     :stream-force-output
205     :stream-finish-output
206     :fundamental-character-input-stream
207     :stream-read-char
208 heller 1.148 :stream-peek-char
209     :stream-read-line
210 trittweiler 1.150 ;; STREAM-FILE-POSITION is not available on all implementations, or
211     ;; partially under a different name.
212     ; :stream-file-posiion
213 heller 1.88 :stream-listen
214     :stream-unread-char
215     :stream-clear-input
216     :stream-line-column
217 jsnellman 1.90 :stream-read-char-no-hang
218     ;; STREAM-LINE-LENGTH is an extension to gray streams that's apparently
219 dcrosher 1.91 ;; supported by CMUCL, OpenMCL, SBCL and SCL.
220     #+(or cmu openmcl sbcl scl)
221 jsnellman 1.90 :stream-line-length))
222 heller 1.88
223     (defun import-from (package symbol-names &optional (to-package *package*))
224     "Import the list of SYMBOL-NAMES found in the package PACKAGE."
225     (dolist (name symbol-names)
226     (multiple-value-bind (symbol found) (find-symbol (string name) package)
227     (assert found () "Symbol ~A not found in package ~A" name package)
228     (import symbol to-package))))
229    
230 lgorrie 1.21
231 heller 1.46 ;;;; Utilities
232    
233     (defmacro with-struct ((conc-name &rest names) obj &body body)
234     "Like with-slots but works only for structs."
235     (flet ((reader (slot) (intern (concatenate 'string
236     (symbol-name conc-name)
237     (symbol-name slot))
238     (symbol-package conc-name))))
239     (let ((tmp (gensym "OO-")))
240     ` (let ((,tmp ,obj))
241     (symbol-macrolet
242     ,(loop for name in names collect
243     (typecase name
244     (symbol `(,name (,(reader name) ,tmp)))
245     (cons `(,(first name) (,(reader (second name)) ,tmp)))
246     (t (error "Malformed syntax in WITH-STRUCT: ~A" name))))
247     ,@body)))))
248 lgorrie 1.54
249 trittweiler 1.171 (defun with-symbol (name package)
250     "Generate a form suitable for testing with #+."
251     (if (find-symbol (string name) (string package))
252     '(:and)
253     '(:or)))
254    
255 lgorrie 1.54
256 lgorrie 1.13 ;;;; TCP server
257    
258 heller 1.29 (definterface create-socket (host port)
259     "Create a listening TCP socket on interface HOST and port PORT .")
260 lgorrie 1.13
261 lgorrie 1.21 (definterface local-port (socket)
262     "Return the local port number of SOCKET.")
263 lgorrie 1.1
264 lgorrie 1.21 (definterface close-socket (socket)
265     "Close the socket SOCKET.")
266 lgorrie 1.1
267 heller 1.93 (definterface accept-connection (socket &key external-format
268 dcrosher 1.97 buffering timeout)
269 heller 1.93 "Accept a client connection on the listening socket SOCKET.
270     Return a stream for the new connection.")
271 heller 1.16
272 heller 1.31 (definterface add-sigio-handler (socket fn)
273 lgorrie 1.21 "Call FN whenever SOCKET is readable.")
274 heller 1.16
275 heller 1.31 (definterface remove-sigio-handlers (socket)
276     "Remove all sigio handlers for SOCKET.")
277    
278     (definterface add-fd-handler (socket fn)
279     "Call FN when Lisp is waiting for input and SOCKET is readable.")
280    
281     (definterface remove-fd-handlers (socket)
282     "Remove all fd-handlers for SOCKET.")
283 heller 1.18
284 heller 1.36 (definterface preferred-communication-style ()
285     "Return one of the symbols :spawn, :sigio, :fd-handler, or NIL."
286     nil)
287    
288 dcrosher 1.97 (definterface set-stream-timeout (stream timeout)
289     "Set the 'stream 'timeout. The timeout is either the real number
290     specifying the timeout in seconds or 'nil for no timeout."
291     (declare (ignore stream timeout))
292     nil)
293    
294 lgorrie 1.13 ;;; Base condition for networking errors.
295 msimmons 1.50 (define-condition network-error (simple-error) ())
296 lgorrie 1.13
297 heller 1.74 (definterface emacs-connected ()
298 lgorrie 1.13 "Hook called when the first connection from Emacs is established.
299     Called from the INIT-FN of the socket server that accepts the
300     connection.
301 lgorrie 1.1
302 lgorrie 1.13 This is intended for setting up extra context, e.g. to discover
303 heller 1.74 that the calling thread is the one that interacts with Emacs."
304 mbaringer 1.73 nil)
305 lgorrie 1.1
306    
307 heller 1.20 ;;;; Unix signals
308    
309     (defconstant +sigint+ 2)
310    
311 heller 1.36 (definterface call-without-interrupts (fn)
312     "Call FN in a context where interrupts are disabled."
313     (funcall fn))
314 heller 1.20
315 heller 1.32 (definterface getpid ()
316     "Return the (Unix) process ID of this superior Lisp.")
317    
318 heller 1.144 (definterface install-sigint-handler (function)
319     "Call FUNCTION on SIGINT (instead of invoking the debugger).
320     Return old signal handler."
321 heller 1.162 (declare (ignore function))
322 heller 1.144 nil)
323    
324     (definterface call-with-user-break-handler (handler function)
325     "Install the break handler HANDLER while executing FUNCTION."
326     (let ((old-handler (install-sigint-handler handler)))
327     (unwind-protect (funcall function)
328     (install-sigint-handler old-handler))))
329    
330 heller 1.155 (definterface quit-lisp ()
331     "Exit the current lisp image.")
332    
333 heller 1.32 (definterface lisp-implementation-type-name ()
334     "Return a short name for the Lisp implementation."
335     (lisp-implementation-type))
336 heller 1.20
337 heller 1.155
338     ;; pathnames are sooo useless
339    
340     (definterface filename-to-pathname (filename)
341     "Return a pathname for FILENAME.
342     A filename in Emacs may for example contain asterisks which should not
343     be translated to wildcards."
344     (parse-namestring filename))
345    
346     (definterface pathname-to-filename (pathname)
347     "Return the filename for PATHNAME."
348     (namestring pathname))
349    
350 heller 1.51 (definterface default-directory ()
351     "Return the default directory."
352     (directory-namestring (truename *default-pathname-defaults*)))
353    
354 heller 1.39 (definterface set-default-directory (directory)
355     "Set the default directory.
356     This is used to resolve filenames without directory component."
357     (setf *default-pathname-defaults* (truename (merge-pathnames directory)))
358 heller 1.51 (default-directory))
359    
360 heller 1.155
361 heller 1.51 (definterface call-with-syntax-hooks (fn)
362     "Call FN with hooks to handle special syntax."
363     (funcall fn))
364 heller 1.39
365 heller 1.52 (definterface default-readtable-alist ()
366 heller 1.77 "Return a suitable initial value for SWANK:*READTABLE-ALIST*."
367 heller 1.52 '())
368    
369 heller 1.20
370 lgorrie 1.1 ;;;; Compilation
371 dbarlow 1.8
372 lgorrie 1.21 (definterface call-with-compilation-hooks (func)
373 lgorrie 1.47 "Call FUNC with hooks to record compiler conditions.")
374 lgorrie 1.13
375 vsedach 1.14 (defmacro with-compilation-hooks ((&rest ignore) &body body)
376 lgorrie 1.47 "Execute BODY as in CALL-WITH-COMPILATION-HOOKS."
377 vsedach 1.14 (declare (ignore ignore))
378 dbarlow 1.8 `(call-with-compilation-hooks (lambda () (progn ,@body))))
379 lgorrie 1.1
380 heller 1.167 (definterface swank-compile-string (string &key buffer position filename
381 trittweiler 1.165 policy)
382 heller 1.156 "Compile source from STRING.
383     During compilation, compiler conditions must be trapped and
384     resignalled as COMPILER-CONDITIONs.
385 lgorrie 1.1
386     If supplied, BUFFER and POSITION specify the source location in Emacs.
387    
388     Additionally, if POSITION is supplied, it must be added to source
389 pseibel 1.64 positions reported in compiler conditions.
390    
391 heller 1.167 If FILENAME is specified it may be used by certain implementations to
392 pseibel 1.64 rebind *DEFAULT-PATHNAME-DEFAULTS* which may improve the recording of
393 heller 1.131 source information.
394    
395 heller 1.167 If POLICY is supplied, and non-NIL, it may be used by certain
396 trittweiler 1.134 implementations to compile with a debug optimization quality of its
397 trittweiler 1.135 value.
398    
399     Should return T on successfull compilation, NIL otherwise.
400 heller 1.131 ")
401 lgorrie 1.1
402 heller 1.169 (definterface swank-compile-file (input-file output-file load-p
403     external-format)
404     "Compile INPUT-FILE signalling COMPILE-CONDITIONs.
405 heller 1.109 If LOAD-P is true, load the file after compilation.
406     EXTERNAL-FORMAT is a value returned by find-external-format or
407 trittweiler 1.135 :default.
408    
409 heller 1.156 Should return OUTPUT-TRUENAME, WARNINGS-P and FAILURE-p
410     like `compile-file'")
411 lgorrie 1.1
412 heller 1.72 (deftype severity ()
413     '(member :error :read-error :warning :style-warning :note))
414 lgorrie 1.13
415     ;; Base condition type for compiler errors, warnings and notes.
416     (define-condition compiler-condition (condition)
417     ((original-condition
418     ;; The original condition thrown by the compiler if appropriate.
419     ;; May be NIL if a compiler does not report using conditions.
420     :type (or null condition)
421     :initarg :original-condition
422     :accessor original-condition)
423    
424     (severity :type severity
425     :initarg :severity
426     :accessor severity)
427    
428     (message :initarg :message
429     :accessor message)
430    
431 heller 1.30 (short-message :initarg :short-message
432     :initform nil
433     :accessor short-message)
434 crhodes 1.62
435     (references :initarg :references
436     :initform nil
437     :accessor references)
438 heller 1.30
439 lgorrie 1.13 (location :initarg :location
440     :accessor location)))
441 heller 1.30
442 heller 1.109 (definterface find-external-format (coding-system)
443     "Return a \"external file format designator\" for CODING-SYSTEM.
444     CODING-SYSTEM is Emacs-style coding system name (a string),
445     e.g. \"latin-1-unix\"."
446     (if (equal coding-system "iso-latin-1-unix")
447     :default
448     nil))
449    
450 trittweiler 1.146 (definterface guess-external-format (pathname)
451     "Detect the external format for the file with name pathname.
452 heller 1.109 Return nil if the file contains no special markers."
453     ;; Look for a Emacs-style -*- coding: ... -*- or Local Variable: section.
454 trittweiler 1.146 (with-open-file (s pathname :if-does-not-exist nil
455 heller 1.109 :external-format (or (find-external-format "latin-1-unix")
456     :default))
457 heller 1.110 (if s
458     (or (let* ((line (read-line s nil))
459     (p (search "-*-" line)))
460     (when p
461     (let* ((start (+ p (length "-*-")))
462     (end (search "-*-" line :start2 start)))
463     (when end
464     (%search-coding line start end)))))
465     (let* ((len (file-length s))
466     (buf (make-string (min len 3000))))
467     (file-position s (- len (length buf)))
468     (read-sequence buf s)
469     (let ((start (search "Local Variables:" buf :from-end t))
470     (end (search "End:" buf :from-end t)))
471     (and start end (< start end)
472     (%search-coding buf start end))))))))
473 heller 1.109
474     (defun %search-coding (str start end)
475     (let ((p (search "coding:" str :start2 start :end2 end)))
476     (when p
477     (incf p (length "coding:"))
478     (loop while (and (< p end)
479     (member (aref str p) '(#\space #\tab)))
480     do (incf p))
481     (let ((end (position-if (lambda (c) (find c '(#\space #\tab #\newline)))
482     str :start p)))
483     (find-external-format (subseq str p end))))))
484    
485 lgorrie 1.17
486 lgorrie 1.13 ;;;; Streams
487    
488 heller 1.147 (definterface make-output-stream (write-string)
489     "Return a new character output stream.
490     The stream calls WRITE-STRING when output is ready.")
491    
492     (definterface make-input-stream (read-string)
493     "Return a new character input stream.
494     The stream calls READ-STRING when input is needed.")
495    
496 lgorrie 1.1
497     ;;;; Documentation
498    
499 heller 1.36 (definterface arglist (name)
500 mbaringer 1.65 "Return the lambda list for the symbol NAME. NAME can also be
501     a lisp function object, on lisps which support this.
502    
503 trittweiler 1.120 The result can be a list or the :not-available keyword if the
504     arglist cannot be determined."
505 mbaringer 1.65 (declare (ignore name))
506     :not-available)
507 heller 1.36
508 trittweiler 1.120 (defgeneric declaration-arglist (decl-identifier)
509     (:documentation
510     "Return the argument list of the declaration specifier belonging to the
511     declaration identifier DECL-IDENTIFIER. If the arglist cannot be determined,
512     the keyword :NOT-AVAILABLE is returned.
513    
514     The different SWANK backends can specialize this generic function to
515     include implementation-dependend declaration specifiers, or to provide
516     additional information on the specifiers defined in ANSI Common Lisp.")
517     (:method (decl-identifier)
518     (case decl-identifier
519     (dynamic-extent '(&rest vars))
520     (ignore '(&rest vars))
521     (ignorable '(&rest vars))
522     (special '(&rest vars))
523     (inline '(&rest function-names))
524 trittweiler 1.175 (notinline '(&rest function-names))
525     (declaration '(&rest names))
526 trittweiler 1.120 (optimize '(&any compilation-speed debug safety space speed))
527     (type '(type-specifier &rest args))
528     (ftype '(type-specifier &rest function-names))
529     (otherwise
530     (flet ((typespec-p (symbol) (member :type (describe-symbol-for-emacs symbol))))
531     (cond ((and (symbolp decl-identifier) (typespec-p decl-identifier))
532     '(&rest vars))
533     ((and (listp decl-identifier) (typespec-p (first decl-identifier)))
534     '(&rest vars))
535     (t :not-available)))))))
536    
537     (defgeneric type-specifier-arglist (typespec-operator)
538     (:documentation
539     "Return the argument list of the type specifier belonging to
540     TYPESPEC-OPERATOR.. If the arglist cannot be determined, the keyword
541     :NOT-AVAILABLE is returned.
542    
543     The different SWANK backends can specialize this generic function to
544     include implementation-dependend declaration specifiers, or to provide
545     additional information on the specifiers defined in ANSI Common Lisp.")
546     (:method (typespec-operator)
547     (declare (special *type-specifier-arglists*)) ; defined at end of file.
548     (typecase typespec-operator
549     (symbol (or (cdr (assoc typespec-operator *type-specifier-arglists*))
550     :not-available))
551     (t :not-available))))
552    
553 mbaringer 1.65 (definterface function-name (function)
554     "Return the name of the function object FUNCTION.
555    
556     The result is either a symbol, a list, or NIL if no function name is available."
557     (declare (ignore function))
558     nil)
559 lgorrie 1.1
560 lgorrie 1.21 (definterface macroexpand-all (form)
561 lgorrie 1.1 "Recursively expand all macros in FORM.
562 lgorrie 1.21 Return the resulting form.")
563 lgorrie 1.1
564 heller 1.94 (definterface compiler-macroexpand-1 (form &optional env)
565     "Call the compiler-macro for form.
566     If FORM is a function call for which a compiler-macro has been
567     defined, invoke the expander function using *macroexpand-hook* and
568     return the results and T. Otherwise, return the original form and
569     NIL."
570     (let ((fun (and (consp form) (compiler-macro-function (car form)))))
571     (if fun
572     (let ((result (funcall *macroexpand-hook* fun form env)))
573     (values result (not (eq result form))))
574     (values form nil))))
575    
576     (definterface compiler-macroexpand (form &optional env)
577     "Repetitively call `compiler-macroexpand-1'."
578     (labels ((frob (form expanded)
579     (multiple-value-bind (new-form newly-expanded)
580     (compiler-macroexpand-1 form env)
581     (if newly-expanded
582     (frob new-form t)
583     (values new-form expanded)))))
584     (frob form env)))
585    
586 trittweiler 1.173 (definterface format-string-expand (control-string)
587     "Expand the format string CONTROL-STRING."
588     (macroexpand `(formatter ,control-string)))
589    
590 lgorrie 1.21 (definterface describe-symbol-for-emacs (symbol)
591 lgorrie 1.1 "Return a property list describing SYMBOL.
592    
593     The property list has an entry for each interesting aspect of the
594     symbol. The recognised keys are:
595    
596 heller 1.86 :VARIABLE :FUNCTION :SETF :SPECIAL-OPERATOR :MACRO :COMPILER-MACRO
597     :TYPE :CLASS :ALIEN-TYPE :ALIEN-STRUCT :ALIEN-UNION :ALIEN-ENUM
598 lgorrie 1.1
599     The value of each property is the corresponding documentation string,
600 heller 1.86 or :NOT-DOCUMENTED. It is legal to include keys not listed here (but
601     slime-print-apropos in Emacs must know about them).
602 lgorrie 1.1
603     Properties should be included if and only if they are applicable to
604     the symbol. For example, only (and all) fbound symbols should include
605     the :FUNCTION property.
606    
607     Example:
608     \(describe-symbol-for-emacs 'vector)
609     => (:CLASS :NOT-DOCUMENTED
610     :TYPE :NOT-DOCUMENTED
611 lgorrie 1.21 :FUNCTION \"Constructs a simple-vector from the given objects.\")")
612    
613     (definterface describe-definition (name type)
614     "Describe the definition NAME of TYPE.
615     TYPE can be any value returned by DESCRIBE-SYMBOL-FOR-EMACS.
616    
617     Return a documentation string, or NIL if none is available.")
618 lgorrie 1.2
619    
620     ;;;; Debugging
621    
622 heller 1.92 (definterface install-debugger-globally (function)
623     "Install FUNCTION as the debugger for all threads/processes. This
624     usually involves setting *DEBUGGER-HOOK* and, if the implementation
625     permits, hooking into BREAK as well."
626     (setq *debugger-hook* function))
627    
628 lgorrie 1.21 (definterface call-with-debugging-environment (debugger-loop-fn)
629 lgorrie 1.2 "Call DEBUGGER-LOOP-FN in a suitable debugging environment.
630    
631     This function is called recursively at each debug level to invoke the
632     debugger loop. The purpose is to setup any necessary environment for
633     other debugger callbacks that will be called within the debugger loop.
634    
635     For example, this is a reasonable place to compute a backtrace, switch
636 lgorrie 1.21 to safe reader/printer settings, and so on.")
637 lgorrie 1.2
638 heller 1.80 (definterface call-with-debugger-hook (hook fun)
639     "Call FUN and use HOOK as debugger hook.
640    
641     HOOK should be called for both BREAK and INVOKE-DEBUGGER."
642     (let ((*debugger-hook* hook))
643     (funcall fun)))
644    
645 lgorrie 1.2 (define-condition sldb-condition (condition)
646     ((original-condition
647     :initarg :original-condition
648 heller 1.5 :accessor original-condition))
649 heller 1.63 (:report (lambda (condition stream)
650     (format stream "Condition in debugger code~@[: ~A~]"
651     (original-condition condition))))
652 lgorrie 1.2 (:documentation
653     "Wrapper for conditions that should not be debugged.
654    
655     When a condition arises from the internals of the debugger, it is not
656     desirable to debug it -- we'd risk entering an endless loop trying to
657     debug the debugger! Instead, such conditions can be reported to the
658     user without (re)entering the debugger by wrapping them as
659     `sldb-condition's."))
660    
661 trittweiler 1.132 ;;; The following functions in this section are supposed to be called
662     ;;; within the dynamic contour of CALL-WITH-DEBUGGING-ENVIRONMENT only.
663    
664 heller 1.36 (definterface compute-backtrace (start end)
665 trittweiler 1.132 "Returns a backtrace of the condition currently being debugged,
666 heller 1.157 that is an ordered list consisting of frames. ``Ordered list''
667 trittweiler 1.151 means that an integer I can be mapped back to the i-th frame of this
668     backtrace.
669 heller 1.36
670     START and END are zero-based indices constraining the number of frames
671 trittweiler 1.151 returned. Frame zero is defined as the frame which invoked the
672     debugger. If END is nil, return the frames from START to the end of
673 heller 1.36 the stack.")
674 lgorrie 1.3
675 heller 1.157 (definterface print-frame (frame stream)
676 heller 1.36 "Print frame to stream.")
677 heller 1.70
678 heller 1.157 (definterface frame-restartable-p (frame)
679     "Is the frame FRAME restartable?.
680     Return T if `restart-frame' can safely be called on the frame."
681 heller 1.161 (declare (ignore frame))
682 heller 1.157 nil)
683    
684 lgorrie 1.21 (definterface frame-source-location-for-emacs (frame-number)
685 trittweiler 1.132 "Return the source location for the frame associated to FRAME-NUMBER.")
686 lgorrie 1.3
687 lgorrie 1.21 (definterface frame-catch-tags (frame-number)
688 trittweiler 1.132 "Return a list of catch tags for being printed in a debugger stack
689 heller 1.159 frame."
690 heller 1.160 (declare (ignore frame-number))
691 heller 1.159 '())
692 lgorrie 1.3
693 lgorrie 1.21 (definterface frame-locals (frame-number)
694 trittweiler 1.132 "Return a list of ((&key NAME ID VALUE) ...) where each element of
695     the list represents a local variable in the stack frame associated to
696     FRAME-NUMBER.
697    
698     NAME, a symbol; the name of the local variable.
699    
700     ID, an integer; used as primary key for the local variable, unique
701     relatively to the frame under operation.
702    
703     value, an object; the value of the local variable.")
704    
705     (definterface frame-var-value (frame-number var-id)
706     "Return the value of the local variable associated to VAR-ID
707     relatively to the frame associated to FRAME-NUMBER.")
708 heller 1.57
709 heller 1.37 (definterface disassemble-frame (frame-number)
710     "Disassemble the code for the FRAME-NUMBER.
711     The output should be written to standard output.
712 heller 1.84 FRAME-NUMBER is a non-negative integer.")
713 heller 1.37
714 lgorrie 1.21 (definterface eval-in-frame (form frame-number)
715 lgorrie 1.3 "Evaluate a Lisp form in the lexical context of a stack frame
716 trittweiler 1.132 in the debugger.
717 lgorrie 1.3
718     FRAME-NUMBER must be a positive integer with 0 indicating the
719     frame which invoked the debugger.
720    
721     The return value is the result of evaulating FORM in the
722 lgorrie 1.21 appropriate context.")
723 heller 1.22
724     (definterface return-from-frame (frame-number form)
725     "Unwind the stack to the frame FRAME-NUMBER and return the value(s)
726     produced by evaluating FORM in the frame context to its caller.
727    
728     Execute any clean-up code from unwind-protect forms above the frame
729     during unwinding.
730    
731     Return a string describing the error if it's not possible to return
732     from the frame.")
733    
734     (definterface restart-frame (frame-number)
735     "Restart execution of the frame FRAME-NUMBER with the same arguments
736     as it was called originally.")
737 lgorrie 1.3
738 lgorrie 1.49 (definterface format-sldb-condition (condition)
739     "Format a condition for display in SLDB."
740     (princ-to-string condition))
741    
742 heller 1.69 (definterface condition-extras (condition)
743     "Return a list of extra for the debugger.
744     The allowed elements are of the form:
745 heller 1.126 (:SHOW-FRAME-SOURCE frame-number)
746     (:REFERENCES &rest refs)
747     "
748 mbaringer 1.73 (declare (ignore condition))
749 heller 1.69 '())
750    
751 heller 1.71 (definterface activate-stepping (frame-number)
752     "Prepare the frame FRAME-NUMBER for stepping.")
753 heller 1.69
754     (definterface sldb-break-on-return (frame-number)
755     "Set a breakpoint in the frame FRAME-NUMBER.")
756    
757     (definterface sldb-break-at-start (symbol)
758     "Set a breakpoint on the beginning of the function for SYMBOL.")
759 heller 1.52
760 jsnellman 1.103 (definterface sldb-stepper-condition-p (condition)
761     "Return true if SLDB was invoked due to a single-stepping condition,
762     false otherwise. "
763     (declare (ignore condition))
764     nil)
765    
766     (definterface sldb-step-into ()
767     "Step into the current single-stepper form.")
768    
769     (definterface sldb-step-next ()
770     "Step to the next form in the current function.")
771    
772     (definterface sldb-step-out ()
773     "Stop single-stepping temporarily, but resume it once the current function
774     returns.")
775 lgorrie 1.49
776 lgorrie 1.3
777 heller 1.36 ;;;; Definition finding
778    
779     (defstruct (:location (:type list) :named
780 lgorrie 1.45 (:constructor make-location
781     (buffer position &optional hints)))
782     buffer position
783     ;; Hints is a property list optionally containing:
784     ;; :snippet SOURCE-TEXT
785     ;; This is a snippet of the actual source text at the start of
786     ;; the definition, which could be used in a text search.
787     hints)
788 heller 1.36
789     (defstruct (:error (:type list) :named (:constructor)) message)
790     (defstruct (:file (:type list) :named (:constructor)) name)
791     (defstruct (:buffer (:type list) :named (:constructor)) name)
792     (defstruct (:position (:type list) :named (:constructor)) pos)
793    
794     (definterface find-definitions (name)
795     "Return a list ((DSPEC LOCATION) ...) for NAME's definitions.
796    
797 heller 1.38 NAME is a \"definition specifier\".
798 heller 1.36
799 heller 1.38 DSPEC is a \"definition specifier\" describing the
800 heller 1.36 definition, e.g., FOO or (METHOD FOO (STRING NUMBER)) or
801 heller 1.38 \(DEFVAR FOO).
802    
803     LOCATION is the source location for the definition.")
804 heller 1.36
805 trittweiler 1.130 (definterface find-source-location (object)
806     "Returns the source location of OBJECT, or NIL.
807    
808     That is the source location of the underlying datastructure of
809     OBJECT. E.g. on a STANDARD-OBJECT, the source location of the
810     respective DEFCLASS definition is returned, on a STRUCTURE-CLASS the
811     respective DEFSTRUCT definition, and so on."
812 trittweiler 1.135 ;; This returns one source location and not a list of locations. It's
813 trittweiler 1.130 ;; supposed to return the location of the DEFGENERIC definition on
814     ;; #'SOME-GENERIC-FUNCTION.
815     )
816    
817    
818 lgorrie 1.61 (definterface buffer-first-change (filename)
819     "Called for effect the first time FILENAME's buffer is modified."
820 mbaringer 1.73 (declare (ignore filename))
821 lgorrie 1.61 nil)
822    
823 trittweiler 1.130
824 heller 1.36
825     ;;;; XREF
826    
827     (definterface who-calls (function-name)
828     "Return the call sites of FUNCTION-NAME (a symbol).
829     The results is a list ((DSPEC LOCATION) ...).")
830    
831 heller 1.81 (definterface calls-who (function-name)
832     "Return the call sites of FUNCTION-NAME (a symbol).
833     The results is a list ((DSPEC LOCATION) ...).")
834    
835 heller 1.36 (definterface who-references (variable-name)
836     "Return the locations where VARIABLE-NAME (a symbol) is referenced.
837     See WHO-CALLS for a description of the return value.")
838    
839     (definterface who-binds (variable-name)
840     "Return the locations where VARIABLE-NAME (a symbol) is bound.
841     See WHO-CALLS for a description of the return value.")
842    
843     (definterface who-sets (variable-name)
844     "Return the locations where VARIABLE-NAME (a symbol) is set.
845     See WHO-CALLS for a description of the return value.")
846    
847     (definterface who-macroexpands (macro-name)
848     "Return the locations where MACRO-NAME (a symbol) is expanded.
849     See WHO-CALLS for a description of the return value.")
850    
851     (definterface who-specializes (class-name)
852     "Return the locations where CLASS-NAME (a symbol) is specialized.
853     See WHO-CALLS for a description of the return value.")
854    
855     ;;; Simpler variants.
856    
857     (definterface list-callers (function-name)
858     "List the callers of FUNCTION-NAME.
859     This function is like WHO-CALLS except that it is expected to use
860     lower-level means. Whereas WHO-CALLS is usually implemented with
861     special compiler support, LIST-CALLERS is usually implemented by
862     groveling for constants in function objects throughout the heap.
863    
864     The return value is as for WHO-CALLS.")
865    
866     (definterface list-callees (function-name)
867     "List the functions called by FUNCTION-NAME.
868     See LIST-CALLERS for a description of the return value.")
869    
870    
871 heller 1.23 ;;;; Profiling
872    
873     ;;; The following functions define a minimal profiling interface.
874    
875     (definterface profile (fname)
876     "Marks symbol FNAME for profiling.")
877    
878     (definterface profiled-functions ()
879     "Returns a list of profiled functions.")
880    
881     (definterface unprofile (fname)
882     "Marks symbol FNAME as not profiled.")
883    
884     (definterface unprofile-all ()
885     "Marks all currently profiled functions as not profiled."
886     (dolist (f (profiled-functions))
887     (unprofile f)))
888    
889     (definterface profile-report ()
890     "Prints profile report.")
891    
892     (definterface profile-reset ()
893     "Resets profile counters.")
894    
895     (definterface profile-package (package callers-p methods)
896     "Wrap profiling code around all functions in PACKAGE. If a function
897     is already profiled, then unprofile and reprofile (useful to notice
898     function redefinition.)
899    
900     If CALLERS-P is T names have counts of the most common calling
901     functions recorded.
902    
903     When called with arguments :METHODS T, profile all methods of all
904     generic functions having names in the given package. Generic functions
905     themselves, that is, their dispatch functions, are left alone.")
906    
907    
908 heller 1.19 ;;;; Inspector
909 lgorrie 1.56
910 heller 1.128 (defgeneric emacs-inspect (object)
911 heller 1.100 (:documentation
912 heller 1.86 "Explain to Emacs how to inspect OBJECT.
913 mbaringer 1.67
914 heller 1.129 Returns a list specifying how to render the object for inspection.
915 mbaringer 1.67
916 lgorrie 1.83 Every element of the list must be either a string, which will be
917 mbaringer 1.67 inserted into the buffer as is, or a list of the form:
918    
919     (:value object &optional format) - Render an inspectable
920     object. If format is provided it must be a string and will be
921     rendered in place of the value, otherwise use princ-to-string.
922    
923     (:newline) - Render a \\n
924    
925 mbaringer 1.117 (:action label lambda &key (refresh t)) - Render LABEL (a text
926     string) which when clicked will call LAMBDA. If REFRESH is
927     non-NIL the currently inspected object will be re-inspected
928     after calling the lambda.
929 heller 1.129 "))
930 mbaringer 1.67
931 heller 1.128 (defmethod emacs-inspect ((object t))
932 mbaringer 1.67 "Generic method for inspecting any kind of object.
933    
934     Since we don't know how to deal with OBJECT we simply dump the
935     output of CL:DESCRIBE."
936 heller 1.86 `("Type: " (:value ,(type-of object)) (:newline)
937     "Don't know how to inspect the object, dumping output of CL:DESCRIBE:"
938     (:newline) (:newline)
939 heller 1.129 ,(with-output-to-string (desc) (describe object desc))))
940 heller 1.70
941 heller 1.84 ;;; Utilities for inspector methods.
942 heller 1.70 ;;;
943 mbaringer 1.118 (defun label-value-line (label value &key (newline t))
944     "Create a control list which prints \"LABEL: VALUE\" in the inspector.
945     If NEWLINE is non-NIL a `(:newline)' is added to the result."
946     (list* (princ-to-string label) ": " `(:value ,value)
947     (if newline '((:newline)) nil)))
948 heller 1.70
949     (defmacro label-value-line* (&rest label-values)
950     ` (append ,@(loop for (label value) in label-values
951     collect `(label-value-line ,label ,value))))
952 heller 1.19
953 heller 1.29 (definterface describe-primitive-type (object)
954 heller 1.35 "Return a string describing the primitive type of object."
955 heller 1.36 (declare (ignore object))
956 heller 1.35 "N/A")
957 heller 1.19
958    
959 heller 1.36 ;;;; Multithreading
960 lgorrie 1.21 ;;;
961     ;;; The default implementations are sufficient for non-multiprocessing
962     ;;; implementations.
963 lgorrie 1.9
964 mbaringer 1.106 (definterface initialize-multiprocessing (continuation)
965 heller 1.107 "Initialize multiprocessing, if necessary and then invoke CONTINUATION.
966    
967     Depending on the impleimentaion, this function may never return."
968 mbaringer 1.106 (funcall continuation))
969 lgorrie 1.9
970 lgorrie 1.21 (definterface spawn (fn &key name)
971     "Create a new thread to call FN.")
972 lgorrie 1.17
973 heller 1.58 (definterface thread-id (thread)
974     "Return an Emacs-parsable object to identify THREAD.
975    
976     Ids should be comparable with equal, i.e.:
977 heller 1.139 (equal (thread-id <t1>) (thread-id <t2>)) <==> (eq <t1> <t2>)"
978     thread)
979 heller 1.58
980     (definterface find-thread (id)
981     "Return the thread for ID.
982     ID should be an id previously obtained with THREAD-ID.
983 heller 1.142 Can return nil if the thread no longer exists."
984 heller 1.162 (declare (ignore id))
985 heller 1.142 (current-thread))
986 heller 1.58
987 heller 1.28 (definterface thread-name (thread)
988     "Return the name of THREAD.
989 lgorrie 1.9
990     Thread names are be single-line strings and are meaningful to the
991 lgorrie 1.21 user. They do not have to be unique."
992 heller 1.28 (declare (ignore thread))
993 lgorrie 1.21 "The One True Thread")
994 lgorrie 1.9
995 heller 1.28 (definterface thread-status (thread)
996     "Return a string describing THREAD's state."
997     (declare (ignore thread))
998     "")
999    
1000 trittweiler 1.133 (definterface thread-description (thread)
1001     "Return a string describing THREAD."
1002     (declare (ignore thread))
1003     "")
1004    
1005     (definterface set-thread-description (thread description)
1006     "Set THREAD's description to DESCRIPTION."
1007     (declare (ignore thread description))
1008     "")
1009    
1010 lgorrie 1.21 (definterface make-lock (&key name)
1011 lgorrie 1.17 "Make a lock for thread synchronization.
1012 heller 1.138 Only one thread may hold the lock (via CALL-WITH-LOCK-HELD) at a time
1013     but that thread may hold it more than once."
1014 heller 1.23 (declare (ignore name))
1015 lgorrie 1.21 :null-lock)
1016 lgorrie 1.9
1017 lgorrie 1.21 (definterface call-with-lock-held (lock function)
1018     "Call FUNCTION with LOCK held, queueing if necessary."
1019 heller 1.24 (declare (ignore lock)
1020     (type function function))
1021 lgorrie 1.21 (funcall function))
1022 heller 1.25
1023     (definterface current-thread ()
1024     "Return the currently executing thread."
1025     0)
1026 heller 1.28
1027     (definterface all-threads ()
1028 trittweiler 1.146 "Return a fresh list of all threads.")
1029 heller 1.28
1030     (definterface thread-alive-p (thread)
1031 heller 1.35 "Test if THREAD is termintated."
1032     (member thread (all-threads)))
1033 heller 1.25
1034     (definterface interrupt-thread (thread fn)
1035     "Cause THREAD to execute FN.")
1036    
1037 mbaringer 1.34 (definterface kill-thread (thread)
1038     "Kill THREAD."
1039     (declare (ignore thread))
1040     nil)
1041    
1042 heller 1.25 (definterface send (thread object)
1043     "Send OBJECT to thread THREAD.")
1044    
1045 heller 1.143 (definterface receive (&optional timeout)
1046 heller 1.142 "Return the next message from current thread's mailbox."
1047 heller 1.143 (receive-if (constantly t) timeout))
1048 mbaringer 1.78
1049 heller 1.143 (definterface receive-if (predicate &optional timeout)
1050 heller 1.136 "Return the first message satisfiying PREDICATE.")
1051    
1052 heller 1.168 (definterface set-default-initial-binding (var form)
1053     "Initialize special variable VAR by default with FORM.
1054    
1055     Some implementations initialize certain variables in each newly
1056     created thread. This function sets the form which is used to produce
1057     the initial value."
1058     (set var (eval form)))
1059    
1060 heller 1.153 ;; List of delayed interrupts.
1061     ;; This should only have thread-local bindings, so no init form.
1062     (defvar *pending-slime-interrupts*)
1063 heller 1.140
1064 heller 1.154 (defun check-slime-interrupts ()
1065 heller 1.140 "Execute pending interrupts if any.
1066     This should be called periodically in operations which
1067 heller 1.153 can take a long time to complete.
1068 heller 1.154 Return a boolean indicating whether any interrupts was processed."
1069 heller 1.153 (when (and (boundp '*pending-slime-interrupts*)
1070     *pending-slime-interrupts*)
1071 heller 1.154 (funcall (pop *pending-slime-interrupts*))
1072 heller 1.153 t))
1073 heller 1.140
1074 heller 1.172 (defvar *interrupt-queued-handler* nil
1075     "Function to call on queued interrupts.
1076     Interrupts get queued when an interrupt occurs while interrupt
1077     handling is disabled.
1078    
1079     Backends can use this function to abort slow operations.")
1080 heller 1.163
1081 heller 1.152 (definterface wait-for-input (streams &optional timeout)
1082     "Wait for input on a list of streams. Return those that are ready.
1083     STREAMS is a list of streams
1084     TIMEOUT nil, t, or real number. If TIMEOUT is t, return
1085     those streams which are ready immediately, without waiting.
1086     If TIMEOUT is a number and no streams is ready after TIMEOUT seconds,
1087     return nil.
1088    
1089     Return :interrupt if an interrupt occurs while waiting."
1090 heller 1.164 (assert (member timeout '(nil t)))
1091 heller 1.166 (cond #+(or)
1092     ((null (cdr streams))
1093 heller 1.164 (wait-for-one-stream (car streams) timeout))
1094     (t
1095     (wait-for-streams streams timeout))))
1096    
1097     (defun wait-for-streams (streams timeout)
1098 heller 1.166 (loop
1099     (when (check-slime-interrupts) (return :interrupt))
1100     (let ((ready (remove-if-not #'stream-readable-p streams)))
1101     (when ready (return ready)))
1102     (when timeout (return nil))
1103     (sleep 0.1)))
1104 heller 1.164
1105 heller 1.166 ;; Note: Usually we can't interrupt PEEK-CHAR cleanly.
1106 heller 1.164 (defun wait-for-one-stream (stream timeout)
1107     (ecase timeout
1108     ((nil)
1109     (cond ((check-slime-interrupts) :interrupt)
1110     (t (peek-char nil stream nil nil)
1111     (list stream))))
1112     ((t)
1113     (let ((c (read-char-no-hang stream nil nil)))
1114     (cond (c
1115     (unread-char c stream)
1116     (list stream))
1117     (t '()))))))
1118 heller 1.152
1119 heller 1.166 (defun stream-readable-p (stream)
1120     (let ((c (read-char-no-hang stream nil :eof)))
1121     (cond ((not c) nil)
1122     ((eq c :eof) t)
1123     (t (unread-char c stream) t))))
1124    
1125 heller 1.81 (definterface toggle-trace (spec)
1126     "Toggle tracing of the function(s) given with SPEC.
1127     SPEC can be:
1128     (setf NAME) ; a setf function
1129     (:defmethod NAME QUALIFIER... (SPECIALIZER...)) ; a specific method
1130     (:defgeneric NAME) ; a generic function with all methods
1131     (:call CALLER CALLEE) ; trace calls from CALLER to CALLEE.
1132     (:labels TOPLEVEL LOCAL)
1133     (:flet TOPLEVEL LOCAL) ")
1134 mkoeppe 1.87
1135    
1136     ;;;; Weak datastructures
1137    
1138     (definterface make-weak-key-hash-table (&rest args)
1139     "Like MAKE-HASH-TABLE, but weak w.r.t. the keys."
1140     (apply #'make-hash-table args))
1141    
1142     (definterface make-weak-value-hash-table (&rest args)
1143     "Like MAKE-HASH-TABLE, but weak w.r.t. the values."
1144     (apply #'make-hash-table args))
1145 mkoeppe 1.108
1146 alendvai 1.113 (definterface hash-table-weakness (hashtable)
1147     "Return nil or one of :key :value :key-or-value :key-and-value"
1148     (declare (ignore hashtable))
1149     nil)
1150    
1151 mkoeppe 1.108
1152     ;;;; Character names
1153    
1154     (definterface character-completion-set (prefix matchp)
1155     "Return a list of names of characters that match PREFIX."
1156     ;; Handle the standard and semi-standard characters.
1157     (loop for name in '("Newline" "Space" "Tab" "Page" "Rubout"
1158     "Linefeed" "Return" "Backspace")
1159     when (funcall matchp prefix name)
1160     collect name))
1161    
1162 trittweiler 1.120
1163     (defparameter *type-specifier-arglists*
1164     '((and . (&rest type-specifiers))
1165     (array . (&optional element-type dimension-spec))
1166     (base-string . (&optional size))
1167     (bit-vector . (&optional size))
1168     (complex . (&optional type-specifier))
1169     (cons . (&optional car-typespec cdr-typespec))
1170     (double-float . (&optional lower-limit upper-limit))
1171     (eql . (object))
1172     (float . (&optional lower-limit upper-limit))
1173     (function . (&optional arg-typespec value-typespec))
1174     (integer . (&optional lower-limit upper-limit))
1175     (long-float . (&optional lower-limit upper-limit))
1176     (member . (&rest eql-objects))
1177     (mod . (n))
1178     (not . (type-specifier))
1179     (or . (&rest type-specifiers))
1180     (rational . (&optional lower-limit upper-limit))
1181     (real . (&optional lower-limit upper-limit))
1182     (satisfies . (predicate-symbol))
1183     (short-float . (&optional lower-limit upper-limit))
1184     (signed-byte . (&optional size))
1185     (simple-array . (&optional element-type dimension-spec))
1186     (simple-base-string . (&optional size))
1187     (simple-bit-vector . (&optional size))
1188     (simple-string . (&optional size))
1189     (single-float . (&optional lower-limit upper-limit))
1190     (simple-vector . (&optional size))
1191     (string . (&optional size))
1192     (unsigned-byte . (&optional size))
1193     (values . (&rest typespecs))
1194     (vector . (&optional element-type size))
1195 heller 1.121 ))
1196 heller 1.145
1197     ;;; Heap dumps
1198    
1199     (definterface save-image (filename &optional restart-function)
1200     "Save a heap image to the file FILENAME.
1201     RESTART-FUNCTION, if non-nil, should be called when the image is loaded.")
1202    
1203    
1204    

  ViewVC Help
Powered by ViewVC 1.1.5