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