move MS-DOS material to emacs-xtra.texi
[bpt/emacs.git] / lisp / simple.el
CommitLineData
c88ab9ce
ER
1;;; simple.el --- basic editing commands for Emacs
2
c6db81aa 3;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
0a487199 4;; 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
2076c87c 5
30764597
PJ
6;; Maintainer: FSF
7;; Keywords: internal
8
2076c87c
JB
9;; This file is part of GNU Emacs.
10
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
3a801d0c 13;; the Free Software Foundation; either version 2, or (at your option)
2076c87c
JB
14;; any later version.
15
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.
20
21;; You should have received a copy of the GNU General Public License
b578f267 22;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15
LK
23;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24;; Boston, MA 02110-1301, USA.
2076c87c 25
d9ecc911
ER
26;;; Commentary:
27
28;; A grab-bag of basic Emacs commands not specifically related to some
29;; major mode or to file-handling.
30
3a801d0c 31;;; Code:
2076c87c 32
d01a33cf 33(eval-when-compile
a339f909 34 (autoload 'widget-convert "wid-edit")
cc76a58c 35 (autoload 'shell-mode "shell"))
d01a33cf 36
ca60ee11
JB
37(defvar compilation-current-error)
38
7fcce20f
RS
39(defcustom idle-update-delay 0.5
40 "*Idle time delay before updating various things on the screen.
41Various Emacs features that update auxiliary information when point moves
42wait this many seconds after Emacs becomes idle before doing an update."
43 :type 'number
44 :group 'display
45 :version "22.1")
d01a33cf 46
69c1dd37 47(defgroup killing nil
c9f0110e 48 "Killing and yanking commands."
69c1dd37
RS
49 :group 'editing)
50
69c1dd37
RS
51(defgroup paren-matching nil
52 "Highlight (un)matching of parens and expressions."
69c1dd37
RS
53 :group 'matching)
54
7979163c
JL
55(defun get-next-valid-buffer (list &optional buffer visible-ok frame)
56 "Search LIST for a valid buffer to display in FRAME.
a74f9094
KL
57Return nil when all buffers in LIST are undesirable for display,
58otherwise return the first suitable buffer in LIST.
59
60Buffers not visible in windows are preferred to visible buffers,
61unless VISIBLE-OK is non-nil.
62If the optional argument FRAME is nil, it defaults to the selected frame.
7979163c 63If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
a74f9094
KL
64 ;; This logic is more or less copied from other-buffer.
65 (setq frame (or frame (selected-frame)))
66 (let ((pred (frame-parameter frame 'buffer-predicate))
67 found buf)
68 (while (and (not found) list)
69 (setq buf (car list))
70 (if (and (not (eq buffer buf))
71 (buffer-live-p buf)
72 (or (null pred) (funcall pred buf))
73 (not (eq (aref (buffer-name buf) 0) ?\s))
74 (or visible-ok (null (get-buffer-window buf 'visible))))
75 (setq found buf)
76 (setq list (cdr list))))
77 (car list)))
78
7979163c
JL
79(defun last-buffer (&optional buffer visible-ok frame)
80 "Return the last non-hidden displayable buffer in the buffer list.
a74f9094
KL
81If BUFFER is non-nil, last-buffer will ignore that buffer.
82Buffers not visible in windows are preferred to visible buffers,
83unless optional argument VISIBLE-OK is non-nil.
84If the optional third argument FRAME is non-nil, use that frame's
85buffer list instead of the selected frame's buffer list.
86If no other buffer exists, the buffer `*scratch*' is returned."
87 (setq frame (or frame (selected-frame)))
88 (or (get-next-valid-buffer (frame-parameter frame 'buried-buffer-list)
89 buffer visible-ok frame)
90 (get-next-valid-buffer (nreverse (buffer-list frame))
91 buffer visible-ok frame)
92 (progn
93 (set-buffer-major-mode (get-buffer-create "*scratch*"))
94 (get-buffer "*scratch*"))))
95
f54b0d85
RS
96(defun next-buffer ()
97 "Switch to the next buffer in cyclic order."
98 (interactive)
a74f9094
KL
99 (let ((buffer (current-buffer))
100 (bbl (frame-parameter nil 'buried-buffer-list)))
101 (switch-to-buffer (other-buffer buffer t))
102 (bury-buffer buffer)
103 (set-frame-parameter nil 'buried-buffer-list
104 (cons buffer (delq buffer bbl)))))
105
106(defun previous-buffer ()
f54b0d85
RS
107 "Switch to the previous buffer in cyclic order."
108 (interactive)
a74f9094
KL
109 (let ((buffer (last-buffer (current-buffer) t))
110 (bbl (frame-parameter nil 'buried-buffer-list)))
111 (switch-to-buffer buffer)
112 ;; Clean up buried-buffer-list up to and including the chosen buffer.
113 (while (and bbl (not (eq (car bbl) buffer)))
114 (setq bbl (cdr bbl)))
115 (set-frame-parameter nil 'buried-buffer-list bbl)))
116
ee9c5954 117\f
50f007fb 118;;; next-error support framework
bbf41690
RS
119
120(defgroup next-error nil
f33321ad 121 "`next-error' support framework."
bbf41690 122 :group 'compilation
bf247b6e 123 :version "22.1")
bbf41690
RS
124
125(defface next-error
126 '((t (:inherit region)))
127 "Face used to highlight next error locus."
128 :group 'next-error
bf247b6e 129 :version "22.1")
bbf41690
RS
130
131(defcustom next-error-highlight 0.1
132 "*Highlighting of locations in selected source buffers.
f33321ad
JB
133If number, highlight the locus in `next-error' face for given time in seconds.
134If t, use persistent overlays fontified in `next-error' face.
bbf41690
RS
135If nil, don't highlight the locus in the source buffer.
136If `fringe-arrow', indicate the locus by the fringe arrow."
137 :type '(choice (number :tag "Delay")
138 (const :tag "Persistent overlay" t)
139 (const :tag "No highlighting" nil)
140 (const :tag "Fringe arrow" 'fringe-arrow))
141 :group 'next-error
bf247b6e 142 :version "22.1")
bbf41690
RS
143
144(defcustom next-error-highlight-no-select 0.1
145 "*Highlighting of locations in non-selected source buffers.
f33321ad
JB
146If number, highlight the locus in `next-error' face for given time in seconds.
147If t, use persistent overlays fontified in `next-error' face.
bbf41690
RS
148If nil, don't highlight the locus in the source buffer.
149If `fringe-arrow', indicate the locus by the fringe arrow."
150 :type '(choice (number :tag "Delay")
151 (const :tag "Persistent overlay" t)
152 (const :tag "No highlighting" nil)
153 (const :tag "Fringe arrow" 'fringe-arrow))
154 :group 'next-error
bf247b6e 155 :version "22.1")
bbf41690 156
d634a3a2
JL
157(defcustom next-error-hook nil
158 "*List of hook functions run by `next-error' after visiting source file."
159 :type 'hook
160 :group 'next-error)
161
814c3037
JL
162(defvar next-error-highlight-timer nil)
163
9c9b00d6 164(defvar next-error-overlay-arrow-position nil)
c29d24ea 165(put 'next-error-overlay-arrow-position 'overlay-arrow-string "=>")
9c9b00d6
JL
166(add-to-list 'overlay-arrow-variable-list 'next-error-overlay-arrow-position)
167
50f007fb 168(defvar next-error-last-buffer nil
f33321ad 169 "The most recent `next-error' buffer.
50f007fb
KS
170A buffer becomes most recent when its compilation, grep, or
171similar mode is started, or when it is used with \\[next-error]
172or \\[compile-goto-error].")
173
174(defvar next-error-function nil
e462ab77
SM
175 "Function to use to find the next error in the current buffer.
176The function is called with 2 parameters:
177ARG is an integer specifying by how many errors to move.
178RESET is a boolean which, if non-nil, says to go back to the beginning
179of the errors before moving.
180Major modes providing compile-like functionality should set this variable
181to indicate to `next-error' that this is a candidate buffer and how
182to navigate in it.")
50f007fb
KS
183
184(make-variable-buffer-local 'next-error-function)
185
f1e2a033 186(defsubst next-error-buffer-p (buffer
e967cd11 187 &optional avoid-current
f1e2a033 188 extra-test-inclusive
5f9e0ca5 189 extra-test-exclusive)
f33321ad 190 "Test if BUFFER is a `next-error' capable buffer.
e967cd11
RS
191
192If AVOID-CURRENT is non-nil, treat the current buffer
193as an absolute last resort only.
194
195The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
196that normally would not qualify. If it returns t, the buffer
197in question is treated as usable.
198
7979163c 199The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
01ba9662 200that would normally be considered usable. If it returns nil,
e967cd11
RS
201that buffer is rejected."
202 (and (buffer-name buffer) ;First make sure it's live.
203 (not (and avoid-current (eq buffer (current-buffer))))
204 (with-current-buffer buffer
205 (if next-error-function ; This is the normal test.
206 ;; Optionally reject some buffers.
207 (if extra-test-exclusive
208 (funcall extra-test-exclusive)
209 t)
210 ;; Optionally accept some other buffers.
211 (and extra-test-inclusive
212 (funcall extra-test-inclusive))))))
213
214(defun next-error-find-buffer (&optional avoid-current
f1e2a033 215 extra-test-inclusive
5f9e0ca5 216 extra-test-exclusive)
f33321ad 217 "Return a `next-error' capable buffer.
7979163c 218
e967cd11
RS
219If AVOID-CURRENT is non-nil, treat the current buffer
220as an absolute last resort only.
221
01ba9662 222The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
e967cd11
RS
223that normally would not qualify. If it returns t, the buffer
224in question is treated as usable.
225
7979163c 226The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
e967cd11
RS
227that would normally be considered usable. If it returns nil,
228that buffer is rejected."
03e75c7e
JL
229 (or
230 ;; 1. If one window on the selected frame displays such buffer, return it.
231 (let ((window-buffers
232 (delete-dups
233 (delq nil (mapcar (lambda (w)
234 (if (next-error-buffer-p
e967cd11
RS
235 (window-buffer w)
236 avoid-current
f1e2a033 237 extra-test-inclusive extra-test-exclusive)
03e75c7e
JL
238 (window-buffer w)))
239 (window-list))))))
03e75c7e
JL
240 (if (eq (length window-buffers) 1)
241 (car window-buffers)))
e967cd11 242 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
03e75c7e 243 (if (and next-error-last-buffer
e967cd11 244 (next-error-buffer-p next-error-last-buffer avoid-current
f1e2a033 245 extra-test-inclusive extra-test-exclusive))
e967cd11
RS
246 next-error-last-buffer)
247 ;; 3. If the current buffer is acceptable, choose it.
248 (if (next-error-buffer-p (current-buffer) avoid-current
249 extra-test-inclusive extra-test-exclusive)
03e75c7e 250 (current-buffer))
e967cd11 251 ;; 4. Look for any acceptable buffer.
03e75c7e
JL
252 (let ((buffers (buffer-list)))
253 (while (and buffers
e967cd11
RS
254 (not (next-error-buffer-p
255 (car buffers) avoid-current
256 extra-test-inclusive extra-test-exclusive)))
03e75c7e 257 (setq buffers (cdr buffers)))
e967cd11
RS
258 (car buffers))
259 ;; 5. Use the current buffer as a last resort if it qualifies,
260 ;; even despite AVOID-CURRENT.
261 (and avoid-current
262 (next-error-buffer-p (current-buffer) nil
263 extra-test-inclusive extra-test-exclusive)
264 (progn
265 (message "This is the only next-error capable buffer")
266 (current-buffer)))
267 ;; 6. Give up.
268 (error "No next-error capable buffer found")))
50f007fb 269
310abb0b 270(defun next-error (&optional arg reset)
f33321ad 271 "Visit next `next-error' message and corresponding source code.
50f007fb
KS
272
273If all the error messages parsed so far have been processed already,
274the message buffer is checked for new ones.
275
e462ab77 276A prefix ARG specifies how many error messages to move;
50f007fb
KS
277negative means move back to previous error messages.
278Just \\[universal-argument] as a prefix means reparse the error message buffer
279and start at the first error.
280
e249a6d8 281The RESET argument specifies that we should restart from the beginning.
50f007fb
KS
282
283\\[next-error] normally uses the most recently started
284compilation, grep, or occur buffer. It can also operate on any
285buffer with output from the \\[compile], \\[grep] commands, or,
286more generally, on any buffer in Compilation mode or with
287Compilation Minor mode enabled, or any buffer in which
03e75c7e
JL
288`next-error-function' is bound to an appropriate function.
289To specify use of a particular buffer for error messages, type
290\\[next-error] in that buffer when it is the only one displayed
291in the current frame.
50f007fb 292
d634a3a2
JL
293Once \\[next-error] has chosen the buffer for error messages, it
294runs `next-error-hook' with `run-hooks', and stays with that buffer
295until you use it in some other buffer which uses Compilation mode
296or Compilation Minor mode.
50f007fb
KS
297
298See variables `compilation-parse-errors-function' and
299\`compilation-error-regexp-alist' for customization ideas."
300 (interactive "P")
e462ab77 301 (if (consp arg) (setq reset t arg nil))
50f007fb
KS
302 (when (setq next-error-last-buffer (next-error-find-buffer))
303 ;; we know here that next-error-function is a valid symbol we can funcall
304 (with-current-buffer next-error-last-buffer
d634a3a2
JL
305 (funcall next-error-function (prefix-numeric-value arg) reset)
306 (run-hooks 'next-error-hook))))
50f007fb 307
56ab610b
RS
308(defun next-error-internal ()
309 "Visit the source code corresponding to the `next-error' message at point."
310 (setq next-error-last-buffer (current-buffer))
311 ;; we know here that next-error-function is a valid symbol we can funcall
312 (with-current-buffer next-error-last-buffer
313 (funcall next-error-function 0 nil)
314 (run-hooks 'next-error-hook)))
315
50f007fb
KS
316(defalias 'goto-next-locus 'next-error)
317(defalias 'next-match 'next-error)
318
310abb0b 319(defun previous-error (&optional n)
f33321ad 320 "Visit previous `next-error' message and corresponding source code.
50f007fb
KS
321
322Prefix arg N says how many error messages to move backwards (or
323forwards, if negative).
324
325This operates on the output from the \\[compile] and \\[grep] commands."
326 (interactive "p")
310abb0b 327 (next-error (- (or n 1))))
50f007fb 328
310abb0b 329(defun first-error (&optional n)
50f007fb
KS
330 "Restart at the first error.
331Visit corresponding source code.
332With prefix arg N, visit the source code of the Nth error.
333This operates on the output from the \\[compile] command, for instance."
334 (interactive "p")
335 (next-error n t))
336
310abb0b 337(defun next-error-no-select (&optional n)
f33321ad 338 "Move point to the next error in the `next-error' buffer and highlight match.
50f007fb
KS
339Prefix arg N says how many error messages to move forwards (or
340backwards, if negative).
341Finds and highlights the source line like \\[next-error], but does not
342select the source buffer."
343 (interactive "p")
ee9c5954
JL
344 (let ((next-error-highlight next-error-highlight-no-select))
345 (next-error n))
50f007fb
KS
346 (pop-to-buffer next-error-last-buffer))
347
310abb0b 348(defun previous-error-no-select (&optional n)
f33321ad 349 "Move point to the previous error in the `next-error' buffer and highlight match.
50f007fb
KS
350Prefix arg N says how many error messages to move backwards (or
351forwards, if negative).
352Finds and highlights the source line like \\[previous-error], but does not
353select the source buffer."
354 (interactive "p")
310abb0b 355 (next-error-no-select (- (or n 1))))
50f007fb 356
282d6eae
EZ
357;;; Internal variable for `next-error-follow-mode-post-command-hook'.
358(defvar next-error-follow-last-line nil)
359
2a223f35 360(define-minor-mode next-error-follow-minor-mode
282d6eae 361 "Minor mode for compilation, occur and diff modes.
2a223f35
EZ
362When turned on, cursor motion in the compilation, grep, occur or diff
363buffer causes automatic display of the corresponding source code
364location."
ed8e0f0a 365 :group 'next-error :init-value nil :lighter " Fol"
8a98a6c2 366 (if (not next-error-follow-minor-mode)
282d6eae
EZ
367 (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t)
368 (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t)
e56dd5c6 369 (make-local-variable 'next-error-follow-last-line)))
282d6eae
EZ
370
371;;; Used as a `post-command-hook' by `next-error-follow-mode'
372;;; for the *Compilation* *grep* and *Occur* buffers.
373(defun next-error-follow-mode-post-command-hook ()
374 (unless (equal next-error-follow-last-line (line-number-at-pos))
375 (setq next-error-follow-last-line (line-number-at-pos))
376 (condition-case nil
377 (let ((compilation-context-lines nil))
378 (setq compilation-current-error (point))
379 (next-error-no-select 0))
380 (error t))))
381
ee9c5954 382\f
50f007fb
KS
383;;;
384
93be67de
KH
385(defun fundamental-mode ()
386 "Major mode not specialized for anything in particular.
387Other major modes are defined by comparison with this one."
388 (interactive)
e174f8db 389 (kill-all-local-variables)
52167727
LK
390 (unless delay-mode-hooks
391 (run-hooks 'after-change-major-mode-hook)))
eaae8106 392
93be67de
KH
393;; Making and deleting lines.
394
4ea0018b
CY
395(defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard)))
396
30bb9754 397(defun newline (&optional arg)
d133d835 398 "Insert a newline, and move to left margin of the new line if it's blank.
058d4999
DL
399If `use-hard-newlines' is non-nil, the newline is marked with the
400text-property `hard'.
76c64e24 401With ARG, insert that many newlines.
058d4999 402Call `auto-fill-function' if the current column number is greater
6688f85f 403than the value of `fill-column' and ARG is nil."
30bb9754 404 (interactive "*P")
4c4cbf11 405 (barf-if-buffer-read-only)
30bb9754
BG
406 ;; Inserting a newline at the end of a line produces better redisplay in
407 ;; try_window_id than inserting at the beginning of a line, and the textual
408 ;; result is the same. So, if we're at beginning of line, pretend to be at
409 ;; the end of the previous line.
1e722f9f 410 (let ((flag (and (not (bobp))
30bb9754 411 (bolp)
1cd24721
RS
412 ;; Make sure no functions want to be told about
413 ;; the range of the changes.
1cd24721
RS
414 (not after-change-functions)
415 (not before-change-functions)
fd977703
RS
416 ;; Make sure there are no markers here.
417 (not (buffer-has-markers-at (1- (point))))
2f047f6c 418 (not (buffer-has-markers-at (point)))
1cd24721
RS
419 ;; Make sure no text properties want to know
420 ;; where the change was.
421 (not (get-char-property (1- (point)) 'modification-hooks))
422 (not (get-char-property (1- (point)) 'insert-behind-hooks))
423 (or (eobp)
424 (not (get-char-property (point) 'insert-in-front-hooks)))
31a5333f
MB
425 ;; Make sure the newline before point isn't intangible.
426 (not (get-char-property (1- (point)) 'intangible))
427 ;; Make sure the newline before point isn't read-only.
428 (not (get-char-property (1- (point)) 'read-only))
429 ;; Make sure the newline before point isn't invisible.
430 (not (get-char-property (1- (point)) 'invisible))
431 ;; Make sure the newline before point has the same
432 ;; properties as the char before it (if any).
1e722f9f 433 (< (or (previous-property-change (point)) -2)
d133d835
RS
434 (- (point) 2))))
435 (was-page-start (and (bolp)
436 (looking-at page-delimiter)))
437 (beforepos (point)))
30bb9754
BG
438 (if flag (backward-char 1))
439 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
440 ;; Set last-command-char to tell self-insert what to insert.
441 (let ((last-command-char ?\n)
442 ;; Don't auto-fill if we have a numeric argument.
3954fff9
RS
443 ;; Also not if flag is true (it would fill wrong line);
444 ;; there is no need to since we're at BOL.
445 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
4cc9d0dc
RS
446 (unwind-protect
447 (self-insert-command (prefix-numeric-value arg))
448 ;; If we get an error in self-insert-command, put point at right place.
449 (if flag (forward-char 1))))
2f047f6c
KH
450 ;; Even if we did *not* get an error, keep that forward-char;
451 ;; all further processing should apply to the newline that the user
452 ;; thinks he inserted.
453
30bb9754
BG
454 ;; Mark the newline(s) `hard'.
455 (if use-hard-newlines
2f047f6c 456 (set-hard-newline-properties
55741b46 457 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
d133d835
RS
458 ;; If the newline leaves the previous line blank,
459 ;; and we have a left margin, delete that from the blank line.
460 (or flag
461 (save-excursion
462 (goto-char beforepos)
463 (beginning-of-line)
464 (and (looking-at "[ \t]$")
465 (> (current-left-margin) 0)
466 (delete-region (point) (progn (end-of-line) (point))))))
d133d835
RS
467 ;; Indent the line after the newline, except in one case:
468 ;; when we added the newline at the beginning of a line
469 ;; which starts a page.
470 (or was-page-start
471 (move-to-left-margin nil t)))
30bb9754
BG
472 nil)
473
55741b46
RS
474(defun set-hard-newline-properties (from to)
475 (let ((sticky (get-text-property from 'rear-nonsticky)))
476 (put-text-property from to 'hard 't)
477 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
478 (if (and (listp sticky) (not (memq 'hard sticky)))
479 (put-text-property from (point) 'rear-nonsticky
480 (cons 'hard sticky)))))
eaae8106 481
e249a6d8 482(defun open-line (n)
ff1fbe3e 483 "Insert a newline and leave point before it.
f33321ad
JB
484If there is a fill prefix and/or a `left-margin', insert them
485on the new line if the line would have been blank.
616ed245 486With arg N, insert N newlines."
2076c87c 487 (interactive "*p")
616ed245 488 (let* ((do-fill-prefix (and fill-prefix (bolp)))
3db1e3b5 489 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
207d7545
GM
490 (loc (point))
491 ;; Don't expand an abbrev before point.
492 (abbrev-mode nil))
e249a6d8 493 (newline n)
d133d835 494 (goto-char loc)
e249a6d8 495 (while (> n 0)
d133d835
RS
496 (cond ((bolp)
497 (if do-left-margin (indent-to (current-left-margin)))
498 (if do-fill-prefix (insert-and-inherit fill-prefix))))
499 (forward-line 1)
e249a6d8 500 (setq n (1- n)))
d133d835
RS
501 (goto-char loc)
502 (end-of-line)))
2076c87c 503
da7d231b
KS
504(defun split-line (&optional arg)
505 "Split current line, moving portion beyond point vertically down.
506If the current line starts with `fill-prefix', insert it on the new
f33321ad 507line as well. With prefix ARG, don't insert `fill-prefix' on new line.
da7d231b 508
e249a6d8 509When called from Lisp code, ARG may be a prefix string to copy."
da7d231b 510 (interactive "*P")
2076c87c 511 (skip-chars-forward " \t")
d77bbdc9
RS
512 (let* ((col (current-column))
513 (pos (point))
514 ;; What prefix should we check for (nil means don't).
515 (prefix (cond ((stringp arg) arg)
516 (arg nil)
517 (t fill-prefix)))
518 ;; Does this line start with it?
519 (have-prfx (and prefix
520 (save-excursion
521 (beginning-of-line)
522 (looking-at (regexp-quote prefix))))))
28191e20 523 (newline 1)
d77bbdc9 524 (if have-prfx (insert-and-inherit prefix))
2076c87c
JB
525 (indent-to col 0)
526 (goto-char pos)))
527
2076c87c
JB
528(defun delete-indentation (&optional arg)
529 "Join this line to previous and fix up whitespace at join.
ccc58657 530If there is a fill prefix, delete it from the beginning of this line.
2076c87c
JB
531With argument, join this line to following line."
532 (interactive "*P")
533 (beginning-of-line)
534 (if arg (forward-line 1))
535 (if (eq (preceding-char) ?\n)
536 (progn
537 (delete-region (point) (1- (point)))
ccc58657
RS
538 ;; If the second line started with the fill prefix,
539 ;; delete the prefix.
540 (if (and fill-prefix
01b8e020 541 (<= (+ (point) (length fill-prefix)) (point-max))
ccc58657
RS
542 (string= fill-prefix
543 (buffer-substring (point)
544 (+ (point) (length fill-prefix)))))
545 (delete-region (point) (+ (point) (length fill-prefix))))
2076c87c
JB
546 (fixup-whitespace))))
547
fc025090 548(defalias 'join-line #'delete-indentation) ; easier to find
eaae8106 549
2076c87c
JB
550(defun delete-blank-lines ()
551 "On blank line, delete all surrounding blank lines, leaving just one.
552On isolated blank line, delete that one.
6d30d416 553On nonblank line, delete any immediately following blank lines."
2076c87c
JB
554 (interactive "*")
555 (let (thisblank singleblank)
556 (save-excursion
557 (beginning-of-line)
558 (setq thisblank (looking-at "[ \t]*$"))
70e14c01 559 ;; Set singleblank if there is just one blank line here.
2076c87c
JB
560 (setq singleblank
561 (and thisblank
562 (not (looking-at "[ \t]*\n[ \t]*$"))
563 (or (bobp)
564 (progn (forward-line -1)
565 (not (looking-at "[ \t]*$")))))))
70e14c01 566 ;; Delete preceding blank lines, and this one too if it's the only one.
2076c87c
JB
567 (if thisblank
568 (progn
569 (beginning-of-line)
570 (if singleblank (forward-line 1))
571 (delete-region (point)
572 (if (re-search-backward "[^ \t\n]" nil t)
573 (progn (forward-line 1) (point))
574 (point-min)))))
70e14c01
JB
575 ;; Delete following blank lines, unless the current line is blank
576 ;; and there are no following blank lines.
2076c87c
JB
577 (if (not (and thisblank singleblank))
578 (save-excursion
579 (end-of-line)
580 (forward-line 1)
581 (delete-region (point)
582 (if (re-search-forward "[^ \t\n]" nil t)
583 (progn (beginning-of-line) (point))
70e14c01
JB
584 (point-max)))))
585 ;; Handle the special case where point is followed by newline and eob.
586 ;; Delete the line, leaving point at eob.
587 (if (looking-at "^[ \t]*\n\\'")
588 (delete-region (point) (point-max)))))
2076c87c 589
eaae8106
SS
590(defun delete-trailing-whitespace ()
591 "Delete all the trailing whitespace across the current buffer.
592All whitespace after the last non-whitespace character in a line is deleted.
103db06c
RS
593This respects narrowing, created by \\[narrow-to-region] and friends.
594A formfeed is not considered whitespace by this function."
eaae8106
SS
595 (interactive "*")
596 (save-match-data
597 (save-excursion
598 (goto-char (point-min))
5c9b3fac
MB
599 (while (re-search-forward "\\s-$" nil t)
600 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
3a768251 601 ;; Don't delete formfeeds, even if they are considered whitespace.
661aa5c7
GM
602 (save-match-data
603 (if (looking-at ".*\f")
604 (goto-char (match-end 0))))
7981d89f 605 (delete-region (point) (match-end 0))))))
eaae8106 606
2076c87c
JB
607(defun newline-and-indent ()
608 "Insert a newline, then indent according to major mode.
ff1fbe3e 609Indentation is done using the value of `indent-line-function'.
2076c87c 610In programming language modes, this is the same as TAB.
ff1fbe3e 611In some text modes, where TAB inserts a tab, this command indents to the
eed5698b 612column specified by the function `current-left-margin'."
2076c87c 613 (interactive "*")
5ff4ba3d 614 (delete-horizontal-space t)
46947372 615 (newline)
2076c87c
JB
616 (indent-according-to-mode))
617
618(defun reindent-then-newline-and-indent ()
619 "Reindent current line, insert newline, then indent the new line.
620Indentation of both lines is done according to the current major mode,
ff1fbe3e 621which means calling the current value of `indent-line-function'.
2076c87c
JB
622In programming language modes, this is the same as TAB.
623In some text modes, where TAB inserts a tab, this indents to the
eed5698b 624column specified by the function `current-left-margin'."
2076c87c 625 (interactive "*")
e1e04350
SM
626 (let ((pos (point)))
627 ;; Be careful to insert the newline before indenting the line.
628 ;; Otherwise, the indentation might be wrong.
629 (newline)
630 (save-excursion
631 (goto-char pos)
fd2c4cd8
SM
632 (indent-according-to-mode)
633 (delete-horizontal-space t))
e1e04350 634 (indent-according-to-mode)))
eaae8106 635
93be67de
KH
636(defun quoted-insert (arg)
637 "Read next input character and insert it.
638This is useful for inserting control characters.
2076c87c 639
93be67de
KH
640If the first character you type after this command is an octal digit,
641you should type a sequence of octal digits which specify a character code.
642Any nondigit terminates the sequence. If the terminator is a RET,
643it is discarded; any other terminator is used itself as input.
644The variable `read-quoted-char-radix' specifies the radix for this feature;
645set it to 10 or 16 to use decimal or hex instead of octal.
dff7d67f 646
93be67de
KH
647In overwrite mode, this function inserts the character anyway, and
648does not handle octal digits specially. This means that if you use
649overwrite as your normal editing mode, you can use this function to
650insert characters when necessary.
dff7d67f 651
93be67de
KH
652In binary overwrite mode, this function does overwrite, and octal
653digits are interpreted as a character code. This is intended to be
654useful for editing binary files."
655 (interactive "*p")
1f57934c 656 (let* ((char (let (translation-table-for-input input-method-function)
940fe486
DL
657 (if (or (not overwrite-mode)
658 (eq overwrite-mode 'overwrite-mode-binary))
659 (read-quoted-char)
660 (read-char)))))
93be67de
KH
661 ;; Assume character codes 0240 - 0377 stand for characters in some
662 ;; single-byte character set, and convert them to Emacs
663 ;; characters.
664 (if (and enable-multibyte-characters
665 (>= char ?\240)
666 (<= char ?\377))
667 (setq char (unibyte-char-to-multibyte char)))
668 (if (> arg 0)
669 (if (eq overwrite-mode 'overwrite-mode-binary)
670 (delete-char arg)))
671 (while (> arg 0)
672 (insert-and-inherit char)
673 (setq arg (1- arg)))))
eaae8106 674
b82d844f 675(defun forward-to-indentation (&optional arg)
93be67de
KH
676 "Move forward ARG lines and position at first nonblank character."
677 (interactive "p")
b82d844f 678 (forward-line (or arg 1))
93be67de 679 (skip-chars-forward " \t"))
cc2b2b6c 680
b82d844f 681(defun backward-to-indentation (&optional arg)
93be67de
KH
682 "Move backward ARG lines and position at first nonblank character."
683 (interactive "p")
b82d844f 684 (forward-line (- (or arg 1)))
93be67de 685 (skip-chars-forward " \t"))
2076c87c 686
93be67de
KH
687(defun back-to-indentation ()
688 "Move point to the first non-whitespace character on this line."
689 (interactive)
690 (beginning-of-line 1)
1e96c007 691 (skip-syntax-forward " " (line-end-position))
b9863466
RS
692 ;; Move back over chars that have whitespace syntax but have the p flag.
693 (backward-prefix-chars))
93be67de
KH
694
695(defun fixup-whitespace ()
696 "Fixup white space between objects around point.
697Leave one space or none, according to the context."
698 (interactive "*")
699 (save-excursion
700 (delete-horizontal-space)
701 (if (or (looking-at "^\\|\\s)")
702 (save-excursion (forward-char -1)
703 (looking-at "$\\|\\s(\\|\\s'")))
704 nil
f33321ad 705 (insert ?\s))))
93be67de 706
5ff4ba3d
MB
707(defun delete-horizontal-space (&optional backward-only)
708 "Delete all spaces and tabs around point.
709If BACKWARD-ONLY is non-nil, only delete spaces before point."
93be67de 710 (interactive "*")
9ab59a1a
MB
711 (let ((orig-pos (point)))
712 (delete-region
713 (if backward-only
714 orig-pos
715 (progn
716 (skip-chars-forward " \t")
717 (constrain-to-field nil orig-pos t)))
5ff4ba3d 718 (progn
9ab59a1a
MB
719 (skip-chars-backward " \t")
720 (constrain-to-field nil orig-pos)))))
93be67de 721
68c16b59 722(defun just-one-space (&optional n)
56abefac
RS
723 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
724 (interactive "*p")
9ab59a1a
MB
725 (let ((orig-pos (point)))
726 (skip-chars-backward " \t")
727 (constrain-to-field nil orig-pos)
68c16b59 728 (dotimes (i (or n 1))
f33321ad 729 (if (= (following-char) ?\s)
56abefac 730 (forward-char 1)
f33321ad 731 (insert ?\s)))
9ab59a1a
MB
732 (delete-region
733 (point)
734 (progn
735 (skip-chars-forward " \t")
736 (constrain-to-field nil orig-pos t)))))
2d88b556 737\f
2076c87c
JB
738(defun beginning-of-buffer (&optional arg)
739 "Move point to the beginning of the buffer; leave mark at previous position.
a416e7ef
KS
740With \\[universal-argument] prefix, do not set mark at previous position.
741With numeric arg N, put point N/10 of the way from the beginning.
c66587fe
RS
742
743If the buffer is narrowed, this command uses the beginning and size
744of the accessible part of the buffer.
ff1fbe3e
RS
745
746Don't use this command in Lisp programs!
2076c87c
JB
747\(goto-char (point-min)) is faster and avoids clobbering the mark."
748 (interactive "P")
24199fe7 749 (or (consp arg)
705a5933
JL
750 (and transient-mark-mode mark-active)
751 (push-mark))
c66587fe 752 (let ((size (- (point-max) (point-min))))
a416e7ef 753 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
754 (+ (point-min)
755 (if (> size 10000)
756 ;; Avoid overflow for large buffer sizes!
757 (* (prefix-numeric-value arg)
758 (/ size 10))
759 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
760 (point-min))))
2076c87c
JB
761 (if arg (forward-line 1)))
762
763(defun end-of-buffer (&optional arg)
764 "Move point to the end of the buffer; leave mark at previous position.
a416e7ef
KS
765With \\[universal-argument] prefix, do not set mark at previous position.
766With numeric arg N, put point N/10 of the way from the end.
c66587fe
RS
767
768If the buffer is narrowed, this command uses the beginning and size
769of the accessible part of the buffer.
ff1fbe3e
RS
770
771Don't use this command in Lisp programs!
2076c87c
JB
772\(goto-char (point-max)) is faster and avoids clobbering the mark."
773 (interactive "P")
24199fe7 774 (or (consp arg)
705a5933
JL
775 (and transient-mark-mode mark-active)
776 (push-mark))
c66587fe 777 (let ((size (- (point-max) (point-min))))
a416e7ef 778 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
779 (- (point-max)
780 (if (> size 10000)
781 ;; Avoid overflow for large buffer sizes!
782 (* (prefix-numeric-value arg)
783 (/ size 10))
784 (/ (* size (prefix-numeric-value arg)) 10)))
785 (point-max))))
3a801d0c
ER
786 ;; If we went to a place in the middle of the buffer,
787 ;; adjust it to the beginning of a line.
314808dc 788 (cond (arg (forward-line 1))
919f2812 789 ((> (point) (window-end nil t))
314808dc
GM
790 ;; If the end of the buffer is not already on the screen,
791 ;; then scroll specially to put it near, but not at, the bottom.
792 (overlay-recenter (point))
793 (recenter -3))))
2076c87c
JB
794
795(defun mark-whole-buffer ()
70e14c01
JB
796 "Put point at beginning and mark at end of buffer.
797You probably should not use this function in Lisp programs;
798it is usually a mistake for a Lisp function to use any subroutine
799that uses or sets the mark."
2076c87c
JB
800 (interactive)
801 (push-mark (point))
fd0f4056 802 (push-mark (point-max) nil t)
2076c87c 803 (goto-char (point-min)))
2d88b556 804\f
eaae8106 805
93be67de
KH
806;; Counting lines, one way or another.
807
00a369ac
RS
808(defun goto-line (arg &optional buffer)
809 "Goto line ARG, counting from line 1 at beginning of buffer.
09ad1a5b
EZ
810Normally, move point in the current buffer.
811With just \\[universal-argument] as argument, move point in the most recently
812displayed other buffer, and switch to it. When called from Lisp code,
813the optional argument BUFFER specifies a buffer to switch to.
00a369ac
RS
814
815If there's a number in the buffer at point, it is the default for ARG."
816 (interactive
817 (if (and current-prefix-arg (not (consp current-prefix-arg)))
818 (list (prefix-numeric-value current-prefix-arg))
819 ;; Look for a default, a number in the buffer at point.
820 (let* ((default
821 (save-excursion
822 (skip-chars-backward "0-9")
823 (if (looking-at "[0-9]")
824 (buffer-substring-no-properties
825 (point)
826 (progn (skip-chars-forward "0-9")
827 (point))))))
828 ;; Decide if we're switching buffers.
829 (buffer
830 (if (consp current-prefix-arg)
831 (other-buffer (current-buffer) t)))
832 (buffer-prompt
833 (if buffer
834 (concat " in " (buffer-name buffer))
835 "")))
836 ;; Read the argument, offering that number (if any) as default.
837 (list (read-from-minibuffer (format (if default "Goto line%s (%s): "
838 "Goto line%s: ")
839 buffer-prompt
840 default)
841 nil nil t
842 'minibuffer-history
843 default)
844 buffer))))
845 ;; Switch to the desired buffer, one way or another.
846 (if buffer
847 (let ((window (get-buffer-window buffer)))
848 (if window (select-window window)
849 (switch-to-buffer-other-window buffer))))
850 ;; Move to the specified line number in that buffer.
93be67de
KH
851 (save-restriction
852 (widen)
853 (goto-char 1)
854 (if (eq selective-display t)
855 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
f38c52df 856 (forward-line (1- arg)))))
2076c87c
JB
857
858(defun count-lines-region (start end)
eb8c3be9 859 "Print number of lines and characters in the region."
2076c87c
JB
860 (interactive "r")
861 (message "Region has %d lines, %d characters"
862 (count-lines start end) (- end start)))
863
864(defun what-line ()
2578be76 865 "Print the current buffer line number and narrowed line number of point."
2076c87c 866 (interactive)
c6db81aa 867 (let ((start (point-min))
4109ce02 868 (n (line-number-at-pos)))
f076870a
KS
869 (if (= start 1)
870 (message "Line %d" n)
871 (save-excursion
872 (save-restriction
873 (widen)
8e5d85ff 874 (message "line %d (narrowed line %d)"
4109ce02 875 (+ n (line-number-at-pos start) -1) n))))))
2578be76 876
2076c87c
JB
877(defun count-lines (start end)
878 "Return number of lines between START and END.
879This is usually the number of newlines between them,
ff1fbe3e 880but can be one more if START is not equal to END
2076c87c 881and the greater of them is not at the start of a line."
e406700d
RS
882 (save-excursion
883 (save-restriction
884 (narrow-to-region start end)
885 (goto-char (point-min))
886 (if (eq selective-display t)
887 (save-match-data
dde92ca6
RS
888 (let ((done 0))
889 (while (re-search-forward "[\n\C-m]" nil t 40)
890 (setq done (+ 40 done)))
891 (while (re-search-forward "[\n\C-m]" nil t 1)
892 (setq done (+ 1 done)))
043efc41
RS
893 (goto-char (point-max))
894 (if (and (/= start end)
895 (not (bolp)))
896 (1+ done)
e406700d
RS
897 done)))
898 (- (buffer-size) (forward-line (buffer-size)))))))
eaae8106 899
4109ce02 900(defun line-number-at-pos (&optional pos)
f076870a
KS
901 "Return (narrowed) buffer line number at position POS.
902If POS is nil, use current buffer location."
903 (let ((opoint (or pos (point))) start)
904 (save-excursion
905 (goto-char (point-min))
906 (setq start (point))
907 (goto-char opoint)
908 (forward-line 0)
909 (1+ (count-lines start (point))))))
910
d5d99b80
KH
911(defun what-cursor-position (&optional detail)
912 "Print info on cursor position (on screen and within buffer).
e38dff0c 913Also describe the character after point, and give its character code
c6fcc518
KH
914in octal, decimal and hex.
915
916For a non-ASCII multibyte character, also give its encoding in the
917buffer's selected coding system if the coding system encodes the
918character safely. If the character is encoded into one byte, that
919code is shown in hex. If the character is encoded into more than one
920byte, just \"...\" is shown.
e5a902cf 921
24dad5d5 922In addition, with prefix argument, show details about that character
0b69eec5 923in *Help* buffer. See also the command `describe-char'."
d5d99b80 924 (interactive "P")
2076c87c
JB
925 (let* ((char (following-char))
926 (beg (point-min))
927 (end (point-max))
928 (pos (point))
929 (total (buffer-size))
930 (percent (if (> total 50000)
931 ;; Avoid overflow from multiplying by 100!
932 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
933 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
934 (hscroll (if (= (window-hscroll) 0)
935 ""
936 (format " Hscroll=%d" (window-hscroll))))
937 (col (current-column)))
938 (if (= pos end)
939 (if (or (/= beg 1) (/= end (1+ total)))
a17a79c0 940 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
2076c87c 941 pos total percent beg end col hscroll)
a17a79c0 942 (message "point=%d of %d (EOB) column=%d%s"
63219d53 943 pos total col hscroll))
c6fcc518 944 (let ((coding buffer-file-coding-system)
a41b50ca 945 encoded encoding-msg display-prop under-display)
c6fcc518
KH
946 (if (or (not coding)
947 (eq (coding-system-type coding) t))
948 (setq coding default-buffer-file-coding-system))
28fd4883
KH
949 (if (not (char-valid-p char))
950 (setq encoding-msg
a17a79c0 951 (format "(%d, #o%o, #x%x, invalid)" char char char))
a41b50ca
KH
952 ;; Check if the character is displayed with some `display'
953 ;; text property. In that case, set under-display to the
954 ;; buffer substring covered by that property.
955 (setq display-prop (get-text-property pos 'display))
956 (if display-prop
957 (let ((to (or (next-single-property-change pos 'display)
958 (point-max))))
959 (if (< to (+ pos 4))
960 (setq under-display "")
961 (setq under-display "..."
962 to (+ pos 4)))
963 (setq under-display
964 (concat (buffer-substring-no-properties pos to)
965 under-display)))
966 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
28fd4883 967 (setq encoding-msg
a41b50ca
KH
968 (if display-prop
969 (if (not (stringp display-prop))
a17a79c0 970 (format "(%d, #o%o, #x%x, part of display \"%s\")"
a41b50ca 971 char char char under-display)
a17a79c0 972 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
a41b50ca
KH
973 char char char under-display display-prop))
974 (if encoded
a17a79c0 975 (format "(%d, #o%o, #x%x, file %s)"
a41b50ca
KH
976 char char char
977 (if (> (length encoded) 1)
978 "..."
979 (encoded-string-description encoded coding)))
a17a79c0 980 (format "(%d, #o%o, #x%x)" char char char)))))
e5e89e48 981 (if detail
24dad5d5 982 ;; We show the detailed information about CHAR.
0b69eec5 983 (describe-char (point)))
24dad5d5 984 (if (or (/= beg 1) (/= end (1+ total)))
a17a79c0 985 (message "Char: %s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
e5a902cf
KH
986 (if (< char 256)
987 (single-key-description char)
f0d16a7f 988 (buffer-substring-no-properties (point) (1+ (point))))
24dad5d5 989 encoding-msg pos total percent beg end col hscroll)
a17a79c0 990 (message "Char: %s %s point=%d of %d (%d%%) column=%d%s"
a41b50ca
KH
991 (if enable-multibyte-characters
992 (if (< char 128)
993 (single-key-description char)
994 (buffer-substring-no-properties (point) (1+ (point))))
995 (single-key-description char))
24dad5d5 996 encoding-msg pos total percent col hscroll))))))
2d88b556 997\f
76c64e24
SM
998(defvar read-expression-map
999 (let ((m (make-sparse-keymap)))
1000 (define-key m "\M-\t" 'lisp-complete-symbol)
1001 (set-keymap-parent m minibuffer-local-map)
1002 m)
854c16c5 1003 "Minibuffer keymap used for reading Lisp expressions.")
854c16c5 1004
8570b0ca
RM
1005(defvar read-expression-history nil)
1006
b49df39d 1007(defcustom eval-expression-print-level 4
2f7e1f5a 1008 "Value for `print-level' while printing value in `eval-expression'.
d26b26dc 1009A value of nil means no limit."
b49df39d 1010 :group 'lisp
058d4999 1011 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
1012 :version "21.1")
1013
1014(defcustom eval-expression-print-length 12
2f7e1f5a 1015 "Value for `print-length' while printing value in `eval-expression'.
d26b26dc 1016A value of nil means no limit."
b49df39d 1017 :group 'lisp
058d4999 1018 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
1019 :version "21.1")
1020
1021(defcustom eval-expression-debug-on-error t
2f7e1f5a 1022 "If non-nil set `debug-on-error' to t in `eval-expression'.
ed8bcabe 1023If nil, don't change the value of `debug-on-error'."
b49df39d
RS
1024 :group 'lisp
1025 :type 'boolean
1026 :version "21.1")
1027
fa219ebd
JL
1028(defun eval-expression-print-format (value)
1029 "Format VALUE as a result of evaluated expression.
1030Return a formatted string which is displayed in the echo area
1031in addition to the value printed by prin1 in functions which
1032display the result of expression evaluation."
1033 (if (and (integerp value)
c9f0110e 1034 (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd 1035 (eq this-command last-command)
56abefac 1036 (if (boundp 'edebug-active) edebug-active)))
fa219ebd 1037 (let ((char-string
9bb25ed3 1038 (if (or (if (boundp 'edebug-active) edebug-active)
c9f0110e 1039 (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd
JL
1040 (prin1-char value))))
1041 (if char-string
1b5fd09e
SM
1042 (format " (#o%o, #x%x, %s)" value value char-string)
1043 (format " (#o%o, #x%x)" value value)))))
fa219ebd 1044
8570b0ca 1045;; We define this, rather than making `eval' interactive,
2076c87c 1046;; for the sake of completion of names like eval-region, eval-current-buffer.
ecb7ad00
RS
1047(defun eval-expression (eval-expression-arg
1048 &optional eval-expression-insert-value)
a6a1ee53
EZ
1049 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1050Value is also consed on to front of the variable `values'.
1051Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1052insert the result into the current buffer instead of printing it in
b4f73994
RS
1053the echo area.
1054
1055If `eval-expression-debug-on-error' is non-nil, which is the default,
1056this command arranges for all errors to enter the debugger."
adca5fa6 1057 (interactive
b387ef9a
RS
1058 (list (read-from-minibuffer "Eval: "
1059 nil read-expression-map t
ecb7ad00
RS
1060 'read-expression-history)
1061 current-prefix-arg))
eaae8106 1062
ed8bcabe
GM
1063 (if (null eval-expression-debug-on-error)
1064 (setq values (cons (eval eval-expression-arg) values))
1065 (let ((old-value (make-symbol "t")) new-value)
1066 ;; Bind debug-on-error to something unique so that we can
1067 ;; detect when evaled code changes it.
1068 (let ((debug-on-error old-value))
1069 (setq values (cons (eval eval-expression-arg) values))
1070 (setq new-value debug-on-error))
1071 ;; If evaled code has changed the value of debug-on-error,
1072 ;; propagate that change to the global binding.
1073 (unless (eq old-value new-value)
1074 (setq debug-on-error new-value))))
eaae8106 1075
b49df39d
RS
1076 (let ((print-length eval-expression-print-length)
1077 (print-level eval-expression-print-level))
b82d844f
RS
1078 (if eval-expression-insert-value
1079 (with-no-warnings
683e7415
RS
1080 (let ((standard-output (current-buffer)))
1081 (eval-last-sexp-print-value (car values))))
fa219ebd
JL
1082 (prog1
1083 (prin1 (car values) t)
1084 (let ((str (eval-expression-print-format (car values))))
1085 (if str (princ str t)))))))
2076c87c
JB
1086
1087(defun edit-and-eval-command (prompt command)
1088 "Prompting with PROMPT, let user edit COMMAND and eval result.
1089COMMAND is a Lisp expression. Let user edit that expression in
1090the minibuffer, then read and evaluate the result."
9f4b6084 1091 (let ((command
11178a06
LT
1092 (let ((print-level nil)
1093 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1094 (unwind-protect
1095 (read-from-minibuffer prompt
1096 (prin1-to-string command)
1097 read-expression-map t
1098 'command-history)
1099 ;; If command was added to command-history as a string,
1100 ;; get rid of that. We want only evaluable expressions there.
1101 (if (stringp (car command-history))
1102 (setq command-history (cdr command-history)))))))
5d6c83ae
KH
1103
1104 ;; If command to be redone does not match front of history,
1105 ;; add it to the history.
1106 (or (equal command (car command-history))
1107 (setq command-history (cons command command-history)))
2076c87c
JB
1108 (eval command)))
1109
ebb61177 1110(defun repeat-complex-command (arg)
2076c87c
JB
1111 "Edit and re-evaluate last complex command, or ARGth from last.
1112A complex command is one which used the minibuffer.
1113The command is placed in the minibuffer as a Lisp form for editing.
1114The result is executed, repeating the command as changed.
1115If the command has been changed or is not the most recent previous command
1116it is added to the front of the command history.
eb6e9899
RS
1117You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1118to get different commands to edit and resubmit."
2076c87c 1119 (interactive "p")
ba343182 1120 (let ((elt (nth (1- arg) command-history))
2076c87c
JB
1121 newcmd)
1122 (if elt
854c16c5 1123 (progn
eab22e27 1124 (setq newcmd
74ae5fab
RS
1125 (let ((print-level nil)
1126 (minibuffer-history-position arg)
99ea24de 1127 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
9f4b6084
MR
1128 (unwind-protect
1129 (read-from-minibuffer
1130 "Redo: " (prin1-to-string elt) read-expression-map t
1131 (cons 'command-history arg))
1132
1133 ;; If command was added to command-history as a
1134 ;; string, get rid of that. We want only
1135 ;; evaluable expressions there.
1136 (if (stringp (car command-history))
1137 (setq command-history (cdr command-history))))))
db16f109
RS
1138
1139 ;; If command to be redone does not match front of history,
1140 ;; add it to the history.
1141 (or (equal newcmd (car command-history))
1142 (setq command-history (cons newcmd command-history)))
2076c87c 1143 (eval newcmd))
536b728a
RS
1144 (if command-history
1145 (error "Argument %d is beyond length of command history" arg)
1146 (error "There are no previous complex commands to repeat")))))
2d88b556 1147\f
854c16c5
RS
1148(defvar minibuffer-history nil
1149 "Default minibuffer history list.
1150This is used for all minibuffer input
1151except when an alternate history list is specified.")
1152(defvar minibuffer-history-sexp-flag nil
2c6a2254
RS
1153 "Control whether history list elements are expressions or strings.
1154If the value of this variable equals current minibuffer depth,
1155they are expressions; otherwise they are strings.
7979163c 1156\(That convention is designed to do the right thing for
2c6a2254 1157recursive uses of the minibuffer.)")
e91f80c4
RS
1158(setq minibuffer-history-variable 'minibuffer-history)
1159(setq minibuffer-history-position nil)
854c16c5 1160(defvar minibuffer-history-search-history nil)
e91f80c4 1161
93cee14b
RS
1162(defvar minibuffer-text-before-history nil
1163 "Text that was in this minibuffer before any history commands.
1164This is nil if there have not yet been any history commands
1165in this use of the minibuffer.")
1166
1167(add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1168
1169(defun minibuffer-history-initialize ()
1170 (setq minibuffer-text-before-history nil))
1171
6e7d0ff7
MB
1172(defun minibuffer-avoid-prompt (new old)
1173 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1174 (constrain-to-field nil (point-max)))
1175
6e30a99a
RS
1176(defcustom minibuffer-history-case-insensitive-variables nil
1177 "*Minibuffer history variables for which matching should ignore case.
1178If a history variable is a member of this list, then the
1179\\[previous-matching-history-element] and \\[next-matching-history-element]\
1180 commands ignore case when searching it, regardless of `case-fold-search'."
1181 :type '(repeat variable)
1182 :group 'minibuffer)
1183
e91f80c4 1184(defun previous-matching-history-element (regexp n)
854c16c5
RS
1185 "Find the previous history element that matches REGEXP.
1186\(Previous history elements refer to earlier actions.)
1187With prefix argument N, search for Nth previous match.
5c2010f0 1188If N is negative, find the next or Nth next match.
9889af08
EZ
1189Normally, history elements are matched case-insensitively if
1190`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1191makes the search case-sensitive.
6e30a99a 1192See also `minibuffer-history-case-insensitive-variables'."
854c16c5 1193 (interactive
c1172a19 1194 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1195 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1196 nil
1197 minibuffer-local-map
1198 nil
5794c45d
RS
1199 'minibuffer-history-search-history
1200 (car minibuffer-history-search-history))))
c1172a19
RS
1201 ;; Use the last regexp specified, by default, if input is empty.
1202 (list (if (string= regexp "")
a8e96cea
KH
1203 (if minibuffer-history-search-history
1204 (car minibuffer-history-search-history)
1205 (error "No previous history search regexp"))
c1172a19 1206 regexp)
854c16c5 1207 (prefix-numeric-value current-prefix-arg))))
e276a14a
MB
1208 (unless (zerop n)
1209 (if (and (zerop minibuffer-history-position)
1210 (null minibuffer-text-before-history))
efaac2e6 1211 (setq minibuffer-text-before-history
6d74d713 1212 (minibuffer-contents-no-properties)))
e276a14a
MB
1213 (let ((history (symbol-value minibuffer-history-variable))
1214 (case-fold-search
1215 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1216 ;; On some systems, ignore case for file names.
1217 (if (memq minibuffer-history-variable
1218 minibuffer-history-case-insensitive-variables)
1219 t
1220 ;; Respect the user's setting for case-fold-search:
1221 case-fold-search)
1222 nil))
1223 prevpos
1224 match-string
1225 match-offset
1226 (pos minibuffer-history-position))
1227 (while (/= n 0)
1228 (setq prevpos pos)
1229 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1230 (when (= pos prevpos)
e91f80c4 1231 (error (if (= pos 1)
ccc58657
RS
1232 "No later matching history item"
1233 "No earlier matching history item")))
e276a14a
MB
1234 (setq match-string
1235 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
7908d27c 1236 (let ((print-level nil))
e276a14a
MB
1237 (prin1-to-string (nth (1- pos) history)))
1238 (nth (1- pos) history)))
1239 (setq match-offset
1240 (if (< n 0)
1241 (and (string-match regexp match-string)
1242 (match-end 0))
1243 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1244 (match-beginning 1))))
1245 (when match-offset
1246 (setq n (+ n (if (< n 0) 1 -1)))))
1247 (setq minibuffer-history-position pos)
1248 (goto-char (point-max))
efaac2e6 1249 (delete-minibuffer-contents)
e276a14a 1250 (insert match-string)
6d74d713 1251 (goto-char (+ (minibuffer-prompt-end) match-offset))))
e1e04350
SM
1252 (if (memq (car (car command-history)) '(previous-matching-history-element
1253 next-matching-history-element))
854c16c5 1254 (setq command-history (cdr command-history))))
e91f80c4 1255
e91f80c4 1256(defun next-matching-history-element (regexp n)
854c16c5
RS
1257 "Find the next history element that matches REGEXP.
1258\(The next history element refers to a more recent action.)
1259With prefix argument N, search for Nth next match.
5c2010f0 1260If N is negative, find the previous or Nth previous match.
9889af08
EZ
1261Normally, history elements are matched case-insensitively if
1262`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1263makes the search case-sensitive."
854c16c5 1264 (interactive
c1172a19 1265 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1266 (regexp (read-from-minibuffer "Next element matching (regexp): "
1267 nil
1268 minibuffer-local-map
1269 nil
e967cd11
RS
1270 'minibuffer-history-search-history
1271 (car minibuffer-history-search-history))))
c1172a19
RS
1272 ;; Use the last regexp specified, by default, if input is empty.
1273 (list (if (string= regexp "")
e967cd11
RS
1274 (if minibuffer-history-search-history
1275 (car minibuffer-history-search-history)
1276 (error "No previous history search regexp"))
c1172a19 1277 regexp)
854c16c5 1278 (prefix-numeric-value current-prefix-arg))))
e91f80c4 1279 (previous-matching-history-element regexp (- n)))
2076c87c 1280
8dc3ba7d
MB
1281(defvar minibuffer-temporary-goal-position nil)
1282
ebb61177
RS
1283(defun next-history-element (n)
1284 "Insert the next element of the minibuffer history into the minibuffer."
2076c87c 1285 (interactive "p")
0818b15e 1286 (or (zerop n)
93cee14b
RS
1287 (let ((narg (- minibuffer-history-position n))
1288 (minimum (if minibuffer-default -1 0))
068c712c 1289 elt minibuffer-returned-to-present)
93cee14b
RS
1290 (if (and (zerop minibuffer-history-position)
1291 (null minibuffer-text-before-history))
efaac2e6
MB
1292 (setq minibuffer-text-before-history
1293 (minibuffer-contents-no-properties)))
93cee14b 1294 (if (< narg minimum)
81091543
RS
1295 (if minibuffer-default
1296 (error "End of history; no next item")
1297 (error "End of history; no default available")))
93cee14b
RS
1298 (if (> narg (length (symbol-value minibuffer-history-variable)))
1299 (error "Beginning of history; no preceding item"))
e1e04350
SM
1300 (unless (memq last-command '(next-history-element
1301 previous-history-element))
efaac2e6 1302 (let ((prompt-end (minibuffer-prompt-end)))
8dc3ba7d
MB
1303 (set (make-local-variable 'minibuffer-temporary-goal-position)
1304 (cond ((<= (point) prompt-end) prompt-end)
1305 ((eobp) nil)
1306 (t (point))))))
a4d1159b 1307 (goto-char (point-max))
efaac2e6 1308 (delete-minibuffer-contents)
93cee14b
RS
1309 (setq minibuffer-history-position narg)
1310 (cond ((= narg -1)
1311 (setq elt minibuffer-default))
1312 ((= narg 0)
54c548db 1313 (setq elt (or minibuffer-text-before-history ""))
068c712c 1314 (setq minibuffer-returned-to-present t)
93cee14b
RS
1315 (setq minibuffer-text-before-history nil))
1316 (t (setq elt (nth (1- minibuffer-history-position)
1317 (symbol-value minibuffer-history-variable)))))
1318 (insert
068c712c
KH
1319 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1320 (not minibuffer-returned-to-present))
93cee14b
RS
1321 (let ((print-level nil))
1322 (prin1-to-string elt))
1323 elt))
8dc3ba7d 1324 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
2076c87c 1325
ebb61177 1326(defun previous-history-element (n)
3ee3a076 1327 "Inserts the previous element of the minibuffer history into the minibuffer."
2076c87c 1328 (interactive "p")
2c5e21c1 1329 (next-history-element (- n)))
d0678801
RM
1330
1331(defun next-complete-history-element (n)
a4d1159b
GM
1332 "Get next history element which completes the minibuffer before the point.
1333The contents of the minibuffer after the point are deleted, and replaced
1334by the new completion."
d0678801 1335 (interactive "p")
b5e6f936
RM
1336 (let ((point-at-start (point)))
1337 (next-matching-history-element
a4d1159b 1338 (concat
efaac2e6 1339 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
a4d1159b 1340 n)
b5e6f936
RM
1341 ;; next-matching-history-element always puts us at (point-min).
1342 ;; Move to the position we were at before changing the buffer contents.
1343 ;; This is still sensical, because the text before point has not changed.
1344 (goto-char point-at-start)))
d0678801
RM
1345
1346(defun previous-complete-history-element (n)
1f6fcec3 1347 "\
a4d1159b
GM
1348Get previous history element which completes the minibuffer before the point.
1349The contents of the minibuffer after the point are deleted, and replaced
1350by the new completion."
d0678801
RM
1351 (interactive "p")
1352 (next-complete-history-element (- n)))
a4d1159b 1353
efaac2e6 1354;; For compatibility with the old subr of the same name.
a4d1159b
GM
1355(defun minibuffer-prompt-width ()
1356 "Return the display width of the minibuffer prompt.
f33321ad 1357Return 0 if current buffer is not a minibuffer."
a4d1159b
GM
1358 ;; Return the width of everything before the field at the end of
1359 ;; the buffer; this should be 0 for normal buffers.
efaac2e6 1360 (1- (minibuffer-prompt-end)))
2d88b556 1361\f
2076c87c 1362;Put this on C-x u, so we can force that rather than C-_ into startup msg
e462e42f 1363(defalias 'advertised-undo 'undo)
2076c87c 1364
1e96c007 1365(defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
713c9020
RS
1366 "Table mapping redo records to the corresponding undo one.
1367A redo record for undo-in-region maps to t.
1368A redo record for ordinary undo maps to the following (earlier) undo.")
1e96c007
SM
1369
1370(defvar undo-in-region nil
1371 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
1372
1373(defvar undo-no-redo nil
1374 "If t, `undo' doesn't go through redo entries.")
1375
a7fe694c
RS
1376(defvar pending-undo-list nil
1377 "Within a run of consecutive undo commands, list remaining to be undone.
8ac28be5 1378If t, we undid all the way to the end of it.")
a7fe694c 1379
2076c87c
JB
1380(defun undo (&optional arg)
1381 "Undo some previous changes.
1382Repeat this command to undo more changes.
65627aad
RS
1383A numeric argument serves as a repeat count.
1384
3c1b77ca 1385In Transient Mark mode when the mark is active, only undo changes within
1e96c007 1386the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
3c1b77ca 1387as an argument limits undo to changes within the current region."
65627aad 1388 (interactive "*P")
2e033693
RS
1389 ;; Make last-command indicate for the next command that this was an undo.
1390 ;; That way, another undo will undo more.
1391 ;; If we get to the end of the undo history and get an error,
1392 ;; another undo command will find the undo history empty
1393 ;; and will get another error. To begin undoing the undos,
1394 ;; you must type some other command.
b553cffa 1395 (let ((modified (buffer-modified-p))
cb3b2ec0
RS
1396 (recent-save (recent-auto-save-p))
1397 message)
2c6a2254
RS
1398 ;; If we get an error in undo-start,
1399 ;; the next command should not be a "consecutive undo".
1400 ;; So set `this-command' to something other than `undo'.
1401 (setq this-command 'undo-start)
1402
e967cd11 1403 (unless (and (eq last-command 'undo)
a7fe694c
RS
1404 (or (eq pending-undo-list t)
1405 ;; If something (a timer or filter?) changed the buffer
1406 ;; since the previous command, don't continue the undo seq.
1407 (let ((list buffer-undo-list))
1408 (while (eq (car list) nil)
1409 (setq list (cdr list)))
1410 ;; If the last undo record made was made by undo
1411 ;; it shows nothing else happened in between.
1412 (gethash list undo-equiv-table))))
1e96c007
SM
1413 (setq undo-in-region
1414 (if transient-mark-mode mark-active (and arg (not (numberp arg)))))
1415 (if undo-in-region
3c1b77ca
MB
1416 (undo-start (region-beginning) (region-end))
1417 (undo-start))
1418 ;; get rid of initial undo boundary
1419 (undo-more 1))
9a1120ea 1420 ;; If we got this far, the next command should be a consecutive undo.
2c6a2254 1421 (setq this-command 'undo)
1e96c007
SM
1422 ;; Check to see whether we're hitting a redo record, and if
1423 ;; so, ask the user whether she wants to skip the redo/undo pair.
1424 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
1425 (or (eq (selected-window) (minibuffer-window))
cb3b2ec0
RS
1426 (setq message (if undo-in-region
1427 (if equiv "Redo in region!" "Undo in region!")
1428 (if equiv "Redo!" "Undo!"))))
0047373b 1429 (when (and (consp equiv) undo-no-redo)
1e96c007
SM
1430 ;; The equiv entry might point to another redo record if we have done
1431 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1432 (while (let ((next (gethash equiv undo-equiv-table)))
1433 (if next (setq equiv next))))
1434 (setq pending-undo-list equiv)))
3c1b77ca
MB
1435 (undo-more
1436 (if (or transient-mark-mode (numberp arg))
1437 (prefix-numeric-value arg)
1438 1))
1e96c007 1439 ;; Record the fact that the just-generated undo records come from an
713c9020
RS
1440 ;; undo operation--that is, they are redo records.
1441 ;; In the ordinary case (not within a region), map the redo
1442 ;; record to the following undos.
1e96c007 1443 ;; I don't know how to do that in the undo-in-region case.
713c9020
RS
1444 (puthash buffer-undo-list
1445 (if undo-in-region t pending-undo-list)
1446 undo-equiv-table)
2512c9f0
RS
1447 ;; Don't specify a position in the undo record for the undo command.
1448 ;; Instead, undoing this should move point to where the change is.
1449 (let ((tail buffer-undo-list)
003550c5
GM
1450 (prev nil))
1451 (while (car tail)
1452 (when (integerp (car tail))
1453 (let ((pos (car tail)))
1e96c007
SM
1454 (if prev
1455 (setcdr prev (cdr tail))
1456 (setq buffer-undo-list (cdr tail)))
003550c5
GM
1457 (setq tail (cdr tail))
1458 (while (car tail)
1459 (if (eq pos (car tail))
1460 (if prev
1461 (setcdr prev (cdr tail))
1462 (setq buffer-undo-list (cdr tail)))
1463 (setq prev tail))
1464 (setq tail (cdr tail)))
1465 (setq tail nil)))
1466 (setq prev tail tail (cdr tail))))
e967cd11
RS
1467 ;; Record what the current undo list says,
1468 ;; so the next command can tell if the buffer was modified in between.
2076c87c 1469 (and modified (not (buffer-modified-p))
cb3b2ec0
RS
1470 (delete-auto-save-file-if-necessary recent-save))
1471 ;; Display a message announcing success.
1472 (if message
1473 (message message))))
2076c87c 1474
e967cd11
RS
1475(defun buffer-disable-undo (&optional buffer)
1476 "Make BUFFER stop keeping undo information.
1477No argument or nil as argument means do this for the current buffer."
1478 (interactive)
0d808a63 1479 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
d020fce0 1480 (setq buffer-undo-list t)))
e967cd11 1481
1e96c007
SM
1482(defun undo-only (&optional arg)
1483 "Undo some previous changes.
1484Repeat this command to undo more changes.
1485A numeric argument serves as a repeat count.
1486Contrary to `undo', this will not redo a previous undo."
1487 (interactive "*p")
1488 (let ((undo-no-redo t)) (undo arg)))
1e96c007 1489
52d1110d
RS
1490(defvar undo-in-progress nil
1491 "Non-nil while performing an undo.
1492Some change-hooks test this variable to do something different.")
1493
8ac28be5 1494(defun undo-more (n)
2076c87c 1495 "Undo back N undo-boundaries beyond what was already undone recently.
ff1fbe3e
RS
1496Call `undo-start' to get ready to undo recent changes,
1497then call `undo-more' one or more times to undo them."
a7fe694c 1498 (or (listp pending-undo-list)
8ac28be5
JB
1499 (error (concat "No further undo information"
1500 (and transient-mark-mode mark-active
1501 " for region"))))
52d1110d 1502 (let ((undo-in-progress t))
8ac28be5 1503 (setq pending-undo-list (primitive-undo n pending-undo-list))
a7fe694c
RS
1504 (if (null pending-undo-list)
1505 (setq pending-undo-list t))))
2076c87c 1506
65627aad
RS
1507;; Deep copy of a list
1508(defun undo-copy-list (list)
1509 "Make a copy of undo list LIST."
1510 (mapcar 'undo-copy-list-1 list))
1511
1512(defun undo-copy-list-1 (elt)
1513 (if (consp elt)
1514 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1515 elt))
1516
1517(defun undo-start (&optional beg end)
1518 "Set `pending-undo-list' to the front of the undo list.
1519The next call to `undo-more' will undo the most recently made change.
1520If BEG and END are specified, then only undo elements
1521that apply to text between BEG and END are used; other undo elements
1522are ignored. If BEG and END are nil, all undo elements are used."
1523 (if (eq buffer-undo-list t)
1524 (error "No undo information in this buffer"))
1e722f9f 1525 (setq pending-undo-list
65627aad
RS
1526 (if (and beg end (not (= beg end)))
1527 (undo-make-selective-list (min beg end) (max beg end))
1528 buffer-undo-list)))
1529
1530(defvar undo-adjusted-markers)
1531
1532(defun undo-make-selective-list (start end)
1533 "Return a list of undo elements for the region START to END.
1534The elements come from `buffer-undo-list', but we keep only
1535the elements inside this region, and discard those outside this region.
1536If we find an element that crosses an edge of this region,
1537we stop and ignore all further elements."
1538 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1539 (undo-list (list nil))
1540 undo-adjusted-markers
1541 some-rejected
1542 undo-elt undo-elt temp-undo-list delta)
1543 (while undo-list-copy
1544 (setq undo-elt (car undo-list-copy))
1545 (let ((keep-this
1546 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1547 ;; This is a "was unmodified" element.
1548 ;; Keep it if we have kept everything thus far.
1549 (not some-rejected))
1550 (t
1551 (undo-elt-in-region undo-elt start end)))))
1552 (if keep-this
1553 (progn
1554 (setq end (+ end (cdr (undo-delta undo-elt))))
1555 ;; Don't put two nils together in the list
1556 (if (not (and (eq (car undo-list) nil)
1557 (eq undo-elt nil)))
1558 (setq undo-list (cons undo-elt undo-list))))
1559 (if (undo-elt-crosses-region undo-elt start end)
1560 (setq undo-list-copy nil)
1561 (setq some-rejected t)
1562 (setq temp-undo-list (cdr undo-list-copy))
1563 (setq delta (undo-delta undo-elt))
1564
1565 (when (/= (cdr delta) 0)
1566 (let ((position (car delta))
1567 (offset (cdr delta)))
1568
e1e04350
SM
1569 ;; Loop down the earlier events adjusting their buffer
1570 ;; positions to reflect the fact that a change to the buffer
1571 ;; isn't being undone. We only need to process those element
1572 ;; types which undo-elt-in-region will return as being in
1573 ;; the region since only those types can ever get into the
1574 ;; output
65627aad
RS
1575
1576 (while temp-undo-list
1577 (setq undo-elt (car temp-undo-list))
1578 (cond ((integerp undo-elt)
1579 (if (>= undo-elt position)
1580 (setcar temp-undo-list (- undo-elt offset))))
1581 ((atom undo-elt) nil)
1582 ((stringp (car undo-elt))
1583 ;; (TEXT . POSITION)
1584 (let ((text-pos (abs (cdr undo-elt)))
1585 (point-at-end (< (cdr undo-elt) 0 )))
1586 (if (>= text-pos position)
1e722f9f 1587 (setcdr undo-elt (* (if point-at-end -1 1)
65627aad
RS
1588 (- text-pos offset))))))
1589 ((integerp (car undo-elt))
1590 ;; (BEGIN . END)
1591 (when (>= (car undo-elt) position)
1592 (setcar undo-elt (- (car undo-elt) offset))
1593 (setcdr undo-elt (- (cdr undo-elt) offset))))
1594 ((null (car undo-elt))
1595 ;; (nil PROPERTY VALUE BEG . END)
1596 (let ((tail (nthcdr 3 undo-elt)))
1597 (when (>= (car tail) position)
1598 (setcar tail (- (car tail) offset))
1599 (setcdr tail (- (cdr tail) offset))))))
1600 (setq temp-undo-list (cdr temp-undo-list))))))))
1601 (setq undo-list-copy (cdr undo-list-copy)))
1602 (nreverse undo-list)))
1603
1604(defun undo-elt-in-region (undo-elt start end)
1605 "Determine whether UNDO-ELT falls inside the region START ... END.
1606If it crosses the edge, we return nil."
1607 (cond ((integerp undo-elt)
1608 (and (>= undo-elt start)
12a93712 1609 (<= undo-elt end)))
65627aad
RS
1610 ((eq undo-elt nil)
1611 t)
1612 ((atom undo-elt)
1613 nil)
1614 ((stringp (car undo-elt))
1615 ;; (TEXT . POSITION)
1616 (and (>= (abs (cdr undo-elt)) start)
1617 (< (abs (cdr undo-elt)) end)))
1618 ((and (consp undo-elt) (markerp (car undo-elt)))
1619 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1620 ;; See if MARKER is inside the region.
1621 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1622 (unless alist-elt
1623 (setq alist-elt (cons (car undo-elt)
1624 (marker-position (car undo-elt))))
1625 (setq undo-adjusted-markers
1626 (cons alist-elt undo-adjusted-markers)))
1627 (and (cdr alist-elt)
1628 (>= (cdr alist-elt) start)
12a93712 1629 (<= (cdr alist-elt) end))))
65627aad
RS
1630 ((null (car undo-elt))
1631 ;; (nil PROPERTY VALUE BEG . END)
1632 (let ((tail (nthcdr 3 undo-elt)))
1633 (and (>= (car tail) start)
12a93712 1634 (<= (cdr tail) end))))
65627aad
RS
1635 ((integerp (car undo-elt))
1636 ;; (BEGIN . END)
1637 (and (>= (car undo-elt) start)
12a93712 1638 (<= (cdr undo-elt) end)))))
65627aad
RS
1639
1640(defun undo-elt-crosses-region (undo-elt start end)
1641 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1642This assumes we have already decided that UNDO-ELT
1643is not *inside* the region START...END."
1644 (cond ((atom undo-elt) nil)
1645 ((null (car undo-elt))
1646 ;; (nil PROPERTY VALUE BEG . END)
1647 (let ((tail (nthcdr 3 undo-elt)))
1648 (not (or (< (car tail) end)
1649 (> (cdr tail) start)))))
1650 ((integerp (car undo-elt))
1651 ;; (BEGIN . END)
1652 (not (or (< (car undo-elt) end)
1653 (> (cdr undo-elt) start))))))
1654
1655;; Return the first affected buffer position and the delta for an undo element
1656;; delta is defined as the change in subsequent buffer positions if we *did*
1657;; the undo.
1658(defun undo-delta (undo-elt)
1659 (if (consp undo-elt)
1660 (cond ((stringp (car undo-elt))
1661 ;; (TEXT . POSITION)
1662 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1663 ((integerp (car undo-elt))
1664 ;; (BEGIN . END)
1665 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1666 (t
1667 '(0 . 0)))
1668 '(0 . 0)))
b6e8e8e5 1669
28cb725d
LT
1670(defcustom undo-ask-before-discard t
1671 "If non-nil ask about discarding undo info for the current command.
1672Normally, Emacs discards the undo info for the current command if
1673it exceeds `undo-outer-limit'. But if you set this option
1674non-nil, it asks in the echo area whether to discard the info.
1675If you answer no, there a slight risk that Emacs might crash, so
1676only do it if you really want to undo the command.
1677
1678This option is mainly intended for debugging. You have to be
1679careful if you use it for other purposes. Garbage collection is
1680inhibited while the question is asked, meaning that Emacs might
1681leak memory. So you should make sure that you do not wait
1682excessively long before answering the question."
1683 :type 'boolean
1684 :group 'undo
bf247b6e 1685 :version "22.1")
28cb725d 1686
a1a801de
RS
1687(defvar undo-extra-outer-limit nil
1688 "If non-nil, an extra level of size that's ok in an undo item.
1689We don't ask the user about truncating the undo list until the
28cb725d
LT
1690current item gets bigger than this amount.
1691
1692This variable only matters if `undo-ask-before-discard' is non-nil.")
a1a801de
RS
1693(make-variable-buffer-local 'undo-extra-outer-limit)
1694
28cb725d
LT
1695;; When the first undo batch in an undo list is longer than
1696;; undo-outer-limit, this function gets called to warn the user that
1697;; the undo info for the current command was discarded. Garbage
1698;; collection is inhibited around the call, so it had better not do a
1699;; lot of consing.
b6e8e8e5
RS
1700(setq undo-outer-limit-function 'undo-outer-limit-truncate)
1701(defun undo-outer-limit-truncate (size)
28cb725d
LT
1702 (if undo-ask-before-discard
1703 (when (or (null undo-extra-outer-limit)
1704 (> size undo-extra-outer-limit))
1705 ;; Don't ask the question again unless it gets even bigger.
1706 ;; This applies, in particular, if the user quits from the question.
1707 ;; Such a quit quits out of GC, but something else will call GC
1708 ;; again momentarily. It will call this function again,
1709 ;; but we don't want to ask the question again.
1710 (setq undo-extra-outer-limit (+ size 50000))
1711 (if (let (use-dialog-box track-mouse executing-kbd-macro )
1712 (yes-or-no-p (format "Buffer %s undo info is %d bytes long; discard it? "
1713 (buffer-name) size)))
1714 (progn (setq buffer-undo-list nil)
1715 (setq undo-extra-outer-limit nil)
1716 t)
1717 nil))
1718 (display-warning '(undo discard-info)
1719 (concat
1720 (format "Buffer %s undo info was %d bytes long.\n"
1721 (buffer-name) size)
1722 "The undo info was discarded because it exceeded \
1723`undo-outer-limit'.
1724
1725This is normal if you executed a command that made a huge change
1726to the buffer. In that case, to prevent similar problems in the
1727future, set `undo-outer-limit' to a value that is large enough to
1728cover the maximum size of normal changes you expect a single
1729command to make, but not so large that it might exceed the
1730maximum memory allotted to Emacs.
1731
1732If you did not execute any such command, the situation is
1733probably due to a bug and you should report it.
1734
1735You can disable the popping up of this buffer by adding the entry
1736\(undo discard-info) to the user option `warning-suppress-types'.\n")
1737 :warning)
1738 (setq buffer-undo-list nil)
1739 t))
e1e04350 1740\f
009ef402
RS
1741(defvar shell-command-history nil
1742 "History list for some commands that read shell commands.")
1743
59fc41e5
RS
1744(defvar shell-command-switch "-c"
1745 "Switch used to have the shell execute its command line argument.")
1746
cc039f78
KH
1747(defvar shell-command-default-error-buffer nil
1748 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
637fff82 1749This buffer is used when `shell-command' or `shell-command-on-region'
cc039f78
KH
1750is run interactively. A value of nil means that output to stderr and
1751stdout will be intermixed in the output stream.")
1752
1753(defun shell-command (command &optional output-buffer error-buffer)
2076c87c 1754 "Execute string COMMAND in inferior shell; display output, if any.
0b3f96d4 1755With prefix argument, insert the COMMAND's output at point.
d382f610 1756
2076c87c 1757If COMMAND ends in ampersand, execute it asynchronously.
d382f610 1758The output appears in the buffer `*Async Shell Command*'.
bcad4985 1759That buffer is in shell mode.
d382f610 1760
939ac10c
GM
1761Otherwise, COMMAND is executed synchronously. The output appears in
1762the buffer `*Shell Command Output*'. If the output is short enough to
1763display in the echo area (which is determined by the variables
1764`resize-mini-windows' and `max-mini-window-height'), it is shown
1765there, but it is nonetheless available in buffer `*Shell Command
e1e04350 1766Output*' even though that buffer is not automatically displayed.
d0d74413 1767
07f458c1
RS
1768To specify a coding system for converting non-ASCII characters
1769in the shell command output, use \\[universal-coding-system-argument]
1770before this command.
1771
1772Noninteractive callers can specify coding systems by binding
1773`coding-system-for-read' and `coding-system-for-write'.
1774
d0d74413
RS
1775The optional second argument OUTPUT-BUFFER, if non-nil,
1776says to put the output in some other buffer.
1777If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1778If OUTPUT-BUFFER is not a buffer and not nil,
1779insert output in current buffer. (This cannot be done asynchronously.)
cc039f78
KH
1780In either case, the output is inserted after point (leaving mark after it).
1781
2e033693
RS
1782If the command terminates without error, but generates output,
1783and you did not specify \"insert it in the current buffer\",
1784the output can be displayed in the echo area or in its buffer.
1785If the output is short enough to display in the echo area
1786\(determined by the variable `max-mini-window-height' if
1787`resize-mini-windows' is non-nil), it is shown there. Otherwise,
1788the buffer containing the output is displayed.
1789
1790If there is output and an error, and you did not specify \"insert it
1791in the current buffer\", a message about the error goes at the end
1792of the output.
1793
1794If there is no output, or if output is inserted in the current buffer,
1795then `*Shell Command Output*' is deleted.
1796
cc039f78
KH
1797If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1798or buffer name to which to direct the command's standard error output.
1799If it is nil, error output is mingled with regular output.
1800In an interactive call, the variable `shell-command-default-error-buffer'
1801specifies the value of ERROR-BUFFER."
1802
aa00b92d
RS
1803 (interactive (list (read-from-minibuffer "Shell command: "
1804 nil nil nil 'shell-command-history)
cc039f78
KH
1805 current-prefix-arg
1806 shell-command-default-error-buffer))
c7edd03c
KH
1807 ;; Look for a handler in case default-directory is a remote file name.
1808 (let ((handler
1809 (find-file-name-handler (directory-file-name default-directory)
1810 'shell-command)))
1811 (if handler
cc039f78 1812 (funcall handler 'shell-command command output-buffer error-buffer)
c7edd03c
KH
1813 (if (and output-buffer
1814 (not (or (bufferp output-buffer) (stringp output-buffer))))
2e033693 1815 ;; Output goes in current buffer.
cc039f78 1816 (let ((error-file
1e722f9f 1817 (if error-buffer
b005abd5 1818 (make-temp-file
171a45d9
EZ
1819 (expand-file-name "scor"
1820 (or small-temporary-file-directory
1821 temporary-file-directory)))
cc039f78
KH
1822 nil)))
1823 (barf-if-buffer-read-only)
63437623 1824 (push-mark nil t)
cc039f78
KH
1825 ;; We do not use -f for csh; we will not support broken use of
1826 ;; .cshrcs. Even the BSD csh manual says to use
1827 ;; "if ($?prompt) exit" before things which are not useful
1828 ;; non-interactively. Besides, if someone wants their other
1829 ;; aliases for shell commands then they can still have them.
1e722f9f 1830 (call-process shell-file-name nil
cc039f78
KH
1831 (if error-file
1832 (list t error-file)
1833 t)
1834 nil shell-command-switch command)
1835 (when (and error-file (file-exists-p error-file))
1836 (if (< 0 (nth 7 (file-attributes error-file)))
1837 (with-current-buffer (get-buffer-create error-buffer)
1838 (let ((pos-from-end (- (point-max) (point))))
1839 (or (bobp)
1840 (insert "\f\n"))
1841 ;; Do no formatting while reading error file,
1842 ;; because that can run a shell command, and we
1843 ;; don't want that to cause an infinite recursion.
1844 (format-insert-file error-file nil)
1845 ;; Put point after the inserted errors.
1846 (goto-char (- (point-max) pos-from-end)))
1847 (display-buffer (current-buffer))))
1848 (delete-file error-file))
1849 ;; This is like exchange-point-and-mark, but doesn't
1850 ;; activate the mark. It is cleaner to avoid activation,
1851 ;; even though the command loop would deactivate the mark
1852 ;; because we inserted text.
1853 (goto-char (prog1 (mark t)
1854 (set-marker (mark-marker) (point)
1855 (current-buffer)))))
2e033693 1856 ;; Output goes in a separate buffer.
c7edd03c
KH
1857 ;; Preserve the match data in case called from a program.
1858 (save-match-data
aab5d2c5 1859 (if (string-match "[ \t]*&[ \t]*\\'" command)
c7edd03c
KH
1860 ;; Command ending with ampersand means asynchronous.
1861 (let ((buffer (get-buffer-create
1862 (or output-buffer "*Async Shell Command*")))
1863 (directory default-directory)
1864 proc)
1865 ;; Remove the ampersand.
1866 (setq command (substring command 0 (match-beginning 0)))
1867 ;; If will kill a process, query first.
1868 (setq proc (get-buffer-process buffer))
1869 (if proc
1870 (if (yes-or-no-p "A command is running. Kill it? ")
1871 (kill-process proc)
1872 (error "Shell command in progress")))
1e96c007 1873 (with-current-buffer buffer
c7edd03c
KH
1874 (setq buffer-read-only nil)
1875 (erase-buffer)
1876 (display-buffer buffer)
1877 (setq default-directory directory)
1e722f9f 1878 (setq proc (start-process "Shell" buffer shell-file-name
c7edd03c
KH
1879 shell-command-switch command))
1880 (setq mode-line-process '(":%s"))
c2020c27 1881 (require 'shell) (shell-mode)
c7edd03c
KH
1882 (set-process-sentinel proc 'shell-command-sentinel)
1883 ))
cc039f78
KH
1884 (shell-command-on-region (point) (point) command
1885 output-buffer nil error-buffer)))))))
eaae8106 1886
f69aad2b
MB
1887(defun display-message-or-buffer (message
1888 &optional buffer-name not-this-window frame)
1889 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1890MESSAGE may be either a string or a buffer.
1891
1892A buffer is displayed using `display-buffer' if MESSAGE is too long for
939ac10c
GM
1893the maximum height of the echo area, as defined by `max-mini-window-height'
1894if `resize-mini-windows' is non-nil.
f69aad2b 1895
2a3f00bf
MB
1896Returns either the string shown in the echo area, or when a pop-up
1897buffer is used, the window used to display it.
1898
f69aad2b
MB
1899If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1900name of the buffer used to display it in the case where a pop-up buffer
1901is used, defaulting to `*Message*'. In the case where MESSAGE is a
1902string and it is displayed in the echo area, it is not specified whether
1903the contents are inserted into the buffer anyway.
1904
1905Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1906and only used if a buffer is displayed."
aca2d9bb
EZ
1907 (cond ((and (stringp message)
1908 (not (string-match "\n" message))
1909 (<= (length message) (frame-width)))
f69aad2b
MB
1910 ;; Trivial case where we can use the echo area
1911 (message "%s" message))
1912 ((and (stringp message)
aca2d9bb
EZ
1913 (= (string-match "\n" message) (1- (length message)))
1914 (<= (1- (length message)) (frame-width)))
f69aad2b
MB
1915 ;; Trivial case where we can just remove single trailing newline
1916 (message "%s" (substring message 0 (1- (length message)))))
1917 (t
1918 ;; General case
1919 (with-current-buffer
1920 (if (bufferp message)
1921 message
1922 (get-buffer-create (or buffer-name "*Message*")))
1923
1924 (unless (bufferp message)
1925 (erase-buffer)
1926 (insert message))
1927
1928 (let ((lines
1929 (if (= (buffer-size) 0)
1930 0
62ffcd76 1931 (count-screen-lines nil nil nil (minibuffer-window)))))
4f017185
RS
1932 (cond ((= lines 0))
1933 ((and (or (<= lines 1)
aab5d2c5
RS
1934 (<= lines
1935 (if resize-mini-windows
1936 (cond ((floatp max-mini-window-height)
1937 (* (frame-height)
1938 max-mini-window-height))
1939 ((integerp max-mini-window-height)
1940 max-mini-window-height)
1941 (t
1942 1))
1943 1)))
1944 ;; Don't use the echo area if the output buffer is
1945 ;; already dispayed in the selected frame.
61b80ebf 1946 (not (get-buffer-window (current-buffer))))
f69aad2b
MB
1947 ;; Echo area
1948 (goto-char (point-max))
1949 (when (bolp)
1950 (backward-char 1))
1951 (message "%s" (buffer-substring (point-min) (point))))
1952 (t
1953 ;; Buffer
1954 (goto-char (point-min))
31252c00
MB
1955 (display-buffer (current-buffer)
1956 not-this-window frame))))))))
f69aad2b
MB
1957
1958
2076c87c
JB
1959;; We have a sentinel to prevent insertion of a termination message
1960;; in the buffer itself.
1961(defun shell-command-sentinel (process signal)
bcad4985 1962 (if (memq (process-status process) '(exit signal))
1e722f9f 1963 (message "%s: %s."
bcad4985
KH
1964 (car (cdr (cdr (process-command process))))
1965 (substring signal 0 -1))))
2076c87c 1966
d0d74413 1967(defun shell-command-on-region (start end command
cce1c318 1968 &optional output-buffer replace
63619f42 1969 error-buffer display-error-buffer)
2076c87c
JB
1970 "Execute string COMMAND in inferior shell with region as input.
1971Normally display output (if any) in temp buffer `*Shell Command Output*';
a0184aeb
DL
1972Prefix arg means replace the region with it. Return the exit code of
1973COMMAND.
56c0450e 1974
07f458c1
RS
1975To specify a coding system for converting non-ASCII characters
1976in the input and output to the shell command, use \\[universal-coding-system-argument]
1977before this command. By default, the input (from the current buffer)
1978is encoded in the same coding system that will be used to save the file,
1979`buffer-file-coding-system'. If the output is going to replace the region,
1980then it is decoded from that same coding system.
1981
63619f42
RS
1982The noninteractive arguments are START, END, COMMAND,
1983OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1984Noninteractive callers can specify coding systems by binding
1985`coding-system-for-read' and `coding-system-for-write'.
2076c87c 1986
2e033693
RS
1987If the command generates output, the output may be displayed
1988in the echo area or in a buffer.
1989If the output is short enough to display in the echo area
1990\(determined by the variable `max-mini-window-height' if
1991`resize-mini-windows' is non-nil), it is shown there. Otherwise
1992it is displayed in the buffer `*Shell Command Output*'. The output
1993is available in that buffer in both cases.
1994
1995If there is output and an error, a message about the error
1996appears at the end of the output.
1997
1998If there is no output, or if output is inserted in the current buffer,
1999then `*Shell Command Output*' is deleted.
d0d74413 2000
56c0450e
RS
2001If the optional fourth argument OUTPUT-BUFFER is non-nil,
2002that says to put the output in some other buffer.
d0d74413
RS
2003If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2004If OUTPUT-BUFFER is not a buffer and not nil,
2005insert output in the current buffer.
cce1c318
RS
2006In either case, the output is inserted after point (leaving mark after it).
2007
8923a211
RS
2008If REPLACE, the optional fifth argument, is non-nil, that means insert
2009the output in place of text from START to END, putting point and mark
2010around it.
2011
b735c991 2012If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
cce1c318 2013or buffer name to which to direct the command's standard error output.
7fd47839 2014If it is nil, error output is mingled with regular output.
63619f42
RS
2015If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2016were any errors. (This is always t, interactively.)
cc039f78
KH
2017In an interactive call, the variable `shell-command-default-error-buffer'
2018specifies the value of ERROR-BUFFER."
195ce311
RS
2019 (interactive (let (string)
2020 (unless (mark)
2021 (error "The mark is not set now, so there is no region"))
2022 ;; Do this before calling region-beginning
2023 ;; and region-end, in case subprocess output
2024 ;; relocates them while we are in the minibuffer.
2025 (setq string (read-from-minibuffer "Shell command on region: "
2026 nil nil nil
2027 'shell-command-history))
2b03c506
RS
2028 ;; call-interactively recognizes region-beginning and
2029 ;; region-end specially, leaving them in the history.
2030 (list (region-beginning) (region-end)
cae49185
RS
2031 string
2032 current-prefix-arg
7fd47839 2033 current-prefix-arg
63619f42
RS
2034 shell-command-default-error-buffer
2035 t)))
cce1c318 2036 (let ((error-file
171a45d9 2037 (if error-buffer
b005abd5 2038 (make-temp-file
171a45d9
EZ
2039 (expand-file-name "scor"
2040 (or small-temporary-file-directory
2041 temporary-file-directory)))
a0184aeb
DL
2042 nil))
2043 exit-status)
7fd47839
RS
2044 (if (or replace
2045 (and output-buffer
748d6ca4 2046 (not (or (bufferp output-buffer) (stringp output-buffer)))))
7fd47839
RS
2047 ;; Replace specified region with output from command.
2048 (let ((swap (and replace (< start end))))
2049 ;; Don't muck with mark unless REPLACE says we should.
2050 (goto-char start)
30883773 2051 (and replace (push-mark (point) 'nomsg))
a0184aeb
DL
2052 (setq exit-status
2053 (call-process-region start end shell-file-name t
2054 (if error-file
2055 (list t error-file)
2056 t)
2057 nil shell-command-switch command))
e1e04350
SM
2058 ;; It is rude to delete a buffer which the command is not using.
2059 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2060 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2061 ;; (kill-buffer shell-buffer)))
7fd47839
RS
2062 ;; Don't muck with mark unless REPLACE says we should.
2063 (and replace swap (exchange-point-and-mark)))
2064 ;; No prefix argument: put the output in a temp buffer,
2065 ;; replacing its entire contents.
2066 (let ((buffer (get-buffer-create
d4bbcbb4 2067 (or output-buffer "*Shell Command Output*"))))
7fd47839
RS
2068 (unwind-protect
2069 (if (eq buffer (current-buffer))
2070 ;; If the input is the same buffer as the output,
2071 ;; delete everything but the specified region,
2072 ;; then replace that region with the output.
2073 (progn (setq buffer-read-only nil)
2074 (delete-region (max start end) (point-max))
2075 (delete-region (point-min) (min start end))
2076 (setq exit-status
2077 (call-process-region (point-min) (point-max)
1e722f9f 2078 shell-file-name t
7fd47839
RS
2079 (if error-file
2080 (list t error-file)
2081 t)
a0184aeb
DL
2082 nil shell-command-switch
2083 command)))
2084 ;; Clear the output buffer, then run the command with
2085 ;; output there.
c2e303c8
GM
2086 (let ((directory default-directory))
2087 (save-excursion
2088 (set-buffer buffer)
2089 (setq buffer-read-only nil)
2090 (if (not output-buffer)
2091 (setq default-directory directory))
2092 (erase-buffer)))
7fd47839
RS
2093 (setq exit-status
2094 (call-process-region start end shell-file-name nil
2095 (if error-file
2096 (list buffer error-file)
2097 buffer)
a0184aeb 2098 nil shell-command-switch command)))
2e033693 2099 ;; Report the output.
9a98fa64 2100 (with-current-buffer buffer
f1180544 2101 (setq mode-line-process
d4bbcbb4
AS
2102 (cond ((null exit-status)
2103 " - Error")
2104 ((stringp exit-status)
2105 (format " - Signal [%s]" exit-status))
2106 ((not (equal 0 exit-status))
2107 (format " - Exit [%d]" exit-status)))))
f69aad2b
MB
2108 (if (with-current-buffer buffer (> (point-max) (point-min)))
2109 ;; There's some output, display it
9a98fa64 2110 (display-message-or-buffer buffer)
f69aad2b 2111 ;; No output; error?
94ddbe6d
RS
2112 (let ((output
2113 (if (and error-file
2114 (< 0 (nth 7 (file-attributes error-file))))
2115 "some error output"
2116 "no output")))
d4bbcbb4
AS
2117 (cond ((null exit-status)
2118 (message "(Shell command failed with error)"))
2119 ((equal 0 exit-status)
2120 (message "(Shell command succeeded with %s)"
2121 output))
2122 ((stringp exit-status)
2123 (message "(Shell command killed by signal %s)"
2124 exit-status))
2125 (t
2126 (message "(Shell command failed with code %d and %s)"
2127 exit-status output))))
e1e04350
SM
2128 ;; Don't kill: there might be useful info in the undo-log.
2129 ;; (kill-buffer buffer)
2130 ))))
f69aad2b 2131
cc039f78
KH
2132 (when (and error-file (file-exists-p error-file))
2133 (if (< 0 (nth 7 (file-attributes error-file)))
2134 (with-current-buffer (get-buffer-create error-buffer)
2135 (let ((pos-from-end (- (point-max) (point))))
2136 (or (bobp)
2137 (insert "\f\n"))
2138 ;; Do no formatting while reading error file,
2139 ;; because that can run a shell command, and we
2140 ;; don't want that to cause an infinite recursion.
2141 (format-insert-file error-file nil)
2142 ;; Put point after the inserted errors.
2143 (goto-char (- (point-max) pos-from-end)))
63619f42
RS
2144 (and display-error-buffer
2145 (display-buffer (current-buffer)))))
cc039f78 2146 (delete-file error-file))
a0184aeb 2147 exit-status))
1e722f9f 2148
d589bd99
RS
2149(defun shell-command-to-string (command)
2150 "Execute shell command COMMAND and return its output as a string."
2151 (with-output-to-string
17cc9013
RS
2152 (with-current-buffer
2153 standard-output
2154 (call-process shell-file-name nil t nil shell-command-switch command))))
0457dd55
KG
2155
2156(defun process-file (program &optional infile buffer display &rest args)
2157 "Process files synchronously in a separate process.
2158Similar to `call-process', but may invoke a file handler based on
2159`default-directory'. The current working directory of the
2160subprocess is `default-directory'.
2161
2162File names in INFILE and BUFFER are handled normally, but file
2163names in ARGS should be relative to `default-directory', as they
2164are passed to the process verbatim. \(This is a difference to
2165`call-process' which does not support file handlers for INFILE
2166and BUFFER.\)
2167
2168Some file handlers might not support all variants, for example
2169they might behave as if DISPLAY was nil, regardless of the actual
2170value passed."
2171 (let ((fh (find-file-name-handler default-directory 'process-file))
2172 lc stderr-file)
2173 (unwind-protect
2174 (if fh (apply fh 'process-file program infile buffer display args)
8de40f9f 2175 (when infile (setq lc (file-local-copy infile)))
0457dd55 2176 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
85af630d
KG
2177 (make-temp-file "emacs")))
2178 (prog1
2179 (apply 'call-process program
2180 (or lc infile)
2181 (if stderr-file (list (car buffer) stderr-file) buffer)
2182 display args)
2183 (when stderr-file (copy-file stderr-file (cadr buffer)))))
0457dd55
KG
2184 (when stderr-file (delete-file stderr-file))
2185 (when lc (delete-file lc)))))
2186
2187
2d88b556 2188\f
1b43f83f 2189(defvar universal-argument-map
69d4c3c4
KH
2190 (let ((map (make-sparse-keymap)))
2191 (define-key map [t] 'universal-argument-other-key)
b9ff190d 2192 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
69d4c3c4
KH
2193 (define-key map [switch-frame] nil)
2194 (define-key map [?\C-u] 'universal-argument-more)
2195 (define-key map [?-] 'universal-argument-minus)
2196 (define-key map [?0] 'digit-argument)
2197 (define-key map [?1] 'digit-argument)
2198 (define-key map [?2] 'digit-argument)
2199 (define-key map [?3] 'digit-argument)
2200 (define-key map [?4] 'digit-argument)
2201 (define-key map [?5] 'digit-argument)
2202 (define-key map [?6] 'digit-argument)
2203 (define-key map [?7] 'digit-argument)
2204 (define-key map [?8] 'digit-argument)
2205 (define-key map [?9] 'digit-argument)
bd7acc8d
GM
2206 (define-key map [kp-0] 'digit-argument)
2207 (define-key map [kp-1] 'digit-argument)
2208 (define-key map [kp-2] 'digit-argument)
2209 (define-key map [kp-3] 'digit-argument)
2210 (define-key map [kp-4] 'digit-argument)
2211 (define-key map [kp-5] 'digit-argument)
2212 (define-key map [kp-6] 'digit-argument)
2213 (define-key map [kp-7] 'digit-argument)
2214 (define-key map [kp-8] 'digit-argument)
2215 (define-key map [kp-9] 'digit-argument)
2216 (define-key map [kp-subtract] 'universal-argument-minus)
69d4c3c4
KH
2217 map)
2218 "Keymap used while processing \\[universal-argument].")
2219
0de84e16
RS
2220(defvar universal-argument-num-events nil
2221 "Number of argument-specifying events read by `universal-argument'.
2222`universal-argument-other-key' uses this to discard those events
2223from (this-command-keys), and reread only the final command.")
2224
6904b34b
EZ
2225(defvar overriding-map-is-bound nil
2226 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2227
2228(defvar saved-overriding-map nil
2229 "The saved value of `overriding-terminal-local-map'.
2230That variable gets restored to this value on exiting \"universal
2231argument mode\".")
2232
2233(defun ensure-overriding-map-is-bound ()
2234 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2235 (unless overriding-map-is-bound
2236 (setq saved-overriding-map overriding-terminal-local-map)
2237 (setq overriding-terminal-local-map universal-argument-map)
2238 (setq overriding-map-is-bound t)))
2239
2240(defun restore-overriding-map ()
2241 "Restore `overriding-terminal-local-map' to its saved value."
2242 (setq overriding-terminal-local-map saved-overriding-map)
2243 (setq overriding-map-is-bound nil))
2244
e8d1a377
KH
2245(defun universal-argument ()
2246 "Begin a numeric argument for the following command.
2247Digits or minus sign following \\[universal-argument] make up the numeric argument.
2248\\[universal-argument] following the digits or minus sign ends the argument.
2249\\[universal-argument] without digits or minus sign provides 4 as argument.
2250Repeating \\[universal-argument] without digits or minus sign
0565d307
RS
2251 multiplies the argument by 4 each time.
2252For some commands, just \\[universal-argument] by itself serves as a flag
a697fc62
RS
2253which is different in effect from any particular numeric argument.
2254These commands include \\[set-mark-command] and \\[start-kbd-macro]."
69d4c3c4
KH
2255 (interactive)
2256 (setq prefix-arg (list 4))
0de84e16 2257 (setq universal-argument-num-events (length (this-command-keys)))
6904b34b 2258 (ensure-overriding-map-is-bound))
e8d1a377 2259
69d4c3c4
KH
2260;; A subsequent C-u means to multiply the factor by 4 if we've typed
2261;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2262(defun universal-argument-more (arg)
e8d1a377 2263 (interactive "P")
69d4c3c4
KH
2264 (if (consp arg)
2265 (setq prefix-arg (list (* 4 (car arg))))
1cd24721
RS
2266 (if (eq arg '-)
2267 (setq prefix-arg (list -4))
2268 (setq prefix-arg arg)
6904b34b 2269 (restore-overriding-map)))
0de84e16 2270 (setq universal-argument-num-events (length (this-command-keys))))
e8d1a377
KH
2271
2272(defun negative-argument (arg)
2273 "Begin a negative numeric argument for the next command.
2274\\[universal-argument] following digits or minus sign ends the argument."
2275 (interactive "P")
69d4c3c4
KH
2276 (cond ((integerp arg)
2277 (setq prefix-arg (- arg)))
2278 ((eq arg '-)
2279 (setq prefix-arg nil))
2280 (t
b9ff190d 2281 (setq prefix-arg '-)))
0de84e16 2282 (setq universal-argument-num-events (length (this-command-keys)))
6904b34b 2283 (ensure-overriding-map-is-bound))
69d4c3c4
KH
2284
2285(defun digit-argument (arg)
2286 "Part of the numeric argument for the next command.
2287\\[universal-argument] following digits or minus sign ends the argument."
2288 (interactive "P")
bd7acc8d
GM
2289 (let* ((char (if (integerp last-command-char)
2290 last-command-char
2291 (get last-command-char 'ascii-character)))
2292 (digit (- (logand char ?\177) ?0)))
69d4c3c4
KH
2293 (cond ((integerp arg)
2294 (setq prefix-arg (+ (* arg 10)
2295 (if (< arg 0) (- digit) digit))))
2296 ((eq arg '-)
2297 ;; Treat -0 as just -, so that -01 will work.
2298 (setq prefix-arg (if (zerop digit) '- (- digit))))
2299 (t
b9ff190d 2300 (setq prefix-arg digit))))
0de84e16 2301 (setq universal-argument-num-events (length (this-command-keys)))
6904b34b 2302 (ensure-overriding-map-is-bound))
69d4c3c4
KH
2303
2304;; For backward compatibility, minus with no modifiers is an ordinary
2305;; command if digits have already been entered.
2306(defun universal-argument-minus (arg)
2307 (interactive "P")
2308 (if (integerp arg)
2309 (universal-argument-other-key arg)
2310 (negative-argument arg)))
2311
2312;; Anything else terminates the argument and is left in the queue to be
2313;; executed as a command.
2314(defun universal-argument-other-key (arg)
2315 (interactive "P")
2316 (setq prefix-arg arg)
0de84e16
RS
2317 (let* ((key (this-command-keys))
2318 (keylist (listify-key-sequence key)))
2319 (setq unread-command-events
06697cdb
RS
2320 (append (nthcdr universal-argument-num-events keylist)
2321 unread-command-events)))
f0ef2555 2322 (reset-this-command-lengths)
6904b34b 2323 (restore-overriding-map))
2d88b556 2324\f
7fcce20f
RS
2325(defvar buffer-substring-filters nil
2326 "List of filter functions for `filter-buffer-substring'.
2327Each function must accept a single argument, a string, and return
2328a string. The buffer substring is passed to the first function
2329in the list, and the return value of each function is passed to
2330the next. The return value of the last function is used as the
2331return value of `filter-buffer-substring'.
2332
2333If this variable is nil, no filtering is performed.")
2334
2335(defun filter-buffer-substring (beg end &optional delete)
2336 "Return the buffer substring between BEG and END, after filtering.
2337The buffer substring is passed through each of the filter
2338functions in `buffer-substring-filters', and the value from the
2339last filter function is returned. If `buffer-substring-filters'
2340is nil, the buffer substring is returned unaltered.
2341
2342If DELETE is non-nil, the text between BEG and END is deleted
2343from the buffer.
2344
2cd16d74 2345Point is temporarily set to BEG before calling
7fcce20f
RS
2346`buffer-substring-filters', in case the functions need to know
2347where the text came from.
2348
2349This function should be used instead of `buffer-substring' or
2350`delete-and-extract-region' when you want to allow filtering to
2351take place. For example, major or minor modes can use
2352`buffer-substring-filters' to extract characters that are special
2353to a buffer, and should not be copied into other buffers."
2354 (save-excursion
2355 (goto-char beg)
2356 (let ((string (if delete (delete-and-extract-region beg end)
2357 (buffer-substring beg end))))
2358 (dolist (filter buffer-substring-filters string)
2359 (setq string (funcall filter string))))))
2360
93be67de 2361;;;; Window system cut and paste hooks.
70e14c01
JB
2362
2363(defvar interprogram-cut-function nil
2364 "Function to call to make a killed region available to other programs.
2365
2366Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2367pasting text between the windows of different programs.
2368This variable holds a function that Emacs calls whenever text
2369is put in the kill ring, to make the new kill available to other
70e14c01
JB
2370programs.
2371
9f112a3d
RS
2372The function takes one or two arguments.
2373The first argument, TEXT, is a string containing
2374the text which should be made available.
8e5d85ff
LT
2375The second, optional, argument PUSH, has the same meaning as the
2376similar argument to `x-set-cut-buffer', which see.")
70e14c01
JB
2377
2378(defvar interprogram-paste-function nil
2379 "Function to call to get text cut from other programs.
2380
2381Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2382pasting text between the windows of different programs.
2383This variable holds a function that Emacs calls to obtain
70e14c01
JB
2384text that other programs have provided for pasting.
2385
2386The function should be called with no arguments. If the function
2387returns nil, then no other program has provided such text, and the top
2388of the Emacs kill ring should be used. If the function returns a
8e5d85ff
LT
2389string, then the caller of the function \(usually `current-kill')
2390should put this string in the kill ring as the latest kill.
daa37602
JB
2391
2392Note that the function should return a string only if a program other
2393than Emacs has provided a string for pasting; if Emacs provided the
2394most recent string, the function should return nil. If it is
2395difficult to tell whether Emacs or some other program provided the
2396current string, it is probably good enough to return nil if the string
2397is equal (according to `string=') to the last text Emacs provided.")
2d88b556 2398\f
70e14c01 2399
eaae8106 2400
70e14c01 2401;;;; The kill ring data structure.
2076c87c
JB
2402
2403(defvar kill-ring nil
70e14c01
JB
2404 "List of killed text sequences.
2405Since the kill ring is supposed to interact nicely with cut-and-paste
2406facilities offered by window systems, use of this variable should
2407interact nicely with `interprogram-cut-function' and
2408`interprogram-paste-function'. The functions `kill-new',
2409`kill-append', and `current-kill' are supposed to implement this
2410interaction; you may want to use them instead of manipulating the kill
2411ring directly.")
2076c87c 2412
bffa4d92 2413(defcustom kill-ring-max 60
69c1dd37
RS
2414 "*Maximum length of kill ring before oldest elements are thrown away."
2415 :type 'integer
2416 :group 'killing)
2076c87c
JB
2417
2418(defvar kill-ring-yank-pointer nil
2419 "The tail of the kill ring whose car is the last thing yanked.")
2420
be5936a7 2421(defun kill-new (string &optional replace yank-handler)
70e14c01 2422 "Make STRING the latest kill in the kill ring.
3e505153 2423Set `kill-ring-yank-pointer' to point to it.
f914dc91
KH
2424If `interprogram-cut-function' is non-nil, apply it to STRING.
2425Optional second argument REPLACE non-nil means that STRING will replace
be5936a7
KS
2426the front of the kill ring, rather than being added to the list.
2427
2428Optional third arguments YANK-HANDLER controls how the STRING is later
f1180544 2429inserted into a buffer; see `insert-for-yank' for details.
2a262563 2430When a yank handler is specified, STRING must be non-empty (the yank
8e5d85ff 2431handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2a262563
KS
2432
2433When the yank handler has a non-nil PARAM element, the original STRING
2434argument is not used by `insert-for-yank'. However, since Lisp code
f33321ad 2435may access and use elements from the kill ring directly, the STRING
2a262563
KS
2436argument should still be a \"useful\" string for such uses."
2437 (if (> (length string) 0)
f1180544 2438 (if yank-handler
7e46b7bf
LT
2439 (put-text-property 0 (length string)
2440 'yank-handler yank-handler string))
2a262563 2441 (if yank-handler
f1180544 2442 (signal 'args-out-of-range
2a262563
KS
2443 (list string "yank-handler specified for empty string"))))
2444 (if (fboundp 'menu-bar-update-yank-menu)
2445 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
ab7e20d5 2446 (if (and replace kill-ring)
f914dc91 2447 (setcar kill-ring string)
1b5fd09e 2448 (push string kill-ring)
f914dc91
KH
2449 (if (> (length kill-ring) kill-ring-max)
2450 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
70e14c01
JB
2451 (setq kill-ring-yank-pointer kill-ring)
2452 (if interprogram-cut-function
657a33ab 2453 (funcall interprogram-cut-function string (not replace))))
70e14c01 2454
be5936a7 2455(defun kill-append (string before-p &optional yank-handler)
70e14c01
JB
2456 "Append STRING to the end of the latest kill in the kill ring.
2457If BEFORE-P is non-nil, prepend STRING to the kill.
8e5d85ff
LT
2458Optional third argument YANK-HANDLER, if non-nil, specifies the
2459yank-handler text property to be set on the combined kill ring
2460string. If the specified yank-handler arg differs from the
2461yank-handler property of the latest kill string, this function
2462adds the combined string to the kill ring as a new element,
2463instead of replacing the last kill with it.
be5936a7
KS
2464If `interprogram-cut-function' is set, pass the resulting kill to it."
2465 (let* ((cur (car kill-ring)))
2466 (kill-new (if before-p (concat string cur) (concat cur string))
2467 (or (= (length cur) 0)
2468 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2469 yank-handler)))
70e14c01
JB
2470
2471(defun current-kill (n &optional do-not-move)
2472 "Rotate the yanking point by N places, and then return that kill.
2473If N is zero, `interprogram-paste-function' is set, and calling it
2474returns a string, then that string is added to the front of the
2475kill ring and returned as the latest kill.
1e722f9f 2476If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
70e14c01
JB
2477yanking point; just return the Nth kill forward."
2478 (let ((interprogram-paste (and (= n 0)
2479 interprogram-paste-function
2480 (funcall interprogram-paste-function))))
2481 (if interprogram-paste
2482 (progn
2483 ;; Disable the interprogram cut function when we add the new
2484 ;; text to the kill ring, so Emacs doesn't try to own the
2485 ;; selection, with identical text.
2486 (let ((interprogram-cut-function nil))
2487 (kill-new interprogram-paste))
2488 interprogram-paste)
2489 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
2490 (let ((ARGth-kill-element
2491 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2492 (length kill-ring))
2493 kill-ring)))
70e14c01
JB
2494 (or do-not-move
2495 (setq kill-ring-yank-pointer ARGth-kill-element))
2496 (car ARGth-kill-element)))))
c88ab9ce 2497
c88ab9ce 2498
eaae8106 2499
70e14c01 2500;;;; Commands for manipulating the kill ring.
c88ab9ce 2501
69c1dd37
RS
2502(defcustom kill-read-only-ok nil
2503 "*Non-nil means don't signal an error for killing read-only text."
2504 :type 'boolean
2505 :group 'killing)
e6291fe1 2506
3a5da8a8
RS
2507(put 'text-read-only 'error-conditions
2508 '(text-read-only buffer-read-only error))
2509(put 'text-read-only 'error-message "Text is read-only")
2510
be5936a7 2511(defun kill-region (beg end &optional yank-handler)
66e9b2b2
RS
2512 "Kill (\"cut\") text between point and mark.
2513This deletes the text from the buffer and saves it in the kill ring.
2076c87c 2514The command \\[yank] can retrieve it from there.
81558867
EZ
2515\(If you want to kill and then yank immediately, use \\[kill-ring-save].)
2516
2517If you want to append the killed region to the last killed text,
2518use \\[append-next-kill] before \\[kill-region].
2519
2aa7a8bf
JB
2520If the buffer is read-only, Emacs will beep and refrain from deleting
2521the text, but put the text in the kill ring anyway. This means that
2522you can use the killing commands to copy text from a read-only buffer.
2076c87c
JB
2523
2524This is the primitive for programs to kill text (as opposed to deleting it).
c15dc81f 2525Supply two arguments, character positions indicating the stretch of text
2076c87c
JB
2526 to be killed.
2527Any command that calls this function is a \"kill command\".
2528If the previous command was also a kill command,
2529the text killed this time appends to the text killed last time
be5936a7
KS
2530to make one entry in the kill ring.
2531
8e5d85ff
LT
2532In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2533specifies the yank-handler text property to be set on the killed
2534text. See `insert-for-yank'."
e761e42c 2535 (interactive "r")
ccd19b9f 2536 (condition-case nil
7fcce20f 2537 (let ((string (filter-buffer-substring beg end t)))
a1eb02bd
SM
2538 (when string ;STRING is nil if BEG = END
2539 ;; Add that string to the kill ring, one way or another.
2540 (if (eq last-command 'kill-region)
be5936a7
KS
2541 (kill-append string (< end beg) yank-handler)
2542 (kill-new string nil yank-handler)))
8a7cda9b 2543 (when (or string (eq last-command 'kill-region))
8e5d85ff
LT
2544 (setq this-command 'kill-region))
2545 nil)
ccd19b9f
KH
2546 ((buffer-read-only text-read-only)
2547 ;; The code above failed because the buffer, or some of the characters
2548 ;; in the region, are read-only.
2549 ;; We should beep, in case the user just isn't aware of this.
2550 ;; However, there's no harm in putting
2551 ;; the region's text in the kill ring, anyway.
2552 (copy-region-as-kill beg end)
cb3e1b4c
RS
2553 ;; Set this-command now, so it will be set even if we get an error.
2554 (setq this-command 'kill-region)
2555 ;; This should barf, if appropriate, and give us the correct error.
ccd19b9f 2556 (if kill-read-only-ok
8e5d85ff 2557 (progn (message "Read only text copied to kill ring") nil)
ccd19b9f
KH
2558 ;; Signal an error if the buffer is read-only.
2559 (barf-if-buffer-read-only)
2560 ;; If the buffer isn't read-only, the text is.
2561 (signal 'text-read-only (list (current-buffer)))))))
2076c87c 2562
a382890a
KH
2563;; copy-region-as-kill no longer sets this-command, because it's confusing
2564;; to get two copies of the text when the user accidentally types M-w and
2565;; then corrects it with the intended C-w.
2076c87c
JB
2566(defun copy-region-as-kill (beg end)
2567 "Save the region as if killed, but don't kill it.
0e264847 2568In Transient Mark mode, deactivate the mark.
46947372
JB
2569If `interprogram-cut-function' is non-nil, also save the text for a window
2570system cut and paste."
2076c87c
JB
2571 (interactive "r")
2572 (if (eq last-command 'kill-region)
7fcce20f
RS
2573 (kill-append (filter-buffer-substring beg end) (< end beg))
2574 (kill-new (filter-buffer-substring beg end)))
1e722f9f 2575 (if transient-mark-mode
5c7319b6 2576 (setq deactivate-mark t))
2076c87c
JB
2577 nil)
2578
2579(defun kill-ring-save (beg end)
0964e562 2580 "Save the region as if killed, but don't kill it.
0e264847 2581In Transient Mark mode, deactivate the mark.
0964e562 2582If `interprogram-cut-function' is non-nil, also save the text for a window
0e264847
RS
2583system cut and paste.
2584
81558867
EZ
2585If you want to append the killed line to the last killed text,
2586use \\[append-next-kill] before \\[kill-ring-save].
2587
0e264847
RS
2588This command is similar to `copy-region-as-kill', except that it gives
2589visual feedback indicating the extent of the region being copied."
2076c87c
JB
2590 (interactive "r")
2591 (copy-region-as-kill beg end)
bbf41690
RS
2592 ;; This use of interactive-p is correct
2593 ;; because the code it controls just gives the user visual feedback.
3a801d0c 2594 (if (interactive-p)
66050f10
RS
2595 (let ((other-end (if (= (point) beg) end beg))
2596 (opoint (point))
2597 ;; Inhibit quitting so we can make a quit here
2598 ;; look like a C-g typed as a command.
2599 (inhibit-quit t))
2600 (if (pos-visible-in-window-p other-end (selected-window))
977e2654
KS
2601 (unless (and transient-mark-mode
2602 (face-background 'region))
66050f10
RS
2603 ;; Swap point and mark.
2604 (set-marker (mark-marker) (point) (current-buffer))
2605 (goto-char other-end)
e4ef3e92 2606 (sit-for blink-matching-delay)
66050f10
RS
2607 ;; Swap back.
2608 (set-marker (mark-marker) other-end (current-buffer))
2609 (goto-char opoint)
2610 ;; If user quit, deactivate the mark
2611 ;; as C-g would as a command.
e4e593ae 2612 (and quit-flag mark-active
fcadf1c7 2613 (deactivate-mark)))
66050f10
RS
2614 (let* ((killed-text (current-kill 0))
2615 (message-len (min (length killed-text) 40)))
2616 (if (= (point) beg)
2617 ;; Don't say "killed"; that is misleading.
2618 (message "Saved text until \"%s\""
2619 (substring killed-text (- message-len)))
2620 (message "Saved text from \"%s\""
2621 (substring killed-text 0 message-len))))))))
2076c87c 2622
c75d4986
KH
2623(defun append-next-kill (&optional interactive)
2624 "Cause following command, if it kills, to append to previous kill.
2625The argument is used for internal purposes; do not supply one."
2626 (interactive "p")
2627 ;; We don't use (interactive-p), since that breaks kbd macros.
2628 (if interactive
2076c87c
JB
2629 (progn
2630 (setq this-command 'kill-region)
2631 (message "If the next command is a kill, it will append"))
2632 (setq last-command 'kill-region)))
cfb4f123 2633\f
93be67de 2634;; Yanking.
2076c87c 2635
cfb4f123
RS
2636;; This is actually used in subr.el but defcustom does not work there.
2637(defcustom yank-excluded-properties
be5936a7 2638 '(read-only invisible intangible field mouse-face help-echo local-map keymap
9e60c724 2639 yank-handler follow-link)
c6ff5a4c
LT
2640 "*Text properties to discard when yanking.
2641The value should be a list of text properties to discard or t,
2642which means to discard all text properties."
cfb4f123 2643 :type '(choice (const :tag "All" t) (repeat symbol))
c9f0110e 2644 :group 'killing
bf247b6e 2645 :version "22.1")
cfb4f123 2646
120de5bd 2647(defvar yank-window-start nil)
be5936a7 2648(defvar yank-undo-function nil
44f5a7b2
KS
2649 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2650Function is called with two parameters, START and END corresponding to
2651the value of the mark and point; it is guaranteed that START <= END.
2652Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
120de5bd 2653
8e5d85ff 2654(defun yank-pop (&optional arg)
ff1fbe3e
RS
2655 "Replace just-yanked stretch of killed text with a different stretch.
2656This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 2657At such a time, the region contains a stretch of reinserted
ff1fbe3e 2658previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
2659place a different stretch of killed text.
2660
2661With no argument, the previous kill is inserted.
ff1fbe3e
RS
2662With argument N, insert the Nth previous kill.
2663If N is negative, this is a more recent kill.
2076c87c
JB
2664
2665The sequence of kills wraps around, so that after the oldest one
a0e8eaa3
EZ
2666comes the newest one.
2667
2668When this command inserts killed text into the buffer, it honors
2669`yank-excluded-properties' and `yank-handler' as described in the
2670doc string for `insert-for-yank-1', which see."
2076c87c
JB
2671 (interactive "*p")
2672 (if (not (eq last-command 'yank))
2673 (error "Previous command was not a yank"))
2674 (setq this-command 'yank)
8e5d85ff 2675 (unless arg (setq arg 1))
3a5da8a8
RS
2676 (let ((inhibit-read-only t)
2677 (before (< (point) (mark t))))
8254897f
KS
2678 (if before
2679 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2680 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
be5936a7 2681 (setq yank-undo-function nil)
fd0f4056 2682 (set-marker (mark-marker) (point) (current-buffer))
cfb4f123 2683 (insert-for-yank (current-kill arg))
120de5bd
RS
2684 ;; Set the window start back where it was in the yank command,
2685 ;; if possible.
2686 (set-window-start (selected-window) yank-window-start t)
fd0f4056
RS
2687 (if before
2688 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2689 ;; It is cleaner to avoid activation, even though the command
2690 ;; loop would deactivate the mark because we inserted text.
2691 (goto-char (prog1 (mark t)
2692 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 2693 nil)
2076c87c
JB
2694
2695(defun yank (&optional arg)
f894e671 2696 "Reinsert (\"paste\") the last stretch of killed text.
2076c87c 2697More precisely, reinsert the stretch of killed text most recently
ff1fbe3e 2698killed OR yanked. Put point at end, and set mark at beginning.
d99f8496 2699With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
ff1fbe3e 2700With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c 2701text.
a0e8eaa3
EZ
2702
2703When this command inserts killed text into the buffer, it honors
2704`yank-excluded-properties' and `yank-handler' as described in the
2705doc string for `insert-for-yank-1', which see.
2706
2076c87c
JB
2707See also the command \\[yank-pop]."
2708 (interactive "*P")
120de5bd 2709 (setq yank-window-start (window-start))
456c617c
RS
2710 ;; If we don't get all the way thru, make last-command indicate that
2711 ;; for the following command.
2712 (setq this-command t)
2076c87c 2713 (push-mark (point))
cfb4f123
RS
2714 (insert-for-yank (current-kill (cond
2715 ((listp arg) 0)
8e5d85ff 2716 ((eq arg '-) -2)
cfb4f123 2717 (t (1- arg)))))
2076c87c 2718 (if (consp arg)
fd0f4056
RS
2719 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2720 ;; It is cleaner to avoid activation, even though the command
2721 ;; loop would deactivate the mark because we inserted text.
2722 (goto-char (prog1 (mark t)
2723 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c 2724 ;; If we do get all the way thru, make this-command indicate that.
be5936a7
KS
2725 (if (eq this-command t)
2726 (setq this-command 'yank))
0964e562 2727 nil)
70e14c01
JB
2728
2729(defun rotate-yank-pointer (arg)
2730 "Rotate the yanking point in the kill ring.
2731With argument, rotate that many kills forward (or backward, if negative)."
2732 (interactive "p")
2733 (current-kill arg))
2d88b556 2734\f
93be67de
KH
2735;; Some kill commands.
2736
2737;; Internal subroutine of delete-char
2738(defun kill-forward-chars (arg)
2739 (if (listp arg) (setq arg (car arg)))
2740 (if (eq arg '-) (setq arg -1))
2741 (kill-region (point) (forward-point arg)))
2742
2743;; Internal subroutine of backward-delete-char
2744(defun kill-backward-chars (arg)
2745 (if (listp arg) (setq arg (car arg)))
2746 (if (eq arg '-) (setq arg -1))
2747 (kill-region (point) (forward-point (- arg))))
2748
2749(defcustom backward-delete-char-untabify-method 'untabify
2750 "*The method for untabifying when deleting backward.
1e722f9f
SS
2751Can be `untabify' -- turn a tab to many spaces, then delete one space;
2752 `hungry' -- delete all whitespace, both tabs and spaces;
2753 `all' -- delete all whitespace, including tabs, spaces and newlines;
93be67de 2754 nil -- just delete one character."
1e722f9f 2755 :type '(choice (const untabify) (const hungry) (const all) (const nil))
03167a34 2756 :version "20.3"
93be67de
KH
2757 :group 'killing)
2758
2759(defun backward-delete-char-untabify (arg &optional killp)
2760 "Delete characters backward, changing tabs into spaces.
2761The exact behavior depends on `backward-delete-char-untabify-method'.
2762Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2763Interactively, ARG is the prefix arg (default 1)
2764and KILLP is t if a prefix arg was specified."
2765 (interactive "*p\nP")
2766 (when (eq backward-delete-char-untabify-method 'untabify)
2767 (let ((count arg))
2768 (save-excursion
2769 (while (and (> count 0) (not (bobp)))
2770 (if (= (preceding-char) ?\t)
2771 (let ((col (current-column)))
2772 (forward-char -1)
2773 (setq col (- col (current-column)))
f33321ad 2774 (insert-char ?\s col)
93be67de
KH
2775 (delete-char 1)))
2776 (forward-char -1)
2777 (setq count (1- count))))))
2778 (delete-backward-char
1e722f9f
SS
2779 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
2780 ((eq backward-delete-char-untabify-method 'all)
2781 " \t\n\r"))))
2782 (if skip
2783 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
93be67de
KH
2784 (point)))))
2785 (+ arg (if (zerop wh) 0 (1- wh))))
1e722f9f 2786 arg))
93be67de
KH
2787 killp))
2788
2789(defun zap-to-char (arg char)
2790 "Kill up to and including ARG'th occurrence of CHAR.
2791Case is ignored if `case-fold-search' is non-nil in the current buffer.
2792Goes backward if ARG is negative; error if CHAR not found."
e761e42c 2793 (interactive "p\ncZap to char: ")
ea9fc1bd
KH
2794 (if (char-table-p translation-table-for-input)
2795 (setq char (or (aref translation-table-for-input char) char)))
93be67de
KH
2796 (kill-region (point) (progn
2797 (search-forward (char-to-string char) nil nil arg)
2798; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2799 (point))))
eaae8106 2800
93be67de
KH
2801;; kill-line and its subroutines.
2802
2803(defcustom kill-whole-line nil
2804 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2805 :type 'boolean
2806 :group 'killing)
2807
2808(defun kill-line (&optional arg)
2809 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2810With prefix argument, kill that many lines from point.
2811Negative arguments kill lines backward.
8be7408c 2812With zero argument, kills the text before point on the current line.
93be67de
KH
2813
2814When calling from a program, nil means \"no arg\",
2815a number counts as a prefix arg.
2816
2817To kill a whole line, when point is not at the beginning, type \
2818\\[beginning-of-line] \\[kill-line] \\[kill-line].
2819
2820If `kill-whole-line' is non-nil, then this command kills the whole line
2821including its terminating newline, when used at the beginning of a line
2822with no argument. As a consequence, you can always kill a whole line
d3f22784
EZ
2823by typing \\[beginning-of-line] \\[kill-line].
2824
81558867
EZ
2825If you want to append the killed line to the last killed text,
2826use \\[append-next-kill] before \\[kill-line].
2827
d3f22784
EZ
2828If the buffer is read-only, Emacs will beep and refrain from deleting
2829the line, but put the line in the kill ring anyway. This means that
1a534b89
RS
2830you can use this command to copy text from a read-only buffer.
2831\(If the variable `kill-read-only-ok' is non-nil, then this won't
2832even beep.)"
e761e42c 2833 (interactive "P")
93be67de
KH
2834 (kill-region (point)
2835 ;; It is better to move point to the other end of the kill
2836 ;; before killing. That way, in a read-only buffer, point
2837 ;; moves across the text that is copied to the kill ring.
2838 ;; The choice has no effect on undo now that undo records
2839 ;; the value of point from before the command was run.
2840 (progn
2841 (if arg
2842 (forward-visible-line (prefix-numeric-value arg))
2843 (if (eobp)
2844 (signal 'end-of-buffer nil))
5560dc5d
RS
2845 (let ((end
2846 (save-excursion
2847 (end-of-visible-line) (point))))
2848 (if (or (save-excursion
2c6a2254
RS
2849 ;; If trailing whitespace is visible,
2850 ;; don't treat it as nothing.
2851 (unless show-trailing-whitespace
2852 (skip-chars-forward " \t" end))
5560dc5d
RS
2853 (= (point) end))
2854 (and kill-whole-line (bolp)))
2855 (forward-visible-line 1)
2856 (goto-char end))))
93be67de
KH
2857 (point))))
2858
348de80b
KG
2859(defun kill-whole-line (&optional arg)
2860 "Kill current line.
6c770e38
LT
2861With prefix arg, kill that many lines starting from the current line.
2862If arg is negative, kill backward. Also kill the preceding newline.
01ba9662 2863\(This is meant to make \\[repeat] work well with negative arguments.\)
348de80b 2864If arg is zero, kill current line but exclude the trailing newline."
f8b0f284 2865 (interactive "p")
6c770e38
LT
2866 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2867 (signal 'end-of-buffer nil))
2868 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2869 (signal 'beginning-of-buffer nil))
2870 (unless (eq last-command 'kill-region)
2871 (kill-new "")
2872 (setq last-command 'kill-region))
348de80b 2873 (cond ((zerop arg)
6c770e38
LT
2874 ;; We need to kill in two steps, because the previous command
2875 ;; could have been a kill command, in which case the text
2876 ;; before point needs to be prepended to the current kill
2877 ;; ring entry and the text after point appended. Also, we
2878 ;; need to use save-excursion to avoid copying the same text
2879 ;; twice to the kill ring in read-only buffers.
2880 (save-excursion
2881 (kill-region (point) (progn (forward-visible-line 0) (point))))
348de80b
KG
2882 (kill-region (point) (progn (end-of-visible-line) (point))))
2883 ((< arg 0)
6c770e38
LT
2884 (save-excursion
2885 (kill-region (point) (progn (end-of-visible-line) (point))))
2886 (kill-region (point)
2887 (progn (forward-visible-line (1+ arg))
2888 (unless (bobp) (backward-char))
2889 (point))))
348de80b 2890 (t
6c770e38
LT
2891 (save-excursion
2892 (kill-region (point) (progn (forward-visible-line 0) (point))))
2893 (kill-region (point)
2894 (progn (forward-visible-line arg) (point))))))
12a93712 2895
93be67de
KH
2896(defun forward-visible-line (arg)
2897 "Move forward by ARG lines, ignoring currently invisible newlines only.
2898If ARG is negative, move backward -ARG lines.
2899If ARG is zero, move to the beginning of the current line."
2900 (condition-case nil
2901 (if (> arg 0)
12a93712
RS
2902 (progn
2903 (while (> arg 0)
93be67de 2904 (or (zerop (forward-line 1))
12a93712
RS
2905 (signal 'end-of-buffer nil))
2906 ;; If the newline we just skipped is invisible,
2907 ;; don't count it.
2908 (let ((prop
2909 (get-char-property (1- (point)) 'invisible)))
2910 (if (if (eq buffer-invisibility-spec t)
2911 prop
2912 (or (memq prop buffer-invisibility-spec)
2913 (assq prop buffer-invisibility-spec)))
2914 (setq arg (1+ arg))))
2915 (setq arg (1- arg)))
2916 ;; If invisible text follows, and it is a number of complete lines,
2917 ;; skip it.
2918 (let ((opoint (point)))
2919 (while (and (not (eobp))
2920 (let ((prop
2921 (get-char-property (point) 'invisible)))
2922 (if (eq buffer-invisibility-spec t)
2923 prop
2924 (or (memq prop buffer-invisibility-spec)
2925 (assq prop buffer-invisibility-spec)))))
2926 (goto-char
2927 (if (get-text-property (point) 'invisible)
2928 (or (next-single-property-change (point) 'invisible)
2929 (point-max))
2930 (next-overlay-change (point)))))
2931 (unless (bolp)
2932 (goto-char opoint))))
93be67de 2933 (let ((first t))
f5fd8833
JB
2934 (while (or first (<= arg 0))
2935 (if first
93be67de
KH
2936 (beginning-of-line)
2937 (or (zerop (forward-line -1))
2938 (signal 'beginning-of-buffer nil)))
12a93712
RS
2939 ;; If the newline we just moved to is invisible,
2940 ;; don't count it.
2941 (unless (bobp)
2942 (let ((prop
2943 (get-char-property (1- (point)) 'invisible)))
f5fd8833
JB
2944 (unless (if (eq buffer-invisibility-spec t)
2945 prop
2946 (or (memq prop buffer-invisibility-spec)
2947 (assq prop buffer-invisibility-spec)))
2948 (setq arg (1+ arg)))))
2949 (setq first nil))
12a93712
RS
2950 ;; If invisible text follows, and it is a number of complete lines,
2951 ;; skip it.
2952 (let ((opoint (point)))
93be67de
KH
2953 (while (and (not (bobp))
2954 (let ((prop
2955 (get-char-property (1- (point)) 'invisible)))
2956 (if (eq buffer-invisibility-spec t)
2957 prop
2958 (or (memq prop buffer-invisibility-spec)
2959 (assq prop buffer-invisibility-spec)))))
2960 (goto-char
2961 (if (get-text-property (1- (point)) 'invisible)
2962 (or (previous-single-property-change (point) 'invisible)
2963 (point-min))
12a93712
RS
2964 (previous-overlay-change (point)))))
2965 (unless (bolp)
2966 (goto-char opoint)))))
93be67de
KH
2967 ((beginning-of-buffer end-of-buffer)
2968 nil)))
70e14c01 2969
93be67de
KH
2970(defun end-of-visible-line ()
2971 "Move to end of current visible line."
2972 (end-of-line)
2973 ;; If the following character is currently invisible,
2974 ;; skip all characters with that same `invisible' property value,
2975 ;; then find the next newline.
2976 (while (and (not (eobp))
5560dc5d
RS
2977 (save-excursion
2978 (skip-chars-forward "^\n")
2979 (let ((prop
2980 (get-char-property (point) 'invisible)))
2981 (if (eq buffer-invisibility-spec t)
2982 prop
2983 (or (memq prop buffer-invisibility-spec)
2984 (assq prop buffer-invisibility-spec))))))
2985 (skip-chars-forward "^\n")
93be67de
KH
2986 (if (get-text-property (point) 'invisible)
2987 (goto-char (next-single-property-change (point) 'invisible))
2988 (goto-char (next-overlay-change (point))))
2989 (end-of-line)))
2d88b556 2990\f
2076c87c
JB
2991(defun insert-buffer (buffer)
2992 "Insert after point the contents of BUFFER.
2993Puts mark after the inserted text.
6cb6e7a2
GM
2994BUFFER may be a buffer or a buffer name.
2995
2996This function is meant for the user to run interactively.
1e96c007 2997Don't call it from programs: use `insert-buffer-substring' instead!"
c3d4f949 2998 (interactive
a3e7c391
FP
2999 (list
3000 (progn
3001 (barf-if-buffer-read-only)
3002 (read-buffer "Insert buffer: "
3003 (if (eq (selected-window) (next-window (selected-window)))
3004 (other-buffer (current-buffer))
3005 (window-buffer (next-window (selected-window))))
3006 t))))
1e96c007
SM
3007 (push-mark
3008 (save-excursion
3009 (insert-buffer-substring (get-buffer buffer))
3010 (point)))
1537a263 3011 nil)
2076c87c
JB
3012
3013(defun append-to-buffer (buffer start end)
3014 "Append to specified buffer the text of the region.
3015It is inserted into that buffer before its point.
3016
3017When calling from a program, give three arguments:
3018BUFFER (or buffer name), START and END.
3019START and END specify the portion of the current buffer to be copied."
70e14c01 3020 (interactive
5d771766 3021 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 3022 (region-beginning) (region-end)))
2076c87c
JB
3023 (let ((oldbuf (current-buffer)))
3024 (save-excursion
c069a480
GM
3025 (let* ((append-to (get-buffer-create buffer))
3026 (windows (get-buffer-window-list append-to t t))
3027 point)
3028 (set-buffer append-to)
3029 (setq point (point))
3030 (barf-if-buffer-read-only)
3031 (insert-buffer-substring oldbuf start end)
3032 (dolist (window windows)
3033 (when (= (window-point window) point)
3034 (set-window-point window (point))))))))
2076c87c
JB
3035
3036(defun prepend-to-buffer (buffer start end)
3037 "Prepend to specified buffer the text of the region.
3038It is inserted into that buffer after its point.
3039
3040When calling from a program, give three arguments:
3041BUFFER (or buffer name), START and END.
3042START and END specify the portion of the current buffer to be copied."
3043 (interactive "BPrepend to buffer: \nr")
3044 (let ((oldbuf (current-buffer)))
3045 (save-excursion
3046 (set-buffer (get-buffer-create buffer))
74399eac 3047 (barf-if-buffer-read-only)
2076c87c
JB
3048 (save-excursion
3049 (insert-buffer-substring oldbuf start end)))))
3050
3051(defun copy-to-buffer (buffer start end)
3052 "Copy to specified buffer the text of the region.
3053It is inserted into that buffer, replacing existing text there.
3054
3055When calling from a program, give three arguments:
3056BUFFER (or buffer name), START and END.
3057START and END specify the portion of the current buffer to be copied."
3058 (interactive "BCopy to buffer: \nr")
3059 (let ((oldbuf (current-buffer)))
1b5fd09e 3060 (with-current-buffer (get-buffer-create buffer)
74399eac 3061 (barf-if-buffer-read-only)
2076c87c
JB
3062 (erase-buffer)
3063 (save-excursion
3064 (insert-buffer-substring oldbuf start end)))))
2d88b556 3065\f
62d1c1fc
RM
3066(put 'mark-inactive 'error-conditions '(mark-inactive error))
3067(put 'mark-inactive 'error-message "The mark is not active now")
3068
0251bafb
RS
3069(defvar activate-mark-hook nil
3070 "Hook run when the mark becomes active.
3071It is also run at the end of a command, if the mark is active and
3072it is possible that the region may have changed")
3073
3074(defvar deactivate-mark-hook nil
3075 "Hook run when the mark becomes inactive.")
3076
af39530e 3077(defun mark (&optional force)
f00239cf
RS
3078 "Return this buffer's mark value as integer, or nil if never set.
3079
3080In Transient Mark mode, this function signals an error if
3081the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3082or the argument FORCE is non-nil, it disregards whether the mark
3083is active, and returns an integer or nil in the usual way.
af39530e 3084
2076c87c
JB
3085If you are using this in an editing command, you are most likely making
3086a mistake; see the documentation of `set-mark'."
0e3a7b14 3087 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
af39530e 3088 (marker-position (mark-marker))
62d1c1fc 3089 (signal 'mark-inactive nil)))
2076c87c 3090
19d35374
RM
3091;; Many places set mark-active directly, and several of them failed to also
3092;; run deactivate-mark-hook. This shorthand should simplify.
3093(defsubst deactivate-mark ()
3094 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 3095\(That makes a difference only in Transient Mark mode.)
19d35374 3096Also runs the hook `deactivate-mark-hook'."
868c2f49
KS
3097 (cond
3098 ((eq transient-mark-mode 'lambda)
3099 (setq transient-mark-mode nil))
3100 (transient-mark-mode
3101 (setq mark-active nil)
3102 (run-hooks 'deactivate-mark-hook))))
19d35374 3103
2076c87c
JB
3104(defun set-mark (pos)
3105 "Set this buffer's mark to POS. Don't use this function!
3106That is to say, don't use this function unless you want
3107the user to see that the mark has moved, and you want the previous
3108mark position to be lost.
3109
3110Normally, when a new mark is set, the old one should go on the stack.
f59006cb 3111This is why most applications should use `push-mark', not `set-mark'.
2076c87c 3112
ff1fbe3e 3113Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3114purposes. The mark saves a location for the user's convenience.
3115Most editing commands should not alter the mark.
3116To remember a location for internal use in the Lisp program,
3117store it in a Lisp variable. Example:
3118
3119 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3120
fcadf1c7
RS
3121 (if pos
3122 (progn
3123 (setq mark-active t)
3124 (run-hooks 'activate-mark-hook)
3125 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
3126 ;; Normally we never clear mark-active except in Transient Mark mode.
3127 ;; But when we actually clear out the mark value too,
3128 ;; we must clear mark-active in any mode.
3129 (setq mark-active nil)
3130 (run-hooks 'deactivate-mark-hook)
3131 (set-marker (mark-marker) nil)))
2076c87c
JB
3132
3133(defvar mark-ring nil
e55e2267 3134 "The list of former marks of the current buffer, most recent first.")
2076c87c 3135(make-variable-buffer-local 'mark-ring)
e55e2267 3136(put 'mark-ring 'permanent-local t)
2076c87c 3137
69c1dd37
RS
3138(defcustom mark-ring-max 16
3139 "*Maximum size of mark ring. Start discarding off end if gets this big."
3140 :type 'integer
3141 :group 'editing-basics)
2076c87c 3142
dc029f0b
RM
3143(defvar global-mark-ring nil
3144 "The list of saved global marks, most recent first.")
3145
69c1dd37 3146(defcustom global-mark-ring-max 16
dc029f0b 3147 "*Maximum size of global mark ring. \
69c1dd37
RS
3148Start discarding off end if gets this big."
3149 :type 'integer
3150 :group 'editing-basics)
dc029f0b 3151
868c2f49
KS
3152(defun pop-to-mark-command ()
3153 "Jump to mark, and pop a new position for mark off the ring
3154\(does not affect global mark ring\)."
3155 (interactive)
3156 (if (null (mark t))
3157 (error "No mark set in this buffer")
868c2f49
KS
3158 (goto-char (mark t))
3159 (pop-mark)))
3160
d00ffe21 3161(defun push-mark-command (arg &optional nomsg)
868c2f49 3162 "Set mark at where point is.
d00ffe21
KS
3163If no prefix arg and mark is already set there, just activate it.
3164Display `Mark set' unless the optional second arg NOMSG is non-nil."
868c2f49
KS
3165 (interactive "P")
3166 (let ((mark (marker-position (mark-marker))))
3167 (if (or arg (null mark) (/= mark (point)))
d00ffe21 3168 (push-mark nil nomsg t)
868c2f49 3169 (setq mark-active t)
0251bafb 3170 (run-hooks 'activate-mark-hook)
d00ffe21
KS
3171 (unless nomsg
3172 (message "Mark activated")))))
868c2f49 3173
6a936796
RS
3174(defcustom set-mark-command-repeat-pop nil
3175 "*Non-nil means that repeating \\[set-mark-command] after popping will pop.
3176This means that if you type C-u \\[set-mark-command] \\[set-mark-command]
3177will pop twice."
3178 :type 'boolean
3179 :group 'editing)
3180
2076c87c
JB
3181(defun set-mark-command (arg)
3182 "Set mark at where point is, or jump to mark.
66ef2df9
KS
3183With no prefix argument, set mark, and push old mark position on local
3184mark ring; also push mark on global mark ring if last mark was set in
3185another buffer. Immediately repeating the command activates
3186`transient-mark-mode' temporarily.
3187
3188With argument, e.g. \\[universal-argument] \\[set-mark-command], \
3189jump to mark, and pop a new position
3190for mark off the local mark ring \(this does not affect the global
3191mark ring\). Use \\[pop-global-mark] to jump to a mark off the global
3192mark ring \(see `pop-global-mark'\).
18c5df40 3193
2ef0a47e
RS
3194If `set-mark-command-repeat-pop' is non-nil, repeating
3195the \\[set-mark-command] command with no prefix pops the next position
3196off the local (or global) mark ring and jumps there.
66ef2df9
KS
3197
3198With a double \\[universal-argument] prefix argument, e.g. \\[universal-argument] \
3199\\[universal-argument] \\[set-mark-command], unconditionally
3200set mark where point is.
2076c87c 3201
7cb42362
RS
3202Setting the mark also sets the \"region\", which is the closest
3203equivalent in Emacs to what some editors call the \"selection\".
3204
ff1fbe3e 3205Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3206purposes. See the documentation of `set-mark' for more information."
3207 (interactive "P")
868c2f49
KS
3208 (if (eq transient-mark-mode 'lambda)
3209 (setq transient-mark-mode nil))
3210 (cond
18c5df40
KS
3211 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3212 (push-mark-command nil))
868c2f49 3213 ((not (eq this-command 'set-mark-command))
1841f9e3
KS
3214 (if arg
3215 (pop-to-mark-command)
3216 (push-mark-command t)))
6a936796
RS
3217 ((and set-mark-command-repeat-pop
3218 (eq last-command 'pop-to-mark-command))
66ef2df9
KS
3219 (setq this-command 'pop-to-mark-command)
3220 (pop-to-mark-command))
6a936796
RS
3221 ((and set-mark-command-repeat-pop
3222 (eq last-command 'pop-global-mark)
3223 (not arg))
66ef2df9
KS
3224 (setq this-command 'pop-global-mark)
3225 (pop-global-mark))
868c2f49 3226 (arg
1841f9e3 3227 (setq this-command 'pop-to-mark-command)
868c2f49
KS
3228 (pop-to-mark-command))
3229 ((and (eq last-command 'set-mark-command)
3230 mark-active (null transient-mark-mode))
3231 (setq transient-mark-mode 'lambda)
3232 (message "Transient-mark-mode temporarily enabled"))
3233 (t
3234 (push-mark-command nil))))
2076c87c 3235
fd0f4056 3236(defun push-mark (&optional location nomsg activate)
2076c87c 3237 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
3238If the last global mark pushed was not in the current buffer,
3239also push LOCATION on the global mark ring.
fd0f4056 3240Display `Mark set' unless the optional second arg NOMSG is non-nil.
8cdc660f 3241In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2076c87c 3242
ff1fbe3e 3243Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
3244purposes. See the documentation of `set-mark' for more information.
3245
3246In Transient Mark mode, this does not activate the mark."
1a0d0b6a 3247 (unless (null (mark t))
2076c87c 3248 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1a0d0b6a
JPW
3249 (when (> (length mark-ring) mark-ring-max)
3250 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3251 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
9a1277dd 3252 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 3253 ;; Now push the mark on the global mark ring.
f1382a3d 3254 (if (and global-mark-ring
e08d3f7c 3255 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
3256 ;; The last global mark pushed was in this same buffer.
3257 ;; Don't push another one.
3258 nil
3259 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1a0d0b6a
JPW
3260 (when (> (length global-mark-ring) global-mark-ring-max)
3261 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3262 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
efcf38c7 3263 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2076c87c 3264 (message "Mark set"))
8cdc660f
RS
3265 (if (or activate (not transient-mark-mode))
3266 (set-mark (mark t)))
2076c87c
JB
3267 nil)
3268
3269(defun pop-mark ()
3270 "Pop off mark ring into the buffer's actual mark.
3271Does not set point. Does nothing if mark ring is empty."
1a0d0b6a
JPW
3272 (when mark-ring
3273 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3274 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1a0d0b6a
JPW
3275 (move-marker (car mark-ring) nil)
3276 (if (null (mark t)) (ding))
0137bae6
JL
3277 (setq mark-ring (cdr mark-ring)))
3278 (deactivate-mark))
2076c87c 3279
e462e42f 3280(defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
868c2f49 3281(defun exchange-point-and-mark (&optional arg)
af39530e
RS
3282 "Put the mark where point is now, and point where the mark is now.
3283This command works even when the mark is not active,
868c2f49
KS
3284and it reactivates the mark.
3285With prefix arg, `transient-mark-mode' is enabled temporarily."
3286 (interactive "P")
3287 (if arg
f1180544 3288 (if mark-active
868c2f49
KS
3289 (if (null transient-mark-mode)
3290 (setq transient-mark-mode 'lambda))
3291 (setq arg nil)))
3292 (unless arg
3293 (let ((omark (mark t)))
3294 (if (null omark)
3295 (error "No mark set in this buffer"))
3296 (set-mark (point))
3297 (goto-char omark)
3298 nil)))
e23c2c21 3299
6710df48 3300(define-minor-mode transient-mark-mode
e23c2c21 3301 "Toggle Transient Mark mode.
b411b5fa 3302With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 3303
5dd1220d
RS
3304In Transient Mark mode, when the mark is active, the region is highlighted.
3305Changing the buffer \"deactivates\" the mark.
3306So do certain other operations that set the mark
3307but whose main purpose is something else--for example,
cfa70244
EZ
3308incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
3309
8e843bc4
EZ
3310You can also deactivate the mark by typing \\[keyboard-quit] or
3311\\[keyboard-escape-quit].
1465c66b 3312
cfa70244
EZ
3313Many commands change their behavior when Transient Mark mode is in effect
3314and the mark is active, by acting on the region instead of their usual
4c5f7215 3315default part of the buffer's text. Examples of such commands include
705a5933
JL
3316\\[comment-dwim], \\[flush-lines], \\[keep-lines], \
3317\\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
3318Invoke \\[apropos-documentation] and type \"transient\" or
3319\"mark.*active\" at the prompt, to see the documentation of
3320commands which are sensitive to the Transient Mark mode."
dfd8ca69 3321 :global t :group 'editing-basics)
dc029f0b 3322
d0c4882d
RS
3323(defvar widen-automatically t
3324 "Non-nil means it is ok for commands to call `widen' when they want to.
3325Some commands will do this in order to go to positions outside
3326the current accessible part of the buffer.
3327
3328If `widen-automatically' is nil, these commands will do something else
3329as a fallback, and won't change the buffer bounds.")
3330
dc029f0b
RM
3331(defun pop-global-mark ()
3332 "Pop off global mark ring and jump to the top location."
3333 (interactive)
52b6d445
RS
3334 ;; Pop entries which refer to non-existent buffers.
3335 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3336 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
3337 (or global-mark-ring
3338 (error "No global mark set"))
3339 (let* ((marker (car global-mark-ring))
3340 (buffer (marker-buffer marker))
3341 (position (marker-position marker)))
34c31301
RS
3342 (setq global-mark-ring (nconc (cdr global-mark-ring)
3343 (list (car global-mark-ring))))
dc029f0b
RM
3344 (set-buffer buffer)
3345 (or (and (>= position (point-min))
3346 (<= position (point-max)))
d0c4882d 3347 (if widen-automatically
60aee8b2
RS
3348 (widen)
3349 (error "Global mark position is outside accessible part of buffer")))
dc029f0b
RM
3350 (goto-char position)
3351 (switch-to-buffer buffer)))
2d88b556 3352\f
95791033 3353(defcustom next-line-add-newlines nil
69c1dd37
RS
3354 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3355 :type 'boolean
e1d6e383 3356 :version "21.1"
69c1dd37 3357 :group 'editing-basics)
38ebcf29 3358
295f6616 3359(defun next-line (&optional arg try-vscroll)
2076c87c 3360 "Move cursor vertically down ARG lines.
295f6616 3361Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
3362If there is no character in the target line exactly under the current column,
3363the cursor is positioned after the character in that line which spans this
3364column, or at the end of the line if it is not long enough.
38ebcf29 3365If there is no line in the buffer after this one, behavior depends on the
1a2c3941
RS
3366value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3367to create a line, and moves the cursor to that line. Otherwise it moves the
e47d38f6 3368cursor to the end of the buffer.
2076c87c
JB
3369
3370The command \\[set-goal-column] can be used to create
85969cb1
RS
3371a semipermanent goal column for this command.
3372Then instead of trying to move exactly vertically (or as close as possible),
3373this command moves to the specified goal column (or as close as possible).
3374The goal column is stored in the variable `goal-column', which is nil
3375when there is no goal column.
2076c87c
JB
3376
3377If you are thinking of using this in a Lisp program, consider
3378using `forward-line' instead. It is usually easier to use
3379and more reliable (no dependence on goal column, etc.)."
295f6616 3380 (interactive "p\np")
b82d844f 3381 (or arg (setq arg 1))
028922cf 3382 (if (and next-line-add-newlines (= arg 1))
207d7545
GM
3383 (if (save-excursion (end-of-line) (eobp))
3384 ;; When adding a newline, don't expand an abbrev.
3385 (let ((abbrev-mode nil))
24886813 3386 (end-of-line)
15575807 3387 (insert (if use-hard-newlines hard-newline "\n")))
295f6616 3388 (line-move arg nil nil try-vscroll))
1a2c3941
RS
3389 (if (interactive-p)
3390 (condition-case nil
295f6616 3391 (line-move arg nil nil try-vscroll)
1a2c3941 3392 ((beginning-of-buffer end-of-buffer) (ding)))
295f6616 3393 (line-move arg nil nil try-vscroll)))
2076c87c
JB
3394 nil)
3395
295f6616 3396(defun previous-line (&optional arg try-vscroll)
2076c87c 3397 "Move cursor vertically up ARG lines.
295f6616 3398Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
3399If there is no character in the target line exactly over the current column,
3400the cursor is positioned after the character in that line which spans this
3401column, or at the end of the line if it is not long enough.
3402
3403The command \\[set-goal-column] can be used to create
85969cb1
RS
3404a semipermanent goal column for this command.
3405Then instead of trying to move exactly vertically (or as close as possible),
3406this command moves to the specified goal column (or as close as possible).
3407The goal column is stored in the variable `goal-column', which is nil
3408when there is no goal column.
2076c87c
JB
3409
3410If you are thinking of using this in a Lisp program, consider using
c2e8a012 3411`forward-line' with a negative argument instead. It is usually easier
2076c87c 3412to use and more reliable (no dependence on goal column, etc.)."
295f6616 3413 (interactive "p\np")
b82d844f 3414 (or arg (setq arg 1))
1a2c3941
RS
3415 (if (interactive-p)
3416 (condition-case nil
295f6616 3417 (line-move (- arg) nil nil try-vscroll)
1a2c3941 3418 ((beginning-of-buffer end-of-buffer) (ding)))
295f6616 3419 (line-move (- arg) nil nil try-vscroll))
2076c87c 3420 nil)
eaae8106 3421
69c1dd37 3422(defcustom track-eol nil
2076c87c
JB
3423 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3424This means moving to the end of each line moved onto.
69c1dd37
RS
3425The beginning of a blank line does not count as the end of a line."
3426 :type 'boolean
3427 :group 'editing-basics)
3428
3429(defcustom goal-column nil
3430 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
3431 :type '(choice integer
3432 (const :tag "None" nil))
3433 :group 'editing-basics)
912c6728 3434(make-variable-buffer-local 'goal-column)
2076c87c
JB
3435
3436(defvar temporary-goal-column 0
3437 "Current goal column for vertical motion.
3438It is the column where point was
3439at the start of current run of vertical motion commands.
c637ae6f 3440When the `track-eol' feature is doing its job, the value is 9999.")
2076c87c 3441
bbf41690 3442(defcustom line-move-ignore-invisible t
098fc1fb 3443 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
69c1dd37
RS
3444Outline mode sets this."
3445 :type 'boolean
3446 :group 'editing-basics)
098fc1fb 3447
bbf41690 3448(defun line-move-invisible-p (pos)
af894fc9
RS
3449 "Return non-nil if the character after POS is currently invisible."
3450 (let ((prop
3451 (get-char-property pos 'invisible)))
3452 (if (eq buffer-invisibility-spec t)
3453 prop
3454 (or (memq prop buffer-invisibility-spec)
3455 (assq prop buffer-invisibility-spec)))))
3456
03ceda9e
RS
3457;; This is like line-move-1 except that it also performs
3458;; vertical scrolling of tall images if appropriate.
3459;; That is not really a clean thing to do, since it mixes
3460;; scrolling with cursor motion. But so far we don't have
3461;; a cleaner solution to the problem of making C-n do something
3462;; useful given a tall image.
ed02c1db 3463(defun line-move (arg &optional noerror to-end try-vscroll)
295f6616 3464 (if (and auto-window-vscroll try-vscroll
03ceda9e 3465 ;; But don't vscroll in a keyboard macro.
295f6616
KS
3466 (not defining-kbd-macro)
3467 (not executing-kbd-macro))
16c2f92f 3468 (let ((forward (> arg 0))
257a694c
KS
3469 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3470 (if (and (consp part)
0fc367df 3471 (> (if forward (cdr part) (car part)) 0))
16c2f92f
KS
3472 (set-window-vscroll nil
3473 (if forward
3474 (+ (window-vscroll nil t)
0fc367df 3475 (min (cdr part)
16c2f92f
KS
3476 (* (frame-char-height) arg)))
3477 (max 0
3478 (- (window-vscroll nil t)
0fc367df 3479 (min (car part)
16c2f92f
KS
3480 (* (frame-char-height) (- arg))))))
3481 t)
3482 (set-window-vscroll nil 0)
ed02c1db 3483 (when (line-move-1 arg noerror to-end)
0fc367df 3484 (when (not forward)
98f4a29e
KS
3485 ;; Update display before calling pos-visible-in-window-p,
3486 ;; because it depends on window-start being up-to-date.
0fc367df 3487 (sit-for 0)
03ceda9e
RS
3488 ;; If the current line is partly hidden at the bottom,
3489 ;; scroll it partially up so as to unhide the bottom.
0fc367df
KS
3490 (if (and (setq part (nth 2 (pos-visible-in-window-p
3491 (line-beginning-position) nil t)))
3492 (> (cdr part) 0))
3493 (set-window-vscroll nil (cdr part) t)))
ed02c1db 3494 t)))
16c2f92f
KS
3495 (line-move-1 arg noerror to-end)))
3496
8c745744
RS
3497;; This is the guts of next-line and previous-line.
3498;; Arg says how many lines to move.
bbf41690 3499;; The value is t if we can move the specified number of lines.
16c2f92f 3500(defun line-move-1 (arg &optional noerror to-end)
2596511d
RS
3501 ;; Don't run any point-motion hooks, and disregard intangibility,
3502 ;; for intermediate positions.
3503 (let ((inhibit-point-motion-hooks t)
3504 (opoint (point))
c6db81aa 3505 (forward (> arg 0)))
2596511d
RS
3506 (unwind-protect
3507 (progn
41d22ee0 3508 (if (not (memq last-command '(next-line previous-line)))
2596511d
RS
3509 (setq temporary-goal-column
3510 (if (and track-eol (eolp)
3511 ;; Don't count beg of empty line as end of line
3512 ;; unless we just did explicit end-of-line.
3513 (or (not (bolp)) (eq last-command 'end-of-line)))
3514 9999
3515 (current-column))))
bbf41690 3516
2596511d
RS
3517 (if (and (not (integerp selective-display))
3518 (not line-move-ignore-invisible))
3519 ;; Use just newline characters.
e9cd25fe 3520 ;; Set ARG to 0 if we move as many lines as requested.
2596511d
RS
3521 (or (if (> arg 0)
3522 (progn (if (> arg 1) (forward-line (1- arg)))
3523 ;; This way of moving forward ARG lines
3524 ;; verifies that we have a newline after the last one.
3525 ;; It doesn't get confused by intangible text.
3526 (end-of-line)
e9cd25fe
RS
3527 (if (zerop (forward-line 1))
3528 (setq arg 0)))
2596511d 3529 (and (zerop (forward-line arg))
e9cd25fe
RS
3530 (bolp)
3531 (setq arg 0)))
bbf41690
RS
3532 (unless noerror
3533 (signal (if (< arg 0)
3534 'beginning-of-buffer
3535 'end-of-buffer)
3536 nil)))
2596511d 3537 ;; Move by arg lines, but ignore invisible ones.
bbf41690
RS
3538 (let (done)
3539 (while (and (> arg 0) (not done))
3540 ;; If the following character is currently invisible,
3541 ;; skip all characters with that same `invisible' property value.
3542 (while (and (not (eobp)) (line-move-invisible-p (point)))
3543 (goto-char (next-char-property-change (point))))
3544 ;; Now move a line.
3545 (end-of-line)
e9ab825f 3546 ;; If there's no invisibility here, move over the newline.
3e43ae87
KS
3547 (cond
3548 ((eobp)
3549 (if (not noerror)
3550 (signal 'end-of-buffer nil)
3551 (setq done t)))
3552 ((and (> arg 1) ;; Use vertical-motion for last move
3553 (not (integerp selective-display))
3554 (not (line-move-invisible-p (point))))
3555 ;; We avoid vertical-motion when possible
3556 ;; because that has to fontify.
3557 (forward-line 1))
3558 ;; Otherwise move a more sophisticated way.
3559 ((zerop (vertical-motion 1))
3560 (if (not noerror)
3561 (signal 'end-of-buffer nil)
3562 (setq done t))))
bbf41690
RS
3563 (unless done
3564 (setq arg (1- arg))))
22c8bff1 3565 ;; The logic of this is the same as the loop above,
e9ab825f 3566 ;; it just goes in the other direction.
bbf41690
RS
3567 (while (and (< arg 0) (not done))
3568 (beginning-of-line)
3e43ae87
KS
3569 (cond
3570 ((bobp)
3571 (if (not noerror)
3572 (signal 'beginning-of-buffer nil)
3573 (setq done t)))
3574 ((and (< arg -1) ;; Use vertical-motion for last move
3575 (not (integerp selective-display))
3576 (not (line-move-invisible-p (1- (point)))))
3577 (forward-line -1))
3578 ((zerop (vertical-motion -1))
3579 (if (not noerror)
3580 (signal 'beginning-of-buffer nil)
3581 (setq done t))))
bbf41690
RS
3582 (unless done
3583 (setq arg (1+ arg))
3584 (while (and ;; Don't move over previous invis lines
3585 ;; if our target is the middle of this line.
3586 (or (zerop (or goal-column temporary-goal-column))
3587 (< arg 0))
3588 (not (bobp)) (line-move-invisible-p (1- (point))))
3589 (goto-char (previous-char-property-change (point))))))))
3590 ;; This is the value the function returns.
3591 (= arg 0))
af894fc9 3592
e9cd25fe
RS
3593 (cond ((> arg 0)
3594 ;; If we did not move down as far as desired,
3595 ;; at least go to end of line.
3596 (end-of-line))
3597 ((< arg 0)
f9872a6b
JL
3598 ;; If we did not move up as far as desired,
3599 ;; at least go to beginning of line.
e9cd25fe
RS
3600 (beginning-of-line))
3601 (t
20782abb
RS
3602 (line-move-finish (or goal-column temporary-goal-column)
3603 opoint forward))))))
2076c87c 3604
20782abb 3605(defun line-move-finish (column opoint forward)
af894fc9
RS
3606 (let ((repeat t))
3607 (while repeat
3608 ;; Set REPEAT to t to repeat the whole thing.
3609 (setq repeat nil)
3610
1f980920 3611 (let (new
af894fc9 3612 (line-beg (save-excursion (beginning-of-line) (point)))
1f980920
RS
3613 (line-end
3614 ;; Compute the end of the line
20782abb 3615 ;; ignoring effectively invisible newlines.
bbf41690 3616 (save-excursion
a5b4a6a0
RS
3617 ;; Like end-of-line but ignores fields.
3618 (skip-chars-forward "^\n")
20782abb
RS
3619 (while (and (not (eobp)) (line-move-invisible-p (point)))
3620 (goto-char (next-char-property-change (point)))
a5b4a6a0 3621 (skip-chars-forward "^\n"))
bbf41690 3622 (point))))
1f980920
RS
3623
3624 ;; Move to the desired column.
3625 (line-move-to-column column)
3626 (setq new (point))
af894fc9
RS
3627
3628 ;; Process intangibility within a line.
3629 ;; Move to the chosen destination position from above,
3630 ;; with intangibility processing enabled.
3631
3632 (goto-char (point-min))
3633 (let ((inhibit-point-motion-hooks nil))
3634 (goto-char new)
3635
3636 ;; If intangibility moves us to a different (later) place
3637 ;; in the same line, use that as the destination.
3638 (if (<= (point) line-end)
1f980920
RS
3639 (setq new (point))
3640 ;; If that position is "too late",
3641 ;; try the previous allowable position.
3642 ;; See if it is ok.
3643 (backward-char)
20782abb
RS
3644 (if (if forward
3645 ;; If going forward, don't accept the previous
3646 ;; allowable position if it is before the target line.
f1e2a033 3647 (< line-beg (point))
20782abb
RS
3648 ;; If going backward, don't accept the previous
3649 ;; allowable position if it is still after the target line.
3650 (<= (point) line-end))
1f980920
RS
3651 (setq new (point))
3652 ;; As a last resort, use the end of the line.
3653 (setq new line-end))))
af894fc9
RS
3654
3655 ;; Now move to the updated destination, processing fields
3656 ;; as well as intangibility.
3657 (goto-char opoint)
3658 (let ((inhibit-point-motion-hooks nil))
3659 (goto-char
3660 (constrain-to-field new opoint nil t
3661 'inhibit-line-move-field-capture)))
3662
1f980920 3663 ;; If all this moved us to a different line,
af894fc9
RS
3664 ;; retry everything within that new line.
3665 (when (or (< (point) line-beg) (> (point) line-end))
3666 ;; Repeat the intangibility and field processing.
3667 (setq repeat t))))))
3668
3669(defun line-move-to-column (col)
3670 "Try to find column COL, considering invisibility.
3671This function works only in certain cases,
3672because what we really need is for `move-to-column'
3673and `current-column' to be able to ignore invisible text."
a615252b
RS
3674 (if (zerop col)
3675 (beginning-of-line)
3676 (move-to-column col))
af894fc9
RS
3677
3678 (when (and line-move-ignore-invisible
bbf41690 3679 (not (bolp)) (line-move-invisible-p (1- (point))))
af894fc9
RS
3680 (let ((normal-location (point))
3681 (normal-column (current-column)))
3682 ;; If the following character is currently invisible,
3683 ;; skip all characters with that same `invisible' property value.
3684 (while (and (not (eobp))
bbf41690 3685 (line-move-invisible-p (point)))
af894fc9
RS
3686 (goto-char (next-char-property-change (point))))
3687 ;; Have we advanced to a larger column position?
3688 (if (> (current-column) normal-column)
3689 ;; We have made some progress towards the desired column.
3690 ;; See if we can make any further progress.
3691 (line-move-to-column (+ (current-column) (- col normal-column)))
3692 ;; Otherwise, go to the place we originally found
3693 ;; and move back over invisible text.
3694 ;; that will get us to the same place on the screen
3695 ;; but with a more reasonable buffer position.
3696 (goto-char normal-location)
3697 (let ((line-beg (save-excursion (beginning-of-line) (point))))
bbf41690 3698 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
af894fc9
RS
3699 (goto-char (previous-char-property-change (point) line-beg))))))))
3700
bbf41690 3701(defun move-end-of-line (arg)
f00239cf
RS
3702 "Move point to end of current line as displayed.
3703\(If there's an image in the line, this disregards newlines
3704which are part of the text that the image rests on.)
3705
bbf41690
RS
3706With argument ARG not nil or 1, move forward ARG - 1 lines first.
3707If point reaches the beginning or end of buffer, it stops there.
f00239cf 3708To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
bbf41690
RS
3709 (interactive "p")
3710 (or arg (setq arg 1))
3711 (let (done)
3712 (while (not done)
3713 (let ((newpos
3714 (save-excursion
3715 (let ((goal-column 0))
3716 (and (line-move arg t)
3717 (not (bobp))
3718 (progn
3719 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3720 (goto-char (previous-char-property-change (point))))
3721 (backward-char 1)))
3722 (point)))))
3723 (goto-char newpos)
3724 (if (and (> (point) newpos)
3725 (eq (preceding-char) ?\n))
3726 (backward-char 1)
3727 (if (and (> (point) newpos) (not (eobp))
3728 (not (eq (following-char) ?\n)))
3729 ;; If we skipped something intangible
3730 ;; and now we're not really at eol,
3731 ;; keep going.
3732 (setq arg 1)
3733 (setq done t)))))))
3734
0cbb497c 3735(defun move-beginning-of-line (arg)
f00239cf
RS
3736 "Move point to beginning of current line as displayed.
3737\(If there's an image in the line, this disregards newlines
3738which are part of the text that the image rests on.)
3739
0cbb497c
KS
3740With argument ARG not nil or 1, move forward ARG - 1 lines first.
3741If point reaches the beginning or end of buffer, it stops there.
f00239cf 3742To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
0cbb497c
KS
3743 (interactive "p")
3744 (or arg (setq arg 1))
2ef0a47e 3745
89767eec 3746 (let ((orig (point)))
1fffd65f
RS
3747
3748 ;; Move by lines, if ARG is not 1 (the default).
3749 (if (/= arg 1)
3750 (line-move (1- arg) t))
3751
3752 ;; Move to beginning-of-line, ignoring fields and invisibles.
3753 (skip-chars-backward "^\n")
3754 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
621a4cc8 3755 (goto-char (previous-char-property-change (point)))
1fffd65f
RS
3756 (skip-chars-backward "^\n"))
3757
3758 ;; Take care of fields.
3759 (goto-char (constrain-to-field (point) orig
3760 (/= arg 1) t nil))))
0cbb497c
KS
3761
3762
d5ab2033
JB
3763;;; Many people have said they rarely use this feature, and often type
3764;;; it by accident. Maybe it shouldn't even be on a key.
3765(put 'set-goal-column 'disabled t)
2076c87c
JB
3766
3767(defun set-goal-column (arg)
3768 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
3769Those commands will move to this position in the line moved to
3770rather than trying to keep the same horizontal position.
3771With a non-nil argument, clears out the goal column
912c6728
RS
3772so that \\[next-line] and \\[previous-line] resume vertical motion.
3773The goal column is stored in the variable `goal-column'."
2076c87c
JB
3774 (interactive "P")
3775 (if arg
3776 (progn
3777 (setq goal-column nil)
3778 (message "No goal column"))
3779 (setq goal-column (current-column))
8a26c165
DG
3780 ;; The older method below can be erroneous if `set-goal-column' is bound
3781 ;; to a sequence containing %
3782 ;;(message (substitute-command-keys
3783 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
3784 ;;goal-column)
3785 (message "%s"
63219d53 3786 (concat
8a26c165
DG
3787 (format "Goal column %d " goal-column)
3788 (substitute-command-keys
3789 "(use \\[set-goal-column] with an arg to unset it)")))
63219d53 3790
8a26c165 3791 )
2076c87c 3792 nil)
2d88b556 3793\f
7492f5a6
RS
3794
3795(defun scroll-other-window-down (lines)
e47d38f6
RS
3796 "Scroll the \"other window\" down.
3797For more details, see the documentation for `scroll-other-window'."
7492f5a6
RS
3798 (interactive "P")
3799 (scroll-other-window
3800 ;; Just invert the argument's meaning.
3801 ;; We can do that without knowing which window it will be.
3802 (if (eq lines '-) nil
3803 (if (null lines) '-
3804 (- (prefix-numeric-value lines))))))
3aef9604
RS
3805
3806(defun beginning-of-buffer-other-window (arg)
3807 "Move point to the beginning of the buffer in the other window.
3808Leave mark at previous position.
3809With arg N, put point N/10 of the way from the true beginning."
3810 (interactive "P")
3811 (let ((orig-window (selected-window))
3812 (window (other-window-for-scrolling)))
3813 ;; We use unwind-protect rather than save-window-excursion
3814 ;; because the latter would preserve the things we want to change.
3815 (unwind-protect
3816 (progn
3817 (select-window window)
3818 ;; Set point and mark in that window's buffer.
bbf41690
RS
3819 (with-no-warnings
3820 (beginning-of-buffer arg))
3aef9604
RS
3821 ;; Set point accordingly.
3822 (recenter '(t)))
3823 (select-window orig-window))))
3824
3825(defun end-of-buffer-other-window (arg)
3826 "Move point to the end of the buffer in the other window.
3827Leave mark at previous position.
3828With arg N, put point N/10 of the way from the true end."
3829 (interactive "P")
3830 ;; See beginning-of-buffer-other-window for comments.
3831 (let ((orig-window (selected-window))
3832 (window (other-window-for-scrolling)))
3833 (unwind-protect
3834 (progn
3835 (select-window window)
bbf41690
RS
3836 (with-no-warnings
3837 (end-of-buffer arg))
3aef9604
RS
3838 (recenter '(t)))
3839 (select-window orig-window))))
2d88b556 3840\f
2076c87c
JB
3841(defun transpose-chars (arg)
3842 "Interchange characters around point, moving forward one character.
3843With prefix arg ARG, effect is to take character before point
3844and drag it forward past ARG other characters (backward if ARG negative).
3845If no argument and at end of line, the previous two chars are exchanged."
3846 (interactive "*P")
3847 (and (null arg) (eolp) (forward-char -1))
3848 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3849
3850(defun transpose-words (arg)
3851 "Interchange words around point, leaving point at end of them.
3852With prefix arg ARG, effect is to take word before or around point
3853and drag it forward past ARG other words (backward if ARG negative).
3854If ARG is zero, the words around or after point and around or after mark
3855are interchanged."
41d22ee0 3856 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
2076c87c
JB
3857 (interactive "*p")
3858 (transpose-subr 'forward-word arg))
3859
3860(defun transpose-sexps (arg)
3861 "Like \\[transpose-words] but applies to sexps.
3862Does not work on a sexp that point is in the middle of
3863if it is a list or string."
3864 (interactive "*p")
41d22ee0
SM
3865 (transpose-subr
3866 (lambda (arg)
3867 ;; Here we should try to simulate the behavior of
3868 ;; (cons (progn (forward-sexp x) (point))
3869 ;; (progn (forward-sexp (- x)) (point)))
3870 ;; Except that we don't want to rely on the second forward-sexp
3871 ;; putting us back to where we want to be, since forward-sexp-function
3872 ;; might do funny things like infix-precedence.
3873 (if (if (> arg 0)
3874 (looking-at "\\sw\\|\\s_")
3875 (and (not (bobp))
3876 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
3877 ;; Jumping over a symbol. We might be inside it, mind you.
3878 (progn (funcall (if (> arg 0)
3879 'skip-syntax-backward 'skip-syntax-forward)
3880 "w_")
3881 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3882 ;; Otherwise, we're between sexps. Take a step back before jumping
3883 ;; to make sure we'll obey the same precedence no matter which direction
3884 ;; we're going.
3885 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3886 (cons (save-excursion (forward-sexp arg) (point))
3887 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3888 (not (zerop (funcall (if (> arg 0)
3889 'skip-syntax-forward
3890 'skip-syntax-backward)
3891 ".")))))
3892 (point)))))
3893 arg 'special))
2076c87c
JB
3894
3895(defun transpose-lines (arg)
3896 "Exchange current line and previous line, leaving point after both.
3897With argument ARG, takes previous line and moves it past ARG lines.
3898With argument 0, interchanges line point is in with line mark is in."
3899 (interactive "*p")
3900 (transpose-subr (function
3901 (lambda (arg)
d3f4ef3f 3902 (if (> arg 0)
2076c87c 3903 (progn
d3f4ef3f
AS
3904 ;; Move forward over ARG lines,
3905 ;; but create newlines if necessary.
3906 (setq arg (forward-line arg))
3907 (if (/= (preceding-char) ?\n)
3908 (setq arg (1+ arg)))
3909 (if (> arg 0)
3910 (newline arg)))
2076c87c
JB
3911 (forward-line arg))))
3912 arg))
3913
e1e04350
SM
3914(defun transpose-subr (mover arg &optional special)
3915 (let ((aux (if special mover
3916 (lambda (x)
3917 (cons (progn (funcall mover x) (point))
3918 (progn (funcall mover (- x)) (point))))))
3919 pos1 pos2)
3920 (cond
3921 ((= arg 0)
3922 (save-excursion
3923 (setq pos1 (funcall aux 1))
3924 (goto-char (mark))
3925 (setq pos2 (funcall aux 1))
3926 (transpose-subr-1 pos1 pos2))
3927 (exchange-point-and-mark))
3928 ((> arg 0)
3929 (setq pos1 (funcall aux -1))
3930 (setq pos2 (funcall aux arg))
3931 (transpose-subr-1 pos1 pos2)
3932 (goto-char (car pos2)))
3933 (t
3934 (setq pos1 (funcall aux -1))
3935 (goto-char (car pos1))
3936 (setq pos2 (funcall aux arg))
3937 (transpose-subr-1 pos1 pos2)))))
3938
3939(defun transpose-subr-1 (pos1 pos2)
3940 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3941 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3942 (when (> (car pos1) (car pos2))
3943 (let ((swap pos1))
3944 (setq pos1 pos2 pos2 swap)))
3945 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
dc7d7552
RS
3946 (atomic-change-group
3947 (let (word2)
1e96c007
SM
3948 ;; FIXME: We first delete the two pieces of text, so markers that
3949 ;; used to point to after the text end up pointing to before it :-(
dc7d7552
RS
3950 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3951 (goto-char (car pos2))
3952 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3953 (goto-char (car pos1))
3954 (insert word2))))
2d88b556 3955\f
b82d844f 3956(defun backward-word (&optional arg)
b7e91b0c 3957 "Move backward until encountering the beginning of a word.
20ecc110 3958With argument, do this that many times."
9e50756b 3959 (interactive "p")
b82d844f 3960 (forward-word (- (or arg 1))))
2076c87c 3961
a1a801de 3962(defun mark-word (&optional arg allow-extend)
705a5933
JL
3963 "Set mark ARG words away from point.
3964The place mark goes is the same place \\[forward-word] would
3965move to with the same argument.
a1a801de 3966Interactively, if this command is repeated
771069f8 3967or (in Transient Mark mode) if the mark is active,
705a5933 3968it marks the next ARG words after the ones already marked."
a1a801de
RS
3969 (interactive "P\np")
3970 (cond ((and allow-extend
3971 (or (and (eq last-command this-command) (mark t))
3972 (and transient-mark-mode mark-active)))
705a5933
JL
3973 (setq arg (if arg (prefix-numeric-value arg)
3974 (if (< (mark) (point)) -1 1)))
cad113ae
KG
3975 (set-mark
3976 (save-excursion
3977 (goto-char (mark))
3978 (forward-word arg)
3979 (point))))
3980 (t
3981 (push-mark
3982 (save-excursion
705a5933 3983 (forward-word (prefix-numeric-value arg))
cad113ae
KG
3984 (point))
3985 nil t))))
2076c87c
JB
3986
3987(defun kill-word (arg)
3988 "Kill characters forward until encountering the end of a word.
3989With argument, do this that many times."
e761e42c 3990 (interactive "p")
89ee2bf6 3991 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
3992
3993(defun backward-kill-word (arg)
3994 "Kill characters backward until encountering the end of a word.
3995With argument, do this that many times."
e761e42c 3996 (interactive "p")
2076c87c 3997 (kill-word (- arg)))
d7c64071 3998
0f7df535
RS
3999(defun current-word (&optional strict really-word)
4000 "Return the symbol or word that point is on (or a nearby one) as a string.
4001The return value includes no text properties.
1e8c5ac4 4002If optional arg STRICT is non-nil, return nil unless point is within
0fa19a57
RS
4003or adjacent to a symbol or word. In all cases the value can be nil
4004if there is no word nearby.
0f7df535
RS
4005The function, belying its name, normally finds a symbol.
4006If optional arg REALLY-WORD is non-nil, it finds just a word."
d7c64071 4007 (save-excursion
0f7df535 4008 (let* ((oldpoint (point)) (start (point)) (end (point))
81d17173 4009 (syntaxes (if really-word "w" "w_"))
0f7df535
RS
4010 (not-syntaxes (concat "^" syntaxes)))
4011 (skip-syntax-backward syntaxes) (setq start (point))
d7c64071 4012 (goto-char oldpoint)
0f7df535
RS
4013 (skip-syntax-forward syntaxes) (setq end (point))
4014 (when (and (eq start oldpoint) (eq end oldpoint)
4015 ;; Point is neither within nor adjacent to a word.
4016 (not strict))
4017 ;; Look for preceding word in same line.
4018 (skip-syntax-backward not-syntaxes
4019 (save-excursion (beginning-of-line)
4020 (point)))
4021 (if (bolp)
4022 ;; No preceding word in same line.
4023 ;; Look for following word in same line.
4024 (progn
4025 (skip-syntax-forward not-syntaxes
4026 (save-excursion (end-of-line)
4027 (point)))
4028 (setq start (point))
4029 (skip-syntax-forward syntaxes)
4030 (setq end (point)))
4031 (setq end (point))
4032 (skip-syntax-backward syntaxes)
4033 (setq start (point))))
4034 ;; If we found something nonempty, return it as a string.
4035 (unless (= start end)
020db25f 4036 (buffer-substring-no-properties start end)))))
2d88b556 4037\f
69c1dd37 4038(defcustom fill-prefix nil
e1e04350 4039 "*String for filling to insert at front of new line, or nil for none."
69c1dd37
RS
4040 :type '(choice (const :tag "None" nil)
4041 string)
4042 :group 'fill)
2076c87c
JB
4043(make-variable-buffer-local 'fill-prefix)
4044
69c1dd37
RS
4045(defcustom auto-fill-inhibit-regexp nil
4046 "*Regexp to match lines which should not be auto-filled."
4047 :type '(choice (const :tag "None" nil)
4048 regexp)
4049 :group 'fill)
2076c87c 4050
58dd38f1 4051(defvar comment-line-break-function 'comment-indent-new-line
b3ac9fa9
RS
4052 "*Mode-specific function which line breaks and continues a comment.
4053
4054This function is only called during auto-filling of a comment section.
4055The function should take a single optional argument, which is a flag
cc4cb0f5 4056indicating whether it should use soft newlines.")
b3ac9fa9 4057
dbe524b6 4058;; This function is used as the auto-fill-function of a buffer
e2504204
KH
4059;; when Auto-Fill mode is enabled.
4060;; It returns t if it really did any work.
dbe524b6
RS
4061;; (Actually some major modes use a different auto-fill function,
4062;; but this one is the default one.)
2076c87c 4063(defun do-auto-fill ()
621a3f62 4064 (let (fc justify give-up
a0170800 4065 (fill-prefix fill-prefix))
c18465c4 4066 (if (or (not (setq justify (current-justification)))
8f066a20
RS
4067 (null (setq fc (current-fill-column)))
4068 (and (eq justify 'left)
4069 (<= (current-column) fc))
621a3f62
SM
4070 (and auto-fill-inhibit-regexp
4071 (save-excursion (beginning-of-line)
eed5698b
RS
4072 (looking-at auto-fill-inhibit-regexp))))
4073 nil ;; Auto-filling not required
3db1e3b5
BG
4074 (if (memq justify '(full center right))
4075 (save-excursion (unjustify-current-line)))
a0170800
RS
4076
4077 ;; Choose a fill-prefix automatically.
e1e04350
SM
4078 (when (and adaptive-fill-mode
4079 (or (null fill-prefix) (string= fill-prefix "")))
4080 (let ((prefix
4081 (fill-context-prefix
4082 (save-excursion (backward-paragraph 1) (point))
4083 (save-excursion (forward-paragraph 1) (point)))))
4084 (and prefix (not (equal prefix ""))
4085 ;; Use auto-indentation rather than a guessed empty prefix.
0e53a373 4086 (not (and fill-indent-according-to-mode
d99f8496 4087 (string-match "\\`[ \t]*\\'" prefix)))
e1e04350 4088 (setq fill-prefix prefix))))
f1180544 4089
eed5698b 4090 (while (and (not give-up) (> (current-column) fc))
e47d38f6 4091 ;; Determine where to split the line.
db893d00
RS
4092 (let* (after-prefix
4093 (fill-point
621a3f62
SM
4094 (save-excursion
4095 (beginning-of-line)
4096 (setq after-prefix (point))
4097 (and fill-prefix
4098 (looking-at (regexp-quote fill-prefix))
4099 (setq after-prefix (match-end 0)))
4100 (move-to-column (1+ fc))
4101 (fill-move-to-break-point after-prefix)
4102 (point))))
db893d00
RS
4103
4104 ;; See whether the place we found is any good.
e47d38f6
RS
4105 (if (save-excursion
4106 (goto-char fill-point)
41d22ee0
SM
4107 (or (bolp)
4108 ;; There is no use breaking at end of line.
4109 (save-excursion (skip-chars-forward " ") (eolp))
4110 ;; It is futile to split at the end of the prefix
4111 ;; since we would just insert the prefix again.
4112 (and after-prefix (<= (point) after-prefix))
4113 ;; Don't split right after a comment starter
4114 ;; since we would just make another comment starter.
4115 (and comment-start-skip
4116 (let ((limit (point)))
4117 (beginning-of-line)
4118 (and (re-search-forward comment-start-skip
4119 limit t)
4120 (eq (point) limit))))))
4121 ;; No good place to break => stop trying.
4122 (setq give-up t)
4123 ;; Ok, we have a useful place to break the line. Do it.
4124 (let ((prev-column (current-column)))
4125 ;; If point is at the fill-point, do not `save-excursion'.
4126 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4127 ;; point will end up before it rather than after it.
4128 (if (save-excursion
4129 (skip-chars-backward " \t")
4130 (= (point) fill-point))
4131 (funcall comment-line-break-function t)
4132 (save-excursion
4133 (goto-char fill-point)
4134 (funcall comment-line-break-function t)))
4135 ;; Now do justification, if required
4136 (if (not (eq justify 'left))
e47d38f6 4137 (save-excursion
e1e04350
SM
4138 (end-of-line 0)
4139 (justify-current-line justify nil t)))
41d22ee0
SM
4140 ;; If making the new line didn't reduce the hpos of
4141 ;; the end of the line, then give up now;
4142 ;; trying again will not help.
4143 (if (>= (current-column) prev-column)
4144 (setq give-up t))))))
24ebf92e 4145 ;; Justify last line.
e2504204 4146 (justify-current-line justify t t)
1e722f9f 4147 t)))
2076c87c 4148
24ebf92e
RS
4149(defvar normal-auto-fill-function 'do-auto-fill
4150 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4151Some major modes set this.")
4152
c75505b4 4153(put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
d99f8496
SM
4154;; FIXME: turn into a proper minor mode.
4155;; Add a global minor mode version of it.
d7465b15 4156(defun auto-fill-mode (&optional arg)
24ebf92e
RS
4157 "Toggle Auto Fill mode.
4158With arg, turn Auto Fill mode on if and only if arg is positive.
4159In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4160automatically breaks the line at a previous space.
4161
4162The value of `normal-auto-fill-function' specifies the function to use
4163for `auto-fill-function' when turning Auto Fill mode on."
d7465b15
RS
4164 (interactive "P")
4165 (prog1 (setq auto-fill-function
4166 (if (if (null arg)
4167 (not auto-fill-function)
4168 (> (prefix-numeric-value arg) 0))
24ebf92e 4169 normal-auto-fill-function
d7465b15 4170 nil))
7911ecc8 4171 (force-mode-line-update)))
d7465b15
RS
4172
4173;; This holds a document string used to document auto-fill-mode.
4174(defun auto-fill-function ()
4175 "Automatically break line at a previous space, in insertion of text."
4176 nil)
4177
4178(defun turn-on-auto-fill ()
4179 "Unconditionally turn on Auto Fill mode."
4180 (auto-fill-mode 1))
3a99c819
GM
4181
4182(defun turn-off-auto-fill ()
4183 "Unconditionally turn off Auto Fill mode."
4184 (auto-fill-mode -1))
4185
7cbf1dc1 4186(custom-add-option 'text-mode-hook 'turn-on-auto-fill)
d7465b15
RS
4187
4188(defun set-fill-column (arg)
4cc0ea11 4189 "Set `fill-column' to specified argument.
923efb99 4190Use \\[universal-argument] followed by a number to specify a column.
4cc0ea11 4191Just \\[universal-argument] as argument means to use the current column."
d7465b15 4192 (interactive "P")
f4520363
RS
4193 (if (consp arg)
4194 (setq arg (current-column)))
4195 (if (not (integerp arg))
4196 ;; Disallow missing argument; it's probably a typo for C-x C-f.
f33321ad 4197 (error "set-fill-column requires an explicit argument")
f4520363
RS
4198 (message "Fill column set to %d (was %d)" arg fill-column)
4199 (setq fill-column arg)))
2d88b556 4200\f
2076c87c 4201(defun set-selective-display (arg)
ff1fbe3e
RS
4202 "Set `selective-display' to ARG; clear it if no arg.
4203When the value of `selective-display' is a number > 0,
4204lines whose indentation is >= that value are not displayed.
4205The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
4206 (interactive "P")
4207 (if (eq selective-display t)
4208 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
4209 (let ((current-vpos
4210 (save-restriction
4211 (narrow-to-region (point-min) (point))
4212 (goto-char (window-start))
4213 (vertical-motion (window-height)))))
4214 (setq selective-display
4215 (and arg (prefix-numeric-value arg)))
4216 (recenter current-vpos))
2076c87c
JB
4217 (set-window-start (selected-window) (window-start (selected-window)))
4218 (princ "selective-display set to " t)
4219 (prin1 selective-display t)
4220 (princ "." t))
4221
40a64816
RS
4222(defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4223(defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4224
0bb64d76
PA
4225(defun toggle-truncate-lines (arg)
4226 "Toggle whether to fold or truncate long lines on the screen.
46cdfe8f
RS
4227With arg, truncate long lines iff arg is positive.
4228Note that in side-by-side windows, truncation is always enabled."
0bb64d76
PA
4229 (interactive "P")
4230 (setq truncate-lines
4231 (if (null arg)
4232 (not truncate-lines)
46cdfe8f
RS
4233 (> (prefix-numeric-value arg) 0)))
4234 (force-mode-line-update)
4f017185
RS
4235 (unless truncate-lines
4236 (let ((buffer (current-buffer)))
4237 (walk-windows (lambda (window)
4238 (if (eq buffer (window-buffer window))
4239 (set-window-hscroll window 0)))
4240 nil t)))
46cdfe8f
RS
4241 (message "Truncate long lines %s"
4242 (if truncate-lines "enabled" "disabled")))
0bb64d76 4243
4f8f7f9f 4244(defvar overwrite-mode-textual " Ovwrt"
b6a22db0 4245 "The string displayed in the mode line when in overwrite mode.")
4f8f7f9f 4246(defvar overwrite-mode-binary " Bin Ovwrt"
b6a22db0
JB
4247 "The string displayed in the mode line when in binary overwrite mode.")
4248
2076c87c
JB
4249(defun overwrite-mode (arg)
4250 "Toggle overwrite mode.
4251With arg, turn overwrite mode on iff arg is positive.
4252In overwrite mode, printing characters typed in replace existing text
b6a22db0
JB
4253on a one-for-one basis, rather than pushing it to the right. At the
4254end of a line, such characters extend the line. Before a tab,
4255such characters insert until the tab is filled in.
4256\\[quoted-insert] still inserts characters in overwrite mode; this
4257is supposed to make it easier to insert characters when necessary."
4258 (interactive "P")
4259 (setq overwrite-mode
4260 (if (if (null arg) (not overwrite-mode)
4261 (> (prefix-numeric-value arg) 0))
4262 'overwrite-mode-textual))
4263 (force-mode-line-update))
4264
4265(defun binary-overwrite-mode (arg)
4266 "Toggle binary overwrite mode.
4267With arg, turn binary overwrite mode on iff arg is positive.
4268In binary overwrite mode, printing characters typed in replace
4269existing text. Newlines are not treated specially, so typing at the
4270end of a line joins the line to the next, with the typed character
4271between them. Typing before a tab character simply replaces the tab
4272with the character typed.
4273\\[quoted-insert] replaces the text at the cursor, just as ordinary
4274typing characters do.
4275
4276Note that binary overwrite mode is not its own minor mode; it is a
f33321ad 4277specialization of overwrite mode, entered by setting the
b6a22db0 4278`overwrite-mode' variable to `overwrite-mode-binary'."
2076c87c
JB
4279 (interactive "P")
4280 (setq overwrite-mode
b6a22db0 4281 (if (if (null arg)
a61099dd 4282 (not (eq overwrite-mode 'overwrite-mode-binary))
b6a22db0
JB
4283 (> (prefix-numeric-value arg) 0))
4284 'overwrite-mode-binary))
4285 (force-mode-line-update))
eaae8106 4286
6710df48 4287(define-minor-mode line-number-mode
a61099dd
RS
4288 "Toggle Line Number mode.
4289With arg, turn Line Number mode on iff arg is positive.
4290When Line Number mode is enabled, the line number appears
8dc9e2ef
KH
4291in the mode line.
4292
32f2f98e
EZ
4293Line numbers do not appear for very large buffers and buffers
4294with very long lines; see variables `line-number-display-limit'
4295and `line-number-display-limit-width'."
dfd8ca69 4296 :init-value t :global t :group 'editing-basics)
bcad4985 4297
6710df48 4298(define-minor-mode column-number-mode
bcad4985
KH
4299 "Toggle Column Number mode.
4300With arg, turn Column Number mode on iff arg is positive.
4301When Column Number mode is enabled, the column number appears
4302in the mode line."
dfd8ca69 4303 :global t :group 'editing-basics)
cf045f9a
LK
4304
4305(define-minor-mode size-indication-mode
4306 "Toggle Size Indication mode.
4307With arg, turn Size Indication mode on iff arg is positive. When
4308Size Indication mode is enabled, the size of the accessible part
4309of the buffer appears in the mode line."
dfd8ca69 4310 :global t :group 'editing-basics)
2d88b556 4311\f
4b384a8f 4312(defgroup paren-blinking nil
020db25f 4313 "Blinking matching of parens and expressions."
4b384a8f
SM
4314 :prefix "blink-matching-"
4315 :group 'paren-matching)
4316
69c1dd37
RS
4317(defcustom blink-matching-paren t
4318 "*Non-nil means show matching open-paren when close-paren is inserted."
4319 :type 'boolean
4b384a8f 4320 :group 'paren-blinking)
2076c87c 4321
69c1dd37 4322(defcustom blink-matching-paren-on-screen t
29fc44dd 4323 "*Non-nil means show matching open-paren when it is on screen.
4b384a8f 4324If nil, means don't show it (but the open-paren can still be shown
92aa8a33
LT
4325when it is off screen).
4326
9cb370a9 4327This variable has no effect if `blink-matching-paren' is nil.
a9f72e5f 4328\(In that case, the open-paren is never shown.)
9cb370a9 4329It is also ignored if `show-paren-mode' is enabled."
69c1dd37 4330 :type 'boolean
4b384a8f 4331 :group 'paren-blinking)
29fc44dd 4332
4b384a8f 4333(defcustom blink-matching-paren-distance (* 25 1024)
66d44a36
EZ
4334 "*If non-nil, maximum distance to search backwards for matching open-paren.
4335If nil, search stops at the beginning of the accessible portion of the buffer."
4336 :type '(choice (const nil) integer)
4b384a8f 4337 :group 'paren-blinking)
2076c87c 4338
69c1dd37 4339(defcustom blink-matching-delay 1
4b384a8f
SM
4340 "*Time in seconds to delay after showing a matching paren."
4341 :type 'number
4342 :group 'paren-blinking)
72dddf8b 4343
69c1dd37 4344(defcustom blink-matching-paren-dont-ignore-comments nil
ab6b3b16
RS
4345 "*nil means `blink-matching-paren' ignores comments.
4346More precisely, when looking for the matching parenthesis,
4347it skips the contents of comments that end before point."
69c1dd37 4348 :type 'boolean
4b384a8f 4349 :group 'paren-blinking)
903b7f65 4350
2076c87c
JB
4351(defun blink-matching-open ()
4352 "Move cursor momentarily to the beginning of the sexp before point."
4353 (interactive)
c448d316 4354 (when (and (> (point) (point-min))
1d0e3fc8
RS
4355 blink-matching-paren
4356 ;; Verify an even number of quoting characters precede the close.
4357 (= 1 (logand 1 (- (point)
4358 (save-excursion
4359 (forward-char -1)
4360 (skip-syntax-backward "/\\")
4361 (point))))))
4362 (let* ((oldpos (point))
4363 blinkpos
4364 message-log-max ; Don't log messages about paren matching.
4365 matching-paren
4366 open-paren-line-string)
4367 (save-excursion
4368 (save-restriction
4369 (if blink-matching-paren-distance
4370 (narrow-to-region (max (point-min)
4371 (- (point) blink-matching-paren-distance))
4372 oldpos))
4373 (condition-case ()
4374 (let ((parse-sexp-ignore-comments
4375 (and parse-sexp-ignore-comments
4376 (not blink-matching-paren-dont-ignore-comments))))
4377 (setq blinkpos (scan-sexps oldpos -1)))
4378 (error nil)))
4379 (and blinkpos
4380 ;; Not syntax '$'.
4381 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4382 (setq matching-paren
4383 (let ((syntax (syntax-after blinkpos)))
4384 (and (consp syntax)
4385 (eq (syntax-class syntax) 4)
4386 (cdr syntax)))))
4387 (cond
1c4b7278
SM
4388 ((not (or (eq matching-paren (char-before oldpos))
4389 ;; The cdr might hold a new paren-class info rather than
4390 ;; a matching-char info, in which case the two CDRs
4391 ;; should match.
9c03d478 4392 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
1d0e3fc8
RS
4393 (message "Mismatched parentheses"))
4394 ((not blinkpos)
4395 (if (not blink-matching-paren-distance)
4396 (message "Unmatched parenthesis")))
4397 ((pos-visible-in-window-p blinkpos)
4398 ;; Matching open within window, temporarily move to blinkpos but only
4399 ;; if `blink-matching-paren-on-screen' is non-nil.
92aa8a33
LT
4400 (and blink-matching-paren-on-screen
4401 (not show-paren-mode)
4402 (save-excursion
4403 (goto-char blinkpos)
4404 (sit-for blink-matching-delay))))
1d0e3fc8
RS
4405 (t
4406 (save-excursion
4407 (goto-char blinkpos)
4408 (setq open-paren-line-string
4409 ;; Show what precedes the open in its line, if anything.
4410 (if (save-excursion
4411 (skip-chars-backward " \t")
4412 (not (bolp)))
4413 (buffer-substring (line-beginning-position)
4414 (1+ blinkpos))
4415 ;; Show what follows the open in its line, if anything.
4416 (if (save-excursion
4417 (forward-char 1)
4418 (skip-chars-forward " \t")
4419 (not (eolp)))
4420 (buffer-substring blinkpos
4421 (line-end-position))
4422 ;; Otherwise show the previous nonblank line,
4423 ;; if there is one.
4424 (if (save-excursion
4425 (skip-chars-backward "\n \t")
4426 (not (bobp)))
4427 (concat
4428 (buffer-substring (progn
267935b9 4429 (skip-chars-backward "\n \t")
1d0e3fc8
RS
4430 (line-beginning-position))
4431 (progn (end-of-line)
4432 (skip-chars-backward " \t")
4433 (point)))
4434 ;; Replace the newline and other whitespace with `...'.
4435 "..."
4436 (buffer-substring blinkpos (1+ blinkpos)))
4437 ;; There is nothing to show except the char itself.
4438 (buffer-substring blinkpos (1+ blinkpos)))))))
4439 (message "Matches %s"
4440 (substring-no-properties open-paren-line-string))))))))
2076c87c
JB
4441
4442;Turned off because it makes dbx bomb out.
4443(setq blink-paren-function 'blink-matching-open)
2d88b556 4444\f
9a1277dd
RS
4445;; This executes C-g typed while Emacs is waiting for a command.
4446;; Quitting out of a program does not go through here;
4447;; that happens in the QUIT macro at the C code level.
2076c87c 4448(defun keyboard-quit ()
d5dae4e1 4449 "Signal a `quit' condition.
af39530e
RS
4450During execution of Lisp code, this character causes a quit directly.
4451At top-level, as an editor command, this simply beeps."
2076c87c 4452 (interactive)
19d35374 4453 (deactivate-mark)
8a7644e9
KS
4454 (if (fboundp 'kmacro-keyboard-quit)
4455 (kmacro-keyboard-quit))
f5e13057 4456 (setq defining-kbd-macro nil)
2076c87c
JB
4457 (signal 'quit nil))
4458
1c6c6fde
RS
4459(defvar buffer-quit-function nil
4460 "Function to call to \"quit\" the current buffer, or nil if none.
4461\\[keyboard-escape-quit] calls this function when its more local actions
4462\(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4463
c66587fe
RS
4464(defun keyboard-escape-quit ()
4465 "Exit the current \"mode\" (in a generalized sense of the word).
4466This command can exit an interactive command such as `query-replace',
4467can clear out a prefix argument or a region,
4468can get out of the minibuffer or other recursive edit,
1c6c6fde
RS
4469cancel the use of the current buffer (for special-purpose buffers),
4470or go back to just one window (by deleting all but the selected window)."
c66587fe
RS
4471 (interactive)
4472 (cond ((eq last-command 'mode-exited) nil)
4473 ((> (minibuffer-depth) 0)
4474 (abort-recursive-edit))
4475 (current-prefix-arg
4476 nil)
705a5933 4477 ((and transient-mark-mode mark-active)
c66587fe 4478 (deactivate-mark))
1b657835
RS
4479 ((> (recursion-depth) 0)
4480 (exit-recursive-edit))
1c6c6fde
RS
4481 (buffer-quit-function
4482 (funcall buffer-quit-function))
c66587fe 4483 ((not (one-window-p t))
1b657835
RS
4484 (delete-other-windows))
4485 ((string-match "^ \\*" (buffer-name (current-buffer)))
4486 (bury-buffer))))
c66587fe 4487
2d88b556
RS
4488(defun play-sound-file (file &optional volume device)
4489 "Play sound stored in FILE.
4490VOLUME and DEVICE correspond to the keywords of the sound
4491specification for `play-sound'."
4492 (interactive "fPlay sound file: ")
4493 (let ((sound (list :file file)))
4494 (if volume
4495 (plist-put sound :volume volume))
4496 (if device
4497 (plist-put sound :device device))
4498 (push 'sound sound)
4499 (play-sound sound)))
4500
56abefac 4501\f
7683b5c2
DL
4502(defcustom read-mail-command 'rmail
4503 "*Your preference for a mail reading package.
9023837e
DL
4504This is used by some keybindings which support reading mail.
4505See also `mail-user-agent' concerning sending mail."
7683b5c2
DL
4506 :type '(choice (function-item rmail)
4507 (function-item gnus)
4508 (function-item mh-rmail)
4509 (function :tag "Other"))
4510 :version "21.1"
4511 :group 'mail)
4512
69c1dd37 4513(defcustom mail-user-agent 'sendmail-user-agent
a31ca314 4514 "*Your preference for a mail composition package.
9023837e 4515Various Emacs Lisp packages (e.g. Reporter) require you to compose an
a31ca314
RS
4516outgoing email message. This variable lets you specify which
4517mail-sending package you prefer.
4518
4519Valid values include:
4520
9023837e
DL
4521 `sendmail-user-agent' -- use the default Emacs Mail package.
4522 See Info node `(emacs)Sending Mail'.
4523 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4524 See Info node `(mh-e)'.
4525 `message-user-agent' -- use the Gnus Message package.
4526 See Info node `(message)'.
4527 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4528 paraphernalia, particularly the Gcc: header for
4529 archiving.
a31ca314
RS
4530
4531Additional valid symbols may be available; check with the author of
15d0c9b1
DL
4532your package for details. The function should return non-nil if it
4533succeeds.
9023837e
DL
4534
4535See also `read-mail-command' concerning reading mail."
69c1dd37
RS
4536 :type '(radio (function-item :tag "Default Emacs mail"
4537 :format "%t\n"
4538 sendmail-user-agent)
4539 (function-item :tag "Emacs interface to MH"
4540 :format "%t\n"
4541 mh-e-user-agent)
9023837e 4542 (function-item :tag "Gnus Message package"
69c1dd37
RS
4543 :format "%t\n"
4544 message-user-agent)
9023837e
DL
4545 (function-item :tag "Gnus Message with full Gnus features"
4546 :format "%t\n"
4547 gnus-user-agent)
69c1dd37
RS
4548 (function :tag "Other"))
4549 :group 'mail)
a31ca314 4550
a31ca314 4551(define-mail-user-agent 'sendmail-user-agent
34fbcdf3 4552 'sendmail-user-agent-compose
a31ca314
RS
4553 'mail-send-and-exit)
4554
360b5483
RS
4555(defun rfc822-goto-eoh ()
4556 ;; Go to header delimiter line in a mail message, following RFC822 rules
4557 (goto-char (point-min))
e1e04350
SM
4558 (when (re-search-forward
4559 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
4560 (goto-char (match-beginning 0))))
360b5483 4561
34fbcdf3
RS
4562(defun sendmail-user-agent-compose (&optional to subject other-headers continue
4563 switch-function yank-action
4564 send-actions)
4565 (if switch-function
4566 (let ((special-display-buffer-names nil)
4567 (special-display-regexps nil)
4568 (same-window-buffer-names nil)
4569 (same-window-regexps nil))
4570 (funcall switch-function "*mail*")))
9462bf2c
RS
4571 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4572 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4573 (body (cdr (assoc-string "body" other-headers t))))
a9267c2c
CY
4574 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4575 continue
4576 (error "Message aborted"))
34fbcdf3 4577 (save-excursion
360b5483 4578 (rfc822-goto-eoh)
34fbcdf3 4579 (while other-headers
0740c738
GM
4580 (unless (member-ignore-case (car (car other-headers))
4581 '("in-reply-to" "cc" "body"))
34fbcdf3 4582 (insert (car (car other-headers)) ": "
15575807
CY
4583 (cdr (car other-headers))
4584 (if use-hard-newlines hard-newline "\n")))
34fbcdf3 4585 (setq other-headers (cdr other-headers)))
0740c738
GM
4586 (when body
4587 (forward-line 1)
4588 (insert body))
34fbcdf3
RS
4589 t)))
4590
d0008a00
RS
4591(defun compose-mail (&optional to subject other-headers continue
4592 switch-function yank-action send-actions)
4593 "Start composing a mail message to send.
4594This uses the user's chosen mail composition package
4595as selected with the variable `mail-user-agent'.
4596The optional arguments TO and SUBJECT specify recipients
4597and the initial Subject field, respectively.
4598
4599OTHER-HEADERS is an alist specifying additional
4600header fields. Elements look like (HEADER . VALUE) where both
4601HEADER and VALUE are strings.
4602
4603CONTINUE, if non-nil, says to continue editing a message already
4604being composed.
4605
4606SWITCH-FUNCTION, if non-nil, is a function to use to
4607switch to and display the buffer used for mail composition.
4608
4609YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
06720de2
RS
4610to insert the raw text of the message being replied to.
4611It has the form (FUNCTION . ARGS). The user agent will apply
4612FUNCTION to ARGS, to insert the raw text of the original message.
4613\(The user agent will also run `mail-citation-hook', *after* the
4614original text has been inserted in this way.)
d0008a00
RS
4615
4616SEND-ACTIONS is a list of actions to call when the message is sent.
4617Each action has the form (FUNCTION . ARGS)."
b5f019be
RS
4618 (interactive
4619 (list nil nil nil current-prefix-arg))
d0008a00
RS
4620 (let ((function (get mail-user-agent 'composefunc)))
4621 (funcall function to subject other-headers continue
4622 switch-function yank-action send-actions)))
b5f019be
RS
4623
4624(defun compose-mail-other-window (&optional to subject other-headers continue
4625 yank-action send-actions)
4626 "Like \\[compose-mail], but edit the outgoing message in another window."
4627 (interactive
4628 (list nil nil nil current-prefix-arg))
4629 (compose-mail to subject other-headers continue
4630 'switch-to-buffer-other-window yank-action send-actions))
4631
4632
4633(defun compose-mail-other-frame (&optional to subject other-headers continue
4634 yank-action send-actions)
4635 "Like \\[compose-mail], but edit the outgoing message in another frame."
4636 (interactive
4637 (list nil nil nil current-prefix-arg))
4638 (compose-mail to subject other-headers continue
4639 'switch-to-buffer-other-frame yank-action send-actions))
56abefac 4640\f
610c1c68
RS
4641(defvar set-variable-value-history nil
4642 "History of values entered with `set-variable'.")
4643
d6281b4e 4644(defun set-variable (variable value &optional make-local)
610c1c68 4645 "Set VARIABLE to VALUE. VALUE is a Lisp object.
d6281b4e
RS
4646VARIABLE should be a user option variable name, a Lisp variable
4647meant to be customized by users. You should enter VALUE in Lisp syntax,
4648so if you want VALUE to be a string, you must surround it with doublequotes.
610c1c68
RS
4649VALUE is used literally, not evaluated.
4650
4651If VARIABLE has a `variable-interactive' property, that is used as if
4652it were the arg to `interactive' (which see) to interactively read VALUE.
4653
4654If VARIABLE has been defined with `defcustom', then the type information
16236388
RS
4655in the definition is used to check that VALUE is valid.
4656
4657With a prefix argument, set VARIABLE to VALUE buffer-locally."
e9dfb72e
RS
4658 (interactive
4659 (let* ((default-var (variable-at-point))
7fd0ef0d
JL
4660 (var (if (user-variable-p default-var)
4661 (read-variable (format "Set variable (default %s): " default-var)
4662 default-var)
4663 (read-variable "Set variable: ")))
7dcd2d16
AS
4664 (minibuffer-help-form '(describe-variable var))
4665 (prop (get var 'variable-interactive))
0684376b
JB
4666 (obsolete (car (get var 'byte-obsolete-variable)))
4667 (prompt (format "Set %s %s to value: " var
7dcd2d16 4668 (cond ((local-variable-p var)
0684376b 4669 "(buffer-local)")
7dcd2d16
AS
4670 ((or current-prefix-arg
4671 (local-variable-if-set-p var))
0684376b
JB
4672 "buffer-locally")
4673 (t "globally"))))
4674 (val (progn
4675 (when obsolete
4676 (message (concat "`%S' is obsolete; "
4677 (if (symbolp obsolete) "use `%S' instead" "%s"))
4678 var obsolete)
4679 (sit-for 3))
4680 (if prop
4681 ;; Use VAR's `variable-interactive' property
4682 ;; as an interactive spec for prompting.
4683 (call-interactively `(lambda (arg)
4684 (interactive ,prop)
4685 arg))
4686 (read
4687 (read-string prompt nil
7fd0ef0d
JL
4688 'set-variable-value-history
4689 (format "%S" (symbol-value var))))))))
7dcd2d16 4690 (list var val current-prefix-arg)))
610c1c68 4691
d6281b4e
RS
4692 (and (custom-variable-p variable)
4693 (not (get variable 'custom-type))
4694 (custom-load-symbol variable))
4695 (let ((type (get variable 'custom-type)))
610c1c68
RS
4696 (when type
4697 ;; Match with custom type.
36755dd9 4698 (require 'cus-edit)
610c1c68 4699 (setq type (widget-convert type))
d6281b4e 4700 (unless (widget-apply type :match value)
1e722f9f 4701 (error "Value `%S' does not match type %S of %S"
d6281b4e 4702 value (car type) variable))))
16236388
RS
4703
4704 (if make-local
d6281b4e 4705 (make-local-variable variable))
f1180544 4706
d6281b4e 4707 (set variable value)
a2aef080
GM
4708
4709 ;; Force a thorough redisplay for the case that the variable
4710 ;; has an effect on the display, like `tab-width' has.
4711 (force-mode-line-update))
56abefac 4712\f
e8a700bf
RS
4713;; Define the major mode for lists of completions.
4714
98b45886
RS
4715(defvar completion-list-mode-map nil
4716 "Local map for completion list buffers.")
ac29eb79 4717(or completion-list-mode-map
e8a700bf
RS
4718 (let ((map (make-sparse-keymap)))
4719 (define-key map [mouse-2] 'mouse-choose-completion)
771069f8 4720 (define-key map [follow-link] 'mouse-face)
eaf76065 4721 (define-key map [down-mouse-2] nil)
80298193 4722 (define-key map "\C-m" 'choose-completion)
1c6c6fde 4723 (define-key map "\e\e\e" 'delete-completion-window)
dde69dbe
RS
4724 (define-key map [left] 'previous-completion)
4725 (define-key map [right] 'next-completion)
ac29eb79 4726 (setq completion-list-mode-map map)))
e8a700bf
RS
4727
4728;; Completion mode is suitable only for specially formatted data.
ac29eb79 4729(put 'completion-list-mode 'mode-class 'special)
e8a700bf 4730
98b45886
RS
4731(defvar completion-reference-buffer nil
4732 "Record the buffer that was current when the completion list was requested.
4733This is a local variable in the completion list buffer.
ec39964e 4734Initial value is nil to avoid some compiler warnings.")
3819736b 4735
83434bda
RS
4736(defvar completion-no-auto-exit nil
4737 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4738This also applies to other functions such as `choose-completion'
4739and `mouse-choose-completion'.")
4740
98b45886
RS
4741(defvar completion-base-size nil
4742 "Number of chars at beginning of minibuffer not involved in completion.
4743This is a local variable in the completion list buffer
4744but it talks about the buffer in `completion-reference-buffer'.
4745If this is nil, it means to compare text to determine which part
4746of the tail end of the buffer's text is involved in completion.")
f6b293e3 4747
1c6c6fde
RS
4748(defun delete-completion-window ()
4749 "Delete the completion list window.
4750Go to the window from which completion was requested."
4751 (interactive)
4752 (let ((buf completion-reference-buffer))
ddb2b181
RS
4753 (if (one-window-p t)
4754 (if (window-dedicated-p (selected-window))
4755 (delete-frame (selected-frame)))
4756 (delete-window (selected-window))
4757 (if (get-buffer-window buf)
4758 (select-window (get-buffer-window buf))))))
1c6c6fde 4759
dde69dbe
RS
4760(defun previous-completion (n)
4761 "Move to the previous item in the completion list."
4762 (interactive "p")
4763 (next-completion (- n)))
4764
4765(defun next-completion (n)
4766 "Move to the next item in the completion list.
1f238ac2 4767With prefix argument N, move N items (negative N means move backward)."
dde69dbe 4768 (interactive "p")
58dd38f1
SM
4769 (let ((beg (point-min)) (end (point-max)))
4770 (while (and (> n 0) (not (eobp)))
dde69dbe 4771 ;; If in a completion, move to the end of it.
58dd38f1
SM
4772 (when (get-text-property (point) 'mouse-face)
4773 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe 4774 ;; Move to start of next one.
58dd38f1
SM
4775 (unless (get-text-property (point) 'mouse-face)
4776 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4777 (setq n (1- n)))
4778 (while (and (< n 0) (not (bobp)))
4779 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4780 ;; If in a completion, move to the start of it.
4781 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
b61a81c2 4782 (goto-char (previous-single-property-change
58dd38f1
SM
4783 (point) 'mouse-face nil beg)))
4784 ;; Move to end of the previous completion.
4785 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4786 (goto-char (previous-single-property-change
4787 (point) 'mouse-face nil beg)))
4788 ;; Move to the start of that one.
4789 (goto-char (previous-single-property-change
4790 (point) 'mouse-face nil beg))
4791 (setq n (1+ n))))))
dde69dbe 4792
80298193
RS
4793(defun choose-completion ()
4794 "Choose the completion that point is in or next to."
4795 (interactive)
f6b293e3
RS
4796 (let (beg end completion (buffer completion-reference-buffer)
4797 (base-size completion-base-size))
6096f362
RS
4798 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4799 (setq end (point) beg (1+ (point))))
4800 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3f299281 4801 (setq end (1- (point)) beg (point)))
6096f362
RS
4802 (if (null beg)
4803 (error "No completion here"))
4804 (setq beg (previous-single-property-change beg 'mouse-face))
88dd3c24 4805 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
6cdd0211 4806 (setq completion (buffer-substring-no-properties beg end))
ab63960f
RS
4807 (let ((owindow (selected-window)))
4808 (if (and (one-window-p t 'selected-frame)
4809 (window-dedicated-p (selected-window)))
4810 ;; This is a special buffer's frame
4811 (iconify-frame (selected-frame))
4812 (or (window-dedicated-p (selected-window))
4813 (bury-buffer)))
4814 (select-window owindow))
f6b293e3 4815 (choose-completion-string completion buffer base-size)))
80298193
RS
4816
4817;; Delete the longest partial match for STRING
4818;; that can be found before POINT.
4819(defun choose-completion-delete-max-match (string)
4820 (let ((opoint (point))
f0bfada7
RS
4821 len)
4822 ;; Try moving back by the length of the string.
4823 (goto-char (max (- (point) (length string))
4824 (minibuffer-prompt-end)))
4825 ;; See how far back we were actually able to move. That is the
4826 ;; upper bound on how much we can match and delete.
4827 (setq len (- opoint (point)))
61bbf6fe
RS
4828 (if completion-ignore-case
4829 (setq string (downcase string)))
80298193 4830 (while (and (> len 0)
f0bfada7 4831 (let ((tail (buffer-substring (point) opoint)))
61bbf6fe
RS
4832 (if completion-ignore-case
4833 (setq tail (downcase tail)))
80298193
RS
4834 (not (string= tail (substring string 0 len)))))
4835 (setq len (1- len))
4836 (forward-char 1))
4837 (delete-char len)))
4838
ba36181b 4839(defvar choose-completion-string-functions nil
bbbbb15b
KS
4840 "Functions that may override the normal insertion of a completion choice.
4841These functions are called in order with four arguments:
4842CHOICE - the string to insert in the buffer,
4843BUFFER - the buffer in which the choice should be inserted,
89a6cfe3 4844MINI-P - non-nil iff BUFFER is a minibuffer, and
12829a07
RS
4845BASE-SIZE - the number of characters in BUFFER before
4846the string being completed.
4847
bbbbb15b
KS
4848If a function in the list returns non-nil, that function is supposed
4849to have inserted the CHOICE in the BUFFER, and possibly exited
12829a07 4850the minibuffer; no further functions will be called.
ba36181b 4851
12829a07
RS
4852If all functions in the list return nil, that means to use
4853the default method of inserting the completion in BUFFER.")
74d0290b 4854
f6b293e3 4855(defun choose-completion-string (choice &optional buffer base-size)
12829a07
RS
4856 "Switch to BUFFER and insert the completion choice CHOICE.
4857BASE-SIZE, if non-nil, says how many characters of BUFFER's text
e36aeef9
RS
4858to keep. If it is nil, we call `choose-completion-delete-max-match'
4859to decide what to delete."
12829a07
RS
4860
4861 ;; If BUFFER is the minibuffer, exit the minibuffer
4862 ;; unless it is reading a file name and CHOICE is a directory,
4863 ;; or completion-no-auto-exit is non-nil.
4864
1a0d0b6a
JPW
4865 (let* ((buffer (or buffer completion-reference-buffer))
4866 (mini-p (minibufferp buffer)))
cf52ad58
RS
4867 ;; If BUFFER is a minibuffer, barf unless it's the currently
4868 ;; active minibuffer.
f436a90a 4869 (if (and mini-p
45486731
RS
4870 (or (not (active-minibuffer-window))
4871 (not (equal buffer
4872 (window-buffer (active-minibuffer-window))))))
cf52ad58 4873 (error "Minibuffer is not active for completion")
17aa3385
KS
4874 ;; Set buffer so buffer-local choose-completion-string-functions works.
4875 (set-buffer buffer)
f1180544 4876 (unless (run-hook-with-args-until-success
d99f8496
SM
4877 'choose-completion-string-functions
4878 choice buffer mini-p base-size)
4879 ;; Insert the completion into the buffer where it was requested.
bbbbb15b
KS
4880 (if base-size
4881 (delete-region (+ base-size (if mini-p
4882 (minibuffer-prompt-end)
4883 (point-min)))
4884 (point))
4885 (choose-completion-delete-max-match choice))
4886 (insert choice)
4887 (remove-text-properties (- (point) (length choice)) (point)
4888 '(mouse-face nil))
4889 ;; Update point in the window that BUFFER is showing in.
4890 (let ((window (get-buffer-window buffer t)))
4891 (set-window-point window (point)))
4892 ;; If completing for the minibuffer, exit it with this choice.
4893 (and (not completion-no-auto-exit)
4894 (equal buffer (window-buffer (minibuffer-window)))
4895 minibuffer-completion-table
4896 ;; If this is reading a file name, and the file name chosen
4897 ;; is a directory, don't exit the minibuffer.
4898 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4899 (file-directory-p (field-string (point-max))))
4900 (let ((mini (active-minibuffer-window)))
4901 (select-window mini)
4902 (when minibuffer-auto-raise
4903 (raise-frame (window-frame mini))))
4904 (exit-minibuffer)))))))
80298193 4905
ac29eb79 4906(defun completion-list-mode ()
e8a700bf 4907 "Major mode for buffers showing lists of possible completions.
80298193
RS
4908Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
4909 to select the completion near point.
4910Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
4911 with the mouse."
e8a700bf
RS
4912 (interactive)
4913 (kill-all-local-variables)
ac29eb79
RS
4914 (use-local-map completion-list-mode-map)
4915 (setq mode-name "Completion List")
4916 (setq major-mode 'completion-list-mode)
f6b293e3
RS
4917 (make-local-variable 'completion-base-size)
4918 (setq completion-base-size nil)
b2777913 4919 (run-mode-hooks 'completion-list-mode-hook))
e8a700bf 4920
c8d6d636
GM
4921(defun completion-list-mode-finish ()
4922 "Finish setup of the completions buffer.
4923Called from `temp-buffer-show-hook'."
4924 (when (eq major-mode 'completion-list-mode)
4925 (toggle-read-only 1)))
4926
4927(add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4928
747a0e2f
RS
4929(defvar completion-setup-hook nil
4930 "Normal hook run at the end of setting up a completion list buffer.
4931When this hook is run, the current buffer is the one in which the
4932command to display the completion list buffer was run.
f5fab556 4933The completion list buffer is available as the value of `standard-output'.
63219d53 4934The common prefix substring for completion may be available as the
f5fab556
MY
4935value of `completion-common-substring'. See also `display-completion-list'.")
4936
4937
4938;; Variables and faces used in `completion-setup-function'.
747a0e2f 4939
6a4940b2 4940(defface completions-first-difference
abcdd45a
MY
4941 '((t (:inherit bold)))
4942 "Face put on the first uncommon character in completions in *Completions* buffer."
4943 :group 'completion)
4944
6a4940b2 4945(defface completions-common-part
abcdd45a 4946 '((t (:inherit default)))
e4ef3e92
JL
4947 "Face put on the common prefix substring in completions in *Completions* buffer.
4948The idea of `completions-common-part' is that you can use it to
4949make the common parts less visible than normal, so that the rest
4950of the differing parts is, by contrast, slightly highlighted."
abcdd45a 4951 :group 'completion)
6096f362 4952
abaf2e77
EZ
4953;; This is for packages that need to bind it to a non-default regexp
4954;; in order to make the first-differing character highlight work
4955;; to their liking
4956(defvar completion-root-regexp "^/"
4957 "Regexp to use in `completion-setup-function' to find the root directory.")
4958
f5fab556
MY
4959(defvar completion-common-substring nil
4960 "Common prefix substring to use in `completion-setup-function' to put faces.
4961The value is set by `display-completion-list' during running `completion-setup-hook'.
4962
6cdd0211
JL
4963To put faces `completions-first-difference' and `completions-common-part'
4964in the `*Completions*' buffer, the common prefix substring in completions
4965is needed as a hint. (The minibuffer is a special case. The content
4966of the minibuffer before point is always the common substring.)")
f5fab556
MY
4967
4968;; This function goes in completion-setup-hook, so that it is called
4969;; after the text of the completion list buffer is written.
e8a700bf 4970(defun completion-setup-function ()
1b5fd09e 4971 (let* ((mainbuf (current-buffer))
6cdd0211
JL
4972 (mbuf-contents (minibuffer-completion-contents))
4973 common-string-length)
621a3f62
SM
4974 ;; When reading a file name in the minibuffer,
4975 ;; set default-directory in the minibuffer
4976 ;; so it will get copied into the completion list buffer.
4977 (if minibuffer-completing-file-name
4978 (with-current-buffer mainbuf
4979 (setq default-directory (file-name-directory mbuf-contents))))
4980 (with-current-buffer standard-output
3819736b 4981 (completion-list-mode)
1b5fd09e 4982 (set (make-local-variable 'completion-reference-buffer) mainbuf)
b8386753 4983 (setq completion-base-size
6cdd0211
JL
4984 (cond
4985 ((and (symbolp minibuffer-completion-table)
4986 (get minibuffer-completion-table 'completion-base-size-function))
4987 ;; To compute base size, a function can use the global value of
4988 ;; completion-common-substring or minibuffer-completion-contents.
4989 (with-current-buffer mainbuf
4990 (funcall (get minibuffer-completion-table
4991 'completion-base-size-function))))
4992 (minibuffer-completing-file-name
4993 ;; For file name completion, use the number of chars before
4994 ;; the start of the file name component at point.
4995 (with-current-buffer mainbuf
4996 (save-excursion
4997 (skip-chars-backward completion-root-regexp)
4998 (- (point) (minibuffer-prompt-end)))))
4999 ;; Otherwise, in minibuffer, the base size is 0.
5000 ((minibufferp mainbuf) 0)))
5001 (setq common-string-length
5002 (cond
5003 (completion-common-substring
5004 (length completion-common-substring))
5005 (completion-base-size
5006 (- (length mbuf-contents) completion-base-size))))
621a3f62 5007 ;; Put faces on first uncommon characters and common parts.
6cdd0211 5008 (when (and (integerp common-string-length) (>= common-string-length 0))
1b5fd09e
SM
5009 (let ((element-start (point-min))
5010 (maxp (point-max))
5011 element-common-end)
5012 (while (and (setq element-start
5013 (next-single-property-change
5014 element-start 'mouse-face))
5015 (< (setq element-common-end
5016 (+ element-start common-string-length))
5017 maxp))
a0bd072b 5018 (when (get-char-property element-start 'mouse-face)
6cdd0211
JL
5019 (if (and (> common-string-length 0)
5020 (get-char-property (1- element-common-end) 'mouse-face))
a0bd072b
JL
5021 (put-text-property element-start element-common-end
5022 'font-lock-face 'completions-common-part))
5023 (if (get-char-property element-common-end 'mouse-face)
5024 (put-text-property element-common-end (1+ element-common-end)
5025 'font-lock-face 'completions-first-difference))))))
abcdd45a 5026 ;; Insert help string.
3819736b 5027 (goto-char (point-min))
0d6e23cf 5028 (if (display-mouse-p)
3819736b 5029 (insert (substitute-command-keys
80298193
RS
5030 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
5031 (insert (substitute-command-keys
5032 "In this buffer, type \\[choose-completion] to \
7d22ed15 5033select the completion near point.\n\n")))))
c88ab9ce 5034
e8a700bf 5035(add-hook 'completion-setup-hook 'completion-setup-function)
dde69dbe 5036
1b5fd09e
SM
5037(define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5038(define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
dde69dbe
RS
5039
5040(defun switch-to-completions ()
5041 "Select the completion list window."
5042 (interactive)
9595fbdb
RS
5043 ;; Make sure we have a completions window.
5044 (or (get-buffer-window "*Completions*")
5045 (minibuffer-completion-help))
fdbd7c4d
KH
5046 (let ((window (get-buffer-window "*Completions*")))
5047 (when window
5048 (select-window window)
5049 (goto-char (point-min))
5050 (search-forward "\n\n")
5051 (forward-line 1))))
f6039de6
JL
5052\f
5053;;; Support keyboard commands to turn on various modifiers.
82072f33
RS
5054
5055;; These functions -- which are not commands -- each add one modifier
5056;; to the following event.
5057
5058(defun event-apply-alt-modifier (ignore-prompt)
1e96c007 5059 "\\<function-key-map>Add the Alt modifier to the following event.
70cf9f08 5060For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
82072f33
RS
5061 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5062(defun event-apply-super-modifier (ignore-prompt)
1e96c007 5063 "\\<function-key-map>Add the Super modifier to the following event.
70cf9f08 5064For example, type \\[event-apply-super-modifier] & to enter Super-&."
82072f33
RS
5065 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5066(defun event-apply-hyper-modifier (ignore-prompt)
1e96c007 5067 "\\<function-key-map>Add the Hyper modifier to the following event.
70cf9f08 5068For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
82072f33
RS
5069 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5070(defun event-apply-shift-modifier (ignore-prompt)
1e96c007 5071 "\\<function-key-map>Add the Shift modifier to the following event.
70cf9f08 5072For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
82072f33
RS
5073 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5074(defun event-apply-control-modifier (ignore-prompt)
1e96c007 5075 "\\<function-key-map>Add the Ctrl modifier to the following event.
70cf9f08 5076For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
82072f33
RS
5077 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5078(defun event-apply-meta-modifier (ignore-prompt)
1e96c007 5079 "\\<function-key-map>Add the Meta modifier to the following event.
70cf9f08 5080For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
82072f33
RS
5081 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5082
5083(defun event-apply-modifier (event symbol lshiftby prefix)
5084 "Apply a modifier flag to event EVENT.
5085SYMBOL is the name of this modifier, as a symbol.
5086LSHIFTBY is the numeric value of this modifier, in keyboard events.
5087PREFIX is the string that represents this modifier in an event type symbol."
5088 (if (numberp event)
5089 (cond ((eq symbol 'control)
90bebcb0
KH
5090 (if (and (<= (downcase event) ?z)
5091 (>= (downcase event) ?a))
82072f33 5092 (- (downcase event) ?a -1)
90bebcb0
KH
5093 (if (and (<= (downcase event) ?Z)
5094 (>= (downcase event) ?A))
82072f33
RS
5095 (- (downcase event) ?A -1)
5096 (logior (lsh 1 lshiftby) event))))
5097 ((eq symbol 'shift)
5098 (if (and (<= (downcase event) ?z)
5099 (>= (downcase event) ?a))
5100 (upcase event)
5101 (logior (lsh 1 lshiftby) event)))
5102 (t
5103 (logior (lsh 1 lshiftby) event)))
5104 (if (memq symbol (event-modifiers event))
5105 event
5106 (let ((event-type (if (symbolp event) event (car event))))
5107 (setq event-type (intern (concat prefix (symbol-name event-type))))
5108 (if (symbolp event)
5109 event-type
5110 (cons event-type (cdr event)))))))
5111
e5fff738
KH
5112(define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5113(define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5114(define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5115(define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5116(define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5117(define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
f6039de6 5118\f
a3d1480b
JB
5119;;;; Keypad support.
5120
5121;;; Make the keypad keys act like ordinary typing keys. If people add
5122;;; bindings for the function key symbols, then those bindings will
5123;;; override these, so this shouldn't interfere with any existing
5124;;; bindings.
5125
0d173134 5126;; Also tell read-char how to handle these keys.
e1e04350 5127(mapc
a3d1480b
JB
5128 (lambda (keypad-normal)
5129 (let ((keypad (nth 0 keypad-normal))
5130 (normal (nth 1 keypad-normal)))
0d173134 5131 (put keypad 'ascii-character normal)
a3d1480b
JB
5132 (define-key function-key-map (vector keypad) (vector normal))))
5133 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5134 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
f33321ad 5135 (kp-space ?\s)
a3d1480b
JB
5136 (kp-tab ?\t)
5137 (kp-enter ?\r)
5138 (kp-multiply ?*)
5139 (kp-add ?+)
5140 (kp-separator ?,)
5141 (kp-subtract ?-)
5142 (kp-decimal ?.)
5143 (kp-divide ?/)
5144 (kp-equal ?=)))
f54b0d85 5145\f
1e722f9f 5146;;;;
b005abd5 5147;;;; forking a twin copy of a buffer.
1e722f9f 5148;;;;
b005abd5
SM
5149
5150(defvar clone-buffer-hook nil
5151 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5152
5153(defun clone-process (process &optional newname)
5154 "Create a twin copy of PROCESS.
5155If NEWNAME is nil, it defaults to PROCESS' name;
5156NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5157If PROCESS is associated with a buffer, the new process will be associated
5158 with the current buffer instead.
5159Returns nil if PROCESS has already terminated."
5160 (setq newname (or newname (process-name process)))
5161 (if (string-match "<[0-9]+>\\'" newname)
5162 (setq newname (substring newname 0 (match-beginning 0))))
5163 (when (memq (process-status process) '(run stop open))
5164 (let* ((process-connection-type (process-tty-name process))
b005abd5
SM
5165 (new-process
5166 (if (memq (process-status process) '(open))
ed7069af
KS
5167 (let ((args (process-contact process t)))
5168 (setq args (plist-put args :name newname))
5169 (setq args (plist-put args :buffer
403ca8d9
KS
5170 (if (process-buffer process)
5171 (current-buffer))))
ed7069af 5172 (apply 'make-network-process args))
b005abd5
SM
5173 (apply 'start-process newname
5174 (if (process-buffer process) (current-buffer))
5175 (process-command process)))))
ed7069af
KS
5176 (set-process-query-on-exit-flag
5177 new-process (process-query-on-exit-flag process))
b005abd5
SM
5178 (set-process-inherit-coding-system-flag
5179 new-process (process-inherit-coding-system-flag process))
5180 (set-process-filter new-process (process-filter process))
5181 (set-process-sentinel new-process (process-sentinel process))
403ca8d9 5182 (set-process-plist new-process (copy-sequence (process-plist process)))
b005abd5
SM
5183 new-process)))
5184
b75b82ab 5185;; things to maybe add (currently partly covered by `funcall mode'):
b005abd5
SM
5186;; - syntax-table
5187;; - overlays
5188(defun clone-buffer (&optional newname display-flag)
186f9ad1
LT
5189 "Create and return a twin copy of the current buffer.
5190Unlike an indirect buffer, the new buffer can be edited
5191independently of the old one (if it is not read-only).
5192NEWNAME is the name of the new buffer. It may be modified by
5193adding or incrementing <N> at the end as necessary to create a
5194unique buffer name. If nil, it defaults to the name of the
5195current buffer, with the proper suffix. If DISPLAY-FLAG is
5196non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5197clone a file-visiting buffer, or a buffer whose major mode symbol
5198has a non-nil `no-clone' property, results in an error.
5199
5200Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5201current buffer with appropriate suffix. However, if a prefix
5202argument is given, then the command prompts for NEWNAME in the
5203minibuffer.
b005abd5 5204
b005abd5
SM
5205This runs the normal hook `clone-buffer-hook' in the new buffer
5206after it has been set up properly in other respects."
61acfe7f
RS
5207 (interactive
5208 (progn
5209 (if buffer-file-name
5210 (error "Cannot clone a file-visiting buffer"))
5211 (if (get major-mode 'no-clone)
5212 (error "Cannot clone a buffer in %s mode" mode-name))
f6039de6
JL
5213 (list (if current-prefix-arg
5214 (read-buffer "Name of new cloned buffer: " (current-buffer)))
61acfe7f 5215 t)))
b005abd5
SM
5216 (if buffer-file-name
5217 (error "Cannot clone a file-visiting buffer"))
5218 (if (get major-mode 'no-clone)
5219 (error "Cannot clone a buffer in %s mode" mode-name))
5220 (setq newname (or newname (buffer-name)))
5221 (if (string-match "<[0-9]+>\\'" newname)
5222 (setq newname (substring newname 0 (match-beginning 0))))
5223 (let ((buf (current-buffer))
5224 (ptmin (point-min))
5225 (ptmax (point-max))
5226 (pt (point))
5227 (mk (if mark-active (mark t)))
5228 (modified (buffer-modified-p))
5229 (mode major-mode)
5230 (lvars (buffer-local-variables))
5231 (process (get-buffer-process (current-buffer)))
5232 (new (generate-new-buffer (or newname (buffer-name)))))
5233 (save-restriction
5234 (widen)
5235 (with-current-buffer new
5236 (insert-buffer-substring buf)))
5237 (with-current-buffer new
5238 (narrow-to-region ptmin ptmax)
5239 (goto-char pt)
5240 (if mk (set-mark mk))
5241 (set-buffer-modified-p modified)
5242
5243 ;; Clone the old buffer's process, if any.
5244 (when process (clone-process process))
5245
5246 ;; Now set up the major mode.
5247 (funcall mode)
5248
5249 ;; Set up other local variables.
5250 (mapcar (lambda (v)
5251 (condition-case () ;in case var is read-only
5252 (if (symbolp v)
5253 (makunbound v)
5254 (set (make-local-variable (car v)) (cdr v)))
5255 (error nil)))
5256 lvars)
5257
5258 ;; Run any hooks (typically set up by the major mode
5259 ;; for cloning to work properly).
5260 (run-hooks 'clone-buffer-hook))
0a487199
SM
5261 (if display-flag
5262 ;; Presumably the current buffer is shown in the selected frame, so
5263 ;; we want to display the clone elsewhere.
5264 (let ((same-window-regexps nil)
5265 (same-window-buffer-names))
5266 (pop-to-buffer new)))
b005abd5
SM
5267 new))
5268
fa65f20b 5269
7e3afb04 5270(defun clone-indirect-buffer (newname display-flag &optional norecord)
fa65f20b
GM
5271 "Create an indirect buffer that is a twin copy of the current buffer.
5272
01ba9662 5273Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
fa65f20b
GM
5274from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5275or if not called with a prefix arg, NEWNAME defaults to the current
5276buffer's name. The name is modified by adding a `<N>' suffix to it
5277or by incrementing the N in an existing suffix.
5278
5279DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7e3afb04
GM
5280This is always done when called interactively.
5281
f33321ad 5282Optional third arg NORECORD non-nil means do not put this buffer at the
7e3afb04 5283front of the list of recently selected ones."
61acfe7f
RS
5284 (interactive
5285 (progn
5286 (if (get major-mode 'no-clone-indirect)
5287 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5288 (list (if current-prefix-arg
f6039de6 5289 (read-buffer "Name of indirect buffer: " (current-buffer)))
61acfe7f
RS
5290 t)))
5291 (if (get major-mode 'no-clone-indirect)
5292 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
fa65f20b
GM
5293 (setq newname (or newname (buffer-name)))
5294 (if (string-match "<[0-9]+>\\'" newname)
5295 (setq newname (substring newname 0 (match-beginning 0))))
5296 (let* ((name (generate-new-buffer-name newname))
5297 (buffer (make-indirect-buffer (current-buffer) name t)))
5298 (when display-flag
58dd38f1 5299 (pop-to-buffer buffer norecord))
fa65f20b
GM
5300 buffer))
5301
5302
1fffd65f
RS
5303(defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
5304 "Like `clone-indirect-buffer' but display in another window."
2ef0a47e
RS
5305 (interactive
5306 (progn
5307 (if (get major-mode 'no-clone-indirect)
5308 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5309 (list (if current-prefix-arg
f6039de6 5310 (read-buffer "Name of indirect buffer: " (current-buffer)))
2ef0a47e 5311 t)))
acd39eb6 5312 (let ((pop-up-windows t))
1fffd65f 5313 (clone-indirect-buffer newname display-flag norecord)))
7e3afb04 5314
f54b0d85 5315\f
1d4b11bf
GM
5316;;; Handling of Backspace and Delete keys.
5317
e5212545
SM
5318(defcustom normal-erase-is-backspace
5319 (and (not noninteractive)
5320 (or (memq system-type '(ms-dos windows-nt))
267e1dbe 5321 (eq window-system 'mac)
e5212545
SM
5322 (and (memq window-system '(x))
5323 (fboundp 'x-backspace-delete-keys-p)
5324 (x-backspace-delete-keys-p))
5325 ;; If the terminal Emacs is running on has erase char
5326 ;; set to ^H, use the Backspace key for deleting
5327 ;; backward and, and the Delete key for deleting forward.
5328 (and (null window-system)
5329 (eq tty-erase-char ?\^H))))
7f62656b 5330 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
1d4b11bf
GM
5331
5332On window systems, the default value of this option is chosen
5333according to the keyboard used. If the keyboard has both a Backspace
5334key and a Delete key, and both are mapped to their usual meanings, the
5335option's default value is set to t, so that Backspace can be used to
7f62656b 5336delete backward, and Delete can be used to delete forward.
1d4b11bf 5337
7f62656b 5338If not running under a window system, customizing this option accomplishes
1d4b11bf
GM
5339a similar effect by mapping C-h, which is usually generated by the
5340Backspace key, to DEL, and by mapping DEL to C-d via
5341`keyboard-translate'. The former functionality of C-h is available on
5342the F1 key. You should probably not use this setting if you don't
f060b834
GM
5343have both Backspace, Delete and F1 keys.
5344
5345Setting this variable with setq doesn't take effect. Programmatically,
7f62656b 5346call `normal-erase-is-backspace-mode' (which see) instead."
1d4b11bf
GM
5347 :type 'boolean
5348 :group 'editing-basics
5349 :version "21.1"
5350 :set (lambda (symbol value)
5351 ;; The fboundp is because of a problem with :set when
5352 ;; dumping Emacs. It doesn't really matter.
7f62656b
EZ
5353 (if (fboundp 'normal-erase-is-backspace-mode)
5354 (normal-erase-is-backspace-mode (or value 0))
1d4b11bf
GM
5355 (set-default symbol value))))
5356
5357
7f62656b
EZ
5358(defun normal-erase-is-backspace-mode (&optional arg)
5359 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5360
e02160a3 5361With numeric arg, turn the mode on if and only if ARG is positive.
7f62656b
EZ
5362
5363On window systems, when this mode is on, Delete is mapped to C-d and
5364Backspace is mapped to DEL; when this mode is off, both Delete and
5365Backspace are mapped to DEL. (The remapping goes via
5366`function-key-map', so binding Delete or Backspace in the global or
5367local keymap will override that.)
5368
5369In addition, on window systems, the bindings of C-Delete, M-Delete,
5370C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5371the global keymap in accordance with the functionality of Delete and
5372Backspace. For example, if Delete is remapped to C-d, which deletes
5373forward, C-Delete is bound to `kill-word', but if Delete is remapped
5374to DEL, which deletes backward, C-Delete is bound to
5375`backward-kill-word'.
5376
5377If not running on a window system, a similar effect is accomplished by
5378remapping C-h (normally produced by the Backspace key) and DEL via
5379`keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5380to C-d; if it's off, the keys are not remapped.
5381
5382When not running on a window system, and this mode is turned on, the
5383former functionality of C-h is available on the F1 key. You should
5384probably not turn on this mode on a text-only terminal if you don't
5385have both Backspace, Delete and F1 keys.
5386
5387See also `normal-erase-is-backspace'."
1d4b11bf 5388 (interactive "P")
7f62656b 5389 (setq normal-erase-is-backspace
1d4b11bf
GM
5390 (if arg
5391 (> (prefix-numeric-value arg) 0)
7f62656b 5392 (not normal-erase-is-backspace)))
1d4b11bf 5393
13a9eed7
EZ
5394 (cond ((or (memq window-system '(x w32 mac pc))
5395 (memq system-type '(ms-dos windows-nt)))
7f62656b 5396 (let ((bindings
103db06c
RS
5397 `(([C-delete] [C-backspace])
5398 ([M-delete] [M-backspace])
5399 ([C-M-delete] [C-M-backspace])
ec9f4754 5400 (,esc-map
103db06c
RS
5401 [C-delete] [C-backspace])))
5402 (old-state (lookup-key function-key-map [delete])))
ec9f4754 5403
7f62656b 5404 (if normal-erase-is-backspace
ec9f4754
GM
5405 (progn
5406 (define-key function-key-map [delete] [?\C-d])
be4f1e41 5407 (define-key function-key-map [kp-delete] [?\C-d])
ec9f4754
GM
5408 (define-key function-key-map [backspace] [?\C-?]))
5409 (define-key function-key-map [delete] [?\C-?])
be4f1e41 5410 (define-key function-key-map [kp-delete] [?\C-?])
ec9f4754
GM
5411 (define-key function-key-map [backspace] [?\C-?]))
5412
103db06c
RS
5413 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5414 (unless (equal old-state (lookup-key function-key-map [delete]))
5415 (dolist (binding bindings)
5416 (let ((map global-map))
5417 (when (keymapp (car binding))
5418 (setq map (car binding) binding (cdr binding)))
5419 (let* ((key1 (nth 0 binding))
5420 (key2 (nth 1 binding))
5421 (binding1 (lookup-key map key1))
5422 (binding2 (lookup-key map key2)))
5423 (define-key map key1 binding2)
5424 (define-key map key2 binding1)))))))
1d4b11bf 5425 (t
7f62656b 5426 (if normal-erase-is-backspace
1d4b11bf
GM
5427 (progn
5428 (keyboard-translate ?\C-h ?\C-?)
5429 (keyboard-translate ?\C-? ?\C-d))
5430 (keyboard-translate ?\C-h ?\C-h)
5431 (keyboard-translate ?\C-? ?\C-?))))
5432
7f62656b 5433 (run-hooks 'normal-erase-is-backspace-hook)
1d4b11bf 5434 (if (interactive-p)
7f62656b
EZ
5435 (message "Delete key deletes %s"
5436 (if normal-erase-is-backspace "forward" "backward"))))
ea82f0df 5437\f
aca8bee5 5438(defvar vis-mode-saved-buffer-invisibility-spec nil
0f7df535 5439 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7f62656b 5440
0f7df535
RS
5441(define-minor-mode visible-mode
5442 "Toggle Visible mode.
5443With argument ARG turn Visible mode on iff ARG is positive.
1d4b11bf 5444
0f7df535
RS
5445Enabling Visible mode makes all invisible text temporarily visible.
5446Disabling Visible mode turns off that effect. Visible mode
5447works by saving the value of `buffer-invisibility-spec' and setting it to nil."
4e57881d 5448 :lighter " Vis"
ab77efd0 5449 :group 'editing-basics
aca8bee5
SM
5450 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5451 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5452 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
0f7df535 5453 (when visible-mode
aca8bee5
SM
5454 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5455 buffer-invisibility-spec)
5456 (setq buffer-invisibility-spec nil)))
4e57881d 5457\f
e1e04350 5458;; Minibuffer prompt stuff.
9b350152 5459
49c14a05
GM
5460;(defun minibuffer-prompt-modification (start end)
5461; (error "You cannot modify the prompt"))
5462;
5463;
5464;(defun minibuffer-prompt-insertion (start end)
5465; (let ((inhibit-modification-hooks t))
5466; (delete-region start end)
5467; ;; Discard undo information for the text insertion itself
5468; ;; and for the text deletion.above.
5469; (when (consp buffer-undo-list)
5470; (setq buffer-undo-list (cddr buffer-undo-list)))
5471; (message "You cannot modify the prompt")))
5472;
5473;
f1180544 5474;(setq minibuffer-prompt-properties
49c14a05
GM
5475; (list 'modification-hooks '(minibuffer-prompt-modification)
5476; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
f1180544 5477;
9b350152 5478
00398e3b 5479(provide 'simple)
ab5796a9 5480
621a3f62 5481;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
c88ab9ce 5482;;; simple.el ends here