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