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

Diff of /slime/swank-backend.lisp

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

revision 1.94 by heller, Sun Nov 20 23:25:38 2005 UTC revision 1.213 by heller, Sun Nov 27 21:47:15 2011 UTC
# Line 12  Line 12 
12    
13  (defpackage :swank-backend  (defpackage :swank-backend
14    (:use :common-lisp)    (:use :common-lisp)
15    (:export #:sldb-condition    (:export #:*debug-swank-backend*
16             #:original-condition             #:sldb-condition
17             #:compiler-condition             #:compiler-condition
18               #:original-condition
19             #:message             #:message
20             #:short-message             #:source-context
21             #:condition             #:condition
22             #:severity             #:severity
23               #:with-compilation-hooks
24             #:location             #:location
25             #:location-p             #:location-p
26             #:location-buffer             #:location-buffer
# Line 29  Line 31 
31             #:quit-lisp             #:quit-lisp
32             #:references             #:references
33             #:unbound-slot-filler             #:unbound-slot-filler
34               #:declaration-arglist
35               #:type-specifier-arglist
36               #:with-struct
37               #:when-let
38               ;; interrupt macro for the backend
39               #:*pending-slime-interrupts*
40               #:check-slime-interrupts
41               #:*interrupt-queued-handler*
42             ;; inspector related symbols             ;; inspector related symbols
43             #:inspector             #:emacs-inspect
            #:inspect-for-emacs  
            #:raw-inspection  
            #:fancy-inspection  
44             #:label-value-line             #:label-value-line
45             #:label-value-line*             #:label-value-line*
46             ))             #:with-symbol))
47    
48  (defpackage :swank-mop  (defpackage :swank-mop
49    (:use)    (:use)
# Line 84  Line 91 
91     #:slot-definition-type     #:slot-definition-type
92     #:slot-definition-readers     #:slot-definition-readers
93     #:slot-definition-writers     #:slot-definition-writers
94       #:slot-boundp-using-class
95       #:slot-value-using-class
96       #:slot-makunbound-using-class
97     ;; generic function protocol     ;; generic function protocol
98     #:compute-applicable-methods-using-classes     #:compute-applicable-methods-using-classes
99     #:finalize-inheritance))     #:finalize-inheritance))
# Line 93  Line 103 
103    
104  ;;;; Metacode  ;;;; Metacode
105    
106    (defparameter *debug-swank-backend* nil
107      "If this is true, backends should not catch errors but enter the
108    debugger where appropriate. Also, they should not perform backtrace
109    magic but really show every frame including SWANK related ones.")
110    
111  (defparameter *interface-functions* '()  (defparameter *interface-functions* '()
112    "The names of all interface functions.")    "The names of all interface functions.")
113    
# Line 102  DEFINTERFACE adds to this list and DEFIM Line 117  DEFINTERFACE adds to this list and DEFIM
117    
118  (defmacro definterface (name args documentation &rest default-body)  (defmacro definterface (name args documentation &rest default-body)
119    "Define an interface function for the backend to implement.    "Define an interface function for the backend to implement.
120  A generic function is defined with NAME, ARGS, and DOCUMENTATION.  A function is defined with NAME, ARGS, and DOCUMENTATION.  This
121    function first looks for a function to call in NAME's property list
122  If a DEFAULT-BODY is supplied then NO-APPLICABLE-METHOD is specialized  that is indicated by 'IMPLEMENTATION; failing that, it looks for a
123  to execute the body if the backend doesn't provide a specific  function indicated by 'DEFAULT. If neither is present, an error is
124  implementation.  signaled.
125    
126    If a DEFAULT-BODY is supplied, then a function with the same body and
127    ARGS will be added to NAME's property list as the property indicated
128    by 'DEFAULT.
129    
130  Backends implement these functions using DEFIMPLEMENTATION."  Backends implement these functions using DEFIMPLEMENTATION."
131    (check-type documentation string "a documentation string")    (check-type documentation string "a documentation string")
132    (flet ((gen-default-impl ()    (assert (every #'symbolp args) ()
133             `(defmethod ,name ,args ,@default-body)))            "Complex lambda-list not supported: ~S ~S" name args)
134      `(progn (defgeneric ,name ,args (:documentation ,documentation))    (labels ((gen-default-impl ()
135              (pushnew ',name *interface-functions*)               `(setf (get ',name 'default) (lambda ,args ,@default-body)))
136              ,(if (null default-body)             (args-as-list (args)
137                   `(pushnew ',name *unimplemented-interfaces*)               (destructuring-bind (req opt key rest) (parse-lambda-list args)
138                   (gen-default-impl))                 `(,@req ,@opt
139              ;; see <http://www.franz.com/support/documentation/6.2/doc/pages/variables/compiler/s_cltl1-compile-file-toplevel-compatibility-p_s.htm>                         ,@(loop for k in key append `(,(kw k) ,k))
140              (eval-when (:compile-toplevel :load-toplevel :execute)                         ,@(or rest '(())))))
141                (export ',name :swank-backend))             (parse-lambda-list (args)
142              ',name)))               (parse args '(&optional &key &rest)
143                        (make-array 4 :initial-element nil)))
144               (parse (args keywords vars)
145                 (cond ((null args)
146                        (reverse (map 'list #'reverse vars)))
147                       ((member (car args) keywords)
148                        (parse (cdr args) (cdr (member (car args) keywords)) vars))
149                       (t (push (car args) (aref vars (length keywords)))
150                          (parse (cdr args) keywords vars))))
151               (kw (s) (intern (string s) :keyword)))
152        `(progn
153           (defun ,name ,args
154             ,documentation
155             (let ((f (or (get ',name 'implementation)
156                          (get ',name 'default))))
157               (cond (f (apply f ,@(args-as-list args)))
158                     (t (error "~S not implemented" ',name)))))
159           (pushnew ',name *interface-functions*)
160           ,(if (null default-body)
161                `(pushnew ',name *unimplemented-interfaces*)
162                (gen-default-impl))
163           ;; see <http://www.franz.com/support/documentation/6.2/doc/pages/variables/compiler/s_cltl1-compile-file-toplevel-compatibility-p_s.htm>
164           (eval-when (:compile-toplevel :load-toplevel :execute)
165             (export ',name :swank-backend))
166           ',name)))
167    
168  (defmacro defimplementation (name args &body body)  (defmacro defimplementation (name args &body body)
169    `(progn (defmethod ,name ,args ,@body)    (assert (every #'symbolp args) ()
170            (if (member ',name *interface-functions*)            "Complex lambda-list not supported: ~S ~S" name args)
171                (setq *unimplemented-interfaces*    `(progn
172                      (remove ',name *unimplemented-interfaces*))       (setf (get ',name 'implementation)
173                (warn "DEFIMPLEMENTATION of undefined interface (~S)" ',name))             ;; For implicit BLOCK. FLET because of interplay w/ decls.
174            ',name))             (flet ((,name ,args ,@body)) #',name))
175         (if (member ',name *interface-functions*)
176             (setq *unimplemented-interfaces*
177                   (remove ',name *unimplemented-interfaces*))
178             (warn "DEFIMPLEMENTATION of undefined interface (~S)" ',name))
179         ',name))
180    
181  (defun warn-unimplemented-interfaces ()  (defun warn-unimplemented-interfaces ()
182    "Warn the user about unimplemented backend features.    "Warn the user about unimplemented backend features.
183  The portable code calls this function at startup."  The portable code calls this function at startup."
184    (warn "These Swank interfaces are unimplemented:~% ~A"    (let ((*print-pretty* t))
185          (sort (copy-list *unimplemented-interfaces*) #'string<)))      (warn "These Swank interfaces are unimplemented:~% ~:<~{~A~^ ~:_~}~:>"
186              (list (sort (copy-list *unimplemented-interfaces*) #'string<)))))
187    
188  (defun import-to-swank-mop (symbol-list)  (defun import-to-swank-mop (symbol-list)
189    (dolist (sym symbol-list)    (dolist (sym symbol-list)
# Line 158  EXCEPT is a list of symbol names which s Line 207  EXCEPT is a list of symbol names which s
207  (defvar *gray-stream-symbols*  (defvar *gray-stream-symbols*
208    '(:fundamental-character-output-stream    '(:fundamental-character-output-stream
209      :stream-write-char      :stream-write-char
210        :stream-write-string
211      :stream-fresh-line      :stream-fresh-line
212      :stream-force-output      :stream-force-output
213      :stream-finish-output      :stream-finish-output
214      :fundamental-character-input-stream      :fundamental-character-input-stream
215      :stream-read-char      :stream-read-char
216        :stream-peek-char
217        :stream-read-line
218        ;; STREAM-FILE-POSITION is not available on all implementations, or
219        ;; partially under a different name.
220        ; :stream-file-posiion
221      :stream-listen      :stream-listen
222      :stream-unread-char      :stream-unread-char
223      :stream-clear-input      :stream-clear-input
# Line 199  EXCEPT is a list of symbol names which s Line 254  EXCEPT is a list of symbol names which s
254                       (t (error "Malformed syntax in WITH-STRUCT: ~A" name))))                       (t (error "Malformed syntax in WITH-STRUCT: ~A" name))))
255            ,@body)))))            ,@body)))))
256    
257    (defmacro when-let ((var value) &body body)
258      `(let ((,var ,value))
259         (when ,var ,@body)))
260    
261    (defun with-symbol (name package)
262      "Generate a form suitable for testing with #+."
263      (if (and (find-package package)
264               (find-symbol (string name) package))
265          '(:and)
266          '(:or)))
267    
268    
269    ;;;; UFT8
270    
271    (deftype octet () '(unsigned-byte 8))
272    (deftype octets () '(simple-array octet (*)))
273    
274    ;; Helper function.  Decode the next N bytes starting from INDEX.
275    ;; Return the decoded char and the new index.
276    (defun utf8-decode-aux (buffer index limit byte0 n)
277      (declare (type octets buffer) (fixnum index limit byte0 n))
278      (if (< (- limit index) n)
279          (values nil index)
280          (do ((i 0 (1+ i))
281               (code byte0 (let ((byte (aref buffer (+ index i))))
282                             (cond ((= (ldb (byte 2 6) byte) #b10)
283                                    (+ (ash code 6) (ldb (byte 6 0) byte)))
284                                   (t
285                                    (error "Invalid encoding"))))))
286              ((= i n)
287               (values (cond ((<= code #xff) (code-char code))
288                             ((<= #xd800 code #xdfff)
289                              (error "Invalid Unicode code point: #x~x" code))
290                             ((and (< code char-code-limit)
291                                   (code-char code)))
292                             (t
293                              (error
294                               "Can't represent code point: #x~x ~
295                                (char-code-limit is #x~x)"
296                               code char-code-limit)))
297                       (+ index n))))))
298    
299    ;; Decode one character in BUFFER starting at INDEX.
300    ;; Return 2 values: the character and the new index.
301    ;; If there aren't enough bytes between INDEX and LIMIT return nil.
302    (defun utf8-decode (buffer index limit)
303      (declare (type octets buffer) (fixnum index limit))
304      (if (= index limit)
305          (values nil index)
306          (let ((b (aref buffer index)))
307            (if (<= b #x7f)
308                (values (code-char b) (1+ index))
309                (macrolet ((try (marker else)
310                             (let* ((l (integer-length marker))
311                                    (n (- l 2)))
312                               `(if (= (ldb (byte ,l ,(- 8 l)) b) ,marker)
313                                    (utf8-decode-aux buffer (1+ index) limit
314                                                     (ldb (byte ,(- 8 l) 0) b)
315                                                     ,n)
316                                    ,else))))
317                  (try #b110
318                       (try #b1110
319                            (try #b11110
320                                 (try #b111110
321                                      (try #b1111110
322                                           (error "Invalid encoding")))))))))))
323    
324    ;; Decode characters from BUFFER and write them to STRING.
325    ;; Return 2 values: LASTINDEX and LASTSTART where
326    ;; LASTINDEX is the last index in BUFFER that was not decoded
327    ;; and LASTSTART is the last index in STRING not written.
328    (defun utf8-decode-into (buffer index limit string start end)
329      (declare (string string) (fixnum index limit start end) (type octets buffer))
330      (loop
331       (cond ((= start end)
332              (return (values index start)))
333             (t
334              (multiple-value-bind (c i) (utf8-decode buffer index limit)
335                (cond (c
336                       (setf (aref string start) c)
337                       (setq index i)
338                       (setq start (1+ start)))
339                      (t
340                       (return (values index start)))))))))
341    
342    (defun default-utf8-to-string (octets)
343      (let* ((limit (length octets))
344             (str (make-string limit)))
345        (multiple-value-bind (i s) (utf8-decode-into octets 0 limit str 0 limit)
346          (if (= i limit)
347              (if (= limit s)
348                  str
349                  (adjust-array str s))
350              (loop
351               (let ((end (+ (length str) (- limit i))))
352                 (setq str (adjust-array str end))
353                 (multiple-value-bind (i2 s2)
354                     (utf8-decode-into octets i limit str s end)
355                   (cond ((= i2 limit)
356                          (return (adjust-array str s2)))
357                         (t
358                          (setq i i2)
359                          (setq s s2))))))))))
360    
361    (defmacro utf8-encode-aux (code buffer start end n)
362      `(cond ((< (- ,end ,start) ,n)
363              ,start)
364             (t
365              (setf (aref ,buffer ,start)
366                    (dpb (ldb (byte ,(- 7 n) ,(* 6 (1- n))) ,code)
367                         (byte ,(- 7 n) 0)
368                         ,(dpb 0 (byte 1 (- 7 n)) #xff)))
369              ,@(loop for i from 0 upto (- n 2) collect
370                      `(setf (aref ,buffer (+ ,start ,(- n 1 i)))
371                             (dpb (ldb (byte 6 ,(* 6 i)) ,code)
372                                  (byte 6 0)
373                                  #b10111111)))
374              (+ ,start ,n))))
375    
376    (defun utf8-encode (char buffer start end)
377      (declare (character char) (type octets buffer) (fixnum start end))
378      (let ((code (char-code char)))
379        (cond ((<= code #x7f)
380               (cond ((< start end)
381                      (setf (aref buffer start) code)
382                      (1+ start))
383                     (t start)))
384              ((<= code #x7ff) (utf8-encode-aux code buffer start end 2))
385              ((<= #xd800 code #xdfff)
386               (error "Invalid Unicode code point (surrogate): #x~x" code))
387              ((<= code #xffff) (utf8-encode-aux code buffer start end 3))
388              ((<= code #x1fffff) (utf8-encode-aux code buffer start end 4))
389              ((<= code #x3ffffff) (utf8-encode-aux code buffer start end 5))
390              ((<= code #x7fffffff) (utf8-encode-aux code buffer start end 6))
391              (t (error "Can't encode ~s (~x)" char code)))))
392    
393    (defun utf8-encode-into (string start end buffer index limit)
394      (declare (string string) (type octets buffer) (fixnum start end index limit))
395      (loop
396       (cond ((= start end)
397              (return (values start index)))
398             ((= index limit)
399              (return (values start index)))
400             (t
401              (let ((i2 (utf8-encode (char string start) buffer index limit)))
402                (cond ((= i2 index)
403                       (return (values start index)))
404                      (t
405                       (setq index i2)
406                       (incf start))))))))
407    
408    (defun default-string-to-utf8 (string)
409      (let* ((len (length string))
410             (b (make-array len :element-type 'octet)))
411        (multiple-value-bind (s i) (utf8-encode-into string 0 len b 0 len)
412          (if (= s len)
413              b
414              (loop
415               (let ((limit (+ (length b) (- len s))))
416                 (setq b (coerce (adjust-array b limit) 'octets))
417                 (multiple-value-bind (s2 i2)
418                     (utf8-encode-into string s len b i limit)
419                   (cond ((= s2 len)
420                          (return (coerce (adjust-array b i2) 'octets)))
421                         (t
422                          (setq i i2)
423                          (setq s s2))))))))))
424    
425    (definterface string-to-utf8 (string)
426      "Convert the string STRING to a (simple-array (unsigned-byte 8))"
427      (default-string-to-utf8 string))
428    
429    (definterface utf8-to-string (octets)
430      "Convert the (simple-array (unsigned-byte 8)) OCTETS to a string."
431      (default-utf8-to-string octets))
432    
433    
434  ;;;; TCP server  ;;;; TCP server
435    
436  (definterface create-socket (host port)  (definterface create-socket (host port &key backlog)
437    "Create a listening TCP socket on interface HOST and port PORT .")    "Create a listening TCP socket on interface HOST and port PORT.
438    BACKLOG queue length for incoming connections.")
439    
440  (definterface local-port (socket)  (definterface local-port (socket)
441    "Return the local port number of SOCKET.")    "Return the local port number of SOCKET.")
# Line 212  EXCEPT is a list of symbol names which s Line 444  EXCEPT is a list of symbol names which s
444    "Close the socket SOCKET.")    "Close the socket SOCKET.")
445    
446  (definterface accept-connection (socket &key external-format  (definterface accept-connection (socket &key external-format
447                                          buffering)                                          buffering timeout)
448     "Accept a client connection on the listening socket SOCKET.     "Accept a client connection on the listening socket SOCKET.
449  Return a stream for the new connection.")  Return a stream for the new connection.
450    If EXTERNAL-FORMAT is nil return a binary stream
451    otherwise create a character stream.
452    BUFFERING can be one of:
453      nil   ... no buffering
454      t     ... enable buffering
455      :line ... enable buffering with automatic flushing on eol.")
456    
457  (definterface add-sigio-handler (socket fn)  (definterface add-sigio-handler (socket fn)
458    "Call FN whenever SOCKET is readable.")    "Call FN whenever SOCKET is readable.")
# Line 232  Return a stream for the new connection." Line 470  Return a stream for the new connection."
470    "Return one of the symbols :spawn, :sigio, :fd-handler, or NIL."    "Return one of the symbols :spawn, :sigio, :fd-handler, or NIL."
471    nil)    nil)
472    
473    (definterface set-stream-timeout (stream timeout)
474      "Set the 'stream 'timeout.  The timeout is either the real number
475      specifying the timeout in seconds or 'nil for no timeout."
476      (declare (ignore stream timeout))
477      nil)
478    
479  ;;; Base condition for networking errors.  ;;; Base condition for networking errors.
480  (define-condition network-error (simple-error) ())  (define-condition network-error (simple-error) ())
481    
# Line 249  that the calling thread is the one that Line 493  that the calling thread is the one that
493    
494  (defconstant +sigint+ 2)  (defconstant +sigint+ 2)
495    
 (definterface call-without-interrupts (fn)  
   "Call FN in a context where interrupts are disabled."  
   (funcall fn))  
   
496  (definterface getpid ()  (definterface getpid ()
497    "Return the (Unix) process ID of this superior Lisp.")    "Return the (Unix) process ID of this superior Lisp.")
498    
499    (definterface install-sigint-handler (function)
500      "Call FUNCTION on SIGINT (instead of invoking the debugger).
501    Return old signal handler."
502      (declare (ignore function))
503      nil)
504    
505    (definterface call-with-user-break-handler (handler function)
506      "Install the break handler HANDLER while executing FUNCTION."
507      (let ((old-handler (install-sigint-handler handler)))
508        (unwind-protect (funcall function)
509          (install-sigint-handler old-handler))))
510    
511    (definterface quit-lisp ()
512      "Exit the current lisp image.")
513    
514  (definterface lisp-implementation-type-name ()  (definterface lisp-implementation-type-name ()
515    "Return a short name for the Lisp implementation."    "Return a short name for the Lisp implementation."
516    (lisp-implementation-type))    (lisp-implementation-type))
517    
518    (definterface lisp-implementation-program ()
519      "Return the argv[0] of the running Lisp process, or NIL."
520      (let ((file (car (command-line-args))))
521        (when (and file (probe-file file))
522          (namestring (truename file)))))
523    
524    (definterface socket-fd (socket-stream)
525      "Return the file descriptor for SOCKET-STREAM.")
526    
527    (definterface make-fd-stream (fd external-format)
528      "Create a character stream for the file descriptor FD.")
529    
530    (definterface dup (fd)
531      "Duplicate a file descriptor.
532    If the syscall fails, signal a condition.
533    See dup(2).")
534    
535    (definterface exec-image (image-file args)
536      "Replace the current process with a new process image.
537    The new image is created by loading the previously dumped
538    core file IMAGE-FILE.
539    ARGS is a list of strings passed as arguments to
540    the new image.
541    This is thin wrapper around exec(3).")
542    
543    (definterface command-line-args ()
544      "Return a list of strings as passed by the OS."
545      nil)
546    
547    
548    ;; pathnames are sooo useless
549    
550    (definterface filename-to-pathname (filename)
551      "Return a pathname for FILENAME.
552    A filename in Emacs may for example contain asterisks which should not
553    be translated to wildcards."
554      (parse-namestring filename))
555    
556    (definterface pathname-to-filename (pathname)
557      "Return the filename for PATHNAME."
558      (namestring pathname))
559    
560  (definterface default-directory ()  (definterface default-directory ()
561    "Return the default directory."    "Return the default directory."
562    (directory-namestring (truename *default-pathname-defaults*)))    (directory-namestring (truename *default-pathname-defaults*)))
# Line 270  This is used to resolve filenames withou Line 567  This is used to resolve filenames withou
567    (setf *default-pathname-defaults* (truename (merge-pathnames directory)))    (setf *default-pathname-defaults* (truename (merge-pathnames directory)))
568    (default-directory))    (default-directory))
569    
570    
571  (definterface call-with-syntax-hooks (fn)  (definterface call-with-syntax-hooks (fn)
572    "Call FN with hooks to handle special syntax."    "Call FN with hooks to handle special syntax."
573    (funcall fn))    (funcall fn))
# Line 278  This is used to resolve filenames withou Line 576  This is used to resolve filenames withou
576    "Return a suitable initial value for SWANK:*READTABLE-ALIST*."    "Return a suitable initial value for SWANK:*READTABLE-ALIST*."
577    '())    '())
578    
 (definterface quit-lisp ()  
   "Exit the current lisp image.")  
   
579    
580  ;;;; Compilation  ;;;; Compilation
581    
# Line 292  This is used to resolve filenames withou Line 587  This is used to resolve filenames withou
587    (declare (ignore ignore))    (declare (ignore ignore))
588    `(call-with-compilation-hooks (lambda () (progn ,@body))))    `(call-with-compilation-hooks (lambda () (progn ,@body))))
589    
590  (definterface swank-compile-string (string &key buffer position directory)  (definterface swank-compile-string (string &key buffer position filename
591    "Compile source from STRING.  During compilation, compiler                                             policy)
592  conditions must be trapped and resignalled as COMPILER-CONDITIONs.    "Compile source from STRING.
593    During compilation, compiler conditions must be trapped and
594    resignalled as COMPILER-CONDITIONs.
595    
596  If supplied, BUFFER and POSITION specify the source location in Emacs.  If supplied, BUFFER and POSITION specify the source location in Emacs.
597    
598  Additionally, if POSITION is supplied, it must be added to source  Additionally, if POSITION is supplied, it must be added to source
599  positions reported in compiler conditions.  positions reported in compiler conditions.
600    
601  If DIRECTORY is specified it may be used by certain implementations to  If FILENAME is specified it may be used by certain implementations to
602  rebind *DEFAULT-PATHNAME-DEFAULTS* which may improve the recording of  rebind *DEFAULT-PATHNAME-DEFAULTS* which may improve the recording of
603  source information.")  source information.
604    
605  (definterface operate-on-system (system-name operation-name &rest keyword-args)  If POLICY is supplied, and non-NIL, it may be used by certain
606    "Perform OPERATION-NAME on SYSTEM-NAME using ASDF.  implementations to compile with optimization qualities of its
607  The KEYWORD-ARGS are passed on to the operation.  value.
608  Example:  
609  \(operate-on-system \"SWANK\" \"COMPILE-OP\" :force t)"  Should return T on successful compilation, NIL otherwise.
610    (unless (member :asdf *features*)  ")
611      (error "ASDF is not loaded."))  
612    (with-compilation-hooks ()  (definterface swank-compile-file (input-file output-file load-p
613      (let ((operate (find-symbol "OPERATE" :asdf))                                               external-format
614            (operation (find-symbol operation-name :asdf)))                                               &key policy)
615        (when (null operation)     "Compile INPUT-FILE signalling COMPILE-CONDITIONs.
616          (error "Couldn't find ASDF operation ~S" operation-name))  If LOAD-P is true, load the file after compilation.
617        (apply operate operation system-name keyword-args))))  EXTERNAL-FORMAT is a value returned by find-external-format or
618    :default.
619  (definterface swank-compile-file (filename load-p &optional external-format)  
620     "Compile FILENAME signalling COMPILE-CONDITIONs.  If POLICY is supplied, and non-NIL, it may be used by certain
621  If LOAD-P is true, load the file after compilation.")  implementations to compile with optimization qualities of its
622    value.
623    
624    Should return OUTPUT-TRUENAME, WARNINGS-P and FAILURE-p
625    like `compile-file'")
626    
627  (deftype severity ()  (deftype severity ()
628    '(member :error :read-error :warning :style-warning :note))    '(member :error :read-error :warning :style-warning :note :redefinition))
629    
630  ;; Base condition type for compiler errors, warnings and notes.  ;; Base condition type for compiler errors, warnings and notes.
631  (define-condition compiler-condition (condition)  (define-condition compiler-condition (condition)
# Line 342  If LOAD-P is true, load the file after c Line 643  If LOAD-P is true, load the file after c
643     (message :initarg :message     (message :initarg :message
644              :accessor message)              :accessor message)
645    
646     (short-message :initarg :short-message     ;; Macro expansion history etc. which may be helpful in some cases
647                    :initform nil     ;; but is often very verbose.
648                    :accessor short-message)     (source-context :initarg :source-context
649                       :type (or null string)
650                       :initform nil
651                       :accessor source-context)
652    
653     (references :initarg :references     (references :initarg :references
654                 :initform nil                 :initform nil
# Line 353  If LOAD-P is true, load the file after c Line 657  If LOAD-P is true, load the file after c
657     (location :initarg :location     (location :initarg :location
658               :accessor location)))               :accessor location)))
659    
660    (definterface find-external-format (coding-system)
661      "Return a \"external file format designator\" for CODING-SYSTEM.
662    CODING-SYSTEM is Emacs-style coding system name (a string),
663    e.g. \"latin-1-unix\"."
664      (if (equal coding-system "iso-latin-1-unix")
665          :default
666          nil))
667    
668    (definterface guess-external-format (pathname)
669      "Detect the external format for the file with name pathname.
670    Return nil if the file contains no special markers."
671      ;; Look for a Emacs-style -*- coding: ... -*- or Local Variable: section.
672      (with-open-file (s pathname :if-does-not-exist nil
673                         :external-format (or (find-external-format "latin-1-unix")
674                                              :default))
675        (if s
676            (or (let* ((line (read-line s nil))
677                       (p (search "-*-" line)))
678                  (when p
679                    (let* ((start (+ p (length "-*-")))
680                           (end (search "-*-" line :start2 start)))
681                      (when end
682                        (%search-coding line start end)))))
683                (let* ((len (file-length s))
684                       (buf (make-string (min len 3000))))
685                  (file-position s (- len (length buf)))
686                  (read-sequence buf s)
687                  (let ((start (search "Local Variables:" buf :from-end t))
688                        (end (search "End:" buf :from-end t)))
689                    (and start end (< start end)
690                         (%search-coding buf start end))))))))
691    
692    (defun %search-coding (str start end)
693      (let ((p (search "coding:" str :start2 start :end2 end)))
694        (when p
695          (incf p (length "coding:"))
696          (loop while (and (< p end)
697                           (member (aref str p) '(#\space #\tab)))
698                do (incf p))
699          (let ((end (position-if (lambda (c) (find c '(#\space #\tab #\newline)))
700                                  str :start p)))
701            (find-external-format (subseq str p end))))))
702    
703    
704  ;;;; Streams  ;;;; Streams
705    
706  (definterface make-fn-streams (input-fn output-fn)  (definterface make-output-stream (write-string)
707     "Return character input and output streams backended by functions.    "Return a new character output stream.
708  When input is needed, INPUT-FN is called with no arguments to  The stream calls WRITE-STRING when output is ready.")
709  return a string.  
710  When output is ready, OUTPUT-FN is called with the output as its  (definterface make-input-stream (read-string)
711  argument.    "Return a new character input stream.
712    The stream calls READ-STRING when input is needed.")
 Output should be forced to OUTPUT-FN before calling INPUT-FN.  
   
 The streams are returned as two values.")  
   
 (definterface make-stream-interactive (stream)  
   "Do any necessary setup to make STREAM work interactively.  
 This is called for each stream used for interaction with the user  
 \(e.g. *standard-output*). An implementation could setup some  
 implementation-specific functions to control output flushing at the  
 like."  
   (declare (ignore stream))  
   nil)  
713    
714    
715  ;;;; Documentation  ;;;; Documentation
# Line 383  like." Line 718  like."
718     "Return the lambda list for the symbol NAME. NAME can also be     "Return the lambda list for the symbol NAME. NAME can also be
719  a lisp function object, on lisps which support this.  a lisp function object, on lisps which support this.
720    
721  The result can be a list or the :not-available if the arglist  The result can be a list or the :not-available keyword if the
722  cannot be determined."  arglist cannot be determined."
723     (declare (ignore name))     (declare (ignore name))
724     :not-available)     :not-available)
725    
726    (defgeneric declaration-arglist (decl-identifier)
727      (:documentation
728       "Return the argument list of the declaration specifier belonging to the
729    declaration identifier DECL-IDENTIFIER. If the arglist cannot be determined,
730    the keyword :NOT-AVAILABLE is returned.
731    
732    The different SWANK backends can specialize this generic function to
733    include implementation-dependend declaration specifiers, or to provide
734    additional information on the specifiers defined in ANSI Common Lisp.")
735      (:method (decl-identifier)
736        (case decl-identifier
737          (dynamic-extent '(&rest variables))
738          (ignore         '(&rest variables))
739          (ignorable      '(&rest variables))
740          (special        '(&rest variables))
741          (inline         '(&rest function-names))
742          (notinline      '(&rest function-names))
743          (declaration    '(&rest names))
744          (optimize       '(&any compilation-speed debug safety space speed))
745          (type           '(type-specifier &rest args))
746          (ftype          '(type-specifier &rest function-names))
747          (otherwise
748           (flet ((typespec-p (symbol) (member :type (describe-symbol-for-emacs symbol))))
749             (cond ((and (symbolp decl-identifier) (typespec-p decl-identifier))
750                    '(&rest variables))
751                   ((and (listp decl-identifier) (typespec-p (first decl-identifier)))
752                    '(&rest variables))
753                   (t :not-available)))))))
754    
755    (defgeneric type-specifier-arglist (typespec-operator)
756      (:documentation
757       "Return the argument list of the type specifier belonging to
758    TYPESPEC-OPERATOR.. If the arglist cannot be determined, the keyword
759    :NOT-AVAILABLE is returned.
760    
761    The different SWANK backends can specialize this generic function to
762    include implementation-dependend declaration specifiers, or to provide
763    additional information on the specifiers defined in ANSI Common Lisp.")
764      (:method (typespec-operator)
765        (declare (special *type-specifier-arglists*)) ; defined at end of file.
766        (typecase typespec-operator
767          (symbol (or (cdr (assoc typespec-operator *type-specifier-arglists*))
768                      :not-available))
769          (t :not-available))))
770    
771  (definterface function-name (function)  (definterface function-name (function)
772    "Return the name of the function object FUNCTION.    "Return the name of the function object FUNCTION.
773    
# Line 395  The result is either a symbol, a list, o Line 775  The result is either a symbol, a list, o
775    (declare (ignore function))    (declare (ignore function))
776    nil)    nil)
777    
778    (definterface valid-function-name-p (form)
779      "Is FORM syntactically valid to name a function?
780       If true, FBOUNDP should not signal a type-error for FORM."
781      (flet ((length=2 (list)
782               (and (not (null (cdr list))) (null (cddr list)))))
783        (or (symbolp form)
784            (and (consp form) (length=2 form)
785                 (eq (first form) 'setf) (symbolp (second form))))))
786    
787  (definterface macroexpand-all (form)  (definterface macroexpand-all (form)
788     "Recursively expand all macros in FORM.     "Recursively expand all macros in FORM.
789  Return the resulting form.")  Return the resulting form.")
# Line 405  If FORM is a function call for which a c Line 794  If FORM is a function call for which a c
794  defined, invoke the expander function using *macroexpand-hook* and  defined, invoke the expander function using *macroexpand-hook* and
795  return the results and T.  Otherwise, return the original form and  return the results and T.  Otherwise, return the original form and
796  NIL."  NIL."
797    (let ((fun (and (consp form) (compiler-macro-function (car form)))))    (let ((fun (and (consp form)
798                      (valid-function-name-p (car form))
799                      (compiler-macro-function (car form)))))
800      (if fun      (if fun
801          (let ((result (funcall *macroexpand-hook* fun form env)))          (let ((result (funcall *macroexpand-hook* fun form env)))
802            (values result (not (eq result form))))            (values result (not (eq result form))))
# Line 421  NIL." Line 812  NIL."
812                     (values new-form expanded)))))                     (values new-form expanded)))))
813      (frob form env)))      (frob form env)))
814    
815    (definterface format-string-expand (control-string)
816      "Expand the format string CONTROL-STRING."
817      (macroexpand `(formatter ,control-string)))
818    
819  (definterface describe-symbol-for-emacs (symbol)  (definterface describe-symbol-for-emacs (symbol)
820     "Return a property list describing SYMBOL.     "Return a property list describing SYMBOL.
821    
# Line 470  For example, this is a reasonable place Line 865  For example, this is a reasonable place
865  to safe reader/printer settings, and so on.")  to safe reader/printer settings, and so on.")
866    
867  (definterface call-with-debugger-hook (hook fun)  (definterface call-with-debugger-hook (hook fun)
868    "Call FUN and use HOOK as debugger hook.    "Call FUN and use HOOK as debugger hook. HOOK can be NIL.
869    
870  HOOK should be called for both BREAK and INVOKE-DEBUGGER."  HOOK should be called for both BREAK and INVOKE-DEBUGGER."
871    (let ((*debugger-hook* hook))    (let ((*debugger-hook* hook))
# Line 492  debug the debugger! Instead, such condit Line 887  debug the debugger! Instead, such condit
887  user without (re)entering the debugger by wrapping them as  user without (re)entering the debugger by wrapping them as
888  `sldb-condition's."))  `sldb-condition's."))
889    
890    ;;; The following functions in this section are supposed to be called
891    ;;; within the dynamic contour of CALL-WITH-DEBUGGING-ENVIRONMENT only.
892    
893  (definterface compute-backtrace (start end)  (definterface compute-backtrace (start end)
894     "Return a list containing a backtrace of the condition current     "Returns a backtrace of the condition currently being debugged,
895  being debugged.  The results are unspecified if this function is  that is an ordered list consisting of frames. ``Ordered list''
896  called outside the dynamic contour CALL-WITH-DEBUGGING-ENVIRONMENT.  means that an integer I can be mapped back to the i-th frame of this
897    backtrace.
898    
899  START and END are zero-based indices constraining the number of frames  START and END are zero-based indices constraining the number of frames
900  returned.  Frame zero is defined as the frame which invoked the  returned. Frame zero is defined as the frame which invoked the
901  debugger.  If END is nil, return the frames from START to the end of  debugger. If END is nil, return the frames from START to the end of
902  the stack.")  the stack.")
903    
904  (definterface print-frame (frame stream)  (definterface print-frame (frame stream)
905    "Print frame to stream.")    "Print frame to stream.")
906    
907  (definterface frame-source-location-for-emacs (frame-number)  (definterface frame-restartable-p (frame)
908    "Return the source location for FRAME-NUMBER.")    "Is the frame FRAME restartable?.
909    Return T if `restart-frame' can safely be called on the frame."
910      (declare (ignore frame))
911      nil)
912    
913    (definterface frame-source-location (frame-number)
914      "Return the source location for the frame associated to FRAME-NUMBER.")
915    
916  (definterface frame-catch-tags (frame-number)  (definterface frame-catch-tags (frame-number)
917    "Return a list of XXX list of what? catch tags for a debugger    "Return a list of catch tags for being printed in a debugger stack
918  stack frame.  The results are undefined unless this is called  frame."
919  within the dynamic contour of a function defined by    (declare (ignore frame-number))
920  DEFINE-DEBUGGER-HOOK.")    '())
921    
922  (definterface frame-locals (frame-number)  (definterface frame-locals (frame-number)
923    "Return a list of XXX local variable designators define me    "Return a list of ((&key NAME ID VALUE) ...) where each element of
924  for a debugger stack frame.  The results are undefined unless  the list represents a local variable in the stack frame associated to
925  this is called within the dynamic contour of a function defined  FRAME-NUMBER.
926  by DEFINE-DEBUGGER-HOOK.")  
927    NAME, a symbol; the name of the local variable.
928  (definterface frame-var-value (frame var)  
929    "Return the value of VAR in FRAME.  ID, an integer; used as primary key for the local variable, unique
930  FRAME is the number of the frame in the backtrace.  relatively to the frame under operation.
931  VAR is the number of the variable in the frame.")  
932    value, an object; the value of the local variable.")
933    
934    (definterface frame-var-value (frame-number var-id)
935      "Return the value of the local variable associated to VAR-ID
936    relatively to the frame associated to FRAME-NUMBER.")
937    
938  (definterface disassemble-frame (frame-number)  (definterface disassemble-frame (frame-number)
939    "Disassemble the code for the FRAME-NUMBER.    "Disassemble the code for the FRAME-NUMBER.
# Line 532  FRAME-NUMBER is a non-negative integer." Line 942  FRAME-NUMBER is a non-negative integer."
942    
943  (definterface eval-in-frame (form frame-number)  (definterface eval-in-frame (form frame-number)
944     "Evaluate a Lisp form in the lexical context of a stack frame     "Evaluate a Lisp form in the lexical context of a stack frame
945  in the debugger.  The results are undefined unless called in the  in the debugger.
 dynamic contour of a function defined by DEFINE-DEBUGGER-HOOK.  
946    
947  FRAME-NUMBER must be a positive integer with 0 indicating the  FRAME-NUMBER must be a positive integer with 0 indicating the
948  frame which invoked the debugger.  frame which invoked the debugger.
# Line 541  frame which invoked the debugger. Line 950  frame which invoked the debugger.
950  The return value is the result of evaulating FORM in the  The return value is the result of evaulating FORM in the
951  appropriate context.")  appropriate context.")
952    
953    (definterface frame-package (frame-number)
954      "Return the package corresponding to the frame at FRAME-NUMBER.
955    Return nil if the backend can't figure it out."
956      (declare (ignore frame-number))
957      nil)
958    
959    (definterface frame-call (frame-number)
960      "Return a string representing a call to the entry point of a frame.")
961    
962  (definterface return-from-frame (frame-number form)  (definterface return-from-frame (frame-number form)
963    "Unwind the stack to the frame FRAME-NUMBER and return the value(s)    "Unwind the stack to the frame FRAME-NUMBER and return the value(s)
964  produced by evaluating FORM in the frame context to its caller.  produced by evaluating FORM in the frame context to its caller.
# Line 559  as it was called originally.") Line 977  as it was called originally.")
977    "Format a condition for display in SLDB."    "Format a condition for display in SLDB."
978    (princ-to-string condition))    (princ-to-string condition))
979    
 (definterface condition-references (condition)  
   "Return a list of documentation references for a condition.  
 Each reference is one of:  
   (:ANSI-CL  
    {:FUNCTION | :SPECIAL-OPERATOR | :MACRO | :SECTION | :GLOSSARY }  
    symbol-or-name)  
   (:SBCL :NODE node-name)"  
   (declare (ignore condition))  
   '())  
   
980  (definterface condition-extras (condition)  (definterface condition-extras (condition)
981    "Return a list of extra for the debugger.    "Return a list of extra for the debugger.
982  The allowed elements are of the form:  The allowed elements are of the form:
983    (:SHOW-FRAME-SOURCE frame-number)"    (:SHOW-FRAME-SOURCE frame-number)
984      (:REFERENCES &rest refs)
985    "
986    (declare (ignore condition))    (declare (ignore condition))
987    '())    '())
988    
989    (definterface gdb-initial-commands ()
990      "List of gdb commands supposed to be executed first for the
991       ATTACH-GDB restart."
992      nil)
993    
994  (definterface activate-stepping (frame-number)  (definterface activate-stepping (frame-number)
995    "Prepare the frame FRAME-NUMBER for stepping.")    "Prepare the frame FRAME-NUMBER for stepping.")
996    
# Line 585  The allowed elements are of the form: Line 1000  The allowed elements are of the form:
1000  (definterface sldb-break-at-start (symbol)  (definterface sldb-break-at-start (symbol)
1001    "Set a breakpoint on the beginning of the function for SYMBOL.")    "Set a breakpoint on the beginning of the function for SYMBOL.")
1002    
1003    (definterface sldb-stepper-condition-p (condition)
1004      "Return true if SLDB was invoked due to a single-stepping condition,
1005    false otherwise. "
1006      (declare (ignore condition))
1007      nil)
1008    
1009    (definterface sldb-step-into ()
1010      "Step into the current single-stepper form.")
1011    
1012    (definterface sldb-step-next ()
1013      "Step to the next form in the current function.")
1014    
1015    (definterface sldb-step-out ()
1016      "Stop single-stepping temporarily, but resume it once the current function
1017    returns.")
1018    
1019    
1020  ;;;; Definition finding  ;;;; Definition finding
# Line 600  The allowed elements are of the form: Line 1030  The allowed elements are of the form:
1030    hints)    hints)
1031    
1032  (defstruct (:error (:type list) :named (:constructor)) message)  (defstruct (:error (:type list) :named (:constructor)) message)
1033  (defstruct (:file (:type list) :named (:constructor)) name)  
1034  (defstruct (:buffer (:type list) :named (:constructor)) name)  ;;; Valid content for BUFFER slot
1035    (defstruct (:file       (:type list) :named (:constructor)) name)
1036    (defstruct (:buffer     (:type list) :named (:constructor)) name)
1037    (defstruct (:etags-file (:type list) :named (:constructor)) filename)
1038    
1039    ;;; Valid content for POSITION slot
1040  (defstruct (:position (:type list) :named (:constructor)) pos)  (defstruct (:position (:type list) :named (:constructor)) pos)
1041    (defstruct (:tag      (:type list) :named (:constructor)) tag1 tag2)
1042    
1043    (defmacro converting-errors-to-error-location (&body body)
1044      "Catches errors during BODY and converts them to an error location."
1045      (let ((gblock (gensym "CONVERTING-ERRORS+")))
1046        `(block ,gblock
1047           (handler-bind ((error
1048                           #'(lambda (e)
1049                                (if *debug-swank-backend*
1050                                    nil     ;decline
1051                                    (return-from ,gblock
1052                                      (make-error-location e))))))
1053             ,@body))))
1054    
1055    (defun make-error-location (datum &rest args)
1056      (cond ((typep datum 'condition)
1057             `(:error ,(format nil "Error: ~A" datum)))
1058            ((symbolp datum)
1059             `(:error ,(format nil "Error: ~A" (apply #'make-condition datum args))))
1060            (t
1061             (assert (stringp datum))
1062             `(:error ,(apply #'format nil datum args)))))
1063    
1064  (definterface find-definitions (name)  (definterface find-definitions (name)
1065     "Return a list ((DSPEC LOCATION) ...) for NAME's definitions.     "Return a list ((DSPEC LOCATION) ...) for NAME's definitions.
# Line 615  definition, e.g., FOO or (METHOD FOO (ST Line 1072  definition, e.g., FOO or (METHOD FOO (ST
1072    
1073  LOCATION is the source location for the definition.")  LOCATION is the source location for the definition.")
1074    
1075    (definterface find-source-location (object)
1076      "Returns the source location of OBJECT, or NIL.
1077    
1078    That is the source location of the underlying datastructure of
1079    OBJECT. E.g. on a STANDARD-OBJECT, the source location of the
1080    respective DEFCLASS definition is returned, on a STRUCTURE-CLASS the
1081    respective DEFSTRUCT definition, and so on."
1082      ;; This returns one source location and not a list of locations. It's
1083      ;; supposed to return the location of the DEFGENERIC definition on
1084      ;; #'SOME-GENERIC-FUNCTION.
1085      (declare (ignore object))
1086      (make-error-location "FIND-DEFINITIONS is not yet implemented on ~
1087                            this implementation."))
1088    
1089    
1090  (definterface buffer-first-change (filename)  (definterface buffer-first-change (filename)
1091    "Called for effect the first time FILENAME's buffer is modified."    "Called for effect the first time FILENAME's buffer is modified."
1092    (declare (ignore filename))    (declare (ignore filename))
1093    nil)    nil)
1094    
1095    
1096    
1097  ;;;; XREF  ;;;; XREF
1098    
1099  (definterface who-calls (function-name)  (definterface who-calls (function-name)
1100    "Return the call sites of FUNCTION-NAME (a symbol).    "Return the call sites of FUNCTION-NAME (a symbol).
1101  The results is a list ((DSPEC LOCATION) ...).")  The results is a list ((DSPEC LOCATION) ...)."
1102      (declare (ignore function-name))
1103      :not-implemented)
1104    
1105  (definterface calls-who (function-name)  (definterface calls-who (function-name)
1106    "Return the call sites of FUNCTION-NAME (a symbol).    "Return the call sites of FUNCTION-NAME (a symbol).
1107  The results is a list ((DSPEC LOCATION) ...).")  The results is a list ((DSPEC LOCATION) ...)."
1108      (declare (ignore function-name))
1109      :not-implemented)
1110    
1111  (definterface who-references (variable-name)  (definterface who-references (variable-name)
1112    "Return the locations where VARIABLE-NAME (a symbol) is referenced.    "Return the locations where VARIABLE-NAME (a symbol) is referenced.
1113  See WHO-CALLS for a description of the return value.")  See WHO-CALLS for a description of the return value."
1114      (declare (ignore variable-name))
1115      :not-implemented)
1116    
1117  (definterface who-binds (variable-name)  (definterface who-binds (variable-name)
1118    "Return the locations where VARIABLE-NAME (a symbol) is bound.    "Return the locations where VARIABLE-NAME (a symbol) is bound.
1119  See WHO-CALLS for a description of the return value.")  See WHO-CALLS for a description of the return value."
1120      (declare (ignore variable-name))
1121      :not-implemented)
1122    
1123  (definterface who-sets (variable-name)  (definterface who-sets (variable-name)
1124    "Return the locations where VARIABLE-NAME (a symbol) is set.    "Return the locations where VARIABLE-NAME (a symbol) is set.
1125  See WHO-CALLS for a description of the return value.")  See WHO-CALLS for a description of the return value."
1126      (declare (ignore variable-name))
1127      :not-implemented)
1128    
1129  (definterface who-macroexpands (macro-name)  (definterface who-macroexpands (macro-name)
1130    "Return the locations where MACRO-NAME (a symbol) is expanded.    "Return the locations where MACRO-NAME (a symbol) is expanded.
1131  See WHO-CALLS for a description of the return value.")  See WHO-CALLS for a description of the return value."
1132      (declare (ignore macro-name))
1133      :not-implemented)
1134    
1135  (definterface who-specializes (class-name)  (definterface who-specializes (class-name)
1136    "Return the locations where CLASS-NAME (a symbol) is specialized.    "Return the locations where CLASS-NAME (a symbol) is specialized.
1137  See WHO-CALLS for a description of the return value.")  See WHO-CALLS for a description of the return value."
1138      (declare (ignore class-name))
1139      :not-implemented)
1140    
1141  ;;; Simpler variants.  ;;; Simpler variants.
1142    
# Line 706  themselves, that is, their dispatch func Line 1193  themselves, that is, their dispatch func
1193    
1194  ;;;; Inspector  ;;;; Inspector
1195    
1196  (defclass inspector ()  (defgeneric emacs-inspect (object)
1197    ()    (:documentation
   (:documentation "Super class of inspector objects.  
   
 Implementations should sub class in order to dispatch off of the  
 inspect-for-emacs method."))  
   
 (definterface make-default-inspector ()  
   "Return an inspector object suitable for passing to inspect-for-emacs.")  
   
 (definterface inspect-for-emacs (object inspector)  
1198     "Explain to Emacs how to inspect OBJECT.     "Explain to Emacs how to inspect OBJECT.
1199    
1200  The argument INSPECTOR is an object representing how to get at  Returns a list specifying how to render the object for inspection.
 the internals of OBJECT, it is usually an implementation specific  
 class used simply for dispatching to the proper method.  
   
 The orgument INSPECTION-MODE is an object specifying how, and  
 what, to show to the user.  
   
 Returns two values: a string which will be used as the title of  
 the inspector buffer and a list specifying how to render the  
 object for inspection.  
1201    
1202  Every element of the list must be either a string, which will be  Every element of the list must be either a string, which will be
1203  inserted into the buffer as is, or a list of the form:  inserted into the buffer as is, or a list of the form:
# Line 739  inserted into the buffer as is, or a lis Line 1208  inserted into the buffer as is, or a lis
1208    
1209   (:newline) - Render a \\n   (:newline) - Render a \\n
1210    
1211   (:action label lambda) - Render LABEL (a text string) which when   (:action label lambda &key (refresh t)) - Render LABEL (a text
1212   clicked will call LAMBDA.   string) which when clicked will call LAMBDA. If REFRESH is
1213     non-NIL the currently inspected object will be re-inspected
1214   NIL - do nothing.")   after calling the lambda.
1215    "))
1216    
1217  (defmethod inspect-for-emacs ((object t) (inspector t))  (defmethod emacs-inspect ((object t))
1218    "Generic method for inspecting any kind of object.    "Generic method for inspecting any kind of object.
1219    
1220  Since we don't know how to deal with OBJECT we simply dump the  Since we don't know how to deal with OBJECT we simply dump the
1221  output of CL:DESCRIBE."  output of CL:DESCRIBE."
   (declare (ignore inspector))  
   (values  
    "A value."  
1222     `("Type: " (:value ,(type-of object)) (:newline)     `("Type: " (:value ,(type-of object)) (:newline)
1223       "Don't know how to inspect the object, dumping output of CL:DESCRIBE:"       "Don't know how to inspect the object, dumping output of CL:DESCRIBE:"
1224       (:newline) (:newline)       (:newline) (:newline)
1225       ,(with-output-to-string (desc) (describe object desc)))))       ,(with-output-to-string (desc) (describe object desc))))
1226    
1227    (definterface eval-context (object)
1228      "Return a list of bindings corresponding to OBJECT's slots."
1229      (declare (ignore object))
1230      '())
1231    
1232  ;;; Utilities for inspector methods.  ;;; Utilities for inspector methods.
1233  ;;;  ;;;
1234  (defun label-value-line (label value)  
1235    "Create a control list which prints \"LABEL: VALUE\" in the inspector."  (defun label-value-line (label value &key (newline t))
1236    (list (princ-to-string label) ": " `(:value ,value) '(:newline)))    "Create a control list which prints \"LABEL: VALUE\" in the inspector.
1237    If NEWLINE is non-NIL a `(:newline)' is added to the result."
1238      (list* (princ-to-string label) ": " `(:value ,value)
1239             (if newline '((:newline)) nil)))
1240    
1241  (defmacro label-value-line* (&rest label-values)  (defmacro label-value-line* (&rest label-values)
1242    ` (append ,@(loop for (label value) in label-values    ` (append ,@(loop for (label value) in label-values
# Line 778  output of CL:DESCRIBE." Line 1253  output of CL:DESCRIBE."
1253  ;;; The default implementations are sufficient for non-multiprocessing  ;;; The default implementations are sufficient for non-multiprocessing
1254  ;;; implementations.  ;;; implementations.
1255    
1256  (definterface initialize-multiprocessing ()  (definterface initialize-multiprocessing (continuation)
1257     "Initialize multiprocessing, if necessary."     "Initialize multiprocessing, if necessary and then invoke CONTINUATION.
    nil)  
1258    
1259  (definterface startup-idle-and-top-level-loops ()  Depending on the impleimentaion, this function may never return."
1260    "This function is called directly through the listener, not in an RPC     (funcall continuation))
 from Emacs. This is to support interfaces such as CMUCL's  
 MP::STARTUP-IDLE-AND-TOP-LEVEL-LOOPS which does not return like a  
 normal function."  
    nil)  
1261    
1262  (definterface spawn (fn &key name)  (definterface spawn (fn &key name)
1263    "Create a new thread to call FN.")    "Create a new thread to call FN.")
# Line 796  normal function." Line 1266  normal function."
1266    "Return an Emacs-parsable object to identify THREAD.    "Return an Emacs-parsable object to identify THREAD.
1267    
1268  Ids should be comparable with equal, i.e.:  Ids should be comparable with equal, i.e.:
1269   (equal (thread-id <t1>) (thread-id <t2>)) <==> (eq <t1> <t2>)")   (equal (thread-id <t1>) (thread-id <t2>)) <==> (eq <t1> <t2>)"
1270      thread)
1271    
1272  (definterface find-thread (id)  (definterface find-thread (id)
1273    "Return the thread for ID.    "Return the thread for ID.
1274  ID should be an id previously obtained with THREAD-ID.  ID should be an id previously obtained with THREAD-ID.
1275  Can return nil if the thread no longer exists.")  Can return nil if the thread no longer exists."
1276      (declare (ignore id))
1277      (current-thread))
1278    
1279  (definterface thread-name (thread)  (definterface thread-name (thread)
1280     "Return the name of THREAD.     "Return the name of THREAD.
1281    Thread names are short strings meaningful to the user. They do not
1282  Thread names are be single-line strings and are meaningful to the  have to be unique."
 user. They do not have to be unique."  
1283     (declare (ignore thread))     (declare (ignore thread))
1284     "The One True Thread")     "The One True Thread")
1285    
# Line 816  user. They do not have to be unique." Line 1288  user. They do not have to be unique."
1288     (declare (ignore thread))     (declare (ignore thread))
1289     "")     "")
1290    
1291    (definterface thread-attributes (thread)
1292      "Return a plist of implementation-dependent attributes for THREAD"
1293      (declare (ignore thread))
1294      '())
1295    
1296  (definterface make-lock (&key name)  (definterface make-lock (&key name)
1297     "Make a lock for thread synchronization.     "Make a lock for thread synchronization.
1298  Only one thread may hold the lock (via CALL-WITH-LOCK-HELD) at a time."  Only one thread may hold the lock (via CALL-WITH-LOCK-HELD) at a time
1299    but that thread may hold it more than once."
1300     (declare (ignore name))     (declare (ignore name))
1301     :null-lock)     :null-lock)
1302    
# Line 833  Only one thread may hold the lock (via C Line 1311  Only one thread may hold the lock (via C
1311    0)    0)
1312    
1313  (definterface all-threads ()  (definterface all-threads ()
1314    "Return a list of all threads.")    "Return a fresh list of all threads."
1315      '())
1316    
1317  (definterface thread-alive-p (thread)  (definterface thread-alive-p (thread)
1318    "Test if THREAD is termintated."    "Test if THREAD is termintated."
# Line 843  Only one thread may hold the lock (via C Line 1322  Only one thread may hold the lock (via C
1322    "Cause THREAD to execute FN.")    "Cause THREAD to execute FN.")
1323    
1324  (definterface kill-thread (thread)  (definterface kill-thread (thread)
1325    "Kill THREAD."    "Terminate THREAD immediately.
1326    Don't execute unwind-protected sections, don't raise conditions.
1327    (Do not pass go, do not collect $200.)"
1328    (declare (ignore thread))    (declare (ignore thread))
1329    nil)    nil)
1330    
1331  (definterface send (thread object)  (definterface send (thread object)
1332    "Send OBJECT to thread THREAD.")    "Send OBJECT to thread THREAD.")
1333    
1334  (definterface receive ()  (definterface receive (&optional timeout)
1335    "Return the next message from current thread's mailbox.")    "Return the next message from current thread's mailbox."
1336      (receive-if (constantly t) timeout))
1337    
1338    (definterface receive-if (predicate &optional timeout)
1339      "Return the first message satisfiying PREDICATE.")
1340    
1341    (definterface set-default-initial-binding (var form)
1342      "Initialize special variable VAR by default with FORM.
1343    
1344    Some implementations initialize certain variables in each newly
1345    created thread.  This function sets the form which is used to produce
1346    the initial value."
1347      (set var (eval form)))
1348    
1349    ;; List of delayed interrupts.
1350    ;; This should only have thread-local bindings, so no init form.
1351    (defvar *pending-slime-interrupts*)
1352    
1353    (defun check-slime-interrupts ()
1354      "Execute pending interrupts if any.
1355    This should be called periodically in operations which
1356    can take a long time to complete.
1357    Return a boolean indicating whether any interrupts was processed."
1358      (when (and (boundp '*pending-slime-interrupts*)
1359                 *pending-slime-interrupts*)
1360        (funcall (pop *pending-slime-interrupts*))
1361        t))
1362    
1363    (defvar *interrupt-queued-handler* nil
1364      "Function to call on queued interrupts.
1365    Interrupts get queued when an interrupt occurs while interrupt
1366    handling is disabled.
1367    
1368    Backends can use this function to abort slow operations.")
1369    
1370    (definterface wait-for-input (streams &optional timeout)
1371      "Wait for input on a list of streams.  Return those that are ready.
1372    STREAMS is a list of streams
1373    TIMEOUT nil, t, or real number. If TIMEOUT is t, return those streams
1374    which are ready (or have reached end-of-file) without waiting.
1375    If TIMEOUT is a number and no streams is ready after TIMEOUT seconds,
1376    return nil.
1377    
1378    Return :interrupt if an interrupt occurs while waiting.")
1379    
1380    (defun wait-for-streams (streams timeout)
1381      (loop
1382       (when (check-slime-interrupts) (return :interrupt))
1383       (let ((ready (remove-if-not #'stream-readable-p streams)))
1384         (when ready (return ready)))
1385       (when timeout (return nil))
1386       (sleep 0.1)))
1387    
1388    ;; Note: Usually we can't interrupt PEEK-CHAR cleanly.
1389    (defun wait-for-one-stream (stream timeout)
1390      (ecase timeout
1391        ((nil)
1392         (cond ((check-slime-interrupts) :interrupt)
1393               (t (peek-char nil stream nil nil)
1394                  (list stream))))
1395        ((t)
1396         (let ((c (read-char-no-hang stream nil nil)))
1397           (cond (c
1398                  (unread-char c stream)
1399                  (list stream))
1400                 (t '()))))))
1401    
1402    (defun stream-readable-p (stream)
1403      (let ((c (read-char-no-hang stream nil :eof)))
1404        (cond ((not c) nil)
1405              ((eq c :eof) t)
1406              (t (unread-char c stream) t))))
1407    
1408  (definterface toggle-trace (spec)  (definterface toggle-trace (spec)
1409    "Toggle tracing of the function(s) given with SPEC.    "Toggle tracing of the function(s) given with SPEC.
# Line 873  SPEC can be: Line 1425  SPEC can be:
1425  (definterface make-weak-value-hash-table (&rest args)  (definterface make-weak-value-hash-table (&rest args)
1426    "Like MAKE-HASH-TABLE, but weak w.r.t. the values."    "Like MAKE-HASH-TABLE, but weak w.r.t. the values."
1427    (apply #'make-hash-table args))    (apply #'make-hash-table args))
1428    
1429    (definterface hash-table-weakness (hashtable)
1430      "Return nil or one of :key :value :key-or-value :key-and-value"
1431      (declare (ignore hashtable))
1432      nil)
1433    
1434    
1435    ;;;; Character names
1436    
1437    (definterface character-completion-set (prefix matchp)
1438      "Return a list of names of characters that match PREFIX."
1439      ;; Handle the standard and semi-standard characters.
1440      (loop for name in '("Newline" "Space" "Tab" "Page" "Rubout"
1441                          "Linefeed" "Return" "Backspace")
1442         when (funcall matchp prefix name)
1443         collect name))
1444    
1445    
1446    (defparameter *type-specifier-arglists*
1447      '((and                . (&rest type-specifiers))
1448        (array              . (&optional element-type dimension-spec))
1449        (base-string        . (&optional size))
1450        (bit-vector         . (&optional size))
1451        (complex            . (&optional type-specifier))
1452        (cons               . (&optional car-typespec cdr-typespec))
1453        (double-float       . (&optional lower-limit upper-limit))
1454        (eql                . (object))
1455        (float              . (&optional lower-limit upper-limit))
1456        (function           . (&optional arg-typespec value-typespec))
1457        (integer            . (&optional lower-limit upper-limit))
1458        (long-float         . (&optional lower-limit upper-limit))
1459        (member             . (&rest eql-objects))
1460        (mod                . (n))
1461        (not                . (type-specifier))
1462        (or                 . (&rest type-specifiers))
1463        (rational           . (&optional lower-limit upper-limit))
1464        (real               . (&optional lower-limit upper-limit))
1465        (satisfies          . (predicate-symbol))
1466        (short-float        . (&optional lower-limit upper-limit))
1467        (signed-byte        . (&optional size))
1468        (simple-array       . (&optional element-type dimension-spec))
1469        (simple-base-string . (&optional size))
1470        (simple-bit-vector  . (&optional size))
1471        (simple-string      . (&optional size))
1472        (single-float       . (&optional lower-limit upper-limit))
1473        (simple-vector      . (&optional size))
1474        (string             . (&optional size))
1475        (unsigned-byte      . (&optional size))
1476        (values             . (&rest typespecs))
1477        (vector             . (&optional element-type size))
1478        ))
1479    
1480    ;;; Heap dumps
1481    
1482    (definterface save-image (filename &optional restart-function)
1483      "Save a heap image to the file FILENAME.
1484    RESTART-FUNCTION, if non-nil, should be called when the image is loaded.")
1485    
1486    (definterface background-save-image (filename &key restart-function
1487                                                  completion-function)
1488      "Request saving a heap image to the file FILENAME.
1489    RESTART-FUNCTION, if non-nil, should be called when the image is loaded.
1490    COMPLETION-FUNCTION, if non-nil, should be called after saving the image.")
1491    
1492    ;;; Codepoint length
1493    
1494    (definterface codepoint-length (string)
1495      "Return the number of codepoints in STRING.
1496    With some Lisps, like cmucl, LENGTH returns the number of UTF-16 code
1497    units, but other Lisps return the number of codepoints. The slime
1498    protocol wants string lengths in terms of codepoints."
1499      (length string))
1500    
1501    ;;; Timeouts
1502    
1503    (definterface call-with-io-timeout (function &key seconds)
1504      "Calls function with the specified IO timeout."
1505      (declare (ignore seconds))
1506      (funcall function))

Legend:
Removed from v.1.94  
changed lines
  Added in v.1.213

  ViewVC Help
Powered by ViewVC 1.1.5