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