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

Diff of /slime/swank-cmucl.lisp

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.32 by heller, Wed Dec 3 22:34:50 2003 UTC revision 1.235 by heller, Sun Nov 6 17:39:29 2011 UTC
# Line 1  Line 1 
1  ;;;; -*- indent-tabs-mode: nil; outline-regexp: ";;;;+" -*-  ;;; -*- indent-tabs-mode: nil; outline-regexp: ";;;;+" -*-
2    ;;;
3    ;;; License: Public Domain
4    ;;;
5    ;;;; Introduction
6    ;;;
7    ;;; This is the CMUCL implementation of the `swank-backend' package.
8    
9    (in-package :swank-backend)
10    
11  (declaim (optimize debug))  (import-swank-mop-symbols :pcl '(:slot-definition-documentation))
12    
13  (in-package :swank)  (defun swank-mop:slot-definition-documentation (slot)
14      (documentation slot t))
15    
16  ;; Turn on xref. [should we?]  ;;;; "Hot fixes"
17  (setf c:*record-xref-info* t)  ;;;
18    ;;; Here are necessary bugfixes to the oldest supported version of
19    ;;; CMUCL (currently 18e). Any fixes placed here should also be
20    ;;; submitted to the `cmucl-imp' mailing list and confirmed as
21    ;;; good. When a new release is made that includes the fixes we should
22    ;;; promptly delete them from here. It is enough to be compatible with
23    ;;; the latest release.
24    
25    (in-package :lisp)
26    
27  (defun without-interrupts* (body)  ;;; `READ-SEQUENCE' with large sequences has problems in 18e. This new
28    (sys:without-interrupts (funcall body)))  ;;; definition works better.
29    
30  (defun set-fd-non-blocking (fd)  #+cmu18
31    (flet ((fcntl (fd cmd arg)  (progn
32             (multiple-value-bind (flags errno) (unix:unix-fcntl fd cmd arg)    (let ((s (find-symbol (string :*enable-package-locked-errors*) :lisp)))
33               (or flags      (when s
34                   (error "fcntl: ~A" (unix:get-unix-error-msg errno))))))        (setf (symbol-value s) nil)))
35      (let ((flags (fcntl fd unix:F-GETFL 0)))  
36        (fcntl fd unix:F-SETFL (logior flags unix:O_NONBLOCK)))))    (defun read-into-simple-string (s stream start end)
37        (declare (type simple-string s))
38        (declare (type stream stream))
39        (declare (type index start end))
40        (unless (subtypep (stream-element-type stream) 'character)
41          (error 'type-error
42                 :datum (read-char stream nil #\Null)
43                 :expected-type (stream-element-type stream)
44                 :format-control "Trying to read characters from a binary stream."))
45        ;; Let's go as low level as it seems reasonable.
46        (let* ((numbytes (- end start))
47               (total-bytes 0))
48          ;; read-n-bytes may return fewer bytes than requested, so we need
49          ;; to keep trying.
50          (loop while (plusp numbytes) do
51                (let ((bytes-read (system:read-n-bytes stream s start numbytes nil)))
52                  (when (zerop bytes-read)
53                    (return-from read-into-simple-string total-bytes))
54                  (incf total-bytes bytes-read)
55                  (incf start bytes-read)
56                  (decf numbytes bytes-read)))
57          total-bytes))
58    
59      (let ((s (find-symbol (string :*enable-package-locked-errors*) :lisp)))
60        (when s
61          (setf (symbol-value s) t)))
62    
63      )
64    
65    (in-package :swank-backend)
66    
67  ;;;; TCP server.  ;;; UTF8
68    
69  (defun resolve-hostname (name)  (defimplementation string-to-utf8 (string)
70    (let* ((hostent (ext:lookup-host-entry name))    (let ((ef (load-time-value (stream::find-external-format :utf-8) t)))
71           (address (car (ext:host-entry-addr-list hostent))))      (stream:string-to-octets string :external-format ef)))
72      (ext:htonl address)))  
73    (defimplementation utf8-to-string (octets)
74  (defun create-swank-server (port &key (reuse-address t)    (let ((ef (load-time-value (stream::find-external-format :utf-8) t)))
75                              (address "localhost"))      (stream:octets-to-string octets :external-format ef)))
76    "Create a SWANK TCP server."  
77    (let* ((ip (resolve-hostname address))  
78           (fd (ext:create-inet-listener port :stream  ;;;; TCP server
79                                         :reuse-address reuse-address  ;;;
80                                         :host ip)))  ;;; In CMUCL we support all communication styles. By default we use
81      (system:add-fd-handler fd :input #'accept-connection)  ;;; `:SIGIO' because it is the most responsive, but it's somewhat
82      (nth-value 1 (ext::get-socket-host-and-port fd))))  ;;; dangerous: CMUCL is not in general "signal safe", and you don't
83    ;;; know for sure what you'll be interrupting. Both `:FD-HANDLER' and
84  (defun accept-connection (socket)  ;;; `:SPAWN' are reasonable alternatives.
85    "Accept one Swank TCP connection on SOCKET and then close it."  
86    (setup-request-handler (ext:accept-tcp-connection socket))  (defimplementation preferred-communication-style ()
87    (sys:invalidate-descriptor socket)    :sigio)
88    (unix:unix-close socket))  
89    #-(or darwin mips)
90  (defun open-stream-to-emacs ()  (defimplementation create-socket (host port)
91    "Return an output-stream to Emacs' output buffer."    (let* ((addr (resolve-hostname host))
92    (let* ((ip (resolve-hostname "localhost"))           (addr (if (not (find-symbol "SOCKET-ERROR" :ext))
93           (listener (ext:create-inet-listener 0 :stream :host ip))                     (ext:htonl addr)
94           (port (nth-value 1 (ext::get-socket-host-and-port listener))))                     addr)))
95      (unwind-protect      (ext:create-inet-listener port :stream :reuse-address t :host addr)))
96           (progn  
97             (eval-in-emacs `(slime-open-stream-to-lisp ,port))  ;; There seems to be a bug in create-inet-listener on Mac/OSX and Irix.
98             (let ((fd (ext:accept-tcp-connection listener)))  #+(or darwin mips)
99               (sys:make-fd-stream fd :output t)))  (defimplementation create-socket (host port)
100        (ext:close-socket listener))))    (declare (ignore host))
101      (ext:create-inet-listener port :stream :reuse-address t))
102  (defvar *use-dedicated-output-stream* t)  
103    (defimplementation local-port (socket)
104  (defun setup-request-handler (socket)    (nth-value 1 (ext::get-socket-host-and-port (socket-fd socket))))
105    "Setup request handling for SOCKET."  
106    (let* ((stream (sys:make-fd-stream socket  (defimplementation close-socket (socket)
107                                       :input t :output t    (let ((fd (socket-fd socket)))
108                                       :element-type 'base-char))      (sys:invalidate-descriptor fd)
109           (input (make-slime-input-stream))      (ext:close-socket fd)))
110           (output (if *use-dedicated-output-stream*  
111                       (let ((*emacs-io* stream)) (open-stream-to-emacs))  (defimplementation accept-connection (socket &key
112                       (make-slime-output-stream)))                                        external-format buffering timeout)
113           (io (make-two-way-stream input output)))    (declare (ignore timeout))
114      (system:add-fd-handler socket    (make-socket-io-stream (ext:accept-tcp-connection socket)
115                             :input (lambda (fd)                           (ecase buffering
116                                      (declare (ignore fd))                             ((t) :full)
117                                      (serve-request stream output input io)))))                             (:line :line)
118                               ((nil) :none))
119  (defun serve-request (*emacs-io* *slime-output* *slime-input* *slime-io*)                           external-format))
120    "Read and process a request from a SWANK client.  
121  The request is read from the socket as a sexp and then evaluated."  ;;;;; Sockets
122    (catch 'slime-toplevel  
123      (with-simple-restart (abort "Return to Slime toplevel.")  (defimplementation socket-fd (socket)
124        (handler-case (read-from-emacs)    "Return the filedescriptor for the socket represented by SOCKET."
125          (slime-read-error (e)    (etypecase socket
126            (when *swank-debug-p*      (fixnum socket)
127              (format *debug-io* "~&;; Connection to Emacs lost.~%;; [~A]~%" e))      (sys:fd-stream (sys:fd-stream-fd socket))))
128            (sys:invalidate-descriptor (sys:fd-stream-fd *emacs-io*))  
129            (close *emacs-io*)))))  (defun resolve-hostname (hostname)
130    (sys:scrub-control-stack))    "Return the IP address of HOSTNAME as an integer (in host byte-order)."
131      (let ((hostent (ext:lookup-host-entry hostname)))
132        (car (ext:host-entry-addr-list hostent))))
133    
134    (defvar *external-format-to-coding-system*
135      '((:iso-8859-1
136         "latin-1" "latin-1-unix" "iso-latin-1-unix"
137         "iso-8859-1" "iso-8859-1-unix")
138        #+unicode
139        (:utf-8 "utf-8" "utf-8-unix")))
140    
141    (defimplementation find-external-format (coding-system)
142      (car (rassoc-if (lambda (x) (member coding-system x :test #'equal))
143                      *external-format-to-coding-system*)))
144    
145    (defun make-socket-io-stream (fd buffering external-format)
146      "Create a new input/output fd-stream for FD."
147      (cond ((and external-format (ext:featurep :unicode))
148             (sys:make-fd-stream fd :input t :output t
149                                 :element-type '(unsigned-byte 8)
150                                 :buffering buffering
151                                 :external-format external-format))
152            (t
153             (sys:make-fd-stream fd :input t :output t
154                                 :element-type '(unsigned-byte 8)
155                                 :buffering buffering))))
156    
157    (defimplementation make-fd-stream (fd external-format)
158      (make-socket-io-stream fd :full external-format))
159    
160    (defimplementation dup (fd)
161      (multiple-value-bind (clone error) (unix:unix-dup fd)
162        (unless clone (error "dup failed: ~a" (unix:get-unix-error-msg error)))
163        clone))
164    
165    (defimplementation command-line-args ()
166      ext:*command-line-strings*)
167    
168    (defimplementation exec-image (image-file args)
169      (multiple-value-bind (ok error)
170          (unix:unix-execve (car (command-line-args))
171                            (list* (car (command-line-args))
172                                   "-core" image-file
173                                   "-noinit"
174                                   args))
175        (error "~a" (unix:get-unix-error-msg error))
176        ok))
177    
178    ;;;;; Signal-driven I/O
179    
180    (defimplementation install-sigint-handler (function)
181      (sys:enable-interrupt :sigint (lambda (signal code scp)
182                                      (declare (ignore signal code scp))
183                                      (funcall function))))
184    
185    (defvar *sigio-handlers* '()
186      "List of (key . function) pairs.
187    All functions are called on SIGIO, and the key is used for removing
188    specific functions.")
189    
190    (defun reset-sigio-handlers () (setq *sigio-handlers* '()))
191    ;; All file handlers are invalid afer reload.
192    (pushnew 'reset-sigio-handlers ext:*after-save-initializations*)
193    
194    (defun set-sigio-handler ()
195      (sys:enable-interrupt :sigio (lambda (signal code scp)
196                                     (sigio-handler signal code scp))))
197    
198    (defun sigio-handler (signal code scp)
199      (declare (ignore signal code scp))
200      (mapc #'funcall (mapcar #'cdr *sigio-handlers*)))
201    
202    (defun fcntl (fd command arg)
203      "fcntl(2) - manipulate a file descriptor."
204      (multiple-value-bind (ok error) (unix:unix-fcntl fd command arg)
205        (cond (ok)
206              (t (error "fcntl: ~A" (unix:get-unix-error-msg error))))))
207    
208    (defimplementation add-sigio-handler (socket fn)
209      (set-sigio-handler)
210      (let ((fd (socket-fd socket)))
211        (fcntl fd unix:f-setown (unix:unix-getpid))
212        (let ((old-flags (fcntl fd unix:f-getfl 0)))
213          (fcntl fd unix:f-setfl (logior old-flags unix:fasync)))
214        (assert (not (assoc fd *sigio-handlers*)))
215        (push (cons fd fn) *sigio-handlers*)))
216    
217    (defimplementation remove-sigio-handlers (socket)
218      (let ((fd (socket-fd socket)))
219        (when (assoc fd *sigio-handlers*)
220          (setf *sigio-handlers* (remove fd *sigio-handlers* :key #'car))
221          (let ((old-flags (fcntl fd unix:f-getfl 0)))
222            (fcntl fd unix:f-setfl (logandc2 old-flags unix:fasync)))
223          (sys:invalidate-descriptor fd))
224        (assert (not (assoc fd *sigio-handlers*)))
225        (when (null *sigio-handlers*)
226          (sys:default-interrupt :sigio))))
227    
228    ;;;;; SERVE-EVENT
229    
230    (defimplementation add-fd-handler (socket fn)
231      (let ((fd (socket-fd socket)))
232        (sys:add-fd-handler fd :input (lambda (_) _ (funcall fn)))))
233    
234    (defimplementation remove-fd-handlers (socket)
235      (sys:invalidate-descriptor (socket-fd socket)))
236    
237    (defimplementation wait-for-input (streams &optional timeout)
238      (assert (member timeout '(nil t)))
239      (loop
240       (let ((ready (remove-if-not #'listen streams)))
241         (when ready (return ready)))
242       (when timeout (return nil))
243       (multiple-value-bind (in out) (make-pipe)
244         (let* ((f (constantly t))
245                (handlers (loop for s in (cons in (mapcar #'to-fd-stream streams))
246                                collect (add-one-shot-handler s f))))
247           (unwind-protect
248                (let ((*interrupt-queued-handler* (lambda ()
249                                                    (write-char #\! out))))
250                  (when (check-slime-interrupts) (return :interrupt))
251                  (sys:serve-event))
252             (mapc #'sys:remove-fd-handler handlers)
253             (close in)
254             (close out))))))
255    
256    (defun to-fd-stream (stream)
257      (etypecase stream
258        (sys:fd-stream stream)
259        (synonym-stream
260         (to-fd-stream
261          (symbol-value (synonym-stream-symbol stream))))
262        (two-way-stream
263         (to-fd-stream (two-way-stream-input-stream stream)))))
264    
265    (defun add-one-shot-handler (stream function)
266      (let (handler)
267        (setq handler (sys:add-fd-handler (sys:fd-stream-fd stream) :input
268                                          (lambda (fd)
269                                            (declare (ignore fd))
270                                            (sys:remove-fd-handler handler)
271                                            (funcall function stream))))))
272    
273    (defun make-pipe ()
274      (multiple-value-bind (in out) (unix:unix-pipe)
275        (values (sys:make-fd-stream in :input t :buffering :none)
276                (sys:make-fd-stream out :output t :buffering :none))))
277    
278    
279  ;;;; Stream handling  ;;;; Stream handling
280    ;;; XXX: How come we don't use Gray streams in CMUCL too? -luke (15/May/2004)
281    
282    (defimplementation make-output-stream (write-string)
283      (make-slime-output-stream write-string))
284    
285    (defimplementation make-input-stream (read-string)
286      (make-slime-input-stream read-string))
287    
288  (defstruct (slime-output-stream  (defstruct (slime-output-stream
289               (:include lisp::lisp-stream               (:include lisp::lisp-stream
290                         (lisp::misc #'sos/misc)                         (lisp::misc #'sos/misc)
291                         (lisp::out #'sos/out)                         (lisp::out #'sos/write-char)
292                         (lisp::sout #'sos/sout))                         (lisp::sout #'sos/write-string))
293               (:conc-name sos.)               (:conc-name sos.)
294               (:print-function %print-slime-output-stream))               (:print-function %print-slime-output-stream)
295    (buffer (make-string 512) :type string)               (:constructor make-slime-output-stream (output-fn)))
296      (output-fn nil :type function)
297      (buffer (make-string 4000) :type string)
298    (index 0 :type kernel:index)    (index 0 :type kernel:index)
299    (column 0 :type kernel:index))    (column 0 :type kernel:index))
300    
# Line 102  The request is read from the socket as a Line 302  The request is read from the socket as a
302    (declare (ignore d))    (declare (ignore d))
303    (print-unreadable-object (s stream :type t :identity t)))    (print-unreadable-object (s stream :type t :identity t)))
304    
305  (defun sos/out (stream char)  (defun sos/write-char (stream char)
306    (let ((buffer (sos.buffer stream))    (let ((pending-output nil))
307          (index (sos.index stream)))      (system:without-interrupts
308      (setf (schar buffer index) char)        (let ((buffer (sos.buffer stream))
309      (setf (sos.index stream) (1+ index))              (index (sos.index stream)))
310      (incf (sos.column stream))          (setf (schar buffer index) char)
311      (when (char= #\newline char)          (setf (sos.index stream) (1+ index))
312        (setf (sos.column stream) 0))          (incf (sos.column stream))
313      (when (= index (1- (length buffer)))          (when (char= #\newline char)
314        (force-output stream)))            (setf (sos.column stream) 0)
315              #+(or)(setq pending-output (sos/reset-buffer stream))
316              )
317            (when (= index (1- (length buffer)))
318              (setq pending-output (sos/reset-buffer stream)))))
319        (when pending-output
320          (funcall (sos.output-fn stream) pending-output)))
321    char)    char)
322    
323  (defun sos/sout (stream string start end)  (defun sos/write-string (stream string start end)
324    (loop for i from start below end    (loop for i from start below end
325          do (sos/out stream (aref string i))))          do (sos/write-char stream (aref string i))))
326    
327    (defun sos/flush (stream)
328      (let ((string (sos/reset-buffer stream)))
329        (when string
330          (funcall (sos.output-fn stream) string))
331        nil))
332    
333    (defun sos/reset-buffer (stream)
334      (system:without-interrupts
335        (let ((end (sos.index stream)))
336          (unless (zerop end)
337            (prog1 (subseq (sos.buffer stream) 0 end)
338              (setf (sos.index stream) 0))))))
339    
340  (defun sos/misc (stream operation &optional arg1 arg2)  (defun sos/misc (stream operation &optional arg1 arg2)
341    (declare (ignore arg1 arg2))    (declare (ignore arg1 arg2))
342    (case operation    (case operation
343      ((:force-output :finish-output)      ((:force-output :finish-output) (sos/flush stream))
      (let ((end (sos.index stream)))  
        (unless (zerop end)  
          (send-to-emacs `(:read-output ,(subseq (sos.buffer stream) 0 end)))  
          (setf (sos.index stream) 0))))  
344      (:charpos (sos.column stream))      (:charpos (sos.column stream))
345      (:line-length 75)      (:line-length 75)
346      (:file-position nil)      (:file-position nil)
# Line 135  The request is read from the socket as a Line 350  The request is read from the socket as a
350      (t (format *terminal-io* "~&~Astream: ~S~%" stream operation))))      (t (format *terminal-io* "~&~Astream: ~S~%" stream operation))))
351    
352  (defstruct (slime-input-stream  (defstruct (slime-input-stream
353               (:include string-stream               (:include string-stream
354                         (lisp::in #'sis/in)                         (lisp::in #'sis/in)
355                         (lisp::misc #'sis/misc))                         (lisp::misc #'sis/misc))
356               (:conc-name sis.)               (:conc-name sis.)
357               (:print-function %print-slime-output-stream))               (:print-function %print-slime-output-stream)
358    (buffer "" :type string)               (:constructor make-slime-input-stream (input-fn)))
359    (index 0 :type kernel:index))    (input-fn nil :type function)
360      (buffer   ""  :type string)
361      (index    0   :type kernel:index))
362    
363  (defun sis/in (stream eof-errorp eof-value)  (defun sis/in (stream eof-errorp eof-value)
   (declare (ignore eof-errorp eof-value))  
364    (let ((index (sis.index stream))    (let ((index (sis.index stream))
365          (buffer (sis.buffer stream)))          (buffer (sis.buffer stream)))
366      (when (= index (length buffer))      (when (= index (length buffer))
367        (setf buffer (slime-read-string))        (let ((string (funcall (sis.input-fn stream))))
368        (setf (sis.buffer stream) buffer)          (cond ((zerop (length string))
369        (setf index 0))                 (return-from sis/in
370                     (if eof-errorp
371                         (error (make-condition 'end-of-file :stream stream))
372                         eof-value)))
373                  (t
374                   (setf buffer string)
375                   (setf (sis.buffer stream) buffer)
376                   (setf index 0)))))
377      (prog1 (aref buffer index)      (prog1 (aref buffer index)
378        (setf (sis.index stream) (1+ index)))))        (setf (sis.index stream) (1+ index)))))
379    
# Line 162  The request is read from the socket as a Line 385  The request is read from the socket as a
385      (:unread (setf (aref (sis.buffer stream)      (:unread (setf (aref (sis.buffer stream)
386                           (decf (sis.index stream)))                           (decf (sis.index stream)))
387                     arg1))                     arg1))
388      (:clear-input (setf (sis.index stream) 0      (:clear-input
389         (setf (sis.index stream) 0
390                          (sis.buffer stream) ""))                          (sis.buffer stream) ""))
391      (:listen (< (sis.index stream) (length (sis.buffer stream))))      (:listen (< (sis.index stream) (length (sis.buffer stream))))
392      (:charpos nil)      (:charpos nil)
393      (:line-length nil)      (:line-length nil)
394      (:get-command nil)      (:get-command nil)
395      (:element-type 'base-char)      (:element-type 'base-char)
396      (:close nil)))      (:close nil)
397        (:interactive-p t)))
398    
399    
400  ;;;; Compilation Commands  ;;;; Compilation Commands
401    
 (defvar *swank-source-info* nil  
   "Bound to a SOURCE-INFO object during compilation.")  
   
402  (defvar *previous-compiler-condition* nil  (defvar *previous-compiler-condition* nil
403    "Used to detect duplicates.")    "Used to detect duplicates.")
404    
405  (defvar *previous-context* nil  (defvar *previous-context* nil
406    "Previous compiler error context.")    "Previous compiler error context.")
407    
408  (defvar *compiler-notes* '()  (defvar *buffer-name* nil
409    "List of compiler notes for the last compilation unit.")    "The name of the Emacs buffer we are compiling from.
410    NIL if we aren't compiling from a buffer.")
411    
 (defvar *buffer-name* nil)  
412  (defvar *buffer-start-position* nil)  (defvar *buffer-start-position* nil)
413  (defvar *buffer-substring* nil)  (defvar *buffer-substring* nil)
 (defvar *compile-filename* nil)  
414    
415    (defimplementation call-with-compilation-hooks (function)
416      (let ((*previous-compiler-condition* nil)
417            (*previous-context* nil)
418            (*print-readably* nil))
419        (handler-bind ((c::compiler-error #'handle-notification-condition)
420                       (c::style-warning  #'handle-notification-condition)
421                       (c::warning        #'handle-notification-condition))
422          (funcall function))))
423    
424    (defimplementation swank-compile-file (input-file output-file
425                                           load-p external-format
426                                           &key policy)
427      (declare (ignore external-format policy))
428      (clear-xref-info input-file)
429      (with-compilation-hooks ()
430        (let ((*buffer-name* nil)
431              (ext:*ignore-extra-close-parentheses* nil))
432          (multiple-value-bind (output-file warnings-p failure-p)
433              (compile-file input-file :output-file output-file)
434            (values output-file warnings-p
435                    (or failure-p
436                        (when load-p
437                          ;; Cache the latest source file for definition-finding.
438                          (source-cache-get input-file
439                                            (file-write-date input-file))
440                          (not (load output-file)))))))))
441    
442    (defimplementation swank-compile-string (string &key buffer position filename
443                                             policy)
444      (declare (ignore filename policy))
445      (with-compilation-hooks ()
446        (let ((*buffer-name* buffer)
447              (*buffer-start-position* position)
448              (*buffer-substring* string)
449              (source-info (list :emacs-buffer buffer
450                                 :emacs-buffer-offset position
451                                 :emacs-buffer-string string)))
452          (with-input-from-string (stream string)
453            (let ((failurep (ext:compile-from-stream stream :source-info
454                                                    source-info)))
455              (not failurep))))))
456    
457    
458  ;;;;; Trapping notes  ;;;;; Trapping notes
459    ;;;
460    ;;; We intercept conditions from the compiler and resignal them as
461    ;;; `SWANK:COMPILER-CONDITION's.
462    
463  (defun handle-notification-condition (condition)  (defun handle-notification-condition (condition)
464    "Handle a condition caused by a compiler warning.    "Handle a condition caused by a compiler warning."
 This traps all compiler conditions at a lower-level than using  
 C:*COMPILER-NOTIFICATION-FUNCTION*. The advantage is that we get to  
 craft our own error messages, which can omit a lot of redundant  
 information."  
465    (unless (eq condition *previous-compiler-condition*)    (unless (eq condition *previous-compiler-condition*)
466      (let ((context (or (c::find-error-context nil) *previous-context*)))      (let ((context (c::find-error-context nil)))
467        (setq *previous-compiler-condition* condition)        (setq *previous-compiler-condition* condition)
468        (setq *previous-context* context)        (setq *previous-context* context)
469        (signal-compiler-condition condition context))))        (signal-compiler-condition condition context))))
# Line 211  information." Line 473  information."
473             'compiler-condition             'compiler-condition
474             :original-condition condition             :original-condition condition
475             :severity (severity-for-emacs condition)             :severity (severity-for-emacs condition)
476             :message (brief-compiler-message-for-emacs condition context)             :message (compiler-condition-message condition)
477             :location (compiler-note-location context))))             :source-context (compiler-error-context context)
478               :location (if (read-error-p condition)
479                             (read-error-location condition)
480                             (compiler-note-location context)))))
481    
482  (defun severity-for-emacs (condition)  (defun severity-for-emacs (condition)
483    "Return the severity of CONDITION."    "Return the severity of CONDITION."
484    (etypecase condition    (etypecase condition
485        ((satisfies read-error-p) :read-error)
486      (c::compiler-error :error)      (c::compiler-error :error)
487      (c::style-warning :note)      (c::style-warning :note)
488      (c::warning :warning)))      (c::warning :warning)))
489    
490  (defun brief-compiler-message-for-emacs (condition error-context)  (defun read-error-p (condition)
491      (eq (type-of condition) 'c::compiler-read-error))
492    
493    (defun compiler-condition-message (condition)
494    "Briefly describe a compiler error for Emacs.    "Briefly describe a compiler error for Emacs.
495  When Emacs presents the message it already has the source popped up  When Emacs presents the message it already has the source popped up
496  and the source form highlighted. This makes much of the information in  and the source form highlighted. This makes much of the information in
497  the error-context redundant."  the error-context redundant."
498      (princ-to-string condition))
499    
500    (defun compiler-error-context (error-context)
501      "Describe context information for Emacs."
502    (declare (type (or c::compiler-error-context null) error-context))    (declare (type (or c::compiler-error-context null) error-context))
503    (multiple-value-bind (enclosing source)    (multiple-value-bind (enclosing source)
504        (if error-context        (if error-context
505            (values (c::compiler-error-context-enclosing-source error-context)            (values (c::compiler-error-context-enclosing-source error-context)
506                    (c::compiler-error-context-source error-context)))                    (c::compiler-error-context-source error-context)))
507      (format nil "~@[--> ~{~<~%--> ~1:;~A~> ~}~%~]~@[~{==>~%~A~^~%~}~]~A"      (if (or enclosing source)
508              enclosing source condition)))          (format nil "~@[--> ~{~<~%--> ~1:;~A ~>~}~%~]~
509                         ~@[==>~{~&~A~}~]"
510                    enclosing source))))
511    
512    (defun read-error-location (condition)
513      (let* ((finfo (car (c::source-info-current-file c::*source-info*)))
514             (file (c::file-info-name finfo))
515             (pos (c::compiler-read-error-position condition)))
516        (cond ((and (eq file :stream) *buffer-name*)
517               (make-location (list :buffer *buffer-name*)
518                              (list :offset *buffer-start-position* pos)))
519              ((and (pathnamep file) (not *buffer-name*))
520               (make-location (list :file (unix-truename file))
521                              (list :position (1+ pos))))
522              (t (break)))))
523    
524  (defun compiler-note-location (context)  (defun compiler-note-location (context)
525    (cond (context    "Derive the location of a complier message from its context.
526           (resolve-note-location  Return a `location' record, or (:error REASON) on failure."
527            *buffer-name*    (if (null context)
528            (c::compiler-error-context-file-name context)        (note-error-location)
529            (c::compiler-error-context-file-position context)        (with-struct (c::compiler-error-context- file-name
530            (reverse (c::compiler-error-context-original-source-path context))                                                 original-source
531            (c::compiler-error-context-original-source context)))                                                 original-source-path) context
532          (t          (or (locate-compiler-note file-name original-source
533           (resolve-note-location *buffer-name* nil nil nil nil))))                                    (reverse original-source-path))
534                (note-error-location)))))
535  (defgeneric resolve-note-location (buffer file-name file-position  
536                                            source-path source))  (defun note-error-location ()
537      "Pseudo-location for notes that can't be located."
538  (defmethod resolve-note-location ((b (eql nil)) (f pathname) pos path source)    (cond (*compile-file-truename*
539    (make-location           (make-location (list :file (unix-truename *compile-file-truename*))
540     `(:file ,(unix-truename f))                          (list :eof)))
541     `(:position ,(1+ (source-path-file-position path f)))))          (*buffer-name*
542             (make-location (list :buffer *buffer-name*)
 (defmethod resolve-note-location ((b string) (f (eql :stream)) pos path source)  
   (make-location  
    `(:buffer ,b)  
    `(:position ,(+ *buffer-start-position*  
                    (source-path-string-position path *buffer-substring*)))))  
   
 (defmethod resolve-note-location (b (f (eql :lisp)) pos path (source string))  
   (make-location  
    `(:source-form ,source)  
    `(:position 1)))  
   
 (defmethod resolve-note-location (buffer  
                                   (file (eql nil))  
                                   (pos (eql nil))  
                                   (path (eql nil))  
                                   (source (eql nil)))  
   (cond (buffer  
          (make-location (list :buffer buffer)  
543                          (list :position *buffer-start-position*)))                          (list :position *buffer-start-position*)))
544          (*compile-file-truename*          (t (list :error "No error location available."))))
          (make-location (list :file (namestring *compile-file-truename*))  
                         (list :position 0)))  
         (*compile-filename*  
          (make-location (list :file *compile-filename*) (list :position 0)))  
         (t  
          (list :error "No error location available"))))  
   
 (defmacro with-compilation-hooks (() &body body)  
   "Execute BODY and record the set of compiler notes."  
   `(let ((*previous-compiler-condition* nil)  
          (*previous-context* nil)  
          (*print-readably* nil))  
     (handler-bind ((c::compiler-error #'handle-notification-condition)  
                    (c::style-warning  #'handle-notification-condition)  
                    (c::warning        #'handle-notification-condition))  
       ,@body)))  
545    
546  (defmethod compile-file-for-emacs (filename load-p)  (defun locate-compiler-note (file source source-path)
547    (clear-xref-info filename)    (cond ((and (eq file :stream) *buffer-name*)
548    (with-compilation-hooks ()           ;; Compiling from a buffer
549      (let ((*buffer-name* nil)           (make-location (list :buffer *buffer-name*)
550            (*compile-filename* filename))                          (list :offset *buffer-start-position*
551          (compile-file filename :load load-p))))                                (source-path-string-position
552                                   source-path *buffer-substring*))))
553            ((and (pathnamep file) (null *buffer-name*))
554             ;; Compiling from a file
555             (make-location (list :file (unix-truename file))
556                            (list :position (1+ (source-path-file-position
557                                                 source-path file)))))
558            ((and (eq file :lisp) (stringp source))
559             ;; No location known, but we have the source form.
560             ;; XXX How is this case triggered?  -luke (16/May/2004)
561             ;; This can happen if the compiler needs to expand a macro
562             ;; but the macro-expander is not yet compiled.  Calling the
563             ;; (interpreted) macro-expander triggers IR1 conversion of
564             ;; the lambda expression for the expander and invokes the
565             ;; compiler recursively.
566             (make-location (list :source-form source)
567                            (list :position 1)))))
568    
569  (defmethod compile-string-for-emacs (string &key buffer position)  (defun unix-truename (pathname)
570    (with-compilation-hooks ()    (ext:unix-namestring (truename pathname)))
     (let ((*package* *buffer-package*)  
           (*compile-filename* nil)  
           (*buffer-name* buffer)  
           (*buffer-start-position* position)  
           (*buffer-substring* string))  
       (with-input-from-string (stream string)  
         (ext:compile-from-stream  
          stream  
          :source-info `(:emacs-buffer ,buffer  
                         :emacs-buffer-offset ,position  
                         :emacs-buffer-string ,string))))))  
571    
572    
573  ;;;; XREF  ;;;; XREF
574    ;;;
575    ;;; Cross-reference support is based on the standard CMUCL `XREF'
576    ;;; package. This package has some caveats: XREF information is
577    ;;; recorded during compilation and not preserved in fasl files, and
578    ;;; XREF recording is disabled by default. Redefining functions can
579    ;;; also cause duplicate references to accumulate, but
580    ;;; `swank-compile-file' will automatically clear out any old records
581    ;;; from the same filename.
582    ;;;
583    ;;; To enable XREF recording, set `c:*record-xref-info*' to true. To
584    ;;; clear out the XREF database call `xref:init-xref-database'.
585    
586  (defun lookup-xrefs (finder name)  (defmacro defxref (name function)
587    (xref-results-for-emacs (funcall finder (from-string name))))    `(defimplementation ,name (name)
588        (xref-results (,function name))))
589  (defslimefun who-calls (function-name)  
590    "Return the places where FUNCTION-NAME is called."  (defxref who-calls      xref:who-calls)
591    (lookup-xrefs #'xref:who-calls function-name))  (defxref who-references xref:who-references)
592    (defxref who-binds      xref:who-binds)
593  (defslimefun who-references (variable)  (defxref who-sets       xref:who-sets)
   "Return the places where the global variable VARIABLE is referenced."  
   (lookup-xrefs #'xref:who-references variable))  
   
 (defslimefun who-binds (variable)  
   "Return the places where the global variable VARIABLE is bound."  
   (lookup-xrefs #'xref:who-binds variable))  
   
 (defslimefun who-sets (variable)  
   "Return the places where the global variable VARIABLE is set."  
   (lookup-xrefs #'xref:who-sets variable))  
594    
595  #+cmu19  ;;; More types of XREF information were added since 18e:
596    ;;;
597    #-cmu18
598  (progn  (progn
599    (defslimefun who-macroexpands (macro)    (defxref who-macroexpands xref:who-macroexpands)
600      "Return the places where MACRO is expanded."    ;; XXX
601      (lookup-xrefs #'xref:who-macroexpands macro))    (defimplementation who-specializes (symbol)
602        (let* ((methods (xref::who-specializes (find-class symbol)))
603    (defslimefun who-specializes (class)             (locations (mapcar #'method-location methods)))
604      "Return the methods with specializers for CLASS."        (mapcar #'list methods locations))))
605      (let* ((methods (xref::who-specializes (find-class (from-string class))))  
606             (locations (mapcar #'method-source-location methods)))  (defun xref-results (contexts)
607        (group-xrefs (mapcar (lambda (m l)    (mapcar (lambda (xref)
608                               (cons (let ((*print-pretty* nil))              (list (xref:xref-context-name xref)
609                                       (to-string m))                    (resolve-xref-location xref)))
610                                     l))            contexts))
                            methods locations))))  
   )  
611    
612  (defun resolve-xref-location (xref)  (defun resolve-xref-location (xref)
613    (let ((name (xref:xref-context-name xref))    (let ((name (xref:xref-context-name xref))
# Line 363  the error-context redundant." Line 621  the error-context redundant."
621             (make-location (list :file (unix-truename file))             (make-location (list :file (unix-truename file))
622                            (list :function-name (string name))))                            (list :function-name (string name))))
623            (t            (t
624             `(:error ,(format nil "Unkown source location: ~S ~S ~S "             `(:error ,(format nil "Unknown source location: ~S ~S ~S "
625                               name file source-path))))))                               name file source-path))))))
626    
   
 (defun xref-results-for-emacs (contexts)  
   "Prepare a list of xref contexts for Emacs.  
 The result is a list of xrefs:  
 group       ::= (FILENAME . ({reference}+))  
 reference   ::= (FUNCTION-SPECIFIER . SOURCE-LOCATION)"  
   (let ((xrefs '()))  
     (dolist (cxt contexts)  
       (let ((name (xref:xref-context-name cxt)))  
         (push (cons (to-string name)  
                     (resolve-xref-location cxt))  
               xrefs)))  
     (group-xrefs xrefs)))  
   
   
 (defun location-buffer= (location1 location2)  
   (equalp location1 location2))  
   
 (defun file-xrefs-for-emacs (unix-filename contexts)  
   "Return a summary of the references from a particular file.  
 The result is a list of the form (FILENAME ((REFERRER SOURCE-PATH) ...))"  
   (list unix-filename  
         (loop for context in (sort-contexts-by-source-path contexts)  
               collect (list (let ((*print-pretty* nil))  
                               (to-string (xref:xref-context-name context)))  
                             (xref:xref-context-source-path context)))))  
   
 (defun sort-contexts-by-source-path (contexts)  
   "Sort xref contexts by lexical position of source-paths.  
 It is assumed that all contexts belong to the same file."  
   (sort contexts #'source-path< :key #'xref:xref-context-source-path))  
   
 (defun source-path< (path1 path2)  
   "Return true if PATH1 is lexically before PATH2."  
   (and (every #'< path1 path2)  
        (< (length path1) (length path2))))  
   
627  (defun clear-xref-info (namestring)  (defun clear-xref-info (namestring)
628    "Clear XREF notes pertaining to FILENAME.    "Clear XREF notes pertaining to NAMESTRING.
629  This is a workaround for a CMUCL bug: XREF records are cumulative."  This is a workaround for a CMUCL bug: XREF records are cumulative."
630    (let ((filename (parse-namestring namestring)))    (when c:*record-xref-info*
631      (when c:*record-xref-info*      (let ((filename (truename namestring)))
632        (dolist (db (list xref::*who-calls*        (dolist (db (list xref::*who-calls*
633                          #+cmu19 xref::*who-is-called*                          #-cmu18 xref::*who-is-called*
634                          #+cmu19 xref::*who-macroexpands*                          #-cmu18 xref::*who-macroexpands*
635                          xref::*who-references*                          xref::*who-references*
636                          xref::*who-binds*                          xref::*who-binds*
637                          xref::*who-sets*))                          xref::*who-sets*))
638          (maphash (lambda (target contexts)          (maphash (lambda (target contexts)
639                       ;; XXX update during traversal?
640                     (setf (gethash target db)                     (setf (gethash target db)
641                           (delete-if                           (delete filename contexts
642                            (lambda (ctx)                                   :key #'xref:xref-context-file
643                              (xref-context-derived-from-p ctx filename))                                   :test #'equalp)))
                           contexts)))  
644                   db)))))                   db)))))
645    
 (defun xref-context-derived-from-p (context filename)  
   (let ((xref-file (xref:xref-context-file context)))  
     (and xref-file (pathname= filename xref-file))))  
   
 (defun pathname= (&rest pathnames)  
   "True if PATHNAMES refer to the same file."  
   (apply #'string= (mapcar #'unix-truename pathnames)))  
   
 (defun unix-truename (pathname)  
   (ext:unix-namestring (truename pathname)))  
   
646    
647  ;;;; Find callers and callees  ;;;; Find callers and callees
648    ;;;
649  ;;; Find callers and callees by looking at the constant pool of  ;;; Find callers and callees by looking at the constant pool of
650  ;;; compiled code objects.  We assume every fdefn object in the  ;;; compiled code objects.  We assume every fdefn object in the
651  ;;; constant pool corresponds to a call to that function.  A better  ;;; constant pool corresponds to a call to that function.  A better
652  ;;; strategy would be to use the disassembler to find actual  ;;; strategy would be to use the disassembler to find actual
653  ;;; call-sites.  ;;; call-sites.
654    
655  (declaim (inline map-code-constants))  (labels ((make-stack () (make-array 100 :fill-pointer 0 :adjustable t))
656  (defun map-code-constants (code fn)           (map-cpool (code fun)
657    "Call FN for each constant in CODE's constant pool."             (declare (type kernel:code-component code) (type function fun))
658    (check-type code kernel:code-component)             (loop for i from vm:code-constants-offset
659    (loop for i from vm:code-constants-offset below (kernel:get-header-data code)                   below (kernel:get-header-data code)
660          do (funcall fn (kernel:code-header-ref code i))))                   do (funcall fun (kernel:code-header-ref code i))))
661    
662  (defun function-callees (function)           (callees (fun)
663    "Return FUNCTION's callees as a list of functions."             (let ((callees (make-stack)))
664    (let ((callees '()))               (map-cpool (vm::find-code-object fun)
665      (map-code-constants                          (lambda (o)
666       (vm::find-code-object function)                            (when (kernel:fdefn-p o)
667       (lambda (obj)                              (vector-push-extend (kernel:fdefn-function o)
668         (when (kernel:fdefn-p obj)                                                  callees))))
669           (push (kernel:fdefn-function obj) callees))))               (coerce callees 'list)))
670      callees))  
671             (callers (fun)
672  (declaim (ext:maybe-inline map-allocated-code-components))             (declare (function fun))
673  (defun map-allocated-code-components (spaces fn)             (let ((callers (make-stack)))
674    "Call FN for each allocated code component in one of SPACES.  FN               (ext:gc :full t)
675  receives the object as argument.  SPACES should be a list of the               ;; scan :dynamic first to avoid the need for even more gcing
676  symbols :dynamic, :static, or :read-only."               (dolist (space '(:dynamic :read-only :static))
677    (dolist (space spaces)                 (vm::map-allocated-objects
678      (declare (inline vm::map-allocated-objects))                  (lambda (obj header size)
679      (vm::map-allocated-objects                    (declare (type fixnum header) (ignore size))
680       (lambda (obj header size)                    (when (= vm:code-header-type header)
681         (declare (type fixnum size) (ignore size))                      (map-cpool obj
682         (when (= vm:code-header-type header)                                 (lambda (c)
683           (funcall fn obj)))                                   (when (and (kernel:fdefn-p c)
684       space)))                                              (eq (kernel:fdefn-function c) fun))
685                                       (vector-push-extend obj callers))))))
686  (declaim (ext:maybe-inline map-caller-code-components))                  space)
687  (defun map-caller-code-components (function spaces fn)                 (ext:gc))
688    "Call FN for each code component with a fdefn for FUNCTION in its               (coerce callers 'list)))
689  constant pool."  
690    (let ((function (coerce function 'function)))           (entry-points (code)
691      (declare (inline map-allocated-code-components))             (loop for entry = (kernel:%code-entry-points code)
692      (map-allocated-code-components                   then (kernel::%function-next entry)
693       spaces                   while entry
694       (lambda (obj)                   collect entry))
695         (map-code-constants  
696          obj           (guess-main-entry-point (entry-points)
697          (lambda (constant)             (or (find-if (lambda (fun)
698            (when (and (kernel:fdefn-p constant)                            (ext:valid-function-name-p
699                       (eq (kernel:fdefn-function constant)                             (kernel:%function-name fun)))
700                           function))                          entry-points)
701              (funcall fn obj))))))))                 (car entry-points)))
702    
703  (defun function-callers (function &optional (spaces '(:read-only :static           (fun-dspec (fun)
704                                                        :dynamic)))             (list (kernel:%function-name fun) (function-location fun)))
705    "Return FUNCTION's callers.  The result is a list of code-objects."  
706    (let ((referrers '()))           (code-dspec (code)
707      (declare (inline map-caller-code-components))             (let ((eps (entry-points code))
708      (ext:gc :full t)                   (di (kernel:%code-debug-info code)))
709      (map-caller-code-components function spaces               (cond (eps (fun-dspec (guess-main-entry-point eps)))
710                                  (lambda (code) (push code referrers)))                     (di (list (c::debug-info-name di)
711      referrers))                               (debug-info-function-name-location di)))
712                       (t (list (princ-to-string code)
713  (defun debug-info-definitions (debug-info)                              `(:error "No src-loc available")))))))
714    "Return the defintions for a debug-info.  This should only be used    (declare (inline map-cpool))
715  for code-object without entry points, i.e., byte compiled  
716  code (are theree others?)"    (defimplementation list-callers (symbol)
717    ;; This mess has only been tested with #'ext::skip-whitespace, a      (mapcar #'code-dspec (callers (coerce symbol 'function) )))
718    ;; byte-compiled caller of #'read-char .  
719    (check-type debug-info (and (not c::compiled-debug-info) c::debug-info))    (defimplementation list-callees (symbol)
720    (let ((name (c::debug-info-name debug-info))      (mapcar #'fun-dspec (callees symbol))))
721          (source (c::debug-info-source debug-info)))  
722      (destructuring-bind (first) source  (defun test-list-callers (count)
723        (ecase (c::debug-source-from first)    (let ((funsyms '()))
724          (:file      (do-all-symbols (s)
725           (list        (when (and (fboundp s)
726            (cons name                   (functionp (symbol-function s))
727                  (make-location                   (not (macro-function s))
728                   (list :file (unix-truename (c::debug-source-name first)))                   (not (special-operator-p s)))
729                   (list :function-name name)))))))))          (push s funsyms)))
730        (let ((len (length funsyms)))
731  (defun code-component-entry-points (code)        (dotimes (i count)
732    "Return a list ((NAME . LOCATION) ...) of function definitons for          (let ((sym (nth (random len) funsyms)))
733  the code omponent CODE."            (format t "~s -> ~a~%" sym (mapcar #'car (list-callers sym))))))))
   (delete-duplicates  
    (loop for e = (kernel:%code-entry-points code)  
          then (kernel::%function-next e)  
          while e  
          collect (cons (to-string (kernel:%function-name e))  
                        (function-source-location e)))  
    :test #'equal))  
   
 (defslimefun list-callers (symbol-name)  
   "Return a list ((FILE . ((NAME . LOCATION) ...)) ...) of callers."  
   (let ((components (function-callers (from-string symbol-name)))  
         (xrefs '()))  
     (dolist (code components)  
       (let* ((entry (kernel:%code-entry-points code))  
              (defs (if entry  
                        (code-component-entry-points code)  
                        ;; byte compiled stuff  
                        (debug-info-definitions  
                         (kernel:%code-debug-info code)))))  
         (setq xrefs (nconc defs xrefs))))  
     (group-xrefs xrefs)))  
   
   
 (defslimefun list-callees (symbol-name)  
   (let ((fns (function-callees (from-string symbol-name))))  
     (group-xrefs (mapcar (lambda (fn)  
                            (cons (to-string (kernel:%function-name fn))  
                                  (function-source-location fn)))  
                          fns))))  
734    
735  ;;;; Definitions  ;; (test-list-callers 100)
736    
737  (defvar *debug-definition-finding* t  
738    ;;;; Resolving source locations
739    ;;;
740    ;;; Our mission here is to "resolve" references to code locations into
741    ;;; actual file/buffer names and character positions. The references
742    ;;; we work from come out of the compiler's statically-generated debug
743    ;;; information, such as `code-location''s and `debug-source''s. For
744    ;;; more details, see the "Debugger Programmer's Interface" section of
745    ;;; the CMUCL manual.
746    ;;;
747    ;;; The first step is usually to find the corresponding "source-path"
748    ;;; for the location. Once we have the source-path we can pull up the
749    ;;; source file and `READ' our way through to the right position. The
750    ;;; main source-code groveling work is done in
751    ;;; `swank-source-path-parser.lisp'.
752    
753    (defvar *debug-definition-finding* nil
754    "When true don't handle errors while looking for definitions.    "When true don't handle errors while looking for definitions.
755  This is useful when debugging the definition-finding code.")  This is useful when debugging the definition-finding code.")
756    
757    (defvar *source-snippet-size* 256
758      "Maximum number of characters in a snippet of source code.
759    Snippets at the beginning of definitions are used to tell Emacs what
760    the definitions looks like, so that it can accurately find them by
761    text search.")
762    
763  (defmacro safe-definition-finding (&body body)  (defmacro safe-definition-finding (&body body)
764    "Execute BODY ignoring errors.  Return a the source location    "Execute BODY and return the source-location it returns.
765  returned by BODY or if an error occurs a description of the error.  If an error occurs and `*debug-definition-finding*' is false, then
766  The second return value is the condition or nil."  return an error pseudo-location.
767    
768    The second return value is NIL if no error occurs, otherwise it is the
769    condition object."
770    `(flet ((body () ,@body))    `(flet ((body () ,@body))
771      (if *debug-definition-finding*      (if *debug-definition-finding*
772          (body)          (body)
773          (handler-case (values (progn ,@body) nil)          (handler-case (values (progn ,@body) nil)
774            (error (c) (values (list :error (princ-to-string c)) c))))))            (error (c) (values `(:error ,(trim-whitespace (princ-to-string c)))
775                                 c))))))
776    
777    (defun trim-whitespace (string)
778      (string-trim #(#\newline #\space #\tab) string))
779    
780    (defun code-location-source-location (code-location)
781      "Safe wrapper around `code-location-from-source-location'."
782      (safe-definition-finding
783       (source-location-from-code-location code-location)))
784    
785    (defun source-location-from-code-location (code-location)
786      "Return the source location for CODE-LOCATION."
787      (let ((debug-fun (di:code-location-debug-function code-location)))
788        (when (di::bogus-debug-function-p debug-fun)
789          ;; Those lousy cheapskates! They've put in a bogus debug source
790          ;; because the code was compiled at a low debug setting.
791          (error "Bogus debug function: ~A" debug-fun)))
792      (let* ((debug-source (di:code-location-debug-source code-location))
793             (from (di:debug-source-from debug-source))
794             (name (di:debug-source-name debug-source)))
795        (ecase from
796          (:file
797           (location-in-file name code-location debug-source))
798          (:stream
799           (location-in-stream code-location debug-source))
800          (:lisp
801           ;; The location comes from a form passed to `compile'.
802           ;; The best we can do is return the form itself for printing.
803           (make-location
804            (list :source-form (with-output-to-string (*standard-output*)
805                                 (debug::print-code-location-source-form
806                                  code-location 100 t)))
807            (list :position 1))))))
808    
809    (defun location-in-file (filename code-location debug-source)
810      "Resolve the source location for CODE-LOCATION in FILENAME."
811      (let* ((code-date (di:debug-source-created debug-source))
812             (root-number (di:debug-source-root-number debug-source))
813             (source-code (get-source-code filename code-date)))
814        (with-input-from-string (s source-code)
815          (make-location (list :file (unix-truename filename))
816                         (list :position (1+ (code-location-stream-position
817                                              code-location s root-number)))
818                         `(:snippet ,(read-snippet s))))))
819    
820    (defun location-in-stream (code-location debug-source)
821      "Resolve the source location for a CODE-LOCATION from a stream.
822    This only succeeds if the code was compiled from an Emacs buffer."
823      (unless (debug-source-info-from-emacs-buffer-p debug-source)
824        (error "The code is compiled from a non-SLIME stream."))
825      (let* ((info (c::debug-source-info debug-source))
826             (string (getf info :emacs-buffer-string))
827             (position (code-location-string-offset
828                        code-location
829                        string)))
830        (make-location
831         (list :buffer (getf info :emacs-buffer))
832         (list :offset (getf info :emacs-buffer-offset) position)
833         (list :snippet (with-input-from-string (s string)
834                          (file-position s position)
835                          (read-snippet s))))))
836    
837    ;;;;; Function-name locations
838    ;;;
839    (defun debug-info-function-name-location (debug-info)
840      "Return a function-name source-location for DEBUG-INFO.
841    Function-name source-locations are a fallback for when precise
842    positions aren't available."
843      (with-struct (c::debug-info- (fname name) source) debug-info
844        (with-struct (c::debug-source- info from name) (car source)
845          (ecase from
846            (:file
847             (make-location (list :file (namestring (truename name)))
848                            (list :function-name (string fname))))
849            (:stream
850             (assert (debug-source-info-from-emacs-buffer-p (car source)))
851             (make-location (list :buffer (getf info :emacs-buffer))
852                            (list :function-name (string fname))))
853            (:lisp
854             (make-location (list :source-form (princ-to-string (aref name 0)))
855                            (list :position 1)))))))
856    
857    (defun debug-source-info-from-emacs-buffer-p (debug-source)
858      "Does the `info' slot of DEBUG-SOURCE contain an Emacs buffer location?
859    This is true for functions that were compiled directly from buffers."
860      (info-from-emacs-buffer-p (c::debug-source-info debug-source)))
861    
862    (defun info-from-emacs-buffer-p (info)
863      (and info
864           (consp info)
865           (eq :emacs-buffer (car info))))
866    
867    
868    ;;;;; Groveling source-code for positions
869    
870    (defun code-location-stream-position (code-location stream root)
871      "Return the byte offset of CODE-LOCATION in STREAM.  Extract the
872    toplevel-form-number and form-number from CODE-LOCATION and use that
873    to find the position of the corresponding form.
874    
875    Finish with STREAM positioned at the start of the code location."
876      (let* ((location (debug::maybe-block-start-location code-location))
877             (tlf-offset (- (di:code-location-top-level-form-offset location)
878                            root))
879             (form-number (di:code-location-form-number location)))
880        (let ((pos (form-number-stream-position tlf-offset form-number stream)))
881          (file-position stream pos)
882          pos)))
883    
884    (defun form-number-stream-position (tlf-number form-number stream)
885      "Return the starting character position of a form in STREAM.
886    TLF-NUMBER is the top-level-form number.
887    FORM-NUMBER is an index into a source-path table for the TLF."
888      (multiple-value-bind (tlf position-map) (read-source-form tlf-number stream)
889        (let* ((path-table (di:form-number-translations tlf 0))
890               (source-path
891                (if (<= (length path-table) form-number) ; source out of sync?
892                    (list 0)                ; should probably signal a condition
893                    (reverse (cdr (aref path-table form-number))))))
894          (source-path-source-position source-path tlf position-map))))
895    
896    (defun code-location-string-offset (code-location string)
897      "Return the byte offset of CODE-LOCATION in STRING.
898    See CODE-LOCATION-STREAM-POSITION."
899      (with-input-from-string (s string)
900        (code-location-stream-position code-location s 0)))
901    
902    
903    ;;;; Finding definitions
904    
905    ;;; There are a great many different types of definition for us to
906    ;;; find. We search for definitions of every kind and return them in a
907    ;;; list.
908    
909    (defimplementation find-definitions (name)
910      (append (function-definitions name)
911              (setf-definitions name)
912              (variable-definitions name)
913              (class-definitions name)
914              (type-definitions name)
915              (compiler-macro-definitions name)
916              (source-transform-definitions name)
917              (function-info-definitions name)
918              (ir1-translator-definitions name)
919              (template-definitions name)
920              (primitive-definitions name)
921              (vm-support-routine-definitions name)
922              ))
923    
924    ;;;;; Functions, macros, generic functions, methods
925    ;;;
926    ;;; We make extensive use of the compile-time debug information that
927    ;;; CMUCL records, in particular "debug functions" and "code
928    ;;; locations." Refer to the "Debugger Programmer's Interface" section
929    ;;; of the CMUCL manual for more details.
930    
931    (defun function-definitions (name)
932      "Return definitions for NAME in the \"function namespace\", i.e.,
933    regular functions, generic functions, methods and macros.
934    NAME can any valid function name (e.g, (setf car))."
935      (let ((macro?    (and (symbolp name) (macro-function name)))
936            (function? (and (ext:valid-function-name-p name)
937                            (ext:info :function :definition name)
938                            (if (symbolp name) (fboundp name) t))))
939        (cond (macro?
940               (list `((defmacro ,name)
941                       ,(function-location (macro-function name)))))
942              (function?
943               (let ((function (fdefinition name)))
944                 (if (genericp function)
945                     (gf-definitions name function)
946                     (list (list `(function ,name)
947                                 (function-location function)))))))))
948    
949    ;;;;;; Ordinary (non-generic/macro/special) functions
950    ;;;
951    ;;; First we test if FUNCTION is a closure created by defstruct, and
952    ;;; if so extract the defstruct-description (`dd') from the closure
953    ;;; and find the constructor for the struct.  Defstruct creates a
954    ;;; defun for the default constructor and we use that as an
955    ;;; approximation to the source location of the defstruct.
956    ;;;
957    ;;; For an ordinary function we return the source location of the
958    ;;; first code-location we find.
959    ;;;
960    (defun function-location (function)
961      "Return the source location for FUNCTION."
962      (cond ((struct-closure-p function)
963             (struct-closure-location function))
964            ((c::byte-function-or-closure-p function)
965             (byte-function-location function))
966            (t
967             (compiled-function-location function))))
968    
969    (defun compiled-function-location (function)
970      "Return the location of a regular compiled function."
971      (multiple-value-bind (code-location error)
972          (safe-definition-finding (function-first-code-location function))
973        (cond (error (list :error (princ-to-string error)))
974              (t (code-location-source-location code-location)))))
975    
976  (defun function-first-code-location (function)  (defun function-first-code-location (function)
977      "Return the first code-location we can find for FUNCTION."
978    (and (function-has-debug-function-p function)    (and (function-has-debug-function-p function)
979         (di:debug-function-start-location         (di:debug-function-start-location
980          (di:function-debug-function function))))          (di:function-debug-function function))))
# Line 580  The second return value is the condition Line 987  The second return value is the condition
987             (vm::find-code-object function))             (vm::find-code-object function))
988         (not (eq closure function))))         (not (eq closure function))))
989    
990    (defun byte-function-location (fun)
991      "Return the location of the byte-compiled function FUN."
992      (etypecase fun
993        ((or c::hairy-byte-function c::simple-byte-function)
994         (let* ((di (kernel:%code-debug-info (c::byte-function-component fun))))
995           (if di
996               (debug-info-function-name-location di)
997               `(:error
998                 ,(format nil "Byte-function without debug-info: ~a" fun)))))
999        (c::byte-closure
1000         (byte-function-location (c::byte-closure-function fun)))))
1001    
1002    ;;; Here we deal with structure accessors. Note that `dd' is a
1003    ;;; "defstruct descriptor" structure in CMUCL. A `dd' describes a
1004    ;;; `defstruct''d structure.
1005    
1006  (defun struct-closure-p (function)  (defun struct-closure-p (function)
1007      "Is FUNCTION a closure created by defstruct?"
1008    (or (function-code-object= function #'kernel::structure-slot-accessor)    (or (function-code-object= function #'kernel::structure-slot-accessor)
1009        (function-code-object= function #'kernel::structure-slot-setter)        (function-code-object= function #'kernel::structure-slot-setter)
1010        (function-code-object= function #'kernel::%defstruct)))        (function-code-object= function #'kernel::%defstruct)))
1011    
1012    (defun struct-closure-location (function)
1013      "Return the location of the structure that FUNCTION belongs to."
1014      (assert (struct-closure-p function))
1015      (safe-definition-finding
1016        (dd-location (struct-closure-dd function))))
1017    
1018  (defun struct-closure-dd (function)  (defun struct-closure-dd (function)
1019      "Return the defstruct-definition (dd) of FUNCTION."
1020    (assert (= (kernel:get-type function) vm:closure-header-type))    (assert (= (kernel:get-type function) vm:closure-header-type))
1021    (flet ((find-layout (function)    (flet ((find-layout (function)
1022             (sys:find-if-in-closure             (sys:find-if-in-closure
# Line 597  The second return value is the condition Line 1028  The second return value is the condition
1028                    (return-from find-layout value))))                    (return-from find-layout value))))
1029              function)))              function)))
1030      (kernel:layout-info (find-layout function))))      (kernel:layout-info (find-layout function))))
1031    
1032  (defun dd-source-location (dd)  (defun dd-location (dd)
1033    (let ((constructor (or (kernel:dd-default-constructor dd)    "Return the location of a `defstruct'."
1034                           (car (kernel::dd-constructors dd)))))    ;; Find the location in a constructor.
1035      (when (or (not constructor) (and (consp constructor)    (function-location (struct-constructor dd)))
1036                                       (not (car constructor))))  
1037        (error "Cannot locate struct without constructor: ~S"  (defun struct-constructor (dd)
1038               (kernel::dd-name dd)))    "Return a constructor function from a defstruct definition.
1039      (function-source-location  Signal an error if no constructor can be found."
1040       (coerce (if (consp constructor) (car constructor) constructor)    (let* ((constructor (or (kernel:dd-default-constructor dd)
1041               'function))))                            (car (kernel::dd-constructors dd))))
1042             (sym (if (consp constructor) (car constructor) constructor)))
1043        (unless sym
1044          (error "Cannot find structure's constructor: ~S" (kernel::dd-name dd)))
1045        (coerce sym 'function)))
1046    
1047    ;;;;;; Generic functions and methods
1048    
1049    (defun gf-definitions (name function)
1050      "Return the definitions of a generic function and its methods."
1051      (cons (list `(defgeneric ,name) (gf-location function))
1052            (gf-method-definitions function)))
1053    
1054    (defun gf-location (gf)
1055      "Return the location of the generic function GF."
1056      (definition-source-location gf (pcl::generic-function-name gf)))
1057    
1058    (defun gf-method-definitions (gf)
1059      "Return the locations of all methods of the generic function GF."
1060      (mapcar #'method-definition (pcl::generic-function-methods gf)))
1061    
1062    (defun method-definition (method)
1063      (list (method-dspec method)
1064            (method-location method)))
1065    
1066    (defun method-dspec (method)
1067      "Return a human-readable \"definition specifier\" for METHOD."
1068      (let* ((gf (pcl:method-generic-function method))
1069             (name (pcl:generic-function-name gf))
1070             (specializers (pcl:method-specializers method))
1071             (qualifiers (pcl:method-qualifiers method)))
1072        `(method ,name ,@qualifiers ,(pcl::unparse-specializers specializers))))
1073    
1074    ;; XXX maybe special case setters/getters
1075    (defun method-location (method)
1076      (function-location (or (pcl::method-fast-function method)
1077                             (pcl:method-function method))))
1078    
1079  (defun genericp (fn)  (defun genericp (fn)
1080    (typep fn 'generic-function))    (typep fn 'generic-function))
1081    
1082  (defun gf-definition-location (gf)  ;;;;;; Types and classes
1083    (flet ((guess-source-file (faslfile)  
1084             (unix-truename  (defun type-definitions (name)
1085              (merge-pathnames (make-pathname :type "lisp")    "Return `deftype' locations for type NAME."
1086                               faslfile))))    (maybe-make-definition (ext:info :type :expander name) 'deftype name))
1087      (let ((def-source (pcl::definition-source gf))  
1088            (name (string (pcl:generic-function-name gf))))  (defun maybe-make-definition (function kind name)
1089        (etypecase def-source    "If FUNCTION is non-nil then return its definition location."
1090          (pathname (make-location    (if function
1091                     `(:file ,(guess-source-file def-source))        (list (list `(,kind ,name) (function-location function)))))
1092                     `(:function-name ,name)))  
1093          (cons  (defun class-definitions (name)
1094           (destructuring-bind ((dg name) pathname) def-source    "Return the definition locations for the class called NAME."
1095             (declare (ignore dg))    (if (symbolp name)
1096             (etypecase pathname        (let ((class (kernel::find-class name nil)))
1097               (pathname          (etypecase class
1098                (make-location `(:file ,(guess-source-file pathname))            (null '())
1099                               `(:function-name ,(string name)))))))))))            (kernel::structure-class
1100               (list (list `(defstruct ,name) (dd-location (find-dd name)))))
1101  (defun method-source-location (method)            #+(or)
1102    (function-source-location (or (pcl::method-fast-function method)            (conditions::condition-class
1103                                  (pcl:method-function method))))             (list (list `(define-condition ,name)
1104                           (condition-class-location class))))
1105  (defun gf-method-locations (gf)            (kernel::standard-class
1106    (let ((ms (pcl::generic-function-methods gf)))             (list (list `(defclass ,name)
1107      (mapcar #'method-source-location ms)))                         (class-location (find-class name)))))
1108              ((or kernel::built-in-class
1109  (defun gf-source-locations (gf)                 conditions::condition-class
1110    (list* (gf-definition-location gf)                 kernel:funcallable-structure-class)
1111           (gf-method-locations gf)))             (list (list `(kernel::define-type-class ,name)
1112                           `(:error
1113  (defun function-source-locations (function)                           ,(format nil "No source info for ~A" name)))))))))
1114    "Return a list of source locations for FUNCTION."  
1115    ;; First test if FUNCTION is a closure created by defstruct; if so  (defun class-location (class)
1116    ;; extract the defstruct-description (dd) from the closure and find    "Return the `defclass' location for CLASS."
1117    ;; the constructor for the struct.  Defstruct creates a defun for    (definition-source-location class (pcl:class-name class)))
1118    ;; the default constructor and we use that as an approximation to  
1119    ;; the source location of the defstruct.  (defun find-dd (name)
1120    ;;    "Find the defstruct-definition by the name of its structure-class."
1121    ;; For an ordinary function we return the source location of the    (let ((layout (ext:info :type :compiler-layout name)))
1122    ;; first code-location we find.      (if layout
1123    (cond ((struct-closure-p function)          (kernel:layout-info layout))))
1124           (list  
1125            (safe-definition-finding  (defun condition-class-location (class)
1126             (dd-source-location (struct-closure-dd function)))))    (let ((slots (conditions::condition-class-slots class))
1127          ((genericp function)          (name (conditions::condition-class-name class)))
1128           (gf-source-locations function))      (cond ((null slots)
1129          (t             `(:error ,(format nil "No location info for condition: ~A" name)))
1130           (list            (t
1131            (multiple-value-bind (code-location error)             ;; Find the class via one of its slot-reader methods.
1132                (safe-definition-finding (function-first-code-location function))             (let* ((slot (first slots))
1133              (cond (error (list :error (princ-to-string error)))                    (gf (fdefinition
1134                    (t (code-location-source-location code-location))))))))                         (first (conditions::condition-slot-readers slot)))))
1135                 (method-location
1136  (defun function-source-location (function)                (first
1137    (destructuring-bind (first) (function-source-locations function)                 (pcl:compute-applicable-methods-using-classes
1138      first))                  gf (list (find-class name))))))))))
1139    
1140  (defslimefun find-function-locations (symbol-name)  (defun make-name-in-file-location (file string)
1141    "Return a list of source-locations for SYMBOL-NAME's functions."    (multiple-value-bind (filename c)
1142    (multiple-value-bind (symbol foundp) (find-symbol-designator symbol-name)        (ignore-errors
1143      (cond ((not foundp)          (unix-truename (merge-pathnames (make-pathname :type "lisp")
1144             (list (list :error (format nil "Unkown symbol: ~A" symbol-name))))                                          file)))
1145            ((macro-function symbol)      (cond (filename (make-location `(:file ,filename)
1146             (function-source-locations (macro-function symbol)))                                     `(:function-name ,(string string))))
1147            ((special-operator-p symbol)            (t (list :error (princ-to-string c))))))
1148             (list (list :error (format nil "~A is a special-operator" symbol))))  
1149            ((fboundp symbol)  (defun source-location-form-numbers (location)
1150             (function-source-locations (coerce symbol 'function)))    (c::decode-form-numbers (c::form-numbers-form-numbers location)))
1151            (t (list (list :error  
1152                           (format nil "Symbol not fbound: ~A" symbol-name))))  (defun source-location-tlf-number (location)
1153            )))    (nth-value 0 (source-location-form-numbers location)))
1154    
1155    (defun source-location-form-number (location)
1156      (nth-value 1 (source-location-form-numbers location)))
1157    
1158    (defun resolve-file-source-location (location)
1159      (let ((filename (c::file-source-location-pathname location))
1160            (tlf-number (source-location-tlf-number location))
1161            (form-number (source-location-form-number location)))
1162        (with-open-file (s filename)
1163          (let ((pos (form-number-stream-position tlf-number form-number s)))
1164            (make-location `(:file ,(unix-truename filename))
1165                           `(:position ,(1+ pos)))))))
1166    
1167    (defun resolve-stream-source-location (location)
1168      (let ((info (c::stream-source-location-user-info location))
1169            (tlf-number (source-location-tlf-number location))
1170            (form-number (source-location-form-number location)))
1171        ;; XXX duplication in frame-source-location
1172        (assert (info-from-emacs-buffer-p info))
1173        (destructuring-bind (&key emacs-buffer emacs-buffer-string
1174                                  emacs-buffer-offset) info
1175          (with-input-from-string (s emacs-buffer-string)
1176            (let ((pos (form-number-stream-position tlf-number form-number s)))
1177              (make-location `(:buffer ,emacs-buffer)
1178                             `(:offset ,emacs-buffer-offset ,pos)))))))
1179    
1180    ;; XXX predicates for 18e backward compatibilty.  Remove them when
1181    ;; we're 19a only.
1182    (defun file-source-location-p (object)
1183      (when (fboundp 'c::file-source-location-p)
1184        (c::file-source-location-p object)))
1185    
1186    (defun stream-source-location-p (object)
1187      (when (fboundp 'c::stream-source-location-p)
1188        (c::stream-source-location-p object)))
1189    
1190    (defun source-location-p (object)
1191      (or (file-source-location-p object)
1192          (stream-source-location-p object)))
1193    
1194    (defun resolve-source-location (location)
1195      (etypecase location
1196        ((satisfies file-source-location-p)
1197         (resolve-file-source-location location))
1198        ((satisfies stream-source-location-p)
1199         (resolve-stream-source-location location))))
1200    
1201    (defun definition-source-location (object name)
1202      (let ((source (pcl::definition-source object)))
1203        (etypecase source
1204          (null
1205           `(:error ,(format nil "No source info for: ~A" object)))
1206          ((satisfies source-location-p)
1207           (resolve-source-location source))
1208          (pathname
1209           (make-name-in-file-location source name))
1210          (cons
1211           (destructuring-bind ((dg name) pathname) source
1212             (declare (ignore dg))
1213             (etypecase pathname
1214               (pathname (make-name-in-file-location pathname (string name)))
1215               (null `(:error ,(format nil "Cannot resolve: ~S" source)))))))))
1216    
1217    (defun setf-definitions (name)
1218      (let ((f (or (ext:info :setf :inverse name)
1219                   (ext:info :setf :expander name)
1220                   (and (symbolp name)
1221                        (fboundp `(setf ,name))
1222                        (fdefinition `(setf ,name))))))
1223        (if f
1224            `(((setf ,name) ,(function-location (cond ((functionp  f) f)
1225                                                      ((macro-function f))
1226                                                      ((fdefinition f)))))))))
1227    
1228    (defun variable-location (symbol)
1229      (multiple-value-bind (location foundp)
1230          ;; XXX for 18e compatibilty. rewrite this when we drop 18e
1231          ;; support.
1232          (ignore-errors (eval `(ext:info :source-location :defvar ',symbol)))
1233        (if (and foundp location)
1234            (resolve-source-location location)
1235            `(:error ,(format nil "No source info for variable ~S" symbol)))))
1236    
1237    (defun variable-definitions (name)
1238      (if (symbolp name)
1239          (multiple-value-bind (kind recorded-p) (ext:info :variable :kind name)
1240            (if recorded-p
1241                (list (list `(variable ,kind ,name)
1242                            (variable-location name)))))))
1243    
1244    (defun compiler-macro-definitions (symbol)
1245      (maybe-make-definition (compiler-macro-function symbol)
1246                             'define-compiler-macro
1247                             symbol))
1248    
1249    (defun source-transform-definitions (name)
1250      (maybe-make-definition (ext:info :function :source-transform name)
1251                             'c:def-source-transform
1252                             name))
1253    
1254    (defun function-info-definitions (name)
1255      (let ((info (ext:info :function :info name)))
1256        (if info
1257            (append (loop for transform in (c::function-info-transforms info)
1258                          collect (list `(c:deftransform ,name
1259                                          ,(c::type-specifier
1260                                            (c::transform-type transform)))
1261                                        (function-location (c::transform-function
1262                                                            transform))))
1263                    (maybe-make-definition (c::function-info-derive-type info)
1264                                           'c::derive-type name)
1265                    (maybe-make-definition (c::function-info-optimizer info)
1266                                           'c::optimizer name)
1267                    (maybe-make-definition (c::function-info-ltn-annotate info)
1268                                           'c::ltn-annotate name)
1269                    (maybe-make-definition (c::function-info-ir2-convert info)
1270                                           'c::ir2-convert name)
1271                    (loop for template in (c::function-info-templates info)
1272                          collect (list `(,(type-of template)
1273                                           ,(c::template-name template))
1274                                        (function-location
1275                                         (c::vop-info-generator-function
1276                                          template))))))))
1277    
1278    (defun ir1-translator-definitions (name)
1279      (maybe-make-definition (ext:info :function :ir1-convert name)
1280                             'c:def-ir1-translator name))
1281    
1282    (defun template-definitions (name)
1283      (let* ((templates (c::backend-template-names c::*backend*))
1284             (template (gethash name templates)))
1285        (etypecase template
1286          (null)
1287          (c::vop-info
1288           (maybe-make-definition (c::vop-info-generator-function template)
1289                                  (type-of template) name)))))
1290    
1291    ;; for cases like: (%primitive NAME ...)
1292    (defun primitive-definitions (name)
1293      (let ((csym (find-symbol (string name) 'c)))
1294        (and csym
1295             (not (eq csym name))
1296             (template-definitions csym))))
1297    
1298    (defun vm-support-routine-definitions (name)
1299      (let ((sr (c::backend-support-routines c::*backend*))
1300            (name (find-symbol (string name) 'c)))
1301        (and name
1302             (slot-exists-p sr name)
1303             (maybe-make-definition (slot-value sr name)
1304                                    (find-symbol (string 'vm-support-routine) 'c)
1305                                    name))))
1306    
1307    
1308  ;;;; Documentation.  ;;;; Documentation.
1309    
1310  (defmethod describe-symbol-for-emacs (symbol)  (defimplementation describe-symbol-for-emacs (symbol)
1311    (let ((result '()))    (let ((result '()))
1312      (flet ((doc (kind)      (flet ((doc (kind)
1313               (or (documentation symbol kind) :not-documented))               (or (documentation symbol kind) :not-documented))
# Line 701  The second return value is the condition Line 1320  The second return value is the condition
1320                     (declare (ignore kind))                     (declare (ignore kind))
1321                     (if (or (boundp symbol) recorded-p)                     (if (or (boundp symbol) recorded-p)
1322                         (doc 'variable))))                         (doc 'variable))))
1323        (maybe-push        (when (fboundp symbol)
1324         :generic-function          (maybe-push
1325         (if (and (fboundp symbol)           (cond ((macro-function symbol)     :macro)
1326                  (typep (fdefinition symbol) 'generic-function))                 ((special-operator-p symbol) :special-operator)
1327             (doc 'function)))                 ((genericp (fdefinition symbol)) :generic-function)
1328        (maybe-push                 (t :function))
1329         :function (if (and (fboundp symbol)           (doc 'function)))
                           (not (typep (fdefinition symbol) 'generic-function)))  
                      (doc 'function)))  
1330        (maybe-push        (maybe-push
1331         :setf (if (or (ext:info setf inverse symbol)         :setf (if (or (ext:info setf inverse symbol)
1332                       (ext:info setf expander symbol))                       (ext:info setf expander symbol))
# Line 734  The second return value is the condition Line 1351  The second return value is the condition
1351                         (doc nil)))                         (doc nil)))
1352        result)))        result)))
1353    
1354  (defslimefun describe-setf-function (symbol-name)  (defimplementation describe-definition (symbol namespace)
1355    (print-description-to-string    (describe (ecase namespace
1356     (or (ext:info setf inverse (from-string symbol-name))                (:variable
1357         (ext:info setf expander (from-string symbol-name)))))                 symbol)
1358                  ((:function :generic-function)
1359  (defslimefun describe-type (symbol-name)                 (symbol-function symbol))
1360    (print-description-to-string                (:setf
1361     (kernel:values-specifier-type (from-string symbol-name))))                 (or (ext:info setf inverse symbol)
1362                       (ext:info setf expander symbol)))
1363  (defslimefun describe-class (symbol-name)                (:type
1364    (print-description-to-string (find-class (from-string symbol-name) nil)))                 (kernel:values-specifier-type symbol))
1365                  (:class
1366  (defslimefun describe-alien-type (symbol-name)                 (find-class symbol))
1367    (let ((name (from-string symbol-name)))                (:alien-struct
1368      (ecase (ext:info :alien-type :kind name)                 (ext:info :alien-type :struct symbol))
1369        (:primitive                (:alien-union
1370         (print-description-to-string                 (ext:info :alien-type :union symbol))
1371          (let ((alien::*values-type-okay* t))                (:alien-enum
1372            (funcall (ext:info :alien-type :translator name) (list name)))))                 (ext:info :alien-type :enum symbol))
1373        ((:defined)                (:alien-type
1374         (print-description-to-string (ext:info :alien-type :definition name)))                 (ecase (ext:info :alien-type :kind symbol)
1375        (:unknown                   (:primitive
1376         (format nil "Unkown alien type: ~A" symbol-name)))))                    (let ((alien::*values-type-okay* t))
1377                        (funcall (ext:info :alien-type :translator symbol)
1378  (defmacro %describe-alien (symbol-name namespace)                               (list symbol))))
1379    `(print-description-to-string                   ((:defined)
1380      (ext:info :alien-type ,namespace (from-string ,symbol-name))))                    (ext:info :alien-type :definition symbol))
1381                     (:unknown :unkown))))))
1382  (defslimefun describe-alien-struct (symbol-name)  
1383    (%describe-alien symbol-name :struct))  ;;;;; Argument lists
1384    
1385  (defslimefun describe-alien-union (symbol-name)  (defimplementation arglist (fun)
1386    (%describe-alien symbol-name :union))    (etypecase fun
1387        (function (function-arglist fun))
1388  (defslimefun describe-alien-enum (symbol-name)      (symbol (function-arglist (or (macro-function fun)
1389    (%describe-alien symbol-name :enum))                                    (symbol-function fun))))))
1390    
1391  (defmethod arglist-string (fname)  (defun function-arglist (fun)
1392    "Return a string describing the argument list for FNAME.    (let ((arglist
1393  The result has the format \"(...)\"."           (cond ((eval:interpreted-function-p fun)
1394    (declare (type string fname))                  (eval:interpreted-function-arglist fun))
1395    (multiple-value-bind (function condition)                 ((pcl::generic-function-p fun)
1396        (ignore-errors (values (find-symbol-designator fname *buffer-package*)))                  (pcl:generic-function-lambda-list fun))
1397      (when condition                 ((c::byte-function-or-closure-p fun)
1398        (return-from arglist-string (format nil "(-- ~A)" condition)))                  (byte-code-function-arglist fun))
1399      (let ((arglist                 ((kernel:%function-arglist (kernel:%function-self fun))
1400             (if (not (or (fboundp function)                  (handler-case (read-arglist fun)
1401                          (functionp function)))                    (error () :not-available)))
1402                 "(-- <Unknown-Function>)"                 ;; this should work both for compiled-debug-function
1403                 (let* ((fun (or (macro-function function)                 ;; and for interpreted-debug-function
1404                                 (symbol-function function)))                 (t
1405                        (df (di::function-debug-function fun))                  (handler-case (debug-function-arglist
1406                        (arglist (kernel:%function-arglist fun)))                                 (di::function-debug-function fun))
1407                   (cond ((eval:interpreted-function-p fun)                    (di:unhandled-condition () :not-available))))))
1408                          (eval:interpreted-function-arglist fun))      (check-type arglist (or list (member :not-available)))
1409                         ((pcl::generic-function-p fun)      arglist))
1410                          (pcl::gf-pretty-arglist fun))  
1411                         (arglist arglist)  (defimplementation function-name (function)
1412                         ;; this should work both for    (cond ((eval:interpreted-function-p function)
1413                         ;; compiled-debug-function and for           (eval:interpreted-function-name function))
1414                         ;; interpreted-debug-function          ((pcl::generic-function-p function)
1415                         (df (di::debug-function-lambda-list df))           (pcl::generic-function-name function))
1416                         (t "(<arglist-unavailable>)"))))))          ((c::byte-function-or-closure-p function)
1417        (if (stringp arglist)           (c::byte-function-name function))
1418            arglist          (t (kernel:%function-name (kernel:%function-self function)))))
1419            (to-string arglist)))))  
1420    ;;; A simple case: the arglist is available as a string that we can
1421    ;;; `read'.
1422    
1423    (defun read-arglist (fn)
1424      "Parse the arglist-string of the function object FN."
1425      (let ((string (kernel:%function-arglist
1426                     (kernel:%function-self fn)))
1427            (package (find-package
1428                      (c::compiled-debug-info-package
1429                       (kernel:%code-debug-info
1430                        (vm::find-code-object fn))))))
1431        (with-standard-io-syntax
1432          (let ((*package* (or package *package*)))
1433            (read-from-string string)))))
1434    
1435    ;;; A harder case: an approximate arglist is derived from available
1436    ;;; debugging information.
1437    
1438    (defun debug-function-arglist (debug-function)
1439      "Derive the argument list of DEBUG-FUNCTION from debug info."
1440      (let ((args (di::debug-function-lambda-list debug-function))
1441            (required '())
1442            (optional '())
1443            (rest '())
1444            (key '()))
1445        ;; collect the names of debug-vars
1446        (dolist (arg args)
1447          (etypecase arg
1448            (di::debug-variable
1449             (push (di::debug-variable-symbol arg) required))
1450            ((member :deleted)
1451             (push ':deleted required))
1452            (cons
1453             (ecase (car arg)
1454               (:keyword
1455                (push (second arg) key))
1456               (:optional
1457                (push (debug-variable-symbol-or-deleted (second arg)) optional))
1458               (:rest
1459                (push (debug-variable-symbol-or-deleted (second arg)) rest))))))
1460        ;; intersperse lambda keywords as needed
1461        (append (nreverse required)
1462                (if optional (cons '&optional (nreverse optional)))
1463                (if rest (cons '&rest (nreverse rest)))
1464                (if key (cons '&key (nreverse key))))))
1465    
1466    (defun debug-variable-symbol-or-deleted (var)
1467      (etypecase var
1468        (di:debug-variable
1469         (di::debug-variable-symbol var))
1470        ((member :deleted)
1471         '#:deleted)))
1472    
1473    (defun symbol-debug-function-arglist (fname)
1474      "Return FNAME's debug-function-arglist and %function-arglist.
1475    A utility for debugging DEBUG-FUNCTION-ARGLIST."
1476      (let ((fn (fdefinition fname)))
1477        (values (debug-function-arglist (di::function-debug-function fn))
1478                (kernel:%function-arglist (kernel:%function-self fn)))))
1479    
1480    ;;; Deriving arglists for byte-compiled functions:
1481    ;;;
1482    (defun byte-code-function-arglist (fn)
1483      ;; There doesn't seem to be much arglist information around for
1484      ;; byte-code functions.  Use the arg-count and return something like
1485      ;; (arg0 arg1 ...)
1486      (etypecase fn
1487        (c::simple-byte-function
1488         (loop for i from 0 below (c::simple-byte-function-num-args fn)
1489               collect (make-arg-symbol i)))
1490        (c::hairy-byte-function
1491         (hairy-byte-function-arglist fn))
1492        (c::byte-closure
1493         (byte-code-function-arglist (c::byte-closure-function fn)))))
1494    
1495    (defun make-arg-symbol (i)
1496      (make-symbol (format nil "~A~D" (string 'arg) i)))
1497    
1498    ;;; A "hairy" byte-function is one that takes a variable number of
1499    ;;; arguments. `hairy-byte-function' is a type from the bytecode
1500    ;;; interpreter.
1501    ;;;
1502    (defun hairy-byte-function-arglist (fn)
1503      (let ((counter -1))
1504        (flet ((next-arg () (make-arg-symbol (incf counter))))
1505          (with-struct (c::hairy-byte-function- min-args max-args rest-arg-p
1506                                                keywords-p keywords) fn
1507            (let ((arglist '())
1508                  (optional (- max-args min-args)))
1509              ;; XXX isn't there a better way to write this?
1510              ;; (Looks fine to me. -luke)
1511              (dotimes (i min-args)
1512                (push (next-arg) arglist))
1513              (when (plusp optional)
1514                (push '&optional arglist)
1515                (dotimes (i optional)
1516                  (push (next-arg) arglist)))
1517              (when rest-arg-p
1518                (push '&rest arglist)
1519                (push (next-arg) arglist))
1520              (when keywords-p
1521                (push '&key arglist)
1522                (loop for (key _ __) in keywords
1523                      do (push key arglist))
1524                (when (eq keywords-p :allow-others)
1525                  (push '&allow-other-keys arglist)))
1526              (nreverse arglist))))))
1527    
1528    
1529  ;;;; Miscellaneous.  ;;;; Miscellaneous.
1530    
1531  (defmethod macroexpand-all (form)  (defimplementation macroexpand-all (form)
1532    (walker:macroexpand-all form))    (walker:macroexpand-all form))
1533    
1534  (defun tracedp (fname)  (defimplementation compiler-macroexpand-1 (form &optional env)
1535    (gethash (debug::trace-fdefinition fname)    (ext:compiler-macroexpand-1 form env))
1536             debug::*traced-functions*))  
1537    (defimplementation compiler-macroexpand (form &optional env)
1538  (defslimefun toggle-trace-fdefinition (fname-string)    (ext:compiler-macroexpand form env))
   (let ((fname (from-string fname-string)))  
     (cond ((tracedp fname)  
            (debug::untrace-1 fname)  
            (format nil "~S is now untraced." fname))  
           (t  
            (debug::trace-1 fname (debug::make-trace-info))  
            (format nil "~S is now traced." fname)))))  
1539    
1540  (defslimefun set-default-directory (directory)  (defimplementation set-default-directory (directory)
1541    (setf (ext:default-directory) (namestring directory))    (setf (ext:default-directory) (namestring directory))
1542    ;; Setting *default-pathname-defaults* to an absolute directory    ;; Setting *default-pathname-defaults* to an absolute directory
1543    ;; makes the behavior of MERGE-PATHNAMES a bit more intuitive.    ;; makes the behavior of MERGE-PATHNAMES a bit more intuitive.
1544    (setf *default-pathname-defaults* (pathname (ext:default-directory)))    (setf *default-pathname-defaults* (pathname (ext:default-directory)))
1545    (namestring (ext:default-directory)))    (default-directory))
   
   
 ;;;; Source-paths  
   
 ;;; CMUCL uses a data structure called "source-path" to locate  
 ;;; subforms.  The compiler assigns a source-path to each form in a  
 ;;; compilation unit.  Compiler notes usually contain the source-path  
 ;;; of the error location.  
 ;;;  
 ;;; Compiled code objects don't contain source paths, only the  
 ;;; "toplevel-form-number" and the (sub-) "form-number".  To get from  
 ;;; the form-number to the source-path we need the entire toplevel-form  
 ;;; (i.e. we have to read the source code).  CMUCL has already some  
 ;;; utilities to do this translation, but we use some extended  
 ;;; versions, because we need more exact position info.  Apparently  
 ;;; Hemlock is happy with the position of the toplevel-form; we also  
 ;;; need the position of subforms.  
 ;;;  
 ;;; We use a special readtable to get the positions of the subforms.  
 ;;; The readtable stores the start and end position for each subform in  
 ;;; hashtable for later retrieval.  
   
 (defun make-source-recorder (fn source-map)  
   "Return a macro character function that does the same as FN, but  
 additionally stores the result together with the stream positions  
 before and after of calling FN in the hashtable SOURCE-MAP."  
   (lambda (stream char)  
     (let ((start (file-position stream))  
           (values (multiple-value-list (funcall fn stream char)))  
           (end (file-position stream)))  
       #+(or) (format t "~&[~D ~{~A~^, ~} ~D]~%" start values end)  
       (unless (null values)  
         (push (cons start end) (gethash (car values) source-map)))  
       (values-list values))))  
   
 (defun make-source-recording-readtable (readtable source-map)  
   "Return a source position recording copy of READTABLE.  
 The source locations are stored in SOURCE-MAP."  
   (let* ((tab (copy-readtable readtable))  
          (*readtable* tab))  
     (dotimes (code char-code-limit)  
       (let ((char (code-char code)))  
         (multiple-value-bind (fn term) (get-macro-character char tab)  
           (when fn  
             (set-macro-character char (make-source-recorder fn source-map)  
                                  term tab)))))  
     tab))  
   
 (defun make-source-map ()  
   (make-hash-table :test #'eq))  
   
 (defvar *source-map* (make-source-map)  
   "The hashtable table used for source position recording.")  
   
 (defvar *recording-readtable-cache* '()  
   "An alist of (READTABLE . RECORDING-READTABLE) pairs.")  
   
 (defun lookup-recording-readtable (readtable)  
   "Find a cached or create a new recording readtable for READTABLE."  
   (or (cdr (assoc readtable *recording-readtable-cache*))  
       (let ((table (make-source-recording-readtable readtable *source-map*)))  
         (push (cons readtable table) *recording-readtable-cache*)  
         table)))  
   
 (defun read-and-record-source-map (stream)  
   "Read the next object from STREAM.  
 Return the object together with a hashtable that maps  
 subexpressions of the object to stream positions."  
   (let ((*readtable* (lookup-recording-readtable *readtable*)))  
     (clrhash *source-map*)  
     (values (read stream) *source-map*)))  
   
 (defun source-path-stream-position (path stream)  
   "Search the source-path PATH in STREAM and return its position."  
   (destructuring-bind (tlf-number . path) path  
     (let ((*read-suppress* t))  
       (dotimes (i tlf-number) (read stream))  
       (multiple-value-bind (form source-map)  
           (read-and-record-source-map stream)  
         (source-path-source-position (cons 0 path) form source-map)))))  
   
 (defun source-path-string-position (path string)  
   (with-input-from-string (s string)  
     (source-path-stream-position path s)))  
1546    
1547  (defun source-path-file-position (path filename)  (defimplementation default-directory ()
1548    (with-open-file (file filename)    (namestring (ext:default-directory)))
     (source-path-stream-position path file)))  
   
 (defun source-path-source-position (path form source-map)  
   "Return the start position of PATH form FORM and SOURCE-MAP.  All  
 subforms along the path are considered and the start and end position  
 of deepest (i.e. smallest) possible form is returned."  
   ;; compute all subforms along path  
   (let ((forms (loop for n in path  
                      for f = form then (nth n f)  
                      collect f)))  
     ;; select the first subform present in source-map  
     (loop for form in (reverse forms)  
           for positions = (gethash form source-map)  
           until (and positions (null (cdr positions)))  
           finally (destructuring-bind ((start . end)) positions  
                     (return (values (1- start) end))))))  
   
 (defun code-location-stream-position (code-location stream)  
   "Return the byte offset of CODE-LOCATION in STREAM.  Extract the  
 toplevel-form-number and form-number from CODE-LOCATION and use that  
 to find the position of the corresponding form."  
   (let* ((location (debug::maybe-block-start-location code-location))  
          (tlf-offset (di:code-location-top-level-form-offset location))  
          (form-number (di:code-location-form-number location))  
          (*read-suppress* t))  
     (dotimes (i tlf-offset) (read stream))  
     (multiple-value-bind (tlf position-map) (read-and-record-source-map stream)  
       (let* ((path-table (di:form-number-translations tlf 0))  
              (source-path  
               (if (<= (length path-table) form-number) ; source out of sync?  
                   (list 0)              ; should probably signal a condition  
                   (reverse (cdr (aref path-table form-number))))))  
         (source-path-source-position source-path tlf position-map)))))  
   
 (defun code-location-string-offset (code-location string)  
   (with-input-from-string (s string)  
     (code-location-stream-position code-location s)))  
1549    
1550  (defun code-location-file-position (code-location filename)  (defimplementation getpid ()
1551    (with-open-file (s filename :direction :input)    (unix:unix-getpid))
     (code-location-stream-position code-location s)))  
1552    
1553  (defun debug-source-info-from-emacs-buffer-p (debug-source)  (defimplementation lisp-implementation-type-name ()
1554    (let ((info (c::debug-source-info debug-source)))    "cmucl")
     (and info  
          (consp info)  
          (eq :emacs-buffer (car info)))))  
1555    
1556  (defun source-location-from-code-location (code-location)  (defimplementation quit-lisp ()
1557    "Return the source location for CODE-LOCATION."    (ext::quit))
   (let ((debug-fun (di:code-location-debug-function code-location)))  
     (when (di::bogus-debug-function-p debug-fun)  
       (error "Bogus debug function: ~A" debug-fun)))  
   (let* ((debug-source (di:code-location-debug-source code-location))  
          (from (di:debug-source-from debug-source))  
          (name (di:debug-source-name debug-source)))  
     (ecase from  
       (:file  
        (make-location (list :file (unix-truename name))  
                       (list :position (1+ (code-location-file-position  
                                            code-location name)))))  
       (:stream  
        (assert (debug-source-info-from-emacs-buffer-p debug-source))  
        (let ((info (c::debug-source-info debug-source)))  
          (make-location  
           (list :buffer (getf info :emacs-buffer))  
           (list :position (+ (getf info :emacs-buffer-offset)  
                              (code-location-string-offset  
                               code-location  
                               (getf info :emacs-buffer-string)))))))  
       (:lisp  
        (make-location  
         (list :source-form (with-output-to-string (*standard-output*)  
                              (debug::print-code-location-source-form  
                               code-location 100 t)))  
         (list :position 1))))))  
   
 (defun code-location-source-location (code-location)  
   "Safe wrapper around `code-location-from-source-location'."  
   (safe-definition-finding  
    (source-location-from-code-location code-location)))  
1558    
1559  (defslimefun getpid ()  ;;; source-path-{stream,file,string,etc}-position moved into
1560    (unix:unix-getpid))  ;;; swank-source-path-parser
1561    
1562    
1563  ;;;; Debugging  ;;;; Debugging
1564    
1565  (defvar *sldb-stack-top*)  (defvar *sldb-stack-top*)
 (defvar *sldb-restarts*)  
1566    
1567  (defmethod call-with-debugging-environment (debugger-loop-fn)  (defimplementation call-with-debugging-environment (debugger-loop-fn)
1568    (unix:unix-sigsetmask 0)    (unix:unix-sigsetmask 0)
1569    (let* ((*sldb-stack-top* (or debug:*stack-top-hint* (di:top-frame)))    (let* ((*sldb-stack-top* (or debug:*stack-top-hint* (di:top-frame)))
          (*sldb-restarts* (compute-restarts *swank-debugger-condition*))  
1570           (debug:*stack-top-hint* nil)           (debug:*stack-top-hint* nil)
1571           (*debugger-hook* nil)           (kernel:*current-level* 0))
1572           (*readtable* (or debug:*debug-readtable* *readtable*))      (handler-bind ((di::unhandled-condition
          (*print-level* debug:*debug-print-level*)  
          (*print-length* debug:*debug-print-length*)  
          (*print-readably* nil))  
     (handler-bind ((di:debug-condition  
1573                      (lambda (condition)                      (lambda (condition)
1574                        (signal (make-condition                        (error (make-condition
1575                                 'sldb-condition                                'sldb-condition
1576                                 :original-condition condition)))))                                :original-condition condition)))))
1577        (funcall debugger-loop-fn))))        (unwind-protect
1578               (progn
1579  (defun format-restarts-for-emacs ()               #+(or)(sys:scrub-control-stack)
1580    "Return a list of restarts for *swank-debugger-condition* in a               (funcall debugger-loop-fn))
1581  format suitable for Emacs."          #+(or)(sys:scrub-control-stack)
1582    (loop for restart in *sldb-restarts*          ))))
1583          collect (list (princ-to-string (restart-name restart))  
1584                        (princ-to-string restart))))  (defun frame-down (frame)
1585      (handler-case (di:frame-down frame)
1586  (defun format-condition-for-emacs ()      (di:no-debug-info () nil)))
   (format nil "~A~%   [Condition of type ~S]"  
           (debug::safe-condition-message *swank-debugger-condition*)  
           (type-of *swank-debugger-condition*)))  
1587    
1588  (defun nth-frame (index)  (defun nth-frame (index)
1589    (do ((frame *sldb-stack-top* (di:frame-down frame))    (do ((frame *sldb-stack-top* (frame-down frame))
1590         (i index (1- i)))         (i index (1- i)))
1591        ((zerop i) frame)))        ((zerop i) frame)))
1592    
1593  (defun nth-restart (index)  (defimplementation compute-backtrace (start end)
   (nth index *sldb-restarts*))  
   
 (defun format-frame-for-emacs (frame)  
   (list (di:frame-number frame)  
         (with-output-to-string (*standard-output*)  
           (let ((*print-pretty* *sldb-pprint-frames*))  
             (debug::print-frame-call frame :verbosity 1 :number t)))))  
   
 (defun compute-backtrace (start end)  
   "Return a list of frames starting with frame number START and  
 continuing to frame number END or, if END is nil, the last frame on the  
 stack."  
1594    (let ((end (or end most-positive-fixnum)))    (let ((end (or end most-positive-fixnum)))
1595      (loop for f = (nth-frame start) then (di:frame-down f)      (loop for f = (nth-frame start) then (frame-down f)
1596            for i from start below end            for i from start below end
1597            while f            while f collect f)))
           collect f)))  
1598    
1599  (defmethod backtrace (start end)  (defimplementation print-frame (frame stream)
1600    (mapcar #'format-frame-for-emacs (compute-backtrace start end)))    (let ((*standard-output* stream))
1601        (handler-case
1602            (debug::print-frame-call frame :verbosity 1 :number nil)
1603          (error (e)
1604            (ignore-errors (princ e stream))))))
1605    
1606    (defimplementation frame-source-location (index)
1607      (let ((frame (nth-frame index)))
1608        (cond ((foreign-frame-p frame) (foreign-frame-source-location frame))
1609              ((code-location-source-location (di:frame-code-location frame))))))
1610    
1611  (defmethod debugger-info-for-emacs (start end)  (defimplementation eval-in-frame (form index)
1612    (list (format-condition-for-emacs)    (di:eval-in-frame (nth-frame index) form))
         (format-restarts-for-emacs)  
         (backtrace start end)))  
1613    
1614  (defmethod frame-source-location-for-emacs (index)  (defun frame-debug-vars (frame)
1615    (code-location-source-location (di:frame-code-location (nth-frame index))))    "Return a vector of debug-variables in frame."
1616      (let ((loc (di:frame-code-location frame)))
1617        (remove-if
1618         (lambda (v)
1619           (not (eq (di:debug-variable-validity v loc) :valid)))
1620         (di::debug-function-debug-variables (di:frame-debug-function frame)))))
1621    
1622    (defun debug-var-value (var frame)
1623      (let* ((loc (di:frame-code-location frame))
1624             (validity (di:debug-variable-validity var loc)))
1625        (ecase validity
1626          (:valid (di:debug-variable-value var frame))
1627          ((:invalid :unknown) (make-symbol (string validity))))))
1628    
1629    (defimplementation frame-locals (index)
1630      (let ((frame (nth-frame index)))
1631        (loop for v across (frame-debug-vars frame)
1632              collect (list :name (di:debug-variable-symbol v)
1633                            :id (di:debug-variable-id v)
1634                            :value (debug-var-value v frame)))))
1635    
1636    (defimplementation frame-var-value (frame var)
1637      (let* ((frame (nth-frame frame))
1638             (dvar (aref (frame-debug-vars frame) var)))
1639        (debug-var-value dvar frame)))
1640    
1641    (defimplementation frame-catch-tags (index)
1642      (mapcar #'car (di:frame-catches (nth-frame index))))
1643    
1644    (defimplementation return-from-frame (index form)
1645      (let ((sym (find-symbol (string 'find-debug-tag-for-frame)
1646                              :debug-internals)))
1647        (if sym
1648            (let* ((frame (nth-frame index))
1649                   (probe (funcall sym frame)))
1650              (cond (probe (throw (car probe) (eval-in-frame form index)))
1651                    (t (format nil "Cannot return from frame: ~S" frame))))
1652            "return-from-frame is not implemented in this version of CMUCL.")))
1653    
1654  (defmethod eval-in-frame (form index)  (defimplementation activate-stepping (frame)
1655    (di:eval-in-frame (nth-frame index) form))    (set-step-breakpoints (nth-frame frame)))
1656    
1657  (defslimefun pprint-eval-string-in-frame (string index)  (defimplementation sldb-break-on-return (frame)
1658    (swank-pprint    (break-on-return (nth-frame frame)))
1659     (multiple-value-list  
1660      (di:eval-in-frame (nth-frame index) (from-string string)))))  ;;; We set the breakpoint in the caller which might be a bit confusing.
1661    ;;;
1662  (defslimefun inspect-in-frame (string index)  (defun break-on-return (frame)
1663    (reset-inspector)    (let* ((caller (di:frame-down frame))
1664    (inspect-object (di:eval-in-frame (nth-frame index) (from-string string))))           (cl (di:frame-code-location caller)))
1665        (flet ((hook (frame bp)
1666  (defmethod frame-locals (index)               (when (frame-pointer= frame caller)
1667    (let* ((frame (nth-frame index))                 (di:delete-breakpoint bp)
1668           (location (di:frame-code-location frame))                 (signal-breakpoint bp frame))))
1669           (debug-function (di:frame-debug-function frame))        (let* ((info (ecase (di:code-location-kind cl)
1670           (debug-variables (di::debug-function-debug-variables debug-function)))                       ((:single-value-return :unknown-return) nil)
1671      (loop for v across debug-variables                       (:known-return (debug-function-returns
1672            collect (list                                       (di:frame-debug-function frame)))))
1673                     :symbol (di:debug-variable-symbol v)               (bp (di:make-breakpoint #'hook cl :kind :code-location
1674                     :id (di:debug-variable-id v)                                       :info info)))
1675                     :value-string          (di:activate-breakpoint bp)
1676                     (if (eq (di:debug-variable-validity v location)          `(:ok ,(format nil "Set breakpoint in ~A" caller))))))
1677                             :valid)  
1678                         (to-string (di:debug-variable-value v frame))  (defun frame-pointer= (frame1 frame2)
1679                         "<not-available>")))))    "Return true if the frame pointers of FRAME1 and FRAME2 are the same."
1680      (sys:sap= (di::frame-pointer frame1) (di::frame-pointer frame2)))
1681  (defmethod frame-catch-tags (index)  
1682    (loop for (tag . code-location) in (di:frame-catches (nth-frame index))  ;;; The PC in escaped frames at a single-return-value point is
1683          collect `(,tag . ,(code-location-source-location code-location))))  ;;; actually vm:single-value-return-byte-offset bytes after the
1684    ;;; position given in the debug info.  Here we try to recognize such
1685    ;;; cases.
1686    ;;;
1687    (defun next-code-locations (frame code-location)
1688      "Like `debug::next-code-locations' but be careful in escaped frames."
1689      (let ((next (debug::next-code-locations code-location)))
1690        (flet ((adjust-pc ()
1691                 (let ((cl (di::copy-compiled-code-location code-location)))
1692                   (incf (di::compiled-code-location-pc cl)
1693                         vm:single-value-return-byte-offset)
1694                   cl)))
1695          (cond ((and (di::compiled-frame-escaped frame)
1696                      (eq (di:code-location-kind code-location)
1697                          :single-value-return)
1698                      (= (length next) 1)
1699                      (di:code-location= (car next) (adjust-pc)))
1700                 (debug::next-code-locations (car next)))
1701                (t
1702                 next)))))
1703    
1704    (defun set-step-breakpoints (frame)
1705      (let ((cl (di:frame-code-location frame)))
1706        (when (di:debug-block-elsewhere-p (di:code-location-debug-block cl))
1707          (error "Cannot step in elsewhere code"))
1708        (let* ((debug::*bad-code-location-types*
1709                (remove :call-site debug::*bad-code-location-types*))
1710               (next (next-code-locations frame cl)))
1711          (cond (next
1712                 (let ((steppoints '()))
1713                   (flet ((hook (bp-frame bp)
1714                            (signal-breakpoint bp bp-frame)
1715                            (mapc #'di:delete-breakpoint steppoints)))
1716                     (dolist (code-location next)
1717                       (let ((bp (di:make-breakpoint #'hook code-location
1718                                                     :kind :code-location)))
1719                         (di:activate-breakpoint bp)
1720                         (push bp steppoints))))))
1721                (t
1722                 (break-on-return frame))))))
1723    
1724    
1725    ;; XXX the return values at return breakpoints should be passed to the
1726    ;; user hooks. debug-int.lisp should be changed to do this cleanly.
1727    
1728    ;;; The sigcontext and the PC for a breakpoint invocation are not
1729    ;;; passed to user hook functions, but we need them to extract return
1730    ;;; values. So we advice di::handle-breakpoint and bind the values to
1731    ;;; special variables.
1732    ;;;
1733    (defvar *breakpoint-sigcontext*)
1734    (defvar *breakpoint-pc*)
1735    
1736    ;; XXX don't break old versions without fwrappers.  Remove this one day.
1737    #+#.(cl:if (cl:find-package :fwrappers) '(and) '(or))
1738    (progn
1739      (fwrappers:define-fwrapper bind-breakpoint-sigcontext (offset c sigcontext)
1740        (let ((*breakpoint-sigcontext* sigcontext)
1741              (*breakpoint-pc* offset))
1742          (fwrappers:call-next-function)))
1743      (fwrappers:set-fwrappers 'di::handle-breakpoint '())
1744      (fwrappers:fwrap 'di::handle-breakpoint #'bind-breakpoint-sigcontext))
1745    
1746    (defun sigcontext-object (sc index)
1747      "Extract the lisp object in sigcontext SC at offset INDEX."
1748      (kernel:make-lisp-obj (vm:sigcontext-register sc index)))
1749    
1750    (defun known-return-point-values (sigcontext sc-offsets)
1751      (let ((fp (system:int-sap (vm:sigcontext-register sigcontext
1752                                                        vm::cfp-offset))))
1753        (system:without-gcing
1754         (loop for sc-offset across sc-offsets
1755               collect (di::sub-access-debug-var-slot fp sc-offset sigcontext)))))
1756    
1757    ;;; CMUCL returns the first few values in registers and the rest on
1758    ;;; the stack. In the multiple value case, the number of values is
1759    ;;; stored in a dedicated register. The values of the registers can be
1760    ;;; accessed in the sigcontext for the breakpoint.  There are 3 kinds
1761    ;;; of return conventions: :single-value-return, :unknown-return, and
1762    ;;; :known-return.
1763    ;;;
1764    ;;; The :single-value-return convention returns the value in a
1765    ;;; register without setting the nargs registers.
1766    ;;;
1767    ;;; The :unknown-return variant is used for multiple values. A
1768    ;;; :unknown-return point consists actually of 2 breakpoints: one for
1769    ;;; the single value case and one for the general case.  The single
1770    ;;; value breakpoint comes vm:single-value-return-byte-offset after
1771    ;;; the multiple value breakpoint.
1772    ;;;
1773    ;;; The :known-return convention is used by local functions.
1774    ;;; :known-return is currently not supported because we don't know
1775    ;;; where the values are passed.
1776    ;;;
1777    (defun breakpoint-values (breakpoint)
1778      "Return the list of return values for a return point."
1779      (flet ((1st (sc) (sigcontext-object sc (car vm::register-arg-offsets))))
1780        (let ((sc (locally (declare (optimize (speed 0)))
1781                    (alien:sap-alien *breakpoint-sigcontext* (* unix:sigcontext))))
1782              (cl (di:breakpoint-what breakpoint)))
1783          (ecase (di:code-location-kind cl)
1784            (:single-value-return
1785             (list (1st sc)))
1786            (:known-return
1787             (let ((info (di:breakpoint-info breakpoint)))
1788               (if (vectorp info)
1789                   (known-return-point-values sc info)
1790                   (progn
1791                     ;;(break)
1792                     (list "<<known-return convention not supported>>" info)))))
1793            (:unknown-return
1794             (let ((mv-return-pc (di::compiled-code-location-pc cl)))
1795               (if (= mv-return-pc *breakpoint-pc*)
1796                   (mv-function-end-breakpoint-values sc)
1797                   (list (1st sc)))))))))
1798    
1799    ;; XXX: di::get-function-end-breakpoint-values takes 2 arguments in
1800    ;; newer versions of CMUCL (after ~March 2005).
1801    (defun mv-function-end-breakpoint-values (sigcontext)
1802      (let ((sym (find-symbol "FUNCTION-END-BREAKPOINT-VALUES/STANDARD" :di)))
1803        (cond (sym (funcall sym sigcontext))
1804              (t (funcall 'di::get-function-end-breakpoint-values sigcontext)))))
1805    
1806    (defun debug-function-returns (debug-fun)
1807      "Return the return style of DEBUG-FUN."
1808      (let* ((cdfun (di::compiled-debug-function-compiler-debug-fun debug-fun)))
1809        (c::compiled-debug-function-returns cdfun)))
1810    
1811    (define-condition breakpoint (simple-condition)
1812      ((message :initarg :message :reader breakpoint.message)
1813       (values  :initarg :values  :reader breakpoint.values))
1814      (:report (lambda (c stream) (princ (breakpoint.message c) stream))))
1815    
1816    (defimplementation condition-extras (condition)
1817      (typecase condition
1818        (breakpoint
1819         ;; pop up the source buffer
1820         `((:show-frame-source 0)))
1821        (t '())))
1822    
1823    (defun signal-breakpoint (breakpoint frame)
1824      "Signal a breakpoint condition for BREAKPOINT in FRAME.
1825    Try to create a informative message."
1826      (flet ((brk (values fstring &rest args)
1827               (let ((msg (apply #'format nil fstring args))
1828                     (debug:*stack-top-hint* frame))
1829                 (break 'breakpoint :message msg :values values))))
1830        (with-struct (di::breakpoint- kind what) breakpoint
1831          (case kind
1832            (:code-location
1833             (case (di:code-location-kind what)
1834               ((:single-value-return :known-return :unknown-return)
1835                (let ((values (breakpoint-values breakpoint)))
1836                  (brk values "Return value: ~{~S ~}" values)))
1837               (t
1838                #+(or)
1839                (when (eq (di:code-location-kind what) :call-site)
1840                  (call-site-function breakpoint frame))
1841                (brk nil "Breakpoint: ~S ~S"
1842                     (di:code-location-kind what)
1843                     (di::compiled-code-location-pc what)))))
1844            (:function-start
1845             (brk nil "Function start breakpoint"))
1846            (t (brk nil "Breakpoint: ~A in ~A" breakpoint frame))))))
1847    
1848    (defimplementation sldb-break-at-start (fname)
1849      (let ((debug-fun (di:function-debug-function (coerce fname 'function))))
1850        (cond ((not debug-fun)
1851               `(:error ,(format nil "~S has no debug-function" fname)))
1852              (t
1853               (flet ((hook (frame bp &optional args cookie)
1854                        (declare (ignore args cookie))
1855                        (signal-breakpoint bp frame)))
1856                 (let ((bp (di:make-breakpoint #'hook debug-fun
1857                                               :kind :function-start)))
1858                   (di:activate-breakpoint bp)
1859                   `(:ok ,(format nil "Set breakpoint in ~S" fname))))))))
1860    
1861    (defun frame-cfp (frame)
1862      "Return the Control-Stack-Frame-Pointer for FRAME."
1863      (etypecase frame
1864        (di::compiled-frame (di::frame-pointer frame))
1865        ((or di::interpreted-frame null) -1)))
1866    
1867    (defun frame-ip (frame)
1868      "Return the (absolute) instruction pointer and the relative pc of FRAME."
1869      (if (not frame)
1870          -1
1871          (let ((debug-fun (di::frame-debug-function frame)))
1872            (etypecase debug-fun
1873              (di::compiled-debug-function
1874               (let* ((code-loc (di:frame-code-location frame))
1875                      (component (di::compiled-debug-function-component debug-fun))
1876                      (pc (di::compiled-code-location-pc code-loc))
1877                      (ip (sys:without-gcing
1878                           (sys:sap-int
1879                            (sys:sap+ (kernel:code-instructions component) pc)))))
1880                 (values ip pc)))
1881              (di::interpreted-debug-function -1)
1882              (di::bogus-debug-function
1883               #-x86
1884               (let* ((real (di::frame-real-frame (di::frame-up frame)))
1885                      (fp (di::frame-pointer real)))
1886                 ;;#+(or)
1887                 (progn
1888                   (format *debug-io* "Frame-real-frame = ~S~%" real)
1889                   (format *debug-io* "fp = ~S~%" fp)
1890                   (format *debug-io* "lra = ~S~%"
1891                           (kernel:stack-ref fp vm::lra-save-offset)))
1892                 (values
1893                  (sys:int-sap
1894                   (- (kernel:get-lisp-obj-address
1895                       (kernel:stack-ref fp vm::lra-save-offset))
1896                      (- (ash vm:function-code-offset vm:word-shift)
1897                         vm:function-pointer-type)))
1898                  0))
1899               #+x86
1900               (let ((fp (di::frame-pointer (di:frame-up frame))))
1901                 (multiple-value-bind (ra ofp) (di::x86-call-context fp)
1902                   (declare (ignore ofp))
1903                   (values ra 0))))))))
1904    
1905    (defun frame-registers (frame)
1906      "Return the lisp registers CSP, CFP, IP, OCFP, LRA for FRAME-NUMBER."
1907      (let* ((cfp (frame-cfp frame))
1908             (csp (frame-cfp (di::frame-up frame)))
1909             (ip (frame-ip frame))
1910             (ocfp (frame-cfp (di::frame-down frame)))
1911             (lra (frame-ip (di::frame-down frame))))
1912        (values csp cfp ip ocfp lra)))
1913    
1914    (defun print-frame-registers (frame-number)
1915      (let ((frame (di::frame-real-frame (nth-frame frame-number))))
1916        (flet ((fixnum (p) (etypecase p
1917                             (integer p)
1918                             (sys:system-area-pointer (sys:sap-int p)))))
1919          (apply #'format t "~
1920    ~8X  Stack Pointer
1921    ~8X  Frame Pointer
1922    ~8X  Instruction Pointer
1923    ~8X  Saved Frame Pointer
1924    ~8X  Saved Instruction Pointer~%" (mapcar #'fixnum
1925                          (multiple-value-list (frame-registers frame)))))))
1926    
1927    (defvar *gdb-program-name*
1928      (ext:enumerate-search-list (p "path:gdb")
1929        (when (probe-file p)
1930          (return p))))
1931    
1932    (defimplementation disassemble-frame (frame-number)
1933      (print-frame-registers frame-number)
1934      (terpri)
1935      (let* ((frame (di::frame-real-frame (nth-frame frame-number)))
1936             (debug-fun (di::frame-debug-function frame)))
1937        (etypecase debug-fun
1938          (di::compiled-debug-function
1939           (let* ((component (di::compiled-debug-function-component debug-fun))
1940                  (fun (di:debug-function-function debug-fun)))
1941             (if fun
1942                 (disassemble fun)
1943                 (disassem:disassemble-code-component component))))
1944          (di::bogus-debug-function
1945           (cond ((probe-file *gdb-program-name*)
1946                  (let ((ip (sys:sap-int (frame-ip frame))))
1947                    (princ (gdb-command "disas 0x~x" ip))))
1948                 (t
1949                  (format t "~%[Disassembling bogus frames not implemented]")))))))
1950    
1951  (defslimefun invoke-nth-restart (index)  (defmacro with-temporary-file ((stream filename) &body body)
1952    (invoke-restart-interactively (nth-restart index)))    `(call/temporary-file (lambda (,stream ,filename) . ,body)))
1953    
1954    (defun call/temporary-file (fun)
1955      (let ((name (system::pick-temporary-file-name)))
1956        (unwind-protect
1957             (with-open-file (stream name :direction :output :if-exists :supersede)
1958               (funcall fun stream name))
1959          (delete-file name))))
1960    
1961    (defun gdb-command (format-string &rest args)
1962      (let ((str (gdb-exec (format nil
1963                                   "interpreter-exec mi2 \"attach ~d\"~%~
1964                                    interpreter-exec console ~s~%detach"
1965                                   (getpid)
1966                                   (apply #'format nil format-string args))))
1967            (prompt (format nil
1968                            #-(and darwin x86) "~%^done~%(gdb) ~%"
1969                            #+(and darwin x86)
1970    "~%^done,thread-id=\"1\"~%(gdb) ~%")))
1971        (subseq str (+ (or (search prompt str) 0) (length prompt)))))
1972    
1973    (defun gdb-exec (cmd)
1974      (with-temporary-file (file filename)
1975        (write-string cmd file)
1976        (force-output file)
1977        (let* ((output (make-string-output-stream))
1978               ;; gdb on sparc needs to know the executable to find the
1979               ;; symbols.  Without this, gdb can't disassemble anything.
1980               ;; NOTE: We assume that the first entry in
1981               ;; lisp::*cmucl-lib* is the bin directory where lisp is
1982               ;; located.  If this is not true, we'll have to do
1983               ;; something better to find the lisp executable.
1984               (lisp-path
1985                #+sparc
1986                 (list
1987                  (namestring
1988                   (probe-file
1989                    (merge-pathnames "lisp" (car (lisp::parse-unix-search-path
1990                                                  lisp::*cmucl-lib*))))))
1991                 #-sparc
1992                 nil)
1993               (proc (ext:run-program *gdb-program-name*
1994                                      `(,@lisp-path "-batch" "-x" ,filename)
1995                                      :wait t
1996                                      :output output)))
1997          (assert (eq (ext:process-status proc) :exited))
1998          (assert (eq (ext:process-exit-code proc) 0))
1999          (get-output-stream-string output))))
2000    
2001    (defun foreign-frame-p (frame)
2002      #-x86
2003      (let ((ip (frame-ip frame)))
2004        (and (sys:system-area-pointer-p ip)
2005             (typep (di::frame-debug-function frame) 'di::bogus-debug-function)))
2006      #+x86
2007      (let ((ip (frame-ip frame)))
2008        (and (sys:system-area-pointer-p ip)
2009             (multiple-value-bind (pc code)
2010                 (di::compute-lra-data-from-pc ip)
2011               (declare (ignore pc))
2012               (not code)))))
2013    
2014    (defun foreign-frame-source-location (frame)
2015      (let ((ip (sys:sap-int (frame-ip frame))))
2016        (cond ((probe-file *gdb-program-name*)
2017               (parse-gdb-line-info (gdb-command "info line *0x~x" ip)))
2018              (t `(:error "no srcloc available for ~a" frame)))))
2019    
2020    ;; The output of gdb looks like:
2021    ;; Line 215 of "../../src/lisp/x86-assem.S"
2022    ;;    starts at address 0x805318c <Ldone+11>
2023    ;;    and ends at 0x805318e <Ldone+13>.
2024    ;; The ../../ are fixed up with the "target:" search list which might
2025    ;; be wrong sometimes.
2026    (defun parse-gdb-line-info (string)
2027      (with-input-from-string (*standard-input* string)
2028        (let ((w1 (read-word)))
2029          (cond ((equal w1 "Line")
2030                 (let ((line (read-word)))
2031                   (assert (equal (read-word) "of"))
2032                   (let* ((file (read-from-string (read-word)))
2033                          (pathname
2034                           (or (probe-file file)
2035                               (probe-file (format nil "target:lisp/~a" file))
2036                               file)))
2037                     (make-location (list :file (unix-truename pathname))
2038                                    (list :line (parse-integer line))))))
2039                (t
2040                 `(:error ,string))))))
2041    
2042    (defun read-word (&optional (stream *standard-input*))
2043      (peek-char t stream)
2044      (concatenate 'string (loop until (whitespacep (peek-char nil stream))
2045                                 collect (read-char stream))))
2046    
2047  (defslimefun sldb-abort ()  (defun whitespacep (char)
2048    (invoke-restart (find 'abort *sldb-restarts* :key #'restart-name)))    (member char '(#\space #\newline)))
2049    
2050    
2051  ;;;; Inspecting  ;;;; Inspecting
2052    
 (defvar *inspectee*)  
 (defvar *inspectee-parts*)  
 (defvar *inspector-stack* '())  
 (defvar *inspector-history* (make-array 10 :adjustable t :fill-pointer 0))  
 (defvar *inspect-length* 30)  
   
 (defun reset-inspector ()  
   (setq *inspectee* nil)  
   (setq *inspectee-parts* nil)  
   (setq *inspector-stack* nil)  
   (setf (fill-pointer *inspector-history*) 0))  
   
 (defslimefun init-inspector (string)  
   (reset-inspector)  
   (inspect-object (eval (from-string string))))  
   
 (defun print-part-to-string (value)  
   (let ((*print-pretty* nil))  
     (let ((string (to-string value))  
           (pos (position value *inspector-history*)))  
       (if pos  
           (format nil "#~D=~A" pos string)  
           string))))  
   
 (defun inspect-object (object)  
   (push (setq *inspectee* object) *inspector-stack*)  
   (unless (find object *inspector-history*)  
     (vector-push-extend object *inspector-history*))  
   (multiple-value-bind (text parts) (inspected-parts object)  
     (setq *inspectee-parts* parts)  
       (list :text text  
             :type (to-string (type-of object))  
             :primitive-type (describe-primitive-type object)  
             :parts (loop for (label . value) in parts  
                          collect (cons label  
                                        (print-part-to-string value))))))  
2053  (defconstant +lowtag-symbols+  (defconstant +lowtag-symbols+
2054    '(vm:even-fixnum-type    '(vm:even-fixnum-type
2055      vm:function-pointer-type      vm:function-pointer-type
# Line 1152  stack." Line 2058  stack."
2058      vm:odd-fixnum-type      vm:odd-fixnum-type
2059      vm:instance-pointer-type      vm:instance-pointer-type
2060      vm:other-immediate-1-type      vm:other-immediate-1-type
2061      vm:other-pointer-type))      vm:other-pointer-type)
2062      "Names of the constants that specify type tags.
2063    The `symbol-value' of each element is a type tag.")
2064    
2065  (defconstant +header-type-symbols+  (defconstant +header-type-symbols+
2066    ;; Is there a convinient place for all those constants?    (labels ((suffixp (suffix string)
2067    (flet ((tail-comp (string tail)               (and (>= (length string) (length suffix))
2068             (and (>= (length string) (length tail))                    (string= string suffix :start1 (- (length string)
2069                  (string= string tail :start1 (- (length string)                                                      (length suffix)))))
2070                                                  (length tail))))))             (header-type-symbol-p (x)
2071      (remove-if-not               (and (suffixp "-TYPE" (symbol-name x))
2072       (lambda (x) (and (tail-comp (symbol-name x) "-TYPE")                    (not (member x +lowtag-symbols+))
2073                        (not (member x +lowtag-symbols+))                    (boundp x)
2074                        (boundp x)                    (typep (symbol-value x) 'fixnum))))
2075                        (typep (symbol-value x) 'fixnum)))      (remove-if-not #'header-type-symbol-p
2076       (append (apropos-list "-TYPE" "VM" t)                     (append (apropos-list "-TYPE" "VM")
2077               (apropos-list "-TYPE" "BIGNUM" t)))))                             (apropos-list "-TYPE" "BIGNUM"))))
2078      "A list of names of the type codes in boxed objects.")
2079    
2080  (defun describe-primitive-type (object)  (defimplementation describe-primitive-type (object)
2081    (with-output-to-string (*standard-output*)    (with-output-to-string (*standard-output*)
2082      (let* ((lowtag (kernel:get-lowtag object))      (let* ((lowtag (kernel:get-lowtag object))
2083             (lowtag-symbol (find lowtag +lowtag-symbols+ :key #'symbol-value)))             (lowtag-symbol (find lowtag +lowtag-symbols+ :key #'symbol-value)))
2084        (format t "[lowtag: ~A" lowtag-symbol)        (format t "lowtag: ~A" lowtag-symbol)
2085        (cond ((member lowtag (list vm:other-pointer-type        (when (member lowtag (list vm:other-pointer-type
2086                                    vm:function-pointer-type                                   vm:function-pointer-type
2087                                    vm:other-immediate-0-type                                   vm:other-immediate-0-type
2088                                    vm:other-immediate-1-type                                   vm:other-immediate-1-type
2089                                    ))                                   ))
2090               (let* ((type (kernel:get-type object))          (let* ((type (kernel:get-type object))
2091                      (type-symbol (find type +header-type-symbols+                 (type-symbol (find type +header-type-symbols+
2092                                         :key #'symbol-value)))                                    :key #'symbol-value)))
2093                 (format t ", type: ~A]" type-symbol)))            (format t ", type: ~A" type-symbol))))))
             (t (format t "]"))))))  
   
 (defun nth-part (index)  
   (cdr (nth index *inspectee-parts*)))  
   
 (defslimefun inspect-nth-part (index)  
   (inspect-object (nth-part index)))  
   
 (defslimefun inspector-pop ()  
   "Drop the inspector stack and inspect the second element.  Return  
 nil if there's no second element."  
   (cond ((cdr *inspector-stack*)  
          (pop *inspector-stack*)  
          (inspect-object (pop *inspector-stack*)))  
         (t nil)))  
   
 (defslimefun inspector-next ()  
   "Inspect the next element in the *inspector-history*."  
   (let ((position (position *inspectee* *inspector-history*)))  
     (cond ((= (1+ position) (length *inspector-history*))  
            nil)  
           (t (inspect-object (aref *inspector-history* (1+ position)))))))  
   
 (defslimefun quit-inspector ()  
   (reset-inspector)  
   nil)  
   
 (defslimefun describe-inspectee ()  
   "Describe the currently inspected object."  
   (print-description-to-string *inspectee*))  
   
 (defgeneric inspected-parts (object)  
   (:documentation  
    "Return a short description and a list of (label . value) pairs."))  
2094    
2095  (defmethod inspected-parts (o)  (defmethod emacs-inspect ((o t))
2096    (cond ((di::indirect-value-cell-p o)    (cond ((di::indirect-value-cell-p o)
2097           (inspected-parts-of-value-cell o))           `("Value: " (:value ,(c:value-cell-ref o))))
2098            ((alien::alien-value-p o)
2099             (inspect-alien-value o))
2100          (t          (t
2101           (destructuring-bind (text labeledp . parts)           (cmucl-inspect o))))
2102               (inspect::describe-parts o)  
2103             (let ((parts (if labeledp  (defun cmucl-inspect (o)
2104                              (loop for (label . value) in parts    (destructuring-bind (text labeledp . parts) (inspect::describe-parts o)
2105                                    collect (cons (string label) value))      (list* (format nil "~A~%" text)
2106                              (loop for value in parts             (if labeledp
2107                                    for i from 0                 (loop for (label . value) in parts
2108                                    collect (cons (format nil "~D" i) value)))))                       append (label-value-line label value))
2109               (values text parts))))))                 (loop for value in parts  for i from 0
2110                         append (label-value-line i value))))))
 (defun inspected-parts-of-value-cell (o)  
   (values (format nil "~A~% is a value cell." o)  
           (list (cons "Value" (c:value-cell-ref o)))))  
   
 ;; borrowed from sbcl  
 (defmethod inspected-parts ((object cons))  
   (if (consp (cdr object))  
       (inspected-parts-of-nontrivial-list object)  
       (inspected-parts-of-simple-cons object)))  
   
 (defun inspected-parts-of-simple-cons (object)  
   (values "The object is a CONS."  
           (list (cons (string 'car) (car object))  
                 (cons (string 'cdr) (cdr object)))))  
   
 (defun inspected-parts-of-nontrivial-list (object)  
   (let ((length 0)  
         (in-list object)  
         (reversed-elements nil))  
     (flet ((done (description-format)  
              (return-from inspected-parts-of-nontrivial-list  
                (values (format nil description-format length)  
                        (nreverse reversed-elements)))))  
       (loop  
        (cond ((null in-list)  
               (done "The object is a proper list of length ~S.~%"))  
              ((>= length *inspect-length*)  
               (push (cons  (string 'rest) in-list) reversed-elements)  
               (done "The object is a long list (more than ~S elements).~%"))  
              ((consp in-list)  
               (push (cons (format nil "~D" length) (pop in-list))  
                     reversed-elements)  
               (incf length))  
              (t  
               (push (cons (string 'rest) in-list) reversed-elements)  
               (done "The object is an improper list of length ~S.~%")))))))  
2111    
2112  (defmethod inspected-parts ((o function))  (defmethod emacs-inspect ((o function))
2113    (let ((header (kernel:get-type o)))    (let ((header (kernel:get-type o)))
2114      (cond ((= header vm:function-header-type)      (cond ((= header vm:function-header-type)
2115             (values             (append (label-value-line*
2116              (format nil "~A~% is a function." o)                      ("Self" (kernel:%function-self o))
2117              (list (cons "Self" (kernel:%function-self o))                      ("Next" (kernel:%function-next o))
2118                    (cons "Next" (kernel:%function-next o))                      ("Name" (kernel:%function-name o))
2119                    (cons "Name" (kernel:%function-name o))                      ("Arglist" (kernel:%function-arglist o))
2120                    (cons "Arglist" (kernel:%function-arglist o))                      ("Type" (kernel:%function-type o))
2121                    (cons "Type" (kernel:%function-type o))                      ("Code" (kernel:function-code-header o)))
2122                    (cons "Code Object" (kernel:function-code-header o)))))                     (list
2123            ((= header vm:closure-header-type)                      (with-output-to-string (s)
2124             (values (format nil "~A~% is a closure." o)                        (disassem:disassemble-function o :stream s)))))
2125                     (list*            ((= header vm:closure-header-type)
2126                      (cons "Function" (kernel:%closure-function o))             (list* (format nil "~A is a closure.~%" o)
2127                      (loop for i from 0 below (- (kernel:get-closure-length o)                    (append
2128                                                  (1- vm:closure-info-offset))                     (label-value-line "Function" (kernel:%closure-function o))
2129                            collect (cons (format nil "~D" i)                     `("Environment:" (:newline))
2130                                          (kernel:%closure-index-ref o i))))))                     (loop for i from 0 below (1- (kernel:get-closure-length o))
2131            (t (call-next-method o)))))                           append (label-value-line
2132                                     i (kernel:%closure-index-ref o i))))))
2133  (defmethod inspected-parts ((o kernel:code-component))            ((eval::interpreted-function-p o)
2134    (values (format nil "~A~% is a code data-block." o)             (cmucl-inspect o))
2135            `(("First entry point" . ,(kernel:%code-entry-points o))            (t
2136              ,@(loop for i from vm:code-constants-offset             (call-next-method)))))
2137                      below (kernel:get-header-data o)  
2138                      collect (cons (format nil "Constant#~D" i)  (defmethod emacs-inspect ((o kernel:funcallable-instance))
2139                                    (kernel:code-header-ref o i)))    (append (label-value-line*
2140              ("Debug info" . ,(kernel:%code-debug-info o))             (:function (kernel:%funcallable-instance-function o))
2141              ("Instructions"  . ,(kernel:code-instructions o)))))             (:lexenv  (kernel:%funcallable-instance-lexenv o))
2142               (:layout  (kernel:%funcallable-instance-layout o)))
2143  (defmethod inspected-parts ((o kernel:fdefn))            (cmucl-inspect o)))
2144    (values (format nil "~A~% is a fdefn object." o)  
2145            `(("Name" . ,(kernel:fdefn-name o))  (defmethod emacs-inspect ((o kernel:code-component))
2146              ("Function" . ,(kernel:fdefn-function o)))))    (append
2147       (label-value-line*
2148  ;;; Local Variables:      ("code-size" (kernel:%code-code-size o))
2149  ;;; eval: (font-lock-add-keywords 'lisp-mode '(("(\\(defslimefun\\)\\s +\\(\\(\\w\\|\\s_\\)+\\)"  (1 font-lock-keyword-face) (2 font-lock-function-name-face))))      ("entry-points" (kernel:%code-entry-points o))
2150  ;;; End:      ("debug-info" (kernel:%code-debug-info o))
2151        ("trace-table-offset" (kernel:code-header-ref
2152                               o vm:code-trace-table-offset-slot)))
2153       `("Constants:" (:newline))
2154       (loop for i from vm:code-constants-offset
2155             below (kernel:get-header-data o)
2156             append (label-value-line i (kernel:code-header-ref o i)))
2157       `("Code:"
2158         (:newline)
2159         , (with-output-to-string (*standard-output*)
2160             (cond ((c::compiled-debug-info-p (kernel:%code-debug-info o))
2161                    (disassem:disassemble-code-component o))
2162                   ((or
2163                     (c::debug-info-p (kernel:%code-debug-info o))
2164                     (consp (kernel:code-header-ref
2165                             o vm:code-trace-table-offset-slot)))
2166                    (c:disassem-byte-component o))
2167                   (t
2168                    (disassem:disassemble-memory
2169                     (disassem::align
2170                      (+ (logandc2 (kernel:get-lisp-obj-address o)
2171                                   vm:lowtag-mask)
2172                         (* vm:code-constants-offset vm:word-bytes))
2173                      (ash 1 vm:lowtag-bits))
2174                     (ash (kernel:%code-code-size o) vm:word-shift))))))))
2175    
2176    (defmethod emacs-inspect ((o kernel:fdefn))
2177      (label-value-line*
2178       ("name" (kernel:fdefn-name o))
2179       ("function" (kernel:fdefn-function o))
2180       ("raw-addr" (sys:sap-ref-32
2181                    (sys:int-sap (kernel:get-lisp-obj-address o))
2182                    (* vm:fdefn-raw-addr-slot vm:word-bytes)))))
2183    
2184    #+(or)
2185    (defmethod emacs-inspect ((o array))
2186      (if (typep o 'simple-array)
2187          (call-next-method)
2188          (label-value-line*
2189           (:header (describe-primitive-type o))
2190           (:rank (array-rank o))
2191           (:fill-pointer (kernel:%array-fill-pointer o))
2192           (:fill-pointer-p (kernel:%array-fill-pointer-p o))
2193           (:elements (kernel:%array-available-elements o))
2194           (:data (kernel:%array-data-vector o))
2195           (:displacement (kernel:%array-displacement o))
2196           (:displaced-p (kernel:%array-displaced-p o))
2197           (:dimensions (array-dimensions o)))))
2198    
2199    (defmethod emacs-inspect ((o simple-vector))
2200      (append
2201       (label-value-line*
2202        (:header (describe-primitive-type o))
2203        (:length (c::vector-length o)))
2204       (loop for i below (length o)
2205             append (label-value-line i (aref o i)))))
2206    
2207    (defun inspect-alien-record (alien)
2208      (with-struct (alien::alien-value- sap type) alien
2209        (with-struct (alien::alien-record-type- kind name fields) type
2210          (append
2211           (label-value-line*
2212            (:sap sap)
2213            (:kind kind)
2214            (:name name))
2215           (loop for field in fields
2216                 append (let ((slot (alien::alien-record-field-name field)))
2217                          (declare (optimize (speed 0)))
2218                          (label-value-line slot (alien:slot alien slot))))))))
2219    
2220    (defun inspect-alien-pointer (alien)
2221      (with-struct (alien::alien-value- sap type) alien
2222        (label-value-line*
2223         (:sap sap)
2224         (:type type)
2225         (:to (alien::deref alien)))))
2226    
2227    (defun inspect-alien-value (alien)
2228      (typecase (alien::alien-value-type alien)
2229        (alien::alien-record-type (inspect-alien-record alien))
2230        (alien::alien-pointer-type (inspect-alien-pointer alien))
2231        (t (cmucl-inspect alien))))
2232    
2233    (defimplementation eval-context (obj)
2234      (cond ((typep (class-of obj) 'structure-class)
2235             (let* ((dd (kernel:layout-info (kernel:layout-of obj)))
2236                    (slots (kernel:dd-slots dd)))
2237               (list* (cons '*package*
2238                            (symbol-package (if slots
2239                                                (kernel:dsd-name (car slots))
2240                                                (kernel:dd-name dd))))
2241                      (loop for slot in slots collect
2242                            (cons (kernel:dsd-name slot)
2243                                  (funcall (kernel:dsd-accessor slot) obj))))))))
2244    
2245    
2246    ;;;; Profiling
2247    (defimplementation profile (fname)
2248      (eval `(profile:profile ,fname)))
2249    
2250    (defimplementation unprofile (fname)
2251      (eval `(profile:unprofile ,fname)))
2252    
2253    (defimplementation unprofile-all ()
2254      (eval `(profile:unprofile))
2255      "All functions unprofiled.")
2256    
2257    (defimplementation profile-report ()
2258      (eval `(profile:report-time)))
2259    
2260    (defimplementation profile-reset ()
2261      (eval `(profile:reset-time))
2262      "Reset profiling counters.")
2263    
2264    (defimplementation profiled-functions ()
2265      profile:*timed-functions*)
2266    
2267    (defimplementation profile-package (package callers methods)
2268      (profile:profile-all :package package
2269                           :callers-p callers
2270                           #-cmu18e :methods #-cmu18e methods))
2271    
2272    
2273    ;;;; Multiprocessing
2274    
2275    #+mp
2276    (progn
2277      (defimplementation initialize-multiprocessing (continuation)
2278        (mp::init-multi-processing)
2279        (mp:make-process continuation :name "swank")
2280        ;; Threads magic: this never returns! But top-level becomes
2281        ;; available again.
2282        (unless mp::*idle-process*
2283          (mp::startup-idle-and-top-level-loops)))
2284    
2285      (defimplementation spawn (fn &key name)
2286        (mp:make-process fn :name (or name "Anonymous")))
2287    
2288      (defvar *thread-id-counter* 0)
2289    
2290      (defimplementation thread-id (thread)
2291        (or (getf (mp:process-property-list thread) 'id)
2292            (setf (getf (mp:process-property-list thread) 'id)
2293                  (incf *thread-id-counter*))))
2294    
2295      (defimplementation find-thread (id)
2296        (find id (all-threads)
2297              :key (lambda (p) (getf (mp:process-property-list p) 'id))))
2298    
2299      (defimplementation thread-name (thread)
2300        (mp:process-name thread))
2301    
2302      (defimplementation thread-status (thread)
2303        (mp:process-whostate thread))
2304    
2305      (defimplementation current-thread ()
2306        mp:*current-process*)
2307    
2308      (defimplementation all-threads ()
2309        (copy-list mp:*all-processes*))
2310    
2311      (defimplementation interrupt-thread (thread fn)
2312        (mp:process-interrupt thread fn))
2313    
2314      (defimplementation kill-thread (thread)
2315        (mp:destroy-process thread))
2316    
2317      (defvar *mailbox-lock* (mp:make-lock "mailbox lock"))
2318    
2319      (defstruct (mailbox (:conc-name mailbox.))
2320        (mutex (mp:make-lock "process mailbox"))
2321        (queue '() :type list))
2322    
2323      (defun mailbox (thread)
2324        "Return THREAD's mailbox."
2325        (mp:with-lock-held (*mailbox-lock*)
2326          (or (getf (mp:process-property-list thread) 'mailbox)
2327              (setf (getf (mp:process-property-list thread) 'mailbox)
2328                    (make-mailbox)))))
2329    
2330      (defimplementation send (thread message)
2331        (check-slime-interrupts)
2332        (let* ((mbox (mailbox thread)))
2333          (mp:with-lock-held ((mailbox.mutex mbox))
2334            (setf (mailbox.queue mbox)
2335                  (nconc (mailbox.queue mbox) (list message))))))
2336    
2337      (defimplementation receive-if (test &optional timeout)
2338        (let ((mbox (mailbox mp:*current-process*)))
2339          (assert (or (not timeout) (eq timeout t)))
2340          (loop
2341           (check-slime-interrupts)
2342           (mp:with-lock-held ((mailbox.mutex mbox))
2343             (let* ((q (mailbox.queue mbox))
2344                    (tail (member-if test q)))
2345               (when tail
2346                 (setf (mailbox.queue mbox)
2347                       (nconc (ldiff q tail) (cdr tail)))
2348                 (return (car tail)))))
2349           (when (eq timeout t) (return (values nil t)))
2350           (mp:process-wait-with-timeout
2351            "receive-if" 0.5
2352            (lambda () (some test (mailbox.queue mbox)))))))
2353    
2354    
2355      ) ;; #+mp
2356    
2357    
2358    
2359    ;;;; GC hooks
2360    ;;;
2361    ;;; Display GC messages in the echo area to avoid cluttering the
2362    ;;; normal output.
2363    ;;;
2364    
2365    ;; this should probably not be here, but where else?
2366    (defun background-message (message)
2367      (funcall (find-symbol (string :background-message) :swank)
2368               message))
2369    
2370    (defun print-bytes (nbytes &optional stream)
2371      "Print the number NBYTES to STREAM in KB, MB, or GB units."
2372      (let ((names '((0 bytes) (10 kb) (20 mb) (30 gb) (40 tb) (50 eb))))
2373        (multiple-value-bind (power name)
2374            (loop for ((p1 n1) (p2 n2)) on names
2375                  while n2 do
2376                  (when (<= (expt 2 p1) nbytes (1- (expt 2 p2)))
2377                    (return (values p1 n1))))
2378          (cond (name
2379                 (format stream "~,1F ~A" (/ nbytes (expt 2 power)) name))
2380                (t
2381                 (format stream "~:D bytes" nbytes))))))
2382    
2383    (defconstant gc-generations 6)
2384    
2385    #+gencgc
2386    (defun generation-stats ()
2387      "Return a string describing the size distribution among the generations."
2388      (let* ((alloc (loop for i below gc-generations
2389                          collect (lisp::gencgc-stats i)))
2390             (sum (coerce (reduce #'+ alloc) 'float)))
2391        (format nil "~{~3F~^/~}"
2392                (mapcar (lambda (size) (/ size sum))
2393                        alloc))))
2394    
2395    (defvar *gc-start-time* 0)
2396    
2397    (defun pre-gc-hook (bytes-in-use)
2398      (setq *gc-start-time* (get-internal-real-time))
2399      (let ((msg (format nil "[Commencing GC with ~A in use.]"
2400                         (print-bytes bytes-in-use))))
2401        (background-message msg)))
2402    
2403    (defun post-gc-hook (bytes-retained bytes-freed trigger)
2404      (declare (ignore trigger))
2405      (let* ((seconds (/ (- (get-internal-real-time) *gc-start-time*)
2406                         internal-time-units-per-second))
2407             (msg (format nil "[GC done. ~A freed  ~A retained  ~A  ~4F sec]"
2408                         (print-bytes bytes-freed)
2409                         (print-bytes bytes-retained)
2410                         #+gencgc(generation-stats)
2411                         #-gencgc""
2412                         seconds)))
2413        (background-message msg)))
2414    
2415    (defun install-gc-hooks ()
2416      (setq ext:*gc-notify-before* #'pre-gc-hook)
2417      (setq ext:*gc-notify-after* #'post-gc-hook))
2418    
2419    (defun remove-gc-hooks ()
2420      (setq ext:*gc-notify-before* #'lisp::default-gc-notify-before)
2421      (setq ext:*gc-notify-after* #'lisp::default-gc-notify-after))
2422    
2423    (defvar *install-gc-hooks* t
2424      "If non-nil install GC hooks")
2425    
2426    (defimplementation emacs-connected ()
2427      (when *install-gc-hooks*
2428        (install-gc-hooks)))
2429    
2430    ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2431    ;;Trace implementations
2432    ;;In CMUCL, we have:
2433    ;; (trace <name>)
2434    ;; (trace (method <name> <qualifier>? (<specializer>+)))
2435    ;; (trace :methods t '<name>) ;;to trace all methods of the gf <name>
2436    ;; <name> can be a normal name or a (setf name)
2437    
2438    (defun tracedp (spec)
2439      (member spec (eval '(trace)) :test #'equal))
2440    
2441    (defun toggle-trace-aux (spec &rest options)
2442      (cond ((tracedp spec)
2443             (eval `(untrace ,spec))
2444             (format nil "~S is now untraced." spec))
2445            (t
2446             (eval `(trace ,spec ,@options))
2447             (format nil "~S is now traced." spec))))
2448    
2449    (defimplementation toggle-trace (spec)
2450      (ecase (car spec)
2451        ((setf)
2452         (toggle-trace-aux spec))
2453        ((:defgeneric)
2454         (let ((name (second spec)))
2455           (toggle-trace-aux name :methods name)))
2456        ((:defmethod)
2457         (cond ((fboundp `(method ,@(cdr spec)))
2458                (toggle-trace-aux `(method ,(cdr spec))))
2459               ;; Man, is this ugly
2460               ((fboundp `(pcl::fast-method ,@(cdr spec)))
2461                (toggle-trace-aux `(pcl::fast-method ,@(cdr spec))))
2462               (t
2463                (error 'undefined-function :name (cdr spec)))))
2464        ((:call)
2465         (destructuring-bind (caller callee) (cdr spec)
2466           (toggle-trace-aux (process-fspec callee)
2467                             :wherein (list (process-fspec caller)))))
2468        ;; doesn't work properly
2469        ;; ((:labels :flet) (toggle-trace-aux (process-fspec spec)))
2470        ))
2471    
2472    (defun process-fspec (fspec)
2473      (cond ((consp fspec)
2474             (ecase (first fspec)
2475               ((:defun :defgeneric) (second fspec))
2476               ((:defmethod)
2477                `(method ,(second fspec) ,@(third fspec) ,(fourth fspec)))
2478               ((:labels) `(labels ,(third fspec) ,(process-fspec (second fspec))))
2479               ((:flet) `(flet ,(third fspec) ,(process-fspec (second fspec))))))
2480            (t
2481             fspec)))
2482    
2483    ;;; Weak datastructures
2484    
2485    (defimplementation make-weak-key-hash-table (&rest args)
2486      (apply #'make-hash-table :weak-p t args))
2487    
2488    
2489    ;;; Save image
2490    
2491    (defimplementation save-image (filename &optional restart-function)
2492      (multiple-value-bind (pid error) (unix:unix-fork)
2493        (when (not pid) (error "fork: ~A" (unix:get-unix-error-msg error)))
2494        (cond ((= pid 0)
2495               (apply #'ext:save-lisp
2496                      filename
2497                      (if restart-function
2498                          `(:init-function ,restart-function))))
2499              (t
2500               (let ((status (waitpid pid)))
2501                 (destructuring-bind (&key exited? status &allow-other-keys) status
2502                   (assert (and exited? (equal status 0)) ()
2503                           "Invalid exit status: ~a" status)))))))
2504    
2505    (defun waitpid (pid)
2506      (alien:with-alien ((status c-call:int))
2507        (let ((code (alien:alien-funcall
2508                     (alien:extern-alien
2509                      waitpid (alien:function c-call:int c-call:int
2510                                              (* c-call:int) c-call:int))
2511                     pid (alien:addr status) 0)))
2512          (cond ((= code -1) (error "waitpid: ~A" (unix:get-unix-error-msg)))
2513                (t (assert (= code pid))
2514                   (decode-wait-status status))))))
2515    
2516    (defun decode-wait-status (status)
2517      (let ((output (with-output-to-string (s)
2518                      (call-program (list (process-status-program)
2519                                          (format nil "~d" status))
2520                                    :output s))))
2521        (read-from-string output)))
2522    
2523    (defun call-program (args &key output)
2524      (destructuring-bind (program &rest args) args
2525        (let ((process (ext:run-program program args :output output)))
2526          (when (not program) (error "fork failed"))
2527          (unless (and (eq (ext:process-status process) :exited)
2528                       (= (ext:process-exit-code process) 0))
2529            (error "Non-zero exit status")))))
2530    
2531    (defvar *process-status-program* nil)
2532    
2533    (defun process-status-program ()
2534      (or *process-status-program*
2535          (setq *process-status-program*
2536                (compile-process-status-program))))
2537    
2538    (defun compile-process-status-program ()
2539      (let ((infile (system::pick-temporary-file-name
2540                     "/tmp/process-status~d~c.c")))
2541        (with-open-file (stream infile :direction :output :if-exists :supersede)
2542          (format stream "
2543    #include <stdio.h>
2544    #include <stdlib.h>
2545    #include <sys/types.h>
2546    #include <sys/wait.h>
2547    #include <assert.h>
2548    
2549    #define FLAG(value) (value ? \"t\" : \"nil\")
2550    
2551    int main (int argc, char** argv) {
2552      assert (argc == 2);
2553      {
2554        char* endptr = NULL;
2555        char* arg = argv[1];
2556        long int status = strtol (arg, &endptr, 10);
2557        assert (endptr != arg && *endptr == '\\0');
2558        printf (\"(:exited? %s :status %d :signal? %s :signal %d :coredump? %s\"
2559                \" :stopped? %s :stopsig %d)\\n\",
2560                FLAG(WIFEXITED(status)), WEXITSTATUS(status),
2561                FLAG(WIFSIGNALED(status)), WTERMSIG(status),
2562                FLAG(WCOREDUMP(status)),
2563                FLAG(WIFSTOPPED(status)), WSTOPSIG(status));
2564        fflush (NULL);
2565        return 0;
2566      }
2567    }
2568    ")
2569          (finish-output stream))
2570        (let* ((outfile (system::pick-temporary-file-name))
2571               (args (list "cc" "-o" outfile infile)))
2572          (warn "Running cc: ~{~a ~}~%" args)
2573          (call-program args :output t)
2574          (delete-file infile)
2575          outfile)))
2576    
2577    #+#.(swank-backend:with-symbol 'unicode-complete 'lisp)
2578    (defun match-semi-standard (prefix matchp)
2579      ;; Handle the CMUCL's short character names.
2580      (loop for name in lisp::char-name-alist
2581         when (funcall matchp prefix (car name))
2582         collect (car name)))
2583    
2584    #+#.(swank-backend:with-symbol 'unicode-complete 'lisp)
2585    (defimplementation character-completion-set (prefix matchp)
2586      (let ((names (lisp::unicode-complete prefix)))
2587        ;; Match prefix against semistandard names.  If there's a match,
2588        ;; add it to our list of matches.
2589        (let ((semi-standard (match-semi-standard prefix matchp)))
2590          (when semi-standard
2591            (setf names (append semi-standard names))))
2592        (setf names (mapcar #'string-capitalize names))
2593        (loop for n in names
2594           when (funcall matchp prefix n)
2595           collect n)))
2596    
2597    (defimplementation codepoint-length (string)
2598      "Return the number of code points in the string.  The string MUST be
2599      a valid UTF-16 string."
2600      (do ((len (length string))
2601           (index 0 (1+ index))
2602           (count 0 (1+ count)))
2603          ((>= index len)
2604           count)
2605        (multiple-value-bind (codepoint wide)
2606            (lisp:codepoint string index)
2607          (declare (ignore codepoint))
2608          (when wide (incf index)))))

Legend:
Removed from v.1.32  
changed lines
  Added in v.1.235

  ViewVC Help
Powered by ViewVC 1.1.5