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