1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2015 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
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 (eval-when-compile (require 'cl-lib))
33 (declare-function widget-convert "wid-edit" (type &rest args))
34 (declare-function shell-mode "shell" ())
37 (defvar compilation-current-error)
38 (defvar compilation-context-lines)
40 (defcustom idle-update-delay 0.5
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
52 (defgroup paren-matching nil
53 "Highlight (un)matching of parens and expressions."
56 ;;; next-error support framework
58 (defgroup next-error nil
59 "`next-error' support framework."
64 '((t (:inherit region)))
65 "Face used to highlight next error locus."
69 (defcustom next-error-highlight 0.5
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
78 :type '(choice (number :tag "Highlight for specified time")
79 (const :tag "Semipermanent highlighting" t)
80 (const :tag "No highlighting" nil)
81 (const :tag "Fringe arrow" fringe-arrow))
85 (defcustom next-error-highlight-no-select 0.5
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
92 :type '(choice (number :tag "Highlight for specified time")
93 (const :tag "Semipermanent highlighting" t)
94 (const :tag "No highlighting" nil)
95 (const :tag "Fringe arrow" fringe-arrow))
99 (defcustom next-error-recenter nil
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
102 :type '(choice (integer :tag "Line to recenter to")
103 (const :tag "Center of window" (4))
104 (const :tag "No recentering" nil))
108 (defcustom next-error-hook nil
109 "List of hook functions run by `next-error' after visiting source file."
113 (defvar next-error-highlight-timer nil)
115 (defvar next-error-overlay-arrow-position nil)
116 (put 'next-error-overlay-arrow-position 'overlay-arrow-string (purecopy "=>"))
117 (add-to-list 'overlay-arrow-variable-list 'next-error-overlay-arrow-position)
119 (defvar next-error-last-buffer nil
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
122 similar mode is started, or when it is used with \\[next-error]
123 or \\[compile-goto-error].")
125 (defvar next-error-function nil
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
134 (make-variable-buffer-local 'next-error-function)
136 (defvar next-error-move-function nil
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
141 nil means use goto-char using the second argument position.")
142 (make-variable-buffer-local 'next-error-move-function)
144 (defsubst next-error-buffer-p (buffer
145 &optional avoid-current
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
160 (and (buffer-name buffer) ;First make sure it's live.
161 (not (and avoid-current (eq buffer (current-buffer))))
162 (with-current-buffer buffer
163 (if next-error-function ; This is the normal test.
164 ;; Optionally reject some buffers.
165 (if extra-test-exclusive
166 (funcall extra-test-exclusive)
168 ;; Optionally accept some other buffers.
169 (and extra-test-inclusive
170 (funcall extra-test-inclusive))))))
172 (defun next-error-find-buffer (&optional avoid-current
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
189 (let ((window-buffers
191 (delq nil (mapcar (lambda (w)
192 (if (next-error-buffer-p
195 extra-test-inclusive extra-test-exclusive)
198 (if (eq (length window-buffers) 1)
199 (car window-buffers)))
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 (if (and next-error-last-buffer
202 (next-error-buffer-p next-error-last-buffer avoid-current
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
206 (if (next-error-buffer-p (current-buffer) avoid-current
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
210 (let ((buffers (buffer-list)))
212 (not (next-error-buffer-p
213 (car buffers) avoid-current
214 extra-test-inclusive extra-test-exclusive)))
215 (setq buffers (cdr buffers)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
220 (next-error-buffer-p (current-buffer) nil
221 extra-test-inclusive extra-test-exclusive)
223 (message "This is the only buffer with error message locations")
226 (error "No buffers contain error message locations")))
228 (defun next-error (&optional arg reset)
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
236 Just \\[universal-argument] as a prefix means reparse the error message buffer
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
241 \\[next-error] normally uses the most recently started
242 compilation, grep, or occur buffer. It can also operate on any
243 buffer with output from the \\[compile], \\[grep] commands, or,
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
248 \\[next-error] in that buffer when it is the only one displayed
249 in the current frame.
251 Once \\[next-error] has chosen the buffer for error messages, it
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
259 (if (consp arg) (setq reset t arg nil))
260 (when (setq next-error-last-buffer (next-error-find-buffer))
261 ;; we know here that next-error-function is a valid symbol we can funcall
262 (with-current-buffer next-error-last-buffer
263 (funcall next-error-function (prefix-numeric-value arg) reset)
264 (when next-error-recenter
265 (recenter next-error-recenter))
266 (run-hooks 'next-error-hook))))
268 (defun next-error-internal ()
269 "Visit the source code corresponding to the `next-error' message at point."
270 (setq next-error-last-buffer (current-buffer))
271 ;; we know here that next-error-function is a valid symbol we can funcall
272 (with-current-buffer next-error-last-buffer
273 (funcall next-error-function 0 nil)
274 (when next-error-recenter
275 (recenter next-error-recenter))
276 (run-hooks 'next-error-hook)))
278 (defalias 'goto-next-locus 'next-error)
279 (defalias 'next-match 'next-error)
281 (defun previous-error (&optional n)
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
287 This operates on the output from the \\[compile] and \\[grep] commands."
289 (next-error (- (or n 1))))
291 (defun first-error (&optional n)
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
295 This operates on the output from the \\[compile] command, for instance."
299 (defun next-error-no-select (&optional n)
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
303 Finds and highlights the source line like \\[next-error], but does not
304 select the source buffer."
306 (let ((next-error-highlight next-error-highlight-no-select))
308 (pop-to-buffer next-error-last-buffer))
310 (defun previous-error-no-select (&optional n)
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
314 Finds and highlights the source line like \\[previous-error], but does not
315 select the source buffer."
317 (next-error-no-select (- (or n 1))))
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
320 (defvar next-error-follow-last-line nil)
322 (define-minor-mode next-error-follow-minor-mode
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
329 :group 'next-error :init-value nil :lighter " Fol"
330 (if (not next-error-follow-minor-mode)
331 (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t)
332 (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t)
333 (make-local-variable 'next-error-follow-last-line)))
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
337 (defun next-error-follow-mode-post-command-hook ()
338 (unless (equal next-error-follow-last-line (line-number-at-pos))
339 (setq next-error-follow-last-line (line-number-at-pos))
341 (let ((compilation-context-lines nil))
342 (setq compilation-current-error (point))
343 (next-error-no-select 0))
349 (defun fundamental-mode ()
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
353 (kill-all-local-variables)
356 ;; Special major modes to view specially formatted data rather than files.
358 (defvar special-mode-map
359 (let ((map (make-sparse-keymap)))
360 (suppress-keymap map)
361 (define-key map "q" 'quit-window)
362 (define-key map " " 'scroll-up-command)
363 (define-key map [?\S-\ ] 'scroll-down-command)
364 (define-key map "\C-?" 'scroll-down-command)
365 (define-key map "?" 'describe-mode)
366 (define-key map "h" 'describe-mode)
367 (define-key map ">" 'end-of-buffer)
368 (define-key map "<" 'beginning-of-buffer)
369 (define-key map "g" 'revert-buffer)
372 (put 'special-mode 'mode-class 'special)
373 (define-derived-mode special-mode nil "Special"
374 "Parent major mode from which special major modes should inherit."
375 (setq buffer-read-only t))
377 ;; Making and deleting lines.
379 (defvar self-insert-uses-region-functions nil
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
384 can refrain from consuming the region.")
386 (defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard))
387 "Propertized string representing a hard newline character.")
389 (defun newline (&optional arg interactive)
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
397 a newline, use \\[electric-indent-just-newline].
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
402 (interactive "*P\np")
403 (barf-if-buffer-read-only)
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
406 (let* ((was-page-start (and (bolp) (looking-at page-delimiter)))
408 (last-command-event ?\n)
409 ;; Don't auto-fill if we have a numeric argument.
410 (auto-fill-function (if arg nil auto-fill-function))
412 ;; Do the rest in post-self-insert-hook, because we want to do it
413 ;; *before* other functions on that hook.
415 (cl-assert (eq ?\n (char-before)))
416 ;; Mark the newline(s) `hard'.
417 (if use-hard-newlines
418 (set-hard-newline-properties
419 (- (point) (prefix-numeric-value arg)) (point)))
420 ;; If the newline leaves the previous line blank, and we
421 ;; have a left margin, delete that from the blank line.
423 (goto-char beforepos)
425 (and (looking-at "[ \t]$")
426 (> (current-left-margin) 0)
427 (delete-region (point)
428 (line-end-position))))
429 ;; Indent the line after the newline, except in one case:
430 ;; when we added the newline at the beginning of a line which
433 (move-to-left-margin nil t)))))
435 (if (not interactive)
436 ;; FIXME: For non-interactive uses, many calls actually just want
437 ;; (insert "\n"), so maybe we should do just that, so as to avoid
438 ;; the risk of filling or running abbrevs unexpectedly.
439 (let ((post-self-insert-hook (list postproc)))
440 (self-insert-command (prefix-numeric-value arg)))
443 (add-hook 'post-self-insert-hook postproc nil t)
444 (self-insert-command (prefix-numeric-value arg)))
445 ;; We first used let-binding to protect the hook, but that was naive
446 ;; since add-hook affects the symbol-default value of the variable,
447 ;; whereas the let-binding might only protect the buffer-local value.
448 (remove-hook 'post-self-insert-hook postproc t)))
449 (cl-assert (not (member postproc post-self-insert-hook)))
450 (cl-assert (not (member postproc (default-value 'post-self-insert-hook))))))
453 (defun set-hard-newline-properties (from to)
454 (let ((sticky (get-text-property from 'rear-nonsticky)))
455 (put-text-property from to 'hard 't)
456 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
457 (if (and (listp sticky) (not (memq 'hard sticky)))
458 (put-text-property from (point) 'rear-nonsticky
459 (cons 'hard sticky)))))
462 "Insert a newline and leave point before it.
463 If there is a fill prefix and/or a `left-margin', insert them
464 on the new line if the line would have been blank.
465 With arg N, insert N newlines."
467 (let* ((do-fill-prefix (and fill-prefix (bolp)))
468 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
470 ;; Don't expand an abbrev before point.
476 (if do-left-margin (indent-to (current-left-margin)))
477 (if do-fill-prefix (insert-and-inherit fill-prefix))))
483 (defun split-line (&optional arg)
484 "Split current line, moving portion beyond point vertically down.
485 If the current line starts with `fill-prefix', insert it on the new
486 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
488 When called from Lisp code, ARG may be a prefix string to copy."
490 (skip-chars-forward " \t")
491 (let* ((col (current-column))
493 ;; What prefix should we check for (nil means don't).
494 (prefix (cond ((stringp arg) arg)
497 ;; Does this line start with it?
498 (have-prfx (and prefix
501 (looking-at (regexp-quote prefix))))))
503 (if have-prfx (insert-and-inherit prefix))
507 (defun delete-indentation (&optional arg)
508 "Join this line to previous and fix up whitespace at join.
509 If there is a fill prefix, delete it from the beginning of this line.
510 With argument, join this line to following line."
513 (if arg (forward-line 1))
514 (if (eq (preceding-char) ?\n)
516 (delete-region (point) (1- (point)))
517 ;; If the second line started with the fill prefix,
518 ;; delete the prefix.
520 (<= (+ (point) (length fill-prefix)) (point-max))
522 (buffer-substring (point)
523 (+ (point) (length fill-prefix)))))
524 (delete-region (point) (+ (point) (length fill-prefix))))
525 (fixup-whitespace))))
527 (defalias 'join-line #'delete-indentation) ; easier to find
529 (defun delete-blank-lines ()
530 "On blank line, delete all surrounding blank lines, leaving just one.
531 On isolated blank line, delete that one.
532 On nonblank line, delete any immediately following blank lines."
534 (let (thisblank singleblank)
537 (setq thisblank (looking-at "[ \t]*$"))
538 ;; Set singleblank if there is just one blank line here.
541 (not (looking-at "[ \t]*\n[ \t]*$"))
543 (progn (forward-line -1)
544 (not (looking-at "[ \t]*$")))))))
545 ;; Delete preceding blank lines, and this one too if it's the only one.
549 (if singleblank (forward-line 1))
550 (delete-region (point)
551 (if (re-search-backward "[^ \t\n]" nil t)
552 (progn (forward-line 1) (point))
554 ;; Delete following blank lines, unless the current line is blank
555 ;; and there are no following blank lines.
556 (if (not (and thisblank singleblank))
560 (delete-region (point)
561 (if (re-search-forward "[^ \t\n]" nil t)
562 (progn (beginning-of-line) (point))
564 ;; Handle the special case where point is followed by newline and eob.
565 ;; Delete the line, leaving point at eob.
566 (if (looking-at "^[ \t]*\n\\'")
567 (delete-region (point) (point-max)))))
569 (defcustom delete-trailing-lines t
570 "If non-nil, \\[delete-trailing-whitespace] deletes trailing lines.
571 Trailing lines are deleted only if `delete-trailing-whitespace'
572 is called on the entire buffer (rather than an active region)."
577 (defun delete-trailing-whitespace (&optional start end)
578 "Delete trailing whitespace between START and END.
579 If called interactively, START and END are the start/end of the
580 region if the mark is active, or of the buffer's accessible
581 portion if the mark is inactive.
583 This command deletes whitespace characters after the last
584 non-whitespace character in each line between START and END. It
585 does not consider formfeed characters to be whitespace.
587 If this command acts on the entire buffer (i.e. if called
588 interactively with the mark inactive, or called from Lisp with
589 END nil), it also deletes all trailing lines at the end of the
590 buffer if the variable `delete-trailing-lines' is non-nil."
592 (barf-if-buffer-read-only)
594 (list (region-beginning) (region-end))
598 (let ((end-marker (copy-marker (or end (point-max))))
599 (start (or start (point-min))))
601 (while (re-search-forward "\\s-$" end-marker t)
602 (skip-syntax-backward "-" (line-beginning-position))
603 ;; Don't delete formfeeds, even if they are considered whitespace.
604 (if (looking-at-p ".*\f")
605 (goto-char (match-end 0)))
606 (delete-region (point) (match-end 0)))
607 ;; Delete trailing empty lines.
608 (goto-char end-marker)
610 delete-trailing-lines
611 ;; Really the end of buffer.
612 (= (point-max) (1+ (buffer-size)))
613 (<= (skip-chars-backward "\n") -2))
614 (delete-region (1+ (point)) end-marker))
615 (set-marker end-marker nil))))
616 ;; Return nil for the benefit of `write-file-functions'.
619 (defun newline-and-indent ()
620 "Insert a newline, then indent according to major mode.
621 Indentation is done using the value of `indent-line-function'.
622 In programming language modes, this is the same as TAB.
623 In some text modes, where TAB inserts a tab, this command indents to the
624 column specified by the function `current-left-margin'."
626 (delete-horizontal-space t)
628 (indent-according-to-mode))
630 (defun reindent-then-newline-and-indent ()
631 "Reindent current line, insert newline, then indent the new line.
632 Indentation of both lines is done according to the current major mode,
633 which means calling the current value of `indent-line-function'.
634 In programming language modes, this is the same as TAB.
635 In some text modes, where TAB inserts a tab, this indents to the
636 column specified by the function `current-left-margin'."
639 ;; Be careful to insert the newline before indenting the line.
640 ;; Otherwise, the indentation might be wrong.
644 ;; We are at EOL before the call to indent-according-to-mode, and
645 ;; after it we usually are as well, but not always. We tried to
646 ;; address it with `save-excursion' but that uses a normal marker
647 ;; whereas we need `move after insertion', so we do the save/restore
649 (setq pos (copy-marker pos t))
650 (indent-according-to-mode)
652 ;; Remove the trailing white-space after indentation because
653 ;; indentation may introduce the whitespace.
654 (delete-horizontal-space t))
655 (indent-according-to-mode)))
657 (defcustom read-quoted-char-radix 8
658 "Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
659 Legitimate radix values are 8, 10 and 16."
660 :type '(choice (const 8) (const 10) (const 16))
661 :group 'editing-basics)
663 (defun read-quoted-char (&optional prompt)
664 "Like `read-char', but do not allow quitting.
665 Also, if the first character read is an octal digit,
666 we read any number of octal digits and return the
667 specified character code. Any nondigit terminates the sequence.
668 If the terminator is RET, it is discarded;
669 any other terminator is used itself as input.
671 The optional argument PROMPT specifies a string to use to prompt the user.
672 The variable `read-quoted-char-radix' controls which radix to use
674 (let ((message-log-max nil)
675 (help-events (delq nil (mapcar (lambda (c) (unless (characterp c) c))
677 done (first t) (code 0) translated)
679 (let ((inhibit-quit first)
680 ;; Don't let C-h or other help chars get the help
681 ;; message--only help function keys. See bug#16617.
683 (help-event-list help-events)
685 "Type the special character you want to use,
686 or the octal character code.
687 RET terminates the character code and is discarded;
688 any other non-digit terminates the character code and is then used as input."))
689 (setq translated (read-key (and prompt (format "%s-" prompt))))
690 (if inhibit-quit (setq quit-flag nil)))
691 (if (integerp translated)
692 (setq translated (char-resolve-modifiers translated)))
693 (cond ((null translated))
694 ((not (integerp translated))
695 (setq unread-command-events
696 (nconc (listify-key-sequence (this-single-command-raw-keys))
697 unread-command-events)
699 ((/= (logand translated ?\M-\^@) 0)
700 ;; Turn a meta-character into a character with the 0200 bit set.
701 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
703 ((and (<= ?0 translated)
704 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
705 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
706 (and prompt (setq prompt (message "%s %c" prompt translated))))
707 ((and (<= ?a (downcase translated))
708 (< (downcase translated)
709 (+ ?a -10 (min 36 read-quoted-char-radix))))
710 (setq code (+ (* code read-quoted-char-radix)
711 (+ 10 (- (downcase translated) ?a))))
712 (and prompt (setq prompt (message "%s %c" prompt translated))))
713 ((and (not first) (eq translated ?\C-m))
716 (setq unread-command-events
717 (nconc (listify-key-sequence (this-single-command-raw-keys))
718 unread-command-events)
720 (t (setq code translated
725 (defun quoted-insert (arg)
726 "Read next input character and insert it.
727 This is useful for inserting control characters.
728 With argument, insert ARG copies of the character.
730 If the first character you type after this command is an octal digit,
731 you should type a sequence of octal digits which specify a character code.
732 Any nondigit terminates the sequence. If the terminator is a RET,
733 it is discarded; any other terminator is used itself as input.
734 The variable `read-quoted-char-radix' specifies the radix for this feature;
735 set it to 10 or 16 to use decimal or hex instead of octal.
737 In overwrite mode, this function inserts the character anyway, and
738 does not handle octal digits specially. This means that if you use
739 overwrite as your normal editing mode, you can use this function to
740 insert characters when necessary.
742 In binary overwrite mode, this function does overwrite, and octal
743 digits are interpreted as a character code. This is intended to be
744 useful for editing binary files."
747 ;; Avoid "obsolete" warnings for translation-table-for-input.
749 (let (translation-table-for-input input-method-function)
750 (if (or (not overwrite-mode)
751 (eq overwrite-mode 'overwrite-mode-binary))
754 ;; This used to assume character codes 0240 - 0377 stand for
755 ;; characters in some single-byte character set, and converted them
756 ;; to Emacs characters. But in 23.1 this feature is deprecated
757 ;; in favor of inserting the corresponding Unicode characters.
758 ;; (if (and enable-multibyte-characters
761 ;; (setq char (unibyte-char-to-multibyte char)))
762 (unless (characterp char)
763 (user-error "%s is not a valid character"
764 (key-description (vector char))))
766 (if (eq overwrite-mode 'overwrite-mode-binary)
769 (insert-and-inherit char)
770 (setq arg (1- arg)))))
772 (defun forward-to-indentation (&optional arg)
773 "Move forward ARG lines and position at first nonblank character."
775 (forward-line (or arg 1))
776 (skip-chars-forward " \t"))
778 (defun backward-to-indentation (&optional arg)
779 "Move backward ARG lines and position at first nonblank character."
781 (forward-line (- (or arg 1)))
782 (skip-chars-forward " \t"))
784 (defun back-to-indentation ()
785 "Move point to the first non-whitespace character on this line."
787 (beginning-of-line 1)
788 (skip-syntax-forward " " (line-end-position))
789 ;; Move back over chars that have whitespace syntax but have the p flag.
790 (backward-prefix-chars))
792 (defun fixup-whitespace ()
793 "Fixup white space between objects around point.
794 Leave one space or none, according to the context."
797 (delete-horizontal-space)
798 (if (or (looking-at "^\\|\\s)")
799 (save-excursion (forward-char -1)
800 (looking-at "$\\|\\s(\\|\\s'")))
804 (defun delete-horizontal-space (&optional backward-only)
805 "Delete all spaces and tabs around point.
806 If BACKWARD-ONLY is non-nil, only delete them before point."
808 (let ((orig-pos (point)))
813 (skip-chars-forward " \t")
814 (constrain-to-field nil orig-pos t)))
816 (skip-chars-backward " \t")
817 (constrain-to-field nil orig-pos)))))
819 (defun just-one-space (&optional n)
820 "Delete all spaces and tabs around point, leaving one space (or N spaces).
821 If N is negative, delete newlines as well, leaving -N spaces.
822 See also `cycle-spacing'."
824 (cycle-spacing n nil 'single-shot))
826 (defvar cycle-spacing--context nil
827 "Store context used in consecutive calls to `cycle-spacing' command.
828 The first time `cycle-spacing' runs, it saves in this variable:
829 its N argument, the original point position, and the original spacing
832 (defun cycle-spacing (&optional n preserve-nl-back mode)
833 "Manipulate whitespace around point in a smart way.
834 In interactive use, this function behaves differently in successive
837 The first call in a sequence acts like `just-one-space'.
838 It deletes all spaces and tabs around point, leaving one space
839 \(or N spaces). N is the prefix argument. If N is negative,
840 it deletes newlines as well, leaving -N spaces.
841 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
843 The second call in a sequence deletes all spaces.
845 The third call in a sequence restores the original whitespace (and point).
847 If MODE is `single-shot', it only performs the first step in the sequence.
848 If MODE is `fast' and the first step would not result in any change
849 \(i.e., there are exactly (abs N) spaces around point),
850 the function goes straight to the second step.
852 Repeatedly calling the function with different values of N starts a
853 new sequence each time."
855 (let ((orig-pos (point))
856 (skip-characters (if (and n (< n 0)) " \t\n\r" " \t"))
857 (num (abs (or n 1))))
858 (skip-chars-backward (if preserve-nl-back " \t" skip-characters))
859 (constrain-to-field nil orig-pos)
861 ;; Command run for the first time, single-shot mode or different argument
862 ((or (eq 'single-shot mode)
863 (not (equal last-command this-command))
864 (not cycle-spacing--context)
865 (not (eq (car cycle-spacing--context) n)))
866 (let* ((start (point))
867 (num (- num (skip-chars-forward " " (+ num (point)))))
870 (skip-chars-forward skip-characters)
871 (constrain-to-field nil orig-pos t))))
872 (setq cycle-spacing--context ;; Save for later.
873 ;; Special handling for case where there was no space at all.
874 (unless (= start end)
875 (cons n (cons orig-pos (buffer-substring start (point))))))
876 ;; If this run causes no change in buffer content, delete all spaces,
877 ;; otherwise delete all excess spaces.
878 (delete-region (if (and (eq mode 'fast) (zerop num) (= mid end))
880 (insert (make-string num ?\s))))
882 ;; Command run for the second time.
883 ((not (equal orig-pos (point)))
884 (delete-region (point) orig-pos))
886 ;; Command run for the third time.
888 (insert (cddr cycle-spacing--context))
889 (goto-char (cadr cycle-spacing--context))
890 (setq cycle-spacing--context nil)))))
892 (defun beginning-of-buffer (&optional arg)
893 "Move point to the beginning of the buffer.
894 With numeric arg N, put point N/10 of the way from the beginning.
895 If the buffer is narrowed, this command uses the beginning of the
896 accessible part of the buffer.
898 If Transient Mark mode is disabled, leave mark at previous
899 position, unless a \\[universal-argument] prefix is supplied."
900 (declare (interactive-only "use `(goto-char (point-min))' instead."))
905 (let ((size (- (point-max) (point-min))))
906 (goto-char (if (and arg (not (consp arg)))
909 ;; Avoid overflow for large buffer sizes!
910 (* (prefix-numeric-value arg)
912 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
914 (if (and arg (not (consp arg))) (forward-line 1)))
916 (defun end-of-buffer (&optional arg)
917 "Move point to the end of the buffer.
918 With numeric arg N, put point N/10 of the way from the end.
919 If the buffer is narrowed, this command uses the end of the
920 accessible part of the buffer.
922 If Transient Mark mode is disabled, leave mark at previous
923 position, unless a \\[universal-argument] prefix is supplied."
924 (declare (interactive-only "use `(goto-char (point-max))' instead."))
926 (or (consp arg) (region-active-p) (push-mark))
927 (let ((size (- (point-max) (point-min))))
928 (goto-char (if (and arg (not (consp arg)))
931 ;; Avoid overflow for large buffer sizes!
932 (* (prefix-numeric-value arg)
934 (/ (* size (prefix-numeric-value arg)) 10)))
936 ;; If we went to a place in the middle of the buffer,
937 ;; adjust it to the beginning of a line.
938 (cond ((and arg (not (consp arg))) (forward-line 1))
939 ((and (eq (current-buffer) (window-buffer))
940 (> (point) (window-end nil t)))
941 ;; If the end of the buffer is not already on the screen,
942 ;; then scroll specially to put it near, but not at, the bottom.
943 (overlay-recenter (point))
946 (defcustom delete-active-region t
947 "Whether single-char deletion commands delete an active region.
948 This has an effect only if Transient Mark mode is enabled, and
949 affects `delete-forward-char' and `delete-backward-char', though
952 If the value is the symbol `kill', the active region is killed
954 :type '(choice (const :tag "Delete active region" t)
955 (const :tag "Kill active region" kill)
956 (const :tag "Do ordinary deletion" nil))
960 (defvar region-extract-function
962 (when (region-beginning)
963 (if (eq delete 'delete-only)
964 (delete-region (region-beginning) (region-end))
965 (filter-buffer-substring (region-beginning) (region-end) delete))))
966 "Function to get the region's content.
967 Called with one argument DELETE.
968 If DELETE is `delete-only', then only delete the region and the return value
969 is undefined. If DELETE is nil, just return the content as a string.
970 If anything else, delete the region and return its content as a string.")
972 (defun delete-backward-char (n &optional killflag)
973 "Delete the previous N characters (following if N is negative).
974 If Transient Mark mode is enabled, the mark is active, and N is 1,
975 delete the text in the region and deactivate the mark instead.
976 To disable this, set option `delete-active-region' to nil.
978 Optional second arg KILLFLAG, if non-nil, means to kill (save in
979 kill ring) instead of delete. Interactively, N is the prefix
980 arg, and KILLFLAG is set if N is explicitly specified.
982 In Overwrite mode, single character backward deletion may replace
983 tabs with spaces so as to back over columns, unless point is at
984 the end of the line."
985 (declare (interactive-only delete-char))
988 (signal 'wrong-type-argument (list 'integerp n)))
989 (cond ((and (use-region-p)
992 ;; If a region is active, kill or delete it.
993 (if (eq delete-active-region 'kill)
994 (kill-region (region-beginning) (region-end) 'region)
995 (funcall region-extract-function 'delete-only)))
996 ;; In Overwrite mode, maybe untabify while deleting
997 ((null (or (null overwrite-mode)
999 (memq (char-before) '(?\t ?\n))
1001 (eq (char-after) ?\n)))
1002 (let ((ocol (current-column)))
1003 (delete-char (- n) killflag)
1005 (insert-char ?\s (- ocol (current-column)) nil))))
1006 ;; Otherwise, do simple deletion.
1007 (t (delete-char (- n) killflag))))
1009 (defun delete-forward-char (n &optional killflag)
1010 "Delete the following N characters (previous if N is negative).
1011 If Transient Mark mode is enabled, the mark is active, and N is 1,
1012 delete the text in the region and deactivate the mark instead.
1013 To disable this, set variable `delete-active-region' to nil.
1015 Optional second arg KILLFLAG non-nil means to kill (save in kill
1016 ring) instead of delete. Interactively, N is the prefix arg, and
1017 KILLFLAG is set if N was explicitly specified."
1018 (declare (interactive-only delete-char))
1019 (interactive "p\nP")
1020 (unless (integerp n)
1021 (signal 'wrong-type-argument (list 'integerp n)))
1022 (cond ((and (use-region-p)
1023 delete-active-region
1025 ;; If a region is active, kill or delete it.
1026 (if (eq delete-active-region 'kill)
1027 (kill-region (region-beginning) (region-end) 'region)
1028 (funcall region-extract-function 'delete-only)))
1030 ;; Otherwise, do simple deletion.
1031 (t (delete-char n killflag))))
1033 (defun mark-whole-buffer ()
1034 "Put point at beginning and mark at end of buffer.
1035 If narrowing is in effect, only uses the accessible part of the buffer.
1036 You probably should not use this function in Lisp programs;
1037 it is usually a mistake for a Lisp function to use any subroutine
1038 that uses or sets the mark."
1039 (declare (interactive-only t))
1042 (push-mark (point-max) nil t)
1043 (goto-char (point-min)))
1046 ;; Counting lines, one way or another.
1048 (defun goto-line (line &optional buffer)
1049 "Go to LINE, counting from line 1 at beginning of buffer.
1050 If called interactively, a numeric prefix argument specifies
1051 LINE; without a numeric prefix argument, read LINE from the
1054 If optional argument BUFFER is non-nil, switch to that buffer and
1055 move to line LINE there. If called interactively with \\[universal-argument]
1056 as argument, BUFFER is the most recently selected other buffer.
1058 Prior to moving point, this function sets the mark (without
1059 activating it), unless Transient Mark mode is enabled and the
1060 mark is already active.
1062 This function is usually the wrong thing to use in a Lisp program.
1063 What you probably want instead is something like:
1064 (goto-char (point-min))
1065 (forward-line (1- N))
1066 If at all possible, an even better solution is to use char counts
1067 rather than line counts."
1068 (declare (interactive-only forward-line))
1070 (if (and current-prefix-arg (not (consp current-prefix-arg)))
1071 (list (prefix-numeric-value current-prefix-arg))
1072 ;; Look for a default, a number in the buffer at point.
1075 (skip-chars-backward "0-9")
1076 (if (looking-at "[0-9]")
1078 (buffer-substring-no-properties
1080 (progn (skip-chars-forward "0-9")
1082 ;; Decide if we're switching buffers.
1084 (if (consp current-prefix-arg)
1085 (other-buffer (current-buffer) t)))
1088 (concat " in " (buffer-name buffer))
1090 ;; Read the argument, offering that number (if any) as default.
1091 (list (read-number (format "Goto line%s: " buffer-prompt)
1092 (list default (line-number-at-pos)))
1094 ;; Switch to the desired buffer, one way or another.
1096 (let ((window (get-buffer-window buffer)))
1097 (if window (select-window window)
1098 (switch-to-buffer-other-window buffer))))
1099 ;; Leave mark at previous position
1100 (or (region-active-p) (push-mark))
1101 ;; Move to the specified line number in that buffer.
1104 (goto-char (point-min))
1105 (if (eq selective-display t)
1106 (re-search-forward "[\n\C-m]" nil 'end (1- line))
1107 (forward-line (1- line)))))
1109 (defun count-words-region (start end &optional arg)
1110 "Count the number of words in the region.
1111 If called interactively, print a message reporting the number of
1112 lines, words, and characters in the region (whether or not the
1113 region is active); with prefix ARG, report for the entire buffer
1114 rather than the region.
1116 If called from Lisp, return the number of words between positions
1118 (interactive (if current-prefix-arg
1119 (list nil nil current-prefix-arg)
1120 (list (region-beginning) (region-end) nil)))
1121 (cond ((not (called-interactively-p 'any))
1122 (count-words start end))
1124 (count-words--buffer-message))
1126 (count-words--message "Region" start end))))
1128 (defun count-words (start end)
1129 "Count words between START and END.
1130 If called interactively, START and END are normally the start and
1131 end of the buffer; but if the region is active, START and END are
1132 the start and end of the region. Print a message reporting the
1133 number of lines, words, and chars.
1135 If called from Lisp, return the number of words between START and
1136 END, without printing any message."
1137 (interactive (list nil nil))
1138 (cond ((not (called-interactively-p 'any))
1142 (narrow-to-region start end)
1143 (goto-char (point-min))
1144 (while (forward-word 1)
1145 (setq words (1+ words)))))
1148 (call-interactively 'count-words-region))
1150 (count-words--buffer-message))))
1152 (defun count-words--buffer-message ()
1153 (count-words--message
1154 (if (buffer-narrowed-p) "Narrowed part of buffer" "Buffer")
1155 (point-min) (point-max)))
1157 (defun count-words--message (str start end)
1158 (let ((lines (count-lines start end))
1159 (words (count-words start end))
1160 (chars (- end start)))
1161 (message "%s has %d line%s, %d word%s, and %d character%s."
1163 lines (if (= lines 1) "" "s")
1164 words (if (= words 1) "" "s")
1165 chars (if (= chars 1) "" "s"))))
1167 (define-obsolete-function-alias 'count-lines-region 'count-words-region "24.1")
1170 "Print the current buffer line number and narrowed line number of point."
1172 (let ((start (point-min))
1173 (n (line-number-at-pos)))
1175 (message "Line %d" n)
1179 (message "line %d (narrowed line %d)"
1180 (+ n (line-number-at-pos start) -1) n))))))
1182 (defun count-lines (start end)
1183 "Return number of lines between START and END.
1184 This is usually the number of newlines between them,
1185 but can be one more if START is not equal to END
1186 and the greater of them is not at the start of a line."
1189 (narrow-to-region start end)
1190 (goto-char (point-min))
1191 (if (eq selective-display t)
1194 (while (re-search-forward "[\n\C-m]" nil t 40)
1195 (setq done (+ 40 done)))
1196 (while (re-search-forward "[\n\C-m]" nil t 1)
1197 (setq done (+ 1 done)))
1198 (goto-char (point-max))
1199 (if (and (/= start end)
1203 (- (buffer-size) (forward-line (buffer-size)))))))
1205 (defun line-number-at-pos (&optional pos)
1206 "Return (narrowed) buffer line number at position POS.
1207 If POS is nil, use current buffer location.
1208 Counting starts at (point-min), so the value refers
1209 to the contents of the accessible portion of the buffer."
1210 (let ((opoint (or pos (point))) start)
1212 (goto-char (point-min))
1213 (setq start (point))
1216 (1+ (count-lines start (point))))))
1218 (defun what-cursor-position (&optional detail)
1219 "Print info on cursor position (on screen and within buffer).
1220 Also describe the character after point, and give its character code
1221 in octal, decimal and hex.
1223 For a non-ASCII multibyte character, also give its encoding in the
1224 buffer's selected coding system if the coding system encodes the
1225 character safely. If the character is encoded into one byte, that
1226 code is shown in hex. If the character is encoded into more than one
1227 byte, just \"...\" is shown.
1229 In addition, with prefix argument, show details about that character
1230 in *Help* buffer. See also the command `describe-char'."
1232 (let* ((char (following-char))
1234 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1235 ;; start a directional embedding, which could completely
1236 ;; disrupt the rest of the line (e.g., RLO will display the
1237 ;; rest of the line right-to-left). So we put an invisible
1238 ;; PDF character after these characters, to end the
1239 ;; embedding, which eliminates any effects on the rest of
1240 ;; the line. For RLE and RLO we also append an invisible
1241 ;; LRM, to avoid reordering the following numerical
1242 ;; characters. For LRI/RLI/FSI we append a PDI.
1243 (cond ((memq char '(?\x202a ?\x202d))
1244 (propertize (string ?\x202c) 'invisible t))
1245 ((memq char '(?\x202b ?\x202e))
1246 (propertize (string ?\x202c ?\x200e) 'invisible t))
1247 ((memq char '(?\x2066 ?\x2067 ?\x2068))
1248 (propertize (string ?\x2069) 'invisible t))
1249 ;; Strong right-to-left characters cause reordering of
1250 ;; the following numerical characters which show the
1251 ;; codepoint, so append LRM to countermand that.
1252 ((memq (get-char-code-property char 'bidi-class) '(R AL))
1253 (propertize (string ?\x200e) 'invisible t))
1259 (total (buffer-size))
1260 (percent (round (* 100.0 (1- pos)) (max 1 total)))
1261 (hscroll (if (= (window-hscroll) 0)
1263 (format " Hscroll=%d" (window-hscroll))))
1264 (col (current-column)))
1266 (if (or (/= beg 1) (/= end (1+ total)))
1267 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
1268 pos total percent beg end col hscroll)
1269 (message "point=%d of %d (EOB) column=%d%s"
1270 pos total col hscroll))
1271 (let ((coding buffer-file-coding-system)
1272 encoded encoding-msg display-prop under-display)
1273 (if (or (not coding)
1274 (eq (coding-system-type coding) t))
1275 (setq coding (default-value 'buffer-file-coding-system)))
1276 (if (eq (char-charset char) 'eight-bit)
1278 (format "(%d, #o%o, #x%x, raw-byte)" char char char))
1279 ;; Check if the character is displayed with some `display'
1280 ;; text property. In that case, set under-display to the
1281 ;; buffer substring covered by that property.
1282 (setq display-prop (get-char-property pos 'display))
1284 (let ((to (or (next-single-char-property-change pos 'display)
1286 (if (< to (+ pos 4))
1287 (setq under-display "")
1288 (setq under-display "..."
1291 (concat (buffer-substring-no-properties pos to)
1293 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
1296 (if (not (stringp display-prop))
1297 (format "(%d, #o%o, #x%x, part of display \"%s\")"
1298 char char char under-display)
1299 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
1300 char char char under-display display-prop))
1302 (format "(%d, #o%o, #x%x, file %s)"
1304 (if (> (length encoded) 1)
1306 (encoded-string-description encoded coding)))
1307 (format "(%d, #o%o, #x%x)" char char char)))))
1309 ;; We show the detailed information about CHAR.
1310 (describe-char (point)))
1311 (if (or (/= beg 1) (/= end (1+ total)))
1312 (message "Char: %s%s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
1314 (single-key-description char)
1315 (buffer-substring-no-properties (point) (1+ (point))))
1317 encoding-msg pos total percent beg end col hscroll)
1318 (message "Char: %s%s %s point=%d of %d (%d%%) column=%d%s"
1319 (if enable-multibyte-characters
1321 (single-key-description char)
1322 (buffer-substring-no-properties (point) (1+ (point))))
1323 (single-key-description char))
1324 bidi-fixer encoding-msg pos total percent col hscroll))))))
1326 ;; Initialize read-expression-map. It is defined at C level.
1327 (defvar read-expression-map
1328 (let ((m (make-sparse-keymap)))
1329 (define-key m "\M-\t" 'completion-at-point)
1330 ;; Might as well bind TAB to completion, since inserting a TAB char is
1331 ;; much too rarely useful.
1332 (define-key m "\t" 'completion-at-point)
1333 (set-keymap-parent m minibuffer-local-map)
1336 (defun read-minibuffer (prompt &optional initial-contents)
1337 "Return a Lisp object read using the minibuffer, unevaluated.
1338 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1339 is a string to insert in the minibuffer before reading.
1340 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1341 Such arguments are used as in `read-from-minibuffer'.)"
1342 ;; Used for interactive spec `x'.
1343 (read-from-minibuffer prompt initial-contents minibuffer-local-map
1344 t 'minibuffer-history))
1346 (defun eval-minibuffer (prompt &optional initial-contents)
1347 "Return value of Lisp expression read using the minibuffer.
1348 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1349 is a string to insert in the minibuffer before reading.
1350 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1351 Such arguments are used as in `read-from-minibuffer'.)"
1352 ;; Used for interactive spec `X'.
1353 (eval (read--expression prompt initial-contents)))
1355 (defvar minibuffer-completing-symbol nil
1356 "Non-nil means completing a Lisp symbol in the minibuffer.")
1357 (make-obsolete-variable 'minibuffer-completing-symbol nil "24.1" 'get)
1359 (defvar minibuffer-default nil
1360 "The current default value or list of default values in the minibuffer.
1361 The functions `read-from-minibuffer' and `completing-read' bind
1362 this variable locally.")
1364 (defcustom eval-expression-print-level 4
1365 "Value for `print-level' while printing value in `eval-expression'.
1366 A value of nil means no limit."
1368 :type '(choice (const :tag "No Limit" nil) integer)
1371 (defcustom eval-expression-print-length 12
1372 "Value for `print-length' while printing value in `eval-expression'.
1373 A value of nil means no limit."
1375 :type '(choice (const :tag "No Limit" nil) integer)
1378 (defcustom eval-expression-debug-on-error t
1379 "If non-nil set `debug-on-error' to t in `eval-expression'.
1380 If nil, don't change the value of `debug-on-error'."
1385 (defun eval-expression-print-format (value)
1386 "Format VALUE as a result of evaluated expression.
1387 Return a formatted string which is displayed in the echo area
1388 in addition to the value printed by prin1 in functions which
1389 display the result of expression evaluation."
1390 (if (and (integerp value)
1391 (or (eq standard-output t)
1392 (zerop (prefix-numeric-value current-prefix-arg))))
1394 (if (and (characterp value)
1395 (char-displayable-p value))
1396 (prin1-char value))))
1398 (format " (#o%o, #x%x, %s)" value value char-string)
1399 (format " (#o%o, #x%x)" value value)))))
1401 (defvar eval-expression-minibuffer-setup-hook nil
1402 "Hook run by `eval-expression' when entering the minibuffer.")
1404 (defun read--expression (prompt &optional initial-contents)
1405 (let ((minibuffer-completing-symbol t))
1406 (minibuffer-with-setup-hook
1408 ;; FIXME: call emacs-lisp-mode?
1409 (add-function :before-until (local 'eldoc-documentation-function)
1410 #'elisp-eldoc-documentation-function)
1411 (add-hook 'completion-at-point-functions
1412 #'elisp-completion-at-point nil t)
1413 (run-hooks 'eval-expression-minibuffer-setup-hook))
1414 (read-from-minibuffer prompt initial-contents
1415 read-expression-map t
1416 'read-expression-history))))
1418 ;; We define this, rather than making `eval' interactive,
1419 ;; for the sake of completion of names like eval-region, eval-buffer.
1420 (defun eval-expression (exp &optional insert-value)
1421 "Evaluate EXP and print value in the echo area.
1422 When called interactively, read an Emacs Lisp expression and evaluate it.
1423 Value is also consed on to front of the variable `values'.
1424 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1425 argument) means insert the result into the current buffer instead of
1426 printing it in the echo area.
1428 Normally, this function truncates long output according to the value
1429 of the variables `eval-expression-print-length' and
1430 `eval-expression-print-level'. With a prefix argument of zero,
1431 however, there is no such truncation. Such a prefix argument
1432 also causes integers to be printed in several additional formats
1433 \(octal, hexadecimal, and character).
1435 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1438 If `eval-expression-debug-on-error' is non-nil, which is the default,
1439 this command arranges for all errors to enter the debugger."
1441 (list (read--expression "Eval: ")
1442 current-prefix-arg))
1444 (if (null eval-expression-debug-on-error)
1445 (push (eval exp lexical-binding) values)
1446 (let ((old-value (make-symbol "t")) new-value)
1447 ;; Bind debug-on-error to something unique so that we can
1448 ;; detect when evalled code changes it.
1449 (let ((debug-on-error old-value))
1450 (push (eval (macroexpand-all exp) lexical-binding) values)
1451 (setq new-value debug-on-error))
1452 ;; If evalled code has changed the value of debug-on-error,
1453 ;; propagate that change to the global binding.
1454 (unless (eq old-value new-value)
1455 (setq debug-on-error new-value))))
1457 (let ((print-length (and (not (zerop (prefix-numeric-value insert-value)))
1458 eval-expression-print-length))
1459 (print-level (and (not (zerop (prefix-numeric-value insert-value)))
1460 eval-expression-print-level))
1464 (let ((standard-output (current-buffer)))
1466 (prin1 (car values))
1467 (when (zerop (prefix-numeric-value insert-value))
1468 (let ((str (eval-expression-print-format (car values))))
1469 (if str (princ str)))))))
1471 (prin1 (car values) t)
1472 (let ((str (eval-expression-print-format (car values))))
1473 (if str (princ str t)))))))
1475 (defun edit-and-eval-command (prompt command)
1476 "Prompting with PROMPT, let user edit COMMAND and eval result.
1477 COMMAND is a Lisp expression. Let user edit that expression in
1478 the minibuffer, then read and evaluate the result."
1480 (let ((print-level nil)
1481 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1483 (read-from-minibuffer prompt
1484 (prin1-to-string command)
1485 read-expression-map t
1487 ;; If command was added to command-history as a string,
1488 ;; get rid of that. We want only evaluable expressions there.
1489 (if (stringp (car command-history))
1490 (setq command-history (cdr command-history)))))))
1492 ;; If command to be redone does not match front of history,
1493 ;; add it to the history.
1494 (or (equal command (car command-history))
1495 (setq command-history (cons command command-history)))
1498 (defun repeat-complex-command (arg)
1499 "Edit and re-evaluate last complex command, or ARGth from last.
1500 A complex command is one which used the minibuffer.
1501 The command is placed in the minibuffer as a Lisp form for editing.
1502 The result is executed, repeating the command as changed.
1503 If the command has been changed or is not the most recent previous
1504 command it is added to the front of the command history.
1505 You can use the minibuffer history commands \
1506 \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1507 to get different commands to edit and resubmit."
1509 (let ((elt (nth (1- arg) command-history))
1514 (let ((print-level nil)
1515 (minibuffer-history-position arg)
1516 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1518 (read-from-minibuffer
1519 "Redo: " (prin1-to-string elt) read-expression-map t
1520 (cons 'command-history arg))
1522 ;; If command was added to command-history as a
1523 ;; string, get rid of that. We want only
1524 ;; evaluable expressions there.
1525 (if (stringp (car command-history))
1526 (setq command-history (cdr command-history))))))
1528 ;; If command to be redone does not match front of history,
1529 ;; add it to the history.
1530 (or (equal newcmd (car command-history))
1531 (setq command-history (cons newcmd command-history)))
1532 (apply #'funcall-interactively
1534 (mapcar (lambda (e) (eval e t)) (cdr newcmd))))
1536 (error "Argument %d is beyond length of command history" arg)
1537 (error "There are no previous complex commands to repeat")))))
1540 (defvar extended-command-history nil)
1541 (defvar execute-extended-command--last-typed nil)
1543 (defun read-extended-command ()
1544 "Read command name to invoke in `execute-extended-command'."
1545 (minibuffer-with-setup-hook
1547 (add-hook 'post-self-insert-hook
1549 (setq execute-extended-command--last-typed
1550 (minibuffer-contents)))
1552 (set (make-local-variable 'minibuffer-default-add-function)
1554 ;; Get a command name at point in the original buffer
1555 ;; to propose it after M-n.
1556 (with-current-buffer (window-buffer (minibuffer-selected-window))
1557 (and (commandp (function-called-at-point))
1558 (format "%S" (function-called-at-point)))))))
1559 ;; Read a string, completing from and restricting to the set of
1560 ;; all defined commands. Don't provide any initial input.
1561 ;; Save the command read on the extended-command history list.
1564 ((eq current-prefix-arg '-) "- ")
1565 ((and (consp current-prefix-arg)
1566 (eq (car current-prefix-arg) 4)) "C-u ")
1567 ((and (consp current-prefix-arg)
1568 (integerp (car current-prefix-arg)))
1569 (format "%d " (car current-prefix-arg)))
1570 ((integerp current-prefix-arg)
1571 (format "%d " current-prefix-arg)))
1572 ;; This isn't strictly correct if `execute-extended-command'
1573 ;; is bound to anything else (e.g. [menu]).
1574 ;; It could use (key-description (this-single-command-keys)),
1575 ;; but actually a prompt other than "M-x" would be confusing,
1576 ;; because "M-x" is a well-known prompt to read a command
1577 ;; and it serves as a shorthand for "Extended command: ".
1579 (lambda (string pred action)
1581 (if (memq action '(nil t))
1582 ;; Exclude obsolete commands from completions.
1584 (and (funcall pred sym)
1585 (or (equal string (symbol-name sym))
1586 (not (get sym 'byte-obsolete-info)))))
1588 (complete-with-action action obarray string pred)))
1589 #'commandp t nil 'extended-command-history)))
1591 (defcustom suggest-key-bindings t
1592 "Non-nil means show the equivalent key-binding when M-x command has one.
1593 The value can be a length of time to show the message for.
1594 If the value is non-nil and not a number, we wait 2 seconds."
1596 :type '(choice (const :tag "off" nil)
1597 (integer :tag "time" 2)
1600 (defun execute-extended-command--shorter-1 (name length)
1602 ((zerop length) (list ""))
1603 ((equal name "") nil)
1605 (nconc (mapcar (lambda (s) (concat (substring name 0 1) s))
1606 (execute-extended-command--shorter-1
1607 (substring name 1) (1- length)))
1608 (when (string-match "\\`\\(-\\)?[^-]*" name)
1609 (execute-extended-command--shorter-1
1610 (substring name (match-end 0)) length))))))
1612 (defun execute-extended-command--shorter (name typed)
1613 (let ((candidates '())
1614 (max (length typed))
1617 (while (and (not binding)
1621 (setq candidates (execute-extended-command--shorter-1
1623 ;; Don't show the help message if the binding isn't
1624 ;; significantly shorter than the M-x command the user typed.
1626 (let ((candidate (pop candidates)))
1628 (car-safe (completion-try-completion
1629 candidate obarray 'commandp len)))
1630 (setq binding candidate))))
1633 (defun execute-extended-command (prefixarg &optional command-name typed)
1634 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1635 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1636 "Read a command name, then read the arguments and call the command.
1637 To pass a prefix argument to the command you are
1638 invoking, give a prefix argument to `execute-extended-command'."
1639 (declare (interactive-only command-execute))
1640 ;; FIXME: Remember the actual text typed by the user before completion,
1641 ;; so that we don't later on suggest the same shortening.
1643 (let ((execute-extended-command--last-typed nil))
1644 (list current-prefix-arg
1645 (read-extended-command)
1646 execute-extended-command--last-typed)))
1647 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1648 (unless command-name
1649 (let ((current-prefix-arg prefixarg) ; for prompt
1650 (execute-extended-command--last-typed nil))
1651 (setq command-name (read-extended-command))
1652 (setq typed execute-extended-command--last-typed)))
1653 (let* ((function (and (stringp command-name) (intern-soft command-name)))
1654 (binding (and suggest-key-bindings
1655 (not executing-kbd-macro)
1656 (where-is-internal function overriding-local-map t))))
1657 (unless (commandp function)
1658 (error "`%s' is not a valid command name" command-name))
1659 (setq this-command function)
1660 ;; Normally `real-this-command' should never be changed, but here we really
1661 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1662 ;; binding" for <cmd>, so the command the user really wanted to run is
1663 ;; `function' and not `execute-extended-command'. The difference is
1664 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1665 (setq real-this-command function)
1666 (let ((prefix-arg prefixarg))
1667 (command-execute function 'record))
1668 ;; If enabled, show which key runs this command.
1669 ;; But first wait, and skip the message if there is input.
1671 ;; If this command displayed something in the echo area;
1672 ;; wait a few seconds, then display our suggestion message.
1673 ;; FIXME: Wait *after* running post-command-hook!
1674 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1675 ;; find a better answer anyway!
1676 (when suggest-key-bindings
1678 ((zerop (length (current-message))) 0)
1679 ((numberp suggest-key-bindings) suggest-key-bindings)
1681 (when (and waited (not (consp unread-command-events)))
1682 (unless (or binding executing-kbd-macro (not (symbolp function))
1683 (<= (length (symbol-name function)) 2))
1684 ;; There's no binding for CMD. Let's try and find the shortest
1685 ;; string to use in M-x.
1686 ;; FIXME: Can be slow. Cache it maybe?
1688 (setq binding (execute-extended-command--shorter
1689 (symbol-name function) typed))))
1692 (format "You can run the command `%s' with %s"
1694 (if (stringp binding)
1695 (concat "M-x " binding " RET")
1696 (key-description binding)))
1697 (sit-for (if (numberp suggest-key-bindings)
1698 suggest-key-bindings
1701 (defun command-execute (cmd &optional record-flag keys special)
1702 ;; BEWARE: Called directly from the C code.
1703 "Execute CMD as an editor command.
1704 CMD must be a symbol that satisfies the `commandp' predicate.
1705 Optional second arg RECORD-FLAG non-nil
1706 means unconditionally put this command in the variable `command-history'.
1707 Otherwise, that is done only if an arg is read using the minibuffer.
1708 The argument KEYS specifies the value to use instead of (this-command-keys)
1709 when reading the arguments; if it is nil, (this-command-keys) is used.
1710 The argument SPECIAL, if non-nil, means that this command is executing
1711 a special event, so ignore the prefix argument and don't clear it."
1712 (setq debug-on-next-call nil)
1713 (let ((prefixarg (unless special
1715 (setq current-prefix-arg prefix-arg)
1716 (setq prefix-arg nil)))))
1717 (if (and (symbolp cmd)
1719 disabled-command-function)
1720 ;; FIXME: Weird calling convention!
1721 (run-hooks 'disabled-command-function)
1725 (setq final (indirect-function final))
1726 (if (autoloadp final)
1727 (setq final (autoload-do-load final cmd)))))
1730 ;; If requested, place the macro in the command history. For
1731 ;; other sorts of commands, call-interactively takes care of this.
1733 (push `(execute-kbd-macro ,final ,prefixarg) command-history)
1734 ;; Don't keep command history around forever.
1735 (when (and (numberp history-length) (> history-length 0))
1736 (let ((cell (nthcdr history-length command-history)))
1737 (if (consp cell) (setcdr cell nil)))))
1738 (execute-kbd-macro final prefixarg))
1740 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1741 (prog1 (call-interactively cmd record-flag keys)
1742 (when (and (symbolp cmd)
1743 (get cmd 'byte-obsolete-info)
1744 (not (get cmd 'command-execute-obsolete-warned)))
1745 (put cmd 'command-execute-obsolete-warned t)
1746 (message "%s" (macroexp--obsolete-warning
1747 cmd (get cmd 'byte-obsolete-info) "command"))))))))))
1749 (defvar minibuffer-history nil
1750 "Default minibuffer history list.
1751 This is used for all minibuffer input
1752 except when an alternate history list is specified.
1754 Maximum length of the history list is determined by the value
1755 of `history-length', which see.")
1756 (defvar minibuffer-history-sexp-flag nil
1757 "Control whether history list elements are expressions or strings.
1758 If the value of this variable equals current minibuffer depth,
1759 they are expressions; otherwise they are strings.
1760 \(That convention is designed to do the right thing for
1761 recursive uses of the minibuffer.)")
1762 (setq minibuffer-history-variable 'minibuffer-history)
1763 (setq minibuffer-history-position nil) ;; Defvar is in C code.
1764 (defvar minibuffer-history-search-history nil)
1766 (defvar minibuffer-text-before-history nil
1767 "Text that was in this minibuffer before any history commands.
1768 This is nil if there have not yet been any history commands
1769 in this use of the minibuffer.")
1771 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1773 (defun minibuffer-history-initialize ()
1774 (setq minibuffer-text-before-history nil))
1776 (defun minibuffer-avoid-prompt (_new _old)
1777 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1778 (declare (obsolete cursor-intangible-mode "25.1"))
1779 (constrain-to-field nil (point-max)))
1781 (defcustom minibuffer-history-case-insensitive-variables nil
1782 "Minibuffer history variables for which matching should ignore case.
1783 If a history variable is a member of this list, then the
1784 \\[previous-matching-history-element] and \\[next-matching-history-element]\
1785 commands ignore case when searching it, regardless of `case-fold-search'."
1786 :type '(repeat variable)
1789 (defun previous-matching-history-element (regexp n)
1790 "Find the previous history element that matches REGEXP.
1791 \(Previous history elements refer to earlier actions.)
1792 With prefix argument N, search for Nth previous match.
1793 If N is negative, find the next or Nth next match.
1794 Normally, history elements are matched case-insensitively if
1795 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1796 makes the search case-sensitive.
1797 See also `minibuffer-history-case-insensitive-variables'."
1799 (let* ((enable-recursive-minibuffers t)
1800 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1802 minibuffer-local-map
1804 'minibuffer-history-search-history
1805 (car minibuffer-history-search-history))))
1806 ;; Use the last regexp specified, by default, if input is empty.
1807 (list (if (string= regexp "")
1808 (if minibuffer-history-search-history
1809 (car minibuffer-history-search-history)
1810 (user-error "No previous history search regexp"))
1812 (prefix-numeric-value current-prefix-arg))))
1814 (if (and (zerop minibuffer-history-position)
1815 (null minibuffer-text-before-history))
1816 (setq minibuffer-text-before-history
1817 (minibuffer-contents-no-properties)))
1818 (let ((history (symbol-value minibuffer-history-variable))
1820 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1821 ;; On some systems, ignore case for file names.
1822 (if (memq minibuffer-history-variable
1823 minibuffer-history-case-insensitive-variables)
1825 ;; Respect the user's setting for case-fold-search:
1831 (pos minibuffer-history-position))
1834 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1835 (when (= pos prevpos)
1836 (user-error (if (= pos 1)
1837 "No later matching history item"
1838 "No earlier matching history item")))
1840 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
1841 (let ((print-level nil))
1842 (prin1-to-string (nth (1- pos) history)))
1843 (nth (1- pos) history)))
1846 (and (string-match regexp match-string)
1848 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1849 (match-beginning 1))))
1851 (setq n (+ n (if (< n 0) 1 -1)))))
1852 (setq minibuffer-history-position pos)
1853 (goto-char (point-max))
1854 (delete-minibuffer-contents)
1855 (insert match-string)
1856 (goto-char (+ (minibuffer-prompt-end) match-offset))))
1857 (if (memq (car (car command-history)) '(previous-matching-history-element
1858 next-matching-history-element))
1859 (setq command-history (cdr command-history))))
1861 (defun next-matching-history-element (regexp n)
1862 "Find the next history element that matches REGEXP.
1863 \(The next history element refers to a more recent action.)
1864 With prefix argument N, search for Nth next match.
1865 If N is negative, find the previous or Nth previous match.
1866 Normally, history elements are matched case-insensitively if
1867 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1868 makes the search case-sensitive."
1870 (let* ((enable-recursive-minibuffers t)
1871 (regexp (read-from-minibuffer "Next element matching (regexp): "
1873 minibuffer-local-map
1875 'minibuffer-history-search-history
1876 (car minibuffer-history-search-history))))
1877 ;; Use the last regexp specified, by default, if input is empty.
1878 (list (if (string= regexp "")
1879 (if minibuffer-history-search-history
1880 (car minibuffer-history-search-history)
1881 (user-error "No previous history search regexp"))
1883 (prefix-numeric-value current-prefix-arg))))
1884 (previous-matching-history-element regexp (- n)))
1886 (defvar minibuffer-temporary-goal-position nil)
1888 (defvar minibuffer-default-add-function 'minibuffer-default-add-completions
1889 "Function run by `goto-history-element' before consuming default values.
1890 This is useful to dynamically add more elements to the list of default values
1891 when `goto-history-element' reaches the end of this list.
1892 Before calling this function `goto-history-element' sets the variable
1893 `minibuffer-default-add-done' to t, so it will call this function only
1894 once. In special cases, when this function needs to be called more
1895 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1896 overriding the setting of this variable to t in `goto-history-element'.")
1898 (defvar minibuffer-default-add-done nil
1899 "When nil, add more elements to the end of the list of default values.
1900 The value nil causes `goto-history-element' to add more elements to
1901 the list of defaults when it reaches the end of this list. It does
1902 this by calling a function defined by `minibuffer-default-add-function'.")
1904 (make-variable-buffer-local 'minibuffer-default-add-done)
1906 (defun minibuffer-default-add-completions ()
1907 "Return a list of all completions without the default value.
1908 This function is used to add all elements of the completion table to
1909 the end of the list of defaults just after the default value."
1910 (let ((def minibuffer-default)
1911 (all (all-completions ""
1912 minibuffer-completion-table
1913 minibuffer-completion-predicate)))
1916 (cons def (delete def all)))))
1918 (defun goto-history-element (nabs)
1919 "Puts element of the minibuffer history in the minibuffer.
1920 The argument NABS specifies the absolute history position."
1922 (when (and (not minibuffer-default-add-done)
1923 (functionp minibuffer-default-add-function)
1924 (< nabs (- (if (listp minibuffer-default)
1925 (length minibuffer-default)
1927 (setq minibuffer-default-add-done t
1928 minibuffer-default (funcall minibuffer-default-add-function)))
1929 (let ((minimum (if minibuffer-default
1930 (- (if (listp minibuffer-default)
1931 (length minibuffer-default)
1934 elt minibuffer-returned-to-present)
1935 (if (and (zerop minibuffer-history-position)
1936 (null minibuffer-text-before-history))
1937 (setq minibuffer-text-before-history
1938 (minibuffer-contents-no-properties)))
1939 (if (< nabs minimum)
1940 (user-error (if minibuffer-default
1941 "End of defaults; no next item"
1942 "End of history; no default available")))
1943 (if (> nabs (if (listp (symbol-value minibuffer-history-variable))
1944 (length (symbol-value minibuffer-history-variable))
1946 (user-error "Beginning of history; no preceding item"))
1947 (unless (memq last-command '(next-history-element
1948 previous-history-element))
1949 (let ((prompt-end (minibuffer-prompt-end)))
1950 (set (make-local-variable 'minibuffer-temporary-goal-position)
1951 (cond ((<= (point) prompt-end) prompt-end)
1954 (goto-char (point-max))
1955 (delete-minibuffer-contents)
1956 (setq minibuffer-history-position nabs)
1958 (setq elt (if (listp minibuffer-default)
1959 (nth (1- (abs nabs)) minibuffer-default)
1960 minibuffer-default)))
1962 (setq elt (or minibuffer-text-before-history ""))
1963 (setq minibuffer-returned-to-present t)
1964 (setq minibuffer-text-before-history nil))
1965 (t (setq elt (nth (1- minibuffer-history-position)
1966 (symbol-value minibuffer-history-variable)))))
1968 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1969 (not minibuffer-returned-to-present))
1970 (let ((print-level nil))
1971 (prin1-to-string elt))
1973 (goto-char (or minibuffer-temporary-goal-position (point-max)))))
1975 (defun next-history-element (n)
1976 "Puts next element of the minibuffer history in the minibuffer.
1977 With argument N, it uses the Nth following element."
1980 (goto-history-element (- minibuffer-history-position n))))
1982 (defun previous-history-element (n)
1983 "Puts previous element of the minibuffer history in the minibuffer.
1984 With argument N, it uses the Nth previous element."
1987 (goto-history-element (+ minibuffer-history-position n))))
1989 (defun next-line-or-history-element (&optional arg)
1990 "Move cursor vertically down ARG lines, or to the next history element.
1991 When point moves over the bottom line of multi-line minibuffer, puts ARGth
1992 next element of the minibuffer history in the minibuffer."
1994 (or arg (setq arg 1))
1995 (let* ((old-point (point))
1996 ;; Remember the original goal column of possibly multi-line input
1997 ;; excluding the length of the prompt on the first line.
1998 (prompt-end (minibuffer-prompt-end))
1999 (old-column (unless (and (eolp) (> (point) prompt-end))
2000 (if (= (line-number-at-pos) 1)
2001 (max (- (current-column) (1- prompt-end)) 0)
2002 (current-column)))))
2007 ;; Restore old position since `line-move-visual' moves point to
2008 ;; the end of the line when it fails to go to the next line.
2009 (goto-char old-point)
2010 (next-history-element arg)
2011 ;; Restore the original goal column on the last line
2012 ;; of possibly multi-line input.
2013 (goto-char (point-max))
2015 (if (= (line-number-at-pos) 1)
2016 (move-to-column (+ old-column (1- (minibuffer-prompt-end))))
2017 (move-to-column old-column)))))))
2019 (defun previous-line-or-history-element (&optional arg)
2020 "Move cursor vertically up ARG lines, or to the previous history element.
2021 When point moves over the top line of multi-line minibuffer, puts ARGth
2022 previous element of the minibuffer history in the minibuffer."
2024 (or arg (setq arg 1))
2025 (let* ((old-point (point))
2026 ;; Remember the original goal column of possibly multi-line input
2027 ;; excluding the length of the prompt on the first line.
2028 (prompt-end (minibuffer-prompt-end))
2029 (old-column (unless (and (eolp) (> (point) prompt-end))
2030 (if (= (line-number-at-pos) 1)
2031 (max (- (current-column) (1- prompt-end)) 0)
2032 (current-column)))))
2035 (previous-line arg))
2036 (beginning-of-buffer
2037 ;; Restore old position since `line-move-visual' moves point to
2038 ;; the beginning of the line when it fails to go to the previous line.
2039 (goto-char old-point)
2040 (previous-history-element arg)
2041 ;; Restore the original goal column on the first line
2042 ;; of possibly multi-line input.
2043 (goto-char (minibuffer-prompt-end))
2045 (if (= (line-number-at-pos) 1)
2046 (move-to-column (+ old-column (1- (minibuffer-prompt-end))))
2047 (move-to-column old-column))
2048 (goto-char (line-end-position)))))))
2050 (defun next-complete-history-element (n)
2051 "Get next history element which completes the minibuffer before the point.
2052 The contents of the minibuffer after the point are deleted, and replaced
2053 by the new completion."
2055 (let ((point-at-start (point)))
2056 (next-matching-history-element
2058 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
2060 ;; next-matching-history-element always puts us at (point-min).
2061 ;; Move to the position we were at before changing the buffer contents.
2062 ;; This is still sensible, because the text before point has not changed.
2063 (goto-char point-at-start)))
2065 (defun previous-complete-history-element (n)
2067 Get previous history element which completes the minibuffer before the point.
2068 The contents of the minibuffer after the point are deleted, and replaced
2069 by the new completion."
2071 (next-complete-history-element (- n)))
2073 ;; For compatibility with the old subr of the same name.
2074 (defun minibuffer-prompt-width ()
2075 "Return the display width of the minibuffer prompt.
2076 Return 0 if current buffer is not a minibuffer."
2077 ;; Return the width of everything before the field at the end of
2078 ;; the buffer; this should be 0 for normal buffers.
2079 (1- (minibuffer-prompt-end)))
2081 ;; isearch minibuffer history
2082 (add-hook 'minibuffer-setup-hook 'minibuffer-history-isearch-setup)
2084 (defvar minibuffer-history-isearch-message-overlay)
2085 (make-variable-buffer-local 'minibuffer-history-isearch-message-overlay)
2087 (defun minibuffer-history-isearch-setup ()
2088 "Set up a minibuffer for using isearch to search the minibuffer history.
2089 Intended to be added to `minibuffer-setup-hook'."
2090 (set (make-local-variable 'isearch-search-fun-function)
2091 'minibuffer-history-isearch-search)
2092 (set (make-local-variable 'isearch-message-function)
2093 'minibuffer-history-isearch-message)
2094 (set (make-local-variable 'isearch-wrap-function)
2095 'minibuffer-history-isearch-wrap)
2096 (set (make-local-variable 'isearch-push-state-function)
2097 'minibuffer-history-isearch-push-state)
2098 (add-hook 'isearch-mode-end-hook 'minibuffer-history-isearch-end nil t))
2100 (defun minibuffer-history-isearch-end ()
2101 "Clean up the minibuffer after terminating isearch in the minibuffer."
2102 (if minibuffer-history-isearch-message-overlay
2103 (delete-overlay minibuffer-history-isearch-message-overlay)))
2105 (defun minibuffer-history-isearch-search ()
2106 "Return the proper search function, for isearch in minibuffer history."
2107 (lambda (string bound noerror)
2109 ;; Use standard functions to search within minibuffer text
2110 (isearch-search-fun-default))
2112 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2113 ;; searching forward. Lazy-highlight calls this lambda with the
2114 ;; bound arg, so skip the minibuffer prompt.
2115 (if (and bound isearch-forward (< (point) (minibuffer-prompt-end)))
2116 (goto-char (minibuffer-prompt-end)))
2118 ;; 1. First try searching in the initial minibuffer text
2119 (funcall search-fun string
2120 (if isearch-forward bound (minibuffer-prompt-end))
2122 ;; 2. If the above search fails, start putting next/prev history
2123 ;; elements in the minibuffer successively, and search the string
2124 ;; in them. Do this only when bound is nil (i.e. not while
2125 ;; lazy-highlighting search strings in the current minibuffer text).
2130 (cond (isearch-forward
2131 (next-history-element 1)
2132 (goto-char (minibuffer-prompt-end)))
2134 (previous-history-element 1)
2135 (goto-char (point-max))))
2136 (setq isearch-barrier (point) isearch-opoint (point))
2137 ;; After putting the next/prev history element, search
2138 ;; the string in them again, until next-history-element
2139 ;; or previous-history-element raises an error at the
2140 ;; beginning/end of history.
2141 (setq found (funcall search-fun string
2142 (unless isearch-forward
2143 ;; For backward search, don't search
2144 ;; in the minibuffer prompt
2145 (minibuffer-prompt-end))
2147 ;; Return point of the new search result
2149 ;; Return nil when next(prev)-history-element fails
2152 (defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis)
2153 "Display the minibuffer history search prompt.
2154 If there are no search errors, this function displays an overlay with
2155 the isearch prompt which replaces the original minibuffer prompt.
2156 Otherwise, it displays the standard isearch message returned from
2157 the function `isearch-message'."
2158 (if (not (and (minibufferp) isearch-success (not isearch-error)))
2159 ;; Use standard function `isearch-message' when not in the minibuffer,
2160 ;; or search fails, or has an error (like incomplete regexp).
2161 ;; This function overwrites minibuffer text with isearch message,
2162 ;; so it's possible to see what is wrong in the search string.
2163 (isearch-message c-q-hack ellipsis)
2164 ;; Otherwise, put the overlay with the standard isearch prompt over
2165 ;; the initial minibuffer prompt.
2166 (if (overlayp minibuffer-history-isearch-message-overlay)
2167 (move-overlay minibuffer-history-isearch-message-overlay
2168 (point-min) (minibuffer-prompt-end))
2169 (setq minibuffer-history-isearch-message-overlay
2170 (make-overlay (point-min) (minibuffer-prompt-end)))
2171 (overlay-put minibuffer-history-isearch-message-overlay 'evaporate t))
2172 (overlay-put minibuffer-history-isearch-message-overlay
2173 'display (isearch-message-prefix c-q-hack ellipsis))
2174 ;; And clear any previous isearch message.
2177 (defun minibuffer-history-isearch-wrap ()
2178 "Wrap the minibuffer history search when search fails.
2179 Move point to the first history element for a forward search,
2180 or to the last history element for a backward search."
2181 ;; When `minibuffer-history-isearch-search' fails on reaching the
2182 ;; beginning/end of the history, wrap the search to the first/last
2183 ;; minibuffer history element.
2185 (goto-history-element (length (symbol-value minibuffer-history-variable)))
2186 (goto-history-element 0))
2187 (setq isearch-success t)
2188 (goto-char (if isearch-forward (minibuffer-prompt-end) (point-max))))
2190 (defun minibuffer-history-isearch-push-state ()
2191 "Save a function restoring the state of minibuffer history search.
2192 Save `minibuffer-history-position' to the additional state parameter
2193 in the search status stack."
2194 (let ((pos minibuffer-history-position))
2196 (minibuffer-history-isearch-pop-state cmd pos))))
2198 (defun minibuffer-history-isearch-pop-state (_cmd hist-pos)
2199 "Restore the minibuffer history search state.
2200 Go to the history element by the absolute history position HIST-POS."
2201 (goto-history-element hist-pos))
2204 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2205 (define-obsolete-function-alias 'advertised-undo 'undo "23.2")
2207 (defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
2208 "Table mapping redo records to the corresponding undo one.
2209 A redo record for undo-in-region maps to t.
2210 A redo record for ordinary undo maps to the following (earlier) undo.")
2212 (defvar undo-in-region nil
2213 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
2215 (defvar undo-no-redo nil
2216 "If t, `undo' doesn't go through redo entries.")
2218 (defvar pending-undo-list nil
2219 "Within a run of consecutive undo commands, list remaining to be undone.
2220 If t, we undid all the way to the end of it.")
2222 (defun undo (&optional arg)
2223 "Undo some previous changes.
2224 Repeat this command to undo more changes.
2225 A numeric ARG serves as a repeat count.
2227 In Transient Mark mode when the mark is active, only undo changes within
2228 the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
2229 as an argument limits undo to changes within the current region."
2231 ;; Make last-command indicate for the next command that this was an undo.
2232 ;; That way, another undo will undo more.
2233 ;; If we get to the end of the undo history and get an error,
2234 ;; another undo command will find the undo history empty
2235 ;; and will get another error. To begin undoing the undos,
2236 ;; you must type some other command.
2237 (let* ((modified (buffer-modified-p))
2238 ;; For an indirect buffer, look in the base buffer for the
2240 (base-buffer (or (buffer-base-buffer) (current-buffer)))
2241 (recent-save (with-current-buffer base-buffer
2242 (recent-auto-save-p)))
2244 ;; If we get an error in undo-start,
2245 ;; the next command should not be a "consecutive undo".
2246 ;; So set `this-command' to something other than `undo'.
2247 (setq this-command 'undo-start)
2249 (unless (and (eq last-command 'undo)
2250 (or (eq pending-undo-list t)
2251 ;; If something (a timer or filter?) changed the buffer
2252 ;; since the previous command, don't continue the undo seq.
2253 (let ((list buffer-undo-list))
2254 (while (eq (car list) nil)
2255 (setq list (cdr list)))
2256 ;; If the last undo record made was made by undo
2257 ;; it shows nothing else happened in between.
2258 (gethash list undo-equiv-table))))
2259 (setq undo-in-region
2260 (or (region-active-p) (and arg (not (numberp arg)))))
2262 (undo-start (region-beginning) (region-end))
2264 ;; get rid of initial undo boundary
2266 ;; If we got this far, the next command should be a consecutive undo.
2267 (setq this-command 'undo)
2268 ;; Check to see whether we're hitting a redo record, and if
2269 ;; so, ask the user whether she wants to skip the redo/undo pair.
2270 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
2271 (or (eq (selected-window) (minibuffer-window))
2272 (setq message (format "%s%s!"
2273 (if (or undo-no-redo (not equiv))
2275 (if undo-in-region " in region" ""))))
2276 (when (and (consp equiv) undo-no-redo)
2277 ;; The equiv entry might point to another redo record if we have done
2278 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2279 (while (let ((next (gethash equiv undo-equiv-table)))
2280 (if next (setq equiv next))))
2281 (setq pending-undo-list equiv)))
2284 (prefix-numeric-value arg)
2286 ;; Record the fact that the just-generated undo records come from an
2287 ;; undo operation--that is, they are redo records.
2288 ;; In the ordinary case (not within a region), map the redo
2289 ;; record to the following undos.
2290 ;; I don't know how to do that in the undo-in-region case.
2291 (let ((list buffer-undo-list))
2292 ;; Strip any leading undo boundaries there might be, like we do
2293 ;; above when checking.
2294 (while (eq (car list) nil)
2295 (setq list (cdr list)))
2297 ;; Prevent identity mapping. This can happen if
2298 ;; consecutive nils are erroneously in undo list.
2299 (if (or undo-in-region (eq list pending-undo-list))
2303 ;; Don't specify a position in the undo record for the undo command.
2304 ;; Instead, undoing this should move point to where the change is.
2305 (let ((tail buffer-undo-list)
2308 (when (integerp (car tail))
2309 (let ((pos (car tail)))
2311 (setcdr prev (cdr tail))
2312 (setq buffer-undo-list (cdr tail)))
2313 (setq tail (cdr tail))
2315 (if (eq pos (car tail))
2317 (setcdr prev (cdr tail))
2318 (setq buffer-undo-list (cdr tail)))
2320 (setq tail (cdr tail)))
2322 (setq prev tail tail (cdr tail))))
2323 ;; Record what the current undo list says,
2324 ;; so the next command can tell if the buffer was modified in between.
2325 (and modified (not (buffer-modified-p))
2326 (with-current-buffer base-buffer
2327 (delete-auto-save-file-if-necessary recent-save)))
2328 ;; Display a message announcing success.
2330 (message "%s" message))))
2332 (defun buffer-disable-undo (&optional buffer)
2333 "Make BUFFER stop keeping undo information.
2334 No argument or nil as argument means do this for the current buffer."
2336 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
2337 (setq buffer-undo-list t)))
2339 (defun undo-only (&optional arg)
2340 "Undo some previous changes.
2341 Repeat this command to undo more changes.
2342 A numeric ARG serves as a repeat count.
2343 Contrary to `undo', this will not redo a previous undo."
2345 (let ((undo-no-redo t)) (undo arg)))
2347 (defvar undo-in-progress nil
2348 "Non-nil while performing an undo.
2349 Some change-hooks test this variable to do something different.")
2351 (defun undo-more (n)
2352 "Undo back N undo-boundaries beyond what was already undone recently.
2353 Call `undo-start' to get ready to undo recent changes,
2354 then call `undo-more' one or more times to undo them."
2355 (or (listp pending-undo-list)
2356 (user-error (concat "No further undo information"
2357 (and undo-in-region " for region"))))
2358 (let ((undo-in-progress t))
2359 ;; Note: The following, while pulling elements off
2360 ;; `pending-undo-list' will call primitive change functions which
2361 ;; will push more elements onto `buffer-undo-list'.
2362 (setq pending-undo-list (primitive-undo n pending-undo-list))
2363 (if (null pending-undo-list)
2364 (setq pending-undo-list t))))
2366 (defun primitive-undo (n list)
2367 "Undo N records from the front of the list LIST.
2368 Return what remains of the list."
2370 ;; This is a good feature, but would make undo-start
2371 ;; unable to do what is expected.
2372 ;;(when (null (car (list)))
2373 ;; ;; If the head of the list is a boundary, it is the boundary
2374 ;; ;; preceding this command. Get rid of it and don't count it.
2375 ;; (setq list (cdr list))))
2378 ;; In a writable buffer, enable undoing read-only text that is
2379 ;; so because of text properties.
2380 (inhibit-read-only t)
2381 ;; Don't let `intangible' properties interfere with undo.
2382 (inhibit-point-motion-hooks t)
2383 ;; We use oldlist only to check for EQ. ++kfs
2384 (oldlist buffer-undo-list)
2388 (while (setq next (pop list)) ;Exit inner loop at undo boundary.
2389 ;; Handle an integer by setting point to that value.
2391 ((pred integerp) (goto-char next))
2392 ;; Element (t . TIME) records previous modtime.
2393 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2394 ;; UNKNOWN_MODTIME_NSECS.
2396 ;; If this records an obsolete save
2397 ;; (not matching the actual disk file)
2398 ;; then don't mark unmodified.
2399 (when (or (equal time (visited-file-modtime))
2401 (equal (list (car time) (cdr time))
2402 (visited-file-modtime))))
2403 (when (fboundp 'unlock-buffer)
2405 (set-buffer-modified-p nil)))
2406 ;; Element (nil PROP VAL BEG . END) is property change.
2407 (`(nil . ,(or `(,prop ,val ,beg . ,end) pcase--dontcare))
2408 (when (or (> (point-min) beg) (< (point-max) end))
2409 (error "Changes to be undone are outside visible portion of buffer"))
2410 (put-text-property beg end prop val))
2411 ;; Element (BEG . END) means range was inserted.
2412 (`(,(and beg (pred integerp)) . ,(and end (pred integerp)))
2413 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2414 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2415 (when (or (> (point-min) beg) (< (point-max) end))
2416 (error "Changes to be undone are outside visible portion of buffer"))
2417 ;; Set point first thing, so that undoing this undo
2418 ;; does not send point back to where it is now.
2420 (delete-region beg end))
2421 ;; Element (apply FUN . ARGS) means call FUN to undo.
2422 (`(apply . ,fun-args)
2423 (let ((currbuff (current-buffer)))
2424 (if (integerp (car fun-args))
2425 ;; Long format: (apply DELTA START END FUN . ARGS).
2426 (pcase-let* ((`(,delta ,start ,end ,fun . ,args) fun-args)
2427 (start-mark (copy-marker start nil))
2428 (end-mark (copy-marker end t)))
2429 (when (or (> (point-min) start) (< (point-max) end))
2430 (error "Changes to be undone are outside visible portion of buffer"))
2431 (apply fun args) ;; Use `save-current-buffer'?
2432 ;; Check that the function did what the entry
2433 ;; said it would do.
2434 (unless (and (= start start-mark)
2435 (= (+ delta end) end-mark))
2436 (error "Changes to be undone by function different than announced"))
2437 (set-marker start-mark nil)
2438 (set-marker end-mark nil))
2440 (unless (eq currbuff (current-buffer))
2441 (error "Undo function switched buffer"))
2442 (setq did-apply t)))
2443 ;; Element (STRING . POS) means STRING was deleted.
2444 (`(,(and string (pred stringp)) . ,(and pos (pred integerp)))
2445 (when (let ((apos (abs pos)))
2446 (or (< apos (point-min)) (> apos (point-max))))
2447 (error "Changes to be undone are outside visible portion of buffer"))
2448 (let (valid-marker-adjustments)
2449 ;; Check that marker adjustments which were recorded
2450 ;; with the (STRING . POS) record are still valid, ie
2451 ;; the markers haven't moved. We check their validity
2452 ;; before reinserting the string so as we don't need to
2453 ;; mind marker insertion-type.
2454 (while (and (markerp (car-safe (car list)))
2455 (integerp (cdr-safe (car list))))
2456 (let* ((marker-adj (pop list))
2457 (m (car marker-adj)))
2458 (and (eq (marker-buffer m) (current-buffer))
2460 (push marker-adj valid-marker-adjustments))))
2461 ;; Insert string and adjust point
2469 ;; Adjust the valid marker adjustments
2470 (dolist (adj valid-marker-adjustments)
2471 (set-marker (car adj)
2472 (- (car adj) (cdr adj))))))
2473 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2474 (`(,(and marker (pred markerp)) . ,(and offset (pred integerp)))
2475 (warn "Encountered %S entry in undo list with no matching (TEXT . POS) entry"
2477 ;; Even though these elements are not expected in the undo
2478 ;; list, adjust them to be conservative for the 24.4
2479 ;; release. (Bug#16818)
2480 (when (marker-buffer marker)
2483 (marker-buffer marker))))
2484 (_ (error "Unrecognized entry in undo list %S" next))))
2485 (setq arg (1- arg)))
2486 ;; Make sure an apply entry produces at least one undo entry,
2487 ;; so the test in `undo' for continuing an undo series
2490 (eq oldlist buffer-undo-list))
2491 (setq buffer-undo-list
2492 (cons (list 'apply 'cdr nil) buffer-undo-list))))
2495 ;; Deep copy of a list
2496 (defun undo-copy-list (list)
2497 "Make a copy of undo list LIST."
2498 (mapcar 'undo-copy-list-1 list))
2500 (defun undo-copy-list-1 (elt)
2502 (cons (car elt) (undo-copy-list-1 (cdr elt)))
2505 (defun undo-start (&optional beg end)
2506 "Set `pending-undo-list' to the front of the undo list.
2507 The next call to `undo-more' will undo the most recently made change.
2508 If BEG and END are specified, then only undo elements
2509 that apply to text between BEG and END are used; other undo elements
2510 are ignored. If BEG and END are nil, all undo elements are used."
2511 (if (eq buffer-undo-list t)
2512 (user-error "No undo information in this buffer"))
2513 (setq pending-undo-list
2514 (if (and beg end (not (= beg end)))
2515 (undo-make-selective-list (min beg end) (max beg end))
2518 ;; The positions given in elements of the undo list are the positions
2519 ;; as of the time that element was recorded to undo history. In
2520 ;; general, subsequent buffer edits render those positions invalid in
2521 ;; the current buffer, unless adjusted according to the intervening
2524 ;; Undo in region is a use case that requires adjustments to undo
2525 ;; elements. It must adjust positions of elements in the region based
2526 ;; on newer elements not in the region so as they may be correctly
2527 ;; applied in the current buffer. undo-make-selective-list
2528 ;; accomplishes this with its undo-deltas list of adjustments. An
2529 ;; example undo history from oldest to newest:
2532 ;; 123456789 buffer-undo-list undo-deltas
2533 ;; --------- ---------------- -----------
2534 ;; aaa (1 . 4) (1 . -3)
2535 ;; aaba (3 . 4) N/A (in region)
2536 ;; ccaaba (1 . 3) (1 . -2)
2537 ;; ccaabaddd (7 . 10) (7 . -3)
2538 ;; ccaabdd ("ad" . 6) (6 . 2)
2539 ;; ccaabaddd (6 . 8) (6 . -2)
2540 ;; | |<-- region: "caab", from 2 to 6
2542 ;; When the user starts a run of undos in region,
2543 ;; undo-make-selective-list is called to create the full list of in
2544 ;; region elements. Each element is adjusted forward chronologically
2545 ;; through undo-deltas to determine if it is in the region.
2547 ;; In the above example, the insertion of "b" is (3 . 4) in the
2548 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2549 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2550 ;; . 6) is assessed as in the region and placed in the selective list.
2551 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2552 ;; due to the selected element. The "b" insertion is the only element
2553 ;; fully in the region, so in this example undo-make-selective-list
2554 ;; returns (nil (5 . 6)).
2556 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2557 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2558 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2559 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2560 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2562 ;; More interesting is how to adjust the "ddd" insertion due to the
2563 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2564 ;; If the reinsertion was a manual retyping of "ad", then the total
2565 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2566 ;; the reinsertion was due to undo, one might expect the first "d"
2567 ;; character would again be a part of the "ddd" text, meaning its
2568 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2570 ;; undo-make-selective-list assumes in this situation that "ad" was a
2571 ;; new edit, even if it was inserted because of an undo.
2572 ;; Consequently, if the user undos in region "8 to 10" of the
2573 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2574 ;; "ccaabad", as though the first "d" became detached from the
2575 ;; original "ddd" insertion. This quirk is a FIXME.
2577 (defun undo-make-selective-list (start end)
2578 "Return a list of undo elements for the region START to END.
2579 The elements come from `buffer-undo-list', but we keep only the
2580 elements inside this region, and discard those outside this
2581 region. The elements' positions are adjusted so as the returned
2582 list can be applied to the current buffer."
2583 (let ((ulist buffer-undo-list)
2584 ;; A list of position adjusted undo elements in the region.
2585 (selective-list (list nil))
2586 ;; A list of undo-deltas for out of region undo elements.
2591 (while (gethash ulist undo-equiv-table)
2592 (setq ulist (gethash ulist undo-equiv-table))))
2593 (setq undo-elt (car ulist))
2596 ;; Don't put two nils together in the list
2597 (when (car selective-list)
2598 (push nil selective-list)))
2599 ((and (consp undo-elt) (eq (car undo-elt) t))
2600 ;; This is a "was unmodified" element. Keep it
2601 ;; if we have kept everything thus far.
2602 (when (not undo-deltas)
2603 (push undo-elt selective-list)))
2604 ;; Skip over marker adjustments, instead relying
2605 ;; on finding them after (TEXT . POS) elements
2606 ((markerp (car-safe undo-elt))
2609 (let ((adjusted-undo-elt (undo-adjust-elt undo-elt
2611 (if (undo-elt-in-region adjusted-undo-elt start end)
2613 (setq end (+ end (cdr (undo-delta adjusted-undo-elt))))
2614 (push adjusted-undo-elt selective-list)
2615 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2616 ;; kept. primitive-undo may discard them later.
2617 (when (and (stringp (car-safe adjusted-undo-elt))
2618 (integerp (cdr-safe adjusted-undo-elt)))
2619 (let ((list-i (cdr ulist)))
2620 (while (markerp (car-safe (car list-i)))
2621 (push (pop list-i) selective-list)))))
2622 (let ((delta (undo-delta undo-elt)))
2623 (when (/= 0 (cdr delta))
2624 (push delta undo-deltas)))))))
2626 (nreverse selective-list)))
2628 (defun undo-elt-in-region (undo-elt start end)
2629 "Determine whether UNDO-ELT falls inside the region START ... END.
2630 If it crosses the edge, we return nil.
2632 Generally this function is not useful for determining
2633 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2634 because markers can be arbitrarily relocated. Instead, pass the
2635 marker adjustment's corresponding (TEXT . POS) element."
2636 (cond ((integerp undo-elt)
2637 (and (>= undo-elt start)
2643 ((stringp (car undo-elt))
2644 ;; (TEXT . POSITION)
2645 (and (>= (abs (cdr undo-elt)) start)
2646 (<= (abs (cdr undo-elt)) end)))
2647 ((and (consp undo-elt) (markerp (car undo-elt)))
2648 ;; (MARKER . ADJUSTMENT)
2649 (<= start (car undo-elt) end))
2650 ((null (car undo-elt))
2651 ;; (nil PROPERTY VALUE BEG . END)
2652 (let ((tail (nthcdr 3 undo-elt)))
2653 (and (>= (car tail) start)
2654 (<= (cdr tail) end))))
2655 ((integerp (car undo-elt))
2657 (and (>= (car undo-elt) start)
2658 (<= (cdr undo-elt) end)))))
2660 (defun undo-elt-crosses-region (undo-elt start end)
2661 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2662 This assumes we have already decided that UNDO-ELT
2663 is not *inside* the region START...END."
2664 (declare (obsolete nil "25.1"))
2665 (cond ((atom undo-elt) nil)
2666 ((null (car undo-elt))
2667 ;; (nil PROPERTY VALUE BEG . END)
2668 (let ((tail (nthcdr 3 undo-elt)))
2669 (and (< (car tail) end)
2670 (> (cdr tail) start))))
2671 ((integerp (car undo-elt))
2673 (and (< (car undo-elt) end)
2674 (> (cdr undo-elt) start)))))
2676 (defun undo-adjust-elt (elt deltas)
2677 "Return adjustment of undo element ELT by the undo DELTAS
2682 (undo-adjust-pos elt deltas))
2684 (`(,(and beg (pred integerp)) . ,(and end (pred integerp)))
2685 (undo-adjust-beg-end beg end deltas))
2686 ;; (TEXT . POSITION)
2687 (`(,(and text (pred stringp)) . ,(and pos (pred integerp)))
2688 (cons text (* (if (< pos 0) -1 1)
2689 (undo-adjust-pos (abs pos) deltas))))
2690 ;; (nil PROPERTY VALUE BEG . END)
2691 (`(nil . ,(or `(,prop ,val ,beg . ,end) pcase--dontcare))
2692 `(nil ,prop ,val . ,(undo-adjust-beg-end beg end deltas)))
2693 ;; (apply DELTA START END FUN . ARGS)
2695 ;; All others return same elt
2698 ;; (BEG . END) can adjust to the same positions, commonly when an
2699 ;; insertion was undone and they are out of region, for example:
2702 ;; 123456789 buffer-undo-list undo-deltas
2703 ;; --------- ---------------- -----------
2705 ;; abbaa (2 . 4) (2 . -2)
2706 ;; aaa ("bb" . 2) (2 . 2)
2709 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2710 ;; undo. Further adjustments to such an element should be the same as
2711 ;; for (TEXT . POSITION) elements. The options are:
2713 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2714 ;; analogous to marker insertion-type t.
2716 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2717 ;; marker insertion-type nil.
2719 ;; There was no strong reason to prefer one or the other, except that
2720 ;; the first is more consistent with prior undo in region behavior.
2721 (defun undo-adjust-beg-end (beg end deltas)
2722 "Return cons of adjustments to BEG and END by the undo DELTAS
2724 (let ((adj-beg (undo-adjust-pos beg deltas)))
2725 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2727 (max adj-beg (undo-adjust-pos end deltas t)))))
2729 (defun undo-adjust-pos (pos deltas &optional use-<)
2730 "Return adjustment of POS by the undo DELTAS list, comparing
2731 with < or <= based on USE-<."
2732 (dolist (d deltas pos)
2737 ;; Don't allow pos to become less than the undo-delta
2738 ;; position. This edge case is described in the overview
2740 (max (car d) (- pos (cdr d)))))))
2742 ;; Return the first affected buffer position and the delta for an undo element
2743 ;; delta is defined as the change in subsequent buffer positions if we *did*
2745 (defun undo-delta (undo-elt)
2746 (if (consp undo-elt)
2747 (cond ((stringp (car undo-elt))
2748 ;; (TEXT . POSITION)
2749 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
2750 ((integerp (car undo-elt))
2752 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
2757 ;;; Default undo-boundary addition
2759 ;; This section adds a new undo-boundary at either after a command is
2760 ;; called or in some cases on a timer called after a change is made in
2762 (defvar-local undo-auto--last-boundary-cause nil
2763 "Describe the cause of the last undo-boundary.
2765 If `explicit', the last boundary was caused by an explicit call to
2766 `undo-boundary', that is one not called by the code in this
2769 If it is equal to `timer', then the last boundary was inserted
2770 by `undo-auto--boundary-timer'.
2772 If it is equal to `command', then the last boundary was inserted
2773 automatically after a command, that is by the code defined in
2776 If it is equal to a list, then the last boundary was inserted by
2777 an amalgamating command. The car of the list is the number of
2778 times an amalgamating command has been called, and the cdr are the
2779 buffers that were changed during the last command.")
2781 (defvar undo-auto--current-boundary-timer nil
2782 "Current timer which will run `undo-auto--boundary-timer' or nil.
2784 If set to non-nil, this will effectively disable the timer.")
2786 (defvar undo-auto--this-command-amalgamating nil
2787 "Non-nil if `this-command' should be amalgamated.
2788 This variable is set to nil by `undo-auto--boundaries' and is set
2789 by `undo-auto--amalgamate'." )
2791 (defun undo-auto--needs-boundary-p ()
2792 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2793 (car-safe buffer-undo-list))
2795 (defun undo-auto--last-boundary-amalgamating-number ()
2796 "Return the number of amalgamating last commands or nil.
2797 Amalgamating commands are, by default, either
2798 `self-insert-command' and `delete-char', but can be any command
2799 that calls `undo-auto--amalgamate'."
2800 (car-safe undo-auto--last-boundary-cause))
2802 (defun undo-auto--ensure-boundary (cause)
2803 "Add an `undo-boundary' to the current buffer if needed.
2804 REASON describes the reason that the boundary is being added; see
2805 `undo-auto--last-boundary' for more information."
2807 (undo-auto--needs-boundary-p))
2808 (let ((last-amalgamating
2809 (undo-auto--last-boundary-amalgamating-number)))
2811 (setq undo-auto--last-boundary-cause
2812 (if (eq 'amalgamate cause)
2814 (if last-amalgamating (1+ last-amalgamating) 0)
2815 undo-auto--undoably-changed-buffers)
2818 (defun undo-auto--boundaries (cause)
2819 "Check recently changed buffers and add a boundary if necessary.
2820 REASON describes the reason that the boundary is being added; see
2821 `undo-last-boundary' for more information."
2822 (dolist (b undo-auto--undoably-changed-buffers)
2823 (when (buffer-live-p b)
2824 (with-current-buffer b
2825 (undo-auto--ensure-boundary cause))))
2826 (setq undo-auto--undoably-changed-buffers nil))
2828 (defun undo-auto--boundary-timer ()
2829 "Timer which will run `undo--auto-boundary-timer'."
2830 (setq undo-auto--current-boundary-timer nil)
2831 (undo-auto--boundaries 'timer))
2833 (defun undo-auto--boundary-ensure-timer ()
2834 "Ensure that the `undo-auto-boundary-timer' is set."
2835 (unless undo-auto--current-boundary-timer
2836 (setq undo-auto--current-boundary-timer
2837 (run-at-time 10 nil #'undo-auto--boundary-timer))))
2839 (defvar undo-auto--undoably-changed-buffers nil
2840 "List of buffers that have changed recently.
2842 This list is maintained by `undo-auto--undoable-change' and
2843 `undo-auto--boundaries' and can be affected by changes to their
2846 See also `undo-auto--buffer-undoably-changed'.")
2848 (defun undo-auto--add-boundary ()
2849 "Add an `undo-boundary' in appropriate buffers."
2850 (undo-auto--boundaries
2851 (if undo-auto--this-command-amalgamating
2854 (setq undo-auto--this-command-amalgamating nil))
2856 (defun undo-auto--amalgamate ()
2857 "Amalgamate undo if necessary.
2858 This function can be called after an amalgamating command. It
2859 removes the previous `undo-boundary' if a series of such calls
2860 have been made. By default `self-insert-command' and
2861 `delete-char' are the only amalgamating commands, although this
2862 function could be called by any command wishing to have this
2864 (let ((last-amalgamating-count
2865 (undo-auto--last-boundary-amalgamating-number)))
2866 (setq undo-auto--this-command-amalgamating t)
2868 last-amalgamating-count
2871 (< last-amalgamating-count 20)
2872 (eq this-command last-command))
2873 ;; Amalgamate all buffers that have changed.
2874 (dolist (b (cdr undo-auto--last-boundary-cause))
2875 (when (buffer-live-p b)
2876 (with-current-buffer
2879 ;; The head of `buffer-undo-list' is nil.
2880 ;; `car-safe' doesn't work because
2881 ;; `buffer-undo-list' need not be a list!
2882 (and (listp buffer-undo-list)
2883 (not (car buffer-undo-list)))
2884 (setq buffer-undo-list
2885 (cdr buffer-undo-list))))))
2886 (setq undo-auto--last-boundary-cause 0)))))
2888 (defun undo-auto--undoable-change ()
2889 "Called after every undoable buffer change."
2890 (add-to-list 'undo-auto--undoably-changed-buffers (current-buffer))
2891 (undo-auto--boundary-ensure-timer))
2892 ;; End auto-boundary section
2894 (defcustom undo-ask-before-discard nil
2895 "If non-nil ask about discarding undo info for the current command.
2896 Normally, Emacs discards the undo info for the current command if
2897 it exceeds `undo-outer-limit'. But if you set this option
2898 non-nil, it asks in the echo area whether to discard the info.
2899 If you answer no, there is a slight risk that Emacs might crash, so
2900 only do it if you really want to undo the command.
2902 This option is mainly intended for debugging. You have to be
2903 careful if you use it for other purposes. Garbage collection is
2904 inhibited while the question is asked, meaning that Emacs might
2905 leak memory. So you should make sure that you do not wait
2906 excessively long before answering the question."
2911 (defvar undo-extra-outer-limit nil
2912 "If non-nil, an extra level of size that's ok in an undo item.
2913 We don't ask the user about truncating the undo list until the
2914 current item gets bigger than this amount.
2916 This variable only matters if `undo-ask-before-discard' is non-nil.")
2917 (make-variable-buffer-local 'undo-extra-outer-limit)
2919 ;; When the first undo batch in an undo list is longer than
2920 ;; undo-outer-limit, this function gets called to warn the user that
2921 ;; the undo info for the current command was discarded. Garbage
2922 ;; collection is inhibited around the call, so it had better not do a
2924 (setq undo-outer-limit-function 'undo-outer-limit-truncate)
2925 (defun undo-outer-limit-truncate (size)
2926 (if undo-ask-before-discard
2927 (when (or (null undo-extra-outer-limit)
2928 (> size undo-extra-outer-limit))
2929 ;; Don't ask the question again unless it gets even bigger.
2930 ;; This applies, in particular, if the user quits from the question.
2931 ;; Such a quit quits out of GC, but something else will call GC
2932 ;; again momentarily. It will call this function again,
2933 ;; but we don't want to ask the question again.
2934 (setq undo-extra-outer-limit (+ size 50000))
2935 (if (let (use-dialog-box track-mouse executing-kbd-macro )
2936 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
2937 (buffer-name) size)))
2938 (progn (setq buffer-undo-list nil)
2939 (setq undo-extra-outer-limit nil)
2942 (display-warning '(undo discard-info)
2944 (format "Buffer `%s' undo info was %d bytes long.\n"
2946 "The undo info was discarded because it exceeded \
2949 This is normal if you executed a command that made a huge change
2950 to the buffer. In that case, to prevent similar problems in the
2951 future, set `undo-outer-limit' to a value that is large enough to
2952 cover the maximum size of normal changes you expect a single
2953 command to make, but not so large that it might exceed the
2954 maximum memory allotted to Emacs.
2956 If you did not execute any such command, the situation is
2957 probably due to a bug and you should report it.
2959 You can disable the popping up of this buffer by adding the entry
2960 \(undo discard-info) to the user option `warning-suppress-types',
2961 which is defined in the `warnings' library.\n")
2963 (setq buffer-undo-list nil)
2966 (defcustom password-word-equivalents
2967 '("password" "passcode" "passphrase" "pass phrase"
2968 ; These are sorted according to the GNU en_US locale.
2971 "ପ୍ରବେଶ ସଙ୍କେତ" ; or
2997 "пароль" ; kk, ru, uk
3012 "List of words equivalent to \"password\".
3013 This is used by Shell mode and other parts of Emacs to recognize
3014 password prompts, including prompts in languages other than
3015 English. Different case choices should not be assumed to be
3016 included; callers should bind `case-fold-search' to t."
3017 :type '(repeat string)
3021 (defvar shell-command-history nil
3022 "History list for some commands that read shell commands.
3024 Maximum length of the history list is determined by the value
3025 of `history-length', which see.")
3027 (defvar shell-command-switch (purecopy "-c")
3028 "Switch used to have the shell execute its command line argument.")
3030 (defvar shell-command-default-error-buffer nil
3031 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3032 This buffer is used when `shell-command' or `shell-command-on-region'
3033 is run interactively. A value of nil means that output to stderr and
3034 stdout will be intermixed in the output stream.")
3036 (declare-function mailcap-file-default-commands "mailcap" (files))
3037 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
3039 (defun minibuffer-default-add-shell-commands ()
3040 "Return a list of all commands associated with the current file.
3041 This function is used to add all related commands retrieved by `mailcap'
3042 to the end of the list of defaults just after the default value."
3044 (let* ((filename (if (listp minibuffer-default)
3045 (car minibuffer-default)
3046 minibuffer-default))
3047 (commands (and filename (require 'mailcap nil t)
3048 (mailcap-file-default-commands (list filename)))))
3049 (setq commands (mapcar (lambda (command)
3050 (concat command " " filename))
3052 (if (listp minibuffer-default)
3053 (append minibuffer-default commands)
3054 (cons minibuffer-default commands))))
3056 (declare-function shell-completion-vars "shell" ())
3058 (defvar minibuffer-local-shell-command-map
3059 (let ((map (make-sparse-keymap)))
3060 (set-keymap-parent map minibuffer-local-map)
3061 (define-key map "\t" 'completion-at-point)
3063 "Keymap used for completing shell commands in minibuffer.")
3065 (defun read-shell-command (prompt &optional initial-contents hist &rest args)
3066 "Read a shell command from the minibuffer.
3067 The arguments are the same as the ones of `read-from-minibuffer',
3068 except READ and KEYMAP are missing and HIST defaults
3069 to `shell-command-history'."
3071 (minibuffer-with-setup-hook
3073 (shell-completion-vars)
3074 (set (make-local-variable 'minibuffer-default-add-function)
3075 'minibuffer-default-add-shell-commands))
3076 (apply 'read-from-minibuffer prompt initial-contents
3077 minibuffer-local-shell-command-map
3079 (or hist 'shell-command-history)
3082 (defcustom async-shell-command-buffer 'confirm-new-buffer
3083 "What to do when the output buffer is used by another shell command.
3084 This option specifies how to resolve the conflict where a new command
3085 wants to direct its output to the buffer `*Async Shell Command*',
3086 but this buffer is already taken by another running shell command.
3088 The value `confirm-kill-process' is used to ask for confirmation before
3089 killing the already running process and running a new process
3090 in the same buffer, `confirm-new-buffer' for confirmation before running
3091 the command in a new buffer with a name other than the default buffer name,
3092 `new-buffer' for doing the same without confirmation,
3093 `confirm-rename-buffer' for confirmation before renaming the existing
3094 output buffer and running a new command in the default buffer,
3095 `rename-buffer' for doing the same without confirmation."
3096 :type '(choice (const :tag "Confirm killing of running command"
3097 confirm-kill-process)
3098 (const :tag "Confirm creation of a new buffer"
3100 (const :tag "Create a new buffer"
3102 (const :tag "Confirm renaming of existing buffer"
3103 confirm-rename-buffer)
3104 (const :tag "Rename the existing buffer"
3109 (defun async-shell-command (command &optional output-buffer error-buffer)
3110 "Execute string COMMAND asynchronously in background.
3112 Like `shell-command', but adds `&' at the end of COMMAND
3113 to execute it asynchronously.
3115 The output appears in the buffer `*Async Shell Command*'.
3116 That buffer is in shell mode.
3118 You can configure `async-shell-command-buffer' to specify what to do in
3119 case when `*Async Shell Command*' buffer is already taken by another
3120 running shell command. To run COMMAND without displaying the output
3121 in a window you can configure `display-buffer-alist' to use the action
3122 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3124 In Elisp, you will often be better served by calling `start-process'
3125 directly, since it offers more control and does not impose the use of a
3126 shell (with its need to quote arguments)."
3129 (read-shell-command "Async shell command: " nil nil
3133 ((eq major-mode 'dired-mode)
3134 (dired-get-filename nil t)))))
3135 (and filename (file-relative-name filename))))
3137 shell-command-default-error-buffer))
3138 (unless (string-match "&[ \t]*\\'" command)
3139 (setq command (concat command " &")))
3140 (shell-command command output-buffer error-buffer))
3142 (defun shell-command (command &optional output-buffer error-buffer)
3143 "Execute string COMMAND in inferior shell; display output, if any.
3144 With prefix argument, insert the COMMAND's output at point.
3146 If COMMAND ends in `&', execute it asynchronously.
3147 The output appears in the buffer `*Async Shell Command*'.
3148 That buffer is in shell mode. You can also use
3149 `async-shell-command' that automatically adds `&'.
3151 Otherwise, COMMAND is executed synchronously. The output appears in
3152 the buffer `*Shell Command Output*'. If the output is short enough to
3153 display in the echo area (which is determined by the variables
3154 `resize-mini-windows' and `max-mini-window-height'), it is shown
3155 there, but it is nonetheless available in buffer `*Shell Command
3156 Output*' even though that buffer is not automatically displayed.
3158 To specify a coding system for converting non-ASCII characters
3159 in the shell command output, use \\[universal-coding-system-argument] \
3160 before this command.
3162 Noninteractive callers can specify coding systems by binding
3163 `coding-system-for-read' and `coding-system-for-write'.
3165 The optional second argument OUTPUT-BUFFER, if non-nil,
3166 says to put the output in some other buffer.
3167 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3168 If OUTPUT-BUFFER is not a buffer and not nil,
3169 insert output in current buffer. (This cannot be done asynchronously.)
3170 In either case, the buffer is first erased, and the output is
3171 inserted after point (leaving mark after it).
3173 If the command terminates without error, but generates output,
3174 and you did not specify \"insert it in the current buffer\",
3175 the output can be displayed in the echo area or in its buffer.
3176 If the output is short enough to display in the echo area
3177 \(determined by the variable `max-mini-window-height' if
3178 `resize-mini-windows' is non-nil), it is shown there.
3179 Otherwise,the buffer containing the output is displayed.
3181 If there is output and an error, and you did not specify \"insert it
3182 in the current buffer\", a message about the error goes at the end
3185 If there is no output, or if output is inserted in the current buffer,
3186 then `*Shell Command Output*' is deleted.
3188 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3189 or buffer name to which to direct the command's standard error output.
3190 If it is nil, error output is mingled with regular output.
3191 In an interactive call, the variable `shell-command-default-error-buffer'
3192 specifies the value of ERROR-BUFFER.
3194 In Elisp, you will often be better served by calling `call-process' or
3195 `start-process' directly, since it offers more control and does not impose
3196 the use of a shell (with its need to quote arguments)."
3200 (read-shell-command "Shell command: " nil nil
3204 ((eq major-mode 'dired-mode)
3205 (dired-get-filename nil t)))))
3206 (and filename (file-relative-name filename))))
3208 shell-command-default-error-buffer))
3209 ;; Look for a handler in case default-directory is a remote file name.
3211 (find-file-name-handler (directory-file-name default-directory)
3214 (funcall handler 'shell-command command output-buffer error-buffer)
3215 (if (and output-buffer
3216 (not (or (bufferp output-buffer) (stringp output-buffer))))
3217 ;; Output goes in current buffer.
3221 (expand-file-name "scor"
3222 (or small-temporary-file-directory
3223 temporary-file-directory)))
3225 (barf-if-buffer-read-only)
3227 ;; We do not use -f for csh; we will not support broken use of
3228 ;; .cshrcs. Even the BSD csh manual says to use
3229 ;; "if ($?prompt) exit" before things which are not useful
3230 ;; non-interactively. Besides, if someone wants their other
3231 ;; aliases for shell commands then they can still have them.
3232 (call-process shell-file-name nil
3236 nil shell-command-switch command)
3237 (when (and error-file (file-exists-p error-file))
3238 (if (< 0 (nth 7 (file-attributes error-file)))
3239 (with-current-buffer (get-buffer-create error-buffer)
3240 (let ((pos-from-end (- (point-max) (point))))
3243 ;; Do no formatting while reading error file,
3244 ;; because that can run a shell command, and we
3245 ;; don't want that to cause an infinite recursion.
3246 (format-insert-file error-file nil)
3247 ;; Put point after the inserted errors.
3248 (goto-char (- (point-max) pos-from-end)))
3249 (display-buffer (current-buffer))))
3250 (delete-file error-file))
3251 ;; This is like exchange-point-and-mark, but doesn't
3252 ;; activate the mark. It is cleaner to avoid activation,
3253 ;; even though the command loop would deactivate the mark
3254 ;; because we inserted text.
3255 (goto-char (prog1 (mark t)
3256 (set-marker (mark-marker) (point)
3257 (current-buffer)))))
3258 ;; Output goes in a separate buffer.
3259 ;; Preserve the match data in case called from a program.
3261 (if (string-match "[ \t]*&[ \t]*\\'" command)
3262 ;; Command ending with ampersand means asynchronous.
3263 (let ((buffer (get-buffer-create
3264 (or output-buffer "*Async Shell Command*")))
3265 (directory default-directory)
3267 ;; Remove the ampersand.
3268 (setq command (substring command 0 (match-beginning 0)))
3269 ;; Ask the user what to do with already running process.
3270 (setq proc (get-buffer-process buffer))
3273 ((eq async-shell-command-buffer 'confirm-kill-process)
3274 ;; If will kill a process, query first.
3275 (if (yes-or-no-p "A command is running in the default buffer. Kill it? ")
3277 (error "Shell command in progress")))
3278 ((eq async-shell-command-buffer 'confirm-new-buffer)
3279 ;; If will create a new buffer, query first.
3280 (if (yes-or-no-p "A command is running in the default buffer. Use a new buffer? ")
3281 (setq buffer (generate-new-buffer
3282 (or (and (bufferp output-buffer) (buffer-name output-buffer))
3283 output-buffer "*Async Shell Command*")))
3284 (error "Shell command in progress")))
3285 ((eq async-shell-command-buffer 'new-buffer)
3286 ;; It will create a new buffer.
3287 (setq buffer (generate-new-buffer
3288 (or (and (bufferp output-buffer) (buffer-name output-buffer))
3289 output-buffer "*Async Shell Command*"))))
3290 ((eq async-shell-command-buffer 'confirm-rename-buffer)
3291 ;; If will rename the buffer, query first.
3292 (if (yes-or-no-p "A command is running in the default buffer. Rename it? ")
3294 (with-current-buffer buffer
3296 (setq buffer (get-buffer-create
3297 (or output-buffer "*Async Shell Command*"))))
3298 (error "Shell command in progress")))
3299 ((eq async-shell-command-buffer 'rename-buffer)
3300 ;; It will rename the buffer.
3301 (with-current-buffer buffer
3303 (setq buffer (get-buffer-create
3304 (or output-buffer "*Async Shell Command*"))))))
3305 (with-current-buffer buffer
3306 (setq buffer-read-only nil)
3307 ;; Setting buffer-read-only to nil doesn't suffice
3308 ;; if some text has a non-nil read-only property,
3309 ;; which comint sometimes adds for prompts.
3310 (let ((inhibit-read-only t))
3312 (display-buffer buffer '(nil (allow-no-window . t)))
3313 (setq default-directory directory)
3314 (setq proc (start-process "Shell" buffer shell-file-name
3315 shell-command-switch command))
3316 (setq mode-line-process '(":%s"))
3317 (require 'shell) (shell-mode)
3318 (set-process-sentinel proc 'shell-command-sentinel)
3319 ;; Use the comint filter for proper handling of carriage motion
3320 ;; (see `comint-inhibit-carriage-motion'),.
3321 (set-process-filter proc 'comint-output-filter)
3323 ;; Otherwise, command is executed synchronously.
3324 (shell-command-on-region (point) (point) command
3325 output-buffer nil error-buffer)))))))
3327 (defun display-message-or-buffer (message
3328 &optional buffer-name not-this-window frame)
3329 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3330 MESSAGE may be either a string or a buffer.
3332 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3333 the maximum height of the echo area, as defined by `max-mini-window-height'
3334 if `resize-mini-windows' is non-nil.
3336 Returns either the string shown in the echo area, or when a pop-up
3337 buffer is used, the window used to display it.
3339 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3340 name of the buffer used to display it in the case where a pop-up buffer
3341 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3342 string and it is displayed in the echo area, it is not specified whether
3343 the contents are inserted into the buffer anyway.
3345 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3346 and only used if a buffer is displayed."
3347 (cond ((and (stringp message) (not (string-match "\n" message)))
3348 ;; Trivial case where we can use the echo area
3349 (message "%s" message))
3350 ((and (stringp message)
3351 (= (string-match "\n" message) (1- (length message))))
3352 ;; Trivial case where we can just remove single trailing newline
3353 (message "%s" (substring message 0 (1- (length message)))))
3356 (with-current-buffer
3357 (if (bufferp message)
3359 (get-buffer-create (or buffer-name "*Message*")))
3361 (unless (bufferp message)
3366 (if (= (buffer-size) 0)
3368 (count-screen-lines nil nil nil (minibuffer-window)))))
3370 ((and (or (<= lines 1)
3372 (if resize-mini-windows
3373 (cond ((floatp max-mini-window-height)
3375 max-mini-window-height))
3376 ((integerp max-mini-window-height)
3377 max-mini-window-height)
3381 ;; Don't use the echo area if the output buffer is
3382 ;; already displayed in the selected frame.
3383 (not (get-buffer-window (current-buffer))))
3385 (goto-char (point-max))
3388 (message "%s" (buffer-substring (point-min) (point))))
3391 (goto-char (point-min))
3392 (display-buffer (current-buffer)
3393 not-this-window frame))))))))
3396 ;; We have a sentinel to prevent insertion of a termination message
3397 ;; in the buffer itself.
3398 (defun shell-command-sentinel (process signal)
3399 (if (memq (process-status process) '(exit signal))
3401 (car (cdr (cdr (process-command process))))
3402 (substring signal 0 -1))))
3404 (defun shell-command-on-region (start end command
3405 &optional output-buffer replace
3406 error-buffer display-error-buffer)
3407 "Execute string COMMAND in inferior shell with region as input.
3408 Normally display output (if any) in temp buffer `*Shell Command Output*';
3409 Prefix arg means replace the region with it. Return the exit code of
3412 To specify a coding system for converting non-ASCII characters
3413 in the input and output to the shell command, use \\[universal-coding-system-argument]
3414 before this command. By default, the input (from the current buffer)
3415 is encoded using coding-system specified by `process-coding-system-alist',
3416 falling back to `default-process-coding-system' if no match for COMMAND
3417 is found in `process-coding-system-alist'.
3419 Noninteractive callers can specify coding systems by binding
3420 `coding-system-for-read' and `coding-system-for-write'.
3422 If the command generates output, the output may be displayed
3423 in the echo area or in a buffer.
3424 If the output is short enough to display in the echo area
3425 \(determined by the variable `max-mini-window-height' if
3426 `resize-mini-windows' is non-nil), it is shown there.
3427 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3428 The output is available in that buffer in both cases.
3430 If there is output and an error, a message about the error
3431 appears at the end of the output. If there is no output, or if
3432 output is inserted in the current buffer, the buffer `*Shell
3433 Command Output*' is deleted.
3435 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3436 command's output. If the value is a buffer or buffer name,
3437 put the output there. If the value is nil, use the buffer
3438 `*Shell Command Output*'. Any other value, excluding nil,
3439 means to insert the output in the current buffer. In either case,
3440 the output is inserted after point (leaving mark after it).
3442 Optional fifth arg REPLACE, if non-nil, means to insert the
3443 output in place of text from START to END, putting point and mark
3446 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3447 or buffer name to which to direct the command's standard error
3448 output. If nil, error output is mingled with regular output.
3449 When called interactively, `shell-command-default-error-buffer'
3450 is used for ERROR-BUFFER.
3452 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3453 display the error buffer if there were any errors. When called
3454 interactively, this is t."
3455 (interactive (let (string)
3457 (user-error "The mark is not set now, so there is no region"))
3458 ;; Do this before calling region-beginning
3459 ;; and region-end, in case subprocess output
3460 ;; relocates them while we are in the minibuffer.
3461 (setq string (read-shell-command "Shell command on region: "))
3462 ;; call-interactively recognizes region-beginning and
3463 ;; region-end specially, leaving them in the history.
3464 (list (region-beginning) (region-end)
3468 shell-command-default-error-buffer
3473 (expand-file-name "scor"
3474 (or small-temporary-file-directory
3475 temporary-file-directory)))
3480 (not (or (bufferp output-buffer) (stringp output-buffer)))))
3481 ;; Replace specified region with output from command.
3482 (let ((swap (and replace (< start end))))
3483 ;; Don't muck with mark unless REPLACE says we should.
3485 (and replace (push-mark (point) 'nomsg))
3487 (call-process-region start end shell-file-name replace
3491 nil shell-command-switch command))
3492 ;; It is rude to delete a buffer which the command is not using.
3493 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3494 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3495 ;; (kill-buffer shell-buffer)))
3496 ;; Don't muck with mark unless REPLACE says we should.
3497 (and replace swap (exchange-point-and-mark)))
3498 ;; No prefix argument: put the output in a temp buffer,
3499 ;; replacing its entire contents.
3500 (let ((buffer (get-buffer-create
3501 (or output-buffer "*Shell Command Output*"))))
3503 (if (eq buffer (current-buffer))
3504 ;; If the input is the same buffer as the output,
3505 ;; delete everything but the specified region,
3506 ;; then replace that region with the output.
3507 (progn (setq buffer-read-only nil)
3508 (delete-region (max start end) (point-max))
3509 (delete-region (point-min) (min start end))
3511 (call-process-region (point-min) (point-max)
3516 nil shell-command-switch
3518 ;; Clear the output buffer, then run the command with
3520 (let ((directory default-directory))
3521 (with-current-buffer buffer
3522 (setq buffer-read-only nil)
3523 (if (not output-buffer)
3524 (setq default-directory directory))
3527 (call-process-region start end shell-file-name nil
3529 (list buffer error-file)
3531 nil shell-command-switch command)))
3532 ;; Report the output.
3533 (with-current-buffer buffer
3534 (setq mode-line-process
3535 (cond ((null exit-status)
3537 ((stringp exit-status)
3538 (format " - Signal [%s]" exit-status))
3539 ((not (equal 0 exit-status))
3540 (format " - Exit [%d]" exit-status)))))
3541 (if (with-current-buffer buffer (> (point-max) (point-min)))
3542 ;; There's some output, display it
3543 (display-message-or-buffer buffer)
3544 ;; No output; error?
3547 (< 0 (nth 7 (file-attributes error-file))))
3548 (format "some error output%s"
3549 (if shell-command-default-error-buffer
3550 (format " to the \"%s\" buffer"
3551 shell-command-default-error-buffer)
3554 (cond ((null exit-status)
3555 (message "(Shell command failed with error)"))
3556 ((equal 0 exit-status)
3557 (message "(Shell command succeeded with %s)"
3559 ((stringp exit-status)
3560 (message "(Shell command killed by signal %s)"
3563 (message "(Shell command failed with code %d and %s)"
3564 exit-status output))))
3565 ;; Don't kill: there might be useful info in the undo-log.
3566 ;; (kill-buffer buffer)
3569 (when (and error-file (file-exists-p error-file))
3570 (if (< 0 (nth 7 (file-attributes error-file)))
3571 (with-current-buffer (get-buffer-create error-buffer)
3572 (let ((pos-from-end (- (point-max) (point))))
3575 ;; Do no formatting while reading error file,
3576 ;; because that can run a shell command, and we
3577 ;; don't want that to cause an infinite recursion.
3578 (format-insert-file error-file nil)
3579 ;; Put point after the inserted errors.
3580 (goto-char (- (point-max) pos-from-end)))
3581 (and display-error-buffer
3582 (display-buffer (current-buffer)))))
3583 (delete-file error-file))
3586 (defun shell-command-to-string (command)
3587 "Execute shell command COMMAND and return its output as a string."
3588 (with-output-to-string
3589 (with-current-buffer
3591 (process-file shell-file-name nil t nil shell-command-switch command))))
3593 (defun process-file (program &optional infile buffer display &rest args)
3594 "Process files synchronously in a separate process.
3595 Similar to `call-process', but may invoke a file handler based on
3596 `default-directory'. The current working directory of the
3597 subprocess is `default-directory'.
3599 File names in INFILE and BUFFER are handled normally, but file
3600 names in ARGS should be relative to `default-directory', as they
3601 are passed to the process verbatim. (This is a difference to
3602 `call-process' which does not support file handlers for INFILE
3605 Some file handlers might not support all variants, for example
3606 they might behave as if DISPLAY was nil, regardless of the actual
3608 (let ((fh (find-file-name-handler default-directory 'process-file))
3611 (if fh (apply fh 'process-file program infile buffer display args)
3612 (when infile (setq lc (file-local-copy infile)))
3613 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
3614 (make-temp-file "emacs")))
3616 (apply 'call-process program
3618 (if stderr-file (list (car buffer) stderr-file) buffer)
3620 (when stderr-file (copy-file stderr-file (cadr buffer) t))))
3621 (when stderr-file (delete-file stderr-file))
3622 (when lc (delete-file lc)))))
3624 (defvar process-file-side-effects t
3625 "Whether a call of `process-file' changes remote files.
3627 By default, this variable is always set to t, meaning that a
3628 call of `process-file' could potentially change any file on a
3629 remote host. When set to nil, a file handler could optimize
3630 its behavior with respect to remote file attribute caching.
3632 You should only ever change this variable with a let-binding;
3633 never with `setq'.")
3635 (defun start-file-process (name buffer program &rest program-args)
3636 "Start a program in a subprocess. Return the process object for it.
3638 Similar to `start-process', but may invoke a file handler based on
3639 `default-directory'. See Info node `(elisp)Magic File Names'.
3641 This handler ought to run PROGRAM, perhaps on the local host,
3642 perhaps on a remote host that corresponds to `default-directory'.
3643 In the latter case, the local part of `default-directory' becomes
3644 the working directory of the process.
3646 PROGRAM and PROGRAM-ARGS might be file names. They are not
3647 objects of file handler invocation. File handlers might not
3648 support pty association, if PROGRAM is nil."
3649 (let ((fh (find-file-name-handler default-directory 'start-file-process)))
3650 (if fh (apply fh 'start-file-process name buffer program program-args)
3651 (apply 'start-process name buffer program program-args))))
3655 (defvar tabulated-list-format)
3656 (defvar tabulated-list-entries)
3657 (defvar tabulated-list-sort-key)
3658 (declare-function tabulated-list-init-header "tabulated-list" ())
3659 (declare-function tabulated-list-print "tabulated-list"
3660 (&optional remember-pos update))
3662 (defvar process-menu-query-only nil)
3664 (defvar process-menu-mode-map
3665 (let ((map (make-sparse-keymap)))
3666 (define-key map [?d] 'process-menu-delete-process)
3669 (define-derived-mode process-menu-mode tabulated-list-mode "Process Menu"
3670 "Major mode for listing the processes called by Emacs."
3671 (setq tabulated-list-format [("Process" 15 t)
3676 (make-local-variable 'process-menu-query-only)
3677 (setq tabulated-list-sort-key (cons "Process" nil))
3678 (add-hook 'tabulated-list-revert-hook 'list-processes--refresh nil t)
3679 (tabulated-list-init-header))
3681 (defun process-menu-delete-process ()
3682 "Kill process at point in a `list-processes' buffer."
3684 (delete-process (tabulated-list-get-id))
3687 (defun list-processes--refresh ()
3688 "Recompute the list of processes for the Process List buffer.
3689 Also, delete any process that is exited or signaled."
3690 (setq tabulated-list-entries nil)
3691 (dolist (p (process-list))
3692 (cond ((memq (process-status p) '(exit signal closed))
3694 ((or (not process-menu-query-only)
3695 (process-query-on-exit-flag p))
3696 (let* ((buf (process-buffer p))
3697 (type (process-type p))
3698 (name (process-name p))
3699 (status (symbol-name (process-status p)))
3700 (buf-label (if (buffer-live-p buf)
3701 `(,(buffer-name buf)
3703 help-echo ,(concat "Visit buffer `"
3704 (buffer-name buf) "'")
3707 action process-menu-visit-buffer)
3709 (tty (or (process-tty-name p) "--"))
3711 (if (memq type '(network serial))
3712 (let ((contact (process-contact p t)))
3713 (if (eq type 'network)
3715 (if (plist-get contact :type)
3718 (if (plist-get contact :server)
3719 (format "server on %s"
3721 (plist-get contact :host)
3722 (plist-get contact :local)))
3723 (format "connection to %s"
3724 (plist-get contact :host))))
3725 (format "(serial port %s%s)"
3726 (or (plist-get contact :port) "?")
3727 (let ((speed (plist-get contact :speed)))
3729 (format " at %s b/s" speed)
3731 (mapconcat 'identity (process-command p) " "))))
3732 (push (list p (vector name status buf-label tty cmd))
3733 tabulated-list-entries))))))
3735 (defun process-menu-visit-buffer (button)
3736 (display-buffer (button-get button 'process-buffer)))
3738 (defun list-processes (&optional query-only buffer)
3739 "Display a list of all processes that are Emacs sub-processes.
3740 If optional argument QUERY-ONLY is non-nil, only processes with
3741 the query-on-exit flag set are listed.
3742 Any process listed as exited or signaled is actually eliminated
3743 after the listing is made.
3744 Optional argument BUFFER specifies a buffer to use, instead of
3746 The return value is always nil.
3748 This function lists only processes that were launched by Emacs. To
3749 see other processes running on the system, use `list-system-processes'."
3751 (or (fboundp 'process-list)
3752 (error "Asynchronous subprocesses are not supported on this system"))
3753 (unless (bufferp buffer)
3754 (setq buffer (get-buffer-create "*Process List*")))
3755 (with-current-buffer buffer
3757 (setq process-menu-query-only query-only)
3758 (list-processes--refresh)
3759 (tabulated-list-print))
3760 (display-buffer buffer)
3763 (defvar universal-argument-map
3764 (let ((map (make-sparse-keymap))
3765 (universal-argument-minus
3766 ;; For backward compatibility, minus with no modifiers is an ordinary
3767 ;; command if digits have already been entered.
3768 `(menu-item "" negative-argument
3769 :filter ,(lambda (cmd)
3770 (if (integerp prefix-arg) nil cmd)))))
3771 (define-key map [switch-frame]
3772 (lambda (e) (interactive "e")
3773 (handle-switch-frame e) (universal-argument--mode)))
3774 (define-key map [?\C-u] 'universal-argument-more)
3775 (define-key map [?-] universal-argument-minus)
3776 (define-key map [?0] 'digit-argument)
3777 (define-key map [?1] 'digit-argument)
3778 (define-key map [?2] 'digit-argument)
3779 (define-key map [?3] 'digit-argument)
3780 (define-key map [?4] 'digit-argument)
3781 (define-key map [?5] 'digit-argument)
3782 (define-key map [?6] 'digit-argument)
3783 (define-key map [?7] 'digit-argument)
3784 (define-key map [?8] 'digit-argument)
3785 (define-key map [?9] 'digit-argument)
3786 (define-key map [kp-0] 'digit-argument)
3787 (define-key map [kp-1] 'digit-argument)
3788 (define-key map [kp-2] 'digit-argument)
3789 (define-key map [kp-3] 'digit-argument)
3790 (define-key map [kp-4] 'digit-argument)
3791 (define-key map [kp-5] 'digit-argument)
3792 (define-key map [kp-6] 'digit-argument)
3793 (define-key map [kp-7] 'digit-argument)
3794 (define-key map [kp-8] 'digit-argument)
3795 (define-key map [kp-9] 'digit-argument)
3796 (define-key map [kp-subtract] universal-argument-minus)
3798 "Keymap used while processing \\[universal-argument].")
3800 (defun universal-argument--mode ()
3801 (set-transient-map universal-argument-map))
3803 (defun universal-argument ()
3804 "Begin a numeric argument for the following command.
3805 Digits or minus sign following \\[universal-argument] make up the numeric argument.
3806 \\[universal-argument] following the digits or minus sign ends the argument.
3807 \\[universal-argument] without digits or minus sign provides 4 as argument.
3808 Repeating \\[universal-argument] without digits or minus sign
3809 multiplies the argument by 4 each time.
3810 For some commands, just \\[universal-argument] by itself serves as a flag
3811 which is different in effect from any particular numeric argument.
3812 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
3814 (setq prefix-arg (list 4))
3815 (universal-argument--mode))
3817 (defun universal-argument-more (arg)
3818 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3819 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3821 (setq prefix-arg (if (consp arg)
3822 (list (* 4 (car arg)))
3826 (when (consp prefix-arg) (universal-argument--mode)))
3828 (defun negative-argument (arg)
3829 "Begin a negative numeric argument for the next command.
3830 \\[universal-argument] following digits or minus sign ends the argument."
3832 (setq prefix-arg (cond ((integerp arg) (- arg))
3835 (universal-argument--mode))
3837 (defun digit-argument (arg)
3838 "Part of the numeric argument for the next command.
3839 \\[universal-argument] following digits or minus sign ends the argument."
3841 (let* ((char (if (integerp last-command-event)
3843 (get last-command-event 'ascii-character)))
3844 (digit (- (logand char ?\177) ?0)))
3845 (setq prefix-arg (cond ((integerp arg)
3847 (if (< arg 0) (- digit) digit)))
3849 ;; Treat -0 as just -, so that -01 will work.
3850 (if (zerop digit) '- (- digit)))
3853 (universal-argument--mode))
3856 (defvar filter-buffer-substring-functions nil
3857 "This variable is a wrapper hook around `buffer-substring--filter'.")
3858 (make-obsolete-variable 'filter-buffer-substring-functions
3859 'filter-buffer-substring-function "24.4")
3861 (defvar filter-buffer-substring-function #'buffer-substring--filter
3862 "Function to perform the filtering in `filter-buffer-substring'.
3863 The function is called with the same 3 arguments (BEG END DELETE)
3864 that `filter-buffer-substring' received. It should return the
3865 buffer substring between BEG and END, after filtering. If DELETE is
3866 non-nil, it should delete the text between BEG and END from the buffer.")
3868 (defvar buffer-substring-filters nil
3869 "List of filter functions for `buffer-substring--filter'.
3870 Each function must accept a single argument, a string, and return a string.
3871 The buffer substring is passed to the first function in the list,
3872 and the return value of each function is passed to the next.
3873 As a special convention, point is set to the start of the buffer text
3874 being operated on (i.e., the first argument of `buffer-substring--filter')
3875 before these functions are called.")
3876 (make-obsolete-variable 'buffer-substring-filters
3877 'filter-buffer-substring-function "24.1")
3879 (defun filter-buffer-substring (beg end &optional delete)
3880 "Return the buffer substring between BEG and END, after filtering.
3881 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3883 This calls the function that `filter-buffer-substring-function' specifies
3884 \(passing the same three arguments that it received) to do the work,
3885 and returns whatever it does. The default function does no filtering,
3886 unless a hook has been set.
3888 Use `filter-buffer-substring' instead of `buffer-substring',
3889 `buffer-substring-no-properties', or `delete-and-extract-region' when
3890 you want to allow filtering to take place. For example, major or minor
3891 modes can use `filter-buffer-substring-function' to extract characters
3892 that are special to a buffer, and should not be copied into other buffers."
3893 (funcall filter-buffer-substring-function beg end delete))
3895 (defun buffer-substring--filter (beg end &optional delete)
3896 "Default function to use for `filter-buffer-substring-function'.
3897 Its arguments and return value are as specified for `filter-buffer-substring'.
3898 This respects the wrapper hook `filter-buffer-substring-functions',
3899 and the abnormal hook `buffer-substring-filters'.
3900 No filtering is done unless a hook says to."
3901 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3903 ((or delete buffer-substring-filters)
3906 (let ((string (if delete (delete-and-extract-region beg end)
3907 (buffer-substring beg end))))
3908 (dolist (filter buffer-substring-filters)
3909 (setq string (funcall filter string)))
3912 (buffer-substring beg end)))))
3915 ;;;; Window system cut and paste hooks.
3917 (defvar interprogram-cut-function #'gui-select-text
3918 "Function to call to make a killed region available to other programs.
3919 Most window systems provide a facility for cutting and pasting
3920 text between different programs, such as the clipboard on X and
3921 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3923 This variable holds a function that Emacs calls whenever text is
3924 put in the kill ring, to make the new kill available to other
3925 programs. The function takes one argument, TEXT, which is a
3926 string containing the text which should be made available.")
3928 (defvar interprogram-paste-function #'gui-selection-value
3929 "Function to call to get text cut from other programs.
3930 Most window systems provide a facility for cutting and pasting
3931 text between different programs, such as the clipboard on X and
3932 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3934 This variable holds a function that Emacs calls to obtain text
3935 that other programs have provided for pasting. The function is
3936 called with no arguments. If no other program has provided text
3937 to paste, the function should return nil (in which case the
3938 caller, usually `current-kill', should use the top of the Emacs
3939 kill ring). If another program has provided text to paste, the
3940 function should return that text as a string (in which case the
3941 caller should put this string in the kill ring as the latest
3944 The function may also return a list of strings if the window
3945 system supports multiple selections. The first string will be
3946 used as the pasted text, but the other will be placed in the kill
3947 ring for easy access via `yank-pop'.
3949 Note that the function should return a string only if a program
3950 other than Emacs has provided a string for pasting; if Emacs
3951 provided the most recent string, the function should return nil.
3952 If it is difficult to tell whether Emacs or some other program
3953 provided the current string, it is probably good enough to return
3954 nil if the string is equal (according to `string=') to the last
3955 text Emacs provided.")
3959 ;;;; The kill ring data structure.
3961 (defvar kill-ring nil
3962 "List of killed text sequences.
3963 Since the kill ring is supposed to interact nicely with cut-and-paste
3964 facilities offered by window systems, use of this variable should
3965 interact nicely with `interprogram-cut-function' and
3966 `interprogram-paste-function'. The functions `kill-new',
3967 `kill-append', and `current-kill' are supposed to implement this
3968 interaction; you may want to use them instead of manipulating the kill
3971 (defcustom kill-ring-max 60
3972 "Maximum length of kill ring before oldest elements are thrown away."
3976 (defvar kill-ring-yank-pointer nil
3977 "The tail of the kill ring whose car is the last thing yanked.")
3979 (defcustom save-interprogram-paste-before-kill nil
3980 "Save clipboard strings into kill ring before replacing them.
3981 When one selects something in another program to paste it into Emacs,
3982 but kills something in Emacs before actually pasting it,
3983 this selection is gone unless this variable is non-nil,
3984 in which case the other program's selection is saved in the `kill-ring'
3985 before the Emacs kill and one can still paste it using \\[yank] \\[yank-pop]."
3990 (defcustom kill-do-not-save-duplicates nil
3991 "Do not add a new string to `kill-ring' if it duplicates the last one.
3992 The comparison is done using `equal-including-properties'."
3997 (defun kill-new (string &optional replace)
3998 "Make STRING the latest kill in the kill ring.
3999 Set `kill-ring-yank-pointer' to point to it.
4000 If `interprogram-cut-function' is non-nil, apply it to STRING.
4001 Optional second argument REPLACE non-nil means that STRING will replace
4002 the front of the kill ring, rather than being added to the list.
4004 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4005 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4008 When the yank handler has a non-nil PARAM element, the original STRING
4009 argument is not used by `insert-for-yank'. However, since Lisp code
4010 may access and use elements from the kill ring directly, the STRING
4011 argument should still be a \"useful\" string for such uses."
4012 (unless (and kill-do-not-save-duplicates
4013 ;; Due to text properties such as 'yank-handler that
4014 ;; can alter the contents to yank, comparison using
4015 ;; `equal' is unsafe.
4016 (equal-including-properties string (car kill-ring)))
4017 (if (fboundp 'menu-bar-update-yank-menu)
4018 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
4019 (when save-interprogram-paste-before-kill
4020 (let ((interprogram-paste (and interprogram-paste-function
4021 (funcall interprogram-paste-function))))
4022 (when interprogram-paste
4023 (dolist (s (if (listp interprogram-paste)
4024 (nreverse interprogram-paste)
4025 (list interprogram-paste)))
4026 (unless (and kill-do-not-save-duplicates
4027 (equal-including-properties s (car kill-ring)))
4028 (push s kill-ring))))))
4029 (unless (and kill-do-not-save-duplicates
4030 (equal-including-properties string (car kill-ring)))
4031 (if (and replace kill-ring)
4032 (setcar kill-ring string)
4033 (push string kill-ring)
4034 (if (> (length kill-ring) kill-ring-max)
4035 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
4036 (setq kill-ring-yank-pointer kill-ring)
4037 (if interprogram-cut-function
4038 (funcall interprogram-cut-function string)))
4040 ;; It has been argued that this should work similar to `self-insert-command'
4041 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4042 (defcustom kill-append-merge-undo nil
4043 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4048 (defun kill-append (string before-p)
4049 "Append STRING to the end of the latest kill in the kill ring.
4050 If BEFORE-P is non-nil, prepend STRING to the kill.
4051 Also removes the last undo boundary in the current buffer,
4052 depending on `kill-append-merge-undo'.
4053 If `interprogram-cut-function' is set, pass the resulting kill to it."
4054 (let* ((cur (car kill-ring)))
4055 (kill-new (if before-p (concat string cur) (concat cur string))
4056 (or (= (length cur) 0)
4057 (equal nil (get-text-property 0 'yank-handler cur))))
4058 (when (and kill-append-merge-undo (not buffer-read-only))
4059 (let ((prev buffer-undo-list)
4060 (next (cdr buffer-undo-list)))
4061 ;; find the next undo boundary
4065 ;; remove this undo boundary
4067 (setcdr prev (cdr next)))))))
4069 (defcustom yank-pop-change-selection nil
4070 "Whether rotating the kill ring changes the window system selection.
4071 If non-nil, whenever the kill ring is rotated (usually via the
4072 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4073 to copy the new kill to the window system selection."
4078 (defun current-kill (n &optional do-not-move)
4079 "Rotate the yanking point by N places, and then return that kill.
4080 If N is zero and `interprogram-paste-function' is set to a
4081 function that returns a string or a list of strings, and if that
4082 function doesn't return nil, then that string (or list) is added
4083 to the front of the kill ring and the string (or first string in
4084 the list) is returned as the latest kill.
4086 If N is not zero, and if `yank-pop-change-selection' is
4087 non-nil, use `interprogram-cut-function' to transfer the
4088 kill at the new yank point into the window system selection.
4090 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4091 move the yanking point; just return the Nth kill forward."
4093 (let ((interprogram-paste (and (= n 0)
4094 interprogram-paste-function
4095 (funcall interprogram-paste-function))))
4096 (if interprogram-paste
4098 ;; Disable the interprogram cut function when we add the new
4099 ;; text to the kill ring, so Emacs doesn't try to own the
4100 ;; selection, with identical text.
4101 (let ((interprogram-cut-function nil))
4102 (if (listp interprogram-paste)
4103 (mapc 'kill-new (nreverse interprogram-paste))
4104 (kill-new interprogram-paste)))
4106 (or kill-ring (error "Kill ring is empty"))
4107 (let ((ARGth-kill-element
4108 (nthcdr (mod (- n (length kill-ring-yank-pointer))
4112 (setq kill-ring-yank-pointer ARGth-kill-element)
4113 (when (and yank-pop-change-selection
4115 interprogram-cut-function)
4116 (funcall interprogram-cut-function (car ARGth-kill-element))))
4117 (car ARGth-kill-element)))))
4121 ;;;; Commands for manipulating the kill ring.
4123 (defcustom kill-read-only-ok nil
4124 "Non-nil means don't signal an error for killing read-only text."
4128 (defun kill-region (beg end &optional region)
4129 "Kill (\"cut\") text between point and mark.
4130 This deletes the text from the buffer and saves it in the kill ring.
4131 The command \\[yank] can retrieve it from there.
4132 \(If you want to save the region without killing it, use \\[kill-ring-save].)
4134 If you want to append the killed region to the last killed text,
4135 use \\[append-next-kill] before \\[kill-region].
4137 If the buffer is read-only, Emacs will beep and refrain from deleting
4138 the text, but put the text in the kill ring anyway. This means that
4139 you can use the killing commands to copy text from a read-only buffer.
4141 Lisp programs should use this function for killing text.
4142 (To delete text, use `delete-region'.)
4143 Supply two arguments, character positions indicating the stretch of text
4145 Any command that calls this function is a \"kill command\".
4146 If the previous command was also a kill command,
4147 the text killed this time appends to the text killed last time
4148 to make one entry in the kill ring.
4150 The optional argument REGION if non-nil, indicates that we're not just killing
4151 some text between BEG and END, but we're killing the region."
4152 ;; Pass mark first, then point, because the order matters when
4153 ;; calling `kill-append'.
4154 (interactive (list (mark) (point) 'region))
4155 (unless (and beg end)
4156 (user-error "The mark is not set now, so there is no region"))
4158 (let ((string (if region
4159 (funcall region-extract-function 'delete)
4160 (filter-buffer-substring beg end 'delete))))
4161 (when string ;STRING is nil if BEG = END
4162 ;; Add that string to the kill ring, one way or another.
4163 (if (eq last-command 'kill-region)
4164 (kill-append string (< end beg))
4166 (when (or string (eq last-command 'kill-region))
4167 (setq this-command 'kill-region))
4168 (setq deactivate-mark t)
4170 ((buffer-read-only text-read-only)
4171 ;; The code above failed because the buffer, or some of the characters
4172 ;; in the region, are read-only.
4173 ;; We should beep, in case the user just isn't aware of this.
4174 ;; However, there's no harm in putting
4175 ;; the region's text in the kill ring, anyway.
4176 (copy-region-as-kill beg end region)
4177 ;; Set this-command now, so it will be set even if we get an error.
4178 (setq this-command 'kill-region)
4179 ;; This should barf, if appropriate, and give us the correct error.
4180 (if kill-read-only-ok
4181 (progn (message "Read only text copied to kill ring") nil)
4182 ;; Signal an error if the buffer is read-only.
4183 (barf-if-buffer-read-only)
4184 ;; If the buffer isn't read-only, the text is.
4185 (signal 'text-read-only (list (current-buffer)))))))
4187 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4188 ;; to get two copies of the text when the user accidentally types M-w and
4189 ;; then corrects it with the intended C-w.
4190 (defun copy-region-as-kill (beg end &optional region)
4191 "Save the region as if killed, but don't kill it.
4192 In Transient Mark mode, deactivate the mark.
4193 If `interprogram-cut-function' is non-nil, also save the text for a window
4194 system cut and paste.
4196 The optional argument REGION if non-nil, indicates that we're not just copying
4197 some text between BEG and END, but we're copying the region.
4199 This command's old key binding has been given to `kill-ring-save'."
4200 ;; Pass mark first, then point, because the order matters when
4201 ;; calling `kill-append'.
4202 (interactive (list (mark) (point)
4203 (prefix-numeric-value current-prefix-arg)))
4204 (let ((str (if region
4205 (funcall region-extract-function nil)
4206 (filter-buffer-substring beg end))))
4207 (if (eq last-command 'kill-region)
4208 (kill-append str (< end beg))
4210 (setq deactivate-mark t)
4213 (defun kill-ring-save (beg end &optional region)
4214 "Save the region as if killed, but don't kill it.
4215 In Transient Mark mode, deactivate the mark.
4216 If `interprogram-cut-function' is non-nil, also save the text for a window
4217 system cut and paste.
4219 If you want to append the killed line to the last killed text,
4220 use \\[append-next-kill] before \\[kill-ring-save].
4222 The optional argument REGION if non-nil, indicates that we're not just copying
4223 some text between BEG and END, but we're copying the region.
4225 This command is similar to `copy-region-as-kill', except that it gives
4226 visual feedback indicating the extent of the region being copied."
4227 ;; Pass mark first, then point, because the order matters when
4228 ;; calling `kill-append'.
4229 (interactive (list (mark) (point)
4230 (prefix-numeric-value current-prefix-arg)))
4231 (copy-region-as-kill beg end region)
4232 ;; This use of called-interactively-p is correct because the code it
4233 ;; controls just gives the user visual feedback.
4234 (if (called-interactively-p 'interactive)
4235 (indicate-copied-region)))
4237 (defun indicate-copied-region (&optional message-len)
4238 "Indicate that the region text has been copied interactively.
4239 If the mark is visible in the selected window, blink the cursor
4240 between point and mark if there is currently no active region
4243 If the mark lies outside the selected window, display an
4244 informative message containing a sample of the copied text. The
4245 optional argument MESSAGE-LEN, if non-nil, specifies the length
4246 of this sample text; it defaults to 40."
4247 (let ((mark (mark t))
4249 ;; Inhibit quitting so we can make a quit here
4250 ;; look like a C-g typed as a command.
4252 (if (pos-visible-in-window-p mark (selected-window))
4253 ;; Swap point-and-mark quickly so as to show the region that
4254 ;; was selected. Don't do it if the region is highlighted.
4255 (unless (and (region-active-p)
4256 (face-background 'region))
4257 ;; Swap point and mark.
4258 (set-marker (mark-marker) (point) (current-buffer))
4260 (sit-for blink-matching-delay)
4262 (set-marker (mark-marker) mark (current-buffer))
4264 ;; If user quit, deactivate the mark
4265 ;; as C-g would as a command.
4266 (and quit-flag (region-active-p)
4268 (let ((len (min (abs (- mark point))
4269 (or message-len 40))))
4271 ;; Don't say "killed"; that is misleading.
4272 (message "Saved text until \"%s\""
4273 (buffer-substring-no-properties (- mark len) mark))
4274 (message "Saved text from \"%s\""
4275 (buffer-substring-no-properties mark (+ mark len))))))))
4277 (defun append-next-kill (&optional interactive)
4278 "Cause following command, if it kills, to add to previous kill.
4279 If the next command kills forward from point, the kill is
4280 appended to the previous killed text. If the command kills
4281 backward, the kill is prepended. Kill commands that act on the
4282 region, such as `kill-region', are regarded as killing forward if
4283 point is after mark, and killing backward if point is before
4286 If the next command is not a kill command, `append-next-kill' has
4289 The argument is used for internal purposes; do not supply one."
4291 ;; We don't use (interactive-p), since that breaks kbd macros.
4294 (setq this-command 'kill-region)
4295 (message "If the next command is a kill, it will append"))
4296 (setq last-command 'kill-region)))
4298 (defvar bidi-directional-controls-chars "\x202a-\x202e\x2066-\x2069"
4299 "Character set that matches bidirectional formatting control characters.")
4301 (defvar bidi-directional-non-controls-chars "^\x202a-\x202e\x2066-\x2069"
4302 "Character set that matches any character except bidirectional controls.")
4304 (defun squeeze-bidi-context-1 (from to category replacement)
4305 "A subroutine of `squeeze-bidi-context'.
4306 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4307 (let ((pt (copy-marker from))
4308 (limit (copy-marker to))
4317 ;; L and R categories include embedding and
4318 ;; override controls, but we don't want to
4319 ;; replace them, because that might change
4320 ;; the visual order. Likewise with PDF and
4321 ;; isolate controls.
4322 (+ pt (skip-chars-forward
4323 bidi-directional-non-controls-chars
4325 ;; Replace any run of non-RTL characters by a single LRM.
4326 (if (null (re-search-forward category lim1 t))
4327 ;; No more characters of CATEGORY, we are done.
4329 (replace-match replacement nil t)
4330 (move-marker pt (point)))
4332 ;; Skip directional controls, if any.
4334 pt (+ pt (skip-chars-forward bidi-directional-controls-chars limit))))))
4336 (defun squeeze-bidi-context (from to)
4337 "Replace characters between FROM and TO while keeping bidi context.
4339 This function replaces the region of text with as few characters
4340 as possible, while preserving the effect that region will have on
4341 bidirectional display before and after the region."
4342 (let ((start (set-marker (make-marker)
4343 (if (> from 0) from (+ (point-max) from))))
4344 (end (set-marker (make-marker) to))
4345 ;; This is for when they copy text with read-only text
4347 (inhibit-read-only t))
4348 (if (null (marker-position end))
4349 (setq end (point-max-marker)))
4350 ;; Replace each run of non-RTL characters with a single LRM.
4351 (squeeze-bidi-context-1 start end "\\CR+" "\x200e")
4352 ;; Replace each run of non-LTR characters with a single RLM. Note
4353 ;; that the \cR category includes both the Arabic Letter (AL) and
4354 ;; R characters; here we ignore the distinction between them,
4355 ;; because that distinction only affects Arabic Number (AN)
4356 ;; characters, which are weak and don't affect the reordering.
4357 (squeeze-bidi-context-1 start end "\\CL+" "\x200f")))
4359 (defun line-substring-with-bidi-context (start end &optional no-properties)
4360 "Return buffer text between START and END with its bidi context.
4362 START and END are assumed to belong to the same physical line
4363 of buffer text. This function prepends and appends to the text
4364 between START and END bidi control characters that preserve the
4365 visual order of that text when it is inserted at some other place."
4366 (if (or (< start (point-min))
4367 (> end (point-max)))
4368 (signal 'args-out-of-range (list (current-buffer) start end)))
4369 (let ((buf (current-buffer))
4370 substr para-dir from to)
4373 (setq para-dir (current-bidi-paragraph-direction))
4374 (setq from (line-beginning-position)
4375 to (line-end-position))
4377 ;; If we don't have any mixed directional characters in the
4378 ;; entire line, we can just copy the substring without adding
4380 (if (or (looking-at-p "\\CR*$")
4381 (looking-at-p "\\CL*$"))
4382 (setq substr (if no-properties
4383 (buffer-substring-no-properties start end)
4384 (buffer-substring start end)))
4388 (insert-buffer-substring-no-properties buf from to)
4389 (insert-buffer-substring buf from to))
4390 (squeeze-bidi-context 1 (1+ (- start from)))
4391 (squeeze-bidi-context (- end to) nil)
4392 (buffer-substring 1 (point-max)))))
4394 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4395 ;; (1) force the string to have the same base embedding
4396 ;; direction as the paragraph direction at the source, no matter
4397 ;; what is the paragraph direction at destination; and (2) avoid
4398 ;; affecting the visual order of the surrounding text at
4399 ;; destination if there are characters of different
4400 ;; directionality there.
4401 (concat (if (eq para-dir 'left-to-right) "\x2066" "\x2067")
4404 (defun buffer-substring-with-bidi-context (start end &optional no-properties)
4405 "Return portion of current buffer between START and END with bidi context.
4407 This function works similar to `buffer-substring', but it prepends and
4408 appends to the text bidi directional control characters necessary to
4409 preserve the visual appearance of the text if it is inserted at another
4410 place. This is useful when the buffer substring includes bidirectional
4411 text and control characters that cause non-trivial reordering on display.
4412 If copied verbatim, such text can have a very different visual appearance,
4413 and can also change the visual appearance of the surrounding text at the
4414 destination of the copy.
4416 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4417 the text properties."
4418 (let (line-end substr)
4419 (if (or (< start (point-min))
4420 (> end (point-max)))
4421 (signal 'args-out-of-range (list (current-buffer) start end)))
4424 (setq line-end (min end (line-end-position)))
4425 (while (< start end)
4429 (line-substring-with-bidi-context start line-end
4432 (setq start (point))
4433 (setq line-end (min end (line-end-position))))
4438 (defcustom yank-handled-properties
4439 '((font-lock-face . yank-handle-font-lock-face-property)
4440 (category . yank-handle-category-property))
4441 "List of special text property handling conditions for yanking.
4442 Each element should have the form (PROP . FUN), where PROP is a
4443 property symbol and FUN is a function. When the `yank' command
4444 inserts text into the buffer, it scans the inserted text for
4445 stretches of text that have `eq' values of the text property
4446 PROP; for each such stretch of text, FUN is called with three
4447 arguments: the property's value in that text, and the start and
4448 end positions of the text.
4450 This is done prior to removing the properties specified by
4451 `yank-excluded-properties'."
4453 :type '(repeat (cons (symbol :tag "property symbol")
4457 ;; This is actually used in subr.el but defcustom does not work there.
4458 (defcustom yank-excluded-properties
4459 '(category field follow-link fontified font-lock-face help-echo
4460 intangible invisible keymap local-map mouse-face read-only
4462 "Text properties to discard when yanking.
4463 The value should be a list of text properties to discard or t,
4464 which means to discard all text properties.
4466 See also `yank-handled-properties'."
4467 :type '(choice (const :tag "All" t) (repeat symbol))
4471 (defvar yank-window-start nil)
4472 (defvar yank-undo-function nil
4473 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4474 Function is called with two parameters, START and END corresponding to
4475 the value of the mark and point; it is guaranteed that START <= END.
4476 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
4478 (defun yank-pop (&optional arg)
4479 "Replace just-yanked stretch of killed text with a different stretch.
4480 This command is allowed only immediately after a `yank' or a `yank-pop'.
4481 At such a time, the region contains a stretch of reinserted
4482 previously-killed text. `yank-pop' deletes that text and inserts in its
4483 place a different stretch of killed text.
4485 With no argument, the previous kill is inserted.
4486 With argument N, insert the Nth previous kill.
4487 If N is negative, this is a more recent kill.
4489 The sequence of kills wraps around, so that after the oldest one
4490 comes the newest one.
4492 When this command inserts killed text into the buffer, it honors
4493 `yank-excluded-properties' and `yank-handler' as described in the
4494 doc string for `insert-for-yank-1', which see."
4496 (if (not (eq last-command 'yank))
4497 (user-error "Previous command was not a yank"))
4498 (setq this-command 'yank)
4499 (unless arg (setq arg 1))
4500 (let ((inhibit-read-only t)
4501 (before (< (point) (mark t))))
4503 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
4504 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
4505 (setq yank-undo-function nil)
4506 (set-marker (mark-marker) (point) (current-buffer))
4507 (insert-for-yank (current-kill arg))
4508 ;; Set the window start back where it was in the yank command,
4510 (set-window-start (selected-window) yank-window-start t)
4512 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4513 ;; It is cleaner to avoid activation, even though the command
4514 ;; loop would deactivate the mark because we inserted text.
4515 (goto-char (prog1 (mark t)
4516 (set-marker (mark-marker) (point) (current-buffer))))))
4519 (defun yank (&optional arg)
4520 "Reinsert (\"paste\") the last stretch of killed text.
4521 More precisely, reinsert the most recent kill, which is the
4522 stretch of killed text most recently killed OR yanked. Put point
4523 at the end, and set mark at the beginning without activating it.
4524 With just \\[universal-argument] as argument, put point at beginning, and mark at end.
4525 With argument N, reinsert the Nth most recent kill.
4527 When this command inserts text into the buffer, it honors the
4528 `yank-handled-properties' and `yank-excluded-properties'
4529 variables, and the `yank-handler' text property. See
4530 `insert-for-yank-1' for details.
4532 See also the command `yank-pop' (\\[yank-pop])."
4534 (setq yank-window-start (window-start))
4535 ;; If we don't get all the way thru, make last-command indicate that
4536 ;; for the following command.
4537 (setq this-command t)
4539 (insert-for-yank (current-kill (cond
4544 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4545 ;; It is cleaner to avoid activation, even though the command
4546 ;; loop would deactivate the mark because we inserted text.
4547 (goto-char (prog1 (mark t)
4548 (set-marker (mark-marker) (point) (current-buffer)))))
4549 ;; If we do get all the way thru, make this-command indicate that.
4550 (if (eq this-command t)
4551 (setq this-command 'yank))
4554 (defun rotate-yank-pointer (arg)
4555 "Rotate the yanking point in the kill ring.
4556 With ARG, rotate that many kills forward (or backward, if negative)."
4560 ;; Some kill commands.
4562 ;; Internal subroutine of delete-char
4563 (defun kill-forward-chars (arg)
4564 (if (listp arg) (setq arg (car arg)))
4565 (if (eq arg '-) (setq arg -1))
4566 (kill-region (point) (+ (point) arg)))
4568 ;; Internal subroutine of backward-delete-char
4569 (defun kill-backward-chars (arg)
4570 (if (listp arg) (setq arg (car arg)))
4571 (if (eq arg '-) (setq arg -1))
4572 (kill-region (point) (- (point) arg)))
4574 (defcustom backward-delete-char-untabify-method 'untabify
4575 "The method for untabifying when deleting backward.
4576 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4577 `hungry' -- delete all whitespace, both tabs and spaces;
4578 `all' -- delete all whitespace, including tabs, spaces and newlines;
4579 nil -- just delete one character."
4580 :type '(choice (const untabify) (const hungry) (const all) (const nil))
4584 (defun backward-delete-char-untabify (arg &optional killp)
4585 "Delete characters backward, changing tabs into spaces.
4586 The exact behavior depends on `backward-delete-char-untabify-method'.
4587 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4588 Interactively, ARG is the prefix arg (default 1)
4589 and KILLP is t if a prefix arg was specified."
4590 (interactive "*p\nP")
4591 (when (eq backward-delete-char-untabify-method 'untabify)
4594 (while (and (> count 0) (not (bobp)))
4595 (if (= (preceding-char) ?\t)
4596 (let ((col (current-column)))
4598 (setq col (- col (current-column)))
4599 (insert-char ?\s col)
4602 (setq count (1- count))))))
4603 (let* ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
4604 ((eq backward-delete-char-untabify-method 'all)
4607 (let* ((oldpt (point))
4608 (wh (- oldpt (save-excursion
4609 (skip-chars-backward skip)
4610 (constrain-to-field nil oldpt)))))
4611 (+ arg (if (zerop wh) 0 (1- wh))))
4613 ;; Avoid warning about delete-backward-char
4614 (with-no-warnings (delete-backward-char n killp))))
4616 (defun zap-to-char (arg char)
4617 "Kill up to and including ARGth occurrence of CHAR.
4618 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4619 Goes backward if ARG is negative; error if CHAR not found."
4620 (interactive (list (prefix-numeric-value current-prefix-arg)
4621 (read-char "Zap to char: " t)))
4622 ;; Avoid "obsolete" warnings for translation-table-for-input.
4624 (if (char-table-p translation-table-for-input)
4625 (setq char (or (aref translation-table-for-input char) char))))
4626 (kill-region (point) (progn
4627 (search-forward (char-to-string char) nil nil arg)
4630 ;; kill-line and its subroutines.
4632 (defcustom kill-whole-line nil
4633 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4637 (defun kill-line (&optional arg)
4638 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4639 With prefix argument ARG, kill that many lines from point.
4640 Negative arguments kill lines backward.
4641 With zero argument, kills the text before point on the current line.
4643 When calling from a program, nil means \"no arg\",
4644 a number counts as a prefix arg.
4646 To kill a whole line, when point is not at the beginning, type \
4647 \\[move-beginning-of-line] \\[kill-line] \\[kill-line].
4649 If `show-trailing-whitespace' is non-nil, this command will just
4650 kill the rest of the current line, even if there are only
4653 If option `kill-whole-line' is non-nil, then this command kills the whole line
4654 including its terminating newline, when used at the beginning of a line
4655 with no argument. As a consequence, you can always kill a whole line
4656 by typing \\[move-beginning-of-line] \\[kill-line].
4658 If you want to append the killed line to the last killed text,
4659 use \\[append-next-kill] before \\[kill-line].
4661 If the buffer is read-only, Emacs will beep and refrain from deleting
4662 the line, but put the line in the kill ring anyway. This means that
4663 you can use this command to copy text from a read-only buffer.
4664 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4667 (kill-region (point)
4668 ;; It is better to move point to the other end of the kill
4669 ;; before killing. That way, in a read-only buffer, point
4670 ;; moves across the text that is copied to the kill ring.
4671 ;; The choice has no effect on undo now that undo records
4672 ;; the value of point from before the command was run.
4675 (forward-visible-line (prefix-numeric-value arg))
4677 (signal 'end-of-buffer nil))
4680 (end-of-visible-line) (point))))
4681 (if (or (save-excursion
4682 ;; If trailing whitespace is visible,
4683 ;; don't treat it as nothing.
4684 (unless show-trailing-whitespace
4685 (skip-chars-forward " \t" end))
4687 (and kill-whole-line (bolp)))
4688 (forward-visible-line 1)
4692 (defun kill-whole-line (&optional arg)
4694 With prefix ARG, kill that many lines starting from the current line.
4695 If ARG is negative, kill backward. Also kill the preceding newline.
4696 \(This is meant to make \\[repeat] work well with negative arguments.)
4697 If ARG is zero, kill current line but exclude the trailing newline."
4699 (or arg (setq arg 1))
4700 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
4701 (signal 'end-of-buffer nil))
4702 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
4703 (signal 'beginning-of-buffer nil))
4704 (unless (eq last-command 'kill-region)
4706 (setq last-command 'kill-region))
4708 ;; We need to kill in two steps, because the previous command
4709 ;; could have been a kill command, in which case the text
4710 ;; before point needs to be prepended to the current kill
4711 ;; ring entry and the text after point appended. Also, we
4712 ;; need to use save-excursion to avoid copying the same text
4713 ;; twice to the kill ring in read-only buffers.
4715 (kill-region (point) (progn (forward-visible-line 0) (point))))
4716 (kill-region (point) (progn (end-of-visible-line) (point))))
4719 (kill-region (point) (progn (end-of-visible-line) (point))))
4720 (kill-region (point)
4721 (progn (forward-visible-line (1+ arg))
4722 (unless (bobp) (backward-char))
4726 (kill-region (point) (progn (forward-visible-line 0) (point))))
4727 (kill-region (point)
4728 (progn (forward-visible-line arg) (point))))))
4730 (defun forward-visible-line (arg)
4731 "Move forward by ARG lines, ignoring currently invisible newlines only.
4732 If ARG is negative, move backward -ARG lines.
4733 If ARG is zero, move to the beginning of the current line."
4738 (or (zerop (forward-line 1))
4739 (signal 'end-of-buffer nil))
4740 ;; If the newline we just skipped is invisible,
4743 (get-char-property (1- (point)) 'invisible)))
4744 (if (if (eq buffer-invisibility-spec t)
4746 (or (memq prop buffer-invisibility-spec)
4747 (assq prop buffer-invisibility-spec)))
4748 (setq arg (1+ arg))))
4749 (setq arg (1- arg)))
4750 ;; If invisible text follows, and it is a number of complete lines,
4752 (let ((opoint (point)))
4753 (while (and (not (eobp))
4755 (get-char-property (point) 'invisible)))
4756 (if (eq buffer-invisibility-spec t)
4758 (or (memq prop buffer-invisibility-spec)
4759 (assq prop buffer-invisibility-spec)))))
4761 (if (get-text-property (point) 'invisible)
4762 (or (next-single-property-change (point) 'invisible)
4764 (next-overlay-change (point)))))
4766 (goto-char opoint))))
4768 (while (or first (<= arg 0))
4771 (or (zerop (forward-line -1))
4772 (signal 'beginning-of-buffer nil)))
4773 ;; If the newline we just moved to is invisible,
4777 (get-char-property (1- (point)) 'invisible)))
4778 (unless (if (eq buffer-invisibility-spec t)
4780 (or (memq prop buffer-invisibility-spec)
4781 (assq prop buffer-invisibility-spec)))
4782 (setq arg (1+ arg)))))
4784 ;; If invisible text follows, and it is a number of complete lines,
4786 (let ((opoint (point)))
4787 (while (and (not (bobp))
4789 (get-char-property (1- (point)) 'invisible)))
4790 (if (eq buffer-invisibility-spec t)
4792 (or (memq prop buffer-invisibility-spec)
4793 (assq prop buffer-invisibility-spec)))))
4795 (if (get-text-property (1- (point)) 'invisible)
4796 (or (previous-single-property-change (point) 'invisible)
4798 (previous-overlay-change (point)))))
4800 (goto-char opoint)))))
4801 ((beginning-of-buffer end-of-buffer)
4804 (defun end-of-visible-line ()
4805 "Move to end of current visible line."
4807 ;; If the following character is currently invisible,
4808 ;; skip all characters with that same `invisible' property value,
4809 ;; then find the next newline.
4810 (while (and (not (eobp))
4812 (skip-chars-forward "^\n")
4814 (get-char-property (point) 'invisible)))
4815 (if (eq buffer-invisibility-spec t)
4817 (or (memq prop buffer-invisibility-spec)
4818 (assq prop buffer-invisibility-spec))))))
4819 (skip-chars-forward "^\n")
4820 (if (get-text-property (point) 'invisible)
4821 (goto-char (or (next-single-property-change (point) 'invisible)
4823 (goto-char (next-overlay-change (point))))
4826 (defun insert-buffer (buffer)
4827 "Insert after point the contents of BUFFER.
4828 Puts mark after the inserted text.
4829 BUFFER may be a buffer or a buffer name."
4830 (declare (interactive-only insert-buffer-substring))
4834 (barf-if-buffer-read-only)
4835 (read-buffer "Insert buffer: "
4836 (if (eq (selected-window) (next-window))
4837 (other-buffer (current-buffer))
4838 (window-buffer (next-window)))
4842 (insert-buffer-substring (get-buffer buffer))
4846 (defun append-to-buffer (buffer start end)
4847 "Append to specified buffer the text of the region.
4848 It is inserted into that buffer before its point.
4850 When calling from a program, give three arguments:
4851 BUFFER (or buffer name), START and END.
4852 START and END specify the portion of the current buffer to be copied."
4854 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
4855 (region-beginning) (region-end)))
4856 (let* ((oldbuf (current-buffer))
4857 (append-to (get-buffer-create buffer))
4858 (windows (get-buffer-window-list append-to t t))
4861 (with-current-buffer append-to
4862 (setq point (point))
4863 (barf-if-buffer-read-only)
4864 (insert-buffer-substring oldbuf start end)
4865 (dolist (window windows)
4866 (when (= (window-point window) point)
4867 (set-window-point window (point))))))))
4869 (defun prepend-to-buffer (buffer start end)
4870 "Prepend to specified buffer the text of the region.
4871 It is inserted into that buffer after its point.
4873 When calling from a program, give three arguments:
4874 BUFFER (or buffer name), START and END.
4875 START and END specify the portion of the current buffer to be copied."
4876 (interactive "BPrepend to buffer: \nr")
4877 (let ((oldbuf (current-buffer)))
4878 (with-current-buffer (get-buffer-create buffer)
4879 (barf-if-buffer-read-only)
4881 (insert-buffer-substring oldbuf start end)))))
4883 (defun copy-to-buffer (buffer start end)
4884 "Copy to specified buffer the text of the region.
4885 It is inserted into that buffer, replacing existing text there.
4887 When calling from a program, give three arguments:
4888 BUFFER (or buffer name), START and END.
4889 START and END specify the portion of the current buffer to be copied."
4890 (interactive "BCopy to buffer: \nr")
4891 (let ((oldbuf (current-buffer)))
4892 (with-current-buffer (get-buffer-create buffer)
4893 (barf-if-buffer-read-only)
4896 (insert-buffer-substring oldbuf start end)))))
4898 (define-error 'mark-inactive (purecopy "The mark is not active now"))
4900 (defvar activate-mark-hook nil
4901 "Hook run when the mark becomes active.
4902 It is also run at the end of a command, if the mark is active and
4903 it is possible that the region may have changed.")
4905 (defvar deactivate-mark-hook nil
4906 "Hook run when the mark becomes inactive.")
4908 (defun mark (&optional force)
4909 "Return this buffer's mark value as integer, or nil if never set.
4911 In Transient Mark mode, this function signals an error if
4912 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4913 or the argument FORCE is non-nil, it disregards whether the mark
4914 is active, and returns an integer or nil in the usual way.
4916 If you are using this in an editing command, you are most likely making
4917 a mistake; see the documentation of `set-mark'."
4918 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
4919 (marker-position (mark-marker))
4920 (signal 'mark-inactive nil)))
4922 ;; Behind display-selections-p.
4924 (defun deactivate-mark (&optional force)
4925 "Deactivate the mark.
4926 If Transient Mark mode is disabled, this function normally does
4927 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4929 Deactivating the mark sets `mark-active' to nil, updates the
4930 primary selection according to `select-active-regions', and runs
4931 `deactivate-mark-hook'.
4933 If Transient Mark mode was temporarily enabled, reset the value
4934 of the variable `transient-mark-mode'; if this causes Transient
4935 Mark mode to be disabled, don't change `mark-active' to nil or
4936 run `deactivate-mark-hook'."
4937 (when (or (region-active-p) force)
4938 (when (and (if (eq select-active-regions 'only)
4939 (eq (car-safe transient-mark-mode) 'only)
4940 select-active-regions)
4942 (display-selections-p))
4943 ;; The var `saved-region-selection', if non-nil, is the text in
4944 ;; the region prior to the last command modifying the buffer.
4945 ;; Set the selection to that, or to the current region.
4946 (cond (saved-region-selection
4947 (if (gui-backend-selection-owner-p 'PRIMARY)
4948 (gui-set-selection 'PRIMARY saved-region-selection))
4949 (setq saved-region-selection nil))
4950 ;; If another program has acquired the selection, region
4951 ;; deactivation should not clobber it (Bug#11772).
4952 ((and (/= (region-beginning) (region-end))
4953 (or (gui-backend-selection-owner-p 'PRIMARY)
4954 (null (gui-backend-selection-exists-p 'PRIMARY))))
4955 (gui-set-selection 'PRIMARY
4956 (funcall region-extract-function nil)))))
4957 (when mark-active (force-mode-line-update)) ;Refresh toolbar (bug#16382).
4959 ((eq (car-safe transient-mark-mode) 'only)
4960 (setq transient-mark-mode (cdr transient-mark-mode))
4961 (if (eq transient-mark-mode (default-value 'transient-mark-mode))
4962 (kill-local-variable 'transient-mark-mode)))
4963 ((eq transient-mark-mode 'lambda)
4964 (kill-local-variable 'transient-mark-mode)))
4965 (setq mark-active nil)
4966 (run-hooks 'deactivate-mark-hook)
4967 (redisplay--update-region-highlight (selected-window))))
4969 (defun activate-mark (&optional no-tmm)
4971 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4973 (unless (region-active-p)
4974 (force-mode-line-update) ;Refresh toolbar (bug#16382).
4975 (setq mark-active t)
4976 (unless (or transient-mark-mode no-tmm)
4977 (setq-local transient-mark-mode 'lambda))
4978 (run-hooks 'activate-mark-hook))))
4980 (defun set-mark (pos)
4981 "Set this buffer's mark to POS. Don't use this function!
4982 That is to say, don't use this function unless you want
4983 the user to see that the mark has moved, and you want the previous
4984 mark position to be lost.
4986 Normally, when a new mark is set, the old one should go on the stack.
4987 This is why most applications should use `push-mark', not `set-mark'.
4989 Novice Emacs Lisp programmers often try to use the mark for the wrong
4990 purposes. The mark saves a location for the user's convenience.
4991 Most editing commands should not alter the mark.
4992 To remember a location for internal use in the Lisp program,
4993 store it in a Lisp variable. Example:
4995 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4998 (set-marker (mark-marker) pos (current-buffer))
4999 (activate-mark 'no-tmm))
5000 ;; Normally we never clear mark-active except in Transient Mark mode.
5001 ;; But when we actually clear out the mark value too, we must
5002 ;; clear mark-active in any mode.
5004 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5005 ;; it should never be nil if the mark is nil.
5006 (setq mark-active nil)
5007 (set-marker (mark-marker) nil)))
5009 (defun save-mark-and-excursion--save ()
5011 (let ((mark (mark-marker)))
5012 (and (marker-position mark) (copy-marker mark)))
5015 (defun save-mark-and-excursion--restore (saved-mark-info)
5016 (let ((saved-mark (car saved-mark-info))
5017 (omark (marker-position (mark-marker)))
5019 (saved-mark-active (cdr saved-mark-info)))
5021 (if (null saved-mark)
5022 (set-marker (mark-marker) nil)
5023 (setf nmark (marker-position saved-mark))
5024 (set-marker (mark-marker) nmark)
5025 (set-marker saved-mark nil))
5027 (let ((cur-mark-active mark-active))
5028 (setq mark-active saved-mark-active)
5029 ;; If mark is active now, and either was not active or was at a
5030 ;; different place, run the activate hook.
5031 (if saved-mark-active
5032 (when (or (not cur-mark-active)
5033 (not (eq omark nmark)))
5034 (run-hooks 'activate-mark-hook))
5035 ;; If mark has ceased to be active, run deactivate hook.
5036 (when cur-mark-active
5037 (run-hooks 'deactivate-mark-hook))))))
5039 (defmacro save-mark-and-excursion (&rest body)
5040 "Like `save-excursion', but also save and restore the mark state.
5041 This macro does what `save-excursion' did before Emacs 25.1."
5042 (let ((saved-marker-sym (make-symbol "saved-marker")))
5043 `(let ((,saved-marker-sym (save-mark-and-excursion--save)))
5045 (save-excursion ,@body)
5046 (save-mark-and-excursion--restore ,saved-marker-sym)))))
5048 (defcustom use-empty-active-region nil
5049 "Whether \"region-aware\" commands should act on empty regions.
5050 If nil, region-aware commands treat empty regions as inactive.
5051 If non-nil, region-aware commands treat the region as active as
5052 long as the mark is active, even if the region is empty.
5054 Region-aware commands are those that act on the region if it is
5055 active and Transient Mark mode is enabled, and on the text near
5059 :group 'editing-basics)
5061 (defun use-region-p ()
5062 "Return t if the region is active and it is appropriate to act on it.
5063 This is used by commands that act specially on the region under
5064 Transient Mark mode.
5066 The return value is t if Transient Mark mode is enabled and the
5067 mark is active; furthermore, if `use-empty-active-region' is nil,
5068 the region must not be empty. Otherwise, the return value is nil.
5070 For some commands, it may be appropriate to ignore the value of
5071 `use-empty-active-region'; in that case, use `region-active-p'."
5072 (and (region-active-p)
5073 (or use-empty-active-region (> (region-end) (region-beginning)))))
5075 (defun region-active-p ()
5076 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5078 Some commands act specially on the region when Transient Mark
5079 mode is enabled. Usually, such commands should use
5080 `use-region-p' instead of this function, because `use-region-p'
5081 also checks the value of `use-empty-active-region'."
5082 (and transient-mark-mode mark-active
5083 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5084 ;; without the mark being set (e.g. bug#17324). We really should fix
5085 ;; that problem, but in the mean time, let's make sure we don't say the
5086 ;; region is active when there's no mark.
5087 (progn (cl-assert (mark)) t)))
5090 (defvar redisplay-unhighlight-region-function
5091 (lambda (rol) (when (overlayp rol) (delete-overlay rol))))
5093 (defvar redisplay-highlight-region-function
5094 (lambda (start end window rol)
5095 (if (not (overlayp rol))
5096 (let ((nrol (make-overlay start end)))
5097 (funcall redisplay-unhighlight-region-function rol)
5098 (overlay-put nrol 'window window)
5099 (overlay-put nrol 'face 'region)
5100 ;; Normal priority so that a large region doesn't hide all the
5101 ;; overlays within it, but high secondary priority so that if it
5102 ;; ends/starts in the middle of a small overlay, that small overlay
5103 ;; won't hide the region's boundaries.
5104 (overlay-put nrol 'priority '(nil . 100))
5106 (unless (and (eq (overlay-buffer rol) (current-buffer))
5107 (eq (overlay-start rol) start)
5108 (eq (overlay-end rol) end))
5109 (move-overlay rol start end (current-buffer)))
5112 (defun redisplay--update-region-highlight (window)
5113 (let ((rol (window-parameter window 'internal-region-overlay)))
5114 (if (not (and (region-active-p)
5115 (or highlight-nonselected-windows
5116 (eq window (selected-window))
5117 (and (window-minibuffer-p)
5118 (eq window (minibuffer-selected-window))))))
5119 (funcall redisplay-unhighlight-region-function rol)
5120 (let* ((pt (window-point window))
5122 (start (min pt mark))
5125 (funcall redisplay-highlight-region-function
5126 start end window rol)))
5127 (unless (equal new rol)
5128 (set-window-parameter window 'internal-region-overlay
5131 (defvar pre-redisplay-functions (list #'redisplay--update-region-highlight)
5132 "Hook run just before redisplay.
5133 It is called in each window that is to be redisplayed. It takes one argument,
5134 which is the window that will be redisplayed. When run, the `current-buffer'
5135 is set to the buffer displayed in that window.")
5137 (defun redisplay--pre-redisplay-functions (windows)
5138 (with-demoted-errors "redisplay--pre-redisplay-functions: %S"
5140 (with-current-buffer (window-buffer (selected-window))
5141 (run-hook-with-args 'pre-redisplay-functions (selected-window)))
5142 (dolist (win (if (listp windows) windows (window-list-1 nil nil t)))
5143 (with-current-buffer (window-buffer win)
5144 (run-hook-with-args 'pre-redisplay-functions win))))))
5146 (add-function :before pre-redisplay-function
5147 #'redisplay--pre-redisplay-functions)
5150 (defvar-local mark-ring nil
5151 "The list of former marks of the current buffer, most recent first.")
5152 (put 'mark-ring 'permanent-local t)
5154 (defcustom mark-ring-max 16
5155 "Maximum size of mark ring. Start discarding off end if gets this big."
5157 :group 'editing-basics)
5159 (defvar global-mark-ring nil
5160 "The list of saved global marks, most recent first.")
5162 (defcustom global-mark-ring-max 16
5163 "Maximum size of global mark ring. \
5164 Start discarding off end if gets this big."
5166 :group 'editing-basics)
5168 (defun pop-to-mark-command ()
5169 "Jump to mark, and pop a new position for mark off the ring.
5170 \(Does not affect global mark ring)."
5173 (user-error "No mark set in this buffer")
5174 (if (= (point) (mark t))
5175 (message "Mark popped"))
5176 (goto-char (mark t))
5179 (defun push-mark-command (arg &optional nomsg)
5180 "Set mark at where point is.
5181 If no prefix ARG and mark is already set there, just activate it.
5182 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5184 (let ((mark (mark t)))
5185 (if (or arg (null mark) (/= mark (point)))
5186 (push-mark nil nomsg t)
5187 (activate-mark 'no-tmm)
5189 (message "Mark activated")))))
5191 (defcustom set-mark-command-repeat-pop nil
5192 "Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
5193 That means that C-u \\[set-mark-command] \\[set-mark-command]
5194 will pop the mark twice, and
5195 C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
5196 will pop the mark three times.
5198 A value of nil means \\[set-mark-command]'s behavior does not change
5199 after C-u \\[set-mark-command]."
5201 :group 'editing-basics)
5203 (defun set-mark-command (arg)
5204 "Set the mark where point is, or jump to the mark.
5205 Setting the mark also alters the region, which is the text
5206 between point and mark; this is the closest equivalent in
5207 Emacs to what some editors call the \"selection\".
5209 With no prefix argument, set the mark at point, and push the
5210 old mark position on local mark ring. Also push the old mark on
5211 global mark ring, if the previous mark was set in another buffer.
5213 When Transient Mark Mode is off, immediately repeating this
5214 command activates `transient-mark-mode' temporarily.
5216 With prefix argument (e.g., \\[universal-argument] \\[set-mark-command]), \
5217 jump to the mark, and set the mark from
5218 position popped off the local mark ring (this does not affect the global
5219 mark ring). Use \\[pop-global-mark] to jump to a mark popped off the global
5220 mark ring (see `pop-global-mark').
5222 If `set-mark-command-repeat-pop' is non-nil, repeating
5223 the \\[set-mark-command] command with no prefix argument pops the next position
5224 off the local (or global) mark ring and jumps there.
5226 With \\[universal-argument] \\[universal-argument] as prefix
5227 argument, unconditionally set mark where point is, even if
5228 `set-mark-command-repeat-pop' is non-nil.
5230 Novice Emacs Lisp programmers often try to use the mark for the wrong
5231 purposes. See the documentation of `set-mark' for more information."
5233 (cond ((eq transient-mark-mode 'lambda)
5234 (kill-local-variable 'transient-mark-mode))
5235 ((eq (car-safe transient-mark-mode) 'only)
5238 ((and (consp arg) (> (prefix-numeric-value arg) 4))
5239 (push-mark-command nil))
5240 ((not (eq this-command 'set-mark-command))
5242 (pop-to-mark-command)
5243 (push-mark-command t)))
5244 ((and set-mark-command-repeat-pop
5245 (eq last-command 'pop-global-mark)
5247 (setq this-command 'pop-global-mark)
5249 ((or (and set-mark-command-repeat-pop
5250 (eq last-command 'pop-to-mark-command))
5252 (setq this-command 'pop-to-mark-command)
5253 (pop-to-mark-command))
5254 ((eq last-command 'set-mark-command)
5255 (if (region-active-p)
5258 (message "Mark deactivated"))
5260 (message "Mark activated")))
5262 (push-mark-command nil))))
5264 (defun push-mark (&optional location nomsg activate)
5265 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5266 If the last global mark pushed was not in the current buffer,
5267 also push LOCATION on the global mark ring.
5268 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5270 Novice Emacs Lisp programmers often try to use the mark for the wrong
5271 purposes. See the documentation of `set-mark' for more information.
5273 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5274 (unless (null (mark t))
5275 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
5276 (when (> (length mark-ring) mark-ring-max)
5277 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
5278 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
5279 (set-marker (mark-marker) (or location (point)) (current-buffer))
5280 ;; Now push the mark on the global mark ring.
5281 (if (and global-mark-ring
5282 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
5283 ;; The last global mark pushed was in this same buffer.
5284 ;; Don't push another one.
5286 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
5287 (when (> (length global-mark-ring) global-mark-ring-max)
5288 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
5289 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
5290 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
5291 (message "Mark set"))
5292 (if (or activate (not transient-mark-mode))
5293 (set-mark (mark t)))
5297 "Pop off mark ring into the buffer's actual mark.
5298 Does not set point. Does nothing if mark ring is empty."
5300 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
5301 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
5302 (move-marker (car mark-ring) nil)
5303 (if (null (mark t)) (ding))
5304 (setq mark-ring (cdr mark-ring)))
5307 (define-obsolete-function-alias
5308 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
5309 (defun exchange-point-and-mark (&optional arg)
5310 "Put the mark where point is now, and point where the mark is now.
5311 This command works even when the mark is not active,
5312 and it reactivates the mark.
5314 If Transient Mark mode is on, a prefix ARG deactivates the mark
5315 if it is active, and otherwise avoids reactivating it. If
5316 Transient Mark mode is off, a prefix ARG enables Transient Mark
5319 (let ((omark (mark t))
5320 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
5322 (user-error "No mark set in this buffer"))
5325 (cond (temp-highlight
5326 (setq-local transient-mark-mode (cons 'only transient-mark-mode)))
5327 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
5328 (not (or arg (region-active-p))))
5330 (t (activate-mark)))
5333 (defcustom shift-select-mode t
5334 "When non-nil, shifted motion keys activate the mark momentarily.
5336 While the mark is activated in this way, any shift-translated point
5337 motion key extends the region, and if Transient Mark mode was off, it
5338 is temporarily turned on. Furthermore, the mark will be deactivated
5339 by any subsequent point motion key that was not shift-translated, or
5340 by any action that normally deactivates the mark in Transient Mark mode.
5342 See `this-command-keys-shift-translated' for the meaning of
5345 :group 'editing-basics)
5347 (defun handle-shift-selection ()
5348 "Activate/deactivate mark depending on invocation thru shift translation.
5349 This function is called by `call-interactively' when a command
5350 with a `^' character in its `interactive' spec is invoked, before
5351 running the command itself.
5353 If `shift-select-mode' is enabled and the command was invoked
5354 through shift translation, set the mark and activate the region
5355 temporarily, unless it was already set in this way. See
5356 `this-command-keys-shift-translated' for the meaning of shift
5359 Otherwise, if the region has been activated temporarily,
5360 deactivate it, and restore the variable `transient-mark-mode' to
5362 (cond ((and shift-select-mode this-command-keys-shift-translated)
5363 (unless (and mark-active
5364 (eq (car-safe transient-mark-mode) 'only))
5365 (setq-local transient-mark-mode
5367 (unless (eq transient-mark-mode 'lambda)
5368 transient-mark-mode)))
5369 (push-mark nil nil t)))
5370 ((eq (car-safe transient-mark-mode) 'only)
5371 (setq transient-mark-mode (cdr transient-mark-mode))
5372 (if (eq transient-mark-mode (default-value 'transient-mark-mode))
5373 (kill-local-variable 'transient-mark-mode))
5374 (deactivate-mark))))
5376 (define-minor-mode transient-mark-mode
5377 "Toggle Transient Mark mode.
5378 With a prefix argument ARG, enable Transient Mark mode if ARG is
5379 positive, and disable it otherwise. If called from Lisp, enable
5380 Transient Mark mode if ARG is omitted or nil.
5382 Transient Mark mode is a global minor mode. When enabled, the
5383 region is highlighted with the `region' face whenever the mark
5384 is active. The mark is \"deactivated\" by changing the buffer,
5385 and after certain other operations that set the mark but whose
5386 main purpose is something else--for example, incremental search,
5387 \\[beginning-of-buffer], and \\[end-of-buffer].
5389 You can also deactivate the mark by typing \\[keyboard-quit] or
5390 \\[keyboard-escape-quit].
5392 Many commands change their behavior when Transient Mark mode is
5393 in effect and the mark is active, by acting on the region instead
5394 of their usual default part of the buffer's text. Examples of
5395 such commands include \\[comment-dwim], \\[flush-lines], \\[keep-lines],
5396 \\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
5397 To see the documentation of commands which are sensitive to the
5398 Transient Mark mode, invoke \\[apropos-documentation] and type \"transient\"
5399 or \"mark.*active\" at the prompt."
5401 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5402 :variable (default-value 'transient-mark-mode))
5404 (defvar widen-automatically t
5405 "Non-nil means it is ok for commands to call `widen' when they want to.
5406 Some commands will do this in order to go to positions outside
5407 the current accessible part of the buffer.
5409 If `widen-automatically' is nil, these commands will do something else
5410 as a fallback, and won't change the buffer bounds.")
5412 (defvar non-essential nil
5413 "Whether the currently executing code is performing an essential task.
5414 This variable should be non-nil only when running code which should not
5415 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5416 user for a password when we are simply scanning a set of files in the
5417 background or displaying possible completions before the user even asked
5420 (defun pop-global-mark ()
5421 "Pop off global mark ring and jump to the top location."
5423 ;; Pop entries which refer to non-existent buffers.
5424 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
5425 (setq global-mark-ring (cdr global-mark-ring)))
5426 (or global-mark-ring
5427 (error "No global mark set"))
5428 (let* ((marker (car global-mark-ring))
5429 (buffer (marker-buffer marker))
5430 (position (marker-position marker)))
5431 (setq global-mark-ring (nconc (cdr global-mark-ring)
5432 (list (car global-mark-ring))))
5434 (or (and (>= position (point-min))
5435 (<= position (point-max)))
5436 (if widen-automatically
5438 (error "Global mark position is outside accessible part of buffer")))
5439 (goto-char position)
5440 (switch-to-buffer buffer)))
5442 (defcustom next-line-add-newlines nil
5443 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5446 :group 'editing-basics)
5448 (defun next-line (&optional arg try-vscroll)
5449 "Move cursor vertically down ARG lines.
5450 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5451 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5452 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5453 function will not vscroll.
5457 If there is no character in the target line exactly under the current column,
5458 the cursor is positioned after the character in that line which spans this
5459 column, or at the end of the line if it is not long enough.
5460 If there is no line in the buffer after this one, behavior depends on the
5461 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5462 to create a line, and moves the cursor to that line. Otherwise it moves the
5463 cursor to the end of the buffer.
5465 If the variable `line-move-visual' is non-nil, this command moves
5466 by display lines. Otherwise, it moves by buffer lines, without
5467 taking variable-width characters or continued lines into account.
5469 The command \\[set-goal-column] can be used to create
5470 a semipermanent goal column for this command.
5471 Then instead of trying to move exactly vertically (or as close as possible),
5472 this command moves to the specified goal column (or as close as possible).
5473 The goal column is stored in the variable `goal-column', which is nil
5474 when there is no goal column. Note that setting `goal-column'
5475 overrides `line-move-visual' and causes this command to move by buffer
5476 lines rather than by display lines."
5477 (declare (interactive-only forward-line))
5478 (interactive "^p\np")
5479 (or arg (setq arg 1))
5480 (if (and next-line-add-newlines (= arg 1))
5481 (if (save-excursion (end-of-line) (eobp))
5482 ;; When adding a newline, don't expand an abbrev.
5483 (let ((abbrev-mode nil))
5485 (insert (if use-hard-newlines hard-newline "\n")))
5486 (line-move arg nil nil try-vscroll))
5487 (if (called-interactively-p 'interactive)
5489 (line-move arg nil nil try-vscroll)
5490 ((beginning-of-buffer end-of-buffer)
5491 (signal (car err) (cdr err))))
5492 (line-move arg nil nil try-vscroll)))
5495 (defun previous-line (&optional arg try-vscroll)
5496 "Move cursor vertically up ARG lines.
5497 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5498 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5499 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5500 function will not vscroll.
5504 If there is no character in the target line exactly over the current column,
5505 the cursor is positioned after the character in that line which spans this
5506 column, or at the end of the line if it is not long enough.
5508 If the variable `line-move-visual' is non-nil, this command moves
5509 by display lines. Otherwise, it moves by buffer lines, without
5510 taking variable-width characters or continued lines into account.
5512 The command \\[set-goal-column] can be used to create
5513 a semipermanent goal column for this command.
5514 Then instead of trying to move exactly vertically (or as close as possible),
5515 this command moves to the specified goal column (or as close as possible).
5516 The goal column is stored in the variable `goal-column', which is nil
5517 when there is no goal column. Note that setting `goal-column'
5518 overrides `line-move-visual' and causes this command to move by buffer
5519 lines rather than by display lines."
5520 (declare (interactive-only
5521 "use `forward-line' with negative argument instead."))
5522 (interactive "^p\np")
5523 (or arg (setq arg 1))
5524 (if (called-interactively-p 'interactive)
5526 (line-move (- arg) nil nil try-vscroll)
5527 ((beginning-of-buffer end-of-buffer)
5528 (signal (car err) (cdr err))))
5529 (line-move (- arg) nil nil try-vscroll))
5532 (defcustom track-eol nil
5533 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5534 This means moving to the end of each line moved onto.
5535 The beginning of a blank line does not count as the end of a line.
5536 This has no effect when the variable `line-move-visual' is non-nil."
5538 :group 'editing-basics)
5540 (defcustom goal-column nil
5541 "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.
5542 A non-nil setting overrides the variable `line-move-visual', which see."
5543 :type '(choice integer
5544 (const :tag "None" nil))
5545 :group 'editing-basics)
5546 (make-variable-buffer-local 'goal-column)
5548 (defvar temporary-goal-column 0
5549 "Current goal column for vertical motion.
5550 It is the column where point was at the start of the current run
5551 of vertical motion commands.
5553 When moving by visual lines via the function `line-move-visual', it is a cons
5554 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5555 divided by the default column width, and HSCROLL is the number of
5556 columns by which window is scrolled from left margin.
5558 When the `track-eol' feature is doing its job, the value is
5559 `most-positive-fixnum'.")
5561 (defcustom line-move-ignore-invisible t
5562 "Non-nil means commands that move by lines ignore invisible newlines.
5563 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5564 as if newlines that are invisible didn't exist, and count
5565 only visible newlines. Thus, moving across across 2 newlines
5566 one of which is invisible will be counted as a one-line move.
5567 Also, a non-nil value causes invisible text to be ignored when
5568 counting columns for the purposes of keeping point in the same
5569 column by \\[next-line] and \\[previous-line].
5571 Outline mode sets this."
5573 :group 'editing-basics)
5575 (defcustom line-move-visual t
5576 "When non-nil, `line-move' moves point by visual lines.
5577 This movement is based on where the cursor is displayed on the
5578 screen, instead of relying on buffer contents alone. It takes
5579 into account variable-width characters and line continuation.
5580 If nil, `line-move' moves point by logical lines.
5581 A non-nil setting of `goal-column' overrides the value of this variable
5582 and forces movement by logical lines.
5583 A window that is horizontally scrolled also forces movement by logical
5586 :group 'editing-basics
5589 ;; Only used if display-graphic-p.
5590 (declare-function font-info "font.c" (name &optional frame))
5592 (defun default-font-height ()
5593 "Return the height in pixels of the current buffer's default face font.
5595 If the default font is remapped (see `face-remapping-alist'), the
5596 function returns the height of the remapped face."
5597 (let ((default-font (face-font 'default)))
5599 ((and (display-multi-font-p)
5600 ;; Avoid calling font-info if the frame's default font was
5601 ;; not changed since the frame was created. That's because
5602 ;; font-info is expensive for some fonts, see bug #14838.
5603 (not (string= (frame-parameter nil 'font) default-font)))
5604 (aref (font-info default-font) 3))
5605 (t (frame-char-height)))))
5607 (defun default-font-width ()
5608 "Return the width in pixels of the current buffer's default face font.
5610 If the default font is remapped (see `face-remapping-alist'), the
5611 function returns the width of the remapped face."
5612 (let ((default-font (face-font 'default)))
5614 ((and (display-multi-font-p)
5615 ;; Avoid calling font-info if the frame's default font was
5616 ;; not changed since the frame was created. That's because
5617 ;; font-info is expensive for some fonts, see bug #14838.
5618 (not (string= (frame-parameter nil 'font) default-font)))
5619 (let* ((info (font-info (face-font 'default)))
5620 (width (aref info 11)))
5624 (t (frame-char-width)))))
5626 (defun default-line-height ()
5627 "Return the pixel height of current buffer's default-face text line.
5629 The value includes `line-spacing', if any, defined for the buffer
5631 (let ((dfh (default-font-height))
5632 (lsp (if (display-graphic-p)
5634 (default-value 'line-spacing)
5635 (frame-parameter nil 'line-spacing)
5639 (setq lsp (truncate (* (frame-char-height) lsp))))
5642 (defun window-screen-lines ()
5643 "Return the number of screen lines in the text area of the selected window.
5645 This is different from `window-text-height' in that this function counts
5646 lines in units of the height of the font used by the default face displayed
5647 in the window, not in units of the frame's default font, and also accounts
5648 for `line-spacing', if any, defined for the window's buffer or frame.
5650 The value is a floating-point number."
5651 (let ((edges (window-inside-pixel-edges))
5652 (dlh (default-line-height)))
5653 (/ (float (- (nth 3 edges) (nth 1 edges))) dlh)))
5655 ;; Returns non-nil if partial move was done.
5656 (defun line-move-partial (arg noerror to-end)
5658 ;; Move backward (up).
5659 ;; If already vscrolled, reduce vscroll
5660 (let ((vs (window-vscroll nil t))
5661 (dlh (default-line-height)))
5663 (set-window-vscroll nil (- vs dlh) t)))
5665 ;; Move forward (down).
5666 (let* ((lh (window-line-height -1))
5671 (this-lh (window-line-height))
5672 (this-height (car this-lh))
5673 (this-ypos (nth 2 this-lh))
5674 (dlh (default-line-height))
5675 (wslines (window-screen-lines))
5676 (edges (window-inside-pixel-edges))
5677 (winh (- (nth 3 edges) (nth 1 edges) 1))
5679 (if (> (mod wslines 1.0) 0.0)
5680 (setq wslines (round (+ wslines 0.5))))
5685 (<= this-ypos (- dlh)))
5687 (let ((wend (pos-visible-in-window-p t nil t)))
5688 (setq rbot (nth 3 wend)
5690 vpos (nth 5 wend))))
5692 (let ((wstart (pos-visible-in-window-p nil nil t)))
5693 (setq this-ypos (nth 2 wstart)
5694 this-height (nth 4 wstart))))
5697 (let ((ppos (posn-at-point))
5699 (setq col-row (posn-actual-col-row ppos))
5701 (- (cdr col-row) (window-vscroll))
5702 (cdr (posn-col-row ppos))))))
5703 ;; VPOS > 0 means the last line is only partially visible.
5704 ;; But if the part that is visible is at least as tall as the
5705 ;; default font, that means the line is actually fully
5706 ;; readable, and something like line-spacing is hidden. So in
5707 ;; that case we accept the last line in the window as still
5708 ;; visible, and consider the margin as starting one line
5710 (if (and vpos (> vpos 0))
5712 (>= rowh (default-font-height))
5714 (setq last-line (min (- wslines scroll-margin) vpos))
5715 (setq last-line (min (- wslines scroll-margin 1) (1- vpos)))))
5717 ;; If last line of window is fully visible, and vscrolling
5718 ;; more would make this line invisible, move forward.
5719 ((and (or (< (setq vs (window-vscroll nil t)) dlh)
5721 (<= this-height dlh))
5722 (or (null rbot) (= rbot 0)))
5724 ;; If cursor is not in the bottom scroll margin, and the
5725 ;; current line is is not too tall, move forward.
5726 ((and (or (null this-height) (<= this-height winh))
5731 ;; When already vscrolled, we vscroll some more if we can,
5732 ;; or clear vscroll and move forward at end of tall image.
5734 (when (or (and rbot (> rbot 0))
5735 (and this-height (> this-height dlh)))
5736 (set-window-vscroll nil (+ vs dlh) t)))
5737 ;; If cursor just entered the bottom scroll margin, move forward,
5738 ;; but also optionally vscroll one line so redisplay won't recenter.
5742 ;; Don't vscroll if the partially-visible line at window
5743 ;; bottom is not too tall (a.k.a. "just one more text
5744 ;; line"): in that case, we do want redisplay to behave
5745 ;; normally, i.e. recenter or whatever.
5747 ;; Note: ROWH + RBOT from the value returned by
5748 ;; pos-visible-in-window-p give the total height of the
5749 ;; partially-visible glyph row at the end of the window. As
5750 ;; we are dealing with floats, we disregard sub-pixel
5751 ;; discrepancies between that and DLH.
5752 (if (and rowh rbot (>= (- (+ rowh rbot) winh) 1))
5753 (set-window-vscroll nil dlh t))
5754 (line-move-1 arg noerror to-end)
5756 ;; If there are lines above the last line, scroll-up one line.
5757 ((and vpos (> vpos 0))
5760 ;; Finally, start vscroll.
5762 (set-window-vscroll nil dlh t)))))))
5765 ;; This is like line-move-1 except that it also performs
5766 ;; vertical scrolling of tall images if appropriate.
5767 ;; That is not really a clean thing to do, since it mixes
5768 ;; scrolling with cursor motion. But so far we don't have
5769 ;; a cleaner solution to the problem of making C-n do something
5770 ;; useful given a tall image.
5771 (defun line-move (arg &optional noerror to-end try-vscroll)
5772 "Move forward ARG lines.
5773 If NOERROR, don't signal an error if we can't move ARG lines.
5775 TRY-VSCROLL controls whether to vscroll tall lines: if either
5776 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5779 (line-move-1 arg noerror to-end)
5780 (unless (and auto-window-vscroll try-vscroll
5781 ;; Only vscroll for single line moves
5783 ;; Under scroll-conservatively, the display engine
5784 ;; does this better.
5785 (zerop scroll-conservatively)
5786 ;; But don't vscroll in a keyboard macro.
5787 (not defining-kbd-macro)
5788 (not executing-kbd-macro)
5789 (line-move-partial arg noerror to-end))
5790 (set-window-vscroll nil 0 t)
5791 (if (and line-move-visual
5792 ;; Display-based column are incompatible with goal-column.
5794 ;; When the text in the window is scrolled to the left,
5795 ;; display-based motion doesn't make sense (because each
5796 ;; logical line occupies exactly one screen line).
5797 (not (> (window-hscroll) 0))
5798 ;; Likewise when the text _was_ scrolled to the left
5799 ;; when the current run of vertical motion commands
5801 (not (and (memq last-command
5802 `(next-line previous-line ,this-command))
5804 (numberp temporary-goal-column)
5805 (>= temporary-goal-column
5806 (- (window-width) hscroll-margin)))))
5807 (prog1 (line-move-visual arg noerror)
5808 ;; If we moved into a tall line, set vscroll to make
5809 ;; scrolling through tall images more smooth.
5810 (let ((lh (line-pixel-height))
5811 (edges (window-inside-pixel-edges))
5812 (dlh (default-line-height))
5814 (setq winh (- (nth 3 edges) (nth 1 edges) 1))
5816 (< (point) (window-start))
5821 (line-move-1 arg noerror to-end)))))
5823 ;; Display-based alternative to line-move-1.
5824 ;; Arg says how many lines to move. The value is t if we can move the
5825 ;; specified number of lines.
5826 (defun line-move-visual (arg &optional noerror)
5827 "Move ARG lines forward.
5828 If NOERROR, don't signal an error if we can't move that many lines."
5829 (let ((opoint (point))
5830 (hscroll (window-hscroll))
5832 ;; Check if the previous command was a line-motion command, or if
5833 ;; we were called from some other command.
5834 (if (and (consp temporary-goal-column)
5835 (memq last-command `(next-line previous-line ,this-command)))
5836 ;; If so, there's no need to reset `temporary-goal-column',
5837 ;; but we may need to hscroll.
5838 (if (or (/= (cdr temporary-goal-column) hscroll)
5839 (> (cdr temporary-goal-column) 0))
5840 (setq target-hscroll (cdr temporary-goal-column)))
5841 ;; Otherwise, we should reset `temporary-goal-column'.
5842 (let ((posn (posn-at-point))
5845 ;; Handle the `overflow-newline-into-fringe' case:
5846 ((eq (nth 1 posn) 'right-fringe)
5847 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
5848 ((car (posn-x-y posn))
5849 (setq x-pos (car (posn-x-y posn)))
5850 ;; In R2L lines, the X pixel coordinate is measured from the
5851 ;; left edge of the window, but columns are still counted
5852 ;; from the logical-order beginning of the line, i.e. from
5853 ;; the right edge in this case. We need to adjust for that.
5854 (if (eq (current-bidi-paragraph-direction) 'right-to-left)
5855 (setq x-pos (- (window-body-width nil t) 1 x-pos)))
5856 (setq temporary-goal-column
5857 (cons (/ (float x-pos)
5861 (set-window-hscroll (selected-window) target-hscroll))
5862 ;; vertical-motion can move more than it was asked to if it moves
5863 ;; across display strings with newlines. We don't want to ring
5864 ;; the bell and announce beginning/end of buffer in that case.
5865 (or (and (or (and (>= arg 0)
5866 (>= (vertical-motion
5867 (cons (or goal-column
5868 (if (consp temporary-goal-column)
5869 (car temporary-goal-column)
5870 temporary-goal-column))
5874 (<= (vertical-motion
5875 (cons (or goal-column
5876 (if (consp temporary-goal-column)
5877 (car temporary-goal-column)
5878 temporary-goal-column))
5883 ;; If the goal column lies on a display string,
5884 ;; `vertical-motion' advances the cursor to the end
5885 ;; of the string. For arg < 0, this can cause the
5886 ;; cursor to get stuck. (Bug#3020).
5887 (= (vertical-motion arg) arg)))
5889 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
5892 ;; This is the guts of next-line and previous-line.
5893 ;; Arg says how many lines to move.
5894 ;; The value is t if we can move the specified number of lines.
5895 (defun line-move-1 (arg &optional noerror _to-end)
5896 ;; Don't run any point-motion hooks, and disregard intangibility,
5897 ;; for intermediate positions.
5898 (let ((inhibit-point-motion-hooks t)
5901 (if (consp temporary-goal-column)
5902 (setq temporary-goal-column (+ (car temporary-goal-column)
5903 (cdr temporary-goal-column))))
5906 (if (not (memq last-command '(next-line previous-line)))
5907 (setq temporary-goal-column
5908 (if (and track-eol (eolp)
5909 ;; Don't count beg of empty line as end of line
5910 ;; unless we just did explicit end-of-line.
5911 (or (not (bolp)) (eq last-command 'move-end-of-line)))
5912 most-positive-fixnum
5915 (if (not (or (integerp selective-display)
5916 line-move-ignore-invisible))
5917 ;; Use just newline characters.
5918 ;; Set ARG to 0 if we move as many lines as requested.
5920 (progn (if (> arg 1) (forward-line (1- arg)))
5921 ;; This way of moving forward ARG lines
5922 ;; verifies that we have a newline after the last one.
5923 ;; It doesn't get confused by intangible text.
5925 (if (zerop (forward-line 1))
5927 (and (zerop (forward-line arg))
5931 (signal (if (< arg 0)
5932 'beginning-of-buffer
5935 ;; Move by arg lines, but ignore invisible ones.
5937 (while (and (> arg 0) (not done))
5938 ;; If the following character is currently invisible,
5939 ;; skip all characters with that same `invisible' property value.
5940 (while (and (not (eobp)) (invisible-p (point)))
5941 (goto-char (next-char-property-change (point))))
5943 ;; We don't use `end-of-line', since we want to escape
5944 ;; from field boundaries occurring exactly at point.
5945 (goto-char (constrain-to-field
5946 (let ((inhibit-field-text-motion t))
5947 (line-end-position))
5949 'inhibit-line-move-field-capture))
5950 ;; If there's no invisibility here, move over the newline.
5954 (signal 'end-of-buffer nil)
5956 ((and (> arg 1) ;; Use vertical-motion for last move
5957 (not (integerp selective-display))
5958 (not (invisible-p (point))))
5959 ;; We avoid vertical-motion when possible
5960 ;; because that has to fontify.
5962 ;; Otherwise move a more sophisticated way.
5963 ((zerop (vertical-motion 1))
5965 (signal 'end-of-buffer nil)
5968 (setq arg (1- arg))))
5969 ;; The logic of this is the same as the loop above,
5970 ;; it just goes in the other direction.
5971 (while (and (< arg 0) (not done))
5972 ;; For completely consistency with the forward-motion
5973 ;; case, we should call beginning-of-line here.
5974 ;; However, if point is inside a field and on a
5975 ;; continued line, the call to (vertical-motion -1)
5976 ;; below won't move us back far enough; then we return
5977 ;; to the same column in line-move-finish, and point
5978 ;; gets stuck -- cyd
5983 (signal 'beginning-of-buffer nil)
5985 ((and (< arg -1) ;; Use vertical-motion for last move
5986 (not (integerp selective-display))
5987 (not (invisible-p (1- (point)))))
5989 ((zerop (vertical-motion -1))
5991 (signal 'beginning-of-buffer nil)
5995 (while (and ;; Don't move over previous invis lines
5996 ;; if our target is the middle of this line.
5997 (or (zerop (or goal-column temporary-goal-column))
5999 (not (bobp)) (invisible-p (1- (point))))
6000 (goto-char (previous-char-property-change (point))))))))
6001 ;; This is the value the function returns.
6005 ;; If we did not move down as far as desired, at least go
6006 ;; to end of line. Be sure to call point-entered and
6007 ;; point-left-hooks.
6008 (let* ((npoint (prog1 (line-end-position)
6009 (goto-char opoint)))
6010 (inhibit-point-motion-hooks nil))
6011 (goto-char npoint)))
6013 ;; If we did not move up as far as desired,
6014 ;; at least go to beginning of line.
6015 (let* ((npoint (prog1 (line-beginning-position)
6016 (goto-char opoint)))
6017 (inhibit-point-motion-hooks nil))
6018 (goto-char npoint)))
6020 (line-move-finish (or goal-column temporary-goal-column)
6021 opoint (> orig-arg 0)))))))
6023 (defun line-move-finish (column opoint forward)
6026 ;; Set REPEAT to t to repeat the whole thing.
6031 (line-beg (line-beginning-position))
6033 ;; Compute the end of the line
6034 ;; ignoring effectively invisible newlines.
6036 ;; Like end-of-line but ignores fields.
6037 (skip-chars-forward "^\n")
6038 (while (and (not (eobp)) (invisible-p (point)))
6039 (goto-char (next-char-property-change (point)))
6040 (skip-chars-forward "^\n"))
6043 ;; Move to the desired column.
6044 (line-move-to-column (truncate column))
6046 ;; Corner case: suppose we start out in a field boundary in
6047 ;; the middle of a continued line. When we get to
6048 ;; line-move-finish, point is at the start of a new *screen*
6049 ;; line but the same text line; then line-move-to-column would
6050 ;; move us backwards. Test using C-n with point on the "x" in
6051 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6058 ;; Process intangibility within a line.
6059 ;; With inhibit-point-motion-hooks bound to nil, a call to
6060 ;; goto-char moves point past intangible text.
6062 ;; However, inhibit-point-motion-hooks controls both the
6063 ;; intangibility and the point-entered/point-left hooks. The
6064 ;; following hack avoids calling the point-* hooks
6065 ;; unnecessarily. Note that we move *forward* past intangible
6066 ;; text when the initial and final points are the same.
6068 (let ((inhibit-point-motion-hooks nil))
6071 ;; If intangibility moves us to a different (later) place
6072 ;; in the same line, use that as the destination.
6073 (if (<= (point) line-end)
6075 ;; If that position is "too late",
6076 ;; try the previous allowable position.
6080 ;; If going forward, don't accept the previous
6081 ;; allowable position if it is before the target line.
6082 (< line-beg (point))
6083 ;; If going backward, don't accept the previous
6084 ;; allowable position if it is still after the target line.
6085 (<= (point) line-end))
6087 ;; As a last resort, use the end of the line.
6088 (setq new line-end))))
6090 ;; Now move to the updated destination, processing fields
6091 ;; as well as intangibility.
6093 (let ((inhibit-point-motion-hooks nil))
6095 ;; Ignore field boundaries if the initial and final
6096 ;; positions have the same `field' property, even if the
6097 ;; fields are non-contiguous. This seems to be "nicer"
6098 ;; behavior in many situations.
6099 (if (eq (get-char-property new 'field)
6100 (get-char-property opoint 'field))
6102 (constrain-to-field new opoint t t
6103 'inhibit-line-move-field-capture))))
6105 ;; If all this moved us to a different line,
6106 ;; retry everything within that new line.
6107 (when (or (< (point) line-beg) (> (point) line-end))
6108 ;; Repeat the intangibility and field processing.
6109 (setq repeat t))))))
6111 (defun line-move-to-column (col)
6112 "Try to find column COL, considering invisibility.
6113 This function works only in certain cases,
6114 because what we really need is for `move-to-column'
6115 and `current-column' to be able to ignore invisible text."
6118 (move-to-column col))
6120 (when (and line-move-ignore-invisible
6121 (not (bolp)) (invisible-p (1- (point))))
6122 (let ((normal-location (point))
6123 (normal-column (current-column)))
6124 ;; If the following character is currently invisible,
6125 ;; skip all characters with that same `invisible' property value.
6126 (while (and (not (eobp))
6127 (invisible-p (point)))
6128 (goto-char (next-char-property-change (point))))
6129 ;; Have we advanced to a larger column position?
6130 (if (> (current-column) normal-column)
6131 ;; We have made some progress towards the desired column.
6132 ;; See if we can make any further progress.
6133 (line-move-to-column (+ (current-column) (- col normal-column)))
6134 ;; Otherwise, go to the place we originally found
6135 ;; and move back over invisible text.
6136 ;; that will get us to the same place on the screen
6137 ;; but with a more reasonable buffer position.
6138 (goto-char normal-location)
6140 ;; We want the real line beginning, so it's consistent
6141 ;; with bolp below, otherwise we might infloop.
6142 (let ((inhibit-field-text-motion t))
6143 (line-beginning-position))))
6144 (while (and (not (bolp)) (invisible-p (1- (point))))
6145 (goto-char (previous-char-property-change (point) line-beg))))))))
6147 (defun move-end-of-line (arg)
6148 "Move point to end of current line as displayed.
6149 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6150 If point reaches the beginning or end of buffer, it stops there.
6152 To ignore the effects of the `intangible' text or overlay
6153 property, bind `inhibit-point-motion-hooks' to t.
6154 If there is an image in the current line, this function
6155 disregards newlines that are part of the text on which the image
6158 (or arg (setq arg 1))
6163 (let ((goal-column 0)
6164 (line-move-visual nil))
6165 (and (line-move arg t)
6166 ;; With bidi reordering, we may not be at bol,
6167 ;; so make sure we are.
6168 (skip-chars-backward "^\n")
6171 (while (and (not (bobp)) (invisible-p (1- (point))))
6172 (goto-char (previous-single-char-property-change
6173 (point) 'invisible)))
6177 (if (and (> (point) newpos)
6178 (eq (preceding-char) ?\n))
6180 (if (and (> (point) newpos) (not (eobp))
6181 (not (eq (following-char) ?\n)))
6182 ;; If we skipped something intangible and now we're not
6183 ;; really at eol, keep going.
6187 (defun move-beginning-of-line (arg)
6188 "Move point to beginning of current line as displayed.
6189 \(If there's an image in the line, this disregards newlines
6190 which are part of the text that the image rests on.)
6192 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6193 If point reaches the beginning or end of buffer, it stops there.
6194 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6196 (or arg (setq arg 1))
6198 (let ((orig (point))
6199 first-vis first-vis-field-value)
6201 ;; Move by lines, if ARG is not 1 (the default).
6203 (let ((line-move-visual nil))
6204 (line-move (1- arg) t)))
6206 ;; Move to beginning-of-line, ignoring fields and invisible text.
6207 (skip-chars-backward "^\n")
6208 (while (and (not (bobp)) (invisible-p (1- (point))))
6209 (goto-char (previous-char-property-change (point)))
6210 (skip-chars-backward "^\n"))
6212 ;; Now find first visible char in the line.
6213 (while (and (< (point) orig) (invisible-p (point)))
6214 (goto-char (next-char-property-change (point) orig)))
6215 (setq first-vis (point))
6217 ;; See if fields would stop us from reaching FIRST-VIS.
6218 (setq first-vis-field-value
6219 (constrain-to-field first-vis orig (/= arg 1) t nil))
6221 (goto-char (if (/= first-vis-field-value first-vis)
6222 ;; If yes, obey them.
6223 first-vis-field-value
6224 ;; Otherwise, move to START with attention to fields.
6225 ;; (It is possible that fields never matter in this case.)
6226 (constrain-to-field (point) orig
6227 (/= arg 1) t nil)))))
6230 ;; Many people have said they rarely use this feature, and often type
6231 ;; it by accident. Maybe it shouldn't even be on a key.
6232 (put 'set-goal-column 'disabled t)
6234 (defun set-goal-column (arg)
6235 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
6236 Those commands will move to this position in the line moved to
6237 rather than trying to keep the same horizontal position.
6238 With a non-nil argument ARG, clears out the goal column
6239 so that \\[next-line] and \\[previous-line] resume vertical motion.
6240 The goal column is stored in the variable `goal-column'."
6244 (setq goal-column nil)
6245 (message "No goal column"))
6246 (setq goal-column (current-column))
6247 ;; The older method below can be erroneous if `set-goal-column' is bound
6248 ;; to a sequence containing %
6249 ;;(message (substitute-command-keys
6250 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6254 (format "Goal column %d " goal-column)
6255 (substitute-command-keys
6256 "(use \\[set-goal-column] with an arg to unset it)")))
6261 ;;; Editing based on visual lines, as opposed to logical lines.
6263 (defun end-of-visual-line (&optional n)
6264 "Move point to end of current visual line.
6265 With argument N not nil or 1, move forward N - 1 visual lines first.
6266 If point reaches the beginning or end of buffer, it stops there.
6267 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6271 (let ((line-move-visual t))
6272 (line-move (1- n) t)))
6273 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6274 ;; constrain to field boundaries, so we don't either.
6275 (vertical-motion (cons (window-width) 0)))
6277 (defun beginning-of-visual-line (&optional n)
6278 "Move point to beginning of current visual line.
6279 With argument N not nil or 1, move forward N - 1 visual lines first.
6280 If point reaches the beginning or end of buffer, it stops there.
6281 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6284 (let ((opoint (point)))
6286 (let ((line-move-visual t))
6287 (line-move (1- n) t)))
6289 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6290 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
6292 (defun kill-visual-line (&optional arg)
6293 "Kill the rest of the visual line.
6294 With prefix argument ARG, kill that many visual lines from point.
6295 If ARG is negative, kill visual lines backward.
6296 If ARG is zero, kill the text before point on the current visual
6299 If you want to append the killed line to the last killed text,
6300 use \\[append-next-kill] before \\[kill-line].
6302 If the buffer is read-only, Emacs will beep and refrain from deleting
6303 the line, but put the line in the kill ring anyway. This means that
6304 you can use this command to copy text from a read-only buffer.
6305 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6308 ;; Like in `kill-line', it's better to move point to the other end
6309 ;; of the kill before killing.
6310 (let ((opoint (point))
6311 (kill-whole-line (and kill-whole-line (bolp))))
6313 (vertical-motion (prefix-numeric-value arg))
6314 (end-of-visual-line 1)
6315 (if (= (point) opoint)
6317 ;; Skip any trailing whitespace at the end of the visual line.
6318 ;; We used to do this only if `show-trailing-whitespace' is
6319 ;; nil, but that's wrong; the correct thing would be to check
6320 ;; whether the trailing whitespace is highlighted. But, it's
6321 ;; OK to just do this unconditionally.
6322 (skip-chars-forward " \t")))
6323 (kill-region opoint (if (and kill-whole-line (looking-at "\n"))
6327 (defun next-logical-line (&optional arg try-vscroll)
6328 "Move cursor vertically down ARG lines.
6329 This is identical to `next-line', except that it always moves
6330 by logical lines instead of visual lines, ignoring the value of
6331 the variable `line-move-visual'."
6332 (interactive "^p\np")
6333 (let ((line-move-visual nil))
6335 (next-line arg try-vscroll))))
6337 (defun previous-logical-line (&optional arg try-vscroll)
6338 "Move cursor vertically up ARG lines.
6339 This is identical to `previous-line', except that it always moves
6340 by logical lines instead of visual lines, ignoring the value of
6341 the variable `line-move-visual'."
6342 (interactive "^p\np")
6343 (let ((line-move-visual nil))
6345 (previous-line arg try-vscroll))))
6347 (defgroup visual-line nil
6348 "Editing based on visual lines."
6352 (defvar visual-line-mode-map
6353 (let ((map (make-sparse-keymap)))
6354 (define-key map [remap kill-line] 'kill-visual-line)
6355 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
6356 (define-key map [remap move-end-of-line] 'end-of-visual-line)
6357 ;; These keybindings interfere with xterm function keys. Are
6358 ;; there any other suitable bindings?
6359 ;; (define-key map "\M-[" 'previous-logical-line)
6360 ;; (define-key map "\M-]" 'next-logical-line)
6363 (defcustom visual-line-fringe-indicators '(nil nil)
6364 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6365 The value should be a list of the form (LEFT RIGHT), where LEFT
6366 and RIGHT are symbols representing the bitmaps to display, to
6367 indicate wrapped lines, in the left and right fringes respectively.
6368 See also `fringe-indicator-alist'.
6369 The default is not to display fringe indicators for wrapped lines.
6370 This variable does not affect fringe indicators displayed for
6372 :type '(list (choice (const :tag "Hide left indicator" nil)
6373 (const :tag "Left curly arrow" left-curly-arrow)
6374 (symbol :tag "Other bitmap"))
6375 (choice (const :tag "Hide right indicator" nil)
6376 (const :tag "Right curly arrow" right-curly-arrow)
6377 (symbol :tag "Other bitmap")))
6378 :set (lambda (symbol value)
6379 (dolist (buf (buffer-list))
6380 (with-current-buffer buf
6381 (when (and (boundp 'visual-line-mode)
6382 (symbol-value 'visual-line-mode))
6383 (setq fringe-indicator-alist
6384 (cons (cons 'continuation value)
6387 (copy-tree fringe-indicator-alist)))))))
6388 (set-default symbol value)))
6390 (defvar visual-line--saved-state nil)
6392 (define-minor-mode visual-line-mode
6393 "Toggle visual line based editing (Visual Line mode).
6394 With a prefix argument ARG, enable Visual Line mode if ARG is
6395 positive, and disable it otherwise. If called from Lisp, enable
6396 the mode if ARG is omitted or nil.
6398 When Visual Line mode is enabled, `word-wrap' is turned on in
6399 this buffer, and simple editing commands are redefined to act on
6400 visual lines, not logical lines. See Info node `Visual Line
6402 :keymap visual-line-mode-map
6405 (if visual-line-mode
6407 (set (make-local-variable 'visual-line--saved-state) nil)
6408 ;; Save the local values of some variables, to be restored if
6409 ;; visual-line-mode is turned off.
6410 (dolist (var '(line-move-visual truncate-lines
6411 truncate-partial-width-windows
6412 word-wrap fringe-indicator-alist))
6413 (if (local-variable-p var)
6414 (push (cons var (symbol-value var))
6415 visual-line--saved-state)))
6416 (set (make-local-variable 'line-move-visual) t)
6417 (set (make-local-variable 'truncate-partial-width-windows) nil)
6418 (setq truncate-lines nil
6420 fringe-indicator-alist
6421 (cons (cons 'continuation visual-line-fringe-indicators)
6422 fringe-indicator-alist)))
6423 (kill-local-variable 'line-move-visual)
6424 (kill-local-variable 'word-wrap)
6425 (kill-local-variable 'truncate-lines)
6426 (kill-local-variable 'truncate-partial-width-windows)
6427 (kill-local-variable 'fringe-indicator-alist)
6428 (dolist (saved visual-line--saved-state)
6429 (set (make-local-variable (car saved)) (cdr saved)))
6430 (kill-local-variable 'visual-line--saved-state)))
6432 (defun turn-on-visual-line-mode ()
6433 (visual-line-mode 1))
6435 (define-globalized-minor-mode global-visual-line-mode
6436 visual-line-mode turn-on-visual-line-mode)
6439 (defun transpose-chars (arg)
6440 "Interchange characters around point, moving forward one character.
6441 With prefix arg ARG, effect is to take character before point
6442 and drag it forward past ARG other characters (backward if ARG negative).
6443 If no argument and at end of line, the previous two chars are exchanged."
6445 (when (and (null arg) (eolp) (not (bobp))
6446 (not (get-text-property (1- (point)) 'read-only)))
6448 (transpose-subr 'forward-char (prefix-numeric-value arg)))
6450 (defun transpose-words (arg)
6451 "Interchange words around point, leaving point at end of them.
6452 With prefix arg ARG, effect is to take word before or around point
6453 and drag it forward past ARG other words (backward if ARG negative).
6454 If ARG is zero, the words around or after point and around or after mark
6456 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6458 (transpose-subr 'forward-word arg))
6460 (defun transpose-sexps (arg)
6461 "Like \\[transpose-words] but applies to sexps.
6462 Does not work on a sexp that point is in the middle of
6463 if it is a list or string."
6467 ;; Here we should try to simulate the behavior of
6468 ;; (cons (progn (forward-sexp x) (point))
6469 ;; (progn (forward-sexp (- x)) (point)))
6470 ;; Except that we don't want to rely on the second forward-sexp
6471 ;; putting us back to where we want to be, since forward-sexp-function
6472 ;; might do funny things like infix-precedence.
6474 (looking-at "\\sw\\|\\s_")
6476 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
6477 ;; Jumping over a symbol. We might be inside it, mind you.
6478 (progn (funcall (if (> arg 0)
6479 'skip-syntax-backward 'skip-syntax-forward)
6481 (cons (save-excursion (forward-sexp arg) (point)) (point)))
6482 ;; Otherwise, we're between sexps. Take a step back before jumping
6483 ;; to make sure we'll obey the same precedence no matter which direction
6485 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
6486 (cons (save-excursion (forward-sexp arg) (point))
6487 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
6488 (not (zerop (funcall (if (> arg 0)
6489 'skip-syntax-forward
6490 'skip-syntax-backward)
6495 (defun transpose-lines (arg)
6496 "Exchange current line and previous line, leaving point after both.
6497 With argument ARG, takes previous line and moves it past ARG lines.
6498 With argument 0, interchanges line point is in with line mark is in."
6500 (transpose-subr (function
6504 ;; Move forward over ARG lines,
6505 ;; but create newlines if necessary.
6506 (setq arg (forward-line arg))
6507 (if (/= (preceding-char) ?\n)
6508 (setq arg (1+ arg)))
6511 (forward-line arg))))
6514 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6515 ;; which seems inconsistent with the ARG /= 0 case.
6516 ;; FIXME document SPECIAL.
6517 (defun transpose-subr (mover arg &optional special)
6518 "Subroutine to do the work of transposing objects.
6519 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6520 moves forward by units of the given object (e.g. forward-sentence,
6521 forward-paragraph). If ARG is zero, exchanges the current object
6522 with the one containing mark. If ARG is an integer, moves the
6523 current object past ARG following (if ARG is positive) or
6524 preceding (if ARG is negative) objects, leaving point after the
6526 (let ((aux (if special mover
6528 (cons (progn (funcall mover x) (point))
6529 (progn (funcall mover (- x)) (point))))))
6534 (setq pos1 (funcall aux 1))
6535 (goto-char (or (mark) (error "No mark set in this buffer")))
6536 (setq pos2 (funcall aux 1))
6537 (transpose-subr-1 pos1 pos2))
6538 (exchange-point-and-mark))
6540 (setq pos1 (funcall aux -1))
6541 (setq pos2 (funcall aux arg))
6542 (transpose-subr-1 pos1 pos2)
6543 (goto-char (car pos2)))
6545 (setq pos1 (funcall aux -1))
6546 (goto-char (car pos1))
6547 (setq pos2 (funcall aux arg))
6548 (transpose-subr-1 pos1 pos2)))))
6550 (defun transpose-subr-1 (pos1 pos2)
6551 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
6552 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
6553 (when (> (car pos1) (car pos2))
6555 (setq pos1 pos2 pos2 swap)))
6556 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
6557 (atomic-change-group
6558 ;; This sequence of insertions attempts to preserve marker
6559 ;; positions at the start and end of the transposed objects.
6560 (let* ((word (buffer-substring (car pos2) (cdr pos2)))
6561 (len1 (- (cdr pos1) (car pos1)))
6562 (len2 (length word))
6563 (boundary (make-marker)))
6564 (set-marker boundary (car pos2))
6565 (goto-char (cdr pos1))
6566 (insert-before-markers word)
6567 (setq word (delete-and-extract-region (car pos1) (+ (car pos1) len1)))
6568 (goto-char boundary)
6570 (goto-char (+ boundary len1))
6571 (delete-region (point) (+ (point) len2))
6572 (set-marker boundary nil))))
6574 (defun backward-word (&optional arg)
6575 "Move backward until encountering the beginning of a word.
6576 With argument ARG, do this that many times.
6577 If ARG is omitted or nil, move point backward one word."
6579 (forward-word (- (or arg 1))))
6581 (defun mark-word (&optional arg allow-extend)
6582 "Set mark ARG words away from point.
6583 The place mark goes is the same place \\[forward-word] would
6584 move to with the same argument.
6585 Interactively, if this command is repeated
6586 or (in Transient Mark mode) if the mark is active,
6587 it marks the next ARG words after the ones already marked."
6588 (interactive "P\np")
6589 (cond ((and allow-extend
6590 (or (and (eq last-command this-command) (mark t))
6592 (setq arg (if arg (prefix-numeric-value arg)
6593 (if (< (mark) (point)) -1 1)))
6602 (forward-word (prefix-numeric-value arg))
6606 (defun kill-word (arg)
6607 "Kill characters forward until encountering the end of a word.
6608 With argument ARG, do this that many times."
6610 (kill-region (point) (progn (forward-word arg) (point))))
6612 (defun backward-kill-word (arg)
6613 "Kill characters backward until encountering the beginning of a word.
6614 With argument ARG, do this that many times."
6616 (kill-word (- arg)))
6618 (defun current-word (&optional strict really-word)
6619 "Return the symbol or word that point is on (or a nearby one) as a string.
6620 The return value includes no text properties.
6621 If optional arg STRICT is non-nil, return nil unless point is within
6622 or adjacent to a symbol or word. In all cases the value can be nil
6623 if there is no word nearby.
6624 The function, belying its name, normally finds a symbol.
6625 If optional arg REALLY-WORD is non-nil, it finds just a word."
6627 (let* ((oldpoint (point)) (start (point)) (end (point))
6628 (syntaxes (if really-word "w" "w_"))
6629 (not-syntaxes (concat "^" syntaxes)))
6630 (skip-syntax-backward syntaxes) (setq start (point))
6631 (goto-char oldpoint)
6632 (skip-syntax-forward syntaxes) (setq end (point))
6633 (when (and (eq start oldpoint) (eq end oldpoint)
6634 ;; Point is neither within nor adjacent to a word.
6636 ;; Look for preceding word in same line.
6637 (skip-syntax-backward not-syntaxes (line-beginning-position))
6639 ;; No preceding word in same line.
6640 ;; Look for following word in same line.
6642 (skip-syntax-forward not-syntaxes (line-end-position))
6643 (setq start (point))
6644 (skip-syntax-forward syntaxes)
6647 (skip-syntax-backward syntaxes)
6648 (setq start (point))))
6649 ;; If we found something nonempty, return it as a string.
6650 (unless (= start end)
6651 (buffer-substring-no-properties start end)))))
6653 (defcustom fill-prefix nil
6654 "String for filling to insert at front of new line, or nil for none."
6655 :type '(choice (const :tag "None" nil)
6658 (make-variable-buffer-local 'fill-prefix)
6659 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
6661 (defcustom auto-fill-inhibit-regexp nil
6662 "Regexp to match lines which should not be auto-filled."
6663 :type '(choice (const :tag "None" nil)
6667 (defun do-auto-fill ()
6668 "The default value for `normal-auto-fill-function'.
6669 This is the default auto-fill function, some major modes use a different one.
6670 Returns t if it really did any work."
6671 (let (fc justify give-up
6672 (fill-prefix fill-prefix))
6673 (if (or (not (setq justify (current-justification)))
6674 (null (setq fc (current-fill-column)))
6675 (and (eq justify 'left)
6676 (<= (current-column) fc))
6677 (and auto-fill-inhibit-regexp
6678 (save-excursion (beginning-of-line)
6679 (looking-at auto-fill-inhibit-regexp))))
6680 nil ;; Auto-filling not required
6681 (if (memq justify '(full center right))
6682 (save-excursion (unjustify-current-line)))
6684 ;; Choose a fill-prefix automatically.
6685 (when (and adaptive-fill-mode
6686 (or (null fill-prefix) (string= fill-prefix "")))
6688 (fill-context-prefix
6689 (save-excursion (fill-forward-paragraph -1) (point))
6690 (save-excursion (fill-forward-paragraph 1) (point)))))
6691 (and prefix (not (equal prefix ""))
6692 ;; Use auto-indentation rather than a guessed empty prefix.
6693 (not (and fill-indent-according-to-mode
6694 (string-match "\\`[ \t]*\\'" prefix)))
6695 (setq fill-prefix prefix))))
6697 (while (and (not give-up) (> (current-column) fc))
6698 ;; Determine where to split the line.
6703 (setq after-prefix (point))
6705 (looking-at (regexp-quote fill-prefix))
6706 (setq after-prefix (match-end 0)))
6707 (move-to-column (1+ fc))
6708 (fill-move-to-break-point after-prefix)
6711 ;; See whether the place we found is any good.
6713 (goto-char fill-point)
6715 ;; There is no use breaking at end of line.
6716 (save-excursion (skip-chars-forward " ") (eolp))
6717 ;; It is futile to split at the end of the prefix
6718 ;; since we would just insert the prefix again.
6719 (and after-prefix (<= (point) after-prefix))
6720 ;; Don't split right after a comment starter
6721 ;; since we would just make another comment starter.
6722 (and comment-start-skip
6723 (let ((limit (point)))
6725 (and (re-search-forward comment-start-skip
6727 (eq (point) limit))))))
6728 ;; No good place to break => stop trying.
6730 ;; Ok, we have a useful place to break the line. Do it.
6731 (let ((prev-column (current-column)))
6732 ;; If point is at the fill-point, do not `save-excursion'.
6733 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6734 ;; point will end up before it rather than after it.
6736 (skip-chars-backward " \t")
6737 (= (point) fill-point))
6738 (default-indent-new-line t)
6740 (goto-char fill-point)
6741 (default-indent-new-line t)))
6742 ;; Now do justification, if required
6743 (if (not (eq justify 'left))
6746 (justify-current-line justify nil t)))
6747 ;; If making the new line didn't reduce the hpos of
6748 ;; the end of the line, then give up now;
6749 ;; trying again will not help.
6750 (if (>= (current-column) prev-column)
6751 (setq give-up t))))))
6752 ;; Justify last line.
6753 (justify-current-line justify t t)
6756 (defvar comment-line-break-function 'comment-indent-new-line
6757 "Mode-specific function which line breaks and continues a comment.
6758 This function is called during auto-filling when a comment syntax
6760 The function should take a single optional argument, which is a flag
6761 indicating whether it should use soft newlines.")
6763 (defun default-indent-new-line (&optional soft)
6764 "Break line at point and indent.
6765 If a comment syntax is defined, call `comment-indent-new-line'.
6767 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6768 unless optional argument SOFT is non-nil."
6771 (funcall comment-line-break-function soft)
6772 ;; Insert the newline before removing empty space so that markers
6773 ;; get preserved better.
6774 (if soft (insert-and-inherit ?\n) (newline 1))
6775 (save-excursion (forward-char -1) (delete-horizontal-space))
6776 (delete-horizontal-space)
6778 (if (and fill-prefix (not adaptive-fill-mode))
6779 ;; Blindly trust a non-adaptive fill-prefix.
6781 (indent-to-left-margin)
6782 (insert-before-markers-and-inherit fill-prefix))
6785 ;; If there's an adaptive prefix, use it unless we're inside
6786 ;; a comment and the prefix is not a comment starter.
6788 (indent-to-left-margin)
6789 (insert-and-inherit fill-prefix))
6790 ;; If we're not inside a comment, just try to indent.
6791 (t (indent-according-to-mode))))))
6793 (defvar normal-auto-fill-function 'do-auto-fill
6794 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6795 Some major modes set this.")
6797 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
6798 ;; `functions' and `hooks' are usually unsafe to set, but setting
6799 ;; auto-fill-function to nil in a file-local setting is safe and
6800 ;; can be useful to prevent auto-filling.
6801 (put 'auto-fill-function 'safe-local-variable 'null)
6803 (define-minor-mode auto-fill-mode
6804 "Toggle automatic line breaking (Auto Fill mode).
6805 With a prefix argument ARG, enable Auto Fill mode if ARG is
6806 positive, and disable it otherwise. If called from Lisp, enable
6807 the mode if ARG is omitted or nil.
6809 When Auto Fill mode is enabled, inserting a space at a column
6810 beyond `current-fill-column' automatically breaks the line at a
6813 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6816 The value of `normal-auto-fill-function' specifies the function to use
6817 for `auto-fill-function' when turning Auto Fill mode on."
6818 :variable (auto-fill-function
6819 . (lambda (v) (setq auto-fill-function
6820 (if v normal-auto-fill-function)))))
6822 ;; This holds a document string used to document auto-fill-mode.
6823 (defun auto-fill-function ()
6824 "Automatically break line at a previous space, in insertion of text."
6827 (defun turn-on-auto-fill ()
6828 "Unconditionally turn on Auto Fill mode."
6831 (defun turn-off-auto-fill ()
6832 "Unconditionally turn off Auto Fill mode."
6833 (auto-fill-mode -1))
6835 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
6837 (defun set-fill-column (arg)
6838 "Set `fill-column' to specified argument.
6839 Use \\[universal-argument] followed by a number to specify a column.
6840 Just \\[universal-argument] as argument means to use the current column."
6842 (list (or current-prefix-arg
6843 ;; We used to use current-column silently, but C-x f is too easily
6844 ;; typed as a typo for C-x C-f, so we turned it into an error and
6845 ;; now an interactive prompt.
6846 (read-number "Set fill-column to: " (current-column)))))
6848 (setq arg (current-column)))
6849 (if (not (integerp arg))
6850 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6851 (error "set-fill-column requires an explicit argument")
6852 (message "Fill column set to %d (was %d)" arg fill-column)
6853 (setq fill-column arg)))
6855 (defun set-selective-display (arg)
6856 "Set `selective-display' to ARG; clear it if no arg.
6857 When the value of `selective-display' is a number > 0,
6858 lines whose indentation is >= that value are not displayed.
6859 The variable `selective-display' has a separate value for each buffer."
6861 (if (eq selective-display t)
6862 (error "selective-display already in use for marked lines"))
6865 (narrow-to-region (point-min) (point))
6866 (goto-char (window-start))
6867 (vertical-motion (window-height)))))
6868 (setq selective-display
6869 (and arg (prefix-numeric-value arg)))
6870 (recenter current-vpos))
6871 (set-window-start (selected-window) (window-start))
6872 (princ "selective-display set to " t)
6873 (prin1 selective-display t)
6876 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
6878 (defun toggle-truncate-lines (&optional arg)
6879 "Toggle truncating of long lines for the current buffer.
6880 When truncating is off, long lines are folded.
6881 With prefix argument ARG, truncate long lines if ARG is positive,
6882 otherwise fold them. Note that in side-by-side windows, this
6883 command has no effect if `truncate-partial-width-windows' is
6886 (setq truncate-lines
6888 (not truncate-lines)
6889 (> (prefix-numeric-value arg) 0)))
6890 (force-mode-line-update)
6891 (unless truncate-lines
6892 (let ((buffer (current-buffer)))
6893 (walk-windows (lambda (window)
6894 (if (eq buffer (window-buffer window))
6895 (set-window-hscroll window 0)))
6897 (message "Truncate long lines %s"
6898 (if truncate-lines "enabled" "disabled")))
6900 (defun toggle-word-wrap (&optional arg)
6901 "Toggle whether to use word-wrapping for continuation lines.
6902 With prefix argument ARG, wrap continuation lines at word boundaries
6903 if ARG is positive, otherwise wrap them at the right screen edge.
6904 This command toggles the value of `word-wrap'. It has no effect
6905 if long lines are truncated."
6910 (> (prefix-numeric-value arg) 0)))
6911 (force-mode-line-update)
6912 (message "Word wrapping %s"
6913 (if word-wrap "enabled" "disabled")))
6915 (defvar overwrite-mode-textual (purecopy " Ovwrt")
6916 "The string displayed in the mode line when in overwrite mode.")
6917 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
6918 "The string displayed in the mode line when in binary overwrite mode.")
6920 (define-minor-mode overwrite-mode
6921 "Toggle Overwrite mode.
6922 With a prefix argument ARG, enable Overwrite mode if ARG is
6923 positive, and disable it otherwise. If called from Lisp, enable
6924 the mode if ARG is omitted or nil.
6926 When Overwrite mode is enabled, printing characters typed in
6927 replace existing text on a one-for-one basis, rather than pushing
6928 it to the right. At the end of a line, such characters extend
6929 the line. Before a tab, such characters insert until the tab is
6930 filled in. \\[quoted-insert] still inserts characters in
6931 overwrite mode; this is supposed to make it easier to insert
6932 characters when necessary."
6933 :variable (overwrite-mode
6934 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
6936 (define-minor-mode binary-overwrite-mode
6937 "Toggle Binary Overwrite mode.
6938 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6939 is positive, and disable it otherwise. If called from Lisp,
6940 enable the mode if ARG is omitted or nil.
6942 When Binary Overwrite mode is enabled, printing characters typed
6943 in replace existing text. Newlines are not treated specially, so
6944 typing at the end of a line joins the line to the next, with the
6945 typed character between them. Typing before a tab character
6946 simply replaces the tab with the character typed.
6947 \\[quoted-insert] replaces the text at the cursor, just as
6948 ordinary typing characters do.
6950 Note that Binary Overwrite mode is not its own minor mode; it is
6951 a specialization of overwrite mode, entered by setting the
6952 `overwrite-mode' variable to `overwrite-mode-binary'."
6953 :variable (overwrite-mode
6954 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
6956 (define-minor-mode line-number-mode
6957 "Toggle line number display in the mode line (Line Number mode).
6958 With a prefix argument ARG, enable Line Number mode if ARG is
6959 positive, and disable it otherwise. If called from Lisp, enable
6960 the mode if ARG is omitted or nil.
6962 Line numbers do not appear for very large buffers and buffers
6963 with very long lines; see variables `line-number-display-limit'
6964 and `line-number-display-limit-width'."
6965 :init-value t :global t :group 'mode-line)
6967 (define-minor-mode column-number-mode
6968 "Toggle column number display in the mode line (Column Number mode).
6969 With a prefix argument ARG, enable Column Number mode if ARG is
6970 positive, and disable it otherwise.
6972 If called from Lisp, enable the mode if ARG is omitted or nil."
6973 :global t :group 'mode-line)
6975 (define-minor-mode size-indication-mode
6976 "Toggle buffer size display in the mode line (Size Indication mode).
6977 With a prefix argument ARG, enable Size Indication mode if ARG is
6978 positive, and disable it otherwise.
6980 If called from Lisp, enable the mode if ARG is omitted or nil."
6981 :global t :group 'mode-line)
6983 (define-minor-mode auto-save-mode
6984 "Toggle auto-saving in the current buffer (Auto Save mode).
6985 With a prefix argument ARG, enable Auto Save mode if ARG is
6986 positive, and disable it otherwise.
6988 If called from Lisp, enable the mode if ARG is omitted or nil."
6989 :variable ((and buffer-auto-save-file-name
6990 ;; If auto-save is off because buffer has shrunk,
6991 ;; then toggling should turn it on.
6992 (>= buffer-saved-size 0))
6994 (setq buffer-auto-save-file-name
6997 ((and buffer-file-name auto-save-visited-file-name
6998 (not buffer-read-only))
7000 (t (make-auto-save-file-name))))))
7001 ;; If -1 was stored here, to temporarily turn off saving,
7003 (and (< buffer-saved-size 0)
7004 (setq buffer-saved-size 0)))
7006 (defgroup paren-blinking nil
7007 "Blinking matching of parens and expressions."
7008 :prefix "blink-matching-"
7009 :group 'paren-matching)
7011 (defcustom blink-matching-paren t
7012 "Non-nil means show matching open-paren when close-paren is inserted.
7013 If t, highlight the paren. If `jump', move cursor to its position."
7015 (const :tag "Disable" nil)
7016 (const :tag "Highlight" t)
7017 (const :tag "Move cursor" jump))
7018 :group 'paren-blinking)
7020 (defcustom blink-matching-paren-on-screen t
7021 "Non-nil means show matching open-paren when it is on screen.
7022 If nil, don't show it (but the open-paren can still be shown
7023 when it is off screen).
7025 This variable has no effect if `blink-matching-paren' is nil.
7026 \(In that case, the open-paren is never shown.)
7027 It is also ignored if `show-paren-mode' is enabled."
7029 :group 'paren-blinking)
7031 (defcustom blink-matching-paren-distance (* 100 1024)
7032 "If non-nil, maximum distance to search backwards for matching open-paren.
7033 If nil, search stops at the beginning of the accessible portion of the buffer."
7034 :version "23.2" ; 25->100k
7035 :type '(choice (const nil) integer)
7036 :group 'paren-blinking)
7038 (defcustom blink-matching-delay 1
7039 "Time in seconds to delay after showing a matching paren."
7041 :group 'paren-blinking)
7043 (defcustom blink-matching-paren-dont-ignore-comments nil
7044 "If nil, `blink-matching-paren' ignores comments.
7045 More precisely, when looking for the matching parenthesis,
7046 it skips the contents of comments that end before point."
7048 :group 'paren-blinking)
7050 (defun blink-matching-check-mismatch (start end)
7051 "Return whether or not START...END are matching parens.
7052 END is the current point and START is the blink position.
7053 START might be nil if no matching starter was found.
7054 Returns non-nil if we find there is a mismatch."
7055 (let* ((end-syntax (syntax-after (1- end)))
7056 (matching-paren (and (consp end-syntax)
7057 (eq (syntax-class end-syntax) 5)
7059 ;; For self-matched chars like " and $, we can't know when they're
7060 ;; mismatched or unmatched, so we can only do it for parens.
7061 (when matching-paren
7064 (eq (char-after start) matching-paren)
7065 ;; The cdr might hold a new paren-class info rather than
7066 ;; a matching-char info, in which case the two CDRs
7068 (eq matching-paren (cdr-safe (syntax-after start)))))))))
7070 (defvar blink-matching-check-function #'blink-matching-check-mismatch
7071 "Function to check parentheses mismatches.
7072 The function takes two arguments (START and END) where START is the
7073 position just before the opening token and END is the position right after.
7074 START can be nil, if it was not found.
7075 The function should return non-nil if the two tokens do not match.")
7077 (defvar blink-matching--overlay
7078 (let ((ol (make-overlay (point) (point) nil t)))
7079 (overlay-put ol 'face 'show-paren-match)
7082 "Overlay used to highlight the matching paren.")
7084 (defun blink-matching-open ()
7085 "Momentarily highlight the beginning of the sexp before point."
7087 (when (and (not (bobp))
7088 blink-matching-paren)
7089 (let* ((oldpos (point))
7090 (message-log-max nil) ; Don't log messages about paren matching.
7094 (if blink-matching-paren-distance
7096 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
7097 (- (point) blink-matching-paren-distance))
7099 (let ((parse-sexp-ignore-comments
7100 (and parse-sexp-ignore-comments
7101 (not blink-matching-paren-dont-ignore-comments))))
7104 (syntax-propertize (point))
7106 ;; backward-sexp skips backward over prefix chars,
7107 ;; so move back to the matching paren.
7108 (while (and (< (point) (1- oldpos))
7109 (let ((code (syntax-after (point))))
7110 (or (eq (syntax-class code) 6)
7111 (eq (logand 1048576 (car code))
7116 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
7121 (minibuffer-message "Mismatched parentheses")
7122 (message "Mismatched parentheses"))
7124 (minibuffer-message "No matching parenthesis found")
7125 (message "No matching parenthesis found"))))
7126 ((not blinkpos) nil)
7127 ((pos-visible-in-window-p blinkpos)
7128 ;; Matching open within window, temporarily move to or highlight
7129 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7131 (and blink-matching-paren-on-screen
7132 (not show-paren-mode)
7133 (if (eq blink-matching-paren 'jump)
7135 (goto-char blinkpos)
7136 (sit-for blink-matching-delay))
7139 (move-overlay blink-matching--overlay blinkpos (1+ blinkpos)
7141 (sit-for blink-matching-delay))
7142 (delete-overlay blink-matching--overlay)))))
7145 (goto-char blinkpos)
7146 (let ((open-paren-line-string
7147 ;; Show what precedes the open in its line, if anything.
7149 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
7150 (buffer-substring (line-beginning-position)
7152 ;; Show what follows the open in its line, if anything.
7155 (skip-chars-forward " \t")
7157 (buffer-substring blinkpos
7158 (line-end-position)))
7159 ;; Otherwise show the previous nonblank line,
7161 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
7163 (buffer-substring (progn
7164 (skip-chars-backward "\n \t")
7165 (line-beginning-position))
7166 (progn (end-of-line)
7167 (skip-chars-backward " \t")
7169 ;; Replace the newline and other whitespace with `...'.
7171 (buffer-substring blinkpos (1+ blinkpos))))
7172 ;; There is nothing to show except the char itself.
7173 (t (buffer-substring blinkpos (1+ blinkpos))))))
7176 (substring-no-properties open-paren-line-string)))))))))
7178 (defvar blink-paren-function 'blink-matching-open
7179 "Function called, if non-nil, whenever a close parenthesis is inserted.
7180 More precisely, a char with closeparen syntax is self-inserted.")
7182 (defun blink-paren-post-self-insert-function ()
7183 (when (and (eq (char-before) last-command-event) ; Sanity check.
7184 (memq (char-syntax last-command-event) '(?\) ?\$))
7185 blink-paren-function
7186 (not executing-kbd-macro)
7187 (not noninteractive)
7188 ;; Verify an even number of quoting characters precede the close.
7189 ;; FIXME: Also check if this parenthesis closes a comment as
7190 ;; can happen in Pascal and SML.
7191 (= 1 (logand 1 (- (point)
7194 (skip-syntax-backward "/\\")
7196 (funcall blink-paren-function)))
7198 (put 'blink-paren-post-self-insert-function 'priority 100)
7200 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
7201 ;; Most likely, this hook is nil, so this arg doesn't matter,
7202 ;; but I use it as a reminder that this function usually
7203 ;; likes to be run after others since it does
7204 ;; `sit-for'. That's also the reason it get a `priority' prop
7208 ;; This executes C-g typed while Emacs is waiting for a command.
7209 ;; Quitting out of a program does not go through here;
7210 ;; that happens in the QUIT macro at the C code level.
7211 (defun keyboard-quit ()
7212 "Signal a `quit' condition.
7213 During execution of Lisp code, this character causes a quit directly.
7214 At top-level, as an editor command, this simply beeps."
7216 ;; Avoid adding the region to the window selection.
7217 (setq saved-region-selection nil)
7218 (let (select-active-regions)
7220 (if (fboundp 'kmacro-keyboard-quit)
7221 (kmacro-keyboard-quit))
7222 (when completion-in-region-mode
7223 (completion-in-region-mode -1))
7224 ;; Force the next redisplay cycle to remove the "Def" indicator from
7225 ;; all the mode lines.
7226 (if defining-kbd-macro
7227 (force-mode-line-update t))
7228 (setq defining-kbd-macro nil)
7229 (let ((debug-on-quit nil))
7230 (signal 'quit nil)))
7232 (defvar buffer-quit-function nil
7233 "Function to call to \"quit\" the current buffer, or nil if none.
7234 \\[keyboard-escape-quit] calls this function when its more local actions
7235 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
7237 (defun keyboard-escape-quit ()
7238 "Exit the current \"mode\" (in a generalized sense of the word).
7239 This command can exit an interactive command such as `query-replace',
7240 can clear out a prefix argument or a region,
7241 can get out of the minibuffer or other recursive edit,
7242 cancel the use of the current buffer (for special-purpose buffers),
7243 or go back to just one window (by deleting all but the selected window)."
7245 (cond ((eq last-command 'mode-exited) nil)
7248 ((> (minibuffer-depth) 0)
7249 (abort-recursive-edit))
7252 ((> (recursion-depth) 0)
7253 (exit-recursive-edit))
7254 (buffer-quit-function
7255 (funcall buffer-quit-function))
7256 ((not (one-window-p t))
7257 (delete-other-windows))
7258 ((string-match "^ \\*" (buffer-name (current-buffer)))
7261 (defun play-sound-file (file &optional volume device)
7262 "Play sound stored in FILE.
7263 VOLUME and DEVICE correspond to the keywords of the sound
7264 specification for `play-sound'."
7265 (interactive "fPlay sound file: ")
7266 (let ((sound (list :file file)))
7268 (plist-put sound :volume volume))
7270 (plist-put sound :device device))
7272 (play-sound sound)))
7275 (defcustom read-mail-command 'rmail
7276 "Your preference for a mail reading package.
7277 This is used by some keybindings which support reading mail.
7278 See also `mail-user-agent' concerning sending mail."
7279 :type '(radio (function-item :tag "Rmail" :format "%t\n" rmail)
7280 (function-item :tag "Gnus" :format "%t\n" gnus)
7281 (function-item :tag "Emacs interface to MH"
7282 :format "%t\n" mh-rmail)
7283 (function :tag "Other"))
7287 (defcustom mail-user-agent 'message-user-agent
7288 "Your preference for a mail composition package.
7289 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7290 outgoing email message. This variable lets you specify which
7291 mail-sending package you prefer.
7293 Valid values include:
7295 `message-user-agent' -- use the Message package.
7296 See Info node `(message)'.
7297 `sendmail-user-agent' -- use the Mail package.
7298 See Info node `(emacs)Sending Mail'.
7299 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7300 See Info node `(mh-e)'.
7301 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7302 paraphernalia if Gnus is running, particularly
7303 the Gcc: header for archiving.
7305 Additional valid symbols may be available; check with the author of
7306 your package for details. The function should return non-nil if it
7309 See also `read-mail-command' concerning reading mail."
7310 :type '(radio (function-item :tag "Message package"
7313 (function-item :tag "Mail package"
7315 sendmail-user-agent)
7316 (function-item :tag "Emacs interface to MH"
7319 (function-item :tag "Message with full Gnus features"
7322 (function :tag "Other"))
7323 :version "23.2" ; sendmail->message
7326 (defcustom compose-mail-user-agent-warnings t
7327 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7328 If the value of `mail-user-agent' is the default, and the user
7329 appears to have customizations applying to the old default,
7330 `compose-mail' issues a warning."
7335 (defun rfc822-goto-eoh ()
7336 "If the buffer starts with a mail header, move point to the header's end.
7337 Otherwise, moves to `point-min'.
7338 The end of the header is the start of the next line, if there is one,
7339 else the end of the last line. This function obeys RFC822."
7340 (goto-char (point-min))
7341 (when (re-search-forward
7342 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
7343 (goto-char (match-beginning 0))))
7345 ;; Used by Rmail (e.g., rmail-forward).
7346 (defvar mail-encode-mml nil
7347 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7348 the outgoing message before sending it.")
7350 (defun compose-mail (&optional to subject other-headers continue
7351 switch-function yank-action send-actions
7353 "Start composing a mail message to send.
7354 This uses the user's chosen mail composition package
7355 as selected with the variable `mail-user-agent'.
7356 The optional arguments TO and SUBJECT specify recipients
7357 and the initial Subject field, respectively.
7359 OTHER-HEADERS is an alist specifying additional
7360 header fields. Elements look like (HEADER . VALUE) where both
7361 HEADER and VALUE are strings.
7363 CONTINUE, if non-nil, says to continue editing a message already
7364 being composed. Interactively, CONTINUE is the prefix argument.
7366 SWITCH-FUNCTION, if non-nil, is a function to use to
7367 switch to and display the buffer used for mail composition.
7369 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7370 to insert the raw text of the message being replied to.
7371 It has the form (FUNCTION . ARGS). The user agent will apply
7372 FUNCTION to ARGS, to insert the raw text of the original message.
7373 \(The user agent will also run `mail-citation-hook', *after* the
7374 original text has been inserted in this way.)
7376 SEND-ACTIONS is a list of actions to call when the message is sent.
7377 Each action has the form (FUNCTION . ARGS).
7379 RETURN-ACTION, if non-nil, is an action for returning to the
7380 caller. It has the form (FUNCTION . ARGS). The function is
7381 called after the mail has been sent or put aside, and the mail
7384 (list nil nil nil current-prefix-arg))
7386 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7387 ;; from sendmail-user-agent to message-user-agent. Some users may
7388 ;; encounter incompatibilities. This hack tries to detect problems
7389 ;; and warn about them.
7390 (and compose-mail-user-agent-warnings
7391 (eq mail-user-agent 'message-user-agent)
7393 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
7394 mail-yank-hooks mail-archive-file-name
7395 mail-default-reply-to mail-mailing-lists
7399 (push var warn-vars)))
7401 (display-warning 'mail
7403 The default mail mode is now Message mode.
7404 You have the following Mail mode variable%s customized:
7405 \n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
7406 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7407 (if (> (length warn-vars) 1) "s" "")
7408 (mapconcat 'symbol-name
7411 (let ((function (get mail-user-agent 'composefunc)))
7412 (funcall function to subject other-headers continue switch-function
7413 yank-action send-actions return-action)))
7415 (defun compose-mail-other-window (&optional to subject other-headers continue
7416 yank-action send-actions
7418 "Like \\[compose-mail], but edit the outgoing message in another window."
7419 (interactive (list nil nil nil current-prefix-arg))
7420 (compose-mail to subject other-headers continue
7421 'switch-to-buffer-other-window yank-action send-actions
7424 (defun compose-mail-other-frame (&optional to subject other-headers continue
7425 yank-action send-actions
7427 "Like \\[compose-mail], but edit the outgoing message in another frame."
7428 (interactive (list nil nil nil current-prefix-arg))
7429 (compose-mail to subject other-headers continue
7430 'switch-to-buffer-other-frame yank-action send-actions
7434 (defvar set-variable-value-history nil
7435 "History of values entered with `set-variable'.
7437 Maximum length of the history list is determined by the value
7438 of `history-length', which see.")
7440 (defun set-variable (variable value &optional make-local)
7441 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7442 VARIABLE should be a user option variable name, a Lisp variable
7443 meant to be customized by users. You should enter VALUE in Lisp syntax,
7444 so if you want VALUE to be a string, you must surround it with doublequotes.
7445 VALUE is used literally, not evaluated.
7447 If VARIABLE has a `variable-interactive' property, that is used as if
7448 it were the arg to `interactive' (which see) to interactively read VALUE.
7450 If VARIABLE has been defined with `defcustom', then the type information
7451 in the definition is used to check that VALUE is valid.
7453 Note that this function is at heart equivalent to the basic `set' function.
7454 For a variable defined with `defcustom', it does not pay attention to
7455 any :set property that the variable might have (if you want that, use
7456 \\[customize-set-variable] instead).
7458 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7460 (let* ((default-var (variable-at-point))
7461 (var (if (custom-variable-p default-var)
7462 (read-variable (format "Set variable (default %s): " default-var)
7464 (read-variable "Set variable: ")))
7465 (minibuffer-help-form '(describe-variable var))
7466 (prop (get var 'variable-interactive))
7467 (obsolete (car (get var 'byte-obsolete-variable)))
7468 (prompt (format "Set %s %s to value: " var
7469 (cond ((local-variable-p var)
7471 ((or current-prefix-arg
7472 (local-variable-if-set-p var))
7477 (message (concat "`%S' is obsolete; "
7478 (if (symbolp obsolete) "use `%S' instead" "%s"))
7482 ;; Use VAR's `variable-interactive' property
7483 ;; as an interactive spec for prompting.
7484 (call-interactively `(lambda (arg)
7487 (read-from-minibuffer prompt nil
7488 read-expression-map t
7489 'set-variable-value-history
7490 (format "%S" (symbol-value var)))))))
7491 (list var val current-prefix-arg)))
7493 (and (custom-variable-p variable)
7494 (not (get variable 'custom-type))
7495 (custom-load-symbol variable))
7496 (let ((type (get variable 'custom-type)))
7498 ;; Match with custom type.
7500 (setq type (widget-convert type))
7501 (unless (widget-apply type :match value)
7502 (user-error "Value `%S' does not match type %S of %S"
7503 value (car type) variable))))
7506 (make-local-variable variable))
7508 (set variable value)
7510 ;; Force a thorough redisplay for the case that the variable
7511 ;; has an effect on the display, like `tab-width' has.
7512 (force-mode-line-update))
7514 ;; Define the major mode for lists of completions.
7516 (defvar completion-list-mode-map
7517 (let ((map (make-sparse-keymap)))
7518 (define-key map [mouse-2] 'choose-completion)
7519 (define-key map [follow-link] 'mouse-face)
7520 (define-key map [down-mouse-2] nil)
7521 (define-key map "\C-m" 'choose-completion)
7522 (define-key map "\e\e\e" 'delete-completion-window)
7523 (define-key map [left] 'previous-completion)
7524 (define-key map [right] 'next-completion)
7525 (define-key map [?\t] 'next-completion)
7526 (define-key map [backtab] 'previous-completion)
7527 (define-key map "q" 'quit-window)
7528 (define-key map "z" 'kill-this-buffer)
7530 "Local map for completion list buffers.")
7532 ;; Completion mode is suitable only for specially formatted data.
7533 (put 'completion-list-mode 'mode-class 'special)
7535 (defvar completion-reference-buffer nil
7536 "Record the buffer that was current when the completion list was requested.
7537 This is a local variable in the completion list buffer.
7538 Initial value is nil to avoid some compiler warnings.")
7540 (defvar completion-no-auto-exit nil
7541 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7542 This also applies to other functions such as `choose-completion'.")
7544 (defvar completion-base-position nil
7545 "Position of the base of the text corresponding to the shown completions.
7546 This variable is used in the *Completions* buffers.
7547 Its value is a list of the form (START END) where START is the place
7548 where the completion should be inserted and END (if non-nil) is the end
7549 of the text to replace. If END is nil, point is used instead.")
7551 (defvar completion-list-insert-choice-function #'completion--replace
7552 "Function to use to insert the text chosen in *Completions*.
7553 Called with three arguments (BEG END TEXT), it should replace the text
7554 between BEG and END with TEXT. Expected to be set buffer-locally
7555 in the *Completions* buffer.")
7557 (defvar completion-base-size nil
7558 "Number of chars before point not involved in completion.
7559 This is a local variable in the completion list buffer.
7560 It refers to the chars in the minibuffer if completing in the
7561 minibuffer, or in `completion-reference-buffer' otherwise.
7562 Only characters in the field at point are included.
7564 If nil, Emacs determines which part of the tail end of the
7565 buffer's text is involved in completion by comparing the text
7567 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7569 (defun delete-completion-window ()
7570 "Delete the completion list window.
7571 Go to the window from which completion was requested."
7573 (let ((buf completion-reference-buffer))
7574 (if (one-window-p t)
7575 (if (window-dedicated-p) (delete-frame))
7576 (delete-window (selected-window))
7577 (if (get-buffer-window buf)
7578 (select-window (get-buffer-window buf))))))
7580 (defun previous-completion (n)
7581 "Move to the previous item in the completion list."
7583 (next-completion (- n)))
7585 (defun next-completion (n)
7586 "Move to the next item in the completion list.
7587 With prefix argument N, move N items (negative N means move backward)."
7589 (let ((beg (point-min)) (end (point-max)))
7590 (while (and (> n 0) (not (eobp)))
7591 ;; If in a completion, move to the end of it.
7592 (when (get-text-property (point) 'mouse-face)
7593 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7594 ;; Move to start of next one.
7595 (unless (get-text-property (point) 'mouse-face)
7596 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7598 (while (and (< n 0) (not (bobp)))
7599 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7600 ;; If in a completion, move to the start of it.
7601 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7602 (goto-char (previous-single-property-change
7603 (point) 'mouse-face nil beg)))
7604 ;; Move to end of the previous completion.
7605 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7606 (goto-char (previous-single-property-change
7607 (point) 'mouse-face nil beg)))
7608 ;; Move to the start of that one.
7609 (goto-char (previous-single-property-change
7610 (point) 'mouse-face nil beg))
7613 (defun choose-completion (&optional event)
7614 "Choose the completion at point.
7615 If EVENT, use EVENT's position to determine the starting position."
7616 (interactive (list last-nonmenu-event))
7617 ;; In case this is run via the mouse, give temporary modes such as
7618 ;; isearch a chance to turn off.
7619 (run-hooks 'mouse-leave-buffer-hook)
7620 (with-current-buffer (window-buffer (posn-window (event-start event)))
7621 (let ((buffer completion-reference-buffer)
7622 (base-size completion-base-size)
7623 (base-position completion-base-position)
7624 (insert-function completion-list-insert-choice-function)
7627 (goto-char (posn-point (event-start event)))
7630 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7631 (setq end (point) beg (1+ (point))))
7633 (get-text-property (1- (point)) 'mouse-face))
7634 (setq end (1- (point)) beg (point)))
7635 (t (error "No completion here")))
7636 (setq beg (previous-single-property-change beg 'mouse-face))
7637 (setq end (or (next-single-property-change end 'mouse-face)
7639 (buffer-substring-no-properties beg end)))))
7641 (unless (buffer-live-p buffer)
7642 (error "Destination buffer is dead"))
7643 (quit-window nil (posn-window (event-start event)))
7645 (with-current-buffer buffer
7646 (choose-completion-string
7650 ;; Someone's using old completion code that doesn't know
7651 ;; about base-position yet.
7652 (list (+ base-size (field-beginning))))
7653 ;; If all else fails, just guess.
7654 (list (choose-completion-guess-base-position choice)))
7655 insert-function)))))
7657 ;; Delete the longest partial match for STRING
7658 ;; that can be found before POINT.
7659 (defun choose-completion-guess-base-position (string)
7661 (let ((opoint (point))
7663 ;; Try moving back by the length of the string.
7664 (goto-char (max (- (point) (length string))
7665 (minibuffer-prompt-end)))
7666 ;; See how far back we were actually able to move. That is the
7667 ;; upper bound on how much we can match and delete.
7668 (setq len (- opoint (point)))
7669 (if completion-ignore-case
7670 (setq string (downcase string)))
7671 (while (and (> len 0)
7672 (let ((tail (buffer-substring (point) opoint)))
7673 (if completion-ignore-case
7674 (setq tail (downcase tail)))
7675 (not (string= tail (substring string 0 len)))))
7680 (defun choose-completion-delete-max-match (string)
7681 (declare (obsolete choose-completion-guess-base-position "23.2"))
7682 (delete-region (choose-completion-guess-base-position string) (point)))
7684 (defvar choose-completion-string-functions nil
7685 "Functions that may override the normal insertion of a completion choice.
7686 These functions are called in order with three arguments:
7687 CHOICE - the string to insert in the buffer,
7688 BUFFER - the buffer in which the choice should be inserted,
7689 BASE-POSITION - where to insert the completion.
7691 If a function in the list returns non-nil, that function is supposed
7692 to have inserted the CHOICE in the BUFFER, and possibly exited
7693 the minibuffer; no further functions will be called.
7695 If all functions in the list return nil, that means to use
7696 the default method of inserting the completion in BUFFER.")
7698 (defun choose-completion-string (choice &optional
7699 buffer base-position insert-function)
7700 "Switch to BUFFER and insert the completion choice CHOICE.
7701 BASE-POSITION says where to insert the completion.
7702 INSERT-FUNCTION says how to insert the completion and falls
7703 back on `completion-list-insert-choice-function' when nil."
7705 ;; If BUFFER is the minibuffer, exit the minibuffer
7706 ;; unless it is reading a file name and CHOICE is a directory,
7707 ;; or completion-no-auto-exit is non-nil.
7709 ;; Some older code may call us passing `base-size' instead of
7710 ;; `base-position'. It's difficult to make any use of `base-size',
7711 ;; so we just ignore it.
7712 (unless (consp base-position)
7713 (message "Obsolete `base-size' passed to choose-completion-string")
7714 (setq base-position nil))
7716 (let* ((buffer (or buffer completion-reference-buffer))
7717 (mini-p (minibufferp buffer)))
7718 ;; If BUFFER is a minibuffer, barf unless it's the currently
7719 ;; active minibuffer.
7721 (not (and (active-minibuffer-window)
7723 (window-buffer (active-minibuffer-window))))))
7724 (error "Minibuffer is not active for completion")
7725 ;; Set buffer so buffer-local choose-completion-string-functions works.
7727 (unless (run-hook-with-args-until-success
7728 'choose-completion-string-functions
7729 ;; The fourth arg used to be `mini-p' but was useless
7730 ;; (since minibufferp can be used on the `buffer' arg)
7731 ;; and indeed unused. The last used to be `base-size', so we
7732 ;; keep it to try and avoid breaking old code.
7733 choice buffer base-position nil)
7734 ;; This remove-text-properties should be unnecessary since `choice'
7735 ;; comes from buffer-substring-no-properties.
7736 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7737 ;; Insert the completion into the buffer where it was requested.
7738 (funcall (or insert-function completion-list-insert-choice-function)
7739 (or (car base-position) (point))
7740 (or (cadr base-position) (point))
7742 ;; Update point in the window that BUFFER is showing in.
7743 (let ((window (get-buffer-window buffer t)))
7744 (set-window-point window (point)))
7745 ;; If completing for the minibuffer, exit it with this choice.
7746 (and (not completion-no-auto-exit)
7747 (minibufferp buffer)
7748 minibuffer-completion-table
7749 ;; If this is reading a file name, and the file name chosen
7750 ;; is a directory, don't exit the minibuffer.
7751 (let* ((result (buffer-substring (field-beginning) (point)))
7753 (completion-boundaries result minibuffer-completion-table
7754 minibuffer-completion-predicate
7756 (if (eq (car bounds) (length result))
7757 ;; The completion chosen leads to a new set of completions
7758 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7759 (let ((mini (active-minibuffer-window)))
7760 (select-window mini)
7761 (when minibuffer-auto-raise
7762 (raise-frame (window-frame mini))))
7763 (exit-minibuffer))))))))
7765 (define-derived-mode completion-list-mode nil "Completion List"
7766 "Major mode for buffers showing lists of possible completions.
7767 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
7768 to select the completion near point.
7769 Or click to select one with the mouse.
7771 \\{completion-list-mode-map}"
7772 (set (make-local-variable 'completion-base-size) nil))
7774 (defun completion-list-mode-finish ()
7775 "Finish setup of the completions buffer.
7776 Called from `temp-buffer-show-hook'."
7777 (when (eq major-mode 'completion-list-mode)
7778 (setq buffer-read-only t)))
7780 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7783 ;; Variables and faces used in `completion-setup-function'.
7785 (defcustom completion-show-help t
7786 "Non-nil means show help message in *Completions* buffer."
7791 ;; This function goes in completion-setup-hook, so that it is called
7792 ;; after the text of the completion list buffer is written.
7793 (defun completion-setup-function ()
7794 (let* ((mainbuf (current-buffer))
7796 ;; FIXME: This is a bad hack. We try to set the default-directory
7797 ;; in the *Completions* buffer so that the relative file names
7798 ;; displayed there can be treated as valid file names, independently
7799 ;; from the completion context. But this suffers from many problems:
7800 ;; - It's not clear when the completions are file names. With some
7801 ;; completion tables (e.g. bzr revision specs), the listed
7802 ;; completions can mix file names and other things.
7803 ;; - It doesn't pay attention to possible quoting.
7804 ;; - With fancy completion styles, the code below will not always
7805 ;; find the right base directory.
7806 (if minibuffer-completing-file-name
7807 (file-name-as-directory
7809 (buffer-substring (minibuffer-prompt-end)
7810 (- (point) (or completion-base-size 0))))))))
7811 (with-current-buffer standard-output
7812 (let ((base-size completion-base-size) ;Read before killing localvars.
7813 (base-position completion-base-position)
7814 (insert-fun completion-list-insert-choice-function))
7815 (completion-list-mode)
7816 (set (make-local-variable 'completion-base-size) base-size)
7817 (set (make-local-variable 'completion-base-position) base-position)
7818 (set (make-local-variable 'completion-list-insert-choice-function)
7820 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7821 (if base-dir (setq default-directory base-dir))
7822 ;; Maybe insert help string.
7823 (when completion-show-help
7824 (goto-char (point-min))
7825 (if (display-mouse-p)
7826 (insert (substitute-command-keys
7827 "Click on a completion to select it.\n")))
7828 (insert (substitute-command-keys
7829 "In this buffer, type \\[choose-completion] to \
7830 select the completion near point.\n\n"))))))
7832 (add-hook 'completion-setup-hook 'completion-setup-function)
7834 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7835 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7837 (defun switch-to-completions ()
7838 "Select the completion list window."
7840 (let ((window (or (get-buffer-window "*Completions*" 0)
7841 ;; Make sure we have a completions window.
7842 (progn (minibuffer-completion-help)
7843 (get-buffer-window "*Completions*" 0)))))
7845 (select-window window)
7846 ;; In the new buffer, go to the first completion.
7847 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7849 (next-completion 1)))))
7851 ;;; Support keyboard commands to turn on various modifiers.
7853 ;; These functions -- which are not commands -- each add one modifier
7854 ;; to the following event.
7856 (defun event-apply-alt-modifier (_ignore-prompt)
7857 "\\<function-key-map>Add the Alt modifier to the following event.
7858 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
7859 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7860 (defun event-apply-super-modifier (_ignore-prompt)
7861 "\\<function-key-map>Add the Super modifier to the following event.
7862 For example, type \\[event-apply-super-modifier] & to enter Super-&."
7863 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7864 (defun event-apply-hyper-modifier (_ignore-prompt)
7865 "\\<function-key-map>Add the Hyper modifier to the following event.
7866 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
7867 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7868 (defun event-apply-shift-modifier (_ignore-prompt)
7869 "\\<function-key-map>Add the Shift modifier to the following event.
7870 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
7871 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7872 (defun event-apply-control-modifier (_ignore-prompt)
7873 "\\<function-key-map>Add the Ctrl modifier to the following event.
7874 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
7875 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7876 (defun event-apply-meta-modifier (_ignore-prompt)
7877 "\\<function-key-map>Add the Meta modifier to the following event.
7878 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
7879 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7881 (defun event-apply-modifier (event symbol lshiftby prefix)
7882 "Apply a modifier flag to event EVENT.
7883 SYMBOL is the name of this modifier, as a symbol.
7884 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7885 PREFIX is the string that represents this modifier in an event type symbol."
7887 (cond ((eq symbol 'control)
7888 (if (and (<= (downcase event) ?z)
7889 (>= (downcase event) ?a))
7890 (- (downcase event) ?a -1)
7891 (if (and (<= (downcase event) ?Z)
7892 (>= (downcase event) ?A))
7893 (- (downcase event) ?A -1)
7894 (logior (lsh 1 lshiftby) event))))
7896 (if (and (<= (downcase event) ?z)
7897 (>= (downcase event) ?a))
7899 (logior (lsh 1 lshiftby) event)))
7901 (logior (lsh 1 lshiftby) event)))
7902 (if (memq symbol (event-modifiers event))
7904 (let ((event-type (if (symbolp event) event (car event))))
7905 (setq event-type (intern (concat prefix (symbol-name event-type))))
7908 (cons event-type (cdr event)))))))
7910 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7911 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7912 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7913 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7914 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7915 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7917 ;;;; Keypad support.
7919 ;; Make the keypad keys act like ordinary typing keys. If people add
7920 ;; bindings for the function key symbols, then those bindings will
7921 ;; override these, so this shouldn't interfere with any existing
7924 ;; Also tell read-char how to handle these keys.
7926 (lambda (keypad-normal)
7927 (let ((keypad (nth 0 keypad-normal))
7928 (normal (nth 1 keypad-normal)))
7929 (put keypad 'ascii-character normal)
7930 (define-key function-key-map (vector keypad) (vector normal))))
7931 ;; See also kp-keys bound in bindings.el.
7937 ;; Do the same for various keys that are represented as symbols under
7938 ;; GUIs but naturally correspond to characters.
7949 ;;;; forking a twin copy of a buffer.
7952 (defvar clone-buffer-hook nil
7953 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7955 (defvar clone-indirect-buffer-hook nil
7956 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7958 (defun clone-process (process &optional newname)
7959 "Create a twin copy of PROCESS.
7960 If NEWNAME is nil, it defaults to PROCESS' name;
7961 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7962 If PROCESS is associated with a buffer, the new process will be associated
7963 with the current buffer instead.
7964 Returns nil if PROCESS has already terminated."
7965 (setq newname (or newname (process-name process)))
7966 (if (string-match "<[0-9]+>\\'" newname)
7967 (setq newname (substring newname 0 (match-beginning 0))))
7968 (when (memq (process-status process) '(run stop open))
7969 (let* ((process-connection-type (process-tty-name process))
7971 (if (memq (process-status process) '(open))
7972 (let ((args (process-contact process t)))
7973 (setq args (plist-put args :name newname))
7974 (setq args (plist-put args :buffer
7975 (if (process-buffer process)
7977 (apply 'make-network-process args))
7978 (apply 'start-process newname
7979 (if (process-buffer process) (current-buffer))
7980 (process-command process)))))
7981 (set-process-query-on-exit-flag
7982 new-process (process-query-on-exit-flag process))
7983 (set-process-inherit-coding-system-flag
7984 new-process (process-inherit-coding-system-flag process))
7985 (set-process-filter new-process (process-filter process))
7986 (set-process-sentinel new-process (process-sentinel process))
7987 (set-process-plist new-process (copy-sequence (process-plist process)))
7990 ;; things to maybe add (currently partly covered by `funcall mode'):
7993 (defun clone-buffer (&optional newname display-flag)
7994 "Create and return a twin copy of the current buffer.
7995 Unlike an indirect buffer, the new buffer can be edited
7996 independently of the old one (if it is not read-only).
7997 NEWNAME is the name of the new buffer. It may be modified by
7998 adding or incrementing <N> at the end as necessary to create a
7999 unique buffer name. If nil, it defaults to the name of the
8000 current buffer, with the proper suffix. If DISPLAY-FLAG is
8001 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8002 clone a file-visiting buffer, or a buffer whose major mode symbol
8003 has a non-nil `no-clone' property, results in an error.
8005 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8006 current buffer with appropriate suffix. However, if a prefix
8007 argument is given, then the command prompts for NEWNAME in the
8010 This runs the normal hook `clone-buffer-hook' in the new buffer
8011 after it has been set up properly in other respects."
8014 (if buffer-file-name
8015 (error "Cannot clone a file-visiting buffer"))
8016 (if (get major-mode 'no-clone)
8017 (error "Cannot clone a buffer in %s mode" mode-name))
8018 (list (if current-prefix-arg
8019 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8021 (if buffer-file-name
8022 (error "Cannot clone a file-visiting buffer"))
8023 (if (get major-mode 'no-clone)
8024 (error "Cannot clone a buffer in %s mode" mode-name))
8025 (setq newname (or newname (buffer-name)))
8026 (if (string-match "<[0-9]+>\\'" newname)
8027 (setq newname (substring newname 0 (match-beginning 0))))
8028 (let ((buf (current-buffer))
8032 (mk (if mark-active (mark t)))
8033 (modified (buffer-modified-p))
8035 (lvars (buffer-local-variables))
8036 (process (get-buffer-process (current-buffer)))
8037 (new (generate-new-buffer (or newname (buffer-name)))))
8040 (with-current-buffer new
8041 (insert-buffer-substring buf)))
8042 (with-current-buffer new
8043 (narrow-to-region ptmin ptmax)
8045 (if mk (set-mark mk))
8046 (set-buffer-modified-p modified)
8048 ;; Clone the old buffer's process, if any.
8049 (when process (clone-process process))
8051 ;; Now set up the major mode.
8054 ;; Set up other local variables.
8056 (condition-case () ;in case var is read-only
8059 (set (make-local-variable (car v)) (cdr v)))
8063 ;; Run any hooks (typically set up by the major mode
8064 ;; for cloning to work properly).
8065 (run-hooks 'clone-buffer-hook))
8067 ;; Presumably the current buffer is shown in the selected frame, so
8068 ;; we want to display the clone elsewhere.
8069 (let ((same-window-regexps nil)
8070 (same-window-buffer-names))
8071 (pop-to-buffer new)))
8075 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8076 "Create an indirect buffer that is a twin copy of the current buffer.
8078 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8079 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8080 or if not called with a prefix arg, NEWNAME defaults to the current
8081 buffer's name. The name is modified by adding a `<N>' suffix to it
8082 or by incrementing the N in an existing suffix. Trying to clone a
8083 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8084 property results in an error.
8086 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8087 This is always done when called interactively.
8089 Optional third arg NORECORD non-nil means do not put this buffer at the
8090 front of the list of recently selected ones.
8092 Returns the newly created indirect buffer."
8095 (if (get major-mode 'no-clone-indirect)
8096 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8097 (list (if current-prefix-arg
8098 (read-buffer "Name of indirect buffer: " (current-buffer)))
8100 (if (get major-mode 'no-clone-indirect)
8101 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8102 (setq newname (or newname (buffer-name)))
8103 (if (string-match "<[0-9]+>\\'" newname)
8104 (setq newname (substring newname 0 (match-beginning 0))))
8105 (let* ((name (generate-new-buffer-name newname))
8106 (buffer (make-indirect-buffer (current-buffer) name t)))
8107 (with-current-buffer buffer
8108 (run-hooks 'clone-indirect-buffer-hook))
8110 (pop-to-buffer buffer norecord))
8114 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8115 "Like `clone-indirect-buffer' but display in another window."
8118 (if (get major-mode 'no-clone-indirect)
8119 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8120 (list (if current-prefix-arg
8121 (read-buffer "Name of indirect buffer: " (current-buffer)))
8123 (let ((pop-up-windows t))
8124 (clone-indirect-buffer newname display-flag norecord)))
8127 ;;; Handling of Backspace and Delete keys.
8129 (defcustom normal-erase-is-backspace 'maybe
8130 "Set the default behavior of the Delete and Backspace keys.
8132 If set to t, Delete key deletes forward and Backspace key deletes
8135 If set to nil, both Delete and Backspace keys delete backward.
8137 If set to 'maybe (which is the default), Emacs automatically
8138 selects a behavior. On window systems, the behavior depends on
8139 the keyboard used. If the keyboard has both a Backspace key and
8140 a Delete key, and both are mapped to their usual meanings, the
8141 option's default value is set to t, so that Backspace can be used
8142 to delete backward, and Delete can be used to delete forward.
8144 If not running under a window system, customizing this option
8145 accomplishes a similar effect by mapping C-h, which is usually
8146 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8147 via `keyboard-translate'. The former functionality of C-h is
8148 available on the F1 key. You should probably not use this
8149 setting if you don't have both Backspace, Delete and F1 keys.
8151 Setting this variable with setq doesn't take effect. Programmatically,
8152 call `normal-erase-is-backspace-mode' (which see) instead."
8153 :type '(choice (const :tag "Off" nil)
8154 (const :tag "Maybe" maybe)
8155 (other :tag "On" t))
8156 :group 'editing-basics
8158 :set (lambda (symbol value)
8159 ;; The fboundp is because of a problem with :set when
8160 ;; dumping Emacs. It doesn't really matter.
8161 (if (fboundp 'normal-erase-is-backspace-mode)
8162 (normal-erase-is-backspace-mode (or value 0))
8163 (set-default symbol value))))
8165 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8166 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8167 (unless frame (setq frame (selected-frame)))
8168 (with-selected-frame frame
8169 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8170 (normal-erase-is-backspace-mode
8171 (if (if (eq normal-erase-is-backspace 'maybe)
8172 (and (not noninteractive)
8173 (or (memq system-type '(ms-dos windows-nt))
8174 (memq window-system '(w32 ns))
8175 (and (memq window-system '(x))
8176 (fboundp 'x-backspace-delete-keys-p)
8177 (x-backspace-delete-keys-p))
8178 ;; If the terminal Emacs is running on has erase char
8179 ;; set to ^H, use the Backspace key for deleting
8180 ;; backward, and the Delete key for deleting forward.
8181 (and (null window-system)
8182 (eq tty-erase-char ?\^H))))
8183 normal-erase-is-backspace)
8186 (define-minor-mode normal-erase-is-backspace-mode
8187 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8188 With a prefix argument ARG, enable this feature if ARG is
8189 positive, and disable it otherwise. If called from Lisp, enable
8190 the mode if ARG is omitted or nil.
8192 On window systems, when this mode is on, Delete is mapped to C-d
8193 and Backspace is mapped to DEL; when this mode is off, both
8194 Delete and Backspace are mapped to DEL. (The remapping goes via
8195 `local-function-key-map', so binding Delete or Backspace in the
8196 global or local keymap will override that.)
8198 In addition, on window systems, the bindings of C-Delete, M-Delete,
8199 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8200 the global keymap in accordance with the functionality of Delete and
8201 Backspace. For example, if Delete is remapped to C-d, which deletes
8202 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8203 to DEL, which deletes backward, C-Delete is bound to
8204 `backward-kill-word'.
8206 If not running on a window system, a similar effect is accomplished by
8207 remapping C-h (normally produced by the Backspace key) and DEL via
8208 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8209 to C-d; if it's off, the keys are not remapped.
8211 When not running on a window system, and this mode is turned on, the
8212 former functionality of C-h is available on the F1 key. You should
8213 probably not turn on this mode on a text-only terminal if you don't
8214 have both Backspace, Delete and F1 keys.
8216 See also `normal-erase-is-backspace'."
8217 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8219 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8221 (let ((enabled (eq 1 (terminal-parameter
8222 nil 'normal-erase-is-backspace))))
8224 (cond ((or (memq window-system '(x w32 ns pc))
8225 (memq system-type '(ms-dos windows-nt)))
8227 `(([M-delete] [M-backspace])
8228 ([C-M-delete] [C-M-backspace])
8229 ([?\e C-delete] [?\e C-backspace]))))
8233 (define-key local-function-key-map [delete] [deletechar])
8234 (define-key local-function-key-map [kp-delete] [deletechar])
8235 (define-key local-function-key-map [backspace] [?\C-?])
8236 (dolist (b bindings)
8237 ;; Not sure if input-decode-map is really right, but
8238 ;; keyboard-translate-table (used below) only works
8239 ;; for integer events, and key-translation-table is
8240 ;; global (like the global-map, used earlier).
8241 (define-key input-decode-map (car b) nil)
8242 (define-key input-decode-map (cadr b) nil)))
8243 (define-key local-function-key-map [delete] [?\C-?])
8244 (define-key local-function-key-map [kp-delete] [?\C-?])
8245 (define-key local-function-key-map [backspace] [?\C-?])
8246 (dolist (b bindings)
8247 (define-key input-decode-map (car b) (cadr b))
8248 (define-key input-decode-map (cadr b) (car b))))))
8252 (keyboard-translate ?\C-h ?\C-?)
8253 (keyboard-translate ?\C-? ?\C-d))
8254 (keyboard-translate ?\C-h ?\C-h)
8255 (keyboard-translate ?\C-? ?\C-?))))
8257 (if (called-interactively-p 'interactive)
8258 (message "Delete key deletes %s"
8259 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8260 "forward" "backward")))))
8262 (defvar vis-mode-saved-buffer-invisibility-spec nil
8263 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8265 (define-minor-mode read-only-mode
8266 "Change whether the current buffer is read-only.
8267 With prefix argument ARG, make the buffer read-only if ARG is
8268 positive, otherwise make it writable. If buffer is read-only
8269 and `view-read-only' is non-nil, enter view mode.
8271 Do not call this from a Lisp program unless you really intend to
8272 do the same thing as the \\[read-only-mode] command, including
8273 possibly enabling or disabling View mode. Also, note that this
8274 command works by setting the variable `buffer-read-only', which
8275 does not affect read-only regions caused by text properties. To
8276 ignore read-only status in a Lisp program (whether due to text
8277 properties or buffer state), bind `inhibit-read-only' temporarily
8278 to a non-nil value."
8279 :variable buffer-read-only
8281 ((and (not buffer-read-only) view-mode)
8282 (View-exit-and-edit)
8283 (make-local-variable 'view-read-only)
8284 (setq view-read-only t)) ; Must leave view mode.
8285 ((and buffer-read-only view-read-only
8286 ;; If view-mode is already active, `view-mode-enter' is a nop.
8288 (not (eq (get major-mode 'mode-class) 'special)))
8289 (view-mode-enter))))
8291 (define-minor-mode visible-mode
8292 "Toggle making all invisible text temporarily visible (Visible mode).
8293 With a prefix argument ARG, enable Visible mode if ARG is
8294 positive, and disable it otherwise. If called from Lisp, enable
8295 the mode if ARG is omitted or nil.
8297 This mode works by saving the value of `buffer-invisibility-spec'
8298 and setting it to nil."
8300 :group 'editing-basics
8301 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8302 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8303 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8305 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8306 buffer-invisibility-spec)
8307 (setq buffer-invisibility-spec nil)))
8309 (defvar messages-buffer-mode-map
8310 (let ((map (make-sparse-keymap)))
8311 (set-keymap-parent map special-mode-map)
8312 (define-key map "g" nil) ; nothing to revert
8315 (define-derived-mode messages-buffer-mode special-mode "Messages"
8316 "Major mode used in the \"*Messages*\" buffer.")
8318 (defun messages-buffer ()
8319 "Return the \"*Messages*\" buffer.
8320 If it does not exist, create and it switch it to `messages-buffer-mode'."
8321 (or (get-buffer "*Messages*")
8322 (with-current-buffer (get-buffer-create "*Messages*")
8323 (messages-buffer-mode)
8327 ;; Minibuffer prompt stuff.
8329 ;;(defun minibuffer-prompt-modification (start end)
8330 ;; (error "You cannot modify the prompt"))
8333 ;;(defun minibuffer-prompt-insertion (start end)
8334 ;; (let ((inhibit-modification-hooks t))
8335 ;; (delete-region start end)
8336 ;; ;; Discard undo information for the text insertion itself
8337 ;; ;; and for the text deletion.above.
8338 ;; (when (consp buffer-undo-list)
8339 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8340 ;; (message "You cannot modify the prompt")))
8343 ;;(setq minibuffer-prompt-properties
8344 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8345 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8348 ;;;; Problematic external packages.
8350 ;; rms says this should be done by specifying symbols that define
8351 ;; versions together with bad values. This is therefore not as
8352 ;; flexible as it could be. See the thread:
8353 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8354 (defconst bad-packages-alist
8355 ;; Not sure exactly which semantic versions have problems.
8356 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8357 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
8358 "The version of `semantic' loaded does not work in Emacs 22.
8359 It can cause constant high CPU load.
8360 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8361 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8362 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8363 ;; provided the `CUA-mode' feature. Since this is no longer true,
8364 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8366 "CUA-mode is now part of the standard GNU Emacs distribution,
8367 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8369 You have loaded an older version of CUA-mode which does not work
8370 correctly with this version of Emacs. You should remove the old
8371 version and use the one distributed with Emacs."))
8372 "Alist of packages known to cause problems in this version of Emacs.
8373 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8374 PACKAGE is either a regular expression to match file names, or a
8375 symbol (a feature name), like for `with-eval-after-load'.
8376 SYMBOL is either the name of a string variable, or t. Upon
8377 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8378 warning using STRING as the message.")
8380 (defun bad-package-check (package)
8381 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8383 (let* ((list (assoc package bad-packages-alist))
8384 (symbol (nth 1 list)))
8388 (and (stringp (setq symbol (eval symbol)))
8389 (string-match-p (nth 2 list) symbol)))
8390 (display-warning package (nth 3 list) :warning)))
8393 (dolist (elem bad-packages-alist)
8394 (let ((pkg (car elem)))
8395 (with-eval-after-load pkg
8396 (bad-package-check pkg))))
8399 ;;; Generic dispatcher commands
8401 ;; Macro `define-alternatives' is used to create generic commands.
8402 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8403 ;; that can have different alternative implementations where choosing
8404 ;; among them is exclusively a matter of user preference.
8406 ;; (define-alternatives COMMAND) creates a new interactive command
8407 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8408 ;; Typically, the user will not need to customize this variable; packages
8409 ;; wanting to add alternative implementations should use
8411 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8413 (defmacro define-alternatives (command &rest customizations)
8414 "Define the new command `COMMAND'.
8416 The argument `COMMAND' should be a symbol.
8418 Running `M-x COMMAND RET' for the first time prompts for which
8419 alternative to use and records the selected command as a custom
8422 Running `C-u M-x COMMAND RET' prompts again for an alternative
8423 and overwrites the previous choice.
8425 The variable `COMMAND-alternatives' contains an alist with
8426 alternative implementations of COMMAND. `define-alternatives'
8427 does not have any effect until this variable is set.
8429 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8430 `defcustom' keywords and values to add to the declaration of
8431 `COMMAND-alternatives' (typically :group and :version)."
8432 (let* ((command-name (symbol-name command))
8433 (varalt-name (concat command-name "-alternatives"))
8434 (varalt-sym (intern varalt-name))
8435 (varimp-sym (intern (concat command-name "--implementation"))))
8438 (defcustom ,varalt-sym nil
8439 ,(format "Alist of alternative implementations for the `%s' command.
8441 Each entry must be a pair (ALTNAME . ALTFUN), where:
8442 ALTNAME - The name shown at user to describe the alternative implementation.
8443 ALTFUN - The function called to implement this alternative."
8445 :type '(alist :key-type string :value-type function)
8448 (put ',varalt-sym 'definition-name ',command)
8449 (defvar ,varimp-sym nil "Internal use only.")
8451 (defun ,command (&optional arg)
8452 ,(format "Run generic command `%s'.
8453 If used for the first time, or with interactive ARG, ask the user which
8454 implementation to use for `%s'. The variable `%s'
8455 contains the list of implementations currently supported for this command."
8456 command-name command-name varalt-name)
8458 (when (or arg (null ,varimp-sym))
8459 (let ((val (completing-read
8460 ,(format "Select implementation for command `%s': "
8462 ,varalt-sym nil t)))
8463 (unless (string-equal val "")
8464 (when (null ,varimp-sym)
8466 "Use `C-u M-x %s RET' to select another implementation"
8469 (customize-save-variable ',varimp-sym
8470 (cdr (assoc-string val ,varalt-sym))))))
8472 (call-interactively ,varimp-sym)
8473 (message ,(format "No implementation selected for command `%s'"
8480 ;;; simple.el ends here