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

Contents of /slime/swank-scl.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.37 - (hide annotations)
Thu May 6 06:18:32 2010 UTC (3 years, 11 months ago) by heller
Branch: MAIN
CVS Tags: SLIME-2-3, SLIME-2-2, FAIRLY-STABLE, byte-stream
Changes since 1.36: +0 -5 lines
Remove some non-standard file variables.

* swank-cmucl.lisp, swank-scl.lisp: Remove pbook vars.
* swank-clisp.lisp: Remove indentation settings. Slime does it
automatically.
1 dcrosher 1.1 ;;; -*- indent-tabs-mode: nil; outline-regexp: ";;;;+" -*-
2     ;;;
3     ;;; Scieneer Common Lisp code for SLIME.
4     ;;;
5     ;;; This code has been placed in the Public Domain. All warranties
6     ;;; are disclaimed.
7     ;;;
8    
9     (in-package :swank-backend)
10    
11    
12    
13     ;;; swank-mop
14    
15 dcrosher 1.7 (import-swank-mop-symbols :clos '(:slot-definition-documentation))
16 dcrosher 1.1
17     (defun swank-mop:slot-definition-documentation (slot)
18 dcrosher 1.7 (documentation slot t))
19 dcrosher 1.1
20    
21     ;;;; TCP server
22     ;;;
23     ;;; SCL only supports the :spawn communication style.
24     ;;;
25    
26     (defimplementation preferred-communication-style ()
27     :spawn)
28    
29     (defimplementation create-socket (host port)
30     (let ((addr (resolve-hostname host)))
31     (ext:create-inet-listener port :stream :host addr :reuse-address t)))
32    
33     (defimplementation local-port (socket)
34     (nth-value 1 (ext::get-socket-host-and-port (socket-fd socket))))
35    
36     (defimplementation close-socket (socket)
37     (ext:close-socket (socket-fd socket)))
38    
39 heller 1.10 (defimplementation accept-connection (socket
40     &key external-format buffering timeout)
41 heller 1.12 (let ((external-format (or external-format :default))
42 heller 1.10 (buffering (or buffering :full))
43 dcrosher 1.6 (fd (socket-fd socket)))
44     (loop
45     (let ((ready (sys:wait-until-fd-usable fd :input timeout)))
46     (unless ready
47     (error "Timeout accepting connection on socket: ~S~%" socket)))
48     (let ((new-fd (ignore-errors (ext:accept-tcp-connection fd))))
49     (when new-fd
50     (return (make-socket-io-stream new-fd external-format buffering)))))))
51    
52     (defimplementation set-stream-timeout (stream timeout)
53     (check-type timeout (or null real))
54     (if (fboundp 'ext::stream-timeout)
55     (setf (ext::stream-timeout stream) timeout)
56 dcrosher 1.14 (setf (slot-value (slot-value stream 'lisp::stream) 'lisp::timeout)
57     timeout)))
58 dcrosher 1.1
59     ;;;;; Sockets
60    
61     (defun socket-fd (socket)
62     "Return the file descriptor for the socket represented by 'socket."
63     (etypecase socket
64     (fixnum socket)
65     (stream (sys:fd-stream-fd socket))))
66    
67     (defun resolve-hostname (hostname)
68     "Return the IP address of 'hostname as an integer (in host byte-order)."
69     (let ((hostent (ext:lookup-host-entry hostname)))
70     (car (ext:host-entry-addr-list hostent))))
71    
72 heller 1.12 (defvar *external-format-to-coding-system*
73     '((:iso-8859-1
74     "latin-1" "latin-1-unix" "iso-latin-1-unix"
75     "iso-8859-1" "iso-8859-1-unix")
76     (:utf-8 "utf-8" "utf-8-unix")
77     (:euc-jp "euc-jp" "euc-jp-unix")))
78    
79     (defimplementation find-external-format (coding-system)
80     (car (rassoc-if (lambda (x) (member coding-system x :test #'equal))
81     *external-format-to-coding-system*)))
82 dcrosher 1.1
83 dcrosher 1.3 (defun make-socket-io-stream (fd external-format buffering)
84 dcrosher 1.1 "Create a new input/output fd-stream for 'fd."
85 heller 1.12 (let* ((stream (sys:make-fd-stream fd :input t :output t
86 dcrosher 1.7 :element-type 'base-char
87     :buffering buffering
88     :external-format external-format)))
89     ;; Ignore character conversion errors. Without this the communication
90     ;; channel is prone to lockup if a character conversion error occurs.
91 dcrosher 1.14 (setf (lisp::character-conversion-stream-input-error-value stream) #\?)
92     (setf (lisp::character-conversion-stream-output-error-value stream) #\?)
93 dcrosher 1.7 stream))
94 dcrosher 1.1
95    
96     ;;;; Stream handling
97    
98     (defclass slime-input-stream (ext:character-input-stream)
99     ((buffer :initarg :buffer :type string)
100     (index :initarg :index :initform 0 :type fixnum)
101     (position :initarg :position :initform 0 :type integer)
102     (interactive :initarg :interactive :initform nil :type (member nil t))
103     (input-fn :initarg :input-fn :type function)
104     ))
105    
106 heller 1.23 (defun make-slime-input-stream (input-fn)
107 dcrosher 1.1 (declare (function input-fn))
108     (make-instance 'slime-input-stream
109     :in-buffer (make-string 256)
110     :in-head 0 :in-tail 0
111     :out-buffer ""
112     :buffer "" :index 0
113 heller 1.23 :input-fn input-fn))
114 dcrosher 1.1
115     (defmethod print-object ((s slime-input-stream) stream)
116     (print-unreadable-object (s stream :type t)))
117    
118     ;;; input-stream-p inherits from input-stream.
119     ;;; output-stream-p inherits nil.
120    
121     (defmethod ext:stream-listen ((stream slime-input-stream))
122     (let* ((buffer (slot-value stream 'buffer))
123     (index (slot-value stream 'index))
124     (length (length buffer)))
125     (declare (type string buffer)
126     (fixnum index length))
127     (< index length)))
128    
129     (defmethod close ((stream slime-input-stream) &key ((:abort abort) nil))
130     (declare (ignore abort))
131     (when (ext:stream-open-p stream)
132     (setf (ext:stream-open-p stream) nil)
133     (setf (ext:stream-in-buffer stream) " ")
134     t))
135    
136     (defmethod ext:stream-clear-input ((stream slime-input-stream))
137     (let* ((input-buffer (slot-value stream 'buffer))
138     (index (slot-value stream 'index))
139     (input-length (length input-buffer))
140     (available (- input-length index))
141     (position (slot-value stream 'position))
142     (new-position (+ position available)))
143     (declare (type kernel:index index available position new-position))
144     (setf (slot-value stream 'position) new-position))
145     (setf (slot-value stream 'buffer) "")
146     (setf (slot-value stream 'index) 0)
147     nil)
148    
149     ;;; No 'stream-finish-output method.
150     ;;; No 'stream-force-output method.
151     ;;; No 'stream-clear-output method.
152    
153     ;;; stream-element-type inherits from character-stream.
154    
155     ;;; No 'stream-line-length method.
156     ;;; No 'stream-line-column method.
157    
158     ;;; Add the remaining input to the current position.
159     (defmethod file-length ((stream slime-input-stream))
160     (let* ((input-buffer (slot-value stream 'buffer))
161     (index (slot-value stream 'index))
162     (input-length (length input-buffer))
163     (available (- input-length index))
164     (position (slot-value stream 'position))
165     (file-length (+ position available)))
166     (declare (type kernel:index index available position file-length))
167     file-length))
168    
169     (defmethod ext:stream-file-position ((stream slime-input-stream)
170     &optional position)
171     (let ((current-position (slot-value stream 'position)))
172     (declare (type kernel:index current-position))
173     (cond (position
174     ;; Could make an attempt here, but just give up for now.
175     nil)
176     (t
177     current-position))))
178    
179     (defmethod interactive-stream-p ((stream slime-input-stream))
180     (slot-value stream 'interactive))
181    
182     ;;; No 'file-string-length method.
183    
184     (defmethod ext:stream-read-chars ((stream slime-input-stream) buffer
185     start requested waitp)
186     (declare (type simple-string buffer)
187     (type kernel:index start requested))
188     (let* ((input-buffer (slot-value stream 'buffer))
189     (index (slot-value stream 'index))
190     (input-length (length input-buffer))
191     (available (- input-length index))
192     (copy (min available requested)))
193     (declare (string input-buffer)
194     (type kernel:index index available copy))
195     (cond ((plusp copy)
196     (dotimes (i copy)
197     (declare (type kernel:index i))
198     (setf (aref buffer (+ start i)) (aref input-buffer (+ index i))))
199 dcrosher 1.5 (setf (slot-value stream 'index) (+ index copy))
200 dcrosher 1.1 (incf (slot-value stream 'position) copy)
201     copy)
202     (waitp
203 heller 1.23 (let ((input-fn (slot-value stream 'input-fn)))
204 dcrosher 1.1 (declare (type function input-fn))
205     (let ((new-input (funcall input-fn)))
206     (cond ((zerop (length new-input))
207     -1)
208     (t
209     (setf (slot-value stream 'buffer) new-input)
210     (setf (slot-value stream 'index) 0)
211 dcrosher 1.5 (ext:stream-read-chars stream buffer
212     start requested waitp))))))
213 dcrosher 1.1 (t
214     0))))
215    
216     ;;; Slime output stream.
217    
218     (defclass slime-output-stream (ext:character-output-stream)
219     ((output-fn :initarg :output-fn :type function)
220 dcrosher 1.26 (output-buffer :initarg :output-buffer :type simple-string)
221     (buffer-tail :initarg :buffer-tail :initform 0 :type kernel:index)
222     (last-write :initarg :last-write)
223 dcrosher 1.1 (column :initform 0 :type kernel:index)
224     (interactive :initform nil :type (member nil t))
225     (position :initform 0 :type integer)))
226    
227     (defun make-slime-output-stream (output-fn)
228     (declare (function output-fn))
229     (make-instance 'slime-output-stream
230     :in-buffer ""
231 dcrosher 1.26 :out-buffer ""
232     :output-buffer (make-string 256)
233     :output-fn output-fn
234     :last-write (get-internal-real-time)
235     ))
236 dcrosher 1.1
237     (defmethod print-object ((s slime-output-stream) stream)
238     (print-unreadable-object (s stream :type t)))
239    
240     ;;; Use default 'input-stream-p method for 'output-stream which returns 'nil.
241     ;;; Use default 'output-stream-p method for 'output-stream which returns 't.
242    
243     ;;; No 'stream-listen method.
244    
245     (defmethod close ((stream slime-output-stream) &key ((:abort abort) nil))
246     (when (ext:stream-open-p stream)
247     (unless abort
248     (finish-output stream))
249     (setf (ext:stream-open-p stream) nil)
250 dcrosher 1.26 (setf (slot-value stream 'output-buffer) "")
251 dcrosher 1.1 t))
252    
253     ;;; No 'stream-clear-input method.
254    
255     (defmethod ext:stream-finish-output ((stream slime-output-stream))
256 dcrosher 1.26 (let ((buffer-tail (slot-value stream 'buffer-tail)))
257     (declare (type kernel:index buffer-tail))
258     (when (> buffer-tail 0)
259     (let ((output-fn (slot-value stream 'output-fn))
260     (output-buffer (slot-value stream 'output-buffer)))
261     (declare (function output-fn)
262     (simple-string output-buffer))
263     (funcall output-fn (subseq output-buffer 0 buffer-tail))
264     (setf (slot-value stream 'buffer-tail) 0))
265     (setf (slot-value stream 'last-write) (get-internal-real-time))))
266 dcrosher 1.1 nil)
267    
268     (defmethod ext:stream-force-output ((stream slime-output-stream))
269 dcrosher 1.26 (ext:stream-finish-output stream)
270 dcrosher 1.1 nil)
271    
272     (defmethod ext:stream-clear-output ((stream slime-output-stream))
273 dcrosher 1.26 (decf (slot-value stream 'position) (slot-value stream 'buffer-tail))
274     (setf (slot-value stream 'buffer-tail) 0)
275 dcrosher 1.1 nil)
276    
277     ;;; Use default 'stream-element-type method for 'character-stream which
278     ;;; returns 'base-char.
279    
280     (defmethod ext:stream-line-length ((stream slime-output-stream))
281     80)
282    
283     (defmethod ext:stream-line-column ((stream slime-output-stream))
284     (slot-value stream 'column))
285    
286     (defmethod file-length ((stream slime-output-stream))
287     (slot-value stream 'position))
288    
289     (defmethod ext:stream-file-position ((stream slime-output-stream)
290     &optional position)
291     (declare (optimize (speed 3)))
292     (cond (position
293     (let* ((current-position (slot-value stream 'position))
294     (target-position (etypecase position
295     ((member :start) 0)
296     ((member :end) current-position)
297     (kernel:index position))))
298     (declare (type kernel:index current-position target-position))
299     (cond ((= target-position current-position)
300     t)
301     ((> target-position current-position)
302 dcrosher 1.26 (ext:stream-finish-output stream)
303 dcrosher 1.1 (let ((output-fn (slot-value stream 'output-fn))
304     (fill-size (- target-position current-position)))
305     (declare (function output-fn))
306     (funcall output-fn (make-string fill-size
307     :initial-element #\space))
308     (setf (slot-value stream 'position) target-position))
309 dcrosher 1.26 (setf (slot-value stream 'last-write) (get-internal-real-time))
310 dcrosher 1.1 t)
311     (t
312     nil))))
313     (t
314     (slot-value stream 'position))))
315    
316     (defmethod interactive-stream-p ((stream slime-output-stream))
317     (slot-value stream 'interactive))
318    
319     ;;; Use the default 'character-output-stream 'file-string-length method.
320    
321 dcrosher 1.26 ;;; stream-write-char -- internal
322     ;;;
323     (defmethod ext:stream-write-char ((stream slime-output-stream) character)
324     (declare (type character character)
325     (optimize (speed 3)))
326     (unless (ext:stream-open-p stream)
327     (error 'kernel:simple-stream-error
328     :stream stream
329     :format-control "Stream closed."))
330     ;;
331     ;; Fill the output buffer.
332     (let* ((buffer-tail (slot-value stream 'buffer-tail))
333     (output-buffer (slot-value stream 'output-buffer))
334     (buffer-length (length output-buffer)))
335     (declare (type kernel:index buffer-tail)
336     (simple-string output-buffer))
337     (when (>= buffer-tail buffer-length)
338     ;; Flush the output buffer to make room.
339     (let ((output-fn (slot-value stream 'output-fn)))
340     (declare (function output-fn))
341     (funcall output-fn output-buffer)
342     (setf buffer-tail 0)
343     (setf (slot-value stream 'last-write) (get-internal-real-time))))
344     (setf (aref output-buffer buffer-tail) character)
345     (incf buffer-tail)
346     (setf (slot-value stream 'buffer-tail) buffer-tail)
347     ;;
348     (let ((newline (char= character #\newline)))
349     (when (or newline
350     (let ((last-write (slot-value stream 'last-write)))
351     (declare (type integer last-write))
352     (> (get-internal-real-time)
353     (+ last-write (* 5 internal-time-units-per-second)))))
354     ;; Flush the output buffer.
355     (let ((output-fn (slot-value stream 'output-fn)))
356     (declare (function output-fn))
357     (funcall output-fn (subseq output-buffer 0 buffer-tail))
358     (setf buffer-tail 0)
359     (setf (slot-value stream 'buffer-tail) buffer-tail)
360     (setf (slot-value stream 'last-write) (get-internal-real-time))))
361     ;;
362     (setf (slot-value stream 'column)
363     (if newline
364     0
365     (let ((line-column (slot-value stream 'column)))
366     (declare (type kernel:index line-column))
367     (+ line-column 1))))
368     (incf (slot-value stream 'position))
369     ))
370     character)
371    
372 dcrosher 1.1 ;;; stream-write-chars
373     ;;;
374 dcrosher 1.8 (defmethod ext:stream-write-chars ((stream slime-output-stream)
375     string start end waitp)
376 dcrosher 1.1 (declare (simple-string string)
377 dcrosher 1.8 (type kernel:index start end)
378     (ignore waitp))
379 dcrosher 1.1 (declare (optimize (speed 3)))
380     (unless (ext:stream-open-p stream)
381     (error 'kernel:simple-stream-error
382     :stream stream
383     :format-control "Stream closed."))
384     (let* ((string-length (length string))
385     (start (cond ((< start 0) 0)
386     ((> start string-length) string-length)
387     (t start)))
388     (end (cond ((< end start) start)
389     ((> end string-length) string-length)
390     (t end)))
391     (length (- end start))
392     (output-fn (slot-value stream 'output-fn)))
393     (declare (type kernel:index start end length)
394     (type function output-fn))
395     (unless (zerop length)
396     (funcall output-fn (subseq string start end))
397     (let ((last-newline (position #\newline string :from-end t
398     :start start :end end)))
399     (setf (slot-value stream 'column)
400     (if last-newline
401     (- end last-newline 1)
402     (let ((column (slot-value stream 'column)))
403     (declare (type kernel:index column))
404 dcrosher 1.26 (+ column (- end start))))))
405     (incf (slot-value stream 'position) length)))
406 dcrosher 1.8 (- end start))
407 dcrosher 1.1
408     ;;;
409    
410 heller 1.23 (defimplementation make-output-stream (output-fn)
411     (make-slime-output-stream output-fn))
412    
413     (defimplementation make-input-stream (input-fn)
414     (make-slime-input-stream input-fn))
415 dcrosher 1.1
416    
417     ;;;; Compilation Commands
418    
419     (defvar *previous-compiler-condition* nil
420     "Used to detect duplicates.")
421    
422     (defvar *previous-context* nil
423     "Previous compiler error context.")
424    
425     (defvar *buffer-name* nil
426     "The name of the Emacs buffer we are compiling from.
427     Nil if we aren't compiling from a buffer.")
428    
429     (defvar *buffer-start-position* nil)
430     (defvar *buffer-substring* nil)
431    
432     (defimplementation call-with-compilation-hooks (function)
433     (let ((*previous-compiler-condition* nil)
434     (*previous-context* nil)
435     (*print-readably* nil))
436     (handler-bind ((c::compiler-error #'handle-notification-condition)
437     (c::style-warning #'handle-notification-condition)
438     (c::warning #'handle-notification-condition))
439     (funcall function))))
440    
441 heller 1.32 (defimplementation swank-compile-file (input-file output-file
442 sboukarev 1.36 load-p external-format
443     &key policy)
444     (declare (ignore policy))
445 heller 1.12 (with-compilation-hooks ()
446     (let ((*buffer-name* nil)
447     (ext:*ignore-extra-close-parentheses* nil))
448     (multiple-value-bind (output-file warnings-p failure-p)
449 heller 1.32 (compile-file input-file
450     :output-file output-file
451     :external-format external-format)
452 heller 1.28 (values output-file warnings-p
453     (or failure-p
454     (when load-p
455     ;; Cache the latest source file for definition-finding.
456 heller 1.32 (source-cache-get input-file
457     (file-write-date input-file))
458 heller 1.28 (not (load output-file)))))))))
459 dcrosher 1.1
460 heller 1.31 (defimplementation swank-compile-string (string &key buffer position filename
461 trittweiler 1.30 policy)
462 heller 1.31 (declare (ignore filename policy))
463 dcrosher 1.1 (with-compilation-hooks ()
464     (let ((*buffer-name* buffer)
465     (*buffer-start-position* position)
466     (*buffer-substring* string))
467     (with-input-from-string (stream string)
468     (ext:compile-from-stream
469     stream
470     :source-info `(:emacs-buffer ,buffer
471     :emacs-buffer-offset ,position
472     :emacs-buffer-string ,string))))))
473    
474    
475     ;;;;; Trapping notes
476     ;;;
477     ;;; We intercept conditions from the compiler and resignal them as
478     ;;; `swank:compiler-condition's.
479    
480     (defun handle-notification-condition (condition)
481     "Handle a condition caused by a compiler warning."
482     (unless (eq condition *previous-compiler-condition*)
483     (let ((context (c::find-error-context nil)))
484     (setq *previous-compiler-condition* condition)
485     (setq *previous-context* context)
486     (signal-compiler-condition condition context))))
487    
488     (defun signal-compiler-condition (condition context)
489     (signal (make-condition
490     'compiler-condition
491     :original-condition condition
492     :severity (severity-for-emacs condition)
493 heller 1.34 :message (brief-compiler-message-for-emacs condition)
494     :source-context (compiler-error-context context)
495 dcrosher 1.1 :location (if (read-error-p condition)
496     (read-error-location condition)
497     (compiler-note-location context)))))
498    
499     (defun severity-for-emacs (condition)
500     "Return the severity of 'condition."
501     (etypecase condition
502     ((satisfies read-error-p) :read-error)
503     (c::compiler-error :error)
504     (c::style-warning :note)
505     (c::warning :warning)))
506    
507     (defun read-error-p (condition)
508     (eq (type-of condition) 'c::compiler-read-error))
509    
510     (defun brief-compiler-message-for-emacs (condition)
511     "Briefly describe a compiler error for Emacs.
512     When Emacs presents the message it already has the source popped up
513     and the source form highlighted. This makes much of the information in
514     the error-context redundant."
515     (princ-to-string condition))
516    
517 heller 1.34 (defun compiler-error-context (error-context)
518 dcrosher 1.1 "Describe a compiler error for Emacs including context information."
519     (declare (type (or c::compiler-error-context null) error-context))
520     (multiple-value-bind (enclosing source)
521     (if error-context
522     (values (c::compiler-error-context-enclosing-source error-context)
523     (c::compiler-error-context-source error-context)))
524 heller 1.34 (if (and enclosing source)
525     (format nil "~@[--> ~{~<~%--> ~1:;~A~> ~}~%~]~@[~{==>~%~A~^~%~}~]"
526     enclosing source))))
527 dcrosher 1.1
528     (defun read-error-location (condition)
529     (let* ((finfo (car (c::source-info-current-file c::*source-info*)))
530     (file (c::file-info-name finfo))
531     (pos (c::compiler-read-error-position condition)))
532     (cond ((and (eq file :stream) *buffer-name*)
533     (make-location (list :buffer *buffer-name*)
534 heller 1.25 (list :offset *buffer-start-position* pos)))
535 dcrosher 1.1 ((and (pathnamep file) (not *buffer-name*))
536     (make-location (list :file (unix-truename file))
537     (list :position (1+ pos))))
538     (t (break)))))
539    
540     (defun compiler-note-location (context)
541     "Derive the location of a complier message from its context.
542     Return a `location' record, or (:error <reason>) on failure."
543     (if (null context)
544     (note-error-location)
545     (let ((file (c::compiler-error-context-file-name context))
546     (source (c::compiler-error-context-original-source context))
547     (path
548     (reverse (c::compiler-error-context-original-source-path context))))
549     (or (locate-compiler-note file source path)
550     (note-error-location)))))
551    
552     (defun note-error-location ()
553     "Pseudo-location for notes that can't be located."
554     (list :error "No error location available."))
555    
556     (defun locate-compiler-note (file source source-path)
557     (cond ((and (eq file :stream) *buffer-name*)
558     ;; Compiling from a buffer
559 heller 1.25 (make-location (list :buffer *buffer-name*)
560     (list :offset *buffer-start-position*
561     (source-path-string-position
562     source-path *buffer-substring*))))
563 dcrosher 1.1 ((and (pathnamep file) (null *buffer-name*))
564     ;; Compiling from a file
565     (make-location (list :file (unix-truename file))
566 heller 1.25 (list :position (1+ (source-path-file-position
567     source-path file)))))
568 dcrosher 1.1 ((and (eq file :lisp) (stringp source))
569     ;; No location known, but we have the source form.
570     ;; XXX How is this case triggered? -luke (16/May/2004)
571     ;; This can happen if the compiler needs to expand a macro
572     ;; but the macro-expander is not yet compiled. Calling the
573     ;; (interpreted) macro-expander triggers IR1 conversion of
574     ;; the lambda expression for the expander and invokes the
575     ;; compiler recursively.
576     (make-location (list :source-form source)
577     (list :position 1)))))
578    
579     (defun unix-truename (pathname)
580     (ext:unix-namestring (truename pathname)))
581    
582    
583    
584     ;;; TODO
585     (defimplementation who-calls (name) nil)
586     (defimplementation who-references (name) nil)
587     (defimplementation who-binds (name) nil)
588     (defimplementation who-sets (name) nil)
589     (defimplementation who-specializes (symbol) nil)
590     (defimplementation who-macroexpands (name) nil)
591    
592    
593     ;;;; Find callers and callees
594     ;;;
595     ;;; Find callers and callees by looking at the constant pool of
596     ;;; compiled code objects. We assume every fdefn object in the
597     ;;; constant pool corresponds to a call to that function. A better
598     ;;; strategy would be to use the disassembler to find actual
599     ;;; call-sites.
600    
601     (declaim (inline map-code-constants))
602     (defun map-code-constants (code fn)
603     "Call 'fn for each constant in 'code's constant pool."
604     (check-type code kernel:code-component)
605     (loop for i from vm:code-constants-offset below (kernel:get-header-data code)
606     do (funcall fn (kernel:code-header-ref code i))))
607    
608     (defun function-callees (function)
609     "Return 'function's callees as a list of functions."
610     (let ((callees '()))
611     (map-code-constants
612     (vm::find-code-object function)
613     (lambda (obj)
614     (when (kernel:fdefn-p obj)
615     (push (kernel:fdefn-function obj) callees))))
616     callees))
617    
618     (declaim (ext:maybe-inline map-allocated-code-components))
619     (defun map-allocated-code-components (spaces fn)
620     "Call FN for each allocated code component in one of 'spaces. FN
621     receives the object as argument. 'spaces should be a list of the
622     symbols :dynamic, :static, or :read-only."
623     (dolist (space spaces)
624     (declare (inline vm::map-allocated-objects)
625     (optimize (ext:inhibit-warnings 3)))
626     (vm::map-allocated-objects
627     (lambda (obj header size)
628     (declare (type fixnum size) (ignore size))
629     (when (= vm:code-header-type header)
630     (funcall fn obj)))
631     space)))
632    
633     (declaim (ext:maybe-inline map-caller-code-components))
634     (defun map-caller-code-components (function spaces fn)
635     "Call 'fn for each code component with a fdefn for 'function in its
636     constant pool."
637     (let ((function (coerce function 'function)))
638     (declare (inline map-allocated-code-components))
639     (map-allocated-code-components
640     spaces
641     (lambda (obj)
642     (map-code-constants
643     obj
644     (lambda (constant)
645     (when (and (kernel:fdefn-p constant)
646     (eq (kernel:fdefn-function constant)
647     function))
648     (funcall fn obj))))))))
649    
650     (defun function-callers (function &optional (spaces '(:read-only :static
651     :dynamic)))
652     "Return 'function's callers. The result is a list of code-objects."
653     (let ((referrers '()))
654     (declare (inline map-caller-code-components))
655     (map-caller-code-components function spaces
656     (lambda (code) (push code referrers)))
657     referrers))
658    
659     (defun debug-info-definitions (debug-info)
660     "Return the defintions for a debug-info. This should only be used
661     for code-object without entry points, i.e., byte compiled
662     code (are theree others?)"
663     ;; This mess has only been tested with #'ext::skip-whitespace, a
664     ;; byte-compiled caller of #'read-char .
665     (check-type debug-info (and (not c::compiled-debug-info) c::debug-info))
666     (let ((name (c::debug-info-name debug-info))
667     (source (c::debug-info-source debug-info)))
668     (destructuring-bind (first) source
669     (ecase (c::debug-source-from first)
670     (:file
671     (list (list name
672     (make-location
673     (list :file (unix-truename (c::debug-source-name first)))
674     (list :function-name (string name))))))))))
675    
676     (defun valid-function-name-p (name)
677     (or (symbolp name) (and (consp name)
678     (eq (car name) 'setf)
679     (symbolp (cadr name))
680     (not (cddr name)))))
681    
682     (defun code-component-entry-points (code)
683     "Return a list ((name location) ...) of function definitons for
684     the code omponent 'code."
685     (let ((names '()))
686     (do ((f (kernel:%code-entry-points code) (kernel::%function-next f)))
687     ((not f))
688     (let ((name (kernel:%function-name f)))
689     (when (valid-function-name-p name)
690     (push (list name (function-location f)) names))))
691     names))
692    
693     (defimplementation list-callers (symbol)
694     "Return a list ((name location) ...) of callers."
695     (let ((components (function-callers symbol))
696     (xrefs '()))
697     (dolist (code components)
698     (let* ((entry (kernel:%code-entry-points code))
699     (defs (if entry
700     (code-component-entry-points code)
701     ;; byte compiled stuff
702     (debug-info-definitions
703     (kernel:%code-debug-info code)))))
704     (setq xrefs (nconc defs xrefs))))
705     xrefs))
706    
707     (defimplementation list-callees (symbol)
708     (let ((fns (function-callees symbol)))
709     (mapcar (lambda (fn)
710     (list (kernel:%function-name fn)
711     (function-location fn)))
712     fns)))
713    
714    
715     ;;;; Resolving source locations
716     ;;;
717     ;;; Our mission here is to "resolve" references to code locations into
718     ;;; actual file/buffer names and character positions. The references
719     ;;; we work from come out of the compiler's statically-generated debug
720     ;;; information, such as `code-location''s and `debug-source''s. For
721     ;;; more details, see the "Debugger Programmer's Interface" section of
722     ;;; the SCL manual.
723     ;;;
724     ;;; The first step is usually to find the corresponding "source-path"
725     ;;; for the location. Once we have the source-path we can pull up the
726     ;;; source file and `READ' our way through to the right position. The
727     ;;; main source-code groveling work is done in
728     ;;; `swank-source-path-parser.lisp'.
729    
730     (defvar *debug-definition-finding* nil
731     "When true don't handle errors while looking for definitions.
732     This is useful when debugging the definition-finding code.")
733    
734     (defvar *source-snippet-size* 256
735     "Maximum number of characters in a snippet of source code.
736     Snippets at the beginning of definitions are used to tell Emacs what
737     the definitions looks like, so that it can accurately find them by
738     text search.")
739    
740     (defmacro safe-definition-finding (&body body)
741     "Execute 'body and return the source-location it returns.
742     If an error occurs and `*debug-definition-finding*' is false, then
743     return an error pseudo-location.
744    
745     The second return value is 'nil if no error occurs, otherwise it is the
746     condition object."
747     `(flet ((body () ,@body))
748     (if *debug-definition-finding*
749     (body)
750     (handler-case (values (progn ,@body) nil)
751     (error (c) (values (list :error (princ-to-string c)) c))))))
752    
753     (defun code-location-source-location (code-location)
754     "Safe wrapper around `code-location-from-source-location'."
755     (safe-definition-finding
756     (source-location-from-code-location code-location)))
757    
758     (defun source-location-from-code-location (code-location)
759     "Return the source location for 'code-location."
760     (let ((debug-fun (di:code-location-debug-function code-location)))
761     (when (di::bogus-debug-function-p debug-fun)
762     ;; Those lousy cheapskates! They've put in a bogus debug source
763     ;; because the code was compiled at a low debug setting.
764     (error "Bogus debug function: ~A" debug-fun)))
765     (let* ((debug-source (di:code-location-debug-source code-location))
766     (from (di:debug-source-from debug-source))
767     (name (di:debug-source-name debug-source)))
768     (ecase from
769     (:file
770     (location-in-file name code-location debug-source))
771     (:stream
772     (location-in-stream code-location debug-source))
773     (:lisp
774     ;; The location comes from a form passed to `compile'.
775     ;; The best we can do is return the form itself for printing.
776     (make-location
777     (list :source-form (with-output-to-string (*standard-output*)
778     (debug::print-code-location-source-form
779     code-location 100 t)))
780     (list :position 1))))))
781    
782     (defun location-in-file (filename code-location debug-source)
783     "Resolve the source location for 'code-location in 'filename."
784     (let* ((code-date (di:debug-source-created debug-source))
785     (source-code (get-source-code filename code-date)))
786     (with-input-from-string (s source-code)
787     (make-location (list :file (unix-truename filename))
788     (list :position (1+ (code-location-stream-position
789 heller 1.25 code-location s)))
790 dcrosher 1.1 `(:snippet ,(read-snippet s))))))
791    
792     (defun location-in-stream (code-location debug-source)
793     "Resolve the source location for a 'code-location from a stream.
794     This only succeeds if the code was compiled from an Emacs buffer."
795     (unless (debug-source-info-from-emacs-buffer-p debug-source)
796     (error "The code is compiled from a non-SLIME stream."))
797     (let* ((info (c::debug-source-info debug-source))
798     (string (getf info :emacs-buffer-string))
799     (position (code-location-string-offset
800     code-location
801     string)))
802     (make-location
803     (list :buffer (getf info :emacs-buffer))
804 heller 1.25 (list :offset (getf info :emacs-buffer-offset) position)
805 dcrosher 1.1 (list :snippet (with-input-from-string (s string)
806     (file-position s position)
807     (read-snippet s))))))
808    
809     ;;;;; Function-name locations
810     ;;;
811     (defun debug-info-function-name-location (debug-info)
812     "Return a function-name source-location for 'debug-info.
813     Function-name source-locations are a fallback for when precise
814     positions aren't available."
815     (with-struct (c::debug-info- (fname name) source) debug-info
816     (with-struct (c::debug-source- info from name) (car source)
817     (ecase from
818     (:file
819     (make-location (list :file (namestring (truename name)))
820     (list :function-name (string fname))))
821     (:stream
822     (assert (debug-source-info-from-emacs-buffer-p (car source)))
823     (make-location (list :buffer (getf info :emacs-buffer))
824     (list :function-name (string fname))))
825     (:lisp
826     (make-location (list :source-form (princ-to-string (aref name 0)))
827     (list :position 1)))))))
828    
829     (defun debug-source-info-from-emacs-buffer-p (debug-source)
830     "Does the `info' slot of 'debug-source contain an Emacs buffer location?
831     This is true for functions that were compiled directly from buffers."
832     (info-from-emacs-buffer-p (c::debug-source-info debug-source)))
833    
834     (defun info-from-emacs-buffer-p (info)
835     (and info
836     (consp info)
837     (eq :emacs-buffer (car info))))
838    
839    
840     ;;;;; Groveling source-code for positions
841    
842     (defun code-location-stream-position (code-location stream)
843     "Return the byte offset of 'code-location in 'stream. Extract the
844     toplevel-form-number and form-number from 'code-location and use that
845     to find the position of the corresponding form.
846    
847     Finish with 'stream positioned at the start of the code location."
848     (let* ((location (debug::maybe-block-start-location code-location))
849     (tlf-offset (di:code-location-top-level-form-offset location))
850     (form-number (di:code-location-form-number location)))
851     (let ((pos (form-number-stream-position tlf-offset form-number stream)))
852     (file-position stream pos)
853     pos)))
854    
855     (defun form-number-stream-position (tlf-number form-number stream)
856     "Return the starting character position of a form in 'stream.
857     'tlf-number is the top-level-form number.
858     'form-number is an index into a source-path table for the TLF."
859     (multiple-value-bind (tlf position-map) (read-source-form tlf-number stream)
860     (let* ((path-table (di:form-number-translations tlf 0))
861     (source-path
862     (if (<= (length path-table) form-number) ; source out of sync?
863     (list 0) ; should probably signal a condition
864     (reverse (cdr (aref path-table form-number))))))
865     (source-path-source-position source-path tlf position-map))))
866    
867     (defun code-location-string-offset (code-location string)
868     "Return the byte offset of 'code-location in 'string.
869     See 'code-location-stream-position."
870     (with-input-from-string (s string)
871     (code-location-stream-position code-location s)))
872    
873    
874     ;;;; Finding definitions
875    
876     ;;; There are a great many different types of definition for us to
877     ;;; find. We search for definitions of every kind and return them in a
878     ;;; list.
879    
880     (defimplementation find-definitions (name)
881     (append (function-definitions name)
882     (setf-definitions name)
883     (variable-definitions name)
884     (class-definitions name)
885     (type-definitions name)
886     (compiler-macro-definitions name)
887     (source-transform-definitions name)
888     (function-info-definitions name)
889     (ir1-translator-definitions name)))
890    
891     ;;;;; Functions, macros, generic functions, methods
892     ;;;
893     ;;; We make extensive use of the compile-time debug information that
894     ;;; SCL records, in particular "debug functions" and "code
895     ;;; locations." Refer to the "Debugger Programmer's Interface" section
896     ;;; of the SCL manual for more details.
897    
898     (defun function-definitions (name)
899     "Return definitions for 'name in the \"function namespace\", i.e.,
900     regular functions, generic functions, methods and macros.
901     'name can any valid function name (e.g, (setf car))."
902     (let ((macro? (and (symbolp name) (macro-function name)))
903     (special? (and (symbolp name) (special-operator-p name)))
904     (function? (and (valid-function-name-p name)
905     (ext:info :function :definition name)
906     (if (symbolp name) (fboundp name) t))))
907     (cond (macro?
908     (list `((defmacro ,name)
909     ,(function-location (macro-function name)))))
910     (special?
911     (list `((:special-operator ,name)
912     (:error ,(format nil "Special operator: ~S" name)))))
913     (function?
914     (let ((function (fdefinition name)))
915     (if (genericp function)
916     (generic-function-definitions name function)
917     (list (list `(function ,name)
918     (function-location function)))))))))
919    
920     ;;;;;; Ordinary (non-generic/macro/special) functions
921     ;;;
922     ;;; First we test if FUNCTION is a closure created by defstruct, and
923     ;;; if so extract the defstruct-description (`dd') from the closure
924     ;;; and find the constructor for the struct. Defstruct creates a
925     ;;; defun for the default constructor and we use that as an
926     ;;; approximation to the source location of the defstruct.
927     ;;;
928     ;;; For an ordinary function we return the source location of the
929     ;;; first code-location we find.
930     ;;;
931     (defun function-location (function)
932     "Return the source location for FUNCTION."
933     (cond ((struct-closure-p function)
934     (struct-closure-location function))
935     ((c::byte-function-or-closure-p function)
936     (byte-function-location function))
937     (t
938     (compiled-function-location function))))
939    
940     (defun compiled-function-location (function)
941     "Return the location of a regular compiled function."
942     (multiple-value-bind (code-location error)
943     (safe-definition-finding (function-first-code-location function))
944     (cond (error (list :error (princ-to-string error)))
945     (t (code-location-source-location code-location)))))
946    
947     (defun function-first-code-location (function)
948     "Return the first code-location we can find for 'function."
949     (and (function-has-debug-function-p function)
950     (di:debug-function-start-location
951     (di:function-debug-function function))))
952    
953     (defun function-has-debug-function-p (function)
954     (di:function-debug-function function))
955    
956     (defun function-code-object= (closure function)
957     (and (eq (vm::find-code-object closure)
958     (vm::find-code-object function))
959     (not (eq closure function))))
960    
961    
962     (defun byte-function-location (fn)
963     "Return the location of the byte-compiled function 'fn."
964     (etypecase fn
965     ((or c::hairy-byte-function c::simple-byte-function)
966     (let* ((component (c::byte-function-component fn))
967     (debug-info (kernel:%code-debug-info component)))
968     (debug-info-function-name-location debug-info)))
969     (c::byte-closure
970     (byte-function-location (c::byte-closure-function fn)))))
971    
972     ;;; Here we deal with structure accessors. Note that `dd' is a
973     ;;; "defstruct descriptor" structure in SCL. A `dd' describes a
974     ;;; `defstruct''d structure.
975    
976     (defun struct-closure-p (function)
977     "Is 'function a closure created by defstruct?"
978     (or (function-code-object= function #'kernel::structure-slot-accessor)
979     (function-code-object= function #'kernel::structure-slot-setter)
980     (function-code-object= function #'kernel::%defstruct)))
981    
982     (defun struct-closure-location (function)
983     "Return the location of the structure that 'function belongs to."
984     (assert (struct-closure-p function))
985     (safe-definition-finding
986     (dd-location (struct-closure-dd function))))
987    
988     (defun struct-closure-dd (function)
989     "Return the defstruct-definition (dd) of FUNCTION."
990     (assert (= (kernel:get-type function) vm:closure-header-type))
991     (flet ((find-layout (function)
992     (sys:find-if-in-closure
993     (lambda (x)
994     (let ((value (if (di::indirect-value-cell-p x)
995     (c:value-cell-ref x)
996     x)))
997     (when (kernel::layout-p value)
998     (return-from find-layout value))))
999     function)))
1000     (kernel:layout-info (find-layout function))))
1001    
1002     (defun dd-location (dd)
1003     "Return the location of a `defstruct'."
1004     ;; Find the location in a constructor.
1005     (function-location (struct-constructor dd)))
1006    
1007     (defun struct-constructor (dd)
1008     "Return a constructor function from a defstruct definition.
1009     Signal an error if no constructor can be found."
1010     (let ((constructor (or (kernel:dd-default-constructor dd)
1011     (car (kernel::dd-constructors dd)))))
1012     (when (or (null constructor)
1013     (and (consp constructor) (null (car constructor))))
1014     (error "Cannot find structure's constructor: ~S"
1015     (kernel::dd-name dd)))
1016     (coerce (if (consp constructor) (first constructor) constructor)
1017     'function)))
1018    
1019     ;;;;;; Generic functions and methods
1020    
1021     (defun generic-function-definitions (name function)
1022     "Return the definitions of a generic function and its methods."
1023     (cons (list `(defgeneric ,name) (gf-location function))
1024     (gf-method-definitions function)))
1025    
1026     (defun gf-location (gf)
1027     "Return the location of the generic function GF."
1028     (definition-source-location gf (clos:generic-function-name gf)))
1029    
1030     (defun gf-method-definitions (gf)
1031     "Return the locations of all methods of the generic function GF."
1032     (mapcar #'method-definition (clos:generic-function-methods gf)))
1033    
1034     (defun method-definition (method)
1035     (list (method-dspec method)
1036     (method-location method)))
1037    
1038     (defun method-dspec (method)
1039     "Return a human-readable \"definition specifier\" for METHOD."
1040     (let* ((gf (clos:method-generic-function method))
1041     (name (clos:generic-function-name gf))
1042     (specializers (clos:method-specializers method))
1043     (qualifiers (clos:method-qualifiers method)))
1044     `(method ,name ,@qualifiers ,specializers #+nil (clos::unparse-specializers specializers))))
1045    
1046     ;; XXX maybe special case setters/getters
1047     (defun method-location (method)
1048     (function-location (clos:method-function method)))
1049    
1050     (defun genericp (fn)
1051     (typep fn 'generic-function))
1052    
1053     ;;;;;; Types and classes
1054    
1055     (defun type-definitions (name)
1056     "Return `deftype' locations for type NAME."
1057     (maybe-make-definition (ext:info :type :expander name) 'deftype name))
1058    
1059     (defun maybe-make-definition (function kind name)
1060     "If FUNCTION is non-nil then return its definition location."
1061     (if function
1062     (list (list `(,kind ,name) (function-location function)))))
1063    
1064     (defun class-definitions (name)
1065     "Return the definition locations for the class called NAME."
1066     (if (symbolp name)
1067     (let ((class (find-class name nil)))
1068     (etypecase class
1069     (null '())
1070     (structure-class
1071     (list (list `(defstruct ,name)
1072     (dd-location (find-dd name)))))
1073     (standard-class
1074     (list (list `(defclass ,name)
1075     (class-location (find-class name)))))
1076     ((or built-in-class
1077     kernel:funcallable-structure-class)
1078     (list (list `(kernel::define-type-class ,name)
1079     `(:error
1080     ,(format nil "No source info for ~A" name)))))))))
1081    
1082     (defun class-location (class)
1083     "Return the `defclass' location for CLASS."
1084     (definition-source-location class (class-name class)))
1085    
1086     (defun find-dd (name)
1087     "Find the defstruct-definition by the name of its structure-class."
1088     (let ((layout (ext:info :type :compiler-layout name)))
1089     (if layout
1090     (kernel:layout-info layout))))
1091    
1092     (defun condition-class-location (class)
1093     (let ((name (class-name class)))
1094     `(:error ,(format nil "No location info for condition: ~A" name))))
1095    
1096     (defun make-name-in-file-location (file string)
1097     (multiple-value-bind (filename c)
1098     (ignore-errors
1099     (unix-truename (merge-pathnames (make-pathname :type "lisp")
1100     file)))
1101     (cond (filename (make-location `(:file ,filename)
1102     `(:function-name ,(string string))))
1103     (t (list :error (princ-to-string c))))))
1104    
1105     (defun definition-source-location (object name)
1106     `(:error ,(format nil "No source info for: ~A" object)))
1107    
1108     (defun setf-definitions (name)
1109     (let ((function (or (ext:info :setf :inverse name)
1110     (ext:info :setf :expander name))))
1111     (if function
1112     (list (list `(setf ,name)
1113     (function-location (coerce function 'function)))))))
1114    
1115    
1116     (defun variable-location (symbol)
1117     `(:error ,(format nil "No source info for variable ~S" symbol)))
1118    
1119     (defun variable-definitions (name)
1120     (if (symbolp name)
1121     (multiple-value-bind (kind recorded-p) (ext:info :variable :kind name)
1122     (if recorded-p
1123     (list (list `(variable ,kind ,name)
1124     (variable-location name)))))))
1125    
1126     (defun compiler-macro-definitions (symbol)
1127     (maybe-make-definition (compiler-macro-function symbol)
1128     'define-compiler-macro
1129     symbol))
1130    
1131     (defun source-transform-definitions (name)
1132     (maybe-make-definition (ext:info :function :source-transform name)
1133     'c:def-source-transform
1134     name))
1135    
1136     (defun function-info-definitions (name)
1137     (let ((info (ext:info :function :info name)))
1138     (if info
1139     (append (loop for transform in (c::function-info-transforms info)
1140     collect (list `(c:deftransform ,name
1141     ,(c::type-specifier
1142     (c::transform-type transform)))
1143     (function-location (c::transform-function
1144     transform))))
1145     (maybe-make-definition (c::function-info-derive-type info)
1146     'c::derive-type name)
1147     (maybe-make-definition (c::function-info-optimizer info)
1148     'c::optimizer name)
1149     (maybe-make-definition (c::function-info-ltn-annotate info)
1150     'c::ltn-annotate name)
1151     (maybe-make-definition (c::function-info-ir2-convert info)
1152     'c::ir2-convert name)
1153     (loop for template in (c::function-info-templates info)
1154     collect (list `(c::vop ,(c::template-name template))
1155     (function-location
1156     (c::vop-info-generator-function
1157     template))))))))
1158    
1159     (defun ir1-translator-definitions (name)
1160     (maybe-make-definition (ext:info :function :ir1-convert name)
1161     'c:def-ir1-translator name))
1162    
1163    
1164     ;;;; Documentation.
1165    
1166     (defimplementation describe-symbol-for-emacs (symbol)
1167     (let ((result '()))
1168     (flet ((doc (kind)
1169     (or (documentation symbol kind) :not-documented))
1170     (maybe-push (property value)
1171     (when value
1172     (setf result (list* property value result)))))
1173     (maybe-push
1174     :variable (multiple-value-bind (kind recorded-p)
1175     (ext:info variable kind symbol)
1176     (declare (ignore kind))
1177     (if (or (boundp symbol) recorded-p)
1178     (doc 'variable))))
1179     (when (fboundp symbol)
1180     (maybe-push
1181     (cond ((macro-function symbol) :macro)
1182     ((special-operator-p symbol) :special-operator)
1183     ((genericp (fdefinition symbol)) :generic-function)
1184     (t :function))
1185     (doc 'function)))
1186     (maybe-push
1187     :setf (if (or (ext:info setf inverse symbol)
1188     (ext:info setf expander symbol))
1189     (doc 'setf)))
1190     (maybe-push
1191     :type (if (ext:info type kind symbol)
1192     (doc 'type)))
1193     (maybe-push
1194     :class (if (find-class symbol nil)
1195     (doc 'class)))
1196     (maybe-push
1197     :alien-type (if (not (eq (ext:info alien-type kind symbol) :unknown))
1198     (doc 'alien-type)))
1199     (maybe-push
1200     :alien-struct (if (ext:info alien-type struct symbol)
1201     (doc nil)))
1202     (maybe-push
1203     :alien-union (if (ext:info alien-type union symbol)
1204     (doc nil)))
1205     (maybe-push
1206     :alien-enum (if (ext:info alien-type enum symbol)
1207     (doc nil)))
1208     result)))
1209    
1210     (defimplementation describe-definition (symbol namespace)
1211     (describe (ecase namespace
1212     (:variable
1213     symbol)
1214     ((:function :generic-function)
1215     (symbol-function symbol))
1216     (:setf
1217     (or (ext:info setf inverse symbol)
1218     (ext:info setf expander symbol)))
1219     (:type
1220     (kernel:values-specifier-type symbol))
1221     (:class
1222     (find-class symbol))
1223     (:alien-struct
1224     (ext:info :alien-type :struct symbol))
1225     (:alien-union
1226     (ext:info :alien-type :union symbol))
1227     (:alien-enum
1228     (ext:info :alien-type :enum symbol))
1229     (:alien-type
1230     (ecase (ext:info :alien-type :kind symbol)
1231     (:primitive
1232     (let ((alien::*values-type-okay* t))
1233     (funcall (ext:info :alien-type :translator symbol)
1234     (list symbol))))
1235     ((:defined)
1236     (ext:info :alien-type :definition symbol))
1237 heller 1.10 (:unknown :unknown))))))
1238 dcrosher 1.1
1239     ;;;;; Argument lists
1240    
1241 heller 1.10 (defimplementation arglist (fun)
1242 dcrosher 1.26 (multiple-value-bind (args winp)
1243     (ext:function-arglist fun)
1244     (if winp args :not-available)))
1245 dcrosher 1.1
1246     (defimplementation function-name (function)
1247     (cond ((eval:interpreted-function-p function)
1248     (eval:interpreted-function-name function))
1249     ((typep function 'generic-function)
1250     (clos:generic-function-name function))
1251     ((c::byte-function-or-closure-p function)
1252     (c::byte-function-name function))
1253     (t (kernel:%function-name (kernel:%function-self function)))))
1254    
1255    
1256     ;;; A harder case: an approximate arglist is derived from available
1257     ;;; debugging information.
1258    
1259     (defun debug-function-arglist (debug-function)
1260     "Derive the argument list of DEBUG-FUNCTION from debug info."
1261     (let ((args (di::debug-function-lambda-list debug-function))
1262     (required '())
1263     (optional '())
1264     (rest '())
1265     (key '()))
1266     ;; collect the names of debug-vars
1267     (dolist (arg args)
1268     (etypecase arg
1269     (di::debug-variable
1270     (push (di::debug-variable-symbol arg) required))
1271     ((member :deleted)
1272     (push ':deleted required))
1273     (cons
1274     (ecase (car arg)
1275     (:keyword
1276     (push (second arg) key))
1277     (:optional
1278     (push (debug-variable-symbol-or-deleted (second arg)) optional))
1279     (:rest
1280     (push (debug-variable-symbol-or-deleted (second arg)) rest))))))
1281     ;; intersperse lambda keywords as needed
1282     (append (nreverse required)
1283     (if optional (cons '&optional (nreverse optional)))
1284     (if rest (cons '&rest (nreverse rest)))
1285     (if key (cons '&key (nreverse key))))))
1286    
1287     (defun debug-variable-symbol-or-deleted (var)
1288     (etypecase var
1289     (di:debug-variable
1290     (di::debug-variable-symbol var))
1291     ((member :deleted)
1292     '#:deleted)))
1293    
1294     (defun symbol-debug-function-arglist (fname)
1295     "Return FNAME's debug-function-arglist and %function-arglist.
1296     A utility for debugging DEBUG-FUNCTION-ARGLIST."
1297     (let ((fn (fdefinition fname)))
1298     (values (debug-function-arglist (di::function-debug-function fn))
1299     (kernel:%function-arglist (kernel:%function-self fn)))))
1300    
1301    
1302     ;;;; Miscellaneous.
1303    
1304     (defimplementation macroexpand-all (form)
1305     (macroexpand form))
1306    
1307     (defimplementation set-default-directory (directory)
1308     (setf (ext:default-directory) (namestring directory))
1309     ;; Setting *default-pathname-defaults* to an absolute directory
1310     ;; makes the behavior of MERGE-PATHNAMES a bit more intuitive.
1311     (setf *default-pathname-defaults* (pathname (ext:default-directory)))
1312     (default-directory))
1313    
1314     (defimplementation default-directory ()
1315     (namestring (ext:default-directory)))
1316    
1317 heller 1.27 (defimplementation pathname-to-filename (pathname)
1318     (ext:unix-namestring pathname nil))
1319    
1320 dcrosher 1.1 (defimplementation getpid ()
1321     (unix:unix-getpid))
1322    
1323     (defimplementation lisp-implementation-type-name ()
1324     (if (eq ext:*case-mode* :upper) "scl" "scl-lower"))
1325    
1326     (defimplementation quit-lisp ()
1327     (ext:quit))
1328    
1329     ;;; source-path-{stream,file,string,etc}-position moved into
1330     ;;; swank-source-path-parser
1331    
1332    
1333     ;;;; Debugging
1334    
1335     (defvar *sldb-stack-top*)
1336    
1337     (defimplementation call-with-debugging-environment (debugger-loop-fn)
1338     (let* ((*sldb-stack-top* (or debug:*stack-top-hint* (di:top-frame)))
1339     (debug:*stack-top-hint* nil)
1340     (kernel:*current-level* 0))
1341     (handler-bind ((di::unhandled-condition
1342     (lambda (condition)
1343     (error (make-condition
1344     'sldb-condition
1345     :original-condition condition)))))
1346     (funcall debugger-loop-fn))))
1347    
1348     (defun frame-down (frame)
1349     (handler-case (di:frame-down frame)
1350     (di:no-debug-info () nil)))
1351    
1352     (defun nth-frame (index)
1353     (do ((frame *sldb-stack-top* (frame-down frame))
1354     (i index (1- i)))
1355     ((zerop i) frame)))
1356    
1357     (defimplementation compute-backtrace (start end)
1358     (let ((end (or end most-positive-fixnum)))
1359     (loop for f = (nth-frame start) then (frame-down f)
1360     for i from start below end
1361 heller 1.29 while f collect f)))
1362 dcrosher 1.1
1363 heller 1.29 (defimplementation print-frame (frame stream)
1364     (let ((*standard-output* stream))
1365 dcrosher 1.1 (handler-case
1366     (debug::print-frame-call frame :verbosity 1 :number nil)
1367     (error (e)
1368     (ignore-errors (princ e stream))))))
1369    
1370 heller 1.33 (defimplementation frame-source-location (index)
1371 dcrosher 1.1 (code-location-source-location (di:frame-code-location (nth-frame index))))
1372    
1373     (defimplementation eval-in-frame (form index)
1374     (di:eval-in-frame (nth-frame index) form))
1375    
1376     (defun frame-debug-vars (frame)
1377     "Return a vector of debug-variables in frame."
1378     (di::debug-function-debug-variables (di:frame-debug-function frame)))
1379    
1380     (defun debug-var-value (var frame location)
1381     (let ((validity (di:debug-variable-validity var location)))
1382     (ecase validity
1383     (:valid (di:debug-variable-value var frame))
1384     ((:invalid :unknown) (make-symbol (string validity))))))
1385    
1386     (defimplementation frame-locals (index)
1387     (let* ((frame (nth-frame index))
1388     (loc (di:frame-code-location frame))
1389     (vars (frame-debug-vars frame)))
1390     (loop for v across vars collect
1391     (list :name (di:debug-variable-symbol v)
1392     :id (di:debug-variable-id v)
1393     :value (debug-var-value v frame loc)))))
1394    
1395     (defimplementation frame-var-value (frame var)
1396     (let* ((frame (nth-frame frame))
1397     (dvar (aref (frame-debug-vars frame) var)))
1398     (debug-var-value dvar frame (di:frame-code-location frame))))
1399    
1400     (defimplementation frame-catch-tags (index)
1401     (mapcar #'car (di:frame-catches (nth-frame index))))
1402    
1403     (defimplementation return-from-frame (index form)
1404 dcrosher 1.4 (let ((sym (find-symbol (symbol-name '#:find-debug-tag-for-frame)
1405 dcrosher 1.1 :debug-internals)))
1406     (if sym
1407     (let* ((frame (nth-frame index))
1408     (probe (funcall sym frame)))
1409     (cond (probe (throw (car probe) (eval-in-frame form index)))
1410     (t (format nil "Cannot return from frame: ~S" frame))))
1411     "return-from-frame is not implemented in this version of SCL.")))
1412    
1413     (defimplementation activate-stepping (frame)
1414     (set-step-breakpoints (nth-frame frame)))
1415    
1416     (defimplementation sldb-break-on-return (frame)
1417     (break-on-return (nth-frame frame)))
1418    
1419     ;;; We set the breakpoint in the caller which might be a bit confusing.
1420     ;;;
1421     (defun break-on-return (frame)
1422     (let* ((caller (di:frame-down frame))
1423     (cl (di:frame-code-location caller)))
1424     (flet ((hook (frame bp)
1425     (when (frame-pointer= frame caller)
1426     (di:delete-breakpoint bp)
1427     (signal-breakpoint bp frame))))
1428     (let* ((info (ecase (di:code-location-kind cl)
1429     ((:single-value-return :unknown-return) nil)
1430     (:known-return (debug-function-returns
1431     (di:frame-debug-function frame)))))
1432     (bp (di:make-breakpoint #'hook cl :kind :code-location
1433     :info info)))
1434     (di:activate-breakpoint bp)
1435     `(:ok ,(format nil "Set breakpoint in ~A" caller))))))
1436    
1437     (defun frame-pointer= (frame1 frame2)
1438     "Return true if the frame pointers of FRAME1 and FRAME2 are the same."
1439     (sys:sap= (di::frame-pointer frame1) (di::frame-pointer frame2)))
1440    
1441     ;;; The PC in escaped frames at a single-return-value point is
1442     ;;; actually vm:single-value-return-byte-offset bytes after the
1443     ;;; position given in the debug info. Here we try to recognize such
1444     ;;; cases.
1445     ;;;
1446     (defun next-code-locations (frame code-location)
1447     "Like `debug::next-code-locations' but be careful in escaped frames."
1448     (let ((next (debug::next-code-locations code-location)))
1449     (flet ((adjust-pc ()
1450     (let ((cl (di::copy-compiled-code-location code-location)))
1451     (incf (di::compiled-code-location-pc cl)
1452     vm:single-value-return-byte-offset)
1453     cl)))
1454     (cond ((and (di::compiled-frame-escaped frame)
1455     (eq (di:code-location-kind code-location)
1456     :single-value-return)
1457     (= (length next) 1)
1458     (di:code-location= (car next) (adjust-pc)))
1459     (debug::next-code-locations (car next)))
1460     (t
1461     next)))))
1462    
1463     (defun set-step-breakpoints (frame)
1464     (let ((cl (di:frame-code-location frame)))
1465     (when (di:debug-block-elsewhere-p (di:code-location-debug-block cl))
1466     (error "Cannot step in elsewhere code"))
1467     (let* ((debug::*bad-code-location-types*
1468     (remove :call-site debug::*bad-code-location-types*))
1469     (next (next-code-locations frame cl)))
1470     (cond (next
1471     (let ((steppoints '()))
1472     (flet ((hook (bp-frame bp)
1473     (signal-breakpoint bp bp-frame)
1474     (mapc #'di:delete-breakpoint steppoints)))
1475     (dolist (code-location next)
1476     (let ((bp (di:make-breakpoint #'hook code-location
1477     :kind :code-location)))
1478     (di:activate-breakpoint bp)
1479     (push bp steppoints))))))
1480     (t
1481     (break-on-return frame))))))
1482    
1483    
1484     ;; XXX the return values at return breakpoints should be passed to the
1485     ;; user hooks. debug-int.lisp should be changed to do this cleanly.
1486    
1487     ;;; The sigcontext and the PC for a breakpoint invocation are not
1488     ;;; passed to user hook functions, but we need them to extract return
1489     ;;; values. So we advice di::handle-breakpoint and bind the values to
1490     ;;; special variables.
1491     ;;;
1492     (defvar *breakpoint-sigcontext*)
1493     (defvar *breakpoint-pc*)
1494    
1495     (defun sigcontext-object (sc index)
1496     "Extract the lisp object in sigcontext SC at offset INDEX."
1497     (kernel:make-lisp-obj (vm:ucontext-register sc index)))
1498    
1499     (defun known-return-point-values (sigcontext sc-offsets)
1500     (let ((fp (system:int-sap (vm:ucontext-register sigcontext
1501     vm::cfp-offset))))
1502     (system:without-gcing
1503     (loop for sc-offset across sc-offsets
1504     collect (di::sub-access-debug-var-slot fp sc-offset sigcontext)))))
1505    
1506     ;;; SCL returns the first few values in registers and the rest on
1507     ;;; the stack. In the multiple value case, the number of values is
1508     ;;; stored in a dedicated register. The values of the registers can be
1509     ;;; accessed in the sigcontext for the breakpoint. There are 3 kinds
1510     ;;; of return conventions: :single-value-return, :unknown-return, and
1511     ;;; :known-return.
1512     ;;;
1513     ;;; The :single-value-return convention returns the value in a
1514     ;;; register without setting the nargs registers.
1515     ;;;
1516     ;;; The :unknown-return variant is used for multiple values. A
1517     ;;; :unknown-return point consists actually of 2 breakpoints: one for
1518     ;;; the single value case and one for the general case. The single
1519     ;;; value breakpoint comes vm:single-value-return-byte-offset after
1520     ;;; the multiple value breakpoint.
1521     ;;;
1522     ;;; The :known-return convention is used by local functions.
1523     ;;; :known-return is currently not supported because we don't know
1524     ;;; where the values are passed.
1525     ;;;
1526     (defun breakpoint-values (breakpoint)
1527     "Return the list of return values for a return point."
1528     (flet ((1st (sc) (sigcontext-object sc (car vm::register-arg-offsets))))
1529     (let ((sc (locally (declare (optimize (ext:inhibit-warnings 3)))
1530     (alien:sap-alien *breakpoint-sigcontext* (* unix:ucontext))))
1531     (cl (di:breakpoint-what breakpoint)))
1532     (ecase (di:code-location-kind cl)
1533     (:single-value-return
1534     (list (1st sc)))
1535     (:known-return
1536     (let ((info (di:breakpoint-info breakpoint)))
1537     (if (vectorp info)
1538     (known-return-point-values sc info)
1539     (progn
1540     ;;(break)
1541     (list "<<known-return convention not supported>>" info)))))
1542     (:unknown-return
1543     (let ((mv-return-pc (di::compiled-code-location-pc cl)))
1544     (if (= mv-return-pc *breakpoint-pc*)
1545     (mv-function-end-breakpoint-values sc)
1546     (list (1st sc)))))))))
1547    
1548     (defun mv-function-end-breakpoint-values (sigcontext)
1549 dcrosher 1.4 (let ((sym (find-symbol (symbol-name '#:function-end-breakpoint-values/standard)
1550     :debug-internals)))
1551 dcrosher 1.1 (cond (sym (funcall sym sigcontext))
1552     (t (di::get-function-end-breakpoint-values sigcontext)))))
1553    
1554     (defun debug-function-returns (debug-fun)
1555     "Return the return style of DEBUG-FUN."
1556     (let* ((cdfun (di::compiled-debug-function-compiler-debug-fun debug-fun)))
1557     (c::compiled-debug-function-returns cdfun)))
1558    
1559     (define-condition breakpoint (simple-condition)
1560     ((message :initarg :message :reader breakpoint.message)
1561     (values :initarg :values :reader breakpoint.values))
1562     (:report (lambda (c stream) (princ (breakpoint.message c) stream))))
1563    
1564 heller 1.10 #+nil
1565 dcrosher 1.1 (defimplementation condition-extras ((c breakpoint))
1566     ;; simply pop up the source buffer
1567     `((:short-frame-source 0)))
1568    
1569     (defun signal-breakpoint (breakpoint frame)
1570     "Signal a breakpoint condition for BREAKPOINT in FRAME.
1571     Try to create a informative message."
1572     (flet ((brk (values fstring &rest args)
1573     (let ((msg (apply #'format nil fstring args))
1574     (debug:*stack-top-hint* frame))
1575     (break 'breakpoint :message msg :values values))))
1576     (with-struct (di::breakpoint- kind what) breakpoint
1577     (case kind
1578     (:code-location
1579     (case (di:code-location-kind what)
1580     ((:single-value-return :known-return :unknown-return)
1581     (let ((values (breakpoint-values breakpoint)))
1582     (brk values "Return value: ~{~S ~}" values)))
1583     (t
1584     #+(or)
1585     (when (eq (di:code-location-kind what) :call-site)
1586     (call-site-function breakpoint frame))
1587     (brk nil "Breakpoint: ~S ~S"
1588     (di:code-location-kind what)
1589     (di::compiled-code-location-pc what)))))
1590     (:function-start
1591     (brk nil "Function start breakpoint"))
1592     (t (brk nil "Breakpoint: ~A in ~A" breakpoint frame))))))
1593    
1594     #+nil
1595     (defimplementation sldb-break-at-start (fname)
1596     (let ((debug-fun (di:function-debug-function (coerce fname 'function))))
1597     (cond ((not debug-fun)
1598     `(:error ,(format nil "~S has no debug-function" fname)))
1599     (t
1600     (flet ((hook (frame bp &optional args cookie)
1601     (declare (ignore args cookie))
1602     (signal-breakpoint bp frame)))
1603     (let ((bp (di:make-breakpoint #'hook debug-fun
1604     :kind :function-start)))
1605     (di:activate-breakpoint bp)
1606     `(:ok ,(format nil "Set breakpoint in ~S" fname))))))))
1607    
1608     (defun frame-cfp (frame)
1609     "Return the Control-Stack-Frame-Pointer for FRAME."
1610     (etypecase frame
1611     (di::compiled-frame (di::frame-pointer frame))
1612     ((or di::interpreted-frame null) -1)))
1613    
1614     (defun frame-ip (frame)
1615     "Return the (absolute) instruction pointer and the relative pc of FRAME."
1616     (if (not frame)
1617     -1
1618     (let ((debug-fun (di::frame-debug-function frame)))
1619     (etypecase debug-fun
1620     (di::compiled-debug-function
1621     (let* ((code-loc (di:frame-code-location frame))
1622     (component (di::compiled-debug-function-component debug-fun))
1623     (pc (di::compiled-code-location-pc code-loc))
1624     (ip (sys:without-gcing
1625     (sys:sap-int
1626     (sys:sap+ (kernel:code-instructions component) pc)))))
1627     (values ip pc)))
1628     ((or di::bogus-debug-function di::interpreted-debug-function)
1629     -1)))))
1630    
1631     (defun frame-registers (frame)
1632     "Return the lisp registers CSP, CFP, IP, OCFP, LRA for FRAME-NUMBER."
1633     (let* ((cfp (frame-cfp frame))
1634     (csp (frame-cfp (di::frame-up frame)))
1635     (ip (frame-ip frame))
1636     (ocfp (frame-cfp (di::frame-down frame)))
1637     (lra (frame-ip (di::frame-down frame))))
1638     (values csp cfp ip ocfp lra)))
1639    
1640     (defun print-frame-registers (frame-number)
1641     (let ((frame (di::frame-real-frame (nth-frame frame-number))))
1642     (flet ((fixnum (p) (etypecase p
1643     (integer p)
1644     (sys:system-area-pointer (sys:sap-int p)))))
1645     (apply #'format t "~
1646     CSP = ~X
1647     CFP = ~X
1648     IP = ~X
1649     OCFP = ~X
1650     LRA = ~X~%" (mapcar #'fixnum
1651     (multiple-value-list (frame-registers frame)))))))
1652    
1653    
1654     (defimplementation disassemble-frame (frame-number)
1655     "Return a string with the disassembly of frames code."
1656     (print-frame-registers frame-number)
1657     (terpri)
1658     (let* ((frame (di::frame-real-frame (nth-frame frame-number)))
1659     (debug-fun (di::frame-debug-function frame)))
1660     (etypecase debug-fun
1661     (di::compiled-debug-function
1662     (let* ((component (di::compiled-debug-function-component debug-fun))
1663     (fun (di:debug-function-function debug-fun)))
1664     (if fun
1665     (disassemble fun)
1666     (disassem:disassemble-code-component component))))
1667     (di::bogus-debug-function
1668     (format t "~%[Disassembling bogus frames not implemented]")))))
1669    
1670    
1671     ;;;; Inspecting
1672    
1673     (defconstant +lowtag-symbols+
1674     '(vm:even-fixnum-type
1675     vm:instance-pointer-type
1676     vm:other-immediate-0-type
1677     vm:list-pointer-type
1678     vm:odd-fixnum-type
1679     vm:function-pointer-type
1680     vm:other-immediate-1-type
1681     vm:other-pointer-type)
1682     "Names of the constants that specify type tags.
1683     The `symbol-value' of each element is a type tag.")
1684    
1685     (defconstant +header-type-symbols+
1686     (labels ((suffixp (suffix string)
1687     (and (>= (length string) (length suffix))
1688     (string= string suffix :start1 (- (length string)
1689     (length suffix)))))
1690     (header-type-symbol-p (x)
1691     (and (suffixp (symbol-name '#:-type) (symbol-name x))
1692     (not (member x +lowtag-symbols+))
1693     (boundp x)
1694     (typep (symbol-value x) 'fixnum))))
1695     (remove-if-not #'header-type-symbol-p
1696     (append (apropos-list (symbol-name '#:-type) :vm)
1697     (apropos-list (symbol-name '#:-type) :bignum))))
1698     "A list of names of the type codes in boxed objects.")
1699    
1700     (defimplementation describe-primitive-type (object)
1701     (with-output-to-string (*standard-output*)
1702     (let* ((lowtag (kernel:get-lowtag object))
1703     (lowtag-symbol (find lowtag +lowtag-symbols+ :key #'symbol-value)))
1704     (format t "lowtag: ~A" lowtag-symbol)
1705     (when (member lowtag (list vm:other-pointer-type
1706     vm:function-pointer-type
1707     vm:other-immediate-0-type
1708     vm:other-immediate-1-type
1709     ))
1710     (let* ((type (kernel:get-type object))
1711     (type-symbol (find type +header-type-symbols+
1712     :key #'symbol-value)))
1713     (format t ", type: ~A" type-symbol))))))
1714    
1715 heller 1.16 (defmethod emacs-inspect ((o t))
1716 dcrosher 1.1 (cond ((di::indirect-value-cell-p o)
1717 heller 1.17 `("Value: " (:value ,(c:value-cell-ref o))))
1718 dcrosher 1.1 ((alien::alien-value-p o)
1719     (inspect-alien-value o))
1720     (t
1721     (scl-inspect o))))
1722    
1723     (defun scl-inspect (o)
1724 dcrosher 1.4 (destructuring-bind (text labeledp . parts)
1725     (inspect::describe-parts o)
1726 heller 1.17 (list* (format nil "~A~%" text)
1727 dcrosher 1.1 (if labeledp
1728     (loop for (label . value) in parts
1729     append (label-value-line label value))
1730     (loop for value in parts for i from 0
1731     append (label-value-line i value))))))
1732    
1733 heller 1.16 (defmethod emacs-inspect ((o function))
1734 dcrosher 1.1 (let ((header (kernel:get-type o)))
1735     (cond ((= header vm:function-header-type)
1736 heller 1.17 (list* (format nil "~A is a function.~%" o)
1737 dcrosher 1.1 (append (label-value-line*
1738     ("Self" (kernel:%function-self o))
1739     ("Next" (kernel:%function-next o))
1740     ("Name" (kernel:%function-name o))
1741     ("Arglist" (kernel:%function-arglist o))
1742     ("Type" (kernel:%function-type o))
1743     ("Code" (kernel:function-code-header o)))
1744     (list
1745     (with-output-to-string (s)
1746     (disassem:disassemble-function o :stream s))))))
1747     ((= header vm:closure-header-type)
1748 heller 1.17 (list* (format nil "~A is a closure.~%" o)
1749 dcrosher 1.1 (append
1750     (label-value-line "Function" (kernel:%closure-function o))
1751     `("Environment:" (:newline))
1752 dcrosher 1.7 (loop for i from 0 below (- (kernel:get-closure-length o)
1753     (1- vm:closure-info-offset))
1754 dcrosher 1.1 append (label-value-line
1755     i (kernel:%closure-index-ref o i))))))
1756     ((eval::interpreted-function-p o)
1757     (scl-inspect o))
1758     (t
1759     (call-next-method)))))
1760    
1761    
1762 heller 1.16 (defmethod emacs-inspect ((o kernel:code-component))
1763 dcrosher 1.1 (append
1764     (label-value-line*
1765     ("code-size" (kernel:%code-code-size o))
1766     ("entry-points" (kernel:%code-entry-points o))
1767     ("debug-info" (kernel:%code-debug-info o))
1768     ("trace-table-offset" (kernel:code-header-ref
1769     o vm:code-trace-table-offset-slot)))
1770     `("Constants:" (:newline))
1771     (loop for i from vm:code-constants-offset
1772     below (kernel:get-header-data o)
1773     append (label-value-line i (kernel:code-header-ref o i)))
1774     `("Code:" (:newline)
1775     , (with-output-to-string (s)
1776     (cond ((kernel:%code-debug-info o)
1777     (disassem:disassemble-code-component o :stream s))
1778     (t
1779     (disassem:disassemble-memory
1780     (disassem::align
1781     (+ (logandc2 (kernel:get-lisp-obj-address o)
1782     vm:lowtag-mask)
1783     (* vm:code-constants-offset vm:word-bytes))
1784     (ash 1 vm:lowtag-bits))
1785     (ash (kernel:%code-code-size o) vm:word-shift)
1786 heller 1.17 :stream s)))))))
1787 dcrosher 1.1
1788 heller 1.16 (defmethod emacs-inspect ((o kernel:fdefn))
1789 heller 1.17 (label-value-line*
1790 dcrosher 1.1 ("name" (kernel:fdefn-name o))
1791     ("function" (kernel:fdefn-function o))
1792     ("raw-addr" (sys:sap-ref-32
1793     (sys:int-sap (kernel:get-lisp-obj-address o))
1794 heller 1.17 (* vm:fdefn-raw-addr-slot vm:word-bytes)))))
1795 dcrosher 1.1
1796 heller 1.16 (defmethod emacs-inspect ((o array))
1797 dcrosher 1.4 (cond ((kernel:array-header-p o)
1798 heller 1.17 (list* (format nil "~A is an array.~%" o)
1799 dcrosher 1.4 (label-value-line*
1800     (:header (describe-primitive-type o))
1801     (:rank (array-rank o))
1802     (:fill-pointer (kernel:%array-fill-pointer o))
1803     (:fill-pointer-p (kernel:%array-fill-pointer-p o))
1804     (:elements (kernel:%array-available-elements o))
1805     (:data (kernel:%array-data-vector o))
1806     (:displacement (kernel:%array-displacement o))
1807     (:displaced-p (kernel:%array-displaced-p o))
1808     (:dimensions (array-dimensions o)))))
1809     (t
1810 heller 1.17 (list* (format nil "~A is an simple-array.~%" o)
1811 dcrosher 1.4 (label-value-line*
1812     (:header (describe-primitive-type o))
1813     (:length (length o)))))))
1814 dcrosher 1.1
1815 heller 1.16 (defmethod emacs-inspect ((o simple-vector))
1816 heller 1.17 (list* (format nil "~A is a vector.~%" o)
1817 dcrosher 1.1 (append
1818     (label-value-line*
1819     (:header (describe-primitive-type o))
1820     (:length (c::vector-length o)))
1821     (unless (eq (array-element-type o) 'nil)
1822     (loop for i below (length o)
1823     append (label-value-line i (aref o i)))))))
1824    
1825     (defun inspect-alien-record (alien)
1826     (with-struct (alien::alien-value- sap type) alien
1827     (with-struct (alien::alien-record-type- kind name fields) type
1828     (append
1829     (label-value-line*
1830     (:sap sap)
1831     (:kind kind)
1832     (:name name))
1833     (loop for field in fields
1834     append (let ((slot (alien::alien-record-field-name field)))
1835 heller 1.17 (label-value-line slot (alien:slot alien slot))))))))
1836 dcrosher 1.1
1837     (defun inspect-alien-pointer (alien)
1838 heller 1.17 (with-struct (alien::alien-value- sap type) alien
1839 dcrosher 1.1 (label-value-line*
1840     (:sap sap)
1841     (:type type)
1842 heller 1.17 (:to (alien::deref alien)))))
1843 dcrosher 1.1
1844     (defun inspect-alien-value (alien)
1845     (typecase (alien::alien-value-type alien)
1846     (alien::alien-record-type (inspect-alien-record alien))
1847     (alien::alien-pointer-type (inspect-alien-pointer alien))
1848     (t (scl-inspect alien))))
1849    
1850     ;;;; Profiling
1851     (defimplementation profile (fname)
1852     (eval `(profile:profile ,fname)))
1853    
1854     (defimplementation unprofile (fname)
1855     (eval `(profile:unprofile ,fname)))
1856    
1857     (defimplementation unprofile-all ()
1858     (eval `(profile:unprofile))
1859     "All functions unprofiled.")
1860    
1861     (defimplementation profile-report ()
1862     (eval `(profile:report-time)))
1863    
1864     (defimplementation profile-reset ()
1865     (eval `(profile:reset-time))
1866     "Reset profiling counters.")
1867    
1868     (defimplementation profiled-functions ()
1869     profile:*timed-functions*)
1870    
1871     (defimplementation profile-package (package callers methods)
1872     (profile:profile-all :package package
1873     :callers-p callers
1874     #+nil :methods #+nil methods))
1875    
1876    
1877     ;;;; Multiprocessing
1878    
1879 dcrosher 1.11 (defimplementation spawn (fn &key name)
1880     (thread:thread-create fn :name (or name "Anonymous")))
1881 dcrosher 1.1
1882     (defvar *thread-id-counter* 0)
1883     (defvar *thread-id-counter-lock* (thread:make-lock "Thread ID counter"))
1884    
1885     (defimplementation thread-id (thread)
1886     (thread:with-lock-held (*thread-id-counter-lock*)
1887     (or (getf (thread:thread-plist thread) 'id)
1888     (setf (getf (thread:thread-plist thread) 'id)
1889     (incf *thread-id-counter*)))))
1890    
1891     (defimplementation find-thread (id)
1892 heller 1.10 (block find-thread
1893     (thread:map-over-threads
1894     #'(lambda (thread)
1895     (when (eql (getf (thread:thread-plist thread) 'id) id)
1896     (return-from find-thread thread))))))
1897 dcrosher 1.1
1898     (defimplementation thread-name (thread)
1899     (princ-to-string (thread:thread-name thread)))
1900    
1901     (defimplementation thread-status (thread)
1902     (let ((dynamic-values (thread::thread-dynamic-values thread)))
1903     (if (zerop dynamic-values) "Exited" "Running")))
1904    
1905     (defimplementation make-lock (&key name)
1906     (thread:make-lock name))
1907    
1908     (defimplementation call-with-lock-held (lock function)
1909     (declare (type function function))
1910     (thread:with-lock-held (lock) (funcall function)))
1911    
1912     (defimplementation current-thread ()
1913     thread:*thread*)
1914    
1915     (defimplementation all-threads ()
1916     (let ((all-threads nil))
1917     (thread:map-over-threads #'(lambda (thread) (push thread all-threads)))
1918     all-threads))
1919    
1920     (defimplementation interrupt-thread (thread fn)
1921     (thread:thread-interrupt thread #'(lambda ()
1922     (sys:with-interrupts
1923     (funcall fn)))))
1924    
1925     (defimplementation kill-thread (thread)
1926     (thread:destroy-thread thread))
1927    
1928     (defimplementation thread-alive-p (thread)
1929     (not (zerop (thread::thread-dynamic-values thread))))
1930    
1931 dcrosher 1.26 (defvar *mailbox-lock* (thread:make-lock "Mailbox lock" :interruptible nil))
1932 dcrosher 1.1
1933     (defstruct (mailbox)
1934 dcrosher 1.7 (lock (thread:make-lock "Thread mailbox" :type :error-check
1935     :interruptible nil)
1936 dcrosher 1.1 :type thread:error-check-lock)
1937     (queue '() :type list))
1938    
1939     (defun mailbox (thread)
1940     "Return 'thread's mailbox."
1941 dcrosher 1.26 (sys:without-interrupts
1942     (thread:with-lock-held (*mailbox-lock*)
1943     (or (getf (thread:thread-plist thread) 'mailbox)
1944     (setf (getf (thread:thread-plist thread) 'mailbox) (make-mailbox))))))
1945 dcrosher 1.1
1946     (defimplementation send (thread message)
1947     (let* ((mbox (mailbox thread))
1948 dcrosher 1.7 (lock (mailbox-lock mbox)))
1949 dcrosher 1.26 (sys:without-interrupts
1950     (thread:with-lock-held (lock "Mailbox Send")
1951     (setf (mailbox-queue mbox) (nconc (mailbox-queue mbox)
1952     (list message)))))
1953 heller 1.21 (mp:process-wakeup thread)))
1954    
1955 dcrosher 1.26 #+nil
1956 dcrosher 1.1 (defimplementation receive ()
1957 heller 1.21 (receive-if (constantly t)))
1958 dcrosher 1.1
1959 dcrosher 1.26 (defimplementation receive-if (test &optional timeout)
1960 heller 1.20 (let ((mbox (mailbox thread:*thread*)))
1961 dcrosher 1.26 (assert (or (not timeout) (eq timeout t)))
1962 heller 1.20 (loop
1963 heller 1.21 (check-slime-interrupts)
1964 dcrosher 1.26 (sys:without-interrupts
1965     (mp:with-lock-held ((mailbox-lock mbox))
1966     (let* ((q (mailbox-queue mbox))
1967     (tail (member-if test q)))
1968     (when tail
1969     (setf (mailbox-queue mbox)
1970     (nconc (ldiff q tail) (cdr tail)))
1971     (return (car tail))))))
1972     (when (eq timeout t) (return (values nil t)))
1973 heller 1.21 (mp:process-wait-with-timeout
1974     "Mailbox read wait" 0.5 (lambda () (some test (mailbox-queue mbox)))))))
1975 heller 1.20
1976 dcrosher 1.1
1977    
1978     (defimplementation emacs-connected ())
1979    
1980    
1981     ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1982     ;;Trace implementations
1983     ;; In SCL, we have:
1984     ;; (trace <name>)
1985     ;; (trace (method <name> <qualifier>? (<specializer>+)))
1986     ;; (trace :methods t '<name>) ;;to trace all methods of the gf <name>
1987     ;; <name> can be a normal name or a (setf name)
1988    
1989     (defun tracedp (spec)
1990     (member spec (eval '(trace)) :test #'equal))
1991    
1992     (defun toggle-trace-aux (spec &rest options)
1993     (cond ((tracedp spec)
1994     (eval `(untrace ,spec))
1995     (format nil "~S is now untraced." spec))
1996     (t
1997     (eval `(trace ,spec ,@options))
1998     (format nil "~S is now traced." spec))))
1999    
2000     (defimplementation toggle-trace (spec)
2001     (ecase (car spec)
2002     ((setf)
2003     (toggle-trace-aux spec))
2004     ((:defgeneric)
2005     (let ((name (second spec)))
2006     (toggle-trace-aux name :methods name)))
2007     ((:defmethod)
2008     nil)
2009     ((:call)
2010     (destructuring-bind (caller callee) (cdr spec)
2011     (toggle-trace-aux (process-fspec callee)
2012     :wherein (list (process-fspec caller)))))))
2013    
2014     (defun process-fspec (fspec)
2015     (cond ((consp fspec)
2016     (ecase (first fspec)
2017     ((:defun :defgeneric) (second fspec))
2018     ((:defmethod)
2019     `(method ,(second fspec) ,@(third fspec) ,(fourth fspec)))
2020     ;; this isn't actually supported
2021     ((:labels) `(labels ,(process-fspec (second fspec)) ,(third fspec)))
2022     ((:flet) `(flet ,(process-fspec (second fspec)) ,(third fspec)))))
2023     (t
2024     fspec)))
2025    
2026     ;;; Weak datastructures
2027    
2028     ;;; Not implemented in SCL.
2029     (defimplementation make-weak-key-hash-table (&rest args)
2030     (apply #'make-hash-table :weak-p t args))

  ViewVC Help
Powered by ViewVC 1.1.5