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