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