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