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

Contents of /slime/swank.lisp

Parent Directory Parent Directory | Revision Log Revision Log


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