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