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