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