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