comparison lisp/packages/cmuscheme.el @ 0:376386a54a3c r19-14

Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children ac2d302a0011
comparison
equal deleted inserted replaced
-1:000000000000 0:376386a54a3c
1 ;;; cmuscheme.el --- Scheme process in a buffer. Adapted from tea.el.
2
3 ;; Copyright (C) 1988, 1994 Free Software Foundation, Inc.
4
5 ;; Author: Olin Shivers <olin.shivers@cs.cmu.edu>
6 ;; Maintainer: FSF
7 ;; Keywords: processes, lisp
8
9 ;; This file is part of XEmacs.
10
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; see the file COPYING. If not, write to the Free
23 ;; Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24
25 ;;; Synched up with: FSF 19.30.
26
27 ;;; Commentary:
28
29 ;;; This is a customisation of comint-mode (see comint.el)
30 ;;;
31 ;;; Written by Olin Shivers (olin.shivers@cs.cmu.edu). With bits and pieces
32 ;;; lifted from scheme.el, shell.el, clisp.el, newclisp.el, cobol.el, et al..
33 ;;; 8/88
34 ;;;
35 ;;; Please send me bug reports, bug fixes, and extensions, so that I can
36 ;;; merge them into the master source.
37 ;;;
38 ;;; The changelog is at the end of this file.
39 ;;;
40 ;;; NOTE: MIT Cscheme, when invoked with the -emacs flag, has a special user
41 ;;; interface that communicates process state back to the superior emacs by
42 ;;; outputting special control sequences. The gnumacs package, xscheme.el, has
43 ;;; lots and lots of special purpose code to read these control sequences, and
44 ;;; so is very tightly integrated with the cscheme process. The cscheme
45 ;;; interrupt handler and debugger read single character commands in cbreak
46 ;;; mode; when this happens, xscheme.el switches to special keymaps that bind
47 ;;; the single letter command keys to emacs functions that directly send the
48 ;;; character to the scheme process. Cmuscheme mode does *not* provide this
49 ;;; functionality. If you are a cscheme user, you may prefer to use the
50 ;;; xscheme.el/cscheme -emacs interaction.
51 ;;;
52 ;;; Here's a summary of the pros and cons, as I see them.
53 ;;; xscheme: Tightly integrated with inferior cscheme process! A few commands
54 ;;; not in cmuscheme. But. Integration is a bit of a hack. Input
55 ;;; history only keeps the immediately prior input. Bizarre
56 ;;; keybindings.
57 ;;;
58 ;;; cmuscheme: Not tightly integrated with inferior cscheme process. But.
59 ;;; Carefully integrated functionality with the entire suite of
60 ;;; comint-derived CMU process modes. Keybindings reminiscent of
61 ;;; Zwei and Hemlock. Good input history. A few commands not in
62 ;;; xscheme.
63 ;;;
64 ;;; It's a tradeoff. Pay your money; take your choice. If you use a Scheme
65 ;;; that isn't Cscheme, of course, there isn't a choice. Xscheme.el is *very*
66 ;;; Cscheme-specific; you must use cmuscheme.el. Interested parties are
67 ;;; invited to port xscheme functionality on top of comint mode...
68
69 ;;; Code:
70
71 (require 'scheme)
72 (require 'comint)
73
74 ;;; INFERIOR SCHEME MODE STUFF
75 ;;;============================================================================
76
77 (defvar inferior-scheme-mode-hook nil
78 "*Hook for customising inferior-scheme mode.")
79 (defvar inferior-scheme-mode-map nil)
80
81 (cond ((not inferior-scheme-mode-map)
82 (setq inferior-scheme-mode-map
83 (copy-keymap comint-mode-map))
84 (define-key inferior-scheme-mode-map "\M-\C-x" ;gnu convention
85 'scheme-send-definition)
86 (define-key inferior-scheme-mode-map "\C-x\C-e" 'scheme-send-last-sexp)
87 (define-key inferior-scheme-mode-map "\C-c\C-l" 'scheme-load-file)
88 (define-key inferior-scheme-mode-map "\C-c\C-k" 'scheme-compile-file)
89 (scheme-mode-commands inferior-scheme-mode-map)))
90
91 ;; Install the process communication commands in the scheme-mode keymap.
92 (define-key scheme-mode-map "\M-\C-x" 'scheme-send-definition);gnu convention
93 (define-key scheme-mode-map "\C-x\C-e" 'scheme-send-last-sexp);gnu convention
94 (define-key scheme-mode-map "\C-c\C-e" 'scheme-send-definition)
95 (define-key scheme-mode-map "\C-c\M-e" 'scheme-send-definition-and-go)
96 (define-key scheme-mode-map "\C-c\C-r" 'scheme-send-region)
97 (define-key scheme-mode-map "\C-c\M-r" 'scheme-send-region-and-go)
98 (define-key scheme-mode-map "\C-c\M-c" 'scheme-compile-definition)
99 (define-key scheme-mode-map "\C-c\C-c" 'scheme-compile-definition-and-go)
100 (define-key scheme-mode-map "\C-c\C-z" 'switch-to-scheme)
101 (define-key scheme-mode-map "\C-c\C-l" 'scheme-load-file)
102 (define-key scheme-mode-map "\C-c\C-k" 'scheme-compile-file) ;k for "kompile"
103
104 (defvar scheme-buffer)
105
106 (defun inferior-scheme-mode ()
107 "Major mode for interacting with an inferior Scheme process.
108
109 The following commands are available:
110 \\{inferior-scheme-mode-map}
111
112 A Scheme process can be fired up with M-x run-scheme.
113
114 Customisation: Entry to this mode runs the hooks on comint-mode-hook and
115 inferior-scheme-mode-hook (in that order).
116
117 You can send text to the inferior Scheme process from other buffers containing
118 Scheme source.
119 switch-to-scheme switches the current buffer to the Scheme process buffer.
120 scheme-send-definition sends the current definition to the Scheme process.
121 scheme-compile-definition compiles the current definition.
122 scheme-send-region sends the current region to the Scheme process.
123 scheme-compile-region compiles the current region.
124
125 scheme-send-definition-and-go, scheme-compile-definition-and-go,
126 scheme-send-region-and-go, and scheme-compile-region-and-go
127 switch to the Scheme process buffer after sending their text.
128 For information on running multiple processes in multiple buffers, see
129 documentation for variable scheme-buffer.
130
131 Commands:
132 Return after the end of the process' output sends the text from the
133 end of process to point.
134 Return before the end of the process' output copies the sexp ending at point
135 to the end of the process' output, and sends it.
136 Delete converts tabs to spaces as it moves back.
137 Tab indents for Scheme; with argument, shifts rest
138 of expression rigidly with the current line.
139 C-M-q does Tab on each line starting within following expression.
140 Paragraphs are separated only by blank lines. Semicolons start comments.
141 If you accidentally suspend your process, use \\[comint-continue-subjob]
142 to continue it."
143 (interactive)
144 (comint-mode)
145 ;; Customise in inferior-scheme-mode-hook
146 (setq comint-prompt-regexp "^[^>\n]*>+ *") ; OK for cscheme, oaklisp, T,...
147 (scheme-mode-variables)
148 (setq major-mode 'inferior-scheme-mode)
149 (setq mode-name "Inferior Scheme")
150 (setq mode-line-process '(":%s"))
151 (use-local-map inferior-scheme-mode-map)
152 (setq comint-input-filter (function scheme-input-filter))
153 (setq comint-get-old-input (function scheme-get-old-input))
154 (run-hooks 'inferior-scheme-mode-hook))
155
156 (defvar inferior-scheme-filter-regexp "\\`\\s *\\S ?\\S ?\\s *\\'"
157 "*Input matching this regexp are not saved on the history list.
158 Defaults to a regexp ignoring all inputs of 0, 1, or 2 letters.")
159
160 (defun scheme-input-filter (str)
161 "Don't save anything matching inferior-scheme-filter-regexp"
162 (not (string-match inferior-scheme-filter-regexp str)))
163
164 (defun scheme-get-old-input ()
165 "Snarf the sexp ending at point"
166 (save-excursion
167 (let ((end (point)))
168 (backward-sexp)
169 (buffer-substring (point) end))))
170
171 (defun scheme-args-to-list (string)
172 (let ((where (string-match "[ \t]" string)))
173 (cond ((null where) (list string))
174 ((not (= where 0))
175 (cons (substring string 0 where)
176 (scheme-args-to-list (substring string (+ 1 where)
177 (length string)))))
178 (t (let ((pos (string-match "[^ \t]" string)))
179 (if (null pos)
180 nil
181 (scheme-args-to-list (substring string pos
182 (length string)))))))))
183
184 (defvar scheme-program-name "scheme"
185 "*Program invoked by the run-scheme command")
186
187 (defun run-scheme (cmd)
188 "Run an inferior Scheme process, input and output via buffer *scheme*.
189 If there is a process already running in `*scheme*', switch to that buffer.
190 With argument, allows you to edit the command line (default is value
191 of `scheme-program-name'). Runs the hooks `inferior-scheme-mode-hook'
192 \(after the `comint-mode-hook' is run).
193 \(Type \\[describe-mode] in the process buffer for a list of commands.)"
194
195 (interactive (list (if current-prefix-arg
196 (read-string "Run Scheme: " scheme-program-name)
197 scheme-program-name)))
198 (if (not (comint-check-proc "*scheme*"))
199 (let ((cmdlist (scheme-args-to-list cmd)))
200 (set-buffer (apply 'make-comint "scheme" (car cmdlist)
201 nil (cdr cmdlist)))
202 (inferior-scheme-mode)))
203 (setq scheme-program-name cmd)
204 (setq scheme-buffer "*scheme*")
205 (pop-to-buffer "*scheme*"))
206 ;;;###autoload (add-hook 'same-window-buffer-names "*scheme*")
207
208 (defun scheme-send-region (start end)
209 "Send the current region to the inferior Scheme process."
210 (interactive "r")
211 (comint-send-region (scheme-proc) start end)
212 (comint-send-string (scheme-proc) "\n"))
213
214 (defun scheme-send-definition ()
215 "Send the current definition to the inferior Scheme process."
216 (interactive)
217 (save-excursion
218 (end-of-defun)
219 (let ((end (point)))
220 (beginning-of-defun)
221 (scheme-send-region (point) end))))
222
223 (defun scheme-send-last-sexp ()
224 "Send the previous sexp to the inferior Scheme process."
225 (interactive)
226 (scheme-send-region (save-excursion (backward-sexp) (point)) (point)))
227
228 (defvar scheme-compile-exp-command "(compile '%s)"
229 "*Template for issuing commands to compile arbitrary Scheme expressions.")
230
231 (defun scheme-compile-region (start end)
232 "Compile the current region in the inferior Scheme process.
233 \(A BEGIN is wrapped around the region: (BEGIN <region>))"
234 (interactive "r")
235 (comint-send-string (scheme-proc) (format scheme-compile-exp-command
236 (format "(begin %s)"
237 (buffer-substring start end))))
238 (comint-send-string (scheme-proc) "\n"))
239
240 (defun scheme-compile-definition ()
241 "Compile the current definition in the inferior Scheme process."
242 (interactive)
243 (save-excursion
244 (end-of-defun)
245 (let ((end (point)))
246 (beginning-of-defun)
247 (scheme-compile-region (point) end))))
248
249 (defun switch-to-scheme (eob-p)
250 "Switch to the scheme process buffer.
251 With argument, positions cursor at end of buffer."
252 (interactive "P")
253 (if (get-buffer scheme-buffer)
254 (pop-to-buffer scheme-buffer)
255 (error "No current process buffer. See variable scheme-buffer."))
256 (cond (eob-p
257 (push-mark)
258 (goto-char (point-max)))))
259
260 (defun scheme-send-region-and-go (start end)
261 "Send the current region to the inferior Scheme process.
262 Then switch to the process buffer."
263 (interactive "r")
264 (scheme-send-region start end)
265 (switch-to-scheme t))
266
267 (defun scheme-send-definition-and-go ()
268 "Send the current definition to the inferior Scheme.
269 Then switch to the process buffer."
270 (interactive)
271 (scheme-send-definition)
272 (switch-to-scheme t))
273
274 (defun scheme-compile-definition-and-go ()
275 "Compile the current definition in the inferior Scheme.
276 Then switch to the process buffer."
277 (interactive)
278 (scheme-compile-definition)
279 (switch-to-scheme t))
280
281 (defun scheme-compile-region-and-go (start end)
282 "Compile the current region in the inferior Scheme.
283 Then switch to the process buffer."
284 (interactive "r")
285 (scheme-compile-region start end)
286 (switch-to-scheme t))
287
288 (defvar scheme-source-modes '(scheme-mode)
289 "*Used to determine if a buffer contains Scheme source code.
290 If it's loaded into a buffer that is in one of these major modes, it's
291 considered a scheme source file by scheme-load-file and scheme-compile-file.
292 Used by these commands to determine defaults.")
293
294 (defvar scheme-prev-l/c-dir/file nil
295 "Caches the last (directory . file) pair.
296 Caches the last pair used in the last scheme-load-file or
297 scheme-compile-file command. Used for determining the default in the
298 next one.")
299
300 (defun scheme-load-file (file-name)
301 "Load a Scheme file into the inferior Scheme process."
302 (interactive (comint-get-source "Load Scheme file: " scheme-prev-l/c-dir/file
303 scheme-source-modes t)) ; T because LOAD
304 ; needs an exact name
305 (comint-check-source file-name) ; Check to see if buffer needs saved.
306 (setq scheme-prev-l/c-dir/file (cons (file-name-directory file-name)
307 (file-name-nondirectory file-name)))
308 (comint-send-string (scheme-proc) (concat "(load \""
309 file-name
310 "\"\)\n")))
311
312 (defun scheme-compile-file (file-name)
313 "Compile a Scheme file in the inferior Scheme process."
314 (interactive (comint-get-source "Compile Scheme file: "
315 scheme-prev-l/c-dir/file
316 scheme-source-modes
317 nil)) ; NIL because COMPILE doesn't
318 ; need an exact name.
319 (comint-check-source file-name) ; Check to see if buffer needs saved.
320 (setq scheme-prev-l/c-dir/file (cons (file-name-directory file-name)
321 (file-name-nondirectory file-name)))
322 (comint-send-string (scheme-proc) (concat "(compile-file \""
323 file-name
324 "\"\)\n")))
325
326
327 (defvar scheme-buffer nil "*The current scheme process buffer.
328
329 MULTIPLE PROCESS SUPPORT
330 ===========================================================================
331 Cmuscheme.el supports, in a fairly simple fashion, running multiple Scheme
332 processes. To run multiple Scheme processes, you start the first up with
333 \\[run-scheme]. It will be in a buffer named *scheme*. Rename this buffer
334 with \\[rename-buffer]. You may now start up a new process with another
335 \\[run-scheme]. It will be in a new buffer, named *scheme*. You can
336 switch between the different process buffers with \\[switch-to-buffer].
337
338 Commands that send text from source buffers to Scheme processes --
339 like scheme-send-definition or scheme-compile-region -- have to choose a
340 process to send to, when you have more than one Scheme process around. This
341 is determined by the global variable scheme-buffer. Suppose you
342 have three inferior Schemes running:
343 Buffer Process
344 foo scheme
345 bar scheme<2>
346 *scheme* scheme<3>
347 If you do a \\[scheme-send-definition-and-go] command on some Scheme source
348 code, what process do you send it to?
349
350 - If you're in a process buffer (foo, bar, or *scheme*),
351 you send it to that process.
352 - If you're in some other buffer (e.g., a source file), you
353 send it to the process attached to buffer scheme-buffer.
354 This process selection is performed by function scheme-proc.
355
356 Whenever \\[run-scheme] fires up a new process, it resets scheme-buffer
357 to be the new process's buffer. If you only run one process, this will
358 do the right thing. If you run multiple processes, you can change
359 scheme-buffer to another process buffer with \\[set-variable].
360
361 More sophisticated approaches are, of course, possible. If you find yourself
362 needing to switch back and forth between multiple processes frequently,
363 you may wish to consider ilisp.el, a larger, more sophisticated package
364 for running inferior Lisp and Scheme processes. The approach taken here is
365 for a minimal, simple implementation. Feel free to extend it.")
366
367 (defun scheme-proc ()
368 "Returns the current scheme process. See variable scheme-buffer."
369 (let ((proc (get-buffer-process (if (eq major-mode 'inferior-scheme-mode)
370 (current-buffer)
371 scheme-buffer))))
372 (or proc
373 (error "No current process. See variable scheme-buffer"))))
374
375
376 ;;; Do the user's customisation...
377
378 (defvar cmuscheme-load-hook nil
379 "This hook is run when cmuscheme is loaded in.
380 This is a good place to put keybindings.")
381
382 (run-hooks 'cmuscheme-load-hook)
383
384
385 ;;; CHANGE LOG
386 ;;; ===========================================================================
387 ;;; 8/88 Olin
388 ;;; Created.
389 ;;;
390 ;;; 2/15/89 Olin
391 ;;; Removed -emacs flag from process invocation. It's only useful for
392 ;;; cscheme, and makes cscheme assume it's running under xscheme.el,
393 ;;; which messes things up royally. A bug.
394 ;;;
395 ;;; 5/22/90 Olin
396 ;;; - Upgraded to use comint-send-string and comint-send-region.
397 ;;; - run-scheme now offers to let you edit the command line if
398 ;;; you invoke it with a prefix-arg. M-x scheme is redundant, and
399 ;;; has been removed.
400 ;;; - Explicit references to process "scheme" have been replaced with
401 ;;; (scheme-proc). This allows better handling of multiple process bufs.
402 ;;; - Added scheme-send-last-sexp, bound to C-x C-e. A gnu convention.
403 ;;; - Have not added process query facility a la cmulisp.el's lisp-show-arglist
404 ;;; and friends, but interested hackers might find a useful application
405 ;;; of this facility.
406 ;;;
407 ;;; 3/12/90 Olin
408 ;;; - scheme-load-file and scheme-compile-file no longer switch-to-scheme.
409 ;;; Tale suggested this.
410
411 (provide 'cmuscheme)
412
413 ;;; cmuscheme.el ends here