1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2013 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
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.
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.
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/>.
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
31 (declare-function widget-convert "wid-edit" (type &rest args))
32 (declare-function shell-mode "shell" ())
35 (defvar compilation-current-error)
36 (defvar compilation-context-lines)
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."
47 "Killing and yanking commands."
50 (defgroup paren-matching nil
51 "Highlight (un)matching of parens and expressions."
54 ;;; next-error support framework
56 (defgroup next-error nil
57 "`next-error' support framework."
62 '((t (:inherit region)))
63 "Face used to highlight next error locus."
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))
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))
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))
106 (defcustom next-error-hook nil
107 "List of hook functions run by `next-error' after visiting source file."
111 (defvar next-error-highlight-timer nil)
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)
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].")
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
132 (make-variable-buffer-local 'next-error-function)
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)
142 (defsubst next-error-buffer-p (buffer
143 &optional avoid-current
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
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.
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)
166 ;; Optionally accept some other buffers.
167 (and extra-test-inclusive
168 (funcall extra-test-inclusive))))))
170 (defun next-error-find-buffer (&optional avoid-current
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
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.
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."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
187 (let ((window-buffers
189 (delq nil (mapcar (lambda (w)
190 (if (next-error-buffer-p
193 extra-test-inclusive extra-test-exclusive)
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)
207 ;; 4. Look for any acceptable buffer.
208 (let ((buffers (buffer-list)))
210 (not (next-error-buffer-p
211 (car buffers) avoid-current
212 extra-test-inclusive extra-test-exclusive)))
213 (setq buffers (cdr buffers)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
218 (next-error-buffer-p (current-buffer) nil
219 extra-test-inclusive extra-test-exclusive)
221 (message "This is the only buffer with error message locations")
224 (error "No buffers contain error message locations")))
226 (defun next-error (&optional arg reset)
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
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.
237 The RESET argument specifies that we should restart from the beginning.
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.
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.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
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))))
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)))
276 (defalias 'goto-next-locus 'next-error)
277 (defalias 'next-match 'next-error)
279 (defun previous-error (&optional n)
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
285 This operates on the output from the \\[compile] and \\[grep] commands."
287 (next-error (- (or n 1))))
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."
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."
304 (let ((next-error-highlight next-error-highlight-no-select))
306 (pop-to-buffer next-error-last-buffer))
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."
315 (next-error-no-select (- (or n 1))))
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
318 (defvar next-error-follow-last-line nil)
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
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)))
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))
339 (let ((compilation-context-lines nil))
340 (setq compilation-current-error (point))
341 (next-error-no-select 0))
347 (defun fundamental-mode ()
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
351 (kill-all-local-variables)
354 ;; Special major modes to view specially formatted data rather than files.
356 (defvar special-mode-map
357 (let ((map (make-sparse-keymap)))
358 (suppress-keymap map)
359 (define-key map "q" 'quit-window)
360 (define-key map " " 'scroll-up-command)
361 (define-key map [?\S-\ ] 'scroll-down-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)
370 (put 'special-mode 'mode-class 'special)
371 (define-derived-mode special-mode nil "Special"
372 "Parent major mode from which special major modes should inherit."
373 (setq buffer-read-only t))
375 ;; Major mode meant to be the parent of programming modes.
377 (defvar prog-mode-map
378 (let ((map (make-sparse-keymap)))
379 (define-key map [?\C-\M-q] 'prog-indent-sexp)
381 "Keymap used for programming modes.")
383 (defun prog-indent-sexp ()
384 "Indent the expression after point."
386 (let ((start (point))
387 (end (save-excursion (forward-sexp 1) (point))))
388 (indent-region start end nil)))
390 (define-derived-mode prog-mode fundamental-mode "Prog"
391 "Major mode for editing programming language source code."
392 (set (make-local-variable 'require-final-newline) mode-require-final-newline)
393 (set (make-local-variable 'parse-sexp-ignore-comments) t)
394 ;; Any programming language is always written left to right.
395 (setq bidi-paragraph-direction 'left-to-right))
397 ;; Making and deleting lines.
399 (defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard))
400 "Propertized string representing a hard newline character.")
402 (defun newline (&optional arg)
403 "Insert a newline, and move to left margin of the new line if it's blank.
404 If option `use-hard-newlines' is non-nil, the newline is marked with the
405 text-property `hard'.
406 With ARG, insert that many newlines.
407 Call `auto-fill-function' if the current column number is greater
408 than the value of `fill-column' and ARG is nil."
410 (barf-if-buffer-read-only)
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
413 (let* ((was-page-start (and (bolp) (looking-at page-delimiter)))
415 (last-command-event ?\n)
416 ;; Don't auto-fill if we have a numeric argument.
417 (auto-fill-function (if arg nil auto-fill-function))
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
422 ;; Mark the newline(s) `hard'.
423 (if use-hard-newlines
424 (set-hard-newline-properties
425 (- (point) (prefix-numeric-value arg)) (point)))
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
429 (goto-char beforepos)
431 (and (looking-at "[ \t]$")
432 (> (current-left-margin) 0)
433 (delete-region (point)
434 (line-end-position))))
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
439 (move-to-left-margin nil t)))))
442 (add-hook 'post-self-insert-hook postproc)
443 (self-insert-command (prefix-numeric-value arg)))
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
447 (remove-hook 'post-self-insert-hook postproc)))
450 (defun set-hard-newline-properties (from to)
451 (let ((sticky (get-text-property from 'rear-nonsticky)))
452 (put-text-property from to 'hard 't)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
454 (if (and (listp sticky) (not (memq 'hard sticky)))
455 (put-text-property from (point) 'rear-nonsticky
456 (cons 'hard sticky)))))
459 "Insert a newline and leave point before it.
460 If there is a fill prefix and/or a `left-margin', insert them
461 on the new line if the line would have been blank.
462 With arg N, insert N newlines."
464 (let* ((do-fill-prefix (and fill-prefix (bolp)))
465 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
467 ;; Don't expand an abbrev before point.
473 (if do-left-margin (indent-to (current-left-margin)))
474 (if do-fill-prefix (insert-and-inherit fill-prefix))))
480 (defun split-line (&optional arg)
481 "Split current line, moving portion beyond point vertically down.
482 If the current line starts with `fill-prefix', insert it on the new
483 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
485 When called from Lisp code, ARG may be a prefix string to copy."
487 (skip-chars-forward " \t")
488 (let* ((col (current-column))
490 ;; What prefix should we check for (nil means don't).
491 (prefix (cond ((stringp arg) arg)
494 ;; Does this line start with it?
495 (have-prfx (and prefix
498 (looking-at (regexp-quote prefix))))))
500 (if have-prfx (insert-and-inherit prefix))
504 (defun delete-indentation (&optional arg)
505 "Join this line to previous and fix up whitespace at join.
506 If there is a fill prefix, delete it from the beginning of this line.
507 With argument, join this line to following line."
510 (if arg (forward-line 1))
511 (if (eq (preceding-char) ?\n)
513 (delete-region (point) (1- (point)))
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
517 (<= (+ (point) (length fill-prefix)) (point-max))
519 (buffer-substring (point)
520 (+ (point) (length fill-prefix)))))
521 (delete-region (point) (+ (point) (length fill-prefix))))
522 (fixup-whitespace))))
524 (defalias 'join-line #'delete-indentation) ; easier to find
526 (defun delete-blank-lines ()
527 "On blank line, delete all surrounding blank lines, leaving just one.
528 On isolated blank line, delete that one.
529 On nonblank line, delete any immediately following blank lines."
531 (let (thisblank singleblank)
534 (setq thisblank (looking-at "[ \t]*$"))
535 ;; Set singleblank if there is just one blank line here.
538 (not (looking-at "[ \t]*\n[ \t]*$"))
540 (progn (forward-line -1)
541 (not (looking-at "[ \t]*$")))))))
542 ;; Delete preceding blank lines, and this one too if it's the only one.
546 (if singleblank (forward-line 1))
547 (delete-region (point)
548 (if (re-search-backward "[^ \t\n]" nil t)
549 (progn (forward-line 1) (point))
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
553 (if (not (and thisblank singleblank))
557 (delete-region (point)
558 (if (re-search-forward "[^ \t\n]" nil t)
559 (progn (beginning-of-line) (point))
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
563 (if (looking-at "^[ \t]*\n\\'")
564 (delete-region (point) (point-max)))))
566 (defcustom delete-trailing-lines t
567 "If non-nil, \\[delete-trailing-whitespace] deletes trailing lines.
568 Trailing lines are deleted only if `delete-trailing-whitespace'
569 is called on the entire buffer (rather than an active region)."
574 (defun delete-trailing-whitespace (&optional start end)
575 "Delete trailing whitespace between START and END.
576 If called interactively, START and END are the start/end of the
577 region if the mark is active, or of the buffer's accessible
578 portion if the mark is inactive.
580 This command deletes whitespace characters after the last
581 non-whitespace character in each line between START and END. It
582 does not consider formfeed characters to be whitespace.
584 If this command acts on the entire buffer (i.e. if called
585 interactively with the mark inactive, or called from Lisp with
586 END nil), it also deletes all trailing lines at the end of the
587 buffer if the variable `delete-trailing-lines' is non-nil."
589 (barf-if-buffer-read-only)
591 (list (region-beginning) (region-end))
595 (let ((end-marker (copy-marker (or end (point-max))))
596 (start (or start (point-min))))
598 (while (re-search-forward "\\s-$" end-marker t)
599 (skip-syntax-backward "-" (line-beginning-position))
600 ;; Don't delete formfeeds, even if they are considered whitespace.
601 (if (looking-at-p ".*\f")
602 (goto-char (match-end 0)))
603 (delete-region (point) (match-end 0)))
604 ;; Delete trailing empty lines.
605 (goto-char end-marker)
607 delete-trailing-lines
608 ;; Really the end of buffer.
609 (= (point-max) (1+ (buffer-size)))
610 (<= (skip-chars-backward "\n") -2))
611 (delete-region (1+ (point)) end-marker))
612 (set-marker end-marker nil))))
613 ;; Return nil for the benefit of `write-file-functions'.
616 (defun newline-and-indent ()
617 "Insert a newline, then indent according to major mode.
618 Indentation is done using the value of `indent-line-function'.
619 In programming language modes, this is the same as TAB.
620 In some text modes, where TAB inserts a tab, this command indents to the
621 column specified by the function `current-left-margin'."
623 (delete-horizontal-space t)
625 (indent-according-to-mode))
627 (defun reindent-then-newline-and-indent ()
628 "Reindent current line, insert newline, then indent the new line.
629 Indentation of both lines is done according to the current major mode,
630 which means calling the current value of `indent-line-function'.
631 In programming language modes, this is the same as TAB.
632 In some text modes, where TAB inserts a tab, this indents to the
633 column specified by the function `current-left-margin'."
636 ;; Be careful to insert the newline before indenting the line.
637 ;; Otherwise, the indentation might be wrong.
641 ;; We are at EOL before the call to indent-according-to-mode, and
642 ;; after it we usually are as well, but not always. We tried to
643 ;; address it with `save-excursion' but that uses a normal marker
644 ;; whereas we need `move after insertion', so we do the save/restore
646 (setq pos (copy-marker pos t))
647 (indent-according-to-mode)
649 ;; Remove the trailing white-space after indentation because
650 ;; indentation may introduce the whitespace.
651 (delete-horizontal-space t))
652 (indent-according-to-mode)))
654 (defun quoted-insert (arg)
655 "Read next input character and insert it.
656 This is useful for inserting control characters.
657 With argument, insert ARG copies of the character.
659 If the first character you type after this command is an octal digit,
660 you should type a sequence of octal digits which specify a character code.
661 Any nondigit terminates the sequence. If the terminator is a RET,
662 it is discarded; any other terminator is used itself as input.
663 The variable `read-quoted-char-radix' specifies the radix for this feature;
664 set it to 10 or 16 to use decimal or hex instead of octal.
666 In overwrite mode, this function inserts the character anyway, and
667 does not handle octal digits specially. This means that if you use
668 overwrite as your normal editing mode, you can use this function to
669 insert characters when necessary.
671 In binary overwrite mode, this function does overwrite, and octal
672 digits are interpreted as a character code. This is intended to be
673 useful for editing binary files."
676 ;; Avoid "obsolete" warnings for translation-table-for-input.
678 (let (translation-table-for-input input-method-function)
679 (if (or (not overwrite-mode)
680 (eq overwrite-mode 'overwrite-mode-binary))
683 ;; This used to assume character codes 0240 - 0377 stand for
684 ;; characters in some single-byte character set, and converted them
685 ;; to Emacs characters. But in 23.1 this feature is deprecated
686 ;; in favor of inserting the corresponding Unicode characters.
687 ;; (if (and enable-multibyte-characters
690 ;; (setq char (unibyte-char-to-multibyte char)))
692 (if (eq overwrite-mode 'overwrite-mode-binary)
695 (insert-and-inherit char)
696 (setq arg (1- arg)))))
698 (defun forward-to-indentation (&optional arg)
699 "Move forward ARG lines and position at first nonblank character."
701 (forward-line (or arg 1))
702 (skip-chars-forward " \t"))
704 (defun backward-to-indentation (&optional arg)
705 "Move backward ARG lines and position at first nonblank character."
707 (forward-line (- (or arg 1)))
708 (skip-chars-forward " \t"))
710 (defun back-to-indentation ()
711 "Move point to the first non-whitespace character on this line."
713 (beginning-of-line 1)
714 (skip-syntax-forward " " (line-end-position))
715 ;; Move back over chars that have whitespace syntax but have the p flag.
716 (backward-prefix-chars))
718 (defun fixup-whitespace ()
719 "Fixup white space between objects around point.
720 Leave one space or none, according to the context."
723 (delete-horizontal-space)
724 (if (or (looking-at "^\\|\\s)")
725 (save-excursion (forward-char -1)
726 (looking-at "$\\|\\s(\\|\\s'")))
730 (defun delete-horizontal-space (&optional backward-only)
731 "Delete all spaces and tabs around point.
732 If BACKWARD-ONLY is non-nil, only delete them before point."
734 (let ((orig-pos (point)))
739 (skip-chars-forward " \t")
740 (constrain-to-field nil orig-pos t)))
742 (skip-chars-backward " \t")
743 (constrain-to-field nil orig-pos)))))
745 (defun just-one-space (&optional n)
746 "Delete all spaces and tabs around point, leaving one space (or N spaces).
747 If N is negative, delete newlines as well, leaving -N spaces."
749 (cycle-spacing n nil t))
751 (defvar cycle-spacing--context nil
752 "Store context used in consecutive calls to `cycle-spacing' command.
753 The first time this function is run, it saves the original point
754 position and original spacing around the point in this
757 (defun cycle-spacing (&optional n preserve-nl-back single-shot)
758 "Manipulate spaces around the point in a smart way.
760 When run as an interactive command, the first time it's called
761 in a sequence, deletes all spaces and tabs around point leaving
762 one (or N spaces). If this does not change content of the
763 buffer, skips to the second step:
765 When run for the second time in a sequence, deletes all the
766 spaces it has previously inserted.
768 When run for the third time, returns the whitespace and point in
769 a state encountered when it had been run for the first time.
771 For example, if buffer contains \"foo ^ bar\" with \"^\" denoting the
772 point, calling `cycle-spacing' command will replace two spaces with
773 a single space, calling it again immediately after, will remove all
774 spaces, and calling it for the third time will bring two spaces back
777 If N is negative, delete newlines as well. However, if
778 PRESERVE-NL-BACK is t new line characters prior to the point
781 If SINGLE-SHOT is non-nil, will only perform the first step. In
782 other words, it will work just like `just-one-space' command."
784 (let ((orig-pos (point))
785 (skip-characters (if (and n (< n 0)) " \t\n\r" " \t"))
787 (skip-chars-backward (if preserve-nl-back " \t" skip-characters))
788 (constrain-to-field nil orig-pos)
790 ;; Command run for the first time or single-shot is non-nil.
792 (not (equal last-command this-command))
793 (not cycle-spacing--context))
794 (let* ((start (point))
795 (n (- n (skip-chars-forward " " (+ n (point)))))
798 (skip-chars-forward skip-characters)
799 (constrain-to-field nil orig-pos t))))
800 (setq cycle-spacing--context ;; Save for later.
801 ;; Special handling for case where there was no space at all.
802 (unless (= start end)
803 (cons orig-pos (buffer-substring start (point)))))
804 ;; If this run causes no change in buffer content, delete all spaces,
805 ;; otherwise delete all excess spaces.
806 (delete-region (if (and (not single-shot) (zerop n) (= mid end))
808 (insert (make-string n ?\s))))
810 ;; Command run for the second time.
811 ((not (equal orig-pos (point)))
812 (delete-region (point) orig-pos))
814 ;; Command run for the third time.
816 (insert (cdr cycle-spacing--context))
817 (goto-char (car cycle-spacing--context))
818 (setq cycle-spacing--context nil)))))
820 (defun beginning-of-buffer (&optional arg)
821 "Move point to the beginning of the buffer.
822 With numeric arg N, put point N/10 of the way from the beginning.
823 If the buffer is narrowed, this command uses the beginning of the
824 accessible part of the buffer.
826 If Transient Mark mode is disabled, leave mark at previous
827 position, unless a \\[universal-argument] prefix is supplied.
829 Don't use this command in Lisp programs!
830 \(goto-char (point-min)) is faster."
835 (let ((size (- (point-max) (point-min))))
836 (goto-char (if (and arg (not (consp arg)))
839 ;; Avoid overflow for large buffer sizes!
840 (* (prefix-numeric-value arg)
842 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
844 (if (and arg (not (consp arg))) (forward-line 1)))
846 (defun end-of-buffer (&optional arg)
847 "Move point to the end of the buffer.
848 With numeric arg N, put point N/10 of the way from the end.
849 If the buffer is narrowed, this command uses the end of the
850 accessible part of the buffer.
852 If Transient Mark mode is disabled, leave mark at previous
853 position, unless a \\[universal-argument] prefix is supplied.
855 Don't use this command in Lisp programs!
856 \(goto-char (point-max)) is faster."
858 (or (consp arg) (region-active-p) (push-mark))
859 (let ((size (- (point-max) (point-min))))
860 (goto-char (if (and arg (not (consp arg)))
863 ;; Avoid overflow for large buffer sizes!
864 (* (prefix-numeric-value arg)
866 (/ (* size (prefix-numeric-value arg)) 10)))
868 ;; If we went to a place in the middle of the buffer,
869 ;; adjust it to the beginning of a line.
870 (cond ((and arg (not (consp arg))) (forward-line 1))
871 ((and (eq (current-buffer) (window-buffer))
872 (> (point) (window-end nil t)))
873 ;; If the end of the buffer is not already on the screen,
874 ;; then scroll specially to put it near, but not at, the bottom.
875 (overlay-recenter (point))
878 (defcustom delete-active-region t
879 "Whether single-char deletion commands delete an active region.
880 This has an effect only if Transient Mark mode is enabled, and
881 affects `delete-forward-char' and `delete-backward-char', though
884 If the value is the symbol `kill', the active region is killed
886 :type '(choice (const :tag "Delete active region" t)
887 (const :tag "Kill active region" kill)
888 (const :tag "Do ordinary deletion" nil))
892 (defun delete-backward-char (n &optional killflag)
893 "Delete the previous N characters (following if N is negative).
894 If Transient Mark mode is enabled, the mark is active, and N is 1,
895 delete the text in the region and deactivate the mark instead.
896 To disable this, set option `delete-active-region' to nil.
898 Optional second arg KILLFLAG, if non-nil, means to kill (save in
899 kill ring) instead of delete. Interactively, N is the prefix
900 arg, and KILLFLAG is set if N is explicitly specified.
902 In Overwrite mode, single character backward deletion may replace
903 tabs with spaces so as to back over columns, unless point is at
904 the end of the line."
907 (signal 'wrong-type-argument (list 'integerp n)))
908 (cond ((and (use-region-p)
911 ;; If a region is active, kill or delete it.
912 (if (eq delete-active-region 'kill)
913 (kill-region (region-beginning) (region-end))
914 (delete-region (region-beginning) (region-end))))
915 ;; In Overwrite mode, maybe untabify while deleting
916 ((null (or (null overwrite-mode)
918 (memq (char-before) '(?\t ?\n))
920 (eq (char-after) ?\n)))
921 (let ((ocol (current-column)))
922 (delete-char (- n) killflag)
924 (insert-char ?\s (- ocol (current-column)) nil))))
925 ;; Otherwise, do simple deletion.
926 (t (delete-char (- n) killflag))))
928 (defun delete-forward-char (n &optional killflag)
929 "Delete the following N characters (previous if N is negative).
930 If Transient Mark mode is enabled, the mark is active, and N is 1,
931 delete the text in the region and deactivate the mark instead.
932 To disable this, set variable `delete-active-region' to nil.
934 Optional second arg KILLFLAG non-nil means to kill (save in kill
935 ring) instead of delete. Interactively, N is the prefix arg, and
936 KILLFLAG is set if N was explicitly specified."
939 (signal 'wrong-type-argument (list 'integerp n)))
940 (cond ((and (use-region-p)
943 ;; If a region is active, kill or delete it.
944 (if (eq delete-active-region 'kill)
945 (kill-region (region-beginning) (region-end))
946 (delete-region (region-beginning) (region-end))))
947 ;; Otherwise, do simple deletion.
948 (t (delete-char n killflag))))
950 (defun mark-whole-buffer ()
951 "Put point at beginning and mark at end of buffer.
952 If narrowing is in effect, only uses the accessible part of the buffer.
953 You probably should not use this function in Lisp programs;
954 it is usually a mistake for a Lisp function to use any subroutine
955 that uses or sets the mark."
958 (push-mark (point-max) nil t)
959 (goto-char (point-min)))
962 ;; Counting lines, one way or another.
964 (defun goto-line (line &optional buffer)
965 "Go to LINE, counting from line 1 at beginning of buffer.
966 If called interactively, a numeric prefix argument specifies
967 LINE; without a numeric prefix argument, read LINE from the
970 If optional argument BUFFER is non-nil, switch to that buffer and
971 move to line LINE there. If called interactively with \\[universal-argument]
972 as argument, BUFFER is the most recently selected other buffer.
974 Prior to moving point, this function sets the mark (without
975 activating it), unless Transient Mark mode is enabled and the
976 mark is already active.
978 This function is usually the wrong thing to use in a Lisp program.
979 What you probably want instead is something like:
980 (goto-char (point-min))
981 (forward-line (1- N))
982 If at all possible, an even better solution is to use char counts
983 rather than line counts."
985 (if (and current-prefix-arg (not (consp current-prefix-arg)))
986 (list (prefix-numeric-value current-prefix-arg))
987 ;; Look for a default, a number in the buffer at point.
990 (skip-chars-backward "0-9")
991 (if (looking-at "[0-9]")
993 (buffer-substring-no-properties
995 (progn (skip-chars-forward "0-9")
997 ;; Decide if we're switching buffers.
999 (if (consp current-prefix-arg)
1000 (other-buffer (current-buffer) t)))
1003 (concat " in " (buffer-name buffer))
1005 ;; Read the argument, offering that number (if any) as default.
1006 (list (read-number (format "Goto line%s: " buffer-prompt)
1007 (list default (line-number-at-pos)))
1009 ;; Switch to the desired buffer, one way or another.
1011 (let ((window (get-buffer-window buffer)))
1012 (if window (select-window window)
1013 (switch-to-buffer-other-window buffer))))
1014 ;; Leave mark at previous position
1015 (or (region-active-p) (push-mark))
1016 ;; Move to the specified line number in that buffer.
1019 (goto-char (point-min))
1020 (if (eq selective-display t)
1021 (re-search-forward "[\n\C-m]" nil 'end (1- line))
1022 (forward-line (1- line)))))
1024 (defun count-words-region (start end &optional arg)
1025 "Count the number of words in the region.
1026 If called interactively, print a message reporting the number of
1027 lines, words, and characters in the region (whether or not the
1028 region is active); with prefix ARG, report for the entire buffer
1029 rather than the region.
1031 If called from Lisp, return the number of words between positions
1033 (interactive (if current-prefix-arg
1034 (list nil nil current-prefix-arg)
1035 (list (region-beginning) (region-end) nil)))
1036 (cond ((not (called-interactively-p 'any))
1037 (count-words start end))
1039 (count-words--buffer-message))
1041 (count-words--message "Region" start end))))
1043 (defun count-words (start end)
1044 "Count words between START and END.
1045 If called interactively, START and END are normally the start and
1046 end of the buffer; but if the region is active, START and END are
1047 the start and end of the region. Print a message reporting the
1048 number of lines, words, and chars.
1050 If called from Lisp, return the number of words between START and
1051 END, without printing any message."
1052 (interactive (list nil nil))
1053 (cond ((not (called-interactively-p 'any))
1057 (narrow-to-region start end)
1058 (goto-char (point-min))
1059 (while (forward-word 1)
1060 (setq words (1+ words)))))
1063 (call-interactively 'count-words-region))
1065 (count-words--buffer-message))))
1067 (defun count-words--buffer-message ()
1068 (count-words--message
1069 (if (buffer-narrowed-p) "Narrowed part of buffer" "Buffer")
1070 (point-min) (point-max)))
1072 (defun count-words--message (str start end)
1073 (let ((lines (count-lines start end))
1074 (words (count-words start end))
1075 (chars (- end start)))
1076 (message "%s has %d line%s, %d word%s, and %d character%s."
1078 lines (if (= lines 1) "" "s")
1079 words (if (= words 1) "" "s")
1080 chars (if (= chars 1) "" "s"))))
1082 (define-obsolete-function-alias 'count-lines-region 'count-words-region "24.1")
1085 "Print the current buffer line number and narrowed line number of point."
1087 (let ((start (point-min))
1088 (n (line-number-at-pos)))
1090 (message "Line %d" n)
1094 (message "line %d (narrowed line %d)"
1095 (+ n (line-number-at-pos start) -1) n))))))
1097 (defun count-lines (start end)
1098 "Return number of lines between START and END.
1099 This is usually the number of newlines between them,
1100 but can be one more if START is not equal to END
1101 and the greater of them is not at the start of a line."
1104 (narrow-to-region start end)
1105 (goto-char (point-min))
1106 (if (eq selective-display t)
1109 (while (re-search-forward "[\n\C-m]" nil t 40)
1110 (setq done (+ 40 done)))
1111 (while (re-search-forward "[\n\C-m]" nil t 1)
1112 (setq done (+ 1 done)))
1113 (goto-char (point-max))
1114 (if (and (/= start end)
1118 (- (buffer-size) (forward-line (buffer-size)))))))
1120 (defun line-number-at-pos (&optional pos)
1121 "Return (narrowed) buffer line number at position POS.
1122 If POS is nil, use current buffer location.
1123 Counting starts at (point-min), so the value refers
1124 to the contents of the accessible portion of the buffer."
1125 (let ((opoint (or pos (point))) start)
1127 (goto-char (point-min))
1128 (setq start (point))
1131 (1+ (count-lines start (point))))))
1133 (defun what-cursor-position (&optional detail)
1134 "Print info on cursor position (on screen and within buffer).
1135 Also describe the character after point, and give its character code
1136 in octal, decimal and hex.
1138 For a non-ASCII multibyte character, also give its encoding in the
1139 buffer's selected coding system if the coding system encodes the
1140 character safely. If the character is encoded into one byte, that
1141 code is shown in hex. If the character is encoded into more than one
1142 byte, just \"...\" is shown.
1144 In addition, with prefix argument, show details about that character
1145 in *Help* buffer. See also the command `describe-char'."
1147 (let* ((char (following-char))
1149 (cond ((memq char '(?\x202a ?\x202b ?\x202d ?\x202e))
1150 ;; If the character is one of LRE, LRO, RLE, RLO, it
1151 ;; will start a directional embedding, which could
1152 ;; completely disrupt the rest of the line (e.g., RLO
1153 ;; will display the rest of the line right-to-left).
1154 ;; So we put an invisible PDF character after these
1155 ;; characters, to end the embedding, which eliminates
1156 ;; any effects on the rest of the line.
1157 (propertize (string ?\x202c) 'invisible t))
1158 ;; Strong right-to-left characters cause reordering of
1159 ;; the following numerical characters which show the
1160 ;; codepoint, so append LRM to countermand that.
1161 ((memq (get-char-code-property char 'bidi-class) '(R AL))
1162 (propertize (string ?\x200e) 'invisible t))
1168 (total (buffer-size))
1169 (percent (if (> total 50000)
1170 ;; Avoid overflow from multiplying by 100!
1171 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
1172 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
1173 (hscroll (if (= (window-hscroll) 0)
1175 (format " Hscroll=%d" (window-hscroll))))
1176 (col (current-column)))
1178 (if (or (/= beg 1) (/= end (1+ total)))
1179 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
1180 pos total percent beg end col hscroll)
1181 (message "point=%d of %d (EOB) column=%d%s"
1182 pos total col hscroll))
1183 (let ((coding buffer-file-coding-system)
1184 encoded encoding-msg display-prop under-display)
1185 (if (or (not coding)
1186 (eq (coding-system-type coding) t))
1187 (setq coding (default-value 'buffer-file-coding-system)))
1188 (if (eq (char-charset char) 'eight-bit)
1190 (format "(%d, #o%o, #x%x, raw-byte)" char char char))
1191 ;; Check if the character is displayed with some `display'
1192 ;; text property. In that case, set under-display to the
1193 ;; buffer substring covered by that property.
1194 (setq display-prop (get-char-property pos 'display))
1196 (let ((to (or (next-single-char-property-change pos 'display)
1198 (if (< to (+ pos 4))
1199 (setq under-display "")
1200 (setq under-display "..."
1203 (concat (buffer-substring-no-properties pos to)
1205 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
1208 (if (not (stringp display-prop))
1209 (format "(%d, #o%o, #x%x, part of display \"%s\")"
1210 char char char under-display)
1211 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
1212 char char char under-display display-prop))
1214 (format "(%d, #o%o, #x%x, file %s)"
1216 (if (> (length encoded) 1)
1218 (encoded-string-description encoded coding)))
1219 (format "(%d, #o%o, #x%x)" char char char)))))
1221 ;; We show the detailed information about CHAR.
1222 (describe-char (point)))
1223 (if (or (/= beg 1) (/= end (1+ total)))
1224 (message "Char: %s%s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
1226 (single-key-description char)
1227 (buffer-substring-no-properties (point) (1+ (point))))
1229 encoding-msg pos total percent beg end col hscroll)
1230 (message "Char: %s%s %s point=%d of %d (%d%%) column=%d%s"
1231 (if enable-multibyte-characters
1233 (single-key-description char)
1234 (buffer-substring-no-properties (point) (1+ (point))))
1235 (single-key-description char))
1236 bidi-fixer encoding-msg pos total percent col hscroll))))))
1238 ;; Initialize read-expression-map. It is defined at C level.
1239 (let ((m (make-sparse-keymap)))
1240 (define-key m "\M-\t" 'lisp-complete-symbol)
1241 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1242 ;; too rarely useful.
1243 (define-key m "\t" 'lisp-complete-symbol)
1244 (set-keymap-parent m minibuffer-local-map)
1245 (setq read-expression-map m))
1247 (defvar minibuffer-completing-symbol nil
1248 "Non-nil means completing a Lisp symbol in the minibuffer.")
1249 (make-obsolete-variable 'minibuffer-completing-symbol nil "24.1" 'get)
1251 (defvar minibuffer-default nil
1252 "The current default value or list of default values in the minibuffer.
1253 The functions `read-from-minibuffer' and `completing-read' bind
1254 this variable locally.")
1256 (defcustom eval-expression-print-level 4
1257 "Value for `print-level' while printing value in `eval-expression'.
1258 A value of nil means no limit."
1260 :type '(choice (const :tag "No Limit" nil) integer)
1263 (defcustom eval-expression-print-length 12
1264 "Value for `print-length' while printing value in `eval-expression'.
1265 A value of nil means no limit."
1267 :type '(choice (const :tag "No Limit" nil) integer)
1270 (defcustom eval-expression-debug-on-error t
1271 "If non-nil set `debug-on-error' to t in `eval-expression'.
1272 If nil, don't change the value of `debug-on-error'."
1277 (defun eval-expression-print-format (value)
1278 "Format VALUE as a result of evaluated expression.
1279 Return a formatted string which is displayed in the echo area
1280 in addition to the value printed by prin1 in functions which
1281 display the result of expression evaluation."
1282 (if (and (integerp value)
1283 (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp)))
1284 (eq this-command last-command)
1285 (if (boundp 'edebug-active) edebug-active)))
1287 (if (or (if (boundp 'edebug-active) edebug-active)
1288 (memq this-command '(eval-last-sexp eval-print-last-sexp)))
1289 (prin1-char value))))
1291 (format " (#o%o, #x%x, %s)" value value char-string)
1292 (format " (#o%o, #x%x)" value value)))))
1294 ;; We define this, rather than making `eval' interactive,
1295 ;; for the sake of completion of names like eval-region, eval-buffer.
1296 (defun eval-expression (exp &optional insert-value)
1297 "Evaluate EXP and print value in the echo area.
1298 When called interactively, read an Emacs Lisp expression and
1300 Value is also consed on to front of the variable `values'.
1301 Optional argument INSERT-VALUE non-nil (interactively,
1302 with prefix argument) means insert the result into the current buffer
1303 instead of printing it in the echo area. Truncates long output
1304 according to the value of the variables `eval-expression-print-length'
1305 and `eval-expression-print-level'.
1307 If `eval-expression-debug-on-error' is non-nil, which is the default,
1308 this command arranges for all errors to enter the debugger."
1310 (list (let ((minibuffer-completing-symbol t))
1311 (read-from-minibuffer "Eval: "
1312 nil read-expression-map t
1313 'read-expression-history))
1314 current-prefix-arg))
1316 (if (null eval-expression-debug-on-error)
1317 (push (eval exp lexical-binding) values)
1318 (let ((old-value (make-symbol "t")) new-value)
1319 ;; Bind debug-on-error to something unique so that we can
1320 ;; detect when evalled code changes it.
1321 (let ((debug-on-error old-value))
1322 (push (eval exp lexical-binding) values)
1323 (setq new-value debug-on-error))
1324 ;; If evalled code has changed the value of debug-on-error,
1325 ;; propagate that change to the global binding.
1326 (unless (eq old-value new-value)
1327 (setq debug-on-error new-value))))
1329 (let ((print-length eval-expression-print-length)
1330 (print-level eval-expression-print-level)
1334 (let ((standard-output (current-buffer)))
1335 (prin1 (car values))))
1337 (prin1 (car values) t)
1338 (let ((str (eval-expression-print-format (car values))))
1339 (if str (princ str t)))))))
1341 (defun edit-and-eval-command (prompt command)
1342 "Prompting with PROMPT, let user edit COMMAND and eval result.
1343 COMMAND is a Lisp expression. Let user edit that expression in
1344 the minibuffer, then read and evaluate the result."
1346 (let ((print-level nil)
1347 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1349 (read-from-minibuffer prompt
1350 (prin1-to-string command)
1351 read-expression-map t
1353 ;; If command was added to command-history as a string,
1354 ;; get rid of that. We want only evaluable expressions there.
1355 (if (stringp (car command-history))
1356 (setq command-history (cdr command-history)))))))
1358 ;; If command to be redone does not match front of history,
1359 ;; add it to the history.
1360 (or (equal command (car command-history))
1361 (setq command-history (cons command command-history)))
1364 (defun repeat-complex-command (arg)
1365 "Edit and re-evaluate last complex command, or ARGth from last.
1366 A complex command is one which used the minibuffer.
1367 The command is placed in the minibuffer as a Lisp form for editing.
1368 The result is executed, repeating the command as changed.
1369 If the command has been changed or is not the most recent previous
1370 command it is added to the front of the command history.
1371 You can use the minibuffer history commands \
1372 \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1373 to get different commands to edit and resubmit."
1375 (let ((elt (nth (1- arg) command-history))
1380 (let ((print-level nil)
1381 (minibuffer-history-position arg)
1382 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1384 (read-from-minibuffer
1385 "Redo: " (prin1-to-string elt) read-expression-map t
1386 (cons 'command-history arg))
1388 ;; If command was added to command-history as a
1389 ;; string, get rid of that. We want only
1390 ;; evaluable expressions there.
1391 (if (stringp (car command-history))
1392 (setq command-history (cdr command-history))))))
1394 ;; If command to be redone does not match front of history,
1395 ;; add it to the history.
1396 (or (equal newcmd (car command-history))
1397 (setq command-history (cons newcmd command-history)))
1400 (error "Argument %d is beyond length of command history" arg)
1401 (error "There are no previous complex commands to repeat")))))
1403 (defun read-extended-command ()
1404 "Read command name to invoke in `execute-extended-command'."
1405 (minibuffer-with-setup-hook
1407 (set (make-local-variable 'minibuffer-default-add-function)
1409 ;; Get a command name at point in the original buffer
1410 ;; to propose it after M-n.
1411 (with-current-buffer (window-buffer (minibuffer-selected-window))
1412 (and (commandp (function-called-at-point))
1413 (format "%S" (function-called-at-point)))))))
1414 ;; Read a string, completing from and restricting to the set of
1415 ;; all defined commands. Don't provide any initial input.
1416 ;; Save the command read on the extended-command history list.
1419 ((eq current-prefix-arg '-) "- ")
1420 ((and (consp current-prefix-arg)
1421 (eq (car current-prefix-arg) 4)) "C-u ")
1422 ((and (consp current-prefix-arg)
1423 (integerp (car current-prefix-arg)))
1424 (format "%d " (car current-prefix-arg)))
1425 ((integerp current-prefix-arg)
1426 (format "%d " current-prefix-arg)))
1427 ;; This isn't strictly correct if `execute-extended-command'
1428 ;; is bound to anything else (e.g. [menu]).
1429 ;; It could use (key-description (this-single-command-keys)),
1430 ;; but actually a prompt other than "M-x" would be confusing,
1431 ;; because "M-x" is a well-known prompt to read a command
1432 ;; and it serves as a shorthand for "Extended command: ".
1434 obarray 'commandp t nil 'extended-command-history)))
1436 (defcustom suggest-key-bindings t
1437 "Non-nil means show the equivalent key-binding when M-x command has one.
1438 The value can be a length of time to show the message for.
1439 If the value is non-nil and not a number, we wait 2 seconds."
1441 :type '(choice (const :tag "off" nil)
1442 (integer :tag "time" 2)
1445 (defun execute-extended-command (prefixarg &optional command-name)
1446 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1447 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1448 "Read function name, then read its arguments and call it.
1450 To pass a numeric argument to the command you are invoking, specify
1451 the numeric argument to this command.
1453 Noninteractively, the argument PREFIXARG is the prefix argument to
1454 give to the command you invoke, if it asks for an argument."
1455 (interactive (list current-prefix-arg (read-extended-command)))
1456 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1457 (if (null command-name)
1458 (setq command-name (let ((current-prefix-arg prefixarg)) ; for prompt
1459 (read-extended-command))))
1460 (let* ((function (and (stringp command-name) (intern-soft command-name)))
1461 (binding (and suggest-key-bindings
1462 (not executing-kbd-macro)
1463 (where-is-internal function overriding-local-map t))))
1464 (unless (commandp function)
1465 (error "`%s' is not a valid command name" command-name))
1466 (setq this-command function)
1467 ;; Normally `real-this-command' should never be changed, but here we really
1468 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1469 ;; binding" for <cmd>, so the command the user really wanted to run is
1470 ;; `function' and not `execute-extended-command'. The difference is
1471 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1472 (setq real-this-command function)
1473 (let ((prefix-arg prefixarg))
1474 (command-execute function 'record))
1475 ;; If enabled, show which key runs this command.
1477 ;; But first wait, and skip the message if there is input.
1479 ;; If this command displayed something in the echo area;
1480 ;; wait a few seconds, then display our suggestion message.
1482 ((zerop (length (current-message))) 0)
1483 ((numberp suggest-key-bindings) suggest-key-bindings)
1485 (when (and waited (not (consp unread-command-events)))
1487 (format "You can run the command `%s' with %s"
1488 function (key-description binding))
1489 (sit-for (if (numberp suggest-key-bindings)
1490 suggest-key-bindings
1493 (defvar minibuffer-history nil
1494 "Default minibuffer history list.
1495 This is used for all minibuffer input
1496 except when an alternate history list is specified.
1498 Maximum length of the history list is determined by the value
1499 of `history-length', which see.")
1500 (defvar minibuffer-history-sexp-flag nil
1501 "Control whether history list elements are expressions or strings.
1502 If the value of this variable equals current minibuffer depth,
1503 they are expressions; otherwise they are strings.
1504 \(That convention is designed to do the right thing for
1505 recursive uses of the minibuffer.)")
1506 (setq minibuffer-history-variable 'minibuffer-history)
1507 (setq minibuffer-history-position nil) ;; Defvar is in C code.
1508 (defvar minibuffer-history-search-history nil)
1510 (defvar minibuffer-text-before-history nil
1511 "Text that was in this minibuffer before any history commands.
1512 This is nil if there have not yet been any history commands
1513 in this use of the minibuffer.")
1515 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1517 (defun minibuffer-history-initialize ()
1518 (setq minibuffer-text-before-history nil))
1520 (defun minibuffer-avoid-prompt (_new _old)
1521 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1522 (constrain-to-field nil (point-max)))
1524 (defcustom minibuffer-history-case-insensitive-variables nil
1525 "Minibuffer history variables for which matching should ignore case.
1526 If a history variable is a member of this list, then the
1527 \\[previous-matching-history-element] and \\[next-matching-history-element]\
1528 commands ignore case when searching it, regardless of `case-fold-search'."
1529 :type '(repeat variable)
1532 (defun previous-matching-history-element (regexp n)
1533 "Find the previous history element that matches REGEXP.
1534 \(Previous history elements refer to earlier actions.)
1535 With prefix argument N, search for Nth previous match.
1536 If N is negative, find the next or Nth next match.
1537 Normally, history elements are matched case-insensitively if
1538 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1539 makes the search case-sensitive.
1540 See also `minibuffer-history-case-insensitive-variables'."
1542 (let* ((enable-recursive-minibuffers t)
1543 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1545 minibuffer-local-map
1547 'minibuffer-history-search-history
1548 (car minibuffer-history-search-history))))
1549 ;; Use the last regexp specified, by default, if input is empty.
1550 (list (if (string= regexp "")
1551 (if minibuffer-history-search-history
1552 (car minibuffer-history-search-history)
1553 (user-error "No previous history search regexp"))
1555 (prefix-numeric-value current-prefix-arg))))
1557 (if (and (zerop minibuffer-history-position)
1558 (null minibuffer-text-before-history))
1559 (setq minibuffer-text-before-history
1560 (minibuffer-contents-no-properties)))
1561 (let ((history (symbol-value minibuffer-history-variable))
1563 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1564 ;; On some systems, ignore case for file names.
1565 (if (memq minibuffer-history-variable
1566 minibuffer-history-case-insensitive-variables)
1568 ;; Respect the user's setting for case-fold-search:
1574 (pos minibuffer-history-position))
1577 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1578 (when (= pos prevpos)
1579 (user-error (if (= pos 1)
1580 "No later matching history item"
1581 "No earlier matching history item")))
1583 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
1584 (let ((print-level nil))
1585 (prin1-to-string (nth (1- pos) history)))
1586 (nth (1- pos) history)))
1589 (and (string-match regexp match-string)
1591 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1592 (match-beginning 1))))
1594 (setq n (+ n (if (< n 0) 1 -1)))))
1595 (setq minibuffer-history-position pos)
1596 (goto-char (point-max))
1597 (delete-minibuffer-contents)
1598 (insert match-string)
1599 (goto-char (+ (minibuffer-prompt-end) match-offset))))
1600 (if (memq (car (car command-history)) '(previous-matching-history-element
1601 next-matching-history-element))
1602 (setq command-history (cdr command-history))))
1604 (defun next-matching-history-element (regexp n)
1605 "Find the next history element that matches REGEXP.
1606 \(The next history element refers to a more recent action.)
1607 With prefix argument N, search for Nth next match.
1608 If N is negative, find the previous or Nth previous match.
1609 Normally, history elements are matched case-insensitively if
1610 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1611 makes the search case-sensitive."
1613 (let* ((enable-recursive-minibuffers t)
1614 (regexp (read-from-minibuffer "Next element matching (regexp): "
1616 minibuffer-local-map
1618 'minibuffer-history-search-history
1619 (car minibuffer-history-search-history))))
1620 ;; Use the last regexp specified, by default, if input is empty.
1621 (list (if (string= regexp "")
1622 (if minibuffer-history-search-history
1623 (car minibuffer-history-search-history)
1624 (user-error "No previous history search regexp"))
1626 (prefix-numeric-value current-prefix-arg))))
1627 (previous-matching-history-element regexp (- n)))
1629 (defvar minibuffer-temporary-goal-position nil)
1631 (defvar minibuffer-default-add-function 'minibuffer-default-add-completions
1632 "Function run by `goto-history-element' before consuming default values.
1633 This is useful to dynamically add more elements to the list of default values
1634 when `goto-history-element' reaches the end of this list.
1635 Before calling this function `goto-history-element' sets the variable
1636 `minibuffer-default-add-done' to t, so it will call this function only
1637 once. In special cases, when this function needs to be called more
1638 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1639 overriding the setting of this variable to t in `goto-history-element'.")
1641 (defvar minibuffer-default-add-done nil
1642 "When nil, add more elements to the end of the list of default values.
1643 The value nil causes `goto-history-element' to add more elements to
1644 the list of defaults when it reaches the end of this list. It does
1645 this by calling a function defined by `minibuffer-default-add-function'.")
1647 (make-variable-buffer-local 'minibuffer-default-add-done)
1649 (defun minibuffer-default-add-completions ()
1650 "Return a list of all completions without the default value.
1651 This function is used to add all elements of the completion table to
1652 the end of the list of defaults just after the default value."
1653 (let ((def minibuffer-default)
1654 (all (all-completions ""
1655 minibuffer-completion-table
1656 minibuffer-completion-predicate)))
1659 (cons def (delete def all)))))
1661 (defun goto-history-element (nabs)
1662 "Puts element of the minibuffer history in the minibuffer.
1663 The argument NABS specifies the absolute history position."
1665 (when (and (not minibuffer-default-add-done)
1666 (functionp minibuffer-default-add-function)
1667 (< nabs (- (if (listp minibuffer-default)
1668 (length minibuffer-default)
1670 (setq minibuffer-default-add-done t
1671 minibuffer-default (funcall minibuffer-default-add-function)))
1672 (let ((minimum (if minibuffer-default
1673 (- (if (listp minibuffer-default)
1674 (length minibuffer-default)
1677 elt minibuffer-returned-to-present)
1678 (if (and (zerop minibuffer-history-position)
1679 (null minibuffer-text-before-history))
1680 (setq minibuffer-text-before-history
1681 (minibuffer-contents-no-properties)))
1682 (if (< nabs minimum)
1683 (user-error (if minibuffer-default
1684 "End of defaults; no next item"
1685 "End of history; no default available")))
1686 (if (> nabs (length (symbol-value minibuffer-history-variable)))
1687 (user-error "Beginning of history; no preceding item"))
1688 (unless (memq last-command '(next-history-element
1689 previous-history-element))
1690 (let ((prompt-end (minibuffer-prompt-end)))
1691 (set (make-local-variable 'minibuffer-temporary-goal-position)
1692 (cond ((<= (point) prompt-end) prompt-end)
1695 (goto-char (point-max))
1696 (delete-minibuffer-contents)
1697 (setq minibuffer-history-position nabs)
1699 (setq elt (if (listp minibuffer-default)
1700 (nth (1- (abs nabs)) minibuffer-default)
1701 minibuffer-default)))
1703 (setq elt (or minibuffer-text-before-history ""))
1704 (setq minibuffer-returned-to-present t)
1705 (setq minibuffer-text-before-history nil))
1706 (t (setq elt (nth (1- minibuffer-history-position)
1707 (symbol-value minibuffer-history-variable)))))
1709 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1710 (not minibuffer-returned-to-present))
1711 (let ((print-level nil))
1712 (prin1-to-string elt))
1714 (goto-char (or minibuffer-temporary-goal-position (point-max)))))
1716 (defun next-history-element (n)
1717 "Puts next element of the minibuffer history in the minibuffer.
1718 With argument N, it uses the Nth following element."
1721 (goto-history-element (- minibuffer-history-position n))))
1723 (defun previous-history-element (n)
1724 "Puts previous element of the minibuffer history in the minibuffer.
1725 With argument N, it uses the Nth previous element."
1728 (goto-history-element (+ minibuffer-history-position n))))
1730 (defun next-complete-history-element (n)
1731 "Get next history element which completes the minibuffer before the point.
1732 The contents of the minibuffer after the point are deleted, and replaced
1733 by the new completion."
1735 (let ((point-at-start (point)))
1736 (next-matching-history-element
1738 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
1740 ;; next-matching-history-element always puts us at (point-min).
1741 ;; Move to the position we were at before changing the buffer contents.
1742 ;; This is still sensible, because the text before point has not changed.
1743 (goto-char point-at-start)))
1745 (defun previous-complete-history-element (n)
1747 Get previous history element which completes the minibuffer before the point.
1748 The contents of the minibuffer after the point are deleted, and replaced
1749 by the new completion."
1751 (next-complete-history-element (- n)))
1753 ;; For compatibility with the old subr of the same name.
1754 (defun minibuffer-prompt-width ()
1755 "Return the display width of the minibuffer prompt.
1756 Return 0 if current buffer is not a minibuffer."
1757 ;; Return the width of everything before the field at the end of
1758 ;; the buffer; this should be 0 for normal buffers.
1759 (1- (minibuffer-prompt-end)))
1761 ;; isearch minibuffer history
1762 (add-hook 'minibuffer-setup-hook 'minibuffer-history-isearch-setup)
1764 (defvar minibuffer-history-isearch-message-overlay)
1765 (make-variable-buffer-local 'minibuffer-history-isearch-message-overlay)
1767 (defun minibuffer-history-isearch-setup ()
1768 "Set up a minibuffer for using isearch to search the minibuffer history.
1769 Intended to be added to `minibuffer-setup-hook'."
1770 (set (make-local-variable 'isearch-search-fun-function)
1771 'minibuffer-history-isearch-search)
1772 (set (make-local-variable 'isearch-message-function)
1773 'minibuffer-history-isearch-message)
1774 (set (make-local-variable 'isearch-wrap-function)
1775 'minibuffer-history-isearch-wrap)
1776 (set (make-local-variable 'isearch-push-state-function)
1777 'minibuffer-history-isearch-push-state)
1778 (add-hook 'isearch-mode-end-hook 'minibuffer-history-isearch-end nil t))
1780 (defun minibuffer-history-isearch-end ()
1781 "Clean up the minibuffer after terminating isearch in the minibuffer."
1782 (if minibuffer-history-isearch-message-overlay
1783 (delete-overlay minibuffer-history-isearch-message-overlay)))
1785 (defun minibuffer-history-isearch-search ()
1786 "Return the proper search function, for isearch in minibuffer history."
1787 (lambda (string bound noerror)
1789 ;; Use standard functions to search within minibuffer text
1790 (isearch-search-fun-default))
1792 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1793 ;; searching forward. Lazy-highlight calls this lambda with the
1794 ;; bound arg, so skip the minibuffer prompt.
1795 (if (and bound isearch-forward (< (point) (minibuffer-prompt-end)))
1796 (goto-char (minibuffer-prompt-end)))
1798 ;; 1. First try searching in the initial minibuffer text
1799 (funcall search-fun string
1800 (if isearch-forward bound (minibuffer-prompt-end))
1802 ;; 2. If the above search fails, start putting next/prev history
1803 ;; elements in the minibuffer successively, and search the string
1804 ;; in them. Do this only when bound is nil (i.e. not while
1805 ;; lazy-highlighting search strings in the current minibuffer text).
1810 (cond (isearch-forward
1811 (next-history-element 1)
1812 (goto-char (minibuffer-prompt-end)))
1814 (previous-history-element 1)
1815 (goto-char (point-max))))
1816 (setq isearch-barrier (point) isearch-opoint (point))
1817 ;; After putting the next/prev history element, search
1818 ;; the string in them again, until next-history-element
1819 ;; or previous-history-element raises an error at the
1820 ;; beginning/end of history.
1821 (setq found (funcall search-fun string
1822 (unless isearch-forward
1823 ;; For backward search, don't search
1824 ;; in the minibuffer prompt
1825 (minibuffer-prompt-end))
1827 ;; Return point of the new search result
1829 ;; Return nil when next(prev)-history-element fails
1832 (defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis)
1833 "Display the minibuffer history search prompt.
1834 If there are no search errors, this function displays an overlay with
1835 the isearch prompt which replaces the original minibuffer prompt.
1836 Otherwise, it displays the standard isearch message returned from
1837 the function `isearch-message'."
1838 (if (not (and (minibufferp) isearch-success (not isearch-error)))
1839 ;; Use standard function `isearch-message' when not in the minibuffer,
1840 ;; or search fails, or has an error (like incomplete regexp).
1841 ;; This function overwrites minibuffer text with isearch message,
1842 ;; so it's possible to see what is wrong in the search string.
1843 (isearch-message c-q-hack ellipsis)
1844 ;; Otherwise, put the overlay with the standard isearch prompt over
1845 ;; the initial minibuffer prompt.
1846 (if (overlayp minibuffer-history-isearch-message-overlay)
1847 (move-overlay minibuffer-history-isearch-message-overlay
1848 (point-min) (minibuffer-prompt-end))
1849 (setq minibuffer-history-isearch-message-overlay
1850 (make-overlay (point-min) (minibuffer-prompt-end)))
1851 (overlay-put minibuffer-history-isearch-message-overlay 'evaporate t))
1852 (overlay-put minibuffer-history-isearch-message-overlay
1853 'display (isearch-message-prefix c-q-hack ellipsis))
1854 ;; And clear any previous isearch message.
1857 (defun minibuffer-history-isearch-wrap ()
1858 "Wrap the minibuffer history search when search fails.
1859 Move point to the first history element for a forward search,
1860 or to the last history element for a backward search."
1861 ;; When `minibuffer-history-isearch-search' fails on reaching the
1862 ;; beginning/end of the history, wrap the search to the first/last
1863 ;; minibuffer history element.
1865 (goto-history-element (length (symbol-value minibuffer-history-variable)))
1866 (goto-history-element 0))
1867 (setq isearch-success t)
1868 (goto-char (if isearch-forward (minibuffer-prompt-end) (point-max))))
1870 (defun minibuffer-history-isearch-push-state ()
1871 "Save a function restoring the state of minibuffer history search.
1872 Save `minibuffer-history-position' to the additional state parameter
1873 in the search status stack."
1874 (let ((pos minibuffer-history-position))
1876 (minibuffer-history-isearch-pop-state cmd pos))))
1878 (defun minibuffer-history-isearch-pop-state (_cmd hist-pos)
1879 "Restore the minibuffer history search state.
1880 Go to the history element by the absolute history position HIST-POS."
1881 (goto-history-element hist-pos))
1884 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1885 (define-obsolete-function-alias 'advertised-undo 'undo "23.2")
1887 (defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
1888 "Table mapping redo records to the corresponding undo one.
1889 A redo record for undo-in-region maps to t.
1890 A redo record for ordinary undo maps to the following (earlier) undo.")
1892 (defvar undo-in-region nil
1893 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
1895 (defvar undo-no-redo nil
1896 "If t, `undo' doesn't go through redo entries.")
1898 (defvar pending-undo-list nil
1899 "Within a run of consecutive undo commands, list remaining to be undone.
1900 If t, we undid all the way to the end of it.")
1902 (defun undo (&optional arg)
1903 "Undo some previous changes.
1904 Repeat this command to undo more changes.
1905 A numeric ARG serves as a repeat count.
1907 In Transient Mark mode when the mark is active, only undo changes within
1908 the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
1909 as an argument limits undo to changes within the current region."
1911 ;; Make last-command indicate for the next command that this was an undo.
1912 ;; That way, another undo will undo more.
1913 ;; If we get to the end of the undo history and get an error,
1914 ;; another undo command will find the undo history empty
1915 ;; and will get another error. To begin undoing the undos,
1916 ;; you must type some other command.
1917 (let* ((modified (buffer-modified-p))
1918 ;; For an indirect buffer, look in the base buffer for the
1920 (base-buffer (or (buffer-base-buffer) (current-buffer)))
1921 (recent-save (with-current-buffer base-buffer
1922 (recent-auto-save-p)))
1924 ;; If we get an error in undo-start,
1925 ;; the next command should not be a "consecutive undo".
1926 ;; So set `this-command' to something other than `undo'.
1927 (setq this-command 'undo-start)
1929 (unless (and (eq last-command 'undo)
1930 (or (eq pending-undo-list t)
1931 ;; If something (a timer or filter?) changed the buffer
1932 ;; since the previous command, don't continue the undo seq.
1933 (let ((list buffer-undo-list))
1934 (while (eq (car list) nil)
1935 (setq list (cdr list)))
1936 ;; If the last undo record made was made by undo
1937 ;; it shows nothing else happened in between.
1938 (gethash list undo-equiv-table))))
1939 (setq undo-in-region
1940 (or (region-active-p) (and arg (not (numberp arg)))))
1942 (undo-start (region-beginning) (region-end))
1944 ;; get rid of initial undo boundary
1946 ;; If we got this far, the next command should be a consecutive undo.
1947 (setq this-command 'undo)
1948 ;; Check to see whether we're hitting a redo record, and if
1949 ;; so, ask the user whether she wants to skip the redo/undo pair.
1950 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
1951 (or (eq (selected-window) (minibuffer-window))
1952 (setq message (format "%s%s!"
1953 (if (or undo-no-redo (not equiv))
1955 (if undo-in-region " in region" ""))))
1956 (when (and (consp equiv) undo-no-redo)
1957 ;; The equiv entry might point to another redo record if we have done
1958 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1959 (while (let ((next (gethash equiv undo-equiv-table)))
1960 (if next (setq equiv next))))
1961 (setq pending-undo-list equiv)))
1964 (prefix-numeric-value arg)
1966 ;; Record the fact that the just-generated undo records come from an
1967 ;; undo operation--that is, they are redo records.
1968 ;; In the ordinary case (not within a region), map the redo
1969 ;; record to the following undos.
1970 ;; I don't know how to do that in the undo-in-region case.
1971 (let ((list buffer-undo-list))
1972 ;; Strip any leading undo boundaries there might be, like we do
1973 ;; above when checking.
1974 (while (eq (car list) nil)
1975 (setq list (cdr list)))
1976 (puthash list (if undo-in-region t pending-undo-list)
1978 ;; Don't specify a position in the undo record for the undo command.
1979 ;; Instead, undoing this should move point to where the change is.
1980 (let ((tail buffer-undo-list)
1983 (when (integerp (car tail))
1984 (let ((pos (car tail)))
1986 (setcdr prev (cdr tail))
1987 (setq buffer-undo-list (cdr tail)))
1988 (setq tail (cdr tail))
1990 (if (eq pos (car tail))
1992 (setcdr prev (cdr tail))
1993 (setq buffer-undo-list (cdr tail)))
1995 (setq tail (cdr tail)))
1997 (setq prev tail tail (cdr tail))))
1998 ;; Record what the current undo list says,
1999 ;; so the next command can tell if the buffer was modified in between.
2000 (and modified (not (buffer-modified-p))
2001 (with-current-buffer base-buffer
2002 (delete-auto-save-file-if-necessary recent-save)))
2003 ;; Display a message announcing success.
2005 (message "%s" message))))
2007 (defun buffer-disable-undo (&optional buffer)
2008 "Make BUFFER stop keeping undo information.
2009 No argument or nil as argument means do this for the current buffer."
2011 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
2012 (setq buffer-undo-list t)))
2014 (defun undo-only (&optional arg)
2015 "Undo some previous changes.
2016 Repeat this command to undo more changes.
2017 A numeric ARG serves as a repeat count.
2018 Contrary to `undo', this will not redo a previous undo."
2020 (let ((undo-no-redo t)) (undo arg)))
2022 (defvar undo-in-progress nil
2023 "Non-nil while performing an undo.
2024 Some change-hooks test this variable to do something different.")
2026 (defun undo-more (n)
2027 "Undo back N undo-boundaries beyond what was already undone recently.
2028 Call `undo-start' to get ready to undo recent changes,
2029 then call `undo-more' one or more times to undo them."
2030 (or (listp pending-undo-list)
2031 (user-error (concat "No further undo information"
2032 (and undo-in-region " for region"))))
2033 (let ((undo-in-progress t))
2034 ;; Note: The following, while pulling elements off
2035 ;; `pending-undo-list' will call primitive change functions which
2036 ;; will push more elements onto `buffer-undo-list'.
2037 (setq pending-undo-list (primitive-undo n pending-undo-list))
2038 (if (null pending-undo-list)
2039 (setq pending-undo-list t))))
2041 (defun primitive-undo (n list)
2042 "Undo N records from the front of the list LIST.
2043 Return what remains of the list."
2045 ;; This is a good feature, but would make undo-start
2046 ;; unable to do what is expected.
2047 ;;(when (null (car (list)))
2048 ;; ;; If the head of the list is a boundary, it is the boundary
2049 ;; ;; preceding this command. Get rid of it and don't count it.
2050 ;; (setq list (cdr list))))
2053 ;; In a writable buffer, enable undoing read-only text that is
2054 ;; so because of text properties.
2055 (inhibit-read-only t)
2056 ;; Don't let `intangible' properties interfere with undo.
2057 (inhibit-point-motion-hooks t)
2058 ;; We use oldlist only to check for EQ. ++kfs
2059 (oldlist buffer-undo-list)
2063 (while (setq next (pop list)) ;Exit inner loop at undo boundary.
2064 ;; Handle an integer by setting point to that value.
2066 ((pred integerp) (goto-char next))
2067 ;; Element (t . TIME) records previous modtime.
2068 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2069 ;; UNKNOWN_MODTIME_NSECS.
2071 ;; If this records an obsolete save
2072 ;; (not matching the actual disk file)
2073 ;; then don't mark unmodified.
2074 (when (or (equal time (visited-file-modtime))
2076 (equal (list (car time) (cdr time))
2077 (visited-file-modtime))))
2078 (when (fboundp 'unlock-buffer)
2080 (set-buffer-modified-p nil)))
2081 ;; Element (nil PROP VAL BEG . END) is property change.
2082 (`(nil . ,(or `(,prop ,val ,beg . ,end) pcase--dontcare))
2083 (when (or (> (point-min) beg) (< (point-max) end))
2084 (error "Changes to be undone are outside visible portion of buffer"))
2085 (put-text-property beg end prop val))
2086 ;; Element (BEG . END) means range was inserted.
2087 (`(,(and beg (pred integerp)) . ,(and end (pred integerp)))
2088 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2089 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2090 (when (or (> (point-min) beg) (< (point-max) end))
2091 (error "Changes to be undone are outside visible portion of buffer"))
2092 ;; Set point first thing, so that undoing this undo
2093 ;; does not send point back to where it is now.
2095 (delete-region beg end))
2096 ;; Element (apply FUN . ARGS) means call FUN to undo.
2097 (`(apply . ,fun-args)
2098 (let ((currbuff (current-buffer)))
2099 (if (integerp (car fun-args))
2100 ;; Long format: (apply DELTA START END FUN . ARGS).
2101 (pcase-let* ((`(,delta ,start ,end ,fun . ,args) fun-args)
2102 (start-mark (copy-marker start nil))
2103 (end-mark (copy-marker end t)))
2104 (when (or (> (point-min) start) (< (point-max) end))
2105 (error "Changes to be undone are outside visible portion of buffer"))
2106 (apply fun args) ;; Use `save-current-buffer'?
2107 ;; Check that the function did what the entry
2108 ;; said it would do.
2109 (unless (and (= start start-mark)
2110 (= (+ delta end) end-mark))
2111 (error "Changes to be undone by function different than announced"))
2112 (set-marker start-mark nil)
2113 (set-marker end-mark nil))
2115 (unless (eq currbuff (current-buffer))
2116 (error "Undo function switched buffer"))
2117 (setq did-apply t)))
2118 ;; Element (STRING . POS) means STRING was deleted.
2119 (`(,(and string (pred stringp)) . ,(and pos (pred integerp)))
2120 (when (let ((apos (abs pos)))
2121 (or (< apos (point-min)) (> apos (point-max))))
2122 (error "Changes to be undone are outside visible portion of buffer"))
2128 ;; Now that we record marker adjustments
2129 ;; (caused by deletion) for undo,
2130 ;; we should always insert after markers,
2131 ;; so that undoing the marker adjustments
2132 ;; put the markers back in the right place.
2135 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2136 (`(,(and marker (pred markerp)) . ,(and offset (pred integerp)))
2137 (when (marker-buffer marker)
2140 (marker-buffer marker))))
2141 (_ (error "Unrecognized entry in undo list %S" next))))
2142 (setq arg (1- arg)))
2143 ;; Make sure an apply entry produces at least one undo entry,
2144 ;; so the test in `undo' for continuing an undo series
2147 (eq oldlist buffer-undo-list))
2148 (setq buffer-undo-list
2149 (cons (list 'apply 'cdr nil) buffer-undo-list))))
2152 ;; Deep copy of a list
2153 (defun undo-copy-list (list)
2154 "Make a copy of undo list LIST."
2155 (mapcar 'undo-copy-list-1 list))
2157 (defun undo-copy-list-1 (elt)
2159 (cons (car elt) (undo-copy-list-1 (cdr elt)))
2162 (defun undo-start (&optional beg end)
2163 "Set `pending-undo-list' to the front of the undo list.
2164 The next call to `undo-more' will undo the most recently made change.
2165 If BEG and END are specified, then only undo elements
2166 that apply to text between BEG and END are used; other undo elements
2167 are ignored. If BEG and END are nil, all undo elements are used."
2168 (if (eq buffer-undo-list t)
2169 (user-error "No undo information in this buffer"))
2170 (setq pending-undo-list
2171 (if (and beg end (not (= beg end)))
2172 (undo-make-selective-list (min beg end) (max beg end))
2175 (defvar undo-adjusted-markers)
2177 (defun undo-make-selective-list (start end)
2178 "Return a list of undo elements for the region START to END.
2179 The elements come from `buffer-undo-list', but we keep only
2180 the elements inside this region, and discard those outside this region.
2181 If we find an element that crosses an edge of this region,
2182 we stop and ignore all further elements."
2183 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
2184 (undo-list (list nil))
2185 undo-adjusted-markers
2187 undo-elt temp-undo-list delta)
2188 (while undo-list-copy
2189 (setq undo-elt (car undo-list-copy))
2191 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
2192 ;; This is a "was unmodified" element.
2193 ;; Keep it if we have kept everything thus far.
2194 (not some-rejected))
2196 (undo-elt-in-region undo-elt start end)))))
2199 (setq end (+ end (cdr (undo-delta undo-elt))))
2200 ;; Don't put two nils together in the list
2201 (if (not (and (eq (car undo-list) nil)
2203 (setq undo-list (cons undo-elt undo-list))))
2204 (if (undo-elt-crosses-region undo-elt start end)
2205 (setq undo-list-copy nil)
2206 (setq some-rejected t)
2207 (setq temp-undo-list (cdr undo-list-copy))
2208 (setq delta (undo-delta undo-elt))
2210 (when (/= (cdr delta) 0)
2211 (let ((position (car delta))
2212 (offset (cdr delta)))
2214 ;; Loop down the earlier events adjusting their buffer
2215 ;; positions to reflect the fact that a change to the buffer
2216 ;; isn't being undone. We only need to process those element
2217 ;; types which undo-elt-in-region will return as being in
2218 ;; the region since only those types can ever get into the
2221 (while temp-undo-list
2222 (setq undo-elt (car temp-undo-list))
2223 (cond ((integerp undo-elt)
2224 (if (>= undo-elt position)
2225 (setcar temp-undo-list (- undo-elt offset))))
2226 ((atom undo-elt) nil)
2227 ((stringp (car undo-elt))
2228 ;; (TEXT . POSITION)
2229 (let ((text-pos (abs (cdr undo-elt)))
2230 (point-at-end (< (cdr undo-elt) 0 )))
2231 (if (>= text-pos position)
2232 (setcdr undo-elt (* (if point-at-end -1 1)
2233 (- text-pos offset))))))
2234 ((integerp (car undo-elt))
2236 (when (>= (car undo-elt) position)
2237 (setcar undo-elt (- (car undo-elt) offset))
2238 (setcdr undo-elt (- (cdr undo-elt) offset))))
2239 ((null (car undo-elt))
2240 ;; (nil PROPERTY VALUE BEG . END)
2241 (let ((tail (nthcdr 3 undo-elt)))
2242 (when (>= (car tail) position)
2243 (setcar tail (- (car tail) offset))
2244 (setcdr tail (- (cdr tail) offset))))))
2245 (setq temp-undo-list (cdr temp-undo-list))))))))
2246 (setq undo-list-copy (cdr undo-list-copy)))
2247 (nreverse undo-list)))
2249 (defun undo-elt-in-region (undo-elt start end)
2250 "Determine whether UNDO-ELT falls inside the region START ... END.
2251 If it crosses the edge, we return nil."
2252 (cond ((integerp undo-elt)
2253 (and (>= undo-elt start)
2259 ((stringp (car undo-elt))
2260 ;; (TEXT . POSITION)
2261 (and (>= (abs (cdr undo-elt)) start)
2262 (< (abs (cdr undo-elt)) end)))
2263 ((and (consp undo-elt) (markerp (car undo-elt)))
2264 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2265 ;; See if MARKER is inside the region.
2266 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
2268 (setq alist-elt (cons (car undo-elt)
2269 (marker-position (car undo-elt))))
2270 (setq undo-adjusted-markers
2271 (cons alist-elt undo-adjusted-markers)))
2272 (and (cdr alist-elt)
2273 (>= (cdr alist-elt) start)
2274 (<= (cdr alist-elt) end))))
2275 ((null (car undo-elt))
2276 ;; (nil PROPERTY VALUE BEG . END)
2277 (let ((tail (nthcdr 3 undo-elt)))
2278 (and (>= (car tail) start)
2279 (<= (cdr tail) end))))
2280 ((integerp (car undo-elt))
2282 (and (>= (car undo-elt) start)
2283 (<= (cdr undo-elt) end)))))
2285 (defun undo-elt-crosses-region (undo-elt start end)
2286 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2287 This assumes we have already decided that UNDO-ELT
2288 is not *inside* the region START...END."
2289 (cond ((atom undo-elt) nil)
2290 ((null (car undo-elt))
2291 ;; (nil PROPERTY VALUE BEG . END)
2292 (let ((tail (nthcdr 3 undo-elt)))
2293 (and (< (car tail) end)
2294 (> (cdr tail) start))))
2295 ((integerp (car undo-elt))
2297 (and (< (car undo-elt) end)
2298 (> (cdr undo-elt) start)))))
2300 ;; Return the first affected buffer position and the delta for an undo element
2301 ;; delta is defined as the change in subsequent buffer positions if we *did*
2303 (defun undo-delta (undo-elt)
2304 (if (consp undo-elt)
2305 (cond ((stringp (car undo-elt))
2306 ;; (TEXT . POSITION)
2307 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
2308 ((integerp (car undo-elt))
2310 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
2315 (defcustom undo-ask-before-discard nil
2316 "If non-nil ask about discarding undo info for the current command.
2317 Normally, Emacs discards the undo info for the current command if
2318 it exceeds `undo-outer-limit'. But if you set this option
2319 non-nil, it asks in the echo area whether to discard the info.
2320 If you answer no, there is a slight risk that Emacs might crash, so
2321 only do it if you really want to undo the command.
2323 This option is mainly intended for debugging. You have to be
2324 careful if you use it for other purposes. Garbage collection is
2325 inhibited while the question is asked, meaning that Emacs might
2326 leak memory. So you should make sure that you do not wait
2327 excessively long before answering the question."
2332 (defvar undo-extra-outer-limit nil
2333 "If non-nil, an extra level of size that's ok in an undo item.
2334 We don't ask the user about truncating the undo list until the
2335 current item gets bigger than this amount.
2337 This variable only matters if `undo-ask-before-discard' is non-nil.")
2338 (make-variable-buffer-local 'undo-extra-outer-limit)
2340 ;; When the first undo batch in an undo list is longer than
2341 ;; undo-outer-limit, this function gets called to warn the user that
2342 ;; the undo info for the current command was discarded. Garbage
2343 ;; collection is inhibited around the call, so it had better not do a
2345 (setq undo-outer-limit-function 'undo-outer-limit-truncate)
2346 (defun undo-outer-limit-truncate (size)
2347 (if undo-ask-before-discard
2348 (when (or (null undo-extra-outer-limit)
2349 (> size undo-extra-outer-limit))
2350 ;; Don't ask the question again unless it gets even bigger.
2351 ;; This applies, in particular, if the user quits from the question.
2352 ;; Such a quit quits out of GC, but something else will call GC
2353 ;; again momentarily. It will call this function again,
2354 ;; but we don't want to ask the question again.
2355 (setq undo-extra-outer-limit (+ size 50000))
2356 (if (let (use-dialog-box track-mouse executing-kbd-macro )
2357 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
2358 (buffer-name) size)))
2359 (progn (setq buffer-undo-list nil)
2360 (setq undo-extra-outer-limit nil)
2363 (display-warning '(undo discard-info)
2365 (format "Buffer `%s' undo info was %d bytes long.\n"
2367 "The undo info was discarded because it exceeded \
2370 This is normal if you executed a command that made a huge change
2371 to the buffer. In that case, to prevent similar problems in the
2372 future, set `undo-outer-limit' to a value that is large enough to
2373 cover the maximum size of normal changes you expect a single
2374 command to make, but not so large that it might exceed the
2375 maximum memory allotted to Emacs.
2377 If you did not execute any such command, the situation is
2378 probably due to a bug and you should report it.
2380 You can disable the popping up of this buffer by adding the entry
2381 \(undo discard-info) to the user option `warning-suppress-types',
2382 which is defined in the `warnings' library.\n")
2384 (setq buffer-undo-list nil)
2387 (defvar shell-command-history nil
2388 "History list for some commands that read shell commands.
2390 Maximum length of the history list is determined by the value
2391 of `history-length', which see.")
2393 (defvar shell-command-switch (purecopy "-c")
2394 "Switch used to have the shell execute its command line argument.")
2396 (defvar shell-command-default-error-buffer nil
2397 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2398 This buffer is used when `shell-command' or `shell-command-on-region'
2399 is run interactively. A value of nil means that output to stderr and
2400 stdout will be intermixed in the output stream.")
2402 (declare-function mailcap-file-default-commands "mailcap" (files))
2403 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
2405 (defun minibuffer-default-add-shell-commands ()
2406 "Return a list of all commands associated with the current file.
2407 This function is used to add all related commands retrieved by `mailcap'
2408 to the end of the list of defaults just after the default value."
2410 (let* ((filename (if (listp minibuffer-default)
2411 (car minibuffer-default)
2412 minibuffer-default))
2413 (commands (and filename (require 'mailcap nil t)
2414 (mailcap-file-default-commands (list filename)))))
2415 (setq commands (mapcar (lambda (command)
2416 (concat command " " filename))
2418 (if (listp minibuffer-default)
2419 (append minibuffer-default commands)
2420 (cons minibuffer-default commands))))
2422 (declare-function shell-completion-vars "shell" ())
2424 (defvar minibuffer-local-shell-command-map
2425 (let ((map (make-sparse-keymap)))
2426 (set-keymap-parent map minibuffer-local-map)
2427 (define-key map "\t" 'completion-at-point)
2429 "Keymap used for completing shell commands in minibuffer.")
2431 (defun read-shell-command (prompt &optional initial-contents hist &rest args)
2432 "Read a shell command from the minibuffer.
2433 The arguments are the same as the ones of `read-from-minibuffer',
2434 except READ and KEYMAP are missing and HIST defaults
2435 to `shell-command-history'."
2437 (minibuffer-with-setup-hook
2439 (shell-completion-vars)
2440 (set (make-local-variable 'minibuffer-default-add-function)
2441 'minibuffer-default-add-shell-commands))
2442 (apply 'read-from-minibuffer prompt initial-contents
2443 minibuffer-local-shell-command-map
2445 (or hist 'shell-command-history)
2448 (defcustom async-shell-command-buffer 'confirm-new-buffer
2449 "What to do when the output buffer is used by another shell command.
2450 This option specifies how to resolve the conflict where a new command
2451 wants to direct its output to the buffer `*Async Shell Command*',
2452 but this buffer is already taken by another running shell command.
2454 The value `confirm-kill-process' is used to ask for confirmation before
2455 killing the already running process and running a new process
2456 in the same buffer, `confirm-new-buffer' for confirmation before running
2457 the command in a new buffer with a name other than the default buffer name,
2458 `new-buffer' for doing the same without confirmation,
2459 `confirm-rename-buffer' for confirmation before renaming the existing
2460 output buffer and running a new command in the default buffer,
2461 `rename-buffer' for doing the same without confirmation."
2462 :type '(choice (const :tag "Confirm killing of running command"
2463 confirm-kill-process)
2464 (const :tag "Confirm creation of a new buffer"
2466 (const :tag "Create a new buffer"
2468 (const :tag "Confirm renaming of existing buffer"
2469 confirm-rename-buffer)
2470 (const :tag "Rename the existing buffer"
2475 (defun async-shell-command (command &optional output-buffer error-buffer)
2476 "Execute string COMMAND asynchronously in background.
2478 Like `shell-command', but adds `&' at the end of COMMAND
2479 to execute it asynchronously.
2481 The output appears in the buffer `*Async Shell Command*'.
2482 That buffer is in shell mode.
2484 In Elisp, you will often be better served by calling `start-process'
2485 directly, since it offers more control and does not impose the use of a
2486 shell (with its need to quote arguments)."
2489 (read-shell-command "Async shell command: " nil nil
2493 ((eq major-mode 'dired-mode)
2494 (dired-get-filename nil t)))))
2495 (and filename (file-relative-name filename))))
2497 shell-command-default-error-buffer))
2498 (unless (string-match "&[ \t]*\\'" command)
2499 (setq command (concat command " &")))
2500 (shell-command command output-buffer error-buffer))
2502 (defun shell-command (command &optional output-buffer error-buffer)
2503 "Execute string COMMAND in inferior shell; display output, if any.
2504 With prefix argument, insert the COMMAND's output at point.
2506 If COMMAND ends in `&', execute it asynchronously.
2507 The output appears in the buffer `*Async Shell Command*'.
2508 That buffer is in shell mode. You can also use
2509 `async-shell-command' that automatically adds `&'.
2511 Otherwise, COMMAND is executed synchronously. The output appears in
2512 the buffer `*Shell Command Output*'. If the output is short enough to
2513 display in the echo area (which is determined by the variables
2514 `resize-mini-windows' and `max-mini-window-height'), it is shown
2515 there, but it is nonetheless available in buffer `*Shell Command
2516 Output*' even though that buffer is not automatically displayed.
2518 To specify a coding system for converting non-ASCII characters
2519 in the shell command output, use \\[universal-coding-system-argument] \
2520 before this command.
2522 Noninteractive callers can specify coding systems by binding
2523 `coding-system-for-read' and `coding-system-for-write'.
2525 The optional second argument OUTPUT-BUFFER, if non-nil,
2526 says to put the output in some other buffer.
2527 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2528 If OUTPUT-BUFFER is not a buffer and not nil,
2529 insert output in current buffer. (This cannot be done asynchronously.)
2530 In either case, the buffer is first erased, and the output is
2531 inserted after point (leaving mark after it).
2533 If the command terminates without error, but generates output,
2534 and you did not specify \"insert it in the current buffer\",
2535 the output can be displayed in the echo area or in its buffer.
2536 If the output is short enough to display in the echo area
2537 \(determined by the variable `max-mini-window-height' if
2538 `resize-mini-windows' is non-nil), it is shown there.
2539 Otherwise,the buffer containing the output is displayed.
2541 If there is output and an error, and you did not specify \"insert it
2542 in the current buffer\", a message about the error goes at the end
2545 If there is no output, or if output is inserted in the current buffer,
2546 then `*Shell Command Output*' is deleted.
2548 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2549 or buffer name to which to direct the command's standard error output.
2550 If it is nil, error output is mingled with regular output.
2551 In an interactive call, the variable `shell-command-default-error-buffer'
2552 specifies the value of ERROR-BUFFER.
2554 In Elisp, you will often be better served by calling `call-process' or
2555 `start-process' directly, since it offers more control and does not impose
2556 the use of a shell (with its need to quote arguments)."
2560 (read-shell-command "Shell command: " nil nil
2564 ((eq major-mode 'dired-mode)
2565 (dired-get-filename nil t)))))
2566 (and filename (file-relative-name filename))))
2568 shell-command-default-error-buffer))
2569 ;; Look for a handler in case default-directory is a remote file name.
2571 (find-file-name-handler (directory-file-name default-directory)
2574 (funcall handler 'shell-command command output-buffer error-buffer)
2575 (if (and output-buffer
2576 (not (or (bufferp output-buffer) (stringp output-buffer))))
2577 ;; Output goes in current buffer.
2581 (expand-file-name "scor"
2582 (or small-temporary-file-directory
2583 temporary-file-directory)))
2585 (barf-if-buffer-read-only)
2587 ;; We do not use -f for csh; we will not support broken use of
2588 ;; .cshrcs. Even the BSD csh manual says to use
2589 ;; "if ($?prompt) exit" before things which are not useful
2590 ;; non-interactively. Besides, if someone wants their other
2591 ;; aliases for shell commands then they can still have them.
2592 (call-process shell-file-name nil
2596 nil shell-command-switch command)
2597 (when (and error-file (file-exists-p error-file))
2598 (if (< 0 (nth 7 (file-attributes error-file)))
2599 (with-current-buffer (get-buffer-create error-buffer)
2600 (let ((pos-from-end (- (point-max) (point))))
2603 ;; Do no formatting while reading error file,
2604 ;; because that can run a shell command, and we
2605 ;; don't want that to cause an infinite recursion.
2606 (format-insert-file error-file nil)
2607 ;; Put point after the inserted errors.
2608 (goto-char (- (point-max) pos-from-end)))
2609 (display-buffer (current-buffer))))
2610 (delete-file error-file))
2611 ;; This is like exchange-point-and-mark, but doesn't
2612 ;; activate the mark. It is cleaner to avoid activation,
2613 ;; even though the command loop would deactivate the mark
2614 ;; because we inserted text.
2615 (goto-char (prog1 (mark t)
2616 (set-marker (mark-marker) (point)
2617 (current-buffer)))))
2618 ;; Output goes in a separate buffer.
2619 ;; Preserve the match data in case called from a program.
2621 (if (string-match "[ \t]*&[ \t]*\\'" command)
2622 ;; Command ending with ampersand means asynchronous.
2623 (let ((buffer (get-buffer-create
2624 (or output-buffer "*Async Shell Command*")))
2625 (directory default-directory)
2627 ;; Remove the ampersand.
2628 (setq command (substring command 0 (match-beginning 0)))
2629 ;; Ask the user what to do with already running process.
2630 (setq proc (get-buffer-process buffer))
2633 ((eq async-shell-command-buffer 'confirm-kill-process)
2634 ;; If will kill a process, query first.
2635 (if (yes-or-no-p "A command is running in the default buffer. Kill it? ")
2637 (error "Shell command in progress")))
2638 ((eq async-shell-command-buffer 'confirm-new-buffer)
2639 ;; If will create a new buffer, query first.
2640 (if (yes-or-no-p "A command is running in the default buffer. Use a new buffer? ")
2641 (setq buffer (generate-new-buffer
2642 (or output-buffer "*Async Shell Command*")))
2643 (error "Shell command in progress")))
2644 ((eq async-shell-command-buffer 'new-buffer)
2645 ;; It will create a new buffer.
2646 (setq buffer (generate-new-buffer
2647 (or output-buffer "*Async Shell Command*"))))
2648 ((eq async-shell-command-buffer 'confirm-rename-buffer)
2649 ;; If will rename the buffer, query first.
2650 (if (yes-or-no-p "A command is running in the default buffer. Rename it? ")
2652 (with-current-buffer buffer
2654 (setq buffer (get-buffer-create
2655 (or output-buffer "*Async Shell Command*"))))
2656 (error "Shell command in progress")))
2657 ((eq async-shell-command-buffer 'rename-buffer)
2658 ;; It will rename the buffer.
2659 (with-current-buffer buffer
2661 (setq buffer (get-buffer-create
2662 (or output-buffer "*Async Shell Command*"))))))
2663 (with-current-buffer buffer
2664 (setq buffer-read-only nil)
2665 ;; Setting buffer-read-only to nil doesn't suffice
2666 ;; if some text has a non-nil read-only property,
2667 ;; which comint sometimes adds for prompts.
2668 (let ((inhibit-read-only t))
2670 (display-buffer buffer)
2671 (setq default-directory directory)
2672 (setq proc (start-process "Shell" buffer shell-file-name
2673 shell-command-switch command))
2674 (setq mode-line-process '(":%s"))
2675 (require 'shell) (shell-mode)
2676 (set-process-sentinel proc 'shell-command-sentinel)
2677 ;; Use the comint filter for proper handling of carriage motion
2678 ;; (see `comint-inhibit-carriage-motion'),.
2679 (set-process-filter proc 'comint-output-filter)
2681 ;; Otherwise, command is executed synchronously.
2682 (shell-command-on-region (point) (point) command
2683 output-buffer nil error-buffer)))))))
2685 (defun display-message-or-buffer (message
2686 &optional buffer-name not-this-window frame)
2687 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2688 MESSAGE may be either a string or a buffer.
2690 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2691 the maximum height of the echo area, as defined by `max-mini-window-height'
2692 if `resize-mini-windows' is non-nil.
2694 Returns either the string shown in the echo area, or when a pop-up
2695 buffer is used, the window used to display it.
2697 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2698 name of the buffer used to display it in the case where a pop-up buffer
2699 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2700 string and it is displayed in the echo area, it is not specified whether
2701 the contents are inserted into the buffer anyway.
2703 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2704 and only used if a buffer is displayed."
2705 (cond ((and (stringp message) (not (string-match "\n" message)))
2706 ;; Trivial case where we can use the echo area
2707 (message "%s" message))
2708 ((and (stringp message)
2709 (= (string-match "\n" message) (1- (length message))))
2710 ;; Trivial case where we can just remove single trailing newline
2711 (message "%s" (substring message 0 (1- (length message)))))
2714 (with-current-buffer
2715 (if (bufferp message)
2717 (get-buffer-create (or buffer-name "*Message*")))
2719 (unless (bufferp message)
2724 (if (= (buffer-size) 0)
2726 (count-screen-lines nil nil nil (minibuffer-window)))))
2728 ((and (or (<= lines 1)
2730 (if resize-mini-windows
2731 (cond ((floatp max-mini-window-height)
2733 max-mini-window-height))
2734 ((integerp max-mini-window-height)
2735 max-mini-window-height)
2739 ;; Don't use the echo area if the output buffer is
2740 ;; already displayed in the selected frame.
2741 (not (get-buffer-window (current-buffer))))
2743 (goto-char (point-max))
2746 (message "%s" (buffer-substring (point-min) (point))))
2749 (goto-char (point-min))
2750 (display-buffer (current-buffer)
2751 not-this-window frame))))))))
2754 ;; We have a sentinel to prevent insertion of a termination message
2755 ;; in the buffer itself.
2756 (defun shell-command-sentinel (process signal)
2757 (if (memq (process-status process) '(exit signal))
2759 (car (cdr (cdr (process-command process))))
2760 (substring signal 0 -1))))
2762 (defun shell-command-on-region (start end command
2763 &optional output-buffer replace
2764 error-buffer display-error-buffer)
2765 "Execute string COMMAND in inferior shell with region as input.
2766 Normally display output (if any) in temp buffer `*Shell Command Output*';
2767 Prefix arg means replace the region with it. Return the exit code of
2770 To specify a coding system for converting non-ASCII characters
2771 in the input and output to the shell command, use \\[universal-coding-system-argument]
2772 before this command. By default, the input (from the current buffer)
2773 is encoded using coding-system specified by `process-coding-system-alist',
2774 falling back to `default-process-coding-system' if no match for COMMAND
2775 is found in `process-coding-system-alist'.
2777 Noninteractive callers can specify coding systems by binding
2778 `coding-system-for-read' and `coding-system-for-write'.
2780 If the command generates output, the output may be displayed
2781 in the echo area or in a buffer.
2782 If the output is short enough to display in the echo area
2783 \(determined by the variable `max-mini-window-height' if
2784 `resize-mini-windows' is non-nil), it is shown there.
2785 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2786 The output is available in that buffer in both cases.
2788 If there is output and an error, a message about the error
2789 appears at the end of the output. If there is no output, or if
2790 output is inserted in the current buffer, the buffer `*Shell
2791 Command Output*' is deleted.
2793 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2794 command's output. If the value is a buffer or buffer name, put
2795 the output there. Any other value, including nil, means to
2796 insert the output in the current buffer. In either case, the
2797 output is inserted after point (leaving mark after it).
2799 Optional fifth arg REPLACE, if non-nil, means to insert the
2800 output in place of text from START to END, putting point and mark
2803 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2804 or buffer name to which to direct the command's standard error
2805 output. If nil, error output is mingled with regular output.
2806 When called interactively, `shell-command-default-error-buffer'
2807 is used for ERROR-BUFFER.
2809 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2810 display the error buffer if there were any errors. When called
2811 interactively, this is t."
2812 (interactive (let (string)
2814 (error "The mark is not set now, so there is no region"))
2815 ;; Do this before calling region-beginning
2816 ;; and region-end, in case subprocess output
2817 ;; relocates them while we are in the minibuffer.
2818 (setq string (read-shell-command "Shell command on region: "))
2819 ;; call-interactively recognizes region-beginning and
2820 ;; region-end specially, leaving them in the history.
2821 (list (region-beginning) (region-end)
2825 shell-command-default-error-buffer
2830 (expand-file-name "scor"
2831 (or small-temporary-file-directory
2832 temporary-file-directory)))
2837 (not (or (bufferp output-buffer) (stringp output-buffer)))))
2838 ;; Replace specified region with output from command.
2839 (let ((swap (and replace (< start end))))
2840 ;; Don't muck with mark unless REPLACE says we should.
2842 (and replace (push-mark (point) 'nomsg))
2844 (call-process-region start end shell-file-name t
2848 nil shell-command-switch command))
2849 ;; It is rude to delete a buffer which the command is not using.
2850 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2851 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2852 ;; (kill-buffer shell-buffer)))
2853 ;; Don't muck with mark unless REPLACE says we should.
2854 (and replace swap (exchange-point-and-mark)))
2855 ;; No prefix argument: put the output in a temp buffer,
2856 ;; replacing its entire contents.
2857 (let ((buffer (get-buffer-create
2858 (or output-buffer "*Shell Command Output*"))))
2860 (if (eq buffer (current-buffer))
2861 ;; If the input is the same buffer as the output,
2862 ;; delete everything but the specified region,
2863 ;; then replace that region with the output.
2864 (progn (setq buffer-read-only nil)
2865 (delete-region (max start end) (point-max))
2866 (delete-region (point-min) (min start end))
2868 (call-process-region (point-min) (point-max)
2873 nil shell-command-switch
2875 ;; Clear the output buffer, then run the command with
2877 (let ((directory default-directory))
2878 (with-current-buffer buffer
2879 (setq buffer-read-only nil)
2880 (if (not output-buffer)
2881 (setq default-directory directory))
2884 (call-process-region start end shell-file-name nil
2886 (list buffer error-file)
2888 nil shell-command-switch command)))
2889 ;; Report the output.
2890 (with-current-buffer buffer
2891 (setq mode-line-process
2892 (cond ((null exit-status)
2894 ((stringp exit-status)
2895 (format " - Signal [%s]" exit-status))
2896 ((not (equal 0 exit-status))
2897 (format " - Exit [%d]" exit-status)))))
2898 (if (with-current-buffer buffer (> (point-max) (point-min)))
2899 ;; There's some output, display it
2900 (display-message-or-buffer buffer)
2901 ;; No output; error?
2904 (< 0 (nth 7 (file-attributes error-file))))
2905 (format "some error output%s"
2906 (if shell-command-default-error-buffer
2907 (format " to the \"%s\" buffer"
2908 shell-command-default-error-buffer)
2911 (cond ((null exit-status)
2912 (message "(Shell command failed with error)"))
2913 ((equal 0 exit-status)
2914 (message "(Shell command succeeded with %s)"
2916 ((stringp exit-status)
2917 (message "(Shell command killed by signal %s)"
2920 (message "(Shell command failed with code %d and %s)"
2921 exit-status output))))
2922 ;; Don't kill: there might be useful info in the undo-log.
2923 ;; (kill-buffer buffer)
2926 (when (and error-file (file-exists-p error-file))
2927 (if (< 0 (nth 7 (file-attributes error-file)))
2928 (with-current-buffer (get-buffer-create error-buffer)
2929 (let ((pos-from-end (- (point-max) (point))))
2932 ;; Do no formatting while reading error file,
2933 ;; because that can run a shell command, and we
2934 ;; don't want that to cause an infinite recursion.
2935 (format-insert-file error-file nil)
2936 ;; Put point after the inserted errors.
2937 (goto-char (- (point-max) pos-from-end)))
2938 (and display-error-buffer
2939 (display-buffer (current-buffer)))))
2940 (delete-file error-file))
2943 (defun shell-command-to-string (command)
2944 "Execute shell command COMMAND and return its output as a string."
2945 (with-output-to-string
2946 (with-current-buffer
2948 (process-file shell-file-name nil t nil shell-command-switch command))))
2950 (defun process-file (program &optional infile buffer display &rest args)
2951 "Process files synchronously in a separate process.
2952 Similar to `call-process', but may invoke a file handler based on
2953 `default-directory'. The current working directory of the
2954 subprocess is `default-directory'.
2956 File names in INFILE and BUFFER are handled normally, but file
2957 names in ARGS should be relative to `default-directory', as they
2958 are passed to the process verbatim. \(This is a difference to
2959 `call-process' which does not support file handlers for INFILE
2962 Some file handlers might not support all variants, for example
2963 they might behave as if DISPLAY was nil, regardless of the actual
2965 (let ((fh (find-file-name-handler default-directory 'process-file))
2968 (if fh (apply fh 'process-file program infile buffer display args)
2969 (when infile (setq lc (file-local-copy infile)))
2970 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
2971 (make-temp-file "emacs")))
2973 (apply 'call-process program
2975 (if stderr-file (list (car buffer) stderr-file) buffer)
2977 (when stderr-file (copy-file stderr-file (cadr buffer) t))))
2978 (when stderr-file (delete-file stderr-file))
2979 (when lc (delete-file lc)))))
2981 (defvar process-file-side-effects t
2982 "Whether a call of `process-file' changes remote files.
2984 By default, this variable is always set to `t', meaning that a
2985 call of `process-file' could potentially change any file on a
2986 remote host. When set to `nil', a file handler could optimize
2987 its behavior with respect to remote file attribute caching.
2989 You should only ever change this variable with a let-binding;
2990 never with `setq'.")
2992 (defun start-file-process (name buffer program &rest program-args)
2993 "Start a program in a subprocess. Return the process object for it.
2995 Similar to `start-process', but may invoke a file handler based on
2996 `default-directory'. See Info node `(elisp)Magic File Names'.
2998 This handler ought to run PROGRAM, perhaps on the local host,
2999 perhaps on a remote host that corresponds to `default-directory'.
3000 In the latter case, the local part of `default-directory' becomes
3001 the working directory of the process.
3003 PROGRAM and PROGRAM-ARGS might be file names. They are not
3004 objects of file handler invocation. File handlers might not
3005 support pty association, if PROGRAM is nil."
3006 (let ((fh (find-file-name-handler default-directory 'start-file-process)))
3007 (if fh (apply fh 'start-file-process name buffer program program-args)
3008 (apply 'start-process name buffer program program-args))))
3012 (defvar tabulated-list-format)
3013 (defvar tabulated-list-entries)
3014 (defvar tabulated-list-sort-key)
3015 (declare-function tabulated-list-init-header "tabulated-list" ())
3016 (declare-function tabulated-list-print "tabulated-list"
3017 (&optional remember-pos))
3019 (defvar process-menu-query-only nil)
3021 (define-derived-mode process-menu-mode tabulated-list-mode "Process Menu"
3022 "Major mode for listing the processes called by Emacs."
3023 (setq tabulated-list-format [("Process" 15 t)
3028 (make-local-variable 'process-menu-query-only)
3029 (setq tabulated-list-sort-key (cons "Process" nil))
3030 (add-hook 'tabulated-list-revert-hook 'list-processes--refresh nil t)
3031 (tabulated-list-init-header))
3033 (defun list-processes--refresh ()
3034 "Recompute the list of processes for the Process List buffer.
3035 Also, delete any process that is exited or signaled."
3036 (setq tabulated-list-entries nil)
3037 (dolist (p (process-list))
3038 (cond ((memq (process-status p) '(exit signal closed))
3040 ((or (not process-menu-query-only)
3041 (process-query-on-exit-flag p))
3042 (let* ((buf (process-buffer p))
3043 (type (process-type p))
3044 (name (process-name p))
3045 (status (symbol-name (process-status p)))
3046 (buf-label (if (buffer-live-p buf)
3047 `(,(buffer-name buf)
3049 help-echo ,(concat "Visit buffer `"
3050 (buffer-name buf) "'")
3053 action process-menu-visit-buffer)
3055 (tty (or (process-tty-name p) "--"))
3057 (if (memq type '(network serial))
3058 (let ((contact (process-contact p t)))
3059 (if (eq type 'network)
3061 (if (plist-get contact :type)
3064 (if (plist-get contact :server)
3065 (format "server on %s"
3067 (plist-get contact :host)
3068 (plist-get contact :local)))
3069 (format "connection to %s"
3070 (plist-get contact :host))))
3071 (format "(serial port %s%s)"
3072 (or (plist-get contact :port) "?")
3073 (let ((speed (plist-get contact :speed)))
3075 (format " at %s b/s" speed)
3077 (mapconcat 'identity (process-command p) " "))))
3078 (push (list p (vector name status buf-label tty cmd))
3079 tabulated-list-entries))))))
3081 (defun process-menu-visit-buffer (button)
3082 (display-buffer (button-get button 'process-buffer)))
3084 (defun list-processes (&optional query-only buffer)
3085 "Display a list of all processes.
3086 If optional argument QUERY-ONLY is non-nil, only processes with
3087 the query-on-exit flag set are listed.
3088 Any process listed as exited or signaled is actually eliminated
3089 after the listing is made.
3090 Optional argument BUFFER specifies a buffer to use, instead of
3092 The return value is always nil."
3094 (or (fboundp 'process-list)
3095 (error "Asynchronous subprocesses are not supported on this system"))
3096 (unless (bufferp buffer)
3097 (setq buffer (get-buffer-create "*Process List*")))
3098 (with-current-buffer buffer
3100 (setq process-menu-query-only query-only)
3101 (list-processes--refresh)
3102 (tabulated-list-print))
3103 (display-buffer buffer)
3106 (defvar universal-argument-map
3107 (let ((map (make-sparse-keymap)))
3108 (define-key map [t] 'universal-argument-other-key)
3109 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
3110 (define-key map [switch-frame] nil)
3111 (define-key map [?\C-u] 'universal-argument-more)
3112 (define-key map [?-] 'universal-argument-minus)
3113 (define-key map [?0] 'digit-argument)
3114 (define-key map [?1] 'digit-argument)
3115 (define-key map [?2] 'digit-argument)
3116 (define-key map [?3] 'digit-argument)
3117 (define-key map [?4] 'digit-argument)
3118 (define-key map [?5] 'digit-argument)
3119 (define-key map [?6] 'digit-argument)
3120 (define-key map [?7] 'digit-argument)
3121 (define-key map [?8] 'digit-argument)
3122 (define-key map [?9] 'digit-argument)
3123 (define-key map [kp-0] 'digit-argument)
3124 (define-key map [kp-1] 'digit-argument)
3125 (define-key map [kp-2] 'digit-argument)
3126 (define-key map [kp-3] 'digit-argument)
3127 (define-key map [kp-4] 'digit-argument)
3128 (define-key map [kp-5] 'digit-argument)
3129 (define-key map [kp-6] 'digit-argument)
3130 (define-key map [kp-7] 'digit-argument)
3131 (define-key map [kp-8] 'digit-argument)
3132 (define-key map [kp-9] 'digit-argument)
3133 (define-key map [kp-subtract] 'universal-argument-minus)
3135 "Keymap used while processing \\[universal-argument].")
3137 (defvar universal-argument-num-events nil
3138 "Number of argument-specifying events read by `universal-argument'.
3139 `universal-argument-other-key' uses this to discard those events
3140 from (this-command-keys), and reread only the final command.")
3142 (defvar saved-overriding-map t
3143 "The saved value of `overriding-terminal-local-map'.
3144 That variable gets restored to this value on exiting \"universal
3147 (defun save&set-overriding-map (map)
3148 "Set `overriding-terminal-local-map' to MAP."
3149 (when (eq saved-overriding-map t)
3150 (setq saved-overriding-map overriding-terminal-local-map)
3151 (setq overriding-terminal-local-map map)))
3153 (defun restore-overriding-map ()
3154 "Restore `overriding-terminal-local-map' to its saved value."
3155 (setq overriding-terminal-local-map saved-overriding-map)
3156 (setq saved-overriding-map t))
3158 (defun universal-argument ()
3159 "Begin a numeric argument for the following command.
3160 Digits or minus sign following \\[universal-argument] make up the numeric argument.
3161 \\[universal-argument] following the digits or minus sign ends the argument.
3162 \\[universal-argument] without digits or minus sign provides 4 as argument.
3163 Repeating \\[universal-argument] without digits or minus sign
3164 multiplies the argument by 4 each time.
3165 For some commands, just \\[universal-argument] by itself serves as a flag
3166 which is different in effect from any particular numeric argument.
3167 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
3169 (setq prefix-arg (list 4))
3170 (setq universal-argument-num-events (length (this-command-keys)))
3171 (save&set-overriding-map universal-argument-map))
3173 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3174 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3175 (defun universal-argument-more (arg)
3178 (setq prefix-arg (list (* 4 (car arg))))
3180 (setq prefix-arg (list -4))
3181 (setq prefix-arg arg)
3182 (restore-overriding-map)))
3183 (setq universal-argument-num-events (length (this-command-keys))))
3185 (defun negative-argument (arg)
3186 "Begin a negative numeric argument for the next command.
3187 \\[universal-argument] following digits or minus sign ends the argument."
3189 (cond ((integerp arg)
3190 (setq prefix-arg (- arg)))
3192 (setq prefix-arg nil))
3194 (setq prefix-arg '-)))
3195 (setq universal-argument-num-events (length (this-command-keys)))
3196 (save&set-overriding-map universal-argument-map))
3198 (defun digit-argument (arg)
3199 "Part of the numeric argument for the next command.
3200 \\[universal-argument] following digits or minus sign ends the argument."
3202 (let* ((char (if (integerp last-command-event)
3204 (get last-command-event 'ascii-character)))
3205 (digit (- (logand char ?\177) ?0)))
3206 (cond ((integerp arg)
3207 (setq prefix-arg (+ (* arg 10)
3208 (if (< arg 0) (- digit) digit))))
3210 ;; Treat -0 as just -, so that -01 will work.
3211 (setq prefix-arg (if (zerop digit) '- (- digit))))
3213 (setq prefix-arg digit))))
3214 (setq universal-argument-num-events (length (this-command-keys)))
3215 (save&set-overriding-map universal-argument-map))
3217 ;; For backward compatibility, minus with no modifiers is an ordinary
3218 ;; command if digits have already been entered.
3219 (defun universal-argument-minus (arg)
3222 (universal-argument-other-key arg)
3223 (negative-argument arg)))
3225 ;; Anything else terminates the argument and is left in the queue to be
3226 ;; executed as a command.
3227 (defun universal-argument-other-key (arg)
3229 (setq prefix-arg arg)
3230 (let* ((key (this-command-keys))
3231 (keylist (listify-key-sequence key)))
3232 (setq unread-command-events
3233 (append (nthcdr universal-argument-num-events keylist)
3234 unread-command-events)))
3235 (reset-this-command-lengths)
3236 (restore-overriding-map))
3239 (defvar filter-buffer-substring-functions nil
3240 "This variable is a wrapper hook around `filter-buffer-substring'.
3241 Each member of the hook should be a function accepting four arguments:
3242 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
3243 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3244 as those of `filter-buffer-substring' in each case.
3246 The first hook function to be called receives a FUN equivalent
3247 to the default operation of `filter-buffer-substring',
3248 i.e. one that returns the buffer-substring between BEG and
3249 END (processed by any `buffer-substring-filters'). Normally,
3250 the hook function will call FUN and then do its own processing
3251 of the result. The next hook function receives a FUN equivalent
3252 to the previous hook function, calls it, and does its own
3253 processing, and so on. The overall result is that of all hook
3254 functions acting in sequence.
3256 Any hook may choose not to call FUN though, in which case it
3257 effectively replaces the default behavior with whatever it chooses.
3258 Of course, a later hook function may do the same thing.")
3260 (defvar buffer-substring-filters nil
3261 "List of filter functions for `filter-buffer-substring'.
3262 Each function must accept a single argument, a string, and return
3263 a string. The buffer substring is passed to the first function
3264 in the list, and the return value of each function is passed to
3265 the next. The final result (if `buffer-substring-filters' is
3266 nil, this is the unfiltered buffer-substring) is passed to the
3267 first function on `filter-buffer-substring-functions'.
3269 As a special convention, point is set to the start of the buffer text
3270 being operated on (i.e., the first argument of `filter-buffer-substring')
3271 before these functions are called.")
3272 (make-obsolete-variable 'buffer-substring-filters
3273 'filter-buffer-substring-functions "24.1")
3275 (defun filter-buffer-substring (beg end &optional delete)
3276 "Return the buffer substring between BEG and END, after filtering.
3277 The wrapper hook `filter-buffer-substring-functions' performs
3278 the actual filtering. The obsolete variable `buffer-substring-filters'
3279 is also consulted. If both of these are nil, no filtering is done.
3281 If DELETE is non-nil, the text between BEG and END is deleted
3284 This function should be used instead of `buffer-substring',
3285 `buffer-substring-no-properties', or `delete-and-extract-region'
3286 when you want to allow filtering to take place. For example,
3287 major or minor modes can use `filter-buffer-substring-functions' to
3288 extract characters that are special to a buffer, and should not
3289 be copied into other buffers."
3290 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3292 ((or delete buffer-substring-filters)
3295 (let ((string (if delete (delete-and-extract-region beg end)
3296 (buffer-substring beg end))))
3297 (dolist (filter buffer-substring-filters)
3298 (setq string (funcall filter string)))
3301 (buffer-substring beg end)))))
3304 ;;;; Window system cut and paste hooks.
3306 (defvar interprogram-cut-function nil
3307 "Function to call to make a killed region available to other programs.
3308 Most window systems provide a facility for cutting and pasting
3309 text between different programs, such as the clipboard on X and
3310 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3312 This variable holds a function that Emacs calls whenever text is
3313 put in the kill ring, to make the new kill available to other
3314 programs. The function takes one argument, TEXT, which is a
3315 string containing the text which should be made available.")
3317 (defvar interprogram-paste-function nil
3318 "Function to call to get text cut from other programs.
3319 Most window systems provide a facility for cutting and pasting
3320 text between different programs, such as the clipboard on X and
3321 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3323 This variable holds a function that Emacs calls to obtain text
3324 that other programs have provided for pasting. The function is
3325 called with no arguments. If no other program has provided text
3326 to paste, the function should return nil (in which case the
3327 caller, usually `current-kill', should use the top of the Emacs
3328 kill ring). If another program has provided text to paste, the
3329 function should return that text as a string (in which case the
3330 caller should put this string in the kill ring as the latest
3333 The function may also return a list of strings if the window
3334 system supports multiple selections. The first string will be
3335 used as the pasted text, but the other will be placed in the kill
3336 ring for easy access via `yank-pop'.
3338 Note that the function should return a string only if a program
3339 other than Emacs has provided a string for pasting; if Emacs
3340 provided the most recent string, the function should return nil.
3341 If it is difficult to tell whether Emacs or some other program
3342 provided the current string, it is probably good enough to return
3343 nil if the string is equal (according to `string=') to the last
3344 text Emacs provided.")
3348 ;;;; The kill ring data structure.
3350 (defvar kill-ring nil
3351 "List of killed text sequences.
3352 Since the kill ring is supposed to interact nicely with cut-and-paste
3353 facilities offered by window systems, use of this variable should
3354 interact nicely with `interprogram-cut-function' and
3355 `interprogram-paste-function'. The functions `kill-new',
3356 `kill-append', and `current-kill' are supposed to implement this
3357 interaction; you may want to use them instead of manipulating the kill
3360 (defcustom kill-ring-max 60
3361 "Maximum length of kill ring before oldest elements are thrown away."
3365 (defvar kill-ring-yank-pointer nil
3366 "The tail of the kill ring whose car is the last thing yanked.")
3368 (defcustom save-interprogram-paste-before-kill nil
3369 "Save clipboard strings into kill ring before replacing them.
3370 When one selects something in another program to paste it into Emacs,
3371 but kills something in Emacs before actually pasting it,
3372 this selection is gone unless this variable is non-nil,
3373 in which case the other program's selection is saved in the `kill-ring'
3374 before the Emacs kill and one can still paste it using \\[yank] \\[yank-pop]."
3379 (defcustom kill-do-not-save-duplicates nil
3380 "Do not add a new string to `kill-ring' if it duplicates the last one.
3381 The comparison is done using `equal-including-properties'."
3386 (defun kill-new (string &optional replace yank-handler)
3387 "Make STRING the latest kill in the kill ring.
3388 Set `kill-ring-yank-pointer' to point to it.
3389 If `interprogram-cut-function' is non-nil, apply it to STRING.
3390 Optional second argument REPLACE non-nil means that STRING will replace
3391 the front of the kill ring, rather than being added to the list.
3393 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3394 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3397 When the yank handler has a non-nil PARAM element, the original STRING
3398 argument is not used by `insert-for-yank'. However, since Lisp code
3399 may access and use elements from the kill ring directly, the STRING
3400 argument should still be a \"useful\" string for such uses."
3401 (if (> (length string) 0)
3403 (put-text-property 0 (length string)
3404 'yank-handler yank-handler string))
3406 (signal 'args-out-of-range
3407 (list string "yank-handler specified for empty string"))))
3408 (unless (and kill-do-not-save-duplicates
3409 ;; Due to text properties such as 'yank-handler that
3410 ;; can alter the contents to yank, comparison using
3411 ;; `equal' is unsafe.
3412 (equal-including-properties string (car kill-ring)))
3413 (if (fboundp 'menu-bar-update-yank-menu)
3414 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3415 (when save-interprogram-paste-before-kill
3416 (let ((interprogram-paste (and interprogram-paste-function
3417 (funcall interprogram-paste-function))))
3418 (when interprogram-paste
3419 (dolist (s (if (listp interprogram-paste)
3420 (nreverse interprogram-paste)
3421 (list interprogram-paste)))
3422 (unless (and kill-do-not-save-duplicates
3423 (equal-including-properties s (car kill-ring)))
3424 (push s kill-ring))))))
3425 (unless (and kill-do-not-save-duplicates
3426 (equal-including-properties string (car kill-ring)))
3427 (if (and replace kill-ring)
3428 (setcar kill-ring string)
3429 (push string kill-ring)
3430 (if (> (length kill-ring) kill-ring-max)
3431 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3432 (setq kill-ring-yank-pointer kill-ring)
3433 (if interprogram-cut-function
3434 (funcall interprogram-cut-function string)))
3435 (set-advertised-calling-convention
3436 'kill-new '(string &optional replace) "23.3")
3438 (defun kill-append (string before-p &optional yank-handler)
3439 "Append STRING to the end of the latest kill in the kill ring.
3440 If BEFORE-P is non-nil, prepend STRING to the kill.
3441 If `interprogram-cut-function' is set, pass the resulting kill to it."
3442 (let* ((cur (car kill-ring)))
3443 (kill-new (if before-p (concat string cur) (concat cur string))
3444 (or (= (length cur) 0)
3445 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3447 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3449 (defcustom yank-pop-change-selection nil
3450 "Whether rotating the kill ring changes the window system selection.
3451 If non-nil, whenever the kill ring is rotated (usually via the
3452 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3453 to copy the new kill to the window system selection."
3458 (defun current-kill (n &optional do-not-move)
3459 "Rotate the yanking point by N places, and then return that kill.
3460 If N is zero and `interprogram-paste-function' is set to a
3461 function that returns a string or a list of strings, and if that
3462 function doesn't return nil, then that string (or list) is added
3463 to the front of the kill ring and the string (or first string in
3464 the list) is returned as the latest kill.
3466 If N is not zero, and if `yank-pop-change-selection' is
3467 non-nil, use `interprogram-cut-function' to transfer the
3468 kill at the new yank point into the window system selection.
3470 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3471 move the yanking point; just return the Nth kill forward."
3473 (let ((interprogram-paste (and (= n 0)
3474 interprogram-paste-function
3475 (funcall interprogram-paste-function))))
3476 (if interprogram-paste
3478 ;; Disable the interprogram cut function when we add the new
3479 ;; text to the kill ring, so Emacs doesn't try to own the
3480 ;; selection, with identical text.
3481 (let ((interprogram-cut-function nil))
3482 (if (listp interprogram-paste)
3483 (mapc 'kill-new (nreverse interprogram-paste))
3484 (kill-new interprogram-paste)))
3486 (or kill-ring (error "Kill ring is empty"))
3487 (let ((ARGth-kill-element
3488 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3492 (setq kill-ring-yank-pointer ARGth-kill-element)
3493 (when (and yank-pop-change-selection
3495 interprogram-cut-function)
3496 (funcall interprogram-cut-function (car ARGth-kill-element))))
3497 (car ARGth-kill-element)))))
3501 ;;;; Commands for manipulating the kill ring.
3503 (defcustom kill-read-only-ok nil
3504 "Non-nil means don't signal an error for killing read-only text."
3508 (defun kill-region (beg end &optional yank-handler)
3509 "Kill (\"cut\") text between point and mark.
3510 This deletes the text from the buffer and saves it in the kill ring.
3511 The command \\[yank] can retrieve it from there.
3512 \(If you want to save the region without killing it, use \\[kill-ring-save].)
3514 If you want to append the killed region to the last killed text,
3515 use \\[append-next-kill] before \\[kill-region].
3517 If the buffer is read-only, Emacs will beep and refrain from deleting
3518 the text, but put the text in the kill ring anyway. This means that
3519 you can use the killing commands to copy text from a read-only buffer.
3521 Lisp programs should use this function for killing text.
3522 (To delete text, use `delete-region'.)
3523 Supply two arguments, character positions indicating the stretch of text
3525 Any command that calls this function is a \"kill command\".
3526 If the previous command was also a kill command,
3527 the text killed this time appends to the text killed last time
3528 to make one entry in the kill ring."
3529 ;; Pass point first, then mark, because the order matters
3530 ;; when calling kill-append.
3531 (interactive (list (point) (mark)))
3532 (unless (and beg end)
3533 (error "The mark is not set now, so there is no region"))
3535 (let ((string (filter-buffer-substring beg end t)))
3536 (when string ;STRING is nil if BEG = END
3537 ;; Add that string to the kill ring, one way or another.
3538 (if (eq last-command 'kill-region)
3539 (kill-append string (< end beg) yank-handler)
3540 (kill-new string nil yank-handler)))
3541 (when (or string (eq last-command 'kill-region))
3542 (setq this-command 'kill-region))
3543 (setq deactivate-mark t)
3545 ((buffer-read-only text-read-only)
3546 ;; The code above failed because the buffer, or some of the characters
3547 ;; in the region, are read-only.
3548 ;; We should beep, in case the user just isn't aware of this.
3549 ;; However, there's no harm in putting
3550 ;; the region's text in the kill ring, anyway.
3551 (copy-region-as-kill beg end)
3552 ;; Set this-command now, so it will be set even if we get an error.
3553 (setq this-command 'kill-region)
3554 ;; This should barf, if appropriate, and give us the correct error.
3555 (if kill-read-only-ok
3556 (progn (message "Read only text copied to kill ring") nil)
3557 ;; Signal an error if the buffer is read-only.
3558 (barf-if-buffer-read-only)
3559 ;; If the buffer isn't read-only, the text is.
3560 (signal 'text-read-only (list (current-buffer)))))))
3561 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3563 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3564 ;; to get two copies of the text when the user accidentally types M-w and
3565 ;; then corrects it with the intended C-w.
3566 (defun copy-region-as-kill (beg end)
3567 "Save the region as if killed, but don't kill it.
3568 In Transient Mark mode, deactivate the mark.
3569 If `interprogram-cut-function' is non-nil, also save the text for a window
3570 system cut and paste.
3572 This command's old key binding has been given to `kill-ring-save'."
3574 (if (eq last-command 'kill-region)
3575 (kill-append (filter-buffer-substring beg end) (< end beg))
3576 (kill-new (filter-buffer-substring beg end)))
3577 (setq deactivate-mark t)
3580 (defun kill-ring-save (beg end)
3581 "Save the region as if killed, but don't kill it.
3582 In Transient Mark mode, deactivate the mark.
3583 If `interprogram-cut-function' is non-nil, also save the text for a window
3584 system cut and paste.
3586 If you want to append the killed line to the last killed text,
3587 use \\[append-next-kill] before \\[kill-ring-save].
3589 This command is similar to `copy-region-as-kill', except that it gives
3590 visual feedback indicating the extent of the region being copied."
3592 (copy-region-as-kill beg end)
3593 ;; This use of called-interactively-p is correct because the code it
3594 ;; controls just gives the user visual feedback.
3595 (if (called-interactively-p 'interactive)
3596 (indicate-copied-region)))
3598 (defun indicate-copied-region (&optional message-len)
3599 "Indicate that the region text has been copied interactively.
3600 If the mark is visible in the selected window, blink the cursor
3601 between point and mark if there is currently no active region
3604 If the mark lies outside the selected window, display an
3605 informative message containing a sample of the copied text. The
3606 optional argument MESSAGE-LEN, if non-nil, specifies the length
3607 of this sample text; it defaults to 40."
3608 (let ((mark (mark t))
3610 ;; Inhibit quitting so we can make a quit here
3611 ;; look like a C-g typed as a command.
3613 (if (pos-visible-in-window-p mark (selected-window))
3614 ;; Swap point-and-mark quickly so as to show the region that
3615 ;; was selected. Don't do it if the region is highlighted.
3616 (unless (and (region-active-p)
3617 (face-background 'region))
3618 ;; Swap point and mark.
3619 (set-marker (mark-marker) (point) (current-buffer))
3621 (sit-for blink-matching-delay)
3623 (set-marker (mark-marker) mark (current-buffer))
3625 ;; If user quit, deactivate the mark
3626 ;; as C-g would as a command.
3627 (and quit-flag mark-active
3629 (let ((len (min (abs (- mark point))
3630 (or message-len 40))))
3632 ;; Don't say "killed"; that is misleading.
3633 (message "Saved text until \"%s\""
3634 (buffer-substring-no-properties (- mark len) mark))
3635 (message "Saved text from \"%s\""
3636 (buffer-substring-no-properties mark (+ mark len))))))))
3638 (defun append-next-kill (&optional interactive)
3639 "Cause following command, if it kills, to append to previous kill.
3640 The argument is used for internal purposes; do not supply one."
3642 ;; We don't use (interactive-p), since that breaks kbd macros.
3645 (setq this-command 'kill-region)
3646 (message "If the next command is a kill, it will append"))
3647 (setq last-command 'kill-region)))
3651 (defcustom yank-handled-properties
3652 '((font-lock-face . yank-handle-font-lock-face-property)
3653 (category . yank-handle-category-property))
3654 "List of special text property handling conditions for yanking.
3655 Each element should have the form (PROP . FUN), where PROP is a
3656 property symbol and FUN is a function. When the `yank' command
3657 inserts text into the buffer, it scans the inserted text for
3658 stretches of text that have `eq' values of the text property
3659 PROP; for each such stretch of text, FUN is called with three
3660 arguments: the property's value in that text, and the start and
3661 end positions of the text.
3663 This is done prior to removing the properties specified by
3664 `yank-excluded-properties'."
3668 ;; This is actually used in subr.el but defcustom does not work there.
3669 (defcustom yank-excluded-properties
3670 '(category field follow-link fontified font-lock-face help-echo
3671 intangible invisible keymap local-map mouse-face read-only
3673 "Text properties to discard when yanking.
3674 The value should be a list of text properties to discard or t,
3675 which means to discard all text properties.
3677 See also `yank-handled-properties'."
3678 :type '(choice (const :tag "All" t) (repeat symbol))
3682 (defvar yank-window-start nil)
3683 (defvar yank-undo-function nil
3684 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3685 Function is called with two parameters, START and END corresponding to
3686 the value of the mark and point; it is guaranteed that START <= END.
3687 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3689 (defun yank-pop (&optional arg)
3690 "Replace just-yanked stretch of killed text with a different stretch.
3691 This command is allowed only immediately after a `yank' or a `yank-pop'.
3692 At such a time, the region contains a stretch of reinserted
3693 previously-killed text. `yank-pop' deletes that text and inserts in its
3694 place a different stretch of killed text.
3696 With no argument, the previous kill is inserted.
3697 With argument N, insert the Nth previous kill.
3698 If N is negative, this is a more recent kill.
3700 The sequence of kills wraps around, so that after the oldest one
3701 comes the newest one.
3703 When this command inserts killed text into the buffer, it honors
3704 `yank-excluded-properties' and `yank-handler' as described in the
3705 doc string for `insert-for-yank-1', which see."
3707 (if (not (eq last-command 'yank))
3708 (error "Previous command was not a yank"))
3709 (setq this-command 'yank)
3710 (unless arg (setq arg 1))
3711 (let ((inhibit-read-only t)
3712 (before (< (point) (mark t))))
3714 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3715 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3716 (setq yank-undo-function nil)
3717 (set-marker (mark-marker) (point) (current-buffer))
3718 (insert-for-yank (current-kill arg))
3719 ;; Set the window start back where it was in the yank command,
3721 (set-window-start (selected-window) yank-window-start t)
3723 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3724 ;; It is cleaner to avoid activation, even though the command
3725 ;; loop would deactivate the mark because we inserted text.
3726 (goto-char (prog1 (mark t)
3727 (set-marker (mark-marker) (point) (current-buffer))))))
3730 (defun yank (&optional arg)
3731 "Reinsert (\"paste\") the last stretch of killed text.
3732 More precisely, reinsert the most recent kill, which is the
3733 stretch of killed text most recently killed OR yanked. Put point
3734 at the end, and set mark at the beginning without activating it.
3735 With just \\[universal-argument] as argument, put point at beginning, and mark at end.
3736 With argument N, reinsert the Nth most recent kill.
3738 When this command inserts text into the buffer, it honors the
3739 `yank-handled-properties' and `yank-excluded-properties'
3740 variables, and the `yank-handler' text property. See
3741 `insert-for-yank-1' for details.
3743 See also the command `yank-pop' (\\[yank-pop])."
3745 (setq yank-window-start (window-start))
3746 ;; If we don't get all the way thru, make last-command indicate that
3747 ;; for the following command.
3748 (setq this-command t)
3750 (insert-for-yank (current-kill (cond
3755 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3756 ;; It is cleaner to avoid activation, even though the command
3757 ;; loop would deactivate the mark because we inserted text.
3758 (goto-char (prog1 (mark t)
3759 (set-marker (mark-marker) (point) (current-buffer)))))
3760 ;; If we do get all the way thru, make this-command indicate that.
3761 (if (eq this-command t)
3762 (setq this-command 'yank))
3765 (defun rotate-yank-pointer (arg)
3766 "Rotate the yanking point in the kill ring.
3767 With ARG, rotate that many kills forward (or backward, if negative)."
3771 ;; Some kill commands.
3773 ;; Internal subroutine of delete-char
3774 (defun kill-forward-chars (arg)
3775 (if (listp arg) (setq arg (car arg)))
3776 (if (eq arg '-) (setq arg -1))
3777 (kill-region (point) (+ (point) arg)))
3779 ;; Internal subroutine of backward-delete-char
3780 (defun kill-backward-chars (arg)
3781 (if (listp arg) (setq arg (car arg)))
3782 (if (eq arg '-) (setq arg -1))
3783 (kill-region (point) (- (point) arg)))
3785 (defcustom backward-delete-char-untabify-method 'untabify
3786 "The method for untabifying when deleting backward.
3787 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3788 `hungry' -- delete all whitespace, both tabs and spaces;
3789 `all' -- delete all whitespace, including tabs, spaces and newlines;
3790 nil -- just delete one character."
3791 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3795 (defun backward-delete-char-untabify (arg &optional killp)
3796 "Delete characters backward, changing tabs into spaces.
3797 The exact behavior depends on `backward-delete-char-untabify-method'.
3798 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3799 Interactively, ARG is the prefix arg (default 1)
3800 and KILLP is t if a prefix arg was specified."
3801 (interactive "*p\nP")
3802 (when (eq backward-delete-char-untabify-method 'untabify)
3805 (while (and (> count 0) (not (bobp)))
3806 (if (= (preceding-char) ?\t)
3807 (let ((col (current-column)))
3809 (setq col (- col (current-column)))
3810 (insert-char ?\s col)
3813 (setq count (1- count))))))
3814 (let* ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
3815 ((eq backward-delete-char-untabify-method 'all)
3818 (let* ((oldpt (point))
3819 (wh (- oldpt (save-excursion
3820 (skip-chars-backward skip)
3821 (constrain-to-field nil oldpt)))))
3822 (+ arg (if (zerop wh) 0 (1- wh))))
3824 ;; Avoid warning about delete-backward-char
3825 (with-no-warnings (delete-backward-char n killp))))
3827 (defun zap-to-char (arg char)
3828 "Kill up to and including ARGth occurrence of CHAR.
3829 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3830 Goes backward if ARG is negative; error if CHAR not found."
3831 (interactive (list (prefix-numeric-value current-prefix-arg)
3832 (read-char "Zap to char: " t)))
3833 ;; Avoid "obsolete" warnings for translation-table-for-input.
3835 (if (char-table-p translation-table-for-input)
3836 (setq char (or (aref translation-table-for-input char) char))))
3837 (kill-region (point) (progn
3838 (search-forward (char-to-string char) nil nil arg)
3841 ;; kill-line and its subroutines.
3843 (defcustom kill-whole-line nil
3844 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3848 (defun kill-line (&optional arg)
3849 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3850 With prefix argument ARG, kill that many lines from point.
3851 Negative arguments kill lines backward.
3852 With zero argument, kills the text before point on the current line.
3854 When calling from a program, nil means \"no arg\",
3855 a number counts as a prefix arg.
3857 To kill a whole line, when point is not at the beginning, type \
3858 \\[move-beginning-of-line] \\[kill-line] \\[kill-line].
3860 If `show-trailing-whitespace' is non-nil, this command will just
3861 kill the rest of the current line, even if there are only
3864 If option `kill-whole-line' is non-nil, then this command kills the whole line
3865 including its terminating newline, when used at the beginning of a line
3866 with no argument. As a consequence, you can always kill a whole line
3867 by typing \\[move-beginning-of-line] \\[kill-line].
3869 If you want to append the killed line to the last killed text,
3870 use \\[append-next-kill] before \\[kill-line].
3872 If the buffer is read-only, Emacs will beep and refrain from deleting
3873 the line, but put the line in the kill ring anyway. This means that
3874 you can use this command to copy text from a read-only buffer.
3875 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3878 (kill-region (point)
3879 ;; It is better to move point to the other end of the kill
3880 ;; before killing. That way, in a read-only buffer, point
3881 ;; moves across the text that is copied to the kill ring.
3882 ;; The choice has no effect on undo now that undo records
3883 ;; the value of point from before the command was run.
3886 (forward-visible-line (prefix-numeric-value arg))
3888 (signal 'end-of-buffer nil))
3891 (end-of-visible-line) (point))))
3892 (if (or (save-excursion
3893 ;; If trailing whitespace is visible,
3894 ;; don't treat it as nothing.
3895 (unless show-trailing-whitespace
3896 (skip-chars-forward " \t" end))
3898 (and kill-whole-line (bolp)))
3899 (forward-visible-line 1)
3903 (defun kill-whole-line (&optional arg)
3905 With prefix ARG, kill that many lines starting from the current line.
3906 If ARG is negative, kill backward. Also kill the preceding newline.
3907 \(This is meant to make \\[repeat] work well with negative arguments.\)
3908 If ARG is zero, kill current line but exclude the trailing newline."
3910 (or arg (setq arg 1))
3911 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3912 (signal 'end-of-buffer nil))
3913 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3914 (signal 'beginning-of-buffer nil))
3915 (unless (eq last-command 'kill-region)
3917 (setq last-command 'kill-region))
3919 ;; We need to kill in two steps, because the previous command
3920 ;; could have been a kill command, in which case the text
3921 ;; before point needs to be prepended to the current kill
3922 ;; ring entry and the text after point appended. Also, we
3923 ;; need to use save-excursion to avoid copying the same text
3924 ;; twice to the kill ring in read-only buffers.
3926 (kill-region (point) (progn (forward-visible-line 0) (point))))
3927 (kill-region (point) (progn (end-of-visible-line) (point))))
3930 (kill-region (point) (progn (end-of-visible-line) (point))))
3931 (kill-region (point)
3932 (progn (forward-visible-line (1+ arg))
3933 (unless (bobp) (backward-char))
3937 (kill-region (point) (progn (forward-visible-line 0) (point))))
3938 (kill-region (point)
3939 (progn (forward-visible-line arg) (point))))))
3941 (defun forward-visible-line (arg)
3942 "Move forward by ARG lines, ignoring currently invisible newlines only.
3943 If ARG is negative, move backward -ARG lines.
3944 If ARG is zero, move to the beginning of the current line."
3949 (or (zerop (forward-line 1))
3950 (signal 'end-of-buffer nil))
3951 ;; If the newline we just skipped is invisible,
3954 (get-char-property (1- (point)) 'invisible)))
3955 (if (if (eq buffer-invisibility-spec t)
3957 (or (memq prop buffer-invisibility-spec)
3958 (assq prop buffer-invisibility-spec)))
3959 (setq arg (1+ arg))))
3960 (setq arg (1- arg)))
3961 ;; If invisible text follows, and it is a number of complete lines,
3963 (let ((opoint (point)))
3964 (while (and (not (eobp))
3966 (get-char-property (point) 'invisible)))
3967 (if (eq buffer-invisibility-spec t)
3969 (or (memq prop buffer-invisibility-spec)
3970 (assq prop buffer-invisibility-spec)))))
3972 (if (get-text-property (point) 'invisible)
3973 (or (next-single-property-change (point) 'invisible)
3975 (next-overlay-change (point)))))
3977 (goto-char opoint))))
3979 (while (or first (<= arg 0))
3982 (or (zerop (forward-line -1))
3983 (signal 'beginning-of-buffer nil)))
3984 ;; If the newline we just moved to is invisible,
3988 (get-char-property (1- (point)) 'invisible)))
3989 (unless (if (eq buffer-invisibility-spec t)
3991 (or (memq prop buffer-invisibility-spec)
3992 (assq prop buffer-invisibility-spec)))
3993 (setq arg (1+ arg)))))
3995 ;; If invisible text follows, and it is a number of complete lines,
3997 (let ((opoint (point)))
3998 (while (and (not (bobp))
4000 (get-char-property (1- (point)) 'invisible)))
4001 (if (eq buffer-invisibility-spec t)
4003 (or (memq prop buffer-invisibility-spec)
4004 (assq prop buffer-invisibility-spec)))))
4006 (if (get-text-property (1- (point)) 'invisible)
4007 (or (previous-single-property-change (point) 'invisible)
4009 (previous-overlay-change (point)))))
4011 (goto-char opoint)))))
4012 ((beginning-of-buffer end-of-buffer)
4015 (defun end-of-visible-line ()
4016 "Move to end of current visible line."
4018 ;; If the following character is currently invisible,
4019 ;; skip all characters with that same `invisible' property value,
4020 ;; then find the next newline.
4021 (while (and (not (eobp))
4023 (skip-chars-forward "^\n")
4025 (get-char-property (point) 'invisible)))
4026 (if (eq buffer-invisibility-spec t)
4028 (or (memq prop buffer-invisibility-spec)
4029 (assq prop buffer-invisibility-spec))))))
4030 (skip-chars-forward "^\n")
4031 (if (get-text-property (point) 'invisible)
4032 (goto-char (or (next-single-property-change (point) 'invisible)
4034 (goto-char (next-overlay-change (point))))
4037 (defun insert-buffer (buffer)
4038 "Insert after point the contents of BUFFER.
4039 Puts mark after the inserted text.
4040 BUFFER may be a buffer or a buffer name.
4042 This function is meant for the user to run interactively.
4043 Don't call it from programs: use `insert-buffer-substring' instead!"
4047 (barf-if-buffer-read-only)
4048 (read-buffer "Insert buffer: "
4049 (if (eq (selected-window) (next-window (selected-window)))
4050 (other-buffer (current-buffer))
4051 (window-buffer (next-window (selected-window))))
4055 (insert-buffer-substring (get-buffer buffer))
4059 (defun append-to-buffer (buffer start end)
4060 "Append to specified buffer the text of the region.
4061 It is inserted into that buffer before its point.
4063 When calling from a program, give three arguments:
4064 BUFFER (or buffer name), START and END.
4065 START and END specify the portion of the current buffer to be copied."
4067 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
4068 (region-beginning) (region-end)))
4069 (let* ((oldbuf (current-buffer))
4070 (append-to (get-buffer-create buffer))
4071 (windows (get-buffer-window-list append-to t t))
4074 (with-current-buffer append-to
4075 (setq point (point))
4076 (barf-if-buffer-read-only)
4077 (insert-buffer-substring oldbuf start end)
4078 (dolist (window windows)
4079 (when (= (window-point window) point)
4080 (set-window-point window (point))))))))
4082 (defun prepend-to-buffer (buffer start end)
4083 "Prepend to specified buffer the text of the region.
4084 It is inserted into that buffer after its point.
4086 When calling from a program, give three arguments:
4087 BUFFER (or buffer name), START and END.
4088 START and END specify the portion of the current buffer to be copied."
4089 (interactive "BPrepend to buffer: \nr")
4090 (let ((oldbuf (current-buffer)))
4091 (with-current-buffer (get-buffer-create buffer)
4092 (barf-if-buffer-read-only)
4094 (insert-buffer-substring oldbuf start end)))))
4096 (defun copy-to-buffer (buffer start end)
4097 "Copy to specified buffer the text of the region.
4098 It is inserted into that buffer, replacing existing text there.
4100 When calling from a program, give three arguments:
4101 BUFFER (or buffer name), START and END.
4102 START and END specify the portion of the current buffer to be copied."
4103 (interactive "BCopy to buffer: \nr")
4104 (let ((oldbuf (current-buffer)))
4105 (with-current-buffer (get-buffer-create buffer)
4106 (barf-if-buffer-read-only)
4109 (insert-buffer-substring oldbuf start end)))))
4111 (put 'mark-inactive 'error-conditions '(mark-inactive error))
4112 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
4114 (defvar activate-mark-hook nil
4115 "Hook run when the mark becomes active.
4116 It is also run at the end of a command, if the mark is active and
4117 it is possible that the region may have changed.")
4119 (defvar deactivate-mark-hook nil
4120 "Hook run when the mark becomes inactive.")
4122 (defun mark (&optional force)
4123 "Return this buffer's mark value as integer, or nil if never set.
4125 In Transient Mark mode, this function signals an error if
4126 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4127 or the argument FORCE is non-nil, it disregards whether the mark
4128 is active, and returns an integer or nil in the usual way.
4130 If you are using this in an editing command, you are most likely making
4131 a mistake; see the documentation of `set-mark'."
4132 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
4133 (marker-position (mark-marker))
4134 (signal 'mark-inactive nil)))
4136 (defsubst deactivate-mark (&optional force)
4137 "Deactivate the mark.
4138 If Transient Mark mode is disabled, this function normally does
4139 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4141 Deactivating the mark sets `mark-active' to nil, updates the
4142 primary selection according to `select-active-regions', and runs
4143 `deactivate-mark-hook'.
4145 If Transient Mark mode was temporarily enabled, reset the value
4146 of the variable `transient-mark-mode'; if this causes Transient
4147 Mark mode to be disabled, don't change `mark-active' to nil or
4148 run `deactivate-mark-hook'."
4149 (when (or transient-mark-mode force)
4150 (when (and (if (eq select-active-regions 'only)
4151 (eq (car-safe transient-mark-mode) 'only)
4152 select-active-regions)
4154 (display-selections-p))
4155 ;; The var `saved-region-selection', if non-nil, is the text in
4156 ;; the region prior to the last command modifying the buffer.
4157 ;; Set the selection to that, or to the current region.
4158 (cond (saved-region-selection
4159 (x-set-selection 'PRIMARY saved-region-selection)
4160 (setq saved-region-selection nil))
4161 ;; If another program has acquired the selection, region
4162 ;; deactivation should not clobber it (Bug#11772).
4163 ((and (/= (region-beginning) (region-end))
4164 (or (x-selection-owner-p 'PRIMARY)
4165 (null (x-selection-exists-p 'PRIMARY))))
4166 (x-set-selection 'PRIMARY
4167 (buffer-substring (region-beginning)
4169 (if (and (null force)
4170 (or (eq transient-mark-mode 'lambda)
4171 (and (eq (car-safe transient-mark-mode) 'only)
4172 (null (cdr transient-mark-mode)))))
4173 ;; When deactivating a temporary region, don't change
4174 ;; `mark-active' or run `deactivate-mark-hook'.
4175 (setq transient-mark-mode nil)
4176 (if (eq (car-safe transient-mark-mode) 'only)
4177 (setq transient-mark-mode (cdr transient-mark-mode)))
4178 (setq mark-active nil)
4179 (run-hooks 'deactivate-mark-hook))))
4181 (defun activate-mark ()
4182 "Activate the mark."
4184 (setq mark-active t)
4185 (unless transient-mark-mode
4186 (setq transient-mark-mode 'lambda))
4187 (run-hooks 'activate-mark-hook)))
4189 (defun set-mark (pos)
4190 "Set this buffer's mark to POS. Don't use this function!
4191 That is to say, don't use this function unless you want
4192 the user to see that the mark has moved, and you want the previous
4193 mark position to be lost.
4195 Normally, when a new mark is set, the old one should go on the stack.
4196 This is why most applications should use `push-mark', not `set-mark'.
4198 Novice Emacs Lisp programmers often try to use the mark for the wrong
4199 purposes. The mark saves a location for the user's convenience.
4200 Most editing commands should not alter the mark.
4201 To remember a location for internal use in the Lisp program,
4202 store it in a Lisp variable. Example:
4204 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4208 (setq mark-active t)
4209 (run-hooks 'activate-mark-hook)
4210 (set-marker (mark-marker) pos (current-buffer)))
4211 ;; Normally we never clear mark-active except in Transient Mark mode.
4212 ;; But when we actually clear out the mark value too, we must
4213 ;; clear mark-active in any mode.
4215 (set-marker (mark-marker) nil)))
4217 (defcustom use-empty-active-region nil
4218 "Whether \"region-aware\" commands should act on empty regions.
4219 If nil, region-aware commands treat empty regions as inactive.
4220 If non-nil, region-aware commands treat the region as active as
4221 long as the mark is active, even if the region is empty.
4223 Region-aware commands are those that act on the region if it is
4224 active and Transient Mark mode is enabled, and on the text near
4228 :group 'editing-basics)
4230 (defun use-region-p ()
4231 "Return t if the region is active and it is appropriate to act on it.
4232 This is used by commands that act specially on the region under
4233 Transient Mark mode.
4235 The return value is t if Transient Mark mode is enabled and the
4236 mark is active; furthermore, if `use-empty-active-region' is nil,
4237 the region must not be empty. Otherwise, the return value is nil.
4239 For some commands, it may be appropriate to ignore the value of
4240 `use-empty-active-region'; in that case, use `region-active-p'."
4241 (and (region-active-p)
4242 (or use-empty-active-region (> (region-end) (region-beginning)))))
4244 (defun region-active-p ()
4245 "Return t if Transient Mark mode is enabled and the mark is active.
4247 Some commands act specially on the region when Transient Mark
4248 mode is enabled. Usually, such commands should use
4249 `use-region-p' instead of this function, because `use-region-p'
4250 also checks the value of `use-empty-active-region'."
4251 (and transient-mark-mode mark-active))
4253 (defvar mark-ring nil
4254 "The list of former marks of the current buffer, most recent first.")
4255 (make-variable-buffer-local 'mark-ring)
4256 (put 'mark-ring 'permanent-local t)
4258 (defcustom mark-ring-max 16
4259 "Maximum size of mark ring. Start discarding off end if gets this big."
4261 :group 'editing-basics)
4263 (defvar global-mark-ring nil
4264 "The list of saved global marks, most recent first.")
4266 (defcustom global-mark-ring-max 16
4267 "Maximum size of global mark ring. \
4268 Start discarding off end if gets this big."
4270 :group 'editing-basics)
4272 (defun pop-to-mark-command ()
4273 "Jump to mark, and pop a new position for mark off the ring.
4274 \(Does not affect global mark ring\)."
4277 (error "No mark set in this buffer")
4278 (if (= (point) (mark t))
4279 (message "Mark popped"))
4280 (goto-char (mark t))
4283 (defun push-mark-command (arg &optional nomsg)
4284 "Set mark at where point is.
4285 If no prefix ARG and mark is already set there, just activate it.
4286 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4288 (let ((mark (marker-position (mark-marker))))
4289 (if (or arg (null mark) (/= mark (point)))
4290 (push-mark nil nomsg t)
4291 (setq mark-active t)
4292 (run-hooks 'activate-mark-hook)
4294 (message "Mark activated")))))
4296 (defcustom set-mark-command-repeat-pop nil
4297 "Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
4298 That means that C-u \\[set-mark-command] \\[set-mark-command]
4299 will pop the mark twice, and
4300 C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
4301 will pop the mark three times.
4303 A value of nil means \\[set-mark-command]'s behavior does not change
4304 after C-u \\[set-mark-command]."
4306 :group 'editing-basics)
4308 (defun set-mark-command (arg)
4309 "Set the mark where point is, or jump to the mark.
4310 Setting the mark also alters the region, which is the text
4311 between point and mark; this is the closest equivalent in
4312 Emacs to what some editors call the \"selection\".
4314 With no prefix argument, set the mark at point, and push the
4315 old mark position on local mark ring. Also push the old mark on
4316 global mark ring, if the previous mark was set in another buffer.
4318 When Transient Mark Mode is off, immediately repeating this
4319 command activates `transient-mark-mode' temporarily.
4321 With prefix argument \(e.g., \\[universal-argument] \\[set-mark-command]\), \
4322 jump to the mark, and set the mark from
4323 position popped off the local mark ring \(this does not affect the global
4324 mark ring\). Use \\[pop-global-mark] to jump to a mark popped off the global
4325 mark ring \(see `pop-global-mark'\).
4327 If `set-mark-command-repeat-pop' is non-nil, repeating
4328 the \\[set-mark-command] command with no prefix argument pops the next position
4329 off the local (or global) mark ring and jumps there.
4331 With \\[universal-argument] \\[universal-argument] as prefix
4332 argument, unconditionally set mark where point is, even if
4333 `set-mark-command-repeat-pop' is non-nil.
4335 Novice Emacs Lisp programmers often try to use the mark for the wrong
4336 purposes. See the documentation of `set-mark' for more information."
4338 (cond ((eq transient-mark-mode 'lambda)
4339 (setq transient-mark-mode nil))
4340 ((eq (car-safe transient-mark-mode) 'only)
4343 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4344 (push-mark-command nil))
4345 ((not (eq this-command 'set-mark-command))
4347 (pop-to-mark-command)
4348 (push-mark-command t)))
4349 ((and set-mark-command-repeat-pop
4350 (eq last-command 'pop-to-mark-command))
4351 (setq this-command 'pop-to-mark-command)
4352 (pop-to-mark-command))
4353 ((and set-mark-command-repeat-pop
4354 (eq last-command 'pop-global-mark)
4356 (setq this-command 'pop-global-mark)
4359 (setq this-command 'pop-to-mark-command)
4360 (pop-to-mark-command))
4361 ((eq last-command 'set-mark-command)
4362 (if (region-active-p)
4365 (message "Mark deactivated"))
4367 (message "Mark activated")))
4369 (push-mark-command nil))))
4371 (defun push-mark (&optional location nomsg activate)
4372 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4373 If the last global mark pushed was not in the current buffer,
4374 also push LOCATION on the global mark ring.
4375 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4377 Novice Emacs Lisp programmers often try to use the mark for the wrong
4378 purposes. See the documentation of `set-mark' for more information.
4380 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4381 (unless (null (mark t))
4382 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4383 (when (> (length mark-ring) mark-ring-max)
4384 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4385 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4386 (set-marker (mark-marker) (or location (point)) (current-buffer))
4387 ;; Now push the mark on the global mark ring.
4388 (if (and global-mark-ring
4389 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4390 ;; The last global mark pushed was in this same buffer.
4391 ;; Don't push another one.
4393 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4394 (when (> (length global-mark-ring) global-mark-ring-max)
4395 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4396 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4397 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4398 (message "Mark set"))
4399 (if (or activate (not transient-mark-mode))
4400 (set-mark (mark t)))
4404 "Pop off mark ring into the buffer's actual mark.
4405 Does not set point. Does nothing if mark ring is empty."
4407 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4408 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4409 (move-marker (car mark-ring) nil)
4410 (if (null (mark t)) (ding))
4411 (setq mark-ring (cdr mark-ring)))
4414 (define-obsolete-function-alias
4415 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4416 (defun exchange-point-and-mark (&optional arg)
4417 "Put the mark where point is now, and point where the mark is now.
4418 This command works even when the mark is not active,
4419 and it reactivates the mark.
4421 If Transient Mark mode is on, a prefix ARG deactivates the mark
4422 if it is active, and otherwise avoids reactivating it. If
4423 Transient Mark mode is off, a prefix ARG enables Transient Mark
4426 (let ((omark (mark t))
4427 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4429 (error "No mark set in this buffer"))
4433 (cond (temp-highlight
4434 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4435 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4436 (not (or arg (region-active-p))))
4438 (t (activate-mark)))
4441 (defcustom shift-select-mode t
4442 "When non-nil, shifted motion keys activate the mark momentarily.
4444 While the mark is activated in this way, any shift-translated point
4445 motion key extends the region, and if Transient Mark mode was off, it
4446 is temporarily turned on. Furthermore, the mark will be deactivated
4447 by any subsequent point motion key that was not shift-translated, or
4448 by any action that normally deactivates the mark in Transient Mark mode.
4450 See `this-command-keys-shift-translated' for the meaning of
4453 :group 'editing-basics)
4455 (defun handle-shift-selection ()
4456 "Activate/deactivate mark depending on invocation thru shift translation.
4457 This function is called by `call-interactively' when a command
4458 with a `^' character in its `interactive' spec is invoked, before
4459 running the command itself.
4461 If `shift-select-mode' is enabled and the command was invoked
4462 through shift translation, set the mark and activate the region
4463 temporarily, unless it was already set in this way. See
4464 `this-command-keys-shift-translated' for the meaning of shift
4467 Otherwise, if the region has been activated temporarily,
4468 deactivate it, and restore the variable `transient-mark-mode' to
4470 (cond ((and shift-select-mode this-command-keys-shift-translated)
4471 (unless (and mark-active
4472 (eq (car-safe transient-mark-mode) 'only))
4473 (setq transient-mark-mode
4475 (unless (eq transient-mark-mode 'lambda)
4476 transient-mark-mode)))
4477 (push-mark nil nil t)))
4478 ((eq (car-safe transient-mark-mode) 'only)
4479 (setq transient-mark-mode (cdr transient-mark-mode))
4480 (deactivate-mark))))
4482 (define-minor-mode transient-mark-mode
4483 "Toggle Transient Mark mode.
4484 With a prefix argument ARG, enable Transient Mark mode if ARG is
4485 positive, and disable it otherwise. If called from Lisp, enable
4486 Transient Mark mode if ARG is omitted or nil.
4488 Transient Mark mode is a global minor mode. When enabled, the
4489 region is highlighted whenever the mark is active. The mark is
4490 \"deactivated\" by changing the buffer, and after certain other
4491 operations that set the mark but whose main purpose is something
4492 else--for example, incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
4494 You can also deactivate the mark by typing \\[keyboard-quit] or
4495 \\[keyboard-escape-quit].
4497 Many commands change their behavior when Transient Mark mode is
4498 in effect and the mark is active, by acting on the region instead
4499 of their usual default part of the buffer's text. Examples of
4500 such commands include \\[comment-dwim], \\[flush-lines], \\[keep-lines],
4501 \\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
4502 To see the documentation of commands which are sensitive to the
4503 Transient Mark mode, invoke \\[apropos-documentation] and type \"transient\"
4504 or \"mark.*active\" at the prompt."
4506 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4507 :variable transient-mark-mode)
4509 (defvar widen-automatically t
4510 "Non-nil means it is ok for commands to call `widen' when they want to.
4511 Some commands will do this in order to go to positions outside
4512 the current accessible part of the buffer.
4514 If `widen-automatically' is nil, these commands will do something else
4515 as a fallback, and won't change the buffer bounds.")
4517 (defvar non-essential nil
4518 "Whether the currently executing code is performing an essential task.
4519 This variable should be non-nil only when running code which should not
4520 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4521 user for a password when we are simply scanning a set of files in the
4522 background or displaying possible completions before the user even asked
4525 (defun pop-global-mark ()
4526 "Pop off global mark ring and jump to the top location."
4528 ;; Pop entries which refer to non-existent buffers.
4529 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4530 (setq global-mark-ring (cdr global-mark-ring)))
4531 (or global-mark-ring
4532 (error "No global mark set"))
4533 (let* ((marker (car global-mark-ring))
4534 (buffer (marker-buffer marker))
4535 (position (marker-position marker)))
4536 (setq global-mark-ring (nconc (cdr global-mark-ring)
4537 (list (car global-mark-ring))))
4539 (or (and (>= position (point-min))
4540 (<= position (point-max)))
4541 (if widen-automatically
4543 (error "Global mark position is outside accessible part of buffer")))
4544 (goto-char position)
4545 (switch-to-buffer buffer)))
4547 (defcustom next-line-add-newlines nil
4548 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4551 :group 'editing-basics)
4553 (defun next-line (&optional arg try-vscroll)
4554 "Move cursor vertically down ARG lines.
4555 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4556 If there is no character in the target line exactly under the current column,
4557 the cursor is positioned after the character in that line which spans this
4558 column, or at the end of the line if it is not long enough.
4559 If there is no line in the buffer after this one, behavior depends on the
4560 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4561 to create a line, and moves the cursor to that line. Otherwise it moves the
4562 cursor to the end of the buffer.
4564 If the variable `line-move-visual' is non-nil, this command moves
4565 by display lines. Otherwise, it moves by buffer lines, without
4566 taking variable-width characters or continued lines into account.
4568 The command \\[set-goal-column] can be used to create
4569 a semipermanent goal column for this command.
4570 Then instead of trying to move exactly vertically (or as close as possible),
4571 this command moves to the specified goal column (or as close as possible).
4572 The goal column is stored in the variable `goal-column', which is nil
4573 when there is no goal column. Note that setting `goal-column'
4574 overrides `line-move-visual' and causes this command to move by buffer
4575 lines rather than by display lines.
4577 If you are thinking of using this in a Lisp program, consider
4578 using `forward-line' instead. It is usually easier to use
4579 and more reliable (no dependence on goal column, etc.)."
4580 (interactive "^p\np")
4581 (or arg (setq arg 1))
4582 (if (and next-line-add-newlines (= arg 1))
4583 (if (save-excursion (end-of-line) (eobp))
4584 ;; When adding a newline, don't expand an abbrev.
4585 (let ((abbrev-mode nil))
4587 (insert (if use-hard-newlines hard-newline "\n")))
4588 (line-move arg nil nil try-vscroll))
4589 (if (called-interactively-p 'interactive)
4591 (line-move arg nil nil try-vscroll)
4592 ((beginning-of-buffer end-of-buffer)
4593 (signal (car err) (cdr err))))
4594 (line-move arg nil nil try-vscroll)))
4597 (defun previous-line (&optional arg try-vscroll)
4598 "Move cursor vertically up ARG lines.
4599 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4600 If there is no character in the target line exactly over the current column,
4601 the cursor is positioned after the character in that line which spans this
4602 column, or at the end of the line if it is not long enough.
4604 If the variable `line-move-visual' is non-nil, this command moves
4605 by display lines. Otherwise, it moves by buffer lines, without
4606 taking variable-width characters or continued lines into account.
4608 The command \\[set-goal-column] can be used to create
4609 a semipermanent goal column for this command.
4610 Then instead of trying to move exactly vertically (or as close as possible),
4611 this command moves to the specified goal column (or as close as possible).
4612 The goal column is stored in the variable `goal-column', which is nil
4613 when there is no goal column. Note that setting `goal-column'
4614 overrides `line-move-visual' and causes this command to move by buffer
4615 lines rather than by display lines.
4617 If you are thinking of using this in a Lisp program, consider using
4618 `forward-line' with a negative argument instead. It is usually easier
4619 to use and more reliable (no dependence on goal column, etc.)."
4620 (interactive "^p\np")
4621 (or arg (setq arg 1))
4622 (if (called-interactively-p 'interactive)
4624 (line-move (- arg) nil nil try-vscroll)
4625 ((beginning-of-buffer end-of-buffer)
4626 (signal (car err) (cdr err))))
4627 (line-move (- arg) nil nil try-vscroll))
4630 (defcustom track-eol nil
4631 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4632 This means moving to the end of each line moved onto.
4633 The beginning of a blank line does not count as the end of a line.
4634 This has no effect when the variable `line-move-visual' is non-nil."
4636 :group 'editing-basics)
4638 (defcustom goal-column nil
4639 "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.
4640 A non-nil setting overrides the variable `line-move-visual', which see."
4641 :type '(choice integer
4642 (const :tag "None" nil))
4643 :group 'editing-basics)
4644 (make-variable-buffer-local 'goal-column)
4646 (defvar temporary-goal-column 0
4647 "Current goal column for vertical motion.
4648 It is the column where point was at the start of the current run
4649 of vertical motion commands.
4651 When moving by visual lines via the function `line-move-visual', it is a cons
4652 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4653 divided by the default column width, and HSCROLL is the number of
4654 columns by which window is scrolled from left margin.
4656 When the `track-eol' feature is doing its job, the value is
4657 `most-positive-fixnum'.")
4659 (defcustom line-move-ignore-invisible t
4660 "Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
4661 Outline mode sets this."
4663 :group 'editing-basics)
4665 (defcustom line-move-visual t
4666 "When non-nil, `line-move' moves point by visual lines.
4667 This movement is based on where the cursor is displayed on the
4668 screen, instead of relying on buffer contents alone. It takes
4669 into account variable-width characters and line continuation.
4670 If nil, `line-move' moves point by logical lines.
4671 A non-nil setting of `goal-column' overrides the value of this variable
4672 and forces movement by logical lines.
4673 A window that is horizontally scrolled also forces movement by logical
4676 :group 'editing-basics
4679 ;; Returns non-nil if partial move was done.
4680 (defun line-move-partial (arg noerror to-end)
4682 ;; Move backward (up).
4683 ;; If already vscrolled, reduce vscroll
4684 (let ((vs (window-vscroll nil t)))
4685 (when (> vs (frame-char-height))
4686 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4688 ;; Move forward (down).
4689 (let* ((lh (window-line-height -1))
4695 (>= rbot (frame-char-height))
4696 (<= ypos (- (frame-char-height))))
4698 (let ((wend (pos-visible-in-window-p t nil t)))
4699 (setq rbot (nth 3 wend)
4700 vpos (nth 5 wend))))
4702 ;; If last line of window is fully visible, move forward.
4703 ((or (null rbot) (= rbot 0))
4705 ;; If cursor is not in the bottom scroll margin, move forward.
4708 (or (nth 1 (window-line-height))
4709 (let ((ppos (posn-at-point)))
4710 (cdr (or (posn-actual-col-row ppos)
4711 (posn-col-row ppos))))))
4712 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4714 ;; When already vscrolled, we vscroll some more if we can,
4715 ;; or clear vscroll and move forward at end of tall image.
4716 ((> (setq vs (window-vscroll nil t)) 0)
4718 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4719 ;; If cursor just entered the bottom scroll margin, move forward,
4720 ;; but also vscroll one line so redisplay won't recenter.
4722 (= py (min (- (window-text-height) scroll-margin 1)
4724 (set-window-vscroll nil (frame-char-height) t)
4725 (line-move-1 arg noerror to-end)
4727 ;; If there are lines above the last line, scroll-up one line.
4731 ;; Finally, start vscroll.
4733 (set-window-vscroll nil (frame-char-height) t)))))))
4736 ;; This is like line-move-1 except that it also performs
4737 ;; vertical scrolling of tall images if appropriate.
4738 ;; That is not really a clean thing to do, since it mixes
4739 ;; scrolling with cursor motion. But so far we don't have
4740 ;; a cleaner solution to the problem of making C-n do something
4741 ;; useful given a tall image.
4742 (defun line-move (arg &optional noerror to-end try-vscroll)
4745 (unless (and auto-window-vscroll try-vscroll
4746 ;; Only vscroll for single line moves
4748 ;; Under scroll-conservatively, the display engine
4749 ;; does this better.
4750 (zerop scroll-conservatively)
4751 ;; But don't vscroll in a keyboard macro.
4752 (not defining-kbd-macro)
4753 (not executing-kbd-macro)
4754 (line-move-partial arg noerror to-end))
4755 (set-window-vscroll nil 0 t)
4756 (if (and line-move-visual
4757 ;; Display-based column are incompatible with goal-column.
4759 ;; When the text in the window is scrolled to the left,
4760 ;; display-based motion doesn't make sense (because each
4761 ;; logical line occupies exactly one screen line).
4762 (not (> (window-hscroll) 0)))
4763 (line-move-visual arg noerror)
4764 (line-move-1 arg noerror to-end)))))
4766 ;; Display-based alternative to line-move-1.
4767 ;; Arg says how many lines to move. The value is t if we can move the
4768 ;; specified number of lines.
4769 (defun line-move-visual (arg &optional noerror)
4770 (let ((opoint (point))
4771 (hscroll (window-hscroll))
4773 ;; Check if the previous command was a line-motion command, or if
4774 ;; we were called from some other command.
4775 (if (and (consp temporary-goal-column)
4776 (memq last-command `(next-line previous-line ,this-command)))
4777 ;; If so, there's no need to reset `temporary-goal-column',
4778 ;; but we may need to hscroll.
4779 (if (or (/= (cdr temporary-goal-column) hscroll)
4780 (> (cdr temporary-goal-column) 0))
4781 (setq target-hscroll (cdr temporary-goal-column)))
4782 ;; Otherwise, we should reset `temporary-goal-column'.
4783 (let ((posn (posn-at-point)))
4785 ;; Handle the `overflow-newline-into-fringe' case:
4786 ((eq (nth 1 posn) 'right-fringe)
4787 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4788 ((car (posn-x-y posn))
4789 (setq temporary-goal-column
4790 (cons (/ (float (car (posn-x-y posn)))
4791 (frame-char-width)) hscroll))))))
4793 (set-window-hscroll (selected-window) target-hscroll))
4794 (or (and (= (vertical-motion
4795 (cons (or goal-column
4796 (if (consp temporary-goal-column)
4797 (car temporary-goal-column)
4798 temporary-goal-column))
4803 ;; If the goal column lies on a display string,
4804 ;; `vertical-motion' advances the cursor to the end
4805 ;; of the string. For arg < 0, this can cause the
4806 ;; cursor to get stuck. (Bug#3020).
4807 (= (vertical-motion arg) arg)))
4809 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4812 ;; This is the guts of next-line and previous-line.
4813 ;; Arg says how many lines to move.
4814 ;; The value is t if we can move the specified number of lines.
4815 (defun line-move-1 (arg &optional noerror _to-end)
4816 ;; Don't run any point-motion hooks, and disregard intangibility,
4817 ;; for intermediate positions.
4818 (let ((inhibit-point-motion-hooks t)
4821 (if (consp temporary-goal-column)
4822 (setq temporary-goal-column (+ (car temporary-goal-column)
4823 (cdr temporary-goal-column))))
4826 (if (not (memq last-command '(next-line previous-line)))
4827 (setq temporary-goal-column
4828 (if (and track-eol (eolp)
4829 ;; Don't count beg of empty line as end of line
4830 ;; unless we just did explicit end-of-line.
4831 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4832 most-positive-fixnum
4835 (if (not (or (integerp selective-display)
4836 line-move-ignore-invisible))
4837 ;; Use just newline characters.
4838 ;; Set ARG to 0 if we move as many lines as requested.
4840 (progn (if (> arg 1) (forward-line (1- arg)))
4841 ;; This way of moving forward ARG lines
4842 ;; verifies that we have a newline after the last one.
4843 ;; It doesn't get confused by intangible text.
4845 (if (zerop (forward-line 1))
4847 (and (zerop (forward-line arg))
4851 (signal (if (< arg 0)
4852 'beginning-of-buffer
4855 ;; Move by arg lines, but ignore invisible ones.
4857 (while (and (> arg 0) (not done))
4858 ;; If the following character is currently invisible,
4859 ;; skip all characters with that same `invisible' property value.
4860 (while (and (not (eobp)) (invisible-p (point)))
4861 (goto-char (next-char-property-change (point))))
4863 ;; We don't use `end-of-line', since we want to escape
4864 ;; from field boundaries occurring exactly at point.
4865 (goto-char (constrain-to-field
4866 (let ((inhibit-field-text-motion t))
4867 (line-end-position))
4869 'inhibit-line-move-field-capture))
4870 ;; If there's no invisibility here, move over the newline.
4874 (signal 'end-of-buffer nil)
4876 ((and (> arg 1) ;; Use vertical-motion for last move
4877 (not (integerp selective-display))
4878 (not (invisible-p (point))))
4879 ;; We avoid vertical-motion when possible
4880 ;; because that has to fontify.
4882 ;; Otherwise move a more sophisticated way.
4883 ((zerop (vertical-motion 1))
4885 (signal 'end-of-buffer nil)
4888 (setq arg (1- arg))))
4889 ;; The logic of this is the same as the loop above,
4890 ;; it just goes in the other direction.
4891 (while (and (< arg 0) (not done))
4892 ;; For completely consistency with the forward-motion
4893 ;; case, we should call beginning-of-line here.
4894 ;; However, if point is inside a field and on a
4895 ;; continued line, the call to (vertical-motion -1)
4896 ;; below won't move us back far enough; then we return
4897 ;; to the same column in line-move-finish, and point
4898 ;; gets stuck -- cyd
4903 (signal 'beginning-of-buffer nil)
4905 ((and (< arg -1) ;; Use vertical-motion for last move
4906 (not (integerp selective-display))
4907 (not (invisible-p (1- (point)))))
4909 ((zerop (vertical-motion -1))
4911 (signal 'beginning-of-buffer nil)
4915 (while (and ;; Don't move over previous invis lines
4916 ;; if our target is the middle of this line.
4917 (or (zerop (or goal-column temporary-goal-column))
4919 (not (bobp)) (invisible-p (1- (point))))
4920 (goto-char (previous-char-property-change (point))))))))
4921 ;; This is the value the function returns.
4925 ;; If we did not move down as far as desired, at least go
4926 ;; to end of line. Be sure to call point-entered and
4927 ;; point-left-hooks.
4928 (let* ((npoint (prog1 (line-end-position)
4929 (goto-char opoint)))
4930 (inhibit-point-motion-hooks nil))
4931 (goto-char npoint)))
4933 ;; If we did not move up as far as desired,
4934 ;; at least go to beginning of line.
4935 (let* ((npoint (prog1 (line-beginning-position)
4936 (goto-char opoint)))
4937 (inhibit-point-motion-hooks nil))
4938 (goto-char npoint)))
4940 (line-move-finish (or goal-column temporary-goal-column)
4941 opoint (> orig-arg 0)))))))
4943 (defun line-move-finish (column opoint forward)
4946 ;; Set REPEAT to t to repeat the whole thing.
4951 (line-beg (line-beginning-position))
4953 ;; Compute the end of the line
4954 ;; ignoring effectively invisible newlines.
4956 ;; Like end-of-line but ignores fields.
4957 (skip-chars-forward "^\n")
4958 (while (and (not (eobp)) (invisible-p (point)))
4959 (goto-char (next-char-property-change (point)))
4960 (skip-chars-forward "^\n"))
4963 ;; Move to the desired column.
4964 (line-move-to-column (truncate column))
4966 ;; Corner case: suppose we start out in a field boundary in
4967 ;; the middle of a continued line. When we get to
4968 ;; line-move-finish, point is at the start of a new *screen*
4969 ;; line but the same text line; then line-move-to-column would
4970 ;; move us backwards. Test using C-n with point on the "x" in
4971 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4978 ;; Process intangibility within a line.
4979 ;; With inhibit-point-motion-hooks bound to nil, a call to
4980 ;; goto-char moves point past intangible text.
4982 ;; However, inhibit-point-motion-hooks controls both the
4983 ;; intangibility and the point-entered/point-left hooks. The
4984 ;; following hack avoids calling the point-* hooks
4985 ;; unnecessarily. Note that we move *forward* past intangible
4986 ;; text when the initial and final points are the same.
4988 (let ((inhibit-point-motion-hooks nil))
4991 ;; If intangibility moves us to a different (later) place
4992 ;; in the same line, use that as the destination.
4993 (if (<= (point) line-end)
4995 ;; If that position is "too late",
4996 ;; try the previous allowable position.
5000 ;; If going forward, don't accept the previous
5001 ;; allowable position if it is before the target line.
5002 (< line-beg (point))
5003 ;; If going backward, don't accept the previous
5004 ;; allowable position if it is still after the target line.
5005 (<= (point) line-end))
5007 ;; As a last resort, use the end of the line.
5008 (setq new line-end))))
5010 ;; Now move to the updated destination, processing fields
5011 ;; as well as intangibility.
5013 (let ((inhibit-point-motion-hooks nil))
5015 ;; Ignore field boundaries if the initial and final
5016 ;; positions have the same `field' property, even if the
5017 ;; fields are non-contiguous. This seems to be "nicer"
5018 ;; behavior in many situations.
5019 (if (eq (get-char-property new 'field)
5020 (get-char-property opoint 'field))
5022 (constrain-to-field new opoint t t
5023 'inhibit-line-move-field-capture))))
5025 ;; If all this moved us to a different line,
5026 ;; retry everything within that new line.
5027 (when (or (< (point) line-beg) (> (point) line-end))
5028 ;; Repeat the intangibility and field processing.
5029 (setq repeat t))))))
5031 (defun line-move-to-column (col)
5032 "Try to find column COL, considering invisibility.
5033 This function works only in certain cases,
5034 because what we really need is for `move-to-column'
5035 and `current-column' to be able to ignore invisible text."
5038 (move-to-column col))
5040 (when (and line-move-ignore-invisible
5041 (not (bolp)) (invisible-p (1- (point))))
5042 (let ((normal-location (point))
5043 (normal-column (current-column)))
5044 ;; If the following character is currently invisible,
5045 ;; skip all characters with that same `invisible' property value.
5046 (while (and (not (eobp))
5047 (invisible-p (point)))
5048 (goto-char (next-char-property-change (point))))
5049 ;; Have we advanced to a larger column position?
5050 (if (> (current-column) normal-column)
5051 ;; We have made some progress towards the desired column.
5052 ;; See if we can make any further progress.
5053 (line-move-to-column (+ (current-column) (- col normal-column)))
5054 ;; Otherwise, go to the place we originally found
5055 ;; and move back over invisible text.
5056 ;; that will get us to the same place on the screen
5057 ;; but with a more reasonable buffer position.
5058 (goto-char normal-location)
5059 (let ((line-beg (line-beginning-position)))
5060 (while (and (not (bolp)) (invisible-p (1- (point))))
5061 (goto-char (previous-char-property-change (point) line-beg))))))))
5063 (defun move-end-of-line (arg)
5064 "Move point to end of current line as displayed.
5065 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5066 If point reaches the beginning or end of buffer, it stops there.
5068 To ignore the effects of the `intangible' text or overlay
5069 property, bind `inhibit-point-motion-hooks' to t.
5070 If there is an image in the current line, this function
5071 disregards newlines that are part of the text on which the image
5074 (or arg (setq arg 1))
5079 (let ((goal-column 0)
5080 (line-move-visual nil))
5081 (and (line-move arg t)
5082 ;; With bidi reordering, we may not be at bol,
5083 ;; so make sure we are.
5084 (skip-chars-backward "^\n")
5087 (while (and (not (bobp)) (invisible-p (1- (point))))
5088 (goto-char (previous-single-char-property-change
5089 (point) 'invisible)))
5093 (if (and (> (point) newpos)
5094 (eq (preceding-char) ?\n))
5096 (if (and (> (point) newpos) (not (eobp))
5097 (not (eq (following-char) ?\n)))
5098 ;; If we skipped something intangible and now we're not
5099 ;; really at eol, keep going.
5103 (defun move-beginning-of-line (arg)
5104 "Move point to beginning of current line as displayed.
5105 \(If there's an image in the line, this disregards newlines
5106 which are part of the text that the image rests on.)
5108 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5109 If point reaches the beginning or end of buffer, it stops there.
5110 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5112 (or arg (setq arg 1))
5114 (let ((orig (point))
5115 first-vis first-vis-field-value)
5117 ;; Move by lines, if ARG is not 1 (the default).
5119 (let ((line-move-visual nil))
5120 (line-move (1- arg) t)))
5122 ;; Move to beginning-of-line, ignoring fields and invisible text.
5123 (skip-chars-backward "^\n")
5124 (while (and (not (bobp)) (invisible-p (1- (point))))
5125 (goto-char (previous-char-property-change (point)))
5126 (skip-chars-backward "^\n"))
5128 ;; Now find first visible char in the line
5129 (while (and (not (eobp)) (invisible-p (point)))
5130 (goto-char (next-char-property-change (point))))
5131 (setq first-vis (point))
5133 ;; See if fields would stop us from reaching FIRST-VIS.
5134 (setq first-vis-field-value
5135 (constrain-to-field first-vis orig (/= arg 1) t nil))
5137 (goto-char (if (/= first-vis-field-value first-vis)
5138 ;; If yes, obey them.
5139 first-vis-field-value
5140 ;; Otherwise, move to START with attention to fields.
5141 ;; (It is possible that fields never matter in this case.)
5142 (constrain-to-field (point) orig
5143 (/= arg 1) t nil)))))
5146 ;; Many people have said they rarely use this feature, and often type
5147 ;; it by accident. Maybe it shouldn't even be on a key.
5148 (put 'set-goal-column 'disabled t)
5150 (defun set-goal-column (arg)
5151 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
5152 Those commands will move to this position in the line moved to
5153 rather than trying to keep the same horizontal position.
5154 With a non-nil argument ARG, clears out the goal column
5155 so that \\[next-line] and \\[previous-line] resume vertical motion.
5156 The goal column is stored in the variable `goal-column'."
5160 (setq goal-column nil)
5161 (message "No goal column"))
5162 (setq goal-column (current-column))
5163 ;; The older method below can be erroneous if `set-goal-column' is bound
5164 ;; to a sequence containing %
5165 ;;(message (substitute-command-keys
5166 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5170 (format "Goal column %d " goal-column)
5171 (substitute-command-keys
5172 "(use \\[set-goal-column] with an arg to unset it)")))
5177 ;;; Editing based on visual lines, as opposed to logical lines.
5179 (defun end-of-visual-line (&optional n)
5180 "Move point to end of current visual line.
5181 With argument N not nil or 1, move forward N - 1 visual lines first.
5182 If point reaches the beginning or end of buffer, it stops there.
5183 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5187 (let ((line-move-visual t))
5188 (line-move (1- n) t)))
5189 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5190 ;; constrain to field boundaries, so we don't either.
5191 (vertical-motion (cons (window-width) 0)))
5193 (defun beginning-of-visual-line (&optional n)
5194 "Move point to beginning of current visual line.
5195 With argument N not nil or 1, move forward N - 1 visual lines first.
5196 If point reaches the beginning or end of buffer, it stops there.
5197 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5200 (let ((opoint (point)))
5202 (let ((line-move-visual t))
5203 (line-move (1- n) t)))
5205 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5206 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5208 (defun kill-visual-line (&optional arg)
5209 "Kill the rest of the visual line.
5210 With prefix argument ARG, kill that many visual lines from point.
5211 If ARG is negative, kill visual lines backward.
5212 If ARG is zero, kill the text before point on the current visual
5215 If you want to append the killed line to the last killed text,
5216 use \\[append-next-kill] before \\[kill-line].
5218 If the buffer is read-only, Emacs will beep and refrain from deleting
5219 the line, but put the line in the kill ring anyway. This means that
5220 you can use this command to copy text from a read-only buffer.
5221 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5224 ;; Like in `kill-line', it's better to move point to the other end
5225 ;; of the kill before killing.
5226 (let ((opoint (point))
5227 (kill-whole-line (and kill-whole-line (bolp))))
5229 (vertical-motion (prefix-numeric-value arg))
5230 (end-of-visual-line 1)
5231 (if (= (point) opoint)
5233 ;; Skip any trailing whitespace at the end of the visual line.
5234 ;; We used to do this only if `show-trailing-whitespace' is
5235 ;; nil, but that's wrong; the correct thing would be to check
5236 ;; whether the trailing whitespace is highlighted. But, it's
5237 ;; OK to just do this unconditionally.
5238 (skip-chars-forward " \t")))
5239 (kill-region opoint (if (and kill-whole-line (looking-at "\n"))
5243 (defun next-logical-line (&optional arg try-vscroll)
5244 "Move cursor vertically down ARG lines.
5245 This is identical to `next-line', except that it always moves
5246 by logical lines instead of visual lines, ignoring the value of
5247 the variable `line-move-visual'."
5248 (interactive "^p\np")
5249 (let ((line-move-visual nil))
5251 (next-line arg try-vscroll))))
5253 (defun previous-logical-line (&optional arg try-vscroll)
5254 "Move cursor vertically up ARG lines.
5255 This is identical to `previous-line', except that it always moves
5256 by logical lines instead of visual lines, ignoring the value of
5257 the variable `line-move-visual'."
5258 (interactive "^p\np")
5259 (let ((line-move-visual nil))
5261 (previous-line arg try-vscroll))))
5263 (defgroup visual-line nil
5264 "Editing based on visual lines."
5268 (defvar visual-line-mode-map
5269 (let ((map (make-sparse-keymap)))
5270 (define-key map [remap kill-line] 'kill-visual-line)
5271 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5272 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5273 ;; These keybindings interfere with xterm function keys. Are
5274 ;; there any other suitable bindings?
5275 ;; (define-key map "\M-[" 'previous-logical-line)
5276 ;; (define-key map "\M-]" 'next-logical-line)
5279 (defcustom visual-line-fringe-indicators '(nil nil)
5280 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5281 The value should be a list of the form (LEFT RIGHT), where LEFT
5282 and RIGHT are symbols representing the bitmaps to display, to
5283 indicate wrapped lines, in the left and right fringes respectively.
5284 See also `fringe-indicator-alist'.
5285 The default is not to display fringe indicators for wrapped lines.
5286 This variable does not affect fringe indicators displayed for
5288 :type '(list (choice (const :tag "Hide left indicator" nil)
5289 (const :tag "Left curly arrow" left-curly-arrow)
5290 (symbol :tag "Other bitmap"))
5291 (choice (const :tag "Hide right indicator" nil)
5292 (const :tag "Right curly arrow" right-curly-arrow)
5293 (symbol :tag "Other bitmap")))
5294 :set (lambda (symbol value)
5295 (dolist (buf (buffer-list))
5296 (with-current-buffer buf
5297 (when (and (boundp 'visual-line-mode)
5298 (symbol-value 'visual-line-mode))
5299 (setq fringe-indicator-alist
5300 (cons (cons 'continuation value)
5303 (copy-tree fringe-indicator-alist)))))))
5304 (set-default symbol value)))
5306 (defvar visual-line--saved-state nil)
5308 (define-minor-mode visual-line-mode
5309 "Toggle visual line based editing (Visual Line mode).
5310 With a prefix argument ARG, enable Visual Line mode if ARG is
5311 positive, and disable it otherwise. If called from Lisp, enable
5312 the mode if ARG is omitted or nil.
5314 When Visual Line mode is enabled, `word-wrap' is turned on in
5315 this buffer, and simple editing commands are redefined to act on
5316 visual lines, not logical lines. See Info node `Visual Line
5318 :keymap visual-line-mode-map
5321 (if visual-line-mode
5323 (set (make-local-variable 'visual-line--saved-state) nil)
5324 ;; Save the local values of some variables, to be restored if
5325 ;; visual-line-mode is turned off.
5326 (dolist (var '(line-move-visual truncate-lines
5327 truncate-partial-width-windows
5328 word-wrap fringe-indicator-alist))
5329 (if (local-variable-p var)
5330 (push (cons var (symbol-value var))
5331 visual-line--saved-state)))
5332 (set (make-local-variable 'line-move-visual) t)
5333 (set (make-local-variable 'truncate-partial-width-windows) nil)
5334 (setq truncate-lines nil
5336 fringe-indicator-alist
5337 (cons (cons 'continuation visual-line-fringe-indicators)
5338 fringe-indicator-alist)))
5339 (kill-local-variable 'line-move-visual)
5340 (kill-local-variable 'word-wrap)
5341 (kill-local-variable 'truncate-lines)
5342 (kill-local-variable 'truncate-partial-width-windows)
5343 (kill-local-variable 'fringe-indicator-alist)
5344 (dolist (saved visual-line--saved-state)
5345 (set (make-local-variable (car saved)) (cdr saved)))
5346 (kill-local-variable 'visual-line--saved-state)))
5348 (defun turn-on-visual-line-mode ()
5349 (visual-line-mode 1))
5351 (define-globalized-minor-mode global-visual-line-mode
5352 visual-line-mode turn-on-visual-line-mode
5356 (defun transpose-chars (arg)
5357 "Interchange characters around point, moving forward one character.
5358 With prefix arg ARG, effect is to take character before point
5359 and drag it forward past ARG other characters (backward if ARG negative).
5360 If no argument and at end of line, the previous two chars are exchanged."
5362 (and (null arg) (eolp) (forward-char -1))
5363 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5365 (defun transpose-words (arg)
5366 "Interchange words around point, leaving point at end of them.
5367 With prefix arg ARG, effect is to take word before or around point
5368 and drag it forward past ARG other words (backward if ARG negative).
5369 If ARG is zero, the words around or after point and around or after mark
5371 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5373 (transpose-subr 'forward-word arg))
5375 (defun transpose-sexps (arg)
5376 "Like \\[transpose-words] but applies to sexps.
5377 Does not work on a sexp that point is in the middle of
5378 if it is a list or string."
5382 ;; Here we should try to simulate the behavior of
5383 ;; (cons (progn (forward-sexp x) (point))
5384 ;; (progn (forward-sexp (- x)) (point)))
5385 ;; Except that we don't want to rely on the second forward-sexp
5386 ;; putting us back to where we want to be, since forward-sexp-function
5387 ;; might do funny things like infix-precedence.
5389 (looking-at "\\sw\\|\\s_")
5391 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
5392 ;; Jumping over a symbol. We might be inside it, mind you.
5393 (progn (funcall (if (> arg 0)
5394 'skip-syntax-backward 'skip-syntax-forward)
5396 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5397 ;; Otherwise, we're between sexps. Take a step back before jumping
5398 ;; to make sure we'll obey the same precedence no matter which direction
5400 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5401 (cons (save-excursion (forward-sexp arg) (point))
5402 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5403 (not (zerop (funcall (if (> arg 0)
5404 'skip-syntax-forward
5405 'skip-syntax-backward)
5410 (defun transpose-lines (arg)
5411 "Exchange current line and previous line, leaving point after both.
5412 With argument ARG, takes previous line and moves it past ARG lines.
5413 With argument 0, interchanges line point is in with line mark is in."
5415 (transpose-subr (function
5419 ;; Move forward over ARG lines,
5420 ;; but create newlines if necessary.
5421 (setq arg (forward-line arg))
5422 (if (/= (preceding-char) ?\n)
5423 (setq arg (1+ arg)))
5426 (forward-line arg))))
5429 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5430 ;; which seems inconsistent with the ARG /= 0 case.
5431 ;; FIXME document SPECIAL.
5432 (defun transpose-subr (mover arg &optional special)
5433 "Subroutine to do the work of transposing objects.
5434 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5435 moves forward by units of the given object (e.g. forward-sentence,
5436 forward-paragraph). If ARG is zero, exchanges the current object
5437 with the one containing mark. If ARG is an integer, moves the
5438 current object past ARG following (if ARG is positive) or
5439 preceding (if ARG is negative) objects, leaving point after the
5441 (let ((aux (if special mover
5443 (cons (progn (funcall mover x) (point))
5444 (progn (funcall mover (- x)) (point))))))
5449 (setq pos1 (funcall aux 1))
5450 (goto-char (or (mark) (error "No mark set in this buffer")))
5451 (setq pos2 (funcall aux 1))
5452 (transpose-subr-1 pos1 pos2))
5453 (exchange-point-and-mark))
5455 (setq pos1 (funcall aux -1))
5456 (setq pos2 (funcall aux arg))
5457 (transpose-subr-1 pos1 pos2)
5458 (goto-char (car pos2)))
5460 (setq pos1 (funcall aux -1))
5461 (goto-char (car pos1))
5462 (setq pos2 (funcall aux arg))
5463 (transpose-subr-1 pos1 pos2)))))
5465 (defun transpose-subr-1 (pos1 pos2)
5466 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5467 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5468 (when (> (car pos1) (car pos2))
5470 (setq pos1 pos2 pos2 swap)))
5471 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5472 (atomic-change-group
5473 ;; This sequence of insertions attempts to preserve marker
5474 ;; positions at the start and end of the transposed objects.
5475 (let* ((word (buffer-substring (car pos2) (cdr pos2)))
5476 (len1 (- (cdr pos1) (car pos1)))
5477 (len2 (length word))
5478 (boundary (make-marker)))
5479 (set-marker boundary (car pos2))
5480 (goto-char (cdr pos1))
5481 (insert-before-markers word)
5482 (setq word (delete-and-extract-region (car pos1) (+ (car pos1) len1)))
5483 (goto-char boundary)
5485 (goto-char (+ boundary len1))
5486 (delete-region (point) (+ (point) len2))
5487 (set-marker boundary nil))))
5489 (defun backward-word (&optional arg)
5490 "Move backward until encountering the beginning of a word.
5491 With argument ARG, do this that many times."
5493 (forward-word (- (or arg 1))))
5495 (defun mark-word (&optional arg allow-extend)
5496 "Set mark ARG words away from point.
5497 The place mark goes is the same place \\[forward-word] would
5498 move to with the same argument.
5499 Interactively, if this command is repeated
5500 or (in Transient Mark mode) if the mark is active,
5501 it marks the next ARG words after the ones already marked."
5502 (interactive "P\np")
5503 (cond ((and allow-extend
5504 (or (and (eq last-command this-command) (mark t))
5506 (setq arg (if arg (prefix-numeric-value arg)
5507 (if (< (mark) (point)) -1 1)))
5516 (forward-word (prefix-numeric-value arg))
5520 (defun kill-word (arg)
5521 "Kill characters forward until encountering the end of a word.
5522 With argument ARG, do this that many times."
5524 (kill-region (point) (progn (forward-word arg) (point))))
5526 (defun backward-kill-word (arg)
5527 "Kill characters backward until encountering the beginning of a word.
5528 With argument ARG, do this that many times."
5530 (kill-word (- arg)))
5532 (defun current-word (&optional strict really-word)
5533 "Return the symbol or word that point is on (or a nearby one) as a string.
5534 The return value includes no text properties.
5535 If optional arg STRICT is non-nil, return nil unless point is within
5536 or adjacent to a symbol or word. In all cases the value can be nil
5537 if there is no word nearby.
5538 The function, belying its name, normally finds a symbol.
5539 If optional arg REALLY-WORD is non-nil, it finds just a word."
5541 (let* ((oldpoint (point)) (start (point)) (end (point))
5542 (syntaxes (if really-word "w" "w_"))
5543 (not-syntaxes (concat "^" syntaxes)))
5544 (skip-syntax-backward syntaxes) (setq start (point))
5545 (goto-char oldpoint)
5546 (skip-syntax-forward syntaxes) (setq end (point))
5547 (when (and (eq start oldpoint) (eq end oldpoint)
5548 ;; Point is neither within nor adjacent to a word.
5550 ;; Look for preceding word in same line.
5551 (skip-syntax-backward not-syntaxes (line-beginning-position))
5553 ;; No preceding word in same line.
5554 ;; Look for following word in same line.
5556 (skip-syntax-forward not-syntaxes (line-end-position))
5557 (setq start (point))
5558 (skip-syntax-forward syntaxes)
5561 (skip-syntax-backward syntaxes)
5562 (setq start (point))))
5563 ;; If we found something nonempty, return it as a string.
5564 (unless (= start end)
5565 (buffer-substring-no-properties start end)))))
5567 (defcustom fill-prefix nil
5568 "String for filling to insert at front of new line, or nil for none."
5569 :type '(choice (const :tag "None" nil)
5572 (make-variable-buffer-local 'fill-prefix)
5573 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5575 (defcustom auto-fill-inhibit-regexp nil
5576 "Regexp to match lines which should not be auto-filled."
5577 :type '(choice (const :tag "None" nil)
5581 (defun do-auto-fill ()
5582 "The default value for `normal-auto-fill-function'.
5583 This is the default auto-fill function, some major modes use a different one.
5584 Returns t if it really did any work."
5585 (let (fc justify give-up
5586 (fill-prefix fill-prefix))
5587 (if (or (not (setq justify (current-justification)))
5588 (null (setq fc (current-fill-column)))
5589 (and (eq justify 'left)
5590 (<= (current-column) fc))
5591 (and auto-fill-inhibit-regexp
5592 (save-excursion (beginning-of-line)
5593 (looking-at auto-fill-inhibit-regexp))))
5594 nil ;; Auto-filling not required
5595 (if (memq justify '(full center right))
5596 (save-excursion (unjustify-current-line)))
5598 ;; Choose a fill-prefix automatically.
5599 (when (and adaptive-fill-mode
5600 (or (null fill-prefix) (string= fill-prefix "")))
5602 (fill-context-prefix
5603 (save-excursion (fill-forward-paragraph -1) (point))
5604 (save-excursion (fill-forward-paragraph 1) (point)))))
5605 (and prefix (not (equal prefix ""))
5606 ;; Use auto-indentation rather than a guessed empty prefix.
5607 (not (and fill-indent-according-to-mode
5608 (string-match "\\`[ \t]*\\'" prefix)))
5609 (setq fill-prefix prefix))))
5611 (while (and (not give-up) (> (current-column) fc))
5612 ;; Determine where to split the line.
5617 (setq after-prefix (point))
5619 (looking-at (regexp-quote fill-prefix))
5620 (setq after-prefix (match-end 0)))
5621 (move-to-column (1+ fc))
5622 (fill-move-to-break-point after-prefix)
5625 ;; See whether the place we found is any good.
5627 (goto-char fill-point)
5629 ;; There is no use breaking at end of line.
5630 (save-excursion (skip-chars-forward " ") (eolp))
5631 ;; It is futile to split at the end of the prefix
5632 ;; since we would just insert the prefix again.
5633 (and after-prefix (<= (point) after-prefix))
5634 ;; Don't split right after a comment starter
5635 ;; since we would just make another comment starter.
5636 (and comment-start-skip
5637 (let ((limit (point)))
5639 (and (re-search-forward comment-start-skip
5641 (eq (point) limit))))))
5642 ;; No good place to break => stop trying.
5644 ;; Ok, we have a useful place to break the line. Do it.
5645 (let ((prev-column (current-column)))
5646 ;; If point is at the fill-point, do not `save-excursion'.
5647 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5648 ;; point will end up before it rather than after it.
5650 (skip-chars-backward " \t")
5651 (= (point) fill-point))
5652 (default-indent-new-line t)
5654 (goto-char fill-point)
5655 (default-indent-new-line t)))
5656 ;; Now do justification, if required
5657 (if (not (eq justify 'left))
5660 (justify-current-line justify nil t)))
5661 ;; If making the new line didn't reduce the hpos of
5662 ;; the end of the line, then give up now;
5663 ;; trying again will not help.
5664 (if (>= (current-column) prev-column)
5665 (setq give-up t))))))
5666 ;; Justify last line.
5667 (justify-current-line justify t t)
5670 (defvar comment-line-break-function 'comment-indent-new-line
5671 "Mode-specific function which line breaks and continues a comment.
5672 This function is called during auto-filling when a comment syntax
5674 The function should take a single optional argument, which is a flag
5675 indicating whether it should use soft newlines.")
5677 (defun default-indent-new-line (&optional soft)
5678 "Break line at point and indent.
5679 If a comment syntax is defined, call `comment-indent-new-line'.
5681 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5682 unless optional argument SOFT is non-nil."
5685 (funcall comment-line-break-function soft)
5686 ;; Insert the newline before removing empty space so that markers
5687 ;; get preserved better.
5688 (if soft (insert-and-inherit ?\n) (newline 1))
5689 (save-excursion (forward-char -1) (delete-horizontal-space))
5690 (delete-horizontal-space)
5692 (if (and fill-prefix (not adaptive-fill-mode))
5693 ;; Blindly trust a non-adaptive fill-prefix.
5695 (indent-to-left-margin)
5696 (insert-before-markers-and-inherit fill-prefix))
5699 ;; If there's an adaptive prefix, use it unless we're inside
5700 ;; a comment and the prefix is not a comment starter.
5702 (indent-to-left-margin)
5703 (insert-and-inherit fill-prefix))
5704 ;; If we're not inside a comment, just try to indent.
5705 (t (indent-according-to-mode))))))
5707 (defvar normal-auto-fill-function 'do-auto-fill
5708 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5709 Some major modes set this.")
5711 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5712 ;; `functions' and `hooks' are usually unsafe to set, but setting
5713 ;; auto-fill-function to nil in a file-local setting is safe and
5714 ;; can be useful to prevent auto-filling.
5715 (put 'auto-fill-function 'safe-local-variable 'null)
5717 (define-minor-mode auto-fill-mode
5718 "Toggle automatic line breaking (Auto Fill mode).
5719 With a prefix argument ARG, enable Auto Fill mode if ARG is
5720 positive, and disable it otherwise. If called from Lisp, enable
5721 the mode if ARG is omitted or nil.
5723 When Auto Fill mode is enabled, inserting a space at a column
5724 beyond `current-fill-column' automatically breaks the line at a
5727 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5730 The value of `normal-auto-fill-function' specifies the function to use
5731 for `auto-fill-function' when turning Auto Fill mode on."
5732 :variable (auto-fill-function
5733 . (lambda (v) (setq auto-fill-function
5734 (if v normal-auto-fill-function)))))
5736 ;; This holds a document string used to document auto-fill-mode.
5737 (defun auto-fill-function ()
5738 "Automatically break line at a previous space, in insertion of text."
5741 (defun turn-on-auto-fill ()
5742 "Unconditionally turn on Auto Fill mode."
5745 (defun turn-off-auto-fill ()
5746 "Unconditionally turn off Auto Fill mode."
5747 (auto-fill-mode -1))
5749 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5751 (defun set-fill-column (arg)
5752 "Set `fill-column' to specified argument.
5753 Use \\[universal-argument] followed by a number to specify a column.
5754 Just \\[universal-argument] as argument means to use the current column."
5756 (list (or current-prefix-arg
5757 ;; We used to use current-column silently, but C-x f is too easily
5758 ;; typed as a typo for C-x C-f, so we turned it into an error and
5759 ;; now an interactive prompt.
5760 (read-number "Set fill-column to: " (current-column)))))
5762 (setq arg (current-column)))
5763 (if (not (integerp arg))
5764 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5765 (error "set-fill-column requires an explicit argument")
5766 (message "Fill column set to %d (was %d)" arg fill-column)
5767 (setq fill-column arg)))
5769 (defun set-selective-display (arg)
5770 "Set `selective-display' to ARG; clear it if no arg.
5771 When the value of `selective-display' is a number > 0,
5772 lines whose indentation is >= that value are not displayed.
5773 The variable `selective-display' has a separate value for each buffer."
5775 (if (eq selective-display t)
5776 (error "selective-display already in use for marked lines"))
5779 (narrow-to-region (point-min) (point))
5780 (goto-char (window-start))
5781 (vertical-motion (window-height)))))
5782 (setq selective-display
5783 (and arg (prefix-numeric-value arg)))
5784 (recenter current-vpos))
5785 (set-window-start (selected-window) (window-start (selected-window)))
5786 (princ "selective-display set to " t)
5787 (prin1 selective-display t)
5790 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5792 (defun toggle-truncate-lines (&optional arg)
5793 "Toggle truncating of long lines for the current buffer.
5794 When truncating is off, long lines are folded.
5795 With prefix argument ARG, truncate long lines if ARG is positive,
5796 otherwise fold them. Note that in side-by-side windows, this
5797 command has no effect if `truncate-partial-width-windows' is
5800 (setq truncate-lines
5802 (not truncate-lines)
5803 (> (prefix-numeric-value arg) 0)))
5804 (force-mode-line-update)
5805 (unless truncate-lines
5806 (let ((buffer (current-buffer)))
5807 (walk-windows (lambda (window)
5808 (if (eq buffer (window-buffer window))
5809 (set-window-hscroll window 0)))
5811 (message "Truncate long lines %s"
5812 (if truncate-lines "enabled" "disabled")))
5814 (defun toggle-word-wrap (&optional arg)
5815 "Toggle whether to use word-wrapping for continuation lines.
5816 With prefix argument ARG, wrap continuation lines at word boundaries
5817 if ARG is positive, otherwise wrap them at the right screen edge.
5818 This command toggles the value of `word-wrap'. It has no effect
5819 if long lines are truncated."
5824 (> (prefix-numeric-value arg) 0)))
5825 (force-mode-line-update)
5826 (message "Word wrapping %s"
5827 (if word-wrap "enabled" "disabled")))
5829 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5830 "The string displayed in the mode line when in overwrite mode.")
5831 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5832 "The string displayed in the mode line when in binary overwrite mode.")
5834 (define-minor-mode overwrite-mode
5835 "Toggle Overwrite mode.
5836 With a prefix argument ARG, enable Overwrite mode if ARG is
5837 positive, and disable it otherwise. If called from Lisp, enable
5838 the mode if ARG is omitted or nil.
5840 When Overwrite mode is enabled, printing characters typed in
5841 replace existing text on a one-for-one basis, rather than pushing
5842 it to the right. At the end of a line, such characters extend
5843 the line. Before a tab, such characters insert until the tab is
5844 filled in. \\[quoted-insert] still inserts characters in
5845 overwrite mode; this is supposed to make it easier to insert
5846 characters when necessary."
5847 :variable (overwrite-mode
5848 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5850 (define-minor-mode binary-overwrite-mode
5851 "Toggle Binary Overwrite mode.
5852 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5853 is positive, and disable it otherwise. If called from Lisp,
5854 enable the mode if ARG is omitted or nil.
5856 When Binary Overwrite mode is enabled, printing characters typed
5857 in replace existing text. Newlines are not treated specially, so
5858 typing at the end of a line joins the line to the next, with the
5859 typed character between them. Typing before a tab character
5860 simply replaces the tab with the character typed.
5861 \\[quoted-insert] replaces the text at the cursor, just as
5862 ordinary typing characters do.
5864 Note that Binary Overwrite mode is not its own minor mode; it is
5865 a specialization of overwrite mode, entered by setting the
5866 `overwrite-mode' variable to `overwrite-mode-binary'."
5867 :variable (overwrite-mode
5868 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5870 (define-minor-mode line-number-mode
5871 "Toggle line number display in the mode line (Line Number mode).
5872 With a prefix argument ARG, enable Line Number mode if ARG is
5873 positive, and disable it otherwise. If called from Lisp, enable
5874 the mode if ARG is omitted or nil.
5876 Line numbers do not appear for very large buffers and buffers
5877 with very long lines; see variables `line-number-display-limit'
5878 and `line-number-display-limit-width'."
5879 :init-value t :global t :group 'mode-line)
5881 (define-minor-mode column-number-mode
5882 "Toggle column number display in the mode line (Column Number mode).
5883 With a prefix argument ARG, enable Column Number mode if ARG is
5884 positive, and disable it otherwise.
5886 If called from Lisp, enable the mode if ARG is omitted or nil."
5887 :global t :group 'mode-line)
5889 (define-minor-mode size-indication-mode
5890 "Toggle buffer size display in the mode line (Size Indication mode).
5891 With a prefix argument ARG, enable Size Indication mode if ARG is
5892 positive, and disable it otherwise.
5894 If called from Lisp, enable the mode if ARG is omitted or nil."
5895 :global t :group 'mode-line)
5897 (define-minor-mode auto-save-mode
5898 "Toggle auto-saving in the current buffer (Auto Save mode).
5899 With a prefix argument ARG, enable Auto Save mode if ARG is
5900 positive, and disable it otherwise.
5902 If called from Lisp, enable the mode if ARG is omitted or nil."
5903 :variable ((and buffer-auto-save-file-name
5904 ;; If auto-save is off because buffer has shrunk,
5905 ;; then toggling should turn it on.
5906 (>= buffer-saved-size 0))
5908 (setq buffer-auto-save-file-name
5911 ((and buffer-file-name auto-save-visited-file-name
5912 (not buffer-read-only))
5914 (t (make-auto-save-file-name))))))
5915 ;; If -1 was stored here, to temporarily turn off saving,
5917 (and (< buffer-saved-size 0)
5918 (setq buffer-saved-size 0)))
5920 (defgroup paren-blinking nil
5921 "Blinking matching of parens and expressions."
5922 :prefix "blink-matching-"
5923 :group 'paren-matching)
5925 (defcustom blink-matching-paren t
5926 "Non-nil means show matching open-paren when close-paren is inserted."
5928 :group 'paren-blinking)
5930 (defcustom blink-matching-paren-on-screen t
5931 "Non-nil means show matching open-paren when it is on screen.
5932 If nil, don't show it (but the open-paren can still be shown
5933 when it is off screen).
5935 This variable has no effect if `blink-matching-paren' is nil.
5936 \(In that case, the open-paren is never shown.)
5937 It is also ignored if `show-paren-mode' is enabled."
5939 :group 'paren-blinking)
5941 (defcustom blink-matching-paren-distance (* 100 1024)
5942 "If non-nil, maximum distance to search backwards for matching open-paren.
5943 If nil, search stops at the beginning of the accessible portion of the buffer."
5944 :version "23.2" ; 25->100k
5945 :type '(choice (const nil) integer)
5946 :group 'paren-blinking)
5948 (defcustom blink-matching-delay 1
5949 "Time in seconds to delay after showing a matching paren."
5951 :group 'paren-blinking)
5953 (defcustom blink-matching-paren-dont-ignore-comments nil
5954 "If nil, `blink-matching-paren' ignores comments.
5955 More precisely, when looking for the matching parenthesis,
5956 it skips the contents of comments that end before point."
5958 :group 'paren-blinking)
5960 (defun blink-matching-check-mismatch (start end)
5961 "Return whether or not START...END are matching parens.
5962 END is the current point and START is the blink position.
5963 START might be nil if no matching starter was found.
5964 Returns non-nil if we find there is a mismatch."
5965 (let* ((end-syntax (syntax-after (1- end)))
5966 (matching-paren (and (consp end-syntax)
5967 (eq (syntax-class end-syntax) 5)
5969 ;; For self-matched chars like " and $, we can't know when they're
5970 ;; mismatched or unmatched, so we can only do it for parens.
5971 (when matching-paren
5974 (eq (char-after start) matching-paren)
5975 ;; The cdr might hold a new paren-class info rather than
5976 ;; a matching-char info, in which case the two CDRs
5978 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5980 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5981 "Function to check parentheses mismatches.
5982 The function takes two arguments (START and END) where START is the
5983 position just before the opening token and END is the position right after.
5984 START can be nil, if it was not found.
5985 The function should return non-nil if the two tokens do not match.")
5987 (defun blink-matching-open ()
5988 "Move cursor momentarily to the beginning of the sexp before point."
5990 (when (and (not (bobp))
5991 blink-matching-paren)
5992 (let* ((oldpos (point))
5993 (message-log-max nil) ; Don't log messages about paren matching.
5997 (if blink-matching-paren-distance
5999 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
6000 (- (point) blink-matching-paren-distance))
6002 (let ((parse-sexp-ignore-comments
6003 (and parse-sexp-ignore-comments
6004 (not blink-matching-paren-dont-ignore-comments))))
6008 ;; backward-sexp skips backward over prefix chars,
6009 ;; so move back to the matching paren.
6010 (while (and (< (point) (1- oldpos))
6011 (let ((code (syntax-after (point))))
6012 (or (eq (syntax-class code) 6)
6013 (eq (logand 1048576 (car code))
6018 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
6023 (minibuffer-message "Mismatched parentheses")
6024 (message "Mismatched parentheses"))
6026 (minibuffer-message "No matching parenthesis found")
6027 (message "No matching parenthesis found"))))
6028 ((not blinkpos) nil)
6029 ((pos-visible-in-window-p blinkpos)
6030 ;; Matching open within window, temporarily move to blinkpos but only
6031 ;; if `blink-matching-paren-on-screen' is non-nil.
6032 (and blink-matching-paren-on-screen
6033 (not show-paren-mode)
6035 (goto-char blinkpos)
6036 (sit-for blink-matching-delay))))
6039 (goto-char blinkpos)
6040 (let ((open-paren-line-string
6041 ;; Show what precedes the open in its line, if anything.
6043 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
6044 (buffer-substring (line-beginning-position)
6046 ;; Show what follows the open in its line, if anything.
6049 (skip-chars-forward " \t")
6051 (buffer-substring blinkpos
6052 (line-end-position)))
6053 ;; Otherwise show the previous nonblank line,
6055 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
6057 (buffer-substring (progn
6058 (skip-chars-backward "\n \t")
6059 (line-beginning-position))
6060 (progn (end-of-line)
6061 (skip-chars-backward " \t")
6063 ;; Replace the newline and other whitespace with `...'.
6065 (buffer-substring blinkpos (1+ blinkpos))))
6066 ;; There is nothing to show except the char itself.
6067 (t (buffer-substring blinkpos (1+ blinkpos))))))
6068 (message "Matches %s"
6069 (substring-no-properties open-paren-line-string)))))))))
6071 (defvar blink-paren-function 'blink-matching-open
6072 "Function called, if non-nil, whenever a close parenthesis is inserted.
6073 More precisely, a char with closeparen syntax is self-inserted.")
6075 (defun blink-paren-post-self-insert-function ()
6076 (when (and (eq (char-before) last-command-event) ; Sanity check.
6077 (memq (char-syntax last-command-event) '(?\) ?\$))
6078 blink-paren-function
6079 (not executing-kbd-macro)
6080 (not noninteractive)
6081 ;; Verify an even number of quoting characters precede the close.
6082 (= 1 (logand 1 (- (point)
6085 (skip-syntax-backward "/\\")
6087 (funcall blink-paren-function)))
6089 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
6090 ;; Most likely, this hook is nil, so this arg doesn't matter,
6091 ;; but I use it as a reminder that this function usually
6092 ;; likes to be run after others since it does `sit-for'.
6095 ;; This executes C-g typed while Emacs is waiting for a command.
6096 ;; Quitting out of a program does not go through here;
6097 ;; that happens in the QUIT macro at the C code level.
6098 (defun keyboard-quit ()
6099 "Signal a `quit' condition.
6100 During execution of Lisp code, this character causes a quit directly.
6101 At top-level, as an editor command, this simply beeps."
6103 ;; Avoid adding the region to the window selection.
6104 (setq saved-region-selection nil)
6105 (let (select-active-regions)
6107 (if (fboundp 'kmacro-keyboard-quit)
6108 (kmacro-keyboard-quit))
6109 (setq defining-kbd-macro nil)
6110 (let ((debug-on-quit nil))
6111 (signal 'quit nil)))
6113 (defvar buffer-quit-function nil
6114 "Function to call to \"quit\" the current buffer, or nil if none.
6115 \\[keyboard-escape-quit] calls this function when its more local actions
6116 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
6118 (defun keyboard-escape-quit ()
6119 "Exit the current \"mode\" (in a generalized sense of the word).
6120 This command can exit an interactive command such as `query-replace',
6121 can clear out a prefix argument or a region,
6122 can get out of the minibuffer or other recursive edit,
6123 cancel the use of the current buffer (for special-purpose buffers),
6124 or go back to just one window (by deleting all but the selected window)."
6126 (cond ((eq last-command 'mode-exited) nil)
6129 ((> (minibuffer-depth) 0)
6130 (abort-recursive-edit))
6133 ((> (recursion-depth) 0)
6134 (exit-recursive-edit))
6135 (buffer-quit-function
6136 (funcall buffer-quit-function))
6137 ((not (one-window-p t))
6138 (delete-other-windows))
6139 ((string-match "^ \\*" (buffer-name (current-buffer)))
6142 (defun play-sound-file (file &optional volume device)
6143 "Play sound stored in FILE.
6144 VOLUME and DEVICE correspond to the keywords of the sound
6145 specification for `play-sound'."
6146 (interactive "fPlay sound file: ")
6147 (let ((sound (list :file file)))
6149 (plist-put sound :volume volume))
6151 (plist-put sound :device device))
6153 (play-sound sound)))
6156 (defcustom read-mail-command 'rmail
6157 "Your preference for a mail reading package.
6158 This is used by some keybindings which support reading mail.
6159 See also `mail-user-agent' concerning sending mail."
6160 :type '(radio (function-item :tag "Rmail" :format "%t\n" rmail)
6161 (function-item :tag "Gnus" :format "%t\n" gnus)
6162 (function-item :tag "Emacs interface to MH"
6163 :format "%t\n" mh-rmail)
6164 (function :tag "Other"))
6168 (defcustom mail-user-agent 'message-user-agent
6169 "Your preference for a mail composition package.
6170 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6171 outgoing email message. This variable lets you specify which
6172 mail-sending package you prefer.
6174 Valid values include:
6176 `message-user-agent' -- use the Message package.
6177 See Info node `(message)'.
6178 `sendmail-user-agent' -- use the Mail package.
6179 See Info node `(emacs)Sending Mail'.
6180 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6181 See Info node `(mh-e)'.
6182 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6183 paraphernalia if Gnus is running, particularly
6184 the Gcc: header for archiving.
6186 Additional valid symbols may be available; check with the author of
6187 your package for details. The function should return non-nil if it
6190 See also `read-mail-command' concerning reading mail."
6191 :type '(radio (function-item :tag "Message package"
6194 (function-item :tag "Mail package"
6196 sendmail-user-agent)
6197 (function-item :tag "Emacs interface to MH"
6200 (function-item :tag "Message with full Gnus features"
6203 (function :tag "Other"))
6204 :version "23.2" ; sendmail->message
6207 (defcustom compose-mail-user-agent-warnings t
6208 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6209 If the value of `mail-user-agent' is the default, and the user
6210 appears to have customizations applying to the old default,
6211 `compose-mail' issues a warning."
6216 (defun rfc822-goto-eoh ()
6217 "If the buffer starts with a mail header, move point to the header's end.
6218 Otherwise, moves to `point-min'.
6219 The end of the header is the start of the next line, if there is one,
6220 else the end of the last line. This function obeys RFC822."
6221 (goto-char (point-min))
6222 (when (re-search-forward
6223 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
6224 (goto-char (match-beginning 0))))
6226 ;; Used by Rmail (e.g., rmail-forward).
6227 (defvar mail-encode-mml nil
6228 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6229 the outgoing message before sending it.")
6231 (defun compose-mail (&optional to subject other-headers continue
6232 switch-function yank-action send-actions
6234 "Start composing a mail message to send.
6235 This uses the user's chosen mail composition package
6236 as selected with the variable `mail-user-agent'.
6237 The optional arguments TO and SUBJECT specify recipients
6238 and the initial Subject field, respectively.
6240 OTHER-HEADERS is an alist specifying additional
6241 header fields. Elements look like (HEADER . VALUE) where both
6242 HEADER and VALUE are strings.
6244 CONTINUE, if non-nil, says to continue editing a message already
6245 being composed. Interactively, CONTINUE is the prefix argument.
6247 SWITCH-FUNCTION, if non-nil, is a function to use to
6248 switch to and display the buffer used for mail composition.
6250 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6251 to insert the raw text of the message being replied to.
6252 It has the form (FUNCTION . ARGS). The user agent will apply
6253 FUNCTION to ARGS, to insert the raw text of the original message.
6254 \(The user agent will also run `mail-citation-hook', *after* the
6255 original text has been inserted in this way.)
6257 SEND-ACTIONS is a list of actions to call when the message is sent.
6258 Each action has the form (FUNCTION . ARGS).
6260 RETURN-ACTION, if non-nil, is an action for returning to the
6261 caller. It has the form (FUNCTION . ARGS). The function is
6262 called after the mail has been sent or put aside, and the mail
6265 (list nil nil nil current-prefix-arg))
6267 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6268 ;; from sendmail-user-agent to message-user-agent. Some users may
6269 ;; encounter incompatibilities. This hack tries to detect problems
6270 ;; and warn about them.
6271 (and compose-mail-user-agent-warnings
6272 (eq mail-user-agent 'message-user-agent)
6274 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6275 mail-yank-hooks mail-archive-file-name
6276 mail-default-reply-to mail-mailing-lists
6280 (push var warn-vars)))
6282 (display-warning 'mail
6284 The default mail mode is now Message mode.
6285 You have the following Mail mode variable%s customized:
6286 \n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
6287 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6288 (if (> (length warn-vars) 1) "s" "")
6289 (mapconcat 'symbol-name
6292 (let ((function (get mail-user-agent 'composefunc)))
6293 (funcall function to subject other-headers continue switch-function
6294 yank-action send-actions return-action)))
6296 (defun compose-mail-other-window (&optional to subject other-headers continue
6297 yank-action send-actions
6299 "Like \\[compose-mail], but edit the outgoing message in another window."
6300 (interactive (list nil nil nil current-prefix-arg))
6301 (compose-mail to subject other-headers continue
6302 'switch-to-buffer-other-window yank-action send-actions
6305 (defun compose-mail-other-frame (&optional to subject other-headers continue
6306 yank-action send-actions
6308 "Like \\[compose-mail], but edit the outgoing message in another frame."
6309 (interactive (list nil nil nil current-prefix-arg))
6310 (compose-mail to subject other-headers continue
6311 'switch-to-buffer-other-frame yank-action send-actions
6315 (defvar set-variable-value-history nil
6316 "History of values entered with `set-variable'.
6318 Maximum length of the history list is determined by the value
6319 of `history-length', which see.")
6321 (defun set-variable (variable value &optional make-local)
6322 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6323 VARIABLE should be a user option variable name, a Lisp variable
6324 meant to be customized by users. You should enter VALUE in Lisp syntax,
6325 so if you want VALUE to be a string, you must surround it with doublequotes.
6326 VALUE is used literally, not evaluated.
6328 If VARIABLE has a `variable-interactive' property, that is used as if
6329 it were the arg to `interactive' (which see) to interactively read VALUE.
6331 If VARIABLE has been defined with `defcustom', then the type information
6332 in the definition is used to check that VALUE is valid.
6334 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6336 (let* ((default-var (variable-at-point))
6337 (var (if (custom-variable-p default-var)
6338 (read-variable (format "Set variable (default %s): " default-var)
6340 (read-variable "Set variable: ")))
6341 (minibuffer-help-form '(describe-variable var))
6342 (prop (get var 'variable-interactive))
6343 (obsolete (car (get var 'byte-obsolete-variable)))
6344 (prompt (format "Set %s %s to value: " var
6345 (cond ((local-variable-p var)
6347 ((or current-prefix-arg
6348 (local-variable-if-set-p var))
6353 (message (concat "`%S' is obsolete; "
6354 (if (symbolp obsolete) "use `%S' instead" "%s"))
6358 ;; Use VAR's `variable-interactive' property
6359 ;; as an interactive spec for prompting.
6360 (call-interactively `(lambda (arg)
6364 (read-string prompt nil
6365 'set-variable-value-history
6366 (format "%S" (symbol-value var))))))))
6367 (list var val current-prefix-arg)))
6369 (and (custom-variable-p variable)
6370 (not (get variable 'custom-type))
6371 (custom-load-symbol variable))
6372 (let ((type (get variable 'custom-type)))
6374 ;; Match with custom type.
6376 (setq type (widget-convert type))
6377 (unless (widget-apply type :match value)
6378 (error "Value `%S' does not match type %S of %S"
6379 value (car type) variable))))
6382 (make-local-variable variable))
6384 (set variable value)
6386 ;; Force a thorough redisplay for the case that the variable
6387 ;; has an effect on the display, like `tab-width' has.
6388 (force-mode-line-update))
6390 ;; Define the major mode for lists of completions.
6392 (defvar completion-list-mode-map
6393 (let ((map (make-sparse-keymap)))
6394 (define-key map [mouse-2] 'mouse-choose-completion)
6395 (define-key map [follow-link] 'mouse-face)
6396 (define-key map [down-mouse-2] nil)
6397 (define-key map "\C-m" 'choose-completion)
6398 (define-key map "\e\e\e" 'delete-completion-window)
6399 (define-key map [left] 'previous-completion)
6400 (define-key map [right] 'next-completion)
6401 (define-key map "q" 'quit-window)
6402 (define-key map "z" 'kill-this-buffer)
6404 "Local map for completion list buffers.")
6406 ;; Completion mode is suitable only for specially formatted data.
6407 (put 'completion-list-mode 'mode-class 'special)
6409 (defvar completion-reference-buffer nil
6410 "Record the buffer that was current when the completion list was requested.
6411 This is a local variable in the completion list buffer.
6412 Initial value is nil to avoid some compiler warnings.")
6414 (defvar completion-no-auto-exit nil
6415 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6416 This also applies to other functions such as `choose-completion'.")
6418 (defvar completion-base-position nil
6419 "Position of the base of the text corresponding to the shown completions.
6420 This variable is used in the *Completions* buffers.
6421 Its value is a list of the form (START END) where START is the place
6422 where the completion should be inserted and END (if non-nil) is the end
6423 of the text to replace. If END is nil, point is used instead.")
6425 (defvar completion-list-insert-choice-function #'completion--replace
6426 "Function to use to insert the text chosen in *Completions*.
6427 Called with three arguments (BEG END TEXT), it should replace the text
6428 between BEG and END with TEXT. Expected to be set buffer-locally
6429 in the *Completions* buffer.")
6431 (defvar completion-base-size nil
6432 "Number of chars before point not involved in completion.
6433 This is a local variable in the completion list buffer.
6434 It refers to the chars in the minibuffer if completing in the
6435 minibuffer, or in `completion-reference-buffer' otherwise.
6436 Only characters in the field at point are included.
6438 If nil, Emacs determines which part of the tail end of the
6439 buffer's text is involved in completion by comparing the text
6441 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6443 (defun delete-completion-window ()
6444 "Delete the completion list window.
6445 Go to the window from which completion was requested."
6447 (let ((buf completion-reference-buffer))
6448 (if (one-window-p t)
6449 (if (window-dedicated-p (selected-window))
6450 (delete-frame (selected-frame)))
6451 (delete-window (selected-window))
6452 (if (get-buffer-window buf)
6453 (select-window (get-buffer-window buf))))))
6455 (defun previous-completion (n)
6456 "Move to the previous item in the completion list."
6458 (next-completion (- n)))
6460 (defun next-completion (n)
6461 "Move to the next item in the completion list.
6462 With prefix argument N, move N items (negative N means move backward)."
6464 (let ((beg (point-min)) (end (point-max)))
6465 (while (and (> n 0) (not (eobp)))
6466 ;; If in a completion, move to the end of it.
6467 (when (get-text-property (point) 'mouse-face)
6468 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6469 ;; Move to start of next one.
6470 (unless (get-text-property (point) 'mouse-face)
6471 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6473 (while (and (< n 0) (not (bobp)))
6474 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6475 ;; If in a completion, move to the start of it.
6476 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6477 (goto-char (previous-single-property-change
6478 (point) 'mouse-face nil beg)))
6479 ;; Move to end of the previous completion.
6480 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6481 (goto-char (previous-single-property-change
6482 (point) 'mouse-face nil beg)))
6483 ;; Move to the start of that one.
6484 (goto-char (previous-single-property-change
6485 (point) 'mouse-face nil beg))
6488 (defun choose-completion (&optional event)
6489 "Choose the completion at point."
6490 (interactive (list last-nonmenu-event))
6491 ;; In case this is run via the mouse, give temporary modes such as
6492 ;; isearch a chance to turn off.
6493 (run-hooks 'mouse-leave-buffer-hook)
6494 (with-current-buffer (window-buffer (posn-window (event-start event)))
6495 (let ((buffer completion-reference-buffer)
6496 (base-size completion-base-size)
6497 (base-position completion-base-position)
6498 (insert-function completion-list-insert-choice-function)
6501 (goto-char (posn-point (event-start event)))
6504 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6505 (setq end (point) beg (1+ (point))))
6507 (get-text-property (1- (point)) 'mouse-face))
6508 (setq end (1- (point)) beg (point)))
6509 (t (error "No completion here")))
6510 (setq beg (previous-single-property-change beg 'mouse-face))
6511 (setq end (or (next-single-property-change end 'mouse-face)
6513 (buffer-substring-no-properties beg end)))))
6515 (unless (buffer-live-p buffer)
6516 (error "Destination buffer is dead"))
6517 (quit-window nil (posn-window (event-start event)))
6519 (with-current-buffer buffer
6520 (choose-completion-string
6524 ;; Someone's using old completion code that doesn't know
6525 ;; about base-position yet.
6526 (list (+ base-size (field-beginning))))
6527 ;; If all else fails, just guess.
6528 (list (choose-completion-guess-base-position choice)))
6529 insert-function)))))
6531 ;; Delete the longest partial match for STRING
6532 ;; that can be found before POINT.
6533 (defun choose-completion-guess-base-position (string)
6535 (let ((opoint (point))
6537 ;; Try moving back by the length of the string.
6538 (goto-char (max (- (point) (length string))
6539 (minibuffer-prompt-end)))
6540 ;; See how far back we were actually able to move. That is the
6541 ;; upper bound on how much we can match and delete.
6542 (setq len (- opoint (point)))
6543 (if completion-ignore-case
6544 (setq string (downcase string)))
6545 (while (and (> len 0)
6546 (let ((tail (buffer-substring (point) opoint)))
6547 (if completion-ignore-case
6548 (setq tail (downcase tail)))
6549 (not (string= tail (substring string 0 len)))))
6554 (defun choose-completion-delete-max-match (string)
6555 (declare (obsolete choose-completion-guess-base-position "23.2"))
6556 (delete-region (choose-completion-guess-base-position string) (point)))
6558 (defvar choose-completion-string-functions nil
6559 "Functions that may override the normal insertion of a completion choice.
6560 These functions are called in order with four arguments:
6561 CHOICE - the string to insert in the buffer,
6562 BUFFER - the buffer in which the choice should be inserted,
6563 MINI-P - non-nil if BUFFER is a minibuffer, and
6564 BASE-SIZE - the number of characters in BUFFER before
6565 the string being completed.
6567 If a function in the list returns non-nil, that function is supposed
6568 to have inserted the CHOICE in the BUFFER, and possibly exited
6569 the minibuffer; no further functions will be called.
6571 If all functions in the list return nil, that means to use
6572 the default method of inserting the completion in BUFFER.")
6574 (defun choose-completion-string (choice &optional
6575 buffer base-position insert-function)
6576 "Switch to BUFFER and insert the completion choice CHOICE.
6577 BASE-POSITION, says where to insert the completion."
6579 ;; If BUFFER is the minibuffer, exit the minibuffer
6580 ;; unless it is reading a file name and CHOICE is a directory,
6581 ;; or completion-no-auto-exit is non-nil.
6583 ;; Some older code may call us passing `base-size' instead of
6584 ;; `base-position'. It's difficult to make any use of `base-size',
6585 ;; so we just ignore it.
6586 (unless (consp base-position)
6587 (message "Obsolete `base-size' passed to choose-completion-string")
6588 (setq base-position nil))
6590 (let* ((buffer (or buffer completion-reference-buffer))
6591 (mini-p (minibufferp buffer)))
6592 ;; If BUFFER is a minibuffer, barf unless it's the currently
6593 ;; active minibuffer.
6595 (not (and (active-minibuffer-window)
6597 (window-buffer (active-minibuffer-window))))))
6598 (error "Minibuffer is not active for completion")
6599 ;; Set buffer so buffer-local choose-completion-string-functions works.
6601 (unless (run-hook-with-args-until-success
6602 'choose-completion-string-functions
6603 ;; The fourth arg used to be `mini-p' but was useless
6604 ;; (since minibufferp can be used on the `buffer' arg)
6605 ;; and indeed unused. The last used to be `base-size', so we
6606 ;; keep it to try and avoid breaking old code.
6607 choice buffer base-position nil)
6608 ;; This remove-text-properties should be unnecessary since `choice'
6609 ;; comes from buffer-substring-no-properties.
6610 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6611 ;; Insert the completion into the buffer where it was requested.
6612 (funcall (or insert-function completion-list-insert-choice-function)
6613 (or (car base-position) (point))
6614 (or (cadr base-position) (point))
6616 ;; Update point in the window that BUFFER is showing in.
6617 (let ((window (get-buffer-window buffer t)))
6618 (set-window-point window (point)))
6619 ;; If completing for the minibuffer, exit it with this choice.
6620 (and (not completion-no-auto-exit)
6621 (minibufferp buffer)
6622 minibuffer-completion-table
6623 ;; If this is reading a file name, and the file name chosen
6624 ;; is a directory, don't exit the minibuffer.
6625 (let* ((result (buffer-substring (field-beginning) (point)))
6627 (completion-boundaries result minibuffer-completion-table
6628 minibuffer-completion-predicate
6630 (if (eq (car bounds) (length result))
6631 ;; The completion chosen leads to a new set of completions
6632 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6633 (let ((mini (active-minibuffer-window)))
6634 (select-window mini)
6635 (when minibuffer-auto-raise
6636 (raise-frame (window-frame mini))))
6637 (exit-minibuffer))))))))
6639 (define-derived-mode completion-list-mode nil "Completion List"
6640 "Major mode for buffers showing lists of possible completions.
6641 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
6642 to select the completion near point.
6643 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
6646 \\{completion-list-mode-map}"
6647 (set (make-local-variable 'completion-base-size) nil))
6649 (defun completion-list-mode-finish ()
6650 "Finish setup of the completions buffer.
6651 Called from `temp-buffer-show-hook'."
6652 (when (eq major-mode 'completion-list-mode)
6653 (setq buffer-read-only t)))
6655 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6658 ;; Variables and faces used in `completion-setup-function'.
6660 (defcustom completion-show-help t
6661 "Non-nil means show help message in *Completions* buffer."
6666 ;; This function goes in completion-setup-hook, so that it is called
6667 ;; after the text of the completion list buffer is written.
6668 (defun completion-setup-function ()
6669 (let* ((mainbuf (current-buffer))
6671 ;; When reading a file name in the minibuffer,
6672 ;; try and find the right default-directory to set in the
6673 ;; completion list buffer.
6674 ;; FIXME: Why do we do that, actually? --Stef
6675 (if minibuffer-completing-file-name
6676 (file-name-as-directory
6678 (substring (minibuffer-completion-contents)
6679 0 (or completion-base-size 0)))))))
6680 (with-current-buffer standard-output
6681 (let ((base-size completion-base-size) ;Read before killing localvars.
6682 (base-position completion-base-position)
6683 (insert-fun completion-list-insert-choice-function))
6684 (completion-list-mode)
6685 (set (make-local-variable 'completion-base-size) base-size)
6686 (set (make-local-variable 'completion-base-position) base-position)
6687 (set (make-local-variable 'completion-list-insert-choice-function)
6689 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6690 (if base-dir (setq default-directory base-dir))
6691 ;; Maybe insert help string.
6692 (when completion-show-help
6693 (goto-char (point-min))
6694 (if (display-mouse-p)
6695 (insert (substitute-command-keys
6696 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
6697 (insert (substitute-command-keys
6698 "In this buffer, type \\[choose-completion] to \
6699 select the completion near point.\n\n"))))))
6701 (add-hook 'completion-setup-hook 'completion-setup-function)
6703 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6704 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6706 (defun switch-to-completions ()
6707 "Select the completion list window."
6709 (let ((window (or (get-buffer-window "*Completions*" 0)
6710 ;; Make sure we have a completions window.
6711 (progn (minibuffer-completion-help)
6712 (get-buffer-window "*Completions*" 0)))))
6714 (select-window window)
6715 ;; In the new buffer, go to the first completion.
6716 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6718 (next-completion 1)))))
6720 ;;; Support keyboard commands to turn on various modifiers.
6722 ;; These functions -- which are not commands -- each add one modifier
6723 ;; to the following event.
6725 (defun event-apply-alt-modifier (_ignore-prompt)
6726 "\\<function-key-map>Add the Alt modifier to the following event.
6727 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
6728 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6729 (defun event-apply-super-modifier (_ignore-prompt)
6730 "\\<function-key-map>Add the Super modifier to the following event.
6731 For example, type \\[event-apply-super-modifier] & to enter Super-&."
6732 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6733 (defun event-apply-hyper-modifier (_ignore-prompt)
6734 "\\<function-key-map>Add the Hyper modifier to the following event.
6735 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
6736 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6737 (defun event-apply-shift-modifier (_ignore-prompt)
6738 "\\<function-key-map>Add the Shift modifier to the following event.
6739 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
6740 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6741 (defun event-apply-control-modifier (_ignore-prompt)
6742 "\\<function-key-map>Add the Ctrl modifier to the following event.
6743 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
6744 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6745 (defun event-apply-meta-modifier (_ignore-prompt)
6746 "\\<function-key-map>Add the Meta modifier to the following event.
6747 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
6748 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6750 (defun event-apply-modifier (event symbol lshiftby prefix)
6751 "Apply a modifier flag to event EVENT.
6752 SYMBOL is the name of this modifier, as a symbol.
6753 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6754 PREFIX is the string that represents this modifier in an event type symbol."
6756 (cond ((eq symbol 'control)
6757 (if (and (<= (downcase event) ?z)
6758 (>= (downcase event) ?a))
6759 (- (downcase event) ?a -1)
6760 (if (and (<= (downcase event) ?Z)
6761 (>= (downcase event) ?A))
6762 (- (downcase event) ?A -1)
6763 (logior (lsh 1 lshiftby) event))))
6765 (if (and (<= (downcase event) ?z)
6766 (>= (downcase event) ?a))
6768 (logior (lsh 1 lshiftby) event)))
6770 (logior (lsh 1 lshiftby) event)))
6771 (if (memq symbol (event-modifiers event))
6773 (let ((event-type (if (symbolp event) event (car event))))
6774 (setq event-type (intern (concat prefix (symbol-name event-type))))
6777 (cons event-type (cdr event)))))))
6779 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6780 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6781 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6782 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6783 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6784 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6786 ;;;; Keypad support.
6788 ;; Make the keypad keys act like ordinary typing keys. If people add
6789 ;; bindings for the function key symbols, then those bindings will
6790 ;; override these, so this shouldn't interfere with any existing
6793 ;; Also tell read-char how to handle these keys.
6795 (lambda (keypad-normal)
6796 (let ((keypad (nth 0 keypad-normal))
6797 (normal (nth 1 keypad-normal)))
6798 (put keypad 'ascii-character normal)
6799 (define-key function-key-map (vector keypad) (vector normal))))
6800 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6801 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6812 ;; Do the same for various keys that are represented as symbols under
6813 ;; GUIs but naturally correspond to characters.
6824 ;;;; forking a twin copy of a buffer.
6827 (defvar clone-buffer-hook nil
6828 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6830 (defvar clone-indirect-buffer-hook nil
6831 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6833 (defun clone-process (process &optional newname)
6834 "Create a twin copy of PROCESS.
6835 If NEWNAME is nil, it defaults to PROCESS' name;
6836 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6837 If PROCESS is associated with a buffer, the new process will be associated
6838 with the current buffer instead.
6839 Returns nil if PROCESS has already terminated."
6840 (setq newname (or newname (process-name process)))
6841 (if (string-match "<[0-9]+>\\'" newname)
6842 (setq newname (substring newname 0 (match-beginning 0))))
6843 (when (memq (process-status process) '(run stop open))
6844 (let* ((process-connection-type (process-tty-name process))
6846 (if (memq (process-status process) '(open))
6847 (let ((args (process-contact process t)))
6848 (setq args (plist-put args :name newname))
6849 (setq args (plist-put args :buffer
6850 (if (process-buffer process)
6852 (apply 'make-network-process args))
6853 (apply 'start-process newname
6854 (if (process-buffer process) (current-buffer))
6855 (process-command process)))))
6856 (set-process-query-on-exit-flag
6857 new-process (process-query-on-exit-flag process))
6858 (set-process-inherit-coding-system-flag
6859 new-process (process-inherit-coding-system-flag process))
6860 (set-process-filter new-process (process-filter process))
6861 (set-process-sentinel new-process (process-sentinel process))
6862 (set-process-plist new-process (copy-sequence (process-plist process)))
6865 ;; things to maybe add (currently partly covered by `funcall mode'):
6868 (defun clone-buffer (&optional newname display-flag)
6869 "Create and return a twin copy of the current buffer.
6870 Unlike an indirect buffer, the new buffer can be edited
6871 independently of the old one (if it is not read-only).
6872 NEWNAME is the name of the new buffer. It may be modified by
6873 adding or incrementing <N> at the end as necessary to create a
6874 unique buffer name. If nil, it defaults to the name of the
6875 current buffer, with the proper suffix. If DISPLAY-FLAG is
6876 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6877 clone a file-visiting buffer, or a buffer whose major mode symbol
6878 has a non-nil `no-clone' property, results in an error.
6880 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6881 current buffer with appropriate suffix. However, if a prefix
6882 argument is given, then the command prompts for NEWNAME in the
6885 This runs the normal hook `clone-buffer-hook' in the new buffer
6886 after it has been set up properly in other respects."
6889 (if buffer-file-name
6890 (error "Cannot clone a file-visiting buffer"))
6891 (if (get major-mode 'no-clone)
6892 (error "Cannot clone a buffer in %s mode" mode-name))
6893 (list (if current-prefix-arg
6894 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6896 (if buffer-file-name
6897 (error "Cannot clone a file-visiting buffer"))
6898 (if (get major-mode 'no-clone)
6899 (error "Cannot clone a buffer in %s mode" mode-name))
6900 (setq newname (or newname (buffer-name)))
6901 (if (string-match "<[0-9]+>\\'" newname)
6902 (setq newname (substring newname 0 (match-beginning 0))))
6903 (let ((buf (current-buffer))
6907 (mk (if mark-active (mark t)))
6908 (modified (buffer-modified-p))
6910 (lvars (buffer-local-variables))
6911 (process (get-buffer-process (current-buffer)))
6912 (new (generate-new-buffer (or newname (buffer-name)))))
6915 (with-current-buffer new
6916 (insert-buffer-substring buf)))
6917 (with-current-buffer new
6918 (narrow-to-region ptmin ptmax)
6920 (if mk (set-mark mk))
6921 (set-buffer-modified-p modified)
6923 ;; Clone the old buffer's process, if any.
6924 (when process (clone-process process))
6926 ;; Now set up the major mode.
6929 ;; Set up other local variables.
6931 (condition-case () ;in case var is read-only
6934 (set (make-local-variable (car v)) (cdr v)))
6938 ;; Run any hooks (typically set up by the major mode
6939 ;; for cloning to work properly).
6940 (run-hooks 'clone-buffer-hook))
6942 ;; Presumably the current buffer is shown in the selected frame, so
6943 ;; we want to display the clone elsewhere.
6944 (let ((same-window-regexps nil)
6945 (same-window-buffer-names))
6946 (pop-to-buffer new)))
6950 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6951 "Create an indirect buffer that is a twin copy of the current buffer.
6953 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6954 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6955 or if not called with a prefix arg, NEWNAME defaults to the current
6956 buffer's name. The name is modified by adding a `<N>' suffix to it
6957 or by incrementing the N in an existing suffix. Trying to clone a
6958 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6959 property results in an error.
6961 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6962 This is always done when called interactively.
6964 Optional third arg NORECORD non-nil means do not put this buffer at the
6965 front of the list of recently selected ones."
6968 (if (get major-mode 'no-clone-indirect)
6969 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6970 (list (if current-prefix-arg
6971 (read-buffer "Name of indirect buffer: " (current-buffer)))
6973 (if (get major-mode 'no-clone-indirect)
6974 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6975 (setq newname (or newname (buffer-name)))
6976 (if (string-match "<[0-9]+>\\'" newname)
6977 (setq newname (substring newname 0 (match-beginning 0))))
6978 (let* ((name (generate-new-buffer-name newname))
6979 (buffer (make-indirect-buffer (current-buffer) name t)))
6980 (with-current-buffer buffer
6981 (run-hooks 'clone-indirect-buffer-hook))
6983 (pop-to-buffer buffer norecord))
6987 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6988 "Like `clone-indirect-buffer' but display in another window."
6991 (if (get major-mode 'no-clone-indirect)
6992 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6993 (list (if current-prefix-arg
6994 (read-buffer "Name of indirect buffer: " (current-buffer)))
6996 (let ((pop-up-windows t))
6997 (clone-indirect-buffer newname display-flag norecord)))
7000 ;;; Handling of Backspace and Delete keys.
7002 (defcustom normal-erase-is-backspace 'maybe
7003 "Set the default behavior of the Delete and Backspace keys.
7005 If set to t, Delete key deletes forward and Backspace key deletes
7008 If set to nil, both Delete and Backspace keys delete backward.
7010 If set to 'maybe (which is the default), Emacs automatically
7011 selects a behavior. On window systems, the behavior depends on
7012 the keyboard used. If the keyboard has both a Backspace key and
7013 a Delete key, and both are mapped to their usual meanings, the
7014 option's default value is set to t, so that Backspace can be used
7015 to delete backward, and Delete can be used to delete forward.
7017 If not running under a window system, customizing this option
7018 accomplishes a similar effect by mapping C-h, which is usually
7019 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7020 via `keyboard-translate'. The former functionality of C-h is
7021 available on the F1 key. You should probably not use this
7022 setting if you don't have both Backspace, Delete and F1 keys.
7024 Setting this variable with setq doesn't take effect. Programmatically,
7025 call `normal-erase-is-backspace-mode' (which see) instead."
7026 :type '(choice (const :tag "Off" nil)
7027 (const :tag "Maybe" maybe)
7028 (other :tag "On" t))
7029 :group 'editing-basics
7031 :set (lambda (symbol value)
7032 ;; The fboundp is because of a problem with :set when
7033 ;; dumping Emacs. It doesn't really matter.
7034 (if (fboundp 'normal-erase-is-backspace-mode)
7035 (normal-erase-is-backspace-mode (or value 0))
7036 (set-default symbol value))))
7038 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7039 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7040 (unless frame (setq frame (selected-frame)))
7041 (with-selected-frame frame
7042 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7043 (normal-erase-is-backspace-mode
7044 (if (if (eq normal-erase-is-backspace 'maybe)
7045 (and (not noninteractive)
7046 (or (memq system-type '(ms-dos windows-nt))
7047 (memq window-system '(w32 ns))
7048 (and (memq window-system '(x))
7049 (fboundp 'x-backspace-delete-keys-p)
7050 (x-backspace-delete-keys-p))
7051 ;; If the terminal Emacs is running on has erase char
7052 ;; set to ^H, use the Backspace key for deleting
7053 ;; backward, and the Delete key for deleting forward.
7054 (and (null window-system)
7055 (eq tty-erase-char ?\^H))))
7056 normal-erase-is-backspace)
7059 (define-minor-mode normal-erase-is-backspace-mode
7060 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7061 With a prefix argument ARG, enable this feature if ARG is
7062 positive, and disable it otherwise. If called from Lisp, enable
7063 the mode if ARG is omitted or nil.
7065 On window systems, when this mode is on, Delete is mapped to C-d
7066 and Backspace is mapped to DEL; when this mode is off, both
7067 Delete and Backspace are mapped to DEL. (The remapping goes via
7068 `local-function-key-map', so binding Delete or Backspace in the
7069 global or local keymap will override that.)
7071 In addition, on window systems, the bindings of C-Delete, M-Delete,
7072 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7073 the global keymap in accordance with the functionality of Delete and
7074 Backspace. For example, if Delete is remapped to C-d, which deletes
7075 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7076 to DEL, which deletes backward, C-Delete is bound to
7077 `backward-kill-word'.
7079 If not running on a window system, a similar effect is accomplished by
7080 remapping C-h (normally produced by the Backspace key) and DEL via
7081 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7082 to C-d; if it's off, the keys are not remapped.
7084 When not running on a window system, and this mode is turned on, the
7085 former functionality of C-h is available on the F1 key. You should
7086 probably not turn on this mode on a text-only terminal if you don't
7087 have both Backspace, Delete and F1 keys.
7089 See also `normal-erase-is-backspace'."
7090 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7092 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7094 (let ((enabled (eq 1 (terminal-parameter
7095 nil 'normal-erase-is-backspace))))
7097 (cond ((or (memq window-system '(x w32 ns pc))
7098 (memq system-type '(ms-dos windows-nt)))
7100 `(([M-delete] [M-backspace])
7101 ([C-M-delete] [C-M-backspace])
7102 ([?\e C-delete] [?\e C-backspace]))))
7106 (define-key local-function-key-map [delete] [deletechar])
7107 (define-key local-function-key-map [kp-delete] [?\C-d])
7108 (define-key local-function-key-map [backspace] [?\C-?])
7109 (dolist (b bindings)
7110 ;; Not sure if input-decode-map is really right, but
7111 ;; keyboard-translate-table (used below) only works
7112 ;; for integer events, and key-translation-table is
7113 ;; global (like the global-map, used earlier).
7114 (define-key input-decode-map (car b) nil)
7115 (define-key input-decode-map (cadr b) nil)))
7116 (define-key local-function-key-map [delete] [?\C-?])
7117 (define-key local-function-key-map [kp-delete] [?\C-?])
7118 (define-key local-function-key-map [backspace] [?\C-?])
7119 (dolist (b bindings)
7120 (define-key input-decode-map (car b) (cadr b))
7121 (define-key input-decode-map (cadr b) (car b))))))
7125 (keyboard-translate ?\C-h ?\C-?)
7126 (keyboard-translate ?\C-? ?\C-d))
7127 (keyboard-translate ?\C-h ?\C-h)
7128 (keyboard-translate ?\C-? ?\C-?))))
7130 (if (called-interactively-p 'interactive)
7131 (message "Delete key deletes %s"
7132 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7133 "forward" "backward")))))
7135 (defvar vis-mode-saved-buffer-invisibility-spec nil
7136 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7138 (define-minor-mode read-only-mode
7139 "Change whether the current buffer is read-only.
7140 With prefix argument ARG, make the buffer read-only if ARG is
7141 positive, otherwise make it writable. If buffer is read-only
7142 and `view-read-only' is non-nil, enter view mode.
7144 Do not call this from a Lisp program unless you really intend to
7145 do the same thing as the \\[read-only-mode] command, including
7146 possibly enabling or disabling View mode. Also, note that this
7147 command works by setting the variable `buffer-read-only', which
7148 does not affect read-only regions caused by text properties. To
7149 ignore read-only status in a Lisp program (whether due to text
7150 properties or buffer state), bind `inhibit-read-only' temporarily
7151 to a non-nil value."
7152 :variable buffer-read-only
7154 ((and (not buffer-read-only) view-mode)
7155 (View-exit-and-edit)
7156 (make-local-variable 'view-read-only)
7157 (setq view-read-only t)) ; Must leave view mode.
7158 ((and buffer-read-only view-read-only
7159 ;; If view-mode is already active, `view-mode-enter' is a nop.
7161 (not (eq (get major-mode 'mode-class) 'special)))
7162 (view-mode-enter))))
7164 (define-minor-mode visible-mode
7165 "Toggle making all invisible text temporarily visible (Visible mode).
7166 With a prefix argument ARG, enable Visible mode if ARG is
7167 positive, and disable it otherwise. If called from Lisp, enable
7168 the mode if ARG is omitted or nil.
7170 This mode works by saving the value of `buffer-invisibility-spec'
7171 and setting it to nil."
7173 :group 'editing-basics
7174 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7175 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7176 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7178 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7179 buffer-invisibility-spec)
7180 (setq buffer-invisibility-spec nil)))
7182 ;; Minibuffer prompt stuff.
7184 ;;(defun minibuffer-prompt-modification (start end)
7185 ;; (error "You cannot modify the prompt"))
7188 ;;(defun minibuffer-prompt-insertion (start end)
7189 ;; (let ((inhibit-modification-hooks t))
7190 ;; (delete-region start end)
7191 ;; ;; Discard undo information for the text insertion itself
7192 ;; ;; and for the text deletion.above.
7193 ;; (when (consp buffer-undo-list)
7194 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7195 ;; (message "You cannot modify the prompt")))
7198 ;;(setq minibuffer-prompt-properties
7199 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7200 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7203 ;;;; Problematic external packages.
7205 ;; rms says this should be done by specifying symbols that define
7206 ;; versions together with bad values. This is therefore not as
7207 ;; flexible as it could be. See the thread:
7208 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7209 (defconst bad-packages-alist
7210 ;; Not sure exactly which semantic versions have problems.
7211 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7212 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
7213 "The version of `semantic' loaded does not work in Emacs 22.
7214 It can cause constant high CPU load.
7215 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7216 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7217 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7218 ;; provided the `CUA-mode' feature. Since this is no longer true,
7219 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7221 "CUA-mode is now part of the standard GNU Emacs distribution,
7222 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7224 You have loaded an older version of CUA-mode which does not work
7225 correctly with this version of Emacs. You should remove the old
7226 version and use the one distributed with Emacs."))
7227 "Alist of packages known to cause problems in this version of Emacs.
7228 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7229 PACKAGE is either a regular expression to match file names, or a
7230 symbol (a feature name); see the documentation of
7231 `after-load-alist', to which this variable adds functions.
7232 SYMBOL is either the name of a string variable, or `t'. Upon
7233 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7234 warning using STRING as the message.")
7236 (defun bad-package-check (package)
7237 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7239 (let* ((list (assoc package bad-packages-alist))
7240 (symbol (nth 1 list)))
7244 (and (stringp (setq symbol (eval symbol)))
7245 (string-match-p (nth 2 list) symbol)))
7246 (display-warning package (nth 3 list) :warning)))
7249 (mapc (lambda (elem)
7250 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
7256 ;;; simple.el ends here