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