comparison lisp/comint/inf-lisp.el @ 0:376386a54a3c r19-14

Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children 0293115a14e9
comparison
equal deleted inserted replaced
-1:000000000000 0:376386a54a3c
1 ;;; inf-lisp.el --- an inferior-lisp mode
2 ;;; Copyright (C) 1988, 1993, 1994 Free Software Foundation, Inc.
3
4 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
5 ;; Keywords: processes, lisp
6
7 ;; This file is part of XEmacs.
8
9 ;; XEmacs is free software; you can redistribute it and/or modify it
10 ;; under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; XEmacs is distributed in the hope that it will be useful, but
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 ;; General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with XEmacs; see the file COPYING. If not, write to the Free
21 ;; Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22
23 ;;; Synched up with: FSF 19.30.
24
25 ;;; Commentary:
26
27 ;;; Hacked from tea.el by Olin Shivers (shivers@cs.cmu.edu). 8/88
28
29 ;;; This file defines a a lisp-in-a-buffer package (inferior-lisp
30 ;;; mode) built on top of comint mode. This version is more
31 ;;; featureful, robust, and uniform than the Emacs 18 version. The
32 ;;; key bindings are also more compatible with the bindings of Hemlock
33 ;;; and Zwei (the Lisp Machine emacs).
34
35 ;;; Since this mode is built on top of the general command-interpreter-in-
36 ;;; a-buffer mode (comint mode), it shares a common base functionality,
37 ;;; and a common set of bindings, with all modes derived from comint mode.
38 ;;; This makes these modes easier to use.
39
40 ;;; For documentation on the functionality provided by comint mode, and
41 ;;; the hooks available for customizing it, see the file comint.el.
42 ;;; For further information on inferior-lisp mode, see the comments below.
43
44 ;;; Needs fixin:
45 ;;; The load-file/compile-file default mechanism could be smarter -- it
46 ;;; doesn't know about the relationship between filename extensions and
47 ;;; whether the file is source or executable. If you compile foo.lisp
48 ;;; with compile-file, then the next load-file should use foo.bin for
49 ;;; the default, not foo.lisp. This is tricky to do right, particularly
50 ;;; because the extension for executable files varies so much (.o, .bin,
51 ;;; .lbin, .mo, .vo, .ao, ...).
52 ;;;
53 ;;; It would be nice if inferior-lisp (and inferior scheme, T, ...) modes
54 ;;; had a verbose minor mode wherein sending or compiling defuns, etc.
55 ;;; would be reflected in the transcript with suitable comments, e.g.
56 ;;; ";;; redefining fact". Several ways to do this. Which is right?
57 ;;;
58 ;;; When sending text from a source file to a subprocess, the process-mark can
59 ;;; move off the window, so you can lose sight of the process interactions.
60 ;;; Maybe I should ensure the process mark is in the window when I send
61 ;;; text to the process? Switch selectable?
62
63 ;;; Code:
64
65 (require 'comint)
66 (require 'lisp-mode)
67
68
69 ;;;jwz: ilisp is better, don't ###autoload
70 (defvar inferior-lisp-filter-regexp "\\`\\s *\\(:\\(\\w\\|\\s_\\)\\)?\\s *\\'"
71 "*What not to save on inferior Lisp's input history.
72 Input matching this regexp is not saved on the input history in Inferior Lisp
73 mode. Default is whitespace followed by 0 or 1 single-letter colon-keyword
74 \(as in :a, :c, etc.)")
75
76 (defvar inferior-lisp-mode-map nil)
77 (cond ((not inferior-lisp-mode-map)
78 (setq inferior-lisp-mode-map (make-sparse-keymap))
79 (set-keymap-name inferior-lisp-mode-map 'inferior-lisp-mode-map)
80 (set-keymap-parents inferior-lisp-mode-map
81 (list comint-mode-map shared-lisp-mode-map))
82 (define-key inferior-lisp-mode-map "\C-x\C-e" 'lisp-eval-last-sexp)
83 (define-key inferior-lisp-mode-map "\C-c\C-l" 'lisp-load-file)
84 (define-key inferior-lisp-mode-map "\C-c\C-k" 'lisp-compile-file)
85 (define-key inferior-lisp-mode-map "\C-c\C-a" 'lisp-show-arglist)
86 (define-key inferior-lisp-mode-map "\C-c\C-d" 'lisp-describe-sym)
87 (define-key inferior-lisp-mode-map "\C-c\C-f"
88 'lisp-show-function-documentation)
89 (define-key inferior-lisp-mode-map "\C-c\C-v"
90 'lisp-show-variable-documentation)))
91
92 ;;; These commands augment Lisp mode, so you can process Lisp code in
93 ;;; the source files.
94 (define-key lisp-mode-map "\M-\C-x" 'lisp-eval-defun) ; Gnu convention
95 (define-key lisp-mode-map "\C-x\C-e" 'lisp-eval-last-sexp) ; Gnu convention
96 (define-key lisp-mode-map "\C-c\C-e" 'lisp-eval-defun)
97 (define-key lisp-mode-map "\C-c\C-r" 'lisp-eval-region)
98 (define-key lisp-mode-map "\C-c\C-c" 'lisp-compile-defun)
99 (define-key lisp-mode-map "\C-c\C-z" 'switch-to-lisp)
100 (define-key lisp-mode-map "\C-c\C-l" 'lisp-load-file)
101 (define-key lisp-mode-map "\C-c\C-k" 'lisp-compile-file) ; "kompile" file
102 (define-key lisp-mode-map "\C-c\C-a" 'lisp-show-arglist)
103 (define-key lisp-mode-map "\C-c\C-d" 'lisp-describe-sym)
104 (define-key lisp-mode-map "\C-c\C-f" 'lisp-show-function-documentation)
105 (define-key lisp-mode-map "\C-c\C-v" 'lisp-show-variable-documentation)
106
107 ;;; This function exists for backwards compatibility.
108 ;;; Previous versions of this package bound commands to C-c <letter>
109 ;;; bindings, which is not allowed by the gnumacs standard.
110
111 ;;; "This function binds many inferior-lisp commands to C-c <letter> bindings,
112 ;;;where they are more accessible. C-c <letter> bindings are reserved for the
113 ;;;user, so these bindings are non-standard. If you want them, you should
114 ;;;have this function called by the inferior-lisp-load-hook:
115 ;;; (setq inferior-lisp-load-hook '(inferior-lisp-install-letter-bindings))
116 ;;;You can modify this function to install just the bindings you want."
117 (defun inferior-lisp-install-letter-bindings ()
118 (define-key lisp-mode-map "\C-ce" 'lisp-eval-defun-and-go)
119 (define-key lisp-mode-map "\C-cr" 'lisp-eval-region-and-go)
120 (define-key lisp-mode-map "\C-cc" 'lisp-compile-defun-and-go)
121 (define-key lisp-mode-map "\C-cz" 'switch-to-lisp)
122 (define-key lisp-mode-map "\C-cl" 'lisp-load-file)
123 (define-key lisp-mode-map "\C-ck" 'lisp-compile-file)
124 (define-key lisp-mode-map "\C-ca" 'lisp-show-arglist)
125 (define-key lisp-mode-map "\C-cd" 'lisp-describe-sym)
126 (define-key lisp-mode-map "\C-cf" 'lisp-show-function-documentation)
127 (define-key lisp-mode-map "\C-cv" 'lisp-show-variable-documentation)
128
129 (define-key inferior-lisp-mode-map "\C-cl" 'lisp-load-file)
130 (define-key inferior-lisp-mode-map "\C-ck" 'lisp-compile-file)
131 (define-key inferior-lisp-mode-map "\C-ca" 'lisp-show-arglist)
132 (define-key inferior-lisp-mode-map "\C-cd" 'lisp-describe-sym)
133 (define-key inferior-lisp-mode-map "\C-cf" 'lisp-show-function-documentation)
134 (define-key inferior-lisp-mode-map "\C-cv"
135 'lisp-show-variable-documentation))
136
137
138 ;;;jwz: ilisp is better, don't ###autoload
139 (defvar inferior-lisp-program "lisp"
140 "*Program name for invoking an inferior Lisp with for Inferior Lisp mode.")
141
142 ;;;jwz: ilisp is better, don't ###autoload
143 (defvar inferior-lisp-load-command "(load \"%s\")\n"
144 "*Format-string for building a Lisp expression to load a file.
145 This format string should use `%s' to substitute a file name
146 and should result in a Lisp expression that will command the inferior Lisp
147 to load that file. The default works acceptably on most Lisps.
148 The string \"(progn (load \\\"%s\\\" :verbose nil :print t) (values))\\n\"
149 produces cosmetically superior output for this application,
150 but it works only in Common Lisp.")
151
152 ;;;jwz: ilisp is better, don't ###autoload
153 (defvar inferior-lisp-prompt "^[^> \n]*>+:? *"
154 "Regexp to recognise prompts in the Inferior Lisp mode.
155 Defaults to \"^[^> \\n]*>+:? *\", which works pretty good for Lucid, kcl,
156 and franz. This variable is used to initialize `comint-prompt-regexp' in the
157 Inferior Lisp buffer.
158
159 More precise choices:
160 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
161 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
162 kcl: \"^>+ *\"
163
164 This is a fine thing to set in your .emacs file.")
165
166 (defvar inferior-lisp-buffer nil "*The current inferior-lisp process buffer.
167
168 MULTIPLE PROCESS SUPPORT
169 ===========================================================================
170 To run multiple Lisp processes, you start the first up
171 with \\[inferior-lisp]. It will be in a buffer named `*inferior-lisp*'.
172 Rename this buffer with \\[rename-buffer]. You may now start up a new
173 process with another \\[inferior-lisp]. It will be in a new buffer,
174 named `*inferior-lisp*'. You can switch between the different process
175 buffers with \\[switch-to-buffer].
176
177 Commands that send text from source buffers to Lisp processes --
178 like `lisp-eval-defun' or `lisp-show-arglist' -- have to choose a process
179 to send to, when you have more than one Lisp process around. This
180 is determined by the global variable `inferior-lisp-buffer'. Suppose you
181 have three inferior Lisps running:
182 Buffer Process
183 foo inferior-lisp
184 bar inferior-lisp<2>
185 *inferior-lisp* inferior-lisp<3>
186 If you do a \\[lisp-eval-defun] command on some Lisp source code,
187 what process do you send it to?
188
189 - If you're in a process buffer (foo, bar, or *inferior-lisp*),
190 you send it to that process.
191 - If you're in some other buffer (e.g., a source file), you
192 send it to the process attached to buffer `inferior-lisp-buffer'.
193 This process selection is performed by function `inferior-lisp-proc'.
194
195 Whenever \\[inferior-lisp] fires up a new process, it resets
196 `inferior-lisp-buffer' to be the new process's buffer. If you only run
197 one process, this does the right thing. If you run multiple
198 processes, you can change `inferior-lisp-buffer' to another process
199 buffer with \\[set-variable].")
200
201 ;;;jwz: ilisp is better, don't ###autoload
202 (defvar inferior-lisp-mode-hook '()
203 "*Hook for customizing Inferior Lisp mode.")
204
205 (defun inferior-lisp-mode ()
206 "Major mode for interacting with an inferior Lisp process.
207 Runs a Lisp interpreter as a subprocess of Emacs, with Lisp I/O through an
208 Emacs buffer. Variable `inferior-lisp-program' controls which Lisp interpreter
209 is run. Variables `inferior-lisp-prompt', `inferior-lisp-filter-regexp' and
210 `inferior-lisp-load-command' can customize this mode for different Lisp
211 interpreters.
212
213 For information on running multiple processes in multiple buffers, see
214 documentation for variable `inferior-lisp-buffer'.
215
216 \\{inferior-lisp-mode-map}
217
218 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
219 `inferior-lisp-mode-hook' (in that order).
220
221 You can send text to the inferior Lisp process from other buffers containing
222 Lisp source.
223 switch-to-lisp switches the current buffer to the Lisp process buffer.
224 lisp-eval-defun sends the current defun to the Lisp process.
225 lisp-compile-defun compiles the current defun.
226 lisp-eval-region sends the current region to the Lisp process.
227 lisp-compile-region compiles the current region.
228
229 Prefixing the lisp-eval/compile-defun/region commands with
230 a \\[universal-argument] causes a switch to the Lisp process buffer after sending
231 the text.
232
233 Commands:
234 Return after the end of the process' output sends the text from the
235 end of process to point.
236 Return before the end of the process' output copies the sexp ending at point
237 to the end of the process' output, and sends it.
238 Delete converts tabs to spaces as it moves back.
239 Tab indents for Lisp; with argument, shifts rest
240 of expression rigidly with the current line.
241 C-M-q does Tab on each line starting within following expression.
242 Paragraphs are separated only by blank lines. Semicolons start comments.
243 If you accidentally suspend your process, use \\[comint-continue-subjob]
244 to continue it."
245 (interactive)
246 (comint-mode)
247 (setq comint-prompt-regexp inferior-lisp-prompt)
248 (setq major-mode 'inferior-lisp-mode)
249 (setq mode-name "Inferior Lisp")
250 (setq mode-line-process '(":%s"))
251 (lisp-mode-variables t)
252 (use-local-map inferior-lisp-mode-map) ;c-c c-k for "kompile" file
253 (setq comint-get-old-input (function lisp-get-old-input))
254 (setq comint-input-filter (function lisp-input-filter))
255 (setq comint-input-sentinel 'ignore)
256 (run-hooks 'inferior-lisp-mode-hook))
257
258 (defun lisp-get-old-input ()
259 "Return a string containing the sexp ending at point."
260 (save-excursion
261 (let ((end (point)))
262 (backward-sexp)
263 (buffer-substring (point) end))))
264
265 (defun lisp-input-filter (str)
266 "t if STR does not match `inferior-lisp-filter-regexp'."
267 (not (string-match inferior-lisp-filter-regexp str)))
268
269 ;;;jwz: ilisp is better, don't ###autoload
270 (defun inferior-lisp (cmd)
271 "Run an inferior Lisp process, input and output via buffer `*inferior-lisp*'.
272 If there is a process already running in `*inferior-lisp*', just switch
273 to that buffer.
274 With argument, allows you to edit the command line (default is value
275 of `inferior-lisp-program'). Runs the hooks from
276 `inferior-lisp-mode-hook' (after the `comint-mode-hook' is run).
277 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
278 (interactive (list (if current-prefix-arg
279 (read-string "Run lisp: " inferior-lisp-program)
280 inferior-lisp-program)))
281 (if (not (comint-check-proc "*inferior-lisp*"))
282 (let ((cmdlist (inferior-lisp-args-to-list cmd)))
283 (set-buffer (apply (function make-comint)
284 "inferior-lisp" (car cmdlist) nil (cdr cmdlist)))
285 (inferior-lisp-mode)))
286 (setq inferior-lisp-buffer "*inferior-lisp*")
287 (pop-to-buffer "*inferior-lisp*"))
288 ;;;###autoload (add-hook 'same-window-buffer-names "*inferior-lisp*")
289
290 ;;;jwz: ilisp is better, don't ###autoload
291 (define-function 'run-lisp 'inferior-lisp)
292
293 ;;; Break a string up into a list of arguments.
294 ;;; This will break if you have an argument with whitespace, as in
295 ;;; string = "-ab +c -x 'you lose'".
296 (defun inferior-lisp-args-to-list (string)
297 (let ((where (string-match "[ \t]" string)))
298 (cond ((null where) (list string))
299 ((not (= where 0))
300 (cons (substring string 0 where)
301 (inferior-lisp-args-to-list (substring string (+ 1 where)
302 (length string)))))
303 (t (let ((pos (string-match "[^ \t]" string)))
304 (if (null pos)
305 nil
306 (inferior-lisp-args-to-list (substring string pos
307 (length string)))))))))
308
309 (defun lisp-eval-region (start end &optional and-go)
310 "Send the current region to the inferior Lisp process.
311 Prefix argument means switch to the Lisp buffer afterwards."
312 (interactive "r\nP")
313 (comint-send-region (inferior-lisp-proc) start end)
314 (comint-send-string (inferior-lisp-proc) "\n")
315 (if and-go (switch-to-lisp t)))
316
317 (defun lisp-eval-defun (&optional and-go)
318 "Send the current defun to the inferior Lisp process.
319 Prefix argument means switch to the Lisp buffer afterwards."
320 (interactive "P")
321 (save-excursion
322 (end-of-defun)
323 (skip-chars-backward " \t\n\r\f") ; Makes allegro happy
324 (let ((end (point)))
325 (beginning-of-defun)
326 (lisp-eval-region (point) end)))
327 (if and-go (switch-to-lisp t)))
328
329 (defun lisp-eval-last-sexp (&optional and-go)
330 "Send the previous sexp to the inferior Lisp process.
331 Prefix argument means switch to the Lisp buffer afterwards."
332 (interactive "P")
333 (lisp-eval-region (save-excursion (backward-sexp) (point)) (point) and-go))
334
335 ;;; Common Lisp COMPILE sux.
336 (defun lisp-compile-region (start end &optional and-go)
337 "Compile the current region in the inferior Lisp process.
338 Prefix argument means switch to the Lisp buffer afterwards."
339 (interactive "r\nP")
340 (comint-send-string
341 (inferior-lisp-proc)
342 (format "(funcall (compile nil `(lambda () (progn 'compile %s))))\n"
343 (buffer-substring start end)))
344 (if and-go (switch-to-lisp t)))
345
346 (defun lisp-compile-defun (&optional and-go)
347 "Compile the current defun in the inferior Lisp process.
348 Prefix argument means switch to the Lisp buffer afterwards."
349 (interactive "P")
350 (save-excursion
351 (end-of-defun)
352 (skip-chars-backward " \t\n\r\f") ; Makes allegro happy
353 (let ((e (point)))
354 (beginning-of-defun)
355 (lisp-compile-region (point) e)))
356 (if and-go (switch-to-lisp t)))
357
358 (defun switch-to-lisp (eob-p)
359 "Switch to the inferior Lisp process buffer.
360 With argument, positions cursor at end of buffer."
361 (interactive "P")
362 (if (get-buffer inferior-lisp-buffer)
363 (pop-to-buffer inferior-lisp-buffer)
364 (error "No current inferior Lisp buffer"))
365 (cond (eob-p
366 (push-mark)
367 (goto-char (point-max)))))
368
369
370 ;;; Now that lisp-compile/eval-defun/region takes an optional prefix arg,
371 ;;; these commands are redundant. But they are kept around for the user
372 ;;; to bind if he wishes, for backwards functionality, and because it's
373 ;;; easier to type C-c e than C-u C-c C-e.
374
375 (defun lisp-eval-region-and-go (start end)
376 "Send the current region to the inferior Lisp, and switch to its buffer."
377 (interactive "r")
378 (lisp-eval-region start end t))
379
380 (defun lisp-eval-defun-and-go ()
381 "Send the current defun to the inferior Lisp, and switch to its buffer."
382 (interactive)
383 (lisp-eval-defun t))
384
385 (defun lisp-compile-region-and-go (start end)
386 "Compile the current region in the inferior Lisp, and switch to its buffer."
387 (interactive "r")
388 (lisp-compile-region start end t))
389
390 (defun lisp-compile-defun-and-go ()
391 "Compile the current defun in the inferior Lisp, and switch to its buffer."
392 (interactive)
393 (lisp-compile-defun t))
394
395 ;;; A version of the form in H. Shevis' soar-mode.el package. Less robust.
396 ;;; (defun lisp-compile-sexp (start end)
397 ;;; "Compile the s-expression bounded by START and END in the inferior lisp.
398 ;;; If the sexp isn't a DEFUN form, it is evaluated instead."
399 ;;; (cond ((looking-at "(defun\\s +")
400 ;;; (goto-char (match-end 0))
401 ;;; (let ((name-start (point)))
402 ;;; (forward-sexp 1)
403 ;;; (process-send-string "inferior-lisp"
404 ;;; (format "(compile '%s #'(lambda "
405 ;;; (buffer-substring name-start
406 ;;; (point)))))
407 ;;; (let ((body-start (point)))
408 ;;; (goto-char start) (forward-sexp 1) ; Can't use end-of-defun.
409 ;;; (process-send-region "inferior-lisp"
410 ;;; (buffer-substring body-start (point))))
411 ;;; (process-send-string "inferior-lisp" ")\n"))
412 ;;; (t (lisp-eval-region start end)))))
413 ;;;
414 ;;; (defun lisp-compile-region (start end)
415 ;;; "Each s-expression in the current region is compiled (if a DEFUN)
416 ;;; or evaluated (if not) in the inferior lisp."
417 ;;; (interactive "r")
418 ;;; (save-excursion
419 ;;; (goto-char start) (end-of-defun) (beginning-of-defun) ; error check
420 ;;; (if (< (point) start) (error "region begins in middle of defun"))
421 ;;; (goto-char start)
422 ;;; (let ((s start))
423 ;;; (end-of-defun)
424 ;;; (while (<= (point) end) ; Zip through
425 ;;; (lisp-compile-sexp s (point)) ; compiling up defun-sized chunks.
426 ;;; (setq s (point))
427 ;;; (end-of-defun))
428 ;;; (if (< s end) (lisp-compile-sexp s end)))))
429 ;;;
430 ;;; End of HS-style code
431
432
433 (defvar lisp-prev-l/c-dir/file nil
434 "Record last directory and file used in loading or compiling.
435 This holds a cons cell of the form `(DIRECTORY . FILE)'
436 describing the last `lisp-load-file' or `lisp-compile-file' command.")
437
438 (defvar lisp-source-modes '(lisp-mode)
439 "*Used to determine if a buffer contains Lisp source code.
440 If it's loaded into a buffer that is in one of these major modes, it's
441 considered a Lisp source file by `lisp-load-file' and `lisp-compile-file'.
442 Used by these commands to determine defaults.")
443
444 (defun lisp-load-file (file-name)
445 "Load a Lisp file into the inferior Lisp process."
446 (interactive (comint-get-source "Load Lisp file: " lisp-prev-l/c-dir/file
447 lisp-source-modes nil)) ; NIL because LOAD
448 ; doesn't need an exact name
449 (comint-check-source file-name) ; Check to see if buffer needs saved.
450 (setq lisp-prev-l/c-dir/file (cons (file-name-directory file-name)
451 (file-name-nondirectory file-name)))
452 (comint-send-string (inferior-lisp-proc)
453 (format inferior-lisp-load-command file-name))
454 (switch-to-lisp t))
455
456 (defun lisp-compile-file (file-name)
457 "Compile a Lisp file in the inferior Lisp process."
458 (interactive (comint-get-source "Compile Lisp file: " lisp-prev-l/c-dir/file
459 lisp-source-modes nil)) ; NIL = don't need
460 ; suffix .lisp
461 (comint-check-source file-name) ; Check to see if buffer needs saved.
462 (setq lisp-prev-l/c-dir/file (cons (file-name-directory file-name)
463 (file-name-nondirectory file-name)))
464 (comint-send-string (inferior-lisp-proc) (concat "(compile-file \""
465 file-name
466 "\"\)\n"))
467 (switch-to-lisp t))
468
469
470
471 ;;; Documentation functions: function doc, var doc, arglist, and
472 ;;; describe symbol.
473 ;;; ===========================================================================
474
475 ;;; Command strings
476 ;;; ===============
477
478 (defvar lisp-function-doc-command
479 "(let ((fn '%s))
480 (format t \"Documentation for ~a:~&~a\"
481 fn (documentation fn 'function))
482 (values))\n"
483 "Command to query inferior Lisp for a function's documentation.")
484
485 (defvar lisp-var-doc-command
486 "(let ((v '%s))
487 (format t \"Documentation for ~a:~&~a\"
488 v (documentation v 'variable))
489 (values))\n"
490 "Command to query inferior Lisp for a variable's documentation.")
491
492 (defvar lisp-arglist-command
493 "(let ((fn '%s))
494 (format t \"Arglist for ~a: ~a\" fn (arglist fn))
495 (values))\n"
496 "Command to query inferior Lisp for a function's arglist.")
497
498 (defvar lisp-describe-sym-command
499 "(describe '%s)\n"
500 "Command to query inferior Lisp for a variable's documentation.")
501
502
503 ;;; Ancillary functions
504 ;;; ===================
505
506 ;;; Reads a string from the user.
507 (defun lisp-symprompt (prompt default)
508 (list (let* ((prompt (if default
509 (format "%s (default %s): " prompt default)
510 (concat prompt ": ")))
511 (ans (read-string prompt)))
512 (if (zerop (length ans)) default ans))))
513
514
515 ;;; Adapted from function-called-at-point in help.el.
516 (defun lisp-fn-called-at-pt ()
517 "Returns the name of the function called in the current call.
518 The value is nil if it can't find one."
519 (condition-case nil
520 (save-excursion
521 (save-restriction
522 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max))
523 (backward-up-list 1)
524 (forward-char 1)
525 (let ((obj (read (current-buffer))))
526 (and (symbolp obj) obj))))
527 (error nil)))
528
529
530 ;;; Adapted from variable-at-point in help.el.
531 (defun lisp-var-at-pt ()
532 (condition-case ()
533 (save-excursion
534 (forward-sexp -1)
535 (skip-chars-forward "'")
536 (let ((obj (read (current-buffer))))
537 (and (symbolp obj) obj)))
538 (error nil)))
539
540
541 ;;; Documentation functions: fn and var doc, arglist, and symbol describe.
542 ;;; ======================================================================
543
544 (defun lisp-show-function-documentation (fn)
545 "Send a command to the inferior Lisp to give documentation for function FN.
546 See variable `lisp-function-doc-command'."
547 (interactive (lisp-symprompt "Function doc" (lisp-fn-called-at-pt)))
548 (comint-proc-query (inferior-lisp-proc)
549 (format lisp-function-doc-command fn)))
550
551 (defun lisp-show-variable-documentation (var)
552 "Send a command to the inferior Lisp to give documentation for function FN.
553 See variable `lisp-var-doc-command'."
554 (interactive (lisp-symprompt "Variable doc" (lisp-var-at-pt)))
555 (comint-proc-query (inferior-lisp-proc) (format lisp-var-doc-command var)))
556
557 (defun lisp-show-arglist (fn)
558 "Send a query to the inferior Lisp for the arglist for function FN.
559 See variable `lisp-arglist-command'."
560 (interactive (lisp-symprompt "Arglist" (lisp-fn-called-at-pt)))
561 (comint-proc-query (inferior-lisp-proc) (format lisp-arglist-command fn)))
562
563 (defun lisp-describe-sym (sym)
564 "Send a command to the inferior Lisp to describe symbol SYM.
565 See variable `lisp-describe-sym-command'."
566 (interactive (lisp-symprompt "Describe" (lisp-var-at-pt)))
567 (comint-proc-query (inferior-lisp-proc)
568 (format lisp-describe-sym-command sym)))
569
570
571 ;; "Returns the current inferior Lisp process.
572 ;; See variable `inferior-lisp-buffer'."
573 (defun inferior-lisp-proc ()
574 (let ((proc (get-buffer-process (if (eq major-mode 'inferior-lisp-mode)
575 (current-buffer)
576 inferior-lisp-buffer))))
577 (or proc
578 (error "No Lisp subprocess; see variable `inferior-lisp-buffer'"))))
579
580
581 ;;; Do the user's customization...
582 ;;;===============================
583 (defvar inferior-lisp-load-hook nil
584 "This hook is run when the library `inf-lisp' is loaded.
585 This is a good place to put keybindings.")
586
587 (run-hooks 'inferior-lisp-load-hook)
588
589 ;;; CHANGE LOG
590 ;;; ===========================================================================
591 ;;; 7/21/92 Jim Blandy
592 ;;; - Changed all uses of the cmulisp name or prefix to inferior-lisp;
593 ;;; this is now the official inferior lisp package. Use the global
594 ;;; ChangeLog from now on.
595 ;;; 5/24/90 Olin
596 ;;; - Split cmulisp and cmushell modes into separate files.
597 ;;; Not only is this a good idea, it's apparently the way it'll be rel 19.
598 ;;; - Upgraded process sends to use comint-send-string instead of
599 ;;; process-send-string.
600 ;;; - Explicit references to process "cmulisp" have been replaced with
601 ;;; (cmulisp-proc). This allows better handling of multiple process bufs.
602 ;;; - Added process query and var/function/symbol documentation
603 ;;; commands. Based on code written by Douglas Roberts.
604 ;;; - Added lisp-eval-last-sexp, bound to C-x C-e.
605 ;;;
606 ;;; 9/20/90 Olin
607 ;;; Added a save-restriction to lisp-fn-called-at-pt. This bug and fix
608 ;;; reported by Lennart Staflin.
609 ;;;
610 ;;; 3/12/90 Olin
611 ;;; - lisp-load-file and lisp-compile-file no longer switch-to-lisp.
612 ;;; Tale suggested this.
613 ;;; - Reversed this decision 7/15/91. You need the visual feedback.
614 ;;;
615 ;;; 7/25/91 Olin
616 ;;; Changed all keybindings of the form C-c <letter>. These are
617 ;;; supposed to be reserved for the user to bind. This affected
618 ;;; mainly the compile/eval-defun/region[-and-go] commands.
619 ;;; This was painful, but necessary to adhere to the gnumacs standard.
620 ;;; For some backwards compatibility, see the
621 ;;; cmulisp-install-letter-bindings
622 ;;; function.
623 ;;;
624 ;;; 8/2/91 Olin
625 ;;; - The lisp-compile/eval-defun/region commands now take a prefix arg,
626 ;;; which means switch-to-lisp after sending the text to the Lisp process.
627 ;;; This obsoletes all the -and-go commands. The -and-go commands are
628 ;;; kept around for historical reasons, and because the user can bind
629 ;;; them to key sequences shorter than C-u C-c C-<letter>.
630 ;;; - If M-x cmulisp is invoked with a prefix arg, it allows you to
631 ;;; edit the command line.
632
633 (provide 'inf-lisp)
634
635 ;;; inf-lisp.el ends here