1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2016 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 on
464 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
))))
481 ;; Necessary in case a margin or prefix was inserted.
484 (defun split-line (&optional arg
)
485 "Split current line, moving portion beyond point vertically down.
486 If the current line starts with `fill-prefix', insert it on the new
487 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
489 When called from Lisp code, ARG may be a prefix string to copy."
491 (skip-chars-forward " \t")
492 (let* ((col (current-column))
494 ;; What prefix should we check for (nil means don't).
495 (prefix (cond ((stringp arg
) arg
)
498 ;; Does this line start with it?
499 (have-prfx (and prefix
502 (looking-at (regexp-quote prefix
))))))
504 (if have-prfx
(insert-and-inherit prefix
))
508 (defun delete-indentation (&optional arg
)
509 "Join this line to previous and fix up whitespace at join.
510 If there is a fill prefix, delete it from the beginning of this line.
511 With argument, join this line to following line."
514 (if arg
(forward-line 1))
515 (if (eq (preceding-char) ?
\n)
517 (delete-region (point) (1- (point)))
518 ;; If the second line started with the fill prefix,
519 ;; delete the prefix.
521 (<= (+ (point) (length fill-prefix
)) (point-max))
523 (buffer-substring (point)
524 (+ (point) (length fill-prefix
)))))
525 (delete-region (point) (+ (point) (length fill-prefix
))))
526 (fixup-whitespace))))
528 (defalias 'join-line
#'delete-indentation
) ; easier to find
530 (defun delete-blank-lines ()
531 "On blank line, delete all surrounding blank lines, leaving just one.
532 On isolated blank line, delete that one.
533 On nonblank line, delete any immediately following blank lines."
535 (let (thisblank singleblank
)
538 (setq thisblank
(looking-at "[ \t]*$"))
539 ;; Set singleblank if there is just one blank line here.
542 (not (looking-at "[ \t]*\n[ \t]*$"))
544 (progn (forward-line -
1)
545 (not (looking-at "[ \t]*$")))))))
546 ;; Delete preceding blank lines, and this one too if it's the only one.
550 (if singleblank
(forward-line 1))
551 (delete-region (point)
552 (if (re-search-backward "[^ \t\n]" nil t
)
553 (progn (forward-line 1) (point))
555 ;; Delete following blank lines, unless the current line is blank
556 ;; and there are no following blank lines.
557 (if (not (and thisblank singleblank
))
561 (delete-region (point)
562 (if (re-search-forward "[^ \t\n]" nil t
)
563 (progn (beginning-of-line) (point))
565 ;; Handle the special case where point is followed by newline and eob.
566 ;; Delete the line, leaving point at eob.
567 (if (looking-at "^[ \t]*\n\\'")
568 (delete-region (point) (point-max)))))
570 (defcustom delete-trailing-lines t
571 "If non-nil, \\[delete-trailing-whitespace] deletes trailing lines.
572 Trailing lines are deleted only if `delete-trailing-whitespace'
573 is called on the entire buffer (rather than an active region)."
578 (defun delete-trailing-whitespace (&optional start end
)
579 "Delete trailing whitespace between START and END.
580 If called interactively, START and END are the start/end of the
581 region if the mark is active, or of the buffer's accessible
582 portion if the mark is inactive.
584 This command deletes whitespace characters after the last
585 non-whitespace character in each line between START and END. It
586 does not consider formfeed characters to be whitespace.
588 If this command acts on the entire buffer (i.e. if called
589 interactively with the mark inactive, or called from Lisp with
590 END nil), it also deletes all trailing lines at the end of the
591 buffer if the variable `delete-trailing-lines' is non-nil."
593 (barf-if-buffer-read-only)
595 (list (region-beginning) (region-end))
599 (let ((end-marker (copy-marker (or end
(point-max))))
600 (start (or start
(point-min))))
602 (while (re-search-forward "\\s-$" end-marker t
)
603 (skip-syntax-backward "-" (line-beginning-position))
604 ;; Don't delete formfeeds, even if they are considered whitespace.
605 (if (looking-at-p ".*\f")
606 (goto-char (match-end 0)))
607 (delete-region (point) (match-end 0)))
608 ;; Delete trailing empty lines.
609 (goto-char end-marker
)
611 delete-trailing-lines
612 ;; Really the end of buffer.
613 (= (point-max) (1+ (buffer-size)))
614 (<= (skip-chars-backward "\n") -
2))
615 (delete-region (1+ (point)) end-marker
))
616 (set-marker end-marker nil
))))
617 ;; Return nil for the benefit of `write-file-functions'.
620 (defun newline-and-indent ()
621 "Insert a newline, then indent according to major mode.
622 Indentation is done using the value of `indent-line-function'.
623 In programming language modes, this is the same as TAB.
624 In some text modes, where TAB inserts a tab, this command indents to the
625 column specified by the function `current-left-margin'."
627 (delete-horizontal-space t
)
629 (indent-according-to-mode))
631 (defun reindent-then-newline-and-indent ()
632 "Reindent current line, insert newline, then indent the new line.
633 Indentation of both lines is done according to the current major mode,
634 which means calling the current value of `indent-line-function'.
635 In programming language modes, this is the same as TAB.
636 In some text modes, where TAB inserts a tab, this indents to the
637 column specified by the function `current-left-margin'."
640 ;; Be careful to insert the newline before indenting the line.
641 ;; Otherwise, the indentation might be wrong.
645 ;; We are at EOL before the call to indent-according-to-mode, and
646 ;; after it we usually are as well, but not always. We tried to
647 ;; address it with `save-excursion' but that uses a normal marker
648 ;; whereas we need `move after insertion', so we do the save/restore
650 (setq pos
(copy-marker pos t
))
651 (indent-according-to-mode)
653 ;; Remove the trailing white-space after indentation because
654 ;; indentation may introduce the whitespace.
655 (delete-horizontal-space t
))
656 (indent-according-to-mode)))
658 (defcustom read-quoted-char-radix
8
659 "Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
660 Legitimate radix values are 8, 10 and 16."
661 :type
'(choice (const 8) (const 10) (const 16))
662 :group
'editing-basics
)
664 (defun read-quoted-char (&optional prompt
)
665 "Like `read-char', but do not allow quitting.
666 Also, if the first character read is an octal digit,
667 we read any number of octal digits and return the
668 specified character code. Any nondigit terminates the sequence.
669 If the terminator is RET, it is discarded;
670 any other terminator is used itself as input.
672 The optional argument PROMPT specifies a string to use to prompt the user.
673 The variable `read-quoted-char-radix' controls which radix to use
675 (let ((message-log-max nil
)
676 (help-events (delq nil
(mapcar (lambda (c) (unless (characterp c
) c
))
678 done
(first t
) (code 0) translated
)
680 (let ((inhibit-quit first
)
681 ;; Don't let C-h or other help chars get the help
682 ;; message--only help function keys. See bug#16617.
684 (help-event-list help-events
)
686 "Type the special character you want to use,
687 or the octal character code.
688 RET terminates the character code and is discarded;
689 any other non-digit terminates the character code and is then used as input."))
690 (setq translated
(read-key (and prompt
(format "%s-" prompt
))))
691 (if inhibit-quit
(setq quit-flag nil
)))
692 (if (integerp translated
)
693 (setq translated
(char-resolve-modifiers translated
)))
694 (cond ((null translated
))
695 ((not (integerp translated
))
696 (setq unread-command-events
697 (nconc (listify-key-sequence (this-single-command-raw-keys))
698 unread-command-events
)
700 ((/= (logand translated ?\M-\^
@) 0)
701 ;; Turn a meta-character into a character with the 0200 bit set.
702 (setq code
(logior (logand translated
(lognot ?\M-\^
@)) 128)
704 ((and (<= ?
0 translated
)
705 (< translated
(+ ?
0 (min 10 read-quoted-char-radix
))))
706 (setq code
(+ (* code read-quoted-char-radix
) (- translated ?
0)))
707 (and prompt
(setq prompt
(message "%s %c" prompt translated
))))
708 ((and (<= ?a
(downcase translated
))
709 (< (downcase translated
)
710 (+ ?a -
10 (min 36 read-quoted-char-radix
))))
711 (setq code
(+ (* code read-quoted-char-radix
)
712 (+ 10 (- (downcase translated
) ?a
))))
713 (and prompt
(setq prompt
(message "%s %c" prompt translated
))))
714 ((and (not first
) (eq translated ?\C-m
))
717 (setq unread-command-events
718 (nconc (listify-key-sequence (this-single-command-raw-keys))
719 unread-command-events
)
721 (t (setq code translated
726 (defun quoted-insert (arg)
727 "Read next input character and insert it.
728 This is useful for inserting control characters.
729 With argument, insert ARG copies of the character.
731 If the first character you type after this command is an octal digit,
732 you should type a sequence of octal digits which specify a character code.
733 Any nondigit terminates the sequence. If the terminator is a RET,
734 it is discarded; any other terminator is used itself as input.
735 The variable `read-quoted-char-radix' specifies the radix for this feature;
736 set it to 10 or 16 to use decimal or hex instead of octal.
738 In overwrite mode, this function inserts the character anyway, and
739 does not handle octal digits specially. This means that if you use
740 overwrite as your normal editing mode, you can use this function to
741 insert characters when necessary.
743 In binary overwrite mode, this function does overwrite, and octal
744 digits are interpreted as a character code. This is intended to be
745 useful for editing binary files."
748 ;; Avoid "obsolete" warnings for translation-table-for-input.
750 (let (translation-table-for-input input-method-function
)
751 (if (or (not overwrite-mode
)
752 (eq overwrite-mode
'overwrite-mode-binary
))
755 ;; This used to assume character codes 0240 - 0377 stand for
756 ;; characters in some single-byte character set, and converted them
757 ;; to Emacs characters. But in 23.1 this feature is deprecated
758 ;; in favor of inserting the corresponding Unicode characters.
759 ;; (if (and enable-multibyte-characters
762 ;; (setq char (unibyte-char-to-multibyte char)))
763 (unless (characterp char
)
764 (user-error "%s is not a valid character"
765 (key-description (vector char
))))
767 (if (eq overwrite-mode
'overwrite-mode-binary
)
770 (insert-and-inherit char
)
771 (setq arg
(1- arg
)))))
773 (defun forward-to-indentation (&optional arg
)
774 "Move forward ARG lines and position at first nonblank character."
776 (forward-line (or arg
1))
777 (skip-chars-forward " \t"))
779 (defun backward-to-indentation (&optional arg
)
780 "Move backward ARG lines and position at first nonblank character."
782 (forward-line (- (or arg
1)))
783 (skip-chars-forward " \t"))
785 (defun back-to-indentation ()
786 "Move point to the first non-whitespace character on this line."
788 (beginning-of-line 1)
789 (skip-syntax-forward " " (line-end-position))
790 ;; Move back over chars that have whitespace syntax but have the p flag.
791 (backward-prefix-chars))
793 (defun fixup-whitespace ()
794 "Fixup white space between objects around point.
795 Leave one space or none, according to the context."
798 (delete-horizontal-space)
799 (if (or (looking-at "^\\|\\s)")
800 (save-excursion (forward-char -
1)
801 (looking-at "$\\|\\s(\\|\\s'")))
805 (defun delete-horizontal-space (&optional backward-only
)
806 "Delete all spaces and tabs around point.
807 If BACKWARD-ONLY is non-nil, only delete them before point."
809 (let ((orig-pos (point)))
814 (skip-chars-forward " \t")
815 (constrain-to-field nil orig-pos t
)))
817 (skip-chars-backward " \t")
818 (constrain-to-field nil orig-pos
)))))
820 (defun just-one-space (&optional n
)
821 "Delete all spaces and tabs around point, leaving one space (or N spaces).
822 If N is negative, delete newlines as well, leaving -N spaces.
823 See also `cycle-spacing'."
825 (cycle-spacing n nil
'single-shot
))
827 (defvar cycle-spacing--context nil
828 "Store context used in consecutive calls to `cycle-spacing' command.
829 The first time `cycle-spacing' runs, it saves in this variable:
830 its N argument, the original point position, and the original spacing
833 (defun cycle-spacing (&optional n preserve-nl-back mode
)
834 "Manipulate whitespace around point in a smart way.
835 In interactive use, this function behaves differently in successive
838 The first call in a sequence acts like `just-one-space'.
839 It deletes all spaces and tabs around point, leaving one space
840 \(or N spaces). N is the prefix argument. If N is negative,
841 it deletes newlines as well, leaving -N spaces.
842 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
844 The second call in a sequence deletes all spaces.
846 The third call in a sequence restores the original whitespace (and point).
848 If MODE is `single-shot', it only performs the first step in the sequence.
849 If MODE is `fast' and the first step would not result in any change
850 \(i.e., there are exactly (abs N) spaces around point),
851 the function goes straight to the second step.
853 Repeatedly calling the function with different values of N starts a
854 new sequence each time."
856 (let ((orig-pos (point))
857 (skip-characters (if (and n
(< n
0)) " \t\n\r" " \t"))
858 (num (abs (or n
1))))
859 (skip-chars-backward (if preserve-nl-back
" \t" skip-characters
))
860 (constrain-to-field nil orig-pos
)
862 ;; Command run for the first time, single-shot mode or different argument
863 ((or (eq 'single-shot mode
)
864 (not (equal last-command this-command
))
865 (not cycle-spacing--context
)
866 (not (eq (car cycle-spacing--context
) n
)))
867 (let* ((start (point))
868 (num (- num
(skip-chars-forward " " (+ num
(point)))))
871 (skip-chars-forward skip-characters
)
872 (constrain-to-field nil orig-pos t
))))
873 (setq cycle-spacing--context
;; Save for later.
874 ;; Special handling for case where there was no space at all.
875 (unless (= start end
)
876 (cons n
(cons orig-pos
(buffer-substring start
(point))))))
877 ;; If this run causes no change in buffer content, delete all spaces,
878 ;; otherwise delete all excess spaces.
879 (delete-region (if (and (eq mode
'fast
) (zerop num
) (= mid end
))
881 (insert (make-string num ?\s
))))
883 ;; Command run for the second time.
884 ((not (equal orig-pos
(point)))
885 (delete-region (point) orig-pos
))
887 ;; Command run for the third time.
889 (insert (cddr cycle-spacing--context
))
890 (goto-char (cadr cycle-spacing--context
))
891 (setq cycle-spacing--context nil
)))))
893 (defun beginning-of-buffer (&optional arg
)
894 "Move point to the beginning of the buffer.
895 With numeric arg N, put point N/10 of the way from the beginning.
896 If the buffer is narrowed, this command uses the beginning of the
897 accessible part of the buffer.
899 Push mark at previous position, unless either a \\[universal-argument] prefix
900 is supplied, or Transient Mark mode is enabled and the mark is active."
901 (declare (interactive-only "use `(goto-char (point-min))' instead."))
906 (let ((size (- (point-max) (point-min))))
907 (goto-char (if (and arg
(not (consp arg
)))
910 ;; Avoid overflow for large buffer sizes!
911 (* (prefix-numeric-value arg
)
913 (/ (+ 10 (* size
(prefix-numeric-value arg
))) 10)))
915 (if (and arg
(not (consp arg
))) (forward-line 1)))
917 (defun end-of-buffer (&optional arg
)
918 "Move point to the end of the buffer.
919 With numeric arg N, put point N/10 of the way from the end.
920 If the buffer is narrowed, this command uses the end of the
921 accessible part of the buffer.
923 Push mark at previous position, unless either a \\[universal-argument] prefix
924 is supplied, or Transient Mark mode is enabled and the mark is active."
925 (declare (interactive-only "use `(goto-char (point-max))' instead."))
927 (or (consp arg
) (region-active-p) (push-mark))
928 (let ((size (- (point-max) (point-min))))
929 (goto-char (if (and arg
(not (consp arg
)))
932 ;; Avoid overflow for large buffer sizes!
933 (* (prefix-numeric-value arg
)
935 (/ (* size
(prefix-numeric-value arg
)) 10)))
937 ;; If we went to a place in the middle of the buffer,
938 ;; adjust it to the beginning of a line.
939 (cond ((and arg
(not (consp arg
))) (forward-line 1))
940 ((and (eq (current-buffer) (window-buffer))
941 (> (point) (window-end nil t
)))
942 ;; If the end of the buffer is not already on the screen,
943 ;; then scroll specially to put it near, but not at, the bottom.
944 (overlay-recenter (point))
947 (defcustom delete-active-region t
948 "Whether single-char deletion commands delete an active region.
949 This has an effect only if Transient Mark mode is enabled, and
950 affects `delete-forward-char' and `delete-backward-char', though
953 If the value is the symbol `kill', the active region is killed
955 :type
'(choice (const :tag
"Delete active region" t
)
956 (const :tag
"Kill active region" kill
)
957 (const :tag
"Do ordinary deletion" nil
))
961 (defvar region-extract-function
963 (when (region-beginning)
966 (list (cons (region-beginning) (region-end))))
967 ((eq delete
'delete-only
)
968 (delete-region (region-beginning) (region-end)))
970 (filter-buffer-substring (region-beginning) (region-end) delete
)))))
971 "Function to get the region's content.
972 Called with one argument DELETE.
973 If DELETE is `delete-only', then only delete the region and the return value
974 is undefined. If DELETE is nil, just return the content as a string.
975 If DELETE is `bounds', then don't delete, but just return the
976 boundaries of the region as a list of (START . END) positions.
977 If anything else, delete the region and return its content as a string,
978 after filtering it with `filter-buffer-substring'.")
980 (defvar region-insert-function
986 (insert-for-yank (car lines
))
987 (setq lines
(cdr lines
)
989 "Function to insert the region's content.
990 Called with one argument LINES.
991 Insert the region as a list of lines.")
993 (defun delete-backward-char (n &optional killflag
)
994 "Delete the previous N characters (following if N is negative).
995 If Transient Mark mode is enabled, the mark is active, and N is 1,
996 delete the text in the region and deactivate the mark instead.
997 To disable this, set option `delete-active-region' to nil.
999 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1000 kill ring) instead of delete. Interactively, N is the prefix
1001 arg, and KILLFLAG is set if N is explicitly specified.
1003 When killing, the killed text is filtered by
1004 `filter-buffer-substring' before it is saved in the kill ring, so
1005 the actual saved text might be different from what was killed.
1007 In Overwrite mode, single character backward deletion may replace
1008 tabs with spaces so as to back over columns, unless point is at
1009 the end of the line."
1010 (declare (interactive-only delete-char
))
1011 (interactive "p\nP")
1012 (unless (integerp n
)
1013 (signal 'wrong-type-argument
(list 'integerp n
)))
1014 (cond ((and (use-region-p)
1015 delete-active-region
1017 ;; If a region is active, kill or delete it.
1018 (if (eq delete-active-region
'kill
)
1019 (kill-region (region-beginning) (region-end) 'region
)
1020 (funcall region-extract-function
'delete-only
)))
1021 ;; In Overwrite mode, maybe untabify while deleting
1022 ((null (or (null overwrite-mode
)
1024 (memq (char-before) '(?
\t ?
\n))
1026 (eq (char-after) ?
\n)))
1027 (let ((ocol (current-column)))
1028 (delete-char (- n
) killflag
)
1030 (insert-char ?\s
(- ocol
(current-column)) nil
))))
1031 ;; Otherwise, do simple deletion.
1032 (t (delete-char (- n
) killflag
))))
1034 (defun delete-forward-char (n &optional killflag
)
1035 "Delete the following N characters (previous if N is negative).
1036 If Transient Mark mode is enabled, the mark is active, and N is 1,
1037 delete the text in the region and deactivate the mark instead.
1038 To disable this, set variable `delete-active-region' to nil.
1040 Optional second arg KILLFLAG non-nil means to kill (save in kill
1041 ring) instead of delete. Interactively, N is the prefix arg, and
1042 KILLFLAG is set if N was explicitly specified.
1044 When killing, the killed text is filtered by
1045 `filter-buffer-substring' before it is saved in the kill ring, so
1046 the actual saved text might be different from what was killed."
1047 (declare (interactive-only delete-char
))
1048 (interactive "p\nP")
1049 (unless (integerp n
)
1050 (signal 'wrong-type-argument
(list 'integerp n
)))
1051 (cond ((and (use-region-p)
1052 delete-active-region
1054 ;; If a region is active, kill or delete it.
1055 (if (eq delete-active-region
'kill
)
1056 (kill-region (region-beginning) (region-end) 'region
)
1057 (funcall region-extract-function
'delete-only
)))
1059 ;; Otherwise, do simple deletion.
1060 (t (delete-char n killflag
))))
1062 (defun mark-whole-buffer ()
1063 "Put point at beginning and mark at end of buffer.
1064 If narrowing is in effect, only uses the accessible part of the buffer.
1065 You probably should not use this function in Lisp programs;
1066 it is usually a mistake for a Lisp function to use any subroutine
1067 that uses or sets the mark."
1068 (declare (interactive-only t
))
1071 (push-mark (point-max) nil t
)
1072 (goto-char (point-min)))
1075 ;; Counting lines, one way or another.
1077 (defun goto-line (line &optional buffer
)
1078 "Go to LINE, counting from line 1 at beginning of buffer.
1079 If called interactively, a numeric prefix argument specifies
1080 LINE; without a numeric prefix argument, read LINE from the
1083 If optional argument BUFFER is non-nil, switch to that buffer and
1084 move to line LINE there. If called interactively with \\[universal-argument]
1085 as argument, BUFFER is the most recently selected other buffer.
1087 Prior to moving point, this function sets the mark (without
1088 activating it), unless Transient Mark mode is enabled and the
1089 mark is already active.
1091 This function is usually the wrong thing to use in a Lisp program.
1092 What you probably want instead is something like:
1093 (goto-char (point-min))
1094 (forward-line (1- N))
1095 If at all possible, an even better solution is to use char counts
1096 rather than line counts."
1097 (declare (interactive-only forward-line
))
1099 (if (and current-prefix-arg
(not (consp current-prefix-arg
)))
1100 (list (prefix-numeric-value current-prefix-arg
))
1101 ;; Look for a default, a number in the buffer at point.
1104 (skip-chars-backward "0-9")
1105 (if (looking-at "[0-9]")
1107 (buffer-substring-no-properties
1109 (progn (skip-chars-forward "0-9")
1111 ;; Decide if we're switching buffers.
1113 (if (consp current-prefix-arg
)
1114 (other-buffer (current-buffer) t
)))
1117 (concat " in " (buffer-name buffer
))
1119 ;; Read the argument, offering that number (if any) as default.
1120 (list (read-number (format "Goto line%s: " buffer-prompt
)
1121 (list default
(line-number-at-pos)))
1123 ;; Switch to the desired buffer, one way or another.
1125 (let ((window (get-buffer-window buffer
)))
1126 (if window
(select-window window
)
1127 (switch-to-buffer-other-window buffer
))))
1128 ;; Leave mark at previous position
1129 (or (region-active-p) (push-mark))
1130 ;; Move to the specified line number in that buffer.
1133 (goto-char (point-min))
1134 (if (eq selective-display t
)
1135 (re-search-forward "[\n\C-m]" nil
'end
(1- line
))
1136 (forward-line (1- line
)))))
1138 (defun count-words-region (start end
&optional arg
)
1139 "Count the number of words in the region.
1140 If called interactively, print a message reporting the number of
1141 lines, words, and characters in the region (whether or not the
1142 region is active); with prefix ARG, report for the entire buffer
1143 rather than the region.
1145 If called from Lisp, return the number of words between positions
1147 (interactive (if current-prefix-arg
1148 (list nil nil current-prefix-arg
)
1149 (list (region-beginning) (region-end) nil
)))
1150 (cond ((not (called-interactively-p 'any
))
1151 (count-words start end
))
1153 (count-words--buffer-message))
1155 (count-words--message "Region" start end
))))
1157 (defun count-words (start end
)
1158 "Count words between START and END.
1159 If called interactively, START and END are normally the start and
1160 end of the buffer; but if the region is active, START and END are
1161 the start and end of the region. Print a message reporting the
1162 number of lines, words, and chars.
1164 If called from Lisp, return the number of words between START and
1165 END, without printing any message."
1166 (interactive (list nil nil
))
1167 (cond ((not (called-interactively-p 'any
))
1171 (narrow-to-region start end
)
1172 (goto-char (point-min))
1173 (while (forward-word-strictly 1)
1174 (setq words
(1+ words
)))))
1177 (call-interactively 'count-words-region
))
1179 (count-words--buffer-message))))
1181 (defun count-words--buffer-message ()
1182 (count-words--message
1183 (if (buffer-narrowed-p) "Narrowed part of buffer" "Buffer")
1184 (point-min) (point-max)))
1186 (defun count-words--message (str start end
)
1187 (let ((lines (count-lines start end
))
1188 (words (count-words start end
))
1189 (chars (- end start
)))
1190 (message "%s has %d line%s, %d word%s, and %d character%s."
1192 lines
(if (= lines
1) "" "s")
1193 words
(if (= words
1) "" "s")
1194 chars
(if (= chars
1) "" "s"))))
1196 (define-obsolete-function-alias 'count-lines-region
'count-words-region
"24.1")
1199 "Print the current buffer line number and narrowed line number of point."
1201 (let ((start (point-min))
1202 (n (line-number-at-pos)))
1204 (message "Line %d" n
)
1208 (message "line %d (narrowed line %d)"
1209 (+ n
(line-number-at-pos start
) -
1) n
))))))
1211 (defun count-lines (start end
)
1212 "Return number of lines between START and END.
1213 This is usually the number of newlines between them,
1214 but can be one more if START is not equal to END
1215 and the greater of them is not at the start of a line."
1218 (narrow-to-region start end
)
1219 (goto-char (point-min))
1220 (if (eq selective-display t
)
1223 (while (re-search-forward "[\n\C-m]" nil t
40)
1224 (setq done
(+ 40 done
)))
1225 (while (re-search-forward "[\n\C-m]" nil t
1)
1226 (setq done
(+ 1 done
)))
1227 (goto-char (point-max))
1228 (if (and (/= start end
)
1232 (- (buffer-size) (forward-line (buffer-size)))))))
1234 (defun line-number-at-pos (&optional pos
)
1235 "Return (narrowed) buffer line number at position POS.
1236 If POS is nil, use current buffer location.
1237 Counting starts at (point-min), so the value refers
1238 to the contents of the accessible portion of the buffer."
1239 (let ((opoint (or pos
(point))) start
)
1241 (goto-char (point-min))
1242 (setq start
(point))
1245 (1+ (count-lines start
(point))))))
1247 (defun what-cursor-position (&optional detail
)
1248 "Print info on cursor position (on screen and within buffer).
1249 Also describe the character after point, and give its character code
1250 in octal, decimal and hex.
1252 For a non-ASCII multibyte character, also give its encoding in the
1253 buffer's selected coding system if the coding system encodes the
1254 character safely. If the character is encoded into one byte, that
1255 code is shown in hex. If the character is encoded into more than one
1256 byte, just \"...\" is shown.
1258 In addition, with prefix argument, show details about that character
1259 in *Help* buffer. See also the command `describe-char'."
1261 (let* ((char (following-char))
1263 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1264 ;; start a directional embedding, which could completely
1265 ;; disrupt the rest of the line (e.g., RLO will display the
1266 ;; rest of the line right-to-left). So we put an invisible
1267 ;; PDF character after these characters, to end the
1268 ;; embedding, which eliminates any effects on the rest of
1269 ;; the line. For RLE and RLO we also append an invisible
1270 ;; LRM, to avoid reordering the following numerical
1271 ;; characters. For LRI/RLI/FSI we append a PDI.
1272 (cond ((memq char
'(?
\x202a ?
\x202d
))
1273 (propertize (string ?
\x202c
) 'invisible t
))
1274 ((memq char
'(?
\x202b ?
\x202e
))
1275 (propertize (string ?
\x202c ?
\x200e
) 'invisible t
))
1276 ((memq char
'(?
\x2066 ?
\x2067 ?
\x2068
))
1277 (propertize (string ?
\x2069
) 'invisible t
))
1278 ;; Strong right-to-left characters cause reordering of
1279 ;; the following numerical characters which show the
1280 ;; codepoint, so append LRM to countermand that.
1281 ((memq (get-char-code-property char
'bidi-class
) '(R AL
))
1282 (propertize (string ?
\x200e
) 'invisible t
))
1288 (total (buffer-size))
1289 (percent (round (* 100.0 (1- pos
)) (max 1 total
)))
1290 (hscroll (if (= (window-hscroll) 0)
1292 (format " Hscroll=%d" (window-hscroll))))
1293 (col (current-column)))
1295 (if (or (/= beg
1) (/= end
(1+ total
)))
1296 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
1297 pos total percent beg end col hscroll
)
1298 (message "point=%d of %d (EOB) column=%d%s"
1299 pos total col hscroll
))
1300 (let ((coding buffer-file-coding-system
)
1301 encoded encoding-msg display-prop under-display
)
1302 (if (or (not coding
)
1303 (eq (coding-system-type coding
) t
))
1304 (setq coding
(default-value 'buffer-file-coding-system
)))
1305 (if (eq (char-charset char
) 'eight-bit
)
1307 (format "(%d, #o%o, #x%x, raw-byte)" char char char
))
1308 ;; Check if the character is displayed with some `display'
1309 ;; text property. In that case, set under-display to the
1310 ;; buffer substring covered by that property.
1311 (setq display-prop
(get-char-property pos
'display
))
1313 (let ((to (or (next-single-char-property-change pos
'display
)
1315 (if (< to
(+ pos
4))
1316 (setq under-display
"")
1317 (setq under-display
"..."
1320 (concat (buffer-substring-no-properties pos to
)
1322 (setq encoded
(and (>= char
128) (encode-coding-char char coding
))))
1325 (if (not (stringp display-prop
))
1326 (format "(%d, #o%o, #x%x, part of display \"%s\")"
1327 char char char under-display
)
1328 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
1329 char char char under-display display-prop
))
1331 (format "(%d, #o%o, #x%x, file %s)"
1333 (if (> (length encoded
) 1)
1335 (encoded-string-description encoded coding
)))
1336 (format "(%d, #o%o, #x%x)" char char char
)))))
1338 ;; We show the detailed information about CHAR.
1339 (describe-char (point)))
1340 (if (or (/= beg
1) (/= end
(1+ total
)))
1341 (message "Char: %s%s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
1343 (single-key-description char
)
1344 (buffer-substring-no-properties (point) (1+ (point))))
1346 encoding-msg pos total percent beg end col hscroll
)
1347 (message "Char: %s%s %s point=%d of %d (%d%%) column=%d%s"
1348 (if enable-multibyte-characters
1350 (single-key-description char
)
1351 (buffer-substring-no-properties (point) (1+ (point))))
1352 (single-key-description char
))
1353 bidi-fixer encoding-msg pos total percent col hscroll
))))))
1355 ;; Initialize read-expression-map. It is defined at C level.
1356 (defvar read-expression-map
1357 (let ((m (make-sparse-keymap)))
1358 (define-key m
"\M-\t" 'completion-at-point
)
1359 ;; Might as well bind TAB to completion, since inserting a TAB char is
1360 ;; much too rarely useful.
1361 (define-key m
"\t" 'completion-at-point
)
1362 (set-keymap-parent m minibuffer-local-map
)
1365 (defun read-minibuffer (prompt &optional initial-contents
)
1366 "Return a Lisp object read using the minibuffer, unevaluated.
1367 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1368 is a string to insert in the minibuffer before reading.
1369 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1370 Such arguments are used as in `read-from-minibuffer'.)"
1371 ;; Used for interactive spec `x'.
1372 (read-from-minibuffer prompt initial-contents minibuffer-local-map
1373 t
'minibuffer-history
))
1375 (defun eval-minibuffer (prompt &optional initial-contents
)
1376 "Return value of Lisp expression read using the minibuffer.
1377 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1378 is a string to insert in the minibuffer before reading.
1379 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1380 Such arguments are used as in `read-from-minibuffer'.)"
1381 ;; Used for interactive spec `X'.
1382 (eval (read--expression prompt initial-contents
)))
1384 (defvar minibuffer-completing-symbol nil
1385 "Non-nil means completing a Lisp symbol in the minibuffer.")
1386 (make-obsolete-variable 'minibuffer-completing-symbol nil
"24.1" 'get
)
1388 (defvar minibuffer-default nil
1389 "The current default value or list of default values in the minibuffer.
1390 The functions `read-from-minibuffer' and `completing-read' bind
1391 this variable locally.")
1393 (defcustom eval-expression-print-level
4
1394 "Value for `print-level' while printing value in `eval-expression'.
1395 A value of nil means no limit."
1397 :type
'(choice (const :tag
"No Limit" nil
) integer
)
1400 (defcustom eval-expression-print-length
12
1401 "Value for `print-length' while printing value in `eval-expression'.
1402 A value of nil means no limit."
1404 :type
'(choice (const :tag
"No Limit" nil
) integer
)
1407 (defcustom eval-expression-debug-on-error t
1408 "If non-nil set `debug-on-error' to t in `eval-expression'.
1409 If nil, don't change the value of `debug-on-error'."
1414 (defun eval-expression-print-format (value)
1415 "Format VALUE as a result of evaluated expression.
1416 Return a formatted string which is displayed in the echo area
1417 in addition to the value printed by prin1 in functions which
1418 display the result of expression evaluation."
1419 (if (and (integerp value
)
1420 (or (eq standard-output t
)
1421 (zerop (prefix-numeric-value current-prefix-arg
))))
1423 (if (and (characterp value
)
1424 (char-displayable-p value
))
1425 (prin1-char value
))))
1427 (format " (#o%o, #x%x, %s)" value value char-string
)
1428 (format " (#o%o, #x%x)" value value
)))))
1430 (defvar eval-expression-minibuffer-setup-hook nil
1431 "Hook run by `eval-expression' when entering the minibuffer.")
1433 (defun read--expression (prompt &optional initial-contents
)
1434 (let ((minibuffer-completing-symbol t
))
1435 (minibuffer-with-setup-hook
1437 ;; FIXME: call emacs-lisp-mode?
1438 (add-function :before-until
(local 'eldoc-documentation-function
)
1439 #'elisp-eldoc-documentation-function
)
1440 (add-hook 'completion-at-point-functions
1441 #'elisp-completion-at-point nil t
)
1442 (run-hooks 'eval-expression-minibuffer-setup-hook
))
1443 (read-from-minibuffer prompt initial-contents
1444 read-expression-map t
1445 'read-expression-history
))))
1447 ;; We define this, rather than making `eval' interactive,
1448 ;; for the sake of completion of names like eval-region, eval-buffer.
1449 (defun eval-expression (exp &optional insert-value
)
1450 "Evaluate EXP and print value in the echo area.
1451 When called interactively, read an Emacs Lisp expression and evaluate it.
1452 Value is also consed on to front of the variable `values'.
1453 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1454 argument) means insert the result into the current buffer instead of
1455 printing it in the echo area.
1457 Normally, this function truncates long output according to the value
1458 of the variables `eval-expression-print-length' and
1459 `eval-expression-print-level'. With a prefix argument of zero,
1460 however, there is no such truncation. Such a prefix argument
1461 also causes integers to be printed in several additional formats
1462 \(octal, hexadecimal, and character).
1464 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1467 If `eval-expression-debug-on-error' is non-nil, which is the default,
1468 this command arranges for all errors to enter the debugger."
1470 (list (read--expression "Eval: ")
1471 current-prefix-arg
))
1473 (if (null eval-expression-debug-on-error
)
1474 (push (eval exp lexical-binding
) values
)
1475 (let ((old-value (make-symbol "t")) new-value
)
1476 ;; Bind debug-on-error to something unique so that we can
1477 ;; detect when evalled code changes it.
1478 (let ((debug-on-error old-value
))
1479 (push (eval (macroexpand-all exp
) lexical-binding
) values
)
1480 (setq new-value debug-on-error
))
1481 ;; If evalled code has changed the value of debug-on-error,
1482 ;; propagate that change to the global binding.
1483 (unless (eq old-value new-value
)
1484 (setq debug-on-error new-value
))))
1486 (let ((print-length (and (not (zerop (prefix-numeric-value insert-value
)))
1487 eval-expression-print-length
))
1488 (print-level (and (not (zerop (prefix-numeric-value insert-value
)))
1489 eval-expression-print-level
))
1493 (let ((standard-output (current-buffer)))
1495 (prin1 (car values
))
1496 (when (zerop (prefix-numeric-value insert-value
))
1497 (let ((str (eval-expression-print-format (car values
))))
1498 (if str
(princ str
)))))))
1500 (prin1 (car values
) t
)
1501 (let ((str (eval-expression-print-format (car values
))))
1502 (if str
(princ str t
)))))))
1504 (defun edit-and-eval-command (prompt command
)
1505 "Prompting with PROMPT, let user edit COMMAND and eval result.
1506 COMMAND is a Lisp expression. Let user edit that expression in
1507 the minibuffer, then read and evaluate the result."
1509 (let ((print-level nil
)
1510 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1512 (read-from-minibuffer prompt
1513 (prin1-to-string command
)
1514 read-expression-map t
1516 ;; If command was added to command-history as a string,
1517 ;; get rid of that. We want only evaluable expressions there.
1518 (if (stringp (car command-history
))
1519 (setq command-history
(cdr command-history
)))))))
1521 ;; If command to be redone does not match front of history,
1522 ;; add it to the history.
1523 (or (equal command
(car command-history
))
1524 (setq command-history
(cons command command-history
)))
1527 (defun repeat-complex-command (arg)
1528 "Edit and re-evaluate last complex command, or ARGth from last.
1529 A complex command is one which used the minibuffer.
1530 The command is placed in the minibuffer as a Lisp form for editing.
1531 The result is executed, repeating the command as changed.
1532 If the command has been changed or is not the most recent previous
1533 command it is added to the front of the command history.
1534 You can use the minibuffer history commands \
1535 \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1536 to get different commands to edit and resubmit."
1538 (let ((elt (nth (1- arg
) command-history
))
1543 (let ((print-level nil
)
1544 (minibuffer-history-position arg
)
1545 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1547 (read-from-minibuffer
1548 "Redo: " (prin1-to-string elt
) read-expression-map t
1549 (cons 'command-history arg
))
1551 ;; If command was added to command-history as a
1552 ;; string, get rid of that. We want only
1553 ;; evaluable expressions there.
1554 (if (stringp (car command-history
))
1555 (setq command-history
(cdr command-history
))))))
1557 ;; If command to be redone does not match front of history,
1558 ;; add it to the history.
1559 (or (equal newcmd
(car command-history
))
1560 (setq command-history
(cons newcmd command-history
)))
1561 (apply #'funcall-interactively
1563 (mapcar (lambda (e) (eval e t
)) (cdr newcmd
))))
1565 (error "Argument %d is beyond length of command history" arg
)
1566 (error "There are no previous complex commands to repeat")))))
1569 (defvar extended-command-history nil
)
1570 (defvar execute-extended-command--last-typed nil
)
1572 (defun read-extended-command ()
1573 "Read command name to invoke in `execute-extended-command'."
1574 (minibuffer-with-setup-hook
1576 (add-hook 'post-self-insert-hook
1578 (setq execute-extended-command--last-typed
1579 (minibuffer-contents)))
1581 (set (make-local-variable 'minibuffer-default-add-function
)
1583 ;; Get a command name at point in the original buffer
1584 ;; to propose it after M-n.
1585 (with-current-buffer (window-buffer (minibuffer-selected-window))
1586 (and (commandp (function-called-at-point))
1587 (format "%S" (function-called-at-point)))))))
1588 ;; Read a string, completing from and restricting to the set of
1589 ;; all defined commands. Don't provide any initial input.
1590 ;; Save the command read on the extended-command history list.
1593 ((eq current-prefix-arg
'-
) "- ")
1594 ((and (consp current-prefix-arg
)
1595 (eq (car current-prefix-arg
) 4)) "C-u ")
1596 ((and (consp current-prefix-arg
)
1597 (integerp (car current-prefix-arg
)))
1598 (format "%d " (car current-prefix-arg
)))
1599 ((integerp current-prefix-arg
)
1600 (format "%d " current-prefix-arg
)))
1601 ;; This isn't strictly correct if `execute-extended-command'
1602 ;; is bound to anything else (e.g. [menu]).
1603 ;; It could use (key-description (this-single-command-keys)),
1604 ;; but actually a prompt other than "M-x" would be confusing,
1605 ;; because "M-x" is a well-known prompt to read a command
1606 ;; and it serves as a shorthand for "Extended command: ".
1608 (lambda (string pred action
)
1610 (if (memq action
'(nil t
))
1611 ;; Exclude obsolete commands from completions.
1613 (and (funcall pred sym
)
1614 (or (equal string
(symbol-name sym
))
1615 (not (get sym
'byte-obsolete-info
)))))
1617 (complete-with-action action obarray string pred
)))
1618 #'commandp t nil
'extended-command-history
)))
1620 (defcustom suggest-key-bindings t
1621 "Non-nil means show the equivalent key-binding when M-x command has one.
1622 The value can be a length of time to show the message for.
1623 If the value is non-nil and not a number, we wait 2 seconds."
1625 :type
'(choice (const :tag
"off" nil
)
1626 (integer :tag
"time" 2)
1629 (defun execute-extended-command--shorter-1 (name length
)
1631 ((zerop length
) (list ""))
1632 ((equal name
"") nil
)
1634 (nconc (mapcar (lambda (s) (concat (substring name
0 1) s
))
1635 (execute-extended-command--shorter-1
1636 (substring name
1) (1- length
)))
1637 (when (string-match "\\`\\(-\\)?[^-]*" name
)
1638 (execute-extended-command--shorter-1
1639 (substring name
(match-end 0)) length
))))))
1641 (defun execute-extended-command--shorter (name typed
)
1642 (let ((candidates '())
1643 (max (length typed
))
1646 (while (and (not binding
)
1650 (setq candidates
(execute-extended-command--shorter-1
1652 ;; Don't show the help message if the binding isn't
1653 ;; significantly shorter than the M-x command the user typed.
1655 (let ((candidate (pop candidates
)))
1657 (car-safe (completion-try-completion
1658 candidate obarray
'commandp len
)))
1659 (setq binding candidate
))))
1662 (defun execute-extended-command (prefixarg &optional command-name typed
)
1663 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1664 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1665 "Read a command name, then read the arguments and call the command.
1666 To pass a prefix argument to the command you are
1667 invoking, give a prefix argument to `execute-extended-command'."
1668 (declare (interactive-only command-execute
))
1669 ;; FIXME: Remember the actual text typed by the user before completion,
1670 ;; so that we don't later on suggest the same shortening.
1672 (let ((execute-extended-command--last-typed nil
))
1673 (list current-prefix-arg
1674 (read-extended-command)
1675 execute-extended-command--last-typed
)))
1676 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1677 (unless command-name
1678 (let ((current-prefix-arg prefixarg
) ; for prompt
1679 (execute-extended-command--last-typed nil
))
1680 (setq command-name
(read-extended-command))
1681 (setq typed execute-extended-command--last-typed
)))
1682 (let* ((function (and (stringp command-name
) (intern-soft command-name
)))
1683 (binding (and suggest-key-bindings
1684 (not executing-kbd-macro
)
1685 (where-is-internal function overriding-local-map t
))))
1686 (unless (commandp function
)
1687 (error "`%s' is not a valid command name" command-name
))
1688 (setq this-command function
)
1689 ;; Normally `real-this-command' should never be changed, but here we really
1690 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1691 ;; binding" for <cmd>, so the command the user really wanted to run is
1692 ;; `function' and not `execute-extended-command'. The difference is
1693 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1694 (setq real-this-command function
)
1695 (let ((prefix-arg prefixarg
))
1696 (command-execute function
'record
))
1697 ;; If enabled, show which key runs this command.
1698 ;; But first wait, and skip the message if there is input.
1700 ;; If this command displayed something in the echo area;
1701 ;; wait a few seconds, then display our suggestion message.
1702 ;; FIXME: Wait *after* running post-command-hook!
1703 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1704 ;; find a better answer anyway!
1705 (when suggest-key-bindings
1707 ((zerop (length (current-message))) 0)
1708 ((numberp suggest-key-bindings
) suggest-key-bindings
)
1710 (when (and waited
(not (consp unread-command-events
)))
1711 (unless (or binding executing-kbd-macro
(not (symbolp function
))
1712 (<= (length (symbol-name function
)) 2))
1713 ;; There's no binding for CMD. Let's try and find the shortest
1714 ;; string to use in M-x.
1715 ;; FIXME: Can be slow. Cache it maybe?
1717 (setq binding
(execute-extended-command--shorter
1718 (symbol-name function
) typed
))))
1721 (format-message "You can run the command `%s' with %s"
1723 (if (stringp binding
)
1724 (concat "M-x " binding
" RET")
1725 (key-description binding
)))
1726 (sit-for (if (numberp suggest-key-bindings
)
1727 suggest-key-bindings
1730 (defun command-execute (cmd &optional record-flag keys special
)
1731 ;; BEWARE: Called directly from the C code.
1732 "Execute CMD as an editor command.
1733 CMD must be a symbol that satisfies the `commandp' predicate.
1734 Optional second arg RECORD-FLAG non-nil
1735 means unconditionally put this command in the variable `command-history'.
1736 Otherwise, that is done only if an arg is read using the minibuffer.
1737 The argument KEYS specifies the value to use instead of (this-command-keys)
1738 when reading the arguments; if it is nil, (this-command-keys) is used.
1739 The argument SPECIAL, if non-nil, means that this command is executing
1740 a special event, so ignore the prefix argument and don't clear it."
1741 (setq debug-on-next-call nil
)
1742 (let ((prefixarg (unless special
1743 ;; FIXME: This should probably be done around
1744 ;; pre-command-hook rather than here!
1746 (setq current-prefix-arg prefix-arg
)
1747 (setq prefix-arg nil
)
1748 (when current-prefix-arg
1749 (prefix-command-update))))))
1750 (if (and (symbolp cmd
)
1752 disabled-command-function
)
1753 ;; FIXME: Weird calling convention!
1754 (run-hooks 'disabled-command-function
)
1758 (setq final
(indirect-function final
))
1759 (if (autoloadp final
)
1760 (setq final
(autoload-do-load final cmd
)))))
1763 ;; If requested, place the macro in the command history. For
1764 ;; other sorts of commands, call-interactively takes care of this.
1766 (push `(execute-kbd-macro ,final
,prefixarg
) command-history
)
1767 ;; Don't keep command history around forever.
1768 (when (and (numberp history-length
) (> history-length
0))
1769 (let ((cell (nthcdr history-length command-history
)))
1770 (if (consp cell
) (setcdr cell nil
)))))
1771 (execute-kbd-macro final prefixarg
))
1773 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1774 (prog1 (call-interactively cmd record-flag keys
)
1775 (when (and (symbolp cmd
)
1776 (get cmd
'byte-obsolete-info
)
1777 (not (get cmd
'command-execute-obsolete-warned
)))
1778 (put cmd
'command-execute-obsolete-warned t
)
1779 (message "%s" (macroexp--obsolete-warning
1780 cmd
(get cmd
'byte-obsolete-info
) "command"))))))))))
1782 (defvar minibuffer-history nil
1783 "Default minibuffer history list.
1784 This is used for all minibuffer input
1785 except when an alternate history list is specified.
1787 Maximum length of the history list is determined by the value
1788 of `history-length', which see.")
1789 (defvar minibuffer-history-sexp-flag nil
1790 "Control whether history list elements are expressions or strings.
1791 If the value of this variable equals current minibuffer depth,
1792 they are expressions; otherwise they are strings.
1793 \(That convention is designed to do the right thing for
1794 recursive uses of the minibuffer.)")
1795 (setq minibuffer-history-variable
'minibuffer-history
)
1796 (setq minibuffer-history-position nil
) ;; Defvar is in C code.
1797 (defvar minibuffer-history-search-history nil
)
1799 (defvar minibuffer-text-before-history nil
1800 "Text that was in this minibuffer before any history commands.
1801 This is nil if there have not yet been any history commands
1802 in this use of the minibuffer.")
1804 (add-hook 'minibuffer-setup-hook
'minibuffer-history-initialize
)
1806 (defun minibuffer-history-initialize ()
1807 (setq minibuffer-text-before-history nil
))
1809 (defun minibuffer-avoid-prompt (_new _old
)
1810 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1811 (declare (obsolete cursor-intangible-mode
"25.1"))
1812 (constrain-to-field nil
(point-max)))
1814 (defcustom minibuffer-history-case-insensitive-variables nil
1815 "Minibuffer history variables for which matching should ignore case.
1816 If a history variable is a member of this list, then the
1817 \\[previous-matching-history-element] and \\[next-matching-history-element]\
1818 commands ignore case when searching it, regardless of `case-fold-search'."
1819 :type
'(repeat variable
)
1822 (defun previous-matching-history-element (regexp n
)
1823 "Find the previous history element that matches REGEXP.
1824 \(Previous history elements refer to earlier actions.)
1825 With prefix argument N, search for Nth previous match.
1826 If N is negative, find the next or Nth next match.
1827 Normally, history elements are matched case-insensitively if
1828 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1829 makes the search case-sensitive.
1830 See also `minibuffer-history-case-insensitive-variables'."
1832 (let* ((enable-recursive-minibuffers t
)
1833 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1835 minibuffer-local-map
1837 'minibuffer-history-search-history
1838 (car minibuffer-history-search-history
))))
1839 ;; Use the last regexp specified, by default, if input is empty.
1840 (list (if (string= regexp
"")
1841 (if minibuffer-history-search-history
1842 (car minibuffer-history-search-history
)
1843 (user-error "No previous history search regexp"))
1845 (prefix-numeric-value current-prefix-arg
))))
1847 (if (and (zerop minibuffer-history-position
)
1848 (null minibuffer-text-before-history
))
1849 (setq minibuffer-text-before-history
1850 (minibuffer-contents-no-properties)))
1851 (let ((history (symbol-value minibuffer-history-variable
))
1853 (if (isearch-no-upper-case-p regexp t
) ; assume isearch.el is dumped
1854 ;; On some systems, ignore case for file names.
1855 (if (memq minibuffer-history-variable
1856 minibuffer-history-case-insensitive-variables
)
1858 ;; Respect the user's setting for case-fold-search:
1864 (pos minibuffer-history-position
))
1867 (setq pos
(min (max 1 (+ pos
(if (< n
0) -
1 1))) (length history
)))
1868 (when (= pos prevpos
)
1869 (user-error (if (= pos
1)
1870 "No later matching history item"
1871 "No earlier matching history item")))
1873 (if (eq minibuffer-history-sexp-flag
(minibuffer-depth))
1874 (let ((print-level nil
))
1875 (prin1-to-string (nth (1- pos
) history
)))
1876 (nth (1- pos
) history
)))
1879 (and (string-match regexp match-string
)
1881 (and (string-match (concat ".*\\(" regexp
"\\)") match-string
)
1882 (match-beginning 1))))
1884 (setq n
(+ n
(if (< n
0) 1 -
1)))))
1885 (setq minibuffer-history-position pos
)
1886 (goto-char (point-max))
1887 (delete-minibuffer-contents)
1888 (insert match-string
)
1889 (goto-char (+ (minibuffer-prompt-end) match-offset
))))
1890 (if (memq (car (car command-history
)) '(previous-matching-history-element
1891 next-matching-history-element
))
1892 (setq command-history
(cdr command-history
))))
1894 (defun next-matching-history-element (regexp n
)
1895 "Find the next history element that matches REGEXP.
1896 \(The next history element refers to a more recent action.)
1897 With prefix argument N, search for Nth next match.
1898 If N is negative, find the previous or Nth previous match.
1899 Normally, history elements are matched case-insensitively if
1900 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1901 makes the search case-sensitive."
1903 (let* ((enable-recursive-minibuffers t
)
1904 (regexp (read-from-minibuffer "Next element matching (regexp): "
1906 minibuffer-local-map
1908 'minibuffer-history-search-history
1909 (car minibuffer-history-search-history
))))
1910 ;; Use the last regexp specified, by default, if input is empty.
1911 (list (if (string= regexp
"")
1912 (if minibuffer-history-search-history
1913 (car minibuffer-history-search-history
)
1914 (user-error "No previous history search regexp"))
1916 (prefix-numeric-value current-prefix-arg
))))
1917 (previous-matching-history-element regexp
(- n
)))
1919 (defvar minibuffer-temporary-goal-position nil
)
1921 (defvar minibuffer-default-add-function
'minibuffer-default-add-completions
1922 "Function run by `goto-history-element' before consuming default values.
1923 This is useful to dynamically add more elements to the list of default values
1924 when `goto-history-element' reaches the end of this list.
1925 Before calling this function `goto-history-element' sets the variable
1926 `minibuffer-default-add-done' to t, so it will call this function only
1927 once. In special cases, when this function needs to be called more
1928 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1929 overriding the setting of this variable to t in `goto-history-element'.")
1931 (defvar minibuffer-default-add-done nil
1932 "When nil, add more elements to the end of the list of default values.
1933 The value nil causes `goto-history-element' to add more elements to
1934 the list of defaults when it reaches the end of this list. It does
1935 this by calling a function defined by `minibuffer-default-add-function'.")
1937 (make-variable-buffer-local 'minibuffer-default-add-done
)
1939 (defun minibuffer-default-add-completions ()
1940 "Return a list of all completions without the default value.
1941 This function is used to add all elements of the completion table to
1942 the end of the list of defaults just after the default value."
1943 (let ((def minibuffer-default
)
1944 (all (all-completions ""
1945 minibuffer-completion-table
1946 minibuffer-completion-predicate
)))
1949 (cons def
(delete def all
)))))
1951 (defun goto-history-element (nabs)
1952 "Puts element of the minibuffer history in the minibuffer.
1953 The argument NABS specifies the absolute history position."
1955 (when (and (not minibuffer-default-add-done
)
1956 (functionp minibuffer-default-add-function
)
1957 (< nabs
(- (if (listp minibuffer-default
)
1958 (length minibuffer-default
)
1960 (setq minibuffer-default-add-done t
1961 minibuffer-default
(funcall minibuffer-default-add-function
)))
1962 (let ((minimum (if minibuffer-default
1963 (- (if (listp minibuffer-default
)
1964 (length minibuffer-default
)
1967 elt minibuffer-returned-to-present
)
1968 (if (and (zerop minibuffer-history-position
)
1969 (null minibuffer-text-before-history
))
1970 (setq minibuffer-text-before-history
1971 (minibuffer-contents-no-properties)))
1972 (if (< nabs minimum
)
1973 (user-error (if minibuffer-default
1974 "End of defaults; no next item"
1975 "End of history; no default available")))
1976 (if (> nabs
(if (listp (symbol-value minibuffer-history-variable
))
1977 (length (symbol-value minibuffer-history-variable
))
1979 (user-error "Beginning of history; no preceding item"))
1980 (unless (memq last-command
'(next-history-element
1981 previous-history-element
))
1982 (let ((prompt-end (minibuffer-prompt-end)))
1983 (set (make-local-variable 'minibuffer-temporary-goal-position
)
1984 (cond ((<= (point) prompt-end
) prompt-end
)
1987 (goto-char (point-max))
1988 (delete-minibuffer-contents)
1989 (setq minibuffer-history-position nabs
)
1991 (setq elt
(if (listp minibuffer-default
)
1992 (nth (1- (abs nabs
)) minibuffer-default
)
1993 minibuffer-default
)))
1995 (setq elt
(or minibuffer-text-before-history
""))
1996 (setq minibuffer-returned-to-present t
)
1997 (setq minibuffer-text-before-history nil
))
1998 (t (setq elt
(nth (1- minibuffer-history-position
)
1999 (symbol-value minibuffer-history-variable
)))))
2001 (if (and (eq minibuffer-history-sexp-flag
(minibuffer-depth))
2002 (not minibuffer-returned-to-present
))
2003 (let ((print-level nil
))
2004 (prin1-to-string elt
))
2006 (goto-char (or minibuffer-temporary-goal-position
(point-max)))))
2008 (defun next-history-element (n)
2009 "Puts next element of the minibuffer history in the minibuffer.
2010 With argument N, it uses the Nth following element."
2013 (goto-history-element (- minibuffer-history-position n
))))
2015 (defun previous-history-element (n)
2016 "Puts previous element of the minibuffer history in the minibuffer.
2017 With argument N, it uses the Nth previous element."
2020 (goto-history-element (+ minibuffer-history-position n
))))
2022 (defun next-line-or-history-element (&optional arg
)
2023 "Move cursor vertically down ARG lines, or to the next history element.
2024 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2025 next element of the minibuffer history in the minibuffer."
2027 (or arg
(setq arg
1))
2028 (let* ((old-point (point))
2029 ;; Remember the original goal column of possibly multi-line input
2030 ;; excluding the length of the prompt on the first line.
2031 (prompt-end (minibuffer-prompt-end))
2032 (old-column (unless (and (eolp) (> (point) prompt-end
))
2033 (if (= (line-number-at-pos) 1)
2034 (max (- (current-column) (1- prompt-end
)) 0)
2035 (current-column)))))
2040 ;; Restore old position since `line-move-visual' moves point to
2041 ;; the end of the line when it fails to go to the next line.
2042 (goto-char old-point
)
2043 (next-history-element arg
)
2044 ;; Reset `temporary-goal-column' because a correct value is not
2045 ;; calculated when `next-line' above fails by bumping against
2046 ;; the bottom of the minibuffer (bug#22544).
2047 (setq temporary-goal-column
0)
2048 ;; Restore the original goal column on the last line
2049 ;; of possibly multi-line input.
2050 (goto-char (point-max))
2052 (if (= (line-number-at-pos) 1)
2053 (move-to-column (+ old-column
(1- (minibuffer-prompt-end))))
2054 (move-to-column old-column
)))))))
2056 (defun previous-line-or-history-element (&optional arg
)
2057 "Move cursor vertically up ARG lines, or to the previous history element.
2058 When point moves over the top line of multi-line minibuffer, puts ARGth
2059 previous element of the minibuffer history in the minibuffer."
2061 (or arg
(setq arg
1))
2062 (let* ((old-point (point))
2063 ;; Remember the original goal column of possibly multi-line input
2064 ;; excluding the length of the prompt on the first line.
2065 (prompt-end (minibuffer-prompt-end))
2066 (old-column (unless (and (eolp) (> (point) prompt-end
))
2067 (if (= (line-number-at-pos) 1)
2068 (max (- (current-column) (1- prompt-end
)) 0)
2069 (current-column)))))
2072 (previous-line arg
))
2073 (beginning-of-buffer
2074 ;; Restore old position since `line-move-visual' moves point to
2075 ;; the beginning of the line when it fails to go to the previous line.
2076 (goto-char old-point
)
2077 (previous-history-element arg
)
2078 ;; Reset `temporary-goal-column' because a correct value is not
2079 ;; calculated when `previous-line' above fails by bumping against
2080 ;; the top of the minibuffer (bug#22544).
2081 (setq temporary-goal-column
0)
2082 ;; Restore the original goal column on the first line
2083 ;; of possibly multi-line input.
2084 (goto-char (minibuffer-prompt-end))
2086 (if (= (line-number-at-pos) 1)
2087 (move-to-column (+ old-column
(1- (minibuffer-prompt-end))))
2088 (move-to-column old-column
))
2089 ;; Put the cursor at the end of the visual line instead of the
2090 ;; logical line, so the next `previous-line-or-history-element'
2091 ;; would move to the previous history element, not to a possible upper
2092 ;; visual line from the end of logical line in `line-move-visual' mode.
2093 (end-of-visual-line)
2094 ;; Since `end-of-visual-line' puts the cursor at the beginning
2095 ;; of the next visual line, move it one char back to the end
2096 ;; of the first visual line (bug#22544).
2097 (unless (eolp) (backward-char 1)))))))
2099 (defun next-complete-history-element (n)
2100 "Get next history element which completes the minibuffer before the point.
2101 The contents of the minibuffer after the point are deleted, and replaced
2102 by the new completion."
2104 (let ((point-at-start (point)))
2105 (next-matching-history-element
2107 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
2109 ;; next-matching-history-element always puts us at (point-min).
2110 ;; Move to the position we were at before changing the buffer contents.
2111 ;; This is still sensible, because the text before point has not changed.
2112 (goto-char point-at-start
)))
2114 (defun previous-complete-history-element (n)
2116 Get previous history element which completes the minibuffer before the point.
2117 The contents of the minibuffer after the point are deleted, and replaced
2118 by the new completion."
2120 (next-complete-history-element (- n
)))
2122 ;; For compatibility with the old subr of the same name.
2123 (defun minibuffer-prompt-width ()
2124 "Return the display width of the minibuffer prompt.
2125 Return 0 if current buffer is not a minibuffer."
2126 ;; Return the width of everything before the field at the end of
2127 ;; the buffer; this should be 0 for normal buffers.
2128 (1- (minibuffer-prompt-end)))
2130 ;; isearch minibuffer history
2131 (add-hook 'minibuffer-setup-hook
'minibuffer-history-isearch-setup
)
2133 (defvar minibuffer-history-isearch-message-overlay
)
2134 (make-variable-buffer-local 'minibuffer-history-isearch-message-overlay
)
2136 (defun minibuffer-history-isearch-setup ()
2137 "Set up a minibuffer for using isearch to search the minibuffer history.
2138 Intended to be added to `minibuffer-setup-hook'."
2139 (set (make-local-variable 'isearch-search-fun-function
)
2140 'minibuffer-history-isearch-search
)
2141 (set (make-local-variable 'isearch-message-function
)
2142 'minibuffer-history-isearch-message
)
2143 (set (make-local-variable 'isearch-wrap-function
)
2144 'minibuffer-history-isearch-wrap
)
2145 (set (make-local-variable 'isearch-push-state-function
)
2146 'minibuffer-history-isearch-push-state
)
2147 (add-hook 'isearch-mode-end-hook
'minibuffer-history-isearch-end nil t
))
2149 (defun minibuffer-history-isearch-end ()
2150 "Clean up the minibuffer after terminating isearch in the minibuffer."
2151 (if minibuffer-history-isearch-message-overlay
2152 (delete-overlay minibuffer-history-isearch-message-overlay
)))
2154 (defun minibuffer-history-isearch-search ()
2155 "Return the proper search function, for isearch in minibuffer history."
2156 (lambda (string bound noerror
)
2158 ;; Use standard functions to search within minibuffer text
2159 (isearch-search-fun-default))
2161 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2162 ;; searching forward. Lazy-highlight calls this lambda with the
2163 ;; bound arg, so skip the minibuffer prompt.
2164 (if (and bound isearch-forward
(< (point) (minibuffer-prompt-end)))
2165 (goto-char (minibuffer-prompt-end)))
2167 ;; 1. First try searching in the initial minibuffer text
2168 (funcall search-fun string
2169 (if isearch-forward bound
(minibuffer-prompt-end))
2171 ;; 2. If the above search fails, start putting next/prev history
2172 ;; elements in the minibuffer successively, and search the string
2173 ;; in them. Do this only when bound is nil (i.e. not while
2174 ;; lazy-highlighting search strings in the current minibuffer text).
2179 (cond (isearch-forward
2180 (next-history-element 1)
2181 (goto-char (minibuffer-prompt-end)))
2183 (previous-history-element 1)
2184 (goto-char (point-max))))
2185 (setq isearch-barrier
(point) isearch-opoint
(point))
2186 ;; After putting the next/prev history element, search
2187 ;; the string in them again, until next-history-element
2188 ;; or previous-history-element raises an error at the
2189 ;; beginning/end of history.
2190 (setq found
(funcall search-fun string
2191 (unless isearch-forward
2192 ;; For backward search, don't search
2193 ;; in the minibuffer prompt
2194 (minibuffer-prompt-end))
2196 ;; Return point of the new search result
2198 ;; Return nil when next(prev)-history-element fails
2201 (defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis
)
2202 "Display the minibuffer history search prompt.
2203 If there are no search errors, this function displays an overlay with
2204 the isearch prompt which replaces the original minibuffer prompt.
2205 Otherwise, it displays the standard isearch message returned from
2206 the function `isearch-message'."
2207 (if (not (and (minibufferp) isearch-success
(not isearch-error
)))
2208 ;; Use standard function `isearch-message' when not in the minibuffer,
2209 ;; or search fails, or has an error (like incomplete regexp).
2210 ;; This function overwrites minibuffer text with isearch message,
2211 ;; so it's possible to see what is wrong in the search string.
2212 (isearch-message c-q-hack ellipsis
)
2213 ;; Otherwise, put the overlay with the standard isearch prompt over
2214 ;; the initial minibuffer prompt.
2215 (if (overlayp minibuffer-history-isearch-message-overlay
)
2216 (move-overlay minibuffer-history-isearch-message-overlay
2217 (point-min) (minibuffer-prompt-end))
2218 (setq minibuffer-history-isearch-message-overlay
2219 (make-overlay (point-min) (minibuffer-prompt-end)))
2220 (overlay-put minibuffer-history-isearch-message-overlay
'evaporate t
))
2221 (overlay-put minibuffer-history-isearch-message-overlay
2222 'display
(isearch-message-prefix c-q-hack ellipsis
))
2223 ;; And clear any previous isearch message.
2226 (defun minibuffer-history-isearch-wrap ()
2227 "Wrap the minibuffer history search when search fails.
2228 Move point to the first history element for a forward search,
2229 or to the last history element for a backward search."
2230 ;; When `minibuffer-history-isearch-search' fails on reaching the
2231 ;; beginning/end of the history, wrap the search to the first/last
2232 ;; minibuffer history element.
2234 (goto-history-element (length (symbol-value minibuffer-history-variable
)))
2235 (goto-history-element 0))
2236 (setq isearch-success t
)
2237 (goto-char (if isearch-forward
(minibuffer-prompt-end) (point-max))))
2239 (defun minibuffer-history-isearch-push-state ()
2240 "Save a function restoring the state of minibuffer history search.
2241 Save `minibuffer-history-position' to the additional state parameter
2242 in the search status stack."
2243 (let ((pos minibuffer-history-position
))
2245 (minibuffer-history-isearch-pop-state cmd pos
))))
2247 (defun minibuffer-history-isearch-pop-state (_cmd hist-pos
)
2248 "Restore the minibuffer history search state.
2249 Go to the history element by the absolute history position HIST-POS."
2250 (goto-history-element hist-pos
))
2253 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2254 (define-obsolete-function-alias 'advertised-undo
'undo
"23.2")
2256 (defconst undo-equiv-table
(make-hash-table :test
'eq
:weakness t
)
2257 "Table mapping redo records to the corresponding undo one.
2258 A redo record for undo-in-region maps to t.
2259 A redo record for ordinary undo maps to the following (earlier) undo.")
2261 (defvar undo-in-region nil
2262 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
2264 (defvar undo-no-redo nil
2265 "If t, `undo' doesn't go through redo entries.")
2267 (defvar pending-undo-list nil
2268 "Within a run of consecutive undo commands, list remaining to be undone.
2269 If t, we undid all the way to the end of it.")
2271 (defun undo (&optional arg
)
2272 "Undo some previous changes.
2273 Repeat this command to undo more changes.
2274 A numeric ARG serves as a repeat count.
2276 In Transient Mark mode when the mark is active, only undo changes within
2277 the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
2278 as an argument limits undo to changes within the current region."
2280 ;; Make last-command indicate for the next command that this was an undo.
2281 ;; That way, another undo will undo more.
2282 ;; If we get to the end of the undo history and get an error,
2283 ;; another undo command will find the undo history empty
2284 ;; and will get another error. To begin undoing the undos,
2285 ;; you must type some other command.
2286 (let* ((modified (buffer-modified-p))
2287 ;; For an indirect buffer, look in the base buffer for the
2289 (base-buffer (or (buffer-base-buffer) (current-buffer)))
2290 (recent-save (with-current-buffer base-buffer
2291 (recent-auto-save-p)))
2293 ;; If we get an error in undo-start,
2294 ;; the next command should not be a "consecutive undo".
2295 ;; So set `this-command' to something other than `undo'.
2296 (setq this-command
'undo-start
)
2298 (unless (and (eq last-command
'undo
)
2299 (or (eq pending-undo-list t
)
2300 ;; If something (a timer or filter?) changed the buffer
2301 ;; since the previous command, don't continue the undo seq.
2302 (let ((list buffer-undo-list
))
2303 (while (eq (car list
) nil
)
2304 (setq list
(cdr list
)))
2305 ;; If the last undo record made was made by undo
2306 ;; it shows nothing else happened in between.
2307 (gethash list undo-equiv-table
))))
2308 (setq undo-in-region
2309 (or (region-active-p) (and arg
(not (numberp arg
)))))
2311 (undo-start (region-beginning) (region-end))
2313 ;; get rid of initial undo boundary
2315 ;; If we got this far, the next command should be a consecutive undo.
2316 (setq this-command
'undo
)
2317 ;; Check to see whether we're hitting a redo record, and if
2318 ;; so, ask the user whether she wants to skip the redo/undo pair.
2319 (let ((equiv (gethash pending-undo-list undo-equiv-table
)))
2320 (or (eq (selected-window) (minibuffer-window))
2321 (setq message
(format "%s%s!"
2322 (if (or undo-no-redo
(not equiv
))
2324 (if undo-in-region
" in region" ""))))
2325 (when (and (consp equiv
) undo-no-redo
)
2326 ;; The equiv entry might point to another redo record if we have done
2327 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2328 (while (let ((next (gethash equiv undo-equiv-table
)))
2329 (if next
(setq equiv next
))))
2330 (setq pending-undo-list equiv
)))
2333 (prefix-numeric-value arg
)
2335 ;; Record the fact that the just-generated undo records come from an
2336 ;; undo operation--that is, they are redo records.
2337 ;; In the ordinary case (not within a region), map the redo
2338 ;; record to the following undos.
2339 ;; I don't know how to do that in the undo-in-region case.
2340 (let ((list buffer-undo-list
))
2341 ;; Strip any leading undo boundaries there might be, like we do
2342 ;; above when checking.
2343 (while (eq (car list
) nil
)
2344 (setq list
(cdr list
)))
2346 ;; Prevent identity mapping. This can happen if
2347 ;; consecutive nils are erroneously in undo list.
2348 (if (or undo-in-region
(eq list pending-undo-list
))
2352 ;; Don't specify a position in the undo record for the undo command.
2353 ;; Instead, undoing this should move point to where the change is.
2354 (let ((tail buffer-undo-list
)
2357 (when (integerp (car tail
))
2358 (let ((pos (car tail
)))
2360 (setcdr prev
(cdr tail
))
2361 (setq buffer-undo-list
(cdr tail
)))
2362 (setq tail
(cdr tail
))
2364 (if (eq pos
(car tail
))
2366 (setcdr prev
(cdr tail
))
2367 (setq buffer-undo-list
(cdr tail
)))
2369 (setq tail
(cdr tail
)))
2371 (setq prev tail tail
(cdr tail
))))
2372 ;; Record what the current undo list says,
2373 ;; so the next command can tell if the buffer was modified in between.
2374 (and modified
(not (buffer-modified-p))
2375 (with-current-buffer base-buffer
2376 (delete-auto-save-file-if-necessary recent-save
)))
2377 ;; Display a message announcing success.
2379 (message "%s" message
))))
2381 (defun buffer-disable-undo (&optional buffer
)
2382 "Make BUFFER stop keeping undo information.
2383 No argument or nil as argument means do this for the current buffer."
2385 (with-current-buffer (if buffer
(get-buffer buffer
) (current-buffer))
2386 (setq buffer-undo-list t
)))
2388 (defun undo-only (&optional arg
)
2389 "Undo some previous changes.
2390 Repeat this command to undo more changes.
2391 A numeric ARG serves as a repeat count.
2392 Contrary to `undo', this will not redo a previous undo."
2394 (let ((undo-no-redo t
)) (undo arg
)))
2396 (defvar undo-in-progress nil
2397 "Non-nil while performing an undo.
2398 Some change-hooks test this variable to do something different.")
2400 (defun undo-more (n)
2401 "Undo back N undo-boundaries beyond what was already undone recently.
2402 Call `undo-start' to get ready to undo recent changes,
2403 then call `undo-more' one or more times to undo them."
2404 (or (listp pending-undo-list
)
2405 (user-error (concat "No further undo information"
2406 (and undo-in-region
" for region"))))
2407 (let ((undo-in-progress t
))
2408 ;; Note: The following, while pulling elements off
2409 ;; `pending-undo-list' will call primitive change functions which
2410 ;; will push more elements onto `buffer-undo-list'.
2411 (setq pending-undo-list
(primitive-undo n pending-undo-list
))
2412 (if (null pending-undo-list
)
2413 (setq pending-undo-list t
))))
2415 (defun primitive-undo (n list
)
2416 "Undo N records from the front of the list LIST.
2417 Return what remains of the list."
2419 ;; This is a good feature, but would make undo-start
2420 ;; unable to do what is expected.
2421 ;;(when (null (car (list)))
2422 ;; ;; If the head of the list is a boundary, it is the boundary
2423 ;; ;; preceding this command. Get rid of it and don't count it.
2424 ;; (setq list (cdr list))))
2427 ;; In a writable buffer, enable undoing read-only text that is
2428 ;; so because of text properties.
2429 (inhibit-read-only t
)
2430 ;; Don't let `intangible' properties interfere with undo.
2431 (inhibit-point-motion-hooks t
)
2432 ;; We use oldlist only to check for EQ. ++kfs
2433 (oldlist buffer-undo-list
)
2437 (while (setq next
(pop list
)) ;Exit inner loop at undo boundary.
2438 ;; Handle an integer by setting point to that value.
2440 ((pred integerp
) (goto-char next
))
2441 ;; Element (t . TIME) records previous modtime.
2442 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2443 ;; UNKNOWN_MODTIME_NSECS.
2445 ;; If this records an obsolete save
2446 ;; (not matching the actual disk file)
2447 ;; then don't mark unmodified.
2448 (when (or (equal time
(visited-file-modtime))
2450 (equal (list (car time
) (cdr time
))
2451 (visited-file-modtime))))
2452 (when (fboundp 'unlock-buffer
)
2454 (set-buffer-modified-p nil
)))
2455 ;; Element (nil PROP VAL BEG . END) is property change.
2456 (`(nil .
,(or `(,prop
,val
,beg .
,end
) pcase--dontcare
))
2457 (when (or (> (point-min) beg
) (< (point-max) end
))
2458 (error "Changes to be undone are outside visible portion of buffer"))
2459 (put-text-property beg end prop val
))
2460 ;; Element (BEG . END) means range was inserted.
2461 (`(,(and beg
(pred integerp
)) .
,(and end
(pred integerp
)))
2462 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2463 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2464 (when (or (> (point-min) beg
) (< (point-max) end
))
2465 (error "Changes to be undone are outside visible portion of buffer"))
2466 ;; Set point first thing, so that undoing this undo
2467 ;; does not send point back to where it is now.
2469 (delete-region beg end
))
2470 ;; Element (apply FUN . ARGS) means call FUN to undo.
2471 (`(apply .
,fun-args
)
2472 (let ((currbuff (current-buffer)))
2473 (if (integerp (car fun-args
))
2474 ;; Long format: (apply DELTA START END FUN . ARGS).
2475 (pcase-let* ((`(,delta
,start
,end
,fun .
,args
) fun-args
)
2476 (start-mark (copy-marker start nil
))
2477 (end-mark (copy-marker end t
)))
2478 (when (or (> (point-min) start
) (< (point-max) end
))
2479 (error "Changes to be undone are outside visible portion of buffer"))
2480 (apply fun args
) ;; Use `save-current-buffer'?
2481 ;; Check that the function did what the entry
2482 ;; said it would do.
2483 (unless (and (= start start-mark
)
2484 (= (+ delta end
) end-mark
))
2485 (error "Changes to be undone by function different than announced"))
2486 (set-marker start-mark nil
)
2487 (set-marker end-mark nil
))
2489 (unless (eq currbuff
(current-buffer))
2490 (error "Undo function switched buffer"))
2491 (setq did-apply t
)))
2492 ;; Element (STRING . POS) means STRING was deleted.
2493 (`(,(and string
(pred stringp
)) .
,(and pos
(pred integerp
)))
2494 (when (let ((apos (abs pos
)))
2495 (or (< apos
(point-min)) (> apos
(point-max))))
2496 (error "Changes to be undone are outside visible portion of buffer"))
2497 (let (valid-marker-adjustments)
2498 ;; Check that marker adjustments which were recorded
2499 ;; with the (STRING . POS) record are still valid, ie
2500 ;; the markers haven't moved. We check their validity
2501 ;; before reinserting the string so as we don't need to
2502 ;; mind marker insertion-type.
2503 (while (and (markerp (car-safe (car list
)))
2504 (integerp (cdr-safe (car list
))))
2505 (let* ((marker-adj (pop list
))
2506 (m (car marker-adj
)))
2507 (and (eq (marker-buffer m
) (current-buffer))
2509 (push marker-adj valid-marker-adjustments
))))
2510 ;; Insert string and adjust point
2518 ;; Adjust the valid marker adjustments
2519 (dolist (adj valid-marker-adjustments
)
2520 (set-marker (car adj
)
2521 (- (car adj
) (cdr adj
))))))
2522 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2523 (`(,(and marker
(pred markerp
)) .
,(and offset
(pred integerp
)))
2524 (warn "Encountered %S entry in undo list with no matching (TEXT . POS) entry"
2526 ;; Even though these elements are not expected in the undo
2527 ;; list, adjust them to be conservative for the 24.4
2528 ;; release. (Bug#16818)
2529 (when (marker-buffer marker
)
2532 (marker-buffer marker
))))
2533 (_ (error "Unrecognized entry in undo list %S" next
))))
2534 (setq arg
(1- arg
)))
2535 ;; Make sure an apply entry produces at least one undo entry,
2536 ;; so the test in `undo' for continuing an undo series
2539 (eq oldlist buffer-undo-list
))
2540 (setq buffer-undo-list
2541 (cons (list 'apply
'cdr nil
) buffer-undo-list
))))
2544 ;; Deep copy of a list
2545 (defun undo-copy-list (list)
2546 "Make a copy of undo list LIST."
2547 (mapcar 'undo-copy-list-1 list
))
2549 (defun undo-copy-list-1 (elt)
2551 (cons (car elt
) (undo-copy-list-1 (cdr elt
)))
2554 (defun undo-start (&optional beg end
)
2555 "Set `pending-undo-list' to the front of the undo list.
2556 The next call to `undo-more' will undo the most recently made change.
2557 If BEG and END are specified, then only undo elements
2558 that apply to text between BEG and END are used; other undo elements
2559 are ignored. If BEG and END are nil, all undo elements are used."
2560 (if (eq buffer-undo-list t
)
2561 (user-error "No undo information in this buffer"))
2562 (setq pending-undo-list
2563 (if (and beg end
(not (= beg end
)))
2564 (undo-make-selective-list (min beg end
) (max beg end
))
2567 ;; The positions given in elements of the undo list are the positions
2568 ;; as of the time that element was recorded to undo history. In
2569 ;; general, subsequent buffer edits render those positions invalid in
2570 ;; the current buffer, unless adjusted according to the intervening
2573 ;; Undo in region is a use case that requires adjustments to undo
2574 ;; elements. It must adjust positions of elements in the region based
2575 ;; on newer elements not in the region so as they may be correctly
2576 ;; applied in the current buffer. undo-make-selective-list
2577 ;; accomplishes this with its undo-deltas list of adjustments. An
2578 ;; example undo history from oldest to newest:
2581 ;; 123456789 buffer-undo-list undo-deltas
2582 ;; --------- ---------------- -----------
2583 ;; aaa (1 . 4) (1 . -3)
2584 ;; aaba (3 . 4) N/A (in region)
2585 ;; ccaaba (1 . 3) (1 . -2)
2586 ;; ccaabaddd (7 . 10) (7 . -3)
2587 ;; ccaabdd ("ad" . 6) (6 . 2)
2588 ;; ccaabaddd (6 . 8) (6 . -2)
2589 ;; | |<-- region: "caab", from 2 to 6
2591 ;; When the user starts a run of undos in region,
2592 ;; undo-make-selective-list is called to create the full list of in
2593 ;; region elements. Each element is adjusted forward chronologically
2594 ;; through undo-deltas to determine if it is in the region.
2596 ;; In the above example, the insertion of "b" is (3 . 4) in the
2597 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2598 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2599 ;; . 6) is assessed as in the region and placed in the selective list.
2600 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2601 ;; due to the selected element. The "b" insertion is the only element
2602 ;; fully in the region, so in this example undo-make-selective-list
2603 ;; returns (nil (5 . 6)).
2605 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2606 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2607 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2608 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2609 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2611 ;; More interesting is how to adjust the "ddd" insertion due to the
2612 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2613 ;; If the reinsertion was a manual retyping of "ad", then the total
2614 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2615 ;; the reinsertion was due to undo, one might expect the first "d"
2616 ;; character would again be a part of the "ddd" text, meaning its
2617 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2619 ;; undo-make-selective-list assumes in this situation that "ad" was a
2620 ;; new edit, even if it was inserted because of an undo.
2621 ;; Consequently, if the user undos in region "8 to 10" of the
2622 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2623 ;; "ccaabad", as though the first "d" became detached from the
2624 ;; original "ddd" insertion. This quirk is a FIXME.
2626 (defun undo-make-selective-list (start end
)
2627 "Return a list of undo elements for the region START to END.
2628 The elements come from `buffer-undo-list', but we keep only the
2629 elements inside this region, and discard those outside this
2630 region. The elements' positions are adjusted so as the returned
2631 list can be applied to the current buffer."
2632 (let ((ulist buffer-undo-list
)
2633 ;; A list of position adjusted undo elements in the region.
2634 (selective-list (list nil
))
2635 ;; A list of undo-deltas for out of region undo elements.
2640 (while (gethash ulist undo-equiv-table
)
2641 (setq ulist
(gethash ulist undo-equiv-table
))))
2642 (setq undo-elt
(car ulist
))
2645 ;; Don't put two nils together in the list
2646 (when (car selective-list
)
2647 (push nil selective-list
)))
2648 ((and (consp undo-elt
) (eq (car undo-elt
) t
))
2649 ;; This is a "was unmodified" element. Keep it
2650 ;; if we have kept everything thus far.
2651 (when (not undo-deltas
)
2652 (push undo-elt selective-list
)))
2653 ;; Skip over marker adjustments, instead relying
2654 ;; on finding them after (TEXT . POS) elements
2655 ((markerp (car-safe undo-elt
))
2658 (let ((adjusted-undo-elt (undo-adjust-elt undo-elt
2660 (if (undo-elt-in-region adjusted-undo-elt start end
)
2662 (setq end
(+ end
(cdr (undo-delta adjusted-undo-elt
))))
2663 (push adjusted-undo-elt selective-list
)
2664 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2665 ;; kept. primitive-undo may discard them later.
2666 (when (and (stringp (car-safe adjusted-undo-elt
))
2667 (integerp (cdr-safe adjusted-undo-elt
)))
2668 (let ((list-i (cdr ulist
)))
2669 (while (markerp (car-safe (car list-i
)))
2670 (push (pop list-i
) selective-list
)))))
2671 (let ((delta (undo-delta undo-elt
)))
2672 (when (/= 0 (cdr delta
))
2673 (push delta undo-deltas
)))))))
2675 (nreverse selective-list
)))
2677 (defun undo-elt-in-region (undo-elt start end
)
2678 "Determine whether UNDO-ELT falls inside the region START ... END.
2679 If it crosses the edge, we return nil.
2681 Generally this function is not useful for determining
2682 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2683 because markers can be arbitrarily relocated. Instead, pass the
2684 marker adjustment's corresponding (TEXT . POS) element."
2685 (cond ((integerp undo-elt
)
2686 (and (>= undo-elt start
)
2692 ((stringp (car undo-elt
))
2693 ;; (TEXT . POSITION)
2694 (and (>= (abs (cdr undo-elt
)) start
)
2695 (<= (abs (cdr undo-elt
)) end
)))
2696 ((and (consp undo-elt
) (markerp (car undo-elt
)))
2697 ;; (MARKER . ADJUSTMENT)
2698 (<= start
(car undo-elt
) end
))
2699 ((null (car undo-elt
))
2700 ;; (nil PROPERTY VALUE BEG . END)
2701 (let ((tail (nthcdr 3 undo-elt
)))
2702 (and (>= (car tail
) start
)
2703 (<= (cdr tail
) end
))))
2704 ((integerp (car undo-elt
))
2706 (and (>= (car undo-elt
) start
)
2707 (<= (cdr undo-elt
) end
)))))
2709 (defun undo-elt-crosses-region (undo-elt start end
)
2710 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2711 This assumes we have already decided that UNDO-ELT
2712 is not *inside* the region START...END."
2713 (declare (obsolete nil
"25.1"))
2714 (cond ((atom undo-elt
) nil
)
2715 ((null (car undo-elt
))
2716 ;; (nil PROPERTY VALUE BEG . END)
2717 (let ((tail (nthcdr 3 undo-elt
)))
2718 (and (< (car tail
) end
)
2719 (> (cdr tail
) start
))))
2720 ((integerp (car undo-elt
))
2722 (and (< (car undo-elt
) end
)
2723 (> (cdr undo-elt
) start
)))))
2725 (defun undo-adjust-elt (elt deltas
)
2726 "Return adjustment of undo element ELT by the undo DELTAS
2731 (undo-adjust-pos elt deltas
))
2733 (`(,(and beg
(pred integerp
)) .
,(and end
(pred integerp
)))
2734 (undo-adjust-beg-end beg end deltas
))
2735 ;; (TEXT . POSITION)
2736 (`(,(and text
(pred stringp
)) .
,(and pos
(pred integerp
)))
2737 (cons text
(* (if (< pos
0) -
1 1)
2738 (undo-adjust-pos (abs pos
) deltas
))))
2739 ;; (nil PROPERTY VALUE BEG . END)
2740 (`(nil .
,(or `(,prop
,val
,beg .
,end
) pcase--dontcare
))
2741 `(nil ,prop
,val .
,(undo-adjust-beg-end beg end deltas
)))
2742 ;; (apply DELTA START END FUN . ARGS)
2744 ;; All others return same elt
2747 ;; (BEG . END) can adjust to the same positions, commonly when an
2748 ;; insertion was undone and they are out of region, for example:
2751 ;; 123456789 buffer-undo-list undo-deltas
2752 ;; --------- ---------------- -----------
2754 ;; abbaa (2 . 4) (2 . -2)
2755 ;; aaa ("bb" . 2) (2 . 2)
2758 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2759 ;; undo. Further adjustments to such an element should be the same as
2760 ;; for (TEXT . POSITION) elements. The options are:
2762 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2763 ;; analogous to marker insertion-type t.
2765 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2766 ;; marker insertion-type nil.
2768 ;; There was no strong reason to prefer one or the other, except that
2769 ;; the first is more consistent with prior undo in region behavior.
2770 (defun undo-adjust-beg-end (beg end deltas
)
2771 "Return cons of adjustments to BEG and END by the undo DELTAS
2773 (let ((adj-beg (undo-adjust-pos beg deltas
)))
2774 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2776 (max adj-beg
(undo-adjust-pos end deltas t
)))))
2778 (defun undo-adjust-pos (pos deltas
&optional use-
<)
2779 "Return adjustment of POS by the undo DELTAS list, comparing
2780 with < or <= based on USE-<."
2781 (dolist (d deltas pos
)
2786 ;; Don't allow pos to become less than the undo-delta
2787 ;; position. This edge case is described in the overview
2789 (max (car d
) (- pos
(cdr d
)))))))
2791 ;; Return the first affected buffer position and the delta for an undo element
2792 ;; delta is defined as the change in subsequent buffer positions if we *did*
2794 (defun undo-delta (undo-elt)
2795 (if (consp undo-elt
)
2796 (cond ((stringp (car undo-elt
))
2797 ;; (TEXT . POSITION)
2798 (cons (abs (cdr undo-elt
)) (length (car undo-elt
))))
2799 ((integerp (car undo-elt
))
2801 (cons (car undo-elt
) (- (car undo-elt
) (cdr undo-elt
))))
2806 ;;; Default undo-boundary addition
2808 ;; This section adds a new undo-boundary at either after a command is
2809 ;; called or in some cases on a timer called after a change is made in
2811 (defvar-local undo-auto--last-boundary-cause nil
2812 "Describe the cause of the last undo-boundary.
2814 If `explicit', the last boundary was caused by an explicit call to
2815 `undo-boundary', that is one not called by the code in this
2818 If it is equal to `timer', then the last boundary was inserted
2819 by `undo-auto--boundary-timer'.
2821 If it is equal to `command', then the last boundary was inserted
2822 automatically after a command, that is by the code defined in
2825 If it is equal to a list, then the last boundary was inserted by
2826 an amalgamating command. The car of the list is the number of
2827 times an amalgamating command has been called, and the cdr are the
2828 buffers that were changed during the last command.")
2830 (defvar undo-auto-current-boundary-timer nil
2831 "Current timer which will run `undo-auto--boundary-timer' or nil.
2833 If set to non-nil, this will effectively disable the timer.")
2835 (defvar undo-auto--this-command-amalgamating nil
2836 "Non-nil if `this-command' should be amalgamated.
2837 This variable is set to nil by `undo-auto--boundaries' and is set
2838 by `undo-auto-amalgamate'." )
2840 (defun undo-auto--needs-boundary-p ()
2841 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2842 (car-safe buffer-undo-list
))
2844 (defun undo-auto--last-boundary-amalgamating-number ()
2845 "Return the number of amalgamating last commands or nil.
2846 Amalgamating commands are, by default, either
2847 `self-insert-command' and `delete-char', but can be any command
2848 that calls `undo-auto-amalgamate'."
2849 (car-safe undo-auto--last-boundary-cause
))
2851 (defun undo-auto--ensure-boundary (cause)
2852 "Add an `undo-boundary' to the current buffer if needed.
2853 REASON describes the reason that the boundary is being added; see
2854 `undo-auto--last-boundary' for more information."
2856 (undo-auto--needs-boundary-p))
2857 (let ((last-amalgamating
2858 (undo-auto--last-boundary-amalgamating-number)))
2860 (setq undo-auto--last-boundary-cause
2861 (if (eq 'amalgamate cause
)
2863 (if last-amalgamating
(1+ last-amalgamating
) 0)
2864 undo-auto--undoably-changed-buffers
)
2867 (defun undo-auto--boundaries (cause)
2868 "Check recently changed buffers and add a boundary if necessary.
2869 REASON describes the reason that the boundary is being added; see
2870 `undo-last-boundary' for more information."
2871 (dolist (b undo-auto--undoably-changed-buffers
)
2872 (when (buffer-live-p b
)
2873 (with-current-buffer b
2874 (undo-auto--ensure-boundary cause
))))
2875 (setq undo-auto--undoably-changed-buffers nil
))
2877 (defun undo-auto--boundary-timer ()
2878 "Timer which will run `undo--auto-boundary-timer'."
2879 (setq undo-auto-current-boundary-timer nil
)
2880 (undo-auto--boundaries 'timer
))
2882 (defun undo-auto--boundary-ensure-timer ()
2883 "Ensure that the `undo-auto-boundary-timer' is set."
2884 (unless undo-auto-current-boundary-timer
2885 (setq undo-auto-current-boundary-timer
2886 (run-at-time 10 nil
#'undo-auto--boundary-timer
))))
2888 (defvar undo-auto--undoably-changed-buffers nil
2889 "List of buffers that have changed recently.
2891 This list is maintained by `undo-auto--undoable-change' and
2892 `undo-auto--boundaries' and can be affected by changes to their
2895 See also `undo-auto--buffer-undoably-changed'.")
2897 (defun undo-auto--add-boundary ()
2898 "Add an `undo-boundary' in appropriate buffers."
2899 (undo-auto--boundaries
2900 (let ((amal undo-auto--this-command-amalgamating
))
2901 (setq undo-auto--this-command-amalgamating nil
)
2906 (defun undo-auto-amalgamate ()
2907 "Amalgamate undo if necessary.
2908 This function can be called before an amalgamating command. It
2909 removes the previous `undo-boundary' if a series of such calls
2910 have been made. By default `self-insert-command' and
2911 `delete-char' are the only amalgamating commands, although this
2912 function could be called by any command wishing to have this
2914 (let ((last-amalgamating-count
2915 (undo-auto--last-boundary-amalgamating-number)))
2916 (setq undo-auto--this-command-amalgamating t
)
2918 last-amalgamating-count
2921 (< last-amalgamating-count
20)
2922 (eq this-command last-command
))
2923 ;; Amalgamate all buffers that have changed.
2924 (dolist (b (cdr undo-auto--last-boundary-cause
))
2925 (when (buffer-live-p b
)
2926 (with-current-buffer
2929 ;; The head of `buffer-undo-list' is nil.
2930 ;; `car-safe' doesn't work because
2931 ;; `buffer-undo-list' need not be a list!
2932 (and (listp buffer-undo-list
)
2933 (not (car buffer-undo-list
)))
2934 (setq buffer-undo-list
2935 (cdr buffer-undo-list
))))))
2936 (setq undo-auto--last-boundary-cause
0)))))
2938 (defun undo-auto--undoable-change ()
2939 "Called after every undoable buffer change."
2940 (add-to-list 'undo-auto--undoably-changed-buffers
(current-buffer))
2941 (undo-auto--boundary-ensure-timer))
2942 ;; End auto-boundary section
2944 (defcustom undo-ask-before-discard nil
2945 "If non-nil ask about discarding undo info for the current command.
2946 Normally, Emacs discards the undo info for the current command if
2947 it exceeds `undo-outer-limit'. But if you set this option
2948 non-nil, it asks in the echo area whether to discard the info.
2949 If you answer no, there is a slight risk that Emacs might crash, so
2950 only do it if you really want to undo the command.
2952 This option is mainly intended for debugging. You have to be
2953 careful if you use it for other purposes. Garbage collection is
2954 inhibited while the question is asked, meaning that Emacs might
2955 leak memory. So you should make sure that you do not wait
2956 excessively long before answering the question."
2961 (defvar undo-extra-outer-limit nil
2962 "If non-nil, an extra level of size that's ok in an undo item.
2963 We don't ask the user about truncating the undo list until the
2964 current item gets bigger than this amount.
2966 This variable only matters if `undo-ask-before-discard' is non-nil.")
2967 (make-variable-buffer-local 'undo-extra-outer-limit
)
2969 ;; When the first undo batch in an undo list is longer than
2970 ;; undo-outer-limit, this function gets called to warn the user that
2971 ;; the undo info for the current command was discarded. Garbage
2972 ;; collection is inhibited around the call, so it had better not do a
2974 (setq undo-outer-limit-function
'undo-outer-limit-truncate
)
2975 (defun undo-outer-limit-truncate (size)
2976 (if undo-ask-before-discard
2977 (when (or (null undo-extra-outer-limit
)
2978 (> size undo-extra-outer-limit
))
2979 ;; Don't ask the question again unless it gets even bigger.
2980 ;; This applies, in particular, if the user quits from the question.
2981 ;; Such a quit quits out of GC, but something else will call GC
2982 ;; again momentarily. It will call this function again,
2983 ;; but we don't want to ask the question again.
2984 (setq undo-extra-outer-limit
(+ size
50000))
2985 (if (let (use-dialog-box track-mouse executing-kbd-macro
)
2986 (yes-or-no-p (format-message
2987 "Buffer `%s' undo info is %d bytes long; discard it? "
2988 (buffer-name) size
)))
2989 (progn (setq buffer-undo-list nil
)
2990 (setq undo-extra-outer-limit nil
)
2993 (display-warning '(undo discard-info
)
2996 "Buffer `%s' undo info was %d bytes long.\n"
2998 "The undo info was discarded because it exceeded \
3001 This is normal if you executed a command that made a huge change
3002 to the buffer. In that case, to prevent similar problems in the
3003 future, set `undo-outer-limit' to a value that is large enough to
3004 cover the maximum size of normal changes you expect a single
3005 command to make, but not so large that it might exceed the
3006 maximum memory allotted to Emacs.
3008 If you did not execute any such command, the situation is
3009 probably due to a bug and you should report it.
3011 You can disable the popping up of this buffer by adding the entry
3012 \(undo discard-info) to the user option `warning-suppress-types',
3013 which is defined in the `warnings' library.\n")
3015 (setq buffer-undo-list nil
)
3018 (defcustom password-word-equivalents
3019 '("password" "passcode" "passphrase" "pass phrase"
3020 ; These are sorted according to the GNU en_US locale.
3023 "ପ୍ରବେଶ ସଙ୍କେତ" ; or
3049 "пароль" ; kk, ru, uk
3064 "List of words equivalent to \"password\".
3065 This is used by Shell mode and other parts of Emacs to recognize
3066 password prompts, including prompts in languages other than
3067 English. Different case choices should not be assumed to be
3068 included; callers should bind `case-fold-search' to t."
3069 :type
'(repeat string
)
3073 (defvar shell-command-history nil
3074 "History list for some commands that read shell commands.
3076 Maximum length of the history list is determined by the value
3077 of `history-length', which see.")
3079 (defvar shell-command-switch
(purecopy "-c")
3080 "Switch used to have the shell execute its command line argument.")
3082 (defvar shell-command-default-error-buffer nil
3083 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3084 This buffer is used when `shell-command' or `shell-command-on-region'
3085 is run interactively. A value of nil means that output to stderr and
3086 stdout will be intermixed in the output stream.")
3088 (declare-function mailcap-file-default-commands
"mailcap" (files))
3089 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
3091 (defun minibuffer-default-add-shell-commands ()
3092 "Return a list of all commands associated with the current file.
3093 This function is used to add all related commands retrieved by `mailcap'
3094 to the end of the list of defaults just after the default value."
3096 (let* ((filename (if (listp minibuffer-default
)
3097 (car minibuffer-default
)
3098 minibuffer-default
))
3099 (commands (and filename
(require 'mailcap nil t
)
3100 (mailcap-file-default-commands (list filename
)))))
3101 (setq commands
(mapcar (lambda (command)
3102 (concat command
" " filename
))
3104 (if (listp minibuffer-default
)
3105 (append minibuffer-default commands
)
3106 (cons minibuffer-default commands
))))
3108 (declare-function shell-completion-vars
"shell" ())
3110 (defvar minibuffer-local-shell-command-map
3111 (let ((map (make-sparse-keymap)))
3112 (set-keymap-parent map minibuffer-local-map
)
3113 (define-key map
"\t" 'completion-at-point
)
3115 "Keymap used for completing shell commands in minibuffer.")
3117 (defun read-shell-command (prompt &optional initial-contents hist
&rest args
)
3118 "Read a shell command from the minibuffer.
3119 The arguments are the same as the ones of `read-from-minibuffer',
3120 except READ and KEYMAP are missing and HIST defaults
3121 to `shell-command-history'."
3123 (minibuffer-with-setup-hook
3125 (shell-completion-vars)
3126 (set (make-local-variable 'minibuffer-default-add-function
)
3127 'minibuffer-default-add-shell-commands
))
3128 (apply 'read-from-minibuffer prompt initial-contents
3129 minibuffer-local-shell-command-map
3131 (or hist
'shell-command-history
)
3134 (defcustom async-shell-command-buffer
'confirm-new-buffer
3135 "What to do when the output buffer is used by another shell command.
3136 This option specifies how to resolve the conflict where a new command
3137 wants to direct its output to the buffer `*Async Shell Command*',
3138 but this buffer is already taken by another running shell command.
3140 The value `confirm-kill-process' is used to ask for confirmation before
3141 killing the already running process and running a new process
3142 in the same buffer, `confirm-new-buffer' for confirmation before running
3143 the command in a new buffer with a name other than the default buffer name,
3144 `new-buffer' for doing the same without confirmation,
3145 `confirm-rename-buffer' for confirmation before renaming the existing
3146 output buffer and running a new command in the default buffer,
3147 `rename-buffer' for doing the same without confirmation."
3148 :type
'(choice (const :tag
"Confirm killing of running command"
3149 confirm-kill-process
)
3150 (const :tag
"Confirm creation of a new buffer"
3152 (const :tag
"Create a new buffer"
3154 (const :tag
"Confirm renaming of existing buffer"
3155 confirm-rename-buffer
)
3156 (const :tag
"Rename the existing buffer"
3161 (defun async-shell-command (command &optional output-buffer error-buffer
)
3162 "Execute string COMMAND asynchronously in background.
3164 Like `shell-command', but adds `&' at the end of COMMAND
3165 to execute it asynchronously.
3167 The output appears in the buffer `*Async Shell Command*'.
3168 That buffer is in shell mode.
3170 You can configure `async-shell-command-buffer' to specify what to do in
3171 case when `*Async Shell Command*' buffer is already taken by another
3172 running shell command. To run COMMAND without displaying the output
3173 in a window you can configure `display-buffer-alist' to use the action
3174 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3176 In Elisp, you will often be better served by calling `start-process'
3177 directly, since it offers more control and does not impose the use of a
3178 shell (with its need to quote arguments)."
3181 (read-shell-command "Async shell command: " nil nil
3185 ((eq major-mode
'dired-mode
)
3186 (dired-get-filename nil t
)))))
3187 (and filename
(file-relative-name filename
))))
3189 shell-command-default-error-buffer
))
3190 (unless (string-match "&[ \t]*\\'" command
)
3191 (setq command
(concat command
" &")))
3192 (shell-command command output-buffer error-buffer
))
3194 (defun shell-command (command &optional output-buffer error-buffer
)
3195 "Execute string COMMAND in inferior shell; display output, if any.
3196 With prefix argument, insert the COMMAND's output at point.
3198 Interactively, prompt for COMMAND in the minibuffer.
3200 If COMMAND ends in `&', execute it asynchronously.
3201 The output appears in the buffer `*Async Shell Command*'.
3202 That buffer is in shell mode. You can also use
3203 `async-shell-command' that automatically adds `&'.
3205 Otherwise, COMMAND is executed synchronously. The output appears in
3206 the buffer `*Shell Command Output*'. If the output is short enough to
3207 display in the echo area (which is determined by the variables
3208 `resize-mini-windows' and `max-mini-window-height'), it is shown
3209 there, but it is nonetheless available in buffer `*Shell Command
3210 Output*' even though that buffer is not automatically displayed.
3212 To specify a coding system for converting non-ASCII characters
3213 in the shell command output, use \\[universal-coding-system-argument] \
3214 before this command.
3216 Noninteractive callers can specify coding systems by binding
3217 `coding-system-for-read' and `coding-system-for-write'.
3219 The optional second argument OUTPUT-BUFFER, if non-nil,
3220 says to put the output in some other buffer.
3221 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3222 If OUTPUT-BUFFER is not a buffer and not nil,
3223 insert output in current buffer. (This cannot be done asynchronously.)
3224 In either case, the buffer is first erased, and the output is
3225 inserted after point (leaving mark after it).
3227 If the command terminates without error, but generates output,
3228 and you did not specify \"insert it in the current buffer\",
3229 the output can be displayed in the echo area or in its buffer.
3230 If the output is short enough to display in the echo area
3231 \(determined by the variable `max-mini-window-height' if
3232 `resize-mini-windows' is non-nil), it is shown there.
3233 Otherwise,the buffer containing the output is displayed.
3235 If there is output and an error, and you did not specify \"insert it
3236 in the current buffer\", a message about the error goes at the end
3239 If there is no output, or if output is inserted in the current buffer,
3240 then `*Shell Command Output*' is deleted.
3242 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3243 or buffer name to which to direct the command's standard error output.
3244 If it is nil, error output is mingled with regular output.
3245 In an interactive call, the variable `shell-command-default-error-buffer'
3246 specifies the value of ERROR-BUFFER.
3248 In Elisp, you will often be better served by calling `call-process' or
3249 `start-process' directly, since it offers more control and does not impose
3250 the use of a shell (with its need to quote arguments)."
3254 (read-shell-command "Shell command: " nil nil
3258 ((eq major-mode
'dired-mode
)
3259 (dired-get-filename nil t
)))))
3260 (and filename
(file-relative-name filename
))))
3262 shell-command-default-error-buffer
))
3263 ;; Look for a handler in case default-directory is a remote file name.
3265 (find-file-name-handler (directory-file-name default-directory
)
3268 (funcall handler
'shell-command command output-buffer error-buffer
)
3269 (if (and output-buffer
3270 (not (or (bufferp output-buffer
) (stringp output-buffer
))))
3271 ;; Output goes in current buffer.
3275 (expand-file-name "scor"
3276 (or small-temporary-file-directory
3277 temporary-file-directory
)))
3279 (barf-if-buffer-read-only)
3281 ;; We do not use -f for csh; we will not support broken use of
3282 ;; .cshrcs. Even the BSD csh manual says to use
3283 ;; "if ($?prompt) exit" before things which are not useful
3284 ;; non-interactively. Besides, if someone wants their other
3285 ;; aliases for shell commands then they can still have them.
3286 (call-process shell-file-name nil
3290 nil shell-command-switch command
)
3291 (when (and error-file
(file-exists-p error-file
))
3292 (if (< 0 (nth 7 (file-attributes error-file
)))
3293 (with-current-buffer (get-buffer-create error-buffer
)
3294 (let ((pos-from-end (- (point-max) (point))))
3297 ;; Do no formatting while reading error file,
3298 ;; because that can run a shell command, and we
3299 ;; don't want that to cause an infinite recursion.
3300 (format-insert-file error-file nil
)
3301 ;; Put point after the inserted errors.
3302 (goto-char (- (point-max) pos-from-end
)))
3303 (display-buffer (current-buffer))))
3304 (delete-file error-file
))
3305 ;; This is like exchange-point-and-mark, but doesn't
3306 ;; activate the mark. It is cleaner to avoid activation,
3307 ;; even though the command loop would deactivate the mark
3308 ;; because we inserted text.
3309 (goto-char (prog1 (mark t
)
3310 (set-marker (mark-marker) (point)
3311 (current-buffer)))))
3312 ;; Output goes in a separate buffer.
3313 ;; Preserve the match data in case called from a program.
3315 (if (string-match "[ \t]*&[ \t]*\\'" command
)
3316 ;; Command ending with ampersand means asynchronous.
3317 (let ((buffer (get-buffer-create
3318 (or output-buffer
"*Async Shell Command*")))
3319 (directory default-directory
)
3321 ;; Remove the ampersand.
3322 (setq command
(substring command
0 (match-beginning 0)))
3323 ;; Ask the user what to do with already running process.
3324 (setq proc
(get-buffer-process buffer
))
3327 ((eq async-shell-command-buffer
'confirm-kill-process
)
3328 ;; If will kill a process, query first.
3329 (if (yes-or-no-p "A command is running in the default buffer. Kill it? ")
3331 (error "Shell command in progress")))
3332 ((eq async-shell-command-buffer
'confirm-new-buffer
)
3333 ;; If will create a new buffer, query first.
3334 (if (yes-or-no-p "A command is running in the default buffer. Use a new buffer? ")
3335 (setq buffer
(generate-new-buffer
3336 (or (and (bufferp output-buffer
) (buffer-name output-buffer
))
3337 output-buffer
"*Async Shell Command*")))
3338 (error "Shell command in progress")))
3339 ((eq async-shell-command-buffer
'new-buffer
)
3340 ;; It will create a new buffer.
3341 (setq buffer
(generate-new-buffer
3342 (or (and (bufferp output-buffer
) (buffer-name output-buffer
))
3343 output-buffer
"*Async Shell Command*"))))
3344 ((eq async-shell-command-buffer
'confirm-rename-buffer
)
3345 ;; If will rename the buffer, query first.
3346 (if (yes-or-no-p "A command is running in the default buffer. Rename it? ")
3348 (with-current-buffer buffer
3350 (setq buffer
(get-buffer-create
3351 (or output-buffer
"*Async Shell Command*"))))
3352 (error "Shell command in progress")))
3353 ((eq async-shell-command-buffer
'rename-buffer
)
3354 ;; It will rename the buffer.
3355 (with-current-buffer buffer
3357 (setq buffer
(get-buffer-create
3358 (or output-buffer
"*Async Shell Command*"))))))
3359 (with-current-buffer buffer
3360 (setq buffer-read-only nil
)
3361 ;; Setting buffer-read-only to nil doesn't suffice
3362 ;; if some text has a non-nil read-only property,
3363 ;; which comint sometimes adds for prompts.
3364 (let ((inhibit-read-only t
))
3366 (display-buffer buffer
'(nil (allow-no-window . t
)))
3367 (setq default-directory directory
)
3368 (setq proc
(start-process "Shell" buffer shell-file-name
3369 shell-command-switch command
))
3370 (setq mode-line-process
'(":%s"))
3371 (require 'shell
) (shell-mode)
3372 (set-process-sentinel proc
'shell-command-sentinel
)
3373 ;; Use the comint filter for proper handling of carriage motion
3374 ;; (see `comint-inhibit-carriage-motion'),.
3375 (set-process-filter proc
'comint-output-filter
)
3377 ;; Otherwise, command is executed synchronously.
3378 (shell-command-on-region (point) (point) command
3379 output-buffer nil error-buffer
)))))))
3381 (defun display-message-or-buffer (message &optional buffer-name action frame
)
3382 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3383 MESSAGE may be either a string or a buffer.
3385 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3386 for maximum height of the echo area, as defined by `max-mini-window-height'
3387 if `resize-mini-windows' is non-nil.
3389 Returns either the string shown in the echo area, or when a pop-up
3390 buffer is used, the window used to display it.
3392 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3393 name of the buffer used to display it in the case where a pop-up buffer
3394 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3395 string and it is displayed in the echo area, it is not specified whether
3396 the contents are inserted into the buffer anyway.
3398 Optional arguments ACTION and FRAME are as for `display-buffer',
3399 and are only used if a pop-up buffer is displayed."
3400 (cond ((and (stringp message
) (not (string-match "\n" message
)))
3401 ;; Trivial case where we can use the echo area
3402 (message "%s" message
))
3403 ((and (stringp message
)
3404 (= (string-match "\n" message
) (1- (length message
))))
3405 ;; Trivial case where we can just remove single trailing newline
3406 (message "%s" (substring message
0 (1- (length message
)))))
3409 (with-current-buffer
3410 (if (bufferp message
)
3412 (get-buffer-create (or buffer-name
"*Message*")))
3414 (unless (bufferp message
)
3419 (if (= (buffer-size) 0)
3421 (count-screen-lines nil nil nil
(minibuffer-window)))))
3423 ((and (or (<= lines
1)
3425 (if resize-mini-windows
3426 (cond ((floatp max-mini-window-height
)
3428 max-mini-window-height
))
3429 ((integerp max-mini-window-height
)
3430 max-mini-window-height
)
3434 ;; Don't use the echo area if the output buffer is
3435 ;; already displayed in the selected frame.
3436 (not (get-buffer-window (current-buffer))))
3438 (goto-char (point-max))
3441 (message "%s" (buffer-substring (point-min) (point))))
3444 (goto-char (point-min))
3445 (display-buffer (current-buffer) action frame
))))))))
3448 ;; We have a sentinel to prevent insertion of a termination message
3449 ;; in the buffer itself.
3450 (defun shell-command-sentinel (process signal
)
3451 (if (memq (process-status process
) '(exit signal
))
3453 (car (cdr (cdr (process-command process
))))
3454 (substring signal
0 -
1))))
3456 (defun shell-command-on-region (start end command
3457 &optional output-buffer replace
3458 error-buffer display-error-buffer
3459 region-noncontiguous-p
)
3460 "Execute string COMMAND in inferior shell with region as input.
3461 Normally display output (if any) in temp buffer `*Shell Command Output*';
3462 Prefix arg means replace the region with it. Return the exit code of
3465 To specify a coding system for converting non-ASCII characters
3466 in the input and output to the shell command, use \\[universal-coding-system-argument]
3467 before this command. By default, the input (from the current buffer)
3468 is encoded using coding-system specified by `process-coding-system-alist',
3469 falling back to `default-process-coding-system' if no match for COMMAND
3470 is found in `process-coding-system-alist'.
3472 Noninteractive callers can specify coding systems by binding
3473 `coding-system-for-read' and `coding-system-for-write'.
3475 If the command generates output, the output may be displayed
3476 in the echo area or in a buffer.
3477 If the output is short enough to display in the echo area
3478 \(determined by the variable `max-mini-window-height' if
3479 `resize-mini-windows' is non-nil), it is shown there.
3480 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3481 The output is available in that buffer in both cases.
3483 If there is output and an error, a message about the error
3484 appears at the end of the output. If there is no output, or if
3485 output is inserted in the current buffer, the buffer `*Shell
3486 Command Output*' is deleted.
3488 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3489 command's output. If the value is a buffer or buffer name,
3490 put the output there. If the value is nil, use the buffer
3491 `*Shell Command Output*'. Any other value, excluding nil,
3492 means to insert the output in the current buffer. In either case,
3493 the output is inserted after point (leaving mark after it).
3495 Optional fifth arg REPLACE, if non-nil, means to insert the
3496 output in place of text from START to END, putting point and mark
3499 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3500 or buffer name to which to direct the command's standard error
3501 output. If nil, error output is mingled with regular output.
3502 When called interactively, `shell-command-default-error-buffer'
3503 is used for ERROR-BUFFER.
3505 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3506 display the error buffer if there were any errors. When called
3507 interactively, this is t."
3508 (interactive (let (string)
3510 (user-error "The mark is not set now, so there is no region"))
3511 ;; Do this before calling region-beginning
3512 ;; and region-end, in case subprocess output
3513 ;; relocates them while we are in the minibuffer.
3514 (setq string
(read-shell-command "Shell command on region: "))
3515 ;; call-interactively recognizes region-beginning and
3516 ;; region-end specially, leaving them in the history.
3517 (list (region-beginning) (region-end)
3521 shell-command-default-error-buffer
3523 (region-noncontiguous-p))))
3527 (expand-file-name "scor"
3528 (or small-temporary-file-directory
3529 temporary-file-directory
)))
3532 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3533 (if region-noncontiguous-p
3534 (let ((input (concat (funcall region-extract-function
'delete
) "\n"))
3538 (call-process-region (point-min) (point-max)
3540 nil shell-command-switch
3542 (setq output
(split-string (buffer-string) "\n")))
3544 (funcall region-insert-function output
))
3547 (not (or (bufferp output-buffer
) (stringp output-buffer
)))))
3548 ;; Replace specified region with output from command.
3549 (let ((swap (and replace
(< start end
))))
3550 ;; Don't muck with mark unless REPLACE says we should.
3552 (and replace
(push-mark (point) 'nomsg
))
3554 (call-process-region start end shell-file-name replace
3558 nil shell-command-switch command
))
3559 ;; It is rude to delete a buffer which the command is not using.
3560 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3561 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3562 ;; (kill-buffer shell-buffer)))
3563 ;; Don't muck with mark unless REPLACE says we should.
3564 (and replace swap
(exchange-point-and-mark)))
3565 ;; No prefix argument: put the output in a temp buffer,
3566 ;; replacing its entire contents.
3567 (let ((buffer (get-buffer-create
3568 (or output-buffer
"*Shell Command Output*"))))
3570 (if (eq buffer
(current-buffer))
3571 ;; If the input is the same buffer as the output,
3572 ;; delete everything but the specified region,
3573 ;; then replace that region with the output.
3574 (progn (setq buffer-read-only nil
)
3575 (delete-region (max start end
) (point-max))
3576 (delete-region (point-min) (min start end
))
3578 (call-process-region (point-min) (point-max)
3583 nil shell-command-switch
3585 ;; Clear the output buffer, then run the command with
3587 (let ((directory default-directory
))
3588 (with-current-buffer buffer
3589 (setq buffer-read-only nil
)
3590 (if (not output-buffer
)
3591 (setq default-directory directory
))
3594 (call-process-region start end shell-file-name nil
3596 (list buffer error-file
)
3598 nil shell-command-switch command
)))
3599 ;; Report the output.
3600 (with-current-buffer buffer
3601 (setq mode-line-process
3602 (cond ((null exit-status
)
3604 ((stringp exit-status
)
3605 (format " - Signal [%s]" exit-status
))
3606 ((not (equal 0 exit-status
))
3607 (format " - Exit [%d]" exit-status
)))))
3608 (if (with-current-buffer buffer
(> (point-max) (point-min)))
3609 ;; There's some output, display it
3610 (display-message-or-buffer buffer
)
3611 ;; No output; error?
3614 (< 0 (nth 7 (file-attributes error-file
))))
3615 (format "some error output%s"
3616 (if shell-command-default-error-buffer
3617 (format " to the \"%s\" buffer"
3618 shell-command-default-error-buffer
)
3621 (cond ((null exit-status
)
3622 (message "(Shell command failed with error)"))
3623 ((equal 0 exit-status
)
3624 (message "(Shell command succeeded with %s)"
3626 ((stringp exit-status
)
3627 (message "(Shell command killed by signal %s)"
3630 (message "(Shell command failed with code %d and %s)"
3631 exit-status output
))))
3632 ;; Don't kill: there might be useful info in the undo-log.
3633 ;; (kill-buffer buffer)
3636 (when (and error-file
(file-exists-p error-file
))
3637 (if (< 0 (nth 7 (file-attributes error-file
)))
3638 (with-current-buffer (get-buffer-create error-buffer
)
3639 (let ((pos-from-end (- (point-max) (point))))
3642 ;; Do no formatting while reading error file,
3643 ;; because that can run a shell command, and we
3644 ;; don't want that to cause an infinite recursion.
3645 (format-insert-file error-file nil
)
3646 ;; Put point after the inserted errors.
3647 (goto-char (- (point-max) pos-from-end
)))
3648 (and display-error-buffer
3649 (display-buffer (current-buffer)))))
3650 (delete-file error-file
))
3653 (defun shell-command-to-string (command)
3654 "Execute shell command COMMAND and return its output as a string."
3655 (with-output-to-string
3656 (with-current-buffer
3658 (process-file shell-file-name nil t nil shell-command-switch command
))))
3660 (defun process-file (program &optional infile buffer display
&rest args
)
3661 "Process files synchronously in a separate process.
3662 Similar to `call-process', but may invoke a file handler based on
3663 `default-directory'. The current working directory of the
3664 subprocess is `default-directory'.
3666 File names in INFILE and BUFFER are handled normally, but file
3667 names in ARGS should be relative to `default-directory', as they
3668 are passed to the process verbatim. (This is a difference to
3669 `call-process' which does not support file handlers for INFILE
3672 Some file handlers might not support all variants, for example
3673 they might behave as if DISPLAY was nil, regardless of the actual
3675 (let ((fh (find-file-name-handler default-directory
'process-file
))
3678 (if fh
(apply fh
'process-file program infile buffer display args
)
3679 (when infile
(setq lc
(file-local-copy infile
)))
3680 (setq stderr-file
(when (and (consp buffer
) (stringp (cadr buffer
)))
3681 (make-temp-file "emacs")))
3683 (apply 'call-process program
3685 (if stderr-file
(list (car buffer
) stderr-file
) buffer
)
3687 (when stderr-file
(copy-file stderr-file
(cadr buffer
) t
))))
3688 (when stderr-file
(delete-file stderr-file
))
3689 (when lc
(delete-file lc
)))))
3691 (defvar process-file-side-effects t
3692 "Whether a call of `process-file' changes remote files.
3694 By default, this variable is always set to t, meaning that a
3695 call of `process-file' could potentially change any file on a
3696 remote host. When set to nil, a file handler could optimize
3697 its behavior with respect to remote file attribute caching.
3699 You should only ever change this variable with a let-binding;
3700 never with `setq'.")
3702 (defun start-file-process (name buffer program
&rest program-args
)
3703 "Start a program in a subprocess. Return the process object for it.
3705 Similar to `start-process', but may invoke a file handler based on
3706 `default-directory'. See Info node `(elisp)Magic File Names'.
3708 This handler ought to run PROGRAM, perhaps on the local host,
3709 perhaps on a remote host that corresponds to `default-directory'.
3710 In the latter case, the local part of `default-directory' becomes
3711 the working directory of the process.
3713 PROGRAM and PROGRAM-ARGS might be file names. They are not
3714 objects of file handler invocation. File handlers might not
3715 support pty association, if PROGRAM is nil."
3716 (let ((fh (find-file-name-handler default-directory
'start-file-process
)))
3717 (if fh
(apply fh
'start-file-process name buffer program program-args
)
3718 (apply 'start-process name buffer program program-args
))))
3722 (defvar tabulated-list-format
)
3723 (defvar tabulated-list-entries
)
3724 (defvar tabulated-list-sort-key
)
3725 (declare-function tabulated-list-init-header
"tabulated-list" ())
3726 (declare-function tabulated-list-print
"tabulated-list"
3727 (&optional remember-pos update
))
3729 (defvar process-menu-query-only nil
)
3731 (defvar process-menu-mode-map
3732 (let ((map (make-sparse-keymap)))
3733 (define-key map
[?d
] 'process-menu-delete-process
)
3736 (define-derived-mode process-menu-mode tabulated-list-mode
"Process Menu"
3737 "Major mode for listing the processes called by Emacs."
3738 (setq tabulated-list-format
[("Process" 15 t
)
3743 (make-local-variable 'process-menu-query-only
)
3744 (setq tabulated-list-sort-key
(cons "Process" nil
))
3745 (add-hook 'tabulated-list-revert-hook
'list-processes--refresh nil t
)
3746 (tabulated-list-init-header))
3748 (defun process-menu-delete-process ()
3749 "Kill process at point in a `list-processes' buffer."
3751 (delete-process (tabulated-list-get-id))
3754 (defun list-processes--refresh ()
3755 "Recompute the list of processes for the Process List buffer.
3756 Also, delete any process that is exited or signaled."
3757 (setq tabulated-list-entries nil
)
3758 (dolist (p (process-list))
3759 (cond ((memq (process-status p
) '(exit signal closed
))
3761 ((or (not process-menu-query-only
)
3762 (process-query-on-exit-flag p
))
3763 (let* ((buf (process-buffer p
))
3764 (type (process-type p
))
3765 (name (process-name p
))
3766 (status (symbol-name (process-status p
)))
3767 (buf-label (if (buffer-live-p buf
)
3768 `(,(buffer-name buf
)
3770 help-echo
,(format-message
3775 action process-menu-visit-buffer
)
3777 (tty (or (process-tty-name p
) "--"))
3779 (if (memq type
'(network serial
))
3780 (let ((contact (process-contact p t
)))
3781 (if (eq type
'network
)
3783 (if (plist-get contact
:type
)
3786 (if (plist-get contact
:server
)
3787 (format "server on %s"
3789 (plist-get contact
:host
)
3790 (plist-get contact
:local
)))
3791 (format "connection to %s"
3792 (plist-get contact
:host
))))
3793 (format "(serial port %s%s)"
3794 (or (plist-get contact
:port
) "?")
3795 (let ((speed (plist-get contact
:speed
)))
3797 (format " at %s b/s" speed
)
3799 (mapconcat 'identity
(process-command p
) " "))))
3800 (push (list p
(vector name status buf-label tty cmd
))
3801 tabulated-list-entries
))))))
3803 (defun process-menu-visit-buffer (button)
3804 (display-buffer (button-get button
'process-buffer
)))
3806 (defun list-processes (&optional query-only buffer
)
3807 "Display a list of all processes that are Emacs sub-processes.
3808 If optional argument QUERY-ONLY is non-nil, only processes with
3809 the query-on-exit flag set are listed.
3810 Any process listed as exited or signaled is actually eliminated
3811 after the listing is made.
3812 Optional argument BUFFER specifies a buffer to use, instead of
3814 The return value is always nil.
3816 This function lists only processes that were launched by Emacs. To
3817 see other processes running on the system, use `list-system-processes'."
3819 (or (fboundp 'process-list
)
3820 (error "Asynchronous subprocesses are not supported on this system"))
3821 (unless (bufferp buffer
)
3822 (setq buffer
(get-buffer-create "*Process List*")))
3823 (with-current-buffer buffer
3825 (setq process-menu-query-only query-only
)
3826 (list-processes--refresh)
3827 (tabulated-list-print))
3828 (display-buffer buffer
)
3831 ;;;; Prefix commands
3833 (setq prefix-command--needs-update nil
)
3834 (setq prefix-command--last-echo nil
)
3836 (defun internal-echo-keystrokes-prefix ()
3837 ;; BEWARE: Called directly from C code.
3838 ;; If the return value is non-nil, it means we are in the middle of
3839 ;; a command with prefix, such as a command invoked with prefix-arg.
3840 (if (not prefix-command--needs-update
)
3841 prefix-command--last-echo
3842 (setq prefix-command--last-echo
3844 (run-hook-wrapped 'prefix-command-echo-keystrokes-functions
3845 (lambda (fun) (push (funcall fun
) strs
)))
3846 (setq strs
(delq nil strs
))
3847 (when strs
(mapconcat #'identity strs
" "))))))
3849 (defvar prefix-command-echo-keystrokes-functions nil
3850 "Abnormal hook which constructs the description of the current prefix state.
3851 Each function is called with no argument, should return a string or nil.")
3853 (defun prefix-command-update ()
3854 "Update state of prefix commands.
3855 Call it whenever you change the \"prefix command state\"."
3856 (setq prefix-command--needs-update t
))
3858 (defvar prefix-command-preserve-state-hook nil
3859 "Normal hook run when a command needs to preserve the prefix.")
3861 (defun prefix-command-preserve-state ()
3862 "Pass the current prefix command state to the next command.
3863 Should be called by all prefix commands.
3864 Runs `prefix-command-preserve-state-hook'."
3865 (run-hooks 'prefix-command-preserve-state-hook
)
3866 ;; If the current command is a prefix command, we don't want the next (real)
3867 ;; command to have `last-command' set to, say, `universal-argument'.
3868 (setq this-command last-command
)
3869 (setq real-this-command real-last-command
)
3870 (prefix-command-update))
3872 (defun reset-this-command-lengths ()
3873 (declare (obsolete prefix-command-preserve-state
"25.1"))
3876 ;;;;; The main prefix command.
3878 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
3880 (add-hook 'prefix-command-echo-keystrokes-functions
3881 #'universal-argument--description
)
3882 (defun universal-argument--description ()
3887 (`(,(and (pred integerp
) n
))
3889 (while (and (> n
4) (= (mod n
4) 0))
3890 (setq str
(concat str
" C-u"))
3892 (if (= n
4) str
(format " %s" prefix-arg
))))
3893 (_ (format " %s" prefix-arg
))))))
3895 (add-hook 'prefix-command-preserve-state-hook
3896 #'universal-argument--preserve
)
3897 (defun universal-argument--preserve ()
3898 (setq prefix-arg current-prefix-arg
))
3900 (defvar universal-argument-map
3901 (let ((map (make-sparse-keymap))
3902 (universal-argument-minus
3903 ;; For backward compatibility, minus with no modifiers is an ordinary
3904 ;; command if digits have already been entered.
3905 `(menu-item "" negative-argument
3906 :filter
,(lambda (cmd)
3907 (if (integerp prefix-arg
) nil cmd
)))))
3908 (define-key map
[switch-frame
]
3909 (lambda (e) (interactive "e")
3910 (handle-switch-frame e
) (universal-argument--mode)))
3911 (define-key map
[?\C-u
] 'universal-argument-more
)
3912 (define-key map
[?-
] universal-argument-minus
)
3913 (define-key map
[?
0] 'digit-argument
)
3914 (define-key map
[?
1] 'digit-argument
)
3915 (define-key map
[?
2] 'digit-argument
)
3916 (define-key map
[?
3] 'digit-argument
)
3917 (define-key map
[?
4] 'digit-argument
)
3918 (define-key map
[?
5] 'digit-argument
)
3919 (define-key map
[?
6] 'digit-argument
)
3920 (define-key map
[?
7] 'digit-argument
)
3921 (define-key map
[?
8] 'digit-argument
)
3922 (define-key map
[?
9] 'digit-argument
)
3923 (define-key map
[kp-0
] 'digit-argument
)
3924 (define-key map
[kp-1
] 'digit-argument
)
3925 (define-key map
[kp-2
] 'digit-argument
)
3926 (define-key map
[kp-3
] 'digit-argument
)
3927 (define-key map
[kp-4
] 'digit-argument
)
3928 (define-key map
[kp-5
] 'digit-argument
)
3929 (define-key map
[kp-6
] 'digit-argument
)
3930 (define-key map
[kp-7
] 'digit-argument
)
3931 (define-key map
[kp-8
] 'digit-argument
)
3932 (define-key map
[kp-9
] 'digit-argument
)
3933 (define-key map
[kp-subtract
] universal-argument-minus
)
3935 "Keymap used while processing \\[universal-argument].")
3937 (defun universal-argument--mode ()
3938 (prefix-command-update)
3939 (set-transient-map universal-argument-map nil
))
3941 (defun universal-argument ()
3942 "Begin a numeric argument for the following command.
3943 Digits or minus sign following \\[universal-argument] make up the numeric argument.
3944 \\[universal-argument] following the digits or minus sign ends the argument.
3945 \\[universal-argument] without digits or minus sign provides 4 as argument.
3946 Repeating \\[universal-argument] without digits or minus sign
3947 multiplies the argument by 4 each time.
3948 For some commands, just \\[universal-argument] by itself serves as a flag
3949 which is different in effect from any particular numeric argument.
3950 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
3952 (prefix-command-preserve-state)
3953 (setq prefix-arg
(list 4))
3954 (universal-argument--mode))
3956 (defun universal-argument-more (arg)
3957 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3958 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3960 (prefix-command-preserve-state)
3961 (setq prefix-arg
(if (consp arg
)
3962 (list (* 4 (car arg
)))
3966 (when (consp prefix-arg
) (universal-argument--mode)))
3968 (defun negative-argument (arg)
3969 "Begin a negative numeric argument for the next command.
3970 \\[universal-argument] following digits or minus sign ends the argument."
3972 (prefix-command-preserve-state)
3973 (setq prefix-arg
(cond ((integerp arg
) (- arg
))
3976 (universal-argument--mode))
3978 (defun digit-argument (arg)
3979 "Part of the numeric argument for the next command.
3980 \\[universal-argument] following digits or minus sign ends the argument."
3982 (prefix-command-preserve-state)
3983 (let* ((char (if (integerp last-command-event
)
3985 (get last-command-event
'ascii-character
)))
3986 (digit (- (logand char ?
\177) ?
0)))
3987 (setq prefix-arg
(cond ((integerp arg
)
3989 (if (< arg
0) (- digit
) digit
)))
3991 ;; Treat -0 as just -, so that -01 will work.
3992 (if (zerop digit
) '-
(- digit
)))
3995 (universal-argument--mode))
3998 (defvar filter-buffer-substring-functions nil
3999 "This variable is a wrapper hook around `buffer-substring--filter'.")
4000 (make-obsolete-variable 'filter-buffer-substring-functions
4001 'filter-buffer-substring-function
"24.4")
4003 (defvar filter-buffer-substring-function
#'buffer-substring--filter
4004 "Function to perform the filtering in `filter-buffer-substring'.
4005 The function is called with the same 3 arguments (BEG END DELETE)
4006 that `filter-buffer-substring' received. It should return the
4007 buffer substring between BEG and END, after filtering. If DELETE is
4008 non-nil, it should delete the text between BEG and END from the buffer.")
4010 (defvar buffer-substring-filters nil
4011 "List of filter functions for `buffer-substring--filter'.
4012 Each function must accept a single argument, a string, and return a string.
4013 The buffer substring is passed to the first function in the list,
4014 and the return value of each function is passed to the next.
4015 As a special convention, point is set to the start of the buffer text
4016 being operated on (i.e., the first argument of `buffer-substring--filter')
4017 before these functions are called.")
4018 (make-obsolete-variable 'buffer-substring-filters
4019 'filter-buffer-substring-function
"24.1")
4021 (defun filter-buffer-substring (beg end
&optional delete
)
4022 "Return the buffer substring between BEG and END, after filtering.
4023 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4025 This calls the function that `filter-buffer-substring-function' specifies
4026 \(passing the same three arguments that it received) to do the work,
4027 and returns whatever it does. The default function does no filtering,
4028 unless a hook has been set.
4030 Use `filter-buffer-substring' instead of `buffer-substring',
4031 `buffer-substring-no-properties', or `delete-and-extract-region' when
4032 you want to allow filtering to take place. For example, major or minor
4033 modes can use `filter-buffer-substring-function' to extract characters
4034 that are special to a buffer, and should not be copied into other buffers."
4035 (funcall filter-buffer-substring-function beg end delete
))
4037 (defun buffer-substring--filter (beg end
&optional delete
)
4038 "Default function to use for `filter-buffer-substring-function'.
4039 Its arguments and return value are as specified for `filter-buffer-substring'.
4040 This respects the wrapper hook `filter-buffer-substring-functions',
4041 and the abnormal hook `buffer-substring-filters'.
4042 No filtering is done unless a hook says to."
4043 (with-wrapper-hook filter-buffer-substring-functions
(beg end delete
)
4045 ((or delete buffer-substring-filters
)
4048 (let ((string (if delete
(delete-and-extract-region beg end
)
4049 (buffer-substring beg end
))))
4050 (dolist (filter buffer-substring-filters
)
4051 (setq string
(funcall filter string
)))
4054 (buffer-substring beg end
)))))
4057 ;;;; Window system cut and paste hooks.
4059 (defvar interprogram-cut-function
#'gui-select-text
4060 "Function to call to make a killed region available to other programs.
4061 Most window systems provide a facility for cutting and pasting
4062 text between different programs, such as the clipboard on X and
4063 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4065 This variable holds a function that Emacs calls whenever text is
4066 put in the kill ring, to make the new kill available to other
4067 programs. The function takes one argument, TEXT, which is a
4068 string containing the text which should be made available.")
4070 (defvar interprogram-paste-function
#'gui-selection-value
4071 "Function to call to get text cut from other programs.
4072 Most window systems provide a facility for cutting and pasting
4073 text between different programs, such as the clipboard on X and
4074 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4076 This variable holds a function that Emacs calls to obtain text
4077 that other programs have provided for pasting. The function is
4078 called with no arguments. If no other program has provided text
4079 to paste, the function should return nil (in which case the
4080 caller, usually `current-kill', should use the top of the Emacs
4081 kill ring). If another program has provided text to paste, the
4082 function should return that text as a string (in which case the
4083 caller should put this string in the kill ring as the latest
4086 The function may also return a list of strings if the window
4087 system supports multiple selections. The first string will be
4088 used as the pasted text, but the other will be placed in the kill
4089 ring for easy access via `yank-pop'.
4091 Note that the function should return a string only if a program
4092 other than Emacs has provided a string for pasting; if Emacs
4093 provided the most recent string, the function should return nil.
4094 If it is difficult to tell whether Emacs or some other program
4095 provided the current string, it is probably good enough to return
4096 nil if the string is equal (according to `string=') to the last
4097 text Emacs provided.")
4101 ;;;; The kill ring data structure.
4103 (defvar kill-ring nil
4104 "List of killed text sequences.
4105 Since the kill ring is supposed to interact nicely with cut-and-paste
4106 facilities offered by window systems, use of this variable should
4107 interact nicely with `interprogram-cut-function' and
4108 `interprogram-paste-function'. The functions `kill-new',
4109 `kill-append', and `current-kill' are supposed to implement this
4110 interaction; you may want to use them instead of manipulating the kill
4113 (defcustom kill-ring-max
60
4114 "Maximum length of kill ring before oldest elements are thrown away."
4118 (defvar kill-ring-yank-pointer nil
4119 "The tail of the kill ring whose car is the last thing yanked.")
4121 (defcustom save-interprogram-paste-before-kill nil
4122 "Save clipboard strings into kill ring before replacing them.
4123 When one selects something in another program to paste it into Emacs,
4124 but kills something in Emacs before actually pasting it,
4125 this selection is gone unless this variable is non-nil,
4126 in which case the other program's selection is saved in the `kill-ring'
4127 before the Emacs kill and one can still paste it using \\[yank] \\[yank-pop]."
4132 (defcustom kill-do-not-save-duplicates nil
4133 "Do not add a new string to `kill-ring' if it duplicates the last one.
4134 The comparison is done using `equal-including-properties'."
4139 (defun kill-new (string &optional replace
)
4140 "Make STRING the latest kill in the kill ring.
4141 Set `kill-ring-yank-pointer' to point to it.
4142 If `interprogram-cut-function' is non-nil, apply it to STRING.
4143 Optional second argument REPLACE non-nil means that STRING will replace
4144 the front of the kill ring, rather than being added to the list.
4146 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4147 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4150 When the yank handler has a non-nil PARAM element, the original STRING
4151 argument is not used by `insert-for-yank'. However, since Lisp code
4152 may access and use elements from the kill ring directly, the STRING
4153 argument should still be a \"useful\" string for such uses."
4154 (unless (and kill-do-not-save-duplicates
4155 ;; Due to text properties such as 'yank-handler that
4156 ;; can alter the contents to yank, comparison using
4157 ;; `equal' is unsafe.
4158 (equal-including-properties string
(car kill-ring
)))
4159 (if (fboundp 'menu-bar-update-yank-menu
)
4160 (menu-bar-update-yank-menu string
(and replace
(car kill-ring
)))))
4161 (when save-interprogram-paste-before-kill
4162 (let ((interprogram-paste (and interprogram-paste-function
4163 (funcall interprogram-paste-function
))))
4164 (when interprogram-paste
4165 (dolist (s (if (listp interprogram-paste
)
4166 (nreverse interprogram-paste
)
4167 (list interprogram-paste
)))
4168 (unless (and kill-do-not-save-duplicates
4169 (equal-including-properties s
(car kill-ring
)))
4170 (push s kill-ring
))))))
4171 (unless (and kill-do-not-save-duplicates
4172 (equal-including-properties string
(car kill-ring
)))
4173 (if (and replace kill-ring
)
4174 (setcar kill-ring string
)
4175 (push string kill-ring
)
4176 (if (> (length kill-ring
) kill-ring-max
)
4177 (setcdr (nthcdr (1- kill-ring-max
) kill-ring
) nil
))))
4178 (setq kill-ring-yank-pointer kill-ring
)
4179 (if interprogram-cut-function
4180 (funcall interprogram-cut-function string
)))
4182 ;; It has been argued that this should work similar to `self-insert-command'
4183 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4184 (defcustom kill-append-merge-undo nil
4185 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4190 (defun kill-append (string before-p
)
4191 "Append STRING to the end of the latest kill in the kill ring.
4192 If BEFORE-P is non-nil, prepend STRING to the kill.
4193 Also removes the last undo boundary in the current buffer,
4194 depending on `kill-append-merge-undo'.
4195 If `interprogram-cut-function' is set, pass the resulting kill to it."
4196 (let* ((cur (car kill-ring
)))
4197 (kill-new (if before-p
(concat string cur
) (concat cur string
))
4198 (or (= (length cur
) 0)
4199 (equal nil
(get-text-property 0 'yank-handler cur
))))
4200 (when (and kill-append-merge-undo
(not buffer-read-only
))
4201 (let ((prev buffer-undo-list
)
4202 (next (cdr buffer-undo-list
)))
4203 ;; find the next undo boundary
4207 ;; remove this undo boundary
4209 (setcdr prev
(cdr next
)))))))
4211 (defcustom yank-pop-change-selection nil
4212 "Whether rotating the kill ring changes the window system selection.
4213 If non-nil, whenever the kill ring is rotated (usually via the
4214 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4215 to copy the new kill to the window system selection."
4220 (defun current-kill (n &optional do-not-move
)
4221 "Rotate the yanking point by N places, and then return that kill.
4222 If N is zero and `interprogram-paste-function' is set to a
4223 function that returns a string or a list of strings, and if that
4224 function doesn't return nil, then that string (or list) is added
4225 to the front of the kill ring and the string (or first string in
4226 the list) is returned as the latest kill.
4228 If N is not zero, and if `yank-pop-change-selection' is
4229 non-nil, use `interprogram-cut-function' to transfer the
4230 kill at the new yank point into the window system selection.
4232 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4233 move the yanking point; just return the Nth kill forward."
4235 (let ((interprogram-paste (and (= n
0)
4236 interprogram-paste-function
4237 (funcall interprogram-paste-function
))))
4238 (if interprogram-paste
4240 ;; Disable the interprogram cut function when we add the new
4241 ;; text to the kill ring, so Emacs doesn't try to own the
4242 ;; selection, with identical text.
4243 (let ((interprogram-cut-function nil
))
4244 (if (listp interprogram-paste
)
4245 (mapc 'kill-new
(nreverse interprogram-paste
))
4246 (kill-new interprogram-paste
)))
4248 (or kill-ring
(error "Kill ring is empty"))
4249 (let ((ARGth-kill-element
4250 (nthcdr (mod (- n
(length kill-ring-yank-pointer
))
4254 (setq kill-ring-yank-pointer ARGth-kill-element
)
4255 (when (and yank-pop-change-selection
4257 interprogram-cut-function
)
4258 (funcall interprogram-cut-function
(car ARGth-kill-element
))))
4259 (car ARGth-kill-element
)))))
4263 ;;;; Commands for manipulating the kill ring.
4265 (defcustom kill-read-only-ok nil
4266 "Non-nil means don't signal an error for killing read-only text."
4270 (defun kill-region (beg end
&optional region
)
4271 "Kill (\"cut\") text between point and mark.
4272 This deletes the text from the buffer and saves it in the kill ring.
4273 The command \\[yank] can retrieve it from there.
4274 \(If you want to save the region without killing it, use \\[kill-ring-save].)
4276 If you want to append the killed region to the last killed text,
4277 use \\[append-next-kill] before \\[kill-region].
4279 Any command that calls this function is a \"kill command\".
4280 If the previous command was also a kill command,
4281 the text killed this time appends to the text killed last time
4282 to make one entry in the kill ring.
4284 The killed text is filtered by `filter-buffer-substring' before it is
4285 saved in the kill ring, so the actual saved text might be different
4286 from what was killed.
4288 If the buffer is read-only, Emacs will beep and refrain from deleting
4289 the text, but put the text in the kill ring anyway. This means that
4290 you can use the killing commands to copy text from a read-only buffer.
4292 Lisp programs should use this function for killing text.
4293 (To delete text, use `delete-region'.)
4294 Supply two arguments, character positions BEG and END indicating the
4295 stretch of text to be killed. If the optional argument REGION is
4296 non-nil, the function ignores BEG and END, and kills the current
4298 ;; Pass mark first, then point, because the order matters when
4299 ;; calling `kill-append'.
4300 (interactive (list (mark) (point) 'region
))
4301 (unless (and beg end
)
4302 (user-error "The mark is not set now, so there is no region"))
4304 (let ((string (if region
4305 (funcall region-extract-function
'delete
)
4306 (filter-buffer-substring beg end
'delete
))))
4307 (when string
;STRING is nil if BEG = END
4308 ;; Add that string to the kill ring, one way or another.
4309 (if (eq last-command
'kill-region
)
4310 (kill-append string
(< end beg
))
4312 (when (or string
(eq last-command
'kill-region
))
4313 (setq this-command
'kill-region
))
4314 (setq deactivate-mark t
)
4316 ((buffer-read-only text-read-only
)
4317 ;; The code above failed because the buffer, or some of the characters
4318 ;; in the region, are read-only.
4319 ;; We should beep, in case the user just isn't aware of this.
4320 ;; However, there's no harm in putting
4321 ;; the region's text in the kill ring, anyway.
4322 (copy-region-as-kill beg end region
)
4323 ;; Set this-command now, so it will be set even if we get an error.
4324 (setq this-command
'kill-region
)
4325 ;; This should barf, if appropriate, and give us the correct error.
4326 (if kill-read-only-ok
4327 (progn (message "Read only text copied to kill ring") nil
)
4328 ;; Signal an error if the buffer is read-only.
4329 (barf-if-buffer-read-only)
4330 ;; If the buffer isn't read-only, the text is.
4331 (signal 'text-read-only
(list (current-buffer)))))))
4333 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4334 ;; to get two copies of the text when the user accidentally types M-w and
4335 ;; then corrects it with the intended C-w.
4336 (defun copy-region-as-kill (beg end
&optional region
)
4337 "Save the region as if killed, but don't kill it.
4338 In Transient Mark mode, deactivate the mark.
4339 If `interprogram-cut-function' is non-nil, also save the text for a window
4340 system cut and paste.
4342 The copied text is filtered by `filter-buffer-substring' before it is
4343 saved in the kill ring, so the actual saved text might be different
4344 from what was in the buffer.
4346 When called from Lisp, save in the kill ring the stretch of text
4347 between BEG and END, unless the optional argument REGION is
4348 non-nil, in which case ignore BEG and END, and save the current
4351 This command's old key binding has been given to `kill-ring-save'."
4352 ;; Pass mark first, then point, because the order matters when
4353 ;; calling `kill-append'.
4354 (interactive (list (mark) (point)
4355 (prefix-numeric-value current-prefix-arg
)))
4356 (let ((str (if region
4357 (funcall region-extract-function nil
)
4358 (filter-buffer-substring beg end
))))
4359 (if (eq last-command
'kill-region
)
4360 (kill-append str
(< end beg
))
4362 (setq deactivate-mark t
)
4365 (defun kill-ring-save (beg end
&optional region
)
4366 "Save the region as if killed, but don't kill it.
4367 In Transient Mark mode, deactivate the mark.
4368 If `interprogram-cut-function' is non-nil, also save the text for a window
4369 system cut and paste.
4371 If you want to append the killed line to the last killed text,
4372 use \\[append-next-kill] before \\[kill-ring-save].
4374 The copied text is filtered by `filter-buffer-substring' before it is
4375 saved in the kill ring, so the actual saved text might be different
4376 from what was in the buffer.
4378 When called from Lisp, save in the kill ring the stretch of text
4379 between BEG and END, unless the optional argument REGION is
4380 non-nil, in which case ignore BEG and END, and save the current
4383 This command is similar to `copy-region-as-kill', except that it gives
4384 visual feedback indicating the extent of the region being copied."
4385 ;; Pass mark first, then point, because the order matters when
4386 ;; calling `kill-append'.
4387 (interactive (list (mark) (point)
4388 (prefix-numeric-value current-prefix-arg
)))
4389 (copy-region-as-kill beg end region
)
4390 ;; This use of called-interactively-p is correct because the code it
4391 ;; controls just gives the user visual feedback.
4392 (if (called-interactively-p 'interactive
)
4393 (indicate-copied-region)))
4395 (defun indicate-copied-region (&optional message-len
)
4396 "Indicate that the region text has been copied interactively.
4397 If the mark is visible in the selected window, blink the cursor
4398 between point and mark if there is currently no active region
4401 If the mark lies outside the selected window, display an
4402 informative message containing a sample of the copied text. The
4403 optional argument MESSAGE-LEN, if non-nil, specifies the length
4404 of this sample text; it defaults to 40."
4405 (let ((mark (mark t
))
4407 ;; Inhibit quitting so we can make a quit here
4408 ;; look like a C-g typed as a command.
4410 (if (pos-visible-in-window-p mark
(selected-window))
4411 ;; Swap point-and-mark quickly so as to show the region that
4412 ;; was selected. Don't do it if the region is highlighted.
4413 (unless (and (region-active-p)
4414 (face-background 'region
))
4415 ;; Swap point and mark.
4416 (set-marker (mark-marker) (point) (current-buffer))
4418 (sit-for blink-matching-delay
)
4420 (set-marker (mark-marker) mark
(current-buffer))
4422 ;; If user quit, deactivate the mark
4423 ;; as C-g would as a command.
4424 (and quit-flag
(region-active-p)
4426 (let ((len (min (abs (- mark point
))
4427 (or message-len
40))))
4429 ;; Don't say "killed"; that is misleading.
4430 (message "Saved text until \"%s\""
4431 (buffer-substring-no-properties (- mark len
) mark
))
4432 (message "Saved text from \"%s\""
4433 (buffer-substring-no-properties mark
(+ mark len
))))))))
4435 (defun append-next-kill (&optional interactive
)
4436 "Cause following command, if it kills, to add to previous kill.
4437 If the next command kills forward from point, the kill is
4438 appended to the previous killed text. If the command kills
4439 backward, the kill is prepended. Kill commands that act on the
4440 region, such as `kill-region', are regarded as killing forward if
4441 point is after mark, and killing backward if point is before
4444 If the next command is not a kill command, `append-next-kill' has
4447 The argument is used for internal purposes; do not supply one."
4449 ;; We don't use (interactive-p), since that breaks kbd macros.
4452 (setq this-command
'kill-region
)
4453 (message "If the next command is a kill, it will append"))
4454 (setq last-command
'kill-region
)))
4456 (defvar bidi-directional-controls-chars
"\x202a-\x202e\x2066-\x2069"
4457 "Character set that matches bidirectional formatting control characters.")
4459 (defvar bidi-directional-non-controls-chars
"^\x202a-\x202e\x2066-\x2069"
4460 "Character set that matches any character except bidirectional controls.")
4462 (defun squeeze-bidi-context-1 (from to category replacement
)
4463 "A subroutine of `squeeze-bidi-context'.
4464 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4465 (let ((pt (copy-marker from
))
4466 (limit (copy-marker to
))
4475 ;; L and R categories include embedding and
4476 ;; override controls, but we don't want to
4477 ;; replace them, because that might change
4478 ;; the visual order. Likewise with PDF and
4479 ;; isolate controls.
4480 (+ pt
(skip-chars-forward
4481 bidi-directional-non-controls-chars
4483 ;; Replace any run of non-RTL characters by a single LRM.
4484 (if (null (re-search-forward category lim1 t
))
4485 ;; No more characters of CATEGORY, we are done.
4487 (replace-match replacement nil t
)
4488 (move-marker pt
(point)))
4490 ;; Skip directional controls, if any.
4492 pt
(+ pt
(skip-chars-forward bidi-directional-controls-chars limit
))))))
4494 (defun squeeze-bidi-context (from to
)
4495 "Replace characters between FROM and TO while keeping bidi context.
4497 This function replaces the region of text with as few characters
4498 as possible, while preserving the effect that region will have on
4499 bidirectional display before and after the region."
4500 (let ((start (set-marker (make-marker)
4501 (if (> from
0) from
(+ (point-max) from
))))
4502 (end (set-marker (make-marker) to
))
4503 ;; This is for when they copy text with read-only text
4505 (inhibit-read-only t
))
4506 (if (null (marker-position end
))
4507 (setq end
(point-max-marker)))
4508 ;; Replace each run of non-RTL characters with a single LRM.
4509 (squeeze-bidi-context-1 start end
"\\CR+" "\x200e")
4510 ;; Replace each run of non-LTR characters with a single RLM. Note
4511 ;; that the \cR category includes both the Arabic Letter (AL) and
4512 ;; R characters; here we ignore the distinction between them,
4513 ;; because that distinction only affects Arabic Number (AN)
4514 ;; characters, which are weak and don't affect the reordering.
4515 (squeeze-bidi-context-1 start end
"\\CL+" "\x200f")))
4517 (defun line-substring-with-bidi-context (start end
&optional no-properties
)
4518 "Return buffer text between START and END with its bidi context.
4520 START and END are assumed to belong to the same physical line
4521 of buffer text. This function prepends and appends to the text
4522 between START and END bidi control characters that preserve the
4523 visual order of that text when it is inserted at some other place."
4524 (if (or (< start
(point-min))
4525 (> end
(point-max)))
4526 (signal 'args-out-of-range
(list (current-buffer) start end
)))
4527 (let ((buf (current-buffer))
4528 substr para-dir from to
)
4531 (setq para-dir
(current-bidi-paragraph-direction))
4532 (setq from
(line-beginning-position)
4533 to
(line-end-position))
4535 ;; If we don't have any mixed directional characters in the
4536 ;; entire line, we can just copy the substring without adding
4538 (if (or (looking-at-p "\\CR*$")
4539 (looking-at-p "\\CL*$"))
4540 (setq substr
(if no-properties
4541 (buffer-substring-no-properties start end
)
4542 (buffer-substring start end
)))
4546 (insert-buffer-substring-no-properties buf from to
)
4547 (insert-buffer-substring buf from to
))
4548 (squeeze-bidi-context 1 (1+ (- start from
)))
4549 (squeeze-bidi-context (- end to
) nil
)
4550 (buffer-substring 1 (point-max)))))
4552 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4553 ;; (1) force the string to have the same base embedding
4554 ;; direction as the paragraph direction at the source, no matter
4555 ;; what is the paragraph direction at destination; and (2) avoid
4556 ;; affecting the visual order of the surrounding text at
4557 ;; destination if there are characters of different
4558 ;; directionality there.
4559 (concat (if (eq para-dir
'left-to-right
) "\x2066" "\x2067")
4562 (defun buffer-substring-with-bidi-context (start end
&optional no-properties
)
4563 "Return portion of current buffer between START and END with bidi context.
4565 This function works similar to `buffer-substring', but it prepends and
4566 appends to the text bidi directional control characters necessary to
4567 preserve the visual appearance of the text if it is inserted at another
4568 place. This is useful when the buffer substring includes bidirectional
4569 text and control characters that cause non-trivial reordering on display.
4570 If copied verbatim, such text can have a very different visual appearance,
4571 and can also change the visual appearance of the surrounding text at the
4572 destination of the copy.
4574 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4575 the text properties."
4576 (let (line-end substr
)
4577 (if (or (< start
(point-min))
4578 (> end
(point-max)))
4579 (signal 'args-out-of-range
(list (current-buffer) start end
)))
4582 (setq line-end
(min end
(line-end-position)))
4583 (while (< start end
)
4587 (line-substring-with-bidi-context start line-end
4590 (setq start
(point))
4591 (setq line-end
(min end
(line-end-position))))
4596 (defcustom yank-handled-properties
4597 '((font-lock-face . yank-handle-font-lock-face-property
)
4598 (category . yank-handle-category-property
))
4599 "List of special text property handling conditions for yanking.
4600 Each element should have the form (PROP . FUN), where PROP is a
4601 property symbol and FUN is a function. When the `yank' command
4602 inserts text into the buffer, it scans the inserted text for
4603 stretches of text that have `eq' values of the text property
4604 PROP; for each such stretch of text, FUN is called with three
4605 arguments: the property's value in that text, and the start and
4606 end positions of the text.
4608 This is done prior to removing the properties specified by
4609 `yank-excluded-properties'."
4611 :type
'(repeat (cons (symbol :tag
"property symbol")
4615 ;; This is actually used in subr.el but defcustom does not work there.
4616 (defcustom yank-excluded-properties
4617 '(category field follow-link fontified font-lock-face help-echo
4618 intangible invisible keymap local-map mouse-face read-only
4620 "Text properties to discard when yanking.
4621 The value should be a list of text properties to discard or t,
4622 which means to discard all text properties.
4624 See also `yank-handled-properties'."
4625 :type
'(choice (const :tag
"All" t
) (repeat symbol
))
4629 (defvar yank-window-start nil
)
4630 (defvar yank-undo-function nil
4631 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4632 Function is called with two parameters, START and END corresponding to
4633 the value of the mark and point; it is guaranteed that START <= END.
4634 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
4636 (defun yank-pop (&optional arg
)
4637 "Replace just-yanked stretch of killed text with a different stretch.
4638 This command is allowed only immediately after a `yank' or a `yank-pop'.
4639 At such a time, the region contains a stretch of reinserted
4640 previously-killed text. `yank-pop' deletes that text and inserts in its
4641 place a different stretch of killed text.
4643 With no argument, the previous kill is inserted.
4644 With argument N, insert the Nth previous kill.
4645 If N is negative, this is a more recent kill.
4647 The sequence of kills wraps around, so that after the oldest one
4648 comes the newest one.
4650 When this command inserts killed text into the buffer, it honors
4651 `yank-excluded-properties' and `yank-handler' as described in the
4652 doc string for `insert-for-yank-1', which see."
4654 (if (not (eq last-command
'yank
))
4655 (user-error "Previous command was not a yank"))
4656 (setq this-command
'yank
)
4657 (unless arg
(setq arg
1))
4658 (let ((inhibit-read-only t
)
4659 (before (< (point) (mark t
))))
4661 (funcall (or yank-undo-function
'delete-region
) (point) (mark t
))
4662 (funcall (or yank-undo-function
'delete-region
) (mark t
) (point)))
4663 (setq yank-undo-function nil
)
4664 (set-marker (mark-marker) (point) (current-buffer))
4665 (insert-for-yank (current-kill arg
))
4666 ;; Set the window start back where it was in the yank command,
4668 (set-window-start (selected-window) yank-window-start t
)
4670 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4671 ;; It is cleaner to avoid activation, even though the command
4672 ;; loop would deactivate the mark because we inserted text.
4673 (goto-char (prog1 (mark t
)
4674 (set-marker (mark-marker) (point) (current-buffer))))))
4677 (defun yank (&optional arg
)
4678 "Reinsert (\"paste\") the last stretch of killed text.
4679 More precisely, reinsert the most recent kill, which is the
4680 stretch of killed text most recently killed OR yanked. Put point
4681 at the end, and set mark at the beginning without activating it.
4682 With just \\[universal-argument] as argument, put point at beginning, and mark at end.
4683 With argument N, reinsert the Nth most recent kill.
4685 When this command inserts text into the buffer, it honors the
4686 `yank-handled-properties' and `yank-excluded-properties'
4687 variables, and the `yank-handler' text property. See
4688 `insert-for-yank-1' for details.
4690 See also the command `yank-pop' (\\[yank-pop])."
4692 (setq yank-window-start
(window-start))
4693 ;; If we don't get all the way thru, make last-command indicate that
4694 ;; for the following command.
4695 (setq this-command t
)
4697 (insert-for-yank (current-kill (cond
4702 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4703 ;; It is cleaner to avoid activation, even though the command
4704 ;; loop would deactivate the mark because we inserted text.
4705 (goto-char (prog1 (mark t
)
4706 (set-marker (mark-marker) (point) (current-buffer)))))
4707 ;; If we do get all the way thru, make this-command indicate that.
4708 (if (eq this-command t
)
4709 (setq this-command
'yank
))
4712 (defun rotate-yank-pointer (arg)
4713 "Rotate the yanking point in the kill ring.
4714 With ARG, rotate that many kills forward (or backward, if negative)."
4718 ;; Some kill commands.
4720 ;; Internal subroutine of delete-char
4721 (defun kill-forward-chars (arg)
4722 (if (listp arg
) (setq arg
(car arg
)))
4723 (if (eq arg
'-
) (setq arg -
1))
4724 (kill-region (point) (+ (point) arg
)))
4726 ;; Internal subroutine of backward-delete-char
4727 (defun kill-backward-chars (arg)
4728 (if (listp arg
) (setq arg
(car arg
)))
4729 (if (eq arg
'-
) (setq arg -
1))
4730 (kill-region (point) (- (point) arg
)))
4732 (defcustom backward-delete-char-untabify-method
'untabify
4733 "The method for untabifying when deleting backward.
4734 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4735 `hungry' -- delete all whitespace, both tabs and spaces;
4736 `all' -- delete all whitespace, including tabs, spaces and newlines;
4737 nil -- just delete one character."
4738 :type
'(choice (const untabify
) (const hungry
) (const all
) (const nil
))
4742 (defun backward-delete-char-untabify (arg &optional killp
)
4743 "Delete characters backward, changing tabs into spaces.
4744 The exact behavior depends on `backward-delete-char-untabify-method'.
4745 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4746 Interactively, ARG is the prefix arg (default 1)
4747 and KILLP is t if a prefix arg was specified."
4748 (interactive "*p\nP")
4749 (when (eq backward-delete-char-untabify-method
'untabify
)
4752 (while (and (> count
0) (not (bobp)))
4753 (if (= (preceding-char) ?
\t)
4754 (let ((col (current-column)))
4756 (setq col
(- col
(current-column)))
4757 (insert-char ?\s col
)
4760 (setq count
(1- count
))))))
4761 (let* ((skip (cond ((eq backward-delete-char-untabify-method
'hungry
) " \t")
4762 ((eq backward-delete-char-untabify-method
'all
)
4765 (let* ((oldpt (point))
4766 (wh (- oldpt
(save-excursion
4767 (skip-chars-backward skip
)
4768 (constrain-to-field nil oldpt
)))))
4769 (+ arg
(if (zerop wh
) 0 (1- wh
))))
4771 ;; Avoid warning about delete-backward-char
4772 (with-no-warnings (delete-backward-char n killp
))))
4774 (defun zap-to-char (arg char
)
4775 "Kill up to and including ARGth occurrence of CHAR.
4776 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4777 Goes backward if ARG is negative; error if CHAR not found."
4778 (interactive (list (prefix-numeric-value current-prefix-arg
)
4779 (read-char "Zap to char: " t
)))
4780 ;; Avoid "obsolete" warnings for translation-table-for-input.
4782 (if (char-table-p translation-table-for-input
)
4783 (setq char
(or (aref translation-table-for-input char
) char
))))
4784 (kill-region (point) (progn
4785 (search-forward (char-to-string char
) nil nil arg
)
4788 ;; kill-line and its subroutines.
4790 (defcustom kill-whole-line nil
4791 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4795 (defun kill-line (&optional arg
)
4796 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4797 With prefix argument ARG, kill that many lines from point.
4798 Negative arguments kill lines backward.
4799 With zero argument, kills the text before point on the current line.
4801 When calling from a program, nil means \"no arg\",
4802 a number counts as a prefix arg.
4804 To kill a whole line, when point is not at the beginning, type \
4805 \\[move-beginning-of-line] \\[kill-line] \\[kill-line].
4807 If `show-trailing-whitespace' is non-nil, this command will just
4808 kill the rest of the current line, even if there are only
4811 If option `kill-whole-line' is non-nil, then this command kills the whole line
4812 including its terminating newline, when used at the beginning of a line
4813 with no argument. As a consequence, you can always kill a whole line
4814 by typing \\[move-beginning-of-line] \\[kill-line].
4816 If you want to append the killed line to the last killed text,
4817 use \\[append-next-kill] before \\[kill-line].
4819 If the buffer is read-only, Emacs will beep and refrain from deleting
4820 the line, but put the line in the kill ring anyway. This means that
4821 you can use this command to copy text from a read-only buffer.
4822 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4825 (kill-region (point)
4826 ;; It is better to move point to the other end of the kill
4827 ;; before killing. That way, in a read-only buffer, point
4828 ;; moves across the text that is copied to the kill ring.
4829 ;; The choice has no effect on undo now that undo records
4830 ;; the value of point from before the command was run.
4833 (forward-visible-line (prefix-numeric-value arg
))
4835 (signal 'end-of-buffer nil
))
4838 (end-of-visible-line) (point))))
4839 (if (or (save-excursion
4840 ;; If trailing whitespace is visible,
4841 ;; don't treat it as nothing.
4842 (unless show-trailing-whitespace
4843 (skip-chars-forward " \t" end
))
4845 (and kill-whole-line
(bolp)))
4846 (forward-visible-line 1)
4850 (defun kill-whole-line (&optional arg
)
4852 With prefix ARG, kill that many lines starting from the current line.
4853 If ARG is negative, kill backward. Also kill the preceding newline.
4854 \(This is meant to make \\[repeat] work well with negative arguments.)
4855 If ARG is zero, kill current line but exclude the trailing newline."
4857 (or arg
(setq arg
1))
4858 (if (and (> arg
0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
4859 (signal 'end-of-buffer nil
))
4860 (if (and (< arg
0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
4861 (signal 'beginning-of-buffer nil
))
4862 (unless (eq last-command
'kill-region
)
4864 (setq last-command
'kill-region
))
4866 ;; We need to kill in two steps, because the previous command
4867 ;; could have been a kill command, in which case the text
4868 ;; before point needs to be prepended to the current kill
4869 ;; ring entry and the text after point appended. Also, we
4870 ;; need to use save-excursion to avoid copying the same text
4871 ;; twice to the kill ring in read-only buffers.
4873 (kill-region (point) (progn (forward-visible-line 0) (point))))
4874 (kill-region (point) (progn (end-of-visible-line) (point))))
4877 (kill-region (point) (progn (end-of-visible-line) (point))))
4878 (kill-region (point)
4879 (progn (forward-visible-line (1+ arg
))
4880 (unless (bobp) (backward-char))
4884 (kill-region (point) (progn (forward-visible-line 0) (point))))
4885 (kill-region (point)
4886 (progn (forward-visible-line arg
) (point))))))
4888 (defun forward-visible-line (arg)
4889 "Move forward by ARG lines, ignoring currently invisible newlines only.
4890 If ARG is negative, move backward -ARG lines.
4891 If ARG is zero, move to the beginning of the current line."
4896 (or (zerop (forward-line 1))
4897 (signal 'end-of-buffer nil
))
4898 ;; If the newline we just skipped is invisible,
4901 (get-char-property (1- (point)) 'invisible
)))
4902 (if (if (eq buffer-invisibility-spec t
)
4904 (or (memq prop buffer-invisibility-spec
)
4905 (assq prop buffer-invisibility-spec
)))
4906 (setq arg
(1+ arg
))))
4907 (setq arg
(1- arg
)))
4908 ;; If invisible text follows, and it is a number of complete lines,
4910 (let ((opoint (point)))
4911 (while (and (not (eobp))
4913 (get-char-property (point) 'invisible
)))
4914 (if (eq buffer-invisibility-spec t
)
4916 (or (memq prop buffer-invisibility-spec
)
4917 (assq prop buffer-invisibility-spec
)))))
4919 (if (get-text-property (point) 'invisible
)
4920 (or (next-single-property-change (point) 'invisible
)
4922 (next-overlay-change (point)))))
4924 (goto-char opoint
))))
4926 (while (or first
(<= arg
0))
4929 (or (zerop (forward-line -
1))
4930 (signal 'beginning-of-buffer nil
)))
4931 ;; If the newline we just moved to is invisible,
4935 (get-char-property (1- (point)) 'invisible
)))
4936 (unless (if (eq buffer-invisibility-spec t
)
4938 (or (memq prop buffer-invisibility-spec
)
4939 (assq prop buffer-invisibility-spec
)))
4940 (setq arg
(1+ arg
)))))
4942 ;; If invisible text follows, and it is a number of complete lines,
4944 (let ((opoint (point)))
4945 (while (and (not (bobp))
4947 (get-char-property (1- (point)) 'invisible
)))
4948 (if (eq buffer-invisibility-spec t
)
4950 (or (memq prop buffer-invisibility-spec
)
4951 (assq prop buffer-invisibility-spec
)))))
4953 (if (get-text-property (1- (point)) 'invisible
)
4954 (or (previous-single-property-change (point) 'invisible
)
4956 (previous-overlay-change (point)))))
4958 (goto-char opoint
)))))
4959 ((beginning-of-buffer end-of-buffer
)
4962 (defun end-of-visible-line ()
4963 "Move to end of current visible line."
4965 ;; If the following character is currently invisible,
4966 ;; skip all characters with that same `invisible' property value,
4967 ;; then find the next newline.
4968 (while (and (not (eobp))
4970 (skip-chars-forward "^\n")
4972 (get-char-property (point) 'invisible
)))
4973 (if (eq buffer-invisibility-spec t
)
4975 (or (memq prop buffer-invisibility-spec
)
4976 (assq prop buffer-invisibility-spec
))))))
4977 (skip-chars-forward "^\n")
4978 (if (get-text-property (point) 'invisible
)
4979 (goto-char (or (next-single-property-change (point) 'invisible
)
4981 (goto-char (next-overlay-change (point))))
4984 (defun insert-buffer (buffer)
4985 "Insert after point the contents of BUFFER.
4986 Puts mark after the inserted text.
4987 BUFFER may be a buffer or a buffer name."
4988 (declare (interactive-only insert-buffer-substring
))
4992 (barf-if-buffer-read-only)
4993 (read-buffer "Insert buffer: "
4994 (if (eq (selected-window) (next-window))
4995 (other-buffer (current-buffer))
4996 (window-buffer (next-window)))
5000 (insert-buffer-substring (get-buffer buffer
))
5004 (defun append-to-buffer (buffer start end
)
5005 "Append to specified buffer the text of the region.
5006 It is inserted into that buffer before its point.
5008 When calling from a program, give three arguments:
5009 BUFFER (or buffer name), START and END.
5010 START and END specify the portion of the current buffer to be copied."
5012 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t
))
5013 (region-beginning) (region-end)))
5014 (let* ((oldbuf (current-buffer))
5015 (append-to (get-buffer-create buffer
))
5016 (windows (get-buffer-window-list append-to t t
))
5019 (with-current-buffer append-to
5020 (setq point
(point))
5021 (barf-if-buffer-read-only)
5022 (insert-buffer-substring oldbuf start end
)
5023 (dolist (window windows
)
5024 (when (= (window-point window
) point
)
5025 (set-window-point window
(point))))))))
5027 (defun prepend-to-buffer (buffer start end
)
5028 "Prepend to specified buffer the text of the region.
5029 It is inserted into that buffer after its point.
5031 When calling from a program, give three arguments:
5032 BUFFER (or buffer name), START and END.
5033 START and END specify the portion of the current buffer to be copied."
5034 (interactive "BPrepend to buffer: \nr")
5035 (let ((oldbuf (current-buffer)))
5036 (with-current-buffer (get-buffer-create buffer
)
5037 (barf-if-buffer-read-only)
5039 (insert-buffer-substring oldbuf start end
)))))
5041 (defun copy-to-buffer (buffer start end
)
5042 "Copy to specified buffer the text of the region.
5043 It is inserted into that buffer, replacing existing text there.
5045 When calling from a program, give three arguments:
5046 BUFFER (or buffer name), START and END.
5047 START and END specify the portion of the current buffer to be copied."
5048 (interactive "BCopy to buffer: \nr")
5049 (let ((oldbuf (current-buffer)))
5050 (with-current-buffer (get-buffer-create buffer
)
5051 (barf-if-buffer-read-only)
5054 (insert-buffer-substring oldbuf start end
)))))
5056 (define-error 'mark-inactive
(purecopy "The mark is not active now"))
5058 (defvar activate-mark-hook nil
5059 "Hook run when the mark becomes active.
5060 It is also run at the end of a command, if the mark is active and
5061 it is possible that the region may have changed.")
5063 (defvar deactivate-mark-hook nil
5064 "Hook run when the mark becomes inactive.")
5066 (defun mark (&optional force
)
5067 "Return this buffer's mark value as integer, or nil if never set.
5069 In Transient Mark mode, this function signals an error if
5070 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5071 or the argument FORCE is non-nil, it disregards whether the mark
5072 is active, and returns an integer or nil in the usual way.
5074 If you are using this in an editing command, you are most likely making
5075 a mistake; see the documentation of `set-mark'."
5076 (if (or force
(not transient-mark-mode
) mark-active mark-even-if-inactive
)
5077 (marker-position (mark-marker))
5078 (signal 'mark-inactive nil
)))
5080 ;; Behind display-selections-p.
5082 (defun deactivate-mark (&optional force
)
5083 "Deactivate the mark.
5084 If Transient Mark mode is disabled, this function normally does
5085 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5087 Deactivating the mark sets `mark-active' to nil, updates the
5088 primary selection according to `select-active-regions', and runs
5089 `deactivate-mark-hook'.
5091 If Transient Mark mode was temporarily enabled, reset the value
5092 of the variable `transient-mark-mode'; if this causes Transient
5093 Mark mode to be disabled, don't change `mark-active' to nil or
5094 run `deactivate-mark-hook'."
5095 (when (or (region-active-p) force
)
5096 (when (and (if (eq select-active-regions
'only
)
5097 (eq (car-safe transient-mark-mode
) 'only
)
5098 select-active-regions
)
5100 (display-selections-p))
5101 ;; The var `saved-region-selection', if non-nil, is the text in
5102 ;; the region prior to the last command modifying the buffer.
5103 ;; Set the selection to that, or to the current region.
5104 (cond (saved-region-selection
5105 (if (gui-backend-selection-owner-p 'PRIMARY
)
5106 (gui-set-selection 'PRIMARY saved-region-selection
))
5107 (setq saved-region-selection nil
))
5108 ;; If another program has acquired the selection, region
5109 ;; deactivation should not clobber it (Bug#11772).
5110 ((and (/= (region-beginning) (region-end))
5111 (or (gui-backend-selection-owner-p 'PRIMARY
)
5112 (null (gui-backend-selection-exists-p 'PRIMARY
))))
5113 (gui-set-selection 'PRIMARY
5114 (funcall region-extract-function nil
)))))
5115 (when mark-active
(force-mode-line-update)) ;Refresh toolbar (bug#16382).
5117 ((eq (car-safe transient-mark-mode
) 'only
)
5118 (setq transient-mark-mode
(cdr transient-mark-mode
))
5119 (if (eq transient-mark-mode
(default-value 'transient-mark-mode
))
5120 (kill-local-variable 'transient-mark-mode
)))
5121 ((eq transient-mark-mode
'lambda
)
5122 (kill-local-variable 'transient-mark-mode
)))
5123 (setq mark-active nil
)
5124 (run-hooks 'deactivate-mark-hook
)
5125 (redisplay--update-region-highlight (selected-window))))
5127 (defun activate-mark (&optional no-tmm
)
5129 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5131 (unless (region-active-p)
5132 (force-mode-line-update) ;Refresh toolbar (bug#16382).
5133 (setq mark-active t
)
5134 (unless (or transient-mark-mode no-tmm
)
5135 (setq-local transient-mark-mode
'lambda
))
5136 (run-hooks 'activate-mark-hook
))))
5138 (defun set-mark (pos)
5139 "Set this buffer's mark to POS. Don't use this function!
5140 That is to say, don't use this function unless you want
5141 the user to see that the mark has moved, and you want the previous
5142 mark position to be lost.
5144 Normally, when a new mark is set, the old one should go on the stack.
5145 This is why most applications should use `push-mark', not `set-mark'.
5147 Novice Emacs Lisp programmers often try to use the mark for the wrong
5148 purposes. The mark saves a location for the user's convenience.
5149 Most editing commands should not alter the mark.
5150 To remember a location for internal use in the Lisp program,
5151 store it in a Lisp variable. Example:
5153 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5156 (set-marker (mark-marker) pos
(current-buffer))
5157 (activate-mark 'no-tmm
))
5158 ;; Normally we never clear mark-active except in Transient Mark mode.
5159 ;; But when we actually clear out the mark value too, we must
5160 ;; clear mark-active in any mode.
5162 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5163 ;; it should never be nil if the mark is nil.
5164 (setq mark-active nil
)
5165 (set-marker (mark-marker) nil
)))
5167 (defun save-mark-and-excursion--save ()
5169 (let ((mark (mark-marker)))
5170 (and (marker-position mark
) (copy-marker mark
)))
5173 (defun save-mark-and-excursion--restore (saved-mark-info)
5174 (let ((saved-mark (car saved-mark-info
))
5175 (omark (marker-position (mark-marker)))
5177 (saved-mark-active (cdr saved-mark-info
)))
5179 (if (null saved-mark
)
5180 (set-marker (mark-marker) nil
)
5181 (setf nmark
(marker-position saved-mark
))
5182 (set-marker (mark-marker) nmark
)
5183 (set-marker saved-mark nil
))
5185 (let ((cur-mark-active mark-active
))
5186 (setq mark-active saved-mark-active
)
5187 ;; If mark is active now, and either was not active or was at a
5188 ;; different place, run the activate hook.
5189 (if saved-mark-active
5190 (when (or (not cur-mark-active
)
5191 (not (eq omark nmark
)))
5192 (run-hooks 'activate-mark-hook
))
5193 ;; If mark has ceased to be active, run deactivate hook.
5194 (when cur-mark-active
5195 (run-hooks 'deactivate-mark-hook
))))))
5197 (defmacro save-mark-and-excursion
(&rest body
)
5198 "Like `save-excursion', but also save and restore the mark state.
5199 This macro does what `save-excursion' did before Emacs 25.1."
5200 (let ((saved-marker-sym (make-symbol "saved-marker")))
5201 `(let ((,saved-marker-sym
(save-mark-and-excursion--save)))
5203 (save-excursion ,@body
)
5204 (save-mark-and-excursion--restore ,saved-marker-sym
)))))
5206 (defcustom use-empty-active-region nil
5207 "Whether \"region-aware\" commands should act on empty regions.
5208 If nil, region-aware commands treat empty regions as inactive.
5209 If non-nil, region-aware commands treat the region as active as
5210 long as the mark is active, even if the region is empty.
5212 Region-aware commands are those that act on the region if it is
5213 active and Transient Mark mode is enabled, and on the text near
5217 :group
'editing-basics
)
5219 (defun use-region-p ()
5220 "Return t if the region is active and it is appropriate to act on it.
5221 This is used by commands that act specially on the region under
5222 Transient Mark mode.
5224 The return value is t if Transient Mark mode is enabled and the
5225 mark is active; furthermore, if `use-empty-active-region' is nil,
5226 the region must not be empty. Otherwise, the return value is nil.
5228 For some commands, it may be appropriate to ignore the value of
5229 `use-empty-active-region'; in that case, use `region-active-p'."
5230 (and (region-active-p)
5231 (or use-empty-active-region
(> (region-end) (region-beginning)))))
5233 (defun region-active-p ()
5234 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5236 Some commands act specially on the region when Transient Mark
5237 mode is enabled. Usually, such commands should use
5238 `use-region-p' instead of this function, because `use-region-p'
5239 also checks the value of `use-empty-active-region'."
5240 (and transient-mark-mode mark-active
5241 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5242 ;; without the mark being set (e.g. bug#17324). We really should fix
5243 ;; that problem, but in the mean time, let's make sure we don't say the
5244 ;; region is active when there's no mark.
5245 (progn (cl-assert (mark)) t
)))
5247 (defun region-noncontiguous-p ()
5248 "Return non-nil if the region contains several pieces.
5249 An example is a rectangular region handled as a list of
5250 separate contiguous regions for each line."
5251 (> (length (funcall region-extract-function
'bounds
)) 1))
5253 (defvar redisplay-unhighlight-region-function
5254 (lambda (rol) (when (overlayp rol
) (delete-overlay rol
))))
5256 (defvar redisplay-highlight-region-function
5257 (lambda (start end window rol
)
5258 (if (not (overlayp rol
))
5259 (let ((nrol (make-overlay start end
)))
5260 (funcall redisplay-unhighlight-region-function rol
)
5261 (overlay-put nrol
'window window
)
5262 (overlay-put nrol
'face
'region
)
5263 ;; Normal priority so that a large region doesn't hide all the
5264 ;; overlays within it, but high secondary priority so that if it
5265 ;; ends/starts in the middle of a small overlay, that small overlay
5266 ;; won't hide the region's boundaries.
5267 (overlay-put nrol
'priority
'(nil .
100))
5269 (unless (and (eq (overlay-buffer rol
) (current-buffer))
5270 (eq (overlay-start rol
) start
)
5271 (eq (overlay-end rol
) end
))
5272 (move-overlay rol start end
(current-buffer)))
5275 (defun redisplay--update-region-highlight (window)
5276 (let ((rol (window-parameter window
'internal-region-overlay
)))
5277 (if (not (and (region-active-p)
5278 (or highlight-nonselected-windows
5279 (eq window
(selected-window))
5280 (and (window-minibuffer-p)
5281 (eq window
(minibuffer-selected-window))))))
5282 (funcall redisplay-unhighlight-region-function rol
)
5283 (let* ((pt (window-point window
))
5285 (start (min pt mark
))
5288 (funcall redisplay-highlight-region-function
5289 start end window rol
)))
5290 (unless (equal new rol
)
5291 (set-window-parameter window
'internal-region-overlay
5294 (defvar pre-redisplay-functions
(list #'redisplay--update-region-highlight
)
5295 "Hook run just before redisplay.
5296 It is called in each window that is to be redisplayed. It takes one argument,
5297 which is the window that will be redisplayed. When run, the `current-buffer'
5298 is set to the buffer displayed in that window.")
5300 (defun redisplay--pre-redisplay-functions (windows)
5301 (with-demoted-errors "redisplay--pre-redisplay-functions: %S"
5303 (with-current-buffer (window-buffer (selected-window))
5304 (run-hook-with-args 'pre-redisplay-functions
(selected-window)))
5305 (dolist (win (if (listp windows
) windows
(window-list-1 nil nil t
)))
5306 (with-current-buffer (window-buffer win
)
5307 (run-hook-with-args 'pre-redisplay-functions win
))))))
5309 (add-function :before pre-redisplay-function
5310 #'redisplay--pre-redisplay-functions
)
5313 (defvar-local mark-ring nil
5314 "The list of former marks of the current buffer, most recent first.")
5315 (put 'mark-ring
'permanent-local t
)
5317 (defcustom mark-ring-max
16
5318 "Maximum size of mark ring. Start discarding off end if gets this big."
5320 :group
'editing-basics
)
5322 (defvar global-mark-ring nil
5323 "The list of saved global marks, most recent first.")
5325 (defcustom global-mark-ring-max
16
5326 "Maximum size of global mark ring. \
5327 Start discarding off end if gets this big."
5329 :group
'editing-basics
)
5331 (defun pop-to-mark-command ()
5332 "Jump to mark, and pop a new position for mark off the ring.
5333 \(Does not affect global mark ring)."
5336 (user-error "No mark set in this buffer")
5337 (if (= (point) (mark t
))
5338 (message "Mark popped"))
5339 (goto-char (mark t
))
5342 (defun push-mark-command (arg &optional nomsg
)
5343 "Set mark at where point is.
5344 If no prefix ARG and mark is already set there, just activate it.
5345 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5347 (let ((mark (mark t
)))
5348 (if (or arg
(null mark
) (/= mark
(point)))
5349 (push-mark nil nomsg t
)
5350 (activate-mark 'no-tmm
)
5352 (message "Mark activated")))))
5354 (defcustom set-mark-command-repeat-pop nil
5355 "Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
5356 That means that C-u \\[set-mark-command] \\[set-mark-command]
5357 will pop the mark twice, and
5358 C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
5359 will pop the mark three times.
5361 A value of nil means \\[set-mark-command]'s behavior does not change
5362 after C-u \\[set-mark-command]."
5364 :group
'editing-basics
)
5366 (defun set-mark-command (arg)
5367 "Set the mark where point is, or jump to the mark.
5368 Setting the mark also alters the region, which is the text
5369 between point and mark; this is the closest equivalent in
5370 Emacs to what some editors call the \"selection\".
5372 With no prefix argument, set the mark at point, and push the
5373 old mark position on local mark ring. Also push the old mark on
5374 global mark ring, if the previous mark was set in another buffer.
5376 When Transient Mark Mode is off, immediately repeating this
5377 command activates `transient-mark-mode' temporarily.
5379 With prefix argument (e.g., \\[universal-argument] \\[set-mark-command]), \
5380 jump to the mark, and set the mark from
5381 position popped off the local mark ring (this does not affect the global
5382 mark ring). Use \\[pop-global-mark] to jump to a mark popped off the global
5383 mark ring (see `pop-global-mark').
5385 If `set-mark-command-repeat-pop' is non-nil, repeating
5386 the \\[set-mark-command] command with no prefix argument pops the next position
5387 off the local (or global) mark ring and jumps there.
5389 With \\[universal-argument] \\[universal-argument] as prefix
5390 argument, unconditionally set mark where point is, even if
5391 `set-mark-command-repeat-pop' is non-nil.
5393 Novice Emacs Lisp programmers often try to use the mark for the wrong
5394 purposes. See the documentation of `set-mark' for more information."
5396 (cond ((eq transient-mark-mode
'lambda
)
5397 (kill-local-variable 'transient-mark-mode
))
5398 ((eq (car-safe transient-mark-mode
) 'only
)
5401 ((and (consp arg
) (> (prefix-numeric-value arg
) 4))
5402 (push-mark-command nil
))
5403 ((not (eq this-command
'set-mark-command
))
5405 (pop-to-mark-command)
5406 (push-mark-command t
)))
5407 ((and set-mark-command-repeat-pop
5408 (eq last-command
'pop-global-mark
)
5410 (setq this-command
'pop-global-mark
)
5412 ((or (and set-mark-command-repeat-pop
5413 (eq last-command
'pop-to-mark-command
))
5415 (setq this-command
'pop-to-mark-command
)
5416 (pop-to-mark-command))
5417 ((eq last-command
'set-mark-command
)
5418 (if (region-active-p)
5421 (message "Mark deactivated"))
5423 (message "Mark activated")))
5425 (push-mark-command nil
))))
5427 (defun push-mark (&optional location nomsg activate
)
5428 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5429 If the last global mark pushed was not in the current buffer,
5430 also push LOCATION on the global mark ring.
5431 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5433 Novice Emacs Lisp programmers often try to use the mark for the wrong
5434 purposes. See the documentation of `set-mark' for more information.
5436 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5437 (unless (null (mark t
))
5438 (setq mark-ring
(cons (copy-marker (mark-marker)) mark-ring
))
5439 (when (> (length mark-ring
) mark-ring-max
)
5440 (move-marker (car (nthcdr mark-ring-max mark-ring
)) nil
)
5441 (setcdr (nthcdr (1- mark-ring-max
) mark-ring
) nil
)))
5442 (set-marker (mark-marker) (or location
(point)) (current-buffer))
5443 ;; Now push the mark on the global mark ring.
5444 (if (and global-mark-ring
5445 (eq (marker-buffer (car global-mark-ring
)) (current-buffer)))
5446 ;; The last global mark pushed was in this same buffer.
5447 ;; Don't push another one.
5449 (setq global-mark-ring
(cons (copy-marker (mark-marker)) global-mark-ring
))
5450 (when (> (length global-mark-ring
) global-mark-ring-max
)
5451 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring
)) nil
)
5452 (setcdr (nthcdr (1- global-mark-ring-max
) global-mark-ring
) nil
)))
5453 (or nomsg executing-kbd-macro
(> (minibuffer-depth) 0)
5454 (message "Mark set"))
5455 (if (or activate
(not transient-mark-mode
))
5456 (set-mark (mark t
)))
5460 "Pop off mark ring into the buffer's actual mark.
5461 Does not set point. Does nothing if mark ring is empty."
5463 (setq mark-ring
(nconc mark-ring
(list (copy-marker (mark-marker)))))
5464 (set-marker (mark-marker) (+ 0 (car mark-ring
)) (current-buffer))
5465 (move-marker (car mark-ring
) nil
)
5466 (if (null (mark t
)) (ding))
5467 (setq mark-ring
(cdr mark-ring
)))
5470 (define-obsolete-function-alias
5471 'exchange-dot-and-mark
'exchange-point-and-mark
"23.3")
5472 (defun exchange-point-and-mark (&optional arg
)
5473 "Put the mark where point is now, and point where the mark is now.
5474 This command works even when the mark is not active,
5475 and it reactivates the mark.
5477 If Transient Mark mode is on, a prefix ARG deactivates the mark
5478 if it is active, and otherwise avoids reactivating it. If
5479 Transient Mark mode is off, a prefix ARG enables Transient Mark
5482 (let ((omark (mark t
))
5483 (temp-highlight (eq (car-safe transient-mark-mode
) 'only
)))
5485 (user-error "No mark set in this buffer"))
5488 (cond (temp-highlight
5489 (setq-local transient-mark-mode
(cons 'only transient-mark-mode
)))
5490 ((or (and arg
(region-active-p)) ; (xor arg (not (region-active-p)))
5491 (not (or arg
(region-active-p))))
5493 (t (activate-mark)))
5496 (defcustom shift-select-mode t
5497 "When non-nil, shifted motion keys activate the mark momentarily.
5499 While the mark is activated in this way, any shift-translated point
5500 motion key extends the region, and if Transient Mark mode was off, it
5501 is temporarily turned on. Furthermore, the mark will be deactivated
5502 by any subsequent point motion key that was not shift-translated, or
5503 by any action that normally deactivates the mark in Transient Mark mode.
5505 See `this-command-keys-shift-translated' for the meaning of
5508 :group
'editing-basics
)
5510 (defun handle-shift-selection ()
5511 "Activate/deactivate mark depending on invocation thru shift translation.
5512 This function is called by `call-interactively' when a command
5513 with a `^' character in its `interactive' spec is invoked, before
5514 running the command itself.
5516 If `shift-select-mode' is enabled and the command was invoked
5517 through shift translation, set the mark and activate the region
5518 temporarily, unless it was already set in this way. See
5519 `this-command-keys-shift-translated' for the meaning of shift
5522 Otherwise, if the region has been activated temporarily,
5523 deactivate it, and restore the variable `transient-mark-mode' to
5525 (cond ((and shift-select-mode this-command-keys-shift-translated
)
5526 (unless (and mark-active
5527 (eq (car-safe transient-mark-mode
) 'only
))
5528 (setq-local transient-mark-mode
5530 (unless (eq transient-mark-mode
'lambda
)
5531 transient-mark-mode
)))
5532 (push-mark nil nil t
)))
5533 ((eq (car-safe transient-mark-mode
) 'only
)
5534 (setq transient-mark-mode
(cdr transient-mark-mode
))
5535 (if (eq transient-mark-mode
(default-value 'transient-mark-mode
))
5536 (kill-local-variable 'transient-mark-mode
))
5537 (deactivate-mark))))
5539 (define-minor-mode transient-mark-mode
5540 "Toggle Transient Mark mode.
5541 With a prefix argument ARG, enable Transient Mark mode if ARG is
5542 positive, and disable it otherwise. If called from Lisp, enable
5543 Transient Mark mode if ARG is omitted or nil.
5545 Transient Mark mode is a global minor mode. When enabled, the
5546 region is highlighted with the `region' face whenever the mark
5547 is active. The mark is \"deactivated\" by changing the buffer,
5548 and after certain other operations that set the mark but whose
5549 main purpose is something else--for example, incremental search,
5550 \\[beginning-of-buffer], and \\[end-of-buffer].
5552 You can also deactivate the mark by typing \\[keyboard-quit] or
5553 \\[keyboard-escape-quit].
5555 Many commands change their behavior when Transient Mark mode is
5556 in effect and the mark is active, by acting on the region instead
5557 of their usual default part of the buffer's text. Examples of
5558 such commands include \\[comment-dwim], \\[flush-lines], \\[keep-lines],
5559 \\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
5560 To see the documentation of commands which are sensitive to the
5561 Transient Mark mode, invoke \\[apropos-documentation] and type \"transient\"
5562 or \"mark.*active\" at the prompt."
5564 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5565 :variable
(default-value 'transient-mark-mode
))
5567 (defvar widen-automatically t
5568 "Non-nil means it is ok for commands to call `widen' when they want to.
5569 Some commands will do this in order to go to positions outside
5570 the current accessible part of the buffer.
5572 If `widen-automatically' is nil, these commands will do something else
5573 as a fallback, and won't change the buffer bounds.")
5575 (defvar non-essential nil
5576 "Whether the currently executing code is performing an essential task.
5577 This variable should be non-nil only when running code which should not
5578 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5579 user for a password when we are simply scanning a set of files in the
5580 background or displaying possible completions before the user even asked
5583 (defun pop-global-mark ()
5584 "Pop off global mark ring and jump to the top location."
5586 ;; Pop entries which refer to non-existent buffers.
5587 (while (and global-mark-ring
(not (marker-buffer (car global-mark-ring
))))
5588 (setq global-mark-ring
(cdr global-mark-ring
)))
5589 (or global-mark-ring
5590 (error "No global mark set"))
5591 (let* ((marker (car global-mark-ring
))
5592 (buffer (marker-buffer marker
))
5593 (position (marker-position marker
)))
5594 (setq global-mark-ring
(nconc (cdr global-mark-ring
)
5595 (list (car global-mark-ring
))))
5597 (or (and (>= position
(point-min))
5598 (<= position
(point-max)))
5599 (if widen-automatically
5601 (error "Global mark position is outside accessible part of buffer")))
5602 (goto-char position
)
5603 (switch-to-buffer buffer
)))
5605 (defcustom next-line-add-newlines nil
5606 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5609 :group
'editing-basics
)
5611 (defun next-line (&optional arg try-vscroll
)
5612 "Move cursor vertically down ARG lines.
5613 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5614 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5615 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5616 function will not vscroll.
5620 If there is no character in the target line exactly under the current column,
5621 the cursor is positioned after the character in that line which spans this
5622 column, or at the end of the line if it is not long enough.
5623 If there is no line in the buffer after this one, behavior depends on the
5624 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5625 to create a line, and moves the cursor to that line. Otherwise it moves the
5626 cursor to the end of the buffer.
5628 If the variable `line-move-visual' is non-nil, this command moves
5629 by display lines. Otherwise, it moves by buffer lines, without
5630 taking variable-width characters or continued lines into account.
5632 The command \\[set-goal-column] can be used to create
5633 a semipermanent goal column for this command.
5634 Then instead of trying to move exactly vertically (or as close as possible),
5635 this command moves to the specified goal column (or as close as possible).
5636 The goal column is stored in the variable `goal-column', which is nil
5637 when there is no goal column. Note that setting `goal-column'
5638 overrides `line-move-visual' and causes this command to move by buffer
5639 lines rather than by display lines."
5640 (declare (interactive-only forward-line
))
5641 (interactive "^p\np")
5642 (or arg
(setq arg
1))
5643 (if (and next-line-add-newlines
(= arg
1))
5644 (if (save-excursion (end-of-line) (eobp))
5645 ;; When adding a newline, don't expand an abbrev.
5646 (let ((abbrev-mode nil
))
5648 (insert (if use-hard-newlines hard-newline
"\n")))
5649 (line-move arg nil nil try-vscroll
))
5650 (if (called-interactively-p 'interactive
)
5652 (line-move arg nil nil try-vscroll
)
5653 ((beginning-of-buffer end-of-buffer
)
5654 (signal (car err
) (cdr err
))))
5655 (line-move arg nil nil try-vscroll
)))
5658 (defun previous-line (&optional arg try-vscroll
)
5659 "Move cursor vertically up ARG lines.
5660 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5661 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5662 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5663 function will not vscroll.
5667 If there is no character in the target line exactly over the current column,
5668 the cursor is positioned after the character in that line which spans this
5669 column, or at the end of the line if it is not long enough.
5671 If the variable `line-move-visual' is non-nil, this command moves
5672 by display lines. Otherwise, it moves by buffer lines, without
5673 taking variable-width characters or continued lines into account.
5675 The command \\[set-goal-column] can be used to create
5676 a semipermanent goal column for this command.
5677 Then instead of trying to move exactly vertically (or as close as possible),
5678 this command moves to the specified goal column (or as close as possible).
5679 The goal column is stored in the variable `goal-column', which is nil
5680 when there is no goal column. Note that setting `goal-column'
5681 overrides `line-move-visual' and causes this command to move by buffer
5682 lines rather than by display lines."
5683 (declare (interactive-only
5684 "use `forward-line' with negative argument instead."))
5685 (interactive "^p\np")
5686 (or arg
(setq arg
1))
5687 (if (called-interactively-p 'interactive
)
5689 (line-move (- arg
) nil nil try-vscroll
)
5690 ((beginning-of-buffer end-of-buffer
)
5691 (signal (car err
) (cdr err
))))
5692 (line-move (- arg
) nil nil try-vscroll
))
5695 (defcustom track-eol nil
5696 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5697 This means moving to the end of each line moved onto.
5698 The beginning of a blank line does not count as the end of a line.
5699 This has no effect when the variable `line-move-visual' is non-nil."
5701 :group
'editing-basics
)
5703 (defcustom goal-column nil
5704 "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.
5705 A non-nil setting overrides the variable `line-move-visual', which see."
5706 :type
'(choice integer
5707 (const :tag
"None" nil
))
5708 :group
'editing-basics
)
5709 (make-variable-buffer-local 'goal-column
)
5711 (defvar temporary-goal-column
0
5712 "Current goal column for vertical motion.
5713 It is the column where point was at the start of the current run
5714 of vertical motion commands.
5716 When moving by visual lines via the function `line-move-visual', it is a cons
5717 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5718 divided by the default column width, and HSCROLL is the number of
5719 columns by which window is scrolled from left margin.
5721 When the `track-eol' feature is doing its job, the value is
5722 `most-positive-fixnum'.")
5724 (defcustom line-move-ignore-invisible t
5725 "Non-nil means commands that move by lines ignore invisible newlines.
5726 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5727 as if newlines that are invisible didn't exist, and count
5728 only visible newlines. Thus, moving across across 2 newlines
5729 one of which is invisible will be counted as a one-line move.
5730 Also, a non-nil value causes invisible text to be ignored when
5731 counting columns for the purposes of keeping point in the same
5732 column by \\[next-line] and \\[previous-line].
5734 Outline mode sets this."
5736 :group
'editing-basics
)
5738 (defcustom line-move-visual t
5739 "When non-nil, `line-move' moves point by visual lines.
5740 This movement is based on where the cursor is displayed on the
5741 screen, instead of relying on buffer contents alone. It takes
5742 into account variable-width characters and line continuation.
5743 If nil, `line-move' moves point by logical lines.
5744 A non-nil setting of `goal-column' overrides the value of this variable
5745 and forces movement by logical lines.
5746 A window that is horizontally scrolled also forces movement by logical
5749 :group
'editing-basics
5752 ;; Only used if display-graphic-p.
5753 (declare-function font-info
"font.c" (name &optional frame
))
5755 (defun default-font-height ()
5756 "Return the height in pixels of the current buffer's default face font.
5758 If the default font is remapped (see `face-remapping-alist'), the
5759 function returns the height of the remapped face."
5760 (let ((default-font (face-font 'default
)))
5762 ((and (display-multi-font-p)
5763 ;; Avoid calling font-info if the frame's default font was
5764 ;; not changed since the frame was created. That's because
5765 ;; font-info is expensive for some fonts, see bug #14838.
5766 (not (string= (frame-parameter nil
'font
) default-font
)))
5767 (aref (font-info default-font
) 3))
5768 (t (frame-char-height)))))
5770 (defun default-font-width ()
5771 "Return the width in pixels of the current buffer's default face font.
5773 If the default font is remapped (see `face-remapping-alist'), the
5774 function returns the width of the remapped face."
5775 (let ((default-font (face-font 'default
)))
5777 ((and (display-multi-font-p)
5778 ;; Avoid calling font-info if the frame's default font was
5779 ;; not changed since the frame was created. That's because
5780 ;; font-info is expensive for some fonts, see bug #14838.
5781 (not (string= (frame-parameter nil
'font
) default-font
)))
5782 (let* ((info (font-info (face-font 'default
)))
5783 (width (aref info
11)))
5787 (t (frame-char-width)))))
5789 (defun default-line-height ()
5790 "Return the pixel height of current buffer's default-face text line.
5792 The value includes `line-spacing', if any, defined for the buffer
5794 (let ((dfh (default-font-height))
5795 (lsp (if (display-graphic-p)
5797 (default-value 'line-spacing
)
5798 (frame-parameter nil
'line-spacing
)
5802 (setq lsp
(truncate (* (frame-char-height) lsp
))))
5805 (defun window-screen-lines ()
5806 "Return the number of screen lines in the text area of the selected window.
5808 This is different from `window-text-height' in that this function counts
5809 lines in units of the height of the font used by the default face displayed
5810 in the window, not in units of the frame's default font, and also accounts
5811 for `line-spacing', if any, defined for the window's buffer or frame.
5813 The value is a floating-point number."
5814 (let ((edges (window-inside-pixel-edges))
5815 (dlh (default-line-height)))
5816 (/ (float (- (nth 3 edges
) (nth 1 edges
))) dlh
)))
5818 ;; Returns non-nil if partial move was done.
5819 (defun line-move-partial (arg noerror to-end
)
5821 ;; Move backward (up).
5822 ;; If already vscrolled, reduce vscroll
5823 (let ((vs (window-vscroll nil t
))
5824 (dlh (default-line-height)))
5826 (set-window-vscroll nil
(- vs dlh
) t
)))
5828 ;; Move forward (down).
5829 (let* ((lh (window-line-height -
1))
5834 (this-lh (window-line-height))
5835 (this-height (car this-lh
))
5836 (this-ypos (nth 2 this-lh
))
5837 (dlh (default-line-height))
5838 (wslines (window-screen-lines))
5839 (edges (window-inside-pixel-edges))
5840 (winh (- (nth 3 edges
) (nth 1 edges
) 1))
5842 (if (> (mod wslines
1.0) 0.0)
5843 (setq wslines
(round (+ wslines
0.5))))
5848 (<= this-ypos
(- dlh
)))
5850 (let ((wend (pos-visible-in-window-p t nil t
)))
5851 (setq rbot
(nth 3 wend
)
5853 vpos
(nth 5 wend
))))
5855 (let ((wstart (pos-visible-in-window-p nil nil t
)))
5856 (setq this-ypos
(nth 2 wstart
)
5857 this-height
(nth 4 wstart
))))
5860 (let ((ppos (posn-at-point))
5862 (setq col-row
(posn-actual-col-row ppos
))
5864 (- (cdr col-row
) (window-vscroll))
5865 (cdr (posn-col-row ppos
))))))
5866 ;; VPOS > 0 means the last line is only partially visible.
5867 ;; But if the part that is visible is at least as tall as the
5868 ;; default font, that means the line is actually fully
5869 ;; readable, and something like line-spacing is hidden. So in
5870 ;; that case we accept the last line in the window as still
5871 ;; visible, and consider the margin as starting one line
5873 (if (and vpos
(> vpos
0))
5875 (>= rowh
(default-font-height))
5877 (setq last-line
(min (- wslines scroll-margin
) vpos
))
5878 (setq last-line
(min (- wslines scroll-margin
1) (1- vpos
)))))
5880 ;; If last line of window is fully visible, and vscrolling
5881 ;; more would make this line invisible, move forward.
5882 ((and (or (< (setq vs
(window-vscroll nil t
)) dlh
)
5884 (<= this-height dlh
))
5885 (or (null rbot
) (= rbot
0)))
5887 ;; If cursor is not in the bottom scroll margin, and the
5888 ;; current line is is not too tall, move forward.
5889 ((and (or (null this-height
) (<= this-height winh
))
5894 ;; When already vscrolled, we vscroll some more if we can,
5895 ;; or clear vscroll and move forward at end of tall image.
5897 (when (or (and rbot
(> rbot
0))
5898 (and this-height
(> this-height dlh
)))
5899 (set-window-vscroll nil
(+ vs dlh
) t
)))
5900 ;; If cursor just entered the bottom scroll margin, move forward,
5901 ;; but also optionally vscroll one line so redisplay won't recenter.
5905 ;; Don't vscroll if the partially-visible line at window
5906 ;; bottom is not too tall (a.k.a. "just one more text
5907 ;; line"): in that case, we do want redisplay to behave
5908 ;; normally, i.e. recenter or whatever.
5910 ;; Note: ROWH + RBOT from the value returned by
5911 ;; pos-visible-in-window-p give the total height of the
5912 ;; partially-visible glyph row at the end of the window. As
5913 ;; we are dealing with floats, we disregard sub-pixel
5914 ;; discrepancies between that and DLH.
5915 (if (and rowh rbot
(>= (- (+ rowh rbot
) winh
) 1))
5916 (set-window-vscroll nil dlh t
))
5917 (line-move-1 arg noerror to-end
)
5919 ;; If there are lines above the last line, scroll-up one line.
5920 ((and vpos
(> vpos
0))
5923 ;; Finally, start vscroll.
5925 (set-window-vscroll nil dlh t
)))))))
5928 ;; This is like line-move-1 except that it also performs
5929 ;; vertical scrolling of tall images if appropriate.
5930 ;; That is not really a clean thing to do, since it mixes
5931 ;; scrolling with cursor motion. But so far we don't have
5932 ;; a cleaner solution to the problem of making C-n do something
5933 ;; useful given a tall image.
5934 (defun line-move (arg &optional noerror to-end try-vscroll
)
5935 "Move forward ARG lines.
5936 If NOERROR, don't signal an error if we can't move ARG lines.
5938 TRY-VSCROLL controls whether to vscroll tall lines: if either
5939 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5942 (line-move-1 arg noerror to-end
)
5943 (unless (and auto-window-vscroll try-vscroll
5944 ;; Only vscroll for single line moves
5946 ;; Under scroll-conservatively, the display engine
5947 ;; does this better.
5948 (zerop scroll-conservatively
)
5949 ;; But don't vscroll in a keyboard macro.
5950 (not defining-kbd-macro
)
5951 (not executing-kbd-macro
)
5952 (line-move-partial arg noerror to-end
))
5953 (set-window-vscroll nil
0 t
)
5954 (if (and line-move-visual
5955 ;; Display-based column are incompatible with goal-column.
5957 ;; When the text in the window is scrolled to the left,
5958 ;; display-based motion doesn't make sense (because each
5959 ;; logical line occupies exactly one screen line).
5960 (not (> (window-hscroll) 0))
5961 ;; Likewise when the text _was_ scrolled to the left
5962 ;; when the current run of vertical motion commands
5964 (not (and (memq last-command
5965 `(next-line previous-line
,this-command
))
5967 (numberp temporary-goal-column
)
5968 (>= temporary-goal-column
5969 (- (window-width) hscroll-margin
)))))
5970 (prog1 (line-move-visual arg noerror
)
5971 ;; If we moved into a tall line, set vscroll to make
5972 ;; scrolling through tall images more smooth.
5973 (let ((lh (line-pixel-height))
5974 (edges (window-inside-pixel-edges))
5975 (dlh (default-line-height))
5977 (setq winh
(- (nth 3 edges
) (nth 1 edges
) 1))
5979 (< (point) (window-start))
5984 (line-move-1 arg noerror to-end
)))))
5986 ;; Display-based alternative to line-move-1.
5987 ;; Arg says how many lines to move. The value is t if we can move the
5988 ;; specified number of lines.
5989 (defun line-move-visual (arg &optional noerror
)
5990 "Move ARG lines forward.
5991 If NOERROR, don't signal an error if we can't move that many lines."
5992 (let ((opoint (point))
5993 (hscroll (window-hscroll))
5995 ;; Check if the previous command was a line-motion command, or if
5996 ;; we were called from some other command.
5997 (if (and (consp temporary-goal-column
)
5998 (memq last-command
`(next-line previous-line
,this-command
)))
5999 ;; If so, there's no need to reset `temporary-goal-column',
6000 ;; but we may need to hscroll.
6001 (if (or (/= (cdr temporary-goal-column
) hscroll
)
6002 (> (cdr temporary-goal-column
) 0))
6003 (setq target-hscroll
(cdr temporary-goal-column
)))
6004 ;; Otherwise, we should reset `temporary-goal-column'.
6005 (let ((posn (posn-at-point))
6008 ;; Handle the `overflow-newline-into-fringe' case:
6009 ((eq (nth 1 posn
) 'right-fringe
)
6010 (setq temporary-goal-column
(cons (- (window-width) 1) hscroll
)))
6011 ((car (posn-x-y posn
))
6012 (setq x-pos
(car (posn-x-y posn
)))
6013 ;; In R2L lines, the X pixel coordinate is measured from the
6014 ;; left edge of the window, but columns are still counted
6015 ;; from the logical-order beginning of the line, i.e. from
6016 ;; the right edge in this case. We need to adjust for that.
6017 (if (eq (current-bidi-paragraph-direction) 'right-to-left
)
6018 (setq x-pos
(- (window-body-width nil t
) 1 x-pos
)))
6019 (setq temporary-goal-column
6020 (cons (/ (float x-pos
)
6024 (set-window-hscroll (selected-window) target-hscroll
))
6025 ;; vertical-motion can move more than it was asked to if it moves
6026 ;; across display strings with newlines. We don't want to ring
6027 ;; the bell and announce beginning/end of buffer in that case.
6028 (or (and (or (and (>= arg
0)
6029 (>= (vertical-motion
6030 (cons (or goal-column
6031 (if (consp temporary-goal-column
)
6032 (car temporary-goal-column
)
6033 temporary-goal-column
))
6037 (<= (vertical-motion
6038 (cons (or goal-column
6039 (if (consp temporary-goal-column
)
6040 (car temporary-goal-column
)
6041 temporary-goal-column
))
6046 ;; If the goal column lies on a display string,
6047 ;; `vertical-motion' advances the cursor to the end
6048 ;; of the string. For arg < 0, this can cause the
6049 ;; cursor to get stuck. (Bug#3020).
6050 (= (vertical-motion arg
) arg
)))
6052 (signal (if (< arg
0) 'beginning-of-buffer
'end-of-buffer
)
6055 ;; This is the guts of next-line and previous-line.
6056 ;; Arg says how many lines to move.
6057 ;; The value is t if we can move the specified number of lines.
6058 (defun line-move-1 (arg &optional noerror _to-end
)
6059 ;; Don't run any point-motion hooks, and disregard intangibility,
6060 ;; for intermediate positions.
6061 (let ((inhibit-point-motion-hooks t
)
6064 (if (consp temporary-goal-column
)
6065 (setq temporary-goal-column
(+ (car temporary-goal-column
)
6066 (cdr temporary-goal-column
))))
6069 (if (not (memq last-command
'(next-line previous-line
)))
6070 (setq temporary-goal-column
6071 (if (and track-eol
(eolp)
6072 ;; Don't count beg of empty line as end of line
6073 ;; unless we just did explicit end-of-line.
6074 (or (not (bolp)) (eq last-command
'move-end-of-line
)))
6075 most-positive-fixnum
6078 (if (not (or (integerp selective-display
)
6079 line-move-ignore-invisible
))
6080 ;; Use just newline characters.
6081 ;; Set ARG to 0 if we move as many lines as requested.
6083 (progn (if (> arg
1) (forward-line (1- arg
)))
6084 ;; This way of moving forward ARG lines
6085 ;; verifies that we have a newline after the last one.
6086 ;; It doesn't get confused by intangible text.
6088 (if (zerop (forward-line 1))
6090 (and (zerop (forward-line arg
))
6094 (signal (if (< arg
0)
6095 'beginning-of-buffer
6098 ;; Move by arg lines, but ignore invisible ones.
6100 (while (and (> arg
0) (not done
))
6101 ;; If the following character is currently invisible,
6102 ;; skip all characters with that same `invisible' property value.
6103 (while (and (not (eobp)) (invisible-p (point)))
6104 (goto-char (next-char-property-change (point))))
6106 ;; We don't use `end-of-line', since we want to escape
6107 ;; from field boundaries occurring exactly at point.
6108 (goto-char (constrain-to-field
6109 (let ((inhibit-field-text-motion t
))
6110 (line-end-position))
6112 'inhibit-line-move-field-capture
))
6113 ;; If there's no invisibility here, move over the newline.
6117 (signal 'end-of-buffer nil
)
6119 ((and (> arg
1) ;; Use vertical-motion for last move
6120 (not (integerp selective-display
))
6121 (not (invisible-p (point))))
6122 ;; We avoid vertical-motion when possible
6123 ;; because that has to fontify.
6125 ;; Otherwise move a more sophisticated way.
6126 ((zerop (vertical-motion 1))
6128 (signal 'end-of-buffer nil
)
6131 (setq arg
(1- arg
))))
6132 ;; The logic of this is the same as the loop above,
6133 ;; it just goes in the other direction.
6134 (while (and (< arg
0) (not done
))
6135 ;; For completely consistency with the forward-motion
6136 ;; case, we should call beginning-of-line here.
6137 ;; However, if point is inside a field and on a
6138 ;; continued line, the call to (vertical-motion -1)
6139 ;; below won't move us back far enough; then we return
6140 ;; to the same column in line-move-finish, and point
6141 ;; gets stuck -- cyd
6146 (signal 'beginning-of-buffer nil
)
6148 ((and (< arg -
1) ;; Use vertical-motion for last move
6149 (not (integerp selective-display
))
6150 (not (invisible-p (1- (point)))))
6152 ((zerop (vertical-motion -
1))
6154 (signal 'beginning-of-buffer nil
)
6158 (while (and ;; Don't move over previous invis lines
6159 ;; if our target is the middle of this line.
6160 (or (zerop (or goal-column temporary-goal-column
))
6162 (not (bobp)) (invisible-p (1- (point))))
6163 (goto-char (previous-char-property-change (point))))))))
6164 ;; This is the value the function returns.
6168 ;; If we did not move down as far as desired, at least go
6169 ;; to end of line. Be sure to call point-entered and
6170 ;; point-left-hooks.
6171 (let* ((npoint (prog1 (line-end-position)
6172 (goto-char opoint
)))
6173 (inhibit-point-motion-hooks nil
))
6174 (goto-char npoint
)))
6176 ;; If we did not move up as far as desired,
6177 ;; at least go to beginning of line.
6178 (let* ((npoint (prog1 (line-beginning-position)
6179 (goto-char opoint
)))
6180 (inhibit-point-motion-hooks nil
))
6181 (goto-char npoint
)))
6183 (line-move-finish (or goal-column temporary-goal-column
)
6184 opoint
(> orig-arg
0)))))))
6186 (defun line-move-finish (column opoint forward
)
6189 ;; Set REPEAT to t to repeat the whole thing.
6194 (line-beg (line-beginning-position))
6196 ;; Compute the end of the line
6197 ;; ignoring effectively invisible newlines.
6199 ;; Like end-of-line but ignores fields.
6200 (skip-chars-forward "^\n")
6201 (while (and (not (eobp)) (invisible-p (point)))
6202 (goto-char (next-char-property-change (point)))
6203 (skip-chars-forward "^\n"))
6206 ;; Move to the desired column.
6207 (line-move-to-column (truncate column
))
6209 ;; Corner case: suppose we start out in a field boundary in
6210 ;; the middle of a continued line. When we get to
6211 ;; line-move-finish, point is at the start of a new *screen*
6212 ;; line but the same text line; then line-move-to-column would
6213 ;; move us backwards. Test using C-n with point on the "x" in
6214 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6221 ;; Process intangibility within a line.
6222 ;; With inhibit-point-motion-hooks bound to nil, a call to
6223 ;; goto-char moves point past intangible text.
6225 ;; However, inhibit-point-motion-hooks controls both the
6226 ;; intangibility and the point-entered/point-left hooks. The
6227 ;; following hack avoids calling the point-* hooks
6228 ;; unnecessarily. Note that we move *forward* past intangible
6229 ;; text when the initial and final points are the same.
6231 (let ((inhibit-point-motion-hooks nil
))
6234 ;; If intangibility moves us to a different (later) place
6235 ;; in the same line, use that as the destination.
6236 (if (<= (point) line-end
)
6238 ;; If that position is "too late",
6239 ;; try the previous allowable position.
6243 ;; If going forward, don't accept the previous
6244 ;; allowable position if it is before the target line.
6245 (< line-beg
(point))
6246 ;; If going backward, don't accept the previous
6247 ;; allowable position if it is still after the target line.
6248 (<= (point) line-end
))
6250 ;; As a last resort, use the end of the line.
6251 (setq new line-end
))))
6253 ;; Now move to the updated destination, processing fields
6254 ;; as well as intangibility.
6256 (let ((inhibit-point-motion-hooks nil
))
6258 ;; Ignore field boundaries if the initial and final
6259 ;; positions have the same `field' property, even if the
6260 ;; fields are non-contiguous. This seems to be "nicer"
6261 ;; behavior in many situations.
6262 (if (eq (get-char-property new
'field
)
6263 (get-char-property opoint
'field
))
6265 (constrain-to-field new opoint t t
6266 'inhibit-line-move-field-capture
))))
6268 ;; If all this moved us to a different line,
6269 ;; retry everything within that new line.
6270 (when (or (< (point) line-beg
) (> (point) line-end
))
6271 ;; Repeat the intangibility and field processing.
6272 (setq repeat t
))))))
6274 (defun line-move-to-column (col)
6275 "Try to find column COL, considering invisibility.
6276 This function works only in certain cases,
6277 because what we really need is for `move-to-column'
6278 and `current-column' to be able to ignore invisible text."
6281 (move-to-column col
))
6283 (when (and line-move-ignore-invisible
6284 (not (bolp)) (invisible-p (1- (point))))
6285 (let ((normal-location (point))
6286 (normal-column (current-column)))
6287 ;; If the following character is currently invisible,
6288 ;; skip all characters with that same `invisible' property value.
6289 (while (and (not (eobp))
6290 (invisible-p (point)))
6291 (goto-char (next-char-property-change (point))))
6292 ;; Have we advanced to a larger column position?
6293 (if (> (current-column) normal-column
)
6294 ;; We have made some progress towards the desired column.
6295 ;; See if we can make any further progress.
6296 (line-move-to-column (+ (current-column) (- col normal-column
)))
6297 ;; Otherwise, go to the place we originally found
6298 ;; and move back over invisible text.
6299 ;; that will get us to the same place on the screen
6300 ;; but with a more reasonable buffer position.
6301 (goto-char normal-location
)
6303 ;; We want the real line beginning, so it's consistent
6304 ;; with bolp below, otherwise we might infloop.
6305 (let ((inhibit-field-text-motion t
))
6306 (line-beginning-position))))
6307 (while (and (not (bolp)) (invisible-p (1- (point))))
6308 (goto-char (previous-char-property-change (point) line-beg
))))))))
6310 (defun move-end-of-line (arg)
6311 "Move point to end of current line as displayed.
6312 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6313 If point reaches the beginning or end of buffer, it stops there.
6315 To ignore the effects of the `intangible' text or overlay
6316 property, bind `inhibit-point-motion-hooks' to t.
6317 If there is an image in the current line, this function
6318 disregards newlines that are part of the text on which the image
6321 (or arg
(setq arg
1))
6326 (let ((goal-column 0)
6327 (line-move-visual nil
))
6328 (and (line-move arg t
)
6329 ;; With bidi reordering, we may not be at bol,
6330 ;; so make sure we are.
6331 (skip-chars-backward "^\n")
6334 (while (and (not (bobp)) (invisible-p (1- (point))))
6335 (goto-char (previous-single-char-property-change
6336 (point) 'invisible
)))
6340 (if (and (> (point) newpos
)
6341 (eq (preceding-char) ?
\n))
6343 (if (and (> (point) newpos
) (not (eobp))
6344 (not (eq (following-char) ?
\n)))
6345 ;; If we skipped something intangible and now we're not
6346 ;; really at eol, keep going.
6350 (defun move-beginning-of-line (arg)
6351 "Move point to beginning of current line as displayed.
6352 \(If there's an image in the line, this disregards newlines
6353 which are part of the text that the image rests on.)
6355 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6356 If point reaches the beginning or end of buffer, it stops there.
6357 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6359 (or arg
(setq arg
1))
6361 (let ((orig (point))
6362 first-vis first-vis-field-value
)
6364 ;; Move by lines, if ARG is not 1 (the default).
6366 (let ((line-move-visual nil
))
6367 (line-move (1- arg
) t
)))
6369 ;; Move to beginning-of-line, ignoring fields and invisible text.
6370 (skip-chars-backward "^\n")
6371 (while (and (not (bobp)) (invisible-p (1- (point))))
6372 (goto-char (previous-char-property-change (point)))
6373 (skip-chars-backward "^\n"))
6375 ;; Now find first visible char in the line.
6376 (while (and (< (point) orig
) (invisible-p (point)))
6377 (goto-char (next-char-property-change (point) orig
)))
6378 (setq first-vis
(point))
6380 ;; See if fields would stop us from reaching FIRST-VIS.
6381 (setq first-vis-field-value
6382 (constrain-to-field first-vis orig
(/= arg
1) t nil
))
6384 (goto-char (if (/= first-vis-field-value first-vis
)
6385 ;; If yes, obey them.
6386 first-vis-field-value
6387 ;; Otherwise, move to START with attention to fields.
6388 ;; (It is possible that fields never matter in this case.)
6389 (constrain-to-field (point) orig
6390 (/= arg
1) t nil
)))))
6393 ;; Many people have said they rarely use this feature, and often type
6394 ;; it by accident. Maybe it shouldn't even be on a key.
6395 (put 'set-goal-column
'disabled t
)
6397 (defun set-goal-column (arg)
6398 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
6399 Those commands will move to this position in the line moved to
6400 rather than trying to keep the same horizontal position.
6401 With a non-nil argument ARG, clears out the goal column
6402 so that \\[next-line] and \\[previous-line] resume vertical motion.
6403 The goal column is stored in the variable `goal-column'."
6407 (setq goal-column nil
)
6408 (message "No goal column"))
6409 (setq goal-column
(current-column))
6410 ;; The older method below can be erroneous if `set-goal-column' is bound
6411 ;; to a sequence containing %
6412 ;;(message (substitute-command-keys
6413 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6417 (format "Goal column %d " goal-column
)
6418 (substitute-command-keys
6419 "(use \\[set-goal-column] with an arg to unset it)")))
6424 ;;; Editing based on visual lines, as opposed to logical lines.
6426 (defun end-of-visual-line (&optional n
)
6427 "Move point to end of current visual line.
6428 With argument N not nil or 1, move forward N - 1 visual lines first.
6429 If point reaches the beginning or end of buffer, it stops there.
6430 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6434 (let ((line-move-visual t
))
6435 (line-move (1- n
) t
)))
6436 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6437 ;; constrain to field boundaries, so we don't either.
6438 (vertical-motion (cons (window-width) 0)))
6440 (defun beginning-of-visual-line (&optional n
)
6441 "Move point to beginning of current visual line.
6442 With argument N not nil or 1, move forward N - 1 visual lines first.
6443 If point reaches the beginning or end of buffer, it stops there.
6444 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6447 (let ((opoint (point)))
6449 (let ((line-move-visual t
))
6450 (line-move (1- n
) t
)))
6452 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6453 (goto-char (constrain-to-field (point) opoint
(/= n
1)))))
6455 (defun kill-visual-line (&optional arg
)
6456 "Kill the rest of the visual line.
6457 With prefix argument ARG, kill that many visual lines from point.
6458 If ARG is negative, kill visual lines backward.
6459 If ARG is zero, kill the text before point on the current visual
6462 If you want to append the killed line to the last killed text,
6463 use \\[append-next-kill] before \\[kill-line].
6465 If the buffer is read-only, Emacs will beep and refrain from deleting
6466 the line, but put the line in the kill ring anyway. This means that
6467 you can use this command to copy text from a read-only buffer.
6468 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6471 ;; Like in `kill-line', it's better to move point to the other end
6472 ;; of the kill before killing.
6473 (let ((opoint (point))
6474 (kill-whole-line (and kill-whole-line
(bolp))))
6476 (vertical-motion (prefix-numeric-value arg
))
6477 (end-of-visual-line 1)
6478 (if (= (point) opoint
)
6480 ;; Skip any trailing whitespace at the end of the visual line.
6481 ;; We used to do this only if `show-trailing-whitespace' is
6482 ;; nil, but that's wrong; the correct thing would be to check
6483 ;; whether the trailing whitespace is highlighted. But, it's
6484 ;; OK to just do this unconditionally.
6485 (skip-chars-forward " \t")))
6486 (kill-region opoint
(if (and kill-whole-line
(looking-at "\n"))
6490 (defun next-logical-line (&optional arg try-vscroll
)
6491 "Move cursor vertically down ARG lines.
6492 This is identical to `next-line', except that it always moves
6493 by logical lines instead of visual lines, ignoring the value of
6494 the variable `line-move-visual'."
6495 (interactive "^p\np")
6496 (let ((line-move-visual nil
))
6498 (next-line arg try-vscroll
))))
6500 (defun previous-logical-line (&optional arg try-vscroll
)
6501 "Move cursor vertically up ARG lines.
6502 This is identical to `previous-line', except that it always moves
6503 by logical lines instead of visual lines, ignoring the value of
6504 the variable `line-move-visual'."
6505 (interactive "^p\np")
6506 (let ((line-move-visual nil
))
6508 (previous-line arg try-vscroll
))))
6510 (defgroup visual-line nil
6511 "Editing based on visual lines."
6515 (defvar visual-line-mode-map
6516 (let ((map (make-sparse-keymap)))
6517 (define-key map
[remap kill-line
] 'kill-visual-line
)
6518 (define-key map
[remap move-beginning-of-line
] 'beginning-of-visual-line
)
6519 (define-key map
[remap move-end-of-line
] 'end-of-visual-line
)
6520 ;; These keybindings interfere with xterm function keys. Are
6521 ;; there any other suitable bindings?
6522 ;; (define-key map "\M-[" 'previous-logical-line)
6523 ;; (define-key map "\M-]" 'next-logical-line)
6526 (defcustom visual-line-fringe-indicators
'(nil nil
)
6527 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6528 The value should be a list of the form (LEFT RIGHT), where LEFT
6529 and RIGHT are symbols representing the bitmaps to display, to
6530 indicate wrapped lines, in the left and right fringes respectively.
6531 See also `fringe-indicator-alist'.
6532 The default is not to display fringe indicators for wrapped lines.
6533 This variable does not affect fringe indicators displayed for
6535 :type
'(list (choice (const :tag
"Hide left indicator" nil
)
6536 (const :tag
"Left curly arrow" left-curly-arrow
)
6537 (symbol :tag
"Other bitmap"))
6538 (choice (const :tag
"Hide right indicator" nil
)
6539 (const :tag
"Right curly arrow" right-curly-arrow
)
6540 (symbol :tag
"Other bitmap")))
6541 :set
(lambda (symbol value
)
6542 (dolist (buf (buffer-list))
6543 (with-current-buffer buf
6544 (when (and (boundp 'visual-line-mode
)
6545 (symbol-value 'visual-line-mode
))
6546 (setq fringe-indicator-alist
6547 (cons (cons 'continuation value
)
6550 (copy-tree fringe-indicator-alist
)))))))
6551 (set-default symbol value
)))
6553 (defvar visual-line--saved-state nil
)
6555 (define-minor-mode visual-line-mode
6556 "Toggle visual line based editing (Visual Line mode).
6557 With a prefix argument ARG, enable Visual Line mode if ARG is
6558 positive, and disable it otherwise. If called from Lisp, enable
6559 the mode if ARG is omitted or nil.
6561 When Visual Line mode is enabled, `word-wrap' is turned on in
6562 this buffer, and simple editing commands are redefined to act on
6563 visual lines, not logical lines. See Info node `Visual Line
6565 :keymap visual-line-mode-map
6568 (if visual-line-mode
6570 (set (make-local-variable 'visual-line--saved-state
) nil
)
6571 ;; Save the local values of some variables, to be restored if
6572 ;; visual-line-mode is turned off.
6573 (dolist (var '(line-move-visual truncate-lines
6574 truncate-partial-width-windows
6575 word-wrap fringe-indicator-alist
))
6576 (if (local-variable-p var
)
6577 (push (cons var
(symbol-value var
))
6578 visual-line--saved-state
)))
6579 (set (make-local-variable 'line-move-visual
) t
)
6580 (set (make-local-variable 'truncate-partial-width-windows
) nil
)
6581 (setq truncate-lines nil
6583 fringe-indicator-alist
6584 (cons (cons 'continuation visual-line-fringe-indicators
)
6585 fringe-indicator-alist
)))
6586 (kill-local-variable 'line-move-visual
)
6587 (kill-local-variable 'word-wrap
)
6588 (kill-local-variable 'truncate-lines
)
6589 (kill-local-variable 'truncate-partial-width-windows
)
6590 (kill-local-variable 'fringe-indicator-alist
)
6591 (dolist (saved visual-line--saved-state
)
6592 (set (make-local-variable (car saved
)) (cdr saved
)))
6593 (kill-local-variable 'visual-line--saved-state
)))
6595 (defun turn-on-visual-line-mode ()
6596 (visual-line-mode 1))
6598 (define-globalized-minor-mode global-visual-line-mode
6599 visual-line-mode turn-on-visual-line-mode
)
6602 (defun transpose-chars (arg)
6603 "Interchange characters around point, moving forward one character.
6604 With prefix arg ARG, effect is to take character before point
6605 and drag it forward past ARG other characters (backward if ARG negative).
6606 If no argument and at end of line, the previous two chars are exchanged."
6608 (when (and (null arg
) (eolp) (not (bobp))
6609 (not (get-text-property (1- (point)) 'read-only
)))
6611 (transpose-subr 'forward-char
(prefix-numeric-value arg
)))
6613 (defun transpose-words (arg)
6614 "Interchange words around point, leaving point at end of them.
6615 With prefix arg ARG, effect is to take word before or around point
6616 and drag it forward past ARG other words (backward if ARG negative).
6617 If ARG is zero, the words around or after point and around or after mark
6619 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6621 (transpose-subr 'forward-word arg
))
6623 (defun transpose-sexps (arg)
6624 "Like \\[transpose-words] but applies to sexps.
6625 Does not work on a sexp that point is in the middle of
6626 if it is a list or string."
6630 ;; Here we should try to simulate the behavior of
6631 ;; (cons (progn (forward-sexp x) (point))
6632 ;; (progn (forward-sexp (- x)) (point)))
6633 ;; Except that we don't want to rely on the second forward-sexp
6634 ;; putting us back to where we want to be, since forward-sexp-function
6635 ;; might do funny things like infix-precedence.
6637 (looking-at "\\sw\\|\\s_")
6639 (save-excursion (forward-char -
1) (looking-at "\\sw\\|\\s_"))))
6640 ;; Jumping over a symbol. We might be inside it, mind you.
6641 (progn (funcall (if (> arg
0)
6642 'skip-syntax-backward
'skip-syntax-forward
)
6644 (cons (save-excursion (forward-sexp arg
) (point)) (point)))
6645 ;; Otherwise, we're between sexps. Take a step back before jumping
6646 ;; to make sure we'll obey the same precedence no matter which direction
6648 (funcall (if (> arg
0) 'skip-syntax-backward
'skip-syntax-forward
) " .")
6649 (cons (save-excursion (forward-sexp arg
) (point))
6650 (progn (while (or (forward-comment (if (> arg
0) 1 -
1))
6651 (not (zerop (funcall (if (> arg
0)
6652 'skip-syntax-forward
6653 'skip-syntax-backward
)
6658 (defun transpose-lines (arg)
6659 "Exchange current line and previous line, leaving point after both.
6660 With argument ARG, takes previous line and moves it past ARG lines.
6661 With argument 0, interchanges line point is in with line mark is in."
6663 (transpose-subr (function
6667 ;; Move forward over ARG lines,
6668 ;; but create newlines if necessary.
6669 (setq arg
(forward-line arg
))
6670 (if (/= (preceding-char) ?
\n)
6671 (setq arg
(1+ arg
)))
6674 (forward-line arg
))))
6677 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6678 ;; which seems inconsistent with the ARG /= 0 case.
6679 ;; FIXME document SPECIAL.
6680 (defun transpose-subr (mover arg
&optional special
)
6681 "Subroutine to do the work of transposing objects.
6682 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6683 moves forward by units of the given object (e.g. forward-sentence,
6684 forward-paragraph). If ARG is zero, exchanges the current object
6685 with the one containing mark. If ARG is an integer, moves the
6686 current object past ARG following (if ARG is positive) or
6687 preceding (if ARG is negative) objects, leaving point after the
6689 (let ((aux (if special mover
6691 (cons (progn (funcall mover x
) (point))
6692 (progn (funcall mover
(- x
)) (point))))))
6697 (setq pos1
(funcall aux
1))
6698 (goto-char (or (mark) (error "No mark set in this buffer")))
6699 (setq pos2
(funcall aux
1))
6700 (transpose-subr-1 pos1 pos2
))
6701 (exchange-point-and-mark))
6703 (setq pos1
(funcall aux -
1))
6704 (setq pos2
(funcall aux arg
))
6705 (transpose-subr-1 pos1 pos2
)
6706 (goto-char (car pos2
)))
6708 (setq pos1
(funcall aux -
1))
6709 (goto-char (car pos1
))
6710 (setq pos2
(funcall aux arg
))
6711 (transpose-subr-1 pos1 pos2
)
6712 (goto-char (+ (car pos2
) (- (cdr pos1
) (car pos1
))))))))
6714 (defun transpose-subr-1 (pos1 pos2
)
6715 (when (> (car pos1
) (cdr pos1
)) (setq pos1
(cons (cdr pos1
) (car pos1
))))
6716 (when (> (car pos2
) (cdr pos2
)) (setq pos2
(cons (cdr pos2
) (car pos2
))))
6717 (when (> (car pos1
) (car pos2
))
6719 (setq pos1 pos2 pos2 swap
)))
6720 (if (> (cdr pos1
) (car pos2
)) (error "Don't have two things to transpose"))
6721 (atomic-change-group
6722 ;; This sequence of insertions attempts to preserve marker
6723 ;; positions at the start and end of the transposed objects.
6724 (let* ((word (buffer-substring (car pos2
) (cdr pos2
)))
6725 (len1 (- (cdr pos1
) (car pos1
)))
6726 (len2 (length word
))
6727 (boundary (make-marker)))
6728 (set-marker boundary
(car pos2
))
6729 (goto-char (cdr pos1
))
6730 (insert-before-markers word
)
6731 (setq word
(delete-and-extract-region (car pos1
) (+ (car pos1
) len1
)))
6732 (goto-char boundary
)
6734 (goto-char (+ boundary len1
))
6735 (delete-region (point) (+ (point) len2
))
6736 (set-marker boundary nil
))))
6738 (defun backward-word (&optional arg
)
6739 "Move backward until encountering the beginning of a word.
6740 With argument ARG, do this that many times.
6741 If ARG is omitted or nil, move point backward one word.
6743 The word boundaries are normally determined by the buffer's syntax
6744 table, but `find-word-boundary-function-table', such as set up
6745 by `subword-mode', can change that. If a Lisp program needs to
6746 move by words determined strictly by the syntax table, it should
6747 use `backward-word-strictly' instead."
6749 (forward-word (- (or arg
1))))
6751 (defun mark-word (&optional arg allow-extend
)
6752 "Set mark ARG words away from point.
6753 The place mark goes is the same place \\[forward-word] would
6754 move to with the same argument.
6755 Interactively, if this command is repeated
6756 or (in Transient Mark mode) if the mark is active,
6757 it marks the next ARG words after the ones already marked."
6758 (interactive "P\np")
6759 (cond ((and allow-extend
6760 (or (and (eq last-command this-command
) (mark t
))
6762 (setq arg
(if arg
(prefix-numeric-value arg
)
6763 (if (< (mark) (point)) -
1 1)))
6772 (forward-word (prefix-numeric-value arg
))
6776 (defun kill-word (arg)
6777 "Kill characters forward until encountering the end of a word.
6778 With argument ARG, do this that many times."
6780 (kill-region (point) (progn (forward-word arg
) (point))))
6782 (defun backward-kill-word (arg)
6783 "Kill characters backward until encountering the beginning of a word.
6784 With argument ARG, do this that many times."
6786 (kill-word (- arg
)))
6788 (defun current-word (&optional strict really-word
)
6789 "Return the symbol or word that point is on (or a nearby one) as a string.
6790 The return value includes no text properties.
6791 If optional arg STRICT is non-nil, return nil unless point is within
6792 or adjacent to a symbol or word. In all cases the value can be nil
6793 if there is no word nearby.
6794 The function, belying its name, normally finds a symbol.
6795 If optional arg REALLY-WORD is non-nil, it finds just a word."
6797 (let* ((oldpoint (point)) (start (point)) (end (point))
6798 (syntaxes (if really-word
"w" "w_"))
6799 (not-syntaxes (concat "^" syntaxes
)))
6800 (skip-syntax-backward syntaxes
) (setq start
(point))
6801 (goto-char oldpoint
)
6802 (skip-syntax-forward syntaxes
) (setq end
(point))
6803 (when (and (eq start oldpoint
) (eq end oldpoint
)
6804 ;; Point is neither within nor adjacent to a word.
6806 ;; Look for preceding word in same line.
6807 (skip-syntax-backward not-syntaxes
(line-beginning-position))
6809 ;; No preceding word in same line.
6810 ;; Look for following word in same line.
6812 (skip-syntax-forward not-syntaxes
(line-end-position))
6813 (setq start
(point))
6814 (skip-syntax-forward syntaxes
)
6817 (skip-syntax-backward syntaxes
)
6818 (setq start
(point))))
6819 ;; If we found something nonempty, return it as a string.
6820 (unless (= start end
)
6821 (buffer-substring-no-properties start end
)))))
6823 (defcustom fill-prefix nil
6824 "String for filling to insert at front of new line, or nil for none."
6825 :type
'(choice (const :tag
"None" nil
)
6828 (make-variable-buffer-local 'fill-prefix
)
6829 (put 'fill-prefix
'safe-local-variable
'string-or-null-p
)
6831 (defcustom auto-fill-inhibit-regexp nil
6832 "Regexp to match lines which should not be auto-filled."
6833 :type
'(choice (const :tag
"None" nil
)
6837 (defun do-auto-fill ()
6838 "The default value for `normal-auto-fill-function'.
6839 This is the default auto-fill function, some major modes use a different one.
6840 Returns t if it really did any work."
6841 (let (fc justify give-up
6842 (fill-prefix fill-prefix
))
6843 (if (or (not (setq justify
(current-justification)))
6844 (null (setq fc
(current-fill-column)))
6845 (and (eq justify
'left
)
6846 (<= (current-column) fc
))
6847 (and auto-fill-inhibit-regexp
6848 (save-excursion (beginning-of-line)
6849 (looking-at auto-fill-inhibit-regexp
))))
6850 nil
;; Auto-filling not required
6851 (if (memq justify
'(full center right
))
6852 (save-excursion (unjustify-current-line)))
6854 ;; Choose a fill-prefix automatically.
6855 (when (and adaptive-fill-mode
6856 (or (null fill-prefix
) (string= fill-prefix
"")))
6858 (fill-context-prefix
6859 (save-excursion (fill-forward-paragraph -
1) (point))
6860 (save-excursion (fill-forward-paragraph 1) (point)))))
6861 (and prefix
(not (equal prefix
""))
6862 ;; Use auto-indentation rather than a guessed empty prefix.
6863 (not (and fill-indent-according-to-mode
6864 (string-match "\\`[ \t]*\\'" prefix
)))
6865 (setq fill-prefix prefix
))))
6867 (while (and (not give-up
) (> (current-column) fc
))
6868 ;; Determine where to split the line.
6873 (setq after-prefix
(point))
6875 (looking-at (regexp-quote fill-prefix
))
6876 (setq after-prefix
(match-end 0)))
6877 (move-to-column (1+ fc
))
6878 (fill-move-to-break-point after-prefix
)
6881 ;; See whether the place we found is any good.
6883 (goto-char fill-point
)
6885 ;; There is no use breaking at end of line.
6886 (save-excursion (skip-chars-forward " ") (eolp))
6887 ;; It is futile to split at the end of the prefix
6888 ;; since we would just insert the prefix again.
6889 (and after-prefix
(<= (point) after-prefix
))
6890 ;; Don't split right after a comment starter
6891 ;; since we would just make another comment starter.
6892 (and comment-start-skip
6893 (let ((limit (point)))
6895 (and (re-search-forward comment-start-skip
6897 (eq (point) limit
))))))
6898 ;; No good place to break => stop trying.
6900 ;; Ok, we have a useful place to break the line. Do it.
6901 (let ((prev-column (current-column)))
6902 ;; If point is at the fill-point, do not `save-excursion'.
6903 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6904 ;; point will end up before it rather than after it.
6906 (skip-chars-backward " \t")
6907 (= (point) fill-point
))
6908 (default-indent-new-line t
)
6910 (goto-char fill-point
)
6911 (default-indent-new-line t
)))
6912 ;; Now do justification, if required
6913 (if (not (eq justify
'left
))
6916 (justify-current-line justify nil t
)))
6917 ;; If making the new line didn't reduce the hpos of
6918 ;; the end of the line, then give up now;
6919 ;; trying again will not help.
6920 (if (>= (current-column) prev-column
)
6921 (setq give-up t
))))))
6922 ;; Justify last line.
6923 (justify-current-line justify t t
)
6926 (defvar comment-line-break-function
'comment-indent-new-line
6927 "Mode-specific function which line breaks and continues a comment.
6928 This function is called during auto-filling when a comment syntax
6930 The function should take a single optional argument, which is a flag
6931 indicating whether it should use soft newlines.")
6933 (defun default-indent-new-line (&optional soft
)
6934 "Break line at point and indent.
6935 If a comment syntax is defined, call `comment-indent-new-line'.
6937 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6938 unless optional argument SOFT is non-nil."
6941 (funcall comment-line-break-function soft
)
6942 ;; Insert the newline before removing empty space so that markers
6943 ;; get preserved better.
6944 (if soft
(insert-and-inherit ?
\n) (newline 1))
6945 (save-excursion (forward-char -
1) (delete-horizontal-space))
6946 (delete-horizontal-space)
6948 (if (and fill-prefix
(not adaptive-fill-mode
))
6949 ;; Blindly trust a non-adaptive fill-prefix.
6951 (indent-to-left-margin)
6952 (insert-before-markers-and-inherit fill-prefix
))
6955 ;; If there's an adaptive prefix, use it unless we're inside
6956 ;; a comment and the prefix is not a comment starter.
6958 (indent-to-left-margin)
6959 (insert-and-inherit fill-prefix
))
6960 ;; If we're not inside a comment, just try to indent.
6961 (t (indent-according-to-mode))))))
6963 (defvar normal-auto-fill-function
'do-auto-fill
6964 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6965 Some major modes set this.")
6967 (put 'auto-fill-function
:minor-mode-function
'auto-fill-mode
)
6968 ;; `functions' and `hooks' are usually unsafe to set, but setting
6969 ;; auto-fill-function to nil in a file-local setting is safe and
6970 ;; can be useful to prevent auto-filling.
6971 (put 'auto-fill-function
'safe-local-variable
'null
)
6973 (define-minor-mode auto-fill-mode
6974 "Toggle automatic line breaking (Auto Fill mode).
6975 With a prefix argument ARG, enable Auto Fill mode if ARG is
6976 positive, and disable it otherwise. If called from Lisp, enable
6977 the mode if ARG is omitted or nil.
6979 When Auto Fill mode is enabled, inserting a space at a column
6980 beyond `current-fill-column' automatically breaks the line at a
6983 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6986 The value of `normal-auto-fill-function' specifies the function to use
6987 for `auto-fill-function' when turning Auto Fill mode on."
6988 :variable
(auto-fill-function
6989 .
(lambda (v) (setq auto-fill-function
6990 (if v normal-auto-fill-function
)))))
6992 ;; This holds a document string used to document auto-fill-mode.
6993 (defun auto-fill-function ()
6994 "Automatically break line at a previous space, in insertion of text."
6997 (defun turn-on-auto-fill ()
6998 "Unconditionally turn on Auto Fill mode."
7001 (defun turn-off-auto-fill ()
7002 "Unconditionally turn off Auto Fill mode."
7003 (auto-fill-mode -
1))
7005 (custom-add-option 'text-mode-hook
'turn-on-auto-fill
)
7007 (defun set-fill-column (arg)
7008 "Set `fill-column' to specified argument.
7009 Use \\[universal-argument] followed by a number to specify a column.
7010 Just \\[universal-argument] as argument means to use the current column."
7012 (list (or current-prefix-arg
7013 ;; We used to use current-column silently, but C-x f is too easily
7014 ;; typed as a typo for C-x C-f, so we turned it into an error and
7015 ;; now an interactive prompt.
7016 (read-number "Set fill-column to: " (current-column)))))
7018 (setq arg
(current-column)))
7019 (if (not (integerp arg
))
7020 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7021 (error "set-fill-column requires an explicit argument")
7022 (message "Fill column set to %d (was %d)" arg fill-column
)
7023 (setq fill-column arg
)))
7025 (defun set-selective-display (arg)
7026 "Set `selective-display' to ARG; clear it if no arg.
7027 When the value of `selective-display' is a number > 0,
7028 lines whose indentation is >= that value are not displayed.
7029 The variable `selective-display' has a separate value for each buffer."
7031 (if (eq selective-display t
)
7032 (error "selective-display already in use for marked lines"))
7035 (narrow-to-region (point-min) (point))
7036 (goto-char (window-start))
7037 (vertical-motion (window-height)))))
7038 (setq selective-display
7039 (and arg
(prefix-numeric-value arg
)))
7040 (recenter current-vpos
))
7041 (set-window-start (selected-window) (window-start))
7042 (princ "selective-display set to " t
)
7043 (prin1 selective-display t
)
7046 (defvaralias 'indicate-unused-lines
'indicate-empty-lines
)
7048 (defun toggle-truncate-lines (&optional arg
)
7049 "Toggle truncating of long lines for the current buffer.
7050 When truncating is off, long lines are folded.
7051 With prefix argument ARG, truncate long lines if ARG is positive,
7052 otherwise fold them. Note that in side-by-side windows, this
7053 command has no effect if `truncate-partial-width-windows' is
7056 (setq truncate-lines
7058 (not truncate-lines
)
7059 (> (prefix-numeric-value arg
) 0)))
7060 (force-mode-line-update)
7061 (unless truncate-lines
7062 (let ((buffer (current-buffer)))
7063 (walk-windows (lambda (window)
7064 (if (eq buffer
(window-buffer window
))
7065 (set-window-hscroll window
0)))
7067 (message "Truncate long lines %s"
7068 (if truncate-lines
"enabled" "disabled")))
7070 (defun toggle-word-wrap (&optional arg
)
7071 "Toggle whether to use word-wrapping for continuation lines.
7072 With prefix argument ARG, wrap continuation lines at word boundaries
7073 if ARG is positive, otherwise wrap them at the right screen edge.
7074 This command toggles the value of `word-wrap'. It has no effect
7075 if long lines are truncated."
7080 (> (prefix-numeric-value arg
) 0)))
7081 (force-mode-line-update)
7082 (message "Word wrapping %s"
7083 (if word-wrap
"enabled" "disabled")))
7085 (defvar overwrite-mode-textual
(purecopy " Ovwrt")
7086 "The string displayed in the mode line when in overwrite mode.")
7087 (defvar overwrite-mode-binary
(purecopy " Bin Ovwrt")
7088 "The string displayed in the mode line when in binary overwrite mode.")
7090 (define-minor-mode overwrite-mode
7091 "Toggle Overwrite mode.
7092 With a prefix argument ARG, enable Overwrite mode if ARG is
7093 positive, and disable it otherwise. If called from Lisp, enable
7094 the mode if ARG is omitted or nil.
7096 When Overwrite mode is enabled, printing characters typed in
7097 replace existing text on a one-for-one basis, rather than pushing
7098 it to the right. At the end of a line, such characters extend
7099 the line. Before a tab, such characters insert until the tab is
7100 filled in. \\[quoted-insert] still inserts characters in
7101 overwrite mode; this is supposed to make it easier to insert
7102 characters when necessary."
7103 :variable
(overwrite-mode
7104 .
(lambda (v) (setq overwrite-mode
(if v
'overwrite-mode-textual
)))))
7106 (define-minor-mode binary-overwrite-mode
7107 "Toggle Binary Overwrite mode.
7108 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7109 is positive, and disable it otherwise. If called from Lisp,
7110 enable the mode if ARG is omitted or nil.
7112 When Binary Overwrite mode is enabled, printing characters typed
7113 in replace existing text. Newlines are not treated specially, so
7114 typing at the end of a line joins the line to the next, with the
7115 typed character between them. Typing before a tab character
7116 simply replaces the tab with the character typed.
7117 \\[quoted-insert] replaces the text at the cursor, just as
7118 ordinary typing characters do.
7120 Note that Binary Overwrite mode is not its own minor mode; it is
7121 a specialization of overwrite mode, entered by setting the
7122 `overwrite-mode' variable to `overwrite-mode-binary'."
7123 :variable
(overwrite-mode
7124 .
(lambda (v) (setq overwrite-mode
(if v
'overwrite-mode-binary
)))))
7126 (define-minor-mode line-number-mode
7127 "Toggle line number display in the mode line (Line Number mode).
7128 With a prefix argument ARG, enable Line Number mode if ARG is
7129 positive, and disable it otherwise. If called from Lisp, enable
7130 the mode if ARG is omitted or nil.
7132 Line numbers do not appear for very large buffers and buffers
7133 with very long lines; see variables `line-number-display-limit'
7134 and `line-number-display-limit-width'."
7135 :init-value t
:global t
:group
'mode-line
)
7137 (define-minor-mode column-number-mode
7138 "Toggle column number display in the mode line (Column Number mode).
7139 With a prefix argument ARG, enable Column Number mode if ARG is
7140 positive, and disable it otherwise.
7142 If called from Lisp, enable the mode if ARG is omitted or nil."
7143 :global t
:group
'mode-line
)
7145 (define-minor-mode size-indication-mode
7146 "Toggle buffer size display in the mode line (Size Indication mode).
7147 With a prefix argument ARG, enable Size Indication mode if ARG is
7148 positive, and disable it otherwise.
7150 If called from Lisp, enable the mode if ARG is omitted or nil."
7151 :global t
:group
'mode-line
)
7153 (define-minor-mode auto-save-mode
7154 "Toggle auto-saving in the current buffer (Auto Save mode).
7155 With a prefix argument ARG, enable Auto Save mode if ARG is
7156 positive, and disable it otherwise.
7158 If called from Lisp, enable the mode if ARG is omitted or nil."
7159 :variable
((and buffer-auto-save-file-name
7160 ;; If auto-save is off because buffer has shrunk,
7161 ;; then toggling should turn it on.
7162 (>= buffer-saved-size
0))
7164 (setq buffer-auto-save-file-name
7167 ((and buffer-file-name auto-save-visited-file-name
7168 (not buffer-read-only
))
7170 (t (make-auto-save-file-name))))))
7171 ;; If -1 was stored here, to temporarily turn off saving,
7173 (and (< buffer-saved-size
0)
7174 (setq buffer-saved-size
0)))
7176 (defgroup paren-blinking nil
7177 "Blinking matching of parens and expressions."
7178 :prefix
"blink-matching-"
7179 :group
'paren-matching
)
7181 (defcustom blink-matching-paren t
7182 "Non-nil means show matching open-paren when close-paren is inserted.
7183 If t, highlight the paren. If `jump', briefly move cursor to its
7184 position. If `jump-offscreen', move cursor there even if the
7185 position is off screen. With any other non-nil value, the
7186 off-screen position of the opening paren will be shown in the
7189 (const :tag
"Disable" nil
)
7190 (const :tag
"Highlight" t
)
7191 (const :tag
"Move cursor" jump
)
7192 (const :tag
"Move cursor, even if off screen" jump-offscreen
))
7193 :group
'paren-blinking
)
7195 (defcustom blink-matching-paren-on-screen t
7196 "Non-nil means show matching open-paren when it is on screen.
7197 If nil, don't show it (but the open-paren can still be shown
7198 in the echo area when it is off screen).
7200 This variable has no effect if `blink-matching-paren' is nil.
7201 \(In that case, the open-paren is never shown.)
7202 It is also ignored if `show-paren-mode' is enabled."
7204 :group
'paren-blinking
)
7206 (defcustom blink-matching-paren-distance
(* 100 1024)
7207 "If non-nil, maximum distance to search backwards for matching open-paren.
7208 If nil, search stops at the beginning of the accessible portion of the buffer."
7209 :version
"23.2" ; 25->100k
7210 :type
'(choice (const nil
) integer
)
7211 :group
'paren-blinking
)
7213 (defcustom blink-matching-delay
1
7214 "Time in seconds to delay after showing a matching paren."
7216 :group
'paren-blinking
)
7218 (defcustom blink-matching-paren-dont-ignore-comments nil
7219 "If nil, `blink-matching-paren' ignores comments.
7220 More precisely, when looking for the matching parenthesis,
7221 it skips the contents of comments that end before point."
7223 :group
'paren-blinking
)
7225 (defun blink-matching-check-mismatch (start end
)
7226 "Return whether or not START...END are matching parens.
7227 END is the current point and START is the blink position.
7228 START might be nil if no matching starter was found.
7229 Returns non-nil if we find there is a mismatch."
7230 (let* ((end-syntax (syntax-after (1- end
)))
7231 (matching-paren (and (consp end-syntax
)
7232 (eq (syntax-class end-syntax
) 5)
7234 ;; For self-matched chars like " and $, we can't know when they're
7235 ;; mismatched or unmatched, so we can only do it for parens.
7236 (when matching-paren
7239 (eq (char-after start
) matching-paren
)
7240 ;; The cdr might hold a new paren-class info rather than
7241 ;; a matching-char info, in which case the two CDRs
7243 (eq matching-paren
(cdr-safe (syntax-after start
)))))))))
7245 (defvar blink-matching-check-function
#'blink-matching-check-mismatch
7246 "Function to check parentheses mismatches.
7247 The function takes two arguments (START and END) where START is the
7248 position just before the opening token and END is the position right after.
7249 START can be nil, if it was not found.
7250 The function should return non-nil if the two tokens do not match.")
7252 (defvar blink-matching--overlay
7253 (let ((ol (make-overlay (point) (point) nil t
)))
7254 (overlay-put ol
'face
'show-paren-match
)
7257 "Overlay used to highlight the matching paren.")
7259 (defun blink-matching-open ()
7260 "Momentarily highlight the beginning of the sexp before point."
7262 (when (and (not (bobp))
7263 blink-matching-paren
)
7264 (let* ((oldpos (point))
7265 (message-log-max nil
) ; Don't log messages about paren matching.
7269 (if blink-matching-paren-distance
7271 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
7272 (- (point) blink-matching-paren-distance
))
7274 (let ((parse-sexp-ignore-comments
7275 (and parse-sexp-ignore-comments
7276 (not blink-matching-paren-dont-ignore-comments
))))
7279 (syntax-propertize (point))
7281 ;; backward-sexp skips backward over prefix chars,
7282 ;; so move back to the matching paren.
7283 (while (and (< (point) (1- oldpos
))
7284 (let ((code (syntax-after (point))))
7285 (or (eq (syntax-class code
) 6)
7286 (eq (logand 1048576 (car code
))
7291 (mismatch (funcall blink-matching-check-function blinkpos oldpos
)))
7296 (minibuffer-message "Mismatched parentheses")
7297 (message "Mismatched parentheses"))
7299 (minibuffer-message "No matching parenthesis found")
7300 (message "No matching parenthesis found"))))
7301 ((not blinkpos
) nil
)
7303 (eq blink-matching-paren
'jump-offscreen
)
7304 (pos-visible-in-window-p blinkpos
))
7305 ;; Matching open within window, temporarily move to or highlight
7306 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7308 (and blink-matching-paren-on-screen
7309 (not show-paren-mode
)
7310 (if (memq blink-matching-paren
'(jump jump-offscreen
))
7312 (goto-char blinkpos
)
7313 (sit-for blink-matching-delay
))
7316 (move-overlay blink-matching--overlay blinkpos
(1+ blinkpos
)
7318 (sit-for blink-matching-delay
))
7319 (delete-overlay blink-matching--overlay
)))))
7321 (let ((open-paren-line-string
7323 (goto-char blinkpos
)
7324 ;; Show what precedes the open in its line, if anything.
7326 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
7327 (buffer-substring (line-beginning-position)
7329 ;; Show what follows the open in its line, if anything.
7332 (skip-chars-forward " \t")
7334 (buffer-substring blinkpos
7335 (line-end-position)))
7336 ;; Otherwise show the previous nonblank line,
7338 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
7340 (buffer-substring (progn
7341 (skip-chars-backward "\n \t")
7342 (line-beginning-position))
7343 (progn (end-of-line)
7344 (skip-chars-backward " \t")
7346 ;; Replace the newline and other whitespace with `...'.
7348 (buffer-substring blinkpos
(1+ blinkpos
))))
7349 ;; There is nothing to show except the char itself.
7350 (t (buffer-substring blinkpos
(1+ blinkpos
)))))))
7353 (substring-no-properties open-paren-line-string
))))))))
7355 (defvar blink-paren-function
'blink-matching-open
7356 "Function called, if non-nil, whenever a close parenthesis is inserted.
7357 More precisely, a char with closeparen syntax is self-inserted.")
7359 (defun blink-paren-post-self-insert-function ()
7360 (when (and (eq (char-before) last-command-event
) ; Sanity check.
7361 (memq (char-syntax last-command-event
) '(?\
) ?\$
))
7362 blink-paren-function
7363 (not executing-kbd-macro
)
7364 (not noninteractive
)
7365 ;; Verify an even number of quoting characters precede the close.
7366 ;; FIXME: Also check if this parenthesis closes a comment as
7367 ;; can happen in Pascal and SML.
7368 (= 1 (logand 1 (- (point)
7371 (skip-syntax-backward "/\\")
7373 (funcall blink-paren-function
)))
7375 (put 'blink-paren-post-self-insert-function
'priority
100)
7377 (add-hook 'post-self-insert-hook
#'blink-paren-post-self-insert-function
7378 ;; Most likely, this hook is nil, so this arg doesn't matter,
7379 ;; but I use it as a reminder that this function usually
7380 ;; likes to be run after others since it does
7381 ;; `sit-for'. That's also the reason it get a `priority' prop
7385 ;; This executes C-g typed while Emacs is waiting for a command.
7386 ;; Quitting out of a program does not go through here;
7387 ;; that happens in the QUIT macro at the C code level.
7388 (defun keyboard-quit ()
7389 "Signal a `quit' condition.
7390 During execution of Lisp code, this character causes a quit directly.
7391 At top-level, as an editor command, this simply beeps."
7393 ;; Avoid adding the region to the window selection.
7394 (setq saved-region-selection nil
)
7395 (let (select-active-regions)
7397 (if (fboundp 'kmacro-keyboard-quit
)
7398 (kmacro-keyboard-quit))
7399 (when completion-in-region-mode
7400 (completion-in-region-mode -
1))
7401 ;; Force the next redisplay cycle to remove the "Def" indicator from
7402 ;; all the mode lines.
7403 (if defining-kbd-macro
7404 (force-mode-line-update t
))
7405 (setq defining-kbd-macro nil
)
7406 (let ((debug-on-quit nil
))
7407 (signal 'quit nil
)))
7409 (defvar buffer-quit-function nil
7410 "Function to call to \"quit\" the current buffer, or nil if none.
7411 \\[keyboard-escape-quit] calls this function when its more local actions
7412 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
7414 (defun keyboard-escape-quit ()
7415 "Exit the current \"mode\" (in a generalized sense of the word).
7416 This command can exit an interactive command such as `query-replace',
7417 can clear out a prefix argument or a region,
7418 can get out of the minibuffer or other recursive edit,
7419 cancel the use of the current buffer (for special-purpose buffers),
7420 or go back to just one window (by deleting all but the selected window)."
7422 (cond ((eq last-command
'mode-exited
) nil
)
7425 ((> (minibuffer-depth) 0)
7426 (abort-recursive-edit))
7429 ((> (recursion-depth) 0)
7430 (exit-recursive-edit))
7431 (buffer-quit-function
7432 (funcall buffer-quit-function
))
7433 ((not (one-window-p t
))
7434 (delete-other-windows))
7435 ((string-match "^ \\*" (buffer-name (current-buffer)))
7438 (defun play-sound-file (file &optional volume device
)
7439 "Play sound stored in FILE.
7440 VOLUME and DEVICE correspond to the keywords of the sound
7441 specification for `play-sound'."
7442 (interactive "fPlay sound file: ")
7443 (let ((sound (list :file file
)))
7445 (plist-put sound
:volume volume
))
7447 (plist-put sound
:device device
))
7449 (play-sound sound
)))
7452 (defcustom read-mail-command
'rmail
7453 "Your preference for a mail reading package.
7454 This is used by some keybindings which support reading mail.
7455 See also `mail-user-agent' concerning sending mail."
7456 :type
'(radio (function-item :tag
"Rmail" :format
"%t\n" rmail
)
7457 (function-item :tag
"Gnus" :format
"%t\n" gnus
)
7458 (function-item :tag
"Emacs interface to MH"
7459 :format
"%t\n" mh-rmail
)
7460 (function :tag
"Other"))
7464 (defcustom mail-user-agent
'message-user-agent
7465 "Your preference for a mail composition package.
7466 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7467 outgoing email message. This variable lets you specify which
7468 mail-sending package you prefer.
7470 Valid values include:
7472 `message-user-agent' -- use the Message package.
7473 See Info node `(message)'.
7474 `sendmail-user-agent' -- use the Mail package.
7475 See Info node `(emacs)Sending Mail'.
7476 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7477 See Info node `(mh-e)'.
7478 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7479 paraphernalia if Gnus is running, particularly
7480 the Gcc: header for archiving.
7482 Additional valid symbols may be available; check with the author of
7483 your package for details. The function should return non-nil if it
7486 See also `read-mail-command' concerning reading mail."
7487 :type
'(radio (function-item :tag
"Message package"
7490 (function-item :tag
"Mail package"
7492 sendmail-user-agent
)
7493 (function-item :tag
"Emacs interface to MH"
7496 (function-item :tag
"Message with full Gnus features"
7499 (function :tag
"Other"))
7500 :version
"23.2" ; sendmail->message
7503 (defcustom compose-mail-user-agent-warnings t
7504 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7505 If the value of `mail-user-agent' is the default, and the user
7506 appears to have customizations applying to the old default,
7507 `compose-mail' issues a warning."
7512 (defun rfc822-goto-eoh ()
7513 "If the buffer starts with a mail header, move point to the header's end.
7514 Otherwise, moves to `point-min'.
7515 The end of the header is the start of the next line, if there is one,
7516 else the end of the last line. This function obeys RFC822."
7517 (goto-char (point-min))
7518 (when (re-search-forward
7519 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil
'move
)
7520 (goto-char (match-beginning 0))))
7522 ;; Used by Rmail (e.g., rmail-forward).
7523 (defvar mail-encode-mml nil
7524 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7525 the outgoing message before sending it.")
7527 (defun compose-mail (&optional to subject other-headers continue
7528 switch-function yank-action send-actions
7530 "Start composing a mail message to send.
7531 This uses the user's chosen mail composition package
7532 as selected with the variable `mail-user-agent'.
7533 The optional arguments TO and SUBJECT specify recipients
7534 and the initial Subject field, respectively.
7536 OTHER-HEADERS is an alist specifying additional
7537 header fields. Elements look like (HEADER . VALUE) where both
7538 HEADER and VALUE are strings.
7540 CONTINUE, if non-nil, says to continue editing a message already
7541 being composed. Interactively, CONTINUE is the prefix argument.
7543 SWITCH-FUNCTION, if non-nil, is a function to use to
7544 switch to and display the buffer used for mail composition.
7546 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7547 to insert the raw text of the message being replied to.
7548 It has the form (FUNCTION . ARGS). The user agent will apply
7549 FUNCTION to ARGS, to insert the raw text of the original message.
7550 \(The user agent will also run `mail-citation-hook', *after* the
7551 original text has been inserted in this way.)
7553 SEND-ACTIONS is a list of actions to call when the message is sent.
7554 Each action has the form (FUNCTION . ARGS).
7556 RETURN-ACTION, if non-nil, is an action for returning to the
7557 caller. It has the form (FUNCTION . ARGS). The function is
7558 called after the mail has been sent or put aside, and the mail
7561 (list nil nil nil current-prefix-arg
))
7563 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7564 ;; from sendmail-user-agent to message-user-agent. Some users may
7565 ;; encounter incompatibilities. This hack tries to detect problems
7566 ;; and warn about them.
7567 (and compose-mail-user-agent-warnings
7568 (eq mail-user-agent
'message-user-agent
)
7570 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
7571 mail-yank-hooks mail-archive-file-name
7572 mail-default-reply-to mail-mailing-lists
7576 (push var warn-vars
)))
7578 (display-warning 'mail
7580 The default mail mode is now Message mode.
7581 You have the following Mail mode variable%s customized:
7582 \n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
7583 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7584 (if (> (length warn-vars
) 1) "s" "")
7585 (mapconcat 'symbol-name
7588 (let ((function (get mail-user-agent
'composefunc
)))
7589 (funcall function to subject other-headers continue switch-function
7590 yank-action send-actions return-action
)))
7592 (defun compose-mail-other-window (&optional to subject other-headers continue
7593 yank-action send-actions
7595 "Like \\[compose-mail], but edit the outgoing message in another window."
7596 (interactive (list nil nil nil current-prefix-arg
))
7597 (compose-mail to subject other-headers continue
7598 'switch-to-buffer-other-window yank-action send-actions
7601 (defun compose-mail-other-frame (&optional to subject other-headers continue
7602 yank-action send-actions
7604 "Like \\[compose-mail], but edit the outgoing message in another frame."
7605 (interactive (list nil nil nil current-prefix-arg
))
7606 (compose-mail to subject other-headers continue
7607 'switch-to-buffer-other-frame yank-action send-actions
7611 (defvar set-variable-value-history nil
7612 "History of values entered with `set-variable'.
7614 Maximum length of the history list is determined by the value
7615 of `history-length', which see.")
7617 (defun set-variable (variable value
&optional make-local
)
7618 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7619 VARIABLE should be a user option variable name, a Lisp variable
7620 meant to be customized by users. You should enter VALUE in Lisp syntax,
7621 so if you want VALUE to be a string, you must surround it with doublequotes.
7622 VALUE is used literally, not evaluated.
7624 If VARIABLE has a `variable-interactive' property, that is used as if
7625 it were the arg to `interactive' (which see) to interactively read VALUE.
7627 If VARIABLE has been defined with `defcustom', then the type information
7628 in the definition is used to check that VALUE is valid.
7630 Note that this function is at heart equivalent to the basic `set' function.
7631 For a variable defined with `defcustom', it does not pay attention to
7632 any :set property that the variable might have (if you want that, use
7633 \\[customize-set-variable] instead).
7635 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7637 (let* ((default-var (variable-at-point))
7638 (var (if (custom-variable-p default-var
)
7639 (read-variable (format "Set variable (default %s): " default-var
)
7641 (read-variable "Set variable: ")))
7642 (minibuffer-help-form '(describe-variable var
))
7643 (prop (get var
'variable-interactive
))
7644 (obsolete (car (get var
'byte-obsolete-variable
)))
7645 (prompt (format "Set %s %s to value: " var
7646 (cond ((local-variable-p var
)
7648 ((or current-prefix-arg
7649 (local-variable-if-set-p var
))
7654 (message (concat "`%S' is obsolete; "
7655 (if (symbolp obsolete
) "use `%S' instead" "%s"))
7659 ;; Use VAR's `variable-interactive' property
7660 ;; as an interactive spec for prompting.
7661 (call-interactively `(lambda (arg)
7664 (read-from-minibuffer prompt nil
7665 read-expression-map t
7666 'set-variable-value-history
7667 (format "%S" (symbol-value var
)))))))
7668 (list var val current-prefix-arg
)))
7670 (and (custom-variable-p variable
)
7671 (not (get variable
'custom-type
))
7672 (custom-load-symbol variable
))
7673 (let ((type (get variable
'custom-type
)))
7675 ;; Match with custom type.
7677 (setq type
(widget-convert type
))
7678 (unless (widget-apply type
:match value
)
7679 (user-error "Value `%S' does not match type %S of %S"
7680 value
(car type
) variable
))))
7683 (make-local-variable variable
))
7685 (set variable value
)
7687 ;; Force a thorough redisplay for the case that the variable
7688 ;; has an effect on the display, like `tab-width' has.
7689 (force-mode-line-update))
7691 ;; Define the major mode for lists of completions.
7693 (defvar completion-list-mode-map
7694 (let ((map (make-sparse-keymap)))
7695 (define-key map
[mouse-2
] 'choose-completion
)
7696 (define-key map
[follow-link
] 'mouse-face
)
7697 (define-key map
[down-mouse-2
] nil
)
7698 (define-key map
"\C-m" 'choose-completion
)
7699 (define-key map
"\e\e\e" 'delete-completion-window
)
7700 (define-key map
[left] 'previous-completion)
7701 (define-key map [right] 'next-completion)
7702 (define-key map [?\t] 'next-completion)
7703 (define-key map [backtab] 'previous-completion)
7704 (define-key map "q" 'quit-window)
7705 (define-key map "z" 'kill-this-buffer)
7707 "Local map for completion list buffers.")
7709 ;; Completion mode is suitable only for specially formatted data.
7710 (put 'completion-list-mode 'mode-class 'special)
7712 (defvar completion-reference-buffer nil
7713 "Record the buffer that was current when the completion list was requested.
7714 This is a local variable in the completion list buffer.
7715 Initial value is nil to avoid some compiler warnings.")
7717 (defvar completion-no-auto-exit nil
7718 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7719 This also applies to other functions such as `choose-completion'.")
7721 (defvar completion-base-position nil
7722 "Position of the base of the text corresponding to the shown completions.
7723 This variable is used in the *Completions* buffers.
7724 Its value is a list of the form (START END) where START is the place
7725 where the completion should be inserted and END (if non-nil) is the end
7726 of the text to replace. If END is nil, point is used instead.")
7728 (defvar completion-list-insert-choice-function #'completion--replace
7729 "Function to use to insert the text chosen in *Completions*.
7730 Called with three arguments (BEG END TEXT), it should replace the text
7731 between BEG and END with TEXT. Expected to be set buffer-locally
7732 in the *Completions* buffer.")
7734 (defvar completion-base-size nil
7735 "Number of chars before point not involved in completion.
7736 This is a local variable in the completion list buffer.
7737 It refers to the chars in the minibuffer if completing in the
7738 minibuffer, or in `completion-reference-buffer' otherwise.
7739 Only characters in the field at point are included.
7741 If nil, Emacs determines which part of the tail end of the
7742 buffer's text is involved in completion by comparing the text
7744 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7746 (defun delete-completion-window ()
7747 "Delete the completion list window.
7748 Go to the window from which completion was requested."
7750 (let ((buf completion-reference-buffer))
7751 (if (one-window-p t)
7752 (if (window-dedicated-p) (delete-frame))
7753 (delete-window (selected-window))
7754 (if (get-buffer-window buf)
7755 (select-window (get-buffer-window buf))))))
7757 (defun previous-completion (n)
7758 "Move to the previous item in the completion list."
7760 (next-completion (- n)))
7762 (defun next-completion (n)
7763 "Move to the next item in the completion list.
7764 With prefix argument N, move N items (negative N means move backward)."
7766 (let ((beg (point-min)) (end (point-max)))
7767 (while (and (> n 0) (not (eobp)))
7768 ;; If in a completion, move to the end of it.
7769 (when (get-text-property (point) 'mouse-face)
7770 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7771 ;; Move to start of next one.
7772 (unless (get-text-property (point) 'mouse-face)
7773 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7775 (while (and (< n 0) (not (bobp)))
7776 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7777 ;; If in a completion, move to the start of it.
7778 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7779 (goto-char (previous-single-property-change
7780 (point) 'mouse-face nil beg)))
7781 ;; Move to end of the previous completion.
7782 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7783 (goto-char (previous-single-property-change
7784 (point) 'mouse-face nil beg)))
7785 ;; Move to the start of that one.
7786 (goto-char (previous-single-property-change
7787 (point) 'mouse-face nil beg))
7790 (defun choose-completion (&optional event)
7791 "Choose the completion at point.
7792 If EVENT, use EVENT's position to determine the starting position."
7793 (interactive (list last-nonmenu-event))
7794 ;; In case this is run via the mouse, give temporary modes such as
7795 ;; isearch a chance to turn off.
7796 (run-hooks 'mouse-leave-buffer-hook)
7797 (with-current-buffer (window-buffer (posn-window (event-start event)))
7798 (let ((buffer completion-reference-buffer)
7799 (base-size completion-base-size)
7800 (base-position completion-base-position)
7801 (insert-function completion-list-insert-choice-function)
7804 (goto-char (posn-point (event-start event)))
7807 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7808 (setq end (point) beg (1+ (point))))
7810 (get-text-property (1- (point)) 'mouse-face))
7811 (setq end (1- (point)) beg (point)))
7812 (t (error "No completion here")))
7813 (setq beg (previous-single-property-change beg 'mouse-face))
7814 (setq end (or (next-single-property-change end 'mouse-face)
7816 (buffer-substring-no-properties beg end)))))
7818 (unless (buffer-live-p buffer)
7819 (error "Destination buffer is dead"))
7820 (quit-window nil (posn-window (event-start event)))
7822 (with-current-buffer buffer
7823 (choose-completion-string
7827 ;; Someone's using old completion code that doesn't know
7828 ;; about base-position yet.
7829 (list (+ base-size (field-beginning))))
7830 ;; If all else fails, just guess.
7831 (list (choose-completion-guess-base-position choice)))
7832 insert-function)))))
7834 ;; Delete the longest partial match for STRING
7835 ;; that can be found before POINT.
7836 (defun choose-completion-guess-base-position (string)
7838 (let ((opoint (point))
7840 ;; Try moving back by the length of the string.
7841 (goto-char (max (- (point) (length string))
7842 (minibuffer-prompt-end)))
7843 ;; See how far back we were actually able to move. That is the
7844 ;; upper bound on how much we can match and delete.
7845 (setq len (- opoint (point)))
7846 (if completion-ignore-case
7847 (setq string (downcase string)))
7848 (while (and (> len 0)
7849 (let ((tail (buffer-substring (point) opoint)))
7850 (if completion-ignore-case
7851 (setq tail (downcase tail)))
7852 (not (string= tail (substring string 0 len)))))
7857 (defun choose-completion-delete-max-match (string)
7858 (declare (obsolete choose-completion-guess-base-position "23.2"))
7859 (delete-region (choose-completion-guess-base-position string) (point)))
7861 (defvar choose-completion-string-functions nil
7862 "Functions that may override the normal insertion of a completion choice.
7863 These functions are called in order with three arguments:
7864 CHOICE - the string to insert in the buffer,
7865 BUFFER - the buffer in which the choice should be inserted,
7866 BASE-POSITION - where to insert the completion.
7868 If a function in the list returns non-nil, that function is supposed
7869 to have inserted the CHOICE in the BUFFER, and possibly exited
7870 the minibuffer; no further functions will be called.
7872 If all functions in the list return nil, that means to use
7873 the default method of inserting the completion in BUFFER.")
7875 (defun choose-completion-string (choice &optional
7876 buffer base-position insert-function)
7877 "Switch to BUFFER and insert the completion choice CHOICE.
7878 BASE-POSITION says where to insert the completion.
7879 INSERT-FUNCTION says how to insert the completion and falls
7880 back on `completion-list-insert-choice-function' when nil."
7882 ;; If BUFFER is the minibuffer, exit the minibuffer
7883 ;; unless it is reading a file name and CHOICE is a directory,
7884 ;; or completion-no-auto-exit is non-nil.
7886 ;; Some older code may call us passing `base-size' instead of
7887 ;; `base-position'. It's difficult to make any use of `base-size',
7888 ;; so we just ignore it.
7889 (unless (consp base-position)
7890 (message "Obsolete `base-size' passed to choose-completion-string")
7891 (setq base-position nil))
7893 (let* ((buffer (or buffer completion-reference-buffer))
7894 (mini-p (minibufferp buffer)))
7895 ;; If BUFFER is a minibuffer, barf unless it's the currently
7896 ;; active minibuffer.
7898 (not (and (active-minibuffer-window)
7900 (window-buffer (active-minibuffer-window))))))
7901 (error "Minibuffer is not active for completion")
7902 ;; Set buffer so buffer-local choose-completion-string-functions works.
7904 (unless (run-hook-with-args-until-success
7905 'choose-completion-string-functions
7906 ;; The fourth arg used to be `mini-p' but was useless
7907 ;; (since minibufferp can be used on the `buffer' arg)
7908 ;; and indeed unused. The last used to be `base-size', so we
7909 ;; keep it to try and avoid breaking old code.
7910 choice buffer base-position nil)
7911 ;; This remove-text-properties should be unnecessary since `choice'
7912 ;; comes from buffer-substring-no-properties.
7913 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7914 ;; Insert the completion into the buffer where it was requested.
7915 (funcall (or insert-function completion-list-insert-choice-function)
7916 (or (car base-position) (point))
7917 (or (cadr base-position) (point))
7919 ;; Update point in the window that BUFFER is showing in.
7920 (let ((window (get-buffer-window buffer t)))
7921 (set-window-point window (point)))
7922 ;; If completing for the minibuffer, exit it with this choice.
7923 (and (not completion-no-auto-exit)
7924 (minibufferp buffer)
7925 minibuffer-completion-table
7926 ;; If this is reading a file name, and the file name chosen
7927 ;; is a directory, don't exit the minibuffer.
7928 (let* ((result (buffer-substring (field-beginning) (point)))
7930 (completion-boundaries result minibuffer-completion-table
7931 minibuffer-completion-predicate
7933 (if (eq (car bounds) (length result))
7934 ;; The completion chosen leads to a new set of completions
7935 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7936 (let ((mini (active-minibuffer-window)))
7937 (select-window mini)
7938 (when minibuffer-auto-raise
7939 (raise-frame (window-frame mini))))
7940 (exit-minibuffer))))))))
7942 (define-derived-mode completion-list-mode nil "Completion List"
7943 "Major mode for buffers showing lists of possible completions.
7944 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
7945 to select the completion near point.
7946 Or click to select one with the mouse.
7948 \\{completion-list-mode-map}"
7949 (set (make-local-variable 'completion-base-size) nil))
7951 (defun completion-list-mode-finish ()
7952 "Finish setup of the completions buffer.
7953 Called from `temp-buffer-show-hook'."
7954 (when (eq major-mode 'completion-list-mode)
7955 (setq buffer-read-only t)))
7957 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7960 ;; Variables and faces used in `completion-setup-function'.
7962 (defcustom completion-show-help t
7963 "Non-nil means show help message in *Completions* buffer."
7968 ;; This function goes in completion-setup-hook, so that it is called
7969 ;; after the text of the completion list buffer is written.
7970 (defun completion-setup-function ()
7971 (let* ((mainbuf (current-buffer))
7973 ;; FIXME: This is a bad hack. We try to set the default-directory
7974 ;; in the *Completions* buffer so that the relative file names
7975 ;; displayed there can be treated as valid file names, independently
7976 ;; from the completion context. But this suffers from many problems:
7977 ;; - It's not clear when the completions are file names. With some
7978 ;; completion tables (e.g. bzr revision specs), the listed
7979 ;; completions can mix file names and other things.
7980 ;; - It doesn't pay attention to possible quoting.
7981 ;; - With fancy completion styles, the code below will not always
7982 ;; find the right base directory.
7983 (if minibuffer-completing-file-name
7984 (file-name-as-directory
7986 (buffer-substring (minibuffer-prompt-end)
7987 (- (point) (or completion-base-size 0))))))))
7988 (with-current-buffer standard-output
7989 (let ((base-size completion-base-size) ;Read before killing localvars.
7990 (base-position completion-base-position)
7991 (insert-fun completion-list-insert-choice-function))
7992 (completion-list-mode)
7993 (set (make-local-variable 'completion-base-size) base-size)
7994 (set (make-local-variable 'completion-base-position) base-position)
7995 (set (make-local-variable 'completion-list-insert-choice-function)
7997 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7998 (if base-dir (setq default-directory base-dir))
7999 ;; Maybe insert help string.
8000 (when completion-show-help
8001 (goto-char (point-min))
8002 (if (display-mouse-p)
8003 (insert "Click on a completion to select it.\n"))
8004 (insert (substitute-command-keys
8005 "In this buffer, type \\[choose-completion] to \
8006 select the completion near point.\n\n"))))))
8008 (add-hook 'completion-setup-hook 'completion-setup-function)
8010 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8011 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8013 (defun switch-to-completions ()
8014 "Select the completion list window."
8016 (let ((window (or (get-buffer-window "*Completions*" 0)
8017 ;; Make sure we have a completions window.
8018 (progn (minibuffer-completion-help)
8019 (get-buffer-window "*Completions*" 0)))))
8021 (select-window window)
8022 ;; In the new buffer, go to the first completion.
8023 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8025 (next-completion 1)))))
8027 ;;; Support keyboard commands to turn on various modifiers.
8029 ;; These functions -- which are not commands -- each add one modifier
8030 ;; to the following event.
8032 (defun event-apply-alt-modifier (_ignore-prompt)
8033 "\\<function-key-map>Add the Alt modifier to the following event.
8034 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
8035 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8036 (defun event-apply-super-modifier (_ignore-prompt)
8037 "\\<function-key-map>Add the Super modifier to the following event.
8038 For example, type \\[event-apply-super-modifier] & to enter Super-&."
8039 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8040 (defun event-apply-hyper-modifier (_ignore-prompt)
8041 "\\<function-key-map>Add the Hyper modifier to the following event.
8042 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
8043 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8044 (defun event-apply-shift-modifier (_ignore-prompt)
8045 "\\<function-key-map>Add the Shift modifier to the following event.
8046 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
8047 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8048 (defun event-apply-control-modifier (_ignore-prompt)
8049 "\\<function-key-map>Add the Ctrl modifier to the following event.
8050 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
8051 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8052 (defun event-apply-meta-modifier (_ignore-prompt)
8053 "\\<function-key-map>Add the Meta modifier to the following event.
8054 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
8055 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8057 (defun event-apply-modifier (event symbol lshiftby prefix)
8058 "Apply a modifier flag to event EVENT.
8059 SYMBOL is the name of this modifier, as a symbol.
8060 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8061 PREFIX is the string that represents this modifier in an event type symbol."
8063 (cond ((eq symbol 'control)
8064 (if (and (<= (downcase event) ?z)
8065 (>= (downcase event) ?a))
8066 (- (downcase event) ?a -1)
8067 (if (and (<= (downcase event) ?Z)
8068 (>= (downcase event) ?A))
8069 (- (downcase event) ?A -1)
8070 (logior (lsh 1 lshiftby) event))))
8072 (if (and (<= (downcase event) ?z)
8073 (>= (downcase event) ?a))
8075 (logior (lsh 1 lshiftby) event)))
8077 (logior (lsh 1 lshiftby) event)))
8078 (if (memq symbol (event-modifiers event))
8080 (let ((event-type (if (symbolp event) event (car event))))
8081 (setq event-type (intern (concat prefix (symbol-name event-type))))
8084 (cons event-type (cdr event)))))))
8086 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8087 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8088 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8089 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8090 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8091 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8093 ;;;; Keypad support.
8095 ;; Make the keypad keys act like ordinary typing keys. If people add
8096 ;; bindings for the function key symbols, then those bindings will
8097 ;; override these, so this shouldn't interfere with any existing
8100 ;; Also tell read-char how to handle these keys.
8102 (lambda (keypad-normal)
8103 (let ((keypad (nth 0 keypad-normal))
8104 (normal (nth 1 keypad-normal)))
8105 (put keypad 'ascii-character normal)
8106 (define-key function-key-map (vector keypad) (vector normal))))
8107 ;; See also kp-keys bound in bindings.el.
8113 ;; Do the same for various keys that are represented as symbols under
8114 ;; GUIs but naturally correspond to characters.
8125 ;;;; forking a twin copy of a buffer.
8128 (defvar clone-buffer-hook nil
8129 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8131 (defvar clone-indirect-buffer-hook nil
8132 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8134 (defun clone-process (process &optional newname)
8135 "Create a twin copy of PROCESS.
8136 If NEWNAME is nil, it defaults to PROCESS' name;
8137 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8138 If PROCESS is associated with a buffer, the new process will be associated
8139 with the current buffer instead.
8140 Returns nil if PROCESS has already terminated."
8141 (setq newname (or newname (process-name process)))
8142 (if (string-match "<[0-9]+>\\'" newname)
8143 (setq newname (substring newname 0 (match-beginning 0))))
8144 (when (memq (process-status process) '(run stop open))
8145 (let* ((process-connection-type (process-tty-name process))
8147 (if (memq (process-status process) '(open))
8148 (let ((args (process-contact process t)))
8149 (setq args (plist-put args :name newname))
8150 (setq args (plist-put args :buffer
8151 (if (process-buffer process)
8153 (apply 'make-network-process args))
8154 (apply 'start-process newname
8155 (if (process-buffer process) (current-buffer))
8156 (process-command process)))))
8157 (set-process-query-on-exit-flag
8158 new-process (process-query-on-exit-flag process))
8159 (set-process-inherit-coding-system-flag
8160 new-process (process-inherit-coding-system-flag process))
8161 (set-process-filter new-process (process-filter process))
8162 (set-process-sentinel new-process (process-sentinel process))
8163 (set-process-plist new-process (copy-sequence (process-plist process)))
8166 ;; things to maybe add (currently partly covered by `funcall mode'):
8169 (defun clone-buffer (&optional newname display-flag)
8170 "Create and return a twin copy of the current buffer.
8171 Unlike an indirect buffer, the new buffer can be edited
8172 independently of the old one (if it is not read-only).
8173 NEWNAME is the name of the new buffer. It may be modified by
8174 adding or incrementing <N> at the end as necessary to create a
8175 unique buffer name. If nil, it defaults to the name of the
8176 current buffer, with the proper suffix. If DISPLAY-FLAG is
8177 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8178 clone a file-visiting buffer, or a buffer whose major mode symbol
8179 has a non-nil `no-clone' property, results in an error.
8181 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8182 current buffer with appropriate suffix. However, if a prefix
8183 argument is given, then the command prompts for NEWNAME in the
8186 This runs the normal hook `clone-buffer-hook' in the new buffer
8187 after it has been set up properly in other respects."
8190 (if buffer-file-name
8191 (error "Cannot clone a file-visiting buffer"))
8192 (if (get major-mode 'no-clone)
8193 (error "Cannot clone a buffer in %s mode" mode-name))
8194 (list (if current-prefix-arg
8195 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8197 (if buffer-file-name
8198 (error "Cannot clone a file-visiting buffer"))
8199 (if (get major-mode 'no-clone)
8200 (error "Cannot clone a buffer in %s mode" mode-name))
8201 (setq newname (or newname (buffer-name)))
8202 (if (string-match "<[0-9]+>\\'" newname)
8203 (setq newname (substring newname 0 (match-beginning 0))))
8204 (let ((buf (current-buffer))
8208 (mk (if mark-active (mark t)))
8209 (modified (buffer-modified-p))
8211 (lvars (buffer-local-variables))
8212 (process (get-buffer-process (current-buffer)))
8213 (new (generate-new-buffer (or newname (buffer-name)))))
8216 (with-current-buffer new
8217 (insert-buffer-substring buf)))
8218 (with-current-buffer new
8219 (narrow-to-region ptmin ptmax)
8221 (if mk (set-mark mk))
8222 (set-buffer-modified-p modified)
8224 ;; Clone the old buffer's process, if any.
8225 (when process (clone-process process))
8227 ;; Now set up the major mode.
8230 ;; Set up other local variables.
8232 (condition-case () ;in case var is read-only
8235 (set (make-local-variable (car v)) (cdr v)))
8239 ;; Run any hooks (typically set up by the major mode
8240 ;; for cloning to work properly).
8241 (run-hooks 'clone-buffer-hook))
8243 ;; Presumably the current buffer is shown in the selected frame, so
8244 ;; we want to display the clone elsewhere.
8245 (let ((same-window-regexps nil)
8246 (same-window-buffer-names))
8247 (pop-to-buffer new)))
8251 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8252 "Create an indirect buffer that is a twin copy of the current buffer.
8254 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8255 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8256 or if not called with a prefix arg, NEWNAME defaults to the current
8257 buffer's name. The name is modified by adding a `<N>' suffix to it
8258 or by incrementing the N in an existing suffix. Trying to clone a
8259 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8260 property results in an error.
8262 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8263 This is always done when called interactively.
8265 Optional third arg NORECORD non-nil means do not put this buffer at the
8266 front of the list of recently selected ones.
8268 Returns the newly created indirect buffer."
8271 (if (get major-mode 'no-clone-indirect)
8272 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8273 (list (if current-prefix-arg
8274 (read-buffer "Name of indirect buffer: " (current-buffer)))
8276 (if (get major-mode 'no-clone-indirect)
8277 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8278 (setq newname (or newname (buffer-name)))
8279 (if (string-match "<[0-9]+>\\'" newname)
8280 (setq newname (substring newname 0 (match-beginning 0))))
8281 (let* ((name (generate-new-buffer-name newname))
8282 (buffer (make-indirect-buffer (current-buffer) name t)))
8283 (with-current-buffer buffer
8284 (run-hooks 'clone-indirect-buffer-hook))
8286 (pop-to-buffer buffer norecord))
8290 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8291 "Like `clone-indirect-buffer' but display in another window."
8294 (if (get major-mode 'no-clone-indirect)
8295 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8296 (list (if current-prefix-arg
8297 (read-buffer "Name of indirect buffer: " (current-buffer)))
8299 (let ((pop-up-windows t))
8300 (clone-indirect-buffer newname display-flag norecord)))
8303 ;;; Handling of Backspace and Delete keys.
8305 (defcustom normal-erase-is-backspace 'maybe
8306 "Set the default behavior of the Delete and Backspace keys.
8308 If set to t, Delete key deletes forward and Backspace key deletes
8311 If set to nil, both Delete and Backspace keys delete backward.
8313 If set to `maybe' (which is the default), Emacs automatically
8314 selects a behavior. On window systems, the behavior depends on
8315 the keyboard used. If the keyboard has both a Backspace key and
8316 a Delete key, and both are mapped to their usual meanings, the
8317 option's default value is set to t, so that Backspace can be used
8318 to delete backward, and Delete can be used to delete forward.
8320 If not running under a window system, customizing this option
8321 accomplishes a similar effect by mapping C-h, which is usually
8322 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8323 via `keyboard-translate'. The former functionality of C-h is
8324 available on the F1 key. You should probably not use this
8325 setting if you don't have both Backspace, Delete and F1 keys.
8327 Setting this variable with setq doesn't take effect. Programmatically,
8328 call `normal-erase-is-backspace-mode' (which see) instead."
8329 :type '(choice (const :tag "Off" nil)
8330 (const :tag "Maybe" maybe)
8331 (other :tag "On" t))
8332 :group 'editing-basics
8334 :set (lambda (symbol value)
8335 ;; The fboundp is because of a problem with :set when
8336 ;; dumping Emacs. It doesn't really matter.
8337 (if (fboundp 'normal-erase-is-backspace-mode)
8338 (normal-erase-is-backspace-mode (or value 0))
8339 (set-default symbol value))))
8341 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8342 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8343 (unless frame (setq frame (selected-frame)))
8344 (with-selected-frame frame
8345 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8346 (normal-erase-is-backspace-mode
8347 (if (if (eq normal-erase-is-backspace 'maybe)
8348 (and (not noninteractive)
8349 (or (memq system-type '(ms-dos windows-nt))
8350 (memq window-system '(w32 ns))
8351 (and (memq window-system '(x))
8352 (fboundp 'x-backspace-delete-keys-p)
8353 (x-backspace-delete-keys-p))
8354 ;; If the terminal Emacs is running on has erase char
8355 ;; set to ^H, use the Backspace key for deleting
8356 ;; backward, and the Delete key for deleting forward.
8357 (and (null window-system)
8358 (eq tty-erase-char ?\^H))))
8359 normal-erase-is-backspace)
8362 (define-minor-mode normal-erase-is-backspace-mode
8363 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8364 With a prefix argument ARG, enable this feature if ARG is
8365 positive, and disable it otherwise. If called from Lisp, enable
8366 the mode if ARG is omitted or nil.
8368 On window systems, when this mode is on, Delete is mapped to C-d
8369 and Backspace is mapped to DEL; when this mode is off, both
8370 Delete and Backspace are mapped to DEL. (The remapping goes via
8371 `local-function-key-map', so binding Delete or Backspace in the
8372 global or local keymap will override that.)
8374 In addition, on window systems, the bindings of C-Delete, M-Delete,
8375 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8376 the global keymap in accordance with the functionality of Delete and
8377 Backspace. For example, if Delete is remapped to C-d, which deletes
8378 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8379 to DEL, which deletes backward, C-Delete is bound to
8380 `backward-kill-word'.
8382 If not running on a window system, a similar effect is accomplished by
8383 remapping C-h (normally produced by the Backspace key) and DEL via
8384 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8385 to C-d; if it's off, the keys are not remapped.
8387 When not running on a window system, and this mode is turned on, the
8388 former functionality of C-h is available on the F1 key. You should
8389 probably not turn on this mode on a text-only terminal if you don't
8390 have both Backspace, Delete and F1 keys.
8392 See also `normal-erase-is-backspace'."
8393 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8395 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8397 (let ((enabled (eq 1 (terminal-parameter
8398 nil 'normal-erase-is-backspace))))
8400 (cond ((or (memq window-system '(x w32 ns pc))
8401 (memq system-type '(ms-dos windows-nt)))
8403 `(([M-delete] [M-backspace])
8404 ([C-M-delete] [C-M-backspace])
8405 ([?\e C-delete] [?\e C-backspace]))))
8409 (define-key local-function-key-map [delete] [deletechar])
8410 (define-key local-function-key-map [kp-delete] [deletechar])
8411 (define-key local-function-key-map [backspace] [?\C-?])
8412 (dolist (b bindings)
8413 ;; Not sure if input-decode-map is really right, but
8414 ;; keyboard-translate-table (used below) only works
8415 ;; for integer events, and key-translation-table is
8416 ;; global (like the global-map, used earlier).
8417 (define-key input-decode-map (car b) nil)
8418 (define-key input-decode-map (cadr b) nil)))
8419 (define-key local-function-key-map [delete] [?\C-?])
8420 (define-key local-function-key-map [kp-delete] [?\C-?])
8421 (define-key local-function-key-map [backspace] [?\C-?])
8422 (dolist (b bindings)
8423 (define-key input-decode-map (car b) (cadr b))
8424 (define-key input-decode-map (cadr b) (car b))))))
8428 (keyboard-translate ?\C-h ?\C-?)
8429 (keyboard-translate ?\C-? ?\C-d))
8430 (keyboard-translate ?\C-h ?\C-h)
8431 (keyboard-translate ?\C-? ?\C-?))))
8433 (if (called-interactively-p 'interactive)
8434 (message "Delete key deletes %s"
8435 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8436 "forward" "backward")))))
8438 (defvar vis-mode-saved-buffer-invisibility-spec nil
8439 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8441 (define-minor-mode read-only-mode
8442 "Change whether the current buffer is read-only.
8443 With prefix argument ARG, make the buffer read-only if ARG is
8444 positive, otherwise make it writable. If buffer is read-only
8445 and `view-read-only' is non-nil, enter view mode.
8447 Do not call this from a Lisp program unless you really intend to
8448 do the same thing as the \\[read-only-mode] command, including
8449 possibly enabling or disabling View mode. Also, note that this
8450 command works by setting the variable `buffer-read-only', which
8451 does not affect read-only regions caused by text properties. To
8452 ignore read-only status in a Lisp program (whether due to text
8453 properties or buffer state), bind `inhibit-read-only' temporarily
8454 to a non-nil value."
8455 :variable buffer-read-only
8457 ((and (not buffer-read-only) view-mode)
8458 (View-exit-and-edit)
8459 (make-local-variable 'view-read-only)
8460 (setq view-read-only t)) ; Must leave view mode.
8461 ((and buffer-read-only view-read-only
8462 ;; If view-mode is already active, `view-mode-enter' is a nop.
8464 (not (eq (get major-mode 'mode-class) 'special)))
8465 (view-mode-enter))))
8467 (define-minor-mode visible-mode
8468 "Toggle making all invisible text temporarily visible (Visible mode).
8469 With a prefix argument ARG, enable Visible mode if ARG is
8470 positive, and disable it otherwise. If called from Lisp, enable
8471 the mode if ARG is omitted or nil.
8473 This mode works by saving the value of `buffer-invisibility-spec'
8474 and setting it to nil."
8476 :group 'editing-basics
8477 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8478 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8479 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8481 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8482 buffer-invisibility-spec)
8483 (setq buffer-invisibility-spec nil)))
8485 (defvar messages-buffer-mode-map
8486 (let ((map (make-sparse-keymap)))
8487 (set-keymap-parent map special-mode-map)
8488 (define-key map "g" nil) ; nothing to revert
8491 (define-derived-mode messages-buffer-mode special-mode "Messages"
8492 "Major mode used in the \"*Messages*\" buffer.")
8494 (defun messages-buffer ()
8495 "Return the \"*Messages*\" buffer.
8496 If it does not exist, create and it switch it to `messages-buffer-mode'."
8497 (or (get-buffer "*Messages*")
8498 (with-current-buffer (get-buffer-create "*Messages*")
8499 (messages-buffer-mode)
8503 ;; Minibuffer prompt stuff.
8505 ;;(defun minibuffer-prompt-modification (start end)
8506 ;; (error "You cannot modify the prompt"))
8509 ;;(defun minibuffer-prompt-insertion (start end)
8510 ;; (let ((inhibit-modification-hooks t))
8511 ;; (delete-region start end)
8512 ;; ;; Discard undo information for the text insertion itself
8513 ;; ;; and for the text deletion.above.
8514 ;; (when (consp buffer-undo-list)
8515 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8516 ;; (message "You cannot modify the prompt")))
8519 ;;(setq minibuffer-prompt-properties
8520 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8521 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8524 ;;;; Problematic external packages.
8526 ;; rms says this should be done by specifying symbols that define
8527 ;; versions together with bad values. This is therefore not as
8528 ;; flexible as it could be. See the thread:
8529 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8530 (defconst bad-packages-alist
8531 ;; Not sure exactly which semantic versions have problems.
8532 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8533 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
8534 "The version of `semantic' loaded does not work in Emacs 22.
8535 It can cause constant high CPU load.
8536 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8537 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8538 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8539 ;; provided the `CUA-mode' feature. Since this is no longer true,
8540 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8542 "CUA-mode is now part of the standard GNU Emacs distribution,
8543 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8545 You have loaded an older version of CUA-mode which does not work
8546 correctly with this version of Emacs. You should remove the old
8547 version and use the one distributed with Emacs."))
8548 "Alist of packages known to cause problems in this version of Emacs.
8549 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8550 PACKAGE is either a regular expression to match file names, or a
8551 symbol (a feature name), like for `with-eval-after-load'.
8552 SYMBOL is either the name of a string variable, or t. Upon
8553 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8554 warning using STRING as the message.")
8556 (defun bad-package-check (package)
8557 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8559 (let* ((list (assoc package bad-packages-alist))
8560 (symbol (nth 1 list)))
8564 (and (stringp (setq symbol (eval symbol)))
8565 (string-match-p (nth 2 list) symbol)))
8566 (display-warning package (nth 3 list) :warning)))
8569 (dolist (elem bad-packages-alist)
8570 (let ((pkg (car elem)))
8571 (with-eval-after-load pkg
8572 (bad-package-check pkg))))
8575 ;;; Generic dispatcher commands
8577 ;; Macro `define-alternatives' is used to create generic commands.
8578 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8579 ;; that can have different alternative implementations where choosing
8580 ;; among them is exclusively a matter of user preference.
8582 ;; (define-alternatives COMMAND) creates a new interactive command
8583 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8584 ;; Typically, the user will not need to customize this variable; packages
8585 ;; wanting to add alternative implementations should use
8587 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8589 (defmacro define-alternatives (command &rest customizations)
8590 "Define the new command `COMMAND'.
8592 The argument `COMMAND' should be a symbol.
8594 Running `M-x COMMAND RET' for the first time prompts for which
8595 alternative to use and records the selected command as a custom
8598 Running `C-u M-x COMMAND RET' prompts again for an alternative
8599 and overwrites the previous choice.
8601 The variable `COMMAND-alternatives' contains an alist with
8602 alternative implementations of COMMAND. `define-alternatives'
8603 does not have any effect until this variable is set.
8605 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8606 `defcustom' keywords and values to add to the declaration of
8607 `COMMAND-alternatives' (typically :group and :version)."
8608 (let* ((command-name (symbol-name command))
8609 (varalt-name (concat command-name "-alternatives"))
8610 (varalt-sym (intern varalt-name))
8611 (varimp-sym (intern (concat command-name "--implementation"))))
8614 (defcustom ,varalt-sym nil
8615 ,(format "Alist of alternative implementations for the `%s' command.
8617 Each entry must be a pair (ALTNAME . ALTFUN), where:
8618 ALTNAME - The name shown at user to describe the alternative implementation.
8619 ALTFUN - The function called to implement this alternative."
8621 :type '(alist :key-type string :value-type function)
8624 (put ',varalt-sym 'definition-name ',command)
8625 (defvar ,varimp-sym nil "Internal use only.")
8627 (defun ,command (&optional arg)
8628 ,(format "Run generic command `%s'.
8629 If used for the first time, or with interactive ARG, ask the user which
8630 implementation to use for `%s'. The variable `%s'
8631 contains the list of implementations currently supported for this command."
8632 command-name command-name varalt-name)
8634 (when (or arg (null ,varimp-sym))
8635 (let ((val (completing-read
8637 "Select implementation for command `%s': "
8639 ,varalt-sym nil t)))
8640 (unless (string-equal val "")
8641 (when (null ,varimp-sym)
8643 "Use C-u M-x %s RET`to select another implementation"
8646 (customize-save-variable ',varimp-sym
8647 (cdr (assoc-string val ,varalt-sym))))))
8649 (call-interactively ,varimp-sym)
8650 (message "%s" ,(format-message
8651 "No implementation selected for command `%s'"
8655 ;;; Functions for changing capitalization that Do What I Mean
8656 (defun upcase-dwim (arg)
8657 "Upcase words in the region, if active; if not, upcase word at point.
8658 If the region is active, this function calls `upcase-region'.
8659 Otherwise, it calls `upcase-word', with prefix argument passed to it
8660 to upcase ARG words."
8663 (upcase-region (region-beginning) (region-end))
8666 (defun downcase-dwim (arg)
8667 "Downcase words in the region, if active; if not, downcase word at point.
8668 If the region is active, this function calls `downcase-region'.
8669 Otherwise, it calls `downcase-word', with prefix argument passed to it
8670 to downcase ARG words."
8673 (downcase-region (region-beginning) (region-end))
8674 (downcase-word arg)))
8676 (defun capitalize-dwim (arg)
8677 "Capitalize words in the region, if active; if not, capitalize word at point.
8678 If the region is active, this function calls `capitalize-region'.
8679 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8680 to capitalize ARG words."
8683 (capitalize-region (region-beginning) (region-end))
8684 (capitalize-word arg)))
8690 ;;; simple.el ends here