*** empty log message ***
[bpt/emacs.git] / lisp / simple.el
CommitLineData
c88ab9ce
ER
1;;; simple.el --- basic editing commands for Emacs
2
c6db81aa 3;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
409cc4a3 4;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
bf825c62 5;; Free Software Foundation, Inc.
2076c87c 6
30764597
PJ
7;; Maintainer: FSF
8;; Keywords: internal
9
2076c87c
JB
10;; This file is part of GNU Emacs.
11
eb3fa2cf 12;; GNU Emacs is free software: you can redistribute it and/or modify
2076c87c 13;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
2076c87c
JB
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
eb3fa2cf 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
2076c87c 24
d9ecc911
ER
25;;; Commentary:
26
27;; A grab-bag of basic Emacs commands not specifically related to some
28;; major mode or to file-handling.
29
3a801d0c 30;;; Code:
2076c87c 31
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))
8ac28be5 1728 (setq pending-undo-list (primitive-undo n pending-undo-list))
a7fe694c
RS
1729 (if (null pending-undo-list)
1730 (setq pending-undo-list t))))
2076c87c 1731
65627aad
RS
1732;; Deep copy of a list
1733(defun undo-copy-list (list)
1734 "Make a copy of undo list LIST."
1735 (mapcar 'undo-copy-list-1 list))
1736
1737(defun undo-copy-list-1 (elt)
1738 (if (consp elt)
1739 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1740 elt))
1741
1742(defun undo-start (&optional beg end)
1743 "Set `pending-undo-list' to the front of the undo list.
1744The next call to `undo-more' will undo the most recently made change.
1745If BEG and END are specified, then only undo elements
1746that apply to text between BEG and END are used; other undo elements
1747are ignored. If BEG and END are nil, all undo elements are used."
1748 (if (eq buffer-undo-list t)
1749 (error "No undo information in this buffer"))
1e722f9f 1750 (setq pending-undo-list
65627aad
RS
1751 (if (and beg end (not (= beg end)))
1752 (undo-make-selective-list (min beg end) (max beg end))
1753 buffer-undo-list)))
1754
1755(defvar undo-adjusted-markers)
1756
1757(defun undo-make-selective-list (start end)
1758 "Return a list of undo elements for the region START to END.
1759The elements come from `buffer-undo-list', but we keep only
1760the elements inside this region, and discard those outside this region.
1761If we find an element that crosses an edge of this region,
1762we stop and ignore all further elements."
1763 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1764 (undo-list (list nil))
1765 undo-adjusted-markers
1766 some-rejected
1767 undo-elt undo-elt temp-undo-list delta)
1768 (while undo-list-copy
1769 (setq undo-elt (car undo-list-copy))
1770 (let ((keep-this
1771 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1772 ;; This is a "was unmodified" element.
1773 ;; Keep it if we have kept everything thus far.
1774 (not some-rejected))
1775 (t
1776 (undo-elt-in-region undo-elt start end)))))
1777 (if keep-this
1778 (progn
1779 (setq end (+ end (cdr (undo-delta undo-elt))))
1780 ;; Don't put two nils together in the list
1781 (if (not (and (eq (car undo-list) nil)
1782 (eq undo-elt nil)))
1783 (setq undo-list (cons undo-elt undo-list))))
1784 (if (undo-elt-crosses-region undo-elt start end)
1785 (setq undo-list-copy nil)
1786 (setq some-rejected t)
1787 (setq temp-undo-list (cdr undo-list-copy))
1788 (setq delta (undo-delta undo-elt))
1789
1790 (when (/= (cdr delta) 0)
1791 (let ((position (car delta))
1792 (offset (cdr delta)))
1793
e1e04350
SM
1794 ;; Loop down the earlier events adjusting their buffer
1795 ;; positions to reflect the fact that a change to the buffer
1796 ;; isn't being undone. We only need to process those element
1797 ;; types which undo-elt-in-region will return as being in
1798 ;; the region since only those types can ever get into the
1799 ;; output
65627aad
RS
1800
1801 (while temp-undo-list
1802 (setq undo-elt (car temp-undo-list))
1803 (cond ((integerp undo-elt)
1804 (if (>= undo-elt position)
1805 (setcar temp-undo-list (- undo-elt offset))))
1806 ((atom undo-elt) nil)
1807 ((stringp (car undo-elt))
1808 ;; (TEXT . POSITION)
1809 (let ((text-pos (abs (cdr undo-elt)))
1810 (point-at-end (< (cdr undo-elt) 0 )))
1811 (if (>= text-pos position)
1e722f9f 1812 (setcdr undo-elt (* (if point-at-end -1 1)
65627aad
RS
1813 (- text-pos offset))))))
1814 ((integerp (car undo-elt))
1815 ;; (BEGIN . END)
1816 (when (>= (car undo-elt) position)
1817 (setcar undo-elt (- (car undo-elt) offset))
1818 (setcdr undo-elt (- (cdr undo-elt) offset))))
1819 ((null (car undo-elt))
1820 ;; (nil PROPERTY VALUE BEG . END)
1821 (let ((tail (nthcdr 3 undo-elt)))
1822 (when (>= (car tail) position)
1823 (setcar tail (- (car tail) offset))
1824 (setcdr tail (- (cdr tail) offset))))))
1825 (setq temp-undo-list (cdr temp-undo-list))))))))
1826 (setq undo-list-copy (cdr undo-list-copy)))
1827 (nreverse undo-list)))
1828
1829(defun undo-elt-in-region (undo-elt start end)
1830 "Determine whether UNDO-ELT falls inside the region START ... END.
1831If it crosses the edge, we return nil."
1832 (cond ((integerp undo-elt)
1833 (and (>= undo-elt start)
12a93712 1834 (<= undo-elt end)))
65627aad
RS
1835 ((eq undo-elt nil)
1836 t)
1837 ((atom undo-elt)
1838 nil)
1839 ((stringp (car undo-elt))
1840 ;; (TEXT . POSITION)
1841 (and (>= (abs (cdr undo-elt)) start)
1842 (< (abs (cdr undo-elt)) end)))
1843 ((and (consp undo-elt) (markerp (car undo-elt)))
1844 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1845 ;; See if MARKER is inside the region.
1846 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1847 (unless alist-elt
1848 (setq alist-elt (cons (car undo-elt)
1849 (marker-position (car undo-elt))))
1850 (setq undo-adjusted-markers
1851 (cons alist-elt undo-adjusted-markers)))
1852 (and (cdr alist-elt)
1853 (>= (cdr alist-elt) start)
12a93712 1854 (<= (cdr alist-elt) end))))
65627aad
RS
1855 ((null (car undo-elt))
1856 ;; (nil PROPERTY VALUE BEG . END)
1857 (let ((tail (nthcdr 3 undo-elt)))
1858 (and (>= (car tail) start)
12a93712 1859 (<= (cdr tail) end))))
65627aad
RS
1860 ((integerp (car undo-elt))
1861 ;; (BEGIN . END)
1862 (and (>= (car undo-elt) start)
12a93712 1863 (<= (cdr undo-elt) end)))))
65627aad
RS
1864
1865(defun undo-elt-crosses-region (undo-elt start end)
1866 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1867This assumes we have already decided that UNDO-ELT
1868is not *inside* the region START...END."
1869 (cond ((atom undo-elt) nil)
1870 ((null (car undo-elt))
1871 ;; (nil PROPERTY VALUE BEG . END)
1872 (let ((tail (nthcdr 3 undo-elt)))
1f8a132d
RS
1873 (and (< (car tail) end)
1874 (> (cdr tail) start))))
65627aad
RS
1875 ((integerp (car undo-elt))
1876 ;; (BEGIN . END)
1f8a132d
RS
1877 (and (< (car undo-elt) end)
1878 (> (cdr undo-elt) start)))))
65627aad
RS
1879
1880;; Return the first affected buffer position and the delta for an undo element
1881;; delta is defined as the change in subsequent buffer positions if we *did*
1882;; the undo.
1883(defun undo-delta (undo-elt)
1884 (if (consp undo-elt)
1885 (cond ((stringp (car undo-elt))
1886 ;; (TEXT . POSITION)
1887 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1888 ((integerp (car undo-elt))
1889 ;; (BEGIN . END)
1890 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1891 (t
1892 '(0 . 0)))
1893 '(0 . 0)))
b6e8e8e5 1894
1223933d 1895(defcustom undo-ask-before-discard nil
28cb725d
LT
1896 "If non-nil ask about discarding undo info for the current command.
1897Normally, Emacs discards the undo info for the current command if
1898it exceeds `undo-outer-limit'. But if you set this option
1899non-nil, it asks in the echo area whether to discard the info.
a3545af4 1900If you answer no, there is a slight risk that Emacs might crash, so
28cb725d
LT
1901only do it if you really want to undo the command.
1902
1903This option is mainly intended for debugging. You have to be
1904careful if you use it for other purposes. Garbage collection is
1905inhibited while the question is asked, meaning that Emacs might
1906leak memory. So you should make sure that you do not wait
1907excessively long before answering the question."
1908 :type 'boolean
1909 :group 'undo
bf247b6e 1910 :version "22.1")
28cb725d 1911
a1a801de
RS
1912(defvar undo-extra-outer-limit nil
1913 "If non-nil, an extra level of size that's ok in an undo item.
1914We don't ask the user about truncating the undo list until the
28cb725d
LT
1915current item gets bigger than this amount.
1916
1917This variable only matters if `undo-ask-before-discard' is non-nil.")
a1a801de
RS
1918(make-variable-buffer-local 'undo-extra-outer-limit)
1919
28cb725d
LT
1920;; When the first undo batch in an undo list is longer than
1921;; undo-outer-limit, this function gets called to warn the user that
1922;; the undo info for the current command was discarded. Garbage
1923;; collection is inhibited around the call, so it had better not do a
1924;; lot of consing.
b6e8e8e5
RS
1925(setq undo-outer-limit-function 'undo-outer-limit-truncate)
1926(defun undo-outer-limit-truncate (size)
28cb725d
LT
1927 (if undo-ask-before-discard
1928 (when (or (null undo-extra-outer-limit)
1929 (> size undo-extra-outer-limit))
1930 ;; Don't ask the question again unless it gets even bigger.
1931 ;; This applies, in particular, if the user quits from the question.
1932 ;; Such a quit quits out of GC, but something else will call GC
1933 ;; again momentarily. It will call this function again,
1934 ;; but we don't want to ask the question again.
1935 (setq undo-extra-outer-limit (+ size 50000))
1936 (if (let (use-dialog-box track-mouse executing-kbd-macro )
d5aa078b 1937 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
28cb725d
LT
1938 (buffer-name) size)))
1939 (progn (setq buffer-undo-list nil)
1940 (setq undo-extra-outer-limit nil)
1941 t)
1942 nil))
1943 (display-warning '(undo discard-info)
1944 (concat
d5aa078b 1945 (format "Buffer `%s' undo info was %d bytes long.\n"
28cb725d
LT
1946 (buffer-name) size)
1947 "The undo info was discarded because it exceeded \
1948`undo-outer-limit'.
1949
1950This is normal if you executed a command that made a huge change
1951to the buffer. In that case, to prevent similar problems in the
1952future, set `undo-outer-limit' to a value that is large enough to
1953cover the maximum size of normal changes you expect a single
1954command to make, but not so large that it might exceed the
1955maximum memory allotted to Emacs.
1956
1957If you did not execute any such command, the situation is
1958probably due to a bug and you should report it.
1959
1960You can disable the popping up of this buffer by adding the entry
1961\(undo discard-info) to the user option `warning-suppress-types'.\n")
1962 :warning)
1963 (setq buffer-undo-list nil)
1964 t))
e1e04350 1965\f
009ef402 1966(defvar shell-command-history nil
e5f0c02f
EZ
1967 "History list for some commands that read shell commands.
1968
1969Maximum length of the history list is determined by the value
1970of `history-length', which see.")
009ef402 1971
59fc41e5
RS
1972(defvar shell-command-switch "-c"
1973 "Switch used to have the shell execute its command line argument.")
1974
cc039f78
KH
1975(defvar shell-command-default-error-buffer nil
1976 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
637fff82 1977This buffer is used when `shell-command' or `shell-command-on-region'
cc039f78
KH
1978is run interactively. A value of nil means that output to stderr and
1979stdout will be intermixed in the output stream.")
1980
a98a2fe8
JL
1981(declare-function mailcap-file-default-commands "mailcap" (files))
1982
1983(defun minibuffer-default-add-shell-commands ()
1984 "Return a list of all commands associted with the current file.
086a7dd4 1985This function is used to add all related commands retrieved by `mailcap'
a98a2fe8
JL
1986to the end of the list of defaults just after the default value."
1987 (interactive)
1988 (let* ((filename (if (listp minibuffer-default)
1989 (car minibuffer-default)
1990 minibuffer-default))
1991 (commands (and filename (require 'mailcap nil t)
1992 (mailcap-file-default-commands (list filename)))))
1993 (setq commands (mapcar (lambda (command)
1994 (concat command " " filename))
1995 commands))
1996 (if (listp minibuffer-default)
1997 (append minibuffer-default commands)
1998 (cons minibuffer-default commands))))
1999
2e7bd464
GM
2000(defvar shell-delimiter-argument-list)
2001(defvar shell-file-name-chars)
2002(defvar shell-file-name-quote-list)
2003
e5c4079c
SM
2004(defun minibuffer-complete-shell-command ()
2005 "Dynamically complete shell command at point."
2006 (interactive)
2007 (require 'shell)
79ccd1b8
AS
2008 (let ((comint-delimiter-argument-list shell-delimiter-argument-list)
2009 (comint-file-name-chars shell-file-name-chars)
2010 (comint-file-name-quote-list shell-file-name-quote-list))
2011 (run-hook-with-args-until-success 'shell-dynamic-complete-functions)))
e5c4079c
SM
2012
2013(defvar minibuffer-local-shell-command-map
2014 (let ((map (make-sparse-keymap)))
2015 (set-keymap-parent map minibuffer-local-map)
2016 (define-key map "\t" 'minibuffer-complete-shell-command)
2017 map)
2018 "Keymap used for completiing shell commands in minibufffer.")
2019
2020(defun read-shell-command (prompt &optional initial-contents hist &rest args)
2021 "Read a shell command from the minibuffer.
2022The arguments are the same as the ones of `read-from-minibuffer',
2023except READ and KEYMAP are missing and HIST defaults
2024to `shell-command-history'."
d6601455
JL
2025 (minibuffer-with-setup-hook
2026 (lambda ()
2027 (set (make-local-variable 'minibuffer-default-add-function)
2028 'minibuffer-default-add-shell-commands))
2029 (apply 'read-from-minibuffer prompt initial-contents
2030 minibuffer-local-shell-command-map
2031 nil
2032 (or hist 'shell-command-history)
2033 args)))
e5c4079c 2034
cc039f78 2035(defun shell-command (command &optional output-buffer error-buffer)
2076c87c 2036 "Execute string COMMAND in inferior shell; display output, if any.
0b3f96d4 2037With prefix argument, insert the COMMAND's output at point.
d382f610 2038
2076c87c 2039If COMMAND ends in ampersand, execute it asynchronously.
d382f610 2040The output appears in the buffer `*Async Shell Command*'.
bcad4985 2041That buffer is in shell mode.
d382f610 2042
939ac10c
GM
2043Otherwise, COMMAND is executed synchronously. The output appears in
2044the buffer `*Shell Command Output*'. If the output is short enough to
2045display in the echo area (which is determined by the variables
2046`resize-mini-windows' and `max-mini-window-height'), it is shown
2047there, but it is nonetheless available in buffer `*Shell Command
e1e04350 2048Output*' even though that buffer is not automatically displayed.
d0d74413 2049
07f458c1
RS
2050To specify a coding system for converting non-ASCII characters
2051in the shell command output, use \\[universal-coding-system-argument]
2052before this command.
2053
2054Noninteractive callers can specify coding systems by binding
2055`coding-system-for-read' and `coding-system-for-write'.
2056
d0d74413
RS
2057The optional second argument OUTPUT-BUFFER, if non-nil,
2058says to put the output in some other buffer.
2059If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2060If OUTPUT-BUFFER is not a buffer and not nil,
2061insert output in current buffer. (This cannot be done asynchronously.)
cc039f78
KH
2062In either case, the output is inserted after point (leaving mark after it).
2063
2e033693
RS
2064If the command terminates without error, but generates output,
2065and you did not specify \"insert it in the current buffer\",
2066the output can be displayed in the echo area or in its buffer.
2067If the output is short enough to display in the echo area
2068\(determined by the variable `max-mini-window-height' if
2069`resize-mini-windows' is non-nil), it is shown there. Otherwise,
2070the buffer containing the output is displayed.
2071
2072If there is output and an error, and you did not specify \"insert it
2073in the current buffer\", a message about the error goes at the end
2074of the output.
2075
2076If there is no output, or if output is inserted in the current buffer,
2077then `*Shell Command Output*' is deleted.
2078
cc039f78
KH
2079If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2080or buffer name to which to direct the command's standard error output.
2081If it is nil, error output is mingled with regular output.
2082In an interactive call, the variable `shell-command-default-error-buffer'
2083specifies the value of ERROR-BUFFER."
2084
a98a2fe8
JL
2085 (interactive
2086 (list
d6601455
JL
2087 (read-shell-command "Shell command: " nil nil
2088 (and buffer-file-name
2089 (file-relative-name buffer-file-name)))
a98a2fe8
JL
2090 current-prefix-arg
2091 shell-command-default-error-buffer))
c7edd03c
KH
2092 ;; Look for a handler in case default-directory is a remote file name.
2093 (let ((handler
2094 (find-file-name-handler (directory-file-name default-directory)
2095 'shell-command)))
2096 (if handler
cc039f78 2097 (funcall handler 'shell-command command output-buffer error-buffer)
c7edd03c
KH
2098 (if (and output-buffer
2099 (not (or (bufferp output-buffer) (stringp output-buffer))))
2e033693 2100 ;; Output goes in current buffer.
cc039f78 2101 (let ((error-file
1e722f9f 2102 (if error-buffer
b005abd5 2103 (make-temp-file
171a45d9
EZ
2104 (expand-file-name "scor"
2105 (or small-temporary-file-directory
2106 temporary-file-directory)))
cc039f78
KH
2107 nil)))
2108 (barf-if-buffer-read-only)
63437623 2109 (push-mark nil t)
cc039f78
KH
2110 ;; We do not use -f for csh; we will not support broken use of
2111 ;; .cshrcs. Even the BSD csh manual says to use
2112 ;; "if ($?prompt) exit" before things which are not useful
2113 ;; non-interactively. Besides, if someone wants their other
2114 ;; aliases for shell commands then they can still have them.
1e722f9f 2115 (call-process shell-file-name nil
cc039f78
KH
2116 (if error-file
2117 (list t error-file)
2118 t)
2119 nil shell-command-switch command)
2120 (when (and error-file (file-exists-p error-file))
2121 (if (< 0 (nth 7 (file-attributes error-file)))
2122 (with-current-buffer (get-buffer-create error-buffer)
2123 (let ((pos-from-end (- (point-max) (point))))
2124 (or (bobp)
2125 (insert "\f\n"))
2126 ;; Do no formatting while reading error file,
2127 ;; because that can run a shell command, and we
2128 ;; don't want that to cause an infinite recursion.
2129 (format-insert-file error-file nil)
2130 ;; Put point after the inserted errors.
2131 (goto-char (- (point-max) pos-from-end)))
2132 (display-buffer (current-buffer))))
2133 (delete-file error-file))
2134 ;; This is like exchange-point-and-mark, but doesn't
2135 ;; activate the mark. It is cleaner to avoid activation,
2136 ;; even though the command loop would deactivate the mark
2137 ;; because we inserted text.
2138 (goto-char (prog1 (mark t)
2139 (set-marker (mark-marker) (point)
2140 (current-buffer)))))
2e033693 2141 ;; Output goes in a separate buffer.
c7edd03c
KH
2142 ;; Preserve the match data in case called from a program.
2143 (save-match-data
aab5d2c5 2144 (if (string-match "[ \t]*&[ \t]*\\'" command)
c7edd03c
KH
2145 ;; Command ending with ampersand means asynchronous.
2146 (let ((buffer (get-buffer-create
2147 (or output-buffer "*Async Shell Command*")))
2148 (directory default-directory)
2149 proc)
2150 ;; Remove the ampersand.
2151 (setq command (substring command 0 (match-beginning 0)))
2152 ;; If will kill a process, query first.
2153 (setq proc (get-buffer-process buffer))
2154 (if proc
2155 (if (yes-or-no-p "A command is running. Kill it? ")
2156 (kill-process proc)
2157 (error "Shell command in progress")))
1e96c007 2158 (with-current-buffer buffer
c7edd03c
KH
2159 (setq buffer-read-only nil)
2160 (erase-buffer)
2161 (display-buffer buffer)
2162 (setq default-directory directory)
1e722f9f 2163 (setq proc (start-process "Shell" buffer shell-file-name
c7edd03c
KH
2164 shell-command-switch command))
2165 (setq mode-line-process '(":%s"))
c2020c27 2166 (require 'shell) (shell-mode)
c7edd03c
KH
2167 (set-process-sentinel proc 'shell-command-sentinel)
2168 ))
cc039f78
KH
2169 (shell-command-on-region (point) (point) command
2170 output-buffer nil error-buffer)))))))
eaae8106 2171
f69aad2b
MB
2172(defun display-message-or-buffer (message
2173 &optional buffer-name not-this-window frame)
2174 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2175MESSAGE may be either a string or a buffer.
2176
2177A buffer is displayed using `display-buffer' if MESSAGE is too long for
939ac10c
GM
2178the maximum height of the echo area, as defined by `max-mini-window-height'
2179if `resize-mini-windows' is non-nil.
f69aad2b 2180
2a3f00bf
MB
2181Returns either the string shown in the echo area, or when a pop-up
2182buffer is used, the window used to display it.
2183
f69aad2b
MB
2184If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2185name of the buffer used to display it in the case where a pop-up buffer
2186is used, defaulting to `*Message*'. In the case where MESSAGE is a
2187string and it is displayed in the echo area, it is not specified whether
2188the contents are inserted into the buffer anyway.
2189
2190Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2191and only used if a buffer is displayed."
39a8d88a 2192 (cond ((and (stringp message) (not (string-match "\n" message)))
f69aad2b
MB
2193 ;; Trivial case where we can use the echo area
2194 (message "%s" message))
2195 ((and (stringp message)
39a8d88a 2196 (= (string-match "\n" message) (1- (length message))))
f69aad2b
MB
2197 ;; Trivial case where we can just remove single trailing newline
2198 (message "%s" (substring message 0 (1- (length message)))))
2199 (t
2200 ;; General case
2201 (with-current-buffer
2202 (if (bufferp message)
2203 message
2204 (get-buffer-create (or buffer-name "*Message*")))
2205
2206 (unless (bufferp message)
2207 (erase-buffer)
2208 (insert message))
2209
2210 (let ((lines
2211 (if (= (buffer-size) 0)
2212 0
62ffcd76 2213 (count-screen-lines nil nil nil (minibuffer-window)))))
4f017185
RS
2214 (cond ((= lines 0))
2215 ((and (or (<= lines 1)
aab5d2c5
RS
2216 (<= lines
2217 (if resize-mini-windows
2218 (cond ((floatp max-mini-window-height)
2219 (* (frame-height)
2220 max-mini-window-height))
2221 ((integerp max-mini-window-height)
2222 max-mini-window-height)
2223 (t
2224 1))
2225 1)))
2226 ;; Don't use the echo area if the output buffer is
2227 ;; already dispayed in the selected frame.
61b80ebf 2228 (not (get-buffer-window (current-buffer))))
f69aad2b
MB
2229 ;; Echo area
2230 (goto-char (point-max))
2231 (when (bolp)
2232 (backward-char 1))
2233 (message "%s" (buffer-substring (point-min) (point))))
2234 (t
2235 ;; Buffer
2236 (goto-char (point-min))
31252c00
MB
2237 (display-buffer (current-buffer)
2238 not-this-window frame))))))))
f69aad2b
MB
2239
2240
2076c87c
JB
2241;; We have a sentinel to prevent insertion of a termination message
2242;; in the buffer itself.
2243(defun shell-command-sentinel (process signal)
bcad4985 2244 (if (memq (process-status process) '(exit signal))
1e722f9f 2245 (message "%s: %s."
bcad4985
KH
2246 (car (cdr (cdr (process-command process))))
2247 (substring signal 0 -1))))
2076c87c 2248
d0d74413 2249(defun shell-command-on-region (start end command
cce1c318 2250 &optional output-buffer replace
63619f42 2251 error-buffer display-error-buffer)
2076c87c
JB
2252 "Execute string COMMAND in inferior shell with region as input.
2253Normally display output (if any) in temp buffer `*Shell Command Output*';
a0184aeb
DL
2254Prefix arg means replace the region with it. Return the exit code of
2255COMMAND.
56c0450e 2256
07f458c1
RS
2257To specify a coding system for converting non-ASCII characters
2258in the input and output to the shell command, use \\[universal-coding-system-argument]
2259before this command. By default, the input (from the current buffer)
2260is encoded in the same coding system that will be used to save the file,
2261`buffer-file-coding-system'. If the output is going to replace the region,
2262then it is decoded from that same coding system.
2263
63619f42
RS
2264The noninteractive arguments are START, END, COMMAND,
2265OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2266Noninteractive callers can specify coding systems by binding
2267`coding-system-for-read' and `coding-system-for-write'.
2076c87c 2268
2e033693
RS
2269If the command generates output, the output may be displayed
2270in the echo area or in a buffer.
2271If the output is short enough to display in the echo area
2272\(determined by the variable `max-mini-window-height' if
2273`resize-mini-windows' is non-nil), it is shown there. Otherwise
2274it is displayed in the buffer `*Shell Command Output*'. The output
2275is available in that buffer in both cases.
2276
2277If there is output and an error, a message about the error
2278appears at the end of the output.
2279
2280If there is no output, or if output is inserted in the current buffer,
2281then `*Shell Command Output*' is deleted.
d0d74413 2282
56c0450e
RS
2283If the optional fourth argument OUTPUT-BUFFER is non-nil,
2284that says to put the output in some other buffer.
d0d74413
RS
2285If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2286If OUTPUT-BUFFER is not a buffer and not nil,
2287insert output in the current buffer.
cce1c318
RS
2288In either case, the output is inserted after point (leaving mark after it).
2289
8923a211
RS
2290If REPLACE, the optional fifth argument, is non-nil, that means insert
2291the output in place of text from START to END, putting point and mark
2292around it.
2293
b735c991 2294If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
cce1c318 2295or buffer name to which to direct the command's standard error output.
7fd47839 2296If it is nil, error output is mingled with regular output.
63619f42
RS
2297If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2298were any errors. (This is always t, interactively.)
cc039f78
KH
2299In an interactive call, the variable `shell-command-default-error-buffer'
2300specifies the value of ERROR-BUFFER."
195ce311
RS
2301 (interactive (let (string)
2302 (unless (mark)
2303 (error "The mark is not set now, so there is no region"))
2304 ;; Do this before calling region-beginning
2305 ;; and region-end, in case subprocess output
2306 ;; relocates them while we are in the minibuffer.
e5c4079c 2307 (setq string (read-shell-command "Shell command on region: "))
2b03c506
RS
2308 ;; call-interactively recognizes region-beginning and
2309 ;; region-end specially, leaving them in the history.
2310 (list (region-beginning) (region-end)
cae49185
RS
2311 string
2312 current-prefix-arg
7fd47839 2313 current-prefix-arg
63619f42
RS
2314 shell-command-default-error-buffer
2315 t)))
cce1c318 2316 (let ((error-file
171a45d9 2317 (if error-buffer
b005abd5 2318 (make-temp-file
171a45d9
EZ
2319 (expand-file-name "scor"
2320 (or small-temporary-file-directory
2321 temporary-file-directory)))
a0184aeb
DL
2322 nil))
2323 exit-status)
7fd47839
RS
2324 (if (or replace
2325 (and output-buffer
748d6ca4 2326 (not (or (bufferp output-buffer) (stringp output-buffer)))))
7fd47839
RS
2327 ;; Replace specified region with output from command.
2328 (let ((swap (and replace (< start end))))
2329 ;; Don't muck with mark unless REPLACE says we should.
2330 (goto-char start)
30883773 2331 (and replace (push-mark (point) 'nomsg))
a0184aeb
DL
2332 (setq exit-status
2333 (call-process-region start end shell-file-name t
2334 (if error-file
2335 (list t error-file)
2336 t)
2337 nil shell-command-switch command))
e1e04350
SM
2338 ;; It is rude to delete a buffer which the command is not using.
2339 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2340 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2341 ;; (kill-buffer shell-buffer)))
7fd47839
RS
2342 ;; Don't muck with mark unless REPLACE says we should.
2343 (and replace swap (exchange-point-and-mark)))
2344 ;; No prefix argument: put the output in a temp buffer,
2345 ;; replacing its entire contents.
2346 (let ((buffer (get-buffer-create
d4bbcbb4 2347 (or output-buffer "*Shell Command Output*"))))
7fd47839
RS
2348 (unwind-protect
2349 (if (eq buffer (current-buffer))
2350 ;; If the input is the same buffer as the output,
2351 ;; delete everything but the specified region,
2352 ;; then replace that region with the output.
2353 (progn (setq buffer-read-only nil)
2354 (delete-region (max start end) (point-max))
2355 (delete-region (point-min) (min start end))
2356 (setq exit-status
2357 (call-process-region (point-min) (point-max)
1e722f9f 2358 shell-file-name t
7fd47839
RS
2359 (if error-file
2360 (list t error-file)
2361 t)
a0184aeb
DL
2362 nil shell-command-switch
2363 command)))
2364 ;; Clear the output buffer, then run the command with
2365 ;; output there.
c2e303c8
GM
2366 (let ((directory default-directory))
2367 (save-excursion
2368 (set-buffer buffer)
2369 (setq buffer-read-only nil)
2370 (if (not output-buffer)
2371 (setq default-directory directory))
2372 (erase-buffer)))
7fd47839
RS
2373 (setq exit-status
2374 (call-process-region start end shell-file-name nil
2375 (if error-file
2376 (list buffer error-file)
2377 buffer)
a0184aeb 2378 nil shell-command-switch command)))
2e033693 2379 ;; Report the output.
9a98fa64 2380 (with-current-buffer buffer
f1180544 2381 (setq mode-line-process
d4bbcbb4
AS
2382 (cond ((null exit-status)
2383 " - Error")
2384 ((stringp exit-status)
2385 (format " - Signal [%s]" exit-status))
2386 ((not (equal 0 exit-status))
2387 (format " - Exit [%d]" exit-status)))))
f69aad2b
MB
2388 (if (with-current-buffer buffer (> (point-max) (point-min)))
2389 ;; There's some output, display it
9a98fa64 2390 (display-message-or-buffer buffer)
f69aad2b 2391 ;; No output; error?
94ddbe6d
RS
2392 (let ((output
2393 (if (and error-file
2394 (< 0 (nth 7 (file-attributes error-file))))
2395 "some error output"
2396 "no output")))
d4bbcbb4
AS
2397 (cond ((null exit-status)
2398 (message "(Shell command failed with error)"))
2399 ((equal 0 exit-status)
2400 (message "(Shell command succeeded with %s)"
2401 output))
2402 ((stringp exit-status)
2403 (message "(Shell command killed by signal %s)"
2404 exit-status))
2405 (t
2406 (message "(Shell command failed with code %d and %s)"
2407 exit-status output))))
e1e04350
SM
2408 ;; Don't kill: there might be useful info in the undo-log.
2409 ;; (kill-buffer buffer)
2410 ))))
f69aad2b 2411
cc039f78
KH
2412 (when (and error-file (file-exists-p error-file))
2413 (if (< 0 (nth 7 (file-attributes error-file)))
2414 (with-current-buffer (get-buffer-create error-buffer)
2415 (let ((pos-from-end (- (point-max) (point))))
2416 (or (bobp)
2417 (insert "\f\n"))
2418 ;; Do no formatting while reading error file,
2419 ;; because that can run a shell command, and we
2420 ;; don't want that to cause an infinite recursion.
2421 (format-insert-file error-file nil)
2422 ;; Put point after the inserted errors.
2423 (goto-char (- (point-max) pos-from-end)))
63619f42
RS
2424 (and display-error-buffer
2425 (display-buffer (current-buffer)))))
cc039f78 2426 (delete-file error-file))
a0184aeb 2427 exit-status))
1e722f9f 2428
d589bd99
RS
2429(defun shell-command-to-string (command)
2430 "Execute shell command COMMAND and return its output as a string."
2431 (with-output-to-string
17cc9013
RS
2432 (with-current-buffer
2433 standard-output
2434 (call-process shell-file-name nil t nil shell-command-switch command))))
0457dd55
KG
2435
2436(defun process-file (program &optional infile buffer display &rest args)
2437 "Process files synchronously in a separate process.
2438Similar to `call-process', but may invoke a file handler based on
2439`default-directory'. The current working directory of the
2440subprocess is `default-directory'.
2441
2442File names in INFILE and BUFFER are handled normally, but file
2443names in ARGS should be relative to `default-directory', as they
2444are passed to the process verbatim. \(This is a difference to
2445`call-process' which does not support file handlers for INFILE
2446and BUFFER.\)
2447
2448Some file handlers might not support all variants, for example
2449they might behave as if DISPLAY was nil, regardless of the actual
2450value passed."
2451 (let ((fh (find-file-name-handler default-directory 'process-file))
2452 lc stderr-file)
2453 (unwind-protect
2454 (if fh (apply fh 'process-file program infile buffer display args)
8de40f9f 2455 (when infile (setq lc (file-local-copy infile)))
0457dd55 2456 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
85af630d
KG
2457 (make-temp-file "emacs")))
2458 (prog1
2459 (apply 'call-process program
2460 (or lc infile)
2461 (if stderr-file (list (car buffer) stderr-file) buffer)
2462 display args)
2463 (when stderr-file (copy-file stderr-file (cadr buffer)))))
0457dd55
KG
2464 (when stderr-file (delete-file stderr-file))
2465 (when lc (delete-file lc)))))
2466
7cb76caa
MA
2467(defun start-file-process (name buffer program &rest program-args)
2468 "Start a program in a subprocess. Return the process object for it.
5a5abb2c 2469
7cb76caa 2470Similar to `start-process', but may invoke a file handler based on
5a5abb2c
MA
2471`default-directory'. See Info node `(elisp)Magic File Names'.
2472
2473This handler ought to run PROGRAM, perhaps on the local host,
2474perhaps on a remote host that corresponds to `default-directory'.
2475In the latter case, the local part of `default-directory' becomes
2476the working directory of the process.
7cb76caa
MA
2477
2478PROGRAM and PROGRAM-ARGS might be file names. They are not
2479objects of file handler invocation."
2480 (let ((fh (find-file-name-handler default-directory 'start-file-process)))
2481 (if fh (apply fh 'start-file-process name buffer program program-args)
2482 (apply 'start-process name buffer program program-args))))
2483
2d88b556 2484\f
1b43f83f 2485(defvar universal-argument-map
69d4c3c4
KH
2486 (let ((map (make-sparse-keymap)))
2487 (define-key map [t] 'universal-argument-other-key)
b9ff190d 2488 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
69d4c3c4
KH
2489 (define-key map [switch-frame] nil)
2490 (define-key map [?\C-u] 'universal-argument-more)
2491 (define-key map [?-] 'universal-argument-minus)
2492 (define-key map [?0] 'digit-argument)
2493 (define-key map [?1] 'digit-argument)
2494 (define-key map [?2] 'digit-argument)
2495 (define-key map [?3] 'digit-argument)
2496 (define-key map [?4] 'digit-argument)
2497 (define-key map [?5] 'digit-argument)
2498 (define-key map [?6] 'digit-argument)
2499 (define-key map [?7] 'digit-argument)
2500 (define-key map [?8] 'digit-argument)
2501 (define-key map [?9] 'digit-argument)
bd7acc8d
GM
2502 (define-key map [kp-0] 'digit-argument)
2503 (define-key map [kp-1] 'digit-argument)
2504 (define-key map [kp-2] 'digit-argument)
2505 (define-key map [kp-3] 'digit-argument)
2506 (define-key map [kp-4] 'digit-argument)
2507 (define-key map [kp-5] 'digit-argument)
2508 (define-key map [kp-6] 'digit-argument)
2509 (define-key map [kp-7] 'digit-argument)
2510 (define-key map [kp-8] 'digit-argument)
2511 (define-key map [kp-9] 'digit-argument)
2512 (define-key map [kp-subtract] 'universal-argument-minus)
69d4c3c4
KH
2513 map)
2514 "Keymap used while processing \\[universal-argument].")
2515
0de84e16
RS
2516(defvar universal-argument-num-events nil
2517 "Number of argument-specifying events read by `universal-argument'.
2518`universal-argument-other-key' uses this to discard those events
2519from (this-command-keys), and reread only the final command.")
2520
6b61353c
KH
2521(defvar overriding-map-is-bound nil
2522 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2523
2524(defvar saved-overriding-map nil
2525 "The saved value of `overriding-terminal-local-map'.
2526That variable gets restored to this value on exiting \"universal
2527argument mode\".")
2528
2529(defun ensure-overriding-map-is-bound ()
2530 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2531 (unless overriding-map-is-bound
2532 (setq saved-overriding-map overriding-terminal-local-map)
2533 (setq overriding-terminal-local-map universal-argument-map)
2534 (setq overriding-map-is-bound t)))
2535
2536(defun restore-overriding-map ()
2537 "Restore `overriding-terminal-local-map' to its saved value."
2538 (setq overriding-terminal-local-map saved-overriding-map)
2539 (setq overriding-map-is-bound nil))
2540
e8d1a377
KH
2541(defun universal-argument ()
2542 "Begin a numeric argument for the following command.
2543Digits or minus sign following \\[universal-argument] make up the numeric argument.
2544\\[universal-argument] following the digits or minus sign ends the argument.
2545\\[universal-argument] without digits or minus sign provides 4 as argument.
2546Repeating \\[universal-argument] without digits or minus sign
0565d307
RS
2547 multiplies the argument by 4 each time.
2548For some commands, just \\[universal-argument] by itself serves as a flag
a697fc62
RS
2549which is different in effect from any particular numeric argument.
2550These commands include \\[set-mark-command] and \\[start-kbd-macro]."
69d4c3c4
KH
2551 (interactive)
2552 (setq prefix-arg (list 4))
0de84e16 2553 (setq universal-argument-num-events (length (this-command-keys)))
6b61353c 2554 (ensure-overriding-map-is-bound))
e8d1a377 2555
69d4c3c4
KH
2556;; A subsequent C-u means to multiply the factor by 4 if we've typed
2557;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2558(defun universal-argument-more (arg)
e8d1a377 2559 (interactive "P")
69d4c3c4
KH
2560 (if (consp arg)
2561 (setq prefix-arg (list (* 4 (car arg))))
1cd24721
RS
2562 (if (eq arg '-)
2563 (setq prefix-arg (list -4))
2564 (setq prefix-arg arg)
6b61353c 2565 (restore-overriding-map)))
0de84e16 2566 (setq universal-argument-num-events (length (this-command-keys))))
e8d1a377
KH
2567
2568(defun negative-argument (arg)
2569 "Begin a negative numeric argument for the next command.
2570\\[universal-argument] following digits or minus sign ends the argument."
2571 (interactive "P")
69d4c3c4
KH
2572 (cond ((integerp arg)
2573 (setq prefix-arg (- arg)))
2574 ((eq arg '-)
2575 (setq prefix-arg nil))
2576 (t
b9ff190d 2577 (setq prefix-arg '-)))
0de84e16 2578 (setq universal-argument-num-events (length (this-command-keys)))
6b61353c 2579 (ensure-overriding-map-is-bound))
69d4c3c4
KH
2580
2581(defun digit-argument (arg)
2582 "Part of the numeric argument for the next command.
2583\\[universal-argument] following digits or minus sign ends the argument."
2584 (interactive "P")
bd7acc8d
GM
2585 (let* ((char (if (integerp last-command-char)
2586 last-command-char
2587 (get last-command-char 'ascii-character)))
2588 (digit (- (logand char ?\177) ?0)))
69d4c3c4
KH
2589 (cond ((integerp arg)
2590 (setq prefix-arg (+ (* arg 10)
2591 (if (< arg 0) (- digit) digit))))
2592 ((eq arg '-)
2593 ;; Treat -0 as just -, so that -01 will work.
2594 (setq prefix-arg (if (zerop digit) '- (- digit))))
2595 (t
b9ff190d 2596 (setq prefix-arg digit))))
0de84e16 2597 (setq universal-argument-num-events (length (this-command-keys)))
6b61353c 2598 (ensure-overriding-map-is-bound))
69d4c3c4
KH
2599
2600;; For backward compatibility, minus with no modifiers is an ordinary
2601;; command if digits have already been entered.
2602(defun universal-argument-minus (arg)
2603 (interactive "P")
2604 (if (integerp arg)
2605 (universal-argument-other-key arg)
2606 (negative-argument arg)))
2607
2608;; Anything else terminates the argument and is left in the queue to be
2609;; executed as a command.
2610(defun universal-argument-other-key (arg)
2611 (interactive "P")
2612 (setq prefix-arg arg)
0de84e16
RS
2613 (let* ((key (this-command-keys))
2614 (keylist (listify-key-sequence key)))
2615 (setq unread-command-events
06697cdb
RS
2616 (append (nthcdr universal-argument-num-events keylist)
2617 unread-command-events)))
f0ef2555 2618 (reset-this-command-lengths)
6b61353c 2619 (restore-overriding-map))
2d88b556 2620\f
7fcce20f
RS
2621(defvar buffer-substring-filters nil
2622 "List of filter functions for `filter-buffer-substring'.
2623Each function must accept a single argument, a string, and return
2624a string. The buffer substring is passed to the first function
2625in the list, and the return value of each function is passed to
2626the next. The return value of the last function is used as the
2627return value of `filter-buffer-substring'.
2628
2629If this variable is nil, no filtering is performed.")
2630
398c9ffb 2631(defun filter-buffer-substring (beg end &optional delete noprops)
7fcce20f
RS
2632 "Return the buffer substring between BEG and END, after filtering.
2633The buffer substring is passed through each of the filter
2634functions in `buffer-substring-filters', and the value from the
2635last filter function is returned. If `buffer-substring-filters'
2636is nil, the buffer substring is returned unaltered.
2637
2638If DELETE is non-nil, the text between BEG and END is deleted
2639from the buffer.
2640
398c9ffb
KS
2641If NOPROPS is non-nil, final string returned does not include
2642text properties, while the string passed to the filters still
2643includes text properties from the buffer text.
2644
2cd16d74 2645Point is temporarily set to BEG before calling
7fcce20f
RS
2646`buffer-substring-filters', in case the functions need to know
2647where the text came from.
2648
398c9ffb
KS
2649This function should be used instead of `buffer-substring',
2650`buffer-substring-no-properties', or `delete-and-extract-region'
2651when you want to allow filtering to take place. For example,
2652major or minor modes can use `buffer-substring-filters' to
2653extract characters that are special to a buffer, and should not
2654be copied into other buffers."
2655 (cond
2656 ((or delete buffer-substring-filters)
2657 (save-excursion
2658 (goto-char beg)
2659 (let ((string (if delete (delete-and-extract-region beg end)
2660 (buffer-substring beg end))))
2661 (dolist (filter buffer-substring-filters)
2662 (setq string (funcall filter string)))
2663 (if noprops
2664 (set-text-properties 0 (length string) nil string))
2665 string)))
2666 (noprops
2667 (buffer-substring-no-properties beg end))
2668 (t
2669 (buffer-substring beg end))))
2670
7fcce20f 2671
93be67de 2672;;;; Window system cut and paste hooks.
70e14c01
JB
2673
2674(defvar interprogram-cut-function nil
2675 "Function to call to make a killed region available to other programs.
2676
2677Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2678pasting text between the windows of different programs.
2679This variable holds a function that Emacs calls whenever text
2680is put in the kill ring, to make the new kill available to other
70e14c01
JB
2681programs.
2682
9f112a3d
RS
2683The function takes one or two arguments.
2684The first argument, TEXT, is a string containing
2685the text which should be made available.
6b61353c
KH
2686The second, optional, argument PUSH, has the same meaning as the
2687similar argument to `x-set-cut-buffer', which see.")
70e14c01
JB
2688
2689(defvar interprogram-paste-function nil
2690 "Function to call to get text cut from other programs.
2691
2692Most window systems provide some sort of facility for cutting and
9f112a3d
RS
2693pasting text between the windows of different programs.
2694This variable holds a function that Emacs calls to obtain
70e14c01
JB
2695text that other programs have provided for pasting.
2696
2697The function should be called with no arguments. If the function
2698returns nil, then no other program has provided such text, and the top
2699of the Emacs kill ring should be used. If the function returns a
6b61353c
KH
2700string, then the caller of the function \(usually `current-kill')
2701should put this string in the kill ring as the latest kill.
daa37602 2702
d4cb4833
GM
2703This function may also return a list of strings if the window
2704system supports multiple selections. The first string will be
2705used as the pasted text, but the other will be placed in the
2706kill ring for easy access via `yank-pop'.
2707
daa37602
JB
2708Note that the function should return a string only if a program other
2709than Emacs has provided a string for pasting; if Emacs provided the
2710most recent string, the function should return nil. If it is
2711difficult to tell whether Emacs or some other program provided the
2712current string, it is probably good enough to return nil if the string
2713is equal (according to `string=') to the last text Emacs provided.")
2d88b556 2714\f
70e14c01 2715
eaae8106 2716
70e14c01 2717;;;; The kill ring data structure.
2076c87c
JB
2718
2719(defvar kill-ring nil
70e14c01
JB
2720 "List of killed text sequences.
2721Since the kill ring is supposed to interact nicely with cut-and-paste
2722facilities offered by window systems, use of this variable should
2723interact nicely with `interprogram-cut-function' and
2724`interprogram-paste-function'. The functions `kill-new',
2725`kill-append', and `current-kill' are supposed to implement this
2726interaction; you may want to use them instead of manipulating the kill
2727ring directly.")
2076c87c 2728
bffa4d92 2729(defcustom kill-ring-max 60
69c1dd37
RS
2730 "*Maximum length of kill ring before oldest elements are thrown away."
2731 :type 'integer
2732 :group 'killing)
2076c87c
JB
2733
2734(defvar kill-ring-yank-pointer nil
2735 "The tail of the kill ring whose car is the last thing yanked.")
2736
be5936a7 2737(defun kill-new (string &optional replace yank-handler)
70e14c01 2738 "Make STRING the latest kill in the kill ring.
3e505153 2739Set `kill-ring-yank-pointer' to point to it.
f914dc91
KH
2740If `interprogram-cut-function' is non-nil, apply it to STRING.
2741Optional second argument REPLACE non-nil means that STRING will replace
be5936a7
KS
2742the front of the kill ring, rather than being added to the list.
2743
2744Optional third arguments YANK-HANDLER controls how the STRING is later
f1180544 2745inserted into a buffer; see `insert-for-yank' for details.
2a262563 2746When a yank handler is specified, STRING must be non-empty (the yank
6b61353c 2747handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2a262563
KS
2748
2749When the yank handler has a non-nil PARAM element, the original STRING
2750argument is not used by `insert-for-yank'. However, since Lisp code
f33321ad 2751may access and use elements from the kill ring directly, the STRING
2a262563
KS
2752argument should still be a \"useful\" string for such uses."
2753 (if (> (length string) 0)
f1180544 2754 (if yank-handler
6b61353c
KH
2755 (put-text-property 0 (length string)
2756 'yank-handler yank-handler string))
2a262563 2757 (if yank-handler
f1180544 2758 (signal 'args-out-of-range
2a262563
KS
2759 (list string "yank-handler specified for empty string"))))
2760 (if (fboundp 'menu-bar-update-yank-menu)
2761 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
ab7e20d5 2762 (if (and replace kill-ring)
f914dc91 2763 (setcar kill-ring string)
1b5fd09e 2764 (push string kill-ring)
f914dc91
KH
2765 (if (> (length kill-ring) kill-ring-max)
2766 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
70e14c01
JB
2767 (setq kill-ring-yank-pointer kill-ring)
2768 (if interprogram-cut-function
657a33ab 2769 (funcall interprogram-cut-function string (not replace))))
70e14c01 2770
be5936a7 2771(defun kill-append (string before-p &optional yank-handler)
70e14c01
JB
2772 "Append STRING to the end of the latest kill in the kill ring.
2773If BEFORE-P is non-nil, prepend STRING to the kill.
6b61353c
KH
2774Optional third argument YANK-HANDLER, if non-nil, specifies the
2775yank-handler text property to be set on the combined kill ring
2776string. If the specified yank-handler arg differs from the
2777yank-handler property of the latest kill string, this function
2778adds the combined string to the kill ring as a new element,
2779instead of replacing the last kill with it.
be5936a7
KS
2780If `interprogram-cut-function' is set, pass the resulting kill to it."
2781 (let* ((cur (car kill-ring)))
2782 (kill-new (if before-p (concat string cur) (concat cur string))
2783 (or (= (length cur) 0)
2784 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2785 yank-handler)))
70e14c01 2786
4496b02b
RS
2787(defcustom yank-pop-change-selection nil
2788 "If non-nil, rotating the kill ring changes the window system selection."
2789 :type 'boolean
2790 :group 'killing
2791 :version "23.1")
2792
70e14c01
JB
2793(defun current-kill (n &optional do-not-move)
2794 "Rotate the yanking point by N places, and then return that kill.
d4cb4833
GM
2795If N is zero, `interprogram-paste-function' is set, and calling it returns a
2796string or list of strings, then that string (or list) is added to the front
2797of the kill ring and the string (or first string in the list) is returned as
4496b02b
RS
2798the latest kill.
2799
2800If N is not zero, and if `yank-pop-change-selection' is
2801non-nil, use `interprogram-cut-function' to transfer the
2802kill at the new yank point into the window system selection.
2803
2804If optional arg DO-NOT-MOVE is non-nil, then don't actually
2805move the yanking point; just return the Nth kill forward."
2806
70e14c01
JB
2807 (let ((interprogram-paste (and (= n 0)
2808 interprogram-paste-function
2809 (funcall interprogram-paste-function))))
2810 (if interprogram-paste
2811 (progn
2812 ;; Disable the interprogram cut function when we add the new
2813 ;; text to the kill ring, so Emacs doesn't try to own the
2814 ;; selection, with identical text.
2815 (let ((interprogram-cut-function nil))
d4cb4833
GM
2816 (if (listp interprogram-paste)
2817 (mapc 'kill-new (nreverse interprogram-paste))
2818 (kill-new interprogram-paste)))
2819 (car kill-ring))
70e14c01 2820 (or kill-ring (error "Kill ring is empty"))
47096a67
PE
2821 (let ((ARGth-kill-element
2822 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2823 (length kill-ring))
2824 kill-ring)))
4496b02b
RS
2825 (unless do-not-move
2826 (setq kill-ring-yank-pointer ARGth-kill-element)
2827 (when (and yank-pop-change-selection
2828 (> n 0)
2829 interprogram-cut-function)
2830 (funcall interprogram-cut-function (car ARGth-kill-element))))
70e14c01 2831 (car ARGth-kill-element)))))
c88ab9ce 2832
c88ab9ce 2833
eaae8106 2834
70e14c01 2835;;;; Commands for manipulating the kill ring.
c88ab9ce 2836
69c1dd37
RS
2837(defcustom kill-read-only-ok nil
2838 "*Non-nil means don't signal an error for killing read-only text."
2839 :type 'boolean
2840 :group 'killing)
e6291fe1 2841
3a5da8a8
RS
2842(put 'text-read-only 'error-conditions
2843 '(text-read-only buffer-read-only error))
2844(put 'text-read-only 'error-message "Text is read-only")
2845
be5936a7 2846(defun kill-region (beg end &optional yank-handler)
66e9b2b2
RS
2847 "Kill (\"cut\") text between point and mark.
2848This deletes the text from the buffer and saves it in the kill ring.
2076c87c 2849The command \\[yank] can retrieve it from there.
ba2b460a 2850\(If you want to save the region without killing it, use \\[kill-ring-save].)
81558867
EZ
2851
2852If you want to append the killed region to the last killed text,
2853use \\[append-next-kill] before \\[kill-region].
2854
2aa7a8bf
JB
2855If the buffer is read-only, Emacs will beep and refrain from deleting
2856the text, but put the text in the kill ring anyway. This means that
2857you can use the killing commands to copy text from a read-only buffer.
2076c87c
JB
2858
2859This is the primitive for programs to kill text (as opposed to deleting it).
c15dc81f 2860Supply two arguments, character positions indicating the stretch of text
2076c87c
JB
2861 to be killed.
2862Any command that calls this function is a \"kill command\".
2863If the previous command was also a kill command,
2864the text killed this time appends to the text killed last time
be5936a7
KS
2865to make one entry in the kill ring.
2866
6b61353c
KH
2867In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2868specifies the yank-handler text property to be set on the killed
2869text. See `insert-for-yank'."
214a3db0
RS
2870 ;; Pass point first, then mark, because the order matters
2871 ;; when calling kill-append.
2872 (interactive (list (point) (mark)))
f39d6be0
RS
2873 (unless (and beg end)
2874 (error "The mark is not set now, so there is no region"))
ccd19b9f 2875 (condition-case nil
7fcce20f 2876 (let ((string (filter-buffer-substring beg end t)))
a1eb02bd
SM
2877 (when string ;STRING is nil if BEG = END
2878 ;; Add that string to the kill ring, one way or another.
2879 (if (eq last-command 'kill-region)
be5936a7
KS
2880 (kill-append string (< end beg) yank-handler)
2881 (kill-new string nil yank-handler)))
8a7cda9b 2882 (when (or string (eq last-command 'kill-region))
6b61353c
KH
2883 (setq this-command 'kill-region))
2884 nil)
ccd19b9f
KH
2885 ((buffer-read-only text-read-only)
2886 ;; The code above failed because the buffer, or some of the characters
2887 ;; in the region, are read-only.
2888 ;; We should beep, in case the user just isn't aware of this.
2889 ;; However, there's no harm in putting
2890 ;; the region's text in the kill ring, anyway.
2891 (copy-region-as-kill beg end)
cb3e1b4c
RS
2892 ;; Set this-command now, so it will be set even if we get an error.
2893 (setq this-command 'kill-region)
2894 ;; This should barf, if appropriate, and give us the correct error.
ccd19b9f 2895 (if kill-read-only-ok
6b61353c 2896 (progn (message "Read only text copied to kill ring") nil)
ccd19b9f
KH
2897 ;; Signal an error if the buffer is read-only.
2898 (barf-if-buffer-read-only)
2899 ;; If the buffer isn't read-only, the text is.
2900 (signal 'text-read-only (list (current-buffer)))))))
2076c87c 2901
a382890a
KH
2902;; copy-region-as-kill no longer sets this-command, because it's confusing
2903;; to get two copies of the text when the user accidentally types M-w and
2904;; then corrects it with the intended C-w.
2076c87c
JB
2905(defun copy-region-as-kill (beg end)
2906 "Save the region as if killed, but don't kill it.
0e264847 2907In Transient Mark mode, deactivate the mark.
46947372 2908If `interprogram-cut-function' is non-nil, also save the text for a window
b66eb11b
RS
2909system cut and paste.
2910
2911This command's old key binding has been given to `kill-ring-save'."
2076c87c
JB
2912 (interactive "r")
2913 (if (eq last-command 'kill-region)
7fcce20f
RS
2914 (kill-append (filter-buffer-substring beg end) (< end beg))
2915 (kill-new (filter-buffer-substring beg end)))
d34c311a 2916 (setq deactivate-mark t)
2076c87c
JB
2917 nil)
2918
2919(defun kill-ring-save (beg end)
0964e562 2920 "Save the region as if killed, but don't kill it.
0e264847 2921In Transient Mark mode, deactivate the mark.
0964e562 2922If `interprogram-cut-function' is non-nil, also save the text for a window
0e264847
RS
2923system cut and paste.
2924
81558867
EZ
2925If you want to append the killed line to the last killed text,
2926use \\[append-next-kill] before \\[kill-ring-save].
2927
0e264847
RS
2928This command is similar to `copy-region-as-kill', except that it gives
2929visual feedback indicating the extent of the region being copied."
2076c87c
JB
2930 (interactive "r")
2931 (copy-region-as-kill beg end)
bbf41690
RS
2932 ;; This use of interactive-p is correct
2933 ;; because the code it controls just gives the user visual feedback.
3a801d0c 2934 (if (interactive-p)
66050f10
RS
2935 (let ((other-end (if (= (point) beg) end beg))
2936 (opoint (point))
2937 ;; Inhibit quitting so we can make a quit here
2938 ;; look like a C-g typed as a command.
2939 (inhibit-quit t))
2940 (if (pos-visible-in-window-p other-end (selected-window))
d34c311a
SM
2941 ;; Swap point-and-mark quickly so as to show the region that
2942 ;; was selected. Don't do it if the region is highlighted.
2943 (unless (and (region-active-p)
977e2654 2944 (face-background 'region))
66050f10
RS
2945 ;; Swap point and mark.
2946 (set-marker (mark-marker) (point) (current-buffer))
2947 (goto-char other-end)
e4ef3e92 2948 (sit-for blink-matching-delay)
66050f10
RS
2949 ;; Swap back.
2950 (set-marker (mark-marker) other-end (current-buffer))
2951 (goto-char opoint)
2952 ;; If user quit, deactivate the mark
2953 ;; as C-g would as a command.
e4e593ae 2954 (and quit-flag mark-active
fcadf1c7 2955 (deactivate-mark)))
66050f10
RS
2956 (let* ((killed-text (current-kill 0))
2957 (message-len (min (length killed-text) 40)))
2958 (if (= (point) beg)
2959 ;; Don't say "killed"; that is misleading.
2960 (message "Saved text until \"%s\""
2961 (substring killed-text (- message-len)))
2962 (message "Saved text from \"%s\""
2963 (substring killed-text 0 message-len))))))))
2076c87c 2964
c75d4986
KH
2965(defun append-next-kill (&optional interactive)
2966 "Cause following command, if it kills, to append to previous kill.
2967The argument is used for internal purposes; do not supply one."
2968 (interactive "p")
2969 ;; We don't use (interactive-p), since that breaks kbd macros.
2970 (if interactive
2076c87c
JB
2971 (progn
2972 (setq this-command 'kill-region)
2973 (message "If the next command is a kill, it will append"))
2974 (setq last-command 'kill-region)))
cfb4f123 2975\f
93be67de 2976;; Yanking.
2076c87c 2977
cfb4f123
RS
2978;; This is actually used in subr.el but defcustom does not work there.
2979(defcustom yank-excluded-properties
be5936a7 2980 '(read-only invisible intangible field mouse-face help-echo local-map keymap
7408ee97 2981 yank-handler follow-link fontified)
3137dda8 2982 "Text properties to discard when yanking.
c6ff5a4c
LT
2983The value should be a list of text properties to discard or t,
2984which means to discard all text properties."
cfb4f123 2985 :type '(choice (const :tag "All" t) (repeat symbol))
c9f0110e 2986 :group 'killing
bf247b6e 2987 :version "22.1")
cfb4f123 2988
120de5bd 2989(defvar yank-window-start nil)
be5936a7 2990(defvar yank-undo-function nil
44f5a7b2
KS
2991 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2992Function is called with two parameters, START and END corresponding to
2993the value of the mark and point; it is guaranteed that START <= END.
2994Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
120de5bd 2995
6b61353c 2996(defun yank-pop (&optional arg)
ff1fbe3e
RS
2997 "Replace just-yanked stretch of killed text with a different stretch.
2998This command is allowed only immediately after a `yank' or a `yank-pop'.
2076c87c 2999At such a time, the region contains a stretch of reinserted
ff1fbe3e 3000previously-killed text. `yank-pop' deletes that text and inserts in its
2076c87c
JB
3001place a different stretch of killed text.
3002
3003With no argument, the previous kill is inserted.
ff1fbe3e
RS
3004With argument N, insert the Nth previous kill.
3005If N is negative, this is a more recent kill.
2076c87c
JB
3006
3007The sequence of kills wraps around, so that after the oldest one
a0e8eaa3
EZ
3008comes the newest one.
3009
3010When this command inserts killed text into the buffer, it honors
3011`yank-excluded-properties' and `yank-handler' as described in the
3012doc string for `insert-for-yank-1', which see."
2076c87c
JB
3013 (interactive "*p")
3014 (if (not (eq last-command 'yank))
3015 (error "Previous command was not a yank"))
3016 (setq this-command 'yank)
6b61353c 3017 (unless arg (setq arg 1))
3a5da8a8
RS
3018 (let ((inhibit-read-only t)
3019 (before (< (point) (mark t))))
8254897f
KS
3020 (if before
3021 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3022 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
be5936a7 3023 (setq yank-undo-function nil)
fd0f4056 3024 (set-marker (mark-marker) (point) (current-buffer))
cfb4f123 3025 (insert-for-yank (current-kill arg))
120de5bd
RS
3026 ;; Set the window start back where it was in the yank command,
3027 ;; if possible.
3028 (set-window-start (selected-window) yank-window-start t)
fd0f4056
RS
3029 (if before
3030 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3031 ;; It is cleaner to avoid activation, even though the command
3032 ;; loop would deactivate the mark because we inserted text.
3033 (goto-char (prog1 (mark t)
3034 (set-marker (mark-marker) (point) (current-buffer))))))
0964e562 3035 nil)
2076c87c
JB
3036
3037(defun yank (&optional arg)
f894e671 3038 "Reinsert (\"paste\") the last stretch of killed text.
2076c87c 3039More precisely, reinsert the stretch of killed text most recently
ff1fbe3e 3040killed OR yanked. Put point at end, and set mark at beginning.
d99f8496 3041With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
ff1fbe3e 3042With argument N, reinsert the Nth most recently killed stretch of killed
2076c87c 3043text.
a0e8eaa3
EZ
3044
3045When this command inserts killed text into the buffer, it honors
3046`yank-excluded-properties' and `yank-handler' as described in the
3047doc string for `insert-for-yank-1', which see.
3048
a9b9303c 3049See also the command `yank-pop' (\\[yank-pop])."
2076c87c 3050 (interactive "*P")
120de5bd 3051 (setq yank-window-start (window-start))
456c617c
RS
3052 ;; If we don't get all the way thru, make last-command indicate that
3053 ;; for the following command.
3054 (setq this-command t)
2076c87c 3055 (push-mark (point))
cfb4f123
RS
3056 (insert-for-yank (current-kill (cond
3057 ((listp arg) 0)
6b61353c 3058 ((eq arg '-) -2)
cfb4f123 3059 (t (1- arg)))))
2076c87c 3060 (if (consp arg)
fd0f4056
RS
3061 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3062 ;; It is cleaner to avoid activation, even though the command
3063 ;; loop would deactivate the mark because we inserted text.
3064 (goto-char (prog1 (mark t)
3065 (set-marker (mark-marker) (point) (current-buffer)))))
456c617c 3066 ;; If we do get all the way thru, make this-command indicate that.
be5936a7
KS
3067 (if (eq this-command t)
3068 (setq this-command 'yank))
0964e562 3069 nil)
70e14c01
JB
3070
3071(defun rotate-yank-pointer (arg)
3072 "Rotate the yanking point in the kill ring.
3073With argument, rotate that many kills forward (or backward, if negative)."
3074 (interactive "p")
3075 (current-kill arg))
2d88b556 3076\f
93be67de
KH
3077;; Some kill commands.
3078
3079;; Internal subroutine of delete-char
3080(defun kill-forward-chars (arg)
3081 (if (listp arg) (setq arg (car arg)))
3082 (if (eq arg '-) (setq arg -1))
3083 (kill-region (point) (forward-point arg)))
3084
3085;; Internal subroutine of backward-delete-char
3086(defun kill-backward-chars (arg)
3087 (if (listp arg) (setq arg (car arg)))
3088 (if (eq arg '-) (setq arg -1))
3089 (kill-region (point) (forward-point (- arg))))
3090
3091(defcustom backward-delete-char-untabify-method 'untabify
3092 "*The method for untabifying when deleting backward.
1e722f9f
SS
3093Can be `untabify' -- turn a tab to many spaces, then delete one space;
3094 `hungry' -- delete all whitespace, both tabs and spaces;
3095 `all' -- delete all whitespace, including tabs, spaces and newlines;
93be67de 3096 nil -- just delete one character."
1e722f9f 3097 :type '(choice (const untabify) (const hungry) (const all) (const nil))
03167a34 3098 :version "20.3"
93be67de
KH
3099 :group 'killing)
3100
3101(defun backward-delete-char-untabify (arg &optional killp)
3102 "Delete characters backward, changing tabs into spaces.
3103The exact behavior depends on `backward-delete-char-untabify-method'.
3104Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3105Interactively, ARG is the prefix arg (default 1)
3106and KILLP is t if a prefix arg was specified."
3107 (interactive "*p\nP")
3108 (when (eq backward-delete-char-untabify-method 'untabify)
3109 (let ((count arg))
3110 (save-excursion
3111 (while (and (> count 0) (not (bobp)))
3112 (if (= (preceding-char) ?\t)
3113 (let ((col (current-column)))
3114 (forward-char -1)
3115 (setq col (- col (current-column)))
f33321ad 3116 (insert-char ?\s col)
93be67de
KH
3117 (delete-char 1)))
3118 (forward-char -1)
3119 (setq count (1- count))))))
3120 (delete-backward-char
1e722f9f
SS
3121 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
3122 ((eq backward-delete-char-untabify-method 'all)
3123 " \t\n\r"))))
3124 (if skip
3125 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
93be67de
KH
3126 (point)))))
3127 (+ arg (if (zerop wh) 0 (1- wh))))
1e722f9f 3128 arg))
93be67de
KH
3129 killp))
3130
3131(defun zap-to-char (arg char)
3132 "Kill up to and including ARG'th occurrence of CHAR.
3133Case is ignored if `case-fold-search' is non-nil in the current buffer.
3134Goes backward if ARG is negative; error if CHAR not found."
e761e42c 3135 (interactive "p\ncZap to char: ")
9b59816e
GM
3136 (if (char-table-p translation-table-for-input)
3137 (setq char (or (aref translation-table-for-input char) char)))
93be67de
KH
3138 (kill-region (point) (progn
3139 (search-forward (char-to-string char) nil nil arg)
3140; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3141 (point))))
eaae8106 3142
93be67de
KH
3143;; kill-line and its subroutines.
3144
3145(defcustom kill-whole-line nil
3146 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3147 :type 'boolean
3148 :group 'killing)
3149
3150(defun kill-line (&optional arg)
3151 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3152With prefix argument, kill that many lines from point.
3153Negative arguments kill lines backward.
8be7408c 3154With zero argument, kills the text before point on the current line.
93be67de
KH
3155
3156When calling from a program, nil means \"no arg\",
3157a number counts as a prefix arg.
3158
3159To kill a whole line, when point is not at the beginning, type \
602157ab 3160\\[move-beginning-of-line] \\[kill-line] \\[kill-line].
93be67de
KH
3161
3162If `kill-whole-line' is non-nil, then this command kills the whole line
3163including its terminating newline, when used at the beginning of a line
3164with no argument. As a consequence, you can always kill a whole line
602157ab 3165by typing \\[move-beginning-of-line] \\[kill-line].
d3f22784 3166
81558867
EZ
3167If you want to append the killed line to the last killed text,
3168use \\[append-next-kill] before \\[kill-line].
3169
d3f22784
EZ
3170If the buffer is read-only, Emacs will beep and refrain from deleting
3171the line, but put the line in the kill ring anyway. This means that
1a534b89
RS
3172you can use this command to copy text from a read-only buffer.
3173\(If the variable `kill-read-only-ok' is non-nil, then this won't
3174even beep.)"
e761e42c 3175 (interactive "P")
93be67de
KH
3176 (kill-region (point)
3177 ;; It is better to move point to the other end of the kill
3178 ;; before killing. That way, in a read-only buffer, point
3179 ;; moves across the text that is copied to the kill ring.
3180 ;; The choice has no effect on undo now that undo records
3181 ;; the value of point from before the command was run.
3182 (progn
3183 (if arg
3184 (forward-visible-line (prefix-numeric-value arg))
3185 (if (eobp)
3186 (signal 'end-of-buffer nil))
5560dc5d
RS
3187 (let ((end
3188 (save-excursion
3189 (end-of-visible-line) (point))))
3190 (if (or (save-excursion
6b61353c
KH
3191 ;; If trailing whitespace is visible,
3192 ;; don't treat it as nothing.
3193 (unless show-trailing-whitespace
3194 (skip-chars-forward " \t" end))
5560dc5d
RS
3195 (= (point) end))
3196 (and kill-whole-line (bolp)))
3197 (forward-visible-line 1)
3198 (goto-char end))))
93be67de
KH
3199 (point))))
3200
348de80b
KG
3201(defun kill-whole-line (&optional arg)
3202 "Kill current line.
6c770e38
LT
3203With prefix arg, kill that many lines starting from the current line.
3204If arg is negative, kill backward. Also kill the preceding newline.
01ba9662 3205\(This is meant to make \\[repeat] work well with negative arguments.\)
348de80b 3206If arg is zero, kill current line but exclude the trailing newline."
f8b0f284 3207 (interactive "p")
6c770e38
LT
3208 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3209 (signal 'end-of-buffer nil))
3210 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3211 (signal 'beginning-of-buffer nil))
3212 (unless (eq last-command 'kill-region)
3213 (kill-new "")
3214 (setq last-command 'kill-region))
348de80b 3215 (cond ((zerop arg)
6c770e38
LT
3216 ;; We need to kill in two steps, because the previous command
3217 ;; could have been a kill command, in which case the text
3218 ;; before point needs to be prepended to the current kill
3219 ;; ring entry and the text after point appended. Also, we
3220 ;; need to use save-excursion to avoid copying the same text
3221 ;; twice to the kill ring in read-only buffers.
3222 (save-excursion
3223 (kill-region (point) (progn (forward-visible-line 0) (point))))
348de80b
KG
3224 (kill-region (point) (progn (end-of-visible-line) (point))))
3225 ((< arg 0)
6c770e38
LT
3226 (save-excursion
3227 (kill-region (point) (progn (end-of-visible-line) (point))))
3228 (kill-region (point)
3229 (progn (forward-visible-line (1+ arg))
3230 (unless (bobp) (backward-char))
3231 (point))))
348de80b 3232 (t
6c770e38
LT
3233 (save-excursion
3234 (kill-region (point) (progn (forward-visible-line 0) (point))))
3235 (kill-region (point)
3236 (progn (forward-visible-line arg) (point))))))
12a93712 3237
93be67de
KH
3238(defun forward-visible-line (arg)
3239 "Move forward by ARG lines, ignoring currently invisible newlines only.
3240If ARG is negative, move backward -ARG lines.
3241If ARG is zero, move to the beginning of the current line."
3242 (condition-case nil
3243 (if (> arg 0)
12a93712
RS
3244 (progn
3245 (while (> arg 0)
93be67de 3246 (or (zerop (forward-line 1))
12a93712
RS
3247 (signal 'end-of-buffer nil))
3248 ;; If the newline we just skipped is invisible,
3249 ;; don't count it.
3250 (let ((prop
3251 (get-char-property (1- (point)) 'invisible)))
3252 (if (if (eq buffer-invisibility-spec t)
3253 prop
3254 (or (memq prop buffer-invisibility-spec)
3255 (assq prop buffer-invisibility-spec)))
3256 (setq arg (1+ arg))))
3257 (setq arg (1- arg)))
3258 ;; If invisible text follows, and it is a number of complete lines,
3259 ;; skip it.
3260 (let ((opoint (point)))
3261 (while (and (not (eobp))
3262 (let ((prop
3263 (get-char-property (point) 'invisible)))
3264 (if (eq buffer-invisibility-spec t)
3265 prop
3266 (or (memq prop buffer-invisibility-spec)
3267 (assq prop buffer-invisibility-spec)))))
3268 (goto-char
3269 (if (get-text-property (point) 'invisible)
3270 (or (next-single-property-change (point) 'invisible)
3271 (point-max))
3272 (next-overlay-change (point)))))
3273 (unless (bolp)
3274 (goto-char opoint))))
93be67de 3275 (let ((first t))
f5fd8833
JB
3276 (while (or first (<= arg 0))
3277 (if first
93be67de
KH
3278 (beginning-of-line)
3279 (or (zerop (forward-line -1))
3280 (signal 'beginning-of-buffer nil)))
12a93712
RS
3281 ;; If the newline we just moved to is invisible,
3282 ;; don't count it.
3283 (unless (bobp)
3284 (let ((prop
3285 (get-char-property (1- (point)) 'invisible)))
f5fd8833
JB
3286 (unless (if (eq buffer-invisibility-spec t)
3287 prop
3288 (or (memq prop buffer-invisibility-spec)
3289 (assq prop buffer-invisibility-spec)))
3290 (setq arg (1+ arg)))))
3291 (setq first nil))
12a93712
RS
3292 ;; If invisible text follows, and it is a number of complete lines,
3293 ;; skip it.
3294 (let ((opoint (point)))
93be67de
KH
3295 (while (and (not (bobp))
3296 (let ((prop
3297 (get-char-property (1- (point)) 'invisible)))
3298 (if (eq buffer-invisibility-spec t)
3299 prop
3300 (or (memq prop buffer-invisibility-spec)
3301 (assq prop buffer-invisibility-spec)))))
3302 (goto-char
3303 (if (get-text-property (1- (point)) 'invisible)
3304 (or (previous-single-property-change (point) 'invisible)
3305 (point-min))
12a93712
RS
3306 (previous-overlay-change (point)))))
3307 (unless (bolp)
3308 (goto-char opoint)))))
93be67de
KH
3309 ((beginning-of-buffer end-of-buffer)
3310 nil)))
70e14c01 3311
93be67de
KH
3312(defun end-of-visible-line ()
3313 "Move to end of current visible line."
3314 (end-of-line)
3315 ;; If the following character is currently invisible,
3316 ;; skip all characters with that same `invisible' property value,
3317 ;; then find the next newline.
3318 (while (and (not (eobp))
5560dc5d
RS
3319 (save-excursion
3320 (skip-chars-forward "^\n")
3321 (let ((prop
3322 (get-char-property (point) 'invisible)))
3323 (if (eq buffer-invisibility-spec t)
3324 prop
3325 (or (memq prop buffer-invisibility-spec)
3326 (assq prop buffer-invisibility-spec))))))
3327 (skip-chars-forward "^\n")
93be67de
KH
3328 (if (get-text-property (point) 'invisible)
3329 (goto-char (next-single-property-change (point) 'invisible))
3330 (goto-char (next-overlay-change (point))))
3331 (end-of-line)))
2d88b556 3332\f
2076c87c
JB
3333(defun insert-buffer (buffer)
3334 "Insert after point the contents of BUFFER.
3335Puts mark after the inserted text.
6cb6e7a2
GM
3336BUFFER may be a buffer or a buffer name.
3337
3338This function is meant for the user to run interactively.
1e96c007 3339Don't call it from programs: use `insert-buffer-substring' instead!"
c3d4f949 3340 (interactive
a3e7c391
FP
3341 (list
3342 (progn
3343 (barf-if-buffer-read-only)
3344 (read-buffer "Insert buffer: "
3345 (if (eq (selected-window) (next-window (selected-window)))
3346 (other-buffer (current-buffer))
3347 (window-buffer (next-window (selected-window))))
3348 t))))
1e96c007
SM
3349 (push-mark
3350 (save-excursion
3351 (insert-buffer-substring (get-buffer buffer))
3352 (point)))
1537a263 3353 nil)
2076c87c
JB
3354
3355(defun append-to-buffer (buffer start end)
3356 "Append to specified buffer the text of the region.
3357It is inserted into that buffer before its point.
3358
3359When calling from a program, give three arguments:
3360BUFFER (or buffer name), START and END.
3361START and END specify the portion of the current buffer to be copied."
70e14c01 3362 (interactive
5d771766 3363 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
23efee2c 3364 (region-beginning) (region-end)))
2076c87c
JB
3365 (let ((oldbuf (current-buffer)))
3366 (save-excursion
c069a480
GM
3367 (let* ((append-to (get-buffer-create buffer))
3368 (windows (get-buffer-window-list append-to t t))
3369 point)
3370 (set-buffer append-to)
3371 (setq point (point))
3372 (barf-if-buffer-read-only)
3373 (insert-buffer-substring oldbuf start end)
3374 (dolist (window windows)
3375 (when (= (window-point window) point)
3376 (set-window-point window (point))))))))
2076c87c
JB
3377
3378(defun prepend-to-buffer (buffer start end)
3379 "Prepend to specified buffer the text of the region.
3380It is inserted into that buffer after its point.
3381
3382When calling from a program, give three arguments:
3383BUFFER (or buffer name), START and END.
3384START and END specify the portion of the current buffer to be copied."
3385 (interactive "BPrepend to buffer: \nr")
3386 (let ((oldbuf (current-buffer)))
3387 (save-excursion
3388 (set-buffer (get-buffer-create buffer))
74399eac 3389 (barf-if-buffer-read-only)
2076c87c
JB
3390 (save-excursion
3391 (insert-buffer-substring oldbuf start end)))))
3392
3393(defun copy-to-buffer (buffer start end)
3394 "Copy to specified buffer the text of the region.
3395It is inserted into that buffer, replacing existing text there.
3396
3397When calling from a program, give three arguments:
3398BUFFER (or buffer name), START and END.
3399START and END specify the portion of the current buffer to be copied."
3400 (interactive "BCopy to buffer: \nr")
3401 (let ((oldbuf (current-buffer)))
1b5fd09e 3402 (with-current-buffer (get-buffer-create buffer)
74399eac 3403 (barf-if-buffer-read-only)
2076c87c
JB
3404 (erase-buffer)
3405 (save-excursion
3406 (insert-buffer-substring oldbuf start end)))))
2d88b556 3407\f
62d1c1fc
RM
3408(put 'mark-inactive 'error-conditions '(mark-inactive error))
3409(put 'mark-inactive 'error-message "The mark is not active now")
3410
0251bafb
RS
3411(defvar activate-mark-hook nil
3412 "Hook run when the mark becomes active.
3413It is also run at the end of a command, if the mark is active and
6cbb0bb0 3414it is possible that the region may have changed.")
0251bafb
RS
3415
3416(defvar deactivate-mark-hook nil
3417 "Hook run when the mark becomes inactive.")
3418
af39530e 3419(defun mark (&optional force)
f00239cf
RS
3420 "Return this buffer's mark value as integer, or nil if never set.
3421
3422In Transient Mark mode, this function signals an error if
3423the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3424or the argument FORCE is non-nil, it disregards whether the mark
3425is active, and returns an integer or nil in the usual way.
af39530e 3426
2076c87c
JB
3427If you are using this in an editing command, you are most likely making
3428a mistake; see the documentation of `set-mark'."
0e3a7b14 3429 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
af39530e 3430 (marker-position (mark-marker))
62d1c1fc 3431 (signal 'mark-inactive nil)))
2076c87c 3432
19d35374
RM
3433;; Many places set mark-active directly, and several of them failed to also
3434;; run deactivate-mark-hook. This shorthand should simplify.
3435(defsubst deactivate-mark ()
3436 "Deactivate the mark by setting `mark-active' to nil.
fcadf1c7 3437\(That makes a difference only in Transient Mark mode.)
19d35374 3438Also runs the hook `deactivate-mark-hook'."
109cfe4e
CY
3439 (when transient-mark-mode
3440 (if (or (eq transient-mark-mode 'lambda)
3441 (and (eq (car-safe transient-mark-mode) 'only)
3442 (null (cdr transient-mark-mode))))
3443 (setq transient-mark-mode nil)
3444 (if (eq (car-safe transient-mark-mode) 'only)
3445 (setq transient-mark-mode (cdr transient-mark-mode)))
3446 (setq mark-active nil)
3447 (run-hooks 'deactivate-mark-hook))))
19d35374 3448
2977fc37
SM
3449(defun activate-mark ()
3450 "Activate the mark."
3451 (when (mark t)
3452 (setq mark-active t)
3453 (unless transient-mark-mode
3454 (setq transient-mark-mode 'lambda))))
3455
98b2fff4
RS
3456(defcustom select-active-regions nil
3457 "If non-nil, an active region automatically becomes the window selection."
3458 :type 'boolean
3459 :group 'killing
3460 :version "23.1")
3461
2076c87c
JB
3462(defun set-mark (pos)
3463 "Set this buffer's mark to POS. Don't use this function!
3464That is to say, don't use this function unless you want
3465the user to see that the mark has moved, and you want the previous
3466mark position to be lost.
3467
3468Normally, when a new mark is set, the old one should go on the stack.
f59006cb 3469This is why most applications should use `push-mark', not `set-mark'.
2076c87c 3470
ff1fbe3e 3471Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3472purposes. The mark saves a location for the user's convenience.
3473Most editing commands should not alter the mark.
3474To remember a location for internal use in the Lisp program,
3475store it in a Lisp variable. Example:
3476
3477 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3478
fcadf1c7
RS
3479 (if pos
3480 (progn
3481 (setq mark-active t)
3482 (run-hooks 'activate-mark-hook)
98b2fff4
RS
3483 (and select-active-regions
3484 (x-set-selection
3485 nil (buffer-substring (region-beginning) (region-end))))
fcadf1c7 3486 (set-marker (mark-marker) pos (current-buffer)))
24c22852
RS
3487 ;; Normally we never clear mark-active except in Transient Mark mode.
3488 ;; But when we actually clear out the mark value too,
3489 ;; we must clear mark-active in any mode.
3490 (setq mark-active nil)
3491 (run-hooks 'deactivate-mark-hook)
3492 (set-marker (mark-marker) nil)))
2076c87c 3493
d03b9b31
RS
3494(defcustom use-empty-active-region nil
3495 "If non-nil, an active region takes control even if empty.
3496This applies to certain commands which, in Transient Mark mode,
3497apply to the active region if there is one. If the setting is t,
3498these commands apply to an empty active region if there is one.
3499If the setting is nil, these commands treat an empty active
3500region as if it were not active."
3501 :type 'boolean
3502 :version "23.1"
3503 :group 'editing-basics)
3504
cb3a9d33 3505(defun use-region-p ()
d03b9b31
RS
3506 "Return t if certain commands should apply to the region.
3507Certain commands normally apply to text near point,
3508but in Transient Mark mode when the mark is active they apply
3509to the region instead. Such commands should use this subroutine to
3510test whether to do that.
3511
3512This function also obeys `use-empty-active-region'."
d34c311a 3513 (and (region-active-p)
d03b9b31
RS
3514 (or use-empty-active-region (> (region-end) (region-beginning)))))
3515
02d52519 3516(defun region-active-p ()
afa39f21 3517 "Return t if Transient Mark mode is enabled and the mark is active.
c6f3e207
CY
3518To test whether a command should operate on the region instead of
3519the usual behavior, use `use-region-p' instead. That returns nil
3520for empty regions when `use-empty-active-region' is nil."
02d52519
RS
3521 (and transient-mark-mode mark-active))
3522
2076c87c 3523(defvar mark-ring nil
e55e2267 3524 "The list of former marks of the current buffer, most recent first.")
2076c87c 3525(make-variable-buffer-local 'mark-ring)
e55e2267 3526(put 'mark-ring 'permanent-local t)
2076c87c 3527
69c1dd37
RS
3528(defcustom mark-ring-max 16
3529 "*Maximum size of mark ring. Start discarding off end if gets this big."
3530 :type 'integer
3531 :group 'editing-basics)
2076c87c 3532
dc029f0b
RM
3533(defvar global-mark-ring nil
3534 "The list of saved global marks, most recent first.")
3535
69c1dd37 3536(defcustom global-mark-ring-max 16
dc029f0b 3537 "*Maximum size of global mark ring. \
69c1dd37
RS
3538Start discarding off end if gets this big."
3539 :type 'integer
3540 :group 'editing-basics)
dc029f0b 3541
868c2f49
KS
3542(defun pop-to-mark-command ()
3543 "Jump to mark, and pop a new position for mark off the ring
3544\(does not affect global mark ring\)."
3545 (interactive)
3546 (if (null (mark t))
3547 (error "No mark set in this buffer")
fb2c06a3
RS
3548 (if (= (point) (mark t))
3549 (message "Mark popped"))
868c2f49
KS
3550 (goto-char (mark t))
3551 (pop-mark)))
3552
d00ffe21 3553(defun push-mark-command (arg &optional nomsg)
868c2f49 3554 "Set mark at where point is.
d00ffe21
KS
3555If no prefix arg and mark is already set there, just activate it.
3556Display `Mark set' unless the optional second arg NOMSG is non-nil."
868c2f49
KS
3557 (interactive "P")
3558 (let ((mark (marker-position (mark-marker))))
3559 (if (or arg (null mark) (/= mark (point)))
d00ffe21 3560 (push-mark nil nomsg t)
868c2f49 3561 (setq mark-active t)
0251bafb 3562 (run-hooks 'activate-mark-hook)
d00ffe21
KS
3563 (unless nomsg
3564 (message "Mark activated")))))
868c2f49 3565
6a936796 3566(defcustom set-mark-command-repeat-pop nil
ebd2fc0d
RS
3567 "*Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
3568That means that C-u \\[set-mark-command] \\[set-mark-command]
3569will pop the mark twice, and
3570C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
3571will pop the mark three times.
3572
7b17b503 3573A value of nil means \\[set-mark-command]'s behavior does not change
ebd2fc0d 3574after C-u \\[set-mark-command]."
6a936796 3575 :type 'boolean
034ce0ec 3576 :group 'editing-basics)
6a936796 3577
2076c87c 3578(defun set-mark-command (arg)
fb2c06a3
RS
3579 "Set the mark where point is, or jump to the mark.
3580Setting the mark also alters the region, which is the text
3581between point and mark; this is the closest equivalent in
3582Emacs to what some editors call the \"selection\".
146adea3 3583
fb2c06a3
RS
3584With no prefix argument, set the mark at point, and push the
3585old mark position on local mark ring. Also push the old mark on
3586global mark ring, if the previous mark was set in another buffer.
146adea3 3587
17923ef2
CY
3588When Transient Mark Mode is off, immediately repeating this
3589command activates `transient-mark-mode' temporarily.
66ef2df9 3590
146adea3 3591With prefix argument \(e.g., \\[universal-argument] \\[set-mark-command]\), \
fb2c06a3 3592jump to the mark, and set the mark from
146adea3
EZ
3593position popped off the local mark ring \(this does not affect the global
3594mark ring\). Use \\[pop-global-mark] to jump to a mark popped off the global
66ef2df9 3595mark ring \(see `pop-global-mark'\).
18c5df40 3596
2ef0a47e 3597If `set-mark-command-repeat-pop' is non-nil, repeating
146adea3 3598the \\[set-mark-command] command with no prefix argument pops the next position
2ef0a47e 3599off the local (or global) mark ring and jumps there.
66ef2df9 3600
fb2c06a3
RS
3601With \\[universal-argument] \\[universal-argument] as prefix
3602argument, unconditionally set mark where point is, even if
3603`set-mark-command-repeat-pop' is non-nil.
7cb42362 3604
ff1fbe3e 3605Novice Emacs Lisp programmers often try to use the mark for the wrong
2076c87c
JB
3606purposes. See the documentation of `set-mark' for more information."
3607 (interactive "P")
109cfe4e
CY
3608 (cond ((eq transient-mark-mode 'lambda)
3609 (setq transient-mark-mode nil))
3610 ((eq (car-safe transient-mark-mode) 'only)
3611 (deactivate-mark)))
868c2f49 3612 (cond
18c5df40
KS
3613 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3614 (push-mark-command nil))
868c2f49 3615 ((not (eq this-command 'set-mark-command))
1841f9e3
KS
3616 (if arg
3617 (pop-to-mark-command)
3618 (push-mark-command t)))
6a936796
RS
3619 ((and set-mark-command-repeat-pop
3620 (eq last-command 'pop-to-mark-command))
66ef2df9
KS
3621 (setq this-command 'pop-to-mark-command)
3622 (pop-to-mark-command))
6a936796
RS
3623 ((and set-mark-command-repeat-pop
3624 (eq last-command 'pop-global-mark)
3625 (not arg))
66ef2df9
KS
3626 (setq this-command 'pop-global-mark)
3627 (pop-global-mark))
868c2f49 3628 (arg
1841f9e3 3629 (setq this-command 'pop-to-mark-command)
868c2f49 3630 (pop-to-mark-command))
2977fc37
SM
3631 ((eq last-command 'set-mark-command)
3632 (if (region-active-p)
3633 (progn
3634 (deactivate-mark)
3635 (message "Mark deactivated"))
3636 (activate-mark)
3637 (message "Mark activated")))
868c2f49
KS
3638 (t
3639 (push-mark-command nil))))
2076c87c 3640
fd0f4056 3641(defun push-mark (&optional location nomsg activate)
2076c87c 3642 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
f1382a3d
RM
3643If the last global mark pushed was not in the current buffer,
3644also push LOCATION on the global mark ring.
fd0f4056 3645Display `Mark set' unless the optional second arg NOMSG is non-nil.
2076c87c 3646
ff1fbe3e 3647Novice Emacs Lisp programmers often try to use the mark for the wrong
9a1277dd
RS
3648purposes. See the documentation of `set-mark' for more information.
3649
de9606f0 3650In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
1a0d0b6a 3651 (unless (null (mark t))
2076c87c 3652 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1a0d0b6a
JPW
3653 (when (> (length mark-ring) mark-ring-max)
3654 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3655 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
9a1277dd 3656 (set-marker (mark-marker) (or location (point)) (current-buffer))
dc029f0b 3657 ;; Now push the mark on the global mark ring.
f1382a3d 3658 (if (and global-mark-ring
e08d3f7c 3659 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
f1382a3d
RM
3660 ;; The last global mark pushed was in this same buffer.
3661 ;; Don't push another one.
3662 nil
3663 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1a0d0b6a
JPW
3664 (when (> (length global-mark-ring) global-mark-ring-max)
3665 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3666 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
efcf38c7 3667 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2076c87c 3668 (message "Mark set"))
8cdc660f
RS
3669 (if (or activate (not transient-mark-mode))
3670 (set-mark (mark t)))
2076c87c
JB
3671 nil)
3672
3673(defun pop-mark ()
3674 "Pop off mark ring into the buffer's actual mark.
3675Does not set point. Does nothing if mark ring is empty."
1a0d0b6a
JPW
3676 (when mark-ring
3677 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3678 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1a0d0b6a
JPW
3679 (move-marker (car mark-ring) nil)
3680 (if (null (mark t)) (ding))
0137bae6
JL
3681 (setq mark-ring (cdr mark-ring)))
3682 (deactivate-mark))
2076c87c 3683
e462e42f 3684(defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
868c2f49 3685(defun exchange-point-and-mark (&optional arg)
af39530e
RS
3686 "Put the mark where point is now, and point where the mark is now.
3687This command works even when the mark is not active,
868c2f49 3688and it reactivates the mark.
109cfe4e
CY
3689
3690If Transient Mark mode is on, a prefix arg deactivates the mark
3691if it is active, and otherwise avoids reactivating it. If
3692Transient Mark mode is off, a prefix arg enables Transient Mark
3693mode temporarily."
868c2f49 3694 (interactive "P")
109cfe4e
CY
3695 (let ((omark (mark t))
3696 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
2977fc37
SM
3697 (if (null omark)
3698 (error "No mark set in this buffer"))
109cfe4e 3699 (deactivate-mark)
2977fc37
SM
3700 (set-mark (point))
3701 (goto-char omark)
109cfe4e
CY
3702 (cond (temp-highlight
3703 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3704 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3705 (not (or arg (region-active-p))))
3706 (deactivate-mark))
3707 (t (activate-mark)))
2977fc37 3708 nil))
e23c2c21 3709
ac1491a7 3710(defun handle-shift-selection (&optional deactivate)
109cfe4e
CY
3711 "Check for shift translation, and operate on the mark accordingly.
3712This is called whenever a command with a `^' character in its
3713`interactive' spec is invoked while `shift-select-mode' is
3714non-nil.
3715
3716If the command was invoked through shift-translation, set the
3717mark and activate the region temporarily, unless it was already
3718set in this way. If the command was invoked without
3719shift-translation and a region is temporarily active, deactivate
ac1491a7
CY
3720the mark.
3721
3722With optional arg DEACTIVATE, only perform region deactivation."
3723 (cond ((and this-command-keys-shift-translated
3724 (null deactivate))
109cfe4e
CY
3725 (unless (and mark-active
3726 (eq (car-safe transient-mark-mode) 'only))
3727 (setq transient-mark-mode
3728 (cons 'only
3729 (unless (eq transient-mark-mode 'lambda)
3730 transient-mark-mode)))
3731 (push-mark nil nil t)))
3732 ((eq (car-safe transient-mark-mode) 'only)
3733 (setq transient-mark-mode (cdr transient-mark-mode))
3734 (deactivate-mark))))
3735
6710df48 3736(define-minor-mode transient-mark-mode
e23c2c21 3737 "Toggle Transient Mark mode.
b411b5fa 3738With arg, turn Transient Mark mode on if arg is positive, off otherwise.
e23c2c21 3739
5dd1220d
RS
3740In Transient Mark mode, when the mark is active, the region is highlighted.
3741Changing the buffer \"deactivates\" the mark.
3742So do certain other operations that set the mark
3743but whose main purpose is something else--for example,
cfa70244
EZ
3744incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
3745
8e843bc4
EZ
3746You can also deactivate the mark by typing \\[keyboard-quit] or
3747\\[keyboard-escape-quit].
1465c66b 3748
cfa70244
EZ
3749Many commands change their behavior when Transient Mark mode is in effect
3750and the mark is active, by acting on the region instead of their usual
4c5f7215 3751default part of the buffer's text. Examples of such commands include
705a5933
JL
3752\\[comment-dwim], \\[flush-lines], \\[keep-lines], \
3753\\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
3754Invoke \\[apropos-documentation] and type \"transient\" or
3755\"mark.*active\" at the prompt, to see the documentation of
3756commands which are sensitive to the Transient Mark mode."
43d16385 3757 :global t
715043a5 3758 :init-value (not noninteractive)
a2b84f35 3759 :group 'editing-basics)
dc029f0b 3760
109cfe4e
CY
3761;; The variable transient-mark-mode is ugly: it can take on special
3762;; values. Document these here.
3763(defvar transient-mark-mode t
3764 "*Non-nil if Transient Mark mode is enabled.
3765See the command `transient-mark-mode' for a description of this minor mode.
3766
3767Non-nil also enables highlighting of the region whenever the mark is active.
3768The variable `highlight-nonselected-windows' controls whether to highlight
3769all windows or just the selected window.
3770
3771If the value is `lambda', that enables Transient Mark mode
3772temporarily. After any subsequent action that would normally
3773deactivate the mark (such as buffer modification), Transient Mark mode
3774is turned off.
3775
3776If the value is (only . OLDVAL), that enables Transient Mark mode
3777temporarily. After any subsequent point motion command that is not
3778shift-translated, or any other action that would normally deactivate
3779the mark (such as buffer modification), the value of
3780`transient-mark-mode' is set to OLDVAL.")
3781
d0c4882d
RS
3782(defvar widen-automatically t
3783 "Non-nil means it is ok for commands to call `widen' when they want to.
3784Some commands will do this in order to go to positions outside
3785the current accessible part of the buffer.
3786
3787If `widen-automatically' is nil, these commands will do something else
3788as a fallback, and won't change the buffer bounds.")
3789
dc029f0b
RM
3790(defun pop-global-mark ()
3791 "Pop off global mark ring and jump to the top location."
3792 (interactive)
52b6d445
RS
3793 ;; Pop entries which refer to non-existent buffers.
3794 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3795 (setq global-mark-ring (cdr global-mark-ring)))
dc029f0b
RM
3796 (or global-mark-ring
3797 (error "No global mark set"))
3798 (let* ((marker (car global-mark-ring))
3799 (buffer (marker-buffer marker))
3800 (position (marker-position marker)))
34c31301
RS
3801 (setq global-mark-ring (nconc (cdr global-mark-ring)
3802 (list (car global-mark-ring))))
dc029f0b
RM
3803 (set-buffer buffer)
3804 (or (and (>= position (point-min))
3805 (<= position (point-max)))
d0c4882d 3806 (if widen-automatically
60aee8b2
RS
3807 (widen)
3808 (error "Global mark position is outside accessible part of buffer")))
dc029f0b
RM
3809 (goto-char position)
3810 (switch-to-buffer buffer)))
2d88b556 3811\f
95791033 3812(defcustom next-line-add-newlines nil
69c1dd37
RS
3813 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3814 :type 'boolean
e1d6e383 3815 :version "21.1"
69c1dd37 3816 :group 'editing-basics)
38ebcf29 3817
295f6616 3818(defun next-line (&optional arg try-vscroll)
2076c87c 3819 "Move cursor vertically down ARG lines.
295f6616 3820Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
3821If there is no character in the target line exactly under the current column,
3822the cursor is positioned after the character in that line which spans this
3823column, or at the end of the line if it is not long enough.
38ebcf29 3824If there is no line in the buffer after this one, behavior depends on the
1a2c3941
RS
3825value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3826to create a line, and moves the cursor to that line. Otherwise it moves the
e47d38f6 3827cursor to the end of the buffer.
2076c87c 3828
53a22af4
CY
3829If the variable `line-move-visual' is non-nil, this command moves
3830by display lines. Otherwise, it moves by buffer lines, without
3831taking variable-width characters or continued lines into account.
3832
2076c87c 3833The command \\[set-goal-column] can be used to create
85969cb1
RS
3834a semipermanent goal column for this command.
3835Then instead of trying to move exactly vertically (or as close as possible),
3836this command moves to the specified goal column (or as close as possible).
3837The goal column is stored in the variable `goal-column', which is nil
3838when there is no goal column.
2076c87c
JB
3839
3840If you are thinking of using this in a Lisp program, consider
3841using `forward-line' instead. It is usually easier to use
3842and more reliable (no dependence on goal column, etc.)."
109cfe4e 3843 (interactive "^p\np")
6b61353c 3844 (or arg (setq arg 1))
028922cf 3845 (if (and next-line-add-newlines (= arg 1))
207d7545
GM
3846 (if (save-excursion (end-of-line) (eobp))
3847 ;; When adding a newline, don't expand an abbrev.
3848 (let ((abbrev-mode nil))
24886813 3849 (end-of-line)
15575807 3850 (insert (if use-hard-newlines hard-newline "\n")))
295f6616 3851 (line-move arg nil nil try-vscroll))
1a2c3941
RS
3852 (if (interactive-p)
3853 (condition-case nil
295f6616 3854 (line-move arg nil nil try-vscroll)
1a2c3941 3855 ((beginning-of-buffer end-of-buffer) (ding)))
295f6616 3856 (line-move arg nil nil try-vscroll)))
2076c87c
JB
3857 nil)
3858
295f6616 3859(defun previous-line (&optional arg try-vscroll)
2076c87c 3860 "Move cursor vertically up ARG lines.
295f6616 3861Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
2076c87c
JB
3862If there is no character in the target line exactly over the current column,
3863the cursor is positioned after the character in that line which spans this
3864column, or at the end of the line if it is not long enough.
3865
53a22af4
CY
3866If the variable `line-move-visual' is non-nil, this command moves
3867by display lines. Otherwise, it moves by buffer lines, without
3868taking variable-width characters or continued lines into account.
3869
2076c87c 3870The command \\[set-goal-column] can be used to create
85969cb1
RS
3871a semipermanent goal column for this command.
3872Then instead of trying to move exactly vertically (or as close as possible),
3873this command moves to the specified goal column (or as close as possible).
3874The goal column is stored in the variable `goal-column', which is nil
3875when there is no goal column.
2076c87c
JB
3876
3877If you are thinking of using this in a Lisp program, consider using
c2e8a012 3878`forward-line' with a negative argument instead. It is usually easier
2076c87c 3879to use and more reliable (no dependence on goal column, etc.)."
109cfe4e 3880 (interactive "^p\np")
6b61353c 3881 (or arg (setq arg 1))
1a2c3941
RS
3882 (if (interactive-p)
3883 (condition-case nil
295f6616 3884 (line-move (- arg) nil nil try-vscroll)
1a2c3941 3885 ((beginning-of-buffer end-of-buffer) (ding)))
295f6616 3886 (line-move (- arg) nil nil try-vscroll))
2076c87c 3887 nil)
eaae8106 3888
69c1dd37 3889(defcustom track-eol nil
2076c87c
JB
3890 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3891This means moving to the end of each line moved onto.
4efebb82
CY
3892The beginning of a blank line does not count as the end of a line.
3893This has no effect when `line-move-visual' is non-nil."
69c1dd37
RS
3894 :type 'boolean
3895 :group 'editing-basics)
3896
3897(defcustom goal-column nil
3898 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
3899 :type '(choice integer
3900 (const :tag "None" nil))
3901 :group 'editing-basics)
912c6728 3902(make-variable-buffer-local 'goal-column)
2076c87c
JB
3903
3904(defvar temporary-goal-column 0
3905 "Current goal column for vertical motion.
4efebb82
CY
3906It is the column where point was at the start of the current run
3907of vertical motion commands. It is a floating point number when
3908moving by visual lines via `line-move-visual'; this is the
3909x-position, in pixels, divided by the default column width. When
3910the `track-eol' feature is doing its job, the value is
3911`most-positive-fixnum'.")
2076c87c 3912
bbf41690 3913(defcustom line-move-ignore-invisible t
098fc1fb 3914 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
69c1dd37
RS
3915Outline mode sets this."
3916 :type 'boolean
3917 :group 'editing-basics)
098fc1fb 3918
a2cf21a2 3919(defcustom line-move-visual t
4efebb82
CY
3920 "When non-nil, `line-move' moves point by visual lines.
3921This movement is based on where the cursor is displayed on the
3922screen, instead of relying on buffer contents alone. It takes
a2cf21a2
CY
3923into account variable-width characters and line continuation."
3924 :type 'boolean
3925 :group 'editing-basics)
4efebb82 3926
b704b1f0
KS
3927;; Returns non-nil if partial move was done.
3928(defun line-move-partial (arg noerror to-end)
3929 (if (< arg 0)
3930 ;; Move backward (up).
3931 ;; If already vscrolled, reduce vscroll
3932 (let ((vs (window-vscroll nil t)))
3933 (when (> vs (frame-char-height))
3934 (set-window-vscroll nil (- vs (frame-char-height)) t)))
3935
3936 ;; Move forward (down).
e437f99a
KS
3937 (let* ((lh (window-line-height -1))
3938 (vpos (nth 1 lh))
3939 (ypos (nth 2 lh))
3940 (rbot (nth 3 lh))
3137dda8 3941 py vs)
e437f99a
KS
3942 (when (or (null lh)
3943 (>= rbot (frame-char-height))
3944 (<= ypos (- (frame-char-height))))
3945 (unless lh
0e7a5039
KS
3946 (let ((wend (pos-visible-in-window-p t nil t)))
3947 (setq rbot (nth 3 wend)
3948 vpos (nth 5 wend))))
e437f99a
KS
3949 (cond
3950 ;; If last line of window is fully visible, move forward.
3951 ((or (null rbot) (= rbot 0))
3952 nil)
3953 ;; If cursor is not in the bottom scroll margin, move forward.
3954 ((and (> vpos 0)
95f5a37f
KS
3955 (< (setq py
3956 (or (nth 1 (window-line-height))
3957 (let ((ppos (posn-at-point)))
3958 (cdr (or (posn-actual-col-row ppos)
3959 (posn-col-row ppos))))))
e437f99a
KS
3960 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
3961 nil)
3962 ;; When already vscrolled, we vscroll some more if we can,
3963 ;; or clear vscroll and move forward at end of tall image.
3964 ((> (setq vs (window-vscroll nil t)) 0)
3965 (when (> rbot 0)
3966 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
3967 ;; If cursor just entered the bottom scroll margin, move forward,
3968 ;; but also vscroll one line so redisplay wont recenter.
3969 ((and (> vpos 0)
3970 (= py (min (- (window-text-height) scroll-margin 1)
3971 (1- vpos))))
3972 (set-window-vscroll nil (frame-char-height) t)
3973 (line-move-1 arg noerror to-end)
3974 t)
3975 ;; If there are lines above the last line, scroll-up one line.
3976 ((> vpos 0)
3977 (scroll-up 1)
3978 t)
3979 ;; Finally, start vscroll.
3980 (t
3981 (set-window-vscroll nil (frame-char-height) t)))))))
b704b1f0
KS
3982
3983
03ceda9e
RS
3984;; This is like line-move-1 except that it also performs
3985;; vertical scrolling of tall images if appropriate.
3986;; That is not really a clean thing to do, since it mixes
3987;; scrolling with cursor motion. But so far we don't have
3988;; a cleaner solution to the problem of making C-n do something
3989;; useful given a tall image.
ed02c1db 3990(defun line-move (arg &optional noerror to-end try-vscroll)
b704b1f0
KS
3991 (unless (and auto-window-vscroll try-vscroll
3992 ;; Only vscroll for single line moves
3993 (= (abs arg) 1)
3994 ;; But don't vscroll in a keyboard macro.
3995 (not defining-kbd-macro)
3996 (not executing-kbd-macro)
3997 (line-move-partial arg noerror to-end))
3998 (set-window-vscroll nil 0 t)
4efebb82
CY
3999 (if line-move-visual
4000 (line-move-visual arg noerror)
4001 (line-move-1 arg noerror to-end))))
4002
4003;; Display-based alternative to line-move-1.
4004;; Arg says how many lines to move. The value is t if we can move the
4005;; specified number of lines.
4006(defun line-move-visual (arg &optional noerror)
4007 (unless (and (floatp temporary-goal-column)
2c80f06b
CY
4008 (or (memq last-command '(next-line previous-line))
4009 ;; In case we're called from some other command.
4010 (eq last-command this-command)))
4011 (let ((x (car (nth 2 (posn-at-point)))))
4012 (when x
4013 (setq temporary-goal-column (/ (float x) (frame-char-width))))))
4014 (or (= (vertical-motion
4015 (cons (or goal-column (truncate temporary-goal-column)) arg))
4016 arg)
4017 (unless noerror
4018 (signal (if (< arg 0)
4019 'beginning-of-buffer
4020 'end-of-buffer)
4021 nil))))
16c2f92f 4022
8c745744
RS
4023;; This is the guts of next-line and previous-line.
4024;; Arg says how many lines to move.
bbf41690 4025;; The value is t if we can move the specified number of lines.
16c2f92f 4026(defun line-move-1 (arg &optional noerror to-end)
2596511d
RS
4027 ;; Don't run any point-motion hooks, and disregard intangibility,
4028 ;; for intermediate positions.
4029 (let ((inhibit-point-motion-hooks t)
4030 (opoint (point))
fef11f15 4031 (orig-arg arg))
a2cf21a2
CY
4032 (if (floatp temporary-goal-column)
4033 (setq temporary-goal-column (truncate temporary-goal-column)))
2596511d
RS
4034 (unwind-protect
4035 (progn
41d22ee0 4036 (if (not (memq last-command '(next-line previous-line)))
2596511d
RS
4037 (setq temporary-goal-column
4038 (if (and track-eol (eolp)
4039 ;; Don't count beg of empty line as end of line
4040 ;; unless we just did explicit end-of-line.
ab9623c2 4041 (or (not (bolp)) (eq last-command 'move-end-of-line)))
3137dda8 4042 most-positive-fixnum
2596511d 4043 (current-column))))
bbf41690 4044
3137dda8
SM
4045 (if (not (or (integerp selective-display)
4046 line-move-ignore-invisible))
2596511d 4047 ;; Use just newline characters.
e9cd25fe 4048 ;; Set ARG to 0 if we move as many lines as requested.
2596511d
RS
4049 (or (if (> arg 0)
4050 (progn (if (> arg 1) (forward-line (1- arg)))
4051 ;; This way of moving forward ARG lines
4052 ;; verifies that we have a newline after the last one.
4053 ;; It doesn't get confused by intangible text.
4054 (end-of-line)
e9cd25fe
RS
4055 (if (zerop (forward-line 1))
4056 (setq arg 0)))
2596511d 4057 (and (zerop (forward-line arg))
e9cd25fe
RS
4058 (bolp)
4059 (setq arg 0)))
bbf41690
RS
4060 (unless noerror
4061 (signal (if (< arg 0)
4062 'beginning-of-buffer
4063 'end-of-buffer)
4064 nil)))
2596511d 4065 ;; Move by arg lines, but ignore invisible ones.
07889873 4066 (let (done)
bbf41690
RS
4067 (while (and (> arg 0) (not done))
4068 ;; If the following character is currently invisible,
4069 ;; skip all characters with that same `invisible' property value.
c65e6942 4070 (while (and (not (eobp)) (invisible-p (point)))
bbf41690 4071 (goto-char (next-char-property-change (point))))
fef11f15
CY
4072 ;; Move a line.
4073 ;; We don't use `end-of-line', since we want to escape
4074 ;; from field boundaries ocurring exactly at point.
07889873
CY
4075 (goto-char (constrain-to-field
4076 (let ((inhibit-field-text-motion t))
4077 (line-end-position))
4078 (point) t t
4079 'inhibit-line-move-field-capture))
e9ab825f 4080 ;; If there's no invisibility here, move over the newline.
3e43ae87
KS
4081 (cond
4082 ((eobp)
4083 (if (not noerror)
4084 (signal 'end-of-buffer nil)
4085 (setq done t)))
4086 ((and (> arg 1) ;; Use vertical-motion for last move
4087 (not (integerp selective-display))
c65e6942 4088 (not (invisible-p (point))))
3e43ae87
KS
4089 ;; We avoid vertical-motion when possible
4090 ;; because that has to fontify.
4091 (forward-line 1))
4092 ;; Otherwise move a more sophisticated way.
4093 ((zerop (vertical-motion 1))
4094 (if (not noerror)
4095 (signal 'end-of-buffer nil)
4096 (setq done t))))
bbf41690
RS
4097 (unless done
4098 (setq arg (1- arg))))
22c8bff1 4099 ;; The logic of this is the same as the loop above,
e9ab825f 4100 ;; it just goes in the other direction.
bbf41690 4101 (while (and (< arg 0) (not done))
ac6701ea
CY
4102 ;; For completely consistency with the forward-motion
4103 ;; case, we should call beginning-of-line here.
4104 ;; However, if point is inside a field and on a
4105 ;; continued line, the call to (vertical-motion -1)
4106 ;; below won't move us back far enough; then we return
4107 ;; to the same column in line-move-finish, and point
4108 ;; gets stuck -- cyd
4109 (forward-line 0)
3e43ae87
KS
4110 (cond
4111 ((bobp)
4112 (if (not noerror)
4113 (signal 'beginning-of-buffer nil)
4114 (setq done t)))
4115 ((and (< arg -1) ;; Use vertical-motion for last move
4116 (not (integerp selective-display))
c65e6942 4117 (not (invisible-p (1- (point)))))
3e43ae87
KS
4118 (forward-line -1))
4119 ((zerop (vertical-motion -1))
4120 (if (not noerror)
4121 (signal 'beginning-of-buffer nil)
4122 (setq done t))))
bbf41690
RS
4123 (unless done
4124 (setq arg (1+ arg))
4125 (while (and ;; Don't move over previous invis lines
4126 ;; if our target is the middle of this line.
4127 (or (zerop (or goal-column temporary-goal-column))
4128 (< arg 0))
c65e6942 4129 (not (bobp)) (invisible-p (1- (point))))
bbf41690
RS
4130 (goto-char (previous-char-property-change (point))))))))
4131 ;; This is the value the function returns.
4132 (= arg 0))
af894fc9 4133
e9cd25fe 4134 (cond ((> arg 0)
2a1e0c92
CY
4135 ;; If we did not move down as far as desired, at least go
4136 ;; to end of line. Be sure to call point-entered and
4137 ;; point-left-hooks.
4138 (let* ((npoint (prog1 (line-end-position)
4139 (goto-char opoint)))
4140 (inhibit-point-motion-hooks nil))
4141 (goto-char npoint)))
e9cd25fe 4142 ((< arg 0)
f9872a6b
JL
4143 ;; If we did not move up as far as desired,
4144 ;; at least go to beginning of line.
2a1e0c92
CY
4145 (let* ((npoint (prog1 (line-beginning-position)
4146 (goto-char opoint)))
4147 (inhibit-point-motion-hooks nil))
4148 (goto-char npoint)))
e9cd25fe 4149 (t
20782abb 4150 (line-move-finish (or goal-column temporary-goal-column)
fef11f15 4151 opoint (> orig-arg 0)))))))
2076c87c 4152
20782abb 4153(defun line-move-finish (column opoint forward)
af894fc9
RS
4154 (let ((repeat t))
4155 (while repeat
4156 ;; Set REPEAT to t to repeat the whole thing.
4157 (setq repeat nil)
4158
1f980920 4159 (let (new
963355a4 4160 (old (point))
af894fc9 4161 (line-beg (save-excursion (beginning-of-line) (point)))
1f980920
RS
4162 (line-end
4163 ;; Compute the end of the line
20782abb 4164 ;; ignoring effectively invisible newlines.
bbf41690 4165 (save-excursion
a5b4a6a0
RS
4166 ;; Like end-of-line but ignores fields.
4167 (skip-chars-forward "^\n")
c65e6942 4168 (while (and (not (eobp)) (invisible-p (point)))
20782abb 4169 (goto-char (next-char-property-change (point)))
a5b4a6a0 4170 (skip-chars-forward "^\n"))
bbf41690 4171 (point))))
1f980920
RS
4172
4173 ;; Move to the desired column.
4174 (line-move-to-column column)
963355a4
CY
4175
4176 ;; Corner case: suppose we start out in a field boundary in
4177 ;; the middle of a continued line. When we get to
4178 ;; line-move-finish, point is at the start of a new *screen*
4179 ;; line but the same text line; then line-move-to-column would
4180 ;; move us backwards. Test using C-n with point on the "x" in
4181 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4182 (and forward
4183 (< (point) old)
4184 (goto-char old))
4185
1f980920 4186 (setq new (point))
af894fc9
RS
4187
4188 ;; Process intangibility within a line.
594a1605
CY
4189 ;; With inhibit-point-motion-hooks bound to nil, a call to
4190 ;; goto-char moves point past intangible text.
4191
4192 ;; However, inhibit-point-motion-hooks controls both the
4193 ;; intangibility and the point-entered/point-left hooks. The
4194 ;; following hack avoids calling the point-* hooks
4195 ;; unnecessarily. Note that we move *forward* past intangible
4196 ;; text when the initial and final points are the same.
d584e29d 4197 (goto-char new)
af894fc9
RS
4198 (let ((inhibit-point-motion-hooks nil))
4199 (goto-char new)
4200
4201 ;; If intangibility moves us to a different (later) place
4202 ;; in the same line, use that as the destination.
4203 (if (<= (point) line-end)
1f980920
RS
4204 (setq new (point))
4205 ;; If that position is "too late",
4206 ;; try the previous allowable position.
4207 ;; See if it is ok.
4208 (backward-char)
20782abb
RS
4209 (if (if forward
4210 ;; If going forward, don't accept the previous
4211 ;; allowable position if it is before the target line.
f1e2a033 4212 (< line-beg (point))
20782abb
RS
4213 ;; If going backward, don't accept the previous
4214 ;; allowable position if it is still after the target line.
4215 (<= (point) line-end))
1f980920
RS
4216 (setq new (point))
4217 ;; As a last resort, use the end of the line.
4218 (setq new line-end))))
af894fc9
RS
4219
4220 ;; Now move to the updated destination, processing fields
4221 ;; as well as intangibility.
4222 (goto-char opoint)
4223 (let ((inhibit-point-motion-hooks nil))
4224 (goto-char
e94e78cc
CY
4225 ;; Ignore field boundaries if the initial and final
4226 ;; positions have the same `field' property, even if the
4227 ;; fields are non-contiguous. This seems to be "nicer"
4228 ;; behavior in many situations.
4229 (if (eq (get-char-property new 'field)
4230 (get-char-property opoint 'field))
4231 new
4232 (constrain-to-field new opoint t t
4233 'inhibit-line-move-field-capture))))
af894fc9 4234
1f980920 4235 ;; If all this moved us to a different line,
af894fc9
RS
4236 ;; retry everything within that new line.
4237 (when (or (< (point) line-beg) (> (point) line-end))
4238 ;; Repeat the intangibility and field processing.
4239 (setq repeat t))))))
4240
4241(defun line-move-to-column (col)
4242 "Try to find column COL, considering invisibility.
4243This function works only in certain cases,
4244because what we really need is for `move-to-column'
4245and `current-column' to be able to ignore invisible text."
a615252b
RS
4246 (if (zerop col)
4247 (beginning-of-line)
095f9ae4 4248 (move-to-column col))
af894fc9
RS
4249
4250 (when (and line-move-ignore-invisible
c65e6942 4251 (not (bolp)) (invisible-p (1- (point))))
af894fc9
RS
4252 (let ((normal-location (point))
4253 (normal-column (current-column)))
4254 ;; If the following character is currently invisible,
4255 ;; skip all characters with that same `invisible' property value.
4256 (while (and (not (eobp))
c65e6942 4257 (invisible-p (point)))
af894fc9
RS
4258 (goto-char (next-char-property-change (point))))
4259 ;; Have we advanced to a larger column position?
4260 (if (> (current-column) normal-column)
4261 ;; We have made some progress towards the desired column.
4262 ;; See if we can make any further progress.
4263 (line-move-to-column (+ (current-column) (- col normal-column)))
4264 ;; Otherwise, go to the place we originally found
4265 ;; and move back over invisible text.
4266 ;; that will get us to the same place on the screen
4267 ;; but with a more reasonable buffer position.
4268 (goto-char normal-location)
4269 (let ((line-beg (save-excursion (beginning-of-line) (point))))
c65e6942 4270 (while (and (not (bolp)) (invisible-p (1- (point))))
af894fc9
RS
4271 (goto-char (previous-char-property-change (point) line-beg))))))))
4272
bbf41690 4273(defun move-end-of-line (arg)
f00239cf
RS
4274 "Move point to end of current line as displayed.
4275\(If there's an image in the line, this disregards newlines
4276which are part of the text that the image rests on.)
4277
bbf41690
RS
4278With argument ARG not nil or 1, move forward ARG - 1 lines first.
4279If point reaches the beginning or end of buffer, it stops there.
f00239cf 4280To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
109cfe4e 4281 (interactive "^p")
bbf41690
RS
4282 (or arg (setq arg 1))
4283 (let (done)
4284 (while (not done)
4285 (let ((newpos
4286 (save-excursion
4efebb82
CY
4287 (let ((goal-column 0)
4288 (line-move-visual nil))
bbf41690
RS
4289 (and (line-move arg t)
4290 (not (bobp))
4291 (progn
c65e6942 4292 (while (and (not (bobp)) (invisible-p (1- (point))))
3137dda8
SM
4293 (goto-char (previous-single-char-property-change
4294 (point) 'invisible)))
bbf41690
RS
4295 (backward-char 1)))
4296 (point)))))
4297 (goto-char newpos)
4298 (if (and (> (point) newpos)
4299 (eq (preceding-char) ?\n))
4300 (backward-char 1)
4301 (if (and (> (point) newpos) (not (eobp))
4302 (not (eq (following-char) ?\n)))
4efebb82
CY
4303 ;; If we skipped something intangible and now we're not
4304 ;; really at eol, keep going.
bbf41690
RS
4305 (setq arg 1)
4306 (setq done t)))))))
4307
0cbb497c 4308(defun move-beginning-of-line (arg)
f00239cf
RS
4309 "Move point to beginning of current line as displayed.
4310\(If there's an image in the line, this disregards newlines
4311which are part of the text that the image rests on.)
4312
0cbb497c
KS
4313With argument ARG not nil or 1, move forward ARG - 1 lines first.
4314If point reaches the beginning or end of buffer, it stops there.
f00239cf 4315To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
109cfe4e 4316 (interactive "^p")
0cbb497c 4317 (or arg (setq arg 1))
398c9ffb 4318
ad47c4a0 4319 (let ((orig (point))
3137dda8 4320 first-vis first-vis-field-value)
1fffd65f
RS
4321
4322 ;; Move by lines, if ARG is not 1 (the default).
4323 (if (/= arg 1)
4efebb82
CY
4324 (let ((line-move-visual nil))
4325 (line-move (1- arg) t)))
1fffd65f
RS
4326
4327 ;; Move to beginning-of-line, ignoring fields and invisibles.
4328 (skip-chars-backward "^\n")
c65e6942 4329 (while (and (not (bobp)) (invisible-p (1- (point))))
621a4cc8 4330 (goto-char (previous-char-property-change (point)))
1fffd65f 4331 (skip-chars-backward "^\n"))
ad47c4a0
RS
4332
4333 ;; Now find first visible char in the line
c65e6942 4334 (while (and (not (eobp)) (invisible-p (point)))
ad47c4a0
RS
4335 (goto-char (next-char-property-change (point))))
4336 (setq first-vis (point))
4337
4338 ;; See if fields would stop us from reaching FIRST-VIS.
4339 (setq first-vis-field-value
4340 (constrain-to-field first-vis orig (/= arg 1) t nil))
4341
4342 (goto-char (if (/= first-vis-field-value first-vis)
4343 ;; If yes, obey them.
4344 first-vis-field-value
4345 ;; Otherwise, move to START with attention to fields.
4346 ;; (It is possible that fields never matter in this case.)
4347 (constrain-to-field (point) orig
4348 (/= arg 1) t nil)))))
0cbb497c
KS
4349
4350
d5ab2033
JB
4351;;; Many people have said they rarely use this feature, and often type
4352;;; it by accident. Maybe it shouldn't even be on a key.
4353(put 'set-goal-column 'disabled t)
2076c87c
JB
4354
4355(defun set-goal-column (arg)
4356 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
4357Those commands will move to this position in the line moved to
4358rather than trying to keep the same horizontal position.
4359With a non-nil argument, clears out the goal column
912c6728
RS
4360so that \\[next-line] and \\[previous-line] resume vertical motion.
4361The goal column is stored in the variable `goal-column'."
2076c87c
JB
4362 (interactive "P")
4363 (if arg
4364 (progn
4365 (setq goal-column nil)
4366 (message "No goal column"))
4367 (setq goal-column (current-column))
8a26c165
DG
4368 ;; The older method below can be erroneous if `set-goal-column' is bound
4369 ;; to a sequence containing %
4370 ;;(message (substitute-command-keys
4371 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
4372 ;;goal-column)
4373 (message "%s"
63219d53 4374 (concat
8a26c165
DG
4375 (format "Goal column %d " goal-column)
4376 (substitute-command-keys
4377 "(use \\[set-goal-column] with an arg to unset it)")))
63219d53 4378
8a26c165 4379 )
2076c87c 4380 nil)
2d88b556 4381\f
a2cf21a2
CY
4382;;; Editing based on visual lines, as opposed to logical lines.
4383
4384(defun end-of-visual-line (&optional n)
4385 "Move point to end of current visual line.
4386With argument N not nil or 1, move forward N - 1 visual lines first.
4387If point reaches the beginning or end of buffer, it stops there.
4388To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4389 (interactive "^p")
4390 (or n (setq n 1))
4391 (if (/= n 1)
4392 (let ((line-move-visual t))
4393 (line-move (1- n) t)))
4394 (vertical-motion (cons (window-width) 0)))
4395
4396(defun beginning-of-visual-line (&optional n)
4397 "Move point to beginning of current visual line.
4398With argument N not nil or 1, move forward N - 1 visual lines first.
4399If point reaches the beginning or end of buffer, it stops there.
4400To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4401 (interactive "^p")
4402 (or n (setq n 1))
4403 (if (/= n 1)
4404 (let ((line-move-visual t))
4405 (line-move (1- n) t)))
4406 (vertical-motion 0))
4407
4408(defun kill-visual-line (&optional arg)
4409 "Kill the rest of the visual line.
4410If there are only whitespace characters there, kill through the
4411newline as well.
4412
4413With prefix argument, kill that many lines from point.
4414Negative arguments kill lines backward.
4415With zero argument, kill the text before point on the current line.
4416
4417When calling from a program, nil means \"no arg\",
4418a number counts as a prefix arg.
7492f5a6 4419
a2cf21a2
CY
4420If `kill-whole-line' is non-nil, then this command kills the whole line
4421including its terminating newline, when used at the beginning of a line
4422with no argument. As a consequence, you can always kill a whole line
4423by typing \\[beginning-of-line] \\[kill-line].
4424
4425If you want to append the killed line to the last killed text,
4426use \\[append-next-kill] before \\[kill-line].
4427
4428If the buffer is read-only, Emacs will beep and refrain from deleting
4429the line, but put the line in the kill ring anyway. This means that
4430you can use this command to copy text from a read-only buffer.
4431\(If the variable `kill-read-only-ok' is non-nil, then this won't
4432even beep.)"
4433 (interactive "P")
4434 (let ((opoint (point))
4435 (line-move-visual t)
4436 end)
4437 ;; It is better to move point to the other end of the kill before
4438 ;; killing. That way, in a read-only buffer, point moves across
4439 ;; the text that is copied to the kill ring. The choice has no
4440 ;; effect on undo now that undo records the value of point from
4441 ;; before the command was run.
4442 (if arg
4443 (vertical-motion (prefix-numeric-value arg))
4444 (if (eobp)
4445 (signal 'end-of-buffer nil))
4446 (setq end (save-excursion
4447 (end-of-visual-line) (point)))
4448 (if (or (save-excursion
4449 ;; If trailing whitespace is visible,
4450 ;; don't treat it as nothing.
4451 (unless show-trailing-whitespace
4452 (skip-chars-forward " \t" end))
4453 (= (point) end))
4454 (and kill-whole-line (bolp)))
4455 (line-move 1)
4456 (goto-char end)))
4457 (kill-region opoint (point))))
4458
4459(defun next-logical-line (&optional arg try-vscroll)
4460 "Move cursor vertically down ARG lines.
4461This is identical to `previous-line', except that it always moves
4462by logical lines instead of visual lines, ignoring the value of
4463the variable `line-move-visual'."
4464 (interactive "^p\np")
4465 (let ((line-move-visual nil))
4466 (with-no-warnings
4467 (next-line arg try-vscroll))))
4468
4469(defun previous-logical-line (&optional arg try-vscroll)
4470 "Move cursor vertically up ARG lines.
4471This is identical to `previous-line', except that it always moves
4472by logical lines instead of visual lines, ignoring the value of
4473the variable `line-move-visual'."
4474 (interactive "^p\np")
4475 (let ((line-move-visual nil))
4476 (with-no-warnings
4477 (previous-line arg try-vscroll))))
4478
4dec5cff
CY
4479(defgroup visual-line nil
4480 "Editing based on visual lines."
4481 :group 'convenience
4482 :version "23.1")
4483
a2cf21a2
CY
4484(defvar visual-line-mode-map
4485 (let ((map (make-sparse-keymap)))
4486 (define-key map [remap kill-line] 'kill-visual-line)
4487 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4488 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4489 (define-key map "\M-[" 'previous-logical-line)
4490 (define-key map "\M-]" 'next-logical-line)
4491 map))
4492
4dec5cff
CY
4493(defcustom visual-line-fringe-indicators '(nil nil)
4494 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4495The value should be a list of the form (LEFT RIGHT), where LEFT
4496and RIGHT are symbols representing the bitmaps to display, to
4497indicate wrapped lines, in the left and right fringes respectively.
4498See also `fringe-indicator-alist'.
4499The default is not to display fringe indicators for wrapped lines.
4500This variable does not affect fringe indicators displayed for
4501other purposes."
4502 :type '(list (choice (const :tag "Hide left indicator" nil)
4503 (const :tag "Left curly arrow" left-curly-arrow)
4504 (symbol :tag "Other bitmap"))
4505 (choice (const :tag "Hide right indicator" nil)
4506 (const :tag "Right curly arrow" right-curly-arrow)
4507 (symbol :tag "Other bitmap")))
4508 :set (lambda (symbol value)
4509 (dolist (buf (buffer-list))
4510 (with-current-buffer buf
4511 (when (and (boundp 'visual-line-mode)
4512 (symbol-value 'visual-line-mode))
4513 (setq fringe-indicator-alist
4514 (cons (cons 'continuation value)
4515 (assq-delete-all
4516 'continuation
4517 (copy-tree fringe-indicator-alist)))))))
4518 (set-default symbol value)))
4519
748e001a
CY
4520(defvar visual-line--saved-state nil)
4521
a2cf21a2 4522(define-minor-mode visual-line-mode
b677cb96
CY
4523 "Redefine simple editing commands to act on visual lines, not logical lines.
4524This also turns on `word-wrap' in the buffer."
a2cf21a2 4525 :keymap visual-line-mode-map
4dec5cff 4526 :group 'visual-line
b677cb96 4527 :lighter " wrap"
a2cf21a2
CY
4528 (if visual-line-mode
4529 (progn
748e001a
CY
4530 (set (make-local-variable 'visual-line--saved-state) nil)
4531 ;; Save the local values of some variables, to be restored if
4532 ;; visual-line-mode is turned off.
4533 (dolist (var '(line-move-visual truncate-lines
4534 truncate-partial-width-windows
4535 word-wrap fringe-indicator-alist))
4536 (if (local-variable-p var)
37820ea9 4537 (push (cons var (symbol-value var))
748e001a 4538 visual-line--saved-state)))
a2cf21a2 4539 (set (make-local-variable 'line-move-visual) t)
c58140f4
CY
4540 (set (make-local-variable 'truncate-partial-width-windows) nil)
4541 (setq truncate-lines nil
4542 word-wrap t
4543 fringe-indicator-alist
4dec5cff
CY
4544 (cons (cons 'continuation visual-line-fringe-indicators)
4545 fringe-indicator-alist)))
a2cf21a2 4546 (kill-local-variable 'line-move-visual)
4dec5cff 4547 (kill-local-variable 'word-wrap)
c58140f4
CY
4548 (kill-local-variable 'truncate-lines)
4549 (kill-local-variable 'truncate-partial-width-windows)
748e001a
CY
4550 (kill-local-variable 'fringe-indicator-alist)
4551 (dolist (saved visual-line--saved-state)
4552 (set (make-local-variable (car saved)) (cdr saved)))
4553 (kill-local-variable 'visual-line--saved-state)))
a2cf21a2
CY
4554
4555(defun turn-on-visual-line-mode ()
4556 (visual-line-mode 1))
4557
4558(define-globalized-minor-mode global-visual-line-mode
4559 visual-line-mode turn-on-visual-line-mode
4560 :lighter " vl")
4561\f
7492f5a6 4562(defun scroll-other-window-down (lines)
e47d38f6
RS
4563 "Scroll the \"other window\" down.
4564For more details, see the documentation for `scroll-other-window'."
7492f5a6
RS
4565 (interactive "P")
4566 (scroll-other-window
4567 ;; Just invert the argument's meaning.
4568 ;; We can do that without knowing which window it will be.
4569 (if (eq lines '-) nil
4570 (if (null lines) '-
4571 (- (prefix-numeric-value lines))))))
3aef9604
RS
4572
4573(defun beginning-of-buffer-other-window (arg)
4574 "Move point to the beginning of the buffer in the other window.
4575Leave mark at previous position.
4576With arg N, put point N/10 of the way from the true beginning."
4577 (interactive "P")
4578 (let ((orig-window (selected-window))
4579 (window (other-window-for-scrolling)))
4580 ;; We use unwind-protect rather than save-window-excursion
4581 ;; because the latter would preserve the things we want to change.
4582 (unwind-protect
4583 (progn
4584 (select-window window)
4585 ;; Set point and mark in that window's buffer.
bbf41690
RS
4586 (with-no-warnings
4587 (beginning-of-buffer arg))
3aef9604
RS
4588 ;; Set point accordingly.
4589 (recenter '(t)))
4590 (select-window orig-window))))
4591
4592(defun end-of-buffer-other-window (arg)
4593 "Move point to the end of the buffer in the other window.
4594Leave mark at previous position.
4595With arg N, put point N/10 of the way from the true end."
4596 (interactive "P")
4597 ;; See beginning-of-buffer-other-window for comments.
4598 (let ((orig-window (selected-window))
4599 (window (other-window-for-scrolling)))
4600 (unwind-protect
4601 (progn
4602 (select-window window)
bbf41690
RS
4603 (with-no-warnings
4604 (end-of-buffer arg))
3aef9604
RS
4605 (recenter '(t)))
4606 (select-window orig-window))))
2d88b556 4607\f
2076c87c
JB
4608(defun transpose-chars (arg)
4609 "Interchange characters around point, moving forward one character.
4610With prefix arg ARG, effect is to take character before point
4611and drag it forward past ARG other characters (backward if ARG negative).
4612If no argument and at end of line, the previous two chars are exchanged."
4613 (interactive "*P")
4614 (and (null arg) (eolp) (forward-char -1))
4615 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4616
4617(defun transpose-words (arg)
4618 "Interchange words around point, leaving point at end of them.
4619With prefix arg ARG, effect is to take word before or around point
4620and drag it forward past ARG other words (backward if ARG negative).
4621If ARG is zero, the words around or after point and around or after mark
4622are interchanged."
41d22ee0 4623 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
2076c87c
JB
4624 (interactive "*p")
4625 (transpose-subr 'forward-word arg))
4626
4627(defun transpose-sexps (arg)
4628 "Like \\[transpose-words] but applies to sexps.
4629Does not work on a sexp that point is in the middle of
4630if it is a list or string."
4631 (interactive "*p")
41d22ee0
SM
4632 (transpose-subr
4633 (lambda (arg)
4634 ;; Here we should try to simulate the behavior of
4635 ;; (cons (progn (forward-sexp x) (point))
4636 ;; (progn (forward-sexp (- x)) (point)))
4637 ;; Except that we don't want to rely on the second forward-sexp
4638 ;; putting us back to where we want to be, since forward-sexp-function
4639 ;; might do funny things like infix-precedence.
4640 (if (if (> arg 0)
4641 (looking-at "\\sw\\|\\s_")
4642 (and (not (bobp))
4643 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
4644 ;; Jumping over a symbol. We might be inside it, mind you.
4645 (progn (funcall (if (> arg 0)
4646 'skip-syntax-backward 'skip-syntax-forward)
4647 "w_")
4648 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4649 ;; Otherwise, we're between sexps. Take a step back before jumping
4650 ;; to make sure we'll obey the same precedence no matter which direction
4651 ;; we're going.
4652 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4653 (cons (save-excursion (forward-sexp arg) (point))
4654 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4655 (not (zerop (funcall (if (> arg 0)
4656 'skip-syntax-forward
4657 'skip-syntax-backward)
4658 ".")))))
4659 (point)))))
4660 arg 'special))
2076c87c
JB
4661
4662(defun transpose-lines (arg)
4663 "Exchange current line and previous line, leaving point after both.
4664With argument ARG, takes previous line and moves it past ARG lines.
4665With argument 0, interchanges line point is in with line mark is in."
4666 (interactive "*p")
4667 (transpose-subr (function
4668 (lambda (arg)
d3f4ef3f 4669 (if (> arg 0)
2076c87c 4670 (progn
d3f4ef3f
AS
4671 ;; Move forward over ARG lines,
4672 ;; but create newlines if necessary.
4673 (setq arg (forward-line arg))
4674 (if (/= (preceding-char) ?\n)
4675 (setq arg (1+ arg)))
4676 (if (> arg 0)
4677 (newline arg)))
2076c87c
JB
4678 (forward-line arg))))
4679 arg))
4680
e1e04350
SM
4681(defun transpose-subr (mover arg &optional special)
4682 (let ((aux (if special mover
4683 (lambda (x)
4684 (cons (progn (funcall mover x) (point))
4685 (progn (funcall mover (- x)) (point))))))
4686 pos1 pos2)
4687 (cond
4688 ((= arg 0)
4689 (save-excursion
4690 (setq pos1 (funcall aux 1))
4691 (goto-char (mark))
4692 (setq pos2 (funcall aux 1))
4693 (transpose-subr-1 pos1 pos2))
4694 (exchange-point-and-mark))
4695 ((> arg 0)
4696 (setq pos1 (funcall aux -1))
4697 (setq pos2 (funcall aux arg))
4698 (transpose-subr-1 pos1 pos2)
4699 (goto-char (car pos2)))
4700 (t
4701 (setq pos1 (funcall aux -1))
4702 (goto-char (car pos1))
4703 (setq pos2 (funcall aux arg))
4704 (transpose-subr-1 pos1 pos2)))))
4705
4706(defun transpose-subr-1 (pos1 pos2)
4707 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4708 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4709 (when (> (car pos1) (car pos2))
4710 (let ((swap pos1))
4711 (setq pos1 pos2 pos2 swap)))
4712 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
dc7d7552
RS
4713 (atomic-change-group
4714 (let (word2)
1e96c007
SM
4715 ;; FIXME: We first delete the two pieces of text, so markers that
4716 ;; used to point to after the text end up pointing to before it :-(
dc7d7552
RS
4717 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
4718 (goto-char (car pos2))
4719 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
4720 (goto-char (car pos1))
4721 (insert word2))))
2d88b556 4722\f
6b61353c 4723(defun backward-word (&optional arg)
b7e91b0c 4724 "Move backward until encountering the beginning of a word.
20ecc110 4725With argument, do this that many times."
109cfe4e 4726 (interactive "^p")
6b61353c 4727 (forward-word (- (or arg 1))))
2076c87c 4728
a1a801de 4729(defun mark-word (&optional arg allow-extend)
705a5933
JL
4730 "Set mark ARG words away from point.
4731The place mark goes is the same place \\[forward-word] would
4732move to with the same argument.
a1a801de 4733Interactively, if this command is repeated
771069f8 4734or (in Transient Mark mode) if the mark is active,
705a5933 4735it marks the next ARG words after the ones already marked."
a1a801de
RS
4736 (interactive "P\np")
4737 (cond ((and allow-extend
4738 (or (and (eq last-command this-command) (mark t))
d34c311a 4739 (region-active-p)))
705a5933
JL
4740 (setq arg (if arg (prefix-numeric-value arg)
4741 (if (< (mark) (point)) -1 1)))
cad113ae
KG
4742 (set-mark
4743 (save-excursion
4744 (goto-char (mark))
4745 (forward-word arg)
4746 (point))))
4747 (t
4748 (push-mark
4749 (save-excursion
705a5933 4750 (forward-word (prefix-numeric-value arg))
cad113ae
KG
4751 (point))
4752 nil t))))
2076c87c
JB
4753
4754(defun kill-word (arg)
4755 "Kill characters forward until encountering the end of a word.
4756With argument, do this that many times."
e761e42c 4757 (interactive "p")
89ee2bf6 4758 (kill-region (point) (progn (forward-word arg) (point))))
2076c87c
JB
4759
4760(defun backward-kill-word (arg)
654ec269 4761 "Kill characters backward until encountering the beginning of a word.
2076c87c 4762With argument, do this that many times."
e761e42c 4763 (interactive "p")
2076c87c 4764 (kill-word (- arg)))
d7c64071 4765
0f7df535
RS
4766(defun current-word (&optional strict really-word)
4767 "Return the symbol or word that point is on (or a nearby one) as a string.
4768The return value includes no text properties.
1e8c5ac4 4769If optional arg STRICT is non-nil, return nil unless point is within
0fa19a57
RS
4770or adjacent to a symbol or word. In all cases the value can be nil
4771if there is no word nearby.
0f7df535
RS
4772The function, belying its name, normally finds a symbol.
4773If optional arg REALLY-WORD is non-nil, it finds just a word."
d7c64071 4774 (save-excursion
0f7df535 4775 (let* ((oldpoint (point)) (start (point)) (end (point))
81d17173 4776 (syntaxes (if really-word "w" "w_"))
0f7df535
RS
4777 (not-syntaxes (concat "^" syntaxes)))
4778 (skip-syntax-backward syntaxes) (setq start (point))
d7c64071 4779 (goto-char oldpoint)
0f7df535
RS
4780 (skip-syntax-forward syntaxes) (setq end (point))
4781 (when (and (eq start oldpoint) (eq end oldpoint)
4782 ;; Point is neither within nor adjacent to a word.
4783 (not strict))
4784 ;; Look for preceding word in same line.
4785 (skip-syntax-backward not-syntaxes
4786 (save-excursion (beginning-of-line)
4787 (point)))
4788 (if (bolp)
4789 ;; No preceding word in same line.
4790 ;; Look for following word in same line.
4791 (progn
4792 (skip-syntax-forward not-syntaxes
4793 (save-excursion (end-of-line)
4794 (point)))
4795 (setq start (point))
4796 (skip-syntax-forward syntaxes)
4797 (setq end (point)))
4798 (setq end (point))
4799 (skip-syntax-backward syntaxes)
4800 (setq start (point))))
4801 ;; If we found something nonempty, return it as a string.
4802 (unless (= start end)
020db25f 4803 (buffer-substring-no-properties start end)))))
2d88b556 4804\f
69c1dd37 4805(defcustom fill-prefix nil
e1e04350 4806 "*String for filling to insert at front of new line, or nil for none."
69c1dd37
RS
4807 :type '(choice (const :tag "None" nil)
4808 string)
4809 :group 'fill)
2076c87c 4810(make-variable-buffer-local 'fill-prefix)
f31b1257 4811(put 'fill-prefix 'safe-local-variable 'string-or-null-p)
2076c87c 4812
69c1dd37
RS
4813(defcustom auto-fill-inhibit-regexp nil
4814 "*Regexp to match lines which should not be auto-filled."
4815 :type '(choice (const :tag "None" nil)
4816 regexp)
4817 :group 'fill)
2076c87c 4818
dbe524b6 4819;; This function is used as the auto-fill-function of a buffer
e2504204
KH
4820;; when Auto-Fill mode is enabled.
4821;; It returns t if it really did any work.
dbe524b6
RS
4822;; (Actually some major modes use a different auto-fill function,
4823;; but this one is the default one.)
2076c87c 4824(defun do-auto-fill ()
621a3f62 4825 (let (fc justify give-up
a0170800 4826 (fill-prefix fill-prefix))
c18465c4 4827 (if (or (not (setq justify (current-justification)))
8f066a20
RS
4828 (null (setq fc (current-fill-column)))
4829 (and (eq justify 'left)
4830 (<= (current-column) fc))
621a3f62
SM
4831 (and auto-fill-inhibit-regexp
4832 (save-excursion (beginning-of-line)
eed5698b
RS
4833 (looking-at auto-fill-inhibit-regexp))))
4834 nil ;; Auto-filling not required
3db1e3b5
BG
4835 (if (memq justify '(full center right))
4836 (save-excursion (unjustify-current-line)))
a0170800
RS
4837
4838 ;; Choose a fill-prefix automatically.
e1e04350
SM
4839 (when (and adaptive-fill-mode
4840 (or (null fill-prefix) (string= fill-prefix "")))
4841 (let ((prefix
4842 (fill-context-prefix
4843 (save-excursion (backward-paragraph 1) (point))
4844 (save-excursion (forward-paragraph 1) (point)))))
4845 (and prefix (not (equal prefix ""))
4846 ;; Use auto-indentation rather than a guessed empty prefix.
0e53a373 4847 (not (and fill-indent-according-to-mode
d99f8496 4848 (string-match "\\`[ \t]*\\'" prefix)))
e1e04350 4849 (setq fill-prefix prefix))))
f1180544 4850
eed5698b 4851 (while (and (not give-up) (> (current-column) fc))
e47d38f6 4852 ;; Determine where to split the line.
db893d00
RS
4853 (let* (after-prefix
4854 (fill-point
621a3f62
SM
4855 (save-excursion
4856 (beginning-of-line)
4857 (setq after-prefix (point))
4858 (and fill-prefix
4859 (looking-at (regexp-quote fill-prefix))
4860 (setq after-prefix (match-end 0)))
4861 (move-to-column (1+ fc))
4862 (fill-move-to-break-point after-prefix)
4863 (point))))
db893d00
RS
4864
4865 ;; See whether the place we found is any good.
e47d38f6
RS
4866 (if (save-excursion
4867 (goto-char fill-point)
41d22ee0
SM
4868 (or (bolp)
4869 ;; There is no use breaking at end of line.
4870 (save-excursion (skip-chars-forward " ") (eolp))
4871 ;; It is futile to split at the end of the prefix
4872 ;; since we would just insert the prefix again.
4873 (and after-prefix (<= (point) after-prefix))
4874 ;; Don't split right after a comment starter
4875 ;; since we would just make another comment starter.
4876 (and comment-start-skip
4877 (let ((limit (point)))
4878 (beginning-of-line)
4879 (and (re-search-forward comment-start-skip
4880 limit t)
4881 (eq (point) limit))))))
4882 ;; No good place to break => stop trying.
4883 (setq give-up t)
4884 ;; Ok, we have a useful place to break the line. Do it.
4885 (let ((prev-column (current-column)))
4886 ;; If point is at the fill-point, do not `save-excursion'.
4887 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4888 ;; point will end up before it rather than after it.
4889 (if (save-excursion
4890 (skip-chars-backward " \t")
4891 (= (point) fill-point))
0b727f9d 4892 (default-indent-new-line t)
41d22ee0
SM
4893 (save-excursion
4894 (goto-char fill-point)
0b727f9d 4895 (default-indent-new-line t)))
41d22ee0
SM
4896 ;; Now do justification, if required
4897 (if (not (eq justify 'left))
e47d38f6 4898 (save-excursion
e1e04350
SM
4899 (end-of-line 0)
4900 (justify-current-line justify nil t)))
41d22ee0
SM
4901 ;; If making the new line didn't reduce the hpos of
4902 ;; the end of the line, then give up now;
4903 ;; trying again will not help.
4904 (if (>= (current-column) prev-column)
4905 (setq give-up t))))))
24ebf92e 4906 ;; Justify last line.
e2504204 4907 (justify-current-line justify t t)
1e722f9f 4908 t)))
2076c87c 4909
0b727f9d
RS
4910(defvar comment-line-break-function 'comment-indent-new-line
4911 "*Mode-specific function which line breaks and continues a comment.
4912This function is called during auto-filling when a comment syntax
4913is defined.
4914The function should take a single optional argument, which is a flag
4915indicating whether it should use soft newlines.")
4916
4917(defun default-indent-new-line (&optional soft)
4918 "Break line at point and indent.
4919If a comment syntax is defined, call `comment-indent-new-line'.
4920
4921The inserted newline is marked hard if variable `use-hard-newlines' is true,
4922unless optional argument SOFT is non-nil."
4923 (interactive)
4924 (if comment-start
4925 (funcall comment-line-break-function soft)
4926 ;; Insert the newline before removing empty space so that markers
4927 ;; get preserved better.
4928 (if soft (insert-and-inherit ?\n) (newline 1))
4929 (save-excursion (forward-char -1) (delete-horizontal-space))
4930 (delete-horizontal-space)
4931
4932 (if (and fill-prefix (not adaptive-fill-mode))
4933 ;; Blindly trust a non-adaptive fill-prefix.
4934 (progn
4935 (indent-to-left-margin)
4936 (insert-before-markers-and-inherit fill-prefix))
4937
4938 (cond
4939 ;; If there's an adaptive prefix, use it unless we're inside
4940 ;; a comment and the prefix is not a comment starter.
4941 (fill-prefix
4942 (indent-to-left-margin)
4943 (insert-and-inherit fill-prefix))
4944 ;; If we're not inside a comment, just try to indent.
4945 (t (indent-according-to-mode))))))
4946
24ebf92e
RS
4947(defvar normal-auto-fill-function 'do-auto-fill
4948 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4949Some major modes set this.")
4950
c75505b4 4951(put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
d99f8496
SM
4952;; FIXME: turn into a proper minor mode.
4953;; Add a global minor mode version of it.
d7465b15 4954(defun auto-fill-mode (&optional arg)
24ebf92e
RS
4955 "Toggle Auto Fill mode.
4956With arg, turn Auto Fill mode on if and only if arg is positive.
4957In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4958automatically breaks the line at a previous space.
4959
4960The value of `normal-auto-fill-function' specifies the function to use
4961for `auto-fill-function' when turning Auto Fill mode on."
d7465b15
RS
4962 (interactive "P")
4963 (prog1 (setq auto-fill-function
4964 (if (if (null arg)
4965 (not auto-fill-function)
4966 (> (prefix-numeric-value arg) 0))
24ebf92e 4967 normal-auto-fill-function
d7465b15 4968 nil))
7911ecc8 4969 (force-mode-line-update)))
d7465b15
RS
4970
4971;; This holds a document string used to document auto-fill-mode.
4972(defun auto-fill-function ()
4973 "Automatically break line at a previous space, in insertion of text."
4974 nil)
4975
4976(defun turn-on-auto-fill ()
4977 "Unconditionally turn on Auto Fill mode."
4978 (auto-fill-mode 1))
3a99c819
GM
4979
4980(defun turn-off-auto-fill ()
4981 "Unconditionally turn off Auto Fill mode."
4982 (auto-fill-mode -1))
4983
7cbf1dc1 4984(custom-add-option 'text-mode-hook 'turn-on-auto-fill)
d7465b15
RS
4985
4986(defun set-fill-column (arg)
4cc0ea11 4987 "Set `fill-column' to specified argument.
923efb99 4988Use \\[universal-argument] followed by a number to specify a column.
4cc0ea11 4989Just \\[universal-argument] as argument means to use the current column."
7c373357
SM
4990 (interactive
4991 (list (or current-prefix-arg
4992 ;; We used to use current-column silently, but C-x f is too easily
4993 ;; typed as a typo for C-x C-f, so we turned it into an error and
4994 ;; now an interactive prompt.
4995 (read-number "Set fill-column to: " (current-column)))))
f4520363
RS
4996 (if (consp arg)
4997 (setq arg (current-column)))
4998 (if (not (integerp arg))
4999 ;; Disallow missing argument; it's probably a typo for C-x C-f.
f33321ad 5000 (error "set-fill-column requires an explicit argument")
f4520363
RS
5001 (message "Fill column set to %d (was %d)" arg fill-column)
5002 (setq fill-column arg)))
2d88b556 5003\f
2076c87c 5004(defun set-selective-display (arg)
ff1fbe3e
RS
5005 "Set `selective-display' to ARG; clear it if no arg.
5006When the value of `selective-display' is a number > 0,
5007lines whose indentation is >= that value are not displayed.
5008The variable `selective-display' has a separate value for each buffer."
2076c87c
JB
5009 (interactive "P")
5010 (if (eq selective-display t)
5011 (error "selective-display already in use for marked lines"))
c88ab9ce
ER
5012 (let ((current-vpos
5013 (save-restriction
5014 (narrow-to-region (point-min) (point))
5015 (goto-char (window-start))
5016 (vertical-motion (window-height)))))
5017 (setq selective-display
5018 (and arg (prefix-numeric-value arg)))
5019 (recenter current-vpos))
2076c87c
JB
5020 (set-window-start (selected-window) (window-start (selected-window)))
5021 (princ "selective-display set to " t)
5022 (prin1 selective-display t)
5023 (princ "." t))
5024
40a64816 5025(defvaralias 'indicate-unused-lines 'indicate-empty-lines)
40a64816 5026
b3228584 5027(defun toggle-truncate-lines (&optional arg)
215f50ce 5028 "Toggle whether to fold or truncate long lines for the current buffer.
4837b516
GM
5029With prefix argument ARG, truncate long lines if ARG is positive,
5030otherwise don't truncate them. Note that in side-by-side
627bb5dc
GM
5031windows, this command has no effect if `truncate-partial-width-windows'
5032is non-nil."
0bb64d76
PA
5033 (interactive "P")
5034 (setq truncate-lines
5035 (if (null arg)
5036 (not truncate-lines)
46cdfe8f
RS
5037 (> (prefix-numeric-value arg) 0)))
5038 (force-mode-line-update)
4f017185
RS
5039 (unless truncate-lines
5040 (let ((buffer (current-buffer)))
5041 (walk-windows (lambda (window)
5042 (if (eq buffer (window-buffer window))
5043 (set-window-hscroll window 0)))
5044 nil t)))
46cdfe8f
RS
5045 (message "Truncate long lines %s"
5046 (if truncate-lines "enabled" "disabled")))
0bb64d76 5047
4f8f7f9f 5048(defvar overwrite-mode-textual " Ovwrt"
b6a22db0 5049 "The string displayed in the mode line when in overwrite mode.")
4f8f7f9f 5050(defvar overwrite-mode-binary " Bin Ovwrt"
b6a22db0
JB
5051 "The string displayed in the mode line when in binary overwrite mode.")
5052
2076c87c
JB
5053(defun overwrite-mode (arg)
5054 "Toggle overwrite mode.
4837b516
GM
5055With prefix argument ARG, turn overwrite mode on if ARG is positive,
5056otherwise turn it off. In overwrite mode, printing characters typed
5057in replace existing text on a one-for-one basis, rather than pushing
5058it to the right. At the end of a line, such characters extend the line.
5059Before a tab, such characters insert until the tab is filled in.
b6a22db0
JB
5060\\[quoted-insert] still inserts characters in overwrite mode; this
5061is supposed to make it easier to insert characters when necessary."
5062 (interactive "P")
5063 (setq overwrite-mode
5064 (if (if (null arg) (not overwrite-mode)
5065 (> (prefix-numeric-value arg) 0))
5066 'overwrite-mode-textual))
5067 (force-mode-line-update))
5068
5069(defun binary-overwrite-mode (arg)
5070 "Toggle binary overwrite mode.
4837b516
GM
5071With prefix argument ARG, turn binary overwrite mode on if ARG is
5072positive, otherwise turn it off. In binary overwrite mode, printing
5073characters typed in replace existing text. Newlines are not treated
5074specially, so typing at the end of a line joins the line to the next,
5075with the typed character between them. Typing before a tab character
5076simply replaces the tab with the character typed. \\[quoted-insert]
5077replaces the text at the cursor, just as ordinary typing characters do.
b6a22db0
JB
5078
5079Note that binary overwrite mode is not its own minor mode; it is a
f33321ad 5080specialization of overwrite mode, entered by setting the
b6a22db0 5081`overwrite-mode' variable to `overwrite-mode-binary'."
2076c87c
JB
5082 (interactive "P")
5083 (setq overwrite-mode
b6a22db0 5084 (if (if (null arg)
a61099dd 5085 (not (eq overwrite-mode 'overwrite-mode-binary))
b6a22db0
JB
5086 (> (prefix-numeric-value arg) 0))
5087 'overwrite-mode-binary))
5088 (force-mode-line-update))
eaae8106 5089
6710df48 5090(define-minor-mode line-number-mode
a61099dd 5091 "Toggle Line Number mode.
4837b516
GM
5092With arg, turn Line Number mode on if arg is positive, otherwise
5093turn it off. When Line Number mode is enabled, the line number
5094appears in the mode line.
8dc9e2ef 5095
32f2f98e
EZ
5096Line numbers do not appear for very large buffers and buffers
5097with very long lines; see variables `line-number-display-limit'
5098and `line-number-display-limit-width'."
efeb22bf 5099 :init-value t :global t :group 'mode-line)
bcad4985 5100
6710df48 5101(define-minor-mode column-number-mode
bcad4985 5102 "Toggle Column Number mode.
4837b516
GM
5103With arg, turn Column Number mode on if arg is positive,
5104otherwise turn it off. When Column Number mode is enabled, the
5105column number appears in the mode line."
efeb22bf 5106 :global t :group 'mode-line)
6b61353c
KH
5107
5108(define-minor-mode size-indication-mode
5109 "Toggle Size Indication mode.
4837b516
GM
5110With arg, turn Size Indication mode on if arg is positive,
5111otherwise turn it off. When Size Indication mode is enabled, the
5112size of the accessible part of the buffer appears in the mode line."
efeb22bf 5113 :global t :group 'mode-line)
2d88b556 5114\f
4b384a8f 5115(defgroup paren-blinking nil
020db25f 5116 "Blinking matching of parens and expressions."
4b384a8f
SM
5117 :prefix "blink-matching-"
5118 :group 'paren-matching)
5119
69c1dd37
RS
5120(defcustom blink-matching-paren t
5121 "*Non-nil means show matching open-paren when close-paren is inserted."
5122 :type 'boolean
4b384a8f 5123 :group 'paren-blinking)
2076c87c 5124
69c1dd37 5125(defcustom blink-matching-paren-on-screen t
29fc44dd 5126 "*Non-nil means show matching open-paren when it is on screen.
1c2ba4e7 5127If nil, don't show it (but the open-paren can still be shown
92aa8a33
LT
5128when it is off screen).
5129
9cb370a9 5130This variable has no effect if `blink-matching-paren' is nil.
a9f72e5f 5131\(In that case, the open-paren is never shown.)
9cb370a9 5132It is also ignored if `show-paren-mode' is enabled."
69c1dd37 5133 :type 'boolean
4b384a8f 5134 :group 'paren-blinking)
29fc44dd 5135
4b384a8f 5136(defcustom blink-matching-paren-distance (* 25 1024)
66d44a36
EZ
5137 "*If non-nil, maximum distance to search backwards for matching open-paren.
5138If nil, search stops at the beginning of the accessible portion of the buffer."
5139 :type '(choice (const nil) integer)
4b384a8f 5140 :group 'paren-blinking)
2076c87c 5141
69c1dd37 5142(defcustom blink-matching-delay 1
4b384a8f
SM
5143 "*Time in seconds to delay after showing a matching paren."
5144 :type 'number
5145 :group 'paren-blinking)
72dddf8b 5146
69c1dd37 5147(defcustom blink-matching-paren-dont-ignore-comments nil
1c2ba4e7 5148 "*If nil, `blink-matching-paren' ignores comments.
ab6b3b16
RS
5149More precisely, when looking for the matching parenthesis,
5150it skips the contents of comments that end before point."
69c1dd37 5151 :type 'boolean
4b384a8f 5152 :group 'paren-blinking)
903b7f65 5153
2076c87c
JB
5154(defun blink-matching-open ()
5155 "Move cursor momentarily to the beginning of the sexp before point."
5156 (interactive)
c448d316 5157 (when (and (> (point) (point-min))
1d0e3fc8
RS
5158 blink-matching-paren
5159 ;; Verify an even number of quoting characters precede the close.
5160 (= 1 (logand 1 (- (point)
5161 (save-excursion
5162 (forward-char -1)
5163 (skip-syntax-backward "/\\")
5164 (point))))))
5165 (let* ((oldpos (point))
3137dda8 5166 (message-log-max nil) ; Don't log messages about paren matching.
bf825c62
GM
5167 (atdollar (eq (syntax-class (syntax-after (1- oldpos))) 8))
5168 (isdollar)
3137dda8
SM
5169 (blinkpos
5170 (save-excursion
5171 (save-restriction
5172 (if blink-matching-paren-distance
5173 (narrow-to-region
5174 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5175 (- (point) blink-matching-paren-distance))
5176 oldpos))
5177 (let ((parse-sexp-ignore-comments
5178 (and parse-sexp-ignore-comments
5179 (not blink-matching-paren-dont-ignore-comments))))
5180 (condition-case ()
5181 (scan-sexps oldpos -1)
5182 (error nil))))))
5183 (matching-paren
5184 (and blinkpos
5185 ;; Not syntax '$'.
bf825c62
GM
5186 (not (setq isdollar
5187 (eq (syntax-class (syntax-after blinkpos)) 8)))
3137dda8
SM
5188 (let ((syntax (syntax-after blinkpos)))
5189 (and (consp syntax)
5190 (eq (syntax-class syntax) 4)
5191 (cdr syntax))))))
5192 (cond
bf825c62
GM
5193 ;; isdollar is for:
5194 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00871.html
5195 ((not (or (and isdollar blinkpos)
5196 (and atdollar (not blinkpos)) ; see below
5197 (eq matching-paren (char-before oldpos))
3137dda8
SM
5198 ;; The cdr might hold a new paren-class info rather than
5199 ;; a matching-char info, in which case the two CDRs
5200 ;; should match.
5201 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
5202 (message "Mismatched parentheses"))
5203 ((not blinkpos)
bf825c62
GM
5204 (or blink-matching-paren-distance
5205 ;; Don't complain when `$' with no blinkpos, because it
5206 ;; could just be the first one typed in the buffer.
5207 atdollar
3137dda8
SM
5208 (message "Unmatched parenthesis")))
5209 ((pos-visible-in-window-p blinkpos)
5210 ;; Matching open within window, temporarily move to blinkpos but only
5211 ;; if `blink-matching-paren-on-screen' is non-nil.
5212 (and blink-matching-paren-on-screen
5213 (not show-paren-mode)
5214 (save-excursion
5215 (goto-char blinkpos)
5216 (sit-for blink-matching-delay))))
5217 (t
5218 (save-excursion
5219 (goto-char blinkpos)
5220 (let ((open-paren-line-string
5221 ;; Show what precedes the open in its line, if anything.
5222 (cond
5223 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
5224 (buffer-substring (line-beginning-position)
5225 (1+ blinkpos)))
5226 ;; Show what follows the open in its line, if anything.
5227 ((save-excursion
5228 (forward-char 1)
5229 (skip-chars-forward " \t")
5230 (not (eolp)))
5231 (buffer-substring blinkpos
5232 (line-end-position)))
5233 ;; Otherwise show the previous nonblank line,
5234 ;; if there is one.
5235 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
5236 (concat
5237 (buffer-substring (progn
5238 (skip-chars-backward "\n \t")
5239 (line-beginning-position))
5240 (progn (end-of-line)
5241 (skip-chars-backward " \t")
5242 (point)))
5243 ;; Replace the newline and other whitespace with `...'.
5244 "..."
5245 (buffer-substring blinkpos (1+ blinkpos))))
5246 ;; There is nothing to show except the char itself.
5247 (t (buffer-substring blinkpos (1+ blinkpos))))))
5248 (message "Matches %s"
5249 (substring-no-properties open-paren-line-string)))))))))
5250
5251;; Turned off because it makes dbx bomb out.
2076c87c 5252(setq blink-paren-function 'blink-matching-open)
2d88b556 5253\f
9a1277dd
RS
5254;; This executes C-g typed while Emacs is waiting for a command.
5255;; Quitting out of a program does not go through here;
5256;; that happens in the QUIT macro at the C code level.
2076c87c 5257(defun keyboard-quit ()
d5dae4e1 5258 "Signal a `quit' condition.
af39530e
RS
5259During execution of Lisp code, this character causes a quit directly.
5260At top-level, as an editor command, this simply beeps."
2076c87c 5261 (interactive)
19d35374 5262 (deactivate-mark)
8a7644e9
KS
5263 (if (fboundp 'kmacro-keyboard-quit)
5264 (kmacro-keyboard-quit))
f5e13057 5265 (setq defining-kbd-macro nil)
2076c87c
JB
5266 (signal 'quit nil))
5267
1c6c6fde
RS
5268(defvar buffer-quit-function nil
5269 "Function to call to \"quit\" the current buffer, or nil if none.
5270\\[keyboard-escape-quit] calls this function when its more local actions
5271\(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5272
c66587fe
RS
5273(defun keyboard-escape-quit ()
5274 "Exit the current \"mode\" (in a generalized sense of the word).
5275This command can exit an interactive command such as `query-replace',
5276can clear out a prefix argument or a region,
5277can get out of the minibuffer or other recursive edit,
1c6c6fde
RS
5278cancel the use of the current buffer (for special-purpose buffers),
5279or go back to just one window (by deleting all but the selected window)."
c66587fe
RS
5280 (interactive)
5281 (cond ((eq last-command 'mode-exited) nil)
5282 ((> (minibuffer-depth) 0)
5283 (abort-recursive-edit))
5284 (current-prefix-arg
5285 nil)
d34c311a 5286 ((region-active-p)
c66587fe 5287 (deactivate-mark))
1b657835
RS
5288 ((> (recursion-depth) 0)
5289 (exit-recursive-edit))
1c6c6fde
RS
5290 (buffer-quit-function
5291 (funcall buffer-quit-function))
c66587fe 5292 ((not (one-window-p t))
1b657835
RS
5293 (delete-other-windows))
5294 ((string-match "^ \\*" (buffer-name (current-buffer)))
5295 (bury-buffer))))
c66587fe 5296
2d88b556
RS
5297(defun play-sound-file (file &optional volume device)
5298 "Play sound stored in FILE.
5299VOLUME and DEVICE correspond to the keywords of the sound
5300specification for `play-sound'."
5301 (interactive "fPlay sound file: ")
5302 (let ((sound (list :file file)))
5303 (if volume
5304 (plist-put sound :volume volume))
5305 (if device
5306 (plist-put sound :device device))
5307 (push 'sound sound)
5308 (play-sound sound)))
5309
56abefac 5310\f
7683b5c2
DL
5311(defcustom read-mail-command 'rmail
5312 "*Your preference for a mail reading package.
9023837e
DL
5313This is used by some keybindings which support reading mail.
5314See also `mail-user-agent' concerning sending mail."
7683b5c2
DL
5315 :type '(choice (function-item rmail)
5316 (function-item gnus)
5317 (function-item mh-rmail)
5318 (function :tag "Other"))
5319 :version "21.1"
5320 :group 'mail)
5321
69c1dd37 5322(defcustom mail-user-agent 'sendmail-user-agent
a31ca314 5323 "*Your preference for a mail composition package.
9023837e 5324Various Emacs Lisp packages (e.g. Reporter) require you to compose an
a31ca314
RS
5325outgoing email message. This variable lets you specify which
5326mail-sending package you prefer.
5327
5328Valid values include:
5329
9023837e
DL
5330 `sendmail-user-agent' -- use the default Emacs Mail package.
5331 See Info node `(emacs)Sending Mail'.
5332 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5333 See Info node `(mh-e)'.
5334 `message-user-agent' -- use the Gnus Message package.
5335 See Info node `(message)'.
5336 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5337 paraphernalia, particularly the Gcc: header for
5338 archiving.
a31ca314
RS
5339
5340Additional valid symbols may be available; check with the author of
15d0c9b1
DL
5341your package for details. The function should return non-nil if it
5342succeeds.
9023837e
DL
5343
5344See also `read-mail-command' concerning reading mail."
69c1dd37
RS
5345 :type '(radio (function-item :tag "Default Emacs mail"
5346 :format "%t\n"
5347 sendmail-user-agent)
5348 (function-item :tag "Emacs interface to MH"
5349 :format "%t\n"
5350 mh-e-user-agent)
9023837e 5351 (function-item :tag "Gnus Message package"
69c1dd37
RS
5352 :format "%t\n"
5353 message-user-agent)
9023837e
DL
5354 (function-item :tag "Gnus Message with full Gnus features"
5355 :format "%t\n"
5356 gnus-user-agent)
69c1dd37
RS
5357 (function :tag "Other"))
5358 :group 'mail)
a31ca314 5359
a31ca314 5360(define-mail-user-agent 'sendmail-user-agent
34fbcdf3 5361 'sendmail-user-agent-compose
a31ca314
RS
5362 'mail-send-and-exit)
5363
360b5483
RS
5364(defun rfc822-goto-eoh ()
5365 ;; Go to header delimiter line in a mail message, following RFC822 rules
5366 (goto-char (point-min))
e1e04350
SM
5367 (when (re-search-forward
5368 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
5369 (goto-char (match-beginning 0))))
360b5483 5370
34fbcdf3
RS
5371(defun sendmail-user-agent-compose (&optional to subject other-headers continue
5372 switch-function yank-action
5373 send-actions)
5374 (if switch-function
5375 (let ((special-display-buffer-names nil)
5376 (special-display-regexps nil)
5377 (same-window-buffer-names nil)
5378 (same-window-regexps nil))
5379 (funcall switch-function "*mail*")))
6b61353c
KH
5380 (let ((cc (cdr (assoc-string "cc" other-headers t)))
5381 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
5382 (body (cdr (assoc-string "body" other-headers t))))
34fbcdf3
RS
5383 (or (mail continue to subject in-reply-to cc yank-action send-actions)
5384 continue
5385 (error "Message aborted"))
5386 (save-excursion
360b5483 5387 (rfc822-goto-eoh)
34fbcdf3 5388 (while other-headers
0740c738
GM
5389 (unless (member-ignore-case (car (car other-headers))
5390 '("in-reply-to" "cc" "body"))
34fbcdf3 5391 (insert (car (car other-headers)) ": "
15575807
CY
5392 (cdr (car other-headers))
5393 (if use-hard-newlines hard-newline "\n")))
34fbcdf3 5394 (setq other-headers (cdr other-headers)))
0740c738
GM
5395 (when body
5396 (forward-line 1)
5397 (insert body))
34fbcdf3
RS
5398 t)))
5399
d0008a00
RS
5400(defun compose-mail (&optional to subject other-headers continue
5401 switch-function yank-action send-actions)
5402 "Start composing a mail message to send.
5403This uses the user's chosen mail composition package
5404as selected with the variable `mail-user-agent'.
5405The optional arguments TO and SUBJECT specify recipients
5406and the initial Subject field, respectively.
5407
5408OTHER-HEADERS is an alist specifying additional
5409header fields. Elements look like (HEADER . VALUE) where both
5410HEADER and VALUE are strings.
5411
5412CONTINUE, if non-nil, says to continue editing a message already
5413being composed.
5414
5415SWITCH-FUNCTION, if non-nil, is a function to use to
5416switch to and display the buffer used for mail composition.
5417
5418YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
06720de2
RS
5419to insert the raw text of the message being replied to.
5420It has the form (FUNCTION . ARGS). The user agent will apply
5421FUNCTION to ARGS, to insert the raw text of the original message.
5422\(The user agent will also run `mail-citation-hook', *after* the
5423original text has been inserted in this way.)
d0008a00
RS
5424
5425SEND-ACTIONS is a list of actions to call when the message is sent.
5426Each action has the form (FUNCTION . ARGS)."
b5f019be
RS
5427 (interactive
5428 (list nil nil nil current-prefix-arg))
676b1a74
CY
5429 (let ((function (get mail-user-agent 'composefunc)))
5430 (funcall function to subject other-headers continue
5431 switch-function yank-action send-actions)))
b5f019be
RS
5432
5433(defun compose-mail-other-window (&optional to subject other-headers continue
5434 yank-action send-actions)
5435 "Like \\[compose-mail], but edit the outgoing message in another window."
5436 (interactive
5437 (list nil nil nil current-prefix-arg))
5438 (compose-mail to subject other-headers continue
5439 'switch-to-buffer-other-window yank-action send-actions))
5440
5441
5442(defun compose-mail-other-frame (&optional to subject other-headers continue
5443 yank-action send-actions)
5444 "Like \\[compose-mail], but edit the outgoing message in another frame."
5445 (interactive
5446 (list nil nil nil current-prefix-arg))
5447 (compose-mail to subject other-headers continue
5448 'switch-to-buffer-other-frame yank-action send-actions))
56abefac 5449\f
610c1c68 5450(defvar set-variable-value-history nil
987ec16d
EZ
5451 "History of values entered with `set-variable'.
5452
5453Maximum length of the history list is determined by the value
5454of `history-length', which see.")
610c1c68 5455
d6281b4e 5456(defun set-variable (variable value &optional make-local)
610c1c68 5457 "Set VARIABLE to VALUE. VALUE is a Lisp object.
d6281b4e
RS
5458VARIABLE should be a user option variable name, a Lisp variable
5459meant to be customized by users. You should enter VALUE in Lisp syntax,
5460so if you want VALUE to be a string, you must surround it with doublequotes.
610c1c68
RS
5461VALUE is used literally, not evaluated.
5462
5463If VARIABLE has a `variable-interactive' property, that is used as if
5464it were the arg to `interactive' (which see) to interactively read VALUE.
5465
5466If VARIABLE has been defined with `defcustom', then the type information
16236388
RS
5467in the definition is used to check that VALUE is valid.
5468
5469With a prefix argument, set VARIABLE to VALUE buffer-locally."
e9dfb72e
RS
5470 (interactive
5471 (let* ((default-var (variable-at-point))
7fd0ef0d
JL
5472 (var (if (user-variable-p default-var)
5473 (read-variable (format "Set variable (default %s): " default-var)
5474 default-var)
5475 (read-variable "Set variable: ")))
6b61353c
KH
5476 (minibuffer-help-form '(describe-variable var))
5477 (prop (get var 'variable-interactive))
0684376b
JB
5478 (obsolete (car (get var 'byte-obsolete-variable)))
5479 (prompt (format "Set %s %s to value: " var
6b61353c 5480 (cond ((local-variable-p var)
0684376b 5481 "(buffer-local)")
6b61353c
KH
5482 ((or current-prefix-arg
5483 (local-variable-if-set-p var))
0684376b
JB
5484 "buffer-locally")
5485 (t "globally"))))
5486 (val (progn
5487 (when obsolete
5488 (message (concat "`%S' is obsolete; "
5489 (if (symbolp obsolete) "use `%S' instead" "%s"))
5490 var obsolete)
5491 (sit-for 3))
5492 (if prop
5493 ;; Use VAR's `variable-interactive' property
5494 ;; as an interactive spec for prompting.
5495 (call-interactively `(lambda (arg)
5496 (interactive ,prop)
5497 arg))
5498 (read
5499 (read-string prompt nil
7fd0ef0d
JL
5500 'set-variable-value-history
5501 (format "%S" (symbol-value var))))))))
6b61353c 5502 (list var val current-prefix-arg)))
610c1c68 5503
d6281b4e
RS
5504 (and (custom-variable-p variable)
5505 (not (get variable 'custom-type))
5506 (custom-load-symbol variable))
5507 (let ((type (get variable 'custom-type)))
610c1c68
RS
5508 (when type
5509 ;; Match with custom type.
36755dd9 5510 (require 'cus-edit)
610c1c68 5511 (setq type (widget-convert type))
d6281b4e 5512 (unless (widget-apply type :match value)
1e722f9f 5513 (error "Value `%S' does not match type %S of %S"
d6281b4e 5514 value (car type) variable))))
16236388
RS
5515
5516 (if make-local
d6281b4e 5517 (make-local-variable variable))
f1180544 5518
d6281b4e 5519 (set variable value)
a2aef080
GM
5520
5521 ;; Force a thorough redisplay for the case that the variable
5522 ;; has an effect on the display, like `tab-width' has.
5523 (force-mode-line-update))
56abefac 5524\f
e8a700bf
RS
5525;; Define the major mode for lists of completions.
5526
e2947429
SM
5527(defvar completion-list-mode-map
5528 (let ((map (make-sparse-keymap)))
5529 (define-key map [mouse-2] 'mouse-choose-completion)
5530 (define-key map [follow-link] 'mouse-face)
5531 (define-key map [down-mouse-2] nil)
5532 (define-key map "\C-m" 'choose-completion)
5533 (define-key map "\e\e\e" 'delete-completion-window)
5534 (define-key map [left] 'previous-completion)
5535 (define-key map [right] 'next-completion)
5536 map)
98b45886 5537 "Local map for completion list buffers.")
e8a700bf
RS
5538
5539;; Completion mode is suitable only for specially formatted data.
ac29eb79 5540(put 'completion-list-mode 'mode-class 'special)
e8a700bf 5541
98b45886
RS
5542(defvar completion-reference-buffer nil
5543 "Record the buffer that was current when the completion list was requested.
5544This is a local variable in the completion list buffer.
ec39964e 5545Initial value is nil to avoid some compiler warnings.")
3819736b 5546
83434bda
RS
5547(defvar completion-no-auto-exit nil
5548 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5549This also applies to other functions such as `choose-completion'
5550and `mouse-choose-completion'.")
5551
98b45886 5552(defvar completion-base-size nil
3c59150d
CY
5553 "Number of chars before point not involved in completion.
5554This is a local variable in the completion list buffer.
5555It refers to the chars in the minibuffer if completing in the
5556minibuffer, or in `completion-reference-buffer' otherwise.
5557Only characters in the field at point are included.
5558
5559If nil, Emacs determines which part of the tail end of the
5560buffer's text is involved in completion by comparing the text
5561directly.")
f6b293e3 5562
1c6c6fde
RS
5563(defun delete-completion-window ()
5564 "Delete the completion list window.
5565Go to the window from which completion was requested."
5566 (interactive)
5567 (let ((buf completion-reference-buffer))
ddb2b181
RS
5568 (if (one-window-p t)
5569 (if (window-dedicated-p (selected-window))
5570 (delete-frame (selected-frame)))
5571 (delete-window (selected-window))
5572 (if (get-buffer-window buf)
5573 (select-window (get-buffer-window buf))))))
1c6c6fde 5574
dde69dbe
RS
5575(defun previous-completion (n)
5576 "Move to the previous item in the completion list."
5577 (interactive "p")
5578 (next-completion (- n)))
5579
5580(defun next-completion (n)
5581 "Move to the next item in the completion list.
1f238ac2 5582With prefix argument N, move N items (negative N means move backward)."
dde69dbe 5583 (interactive "p")
58dd38f1
SM
5584 (let ((beg (point-min)) (end (point-max)))
5585 (while (and (> n 0) (not (eobp)))
dde69dbe 5586 ;; If in a completion, move to the end of it.
58dd38f1
SM
5587 (when (get-text-property (point) 'mouse-face)
5588 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
dde69dbe 5589 ;; Move to start of next one.
58dd38f1
SM
5590 (unless (get-text-property (point) 'mouse-face)
5591 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5592 (setq n (1- n)))
5593 (while (and (< n 0) (not (bobp)))
5594 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5595 ;; If in a completion, move to the start of it.
5596 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
b61a81c2 5597 (goto-char (previous-single-property-change
58dd38f1
SM
5598 (point) 'mouse-face nil beg)))
5599 ;; Move to end of the previous completion.
5600 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5601 (goto-char (previous-single-property-change
5602 (point) 'mouse-face nil beg)))
5603 ;; Move to the start of that one.
5604 (goto-char (previous-single-property-change
5605 (point) 'mouse-face nil beg))
5606 (setq n (1+ n))))))
dde69dbe 5607
80298193
RS
5608(defun choose-completion ()
5609 "Choose the completion that point is in or next to."
5610 (interactive)
f6b293e3
RS
5611 (let (beg end completion (buffer completion-reference-buffer)
5612 (base-size completion-base-size))
6096f362
RS
5613 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
5614 (setq end (point) beg (1+ (point))))
5615 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3f299281 5616 (setq end (1- (point)) beg (point)))
6096f362
RS
5617 (if (null beg)
5618 (error "No completion here"))
5619 (setq beg (previous-single-property-change beg 'mouse-face))
88dd3c24 5620 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
6cdd0211 5621 (setq completion (buffer-substring-no-properties beg end))
ab63960f
RS
5622 (let ((owindow (selected-window)))
5623 (if (and (one-window-p t 'selected-frame)
8a7daef5 5624 (window-dedicated-p owindow))
ab63960f
RS
5625 ;; This is a special buffer's frame
5626 (iconify-frame (selected-frame))
5627 (or (window-dedicated-p (selected-window))
5628 (bury-buffer)))
8a7daef5
CY
5629 (select-window
5630 (or (and (buffer-live-p buffer)
5631 (get-buffer-window buffer))
5632 owindow)))
f6b293e3 5633 (choose-completion-string completion buffer base-size)))
80298193
RS
5634
5635;; Delete the longest partial match for STRING
5636;; that can be found before POINT.
5637(defun choose-completion-delete-max-match (string)
5638 (let ((opoint (point))
f0bfada7
RS
5639 len)
5640 ;; Try moving back by the length of the string.
5641 (goto-char (max (- (point) (length string))
5642 (minibuffer-prompt-end)))
5643 ;; See how far back we were actually able to move. That is the
5644 ;; upper bound on how much we can match and delete.
5645 (setq len (- opoint (point)))
61bbf6fe
RS
5646 (if completion-ignore-case
5647 (setq string (downcase string)))
80298193 5648 (while (and (> len 0)
f0bfada7 5649 (let ((tail (buffer-substring (point) opoint)))
61bbf6fe
RS
5650 (if completion-ignore-case
5651 (setq tail (downcase tail)))
80298193
RS
5652 (not (string= tail (substring string 0 len)))))
5653 (setq len (1- len))
5654 (forward-char 1))
5655 (delete-char len)))
5656
ba36181b 5657(defvar choose-completion-string-functions nil
bbbbb15b
KS
5658 "Functions that may override the normal insertion of a completion choice.
5659These functions are called in order with four arguments:
5660CHOICE - the string to insert in the buffer,
5661BUFFER - the buffer in which the choice should be inserted,
4837b516 5662MINI-P - non-nil if BUFFER is a minibuffer, and
12829a07
RS
5663BASE-SIZE - the number of characters in BUFFER before
5664the string being completed.
5665
bbbbb15b
KS
5666If a function in the list returns non-nil, that function is supposed
5667to have inserted the CHOICE in the BUFFER, and possibly exited
12829a07 5668the minibuffer; no further functions will be called.
ba36181b 5669
12829a07
RS
5670If all functions in the list return nil, that means to use
5671the default method of inserting the completion in BUFFER.")
74d0290b 5672
f6b293e3 5673(defun choose-completion-string (choice &optional buffer base-size)
12829a07
RS
5674 "Switch to BUFFER and insert the completion choice CHOICE.
5675BASE-SIZE, if non-nil, says how many characters of BUFFER's text
e36aeef9
RS
5676to keep. If it is nil, we call `choose-completion-delete-max-match'
5677to decide what to delete."
12829a07
RS
5678
5679 ;; If BUFFER is the minibuffer, exit the minibuffer
5680 ;; unless it is reading a file name and CHOICE is a directory,
5681 ;; or completion-no-auto-exit is non-nil.
5682
1a0d0b6a
JPW
5683 (let* ((buffer (or buffer completion-reference-buffer))
5684 (mini-p (minibufferp buffer)))
cf52ad58
RS
5685 ;; If BUFFER is a minibuffer, barf unless it's the currently
5686 ;; active minibuffer.
f436a90a 5687 (if (and mini-p
45486731
RS
5688 (or (not (active-minibuffer-window))
5689 (not (equal buffer
5690 (window-buffer (active-minibuffer-window))))))
cf52ad58 5691 (error "Minibuffer is not active for completion")
17aa3385
KS
5692 ;; Set buffer so buffer-local choose-completion-string-functions works.
5693 (set-buffer buffer)
f1180544 5694 (unless (run-hook-with-args-until-success
d99f8496
SM
5695 'choose-completion-string-functions
5696 choice buffer mini-p base-size)
5697 ;; Insert the completion into the buffer where it was requested.
6138158d
SM
5698 ;; FIXME:
5699 ;; - There may not be a field at point, or there may be a field but
5700 ;; it's not a "completion field", in which case we have to
5701 ;; call choose-completion-delete-max-match even if base-size is set.
5702 ;; - we may need to delete further than (point) to (field-end),
5703 ;; depending on the completion-style, and for that we need to
5704 ;; extra data `completion-extra-size'.
bbbbb15b 5705 (if base-size
6138158d 5706 (delete-region (+ base-size (field-beginning)) (point))
bbbbb15b
KS
5707 (choose-completion-delete-max-match choice))
5708 (insert choice)
5709 (remove-text-properties (- (point) (length choice)) (point)
5710 '(mouse-face nil))
5711 ;; Update point in the window that BUFFER is showing in.
5712 (let ((window (get-buffer-window buffer t)))
5713 (set-window-point window (point)))
5714 ;; If completing for the minibuffer, exit it with this choice.
5715 (and (not completion-no-auto-exit)
6138158d 5716 (minibufferp buffer)
bbbbb15b
KS
5717 minibuffer-completion-table
5718 ;; If this is reading a file name, and the file name chosen
5719 ;; is a directory, don't exit the minibuffer.
d23734dc 5720 (if (and minibuffer-completing-file-name
bbbbb15b
KS
5721 (file-directory-p (field-string (point-max))))
5722 (let ((mini (active-minibuffer-window)))
5723 (select-window mini)
5724 (when minibuffer-auto-raise
5725 (raise-frame (window-frame mini))))
5726 (exit-minibuffer)))))))
80298193 5727
e2947429 5728(define-derived-mode completion-list-mode nil "Completion List"
e8a700bf 5729 "Major mode for buffers showing lists of possible completions.
80298193
RS
5730Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
5731 to select the completion near point.
5732Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3a77346c
GM
5733 with the mouse.
5734
5735\\{completion-list-mode-map}"
e2947429 5736 (set (make-local-variable 'completion-base-size) nil))
e8a700bf 5737
c8d6d636
GM
5738(defun completion-list-mode-finish ()
5739 "Finish setup of the completions buffer.
5740Called from `temp-buffer-show-hook'."
5741 (when (eq major-mode 'completion-list-mode)
5742 (toggle-read-only 1)))
5743
5744(add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
5745
f5fab556
MY
5746
5747;; Variables and faces used in `completion-setup-function'.
747a0e2f 5748
d0fd0916
JPW
5749(defcustom completion-show-help t
5750 "Non-nil means show help message in *Completions* buffer."
5751 :type 'boolean
5752 :version "22.1"
5753 :group 'completion)
5754
abaf2e77
EZ
5755;; This is for packages that need to bind it to a non-default regexp
5756;; in order to make the first-differing character highlight work
5757;; to their liking
5758(defvar completion-root-regexp "^/"
5759 "Regexp to use in `completion-setup-function' to find the root directory.")
5760
f5fab556
MY
5761;; This function goes in completion-setup-hook, so that it is called
5762;; after the text of the completion list buffer is written.
e8a700bf 5763(defun completion-setup-function ()
1b5fd09e 5764 (let* ((mainbuf (current-buffer))
6cdd0211
JL
5765 (mbuf-contents (minibuffer-completion-contents))
5766 common-string-length)
621a3f62
SM
5767 ;; When reading a file name in the minibuffer,
5768 ;; set default-directory in the minibuffer
5769 ;; so it will get copied into the completion list buffer.
5770 (if minibuffer-completing-file-name
5771 (with-current-buffer mainbuf
bea15365
SM
5772 (setq default-directory
5773 (file-name-directory (expand-file-name mbuf-contents)))))
621a3f62 5774 (with-current-buffer standard-output
e2947429
SM
5775 (let ((base-size completion-base-size)) ;Read before killing localvars.
5776 (completion-list-mode)
5777 (set (make-local-variable 'completion-base-size) base-size))
1b5fd09e 5778 (set (make-local-variable 'completion-reference-buffer) mainbuf)
e2947429
SM
5779 (unless completion-base-size
5780 ;; This may be needed for old completion packages which don't use
5781 ;; completion-all-completions-with-base-size yet.
5782 (setq completion-base-size
5783 (cond
5784 (minibuffer-completing-file-name
5785 ;; For file name completion, use the number of chars before
5786 ;; the start of the file name component at point.
5787 (with-current-buffer mainbuf
5788 (save-excursion
5789 (skip-chars-backward completion-root-regexp)
5790 (- (point) (minibuffer-prompt-end)))))
5791 (minibuffer-completing-symbol nil)
5792 ;; Otherwise, in minibuffer, the base size is 0.
5793 ((minibufferp mainbuf) 0))))
d0fd0916
JPW
5794 ;; Maybe insert help string.
5795 (when completion-show-help
5796 (goto-char (point-min))
5797 (if (display-mouse-p)
5798 (insert (substitute-command-keys
5799 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
5800 (insert (substitute-command-keys
5801 "In this buffer, type \\[choose-completion] to \
5802select the completion near point.\n\n"))))))
c88ab9ce 5803
e8a700bf 5804(add-hook 'completion-setup-hook 'completion-setup-function)
dde69dbe 5805
1b5fd09e
SM
5806(define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5807(define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
dde69dbe
RS
5808
5809(defun switch-to-completions ()
5810 "Select the completion list window."
5811 (interactive)
9595fbdb
RS
5812 ;; Make sure we have a completions window.
5813 (or (get-buffer-window "*Completions*")
5814 (minibuffer-completion-help))
fdbd7c4d
KH
5815 (let ((window (get-buffer-window "*Completions*")))
5816 (when window
5817 (select-window window)
5818 (goto-char (point-min))
5d5afbcd 5819 (search-forward "\n\n" nil t)
fdbd7c4d 5820 (forward-line 1))))
f6039de6
JL
5821\f
5822;;; Support keyboard commands to turn on various modifiers.
82072f33
RS
5823
5824;; These functions -- which are not commands -- each add one modifier
5825;; to the following event.
5826
5827(defun event-apply-alt-modifier (ignore-prompt)
1e96c007 5828 "\\<function-key-map>Add the Alt modifier to the following event.
70cf9f08 5829For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
82072f33
RS
5830 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5831(defun event-apply-super-modifier (ignore-prompt)
1e96c007 5832 "\\<function-key-map>Add the Super modifier to the following event.
70cf9f08 5833For example, type \\[event-apply-super-modifier] & to enter Super-&."
82072f33
RS
5834 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5835(defun event-apply-hyper-modifier (ignore-prompt)
1e96c007 5836 "\\<function-key-map>Add the Hyper modifier to the following event.
70cf9f08 5837For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
82072f33
RS
5838 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5839(defun event-apply-shift-modifier (ignore-prompt)
1e96c007 5840 "\\<function-key-map>Add the Shift modifier to the following event.
70cf9f08 5841For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
82072f33
RS
5842 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5843(defun event-apply-control-modifier (ignore-prompt)
1e96c007 5844 "\\<function-key-map>Add the Ctrl modifier to the following event.
70cf9f08 5845For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
82072f33
RS
5846 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5847(defun event-apply-meta-modifier (ignore-prompt)
1e96c007 5848 "\\<function-key-map>Add the Meta modifier to the following event.
70cf9f08 5849For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
82072f33
RS
5850 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5851
5852(defun event-apply-modifier (event symbol lshiftby prefix)
5853 "Apply a modifier flag to event EVENT.
5854SYMBOL is the name of this modifier, as a symbol.
5855LSHIFTBY is the numeric value of this modifier, in keyboard events.
5856PREFIX is the string that represents this modifier in an event type symbol."
5857 (if (numberp event)
5858 (cond ((eq symbol 'control)
90bebcb0
KH
5859 (if (and (<= (downcase event) ?z)
5860 (>= (downcase event) ?a))
82072f33 5861 (- (downcase event) ?a -1)
90bebcb0
KH
5862 (if (and (<= (downcase event) ?Z)
5863 (>= (downcase event) ?A))
82072f33
RS
5864 (- (downcase event) ?A -1)
5865 (logior (lsh 1 lshiftby) event))))
5866 ((eq symbol 'shift)
5867 (if (and (<= (downcase event) ?z)
5868 (>= (downcase event) ?a))
5869 (upcase event)
5870 (logior (lsh 1 lshiftby) event)))
5871 (t
5872 (logior (lsh 1 lshiftby) event)))
5873 (if (memq symbol (event-modifiers event))
5874 event
5875 (let ((event-type (if (symbolp event) event (car event))))
5876 (setq event-type (intern (concat prefix (symbol-name event-type))))
5877 (if (symbolp event)
5878 event-type
5879 (cons event-type (cdr event)))))))
5880
e5fff738
KH
5881(define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5882(define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5883(define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5884(define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5885(define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5886(define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
f6039de6 5887\f
a3d1480b
JB
5888;;;; Keypad support.
5889
9b77469a
SM
5890;; Make the keypad keys act like ordinary typing keys. If people add
5891;; bindings for the function key symbols, then those bindings will
5892;; override these, so this shouldn't interfere with any existing
5893;; bindings.
a3d1480b 5894
0d173134 5895;; Also tell read-char how to handle these keys.
e1e04350 5896(mapc
a3d1480b
JB
5897 (lambda (keypad-normal)
5898 (let ((keypad (nth 0 keypad-normal))
5899 (normal (nth 1 keypad-normal)))
0d173134 5900 (put keypad 'ascii-character normal)
a3d1480b
JB
5901 (define-key function-key-map (vector keypad) (vector normal))))
5902 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5903 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
f33321ad 5904 (kp-space ?\s)
a3d1480b
JB
5905 (kp-tab ?\t)
5906 (kp-enter ?\r)
5907 (kp-multiply ?*)
5908 (kp-add ?+)
5909 (kp-separator ?,)
5910 (kp-subtract ?-)
5911 (kp-decimal ?.)
5912 (kp-divide ?/)
5913 (kp-equal ?=)))
f54b0d85 5914\f
1e722f9f 5915;;;;
b005abd5 5916;;;; forking a twin copy of a buffer.
1e722f9f 5917;;;;
b005abd5
SM
5918
5919(defvar clone-buffer-hook nil
5920 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5921
64663f06
SM
5922(defvar clone-indirect-buffer-hook nil
5923 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
5924
b005abd5
SM
5925(defun clone-process (process &optional newname)
5926 "Create a twin copy of PROCESS.
5927If NEWNAME is nil, it defaults to PROCESS' name;
5928NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5929If PROCESS is associated with a buffer, the new process will be associated
5930 with the current buffer instead.
5931Returns nil if PROCESS has already terminated."
5932 (setq newname (or newname (process-name process)))
5933 (if (string-match "<[0-9]+>\\'" newname)
5934 (setq newname (substring newname 0 (match-beginning 0))))
5935 (when (memq (process-status process) '(run stop open))
5936 (let* ((process-connection-type (process-tty-name process))
b005abd5
SM
5937 (new-process
5938 (if (memq (process-status process) '(open))
ed7069af
KS
5939 (let ((args (process-contact process t)))
5940 (setq args (plist-put args :name newname))
5941 (setq args (plist-put args :buffer
403ca8d9
KS
5942 (if (process-buffer process)
5943 (current-buffer))))
ed7069af 5944 (apply 'make-network-process args))
b005abd5
SM
5945 (apply 'start-process newname
5946 (if (process-buffer process) (current-buffer))
5947 (process-command process)))))
ed7069af
KS
5948 (set-process-query-on-exit-flag
5949 new-process (process-query-on-exit-flag process))
b005abd5
SM
5950 (set-process-inherit-coding-system-flag
5951 new-process (process-inherit-coding-system-flag process))
5952 (set-process-filter new-process (process-filter process))
5953 (set-process-sentinel new-process (process-sentinel process))
403ca8d9 5954 (set-process-plist new-process (copy-sequence (process-plist process)))
b005abd5
SM
5955 new-process)))
5956
b75b82ab 5957;; things to maybe add (currently partly covered by `funcall mode'):
b005abd5
SM
5958;; - syntax-table
5959;; - overlays
5960(defun clone-buffer (&optional newname display-flag)
6b61353c
KH
5961 "Create and return a twin copy of the current buffer.
5962Unlike an indirect buffer, the new buffer can be edited
5963independently of the old one (if it is not read-only).
5964NEWNAME is the name of the new buffer. It may be modified by
5965adding or incrementing <N> at the end as necessary to create a
5966unique buffer name. If nil, it defaults to the name of the
5967current buffer, with the proper suffix. If DISPLAY-FLAG is
5968non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5969clone a file-visiting buffer, or a buffer whose major mode symbol
5970has a non-nil `no-clone' property, results in an error.
5971
5972Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5973current buffer with appropriate suffix. However, if a prefix
5974argument is given, then the command prompts for NEWNAME in the
5975minibuffer.
b005abd5 5976
b005abd5
SM
5977This runs the normal hook `clone-buffer-hook' in the new buffer
5978after it has been set up properly in other respects."
61acfe7f
RS
5979 (interactive
5980 (progn
5981 (if buffer-file-name
5982 (error "Cannot clone a file-visiting buffer"))
5983 (if (get major-mode 'no-clone)
5984 (error "Cannot clone a buffer in %s mode" mode-name))
f6039de6
JL
5985 (list (if current-prefix-arg
5986 (read-buffer "Name of new cloned buffer: " (current-buffer)))
61acfe7f 5987 t)))
b005abd5
SM
5988 (if buffer-file-name
5989 (error "Cannot clone a file-visiting buffer"))
5990 (if (get major-mode 'no-clone)
5991 (error "Cannot clone a buffer in %s mode" mode-name))
5992 (setq newname (or newname (buffer-name)))
5993 (if (string-match "<[0-9]+>\\'" newname)
5994 (setq newname (substring newname 0 (match-beginning 0))))
5995 (let ((buf (current-buffer))
5996 (ptmin (point-min))
5997 (ptmax (point-max))
5998 (pt (point))
5999 (mk (if mark-active (mark t)))
6000 (modified (buffer-modified-p))
6001 (mode major-mode)
6002 (lvars (buffer-local-variables))
6003 (process (get-buffer-process (current-buffer)))
6004 (new (generate-new-buffer (or newname (buffer-name)))))
6005 (save-restriction
6006 (widen)
6007 (with-current-buffer new
6008 (insert-buffer-substring buf)))
6009 (with-current-buffer new
6010 (narrow-to-region ptmin ptmax)
6011 (goto-char pt)
6012 (if mk (set-mark mk))
6013 (set-buffer-modified-p modified)
6014
6015 ;; Clone the old buffer's process, if any.
6016 (when process (clone-process process))
6017
6018 ;; Now set up the major mode.
6019 (funcall mode)
6020
6021 ;; Set up other local variables.
9ca2204b
JB
6022 (mapc (lambda (v)
6023 (condition-case () ;in case var is read-only
6024 (if (symbolp v)
6025 (makunbound v)
6026 (set (make-local-variable (car v)) (cdr v)))
6027 (error nil)))
6028 lvars)
b005abd5
SM
6029
6030 ;; Run any hooks (typically set up by the major mode
6031 ;; for cloning to work properly).
6032 (run-hooks 'clone-buffer-hook))
0a487199
SM
6033 (if display-flag
6034 ;; Presumably the current buffer is shown in the selected frame, so
6035 ;; we want to display the clone elsewhere.
6036 (let ((same-window-regexps nil)
6037 (same-window-buffer-names))
6038 (pop-to-buffer new)))
b005abd5
SM
6039 new))
6040
fa65f20b 6041
7e3afb04 6042(defun clone-indirect-buffer (newname display-flag &optional norecord)
fa65f20b
GM
6043 "Create an indirect buffer that is a twin copy of the current buffer.
6044
01ba9662 6045Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
fa65f20b
GM
6046from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6047or if not called with a prefix arg, NEWNAME defaults to the current
6048buffer's name. The name is modified by adding a `<N>' suffix to it
6049or by incrementing the N in an existing suffix.
6050
6051DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7e3afb04
GM
6052This is always done when called interactively.
6053
f33321ad 6054Optional third arg NORECORD non-nil means do not put this buffer at the
7e3afb04 6055front of the list of recently selected ones."
61acfe7f
RS
6056 (interactive
6057 (progn
6058 (if (get major-mode 'no-clone-indirect)
6059 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6060 (list (if current-prefix-arg
f6039de6 6061 (read-buffer "Name of indirect buffer: " (current-buffer)))
61acfe7f
RS
6062 t)))
6063 (if (get major-mode 'no-clone-indirect)
6064 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
fa65f20b
GM
6065 (setq newname (or newname (buffer-name)))
6066 (if (string-match "<[0-9]+>\\'" newname)
6067 (setq newname (substring newname 0 (match-beginning 0))))
6068 (let* ((name (generate-new-buffer-name newname))
6069 (buffer (make-indirect-buffer (current-buffer) name t)))
64663f06
SM
6070 (with-current-buffer buffer
6071 (run-hooks 'clone-indirect-buffer-hook))
fa65f20b 6072 (when display-flag
58dd38f1 6073 (pop-to-buffer buffer norecord))
fa65f20b
GM
6074 buffer))
6075
6076
1fffd65f
RS
6077(defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6078 "Like `clone-indirect-buffer' but display in another window."
2ef0a47e
RS
6079 (interactive
6080 (progn
6081 (if (get major-mode 'no-clone-indirect)
6082 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6083 (list (if current-prefix-arg
f6039de6 6084 (read-buffer "Name of indirect buffer: " (current-buffer)))
2ef0a47e 6085 t)))
acd39eb6 6086 (let ((pop-up-windows t))
1fffd65f 6087 (clone-indirect-buffer newname display-flag norecord)))
7e3afb04 6088
f54b0d85 6089\f
1d4b11bf
GM
6090;;; Handling of Backspace and Delete keys.
6091
30a2fded 6092(defcustom normal-erase-is-backspace 'maybe
3784ec80 6093 "Set the default behavior of the Delete and Backspace keys.
30a2fded
KL
6094
6095If set to t, Delete key deletes forward and Backspace key deletes
6096backward.
6097
6098If set to nil, both Delete and Backspace keys delete backward.
6099
6100If set to 'maybe (which is the default), Emacs automatically
3784ec80 6101selects a behavior. On window systems, the behavior depends on
30a2fded
KL
6102the keyboard used. If the keyboard has both a Backspace key and
6103a Delete key, and both are mapped to their usual meanings, the
6104option's default value is set to t, so that Backspace can be used
6105to delete backward, and Delete can be used to delete forward.
6106
6107If not running under a window system, customizing this option
6108accomplishes a similar effect by mapping C-h, which is usually
6109generated by the Backspace key, to DEL, and by mapping DEL to C-d
6110via `keyboard-translate'. The former functionality of C-h is
6111available on the F1 key. You should probably not use this
6112setting if you don't have both Backspace, Delete and F1 keys.
f060b834
GM
6113
6114Setting this variable with setq doesn't take effect. Programmatically,
7f62656b 6115call `normal-erase-is-backspace-mode' (which see) instead."
30a2fded
KL
6116 :type '(choice (const :tag "Off" nil)
6117 (const :tag "Maybe" maybe)
6118 (other :tag "On" t))
1d4b11bf
GM
6119 :group 'editing-basics
6120 :version "21.1"
6121 :set (lambda (symbol value)
6122 ;; The fboundp is because of a problem with :set when
6123 ;; dumping Emacs. It doesn't really matter.
7f62656b
EZ
6124 (if (fboundp 'normal-erase-is-backspace-mode)
6125 (normal-erase-is-backspace-mode (or value 0))
1d4b11bf
GM
6126 (set-default symbol value))))
6127
30a2fded
KL
6128(defun normal-erase-is-backspace-setup-frame (&optional frame)
6129 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6130 (unless frame (setq frame (selected-frame)))
6131 (with-selected-frame frame
ed8dad6b 6132 (unless (terminal-parameter nil 'normal-erase-is-backspace)
08ea6d2f
SM
6133 (normal-erase-is-backspace-mode
6134 (if (if (eq normal-erase-is-backspace 'maybe)
6135 (and (not noninteractive)
6136 (or (memq system-type '(ms-dos windows-nt))
08ea6d2f
SM
6137 (and (memq window-system '(x))
6138 (fboundp 'x-backspace-delete-keys-p)
6139 (x-backspace-delete-keys-p))
6140 ;; If the terminal Emacs is running on has erase char
6141 ;; set to ^H, use the Backspace key for deleting
6142 ;; backward, and the Delete key for deleting forward.
6143 (and (null window-system)
6144 (eq tty-erase-char ?\^H))))
6145 normal-erase-is-backspace)
6146 1 0)))))
1d4b11bf 6147
7f62656b
EZ
6148(defun normal-erase-is-backspace-mode (&optional arg)
6149 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6150
e02160a3 6151With numeric arg, turn the mode on if and only if ARG is positive.
7f62656b 6152
30a2fded
KL
6153On window systems, when this mode is on, Delete is mapped to C-d
6154and Backspace is mapped to DEL; when this mode is off, both
6155Delete and Backspace are mapped to DEL. (The remapping goes via
6156`local-function-key-map', so binding Delete or Backspace in the
6157global or local keymap will override that.)
7f62656b
EZ
6158
6159In addition, on window systems, the bindings of C-Delete, M-Delete,
6160C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6161the global keymap in accordance with the functionality of Delete and
6162Backspace. For example, if Delete is remapped to C-d, which deletes
6163forward, C-Delete is bound to `kill-word', but if Delete is remapped
6164to DEL, which deletes backward, C-Delete is bound to
6165`backward-kill-word'.
6166
6167If not running on a window system, a similar effect is accomplished by
6168remapping C-h (normally produced by the Backspace key) and DEL via
6169`keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6170to C-d; if it's off, the keys are not remapped.
6171
6172When not running on a window system, and this mode is turned on, the
6173former functionality of C-h is available on the F1 key. You should
6174probably not turn on this mode on a text-only terminal if you don't
6175have both Backspace, Delete and F1 keys.
6176
6177See also `normal-erase-is-backspace'."
1d4b11bf 6178 (interactive "P")
0103b7c9
KL
6179 (let ((enabled (or (and arg (> (prefix-numeric-value arg) 0))
6180 (and (not arg)
6181 (not (eq 1 (terminal-parameter
6182 nil 'normal-erase-is-backspace)))))))
6183 (set-terminal-parameter nil 'normal-erase-is-backspace
6184 (if enabled 1 0))
6185
9e2a2647 6186 (cond ((or (memq window-system '(x w32 ns pc))
0103b7c9
KL
6187 (memq system-type '(ms-dos windows-nt)))
6188 (let* ((bindings
6189 `(([C-delete] [C-backspace])
6190 ([M-delete] [M-backspace])
6191 ([C-M-delete] [C-M-backspace])
6192 (,esc-map
6193 [C-delete] [C-backspace])))
6194 (old-state (lookup-key local-function-key-map [delete])))
6195
6196 (if enabled
6197 (progn
6198 (define-key local-function-key-map [delete] [?\C-d])
6199 (define-key local-function-key-map [kp-delete] [?\C-d])
6200 (define-key local-function-key-map [backspace] [?\C-?]))
6201 (define-key local-function-key-map [delete] [?\C-?])
6202 (define-key local-function-key-map [kp-delete] [?\C-?])
6203 (define-key local-function-key-map [backspace] [?\C-?]))
6204
6205 ;; Maybe swap bindings of C-delete and C-backspace, etc.
6206 (unless (equal old-state (lookup-key local-function-key-map [delete]))
6207 (dolist (binding bindings)
6208 (let ((map global-map))
6209 (when (keymapp (car binding))
6210 (setq map (car binding) binding (cdr binding)))
6211 (let* ((key1 (nth 0 binding))
6212 (key2 (nth 1 binding))
6213 (binding1 (lookup-key map key1))
6214 (binding2 (lookup-key map key2)))
6215 (define-key map key1 binding2)
6216 (define-key map key2 binding1)))))))
6217 (t
6218 (if enabled
ec9f4754 6219 (progn
0103b7c9
KL
6220 (keyboard-translate ?\C-h ?\C-?)
6221 (keyboard-translate ?\C-? ?\C-d))
6222 (keyboard-translate ?\C-h ?\C-h)
6223 (keyboard-translate ?\C-? ?\C-?))))
6224
6225 (run-hooks 'normal-erase-is-backspace-hook)
6226 (if (interactive-p)
6227 (message "Delete key deletes %s"
6228 (if (terminal-parameter nil 'normal-erase-is-backspace)
6229 "forward" "backward")))))
ea82f0df 6230\f
aca8bee5 6231(defvar vis-mode-saved-buffer-invisibility-spec nil
0f7df535 6232 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7f62656b 6233
0f7df535
RS
6234(define-minor-mode visible-mode
6235 "Toggle Visible mode.
4837b516
GM
6236With argument ARG turn Visible mode on if ARG is positive, otherwise
6237turn it off.
1d4b11bf 6238
0f7df535
RS
6239Enabling Visible mode makes all invisible text temporarily visible.
6240Disabling Visible mode turns off that effect. Visible mode
6241works by saving the value of `buffer-invisibility-spec' and setting it to nil."
4e57881d 6242 :lighter " Vis"
ab77efd0 6243 :group 'editing-basics
aca8bee5
SM
6244 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6245 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6246 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
0f7df535 6247 (when visible-mode
aca8bee5
SM
6248 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6249 buffer-invisibility-spec)
6250 (setq buffer-invisibility-spec nil)))
4e57881d 6251\f
30ee26a9
EZ
6252;; Partial application of functions (similar to "currying").
6253(defun apply-partially (fun &rest args)
6254 "Return a function that is a partial application of FUN to ARGS.
6255ARGS is a list of the first N arguments to pass to FUN.
6256The result is a new function which does the same as FUN, except that
6257the first N arguments are fixed at the values with which this function
6258was called."
6259 (lexical-let ((fun fun) (args1 args))
6260 (lambda (&rest args2) (apply fun (append args1 args2)))))
6261\f
e1e04350 6262;; Minibuffer prompt stuff.
9b350152 6263
49c14a05
GM
6264;(defun minibuffer-prompt-modification (start end)
6265; (error "You cannot modify the prompt"))
6266;
6267;
6268;(defun minibuffer-prompt-insertion (start end)
6269; (let ((inhibit-modification-hooks t))
6270; (delete-region start end)
6271; ;; Discard undo information for the text insertion itself
6272; ;; and for the text deletion.above.
6273; (when (consp buffer-undo-list)
6274; (setq buffer-undo-list (cddr buffer-undo-list)))
6275; (message "You cannot modify the prompt")))
6276;
6277;
f1180544 6278;(setq minibuffer-prompt-properties
49c14a05
GM
6279; (list 'modification-hooks '(minibuffer-prompt-modification)
6280; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
f1180544 6281;
9b350152 6282
a2603048
GM
6283\f
6284;;;; Problematic external packages.
6285
6286;; rms says this should be done by specifying symbols that define
6287;; versions together with bad values. This is therefore not as
6288;; flexible as it could be. See the thread:
6289;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6290(defconst bad-packages-alist
6291 ;; Not sure exactly which semantic versions have problems.
6292 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7796ee61 6293 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
a2603048 6294 "The version of `semantic' loaded does not work in Emacs 22.
72d595b5
GM
6295It can cause constant high CPU load.
6296Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
a2603048
GM
6297 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6298 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6299 ;; provided the `CUA-mode' feature. Since this is no longer true,
6300 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6301 (CUA-mode t nil
6302"CUA-mode is now part of the standard GNU Emacs distribution,
6303so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6304
6305You have loaded an older version of CUA-mode which does not work
6306correctly with this version of Emacs. You should remove the old
6307version and use the one distributed with Emacs."))
6308 "Alist of packages known to cause problems in this version of Emacs.
6309Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6310PACKAGE is either a regular expression to match file names, or a
6311symbol (a feature name); see the documentation of
6312`after-load-alist', to which this variable adds functions.
6313SYMBOL is either the name of a string variable, or `t'. Upon
6314loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6315warning using STRING as the message.")
6316
6317(defun bad-package-check (package)
6318 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6319 (condition-case nil
6320 (let* ((list (assoc package bad-packages-alist))
6321 (symbol (nth 1 list)))
6322 (and list
6323 (boundp symbol)
6324 (or (eq symbol t)
6325 (and (stringp (setq symbol (eval symbol)))
6326 (string-match (nth 2 list) symbol)))
6327 (display-warning :warning (nth 3 list))))
6328 (error nil)))
6329
6330(mapc (lambda (elem)
6331 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6332 bad-packages-alist)
6333
6334
00398e3b 6335(provide 'simple)
6b61353c 6336
621a3f62 6337;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
c88ab9ce 6338;;; simple.el ends here