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