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