Try and be more careful about propagation of lexical environment.
[bpt/emacs.git] / lisp / simple.el
CommitLineData
c88ab9ce
ER
1;;; simple.el --- basic editing commands for Emacs
2
9d794026
GM
3;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998,
4;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
5;; 2010 Free Software Foundation, Inc.
2076c87c 6
30764597
PJ
7;; Maintainer: FSF
8;; Keywords: internal
bd78fa1d 9;; Package: emacs
30764597 10
2076c87c
JB
11;; This file is part of GNU Emacs.
12
eb3fa2cf 13;; GNU Emacs is free software: you can redistribute it and/or modify
2076c87c 14;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
15;; the Free Software Foundation, either version 3 of the License, or
16;; (at your option) any later version.
2076c87c
JB
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
eb3fa2cf 24;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
2076c87c 25
d9ecc911
ER
26;;; Commentary:
27
28;; A grab-bag of basic Emacs commands not specifically related to some
29;; major mode or to file-handling.
30
3a801d0c 31;;; Code:
2076c87c 32
30ee26a9
EZ
33;; This is for lexical-let in apply-partially.
34(eval-when-compile (require 'cl))
35
f31b1257
DN
36(declare-function widget-convert "wid-edit" (type &rest args))
37(declare-function shell-mode "shell" ())
d01a33cf 38
ca60ee11
JB
39(defvar compilation-current-error)
40
7fcce20f 41(defcustom idle-update-delay 0.5
1d2b0303 42 "Idle time delay before updating various things on the screen.
7fcce20f
RS
43Various Emacs features that update auxiliary information when point moves
44wait this many seconds after Emacs becomes idle before doing an update."
45 :type 'number
46 :group 'display
47 :version "22.1")
d01a33cf 48
69c1dd37 49(defgroup killing nil
c9f0110e 50 "Killing and yanking commands."
69c1dd37
RS
51 :group 'editing)
52
69c1dd37
RS
53(defgroup paren-matching nil
54 "Highlight (un)matching of parens and expressions."
69c1dd37
RS
55 :group 'matching)
56
7979163c
JL
57(defun get-next-valid-buffer (list &optional buffer visible-ok frame)
58 "Search LIST for a valid buffer to display in FRAME.
a74f9094
KL
59Return nil when all buffers in LIST are undesirable for display,
60otherwise return the first suitable buffer in LIST.
61
62Buffers not visible in windows are preferred to visible buffers,
63unless VISIBLE-OK is non-nil.
64If the optional argument FRAME is nil, it defaults to the selected frame.
7979163c 65If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
a74f9094
KL
66 ;; This logic is more or less copied from other-buffer.
67 (setq frame (or frame (selected-frame)))
68 (let ((pred (frame-parameter frame 'buffer-predicate))
69 found buf)
70 (while (and (not found) list)
71 (setq buf (car list))
72 (if (and (not (eq buffer buf))
73 (buffer-live-p buf)
74 (or (null pred) (funcall pred buf))
75 (not (eq (aref (buffer-name buf) 0) ?\s))
76 (or visible-ok (null (get-buffer-window buf 'visible))))
77 (setq found buf)
78 (setq list (cdr list))))
79 (car list)))
80
7979163c 81(defun last-buffer (&optional buffer visible-ok frame)
4dc1abeb
MR
82 "Return the last buffer in FRAME's buffer list.
83If BUFFER is the last buffer, return the preceding buffer instead.
a74f9094
KL
84Buffers not visible in windows are preferred to visible buffers,
85unless optional argument VISIBLE-OK is non-nil.
4dc1abeb
MR
86Optional third argument FRAME nil or omitted means use the
87selected frame's buffer list.
88If no such buffer exists, return the buffer `*scratch*', creating
89it if necessary."
a74f9094 90 (setq frame (or frame (selected-frame)))
a18b8cb5
KL
91 (or (get-next-valid-buffer (nreverse (buffer-list frame))
92 buffer visible-ok frame)
4dc1abeb
MR
93 (get-buffer "*scratch*")
94 (let ((scratch (get-buffer-create "*scratch*")))
95 (set-buffer-major-mode scratch)
96 scratch)))
97
f54b0d85
RS
98(defun next-buffer ()
99 "Switch to the next buffer in cyclic order."
100 (interactive)
a18b8cb5 101 (let ((buffer (current-buffer)))
a74f9094 102 (switch-to-buffer (other-buffer buffer t))
a18b8cb5 103 (bury-buffer buffer)))
a74f9094
KL
104
105(defun previous-buffer ()
f54b0d85
RS
106 "Switch to the previous buffer in cyclic order."
107 (interactive)
a18b8cb5 108 (switch-to-buffer (last-buffer (current-buffer) t)))
a74f9094 109
ee9c5954 110\f
50f007fb 111;;; next-error support framework
bbf41690
RS
112
113(defgroup next-error nil
f33321ad 114 "`next-error' support framework."
bbf41690 115 :group 'compilation
bf247b6e 116 :version "22.1")
bbf41690
RS
117
118(defface next-error
119 '((t (:inherit region)))
120 "Face used to highlight next error locus."
121 :group 'next-error
bf247b6e 122 :version "22.1")
bbf41690 123
7408ee97 124(defcustom next-error-highlight 0.5
1d2b0303 125 "Highlighting of locations in selected source buffers.
676b1a74
CY
126If a number, highlight the locus in `next-error' face for the given time
127in seconds, or until the next command is executed.
128If t, highlight the locus until the next command is executed, or until
129some other locus replaces it.
bbf41690
RS
130If nil, don't highlight the locus in the source buffer.
131If `fringe-arrow', indicate the locus by the fringe arrow."
6d3c944b 132 :type '(choice (number :tag "Highlight for specified time")
c81b29e6 133 (const :tag "Semipermanent highlighting" t)
bbf41690 134 (const :tag "No highlighting" nil)
6d3c944b 135 (const :tag "Fringe arrow" fringe-arrow))
bbf41690 136 :group 'next-error
bf247b6e 137 :version "22.1")
bbf41690 138
7408ee97 139(defcustom next-error-highlight-no-select 0.5
1d2b0303 140 "Highlighting of locations in `next-error-no-select'.
f33321ad 141If number, highlight the locus in `next-error' face for given time in seconds.
6d3c944b 142If t, highlight the locus indefinitely until some other locus replaces it.
bbf41690
RS
143If nil, don't highlight the locus in the source buffer.
144If `fringe-arrow', indicate the locus by the fringe arrow."
6d3c944b 145 :type '(choice (number :tag "Highlight for specified time")
c81b29e6 146 (const :tag "Semipermanent highlighting" t)
bbf41690 147 (const :tag "No highlighting" nil)
6d3c944b 148 (const :tag "Fringe arrow" fringe-arrow))
bbf41690 149 :group 'next-error
bf247b6e 150 :version "22.1")
bbf41690 151
446b609e 152(defcustom next-error-recenter nil
1d2b0303 153 "Display the line in the visited source file recentered as specified.
28adf31c
TTN
154If non-nil, the value is passed directly to `recenter'."
155 :type '(choice (integer :tag "Line to recenter to")
156 (const :tag "Center of window" (4))
446b609e
TTN
157 (const :tag "No recentering" nil))
158 :group 'next-error
159 :version "23.1")
160
d634a3a2 161(defcustom next-error-hook nil
1d2b0303 162 "List of hook functions run by `next-error' after visiting source file."
d634a3a2
JL
163 :type 'hook
164 :group 'next-error)
165
814c3037
JL
166(defvar next-error-highlight-timer nil)
167
9c9b00d6 168(defvar next-error-overlay-arrow-position nil)
6bdad9ae 169(put 'next-error-overlay-arrow-position 'overlay-arrow-string (purecopy "=>"))
9c9b00d6
JL
170(add-to-list 'overlay-arrow-variable-list 'next-error-overlay-arrow-position)
171
50f007fb 172(defvar next-error-last-buffer nil
f33321ad 173 "The most recent `next-error' buffer.
50f007fb
KS
174A buffer becomes most recent when its compilation, grep, or
175similar mode is started, or when it is used with \\[next-error]
176or \\[compile-goto-error].")
177
178(defvar next-error-function nil
e462ab77
SM
179 "Function to use to find the next error in the current buffer.
180The function is called with 2 parameters:
181ARG is an integer specifying by how many errors to move.
182RESET is a boolean which, if non-nil, says to go back to the beginning
183of the errors before moving.
184Major modes providing compile-like functionality should set this variable
185to indicate to `next-error' that this is a candidate buffer and how
186to navigate in it.")
50f007fb
KS
187(make-variable-buffer-local 'next-error-function)
188
8cdba32b
RS
189(defvar next-error-move-function nil
190 "Function to use to move to an error locus.
191It takes two arguments, a buffer position in the error buffer
192and a buffer position in the error locus buffer.
193The buffer for the error locus should already be current.
194nil means use goto-char using the second argument position.")
195(make-variable-buffer-local 'next-error-move-function)
196
f1e2a033 197(defsubst next-error-buffer-p (buffer
e967cd11 198 &optional avoid-current
f1e2a033 199 extra-test-inclusive
5f9e0ca5 200 extra-test-exclusive)
f33321ad 201 "Test if BUFFER is a `next-error' capable buffer.
e967cd11
RS
202
203If AVOID-CURRENT is non-nil, treat the current buffer
204as an absolute last resort only.
205
206The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
207that normally would not qualify. If it returns t, the buffer
208in question is treated as usable.
209
7979163c 210The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
01ba9662 211that would normally be considered usable. If it returns nil,
e967cd11
RS
212that buffer is rejected."
213 (and (buffer-name buffer) ;First make sure it's live.
214 (not (and avoid-current (eq buffer (current-buffer))))
215 (with-current-buffer buffer
216 (if next-error-function ; This is the normal test.
217 ;; Optionally reject some buffers.
218 (if extra-test-exclusive
219 (funcall extra-test-exclusive)
220 t)
221 ;; Optionally accept some other buffers.
222 (and extra-test-inclusive
223 (funcall extra-test-inclusive))))))
224
225(defun next-error-find-buffer (&optional avoid-current
f1e2a033 226 extra-test-inclusive
5f9e0ca5 227 extra-test-exclusive)
f33321ad 228 "Return a `next-error' capable buffer.
7979163c 229
e967cd11
RS
230If AVOID-CURRENT is non-nil, treat the current buffer
231as an absolute last resort only.
232
01ba9662 233The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
e967cd11
RS
234that normally would not qualify. If it returns t, the buffer
235in question is treated as usable.
236
7979163c 237The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
e967cd11
RS
238that would normally be considered usable. If it returns nil,
239that buffer is rejected."
03e75c7e
JL
240 (or
241 ;; 1. If one window on the selected frame displays such buffer, return it.
242 (let ((window-buffers
243 (delete-dups
244 (delq nil (mapcar (lambda (w)
245 (if (next-error-buffer-p
e967cd11
RS
246 (window-buffer w)
247 avoid-current
f1e2a033 248 extra-test-inclusive extra-test-exclusive)
03e75c7e
JL
249 (window-buffer w)))
250 (window-list))))))
03e75c7e
JL
251 (if (eq (length window-buffers) 1)
252 (car window-buffers)))
e967cd11 253 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
03e75c7e 254 (if (and next-error-last-buffer
e967cd11 255 (next-error-buffer-p next-error-last-buffer avoid-current
f1e2a033 256 extra-test-inclusive extra-test-exclusive))
e967cd11
RS
257 next-error-last-buffer)
258 ;; 3. If the current buffer is acceptable, choose it.
259 (if (next-error-buffer-p (current-buffer) avoid-current
260 extra-test-inclusive extra-test-exclusive)
03e75c7e 261 (current-buffer))
e967cd11 262 ;; 4. Look for any acceptable buffer.
03e75c7e
JL
263 (let ((buffers (buffer-list)))
264 (while (and buffers
e967cd11
RS
265 (not (next-error-buffer-p
266 (car buffers) avoid-current
267 extra-test-inclusive extra-test-exclusive)))
03e75c7e 268 (setq buffers (cdr buffers)))
e967cd11
RS
269 (car buffers))
270 ;; 5. Use the current buffer as a last resort if it qualifies,
271 ;; even despite AVOID-CURRENT.
272 (and avoid-current
273 (next-error-buffer-p (current-buffer) nil
274 extra-test-inclusive extra-test-exclusive)
275 (progn
ee4dc5d9 276 (message "This is the only buffer with error message locations")
e967cd11
RS
277 (current-buffer)))
278 ;; 6. Give up.
ee4dc5d9 279 (error "No buffers contain error message locations")))
50f007fb 280
310abb0b 281(defun next-error (&optional arg reset)
f33321ad 282 "Visit next `next-error' message and corresponding source code.
50f007fb
KS
283
284If all the error messages parsed so far have been processed already,
285the message buffer is checked for new ones.
286
e462ab77 287A prefix ARG specifies how many error messages to move;
50f007fb
KS
288negative means move back to previous error messages.
289Just \\[universal-argument] as a prefix means reparse the error message buffer
290and start at the first error.
291
e249a6d8 292The RESET argument specifies that we should restart from the beginning.
50f007fb
KS
293
294\\[next-error] normally uses the most recently started
295compilation, grep, or occur buffer. It can also operate on any
296buffer with output from the \\[compile], \\[grep] commands, or,
297more generally, on any buffer in Compilation mode or with
298Compilation Minor mode enabled, or any buffer in which
03e75c7e
JL
299`next-error-function' is bound to an appropriate function.
300To specify use of a particular buffer for error messages, type
301\\[next-error] in that buffer when it is the only one displayed
302in the current frame.
50f007fb 303
d634a3a2
JL
304Once \\[next-error] has chosen the buffer for error messages, it
305runs `next-error-hook' with `run-hooks', and stays with that buffer
306until you use it in some other buffer which uses Compilation mode
307or Compilation Minor mode.
50f007fb
KS
308
309See variables `compilation-parse-errors-function' and
310\`compilation-error-regexp-alist' for customization ideas."
311 (interactive "P")
e462ab77 312 (if (consp arg) (setq reset t arg nil))
50f007fb
KS
313 (when (setq next-error-last-buffer (next-error-find-buffer))
314 ;; we know here that next-error-function is a valid symbol we can funcall
315 (with-current-buffer next-error-last-buffer
d634a3a2 316 (funcall next-error-function (prefix-numeric-value arg) reset)
446b609e
TTN
317 (when next-error-recenter
318 (recenter next-error-recenter))
d634a3a2 319 (run-hooks 'next-error-hook))))
50f007fb 320
56ab610b
RS
321(defun next-error-internal ()
322 "Visit the source code corresponding to the `next-error' message at point."
323 (setq next-error-last-buffer (current-buffer))
324 ;; we know here that next-error-function is a valid symbol we can funcall
325 (with-current-buffer next-error-last-buffer
326 (funcall next-error-function 0 nil)
446b609e
TTN
327 (when next-error-recenter
328 (recenter next-error-recenter))
56ab610b
RS
329 (run-hooks 'next-error-hook)))
330
50f007fb
KS
331(defalias 'goto-next-locus 'next-error)
332(defalias 'next-match 'next-error)
333
310abb0b 334(defun previous-error (&optional n)
f33321ad 335 "Visit previous `next-error' message and corresponding source code.
50f007fb
KS
336
337Prefix arg N says how many error messages to move backwards (or
338forwards, if negative).
339
340This operates on the output from the \\[compile] and \\[grep] commands."
341 (interactive "p")
310abb0b 342 (next-error (- (or n 1))))
50f007fb 343
310abb0b 344(defun first-error (&optional n)
50f007fb
KS
345 "Restart at the first error.
346Visit corresponding source code.
347With prefix arg N, visit the source code of the Nth error.
348This operates on the output from the \\[compile] command, for instance."
349 (interactive "p")
350 (next-error n t))
351
310abb0b 352(defun next-error-no-select (&optional n)
f33321ad 353 "Move point to the next error in the `next-error' buffer and highlight match.
50f007fb
KS
354Prefix arg N says how many error messages to move forwards (or
355backwards, if negative).
356Finds and highlights the source line like \\[next-error], but does not
357select the source buffer."
358 (interactive "p")
ee9c5954
JL
359 (let ((next-error-highlight next-error-highlight-no-select))
360 (next-error n))
50f007fb
KS
361 (pop-to-buffer next-error-last-buffer))
362
310abb0b 363(defun previous-error-no-select (&optional n)
f33321ad 364 "Move point to the previous error in the `next-error' buffer and highlight match.
50f007fb
KS
365Prefix arg N says how many error messages to move backwards (or
366forwards, if negative).
367Finds and highlights the source line like \\[previous-error], but does not
368select the source buffer."
369 (interactive "p")
310abb0b 370 (next-error-no-select (- (or n 1))))
50f007fb 371
85be9ec4 372;; Internal variable for `next-error-follow-mode-post-command-hook'.
282d6eae
EZ
373(defvar next-error-follow-last-line nil)
374
2a223f35 375(define-minor-mode next-error-follow-minor-mode
282d6eae 376 "Minor mode for compilation, occur and diff modes.
2a223f35
EZ
377When turned on, cursor motion in the compilation, grep, occur or diff
378buffer causes automatic display of the corresponding source code
379location."
ed8e0f0a 380 :group 'next-error :init-value nil :lighter " Fol"
8a98a6c2 381 (if (not next-error-follow-minor-mode)
282d6eae
EZ
382 (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t)
383 (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t)
e56dd5c6 384 (make-local-variable 'next-error-follow-last-line)))
282d6eae 385
85be9ec4
SM
386;; Used as a `post-command-hook' by `next-error-follow-mode'
387;; for the *Compilation* *grep* and *Occur* buffers.
282d6eae
EZ
388(defun next-error-follow-mode-post-command-hook ()
389 (unless (equal next-error-follow-last-line (line-number-at-pos))
390 (setq next-error-follow-last-line (line-number-at-pos))
391 (condition-case nil
392 (let ((compilation-context-lines nil))
393 (setq compilation-current-error (point))
394 (next-error-no-select 0))
395 (error t))))
396
ee9c5954 397\f
50f007fb
KS
398;;;
399
93be67de
KH
400(defun fundamental-mode ()
401 "Major mode not specialized for anything in particular.
402Other major modes are defined by comparison with this one."
403 (interactive)
e174f8db 404 (kill-all-local-variables)
56924d99 405 (run-mode-hooks 'fundamental-mode-hook))
eaae8106 406
d445b3f8
SM
407;; Special major modes to view specially formatted data rather than files.
408
409(defvar special-mode-map
410 (let ((map (make-sparse-keymap)))
411 (suppress-keymap map)
412 (define-key map "q" 'quit-window)
413 (define-key map " " 'scroll-up)
414 (define-key map "\C-?" 'scroll-down)
415 (define-key map "?" 'describe-mode)
416 (define-key map ">" 'end-of-buffer)
417 (define-key map "<" 'beginning-of-buffer)
418 (define-key map "g" 'revert-buffer)
419 map))
1d2b0303 420
d445b3f8
SM
421(put 'special-mode 'mode-class 'special)
422(define-derived-mode special-mode nil "Special"
423 "Parent major mode from which special major modes should inherit."
424 (setq buffer-read-only t))
425
10dcc561
SM
426;; Major mode meant to be the parent of programming modes.
427
b2a15250
SM
428(defvar prog-mode-map
429 (let ((map (make-sparse-keymap)))
430 (define-key map [?\C-\M-q] 'prog-indent-sexp)
431 map)
432 "Keymap used for programming modes.")
433
434(defun prog-indent-sexp ()
435 "Indent the expression after point."
436 (interactive)
437 (let ((start (point))
438 (end (save-excursion (forward-sexp 1) (point))))
439 (indent-region start end nil)))
440
10dcc561
SM
441(define-derived-mode prog-mode fundamental-mode "Prog"
442 "Major mode for editing programming language source code."
443 (set (make-local-variable 'require-final-newline) mode-require-final-newline)
228482b2
EZ
444 (set (make-local-variable 'parse-sexp-ignore-comments) t)
445 ;; Any programming language is always written left to right.
446 (setq bidi-paragraph-direction 'left-to-right))
10dcc561 447
93be67de
KH
448;; Making and deleting lines.
449
28fab7b5
GM
450(defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard))
451 "Propertized string representing a hard newline character.")
4ea0018b 452
30bb9754 453(defun newline (&optional arg)
d133d835 454 "Insert a newline, and move to left margin of the new line if it's blank.
058d4999
DL
455If `use-hard-newlines' is non-nil, the newline is marked with the
456text-property `hard'.
76c64e24 457With ARG, insert that many newlines.
058d4999 458Call `auto-fill-function' if the current column number is greater
6688f85f 459than the value of `fill-column' and ARG is nil."
30bb9754 460 (interactive "*P")
4c4cbf11 461 (barf-if-buffer-read-only)
e5eddfd1
SM
462 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
463 ;; Set last-command-event to tell self-insert what to insert.
464 (let* ((was-page-start (and (bolp) (looking-at page-delimiter)))
465 (beforepos (point))
466 (last-command-event ?\n)
467 ;; Don't auto-fill if we have a numeric argument.
468 (auto-fill-function (if arg nil auto-fill-function))
469 (postproc
470 ;; Do the rest in post-self-insert-hook, because we want to do it
471 ;; *before* other functions on that hook.
472 (lambda ()
473 ;; Mark the newline(s) `hard'.
474 (if use-hard-newlines
475 (set-hard-newline-properties
476 (- (point) (prefix-numeric-value arg)) (point)))
477 ;; If the newline leaves the previous line blank, and we
478 ;; have a left margin, delete that from the blank line.
479 (save-excursion
480 (goto-char beforepos)
481 (beginning-of-line)
482 (and (looking-at "[ \t]$")
483 (> (current-left-margin) 0)
484 (delete-region (point)
485 (line-end-position))))
486 ;; Indent the line after the newline, except in one case:
487 ;; when we added the newline at the beginning of a line which
488 ;; starts a page.
489 (or was-page-start
490 (move-to-left-margin nil t)))))
491 (unwind-protect
492 (progn
493 (add-hook 'post-self-insert-hook postproc)
494 (self-insert-command (prefix-numeric-value arg)))
495 ;; We first used let-binding to protect the hook, but that was naive
496 ;; since add-hook affects the symbol-default value of the variable,
497 ;; whereas the let-binding might only protect the buffer-local value.
498 (remove-hook 'post-self-insert-hook postproc)))
30bb9754
BG
499 nil)
500
55741b46
RS
501(defun set-hard-newline-properties (from to)
502 (let ((sticky (get-text-property from 'rear-nonsticky)))
503 (put-text-property from to 'hard 't)
504 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
505 (if (and (listp sticky) (not (memq 'hard sticky)))
506 (put-text-property from (point) 'rear-nonsticky
507 (cons 'hard sticky)))))
eaae8106 508
e249a6d8 509(defun open-line (n)
ff1fbe3e 510 "Insert a newline and leave point before it.
f33321ad
JB
511If there is a fill prefix and/or a `left-margin', insert them
512on the new line if the line would have been blank.
616ed245 513With arg N, insert N newlines."
2076c87c 514 (interactive "*p")
616ed245 515 (let* ((do-fill-prefix (and fill-prefix (bolp)))
3db1e3b5 516 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
c156a63b 517 (loc (point-marker))
207d7545
GM
518 ;; Don't expand an abbrev before point.
519 (abbrev-mode nil))
e249a6d8 520 (newline n)
d133d835 521 (goto-char loc)
e249a6d8 522 (while (> n 0)
d133d835
RS
523 (cond ((bolp)
524 (if do-left-margin (indent-to (current-left-margin)))
525 (if do-fill-prefix (insert-and-inherit fill-prefix))))
526 (forward-line 1)
e249a6d8 527 (setq n (1- n)))
d133d835
RS
528 (goto-char loc)
529 (end-of-line)))
2076c87c 530
da7d231b
KS
531(defun split-line (&optional arg)
532 "Split current line, moving portion beyond point vertically down.
533If the current line starts with `fill-prefix', insert it on the new
f33321ad 534line as well. With prefix ARG, don't insert `fill-prefix' on new line.
da7d231b 535
e249a6d8 536When called from Lisp code, ARG may be a prefix string to copy."
da7d231b 537 (interactive "*P")
2076c87c 538 (skip-chars-forward " \t")
d77bbdc9
RS
539 (let* ((col (current-column))
540 (pos (point))
541 ;; What prefix should we check for (nil means don't).
542 (prefix (cond ((stringp arg) arg)
543 (arg nil)
544 (t fill-prefix)))
545 ;; Does this line start with it?
546 (have-prfx (and prefix
547 (save-excursion
548 (beginning-of-line)
549 (looking-at (regexp-quote prefix))))))
28191e20 550 (newline 1)
d77bbdc9 551 (if have-prfx (insert-and-inherit prefix))
2076c87c
JB
552 (indent-to col 0)
553 (goto-char pos)))
554
2076c87c
JB
555(defun delete-indentation (&optional arg)
556 "Join this line to previous and fix up whitespace at join.
ccc58657 557If there is a fill prefix, delete it from the beginning of this line.
2076c87c
JB
558With argument, join this line to following line."
559 (interactive "*P")
560 (beginning-of-line)
561 (if arg (forward-line 1))
562 (if (eq (preceding-char) ?\n)
563 (progn
564 (delete-region (point) (1- (point)))
ccc58657
RS
565 ;; If the second line started with the fill prefix,
566 ;; delete the prefix.
567 (if (and fill-prefix
01b8e020 568 (<= (+ (point) (length fill-prefix)) (point-max))
ccc58657
RS
569 (string= fill-prefix
570 (buffer-substring (point)
571 (+ (point) (length fill-prefix)))))
572 (delete-region (point) (+ (point) (length fill-prefix))))
2076c87c
JB
573 (fixup-whitespace))))
574
fc025090 575(defalias 'join-line #'delete-indentation) ; easier to find
eaae8106 576
2076c87c
JB
577(defun delete-blank-lines ()
578 "On blank line, delete all surrounding blank lines, leaving just one.
579On isolated blank line, delete that one.
6d30d416 580On nonblank line, delete any immediately following blank lines."
2076c87c
JB
581 (interactive "*")
582 (let (thisblank singleblank)
583 (save-excursion
584 (beginning-of-line)
585 (setq thisblank (looking-at "[ \t]*$"))
70e14c01 586 ;; Set singleblank if there is just one blank line here.
2076c87c
JB
587 (setq singleblank
588 (and thisblank
589 (not (looking-at "[ \t]*\n[ \t]*$"))
590 (or (bobp)
591 (progn (forward-line -1)
592 (not (looking-at "[ \t]*$")))))))
70e14c01 593 ;; Delete preceding blank lines, and this one too if it's the only one.
2076c87c
JB
594 (if thisblank
595 (progn
596 (beginning-of-line)
597 (if singleblank (forward-line 1))
598 (delete-region (point)
599 (if (re-search-backward "[^ \t\n]" nil t)
600 (progn (forward-line 1) (point))
601 (point-min)))))
70e14c01
JB
602 ;; Delete following blank lines, unless the current line is blank
603 ;; and there are no following blank lines.
2076c87c
JB
604 (if (not (and thisblank singleblank))
605 (save-excursion
606 (end-of-line)
607 (forward-line 1)
608 (delete-region (point)
609 (if (re-search-forward "[^ \t\n]" nil t)
610 (progn (beginning-of-line) (point))
70e14c01
JB
611 (point-max)))))
612 ;; Handle the special case where point is followed by newline and eob.
613 ;; Delete the line, leaving point at eob.
614 (if (looking-at "^[ \t]*\n\\'")
615 (delete-region (point) (point-max)))))
2076c87c 616
eaae8106
SS
617(defun delete-trailing-whitespace ()
618 "Delete all the trailing whitespace across the current buffer.
619All whitespace after the last non-whitespace character in a line is deleted.
103db06c
RS
620This respects narrowing, created by \\[narrow-to-region] and friends.
621A formfeed is not considered whitespace by this function."
eaae8106
SS
622 (interactive "*")
623 (save-match-data
624 (save-excursion
625 (goto-char (point-min))
5c9b3fac
MB
626 (while (re-search-forward "\\s-$" nil t)
627 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
3a768251 628 ;; Don't delete formfeeds, even if they are considered whitespace.
661aa5c7
GM
629 (save-match-data
630 (if (looking-at ".*\f")
631 (goto-char (match-end 0))))
7981d89f 632 (delete-region (point) (match-end 0))))))
eaae8106 633
2076c87c
JB
634(defun newline-and-indent ()
635 "Insert a newline, then indent according to major mode.
ff1fbe3e 636Indentation is done using the value of `indent-line-function'.
2076c87c 637In programming language modes, this is the same as TAB.
ff1fbe3e 638In some text modes, where TAB inserts a tab, this command indents to the
eed5698b 639column specified by the function `current-left-margin'."
2076c87c 640 (interactive "*")
5ff4ba3d 641 (delete-horizontal-space t)
46947372 642 (newline)
2076c87c
JB
643 (indent-according-to-mode))
644
645(defun reindent-then-newline-and-indent ()
646 "Reindent current line, insert newline, then indent the new line.
647Indentation of both lines is done according to the current major mode,
ff1fbe3e 648which means calling the current value of `indent-line-function'.
2076c87c
JB
649In programming language modes, this is the same as TAB.
650In some text modes, where TAB inserts a tab, this indents to the
eed5698b 651column specified by the function `current-left-margin'."
2076c87c 652 (interactive "*")
e1e04350
SM
653 (let ((pos (point)))
654 ;; Be careful to insert the newline before indenting the line.
655 ;; Otherwise, the indentation might be wrong.
656 (newline)
657 (save-excursion
658 (goto-char pos)
eb3d6c67
SM
659 ;; We are at EOL before the call to indent-according-to-mode, and
660 ;; after it we usually are as well, but not always. We tried to
661 ;; address it with `save-excursion' but that uses a normal marker
662 ;; whereas we need `move after insertion', so we do the save/restore
663 ;; by hand.
664 (setq pos (copy-marker pos t))
665 (indent-according-to-mode)
666 (goto-char pos)
667 ;; Remove the trailing white-space after indentation because
668 ;; indentation may introduce the whitespace.
6b61353c 669 (delete-horizontal-space t))
e1e04350 670 (indent-according-to-mode)))
eaae8106 671
93be67de
KH
672(defun quoted-insert (arg)
673 "Read next input character and insert it.
674This is useful for inserting control characters.
5626c14e 675With argument, insert ARG copies of the character.
2076c87c 676
93be67de
KH
677If the first character you type after this command is an octal digit,
678you should type a sequence of octal digits which specify a character code.
679Any nondigit terminates the sequence. If the terminator is a RET,
680it is discarded; any other terminator is used itself as input.
681The variable `read-quoted-char-radix' specifies the radix for this feature;
682set it to 10 or 16 to use decimal or hex instead of octal.
dff7d67f 683
93be67de
KH
684In overwrite mode, this function inserts the character anyway, and
685does not handle octal digits specially. This means that if you use
686overwrite as your normal editing mode, you can use this function to
687insert characters when necessary.
dff7d67f 688
93be67de
KH
689In binary overwrite mode, this function does overwrite, and octal
690digits are interpreted as a character code. This is intended to be
691useful for editing binary files."
692 (interactive "*p")
a6c39c14
EZ
693 (let* ((char
694 ;; Avoid "obsolete" warnings for translation-table-for-input.
695 (with-no-warnings
696 (let (translation-table-for-input input-method-function)
697 (if (or (not overwrite-mode)
698 (eq overwrite-mode 'overwrite-mode-binary))
699 (read-quoted-char)
700 (read-char))))))
0e3269e5
JL
701 ;; This used to assume character codes 0240 - 0377 stand for
702 ;; characters in some single-byte character set, and converted them
703 ;; to Emacs characters. But in 23.1 this feature is deprecated
704 ;; in favor of inserting the corresponding Unicode characters.
705 ;; (if (and enable-multibyte-characters
706 ;; (>= char ?\240)
707 ;; (<= char ?\377))
708 ;; (setq char (unibyte-char-to-multibyte char)))
93be67de
KH
709 (if (> arg 0)
710 (if (eq overwrite-mode 'overwrite-mode-binary)
711 (delete-char arg)))
712 (while (> arg 0)
713 (insert-and-inherit char)
714 (setq arg (1- arg)))))
eaae8106 715
6b61353c 716(defun forward-to-indentation (&optional arg)
93be67de 717 "Move forward ARG lines and position at first nonblank character."
109cfe4e 718 (interactive "^p")
6b61353c 719 (forward-line (or arg 1))
93be67de 720 (skip-chars-forward " \t"))
cc2b2b6c 721
6b61353c 722(defun backward-to-indentation (&optional arg)
93be67de 723 "Move backward ARG lines and position at first nonblank character."
109cfe4e 724 (interactive "^p")
6b61353c 725 (forward-line (- (or arg 1)))
93be67de 726 (skip-chars-forward " \t"))
2076c87c 727
93be67de
KH
728(defun back-to-indentation ()
729 "Move point to the first non-whitespace character on this line."
109cfe4e 730 (interactive "^")
93be67de 731 (beginning-of-line 1)
1e96c007 732 (skip-syntax-forward " " (line-end-position))
b9863466
RS
733 ;; Move back over chars that have whitespace syntax but have the p flag.
734 (backward-prefix-chars))
93be67de
KH
735
736(defun fixup-whitespace ()
737 "Fixup white space between objects around point.
738Leave one space or none, according to the context."
739 (interactive "*")
740 (save-excursion
741 (delete-horizontal-space)
742 (if (or (looking-at "^\\|\\s)")
743 (save-excursion (forward-char -1)
744 (looking-at "$\\|\\s(\\|\\s'")))
745 nil
f33321ad 746 (insert ?\s))))
93be67de 747
5ff4ba3d
MB
748(defun delete-horizontal-space (&optional backward-only)
749 "Delete all spaces and tabs around point.
1cfcd2db 750If BACKWARD-ONLY is non-nil, only delete them before point."
a168699d 751 (interactive "*P")
9ab59a1a
MB
752 (let ((orig-pos (point)))
753 (delete-region
754 (if backward-only
755 orig-pos
756 (progn
757 (skip-chars-forward " \t")
758 (constrain-to-field nil orig-pos t)))
5ff4ba3d 759 (progn
9ab59a1a
MB
760 (skip-chars-backward " \t")
761 (constrain-to-field nil orig-pos)))))
93be67de 762
68c16b59 763(defun just-one-space (&optional n)
88b5a757
DD
764 "Delete all spaces and tabs around point, leaving one space (or N spaces).
765If N is negative, deletes carriage return and linefeed characters as well."
56abefac 766 (interactive "*p")
11c31b99 767 (unless n (setq n 1))
88b5a757
DD
768 (let ((orig-pos (point))
769 (skip-characters (if (< n 0) " \t\n\r" " \t"))
770 (n (abs n)))
771 (skip-chars-backward skip-characters)
9ab59a1a 772 (constrain-to-field nil orig-pos)
68c16b59 773 (dotimes (i (or n 1))
f33321ad 774 (if (= (following-char) ?\s)
56abefac 775 (forward-char 1)
f33321ad 776 (insert ?\s)))
9ab59a1a
MB
777 (delete-region
778 (point)
779 (progn
88b5a757 780 (skip-chars-forward skip-characters)
9ab59a1a 781 (constrain-to-field nil orig-pos t)))))
2d88b556 782\f
2076c87c 783(defun beginning-of-buffer (&optional arg)
8d9f4291 784 "Move point to the beginning of the buffer.
a416e7ef 785With numeric arg N, put point N/10 of the way from the beginning.
8d9f4291
CY
786If the buffer is narrowed, this command uses the beginning of the
787accessible part of the buffer.
c66587fe 788
8d9f4291
CY
789If Transient Mark mode is disabled, leave mark at previous
790position, unless a \\[universal-argument] prefix is supplied.
ff1fbe3e
RS
791
792Don't use this command in Lisp programs!
8d9f4291 793\(goto-char (point-min)) is faster."
109cfe4e 794 (interactive "^P")
24199fe7 795 (or (consp arg)
d34c311a 796 (region-active-p)
705a5933 797 (push-mark))
c66587fe 798 (let ((size (- (point-max) (point-min))))
a416e7ef 799 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
800 (+ (point-min)
801 (if (> size 10000)
802 ;; Avoid overflow for large buffer sizes!
803 (* (prefix-numeric-value arg)
804 (/ size 10))
805 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
806 (point-min))))
d7e7ecd7 807 (if (and arg (not (consp arg))) (forward-line 1)))
2076c87c
JB
808
809(defun end-of-buffer (&optional arg)
8d9f4291 810 "Move point to the end of the buffer.
a416e7ef 811With numeric arg N, put point N/10 of the way from the end.
8d9f4291
CY
812If the buffer is narrowed, this command uses the end of the
813accessible part of the buffer.
c66587fe 814
8d9f4291
CY
815If Transient Mark mode is disabled, leave mark at previous
816position, unless a \\[universal-argument] prefix is supplied.
ff1fbe3e
RS
817
818Don't use this command in Lisp programs!
8d9f4291 819\(goto-char (point-max)) is faster."
109cfe4e 820 (interactive "^P")
d34c311a 821 (or (consp arg) (region-active-p) (push-mark))
c66587fe 822 (let ((size (- (point-max) (point-min))))
a416e7ef 823 (goto-char (if (and arg (not (consp arg)))
c66587fe
RS
824 (- (point-max)
825 (if (> size 10000)
826 ;; Avoid overflow for large buffer sizes!
827 (* (prefix-numeric-value arg)
828 (/ size 10))
829 (/ (* size (prefix-numeric-value arg)) 10)))
830 (point-max))))
3a801d0c
ER
831 ;; If we went to a place in the middle of the buffer,
832 ;; adjust it to the beginning of a line.
d7e7ecd7 833 (cond ((and arg (not (consp arg))) (forward-line 1))
919f2812 834 ((> (point) (window-end nil t))
314808dc
GM
835 ;; If the end of the buffer is not already on the screen,
836 ;; then scroll specially to put it near, but not at, the bottom.
837 (overlay-recenter (point))
838 (recenter -3))))
2076c87c 839
b9229673
CY
840(defcustom delete-active-region t
841 "Whether single-char deletion commands delete an active region.
842This has an effect only if Transient Mark mode is enabled, and
843affects `delete-forward-char' and `delete-backward-char', though
844not `delete-char'.
845
846If the value is the symbol `kill', the active region is killed
847instead of deleted."
848 :type '(choice (const :tag "Delete active region" t)
849 (const :tag "Kill active region" kill)
850 (const :tag "Do ordinary deletion" nil))
851 :group 'editing
852 :version "24.1")
853
854(defun delete-backward-char (n &optional killflag)
855 "Delete the previous N characters (following if N is negative).
856If Transient Mark mode is enabled, the mark is active, and N is 1,
857delete the text in the region and deactivate the mark instead.
858To disable this, set `delete-active-region' to nil.
859
860Optional second arg KILLFLAG, if non-nil, means to kill (save in
861kill ring) instead of delete. Interactively, N is the prefix
862arg, and KILLFLAG is set if N is explicitly specified.
863
864In Overwrite mode, single character backward deletion may replace
865tabs with spaces so as to back over columns, unless point is at
866the end of the line."
867 (interactive "p\nP")
868 (unless (integerp n)
869 (signal 'wrong-type-argument (list 'integerp n)))
870 (cond ((and (use-region-p)
871 delete-active-region
872 (= n 1))
873 ;; If a region is active, kill or delete it.
874 (if (eq delete-active-region 'kill)
875 (kill-region (region-beginning) (region-end))
876 (delete-region (region-beginning) (region-end))))
877 ;; In Overwrite mode, maybe untabify while deleting
878 ((null (or (null overwrite-mode)
879 (<= n 0)
880 (memq (char-before) '(?\t ?\n))
881 (eobp)
882 (eq (char-after) ?\n)))
883 (let* ((ocol (current-column))
884 (val (delete-char (- n) killflag)))
885 (save-excursion
886 (insert-char ?\s (- ocol (current-column)) nil))))
887 ;; Otherwise, do simple deletion.
888 (t (delete-char (- n) killflag))))
889
890(defun delete-forward-char (n &optional killflag)
4c5130d6 891 "Delete the following N characters (previous if N is negative).
b9229673
CY
892If Transient Mark mode is enabled, the mark is active, and N is 1,
893delete the text in the region and deactivate the mark instead.
894To disable this, set `delete-active-region' to nil.
895
896Optional second arg KILLFLAG non-nil means to kill (save in kill
897ring) instead of delete. Interactively, N is the prefix arg, and
898KILLFLAG is set if N was explicitly specified."
899 (interactive "p\nP")
900 (unless (integerp n)
901 (signal 'wrong-type-argument (list 'integerp n)))
902 (cond ((and (use-region-p)
903 delete-active-region
904 (= n 1))
905 ;; If a region is active, kill or delete it.
906 (if (eq delete-active-region 'kill)
907 (kill-region (region-beginning) (region-end))
908 (delete-region (region-beginning) (region-end))))
909 ;; Otherwise, do simple deletion.
910 (t (delete-char n killflag))))
911
2076c87c 912(defun mark-whole-buffer ()
70e14c01
JB
913 "Put point at beginning and mark at end of buffer.
914You probably should not use this function in Lisp programs;
915it is usually a mistake for a Lisp function to use any subroutine
916that uses or sets the mark."
2076c87c
JB
917 (interactive)
918 (push-mark (point))
fd0f4056 919 (push-mark (point-max) nil t)
2076c87c 920 (goto-char (point-min)))
2d88b556 921\f
eaae8106 922
93be67de
KH
923;; Counting lines, one way or another.
924
9af967bd
LK
925(defun goto-line (line &optional buffer)
926 "Goto LINE, counting from line 1 at beginning of buffer.
927Normally, move point in the current buffer, and leave mark at the
928previous position. With just \\[universal-argument] as argument,
a5785534 929move point in the most recently selected other buffer, and switch to it.
9af967bd 930
a5785534
SM
931If there's a number in the buffer at point, it is the default for LINE.
932
933This function is usually the wrong thing to use in a Lisp program.
934What you probably want instead is something like:
935 (goto-char (point-min)) (forward-line (1- N))
936If at all possible, an even better solution is to use char counts
937rather than line counts."
00a369ac
RS
938 (interactive
939 (if (and current-prefix-arg (not (consp current-prefix-arg)))
940 (list (prefix-numeric-value current-prefix-arg))
941 ;; Look for a default, a number in the buffer at point.
942 (let* ((default
943 (save-excursion
944 (skip-chars-backward "0-9")
945 (if (looking-at "[0-9]")
946 (buffer-substring-no-properties
947 (point)
948 (progn (skip-chars-forward "0-9")
949 (point))))))
950 ;; Decide if we're switching buffers.
951 (buffer
952 (if (consp current-prefix-arg)
953 (other-buffer (current-buffer) t)))
954 (buffer-prompt
955 (if buffer
956 (concat " in " (buffer-name buffer))
957 "")))
958 ;; Read the argument, offering that number (if any) as default.
959 (list (read-from-minibuffer (format (if default "Goto line%s (%s): "
960 "Goto line%s: ")
961 buffer-prompt
962 default)
963 nil nil t
964 'minibuffer-history
965 default)
966 buffer))))
967 ;; Switch to the desired buffer, one way or another.
968 (if buffer
969 (let ((window (get-buffer-window buffer)))
970 (if window (select-window window)
971 (switch-to-buffer-other-window buffer))))
f564644b 972 ;; Leave mark at previous position
d34c311a 973 (or (region-active-p) (push-mark))
00a369ac 974 ;; Move to the specified line number in that buffer.
93be67de
KH
975 (save-restriction
976 (widen)
a5785534 977 (goto-char (point-min))
93be67de 978 (if (eq selective-display t)
9af967bd
LK
979 (re-search-forward "[\n\C-m]" nil 'end (1- line))
980 (forward-line (1- line)))))
2076c87c 981
8da5345f
HN
982(defun count-words-region (start end)
983 "Print the number of words in the region.
984When called interactively, the word count is printed in echo area."
985 (interactive "r")
986 (let ((count 0))
987 (save-excursion
988 (save-restriction
989 (narrow-to-region start end)
990 (goto-char (point-min))
991 (while (forward-word 1)
992 (setq count (1+ count)))))
993 (if (interactive-p)
994 (message "Region has %d words" count))
995 count))
996
2076c87c 997(defun count-lines-region (start end)
eb8c3be9 998 "Print number of lines and characters in the region."
2076c87c
JB
999 (interactive "r")
1000 (message "Region has %d lines, %d characters"
1001 (count-lines start end) (- end start)))
1002
1003(defun what-line ()
2578be76 1004 "Print the current buffer line number and narrowed line number of point."
2076c87c 1005 (interactive)
c6db81aa 1006 (let ((start (point-min))
6b61353c
KH
1007 (n (line-number-at-pos)))
1008 (if (= start 1)
1009 (message "Line %d" n)
1010 (save-excursion
1011 (save-restriction
1012 (widen)
1013 (message "line %d (narrowed line %d)"
1014 (+ n (line-number-at-pos start) -1) n))))))
2578be76 1015
2076c87c
JB
1016(defun count-lines (start end)
1017 "Return number of lines between START and END.
1018This is usually the number of newlines between them,
ff1fbe3e 1019but can be one more if START is not equal to END
2076c87c 1020and the greater of them is not at the start of a line."
e406700d
RS
1021 (save-excursion
1022 (save-restriction
1023 (narrow-to-region start end)
1024 (goto-char (point-min))
1025 (if (eq selective-display t)
1026 (save-match-data
dde92ca6
RS
1027 (let ((done 0))
1028 (while (re-search-forward "[\n\C-m]" nil t 40)
1029 (setq done (+ 40 done)))
1030 (while (re-search-forward "[\n\C-m]" nil t 1)
1031 (setq done (+ 1 done)))
043efc41
RS
1032 (goto-char (point-max))
1033 (if (and (/= start end)
1034 (not (bolp)))
1035 (1+ done)
e406700d
RS
1036 done)))
1037 (- (buffer-size) (forward-line (buffer-size)))))))
eaae8106 1038
6b61353c
KH
1039(defun line-number-at-pos (&optional pos)
1040 "Return (narrowed) buffer line number at position POS.
79ffb765
RS
1041If POS is nil, use current buffer location.
1042Counting starts at (point-min), so the value refers
1043to the contents of the accessible portion of the buffer."
6b61353c
KH
1044 (let ((opoint (or pos (point))) start)
1045 (save-excursion
1046 (goto-char (point-min))
1047 (setq start (point))
1048 (goto-char opoint)
1049 (forward-line 0)
1050 (1+ (count-lines start (point))))))
1051
d5d99b80
KH
1052(defun what-cursor-position (&optional detail)
1053 "Print info on cursor position (on screen and within buffer).
e38dff0c 1054Also describe the character after point, and give its character code
c6fcc518
KH
1055in octal, decimal and hex.
1056
1057For a non-ASCII multibyte character, also give its encoding in the
1058buffer's selected coding system if the coding system encodes the
1059character safely. If the character is encoded into one byte, that
1060code is shown in hex. If the character is encoded into more than one
1061byte, just \"...\" is shown.
e5a902cf 1062
24dad5d5 1063In addition, with prefix argument, show details about that character
0b69eec5 1064in *Help* buffer. See also the command `describe-char'."
d5d99b80 1065 (interactive "P")
2076c87c
JB
1066 (let* ((char (following-char))
1067 (beg (point-min))
1068 (end (point-max))
1069 (pos (point))
1070 (total (buffer-size))
1071 (percent (if (> total 50000)
1072 ;; Avoid overflow from multiplying by 100!
1073 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
1074 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
1075 (hscroll (if (= (window-hscroll) 0)
1076 ""
1077 (format " Hscroll=%d" (window-hscroll))))
1078 (col (current-column)))
1079 (if (= pos end)
1080 (if (or (/= beg 1) (/= end (1+ total)))
a17a79c0 1081 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
2076c87c 1082 pos total percent beg end col hscroll)
a17a79c0 1083 (message "point=%d of %d (EOB) column=%d%s"
63219d53 1084 pos total col hscroll))
c6fcc518 1085 (let ((coding buffer-file-coding-system)
a41b50ca 1086 encoded encoding-msg display-prop under-display)
c6fcc518
KH
1087 (if (or (not coding)
1088 (eq (coding-system-type coding) t))
b56a5ae0 1089 (setq coding (default-value 'buffer-file-coding-system)))
8f924df7 1090 (if (eq (char-charset char) 'eight-bit)
28fd4883 1091 (setq encoding-msg
41882805 1092 (format "(%d, #o%o, #x%x, raw-byte)" char char char))
a41b50ca
KH
1093 ;; Check if the character is displayed with some `display'
1094 ;; text property. In that case, set under-display to the
1095 ;; buffer substring covered by that property.
1096 (setq display-prop (get-text-property pos 'display))
1097 (if display-prop
1098 (let ((to (or (next-single-property-change pos 'display)
1099 (point-max))))
1100 (if (< to (+ pos 4))
1101 (setq under-display "")
1102 (setq under-display "..."
1103 to (+ pos 4)))
1104 (setq under-display
1105 (concat (buffer-substring-no-properties pos to)
1106 under-display)))
1107 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
28fd4883 1108 (setq encoding-msg
a41b50ca
KH
1109 (if display-prop
1110 (if (not (stringp display-prop))
a17a79c0 1111 (format "(%d, #o%o, #x%x, part of display \"%s\")"
a41b50ca 1112 char char char under-display)
a17a79c0 1113 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
a41b50ca
KH
1114 char char char under-display display-prop))
1115 (if encoded
a17a79c0 1116 (format "(%d, #o%o, #x%x, file %s)"
a41b50ca
KH
1117 char char char
1118 (if (> (length encoded) 1)
1119 "..."
1120 (encoded-string-description encoded coding)))
a17a79c0 1121 (format "(%d, #o%o, #x%x)" char char char)))))
e5e89e48 1122 (if detail
24dad5d5 1123 ;; We show the detailed information about CHAR.
0b69eec5 1124 (describe-char (point)))
24dad5d5 1125 (if (or (/= beg 1) (/= end (1+ total)))
a17a79c0 1126 (message "Char: %s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
e5a902cf
KH
1127 (if (< char 256)
1128 (single-key-description char)
f0d16a7f 1129 (buffer-substring-no-properties (point) (1+ (point))))
24dad5d5 1130 encoding-msg pos total percent beg end col hscroll)
a17a79c0 1131 (message "Char: %s %s point=%d of %d (%d%%) column=%d%s"
a41b50ca
KH
1132 (if enable-multibyte-characters
1133 (if (< char 128)
1134 (single-key-description char)
1135 (buffer-substring-no-properties (point) (1+ (point))))
1136 (single-key-description char))
24dad5d5 1137 encoding-msg pos total percent col hscroll))))))
2d88b556 1138\f
71a05b36
RS
1139;; Initialize read-expression-map. It is defined at C level.
1140(let ((m (make-sparse-keymap)))
1141 (define-key m "\M-\t" 'lisp-complete-symbol)
1142 (set-keymap-parent m minibuffer-local-map)
1143 (setq read-expression-map m))
854c16c5 1144
8570b0ca
RM
1145(defvar read-expression-history nil)
1146
ad6aa5ed
CY
1147(defvar minibuffer-completing-symbol nil
1148 "Non-nil means completing a Lisp symbol in the minibuffer.")
1149
d658acb6
CY
1150(defvar minibuffer-default nil
1151 "The current default value or list of default values in the minibuffer.
1152The functions `read-from-minibuffer' and `completing-read' bind
1153this variable locally.")
1154
b49df39d 1155(defcustom eval-expression-print-level 4
2f7e1f5a 1156 "Value for `print-level' while printing value in `eval-expression'.
d26b26dc 1157A value of nil means no limit."
b49df39d 1158 :group 'lisp
058d4999 1159 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
1160 :version "21.1")
1161
1162(defcustom eval-expression-print-length 12
2f7e1f5a 1163 "Value for `print-length' while printing value in `eval-expression'.
d26b26dc 1164A value of nil means no limit."
b49df39d 1165 :group 'lisp
058d4999 1166 :type '(choice (const :tag "No Limit" nil) integer)
b49df39d
RS
1167 :version "21.1")
1168
1169(defcustom eval-expression-debug-on-error t
2f7e1f5a 1170 "If non-nil set `debug-on-error' to t in `eval-expression'.
ed8bcabe 1171If nil, don't change the value of `debug-on-error'."
b49df39d
RS
1172 :group 'lisp
1173 :type 'boolean
1174 :version "21.1")
1175
fa219ebd
JL
1176(defun eval-expression-print-format (value)
1177 "Format VALUE as a result of evaluated expression.
1178Return a formatted string which is displayed in the echo area
1179in addition to the value printed by prin1 in functions which
1180display the result of expression evaluation."
1181 (if (and (integerp value)
c9f0110e 1182 (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd 1183 (eq this-command last-command)
56abefac 1184 (if (boundp 'edebug-active) edebug-active)))
fa219ebd 1185 (let ((char-string
9bb25ed3 1186 (if (or (if (boundp 'edebug-active) edebug-active)
3137dda8 1187 (memq this-command '(eval-last-sexp eval-print-last-sexp)))
fa219ebd
JL
1188 (prin1-char value))))
1189 (if char-string
1b5fd09e
SM
1190 (format " (#o%o, #x%x, %s)" value value char-string)
1191 (format " (#o%o, #x%x)" value value)))))
fa219ebd 1192
8570b0ca 1193;; We define this, rather than making `eval' interactive,
ac052b48 1194;; for the sake of completion of names like eval-region, eval-buffer.
ecb7ad00
RS
1195(defun eval-expression (eval-expression-arg
1196 &optional eval-expression-insert-value)
a6a1ee53
EZ
1197 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1198Value is also consed on to front of the variable `values'.
a7a8618b
EZ
1199Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1200with prefix argument) means insert the result into the current buffer
1201instead of printing it in the echo area. Truncates long output
1202according to the value of the variables `eval-expression-print-length'
1203and `eval-expression-print-level'.
b4f73994
RS
1204
1205If `eval-expression-debug-on-error' is non-nil, which is the default,
1206this command arranges for all errors to enter the debugger."
adca5fa6 1207 (interactive
ad6aa5ed
CY
1208 (list (let ((minibuffer-completing-symbol t))
1209 (read-from-minibuffer "Eval: "
1210 nil read-expression-map t
1211 'read-expression-history))
ecb7ad00 1212 current-prefix-arg))
eaae8106 1213
ed8bcabe
GM
1214 (if (null eval-expression-debug-on-error)
1215 (setq values (cons (eval eval-expression-arg) values))
1216 (let ((old-value (make-symbol "t")) new-value)
1217 ;; Bind debug-on-error to something unique so that we can
1218 ;; detect when evaled code changes it.
1219 (let ((debug-on-error old-value))
1220 (setq values (cons (eval eval-expression-arg) values))
1221 (setq new-value debug-on-error))
1222 ;; If evaled code has changed the value of debug-on-error,
1223 ;; propagate that change to the global binding.
1224 (unless (eq old-value new-value)
1225 (setq debug-on-error new-value))))
eaae8106 1226
b49df39d
RS
1227 (let ((print-length eval-expression-print-length)
1228 (print-level eval-expression-print-level))
6b61353c
KH
1229 (if eval-expression-insert-value
1230 (with-no-warnings
1231 (let ((standard-output (current-buffer)))
22e088c6 1232 (prin1 (car values))))
fa219ebd
JL
1233 (prog1
1234 (prin1 (car values) t)
1235 (let ((str (eval-expression-print-format (car values))))
1236 (if str (princ str t)))))))
2076c87c
JB
1237
1238(defun edit-and-eval-command (prompt command)
1239 "Prompting with PROMPT, let user edit COMMAND and eval result.
1240COMMAND is a Lisp expression. Let user edit that expression in
1241the minibuffer, then read and evaluate the result."
9f4b6084 1242 (let ((command
6b61353c
KH
1243 (let ((print-level nil)
1244 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1245 (unwind-protect
1246 (read-from-minibuffer prompt
1247 (prin1-to-string command)
1248 read-expression-map t
1249 'command-history)
1250 ;; If command was added to command-history as a string,
1251 ;; get rid of that. We want only evaluable expressions there.
1252 (if (stringp (car command-history))
1253 (setq command-history (cdr command-history)))))))
5d6c83ae
KH
1254
1255 ;; If command to be redone does not match front of history,
1256 ;; add it to the history.
1257 (or (equal command (car command-history))
1258 (setq command-history (cons command command-history)))
2076c87c
JB
1259 (eval command)))
1260
ebb61177 1261(defun repeat-complex-command (arg)
2076c87c
JB
1262 "Edit and re-evaluate last complex command, or ARGth from last.
1263A complex command is one which used the minibuffer.
1264The command is placed in the minibuffer as a Lisp form for editing.
1265The result is executed, repeating the command as changed.
5626c14e
JB
1266If the command has been changed or is not the most recent previous
1267command it is added to the front of the command history.
1268You can use the minibuffer history commands \
1269\\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
eb6e9899 1270to get different commands to edit and resubmit."
2076c87c 1271 (interactive "p")
ba343182 1272 (let ((elt (nth (1- arg) command-history))
2076c87c
JB
1273 newcmd)
1274 (if elt
854c16c5 1275 (progn
eab22e27 1276 (setq newcmd
74ae5fab
RS
1277 (let ((print-level nil)
1278 (minibuffer-history-position arg)
99ea24de 1279 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
9f4b6084
MR
1280 (unwind-protect
1281 (read-from-minibuffer
1282 "Redo: " (prin1-to-string elt) read-expression-map t
1283 (cons 'command-history arg))
1284
1285 ;; If command was added to command-history as a
1286 ;; string, get rid of that. We want only
1287 ;; evaluable expressions there.
1288 (if (stringp (car command-history))
1289 (setq command-history (cdr command-history))))))
db16f109
RS
1290
1291 ;; If command to be redone does not match front of history,
1292 ;; add it to the history.
1293 (or (equal newcmd (car command-history))
1294 (setq command-history (cons newcmd command-history)))
2076c87c 1295 (eval newcmd))
536b728a
RS
1296 (if command-history
1297 (error "Argument %d is beyond length of command history" arg)
1298 (error "There are no previous complex commands to repeat")))))
7133b7ee
JL
1299
1300(defun read-extended-command ()
1301 "Read command name to invoke in `execute-extended-command'."
1302 (minibuffer-with-setup-hook
1303 (lambda ()
1304 (set (make-local-variable 'minibuffer-default-add-function)
1305 (lambda ()
1306 ;; Get a command name at point in the original buffer
1307 ;; to propose it after M-n.
1308 (with-current-buffer (window-buffer (minibuffer-selected-window))
1309 (and (commandp (function-called-at-point))
1310 (format "%S" (function-called-at-point)))))))
1311 ;; Read a string, completing from and restricting to the set of
1312 ;; all defined commands. Don't provide any initial input.
1313 ;; Save the command read on the extended-command history list.
1314 (completing-read
1315 (concat (cond
1316 ((eq current-prefix-arg '-) "- ")
1317 ((and (consp current-prefix-arg)
1318 (eq (car current-prefix-arg) 4)) "C-u ")
1319 ((and (consp current-prefix-arg)
1320 (integerp (car current-prefix-arg)))
1321 (format "%d " (car current-prefix-arg)))
1322 ((integerp current-prefix-arg)
1323 (format "%d " current-prefix-arg)))
1324 ;; This isn't strictly correct if `execute-extended-command'
1325 ;; is bound to anything else (e.g. [menu]).
1326 ;; It could use (key-description (this-single-command-keys)),
1327 ;; but actually a prompt other than "M-x" would be confusing,
1328 ;; because "M-x" is a well-known prompt to read a command
1329 ;; and it serves as a shorthand for "Extended command: ".
1330 "M-x ")
1331 obarray 'commandp t nil 'extended-command-history)))
1332
2d88b556 1333\f
854c16c5
RS
1334(defvar minibuffer-history nil
1335 "Default minibuffer history list.
1336This is used for all minibuffer input
e5f0c02f
EZ
1337except when an alternate history list is specified.
1338
1339Maximum length of the history list is determined by the value
1340of `history-length', which see.")
854c16c5 1341(defvar minibuffer-history-sexp-flag nil
6b61353c
KH
1342 "Control whether history list elements are expressions or strings.
1343If the value of this variable equals current minibuffer depth,
1344they are expressions; otherwise they are strings.
7979163c 1345\(That convention is designed to do the right thing for
6b61353c 1346recursive uses of the minibuffer.)")
e91f80c4 1347(setq minibuffer-history-variable 'minibuffer-history)
535c8bdb 1348(setq minibuffer-history-position nil) ;; Defvar is in C code.
854c16c5 1349(defvar minibuffer-history-search-history nil)
e91f80c4 1350
93cee14b
RS
1351(defvar minibuffer-text-before-history nil
1352 "Text that was in this minibuffer before any history commands.
1353This is nil if there have not yet been any history commands
1354in this use of the minibuffer.")
1355
1356(add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1357
1358(defun minibuffer-history-initialize ()
1359 (setq minibuffer-text-before-history nil))
1360
6e7d0ff7
MB
1361(defun minibuffer-avoid-prompt (new old)
1362 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1363 (constrain-to-field nil (point-max)))
1364
6e30a99a 1365(defcustom minibuffer-history-case-insensitive-variables nil
1d2b0303 1366 "Minibuffer history variables for which matching should ignore case.
6e30a99a
RS
1367If a history variable is a member of this list, then the
1368\\[previous-matching-history-element] and \\[next-matching-history-element]\
1369 commands ignore case when searching it, regardless of `case-fold-search'."
1370 :type '(repeat variable)
1371 :group 'minibuffer)
1372
e91f80c4 1373(defun previous-matching-history-element (regexp n)
854c16c5
RS
1374 "Find the previous history element that matches REGEXP.
1375\(Previous history elements refer to earlier actions.)
1376With prefix argument N, search for Nth previous match.
5c2010f0 1377If N is negative, find the next or Nth next match.
9889af08
EZ
1378Normally, history elements are matched case-insensitively if
1379`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1380makes the search case-sensitive.
6e30a99a 1381See also `minibuffer-history-case-insensitive-variables'."
854c16c5 1382 (interactive
c1172a19 1383 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1384 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1385 nil
1386 minibuffer-local-map
1387 nil
5794c45d
RS
1388 'minibuffer-history-search-history
1389 (car minibuffer-history-search-history))))
c1172a19
RS
1390 ;; Use the last regexp specified, by default, if input is empty.
1391 (list (if (string= regexp "")
a8e96cea
KH
1392 (if minibuffer-history-search-history
1393 (car minibuffer-history-search-history)
1394 (error "No previous history search regexp"))
c1172a19 1395 regexp)
854c16c5 1396 (prefix-numeric-value current-prefix-arg))))
e276a14a
MB
1397 (unless (zerop n)
1398 (if (and (zerop minibuffer-history-position)
1399 (null minibuffer-text-before-history))
efaac2e6 1400 (setq minibuffer-text-before-history
6d74d713 1401 (minibuffer-contents-no-properties)))
e276a14a
MB
1402 (let ((history (symbol-value minibuffer-history-variable))
1403 (case-fold-search
1404 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1405 ;; On some systems, ignore case for file names.
1406 (if (memq minibuffer-history-variable
1407 minibuffer-history-case-insensitive-variables)
1408 t
1409 ;; Respect the user's setting for case-fold-search:
1410 case-fold-search)
1411 nil))
1412 prevpos
1413 match-string
1414 match-offset
1415 (pos minibuffer-history-position))
1416 (while (/= n 0)
1417 (setq prevpos pos)
1418 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1419 (when (= pos prevpos)
e91f80c4 1420 (error (if (= pos 1)
ccc58657
RS
1421 "No later matching history item"
1422 "No earlier matching history item")))
e276a14a
MB
1423 (setq match-string
1424 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
7908d27c 1425 (let ((print-level nil))
e276a14a
MB
1426 (prin1-to-string (nth (1- pos) history)))
1427 (nth (1- pos) history)))
1428 (setq match-offset
1429 (if (< n 0)
1430 (and (string-match regexp match-string)
1431 (match-end 0))
1432 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1433 (match-beginning 1))))
1434 (when match-offset
1435 (setq n (+ n (if (< n 0) 1 -1)))))
1436 (setq minibuffer-history-position pos)
1437 (goto-char (point-max))
efaac2e6 1438 (delete-minibuffer-contents)
e276a14a 1439 (insert match-string)
6d74d713 1440 (goto-char (+ (minibuffer-prompt-end) match-offset))))
e1e04350
SM
1441 (if (memq (car (car command-history)) '(previous-matching-history-element
1442 next-matching-history-element))
854c16c5 1443 (setq command-history (cdr command-history))))
e91f80c4 1444
e91f80c4 1445(defun next-matching-history-element (regexp n)
854c16c5
RS
1446 "Find the next history element that matches REGEXP.
1447\(The next history element refers to a more recent action.)
1448With prefix argument N, search for Nth next match.
5c2010f0 1449If N is negative, find the previous or Nth previous match.
9889af08
EZ
1450Normally, history elements are matched case-insensitively if
1451`case-fold-search' is non-nil, but an uppercase letter in REGEXP
1452makes the search case-sensitive."
854c16c5 1453 (interactive
c1172a19 1454 (let* ((enable-recursive-minibuffers t)
c1172a19
RS
1455 (regexp (read-from-minibuffer "Next element matching (regexp): "
1456 nil
1457 minibuffer-local-map
1458 nil
e967cd11
RS
1459 'minibuffer-history-search-history
1460 (car minibuffer-history-search-history))))
c1172a19
RS
1461 ;; Use the last regexp specified, by default, if input is empty.
1462 (list (if (string= regexp "")
e967cd11
RS
1463 (if minibuffer-history-search-history
1464 (car minibuffer-history-search-history)
1465 (error "No previous history search regexp"))
c1172a19 1466 regexp)
854c16c5 1467 (prefix-numeric-value current-prefix-arg))))
e91f80c4 1468 (previous-matching-history-element regexp (- n)))
2076c87c 1469
8dc3ba7d
MB
1470(defvar minibuffer-temporary-goal-position nil)
1471
7f914bbe 1472(defvar minibuffer-default-add-function 'minibuffer-default-add-completions
0eb5f40f
JL
1473 "Function run by `goto-history-element' before consuming default values.
1474This is useful to dynamically add more elements to the list of default values
7f914bbe
JL
1475when `goto-history-element' reaches the end of this list.
1476Before calling this function `goto-history-element' sets the variable
1477`minibuffer-default-add-done' to t, so it will call this function only
1478once. In special cases, when this function needs to be called more
1479than once, it can set `minibuffer-default-add-done' to nil explicitly,
1480overriding the setting of this variable to t in `goto-history-element'.")
1481
1482(defvar minibuffer-default-add-done nil
1483 "When nil, add more elements to the end of the list of default values.
1484The value nil causes `goto-history-element' to add more elements to
1485the list of defaults when it reaches the end of this list. It does
1486this by calling a function defined by `minibuffer-default-add-function'.")
1487
1488(make-variable-buffer-local 'minibuffer-default-add-done)
1489
1490(defun minibuffer-default-add-completions ()
1491 "Return a list of all completions without the default value.
1492This function is used to add all elements of the completion table to
1493the end of the list of defaults just after the default value."
7f914bbe
JL
1494 (let ((def minibuffer-default)
1495 (all (all-completions ""
1496 minibuffer-completion-table
e96d62cd 1497 minibuffer-completion-predicate)))
7f914bbe
JL
1498 (if (listp def)
1499 (append def all)
1500 (cons def (delete def all)))))
1501
297b8ccd
JL
1502(defun goto-history-element (nabs)
1503 "Puts element of the minibuffer history in the minibuffer.
1504The argument NABS specifies the absolute history position."
1505 (interactive "p")
7f914bbe
JL
1506 (when (and (not minibuffer-default-add-done)
1507 (functionp minibuffer-default-add-function)
1508 (< nabs (- (if (listp minibuffer-default)
1509 (length minibuffer-default)
1510 1))))
1511 (setq minibuffer-default-add-done t
1512 minibuffer-default (funcall minibuffer-default-add-function)))
b38fc7f1
JL
1513 (let ((minimum (if minibuffer-default
1514 (- (if (listp minibuffer-default)
1515 (length minibuffer-default)
1516 1))
1517 0))
297b8ccd
JL
1518 elt minibuffer-returned-to-present)
1519 (if (and (zerop minibuffer-history-position)
1520 (null minibuffer-text-before-history))
1521 (setq minibuffer-text-before-history
1522 (minibuffer-contents-no-properties)))
1523 (if (< nabs minimum)
1524 (if minibuffer-default
7f914bbe 1525 (error "End of defaults; no next item")
297b8ccd
JL
1526 (error "End of history; no default available")))
1527 (if (> nabs (length (symbol-value minibuffer-history-variable)))
1528 (error "Beginning of history; no preceding item"))
1529 (unless (memq last-command '(next-history-element
1530 previous-history-element))
1531 (let ((prompt-end (minibuffer-prompt-end)))
1532 (set (make-local-variable 'minibuffer-temporary-goal-position)
1533 (cond ((<= (point) prompt-end) prompt-end)
1534 ((eobp) nil)
1535 (t (point))))))
1536 (goto-char (point-max))
1537 (delete-minibuffer-contents)
1538 (setq minibuffer-history-position nabs)
b38fc7f1
JL
1539 (cond ((< nabs 0)
1540 (setq elt (if (listp minibuffer-default)
1541 (nth (1- (abs nabs)) minibuffer-default)
1542 minibuffer-default)))
297b8ccd
JL
1543 ((= nabs 0)
1544 (setq elt (or minibuffer-text-before-history ""))
1545 (setq minibuffer-returned-to-present t)
1546 (setq minibuffer-text-before-history nil))
1547 (t (setq elt (nth (1- minibuffer-history-position)
1548 (symbol-value minibuffer-history-variable)))))
1549 (insert
1550 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1551 (not minibuffer-returned-to-present))
1552 (let ((print-level nil))
1553 (prin1-to-string elt))
1554 elt))
1555 (goto-char (or minibuffer-temporary-goal-position (point-max)))))
1556
ebb61177 1557(defun next-history-element (n)
1459a43b
RS
1558 "Puts next element of the minibuffer history in the minibuffer.
1559With argument N, it uses the Nth following element."
2076c87c 1560 (interactive "p")
0818b15e 1561 (or (zerop n)
297b8ccd 1562 (goto-history-element (- minibuffer-history-position n))))
2076c87c 1563
ebb61177 1564(defun previous-history-element (n)
1459a43b
RS
1565 "Puts previous element of the minibuffer history in the minibuffer.
1566With argument N, it uses the Nth previous element."
2076c87c 1567 (interactive "p")
297b8ccd
JL
1568 (or (zerop n)
1569 (goto-history-element (+ minibuffer-history-position n))))
d0678801
RM
1570
1571(defun next-complete-history-element (n)
a4d1159b
GM
1572 "Get next history element which completes the minibuffer before the point.
1573The contents of the minibuffer after the point are deleted, and replaced
1574by the new completion."
d0678801 1575 (interactive "p")
b5e6f936
RM
1576 (let ((point-at-start (point)))
1577 (next-matching-history-element
a4d1159b 1578 (concat
efaac2e6 1579 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
a4d1159b 1580 n)
b5e6f936
RM
1581 ;; next-matching-history-element always puts us at (point-min).
1582 ;; Move to the position we were at before changing the buffer contents.
1583 ;; This is still sensical, because the text before point has not changed.
1584 (goto-char point-at-start)))
d0678801
RM
1585
1586(defun previous-complete-history-element (n)
1f6fcec3 1587 "\
a4d1159b
GM
1588Get previous history element which completes the minibuffer before the point.
1589The contents of the minibuffer after the point are deleted, and replaced
1590by the new completion."
d0678801
RM
1591 (interactive "p")
1592 (next-complete-history-element (- n)))
a4d1159b 1593
efaac2e6 1594;; For compatibility with the old subr of the same name.
a4d1159b
GM
1595(defun minibuffer-prompt-width ()
1596 "Return the display width of the minibuffer prompt.
f33321ad 1597Return 0 if current buffer is not a minibuffer."
a4d1159b
GM
1598 ;; Return the width of everything before the field at the end of
1599 ;; the buffer; this should be 0 for normal buffers.
efaac2e6 1600 (1- (minibuffer-prompt-end)))
2d88b556 1601\f
297b8ccd
JL
1602;; isearch minibuffer history
1603(add-hook 'minibuffer-setup-hook 'minibuffer-history-isearch-setup)
1604
1605(defvar minibuffer-history-isearch-message-overlay)
1606(make-variable-buffer-local 'minibuffer-history-isearch-message-overlay)
1607
1608(defun minibuffer-history-isearch-setup ()
1609 "Set up a minibuffer for using isearch to search the minibuffer history.
1610Intended to be added to `minibuffer-setup-hook'."
1611 (set (make-local-variable 'isearch-search-fun-function)
1612 'minibuffer-history-isearch-search)
1613 (set (make-local-variable 'isearch-message-function)
1614 'minibuffer-history-isearch-message)
1615 (set (make-local-variable 'isearch-wrap-function)
1616 'minibuffer-history-isearch-wrap)
1617 (set (make-local-variable 'isearch-push-state-function)
1618 'minibuffer-history-isearch-push-state)
1619 (add-hook 'isearch-mode-end-hook 'minibuffer-history-isearch-end nil t))
1620
1621(defun minibuffer-history-isearch-end ()
1622 "Clean up the minibuffer after terminating isearch in the minibuffer."
1623 (if minibuffer-history-isearch-message-overlay
1624 (delete-overlay minibuffer-history-isearch-message-overlay)))
1625
1626(defun minibuffer-history-isearch-search ()
1627 "Return the proper search function, for isearch in minibuffer history."
1628 (cond
1629 (isearch-word
1630 (if isearch-forward 'word-search-forward 'word-search-backward))
1631 (t
1632 (lambda (string bound noerror)
1633 (let ((search-fun
1634 ;; Use standard functions to search within minibuffer text
1635 (cond
1636 (isearch-regexp
1637 (if isearch-forward 're-search-forward 're-search-backward))
1638 (t
1639 (if isearch-forward 'search-forward 'search-backward))))
1640 found)
1641 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1642 ;; searching forward. Lazy-highlight calls this lambda with the
1643 ;; bound arg, so skip the minibuffer prompt.
1644 (if (and bound isearch-forward (< (point) (minibuffer-prompt-end)))
1645 (goto-char (minibuffer-prompt-end)))
1646 (or
1647 ;; 1. First try searching in the initial minibuffer text
1648 (funcall search-fun string
1649 (if isearch-forward bound (minibuffer-prompt-end))
1650 noerror)
1651 ;; 2. If the above search fails, start putting next/prev history
1652 ;; elements in the minibuffer successively, and search the string
1653 ;; in them. Do this only when bound is nil (i.e. not while
1654 ;; lazy-highlighting search strings in the current minibuffer text).
1655 (unless bound
1656 (condition-case nil
1657 (progn
1658 (while (not found)
1659 (cond (isearch-forward
1660 (next-history-element 1)
1661 (goto-char (minibuffer-prompt-end)))
1662 (t
1663 (previous-history-element 1)
1664 (goto-char (point-max))))
1665 (setq isearch-barrier (point) isearch-opoint (point))
1666 ;; After putting the next/prev history element, search
1667 ;; the string in them again, until next-history-element
1668 ;; or previous-history-element raises an error at the
1669 ;; beginning/end of history.
1670 (setq found (funcall search-fun string
1671 (unless isearch-forward
1672 ;; For backward search, don't search
1673 ;; in the minibuffer prompt
1674 (minibuffer-prompt-end))
1675 noerror)))
1676 ;; Return point of the new search result
1677 (point))
1678 ;; Return nil when next(prev)-history-element fails
1679 (error nil)))))))))
1680
1681(defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis)
1682 "Display the minibuffer history search prompt.
1683If there are no search errors, this function displays an overlay with
1684the isearch prompt which replaces the original minibuffer prompt.
1685Otherwise, it displays the standard isearch message returned from
1686`isearch-message'."
1687 (if (not (and (minibufferp) isearch-success (not isearch-error)))
1688 ;; Use standard function `isearch-message' when not in the minibuffer,
1689 ;; or search fails, or has an error (like incomplete regexp).
1690 ;; This function overwrites minibuffer text with isearch message,
1691 ;; so it's possible to see what is wrong in the search string.
1692 (isearch-message c-q-hack ellipsis)
1693 ;; Otherwise, put the overlay with the standard isearch prompt over
1694 ;; the initial minibuffer prompt.
1695 (if (overlayp minibuffer-history-isearch-message-overlay)
1696 (move-overlay minibuffer-history-isearch-message-overlay
1697 (point-min) (minibuffer-prompt-end))
1698 (setq minibuffer-history-isearch-message-overlay
1699 (make-overlay (point-min) (minibuffer-prompt-end)))
1700 (overlay-put minibuffer-history-isearch-message-overlay 'evaporate t))
1701 (overlay-put minibuffer-history-isearch-message-overlay
1702 'display (isearch-message-prefix c-q-hack ellipsis))
1703 ;; And clear any previous isearch message.
1704 (message "")))
1705
1706(defun minibuffer-history-isearch-wrap ()
1d2b0303 1707 "Wrap the minibuffer history search when search fails.
297b8ccd
JL
1708Move point to the first history element for a forward search,
1709or to the last history element for a backward search."
1710 (unless isearch-word
1711 ;; When `minibuffer-history-isearch-search' fails on reaching the
1712 ;; beginning/end of the history, wrap the search to the first/last
1713 ;; minibuffer history element.
1714 (if isearch-forward
1715 (goto-history-element (length (symbol-value minibuffer-history-variable)))
1716 (goto-history-element 0))
1717 (setq isearch-success t))
1718 (goto-char (if isearch-forward (minibuffer-prompt-end) (point-max))))
1719
1720(defun minibuffer-history-isearch-push-state ()
1721 "Save a function restoring the state of minibuffer history search.
1722Save `minibuffer-history-position' to the additional state parameter
1723in the search status stack."
1724 `(lambda (cmd)
1725 (minibuffer-history-isearch-pop-state cmd ,minibuffer-history-position)))
1726
1727(defun minibuffer-history-isearch-pop-state (cmd hist-pos)
1728 "Restore the minibuffer history search state.
5626c14e 1729Go to the history element by the absolute history position HIST-POS."
297b8ccd
JL
1730 (goto-history-element hist-pos))
1731
1732\f
2076c87c 1733;Put this on C-x u, so we can force that rather than C-_ into startup msg
8cb95edf 1734(define-obsolete-function-alias 'advertised-undo 'undo "23.2")
2076c87c 1735
1e96c007 1736(defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
713c9020
RS
1737 "Table mapping redo records to the corresponding undo one.
1738A redo record for undo-in-region maps to t.
1739A redo record for ordinary undo maps to the following (earlier) undo.")
1e96c007
SM
1740
1741(defvar undo-in-region nil
1742 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
1743
1744(defvar undo-no-redo nil
1745 "If t, `undo' doesn't go through redo entries.")
1746
a7fe694c
RS
1747(defvar pending-undo-list nil
1748 "Within a run of consecutive undo commands, list remaining to be undone.
8ac28be5 1749If t, we undid all the way to the end of it.")
a7fe694c 1750
2076c87c
JB
1751(defun undo (&optional arg)
1752 "Undo some previous changes.
1753Repeat this command to undo more changes.
5626c14e 1754A numeric ARG serves as a repeat count.
65627aad 1755
3c1b77ca 1756In Transient Mark mode when the mark is active, only undo changes within
1e96c007 1757the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
3c1b77ca 1758as an argument limits undo to changes within the current region."
65627aad 1759 (interactive "*P")
2e033693
RS
1760 ;; Make last-command indicate for the next command that this was an undo.
1761 ;; That way, another undo will undo more.
1762 ;; If we get to the end of the undo history and get an error,
1763 ;; another undo command will find the undo history empty
1764 ;; and will get another error. To begin undoing the undos,
1765 ;; you must type some other command.
b553cffa 1766 (let ((modified (buffer-modified-p))
cb3b2ec0
RS
1767 (recent-save (recent-auto-save-p))
1768 message)
6b61353c
KH
1769 ;; If we get an error in undo-start,
1770 ;; the next command should not be a "consecutive undo".
1771 ;; So set `this-command' to something other than `undo'.
1772 (setq this-command 'undo-start)
1773
e967cd11 1774 (unless (and (eq last-command 'undo)
a7fe694c
RS
1775 (or (eq pending-undo-list t)
1776 ;; If something (a timer or filter?) changed the buffer
1777 ;; since the previous command, don't continue the undo seq.
1778 (let ((list buffer-undo-list))
1779 (while (eq (car list) nil)
1780 (setq list (cdr list)))
1781 ;; If the last undo record made was made by undo
1782 ;; it shows nothing else happened in between.
1783 (gethash list undo-equiv-table))))
1e96c007 1784 (setq undo-in-region
d34c311a 1785 (or (region-active-p) (and arg (not (numberp arg)))))
1e96c007 1786 (if undo-in-region
3c1b77ca
MB
1787 (undo-start (region-beginning) (region-end))
1788 (undo-start))
1789 ;; get rid of initial undo boundary
1790 (undo-more 1))
9a1120ea 1791 ;; If we got this far, the next command should be a consecutive undo.
6b61353c 1792 (setq this-command 'undo)
1e96c007
SM
1793 ;; Check to see whether we're hitting a redo record, and if
1794 ;; so, ask the user whether she wants to skip the redo/undo pair.
1795 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
1796 (or (eq (selected-window) (minibuffer-window))
cb3b2ec0
RS
1797 (setq message (if undo-in-region
1798 (if equiv "Redo in region!" "Undo in region!")
1799 (if equiv "Redo!" "Undo!"))))
0047373b 1800 (when (and (consp equiv) undo-no-redo)
1e96c007
SM
1801 ;; The equiv entry might point to another redo record if we have done
1802 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1803 (while (let ((next (gethash equiv undo-equiv-table)))
1804 (if next (setq equiv next))))
1805 (setq pending-undo-list equiv)))
3c1b77ca 1806 (undo-more
d34c311a 1807 (if (numberp arg)
3c1b77ca
MB
1808 (prefix-numeric-value arg)
1809 1))
1e96c007 1810 ;; Record the fact that the just-generated undo records come from an
713c9020
RS
1811 ;; undo operation--that is, they are redo records.
1812 ;; In the ordinary case (not within a region), map the redo
1813 ;; record to the following undos.
1e96c007 1814 ;; I don't know how to do that in the undo-in-region case.
86f0d932
SM
1815 (let ((list buffer-undo-list))
1816 ;; Strip any leading undo boundaries there might be, like we do
1817 ;; above when checking.
1818 (while (eq (car list) nil)
1819 (setq list (cdr list)))
1820 (puthash list (if undo-in-region t pending-undo-list)
1821 undo-equiv-table))
2512c9f0
RS
1822 ;; Don't specify a position in the undo record for the undo command.
1823 ;; Instead, undoing this should move point to where the change is.
1824 (let ((tail buffer-undo-list)
003550c5
GM
1825 (prev nil))
1826 (while (car tail)
1827 (when (integerp (car tail))
1828 (let ((pos (car tail)))
1e96c007
SM
1829 (if prev
1830 (setcdr prev (cdr tail))
1831 (setq buffer-undo-list (cdr tail)))
003550c5
GM
1832 (setq tail (cdr tail))
1833 (while (car tail)
1834 (if (eq pos (car tail))
1835 (if prev
1836 (setcdr prev (cdr tail))
1837 (setq buffer-undo-list (cdr tail)))
1838 (setq prev tail))
1839 (setq tail (cdr tail)))
1840 (setq tail nil)))
1841 (setq prev tail tail (cdr tail))))
e967cd11
RS
1842 ;; Record what the current undo list says,
1843 ;; so the next command can tell if the buffer was modified in between.
2076c87c 1844 (and modified (not (buffer-modified-p))
cb3b2ec0
RS
1845 (delete-auto-save-file-if-necessary recent-save))
1846 ;; Display a message announcing success.
1847 (if message
f6e7ec02 1848 (message "%s" message))))
2076c87c 1849
e967cd11
RS
1850(defun buffer-disable-undo (&optional buffer)
1851 "Make BUFFER stop keeping undo information.
1852No argument or nil as argument means do this for the current buffer."
1853 (interactive)
0d808a63 1854 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
d020fce0 1855 (setq buffer-undo-list t)))
e967cd11 1856
1e96c007
SM
1857(defun undo-only (&optional arg)
1858 "Undo some previous changes.
1859Repeat this command to undo more changes.
5626c14e 1860A numeric ARG serves as a repeat count.
1e96c007
SM
1861Contrary to `undo', this will not redo a previous undo."
1862 (interactive "*p")
1863 (let ((undo-no-redo t)) (undo arg)))
1e96c007 1864
52d1110d
RS
1865(defvar undo-in-progress nil
1866 "Non-nil while performing an undo.
1867Some change-hooks test this variable to do something different.")
1868
8ac28be5 1869(defun undo-more (n)
2076c87c 1870 "Undo back N undo-boundaries beyond what was already undone recently.
ff1fbe3e
RS
1871Call `undo-start' to get ready to undo recent changes,
1872then call `undo-more' one or more times to undo them."
a7fe694c 1873 (or (listp pending-undo-list)
8ac28be5 1874 (error (concat "No further undo information"
00fa4024 1875 (and undo-in-region " for region"))))
52d1110d 1876 (let ((undo-in-progress t))
b553f685
AM
1877 ;; Note: The following, while pulling elements off
1878 ;; `pending-undo-list' will call primitive change functions which
1879 ;; will push more elements onto `buffer-undo-list'.
8ac28be5 1880 (setq pending-undo-list (primitive-undo n pending-undo-list))
a7fe694c
RS
1881 (if (null pending-undo-list)
1882 (setq pending-undo-list t))))
2076c87c 1883
65627aad
RS
1884;; Deep copy of a list
1885(defun undo-copy-list (list)
1886 "Make a copy of undo list LIST."
1887 (mapcar 'undo-copy-list-1 list))
1888
1889(defun undo-copy-list-1 (elt)
1890 (if (consp elt)
1891 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1892 elt))
1893
1894(defun undo-start (&optional beg end)
1895 "Set `pending-undo-list' to the front of the undo list.
1896The next call to `undo-more' will undo the most recently made change.
1897If BEG and END are specified, then only undo elements
1898that apply to text between BEG and END are used; other undo elements
1899are ignored. If BEG and END are nil, all undo elements are used."
1900 (if (eq buffer-undo-list t)
1901 (error "No undo information in this buffer"))
1e722f9f 1902 (setq pending-undo-list
65627aad
RS
1903 (if (and beg end (not (= beg end)))
1904 (undo-make-selective-list (min beg end) (max beg end))
1905 buffer-undo-list)))
1906
1907(defvar undo-adjusted-markers)
1908
1909(defun undo-make-selective-list (start end)
1910 "Return a list of undo elements for the region START to END.
1911The elements come from `buffer-undo-list', but we keep only
1912the elements inside this region, and discard those outside this region.
1913If we find an element that crosses an edge of this region,
1914we stop and ignore all further elements."
1915 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1916 (undo-list (list nil))
1917 undo-adjusted-markers
1918 some-rejected
1919 undo-elt undo-elt temp-undo-list delta)
1920 (while undo-list-copy
1921 (setq undo-elt (car undo-list-copy))
1922 (let ((keep-this
1923 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1924 ;; This is a "was unmodified" element.
1925 ;; Keep it if we have kept everything thus far.
1926 (not some-rejected))
1927 (t
1928 (undo-elt-in-region undo-elt start end)))))
1929 (if keep-this
1930 (progn
1931 (setq end (+ end (cdr (undo-delta undo-elt))))
1932 ;; Don't put two nils together in the list
1933 (if (not (and (eq (car undo-list) nil)
1934 (eq undo-elt nil)))
1935 (setq undo-list (cons undo-elt undo-list))))
1936 (if (undo-elt-crosses-region undo-elt start end)
1937 (setq undo-list-copy nil)
1938 (setq some-rejected t)
1939 (setq temp-undo-list (cdr undo-list-copy))
1940 (setq delta (undo-delta undo-elt))
1941
1942 (when (/= (cdr delta) 0)
1943 (let ((position (car delta))
1944 (offset (cdr delta)))
1945
e1e04350
SM
1946 ;; Loop down the earlier events adjusting their buffer
1947 ;; positions to reflect the fact that a change to the buffer
1948 ;; isn't being undone. We only need to process those element
1949 ;; types which undo-elt-in-region will return as being in
1950 ;; the region since only those types can ever get into the
1951 ;; output
65627aad
RS
1952
1953 (while temp-undo-list
1954 (setq undo-elt (car temp-undo-list))
1955 (cond ((integerp undo-elt)
1956 (if (>= undo-elt position)
1957 (setcar temp-undo-list (- undo-elt offset))))
1958 ((atom undo-elt) nil)
1959 ((stringp (car undo-elt))
1960 ;; (TEXT . POSITION)
1961 (let ((text-pos (abs (cdr undo-elt)))
1962 (point-at-end (< (cdr undo-elt) 0 )))
1963 (if (>= text-pos position)
1e722f9f 1964 (setcdr undo-elt (* (if point-at-end -1 1)
65627aad
RS
1965 (- text-pos offset))))))
1966 ((integerp (car undo-elt))
1967 ;; (BEGIN . END)
1968 (when (>= (car undo-elt) position)
1969 (setcar undo-elt (- (car undo-elt) offset))
1970 (setcdr undo-elt (- (cdr undo-elt) offset))))
1971 ((null (car undo-elt))
1972 ;; (nil PROPERTY VALUE BEG . END)
1973 (let ((tail (nthcdr 3 undo-elt)))
1974 (when (>= (car tail) position)
1975 (setcar tail (- (car tail) offset))
1976 (setcdr tail (- (cdr tail) offset))))))
1977 (setq temp-undo-list (cdr temp-undo-list))))))))
1978 (setq undo-list-copy (cdr undo-list-copy)))
1979 (nreverse undo-list)))
1980
1981(defun undo-elt-in-region (undo-elt start end)
1982 "Determine whether UNDO-ELT falls inside the region START ... END.
1983If it crosses the edge, we return nil."
1984 (cond ((integerp undo-elt)
1985 (and (>= undo-elt start)
12a93712 1986 (<= undo-elt end)))
65627aad
RS
1987 ((eq undo-elt nil)
1988 t)
1989 ((atom undo-elt)
1990 nil)
1991 ((stringp (car undo-elt))
1992 ;; (TEXT . POSITION)
1993 (and (>= (abs (cdr undo-elt)) start)
1994 (< (abs (cdr undo-elt)) end)))
1995 ((and (consp undo-elt) (markerp (car undo-elt)))
1996 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1997 ;; See if MARKER is inside the region.
1998 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1999 (unless alist-elt
2000 (setq alist-elt (cons (car undo-elt)
2001 (marker-position (car undo-elt))))
2002 (setq undo-adjusted-markers
2003 (cons alist-elt undo-adjusted-markers)))
2004 (and (cdr alist-elt)
2005 (>= (cdr alist-elt) start)
12a93712 2006 (<= (cdr alist-elt) end))))
65627aad
RS
2007 ((null (car undo-elt))
2008 ;; (nil PROPERTY VALUE BEG . END)
2009 (let ((tail (nthcdr 3 undo-elt)))
2010 (and (>= (car tail) start)
12a93712 2011 (<= (cdr tail) end))))
65627aad
RS
2012 ((integerp (car undo-elt))
2013 ;; (BEGIN . END)
2014 (and (>= (car undo-elt) start)
12a93712 2015 (<= (cdr undo-elt) end)))))
65627aad
RS
2016
2017(defun undo-elt-crosses-region (undo-elt start end)
2018 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2019This assumes we have already decided that UNDO-ELT
2020is not *inside* the region START...END."
2021 (cond ((atom undo-elt) nil)
2022 ((null (car undo-elt))
2023 ;; (nil PROPERTY VALUE BEG . END)
2024 (let ((tail (nthcdr 3 undo-elt)))
1f8a132d
RS
2025 (and (< (car tail) end)
2026 (> (cdr tail) start))))
65627aad
RS
2027 ((integerp (car undo-elt))
2028 ;; (BEGIN . END)
1f8a132d
RS
2029 (and (< (car undo-elt) end)
2030 (> (cdr undo-elt) start)))))
65627aad
RS
2031
2032;; Return the first affected buffer position and the delta for an undo element
2033;; delta is defined as the change in subsequent buffer positions if we *did*
2034;; the undo.
2035(defun undo-delta (undo-elt)
2036 (if (consp undo-elt)
2037 (cond ((stringp (car undo-elt))
2038 ;; (TEXT . POSITION)
2039 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
2040 ((integerp (car undo-elt))
2041 ;; (BEGIN . END)
2042 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
2043 (t
2044 '(0 . 0)))
2045 '(0 . 0)))
b6e8e8e5 2046
1223933d 2047(defcustom undo-ask-before-discard nil
28cb725d
LT
2048 "If non-nil ask about discarding undo info for the current command.
2049Normally, Emacs discards the undo info for the current command if
2050it exceeds `undo-outer-limit'. But if you set this option
2051non-nil, it asks in the echo area whether to discard the info.
a3545af4 2052If you answer no, there is a slight risk that Emacs might crash, so
28cb725d
LT
2053only do it if you really want to undo the command.
2054
2055This option is mainly intended for debugging. You have to be
2056careful if you use it for other purposes. Garbage collection is
2057inhibited while the question is asked, meaning that Emacs might
2058leak memory. So you should make sure that you do not wait
2059excessively long before answering the question."
2060 :type 'boolean
2061 :group 'undo
bf247b6e 2062 :version "22.1")
28cb725d 2063
a1a801de
RS
2064(defvar undo-extra-outer-limit nil
2065 "If non-nil, an extra level of size that's ok in an undo item.
2066We don't ask the user about truncating the undo list until the
28cb725d
LT
2067current item gets bigger than this amount.
2068
2069This variable only matters if `undo-ask-before-discard' is non-nil.")
a1a801de
RS
2070(make-variable-buffer-local 'undo-extra-outer-limit)
2071
28cb725d
LT
2072;; When the first undo batch in an undo list is longer than
2073;; undo-outer-limit, this function gets called to warn the user that
2074;; the undo info for the current command was discarded. Garbage
2075;; collection is inhibited around the call, so it had better not do a
2076;; lot of consing.
b6e8e8e5
RS
2077(setq undo-outer-limit-function 'undo-outer-limit-truncate)
2078(defun undo-outer-limit-truncate (size)
28cb725d
LT
2079 (if undo-ask-before-discard
2080 (when (or (null undo-extra-outer-limit)
2081 (> size undo-extra-outer-limit))
2082 ;; Don't ask the question again unless it gets even bigger.
2083 ;; This applies, in particular, if the user quits from the question.
2084 ;; Such a quit quits out of GC, but something else will call GC
2085 ;; again momentarily. It will call this function again,
2086 ;; but we don't want to ask the question again.
2087 (setq undo-extra-outer-limit (+ size 50000))
2088 (if (let (use-dialog-box track-mouse executing-kbd-macro )
d5aa078b 2089 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
28cb725d
LT
2090 (buffer-name) size)))
2091 (progn (setq buffer-undo-list nil)
2092 (setq undo-extra-outer-limit nil)
2093 t)
2094 nil))
2095 (display-warning '(undo discard-info)
2096 (concat
d5aa078b 2097 (format "Buffer `%s' undo info was %d bytes long.\n"
28cb725d
LT
2098 (buffer-name) size)
2099 "The undo info was discarded because it exceeded \
2100`undo-outer-limit'.
2101
2102This is normal if you executed a command that made a huge change
2103to the buffer. In that case, to prevent similar problems in the
2104future, set `undo-outer-limit' to a value that is large enough to
2105cover the maximum size of normal changes you expect a single
2106command to make, but not so large that it might exceed the
2107maximum memory allotted to Emacs.
2108
2109If you did not execute any such command, the situation is
2110probably due to a bug and you should report it.
2111
2112You can disable the popping up of this buffer by adding the entry
14f01bef
CY
2113\(undo discard-info) to the user option `warning-suppress-types',
2114which is defined in the `warnings' library.\n")
28cb725d
LT
2115 :warning)
2116 (setq buffer-undo-list nil)
2117 t))
e1e04350 2118\f
009ef402 2119(defvar shell-command-history nil
e5f0c02f
EZ
2120 "History list for some commands that read shell commands.
2121
2122Maximum length of the history list is determined by the value
2123of `history-length', which see.")
009ef402 2124
6d341a2a 2125(defvar shell-command-switch (purecopy "-c")
59fc41e5
RS
2126 "Switch used to have the shell execute its command line argument.")
2127
cc039f78
KH
2128(defvar shell-command-default-error-buffer nil
2129 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
637fff82 2130This buffer is used when `shell-command' or `shell-command-on-region'
cc039f78
KH
2131is run interactively. A value of nil means that output to stderr and
2132stdout will be intermixed in the output stream.")
2133
a98a2fe8 2134(declare-function mailcap-file-default-commands "mailcap" (files))
e0987650 2135(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
a98a2fe8
JL
2136
2137(defun minibuffer-default-add-shell-commands ()
263bc3fa 2138 "Return a list of all commands associated with the current file.
086a7dd4 2139This function is used to add all related commands retrieved by `mailcap'
a98a2fe8
JL
2140to the end of the list of defaults just after the default value."
2141 (interactive)
2142 (let* ((filename (if (listp minibuffer-default)
2143 (car minibuffer-default)
2144 minibuffer-default))
2145 (commands (and filename (require 'mailcap nil t)
2146 (mailcap-file-default-commands (list filename)))))
2147 (setq commands (mapcar (lambda (command)
2148 (concat command " " filename))
2149 commands))
2150 (if (listp minibuffer-default)
2151 (append minibuffer-default commands)
2152 (cons minibuffer-default commands))))
2153
2e7bd464
GM
2154(defvar shell-delimiter-argument-list)
2155(defvar shell-file-name-chars)
2156(defvar shell-file-name-quote-list)
2157
e5c4079c
SM
2158(defun minibuffer-complete-shell-command ()
2159 "Dynamically complete shell command at point."
2160 (interactive)
2161 (require 'shell)
79ccd1b8
AS
2162 (let ((comint-delimiter-argument-list shell-delimiter-argument-list)
2163 (comint-file-name-chars shell-file-name-chars)
2164 (comint-file-name-quote-list shell-file-name-quote-list))
2165 (run-hook-with-args-until-success 'shell-dynamic-complete-functions)))
e5c4079c
SM
2166
2167(defvar minibuffer-local-shell-command-map
2168 (let ((map (make-sparse-keymap)))
2169 (set-keymap-parent map minibuffer-local-map)
2170 (define-key map "\t" 'minibuffer-complete-shell-command)
2171 map)
1d2b0303 2172 "Keymap used for completing shell commands in minibuffer.")
e5c4079c
SM
2173
2174(defun read-shell-command (prompt &optional initial-contents hist &rest args)
2175 "Read a shell command from the minibuffer.
2176The arguments are the same as the ones of `read-from-minibuffer',
2177except READ and KEYMAP are missing and HIST defaults
2178to `shell-command-history'."
d6601455
JL
2179 (minibuffer-with-setup-hook
2180 (lambda ()
2181 (set (make-local-variable 'minibuffer-default-add-function)
2182 'minibuffer-default-add-shell-commands))
2183 (apply 'read-from-minibuffer prompt initial-contents
2184 minibuffer-local-shell-command-map
2185 nil
2186 (or hist 'shell-command-history)
2187 args)))
e5c4079c 2188
c945a962
JL
2189(defun async-shell-command (command &optional output-buffer error-buffer)
2190 "Execute string COMMAND asynchronously in background.
2191
2192Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2193surrounded by whitespace and executes the command asynchronously.
5ad4bef5
SM
2194The output appears in the buffer `*Async Shell Command*'.
2195
2196In Elisp, you will often be better served by calling `start-process'
2197directly, since it offers more control and does not impose the use of a
2198shell (with its need to quote arguments)."
c945a962
JL
2199 (interactive
2200 (list
2201 (read-shell-command "Async shell command: " nil nil
2202 (and buffer-file-name
2203 (file-relative-name buffer-file-name)))
2204 current-prefix-arg
2205 shell-command-default-error-buffer))
2206 (unless (string-match "&[ \t]*\\'" command)
2207 (setq command (concat command " &")))
2208 (shell-command command output-buffer error-buffer))
2209
cc039f78 2210(defun shell-command (command &optional output-buffer error-buffer)
2076c87c 2211 "Execute string COMMAND in inferior shell; display output, if any.
0b3f96d4 2212With prefix argument, insert the COMMAND's output at point.
d382f610 2213
2076c87c 2214If COMMAND ends in ampersand, execute it asynchronously.
d382f610 2215The output appears in the buffer `*Async Shell Command*'.
bcad4985 2216That buffer is in shell mode.
d382f610 2217
939ac10c
GM
2218Otherwise, COMMAND is executed synchronously. The output appears in
2219the buffer `*Shell Command Output*'. If the output is short enough to
2220display in the echo area (which is determined by the variables
2221`resize-mini-windows' and `max-mini-window-height'), it is shown
2222there, but it is nonetheless available in buffer `*Shell Command
e1e04350 2223Output*' even though that buffer is not automatically displayed.
d0d74413 2224
07f458c1 2225To specify a coding system for converting non-ASCII characters
5626c14e 2226in the shell command output, use \\[universal-coding-system-argument] \
07f458c1
RS
2227before this command.
2228
2229Noninteractive callers can specify coding systems by binding
2230`coding-system-for-read' and `coding-system-for-write'.
2231
d0d74413
RS
2232The optional second argument OUTPUT-BUFFER, if non-nil,
2233says to put the output in some other buffer.
2234If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2235If OUTPUT-BUFFER is not a buffer and not nil,
2236insert output in current buffer. (This cannot be done asynchronously.)
e7791447
CY
2237In either case, the buffer is first erased, and the output is
2238inserted after point (leaving mark after it).
cc039f78 2239
2e033693
RS
2240If the command terminates without error, but generates output,
2241and you did not specify \"insert it in the current buffer\",
2242the output can be displayed in the echo area or in its buffer.
2243If the output is short enough to display in the echo area
2244\(determined by the variable `max-mini-window-height' if
5626c14e
JB
2245`resize-mini-windows' is non-nil), it is shown there.
2246Otherwise,the buffer containing the output is displayed.
2e033693
RS
2247
2248If there is output and an error, and you did not specify \"insert it
2249in the current buffer\", a message about the error goes at the end
2250of the output.
2251
2252If there is no output, or if output is inserted in the current buffer,
2253then `*Shell Command Output*' is deleted.
2254
cc039f78
KH
2255If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2256or buffer name to which to direct the command's standard error output.
2257If it is nil, error output is mingled with regular output.
2258In an interactive call, the variable `shell-command-default-error-buffer'
5ad4bef5
SM
2259specifies the value of ERROR-BUFFER.
2260
2261In Elisp, you will often be better served by calling `call-process' or
2262`start-process' directly, since it offers more control and does not impose
2263the use of a shell (with its need to quote arguments)."
cc039f78 2264
a98a2fe8
JL
2265 (interactive
2266 (list
d6601455 2267 (read-shell-command "Shell command: " nil nil
e0987650
JL
2268 (let ((filename
2269 (cond
2270 (buffer-file-name)
2271 ((eq major-mode 'dired-mode)
2272 (dired-get-filename nil t)))))
2273 (and filename (file-relative-name filename))))
a98a2fe8
JL
2274 current-prefix-arg
2275 shell-command-default-error-buffer))
c7edd03c
KH
2276 ;; Look for a handler in case default-directory is a remote file name.
2277 (let ((handler
2278 (find-file-name-handler (directory-file-name default-directory)
2279 'shell-command)))
2280 (if handler
cc039f78 2281 (funcall handler 'shell-command command output-buffer error-buffer)
c7edd03c
KH
2282 (if (and output-buffer
2283 (not (or (bufferp output-buffer) (stringp output-buffer))))
2e033693 2284 ;; Output goes in current buffer.
cc039f78 2285 (let ((error-file
1e722f9f 2286 (if error-buffer
b005abd5 2287 (make-temp-file
171a45d9
EZ
2288 (expand-file-name "scor"
2289 (or small-temporary-file-directory
2290 temporary-file-directory)))
cc039f78
KH
2291 nil)))
2292 (barf-if-buffer-read-only)
63437623 2293 (push-mark nil t)
cc039f78
KH
2294 ;; We do not use -f for csh; we will not support broken use of
2295 ;; .cshrcs. Even the BSD csh manual says to use
2296 ;; "if ($?prompt) exit" before things which are not useful
2297 ;; non-interactively. Besides, if someone wants their other
2298 ;; aliases for shell commands then they can still have them.
1e722f9f 2299 (call-process shell-file-name nil
cc039f78
KH
2300 (if error-file
2301 (list t error-file)
2302 t)
2303 nil shell-command-switch command)
2304 (when (and error-file (file-exists-p error-file))
2305 (if (< 0 (nth 7 (file-attributes error-file)))
2306 (with-current-buffer (get-buffer-create error-buffer)
2307 (let ((pos-from-end (- (point-max) (point))))
2308 (or (bobp)
2309 (insert "\f\n"))
2310 ;; Do no formatting while reading error file,
2311 ;; because that can run a shell command, and we
2312 ;; don't want that to cause an infinite recursion.
2313 (format-insert-file error-file nil)
2314 ;; Put point after the inserted errors.
2315 (goto-char (- (point-max) pos-from-end)))
2316 (display-buffer (current-buffer))))
2317 (delete-file error-file))
2318 ;; This is like exchange-point-and-mark, but doesn't
2319 ;; activate the mark. It is cleaner to avoid activation,
2320 ;; even though the command loop would deactivate the mark
2321 ;; because we inserted text.
2322 (goto-char (prog1 (mark t)
2323 (set-marker (mark-marker) (point)
2324 (current-buffer)))))
2e033693 2325 ;; Output goes in a separate buffer.
c7edd03c
KH
2326 ;; Preserve the match data in case called from a program.
2327 (save-match-data
aab5d2c5 2328 (if (string-match "[ \t]*&[ \t]*\\'" command)
c7edd03c
KH
2329 ;; Command ending with ampersand means asynchronous.
2330 (let ((buffer (get-buffer-create
2331 (or output-buffer "*Async Shell Command*")))
2332 (directory default-directory)
2333 proc)
2334 ;; Remove the ampersand.
2335 (setq command (substring command 0 (match-beginning 0)))
2336 ;; If will kill a process, query first.
2337 (setq proc (get-buffer-process buffer))
2338 (if proc
2339 (if (yes-or-no-p "A command is running. Kill it? ")
2340 (kill-process proc)
2341 (error "Shell command in progress")))
1e96c007 2342 (with-current-buffer buffer
c7edd03c
KH
2343 (setq buffer-read-only nil)
2344 (erase-buffer)
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
a2cf21a2
CY
4222into account variable-width characters and line continuation."
4223 :type 'boolean
4224 :group 'editing-basics)
4efebb82 4225
b704b1f0
KS
4226;; Returns non-nil if partial move was done.
4227(defun line-move-partial (arg noerror to-end)
4228 (if (< arg 0)
4229 ;; Move backward (up).
4230 ;; If already vscrolled, reduce vscroll
4231 (let ((vs (window-vscroll nil t)))
4232 (when (> vs (frame-char-height))
4233 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4234
4235 ;; Move forward (down).
e437f99a
KS
4236 (let* ((lh (window-line-height -1))
4237 (vpos (nth 1 lh))
4238 (ypos (nth 2 lh))
4239 (rbot (nth 3 lh))
3137dda8 4240 py vs)
e437f99a
KS
4241 (when (or (null lh)
4242 (>= rbot (frame-char-height))
4243 (<= ypos (- (frame-char-height))))
4244 (unless lh
0e7a5039
KS
4245 (let ((wend (pos-visible-in-window-p t nil t)))
4246 (setq rbot (nth 3 wend)
4247 vpos (nth 5 wend))))
e437f99a
KS
4248 (cond
4249 ;; If last line of window is fully visible, move forward.
4250 ((or (null rbot) (= rbot 0))
4251 nil)
4252 ;; If cursor is not in the bottom scroll margin, move forward.
4253 ((and (> vpos 0)
95f5a37f
KS
4254 (< (setq py
4255 (or (nth 1 (window-line-height))
4256 (let ((ppos (posn-at-point)))
4257 (cdr (or (posn-actual-col-row ppos)
4258 (posn-col-row ppos))))))
e437f99a
KS
4259 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4260 nil)
4261 ;; When already vscrolled, we vscroll some more if we can,
4262 ;; or clear vscroll and move forward at end of tall image.
4263 ((> (setq vs (window-vscroll nil t)) 0)
4264 (when (> rbot 0)
4265 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4266 ;; If cursor just entered the bottom scroll margin, move forward,
4267 ;; but also vscroll one line so redisplay wont recenter.
4268 ((and (> vpos 0)
4269 (= py (min (- (window-text-height) scroll-margin 1)
4270 (1- vpos))))
4271 (set-window-vscroll nil (frame-char-height) t)
4272 (line-move-1 arg noerror to-end)
4273 t)
4274 ;; If there are lines above the last line, scroll-up one line.
4275 ((> vpos 0)
4276 (scroll-up 1)
4277 t)
4278 ;; Finally, start vscroll.
4279 (t
4280 (set-window-vscroll nil (frame-char-height) t)))))))
b704b1f0
KS
4281
4282
03ceda9e
RS
4283;; This is like line-move-1 except that it also performs
4284;; vertical scrolling of tall images if appropriate.
4285;; That is not really a clean thing to do, since it mixes
4286;; scrolling with cursor motion. But so far we don't have
4287;; a cleaner solution to the problem of making C-n do something
4288;; useful given a tall image.
ed02c1db 4289(defun line-move (arg &optional noerror to-end try-vscroll)
b704b1f0
KS
4290 (unless (and auto-window-vscroll try-vscroll
4291 ;; Only vscroll for single line moves
4292 (= (abs arg) 1)
4293 ;; But don't vscroll in a keyboard macro.
4294 (not defining-kbd-macro)
4295 (not executing-kbd-macro)
4296 (line-move-partial arg noerror to-end))
4297 (set-window-vscroll nil 0 t)
4efebb82
CY
4298 (if line-move-visual
4299 (line-move-visual arg noerror)
4300 (line-move-1 arg noerror to-end))))
4301
4302;; Display-based alternative to line-move-1.
4303;; Arg says how many lines to move. The value is t if we can move the
4304;; specified number of lines.
4305(defun line-move-visual (arg &optional noerror)
34be836c 4306 (let ((opoint (point))
774409a1 4307 (hscroll (window-hscroll))
34be836c 4308 target-hscroll)
774409a1
CY
4309 ;; Check if the previous command was a line-motion command, or if
4310 ;; we were called from some other command.
34be836c
CY
4311 (if (and (consp temporary-goal-column)
4312 (memq last-command `(next-line previous-line ,this-command)))
4313 ;; If so, there's no need to reset `temporary-goal-column',
4314 ;; but we may need to hscroll.
4315 (if (or (/= (cdr temporary-goal-column) hscroll)
4316 (> (cdr temporary-goal-column) 0))
4317 (setq target-hscroll (cdr temporary-goal-column)))
4318 ;; Otherwise, we should reset `temporary-goal-column'.
4319 (let ((posn (posn-at-point)))
4320 (cond
4321 ;; Handle the `overflow-newline-into-fringe' case:
4322 ((eq (nth 1 posn) 'right-fringe)
4323 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4324 ((car (posn-x-y posn))
4325 (setq temporary-goal-column
4326 (cons (/ (float (car (posn-x-y posn)))
4327 (frame-char-width)) hscroll))))))
4328 (if target-hscroll
4329 (set-window-hscroll (selected-window) target-hscroll))
624a662f 4330 (or (and (= (vertical-motion
774409a1
CY
4331 (cons (or goal-column
4332 (if (consp temporary-goal-column)
5a66ed0f 4333 (car temporary-goal-column)
774409a1
CY
4334 temporary-goal-column))
4335 arg))
624a662f
CY
4336 arg)
4337 (or (>= arg 0)
4338 (/= (point) opoint)
4339 ;; If the goal column lies on a display string,
4340 ;; `vertical-motion' advances the cursor to the end
4341 ;; of the string. For arg < 0, this can cause the
4342 ;; cursor to get stuck. (Bug#3020).
4343 (= (vertical-motion arg) arg)))
4344 (unless noerror
4345 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4346 nil)))))
16c2f92f 4347
8c745744
RS
4348;; This is the guts of next-line and previous-line.
4349;; Arg says how many lines to move.
bbf41690 4350;; The value is t if we can move the specified number of lines.
16c2f92f 4351(defun line-move-1 (arg &optional noerror to-end)
2596511d
RS
4352 ;; Don't run any point-motion hooks, and disregard intangibility,
4353 ;; for intermediate positions.
4354 (let ((inhibit-point-motion-hooks t)
4355 (opoint (point))
fef11f15 4356 (orig-arg arg))
774409a1
CY
4357 (if (consp temporary-goal-column)
4358 (setq temporary-goal-column (+ (car temporary-goal-column)
4359 (cdr temporary-goal-column))))
2596511d
RS
4360 (unwind-protect
4361 (progn
41d22ee0 4362 (if (not (memq last-command '(next-line previous-line)))
2596511d
RS
4363 (setq temporary-goal-column
4364 (if (and track-eol (eolp)
4365 ;; Don't count beg of empty line as end of line
4366 ;; unless we just did explicit end-of-line.
ab9623c2 4367 (or (not (bolp)) (eq last-command 'move-end-of-line)))
3137dda8 4368 most-positive-fixnum
2596511d 4369 (current-column))))
bbf41690 4370
3137dda8
SM
4371 (if (not (or (integerp selective-display)
4372 line-move-ignore-invisible))
2596511d 4373 ;; Use just newline characters.
e9cd25fe 4374 ;; Set ARG to 0 if we move as many lines as requested.
2596511d
RS
4375 (or (if (> arg 0)
4376 (progn (if (> arg 1) (forward-line (1- arg)))
4377 ;; This way of moving forward ARG lines
4378 ;; verifies that we have a newline after the last one.
4379 ;; It doesn't get confused by intangible text.
4380 (end-of-line)
e9cd25fe
RS
4381 (if (zerop (forward-line 1))
4382 (setq arg 0)))
2596511d 4383 (and (zerop (forward-line arg))
e9cd25fe
RS
4384 (bolp)
4385 (setq arg 0)))
bbf41690
RS
4386 (unless noerror
4387 (signal (if (< arg 0)
4388 'beginning-of-buffer
4389 'end-of-buffer)
4390 nil)))
2596511d 4391 ;; Move by arg lines, but ignore invisible ones.
07889873 4392 (let (done)
bbf41690
RS
4393 (while (and (> arg 0) (not done))
4394 ;; If the following character is currently invisible,
4395 ;; skip all characters with that same `invisible' property value.
c65e6942 4396 (while (and (not (eobp)) (invisible-p (point)))
bbf41690 4397 (goto-char (next-char-property-change (point))))
fef11f15
CY
4398 ;; Move a line.
4399 ;; We don't use `end-of-line', since we want to escape
40b1a3a9 4400 ;; from field boundaries occurring exactly at point.
07889873
CY
4401 (goto-char (constrain-to-field
4402 (let ((inhibit-field-text-motion t))
4403 (line-end-position))
4404 (point) t t
4405 'inhibit-line-move-field-capture))
e9ab825f 4406 ;; If there's no invisibility here, move over the newline.
3e43ae87
KS
4407 (cond
4408 ((eobp)
4409 (if (not noerror)
4410 (signal 'end-of-buffer nil)
4411 (setq done t)))
4412 ((and (> arg 1) ;; Use vertical-motion for last move
4413 (not (integerp selective-display))
c65e6942 4414 (not (invisible-p (point))))
3e43ae87
KS
4415 ;; We avoid vertical-motion when possible
4416 ;; because that has to fontify.
4417 (forward-line 1))
4418 ;; Otherwise move a more sophisticated way.
4419 ((zerop (vertical-motion 1))
4420 (if (not noerror)
4421 (signal 'end-of-buffer nil)
4422 (setq done t))))
bbf41690
RS
4423 (unless done
4424 (setq arg (1- arg))))
22c8bff1 4425 ;; The logic of this is the same as the loop above,
e9ab825f 4426 ;; it just goes in the other direction.
bbf41690 4427 (while (and (< arg 0) (not done))
ac6701ea
CY
4428 ;; For completely consistency with the forward-motion
4429 ;; case, we should call beginning-of-line here.
4430 ;; However, if point is inside a field and on a
4431 ;; continued line, the call to (vertical-motion -1)
4432 ;; below won't move us back far enough; then we return
4433 ;; to the same column in line-move-finish, and point
4434 ;; gets stuck -- cyd
4435 (forward-line 0)
3e43ae87
KS
4436 (cond
4437 ((bobp)
4438 (if (not noerror)
4439 (signal 'beginning-of-buffer nil)
4440 (setq done t)))
4441 ((and (< arg -1) ;; Use vertical-motion for last move
4442 (not (integerp selective-display))
c65e6942 4443 (not (invisible-p (1- (point)))))
3e43ae87
KS
4444 (forward-line -1))
4445 ((zerop (vertical-motion -1))
4446 (if (not noerror)
4447 (signal 'beginning-of-buffer nil)
4448 (setq done t))))
bbf41690
RS
4449 (unless done
4450 (setq arg (1+ arg))
4451 (while (and ;; Don't move over previous invis lines
4452 ;; if our target is the middle of this line.
4453 (or (zerop (or goal-column temporary-goal-column))
4454 (< arg 0))
c65e6942 4455 (not (bobp)) (invisible-p (1- (point))))
bbf41690
RS
4456 (goto-char (previous-char-property-change (point))))))))
4457 ;; This is the value the function returns.
4458 (= arg 0))
af894fc9 4459
e9cd25fe 4460 (cond ((> arg 0)
2a1e0c92
CY
4461 ;; If we did not move down as far as desired, at least go
4462 ;; to end of line. Be sure to call point-entered and
4463 ;; point-left-hooks.
4464 (let* ((npoint (prog1 (line-end-position)
4465 (goto-char opoint)))
4466 (inhibit-point-motion-hooks nil))
4467 (goto-char npoint)))
e9cd25fe 4468 ((< arg 0)
f9872a6b
JL
4469 ;; If we did not move up as far as desired,
4470 ;; at least go to beginning of line.
2a1e0c92
CY
4471 (let* ((npoint (prog1 (line-beginning-position)
4472 (goto-char opoint)))
4473 (inhibit-point-motion-hooks nil))
4474 (goto-char npoint)))
e9cd25fe 4475 (t
20782abb 4476 (line-move-finish (or goal-column temporary-goal-column)
fef11f15 4477 opoint (> orig-arg 0)))))))
2076c87c 4478
20782abb 4479(defun line-move-finish (column opoint forward)
af894fc9
RS
4480 (let ((repeat t))
4481 (while repeat
4482 ;; Set REPEAT to t to repeat the whole thing.
4483 (setq repeat nil)
4484
1f980920 4485 (let (new
963355a4 4486 (old (point))
5ed619e0 4487 (line-beg (line-beginning-position))
1f980920
RS
4488 (line-end
4489 ;; Compute the end of the line
20782abb 4490 ;; ignoring effectively invisible newlines.
bbf41690 4491 (save-excursion
a5b4a6a0
RS
4492 ;; Like end-of-line but ignores fields.
4493 (skip-chars-forward "^\n")
c65e6942 4494 (while (and (not (eobp)) (invisible-p (point)))
20782abb 4495 (goto-char (next-char-property-change (point)))
a5b4a6a0 4496 (skip-chars-forward "^\n"))
bbf41690 4497 (point))))
1f980920
RS
4498
4499 ;; Move to the desired column.
54b99340 4500 (line-move-to-column (truncate column))
963355a4
CY
4501
4502 ;; Corner case: suppose we start out in a field boundary in
4503 ;; the middle of a continued line. When we get to
4504 ;; line-move-finish, point is at the start of a new *screen*
4505 ;; line but the same text line; then line-move-to-column would
4506 ;; move us backwards. Test using C-n with point on the "x" in
4507 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4508 (and forward
4509 (< (point) old)
4510 (goto-char old))
4511
1f980920 4512 (setq new (point))
af894fc9
RS
4513
4514 ;; Process intangibility within a line.
594a1605
CY
4515 ;; With inhibit-point-motion-hooks bound to nil, a call to
4516 ;; goto-char moves point past intangible text.
4517
4518 ;; However, inhibit-point-motion-hooks controls both the
4519 ;; intangibility and the point-entered/point-left hooks. The
4520 ;; following hack avoids calling the point-* hooks
4521 ;; unnecessarily. Note that we move *forward* past intangible
4522 ;; text when the initial and final points are the same.
d584e29d 4523 (goto-char new)
af894fc9
RS
4524 (let ((inhibit-point-motion-hooks nil))
4525 (goto-char new)
4526
4527 ;; If intangibility moves us to a different (later) place
4528 ;; in the same line, use that as the destination.
4529 (if (<= (point) line-end)
1f980920
RS
4530 (setq new (point))
4531 ;; If that position is "too late",
4532 ;; try the previous allowable position.
4533 ;; See if it is ok.
4534 (backward-char)
20782abb
RS
4535 (if (if forward
4536 ;; If going forward, don't accept the previous
4537 ;; allowable position if it is before the target line.
f1e2a033 4538 (< line-beg (point))
20782abb
RS
4539 ;; If going backward, don't accept the previous
4540 ;; allowable position if it is still after the target line.
4541 (<= (point) line-end))
1f980920
RS
4542 (setq new (point))
4543 ;; As a last resort, use the end of the line.
4544 (setq new line-end))))
af894fc9
RS
4545
4546 ;; Now move to the updated destination, processing fields
4547 ;; as well as intangibility.
4548 (goto-char opoint)
4549 (let ((inhibit-point-motion-hooks nil))
4550 (goto-char
e94e78cc
CY
4551 ;; Ignore field boundaries if the initial and final
4552 ;; positions have the same `field' property, even if the
4553 ;; fields are non-contiguous. This seems to be "nicer"
4554 ;; behavior in many situations.
4555 (if (eq (get-char-property new 'field)
4556 (get-char-property opoint 'field))
4557 new
4558 (constrain-to-field new opoint t t
4559 'inhibit-line-move-field-capture))))
af894fc9 4560
1f980920 4561 ;; If all this moved us to a different line,
af894fc9
RS
4562 ;; retry everything within that new line.
4563 (when (or (< (point) line-beg) (> (point) line-end))
4564 ;; Repeat the intangibility and field processing.
4565 (setq repeat t))))))
4566
4567(defun line-move-to-column (col)
4568 "Try to find column COL, considering invisibility.
4569This function works only in certain cases,
4570because what we really need is for `move-to-column'
4571and `current-column' to be able to ignore invisible text."
a615252b
RS
4572 (if (zerop col)
4573 (beginning-of-line)
095f9ae4 4574 (move-to-column col))
af894fc9
RS
4575
4576 (when (and line-move-ignore-invisible
c65e6942 4577 (not (bolp)) (invisible-p (1- (point))))
af894fc9
RS
4578 (let ((normal-location (point))
4579 (normal-column (current-column)))
4580 ;; If the following character is currently invisible,
4581 ;; skip all characters with that same `invisible' property value.
4582 (while (and (not (eobp))
c65e6942 4583 (invisible-p (point)))
af894fc9
RS
4584 (goto-char (next-char-property-change (point))))
4585 ;; Have we advanced to a larger column position?
4586 (if (> (current-column) normal-column)
4587 ;; We have made some progress towards the desired column.
4588 ;; See if we can make any further progress.
4589 (line-move-to-column (+ (current-column) (- col normal-column)))
4590 ;; Otherwise, go to the place we originally found
4591 ;; and move back over invisible text.
4592 ;; that will get us to the same place on the screen
4593 ;; but with a more reasonable buffer position.
4594 (goto-char normal-location)
5ed619e0 4595 (let ((line-beg (line-beginning-position)))
c65e6942 4596 (while (and (not (bolp)) (invisible-p (1- (point))))
af894fc9
RS
4597 (goto-char (previous-char-property-change (point) line-beg))))))))
4598
bbf41690 4599(defun move-end-of-line (arg)
f00239cf 4600 "Move point to end of current line as displayed.
bbf41690
RS
4601With argument ARG not nil or 1, move forward ARG - 1 lines first.
4602If point reaches the beginning or end of buffer, it stops there.
fdb77e6f
CY
4603
4604To ignore the effects of the `intangible' text or overlay
4605property, bind `inhibit-point-motion-hooks' to t.
4606If there is an image in the current line, this function
4607disregards newlines that are part of the text on which the image
4608rests."
109cfe4e 4609 (interactive "^p")
bbf41690
RS
4610 (or arg (setq arg 1))
4611 (let (done)
4612 (while (not done)
4613 (let ((newpos
4614 (save-excursion
4efebb82
CY
4615 (let ((goal-column 0)
4616 (line-move-visual nil))
bbf41690 4617 (and (line-move arg t)
3f2e7735
EZ
4618 ;; With bidi reordering, we may not be at bol,
4619 ;; so make sure we are.
4620 (skip-chars-backward "^\n")
bbf41690
RS
4621 (not (bobp))
4622 (progn
c65e6942 4623 (while (and (not (bobp)) (invisible-p (1- (point))))
3137dda8
SM
4624 (goto-char (previous-single-char-property-change
4625 (point) 'invisible)))
bbf41690
RS
4626 (backward-char 1)))
4627 (point)))))
4628 (goto-char newpos)
4629 (if (and (> (point) newpos)
4630 (eq (preceding-char) ?\n))
4631 (backward-char 1)
4632 (if (and (> (point) newpos) (not (eobp))
4633 (not (eq (following-char) ?\n)))
4efebb82
CY
4634 ;; If we skipped something intangible and now we're not
4635 ;; really at eol, keep going.
bbf41690
RS
4636 (setq arg 1)
4637 (setq done t)))))))
4638
0cbb497c 4639(defun move-beginning-of-line (arg)
f00239cf
RS
4640 "Move point to beginning of current line as displayed.
4641\(If there's an image in the line, this disregards newlines
4642which are part of the text that the image rests on.)
4643
0cbb497c
KS
4644With argument ARG not nil or 1, move forward ARG - 1 lines first.
4645If point reaches the beginning or end of buffer, it stops there.
f00239cf 4646To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
109cfe4e 4647 (interactive "^p")
0cbb497c 4648 (or arg (setq arg 1))
398c9ffb 4649
ad47c4a0 4650 (let ((orig (point))
3137dda8 4651 first-vis first-vis-field-value)
1fffd65f
RS
4652
4653 ;; Move by lines, if ARG is not 1 (the default).
4654 (if (/= arg 1)
4efebb82
CY
4655 (let ((line-move-visual nil))
4656 (line-move (1- arg) t)))
1fffd65f
RS
4657
4658 ;; Move to beginning-of-line, ignoring fields and invisibles.
4659 (skip-chars-backward "^\n")
c65e6942 4660 (while (and (not (bobp)) (invisible-p (1- (point))))
621a4cc8 4661 (goto-char (previous-char-property-change (point)))
1fffd65f 4662 (skip-chars-backward "^\n"))
ad47c4a0
RS
4663
4664 ;; Now find first visible char in the line
c65e6942 4665 (while (and (not (eobp)) (invisible-p (point)))
ad47c4a0
RS
4666 (goto-char (next-char-property-change (point))))
4667 (setq first-vis (point))
4668
4669 ;; See if fields would stop us from reaching FIRST-VIS.
4670 (setq first-vis-field-value
4671 (constrain-to-field first-vis orig (/= arg 1) t nil))
4672
4673 (goto-char (if (/= first-vis-field-value first-vis)
4674 ;; If yes, obey them.
4675 first-vis-field-value
4676 ;; Otherwise, move to START with attention to fields.
4677 ;; (It is possible that fields never matter in this case.)
4678 (constrain-to-field (point) orig
4679 (/= arg 1) t nil)))))
0cbb497c
KS
4680
4681
85be9ec4
SM
4682;; Many people have said they rarely use this feature, and often type
4683;; it by accident. Maybe it shouldn't even be on a key.
d5ab2033 4684(put 'set-goal-column 'disabled t)
2076c87c
JB
4685
4686(defun set-goal-column (arg)
4687 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
4688Those commands will move to this position in the line moved to
4689rather than trying to keep the same horizontal position.
5626c14e 4690With a non-nil argument ARG, clears out the goal column
912c6728
RS
4691so that \\[next-line] and \\[previous-line] resume vertical motion.
4692The goal column is stored in the variable `goal-column'."
2076c87c
JB
4693 (interactive "P")
4694 (if arg
4695 (progn
4696 (setq goal-column nil)
4697 (message "No goal column"))
4698 (setq goal-column (current-column))
8a26c165
DG
4699 ;; The older method below can be erroneous if `set-goal-column' is bound
4700 ;; to a sequence containing %
4701 ;;(message (substitute-command-keys
4702 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
4703 ;;goal-column)
4704 (message "%s"
63219d53 4705 (concat
8a26c165
DG
4706 (format "Goal column %d " goal-column)
4707 (substitute-command-keys
4708 "(use \\[set-goal-column] with an arg to unset it)")))
63219d53 4709
8a26c165 4710 )
2076c87c 4711 nil)
2d88b556 4712\f
a2cf21a2
CY
4713;;; Editing based on visual lines, as opposed to logical lines.
4714
4715(defun end-of-visual-line (&optional n)
4716 "Move point to end of current visual line.
4717With argument N not nil or 1, move forward N - 1 visual lines first.
4718If point reaches the beginning or end of buffer, it stops there.
4719To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4720 (interactive "^p")
4721 (or n (setq n 1))
4722 (if (/= n 1)
4723 (let ((line-move-visual t))
4724 (line-move (1- n) t)))
ef187c24
CY
4725 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4726 ;; constrain to field boundaries, so we don't either.
a2cf21a2
CY
4727 (vertical-motion (cons (window-width) 0)))
4728
4729(defun beginning-of-visual-line (&optional n)
4730 "Move point to beginning of current visual line.
4731With argument N not nil or 1, move forward N - 1 visual lines first.
4732If point reaches the beginning or end of buffer, it stops there.
4733To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4734 (interactive "^p")
4735 (or n (setq n 1))
ef187c24
CY
4736 (let ((opoint (point)))
4737 (if (/= n 1)
4738 (let ((line-move-visual t))
4739 (line-move (1- n) t)))
4740 (vertical-motion 0)
4741 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4742 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
a2cf21a2
CY
4743
4744(defun kill-visual-line (&optional arg)
4745 "Kill the rest of the visual line.
ad4c1f62
CY
4746With prefix argument ARG, kill that many visual lines from point.
4747If ARG is negative, kill visual lines backward.
4748If ARG is zero, kill the text before point on the current visual
4749line.
a2cf21a2
CY
4750
4751If you want to append the killed line to the last killed text,
4752use \\[append-next-kill] before \\[kill-line].
4753
4754If the buffer is read-only, Emacs will beep and refrain from deleting
4755the line, but put the line in the kill ring anyway. This means that
4756you can use this command to copy text from a read-only buffer.
4757\(If the variable `kill-read-only-ok' is non-nil, then this won't
4758even beep.)"
4759 (interactive "P")
ad4c1f62
CY
4760 ;; Like in `kill-line', it's better to move point to the other end
4761 ;; of the kill before killing.
2066b4fe
CY
4762 (let ((opoint (point))
4763 (kill-whole-line (and kill-whole-line (bolp))))
a2cf21a2
CY
4764 (if arg
4765 (vertical-motion (prefix-numeric-value arg))
ad4c1f62
CY
4766 (end-of-visual-line 1)
4767 (if (= (point) opoint)
4768 (vertical-motion 1)
4769 ;; Skip any trailing whitespace at the end of the visual line.
4770 ;; We used to do this only if `show-trailing-whitespace' is
4771 ;; nil, but that's wrong; the correct thing would be to check
4772 ;; whether the trailing whitespace is highlighted. But, it's
4773 ;; OK to just do this unconditionally.
4774 (skip-chars-forward " \t")))
2066b4fe
CY
4775 (kill-region opoint (if (and kill-whole-line (looking-at "\n"))
4776 (1+ (point))
4777 (point)))))
a2cf21a2
CY
4778
4779(defun next-logical-line (&optional arg try-vscroll)
4780 "Move cursor vertically down ARG lines.
1d2b0303 4781This is identical to `next-line', except that it always moves
a2cf21a2
CY
4782by logical lines instead of visual lines, ignoring the value of
4783the variable `line-move-visual'."
4784 (interactive "^p\np")
4785 (let ((line-move-visual nil))
4786 (with-no-warnings
4787 (next-line arg try-vscroll))))
4788
4789(defun previous-logical-line (&optional arg try-vscroll)
4790 "Move cursor vertically up ARG lines.
4791This is identical to `previous-line', except that it always moves
4792by logical lines instead of visual lines, ignoring the value of
4793the variable `line-move-visual'."
4794 (interactive "^p\np")
4795 (let ((line-move-visual nil))
4796 (with-no-warnings
4797 (previous-line arg try-vscroll))))
4798
4dec5cff
CY
4799(defgroup visual-line nil
4800 "Editing based on visual lines."
4801 :group 'convenience
4802 :version "23.1")
4803
a2cf21a2
CY
4804(defvar visual-line-mode-map
4805 (let ((map (make-sparse-keymap)))
4806 (define-key map [remap kill-line] 'kill-visual-line)
4807 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4808 (define-key map [remap move-end-of-line] 'end-of-visual-line)
b316b2b8
CY
4809 ;; These keybindings interfere with xterm function keys. Are
4810 ;; there any other suitable bindings?
4811 ;; (define-key map "\M-[" 'previous-logical-line)
4812 ;; (define-key map "\M-]" 'next-logical-line)
a2cf21a2
CY
4813 map))
4814
4dec5cff
CY
4815(defcustom visual-line-fringe-indicators '(nil nil)
4816 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4817The value should be a list of the form (LEFT RIGHT), where LEFT
4818and RIGHT are symbols representing the bitmaps to display, to
4819indicate wrapped lines, in the left and right fringes respectively.
4820See also `fringe-indicator-alist'.
4821The default is not to display fringe indicators for wrapped lines.
4822This variable does not affect fringe indicators displayed for
4823other purposes."
4824 :type '(list (choice (const :tag "Hide left indicator" nil)
4825 (const :tag "Left curly arrow" left-curly-arrow)
4826 (symbol :tag "Other bitmap"))
4827 (choice (const :tag "Hide right indicator" nil)
4828 (const :tag "Right curly arrow" right-curly-arrow)
4829 (symbol :tag "Other bitmap")))
4830 :set (lambda (symbol value)
4831 (dolist (buf (buffer-list))
4832 (with-current-buffer buf
4833 (when (and (boundp 'visual-line-mode)
4834 (symbol-value 'visual-line-mode))
4835 (setq fringe-indicator-alist
4836 (cons (cons 'continuation value)
4837 (assq-delete-all
4838 'continuation
4839 (copy-tree fringe-indicator-alist)))))))
4840 (set-default symbol value)))
4841
748e001a
CY
4842(defvar visual-line--saved-state nil)
4843
a2cf21a2 4844(define-minor-mode visual-line-mode
b677cb96
CY
4845 "Redefine simple editing commands to act on visual lines, not logical lines.
4846This also turns on `word-wrap' in the buffer."
a2cf21a2 4847 :keymap visual-line-mode-map
4dec5cff 4848 :group 'visual-line
ea92f9f3 4849 :lighter " Wrap"
a2cf21a2
CY
4850 (if visual-line-mode
4851 (progn
748e001a
CY
4852 (set (make-local-variable 'visual-line--saved-state) nil)
4853 ;; Save the local values of some variables, to be restored if
4854 ;; visual-line-mode is turned off.
4855 (dolist (var '(line-move-visual truncate-lines
4856 truncate-partial-width-windows
4857 word-wrap fringe-indicator-alist))
4858 (if (local-variable-p var)
37820ea9 4859 (push (cons var (symbol-value var))
748e001a 4860 visual-line--saved-state)))
a2cf21a2 4861 (set (make-local-variable 'line-move-visual) t)
c58140f4
CY
4862 (set (make-local-variable 'truncate-partial-width-windows) nil)
4863 (setq truncate-lines nil
4864 word-wrap t
4865 fringe-indicator-alist
4dec5cff
CY
4866 (cons (cons 'continuation visual-line-fringe-indicators)
4867 fringe-indicator-alist)))
a2cf21a2 4868 (kill-local-variable 'line-move-visual)
4dec5cff 4869 (kill-local-variable 'word-wrap)
c58140f4
CY
4870 (kill-local-variable 'truncate-lines)
4871 (kill-local-variable 'truncate-partial-width-windows)
748e001a
CY
4872 (kill-local-variable 'fringe-indicator-alist)
4873 (dolist (saved visual-line--saved-state)
4874 (set (make-local-variable (car saved)) (cdr saved)))
4875 (kill-local-variable 'visual-line--saved-state)))
a2cf21a2
CY
4876
4877(defun turn-on-visual-line-mode ()
4878 (visual-line-mode 1))
4879
4880(define-globalized-minor-mode global-visual-line-mode
4881 visual-line-mode turn-on-visual-line-mode
4882 :lighter " vl")
5a97d2da 4883
2d88b556 4884\f
2076c87c
JB
4885(defun transpose-chars (arg)
4886 "Interchange characters around point, moving forward one character.
4887With prefix arg ARG, effect is to take character before point
4888and drag it forward past ARG other characters (backward if ARG negative).
4889If no argument and at end of line, the previous two chars are exchanged."
4890 (interactive "*P")
4891 (and (null arg) (eolp) (forward-char -1))
4892 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4893
4894(defun transpose-words (arg)
4895 "Interchange words around point, leaving point at end of them.
4896With prefix arg ARG, effect is to take word before or around point
4897and drag it forward past ARG other words (backward if ARG negative).
4898If ARG is zero, the words around or after point and around or after mark
4899are interchanged."
41d22ee0 4900 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
2076c87c
JB
4901 (interactive "*p")
4902 (transpose-subr 'forward-word arg))
4903
4904(defun transpose-sexps (arg)
4905 "Like \\[transpose-words] but applies to sexps.
4906Does not work on a sexp that point is in the middle of
4907if it is a list or string."
4908 (interactive "*p")
41d22ee0
SM
4909 (transpose-subr
4910 (lambda (arg)
4911 ;; Here we should try to simulate the behavior of
4912 ;; (cons (progn (forward-sexp x) (point))
4913 ;; (progn (forward-sexp (- x)) (point)))
4914 ;; Except that we don't want to rely on the second forward-sexp
4915 ;; putting us back to where we want to be, since forward-sexp-function
4916 ;; might do funny things like infix-precedence.
4917 (if (if (> arg 0)
4918 (looking-at "\\sw\\|\\s_")
4919 (and (not (bobp))
4920 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
4921 ;; Jumping over a symbol. We might be inside it, mind you.
4922 (progn (funcall (if (> arg 0)
4923 'skip-syntax-backward 'skip-syntax-forward)
4924 "w_")
4925 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4926 ;; Otherwise, we're between sexps. Take a step back before jumping
4927 ;; to make sure we'll obey the same precedence no matter which direction
4928 ;; we're going.
4929 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4930 (cons (save-excursion (forward-sexp arg) (point))
4931 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4932 (not (zerop (funcall (if (> arg 0)
4933 'skip-syntax-forward
4934 'skip-syntax-backward)
4935 ".")))))
4936 (point)))))
4937 arg 'special))
2076c87c
JB
4938
4939(defun transpose-lines (arg)
4940 "Exchange current line and previous line, leaving point after both.
4941With argument ARG, takes previous line and moves it past ARG lines.
4942With argument 0, interchanges line point is in with line mark is in."
4943 (interactive "*p")
4944 (transpose-subr (function
4945 (lambda (arg)
d3f4ef3f 4946 (if (> arg 0)
2076c87c 4947 (progn
d3f4ef3f
AS
4948 ;; Move forward over ARG lines,
4949 ;; but create newlines if necessary.
4950 (setq arg (forward-line arg))
4951 (if (/= (preceding-char) ?\n)
4952 (setq arg (1+ arg)))
4953 (if (> arg 0)
4954 (newline arg)))
2076c87c
JB
4955 (forward-line arg))))
4956 arg))
4957
36020642
GM
4958;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4959;; which seems inconsistent with the ARG /= 0 case.
4960;; FIXME document SPECIAL.
e1e04350 4961(defun transpose-subr (mover arg &optional special)
36020642
GM
4962 "Subroutine to do the work of transposing objects.
4963Works for lines, sentences, paragraphs, etc. MOVER is a function that
4964moves forward by units of the given object (e.g. forward-sentence,
4965forward-paragraph). If ARG is zero, exchanges the current object
4966with the one containing mark. If ARG is an integer, moves the
4967current object past ARG following (if ARG is positive) or
4968preceding (if ARG is negative) objects, leaving point after the
4969current object."
e1e04350
SM
4970 (let ((aux (if special mover
4971 (lambda (x)
4972 (cons (progn (funcall mover x) (point))
4973 (progn (funcall mover (- x)) (point))))))
4974 pos1 pos2)
4975 (cond
4976 ((= arg 0)
4977 (save-excursion
4978 (setq pos1 (funcall aux 1))
41849bf9 4979 (goto-char (or (mark) (error "No mark set in this buffer")))
e1e04350
SM
4980 (setq pos2 (funcall aux 1))
4981 (transpose-subr-1 pos1 pos2))
4982 (exchange-point-and-mark))
4983 ((> arg 0)
4984 (setq pos1 (funcall aux -1))
4985 (setq pos2 (funcall aux arg))
4986 (transpose-subr-1 pos1 pos2)
4987 (goto-char (car pos2)))
4988 (t
4989 (setq pos1 (funcall aux -1))
4990 (goto-char (car pos1))
4991 (setq pos2 (funcall aux arg))
4992 (transpose-subr-1 pos1 pos2)))))
4993
4994(defun transpose-subr-1 (pos1 pos2)
4995 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4996 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4997 (when (> (car pos1) (car pos2))
4998 (let ((swap pos1))
4999 (setq pos1 pos2 pos2 swap)))
5000 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
dc7d7552
RS
5001 (atomic-change-group
5002 (let (word2)
1e96c007
SM
5003 ;; FIXME: We first delete the two pieces of text, so markers that
5004 ;; used to point to after the text end up pointing to before it :-(
dc7d7552
RS
5005 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5006 (goto-char (car pos2))
5007 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5008 (goto-char (car pos1))
5009 (insert word2))))
2d88b556 5010\f
6b61353c 5011(defun backward-word (&optional arg)
b7e91b0c 5012 "Move backward until encountering the beginning of a word.
5626c14e 5013With argument ARG, do this that many times."
109cfe4e 5014 (interactive "^p")
6b61353c 5015 (forward-word (- (or arg 1))))
2076c87c 5016
a1a801de 5017(defun mark-word (&optional arg allow-extend)
705a5933
JL
5018 "Set mark ARG words away from point.
5019The place mark goes is the same place \\[forward-word] would
5020move to with the same argument.
a1a801de 5021Interactively, if this command is repeated
771069f8 5022or (in Transient Mark mode) if the mark is active,
705a5933 5023it marks the next ARG words after the ones already marked."
a1a801de
RS
5024 (interactive "P\np")
5025 (cond ((and allow-extend
5026 (or (and (eq last-command this-command) (mark t))
d34c311a 5027 (region-active-p)))
705a5933
JL
5028 (setq arg (if arg (prefix-numeric-value arg)
5029 (if (< (mark) (point)) -1 1)))
cad113ae
KG
5030 (set-mark
5031 (save-excursion
5032 (goto-char (mark))
5033 (forward-word arg)
5034 (point))))
5035 (t
5036 (push-mark
5037 (save-excursion
705a5933 5038 (forward-word (prefix-numeric-value arg))
cad113ae
KG
5039 (point))
5040 nil t))))
2076c87c
JB
5041
5042(defun kill-word (arg)
5043 "Kill characters forward until encountering the end of a word.
5626c14e 5044With argument ARG, do this that many times."
e761e42c 5045 (interactive "p")
89ee2bf6 5046 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
5047
5048(defun backward-kill-word (arg)
654ec269 5049 "Kill characters backward until encountering the beginning of a word.
5626c14e 5050With argument ARG, do this that many times."
e761e42c 5051 (interactive "p")
2076c87c 5052 (kill-word (- arg)))
d7c64071 5053
0f7df535
RS
5054(defun current-word (&optional strict really-word)
5055 "Return the symbol or word that point is on (or a nearby one) as a string.
5056The return value includes no text properties.
1e8c5ac4 5057If optional arg STRICT is non-nil, return nil unless point is within
0fa19a57
RS
5058or adjacent to a symbol or word. In all cases the value can be nil
5059if there is no word nearby.
0f7df535
RS
5060The function, belying its name, normally finds a symbol.
5061If optional arg REALLY-WORD is non-nil, it finds just a word."
d7c64071 5062 (save-excursion
0f7df535 5063 (let* ((oldpoint (point)) (start (point)) (end (point))
81d17173 5064 (syntaxes (if really-word "w" "w_"))
0f7df535
RS
5065 (not-syntaxes (concat "^" syntaxes)))
5066 (skip-syntax-backward syntaxes) (setq start (point))
d7c64071 5067 (goto-char oldpoint)
0f7df535
RS
5068 (skip-syntax-forward syntaxes) (setq end (point))
5069 (when (and (eq start oldpoint) (eq end oldpoint)
5070 ;; Point is neither within nor adjacent to a word.
5071 (not strict))
5072 ;; Look for preceding word in same line.
9b026d9f 5073 (skip-syntax-backward not-syntaxes (line-beginning-position))
0f7df535
RS
5074 (if (bolp)
5075 ;; No preceding word in same line.
5076 ;; Look for following word in same line.
5077 (progn
9b026d9f 5078 (skip-syntax-forward not-syntaxes (line-end-position))
0f7df535
RS
5079 (setq start (point))
5080 (skip-syntax-forward syntaxes)
5081 (setq end (point)))
5082 (setq end (point))
5083 (skip-syntax-backward syntaxes)
5084 (setq start (point))))
5085 ;; If we found something nonempty, return it as a string.
5086 (unless (= start end)
020db25f 5087 (buffer-substring-no-properties start end)))))
2d88b556 5088\f
69c1dd37 5089(defcustom fill-prefix nil
1d2b0303 5090 "String for filling to insert at front of new line, or nil for none."
69c1dd37
RS
5091 :type '(choice (const :tag "None" nil)
5092 string)
5093 :group 'fill)
2076c87c 5094(make-variable-buffer-local 'fill-prefix)
f31b1257 5095(put 'fill-prefix 'safe-local-variable 'string-or-null-p)
2076c87c 5096
69c1dd37 5097(defcustom auto-fill-inhibit-regexp nil
1d2b0303 5098 "Regexp to match lines which should not be auto-filled."
69c1dd37
RS
5099 :type '(choice (const :tag "None" nil)
5100 regexp)
5101 :group 'fill)
2076c87c 5102
dbe524b6 5103;; This function is used as the auto-fill-function of a buffer
e2504204
KH
5104;; when Auto-Fill mode is enabled.
5105;; It returns t if it really did any work.
dbe524b6
RS
5106;; (Actually some major modes use a different auto-fill function,
5107;; but this one is the default one.)
2076c87c 5108(defun do-auto-fill ()
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
a31ca314 5715(define-mail-user-agent 'sendmail-user-agent
34fbcdf3 5716 'sendmail-user-agent-compose
a31ca314
RS
5717 'mail-send-and-exit)
5718
360b5483
RS
5719(defun rfc822-goto-eoh ()
5720 ;; Go to header delimiter line in a mail message, following RFC822 rules
5721 (goto-char (point-min))
e1e04350
SM
5722 (when (re-search-forward
5723 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
5724 (goto-char (match-beginning 0))))
360b5483 5725
34fbcdf3
RS
5726(defun sendmail-user-agent-compose (&optional to subject other-headers continue
5727 switch-function yank-action
5728 send-actions)
5729 (if switch-function
5730 (let ((special-display-buffer-names nil)
5731 (special-display-regexps nil)
5732 (same-window-buffer-names nil)
5733 (same-window-regexps nil))
5734 (funcall switch-function "*mail*")))
6b61353c
KH
5735 (let ((cc (cdr (assoc-string "cc" other-headers t)))
5736 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
5737 (body (cdr (assoc-string "body" other-headers t))))
34fbcdf3
RS
5738 (or (mail continue to subject in-reply-to cc yank-action send-actions)
5739 continue
5740 (error "Message aborted"))
5741 (save-excursion
360b5483 5742 (rfc822-goto-eoh)
34fbcdf3 5743 (while other-headers
0740c738
GM
5744 (unless (member-ignore-case (car (car other-headers))
5745 '("in-reply-to" "cc" "body"))
34fbcdf3 5746 (insert (car (car other-headers)) ": "
15575807
CY
5747 (cdr (car other-headers))
5748 (if use-hard-newlines hard-newline "\n")))
34fbcdf3 5749 (setq other-headers (cdr other-headers)))
0740c738
GM
5750 (when body
5751 (forward-line 1)
5752 (insert body))
34fbcdf3
RS
5753 t)))
5754
d0008a00
RS
5755(defun compose-mail (&optional to subject other-headers continue
5756 switch-function yank-action send-actions)
5757 "Start composing a mail message to send.
5758This uses the user's chosen mail composition package
5759as selected with the variable `mail-user-agent'.
5760The optional arguments TO and SUBJECT specify recipients
5761and the initial Subject field, respectively.
5762
5763OTHER-HEADERS is an alist specifying additional
5764header fields. Elements look like (HEADER . VALUE) where both
5765HEADER and VALUE are strings.
5766
5767CONTINUE, if non-nil, says to continue editing a message already
9dda5b0e 5768being composed. Interactively, CONTINUE is the prefix argument.
d0008a00
RS
5769
5770SWITCH-FUNCTION, if non-nil, is a function to use to
5771switch to and display the buffer used for mail composition.
5772
5773YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
06720de2
RS
5774to insert the raw text of the message being replied to.
5775It has the form (FUNCTION . ARGS). The user agent will apply
5776FUNCTION to ARGS, to insert the raw text of the original message.
5777\(The user agent will also run `mail-citation-hook', *after* the
5778original text has been inserted in this way.)
d0008a00
RS
5779
5780SEND-ACTIONS is a list of actions to call when the message is sent.
5781Each action has the form (FUNCTION . ARGS)."
b5f019be
RS
5782 (interactive
5783 (list nil nil nil current-prefix-arg))
3d68fa99
CY
5784
5785 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5786 ;; from sendmail-user-agent to message-user-agent. Some users may
5787 ;; encounter incompatibilities. This hack tries to detect problems
5788 ;; and warn about them.
5789 (and compose-mail-user-agent-warnings
5790 (eq mail-user-agent 'message-user-agent)
5791 (let (warn-vars)
5792 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5793 mail-yank-hooks mail-archive-file-name
5794 mail-default-reply-to mail-mailing-lists
5e1d4968 5795 mail-self-blind))
3d68fa99
CY
5796 (and (boundp var)
5797 (symbol-value var)
5798 (push var warn-vars)))
5799 (when warn-vars
5800 (display-warning 'mail
5801 (format "\
5802The default mail mode is now Message mode.
5803You have the following Mail mode variable%s customized:
5804\n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
7f0b7b3e 5805To disable this warning, set `compose-mail-user-agent-warnings' to nil."
3d68fa99
CY
5806 (if (> (length warn-vars) 1) "s" "")
5807 (mapconcat 'symbol-name
5808 warn-vars " "))))))
5809
676b1a74
CY
5810 (let ((function (get mail-user-agent 'composefunc)))
5811 (funcall function to subject other-headers continue
5812 switch-function yank-action send-actions)))
b5f019be
RS
5813
5814(defun compose-mail-other-window (&optional to subject other-headers continue
5815 yank-action send-actions)
5816 "Like \\[compose-mail], but edit the outgoing message in another window."
5817 (interactive
5818 (list nil nil nil current-prefix-arg))
5819 (compose-mail to subject other-headers continue
5820 'switch-to-buffer-other-window yank-action send-actions))
5821
5822
5823(defun compose-mail-other-frame (&optional to subject other-headers continue
5824 yank-action send-actions)
5825 "Like \\[compose-mail], but edit the outgoing message in another frame."
5826 (interactive
5827 (list nil nil nil current-prefix-arg))
5828 (compose-mail to subject other-headers continue
5829 'switch-to-buffer-other-frame yank-action send-actions))
56abefac 5830\f
610c1c68 5831(defvar set-variable-value-history nil
987ec16d
EZ
5832 "History of values entered with `set-variable'.
5833
5834Maximum length of the history list is determined by the value
5835of `history-length', which see.")
610c1c68 5836
d6281b4e 5837(defun set-variable (variable value &optional make-local)
610c1c68 5838 "Set VARIABLE to VALUE. VALUE is a Lisp object.
d6281b4e
RS
5839VARIABLE should be a user option variable name, a Lisp variable
5840meant to be customized by users. You should enter VALUE in Lisp syntax,
5841so if you want VALUE to be a string, you must surround it with doublequotes.
610c1c68
RS
5842VALUE is used literally, not evaluated.
5843
5844If VARIABLE has a `variable-interactive' property, that is used as if
5845it were the arg to `interactive' (which see) to interactively read VALUE.
5846
5847If VARIABLE has been defined with `defcustom', then the type information
16236388
RS
5848in the definition is used to check that VALUE is valid.
5849
5850With a prefix argument, set VARIABLE to VALUE buffer-locally."
e9dfb72e
RS
5851 (interactive
5852 (let* ((default-var (variable-at-point))
7fd0ef0d
JL
5853 (var (if (user-variable-p default-var)
5854 (read-variable (format "Set variable (default %s): " default-var)
5855 default-var)
5856 (read-variable "Set variable: ")))
6b61353c
KH
5857 (minibuffer-help-form '(describe-variable var))
5858 (prop (get var 'variable-interactive))
0684376b
JB
5859 (obsolete (car (get var 'byte-obsolete-variable)))
5860 (prompt (format "Set %s %s to value: " var
6b61353c 5861 (cond ((local-variable-p var)
0684376b 5862 "(buffer-local)")
6b61353c
KH
5863 ((or current-prefix-arg
5864 (local-variable-if-set-p var))
0684376b
JB
5865 "buffer-locally")
5866 (t "globally"))))
5867 (val (progn
5868 (when obsolete
5869 (message (concat "`%S' is obsolete; "
5870 (if (symbolp obsolete) "use `%S' instead" "%s"))
5871 var obsolete)
5872 (sit-for 3))
5873 (if prop
5874 ;; Use VAR's `variable-interactive' property
5875 ;; as an interactive spec for prompting.
5876 (call-interactively `(lambda (arg)
5877 (interactive ,prop)
5878 arg))
5879 (read
5880 (read-string prompt nil
7fd0ef0d
JL
5881 'set-variable-value-history
5882 (format "%S" (symbol-value var))))))))
6b61353c 5883 (list var val current-prefix-arg)))
610c1c68 5884
d6281b4e
RS
5885 (and (custom-variable-p variable)
5886 (not (get variable 'custom-type))
5887 (custom-load-symbol variable))
5888 (let ((type (get variable 'custom-type)))
610c1c68
RS
5889 (when type
5890 ;; Match with custom type.
36755dd9 5891 (require 'cus-edit)
610c1c68 5892 (setq type (widget-convert type))
d6281b4e 5893 (unless (widget-apply type :match value)
1e722f9f 5894 (error "Value `%S' does not match type %S of %S"
d6281b4e 5895 value (car type) variable))))
16236388
RS
5896
5897 (if make-local
d6281b4e 5898 (make-local-variable variable))
f1180544 5899
d6281b4e 5900 (set variable value)
a2aef080
GM
5901
5902 ;; Force a thorough redisplay for the case that the variable
5903 ;; has an effect on the display, like `tab-width' has.
5904 (force-mode-line-update))
56abefac 5905\f
e8a700bf
RS
5906;; Define the major mode for lists of completions.
5907
e2947429
SM
5908(defvar completion-list-mode-map
5909 (let ((map (make-sparse-keymap)))
5910 (define-key map [mouse-2] 'mouse-choose-completion)
5911 (define-key map [follow-link] 'mouse-face)
5912 (define-key map [down-mouse-2] nil)
5913 (define-key map "\C-m" 'choose-completion)
5914 (define-key map "\e\e\e" 'delete-completion-window)
5915 (define-key map [left] 'previous-completion)
5916 (define-key map [right] 'next-completion)
45f8cb0c 5917 (define-key map "q" 'quit-window)
e2947429 5918 map)
98b45886 5919 "Local map for completion list buffers.")
e8a700bf
RS
5920
5921;; Completion mode is suitable only for specially formatted data.
ac29eb79 5922(put 'completion-list-mode 'mode-class 'special)
e8a700bf 5923
98b45886
RS
5924(defvar completion-reference-buffer nil
5925 "Record the buffer that was current when the completion list was requested.
5926This is a local variable in the completion list buffer.
ec39964e 5927Initial value is nil to avoid some compiler warnings.")
3819736b 5928
83434bda
RS
5929(defvar completion-no-auto-exit nil
5930 "Non-nil means `choose-completion-string' should never exit the minibuffer.
f6714ede 5931This also applies to other functions such as `choose-completion'.")
83434bda 5932
d5e63715
SM
5933(defvar completion-base-position nil
5934 "Position of the base of the text corresponding to the shown completions.
5935This variable is used in the *Completions* buffers.
5936Its value is a list of the form (START END) where START is the place
5937where the completion should be inserted and END (if non-nil) is the end
5938of the text to replace. If END is nil, point is used instead.")
5939
98b45886 5940(defvar completion-base-size nil
3c59150d
CY
5941 "Number of chars before point not involved in completion.
5942This is a local variable in the completion list buffer.
5943It refers to the chars in the minibuffer if completing in the
5944minibuffer, or in `completion-reference-buffer' otherwise.
5945Only characters in the field at point are included.
5946
5947If nil, Emacs determines which part of the tail end of the
5948buffer's text is involved in completion by comparing the text
5949directly.")
d5e63715 5950(make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
f6b293e3 5951
1c6c6fde
RS
5952(defun delete-completion-window ()
5953 "Delete the completion list window.
5954Go to the window from which completion was requested."
5955 (interactive)
5956 (let ((buf completion-reference-buffer))
ddb2b181
RS
5957 (if (one-window-p t)
5958 (if (window-dedicated-p (selected-window))
5959 (delete-frame (selected-frame)))
5960 (delete-window (selected-window))
5961 (if (get-buffer-window buf)
5962 (select-window (get-buffer-window buf))))))
1c6c6fde 5963
dde69dbe
RS
5964(defun previous-completion (n)
5965 "Move to the previous item in the completion list."
5966 (interactive "p")
5967 (next-completion (- n)))
5968
5969(defun next-completion (n)
5970 "Move to the next item in the completion list.
1f238ac2 5971With prefix argument N, move N items (negative N means move backward)."
dde69dbe 5972 (interactive "p")
58dd38f1
SM
5973 (let ((beg (point-min)) (end (point-max)))
5974 (while (and (> n 0) (not (eobp)))
dde69dbe 5975 ;; If in a completion, move to the end of it.
58dd38f1
SM
5976 (when (get-text-property (point) 'mouse-face)
5977 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe 5978 ;; Move to start of next one.
58dd38f1
SM
5979 (unless (get-text-property (point) 'mouse-face)
5980 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5981 (setq n (1- n)))
5982 (while (and (< n 0) (not (bobp)))
5983 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5984 ;; If in a completion, move to the start of it.
5985 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
b61a81c2 5986 (goto-char (previous-single-property-change
58dd38f1
SM
5987 (point) 'mouse-face nil beg)))
5988 ;; Move to end of the previous completion.
5989 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5990 (goto-char (previous-single-property-change
5991 (point) 'mouse-face nil beg)))
5992 ;; Move to the start of that one.
5993 (goto-char (previous-single-property-change
5994 (point) 'mouse-face nil beg))
5995 (setq n (1+ n))))))
dde69dbe 5996
d5e63715
SM
5997(defun choose-completion (&optional event)
5998 "Choose the completion at point."
5999 (interactive (list last-nonmenu-event))
6000 ;; In case this is run via the mouse, give temporary modes such as
6001 ;; isearch a chance to turn off.
6002 (run-hooks 'mouse-leave-buffer-hook)
6003 (let (buffer base-size base-position choice)
6004 (with-current-buffer (window-buffer (posn-window (event-start event)))
6005 (setq buffer completion-reference-buffer)
6006 (setq base-size completion-base-size)
6007 (setq base-position completion-base-position)
6008 (save-excursion
6009 (goto-char (posn-point (event-start event)))
6010 (let (beg end)
6011 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
6012 (setq end (point) beg (1+ (point))))
6013 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
6014 (setq end (1- (point)) beg (point)))
6015 (if (null beg)
6016 (error "No completion here"))
6017 (setq beg (previous-single-property-change beg 'mouse-face))
6018 (setq end (or (next-single-property-change end 'mouse-face)
6019 (point-max)))
6020 (setq choice (buffer-substring-no-properties beg end)))))
6021
ab63960f 6022 (let ((owindow (selected-window)))
d5e63715 6023 (select-window (posn-window (event-start event)))
ab63960f 6024 (if (and (one-window-p t 'selected-frame)
d5e63715 6025 (window-dedicated-p (selected-window)))
ab63960f
RS
6026 ;; This is a special buffer's frame
6027 (iconify-frame (selected-frame))
6028 (or (window-dedicated-p (selected-window))
6029 (bury-buffer)))
8a7daef5
CY
6030 (select-window
6031 (or (and (buffer-live-p buffer)
d5e63715 6032 (get-buffer-window buffer 0))
8a7daef5 6033 owindow)))
f6714ede 6034
d5e63715
SM
6035 (choose-completion-string
6036 choice buffer
6037 (or base-position
6038 (when base-size
6039 ;; Someone's using old completion code that doesn't know
6040 ;; about base-position yet.
6041 (list (+ base-size (with-current-buffer buffer (field-beginning)))))
6042 ;; If all else fails, just guess.
6043 (with-current-buffer buffer
6044 (list (choose-completion-guess-base-position choice)))))))
80298193
RS
6045
6046;; Delete the longest partial match for STRING
6047;; that can be found before POINT.
d5e63715
SM
6048(defun choose-completion-guess-base-position (string)
6049 (save-excursion
6050 (let ((opoint (point))
6051 len)
6052 ;; Try moving back by the length of the string.
6053 (goto-char (max (- (point) (length string))
6054 (minibuffer-prompt-end)))
6055 ;; See how far back we were actually able to move. That is the
6056 ;; upper bound on how much we can match and delete.
6057 (setq len (- opoint (point)))
6058 (if completion-ignore-case
6059 (setq string (downcase string)))
6060 (while (and (> len 0)
6061 (let ((tail (buffer-substring (point) opoint)))
6062 (if completion-ignore-case
6063 (setq tail (downcase tail)))
6064 (not (string= tail (substring string 0 len)))))
6065 (setq len (1- len))
6066 (forward-char 1))
6067 (point))))
6068
80298193 6069(defun choose-completion-delete-max-match (string)
d5e63715
SM
6070 (delete-region (choose-completion-guess-base-position string) (point)))
6071(make-obsolete 'choose-completion-delete-max-match
6072 'choose-completion-guess-base-position "23.2")
80298193 6073
ba36181b 6074(defvar choose-completion-string-functions nil
bbbbb15b
KS
6075 "Functions that may override the normal insertion of a completion choice.
6076These functions are called in order with four arguments:
6077CHOICE - the string to insert in the buffer,
6078BUFFER - the buffer in which the choice should be inserted,
4837b516 6079MINI-P - non-nil if BUFFER is a minibuffer, and
12829a07
RS
6080BASE-SIZE - the number of characters in BUFFER before
6081the string being completed.
6082
bbbbb15b
KS
6083If a function in the list returns non-nil, that function is supposed
6084to have inserted the CHOICE in the BUFFER, and possibly exited
12829a07 6085the minibuffer; no further functions will be called.
ba36181b 6086
12829a07
RS
6087If all functions in the list return nil, that means to use
6088the default method of inserting the completion in BUFFER.")
74d0290b 6089
d5e63715 6090(defun choose-completion-string (choice &optional buffer base-position)
12829a07 6091 "Switch to BUFFER and insert the completion choice CHOICE.
d5e63715 6092BASE-POSITION, says where to insert the completion."
12829a07
RS
6093
6094 ;; If BUFFER is the minibuffer, exit the minibuffer
6095 ;; unless it is reading a file name and CHOICE is a directory,
6096 ;; or completion-no-auto-exit is non-nil.
6097
d5e63715
SM
6098 ;; Some older code may call us passing `base-size' instead of
6099 ;; `base-position'. It's difficult to make any use of `base-size',
6100 ;; so we just ignore it.
6101 (unless (consp base-position)
6102 (message "Obsolete `base-size' passed to choose-completion-string")
6103 (setq base-position nil))
6104
1a0d0b6a
JPW
6105 (let* ((buffer (or buffer completion-reference-buffer))
6106 (mini-p (minibufferp buffer)))
cf52ad58
RS
6107 ;; If BUFFER is a minibuffer, barf unless it's the currently
6108 ;; active minibuffer.
f436a90a 6109 (if (and mini-p
45486731
RS
6110 (or (not (active-minibuffer-window))
6111 (not (equal buffer
6112 (window-buffer (active-minibuffer-window))))))
cf52ad58 6113 (error "Minibuffer is not active for completion")
17aa3385
KS
6114 ;; Set buffer so buffer-local choose-completion-string-functions works.
6115 (set-buffer buffer)
f1180544 6116 (unless (run-hook-with-args-until-success
d99f8496 6117 'choose-completion-string-functions
d5e63715
SM
6118 ;; The fourth arg used to be `mini-p' but was useless
6119 ;; (since minibufferp can be used on the `buffer' arg)
6120 ;; and indeed unused. The last used to be `base-size', so we
6121 ;; keep it to try and avoid breaking old code.
6122 choice buffer base-position nil)
d99f8496 6123 ;; Insert the completion into the buffer where it was requested.
d5e63715
SM
6124 (delete-region (or (car base-position) (point))
6125 (or (cadr base-position) (point)))
bbbbb15b
KS
6126 (insert choice)
6127 (remove-text-properties (- (point) (length choice)) (point)
6128 '(mouse-face nil))
6129 ;; Update point in the window that BUFFER is showing in.
6130 (let ((window (get-buffer-window buffer t)))
6131 (set-window-point window (point)))
6132 ;; If completing for the minibuffer, exit it with this choice.
6133 (and (not completion-no-auto-exit)
6138158d 6134 (minibufferp buffer)
bbbbb15b
KS
6135 minibuffer-completion-table
6136 ;; If this is reading a file name, and the file name chosen
6137 ;; is a directory, don't exit the minibuffer.
85be9ec4
SM
6138 (let* ((result (buffer-substring (field-beginning) (point)))
6139 (bounds
6140 (completion-boundaries result minibuffer-completion-table
6141 minibuffer-completion-predicate
6142 "")))
6143 (if (eq (car bounds) (length result))
6144 ;; The completion chosen leads to a new set of completions
6145 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6146 (let ((mini (active-minibuffer-window)))
6147 (select-window mini)
6148 (when minibuffer-auto-raise
6149 (raise-frame (window-frame mini))))
6150 (exit-minibuffer))))))))
80298193 6151
e2947429 6152(define-derived-mode completion-list-mode nil "Completion List"
e8a700bf 6153 "Major mode for buffers showing lists of possible completions.
80298193
RS
6154Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
6155 to select the completion near point.
6156Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3a77346c
GM
6157 with the mouse.
6158
6159\\{completion-list-mode-map}"
e2947429 6160 (set (make-local-variable 'completion-base-size) nil))
e8a700bf 6161
c8d6d636
GM
6162(defun completion-list-mode-finish ()
6163 "Finish setup of the completions buffer.
6164Called from `temp-buffer-show-hook'."
6165 (when (eq major-mode 'completion-list-mode)
6166 (toggle-read-only 1)))
6167
6168(add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6169
f5fab556
MY
6170
6171;; Variables and faces used in `completion-setup-function'.
747a0e2f 6172
d0fd0916
JPW
6173(defcustom completion-show-help t
6174 "Non-nil means show help message in *Completions* buffer."
6175 :type 'boolean
6176 :version "22.1"
6177 :group 'completion)
6178
f5fab556
MY
6179;; This function goes in completion-setup-hook, so that it is called
6180;; after the text of the completion list buffer is written.
e8a700bf 6181(defun completion-setup-function ()
1b5fd09e 6182 (let* ((mainbuf (current-buffer))
a9e3ff69
SM
6183 (base-dir
6184 ;; When reading a file name in the minibuffer,
6185 ;; try and find the right default-directory to set in the
6186 ;; completion list buffer.
6187 ;; FIXME: Why do we do that, actually? --Stef
6188 (if minibuffer-completing-file-name
6189 (file-name-as-directory
6190 (expand-file-name
6191 (substring (minibuffer-completion-contents)
6192 0 (or completion-base-size 0)))))))
621a3f62 6193 (with-current-buffer standard-output
d5e63715
SM
6194 (let ((base-size completion-base-size) ;Read before killing localvars.
6195 (base-position completion-base-position))
e2947429 6196 (completion-list-mode)
d5e63715
SM
6197 (set (make-local-variable 'completion-base-size) base-size)
6198 (set (make-local-variable 'completion-base-position) base-position))
1b5fd09e 6199 (set (make-local-variable 'completion-reference-buffer) mainbuf)
a9e3ff69 6200 (if base-dir (setq default-directory base-dir))
d0fd0916
JPW
6201 ;; Maybe insert help string.
6202 (when completion-show-help
6203 (goto-char (point-min))
6204 (if (display-mouse-p)
6205 (insert (substitute-command-keys
6206 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
6207 (insert (substitute-command-keys
6208 "In this buffer, type \\[choose-completion] to \
6209select the completion near point.\n\n"))))))
c88ab9ce 6210
e8a700bf 6211(add-hook 'completion-setup-hook 'completion-setup-function)
dde69dbe 6212
1b5fd09e
SM
6213(define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6214(define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
dde69dbe
RS
6215
6216(defun switch-to-completions ()
6217 "Select the completion list window."
6218 (interactive)
ab14d7d5 6219 (let ((window (or (get-buffer-window "*Completions*" 0)
042b7cc6 6220 ;; Make sure we have a completions window.
ab14d7d5
SM
6221 (progn (minibuffer-completion-help)
6222 (get-buffer-window "*Completions*" 0)))))
fdbd7c4d
KH
6223 (when window
6224 (select-window window)
042b7cc6
JL
6225 ;; In the new buffer, go to the first completion.
6226 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6227 (when (bobp)
6228 (next-completion 1)))))
f6039de6
JL
6229\f
6230;;; Support keyboard commands to turn on various modifiers.
82072f33
RS
6231
6232;; These functions -- which are not commands -- each add one modifier
6233;; to the following event.
6234
6235(defun event-apply-alt-modifier (ignore-prompt)
1e96c007 6236 "\\<function-key-map>Add the Alt modifier to the following event.
70cf9f08 6237For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
82072f33
RS
6238 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6239(defun event-apply-super-modifier (ignore-prompt)
1e96c007 6240 "\\<function-key-map>Add the Super modifier to the following event.
70cf9f08 6241For example, type \\[event-apply-super-modifier] & to enter Super-&."
82072f33
RS
6242 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6243(defun event-apply-hyper-modifier (ignore-prompt)
1e96c007 6244 "\\<function-key-map>Add the Hyper modifier to the following event.
70cf9f08 6245For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
82072f33
RS
6246 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6247(defun event-apply-shift-modifier (ignore-prompt)
1e96c007 6248 "\\<function-key-map>Add the Shift modifier to the following event.
70cf9f08 6249For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
82072f33
RS
6250 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6251(defun event-apply-control-modifier (ignore-prompt)
1e96c007 6252 "\\<function-key-map>Add the Ctrl modifier to the following event.
70cf9f08 6253For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
82072f33
RS
6254 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6255(defun event-apply-meta-modifier (ignore-prompt)
1e96c007 6256 "\\<function-key-map>Add the Meta modifier to the following event.
70cf9f08 6257For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
82072f33
RS
6258 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6259
6260(defun event-apply-modifier (event symbol lshiftby prefix)
6261 "Apply a modifier flag to event EVENT.
6262SYMBOL is the name of this modifier, as a symbol.
6263LSHIFTBY is the numeric value of this modifier, in keyboard events.
6264PREFIX is the string that represents this modifier in an event type symbol."
6265 (if (numberp event)
6266 (cond ((eq symbol 'control)
90bebcb0
KH
6267 (if (and (<= (downcase event) ?z)
6268 (>= (downcase event) ?a))
82072f33 6269 (- (downcase event) ?a -1)
90bebcb0
KH
6270 (if (and (<= (downcase event) ?Z)
6271 (>= (downcase event) ?A))
82072f33
RS
6272 (- (downcase event) ?A -1)
6273 (logior (lsh 1 lshiftby) event))))
6274 ((eq symbol 'shift)
6275 (if (and (<= (downcase event) ?z)
6276 (>= (downcase event) ?a))
6277 (upcase event)
6278 (logior (lsh 1 lshiftby) event)))
6279 (t
6280 (logior (lsh 1 lshiftby) event)))
6281 (if (memq symbol (event-modifiers event))
6282 event
6283 (let ((event-type (if (symbolp event) event (car event))))
6284 (setq event-type (intern (concat prefix (symbol-name event-type))))
6285 (if (symbolp event)
6286 event-type
6287 (cons event-type (cdr event)))))))
6288
e5fff738
KH
6289(define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6290(define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6291(define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6292(define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6293(define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6294(define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
f6039de6 6295\f
a3d1480b
JB
6296;;;; Keypad support.
6297
9b77469a
SM
6298;; Make the keypad keys act like ordinary typing keys. If people add
6299;; bindings for the function key symbols, then those bindings will
6300;; override these, so this shouldn't interfere with any existing
6301;; bindings.
a3d1480b 6302
0d173134 6303;; Also tell read-char how to handle these keys.
e1e04350 6304(mapc
a3d1480b
JB
6305 (lambda (keypad-normal)
6306 (let ((keypad (nth 0 keypad-normal))
6307 (normal (nth 1 keypad-normal)))
0d173134 6308 (put keypad 'ascii-character normal)
a3d1480b
JB
6309 (define-key function-key-map (vector keypad) (vector normal))))
6310 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6311 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
f33321ad 6312 (kp-space ?\s)
a3d1480b
JB
6313 (kp-tab ?\t)
6314 (kp-enter ?\r)
6315 (kp-multiply ?*)
6316 (kp-add ?+)
6317 (kp-separator ?,)
6318 (kp-subtract ?-)
6319 (kp-decimal ?.)
6320 (kp-divide ?/)
31cd2dd4
SM
6321 (kp-equal ?=)
6322 ;; Do the same for various keys that are represented as symbols under
6323 ;; GUIs but naturally correspond to characters.
6324 (backspace 127)
6325 (delete 127)
6326 (tab ?\t)
6327 (linefeed ?\n)
6328 (clear ?\C-l)
6329 (return ?\C-m)
6330 (escape ?\e)
6331 ))
f54b0d85 6332\f
1e722f9f 6333;;;;
b005abd5 6334;;;; forking a twin copy of a buffer.
1e722f9f 6335;;;;
b005abd5
SM
6336
6337(defvar clone-buffer-hook nil
6338 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6339
64663f06
SM
6340(defvar clone-indirect-buffer-hook nil
6341 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6342
b005abd5
SM
6343(defun clone-process (process &optional newname)
6344 "Create a twin copy of PROCESS.
6345If NEWNAME is nil, it defaults to PROCESS' name;
6346NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6347If PROCESS is associated with a buffer, the new process will be associated
6348 with the current buffer instead.
6349Returns nil if PROCESS has already terminated."
6350 (setq newname (or newname (process-name process)))
6351 (if (string-match "<[0-9]+>\\'" newname)
6352 (setq newname (substring newname 0 (match-beginning 0))))
6353 (when (memq (process-status process) '(run stop open))
6354 (let* ((process-connection-type (process-tty-name process))
b005abd5
SM
6355 (new-process
6356 (if (memq (process-status process) '(open))
ed7069af
KS
6357 (let ((args (process-contact process t)))
6358 (setq args (plist-put args :name newname))
6359 (setq args (plist-put args :buffer
403ca8d9
KS
6360 (if (process-buffer process)
6361 (current-buffer))))
ed7069af 6362 (apply 'make-network-process args))
b005abd5
SM
6363 (apply 'start-process newname
6364 (if (process-buffer process) (current-buffer))
6365 (process-command process)))))
ed7069af
KS
6366 (set-process-query-on-exit-flag
6367 new-process (process-query-on-exit-flag process))
b005abd5
SM
6368 (set-process-inherit-coding-system-flag
6369 new-process (process-inherit-coding-system-flag process))
6370 (set-process-filter new-process (process-filter process))
6371 (set-process-sentinel new-process (process-sentinel process))
403ca8d9 6372 (set-process-plist new-process (copy-sequence (process-plist process)))
b005abd5
SM
6373 new-process)))
6374
b75b82ab 6375;; things to maybe add (currently partly covered by `funcall mode'):
b005abd5
SM
6376;; - syntax-table
6377;; - overlays
6378(defun clone-buffer (&optional newname display-flag)
6b61353c
KH
6379 "Create and return a twin copy of the current buffer.
6380Unlike an indirect buffer, the new buffer can be edited
6381independently of the old one (if it is not read-only).
6382NEWNAME is the name of the new buffer. It may be modified by
6383adding or incrementing <N> at the end as necessary to create a
6384unique buffer name. If nil, it defaults to the name of the
6385current buffer, with the proper suffix. If DISPLAY-FLAG is
6386non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6387clone a file-visiting buffer, or a buffer whose major mode symbol
6388has a non-nil `no-clone' property, results in an error.
6389
6390Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6391current buffer with appropriate suffix. However, if a prefix
6392argument is given, then the command prompts for NEWNAME in the
6393minibuffer.
b005abd5 6394
b005abd5
SM
6395This runs the normal hook `clone-buffer-hook' in the new buffer
6396after it has been set up properly in other respects."
61acfe7f
RS
6397 (interactive
6398 (progn
6399 (if buffer-file-name
6400 (error "Cannot clone a file-visiting buffer"))
6401 (if (get major-mode 'no-clone)
6402 (error "Cannot clone a buffer in %s mode" mode-name))
f6039de6
JL
6403 (list (if current-prefix-arg
6404 (read-buffer "Name of new cloned buffer: " (current-buffer)))
61acfe7f 6405 t)))
b005abd5
SM
6406 (if buffer-file-name
6407 (error "Cannot clone a file-visiting buffer"))
6408 (if (get major-mode 'no-clone)
6409 (error "Cannot clone a buffer in %s mode" mode-name))
6410 (setq newname (or newname (buffer-name)))
6411 (if (string-match "<[0-9]+>\\'" newname)
6412 (setq newname (substring newname 0 (match-beginning 0))))
6413 (let ((buf (current-buffer))
6414 (ptmin (point-min))
6415 (ptmax (point-max))
6416 (pt (point))
6417 (mk (if mark-active (mark t)))
6418 (modified (buffer-modified-p))
6419 (mode major-mode)
6420 (lvars (buffer-local-variables))
6421 (process (get-buffer-process (current-buffer)))
6422 (new (generate-new-buffer (or newname (buffer-name)))))
6423 (save-restriction
6424 (widen)
6425 (with-current-buffer new
6426 (insert-buffer-substring buf)))
6427 (with-current-buffer new
6428 (narrow-to-region ptmin ptmax)
6429 (goto-char pt)
6430 (if mk (set-mark mk))
6431 (set-buffer-modified-p modified)
6432
6433 ;; Clone the old buffer's process, if any.
6434 (when process (clone-process process))
6435
6436 ;; Now set up the major mode.
6437 (funcall mode)
6438
6439 ;; Set up other local variables.
9ca2204b
JB
6440 (mapc (lambda (v)
6441 (condition-case () ;in case var is read-only
6442 (if (symbolp v)
6443 (makunbound v)
6444 (set (make-local-variable (car v)) (cdr v)))
6445 (error nil)))
6446 lvars)
b005abd5
SM
6447
6448 ;; Run any hooks (typically set up by the major mode
6449 ;; for cloning to work properly).
6450 (run-hooks 'clone-buffer-hook))
0a487199
SM
6451 (if display-flag
6452 ;; Presumably the current buffer is shown in the selected frame, so
6453 ;; we want to display the clone elsewhere.
6454 (let ((same-window-regexps nil)
6455 (same-window-buffer-names))
6456 (pop-to-buffer new)))
b005abd5
SM
6457 new))
6458
fa65f20b 6459
7e3afb04 6460(defun clone-indirect-buffer (newname display-flag &optional norecord)
fa65f20b
GM
6461 "Create an indirect buffer that is a twin copy of the current buffer.
6462
01ba9662 6463Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
fa65f20b
GM
6464from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6465or if not called with a prefix arg, NEWNAME defaults to the current
6466buffer's name. The name is modified by adding a `<N>' suffix to it
1d2b0303
JB
6467or by incrementing the N in an existing suffix. Trying to clone a
6468buffer whose major mode symbol has a non-nil `no-clone-indirect'
6469property results in an error.
fa65f20b
GM
6470
6471DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7e3afb04
GM
6472This is always done when called interactively.
6473
f33321ad 6474Optional third arg NORECORD non-nil means do not put this buffer at the
7e3afb04 6475front of the list of recently selected ones."
61acfe7f
RS
6476 (interactive
6477 (progn
6478 (if (get major-mode 'no-clone-indirect)
6479 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6480 (list (if current-prefix-arg
f6039de6 6481 (read-buffer "Name of indirect buffer: " (current-buffer)))
61acfe7f
RS
6482 t)))
6483 (if (get major-mode 'no-clone-indirect)
6484 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
fa65f20b
GM
6485 (setq newname (or newname (buffer-name)))
6486 (if (string-match "<[0-9]+>\\'" newname)
6487 (setq newname (substring newname 0 (match-beginning 0))))
6488 (let* ((name (generate-new-buffer-name newname))
6489 (buffer (make-indirect-buffer (current-buffer) name t)))
64663f06
SM
6490 (with-current-buffer buffer
6491 (run-hooks 'clone-indirect-buffer-hook))
fa65f20b 6492 (when display-flag
58dd38f1 6493 (pop-to-buffer buffer norecord))
fa65f20b
GM
6494 buffer))
6495
6496
1fffd65f
RS
6497(defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6498 "Like `clone-indirect-buffer' but display in another window."
2ef0a47e
RS
6499 (interactive
6500 (progn
6501 (if (get major-mode 'no-clone-indirect)
6502 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6503 (list (if current-prefix-arg
f6039de6 6504 (read-buffer "Name of indirect buffer: " (current-buffer)))
2ef0a47e 6505 t)))
acd39eb6 6506 (let ((pop-up-windows t))
1fffd65f 6507 (clone-indirect-buffer newname display-flag norecord)))
7e3afb04 6508
f54b0d85 6509\f
1d4b11bf
GM
6510;;; Handling of Backspace and Delete keys.
6511
30a2fded 6512(defcustom normal-erase-is-backspace 'maybe
3784ec80 6513 "Set the default behavior of the Delete and Backspace keys.
30a2fded
KL
6514
6515If set to t, Delete key deletes forward and Backspace key deletes
6516backward.
6517
6518If set to nil, both Delete and Backspace keys delete backward.
6519
6520If set to 'maybe (which is the default), Emacs automatically
3784ec80 6521selects a behavior. On window systems, the behavior depends on
30a2fded
KL
6522the keyboard used. If the keyboard has both a Backspace key and
6523a Delete key, and both are mapped to their usual meanings, the
6524option's default value is set to t, so that Backspace can be used
6525to delete backward, and Delete can be used to delete forward.
6526
6527If not running under a window system, customizing this option
6528accomplishes a similar effect by mapping C-h, which is usually
6529generated by the Backspace key, to DEL, and by mapping DEL to C-d
6530via `keyboard-translate'. The former functionality of C-h is
6531available on the F1 key. You should probably not use this
6532setting if you don't have both Backspace, Delete and F1 keys.
f060b834
GM
6533
6534Setting this variable with setq doesn't take effect. Programmatically,
7f62656b 6535call `normal-erase-is-backspace-mode' (which see) instead."
30a2fded
KL
6536 :type '(choice (const :tag "Off" nil)
6537 (const :tag "Maybe" maybe)
6538 (other :tag "On" t))
1d4b11bf
GM
6539 :group 'editing-basics
6540 :version "21.1"
6541 :set (lambda (symbol value)
6542 ;; The fboundp is because of a problem with :set when
6543 ;; dumping Emacs. It doesn't really matter.
7f62656b
EZ
6544 (if (fboundp 'normal-erase-is-backspace-mode)
6545 (normal-erase-is-backspace-mode (or value 0))
1d4b11bf
GM
6546 (set-default symbol value))))
6547
30a2fded
KL
6548(defun normal-erase-is-backspace-setup-frame (&optional frame)
6549 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6550 (unless frame (setq frame (selected-frame)))
6551 (with-selected-frame frame
ed8dad6b 6552 (unless (terminal-parameter nil 'normal-erase-is-backspace)
08ea6d2f
SM
6553 (normal-erase-is-backspace-mode
6554 (if (if (eq normal-erase-is-backspace 'maybe)
6555 (and (not noninteractive)
6556 (or (memq system-type '(ms-dos windows-nt))
79cb9c05 6557 (memq window-system '(ns))
08ea6d2f
SM
6558 (and (memq window-system '(x))
6559 (fboundp 'x-backspace-delete-keys-p)
6560 (x-backspace-delete-keys-p))
6561 ;; If the terminal Emacs is running on has erase char
6562 ;; set to ^H, use the Backspace key for deleting
6563 ;; backward, and the Delete key for deleting forward.
6564 (and (null window-system)
6565 (eq tty-erase-char ?\^H))))
6566 normal-erase-is-backspace)
6567 1 0)))))
1d4b11bf 6568
80ac5d4d 6569(define-minor-mode normal-erase-is-backspace-mode
7f62656b
EZ
6570 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6571
1d2b0303 6572With numeric ARG, turn the mode on if and only if ARG is positive.
7f62656b 6573
30a2fded
KL
6574On window systems, when this mode is on, Delete is mapped to C-d
6575and Backspace is mapped to DEL; when this mode is off, both
6576Delete and Backspace are mapped to DEL. (The remapping goes via
6577`local-function-key-map', so binding Delete or Backspace in the
6578global or local keymap will override that.)
7f62656b
EZ
6579
6580In addition, on window systems, the bindings of C-Delete, M-Delete,
6581C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6582the global keymap in accordance with the functionality of Delete and
6583Backspace. For example, if Delete is remapped to C-d, which deletes
6584forward, C-Delete is bound to `kill-word', but if Delete is remapped
6585to DEL, which deletes backward, C-Delete is bound to
6586`backward-kill-word'.
6587
6588If not running on a window system, a similar effect is accomplished by
6589remapping C-h (normally produced by the Backspace key) and DEL via
6590`keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6591to C-d; if it's off, the keys are not remapped.
6592
6593When not running on a window system, and this mode is turned on, the
6594former functionality of C-h is available on the F1 key. You should
6595probably not turn on this mode on a text-only terminal if you don't
6596have both Backspace, Delete and F1 keys.
6597
6598See also `normal-erase-is-backspace'."
80ac5d4d
SM
6599 :variable (eq (terminal-parameter
6600 nil 'normal-erase-is-backspace) 1)
6601 (let ((enabled (eq 1 (terminal-parameter
6602 nil 'normal-erase-is-backspace))))
0103b7c9 6603
9e2a2647 6604 (cond ((or (memq window-system '(x w32 ns pc))
0103b7c9
KL
6605 (memq system-type '(ms-dos windows-nt)))
6606 (let* ((bindings
411c0104 6607 `(([M-delete] [M-backspace])
0103b7c9 6608 ([C-M-delete] [C-M-backspace])
28a90c44 6609 ([?\e C-delete] [?\e C-backspace])))
0103b7c9
KL
6610 (old-state (lookup-key local-function-key-map [delete])))
6611
6612 (if enabled
6613 (progn
b8a47412 6614 (define-key local-function-key-map [delete] [deletechar])
0103b7c9 6615 (define-key local-function-key-map [kp-delete] [?\C-d])
28a90c44
SM
6616 (define-key local-function-key-map [backspace] [?\C-?])
6617 (dolist (b bindings)
6618 ;; Not sure if input-decode-map is really right, but
6619 ;; keyboard-translate-table (used below) only works
6620 ;; for integer events, and key-translation-table is
6621 ;; global (like the global-map, used earlier).
6622 (define-key input-decode-map (car b) nil)
6623 (define-key input-decode-map (cadr b) nil)))
0103b7c9
KL
6624 (define-key local-function-key-map [delete] [?\C-?])
6625 (define-key local-function-key-map [kp-delete] [?\C-?])
28a90c44
SM
6626 (define-key local-function-key-map [backspace] [?\C-?])
6627 (dolist (b bindings)
6628 (define-key input-decode-map (car b) (cadr b))
6629 (define-key input-decode-map (cadr b) (car b))))))
0103b7c9
KL
6630 (t
6631 (if enabled
ec9f4754 6632 (progn
0103b7c9
KL
6633 (keyboard-translate ?\C-h ?\C-?)
6634 (keyboard-translate ?\C-? ?\C-d))
6635 (keyboard-translate ?\C-h ?\C-h)
6636 (keyboard-translate ?\C-? ?\C-?))))
6637
32226619 6638 (if (called-interactively-p 'interactive)
0103b7c9 6639 (message "Delete key deletes %s"
b08016f2 6640 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
0103b7c9 6641 "forward" "backward")))))
ea82f0df 6642\f
aca8bee5 6643(defvar vis-mode-saved-buffer-invisibility-spec nil
0f7df535 6644 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7f62656b 6645
0f7df535
RS
6646(define-minor-mode visible-mode
6647 "Toggle Visible mode.
4837b516
GM
6648With argument ARG turn Visible mode on if ARG is positive, otherwise
6649turn it off.
1d4b11bf 6650
0f7df535 6651Enabling Visible mode makes all invisible text temporarily visible.
1d2b0303
JB
6652Disabling Visible mode turns off that effect. Visible mode works by
6653saving the value of `buffer-invisibility-spec' and setting it to nil."
4e57881d 6654 :lighter " Vis"
ab77efd0 6655 :group 'editing-basics
aca8bee5
SM
6656 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6657 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6658 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
0f7df535 6659 (when visible-mode
aca8bee5
SM
6660 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6661 buffer-invisibility-spec)
6662 (setq buffer-invisibility-spec nil)))
4e57881d 6663\f
30ee26a9 6664;; Partial application of functions (similar to "currying").
a185548b 6665;; This function is here rather than in subr.el because it uses CL.
30ee26a9
EZ
6666(defun apply-partially (fun &rest args)
6667 "Return a function that is a partial application of FUN to ARGS.
6668ARGS is a list of the first N arguments to pass to FUN.
6669The result is a new function which does the same as FUN, except that
6670the first N arguments are fixed at the values with which this function
6671was called."
6672 (lexical-let ((fun fun) (args1 args))
6673 (lambda (&rest args2) (apply fun (append args1 args2)))))
6674\f
e1e04350 6675;; Minibuffer prompt stuff.
9b350152 6676
49c14a05
GM
6677;(defun minibuffer-prompt-modification (start end)
6678; (error "You cannot modify the prompt"))
6679;
6680;
6681;(defun minibuffer-prompt-insertion (start end)
6682; (let ((inhibit-modification-hooks t))
6683; (delete-region start end)
6684; ;; Discard undo information for the text insertion itself
6685; ;; and for the text deletion.above.
6686; (when (consp buffer-undo-list)
6687; (setq buffer-undo-list (cddr buffer-undo-list)))
6688; (message "You cannot modify the prompt")))
6689;
6690;
f1180544 6691;(setq minibuffer-prompt-properties
49c14a05
GM
6692; (list 'modification-hooks '(minibuffer-prompt-modification)
6693; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
f1180544 6694;
9b350152 6695
a2603048
GM
6696\f
6697;;;; Problematic external packages.
6698
6699;; rms says this should be done by specifying symbols that define
6700;; versions together with bad values. This is therefore not as
6701;; flexible as it could be. See the thread:
6702;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6703(defconst bad-packages-alist
6704 ;; Not sure exactly which semantic versions have problems.
6705 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7796ee61 6706 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
a2603048 6707 "The version of `semantic' loaded does not work in Emacs 22.
72d595b5
GM
6708It can cause constant high CPU load.
6709Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
a2603048
GM
6710 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6711 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6712 ;; provided the `CUA-mode' feature. Since this is no longer true,
6713 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6714 (CUA-mode t nil
6715"CUA-mode is now part of the standard GNU Emacs distribution,
6716so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6717
6718You have loaded an older version of CUA-mode which does not work
6719correctly with this version of Emacs. You should remove the old
6720version and use the one distributed with Emacs."))
6721 "Alist of packages known to cause problems in this version of Emacs.
6722Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6723PACKAGE is either a regular expression to match file names, or a
6724symbol (a feature name); see the documentation of
6725`after-load-alist', to which this variable adds functions.
6726SYMBOL is either the name of a string variable, or `t'. Upon
6727loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6728warning using STRING as the message.")
6729
6730(defun bad-package-check (package)
6731 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6732 (condition-case nil
6733 (let* ((list (assoc package bad-packages-alist))
6734 (symbol (nth 1 list)))
6735 (and list
6736 (boundp symbol)
6737 (or (eq symbol t)
6738 (and (stringp (setq symbol (eval symbol)))
9bc505ab
JB
6739 (string-match-p (nth 2 list) symbol)))
6740 (display-warning package (nth 3 list) :warning)))
a2603048
GM
6741 (error nil)))
6742
6743(mapc (lambda (elem)
6744 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6745 bad-packages-alist)
6746
6747
00398e3b 6748(provide 'simple)
6b61353c 6749
c88ab9ce 6750;;; simple.el ends here