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