Followup to 2011-10-19T09:48:35Z!eliz@gnu.org.
[bpt/emacs.git] / lisp / simple.el
CommitLineData
c88ab9ce
ER
1;;; simple.el --- basic editing commands for Emacs
2
73b0cd50 3;; Copyright (C) 1985-1987, 1993-2011 Free Software Foundation, Inc.
2076c87c 4
30764597
PJ
5;; Maintainer: FSF
6;; Keywords: internal
bd78fa1d 7;; Package: emacs
30764597 8
2076c87c
JB
9;; This file is part of GNU Emacs.
10
eb3fa2cf 11;; GNU Emacs is free software: you can redistribute it and/or modify
2076c87c 12;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
2076c87c
JB
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
eb3fa2cf 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
2076c87c 23
d9ecc911
ER
24;;; Commentary:
25
26;; A grab-bag of basic Emacs commands not specifically related to some
27;; major mode or to file-handling.
28
3a801d0c 29;;; Code:
2076c87c 30
2ec42da9 31(eval-when-compile (require 'cl)) ;For define-minor-mode.
30ee26a9 32
f31b1257
DN
33(declare-function widget-convert "wid-edit" (type &rest args))
34(declare-function shell-mode "shell" ())
d01a33cf 35
06b60517 36;;; From compile.el
ca60ee11 37(defvar compilation-current-error)
06b60517 38(defvar compilation-context-lines)
ca60ee11 39
7fcce20f 40(defcustom idle-update-delay 0.5
1d2b0303 41 "Idle time delay before updating various things on the screen.
7fcce20f
RS
42Various Emacs features that update auxiliary information when point moves
43wait this many seconds after Emacs becomes idle before doing an update."
44 :type 'number
45 :group 'display
46 :version "22.1")
d01a33cf 47
69c1dd37 48(defgroup killing nil
c9f0110e 49 "Killing and yanking commands."
69c1dd37
RS
50 :group 'editing)
51
69c1dd37
RS
52(defgroup paren-matching nil
53 "Highlight (un)matching of parens and expressions."
69c1dd37 54 :group 'matching)
ee9c5954 55\f
50f007fb 56;;; next-error support framework
bbf41690
RS
57
58(defgroup next-error nil
f33321ad 59 "`next-error' support framework."
bbf41690 60 :group 'compilation
bf247b6e 61 :version "22.1")
bbf41690
RS
62
63(defface next-error
64 '((t (:inherit region)))
65 "Face used to highlight next error locus."
66 :group 'next-error
bf247b6e 67 :version "22.1")
bbf41690 68
7408ee97 69(defcustom next-error-highlight 0.5
1d2b0303 70 "Highlighting of locations in selected source buffers.
676b1a74
CY
71If a number, highlight the locus in `next-error' face for the given time
72in seconds, or until the next command is executed.
73If t, highlight the locus until the next command is executed, or until
74some other locus replaces it.
bbf41690 75If nil, don't highlight the locus in the source buffer.
249f792c
JL
76If `fringe-arrow', indicate the locus by the fringe arrow
77indefinitely until some other locus replaces it."
6d3c944b 78 :type '(choice (number :tag "Highlight for specified time")
c81b29e6 79 (const :tag "Semipermanent highlighting" t)
bbf41690 80 (const :tag "No highlighting" nil)
6d3c944b 81 (const :tag "Fringe arrow" fringe-arrow))
bbf41690 82 :group 'next-error
bf247b6e 83 :version "22.1")
bbf41690 84
7408ee97 85(defcustom next-error-highlight-no-select 0.5
1d2b0303 86 "Highlighting of locations in `next-error-no-select'.
f33321ad 87If number, highlight the locus in `next-error' face for given time in seconds.
6d3c944b 88If t, highlight the locus indefinitely until some other locus replaces it.
bbf41690 89If nil, don't highlight the locus in the source buffer.
249f792c
JL
90If `fringe-arrow', indicate the locus by the fringe arrow
91indefinitely until some other locus replaces it."
6d3c944b 92 :type '(choice (number :tag "Highlight for specified time")
c81b29e6 93 (const :tag "Semipermanent highlighting" t)
bbf41690 94 (const :tag "No highlighting" nil)
6d3c944b 95 (const :tag "Fringe arrow" fringe-arrow))
bbf41690 96 :group 'next-error
bf247b6e 97 :version "22.1")
bbf41690 98
446b609e 99(defcustom next-error-recenter nil
1d2b0303 100 "Display the line in the visited source file recentered as specified.
28adf31c
TTN
101If non-nil, the value is passed directly to `recenter'."
102 :type '(choice (integer :tag "Line to recenter to")
103 (const :tag "Center of window" (4))
446b609e
TTN
104 (const :tag "No recentering" nil))
105 :group 'next-error
106 :version "23.1")
107
d634a3a2 108(defcustom next-error-hook nil
1d2b0303 109 "List of hook functions run by `next-error' after visiting source file."
d634a3a2
JL
110 :type 'hook
111 :group 'next-error)
112
814c3037
JL
113(defvar next-error-highlight-timer nil)
114
9c9b00d6 115(defvar next-error-overlay-arrow-position nil)
6bdad9ae 116(put 'next-error-overlay-arrow-position 'overlay-arrow-string (purecopy "=>"))
9c9b00d6
JL
117(add-to-list 'overlay-arrow-variable-list 'next-error-overlay-arrow-position)
118
50f007fb 119(defvar next-error-last-buffer nil
f33321ad 120 "The most recent `next-error' buffer.
50f007fb
KS
121A buffer becomes most recent when its compilation, grep, or
122similar mode is started, or when it is used with \\[next-error]
123or \\[compile-goto-error].")
124
125(defvar next-error-function nil
e462ab77
SM
126 "Function to use to find the next error in the current buffer.
127The function is called with 2 parameters:
128ARG is an integer specifying by how many errors to move.
129RESET is a boolean which, if non-nil, says to go back to the beginning
130of the errors before moving.
131Major modes providing compile-like functionality should set this variable
132to indicate to `next-error' that this is a candidate buffer and how
133to navigate in it.")
50f007fb
KS
134(make-variable-buffer-local 'next-error-function)
135
8cdba32b
RS
136(defvar next-error-move-function nil
137 "Function to use to move to an error locus.
138It takes two arguments, a buffer position in the error buffer
139and a buffer position in the error locus buffer.
140The buffer for the error locus should already be current.
141nil means use goto-char using the second argument position.")
142(make-variable-buffer-local 'next-error-move-function)
143
f1e2a033 144(defsubst next-error-buffer-p (buffer
e967cd11 145 &optional avoid-current
f1e2a033 146 extra-test-inclusive
5f9e0ca5 147 extra-test-exclusive)
f33321ad 148 "Test if BUFFER is a `next-error' capable buffer.
e967cd11
RS
149
150If AVOID-CURRENT is non-nil, treat the current buffer
151as an absolute last resort only.
152
153The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154that normally would not qualify. If it returns t, the buffer
155in question is treated as usable.
156
7979163c 157The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
01ba9662 158that would normally be considered usable. If it returns nil,
e967cd11
RS
159that buffer is rejected."
160 (and (buffer-name buffer) ;First make sure it's live.
161 (not (and avoid-current (eq buffer (current-buffer))))
162 (with-current-buffer buffer
163 (if next-error-function ; This is the normal test.
164 ;; Optionally reject some buffers.
165 (if extra-test-exclusive
166 (funcall extra-test-exclusive)
167 t)
168 ;; Optionally accept some other buffers.
169 (and extra-test-inclusive
170 (funcall extra-test-inclusive))))))
171
172(defun next-error-find-buffer (&optional avoid-current
f1e2a033 173 extra-test-inclusive
5f9e0ca5 174 extra-test-exclusive)
f33321ad 175 "Return a `next-error' capable buffer.
7979163c 176
e967cd11
RS
177If AVOID-CURRENT is non-nil, treat the current buffer
178as an absolute last resort only.
179
01ba9662 180The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
e967cd11
RS
181that normally would not qualify. If it returns t, the buffer
182in question is treated as usable.
183
7979163c 184The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
e967cd11
RS
185that would normally be considered usable. If it returns nil,
186that buffer is rejected."
03e75c7e
JL
187 (or
188 ;; 1. If one window on the selected frame displays such buffer, return it.
189 (let ((window-buffers
190 (delete-dups
191 (delq nil (mapcar (lambda (w)
192 (if (next-error-buffer-p
e967cd11
RS
193 (window-buffer w)
194 avoid-current
f1e2a033 195 extra-test-inclusive extra-test-exclusive)
03e75c7e
JL
196 (window-buffer w)))
197 (window-list))))))
03e75c7e
JL
198 (if (eq (length window-buffers) 1)
199 (car window-buffers)))
e967cd11 200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
03e75c7e 201 (if (and next-error-last-buffer
e967cd11 202 (next-error-buffer-p next-error-last-buffer avoid-current
f1e2a033 203 extra-test-inclusive extra-test-exclusive))
e967cd11
RS
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
206 (if (next-error-buffer-p (current-buffer) avoid-current
207 extra-test-inclusive extra-test-exclusive)
03e75c7e 208 (current-buffer))
e967cd11 209 ;; 4. Look for any acceptable buffer.
03e75c7e
JL
210 (let ((buffers (buffer-list)))
211 (while (and buffers
e967cd11
RS
212 (not (next-error-buffer-p
213 (car buffers) avoid-current
214 extra-test-inclusive extra-test-exclusive)))
03e75c7e 215 (setq buffers (cdr buffers)))
e967cd11
RS
216 (car buffers))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
219 (and avoid-current
220 (next-error-buffer-p (current-buffer) nil
221 extra-test-inclusive extra-test-exclusive)
222 (progn
ee4dc5d9 223 (message "This is the only buffer with error message locations")
e967cd11
RS
224 (current-buffer)))
225 ;; 6. Give up.
ee4dc5d9 226 (error "No buffers contain error message locations")))
50f007fb 227
310abb0b 228(defun next-error (&optional arg reset)
f33321ad 229 "Visit next `next-error' message and corresponding source code.
50f007fb
KS
230
231If all the error messages parsed so far have been processed already,
232the message buffer is checked for new ones.
233
e462ab77 234A prefix ARG specifies how many error messages to move;
50f007fb
KS
235negative means move back to previous error messages.
236Just \\[universal-argument] as a prefix means reparse the error message buffer
237and start at the first error.
238
e249a6d8 239The RESET argument specifies that we should restart from the beginning.
50f007fb
KS
240
241\\[next-error] normally uses the most recently started
242compilation, grep, or occur buffer. It can also operate on any
243buffer with output from the \\[compile], \\[grep] commands, or,
244more generally, on any buffer in Compilation mode or with
245Compilation Minor mode enabled, or any buffer in which
03e75c7e
JL
246`next-error-function' is bound to an appropriate function.
247To specify use of a particular buffer for error messages, type
248\\[next-error] in that buffer when it is the only one displayed
249in the current frame.
50f007fb 250
d634a3a2
JL
251Once \\[next-error] has chosen the buffer for error messages, it
252runs `next-error-hook' with `run-hooks', and stays with that buffer
253until you use it in some other buffer which uses Compilation mode
254or Compilation Minor mode.
50f007fb 255
3caced0b
GM
256To control which errors are matched, customize the variable
257`compilation-error-regexp-alist'."
50f007fb 258 (interactive "P")
e462ab77 259 (if (consp arg) (setq reset t arg nil))
50f007fb
KS
260 (when (setq next-error-last-buffer (next-error-find-buffer))
261 ;; we know here that next-error-function is a valid symbol we can funcall
262 (with-current-buffer next-error-last-buffer
d634a3a2 263 (funcall next-error-function (prefix-numeric-value arg) reset)
446b609e
TTN
264 (when next-error-recenter
265 (recenter next-error-recenter))
d634a3a2 266 (run-hooks 'next-error-hook))))
50f007fb 267
56ab610b
RS
268(defun next-error-internal ()
269 "Visit the source code corresponding to the `next-error' message at point."
270 (setq next-error-last-buffer (current-buffer))
271 ;; we know here that next-error-function is a valid symbol we can funcall
272 (with-current-buffer next-error-last-buffer
273 (funcall next-error-function 0 nil)
446b609e
TTN
274 (when next-error-recenter
275 (recenter next-error-recenter))
56ab610b
RS
276 (run-hooks 'next-error-hook)))
277
50f007fb
KS
278(defalias 'goto-next-locus 'next-error)
279(defalias 'next-match 'next-error)
280
310abb0b 281(defun previous-error (&optional n)
f33321ad 282 "Visit previous `next-error' message and corresponding source code.
50f007fb
KS
283
284Prefix arg N says how many error messages to move backwards (or
285forwards, if negative).
286
287This operates on the output from the \\[compile] and \\[grep] commands."
288 (interactive "p")
310abb0b 289 (next-error (- (or n 1))))
50f007fb 290
310abb0b 291(defun first-error (&optional n)
50f007fb
KS
292 "Restart at the first error.
293Visit corresponding source code.
294With prefix arg N, visit the source code of the Nth error.
295This operates on the output from the \\[compile] command, for instance."
296 (interactive "p")
297 (next-error n t))
298
310abb0b 299(defun next-error-no-select (&optional n)
f33321ad 300 "Move point to the next error in the `next-error' buffer and highlight match.
50f007fb
KS
301Prefix arg N says how many error messages to move forwards (or
302backwards, if negative).
303Finds and highlights the source line like \\[next-error], but does not
304select the source buffer."
305 (interactive "p")
ee9c5954
JL
306 (let ((next-error-highlight next-error-highlight-no-select))
307 (next-error n))
50f007fb
KS
308 (pop-to-buffer next-error-last-buffer))
309
310abb0b 310(defun previous-error-no-select (&optional n)
f33321ad 311 "Move point to the previous error in the `next-error' buffer and highlight match.
50f007fb
KS
312Prefix arg N says how many error messages to move backwards (or
313forwards, if negative).
314Finds and highlights the source line like \\[previous-error], but does not
315select the source buffer."
316 (interactive "p")
310abb0b 317 (next-error-no-select (- (or n 1))))
50f007fb 318
85be9ec4 319;; Internal variable for `next-error-follow-mode-post-command-hook'.
282d6eae
EZ
320(defvar next-error-follow-last-line nil)
321
2a223f35 322(define-minor-mode next-error-follow-minor-mode
282d6eae 323 "Minor mode for compilation, occur and diff modes.
2a223f35
EZ
324When turned on, cursor motion in the compilation, grep, occur or diff
325buffer causes automatic display of the corresponding source code
326location."
ed8e0f0a 327 :group 'next-error :init-value nil :lighter " Fol"
8a98a6c2 328 (if (not next-error-follow-minor-mode)
282d6eae
EZ
329 (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t)
330 (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t)
e56dd5c6 331 (make-local-variable 'next-error-follow-last-line)))
282d6eae 332
85be9ec4
SM
333;; Used as a `post-command-hook' by `next-error-follow-mode'
334;; for the *Compilation* *grep* and *Occur* buffers.
282d6eae
EZ
335(defun next-error-follow-mode-post-command-hook ()
336 (unless (equal next-error-follow-last-line (line-number-at-pos))
337 (setq next-error-follow-last-line (line-number-at-pos))
338 (condition-case nil
339 (let ((compilation-context-lines nil))
340 (setq compilation-current-error (point))
341 (next-error-no-select 0))
342 (error t))))
343
ee9c5954 344\f
50f007fb
KS
345;;;
346
93be67de
KH
347(defun fundamental-mode ()
348 "Major mode not specialized for anything in particular.
349Other major modes are defined by comparison with this one."
350 (interactive)
e174f8db 351 (kill-all-local-variables)
56924d99 352 (run-mode-hooks 'fundamental-mode-hook))
eaae8106 353
d445b3f8
SM
354;; Special major modes to view specially formatted data rather than files.
355
356(defvar special-mode-map
357 (let ((map (make-sparse-keymap)))
358 (suppress-keymap map)
359 (define-key map "q" 'quit-window)
ce3cefcc
CY
360 (define-key map " " 'scroll-up-command)
361 (define-key map "\C-?" 'scroll-down-command)
d445b3f8 362 (define-key map "?" 'describe-mode)
abef340a 363 (define-key map "h" 'describe-mode)
d445b3f8
SM
364 (define-key map ">" 'end-of-buffer)
365 (define-key map "<" 'beginning-of-buffer)
366 (define-key map "g" 'revert-buffer)
abef340a 367 (define-key map "z" 'kill-this-buffer)
d445b3f8 368 map))
1d2b0303 369
d445b3f8
SM
370(put 'special-mode 'mode-class 'special)
371(define-derived-mode special-mode nil "Special"
372 "Parent major mode from which special major modes should inherit."
373 (setq buffer-read-only t))
374
10dcc561
SM
375;; Major mode meant to be the parent of programming modes.
376
b2a15250
SM
377(defvar prog-mode-map
378 (let ((map (make-sparse-keymap)))
379 (define-key map [?\C-\M-q] 'prog-indent-sexp)
380 map)
381 "Keymap used for programming modes.")
382
383(defun prog-indent-sexp ()
384 "Indent the expression after point."
385 (interactive)
386 (let ((start (point))
387 (end (save-excursion (forward-sexp 1) (point))))
388 (indent-region start end nil)))
389
10dcc561
SM
390(define-derived-mode prog-mode fundamental-mode "Prog"
391 "Major mode for editing programming language source code."
392 (set (make-local-variable 'require-final-newline) mode-require-final-newline)
228482b2
EZ
393 (set (make-local-variable 'parse-sexp-ignore-comments) t)
394 ;; Any programming language is always written left to right.
395 (setq bidi-paragraph-direction 'left-to-right))
10dcc561 396
93be67de
KH
397;; Making and deleting lines.
398
28fab7b5
GM
399(defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard))
400 "Propertized string representing a hard newline character.")
4ea0018b 401
30bb9754 402(defun newline (&optional arg)
d133d835 403 "Insert a newline, and move to left margin of the new line if it's blank.
058d4999
DL
404If `use-hard-newlines' is non-nil, the newline is marked with the
405text-property `hard'.
76c64e24 406With ARG, insert that many newlines.
058d4999 407Call `auto-fill-function' if the current column number is greater
6688f85f 408than the value of `fill-column' and ARG is nil."
30bb9754 409 (interactive "*P")
4c4cbf11 410 (barf-if-buffer-read-only)
e5eddfd1
SM
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
413 (let* ((was-page-start (and (bolp) (looking-at page-delimiter)))
414 (beforepos (point))
415 (last-command-event ?\n)
416 ;; Don't auto-fill if we have a numeric argument.
417 (auto-fill-function (if arg nil auto-fill-function))
418 (postproc
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
421 (lambda ()
422 ;; Mark the newline(s) `hard'.
423 (if use-hard-newlines
424 (set-hard-newline-properties
425 (- (point) (prefix-numeric-value arg)) (point)))
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
428 (save-excursion
429 (goto-char beforepos)
430 (beginning-of-line)
431 (and (looking-at "[ \t]$")
432 (> (current-left-margin) 0)
433 (delete-region (point)
434 (line-end-position))))
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
437 ;; starts a page.
438 (or was-page-start
439 (move-to-left-margin nil t)))))
440 (unwind-protect
441 (progn
442 (add-hook 'post-self-insert-hook postproc)
443 (self-insert-command (prefix-numeric-value arg)))
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
447 (remove-hook 'post-self-insert-hook postproc)))
30bb9754
BG
448 nil)
449
55741b46
RS
450(defun set-hard-newline-properties (from to)
451 (let ((sticky (get-text-property from 'rear-nonsticky)))
452 (put-text-property from to 'hard 't)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
454 (if (and (listp sticky) (not (memq 'hard sticky)))
455 (put-text-property from (point) 'rear-nonsticky
456 (cons 'hard sticky)))))
eaae8106 457
e249a6d8 458(defun open-line (n)
ff1fbe3e 459 "Insert a newline and leave point before it.
f33321ad
JB
460If there is a fill prefix and/or a `left-margin', insert them
461on the new line if the line would have been blank.
616ed245 462With arg N, insert N newlines."
2076c87c 463 (interactive "*p")
616ed245 464 (let* ((do-fill-prefix (and fill-prefix (bolp)))
3db1e3b5 465 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
c156a63b 466 (loc (point-marker))
207d7545
GM
467 ;; Don't expand an abbrev before point.
468 (abbrev-mode nil))
e249a6d8 469 (newline n)
d133d835 470 (goto-char loc)
e249a6d8 471 (while (> n 0)
d133d835
RS
472 (cond ((bolp)
473 (if do-left-margin (indent-to (current-left-margin)))
474 (if do-fill-prefix (insert-and-inherit fill-prefix))))
475 (forward-line 1)
e249a6d8 476 (setq n (1- n)))
d133d835
RS
477 (goto-char loc)
478 (end-of-line)))
2076c87c 479
da7d231b
KS
480(defun split-line (&optional arg)
481 "Split current line, moving portion beyond point vertically down.
482If the current line starts with `fill-prefix', insert it on the new
f33321ad 483line as well. With prefix ARG, don't insert `fill-prefix' on new line.
da7d231b 484
e249a6d8 485When called from Lisp code, ARG may be a prefix string to copy."
da7d231b 486 (interactive "*P")
2076c87c 487 (skip-chars-forward " \t")
d77bbdc9
RS
488 (let* ((col (current-column))
489 (pos (point))
490 ;; What prefix should we check for (nil means don't).
491 (prefix (cond ((stringp arg) arg)
492 (arg nil)
493 (t fill-prefix)))
494 ;; Does this line start with it?
495 (have-prfx (and prefix
496 (save-excursion
497 (beginning-of-line)
498 (looking-at (regexp-quote prefix))))))
28191e20 499 (newline 1)
d77bbdc9 500 (if have-prfx (insert-and-inherit prefix))
2076c87c
JB
501 (indent-to col 0)
502 (goto-char pos)))
503
2076c87c
JB
504(defun delete-indentation (&optional arg)
505 "Join this line to previous and fix up whitespace at join.
ccc58657 506If there is a fill prefix, delete it from the beginning of this line.
2076c87c
JB
507With argument, join this line to following line."
508 (interactive "*P")
509 (beginning-of-line)
510 (if arg (forward-line 1))
511 (if (eq (preceding-char) ?\n)
512 (progn
513 (delete-region (point) (1- (point)))
ccc58657
RS
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
516 (if (and fill-prefix
01b8e020 517 (<= (+ (point) (length fill-prefix)) (point-max))
ccc58657
RS
518 (string= fill-prefix
519 (buffer-substring (point)
520 (+ (point) (length fill-prefix)))))
521 (delete-region (point) (+ (point) (length fill-prefix))))
2076c87c
JB
522 (fixup-whitespace))))
523
fc025090 524(defalias 'join-line #'delete-indentation) ; easier to find
eaae8106 525
2076c87c
JB
526(defun delete-blank-lines ()
527 "On blank line, delete all surrounding blank lines, leaving just one.
528On isolated blank line, delete that one.
6d30d416 529On nonblank line, delete any immediately following blank lines."
2076c87c
JB
530 (interactive "*")
531 (let (thisblank singleblank)
532 (save-excursion
533 (beginning-of-line)
534 (setq thisblank (looking-at "[ \t]*$"))
70e14c01 535 ;; Set singleblank if there is just one blank line here.
2076c87c
JB
536 (setq singleblank
537 (and thisblank
538 (not (looking-at "[ \t]*\n[ \t]*$"))
539 (or (bobp)
540 (progn (forward-line -1)
541 (not (looking-at "[ \t]*$")))))))
70e14c01 542 ;; Delete preceding blank lines, and this one too if it's the only one.
2076c87c
JB
543 (if thisblank
544 (progn
545 (beginning-of-line)
546 (if singleblank (forward-line 1))
547 (delete-region (point)
548 (if (re-search-backward "[^ \t\n]" nil t)
549 (progn (forward-line 1) (point))
550 (point-min)))))
70e14c01
JB
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
2076c87c
JB
553 (if (not (and thisblank singleblank))
554 (save-excursion
555 (end-of-line)
556 (forward-line 1)
557 (delete-region (point)
558 (if (re-search-forward "[^ \t\n]" nil t)
559 (progn (beginning-of-line) (point))
70e14c01
JB
560 (point-max)))))
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
563 (if (looking-at "^[ \t]*\n\\'")
564 (delete-region (point) (point-max)))))
2076c87c 565
25833f5e 566(defun delete-trailing-whitespace (&optional start end)
eaae8106
SS
567 "Delete all the trailing whitespace across the current buffer.
568All whitespace after the last non-whitespace character in a line is deleted.
103db06c 569This respects narrowing, created by \\[narrow-to-region] and friends.
25833f5e 570A formfeed is not considered whitespace by this function.
db4e950d 571If END is nil, also delete all trailing lines at the end of the buffer.
25833f5e
DD
572If the region is active, only delete whitespace within the region."
573 (interactive (progn
574 (barf-if-buffer-read-only)
575 (if (use-region-p)
576 (list (region-beginning) (region-end))
577 (list nil nil))))
eaae8106
SS
578 (save-match-data
579 (save-excursion
25833f5e
DD
580 (let ((end-marker (copy-marker (or end (point-max))))
581 (start (or start (point-min))))
582 (goto-char start)
583 (while (re-search-forward "\\s-$" end-marker t)
db4e950d 584 (skip-syntax-backward "-" (line-beginning-position))
25833f5e 585 ;; Don't delete formfeeds, even if they are considered whitespace.
db4e950d
SM
586 (if (looking-at-p ".*\f")
587 (goto-char (match-end 0)))
25833f5e 588 (delete-region (point) (match-end 0)))
db4e950d
SM
589 ;; Delete trailing empty lines.
590 (goto-char end-marker)
591 (when (and (not end)
db4e950d 592 ;; Really the end of buffer.
88d9610c
SM
593 (save-restriction (widen) (eobp))
594 (<= (skip-chars-backward "\n") -2))
db4e950d 595 (delete-region (1+ (point)) end-marker))
f346fd6b
MA
596 (set-marker end-marker nil))))
597 ;; Return nil for the benefit of `write-file-functions'.
598 nil)
eaae8106 599
2076c87c
JB
600(defun newline-and-indent ()
601 "Insert a newline, then indent according to major mode.
ff1fbe3e 602Indentation is done using the value of `indent-line-function'.
2076c87c 603In programming language modes, this is the same as TAB.
ff1fbe3e 604In some text modes, where TAB inserts a tab, this command indents to the
eed5698b 605column specified by the function `current-left-margin'."
2076c87c 606 (interactive "*")
5ff4ba3d 607 (delete-horizontal-space t)
46947372 608 (newline)
2076c87c
JB
609 (indent-according-to-mode))
610
611(defun reindent-then-newline-and-indent ()
612 "Reindent current line, insert newline, then indent the new line.
613Indentation of both lines is done according to the current major mode,
ff1fbe3e 614which means calling the current value of `indent-line-function'.
2076c87c
JB
615In programming language modes, this is the same as TAB.
616In some text modes, where TAB inserts a tab, this indents to the
eed5698b 617column specified by the function `current-left-margin'."
2076c87c 618 (interactive "*")
e1e04350
SM
619 (let ((pos (point)))
620 ;; Be careful to insert the newline before indenting the line.
621 ;; Otherwise, the indentation might be wrong.
622 (newline)
623 (save-excursion
624 (goto-char pos)
eb3d6c67
SM
625 ;; We are at EOL before the call to indent-according-to-mode, and
626 ;; after it we usually are as well, but not always. We tried to
627 ;; address it with `save-excursion' but that uses a normal marker
628 ;; whereas we need `move after insertion', so we do the save/restore
629 ;; by hand.
630 (setq pos (copy-marker pos t))
631 (indent-according-to-mode)
632 (goto-char pos)
633 ;; Remove the trailing white-space after indentation because
634 ;; indentation may introduce the whitespace.
6b61353c 635 (delete-horizontal-space t))
e1e04350 636 (indent-according-to-mode)))
eaae8106 637
93be67de
KH
638(defun quoted-insert (arg)
639 "Read next input character and insert it.
640This is useful for inserting control characters.
5626c14e 641With argument, insert ARG copies of the character.
2076c87c 642
93be67de
KH
643If the first character you type after this command is an octal digit,
644you should type a sequence of octal digits which specify a character code.
645Any nondigit terminates the sequence. If the terminator is a RET,
646it is discarded; any other terminator is used itself as input.
647The variable `read-quoted-char-radix' specifies the radix for this feature;
648set it to 10 or 16 to use decimal or hex instead of octal.
dff7d67f 649
93be67de
KH
650In overwrite mode, this function inserts the character anyway, and
651does not handle octal digits specially. This means that if you use
652overwrite as your normal editing mode, you can use this function to
653insert characters when necessary.
dff7d67f 654
93be67de
KH
655In binary overwrite mode, this function does overwrite, and octal
656digits are interpreted as a character code. This is intended to be
657useful for editing binary files."
658 (interactive "*p")
a6c39c14
EZ
659 (let* ((char
660 ;; Avoid "obsolete" warnings for translation-table-for-input.
661 (with-no-warnings
662 (let (translation-table-for-input input-method-function)
663 (if (or (not overwrite-mode)
664 (eq overwrite-mode 'overwrite-mode-binary))
665 (read-quoted-char)
666 (read-char))))))
0e3269e5
JL
667 ;; This used to assume character codes 0240 - 0377 stand for
668 ;; characters in some single-byte character set, and converted them
669 ;; to Emacs characters. But in 23.1 this feature is deprecated
670 ;; in favor of inserting the corresponding Unicode characters.
671 ;; (if (and enable-multibyte-characters
672 ;; (>= char ?\240)
673 ;; (<= char ?\377))
674 ;; (setq char (unibyte-char-to-multibyte char)))
93be67de
KH
675 (if (> arg 0)
676 (if (eq overwrite-mode 'overwrite-mode-binary)
677 (delete-char arg)))
678 (while (> arg 0)
679 (insert-and-inherit char)
680 (setq arg (1- arg)))))
eaae8106 681
6b61353c 682(defun forward-to-indentation (&optional arg)
93be67de 683 "Move forward ARG lines and position at first nonblank character."
109cfe4e 684 (interactive "^p")
6b61353c 685 (forward-line (or arg 1))
93be67de 686 (skip-chars-forward " \t"))
cc2b2b6c 687
6b61353c 688(defun backward-to-indentation (&optional arg)
93be67de 689 "Move backward ARG lines and position at first nonblank character."
109cfe4e 690 (interactive "^p")
6b61353c 691 (forward-line (- (or arg 1)))
93be67de 692 (skip-chars-forward " \t"))
2076c87c 693
93be67de
KH
694(defun back-to-indentation ()
695 "Move point to the first non-whitespace character on this line."
109cfe4e 696 (interactive "^")
93be67de 697 (beginning-of-line 1)
1e96c007 698 (skip-syntax-forward " " (line-end-position))
b9863466
RS
699 ;; Move back over chars that have whitespace syntax but have the p flag.
700 (backward-prefix-chars))
93be67de
KH
701
702(defun fixup-whitespace ()
703 "Fixup white space between objects around point.
704Leave one space or none, according to the context."
705 (interactive "*")
706 (save-excursion
707 (delete-horizontal-space)
708 (if (or (looking-at "^\\|\\s)")
709 (save-excursion (forward-char -1)
710 (looking-at "$\\|\\s(\\|\\s'")))
711 nil
f33321ad 712 (insert ?\s))))
93be67de 713
5ff4ba3d
MB
714(defun delete-horizontal-space (&optional backward-only)
715 "Delete all spaces and tabs around point.
1cfcd2db 716If BACKWARD-ONLY is non-nil, only delete them before point."
a168699d 717 (interactive "*P")
9ab59a1a
MB
718 (let ((orig-pos (point)))
719 (delete-region
720 (if backward-only
721 orig-pos
722 (progn
723 (skip-chars-forward " \t")
724 (constrain-to-field nil orig-pos t)))
5ff4ba3d 725 (progn
9ab59a1a
MB
726 (skip-chars-backward " \t")
727 (constrain-to-field nil orig-pos)))))
93be67de 728
68c16b59 729(defun just-one-space (&optional n)
88b5a757 730 "Delete all spaces and tabs around point, leaving one space (or N spaces).
1c708c1a 731If N is negative, delete newlines as well."
56abefac 732 (interactive "*p")
11c31b99 733 (unless n (setq n 1))
88b5a757
DD
734 (let ((orig-pos (point))
735 (skip-characters (if (< n 0) " \t\n\r" " \t"))
736 (n (abs n)))
737 (skip-chars-backward skip-characters)
9ab59a1a 738 (constrain-to-field nil orig-pos)
be4a1d71 739 (dotimes (i n)
f33321ad 740 (if (= (following-char) ?\s)
56abefac 741 (forward-char 1)
f33321ad 742 (insert ?\s)))
9ab59a1a
MB
743 (delete-region
744 (point)
745 (progn
88b5a757 746 (skip-chars-forward skip-characters)
9ab59a1a 747 (constrain-to-field nil orig-pos t)))))
2d88b556 748\f
2076c87c 749(defun beginning-of-buffer (&optional arg)
8d9f4291 750 "Move point to the beginning of the buffer.
a416e7ef 751With numeric arg N, put point N/10 of the way from the beginning.
8d9f4291
CY
752If the buffer is narrowed, this command uses the beginning of the
753accessible part of the buffer.
c66587fe 754
8d9f4291
CY
755If Transient Mark mode is disabled, leave mark at previous
756position, unless a \\[universal-argument] prefix is supplied.
ff1fbe3e
RS
757
758Don't use this command in Lisp programs!
8d9f4291 759\(goto-char (point-min)) is faster."
109cfe4e 760 (interactive "^P")
24199fe7 761 (or (consp arg)
d34c311a 762 (region-active-p)
705a5933 763 (push-mark))
c66587fe 764 (let ((size (- (point-max) (point-min))))
a416e7ef 765 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
766 (+ (point-min)
767 (if (> size 10000)
768 ;; Avoid overflow for large buffer sizes!
769 (* (prefix-numeric-value arg)
770 (/ size 10))
771 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
772 (point-min))))
d7e7ecd7 773 (if (and arg (not (consp arg))) (forward-line 1)))
2076c87c
JB
774
775(defun end-of-buffer (&optional arg)
8d9f4291 776 "Move point to the end of the buffer.
a416e7ef 777With numeric arg N, put point N/10 of the way from the end.
8d9f4291
CY
778If the buffer is narrowed, this command uses the end of the
779accessible part of the buffer.
c66587fe 780
8d9f4291
CY
781If Transient Mark mode is disabled, leave mark at previous
782position, unless a \\[universal-argument] prefix is supplied.
ff1fbe3e
RS
783
784Don't use this command in Lisp programs!
8d9f4291 785\(goto-char (point-max)) is faster."
109cfe4e 786 (interactive "^P")
d34c311a 787 (or (consp arg) (region-active-p) (push-mark))
c66587fe 788 (let ((size (- (point-max) (point-min))))
a416e7ef 789 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
790 (- (point-max)
791 (if (> size 10000)
792 ;; Avoid overflow for large buffer sizes!
793 (* (prefix-numeric-value arg)
794 (/ size 10))
795 (/ (* size (prefix-numeric-value arg)) 10)))
796 (point-max))))
3a801d0c
ER
797 ;; If we went to a place in the middle of the buffer,
798 ;; adjust it to the beginning of a line.
d7e7ecd7 799 (cond ((and arg (not (consp arg))) (forward-line 1))
919f2812 800 ((> (point) (window-end nil t))
314808dc
GM
801 ;; If the end of the buffer is not already on the screen,
802 ;; then scroll specially to put it near, but not at, the bottom.
803 (overlay-recenter (point))
804 (recenter -3))))
2076c87c 805
b9229673
CY
806(defcustom delete-active-region t
807 "Whether single-char deletion commands delete an active region.
808This has an effect only if Transient Mark mode is enabled, and
809affects `delete-forward-char' and `delete-backward-char', though
810not `delete-char'.
811
812If the value is the symbol `kill', the active region is killed
813instead of deleted."
814 :type '(choice (const :tag "Delete active region" t)
815 (const :tag "Kill active region" kill)
816 (const :tag "Do ordinary deletion" nil))
817 :group 'editing
818 :version "24.1")
819
820(defun delete-backward-char (n &optional killflag)
821 "Delete the previous N characters (following if N is negative).
822If Transient Mark mode is enabled, the mark is active, and N is 1,
823delete the text in the region and deactivate the mark instead.
824To disable this, set `delete-active-region' to nil.
825
826Optional second arg KILLFLAG, if non-nil, means to kill (save in
827kill ring) instead of delete. Interactively, N is the prefix
828arg, and KILLFLAG is set if N is explicitly specified.
829
830In Overwrite mode, single character backward deletion may replace
831tabs with spaces so as to back over columns, unless point is at
832the end of the line."
833 (interactive "p\nP")
834 (unless (integerp n)
835 (signal 'wrong-type-argument (list 'integerp n)))
836 (cond ((and (use-region-p)
837 delete-active-region
838 (= n 1))
839 ;; If a region is active, kill or delete it.
840 (if (eq delete-active-region 'kill)
841 (kill-region (region-beginning) (region-end))
842 (delete-region (region-beginning) (region-end))))
843 ;; In Overwrite mode, maybe untabify while deleting
844 ((null (or (null overwrite-mode)
845 (<= n 0)
846 (memq (char-before) '(?\t ?\n))
847 (eobp)
848 (eq (char-after) ?\n)))
06b60517
JB
849 (let ((ocol (current-column)))
850 (delete-char (- n) killflag)
b9229673
CY
851 (save-excursion
852 (insert-char ?\s (- ocol (current-column)) nil))))
853 ;; Otherwise, do simple deletion.
854 (t (delete-char (- n) killflag))))
855
856(defun delete-forward-char (n &optional killflag)
4c5130d6 857 "Delete the following N characters (previous if N is negative).
b9229673
CY
858If Transient Mark mode is enabled, the mark is active, and N is 1,
859delete the text in the region and deactivate the mark instead.
860To disable this, set `delete-active-region' to nil.
861
862Optional second arg KILLFLAG non-nil means to kill (save in kill
863ring) instead of delete. Interactively, N is the prefix arg, and
864KILLFLAG is set if N was explicitly specified."
865 (interactive "p\nP")
866 (unless (integerp n)
867 (signal 'wrong-type-argument (list 'integerp n)))
868 (cond ((and (use-region-p)
869 delete-active-region
870 (= n 1))
871 ;; If a region is active, kill or delete it.
872 (if (eq delete-active-region 'kill)
873 (kill-region (region-beginning) (region-end))
874 (delete-region (region-beginning) (region-end))))
875 ;; Otherwise, do simple deletion.
876 (t (delete-char n killflag))))
877
2076c87c 878(defun mark-whole-buffer ()
70e14c01
JB
879 "Put point at beginning and mark at end of buffer.
880You probably should not use this function in Lisp programs;
881it is usually a mistake for a Lisp function to use any subroutine
882that uses or sets the mark."
2076c87c
JB
883 (interactive)
884 (push-mark (point))
fd0f4056 885 (push-mark (point-max) nil t)
2076c87c 886 (goto-char (point-min)))
2d88b556 887\f
eaae8106 888
93be67de
KH
889;; Counting lines, one way or another.
890
9af967bd
LK
891(defun goto-line (line &optional buffer)
892 "Goto LINE, counting from line 1 at beginning of buffer.
893Normally, move point in the current buffer, and leave mark at the
894previous position. With just \\[universal-argument] as argument,
a5785534 895move point in the most recently selected other buffer, and switch to it.
9af967bd 896
a5785534
SM
897If there's a number in the buffer at point, it is the default for LINE.
898
899This function is usually the wrong thing to use in a Lisp program.
900What you probably want instead is something like:
901 (goto-char (point-min)) (forward-line (1- N))
902If at all possible, an even better solution is to use char counts
903rather than line counts."
00a369ac
RS
904 (interactive
905 (if (and current-prefix-arg (not (consp current-prefix-arg)))
906 (list (prefix-numeric-value current-prefix-arg))
907 ;; Look for a default, a number in the buffer at point.
908 (let* ((default
909 (save-excursion
910 (skip-chars-backward "0-9")
911 (if (looking-at "[0-9]")
a514d856
JM
912 (string-to-number
913 (buffer-substring-no-properties
914 (point)
915 (progn (skip-chars-forward "0-9")
916 (point)))))))
00a369ac
RS
917 ;; Decide if we're switching buffers.
918 (buffer
919 (if (consp current-prefix-arg)
920 (other-buffer (current-buffer) t)))
921 (buffer-prompt
922 (if buffer
923 (concat " in " (buffer-name buffer))
924 "")))
925 ;; Read the argument, offering that number (if any) as default.
fb5b2591
SM
926 (list (read-number (format (if default "Goto line%s (%s): "
927 "Goto line%s: ")
928 buffer-prompt
929 default)
930 default)
00a369ac
RS
931 buffer))))
932 ;; Switch to the desired buffer, one way or another.
933 (if buffer
934 (let ((window (get-buffer-window buffer)))
935 (if window (select-window window)
936 (switch-to-buffer-other-window buffer))))
f564644b 937 ;; Leave mark at previous position
d34c311a 938 (or (region-active-p) (push-mark))
00a369ac 939 ;; Move to the specified line number in that buffer.
93be67de
KH
940 (save-restriction
941 (widen)
a5785534 942 (goto-char (point-min))
93be67de 943 (if (eq selective-display t)
9af967bd
LK
944 (re-search-forward "[\n\C-m]" nil 'end (1- line))
945 (forward-line (1- line)))))
2076c87c 946
8da5345f 947(defun count-words-region (start end)
b2b0776e
CY
948 "Return the number of words between START and END.
949If called interactively, print a message reporting the number of
950lines, words, and characters in the region."
951 (interactive "r")
952 (let ((words 0))
8da5345f
HN
953 (save-excursion
954 (save-restriction
955 (narrow-to-region start end)
956 (goto-char (point-min))
957 (while (forward-word 1)
b2b0776e 958 (setq words (1+ words)))))
fece895e 959 (when (called-interactively-p 'interactive)
b2b0776e
CY
960 (count-words--message "Region"
961 (count-lines start end)
962 words
963 (- end start)))
964 words))
965
966(defun count-words ()
967 "Display the number of lines, words, and characters in the buffer.
968In Transient Mark mode when the mark is active, display the
969number of lines, words, and characters in the region."
970 (interactive)
971 (if (use-region-p)
972 (call-interactively 'count-words-region)
973 (let* ((beg (point-min))
974 (end (point-max))
975 (lines (count-lines beg end))
976 (words (count-words-region beg end))
977 (chars (- end beg)))
978 (count-words--message "Buffer" lines words chars))))
979
980(defun count-words--message (str lines words chars)
981 (message "%s has %d line%s, %d word%s, and %d character%s."
982 str
983 lines (if (= lines 1) "" "s")
984 words (if (= words 1) "" "s")
985 chars (if (= chars 1) "" "s")))
986
987(defalias 'count-lines-region 'count-words-region)
2076c87c
JB
988
989(defun what-line ()
2578be76 990 "Print the current buffer line number and narrowed line number of point."
2076c87c 991 (interactive)
c6db81aa 992 (let ((start (point-min))
6b61353c
KH
993 (n (line-number-at-pos)))
994 (if (= start 1)
995 (message "Line %d" n)
996 (save-excursion
997 (save-restriction
998 (widen)
999 (message "line %d (narrowed line %d)"
1000 (+ n (line-number-at-pos start) -1) n))))))
2578be76 1001
2076c87c
JB
1002(defun count-lines (start end)
1003 "Return number of lines between START and END.
1004This is usually the number of newlines between them,
ff1fbe3e 1005but can be one more if START is not equal to END
2076c87c 1006and the greater of them is not at the start of a line."
e406700d
RS
1007 (save-excursion
1008 (save-restriction
1009 (narrow-to-region start end)
1010 (goto-char (point-min))
1011 (if (eq selective-display t)
1012 (save-match-data
dde92ca6 1013 (let ((done 0))
fece895e
RT
1014 (while (re-search-forward "[\n\C-m]" nil t 40)
1015 (setq done (+ 40 done)))
1016 (while (re-search-forward "[\n\C-m]" nil t 1)
1017 (setq done (+ 1 done)))
1018 (goto-char (point-max))
1019 (if (and (/= start end)
043efc41
RS
1020 (not (bolp)))
1021 (1+ done)
e406700d
RS
1022 done)))
1023 (- (buffer-size) (forward-line (buffer-size)))))))
eaae8106 1024
6b61353c
KH
1025(defun line-number-at-pos (&optional pos)
1026 "Return (narrowed) buffer line number at position POS.
79ffb765
RS
1027If POS is nil, use current buffer location.
1028Counting starts at (point-min), so the value refers
1029to the contents of the accessible portion of the buffer."
6b61353c
KH
1030 (let ((opoint (or pos (point))) start)
1031 (save-excursion
1032 (goto-char (point-min))
1033 (setq start (point))
1034 (goto-char opoint)
1035 (forward-line 0)
1036 (1+ (count-lines start (point))))))
1037
d5d99b80
KH
1038(defun what-cursor-position (&optional detail)
1039 "Print info on cursor position (on screen and within buffer).
e38dff0c 1040Also describe the character after point, and give its character code
c6fcc518
KH
1041in octal, decimal and hex.
1042
1043For a non-ASCII multibyte character, also give its encoding in the
1044buffer's selected coding system if the coding system encodes the
1045character safely. If the character is encoded into one byte, that
1046code is shown in hex. If the character is encoded into more than one
1047byte, just \"...\" is shown.
e5a902cf 1048
24dad5d5 1049In addition, with prefix argument, show details about that character
0b69eec5 1050in *Help* buffer. See also the command `describe-char'."
d5d99b80 1051 (interactive "P")
2076c87c 1052 (let* ((char (following-char))
12587bbb
EZ
1053 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1054 ;; start a directional embedding, which could completely
1055 ;; disrupt the rest of the line (e.g., RLO will display the
1056 ;; rest of the line right-to-left). So we put an invisible
1057 ;; PDF character after these characters, to end the
1058 ;; embedding, which eliminates any effects on the rest of the
1059 ;; line.
1060 (pdf (if (memq char '(?\x202a ?\x202b ?\x202d ?\x202e))
1061 (propertize (string ?\x202c) 'invisible t)
1062 ""))
2076c87c
JB
1063 (beg (point-min))
1064 (end (point-max))
1065 (pos (point))
1066 (total (buffer-size))
1067 (percent (if (> total 50000)
1068 ;; Avoid overflow from multiplying by 100!
1069 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
1070 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
1071 (hscroll (if (= (window-hscroll) 0)
1072 ""
1073 (format " Hscroll=%d" (window-hscroll))))
1074 (col (current-column)))
1075 (if (= pos end)
1076 (if (or (/= beg 1) (/= end (1+ total)))
a17a79c0 1077 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
2076c87c 1078 pos total percent beg end col hscroll)
a17a79c0 1079 (message "point=%d of %d (EOB) column=%d%s"
63219d53 1080 pos total col hscroll))
c6fcc518 1081 (let ((coding buffer-file-coding-system)
a41b50ca 1082 encoded encoding-msg display-prop under-display)
c6fcc518
KH
1083 (if (or (not coding)
1084 (eq (coding-system-type coding) t))
b56a5ae0 1085 (setq coding (default-value 'buffer-file-coding-system)))
8f924df7 1086 (if (eq (char-charset char) 'eight-bit)
28fd4883 1087 (setq encoding-msg
41882805 1088 (format "(%d, #o%o, #x%x, raw-byte)" char char char))
a41b50ca
KH
1089 ;; Check if the character is displayed with some `display'
1090 ;; text property. In that case, set under-display to the
1091 ;; buffer substring covered by that property.
d4ef2b50 1092 (setq display-prop (get-char-property pos 'display))
a41b50ca 1093 (if display-prop
d4ef2b50 1094 (let ((to (or (next-single-char-property-change pos 'display)
a41b50ca
KH
1095 (point-max))))
1096 (if (< to (+ pos 4))
1097 (setq under-display "")
1098 (setq under-display "..."
1099 to (+ pos 4)))
1100 (setq under-display
1101 (concat (buffer-substring-no-properties pos to)
1102 under-display)))
1103 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
28fd4883 1104 (setq encoding-msg
a41b50ca
KH
1105 (if display-prop
1106 (if (not (stringp display-prop))
a17a79c0 1107 (format "(%d, #o%o, #x%x, part of display \"%s\")"
a41b50ca 1108 char char char under-display)
a17a79c0 1109 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
a41b50ca
KH
1110 char char char under-display display-prop))
1111 (if encoded
a17a79c0 1112 (format "(%d, #o%o, #x%x, file %s)"
a41b50ca
KH
1113 char char char
1114 (if (> (length encoded) 1)
1115 "..."
1116 (encoded-string-description encoded coding)))
a17a79c0 1117 (format "(%d, #o%o, #x%x)" char char char)))))
e5e89e48 1118 (if detail
24dad5d5 1119 ;; We show the detailed information about CHAR.
0b69eec5 1120 (describe-char (point)))
24dad5d5 1121 (if (or (/= beg 1) (/= end (1+ total)))
12587bbb 1122 (message "Char: %s%s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
e5a902cf
KH
1123 (if (< char 256)
1124 (single-key-description char)
f0d16a7f 1125 (buffer-substring-no-properties (point) (1+ (point))))
12587bbb
EZ
1126 pdf encoding-msg pos total percent beg end col hscroll)
1127 (message "Char: %s%s %s point=%d of %d (%d%%) column=%d%s"
a41b50ca
KH
1128 (if enable-multibyte-characters
1129 (if (< char 128)
1130 (single-key-description char)
1131 (buffer-substring-no-properties (point) (1+ (point))))
1132 (single-key-description char))
12587bbb 1133 pdf encoding-msg pos total percent col hscroll))))))
2d88b556 1134\f
71a05b36
RS
1135;; Initialize read-expression-map. It is defined at C level.
1136(let ((m (make-sparse-keymap)))
1137 (define-key m "\M-\t" 'lisp-complete-symbol)
1bcace58
SM
1138 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1139 ;; too rarely useful.
1140 (define-key m "\t" 'lisp-complete-symbol)
71a05b36
RS
1141 (set-keymap-parent m minibuffer-local-map)
1142 (setq read-expression-map m))
854c16c5 1143
ad6aa5ed
CY
1144(defvar minibuffer-completing-symbol nil
1145 "Non-nil means completing a Lisp symbol in the minibuffer.")
2403c841 1146(make-obsolete-variable 'minibuffer-completing-symbol nil "24.1" 'get)
ad6aa5ed 1147
d658acb6
CY
1148(defvar minibuffer-default nil
1149 "The current default value or list of default values in the minibuffer.
1150The functions `read-from-minibuffer' and `completing-read' bind
1151this variable locally.")
1152
b49df39d 1153(defcustom eval-expression-print-level 4
2f7e1f5a 1154 "Value for `print-level' while printing value in `eval-expression'.
d26b26dc 1155A value of nil means no limit."
b49df39d 1156 :group 'lisp
058d4999 1157 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
1158 :version "21.1")
1159
1160(defcustom eval-expression-print-length 12
2f7e1f5a 1161 "Value for `print-length' while printing value in `eval-expression'.
d26b26dc 1162A value of nil means no limit."
b49df39d 1163 :group 'lisp
058d4999 1164 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
1165 :version "21.1")
1166
1167(defcustom eval-expression-debug-on-error t
2f7e1f5a 1168 "If non-nil set `debug-on-error' to t in `eval-expression'.
ed8bcabe 1169If nil, don't change the value of `debug-on-error'."
b49df39d
RS
1170 :group 'lisp
1171 :type 'boolean
1172 :version "21.1")
1173
fa219ebd
JL
1174(defun eval-expression-print-format (value)
1175 "Format VALUE as a result of evaluated expression.
1176Return a formatted string which is displayed in the echo area
1177in addition to the value printed by prin1 in functions which
1178display the result of expression evaluation."
1179 (if (and (integerp value)
c9f0110e 1180 (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd 1181 (eq this-command last-command)
56abefac 1182 (if (boundp 'edebug-active) edebug-active)))
fa219ebd 1183 (let ((char-string
9bb25ed3 1184 (if (or (if (boundp 'edebug-active) edebug-active)
3137dda8 1185 (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd
JL
1186 (prin1-char value))))
1187 (if char-string
1b5fd09e
SM
1188 (format " (#o%o, #x%x, %s)" value value char-string)
1189 (format " (#o%o, #x%x)" value value)))))
fa219ebd 1190
8570b0ca 1191;; We define this, rather than making `eval' interactive,
ac052b48 1192;; for the sake of completion of names like eval-region, eval-buffer.
ecb7ad00
RS
1193(defun eval-expression (eval-expression-arg
1194 &optional eval-expression-insert-value)
a6a1ee53 1195 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
15853710
LMI
1196When called interactively, read an Emacs Lisp expression and
1197evaluate it.
a6a1ee53 1198Value is also consed on to front of the variable `values'.
a7a8618b
EZ
1199Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1200with prefix argument) means insert the result into the current buffer
1201instead of printing it in the echo area. Truncates long output
1202according to the value of the variables `eval-expression-print-length'
1203and `eval-expression-print-level'.
b4f73994
RS
1204
1205If `eval-expression-debug-on-error' is non-nil, which is the default,
1206this command arranges for all errors to enter the debugger."
adca5fa6 1207 (interactive
ad6aa5ed
CY
1208 (list (let ((minibuffer-completing-symbol t))
1209 (read-from-minibuffer "Eval: "
1210 nil read-expression-map t
1211 'read-expression-history))
ecb7ad00 1212 current-prefix-arg))
eaae8106 1213
ed8bcabe 1214 (if (null eval-expression-debug-on-error)
a0ee6f27 1215 (push (eval eval-expression-arg lexical-binding) values)
ed8bcabe
GM
1216 (let ((old-value (make-symbol "t")) new-value)
1217 ;; Bind debug-on-error to something unique so that we can
1218 ;; detect when evaled code changes it.
1219 (let ((debug-on-error old-value))
a0ee6f27 1220 (push (eval eval-expression-arg lexical-binding) values)
ed8bcabe
GM
1221 (setq new-value debug-on-error))
1222 ;; If evaled code has changed the value of debug-on-error,
1223 ;; propagate that change to the global binding.
1224 (unless (eq old-value new-value)
1225 (setq debug-on-error new-value))))
eaae8106 1226
b49df39d
RS
1227 (let ((print-length eval-expression-print-length)
1228 (print-level eval-expression-print-level))
6b61353c
KH
1229 (if eval-expression-insert-value
1230 (with-no-warnings
1231 (let ((standard-output (current-buffer)))
22e088c6 1232 (prin1 (car values))))
fa219ebd
JL
1233 (prog1
1234 (prin1 (car values) t)
1235 (let ((str (eval-expression-print-format (car values))))
1236 (if str (princ str t)))))))
2076c87c
JB
1237
1238(defun edit-and-eval-command (prompt command)
1239 "Prompting with PROMPT, let user edit COMMAND and eval result.
1240COMMAND is a Lisp expression. Let user edit that expression in
1241the minibuffer, then read and evaluate the result."
9f4b6084 1242 (let ((command
6b61353c
KH
1243 (let ((print-level nil)
1244 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1245 (unwind-protect
1246 (read-from-minibuffer prompt
1247 (prin1-to-string command)
1248 read-expression-map t
1249 'command-history)
1250 ;; If command was added to command-history as a string,
1251 ;; get rid of that. We want only evaluable expressions there.
1252 (if (stringp (car command-history))
1253 (setq command-history (cdr command-history)))))))
5d6c83ae
KH
1254
1255 ;; If command to be redone does not match front of history,
1256 ;; add it to the history.
1257 (or (equal command (car command-history))
1258 (setq command-history (cons command command-history)))
2076c87c
JB
1259 (eval command)))
1260
ebb61177 1261(defun repeat-complex-command (arg)
2076c87c
JB
1262 "Edit and re-evaluate last complex command, or ARGth from last.
1263A complex command is one which used the minibuffer.
1264The command is placed in the minibuffer as a Lisp form for editing.
1265The result is executed, repeating the command as changed.
5626c14e
JB
1266If the command has been changed or is not the most recent previous
1267command it is added to the front of the command history.
1268You can use the minibuffer history commands \
1269\\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
eb6e9899 1270to get different commands to edit and resubmit."
2076c87c 1271 (interactive "p")
ba343182 1272 (let ((elt (nth (1- arg) command-history))
2076c87c
JB
1273 newcmd)
1274 (if elt
854c16c5 1275 (progn
eab22e27 1276 (setq newcmd
74ae5fab
RS
1277 (let ((print-level nil)
1278 (minibuffer-history-position arg)
99ea24de 1279 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
9f4b6084
MR
1280 (unwind-protect
1281 (read-from-minibuffer
1282 "Redo: " (prin1-to-string elt) read-expression-map t
1283 (cons 'command-history arg))
1284
1285 ;; If command was added to command-history as a
1286 ;; string, get rid of that. We want only
1287 ;; evaluable expressions there.
1288 (if (stringp (car command-history))
1289 (setq command-history (cdr command-history))))))
db16f109
RS
1290
1291 ;; If command to be redone does not match front of history,
1292 ;; add it to the history.
1293 (or (equal newcmd (car command-history))
1294 (setq command-history (cons newcmd command-history)))
2076c87c 1295 (eval newcmd))
536b728a
RS
1296 (if command-history
1297 (error "Argument %d is beyond length of command history" arg)
1298 (error "There are no previous complex commands to repeat")))))
7133b7ee
JL
1299
1300(defun read-extended-command ()
1301 "Read command name to invoke in `execute-extended-command'."
1302 (minibuffer-with-setup-hook
1303 (lambda ()
1304 (set (make-local-variable 'minibuffer-default-add-function)
1305 (lambda ()
1306 ;; Get a command name at point in the original buffer
1307 ;; to propose it after M-n.
1308 (with-current-buffer (window-buffer (minibuffer-selected-window))
1309 (and (commandp (function-called-at-point))
1310 (format "%S" (function-called-at-point)))))))
1311 ;; Read a string, completing from and restricting to the set of
1312 ;; all defined commands. Don't provide any initial input.
1313 ;; Save the command read on the extended-command history list.
1314 (completing-read
1315 (concat (cond
1316 ((eq current-prefix-arg '-) "- ")
1317 ((and (consp current-prefix-arg)
1318 (eq (car current-prefix-arg) 4)) "C-u ")
1319 ((and (consp current-prefix-arg)
1320 (integerp (car current-prefix-arg)))
1321 (format "%d " (car current-prefix-arg)))
1322 ((integerp current-prefix-arg)
1323 (format "%d " current-prefix-arg)))
1324 ;; This isn't strictly correct if `execute-extended-command'
1325 ;; is bound to anything else (e.g. [menu]).
1326 ;; It could use (key-description (this-single-command-keys)),
1327 ;; but actually a prompt other than "M-x" would be confusing,
1328 ;; because "M-x" is a well-known prompt to read a command
1329 ;; and it serves as a shorthand for "Extended command: ".
1330 "M-x ")
1331 obarray 'commandp t nil 'extended-command-history)))
1332
2d88b556 1333\f
854c16c5
RS
1334(defvar minibuffer-history nil
1335 "Default minibuffer history list.
1336This is used for all minibuffer input
e5f0c02f
EZ
1337except when an alternate history list is specified.
1338
1339Maximum length of the history list is determined by the value
1340of `history-length', which see.")
854c16c5 1341(defvar minibuffer-history-sexp-flag nil
6b61353c
KH
1342 "Control whether history list elements are expressions or strings.
1343If the value of this variable equals current minibuffer depth,
1344they are expressions; otherwise they are strings.
7979163c 1345\(That convention is designed to do the right thing for
6b61353c 1346recursive uses of the minibuffer.)")
e91f80c4 1347(setq minibuffer-history-variable 'minibuffer-history)
535c8bdb 1348(setq minibuffer-history-position nil) ;; Defvar is in C code.
854c16c5 1349(defvar minibuffer-history-search-history nil)
e91f80c4 1350
93cee14b
RS
1351(defvar minibuffer-text-before-history nil
1352 "Text that was in this minibuffer before any history commands.
1353This is nil if there have not yet been any history commands
1354in this use of the minibuffer.")
1355
1356(add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1357
1358(defun minibuffer-history-initialize ()
1359 (setq minibuffer-text-before-history nil))
1360
06b60517 1361(defun minibuffer-avoid-prompt (_new _old)
6e7d0ff7
MB
1362 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1363 (constrain-to-field nil (point-max)))
1364
6e30a99a 1365(defcustom minibuffer-history-case-insensitive-variables nil
1d2b0303 1366 "Minibuffer history variables for which matching should ignore case.
6e30a99a
RS
1367If a history variable is a member of this list, then the
1368\\[previous-matching-history-element] and \\[next-matching-history-element]\
1369 commands ignore case when searching it, regardless of `case-fold-search'."
1370 :type '(repeat variable)
1371 :group 'minibuffer)
1372
e91f80c4 1373(defun previous-matching-history-element (regexp n)
854c16c5
RS
1374 "Find the previous history element that matches REGEXP.
1375\(Previous history elements refer to earlier actions.)
1376With prefix argument N, search for Nth previous match.
5c2010f0 1377If N is negative, find the next or Nth next match.
9889af08
EZ
1378Normally, history elements are matched case-insensitively if
1379`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1380makes the search case-sensitive.
6e30a99a 1381See also `minibuffer-history-case-insensitive-variables'."
854c16c5 1382 (interactive
c1172a19 1383 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1384 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1385 nil
1386 minibuffer-local-map
1387 nil
5794c45d
RS
1388 'minibuffer-history-search-history
1389 (car minibuffer-history-search-history))))
c1172a19
RS
1390 ;; Use the last regexp specified, by default, if input is empty.
1391 (list (if (string= regexp "")
a8e96cea
KH
1392 (if minibuffer-history-search-history
1393 (car minibuffer-history-search-history)
1394 (error "No previous history search regexp"))
c1172a19 1395 regexp)
854c16c5 1396 (prefix-numeric-value current-prefix-arg))))
e276a14a
MB
1397 (unless (zerop n)
1398 (if (and (zerop minibuffer-history-position)
1399 (null minibuffer-text-before-history))
efaac2e6 1400 (setq minibuffer-text-before-history
6d74d713 1401 (minibuffer-contents-no-properties)))
e276a14a
MB
1402 (let ((history (symbol-value minibuffer-history-variable))
1403 (case-fold-search
1404 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1405 ;; On some systems, ignore case for file names.
1406 (if (memq minibuffer-history-variable
1407 minibuffer-history-case-insensitive-variables)
1408 t
1409 ;; Respect the user's setting for case-fold-search:
1410 case-fold-search)
1411 nil))
1412 prevpos
1413 match-string
1414 match-offset
1415 (pos minibuffer-history-position))
1416 (while (/= n 0)
1417 (setq prevpos pos)
1418 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1419 (when (= pos prevpos)
e91f80c4 1420 (error (if (= pos 1)
ccc58657
RS
1421 "No later matching history item"
1422 "No earlier matching history item")))
e276a14a
MB
1423 (setq match-string
1424 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
7908d27c 1425 (let ((print-level nil))
e276a14a
MB
1426 (prin1-to-string (nth (1- pos) history)))
1427 (nth (1- pos) history)))
1428 (setq match-offset
1429 (if (< n 0)
1430 (and (string-match regexp match-string)
1431 (match-end 0))
1432 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1433 (match-beginning 1))))
1434 (when match-offset
1435 (setq n (+ n (if (< n 0) 1 -1)))))
1436 (setq minibuffer-history-position pos)
1437 (goto-char (point-max))
efaac2e6 1438 (delete-minibuffer-contents)
e276a14a 1439 (insert match-string)
6d74d713 1440 (goto-char (+ (minibuffer-prompt-end) match-offset))))
e1e04350
SM
1441 (if (memq (car (car command-history)) '(previous-matching-history-element
1442 next-matching-history-element))
854c16c5 1443 (setq command-history (cdr command-history))))
e91f80c4 1444
e91f80c4 1445(defun next-matching-history-element (regexp n)
854c16c5
RS
1446 "Find the next history element that matches REGEXP.
1447\(The next history element refers to a more recent action.)
1448With prefix argument N, search for Nth next match.
5c2010f0 1449If N is negative, find the previous or Nth previous match.
9889af08
EZ
1450Normally, history elements are matched case-insensitively if
1451`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1452makes the search case-sensitive."
854c16c5 1453 (interactive
c1172a19 1454 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1455 (regexp (read-from-minibuffer "Next element matching (regexp): "
1456 nil
1457 minibuffer-local-map
1458 nil
e967cd11
RS
1459 'minibuffer-history-search-history
1460 (car minibuffer-history-search-history))))
c1172a19
RS
1461 ;; Use the last regexp specified, by default, if input is empty.
1462 (list (if (string= regexp "")
e967cd11
RS
1463 (if minibuffer-history-search-history
1464 (car minibuffer-history-search-history)
1465 (error "No previous history search regexp"))
c1172a19 1466 regexp)
854c16c5 1467 (prefix-numeric-value current-prefix-arg))))
e91f80c4 1468 (previous-matching-history-element regexp (- n)))
2076c87c 1469
8dc3ba7d
MB
1470(defvar minibuffer-temporary-goal-position nil)
1471
7f914bbe 1472(defvar minibuffer-default-add-function 'minibuffer-default-add-completions
0eb5f40f
JL
1473 "Function run by `goto-history-element' before consuming default values.
1474This is useful to dynamically add more elements to the list of default values
7f914bbe
JL
1475when `goto-history-element' reaches the end of this list.
1476Before calling this function `goto-history-element' sets the variable
1477`minibuffer-default-add-done' to t, so it will call this function only
1478once. In special cases, when this function needs to be called more
1479than once, it can set `minibuffer-default-add-done' to nil explicitly,
1480overriding the setting of this variable to t in `goto-history-element'.")
1481
1482(defvar minibuffer-default-add-done nil
1483 "When nil, add more elements to the end of the list of default values.
1484The value nil causes `goto-history-element' to add more elements to
1485the list of defaults when it reaches the end of this list. It does
1486this by calling a function defined by `minibuffer-default-add-function'.")
1487
1488(make-variable-buffer-local 'minibuffer-default-add-done)
1489
1490(defun minibuffer-default-add-completions ()
1491 "Return a list of all completions without the default value.
1492This function is used to add all elements of the completion table to
1493the end of the list of defaults just after the default value."
7f914bbe
JL
1494 (let ((def minibuffer-default)
1495 (all (all-completions ""
1496 minibuffer-completion-table
e96d62cd 1497 minibuffer-completion-predicate)))
7f914bbe
JL
1498 (if (listp def)
1499 (append def all)
1500 (cons def (delete def all)))))
1501
297b8ccd
JL
1502(defun goto-history-element (nabs)
1503 "Puts element of the minibuffer history in the minibuffer.
1504The argument NABS specifies the absolute history position."
1505 (interactive "p")
7f914bbe
JL
1506 (when (and (not minibuffer-default-add-done)
1507 (functionp minibuffer-default-add-function)
1508 (< nabs (- (if (listp minibuffer-default)
1509 (length minibuffer-default)
1510 1))))
1511 (setq minibuffer-default-add-done t
1512 minibuffer-default (funcall minibuffer-default-add-function)))
b38fc7f1
JL
1513 (let ((minimum (if minibuffer-default
1514 (- (if (listp minibuffer-default)
1515 (length minibuffer-default)
1516 1))
1517 0))
297b8ccd
JL
1518 elt minibuffer-returned-to-present)
1519 (if (and (zerop minibuffer-history-position)
1520 (null minibuffer-text-before-history))
1521 (setq minibuffer-text-before-history
1522 (minibuffer-contents-no-properties)))
1523 (if (< nabs minimum)
1524 (if minibuffer-default
7f914bbe 1525 (error "End of defaults; no next item")
297b8ccd
JL
1526 (error "End of history; no default available")))
1527 (if (> nabs (length (symbol-value minibuffer-history-variable)))
1528 (error "Beginning of history; no preceding item"))
1529 (unless (memq last-command '(next-history-element
1530 previous-history-element))
1531 (let ((prompt-end (minibuffer-prompt-end)))
1532 (set (make-local-variable 'minibuffer-temporary-goal-position)
1533 (cond ((<= (point) prompt-end) prompt-end)
1534 ((eobp) nil)
1535 (t (point))))))
1536 (goto-char (point-max))
1537 (delete-minibuffer-contents)
1538 (setq minibuffer-history-position nabs)
b38fc7f1
JL
1539 (cond ((< nabs 0)
1540 (setq elt (if (listp minibuffer-default)
1541 (nth (1- (abs nabs)) minibuffer-default)
1542 minibuffer-default)))
297b8ccd
JL
1543 ((= nabs 0)
1544 (setq elt (or minibuffer-text-before-history ""))
1545 (setq minibuffer-returned-to-present t)
1546 (setq minibuffer-text-before-history nil))
1547 (t (setq elt (nth (1- minibuffer-history-position)
1548 (symbol-value minibuffer-history-variable)))))
1549 (insert
1550 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1551 (not minibuffer-returned-to-present))
1552 (let ((print-level nil))
1553 (prin1-to-string elt))
1554 elt))
1555 (goto-char (or minibuffer-temporary-goal-position (point-max)))))
1556
ebb61177 1557(defun next-history-element (n)
1459a43b
RS
1558 "Puts next element of the minibuffer history in the minibuffer.
1559With argument N, it uses the Nth following element."
2076c87c 1560 (interactive "p")
0818b15e 1561 (or (zerop n)
297b8ccd 1562 (goto-history-element (- minibuffer-history-position n))))
2076c87c 1563
ebb61177 1564(defun previous-history-element (n)
1459a43b
RS
1565 "Puts previous element of the minibuffer history in the minibuffer.
1566With argument N, it uses the Nth previous element."
2076c87c 1567 (interactive "p")
297b8ccd
JL
1568 (or (zerop n)
1569 (goto-history-element (+ minibuffer-history-position n))))
d0678801
RM
1570
1571(defun next-complete-history-element (n)
a4d1159b
GM
1572 "Get next history element which completes the minibuffer before the point.
1573The contents of the minibuffer after the point are deleted, and replaced
1574by the new completion."
d0678801 1575 (interactive "p")
b5e6f936
RM
1576 (let ((point-at-start (point)))
1577 (next-matching-history-element
a4d1159b 1578 (concat
efaac2e6 1579 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
a4d1159b 1580 n)
b5e6f936
RM
1581 ;; next-matching-history-element always puts us at (point-min).
1582 ;; Move to the position we were at before changing the buffer contents.
1583 ;; This is still sensical, because the text before point has not changed.
1584 (goto-char point-at-start)))
d0678801
RM
1585
1586(defun previous-complete-history-element (n)
1f6fcec3 1587 "\
a4d1159b
GM
1588Get previous history element which completes the minibuffer before the point.
1589The contents of the minibuffer after the point are deleted, and replaced
1590by the new completion."
d0678801
RM
1591 (interactive "p")
1592 (next-complete-history-element (- n)))
a4d1159b 1593
efaac2e6 1594;; For compatibility with the old subr of the same name.
a4d1159b
GM
1595(defun minibuffer-prompt-width ()
1596 "Return the display width of the minibuffer prompt.
f33321ad 1597Return 0 if current buffer is not a minibuffer."
a4d1159b
GM
1598 ;; Return the width of everything before the field at the end of
1599 ;; the buffer; this should be 0 for normal buffers.
efaac2e6 1600 (1- (minibuffer-prompt-end)))
2d88b556 1601\f
297b8ccd
JL
1602;; isearch minibuffer history
1603(add-hook 'minibuffer-setup-hook 'minibuffer-history-isearch-setup)
1604
1605(defvar minibuffer-history-isearch-message-overlay)
1606(make-variable-buffer-local 'minibuffer-history-isearch-message-overlay)
1607
1608(defun minibuffer-history-isearch-setup ()
1609 "Set up a minibuffer for using isearch to search the minibuffer history.
1610Intended to be added to `minibuffer-setup-hook'."
1611 (set (make-local-variable 'isearch-search-fun-function)
1612 'minibuffer-history-isearch-search)
1613 (set (make-local-variable 'isearch-message-function)
1614 'minibuffer-history-isearch-message)
1615 (set (make-local-variable 'isearch-wrap-function)
1616 'minibuffer-history-isearch-wrap)
1617 (set (make-local-variable 'isearch-push-state-function)
1618 'minibuffer-history-isearch-push-state)
1619 (add-hook 'isearch-mode-end-hook 'minibuffer-history-isearch-end nil t))
1620
1621(defun minibuffer-history-isearch-end ()
1622 "Clean up the minibuffer after terminating isearch in the minibuffer."
1623 (if minibuffer-history-isearch-message-overlay
1624 (delete-overlay minibuffer-history-isearch-message-overlay)))
1625
1626(defun minibuffer-history-isearch-search ()
1627 "Return the proper search function, for isearch in minibuffer history."
1628 (cond
1629 (isearch-word
1630 (if isearch-forward 'word-search-forward 'word-search-backward))
1631 (t
1632 (lambda (string bound noerror)
1633 (let ((search-fun
1634 ;; Use standard functions to search within minibuffer text
1635 (cond
1636 (isearch-regexp
1637 (if isearch-forward 're-search-forward 're-search-backward))
1638 (t
1639 (if isearch-forward 'search-forward 'search-backward))))
1640 found)
1641 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1642 ;; searching forward. Lazy-highlight calls this lambda with the
1643 ;; bound arg, so skip the minibuffer prompt.
1644 (if (and bound isearch-forward (< (point) (minibuffer-prompt-end)))
1645 (goto-char (minibuffer-prompt-end)))
1646 (or
1647 ;; 1. First try searching in the initial minibuffer text
1648 (funcall search-fun string
1649 (if isearch-forward bound (minibuffer-prompt-end))
1650 noerror)
1651 ;; 2. If the above search fails, start putting next/prev history
1652 ;; elements in the minibuffer successively, and search the string
1653 ;; in them. Do this only when bound is nil (i.e. not while
1654 ;; lazy-highlighting search strings in the current minibuffer text).
1655 (unless bound
1656 (condition-case nil
1657 (progn
1658 (while (not found)
1659 (cond (isearch-forward
1660 (next-history-element 1)
1661 (goto-char (minibuffer-prompt-end)))
1662 (t
1663 (previous-history-element 1)
1664 (goto-char (point-max))))
1665 (setq isearch-barrier (point) isearch-opoint (point))
1666 ;; After putting the next/prev history element, search
1667 ;; the string in them again, until next-history-element
1668 ;; or previous-history-element raises an error at the
1669 ;; beginning/end of history.
1670 (setq found (funcall search-fun string
1671 (unless isearch-forward
1672 ;; For backward search, don't search
1673 ;; in the minibuffer prompt
1674 (minibuffer-prompt-end))
1675 noerror)))
1676 ;; Return point of the new search result
1677 (point))
1678 ;; Return nil when next(prev)-history-element fails
1679 (error nil)))))))))
1680
1681(defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis)
1682 "Display the minibuffer history search prompt.
1683If there are no search errors, this function displays an overlay with
1684the isearch prompt which replaces the original minibuffer prompt.
1685Otherwise, it displays the standard isearch message returned from
1686`isearch-message'."
1687 (if (not (and (minibufferp) isearch-success (not isearch-error)))
1688 ;; Use standard function `isearch-message' when not in the minibuffer,
1689 ;; or search fails, or has an error (like incomplete regexp).
1690 ;; This function overwrites minibuffer text with isearch message,
1691 ;; so it's possible to see what is wrong in the search string.
1692 (isearch-message c-q-hack ellipsis)
1693 ;; Otherwise, put the overlay with the standard isearch prompt over
1694 ;; the initial minibuffer prompt.
1695 (if (overlayp minibuffer-history-isearch-message-overlay)
1696 (move-overlay minibuffer-history-isearch-message-overlay
1697 (point-min) (minibuffer-prompt-end))
1698 (setq minibuffer-history-isearch-message-overlay
1699 (make-overlay (point-min) (minibuffer-prompt-end)))
1700 (overlay-put minibuffer-history-isearch-message-overlay 'evaporate t))
1701 (overlay-put minibuffer-history-isearch-message-overlay
1702 'display (isearch-message-prefix c-q-hack ellipsis))
1703 ;; And clear any previous isearch message.
1704 (message "")))
1705
1706(defun minibuffer-history-isearch-wrap ()
1d2b0303 1707 "Wrap the minibuffer history search when search fails.
297b8ccd
JL
1708Move point to the first history element for a forward search,
1709or to the last history element for a backward search."
1710 (unless isearch-word
1711 ;; When `minibuffer-history-isearch-search' fails on reaching the
1712 ;; beginning/end of the history, wrap the search to the first/last
1713 ;; minibuffer history element.
1714 (if isearch-forward
1715 (goto-history-element (length (symbol-value minibuffer-history-variable)))
1716 (goto-history-element 0))
1717 (setq isearch-success t))
1718 (goto-char (if isearch-forward (minibuffer-prompt-end) (point-max))))
1719
1720(defun minibuffer-history-isearch-push-state ()
1721 "Save a function restoring the state of minibuffer history search.
1722Save `minibuffer-history-position' to the additional state parameter
1723in the search status stack."
1724 `(lambda (cmd)
1725 (minibuffer-history-isearch-pop-state cmd ,minibuffer-history-position)))
1726
06b60517 1727(defun minibuffer-history-isearch-pop-state (_cmd hist-pos)
297b8ccd 1728 "Restore the minibuffer history search state.
5626c14e 1729Go to the history element by the absolute history position HIST-POS."
297b8ccd
JL
1730 (goto-history-element hist-pos))
1731
1732\f
2076c87c 1733;Put this on C-x u, so we can force that rather than C-_ into startup msg
8cb95edf 1734(define-obsolete-function-alias 'advertised-undo 'undo "23.2")
2076c87c 1735
1e96c007 1736(defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
713c9020
RS
1737 "Table mapping redo records to the corresponding undo one.
1738A redo record for undo-in-region maps to t.
1739A redo record for ordinary undo maps to the following (earlier) undo.")
1e96c007
SM
1740
1741(defvar undo-in-region nil
1742 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
1743
1744(defvar undo-no-redo nil
1745 "If t, `undo' doesn't go through redo entries.")
1746
a7fe694c
RS
1747(defvar pending-undo-list nil
1748 "Within a run of consecutive undo commands, list remaining to be undone.
8ac28be5 1749If t, we undid all the way to the end of it.")
a7fe694c 1750
2076c87c
JB
1751(defun undo (&optional arg)
1752 "Undo some previous changes.
1753Repeat this command to undo more changes.
5626c14e 1754A numeric ARG serves as a repeat count.
65627aad 1755
3c1b77ca 1756In Transient Mark mode when the mark is active, only undo changes within
1e96c007 1757the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
3c1b77ca 1758as an argument limits undo to changes within the current region."
65627aad 1759 (interactive "*P")
2e033693
RS
1760 ;; Make last-command indicate for the next command that this was an undo.
1761 ;; That way, another undo will undo more.
1762 ;; If we get to the end of the undo history and get an error,
1763 ;; another undo command will find the undo history empty
1764 ;; and will get another error. To begin undoing the undos,
1765 ;; you must type some other command.
b553cffa 1766 (let ((modified (buffer-modified-p))
cb3b2ec0
RS
1767 (recent-save (recent-auto-save-p))
1768 message)
6b61353c
KH
1769 ;; If we get an error in undo-start,
1770 ;; the next command should not be a "consecutive undo".
1771 ;; So set `this-command' to something other than `undo'.
1772 (setq this-command 'undo-start)
1773
e967cd11 1774 (unless (and (eq last-command 'undo)
a7fe694c
RS
1775 (or (eq pending-undo-list t)
1776 ;; If something (a timer or filter?) changed the buffer
1777 ;; since the previous command, don't continue the undo seq.
1778 (let ((list buffer-undo-list))
1779 (while (eq (car list) nil)
1780 (setq list (cdr list)))
1781 ;; If the last undo record made was made by undo
1782 ;; it shows nothing else happened in between.
1783 (gethash list undo-equiv-table))))
1e96c007 1784 (setq undo-in-region
d34c311a 1785 (or (region-active-p) (and arg (not (numberp arg)))))
1e96c007 1786 (if undo-in-region
3c1b77ca
MB
1787 (undo-start (region-beginning) (region-end))
1788 (undo-start))
1789 ;; get rid of initial undo boundary
1790 (undo-more 1))
9a1120ea 1791 ;; If we got this far, the next command should be a consecutive undo.
6b61353c 1792 (setq this-command 'undo)
1e96c007
SM
1793 ;; Check to see whether we're hitting a redo record, and if
1794 ;; so, ask the user whether she wants to skip the redo/undo pair.
1795 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
1796 (or (eq (selected-window) (minibuffer-window))
cb3b2ec0
RS
1797 (setq message (if undo-in-region
1798 (if equiv "Redo in region!" "Undo in region!")
1799 (if equiv "Redo!" "Undo!"))))
0047373b 1800 (when (and (consp equiv) undo-no-redo)
1e96c007
SM
1801 ;; The equiv entry might point to another redo record if we have done
1802 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1803 (while (let ((next (gethash equiv undo-equiv-table)))
1804 (if next (setq equiv next))))
1805 (setq pending-undo-list equiv)))
3c1b77ca 1806 (undo-more
d34c311a 1807 (if (numberp arg)
3c1b77ca
MB
1808 (prefix-numeric-value arg)
1809 1))
1e96c007 1810 ;; Record the fact that the just-generated undo records come from an
713c9020
RS
1811 ;; undo operation--that is, they are redo records.
1812 ;; In the ordinary case (not within a region), map the redo
1813 ;; record to the following undos.
1e96c007 1814 ;; I don't know how to do that in the undo-in-region case.
86f0d932
SM
1815 (let ((list buffer-undo-list))
1816 ;; Strip any leading undo boundaries there might be, like we do
1817 ;; above when checking.
1818 (while (eq (car list) nil)
1819 (setq list (cdr list)))
1820 (puthash list (if undo-in-region t pending-undo-list)
1821 undo-equiv-table))
2512c9f0
RS
1822 ;; Don't specify a position in the undo record for the undo command.
1823 ;; Instead, undoing this should move point to where the change is.
1824 (let ((tail buffer-undo-list)
003550c5
GM
1825 (prev nil))
1826 (while (car tail)
1827 (when (integerp (car tail))
1828 (let ((pos (car tail)))
1e96c007
SM
1829 (if prev
1830 (setcdr prev (cdr tail))
1831 (setq buffer-undo-list (cdr tail)))
003550c5
GM
1832 (setq tail (cdr tail))
1833 (while (car tail)
1834 (if (eq pos (car tail))
1835 (if prev
1836 (setcdr prev (cdr tail))
1837 (setq buffer-undo-list (cdr tail)))
1838 (setq prev tail))
1839 (setq tail (cdr tail)))
1840 (setq tail nil)))
1841 (setq prev tail tail (cdr tail))))
e967cd11
RS
1842 ;; Record what the current undo list says,
1843 ;; so the next command can tell if the buffer was modified in between.
2076c87c 1844 (and modified (not (buffer-modified-p))
cb3b2ec0
RS
1845 (delete-auto-save-file-if-necessary recent-save))
1846 ;; Display a message announcing success.
1847 (if message
f6e7ec02 1848 (message "%s" message))))
2076c87c 1849
e967cd11
RS
1850(defun buffer-disable-undo (&optional buffer)
1851 "Make BUFFER stop keeping undo information.
1852No argument or nil as argument means do this for the current buffer."
1853 (interactive)
0d808a63 1854 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
d020fce0 1855 (setq buffer-undo-list t)))
e967cd11 1856
1e96c007
SM
1857(defun undo-only (&optional arg)
1858 "Undo some previous changes.
1859Repeat this command to undo more changes.
5626c14e 1860A numeric ARG serves as a repeat count.
1e96c007
SM
1861Contrary to `undo', this will not redo a previous undo."
1862 (interactive "*p")
1863 (let ((undo-no-redo t)) (undo arg)))
1e96c007 1864
52d1110d
RS
1865(defvar undo-in-progress nil
1866 "Non-nil while performing an undo.
1867Some change-hooks test this variable to do something different.")
1868
8ac28be5 1869(defun undo-more (n)
2076c87c 1870 "Undo back N undo-boundaries beyond what was already undone recently.
ff1fbe3e
RS
1871Call `undo-start' to get ready to undo recent changes,
1872then call `undo-more' one or more times to undo them."
a7fe694c 1873 (or (listp pending-undo-list)
8ac28be5 1874 (error (concat "No further undo information"
00fa4024 1875 (and undo-in-region " for region"))))
52d1110d 1876 (let ((undo-in-progress t))
b553f685
AM
1877 ;; Note: The following, while pulling elements off
1878 ;; `pending-undo-list' will call primitive change functions which
1879 ;; will push more elements onto `buffer-undo-list'.
8ac28be5 1880 (setq pending-undo-list (primitive-undo n pending-undo-list))
a7fe694c
RS
1881 (if (null pending-undo-list)
1882 (setq pending-undo-list t))))
2076c87c 1883
65627aad
RS
1884;; Deep copy of a list
1885(defun undo-copy-list (list)
1886 "Make a copy of undo list LIST."
1887 (mapcar 'undo-copy-list-1 list))
1888
1889(defun undo-copy-list-1 (elt)
1890 (if (consp elt)
1891 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1892 elt))
1893
1894(defun undo-start (&optional beg end)
1895 "Set `pending-undo-list' to the front of the undo list.
1896The next call to `undo-more' will undo the most recently made change.
1897If BEG and END are specified, then only undo elements
1898that apply to text between BEG and END are used; other undo elements
1899are ignored. If BEG and END are nil, all undo elements are used."
1900 (if (eq buffer-undo-list t)
1901 (error "No undo information in this buffer"))
1e722f9f 1902 (setq pending-undo-list
65627aad
RS
1903 (if (and beg end (not (= beg end)))
1904 (undo-make-selective-list (min beg end) (max beg end))
1905 buffer-undo-list)))
1906
1907(defvar undo-adjusted-markers)
1908
1909(defun undo-make-selective-list (start end)
1910 "Return a list of undo elements for the region START to END.
1911The elements come from `buffer-undo-list', but we keep only
1912the elements inside this region, and discard those outside this region.
1913If we find an element that crosses an edge of this region,
1914we stop and ignore all further elements."
1915 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1916 (undo-list (list nil))
1917 undo-adjusted-markers
1918 some-rejected
06b60517 1919 undo-elt temp-undo-list delta)
65627aad
RS
1920 (while undo-list-copy
1921 (setq undo-elt (car undo-list-copy))
1922 (let ((keep-this
1923 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1924 ;; This is a "was unmodified" element.
1925 ;; Keep it if we have kept everything thus far.
1926 (not some-rejected))
1927 (t
1928 (undo-elt-in-region undo-elt start end)))))
1929 (if keep-this
1930 (progn
1931 (setq end (+ end (cdr (undo-delta undo-elt))))
1932 ;; Don't put two nils together in the list
1933 (if (not (and (eq (car undo-list) nil)
1934 (eq undo-elt nil)))
1935 (setq undo-list (cons undo-elt undo-list))))
1936 (if (undo-elt-crosses-region undo-elt start end)
1937 (setq undo-list-copy nil)
1938 (setq some-rejected t)
1939 (setq temp-undo-list (cdr undo-list-copy))
1940 (setq delta (undo-delta undo-elt))
1941
1942 (when (/= (cdr delta) 0)
1943 (let ((position (car delta))
1944 (offset (cdr delta)))
1945
e1e04350
SM
1946 ;; Loop down the earlier events adjusting their buffer
1947 ;; positions to reflect the fact that a change to the buffer
1948 ;; isn't being undone. We only need to process those element
1949 ;; types which undo-elt-in-region will return as being in
1950 ;; the region since only those types can ever get into the
1951 ;; output
65627aad
RS
1952
1953 (while temp-undo-list
1954 (setq undo-elt (car temp-undo-list))
1955 (cond ((integerp undo-elt)
1956 (if (>= undo-elt position)
1957 (setcar temp-undo-list (- undo-elt offset))))
1958 ((atom undo-elt) nil)
1959 ((stringp (car undo-elt))
1960 ;; (TEXT . POSITION)
1961 (let ((text-pos (abs (cdr undo-elt)))
1962 (point-at-end (< (cdr undo-elt) 0 )))
1963 (if (>= text-pos position)
1e722f9f 1964 (setcdr undo-elt (* (if point-at-end -1 1)
65627aad
RS
1965 (- text-pos offset))))))
1966 ((integerp (car undo-elt))
1967 ;; (BEGIN . END)
1968 (when (>= (car undo-elt) position)
1969 (setcar undo-elt (- (car undo-elt) offset))
1970 (setcdr undo-elt (- (cdr undo-elt) offset))))
1971 ((null (car undo-elt))
1972 ;; (nil PROPERTY VALUE BEG . END)
1973 (let ((tail (nthcdr 3 undo-elt)))
1974 (when (>= (car tail) position)
1975 (setcar tail (- (car tail) offset))
1976 (setcdr tail (- (cdr tail) offset))))))
1977 (setq temp-undo-list (cdr temp-undo-list))))))))
1978 (setq undo-list-copy (cdr undo-list-copy)))
1979 (nreverse undo-list)))
1980
1981(defun undo-elt-in-region (undo-elt start end)
1982 "Determine whether UNDO-ELT falls inside the region START ... END.
1983If it crosses the edge, we return nil."
1984 (cond ((integerp undo-elt)
1985 (and (>= undo-elt start)
12a93712 1986 (<= undo-elt end)))
65627aad
RS
1987 ((eq undo-elt nil)
1988 t)
1989 ((atom undo-elt)
1990 nil)
1991 ((stringp (car undo-elt))
1992 ;; (TEXT . POSITION)
1993 (and (>= (abs (cdr undo-elt)) start)
1994 (< (abs (cdr undo-elt)) end)))
1995 ((and (consp undo-elt) (markerp (car undo-elt)))
1996 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1997 ;; See if MARKER is inside the region.
1998 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1999 (unless alist-elt
2000 (setq alist-elt (cons (car undo-elt)
2001 (marker-position (car undo-elt))))
2002 (setq undo-adjusted-markers
2003 (cons alist-elt undo-adjusted-markers)))
2004 (and (cdr alist-elt)
2005 (>= (cdr alist-elt) start)
12a93712 2006 (<= (cdr alist-elt) end))))
65627aad
RS
2007 ((null (car undo-elt))
2008 ;; (nil PROPERTY VALUE BEG . END)
2009 (let ((tail (nthcdr 3 undo-elt)))
2010 (and (>= (car tail) start)
12a93712 2011 (<= (cdr tail) end))))
65627aad
RS
2012 ((integerp (car undo-elt))
2013 ;; (BEGIN . END)
2014 (and (>= (car undo-elt) start)
12a93712 2015 (<= (cdr undo-elt) end)))))
65627aad
RS
2016
2017(defun undo-elt-crosses-region (undo-elt start end)
2018 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2019This assumes we have already decided that UNDO-ELT
2020is not *inside* the region START...END."
2021 (cond ((atom undo-elt) nil)
2022 ((null (car undo-elt))
2023 ;; (nil PROPERTY VALUE BEG . END)
2024 (let ((tail (nthcdr 3 undo-elt)))
1f8a132d
RS
2025 (and (< (car tail) end)
2026 (> (cdr tail) start))))
65627aad
RS
2027 ((integerp (car undo-elt))
2028 ;; (BEGIN . END)
1f8a132d
RS
2029 (and (< (car undo-elt) end)
2030 (> (cdr undo-elt) start)))))
65627aad
RS
2031
2032;; Return the first affected buffer position and the delta for an undo element
2033;; delta is defined as the change in subsequent buffer positions if we *did*
2034;; the undo.
2035(defun undo-delta (undo-elt)
2036 (if (consp undo-elt)
2037 (cond ((stringp (car undo-elt))
2038 ;; (TEXT . POSITION)
2039 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
2040 ((integerp (car undo-elt))
2041 ;; (BEGIN . END)
2042 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
2043 (t
2044 '(0 . 0)))
2045 '(0 . 0)))
b6e8e8e5 2046
1223933d 2047(defcustom undo-ask-before-discard nil
28cb725d
LT
2048 "If non-nil ask about discarding undo info for the current command.
2049Normally, Emacs discards the undo info for the current command if
2050it exceeds `undo-outer-limit'. But if you set this option
2051non-nil, it asks in the echo area whether to discard the info.
a3545af4 2052If you answer no, there is a slight risk that Emacs might crash, so
28cb725d
LT
2053only do it if you really want to undo the command.
2054
2055This option is mainly intended for debugging. You have to be
2056careful if you use it for other purposes. Garbage collection is
2057inhibited while the question is asked, meaning that Emacs might
2058leak memory. So you should make sure that you do not wait
2059excessively long before answering the question."
2060 :type 'boolean
2061 :group 'undo
bf247b6e 2062 :version "22.1")
28cb725d 2063
a1a801de
RS
2064(defvar undo-extra-outer-limit nil
2065 "If non-nil, an extra level of size that's ok in an undo item.
2066We don't ask the user about truncating the undo list until the
28cb725d
LT
2067current item gets bigger than this amount.
2068
2069This variable only matters if `undo-ask-before-discard' is non-nil.")
a1a801de
RS
2070(make-variable-buffer-local 'undo-extra-outer-limit)
2071
28cb725d
LT
2072;; When the first undo batch in an undo list is longer than
2073;; undo-outer-limit, this function gets called to warn the user that
2074;; the undo info for the current command was discarded. Garbage
2075;; collection is inhibited around the call, so it had better not do a
2076;; lot of consing.
b6e8e8e5
RS
2077(setq undo-outer-limit-function 'undo-outer-limit-truncate)
2078(defun undo-outer-limit-truncate (size)
28cb725d
LT
2079 (if undo-ask-before-discard
2080 (when (or (null undo-extra-outer-limit)
2081 (> size undo-extra-outer-limit))
2082 ;; Don't ask the question again unless it gets even bigger.
2083 ;; This applies, in particular, if the user quits from the question.
2084 ;; Such a quit quits out of GC, but something else will call GC
2085 ;; again momentarily. It will call this function again,
2086 ;; but we don't want to ask the question again.
2087 (setq undo-extra-outer-limit (+ size 50000))
2088 (if (let (use-dialog-box track-mouse executing-kbd-macro )
d5aa078b 2089 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
28cb725d
LT
2090 (buffer-name) size)))
2091 (progn (setq buffer-undo-list nil)
2092 (setq undo-extra-outer-limit nil)
2093 t)
2094 nil))
2095 (display-warning '(undo discard-info)
2096 (concat
d5aa078b 2097 (format "Buffer `%s' undo info was %d bytes long.\n"
28cb725d
LT
2098 (buffer-name) size)
2099 "The undo info was discarded because it exceeded \
2100`undo-outer-limit'.
2101
2102This is normal if you executed a command that made a huge change
2103to the buffer. In that case, to prevent similar problems in the
2104future, set `undo-outer-limit' to a value that is large enough to
2105cover the maximum size of normal changes you expect a single
2106command to make, but not so large that it might exceed the
2107maximum memory allotted to Emacs.
2108
2109If you did not execute any such command, the situation is
2110probably due to a bug and you should report it.
2111
2112You can disable the popping up of this buffer by adding the entry
14f01bef
CY
2113\(undo discard-info) to the user option `warning-suppress-types',
2114which is defined in the `warnings' library.\n")
28cb725d
LT
2115 :warning)
2116 (setq buffer-undo-list nil)
2117 t))
e1e04350 2118\f
009ef402 2119(defvar shell-command-history nil
e5f0c02f
EZ
2120 "History list for some commands that read shell commands.
2121
2122Maximum length of the history list is determined by the value
2123of `history-length', which see.")
009ef402 2124
6d341a2a 2125(defvar shell-command-switch (purecopy "-c")
59fc41e5
RS
2126 "Switch used to have the shell execute its command line argument.")
2127
cc039f78
KH
2128(defvar shell-command-default-error-buffer nil
2129 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
637fff82 2130This buffer is used when `shell-command' or `shell-command-on-region'
cc039f78
KH
2131is run interactively. A value of nil means that output to stderr and
2132stdout will be intermixed in the output stream.")
2133
a98a2fe8 2134(declare-function mailcap-file-default-commands "mailcap" (files))
e0987650 2135(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
a98a2fe8
JL
2136
2137(defun minibuffer-default-add-shell-commands ()
263bc3fa 2138 "Return a list of all commands associated with the current file.
086a7dd4 2139This function is used to add all related commands retrieved by `mailcap'
a98a2fe8
JL
2140to the end of the list of defaults just after the default value."
2141 (interactive)
2142 (let* ((filename (if (listp minibuffer-default)
2143 (car minibuffer-default)
2144 minibuffer-default))
2145 (commands (and filename (require 'mailcap nil t)
2146 (mailcap-file-default-commands (list filename)))))
2147 (setq commands (mapcar (lambda (command)
2148 (concat command " " filename))
2149 commands))
2150 (if (listp minibuffer-default)
2151 (append minibuffer-default commands)
2152 (cons minibuffer-default commands))))
2153
914a0ae1 2154(declare-function shell-completion-vars "shell" ())
2e7bd464 2155
e5c4079c
SM
2156(defvar minibuffer-local-shell-command-map
2157 (let ((map (make-sparse-keymap)))
2158 (set-keymap-parent map minibuffer-local-map)
1bcace58 2159 (define-key map "\t" 'completion-at-point)
e5c4079c 2160 map)
1d2b0303 2161 "Keymap used for completing shell commands in minibuffer.")
e5c4079c
SM
2162
2163(defun read-shell-command (prompt &optional initial-contents hist &rest args)
2164 "Read a shell command from the minibuffer.
2165The arguments are the same as the ones of `read-from-minibuffer',
2166except READ and KEYMAP are missing and HIST defaults
2167to `shell-command-history'."
1bcace58 2168 (require 'shell)
d6601455
JL
2169 (minibuffer-with-setup-hook
2170 (lambda ()
914a0ae1 2171 (shell-completion-vars)
d6601455
JL
2172 (set (make-local-variable 'minibuffer-default-add-function)
2173 'minibuffer-default-add-shell-commands))
2174 (apply 'read-from-minibuffer prompt initial-contents
2175 minibuffer-local-shell-command-map
2176 nil
2177 (or hist 'shell-command-history)
2178 args)))
e5c4079c 2179
c945a962
JL
2180(defun async-shell-command (command &optional output-buffer error-buffer)
2181 "Execute string COMMAND asynchronously in background.
2182
2183Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2184surrounded by whitespace and executes the command asynchronously.
5ad4bef5
SM
2185The output appears in the buffer `*Async Shell Command*'.
2186
2187In Elisp, you will often be better served by calling `start-process'
2188directly, since it offers more control and does not impose the use of a
2189shell (with its need to quote arguments)."
c945a962
JL
2190 (interactive
2191 (list
2192 (read-shell-command "Async shell command: " nil nil
2193 (and buffer-file-name
2194 (file-relative-name buffer-file-name)))
2195 current-prefix-arg
2196 shell-command-default-error-buffer))
2197 (unless (string-match "&[ \t]*\\'" command)
2198 (setq command (concat command " &")))
2199 (shell-command command output-buffer error-buffer))
2200
cc039f78 2201(defun shell-command (command &optional output-buffer error-buffer)
2076c87c 2202 "Execute string COMMAND in inferior shell; display output, if any.
0b3f96d4 2203With prefix argument, insert the COMMAND's output at point.
d382f610 2204
2076c87c 2205If COMMAND ends in ampersand, execute it asynchronously.
d382f610 2206The output appears in the buffer `*Async Shell Command*'.
bcad4985 2207That buffer is in shell mode.
d382f610 2208
939ac10c
GM
2209Otherwise, COMMAND is executed synchronously. The output appears in
2210the buffer `*Shell Command Output*'. If the output is short enough to
2211display in the echo area (which is determined by the variables
2212`resize-mini-windows' and `max-mini-window-height'), it is shown
2213there, but it is nonetheless available in buffer `*Shell Command
e1e04350 2214Output*' even though that buffer is not automatically displayed.
d0d74413 2215
07f458c1 2216To specify a coding system for converting non-ASCII characters
5626c14e 2217in the shell command output, use \\[universal-coding-system-argument] \
07f458c1
RS
2218before this command.
2219
2220Noninteractive callers can specify coding systems by binding
2221`coding-system-for-read' and `coding-system-for-write'.
2222
d0d74413
RS
2223The optional second argument OUTPUT-BUFFER, if non-nil,
2224says to put the output in some other buffer.
2225If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2226If OUTPUT-BUFFER is not a buffer and not nil,
2227insert output in current buffer. (This cannot be done asynchronously.)
e7791447
CY
2228In either case, the buffer is first erased, and the output is
2229inserted after point (leaving mark after it).
cc039f78 2230
2e033693
RS
2231If the command terminates without error, but generates output,
2232and you did not specify \"insert it in the current buffer\",
2233the output can be displayed in the echo area or in its buffer.
2234If the output is short enough to display in the echo area
2235\(determined by the variable `max-mini-window-height' if
5626c14e
JB
2236`resize-mini-windows' is non-nil), it is shown there.
2237Otherwise,the buffer containing the output is displayed.
2e033693
RS
2238
2239If there is output and an error, and you did not specify \"insert it
2240in the current buffer\", a message about the error goes at the end
2241of the output.
2242
2243If there is no output, or if output is inserted in the current buffer,
2244then `*Shell Command Output*' is deleted.
2245
cc039f78
KH
2246If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2247or buffer name to which to direct the command's standard error output.
2248If it is nil, error output is mingled with regular output.
2249In an interactive call, the variable `shell-command-default-error-buffer'
5ad4bef5
SM
2250specifies the value of ERROR-BUFFER.
2251
2252In Elisp, you will often be better served by calling `call-process' or
2253`start-process' directly, since it offers more control and does not impose
2254the use of a shell (with its need to quote arguments)."
cc039f78 2255
a98a2fe8
JL
2256 (interactive
2257 (list
d6601455 2258 (read-shell-command "Shell command: " nil nil
e0987650
JL
2259 (let ((filename
2260 (cond
2261 (buffer-file-name)
2262 ((eq major-mode 'dired-mode)
2263 (dired-get-filename nil t)))))
2264 (and filename (file-relative-name filename))))
a98a2fe8
JL
2265 current-prefix-arg
2266 shell-command-default-error-buffer))
c7edd03c
KH
2267 ;; Look for a handler in case default-directory is a remote file name.
2268 (let ((handler
2269 (find-file-name-handler (directory-file-name default-directory)
2270 'shell-command)))
2271 (if handler
cc039f78 2272 (funcall handler 'shell-command command output-buffer error-buffer)
c7edd03c
KH
2273 (if (and output-buffer
2274 (not (or (bufferp output-buffer) (stringp output-buffer))))
2e033693 2275 ;; Output goes in current buffer.
cc039f78 2276 (let ((error-file
1e722f9f 2277 (if error-buffer
b005abd5 2278 (make-temp-file
171a45d9
EZ
2279 (expand-file-name "scor"
2280 (or small-temporary-file-directory
2281 temporary-file-directory)))
cc039f78
KH
2282 nil)))
2283 (barf-if-buffer-read-only)
63437623 2284 (push-mark nil t)
cc039f78
KH
2285 ;; We do not use -f for csh; we will not support broken use of
2286 ;; .cshrcs. Even the BSD csh manual says to use
2287 ;; "if ($?prompt) exit" before things which are not useful
2288 ;; non-interactively. Besides, if someone wants their other
2289 ;; aliases for shell commands then they can still have them.
1e722f9f 2290 (call-process shell-file-name nil
cc039f78
KH
2291 (if error-file
2292 (list t error-file)
2293 t)
2294 nil shell-command-switch command)
2295 (when (and error-file (file-exists-p error-file))
2296 (if (< 0 (nth 7 (file-attributes error-file)))
2297 (with-current-buffer (get-buffer-create error-buffer)
2298 (let ((pos-from-end (- (point-max) (point))))
2299 (or (bobp)
2300 (insert "\f\n"))
2301 ;; Do no formatting while reading error file,
2302 ;; because that can run a shell command, and we
2303 ;; don't want that to cause an infinite recursion.
2304 (format-insert-file error-file nil)
2305 ;; Put point after the inserted errors.
2306 (goto-char (- (point-max) pos-from-end)))
2307 (display-buffer (current-buffer))))
2308 (delete-file error-file))
2309 ;; This is like exchange-point-and-mark, but doesn't
2310 ;; activate the mark. It is cleaner to avoid activation,
2311 ;; even though the command loop would deactivate the mark
2312 ;; because we inserted text.
2313 (goto-char (prog1 (mark t)
2314 (set-marker (mark-marker) (point)
2315 (current-buffer)))))
2e033693 2316 ;; Output goes in a separate buffer.
c7edd03c
KH
2317 ;; Preserve the match data in case called from a program.
2318 (save-match-data
aab5d2c5 2319 (if (string-match "[ \t]*&[ \t]*\\'" command)
c7edd03c
KH
2320 ;; Command ending with ampersand means asynchronous.
2321 (let ((buffer (get-buffer-create
2322 (or output-buffer "*Async Shell Command*")))
2323 (directory default-directory)
2324 proc)
2325 ;; Remove the ampersand.
2326 (setq command (substring command 0 (match-beginning 0)))
2327 ;; If will kill a process, query first.
2328 (setq proc (get-buffer-process buffer))
2329 (if proc
2330 (if (yes-or-no-p "A command is running. Kill it? ")
2331 (kill-process proc)
2332 (error "Shell command in progress")))
1e96c007 2333 (with-current-buffer buffer
c7edd03c 2334 (setq buffer-read-only nil)
50f8cd96
TH
2335 ;; Setting buffer-read-only to nil doesn't suffice
2336 ;; if some text has a non-nil read-only property,
2337 ;; which comint sometimes adds for prompts.
2338 (let ((inhibit-read-only t))
2339 (erase-buffer))
c7edd03c
KH
2340 (display-buffer buffer)
2341 (setq default-directory directory)
1e722f9f 2342 (setq proc (start-process "Shell" buffer shell-file-name
c7edd03c
KH
2343 shell-command-switch command))
2344 (setq mode-line-process '(":%s"))
c2020c27 2345 (require 'shell) (shell-mode)
c7edd03c 2346 (set-process-sentinel proc 'shell-command-sentinel)
50c737e4
JL
2347 ;; Use the comint filter for proper handling of carriage motion
2348 ;; (see `comint-inhibit-carriage-motion'),.
2349 (set-process-filter proc 'comint-output-filter)
c7edd03c 2350 ))
50c737e4 2351 ;; Otherwise, command is executed synchronously.
cc039f78
KH
2352 (shell-command-on-region (point) (point) command
2353 output-buffer nil error-buffer)))))))
eaae8106 2354
f69aad2b
MB
2355(defun display-message-or-buffer (message
2356 &optional buffer-name not-this-window frame)
2357 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2358MESSAGE may be either a string or a buffer.
2359
2360A buffer is displayed using `display-buffer' if MESSAGE is too long for
939ac10c
GM
2361the maximum height of the echo area, as defined by `max-mini-window-height'
2362if `resize-mini-windows' is non-nil.
f69aad2b 2363
2a3f00bf
MB
2364Returns either the string shown in the echo area, or when a pop-up
2365buffer is used, the window used to display it.
2366
f69aad2b
MB
2367If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2368name of the buffer used to display it in the case where a pop-up buffer
2369is used, defaulting to `*Message*'. In the case where MESSAGE is a
2370string and it is displayed in the echo area, it is not specified whether
2371the contents are inserted into the buffer anyway.
2372
2373Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2374and only used if a buffer is displayed."
39a8d88a 2375 (cond ((and (stringp message) (not (string-match "\n" message)))
f69aad2b
MB
2376 ;; Trivial case where we can use the echo area
2377 (message "%s" message))
2378 ((and (stringp message)
39a8d88a 2379 (= (string-match "\n" message) (1- (length message))))
f69aad2b
MB
2380 ;; Trivial case where we can just remove single trailing newline
2381 (message "%s" (substring message 0 (1- (length message)))))
2382 (t
2383 ;; General case
2384 (with-current-buffer
2385 (if (bufferp message)
2386 message
2387 (get-buffer-create (or buffer-name "*Message*")))
2388
2389 (unless (bufferp message)
2390 (erase-buffer)
2391 (insert message))
2392
2393 (let ((lines
2394 (if (= (buffer-size) 0)
2395 0
62ffcd76 2396 (count-screen-lines nil nil nil (minibuffer-window)))))
4f017185
RS
2397 (cond ((= lines 0))
2398 ((and (or (<= lines 1)
aab5d2c5
RS
2399 (<= lines
2400 (if resize-mini-windows
2401 (cond ((floatp max-mini-window-height)
2402 (* (frame-height)
2403 max-mini-window-height))
2404 ((integerp max-mini-window-height)
2405 max-mini-window-height)
2406 (t
2407 1))
2408 1)))
2409 ;; Don't use the echo area if the output buffer is
2410 ;; already dispayed in the selected frame.
61b80ebf 2411 (not (get-buffer-window (current-buffer))))
f69aad2b
MB
2412 ;; Echo area
2413 (goto-char (point-max))
2414 (when (bolp)
2415 (backward-char 1))
2416 (message "%s" (buffer-substring (point-min) (point))))
2417 (t
2418 ;; Buffer
2419 (goto-char (point-min))
31252c00
MB
2420 (display-buffer (current-buffer)
2421 not-this-window frame))))))))
f69aad2b
MB
2422
2423
2076c87c
JB
2424;; We have a sentinel to prevent insertion of a termination message
2425;; in the buffer itself.
2426(defun shell-command-sentinel (process signal)
bcad4985 2427 (if (memq (process-status process) '(exit signal))
1e722f9f 2428 (message "%s: %s."
bcad4985
KH
2429 (car (cdr (cdr (process-command process))))
2430 (substring signal 0 -1))))
2076c87c 2431
d0d74413 2432(defun shell-command-on-region (start end command
cce1c318 2433 &optional output-buffer replace
63619f42 2434 error-buffer display-error-buffer)
2076c87c
JB
2435 "Execute string COMMAND in inferior shell with region as input.
2436Normally display output (if any) in temp buffer `*Shell Command Output*';
a0184aeb
DL
2437Prefix arg means replace the region with it. Return the exit code of
2438COMMAND.
56c0450e 2439
07f458c1
RS
2440To specify a coding system for converting non-ASCII characters
2441in the input and output to the shell command, use \\[universal-coding-system-argument]
2442before this command. By default, the input (from the current buffer)
2443is encoded in the same coding system that will be used to save the file,
2444`buffer-file-coding-system'. If the output is going to replace the region,
2445then it is decoded from that same coding system.
2446
63619f42
RS
2447The noninteractive arguments are START, END, COMMAND,
2448OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2449Noninteractive callers can specify coding systems by binding
2450`coding-system-for-read' and `coding-system-for-write'.
2076c87c 2451
2e033693
RS
2452If the command generates output, the output may be displayed
2453in the echo area or in a buffer.
2454If the output is short enough to display in the echo area
2455\(determined by the variable `max-mini-window-height' if
2456`resize-mini-windows' is non-nil), it is shown there. Otherwise
2457it is displayed in the buffer `*Shell Command Output*'. The output
2458is available in that buffer in both cases.
2459
2460If there is output and an error, a message about the error
2461appears at the end of the output.
2462
2463If there is no output, or if output is inserted in the current buffer,
2464then `*Shell Command Output*' is deleted.
d0d74413 2465
56c0450e
RS
2466If the optional fourth argument OUTPUT-BUFFER is non-nil,
2467that says to put the output in some other buffer.
d0d74413
RS
2468If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2469If OUTPUT-BUFFER is not a buffer and not nil,
2470insert output in the current buffer.
cce1c318
RS
2471In either case, the output is inserted after point (leaving mark after it).
2472
8923a211
RS
2473If REPLACE, the optional fifth argument, is non-nil, that means insert
2474the output in place of text from START to END, putting point and mark
2475around it.
2476
b735c991 2477If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
cce1c318 2478or buffer name to which to direct the command's standard error output.
7fd47839 2479If it is nil, error output is mingled with regular output.
63619f42
RS
2480If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2481were any errors. (This is always t, interactively.)
cc039f78
KH
2482In an interactive call, the variable `shell-command-default-error-buffer'
2483specifies the value of ERROR-BUFFER."
195ce311
RS
2484 (interactive (let (string)
2485 (unless (mark)
2486 (error "The mark is not set now, so there is no region"))
2487 ;; Do this before calling region-beginning
2488 ;; and region-end, in case subprocess output
2489 ;; relocates them while we are in the minibuffer.
e5c4079c 2490 (setq string (read-shell-command "Shell command on region: "))
2b03c506
RS
2491 ;; call-interactively recognizes region-beginning and
2492 ;; region-end specially, leaving them in the history.
2493 (list (region-beginning) (region-end)
cae49185
RS
2494 string
2495 current-prefix-arg
7fd47839 2496 current-prefix-arg
63619f42
RS
2497 shell-command-default-error-buffer
2498 t)))
cce1c318 2499 (let ((error-file
171a45d9 2500 (if error-buffer
b005abd5 2501 (make-temp-file
171a45d9
EZ
2502 (expand-file-name "scor"
2503 (or small-temporary-file-directory
2504 temporary-file-directory)))
a0184aeb
DL
2505 nil))
2506 exit-status)
7fd47839
RS
2507 (if (or replace
2508 (and output-buffer
748d6ca4 2509 (not (or (bufferp output-buffer) (stringp output-buffer)))))
7fd47839
RS
2510 ;; Replace specified region with output from command.
2511 (let ((swap (and replace (< start end))))
2512 ;; Don't muck with mark unless REPLACE says we should.
2513 (goto-char start)
30883773 2514 (and replace (push-mark (point) 'nomsg))
a0184aeb
DL
2515 (setq exit-status
2516 (call-process-region start end shell-file-name t
2517 (if error-file
2518 (list t error-file)
2519 t)
2520 nil shell-command-switch command))
e1e04350
SM
2521 ;; It is rude to delete a buffer which the command is not using.
2522 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2523 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2524 ;; (kill-buffer shell-buffer)))
7fd47839
RS
2525 ;; Don't muck with mark unless REPLACE says we should.
2526 (and replace swap (exchange-point-and-mark)))
2527 ;; No prefix argument: put the output in a temp buffer,
2528 ;; replacing its entire contents.
2529 (let ((buffer (get-buffer-create
d4bbcbb4 2530 (or output-buffer "*Shell Command Output*"))))
7fd47839
RS
2531 (unwind-protect
2532 (if (eq buffer (current-buffer))
2533 ;; If the input is the same buffer as the output,
2534 ;; delete everything but the specified region,
2535 ;; then replace that region with the output.
2536 (progn (setq buffer-read-only nil)
2537 (delete-region (max start end) (point-max))
2538 (delete-region (point-min) (min start end))
2539 (setq exit-status
2540 (call-process-region (point-min) (point-max)
1e722f9f 2541 shell-file-name t
7fd47839
RS
2542 (if error-file
2543 (list t error-file)
2544 t)
a0184aeb
DL
2545 nil shell-command-switch
2546 command)))
2547 ;; Clear the output buffer, then run the command with
2548 ;; output there.
c2e303c8 2549 (let ((directory default-directory))
7fdbcd83 2550 (with-current-buffer buffer
c2e303c8
GM
2551 (setq buffer-read-only nil)
2552 (if (not output-buffer)
2553 (setq default-directory directory))
2554 (erase-buffer)))
7fd47839
RS
2555 (setq exit-status
2556 (call-process-region start end shell-file-name nil
2557 (if error-file
2558 (list buffer error-file)
2559 buffer)
a0184aeb 2560 nil shell-command-switch command)))
2e033693 2561 ;; Report the output.
9a98fa64 2562 (with-current-buffer buffer
f1180544 2563 (setq mode-line-process
d4bbcbb4
AS
2564 (cond ((null exit-status)
2565 " - Error")
2566 ((stringp exit-status)
2567 (format " - Signal [%s]" exit-status))
2568 ((not (equal 0 exit-status))
2569 (format " - Exit [%d]" exit-status)))))
f69aad2b
MB
2570 (if (with-current-buffer buffer (> (point-max) (point-min)))
2571 ;; There's some output, display it
9a98fa64 2572 (display-message-or-buffer buffer)
f69aad2b 2573 ;; No output; error?
94ddbe6d
RS
2574 (let ((output
2575 (if (and error-file
2576 (< 0 (nth 7 (file-attributes error-file))))
e83cc1f7
LMI
2577 (format "some error output%s"
2578 (if shell-command-default-error-buffer
e0457abe
LMI
2579 (format " to the \"%s\" buffer"
2580 shell-command-default-error-buffer)
e83cc1f7 2581 ""))
94ddbe6d 2582 "no output")))
d4bbcbb4
AS
2583 (cond ((null exit-status)
2584 (message "(Shell command failed with error)"))
2585 ((equal 0 exit-status)
2586 (message "(Shell command succeeded with %s)"
2587 output))
2588 ((stringp exit-status)
2589 (message "(Shell command killed by signal %s)"
2590 exit-status))
2591 (t
2592 (message "(Shell command failed with code %d and %s)"
2593 exit-status output))))
e1e04350
SM
2594 ;; Don't kill: there might be useful info in the undo-log.
2595 ;; (kill-buffer buffer)
2596 ))))
f69aad2b 2597
cc039f78
KH
2598 (when (and error-file (file-exists-p error-file))
2599 (if (< 0 (nth 7 (file-attributes error-file)))
2600 (with-current-buffer (get-buffer-create error-buffer)
2601 (let ((pos-from-end (- (point-max) (point))))
2602 (or (bobp)
2603 (insert "\f\n"))
2604 ;; Do no formatting while reading error file,
2605 ;; because that can run a shell command, and we
2606 ;; don't want that to cause an infinite recursion.
2607 (format-insert-file error-file nil)
2608 ;; Put point after the inserted errors.
2609 (goto-char (- (point-max) pos-from-end)))
63619f42
RS
2610 (and display-error-buffer
2611 (display-buffer (current-buffer)))))
cc039f78 2612 (delete-file error-file))
a0184aeb 2613 exit-status))
1e722f9f 2614
d589bd99
RS
2615(defun shell-command-to-string (command)
2616 "Execute shell command COMMAND and return its output as a string."
2617 (with-output-to-string
17cc9013
RS
2618 (with-current-buffer
2619 standard-output
b511b994 2620 (process-file shell-file-name nil t nil shell-command-switch command))))
0457dd55
KG
2621
2622(defun process-file (program &optional infile buffer display &rest args)
2623 "Process files synchronously in a separate process.
2624Similar to `call-process', but may invoke a file handler based on
2625`default-directory'. The current working directory of the
2626subprocess is `default-directory'.
2627
2628File names in INFILE and BUFFER are handled normally, but file
2629names in ARGS should be relative to `default-directory', as they
2630are passed to the process verbatim. \(This is a difference to
2631`call-process' which does not support file handlers for INFILE
2632and BUFFER.\)
2633
2634Some file handlers might not support all variants, for example
2635they might behave as if DISPLAY was nil, regardless of the actual
2636value passed."
2637 (let ((fh (find-file-name-handler default-directory 'process-file))
2638 lc stderr-file)
2639 (unwind-protect
2640 (if fh (apply fh 'process-file program infile buffer display args)
8de40f9f 2641 (when infile (setq lc (file-local-copy infile)))
0457dd55 2642 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
85af630d
KG
2643 (make-temp-file "emacs")))
2644 (prog1
2645 (apply 'call-process program
2646 (or lc infile)
2647 (if stderr-file (list (car buffer) stderr-file) buffer)
2648 display args)
2649 (when stderr-file (copy-file stderr-file (cadr buffer)))))
0457dd55
KG
2650 (when stderr-file (delete-file stderr-file))
2651 (when lc (delete-file lc)))))
2652
2c4f2562
MA
2653(defvar process-file-side-effects t
2654 "Whether a call of `process-file' changes remote files.
2655
2656Per default, this variable is always set to `t', meaning that a
2657call of `process-file' could potentially change any file on a
2658remote host. When set to `nil', a file handler could optimize
2659its behaviour with respect to remote file attributes caching.
2660
2661This variable should never be changed by `setq'. Instead of, it
2662shall be set only by let-binding.")
2663
7cb76caa
MA
2664(defun start-file-process (name buffer program &rest program-args)
2665 "Start a program in a subprocess. Return the process object for it.
5a5abb2c 2666
7cb76caa 2667Similar to `start-process', but may invoke a file handler based on
5a5abb2c
MA
2668`default-directory'. See Info node `(elisp)Magic File Names'.
2669
2670This handler ought to run PROGRAM, perhaps on the local host,
2671perhaps on a remote host that corresponds to `default-directory'.
2672In the latter case, the local part of `default-directory' becomes
2673the working directory of the process.
7cb76caa
MA
2674
2675PROGRAM and PROGRAM-ARGS might be file names. They are not
91f11424
MA
2676objects of file handler invocation. File handlers might not
2677support pty association, if PROGRAM is nil."
7cb76caa
MA
2678 (let ((fh (find-file-name-handler default-directory 'start-file-process)))
2679 (if fh (apply fh 'start-file-process name buffer program program-args)
2680 (apply 'start-process name buffer program program-args))))
7d668f2c
CY
2681\f
2682;;;; Process menu
2683
2684(defvar tabulated-list-format)
2685(defvar tabulated-list-entries)
2686(defvar tabulated-list-sort-key)
2687(declare-function tabulated-list-init-header "tabulated-list" ())
cf5bee67
GM
2688(declare-function tabulated-list-print "tabulated-list"
2689 (&optional remember-pos))
7d668f2c
CY
2690
2691(defvar process-menu-query-only nil)
2692
2693(define-derived-mode process-menu-mode tabulated-list-mode "Process Menu"
2694 "Major mode for listing the processes called by Emacs."
2695 (setq tabulated-list-format [("Process" 15 t)
2696 ("Status" 7 t)
2697 ("Buffer" 15 t)
2698 ("TTY" 12 t)
2699 ("Command" 0 t)])
2700 (make-local-variable 'process-menu-query-only)
2701 (setq tabulated-list-sort-key (cons "Process" nil))
2702 (add-hook 'tabulated-list-revert-hook 'list-processes--refresh nil t)
2703 (tabulated-list-init-header))
2704
2705(defun list-processes--refresh ()
2706 "Recompute the list of processes for the Process List buffer."
2707 (setq tabulated-list-entries nil)
2708 (dolist (p (process-list))
2709 (when (or (not process-menu-query-only)
2710 (process-query-on-exit-flag p))
2711 (let* ((buf (process-buffer p))
2712 (type (process-type p))
2713 (name (process-name p))
2714 (status (symbol-name (process-status p)))
2715 (buf-label (if (buffer-live-p buf)
2716 `(,(buffer-name buf)
2717 face link
2718 help-echo ,(concat "Visit buffer `"
2719 (buffer-name buf) "'")
2720 follow-link t
2721 process-buffer ,buf
2722 action process-menu-visit-buffer)
2723 "--"))
2724 (tty (or (process-tty-name p) "--"))
2725 (cmd
2726 (if (memq type '(network serial))
2727 (let ((contact (process-contact p t)))
2728 (if (eq type 'network)
2729 (format "(%s %s)"
2730 (if (plist-get contact :type)
2731 "datagram"
2732 "network")
2733 (if (plist-get contact :server)
2734 (format "server on %s"
2735 (plist-get contact :server))
2736 (format "connection to %s"
2737 (plist-get contact :host))))
2738 (format "(serial port %s%s)"
2739 (or (plist-get contact :port) "?")
2740 (let ((speed (plist-get contact :speed)))
2741 (if speed
2742 (format " at %s b/s" speed)
2743 "")))))
2744 (mapconcat 'identity (process-command p) " "))))
2745 (push (list p (vector name status buf-label tty cmd))
2746 tabulated-list-entries)))))
2747
2748(defun process-menu-visit-buffer (button)
2749 (display-buffer (button-get button 'process-buffer)))
2750
2751(defun list-processes (&optional query-only buffer)
2752 "Display a list of all processes.
2753If optional argument QUERY-ONLY is non-nil, only processes with
2754the query-on-exit flag set are listed.
2755Any process listed as exited or signaled is actually eliminated
2756after the listing is made.
2757Optional argument BUFFER specifies a buffer to use, instead of
2758\"*Process List\".
2759The return value is always nil."
2760 (interactive)
3726838a
EZ
2761 (or (fboundp 'process-list)
2762 (error "Asynchronous subprocesses are not supported on this system"))
7d668f2c
CY
2763 (unless (bufferp buffer)
2764 (setq buffer (get-buffer-create "*Process List*")))
2765 (with-current-buffer buffer
2766 (process-menu-mode)
2767 (setq process-menu-query-only query-only)
2768 (list-processes--refresh)
2769 (tabulated-list-print))
989681bb
JB
2770 (display-buffer buffer)
2771 nil)
2d88b556 2772\f
1b43f83f 2773(defvar universal-argument-map
69d4c3c4
KH
2774 (let ((map (make-sparse-keymap)))
2775 (define-key map [t] 'universal-argument-other-key)
b9ff190d 2776 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
69d4c3c4
KH
2777 (define-key map [switch-frame] nil)
2778 (define-key map [?\C-u] 'universal-argument-more)
2779 (define-key map [?-] 'universal-argument-minus)
2780 (define-key map [?0] 'digit-argument)
2781 (define-key map [?1] 'digit-argument)
2782 (define-key map [?2] 'digit-argument)
2783 (define-key map [?3] 'digit-argument)
2784 (define-key map [?4] 'digit-argument)
2785 (define-key map [?5] 'digit-argument)
2786 (define-key map [?6] 'digit-argument)
2787 (define-key map [?7] 'digit-argument)
2788 (define-key map [?8] 'digit-argument)
2789 (define-key map [?9] 'digit-argument)
bd7acc8d
GM
2790 (define-key map [kp-0] 'digit-argument)
2791 (define-key map [kp-1] 'digit-argument)
2792 (define-key map [kp-2] 'digit-argument)
2793 (define-key map [kp-3] 'digit-argument)
2794 (define-key map [kp-4] 'digit-argument)
2795 (define-key map [kp-5] 'digit-argument)
2796 (define-key map [kp-6] 'digit-argument)
2797 (define-key map [kp-7] 'digit-argument)
2798 (define-key map [kp-8] 'digit-argument)
2799 (define-key map [kp-9] 'digit-argument)
2800 (define-key map [kp-subtract] 'universal-argument-minus)
69d4c3c4
KH
2801 map)
2802 "Keymap used while processing \\[universal-argument].")
2803
0de84e16
RS
2804(defvar universal-argument-num-events nil
2805 "Number of argument-specifying events read by `universal-argument'.
2806`universal-argument-other-key' uses this to discard those events
2807from (this-command-keys), and reread only the final command.")
2808
fb5b2591 2809(defvar saved-overriding-map t
6b61353c
KH
2810 "The saved value of `overriding-terminal-local-map'.
2811That variable gets restored to this value on exiting \"universal
2812argument mode\".")
2813
fb5b2591
SM
2814(defun save&set-overriding-map (map)
2815 "Set `overriding-terminal-local-map' to MAP."
2816 (when (eq saved-overriding-map t)
6b61353c 2817 (setq saved-overriding-map overriding-terminal-local-map)
fb5b2591 2818 (setq overriding-terminal-local-map map)))
6b61353c
KH
2819
2820(defun restore-overriding-map ()
2821 "Restore `overriding-terminal-local-map' to its saved value."
2822 (setq overriding-terminal-local-map saved-overriding-map)
fb5b2591 2823 (setq saved-overriding-map t))
6b61353c 2824
e8d1a377
KH
2825(defun universal-argument ()
2826 "Begin a numeric argument for the following command.
2827Digits or minus sign following \\[universal-argument] make up the numeric argument.
2828\\[universal-argument] following the digits or minus sign ends the argument.
2829\\[universal-argument] without digits or minus sign provides 4 as argument.
2830Repeating \\[universal-argument] without digits or minus sign
0565d307
RS
2831 multiplies the argument by 4 each time.
2832For some commands, just \\[universal-argument] by itself serves as a flag
a697fc62
RS
2833which is different in effect from any particular numeric argument.
2834These commands include \\[set-mark-command] and \\[start-kbd-macro]."
69d4c3c4
KH
2835 (interactive)
2836 (setq prefix-arg (list 4))
0de84e16 2837 (setq universal-argument-num-events (length (this-command-keys)))
fb5b2591 2838 (save&set-overriding-map universal-argument-map))
e8d1a377 2839
69d4c3c4
KH
2840;; A subsequent C-u means to multiply the factor by 4 if we've typed
2841;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2842(defun universal-argument-more (arg)
e8d1a377 2843 (interactive "P")
69d4c3c4
KH
2844 (if (consp arg)
2845 (setq prefix-arg (list (* 4 (car arg))))
1cd24721
RS
2846 (if (eq arg '-)
2847 (setq prefix-arg (list -4))
2848 (setq prefix-arg arg)
6b61353c 2849 (restore-overriding-map)))
0de84e16 2850 (setq universal-argument-num-events (length (this-command-keys))))
e8d1a377
KH
2851
2852(defun negative-argument (arg)
2853 "Begin a negative numeric argument for the next command.
2854\\[universal-argument] following digits or minus sign ends the argument."
2855 (interactive "P")
69d4c3c4
KH
2856 (cond ((integerp arg)
2857 (setq prefix-arg (- arg)))
2858 ((eq arg '-)
2859 (setq prefix-arg nil))
2860 (t
b9ff190d 2861 (setq prefix-arg '-)))
0de84e16 2862 (setq universal-argument-num-events (length (this-command-keys)))
fb5b2591 2863 (save&set-overriding-map universal-argument-map))
69d4c3c4
KH
2864
2865(defun digit-argument (arg)
2866 "Part of the numeric argument for the next command.
2867\\[universal-argument] following digits or minus sign ends the argument."
2868 (interactive "P")
8989a920
GM
2869 (let* ((char (if (integerp last-command-event)
2870 last-command-event
2871 (get last-command-event 'ascii-character)))
bd7acc8d 2872 (digit (- (logand char ?\177) ?0)))
69d4c3c4
KH
2873 (cond ((integerp arg)
2874 (setq prefix-arg (+ (* arg 10)
2875 (if (< arg 0) (- digit) digit))))
2876 ((eq arg '-)
2877 ;; Treat -0 as just -, so that -01 will work.
2878 (setq prefix-arg (if (zerop digit) '- (- digit))))
2879 (t
b9ff190d 2880 (setq prefix-arg digit))))
0de84e16 2881 (setq universal-argument-num-events (length (this-command-keys)))
fb5b2591 2882 (save&set-overriding-map universal-argument-map))
69d4c3c4
KH
2883
2884;; For backward compatibility, minus with no modifiers is an ordinary
2885;; command if digits have already been entered.
2886(defun universal-argument-minus (arg)
2887 (interactive "P")
2888 (if (integerp arg)
2889 (universal-argument-other-key arg)
2890 (negative-argument arg)))
2891
2892;; Anything else terminates the argument and is left in the queue to be
2893;; executed as a command.
2894(defun universal-argument-other-key (arg)
2895 (interactive "P")
2896 (setq prefix-arg arg)
0de84e16
RS
2897 (let* ((key (this-command-keys))
2898 (keylist (listify-key-sequence key)))
2899 (setq unread-command-events
06697cdb
RS
2900 (append (nthcdr universal-argument-num-events keylist)
2901 unread-command-events)))
f0ef2555 2902 (reset-this-command-lengths)
6b61353c 2903 (restore-overriding-map))
2d88b556 2904\f
8f92b8ad
SM
2905
2906(defvar filter-buffer-substring-functions nil
2907 "Wrapper hook around `filter-buffer-substring'.
2908The functions on this special hook are called with 4 arguments:
2909 NEXT-FUN BEG END DELETE
2910NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2911that performs the default operation. The other 3 arguments are like
2912the ones passed to `filter-buffer-substring'.")
2913
7fcce20f
RS
2914(defvar buffer-substring-filters nil
2915 "List of filter functions for `filter-buffer-substring'.
2916Each function must accept a single argument, a string, and return
2917a string. The buffer substring is passed to the first function
2918in the list, and the return value of each function is passed to
2919the next. The return value of the last function is used as the
2920return value of `filter-buffer-substring'.
2921
2922If this variable is nil, no filtering is performed.")
8f92b8ad
SM
2923(make-obsolete-variable 'buffer-substring-filters
2924 'filter-buffer-substring-functions "24.1")
7fcce20f 2925
8f92b8ad 2926(defun filter-buffer-substring (beg end &optional delete)
7fcce20f 2927 "Return the buffer substring between BEG and END, after filtering.
8f92b8ad 2928The filtering is performed by `filter-buffer-substring-functions'.
7fcce20f
RS
2929
2930If DELETE is non-nil, the text between BEG and END is deleted
2931from the buffer.
2932
398c9ffb
KS
2933This function should be used instead of `buffer-substring',
2934`buffer-substring-no-properties', or `delete-and-extract-region'
2935when you want to allow filtering to take place. For example,
8f92b8ad 2936major or minor modes can use `filter-buffer-substring-functions' to
398c9ffb
KS
2937extract characters that are special to a buffer, and should not
2938be copied into other buffers."
8f92b8ad
SM
2939 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2940 (cond
2941 ((or delete buffer-substring-filters)
2942 (save-excursion
2943 (goto-char beg)
2944 (let ((string (if delete (delete-and-extract-region beg end)
2945 (buffer-substring beg end))))
2946 (dolist (filter buffer-substring-filters)
2947 (setq string (funcall filter string)))
2948 string)))
2949 (t
2950 (buffer-substring beg end)))))
398c9ffb 2951
7fcce20f 2952
93be67de 2953;;;; Window system cut and paste hooks.
70e14c01
JB
2954
2955(defvar interprogram-cut-function nil
2956 "Function to call to make a killed region available to other programs.
2957
2958Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2959pasting text between the windows of different programs.
2960This variable holds a function that Emacs calls whenever text
2961is put in the kill ring, to make the new kill available to other
70e14c01
JB
2962programs.
2963
6d7cc563
JD
2964The function takes one argument, TEXT, which is a string containing
2965the text which should be made available.")
70e14c01
JB
2966
2967(defvar interprogram-paste-function nil
2968 "Function to call to get text cut from other programs.
2969
2970Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2971pasting text between the windows of different programs.
2972This variable holds a function that Emacs calls to obtain
70e14c01
JB
2973text that other programs have provided for pasting.
2974
2975The function should be called with no arguments. If the function
2976returns nil, then no other program has provided such text, and the top
2977of the Emacs kill ring should be used. If the function returns a
6b61353c
KH
2978string, then the caller of the function \(usually `current-kill')
2979should put this string in the kill ring as the latest kill.
daa37602 2980
d4cb4833 2981This function may also return a list of strings if the window
1d2b0303 2982system supports multiple selections. The first string will be
d4cb4833
GM
2983used as the pasted text, but the other will be placed in the
2984kill ring for easy access via `yank-pop'.
2985
daa37602
JB
2986Note that the function should return a string only if a program other
2987than Emacs has provided a string for pasting; if Emacs provided the
2988most recent string, the function should return nil. If it is
2989difficult to tell whether Emacs or some other program provided the
2990current string, it is probably good enough to return nil if the string
2991is equal (according to `string=') to the last text Emacs provided.")
2d88b556 2992\f
70e14c01 2993
eaae8106 2994
70e14c01 2995;;;; The kill ring data structure.
2076c87c
JB
2996
2997(defvar kill-ring nil
70e14c01
JB
2998 "List of killed text sequences.
2999Since the kill ring is supposed to interact nicely with cut-and-paste
3000facilities offered by window systems, use of this variable should
3001interact nicely with `interprogram-cut-function' and
3002`interprogram-paste-function'. The functions `kill-new',
3003`kill-append', and `current-kill' are supposed to implement this
3004interaction; you may want to use them instead of manipulating the kill
3005ring directly.")
2076c87c 3006
bffa4d92 3007(defcustom kill-ring-max 60
1d2b0303 3008 "Maximum length of kill ring before oldest elements are thrown away."
69c1dd37
RS
3009 :type 'integer
3010 :group 'killing)
2076c87c
JB
3011
3012(defvar kill-ring-yank-pointer nil
3013 "The tail of the kill ring whose car is the last thing yanked.")
3014
4ed8c7aa 3015(defcustom save-interprogram-paste-before-kill nil
e8ab3908 3016 "Save clipboard strings into kill ring before replacing them.
4ed8c7aa
SS
3017When one selects something in another program to paste it into Emacs,
3018but kills something in Emacs before actually pasting it,
3019this selection is gone unless this variable is non-nil,
3020in which case the other program's selection is saved in the `kill-ring'
3021before the Emacs kill and one can still paste it using \\[yank] \\[yank-pop]."
3022 :type 'boolean
3023 :group 'killing
3024 :version "23.2")
3025
ba83a64e
SS
3026(defcustom kill-do-not-save-duplicates nil
3027 "Do not add a new string to `kill-ring' when it is the same as the last one."
3028 :type 'boolean
3029 :group 'killing
3030 :version "23.2")
3031
be5936a7 3032(defun kill-new (string &optional replace yank-handler)
70e14c01 3033 "Make STRING the latest kill in the kill ring.
3e505153 3034Set `kill-ring-yank-pointer' to point to it.
f914dc91
KH
3035If `interprogram-cut-function' is non-nil, apply it to STRING.
3036Optional second argument REPLACE non-nil means that STRING will replace
be5936a7
KS
3037the front of the kill ring, rather than being added to the list.
3038
4ed8c7aa
SS
3039When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3040are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3041STRING.
3042
2a262563
KS
3043When the yank handler has a non-nil PARAM element, the original STRING
3044argument is not used by `insert-for-yank'. However, since Lisp code
f33321ad 3045may access and use elements from the kill ring directly, the STRING
2a262563
KS
3046argument should still be a \"useful\" string for such uses."
3047 (if (> (length string) 0)
f1180544 3048 (if yank-handler
6b61353c
KH
3049 (put-text-property 0 (length string)
3050 'yank-handler yank-handler string))
2a262563 3051 (if yank-handler
f1180544 3052 (signal 'args-out-of-range
2a262563 3053 (list string "yank-handler specified for empty string"))))
0665f661
JL
3054 (unless (and kill-do-not-save-duplicates
3055 (equal string (car kill-ring)))
3056 (if (fboundp 'menu-bar-update-yank-menu)
3057 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
4ed8c7aa
SS
3058 (when save-interprogram-paste-before-kill
3059 (let ((interprogram-paste (and interprogram-paste-function
3060 (funcall interprogram-paste-function))))
3061 (when interprogram-paste
0665f661
JL
3062 (dolist (s (if (listp interprogram-paste)
3063 (nreverse interprogram-paste)
3064 (list interprogram-paste)))
3065 (unless (and kill-do-not-save-duplicates
3066 (equal s (car kill-ring)))
3067 (push s kill-ring))))))
3068 (unless (and kill-do-not-save-duplicates
3069 (equal string (car kill-ring)))
3070 (if (and replace kill-ring)
3071 (setcar kill-ring string)
3072 (push string kill-ring)
3073 (if (> (length kill-ring) kill-ring-max)
3074 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
70e14c01
JB
3075 (setq kill-ring-yank-pointer kill-ring)
3076 (if interprogram-cut-function
08d4877e 3077 (funcall interprogram-cut-function string)))
9fca7811
SM
3078(set-advertised-calling-convention
3079 'kill-new '(string &optional replace) "23.3")
70e14c01 3080
be5936a7 3081(defun kill-append (string before-p &optional yank-handler)
70e14c01
JB
3082 "Append STRING to the end of the latest kill in the kill ring.
3083If BEFORE-P is non-nil, prepend STRING to the kill.
be5936a7
KS
3084If `interprogram-cut-function' is set, pass the resulting kill to it."
3085 (let* ((cur (car kill-ring)))
3086 (kill-new (if before-p (concat string cur) (concat cur string))
3087 (or (= (length cur) 0)
3088 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3089 yank-handler)))
9fca7811 3090(set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
70e14c01 3091
4496b02b
RS
3092(defcustom yank-pop-change-selection nil
3093 "If non-nil, rotating the kill ring changes the window system selection."
3094 :type 'boolean
3095 :group 'killing
3096 :version "23.1")
3097
70e14c01
JB
3098(defun current-kill (n &optional do-not-move)
3099 "Rotate the yanking point by N places, and then return that kill.
f019fb21
LMI
3100If N is zero and `interprogram-paste-function' is set to a
3101function that returns a string or a list of strings, and if that
3102function doesn't return nil, then that string (or list) is added
3103to the front of the kill ring and the string (or first string in
3104the list) is returned as the latest kill.
4496b02b
RS
3105
3106If N is not zero, and if `yank-pop-change-selection' is
3107non-nil, use `interprogram-cut-function' to transfer the
3108kill at the new yank point into the window system selection.
3109
3110If optional arg DO-NOT-MOVE is non-nil, then don't actually
3111move the yanking point; just return the Nth kill forward."
3112
70e14c01
JB
3113 (let ((interprogram-paste (and (= n 0)
3114 interprogram-paste-function
3115 (funcall interprogram-paste-function))))
3116 (if interprogram-paste
3117 (progn
3118 ;; Disable the interprogram cut function when we add the new
3119 ;; text to the kill ring, so Emacs doesn't try to own the
3120 ;; selection, with identical text.
3121 (let ((interprogram-cut-function nil))
d4cb4833
GM
3122 (if (listp interprogram-paste)
3123 (mapc 'kill-new (nreverse interprogram-paste))
3124 (kill-new interprogram-paste)))
3125 (car kill-ring))
70e14c01 3126 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
3127 (let ((ARGth-kill-element
3128 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3129 (length kill-ring))
3130 kill-ring)))
4496b02b
RS
3131 (unless do-not-move
3132 (setq kill-ring-yank-pointer ARGth-kill-element)
3133 (when (and yank-pop-change-selection
3134 (> n 0)
3135 interprogram-cut-function)
3136 (funcall interprogram-cut-function (car ARGth-kill-element))))
70e14c01 3137 (car ARGth-kill-element)))))
c88ab9ce 3138
c88ab9ce 3139
eaae8106 3140
70e14c01 3141;;;; Commands for manipulating the kill ring.
c88ab9ce 3142
69c1dd37 3143(defcustom kill-read-only-ok nil
1d2b0303 3144 "Non-nil means don't signal an error for killing read-only text."
69c1dd37
RS
3145 :type 'boolean
3146 :group 'killing)
e6291fe1 3147
3a5da8a8
RS
3148(put 'text-read-only 'error-conditions
3149 '(text-read-only buffer-read-only error))
6d341a2a 3150(put 'text-read-only 'error-message (purecopy "Text is read-only"))
3a5da8a8 3151
be5936a7 3152(defun kill-region (beg end &optional yank-handler)
66e9b2b2
RS
3153 "Kill (\"cut\") text between point and mark.
3154This deletes the text from the buffer and saves it in the kill ring.
2076c87c 3155The command \\[yank] can retrieve it from there.
ba2b460a 3156\(If you want to save the region without killing it, use \\[kill-ring-save].)
81558867
EZ
3157
3158If you want to append the killed region to the last killed text,
3159use \\[append-next-kill] before \\[kill-region].
3160
2aa7a8bf
JB
3161If the buffer is read-only, Emacs will beep and refrain from deleting
3162the text, but put the text in the kill ring anyway. This means that
3163you can use the killing commands to copy text from a read-only buffer.
2076c87c 3164
a4aae1a5
CY
3165Lisp programs should use this function for killing text.
3166 (To delete text, use `delete-region'.)
c15dc81f 3167Supply two arguments, character positions indicating the stretch of text
2076c87c
JB
3168 to be killed.
3169Any command that calls this function is a \"kill command\".
3170If the previous command was also a kill command,
3171the text killed this time appends to the text killed last time
9fca7811 3172to make one entry in the kill ring."
214a3db0
RS
3173 ;; Pass point first, then mark, because the order matters
3174 ;; when calling kill-append.
3175 (interactive (list (point) (mark)))
f39d6be0
RS
3176 (unless (and beg end)
3177 (error "The mark is not set now, so there is no region"))
ccd19b9f 3178 (condition-case nil
7fcce20f 3179 (let ((string (filter-buffer-substring beg end t)))
a1eb02bd
SM
3180 (when string ;STRING is nil if BEG = END
3181 ;; Add that string to the kill ring, one way or another.
3182 (if (eq last-command 'kill-region)
be5936a7
KS
3183 (kill-append string (< end beg) yank-handler)
3184 (kill-new string nil yank-handler)))
8a7cda9b 3185 (when (or string (eq last-command 'kill-region))
6b61353c
KH
3186 (setq this-command 'kill-region))
3187 nil)
ccd19b9f
KH
3188 ((buffer-read-only text-read-only)
3189 ;; The code above failed because the buffer, or some of the characters
3190 ;; in the region, are read-only.
3191 ;; We should beep, in case the user just isn't aware of this.
3192 ;; However, there's no harm in putting
3193 ;; the region's text in the kill ring, anyway.
3194 (copy-region-as-kill beg end)
cb3e1b4c
RS
3195 ;; Set this-command now, so it will be set even if we get an error.
3196 (setq this-command 'kill-region)
3197 ;; This should barf, if appropriate, and give us the correct error.
ccd19b9f 3198 (if kill-read-only-ok
6b61353c 3199 (progn (message "Read only text copied to kill ring") nil)
ccd19b9f
KH
3200 ;; Signal an error if the buffer is read-only.
3201 (barf-if-buffer-read-only)
3202 ;; If the buffer isn't read-only, the text is.
3203 (signal 'text-read-only (list (current-buffer)))))))
9fca7811 3204(set-advertised-calling-convention 'kill-region '(beg end) "23.3")
2076c87c 3205
a382890a
KH
3206;; copy-region-as-kill no longer sets this-command, because it's confusing
3207;; to get two copies of the text when the user accidentally types M-w and
3208;; then corrects it with the intended C-w.
2076c87c
JB
3209(defun copy-region-as-kill (beg end)
3210 "Save the region as if killed, but don't kill it.
0e264847 3211In Transient Mark mode, deactivate the mark.
46947372 3212If `interprogram-cut-function' is non-nil, also save the text for a window
b66eb11b
RS
3213system cut and paste.
3214
3215This command's old key binding has been given to `kill-ring-save'."
2076c87c
JB
3216 (interactive "r")
3217 (if (eq last-command 'kill-region)
7fcce20f
RS
3218 (kill-append (filter-buffer-substring beg end) (< end beg))
3219 (kill-new (filter-buffer-substring beg end)))
d34c311a 3220 (setq deactivate-mark t)
2076c87c
JB
3221 nil)
3222
3223(defun kill-ring-save (beg end)
0964e562 3224 "Save the region as if killed, but don't kill it.
0e264847 3225In Transient Mark mode, deactivate the mark.
0964e562 3226If `interprogram-cut-function' is non-nil, also save the text for a window
0e264847
RS
3227system cut and paste.
3228
81558867
EZ
3229If you want to append the killed line to the last killed text,
3230use \\[append-next-kill] before \\[kill-ring-save].
3231
0e264847
RS
3232This command is similar to `copy-region-as-kill', except that it gives
3233visual feedback indicating the extent of the region being copied."
2076c87c
JB
3234 (interactive "r")
3235 (copy-region-as-kill beg end)
32226619 3236 ;; This use of called-interactively-p is correct
bbf41690 3237 ;; because the code it controls just gives the user visual feedback.
32226619 3238 (if (called-interactively-p 'interactive)
66050f10
RS
3239 (let ((other-end (if (= (point) beg) end beg))
3240 (opoint (point))
3241 ;; Inhibit quitting so we can make a quit here
3242 ;; look like a C-g typed as a command.
3243 (inhibit-quit t))
3244 (if (pos-visible-in-window-p other-end (selected-window))
d34c311a
SM
3245 ;; Swap point-and-mark quickly so as to show the region that
3246 ;; was selected. Don't do it if the region is highlighted.
3247 (unless (and (region-active-p)
977e2654 3248 (face-background 'region))
66050f10
RS
3249 ;; Swap point and mark.
3250 (set-marker (mark-marker) (point) (current-buffer))
3251 (goto-char other-end)
e4ef3e92 3252 (sit-for blink-matching-delay)
66050f10
RS
3253 ;; Swap back.
3254 (set-marker (mark-marker) other-end (current-buffer))
3255 (goto-char opoint)
3256 ;; If user quit, deactivate the mark
3257 ;; as C-g would as a command.
e4e593ae 3258 (and quit-flag mark-active
fcadf1c7 3259 (deactivate-mark)))
66050f10
RS
3260 (let* ((killed-text (current-kill 0))
3261 (message-len (min (length killed-text) 40)))
3262 (if (= (point) beg)
3263 ;; Don't say "killed"; that is misleading.
3264 (message "Saved text until \"%s\""
3265 (substring killed-text (- message-len)))
3266 (message "Saved text from \"%s\""
3267 (substring killed-text 0 message-len))))))))
2076c87c 3268
c75d4986
KH
3269(defun append-next-kill (&optional interactive)
3270 "Cause following command, if it kills, to append to previous kill.
3271The argument is used for internal purposes; do not supply one."
3272 (interactive "p")
3273 ;; We don't use (interactive-p), since that breaks kbd macros.
3274 (if interactive
2076c87c
JB
3275 (progn
3276 (setq this-command 'kill-region)
3277 (message "If the next command is a kill, it will append"))
3278 (setq last-command 'kill-region)))
cfb4f123 3279\f
93be67de 3280;; Yanking.
2076c87c 3281
cfb4f123
RS
3282;; This is actually used in subr.el but defcustom does not work there.
3283(defcustom yank-excluded-properties
be5936a7 3284 '(read-only invisible intangible field mouse-face help-echo local-map keymap
7408ee97 3285 yank-handler follow-link fontified)
3137dda8 3286 "Text properties to discard when yanking.
c6ff5a4c
LT
3287The value should be a list of text properties to discard or t,
3288which means to discard all text properties."
cfb4f123 3289 :type '(choice (const :tag "All" t) (repeat symbol))
c9f0110e 3290 :group 'killing
bf247b6e 3291 :version "22.1")
cfb4f123 3292
120de5bd 3293(defvar yank-window-start nil)
be5936a7 3294(defvar yank-undo-function nil
44f5a7b2
KS
3295 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3296Function is called with two parameters, START and END corresponding to
3297the value of the mark and point; it is guaranteed that START <= END.
3298Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
120de5bd 3299
6b61353c 3300(defun yank-pop (&optional arg)
ff1fbe3e
RS
3301 "Replace just-yanked stretch of killed text with a different stretch.
3302This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 3303At such a time, the region contains a stretch of reinserted
ff1fbe3e 3304previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
3305place a different stretch of killed text.
3306
3307With no argument, the previous kill is inserted.
ff1fbe3e
RS
3308With argument N, insert the Nth previous kill.
3309If N is negative, this is a more recent kill.
2076c87c
JB
3310
3311The sequence of kills wraps around, so that after the oldest one
a0e8eaa3
EZ
3312comes the newest one.
3313
3314When this command inserts killed text into the buffer, it honors
3315`yank-excluded-properties' and `yank-handler' as described in the
3316doc string for `insert-for-yank-1', which see."
2076c87c
JB
3317 (interactive "*p")
3318 (if (not (eq last-command 'yank))
3319 (error "Previous command was not a yank"))
3320 (setq this-command 'yank)
6b61353c 3321 (unless arg (setq arg 1))
3a5da8a8
RS
3322 (let ((inhibit-read-only t)
3323 (before (< (point) (mark t))))
8254897f
KS
3324 (if before
3325 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3326 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
be5936a7 3327 (setq yank-undo-function nil)
fd0f4056 3328 (set-marker (mark-marker) (point) (current-buffer))
cfb4f123 3329 (insert-for-yank (current-kill arg))
120de5bd
RS
3330 ;; Set the window start back where it was in the yank command,
3331 ;; if possible.
3332 (set-window-start (selected-window) yank-window-start t)
fd0f4056
RS
3333 (if before
3334 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3335 ;; It is cleaner to avoid activation, even though the command
3336 ;; loop would deactivate the mark because we inserted text.
3337 (goto-char (prog1 (mark t)
3338 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 3339 nil)
2076c87c
JB
3340
3341(defun yank (&optional arg)
f894e671 3342 "Reinsert (\"paste\") the last stretch of killed text.
2076c87c 3343More precisely, reinsert the stretch of killed text most recently
ff1fbe3e 3344killed OR yanked. Put point at end, and set mark at beginning.
d99f8496 3345With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
ff1fbe3e 3346With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c 3347text.
a0e8eaa3
EZ
3348
3349When this command inserts killed text into the buffer, it honors
3350`yank-excluded-properties' and `yank-handler' as described in the
3351doc string for `insert-for-yank-1', which see.
3352
a9b9303c 3353See also the command `yank-pop' (\\[yank-pop])."
2076c87c 3354 (interactive "*P")
120de5bd 3355 (setq yank-window-start (window-start))
456c617c
RS
3356 ;; If we don't get all the way thru, make last-command indicate that
3357 ;; for the following command.
3358 (setq this-command t)
2076c87c 3359 (push-mark (point))
cfb4f123
RS
3360 (insert-for-yank (current-kill (cond
3361 ((listp arg) 0)
6b61353c 3362 ((eq arg '-) -2)
cfb4f123 3363 (t (1- arg)))))
2076c87c 3364 (if (consp arg)
fd0f4056
RS
3365 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3366 ;; It is cleaner to avoid activation, even though the command
3367 ;; loop would deactivate the mark because we inserted text.
3368 (goto-char (prog1 (mark t)
3369 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c 3370 ;; If we do get all the way thru, make this-command indicate that.
be5936a7
KS
3371 (if (eq this-command t)
3372 (setq this-command 'yank))
0964e562 3373 nil)
70e14c01
JB
3374
3375(defun rotate-yank-pointer (arg)
3376 "Rotate the yanking point in the kill ring.
5626c14e 3377With ARG, rotate that many kills forward (or backward, if negative)."
70e14c01
JB
3378 (interactive "p")
3379 (current-kill arg))
2d88b556 3380\f
93be67de
KH
3381;; Some kill commands.
3382
3383;; Internal subroutine of delete-char
3384(defun kill-forward-chars (arg)
3385 (if (listp arg) (setq arg (car arg)))
3386 (if (eq arg '-) (setq arg -1))
673e5169 3387 (kill-region (point) (+ (point) arg)))
93be67de
KH
3388
3389;; Internal subroutine of backward-delete-char
3390(defun kill-backward-chars (arg)
3391 (if (listp arg) (setq arg (car arg)))
3392 (if (eq arg '-) (setq arg -1))
673e5169 3393 (kill-region (point) (- (point) arg)))
93be67de
KH
3394
3395(defcustom backward-delete-char-untabify-method 'untabify
1d2b0303 3396 "The method for untabifying when deleting backward.
1e722f9f
SS
3397Can be `untabify' -- turn a tab to many spaces, then delete one space;
3398 `hungry' -- delete all whitespace, both tabs and spaces;
3399 `all' -- delete all whitespace, including tabs, spaces and newlines;
93be67de 3400 nil -- just delete one character."
1e722f9f 3401 :type '(choice (const untabify) (const hungry) (const all) (const nil))
03167a34 3402 :version "20.3"
93be67de
KH
3403 :group 'killing)
3404
3405(defun backward-delete-char-untabify (arg &optional killp)
3406 "Delete characters backward, changing tabs into spaces.
3407The exact behavior depends on `backward-delete-char-untabify-method'.
3408Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3409Interactively, ARG is the prefix arg (default 1)
3410and KILLP is t if a prefix arg was specified."
3411 (interactive "*p\nP")
3412 (when (eq backward-delete-char-untabify-method 'untabify)
3413 (let ((count arg))
3414 (save-excursion
3415 (while (and (> count 0) (not (bobp)))
3416 (if (= (preceding-char) ?\t)
3417 (let ((col (current-column)))
3418 (forward-char -1)
3419 (setq col (- col (current-column)))
f33321ad 3420 (insert-char ?\s col)
93be67de
KH
3421 (delete-char 1)))
3422 (forward-char -1)
3423 (setq count (1- count))))))
0b1596c6 3424 (let* ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1e722f9f 3425 ((eq backward-delete-char-untabify-method 'all)
0b1596c6
JB
3426 " \t\n\r")))
3427 (n (if skip
3428 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3429 (point)))))
3430 (+ arg (if (zerop wh) 0 (1- wh))))
3431 arg)))
3432 ;; Avoid warning about delete-backward-char
3433 (with-no-warnings (delete-backward-char n killp))))
93be67de
KH
3434
3435(defun zap-to-char (arg char)
5626c14e 3436 "Kill up to and including ARGth occurrence of CHAR.
93be67de
KH
3437Case is ignored if `case-fold-search' is non-nil in the current buffer.
3438Goes backward if ARG is negative; error if CHAR not found."
e761e42c 3439 (interactive "p\ncZap to char: ")
a6c39c14
EZ
3440 ;; Avoid "obsolete" warnings for translation-table-for-input.
3441 (with-no-warnings
3442 (if (char-table-p translation-table-for-input)
3443 (setq char (or (aref translation-table-for-input char) char))))
93be67de
KH
3444 (kill-region (point) (progn
3445 (search-forward (char-to-string char) nil nil arg)
3446; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3447 (point))))
eaae8106 3448
93be67de
KH
3449;; kill-line and its subroutines.
3450
3451(defcustom kill-whole-line nil
1d2b0303 3452 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
93be67de
KH
3453 :type 'boolean
3454 :group 'killing)
3455
3456(defun kill-line (&optional arg)
3457 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5626c14e 3458With prefix argument ARG, kill that many lines from point.
93be67de 3459Negative arguments kill lines backward.
8be7408c 3460With zero argument, kills the text before point on the current line.
93be67de
KH
3461
3462When calling from a program, nil means \"no arg\",
3463a number counts as a prefix arg.
3464
3465To kill a whole line, when point is not at the beginning, type \
602157ab 3466\\[move-beginning-of-line] \\[kill-line] \\[kill-line].
93be67de 3467
022de23e
LMI
3468If `show-trailing-whitespace' is non-nil, this command will just
3469kill the rest of the current line, even if there are only
3470nonblanks there.
3471
93be67de
KH
3472If `kill-whole-line' is non-nil, then this command kills the whole line
3473including its terminating newline, when used at the beginning of a line
3474with no argument. As a consequence, you can always kill a whole line
602157ab 3475by typing \\[move-beginning-of-line] \\[kill-line].
d3f22784 3476
81558867
EZ
3477If you want to append the killed line to the last killed text,
3478use \\[append-next-kill] before \\[kill-line].
3479
d3f22784
EZ
3480If the buffer is read-only, Emacs will beep and refrain from deleting
3481the line, but put the line in the kill ring anyway. This means that
1a534b89
RS
3482you can use this command to copy text from a read-only buffer.
3483\(If the variable `kill-read-only-ok' is non-nil, then this won't
3484even beep.)"
e761e42c 3485 (interactive "P")
93be67de
KH
3486 (kill-region (point)
3487 ;; It is better to move point to the other end of the kill
3488 ;; before killing. That way, in a read-only buffer, point
3489 ;; moves across the text that is copied to the kill ring.
3490 ;; The choice has no effect on undo now that undo records
3491 ;; the value of point from before the command was run.
3492 (progn
3493 (if arg
3494 (forward-visible-line (prefix-numeric-value arg))
3495 (if (eobp)
3496 (signal 'end-of-buffer nil))
5560dc5d
RS
3497 (let ((end
3498 (save-excursion
3499 (end-of-visible-line) (point))))
3500 (if (or (save-excursion
6b61353c
KH
3501 ;; If trailing whitespace is visible,
3502 ;; don't treat it as nothing.
3503 (unless show-trailing-whitespace
3504 (skip-chars-forward " \t" end))
5560dc5d
RS
3505 (= (point) end))
3506 (and kill-whole-line (bolp)))
3507 (forward-visible-line 1)
3508 (goto-char end))))
93be67de
KH
3509 (point))))
3510
348de80b
KG
3511(defun kill-whole-line (&optional arg)
3512 "Kill current line.
5626c14e
JB
3513With prefix ARG, kill that many lines starting from the current line.
3514If ARG is negative, kill backward. Also kill the preceding newline.
01ba9662 3515\(This is meant to make \\[repeat] work well with negative arguments.\)
5626c14e 3516If ARG is zero, kill current line but exclude the trailing newline."
f8b0f284 3517 (interactive "p")
186133b4 3518 (or arg (setq arg 1))
6c770e38
LT
3519 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3520 (signal 'end-of-buffer nil))
3521 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3522 (signal 'beginning-of-buffer nil))
3523 (unless (eq last-command 'kill-region)
3524 (kill-new "")
3525 (setq last-command 'kill-region))
348de80b 3526 (cond ((zerop arg)
6c770e38
LT
3527 ;; We need to kill in two steps, because the previous command
3528 ;; could have been a kill command, in which case the text
3529 ;; before point needs to be prepended to the current kill
3530 ;; ring entry and the text after point appended. Also, we
3531 ;; need to use save-excursion to avoid copying the same text
3532 ;; twice to the kill ring in read-only buffers.
3533 (save-excursion
3534 (kill-region (point) (progn (forward-visible-line 0) (point))))
348de80b
KG
3535 (kill-region (point) (progn (end-of-visible-line) (point))))
3536 ((< arg 0)
6c770e38
LT
3537 (save-excursion
3538 (kill-region (point) (progn (end-of-visible-line) (point))))
3539 (kill-region (point)
3540 (progn (forward-visible-line (1+ arg))
3541 (unless (bobp) (backward-char))
3542 (point))))
348de80b 3543 (t
6c770e38
LT
3544 (save-excursion
3545 (kill-region (point) (progn (forward-visible-line 0) (point))))
3546 (kill-region (point)
3547 (progn (forward-visible-line arg) (point))))))
12a93712 3548
93be67de
KH
3549(defun forward-visible-line (arg)
3550 "Move forward by ARG lines, ignoring currently invisible newlines only.
3551If ARG is negative, move backward -ARG lines.
3552If ARG is zero, move to the beginning of the current line."
3553 (condition-case nil
3554 (if (> arg 0)
12a93712
RS
3555 (progn
3556 (while (> arg 0)
93be67de 3557 (or (zerop (forward-line 1))
12a93712
RS
3558 (signal 'end-of-buffer nil))
3559 ;; If the newline we just skipped is invisible,
3560 ;; don't count it.
3561 (let ((prop
3562 (get-char-property (1- (point)) 'invisible)))
3563 (if (if (eq buffer-invisibility-spec t)
3564 prop
3565 (or (memq prop buffer-invisibility-spec)
3566 (assq prop buffer-invisibility-spec)))
3567 (setq arg (1+ arg))))
3568 (setq arg (1- arg)))
3569 ;; If invisible text follows, and it is a number of complete lines,
3570 ;; skip it.
3571 (let ((opoint (point)))
3572 (while (and (not (eobp))
3573 (let ((prop
3574 (get-char-property (point) 'invisible)))
3575 (if (eq buffer-invisibility-spec t)
3576 prop
3577 (or (memq prop buffer-invisibility-spec)
3578 (assq prop buffer-invisibility-spec)))))
3579 (goto-char
3580 (if (get-text-property (point) 'invisible)
3581 (or (next-single-property-change (point) 'invisible)
3582 (point-max))
3583 (next-overlay-change (point)))))
3584 (unless (bolp)
3585 (goto-char opoint))))
93be67de 3586 (let ((first t))
f5fd8833
JB
3587 (while (or first (<= arg 0))
3588 (if first
93be67de
KH
3589 (beginning-of-line)
3590 (or (zerop (forward-line -1))
3591 (signal 'beginning-of-buffer nil)))
12a93712
RS
3592 ;; If the newline we just moved to is invisible,
3593 ;; don't count it.
3594 (unless (bobp)
3595 (let ((prop
3596 (get-char-property (1- (point)) 'invisible)))
f5fd8833
JB
3597 (unless (if (eq buffer-invisibility-spec t)
3598 prop
3599 (or (memq prop buffer-invisibility-spec)
3600 (assq prop buffer-invisibility-spec)))
3601 (setq arg (1+ arg)))))
3602 (setq first nil))
12a93712
RS
3603 ;; If invisible text follows, and it is a number of complete lines,
3604 ;; skip it.
3605 (let ((opoint (point)))
93be67de
KH
3606 (while (and (not (bobp))
3607 (let ((prop
3608 (get-char-property (1- (point)) 'invisible)))
3609 (if (eq buffer-invisibility-spec t)
3610 prop
3611 (or (memq prop buffer-invisibility-spec)
3612 (assq prop buffer-invisibility-spec)))))
3613 (goto-char
3614 (if (get-text-property (1- (point)) 'invisible)
3615 (or (previous-single-property-change (point) 'invisible)
3616 (point-min))
12a93712
RS
3617 (previous-overlay-change (point)))))
3618 (unless (bolp)
3619 (goto-char opoint)))))
93be67de
KH
3620 ((beginning-of-buffer end-of-buffer)
3621 nil)))
70e14c01 3622
93be67de
KH
3623(defun end-of-visible-line ()
3624 "Move to end of current visible line."
3625 (end-of-line)
3626 ;; If the following character is currently invisible,
3627 ;; skip all characters with that same `invisible' property value,
3628 ;; then find the next newline.
3629 (while (and (not (eobp))
5560dc5d
RS
3630 (save-excursion
3631 (skip-chars-forward "^\n")
3632 (let ((prop
3633 (get-char-property (point) 'invisible)))
3634 (if (eq buffer-invisibility-spec t)
3635 prop
3636 (or (memq prop buffer-invisibility-spec)
3637 (assq prop buffer-invisibility-spec))))))
3638 (skip-chars-forward "^\n")
93be67de
KH
3639 (if (get-text-property (point) 'invisible)
3640 (goto-char (next-single-property-change (point) 'invisible))
3641 (goto-char (next-overlay-change (point))))
3642 (end-of-line)))
2d88b556 3643\f
2076c87c
JB
3644(defun insert-buffer (buffer)
3645 "Insert after point the contents of BUFFER.
3646Puts mark after the inserted text.
6cb6e7a2
GM
3647BUFFER may be a buffer or a buffer name.
3648
3649This function is meant for the user to run interactively.
1e96c007 3650Don't call it from programs: use `insert-buffer-substring' instead!"
c3d4f949 3651 (interactive
a3e7c391
FP
3652 (list
3653 (progn
3654 (barf-if-buffer-read-only)
3655 (read-buffer "Insert buffer: "
3656 (if (eq (selected-window) (next-window (selected-window)))
3657 (other-buffer (current-buffer))
3658 (window-buffer (next-window (selected-window))))
3659 t))))
1e96c007
SM
3660 (push-mark
3661 (save-excursion
3662 (insert-buffer-substring (get-buffer buffer))
3663 (point)))
1537a263 3664 nil)
2076c87c
JB
3665
3666(defun append-to-buffer (buffer start end)
3667 "Append to specified buffer the text of the region.
3668It is inserted into that buffer before its point.
3669
3670When calling from a program, give three arguments:
3671BUFFER (or buffer name), START and END.
3672START and END specify the portion of the current buffer to be copied."
70e14c01 3673 (interactive
5d771766 3674 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 3675 (region-beginning) (region-end)))
85626eef
SM
3676 (let* ((oldbuf (current-buffer))
3677 (append-to (get-buffer-create buffer))
3678 (windows (get-buffer-window-list append-to t t))
3679 point)
3680 (save-excursion
3681 (with-current-buffer append-to
3682 (setq point (point))
3683 (barf-if-buffer-read-only)
3684 (insert-buffer-substring oldbuf start end)
3685 (dolist (window windows)
3686 (when (= (window-point window) point)
3687 (set-window-point window (point))))))))
2076c87c
JB
3688
3689(defun prepend-to-buffer (buffer start end)
3690 "Prepend to specified buffer the text of the region.
3691It is inserted into that buffer after its point.
3692
3693When calling from a program, give three arguments:
3694BUFFER (or buffer name), START and END.
3695START and END specify the portion of the current buffer to be copied."
3696 (interactive "BPrepend to buffer: \nr")
3697 (let ((oldbuf (current-buffer)))
7fdbcd83 3698 (with-current-buffer (get-buffer-create buffer)
74399eac 3699 (barf-if-buffer-read-only)
2076c87c
JB
3700 (save-excursion
3701 (insert-buffer-substring oldbuf start end)))))
3702
3703(defun copy-to-buffer (buffer start end)
3704 "Copy to specified buffer the text of the region.
3705It is inserted into that buffer, replacing existing text there.
3706
3707When calling from a program, give three arguments:
3708BUFFER (or buffer name), START and END.
3709START and END specify the portion of the current buffer to be copied."
3710 (interactive "BCopy to buffer: \nr")
3711 (let ((oldbuf (current-buffer)))
1b5fd09e 3712 (with-current-buffer (get-buffer-create buffer)
74399eac 3713 (barf-if-buffer-read-only)
2076c87c
JB
3714 (erase-buffer)
3715 (save-excursion
3716 (insert-buffer-substring oldbuf start end)))))
2d88b556 3717\f
62d1c1fc 3718(put 'mark-inactive 'error-conditions '(mark-inactive error))
8f43cbf3 3719(put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
62d1c1fc 3720
0251bafb
RS
3721(defvar activate-mark-hook nil
3722 "Hook run when the mark becomes active.
3723It is also run at the end of a command, if the mark is active and
6cbb0bb0 3724it is possible that the region may have changed.")
0251bafb
RS
3725
3726(defvar deactivate-mark-hook nil
3727 "Hook run when the mark becomes inactive.")
3728
af39530e 3729(defun mark (&optional force)
f00239cf
RS
3730 "Return this buffer's mark value as integer, or nil if never set.
3731
3732In Transient Mark mode, this function signals an error if
3733the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3734or the argument FORCE is non-nil, it disregards whether the mark
3735is active, and returns an integer or nil in the usual way.
af39530e 3736
2076c87c
JB
3737If you are using this in an editing command, you are most likely making
3738a mistake; see the documentation of `set-mark'."
0e3a7b14 3739 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
af39530e 3740 (marker-position (mark-marker))
62d1c1fc 3741 (signal 'mark-inactive nil)))
2076c87c 3742
f9be2e35 3743(defsubst deactivate-mark (&optional force)
19d35374 3744 "Deactivate the mark by setting `mark-active' to nil.
f9be2e35
CY
3745Unless FORCE is non-nil, this function does nothing if Transient
3746Mark mode is disabled.
3747This function also runs `deactivate-mark-hook'."
3748 (when (or transient-mark-mode force)
7c23dd44
CY
3749 (when (and (if (eq select-active-regions 'only)
3750 (eq (car-safe transient-mark-mode) 'only)
3751 select-active-regions)
9852377f
CY
3752 (region-active-p)
3753 (display-selections-p))
3754 ;; The var `saved-region-selection', if non-nil, is the text in
3755 ;; the region prior to the last command modifying the buffer.
3756 ;; Set the selection to that, or to the current region.
3757 (cond (saved-region-selection
3758 (x-set-selection 'PRIMARY saved-region-selection)
3759 (setq saved-region-selection nil))
3760 ((/= (region-beginning) (region-end))
3761 (x-set-selection 'PRIMARY
3762 (buffer-substring-no-properties
1bcb9e65
CY
3763 (region-beginning)
3764 (region-end))))))
f9be2e35
CY
3765 (if (and (null force)
3766 (or (eq transient-mark-mode 'lambda)
3767 (and (eq (car-safe transient-mark-mode) 'only)
3768 (null (cdr transient-mark-mode)))))
3769 ;; When deactivating a temporary region, don't change
3770 ;; `mark-active' or run `deactivate-mark-hook'.
109cfe4e
CY
3771 (setq transient-mark-mode nil)
3772 (if (eq (car-safe transient-mark-mode) 'only)
3773 (setq transient-mark-mode (cdr transient-mark-mode)))
3774 (setq mark-active nil)
3775 (run-hooks 'deactivate-mark-hook))))
19d35374 3776
2977fc37
SM
3777(defun activate-mark ()
3778 "Activate the mark."
3779 (when (mark t)
3780 (setq mark-active t)
3781 (unless transient-mark-mode
9852377f 3782 (setq transient-mark-mode 'lambda))))
98b2fff4 3783
2076c87c
JB
3784(defun set-mark (pos)
3785 "Set this buffer's mark to POS. Don't use this function!
3786That is to say, don't use this function unless you want
3787the user to see that the mark has moved, and you want the previous
3788mark position to be lost.
3789
3790Normally, when a new mark is set, the old one should go on the stack.
f59006cb 3791This is why most applications should use `push-mark', not `set-mark'.
2076c87c 3792
ff1fbe3e 3793Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3794purposes. The mark saves a location for the user's convenience.
3795Most editing commands should not alter the mark.
3796To remember a location for internal use in the Lisp program,
3797store it in a Lisp variable. Example:
3798
3799 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3800
fcadf1c7
RS
3801 (if pos
3802 (progn
3803 (setq mark-active t)
3804 (run-hooks 'activate-mark-hook)
3805 (set-marker (mark-marker) pos (current-buffer)))
24c22852 3806 ;; Normally we never clear mark-active except in Transient Mark mode.
f9be2e35
CY
3807 ;; But when we actually clear out the mark value too, we must
3808 ;; clear mark-active in any mode.
3809 (deactivate-mark t)
24c22852 3810 (set-marker (mark-marker) nil)))
2076c87c 3811
d03b9b31 3812(defcustom use-empty-active-region nil
6a9127b6
CY
3813 "Whether \"region-aware\" commands should act on empty regions.
3814If nil, region-aware commands treat empty regions as inactive.
3815If non-nil, region-aware commands treat the region as active as
3816long as the mark is active, even if the region is empty.
3817
58b356e9
CY
3818Region-aware commands are those that act on the region if it is
3819active and Transient Mark mode is enabled, and on the text near
3820point otherwise."
d03b9b31
RS
3821 :type 'boolean
3822 :version "23.1"
3823 :group 'editing-basics)
3824
cb3a9d33 3825(defun use-region-p ()
6a9127b6
CY
3826 "Return t if the region is active and it is appropriate to act on it.
3827This is used by commands that act specially on the region under
16f2e9fc 3828Transient Mark mode.
6a9127b6 3829
c876b263 3830The return value is t if Transient Mark mode is enabled and the
e5b826ae
CY
3831mark is active; furthermore, if `use-empty-active-region' is nil,
3832the region must not be empty. Otherwise, the return value is nil.
16f2e9fc
CY
3833
3834For some commands, it may be appropriate to ignore the value of
3835`use-empty-active-region'; in that case, use `region-active-p'."
d34c311a 3836 (and (region-active-p)
d03b9b31
RS
3837 (or use-empty-active-region (> (region-end) (region-beginning)))))
3838
02d52519 3839(defun region-active-p ()
afa39f21 3840 "Return t if Transient Mark mode is enabled and the mark is active.
6a9127b6 3841
16f2e9fc
CY
3842Some commands act specially on the region when Transient Mark
3843mode is enabled. Usually, such commands should use
3844`use-region-p' instead of this function, because `use-region-p'
3845also checks the value of `use-empty-active-region'."
02d52519
RS
3846 (and transient-mark-mode mark-active))
3847
2076c87c 3848(defvar mark-ring nil
e55e2267 3849 "The list of former marks of the current buffer, most recent first.")
2076c87c 3850(make-variable-buffer-local 'mark-ring)
e55e2267 3851(put 'mark-ring 'permanent-local t)
2076c87c 3852
69c1dd37 3853(defcustom mark-ring-max 16
1d2b0303 3854 "Maximum size of mark ring. Start discarding off end if gets this big."
69c1dd37
RS
3855 :type 'integer
3856 :group 'editing-basics)
2076c87c 3857
dc029f0b
RM
3858(defvar global-mark-ring nil
3859 "The list of saved global marks, most recent first.")
3860
69c1dd37 3861(defcustom global-mark-ring-max 16
1d2b0303 3862 "Maximum size of global mark ring. \
69c1dd37
RS
3863Start discarding off end if gets this big."
3864 :type 'integer
3865 :group 'editing-basics)
dc029f0b 3866
868c2f49 3867(defun pop-to-mark-command ()
5626c14e
JB
3868 "Jump to mark, and pop a new position for mark off the ring.
3869\(Does not affect global mark ring\)."
868c2f49
KS
3870 (interactive)
3871 (if (null (mark t))
3872 (error "No mark set in this buffer")
fb2c06a3
RS
3873 (if (= (point) (mark t))
3874 (message "Mark popped"))
868c2f49
KS
3875 (goto-char (mark t))
3876 (pop-mark)))
3877
d00ffe21 3878(defun push-mark-command (arg &optional nomsg)
868c2f49 3879 "Set mark at where point is.
5626c14e 3880If no prefix ARG and mark is already set there, just activate it.
d00ffe21 3881Display `Mark set' unless the optional second arg NOMSG is non-nil."
868c2f49
KS
3882 (interactive "P")
3883 (let ((mark (marker-position (mark-marker))))
3884 (if (or arg (null mark) (/= mark (point)))
d00ffe21 3885 (push-mark nil nomsg t)
868c2f49 3886 (setq mark-active t)
0251bafb 3887 (run-hooks 'activate-mark-hook)
d00ffe21
KS
3888 (unless nomsg
3889 (message "Mark activated")))))
868c2f49 3890
6a936796 3891(defcustom set-mark-command-repeat-pop nil
1d2b0303 3892 "Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
ebd2fc0d
RS
3893That means that C-u \\[set-mark-command] \\[set-mark-command]
3894will pop the mark twice, and
3895C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
3896will pop the mark three times.
3897
7b17b503 3898A value of nil means \\[set-mark-command]'s behavior does not change
ebd2fc0d 3899after C-u \\[set-mark-command]."
6a936796 3900 :type 'boolean
034ce0ec 3901 :group 'editing-basics)
6a936796 3902
125f7951
SM
3903(defcustom set-mark-default-inactive nil
3904 "If non-nil, setting the mark does not activate it.
3905This causes \\[set-mark-command] and \\[exchange-point-and-mark] to
0fc10137
JL
3906behave the same whether or not `transient-mark-mode' is enabled."
3907 :type 'boolean
3908 :group 'editing-basics
3909 :version "23.1")
125f7951 3910
2076c87c 3911(defun set-mark-command (arg)
fb2c06a3
RS
3912 "Set the mark where point is, or jump to the mark.
3913Setting the mark also alters the region, which is the text
3914between point and mark; this is the closest equivalent in
3915Emacs to what some editors call the \"selection\".
146adea3 3916
fb2c06a3
RS
3917With no prefix argument, set the mark at point, and push the
3918old mark position on local mark ring. Also push the old mark on
3919global mark ring, if the previous mark was set in another buffer.
146adea3 3920
17923ef2
CY
3921When Transient Mark Mode is off, immediately repeating this
3922command activates `transient-mark-mode' temporarily.
66ef2df9 3923
146adea3 3924With prefix argument \(e.g., \\[universal-argument] \\[set-mark-command]\), \
fb2c06a3 3925jump to the mark, and set the mark from
146adea3
EZ
3926position popped off the local mark ring \(this does not affect the global
3927mark ring\). Use \\[pop-global-mark] to jump to a mark popped off the global
66ef2df9 3928mark ring \(see `pop-global-mark'\).
18c5df40 3929
2ef0a47e 3930If `set-mark-command-repeat-pop' is non-nil, repeating
146adea3 3931the \\[set-mark-command] command with no prefix argument pops the next position
2ef0a47e 3932off the local (or global) mark ring and jumps there.
66ef2df9 3933
fb2c06a3
RS
3934With \\[universal-argument] \\[universal-argument] as prefix
3935argument, unconditionally set mark where point is, even if
3936`set-mark-command-repeat-pop' is non-nil.
7cb42362 3937
ff1fbe3e 3938Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3939purposes. See the documentation of `set-mark' for more information."
3940 (interactive "P")
109cfe4e
CY
3941 (cond ((eq transient-mark-mode 'lambda)
3942 (setq transient-mark-mode nil))
3943 ((eq (car-safe transient-mark-mode) 'only)
3944 (deactivate-mark)))
868c2f49 3945 (cond
18c5df40
KS
3946 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3947 (push-mark-command nil))
868c2f49 3948 ((not (eq this-command 'set-mark-command))
1841f9e3
KS
3949 (if arg
3950 (pop-to-mark-command)
3951 (push-mark-command t)))
6a936796
RS
3952 ((and set-mark-command-repeat-pop
3953 (eq last-command 'pop-to-mark-command))
66ef2df9
KS
3954 (setq this-command 'pop-to-mark-command)
3955 (pop-to-mark-command))
6a936796
RS
3956 ((and set-mark-command-repeat-pop
3957 (eq last-command 'pop-global-mark)
3958 (not arg))
66ef2df9
KS
3959 (setq this-command 'pop-global-mark)
3960 (pop-global-mark))
868c2f49 3961 (arg
1841f9e3 3962 (setq this-command 'pop-to-mark-command)
868c2f49 3963 (pop-to-mark-command))
2977fc37
SM
3964 ((eq last-command 'set-mark-command)
3965 (if (region-active-p)
3966 (progn
3967 (deactivate-mark)
3968 (message "Mark deactivated"))
3969 (activate-mark)
3970 (message "Mark activated")))
868c2f49 3971 (t
125f7951
SM
3972 (push-mark-command nil)
3973 (if set-mark-default-inactive (deactivate-mark)))))
2076c87c 3974
fd0f4056 3975(defun push-mark (&optional location nomsg activate)
2076c87c 3976 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
3977If the last global mark pushed was not in the current buffer,
3978also push LOCATION on the global mark ring.
fd0f4056 3979Display `Mark set' unless the optional second arg NOMSG is non-nil.
2076c87c 3980
ff1fbe3e 3981Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
3982purposes. See the documentation of `set-mark' for more information.
3983
de9606f0 3984In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
1a0d0b6a 3985 (unless (null (mark t))
2076c87c 3986 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1a0d0b6a
JPW
3987 (when (> (length mark-ring) mark-ring-max)
3988 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3989 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
9a1277dd 3990 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 3991 ;; Now push the mark on the global mark ring.
f1382a3d 3992 (if (and global-mark-ring
e08d3f7c 3993 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
3994 ;; The last global mark pushed was in this same buffer.
3995 ;; Don't push another one.
3996 nil
3997 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1a0d0b6a
JPW
3998 (when (> (length global-mark-ring) global-mark-ring-max)
3999 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4000 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
efcf38c7 4001 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2076c87c 4002 (message "Mark set"))
8cdc660f
RS
4003 (if (or activate (not transient-mark-mode))
4004 (set-mark (mark t)))
2076c87c
JB
4005 nil)
4006
4007(defun pop-mark ()
4008 "Pop off mark ring into the buffer's actual mark.
4009Does not set point. Does nothing if mark ring is empty."
1a0d0b6a
JPW
4010 (when mark-ring
4011 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4012 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1a0d0b6a
JPW
4013 (move-marker (car mark-ring) nil)
4014 (if (null (mark t)) (ding))
0137bae6
JL
4015 (setq mark-ring (cdr mark-ring)))
4016 (deactivate-mark))
2076c87c 4017
c613687b
SM
4018(define-obsolete-function-alias
4019 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
868c2f49 4020(defun exchange-point-and-mark (&optional arg)
af39530e
RS
4021 "Put the mark where point is now, and point where the mark is now.
4022This command works even when the mark is not active,
868c2f49 4023and it reactivates the mark.
109cfe4e 4024
5626c14e 4025If Transient Mark mode is on, a prefix ARG deactivates the mark
109cfe4e 4026if it is active, and otherwise avoids reactivating it. If
5626c14e 4027Transient Mark mode is off, a prefix ARG enables Transient Mark
109cfe4e 4028mode temporarily."
868c2f49 4029 (interactive "P")
109cfe4e
CY
4030 (let ((omark (mark t))
4031 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
2977fc37
SM
4032 (if (null omark)
4033 (error "No mark set in this buffer"))
109cfe4e 4034 (deactivate-mark)
2977fc37
SM
4035 (set-mark (point))
4036 (goto-char omark)
125f7951 4037 (if set-mark-default-inactive (deactivate-mark))
109cfe4e
CY
4038 (cond (temp-highlight
4039 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4040 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4041 (not (or arg (region-active-p))))
4042 (deactivate-mark))
4043 (t (activate-mark)))
2977fc37 4044 nil))
e23c2c21 4045
11ff3b67 4046(defcustom shift-select-mode t
84db11d6
SM
4047 "When non-nil, shifted motion keys activate the mark momentarily.
4048
4049While the mark is activated in this way, any shift-translated point
4050motion key extends the region, and if Transient Mark mode was off, it
4051is temporarily turned on. Furthermore, the mark will be deactivated
4052by any subsequent point motion key that was not shift-translated, or
4053by any action that normally deactivates the mark in Transient Mark mode.
4054
4055See `this-command-keys-shift-translated' for the meaning of
11ff3b67
AS
4056shift-translation."
4057 :type 'boolean
4058 :group 'editing-basics)
84db11d6
SM
4059
4060(defun handle-shift-selection ()
337c561c
CY
4061 "Activate/deactivate mark depending on invocation thru shift translation.
4062This function is called by `call-interactively' when a command
4063with a `^' character in its `interactive' spec is invoked, before
4064running the command itself.
4065
4066If `shift-select-mode' is enabled and the command was invoked
4067through shift translation, set the mark and activate the region
4068temporarily, unless it was already set in this way. See
4069`this-command-keys-shift-translated' for the meaning of shift
4070translation.
4071
4072Otherwise, if the region has been activated temporarily,
4073deactivate it, and restore the variable `transient-mark-mode' to
4074its earlier value."
84db11d6 4075 (cond ((and shift-select-mode this-command-keys-shift-translated)
9852377f
CY
4076 (unless (and mark-active
4077 (eq (car-safe transient-mark-mode) 'only))
91023c68 4078 (setq transient-mark-mode
84db11d6
SM
4079 (cons 'only
4080 (unless (eq transient-mark-mode 'lambda)
4081 transient-mark-mode)))
4082 (push-mark nil nil t)))
4083 ((eq (car-safe transient-mark-mode) 'only)
4084 (setq transient-mark-mode (cdr transient-mark-mode))
4085 (deactivate-mark))))
109cfe4e 4086
6710df48 4087(define-minor-mode transient-mark-mode
e23c2c21 4088 "Toggle Transient Mark mode.
1d2b0303 4089With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
e23c2c21 4090
5dd1220d
RS
4091In Transient Mark mode, when the mark is active, the region is highlighted.
4092Changing the buffer \"deactivates\" the mark.
4093So do certain other operations that set the mark
4094but whose main purpose is something else--for example,
cfa70244
EZ
4095incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
4096
8e843bc4
EZ
4097You can also deactivate the mark by typing \\[keyboard-quit] or
4098\\[keyboard-escape-quit].
1465c66b 4099
cfa70244
EZ
4100Many commands change their behavior when Transient Mark mode is in effect
4101and the mark is active, by acting on the region instead of their usual
4c5f7215 4102default part of the buffer's text. Examples of such commands include
705a5933
JL
4103\\[comment-dwim], \\[flush-lines], \\[keep-lines], \
4104\\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
4105Invoke \\[apropos-documentation] and type \"transient\" or
4106\"mark.*active\" at the prompt, to see the documentation of
4107commands which are sensitive to the Transient Mark mode."
43d16385 4108 :global t
9d794026
GM
4109 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4110 :variable transient-mark-mode)
109cfe4e 4111
d0c4882d
RS
4112(defvar widen-automatically t
4113 "Non-nil means it is ok for commands to call `widen' when they want to.
4114Some commands will do this in order to go to positions outside
4115the current accessible part of the buffer.
4116
4117If `widen-automatically' is nil, these commands will do something else
4118as a fallback, and won't change the buffer bounds.")
4119
38111a5a
SM
4120(defvar non-essential nil
4121 "Whether the currently executing code is performing an essential task.
4122This variable should be non-nil only when running code which should not
4123disturb the user. E.g. it can be used to prevent Tramp from prompting the
4124user for a password when we are simply scanning a set of files in the
4125background or displaying possible completions before the user even asked
4126for it.")
4127
dc029f0b
RM
4128(defun pop-global-mark ()
4129 "Pop off global mark ring and jump to the top location."
4130 (interactive)
52b6d445
RS
4131 ;; Pop entries which refer to non-existent buffers.
4132 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4133 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
4134 (or global-mark-ring
4135 (error "No global mark set"))
4136 (let* ((marker (car global-mark-ring))
4137 (buffer (marker-buffer marker))
4138 (position (marker-position marker)))
34c31301
RS
4139 (setq global-mark-ring (nconc (cdr global-mark-ring)
4140 (list (car global-mark-ring))))
dc029f0b
RM
4141 (set-buffer buffer)
4142 (or (and (>= position (point-min))
4143 (<= position (point-max)))
d0c4882d 4144 (if widen-automatically
60aee8b2
RS
4145 (widen)
4146 (error "Global mark position is outside accessible part of buffer")))
dc029f0b
RM
4147 (goto-char position)
4148 (switch-to-buffer buffer)))
2d88b556 4149\f
95791033 4150(defcustom next-line-add-newlines nil
1d2b0303 4151 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
69c1dd37 4152 :type 'boolean
e1d6e383 4153 :version "21.1"
69c1dd37 4154 :group 'editing-basics)
38ebcf29 4155
295f6616 4156(defun next-line (&optional arg try-vscroll)
2076c87c 4157 "Move cursor vertically down ARG lines.
295f6616 4158Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
4159If there is no character in the target line exactly under the current column,
4160the cursor is positioned after the character in that line which spans this
4161column, or at the end of the line if it is not long enough.
38ebcf29 4162If there is no line in the buffer after this one, behavior depends on the
1a2c3941
RS
4163value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4164to create a line, and moves the cursor to that line. Otherwise it moves the
e47d38f6 4165cursor to the end of the buffer.
2076c87c 4166
53a22af4
CY
4167If the variable `line-move-visual' is non-nil, this command moves
4168by display lines. Otherwise, it moves by buffer lines, without
4169taking variable-width characters or continued lines into account.
4170
2076c87c 4171The command \\[set-goal-column] can be used to create
85969cb1
RS
4172a semipermanent goal column for this command.
4173Then instead of trying to move exactly vertically (or as close as possible),
4174this command moves to the specified goal column (or as close as possible).
4175The goal column is stored in the variable `goal-column', which is nil
064f328a
EZ
4176when there is no goal column. Note that setting `goal-column'
4177overrides `line-move-visual' and causes this command to move by buffer
4178lines rather than by display lines.
2076c87c
JB
4179
4180If you are thinking of using this in a Lisp program, consider
4181using `forward-line' instead. It is usually easier to use
4182and more reliable (no dependence on goal column, etc.)."
109cfe4e 4183 (interactive "^p\np")
6b61353c 4184 (or arg (setq arg 1))
028922cf 4185 (if (and next-line-add-newlines (= arg 1))
207d7545
GM
4186 (if (save-excursion (end-of-line) (eobp))
4187 ;; When adding a newline, don't expand an abbrev.
4188 (let ((abbrev-mode nil))
24886813 4189 (end-of-line)
15575807 4190 (insert (if use-hard-newlines hard-newline "\n")))
295f6616 4191 (line-move arg nil nil try-vscroll))
32226619 4192 (if (called-interactively-p 'interactive)
1cd095c6 4193 (condition-case err
295f6616 4194 (line-move arg nil nil try-vscroll)
1cd095c6
JL
4195 ((beginning-of-buffer end-of-buffer)
4196 (signal (car err) (cdr err))))
295f6616 4197 (line-move arg nil nil try-vscroll)))
2076c87c
JB
4198 nil)
4199
295f6616 4200(defun previous-line (&optional arg try-vscroll)
2076c87c 4201 "Move cursor vertically up ARG lines.
295f6616 4202Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
4203If there is no character in the target line exactly over the current column,
4204the cursor is positioned after the character in that line which spans this
4205column, or at the end of the line if it is not long enough.
4206
53a22af4
CY
4207If the variable `line-move-visual' is non-nil, this command moves
4208by display lines. Otherwise, it moves by buffer lines, without
4209taking variable-width characters or continued lines into account.
4210
2076c87c 4211The command \\[set-goal-column] can be used to create
85969cb1
RS
4212a semipermanent goal column for this command.
4213Then instead of trying to move exactly vertically (or as close as possible),
4214this command moves to the specified goal column (or as close as possible).
4215The goal column is stored in the variable `goal-column', which is nil
064f328a
EZ
4216when there is no goal column. Note that setting `goal-column'
4217overrides `line-move-visual' and causes this command to move by buffer
4218lines rather than by display lines.
2076c87c
JB
4219
4220If you are thinking of using this in a Lisp program, consider using
c2e8a012 4221`forward-line' with a negative argument instead. It is usually easier
2076c87c 4222to use and more reliable (no dependence on goal column, etc.)."
109cfe4e 4223 (interactive "^p\np")
6b61353c 4224 (or arg (setq arg 1))
32226619 4225 (if (called-interactively-p 'interactive)
1cd095c6 4226 (condition-case err
295f6616 4227 (line-move (- arg) nil nil try-vscroll)
1cd095c6
JL
4228 ((beginning-of-buffer end-of-buffer)
4229 (signal (car err) (cdr err))))
295f6616 4230 (line-move (- arg) nil nil try-vscroll))
2076c87c 4231 nil)
eaae8106 4232
69c1dd37 4233(defcustom track-eol nil
1d2b0303 4234 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
2076c87c 4235This means moving to the end of each line moved onto.
4efebb82
CY
4236The beginning of a blank line does not count as the end of a line.
4237This has no effect when `line-move-visual' is non-nil."
69c1dd37
RS
4238 :type 'boolean
4239 :group 'editing-basics)
4240
4241(defcustom goal-column nil
064f328a
EZ
4242 "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.
4243A non-nil setting overrides `line-move-visual', which see."
69c1dd37
RS
4244 :type '(choice integer
4245 (const :tag "None" nil))
4246 :group 'editing-basics)
912c6728 4247(make-variable-buffer-local 'goal-column)
2076c87c
JB
4248
4249(defvar temporary-goal-column 0
4250 "Current goal column for vertical motion.
4efebb82 4251It is the column where point was at the start of the current run
774409a1
CY
4252of vertical motion commands.
4253
4254When moving by visual lines via `line-move-visual', it is a cons
4255cell (COL . HSCROLL), where COL is the x-position, in pixels,
4256divided by the default column width, and HSCROLL is the number of
4257columns by which window is scrolled from left margin.
4258
4259When the `track-eol' feature is doing its job, the value is
4efebb82 4260`most-positive-fixnum'.")
2076c87c 4261
bbf41690 4262(defcustom line-move-ignore-invisible t
1d2b0303 4263 "Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
69c1dd37
RS
4264Outline mode sets this."
4265 :type 'boolean
4266 :group 'editing-basics)
098fc1fb 4267
a2cf21a2 4268(defcustom line-move-visual t
4efebb82
CY
4269 "When non-nil, `line-move' moves point by visual lines.
4270This movement is based on where the cursor is displayed on the
4271screen, instead of relying on buffer contents alone. It takes
66e0718b 4272into account variable-width characters and line continuation.
064f328a
EZ
4273If nil, `line-move' moves point by logical lines.
4274A non-nil setting of `goal-column' overrides the value of this variable
fe5f08dd
EZ
4275and forces movement by logical lines.
4276Disabling `auto-hscroll-mode' also overrides forces movement by logical
4277lines when the window is horizontally scrolled."
a2cf21a2 4278 :type 'boolean
66e0718b
CY
4279 :group 'editing-basics
4280 :version "23.1")
4efebb82 4281
b704b1f0
KS
4282;; Returns non-nil if partial move was done.
4283(defun line-move-partial (arg noerror to-end)
4284 (if (< arg 0)
4285 ;; Move backward (up).
4286 ;; If already vscrolled, reduce vscroll
4287 (let ((vs (window-vscroll nil t)))
4288 (when (> vs (frame-char-height))
4289 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4290
4291 ;; Move forward (down).
e437f99a
KS
4292 (let* ((lh (window-line-height -1))
4293 (vpos (nth 1 lh))
4294 (ypos (nth 2 lh))
4295 (rbot (nth 3 lh))
3137dda8 4296 py vs)
e437f99a
KS
4297 (when (or (null lh)
4298 (>= rbot (frame-char-height))
4299 (<= ypos (- (frame-char-height))))
4300 (unless lh
0e7a5039
KS
4301 (let ((wend (pos-visible-in-window-p t nil t)))
4302 (setq rbot (nth 3 wend)
4303 vpos (nth 5 wend))))
e437f99a
KS
4304 (cond
4305 ;; If last line of window is fully visible, move forward.
4306 ((or (null rbot) (= rbot 0))
4307 nil)
4308 ;; If cursor is not in the bottom scroll margin, move forward.
4309 ((and (> vpos 0)
95f5a37f
KS
4310 (< (setq py
4311 (or (nth 1 (window-line-height))
4312 (let ((ppos (posn-at-point)))
4313 (cdr (or (posn-actual-col-row ppos)
4314 (posn-col-row ppos))))))
e437f99a
KS
4315 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4316 nil)
4317 ;; When already vscrolled, we vscroll some more if we can,
4318 ;; or clear vscroll and move forward at end of tall image.
4319 ((> (setq vs (window-vscroll nil t)) 0)
4320 (when (> rbot 0)
4321 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4322 ;; If cursor just entered the bottom scroll margin, move forward,
4323 ;; but also vscroll one line so redisplay wont recenter.
4324 ((and (> vpos 0)
4325 (= py (min (- (window-text-height) scroll-margin 1)
4326 (1- vpos))))
4327 (set-window-vscroll nil (frame-char-height) t)
4328 (line-move-1 arg noerror to-end)
4329 t)
4330 ;; If there are lines above the last line, scroll-up one line.
4331 ((> vpos 0)
4332 (scroll-up 1)
4333 t)
4334 ;; Finally, start vscroll.
4335 (t
4336 (set-window-vscroll nil (frame-char-height) t)))))))
b704b1f0
KS
4337
4338
03ceda9e
RS
4339;; This is like line-move-1 except that it also performs
4340;; vertical scrolling of tall images if appropriate.
4341;; That is not really a clean thing to do, since it mixes
4342;; scrolling with cursor motion. But so far we don't have
4343;; a cleaner solution to the problem of making C-n do something
4344;; useful given a tall image.
ed02c1db 4345(defun line-move (arg &optional noerror to-end try-vscroll)
b704b1f0
KS
4346 (unless (and auto-window-vscroll try-vscroll
4347 ;; Only vscroll for single line moves
4348 (= (abs arg) 1)
4349 ;; But don't vscroll in a keyboard macro.
4350 (not defining-kbd-macro)
4351 (not executing-kbd-macro)
4352 (line-move-partial arg noerror to-end))
4353 (set-window-vscroll nil 0 t)
fe5f08dd
EZ
4354 (if (and line-move-visual
4355 ;; Display-based column are incompatible with goal-column.
4356 (not goal-column)
4357 ;; When auto-hscroll-mode is turned off and the text in
4358 ;; the window is scrolled to the left, display-based
4359 ;; motion doesn't make sense (because each logical line
4360 ;; occupies exactly one screen line).
4361 (not (and (null auto-hscroll-mode)
4362 (> (window-hscroll) 0))))
4efebb82
CY
4363 (line-move-visual arg noerror)
4364 (line-move-1 arg noerror to-end))))
4365
4366;; Display-based alternative to line-move-1.
4367;; Arg says how many lines to move. The value is t if we can move the
4368;; specified number of lines.
4369(defun line-move-visual (arg &optional noerror)
34be836c 4370 (let ((opoint (point))
774409a1 4371 (hscroll (window-hscroll))
34be836c 4372 target-hscroll)
774409a1
CY
4373 ;; Check if the previous command was a line-motion command, or if
4374 ;; we were called from some other command.
34be836c
CY
4375 (if (and (consp temporary-goal-column)
4376 (memq last-command `(next-line previous-line ,this-command)))
4377 ;; If so, there's no need to reset `temporary-goal-column',
4378 ;; but we may need to hscroll.
4379 (if (or (/= (cdr temporary-goal-column) hscroll)
4380 (> (cdr temporary-goal-column) 0))
4381 (setq target-hscroll (cdr temporary-goal-column)))
4382 ;; Otherwise, we should reset `temporary-goal-column'.
4383 (let ((posn (posn-at-point)))
4384 (cond
4385 ;; Handle the `overflow-newline-into-fringe' case:
4386 ((eq (nth 1 posn) 'right-fringe)
4387 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4388 ((car (posn-x-y posn))
4389 (setq temporary-goal-column
4390 (cons (/ (float (car (posn-x-y posn)))
4391 (frame-char-width)) hscroll))))))
4392 (if target-hscroll
4393 (set-window-hscroll (selected-window) target-hscroll))
624a662f 4394 (or (and (= (vertical-motion
774409a1
CY
4395 (cons (or goal-column
4396 (if (consp temporary-goal-column)
5a66ed0f 4397 (car temporary-goal-column)
774409a1
CY
4398 temporary-goal-column))
4399 arg))
624a662f
CY
4400 arg)
4401 (or (>= arg 0)
4402 (/= (point) opoint)
4403 ;; If the goal column lies on a display string,
4404 ;; `vertical-motion' advances the cursor to the end
4405 ;; of the string. For arg < 0, this can cause the
4406 ;; cursor to get stuck. (Bug#3020).
4407 (= (vertical-motion arg) arg)))
4408 (unless noerror
4409 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4410 nil)))))
16c2f92f 4411
8c745744
RS
4412;; This is the guts of next-line and previous-line.
4413;; Arg says how many lines to move.
bbf41690 4414;; The value is t if we can move the specified number of lines.
06b60517 4415(defun line-move-1 (arg &optional noerror _to-end)
2596511d
RS
4416 ;; Don't run any point-motion hooks, and disregard intangibility,
4417 ;; for intermediate positions.
4418 (let ((inhibit-point-motion-hooks t)
4419 (opoint (point))
fef11f15 4420 (orig-arg arg))
774409a1
CY
4421 (if (consp temporary-goal-column)
4422 (setq temporary-goal-column (+ (car temporary-goal-column)
4423 (cdr temporary-goal-column))))
2596511d
RS
4424 (unwind-protect
4425 (progn
41d22ee0 4426 (if (not (memq last-command '(next-line previous-line)))
2596511d
RS
4427 (setq temporary-goal-column
4428 (if (and track-eol (eolp)
4429 ;; Don't count beg of empty line as end of line
4430 ;; unless we just did explicit end-of-line.
ab9623c2 4431 (or (not (bolp)) (eq last-command 'move-end-of-line)))
3137dda8 4432 most-positive-fixnum
2596511d 4433 (current-column))))
bbf41690 4434
3137dda8
SM
4435 (if (not (or (integerp selective-display)
4436 line-move-ignore-invisible))
2596511d 4437 ;; Use just newline characters.
e9cd25fe 4438 ;; Set ARG to 0 if we move as many lines as requested.
2596511d
RS
4439 (or (if (> arg 0)
4440 (progn (if (> arg 1) (forward-line (1- arg)))
4441 ;; This way of moving forward ARG lines
4442 ;; verifies that we have a newline after the last one.
4443 ;; It doesn't get confused by intangible text.
4444 (end-of-line)
e9cd25fe
RS
4445 (if (zerop (forward-line 1))
4446 (setq arg 0)))
2596511d 4447 (and (zerop (forward-line arg))
e9cd25fe
RS
4448 (bolp)
4449 (setq arg 0)))
bbf41690
RS
4450 (unless noerror
4451 (signal (if (< arg 0)
4452 'beginning-of-buffer
4453 'end-of-buffer)
4454 nil)))
2596511d 4455 ;; Move by arg lines, but ignore invisible ones.
07889873 4456 (let (done)
bbf41690
RS
4457 (while (and (> arg 0) (not done))
4458 ;; If the following character is currently invisible,
4459 ;; skip all characters with that same `invisible' property value.
c65e6942 4460 (while (and (not (eobp)) (invisible-p (point)))
bbf41690 4461 (goto-char (next-char-property-change (point))))
fef11f15
CY
4462 ;; Move a line.
4463 ;; We don't use `end-of-line', since we want to escape
40b1a3a9 4464 ;; from field boundaries occurring exactly at point.
07889873
CY
4465 (goto-char (constrain-to-field
4466 (let ((inhibit-field-text-motion t))
4467 (line-end-position))
4468 (point) t t
4469 'inhibit-line-move-field-capture))
e9ab825f 4470 ;; If there's no invisibility here, move over the newline.
3e43ae87
KS
4471 (cond
4472 ((eobp)
4473 (if (not noerror)
4474 (signal 'end-of-buffer nil)
4475 (setq done t)))
4476 ((and (> arg 1) ;; Use vertical-motion for last move
4477 (not (integerp selective-display))
c65e6942 4478 (not (invisible-p (point))))
3e43ae87
KS
4479 ;; We avoid vertical-motion when possible
4480 ;; because that has to fontify.
4481 (forward-line 1))
4482 ;; Otherwise move a more sophisticated way.
4483 ((zerop (vertical-motion 1))
4484 (if (not noerror)
4485 (signal 'end-of-buffer nil)
4486 (setq done t))))
bbf41690
RS
4487 (unless done
4488 (setq arg (1- arg))))
22c8bff1 4489 ;; The logic of this is the same as the loop above,
e9ab825f 4490 ;; it just goes in the other direction.
bbf41690 4491 (while (and (< arg 0) (not done))
ac6701ea
CY
4492 ;; For completely consistency with the forward-motion
4493 ;; case, we should call beginning-of-line here.
4494 ;; However, if point is inside a field and on a
4495 ;; continued line, the call to (vertical-motion -1)
4496 ;; below won't move us back far enough; then we return
4497 ;; to the same column in line-move-finish, and point
4498 ;; gets stuck -- cyd
4499 (forward-line 0)
3e43ae87
KS
4500 (cond
4501 ((bobp)
4502 (if (not noerror)
4503 (signal 'beginning-of-buffer nil)
4504 (setq done t)))
4505 ((and (< arg -1) ;; Use vertical-motion for last move
4506 (not (integerp selective-display))
c65e6942 4507 (not (invisible-p (1- (point)))))
3e43ae87
KS
4508 (forward-line -1))
4509 ((zerop (vertical-motion -1))
4510 (if (not noerror)
4511 (signal 'beginning-of-buffer nil)
4512 (setq done t))))
bbf41690
RS
4513 (unless done
4514 (setq arg (1+ arg))
4515 (while (and ;; Don't move over previous invis lines
4516 ;; if our target is the middle of this line.
4517 (or (zerop (or goal-column temporary-goal-column))
4518 (< arg 0))
c65e6942 4519 (not (bobp)) (invisible-p (1- (point))))
bbf41690
RS
4520 (goto-char (previous-char-property-change (point))))))))
4521 ;; This is the value the function returns.
4522 (= arg 0))
af894fc9 4523
e9cd25fe 4524 (cond ((> arg 0)
2a1e0c92
CY
4525 ;; If we did not move down as far as desired, at least go
4526 ;; to end of line. Be sure to call point-entered and
4527 ;; point-left-hooks.
4528 (let* ((npoint (prog1 (line-end-position)
4529 (goto-char opoint)))
4530 (inhibit-point-motion-hooks nil))
4531 (goto-char npoint)))
e9cd25fe 4532 ((< arg 0)
f9872a6b
JL
4533 ;; If we did not move up as far as desired,
4534 ;; at least go to beginning of line.
2a1e0c92
CY
4535 (let* ((npoint (prog1 (line-beginning-position)
4536 (goto-char opoint)))
4537 (inhibit-point-motion-hooks nil))
4538 (goto-char npoint)))
e9cd25fe 4539 (t
20782abb 4540 (line-move-finish (or goal-column temporary-goal-column)
fef11f15 4541 opoint (> orig-arg 0)))))))
2076c87c 4542
20782abb 4543(defun line-move-finish (column opoint forward)
af894fc9
RS
4544 (let ((repeat t))
4545 (while repeat
4546 ;; Set REPEAT to t to repeat the whole thing.
4547 (setq repeat nil)
4548
1f980920 4549 (let (new
963355a4 4550 (old (point))
5ed619e0 4551 (line-beg (line-beginning-position))
1f980920
RS
4552 (line-end
4553 ;; Compute the end of the line
20782abb 4554 ;; ignoring effectively invisible newlines.
bbf41690 4555 (save-excursion
a5b4a6a0
RS
4556 ;; Like end-of-line but ignores fields.
4557 (skip-chars-forward "^\n")
c65e6942 4558 (while (and (not (eobp)) (invisible-p (point)))
20782abb 4559 (goto-char (next-char-property-change (point)))
a5b4a6a0 4560 (skip-chars-forward "^\n"))
bbf41690 4561 (point))))
1f980920
RS
4562
4563 ;; Move to the desired column.
54b99340 4564 (line-move-to-column (truncate column))
963355a4
CY
4565
4566 ;; Corner case: suppose we start out in a field boundary in
4567 ;; the middle of a continued line. When we get to
4568 ;; line-move-finish, point is at the start of a new *screen*
4569 ;; line but the same text line; then line-move-to-column would
4570 ;; move us backwards. Test using C-n with point on the "x" in
4571 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4572 (and forward
4573 (< (point) old)
4574 (goto-char old))
4575
1f980920 4576 (setq new (point))
af894fc9
RS
4577
4578 ;; Process intangibility within a line.
594a1605
CY
4579 ;; With inhibit-point-motion-hooks bound to nil, a call to
4580 ;; goto-char moves point past intangible text.
4581
4582 ;; However, inhibit-point-motion-hooks controls both the
4583 ;; intangibility and the point-entered/point-left hooks. The
4584 ;; following hack avoids calling the point-* hooks
4585 ;; unnecessarily. Note that we move *forward* past intangible
4586 ;; text when the initial and final points are the same.
d584e29d 4587 (goto-char new)
af894fc9
RS
4588 (let ((inhibit-point-motion-hooks nil))
4589 (goto-char new)
4590
4591 ;; If intangibility moves us to a different (later) place
4592 ;; in the same line, use that as the destination.
4593 (if (<= (point) line-end)
1f980920
RS
4594 (setq new (point))
4595 ;; If that position is "too late",
4596 ;; try the previous allowable position.
4597 ;; See if it is ok.
4598 (backward-char)
20782abb
RS
4599 (if (if forward
4600 ;; If going forward, don't accept the previous
4601 ;; allowable position if it is before the target line.
f1e2a033 4602 (< line-beg (point))
20782abb
RS
4603 ;; If going backward, don't accept the previous
4604 ;; allowable position if it is still after the target line.
4605 (<= (point) line-end))
1f980920
RS
4606 (setq new (point))
4607 ;; As a last resort, use the end of the line.
4608 (setq new line-end))))
af894fc9
RS
4609
4610 ;; Now move to the updated destination, processing fields
4611 ;; as well as intangibility.
4612 (goto-char opoint)
4613 (let ((inhibit-point-motion-hooks nil))
4614 (goto-char
e94e78cc
CY
4615 ;; Ignore field boundaries if the initial and final
4616 ;; positions have the same `field' property, even if the
4617 ;; fields are non-contiguous. This seems to be "nicer"
4618 ;; behavior in many situations.
4619 (if (eq (get-char-property new 'field)
4620 (get-char-property opoint 'field))
4621 new
4622 (constrain-to-field new opoint t t
4623 'inhibit-line-move-field-capture))))
af894fc9 4624
1f980920 4625 ;; If all this moved us to a different line,
af894fc9
RS
4626 ;; retry everything within that new line.
4627 (when (or (< (point) line-beg) (> (point) line-end))
4628 ;; Repeat the intangibility and field processing.
4629 (setq repeat t))))))
4630
4631(defun line-move-to-column (col)
4632 "Try to find column COL, considering invisibility.
4633This function works only in certain cases,
4634because what we really need is for `move-to-column'
4635and `current-column' to be able to ignore invisible text."
a615252b
RS
4636 (if (zerop col)
4637 (beginning-of-line)
095f9ae4 4638 (move-to-column col))
af894fc9
RS
4639
4640 (when (and line-move-ignore-invisible
c65e6942 4641 (not (bolp)) (invisible-p (1- (point))))
af894fc9
RS
4642 (let ((normal-location (point))
4643 (normal-column (current-column)))
4644 ;; If the following character is currently invisible,
4645 ;; skip all characters with that same `invisible' property value.
4646 (while (and (not (eobp))
c65e6942 4647 (invisible-p (point)))
af894fc9
RS
4648 (goto-char (next-char-property-change (point))))
4649 ;; Have we advanced to a larger column position?
4650 (if (> (current-column) normal-column)
4651 ;; We have made some progress towards the desired column.
4652 ;; See if we can make any further progress.
4653 (line-move-to-column (+ (current-column) (- col normal-column)))
4654 ;; Otherwise, go to the place we originally found
4655 ;; and move back over invisible text.
4656 ;; that will get us to the same place on the screen
4657 ;; but with a more reasonable buffer position.
4658 (goto-char normal-location)
5ed619e0 4659 (let ((line-beg (line-beginning-position)))
c65e6942 4660 (while (and (not (bolp)) (invisible-p (1- (point))))
af894fc9
RS
4661 (goto-char (previous-char-property-change (point) line-beg))))))))
4662
bbf41690 4663(defun move-end-of-line (arg)
f00239cf 4664 "Move point to end of current line as displayed.
bbf41690
RS
4665With argument ARG not nil or 1, move forward ARG - 1 lines first.
4666If point reaches the beginning or end of buffer, it stops there.
fdb77e6f
CY
4667
4668To ignore the effects of the `intangible' text or overlay
4669property, bind `inhibit-point-motion-hooks' to t.
4670If there is an image in the current line, this function
4671disregards newlines that are part of the text on which the image
4672rests."
109cfe4e 4673 (interactive "^p")
bbf41690
RS
4674 (or arg (setq arg 1))
4675 (let (done)
4676 (while (not done)
4677 (let ((newpos
4678 (save-excursion
4efebb82
CY
4679 (let ((goal-column 0)
4680 (line-move-visual nil))
bbf41690 4681 (and (line-move arg t)
3f2e7735
EZ
4682 ;; With bidi reordering, we may not be at bol,
4683 ;; so make sure we are.
4684 (skip-chars-backward "^\n")
bbf41690
RS
4685 (not (bobp))
4686 (progn
c65e6942 4687 (while (and (not (bobp)) (invisible-p (1- (point))))
3137dda8
SM
4688 (goto-char (previous-single-char-property-change
4689 (point) 'invisible)))
bbf41690
RS
4690 (backward-char 1)))
4691 (point)))))
4692 (goto-char newpos)
4693 (if (and (> (point) newpos)
4694 (eq (preceding-char) ?\n))
4695 (backward-char 1)
4696 (if (and (> (point) newpos) (not (eobp))
4697 (not (eq (following-char) ?\n)))
4efebb82
CY
4698 ;; If we skipped something intangible and now we're not
4699 ;; really at eol, keep going.
bbf41690
RS
4700 (setq arg 1)
4701 (setq done t)))))))
4702
0cbb497c 4703(defun move-beginning-of-line (arg)
f00239cf
RS
4704 "Move point to beginning of current line as displayed.
4705\(If there's an image in the line, this disregards newlines
4706which are part of the text that the image rests on.)
4707
0cbb497c
KS
4708With argument ARG not nil or 1, move forward ARG - 1 lines first.
4709If point reaches the beginning or end of buffer, it stops there.
f00239cf 4710To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
109cfe4e 4711 (interactive "^p")
0cbb497c 4712 (or arg (setq arg 1))
398c9ffb 4713
ad47c4a0 4714 (let ((orig (point))
3137dda8 4715 first-vis first-vis-field-value)
1fffd65f
RS
4716
4717 ;; Move by lines, if ARG is not 1 (the default).
4718 (if (/= arg 1)
4efebb82
CY
4719 (let ((line-move-visual nil))
4720 (line-move (1- arg) t)))
1fffd65f
RS
4721
4722 ;; Move to beginning-of-line, ignoring fields and invisibles.
4723 (skip-chars-backward "^\n")
c65e6942 4724 (while (and (not (bobp)) (invisible-p (1- (point))))
621a4cc8 4725 (goto-char (previous-char-property-change (point)))
1fffd65f 4726 (skip-chars-backward "^\n"))
ad47c4a0
RS
4727
4728 ;; Now find first visible char in the line
c65e6942 4729 (while (and (not (eobp)) (invisible-p (point)))
ad47c4a0
RS
4730 (goto-char (next-char-property-change (point))))
4731 (setq first-vis (point))
4732
4733 ;; See if fields would stop us from reaching FIRST-VIS.
4734 (setq first-vis-field-value
4735 (constrain-to-field first-vis orig (/= arg 1) t nil))
4736
4737 (goto-char (if (/= first-vis-field-value first-vis)
4738 ;; If yes, obey them.
4739 first-vis-field-value
4740 ;; Otherwise, move to START with attention to fields.
4741 ;; (It is possible that fields never matter in this case.)
4742 (constrain-to-field (point) orig
4743 (/= arg 1) t nil)))))
0cbb497c
KS
4744
4745
85be9ec4
SM
4746;; Many people have said they rarely use this feature, and often type
4747;; it by accident. Maybe it shouldn't even be on a key.
d5ab2033 4748(put 'set-goal-column 'disabled t)
2076c87c
JB
4749
4750(defun set-goal-column (arg)
4751 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
4752Those commands will move to this position in the line moved to
4753rather than trying to keep the same horizontal position.
5626c14e 4754With a non-nil argument ARG, clears out the goal column
912c6728
RS
4755so that \\[next-line] and \\[previous-line] resume vertical motion.
4756The goal column is stored in the variable `goal-column'."
2076c87c
JB
4757 (interactive "P")
4758 (if arg
4759 (progn
4760 (setq goal-column nil)
4761 (message "No goal column"))
4762 (setq goal-column (current-column))
8a26c165
DG
4763 ;; The older method below can be erroneous if `set-goal-column' is bound
4764 ;; to a sequence containing %
4765 ;;(message (substitute-command-keys
4766 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
4767 ;;goal-column)
4768 (message "%s"
63219d53 4769 (concat
8a26c165
DG
4770 (format "Goal column %d " goal-column)
4771 (substitute-command-keys
4772 "(use \\[set-goal-column] with an arg to unset it)")))
63219d53 4773
8a26c165 4774 )
2076c87c 4775 nil)
2d88b556 4776\f
a2cf21a2
CY
4777;;; Editing based on visual lines, as opposed to logical lines.
4778
4779(defun end-of-visual-line (&optional n)
4780 "Move point to end of current visual line.
4781With argument N not nil or 1, move forward N - 1 visual lines first.
4782If point reaches the beginning or end of buffer, it stops there.
4783To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4784 (interactive "^p")
4785 (or n (setq n 1))
4786 (if (/= n 1)
4787 (let ((line-move-visual t))
4788 (line-move (1- n) t)))
ef187c24
CY
4789 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4790 ;; constrain to field boundaries, so we don't either.
a2cf21a2
CY
4791 (vertical-motion (cons (window-width) 0)))
4792
4793(defun beginning-of-visual-line (&optional n)
4794 "Move point to beginning of current visual line.
4795With argument N not nil or 1, move forward N - 1 visual lines first.
4796If point reaches the beginning or end of buffer, it stops there.
4797To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4798 (interactive "^p")
4799 (or n (setq n 1))
ef187c24
CY
4800 (let ((opoint (point)))
4801 (if (/= n 1)
4802 (let ((line-move-visual t))
4803 (line-move (1- n) t)))
4804 (vertical-motion 0)
4805 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4806 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
a2cf21a2
CY
4807
4808(defun kill-visual-line (&optional arg)
4809 "Kill the rest of the visual line.
ad4c1f62
CY
4810With prefix argument ARG, kill that many visual lines from point.
4811If ARG is negative, kill visual lines backward.
4812If ARG is zero, kill the text before point on the current visual
4813line.
a2cf21a2
CY
4814
4815If you want to append the killed line to the last killed text,
4816use \\[append-next-kill] before \\[kill-line].
4817
4818If the buffer is read-only, Emacs will beep and refrain from deleting
4819the line, but put the line in the kill ring anyway. This means that
4820you can use this command to copy text from a read-only buffer.
4821\(If the variable `kill-read-only-ok' is non-nil, then this won't
4822even beep.)"
4823 (interactive "P")
ad4c1f62
CY
4824 ;; Like in `kill-line', it's better to move point to the other end
4825 ;; of the kill before killing.
2066b4fe
CY
4826 (let ((opoint (point))
4827 (kill-whole-line (and kill-whole-line (bolp))))
a2cf21a2
CY
4828 (if arg
4829 (vertical-motion (prefix-numeric-value arg))
ad4c1f62
CY
4830 (end-of-visual-line 1)
4831 (if (= (point) opoint)
4832 (vertical-motion 1)
4833 ;; Skip any trailing whitespace at the end of the visual line.
4834 ;; We used to do this only if `show-trailing-whitespace' is
4835 ;; nil, but that's wrong; the correct thing would be to check
4836 ;; whether the trailing whitespace is highlighted. But, it's
4837 ;; OK to just do this unconditionally.
4838 (skip-chars-forward " \t")))
2066b4fe
CY
4839 (kill-region opoint (if (and kill-whole-line (looking-at "\n"))
4840 (1+ (point))
4841 (point)))))
a2cf21a2
CY
4842
4843(defun next-logical-line (&optional arg try-vscroll)
4844 "Move cursor vertically down ARG lines.
1d2b0303 4845This is identical to `next-line', except that it always moves
a2cf21a2
CY
4846by logical lines instead of visual lines, ignoring the value of
4847the variable `line-move-visual'."
4848 (interactive "^p\np")
4849 (let ((line-move-visual nil))
4850 (with-no-warnings
4851 (next-line arg try-vscroll))))
4852
4853(defun previous-logical-line (&optional arg try-vscroll)
4854 "Move cursor vertically up ARG lines.
4855This is identical to `previous-line', except that it always moves
4856by logical lines instead of visual lines, ignoring the value of
4857the variable `line-move-visual'."
4858 (interactive "^p\np")
4859 (let ((line-move-visual nil))
4860 (with-no-warnings
4861 (previous-line arg try-vscroll))))
4862
4dec5cff
CY
4863(defgroup visual-line nil
4864 "Editing based on visual lines."
4865 :group 'convenience
4866 :version "23.1")
4867
a2cf21a2
CY
4868(defvar visual-line-mode-map
4869 (let ((map (make-sparse-keymap)))
4870 (define-key map [remap kill-line] 'kill-visual-line)
4871 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4872 (define-key map [remap move-end-of-line] 'end-of-visual-line)
b316b2b8
CY
4873 ;; These keybindings interfere with xterm function keys. Are
4874 ;; there any other suitable bindings?
4875 ;; (define-key map "\M-[" 'previous-logical-line)
4876 ;; (define-key map "\M-]" 'next-logical-line)
a2cf21a2
CY
4877 map))
4878
4dec5cff
CY
4879(defcustom visual-line-fringe-indicators '(nil nil)
4880 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4881The value should be a list of the form (LEFT RIGHT), where LEFT
4882and RIGHT are symbols representing the bitmaps to display, to
4883indicate wrapped lines, in the left and right fringes respectively.
4884See also `fringe-indicator-alist'.
4885The default is not to display fringe indicators for wrapped lines.
4886This variable does not affect fringe indicators displayed for
4887other purposes."
4888 :type '(list (choice (const :tag "Hide left indicator" nil)
4889 (const :tag "Left curly arrow" left-curly-arrow)
4890 (symbol :tag "Other bitmap"))
4891 (choice (const :tag "Hide right indicator" nil)
4892 (const :tag "Right curly arrow" right-curly-arrow)
4893 (symbol :tag "Other bitmap")))
4894 :set (lambda (symbol value)
4895 (dolist (buf (buffer-list))
4896 (with-current-buffer buf
4897 (when (and (boundp 'visual-line-mode)
4898 (symbol-value 'visual-line-mode))
4899 (setq fringe-indicator-alist
4900 (cons (cons 'continuation value)
4901 (assq-delete-all
4902 'continuation
4903 (copy-tree fringe-indicator-alist)))))))
4904 (set-default symbol value)))
4905
748e001a
CY
4906(defvar visual-line--saved-state nil)
4907
a2cf21a2 4908(define-minor-mode visual-line-mode
b677cb96
CY
4909 "Redefine simple editing commands to act on visual lines, not logical lines.
4910This also turns on `word-wrap' in the buffer."
a2cf21a2 4911 :keymap visual-line-mode-map
4dec5cff 4912 :group 'visual-line
ea92f9f3 4913 :lighter " Wrap"
a2cf21a2
CY
4914 (if visual-line-mode
4915 (progn
748e001a
CY
4916 (set (make-local-variable 'visual-line--saved-state) nil)
4917 ;; Save the local values of some variables, to be restored if
4918 ;; visual-line-mode is turned off.
4919 (dolist (var '(line-move-visual truncate-lines
4920 truncate-partial-width-windows
4921 word-wrap fringe-indicator-alist))
4922 (if (local-variable-p var)
37820ea9 4923 (push (cons var (symbol-value var))
748e001a 4924 visual-line--saved-state)))
a2cf21a2 4925 (set (make-local-variable 'line-move-visual) t)
c58140f4
CY
4926 (set (make-local-variable 'truncate-partial-width-windows) nil)
4927 (setq truncate-lines nil
4928 word-wrap t
4929 fringe-indicator-alist
4dec5cff
CY
4930 (cons (cons 'continuation visual-line-fringe-indicators)
4931 fringe-indicator-alist)))
a2cf21a2 4932 (kill-local-variable 'line-move-visual)
4dec5cff 4933 (kill-local-variable 'word-wrap)
c58140f4
CY
4934 (kill-local-variable 'truncate-lines)
4935 (kill-local-variable 'truncate-partial-width-windows)
748e001a
CY
4936 (kill-local-variable 'fringe-indicator-alist)
4937 (dolist (saved visual-line--saved-state)
4938 (set (make-local-variable (car saved)) (cdr saved)))
4939 (kill-local-variable 'visual-line--saved-state)))
a2cf21a2
CY
4940
4941(defun turn-on-visual-line-mode ()
4942 (visual-line-mode 1))
4943
4944(define-globalized-minor-mode global-visual-line-mode
4945 visual-line-mode turn-on-visual-line-mode
4946 :lighter " vl")
5a97d2da 4947
2d88b556 4948\f
2076c87c
JB
4949(defun transpose-chars (arg)
4950 "Interchange characters around point, moving forward one character.
4951With prefix arg ARG, effect is to take character before point
4952and drag it forward past ARG other characters (backward if ARG negative).
4953If no argument and at end of line, the previous two chars are exchanged."
4954 (interactive "*P")
4955 (and (null arg) (eolp) (forward-char -1))
4956 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4957
4958(defun transpose-words (arg)
4959 "Interchange words around point, leaving point at end of them.
4960With prefix arg ARG, effect is to take word before or around point
4961and drag it forward past ARG other words (backward if ARG negative).
4962If ARG is zero, the words around or after point and around or after mark
4963are interchanged."
41d22ee0 4964 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
2076c87c
JB
4965 (interactive "*p")
4966 (transpose-subr 'forward-word arg))
4967
4968(defun transpose-sexps (arg)
4969 "Like \\[transpose-words] but applies to sexps.
4970Does not work on a sexp that point is in the middle of
4971if it is a list or string."
4972 (interactive "*p")
41d22ee0
SM
4973 (transpose-subr
4974 (lambda (arg)
4975 ;; Here we should try to simulate the behavior of
4976 ;; (cons (progn (forward-sexp x) (point))
4977 ;; (progn (forward-sexp (- x)) (point)))
4978 ;; Except that we don't want to rely on the second forward-sexp
4979 ;; putting us back to where we want to be, since forward-sexp-function
4980 ;; might do funny things like infix-precedence.
4981 (if (if (> arg 0)
4982 (looking-at "\\sw\\|\\s_")
4983 (and (not (bobp))
4984 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
4985 ;; Jumping over a symbol. We might be inside it, mind you.
4986 (progn (funcall (if (> arg 0)
4987 'skip-syntax-backward 'skip-syntax-forward)
4988 "w_")
4989 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4990 ;; Otherwise, we're between sexps. Take a step back before jumping
4991 ;; to make sure we'll obey the same precedence no matter which direction
4992 ;; we're going.
4993 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4994 (cons (save-excursion (forward-sexp arg) (point))
4995 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4996 (not (zerop (funcall (if (> arg 0)
4997 'skip-syntax-forward
4998 'skip-syntax-backward)
4999 ".")))))
5000 (point)))))
5001 arg 'special))
2076c87c
JB
5002
5003(defun transpose-lines (arg)
5004 "Exchange current line and previous line, leaving point after both.
5005With argument ARG, takes previous line and moves it past ARG lines.
5006With argument 0, interchanges line point is in with line mark is in."
5007 (interactive "*p")
5008 (transpose-subr (function
5009 (lambda (arg)
d3f4ef3f 5010 (if (> arg 0)
2076c87c 5011 (progn
d3f4ef3f
AS
5012 ;; Move forward over ARG lines,
5013 ;; but create newlines if necessary.
5014 (setq arg (forward-line arg))
5015 (if (/= (preceding-char) ?\n)
5016 (setq arg (1+ arg)))
5017 (if (> arg 0)
5018 (newline arg)))
2076c87c
JB
5019 (forward-line arg))))
5020 arg))
5021
36020642
GM
5022;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5023;; which seems inconsistent with the ARG /= 0 case.
5024;; FIXME document SPECIAL.
e1e04350 5025(defun transpose-subr (mover arg &optional special)
36020642
GM
5026 "Subroutine to do the work of transposing objects.
5027Works for lines, sentences, paragraphs, etc. MOVER is a function that
5028moves forward by units of the given object (e.g. forward-sentence,
5029forward-paragraph). If ARG is zero, exchanges the current object
5030with the one containing mark. If ARG is an integer, moves the
5031current object past ARG following (if ARG is positive) or
5032preceding (if ARG is negative) objects, leaving point after the
5033current object."
e1e04350
SM
5034 (let ((aux (if special mover
5035 (lambda (x)
5036 (cons (progn (funcall mover x) (point))
5037 (progn (funcall mover (- x)) (point))))))
5038 pos1 pos2)
5039 (cond
5040 ((= arg 0)
5041 (save-excursion
5042 (setq pos1 (funcall aux 1))
41849bf9 5043 (goto-char (or (mark) (error "No mark set in this buffer")))
e1e04350
SM
5044 (setq pos2 (funcall aux 1))
5045 (transpose-subr-1 pos1 pos2))
5046 (exchange-point-and-mark))
5047 ((> arg 0)
5048 (setq pos1 (funcall aux -1))
5049 (setq pos2 (funcall aux arg))
5050 (transpose-subr-1 pos1 pos2)
5051 (goto-char (car pos2)))
5052 (t
5053 (setq pos1 (funcall aux -1))
5054 (goto-char (car pos1))
5055 (setq pos2 (funcall aux arg))
5056 (transpose-subr-1 pos1 pos2)))))
5057
5058(defun transpose-subr-1 (pos1 pos2)
5059 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5060 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5061 (when (> (car pos1) (car pos2))
5062 (let ((swap pos1))
5063 (setq pos1 pos2 pos2 swap)))
5064 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
dc7d7552
RS
5065 (atomic-change-group
5066 (let (word2)
1e96c007
SM
5067 ;; FIXME: We first delete the two pieces of text, so markers that
5068 ;; used to point to after the text end up pointing to before it :-(
dc7d7552
RS
5069 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5070 (goto-char (car pos2))
5071 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5072 (goto-char (car pos1))
5073 (insert word2))))
2d88b556 5074\f
6b61353c 5075(defun backward-word (&optional arg)
b7e91b0c 5076 "Move backward until encountering the beginning of a word.
5626c14e 5077With argument ARG, do this that many times."
109cfe4e 5078 (interactive "^p")
6b61353c 5079 (forward-word (- (or arg 1))))
2076c87c 5080
a1a801de 5081(defun mark-word (&optional arg allow-extend)
705a5933
JL
5082 "Set mark ARG words away from point.
5083The place mark goes is the same place \\[forward-word] would
5084move to with the same argument.
a1a801de 5085Interactively, if this command is repeated
771069f8 5086or (in Transient Mark mode) if the mark is active,
705a5933 5087it marks the next ARG words after the ones already marked."
a1a801de
RS
5088 (interactive "P\np")
5089 (cond ((and allow-extend
5090 (or (and (eq last-command this-command) (mark t))
d34c311a 5091 (region-active-p)))
705a5933
JL
5092 (setq arg (if arg (prefix-numeric-value arg)
5093 (if (< (mark) (point)) -1 1)))
cad113ae
KG
5094 (set-mark
5095 (save-excursion
5096 (goto-char (mark))
5097 (forward-word arg)
5098 (point))))
5099 (t
5100 (push-mark
5101 (save-excursion
705a5933 5102 (forward-word (prefix-numeric-value arg))
cad113ae
KG
5103 (point))
5104 nil t))))
2076c87c
JB
5105
5106(defun kill-word (arg)
5107 "Kill characters forward until encountering the end of a word.
5626c14e 5108With argument ARG, do this that many times."
e761e42c 5109 (interactive "p")
89ee2bf6 5110 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
5111
5112(defun backward-kill-word (arg)
654ec269 5113 "Kill characters backward until encountering the beginning of a word.
5626c14e 5114With argument ARG, do this that many times."
e761e42c 5115 (interactive "p")
2076c87c 5116 (kill-word (- arg)))
d7c64071 5117
0f7df535
RS
5118(defun current-word (&optional strict really-word)
5119 "Return the symbol or word that point is on (or a nearby one) as a string.
5120The return value includes no text properties.
1e8c5ac4 5121If optional arg STRICT is non-nil, return nil unless point is within
0fa19a57
RS
5122or adjacent to a symbol or word. In all cases the value can be nil
5123if there is no word nearby.
0f7df535
RS
5124The function, belying its name, normally finds a symbol.
5125If optional arg REALLY-WORD is non-nil, it finds just a word."
d7c64071 5126 (save-excursion
0f7df535 5127 (let* ((oldpoint (point)) (start (point)) (end (point))
81d17173 5128 (syntaxes (if really-word "w" "w_"))
0f7df535
RS
5129 (not-syntaxes (concat "^" syntaxes)))
5130 (skip-syntax-backward syntaxes) (setq start (point))
d7c64071 5131 (goto-char oldpoint)
0f7df535
RS
5132 (skip-syntax-forward syntaxes) (setq end (point))
5133 (when (and (eq start oldpoint) (eq end oldpoint)
5134 ;; Point is neither within nor adjacent to a word.
5135 (not strict))
5136 ;; Look for preceding word in same line.
9b026d9f 5137 (skip-syntax-backward not-syntaxes (line-beginning-position))
0f7df535
RS
5138 (if (bolp)
5139 ;; No preceding word in same line.
5140 ;; Look for following word in same line.
5141 (progn
9b026d9f 5142 (skip-syntax-forward not-syntaxes (line-end-position))
0f7df535
RS
5143 (setq start (point))
5144 (skip-syntax-forward syntaxes)
5145 (setq end (point)))
5146 (setq end (point))
5147 (skip-syntax-backward syntaxes)
5148 (setq start (point))))
5149 ;; If we found something nonempty, return it as a string.
5150 (unless (= start end)
020db25f 5151 (buffer-substring-no-properties start end)))))
2d88b556 5152\f
69c1dd37 5153(defcustom fill-prefix nil
1d2b0303 5154 "String for filling to insert at front of new line, or nil for none."
69c1dd37
RS
5155 :type '(choice (const :tag "None" nil)
5156 string)
5157 :group 'fill)
2076c87c 5158(make-variable-buffer-local 'fill-prefix)
f31b1257 5159(put 'fill-prefix 'safe-local-variable 'string-or-null-p)
2076c87c 5160
69c1dd37 5161(defcustom auto-fill-inhibit-regexp nil
1d2b0303 5162 "Regexp to match lines which should not be auto-filled."
69c1dd37
RS
5163 :type '(choice (const :tag "None" nil)
5164 regexp)
5165 :group 'fill)
2076c87c
JB
5166
5167(defun do-auto-fill ()
ce558208
GM
5168 "The default value for `normal-auto-fill-function'.
5169This is the default auto-fill function, some major modes use a different one.
5170Returns t if it really did any work."
621a3f62 5171 (let (fc justify give-up
a0170800 5172 (fill-prefix fill-prefix))
c18465c4 5173 (if (or (not (setq justify (current-justification)))
8f066a20
RS
5174 (null (setq fc (current-fill-column)))
5175 (and (eq justify 'left)
5176 (<= (current-column) fc))
621a3f62
SM
5177 (and auto-fill-inhibit-regexp
5178 (save-excursion (beginning-of-line)
eed5698b
RS
5179 (looking-at auto-fill-inhibit-regexp))))
5180 nil ;; Auto-filling not required
3db1e3b5
BG
5181 (if (memq justify '(full center right))
5182 (save-excursion (unjustify-current-line)))
a0170800
RS
5183
5184 ;; Choose a fill-prefix automatically.
e1e04350
SM
5185 (when (and adaptive-fill-mode
5186 (or (null fill-prefix) (string= fill-prefix "")))
5187 (let ((prefix
5188 (fill-context-prefix
fb5b2591
SM
5189 (save-excursion (fill-forward-paragraph -1) (point))
5190 (save-excursion (fill-forward-paragraph 1) (point)))))
e1e04350
SM
5191 (and prefix (not (equal prefix ""))
5192 ;; Use auto-indentation rather than a guessed empty prefix.
0e53a373 5193 (not (and fill-indent-according-to-mode
d99f8496 5194 (string-match "\\`[ \t]*\\'" prefix)))
e1e04350 5195 (setq fill-prefix prefix))))
f1180544 5196
eed5698b 5197 (while (and (not give-up) (> (current-column) fc))
e47d38f6 5198 ;; Determine where to split the line.
db893d00
RS
5199 (let* (after-prefix
5200 (fill-point
621a3f62
SM
5201 (save-excursion
5202 (beginning-of-line)
5203 (setq after-prefix (point))
5204 (and fill-prefix
5205 (looking-at (regexp-quote fill-prefix))
5206 (setq after-prefix (match-end 0)))
5207 (move-to-column (1+ fc))
5208 (fill-move-to-break-point after-prefix)
5209 (point))))
db893d00
RS
5210
5211 ;; See whether the place we found is any good.
e47d38f6
RS
5212 (if (save-excursion
5213 (goto-char fill-point)
41d22ee0
SM
5214 (or (bolp)
5215 ;; There is no use breaking at end of line.
5216 (save-excursion (skip-chars-forward " ") (eolp))
5217 ;; It is futile to split at the end of the prefix
5218 ;; since we would just insert the prefix again.
5219 (and after-prefix (<= (point) after-prefix))
5220 ;; Don't split right after a comment starter
5221 ;; since we would just make another comment starter.
5222 (and comment-start-skip
5223 (let ((limit (point)))
5224 (beginning-of-line)
5225 (and (re-search-forward comment-start-skip
5226 limit t)
5227 (eq (point) limit))))))
5228 ;; No good place to break => stop trying.
5229 (setq give-up t)
5230 ;; Ok, we have a useful place to break the line. Do it.
5231 (let ((prev-column (current-column)))
5232 ;; If point is at the fill-point, do not `save-excursion'.
5233 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5234 ;; point will end up before it rather than after it.
5235 (if (save-excursion
5236 (skip-chars-backward " \t")
5237 (= (point) fill-point))
0b727f9d 5238 (default-indent-new-line t)
41d22ee0
SM
5239 (save-excursion
5240 (goto-char fill-point)
0b727f9d 5241 (default-indent-new-line t)))
41d22ee0
SM
5242 ;; Now do justification, if required
5243 (if (not (eq justify 'left))
e47d38f6 5244 (save-excursion
e1e04350
SM
5245 (end-of-line 0)
5246 (justify-current-line justify nil t)))
41d22ee0
SM
5247 ;; If making the new line didn't reduce the hpos of
5248 ;; the end of the line, then give up now;
5249 ;; trying again will not help.
5250 (if (>= (current-column) prev-column)
5251 (setq give-up t))))))
24ebf92e 5252 ;; Justify last line.
e2504204 5253 (justify-current-line justify t t)
1e722f9f 5254 t)))
2076c87c 5255
0b727f9d
RS
5256(defvar comment-line-break-function 'comment-indent-new-line
5257 "*Mode-specific function which line breaks and continues a comment.
5258This function is called during auto-filling when a comment syntax
5259is defined.
5260The function should take a single optional argument, which is a flag
5261indicating whether it should use soft newlines.")
5262
5263(defun default-indent-new-line (&optional soft)
5264 "Break line at point and indent.
5265If a comment syntax is defined, call `comment-indent-new-line'.
5266
5267The inserted newline is marked hard if variable `use-hard-newlines' is true,
5268unless optional argument SOFT is non-nil."
5269 (interactive)
5270 (if comment-start
5271 (funcall comment-line-break-function soft)
5272 ;; Insert the newline before removing empty space so that markers
5273 ;; get preserved better.
5274 (if soft (insert-and-inherit ?\n) (newline 1))
5275 (save-excursion (forward-char -1) (delete-horizontal-space))
5276 (delete-horizontal-space)
5277
5278 (if (and fill-prefix (not adaptive-fill-mode))
5279 ;; Blindly trust a non-adaptive fill-prefix.
5280 (progn
5281 (indent-to-left-margin)
5282 (insert-before-markers-and-inherit fill-prefix))
5283
5284 (cond
5285 ;; If there's an adaptive prefix, use it unless we're inside
5286 ;; a comment and the prefix is not a comment starter.
5287 (fill-prefix
5288 (indent-to-left-margin)
5289 (insert-and-inherit fill-prefix))
5290 ;; If we're not inside a comment, just try to indent.
5291 (t (indent-according-to-mode))))))
5292
24ebf92e
RS
5293(defvar normal-auto-fill-function 'do-auto-fill
5294 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5295Some major modes set this.")
5296
c75505b4 5297(put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
74ab01ff
SM
5298;; `functions' and `hooks' are usually unsafe to set, but setting
5299;; auto-fill-function to nil in a file-local setting is safe and
5300;; can be useful to prevent auto-filling.
5301(put 'auto-fill-function 'safe-local-variable 'null)
ca425c7c 5302
80ac5d4d 5303(define-minor-mode auto-fill-mode
24ebf92e 5304 "Toggle Auto Fill mode.
1d2b0303 5305With ARG, turn Auto Fill mode on if and only if ARG is positive.
24ebf92e
RS
5306In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5307automatically breaks the line at a previous space.
5308
ca425c7c
LMI
5309When `auto-fill-mode' is on, the `auto-fill-function' variable is
5310non-`nil'.
5311
24ebf92e
RS
5312The value of `normal-auto-fill-function' specifies the function to use
5313for `auto-fill-function' when turning Auto Fill mode on."
80ac5d4d 5314 :variable (eq auto-fill-function normal-auto-fill-function))
d7465b15
RS
5315
5316;; This holds a document string used to document auto-fill-mode.
5317(defun auto-fill-function ()
5318 "Automatically break line at a previous space, in insertion of text."
5319 nil)
5320
5321(defun turn-on-auto-fill ()
5322 "Unconditionally turn on Auto Fill mode."
5323 (auto-fill-mode 1))
3a99c819
GM
5324
5325(defun turn-off-auto-fill ()
5326 "Unconditionally turn off Auto Fill mode."
5327 (auto-fill-mode -1))
5328
7cbf1dc1 5329(custom-add-option 'text-mode-hook 'turn-on-auto-fill)
d7465b15
RS
5330
5331(defun set-fill-column (arg)
4cc0ea11 5332 "Set `fill-column' to specified argument.
923efb99 5333Use \\[universal-argument] followed by a number to specify a column.
4cc0ea11 5334Just \\[universal-argument] as argument means to use the current column."
7c373357
SM
5335 (interactive
5336 (list (or current-prefix-arg
5337 ;; We used to use current-column silently, but C-x f is too easily
5338 ;; typed as a typo for C-x C-f, so we turned it into an error and
5339 ;; now an interactive prompt.
5340 (read-number "Set fill-column to: " (current-column)))))
f4520363
RS
5341 (if (consp arg)
5342 (setq arg (current-column)))
5343 (if (not (integerp arg))
5344 ;; Disallow missing argument; it's probably a typo for C-x C-f.
f33321ad 5345 (error "set-fill-column requires an explicit argument")
f4520363
RS
5346 (message "Fill column set to %d (was %d)" arg fill-column)
5347 (setq fill-column arg)))
2d88b556 5348\f
2076c87c 5349(defun set-selective-display (arg)
ff1fbe3e
RS
5350 "Set `selective-display' to ARG; clear it if no arg.
5351When the value of `selective-display' is a number > 0,
5352lines whose indentation is >= that value are not displayed.
5353The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
5354 (interactive "P")
5355 (if (eq selective-display t)
5356 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
5357 (let ((current-vpos
5358 (save-restriction
5359 (narrow-to-region (point-min) (point))
5360 (goto-char (window-start))
5361 (vertical-motion (window-height)))))
5362 (setq selective-display
5363 (and arg (prefix-numeric-value arg)))
5364 (recenter current-vpos))
2076c87c
JB
5365 (set-window-start (selected-window) (window-start (selected-window)))
5366 (princ "selective-display set to " t)
5367 (prin1 selective-display t)
5368 (princ "." t))
5369
40a64816 5370(defvaralias 'indicate-unused-lines 'indicate-empty-lines)
40a64816 5371
b3228584 5372(defun toggle-truncate-lines (&optional arg)
1d8c2ccc
LMI
5373 "Toggle truncating of long lines for the current buffer.
5374When truncating is off, long lines are folded.
4837b516 5375With prefix argument ARG, truncate long lines if ARG is positive,
1d8c2ccc
LMI
5376otherwise fold them. Note that in side-by-side windows, this
5377command has no effect if `truncate-partial-width-windows' is
5378non-nil."
0bb64d76
PA
5379 (interactive "P")
5380 (setq truncate-lines
5381 (if (null arg)
5382 (not truncate-lines)
46cdfe8f
RS
5383 (> (prefix-numeric-value arg) 0)))
5384 (force-mode-line-update)
4f017185
RS
5385 (unless truncate-lines
5386 (let ((buffer (current-buffer)))
5387 (walk-windows (lambda (window)
5388 (if (eq buffer (window-buffer window))
5389 (set-window-hscroll window 0)))
5390 nil t)))
46cdfe8f
RS
5391 (message "Truncate long lines %s"
5392 (if truncate-lines "enabled" "disabled")))
0bb64d76 5393
c899b3db
JL
5394(defun toggle-word-wrap (&optional arg)
5395 "Toggle whether to use word-wrapping for continuation lines.
5396With prefix argument ARG, wrap continuation lines at word boundaries
5397if ARG is positive, otherwise wrap them at the right screen edge.
5398This command toggles the value of `word-wrap'. It has no effect
5399if long lines are truncated."
5400 (interactive "P")
5401 (setq word-wrap
5402 (if (null arg)
5403 (not word-wrap)
5404 (> (prefix-numeric-value arg) 0)))
5405 (force-mode-line-update)
5406 (message "Word wrapping %s"
5407 (if word-wrap "enabled" "disabled")))
5408
ca0a881a 5409(defvar overwrite-mode-textual (purecopy " Ovwrt")
b6a22db0 5410 "The string displayed in the mode line when in overwrite mode.")
ca0a881a 5411(defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
b6a22db0
JB
5412 "The string displayed in the mode line when in binary overwrite mode.")
5413
80ac5d4d 5414(define-minor-mode overwrite-mode
2076c87c 5415 "Toggle overwrite mode.
4837b516
GM
5416With prefix argument ARG, turn overwrite mode on if ARG is positive,
5417otherwise turn it off. In overwrite mode, printing characters typed
5418in replace existing text on a one-for-one basis, rather than pushing
5419it to the right. At the end of a line, such characters extend the line.
5420Before a tab, such characters insert until the tab is filled in.
b6a22db0
JB
5421\\[quoted-insert] still inserts characters in overwrite mode; this
5422is supposed to make it easier to insert characters when necessary."
80ac5d4d 5423 :variable (eq overwrite-mode 'overwrite-mode-textual))
b6a22db0 5424
80ac5d4d 5425(define-minor-mode binary-overwrite-mode
b6a22db0 5426 "Toggle binary overwrite mode.
4837b516
GM
5427With prefix argument ARG, turn binary overwrite mode on if ARG is
5428positive, otherwise turn it off. In binary overwrite mode, printing
5429characters typed in replace existing text. Newlines are not treated
5430specially, so typing at the end of a line joins the line to the next,
5431with the typed character between them. Typing before a tab character
5432simply replaces the tab with the character typed. \\[quoted-insert]
5433replaces the text at the cursor, just as ordinary typing characters do.
b6a22db0
JB
5434
5435Note that binary overwrite mode is not its own minor mode; it is a
f33321ad 5436specialization of overwrite mode, entered by setting the
b6a22db0 5437`overwrite-mode' variable to `overwrite-mode-binary'."
80ac5d4d 5438 :variable (eq overwrite-mode 'overwrite-mode-binary))
eaae8106 5439
6710df48 5440(define-minor-mode line-number-mode
a61099dd 5441 "Toggle Line Number mode.
1d2b0303 5442With ARG, turn Line Number mode on if ARG is positive, otherwise
4837b516
GM
5443turn it off. When Line Number mode is enabled, the line number
5444appears in the mode line.
8dc9e2ef 5445
32f2f98e
EZ
5446Line numbers do not appear for very large buffers and buffers
5447with very long lines; see variables `line-number-display-limit'
5448and `line-number-display-limit-width'."
efeb22bf 5449 :init-value t :global t :group 'mode-line)
bcad4985 5450
6710df48 5451(define-minor-mode column-number-mode
bcad4985 5452 "Toggle Column Number mode.
1d2b0303 5453With ARG, turn Column Number mode on if ARG is positive,
4837b516
GM
5454otherwise turn it off. When Column Number mode is enabled, the
5455column number appears in the mode line."
efeb22bf 5456 :global t :group 'mode-line)
6b61353c
KH
5457
5458(define-minor-mode size-indication-mode
5459 "Toggle Size Indication mode.
1d2b0303 5460With ARG, turn Size Indication mode on if ARG is positive,
4837b516
GM
5461otherwise turn it off. When Size Indication mode is enabled, the
5462size of the accessible part of the buffer appears in the mode line."
efeb22bf 5463 :global t :group 'mode-line)
f3ee9200
SM
5464
5465(define-minor-mode auto-save-mode
5466 "Toggle auto-saving of contents of current buffer.
5467With prefix argument ARG, turn auto-saving on if positive, else off."
5468 :variable ((and buffer-auto-save-file-name
5469 ;; If auto-save is off because buffer has shrunk,
5470 ;; then toggling should turn it on.
5471 (>= buffer-saved-size 0))
5472 . (lambda (val)
5473 (setq buffer-auto-save-file-name
5474 (cond
5475 ((null val) nil)
5476 ((and buffer-file-name auto-save-visited-file-name
5477 (not buffer-read-only))
5478 buffer-file-name)
5479 (t (make-auto-save-file-name))))))
5480 ;; If -1 was stored here, to temporarily turn off saving,
5481 ;; turn it back on.
5482 (and (< buffer-saved-size 0)
5483 (setq buffer-saved-size 0)))
2d88b556 5484\f
4b384a8f 5485(defgroup paren-blinking nil
020db25f 5486 "Blinking matching of parens and expressions."
4b384a8f
SM
5487 :prefix "blink-matching-"
5488 :group 'paren-matching)
5489
69c1dd37 5490(defcustom blink-matching-paren t
1d2b0303 5491 "Non-nil means show matching open-paren when close-paren is inserted."
69c1dd37 5492 :type 'boolean
4b384a8f 5493 :group 'paren-blinking)
2076c87c 5494
69c1dd37 5495(defcustom blink-matching-paren-on-screen t
1d2b0303 5496 "Non-nil means show matching open-paren when it is on screen.
1c2ba4e7 5497If nil, don't show it (but the open-paren can still be shown
92aa8a33
LT
5498when it is off screen).
5499
9cb370a9 5500This variable has no effect if `blink-matching-paren' is nil.
a9f72e5f 5501\(In that case, the open-paren is never shown.)
9cb370a9 5502It is also ignored if `show-paren-mode' is enabled."
69c1dd37 5503 :type 'boolean
4b384a8f 5504 :group 'paren-blinking)
29fc44dd 5505
fd413a37 5506(defcustom blink-matching-paren-distance (* 100 1024)
1d2b0303 5507 "If non-nil, maximum distance to search backwards for matching open-paren.
66d44a36 5508If nil, search stops at the beginning of the accessible portion of the buffer."
fd413a37 5509 :version "23.2" ; 25->100k
66d44a36 5510 :type '(choice (const nil) integer)
4b384a8f 5511 :group 'paren-blinking)
2076c87c 5512
69c1dd37 5513(defcustom blink-matching-delay 1
1d2b0303 5514 "Time in seconds to delay after showing a matching paren."
4b384a8f
SM
5515 :type 'number
5516 :group 'paren-blinking)
72dddf8b 5517
69c1dd37 5518(defcustom blink-matching-paren-dont-ignore-comments nil
1d2b0303 5519 "If nil, `blink-matching-paren' ignores comments.
ab6b3b16
RS
5520More precisely, when looking for the matching parenthesis,
5521it skips the contents of comments that end before point."
69c1dd37 5522 :type 'boolean
4b384a8f 5523 :group 'paren-blinking)
903b7f65 5524
b13ebb5c
SM
5525(defun blink-matching-check-mismatch (start end)
5526 "Return whether or not START...END are matching parens.
5527END is the current point and START is the blink position.
5528START might be nil if no matching starter was found.
5529Returns non-nil if we find there is a mismatch."
5530 (let* ((end-syntax (syntax-after (1- end)))
5531 (matching-paren (and (consp end-syntax)
5532 (eq (syntax-class end-syntax) 5)
5533 (cdr end-syntax))))
5534 ;; For self-matched chars like " and $, we can't know when they're
5535 ;; mismatched or unmatched, so we can only do it for parens.
5536 (when matching-paren
5537 (not (and start
5538 (or
5539 (eq (char-after start) matching-paren)
5540 ;; The cdr might hold a new paren-class info rather than
5541 ;; a matching-char info, in which case the two CDRs
5542 ;; should match.
5543 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5544
5545(defvar blink-matching-check-function #'blink-matching-check-mismatch
5546 "Function to check parentheses mismatches.
5547The function takes two arguments (START and END) where START is the
5548position just before the opening token and END is the position right after.
5549START can be nil, if it was not found.
5550The function should return non-nil if the two tokens do not match.")
5551
2076c87c
JB
5552(defun blink-matching-open ()
5553 "Move cursor momentarily to the beginning of the sexp before point."
5554 (interactive)
b13ebb5c
SM
5555 (when (and (not (bobp))
5556 blink-matching-paren)
1d0e3fc8 5557 (let* ((oldpos (point))
b13ebb5c 5558 (message-log-max nil) ; Don't log messages about paren matching.
3137dda8
SM
5559 (blinkpos
5560 (save-excursion
5561 (save-restriction
5fc4038e
CY
5562 (if blink-matching-paren-distance
5563 (narrow-to-region
5564 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5565 (- (point) blink-matching-paren-distance))
5566 oldpos))
3137dda8
SM
5567 (let ((parse-sexp-ignore-comments
5568 (and parse-sexp-ignore-comments
5569 (not blink-matching-paren-dont-ignore-comments))))
5570 (condition-case ()
4b9c0a49
SM
5571 (progn
5572 (forward-sexp -1)
b13ebb5c
SM
5573 ;; backward-sexp skips backward over prefix chars,
5574 ;; so move back to the matching paren.
5575 (while (and (< (point) (1- oldpos))
984edd22
SM
5576 (let ((code (syntax-after (point))))
5577 (or (eq (syntax-class code) 6)
5578 (eq (logand 1048576 (car code))
5579 1048576))))
b13ebb5c 5580 (forward-char 1))
4b9c0a49 5581 (point))
3137dda8 5582 (error nil))))))
b13ebb5c 5583 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
3137dda8 5584 (cond
b13ebb5c
SM
5585 (mismatch
5586 (if blinkpos
28e271f0 5587 (if (minibufferp)
5fc4038e
CY
5588 (minibuffer-message "Mismatched parentheses")
5589 (message "Mismatched parentheses"))
b13ebb5c 5590 (if (minibufferp)
5fc4038e
CY
5591 (minibuffer-message "No matching parenthesis found")
5592 (message "No matching parenthesis found"))))
c34a9669 5593 ((not blinkpos) nil)
3137dda8
SM
5594 ((pos-visible-in-window-p blinkpos)
5595 ;; Matching open within window, temporarily move to blinkpos but only
5596 ;; if `blink-matching-paren-on-screen' is non-nil.
5597 (and blink-matching-paren-on-screen
5598 (not show-paren-mode)
5599 (save-excursion
5600 (goto-char blinkpos)
5601 (sit-for blink-matching-delay))))
5602 (t
5603 (save-excursion
5604 (goto-char blinkpos)
5605 (let ((open-paren-line-string
5606 ;; Show what precedes the open in its line, if anything.
5607 (cond
5608 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
5609 (buffer-substring (line-beginning-position)
5610 (1+ blinkpos)))
5611 ;; Show what follows the open in its line, if anything.
5612 ((save-excursion
5613 (forward-char 1)
5614 (skip-chars-forward " \t")
5615 (not (eolp)))
5616 (buffer-substring blinkpos
5617 (line-end-position)))
5618 ;; Otherwise show the previous nonblank line,
5619 ;; if there is one.
5620 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
5621 (concat
5622 (buffer-substring (progn
5623 (skip-chars-backward "\n \t")
5624 (line-beginning-position))
5625 (progn (end-of-line)
5626 (skip-chars-backward " \t")
5627 (point)))
5628 ;; Replace the newline and other whitespace with `...'.
5629 "..."
5630 (buffer-substring blinkpos (1+ blinkpos))))
5631 ;; There is nothing to show except the char itself.
5632 (t (buffer-substring blinkpos (1+ blinkpos))))))
5633 (message "Matches %s"
5634 (substring-no-properties open-paren-line-string)))))))))
5635
8f4e9110
SM
5636(defvar blink-paren-function 'blink-matching-open
5637 "Function called, if non-nil, whenever a close parenthesis is inserted.
5638More precisely, a char with closeparen syntax is self-inserted.")
5639
5640(defun blink-paren-post-self-insert-function ()
5641 (when (and (eq (char-before) last-command-event) ; Sanity check.
5642 (memq (char-syntax last-command-event) '(?\) ?\$))
5643 blink-paren-function
5644 (not executing-kbd-macro)
b13ebb5c
SM
5645 (not noninteractive)
5646 ;; Verify an even number of quoting characters precede the close.
5647 (= 1 (logand 1 (- (point)
5648 (save-excursion
5649 (forward-char -1)
5650 (skip-syntax-backward "/\\")
5651 (point))))))
8f4e9110
SM
5652 (funcall blink-paren-function)))
5653
5654(add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5655 ;; Most likely, this hook is nil, so this arg doesn't matter,
5656 ;; but I use it as a reminder that this function usually
5657 ;; likes to be run after others since it does `sit-for'.
5658 'append)
2d88b556 5659\f
9a1277dd
RS
5660;; This executes C-g typed while Emacs is waiting for a command.
5661;; Quitting out of a program does not go through here;
5662;; that happens in the QUIT macro at the C code level.
2076c87c 5663(defun keyboard-quit ()
d5dae4e1 5664 "Signal a `quit' condition.
af39530e
RS
5665During execution of Lisp code, this character causes a quit directly.
5666At top-level, as an editor command, this simply beeps."
2076c87c 5667 (interactive)
9852377f
CY
5668 ;; Avoid adding the region to the window selection.
5669 (setq saved-region-selection nil)
5670 (let (select-active-regions)
5671 (deactivate-mark))
8a7644e9
KS
5672 (if (fboundp 'kmacro-keyboard-quit)
5673 (kmacro-keyboard-quit))
f5e13057 5674 (setq defining-kbd-macro nil)
fb5b2591
SM
5675 (let ((debug-on-quit nil))
5676 (signal 'quit nil)))
2076c87c 5677
1c6c6fde
RS
5678(defvar buffer-quit-function nil
5679 "Function to call to \"quit\" the current buffer, or nil if none.
5680\\[keyboard-escape-quit] calls this function when its more local actions
5681\(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5682
c66587fe
RS
5683(defun keyboard-escape-quit ()
5684 "Exit the current \"mode\" (in a generalized sense of the word).
5685This command can exit an interactive command such as `query-replace',
5686can clear out a prefix argument or a region,
5687can get out of the minibuffer or other recursive edit,
1c6c6fde
RS
5688cancel the use of the current buffer (for special-purpose buffers),
5689or go back to just one window (by deleting all but the selected window)."
c66587fe
RS
5690 (interactive)
5691 (cond ((eq last-command 'mode-exited) nil)
67189e62
JL
5692 ((region-active-p)
5693 (deactivate-mark))
c66587fe
RS
5694 ((> (minibuffer-depth) 0)
5695 (abort-recursive-edit))
5696 (current-prefix-arg
5697 nil)
1b657835
RS
5698 ((> (recursion-depth) 0)
5699 (exit-recursive-edit))
1c6c6fde
RS
5700 (buffer-quit-function
5701 (funcall buffer-quit-function))
c66587fe 5702 ((not (one-window-p t))
1b657835
RS
5703 (delete-other-windows))
5704 ((string-match "^ \\*" (buffer-name (current-buffer)))
5705 (bury-buffer))))
c66587fe 5706
2d88b556
RS
5707(defun play-sound-file (file &optional volume device)
5708 "Play sound stored in FILE.
5709VOLUME and DEVICE correspond to the keywords of the sound
5710specification for `play-sound'."
5711 (interactive "fPlay sound file: ")
5712 (let ((sound (list :file file)))
5713 (if volume
5714 (plist-put sound :volume volume))
5715 (if device
5716 (plist-put sound :device device))
5717 (push 'sound sound)
5718 (play-sound sound)))
5719
56abefac 5720\f
7683b5c2 5721(defcustom read-mail-command 'rmail
1d2b0303 5722 "Your preference for a mail reading package.
9023837e
DL
5723This is used by some keybindings which support reading mail.
5724See also `mail-user-agent' concerning sending mail."
f6714ede
GM
5725 :type '(radio (function-item :tag "Rmail" :format "%t\n" rmail)
5726 (function-item :tag "Gnus" :format "%t\n" gnus)
5727 (function-item :tag "Emacs interface to MH"
5728 :format "%t\n" mh-rmail)
5729 (function :tag "Other"))
7683b5c2
DL
5730 :version "21.1"
5731 :group 'mail)
5732
cbd61418 5733(defcustom mail-user-agent 'message-user-agent
1d2b0303 5734 "Your preference for a mail composition package.
9023837e 5735Various Emacs Lisp packages (e.g. Reporter) require you to compose an
a31ca314
RS
5736outgoing email message. This variable lets you specify which
5737mail-sending package you prefer.
5738
5739Valid values include:
5740
cfc47664
GM
5741 `message-user-agent' -- use the Message package.
5742 See Info node `(message)'.
5743 `sendmail-user-agent' -- use the Mail package.
9023837e
DL
5744 See Info node `(emacs)Sending Mail'.
5745 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5746 See Info node `(mh-e)'.
9023837e
DL
5747 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5748 paraphernalia, particularly the Gcc: header for
5749 archiving.
a31ca314
RS
5750
5751Additional valid symbols may be available; check with the author of
15d0c9b1
DL
5752your package for details. The function should return non-nil if it
5753succeeds.
9023837e
DL
5754
5755See also `read-mail-command' concerning reading mail."
cfc47664
GM
5756 :type '(radio (function-item :tag "Message package"
5757 :format "%t\n"
5758 message-user-agent)
5759 (function-item :tag "Mail package"
69c1dd37
RS
5760 :format "%t\n"
5761 sendmail-user-agent)
5762 (function-item :tag "Emacs interface to MH"
5763 :format "%t\n"
5764 mh-e-user-agent)
cfc47664 5765 (function-item :tag "Message with full Gnus features"
9023837e
DL
5766 :format "%t\n"
5767 gnus-user-agent)
69c1dd37 5768 (function :tag "Other"))
cfc47664 5769 :version "23.2" ; sendmail->message
69c1dd37 5770 :group 'mail)
a31ca314 5771
3d68fa99
CY
5772(defcustom compose-mail-user-agent-warnings t
5773 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5774If the value of `mail-user-agent' is the default, and the user
5775appears to have customizations applying to the old default,
5776`compose-mail' issues a warning."
5777 :type 'boolean
5778 :version "23.2"
5779 :group 'mail)
5780
360b5483 5781(defun rfc822-goto-eoh ()
41002397
GM
5782 "If the buffer starts with a mail header, move point to the header's end.
5783Otherwise, moves to `point-min'.
5784The end of the header is the start of the next line, if there is one,
5785else the end of the last line. This function obeys RFC822."
360b5483 5786 (goto-char (point-min))
e1e04350
SM
5787 (when (re-search-forward
5788 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
5789 (goto-char (match-beginning 0))))
360b5483 5790
fd59d131
EZ
5791;; Used by Rmail (e.g., rmail-forward).
5792(defvar mail-encode-mml nil
5793 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5794the outgoing message before sending it.")
5795
d0008a00 5796(defun compose-mail (&optional to subject other-headers continue
25ca2e61
CY
5797 switch-function yank-action send-actions
5798 return-action)
d0008a00
RS
5799 "Start composing a mail message to send.
5800This uses the user's chosen mail composition package
5801as selected with the variable `mail-user-agent'.
5802The optional arguments TO and SUBJECT specify recipients
5803and the initial Subject field, respectively.
5804
5805OTHER-HEADERS is an alist specifying additional
5806header fields. Elements look like (HEADER . VALUE) where both
5807HEADER and VALUE are strings.
5808
5809CONTINUE, if non-nil, says to continue editing a message already
9dda5b0e 5810being composed. Interactively, CONTINUE is the prefix argument.
d0008a00
RS
5811
5812SWITCH-FUNCTION, if non-nil, is a function to use to
5813switch to and display the buffer used for mail composition.
5814
5815YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
06720de2
RS
5816to insert the raw text of the message being replied to.
5817It has the form (FUNCTION . ARGS). The user agent will apply
5818FUNCTION to ARGS, to insert the raw text of the original message.
5819\(The user agent will also run `mail-citation-hook', *after* the
5820original text has been inserted in this way.)
d0008a00
RS
5821
5822SEND-ACTIONS is a list of actions to call when the message is sent.
25ca2e61
CY
5823Each action has the form (FUNCTION . ARGS).
5824
5825RETURN-ACTION, if non-nil, is an action for returning to the
5826caller. It has the form (FUNCTION . ARGS). The function is
5827called after the mail has been sent or put aside, and the mail
5828buffer buried."
b5f019be
RS
5829 (interactive
5830 (list nil nil nil current-prefix-arg))
3d68fa99
CY
5831
5832 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5833 ;; from sendmail-user-agent to message-user-agent. Some users may
5834 ;; encounter incompatibilities. This hack tries to detect problems
5835 ;; and warn about them.
5836 (and compose-mail-user-agent-warnings
5837 (eq mail-user-agent 'message-user-agent)
5838 (let (warn-vars)
5839 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5840 mail-yank-hooks mail-archive-file-name
5841 mail-default-reply-to mail-mailing-lists
5e1d4968 5842 mail-self-blind))
3d68fa99
CY
5843 (and (boundp var)
5844 (symbol-value var)
5845 (push var warn-vars)))
5846 (when warn-vars
5847 (display-warning 'mail
5848 (format "\
5849The default mail mode is now Message mode.
5850You have the following Mail mode variable%s customized:
5851\n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
7f0b7b3e 5852To disable this warning, set `compose-mail-user-agent-warnings' to nil."
3d68fa99
CY
5853 (if (> (length warn-vars) 1) "s" "")
5854 (mapconcat 'symbol-name
5855 warn-vars " "))))))
5856
676b1a74 5857 (let ((function (get mail-user-agent 'composefunc)))
25ca2e61
CY
5858 (funcall function to subject other-headers continue switch-function
5859 yank-action send-actions return-action)))
b5f019be
RS
5860
5861(defun compose-mail-other-window (&optional to subject other-headers continue
25ca2e61
CY
5862 yank-action send-actions
5863 return-action)
b5f019be 5864 "Like \\[compose-mail], but edit the outgoing message in another window."
25ca2e61 5865 (interactive (list nil nil nil current-prefix-arg))
b5f019be 5866 (compose-mail to subject other-headers continue
25ca2e61
CY
5867 'switch-to-buffer-other-window yank-action send-actions
5868 return-action))
b5f019be
RS
5869
5870(defun compose-mail-other-frame (&optional to subject other-headers continue
25ca2e61
CY
5871 yank-action send-actions
5872 return-action)
b5f019be 5873 "Like \\[compose-mail], but edit the outgoing message in another frame."
25ca2e61 5874 (interactive (list nil nil nil current-prefix-arg))
b5f019be 5875 (compose-mail to subject other-headers continue
25ca2e61
CY
5876 'switch-to-buffer-other-frame yank-action send-actions
5877 return-action))
5878
56abefac 5879\f
610c1c68 5880(defvar set-variable-value-history nil
987ec16d
EZ
5881 "History of values entered with `set-variable'.
5882
5883Maximum length of the history list is determined by the value
5884of `history-length', which see.")
610c1c68 5885
d6281b4e 5886(defun set-variable (variable value &optional make-local)
610c1c68 5887 "Set VARIABLE to VALUE. VALUE is a Lisp object.
d6281b4e
RS
5888VARIABLE should be a user option variable name, a Lisp variable
5889meant to be customized by users. You should enter VALUE in Lisp syntax,
5890so if you want VALUE to be a string, you must surround it with doublequotes.
610c1c68
RS
5891VALUE is used literally, not evaluated.
5892
5893If VARIABLE has a `variable-interactive' property, that is used as if
5894it were the arg to `interactive' (which see) to interactively read VALUE.
5895
5896If VARIABLE has been defined with `defcustom', then the type information
16236388
RS
5897in the definition is used to check that VALUE is valid.
5898
5899With a prefix argument, set VARIABLE to VALUE buffer-locally."
e9dfb72e
RS
5900 (interactive
5901 (let* ((default-var (variable-at-point))
7fd0ef0d
JL
5902 (var (if (user-variable-p default-var)
5903 (read-variable (format "Set variable (default %s): " default-var)
5904 default-var)
5905 (read-variable "Set variable: ")))
6b61353c
KH
5906 (minibuffer-help-form '(describe-variable var))
5907 (prop (get var 'variable-interactive))
0684376b
JB
5908 (obsolete (car (get var 'byte-obsolete-variable)))
5909 (prompt (format "Set %s %s to value: " var
6b61353c 5910 (cond ((local-variable-p var)
0684376b 5911 "(buffer-local)")
6b61353c
KH
5912 ((or current-prefix-arg
5913 (local-variable-if-set-p var))
0684376b
JB
5914 "buffer-locally")
5915 (t "globally"))))
5916 (val (progn
5917 (when obsolete
5918 (message (concat "`%S' is obsolete; "
5919 (if (symbolp obsolete) "use `%S' instead" "%s"))
5920 var obsolete)
5921 (sit-for 3))
5922 (if prop
5923 ;; Use VAR's `variable-interactive' property
5924 ;; as an interactive spec for prompting.
5925 (call-interactively `(lambda (arg)
5926 (interactive ,prop)
5927 arg))
5928 (read
5929 (read-string prompt nil
7fd0ef0d
JL
5930 'set-variable-value-history
5931 (format "%S" (symbol-value var))))))))
6b61353c 5932 (list var val current-prefix-arg)))
610c1c68 5933
d6281b4e
RS
5934 (and (custom-variable-p variable)
5935 (not (get variable 'custom-type))
5936 (custom-load-symbol variable))
5937 (let ((type (get variable 'custom-type)))
610c1c68
RS
5938 (when type
5939 ;; Match with custom type.
36755dd9 5940 (require 'cus-edit)
610c1c68 5941 (setq type (widget-convert type))
d6281b4e 5942 (unless (widget-apply type :match value)
1e722f9f 5943 (error "Value `%S' does not match type %S of %S"
d6281b4e 5944 value (car type) variable))))
16236388
RS
5945
5946 (if make-local
d6281b4e 5947 (make-local-variable variable))
f1180544 5948
d6281b4e 5949 (set variable value)
a2aef080
GM
5950
5951 ;; Force a thorough redisplay for the case that the variable
5952 ;; has an effect on the display, like `tab-width' has.
5953 (force-mode-line-update))
56abefac 5954\f
e8a700bf
RS
5955;; Define the major mode for lists of completions.
5956
e2947429
SM
5957(defvar completion-list-mode-map
5958 (let ((map (make-sparse-keymap)))
5959 (define-key map [mouse-2] 'mouse-choose-completion)
5960 (define-key map [follow-link] 'mouse-face)
5961 (define-key map [down-mouse-2] nil)
5962 (define-key map "\C-m" 'choose-completion)
5963 (define-key map "\e\e\e" 'delete-completion-window)
5964 (define-key map [left] 'previous-completion)
5965 (define-key map [right] 'next-completion)
45f8cb0c 5966 (define-key map "q" 'quit-window)
abef340a 5967 (define-key map "z" 'kill-this-buffer)
e2947429 5968 map)
98b45886 5969 "Local map for completion list buffers.")
e8a700bf
RS
5970
5971;; Completion mode is suitable only for specially formatted data.
ac29eb79 5972(put 'completion-list-mode 'mode-class 'special)
e8a700bf 5973
98b45886
RS
5974(defvar completion-reference-buffer nil
5975 "Record the buffer that was current when the completion list was requested.
5976This is a local variable in the completion list buffer.
ec39964e 5977Initial value is nil to avoid some compiler warnings.")
3819736b 5978
83434bda
RS
5979(defvar completion-no-auto-exit nil
5980 "Non-nil means `choose-completion-string' should never exit the minibuffer.
f6714ede 5981This also applies to other functions such as `choose-completion'.")
83434bda 5982
d5e63715
SM
5983(defvar completion-base-position nil
5984 "Position of the base of the text corresponding to the shown completions.
5985This variable is used in the *Completions* buffers.
5986Its value is a list of the form (START END) where START is the place
5987where the completion should be inserted and END (if non-nil) is the end
5988of the text to replace. If END is nil, point is used instead.")
5989
a2a25d24
SM
5990(defvar completion-list-insert-choice-function #'completion--replace
5991 "Function to use to insert the text chosen in *Completions*.
5992Called with 3 arguments (BEG END TEXT), it should replace the text
5993between BEG and END with TEXT. Expected to be set buffer-locally
5994in the *Completions* buffer.")
5995
98b45886 5996(defvar completion-base-size nil
3c59150d
CY
5997 "Number of chars before point not involved in completion.
5998This is a local variable in the completion list buffer.
5999It refers to the chars in the minibuffer if completing in the
6000minibuffer, or in `completion-reference-buffer' otherwise.
6001Only characters in the field at point are included.
6002
6003If nil, Emacs determines which part of the tail end of the
6004buffer's text is involved in completion by comparing the text
6005directly.")
d5e63715 6006(make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
f6b293e3 6007
1c6c6fde
RS
6008(defun delete-completion-window ()
6009 "Delete the completion list window.
6010Go to the window from which completion was requested."
6011 (interactive)
6012 (let ((buf completion-reference-buffer))
ddb2b181
RS
6013 (if (one-window-p t)
6014 (if (window-dedicated-p (selected-window))
6015 (delete-frame (selected-frame)))
6016 (delete-window (selected-window))
6017 (if (get-buffer-window buf)
6018 (select-window (get-buffer-window buf))))))
1c6c6fde 6019
dde69dbe
RS
6020(defun previous-completion (n)
6021 "Move to the previous item in the completion list."
6022 (interactive "p")
6023 (next-completion (- n)))
6024
6025(defun next-completion (n)
6026 "Move to the next item in the completion list.
1f238ac2 6027With prefix argument N, move N items (negative N means move backward)."
dde69dbe 6028 (interactive "p")
58dd38f1
SM
6029 (let ((beg (point-min)) (end (point-max)))
6030 (while (and (> n 0) (not (eobp)))
dde69dbe 6031 ;; If in a completion, move to the end of it.
58dd38f1
SM
6032 (when (get-text-property (point) 'mouse-face)
6033 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe 6034 ;; Move to start of next one.
58dd38f1
SM
6035 (unless (get-text-property (point) 'mouse-face)
6036 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6037 (setq n (1- n)))
6038 (while (and (< n 0) (not (bobp)))
6039 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6040 ;; If in a completion, move to the start of it.
6041 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
b61a81c2 6042 (goto-char (previous-single-property-change
58dd38f1
SM
6043 (point) 'mouse-face nil beg)))
6044 ;; Move to end of the previous completion.
6045 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6046 (goto-char (previous-single-property-change
6047 (point) 'mouse-face nil beg)))
6048 ;; Move to the start of that one.
6049 (goto-char (previous-single-property-change
6050 (point) 'mouse-face nil beg))
6051 (setq n (1+ n))))))
dde69dbe 6052
d5e63715
SM
6053(defun choose-completion (&optional event)
6054 "Choose the completion at point."
6055 (interactive (list last-nonmenu-event))
6056 ;; In case this is run via the mouse, give temporary modes such as
6057 ;; isearch a chance to turn off.
6058 (run-hooks 'mouse-leave-buffer-hook)
a2a25d24
SM
6059 (with-current-buffer (window-buffer (posn-window (event-start event)))
6060 (let ((buffer completion-reference-buffer)
6061 (base-size completion-base-size)
6062 (base-position completion-base-position)
6063 (insert-function completion-list-insert-choice-function)
6064 (choice
6065 (save-excursion
6066 (goto-char (posn-point (event-start event)))
6067 (let (beg end)
6068 (cond
6069 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6070 (setq end (point) beg (1+ (point))))
6071 ((and (not (bobp))
6072 (get-text-property (1- (point)) 'mouse-face))
6073 (setq end (1- (point)) beg (point)))
6074 (t (error "No completion here")))
6075 (setq beg (previous-single-property-change beg 'mouse-face))
6076 (setq end (or (next-single-property-change end 'mouse-face)
6077 (point-max)))
6078 (buffer-substring-no-properties beg end))))
6079 (owindow (selected-window)))
6080
6081 (unless (buffer-live-p buffer)
6082 (error "Destination buffer is dead"))
d5e63715 6083 (select-window (posn-window (event-start event)))
ab63960f 6084 (if (and (one-window-p t 'selected-frame)
d5e63715 6085 (window-dedicated-p (selected-window)))
ab63960f
RS
6086 ;; This is a special buffer's frame
6087 (iconify-frame (selected-frame))
6088 (or (window-dedicated-p (selected-window))
6089 (bury-buffer)))
8a7daef5 6090 (select-window
a2a25d24
SM
6091 (or (get-buffer-window buffer 0)
6092 owindow))
6093
6094 (with-current-buffer buffer
6095 (choose-completion-string
6096 choice buffer
6097 (or base-position
6098 (when base-size
6099 ;; Someone's using old completion code that doesn't know
6100 ;; about base-position yet.
6101 (list (+ base-size (field-beginning))))
6102 ;; If all else fails, just guess.
6103 (list (choose-completion-guess-base-position choice)))
6104 insert-function)))))
80298193
RS
6105
6106;; Delete the longest partial match for STRING
6107;; that can be found before POINT.
d5e63715
SM
6108(defun choose-completion-guess-base-position (string)
6109 (save-excursion
6110 (let ((opoint (point))
6111 len)
6112 ;; Try moving back by the length of the string.
6113 (goto-char (max (- (point) (length string))
6114 (minibuffer-prompt-end)))
6115 ;; See how far back we were actually able to move. That is the
6116 ;; upper bound on how much we can match and delete.
6117 (setq len (- opoint (point)))
6118 (if completion-ignore-case
6119 (setq string (downcase string)))
6120 (while (and (> len 0)
6121 (let ((tail (buffer-substring (point) opoint)))
6122 (if completion-ignore-case
6123 (setq tail (downcase tail)))
6124 (not (string= tail (substring string 0 len)))))
6125 (setq len (1- len))
6126 (forward-char 1))
6127 (point))))
6128
80298193 6129(defun choose-completion-delete-max-match (string)
d5e63715
SM
6130 (delete-region (choose-completion-guess-base-position string) (point)))
6131(make-obsolete 'choose-completion-delete-max-match
6132 'choose-completion-guess-base-position "23.2")
80298193 6133
ba36181b 6134(defvar choose-completion-string-functions nil
bbbbb15b
KS
6135 "Functions that may override the normal insertion of a completion choice.
6136These functions are called in order with four arguments:
6137CHOICE - the string to insert in the buffer,
6138BUFFER - the buffer in which the choice should be inserted,
4837b516 6139MINI-P - non-nil if BUFFER is a minibuffer, and
12829a07
RS
6140BASE-SIZE - the number of characters in BUFFER before
6141the string being completed.
6142
bbbbb15b
KS
6143If a function in the list returns non-nil, that function is supposed
6144to have inserted the CHOICE in the BUFFER, and possibly exited
12829a07 6145the minibuffer; no further functions will be called.
ba36181b 6146
12829a07
RS
6147If all functions in the list return nil, that means to use
6148the default method of inserting the completion in BUFFER.")
74d0290b 6149
a2a25d24
SM
6150(defun choose-completion-string (choice &optional
6151 buffer base-position insert-function)
12829a07 6152 "Switch to BUFFER and insert the completion choice CHOICE.
d5e63715 6153BASE-POSITION, says where to insert the completion."
12829a07
RS
6154
6155 ;; If BUFFER is the minibuffer, exit the minibuffer
6156 ;; unless it is reading a file name and CHOICE is a directory,
6157 ;; or completion-no-auto-exit is non-nil.
6158
d5e63715
SM
6159 ;; Some older code may call us passing `base-size' instead of
6160 ;; `base-position'. It's difficult to make any use of `base-size',
6161 ;; so we just ignore it.
6162 (unless (consp base-position)
6163 (message "Obsolete `base-size' passed to choose-completion-string")
6164 (setq base-position nil))
6165
1a0d0b6a
JPW
6166 (let* ((buffer (or buffer completion-reference-buffer))
6167 (mini-p (minibufferp buffer)))
cf52ad58
RS
6168 ;; If BUFFER is a minibuffer, barf unless it's the currently
6169 ;; active minibuffer.
f436a90a 6170 (if (and mini-p
a2a25d24
SM
6171 (not (and (active-minibuffer-window)
6172 (equal buffer
45486731 6173 (window-buffer (active-minibuffer-window))))))
cf52ad58 6174 (error "Minibuffer is not active for completion")
17aa3385
KS
6175 ;; Set buffer so buffer-local choose-completion-string-functions works.
6176 (set-buffer buffer)
f1180544 6177 (unless (run-hook-with-args-until-success
d99f8496 6178 'choose-completion-string-functions
d5e63715
SM
6179 ;; The fourth arg used to be `mini-p' but was useless
6180 ;; (since minibufferp can be used on the `buffer' arg)
6181 ;; and indeed unused. The last used to be `base-size', so we
6182 ;; keep it to try and avoid breaking old code.
6183 choice buffer base-position nil)
a2a25d24
SM
6184 ;; This remove-text-properties should be unnecessary since `choice'
6185 ;; comes from buffer-substring-no-properties.
6186 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
d99f8496 6187 ;; Insert the completion into the buffer where it was requested.
a2a25d24
SM
6188 (funcall (or insert-function completion-list-insert-choice-function)
6189 (or (car base-position) (point))
6190 (or (cadr base-position) (point))
6191 choice)
6192 ;; Update point in the window that BUFFER is showing in.
bbbbb15b
KS
6193 (let ((window (get-buffer-window buffer t)))
6194 (set-window-point window (point)))
6195 ;; If completing for the minibuffer, exit it with this choice.
6196 (and (not completion-no-auto-exit)
6138158d 6197 (minibufferp buffer)
bbbbb15b
KS
6198 minibuffer-completion-table
6199 ;; If this is reading a file name, and the file name chosen
6200 ;; is a directory, don't exit the minibuffer.
85be9ec4
SM
6201 (let* ((result (buffer-substring (field-beginning) (point)))
6202 (bounds
6203 (completion-boundaries result minibuffer-completion-table
6204 minibuffer-completion-predicate
6205 "")))
6206 (if (eq (car bounds) (length result))
6207 ;; The completion chosen leads to a new set of completions
6208 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6209 (let ((mini (active-minibuffer-window)))
6210 (select-window mini)
6211 (when minibuffer-auto-raise
6212 (raise-frame (window-frame mini))))
6213 (exit-minibuffer))))))))
80298193 6214
e2947429 6215(define-derived-mode completion-list-mode nil "Completion List"
e8a700bf 6216 "Major mode for buffers showing lists of possible completions.
80298193
RS
6217Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
6218 to select the completion near point.
6219Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3a77346c
GM
6220 with the mouse.
6221
6222\\{completion-list-mode-map}"
e2947429 6223 (set (make-local-variable 'completion-base-size) nil))
e8a700bf 6224
c8d6d636
GM
6225(defun completion-list-mode-finish ()
6226 "Finish setup of the completions buffer.
6227Called from `temp-buffer-show-hook'."
6228 (when (eq major-mode 'completion-list-mode)
6229 (toggle-read-only 1)))
6230
6231(add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6232
f5fab556
MY
6233
6234;; Variables and faces used in `completion-setup-function'.
747a0e2f 6235
d0fd0916
JPW
6236(defcustom completion-show-help t
6237 "Non-nil means show help message in *Completions* buffer."
6238 :type 'boolean
6239 :version "22.1"
6240 :group 'completion)
6241
f5fab556
MY
6242;; This function goes in completion-setup-hook, so that it is called
6243;; after the text of the completion list buffer is written.
e8a700bf 6244(defun completion-setup-function ()
1b5fd09e 6245 (let* ((mainbuf (current-buffer))
a9e3ff69
SM
6246 (base-dir
6247 ;; When reading a file name in the minibuffer,
6248 ;; try and find the right default-directory to set in the
6249 ;; completion list buffer.
6250 ;; FIXME: Why do we do that, actually? --Stef
6251 (if minibuffer-completing-file-name
6252 (file-name-as-directory
6253 (expand-file-name
6254 (substring (minibuffer-completion-contents)
6255 0 (or completion-base-size 0)))))))
621a3f62 6256 (with-current-buffer standard-output
d5e63715 6257 (let ((base-size completion-base-size) ;Read before killing localvars.
a2a25d24
SM
6258 (base-position completion-base-position)
6259 (insert-fun completion-list-insert-choice-function))
e2947429 6260 (completion-list-mode)
d5e63715 6261 (set (make-local-variable 'completion-base-size) base-size)
a2a25d24
SM
6262 (set (make-local-variable 'completion-base-position) base-position)
6263 (set (make-local-variable 'completion-list-insert-choice-function)
6264 insert-fun))
1b5fd09e 6265 (set (make-local-variable 'completion-reference-buffer) mainbuf)
a9e3ff69 6266 (if base-dir (setq default-directory base-dir))
d0fd0916
JPW
6267 ;; Maybe insert help string.
6268 (when completion-show-help
6269 (goto-char (point-min))
6270 (if (display-mouse-p)
6271 (insert (substitute-command-keys
6272 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
6273 (insert (substitute-command-keys
6274 "In this buffer, type \\[choose-completion] to \
6275select the completion near point.\n\n"))))))
c88ab9ce 6276
e8a700bf 6277(add-hook 'completion-setup-hook 'completion-setup-function)
dde69dbe 6278
1b5fd09e
SM
6279(define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6280(define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
dde69dbe
RS
6281
6282(defun switch-to-completions ()
6283 "Select the completion list window."
6284 (interactive)
ab14d7d5 6285 (let ((window (or (get-buffer-window "*Completions*" 0)
042b7cc6 6286 ;; Make sure we have a completions window.
ab14d7d5
SM
6287 (progn (minibuffer-completion-help)
6288 (get-buffer-window "*Completions*" 0)))))
fdbd7c4d
KH
6289 (when window
6290 (select-window window)
042b7cc6
JL
6291 ;; In the new buffer, go to the first completion.
6292 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6293 (when (bobp)
6294 (next-completion 1)))))
f6039de6
JL
6295\f
6296;;; Support keyboard commands to turn on various modifiers.
82072f33
RS
6297
6298;; These functions -- which are not commands -- each add one modifier
6299;; to the following event.
6300
06b60517 6301(defun event-apply-alt-modifier (_ignore-prompt)
1e96c007 6302 "\\<function-key-map>Add the Alt modifier to the following event.
70cf9f08 6303For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
82072f33 6304 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
06b60517 6305(defun event-apply-super-modifier (_ignore-prompt)
1e96c007 6306 "\\<function-key-map>Add the Super modifier to the following event.
70cf9f08 6307For example, type \\[event-apply-super-modifier] & to enter Super-&."
82072f33 6308 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
06b60517 6309(defun event-apply-hyper-modifier (_ignore-prompt)
1e96c007 6310 "\\<function-key-map>Add the Hyper modifier to the following event.
70cf9f08 6311For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
82072f33 6312 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
06b60517 6313(defun event-apply-shift-modifier (_ignore-prompt)
1e96c007 6314 "\\<function-key-map>Add the Shift modifier to the following event.
70cf9f08 6315For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
82072f33 6316 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
06b60517 6317(defun event-apply-control-modifier (_ignore-prompt)
1e96c007 6318 "\\<function-key-map>Add the Ctrl modifier to the following event.
70cf9f08 6319For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
82072f33 6320 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
06b60517 6321(defun event-apply-meta-modifier (_ignore-prompt)
1e96c007 6322 "\\<function-key-map>Add the Meta modifier to the following event.
70cf9f08 6323For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
82072f33
RS
6324 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6325
6326(defun event-apply-modifier (event symbol lshiftby prefix)
6327 "Apply a modifier flag to event EVENT.
6328SYMBOL is the name of this modifier, as a symbol.
6329LSHIFTBY is the numeric value of this modifier, in keyboard events.
6330PREFIX is the string that represents this modifier in an event type symbol."
6331 (if (numberp event)
6332 (cond ((eq symbol 'control)
90bebcb0
KH
6333 (if (and (<= (downcase event) ?z)
6334 (>= (downcase event) ?a))
82072f33 6335 (- (downcase event) ?a -1)
90bebcb0
KH
6336 (if (and (<= (downcase event) ?Z)
6337 (>= (downcase event) ?A))
82072f33
RS
6338 (- (downcase event) ?A -1)
6339 (logior (lsh 1 lshiftby) event))))
6340 ((eq symbol 'shift)
6341 (if (and (<= (downcase event) ?z)
6342 (>= (downcase event) ?a))
6343 (upcase event)
6344 (logior (lsh 1 lshiftby) event)))
6345 (t
6346 (logior (lsh 1 lshiftby) event)))
6347 (if (memq symbol (event-modifiers event))
6348 event
6349 (let ((event-type (if (symbolp event) event (car event))))
6350 (setq event-type (intern (concat prefix (symbol-name event-type))))
6351 (if (symbolp event)
6352 event-type
6353 (cons event-type (cdr event)))))))
6354
e5fff738
KH
6355(define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6356(define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6357(define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6358(define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6359(define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6360(define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
f6039de6 6361\f
a3d1480b
JB
6362;;;; Keypad support.
6363
9b77469a
SM
6364;; Make the keypad keys act like ordinary typing keys. If people add
6365;; bindings for the function key symbols, then those bindings will
6366;; override these, so this shouldn't interfere with any existing
6367;; bindings.
a3d1480b 6368
0d173134 6369;; Also tell read-char how to handle these keys.
e1e04350 6370(mapc
a3d1480b
JB
6371 (lambda (keypad-normal)
6372 (let ((keypad (nth 0 keypad-normal))
6373 (normal (nth 1 keypad-normal)))
0d173134 6374 (put keypad 'ascii-character normal)
a3d1480b
JB
6375 (define-key function-key-map (vector keypad) (vector normal))))
6376 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6377 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
f33321ad 6378 (kp-space ?\s)
a3d1480b
JB
6379 (kp-tab ?\t)
6380 (kp-enter ?\r)
6381 (kp-multiply ?*)
6382 (kp-add ?+)
6383 (kp-separator ?,)
6384 (kp-subtract ?-)
6385 (kp-decimal ?.)
6386 (kp-divide ?/)
31cd2dd4
SM
6387 (kp-equal ?=)
6388 ;; Do the same for various keys that are represented as symbols under
6389 ;; GUIs but naturally correspond to characters.
6390 (backspace 127)
6391 (delete 127)
6392 (tab ?\t)
6393 (linefeed ?\n)
6394 (clear ?\C-l)
6395 (return ?\C-m)
6396 (escape ?\e)
6397 ))
f54b0d85 6398\f
1e722f9f 6399;;;;
b005abd5 6400;;;; forking a twin copy of a buffer.
1e722f9f 6401;;;;
b005abd5
SM
6402
6403(defvar clone-buffer-hook nil
6404 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6405
64663f06
SM
6406(defvar clone-indirect-buffer-hook nil
6407 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6408
b005abd5
SM
6409(defun clone-process (process &optional newname)
6410 "Create a twin copy of PROCESS.
6411If NEWNAME is nil, it defaults to PROCESS' name;
6412NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6413If PROCESS is associated with a buffer, the new process will be associated
6414 with the current buffer instead.
6415Returns nil if PROCESS has already terminated."
6416 (setq newname (or newname (process-name process)))
6417 (if (string-match "<[0-9]+>\\'" newname)
6418 (setq newname (substring newname 0 (match-beginning 0))))
6419 (when (memq (process-status process) '(run stop open))
6420 (let* ((process-connection-type (process-tty-name process))
b005abd5
SM
6421 (new-process
6422 (if (memq (process-status process) '(open))
ed7069af
KS
6423 (let ((args (process-contact process t)))
6424 (setq args (plist-put args :name newname))
6425 (setq args (plist-put args :buffer
403ca8d9
KS
6426 (if (process-buffer process)
6427 (current-buffer))))
ed7069af 6428 (apply 'make-network-process args))
b005abd5
SM
6429 (apply 'start-process newname
6430 (if (process-buffer process) (current-buffer))
6431 (process-command process)))))
ed7069af
KS
6432 (set-process-query-on-exit-flag
6433 new-process (process-query-on-exit-flag process))
b005abd5
SM
6434 (set-process-inherit-coding-system-flag
6435 new-process (process-inherit-coding-system-flag process))
6436 (set-process-filter new-process (process-filter process))
6437 (set-process-sentinel new-process (process-sentinel process))
403ca8d9 6438 (set-process-plist new-process (copy-sequence (process-plist process)))
b005abd5
SM
6439 new-process)))
6440
b75b82ab 6441;; things to maybe add (currently partly covered by `funcall mode'):
b005abd5
SM
6442;; - syntax-table
6443;; - overlays
6444(defun clone-buffer (&optional newname display-flag)
6b61353c
KH
6445 "Create and return a twin copy of the current buffer.
6446Unlike an indirect buffer, the new buffer can be edited
6447independently of the old one (if it is not read-only).
6448NEWNAME is the name of the new buffer. It may be modified by
6449adding or incrementing <N> at the end as necessary to create a
6450unique buffer name. If nil, it defaults to the name of the
6451current buffer, with the proper suffix. If DISPLAY-FLAG is
6452non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6453clone a file-visiting buffer, or a buffer whose major mode symbol
6454has a non-nil `no-clone' property, results in an error.
6455
6456Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6457current buffer with appropriate suffix. However, if a prefix
6458argument is given, then the command prompts for NEWNAME in the
6459minibuffer.
b005abd5 6460
b005abd5
SM
6461This runs the normal hook `clone-buffer-hook' in the new buffer
6462after it has been set up properly in other respects."
61acfe7f
RS
6463 (interactive
6464 (progn
6465 (if buffer-file-name
6466 (error "Cannot clone a file-visiting buffer"))
6467 (if (get major-mode 'no-clone)
6468 (error "Cannot clone a buffer in %s mode" mode-name))
f6039de6
JL
6469 (list (if current-prefix-arg
6470 (read-buffer "Name of new cloned buffer: " (current-buffer)))
61acfe7f 6471 t)))
b005abd5
SM
6472 (if buffer-file-name
6473 (error "Cannot clone a file-visiting buffer"))
6474 (if (get major-mode 'no-clone)
6475 (error "Cannot clone a buffer in %s mode" mode-name))
6476 (setq newname (or newname (buffer-name)))
6477 (if (string-match "<[0-9]+>\\'" newname)
6478 (setq newname (substring newname 0 (match-beginning 0))))
6479 (let ((buf (current-buffer))
6480 (ptmin (point-min))
6481 (ptmax (point-max))
6482 (pt (point))
6483 (mk (if mark-active (mark t)))
6484 (modified (buffer-modified-p))
6485 (mode major-mode)
6486 (lvars (buffer-local-variables))
6487 (process (get-buffer-process (current-buffer)))
6488 (new (generate-new-buffer (or newname (buffer-name)))))
6489 (save-restriction
6490 (widen)
6491 (with-current-buffer new
6492 (insert-buffer-substring buf)))
6493 (with-current-buffer new
6494 (narrow-to-region ptmin ptmax)
6495 (goto-char pt)
6496 (if mk (set-mark mk))
6497 (set-buffer-modified-p modified)
6498
6499 ;; Clone the old buffer's process, if any.
6500 (when process (clone-process process))
6501
6502 ;; Now set up the major mode.
6503 (funcall mode)
6504
6505 ;; Set up other local variables.
9ca2204b
JB
6506 (mapc (lambda (v)
6507 (condition-case () ;in case var is read-only
6508 (if (symbolp v)
6509 (makunbound v)
6510 (set (make-local-variable (car v)) (cdr v)))
6511 (error nil)))
6512 lvars)
b005abd5
SM
6513
6514 ;; Run any hooks (typically set up by the major mode
6515 ;; for cloning to work properly).
6516 (run-hooks 'clone-buffer-hook))
0a487199
SM
6517 (if display-flag
6518 ;; Presumably the current buffer is shown in the selected frame, so
6519 ;; we want to display the clone elsewhere.
6520 (let ((same-window-regexps nil)
6521 (same-window-buffer-names))
6522 (pop-to-buffer new)))
b005abd5
SM
6523 new))
6524
fa65f20b 6525
7e3afb04 6526(defun clone-indirect-buffer (newname display-flag &optional norecord)
fa65f20b
GM
6527 "Create an indirect buffer that is a twin copy of the current buffer.
6528
01ba9662 6529Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
fa65f20b
GM
6530from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6531or if not called with a prefix arg, NEWNAME defaults to the current
6532buffer's name. The name is modified by adding a `<N>' suffix to it
1d2b0303
JB
6533or by incrementing the N in an existing suffix. Trying to clone a
6534buffer whose major mode symbol has a non-nil `no-clone-indirect'
6535property results in an error.
fa65f20b
GM
6536
6537DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7e3afb04
GM
6538This is always done when called interactively.
6539
f33321ad 6540Optional third arg NORECORD non-nil means do not put this buffer at the
7e3afb04 6541front of the list of recently selected ones."
61acfe7f
RS
6542 (interactive
6543 (progn
6544 (if (get major-mode 'no-clone-indirect)
6545 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6546 (list (if current-prefix-arg
f6039de6 6547 (read-buffer "Name of indirect buffer: " (current-buffer)))
61acfe7f
RS
6548 t)))
6549 (if (get major-mode 'no-clone-indirect)
6550 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
fa65f20b
GM
6551 (setq newname (or newname (buffer-name)))
6552 (if (string-match "<[0-9]+>\\'" newname)
6553 (setq newname (substring newname 0 (match-beginning 0))))
6554 (let* ((name (generate-new-buffer-name newname))
6555 (buffer (make-indirect-buffer (current-buffer) name t)))
64663f06
SM
6556 (with-current-buffer buffer
6557 (run-hooks 'clone-indirect-buffer-hook))
fa65f20b 6558 (when display-flag
58dd38f1 6559 (pop-to-buffer buffer norecord))
fa65f20b
GM
6560 buffer))
6561
6562
1fffd65f
RS
6563(defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6564 "Like `clone-indirect-buffer' but display in another window."
2ef0a47e
RS
6565 (interactive
6566 (progn
6567 (if (get major-mode 'no-clone-indirect)
6568 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6569 (list (if current-prefix-arg
f6039de6 6570 (read-buffer "Name of indirect buffer: " (current-buffer)))
2ef0a47e 6571 t)))
acd39eb6 6572 (let ((pop-up-windows t))
1fffd65f 6573 (clone-indirect-buffer newname display-flag norecord)))
7e3afb04 6574
f54b0d85 6575\f
1d4b11bf
GM
6576;;; Handling of Backspace and Delete keys.
6577
30a2fded 6578(defcustom normal-erase-is-backspace 'maybe
3784ec80 6579 "Set the default behavior of the Delete and Backspace keys.
30a2fded
KL
6580
6581If set to t, Delete key deletes forward and Backspace key deletes
6582backward.
6583
6584If set to nil, both Delete and Backspace keys delete backward.
6585
6586If set to 'maybe (which is the default), Emacs automatically
3784ec80 6587selects a behavior. On window systems, the behavior depends on
30a2fded
KL
6588the keyboard used. If the keyboard has both a Backspace key and
6589a Delete key, and both are mapped to their usual meanings, the
6590option's default value is set to t, so that Backspace can be used
6591to delete backward, and Delete can be used to delete forward.
6592
6593If not running under a window system, customizing this option
6594accomplishes a similar effect by mapping C-h, which is usually
6595generated by the Backspace key, to DEL, and by mapping DEL to C-d
6596via `keyboard-translate'. The former functionality of C-h is
6597available on the F1 key. You should probably not use this
6598setting if you don't have both Backspace, Delete and F1 keys.
f060b834
GM
6599
6600Setting this variable with setq doesn't take effect. Programmatically,
7f62656b 6601call `normal-erase-is-backspace-mode' (which see) instead."
30a2fded
KL
6602 :type '(choice (const :tag "Off" nil)
6603 (const :tag "Maybe" maybe)
6604 (other :tag "On" t))
1d4b11bf
GM
6605 :group 'editing-basics
6606 :version "21.1"
6607 :set (lambda (symbol value)
6608 ;; The fboundp is because of a problem with :set when
6609 ;; dumping Emacs. It doesn't really matter.
7f62656b
EZ
6610 (if (fboundp 'normal-erase-is-backspace-mode)
6611 (normal-erase-is-backspace-mode (or value 0))
1d4b11bf
GM
6612 (set-default symbol value))))
6613
30a2fded
KL
6614(defun normal-erase-is-backspace-setup-frame (&optional frame)
6615 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6616 (unless frame (setq frame (selected-frame)))
6617 (with-selected-frame frame
ed8dad6b 6618 (unless (terminal-parameter nil 'normal-erase-is-backspace)
08ea6d2f
SM
6619 (normal-erase-is-backspace-mode
6620 (if (if (eq normal-erase-is-backspace 'maybe)
6621 (and (not noninteractive)
6622 (or (memq system-type '(ms-dos windows-nt))
79cb9c05 6623 (memq window-system '(ns))
08ea6d2f
SM
6624 (and (memq window-system '(x))
6625 (fboundp 'x-backspace-delete-keys-p)
6626 (x-backspace-delete-keys-p))
6627 ;; If the terminal Emacs is running on has erase char
6628 ;; set to ^H, use the Backspace key for deleting
6629 ;; backward, and the Delete key for deleting forward.
6630 (and (null window-system)
6631 (eq tty-erase-char ?\^H))))
6632 normal-erase-is-backspace)
6633 1 0)))))
1d4b11bf 6634
80ac5d4d 6635(define-minor-mode normal-erase-is-backspace-mode
7f62656b
EZ
6636 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6637
1d2b0303 6638With numeric ARG, turn the mode on if and only if ARG is positive.
7f62656b 6639
30a2fded
KL
6640On window systems, when this mode is on, Delete is mapped to C-d
6641and Backspace is mapped to DEL; when this mode is off, both
6642Delete and Backspace are mapped to DEL. (The remapping goes via
6643`local-function-key-map', so binding Delete or Backspace in the
6644global or local keymap will override that.)
7f62656b
EZ
6645
6646In addition, on window systems, the bindings of C-Delete, M-Delete,
6647C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6648the global keymap in accordance with the functionality of Delete and
6649Backspace. For example, if Delete is remapped to C-d, which deletes
6650forward, C-Delete is bound to `kill-word', but if Delete is remapped
6651to DEL, which deletes backward, C-Delete is bound to
6652`backward-kill-word'.
6653
6654If not running on a window system, a similar effect is accomplished by
6655remapping C-h (normally produced by the Backspace key) and DEL via
6656`keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6657to C-d; if it's off, the keys are not remapped.
6658
6659When not running on a window system, and this mode is turned on, the
6660former functionality of C-h is available on the F1 key. You should
6661probably not turn on this mode on a text-only terminal if you don't
6662have both Backspace, Delete and F1 keys.
6663
6664See also `normal-erase-is-backspace'."
80ac5d4d
SM
6665 :variable (eq (terminal-parameter
6666 nil 'normal-erase-is-backspace) 1)
6667 (let ((enabled (eq 1 (terminal-parameter
6668 nil 'normal-erase-is-backspace))))
0103b7c9 6669
9e2a2647 6670 (cond ((or (memq window-system '(x w32 ns pc))
0103b7c9 6671 (memq system-type '(ms-dos windows-nt)))
06b60517
JB
6672 (let ((bindings
6673 `(([M-delete] [M-backspace])
6674 ([C-M-delete] [C-M-backspace])
6675 ([?\e C-delete] [?\e C-backspace]))))
0103b7c9
KL
6676
6677 (if enabled
6678 (progn
b8a47412 6679 (define-key local-function-key-map [delete] [deletechar])
0103b7c9 6680 (define-key local-function-key-map [kp-delete] [?\C-d])
28a90c44
SM
6681 (define-key local-function-key-map [backspace] [?\C-?])
6682 (dolist (b bindings)
6683 ;; Not sure if input-decode-map is really right, but
6684 ;; keyboard-translate-table (used below) only works
6685 ;; for integer events, and key-translation-table is
6686 ;; global (like the global-map, used earlier).
6687 (define-key input-decode-map (car b) nil)
6688 (define-key input-decode-map (cadr b) nil)))
0103b7c9
KL
6689 (define-key local-function-key-map [delete] [?\C-?])
6690 (define-key local-function-key-map [kp-delete] [?\C-?])
28a90c44
SM
6691 (define-key local-function-key-map [backspace] [?\C-?])
6692 (dolist (b bindings)
6693 (define-key input-decode-map (car b) (cadr b))
6694 (define-key input-decode-map (cadr b) (car b))))))
0103b7c9
KL
6695 (t
6696 (if enabled
ec9f4754 6697 (progn
0103b7c9
KL
6698 (keyboard-translate ?\C-h ?\C-?)
6699 (keyboard-translate ?\C-? ?\C-d))
6700 (keyboard-translate ?\C-h ?\C-h)
6701 (keyboard-translate ?\C-? ?\C-?))))
6702
32226619 6703 (if (called-interactively-p 'interactive)
0103b7c9 6704 (message "Delete key deletes %s"
b08016f2 6705 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
0103b7c9 6706 "forward" "backward")))))
ea82f0df 6707\f
aca8bee5 6708(defvar vis-mode-saved-buffer-invisibility-spec nil
0f7df535 6709 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7f62656b 6710
0f7df535
RS
6711(define-minor-mode visible-mode
6712 "Toggle Visible mode.
4837b516
GM
6713With argument ARG turn Visible mode on if ARG is positive, otherwise
6714turn it off.
1d4b11bf 6715
0f7df535 6716Enabling Visible mode makes all invisible text temporarily visible.
1d2b0303
JB
6717Disabling Visible mode turns off that effect. Visible mode works by
6718saving the value of `buffer-invisibility-spec' and setting it to nil."
4e57881d 6719 :lighter " Vis"
ab77efd0 6720 :group 'editing-basics
aca8bee5
SM
6721 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6722 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6723 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
0f7df535 6724 (when visible-mode
aca8bee5
SM
6725 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6726 buffer-invisibility-spec)
6727 (setq buffer-invisibility-spec nil)))
4e57881d 6728\f
e1e04350 6729;; Minibuffer prompt stuff.
9b350152 6730
2ec42da9
SM
6731;;(defun minibuffer-prompt-modification (start end)
6732;; (error "You cannot modify the prompt"))
6733;;
6734;;
6735;;(defun minibuffer-prompt-insertion (start end)
6736;; (let ((inhibit-modification-hooks t))
6737;; (delete-region start end)
6738;; ;; Discard undo information for the text insertion itself
6739;; ;; and for the text deletion.above.
6740;; (when (consp buffer-undo-list)
6741;; (setq buffer-undo-list (cddr buffer-undo-list)))
6742;; (message "You cannot modify the prompt")))
6743;;
6744;;
6745;;(setq minibuffer-prompt-properties
6746;; (list 'modification-hooks '(minibuffer-prompt-modification)
6747;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
9b350152 6748
a2603048
GM
6749\f
6750;;;; Problematic external packages.
6751
6752;; rms says this should be done by specifying symbols that define
6753;; versions together with bad values. This is therefore not as
6754;; flexible as it could be. See the thread:
6755;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6756(defconst bad-packages-alist
6757 ;; Not sure exactly which semantic versions have problems.
6758 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7796ee61 6759 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
a2603048 6760 "The version of `semantic' loaded does not work in Emacs 22.
72d595b5
GM
6761It can cause constant high CPU load.
6762Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
a2603048
GM
6763 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6764 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6765 ;; provided the `CUA-mode' feature. Since this is no longer true,
6766 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6767 (CUA-mode t nil
6768"CUA-mode is now part of the standard GNU Emacs distribution,
6769so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6770
6771You have loaded an older version of CUA-mode which does not work
6772correctly with this version of Emacs. You should remove the old
6773version and use the one distributed with Emacs."))
6774 "Alist of packages known to cause problems in this version of Emacs.
6775Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6776PACKAGE is either a regular expression to match file names, or a
6777symbol (a feature name); see the documentation of
6778`after-load-alist', to which this variable adds functions.
6779SYMBOL is either the name of a string variable, or `t'. Upon
6780loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6781warning using STRING as the message.")
6782
6783(defun bad-package-check (package)
6784 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6785 (condition-case nil
6786 (let* ((list (assoc package bad-packages-alist))
6787 (symbol (nth 1 list)))
6788 (and list
6789 (boundp symbol)
6790 (or (eq symbol t)
6791 (and (stringp (setq symbol (eval symbol)))
9bc505ab
JB
6792 (string-match-p (nth 2 list) symbol)))
6793 (display-warning package (nth 3 list) :warning)))
a2603048
GM
6794 (error nil)))
6795
6796(mapc (lambda (elem)
6797 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6798 bad-packages-alist)
6799
6800
00398e3b 6801(provide 'simple)
6b61353c 6802
c88ab9ce 6803;;; simple.el ends here