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