Commit | Line | Data |
---|---|---|
04a19a79 | 1 | ;;; -*- lexical-binding: t -*- |
813f532d | 2 | ;;; ielm.el --- interaction mode for Emacs Lisp |
b578f267 | 3 | |
ab422c4d | 4 | ;; Copyright (C) 1994, 2001-2013 Free Software Foundation, Inc. |
813f532d RS |
5 | |
6 | ;; Author: David Smith <maa036@lancaster.ac.uk> | |
4228277d | 7 | ;; Maintainer: FSF |
813f532d RS |
8 | ;; Created: 25 Feb 1994 |
9 | ;; Keywords: lisp | |
10 | ||
11 | ;; This file is part of GNU Emacs. | |
12 | ||
eb3fa2cf | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
813f532d | 14 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
813f532d RS |
17 | |
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
813f532d RS |
25 | |
26 | ;;; Commentary: | |
27 | ||
e848854a | 28 | ;; Provides a nice interface to evaluating Emacs Lisp expressions. |
813f532d RS |
29 | ;; Input is handled by the comint package, and output is passed |
30 | ;; through the pretty-printer. | |
31 | ||
813f532d RS |
32 | ;; To start: M-x ielm. Type C-h m in the *ielm* buffer for more info. |
33 | ||
813f532d RS |
34 | ;;; Code: |
35 | ||
36 | (require 'comint) | |
37 | (require 'pp) | |
38 | ||
39 | ;;; User variables | |
40 | ||
94114394 RS |
41 | (defgroup ielm nil |
42 | "Interaction mode for Emacs Lisp." | |
43 | :group 'lisp) | |
44 | ||
45 | ||
46 | (defcustom ielm-noisy t | |
61c11870 | 47 | "If non-nil, IELM will beep on error." |
94114394 RS |
48 | :type 'boolean |
49 | :group 'ielm) | |
813f532d | 50 | |
759f960a LT |
51 | (defcustom ielm-prompt-read-only t |
52 | "If non-nil, the IELM prompt is read only. | |
7655d378 | 53 | The read only region includes the newline before the prompt. |
759f960a | 54 | Setting this variable does not affect existing IELM runs. |
016b8f71 | 55 | This works by setting the buffer-local value of `comint-prompt-read-only'. |
7655d378 LT |
56 | Setting that value directly affects new prompts in the current buffer. |
57 | ||
58 | If this option is enabled, then the safe way to temporarily | |
61c11870 | 59 | override the read-only-ness of IELM prompts is to call |
7655d378 LT |
60 | `comint-kill-whole-line' or `comint-kill-region' with no |
61 | narrowing in effect. This way you will be certain that none of | |
62 | the remaining prompts will be accidentally messed up. You may | |
865fe16f | 63 | wish to put something like the following in your init file: |
7655d378 LT |
64 | |
65 | \(add-hook 'ielm-mode-hook | |
04a19a79 DC |
66 | (lambda () |
67 | (define-key ielm-map \"\\C-w\" 'comint-kill-region) | |
68 | (define-key ielm-map [C-S-backspace] | |
69 | 'comint-kill-whole-line))) | |
7655d378 LT |
70 | |
71 | If you set `comint-prompt-read-only' to t, you might wish to use | |
72 | `comint-mode-hook' and `comint-mode-map' instead of | |
73 | `ielm-mode-hook' and `ielm-map'. That will affect all comint | |
61c11870 | 74 | buffers, including IELM buffers. If you sometimes use IELM on |
7655d378 LT |
75 | text-only terminals or with `emacs -nw', you might wish to use |
76 | another binding for `comint-kill-whole-line'." | |
759f960a LT |
77 | :type 'boolean |
78 | :group 'ielm | |
bf247b6e | 79 | :version "22.1") |
759f960a | 80 | |
40cf8f25 | 81 | (defcustom ielm-prompt "ELISP> " |
759f960a | 82 | "Prompt used in IELM. |
016b8f71 | 83 | Setting this variable does not affect existing IELM runs. |
ee9cd72d LT |
84 | |
85 | Interrupting the IELM process with \\<ielm-map>\\[comint-interrupt-subjob], | |
86 | and then restarting it using \\[ielm], makes the then current | |
016b8f71 | 87 | default value affect _new_ prompts. Unless the new prompt |
ee9cd72d LT |
88 | differs only in text properties from the old one, IELM will no |
89 | longer recognize the old prompts. However, executing \\[ielm] | |
90 | does not update the prompt of an *ielm* buffer with a running process. | |
9eca7c03 | 91 | For IELM buffers that are not called `*ielm*', you can execute |
ee9cd72d LT |
92 | \\[inferior-emacs-lisp-mode] in that IELM buffer to update the value, |
93 | for new prompts. This works even if the buffer has a running process." | |
40cf8f25 | 94 | :type 'string |
759f960a | 95 | :group 'ielm) |
813f532d | 96 | |
016b8f71 LT |
97 | (defvar ielm-prompt-internal "ELISP> " |
98 | "Stored value of `ielm-prompt' in the current IELM buffer. | |
99 | This is an internal variable used by IELM. Its purpose is to | |
100 | prevent a running IELM process from being messed up when the user | |
101 | customizes `ielm-prompt'.") | |
102 | ||
94114394 | 103 | (defcustom ielm-dynamic-return t |
61c11870 | 104 | "Controls whether \\<ielm-map>\\[ielm-return] has intelligent behavior in IELM. |
e848854a | 105 | If non-nil, \\[ielm-return] evaluates input for complete sexps, or inserts a newline |
94114394 RS |
106 | and indents for incomplete sexps. If nil, always inserts newlines." |
107 | :type 'boolean | |
108 | :group 'ielm) | |
e848854a | 109 | |
94114394 | 110 | (defcustom ielm-dynamic-multiline-inputs t |
61c11870 | 111 | "Force multiline inputs to start from column zero? |
e848854a RS |
112 | If non-nil, after entering the first line of an incomplete sexp, a newline |
113 | will be inserted after the prompt, moving the input to the next line. | |
114 | This gives more frame width for large indented sexps, and allows functions | |
94114394 RS |
115 | such as `edebug-defun' to work with such inputs." |
116 | :type 'boolean | |
117 | :group 'ielm) | |
813f532d | 118 | |
94114394 | 119 | (defcustom ielm-mode-hook nil |
61c11870 | 120 | "Hooks to be run when IELM (`inferior-emacs-lisp-mode') is started." |
10fea268 | 121 | :options '(turn-on-eldoc-mode) |
94114394 RS |
122 | :type 'hook |
123 | :group 'ielm) | |
61c11870 | 124 | (defvaralias 'inferior-emacs-lisp-mode-hook 'ielm-mode-hook) |
813f532d | 125 | |
d38e7d5f RS |
126 | (defvar * nil |
127 | "Most recent value evaluated in IELM.") | |
128 | ||
129 | (defvar ** nil | |
130 | "Second-most-recent value evaluated in IELM.") | |
131 | ||
132 | (defvar *** nil | |
133 | "Third-most-recent value evaluated in IELM.") | |
690ec649 | 134 | |
565f89ec SM |
135 | (defvar ielm-match-data nil |
136 | "Match data saved at the end of last command.") | |
137 | ||
1322516b | 138 | (defvar *1 nil |
5d9655bb RS |
139 | "During IELM evaluation, most recent value evaluated in IELM. |
140 | Normally identical to `*'. However, if the working buffer is an IELM | |
141 | buffer, distinct from the process buffer, then `*' gives the value in | |
71296446 | 142 | the working buffer, `*1' the value in the process buffer. |
5d9655bb RS |
143 | The intended value is only accessible during IELM evaluation.") |
144 | ||
145 | (defvar *2 nil | |
146 | "During IELM evaluation, second-most-recent value evaluated in IELM. | |
147 | Normally identical to `**'. However, if the working buffer is an IELM | |
148 | buffer, distinct from the process buffer, then `**' gives the value in | |
149 | the working buffer, `*2' the value in the process buffer. | |
150 | The intended value is only accessible during IELM evaluation.") | |
151 | ||
152 | (defvar *3 nil | |
153 | "During IELM evaluation, third-most-recent value evaluated in IELM. | |
154 | Normally identical to `***'. However, if the working buffer is an IELM | |
155 | buffer, distinct from the process buffer, then `***' gives the value in | |
156 | the working buffer, `*3' the value in the process buffer. | |
157 | The intended value is only accessible during IELM evaluation.") | |
158 | ||
813f532d RS |
159 | ;;; System variables |
160 | ||
161 | (defvar ielm-working-buffer nil | |
e848854a RS |
162 | "Buffer in which IELM sexps will be evaluated. |
163 | This variable is buffer-local.") | |
813f532d | 164 | |
690ec649 | 165 | (defvar ielm-header |
0a13146e | 166 | "*** Welcome to IELM *** Type (describe-mode) for help.\n" |
e848854a | 167 | "Message to display when IELM is started.") |
813f532d | 168 | |
61c11870 JB |
169 | (defvar ielm-map |
170 | (let ((map (make-sparse-keymap))) | |
d209d4a9 | 171 | (define-key map "\t" 'completion-at-point) |
61c11870 | 172 | (define-key map "\C-m" 'ielm-return) |
04a19a79 | 173 | (define-key map "\e\C-m" 'ielm-return-for-effect) |
61c11870 JB |
174 | (define-key map "\C-j" 'ielm-send-input) |
175 | (define-key map "\e\C-x" 'eval-defun) ; for consistency with | |
51ef56c4 | 176 | (define-key map "\e\t" 'completion-at-point) ; lisp-interaction-mode |
61c11870 JB |
177 | ;; These bindings are from `lisp-mode-shared-map' -- can you inherit |
178 | ;; from more than one keymap?? | |
179 | (define-key map "\e\C-q" 'indent-sexp) | |
180 | (define-key map "\177" 'backward-delete-char-untabify) | |
181 | ;; Some convenience bindings for setting the working buffer | |
182 | (define-key map "\C-c\C-b" 'ielm-change-working-buffer) | |
183 | (define-key map "\C-c\C-f" 'ielm-display-working-buffer) | |
184 | (define-key map "\C-c\C-v" 'ielm-print-working-buffer) | |
185 | map) | |
186 | "Keymap for IELM mode.") | |
187 | (defvaralias 'inferior-emacs-lisp-mode-map 'ielm-map) | |
813f532d | 188 | |
fe1eb856 RS |
189 | (easy-menu-define ielm-menu ielm-map |
190 | "IELM mode menu." | |
191 | '("IELM" | |
192 | ["Change Working Buffer" ielm-change-working-buffer t] | |
193 | ["Display Working Buffer" ielm-display-working-buffer t] | |
194 | ["Print Working Buffer" ielm-print-working-buffer t])) | |
195 | ||
9d42eea3 | 196 | (defvar ielm-font-lock-keywords |
016b8f71 | 197 | '(("\\(^\\*\\*\\*[^*]+\\*\\*\\*\\)\\(.*$\\)" |
883212ce SM |
198 | (1 font-lock-comment-face) |
199 | (2 font-lock-constant-face))) | |
61c11870 | 200 | "Additional expressions to highlight in IELM buffers.") |
690ec649 | 201 | |
813f532d RS |
202 | ;;; Completion stuff |
203 | ||
204 | (defun ielm-tab nil | |
e5927b52 | 205 | "Possibly indent the current line as Lisp code." |
813f532d | 206 | (interactive) |
61c11870 | 207 | (when (or (eq (preceding-char) ?\n) |
04a19a79 | 208 | (eq (char-syntax (preceding-char)) ?\s)) |
61c11870 JB |
209 | (ielm-indent-line) |
210 | t)) | |
690ec649 | 211 | |
813f532d | 212 | (defun ielm-complete-symbol nil |
e5927b52 | 213 | "Complete the Lisp symbol before point." |
d209d4a9 | 214 | ;; A wrapper for completion-at-point that returns non-nil if |
e848854a | 215 | ;; completion has occurred |
813f532d | 216 | (let* ((btick (buffer-modified-tick)) |
04a19a79 DC |
217 | (cbuffer (get-buffer "*Completions*")) |
218 | (ctick (and cbuffer (buffer-modified-tick cbuffer))) | |
219 | (completion-at-point-functions '(lisp-completion-at-point))) | |
d209d4a9 | 220 | (completion-at-point) |
813f532d | 221 | ;; completion has occurred if: |
690ec649 | 222 | (or |
813f532d | 223 | ;; the buffer has been modified |
690ec649 | 224 | (not (= btick (buffer-modified-tick))) |
a7acbbe4 | 225 | ;; a completions buffer has been modified or created |
813f532d | 226 | (if cbuffer |
04a19a79 | 227 | (not (= ctick (buffer-modified-tick cbuffer))) |
e58df0dc | 228 | (get-buffer "*Completions*"))))) |
813f532d RS |
229 | |
230 | (defun ielm-complete-filename nil | |
e848854a | 231 | "Dynamically complete filename before point, if in a string." |
61c11870 JB |
232 | (when (nth 3 (parse-partial-sexp comint-last-input-start (point))) |
233 | (comint-dynamic-complete-filename))) | |
690ec649 | 234 | |
813f532d | 235 | (defun ielm-indent-line nil |
e848854a | 236 | "Indent the current line as Lisp code if it is not a prompt line." |
3250010d | 237 | (when (save-excursion (comint-bol) (bolp)) |
813f532d RS |
238 | (lisp-indent-line))) |
239 | ||
e848854a RS |
240 | ;;; Working buffer manipulation |
241 | ||
242 | (defun ielm-print-working-buffer nil | |
243 | "Print the current IELM working buffer's name in the echo area." | |
244 | (interactive) | |
245 | (message "The current working buffer is: %s" (buffer-name ielm-working-buffer))) | |
246 | ||
247 | (defun ielm-display-working-buffer nil | |
248 | "Display the current IELM working buffer. | |
249 | Don't forget that selecting that buffer will change its value of `point' | |
250 | to its value of `window-point'!" | |
251 | (interactive) | |
252 | (display-buffer ielm-working-buffer) | |
253 | (ielm-print-working-buffer)) | |
254 | ||
255 | (defun ielm-change-working-buffer (buf) | |
256 | "Change the current IELM working buffer to BUF. | |
257 | This is the buffer in which all sexps entered at the IELM prompt are | |
258 | evaluated. You can achieve the same effect with a call to | |
259 | `set-buffer' at the IELM prompt." | |
260 | (interactive "bSet working buffer to: ") | |
61c11870 JB |
261 | (let ((buffer (get-buffer buf))) |
262 | (if (and buffer (buffer-live-p buffer)) | |
04a19a79 | 263 | (setq ielm-working-buffer buffer) |
61c11870 | 264 | (error "No such buffer: %S" buf))) |
e848854a RS |
265 | (ielm-print-working-buffer)) |
266 | ||
813f532d RS |
267 | ;;; Other bindings |
268 | ||
04a19a79 | 269 | (defun ielm-return (&optional for-effect) |
e848854a RS |
270 | "Newline and indent, or evaluate the sexp before the prompt. |
271 | Complete sexps are evaluated; for incomplete sexps inserts a newline | |
272 | and indents. If however `ielm-dynamic-return' is nil, this always | |
273 | simply inserts a newline." | |
813f532d | 274 | (interactive) |
690ec649 SS |
275 | (if ielm-dynamic-return |
276 | (let ((state | |
04a19a79 DC |
277 | (save-excursion |
278 | (end-of-line) | |
279 | (parse-partial-sexp (ielm-pm) | |
280 | (point))))) | |
281 | (if (and (< (car state) 1) (not (nth 3 state))) | |
282 | (ielm-send-input for-effect) | |
283 | (when (and ielm-dynamic-multiline-inputs | |
284 | (save-excursion | |
285 | (beginning-of-line) | |
286 | (looking-at-p comint-prompt-regexp))) | |
287 | (save-excursion | |
288 | (goto-char (ielm-pm)) | |
289 | (newline 1))) | |
290 | (newline-and-indent))) | |
813f532d RS |
291 | (newline))) |
292 | ||
04a19a79 DC |
293 | (defun ielm-return-for-effect () |
294 | "Like `ielm-return', but do not print the result." | |
295 | (interactive) | |
296 | (ielm-return t)) | |
297 | ||
94aba130 RS |
298 | (defvar ielm-input) |
299 | ||
06b60517 | 300 | (defun ielm-input-sender (_proc input) |
690ec649 | 301 | ;; Just sets the variable ielm-input, which is in the scope of |
e848854a | 302 | ;; `ielm-send-input's call. |
813f532d RS |
303 | (setq ielm-input input)) |
304 | ||
04a19a79 | 305 | (defun ielm-send-input (&optional for-effect) |
e848854a | 306 | "Evaluate the Emacs Lisp expression after the prompt." |
813f532d | 307 | (interactive) |
04a19a79 DC |
308 | (let (ielm-input) ; set by ielm-input-sender |
309 | (comint-send-input) ; update history, markers etc. | |
310 | (ielm-eval-input ielm-input for-effect))) | |
813f532d RS |
311 | |
312 | ;;; Utility functions | |
313 | ||
6ad18d45 | 314 | (defun ielm-is-whitespace-or-comment (string) |
2ef180f7 | 315 | "Return non-nil if STRING is all whitespace or a comment." |
61c11870 JB |
316 | (or (string= string "") |
317 | (string-match-p "\\`[ \t\n]*\\(?:;.*\\)*\\'" string))) | |
813f532d | 318 | |
813f532d RS |
319 | ;;; Evaluation |
320 | ||
04a19a79 DC |
321 | (defun ielm-standard-output-impl (process) |
322 | "Return a function to use for `standard-output' while in ielm eval. | |
323 | The returned function takes one character as input. Passing nil | |
324 | to this function instead of a character flushes the output | |
325 | buffer. Passing t appends a terminating newline if the buffer is | |
326 | nonempty, then flushes the buffer." | |
327 | ;; Use an intermediate output buffer because doing redisplay for | |
328 | ;; each character we output is too expensive. Set up a flush timer | |
329 | ;; so that users don't have to wait for whole lines to appear before | |
330 | ;; seeing output. | |
331 | (let* ((output-buffer nil) | |
332 | (flush-timer nil) | |
333 | (flush-buffer | |
334 | (lambda () | |
335 | (comint-output-filter | |
336 | process | |
337 | (apply #'string (nreverse output-buffer))) | |
338 | (redisplay) | |
339 | (setf output-buffer nil) | |
340 | (when flush-timer | |
341 | (cancel-timer flush-timer) | |
342 | (setf flush-timer nil))))) | |
343 | (lambda (char) | |
344 | (let (flush-now) | |
345 | (cond ((and (eq char t) output-buffer) | |
346 | (push ?\n output-buffer) | |
347 | (setf flush-now t)) | |
348 | ((characterp char) | |
349 | (push char output-buffer))) | |
350 | (if flush-now | |
351 | (funcall flush-buffer) | |
352 | (unless flush-timer | |
353 | (setf flush-timer (run-with-timer 0.1 nil flush-buffer)))))))) | |
354 | ||
355 | (defun ielm-eval-input (input-string &optional for-effect) | |
06b60517 | 356 | "Evaluate the Lisp expression INPUT-STRING, and pretty-print the result." |
813f532d | 357 | ;; This is the function that actually `sends' the input to the |
e848854a | 358 | ;; `inferior Lisp process'. All comint-send-input does is works out |
813f532d RS |
359 | ;; what that input is. What this function does is evaluates that |
360 | ;; input and produces `output' which gets inserted into the buffer, | |
361 | ;; along with a new prompt. A better way of doing this might have | |
362 | ;; been to actually send the output to the `cat' process, and write | |
363 | ;; this as in output filter that converted sexps in the output | |
364 | ;; stream to their evaluated value. But that would have involved | |
365 | ;; more process coordination than I was happy to deal with. | |
04a19a79 DC |
366 | (let ((string input-string) ; input expression, as a string |
367 | form ; form to evaluate | |
368 | pos ; End posn of parse in string | |
369 | result ; Result, or error message | |
370 | error-type ; string, nil if no error | |
371 | (output "") ; result to display | |
372 | (wbuf ielm-working-buffer) ; current buffer after evaluation | |
373 | (pmark (ielm-pm))) | |
374 | (unless (ielm-is-whitespace-or-comment string) | |
61c11870 | 375 | (condition-case err |
04a19a79 DC |
376 | (let ((rout (read-from-string string))) |
377 | (setq form (car rout) | |
378 | pos (cdr rout))) | |
379 | (error (setq result (error-message-string err)) | |
380 | (setq error-type "Read error"))) | |
381 | (unless error-type | |
382 | ;; Make sure working buffer has not been killed | |
383 | (if (not (buffer-name ielm-working-buffer)) | |
384 | (setq result "Working buffer has been killed" | |
385 | error-type "IELM Error" | |
386 | wbuf (current-buffer)) | |
387 | (if (ielm-is-whitespace-or-comment (substring string pos)) | |
388 | ;; To correctly handle the ielm-local variables *, | |
389 | ;; ** and ***, we need a temporary buffer to be | |
390 | ;; current at entry to the inner of the next two let | |
391 | ;; forms. We need another temporary buffer to exit | |
392 | ;; that same let. To avoid problems, neither of | |
393 | ;; these buffers should be alive during the | |
394 | ;; evaluation of form. | |
395 | (let* ((*1 *) | |
396 | (*2 **) | |
397 | (*3 ***) | |
398 | (active-process (ielm-process)) | |
399 | (old-standard-output standard-output) | |
400 | new-standard-output | |
401 | ielm-temp-buffer) | |
402 | (set-match-data ielm-match-data) | |
403 | (save-excursion | |
404 | (with-temp-buffer | |
405 | (condition-case err | |
406 | (unwind-protect | |
407 | ;; The next let form creates default | |
408 | ;; bindings for *, ** and ***. But | |
409 | ;; these default bindings are | |
410 | ;; identical to the ielm-local | |
411 | ;; bindings. Hence, during the | |
412 | ;; evaluation of form, the | |
413 | ;; ielm-local values are going to be | |
414 | ;; used in all buffers except for | |
415 | ;; other ielm buffers, which override | |
416 | ;; them. Normally, the variables *1, | |
417 | ;; *2 and *3 also have default | |
418 | ;; bindings, which are not overridden. | |
419 | (let ((* *1) | |
420 | (** *2) | |
421 | (*** *3)) | |
422 | (when (eq standard-output t) | |
423 | (setf new-standard-output | |
424 | (ielm-standard-output-impl | |
425 | active-process)) | |
426 | (setf standard-output new-standard-output)) | |
427 | (kill-buffer (current-buffer)) | |
428 | (set-buffer wbuf) | |
429 | (setq result | |
430 | (eval form lexical-binding)) | |
431 | (setq wbuf (current-buffer)) | |
432 | (setq | |
433 | ielm-temp-buffer | |
434 | (generate-new-buffer " *ielm-temp*")) | |
435 | (set-buffer ielm-temp-buffer)) | |
436 | (when ielm-temp-buffer | |
437 | (kill-buffer ielm-temp-buffer)) | |
438 | (when (eq new-standard-output standard-output) | |
439 | (ignore-errors | |
440 | (funcall standard-output t)) | |
441 | (setf standard-output old-standard-output))) | |
442 | (error (setq result (error-message-string err)) | |
443 | (setq error-type "Eval error")) | |
444 | (quit (setq result "Quit during evaluation") | |
445 | (setq error-type "Eval error"))))) | |
446 | (setq ielm-match-data (match-data))) | |
447 | (setq error-type "IELM error") | |
448 | (setq result "More than one sexp in input")))) | |
61c11870 JB |
449 | |
450 | ;; If the eval changed the current buffer, mention it here | |
04a19a79 DC |
451 | (unless (eq wbuf ielm-working-buffer) |
452 | (message "current buffer is now: %s" wbuf) | |
453 | (setq ielm-working-buffer wbuf)) | |
454 | ||
455 | (goto-char pmark) | |
456 | (unless error-type | |
457 | (condition-case nil | |
458 | ;; Self-referential objects cause loops in the printer, so | |
459 | ;; trap quits here. May as well do errors, too | |
460 | (unless for-effect | |
461 | (setq output (concat output (pp-to-string result)))) | |
462 | (error (setq error-type "IELM Error") | |
463 | (setq result "Error during pretty-printing (bug in pp)")) | |
464 | (quit (setq error-type "IELM Error") | |
465 | (setq result "Quit during pretty-printing")))) | |
466 | (if error-type | |
467 | (progn | |
468 | (when ielm-noisy (ding)) | |
469 | (setq output (concat output "*** " error-type " *** ")) | |
470 | (setq output (concat output result))) | |
471 | ;; There was no error, so shift the *** values | |
472 | (setq *** **) | |
473 | (setq ** *) | |
474 | (setq * result)) | |
475 | (when (or (not for-effect) (not (equal output ""))) | |
476 | (setq output (concat output "\n")))) | |
477 | (setq output (concat output ielm-prompt-internal)) | |
478 | (comint-output-filter (ielm-process) output))) | |
813f532d RS |
479 | |
480 | ;;; Process and marker utilities | |
481 | ||
482 | (defun ielm-process nil | |
e848854a | 483 | ;; Return the current buffer's process. |
813f532d RS |
484 | (get-buffer-process (current-buffer))) |
485 | ||
486 | (defun ielm-pm nil | |
e848854a | 487 | ;; Return the process mark of the current buffer. |
813f532d RS |
488 | (process-mark (get-buffer-process (current-buffer)))) |
489 | ||
490 | (defun ielm-set-pm (pos) | |
e848854a | 491 | ;; Set the process mark in the current buffer to POS. |
813f532d RS |
492 | (set-marker (process-mark (get-buffer-process (current-buffer))) pos)) |
493 | ||
494 | ;;; Major mode | |
495 | ||
61c11870 | 496 | (define-derived-mode inferior-emacs-lisp-mode comint-mode "IELM" |
e848854a RS |
497 | "Major mode for interactively evaluating Emacs Lisp expressions. |
498 | Uses the interface provided by `comint-mode' (which see). | |
499 | ||
66f06793 SM |
500 | * \\<ielm-map>\\[ielm-send-input] evaluates the sexp following the prompt. There must be at most |
501 | one top level sexp per prompt. | |
813f532d | 502 | |
e848854a RS |
503 | * \\[ielm-return] inserts a newline and indents, or evaluates a |
504 | complete expression (but see variable `ielm-dynamic-return'). | |
505 | Inputs longer than one line are moved to the line following the | |
506 | prompt (but see variable `ielm-dynamic-multiline-inputs'). | |
507 | ||
04a19a79 DC |
508 | * \\[ielm-return-for-effect] works like `ielm-return', except |
509 | that it doesn't print the result of evaluating the input. This | |
510 | functionality is useful when forms would generate voluminous | |
511 | output. | |
512 | ||
d209d4a9 | 513 | * \\[completion-at-point] completes Lisp symbols (or filenames, within strings), |
e848854a | 514 | or indents the line if there is nothing to complete. |
813f532d | 515 | |
61c11870 JB |
516 | The current working buffer may be changed (with a call to `set-buffer', |
517 | or with \\[ielm-change-working-buffer]), and its value is preserved between successive | |
518 | evaluations. In this way, expressions may be evaluated in a different | |
519 | buffer than the *ielm* buffer. By default, its name is shown on the | |
520 | mode line; you can always display it with \\[ielm-print-working-buffer], or the buffer itself | |
521 | with \\[ielm-display-working-buffer]. | |
813f532d | 522 | |
5d9655bb RS |
523 | During evaluations, the values of the variables `*', `**', and `***' |
524 | are the results of the previous, second previous and third previous | |
525 | evaluations respectively. If the working buffer is another IELM | |
526 | buffer, then the values in the working buffer are used. The variables | |
527 | `*1', `*2' and `*3', yield the process buffer values. | |
528 | ||
04a19a79 DC |
529 | If, at the start of evaluation, `standard-output' is `t' (the |
530 | default), `standard-output' is set to a special function that | |
531 | causes output to be directed to the ielm buffer. | |
532 | `standard-output' is restored after evaluation unless explicitly | |
533 | set to a different value during evaluation. You can use (princ | |
534 | VALUE) or (pp VALUE) to write to the ielm buffer. | |
535 | ||
e848854a RS |
536 | Expressions evaluated by IELM are not subject to `debug-on-quit' or |
537 | `debug-on-error'. | |
813f532d | 538 | |
291cfc0c | 539 | The behavior of IELM may be customized with the following variables: |
0382cf8f | 540 | * To stop beeping on error, set `ielm-noisy' to nil. |
813f532d | 541 | * If you don't like the prompt, you can change it by setting `ielm-prompt'. |
759f960a LT |
542 | * If you do not like that the prompt is (by default) read-only, set |
543 | `ielm-prompt-read-only' to nil. | |
0382cf8f | 544 | * Set `ielm-dynamic-return' to nil for bindings like `lisp-interaction-mode'. |
813f532d RS |
545 | * Entry to this mode runs `comint-mode-hook' and `ielm-mode-hook' |
546 | (in that order). | |
547 | ||
0382cf8f | 548 | Customized bindings may be defined in `ielm-map', which currently contains: |
813f532d | 549 | \\{ielm-map}" |
61c11870 JB |
550 | :syntax-table emacs-lisp-mode-syntax-table |
551 | ||
813f532d | 552 | (setq comint-prompt-regexp (concat "^" (regexp-quote ielm-prompt))) |
85ab9f4e | 553 | (set (make-local-variable 'paragraph-separate) "\\'") |
61c11870 | 554 | (set (make-local-variable 'paragraph-start) comint-prompt-regexp) |
813f532d RS |
555 | (setq comint-input-sender 'ielm-input-sender) |
556 | (setq comint-process-echoes nil) | |
d209d4a9 | 557 | (set (make-local-variable 'completion-at-point-functions) |
61c11870 | 558 | '(ielm-tab comint-replace-by-expanded-history |
04a19a79 | 559 | ielm-complete-filename ielm-complete-symbol)) |
016b8f71 LT |
560 | (set (make-local-variable 'ielm-prompt-internal) ielm-prompt) |
561 | (set (make-local-variable 'comint-prompt-read-only) ielm-prompt-read-only) | |
e848854a | 562 | (setq comint-get-old-input 'ielm-get-old-input) |
61c11870 | 563 | (set (make-local-variable 'comint-completion-addsuffix) '("/" . "")) |
76364803 | 564 | (setq mode-line-process '(":%s on " (:eval (buffer-name ielm-working-buffer)))) |
fe1eb856 RS |
565 | ;; Useful for `hs-minor-mode'. |
566 | (setq-local comment-start ";") | |
567 | (setq-local comment-use-global-state t) | |
813f532d | 568 | |
61c11870 JB |
569 | (set (make-local-variable 'indent-line-function) 'ielm-indent-line) |
570 | (set (make-local-variable 'ielm-working-buffer) (current-buffer)) | |
571 | (set (make-local-variable 'fill-paragraph-function) 'lisp-fill-paragraph) | |
813f532d | 572 | |
e848854a | 573 | ;; Value holders |
61c11870 JB |
574 | (set (make-local-variable '*) nil) |
575 | (set (make-local-variable '**) nil) | |
576 | (set (make-local-variable '***) nil) | |
565f89ec | 577 | (set (make-local-variable 'ielm-match-data) nil) |
813f532d | 578 | |
9d42eea3 | 579 | ;; font-lock support |
61c11870 JB |
580 | (set (make-local-variable 'font-lock-defaults) |
581 | '(ielm-font-lock-keywords nil nil ((?: . "w") (?- . "w") (?* . "w")))) | |
690ec649 | 582 | |
813f532d | 583 | ;; A dummy process to keep comint happy. It will never get any input |
20b13009 | 584 | (unless (comint-check-proc (current-buffer)) |
33a65176 JR |
585 | ;; Was cat, but on non-Unix platforms that might not exist, so |
586 | ;; use hexl instead, which is part of the Emacs distribution. | |
66f06793 | 587 | (condition-case nil |
04a19a79 | 588 | (start-process "ielm" (current-buffer) "hexl") |
66f06793 | 589 | (file-error (start-process "ielm" (current-buffer) "cat"))) |
e5927b52 | 590 | (set-process-query-on-exit-flag (ielm-process) nil) |
813f532d | 591 | (goto-char (point-max)) |
71296446 | 592 | |
20b13009 MB |
593 | ;; Lisp output can include raw characters that confuse comint's |
594 | ;; carriage control code. | |
595 | (set (make-local-variable 'comint-inhibit-carriage-motion) t) | |
596 | ||
813f532d RS |
597 | ;; Add a silly header |
598 | (insert ielm-header) | |
599 | (ielm-set-pm (point-max)) | |
85ab9f4e | 600 | (unless comint-use-prompt-regexp |
76364803 JB |
601 | (let ((inhibit-read-only t)) |
602 | (add-text-properties | |
603 | (point-min) (point-max) | |
604 | '(rear-nonsticky t field output inhibit-line-move-field-capture t)))) | |
016b8f71 | 605 | (comint-output-filter (ielm-process) ielm-prompt-internal) |
813f532d | 606 | (set-marker comint-last-input-start (ielm-pm)) |
61c11870 | 607 | (set-process-filter (get-buffer-process (current-buffer)) 'comint-output-filter))) |
813f532d | 608 | |
e848854a RS |
609 | (defun ielm-get-old-input nil |
610 | ;; Return the previous input surrounding point | |
611 | (save-excursion | |
612 | (beginning-of-line) | |
61c11870 | 613 | (unless (looking-at-p comint-prompt-regexp) |
e848854a RS |
614 | (re-search-backward comint-prompt-regexp)) |
615 | (comint-skip-prompt) | |
616 | (buffer-substring (point) (progn (forward-sexp 1) (point))))) | |
617 | ||
813f532d RS |
618 | ;;; User command |
619 | ||
e848854a | 620 | ;;;###autoload |
813f532d | 621 | (defun ielm nil |
e848854a | 622 | "Interactively evaluate Emacs Lisp expressions. |
04a19a79 DC |
623 | Switches to the buffer `*ielm*', or creates it if it does not exist. |
624 | See `inferior-emacs-lisp-mode' for details." | |
813f532d | 625 | (interactive) |
ee9cd72d LT |
626 | (let (old-point) |
627 | (unless (comint-check-proc "*ielm*") | |
628 | (with-current-buffer (get-buffer-create "*ielm*") | |
04a19a79 DC |
629 | (unless (zerop (buffer-size)) (setq old-point (point))) |
630 | (inferior-emacs-lisp-mode))) | |
37ac18a3 | 631 | (switch-to-buffer "*ielm*") |
ee9cd72d | 632 | (when old-point (push-mark old-point)))) |
813f532d | 633 | |
896546cd RS |
634 | (provide 'ielm) |
635 | ||
e848854a | 636 | ;;; ielm.el ends here |