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

Contents of /slime/swank.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.375 - (show annotations)
Tue Mar 28 20:41:53 2006 UTC (8 years ago) by mkoeppe
Branch: MAIN
CVS Tags: SLIME-1-3
Branch point for: fsm
Changes since 1.374: +24 -13 lines
(multiple-value-or): New macro.
(extra-keywords): Use MULTIPLE-VALUE-OR rather than OR.
1 ;;; -*- outline-regexp: ";;;;;*"; indent-tabs-mode: nil -*-
2 ;;;
3 ;;; This code has been placed in the Public Domain. All warranties
4 ;;; are disclaimed.
5 ;;;
6 ;;;; swank.lisp
7 ;;;
8 ;;; This file defines the "Swank" TCP server for Emacs to talk to. The
9 ;;; code in this file is purely portable Common Lisp. We do require a
10 ;;; smattering of non-portable functions in order to write the server,
11 ;;; so we have defined them in `swank-backend.lisp' and implemented
12 ;;; them separately for each Lisp implementation. These extensions are
13 ;;; available to us here via the `SWANK-BACKEND' package.
14
15 (defpackage :swank
16 (:use :common-lisp :swank-backend)
17 (:export #:startup-multiprocessing
18 #:start-server
19 #:create-swank-server
20 #:create-server
21 #:ed-in-emacs
22 #:print-indentation-lossage
23 #:swank-debugger-hook
24 ;; These are user-configurable variables:
25 #:*communication-style*
26 #:*log-events*
27 #:*log-output*
28 #:*use-dedicated-output-stream*
29 #:*dedicated-output-stream-port*
30 #:*configure-emacs-indentation*
31 #:*readtable-alist*
32 #:*globally-redirect-io*
33 #:*global-debugger*
34 #:*sldb-printer-bindings*
35 #:*swank-pprint-bindings*
36 #:*default-worker-thread-bindings*
37 #:*macroexpand-printer-bindings*
38 #:*record-repl-results*
39 ;; These are re-exported directly from the backend:
40 #:buffer-first-change
41 #:frame-source-location-for-emacs
42 #:restart-frame
43 #:sldb-step
44 #:sldb-break
45 #:sldb-break-on-return
46 #:profiled-functions
47 #:profile-report
48 #:profile-reset
49 #:unprofile-all
50 #:profile-package
51 #:default-directory
52 #:set-default-directory
53 #:quit-lisp))
54
55 (in-package :swank)
56
57
58 ;;;; Top-level variables, constants, macros
59
60 (defconstant cl-package (find-package :cl)
61 "The COMMON-LISP package.")
62
63 (defconstant keyword-package (find-package :keyword)
64 "The KEYWORD package.")
65
66 (defvar *canonical-package-nicknames*
67 `((:common-lisp-user . :cl-user))
68 "Canonical package names to use instead of shortest name/nickname.")
69
70 (defvar *auto-abbreviate-dotted-packages* t
71 "Abbreviate dotted package names to their last component if T.")
72
73 (defvar *swank-io-package*
74 (let ((package (make-package :swank-io-package :use '())))
75 (import '(nil t quote) package)
76 package))
77
78 (defconstant default-server-port 4005
79 "The default TCP port for the server (when started manually).")
80
81 (defvar *swank-debug-p* t
82 "When true, print extra debugging information.")
83
84 (defvar *redirect-io* t
85 "When non-nil redirect Lisp standard I/O to Emacs.
86 Redirection is done while Lisp is processing a request for Emacs.")
87
88 (defvar *sldb-printer-bindings*
89 `((*print-pretty* . nil)
90 (*print-level* . 4)
91 (*print-length* . 10)
92 (*print-circle* . t)
93 (*print-readably* . nil)
94 (*print-pprint-dispatch* . ,(copy-pprint-dispatch nil))
95 (*print-gensym* . t)
96 (*print-base* . 10)
97 (*print-radix* . nil)
98 (*print-array* . t)
99 (*print-lines* . 200)
100 (*print-escape* . t))
101 "A set of printer variables used in the debugger.")
102
103 (defvar *default-worker-thread-bindings* '()
104 "An alist to initialize dynamic variables in worker threads.
105 The list has the form ((VAR . VALUE) ...). Each variable VAR will be
106 bound to the corresponding VALUE.")
107
108 (defun call-with-bindings (alist fun)
109 "Call FUN with variables bound according to ALIST.
110 ALIST is a list of the form ((VAR . VAL) ...)."
111 (let* ((rlist (reverse alist))
112 (vars (mapcar #'car rlist))
113 (vals (mapcar #'cdr rlist)))
114 (progv vars vals
115 (funcall fun))))
116
117 (defmacro with-bindings (alist &body body)
118 "See `call-with-bindings'."
119 `(call-with-bindings ,alist (lambda () ,@body)))
120
121 ;;; The `DEFSLIMEFUN' macro defines a function that Emacs can call via
122 ;;; RPC.
123
124 (defmacro defslimefun (name arglist &body rest)
125 "A DEFUN for functions that Emacs can call by RPC."
126 `(progn
127 (defun ,name ,arglist ,@rest)
128 ;; see <http://www.franz.com/support/documentation/6.2/doc/pages/variables/compiler/s_cltl1-compile-file-toplevel-compatibility-p_s.htm>
129 (eval-when (:compile-toplevel :load-toplevel :execute)
130 (export ',name :swank))))
131
132 (declaim (ftype (function () nil) missing-arg))
133 (defun missing-arg ()
134 "A function that the compiler knows will never to return a value.
135 You can use (MISSING-ARG) as the initform for defstruct slots that
136 must always be supplied. This way the :TYPE slot option need not
137 include some arbitrary initial value like NIL."
138 (error "A required &KEY or &OPTIONAL argument was not supplied."))
139
140
141 ;;;; Hooks
142 ;;;
143 ;;; We use Emacs-like `add-hook' and `run-hook' utilities to support
144 ;;; simple indirection. The interface is more CLish than the Emacs
145 ;;; Lisp one.
146
147 (defmacro add-hook (place function)
148 "Add FUNCTION to the list of values on PLACE."
149 `(pushnew ,function ,place))
150
151 (defun run-hook (functions &rest arguments)
152 "Call each of FUNCTIONS with ARGUMENTS."
153 (dolist (function functions)
154 (apply function arguments)))
155
156 (defvar *new-connection-hook* '()
157 "This hook is run each time a connection is established.
158 The connection structure is given as the argument.
159 Backend code should treat the connection structure as opaque.")
160
161 (defvar *connection-closed-hook* '()
162 "This hook is run when a connection is closed.
163 The connection as passed as an argument.
164 Backend code should treat the connection structure as opaque.")
165
166 (defvar *pre-reply-hook* '()
167 "Hook run (without arguments) immediately before replying to an RPC.")
168
169
170 ;;;; Connections
171 ;;;
172 ;;; Connection structures represent the network connections between
173 ;;; Emacs and Lisp. Each has a socket stream, a set of user I/O
174 ;;; streams that redirect to Emacs, and optionally a second socket
175 ;;; used solely to pipe user-output to Emacs (an optimization).
176 ;;;
177
178 (defvar *coding-system* ':iso-latin-1-unix)
179
180 (defstruct (connection
181 (:conc-name connection.)
182 (:print-function print-connection))
183 ;; Raw I/O stream of socket connection.
184 (socket-io (missing-arg) :type stream :read-only t)
185 ;; Optional dedicated output socket (backending `user-output' slot).
186 ;; Has a slot so that it can be closed with the connection.
187 (dedicated-output nil :type (or stream null))
188 ;; Streams that can be used for user interaction, with requests
189 ;; redirected to Emacs.
190 (user-input nil :type (or stream null))
191 (user-output nil :type (or stream null))
192 (user-io nil :type (or stream null))
193 ;; In multithreaded systems we delegate certain tasks to specific
194 ;; threads. The `reader-thread' is responsible for reading network
195 ;; requests from Emacs and sending them to the `control-thread'; the
196 ;; `control-thread' is responsible for dispatching requests to the
197 ;; threads that should handle them; the `repl-thread' is the one
198 ;; that evaluates REPL expressions. The control thread dispatches
199 ;; all REPL evaluations to the REPL thread and for other requests it
200 ;; spawns new threads.
201 reader-thread
202 control-thread
203 repl-thread
204 ;; Callback functions:
205 ;; (SERVE-REQUESTS <this-connection>) serves all pending requests
206 ;; from Emacs.
207 (serve-requests (missing-arg) :type function)
208 ;; (READ) is called to read and return one message from Emacs.
209 (read (missing-arg) :type function)
210 ;; (SEND OBJECT) is called to send one message to Emacs.
211 (send (missing-arg) :type function)
212 ;; (CLEANUP <this-connection>) is called when the connection is
213 ;; closed.
214 (cleanup nil :type (or null function))
215 ;; Cache of macro-indentation information that has been sent to Emacs.
216 ;; This is used for preparing deltas to update Emacs's knowledge.
217 ;; Maps: symbol -> indentation-specification
218 (indentation-cache (make-hash-table :test 'eq) :type hash-table)
219 ;; The list of packages represented in the cache:
220 (indentation-cache-packages '())
221 ;; The communication style used.
222 (communication-style nil :type (member nil :spawn :sigio :fd-handler))
223 ;; The coding system for network streams.
224 (external-format *coding-system* :type (member :iso-latin-1-unix
225 :emacs-mule-unix
226 :utf-8-unix
227 :euc-jp-unix)))
228
229 (defun print-connection (conn stream depth)
230 (declare (ignore depth))
231 (print-unreadable-object (conn stream :type t :identity t)))
232
233 (defvar *connections* '()
234 "List of all active connections, with the most recent at the front.")
235
236 (defvar *emacs-connection* nil
237 "The connection to Emacs currently in use.")
238
239 (defvar *swank-state-stack* '()
240 "A list of symbols describing the current state. Used for debugging
241 and to detect situations where interrupts can be ignored.")
242
243 (defun default-connection ()
244 "Return the 'default' Emacs connection.
245 This connection can be used to talk with Emacs when no specific
246 connection is in use, i.e. *EMACS-CONNECTION* is NIL.
247
248 The default connection is defined (quite arbitrarily) as the most
249 recently established one."
250 (first *connections*))
251
252 (defslimefun state-stack ()
253 "Return the value of *SWANK-STATE-STACK*."
254 *swank-state-stack*)
255
256 (define-condition slime-protocol-error (error)
257 ((condition :initarg :condition :reader slime-protocol-error.condition))
258 (:report (lambda (condition stream)
259 (format stream "~A" (slime-protocol-error.condition condition)))))
260
261 (add-hook *new-connection-hook* 'notify-backend-of-connection)
262 (defun notify-backend-of-connection (connection)
263 (declare (ignore connection))
264 (emacs-connected))
265
266
267 ;;;; Helper macros
268
269 (defmacro with-io-redirection ((connection) &body body)
270 "Execute BODY I/O redirection to CONNECTION.
271 If *REDIRECT-IO* is true then all standard I/O streams are redirected."
272 `(maybe-call-with-io-redirection ,connection (lambda () ,@body)))
273
274 (defun maybe-call-with-io-redirection (connection fun)
275 (if *redirect-io*
276 (call-with-redirected-io connection fun)
277 (funcall fun)))
278
279 (defmacro with-connection ((connection) &body body)
280 "Execute BODY in the context of CONNECTION."
281 `(call-with-connection ,connection (lambda () ,@body)))
282
283 (defun call-with-connection (connection fun)
284 (let ((*emacs-connection* connection))
285 (with-io-redirection (*emacs-connection*)
286 (call-with-debugger-hook #'swank-debugger-hook fun))))
287
288 (defmacro without-interrupts (&body body)
289 `(call-without-interrupts (lambda () ,@body)))
290
291 (defmacro destructure-case (value &rest patterns)
292 "Dispatch VALUE to one of PATTERNS.
293 A cross between `case' and `destructuring-bind'.
294 The pattern syntax is:
295 ((HEAD . ARGS) . BODY)
296 The list of patterns is searched for a HEAD `eq' to the car of
297 VALUE. If one is found, the BODY is executed with ARGS bound to the
298 corresponding values in the CDR of VALUE."
299 (let ((operator (gensym "op-"))
300 (operands (gensym "rand-"))
301 (tmp (gensym "tmp-")))
302 `(let* ((,tmp ,value)
303 (,operator (car ,tmp))
304 (,operands (cdr ,tmp)))
305 (case ,operator
306 ,@(loop for (pattern . body) in patterns collect
307 (if (eq pattern t)
308 `(t ,@body)
309 (destructuring-bind (op &rest rands) pattern
310 `(,op (destructuring-bind ,rands ,operands
311 ,@body)))))
312 ,@(if (eq (caar (last patterns)) t)
313 '()
314 `((t (error "destructure-case failed: ~S" ,tmp))))))))
315
316 (defmacro with-temp-package (var &body body)
317 "Execute BODY with VAR bound to a temporary package.
318 The package is deleted before returning."
319 `(let ((,var (make-package (gensym "TEMP-PACKAGE-"))))
320 (unwind-protect (progn ,@body)
321 (delete-package ,var))))
322
323 (defvar *log-events* nil)
324 (defvar *log-output* *error-output*)
325 (defvar *event-history* (make-array 40 :initial-element nil)
326 "A ring buffer to record events for better error messages.")
327 (defvar *event-history-index* 0)
328 (defvar *enable-event-history* t)
329
330 (defun log-event (format-string &rest args)
331 "Write a message to *terminal-io* when *log-events* is non-nil.
332 Useful for low level debugging."
333 (when *enable-event-history*
334 (setf (aref *event-history* *event-history-index*)
335 (format nil "~?" format-string args))
336 (setf *event-history-index*
337 (mod (1+ *event-history-index*) (length *event-history*))))
338 (when *log-events*
339 (apply #'format *log-output* format-string args)
340 (force-output *log-output*)))
341
342 (defun event-history-to-list ()
343 "Return the list of events (older events first)."
344 (let ((arr *event-history*)
345 (idx *event-history-index*))
346 (concatenate 'list (subseq arr idx) (subseq arr 0 idx))))
347
348 (defun dump-event-history (stream)
349 (dolist (e (event-history-to-list))
350 (dump-event e stream)))
351
352 (defun dump-event (event stream)
353 (cond ((stringp event)
354 (write-string (escape-non-ascii event) stream))
355 ((null event))
356 (t (format stream "Unexpected event: ~A~%" event))))
357
358 (defun escape-non-ascii (string)
359 "Return a string like STRING but with non-ascii chars escaped."
360 (cond ((ascii-string-p string) string)
361 (t (with-output-to-string (out)
362 (loop for c across string do
363 (cond ((ascii-char-p c) (write-char c out))
364 (t (format out "\\x~4,'0X" (char-code c)))))))))
365
366 (defun ascii-string-p (o)
367 (and (stringp o)
368 (every #'ascii-char-p o)))
369
370 (defun ascii-char-p (c)
371 (<= (char-code c) 127))
372
373
374 ;;;; TCP Server
375
376 (defvar *use-dedicated-output-stream* t
377 "When T swank will attempt to create a second connection to
378 Emacs which is used just to send output.")
379
380 (defvar *dedicated-output-stream-port* 0
381 "Which port we should use for the dedicated output stream.")
382
383 (defvar *communication-style* (preferred-communication-style))
384
385 (defvar *dedicated-output-stream-buffering*
386 (if (eq *communication-style* :spawn) :full :none)
387 "The buffering scheme that should be used for the output stream.
388 Valid values are :none, :line, and :full.")
389
390 (defun start-server (port-file &key (style *communication-style*)
391 dont-close (external-format *coding-system*))
392 "Start the server and write the listen port number to PORT-FILE.
393 This is the entry point for Emacs."
394 (when (eq style :spawn)
395 (initialize-multiprocessing))
396 (setup-server 0 (lambda (port) (announce-server-port port-file port))
397 style dont-close external-format)
398 (when (eq style :spawn)
399 (startup-idle-and-top-level-loops)))
400
401 (defun create-server (&key (port default-server-port)
402 (style *communication-style*)
403 dont-close (external-format *coding-system*))
404 "Start a SWANK server on PORT running in STYLE.
405 If DONT-CLOSE is true then the listen socket will accept multiple
406 connections, otherwise it will be closed after the first."
407 (setup-server port #'simple-announce-function style dont-close
408 external-format))
409
410 (defun create-swank-server (&optional (port default-server-port)
411 (style *communication-style*)
412 (announce-fn #'simple-announce-function)
413 dont-close (external-format *coding-system*))
414 (setup-server port announce-fn style dont-close external-format))
415
416 (defparameter *loopback-interface* "127.0.0.1")
417
418 (defun setup-server (port announce-fn style dont-close external-format)
419 (declare (type function announce-fn))
420 (let* ((socket (create-socket *loopback-interface* port))
421 (port (local-port socket)))
422 (funcall announce-fn port)
423 (flet ((serve ()
424 (serve-connection socket style dont-close external-format)))
425 (ecase style
426 (:spawn
427 (spawn (lambda () (loop do (ignore-errors (serve)) while dont-close))
428 :name "Swank"))
429 ((:fd-handler :sigio)
430 (add-fd-handler socket (lambda () (serve))))
431 ((nil) (loop do (serve) while dont-close)))
432 port)))
433
434 (defun serve-connection (socket style dont-close external-format)
435 (let ((closed-socket-p nil))
436 (unwind-protect
437 (let ((client (accept-authenticated-connection
438 socket :external-format external-format)))
439 (unless dont-close
440 (close-socket socket)
441 (setf closed-socket-p t))
442 (let ((connection (create-connection client style external-format)))
443 (run-hook *new-connection-hook* connection)
444 (push connection *connections*)
445 (serve-requests connection)))
446 (unless (or dont-close closed-socket-p)
447 (close-socket socket)))))
448
449 (defun accept-authenticated-connection (&rest args)
450 (let ((new (apply #'accept-connection args))
451 (success nil))
452 (unwind-protect
453 (let ((secret (slime-secret)))
454 (when secret
455 (set-stream-timeout new 20)
456 (let ((first-val (decode-message new)))
457 (unless (and (stringp first-val) (string= first-val secret))
458 (error "Incoming connection doesn't know the password."))))
459 (set-stream-timeout new nil)
460 (setf success t))
461 (unless success
462 (close new :abort t)))
463 new))
464
465 (defun slime-secret ()
466 "Finds the magic secret from the user's home directory. Returns nil
467 if the file doesn't exist; otherwise the first line of the file."
468 (with-open-file (in
469 (merge-pathnames (user-homedir-pathname) #p".slime-secret")
470 :if-does-not-exist nil)
471 (and in (read-line in nil ""))))
472
473 (defun serve-requests (connection)
474 "Read and process all requests on connections."
475 (funcall (connection.serve-requests connection) connection))
476
477 (defun announce-server-port (file port)
478 (with-open-file (s file
479 :direction :output
480 :if-exists :error
481 :if-does-not-exist :create)
482 (format s "~S~%" port))
483 (simple-announce-function port))
484
485 (defun simple-announce-function (port)
486 (when *swank-debug-p*
487 (format *debug-io* "~&;; Swank started at port: ~D.~%" port)
488 (force-output *debug-io*)))
489
490 (defun open-streams (connection)
491 "Return the 4 streams for IO redirection:
492 DEDICATED-OUTPUT INPUT OUTPUT IO"
493 (multiple-value-bind (output-fn dedicated-output)
494 (make-output-function connection)
495 (let ((input-fn
496 (lambda ()
497 (with-connection (connection)
498 (with-simple-restart (abort-read
499 "Abort reading input from Emacs.")
500 (read-user-input-from-emacs))))))
501 (multiple-value-bind (in out) (make-fn-streams input-fn output-fn)
502 (let ((out (or dedicated-output out)))
503 (let ((io (make-two-way-stream in out)))
504 (mapc #'make-stream-interactive (list in out io))
505 (values dedicated-output in out io)))))))
506
507 (defun make-output-function (connection)
508 "Create function to send user output to Emacs.
509 This function may open a dedicated socket to send output. It
510 returns two values: the output function, and the dedicated
511 stream (or NIL if none was created)."
512 (if *use-dedicated-output-stream*
513 (let ((stream (open-dedicated-output-stream
514 (connection.socket-io connection)
515 (connection.external-format connection))))
516 (values (lambda (string)
517 (write-string string stream)
518 (force-output stream))
519 stream))
520 (values (lambda (string)
521 (with-connection (connection)
522 (with-simple-restart
523 (abort "Abort sending output to Emacs.")
524 (send-to-emacs `(:write-string ,string)))))
525 nil)))
526
527 (defun open-dedicated-output-stream (socket-io external-format)
528 "Open a dedicated output connection to the Emacs on SOCKET-IO.
529 Return an output stream suitable for writing program output.
530
531 This is an optimized way for Lisp to deliver output to Emacs."
532 (let ((socket (create-socket *loopback-interface*
533 *dedicated-output-stream-port*)))
534 (unwind-protect
535 (let ((port (local-port socket)))
536 (encode-message `(:open-dedicated-output-stream ,port) socket-io)
537 (let ((dedicated (accept-authenticated-connection
538 socket :external-format external-format
539 :buffering *dedicated-output-stream-buffering*
540 :timeout 30)))
541 (close-socket socket)
542 (setf socket nil)
543 dedicated))
544 (when socket
545 (close-socket socket)))))
546
547 (defun handle-request (connection)
548 "Read and process one request. The processing is done in the extent
549 of the toplevel restart."
550 (assert (null *swank-state-stack*))
551 (let ((*swank-state-stack* '(:handle-request)))
552 (with-connection (connection)
553 (with-simple-restart (abort-request "Abort handling SLIME request.")
554 (read-from-emacs)))))
555
556 (defun current-socket-io ()
557 (connection.socket-io *emacs-connection*))
558
559 (defun close-connection (c &optional condition)
560 (let ((cleanup (connection.cleanup c)))
561 (when cleanup
562 (funcall cleanup c)))
563 (close (connection.socket-io c))
564 (when (connection.dedicated-output c)
565 (close (connection.dedicated-output c)))
566 (setf *connections* (remove c *connections*))
567 (run-hook *connection-closed-hook* c)
568 (when condition
569 (finish-output *debug-io*)
570 (format *debug-io* "~&;; Event history start:~%")
571 (dump-event-history *debug-io*)
572 (format *debug-io* ";; Event history end.~%~
573 ;; Connection to Emacs lost. [~%~
574 ;; condition: ~A~%~
575 ;; type: ~S~%~
576 ;; encoding: ~S style: ~S dedicated: ~S]~%"
577 (escape-non-ascii (safe-condition-message condition) )
578 (type-of condition)
579 (connection.external-format c)
580 (connection.communication-style c)
581 *use-dedicated-output-stream*)
582 (finish-output *debug-io*)))
583
584 (defmacro with-reader-error-handler ((connection) &body body)
585 `(handler-case (progn ,@body)
586 (slime-protocol-error (e)
587 (close-connection ,connection e))))
588
589 (defslimefun simple-break ()
590 (with-simple-restart (continue "Continue from interrupt.")
591 (call-with-debugger-hook
592 #'swank-debugger-hook
593 (lambda ()
594 (invoke-debugger
595 (make-condition 'simple-error
596 :format-control "Interrupt from Emacs")))))
597 nil)
598
599 ;;;;;; Thread based communication
600
601 (defvar *active-threads* '())
602
603 (defun read-loop (control-thread input-stream connection)
604 (with-reader-error-handler (connection)
605 (loop (send control-thread (decode-message input-stream)))))
606
607 (defun dispatch-loop (socket-io connection)
608 (let ((*emacs-connection* connection))
609 (handler-case
610 (loop (dispatch-event (receive) socket-io))
611 (error (e)
612 (close-connection connection e)))))
613
614 (defun repl-thread (connection)
615 (let ((thread (connection.repl-thread connection)))
616 (when (not thread)
617 (log-event "ERROR: repl-thread is nil"))
618 (assert thread)
619 (cond ((thread-alive-p thread)
620 thread)
621 (t
622 (setf (connection.repl-thread connection)
623 (spawn-repl-thread connection "new-repl-thread"))))))
624
625 (defun find-worker-thread (id)
626 (etypecase id
627 ((member t)
628 (car *active-threads*))
629 ((member :repl-thread)
630 (repl-thread *emacs-connection*))
631 (fixnum
632 (find-thread id))))
633
634 (defun interrupt-worker-thread (id)
635 (let ((thread (or (find-worker-thread id)
636 (repl-thread *emacs-connection*))))
637 (interrupt-thread thread #'simple-break)))
638
639 (defun thread-for-evaluation (id)
640 "Find or create a thread to evaluate the next request."
641 (let ((c *emacs-connection*))
642 (etypecase id
643 ((member t)
644 (spawn-worker-thread c))
645 ((member :repl-thread)
646 (repl-thread c))
647 (fixnum
648 (find-thread id)))))
649
650 (defun spawn-worker-thread (connection)
651 (spawn (lambda ()
652 (with-bindings *default-worker-thread-bindings*
653 (handle-request connection)))
654 :name "worker"))
655
656 (defun spawn-repl-thread (connection name)
657 (spawn (lambda ()
658 (with-bindings *default-worker-thread-bindings*
659 (repl-loop connection)))
660 :name name))
661
662 (defun dispatch-event (event socket-io)
663 "Handle an event triggered either by Emacs or within Lisp."
664 (log-event "DISPATCHING: ~S~%" event)
665 (destructure-case event
666 ((:emacs-rex form package thread-id id)
667 (let ((thread (thread-for-evaluation thread-id)))
668 (push thread *active-threads*)
669 (send thread `(eval-for-emacs ,form ,package ,id))))
670 ((:return thread &rest args)
671 (let ((tail (member thread *active-threads*)))
672 (setq *active-threads* (nconc (ldiff *active-threads* tail)
673 (cdr tail))))
674 (encode-message `(:return ,@args) socket-io))
675 ((:emacs-interrupt thread-id)
676 (interrupt-worker-thread thread-id))
677 (((:debug :debug-condition :debug-activate :debug-return)
678 thread &rest args)
679 (encode-message `(,(car event) ,(thread-id thread) ,@args) socket-io))
680 ((:read-string thread &rest args)
681 (encode-message `(:read-string ,(thread-id thread) ,@args) socket-io))
682 ((:y-or-n-p thread &rest args)
683 (encode-message `(:y-or-n-p ,(thread-id thread) ,@args) socket-io))
684 ((:read-aborted thread &rest args)
685 (encode-message `(:read-aborted ,(thread-id thread) ,@args) socket-io))
686 ((:emacs-return-string thread-id tag string)
687 (send (find-thread thread-id) `(take-input ,tag ,string)))
688 ((:eval thread &rest args)
689 (encode-message `(:eval ,(thread-id thread) ,@args) socket-io))
690 ((:emacs-return thread-id tag value)
691 (send (find-thread thread-id) `(take-input ,tag ,value)))
692 (((:write-string :presentation-start :presentation-end
693 :new-package :new-features :ed :%apply :indentation-update
694 :eval-no-wait :background-message)
695 &rest _)
696 (declare (ignore _))
697 (encode-message event socket-io))))
698
699 (defun spawn-threads-for-connection (connection)
700 (macrolet ((without-debugger-hook (&body body)
701 `(call-with-debugger-hook nil (lambda () ,@body))))
702 (let* ((socket-io (connection.socket-io connection))
703 (control-thread (spawn (lambda ()
704 (without-debugger-hook
705 (dispatch-loop socket-io connection)))
706 :name "control-thread")))
707 (setf (connection.control-thread connection) control-thread)
708 (let ((reader-thread (spawn (lambda ()
709 (let ((go (receive)))
710 (assert (eq go 'accept-input)))
711 (without-debugger-hook
712 (read-loop control-thread socket-io
713 connection)))
714 :name "reader-thread"))
715 (repl-thread (spawn-repl-thread connection "repl-thread")))
716 (setf (connection.repl-thread connection) repl-thread)
717 (setf (connection.reader-thread connection) reader-thread)
718 (send reader-thread 'accept-input)
719 connection))))
720
721 (defun cleanup-connection-threads (connection)
722 (let ((threads (list (connection.repl-thread connection)
723 (connection.reader-thread connection)
724 (connection.control-thread connection))))
725 (dolist (thread threads)
726 (when (and thread
727 (thread-alive-p thread)
728 (not (equal (current-thread) thread)))
729 (kill-thread thread)))))
730
731 (defun repl-loop (connection)
732 (with-connection (connection)
733 (loop (handle-request connection))))
734
735 (defun process-available-input (stream fn)
736 (loop while (and (open-stream-p stream)
737 (listen stream))
738 do (funcall fn)))
739
740 ;;;;;; Signal driven IO
741
742 (defun install-sigio-handler (connection)
743 (let ((client (connection.socket-io connection)))
744 (flet ((handler ()
745 (cond ((null *swank-state-stack*)
746 (with-reader-error-handler (connection)
747 (process-available-input
748 client (lambda () (handle-request connection)))))
749 ((eq (car *swank-state-stack*) :read-next-form))
750 (t (process-available-input client #'read-from-emacs)))))
751 (add-sigio-handler client #'handler)
752 (handler))))
753
754 (defun deinstall-sigio-handler (connection)
755 (remove-sigio-handlers (connection.socket-io connection)))
756
757 ;;;;;; SERVE-EVENT based IO
758
759 (defun install-fd-handler (connection)
760 (let ((client (connection.socket-io connection)))
761 (flet ((handler ()
762 (cond ((null *swank-state-stack*)
763 (with-reader-error-handler (connection)
764 (process-available-input
765 client (lambda () (handle-request connection)))))
766 ((eq (car *swank-state-stack*) :read-next-form))
767 (t
768 (process-available-input client #'read-from-emacs)))))
769 ;; handle sigint
770 (install-debugger-globally
771 (lambda (c h)
772 (with-reader-error-handler (connection)
773 (block debugger
774 (with-connection (connection)
775 (swank-debugger-hook c h)
776 (return-from debugger))
777 (abort)))))
778 (add-fd-handler client #'handler)
779 (handler))))
780
781 (defun deinstall-fd-handler (connection)
782 (remove-fd-handlers (connection.socket-io connection)))
783
784 ;;;;;; Simple sequential IO
785
786 (defun simple-serve-requests (connection)
787 (with-reader-error-handler (connection)
788 (unwind-protect
789 (loop
790 (with-connection (connection)
791 (with-simple-restart (abort-request "")
792 (do ()
793 ((wait-until-readable (connection.socket-io connection))))))
794 (handle-request connection))
795 (close-connection connection))))
796
797 (defun wait-until-readable (stream)
798 (unread-char (read-char stream) stream)
799 t)
800
801 (defun read-from-socket-io ()
802 (let ((event (decode-message (current-socket-io))))
803 (log-event "DISPATCHING: ~S~%" event)
804 (destructure-case event
805 ((:emacs-rex form package thread id)
806 (declare (ignore thread))
807 `(eval-for-emacs ,form ,package ,id))
808 ((:emacs-interrupt thread)
809 (declare (ignore thread))
810 '(simple-break))
811 ((:emacs-return-string thread tag string)
812 (declare (ignore thread))
813 `(take-input ,tag ,string))
814 ((:emacs-return thread tag value)
815 (declare (ignore thread))
816 `(take-input ,tag ,value)))))
817
818 (defun send-to-socket-io (event)
819 (log-event "DISPATCHING: ~S~%" event)
820 (flet ((send (o)
821 (without-interrupts
822 (encode-message o (current-socket-io)))))
823 (destructure-case event
824 (((:debug-activate :debug :debug-return :read-string :read-aborted
825 :y-or-n-p :eval)
826 thread &rest args)
827 (declare (ignore thread))
828 (send `(,(car event) 0 ,@args)))
829 ((:return thread &rest args)
830 (declare (ignore thread))
831 (send `(:return ,@args)))
832 (((:write-string :new-package :new-features :debug-condition
833 :presentation-start :presentation-end
834 :indentation-update :ed :%apply :eval-no-wait
835 :background-message)
836 &rest _)
837 (declare (ignore _))
838 (send event)))))
839
840 (defun initialize-streams-for-connection (connection)
841 (multiple-value-bind (dedicated in out io) (open-streams connection)
842 (setf (connection.dedicated-output connection) dedicated
843 (connection.user-io connection) io
844 (connection.user-output connection) out
845 (connection.user-input connection) in)
846 connection))
847
848 (defun create-connection (socket-io style external-format)
849 (let ((success nil))
850 (unwind-protect
851 (let ((c (ecase style
852 (:spawn
853 (make-connection :socket-io socket-io
854 :read #'read-from-control-thread
855 :send #'send-to-control-thread
856 :serve-requests #'spawn-threads-for-connection
857 :cleanup #'cleanup-connection-threads))
858 (:sigio
859 (make-connection :socket-io socket-io
860 :read #'read-from-socket-io
861 :send #'send-to-socket-io
862 :serve-requests #'install-sigio-handler
863 :cleanup #'deinstall-sigio-handler))
864 (:fd-handler
865 (make-connection :socket-io socket-io
866 :read #'read-from-socket-io
867 :send #'send-to-socket-io
868 :serve-requests #'install-fd-handler
869 :cleanup #'deinstall-fd-handler))
870 ((nil)
871 (make-connection :socket-io socket-io
872 :read #'read-from-socket-io
873 :send #'send-to-socket-io
874 :serve-requests #'simple-serve-requests)))))
875 (setf (connection.communication-style c) style)
876 (setf (connection.external-format c) external-format)
877 (initialize-streams-for-connection c)
878 (setf success t)
879 c)
880 (unless success
881 (close socket-io :abort t)))))
882
883
884 ;;;; IO to Emacs
885 ;;;
886 ;;; This code handles redirection of the standard I/O streams
887 ;;; (`*standard-output*', etc) into Emacs. The `connection' structure
888 ;;; contains the appropriate streams, so all we have to do is make the
889 ;;; right bindings.
890
891 ;;;;; Global I/O redirection framework
892 ;;;
893 ;;; Optionally, the top-level global bindings of the standard streams
894 ;;; can be assigned to be redirected to Emacs. When Emacs connects we
895 ;;; redirect the streams into the connection, and they keep going into
896 ;;; that connection even if more are established. If the connection
897 ;;; handling the streams closes then another is chosen, or if there
898 ;;; are no connections then we revert to the original (real) streams.
899 ;;;
900 ;;; It is slightly tricky to assign the global values of standard
901 ;;; streams because they are often shadowed by dynamic bindings. We
902 ;;; solve this problem by introducing an extra indirection via synonym
903 ;;; streams, so that *STANDARD-INPUT* is a synonym stream to
904 ;;; *CURRENT-STANDARD-INPUT*, etc. We never shadow the "current"
905 ;;; variables, so they can always be assigned to affect a global
906 ;;; change.
907
908 (defvar *globally-redirect-io* nil
909 "When non-nil globally redirect all standard streams to Emacs.")
910
911 (defmacro setup-stream-indirection (stream-var)
912 "Setup redirection scaffolding for a global stream variable.
913 Supposing (for example) STREAM-VAR is *STANDARD-INPUT*, this macro:
914
915 1. Saves the value of *STANDARD-INPUT* in a variable called
916 *REAL-STANDARD-INPUT*.
917
918 2. Creates *CURRENT-STANDARD-INPUT*, initially with the same value as
919 *STANDARD-INPUT*.
920
921 3. Assigns *STANDARD-INPUT* to a synonym stream pointing to
922 *CURRENT-STANDARD-INPUT*.
923
924 This has the effect of making *CURRENT-STANDARD-INPUT* contain the
925 effective global value for *STANDARD-INPUT*. This way we can assign
926 the effective global value even when *STANDARD-INPUT* is shadowed by a
927 dynamic binding."
928 (let ((real-stream-var (prefixed-var '#:real stream-var))
929 (current-stream-var (prefixed-var '#:current stream-var)))
930 `(progn
931 ;; Save the real stream value for the future.
932 (defvar ,real-stream-var ,stream-var)
933 ;; Define a new variable for the effective stream.
934 ;; This can be reassigned.
935 (defvar ,current-stream-var ,stream-var)
936 ;; Assign the real binding as a synonym for the current one.
937 (setq ,stream-var (make-synonym-stream ',current-stream-var)))))
938
939 (eval-when (:compile-toplevel :load-toplevel :execute)
940 (defun prefixed-var (prefix variable-symbol)
941 "(PREFIXED-VAR \"FOO\" '*BAR*) => SWANK::*FOO-BAR*"
942 (let ((basename (subseq (symbol-name variable-symbol) 1)))
943 (intern (format nil "*~A-~A" prefix basename) :swank))))
944
945 ;;;;; Global redirection setup
946
947 (setup-stream-indirection *standard-output*)
948 (setup-stream-indirection *error-output*)
949 (setup-stream-indirection *trace-output*)
950 (setup-stream-indirection *standard-input*)
951 (setup-stream-indirection *debug-io*)
952 (setup-stream-indirection *query-io*)
953 (setup-stream-indirection *terminal-io*)
954
955 (defparameter *standard-output-streams*
956 '(*standard-output* *error-output* *trace-output*)
957 "The symbols naming standard output streams.")
958
959 (defparameter *standard-input-streams*
960 '(*standard-input*)
961 "The symbols naming standard input streams.")
962
963 (defparameter *standard-io-streams*
964 '(*debug-io* *query-io* *terminal-io*)
965 "The symbols naming standard io streams.")
966
967 (defun globally-redirect-io-to-connection (connection)
968 "Set the standard I/O streams to redirect to CONNECTION.
969 Assigns *CURRENT-<STREAM>* for all standard streams."
970 (dolist (o *standard-output-streams*)
971 (set (prefixed-var '#:current o)
972 (connection.user-output connection)))
973 ;; FIXME: If we redirect standard input to Emacs then we get the
974 ;; regular Lisp top-level trying to read from our REPL.
975 ;;
976 ;; Perhaps the ideal would be for the real top-level to run in a
977 ;; thread with local bindings for all the standard streams. Failing
978 ;; that we probably would like to inhibit it from reading while
979 ;; Emacs is connected.
980 ;;
981 ;; Meanwhile we just leave *standard-input* alone.
982 #+NIL
983 (dolist (i *standard-input-streams*)
984 (set (prefixed-var '#:current i)
985 (connection.user-input connection)))
986 (dolist (io *standard-io-streams*)
987 (set (prefixed-var '#:current io)
988 (connection.user-io connection))))
989
990 (defun revert-global-io-redirection ()
991 "Set *CURRENT-<STREAM>* to *REAL-<STREAM>* for all standard streams."
992 (dolist (stream-var (append *standard-output-streams*
993 *standard-input-streams*
994 *standard-io-streams*))
995 (set (prefixed-var '#:current stream-var)
996 (symbol-value (prefixed-var '#:real stream-var)))))
997
998 ;;;;; Global redirection hooks
999
1000 (defvar *global-stdio-connection* nil
1001 "The connection to which standard I/O streams are globally redirected.
1002 NIL if streams are not globally redirected.")
1003
1004 (defun maybe-redirect-global-io (connection)
1005 "Consider globally redirecting to a newly-established CONNECTION."
1006 (when (and *globally-redirect-io* (null *global-stdio-connection*))
1007 (setq *global-stdio-connection* connection)
1008 (globally-redirect-io-to-connection connection)))
1009
1010 (defun update-redirection-after-close (closed-connection)
1011 "Update redirection after a connection closes."
1012 (when (eq *global-stdio-connection* closed-connection)
1013 (if (and (default-connection) *globally-redirect-io*)
1014 ;; Redirect to another connection.
1015 (globally-redirect-io-to-connection (default-connection))
1016 ;; No more connections, revert to the real streams.
1017 (progn (revert-global-io-redirection)
1018 (setq *global-stdio-connection* nil)))))
1019
1020 (add-hook *new-connection-hook* 'maybe-redirect-global-io)
1021 (add-hook *connection-closed-hook* 'update-redirection-after-close)
1022
1023 ;;;;; Redirection during requests
1024 ;;;
1025 ;;; We always redirect the standard streams to Emacs while evaluating
1026 ;;; an RPC. This is done with simple dynamic bindings.
1027
1028 (defun call-with-redirected-io (connection function)
1029 "Call FUNCTION with I/O streams redirected via CONNECTION."
1030 (declare (type function function))
1031 (let* ((io (connection.user-io connection))
1032 (in (connection.user-input connection))
1033 (out (connection.user-output connection))
1034 (*standard-output* out)
1035 (*error-output* out)
1036 (*trace-output* out)
1037 (*debug-io* io)
1038 (*query-io* io)
1039 (*standard-input* in)
1040 (*terminal-io* io))
1041 (funcall function)))
1042
1043 (defun read-from-emacs ()
1044 "Read and process a request from Emacs."
1045 (apply #'funcall (funcall (connection.read *emacs-connection*))))
1046
1047 (defun read-from-control-thread ()
1048 (receive))
1049
1050 (defun decode-message (stream)
1051 "Read an S-expression from STREAM using the SLIME protocol.
1052 If a protocol error occurs then a SLIME-PROTOCOL-ERROR is signalled."
1053 (let ((*swank-state-stack* (cons :read-next-form *swank-state-stack*)))
1054 (handler-case
1055 (let* ((length (decode-message-length stream))
1056 (string (make-string length))
1057 (pos (read-sequence string stream)))
1058 (assert (= pos length) ()
1059 "Short read: length=~D pos=~D" length pos)
1060 (log-event "READ: ~S~%" string)
1061 (read-form string))
1062 (serious-condition (c)
1063 (error (make-condition 'slime-protocol-error :condition c))))))
1064
1065 (defun decode-message-length (stream)
1066 (let ((buffer (make-string 6)))
1067 (dotimes (i 6)
1068 (setf (aref buffer i) (read-char stream)))
1069 (parse-integer buffer :radix #x10)))
1070
1071 (defun read-form (string)
1072 (with-standard-io-syntax
1073 (let ((*package* *swank-io-package*))
1074 (read-from-string string))))
1075
1076 (defvar *slime-features* nil
1077 "The feature list that has been sent to Emacs.")
1078
1079 (defun send-to-emacs (object)
1080 "Send OBJECT to Emacs."
1081 (funcall (connection.send *emacs-connection*) object))
1082
1083 (defun send-oob-to-emacs (object)
1084 (send-to-emacs object))
1085
1086 (defun send-to-control-thread (object)
1087 (send (connection.control-thread *emacs-connection*) object))
1088
1089 (defun encode-message (message stream)
1090 (let* ((string (prin1-to-string-for-emacs message))
1091 (length (length string)))
1092 (log-event "WRITE: ~A~%" string)
1093 (let ((*print-pretty* nil))
1094 (format stream "~6,'0x" length))
1095 (write-string string stream)
1096 ;;(terpri stream)
1097 (finish-output stream)))
1098
1099 (defun prin1-to-string-for-emacs (object)
1100 (with-standard-io-syntax
1101 (let ((*print-case* :downcase)
1102 (*print-readably* nil)
1103 (*print-pretty* nil)
1104 (*package* *swank-io-package*))
1105 (prin1-to-string object))))
1106
1107 (defun force-user-output ()
1108 (force-output (connection.user-io *emacs-connection*))
1109 (finish-output (connection.user-output *emacs-connection*)))
1110
1111 (defun clear-user-input ()
1112 (clear-input (connection.user-input *emacs-connection*)))
1113
1114 (defvar *read-input-catch-tag* 0)
1115
1116 (defun intern-catch-tag (tag)
1117 ;; fixnums aren't eq in ABCL, so we use intern to create tags
1118 (intern (format nil "~D" tag) :swank))
1119
1120 (defun read-user-input-from-emacs ()
1121 (let ((tag (incf *read-input-catch-tag*)))
1122 (force-output)
1123 (send-to-emacs `(:read-string ,(current-thread) ,tag))
1124 (let ((ok nil))
1125 (unwind-protect
1126 (prog1 (catch (intern-catch-tag tag)
1127 (loop (read-from-emacs)))
1128 (setq ok t))
1129 (unless ok
1130 (send-to-emacs `(:read-aborted ,(current-thread) ,tag)))))))
1131
1132 (defun y-or-n-p-in-emacs (format-string &rest arguments)
1133 "Like y-or-n-p, but ask in the Emacs minibuffer."
1134 (let ((tag (incf *read-input-catch-tag*))
1135 (question (apply #'format nil format-string arguments)))
1136 (force-output)
1137 (send-to-emacs `(:y-or-n-p ,(current-thread) ,tag ,question))
1138 (catch (intern-catch-tag tag)
1139 (loop (read-from-emacs)))))
1140
1141 (defslimefun take-input (tag input)
1142 "Return the string INPUT to the continuation TAG."
1143 (throw (intern-catch-tag tag) input))
1144
1145 (defun process-form-for-emacs (form)
1146 "Returns a string which emacs will read as equivalent to
1147 FORM. FORM can contain lists, strings, characters, symbols and
1148 numbers.
1149
1150 Characters are converted emacs' ?<char> notaion, strings are left
1151 as they are (except for espacing any nested \" chars, numbers are
1152 printed in base 10 and symbols are printed as their symbol-nome
1153 converted to lower case."
1154 (etypecase form
1155 (string (format nil "~S" form))
1156 (cons (format nil "(~A . ~A)"
1157 (process-form-for-emacs (car form))
1158 (process-form-for-emacs (cdr form))))
1159 (character (format nil "?~C" form))
1160 (symbol (string-downcase (symbol-name form)))
1161 (number (let ((*print-base* 10))
1162 (princ-to-string form)))))
1163
1164 (defun eval-in-emacs (form &optional nowait)
1165 "Eval FORM in Emacs."
1166 (cond (nowait
1167 (send-to-emacs `(:eval-no-wait ,(process-form-for-emacs form))))
1168 (t
1169 (force-output)
1170 (let* ((tag (incf *read-input-catch-tag*))
1171 (value (catch (intern-catch-tag tag)
1172 (send-to-emacs
1173 `(:eval ,(current-thread) ,tag
1174 ,(process-form-for-emacs form)))
1175 (loop (read-from-emacs)))))
1176 (destructure-case value
1177 ((:ok value) value)
1178 ((:abort) (abort)))))))
1179
1180 (defslimefun connection-info ()
1181 "Return a key-value list of the form:
1182 \(&key PID STYLE LISP-IMPLEMENTATION MACHINE FEATURES PACKAGE)
1183 PID: is the process-id of Lisp process (or nil, depending on the STYLE)
1184 STYLE: the communication style
1185 LISP-IMPLEMENTATION: a list (&key TYPE NAME VERSION)
1186 FEATURES: a list of keywords
1187 PACKAGE: a list (&key NAME PROMPT)"
1188 (setq *slime-features* *features*)
1189 `(:pid ,(getpid) :style ,(connection.communication-style *emacs-connection*)
1190 :lisp-implementation (:type ,(lisp-implementation-type)
1191 :name ,(lisp-implementation-type-name)
1192 :version ,(lisp-implementation-version))
1193 :machine (:instance ,(machine-instance)
1194 :type ,(machine-type)
1195 :version ,(machine-version))
1196 :features ,(features-for-emacs)
1197 :package (:name ,(package-name *package*)
1198 :prompt ,(package-string-for-prompt *package*))))
1199
1200 (defslimefun io-speed-test (&optional (n 5000) (m 1))
1201 (let* ((s *standard-output*)
1202 (*trace-output* (make-broadcast-stream s *log-output*)))
1203 (time (progn
1204 (dotimes (i n)
1205 (format s "~D abcdefghijklm~%" i)
1206 (when (zerop (mod n m))
1207 (force-output s)))
1208 (finish-output s)
1209 (when *emacs-connection*
1210 (eval-in-emacs '(message "done.")))))
1211 (terpri *trace-output*)
1212 (finish-output *trace-output*)
1213 nil))
1214
1215
1216 ;;;; Reading and printing
1217
1218 (defmacro define-special (name doc)
1219 "Define a special variable NAME with doc string DOC.
1220 This is like defvar, but NAME will not be initialized."
1221 `(progn
1222 (defvar ,name)
1223 (setf (documentation ',name 'variable) ,doc)))
1224
1225 (define-special *buffer-package*
1226 "Package corresponding to slime-buffer-package.
1227
1228 EVAL-FOR-EMACS binds *buffer-package*. Strings originating from a slime
1229 buffer are best read in this package. See also FROM-STRING and TO-STRING.")
1230
1231 (define-special *buffer-readtable*
1232 "Readtable associated with the current buffer")
1233
1234 (defmacro with-buffer-syntax ((&rest _) &body body)
1235 "Execute BODY with appropriate *package* and *readtable* bindings.
1236
1237 This should be used for code that is conceptionally executed in an
1238 Emacs buffer."
1239 (destructuring-bind () _
1240 `(call-with-buffer-syntax (lambda () ,@body))))
1241
1242 (defun call-with-buffer-syntax (fun)
1243 (let ((*package* *buffer-package*))
1244 ;; Don't shadow *readtable* unnecessarily because that prevents
1245 ;; the user from assigning to it.
1246 (if (eq *readtable* *buffer-readtable*)
1247 (call-with-syntax-hooks fun)
1248 (let ((*readtable* *buffer-readtable*))
1249 (call-with-syntax-hooks fun)))))
1250
1251 (defun to-string (object)
1252 "Write OBJECT in the *BUFFER-PACKAGE*.
1253 The result may not be readable. Handles problems with PRINT-OBJECT methods
1254 gracefully."
1255 (with-buffer-syntax ()
1256 (let ((*print-readably* nil))
1257 (handler-case
1258 (prin1-to-string object)
1259 (error ()
1260 (with-output-to-string (s)
1261 (print-unreadable-object (object s :type t :identity t)
1262 (princ "<<error printing object>>" s))))))))
1263
1264 (defun from-string (string)
1265 "Read string in the *BUFFER-PACKAGE*"
1266 (with-buffer-syntax ()
1267 (let ((*read-suppress* nil))
1268 (read-from-string string))))
1269
1270 ;; FIXME: deal with #\| etc. hard to do portably.
1271 (defun tokenize-symbol (string)
1272 (let ((package (let ((pos (position #\: string)))
1273 (if pos (subseq string 0 pos) nil)))
1274 (symbol (let ((pos (position #\: string :from-end t)))
1275 (if pos (subseq string (1+ pos)) string)))
1276 (internp (search "::" string)))
1277 (values symbol package internp)))
1278
1279 (defun tokenize-symbol-thoroughly (string)
1280 "This version of tokenize-symbol handles escape characters."
1281 (let ((package nil)
1282 (token (make-array (length string) :element-type 'character
1283 :fill-pointer 0))
1284 (backslash nil)
1285 (vertical nil)
1286 (internp nil))
1287 (loop for char across string
1288 do (cond
1289 (backslash
1290 (vector-push-extend char token)
1291 (setq backslash nil))
1292 ((char= char #\\) ; Quotes next character, even within |...|
1293 (setq backslash t))
1294 ((char= char #\|)
1295 (setq vertical t))
1296 (vertical
1297 (vector-push-extend char token))
1298 ((char= char #\:)
1299 (if package
1300 (setq internp t)
1301 (setq package token
1302 token (make-array (length string)
1303 :element-type 'character
1304 :fill-pointer 0))))
1305 (t
1306 (vector-push-extend (casify-char char) token))))
1307 (values token package internp)))
1308
1309 (defun casify-char (char)
1310 "Convert CHAR accoring to readtable-case."
1311 (ecase (readtable-case *readtable*)
1312 (:preserve char)
1313 (:upcase (char-upcase char))
1314 (:downcase (char-downcase char))
1315 (:invert (if (upper-case-p char)
1316 (char-downcase char)
1317 (char-upcase char)))))
1318
1319 (defun parse-symbol (string &optional (package *package*))
1320 "Find the symbol named STRING.
1321 Return the symbol and a flag indicating whether the symbols was found."
1322 (multiple-value-bind (sname pname) (tokenize-symbol-thoroughly string)
1323 (let ((package (cond ((string= pname "") keyword-package)
1324 (pname (find-package pname))
1325 (t package))))
1326 (if package
1327 (find-symbol sname package)
1328 (values nil nil)))))
1329
1330 (defun parse-symbol-or-lose (string &optional (package *package*))
1331 (multiple-value-bind (symbol status) (parse-symbol string package)
1332 (if status
1333 (values symbol status)
1334 (error "Unknown symbol: ~A [in ~A]" string package))))
1335
1336 ;; FIXME: interns the name
1337 (defun parse-package (string)
1338 "Find the package named STRING.
1339 Return the package or nil."
1340 (multiple-value-bind (name pos)
1341 (if (zerop (length string))
1342 (values :|| 0)
1343 (let ((*package* keyword-package))
1344 (ignore-errors (read-from-string string))))
1345 (if (and (or (keywordp name) (stringp name))
1346 (= (length string) pos))
1347 (find-package name))))
1348
1349 (defun guess-package-from-string (name &optional (default-package *package*))
1350 (or (and name
1351 (or (parse-package name)
1352 (find-package (string-upcase name))
1353 (parse-package (substitute #\- #\! name))))
1354 default-package))
1355
1356 (defvar *readtable-alist* (default-readtable-alist)
1357 "An alist mapping package names to readtables.")
1358
1359 (defun guess-buffer-readtable (package-name &optional (default *readtable*))
1360 (let ((package (guess-package-from-string package-name)))
1361 (if package
1362 (or (cdr (assoc (package-name package) *readtable-alist*
1363 :test #'string=))
1364 default)
1365 default)))
1366
1367 (defun valid-operator-symbol-p (symbol)
1368 "Test if SYMBOL names a function, macro, or special-operator."
1369 (or (fboundp symbol)
1370 (macro-function symbol)
1371 (special-operator-p symbol)))
1372
1373 (defun valid-operator-name-p (string)
1374 "Test if STRING names a function, macro, or special-operator."
1375 (let ((symbol (parse-symbol string)))
1376 (valid-operator-symbol-p symbol)))
1377
1378
1379 ;;;; Arglists
1380
1381 (defslimefun arglist-for-echo-area (names &key print-right-margin
1382 print-lines arg-indices)
1383 "Return the arglist for the first function, macro, or special-op in NAMES."
1384 (handler-case
1385 (with-buffer-syntax ()
1386 (let ((which (position-if (lambda (name)
1387 (or (consp name)
1388 (valid-operator-name-p name)))
1389 names)))
1390 (when which
1391 (let ((name (elt names which))
1392 (arg-index (and arg-indices (elt arg-indices which))))
1393 (multiple-value-bind (form operator-name)
1394 (operator-designator-to-form name)
1395 (let ((*print-right-margin* print-right-margin))
1396 (format-arglist-for-echo-area
1397 form operator-name
1398 :print-right-margin print-right-margin
1399 :print-lines print-lines
1400 :highlight (and arg-index
1401 (not (zerop arg-index))
1402 ;; don't highlight the operator
1403 arg-index))))))))
1404 (error (cond)
1405 (format nil "ARGLIST: ~A" cond))))
1406
1407 (defun operator-designator-to-form (name)
1408 (etypecase name
1409 (cons
1410 (destructure-case name
1411 ((:make-instance class-name operator-name)
1412 (let ((parsed-operator-name (parse-symbol operator-name)))
1413 (values `(,parsed-operator-name ',(parse-symbol class-name))
1414 operator-name)))
1415 ((:defmethod generic-name)
1416 (values `(defmethod ,(parse-symbol generic-name))
1417 'defmethod))))
1418 (string
1419 (values `(,(parse-symbol name))
1420 name))))
1421
1422 (defun clean-arglist (arglist)
1423 "Remove &whole, &enviroment, and &aux elements from ARGLIST."
1424 (cond ((null arglist) '())
1425 ((member (car arglist) '(&whole &environment))
1426 (clean-arglist (cddr arglist)))
1427 ((eq (car arglist) '&aux)
1428 '())
1429 (t (cons (car arglist) (clean-arglist (cdr arglist))))))
1430
1431 (defun decoded-arglist-to-string (arglist package
1432 &key operator print-right-margin
1433 print-lines highlight)
1434 "Print the decoded ARGLIST for display in the echo area. The
1435 argument name are printed without package qualifiers and pretty
1436 printing of (function foo) as #'foo is suppressed. If HIGHLIGHT is
1437 non-nil, it must be the index of an argument; highlight this argument.
1438 If OPERATOR is non-nil, put it in front of the arglist."
1439 (with-output-to-string (*standard-output*)
1440 (with-standard-io-syntax
1441 (let ((*package* package) (*print-case* :downcase)
1442 (*print-pretty* t) (*print-circle* nil) (*print-readably* nil)
1443 (*print-level* 10) (*print-length* 20)
1444 (*print-right-margin* print-right-margin)
1445 (*print-lines* print-lines))
1446 (let ((index 0)
1447 (first-arg t))
1448 (labels ((print-arg (arg)
1449 (etypecase arg
1450 (symbol (princ arg))
1451 (string (princ arg))
1452 (cons (pprint-logical-block (nil nil :prefix "(" :suffix ")")
1453 (princ (car arg))
1454 (unless (null (cdr arg))
1455 (write-char #\space))
1456 (pprint-fill *standard-output* (cdr arg) nil)))))
1457 (print-space ()
1458 (unless first-arg
1459 (write-char #\space)
1460 (pprint-newline :fill))
1461 (setf first-arg nil))
1462 (print-with-space (obj)
1463 (print-space)
1464 (print-arg obj))
1465 (print-with-highlight (arg &optional (index-ok-p #'=))
1466 (print-space)
1467 (cond
1468 ((and highlight (funcall index-ok-p index highlight))
1469 (princ "===> ")
1470 (print-arg arg)
1471 (princ " <==="))
1472 (t
1473 (print-arg arg)))
1474 (incf index)))
1475 (pprint-logical-block (nil nil :prefix "(" :suffix ")")
1476 (when operator
1477 (print-with-highlight operator))
1478 (mapc #'print-with-highlight
1479 (arglist.required-args arglist))
1480 (when (arglist.optional-args arglist)
1481 (print-with-space '&optional)
1482 (mapc #'print-with-highlight
1483 (mapcar #'encode-optional-arg
1484 (arglist.optional-args arglist))))
1485 (when (arglist.key-p arglist)
1486 (print-with-space '&key)
1487 (mapc #'print-with-space
1488 (mapcar #'encode-keyword-arg
1489 (arglist.keyword-args arglist))))
1490 (when (arglist.allow-other-keys-p arglist)
1491 (print-with-space '&allow-other-keys))
1492 (cond ((not (arglist.rest arglist)))
1493 ((arglist.body-p arglist)
1494 (print-with-space '&body)
1495 (print-with-highlight (arglist.rest arglist) #'<=))
1496 (t
1497 (print-with-space '&rest)
1498 (print-with-highlight (arglist.rest arglist) #'<=)))
1499 (mapc #'print-with-space
1500 (arglist.unknown-junk arglist)))))))))
1501
1502 (defslimefun variable-desc-for-echo-area (variable-name)
1503 "Return a short description of VARIABLE-NAME, or NIL."
1504 (with-buffer-syntax ()
1505 (let ((sym (parse-symbol variable-name)))
1506 (if (and sym (boundp sym))
1507 (let ((*print-pretty* nil) (*print-level* 4)
1508 (*print-length* 10) (*print-circle* t))
1509 (format nil "~A => ~A" sym (symbol-value sym)))))))
1510
1511 (defstruct (keyword-arg
1512 (:conc-name keyword-arg.)
1513 (:constructor make-keyword-arg (keyword arg-name default-arg)))
1514 keyword
1515 arg-name
1516 default-arg)
1517
1518 (defun decode-keyword-arg (arg)
1519 "Decode a keyword item of formal argument list.
1520 Return three values: keyword, argument name, default arg."
1521 (cond ((symbolp arg)
1522 (make-keyword-arg (intern (symbol-name arg) keyword-package)
1523 arg
1524 nil))
1525 ((and (consp arg)
1526 (consp (car arg)))
1527 (make-keyword-arg (caar arg)
1528 (cadar arg)
1529 (cadr arg)))
1530 ((consp arg)
1531 (make-keyword-arg (intern (symbol-name (car arg)) keyword-package)
1532 (car arg)
1533 (cadr arg)))
1534 (t
1535 (error "Bad keyword item of formal argument list"))))
1536
1537 (defun encode-keyword-arg (arg)
1538 (if (eql (intern (symbol-name (keyword-arg.arg-name arg))
1539 keyword-package)
1540 (keyword-arg.keyword arg))
1541 (if (keyword-arg.default-arg arg)
1542 (list (keyword-arg.arg-name arg)
1543 (keyword-arg.default-arg arg))
1544 (keyword-arg.arg-name arg))
1545 (let ((keyword/name (list (keyword-arg.arg-name arg)
1546 (keyword-arg.keyword arg))))
1547 (if (keyword-arg.default-arg arg)
1548 (list keyword/name
1549 (keyword-arg.default-arg arg))
1550 (list keyword/name)))))
1551
1552 (progn
1553 (assert (equalp (decode-keyword-arg 'x)
1554 (make-keyword-arg :x 'x nil)))
1555 (assert (equalp (decode-keyword-arg '(x t))
1556 (make-keyword-arg :x 'x t)))
1557 (assert (equalp (decode-keyword-arg '((:x y)))
1558 (make-keyword-arg :x 'y nil)))
1559 (assert (equalp (decode-keyword-arg '((:x y) t))
1560 (make-keyword-arg :x 'y t))))
1561
1562 (defstruct (optional-arg
1563 (:conc-name optional-arg.)
1564 (:constructor make-optional-arg (arg-name default-arg)))
1565 arg-name
1566 default-arg)
1567
1568 (defun decode-optional-arg (arg)
1569 "Decode an optional item of a formal argument list.
1570 Return an OPTIONAL-ARG structure."
1571 (etypecase arg
1572 (symbol (make-optional-arg arg nil))
1573 (list (make-optional-arg (car arg) (cadr arg)))))
1574
1575 (defun encode-optional-arg (optional-arg)
1576 (if (optional-arg.default-arg optional-arg)
1577 (list (optional-arg.arg-name optional-arg)
1578 (optional-arg.default-arg optional-arg))
1579 (optional-arg.arg-name optional-arg)))
1580
1581 (progn
1582 (assert (equalp (decode-optional-arg 'x)
1583 (make-optional-arg 'x nil)))
1584 (assert (equalp (decode-optional-arg '(x t))
1585 (make-optional-arg 'x t))))
1586
1587 (defstruct (arglist (:conc-name arglist.))
1588 required-args ; list of the required arguments
1589 optional-args ; list of the optional arguments
1590 key-p ; whether &key appeared
1591 keyword-args ; list of the keywords
1592 rest ; name of the &rest or &body argument (if any)
1593 body-p ; whether the rest argument is a &body
1594 allow-other-keys-p ; whether &allow-other-keys appeared
1595 aux-args ; list of &aux variables
1596 known-junk ; &whole, &environment
1597 unknown-junk) ; unparsed stuff
1598
1599 (define-modify-macro nreversef () nreverse "Reverse the list in PLACE.")
1600
1601 (defun decode-arglist (arglist)
1602 "Parse the list ARGLIST and return an ARGLIST structure."
1603 (let ((mode nil)
1604 (result (make-arglist)))
1605 (dolist (arg arglist)
1606 (cond
1607 ((eql mode '&unknown-junk)
1608 ;; don't leave this mode -- we don't know how the arglist
1609 ;; after unknown lambda-list keywords is interpreted
1610 (push arg (arglist.unknown-junk result)))
1611 ((eql arg '&allow-other-keys)
1612 (setf (arglist.allow-other-keys-p result) t))
1613 ((eql arg '&key)
1614 (setf (arglist.key-p result) t
1615 mode arg))
1616 ((member arg '(&optional &rest &body &aux))
1617 (setq mode arg))
1618 ((member arg '(&whole &environment))
1619 (setq mode arg)
1620 (push arg (arglist.known-junk result)))
1621 ((member arg lambda-list-keywords)
1622 (setq mode '&unknown-junk)
1623 (push arg (arglist.unknown-junk result)))
1624 (t
1625 (ecase mode
1626 (&key
1627 (push (decode-keyword-arg arg)
1628 (arglist.keyword-args result)))
1629 (&optional
1630 (push (decode-optional-arg arg)
1631 (arglist.optional-args result)))
1632 (&body
1633 (setf (arglist.body-p result) t
1634 (arglist.rest result) arg))
1635 (&rest
1636 (setf (arglist.rest result) arg))
1637 (&aux
1638 (push (decode-optional-arg arg)
1639 (arglist.aux-args result)))
1640 ((nil)
1641 (push arg (arglist.required-args result)))
1642 ((&whole &environment)
1643 (setf mode nil)
1644 (push arg (arglist.known-junk result)))))))
1645 (nreversef (arglist.required-args result))
1646 (nreversef (arglist.optional-args result))
1647 (nreversef (arglist.keyword-args result))
1648 (nreversef (arglist.aux-args result))
1649 (nreversef (arglist.known-junk result))
1650 (nreversef (arglist.unknown-junk result))
1651 result))
1652
1653 (defun encode-arglist (decoded-arglist)
1654 (append (arglist.required-args decoded-arglist)
1655 (when (arglist.optional-args decoded-arglist)
1656 '(&optional))
1657 (mapcar #'encode-optional-arg (arglist.optional-args decoded-arglist))
1658 (when (arglist.key-p decoded-arglist)
1659 '(&key))
1660 (mapcar #'encode-keyword-arg (arglist.keyword-args decoded-arglist))
1661 (when (arglist.allow-other-keys-p decoded-arglist)
1662 '(&allow-other-keys))
1663 (cond ((not (arglist.rest decoded-arglist))
1664 '())
1665 ((arglist.body-p decoded-arglist)
1666 `(&body ,(arglist.rest decoded-arglist)))
1667 (t
1668 `(&rest ,(arglist.rest decoded-arglist))))
1669 (when (arglist.aux-args decoded-arglist)
1670 `(&aux ,(arglist.aux-args decoded-arglist)))
1671 (arglist.known-junk decoded-arglist)
1672 (arglist.unknown-junk decoded-arglist)))
1673
1674 (defun arglist-keywords (arglist)
1675 "Return the list of keywords in ARGLIST.
1676 As a secondary value, return whether &allow-other-keys appears."
1677 (let ((decoded-arglist (decode-arglist arglist)))
1678 (values (arglist.keyword-args decoded-arglist)
1679 (arglist.allow-other-keys-p decoded-arglist))))
1680
1681 (defun methods-keywords (methods)
1682 "Collect all keywords in the arglists of METHODS.
1683 As a secondary value, return whether &allow-other-keys appears somewhere."
1684 (let ((keywords '())
1685 (allow-other-keys nil))
1686 (dolist (method methods)
1687 (multiple-value-bind (kw aok)
1688 (arglist-keywords
1689 (swank-mop:method-lambda-list method))
1690 (setq keywords (remove-duplicates (append keywords kw)
1691 :key #'keyword-arg.keyword)
1692 allow-other-keys (or allow-other-keys aok))))
1693 (values keywords allow-other-keys)))
1694
1695 (defun generic-function-keywords (generic-function)
1696 "Collect all keywords in the methods of GENERIC-FUNCTION.
1697 As a secondary value, return whether &allow-other-keys appears somewhere."
1698 (methods-keywords
1699 (swank-mop:generic-function-methods generic-function)))
1700
1701 (defun applicable-methods-keywords (generic-function classes)
1702 "Collect all keywords in the methods of GENERIC-FUNCTION that are
1703 applicable for argument of CLASSES. As a secondary value, return
1704 whether &allow-other-keys appears somewhere."
1705 (methods-keywords
1706 (swank-mop:compute-applicable-methods-using-classes
1707 generic-function classes)))
1708
1709 (defun decoded-arglist-to-template-string (decoded-arglist package &key (prefix "(") (suffix ")"))
1710 (with-output-to-string (*standard-output*)
1711 (with-standard-io-syntax
1712 (let ((*package* package) (*print-case* :downcase)
1713 (*print-pretty* t) (*print-circle* nil) (*print-readably* nil)
1714 (*print-level* 10) (*print-length* 20))
1715 (pprint-logical-block (nil nil :prefix prefix :suffix suffix)
1716 (print-decoded-arglist-as-template decoded-arglist))))))
1717
1718 (defun print-decoded-arglist-as-template (decoded-arglist)
1719 (let ((first-p t))
1720 (flet ((space ()
1721 (unless first-p
1722 (write-char #\space)
1723 (pprint-newline :fill))
1724 (setq first-p nil)))
1725 (dolist (arg (arglist.required-args decoded-arglist))
1726 (space)
1727 (princ arg))
1728 (dolist (arg (arglist.optional-args decoded-arglist))
1729 (space)
1730 (format t "[~A]" (optional-arg.arg-name arg)))
1731 (dolist (keyword-arg (arglist.keyword-args decoded-arglist))
1732 (space)
1733 (let ((arg-name (keyword-arg.arg-name keyword-arg))
1734 (keyword (keyword-arg.keyword keyword-arg)))
1735 (format t "~W ~A"
1736 (if (keywordp keyword) keyword `',keyword)
1737 arg-name)))
1738 (when (and (arglist.rest decoded-arglist)
1739 (or (not (arglist.keyword-args decoded-arglist))
1740 (arglist.allow-other-keys-p decoded-arglist)))
1741 (if (arglist.body-p decoded-arglist)
1742 (pprint-newline :mandatory)
1743 (space))
1744 (format t "~A..." (arglist.rest decoded-arglist)))))
1745 (pprint-newline :fill))
1746
1747 (defgeneric extra-keywords (operator &rest args)
1748 (:documentation "Return a list of extra keywords of OPERATOR (a
1749 symbol) when applied to the (unevaluated) ARGS.
1750 As a secondary value, return whether other keys are allowed.
1751 As a tertiary value, return the initial sublist of ARGS that was needed
1752 to determine the extra keywords."))
1753
1754 (defmethod extra-keywords (operator &rest args)
1755 ;; default method
1756 (declare (ignore args))
1757 (let ((symbol-function (symbol-function operator)))
1758 (if (typep symbol-function 'generic-function)
1759 (generic-function-keywords symbol-function)
1760 nil)))
1761
1762 (defun extra-keywords/make-instance (operator &rest args)
1763 (declare (ignore operator))
1764 (unless (null args)
1765 (let ((class-name-form (car args)))
1766 (when (and (listp class-name-form)
1767 (= (length class-name-form) 2)
1768 (eq (car class-name-form) 'quote))
1769 (let* ((class-name (cadr class-name-form))
1770 (class (find-class class-name nil)))
1771 (when (and class
1772 (not (swank-mop:class-finalized-p class)))
1773 ;; Try to finalize the class, which can fail if
1774 ;; superclasses are not defined yet
1775 (handler-case (swank-mop:finalize-inheritance class)
1776 (program-error (c)
1777 (declare (ignore c)))))
1778 (when class
1779 ;; We have the case (make-instance 'CLASS ...)
1780 ;; with a known CLASS.
1781 (multiple-value-bind (slots allow-other-keys-p)
1782 (if (swank-mop:class-finalized-p class)
1783 (values (swank-mop:class-slots class) nil)
1784 (values (swank-mop:class-direct-slots class) t))
1785 (let ((slot-init-keywords
1786 (loop for slot in slots append
1787 (mapcar (lambda (initarg)
1788 (make-keyword-arg
1789 initarg
1790 initarg ; FIXME
1791 (swank-mop:slot-definition-initform slot)))
1792 (swank-mop:slot-definition-initargs slot))))
1793 (initialize-instance-keywords
1794 (applicable-methods-keywords #'initialize-instance
1795 (list class))))
1796 (return-from extra-keywords/make-instance
1797 (values (append slot-init-keywords
1798 initialize-instance-keywords)
1799 allow-other-keys-p
1800 (list class-name-form)))))))))))
1801
1802 (defmacro multiple-value-or (&rest forms)
1803 (if (null forms)
1804 nil
1805 (let ((first (first forms))
1806 (rest (rest forms)))
1807 `(let* ((values (multiple-value-list ,first))
1808 (primary-value (first values)))
1809 (if primary-value
1810 (values-list values)
1811 (multiple-value-or ,@rest))))))
1812
1813 (defmethod extra-keywords ((operator (eql 'make-instance))
1814 &rest args)
1815 (multiple-value-or (apply #'extra-keywords/make-instance operator args)
1816 (call-next-method)))
1817
1818 (defmethod extra-keywords ((operator (eql 'make-condition))
1819 &rest args)
1820 (multiple-value-or (apply #'extra-keywords/make-instance operator args)
1821 (call-next-method)))
1822
1823 (defmethod extra-keywords ((operator (eql 'error))
1824 &rest args)
1825 (multiple-value-or (apply #'extra-keywords/make-instance operator args)
1826 (call-next-method)))
1827
1828 (defmethod extra-keywords ((operator (eql 'signal))
1829 &rest args)
1830 (multiple-value-or (apply #'extra-keywords/make-instance operator args)
1831 (call-next-method)))
1832
1833 (defmethod extra-keywords ((operator (eql 'warn))
1834 &rest args)
1835 (multiple-value-or (apply #'extra-keywords/make-instance operator args)
1836 (call-next-method)))
1837
1838 (defmethod extra-keywords ((operator (eql 'cerror))
1839 &rest args)
1840 (multiple-value-or (apply #'extra-keywords/make-instance operator
1841 (cdr args))
1842 (call-next-method)))
1843
1844 (defun enrich-decoded-arglist-with-extra-keywords (decoded-arglist form)
1845 "Determine extra keywords from the function call FORM, and modify
1846 DECODED-ARGLIST to include them. As a secondary return value, return
1847 the initial sublist of ARGS that was needed to determine the extra
1848 keywords. As a tertiary return value, return whether any enrichment
1849 was done."
1850 (multiple-value-bind (extra-keywords extra-aok determining-args)
1851 (apply #'extra-keywords form)
1852 ;; enrich the list of keywords with the extra keywords
1853 (when extra-keywords
1854 (setf (arglist.key-p decoded-arglist) t)
1855 (setf (arglist.keyword-args decoded-arglist)
1856 (remove-duplicates
1857 (append (arglist.keyword-args decoded-arglist)
1858 extra-keywords)
1859 :key #'keyword-arg.keyword)))
1860 (setf (arglist.allow-other-keys-p decoded-arglist)
1861 (or (arglist.allow-other-keys-p decoded-arglist) extra-aok))
1862 (values decoded-arglist
1863 determining-args
1864 (or extra-keywords extra-aok))))
1865
1866 (defslimefun arglist-for-insertion (name)
1867 (with-buffer-syntax ()
1868 (let ((symbol (parse-symbol name)))
1869 (cond
1870 ((and symbol
1871 (valid-operator-name-p name))
1872 (let ((arglist (arglist symbol)))
1873 (etypecase arglist
1874 ((member :not-available)
1875 :not-available)
1876 (list
1877 (let ((decoded-arglist (decode-arglist arglist)))
1878 (enrich-decoded-arglist-with-extra-keywords decoded-arglist
1879 (list symbol))
1880 (decoded-arglist-to-template-string decoded-arglist
1881 *buffer-package*))))))
1882 (t
1883 :not-available)))))
1884
1885 (defvar *remove-keywords-alist*
1886 '((:test :test-not)
1887 (:test-not :test)))
1888
1889 (defun remove-actual-args (decoded-arglist actual-arglist)
1890 "Remove from DECODED-ARGLIST the arguments that have already been
1891 provided in ACTUAL-ARGLIST."
1892 (loop while (and actual-arglist
1893 (arglist.required-args decoded-arglist))
1894 do (progn (pop actual-arglist)
1895 (pop (arglist.required-args decoded-arglist))))
1896 (loop while (and actual-arglist
1897 (arglist.optional-args decoded-arglist))
1898 do (progn (pop actual-arglist)
1899 (pop (arglist.optional-args decoded-arglist))))
1900 (loop for keyword in actual-arglist by #'cddr
1901 for keywords-to-remove = (cdr (assoc keyword *remove-keywords-alist*))
1902 do (setf (arglist.keyword-args decoded-arglist)
1903 (remove-if (lambda (kw)
1904 (or (eql kw keyword)
1905 (member kw keywords-to-remove)))
1906 (arglist.keyword-args decoded-arglist)
1907 :key #'keyword-arg.keyword))))
1908
1909 (defgeneric form-completion (operator-form argument-forms &key remove-args))
1910
1911 (defmethod form-completion (operator-form argument-forms &key (remove-args t))
1912 (when (and (symbolp operator-form)
1913 (valid-operator-symbol-p operator-form))
1914 (let ((arglist (arglist operator-form)))
1915 (etypecase arglist
1916 ((member :not-available)
1917 :not-available)
1918 (list
1919 (let ((decoded-arglist (decode-arglist arglist)))
1920 (multiple-value-bind (decoded-arglist determining-args any-enrichment)
1921 (enrich-decoded-arglist-with-extra-keywords decoded-arglist
1922 (cons operator-form
1923 argument-forms))
1924 (cond
1925 (remove-args
1926 ;; get rid of formal args already provided
1927 (remove-actual-args decoded-arglist argument-forms))
1928 (t
1929 ;; replace some formal args by determining actual args
1930 (remove-actual-args decoded-arglist determining-args)
1931 (setf (arglist.required-args decoded-arglist)
1932 (append determining-args
1933 (arglist.required-args decoded-arglist)))))
1934 (return-from form-completion
1935 (values decoded-arglist any-enrichment))))))))
1936 :not-available)
1937
1938 (defmethod form-completion ((operator-form (eql 'defmethod))
1939 argument-forms &key (remove-args t))
1940 (when (and (listp argument-forms)
1941 (not (null argument-forms)) ;have generic function name
1942 (notany #'listp (rest argument-forms))) ;don't have arglist yet
1943 (let* ((gf-name (first argument-forms))
1944 (gf (and (or (symbolp gf-name)
1945 (and (listp gf-name)
1946 (eql (first gf-name) 'setf)))
1947 (fboundp gf-name)
1948 (fdefinition gf-name))))
1949 (when (typep gf 'generic-function)
1950 (let ((arglist (arglist gf)))
1951 (etypecase arglist
1952 ((member :not-available))
1953 (list
1954 (return-from form-completion
1955 (values (make-arglist :required-args (if remove-args
1956 (list arglist)
1957 (list gf-name arglist))
1958 :rest "body" :body-p t)
1959 t))))))))
1960 (call-next-method))
1961
1962 (defun read-incomplete-form-from-string (form-string)
1963 (with-buffer-syntax ()
1964 (handler-case
1965 (read-from-string form-string)
1966 (reader-error (c)
1967 (declare (ignore c))
1968 nil)
1969 (stream-error (c)
1970 (declare (ignore c))
1971 nil))))
1972
1973 (defslimefun complete-form (form-string)
1974 "Read FORM-STRING in the current buffer package, then complete it
1975 by adding a template for the missing arguments."
1976 (let ((form (read-incomplete-form-from-string form-string)))
1977 (when (consp form)
1978 (let ((operator-form (first form))
1979 (argument-forms (rest form)))
1980 (let ((form-completion
1981 (form-completion operator-form argument-forms)))
1982 (unless (eql form-completion :not-available)
1983 (return-from complete-form
1984 (decoded-arglist-to-template-string form-completion
1985 *buffer-package*
1986 :prefix ""))))))
1987 :not-available))
1988
1989 (defun format-arglist-for-echo-area (form operator-name
1990 &key print-right-margin print-lines
1991 highlight)
1992 "Return the arglist for FORM as a string."
1993 (when (consp form)
1994 (let ((operator-form (first form))
1995 (argument-forms (rest form)))
1996 (let ((form-completion
1997 (form-completion operator-form argument-forms
1998 :remove-args nil)))
1999 (unless (eql form-completion :not-available)
2000 (return-from format-arglist-for-echo-area
2001 (decoded-arglist-to-string
2002 form-completion
2003 *package*
2004 :operator operator-name
2005 :print-right-margin print-right-margin
2006 :print-lines print-lines
2007 :highlight highlight))))))
2008 nil)
2009
2010 (defslimefun completions-for-keyword (name keyword-string)
2011 (with-buffer-syntax ()
2012 (let* ((form (operator-designator-to-form name))
2013 (operator-form (first form))
2014 (argument-forms (rest form))
2015 (arglist
2016 (form-completion operator-form argument-forms
2017 :remove-args nil)))
2018 (unless (eql arglist :not-available)
2019 (let* ((keywords
2020 (mapcar #'keyword-arg.keyword
2021 (arglist.keyword-args arglist)))
2022 (keyword-name
2023 (tokenize-symbol keyword-string))
2024 (matching-keywords
2025 (find-matching-symbols-in-list keyword-name keywords
2026 #'compound-prefix-match))
2027 (converter (output-case-converter keyword-string))
2028 (strings
2029 (mapcar converter
2030 (mapcar #'symbol-name matching-keywords)))
2031 (completion-set
2032 (format-completion-set strings nil "")))
2033 (list completion-set
2034 (longest-completion completion-set)))))))
2035
2036
2037 (defun arglist-to-string (arglist package &key print-right-margin highlight)
2038 (decoded-arglist-to-string (decode-arglist arglist)
2039 package
2040 :print-right-margin print-right-margin
2041 :highlight highlight))
2042
2043 (defun test-print-arglist (list string)
2044 (string= (arglist-to-string list (find-package :swank)) string))
2045
2046 ;; Should work:
2047 (progn
2048 (assert (test-print-arglist '(function cons) "(function cons)"))
2049 (assert (test-print-arglist '(quote cons) "(quote cons)"))
2050 (assert (test-print-arglist '(&key (function #'+)) "(&key (function #'+))"))
2051 (assert (test-print-arglist '(&whole x y z) "(y z)"))
2052 (assert (test-print-arglist '(x &aux y z) "(x)"))
2053 (assert (test-print-arglist '(x &environment env y) "(x y)")))
2054 ;; Expected failure:
2055 ;; (assert (test-print-arglist '(&key ((function f))) "(&key ((function f)))"))
2056
2057
2058 ;;;; Recording and accessing results of computations
2059
2060 (defvar *record-repl-results* t
2061 "Non-nil means that REPL results are saved for later lookup.")
2062
2063 (defvar *object-to-presentation-id*
2064 (make-weak-key-hash-table :test 'eq)
2065 "Store the mapping of objects to numeric identifiers")
2066
2067 (defvar *presentation-id-to-object*
2068 (make-weak-value-hash-table :test 'eql)
2069 "Store the mapping of numeric identifiers to objects")
2070
2071 (defun clear-presentation-tables ()
2072 (clrhash *object-to-presentation-id*)
2073 (clrhash *presentation-id-to-object*))
2074
2075 (defvar *presentation-counter* 0 "identifier counter")
2076
2077 ;; XXX thread safety?
2078 (defun save-presented-object (object)
2079 "Save OBJECT and return the assigned id.
2080 If OBJECT was saved previously return the old id."
2081 (or (gethash object *object-to-presentation-id*)
2082 (let ((id (incf *presentation-counter*)))
2083 (setf (gethash id *presentation-id-to-object*) object)
2084 (setf (gethash object *object-to-presentation-id*) id)
2085 id)))
2086
2087 (defun lookup-presented-object (id)
2088 "Retrieve the object corresponding to ID.
2089 The secondary value indicates the absence of an entry."
2090 (gethash id *presentation-id-to-object*))
2091
2092 (defslimefun get-repl-result (id)
2093 "Get the result of the previous REPL evaluation with ID."
2094 (multiple-value-bind (object foundp) (lookup-presented-object id)
2095 (cond (foundp object)
2096 (t (error "Attempt to access unrecorded object (id ~D)." id)))))
2097
2098 (defslimefun clear-repl-results ()
2099 "Forget the results of all previous REPL evaluations."
2100 (clear-presentation-tables)
2101 t)
2102
2103
2104 ;;;; Evaluation
2105
2106 (defvar *pending-continuations* '()
2107 "List of continuations for Emacs. (thread local)")
2108
2109 (defun guess-buffer-package (string)
2110 "Return a package for STRING.
2111 Fall back to the the current if no such package exists."
2112 (or (guess-package-from-string string nil)
2113 *package*))
2114
2115 (defun eval-for-emacs (form buffer-package id)
2116 "Bind *BUFFER-PACKAGE* BUFFER-PACKAGE and evaluate FORM.
2117 Return the result to the continuation ID.
2118 Errors are trapped and invoke our debugger."
2119 (call-with-debugger-hook
2120 #'swank-debugger-hook
2121 (lambda ()
2122 (let (ok result)
2123 (unwind-protect
2124 (let ((*buffer-package* (guess-buffer-package buffer-package))
2125 (*buffer-readtable* (guess-buffer-readtable buffer-package))
2126 (*pending-continuations* (cons id *pending-continuations*)))
2127 (check-type *buffer-package* package)
2128 (check-type *buffer-readtable* readtable)
2129 ;; APPLY would be cleaner than EVAL.
2130 ;;(setq result (apply (car form) (cdr form)))
2131 (setq result (eval form))
2132 (finish-output)
2133 (run-hook *pre-reply-hook*)
2134 (setq ok t))
2135 (force-user-output)
2136 (send-to-emacs `(:return ,(current-thread)
2137 ,(if ok `(:ok ,result) '(:abort))
2138 ,id)))))))
2139
2140 (defvar *echo-area-prefix* "=> "
2141 "A prefix that `format-values-for-echo-area' should use.")
2142
2143 (defun format-values-for-echo-area (values)
2144 (with-buffer-syntax ()
2145 (let ((*print-readably* nil))
2146 (cond ((null values) "; No value")
2147 ((and (null (cdr values)) (integerp (car values)))
2148 (let ((i (car values)))
2149 (format nil "~A~D (#x~X, #o~O, #b~B)"
2150 *echo-area-prefix* i i i i)))
2151 (t (format nil "~A~{~S~^, ~}" *echo-area-prefix* values))))))
2152
2153 (defslimefun interactive-eval (string)
2154 (with-buffer-syntax ()
2155 (let ((values (multiple-value-list (eval (from-string string)))))
2156 (fresh-line)
2157 (finish-output)
2158 (format-values-for-echo-area values))))
2159
2160 (defslimefun eval-and-grab-output (string)
2161 (with-buffer-syntax ()
2162 (let* ((s (make-string-output-stream))
2163 (*standard-output* s)
2164 (values (multiple-value-list (eval (from-string string)))))
2165 (list (get-output-stream-string s)
2166 (format nil "~{~S~^~%~}" values)))))
2167
2168 ;;; XXX do we need this stuff? What is it good for?
2169 (defvar *slime-repl-advance-history* nil
2170 "In the dynamic scope of a single form typed at the repl, is set to nil to
2171 prevent the repl from advancing the history - * ** *** etc.")
2172
2173 (defvar *slime-repl-suppress-output* nil
2174 "In the dynamic scope of a single form typed at the repl, is set to nil to
2175 prevent the repl from printing the result of the evalation.")
2176
2177 (defvar *slime-repl-eval-hook-pass* (gensym "PASS")
2178 "Token to indicate that a repl hook declines to evaluate the form")
2179
2180 (defvar *slime-repl-eval-hooks* nil
2181 "A list of functions. When the repl is about to eval a form, first try running each of
2182 these hooks. The first hook which returns a value which is not *slime-repl-eval-hook-pass*
2183 is considered a replacement for calling eval. If there are no hooks, or all
2184 pass, then eval is used.")
2185
2186 (defslimefun repl-eval-hook-pass ()
2187 "call when repl hook declines to evaluate the form"
2188 (throw *slime-repl-eval-hook-pass* *slime-repl-eval-hook-pass*))
2189
2190 (defslimefun repl-suppress-output ()
2191 "In the dynamic scope of a single form typed at the repl, call to
2192 prevent the repl from printing the result of the evalation."
2193 (setq *slime-repl-suppress-output* t))
2194
2195 (defslimefun repl-suppress-advance-history ()
2196 "In the dynamic scope of a single form typed at the repl, call to
2197 prevent the repl from advancing the history - * ** *** etc."
2198 (setq *slime-repl-advance-history* nil))
2199
2200 (defun eval-region (string &optional package-update-p)
2201 "Evaluate STRING and return the result.
2202 If PACKAGE-UPDATE-P is non-nil, and evaluation causes a package
2203 change, then send Emacs an update."
2204 (unwind-protect
2205 (with-input-from-string (stream string)
2206 (let (- values)
2207 (loop
2208 (let ((form (read stream nil stream)))
2209 (when (eq form stream)
2210 (fresh-line)
2211 (finish-output)
2212 (return (values values -)))
2213 (setq - form)
2214 (if *slime-repl-eval-hooks*
2215 (setq values (run-repl-eval-hooks form))
2216 (setq values (multiple-value-list (eval form))))
2217 (finish-output)))))
2218 (when (and package-update-p (not (eq *package* *buffer-package*)))
2219 (send-to-emacs
2220 (list :new-package (package-name *package*)
2221 (package-string-for-prompt *package*))))))
2222
2223 (defun run-repl-eval-hooks (form)
2224 (loop for hook in *slime-repl-eval-hooks*
2225 for res = (catch *slime-repl-eval-hook-pass*
2226 (multiple-value-list (funcall hook form)))
2227 until (not (eq res *slime-repl-eval-hook-pass*))
2228 finally (return
2229 (if (eq res *slime-repl-eval-hook-pass*)
2230 (multiple-value-list (eval form))
2231 res))))
2232
2233 (defun package-string-for-prompt (package)
2234 "Return the shortest nickname (or canonical name) of PACKAGE."
2235 (princ-to-string
2236 (make-symbol
2237 (or (canonical-package-nickname package)
2238 (auto-abbreviated-package-name package)
2239 (shortest-package-nickname package)))))
2240
2241 (defun canonical-package-nickname (package)
2242 "Return the canonical package nickname, if any, of PACKAGE."
2243 (let ((name (cdr (assoc (package-name package) *canonical-package-nicknames*
2244 :test #'string=))))
2245 (and name (string name))))
2246
2247 (defun auto-abbreviated-package-name (package)
2248 "Return an abbreviated 'name' for PACKAGE.
2249
2250 N.B. this is not an actual package name or nickname."
2251 (when *auto-abbreviate-dotted-packages*
2252 (let ((last-dot (position #\. (package-name package) :from-end t)))
2253 (when last-dot (subseq (package-name package) (1+ last-dot))))))
2254
2255 (defun shortest-package-nickname (package)
2256 "Return the shortest nickname (or canonical name) of PACKAGE."
2257 (loop for name in (cons (package-name package) (package-nicknames package))
2258 for shortest = name then (if (< (length name) (length shortest))
2259 name
2260 shortest)
2261 finally (return shortest)))
2262
2263 (defslimefun interactive-eval-region (string)
2264 (with-buffer-syntax ()
2265 (format-values-for-echo-area (eval-region string))))
2266
2267 (defslimefun re-evaluate-defvar (form)
2268 (with-buffer-syntax ()
2269 (let ((form (read-from-string form)))
2270 (destructuring-bind (dv name &optional value doc) form
2271 (declare (ignore value doc))
2272 (assert (eq dv 'defvar))
2273 (makunbound name)
2274 (prin1-to-string (eval form))))))
2275
2276 (defvar *swank-pprint-bindings*
2277 `((*print-pretty* . t)
2278 (*print-level* . nil)
2279 (*print-length* . nil)
2280 (*print-circle* . t)
2281 (*print-gensym* . t)
2282 (*print-readably* . nil))
2283 "A list of variables bindings during pretty printing.
2284 Used by pprint-eval.")
2285
2286 (defun swank-pprint (list)
2287 "Bind some printer variables and pretty print each object in LIST."
2288 (with-buffer-syntax ()
2289 (with-bindings *swank-pprint-bindings*
2290 (cond ((null list) "; No value")
2291 (t (with-output-to-string (*standard-output*)
2292 (dolist (o list)
2293 (pprint o)
2294 (terpri))))))))
2295
2296 (defslimefun pprint-eval (string)
2297 (with-buffer-syntax ()
2298 (swank-pprint (multiple-value-list (eval (read-from-string string))))))
2299
2300 (defslimefun set-package (package)
2301 "Set *package* to PACKAGE.
2302 Return its name and the string to use in the prompt."
2303 (let ((p (setq *package* (guess-package-from-string package))))
2304 (list (package-name p) (package-string-for-prompt p))))
2305
2306 (defslimefun listener-eval (string)
2307 (clear-user-input)
2308 (with-buffer-syntax ()
2309 (let ((*slime-repl-suppress-output* :unset)
2310 (*slime-repl-advance-history* :unset))
2311 (multiple-value-bind (values last-form) (eval-region string t)
2312 (unless (or (and (eq values nil) (eq last-form nil))
2313 (eq *slime-repl-advance-history* nil))
2314 (setq *** ** ** * * (car values)
2315 /// // // / / values))
2316 (setq +++ ++ ++ + + last-form)
2317 (cond ((eq *slime-repl-suppress-output* t) '(:suppress-output))
2318 (*record-repl-results*
2319 `(:present ,(loop for x in values
2320 collect (cons (prin1-to-string x)
2321 (save-presented-object x)))))
2322 (t
2323 `(:values ,(mapcar #'prin1-to-string values))))))))
2324
2325 (defslimefun ed-in-emacs (&optional what)
2326 "Edit WHAT in Emacs.
2327
2328 WHAT can be:
2329 A pathname or a string,
2330 A list (PATHNAME-OR-STRING LINE [COLUMN]),
2331 A function name (symbol or cons),
2332 NIL.
2333
2334 Returns true if it actually called emacs, or NIL if not."
2335 (flet ((pathname-or-string-p (thing)
2336 (or (pathnamep thing) (typep thing 'string))))
2337 (let ((target
2338 (cond ((and (listp what) (pathname-or-string-p (first what)))
2339 (cons (canonicalize-filename (car what)) (cdr what)))
2340 ((pathname-or-string-p what)
2341 (canonicalize-filename what))
2342 ((symbolp what) what)
2343 ((consp what) what)
2344 (t (return-from ed-in-emacs nil)))))
2345 (cond
2346 (*emacs-connection* (send-oob-to-emacs `(:ed ,target)))
2347 ((default-connection)
2348 (with-connection ((default-connection))
2349 (send-oob-to-emacs `(:ed ,target))))
2350 (t nil)))))
2351
2352 (defslimefun value-for-editing (form)
2353 "Return a readable value of FORM for editing in Emacs.
2354 FORM is expected, but not required, to be SETF'able."
2355 ;; FIXME: Can we check FORM for setfability? -luke (12/Mar/2005)
2356 (with-buffer-syntax ()
2357 (prin1-to-string (eval (read-from-string form)))))
2358
2359 (defslimefun commit-edited-value (form value)
2360 "Set the value of a setf'able FORM to VALUE.
2361 FORM and VALUE are both strings from Emacs."
2362 (with-buffer-syntax ()
2363 (eval `(setf ,(read-from-string form)
2364 ,(read-from-string (concatenate 'string "`" value))))
2365 t))
2366
2367 (defun background-message (format-string &rest args)
2368 "Display a message in Emacs' echo area.
2369
2370 Use this function for informative messages only. The message may even
2371 be dropped, if we are too busy with other things."
2372 (when *emacs-connection*
2373 (send-to-emacs `(:background-message
2374 ,(apply #'format nil format-string args)))))
2375
2376
2377 ;;;; Debugger
2378
2379 (defun swank-debugger-hook (condition hook)
2380 "Debugger function for binding *DEBUGGER-HOOK*.
2381 Sends a message to Emacs declaring that the debugger has been entered,
2382 then waits to handle further requests from Emacs. Eventually returns
2383 after Emacs causes a restart to be invoked."
2384 (declare (ignore hook))
2385 (cond (*emacs-connection*
2386 (debug-in-emacs condition))
2387 ((default-connection)
2388 (with-connection ((default-connection))
2389 (debug-in-emacs condition)))))
2390
2391 (defvar *global-debugger* t
2392 "Non-nil means the Swank debugger hook will be installed globally.")
2393
2394 (add-hook *new-connection-hook* 'install-debugger)
2395 (defun install-debugger (connection)
2396 (declare (ignore connection))
2397 (when *global-debugger*
2398 (install-debugger-globally #'swank-debugger-hook)))
2399
2400 ;;;;; Debugger loop
2401 ;;;
2402 ;;; These variables are dynamically bound during debugging.
2403 ;;;
2404 (defvar *swank-debugger-condition* nil
2405 "The condition being debugged.")
2406
2407 (defvar *sldb-level* 0
2408 "The current level of recursive debugging.")
2409
2410 (defvar *sldb-initial-frames* 20
2411 "The initial number of backtrace frames to send to Emacs.")
2412
2413 (defvar *sldb-restarts* nil
2414 "The list of currenlty active restarts.")
2415
2416 (defvar *sldb-stepping-p* nil
2417 "True when during execution of a stepp command.")
2418
2419 (defun debug-in-emacs (condition)
2420 (let ((*swank-debugger-condition* condition)
2421 (*sldb-restarts* (compute-restarts condition))
2422 (*package* (or (and (boundp '*buffer-package*)
2423 (symbol-value '*buffer-package*))
2424 *package*))
2425 (*sldb-level* (1+ *sldb-level*))
2426 (*sldb-stepping-p* nil)
2427 (*swank-state-stack* (cons :swank-debugger-hook *swank-state-stack*)))
2428 (force-user-output)
2429 (with-bindings *sldb-printer-bindings*
2430 (call-with-debugging-environment
2431 (lambda () (sldb-loop *sldb-level*))))))
2432
2433 (defun sldb-loop (level)
2434 (unwind-protect
2435 (catch 'sldb-enter-default-debugger
2436 (send-to-emacs
2437 (list* :debug (current-thread) level
2438 (debugger-info-for-emacs 0 *sldb-initial-frames*)))
2439 (loop (catch 'sldb-loop-catcher
2440 (with-simple-restart (abort "Return to sldb level ~D." level)
2441 (send-to-emacs (list :debug-activate (current-thread)
2442 level))
2443 (handler-bind ((sldb-condition #'handle-sldb-condition))
2444 (read-from-emacs))))))
2445 (send-to-emacs `(:debug-return
2446 ,(current-thread) ,level ,*sldb-stepping-p*))))
2447
2448 (defun handle-sldb-condition (condition)
2449 "Handle an internal debugger condition.
2450 Rather than recursively debug the debugger (a dangerous idea!), these
2451 conditions are simply reported."
2452 (let ((real-condition (original-condition condition)))
2453 (send-to-emacs `(:debug-condition ,(current-thread)
2454 ,(princ-to-string real-condition))))
2455 (throw 'sldb-loop-catcher nil))
2456
2457 (defun safe-condition-message (condition)
2458 "Safely print condition to a string, handling any errors during
2459 printing."
2460 (let ((*print-pretty* t))
2461 (handler-case
2462 (format-sldb-condition condition)
2463 (error (cond)
2464 ;; Beware of recursive errors in printing, so only use the condition
2465 ;; if it is printable itself:
2466 (format nil "Unable to display error condition~@[: ~A~]"
2467 (ignore-errors (princ-to-string cond)))))))
2468
2469 (defun debugger-condition-for-emacs ()
2470 (list (safe-condition-message *swank-debugger-condition*)
2471 (format nil " [Condition of type ~S]"
2472 (type-of *swank-debugger-condition*))
2473 (condition-references *swank-debugger-condition*)
2474 (condition-extras *swank-debugger-condition*)))
2475
2476 (defun format-restarts-for-emacs ()
2477 "Return a list of restarts for *swank-debugger-condition* in a
2478 format suitable for Emacs."
2479 (loop for restart in *sldb-restarts*
2480 collect (list (princ-to-string (restart-name restart))
2481 (princ-to-string restart))))
2482
2483 (defun frame-for-emacs (n frame)
2484 (let* ((label (format nil " ~2D: " n))
2485 (string (with-output-to-string (stream)
2486 (princ label stream)
2487 (print-frame frame stream))))
2488 (subseq string (length label))))
2489
2490 ;;;;; SLDB entry points
2491
2492 (defslimefun sldb-break-with-default-debugger ()
2493 "Invoke the default debugger by returning from our debugger-loop."
2494 (throw 'sldb-enter-default-debugger nil))
2495
2496 (defslimefun backtrace (start end)
2497 "Return a list ((I FRAME) ...) of frames from START to END.
2498 I is an integer describing and FRAME a string."
2499 (loop for frame in (compute-backtrace start end)
2500 for i from start
2501 collect (list i (frame-for-emacs i frame))))
2502
2503 (defslimefun debugger-info-for-emacs (start end)
2504 "Return debugger state, with stack frames from START to END.
2505 The result is a list:
2506 (condition ({restart}*) ({stack-frame}*) (cont*))
2507 where
2508 condition ::= (description type [extra])
2509 restart ::= (name description)
2510 stack-frame ::= (number description)
2511 extra ::= (:references and other random things)
2512 cont ::= continutation
2513 condition---a pair of strings: message, and type. If show-source is
2514 not nil it is a frame number for which the source should be displayed.
2515
2516 restart---a pair of strings: restart name, and description.
2517
2518 stack-frame---a number from zero (the top), and a printed
2519 representation of the frame's call.
2520
2521 continutation---the id of a pending Emacs continuation.
2522
2523 Below is an example return value. In this case the condition was a
2524 division by zero (multi-line description), and only one frame is being
2525 fetched (start=0, end=1).
2526
2527 ((\"Arithmetic error DIVISION-BY-ZERO signalled.
2528 Operation was KERNEL::DIVISION, operands (1 0).\"
2529 \"[Condition of type DIVISION-BY-ZERO]\")
2530 ((\"ABORT\" \"Return to Slime toplevel.\")
2531 (\"ABORT\" \"Return to Top-Level.\"))
2532 ((0 \"(KERNEL::INTEGER-/-INTEGER 1 0)\"))
2533 (4))"
2534 (list (debugger-condition-for-emacs)
2535 (format-restarts-for-emacs)
2536 (backtrace start end)
2537 *pending-continuations*))
2538
2539 (defun nth-restart (index)
2540 (nth index *sldb-restarts*))
2541
2542 (defslimefun invoke-nth-restart (index)
2543 (invoke-restart-interactively (nth-restart index)))
2544
2545 (defslimefun sldb-abort ()
2546 (invoke-restart (find 'abort *sldb-restarts* :key #'restart-name)))
2547
2548 (defslimefun sldb-continue ()
2549 (continue))
2550
2551 (defslimefun throw-to-toplevel ()
2552 "Invoke the ABORT-REQUEST restart abort an RPC from Emacs.
2553 If we are not evaluating an RPC then ABORT instead."
2554 (let ((restart (find-restart 'abort-request)))
2555 (cond (restart (invoke-restart restart))
2556 (t "Restart not found: ABORT-REQUEST"))))
2557
2558 (defslimefun invoke-nth-restart-for-emacs (sldb-level n)
2559 "Invoke the Nth available restart.
2560 SLDB-LEVEL is the debug level when the request was made. If this
2561 has changed, ignore the request."
2562 (when (= sldb-level *sldb-level*)
2563 (invoke-nth-restart n)))
2564
2565 (defun wrap-sldb-vars (form)
2566 `(let ((*sldb-level* ,*sldb-level*))
2567 ,form))
2568
2569 (defslimefun eval-string-in-frame (string index)
2570 (to-string (eval-in-frame (wrap-sldb-vars (from-string string))
2571 index)))
2572
2573 (defslimefun pprint-eval-string-in-frame (string index)
2574 (swank-pprint
2575 (multiple-value-list
2576 (eval-in-frame (wrap-sldb-vars (from-string string)) index))))
2577
2578 (defslimefun frame-locals-for-emacs (index)
2579 "Return a property list ((&key NAME ID VALUE) ...) describing
2580 the local variables in the frame INDEX."
2581 (mapcar (lambda (frame-locals)
2582 (destructuring-bind (&key name id value) frame-locals
2583 (list :name (prin1-to-string name) :id id
2584 :value (to-string value))))
2585 (frame-locals index)))
2586
2587 (defslimefun frame-catch-tags-for-emacs (frame-index)
2588 (mapcar #'to-string (frame-catch-tags frame-index)))
2589
2590 (defslimefun sldb-disassemble (index)
2591 (with-output-to-string (*standard-output*)
2592 (disassemble-frame index)))
2593
2594 (defslimefun sldb-return-from-frame (index string)
2595 (let ((form (from-string string)))
2596 (to-string (multiple-value-list (return-from-frame index form)))))
2597
2598 (defslimefun sldb-break (name)
2599 (with-buffer-syntax ()
2600 (sldb-break-at-start (read-from-string name))))
2601
2602 (defslimefun sldb-step (frame)
2603 (cond ((find-restart 'continue)
2604 (activate-stepping frame)
2605 (setq *sldb-stepping-p* t)
2606 (continue))
2607 (t
2608 (error "No continue restart."))))
2609
2610
2611 ;;;; Compilation Commands.
2612
2613 (defvar *compiler-notes* '()
2614 "List of compiler notes for the last compilation unit.")
2615
2616 (defun clear-compiler-notes ()
2617 (setf *compiler-notes* '()))
2618
2619 (defun canonicalize-filename (filename)
2620 (namestring (truename filename)))
2621
2622 (defslimefun compiler-notes-for-emacs ()
2623 "Return the list of compiler notes for the last compilation unit."
2624 (reverse *compiler-notes*))
2625
2626 (defun measure-time-interval (fn)
2627 "Call FN and return the first return value and the elapsed time.
2628 The time is measured in microseconds."
2629 (declare (type function fn))
2630 (let ((before (get-internal-real-time)))
2631 (values
2632 (funcall fn)
2633 (* (- (get-internal-real-time) before)
2634 (/ 1000000 internal-time-units-per-second)))))
2635
2636 (defun record-note-for-condition (condition)
2637 "Record a note for a compiler-condition."
2638 (push (make-compiler-note condition) *compiler-notes*))
2639
2640 (defun make-compiler-note (condition)
2641 "Make a compiler note data structure from a compiler-condition."
2642 (declare (type compiler-condition condition))
2643 (list* :message (message condition)
2644 :severity (severity condition)
2645 :location (location condition)
2646 :references (references condition)
2647 (let ((s (short-message condition)))
2648 (if s (list :short-message s)))))
2649
2650 (defun swank-compiler (function)
2651 (clear-compiler-notes)
2652 (with-simple-restart (abort "Abort SLIME compilation.")
2653 (multiple-value-bind (result usecs)
2654 (handler-bind ((compiler-condition #'record-note-for-condition))
2655 (measure-time-interval function))
2656 (list (to-string result)
2657 (format nil "~,2F" (/ usecs 1000000.0))))))
2658
2659 (defslimefun compile-file-for-emacs (filename load-p &optional external-format)
2660 "Compile FILENAME and, when LOAD-P, load the result.
2661 Record compiler notes signalled as `compiler-condition's."
2662 (with-buffer-syntax ()
2663 (let ((*compile-print* nil))
2664 (swank-compiler (lambda () (swank-compile-file filename load-p
2665 external-format))))))
2666
2667 (defslimefun compile-string-for-emacs (string buffer position directory)
2668 "Compile STRING (exerpted from BUFFER at POSITION).
2669 Record compiler notes signalled as `compiler-condition's."
2670 (with-buffer-syntax ()
2671 (swank-compiler
2672 (lambda ()
2673 (let ((*compile-print* nil) (*compile-verbose* t))
2674 (swank-compile-string string :buffer buffer :position position
2675 :directory directory))))))
2676
2677 (defslimefun operate-on-system-for-emacs (system-name operation &rest keywords)
2678 "Compile and load SYSTEM using ASDF.
2679 Record compiler notes signalled as `compiler-condition's."
2680 (swank-compiler
2681 (lambda ()
2682 (apply #'operate-on-system system-name operation keywords))))
2683
2684 (defun asdf-central-registry ()
2685 (when (find-package :asdf)
2686 (symbol-value (find-symbol (string :*central-registry*) :asdf))))
2687
2688 (defslimefun list-all-systems-in-central-registry ()
2689 "Returns a list of all systems in ASDF's central registry."
2690 (delete-duplicates
2691 (loop for dir in (asdf-central-registry)
2692 for defaults = (eval dir)
2693 when defaults
2694 nconc (mapcar #'file-namestring
2695 (directory
2696 (make-pathname :defaults defaults
2697 :version :newest
2698 :type "asd"
2699 :name :wild
2700 :case :local))))
2701 :test #'string=))
2702
2703 (defun file-newer-p (new-file old-file)
2704 "Returns true if NEW-FILE is newer than OLD-FILE."
2705 (> (file-write-date new-file) (file-write-date old-file)))
2706
2707 (defun requires-compile-p (source-file)
2708 (let ((fasl-file (probe-file (compile-file-pathname source-file))))
2709 (or (not fasl-file)
2710 (file-newer-p source-file fasl-file))))
2711
2712 (defslimefun compile-file-if-needed (filename loadp)
2713 (cond ((requires-compile-p filename)
2714 (compile-file-for-emacs filename loadp))
2715 (loadp
2716 (load (compile-file-pathname filename))
2717 nil)))
2718
2719
2720 ;;;; Loading
2721
2722 (defslimefun load-file (filename)
2723 (to-string (load filename)))
2724
2725 (defslimefun load-file-set-package (filename &optional package)
2726 (load-file filename)
2727 (if package
2728 (set-package package)))
2729
2730
2731 ;;;; Macroexpansion
2732
2733 (defvar *macroexpand-printer-bindings*
2734 '((*print-circle* . nil)
2735 (*print-pretty* . t)
2736 (*print-escape* . t)
2737 (*print-level* . nil)
2738 (*print-length* . nil)))
2739
2740 (defun apply-macro-expander (expander string)
2741 (declare (type function expander))
2742 (with-buffer-syntax ()
2743 (with-bindings *macroexpand-printer-bindings*
2744 (prin1-to-string (funcall expander (from-string string))))))
2745
2746 (defslimefun swank-macroexpand-1 (string)
2747 (apply-macro-expander #'macroexpand-1 string))
2748
2749 (defslimefun swank-macroexpand (string)
2750 (apply-macro-expander #'macroexpand string))
2751
2752 (defslimefun swank-macroexpand-all (string)
2753 (apply-macro-expander #'macroexpand-all string))
2754
2755 (defslimefun swank-compiler-macroexpand-1 (string)
2756 (apply-macro-expander #'compiler-macroexpand-1 string))
2757
2758 (defslimefun swank-compiler-macroexpand (string)
2759 (apply-macro-expander #'compiler-macroexpand string))
2760
2761 (defslimefun disassemble-symbol (name)
2762 (with-buffer-syntax ()
2763 (with-output-to-string (*standard-output*)
2764 (let ((*print-readably* nil))
2765 (disassemble (fdefinition (from-string name)))))))
2766
2767
2768 ;;;; Basic completion
2769
2770 (defslimefun completions (string default-package-name)
2771 "Return a list of completions for a symbol designator STRING.
2772
2773 The result is the list (COMPLETION-SET
2774 COMPLETED-PREFIX). COMPLETION-SET is the list of all matching
2775 completions, and COMPLETED-PREFIX is the best (partial)
2776 completion of the input string.
2777
2778 If STRING is package qualified the result list will also be
2779 qualified. If string is non-qualified the result strings are
2780 also not qualified and are considered relative to
2781 DEFAULT-PACKAGE-NAME.
2782
2783 The way symbols are matched depends on the symbol designator's
2784 format. The cases are as follows:
2785 FOO - Symbols with matching prefix and accessible in the buffer package.
2786 PKG:FOO - Symbols with matching prefix and external in package PKG.
2787 PKG::FOO - Symbols with matching prefix and accessible in package PKG."
2788 (let ((completion-set (completion-set string default-package-name
2789 #'compound-prefix-match)))
2790 (list completion-set (longest-completion completion-set))))
2791
2792 (defslimefun simple-completions (string default-package-name)
2793 "Return a list of completions for a symbol designator STRING."
2794 (let ((completion-set (completion-set string default-package-name
2795 #'prefix-match-p)))
2796 (list completion-set (longest-common-prefix completion-set))))
2797
2798 ;;;;; Find completion set
2799
2800 (defun completion-set (string default-package-name matchp)
2801 "Return the set of completion-candidates as strings."
2802 (multiple-value-bind (name package-name package internal-p)
2803 (parse-completion-arguments string default-package-name)
2804 (let* ((symbols (and package
2805 (find-matching-symbols name
2806 package
2807 (and (not internal-p)
2808 package-name)
2809 matchp)))
2810 (packs (and (not package-name)
2811 (find-matching-packages name matchp)))
2812 (converter (output-case-converter name))
2813 (strings
2814 (mapcar converter
2815 (nconc (mapcar #'symbol-name symbols) packs))))
2816 (format-completion-set strings internal-p package-name))))
2817
2818 (defun find-matching-symbols (string package external test)
2819 "Return a list of symbols in PACKAGE matching STRING.
2820 TEST is called with two strings. If EXTERNAL is true, only external
2821 symbols are returned."
2822 (let ((completions '())
2823 (converter (output-case-converter string)))
2824 (flet ((symbol-matches-p (symbol)
2825 (and (or (not external)
2826 (symbol-external-p symbol package))
2827 (funcall test string
2828 (funcall converter (symbol-name symbol))))))
2829 (do-symbols (symbol package)
2830 (when (symbol-matches-p symbol)
2831 (push symbol completions))))
2832 (remove-duplicates completions)))
2833
2834 (defun find-matching-symbols-in-list (string list test)
2835 "Return a list of symbols in LIST matching STRING.
2836 TEST is called with two strings."
2837 (let ((completions '())
2838 (converter (output-case-converter string)))
2839 (flet ((symbol-matches-p (symbol)
2840 (funcall test string
2841 (funcall converter (symbol-name symbol)))))
2842 (dolist (symbol list)
2843 (when (symbol-matches-p symbol)
2844 (push symbol completions))))
2845 (remove-duplicates completions)))
2846
2847 (defun symbol-external-p (symbol &optional (package (symbol-package symbol)))
2848 "True if SYMBOL is external in PACKAGE.
2849 If PACKAGE is not specified, the home package of SYMBOL is used."
2850 (and package
2851 (eq (nth-value 1 (find-symbol (symbol-name symbol) package))
2852 :external)))
2853
2854 (defun find-matching-packages (name matcher)
2855 "Return a list of package names matching NAME with MATCHER.
2856 MATCHER is a two-argument predicate."
2857 (let ((to-match (string-upcase name)))
2858 (remove-if-not (lambda (x) (funcall matcher to-match x))
2859 (mapcar (lambda (pkgname)
2860 (concatenate 'string pkgname ":"))
2861 (loop for package in (list-all-packages)
2862 collect (package-name package)
2863 append (package-nicknames package))))))
2864
2865 (defun parse-completion-arguments (string default-package-name)
2866 "Parse STRING as a symbol designator.
2867 Return these values:
2868 SYMBOL-NAME
2869 PACKAGE-NAME, or nil if the designator does not include an explicit package.
2870 PACKAGE, the package to complete in
2871 INTERNAL-P, if the symbol is qualified with `::'."
2872 (multiple-value-bind (name package-name internal-p)
2873 (tokenize-symbol string)
2874 (let ((package (carefully-find-package package-name default-package-name)))
2875 (values name package-name package internal-p))))
2876
2877 (defun carefully-find-package (name default-package-name)
2878 "Find the package with name NAME, or DEFAULT-PACKAGE-NAME, or the
2879 *buffer-package*. NAME and DEFAULT-PACKAGE-NAME can be nil."
2880 (let ((string (cond ((equal name "") "KEYWORD")
2881 (t (or name default-package-name)))))
2882 (if string
2883 (guess-package-from-string string nil)
2884 *buffer-package*)))
2885
2886 ;;;;; Format completion results
2887 ;;;
2888 ;;; We try to format results in the case as inputs. If you complete
2889 ;;; `FOO' then your result should include `FOOBAR' rather than
2890 ;;; `foobar'.
2891
2892 (defun format-completion-set (strings internal-p package-name)
2893 "Format a set of completion strings.
2894 Returns a list of completions with package qualifiers if needed."
2895 (mapcar (lambda (string)
2896 (format-completion-result string internal-p package-name))
2897 (sort strings #'string<)))
2898
2899 (defun format-completion-result (string internal-p package-name)
2900 (let ((prefix (cond (internal-p (format nil "~A::" package-name))
2901 (package-name (format nil "~A:" package-name))
2902 (t ""))))
2903 (values (concatenate 'string prefix string)
2904 (length prefix))))
2905
2906 (defun output-case-converter (input)
2907 "Return a function to case convert strings for output.
2908 INPUT is used to guess the preferred case."
2909 (ecase (readtable-case *readtable*)
2910 (:upcase (if (some #'lower-case-p input) #'string-downcase #'identity))
2911 (:invert (lambda (output)
2912 (multiple-value-bind (lower upper) (determine-case output)
2913 (cond ((and lower upper) output)
2914 (lower (string-upcase output))
2915 (upper (string-downcase output))
2916 (t output)))))
2917 (:downcase (if (some #'upper-case-p input) #'string-upcase #'identity))
2918 (:preserve #'identity)))
2919
2920 (defun determine-case (string)
2921 "Return two booleans LOWER and UPPER indicating whether STRING
2922 contains lower or upper case characters."
2923 (values (some #'lower-case-p string)
2924 (some #'upper-case-p string)))
2925
2926
2927 ;;;;; Compound-prefix matching
2928
2929 (defun compound-prefix-match (prefix target)
2930 "Return true if PREFIX is a compound-prefix of TARGET.
2931 Viewing each of PREFIX and TARGET as a series of substrings delimited
2932 by hyphens, if each substring of PREFIX is a prefix of the
2933 corresponding substring in TARGET then we call PREFIX a
2934 compound-prefix of TARGET.
2935
2936 Examples:
2937 \(compound-prefix-match \"foo\" \"foobar\") => t
2938 \(compound-prefix-match \"m--b\" \"multiple-value-bind\") => t
2939 \(compound-prefix-match \"m-v-c\" \"multiple-value-bind\") => NIL"
2940 (declare (type simple-string prefix target))
2941 (loop for ch across prefix
2942 with tpos = 0
2943 always (and (< tpos (length target))
2944 (if (char= ch #\-)
2945 (setf tpos (position #\- target :start tpos))
2946 (char= ch (aref target tpos))))
2947 do (incf tpos)))
2948
2949 (defun prefix-match-p (prefix string)
2950 "Return true if PREFIX is a prefix of STRING."
2951 (not (mismatch prefix string :end2 (min (length string) (length prefix)))))
2952
2953
2954 ;;;;; Extending the input string by completion
2955
2956 (defun longest-completion (completions)
2957 "Return the longest prefix for all COMPLETIONS.
2958 COMPLETIONS is a list of strings."
2959 (untokenize-completion
2960 (mapcar #'longest-common-prefix
2961 (transpose-lists (mapcar #'tokenize-completion completions)))))
2962
2963 (defun tokenize-completion (string)
2964 "Return all substrings of STRING delimited by #\-."
2965 (loop with end
2966 for start = 0 then (1+ end)
2967 until (> start (length string))
2968 do (setq end (or (position #\- string :start start) (length string)))
2969 collect (subseq string start end)))
2970
2971 (defun untokenize-completion (tokens)
2972 (format nil "~{~A~^-~}" tokens))
2973
2974 (defun longest-common-prefix (strings)
2975 "Return the longest string that is a common prefix of STRINGS."
2976 (if (null strings)
2977 ""
2978 (flet ((common-prefix (s1 s2)
2979 (let ((diff-pos (mismatch s1 s2)))
2980 (if diff-pos (subseq s1 0 diff-pos) s1))))
2981 (reduce #'common-prefix strings))))
2982
2983 (defun transpose-lists (lists)
2984 "Turn a list-of-lists on its side.
2985 If the rows are of unequal length, truncate uniformly to the shortest.
2986
2987 For example:
2988 \(transpose-lists '((ONE TWO THREE) (1 2)))
2989 => ((ONE 1) (TWO 2))"
2990 (cond ((null lists) '())
2991 ((some #'null lists) '())
2992 (t (cons (mapcar #'car lists)
2993 (transpose-lists (mapcar #'cdr lists))))))
2994
2995
2996 ;;;;; Completion Tests
2997
2998 (defpackage :swank-completion-test
2999 (:use))
3000
3001 (let ((*readtable* (copy-readtable *readtable*))
3002 (p (find-package :swank-completion-test)))
3003 (intern "foo" p)
3004 (intern "Foo" p)
3005 (intern "FOO" p)
3006 (setf (readtable-case *readtable*) :invert)
3007 (flet ((names (prefix)
3008 (sort (mapcar #'symbol-name
3009 (find-matching-symbols prefix p nil #'prefix-match-p))
3010 #'string<)))
3011 (assert (equal '("FOO") (names "f")))
3012 (assert (equal '("Foo" "foo") (names "F")))
3013 (assert (equal '("Foo") (names "Fo")))
3014 (assert (equal '("foo") (names "FO")))))
3015
3016 ;;;; Fuzzy completion
3017
3018 (defslimefun fuzzy-completions (string default-package-name &optional limit)
3019 "Return an (optionally limited to LIMIT best results) list of
3020 fuzzy completions for a symbol designator STRING. The list will
3021 be sorted by score, most likely match first.
3022
3023 The result is a list of completion objects, where a completion
3024 object is:
3025 (COMPLETED-STRING SCORE (&rest CHUNKS) FLAGS)
3026 where a CHUNK is a description of a matched string of characters:
3027 (OFFSET STRING)
3028 and FLAGS is a list of keywords describing properties of the symbol.
3029 For example, the top result for completing \"mvb\" in a package
3030 that uses COMMON-LISP would be something like:
3031 (\"multiple-value-bind\" 42.391666 ((0 \"mul\") (9 \"v\") (15 \"b\"))
3032 (:FBOUNDP :MACRO))
3033
3034 If STRING is package qualified the result list will also be
3035 qualified. If string is non-qualified the result strings are
3036 also not qualified and are considered relative to
3037 DEFAULT-PACKAGE-NAME.
3038
3039 Which symbols are candidates for matching depends on the symbol
3040 designator's format. The cases are as follows:
3041 FOO - Symbols accessible in the buffer package.
3042 PKG:FOO - Symbols external in package PKG.
3043 PKG::FOO - Symbols accessible in package PKG."
3044 (fuzzy-completion-set string default-package-name limit))
3045
3046 (defun convert-fuzzy-completion-result (result converter
3047 internal-p package-name)
3048 "Converts a result from the fuzzy completion core into
3049 something that emacs is expecting. Converts symbols to strings,
3050 fixes case issues, and adds information describing if the symbol
3051 is :bound, :fbound, a :class, a :macro, a :generic-function,
3052 a :special-operator, or a :package."
3053 (destructuring-bind (symbol-or-name score chunks) result
3054 (multiple-value-bind (name added-length)
3055 (format-completion-result
3056 (funcall converter
3057 (if (symbolp symbol-or-name)
3058 (symbol-name symbol-or-name)
3059 symbol-or-name))
3060 internal-p package-name)
3061 (list name score
3062 (mapcar
3063 #'(lambda (chunk)
3064 ;; fix up chunk positions to account for possible
3065 ;; added package identifier
3066 (list (+ added-length (first chunk))
3067 (second chunk)))
3068 chunks)
3069 (loop for flag in '(:boundp :fboundp :generic-function
3070 :class :macro :special-operator
3071 :package)
3072 if (if (symbolp symbol-or-name)
3073 (case flag
3074 (:boundp (boundp symbol-or-name))
3075 (:fboundp (fboundp symbol-or-name))
3076 (:class (find-class symbol-or-name nil))
3077 (:macro (macro-function symbol-or-name))
3078 (:special-operator
3079 (special-operator-p symbol-or-name))
3080 (:generic-function
3081 (typep (ignore-errors (fdefinition symbol-or-name))
3082 'generic-function)))
3083 (case flag
3084 (:package (stringp symbol-or-name)
3085 ;; KLUDGE: depends on internal
3086 ;; knowledge that packages are
3087 ;; brought up from the bowels of
3088 ;; the completion algorithm as
3089 ;; strings!
3090 )))
3091 collect flag)))))
3092
3093 (defun fuzzy-completion-set (string default-package-name &optional limit)
3094 "Prepares list of completion obajects, sorted by SCORE, of fuzzy
3095 completions of STRING in DEFAULT-PACKAGE-NAME. If LIMIT is set,
3096 only the top LIMIT results will be returned."
3097 (multiple-value-bind (name package-name package internal-p)
3098 (parse-completion-arguments string default-package-name)
3099 (let* ((symbols (and package
3100 (fuzzy-find-matching-symbols name
3101 package
3102 (and (not internal-p)
3103 package-name))))
3104 (packs (and (not package-name)
3105 (fuzzy-find-matching-packages name)))
3106 (converter (output-case-converter name))
3107 (results
3108 (sort (mapcar #'(lambda (result)
3109 (convert-fuzzy-completion-result
3110 result converter internal-p package-name))
3111 (nconc symbols packs))
3112 #'> :key #'second)))
3113 (when (and limit
3114 (> limit 0)
3115 (< limit (length results)))
3116 (setf (cdr (nthcdr (1- limit) results)) nil))
3117 results)))
3118
3119 (defun fuzzy-find-matching-symbols (string package external)
3120 "Return a list of symbols in PACKAGE matching STRING using the
3121 fuzzy completion algorithm. If EXTERNAL is true, only external
3122 symbols are returned."
3123 (let ((completions '())
3124 (converter (output-case-converter string)))
3125 (flet ((symbol-match (symbol)
3126 (and (or (not external)
3127 (symbol-external-p symbol package))
3128 (compute-highest-scoring-completion
3129 string (funcall converter (symbol-name symbol)) #'char=))))
3130 (do-symbols (symbol package)
3131 (if (string= "" string)
3132 (when (or (and external (symbol-external-p symbol package))
3133 (not external))
3134 (push (list symbol 0.0 (list (list 0 ""))) completions))
3135 (multiple-value-bind (result score) (symbol-match symbol)
3136 (when result
3137 (push (list symbol score result) completions))))))
3138 (remove-duplicates completions :key #'first)))
3139
3140 (defun fuzzy-find-matching-packages (name)
3141 "Return a list of package names matching NAME using the fuzzy
3142 completion algorithm."
3143 (let ((converter (output-case-converter name)))
3144 (loop for package in (list-all-packages)
3145 for package-name = (concatenate 'string
3146 (funcall converter
3147 (package-name package))
3148 ":")
3149 for (result score) = (multiple-value-list
3150 (compute-highest-scoring-completion
3151 name package-name #'char=))
3152 if result collect (list package-name score result))))
3153
3154 (defslimefun fuzzy-completion-selected (original-string completion)
3155 "This function is called by Slime when a fuzzy completion is
3156 selected by the user. It is for future expansion to make
3157 testing, say, a machine learning algorithm for completion scoring
3158 easier.
3159
3160 ORIGINAL-STRING is the string the user completed from, and
3161 COMPLETION is the completion object (see docstring for
3162 SWANK:FUZZY-COMPLETIONS) corresponding to the completion that the
3163 user selected."
3164 (declare (ignore original-string completion))
3165 nil)
3166
3167 ;;;;; Fuzzy completion core
3168
3169 (defparameter *fuzzy-recursion-soft-limit* 30
3170 "This is a soft limit for recursion in
3171 RECURSIVELY-COMPUTE-MOST-COMPLETIONS. Without this limit,
3172 completing a string such as \"ZZZZZZ\" with a symbol named
3173 \"ZZZZZZZZZZZZZZZZZZZZZZZ\" will result in explosive recursion to
3174 find all the ways it can match.
3175
3176 Most natural language searches and symbols do not have this
3177 problem -- this is only here as a safeguard.")
3178
3179 (defun compute-highest-scoring-completion (short full test)
3180 "Finds the highest scoring way to complete the abbreviation
3181 SHORT onto the string FULL, using TEST as a equality function for
3182 letters. Returns two values: The first being the completion
3183 chunks of the high scorer, and the second being the score."
3184 (let* ((scored-results
3185 (mapcar #'(lambda (result)
3186 (cons (score-completion result short full) result))
3187 (compute-most-completions short full test)))
3188 (winner (first (sort scored-results #'> :key #'first))))
3189 (values (rest winner) (first winner))))
3190
3191 (defun compute-most-completions (short full test)
3192 "Finds most possible ways to complete FULL with the letters in SHORT.
3193 Calls RECURSIVELY-COMPUTE-MOST-COMPLETIONS recursively. Returns
3194 a list of (&rest CHUNKS), where each CHUNKS is a description of
3195 how a completion matches."
3196 (let ((*all-chunks* nil))
3197 (declare (special *all-chunks*))
3198 (recursively-compute-most-completions short full test 0 0 nil nil nil t)
3199 *all-chunks*))
3200
3201 (defun recursively-compute-most-completions
3202 (short full test
3203 short-index initial-full-index
3204 chunks current-chunk current-chunk-pos
3205 recurse-p)
3206 "Recursively (if RECURSE-P is true) find /most/ possible ways
3207 to fuzzily map the letters in SHORT onto FULL, with TEST being a
3208 function to determine if two letters match.
3209
3210 A chunk is a list of elements that have matched consecutively.
3211 When consecutive matches stop, it is coerced into a string,
3212 paired with the starting position of the chunk, and pushed onto
3213 CHUNKS.
3214
3215 Whenever a letter matches, if RECURSE-P is true,
3216 RECURSIVELY-COMPUTE-MOST-COMPLETIONS calls itself with a position
3217 one index ahead, to find other possibly higher scoring
3218 possibilities. If there are less than
3219 *FUZZY-RECURSION-SOFT-LIMIT* results in *ALL-CHUNKS* currently,
3220 this call will also recurse.
3221
3222 Once a word has been completely matched, the chunks are pushed
3223 onto the special variable *ALL-CHUNKS* and the function returns."
3224 (declare (special *all-chunks*))
3225 (flet ((short-cur ()
3226 "Returns the next letter from the abbreviation, or NIL
3227 if all have been used."
3228 (if (= short-index (length short))
3229 nil
3230 (aref short short-index)))
3231 (add-to-chunk (char pos)
3232 "Adds the CHAR at POS in FULL to the current chunk,
3233 marking the start position if it is empty."
3234 (unless current-chunk
3235 (setf current-chunk-pos pos))
3236 (push char current-chunk))
3237 (collect-chunk ()
3238 "Collects the current chunk to CHUNKS and prepares for
3239 a new chunk."
3240 (when current-chunk
3241 (push (list current-chunk-pos
3242 (coerce (reverse current-chunk) 'string)) chunks)
3243 (setf current-chunk nil
3244 current-chunk-pos nil))))
3245 ;; If there's an outstanding chunk coming in collect it. Since
3246 ;; we're recursively called on skipping an input character, the
3247 ;; chunk can't possibly continue on.
3248 (when current-chunk (collect-chunk))
3249 (do ((pos initial-full-index (1+ pos)))
3250 ((= pos (length full)))
3251 (let ((cur-char (aref full pos)))
3252 (if (and (short-cur)
3253 (funcall test cur-char (short-cur)))
3254 (progn
3255 (when recurse-p
3256 ;; Try other possibilities, limiting insanely deep
3257 ;; recursion somewhat.
3258 (recursively-compute-most-completions
3259 short full test short-index (1+ pos)
3260 chunks current-chunk current-chunk-pos
3261 (not (> (length *all-chunks*)
3262 *fuzzy-recursion-soft-limit*))))
3263 (incf short-index)
3264 (add-to-chunk cur-char pos))
3265 (collect-chunk))))
3266 (collect-chunk)
3267 ;; If we've exhausted the short characters we have a match.
3268 (if (short-cur)
3269 nil
3270 (let ((rev-chunks (reverse chunks)))
3271 (push rev-chunks *all-chunks*)
3272 rev-chunks))))
3273
3274 ;;;;; Fuzzy completion scoring
3275
3276 (defparameter *fuzzy-completion-symbol-prefixes* "*+-%&?<"
3277 "Letters that are likely to be at the beginning of a symbol.
3278 Letters found after one of these prefixes will be scored as if
3279 they were at the beginning of ths symbol.")
3280 (defparameter *fuzzy-completion-symbol-suffixes* "*+->"
3281 "Letters that are likely to be at the end of a symbol.
3282 Letters found before one of these suffixes will be scored as if
3283 they were at the end of the symbol.")
3284 (defparameter *fuzzy-completion-word-separators* "-/."
3285 "Letters that separate different words in symbols. Letters
3286 after one of these symbols will be scores more highly than other
3287 letters.")
3288
3289 (defun score-completion (completion short full)
3290 "Scores the completion chunks COMPLETION as a completion from
3291 the abbreviation SHORT to the full string FULL. COMPLETION is a
3292 list like:
3293 ((0 \"mul\") (9 \"v\") (15 \"b\"))
3294 Which, if SHORT were \"mulvb\" and full were \"multiple-value-bind\",
3295 would indicate that it completed as such (completed letters
3296 capitalized):
3297 MULtiple-Value-Bind
3298
3299 Letters are given scores based on their position in the string.
3300 Letters at the beginning of a string or after a prefix letter at
3301 the beginning of a string are scored highest. Letters after a
3302 word separator such as #\- are scored next highest. Letters at
3303 the end of a string or before a suffix letter at the end of a
3304 string are scored medium, and letters anywhere else are scored
3305 low.
3306
3307 If a letter is directly after another matched letter, and its
3308 intrinsic value in that position is less than a percentage of the
3309 previous letter's value, it will use that percentage instead.
3310
3311 Finally, a small scaling factor is applied to favor shorter
3312 matches, all other things being equal."
3313 (labels ((at-beginning-p (pos)
3314 (= pos 0))
3315 (after-prefix-p (pos)
3316 (and (= pos 1)
3317 (find (aref full 0) *fuzzy-completion-symbol-prefixes*)))
3318 (word-separator-p (pos)
3319 (find (aref full pos) *fuzzy-completion-word-separators*))
3320 (after-word-separator-p (pos)
3321 (find (aref full (1- pos)) *fuzzy-completion-word-separators*))
3322 (at-end-p (pos)
3323 (= pos (1- (length full))))
3324 (before-suffix-p (pos)
3325 (and (= pos (- (length full) 2))
3326 (find (aref full (1- (length full)))
3327 *fuzzy-completion-symbol-suffixes*)))
3328 (score-or-percentage-of-previous (base-score pos chunk-pos)
3329 (if (zerop chunk-pos)
3330 base-score
3331 (max base-score
3332 (* (score-char (1- pos) (1- chunk-pos)) 0.85))))
3333 (score-char (pos chunk-pos)
3334 (score-or-percentage-of-previous
3335 (cond ((at-beginning-p pos) 10)
3336 ((after-prefix-p pos) 10)
3337 ((word-separator-p pos) 1)
3338 ((after-word-separator-p pos) 8)
3339 ((at-end-p pos) 6)
3340 ((before-suffix-p pos) 6)
3341 (t 1))
3342 pos chunk-pos))
3343 (score-chunk (chunk)
3344 (loop for chunk-pos below (length (second chunk))
3345 for pos from (first chunk)
3346 summing (score-char pos chunk-pos))))
3347 (let* ((chunk-scores (mapcar #'score-chunk completion))
3348 (length-score (/ 10.0 (1+ (- (length full) (length short))))))
3349 (values
3350 (+ (reduce #'+ chunk-scores) length-score)
3351 (list (mapcar #'list chunk-scores completion) length-score)))))
3352
3353 (defun highlight-completion (completion full)
3354 "Given a chunk definition COMPLETION and the string FULL,
3355 HIGHLIGHT-COMPLETION will create a string that demonstrates where
3356 the completion matched in the string. Matches will be
3357 capitalized, while the rest of the string will be lower-case."
3358 (let ((highlit (nstring-downcase (copy-seq full))))
3359 (dolist (chunk completion)
3360 (setf highlit (nstring-upcase highlit
3361 :start (first chunk)
3362 :end (+ (first chunk)
3363 (length (second chunk))))))
3364 highlit))
3365
3366 (defun format-fuzzy-completions (winners)
3367 "Given a list of completion objects such as on returned by
3368 FUZZY-COMPLETIONS, format the list into user-readable output."
3369 (let ((max-len
3370 (loop for winner in winners maximizing (length (first winner)))))
3371 (loop for (sym score result) in winners do
3372 (format t "~&~VA score ~8,2F ~A"
3373 max-len (highlight-completion result sym) score result))))
3374
3375
3376 ;;;; Documentation
3377
3378 (defslimefun apropos-list-for-emacs (name &optional external-only
3379 case-sensitive package)
3380 "Make an apropos search for Emacs.
3381 The result is a list of property lists."
3382 (let ((package (if package
3383 (or (find-package (string-to-package-designator package))
3384 (error "No such package: ~S" package)))))
3385 (mapcan (listify #'briefly-describe-symbol-for-emacs)
3386 (sort (remove-duplicates
3387 (apropos-symbols name external-only case-sensitive package))
3388 #'present-symbol-before-p))))
3389
3390 (defun string-to-package-designator (string)
3391 "Return a package designator made from STRING.
3392 Uses READ to case-convert STRING."
3393 (let ((*package* *swank-io-package*))
3394 (read-from-string string)))
3395
3396 (defun briefly-describe-symbol-for-emacs (symbol)
3397 "Return a property list describing SYMBOL.
3398 Like `describe-symbol-for-emacs' but with at most one line per item."
3399 (flet ((first-line (string)
3400 (let ((pos (position #\newline string)))
3401 (if (null pos) string (subseq string 0 pos)))))
3402 (let ((desc (map-if #'stringp #'first-line
3403 (describe-symbol-for-emacs symbol))))
3404 (if desc
3405 (list* :designator (to-string symbol) desc)))))
3406
3407 (defun map-if (test fn &rest lists)
3408 "Like (mapcar FN . LISTS) but only call FN on objects satisfying TEST.
3409 Example:
3410 \(map-if #'oddp #'- '(1 2 3 4 5)) => (-1 2 -3 4 -5)"
3411 (declare (type function test fn))
3412 (apply #'mapcar
3413 (lambda (x) (if (funcall test x) (funcall fn x) x))
3414 lists))
3415
3416 (defun listify (f)
3417 "Return a function like F, but which returns any non-null value
3418 wrapped in a list."
3419 (declare (type function f))
3420 (lambda (x)
3421 (let ((y (funcall f x)))
3422 (and y (list y)))))
3423
3424 (defun present-symbol-before-p (x y)
3425 "Return true if X belongs before Y in a printed summary of symbols.
3426 Sorted alphabetically by package name and then symbol name, except
3427 that symbols accessible in the current package go first."
3428 (declare (type symbol x y))
3429 (flet ((accessible (s)
3430 ;; Test breaks on NIL for package that does not inherit it
3431 (eq (find-symbol (symbol-name s) *buffer-package*) s)))
3432 (let ((ax (accessible x)) (ay (accessible y)))
3433 (cond ((and ax ay) (string< (symbol-name x) (symbol-name y)))
3434 (ax t)
3435 (ay nil)
3436 (t (let ((px (symbol-package x)) (py (symbol-package y)))
3437 (if (eq px py)
3438 (string< (symbol-name x) (symbol-name y))
3439 (string< (package-name px) (package-name py)))))))))
3440
3441 (let ((regex-hash (make-hash-table :test #'equal)))
3442 (defun compiled-regex (regex-string)
3443 (or (gethash regex-string regex-hash)
3444 (setf (gethash regex-string regex-hash)
3445 (if (zerop (length regex-string))
3446 (lambda (s) (check-type s string) t)
3447 (compile nil (slime-nregex:regex-compile regex-string)))))))
3448
3449 (defun apropos-matcher (string case-sensitive package external-only)
3450 (let* ((case-modifier (if case-sensitive #'string #'string-upcase))
3451 (regex (compiled-regex (funcall case-modifier string))))
3452 (lambda (symbol)
3453 (and (not (keywordp symbol))
3454 (if package (eq (symbol-package symbol) package) t)
3455 (if external-only (symbol-external-p symbol) t)
3456 (funcall regex (funcall case-modifier symbol))))))
3457
3458 (defun apropos-symbols (string external-only case-sensitive package)
3459 (let ((result '())
3460 (matchp (apropos-matcher string case-sensitive package external-only)))
3461 (with-package-iterator (next (or package (list-all-packages))
3462 :external :internal)
3463 (loop
3464 (multiple-value-bind (morep symbol) (next)
3465 (cond ((not morep)
3466 (return))
3467 ((funcall matchp symbol)
3468 (push symbol result))))))
3469 result))
3470
3471 (defun call-with-describe-settings (fn)
3472 (let ((*print-readably* nil))
3473 (funcall fn)))
3474
3475 (defmacro with-describe-settings ((&rest _) &body body)
3476 (declare (ignore _))
3477 `(call-with-describe-settings (lambda () ,@body)))
3478
3479 (defun describe-to-string (object)
3480 (with-describe-settings ()
3481 (with-output-to-string (*standard-output*)
3482 (describe object))))
3483
3484 (defslimefun describe-symbol (symbol-name)
3485 (with-buffer-syntax ()
3486 (describe-to-string (parse-symbol-or-lose symbol-name))))
3487
3488 (defslimefun describe-function (name)
3489 (with-buffer-syntax ()
3490 (let ((symbol (parse-symbol-or-lose name)))
3491 (describe-to-string (or (macro-function symbol)
3492 (symbol-function symbol))))))
3493
3494 (defslimefun describe-definition-for-emacs (name kind)
3495 (with-buffer-syntax ()
3496 (with-describe-settings ()
3497 (with-output-to-string (*standard-output*)
3498 (describe-definition (parse-symbol-or-lose name) kind)))))
3499
3500 (defslimefun documentation-symbol (symbol-name &optional default)
3501 (with-buffer-syntax ()
3502 (multiple-value-bind (sym foundp) (parse-symbol symbol-name)
3503 (if foundp
3504 (let ((vdoc (documentation sym 'variable))
3505 (fdoc (documentation sym 'function)))
3506 (or (and (or vdoc fdoc)
3507 (concatenate 'string
3508 fdoc
3509 (and vdoc fdoc '(#\Newline #\Newline))
3510 vdoc))
3511 default))
3512 default))))
3513
3514
3515 ;;;; Package Commands
3516
3517 (defslimefun list-all-package-names (&optional include-nicknames)
3518 "Return a list of all package names.
3519 Include the nicknames if INCLUDE-NICKNAMES is true."
3520 (loop for package in (list-all-packages)
3521 collect (package-name package)
3522 when include-nicknames append (package-nicknames package)))
3523
3524
3525 ;;;; Tracing
3526
3527 ;; Use eval for the sake of portability...
3528 (defun tracedp (fspec)
3529 (member fspec (eval '(trace))))
3530
3531 (defslimefun swank-toggle-trace (spec-string)
3532 (let ((spec (from-string spec-string)))
3533 (cond ((consp spec) ; handle complicated cases in the backend
3534 (toggle-trace spec))
3535 ((tracedp spec)
3536 (eval `(untrace ,spec))
3537 (format nil "~S is now untraced." spec))
3538 (t
3539 (eval `(trace ,spec))
3540 (format nil "~S is now traced." spec)))))
3541
3542 (defslimefun untrace-all ()
3543 (untrace))
3544
3545
3546 ;;;; Undefing
3547
3548 (defslimefun undefine-function (fname-string)
3549 (let ((fname (from-string fname-string)))
3550 (format nil "~S" (fmakunbound fname))))
3551
3552
3553 ;;;; Profiling
3554
3555 (defun profiledp (fspec)
3556 (member fspec (profiled-functions)))
3557
3558 (defslimefun toggle-profile-fdefinition (fname-string)
3559 (let ((fname (from-string fname-string)))
3560 (cond ((profiledp fname)
3561 (unprofile fname)
3562 (format nil "~S is now unprofiled." fname))
3563 (t
3564 (profile fname)
3565 (format nil "~S is now profiled." fname)))))
3566
3567
3568 ;;;; Source Locations
3569
3570 (defslimefun find-definitions-for-emacs (name)
3571 "Return a list ((DSPEC LOCATION) ...) of definitions for NAME.
3572 DSPEC is a string and LOCATION a source location. NAME is a string."
3573 (multiple-value-bind (sexp error)
3574 (ignore-errors (values (from-string name)))
3575 (cond (error '())
3576 (t (loop for (dspec loc) in (find-definitions sexp)
3577 collect (list (to-string dspec) loc))))))
3578
3579 (defun alistify (list key test)
3580 "Partition the elements of LIST into an alist. KEY extracts the key
3581 from an element and TEST is used to compare keys."
3582 (declare (type function key))
3583 (let ((alist '()))
3584 (dolist (e list)
3585 (let* ((k (funcall key e))
3586 (probe (assoc k alist :test test)))
3587 (if probe
3588 (push e (cdr probe))
3589 (push (cons k (list e)) alist))))
3590 alist))
3591
3592 (defun location-position< (pos1 pos2)
3593 (cond ((and (position-p pos1) (position-p pos2))
3594 (< (position-pos pos1)
3595 (position-pos pos2)))
3596 (t nil)))
3597
3598 (defun partition (list test key)
3599 (declare (type function test key))
3600 (loop for e in list
3601 if (funcall test (funcall key e)) collect e into yes
3602 else collect e into no
3603 finally (return (values yes no))))
3604
3605 (defstruct (xref (:conc-name xref.)
3606 (:type list))
3607 dspec location)
3608
3609 (defun location-valid-p (location)
3610 (eq (car location) :location))
3611
3612 (defun xref-buffer (xref)
3613 (location-buffer (xref.location xref)))
3614
3615 (defun xref-position (xref)
3616 (location-buffer (xref.location xref)))
3617
3618 (defun group-xrefs (xrefs)
3619 "Group XREFS, a list of the form ((DSPEC LOCATION) ...) by location.
3620 The result is a list of the form ((LOCATION . ((DSPEC . LOCATION) ...)) ...)."
3621 (multiple-value-bind (resolved errors)
3622 (partition xrefs #'location-valid-p #'xref.location)
3623 (let ((alist (alistify resolved #'xref-buffer #'equal)))
3624 (append
3625 (loop for (buffer . list) in alist
3626 collect (cons (second buffer)
3627 (mapcar (lambda (xref)
3628 (cons (to-string (xref.dspec xref))
3629 (xref.location xref)))
3630 (sort list #'location-position<
3631 :key #'xref-position))))
3632 (if errors
3633 (list (cons "Unresolved"
3634 (mapcar (lambda (xref)
3635 (cons (to-string (xref.dspec xref))
3636 (xref.location xref)))
3637 errors))))))))
3638
3639 (defslimefun xref (type symbol-name)
3640 (let ((symbol (parse-symbol-or-lose symbol-name *buffer-package*)))
3641 (group-xrefs
3642 (ecase type
3643 (:calls (who-calls symbol))
3644 (:calls-who (calls-who symbol))
3645 (:references (who-references symbol))
3646 (:binds (who-binds symbol))
3647 (:sets (who-sets symbol))
3648 (:macroexpands (who-macroexpands symbol))
3649 (:specializes (who-specializes symbol))
3650 (:callers (list-callers symbol))
3651 (:callees (list-callees symbol))))))
3652
3653
3654 ;;;; Inspecting
3655
3656 (defun common-seperated-spec (list &optional (callback (lambda (v)
3657 `(:value ,v))))
3658 (butlast
3659 (loop
3660 for i in list
3661 collect (funcall callback i)
3662 collect ", ")))
3663
3664 (defun inspector-princ (list)
3665 "Like princ-to-string, but don't rewrite (function foo) as #'foo.
3666 Do NOT pass circular lists to this function."
3667 (let ((*print-pprint-dispatch* (copy-pprint-dispatch)))
3668 (set-pprint-dispatch '(cons (member function)) nil)
3669 (princ-to-string list)))
3670
3671 (defmethod inspect-for-emacs ((object cons) inspector)
3672 (declare (ignore inspector))
3673 (if (consp (cdr object))
3674 (inspect-for-emacs-list object)
3675 (inspect-for-emacs-simple-cons object)))
3676
3677 (defun inspect-for-emacs-simple-cons (cons)
3678 (values "A cons cell."
3679 (label-value-line*
3680 ('car (car cons))
3681 ('cdr (cdr cons)))))
3682
3683 (defun inspect-for-emacs-list (list)
3684 (let ((maxlen 40))
3685 (multiple-value-bind (length tail) (safe-length list)
3686 (flet ((frob (title list)
3687 (let ((lines
3688 (do ((i 0 (1+ i))
3689 (l list (cdr l))
3690 (a '() (cons (label-value-line i (car l)) a)))
3691 ((not (consp l))
3692 (let ((a (if (null l)
3693 a
3694 (cons (label-value-line :tail l) a))))
3695 (reduce #'append (reverse a) :from-end t))))))
3696 (values title (append '("Elements:" (:newline)) lines)))))
3697
3698 (cond ((not length) ; circular
3699 (frob "A circular list."
3700 (cons (car list)
3701 (ldiff (cdr list) list))))
3702 ((and (<= length maxlen) (not tail))
3703 (frob "A proper list." list))
3704 (tail
3705 (frob "An improper list." list))
3706 (t
3707 (frob "A proper list." list)))))))
3708
3709 ;; (inspect-for-emacs-list '#1=(a #1# . #1# ))
3710
3711 (defun safe-length (list)
3712 "Similar to `list-length', but avoid errors on improper lists.
3713 Return two values: the length of the list and the last cdr.
3714 NIL is returned if the list is circular."
3715 (do ((n 0 (+ n 2)) ;Counter.
3716 (fast list (cddr fast)) ;Fast pointer: leaps by 2.
3717 (slow list (cdr slow))) ;Slow pointer: leaps by 1.
3718 (nil)
3719 (cond ((null fast) (return (values n nil)))
3720 ((not (consp fast)) (return (values n fast)))
3721 ((null (cdr fast)) (return (values (1+ n) (cdr fast))))
3722 ((and (eq fast slow) (> n 0)) (return nil))
3723 ((not (consp (cdr fast))) (return (values (1+ n) (cdr fast)))))))
3724
3725 (defvar *slime-inspect-contents-limit* nil "How many elements of
3726 a hash table or array to show by default. If table has more than
3727 this then offer actions to view more. Set to nil for no limit." )
3728
3729 (defmethod inspect-for-emacs ((ht hash-table) inspector)
3730 (declare (ignore inspector))
3731 (values (prin1-to-string ht)
3732 (append
3733 (label-value-line*
3734 ("Count" (hash-table-count ht))
3735 ("Size" (hash-table-size ht))
3736 ("Test" (hash-table-test ht))
3737 ("Rehash size" (hash-table-rehash-size ht))
3738 ("Rehash threshold" (hash-table-rehash-threshold ht)))
3739 '("Contents: " (:newline))
3740 (if (and *slime-inspect-contents-limit*
3741 (>= (hash-table-count ht) *slime-inspect-contents-limit*))
3742 (inspect-bigger-piece-actions ht (hash-table-count ht))
3743 nil)
3744 (loop for key being the hash-keys of ht
3745 for value being the hash-values of ht
3746 repeat (or *slime-inspect-contents-limit* most-positive-fixnum)
3747 append `((:value ,key) " = " (:value ,value) (:newline))
3748 )
3749
3750 )))
3751
3752 (defmethod inspect-bigger-piece-actions (thing size)
3753 (append
3754 (if (> size *slime-inspect-contents-limit*)
3755 (list (inspect-show-more-action thing)
3756 '(:newline))
3757 nil)
3758 (list (inspect-whole-thing-action thing size)
3759 '(:newline))))
3760
3761 (defmethod inspect-whole-thing-action (thing size)
3762 `(:action ,(format nil "Inspect all ~a elements."
3763 size)
3764 ,(lambda()
3765 (let ((*slime-inspect-contents-limit* nil))
3766 (values
3767 (swank::inspect-object thing)
3768 :replace)
3769 ))))
3770
3771 (defmethod inspect-show-more-action (thing)
3772 `(:action ,(format nil "~a elements shown. Prompt for how many to inspect..."
3773 *slime-inspect-contents-limit* )
3774 ,(lambda()
3775 (let ((*slime-inspect-contents-limit*
3776 (progn (format t "How many elements should be shown? ") (read))))
3777 (values
3778 (swank::inspect-object thing)
3779 :replace)
3780 ))
3781 ))
3782
3783 (defmethod inspect-for-emacs ((array array) inspector)
3784 (declare (ignore inspector))
3785 (values "An array."
3786 (append
3787 (label-value-line*
3788 ("Dimensions" (array-dimensions array))
3789 ("Its element type is" (array-element-type array))
3790 ("Total size" (array-total-size array))
3791 ("Adjustable" (adjustable-array-p array)))
3792 (when (array-has-fill-pointer-p array)
3793 (label-value-line "Fill pointer" (fill-pointer array)))
3794 '("Contents:" (:newline))
3795 (if (and *slime-inspect-contents-limit*
3796 (>= (array-total-size array) *slime-inspect-contents-limit*))
3797 (inspect-bigger-piece-actions array (length array))
3798 nil)
3799 (loop for i below (or *slime-inspect-contents-limit* (array-total-size array))
3800 append (label-value-line i (row-major-aref array i))))))
3801
3802 (defmethod inspect-for-emacs ((char character) inspector)
3803 (declare (ignore inspector))
3804 (values "A character."
3805 (append
3806 (label-value-line*
3807 ("Char code" (char-code char))
3808 ("Lower cased" (char-downcase char))
3809 ("Upper cased" (char-upcase char)))
3810 (if (get-macro-character char)
3811 `("In the current readtable ("
3812 (:value ,*readtable*) ") it is a macro character: "
3813 (:value ,(get-macro-character char)))))))
3814
3815 (defun docstring-ispec (label object kind)
3816 "Return a inspector spec if OBJECT has a docstring of of kind KIND."
3817 (let ((docstring (documentation object kind)))
3818 (cond ((not docstring) nil)
3819 ((< (+ (length label) (length docstring))
3820 75)
3821 (list label ": " docstring '(:newline)))
3822 (t
3823 (list label ": " '(:newline) " " docstring '(:newline))))))
3824
3825 (defmethod inspect-for-emacs ((symbol symbol) inspector)
3826 (declare (ignore inspector))
3827 (let ((package (symbol-package symbol)))
3828 (multiple-value-bind (_symbol status)
3829 (and package (find-symbol (string symbol) package))
3830 (declare (ignore _symbol))
3831 (values
3832 "A symbol."
3833 (append
3834 (label-value-line "Its name is" (symbol-name symbol))
3835 ;;
3836 ;; Value
3837 (cond ((boundp symbol)
3838 (label-value-line (if (constantp symbol)
3839 "It is a constant of value"
3840 "It is a global variable bound to")
3841 (symbol-value symbol)))
3842 (t '("It is unbound." (:newline))))
3843 (docstring-ispec "Documentation" symbol 'variable)
3844 (multiple-value-bind (expansion definedp) (macroexpand symbol)
3845 (if definedp
3846 (label-value-line "It is a symbol macro with expansion"
3847 expansion)))
3848 ;;
3849 ;; Function
3850 (if (fboundp symbol)
3851 (append (if (macro-function symbol)
3852 `("It a macro with macro-function: "
3853 (:value ,(macro-function symbol)))
3854 `("It is a function: "
3855 (:value ,(symbol-function symbol))))
3856 `(" " (:action "[make funbound]"
3857 ,(lambda () (fmakunbound symbol))))
3858 `((:newline)))
3859 `("It has no function value." (:newline)))
3860 (docstring-ispec "Function Documentation" symbol 'function)
3861 (if (compiler-macro-function symbol)
3862 (label-value-line "It also names the compiler macro"
3863 (compiler-macro-function symbol)))
3864 (docstring-ispec "Compiler Macro Documentation"
3865 symbol 'compiler-macro)
3866 ;;
3867 ;; Package
3868 (if package
3869 `("It is " ,(string-downcase (string status))
3870 " to the package: "
3871 (:value ,package ,(package-name package))
3872 ,@(if (eq :internal status)
3873 `(" "
3874 (:action "[export it]"
3875 ,(lambda () (export symbol package)))))
3876 " "
3877 (:action "[unintern it]"
3878 ,(lambda () (unintern symbol package)))
3879 (:newline))
3880 '("It is a non-interned symbol." (:newline)))
3881 ;;
3882 ;; Plist
3883 (label-value-line "Property list" (symbol-plist symbol))
3884 ;;
3885 ;; Class
3886 (if (find-class symbol nil)
3887 `("It names the class "
3888 (:value ,(find-class symbol) ,(string symbol))
3889 " "
3890 (:action "[remove]"
3891 ,(lambda () (setf (find-class symbol) nil)))
3892 (:newline)))
3893 ;;
3894 ;; More package
3895 (if (find-package symbol)
3896 (label-value-line "It names the package" (find-package symbol)))
3897 )))))
3898
3899 (defmethod inspect-for-emacs ((f function) inspector)
3900 (declare (ignore inspector))
3901 (values "A function."
3902 (append
3903 (label-value-line "Name" (function-name f))
3904 `("Its argument list is: "
3905 ,(inspector-princ (arglist f)) (:newline))
3906 (docstring-ispec "Documentation" f t)
3907 (if (function-lambda-expression f)
3908 (label-value-line "Lambda Expression"
3909 (function-lambda-expression f))))))
3910
3911 (defun method-specializers-for-inspect (method)
3912 "Return a \"pretty\" list of the method's specializers. Normal
3913 specializers are replaced by the name of the class, eql
3914 specializers are replaced by `(eql ,object)."
3915 (mapcar (lambda (spec)
3916 (typecase spec
3917 (swank-mop:eql-specializer
3918 `(eql ,(swank-mop:eql-specializer-object spec)))
3919 (t (swank-mop:class-name spec))))
3920 (swank-mop:method-specializers method)))
3921
3922 (defun method-for-inspect-value (method)
3923 "Returns a \"pretty\" list describing METHOD. The first element
3924 of the list is the name of generic-function method is
3925 specialiazed on, the second element is the method qualifiers,
3926 the rest of the list is the method's specialiazers (as per
3927 method-specializers-for-inspect)."
3928 (append (list (swank-mop:generic-function-name
3929 (swank-mop:method-generic-function method)))
3930 (swank-mop:method-qualifiers method)
3931 (method-specializers-for-inspect method)))
3932
3933 (defmethod inspect-for-emacs ((o standard-object) inspector)
3934 (declare (ignore inspector))
3935 (let ((c (class-of o)))
3936 (values "An object."
3937 `("Class: " (:value ,c) (:newline)
3938 "Slots:" (:newline)
3939 ,@(loop for slotd in (swank-mop:class-slots c)
3940 for name = (swank-mop:slot-definition-name slotd)
3941 collect `(:value ,slotd ,(string name))
3942 collect " = "
3943 collect (if (swank-mop:slot-boundp-using-class c o slotd)
3944 `(:value ,(swank-mop:slot-value-using-class
3945 c o slotd))
3946 "#<unbound>")
3947 collect '(:newline))))))
3948
3949 (defvar *gf-method-getter* 'methods-by-applicability
3950 "This function is called to get the methods of a generic function.
3951 The default returns the method sorted by applicability.
3952 See `methods-by-applicability'.")
3953
3954 (defun specializer< (specializer1 specializer2)
3955 "Return true if SPECIALIZER1 is more specific than SPECIALIZER2."
3956 (let ((s1 specializer1) (s2 specializer2) )
3957 (cond ((typep s1 'swank-mop:eql-specializer)
3958 (not (typep s2 'swank-mop:eql-specializer)))
3959 (t
3960 (flet ((cpl (class)
3961 (and (swank-mop:class-finalized-p class)
3962 (swank-mop:class-precedence-list class))))
3963 (member s2 (cpl s1)))))))
3964
3965 (defun methods-by-applicability (gf)
3966 "Return methods ordered by most specific argument types.
3967
3968 `method-specializer<' is used for sorting."
3969 ;; FIXME: argument-precedence-order and qualifiers are ignored.
3970 (let ((methods (copy-list (swank-mop:generic-function-methods gf))))
3971 (labels ((method< (meth1 meth2)
3972 (loop for s1 in (swank-mop:method-specializers meth1)
3973 for s2 in (swank-mop:method-specializers meth2)
3974 do (cond ((specializer< s2 s1) (return nil))
3975 ((specializer< s1 s2) (return t))))))
3976 (stable-sort methods #'method<))))
3977
3978 (defun abbrev-doc (doc &optional (maxlen 80))
3979 "Return the first sentence of DOC, but not more than MAXLAN characters."
3980 (subseq doc 0 (min (1+ (or (position #\. doc) (1- maxlen)))
3981 maxlen
3982 (length doc))))
3983
3984 (defun all-slots-for-inspector (object)
3985 (append (list "------------------------------" '(:newline)
3986 "All Slots:" '(:newline))
3987 (loop
3988 with direct-slots = (swank-mop:class-direct-slots (class-of object))
3989 for slot in (swank-mop:class-slots (class-of object))
3990 for slot-def = (or (find-if (lambda (a)
3991 ;; find the direct slot
3992 ;; with the same name
3993 ;; as SLOT (an
3994 ;; effective slot).
3995 (eql (swank-mop:slot-definition-name a)
3996 (swank-mop:slot-definition-name slot)))
3997 direct-slots)
3998 slot)
3999 collect `(:value ,slot-def ,(inspector-princ (swank-mop:slot-definition-name slot-def)))
4000 collect " = "
4001 if (slot-boundp object (swank-mop:slot-definition-name slot-def))
4002 collect `(:value ,(slot-value object (swank-mop:slot-definition-name slot-def)))
4003 else
4004 collect "#<unbound>"
4005 collect '(:newline))))
4006
4007 (defmethod inspect-for-emacs ((gf standard-generic-function) inspector)
4008 (declare (ignore inspector))
4009 (flet ((lv (label value) (label-value-line label value)))
4010 (values
4011 "A generic function."
4012 (append
4013 (lv "Name" (swank-mop:generic-function-name gf))
4014 (lv "Arguments" (swank-mop:generic-function-lambda-list gf))
4015 (docstring-ispec "Documentation" gf t)
4016 (lv "Method class" (swank-mop:generic-function-method-class gf))
4017 (lv "Method combination"
4018 (swank-mop:generic-function-method-combination gf))
4019 `("Methods: " (:newline))
4020 (loop for method in (funcall *gf-method-getter* gf) append
4021 `((:value ,method ,(inspector-princ
4022 ;; drop the name of the GF
4023 (cdr (method-for-inspect-value method))))
4024 " "
4025 (:action "[remove method]"
4026 ,(let ((m method)) ; LOOP reassigns method
4027 (lambda ()
4028 (remove-method gf m))))
4029 (:newline)))
4030 `((:newline))
4031 (all-slots-for-inspector gf)))))
4032
4033 (defmethod inspect-for-emacs ((method standard-method) inspector)
4034 (declare (ignore inspector))
4035 (values "A method."
4036 `("Method defined on the generic function "
4037 (:value ,(swank-mop:method-generic-function method)
4038 ,(inspector-princ
4039 (swank-mop:generic-function-name
4040 (swank-mop:method-generic-function method))))
4041 (:newline)
4042 ,@(docstring-ispec "Documentation" method t)
4043 "Lambda List: " (:value ,(swank-mop:method-lambda-list method))
4044 (:newline)
4045 "Specializers: " (:value ,(swank-mop:method-specializers method)
4046 ,(inspector-princ (method-specializers-for-inspect method)))
4047 (:newline)
4048 "Qualifiers: " (:value ,(swank-mop:method-qualifiers method))
4049 (:newline)
4050 "Method function: " (:value ,(swank-mop:method-function method))
4051 (:newline)
4052 ,@(all-slots-for-inspector method))))
4053
4054 (defmethod inspect-for-emacs ((class standard-class) inspector)
4055 (declare (ignore inspector))
4056 (values "A class."
4057 `("Name: " (:value ,(class-name class))
4058 (:newline)
4059 "Super classes: "
4060 ,@(common-seperated-spec (swank-mop:class-direct-superclasses class))
4061 (:newline)
4062 "Direct Slots: "
4063 ,@(common-seperated-spec
4064 (swank-mop:class-direct-slots class)
4065 (lambda (slot)
4066 `(:value ,slot ,(inspector-princ (swank-mop:slot-definition-name slot)))))
4067 (:newline)
4068 "Effective Slots: "
4069 ,@(if (swank-mop:class-finalized-p class)
4070 (common-seperated-spec
4071 (swank-mop:class-slots class)
4072 (lambda (slot)
4073 `(:value ,slot ,(inspector-princ
4074 (swank-mop:slot-definition-name slot)))))
4075 '("#<N/A (class not finalized)>"))
4076 (:newline)
4077 ,@(when (documentation class t)
4078 `("Documentation:" (:newline) ,(documentation class t) (:newline)))
4079 "Sub classes: "
4080 ,@(common-seperated-spec (swank-mop:class-direct-subclasses class)
4081 (lambda (sub)
4082 `(:value ,sub ,(inspector-princ (class-name sub)))))
4083 (:newline)
4084 "Precedence List: "
4085 ,@(if (swank-mop:class-finalized-p class)
4086 (common-seperated-spec (swank-mop:class-precedence-list class)
4087 (lambda (class)
4088 `(:value ,class ,(inspector-princ (class-name class)))))
4089 '("#<N/A (class not finalized)>"))
4090 (:newline)
4091 ,@(when (swank-mop:specializer-direct-methods class)
4092 `("It is used as a direct specializer in the following methods:" (:newline)
4093 ,@(loop
4094 for method in (sort (copy-list (swank-mop:specializer-direct-methods class))
4095 #'string< :key (lamb