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

Contents of /slime/swank.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.371 - (show annotations)
Thu Mar 23 07:14:13 2006 UTC (8 years, 1 month ago) by crhodes
Branch: MAIN
Changes since 1.370: +8 -3 lines
Allow swank:ed-in-emacs to take cons function names.  (This adds some
ambiguity with conses representing filenames and positions)
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 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 :highlight (and arg-index
1400 (not (zerop arg-index))
1401 ;; don't highlight the operator
1402 arg-index))))))))
1403 (error (cond)
1404 (format nil "ARGLIST: ~A" cond))))
1405
1406 (defun operator-designator-to-form (name)
1407 (etypecase name
1408 (cons
1409 (destructure-case name
1410 ((:make-instance class-name)
1411 (values `(make-instance ',(parse-symbol class-name))
1412 'make-instance))
1413 ((:defmethod generic-name)
1414 (values `(defmethod ,(parse-symbol generic-name))
1415 'defmethod))))
1416 (string
1417 (values `(,(parse-symbol name))
1418 name))))
1419
1420 (defun clean-arglist (arglist)
1421 "Remove &whole, &enviroment, and &aux elements from ARGLIST."
1422 (cond ((null arglist) '())
1423 ((member (car arglist) '(&whole &environment))
1424 (clean-arglist (cddr arglist)))
1425 ((eq (car arglist) '&aux)
1426 '())
1427 (t (cons (car arglist) (clean-arglist (cdr arglist))))))
1428
1429 (defun arglist-to-string (arglist package &key print-right-margin highlight)
1430 "Print the list ARGLIST for display in the echo area.
1431 The argument name are printed without package qualifiers and
1432 pretty printing of (function foo) as #'foo is suppressed.
1433 If HIGHLIGHT is non-nil, it must be the index of an argument;
1434 highlight this argument."
1435 (setq arglist (clean-arglist arglist))
1436 (etypecase arglist
1437 (null "()")
1438 (cons
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 (let ((index 0))
1446 (pprint-logical-block (nil nil :prefix "(" :suffix ")")
1447 (loop
1448 (let ((arg (pop arglist)))
1449 (when (member arg lambda-list-keywords)
1450 ;; The highlighting code is currently only
1451 ;; prepared for the required arguments. To
1452 ;; extend it to work with optional and keyword
1453 ;; arguments as well, arglist-to-string should
1454 ;; get a DECODED-ARGLIST instead. --mkoeppe
1455 (setq highlight nil))
1456 (when (and highlight (= index highlight))
1457 (princ "===> "))
1458 (etypecase arg
1459 (symbol (princ arg))
1460 (string (princ arg))
1461 (cons (pprint-logical-block (nil nil :prefix "(" :suffix ")")
1462 (princ (car arg))
1463 (unless (null (cdr arg))
1464 (write-char #\space))
1465 (pprint-fill *standard-output* (cdr arg) nil))))
1466 (when (and highlight (= index highlight))
1467 (princ " <==="))
1468 (incf index)
1469 (when (null arglist) (return))
1470 (write-char #\space)
1471 (pprint-newline :fill)))))))))))
1472
1473 (defun test-print-arglist (list string)
1474 (string= (arglist-to-string list (find-package :swank)) string))
1475
1476 ;; Should work:
1477 (progn
1478 (assert (test-print-arglist '(function cons) "(function cons)"))
1479 (assert (test-print-arglist '(quote cons) "(quote cons)"))
1480 (assert (test-print-arglist '(&key (function #'+)) "(&key (function #'+))"))
1481 (assert (test-print-arglist '(&whole x y z) "(y z)"))
1482 (assert (test-print-arglist '(x &aux y z) "(x)"))
1483 (assert (test-print-arglist '(x &environment env y) "(x y)")))
1484 ;; Expected failure:
1485 ;; (assert (test-print-arglist '(&key ((function f))) "(&key ((function f)))"))
1486
1487 (defslimefun variable-desc-for-echo-area (variable-name)
1488 "Return a short description of VARIABLE-NAME, or NIL."
1489 (with-buffer-syntax ()
1490 (let ((sym (parse-symbol variable-name)))
1491 (if (and sym (boundp sym))
1492 (let ((*print-pretty* nil) (*print-level* 4)
1493 (*print-length* 10) (*print-circle* t))
1494 (format nil "~A => ~A" sym (symbol-value sym)))))))
1495
1496 (defstruct (keyword-arg
1497 (:conc-name keyword-arg.)
1498 (:constructor make-keyword-arg (keyword arg-name default-arg)))
1499 keyword
1500 arg-name
1501 default-arg)
1502
1503 (defun decode-keyword-arg (arg)
1504 "Decode a keyword item of formal argument list.
1505 Return three values: keyword, argument name, default arg."
1506 (cond ((symbolp arg)
1507 (make-keyword-arg (intern (symbol-name arg) keyword-package)
1508 arg
1509 nil))
1510 ((and (consp arg)
1511 (consp (car arg)))
1512 (make-keyword-arg (caar arg)
1513 (cadar arg)
1514 (cadr arg)))
1515 ((consp arg)
1516 (make-keyword-arg (intern (symbol-name (car arg)) keyword-package)
1517 (car arg)
1518 (cadr arg)))
1519 (t
1520 (error "Bad keyword item of formal argument list"))))
1521
1522 (defun encode-keyword-arg (arg)
1523 (if (eql (intern (symbol-name (keyword-arg.arg-name arg))
1524 keyword-package)
1525 (keyword-arg.keyword arg))
1526 (if (keyword-arg.default-arg arg)
1527 (list (keyword-arg.arg-name arg)
1528 (keyword-arg.default-arg arg))
1529 (keyword-arg.arg-name arg))
1530 (let ((keyword/name (list (keyword-arg.arg-name arg)
1531 (keyword-arg.keyword arg))))
1532 (if (keyword-arg.default-arg arg)
1533 (list keyword/name
1534 (keyword-arg.default-arg arg))
1535 (list keyword/name)))))
1536
1537 (progn
1538 (assert (equalp (decode-keyword-arg 'x)
1539 (make-keyword-arg :x 'x nil)))
1540 (assert (equalp (decode-keyword-arg '(x t))
1541 (make-keyword-arg :x 'x t)))
1542 (assert (equalp (decode-keyword-arg '((:x y)))
1543 (make-keyword-arg :x 'y nil)))
1544 (assert (equalp (decode-keyword-arg '((:x y) t))
1545 (make-keyword-arg :x 'y t))))
1546
1547 (defstruct (optional-arg
1548 (:conc-name optional-arg.)
1549 (:constructor make-optional-arg (arg-name default-arg)))
1550 arg-name
1551 default-arg)
1552
1553 (defun decode-optional-arg (arg)
1554 "Decode an optional item of a formal argument list.
1555 Return an OPTIONAL-ARG structure."
1556 (etypecase arg
1557 (symbol (make-optional-arg arg nil))
1558 (list (make-optional-arg (car arg) (cadr arg)))))
1559
1560 (defun encode-optional-arg (optional-arg)
1561 (if (optional-arg.default-arg optional-arg)
1562 (list (optional-arg.arg-name optional-arg)
1563 (optional-arg.default-arg optional-arg))
1564 (optional-arg.arg-name optional-arg)))
1565
1566 (progn
1567 (assert (equalp (decode-optional-arg 'x)
1568 (make-optional-arg 'x nil)))
1569 (assert (equalp (decode-optional-arg '(x t))
1570 (make-optional-arg 'x t))))
1571
1572 (defstruct (arglist (:conc-name arglist.))
1573 required-args ; list of the required arguments
1574 optional-args ; list of the optional arguments
1575 key-p ; whether &key appeared
1576 keyword-args ; list of the keywords
1577 rest ; name of the &rest or &body argument (if any)
1578 body-p ; whether the rest argument is a &body
1579 allow-other-keys-p) ; whether &allow-other-keys appeared
1580
1581 (defun decode-arglist (arglist)
1582 "Parse the list ARGLIST and return an ARGLIST structure."
1583 (let ((mode nil)
1584 (result (make-arglist)))
1585 (dolist (arg arglist)
1586 (cond
1587 ((eql arg '&allow-other-keys)
1588 (setf (arglist.allow-other-keys-p result) t))
1589 ((eql arg '&key)
1590 (setf (arglist.key-p result) t
1591 mode arg))
1592 ((member arg lambda-list-keywords)
1593 (setq mode arg))
1594 (t
1595 (case mode
1596 (&key
1597 (push (decode-keyword-arg arg)
1598 (arglist.keyword-args result)))
1599 (&optional
1600 (push (decode-optional-arg arg)
1601 (arglist.optional-args result)))
1602 (&body
1603 (setf (arglist.body-p result) t
1604 (arglist.rest result) arg))
1605 (&rest
1606 (setf (arglist.rest result) arg))
1607 ((nil)
1608 (push arg (arglist.required-args result)))
1609 ((&whole &environment)
1610 (setf mode nil))))))
1611 (setf (arglist.required-args result)
1612 (nreverse (arglist.required-args result)))
1613 (setf (arglist.optional-args result)
1614 (nreverse (arglist.optional-args result)))
1615 (setf (arglist.keyword-args result)
1616 (nreverse (arglist.keyword-args result)))
1617 result))
1618
1619 (defun encode-arglist (decoded-arglist)
1620 (append (arglist.required-args decoded-arglist)
1621 (when (arglist.optional-args decoded-arglist)
1622 '(&optional))
1623 (mapcar #'encode-optional-arg (arglist.optional-args decoded-arglist))
1624 (when (arglist.key-p decoded-arglist)
1625 '(&key))
1626 (mapcar #'encode-keyword-arg (arglist.keyword-args decoded-arglist))
1627 (when (arglist.allow-other-keys-p decoded-arglist)
1628 '(&allow-other-keys))
1629 (cond ((not (arglist.rest decoded-arglist))
1630 '())
1631 ((arglist.body-p decoded-arglist)
1632 `(&body ,(arglist.rest decoded-arglist)))
1633 (t
1634 `(&rest ,(arglist.rest decoded-arglist))))))
1635
1636 (defun arglist-keywords (arglist)
1637 "Return the list of keywords in ARGLIST.
1638 As a secondary value, return whether &allow-other-keys appears."
1639 (let ((decoded-arglist (decode-arglist arglist)))
1640 (values (arglist.keyword-args decoded-arglist)
1641 (arglist.allow-other-keys-p decoded-arglist))))
1642
1643 (defun methods-keywords (methods)
1644 "Collect all keywords in the arglists of METHODS.
1645 As a secondary value, return whether &allow-other-keys appears somewhere."
1646 (let ((keywords '())
1647 (allow-other-keys nil))
1648 (dolist (method methods)
1649 (multiple-value-bind (kw aok)
1650 (arglist-keywords
1651 (swank-mop:method-lambda-list method))
1652 (setq keywords (remove-duplicates (append keywords kw)
1653 :key #'keyword-arg.keyword)
1654 allow-other-keys (or allow-other-keys aok))))
1655 (values keywords allow-other-keys)))
1656
1657 (defun generic-function-keywords (generic-function)
1658 "Collect all keywords in the methods of GENERIC-FUNCTION.
1659 As a secondary value, return whether &allow-other-keys appears somewhere."
1660 (methods-keywords
1661 (swank-mop:generic-function-methods generic-function)))
1662
1663 (defun applicable-methods-keywords (generic-function classes)
1664 "Collect all keywords in the methods of GENERIC-FUNCTION that are
1665 applicable for argument of CLASSES. As a secondary value, return
1666 whether &allow-other-keys appears somewhere."
1667 (methods-keywords
1668 (swank-mop:compute-applicable-methods-using-classes
1669 generic-function classes)))
1670
1671 (defun decoded-arglist-to-template-string (decoded-arglist package &key (prefix "(") (suffix ")"))
1672 (with-output-to-string (*standard-output*)
1673 (with-standard-io-syntax
1674 (let ((*package* package) (*print-case* :downcase)
1675 (*print-pretty* t) (*print-circle* nil) (*print-readably* nil)
1676 (*print-level* 10) (*print-length* 20))
1677 (pprint-logical-block (nil nil :prefix prefix :suffix suffix)
1678 (print-decoded-arglist-as-template decoded-arglist))))))
1679
1680 (defun print-decoded-arglist-as-template (decoded-arglist)
1681 (let ((first-p t))
1682 (flet ((space ()
1683 (unless first-p
1684 (write-char #\space)
1685 (pprint-newline :fill))
1686 (setq first-p nil)))
1687 (dolist (arg (arglist.required-args decoded-arglist))
1688 (space)
1689 (princ arg))
1690 (dolist (arg (arglist.optional-args decoded-arglist))
1691 (space)
1692 (format t "[~A]" (optional-arg.arg-name arg)))
1693 (dolist (keyword-arg (arglist.keyword-args decoded-arglist))
1694 (space)
1695 (let ((arg-name (keyword-arg.arg-name keyword-arg))
1696 (keyword (keyword-arg.keyword keyword-arg)))
1697 (format t "~W ~A"
1698 (if (keywordp keyword) keyword `',keyword)
1699 arg-name)))
1700 (when (and (arglist.rest decoded-arglist)
1701 (or (not (arglist.keyword-args decoded-arglist))
1702 (arglist.allow-other-keys-p decoded-arglist)))
1703 (if (arglist.body-p decoded-arglist)
1704 (pprint-newline :mandatory)
1705 (space))
1706 (format t "~A..." (arglist.rest decoded-arglist)))))
1707 (pprint-newline :fill))
1708
1709 (defgeneric extra-keywords (operator &rest args)
1710 (:documentation "Return a list of extra keywords of OPERATOR (a
1711 symbol) when applied to the (unevaluated) ARGS.
1712 As a secondary value, return whether other keys are allowed.
1713 As a tertiary value, return the initial sublist of ARGS that was needed
1714 to determine the extra keywords."))
1715
1716 (defmethod extra-keywords (operator &rest args)
1717 ;; default method
1718 (declare (ignore args))
1719 (let ((symbol-function (symbol-function operator)))
1720 (if (typep symbol-function 'generic-function)
1721 (generic-function-keywords symbol-function)
1722 nil)))
1723
1724 (defmethod extra-keywords ((operator (eql 'make-instance))
1725 &rest args)
1726 (unless (null args)
1727 (let ((class-name-form (car args)))
1728 (when (and (listp class-name-form)
1729 (= (length class-name-form) 2)
1730 (eq (car class-name-form) 'quote))
1731 (let* ((class-name (cadr class-name-form))
1732 (class (find-class class-name nil)))
1733 (when (and class
1734 (not (swank-mop:class-finalized-p class)))
1735 ;; Try to finalize the class, which can fail if
1736 ;; superclasses are not defined yet
1737 (handler-case (swank-mop:finalize-inheritance class)
1738 (program-error (c)
1739 (declare (ignore c)))))
1740 (when class
1741 ;; We have the case (make-instance 'CLASS ...)
1742 ;; with a known CLASS.
1743 (multiple-value-bind (slots allow-other-keys-p)
1744 (if (swank-mop:class-finalized-p class)
1745 (values (swank-mop:class-slots class) nil)
1746 (values (swank-mop:class-direct-slots class) t))
1747 (let ((slot-init-keywords
1748 (loop for slot in slots append
1749 (mapcar (lambda (initarg)
1750 (make-keyword-arg
1751 initarg
1752 initarg ; FIXME
1753 (swank-mop:slot-definition-initform slot)))
1754 (swank-mop:slot-definition-initargs slot))))
1755 (initialize-instance-keywords
1756 (applicable-methods-keywords #'initialize-instance
1757 (list class))))
1758 (return-from extra-keywords
1759 (values (append slot-init-keywords
1760 initialize-instance-keywords)
1761 allow-other-keys-p
1762 (list class-name-form))))))))))
1763 (call-next-method))
1764
1765 (defun enrich-decoded-arglist-with-extra-keywords (decoded-arglist form)
1766 "Determine extra keywords from the function call FORM, and modify
1767 DECODED-ARGLIST to include them. As a secondary return value, return
1768 the initial sublist of ARGS that was needed to determine the extra
1769 keywords. As a tertiary return value, return whether any enrichment
1770 was done."
1771 (multiple-value-bind (extra-keywords extra-aok determining-args)
1772 (apply #'extra-keywords form)
1773 ;; enrich the list of keywords with the extra keywords
1774 (when extra-keywords
1775 (setf (arglist.key-p decoded-arglist) t)
1776 (setf (arglist.keyword-args decoded-arglist)
1777 (remove-duplicates
1778 (append (arglist.keyword-args decoded-arglist)
1779 extra-keywords)
1780 :key #'keyword-arg.keyword)))
1781 (setf (arglist.allow-other-keys-p decoded-arglist)
1782 (or (arglist.allow-other-keys-p decoded-arglist) extra-aok))
1783 (values decoded-arglist
1784 determining-args
1785 (or extra-keywords extra-aok))))
1786
1787 (defslimefun arglist-for-insertion (name)
1788 (with-buffer-syntax ()
1789 (let ((symbol (parse-symbol name)))
1790 (cond
1791 ((and symbol
1792 (valid-operator-name-p name))
1793 (let ((arglist (arglist symbol)))
1794 (etypecase arglist
1795 ((member :not-available)
1796 :not-available)
1797 (list
1798 (let ((decoded-arglist (decode-arglist arglist)))
1799 (enrich-decoded-arglist-with-extra-keywords decoded-arglist
1800 (list symbol))
1801 (decoded-arglist-to-template-string decoded-arglist
1802 *buffer-package*))))))
1803 (t
1804 :not-available)))))
1805
1806 (defvar *remove-keywords-alist*
1807 '((:test :test-not)
1808 (:test-not :test)))
1809
1810 (defun remove-actual-args (decoded-arglist actual-arglist)
1811 "Remove from DECODED-ARGLIST the arguments that have already been
1812 provided in ACTUAL-ARGLIST."
1813 (loop while (and actual-arglist
1814 (arglist.required-args decoded-arglist))
1815 do (progn (pop actual-arglist)
1816 (pop (arglist.required-args decoded-arglist))))
1817 (loop while (and actual-arglist
1818 (arglist.optional-args decoded-arglist))
1819 do (progn (pop actual-arglist)
1820 (pop (arglist.optional-args decoded-arglist))))
1821 (loop for keyword in actual-arglist by #'cddr
1822 for keywords-to-remove = (cdr (assoc keyword *remove-keywords-alist*))
1823 do (setf (arglist.keyword-args decoded-arglist)
1824 (remove-if (lambda (kw)
1825 (or (eql kw keyword)
1826 (member kw keywords-to-remove)))
1827 (arglist.keyword-args decoded-arglist)
1828 :key #'keyword-arg.keyword))))
1829
1830 (defgeneric form-completion (operator-form argument-forms &key remove-args))
1831
1832 (defmethod form-completion (operator-form argument-forms &key (remove-args t))
1833 (when (and (symbolp operator-form)
1834 (valid-operator-symbol-p operator-form))
1835 (let ((arglist (arglist operator-form)))
1836 (etypecase arglist
1837 ((member :not-available)
1838 :not-available)
1839 (list
1840 (let ((decoded-arglist (decode-arglist arglist)))
1841 (multiple-value-bind (decoded-arglist determining-args any-enrichment)
1842 (enrich-decoded-arglist-with-extra-keywords decoded-arglist
1843 (cons operator-form
1844 argument-forms))
1845 (cond
1846 (remove-args
1847 ;; get rid of formal args already provided
1848 (remove-actual-args decoded-arglist argument-forms))
1849 (t
1850 ;; replace some formal args by determining actual args
1851 (remove-actual-args decoded-arglist determining-args)
1852 (setf (arglist.required-args decoded-arglist)
1853 (append determining-args
1854 (arglist.required-args decoded-arglist)))))
1855 (return-from form-completion
1856 (values decoded-arglist any-enrichment))))))))
1857 :not-available)
1858
1859 (defmethod form-completion ((operator-form (eql 'defmethod))
1860 argument-forms &key (remove-args t))
1861 (when (and (listp argument-forms)
1862 (not (null argument-forms)) ;have generic function name
1863 (notany #'listp (rest argument-forms))) ;don't have arglist yet
1864 (let* ((gf-name (first argument-forms))
1865 (gf (and (or (symbolp gf-name)
1866 (and (listp gf-name)
1867 (eql (first gf-name) 'setf)))
1868 (fboundp gf-name)
1869 (fdefinition gf-name))))
1870 (when (typep gf 'generic-function)
1871 (let ((arglist (arglist gf)))
1872 (etypecase arglist
1873 ((member :not-available))
1874 (list
1875 (return-from form-completion
1876 (values (make-arglist :required-args (if remove-args
1877 (list arglist)
1878 (list gf-name arglist))
1879 :rest "body" :body-p t)
1880 t))))))))
1881 (call-next-method))
1882
1883 (defun read-incomplete-form-from-string (form-string)
1884 (with-buffer-syntax ()
1885 (handler-case
1886 (read-from-string form-string)
1887 (reader-error (c)
1888 (declare (ignore c))
1889 nil)
1890 (stream-error (c)
1891 (declare (ignore c))
1892 nil))))
1893
1894 (defslimefun complete-form (form-string)
1895 "Read FORM-STRING in the current buffer package, then complete it
1896 by adding a template for the missing arguments."
1897 (let ((form (read-incomplete-form-from-string form-string)))
1898 (when (consp form)
1899 (let ((operator-form (first form))
1900 (argument-forms (rest form)))
1901 (let ((form-completion
1902 (form-completion operator-form argument-forms)))
1903 (unless (eql form-completion :not-available)
1904 (return-from complete-form
1905 (decoded-arglist-to-template-string form-completion
1906 *buffer-package*
1907 :prefix ""))))))
1908 :not-available))
1909
1910 (defun format-arglist-for-echo-area (form operator-name
1911 &key print-right-margin highlight)
1912 "Return the arglist for FORM as a string."
1913 (when (consp form)
1914 (let ((operator-form (first form))
1915 (argument-forms (rest form)))
1916 (multiple-value-bind (form-completion any-enrichment)
1917 (form-completion operator-form argument-forms
1918 :remove-args nil)
1919 (cond
1920 ((eql form-completion :not-available)
1921 nil)
1922 ((not any-enrichment)
1923 ;; Just use the original arglist.
1924 ;; This works better for implementation-specific
1925 ;; lambda-list-keywords like CMUCL's &parse-body.
1926 (let ((arglist (arglist operator-form)))
1927 (etypecase arglist
1928 ((member :not-available)
1929 nil)
1930 (list
1931 (return-from format-arglist-for-echo-area
1932 (arglist-to-string (cons operator-name arglist)
1933 *package*
1934 :print-right-margin print-right-margin
1935 :highlight highlight))))))
1936 (t
1937 (return-from format-arglist-for-echo-area
1938 (arglist-to-string
1939 (cons operator-name
1940 (encode-arglist form-completion))
1941 *package*
1942 :print-right-margin print-right-margin
1943 :highlight highlight)))))))
1944 nil)
1945
1946 (defslimefun completions-for-keyword (name keyword-string)
1947 (with-buffer-syntax ()
1948 (let* ((form (operator-designator-to-form name))
1949 (operator-form (first form))
1950 (argument-forms (rest form))
1951 (arglist
1952 (form-completion operator-form argument-forms
1953 :remove-args nil)))
1954 (unless (eql arglist :not-available)
1955 (let* ((keywords
1956 (mapcar #'keyword-arg.keyword
1957 (arglist.keyword-args arglist)))
1958 (keyword-name
1959 (tokenize-symbol keyword-string))
1960 (matching-keywords
1961 (find-matching-symbols-in-list keyword-name keywords
1962 #'compound-prefix-match))
1963 (converter (output-case-converter keyword-string))
1964 (strings
1965 (mapcar converter
1966 (mapcar #'symbol-name matching-keywords)))
1967 (completion-set
1968 (format-completion-set strings nil "")))
1969 (list completion-set
1970 (longest-completion completion-set)))))))
1971
1972
1973
1974 ;;;; Recording and accessing results of computations
1975
1976 (defvar *record-repl-results* t
1977 "Non-nil means that REPL results are saved for later lookup.")
1978
1979 (defvar *object-to-presentation-id*
1980 (make-weak-key-hash-table :test 'eq)
1981 "Store the mapping of objects to numeric identifiers")
1982
1983 (defvar *presentation-id-to-object*
1984 (make-weak-value-hash-table :test 'eql)
1985 "Store the mapping of numeric identifiers to objects")
1986
1987 (defun clear-presentation-tables ()
1988 (clrhash *object-to-presentation-id*)
1989 (clrhash *presentation-id-to-object*))
1990
1991 (defvar *presentation-counter* 0 "identifier counter")
1992
1993 ;; XXX thread safety?
1994 (defun save-presented-object (object)
1995 "Save OBJECT and return the assigned id.
1996 If OBJECT was saved previously return the old id."
1997 (or (gethash object *object-to-presentation-id*)
1998 (let ((id (incf *presentation-counter*)))
1999 (setf (gethash id *presentation-id-to-object*) object)
2000 (setf (gethash object *object-to-presentation-id*) id)
2001 id)))
2002
2003 (defun lookup-presented-object (id)
2004 "Retrieve the object corresponding to ID.
2005 The secondary value indicates the absence of an entry."
2006 (gethash id *presentation-id-to-object*))
2007
2008 (defslimefun get-repl-result (id)
2009 "Get the result of the previous REPL evaluation with ID."
2010 (multiple-value-bind (object foundp) (lookup-presented-object id)
2011 (cond (foundp object)
2012 (t (error "Attempt to access unrecorded object (id ~D)." id)))))
2013
2014 (defslimefun clear-repl-results ()
2015 "Forget the results of all previous REPL evaluations."
2016 (clear-presentation-tables)
2017 t)
2018
2019
2020 ;;;; Evaluation
2021
2022 (defvar *pending-continuations* '()
2023 "List of continuations for Emacs. (thread local)")
2024
2025 (defun guess-buffer-package (string)
2026 "Return a package for STRING.
2027 Fall back to the the current if no such package exists."
2028 (or (guess-package-from-string string nil)
2029 *package*))
2030
2031 (defun eval-for-emacs (form buffer-package id)
2032 "Bind *BUFFER-PACKAGE* BUFFER-PACKAGE and evaluate FORM.
2033 Return the result to the continuation ID.
2034 Errors are trapped and invoke our debugger."
2035 (call-with-debugger-hook
2036 #'swank-debugger-hook
2037 (lambda ()
2038 (let (ok result)
2039 (unwind-protect
2040 (let ((*buffer-package* (guess-buffer-package buffer-package))
2041 (*buffer-readtable* (guess-buffer-readtable buffer-package))
2042 (*pending-continuations* (cons id *pending-continuations*)))
2043 (check-type *buffer-package* package)
2044 (check-type *buffer-readtable* readtable)
2045 ;; APPLY would be cleaner than EVAL.
2046 ;;(setq result (apply (car form) (cdr form)))
2047 (setq result (eval form))
2048 (finish-output)
2049 (run-hook *pre-reply-hook*)
2050 (setq ok t))
2051 (force-user-output)
2052 (send-to-emacs `(:return ,(current-thread)
2053 ,(if ok `(:ok ,result) '(:abort))
2054 ,id)))))))
2055
2056 (defvar *echo-area-prefix* "=> "
2057 "A prefix that `format-values-for-echo-area' should use.")
2058
2059 (defun format-values-for-echo-area (values)
2060 (with-buffer-syntax ()
2061 (let ((*print-readably* nil))
2062 (cond ((null values) "; No value")
2063 ((and (null (cdr values)) (integerp (car values)))
2064 (let ((i (car values)))
2065 (format nil "~A~D (#x~X, #o~O, #b~B)"
2066 *echo-area-prefix* i i i i)))
2067 (t (format nil "~A~{~S~^, ~}" *echo-area-prefix* values))))))
2068
2069 (defslimefun interactive-eval (string)
2070 (with-buffer-syntax ()
2071 (let ((values (multiple-value-list (eval (from-string string)))))
2072 (fresh-line)
2073 (finish-output)
2074 (format-values-for-echo-area values))))
2075
2076 (defslimefun eval-and-grab-output (string)
2077 (with-buffer-syntax ()
2078 (let* ((s (make-string-output-stream))
2079 (*standard-output* s)
2080 (values (multiple-value-list (eval (from-string string)))))
2081 (list (get-output-stream-string s)
2082 (format nil "~{~S~^~%~}" values)))))
2083
2084 ;;; XXX do we need this stuff? What is it good for?
2085 (defvar *slime-repl-advance-history* nil
2086 "In the dynamic scope of a single form typed at the repl, is set to nil to
2087 prevent the repl from advancing the history - * ** *** etc.")
2088
2089 (defvar *slime-repl-suppress-output* nil
2090 "In the dynamic scope of a single form typed at the repl, is set to nil to
2091 prevent the repl from printing the result of the evalation.")
2092
2093 (defvar *slime-repl-eval-hook-pass* (gensym "PASS")
2094 "Token to indicate that a repl hook declines to evaluate the form")
2095
2096 (defvar *slime-repl-eval-hooks* nil
2097 "A list of functions. When the repl is about to eval a form, first try running each of
2098 these hooks. The first hook which returns a value which is not *slime-repl-eval-hook-pass*
2099 is considered a replacement for calling eval. If there are no hooks, or all
2100 pass, then eval is used.")
2101
2102 (defslimefun repl-eval-hook-pass ()
2103 "call when repl hook declines to evaluate the form"
2104 (throw *slime-repl-eval-hook-pass* *slime-repl-eval-hook-pass*))
2105
2106 (defslimefun repl-suppress-output ()
2107 "In the dynamic scope of a single form typed at the repl, call to
2108 prevent the repl from printing the result of the evalation."
2109 (setq *slime-repl-suppress-output* t))
2110
2111 (defslimefun repl-suppress-advance-history ()
2112 "In the dynamic scope of a single form typed at the repl, call to
2113 prevent the repl from advancing the history - * ** *** etc."
2114 (setq *slime-repl-advance-history* nil))
2115
2116 (defun eval-region (string &optional package-update-p)
2117 "Evaluate STRING and return the result.
2118 If PACKAGE-UPDATE-P is non-nil, and evaluation causes a package
2119 change, then send Emacs an update."
2120 (unwind-protect
2121 (with-input-from-string (stream string)
2122 (let (- values)
2123 (loop
2124 (let ((form (read stream nil stream)))
2125 (when (eq form stream)
2126 (fresh-line)
2127 (finish-output)
2128 (return (values values -)))
2129 (setq - form)
2130 (if *slime-repl-eval-hooks*
2131 (setq values (run-repl-eval-hooks form))
2132 (setq values (multiple-value-list (eval form))))
2133 (finish-output)))))
2134 (when (and package-update-p (not (eq *package* *buffer-package*)))
2135 (send-to-emacs
2136 (list :new-package (package-name *package*)
2137 (package-string-for-prompt *package*))))))
2138
2139 (defun run-repl-eval-hooks (form)
2140 (loop for hook in *slime-repl-eval-hooks*
2141 for res = (catch *slime-repl-eval-hook-pass*
2142 (multiple-value-list (funcall hook form)))
2143 until (not (eq res *slime-repl-eval-hook-pass*))
2144 finally (return
2145 (if (eq res *slime-repl-eval-hook-pass*)
2146 (multiple-value-list (eval form))
2147 res))))
2148
2149 (defun package-string-for-prompt (package)
2150 "Return the shortest nickname (or canonical name) of PACKAGE."
2151 (princ-to-string
2152 (make-symbol
2153 (or (canonical-package-nickname package)
2154 (auto-abbreviated-package-name package)
2155 (shortest-package-nickname package)))))
2156
2157 (defun canonical-package-nickname (package)
2158 "Return the canonical package nickname, if any, of PACKAGE."
2159 (let ((name (cdr (assoc (package-name package) *canonical-package-nicknames*
2160 :test #'string=))))
2161 (and name (string name))))
2162
2163 (defun auto-abbreviated-package-name (package)
2164 "Return an abbreviated 'name' for PACKAGE.
2165
2166 N.B. this is not an actual package name or nickname."
2167 (when *auto-abbreviate-dotted-packages*
2168 (let ((last-dot (position #\. (package-name package) :from-end t)))
2169 (when last-dot (subseq (package-name package) (1+ last-dot))))))
2170
2171 (defun shortest-package-nickname (package)
2172 "Return the shortest nickname (or canonical name) of PACKAGE."
2173 (loop for name in (cons (package-name package) (package-nicknames package))
2174 for shortest = name then (if (< (length name) (length shortest))
2175 name
2176 shortest)
2177 finally (return shortest)))
2178
2179 (defslimefun interactive-eval-region (string)
2180 (with-buffer-syntax ()
2181 (format-values-for-echo-area (eval-region string))))
2182
2183 (defslimefun re-evaluate-defvar (form)
2184 (with-buffer-syntax ()
2185 (let ((form (read-from-string form)))
2186 (destructuring-bind (dv name &optional value doc) form
2187 (declare (ignore value doc))
2188 (assert (eq dv 'defvar))
2189 (makunbound name)
2190 (prin1-to-string (eval form))))))
2191
2192 (defvar *swank-pprint-bindings*
2193 `((*print-pretty* . t)
2194 (*print-level* . nil)
2195 (*print-length* . nil)
2196 (*print-circle* . t)
2197 (*print-gensym* . t)
2198 (*print-readably* . nil))
2199 "A list of variables bindings during pretty printing.
2200 Used by pprint-eval.")
2201
2202 (defun swank-pprint (list)
2203 "Bind some printer variables and pretty print each object in LIST."
2204 (with-buffer-syntax ()
2205 (with-bindings *swank-pprint-bindings*
2206 (cond ((null list) "; No value")
2207 (t (with-output-to-string (*standard-output*)
2208 (dolist (o list)
2209 (pprint o)
2210 (terpri))))))))
2211
2212 (defslimefun pprint-eval (string)
2213 (with-buffer-syntax ()
2214 (swank-pprint (multiple-value-list (eval (read-from-string string))))))
2215
2216 (defslimefun set-package (package)
2217 "Set *package* to PACKAGE.
2218 Return its name and the string to use in the prompt."
2219 (let ((p (setq *package* (guess-package-from-string package))))
2220 (list (package-name p) (package-string-for-prompt p))))
2221
2222 (defslimefun listener-eval (string)
2223 (clear-user-input)
2224 (with-buffer-syntax ()
2225 (let ((*slime-repl-suppress-output* :unset)
2226 (*slime-repl-advance-history* :unset))
2227 (multiple-value-bind (values last-form) (eval-region string t)
2228 (unless (or (and (eq values nil) (eq last-form nil))
2229 (eq *slime-repl-advance-history* nil))
2230 (setq *** ** ** * * (car values)
2231 /// // // / / values))
2232 (setq +++ ++ ++ + + last-form)
2233 (cond ((eq *slime-repl-suppress-output* t) '(:suppress-output))
2234 (*record-repl-results*
2235 `(:present ,(loop for x in values
2236 collect (cons (prin1-to-string x)
2237 (save-presented-object x)))))
2238 (t
2239 `(:values ,(mapcar #'prin1-to-string values))))))))
2240
2241 (defslimefun ed-in-emacs (&optional what)
2242 "Edit WHAT in Emacs.
2243
2244 WHAT can be:
2245 A pathname or a string,
2246 A list (PATHNAME-OR-STRING LINE [COLUMN]),
2247 A function name (symbol or cons),
2248 NIL.
2249
2250 Returns true if it actually called emacs, or NIL if not."
2251 (flet ((pathname-or-string-p (thing)
2252 (or (pathnamep thing) (typep thing 'string))))
2253 (let ((target
2254 (cond ((and (listp what) (pathname-or-string-p (first what)))
2255 (cons (canonicalize-filename (car what)) (cdr what)))
2256 ((pathname-or-string-p what)
2257 (canonicalize-filename what))
2258 ((symbolp what) what)
2259 ((consp what) what)
2260 (t (return-from ed-in-emacs nil)))))
2261 (cond
2262 (*emacs-connection* (send-oob-to-emacs `(:ed ,target)))
2263 ((default-connection)
2264 (with-connection ((default-connection))
2265 (send-oob-to-emacs `(:ed ,target))))
2266 (t nil)))))
2267
2268 (defslimefun value-for-editing (form)
2269 "Return a readable value of FORM for editing in Emacs.
2270 FORM is expected, but not required, to be SETF'able."
2271 ;; FIXME: Can we check FORM for setfability? -luke (12/Mar/2005)
2272 (with-buffer-syntax ()
2273 (prin1-to-string (eval (read-from-string form)))))
2274
2275 (defslimefun commit-edited-value (form value)
2276 "Set the value of a setf'able FORM to VALUE.
2277 FORM and VALUE are both strings from Emacs."
2278 (with-buffer-syntax ()
2279 (eval `(setf ,(read-from-string form)
2280 ,(read-from-string (concatenate 'string "`" value))))
2281 t))
2282
2283 (defun background-message (format-string &rest args)
2284 "Display a message in Emacs' echo area.
2285
2286 Use this function for informative messages only. The message may even
2287 be dropped, if we are too busy with other things."
2288 (when *emacs-connection*
2289 (send-to-emacs `(:background-message
2290 ,(apply #'format nil format-string args)))))
2291
2292
2293 ;;;; Debugger
2294
2295 (defun swank-debugger-hook (condition hook)
2296 "Debugger function for binding *DEBUGGER-HOOK*.
2297 Sends a message to Emacs declaring that the debugger has been entered,
2298 then waits to handle further requests from Emacs. Eventually returns
2299 after Emacs causes a restart to be invoked."
2300 (declare (ignore hook))
2301 (cond (*emacs-connection*
2302 (debug-in-emacs condition))
2303 ((default-connection)
2304 (with-connection ((default-connection))
2305 (debug-in-emacs condition)))))
2306
2307 (defvar *global-debugger* t
2308 "Non-nil means the Swank debugger hook will be installed globally.")
2309
2310 (add-hook *new-connection-hook* 'install-debugger)
2311 (defun install-debugger (connection)
2312 (declare (ignore connection))
2313 (when *global-debugger*
2314 (install-debugger-globally #'swank-debugger-hook)))
2315
2316 ;;;;; Debugger loop
2317 ;;;
2318 ;;; These variables are dynamically bound during debugging.
2319 ;;;
2320 (defvar *swank-debugger-condition* nil
2321 "The condition being debugged.")
2322
2323 (defvar *sldb-level* 0
2324 "The current level of recursive debugging.")
2325
2326 (defvar *sldb-initial-frames* 20
2327 "The initial number of backtrace frames to send to Emacs.")
2328
2329 (defvar *sldb-restarts* nil
2330 "The list of currenlty active restarts.")
2331
2332 (defvar *sldb-stepping-p* nil
2333 "True when during execution of a stepp command.")
2334
2335 (defun debug-in-emacs (condition)
2336 (let ((*swank-debugger-condition* condition)
2337 (*sldb-restarts* (compute-restarts condition))
2338 (*package* (or (and (boundp '*buffer-package*)
2339 (symbol-value '*buffer-package*))
2340 *package*))
2341 (*sldb-level* (1+ *sldb-level*))
2342 (*sldb-stepping-p* nil)
2343 (*swank-state-stack* (cons :swank-debugger-hook *swank-state-stack*)))
2344 (force-user-output)
2345 (with-bindings *sldb-printer-bindings*
2346 (call-with-debugging-environment
2347 (lambda () (sldb-loop *sldb-level*))))))
2348
2349 (defun sldb-loop (level)
2350 (unwind-protect
2351 (catch 'sldb-enter-default-debugger
2352 (send-to-emacs
2353 (list* :debug (current-thread) level
2354 (debugger-info-for-emacs 0 *sldb-initial-frames*)))
2355 (loop (catch 'sldb-loop-catcher
2356 (with-simple-restart (abort "Return to sldb level ~D." level)
2357 (send-to-emacs (list :debug-activate (current-thread)
2358 level))
2359 (handler-bind ((sldb-condition #'handle-sldb-condition))
2360 (read-from-emacs))))))
2361 (send-to-emacs `(:debug-return
2362 ,(current-thread) ,level ,*sldb-stepping-p*))))
2363
2364 (defun handle-sldb-condition (condition)
2365 "Handle an internal debugger condition.
2366 Rather than recursively debug the debugger (a dangerous idea!), these
2367 conditions are simply reported."
2368 (let ((real-condition (original-condition condition)))
2369 (send-to-emacs `(:debug-condition ,(current-thread)
2370 ,(princ-to-string real-condition))))
2371 (throw 'sldb-loop-catcher nil))
2372
2373 (defun safe-condition-message (condition)
2374 "Safely print condition to a string, handling any errors during
2375 printing."
2376 (let ((*print-pretty* t))
2377 (handler-case
2378 (format-sldb-condition condition)
2379 (error (cond)
2380 ;; Beware of recursive errors in printing, so only use the condition
2381 ;; if it is printable itself:
2382 (format nil "Unable to display error condition~@[: ~A~]"
2383 (ignore-errors (princ-to-string cond)))))))
2384
2385 (defun debugger-condition-for-emacs ()
2386 (list (safe-condition-message *swank-debugger-condition*)
2387 (format nil " [Condition of type ~S]"
2388 (type-of *swank-debugger-condition*))
2389 (condition-references *swank-debugger-condition*)
2390 (condition-extras *swank-debugger-condition*)))
2391
2392 (defun format-restarts-for-emacs ()
2393 "Return a list of restarts for *swank-debugger-condition* in a
2394 format suitable for Emacs."
2395 (loop for restart in *sldb-restarts*
2396 collect (list (princ-to-string (restart-name restart))
2397 (princ-to-string restart))))
2398
2399 (defun frame-for-emacs (n frame)
2400 (let* ((label (format nil " ~2D: " n))
2401 (string (with-output-to-string (stream)
2402 (princ label stream)
2403 (print-frame frame stream))))
2404 (subseq string (length label))))
2405
2406 ;;;;; SLDB entry points
2407
2408 (defslimefun sldb-break-with-default-debugger ()
2409 "Invoke the default debugger by returning from our debugger-loop."
2410 (throw 'sldb-enter-default-debugger nil))
2411
2412 (defslimefun backtrace (start end)
2413 "Return a list ((I FRAME) ...) of frames from START to END.
2414 I is an integer describing and FRAME a string."
2415 (loop for frame in (compute-backtrace start end)
2416 for i from start
2417 collect (list i (frame-for-emacs i frame))))
2418
2419 (defslimefun debugger-info-for-emacs (start end)
2420 "Return debugger state, with stack frames from START to END.
2421 The result is a list:
2422 (condition ({restart}*) ({stack-frame}*) (cont*))
2423 where
2424 condition ::= (description type [extra])
2425 restart ::= (name description)
2426 stack-frame ::= (number description)
2427 extra ::= (:references and other random things)
2428 cont ::= continutation
2429 condition---a pair of strings: message, and type. If show-source is
2430 not nil it is a frame number for which the source should be displayed.
2431
2432 restart---a pair of strings: restart name, and description.
2433
2434 stack-frame---a number from zero (the top), and a printed
2435 representation of the frame's call.
2436
2437 continutation---the id of a pending Emacs continuation.
2438
2439 Below is an example return value. In this case the condition was a
2440 division by zero (multi-line description), and only one frame is being
2441 fetched (start=0, end=1).
2442
2443 ((\"Arithmetic error DIVISION-BY-ZERO signalled.
2444 Operation was KERNEL::DIVISION, operands (1 0).\"
2445 \"[Condition of type DIVISION-BY-ZERO]\")
2446 ((\"ABORT\" \"Return to Slime toplevel.\")
2447 (\"ABORT\" \"Return to Top-Level.\"))
2448 ((0 \"(KERNEL::INTEGER-/-INTEGER 1 0)\"))
2449 (4))"
2450 (list (debugger-condition-for-emacs)
2451 (format-restarts-for-emacs)
2452 (backtrace start end)
2453 *pending-continuations*))
2454
2455 (defun nth-restart (index)
2456 (nth index *sldb-restarts*))
2457
2458 (defslimefun invoke-nth-restart (index)
2459 (invoke-restart-interactively (nth-restart index)))
2460
2461 (defslimefun sldb-abort ()
2462 (invoke-restart (find 'abort *sldb-restarts* :key #'restart-name)))
2463
2464 (defslimefun sldb-continue ()
2465 (continue))
2466
2467 (defslimefun throw-to-toplevel ()
2468 "Invoke the ABORT-REQUEST restart abort an RPC from Emacs.
2469 If we are not evaluating an RPC then ABORT instead."
2470 (let ((restart (find-restart 'abort-request)))
2471 (cond (restart (invoke-restart restart))
2472 (t "Restart not found: ABORT-REQUEST"))))
2473
2474 (defslimefun invoke-nth-restart-for-emacs (sldb-level n)
2475 "Invoke the Nth available restart.
2476 SLDB-LEVEL is the debug level when the request was made. If this
2477 has changed, ignore the request."
2478 (when (= sldb-level *sldb-level*)
2479 (invoke-nth-restart n)))
2480
2481 (defun wrap-sldb-vars (form)
2482 `(let ((*sldb-level* ,*sldb-level*))
2483 ,form))
2484
2485 (defslimefun eval-string-in-frame (string index)
2486 (to-string (eval-in-frame (wrap-sldb-vars (from-string string))
2487 index)))
2488
2489 (defslimefun pprint-eval-string-in-frame (string index)
2490 (swank-pprint
2491 (multiple-value-list
2492 (eval-in-frame (wrap-sldb-vars (from-string string)) index))))
2493
2494 (defslimefun frame-locals-for-emacs (index)
2495 "Return a property list ((&key NAME ID VALUE) ...) describing
2496 the local variables in the frame INDEX."
2497 (mapcar (lambda (frame-locals)
2498 (destructuring-bind (&key name id value) frame-locals
2499 (list :name (prin1-to-string name) :id id
2500 :value (to-string value))))
2501 (frame-locals index)))
2502
2503 (defslimefun frame-catch-tags-for-emacs (frame-index)
2504 (mapcar #'to-string (frame-catch-tags frame-index)))
2505
2506 (defslimefun sldb-disassemble (index)
2507 (with-output-to-string (*standard-output*)
2508 (disassemble-frame index)))
2509
2510 (defslimefun sldb-return-from-frame (index string)
2511 (let ((form (from-string string)))
2512 (to-string (multiple-value-list (return-from-frame index form)))))
2513
2514 (defslimefun sldb-break (name)
2515 (with-buffer-syntax ()
2516 (sldb-break-at-start (read-from-string name))))
2517
2518 (defslimefun sldb-step (frame)
2519 (cond ((find-restart 'continue)
2520 (activate-stepping frame)
2521 (setq *sldb-stepping-p* t)
2522 (continue))
2523 (t
2524 (error "No continue restart."))))
2525
2526
2527 ;;;; Compilation Commands.
2528
2529 (defvar *compiler-notes* '()
2530 "List of compiler notes for the last compilation unit.")
2531
2532 (defun clear-compiler-notes ()
2533 (setf *compiler-notes* '()))
2534
2535 (defun canonicalize-filename (filename)
2536 (namestring (truename filename)))
2537
2538 (defslimefun compiler-notes-for-emacs ()
2539 "Return the list of compiler notes for the last compilation unit."
2540 (reverse *compiler-notes*))
2541
2542 (defun measure-time-interval (fn)
2543 "Call FN and return the first return value and the elapsed time.
2544 The time is measured in microseconds."
2545 (declare (type function fn))
2546 (let ((before (get-internal-real-time)))
2547 (values
2548 (funcall fn)
2549 (* (- (get-internal-real-time) before)
2550 (/ 1000000 internal-time-units-per-second)))))
2551
2552 (defun record-note-for-condition (condition)
2553 "Record a note for a compiler-condition."
2554 (push (make-compiler-note condition) *compiler-notes*))
2555
2556 (defun make-compiler-note (condition)
2557 "Make a compiler note data structure from a compiler-condition."
2558 (declare (type compiler-condition condition))
2559 (list* :message (message condition)
2560 :severity (severity condition)
2561 :location (location condition)
2562 :references (references condition)
2563 (let ((s (short-message condition)))
2564 (if s (list :short-message s)))))
2565
2566 (defun swank-compiler (function)
2567 (clear-compiler-notes)
2568 (with-simple-restart (abort "Abort SLIME compilation.")
2569 (multiple-value-bind (result usecs)
2570 (handler-bind ((compiler-condition #'record-note-for-condition))
2571 (measure-time-interval function))
2572 (list (to-string result)
2573 (format nil "~,2F" (/ usecs 1000000.0))))))
2574
2575 (defslimefun compile-file-for-emacs (filename load-p &optional external-format)
2576 "Compile FILENAME and, when LOAD-P, load the result.
2577 Record compiler notes signalled as `compiler-condition's."
2578 (with-buffer-syntax ()
2579 (let ((*compile-print* nil))
2580 (swank-compiler (lambda () (swank-compile-file filename load-p
2581 external-format))))))
2582
2583 (defslimefun compile-string-for-emacs (string buffer position directory)
2584 "Compile STRING (exerpted from BUFFER at POSITION).
2585 Record compiler notes signalled as `compiler-condition's."
2586 (with-buffer-syntax ()
2587 (swank-compiler
2588 (lambda ()
2589 (let ((*compile-print* nil) (*compile-verbose* t))
2590 (swank-compile-string string :buffer buffer :position position
2591 :directory directory))))))
2592
2593 (defslimefun operate-on-system-for-emacs (system-name operation &rest keywords)
2594 "Compile and load SYSTEM using ASDF.
2595 Record compiler notes signalled as `compiler-condition's."
2596 (swank-compiler
2597 (lambda ()
2598 (apply #'operate-on-system system-name operation keywords))))
2599
2600 (defun asdf-central-registry ()
2601 (when (find-package :asdf)
2602 (symbol-value (find-symbol (string :*central-registry*) :asdf))))
2603
2604 (defslimefun list-all-systems-in-central-registry ()
2605 "Returns a list of all systems in ASDF's central registry."
2606 (delete-duplicates
2607 (loop for dir in (asdf-central-registry)
2608 for defaults = (eval dir)
2609 when defaults
2610 nconc (mapcar #'file-namestring
2611 (directory
2612 (make-pathname :defaults defaults
2613 :version :newest
2614 :type "asd"
2615 :name :wild
2616 :case :local))))
2617 :test #'string=))
2618
2619 (defun file-newer-p (new-file old-file)
2620 "Returns true if NEW-FILE is newer than OLD-FILE."
2621 (> (file-write-date new-file) (file-write-date old-file)))
2622
2623 (defun requires-compile-p (source-file)
2624 (let ((fasl-file (probe-file (compile-file-pathname source-file))))
2625 (or (not fasl-file)
2626 (file-newer-p source-file fasl-file))))
2627
2628 (defslimefun compile-file-if-needed (filename loadp)
2629 (cond ((requires-compile-p filename)
2630 (compile-file-for-emacs filename loadp))
2631 (loadp
2632 (load (compile-file-pathname filename))
2633 nil)))
2634
2635
2636 ;;;; Loading
2637
2638 (defslimefun load-file (filename)
2639 (to-string (load filename)))
2640
2641 (defslimefun load-file-set-package (filename &optional package)
2642 (load-file filename)
2643 (if package
2644 (set-package package)))
2645
2646
2647 ;;;; Macroexpansion
2648
2649 (defvar *macroexpand-printer-bindings*
2650 '((*print-circle* . nil)
2651 (*print-pretty* . t)
2652 (*print-escape* . t)
2653 (*print-level* . nil)
2654 (*print-length* . nil)))
2655
2656 (defun apply-macro-expander (expander string)
2657 (declare (type function expander))
2658 (with-buffer-syntax ()
2659 (with-bindings *macroexpand-printer-bindings*
2660 (prin1-to-string (funcall expander (from-string string))))))
2661
2662 (defslimefun swank-macroexpand-1 (string)
2663 (apply-macro-expander #'macroexpand-1 string))
2664
2665 (defslimefun swank-macroexpand (string)
2666 (apply-macro-expander #'macroexpand string))
2667
2668 (defslimefun swank-macroexpand-all (string)
2669 (apply-macro-expander #'macroexpand-all string))
2670
2671 (defslimefun swank-compiler-macroexpand-1 (string)
2672 (apply-macro-expander #'compiler-macroexpand-1 string))
2673
2674 (defslimefun swank-compiler-macroexpand (string)
2675 (apply-macro-expander #'compiler-macroexpand string))
2676
2677 (defslimefun disassemble-symbol (name)
2678 (with-buffer-syntax ()
2679 (with-output-to-string (*standard-output*)
2680 (let ((*print-readably* nil))
2681 (disassemble (fdefinition (from-string name)))))))
2682
2683
2684 ;;;; Basic completion
2685
2686 (defslimefun completions (string default-package-name)
2687 "Return a list of completions for a symbol designator STRING.
2688
2689 The result is the list (COMPLETION-SET
2690 COMPLETED-PREFIX). COMPLETION-SET is the list of all matching
2691 completions, and COMPLETED-PREFIX is the best (partial)
2692 completion of the input string.
2693
2694 If STRING is package qualified the result list will also be
2695 qualified. If string is non-qualified the result strings are
2696 also not qualified and are considered relative to
2697 DEFAULT-PACKAGE-NAME.
2698
2699 The way symbols are matched depends on the symbol designator's
2700 format. The cases are as follows:
2701 FOO - Symbols with matching prefix and accessible in the buffer package.
2702 PKG:FOO - Symbols with matching prefix and external in package PKG.
2703 PKG::FOO - Symbols with matching prefix and accessible in package PKG."
2704 (let ((completion-set (completion-set string default-package-name
2705 #'compound-prefix-match)))
2706 (list completion-set (longest-completion completion-set))))
2707
2708 (defslimefun simple-completions (string default-package-name)
2709 "Return a list of completions for a symbol designator STRING."
2710 (let ((completion-set (completion-set string default-package-name
2711 #'prefix-match-p)))
2712 (list completion-set (longest-common-prefix completion-set))))
2713
2714 ;;;;; Find completion set
2715
2716 (defun completion-set (string default-package-name matchp)
2717 "Return the set of completion-candidates as strings."
2718 (multiple-value-bind (name package-name package internal-p)
2719 (parse-completion-arguments string default-package-name)
2720 (let* ((symbols (and package
2721 (find-matching-symbols name
2722 package
2723 (and (not internal-p)
2724 package-name)
2725 matchp)))
2726 (packs (and (not package-name)
2727 (find-matching-packages name matchp)))
2728 (converter (output-case-converter name))
2729 (strings
2730 (mapcar converter
2731 (nconc (mapcar #'symbol-name symbols) packs))))
2732 (format-completion-set strings internal-p package-name))))
2733
2734 (defun find-matching-symbols (string package external test)
2735 "Return a list of symbols in PACKAGE matching STRING.
2736 TEST is called with two strings. If EXTERNAL is true, only external
2737 symbols are returned."
2738 (let ((completions '())
2739 (converter (output-case-converter string)))
2740 (flet ((symbol-matches-p (symbol)
2741 (and (or (not external)
2742 (symbol-external-p symbol package))
2743 (funcall test string
2744 (funcall converter (symbol-name symbol))))))
2745 (do-symbols (symbol package)
2746 (when (symbol-matches-p symbol)
2747 (push symbol completions))))
2748 (remove-duplicates completions)))
2749
2750 (defun find-matching-symbols-in-list (string list test)
2751 "Return a list of symbols in LIST matching STRING.
2752 TEST is called with two strings."
2753 (let ((completions '())
2754 (converter (output-case-converter string)))
2755 (flet ((symbol-matches-p (symbol)
2756 (funcall test string
2757 (funcall converter (symbol-name symbol)))))
2758 (dolist (symbol list)
2759 (when (symbol-matches-p symbol)
2760 (push symbol completions))))
2761 (remove-duplicates completions)))
2762
2763 (defun symbol-external-p (symbol &optional (package (symbol-package symbol)))
2764 "True if SYMBOL is external in PACKAGE.
2765 If PACKAGE is not specified, the home package of SYMBOL is used."
2766 (and package
2767 (eq (nth-value 1 (find-symbol (symbol-name symbol) package))
2768 :external)))
2769
2770 (defun find-matching-packages (name matcher)
2771 "Return a list of package names matching NAME with MATCHER.
2772 MATCHER is a two-argument predicate."
2773 (let ((to-match (string-upcase name)))
2774 (remove-if-not (lambda (x) (funcall matcher to-match x))
2775 (mapcar (lambda (pkgname)
2776 (concatenate 'string pkgname ":"))
2777 (loop for package in (list-all-packages)
2778 collect (package-name package)
2779 append (package-nicknames package))))))
2780
2781 (defun parse-completion-arguments (string default-package-name)
2782 "Parse STRING as a symbol designator.
2783 Return these values:
2784 SYMBOL-NAME
2785 PACKAGE-NAME, or nil if the designator does not include an explicit package.
2786 PACKAGE, the package to complete in
2787 INTERNAL-P, if the symbol is qualified with `::'."
2788 (multiple-value-bind (name package-name internal-p)
2789 (tokenize-symbol string)
2790 (let ((package (carefully-find-package package-name default-package-name)))
2791 (values name package-name package internal-p))))
2792
2793 (defun carefully-find-package (name default-package-name)
2794 "Find the package with name NAME, or DEFAULT-PACKAGE-NAME, or the
2795 *buffer-package*. NAME and DEFAULT-PACKAGE-NAME can be nil."
2796 (let ((string (cond ((equal name "") "KEYWORD")
2797 (t (or name default-package-name)))))
2798 (if string
2799 (guess-package-from-string string nil)
2800 *buffer-package*)))
2801
2802 ;;;;; Format completion results
2803 ;;;
2804 ;;; We try to format results in the case as inputs. If you complete
2805 ;;; `FOO' then your result should include `FOOBAR' rather than
2806 ;;; `foobar'.
2807
2808 (defun format-completion-set (strings internal-p package-name)
2809 "Format a set of completion strings.
2810 Returns a list of completions with package qualifiers if needed."
2811 (mapcar (lambda (string)
2812 (format-completion-result string internal-p package-name))
2813 (sort strings #'string<)))
2814
2815 (defun format-completion-result (string internal-p package-name)
2816 (let ((prefix (cond (internal-p (format nil "~A::" package-name))
2817 (package-name (format nil "~A:" package-name))
2818 (t ""))))
2819 (values (concatenate 'string prefix string)
2820 (length prefix))))
2821
2822 (defun output-case-converter (input)
2823 "Return a function to case convert strings for output.
2824 INPUT is used to guess the preferred case."
2825 (ecase (readtable-case *readtable*)
2826 (:upcase (if (some #'lower-case-p input) #'string-downcase #'identity))
2827 (:invert (lambda (output)
2828 (multiple-value-bind (lower upper) (determine-case output)
2829 (cond ((and lower upper) output)
2830 (lower (string-upcase output))
2831 (upper (string-downcase output))
2832 (t output)))))
2833 (:downcase (if (some #'upper-case-p input) #'string-upcase #'identity))
2834 (:preserve #'identity)))
2835
2836 (defun determine-case (string)
2837 "Return two booleans LOWER and UPPER indicating whether STRING
2838 contains lower or upper case characters."
2839 (values (some #'lower-case-p string)
2840 (some #'upper-case-p string)))
2841
2842
2843 ;;;;; Compound-prefix matching
2844
2845 (defun compound-prefix-match (prefix target)
2846 "Return true if PREFIX is a compound-prefix of TARGET.
2847 Viewing each of PREFIX and TARGET as a series of substrings delimited
2848 by hyphens, if each substring of PREFIX is a prefix of the
2849 corresponding substring in TARGET then we call PREFIX a
2850 compound-prefix of TARGET.
2851
2852 Examples:
2853 \(compound-prefix-match \"foo\" \"foobar\") => t
2854 \(compound-prefix-match \"m--b\" \"multiple-value-bind\") => t
2855 \(compound-prefix-match \"m-v-c\" \"multiple-value-bind\") => NIL"
2856 (declare (type simple-string prefix target))
2857 (loop for ch across prefix
2858 with tpos = 0
2859 always (and (< tpos (length target))
2860 (if (char= ch #\-)
2861 (setf tpos (position #\- target :start tpos))
2862 (char= ch (aref target tpos))))
2863 do (incf tpos)))
2864
2865 (defun prefix-match-p (prefix string)
2866 "Return true if PREFIX is a prefix of STRING."
2867 (not (mismatch prefix string :end2 (min (length string) (length prefix)))))
2868
2869
2870 ;;;;; Extending the input string by completion
2871
2872 (defun longest-completion (completions)
2873 "Return the longest prefix for all COMPLETIONS.
2874 COMPLETIONS is a list of strings."
2875 (untokenize-completion
2876 (mapcar #'longest-common-prefix
2877 (transpose-lists (mapcar #'tokenize-completion completions)))))
2878
2879 (defun tokenize-completion (string)
2880 "Return all substrings of STRING delimited by #\-."
2881 (loop with end
2882 for start = 0 then (1+ end)
2883 until (> start (length string))
2884 do (setq end (or (position #\- string :start start) (length string)))
2885 collect (subseq string start end)))
2886
2887 (defun untokenize-completion (tokens)
2888 (format nil "~{~A~^-~}" tokens))
2889
2890 (defun longest-common-prefix (strings)
2891 "Return the longest string that is a common prefix of STRINGS."
2892 (if (null strings)
2893 ""
2894 (flet ((common-prefix (s1 s2)
2895 (let ((diff-pos (mismatch s1 s2)))
2896 (if diff-pos (subseq s1 0 diff-pos) s1))))
2897 (reduce #'common-prefix strings))))
2898
2899 (defun transpose-lists (lists)
2900 "Turn a list-of-lists on its side.
2901 If the rows are of unequal length, truncate uniformly to the shortest.
2902
2903 For example:
2904 \(transpose-lists '((ONE TWO THREE) (1 2)))
2905 => ((ONE 1) (TWO 2))"
2906 (cond ((null lists) '())
2907 ((some #'null lists) '())
2908 (t (cons (mapcar #'car lists)
2909 (transpose-lists (mapcar #'cdr lists))))))
2910
2911
2912 ;;;;; Completion Tests
2913
2914 (defpackage :swank-completion-test
2915 (:use))
2916
2917 (let ((*readtable* (copy-readtable *readtable*))
2918 (p (find-package :swank-completion-test)))
2919 (intern "foo" p)
2920 (intern "Foo" p)
2921 (intern "FOO" p)
2922 (setf (readtable-case *readtable*) :invert)
2923 (flet ((names (prefix)
2924 (sort (mapcar #'symbol-name
2925 (find-matching-symbols prefix p nil #'prefix-match-p))
2926 #'string<)))
2927 (assert (equal '("FOO") (names "f")))
2928 (assert (equal '("Foo" "foo") (names "F")))
2929 (assert (equal '("Foo") (names "Fo")))
2930 (assert (equal '("foo") (names "FO")))))
2931
2932 ;;;; Fuzzy completion
2933
2934 (defslimefun fuzzy-completions (string default-package-name &optional limit)
2935 "Return an (optionally limited to LIMIT best results) list of
2936 fuzzy completions for a symbol designator STRING. The list will
2937 be sorted by score, most likely match first.
2938
2939 The result is a list of completion objects, where a completion
2940 object is:
2941 (COMPLETED-STRING SCORE (&rest CHUNKS) FLAGS)
2942 where a CHUNK is a description of a matched string of characters:
2943 (OFFSET STRING)
2944 and FLAGS is a list of keywords describing properties of the symbol.
2945 For example, the top result for completing \"mvb\" in a package
2946 that uses COMMON-LISP would be something like:
2947 (\"multiple-value-bind\" 42.391666 ((0 \"mul\") (9 \"v\") (15 \"b\"))
2948 (:FBOUNDP :MACRO))
2949
2950 If STRING is package qualified the result list will also be
2951 qualified. If string is non-qualified the result strings are
2952 also not qualified and are considered relative to
2953 DEFAULT-PACKAGE-NAME.
2954
2955 Which symbols are candidates for matching depends on the symbol
2956 designator's format. The cases are as follows:
2957 FOO - Symbols accessible in the buffer package.
2958 PKG:FOO - Symbols external in package PKG.
2959 PKG::FOO - Symbols accessible in package PKG."
2960 (fuzzy-completion-set string default-package-name limit))
2961
2962 (defun convert-fuzzy-completion-result (result converter
2963 internal-p package-name)
2964 "Converts a result from the fuzzy completion core into
2965 something that emacs is expecting. Converts symbols to strings,
2966 fixes case issues, and adds information describing if the symbol
2967 is :bound, :fbound, a :class, a :macro, a :generic-function,
2968 a :special-operator, or a :package."
2969 (destructuring-bind (symbol-or-name score chunks) result
2970 (multiple-value-bind (name added-length)
2971 (format-completion-result
2972 (funcall converter
2973 (if (symbolp symbol-or-name)
2974 (symbol-name symbol-or-name)
2975 symbol-or-name))
2976 internal-p package-name)
2977 (list name score
2978 (mapcar
2979 #'(lambda (chunk)
2980 ;; fix up chunk positions to account for possible
2981 ;; added package identifier
2982 (list (+ added-length (first chunk))
2983 (second chunk)))
2984 chunks)
2985 (loop for flag in '(:boundp :fboundp :generic-function
2986 :class :macro :special-operator
2987 :package)
2988 if (if (symbolp symbol-or-name)
2989 (case flag
2990 (:boundp (boundp symbol-or-name))
2991 (:fboundp (fboundp symbol-or-name))
2992 (:class (find-class symbol-or-name nil))
2993 (:macro (macro-function symbol-or-name))
2994 (:special-operator
2995 (special-operator-p symbol-or-name))
2996 (:generic-function
2997 (typep (ignore-errors (fdefinition symbol-or-name))
2998 'generic-function)))
2999 (case flag
3000 (:package (stringp symbol-or-name)
3001 ;; KLUDGE: depends on internal
3002 ;; knowledge that packages are
3003 ;; brought up from the bowels of
3004 ;; the completion algorithm as
3005 ;; strings!
3006 )))
3007 collect flag)))))
3008
3009 (defun fuzzy-completion-set (string default-package-name &optional limit)
3010 "Prepares list of completion obajects, sorted by SCORE, of fuzzy
3011 completions of STRING in DEFAULT-PACKAGE-NAME. If LIMIT is set,
3012 only the top LIMIT results will be returned."
3013 (multiple-value-bind (name package-name package internal-p)
3014 (parse-completion-arguments string default-package-name)
3015 (let* ((symbols (and package
3016 (fuzzy-find-matching-symbols name
3017 package
3018 (and (not internal-p)
3019 package-name))))
3020 (packs (and (not package-name)
3021 (fuzzy-find-matching-packages name)))
3022 (converter (output-case-converter name))
3023 (results
3024 (sort (mapcar #'(lambda (result)
3025 (convert-fuzzy-completion-result
3026 result converter internal-p package-name))
3027 (nconc symbols packs))
3028 #'> :key #'second)))
3029 (when (and limit
3030 (> limit 0)
3031 (< limit (length results)))
3032 (setf (cdr (nthcdr (1- limit) results)) nil))
3033 results)))
3034
3035 (defun fuzzy-find-matching-symbols (string package external)
3036 "Return a list of symbols in PACKAGE matching STRING using the
3037 fuzzy completion algorithm. If EXTERNAL is true, only external
3038 symbols are returned."
3039 (let ((completions '())
3040 (converter (output-case-converter string)))
3041 (flet ((symbol-match (symbol)
3042 (and (or (not external)
3043 (symbol-external-p symbol package))
3044 (compute-highest-scoring-completion
3045 string (funcall converter (symbol-name symbol)) #'char=))))
3046 (do-symbols (symbol package)
3047 (if (string= "" string)
3048 (when (or (and external (symbol-external-p symbol package))
3049 (not external))
3050 (push (list symbol 0.0 (list (list 0 ""))) completions))
3051 (multiple-value-bind (result score) (symbol-match symbol)
3052 (when result
3053 (push (list symbol score result) completions))))))
3054 (remove-duplicates completions :key #'first)))
3055
3056 (defun fuzzy-find-matching-packages (name)
3057 "Return a list of package names matching NAME using the fuzzy
3058 completion algorithm."
3059 (let ((converter (output-case-converter name)))
3060 (loop for package in (list-all-packages)
3061 for package-name = (concatenate 'string
3062 (funcall converter
3063 (package-name package))
3064 ":")
3065 for (result score) = (multiple-value-list
3066 (compute-highest-scoring-completion
3067 name package-name #'char=))
3068 if result collect (list package-name score result))))
3069
3070 (defslimefun fuzzy-completion-selected (original-string completion)
3071 "This function is called by Slime when a fuzzy completion is
3072 selected by the user. It is for future expansion to make
3073 testing, say, a machine learning algorithm for completion scoring
3074 easier.
3075
3076 ORIGINAL-STRING is the string the user completed from, and
3077 COMPLETION is the completion object (see docstring for
3078 SWANK:FUZZY-COMPLETIONS) corresponding to the completion that the
3079 user selected."
3080 (declare (ignore original-string completion))
3081 nil)
3082
3083 ;;;;; Fuzzy completion core
3084
3085 (defparameter *fuzzy-recursion-soft-limit* 30
3086 "This is a soft limit for recursion in
3087 RECURSIVELY-COMPUTE-MOST-COMPLETIONS. Without this limit,
3088 completing a string such as \"ZZZZZZ\" with a symbol named
3089 \"ZZZZZZZZZZZZZZZZZZZZZZZ\" will result in explosive recursion to
3090 find all the ways it can match.
3091
3092 Most natural language searches and symbols do not have this
3093 problem -- this is only here as a safeguard.")
3094
3095 (defun compute-highest-scoring-completion (short full test)
3096 "Finds the highest scoring way to complete the abbreviation
3097 SHORT onto the string FULL, using TEST as a equality function for
3098 letters. Returns two values: The first being the completion
3099 chunks of the high scorer, and the second being the score."
3100 (let* ((scored-results
3101 (mapcar #'(lambda (result)
3102 (cons (score-completion result short full) result))
3103 (compute-most-completions short full test)))
3104 (winner (first (sort scored-results #'> :key #'first))))
3105 (values (rest winner) (first winner))))
3106
3107 (defun compute-most-completions (short full test)
3108 "Finds most possible ways to complete FULL with the letters in SHORT.
3109 Calls RECURSIVELY-COMPUTE-MOST-COMPLETIONS recursively. Returns
3110 a list of (&rest CHUNKS), where each CHUNKS is a description of
3111 how a completion matches."
3112 (let ((*all-chunks* nil))
3113 (declare (special *all-chunks*))
3114 (recursively-compute-most-completions short full test 0 0 nil nil nil t)
3115 *all-chunks*))
3116
3117 (defun recursively-compute-most-completions
3118 (short full test
3119 short-index initial-full-index
3120 chunks current-chunk current-chunk-pos
3121 recurse-p)
3122 "Recursively (if RECURSE-P is true) find /most/ possible ways
3123 to fuzzily map the letters in SHORT onto FULL, with TEST being a
3124 function to determine if two letters match.
3125
3126 A chunk is a list of elements that have matched consecutively.
3127 When consecutive matches stop, it is coerced into a string,
3128 paired with the starting position of the chunk, and pushed onto
3129 CHUNKS.
3130
3131 Whenever a letter matches, if RECURSE-P is true,
3132 RECURSIVELY-COMPUTE-MOST-COMPLETIONS calls itself with a position
3133 one index ahead, to find other possibly higher scoring
3134 possibilities. If there are less than
3135 *FUZZY-RECURSION-SOFT-LIMIT* results in *ALL-CHUNKS* currently,
3136 this call will also recurse.
3137
3138 Once a word has been completely matched, the chunks are pushed
3139 onto the special variable *ALL-CHUNKS* and the function returns."
3140 (declare (special *all-chunks*))
3141 (flet ((short-cur ()
3142 "Returns the next letter from the abbreviation, or NIL
3143 if all have been used."
3144 (if (= short-index (length short))
3145 nil
3146 (aref short short-index)))
3147 (add-to-chunk (char pos)
3148 "Adds the CHAR at POS in FULL to the current chunk,
3149 marking the start position if it is empty."
3150 (unless current-chunk
3151 (setf current-chunk-pos pos))
3152 (push char current-chunk))
3153 (collect-chunk ()
3154 "Collects the current chunk to CHUNKS and prepares for
3155 a new chunk."
3156 (when current-chunk
3157 (push (list current-chunk-pos
3158 (coerce (reverse current-chunk) 'string)) chunks)
3159 (setf current-chunk nil
3160 current-chunk-pos nil))))
3161 ;; If there's an outstanding chunk coming in collect it. Since
3162 ;; we're recursively called on skipping an input character, the
3163 ;; chunk can't possibly continue on.
3164 (when current-chunk (collect-chunk))
3165 (do ((pos initial-full-index (1+ pos)))
3166 ((= pos (length full)))
3167 (let ((cur-char (aref full pos)))
3168 (if (and (short-cur)
3169 (funcall test cur-char (short-cur)))
3170 (progn
3171 (when recurse-p
3172 ;; Try other possibilities, limiting insanely deep
3173 ;; recursion somewhat.
3174 (recursively-compute-most-completions
3175 short full test short-index (1+ pos)
3176 chunks current-chunk current-chunk-pos
3177 (not (> (length *all-chunks*)
3178 *fuzzy-recursion-soft-limit*))))
3179 (incf short-index)
3180 (add-to-chunk cur-char pos))
3181 (collect-chunk))))
3182 (collect-chunk)
3183 ;; If we've exhausted the short characters we have a match.
3184 (if (short-cur)
3185 nil
3186 (let ((rev-chunks (reverse chunks)))
3187 (push rev-chunks *all-chunks*)
3188 rev-chunks))))
3189
3190 ;;;;; Fuzzy completion scoring
3191
3192 (defparameter *fuzzy-completion-symbol-prefixes* "*+-%&?<"
3193 "Letters that are likely to be at the beginning of a symbol.
3194 Letters found after one of these prefixes will be scored as if
3195 they were at the beginning of ths symbol.")
3196 (defparameter *fuzzy-completion-symbol-suffixes* "*+->"
3197 "Letters that are likely to be at the end of a symbol.
3198 Letters found before one of these suffixes will be scored as if
3199 they were at the end of the symbol.")
3200 (defparameter *fuzzy-completion-word-separators* "-/."
3201 "Letters that separate different words in symbols. Letters
3202 after one of these symbols will be scores more highly than other
3203 letters.")
3204
3205 (defun score-completion (completion short full)
3206 "Scores the completion chunks COMPLETION as a completion from
3207 the abbreviation SHORT to the full string FULL. COMPLETION is a
3208 list like:
3209 ((0 \"mul\") (9 \"v\") (15 \"b\"))
3210 Which, if SHORT were \"mulvb\" and full were \"multiple-value-bind\",
3211 would indicate that it completed as such (completed letters
3212 capitalized):
3213 MULtiple-Value-Bind
3214
3215 Letters are given scores based on their position in the string.
3216 Letters at the beginning of a string or after a prefix letter at
3217 the beginning of a string are scored highest. Letters after a
3218 word separator such as #\- are scored next highest. Letters at
3219 the end of a string or before a suffix letter at the end of a
3220 string are scored medium, and letters anywhere else are scored
3221 low.
3222
3223 If a letter is directly after another matched letter, and its
3224 intrinsic value in that position is less than a percentage of the
3225 previous letter's value, it will use that percentage instead.
3226
3227 Finally, a small scaling factor is applied to favor shorter
3228 matches, all other things being equal."
3229 (labels ((at-beginning-p (pos)
3230 (= pos 0))
3231 (after-prefix-p (pos)
3232 (and (= pos 1)
3233 (find (aref full 0) *fuzzy-completion-symbol-prefixes*)))
3234 (word-separator-p (pos)
3235 (find (aref full pos) *fuzzy-completion-word-separators*))
3236 (after-word-separator-p (pos)
3237 (find (aref full (1- pos)) *fuzzy-completion-word-separators*))
3238 (at-end-p (pos)
3239 (= pos (1- (length full))))
3240 (before-suffix-p (pos)
3241 (and (= pos (- (length full) 2))
3242 (find (aref full (1- (length full)))
3243 *fuzzy-completion-symbol-suffixes*)))
3244 (score-or-percentage-of-previous (base-score pos chunk-pos)
3245 (if (zerop chunk-pos)
3246 base-score
3247 (max base-score
3248 (* (score-char (1- pos) (1- chunk-pos)) 0.85))))
3249 (score-char (pos chunk-pos)
3250 (score-or-percentage-of-previous
3251 (cond ((at-beginning-p pos) 10)
3252 ((after-prefix-p pos) 10)
3253 ((word-separator-p pos) 1)
3254 ((after-word-separator-p pos) 8)
3255 ((at-end-p pos) 6)
3256 ((before-suffix-p pos) 6)
3257 (t 1))
3258 pos chunk-pos))
3259 (score-chunk (chunk)
3260 (loop for chunk-pos below (length (second chunk))
3261 for pos from (first chunk)
3262 summing (score-char pos chunk-pos))))
3263 (let* ((chunk-scores (mapcar #'score-chunk completion))
3264 (length-score (/ 10.0 (1+ (- (length full) (length short))))))
3265 (values
3266 (+ (reduce #'+ chunk-scores) length-score)
3267 (list (mapcar #'list chunk-scores completion) length-score)))))
3268
3269 (defun highlight-completion (completion full)
3270 "Given a chunk definition COMPLETION and the string FULL,
3271 HIGHLIGHT-COMPLETION will create a string that demonstrates where
3272 the completion matched in the string. Matches will be
3273 capitalized, while the rest of the string will be lower-case."
3274 (let ((highlit (nstring-downcase (copy-seq full))))
3275 (dolist (chunk completion)
3276 (setf highlit (nstring-upcase highlit
3277 :start (first chunk)
3278 :end (+ (first chunk)
3279 (length (second chunk))))))
3280 highlit))
3281
3282 (defun format-fuzzy-completions (winners)
3283 "Given a list of completion objects such as on returned by
3284 FUZZY-COMPLETIONS, format the list into user-readable output."
3285 (let ((max-len
3286 (loop for winner in winners maximizing (length (first winner)))))
3287 (loop for (sym score result) in winners do
3288 (format t "~&~VA score ~8,2F ~A"
3289 max-len (highlight-completion result sym) score result))))
3290
3291
3292 ;;;; Documentation
3293
3294 (defslimefun apropos-list-for-emacs (name &optional external-only
3295 case-sensitive package)
3296 "Make an apropos search for Emacs.
3297 The result is a list of property lists."
3298 (let ((package (if package
3299 (or (find-package (string-to-package-designator package))
3300 (error "No such package: ~S" package)))))
3301 (mapcan (listify #'briefly-describe-symbol-for-emacs)
3302 (sort (remove-duplicates
3303 (apropos-symbols name external-only case-sensitive package))
3304 #'present-symbol-before-p))))
3305
3306 (defun string-to-package-designator (string)
3307 "Return a package designator made from STRING.
3308 Uses READ to case-convert STRING."
3309 (let ((*package* *swank-io-package*))
3310 (read-from-string string)))
3311
3312 (defun briefly-describe-symbol-for-emacs (symbol)
3313 "Return a property list describing SYMBOL.
3314 Like `describe-symbol-for-emacs' but with at most one line per item."
3315 (flet ((first-line (string)
3316 (let ((pos (position #\newline string)))
3317 (if (null pos) string (subseq string 0 pos)))))
3318 (let ((desc (map-if #'stringp #'first-line
3319 (describe-symbol-for-emacs symbol))))
3320 (if desc
3321 (list* :designator (to-string symbol) desc)))))
3322
3323 (defun map-if (test fn &rest lists)
3324 "Like (mapcar FN . LISTS) but only call FN on objects satisfying TEST.
3325 Example:
3326 \(map-if #'oddp #'- '(1 2 3 4 5)) => (-1 2 -3 4 -5)"
3327 (declare (type function test fn))
3328 (apply #'mapcar
3329 (lambda (x) (if (funcall test x) (funcall fn x) x))
3330 lists))
3331
3332 (defun listify (f)
3333 "Return a function like F, but which returns any non-null value
3334 wrapped in a list."
3335 (declare (type function f))
3336 (lambda (x)
3337 (let ((y (funcall f x)))
3338 (and y (list y)))))
3339
3340 (defun present-symbol-before-p (x y)
3341 "Return true if X belongs before Y in a printed summary of symbols.
3342 Sorted alphabetically by package name and then symbol name, except
3343 that symbols accessible in the current package go first."
3344 (declare (type symbol x y))
3345 (flet ((accessible (s)
3346 ;; Test breaks on NIL for package that does not inherit it
3347 (eq (find-symbol (symbol-name s) *buffer-package*) s)))
3348 (let ((ax (accessible x)) (ay (accessible y)))
3349 (cond ((and ax ay) (string< (symbol-name x) (symbol-name y)))
3350 (ax t)
3351 (ay nil)
3352 (t (let ((px (symbol-package x)) (py (symbol-package y)))
3353 (if (eq px py)
3354 (string< (symbol-name x) (symbol-name y))
3355 (string< (package-name px) (package-name py)))))))))
3356
3357 (let ((regex-hash (make-hash-table :test #'equal)))
3358 (defun compiled-regex (regex-string)
3359 (or (gethash regex-string regex-hash)
3360 (setf (gethash regex-string regex-hash)
3361 (if (zerop (length regex-string))
3362 (lambda (s) (check-type s string) t)
3363 (compile nil (slime-nregex:regex-compile regex-string)))))))
3364
3365 (defun apropos-matcher (string case-sensitive package external-only)
3366 (let* ((case-modifier (if case-sensitive #'string #'string-upcase))
3367 (regex (compiled-regex (funcall case-modifier string))))
3368 (lambda (symbol)
3369 (and (not (keywordp symbol))
3370 (if package (eq (symbol-package symbol) package) t)
3371 (if external-only (symbol-external-p symbol) t)
3372 (funcall regex (funcall case-modifier symbol))))))
3373
3374 (defun apropos-symbols (string external-only case-sensitive package)
3375 (let ((result '())
3376 (matchp (apropos-matcher string case-sensitive package external-only)))
3377 (with-package-iterator (next (or package (list-all-packages))
3378 :external :internal)
3379 (loop
3380 (multiple-value-bind (morep symbol) (next)
3381 (cond ((not morep)
3382 (return))
3383 ((funcall matchp symbol)
3384 (push symbol result))))))
3385 result))
3386
3387 (defun call-with-describe-settings (fn)
3388 (let ((*print-readably* nil))
3389 (funcall fn)))
3390
3391 (defmacro with-describe-settings ((&rest _) &body body)
3392 (declare (ignore _))
3393 `(call-with-describe-settings (lambda () ,@body)))
3394
3395 (defun describe-to-string (object)
3396 (with-describe-settings ()
3397 (with-output-to-string (*standard-output*)
3398 (describe object))))
3399
3400 (defslimefun describe-symbol (symbol-name)
3401 (with-buffer-syntax ()
3402 (describe-to-string (parse-symbol-or-lose symbol-name))))
3403
3404 (defslimefun describe-function (name)
3405 (with-buffer-syntax ()
3406 (let ((symbol (parse-symbol-or-lose name)))
3407 (describe-to-string (or (macro-function symbol)
3408 (symbol-function symbol))))))
3409
3410 (defslimefun describe-definition-for-emacs (name kind)
3411 (with-buffer-syntax ()
3412 (with-describe-settings ()
3413 (with-output-to-string (*standard-output*)
3414 (describe-definition (parse-symbol-or-lose name) kind)))))
3415
3416 (defslimefun documentation-symbol (symbol-name &optional default)
3417 (with-buffer-syntax ()
3418 (multiple-value-bind (sym foundp) (parse-symbol symbol-name)
3419 (if foundp
3420 (let ((vdoc (documentation sym 'variable))
3421 (fdoc (documentation sym 'function)))
3422 (or (and (or vdoc fdoc)
3423 (concatenate 'string
3424 fdoc
3425 (and vdoc fdoc '(#\Newline #\Newline))
3426 vdoc))
3427 default))
3428 default))))
3429
3430
3431 ;;;; Package Commands
3432
3433 (defslimefun list-all-package-names (&optional include-nicknames)
3434 "Return a list of all package names.
3435 Include the nicknames if INCLUDE-NICKNAMES is true."
3436 (loop for package in (list-all-packages)
3437 collect (package-name package)
3438 when include-nicknames append (package-nicknames package)))
3439
3440
3441 ;;;; Tracing
3442
3443 ;; Use eval for the sake of portability...
3444 (defun tracedp (fspec)
3445 (member fspec (eval '(trace))))
3446
3447 (defslimefun swank-toggle-trace (spec-string)
3448 (let ((spec (from-string spec-string)))
3449 (cond ((consp spec) ; handle complicated cases in the backend
3450 (toggle-trace spec))
3451 ((tracedp spec)
3452 (eval `(untrace ,spec))
3453 (format nil "~S is now untraced." spec))
3454 (t
3455 (eval `(trace ,spec))
3456 (format nil "~S is now traced." spec)))))
3457
3458 (defslimefun untrace-all ()
3459 (untrace))
3460
3461
3462 ;;;; Undefing
3463
3464 (defslimefun undefine-function (fname-string)
3465 (let ((fname (from-string fname-string)))
3466 (format nil "~S" (fmakunbound fname))))
3467
3468
3469 ;;;; Profiling
3470
3471 (defun profiledp (fspec)
3472 (member fspec (profiled-functions)))
3473
3474 (defslimefun toggle-profile-fdefinition (fname-string)
3475 (let ((fname (from-string fname-string)))
3476 (cond ((profiledp fname)
3477 (unprofile fname)
3478 (format nil "~S is now unprofiled." fname))
3479 (t
3480 (profile fname)
3481 (format nil "~S is now profiled." fname)))))
3482
3483
3484 ;;;; Source Locations
3485
3486 (defslimefun find-definitions-for-emacs (name)
3487 "Return a list ((DSPEC LOCATION) ...) of definitions for NAME.
3488 DSPEC is a string and LOCATION a source location. NAME is a string."
3489 (multiple-value-bind (sexp error)
3490 (ignore-errors (values (from-string name)))
3491 (cond (error '())
3492 (t (loop for (dspec loc) in (find-definitions sexp)
3493 collect (list (to-string dspec) loc))))))
3494
3495 (defun alistify (list key test)
3496 "Partition the elements of LIST into an alist. KEY extracts the key
3497 from an element and TEST is used to compare keys."
3498 (declare (type function key))
3499 (let ((alist '()))
3500 (dolist (e list)
3501 (let* ((k (funcall key e))
3502 (probe (assoc k alist :test test)))
3503 (if probe
3504 (push e (cdr probe))
3505 (push (cons k (list e)) alist))))
3506 alist))
3507
3508 (defun location-position< (pos1 pos2)
3509 (cond ((and (position-p pos1) (position-p pos2))
3510 (< (position-pos pos1)
3511 (position-pos pos2)))
3512 (t nil)))
3513
3514 (defun partition (list test key)
3515 (declare (type function test key))
3516 (loop for e in list
3517 if (funcall test (funcall key e)) collect e into yes
3518 else collect e into no
3519 finally (return (values yes no))))
3520
3521 (defstruct (xref (:conc-name xref.)
3522 (:type list))
3523 dspec location)
3524
3525 (defun location-valid-p (location)
3526 (eq (car location) :location))
3527
3528 (defun xref-buffer (xref)
3529 (location-buffer (xref.location xref)))
3530
3531 (defun xref-position (xref)
3532 (location-buffer (xref.location xref)))
3533
3534 (defun group-xrefs (xrefs)
3535 "Group XREFS, a list of the form ((DSPEC LOCATION) ...) by location.
3536 The result is a list of the form ((LOCATION . ((DSPEC . LOCATION) ...)) ...)."
3537 (multiple-value-bind (resolved errors)
3538 (partition xrefs #'location-valid-p #'xref.location)
3539 (let ((alist (alistify resolved #'xref-buffer #'equal)))
3540 (append
3541 (loop for (buffer . list) in alist
3542 collect (cons (second buffer)
3543 (mapcar (lambda (xref)
3544 (cons (to-string (xref.dspec xref))
3545 (xref.location xref)))
3546 (sort list #'location-position<
3547 :key #'xref-position))))
3548 (if errors
3549 (list (cons "Unresolved"
3550 (mapcar (lambda (xref)
3551 (cons (to-string (xref.dspec xref))
3552 (xref.location xref)))
3553 errors))))))))
3554
3555 (defslimefun xref (type symbol-name)
3556 (let ((symbol (parse-symbol-or-lose symbol-name *buffer-package*)))
3557 (group-xrefs
3558 (ecase type
3559 (:calls (who-calls symbol))
3560 (:calls-who (calls-who symbol))
3561 (:references (who-references symbol))
3562 (:binds (who-binds symbol))
3563 (:sets (who-sets symbol))
3564 (:macroexpands (who-macroexpands symbol))
3565 (:specializes (who-specializes symbol))
3566 (:callers (list-callers symbol))
3567 (:callees (list-callees symbol))))))
3568
3569
3570 ;;;; Inspecting
3571
3572 (defun common-seperated-spec (list &optional (callback (lambda (v)
3573 `(:value ,v))))
3574 (butlast
3575 (loop
3576 for i in list
3577 collect (funcall callback i)
3578 collect ", ")))
3579
3580 (defun inspector-princ (list)
3581 "Like princ-to-string, but don't rewrite (function foo) as #'foo.
3582 Do NOT pass circular lists to this function."
3583 (let ((*print-pprint-dispatch* (copy-pprint-dispatch)))
3584 (set-pprint-dispatch '(cons (member function)) nil)
3585 (princ-to-string list)))
3586
3587 (defmethod inspect-for-emacs ((object cons) inspector)
3588 (declare (ignore inspector))
3589 (if (consp (cdr object))
3590 (inspect-for-emacs-list object)
3591 (inspect-for-emacs-simple-cons object)))
3592
3593 (defun inspect-for-emacs-simple-cons (cons)
3594 (values "A cons cell."
3595 (label-value-line*
3596 ('car (car cons))
3597 ('cdr (cdr cons)))))
3598
3599 (defun inspect-for-emacs-list (list)
3600 (let ((maxlen 40))
3601 (multiple-value-bind (length tail) (safe-length list)
3602 (flet ((frob (title list)
3603 (let ((lines
3604 (do ((i 0 (1+ i))
3605 (l list (cdr l))
3606 (a '() (cons (label-value-line i (car l)) a)))
3607 ((not (consp l))
3608 (let ((a (if (null l)
3609 a
3610 (cons (label-value-line :tail l) a))))
3611 (reduce #'append (reverse a) :from-end t))))))
3612 (values title (append '("Elements:" (:newline)) lines)))))
3613
3614 (cond ((not length) ; circular
3615 (frob "A circular list."
3616 (cons (car list)
3617 (ldiff (cdr list) list))))
3618 ((and (<= length maxlen) (not tail))
3619 (frob "A proper list." list))
3620 (tail
3621 (frob "An improper list." list))
3622 (t
3623 (frob "A proper list." list)))))))
3624
3625 ;; (inspect-for-emacs-list '#1=(a #1# . #1# ))
3626
3627 (defun safe-length (list)
3628 "Similar to `list-length', but avoid errors on improper lists.
3629 Return two values: the length of the list and the last cdr.
3630 NIL is returned if the list is circular."
3631 (do ((n 0 (+ n 2)) ;Counter.
3632 (fast list (cddr fast)) ;Fast pointer: leaps by 2.
3633 (slow list (cdr slow))) ;Slow pointer: leaps by 1.
3634 (nil)
3635 (cond ((null fast) (return (values n nil)))
3636 ((not (consp fast)) (return (values n fast)))
3637 ((null (cdr fast)) (return (values (1+ n) (cdr fast))))
3638 ((and (eq fast slow) (> n 0)) (return nil))
3639 ((not (consp (cdr fast))) (return (values (1+ n) (cdr fast)))))))
3640
3641 (defvar *slime-inspect-contents-limit* nil "How many elements of
3642 a hash table or array to show by default. If table has more than
3643 this then offer actions to view more. Set to nil for no limit." )
3644
3645 (defmethod inspect-for-emacs ((ht hash-table) inspector)
3646 (declare (ignore inspector))
3647 (values (prin1-to-string ht)
3648 (append
3649 (label-value-line*
3650 ("Count" (hash-table-count ht))
3651 ("Size" (hash-table-size ht))
3652 ("Test" (hash-table-test ht))
3653 ("Rehash size" (hash-table-rehash-size ht))
3654 ("Rehash threshold" (hash-table-rehash-threshold ht)))
3655 '("Contents: " (:newline))
3656 (if (and *slime-inspect-contents-limit*
3657 (>= (hash-table-count ht) *slime-inspect-contents-limit*))
3658 (inspect-bigger-piece-actions ht (hash-table-count ht))
3659 nil)
3660 (loop for key being the hash-keys of ht
3661 for value being the hash-values of ht
3662 repeat (or *slime-inspect-contents-limit* most-positive-fixnum)
3663 append `((:value ,key) " = " (:value ,value) (:newline))
3664 )
3665
3666 )))
3667
3668 (defmethod inspect-bigger-piece-actions (thing size)
3669 (append
3670 (if (> size *slime-inspect-contents-limit*)
3671 (list (inspect-show-more-action thing)
3672 '(:newline))
3673 nil)
3674 (list (inspect-whole-thing-action thing size)
3675 '(:newline))))
3676
3677 (defmethod inspect-whole-thing-action (thing size)
3678 `(:action ,(format nil "Inspect all ~a elements."
3679 size)
3680 ,(lambda()
3681 (let ((*slime-inspect-contents-limit* nil))
3682 (values
3683 (swank::inspect-object thing)
3684 :replace)
3685 ))))
3686
3687 (defmethod inspect-show-more-action (thing)
3688 `(:action ,(format nil "~a elements shown. Prompt for how many to inspect..."
3689 *slime-inspect-contents-limit* )
3690 ,(lambda()
3691 (let ((*slime-inspect-contents-limit*
3692 (progn (format t "How many elements should be shown? ") (read))))
3693 (values
3694 (swank::inspect-object thing)
3695 :replace)
3696 ))
3697 ))
3698
3699 (defmethod inspect-for-emacs ((array array) inspector)
3700 (declare (ignore inspector))
3701 (values "An array."
3702 (append
3703 (label-value-line*
3704 ("Dimensions" (array-dimensions array))
3705 ("Its element type is" (array-element-type array))
3706 ("Total size" (array-total-size array))
3707 ("Adjustable" (adjustable-array-p array)))
3708 (when (array-has-fill-pointer-p array)
3709 (label-value-line "Fill pointer" (fill-pointer array)))
3710 '("Contents:" (:newline))
3711 (if (and *slime-inspect-contents-limit*
3712 (>= (array-total-size array) *slime-inspect-contents-limit*))
3713 (inspect-bigger-piece-actions array (length array))
3714 nil)
3715 (loop for i below (or *slime-inspect-contents-limit* (array-total-size array))
3716 append (label-value-line i (row-major-aref array i))))))
3717
3718 (defmethod inspect-for-emacs ((char character) inspector)
3719 (declare (ignore inspector))
3720 (values "A character."
3721 (append
3722 (label-value-line*
3723 ("Char code" (char-code char))
3724 ("Lower cased" (char-downcase char))
3725 ("Upper cased" (char-upcase char)))
3726 (if (get-macro-character char)
3727 `("In the current readtable ("
3728 (:value ,*readtable*) ") it is a macro character: "
3729 (:value ,(get-macro-character char)))))))
3730
3731 (defun docstring-ispec (label object kind)
3732 "Return a inspector spec if OBJECT has a docstring of of kind KIND."
3733 (let ((docstring (documentation object kind)))
3734 (cond ((not docstring) nil)
3735 ((< (+ (length label) (length docstring))
3736 75)
3737 (list label ": " docstring '(:newline)))
3738 (t
3739 (list label ": " '(:newline) " " docstring '(:newline))))))
3740
3741 (defmethod inspect-for-emacs ((symbol symbol) inspector)
3742 (declare (ignore inspector))
3743 (let ((package (symbol-package symbol)))
3744 (multiple-value-bind (_symbol status)
3745 (and package (find-symbol (string symbol) package))
3746 (declare (ignore _symbol))
3747 (values
3748 "A symbol."
3749 (append
3750 (label-value-line "Its name is" (symbol-name symbol))
3751 ;;
3752 ;; Value
3753 (cond ((boundp symbol)
3754 (label-value-line (if (constantp symbol)
3755 "It is a constant of value"
3756 "It is a global variable bound to")
3757 (symbol-value symbol)))
3758 (t '("It is unbound." (:newline))))
3759 (docstring-ispec "Documentation" symbol 'variable)
3760 (multiple-value-bind (expansion definedp) (macroexpand symbol)
3761 (if definedp
3762 (label-value-line "It is a symbol macro with expansion"
3763 expansion)))
3764 ;;
3765 ;; Function
3766 (if (fboundp symbol)
3767 (append (if (macro-function symbol)
3768 `("It a macro with macro-function: "
3769 (:value ,(macro-function symbol)))
3770 `("It is a function: "
3771 (:value ,(symbol-function symbol))))
3772 `(" " (:action "[make funbound]"
3773 ,(lambda () (fmakunbound symbol))))
3774 `((:newline)))
3775 `("It has no function value." (:newline)))
3776 (docstring-ispec "Function Documentation" symbol 'function)
3777 (if (compiler-macro-function symbol)
3778 (label-value-line "It also names the compiler macro"
3779 (compiler-macro-function symbol)))
3780 (docstring-ispec "Compiler Macro Documentation"
3781 symbol 'compiler-macro)
3782 ;;
3783 ;; Package
3784 (if package
3785 `("It is " ,(string-downcase (string status))
3786 " to the package: "
3787 (:value ,package ,(package-name package))
3788 ,@(if (eq :internal status)
3789 `(" "
3790 (:action "[export it]"
3791 ,(lambda () (export symbol package)))))
3792 " "
3793 (:action "[unintern it]"
3794 ,(lambda () (unintern symbol package)))
3795 (:newline))
3796 '("It is a non-interned symbol." (:newline)))
3797 ;;
3798 ;; Plist
3799 (label-value-line "Property list" (symbol-plist symbol))
3800 ;;
3801 ;; Class
3802 (if (find-class symbol nil)
3803 `("It names the class "
3804 (:value ,(find-class symbol) ,(string symbol))
3805 " "
3806 (:action "[remove]"
3807 ,(lambda () (setf (find-class symbol) nil)))
3808 (:newline)))
3809 ;;
3810 ;; More package
3811 (if (find-package symbol)
3812 (label-value-line "It names the package" (find-package symbol)))
3813 )))))
3814
3815 (defmethod inspect-for-emacs ((f function) inspector)
3816 (declare (ignore inspector))
3817 (values "A function."
3818 (append
3819 (label-value-line "Name" (function-name f))
3820 `("Its argument list is: "
3821 ,(inspector-princ (arglist f)) (:newline))
3822 (docstring-ispec "Documentation" f t)
3823 (if (function-lambda-expression f)
3824 (label-value-line "Lambda Expression"
3825 (function-lambda-expression f))))))
3826
3827 (defun method-specializers-for-inspect (method)
3828 "Return a \"pretty\" list of the method's specializers. Normal
3829 specializers are replaced by the name of the class, eql
3830 specializers are replaced by `(eql ,object)."
3831 (mapcar (lambda (spec)
3832 (typecase spec
3833 (swank-mop:eql-specializer
3834 `(eql ,(swank-mop:eql-specializer-object spec)))
3835 (t (swank-mop:class-name spec))))
3836 (swank-mop:method-specializers method)))
3837
3838 (defun method-for-inspect-value (method)
3839 "Returns a \"pretty\" list describing METHOD. The first element
3840 of the list is the name of generic-function method is
3841 specialiazed on, the second element is the method qualifiers,
3842 the rest of the list is the method's specialiazers (as per
3843 method-specializers-for-inspect)."
3844 (append (list (swank-mop:generic-function-name
3845 (swank-mop:method-generic-function method)))
3846 (swank-mop:method-qualifiers method)
3847 (method-specializers-for-inspect method)))
3848
3849 (defmethod inspect-for-emacs ((o standard-object) inspector)
3850 (declare (ignore inspector))
3851 (let ((c (class-of o)))
3852 (values "An object."
3853 `("Class: " (:value ,c) (:newline)
3854 "Slots:" (:newline)
3855 ,@(loop for slotd in (swank-mop:class-slots c)
3856 for name = (swank-mop:slot-definition-name slotd)
3857 collect `(:value ,slotd ,(string name))
3858 collect " = "
3859 collect (if (swank-mop:slot-boundp-using-class c o slotd)
3860 `(:value ,(swank-mop:slot-value-using-class
3861 c o slotd))
3862 "#<unbound>")
3863 collect '(:newline))))))
3864
3865 (defvar *gf-method-getter* 'methods-by-applicability
3866 "This function is called to get the methods of a generic function.
3867 The default returns the method sorted by applicability.
3868 See `methods-by-applicability'.")
3869
3870 (defun specializer< (specializer1 specializer2)
3871 "Return true if SPECIALIZER1 is more specific than SPECIALIZER2."
3872 (let ((s1 specializer1) (s2 specializer2) )
3873 (cond ((typep s1 'swank-mop:eql-specializer)
3874 (not (typep s2 'swank-mop:eql-specializer)))
3875 (t
3876 (flet ((cpl (class)
3877 (and (swank-mop:class-finalized-p class)
3878 (swank-mop:class-precedence-list class))))
3879 (member s2 (cpl s1)))))))
3880
3881 (defun methods-by-applicability (gf)
3882 "Return methods ordered by most specific argument types.
3883
3884 `method-specializer<' is used for sorting."
3885 ;; FIXME: argument-precedence-order and qualifiers are ignored.
3886 (let ((methods (copy-list (swank-mop:generic-function-methods gf))))
3887 (labels ((method< (meth1 meth2)
3888 (loop for s1 in (swank-mop:method-specializers meth1)
3889 for s2 in (swank-mop:method-specializers meth2)
3890 do (cond ((specializer< s2 s1) (return nil))
3891 ((specializer< s1 s2) (return t))))))
3892 (stable-sort methods #'method<))))
3893
3894 (defun abbrev-doc (doc &optional (maxlen 80))
3895 "Return the first sentence of DOC, but not more than MAXLAN characters."
3896 (subseq doc 0 (min (1+ (or (position #\. doc) (1- maxlen)))
3897 maxlen
3898 (length doc))))
3899
3900 (defun all-slots-for-inspector (object)
3901 (append (list "------------------------------" '(:newline)
3902 "All Slots:" '(:newline))
3903 (loop
3904 with direct-slots = (swank-mop:class-direct-slots (class-of object))
3905 for slot in (swank-mop:class-slots (class-of object))
3906 for slot-def = (or (find-if (lambda (a)
3907 ;; find the direct slot
3908 ;; with the same name
3909 ;; as SLOT (an
3910 ;; effective slot).
3911 (eql (swank-mop:slot-definition-name a)
3912 (swank-mop:slot-definition-name slot)))
3913 direct-slots)
3914 slot)
3915 collect `(:value ,slot-def ,(inspector-princ (swank-mop:slot-definition-name slot-def)))
3916 collect " = "
3917 if (slot-boundp object (swank-mop:slot-definition-name slot-def))
3918 collect `(:value ,(slot-value object (swank-mop:slot-definition-name slot-def)))
3919 else
3920 collect "#<unbound>"
3921 collect '(:newline))))
3922
3923 (defmethod inspect-for-emacs ((gf standard-generic-function) inspector)
3924 (declare (ignore inspector))
3925 (flet ((lv (label value) (label-value-line label value)))
3926 (values
3927 "A generic function."
3928 (append
3929 (lv "Name" (swank-mop:generic-function-name gf))
3930 (lv "Arguments" (swank-mop:generic-function-lambda-list gf))
3931 (docstring-ispec "Documentation" gf t)
3932 (lv "Method class" (swank-mop:generic-function-method-class gf))
3933 (lv "Method combination"
3934 (swank-mop:generic-function-method-combination gf))
3935 `("Methods: " (:newline))
3936 (loop for method in (funcall *gf-method-getter* gf) append
3937 `((:value ,method ,(inspector-princ
3938 ;; drop the name of the GF
3939 (cdr (method-for-inspect-value method))))
3940 " "
3941 (:action "[remove method]"
3942 ,(let ((m method)) ; LOOP reassigns method
3943 (lambda ()
3944 (remove-method gf m))))
3945 (:newline)))
3946 `((:newline))
3947 (all-slots-for-inspector gf)))))
3948
3949 (defmethod inspect-for-emacs ((method standard-method) inspector)
3950 (declare (ignore inspector))
3951 (values "A method."
3952 `("Method defined on the generic function "
3953 (:value ,(swank-mop:method-generic-function method)
3954 ,(inspector-princ
3955 (swank-mop:generic-function-name
3956 (swank-mop:method-generic-function method))))
3957 (:newline)
3958 ,@(docstring-ispec "Documentation" method t)
3959 "Lambda List: " (:value ,(swank-mop:method-lambda-list method))
3960 (:newline)
3961 "Specializers: " (:value ,(swank-mop:method-specializers method)
3962 ,(inspector-princ (method-specializers-for-inspect method)))
3963 (:newline)
3964 "Qualifiers: " (:value ,(swank-mop:method-qualifiers method))
3965 (:newline)
3966 "Method function: " (:value ,(swank-mop:method-function method))
3967 (:newline)
3968 ,@(all-slots-for-inspector method))))
3969
3970 (defmethod inspect-for-emacs ((class standard-class) inspector)
3971 (declare (ignore inspector))
3972 (values "A class."
3973 `("Name: " (:value ,(class-name class))
3974 (:newline)
3975 "Super classes: "
3976 ,@(common-seperated-spec (swank-mop:class-direct-superclasses class))
3977 (:newline)
3978 "Direct Slots: "
3979 ,@(common-seperated-spec
3980 (swank-mop:class-direct-slots class)
3981 (lambda (slot)
3982 `(:value ,slot ,(inspector-princ (swank-mop:slot-definition-name slot)))))
3983 (:newline)
3984 "Effective Slots: "
3985 ,@(if (swank-mop:class-finalized-p class)
3986 (common-seperated-spec
3987 (swank-mop:class-slots class)
3988 (lambda (slot)
3989 `(:value ,slot ,(inspector-princ
3990 (swank-mop:slot-definition-name slot)))))
3991 '("#<N/A (class not finalized)>"))
3992 (:newline)
3993 ,@(when (documentation class t)
3994 `("Documentation:" (:newline) ,(documentation class t) (:newline)))
3995 "Sub classes: "
3996 ,@(common-seperated-spec (swank-mop:class-direct-subclasses class)
3997 (lambda (sub)
3998 `(:value ,sub ,(inspector-princ (class-name sub)))))
3999 (:newline)
4000 "Precedence List: "
4001 ,@(if (swank-mop:class-finalized-p class)
4002 (common-seperated-spec (swank-mop:class-precedence-list class)
4003 (lambda (class)
4004 `(:value ,class ,(inspector-princ (class-name class)))))
4005 '("#<N/A (class not finalized)>"))
4006 (:newline)
4007 ,@(when (swank-mop:specializer-direct-methods class)
4008 `("It is used as a direct specializer in the following methods:" (:newline)
4009 ,@(loop
4010 for method in (sort (copy-list (swank-mop:specializer-direct-methods class))
4011 #'string< :key (lambda (x)
4012 (symbol-name
4013 (let ((name (swank-mop::generic-function-name
4014 (swank-mop::method-generic-function x))))
4015 (if (symbolp name) name (second name))))))
4016 collect " "
4017 collect `(:value ,method ,(inspector-princ (method-for-inspect-value method)))
4018 collect '(:newline)
4019 if (documentation method t)
4020 collect " Documentation: " and
4021 collect (abbrev-doc (documentation method t)) and
4022 collect '(:newline))))
4023 "Prototype: " ,(if (swank-mop:class-finalized-p class)
4024 `(:value ,(swank-mop:class-prototype class))
4025 '"#<N/A (class not finalized)>")
4026 (:newline)
4027 ,@(all-slots-for-inspector class))))
4028
4029 (defmethod inspect-for-emacs ((slot swank-mop:standard-slot-definition) inspector)
4030 (declare (ignore inspector))
4031 (values "A slot."
4032 `("Name: " (:value ,(swank-mop:slot-definition-name slot))
4033 (:newline)
4034 ,@(when (swank-mop:slot-definition-documentation slot)
4035 `("Documentation:" (:newline)
4036 (:value ,(swank-mop:slot-definition-documentation slot))
4037 (:newline)))
4038 "Init args: " (:value ,(swank-mop:slot-definition-initargs slot)) (:newline)
4039 "Init form: " ,(if (swank-mop:slot-definition-initfunction slot)
4040 `(:value ,(swank-mop:slot-definition-initform slot))
4041 "#<unspecified>") (:newline)
4042 "Init function: " (:value ,(swank-mop:slot-definition-initfunction slot))
4043 (:newline)
4044 ,@(all-slots-for-inspector slot))))
4045
4046 (defmethod inspect-for-emacs ((package package) inspector)
4047 (declare (ignore inspector))
4048 (let ((internal-symbols '())
4049 (external-symbols '()))
4050 (do-symbols (sym package)
4051 (when (eq package (symbol-package sym))
4052 (push sym internal-symbols)
4053 (multiple-value-bind (symbol status)
4054 (find-symbol (symbol-name sym) package)
4055 (declare (ignore symbol))
4056 (when (eql :external status)
4057 (push sym external-symbols)))))
4058 (setf internal-symbols (sort internal-symbols #'string-lessp)
4059 external-symbols (sort external-symbols #'string-lessp))
4060 (values "A package."
4061 `("Name: " (:value ,(package-name package))
4062 (:newline)
4063 "Nick names: " ,@(common-seperated-spec (sort (package-nicknames package) #'string-lessp))
4064 (:newline)
4065 ,@(when (documentation package t)
4066 `("Documentation:" (:newline)
4067 ,(documentation package t) (:newline)))
4068 "Use list: " ,@(common-seperated-spec (sort (package-use-list package) #'string-lessp :key #'package-name)
4069 (lambda (pack)
4070 `(:value ,pack ,(inspector-princ (package-name pack)))))
4071 (:newline)
4072 "Used by list: " ,@(common-seperated-spec (sort (package-used-by-list package) #'string-lessp :key #'package-name)
4073 (lambda (pack)
4074 `(:value ,pack ,(inspector-princ (package-name pack)))))
4075 (:newline)
4076 ,(if (null external-symbols)
4077 "0 external symbols."
4078 `(:value ,external-symbols ,(format nil "~D external symbol~:P." (length external-symbols))))
4079 (:newline)
4080 ,(if (null internal-symbols)
4081 "0 internal symbols."
4082 `(:value ,internal-symbols ,(format nil "~D internal symbol~:P." (length internal-symbols))))
4083 (:newline)
4084 ,(if (null (package-shadowing-symbols package))
4085 "0 shadowed symbols."
4086 `(:value ,(package-shadowing-symbols package)
4087 ,(format nil "~D shadowed symbol~:P." (length (package-shadowing-symbols package)))))))))
4088
4089 (defmethod inspect-for-emacs ((pathname pathname) inspec