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