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