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