/[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.176 by heller, Sun Jun 21 07:22:56 2009 UTC
# Line 19  Line 19 
19             #:short-message             #:short-message
20             #:condition             #:condition
21             #:severity             #:severity
22               #:with-compilation-hooks
23             #:location             #:location
24             #:location-p             #:location-p
25             #:location-buffer             #:location-buffer
# Line 29  Line 30 
30             #:quit-lisp             #:quit-lisp
31             #:references             #:references
32             #:unbound-slot-filler             #:unbound-slot-filler
33               #:declaration-arglist
34               #:type-specifier-arglist
35               ;; interrupt macro for the backend
36               #:*pending-slime-interrupts*
37               #:check-slime-interrupts
38               #:*interrupt-queued-handler*
39             ;; inspector related symbols             ;; inspector related symbols
40             #:inspector             #:emacs-inspect
            #:inspect-for-emacs  
            #:raw-inspection  
            #:fancy-inspection  
41             #:label-value-line             #:label-value-line
42             #:label-value-line*             #:label-value-line*
43    
44               #:with-struct
45             ))             ))
46    
47  (defpackage :swank-mop  (defpackage :swank-mop
# Line 84  Line 90 
90     #:slot-definition-type     #:slot-definition-type
91     #:slot-definition-readers     #:slot-definition-readers
92     #:slot-definition-writers     #:slot-definition-writers
93       #:slot-boundp-using-class
94       #:slot-value-using-class
95       #:slot-makunbound-using-class
96     ;; generic function protocol     ;; generic function protocol
97     #:compute-applicable-methods-using-classes     #:compute-applicable-methods-using-classes
98     #:finalize-inheritance))     #:finalize-inheritance))
# Line 102  DEFINTERFACE adds to this list and DEFIM Line 111  DEFINTERFACE adds to this list and DEFIM
111    
112  (defmacro definterface (name args documentation &rest default-body)  (defmacro definterface (name args documentation &rest default-body)
113    "Define an interface function for the backend to implement.    "Define an interface function for the backend to implement.
114  A generic function is defined with NAME, ARGS, and DOCUMENTATION.  A function is defined with NAME, ARGS, and DOCUMENTATION.  This
115    function first looks for a function to call in NAME's property list
116  If a DEFAULT-BODY is supplied then NO-APPLICABLE-METHOD is specialized  that is indicated by 'IMPLEMENTATION; failing that, it looks for a
117  to execute the body if the backend doesn't provide a specific  function indicated by 'DEFAULT. If neither is present, an error is
118  implementation.  signaled.
119    
120    If a DEFAULT-BODY is supplied, then a function with the same body and
121    ARGS will be added to NAME's property list as the property indicated
122    by 'DEFAULT.
123    
124  Backends implement these functions using DEFIMPLEMENTATION."  Backends implement these functions using DEFIMPLEMENTATION."
125    (check-type documentation string "a documentation string")    (check-type documentation string "a documentation string")
126    (flet ((gen-default-impl ()    (assert (every #'symbolp args) ()
127             `(defmethod ,name ,args ,@default-body)))            "Complex lambda-list not supported: ~S ~S" name args)
128      `(progn (defgeneric ,name ,args (:documentation ,documentation))    (labels ((gen-default-impl ()
129              (pushnew ',name *interface-functions*)               `(setf (get ',name 'default) (lambda ,args ,@default-body)))
130              ,(if (null default-body)             (args-as-list (args)
131                   `(pushnew ',name *unimplemented-interfaces*)               (destructuring-bind (req opt key rest) (parse-lambda-list args)
132                   (gen-default-impl))                 `(,@req ,@opt
133              ;; 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))
134              (eval-when (:compile-toplevel :load-toplevel :execute)                         ,@(or rest '(())))))
135                (export ',name :swank-backend))             (parse-lambda-list (args)
136              ',name)))               (parse args '(&optional &key &rest)
137                        (make-array 4 :initial-element nil)))
138               (parse (args keywords vars)
139                 (cond ((null args)
140                        (reverse (map 'list #'reverse vars)))
141                       ((member (car args) keywords)
142                        (parse (cdr args) (cdr (member (car args) keywords)) vars))
143                       (t (push (car args) (aref vars (length keywords)))
144                          (parse (cdr args) keywords vars))))
145               (kw (s) (intern (string s) :keyword)))
146        `(progn
147           (defun ,name ,args
148             ,documentation
149             (let ((f (or (get ',name 'implementation)
150                          (get ',name 'default))))
151               (cond (f (apply f ,@(args-as-list args)))
152                     (t (error "~S not implementated" ',name)))))
153           (pushnew ',name *interface-functions*)
154           ,(if (null default-body)
155                `(pushnew ',name *unimplemented-interfaces*)
156                (gen-default-impl))
157           ;; see <http://www.franz.com/support/documentation/6.2/doc/pages/variables/compiler/s_cltl1-compile-file-toplevel-compatibility-p_s.htm>
158           (eval-when (:compile-toplevel :load-toplevel :execute)
159             (export ',name :swank-backend))
160           ',name)))
161    
162  (defmacro defimplementation (name args &body body)  (defmacro defimplementation (name args &body body)
163    `(progn (defmethod ,name ,args ,@body)    (assert (every #'symbolp args) ()
164            (if (member ',name *interface-functions*)            "Complex lambda-list not supported: ~S ~S" name args)
165                (setq *unimplemented-interfaces*    `(progn
166                      (remove ',name *unimplemented-interfaces*))       (setf (get ',name 'implementation) (lambda ,args ,@body))
167                (warn "DEFIMPLEMENTATION of undefined interface (~S)" ',name))       (if (member ',name *interface-functions*)
168            ',name))           (setq *unimplemented-interfaces*
169                   (remove ',name *unimplemented-interfaces*))
170             (warn "DEFIMPLEMENTATION of undefined interface (~S)" ',name))
171         ',name))
172    
173  (defun warn-unimplemented-interfaces ()  (defun warn-unimplemented-interfaces ()
174    "Warn the user about unimplemented backend features.    "Warn the user about unimplemented backend features.
175  The portable code calls this function at startup."  The portable code calls this function at startup."
176    (warn "These Swank interfaces are unimplemented:~% ~A"    (let ((*print-pretty* t))
177          (sort (copy-list *unimplemented-interfaces*) #'string<)))      (warn "These Swank interfaces are unimplemented:~% ~:<~{~A~^ ~:_~}~:>"
178              (list (sort (copy-list *unimplemented-interfaces*) #'string<)))))
179    
180  (defun import-to-swank-mop (symbol-list)  (defun import-to-swank-mop (symbol-list)
181    (dolist (sym symbol-list)    (dolist (sym symbol-list)
# Line 158  EXCEPT is a list of symbol names which s Line 199  EXCEPT is a list of symbol names which s
199  (defvar *gray-stream-symbols*  (defvar *gray-stream-symbols*
200    '(:fundamental-character-output-stream    '(:fundamental-character-output-stream
201      :stream-write-char      :stream-write-char
202        :stream-write-string
203      :stream-fresh-line      :stream-fresh-line
204      :stream-force-output      :stream-force-output
205      :stream-finish-output      :stream-finish-output
206      :fundamental-character-input-stream      :fundamental-character-input-stream
207      :stream-read-char      :stream-read-char
208        :stream-peek-char
209        :stream-read-line
210        ;; STREAM-FILE-POSITION is not available on all implementations, or
211        ;; partially under a different name.
212        ; :stream-file-posiion
213      :stream-listen      :stream-listen
214      :stream-unread-char      :stream-unread-char
215      :stream-clear-input      :stream-clear-input
# Line 199  EXCEPT is a list of symbol names which s Line 246  EXCEPT is a list of symbol names which s
246                       (t (error "Malformed syntax in WITH-STRUCT: ~A" name))))                       (t (error "Malformed syntax in WITH-STRUCT: ~A" name))))
247            ,@body)))))            ,@body)))))
248    
249    (defun with-symbol (name package)
250      "Generate a form suitable for testing with #+."
251      (if (find-symbol (string name) (string package))
252          '(:and)
253          '(:or)))
254    
255    
256  ;;;; TCP server  ;;;; TCP server
257    
# Line 212  EXCEPT is a list of symbol names which s Line 265  EXCEPT is a list of symbol names which s
265    "Close the socket SOCKET.")    "Close the socket SOCKET.")
266    
267  (definterface accept-connection (socket &key external-format  (definterface accept-connection (socket &key external-format
268                                          buffering)                                          buffering timeout)
269     "Accept a client connection on the listening socket SOCKET.     "Accept a client connection on the listening socket SOCKET.
270  Return a stream for the new connection.")  Return a stream for the new connection.")
271    
# Line 232  Return a stream for the new connection." Line 285  Return a stream for the new connection."
285    "Return one of the symbols :spawn, :sigio, :fd-handler, or NIL."    "Return one of the symbols :spawn, :sigio, :fd-handler, or NIL."
286    nil)    nil)
287    
288    (definterface set-stream-timeout (stream timeout)
289      "Set the 'stream 'timeout.  The timeout is either the real number
290      specifying the timeout in seconds or 'nil for no timeout."
291      (declare (ignore stream timeout))
292      nil)
293    
294  ;;; Base condition for networking errors.  ;;; Base condition for networking errors.
295  (define-condition network-error (simple-error) ())  (define-condition network-error (simple-error) ())
296    
# Line 256  that the calling thread is the one that Line 315  that the calling thread is the one that
315  (definterface getpid ()  (definterface getpid ()
316    "Return the (Unix) process ID of this superior Lisp.")    "Return the (Unix) process ID of this superior Lisp.")
317    
318    (definterface install-sigint-handler (function)
319      "Call FUNCTION on SIGINT (instead of invoking the debugger).
320    Return old signal handler."
321      (declare (ignore function))
322      nil)
323    
324    (definterface call-with-user-break-handler (handler function)
325      "Install the break handler HANDLER while executing FUNCTION."
326      (let ((old-handler (install-sigint-handler handler)))
327        (unwind-protect (funcall function)
328          (install-sigint-handler old-handler))))
329    
330    (definterface quit-lisp ()
331      "Exit the current lisp image.")
332    
333  (definterface lisp-implementation-type-name ()  (definterface lisp-implementation-type-name ()
334    "Return a short name for the Lisp implementation."    "Return a short name for the Lisp implementation."
335    (lisp-implementation-type))    (lisp-implementation-type))
336    
337    
338    ;; pathnames are sooo useless
339    
340    (definterface filename-to-pathname (filename)
341      "Return a pathname for FILENAME.
342    A filename in Emacs may for example contain asterisks which should not
343    be translated to wildcards."
344      (parse-namestring filename))
345    
346    (definterface pathname-to-filename (pathname)
347      "Return the filename for PATHNAME."
348      (namestring pathname))
349    
350  (definterface default-directory ()  (definterface default-directory ()
351    "Return the default directory."    "Return the default directory."
352    (directory-namestring (truename *default-pathname-defaults*)))    (directory-namestring (truename *default-pathname-defaults*)))
# Line 270  This is used to resolve filenames withou Line 357  This is used to resolve filenames withou
357    (setf *default-pathname-defaults* (truename (merge-pathnames directory)))    (setf *default-pathname-defaults* (truename (merge-pathnames directory)))
358    (default-directory))    (default-directory))
359    
360    
361  (definterface call-with-syntax-hooks (fn)  (definterface call-with-syntax-hooks (fn)
362    "Call FN with hooks to handle special syntax."    "Call FN with hooks to handle special syntax."
363    (funcall fn))    (funcall fn))
# Line 278  This is used to resolve filenames withou Line 366  This is used to resolve filenames withou
366    "Return a suitable initial value for SWANK:*READTABLE-ALIST*."    "Return a suitable initial value for SWANK:*READTABLE-ALIST*."
367    '())    '())
368    
 (definterface quit-lisp ()  
   "Exit the current lisp image.")  
   
369    
370  ;;;; Compilation  ;;;; Compilation
371    
# Line 292  This is used to resolve filenames withou Line 377  This is used to resolve filenames withou
377    (declare (ignore ignore))    (declare (ignore ignore))
378    `(call-with-compilation-hooks (lambda () (progn ,@body))))    `(call-with-compilation-hooks (lambda () (progn ,@body))))
379    
380  (definterface swank-compile-string (string &key buffer position directory)  (definterface swank-compile-string (string &key buffer position filename
381    "Compile source from STRING.  During compilation, compiler                                             policy)
382  conditions must be trapped and resignalled as COMPILER-CONDITIONs.    "Compile source from STRING.
383    During compilation, compiler conditions must be trapped and
384    resignalled as COMPILER-CONDITIONs.
385    
386  If supplied, BUFFER and POSITION specify the source location in Emacs.  If supplied, BUFFER and POSITION specify the source location in Emacs.
387    
388  Additionally, if POSITION is supplied, it must be added to source  Additionally, if POSITION is supplied, it must be added to source
389  positions reported in compiler conditions.  positions reported in compiler conditions.
390    
391  If DIRECTORY is specified it may be used by certain implementations to  If FILENAME is specified it may be used by certain implementations to
392  rebind *DEFAULT-PATHNAME-DEFAULTS* which may improve the recording of  rebind *DEFAULT-PATHNAME-DEFAULTS* which may improve the recording of
393  source information.")  source information.
394    
395  (definterface operate-on-system (system-name operation-name &rest keyword-args)  If POLICY is supplied, and non-NIL, it may be used by certain
396    "Perform OPERATION-NAME on SYSTEM-NAME using ASDF.  implementations to compile with a debug optimization quality of its
397  The KEYWORD-ARGS are passed on to the operation.  value.
398  Example:  
399  \(operate-on-system \"SWANK\" \"COMPILE-OP\" :force t)"  Should return T on successfull compilation, NIL otherwise.
400    (unless (member :asdf *features*)  ")
401      (error "ASDF is not loaded."))  
402    (with-compilation-hooks ()  (definterface swank-compile-file (input-file output-file load-p
403      (let ((operate (find-symbol "OPERATE" :asdf))                                               external-format)
404            (operation (find-symbol operation-name :asdf)))     "Compile INPUT-FILE signalling COMPILE-CONDITIONs.
405        (when (null operation)  If LOAD-P is true, load the file after compilation.
406          (error "Couldn't find ASDF operation ~S" operation-name))  EXTERNAL-FORMAT is a value returned by find-external-format or
407        (apply operate operation system-name keyword-args))))  :default.
408    
409  (definterface swank-compile-file (filename load-p &optional external-format)  Should return OUTPUT-TRUENAME, WARNINGS-P and FAILURE-p
410     "Compile FILENAME signalling COMPILE-CONDITIONs.  like `compile-file'")
 If LOAD-P is true, load the file after compilation.")  
411    
412  (deftype severity ()  (deftype severity ()
413    '(member :error :read-error :warning :style-warning :note))    '(member :error :read-error :warning :style-warning :note))
# Line 353  If LOAD-P is true, load the file after c Line 439  If LOAD-P is true, load the file after c
439     (location :initarg :location     (location :initarg :location
440               :accessor location)))               :accessor location)))
441    
442    (definterface find-external-format (coding-system)
443      "Return a \"external file format designator\" for CODING-SYSTEM.
444    CODING-SYSTEM is Emacs-style coding system name (a string),
445    e.g. \"latin-1-unix\"."
446      (if (equal coding-system "iso-latin-1-unix")
447          :default
448          nil))
449    
450    (definterface guess-external-format (pathname)
451      "Detect the external format for the file with name pathname.
452    Return nil if the file contains no special markers."
453      ;; Look for a Emacs-style -*- coding: ... -*- or Local Variable: section.
454      (with-open-file (s pathname :if-does-not-exist nil
455                         :external-format (or (find-external-format "latin-1-unix")
456                                              :default))
457        (if s
458            (or (let* ((line (read-line s nil))
459                       (p (search "-*-" line)))
460                  (when p
461                    (let* ((start (+ p (length "-*-")))
462                           (end (search "-*-" line :start2 start)))
463                      (when end
464                        (%search-coding line start end)))))
465                (let* ((len (file-length s))
466                       (buf (make-string (min len 3000))))
467                  (file-position s (- len (length buf)))
468                  (read-sequence buf s)
469                  (let ((start (search "Local Variables:" buf :from-end t))
470                        (end (search "End:" buf :from-end t)))
471                    (and start end (< start end)
472                         (%search-coding buf start end))))))))
473    
474    (defun %search-coding (str start end)
475      (let ((p (search "coding:" str :start2 start :end2 end)))
476        (when p
477          (incf p (length "coding:"))
478          (loop while (and (< p end)
479                           (member (aref str p) '(#\space #\tab)))
480                do (incf p))
481          (let ((end (position-if (lambda (c) (find c '(#\space #\tab #\newline)))
482                                  str :start p)))
483            (find-external-format (subseq str p end))))))
484    
485    
486  ;;;; Streams  ;;;; Streams
487    
488  (definterface make-fn-streams (input-fn output-fn)  (definterface make-output-stream (write-string)
489     "Return character input and output streams backended by functions.    "Return a new character output stream.
490  When input is needed, INPUT-FN is called with no arguments to  The stream calls WRITE-STRING when output is ready.")
491  return a string.  
492  When output is ready, OUTPUT-FN is called with the output as its  (definterface make-input-stream (read-string)
493  argument.    "Return a new character input stream.
494    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)  
495    
496    
497  ;;;; Documentation  ;;;; Documentation
# Line 383  like." Line 500  like."
500     "Return the lambda list for the symbol NAME. NAME can also be     "Return the lambda list for the symbol NAME. NAME can also be
501  a lisp function object, on lisps which support this.  a lisp function object, on lisps which support this.
502    
503  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
504  cannot be determined."  arglist cannot be determined."
505     (declare (ignore name))     (declare (ignore name))
506     :not-available)     :not-available)
507    
508    (defgeneric declaration-arglist (decl-identifier)
509      (:documentation
510       "Return the argument list of the declaration specifier belonging to the
511    declaration identifier DECL-IDENTIFIER. If the arglist cannot be determined,
512    the keyword :NOT-AVAILABLE is returned.
513    
514    The different SWANK backends can specialize this generic function to
515    include implementation-dependend declaration specifiers, or to provide
516    additional information on the specifiers defined in ANSI Common Lisp.")
517      (:method (decl-identifier)
518        (case decl-identifier
519          (dynamic-extent '(&rest vars))
520          (ignore         '(&rest vars))
521          (ignorable      '(&rest vars))
522          (special        '(&rest vars))
523          (inline         '(&rest function-names))
524          (notinline      '(&rest function-names))
525          (declaration    '(&rest names))
526          (optimize       '(&any compilation-speed debug safety space speed))
527          (type           '(type-specifier &rest args))
528          (ftype          '(type-specifier &rest function-names))
529          (otherwise
530           (flet ((typespec-p (symbol) (member :type (describe-symbol-for-emacs symbol))))
531             (cond ((and (symbolp decl-identifier) (typespec-p decl-identifier))
532                    '(&rest vars))
533                   ((and (listp decl-identifier) (typespec-p (first decl-identifier)))
534                    '(&rest vars))
535                   (t :not-available)))))))
536    
537    (defgeneric type-specifier-arglist (typespec-operator)
538      (:documentation
539       "Return the argument list of the type specifier belonging to
540    TYPESPEC-OPERATOR.. If the arglist cannot be determined, the keyword
541    :NOT-AVAILABLE is returned.
542    
543    The different SWANK backends can specialize this generic function to
544    include implementation-dependend declaration specifiers, or to provide
545    additional information on the specifiers defined in ANSI Common Lisp.")
546      (:method (typespec-operator)
547        (declare (special *type-specifier-arglists*)) ; defined at end of file.
548        (typecase typespec-operator
549          (symbol (or (cdr (assoc typespec-operator *type-specifier-arglists*))
550                      :not-available))
551          (t :not-available))))
552    
553  (definterface function-name (function)  (definterface function-name (function)
554    "Return the name of the function object FUNCTION.    "Return the name of the function object FUNCTION.
555    
# Line 421  NIL." Line 583  NIL."
583                     (values new-form expanded)))))                     (values new-form expanded)))))
584      (frob form env)))      (frob form env)))
585    
586    (definterface format-string-expand (control-string)
587      "Expand the format string CONTROL-STRING."
588      (macroexpand `(formatter ,control-string)))
589    
590  (definterface describe-symbol-for-emacs (symbol)  (definterface describe-symbol-for-emacs (symbol)
591     "Return a property list describing SYMBOL.     "Return a property list describing SYMBOL.
592    
# Line 492  debug the debugger! Instead, such condit Line 658  debug the debugger! Instead, such condit
658  user without (re)entering the debugger by wrapping them as  user without (re)entering the debugger by wrapping them as
659  `sldb-condition's."))  `sldb-condition's."))
660    
661    ;;; The following functions in this section are supposed to be called
662    ;;; within the dynamic contour of CALL-WITH-DEBUGGING-ENVIRONMENT only.
663    
664  (definterface compute-backtrace (start end)  (definterface compute-backtrace (start end)
665     "Return a list containing a backtrace of the condition current     "Returns a backtrace of the condition currently being debugged,
666  being debugged.  The results are unspecified if this function is  that is an ordered list consisting of frames. ``Ordered list''
667  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
668    backtrace.
669    
670  START and END are zero-based indices constraining the number of frames  START and END are zero-based indices constraining the number of frames
671  returned.  Frame zero is defined as the frame which invoked the  returned. Frame zero is defined as the frame which invoked the
672  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
673  the stack.")  the stack.")
674    
675  (definterface print-frame (frame stream)  (definterface print-frame (frame stream)
676    "Print frame to stream.")    "Print frame to stream.")
677    
678  (definterface frame-source-location-for-emacs (frame-number)  (definterface frame-restartable-p (frame)
679    "Return the source location for FRAME-NUMBER.")    "Is the frame FRAME restartable?.
680    Return T if `restart-frame' can safely be called on the frame."
681      (declare (ignore frame))
682      nil)
683    
684    (definterface frame-source-location (frame-number)
685      "Return the source location for the frame associated to FRAME-NUMBER.")
686    
687  (definterface frame-catch-tags (frame-number)  (definterface frame-catch-tags (frame-number)
688    "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
689  stack frame.  The results are undefined unless this is called  frame."
690  within the dynamic contour of a function defined by    (declare (ignore frame-number))
691  DEFINE-DEBUGGER-HOOK.")    '())
692    
693  (definterface frame-locals (frame-number)  (definterface frame-locals (frame-number)
694    "Return a list of XXX local variable designators define me    "Return a list of ((&key NAME ID VALUE) ...) where each element of
695  for a debugger stack frame.  The results are undefined unless  the list represents a local variable in the stack frame associated to
696  this is called within the dynamic contour of a function defined  FRAME-NUMBER.
697  by DEFINE-DEBUGGER-HOOK.")  
698    NAME, a symbol; the name of the local variable.
699  (definterface frame-var-value (frame var)  
700    "Return the value of VAR in FRAME.  ID, an integer; used as primary key for the local variable, unique
701  FRAME is the number of the frame in the backtrace.  relatively to the frame under operation.
702  VAR is the number of the variable in the frame.")  
703    value, an object; the value of the local variable.")
704    
705    (definterface frame-var-value (frame-number var-id)
706      "Return the value of the local variable associated to VAR-ID
707    relatively to the frame associated to FRAME-NUMBER.")
708    
709  (definterface disassemble-frame (frame-number)  (definterface disassemble-frame (frame-number)
710    "Disassemble the code for the FRAME-NUMBER.    "Disassemble the code for the FRAME-NUMBER.
# Line 532  FRAME-NUMBER is a non-negative integer." Line 713  FRAME-NUMBER is a non-negative integer."
713    
714  (definterface eval-in-frame (form frame-number)  (definterface eval-in-frame (form frame-number)
715     "Evaluate a Lisp form in the lexical context of a stack frame     "Evaluate a Lisp form in the lexical context of a stack frame
716  in the debugger.  The results are undefined unless called in the  in the debugger.
 dynamic contour of a function defined by DEFINE-DEBUGGER-HOOK.  
717    
718  FRAME-NUMBER must be a positive integer with 0 indicating the  FRAME-NUMBER must be a positive integer with 0 indicating the
719  frame which invoked the debugger.  frame which invoked the debugger.
# Line 559  as it was called originally.") Line 739  as it was called originally.")
739    "Format a condition for display in SLDB."    "Format a condition for display in SLDB."
740    (princ-to-string condition))    (princ-to-string condition))
741    
 (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))  
   '())  
   
742  (definterface condition-extras (condition)  (definterface condition-extras (condition)
743    "Return a list of extra for the debugger.    "Return a list of extra for the debugger.
744  The allowed elements are of the form:  The allowed elements are of the form:
745    (:SHOW-FRAME-SOURCE frame-number)"    (:SHOW-FRAME-SOURCE frame-number)
746      (:REFERENCES &rest refs)
747    "
748    (declare (ignore condition))    (declare (ignore condition))
749    '())    '())
750    
# Line 585  The allowed elements are of the form: Line 757  The allowed elements are of the form:
757  (definterface sldb-break-at-start (symbol)  (definterface sldb-break-at-start (symbol)
758    "Set a breakpoint on the beginning of the function for SYMBOL.")    "Set a breakpoint on the beginning of the function for SYMBOL.")
759    
760    (definterface sldb-stepper-condition-p (condition)
761      "Return true if SLDB was invoked due to a single-stepping condition,
762    false otherwise. "
763      (declare (ignore condition))
764      nil)
765    
766    (definterface sldb-step-into ()
767      "Step into the current single-stepper form.")
768    
769    (definterface sldb-step-next ()
770      "Step to the next form in the current function.")
771    
772    (definterface sldb-step-out ()
773      "Stop single-stepping temporarily, but resume it once the current function
774    returns.")
775    
776    
777  ;;;; Definition finding  ;;;; Definition finding
# Line 615  definition, e.g., FOO or (METHOD FOO (ST Line 802  definition, e.g., FOO or (METHOD FOO (ST
802    
803  LOCATION is the source location for the definition.")  LOCATION is the source location for the definition.")
804    
805    (definterface find-source-location (object)
806      "Returns the source location of OBJECT, or NIL.
807    
808    That is the source location of the underlying datastructure of
809    OBJECT. E.g. on a STANDARD-OBJECT, the source location of the
810    respective DEFCLASS definition is returned, on a STRUCTURE-CLASS the
811    respective DEFSTRUCT definition, and so on."
812      ;; This returns one source location and not a list of locations. It's
813      ;; supposed to return the location of the DEFGENERIC definition on
814      ;; #'SOME-GENERIC-FUNCTION.
815      )
816    
817    
818  (definterface buffer-first-change (filename)  (definterface buffer-first-change (filename)
819    "Called for effect the first time FILENAME's buffer is modified."    "Called for effect the first time FILENAME's buffer is modified."
820    (declare (ignore filename))    (declare (ignore filename))
821    nil)    nil)
822    
823    
824    
825  ;;;; XREF  ;;;; XREF
826    
# Line 706  themselves, that is, their dispatch func Line 907  themselves, that is, their dispatch func
907    
908  ;;;; Inspector  ;;;; Inspector
909    
910  (defclass inspector ()  (defgeneric emacs-inspect (object)
911    ()    (: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)  
912     "Explain to Emacs how to inspect OBJECT.     "Explain to Emacs how to inspect OBJECT.
913    
914  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.  
915    
916  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
917  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 922  inserted into the buffer as is, or a lis
922    
923   (:newline) - Render a \\n   (:newline) - Render a \\n
924    
925   (:action label lambda) - Render LABEL (a text string) which when   (:action label lambda &key (refresh t)) - Render LABEL (a text
926   clicked will call LAMBDA.   string) which when clicked will call LAMBDA. If REFRESH is
927     non-NIL the currently inspected object will be re-inspected
928   NIL - do nothing.")   after calling the lambda.
929    "))
930    
931  (defmethod inspect-for-emacs ((object t) (inspector t))  (defmethod emacs-inspect ((object t))
932    "Generic method for inspecting any kind of object.    "Generic method for inspecting any kind of object.
933    
934  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
935  output of CL:DESCRIBE."  output of CL:DESCRIBE."
   (declare (ignore inspector))  
   (values  
    "A value."  
936     `("Type: " (:value ,(type-of object)) (:newline)     `("Type: " (:value ,(type-of object)) (:newline)
937       "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:"
938       (:newline) (:newline)       (:newline) (:newline)
939       ,(with-output-to-string (desc) (describe object desc)))))       ,(with-output-to-string (desc) (describe object desc))))
940    
941  ;;; Utilities for inspector methods.  ;;; Utilities for inspector methods.
942  ;;;  ;;;
943  (defun label-value-line (label value)  (defun label-value-line (label value &key (newline t))
944    "Create a control list which prints \"LABEL: VALUE\" in the inspector."    "Create a control list which prints \"LABEL: VALUE\" in the inspector.
945    (list (princ-to-string label) ": " `(:value ,value) '(:newline)))  If NEWLINE is non-NIL a `(:newline)' is added to the result."
946      (list* (princ-to-string label) ": " `(:value ,value)
947             (if newline '((:newline)) nil)))
948    
949  (defmacro label-value-line* (&rest label-values)  (defmacro label-value-line* (&rest label-values)
950    ` (append ,@(loop for (label value) in label-values    ` (append ,@(loop for (label value) in label-values
# Line 778  output of CL:DESCRIBE." Line 961  output of CL:DESCRIBE."
961  ;;; The default implementations are sufficient for non-multiprocessing  ;;; The default implementations are sufficient for non-multiprocessing
962  ;;; implementations.  ;;; implementations.
963    
964  (definterface initialize-multiprocessing ()  (definterface initialize-multiprocessing (continuation)
965     "Initialize multiprocessing, if necessary."     "Initialize multiprocessing, if necessary and then invoke CONTINUATION.
    nil)  
966    
967  (definterface startup-idle-and-top-level-loops ()  Depending on the impleimentaion, this function may never return."
968    "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)  
969    
970  (definterface spawn (fn &key name)  (definterface spawn (fn &key name)
971    "Create a new thread to call FN.")    "Create a new thread to call FN.")
# Line 796  normal function." Line 974  normal function."
974    "Return an Emacs-parsable object to identify THREAD.    "Return an Emacs-parsable object to identify THREAD.
975    
976  Ids should be comparable with equal, i.e.:  Ids should be comparable with equal, i.e.:
977   (equal (thread-id <t1>) (thread-id <t2>)) <==> (eq <t1> <t2>)")   (equal (thread-id <t1>) (thread-id <t2>)) <==> (eq <t1> <t2>)"
978      thread)
979    
980  (definterface find-thread (id)  (definterface find-thread (id)
981    "Return the thread for ID.    "Return the thread for ID.
982  ID should be an id previously obtained with THREAD-ID.  ID should be an id previously obtained with THREAD-ID.
983  Can return nil if the thread no longer exists.")  Can return nil if the thread no longer exists."
984      (declare (ignore id))
985      (current-thread))
986    
987  (definterface thread-name (thread)  (definterface thread-name (thread)
988     "Return the name of THREAD.     "Return the name of THREAD.
# Line 816  user. They do not have to be unique." Line 997  user. They do not have to be unique."
997     (declare (ignore thread))     (declare (ignore thread))
998     "")     "")
999    
1000    (definterface thread-description (thread)
1001      "Return a string describing THREAD."
1002      (declare (ignore thread))
1003      "")
1004    
1005    (definterface set-thread-description (thread description)
1006      "Set THREAD's description to DESCRIPTION."
1007      (declare (ignore thread description))
1008      "")
1009    
1010  (definterface make-lock (&key name)  (definterface make-lock (&key name)
1011     "Make a lock for thread synchronization.     "Make a lock for thread synchronization.
1012  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
1013    but that thread may hold it more than once."
1014     (declare (ignore name))     (declare (ignore name))
1015     :null-lock)     :null-lock)
1016    
# Line 833  Only one thread may hold the lock (via C Line 1025  Only one thread may hold the lock (via C
1025    0)    0)
1026    
1027  (definterface all-threads ()  (definterface all-threads ()
1028    "Return a list of all threads.")    "Return a fresh list of all threads.")
1029    
1030  (definterface thread-alive-p (thread)  (definterface thread-alive-p (thread)
1031    "Test if THREAD is termintated."    "Test if THREAD is termintated."
# Line 850  Only one thread may hold the lock (via C Line 1042  Only one thread may hold the lock (via C
1042  (definterface send (thread object)  (definterface send (thread object)
1043    "Send OBJECT to thread THREAD.")    "Send OBJECT to thread THREAD.")
1044    
1045  (definterface receive ()  (definterface receive (&optional timeout)
1046    "Return the next message from current thread's mailbox.")    "Return the next message from current thread's mailbox."
1047      (receive-if (constantly t) timeout))
1048    
1049    (definterface receive-if (predicate &optional timeout)
1050      "Return the first message satisfiying PREDICATE.")
1051    
1052    (definterface set-default-initial-binding (var form)
1053      "Initialize special variable VAR by default with FORM.
1054    
1055    Some implementations initialize certain variables in each newly
1056    created thread.  This function sets the form which is used to produce
1057    the initial value."
1058      (set var (eval form)))
1059    
1060    ;; List of delayed interrupts.
1061    ;; This should only have thread-local bindings, so no init form.
1062    (defvar *pending-slime-interrupts*)
1063    
1064    (defun check-slime-interrupts ()
1065      "Execute pending interrupts if any.
1066    This should be called periodically in operations which
1067    can take a long time to complete.
1068    Return a boolean indicating whether any interrupts was processed."
1069      (when (and (boundp '*pending-slime-interrupts*)
1070                 *pending-slime-interrupts*)
1071        (funcall (pop *pending-slime-interrupts*))
1072        t))
1073    
1074    (defvar *interrupt-queued-handler* nil
1075      "Function to call on queued interrupts.
1076    Interrupts get queued when an interrupt occurs while interrupt
1077    handling is disabled.
1078    
1079    Backends can use this function to abort slow operations.")
1080    
1081    (definterface wait-for-input (streams &optional timeout)
1082      "Wait for input on a list of streams.  Return those that are ready.
1083    STREAMS is a list of streams
1084    TIMEOUT nil, t, or real number. If TIMEOUT is t, return
1085    those streams which are ready immediately, without waiting.
1086    If TIMEOUT is a number and no streams is ready after TIMEOUT seconds,
1087    return nil.
1088    
1089    Return :interrupt if an interrupt occurs while waiting."
1090      (assert (member timeout '(nil t)))
1091      (cond #+(or)
1092            ((null (cdr streams))
1093             (wait-for-one-stream (car streams) timeout))
1094            (t
1095             (wait-for-streams streams timeout))))
1096    
1097    (defun wait-for-streams (streams timeout)
1098      (loop
1099       (when (check-slime-interrupts) (return :interrupt))
1100       (let ((ready (remove-if-not #'stream-readable-p streams)))
1101         (when ready (return ready)))
1102       (when timeout (return nil))
1103       (sleep 0.1)))
1104    
1105    ;; Note: Usually we can't interrupt PEEK-CHAR cleanly.
1106    (defun wait-for-one-stream (stream timeout)
1107      (ecase timeout
1108        ((nil)
1109         (cond ((check-slime-interrupts) :interrupt)
1110               (t (peek-char nil stream nil nil)
1111                  (list stream))))
1112        ((t)
1113         (let ((c (read-char-no-hang stream nil nil)))
1114           (cond (c
1115                  (unread-char c stream)
1116                  (list stream))
1117                 (t '()))))))
1118    
1119    (defun stream-readable-p (stream)
1120      (let ((c (read-char-no-hang stream nil :eof)))
1121        (cond ((not c) nil)
1122              ((eq c :eof) t)
1123              (t (unread-char c stream) t))))
1124    
1125  (definterface toggle-trace (spec)  (definterface toggle-trace (spec)
1126    "Toggle tracing of the function(s) given with SPEC.    "Toggle tracing of the function(s) given with SPEC.
# Line 873  SPEC can be: Line 1142  SPEC can be:
1142  (definterface make-weak-value-hash-table (&rest args)  (definterface make-weak-value-hash-table (&rest args)
1143    "Like MAKE-HASH-TABLE, but weak w.r.t. the values."    "Like MAKE-HASH-TABLE, but weak w.r.t. the values."
1144    (apply #'make-hash-table args))    (apply #'make-hash-table args))
1145    
1146    (definterface hash-table-weakness (hashtable)
1147      "Return nil or one of :key :value :key-or-value :key-and-value"
1148      (declare (ignore hashtable))
1149      nil)
1150    
1151    
1152    ;;;; Character names
1153    
1154    (definterface character-completion-set (prefix matchp)
1155      "Return a list of names of characters that match PREFIX."
1156      ;; Handle the standard and semi-standard characters.
1157      (loop for name in '("Newline" "Space" "Tab" "Page" "Rubout"
1158                          "Linefeed" "Return" "Backspace")
1159         when (funcall matchp prefix name)
1160         collect name))
1161    
1162    
1163    (defparameter *type-specifier-arglists*
1164      '((and                . (&rest type-specifiers))
1165        (array              . (&optional element-type dimension-spec))
1166        (base-string        . (&optional size))
1167        (bit-vector         . (&optional size))
1168        (complex            . (&optional type-specifier))
1169        (cons               . (&optional car-typespec cdr-typespec))
1170        (double-float       . (&optional lower-limit upper-limit))
1171        (eql                . (object))
1172        (float              . (&optional lower-limit upper-limit))
1173        (function           . (&optional arg-typespec value-typespec))
1174        (integer            . (&optional lower-limit upper-limit))
1175        (long-float         . (&optional lower-limit upper-limit))
1176        (member             . (&rest eql-objects))
1177        (mod                . (n))
1178        (not                . (type-specifier))
1179        (or                 . (&rest type-specifiers))
1180        (rational           . (&optional lower-limit upper-limit))
1181        (real               . (&optional lower-limit upper-limit))
1182        (satisfies          . (predicate-symbol))
1183        (short-float        . (&optional lower-limit upper-limit))
1184        (signed-byte        . (&optional size))
1185        (simple-array       . (&optional element-type dimension-spec))
1186        (simple-base-string . (&optional size))
1187        (simple-bit-vector  . (&optional size))
1188        (simple-string      . (&optional size))
1189        (single-float       . (&optional lower-limit upper-limit))
1190        (simple-vector      . (&optional size))
1191        (string             . (&optional size))
1192        (unsigned-byte      . (&optional size))
1193        (values             . (&rest typespecs))
1194        (vector             . (&optional element-type size))
1195        ))
1196    
1197    ;;; Heap dumps
1198    
1199    (definterface save-image (filename &optional restart-function)
1200      "Save a heap image to the file FILENAME.
1201    RESTART-FUNCTION, if non-nil, should be called when the image is loaded.")
1202    
1203    
1204    

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

  ViewVC Help
Powered by ViewVC 1.1.5