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