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

Contents of /slime/swank-corman.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (hide annotations)
Tue Jul 5 20:30:59 2005 UTC (8 years, 9 months ago) by heller
Branch: MAIN
Changes since 1.3: +25 -11 lines
(swank-compile-file): New optional argument `external-format'.
1 ewiborg 1.2 ;;;
2     ;;; swank-corman.lisp --- Corman Lisp specific code for SLIME.
3     ;;;
4     ;;; Copyright (C) 2004, 2005 Espen Wiborg (espenhw@grumblesmurf.org)
5     ;;;
6     ;;; License
7     ;;; =======
8     ;;; This software is provided 'as-is', without any express or implied
9     ;;; warranty. In no event will the author be held liable for any damages
10     ;;; arising from the use of this software.
11     ;;;
12     ;;; Permission is granted to anyone to use this software for any purpose,
13     ;;; including commercial applications, and to alter it and redistribute
14     ;;; it freely, subject to the following restrictions:
15     ;;;
16     ;;; 1. The origin of this software must not be misrepresented; you must
17     ;;; not claim that you wrote the original software. If you use this
18     ;;; software in a product, an acknowledgment in the product documentation
19     ;;; would be appreciated but is not required.
20     ;;;
21     ;;; 2. Altered source versions must be plainly marked as such, and must
22     ;;; not be misrepresented as being the original software.
23     ;;;
24     ;;; 3. This notice may not be removed or altered from any source
25     ;;; distribution.
26     ;;;
27     ;;; Notes
28     ;;; =====
29     ;;; You will need CCL 2.51, and you will *definitely* need to patch
30     ;;; CCL with the patches at
31     ;;; http://www.grumblesmurf.org/lisp/corman-patches, otherwise SLIME
32     ;;; will blow up in your face. You should also follow the
33     ;;; instructions on http://www.grumblesmurf.org/lisp/corman-slime.
34     ;;;
35     ;;; The only communication style currently supported is NIL.
36     ;;;
37     ;;; Starting CCL inside emacs (with M-x slime) seems to work for me
38     ;;; with Corman Lisp 2.51, but I have seen random failures with 2.5
39     ;;; (sometimes it works, other times it hangs on start or hangs when
40     ;;; initializing WinSock) - starting CCL externally and using M-x
41     ;;; slime-connect always works fine.
42     ;;;
43     ;;; Sometimes CCL gets confused and starts giving you random memory
44     ;;; access violation errors on startup; if this happens, try redumping
45     ;;; your image.
46     ;;;
47     ;;; What works
48     ;;; ==========
49     ;;; * Basic editing and evaluation
50     ;;; * Arglist display
51     ;;; * Compilation
52     ;;; * Loading files
53     ;;; * apropos/describe
54     ;;; * Debugger
55     ;;; * Inspector
56     ;;;
57     ;;; TODO
58     ;;; ====
59     ;;; * More debugger functionality (missing bits: restart-frame,
60     ;;; return-from-frame, disassemble-frame, activate-stepping,
61     ;;; toggle-trace)
62     ;;; * XREF
63     ;;; * Profiling
64     ;;; * More sophisticated communication styles than NIL
65     ;;;
66    
67     (in-package :swank-backend)
68    
69     ;;; Pull in various needed bits
70     (require :composite-streams)
71     (require :sockets)
72     (require :winbase)
73     (require :lp)
74    
75     (use-package :gs)
76    
77     ;; MOP stuff
78    
79     (defclass swank-mop:standard-slot-definition ()
80     ()
81     (:documentation "Dummy class created so that swank.lisp will compile and load."))
82    
83     (defun named-by-gensym-p (c)
84     (null (symbol-package (class-name c))))
85    
86     (deftype swank-mop:eql-specializer ()
87     '(satisfies named-by-gensym-p))
88    
89     (defun swank-mop:eql-specializer-object (specializer)
90     (with-hash-table-iterator (next-entry cl::*clos-singleton-specializers*)
91     (loop (multiple-value-bind (more key value)
92     (next-entry)
93     (unless more (return nil))
94     (when (eq specializer value)
95     (return key))))))
96    
97     (defun swank-mop:class-finalized-p (class)
98     (declare (ignore class))
99     t)
100    
101     (defun swank-mop:class-prototype (class)
102     (make-instance class))
103    
104     (defun swank-mop:specializer-direct-methods (obj)
105     (declare (ignore obj))
106     nil)
107    
108     (defun swank-mop:generic-function-argument-precedence-order (gf)
109     (generic-function-lambda-list gf))
110    
111     (defun swank-mop:generic-function-method-combination (gf)
112     (declare (ignore gf))
113     :standard)
114    
115     (defun swank-mop:generic-function-declarations (gf)
116     (declare (ignore gf))
117     nil)
118    
119     (defun swank-mop:slot-definition-documentation (slot)
120     (declare (ignore slot))
121     (getf slot :documentation nil))
122    
123     (defun swank-mop:slot-definition-type (slot)
124     (declare (ignore slot))
125     t)
126    
127     (import-swank-mop-symbols :cl '(;; classes
128     :standard-slot-definition
129     :eql-specializer
130     :eql-specializer-object
131     ;; standard class readers
132     :class-default-initargs
133     :class-direct-default-initargs
134     :class-finalized-p
135     :class-prototype
136     :specializer-direct-methods
137     ;; gf readers
138     :generic-function-argument-precedence-order
139     :generic-function-declarations
140     :generic-function-method-combination
141     ;; method readers
142     ;; slot readers
143     :slot-definition-documentation
144     :slot-definition-type))
145    
146     ;;;; swank implementations
147    
148     ;;; Debugger
149    
150     (defvar *stack-trace* nil)
151     (defvar *frame-trace* nil)
152    
153     (defstruct frame
154     name function address debug-info variables)
155    
156     (defimplementation call-with-debugging-environment (fn)
157     (let* ((real-stack-trace (cl::stack-trace))
158     (*stack-trace* (cdr (member 'cl:invoke-debugger real-stack-trace
159     :key #'car)))
160     (*frame-trace*
161 heller 1.4 (let* ((db::*debug-level* (1+ db::*debug-level*))
162 ewiborg 1.2 (db::*debug-frame-pointer* (db::stash-ebp
163     (ct:create-foreign-ptr)))
164     (db::*debug-max-level* (length real-stack-trace))
165     (db::*debug-min-level* 1))
166     (cdr (member #'cl:invoke-debugger
167     (cons
168     (make-frame :function nil)
169     (loop for i from db::*debug-min-level*
170     upto db::*debug-max-level*
171     until (eq (db::get-frame-function i) cl::*top-level*)
172     collect
173     (make-frame :function (db::get-frame-function i)
174     :address (db::get-frame-address i))))
175     :key #'frame-function)))))
176     (funcall fn)))
177    
178     (defimplementation compute-backtrace (start end)
179     (subseq *stack-trace* start (min end (length *stack-trace*))))
180    
181     (defimplementation print-frame (frame stream)
182     (format stream "~S" frame))
183    
184     (defun get-frame-debug-info (frame)
185 heller 1.3 (or (frame-debug-info frame)
186     (setf (frame-debug-info frame)
187     (db::prepare-frame-debug-info (frame-function frame)
188     (frame-address frame)))))
189 ewiborg 1.2
190     (defimplementation frame-locals (frame-number)
191     (let* ((frame (elt *frame-trace* frame-number))
192     (info (get-frame-debug-info frame)))
193     (let ((var-list
194     (loop for i from 4 below (length info) by 2
195     collect `(list :name ',(svref info i) :id 0
196     :value (db::debug-filter ,(svref info i))))))
197     (let ((vars (eval-in-frame `(list ,@var-list) frame-number)))
198     (setf (frame-variables frame) vars)))))
199    
200     (defimplementation eval-in-frame (form frame-number)
201     (let ((frame (elt *frame-trace* frame-number)))
202     (let ((cl::*compiler-environment* (get-frame-debug-info frame)))
203     (eval form))))
204    
205     (defimplementation frame-catch-tags (index)
206     (declare (ignore index))
207     nil)
208    
209     (defimplementation frame-var-value (frame-number var)
210     (let ((vars (frame-variables (elt *frame-trace* frame-number))))
211     (when vars
212     (second (elt vars var)))))
213    
214     (defimplementation frame-source-location-for-emacs (frame-number)
215     (fspec-location (frame-function (elt *frame-trace* frame-number))))
216    
217 heller 1.4 (defun break (&optional (format-control "Break") &rest format-arguments)
218     (with-simple-restart (continue "Return from BREAK.")
219     (let ();(*debugger-hook* nil))
220     (let ((condition
221     (make-condition 'simple-condition
222     :format-control format-control
223     :format-arguments format-arguments)))
224     ;;(format *debug-io* ";;; User break: ~A~%" condition)
225     (invoke-debugger condition))))
226     nil)
227    
228 ewiborg 1.2 ;;; Socket communication
229    
230     (defimplementation create-socket (host port)
231     (sockets:start-sockets)
232     (sockets:make-server-socket :host host :port port))
233    
234     (defimplementation local-port (socket)
235     (sockets:socket-port socket))
236    
237     (defimplementation close-socket (socket)
238     (close socket))
239    
240     (defimplementation accept-connection (socket
241     &key (external-format :iso-latin-1-unix))
242     (ecase external-format
243     (:iso-latin-1-unix
244     (sockets:make-socket-stream (sockets:accept-socket socket)))))
245    
246     ;;; Misc
247    
248     (defimplementation preferred-communication-style ()
249     nil)
250    
251     (defimplementation getpid ()
252     ccl:*current-process-id*)
253    
254     (defimplementation lisp-implementation-type-name ()
255     "cormanlisp")
256    
257     (defimplementation quit-lisp ()
258     (sockets:stop-sockets)
259     (win32:exitprocess 0))
260    
261     (defimplementation set-default-directory (directory)
262     (setf (ccl:current-directory) directory)
263     (directory-namestring (setf *default-pathname-defaults*
264     (truename (merge-pathnames directory)))))
265    
266     (defimplementation default-directory ()
267 heller 1.3 (directory-namestring (ccl:current-directory)))
268 ewiborg 1.2
269     (defimplementation macroexpand-all (form)
270     (ccl:macroexpand-all form))
271    
272     ;;; Documentation
273    
274     (defun fspec-location (fspec)
275     (when (symbolp fspec)
276     (setq fspec (symbol-function fspec)))
277     (let ((file (ccl::function-source-file fspec)))
278     (if file
279     (handler-case
280     (let ((truename (truename
281     (merge-pathnames file
282     ccl:*cormanlisp-directory*))))
283     (make-location (list :file (namestring truename))
284     (if (ccl::function-source-line fspec)
285 heller 1.3 (list :line
286     (1+ (ccl::function-source-line fspec)))
287 ewiborg 1.2 (list :function-name (princ-to-string
288     (function-name fspec))))))
289     (error (c) (list :error (princ-to-string c))))
290     (list :error (format nil "No source information available for ~S"
291     fspec)))))
292    
293     (defimplementation find-definitions (name)
294     (list (list name (fspec-location name))))
295    
296     (defimplementation arglist (name)
297     (handler-case
298     (cond ((and (symbolp name)
299     (macro-function name))
300     (ccl::macro-lambda-list (symbol-function name)))
301     (t
302     (when (symbolp name)
303     (setq name (symbol-function name)))
304     (if (eq (class-of name) cl::the-class-standard-gf)
305     (generic-function-lambda-list name)
306     (ccl:function-lambda-list name))))
307     (error () :not-available)))
308    
309     (defimplementation function-name (fn)
310     (handler-case (getf (cl::function-info-list fn) 'cl::function-name)
311     (error () nil)))
312    
313     (defimplementation describe-symbol-for-emacs (symbol)
314     (let ((result '()))
315     (flet ((doc (kind &optional (sym symbol))
316     (or (documentation sym kind) :not-documented))
317     (maybe-push (property value)
318     (when value
319     (setf result (list* property value result)))))
320     (maybe-push
321     :variable (when (boundp symbol)
322     (doc 'variable)))
323     (maybe-push
324     :function (if (fboundp symbol)
325     (doc 'function)))
326     (maybe-push
327     :class (if (find-class symbol nil)
328     (doc 'class)))
329     result)))
330    
331     (defimplementation describe-definition (symbol namespace)
332     (ecase namespace
333     (:variable
334     (describe symbol))
335     ((:function :generic-function)
336     (describe (symbol-function symbol)))
337     (:class
338     (describe (find-class symbol)))))
339    
340     ;;; Compiler
341    
342     (defvar *buffer-name* nil)
343     (defvar *buffer-position*)
344     (defvar *buffer-string*)
345     (defvar *compile-filename* nil)
346    
347     ;; FIXME
348     (defimplementation call-with-compilation-hooks (FN)
349     (handler-bind ((error (lambda (c)
350     (signal (make-condition
351     'compiler-condition
352     :original-condition c
353     :severity :warning
354     :message (format nil "~A" c)
355     :location
356     (cond (*buffer-name*
357     (make-location
358     (list :buffer *buffer-name*)
359     (list :position *buffer-position*)))
360     (*compile-filename*
361     (make-location
362     (list :file *compile-filename*)
363     (list :position 1)))
364     (t
365     (list :error "No location"))))))))
366     (funcall fn)))
367    
368 heller 1.4 (defimplementation swank-compile-file (*compile-filename* load-p
369     &optional external-format)
370     (declare (ignore external-format))
371 ewiborg 1.2 (with-compilation-hooks ()
372     (let ((*buffer-name* nil))
373     (compile-file *compile-filename*)
374     (when load-p
375     (load (compile-file-pathname *compile-filename*))))))
376    
377     (defimplementation swank-compile-string (string &key buffer position directory)
378     (declare (ignore directory))
379     (with-compilation-hooks ()
380     (let ((*buffer-name* buffer)
381     (*buffer-position* position)
382     (*buffer-string* string))
383     (funcall (compile nil (read-from-string
384     (format nil "(~S () ~A)" 'lambda string)))))))
385    
386     ;;;; Inspecting
387    
388     (defclass corman-inspector (inspector)
389     ())
390    
391     (defimplementation make-default-inspector ()
392     (make-instance 'corman-inspector))
393    
394     (defun comma-separated (list &optional (callback (lambda (v)
395     `(:value ,v))))
396     (butlast (loop for e in list
397     collect (funcall callback e)
398     collect ", ")))
399    
400     (defimplementation inspect-for-emacs ((class standard-class)
401     (inspector corman-inspector))
402     (declare (ignore inspector))
403     (values "A class."
404     `("Name: " (:value ,(class-name class))
405     (:newline)
406     "Super classes: "
407     ,@(comma-separated (swank-mop:class-direct-superclasses class))
408     (:newline)
409     "Direct Slots: "
410     ,@(comma-separated
411     (swank-mop:class-direct-slots class)
412     (lambda (slot)
413     `(:value ,slot ,(princ-to-string (swank-mop:slot-definition-name slot)))))
414     (:newline)
415     "Effective Slots: "
416     ,@(if (swank-mop:class-finalized-p class)
417     (comma-separated
418     (swank-mop:class-slots class)
419     (lambda (slot)
420     `(:value ,slot ,(princ-to-string
421     (swank-mop:slot-definition-name slot)))))
422     '("#<N/A (class not finalized)>"))
423     (:newline)
424     ,@(when (documentation class t)
425     `("Documentation:" (:newline) ,(documentation class t) (:newline)))
426     "Sub classes: "
427     ,@(comma-separated (swank-mop:class-direct-subclasses class)
428     (lambda (sub)
429     `(:value ,sub ,(princ-to-string (class-name sub)))))
430     (:newline)
431     "Precedence List: "
432     ,@(if (swank-mop:class-finalized-p class)
433     (comma-separated (swank-mop:class-precedence-list class)
434     (lambda (class)
435     `(:value ,class ,(princ-to-string (class-name class)))))
436     '("#<N/A (class not finalized)>"))
437     (:newline))))
438    
439     (defimplementation inspect-for-emacs ((slot cons) (inspector corman-inspector))
440     ;; Inspects slot definitions
441     (declare (ignore corman-inspector))
442     (if (eq (car slot) :name)
443     (values "A slot."
444     `("Name: " (:value ,(swank-mop:slot-definition-name slot))
445     (:newline)
446     ,@(when (swank-mop:slot-definition-documentation slot)
447     `("Documentation:" (:newline)
448     (:value ,(swank-mop:slot-definition-documentation slot))
449     (:newline)))
450     "Init args: " (:value ,(swank-mop:slot-definition-initargs slot)) (:newline)
451     "Init form: " ,(if (swank-mop:slot-definition-initfunction slot)
452     `(:value ,(swank-mop:slot-definition-initform slot))
453     "#<unspecified>") (:newline)
454     "Init function: " (:value ,(swank-mop:slot-definition-initfunction slot))
455     (:newline)))
456     (call-next-method)))
457    
458     (defimplementation inspect-for-emacs ((pathname pathnames::pathname-internal)
459     inspector)
460     (declare (ignore inspector))
461     (values (if (wild-pathname-p pathname)
462     "A wild pathname."
463     "A pathname.")
464     (append (label-value-line*
465     ("Namestring" (namestring pathname))
466     ("Host" (pathname-host pathname))
467     ("Device" (pathname-device pathname))
468     ("Directory" (pathname-directory pathname))
469     ("Name" (pathname-name pathname))
470     ("Type" (pathname-type pathname))
471     ("Version" (pathname-version pathname)))
472     (unless (or (wild-pathname-p pathname)
473     (not (probe-file pathname)))
474     (label-value-line "Truename" (truename pathname))))))
475    
476 heller 1.3 (defimplementation inspect-for-emacs ((o t) (inspector corman-inspector))
477     (cond ((cl::structurep o) (inspect-structure o))
478     (t (call-next-method))))
479    
480     (defun inspect-structure (o)
481     (values
482     (format nil "~A is a structure" o)
483     (let* ((template (cl::uref o 1))
484     (num-slots (cl::struct-template-num-slots template)))
485     (cond ((symbolp template)
486     (loop for i below num-slots
487     append (label-value-line i (cl::uref o (+ 2 i)))))
488     (t
489     (loop for i below num-slots
490     append (label-value-line (elt template (+ 6 (* i 5)))
491     (cl::uref o (+ 2 i)))))))))
492    
493    
494     ;;; Threads
495    
496     (require 'threads)
497    
498     (defstruct (mailbox (:conc-name mailbox.))
499     thread
500     (lock (make-instance 'threads:critical-section))
501     (queue '() :type list))
502    
503     (defvar *mailbox-lock* (make-instance 'threads:critical-section))
504     (defvar *mailboxes* (list))
505    
506     (defmacro with-lock (lock &body body)
507     `(threads:with-synchronization (threads:cs ,lock)
508     ,@body))
509    
510     (defimplementation spawn (fun &key name)
511     (declare (ignore name))
512 heller 1.4 (th:create-thread
513 heller 1.3 (lambda ()
514 heller 1.4 (handler-bind ((serious-condition #'invoke-debugger))
515     (unwind-protect (funcall fun)
516     (with-lock *mailbox-lock*
517     (setq *mailboxes* (remove cormanlisp:*current-thread-id*
518     *mailboxes* :key #'mailbox.thread))))))))
519 heller 1.3
520 heller 1.4 (defimplementation thread-id (thread)
521 heller 1.3 thread)
522    
523     (defimplementation find-thread (thread)
524     (if (thread-alive-p thread)
525     thread))
526    
527 heller 1.4 (defimplementation thread-alive-p (thread)
528     (if (threads:thread-handle thread) t nil))
529    
530 heller 1.3 (defimplementation current-thread ()
531     cormanlisp:*current-thread-id*)
532    
533     ;; XXX implement it
534     (defimplementation all-threads ()
535     '())
536    
537     ;; XXX something here is broken
538     (defimplementation kill-thread (thread)
539     (threads:terminate-thread thread 'killed))
540    
541     (defun mailbox (thread)
542     (with-lock *mailbox-lock*
543     (or (find thread *mailboxes* :key #'mailbox.thread)
544     (let ((mb (make-mailbox :thread thread)))
545     (push mb *mailboxes*)
546     mb))))
547    
548     (defimplementation send (thread message)
549     (let ((mbox (mailbox thread)))
550     (with-lock (mailbox.lock mbox)
551     (setf (mailbox.queue mbox)
552     (nconc (mailbox.queue mbox) (list message))))))
553    
554     (defimplementation receive ()
555     (let ((mbox (mailbox cormanlisp:*current-thread-id*)))
556     (loop
557     (with-lock (mailbox.lock mbox)
558     (when (mailbox.queue mbox)
559     (return (pop (mailbox.queue mbox)))))
560     (sleep 0.1))))
561    
562    
563 ewiborg 1.2 ;;; This is probably not good, but it WFM
564     (in-package :common-lisp)
565    
566     (defvar *old-documentation* #'documentation)
567     (defun documentation (thing &optional (type 'function))
568     (if (symbolp thing)
569     (funcall *old-documentation* thing type)
570     (values)))
571    
572     (defmethod print-object ((restart restart) stream)
573     (if (or *print-escape*
574     *print-readably*)
575     (print-unreadable-object (restart stream :type t :identity t)
576     (princ (restart-name restart) stream))
577     (when (functionp (restart-report-function restart))
578     (funcall (restart-report-function restart) stream))))

  ViewVC Help
Powered by ViewVC 1.1.5