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