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