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