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