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