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