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