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