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