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