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