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

Contents of /slime/swank-backend.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.132 - (hide annotations)
Thu Apr 24 18:51:03 2008 UTC (5 years, 11 months ago) by trittweiler
Branch: MAIN
Changes since 1.131: +35 -26 lines
* swank-backend.lisp: Clarified docstrings of interface functions
  in the Debugging section.
1 lgorrie 1.85 ;;; -*- Mode: lisp; indent-tabs-mode: nil; outline-regexp: ";;;;;*" -*-
2 lgorrie 1.1 ;;;
3 lgorrie 1.13 ;;; slime-backend.lisp --- SLIME backend interface.
4 lgorrie 1.1 ;;;
5 lgorrie 1.13 ;;; Created by James Bielman in 2003. Released into the public domain.
6 lgorrie 1.85 ;;;
7     ;;;; Frontmatter
8 lgorrie 1.1 ;;;
9 lgorrie 1.13 ;;; This file defines the functions that must be implemented
10     ;;; separately for each Lisp. Each is declared as a generic function
11     ;;; for which swank-<implementation>.lisp provides methods.
12 lgorrie 1.1
13 heller 1.36 (defpackage :swank-backend
14 lgorrie 1.1 (:use :common-lisp)
15 heller 1.36 (:export #:sldb-condition
16     #:original-condition
17     #:compiler-condition
18     #:message
19     #:short-message
20     #:condition
21     #:severity
22 heller 1.124 #:with-compilation-hooks
23 heller 1.36 #:location
24     #:location-p
25     #:location-buffer
26     #:location-position
27     #:position-p
28     #:position-pos
29     #:print-output-to-string
30 mbaringer 1.42 #:quit-lisp
31 crhodes 1.62 #:references
32 mbaringer 1.67 #:unbound-slot-filler
33 trittweiler 1.120 #:declaration-arglist
34     #:type-specifier-arglist
35 mbaringer 1.67 ;; inspector related symbols
36 heller 1.128 #:emacs-inspect
37 heller 1.70 #:label-value-line
38     #:label-value-line*
39 mbaringer 1.115 #:with-struct
40 mbaringer 1.67 ))
41 lgorrie 1.1
42 mbaringer 1.65 (defpackage :swank-mop
43     (:use)
44     (:export
45     ;; classes
46     #:standard-generic-function
47     #:standard-slot-definition
48     #:standard-method
49     #:standard-class
50 mbaringer 1.68 #:eql-specializer
51     #:eql-specializer-object
52 mbaringer 1.65 ;; standard-class readers
53     #:class-default-initargs
54     #:class-direct-default-initargs
55     #:class-direct-slots
56     #:class-direct-subclasses
57     #:class-direct-superclasses
58     #:class-finalized-p
59     #:class-name
60     #:class-precedence-list
61     #:class-prototype
62     #:class-slots
63 mbaringer 1.68 #:specializer-direct-methods
64 mbaringer 1.65 ;; generic function readers
65     #:generic-function-argument-precedence-order
66     #:generic-function-declarations
67     #:generic-function-lambda-list
68     #:generic-function-methods
69     #:generic-function-method-class
70     #:generic-function-method-combination
71     #:generic-function-name
72     ;; method readers
73     #:method-generic-function
74     #:method-function
75     #:method-lambda-list
76     #:method-specializers
77     #:method-qualifiers
78     ;; slot readers
79     #:slot-definition-allocation
80     #:slot-definition-documentation
81     #:slot-definition-initargs
82     #:slot-definition-initform
83     #:slot-definition-initfunction
84     #:slot-definition-name
85     #:slot-definition-type
86     #:slot-definition-readers
87 lgorrie 1.79 #:slot-definition-writers
88 heller 1.95 #:slot-boundp-using-class
89     #:slot-value-using-class
90 alendvai 1.111 #:slot-makunbound-using-class
91 lgorrie 1.79 ;; generic function protocol
92 lgorrie 1.82 #:compute-applicable-methods-using-classes
93     #:finalize-inheritance))
94 mbaringer 1.65
95 heller 1.36 (in-package :swank-backend)
96 lgorrie 1.1
97    
98 lgorrie 1.21 ;;;; Metacode
99    
100     (defparameter *interface-functions* '()
101     "The names of all interface functions.")
102    
103     (defparameter *unimplemented-interfaces* '()
104     "List of interface functions that are not implemented.
105     DEFINTERFACE adds to this list and DEFIMPLEMENTATION removes.")
106    
107 heller 1.52 (defmacro definterface (name args documentation &rest default-body)
108 lgorrie 1.21 "Define an interface function for the backend to implement.
109 trittweiler 1.125 A function is defined with NAME, ARGS, and DOCUMENTATION. This
110     function first looks for a function to call in NAME's property list
111     that is indicated by 'IMPLEMENTATION; failing that, it looks for a
112     function indicated by 'DEFAULT. If neither is present, an error is
113     signaled.
114    
115     If a DEFAULT-BODY is supplied, then a function with the same body and
116     ARGS will be added to NAME's property list as the property indicated
117     by 'DEFAULT.
118 lgorrie 1.21
119     Backends implement these functions using DEFIMPLEMENTATION."
120 lgorrie 1.43 (check-type documentation string "a documentation string")
121 heller 1.101 (assert (every #'symbolp args) ()
122     "Complex lambda-list not supported: ~S ~S" name args)
123     (labels ((gen-default-impl ()
124     `(setf (get ',name 'default) (lambda ,args ,@default-body)))
125     (args-as-list (args)
126     (destructuring-bind (req opt key rest) (parse-lambda-list args)
127     `(,@req ,@opt
128     ,@(loop for k in key append `(,(kw k) ,k))
129     ,@(or rest '(())))))
130     (parse-lambda-list (args)
131     (parse args '(&optional &key &rest)
132     (make-array 4 :initial-element nil)))
133     (parse (args keywords vars)
134     (cond ((null args)
135     (reverse (map 'list #'reverse vars)))
136     ((member (car args) keywords)
137     (parse (cdr args) (cdr (member (car args) keywords)) vars))
138     (t (push (car args) (aref vars (length keywords)))
139     (parse (cdr args) keywords vars))))
140     (kw (s) (intern (string s) :keyword)))
141     `(progn
142     (defun ,name ,args
143     ,documentation
144     (let ((f (or (get ',name 'implementation)
145     (get ',name 'default))))
146     (cond (f (apply f ,@(args-as-list args)))
147     (t (error "~S not implementated" ',name)))))
148     (pushnew ',name *interface-functions*)
149     ,(if (null default-body)
150     `(pushnew ',name *unimplemented-interfaces*)
151     (gen-default-impl))
152     ;; see <http://www.franz.com/support/documentation/6.2/doc/pages/variables/compiler/s_cltl1-compile-file-toplevel-compatibility-p_s.htm>
153     (eval-when (:compile-toplevel :load-toplevel :execute)
154     (export ',name :swank-backend))
155     ',name)))
156 lgorrie 1.21
157     (defmacro defimplementation (name args &body body)
158 heller 1.101 (assert (every #'symbolp args) ()
159     "Complex lambda-list not supported: ~S ~S" name args)
160 heller 1.99 `(progn
161 heller 1.101 (setf (get ',name 'implementation) (lambda ,args ,@body))
162 heller 1.99 (if (member ',name *interface-functions*)
163     (setq *unimplemented-interfaces*
164     (remove ',name *unimplemented-interfaces*))
165     (warn "DEFIMPLEMENTATION of undefined interface (~S)" ',name))
166     ',name))
167 lgorrie 1.21
168     (defun warn-unimplemented-interfaces ()
169     "Warn the user about unimplemented backend features.
170     The portable code calls this function at startup."
171     (warn "These Swank interfaces are unimplemented:~% ~A"
172     (sort (copy-list *unimplemented-interfaces*) #'string<)))
173    
174 heller 1.69 (defun import-to-swank-mop (symbol-list)
175     (dolist (sym symbol-list)
176     (let* ((swank-mop-sym (find-symbol (symbol-name sym) :swank-mop)))
177     (when swank-mop-sym
178     (unintern swank-mop-sym :swank-mop))
179     (import sym :swank-mop)
180     (export sym :swank-mop))))
181    
182     (defun import-swank-mop-symbols (package except)
183     "Import the mop symbols from PACKAGE to SWANK-MOP.
184     EXCEPT is a list of symbol names which should be ignored."
185     (do-symbols (s :swank-mop)
186     (unless (member s except :test #'string=)
187     (let ((real-symbol (find-symbol (string s) package)))
188 heller 1.76 (assert real-symbol () "Symbol ~A not found in package ~A" s package)
189 heller 1.69 (unintern s :swank-mop)
190     (import real-symbol :swank-mop)
191     (export real-symbol :swank-mop)))))
192    
193 heller 1.88 (defvar *gray-stream-symbols*
194     '(:fundamental-character-output-stream
195     :stream-write-char
196     :stream-fresh-line
197     :stream-force-output
198     :stream-finish-output
199     :fundamental-character-input-stream
200     :stream-read-char
201     :stream-listen
202     :stream-unread-char
203     :stream-clear-input
204     :stream-line-column
205 jsnellman 1.90 :stream-read-char-no-hang
206     ;; STREAM-LINE-LENGTH is an extension to gray streams that's apparently
207 dcrosher 1.91 ;; supported by CMUCL, OpenMCL, SBCL and SCL.
208     #+(or cmu openmcl sbcl scl)
209 jsnellman 1.90 :stream-line-length))
210 heller 1.88
211     (defun import-from (package symbol-names &optional (to-package *package*))
212     "Import the list of SYMBOL-NAMES found in the package PACKAGE."
213     (dolist (name symbol-names)
214     (multiple-value-bind (symbol found) (find-symbol (string name) package)
215     (assert found () "Symbol ~A not found in package ~A" name package)
216     (import symbol to-package))))
217    
218 lgorrie 1.21
219 heller 1.46 ;;;; Utilities
220    
221     (defmacro with-struct ((conc-name &rest names) obj &body body)
222     "Like with-slots but works only for structs."
223     (flet ((reader (slot) (intern (concatenate 'string
224     (symbol-name conc-name)
225     (symbol-name slot))
226     (symbol-package conc-name))))
227     (let ((tmp (gensym "OO-")))
228     ` (let ((,tmp ,obj))
229     (symbol-macrolet
230     ,(loop for name in names collect
231     (typecase name
232     (symbol `(,name (,(reader name) ,tmp)))
233     (cons `(,(first name) (,(reader (second name)) ,tmp)))
234     (t (error "Malformed syntax in WITH-STRUCT: ~A" name))))
235     ,@body)))))
236 lgorrie 1.54
237    
238 lgorrie 1.13 ;;;; TCP server
239    
240 heller 1.29 (definterface create-socket (host port)
241     "Create a listening TCP socket on interface HOST and port PORT .")
242 lgorrie 1.13
243 lgorrie 1.21 (definterface local-port (socket)
244     "Return the local port number of SOCKET.")
245 lgorrie 1.1
246 lgorrie 1.21 (definterface close-socket (socket)
247     "Close the socket SOCKET.")
248 lgorrie 1.1
249 heller 1.93 (definterface accept-connection (socket &key external-format
250 dcrosher 1.97 buffering timeout)
251 heller 1.93 "Accept a client connection on the listening socket SOCKET.
252     Return a stream for the new connection.")
253 heller 1.16
254 heller 1.31 (definterface add-sigio-handler (socket fn)
255 lgorrie 1.21 "Call FN whenever SOCKET is readable.")
256 heller 1.16
257 heller 1.31 (definterface remove-sigio-handlers (socket)
258     "Remove all sigio handlers for SOCKET.")
259    
260     (definterface add-fd-handler (socket fn)
261     "Call FN when Lisp is waiting for input and SOCKET is readable.")
262    
263     (definterface remove-fd-handlers (socket)
264     "Remove all fd-handlers for SOCKET.")
265 heller 1.18
266 heller 1.36 (definterface preferred-communication-style ()
267     "Return one of the symbols :spawn, :sigio, :fd-handler, or NIL."
268     nil)
269    
270 dcrosher 1.97 (definterface set-stream-timeout (stream timeout)
271     "Set the 'stream 'timeout. The timeout is either the real number
272     specifying the timeout in seconds or 'nil for no timeout."
273     (declare (ignore stream timeout))
274     nil)
275    
276 lgorrie 1.13 ;;; Base condition for networking errors.
277 msimmons 1.50 (define-condition network-error (simple-error) ())
278 lgorrie 1.13
279 heller 1.74 (definterface emacs-connected ()
280 lgorrie 1.13 "Hook called when the first connection from Emacs is established.
281     Called from the INIT-FN of the socket server that accepts the
282     connection.
283 lgorrie 1.1
284 lgorrie 1.13 This is intended for setting up extra context, e.g. to discover
285 heller 1.74 that the calling thread is the one that interacts with Emacs."
286 mbaringer 1.73 nil)
287 lgorrie 1.1
288    
289 heller 1.20 ;;;; Unix signals
290    
291     (defconstant +sigint+ 2)
292    
293 heller 1.36 (definterface call-without-interrupts (fn)
294     "Call FN in a context where interrupts are disabled."
295     (funcall fn))
296 heller 1.20
297 heller 1.32 (definterface getpid ()
298     "Return the (Unix) process ID of this superior Lisp.")
299    
300     (definterface lisp-implementation-type-name ()
301     "Return a short name for the Lisp implementation."
302     (lisp-implementation-type))
303 heller 1.20
304 heller 1.51 (definterface default-directory ()
305     "Return the default directory."
306     (directory-namestring (truename *default-pathname-defaults*)))
307    
308 heller 1.39 (definterface set-default-directory (directory)
309     "Set the default directory.
310     This is used to resolve filenames without directory component."
311     (setf *default-pathname-defaults* (truename (merge-pathnames directory)))
312 heller 1.51 (default-directory))
313    
314     (definterface call-with-syntax-hooks (fn)
315     "Call FN with hooks to handle special syntax."
316     (funcall fn))
317 heller 1.39
318 heller 1.52 (definterface default-readtable-alist ()
319 heller 1.77 "Return a suitable initial value for SWANK:*READTABLE-ALIST*."
320 heller 1.52 '())
321    
322 heller 1.58 (definterface quit-lisp ()
323     "Exit the current lisp image.")
324    
325 heller 1.20
326 lgorrie 1.1 ;;;; Compilation
327 dbarlow 1.8
328 lgorrie 1.21 (definterface call-with-compilation-hooks (func)
329 lgorrie 1.47 "Call FUNC with hooks to record compiler conditions.")
330 lgorrie 1.13
331 vsedach 1.14 (defmacro with-compilation-hooks ((&rest ignore) &body body)
332 lgorrie 1.47 "Execute BODY as in CALL-WITH-COMPILATION-HOOKS."
333 vsedach 1.14 (declare (ignore ignore))
334 dbarlow 1.8 `(call-with-compilation-hooks (lambda () (progn ,@body))))
335 lgorrie 1.1
336 heller 1.131 (definterface swank-compile-string (string &key buffer position directory debug)
337 lgorrie 1.47 "Compile source from STRING. During compilation, compiler
338 lgorrie 1.1 conditions must be trapped and resignalled as COMPILER-CONDITIONs.
339    
340     If supplied, BUFFER and POSITION specify the source location in Emacs.
341    
342     Additionally, if POSITION is supplied, it must be added to source
343 pseibel 1.64 positions reported in compiler conditions.
344    
345     If DIRECTORY is specified it may be used by certain implementations to
346     rebind *DEFAULT-PATHNAME-DEFAULTS* which may improve the recording of
347 heller 1.131 source information.
348    
349     If DEBUG is supplied, it may be used by certain implementations to
350     compile with maximum debugging information.
351     ")
352 lgorrie 1.1
353 heller 1.109 (definterface swank-compile-file (filename load-p external-format)
354 lgorrie 1.1 "Compile FILENAME signalling COMPILE-CONDITIONs.
355 heller 1.109 If LOAD-P is true, load the file after compilation.
356     EXTERNAL-FORMAT is a value returned by find-external-format or
357     :default.")
358 lgorrie 1.1
359 heller 1.72 (deftype severity ()
360     '(member :error :read-error :warning :style-warning :note))
361 lgorrie 1.13
362     ;; Base condition type for compiler errors, warnings and notes.
363     (define-condition compiler-condition (condition)
364     ((original-condition
365     ;; The original condition thrown by the compiler if appropriate.
366     ;; May be NIL if a compiler does not report using conditions.
367     :type (or null condition)
368     :initarg :original-condition
369     :accessor original-condition)
370    
371     (severity :type severity
372     :initarg :severity
373     :accessor severity)
374    
375     (message :initarg :message
376     :accessor message)
377    
378 heller 1.30 (short-message :initarg :short-message
379     :initform nil
380     :accessor short-message)
381 crhodes 1.62
382     (references :initarg :references
383     :initform nil
384     :accessor references)
385 heller 1.30
386 lgorrie 1.13 (location :initarg :location
387     :accessor location)))
388 heller 1.30
389 heller 1.109 (definterface find-external-format (coding-system)
390     "Return a \"external file format designator\" for CODING-SYSTEM.
391     CODING-SYSTEM is Emacs-style coding system name (a string),
392     e.g. \"latin-1-unix\"."
393     (if (equal coding-system "iso-latin-1-unix")
394     :default
395     nil))
396    
397     (definterface guess-external-format (filename)
398     "Detect the external format for the file with name FILENAME.
399     Return nil if the file contains no special markers."
400     ;; Look for a Emacs-style -*- coding: ... -*- or Local Variable: section.
401     (with-open-file (s filename :if-does-not-exist nil
402     :external-format (or (find-external-format "latin-1-unix")
403     :default))
404 heller 1.110 (if s
405     (or (let* ((line (read-line s nil))
406     (p (search "-*-" line)))
407     (when p
408     (let* ((start (+ p (length "-*-")))
409     (end (search "-*-" line :start2 start)))
410     (when end
411     (%search-coding line start end)))))
412     (let* ((len (file-length s))
413     (buf (make-string (min len 3000))))
414     (file-position s (- len (length buf)))
415     (read-sequence buf s)
416     (let ((start (search "Local Variables:" buf :from-end t))
417     (end (search "End:" buf :from-end t)))
418     (and start end (< start end)
419     (%search-coding buf start end))))))))
420 heller 1.109
421     (defun %search-coding (str start end)
422     (let ((p (search "coding:" str :start2 start :end2 end)))
423     (when p
424     (incf p (length "coding:"))
425     (loop while (and (< p end)
426     (member (aref str p) '(#\space #\tab)))
427     do (incf p))
428     (let ((end (position-if (lambda (c) (find c '(#\space #\tab #\newline)))
429     str :start p)))
430     (find-external-format (subseq str p end))))))
431    
432 lgorrie 1.17
433 lgorrie 1.13 ;;;; Streams
434    
435 lgorrie 1.21 (definterface make-fn-streams (input-fn output-fn)
436 lgorrie 1.13 "Return character input and output streams backended by functions.
437     When input is needed, INPUT-FN is called with no arguments to
438     return a string.
439     When output is ready, OUTPUT-FN is called with the output as its
440     argument.
441    
442     Output should be forced to OUTPUT-FN before calling INPUT-FN.
443    
444 lgorrie 1.21 The streams are returned as two values.")
445 lgorrie 1.13
446 lgorrie 1.60 (definterface make-stream-interactive (stream)
447     "Do any necessary setup to make STREAM work interactively.
448     This is called for each stream used for interaction with the user
449     \(e.g. *standard-output*). An implementation could setup some
450     implementation-specific functions to control output flushing at the
451     like."
452 mbaringer 1.73 (declare (ignore stream))
453 lgorrie 1.60 nil)
454    
455 lgorrie 1.1
456     ;;;; Documentation
457    
458 heller 1.36 (definterface arglist (name)
459 mbaringer 1.65 "Return the lambda list for the symbol NAME. NAME can also be
460     a lisp function object, on lisps which support this.
461    
462 trittweiler 1.120 The result can be a list or the :not-available keyword if the
463     arglist cannot be determined."
464 mbaringer 1.65 (declare (ignore name))
465     :not-available)
466 heller 1.36
467 trittweiler 1.120 (defgeneric declaration-arglist (decl-identifier)
468     (:documentation
469     "Return the argument list of the declaration specifier belonging to the
470     declaration identifier DECL-IDENTIFIER. If the arglist cannot be determined,
471     the keyword :NOT-AVAILABLE is returned.
472    
473     The different SWANK backends can specialize this generic function to
474     include implementation-dependend declaration specifiers, or to provide
475     additional information on the specifiers defined in ANSI Common Lisp.")
476     (:method (decl-identifier)
477     (case decl-identifier
478     (dynamic-extent '(&rest vars))
479     (ignore '(&rest vars))
480     (ignorable '(&rest vars))
481     (special '(&rest vars))
482     (inline '(&rest function-names))
483     (notinline '(&rest function-name))
484     (optimize '(&any compilation-speed debug safety space speed))
485     (type '(type-specifier &rest args))
486     (ftype '(type-specifier &rest function-names))
487     (otherwise
488     (flet ((typespec-p (symbol) (member :type (describe-symbol-for-emacs symbol))))
489     (cond ((and (symbolp decl-identifier) (typespec-p decl-identifier))
490     '(&rest vars))
491     ((and (listp decl-identifier) (typespec-p (first decl-identifier)))
492     '(&rest vars))
493     (t :not-available)))))))
494    
495     (defgeneric type-specifier-arglist (typespec-operator)
496     (:documentation
497     "Return the argument list of the type specifier belonging to
498     TYPESPEC-OPERATOR.. If the arglist cannot be determined, the keyword
499     :NOT-AVAILABLE is returned.
500    
501     The different SWANK backends can specialize this generic function to
502     include implementation-dependend declaration specifiers, or to provide
503     additional information on the specifiers defined in ANSI Common Lisp.")
504     (:method (typespec-operator)
505     (declare (special *type-specifier-arglists*)) ; defined at end of file.
506     (typecase typespec-operator
507     (symbol (or (cdr (assoc typespec-operator *type-specifier-arglists*))
508     :not-available))
509     (t :not-available))))
510    
511 mbaringer 1.65 (definterface function-name (function)
512     "Return the name of the function object FUNCTION.
513    
514     The result is either a symbol, a list, or NIL if no function name is available."
515     (declare (ignore function))
516     nil)
517 lgorrie 1.1
518 lgorrie 1.21 (definterface macroexpand-all (form)
519 lgorrie 1.1 "Recursively expand all macros in FORM.
520 lgorrie 1.21 Return the resulting form.")
521 lgorrie 1.1
522 heller 1.94 (definterface compiler-macroexpand-1 (form &optional env)
523     "Call the compiler-macro for form.
524     If FORM is a function call for which a compiler-macro has been
525     defined, invoke the expander function using *macroexpand-hook* and
526     return the results and T. Otherwise, return the original form and
527     NIL."
528     (let ((fun (and (consp form) (compiler-macro-function (car form)))))
529     (if fun
530     (let ((result (funcall *macroexpand-hook* fun form env)))
531     (values result (not (eq result form))))
532     (values form nil))))
533    
534     (definterface compiler-macroexpand (form &optional env)
535     "Repetitively call `compiler-macroexpand-1'."
536     (labels ((frob (form expanded)
537     (multiple-value-bind (new-form newly-expanded)
538     (compiler-macroexpand-1 form env)
539     (if newly-expanded
540     (frob new-form t)
541     (values new-form expanded)))))
542     (frob form env)))
543    
544 lgorrie 1.21 (definterface describe-symbol-for-emacs (symbol)
545 lgorrie 1.1 "Return a property list describing SYMBOL.
546    
547     The property list has an entry for each interesting aspect of the
548     symbol. The recognised keys are:
549    
550 heller 1.86 :VARIABLE :FUNCTION :SETF :SPECIAL-OPERATOR :MACRO :COMPILER-MACRO
551     :TYPE :CLASS :ALIEN-TYPE :ALIEN-STRUCT :ALIEN-UNION :ALIEN-ENUM
552 lgorrie 1.1
553     The value of each property is the corresponding documentation string,
554 heller 1.86 or :NOT-DOCUMENTED. It is legal to include keys not listed here (but
555     slime-print-apropos in Emacs must know about them).
556 lgorrie 1.1
557     Properties should be included if and only if they are applicable to
558     the symbol. For example, only (and all) fbound symbols should include
559     the :FUNCTION property.
560    
561     Example:
562     \(describe-symbol-for-emacs 'vector)
563     => (:CLASS :NOT-DOCUMENTED
564     :TYPE :NOT-DOCUMENTED
565 lgorrie 1.21 :FUNCTION \"Constructs a simple-vector from the given objects.\")")
566    
567     (definterface describe-definition (name type)
568     "Describe the definition NAME of TYPE.
569     TYPE can be any value returned by DESCRIBE-SYMBOL-FOR-EMACS.
570    
571     Return a documentation string, or NIL if none is available.")
572 lgorrie 1.2
573    
574     ;;;; Debugging
575    
576 heller 1.92 (definterface install-debugger-globally (function)
577     "Install FUNCTION as the debugger for all threads/processes. This
578     usually involves setting *DEBUGGER-HOOK* and, if the implementation
579     permits, hooking into BREAK as well."
580     (setq *debugger-hook* function))
581    
582 lgorrie 1.21 (definterface call-with-debugging-environment (debugger-loop-fn)
583 lgorrie 1.2 "Call DEBUGGER-LOOP-FN in a suitable debugging environment.
584    
585     This function is called recursively at each debug level to invoke the
586     debugger loop. The purpose is to setup any necessary environment for
587     other debugger callbacks that will be called within the debugger loop.
588    
589     For example, this is a reasonable place to compute a backtrace, switch
590 lgorrie 1.21 to safe reader/printer settings, and so on.")
591 lgorrie 1.2
592 heller 1.80 (definterface call-with-debugger-hook (hook fun)
593     "Call FUN and use HOOK as debugger hook.
594    
595     HOOK should be called for both BREAK and INVOKE-DEBUGGER."
596     (let ((*debugger-hook* hook))
597     (funcall fun)))
598    
599 lgorrie 1.2 (define-condition sldb-condition (condition)
600     ((original-condition
601     :initarg :original-condition
602 heller 1.5 :accessor original-condition))
603 heller 1.63 (:report (lambda (condition stream)
604     (format stream "Condition in debugger code~@[: ~A~]"
605     (original-condition condition))))
606 lgorrie 1.2 (:documentation
607     "Wrapper for conditions that should not be debugged.
608    
609     When a condition arises from the internals of the debugger, it is not
610     desirable to debug it -- we'd risk entering an endless loop trying to
611     debug the debugger! Instead, such conditions can be reported to the
612     user without (re)entering the debugger by wrapping them as
613     `sldb-condition's."))
614    
615 trittweiler 1.132 (definterface compute-sane-restarts (condition)
616     "This is an opportunity for Lisps such as CLISP to remove
617     unwanted restarts from the output of CL:COMPUTE-RESTARTS,
618     otherwise it should simply call CL:COMPUTE-RESTARTS, which is
619     what the default implementation does."
620     (compute-restarts condition))
621    
622     ;;; The following functions in this section are supposed to be called
623     ;;; within the dynamic contour of CALL-WITH-DEBUGGING-ENVIRONMENT only.
624    
625 heller 1.36 (definterface compute-backtrace (start end)
626 trittweiler 1.132 "Returns a backtrace of the condition currently being debugged,
627     that is an ordered list consisting of frames. (What constitutes a
628     frame is implementation dependent, but PRINT-FRAME must be defined on
629     it.)
630    
631     ``Ordered list'' means that the i-th. frame is associated to the
632     frame-number i.
633 heller 1.36
634     START and END are zero-based indices constraining the number of frames
635     returned. Frame zero is defined as the frame which invoked the
636     debugger. If END is nil, return the frames from START to the end of
637     the stack.")
638 lgorrie 1.3
639 heller 1.36 (definterface print-frame (frame stream)
640     "Print frame to stream.")
641 heller 1.70
642 lgorrie 1.21 (definterface frame-source-location-for-emacs (frame-number)
643 trittweiler 1.132 "Return the source location for the frame associated to FRAME-NUMBER.")
644 lgorrie 1.3
645 lgorrie 1.21 (definterface frame-catch-tags (frame-number)
646 trittweiler 1.132 "Return a list of catch tags for being printed in a debugger stack
647     frame.")
648 lgorrie 1.3
649 lgorrie 1.21 (definterface frame-locals (frame-number)
650 trittweiler 1.132 "Return a list of ((&key NAME ID VALUE) ...) where each element of
651     the list represents a local variable in the stack frame associated to
652     FRAME-NUMBER.
653    
654     NAME, a symbol; the name of the local variable.
655    
656     ID, an integer; used as primary key for the local variable, unique
657     relatively to the frame under operation.
658    
659     value, an object; the value of the local variable.")
660    
661     (definterface frame-var-value (frame-number var-id)
662     "Return the value of the local variable associated to VAR-ID
663     relatively to the frame associated to FRAME-NUMBER.")
664 heller 1.57
665 heller 1.37 (definterface disassemble-frame (frame-number)
666     "Disassemble the code for the FRAME-NUMBER.
667     The output should be written to standard output.
668 heller 1.84 FRAME-NUMBER is a non-negative integer.")
669 heller 1.37
670 lgorrie 1.21 (definterface eval-in-frame (form frame-number)
671 lgorrie 1.3 "Evaluate a Lisp form in the lexical context of a stack frame
672 trittweiler 1.132 in the debugger.
673 lgorrie 1.3
674     FRAME-NUMBER must be a positive integer with 0 indicating the
675     frame which invoked the debugger.
676    
677     The return value is the result of evaulating FORM in the
678 lgorrie 1.21 appropriate context.")
679 heller 1.22
680     (definterface return-from-frame (frame-number form)
681     "Unwind the stack to the frame FRAME-NUMBER and return the value(s)
682     produced by evaluating FORM in the frame context to its caller.
683    
684     Execute any clean-up code from unwind-protect forms above the frame
685     during unwinding.
686    
687     Return a string describing the error if it's not possible to return
688     from the frame.")
689    
690     (definterface restart-frame (frame-number)
691     "Restart execution of the frame FRAME-NUMBER with the same arguments
692     as it was called originally.")
693 lgorrie 1.3
694 lgorrie 1.49 (definterface format-sldb-condition (condition)
695     "Format a condition for display in SLDB."
696     (princ-to-string condition))
697    
698 heller 1.69 (definterface condition-extras (condition)
699     "Return a list of extra for the debugger.
700     The allowed elements are of the form:
701 heller 1.126 (:SHOW-FRAME-SOURCE frame-number)
702     (:REFERENCES &rest refs)
703     "
704 mbaringer 1.73 (declare (ignore condition))
705 heller 1.69 '())
706    
707 heller 1.71 (definterface activate-stepping (frame-number)
708     "Prepare the frame FRAME-NUMBER for stepping.")
709 heller 1.69
710     (definterface sldb-break-on-return (frame-number)
711     "Set a breakpoint in the frame FRAME-NUMBER.")
712    
713     (definterface sldb-break-at-start (symbol)
714     "Set a breakpoint on the beginning of the function for SYMBOL.")
715 heller 1.52
716 jsnellman 1.103 (definterface sldb-stepper-condition-p (condition)
717     "Return true if SLDB was invoked due to a single-stepping condition,
718     false otherwise. "
719     (declare (ignore condition))
720     nil)
721    
722     (definterface sldb-step-into ()
723     "Step into the current single-stepper form.")
724    
725     (definterface sldb-step-next ()
726     "Step to the next form in the current function.")
727    
728     (definterface sldb-step-out ()
729     "Stop single-stepping temporarily, but resume it once the current function
730     returns.")
731 lgorrie 1.49
732 lgorrie 1.3
733 heller 1.36 ;;;; Definition finding
734    
735     (defstruct (:location (:type list) :named
736 lgorrie 1.45 (:constructor make-location
737     (buffer position &optional hints)))
738     buffer position
739     ;; Hints is a property list optionally containing:
740     ;; :snippet SOURCE-TEXT
741     ;; This is a snippet of the actual source text at the start of
742     ;; the definition, which could be used in a text search.
743     hints)
744 heller 1.36
745     (defstruct (:error (:type list) :named (:constructor)) message)
746     (defstruct (:file (:type list) :named (:constructor)) name)
747     (defstruct (:buffer (:type list) :named (:constructor)) name)
748     (defstruct (:position (:type list) :named (:constructor)) pos)
749    
750     (definterface find-definitions (name)
751     "Return a list ((DSPEC LOCATION) ...) for NAME's definitions.
752    
753 heller 1.38 NAME is a \"definition specifier\".
754 heller 1.36
755 heller 1.38 DSPEC is a \"definition specifier\" describing the
756 heller 1.36 definition, e.g., FOO or (METHOD FOO (STRING NUMBER)) or
757 heller 1.38 \(DEFVAR FOO).
758    
759     LOCATION is the source location for the definition.")
760 heller 1.36
761 trittweiler 1.130 (definterface find-source-location (object)
762     "Returns the source location of OBJECT, or NIL.
763    
764     That is the source location of the underlying datastructure of
765     OBJECT. E.g. on a STANDARD-OBJECT, the source location of the
766     respective DEFCLASS definition is returned, on a STRUCTURE-CLASS the
767     respective DEFSTRUCT definition, and so on."
768     ;; This returns _ source location and not a list of locations. It's
769     ;; supposed to return the location of the DEFGENERIC definition on
770     ;; #'SOME-GENERIC-FUNCTION.
771     )
772    
773    
774 lgorrie 1.61 (definterface buffer-first-change (filename)
775     "Called for effect the first time FILENAME's buffer is modified."
776 mbaringer 1.73 (declare (ignore filename))
777 lgorrie 1.61 nil)
778    
779 trittweiler 1.130
780 heller 1.36
781     ;;;; XREF
782    
783     (definterface who-calls (function-name)
784     "Return the call sites of FUNCTION-NAME (a symbol).
785     The results is a list ((DSPEC LOCATION) ...).")
786    
787 heller 1.81 (definterface calls-who (function-name)
788     "Return the call sites of FUNCTION-NAME (a symbol).
789     The results is a list ((DSPEC LOCATION) ...).")
790    
791 heller 1.36 (definterface who-references (variable-name)
792     "Return the locations where VARIABLE-NAME (a symbol) is referenced.
793     See WHO-CALLS for a description of the return value.")
794    
795     (definterface who-binds (variable-name)
796     "Return the locations where VARIABLE-NAME (a symbol) is bound.
797     See WHO-CALLS for a description of the return value.")
798    
799     (definterface who-sets (variable-name)
800     "Return the locations where VARIABLE-NAME (a symbol) is set.
801     See WHO-CALLS for a description of the return value.")
802    
803     (definterface who-macroexpands (macro-name)
804     "Return the locations where MACRO-NAME (a symbol) is expanded.
805     See WHO-CALLS for a description of the return value.")
806    
807     (definterface who-specializes (class-name)
808     "Return the locations where CLASS-NAME (a symbol) is specialized.
809     See WHO-CALLS for a description of the return value.")
810    
811     ;;; Simpler variants.
812    
813     (definterface list-callers (function-name)
814     "List the callers of FUNCTION-NAME.
815     This function is like WHO-CALLS except that it is expected to use
816     lower-level means. Whereas WHO-CALLS is usually implemented with
817     special compiler support, LIST-CALLERS is usually implemented by
818     groveling for constants in function objects throughout the heap.
819    
820     The return value is as for WHO-CALLS.")
821    
822     (definterface list-callees (function-name)
823     "List the functions called by FUNCTION-NAME.
824     See LIST-CALLERS for a description of the return value.")
825    
826    
827 heller 1.23 ;;;; Profiling
828    
829     ;;; The following functions define a minimal profiling interface.
830    
831     (definterface profile (fname)
832     "Marks symbol FNAME for profiling.")
833    
834     (definterface profiled-functions ()
835     "Returns a list of profiled functions.")
836    
837     (definterface unprofile (fname)
838     "Marks symbol FNAME as not profiled.")
839    
840     (definterface unprofile-all ()
841     "Marks all currently profiled functions as not profiled."
842     (dolist (f (profiled-functions))
843     (unprofile f)))
844    
845     (definterface profile-report ()
846     "Prints profile report.")
847    
848     (definterface profile-reset ()
849     "Resets profile counters.")
850    
851     (definterface profile-package (package callers-p methods)
852     "Wrap profiling code around all functions in PACKAGE. If a function
853     is already profiled, then unprofile and reprofile (useful to notice
854     function redefinition.)
855    
856     If CALLERS-P is T names have counts of the most common calling
857     functions recorded.
858    
859     When called with arguments :METHODS T, profile all methods of all
860     generic functions having names in the given package. Generic functions
861     themselves, that is, their dispatch functions, are left alone.")
862    
863    
864 heller 1.19 ;;;; Inspector
865 lgorrie 1.56
866 heller 1.128 (defgeneric emacs-inspect (object)
867 heller 1.100 (:documentation
868 heller 1.86 "Explain to Emacs how to inspect OBJECT.
869 mbaringer 1.67
870 heller 1.129 Returns a list specifying how to render the object for inspection.
871 mbaringer 1.67
872 lgorrie 1.83 Every element of the list must be either a string, which will be
873 mbaringer 1.67 inserted into the buffer as is, or a list of the form:
874    
875     (:value object &optional format) - Render an inspectable
876     object. If format is provided it must be a string and will be
877     rendered in place of the value, otherwise use princ-to-string.
878    
879     (:newline) - Render a \\n
880    
881 mbaringer 1.117 (:action label lambda &key (refresh t)) - Render LABEL (a text
882     string) which when clicked will call LAMBDA. If REFRESH is
883     non-NIL the currently inspected object will be re-inspected
884     after calling the lambda.
885 heller 1.129 "))
886 mbaringer 1.67
887 heller 1.128 (defmethod emacs-inspect ((object t))
888 mbaringer 1.67 "Generic method for inspecting any kind of object.
889    
890     Since we don't know how to deal with OBJECT we simply dump the
891     output of CL:DESCRIBE."
892 heller 1.86 `("Type: " (:value ,(type-of object)) (:newline)
893     "Don't know how to inspect the object, dumping output of CL:DESCRIBE:"
894     (:newline) (:newline)
895 heller 1.129 ,(with-output-to-string (desc) (describe object desc))))
896 heller 1.70
897 heller 1.84 ;;; Utilities for inspector methods.
898 heller 1.70 ;;;
899 mbaringer 1.118 (defun label-value-line (label value &key (newline t))
900     "Create a control list which prints \"LABEL: VALUE\" in the inspector.
901     If NEWLINE is non-NIL a `(:newline)' is added to the result."
902     (list* (princ-to-string label) ": " `(:value ,value)
903     (if newline '((:newline)) nil)))
904 heller 1.70
905     (defmacro label-value-line* (&rest label-values)
906     ` (append ,@(loop for (label value) in label-values
907     collect `(label-value-line ,label ,value))))
908 heller 1.19
909 heller 1.29 (definterface describe-primitive-type (object)
910 heller 1.35 "Return a string describing the primitive type of object."
911 heller 1.36 (declare (ignore object))
912 heller 1.35 "N/A")
913 heller 1.19
914    
915 heller 1.36 ;;;; Multithreading
916 lgorrie 1.21 ;;;
917     ;;; The default implementations are sufficient for non-multiprocessing
918     ;;; implementations.
919 lgorrie 1.9
920 mbaringer 1.106 (definterface initialize-multiprocessing (continuation)
921 heller 1.107 "Initialize multiprocessing, if necessary and then invoke CONTINUATION.
922    
923     Depending on the impleimentaion, this function may never return."
924 mbaringer 1.106 (funcall continuation))
925 lgorrie 1.9
926 lgorrie 1.21 (definterface spawn (fn &key name)
927     "Create a new thread to call FN.")
928 lgorrie 1.17
929 heller 1.58 (definterface thread-id (thread)
930     "Return an Emacs-parsable object to identify THREAD.
931    
932     Ids should be comparable with equal, i.e.:
933     (equal (thread-id <t1>) (thread-id <t2>)) <==> (eq <t1> <t2>)")
934    
935     (definterface find-thread (id)
936     "Return the thread for ID.
937     ID should be an id previously obtained with THREAD-ID.
938     Can return nil if the thread no longer exists.")
939    
940 heller 1.28 (definterface thread-name (thread)
941     "Return the name of THREAD.
942 lgorrie 1.9
943     Thread names are be single-line strings and are meaningful to the
944 lgorrie 1.21 user. They do not have to be unique."
945 heller 1.28 (declare (ignore thread))
946 lgorrie 1.21 "The One True Thread")
947 lgorrie 1.9
948 heller 1.28 (definterface thread-status (thread)
949     "Return a string describing THREAD's state."
950     (declare (ignore thread))
951     "")
952    
953 lgorrie 1.21 (definterface make-lock (&key name)
954 lgorrie 1.17 "Make a lock for thread synchronization.
955 lgorrie 1.21 Only one thread may hold the lock (via CALL-WITH-LOCK-HELD) at a time."
956 heller 1.23 (declare (ignore name))
957 lgorrie 1.21 :null-lock)
958 lgorrie 1.9
959 lgorrie 1.21 (definterface call-with-lock-held (lock function)
960     "Call FUNCTION with LOCK held, queueing if necessary."
961 heller 1.24 (declare (ignore lock)
962     (type function function))
963 lgorrie 1.21 (funcall function))
964 heller 1.25
965 nsiivola 1.98 (definterface make-recursive-lock (&key name)
966     "Make a lock for thread synchronization.
967     Only one thread may hold the lock (via CALL-WITH-RECURSIVE-LOCK-HELD)
968     at a time, but that thread may hold it more than once."
969     (cons nil (make-lock :name name)))
970    
971     (definterface call-with-recursive-lock-held (lock function)
972     "Call FUNCTION with LOCK held, queueing if necessary."
973     (if (eql (car lock) (current-thread))
974     (funcall function)
975     (call-with-lock-held (cdr lock)
976     (lambda ()
977     (unwind-protect
978     (progn
979     (setf (car lock) (current-thread))
980     (funcall function))
981     (setf (car lock) nil))))))
982    
983 heller 1.25 (definterface current-thread ()
984     "Return the currently executing thread."
985     0)
986 heller 1.28
987     (definterface all-threads ()
988     "Return a list of all threads.")
989    
990     (definterface thread-alive-p (thread)
991 heller 1.35 "Test if THREAD is termintated."
992     (member thread (all-threads)))
993 heller 1.25
994     (definterface interrupt-thread (thread fn)
995     "Cause THREAD to execute FN.")
996    
997 mbaringer 1.34 (definterface kill-thread (thread)
998     "Kill THREAD."
999     (declare (ignore thread))
1000     nil)
1001    
1002 heller 1.25 (definterface send (thread object)
1003     "Send OBJECT to thread THREAD.")
1004    
1005     (definterface receive ()
1006 heller 1.84 "Return the next message from current thread's mailbox.")
1007 mbaringer 1.78
1008 heller 1.81 (definterface toggle-trace (spec)
1009     "Toggle tracing of the function(s) given with SPEC.
1010     SPEC can be:
1011     (setf NAME) ; a setf function
1012     (:defmethod NAME QUALIFIER... (SPECIALIZER...)) ; a specific method
1013     (:defgeneric NAME) ; a generic function with all methods
1014     (:call CALLER CALLEE) ; trace calls from CALLER to CALLEE.
1015     (:labels TOPLEVEL LOCAL)
1016     (:flet TOPLEVEL LOCAL) ")
1017 mkoeppe 1.87
1018    
1019     ;;;; Weak datastructures
1020    
1021     (definterface make-weak-key-hash-table (&rest args)
1022     "Like MAKE-HASH-TABLE, but weak w.r.t. the keys."
1023     (apply #'make-hash-table args))
1024    
1025     (definterface make-weak-value-hash-table (&rest args)
1026     "Like MAKE-HASH-TABLE, but weak w.r.t. the values."
1027     (apply #'make-hash-table args))
1028 mkoeppe 1.108
1029 alendvai 1.113 (definterface hash-table-weakness (hashtable)
1030     "Return nil or one of :key :value :key-or-value :key-and-value"
1031     (declare (ignore hashtable))
1032     nil)
1033    
1034 mkoeppe 1.108
1035     ;;;; Character names
1036    
1037     (definterface character-completion-set (prefix matchp)
1038     "Return a list of names of characters that match PREFIX."
1039     ;; Handle the standard and semi-standard characters.
1040     (loop for name in '("Newline" "Space" "Tab" "Page" "Rubout"
1041     "Linefeed" "Return" "Backspace")
1042     when (funcall matchp prefix name)
1043     collect name))
1044    
1045 trittweiler 1.120
1046     (defparameter *type-specifier-arglists*
1047     '((and . (&rest type-specifiers))
1048     (array . (&optional element-type dimension-spec))
1049     (base-string . (&optional size))
1050     (bit-vector . (&optional size))
1051     (complex . (&optional type-specifier))
1052     (cons . (&optional car-typespec cdr-typespec))
1053     (double-float . (&optional lower-limit upper-limit))
1054     (eql . (object))
1055     (float . (&optional lower-limit upper-limit))
1056     (function . (&optional arg-typespec value-typespec))
1057     (integer . (&optional lower-limit upper-limit))
1058     (long-float . (&optional lower-limit upper-limit))
1059     (member . (&rest eql-objects))
1060     (mod . (n))
1061     (not . (type-specifier))
1062     (or . (&rest type-specifiers))
1063     (rational . (&optional lower-limit upper-limit))
1064     (real . (&optional lower-limit upper-limit))
1065     (satisfies . (predicate-symbol))
1066     (short-float . (&optional lower-limit upper-limit))
1067     (signed-byte . (&optional size))
1068     (simple-array . (&optional element-type dimension-spec))
1069     (simple-base-string . (&optional size))
1070     (simple-bit-vector . (&optional size))
1071     (simple-string . (&optional size))
1072     (single-float . (&optional lower-limit upper-limit))
1073     (simple-vector . (&optional size))
1074     (string . (&optional size))
1075     (unsigned-byte . (&optional size))
1076     (values . (&rest typespecs))
1077     (vector . (&optional element-type size))
1078 heller 1.121 ))

  ViewVC Help
Powered by ViewVC 1.1.5