1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2014 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 (declare-function widget-convert
"wid-edit" (type &rest args
))
32 (declare-function shell-mode
"shell" ())
35 (defvar compilation-current-error
)
36 (defvar compilation-context-lines
)
38 (defcustom idle-update-delay
0.5
39 "Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
50 (defgroup paren-matching nil
51 "Highlight (un)matching of parens and expressions."
54 ;;; next-error support framework
56 (defgroup next-error nil
57 "`next-error' support framework."
62 '((t (:inherit region
)))
63 "Face used to highlight next error locus."
67 (defcustom next-error-highlight
0.5
68 "Highlighting of locations in selected source buffers.
69 If a number, highlight the locus in `next-error' face for the given time
70 in seconds, or until the next command is executed.
71 If t, highlight the locus until the next command is executed, or until
72 some other locus replaces it.
73 If nil, don't highlight the locus in the source buffer.
74 If `fringe-arrow', indicate the locus by the fringe arrow
75 indefinitely until some other locus replaces it."
76 :type
'(choice (number :tag
"Highlight for specified time")
77 (const :tag
"Semipermanent highlighting" t
)
78 (const :tag
"No highlighting" nil
)
79 (const :tag
"Fringe arrow" fringe-arrow
))
83 (defcustom next-error-highlight-no-select
0.5
84 "Highlighting of locations in `next-error-no-select'.
85 If number, highlight the locus in `next-error' face for given time in seconds.
86 If t, highlight the locus indefinitely until some other locus replaces it.
87 If nil, don't highlight the locus in the source buffer.
88 If `fringe-arrow', indicate the locus by the fringe arrow
89 indefinitely until some other locus replaces it."
90 :type
'(choice (number :tag
"Highlight for specified time")
91 (const :tag
"Semipermanent highlighting" t
)
92 (const :tag
"No highlighting" nil
)
93 (const :tag
"Fringe arrow" fringe-arrow
))
97 (defcustom next-error-recenter nil
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
100 :type
'(choice (integer :tag
"Line to recenter to")
101 (const :tag
"Center of window" (4))
102 (const :tag
"No recentering" nil
))
106 (defcustom next-error-hook nil
107 "List of hook functions run by `next-error' after visiting source file."
111 (defvar next-error-highlight-timer nil
)
113 (defvar next-error-overlay-arrow-position nil
)
114 (put 'next-error-overlay-arrow-position
'overlay-arrow-string
(purecopy "=>"))
115 (add-to-list 'overlay-arrow-variable-list
'next-error-overlay-arrow-position
)
117 (defvar next-error-last-buffer nil
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
120 similar mode is started, or when it is used with \\[next-error]
121 or \\[compile-goto-error].")
123 (defvar next-error-function nil
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
132 (make-variable-buffer-local 'next-error-function
)
134 (defvar next-error-move-function nil
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
139 nil means use goto-char using the second argument position.")
140 (make-variable-buffer-local 'next-error-move-function
)
142 (defsubst next-error-buffer-p
(buffer
143 &optional avoid-current
145 extra-test-exclusive
)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
158 (and (buffer-name buffer
) ;First make sure it's live.
159 (not (and avoid-current
(eq buffer
(current-buffer))))
160 (with-current-buffer buffer
161 (if next-error-function
; This is the normal test.
162 ;; Optionally reject some buffers.
163 (if extra-test-exclusive
164 (funcall extra-test-exclusive
)
166 ;; Optionally accept some other buffers.
167 (and extra-test-inclusive
168 (funcall extra-test-inclusive
))))))
170 (defun next-error-find-buffer (&optional avoid-current
172 extra-test-exclusive
)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
187 (let ((window-buffers
189 (delq nil
(mapcar (lambda (w)
190 (if (next-error-buffer-p
193 extra-test-inclusive extra-test-exclusive
)
196 (if (eq (length window-buffers
) 1)
197 (car window-buffers
)))
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
199 (if (and next-error-last-buffer
200 (next-error-buffer-p next-error-last-buffer avoid-current
201 extra-test-inclusive extra-test-exclusive
))
202 next-error-last-buffer
)
203 ;; 3. If the current buffer is acceptable, choose it.
204 (if (next-error-buffer-p (current-buffer) avoid-current
205 extra-test-inclusive extra-test-exclusive
)
207 ;; 4. Look for any acceptable buffer.
208 (let ((buffers (buffer-list)))
210 (not (next-error-buffer-p
211 (car buffers
) avoid-current
212 extra-test-inclusive extra-test-exclusive
)))
213 (setq buffers
(cdr buffers
)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
218 (next-error-buffer-p (current-buffer) nil
219 extra-test-inclusive extra-test-exclusive
)
221 (message "This is the only buffer with error message locations")
224 (error "No buffers contain error message locations")))
226 (defun next-error (&optional arg reset
)
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
234 Just \\[universal-argument] as a prefix means reparse the error message buffer
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
239 \\[next-error] normally uses the most recently started
240 compilation, grep, or occur buffer. It can also operate on any
241 buffer with output from the \\[compile], \\[grep] commands, or,
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
246 \\[next-error] in that buffer when it is the only one displayed
247 in the current frame.
249 Once \\[next-error] has chosen the buffer for error messages, it
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
257 (if (consp arg
) (setq reset t arg nil
))
258 (when (setq next-error-last-buffer
(next-error-find-buffer))
259 ;; we know here that next-error-function is a valid symbol we can funcall
260 (with-current-buffer next-error-last-buffer
261 (funcall next-error-function
(prefix-numeric-value arg
) reset
)
262 (when next-error-recenter
263 (recenter next-error-recenter
))
264 (run-hooks 'next-error-hook
))))
266 (defun next-error-internal ()
267 "Visit the source code corresponding to the `next-error' message at point."
268 (setq next-error-last-buffer
(current-buffer))
269 ;; we know here that next-error-function is a valid symbol we can funcall
270 (with-current-buffer next-error-last-buffer
271 (funcall next-error-function
0 nil
)
272 (when next-error-recenter
273 (recenter next-error-recenter
))
274 (run-hooks 'next-error-hook
)))
276 (defalias 'goto-next-locus
'next-error
)
277 (defalias 'next-match
'next-error
)
279 (defun previous-error (&optional n
)
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
285 This operates on the output from the \\[compile] and \\[grep] commands."
287 (next-error (- (or n
1))))
289 (defun first-error (&optional n
)
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
293 This operates on the output from the \\[compile] command, for instance."
297 (defun next-error-no-select (&optional n
)
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
301 Finds and highlights the source line like \\[next-error], but does not
302 select the source buffer."
304 (let ((next-error-highlight next-error-highlight-no-select
))
306 (pop-to-buffer next-error-last-buffer
))
308 (defun previous-error-no-select (&optional n
)
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
312 Finds and highlights the source line like \\[previous-error], but does not
313 select the source buffer."
315 (next-error-no-select (- (or n
1))))
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
318 (defvar next-error-follow-last-line nil
)
320 (define-minor-mode next-error-follow-minor-mode
321 "Minor mode for compilation, occur and diff modes.
322 With a prefix argument ARG, enable mode if ARG is positive, and
323 disable it otherwise. If called from Lisp, enable mode if ARG is
325 When turned on, cursor motion in the compilation, grep, occur or diff
326 buffer causes automatic display of the corresponding source code location."
327 :group
'next-error
:init-value nil
:lighter
" Fol"
328 (if (not next-error-follow-minor-mode
)
329 (remove-hook 'post-command-hook
'next-error-follow-mode-post-command-hook t
)
330 (add-hook 'post-command-hook
'next-error-follow-mode-post-command-hook nil t
)
331 (make-local-variable 'next-error-follow-last-line
)))
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
335 (defun next-error-follow-mode-post-command-hook ()
336 (unless (equal next-error-follow-last-line
(line-number-at-pos))
337 (setq next-error-follow-last-line
(line-number-at-pos))
339 (let ((compilation-context-lines nil
))
340 (setq compilation-current-error
(point))
341 (next-error-no-select 0))
347 (defun fundamental-mode ()
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
351 (kill-all-local-variables)
354 ;; Special major modes to view specially formatted data rather than files.
356 (defvar special-mode-map
357 (let ((map (make-sparse-keymap)))
358 (suppress-keymap map
)
359 (define-key map
"q" 'quit-window
)
360 (define-key map
" " 'scroll-up-command
)
361 (define-key map
[?\S-\
] 'scroll-down-command
)
362 (define-key map
"\C-?" 'scroll-down-command
)
363 (define-key map
"?" 'describe-mode
)
364 (define-key map
"h" 'describe-mode
)
365 (define-key map
">" 'end-of-buffer
)
366 (define-key map
"<" 'beginning-of-buffer
)
367 (define-key map
"g" 'revert-buffer
)
370 (put 'special-mode
'mode-class
'special
)
371 (define-derived-mode special-mode nil
"Special"
372 "Parent major mode from which special major modes should inherit."
373 (setq buffer-read-only t
))
375 ;; Making and deleting lines.
377 (defvar hard-newline
(propertize "\n" 'hard t
'rear-nonsticky
'(hard))
378 "Propertized string representing a hard newline character.")
380 (defun newline (&optional arg interactive
)
381 "Insert a newline, and move to left margin of the new line if it's blank.
382 If option `use-hard-newlines' is non-nil, the newline is marked with the
383 text-property `hard'.
384 With ARG, insert that many newlines.
386 If `electric-indent-mode' is enabled, this indents the final new line
387 that it adds, and reindents the preceding line. To just insert
388 a newline, use \\[electric-indent-just-newline].
390 Calls `auto-fill-function' if the current column number is greater
391 than the value of `fill-column' and ARG is nil.
392 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
393 (interactive "*P\np")
394 (barf-if-buffer-read-only)
395 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
396 ;; Set last-command-event to tell self-insert what to insert.
397 (let* ((was-page-start (and (bolp) (looking-at page-delimiter
)))
399 (last-command-event ?
\n)
400 ;; Don't auto-fill if we have a numeric argument.
401 (auto-fill-function (if arg nil auto-fill-function
))
403 ;; Do the rest in post-self-insert-hook, because we want to do it
404 ;; *before* other functions on that hook.
406 ;; Mark the newline(s) `hard'.
407 (if use-hard-newlines
408 (set-hard-newline-properties
409 (- (point) (prefix-numeric-value arg
)) (point)))
410 ;; If the newline leaves the previous line blank, and we
411 ;; have a left margin, delete that from the blank line.
413 (goto-char beforepos
)
415 (and (looking-at "[ \t]$")
416 (> (current-left-margin) 0)
417 (delete-region (point)
418 (line-end-position))))
419 ;; Indent the line after the newline, except in one case:
420 ;; when we added the newline at the beginning of a line which
423 (move-to-left-margin nil t
)))))
424 (if (not interactive
)
425 ;; FIXME: For non-interactive uses, many calls actually just want
426 ;; (insert "\n"), so maybe we should do just that, so as to avoid
427 ;; the risk of filling or running abbrevs unexpectedly.
428 (let ((post-self-insert-hook (list postproc
)))
429 (self-insert-command (prefix-numeric-value arg
)))
432 (add-hook 'post-self-insert-hook postproc
)
433 (self-insert-command (prefix-numeric-value arg
)))
434 ;; We first used let-binding to protect the hook, but that was naive
435 ;; since add-hook affects the symbol-default value of the variable,
436 ;; whereas the let-binding might only protect the buffer-local value.
437 (remove-hook 'post-self-insert-hook postproc
))))
440 (defun set-hard-newline-properties (from to
)
441 (let ((sticky (get-text-property from
'rear-nonsticky
)))
442 (put-text-property from to
'hard
't
)
443 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
444 (if (and (listp sticky
) (not (memq 'hard sticky
)))
445 (put-text-property from
(point) 'rear-nonsticky
446 (cons 'hard sticky
)))))
449 "Insert a newline and leave point before it.
450 If there is a fill prefix and/or a `left-margin', insert them
451 on the new line if the line would have been blank.
452 With arg N, insert N newlines."
454 (let* ((do-fill-prefix (and fill-prefix
(bolp)))
455 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
457 ;; Don't expand an abbrev before point.
463 (if do-left-margin
(indent-to (current-left-margin)))
464 (if do-fill-prefix
(insert-and-inherit fill-prefix
))))
470 (defun split-line (&optional arg
)
471 "Split current line, moving portion beyond point vertically down.
472 If the current line starts with `fill-prefix', insert it on the new
473 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
475 When called from Lisp code, ARG may be a prefix string to copy."
477 (skip-chars-forward " \t")
478 (let* ((col (current-column))
480 ;; What prefix should we check for (nil means don't).
481 (prefix (cond ((stringp arg
) arg
)
484 ;; Does this line start with it?
485 (have-prfx (and prefix
488 (looking-at (regexp-quote prefix
))))))
490 (if have-prfx
(insert-and-inherit prefix
))
494 (defun delete-indentation (&optional arg
)
495 "Join this line to previous and fix up whitespace at join.
496 If there is a fill prefix, delete it from the beginning of this line.
497 With argument, join this line to following line."
500 (if arg
(forward-line 1))
501 (if (eq (preceding-char) ?
\n)
503 (delete-region (point) (1- (point)))
504 ;; If the second line started with the fill prefix,
505 ;; delete the prefix.
507 (<= (+ (point) (length fill-prefix
)) (point-max))
509 (buffer-substring (point)
510 (+ (point) (length fill-prefix
)))))
511 (delete-region (point) (+ (point) (length fill-prefix
))))
512 (fixup-whitespace))))
514 (defalias 'join-line
#'delete-indentation
) ; easier to find
516 (defun delete-blank-lines ()
517 "On blank line, delete all surrounding blank lines, leaving just one.
518 On isolated blank line, delete that one.
519 On nonblank line, delete any immediately following blank lines."
521 (let (thisblank singleblank
)
524 (setq thisblank
(looking-at "[ \t]*$"))
525 ;; Set singleblank if there is just one blank line here.
528 (not (looking-at "[ \t]*\n[ \t]*$"))
530 (progn (forward-line -
1)
531 (not (looking-at "[ \t]*$")))))))
532 ;; Delete preceding blank lines, and this one too if it's the only one.
536 (if singleblank
(forward-line 1))
537 (delete-region (point)
538 (if (re-search-backward "[^ \t\n]" nil t
)
539 (progn (forward-line 1) (point))
541 ;; Delete following blank lines, unless the current line is blank
542 ;; and there are no following blank lines.
543 (if (not (and thisblank singleblank
))
547 (delete-region (point)
548 (if (re-search-forward "[^ \t\n]" nil t
)
549 (progn (beginning-of-line) (point))
551 ;; Handle the special case where point is followed by newline and eob.
552 ;; Delete the line, leaving point at eob.
553 (if (looking-at "^[ \t]*\n\\'")
554 (delete-region (point) (point-max)))))
556 (defcustom delete-trailing-lines t
557 "If non-nil, \\[delete-trailing-whitespace] deletes trailing lines.
558 Trailing lines are deleted only if `delete-trailing-whitespace'
559 is called on the entire buffer (rather than an active region)."
564 (defun delete-trailing-whitespace (&optional start end
)
565 "Delete trailing whitespace between START and END.
566 If called interactively, START and END are the start/end of the
567 region if the mark is active, or of the buffer's accessible
568 portion if the mark is inactive.
570 This command deletes whitespace characters after the last
571 non-whitespace character in each line between START and END. It
572 does not consider formfeed characters to be whitespace.
574 If this command acts on the entire buffer (i.e. if called
575 interactively with the mark inactive, or called from Lisp with
576 END nil), it also deletes all trailing lines at the end of the
577 buffer if the variable `delete-trailing-lines' is non-nil."
579 (barf-if-buffer-read-only)
581 (list (region-beginning) (region-end))
585 (let ((end-marker (copy-marker (or end
(point-max))))
586 (start (or start
(point-min))))
588 (while (re-search-forward "\\s-$" end-marker t
)
589 (skip-syntax-backward "-" (line-beginning-position))
590 ;; Don't delete formfeeds, even if they are considered whitespace.
591 (if (looking-at-p ".*\f")
592 (goto-char (match-end 0)))
593 (delete-region (point) (match-end 0)))
594 ;; Delete trailing empty lines.
595 (goto-char end-marker
)
597 delete-trailing-lines
598 ;; Really the end of buffer.
599 (= (point-max) (1+ (buffer-size)))
600 (<= (skip-chars-backward "\n") -
2))
601 (delete-region (1+ (point)) end-marker
))
602 (set-marker end-marker nil
))))
603 ;; Return nil for the benefit of `write-file-functions'.
606 (defun newline-and-indent ()
607 "Insert a newline, then indent according to major mode.
608 Indentation is done using the value of `indent-line-function'.
609 In programming language modes, this is the same as TAB.
610 In some text modes, where TAB inserts a tab, this command indents to the
611 column specified by the function `current-left-margin'."
613 (delete-horizontal-space t
)
615 (indent-according-to-mode))
617 (defun reindent-then-newline-and-indent ()
618 "Reindent current line, insert newline, then indent the new line.
619 Indentation of both lines is done according to the current major mode,
620 which means calling the current value of `indent-line-function'.
621 In programming language modes, this is the same as TAB.
622 In some text modes, where TAB inserts a tab, this indents to the
623 column specified by the function `current-left-margin'."
626 ;; Be careful to insert the newline before indenting the line.
627 ;; Otherwise, the indentation might be wrong.
631 ;; We are at EOL before the call to indent-according-to-mode, and
632 ;; after it we usually are as well, but not always. We tried to
633 ;; address it with `save-excursion' but that uses a normal marker
634 ;; whereas we need `move after insertion', so we do the save/restore
636 (setq pos
(copy-marker pos t
))
637 (indent-according-to-mode)
639 ;; Remove the trailing white-space after indentation because
640 ;; indentation may introduce the whitespace.
641 (delete-horizontal-space t
))
642 (indent-according-to-mode)))
644 (defcustom read-quoted-char-radix
8
645 "Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
646 Legitimate radix values are 8, 10 and 16."
647 :type
'(choice (const 8) (const 10) (const 16))
648 :group
'editing-basics
)
650 (defun read-quoted-char (&optional prompt
)
651 "Like `read-char', but do not allow quitting.
652 Also, if the first character read is an octal digit,
653 we read any number of octal digits and return the
654 specified character code. Any nondigit terminates the sequence.
655 If the terminator is RET, it is discarded;
656 any other terminator is used itself as input.
658 The optional argument PROMPT specifies a string to use to prompt the user.
659 The variable `read-quoted-char-radix' controls which radix to use
661 (let ((message-log-max nil
) done
(first t
) (code 0) translated
)
663 (let ((inhibit-quit first
)
664 ;; Don't let C-h get the help message--only help function keys.
667 "Type the special character you want to use,
668 or the octal character code.
669 RET terminates the character code and is discarded;
670 any other non-digit terminates the character code and is then used as input."))
671 (setq translated
(read-key (and prompt
(format "%s-" prompt
))))
672 (if inhibit-quit
(setq quit-flag nil
)))
673 (if (integerp translated
)
674 (setq translated
(char-resolve-modifiers translated
)))
675 (cond ((null translated
))
676 ((not (integerp translated
))
677 (setq unread-command-events
678 (listify-key-sequence (this-single-command-raw-keys))
680 ((/= (logand translated ?\M-\^
@) 0)
681 ;; Turn a meta-character into a character with the 0200 bit set.
682 (setq code
(logior (logand translated
(lognot ?\M-\^
@)) 128)
684 ((and (<= ?
0 translated
)
685 (< translated
(+ ?
0 (min 10 read-quoted-char-radix
))))
686 (setq code
(+ (* code read-quoted-char-radix
) (- translated ?
0)))
687 (and prompt
(setq prompt
(message "%s %c" prompt translated
))))
688 ((and (<= ?a
(downcase translated
))
689 (< (downcase translated
)
690 (+ ?a -
10 (min 36 read-quoted-char-radix
))))
691 (setq code
(+ (* code read-quoted-char-radix
)
692 (+ 10 (- (downcase translated
) ?a
))))
693 (and prompt
(setq prompt
(message "%s %c" prompt translated
))))
694 ((and (not first
) (eq translated ?\C-m
))
697 (setq unread-command-events
698 (listify-key-sequence (this-single-command-raw-keys))
700 (t (setq code translated
705 (defun quoted-insert (arg)
706 "Read next input character and insert it.
707 This is useful for inserting control characters.
708 With argument, insert ARG copies of the character.
710 If the first character you type after this command is an octal digit,
711 you should type a sequence of octal digits which specify a character code.
712 Any nondigit terminates the sequence. If the terminator is a RET,
713 it is discarded; any other terminator is used itself as input.
714 The variable `read-quoted-char-radix' specifies the radix for this feature;
715 set it to 10 or 16 to use decimal or hex instead of octal.
717 In overwrite mode, this function inserts the character anyway, and
718 does not handle octal digits specially. This means that if you use
719 overwrite as your normal editing mode, you can use this function to
720 insert characters when necessary.
722 In binary overwrite mode, this function does overwrite, and octal
723 digits are interpreted as a character code. This is intended to be
724 useful for editing binary files."
727 ;; Avoid "obsolete" warnings for translation-table-for-input.
729 (let (translation-table-for-input input-method-function
)
730 (if (or (not overwrite-mode
)
731 (eq overwrite-mode
'overwrite-mode-binary
))
734 ;; This used to assume character codes 0240 - 0377 stand for
735 ;; characters in some single-byte character set, and converted them
736 ;; to Emacs characters. But in 23.1 this feature is deprecated
737 ;; in favor of inserting the corresponding Unicode characters.
738 ;; (if (and enable-multibyte-characters
741 ;; (setq char (unibyte-char-to-multibyte char)))
742 (unless (characterp char
)
743 (user-error "%s is not a valid character"
744 (key-description (vector char
))))
746 (if (eq overwrite-mode
'overwrite-mode-binary
)
749 (insert-and-inherit char
)
750 (setq arg
(1- arg
)))))
752 (defun forward-to-indentation (&optional arg
)
753 "Move forward ARG lines and position at first nonblank character."
755 (forward-line (or arg
1))
756 (skip-chars-forward " \t"))
758 (defun backward-to-indentation (&optional arg
)
759 "Move backward ARG lines and position at first nonblank character."
761 (forward-line (- (or arg
1)))
762 (skip-chars-forward " \t"))
764 (defun back-to-indentation ()
765 "Move point to the first non-whitespace character on this line."
767 (beginning-of-line 1)
768 (skip-syntax-forward " " (line-end-position))
769 ;; Move back over chars that have whitespace syntax but have the p flag.
770 (backward-prefix-chars))
772 (defun fixup-whitespace ()
773 "Fixup white space between objects around point.
774 Leave one space or none, according to the context."
777 (delete-horizontal-space)
778 (if (or (looking-at "^\\|\\s)")
779 (save-excursion (forward-char -
1)
780 (looking-at "$\\|\\s(\\|\\s'")))
784 (defun delete-horizontal-space (&optional backward-only
)
785 "Delete all spaces and tabs around point.
786 If BACKWARD-ONLY is non-nil, only delete them before point."
788 (let ((orig-pos (point)))
793 (skip-chars-forward " \t")
794 (constrain-to-field nil orig-pos t
)))
796 (skip-chars-backward " \t")
797 (constrain-to-field nil orig-pos
)))))
799 (defun just-one-space (&optional n
)
800 "Delete all spaces and tabs around point, leaving one space (or N spaces).
801 If N is negative, delete newlines as well, leaving -N spaces.
802 See also `cycle-spacing'."
804 (cycle-spacing n nil t
))
806 (defvar cycle-spacing--context nil
807 "Store context used in consecutive calls to `cycle-spacing' command.
808 The first time this function is run, it saves the original point
809 position and original spacing around the point in this
812 (defun cycle-spacing (&optional n preserve-nl-back single-shot
)
813 "Manipulate whitespace around point in a smart way.
814 In interactive use, this function behaves differently in successive
817 The first call in a sequence acts like `just-one-space'.
818 It deletes all spaces and tabs around point, leaving one space
819 \(or N spaces). N is the prefix argument. If N is negative,
820 it deletes newlines as well, leaving -N spaces.
821 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
823 The second call in a sequence (or the first call if the above does
824 not result in any changes) deletes all spaces.
826 The third call in a sequence restores the original whitespace (and point).
828 If SINGLE-SHOT is non-nil, it only performs the first step in the sequence."
830 (let ((orig-pos (point))
831 (skip-characters (if (and n
(< n
0)) " \t\n\r" " \t"))
833 (skip-chars-backward (if preserve-nl-back
" \t" skip-characters
))
834 (constrain-to-field nil orig-pos
)
836 ;; Command run for the first time or single-shot is non-nil.
838 (not (equal last-command this-command
))
839 (not cycle-spacing--context
))
840 (let* ((start (point))
841 (n (- n
(skip-chars-forward " " (+ n
(point)))))
844 (skip-chars-forward skip-characters
)
845 (constrain-to-field nil orig-pos t
))))
846 (setq cycle-spacing--context
;; Save for later.
847 ;; Special handling for case where there was no space at all.
848 (unless (= start end
)
849 (cons orig-pos
(buffer-substring start
(point)))))
850 ;; If this run causes no change in buffer content, delete all spaces,
851 ;; otherwise delete all excess spaces.
852 (delete-region (if (and (not single-shot
) (zerop n
) (= mid end
))
854 (insert (make-string n ?\s
))))
856 ;; Command run for the second time.
857 ((not (equal orig-pos
(point)))
858 (delete-region (point) orig-pos
))
860 ;; Command run for the third time.
862 (insert (cdr cycle-spacing--context
))
863 (goto-char (car cycle-spacing--context
))
864 (setq cycle-spacing--context nil
)))))
866 (defun beginning-of-buffer (&optional arg
)
867 "Move point to the beginning of the buffer.
868 With numeric arg N, put point N/10 of the way from the beginning.
869 If the buffer is narrowed, this command uses the beginning of the
870 accessible part of the buffer.
872 If Transient Mark mode is disabled, leave mark at previous
873 position, unless a \\[universal-argument] prefix is supplied.
875 Don't use this command in Lisp programs!
876 \(goto-char (point-min)) is faster."
881 (let ((size (- (point-max) (point-min))))
882 (goto-char (if (and arg
(not (consp arg
)))
885 ;; Avoid overflow for large buffer sizes!
886 (* (prefix-numeric-value arg
)
888 (/ (+ 10 (* size
(prefix-numeric-value arg
))) 10)))
890 (if (and arg
(not (consp arg
))) (forward-line 1)))
891 (put 'beginning-of-buffer
'interactive-only
892 "use `(goto-char (point-min))' instead.")
894 (defun end-of-buffer (&optional arg
)
895 "Move point to the end of the buffer.
896 With numeric arg N, put point N/10 of the way from the end.
897 If the buffer is narrowed, this command uses the end of the
898 accessible part of the buffer.
900 If Transient Mark mode is disabled, leave mark at previous
901 position, unless a \\[universal-argument] prefix is supplied.
903 Don't use this command in Lisp programs!
904 \(goto-char (point-max)) is faster."
906 (or (consp arg
) (region-active-p) (push-mark))
907 (let ((size (- (point-max) (point-min))))
908 (goto-char (if (and arg
(not (consp arg
)))
911 ;; Avoid overflow for large buffer sizes!
912 (* (prefix-numeric-value arg
)
914 (/ (* size
(prefix-numeric-value arg
)) 10)))
916 ;; If we went to a place in the middle of the buffer,
917 ;; adjust it to the beginning of a line.
918 (cond ((and arg
(not (consp arg
))) (forward-line 1))
919 ((and (eq (current-buffer) (window-buffer))
920 (> (point) (window-end nil t
)))
921 ;; If the end of the buffer is not already on the screen,
922 ;; then scroll specially to put it near, but not at, the bottom.
923 (overlay-recenter (point))
925 (put 'end-of-buffer
'interactive-only
"use `(goto-char (point-max))' instead.")
927 (defcustom delete-active-region t
928 "Whether single-char deletion commands delete an active region.
929 This has an effect only if Transient Mark mode is enabled, and
930 affects `delete-forward-char' and `delete-backward-char', though
933 If the value is the symbol `kill', the active region is killed
935 :type
'(choice (const :tag
"Delete active region" t
)
936 (const :tag
"Kill active region" kill
)
937 (const :tag
"Do ordinary deletion" nil
))
941 (defvar region-extract-function
943 (when (region-beginning)
944 (if (eq delete
'delete-only
)
945 (delete-region (region-beginning) (region-end))
946 (filter-buffer-substring (region-beginning) (region-end) delete
))))
947 "Function to get the region's content.
948 Called with one argument DELETE.
949 If DELETE is `delete-only', then only delete the region and the return value
950 is undefined. If DELETE is nil, just return the content as a string.
951 If anything else, delete the region and return its content as a string.")
953 (defun delete-backward-char (n &optional killflag
)
954 "Delete the previous N characters (following if N is negative).
955 If Transient Mark mode is enabled, the mark is active, and N is 1,
956 delete the text in the region and deactivate the mark instead.
957 To disable this, set option `delete-active-region' to nil.
959 Optional second arg KILLFLAG, if non-nil, means to kill (save in
960 kill ring) instead of delete. Interactively, N is the prefix
961 arg, and KILLFLAG is set if N is explicitly specified.
963 In Overwrite mode, single character backward deletion may replace
964 tabs with spaces so as to back over columns, unless point is at
965 the end of the line."
968 (signal 'wrong-type-argument
(list 'integerp n
)))
969 (cond ((and (use-region-p)
972 ;; If a region is active, kill or delete it.
973 (if (eq delete-active-region
'kill
)
974 (kill-region (region-beginning) (region-end) 'region
)
975 (funcall region-extract-function
'delete-only
)))
976 ;; In Overwrite mode, maybe untabify while deleting
977 ((null (or (null overwrite-mode
)
979 (memq (char-before) '(?
\t ?
\n))
981 (eq (char-after) ?
\n)))
982 (let ((ocol (current-column)))
983 (delete-char (- n
) killflag
)
985 (insert-char ?\s
(- ocol
(current-column)) nil
))))
986 ;; Otherwise, do simple deletion.
987 (t (delete-char (- n
) killflag
))))
988 (put 'delete-backward-char
'interactive-only
'delete-char
)
990 (defun delete-forward-char (n &optional killflag
)
991 "Delete the following N characters (previous if N is negative).
992 If Transient Mark mode is enabled, the mark is active, and N is 1,
993 delete the text in the region and deactivate the mark instead.
994 To disable this, set variable `delete-active-region' to nil.
996 Optional second arg KILLFLAG non-nil means to kill (save in kill
997 ring) instead of delete. Interactively, N is the prefix arg, and
998 KILLFLAG is set if N was explicitly specified."
1000 (unless (integerp n
)
1001 (signal 'wrong-type-argument
(list 'integerp n
)))
1002 (cond ((and (use-region-p)
1003 delete-active-region
1005 ;; If a region is active, kill or delete it.
1006 (if (eq delete-active-region
'kill
)
1007 (kill-region (region-beginning) (region-end) 'region
)
1008 (funcall region-extract-function
'delete-only
)))
1010 ;; Otherwise, do simple deletion.
1011 (t (delete-char n killflag
))))
1012 (put 'delete-forward-char
'interactive-only
'delete-char
)
1014 (defun mark-whole-buffer ()
1015 "Put point at beginning and mark at end of buffer.
1016 If narrowing is in effect, only uses the accessible part of the buffer.
1017 You probably should not use this function in Lisp programs;
1018 it is usually a mistake for a Lisp function to use any subroutine
1019 that uses or sets the mark."
1022 (push-mark (point-max) nil t
)
1023 (goto-char (point-min)))
1026 ;; Counting lines, one way or another.
1028 (defun goto-line (line &optional buffer
)
1029 "Go to LINE, counting from line 1 at beginning of buffer.
1030 If called interactively, a numeric prefix argument specifies
1031 LINE; without a numeric prefix argument, read LINE from the
1034 If optional argument BUFFER is non-nil, switch to that buffer and
1035 move to line LINE there. If called interactively with \\[universal-argument]
1036 as argument, BUFFER is the most recently selected other buffer.
1038 Prior to moving point, this function sets the mark (without
1039 activating it), unless Transient Mark mode is enabled and the
1040 mark is already active.
1042 This function is usually the wrong thing to use in a Lisp program.
1043 What you probably want instead is something like:
1044 (goto-char (point-min))
1045 (forward-line (1- N))
1046 If at all possible, an even better solution is to use char counts
1047 rather than line counts."
1049 (if (and current-prefix-arg
(not (consp current-prefix-arg
)))
1050 (list (prefix-numeric-value current-prefix-arg
))
1051 ;; Look for a default, a number in the buffer at point.
1054 (skip-chars-backward "0-9")
1055 (if (looking-at "[0-9]")
1057 (buffer-substring-no-properties
1059 (progn (skip-chars-forward "0-9")
1061 ;; Decide if we're switching buffers.
1063 (if (consp current-prefix-arg
)
1064 (other-buffer (current-buffer) t
)))
1067 (concat " in " (buffer-name buffer
))
1069 ;; Read the argument, offering that number (if any) as default.
1070 (list (read-number (format "Goto line%s: " buffer-prompt
)
1071 (list default
(line-number-at-pos)))
1073 ;; Switch to the desired buffer, one way or another.
1075 (let ((window (get-buffer-window buffer
)))
1076 (if window
(select-window window
)
1077 (switch-to-buffer-other-window buffer
))))
1078 ;; Leave mark at previous position
1079 (or (region-active-p) (push-mark))
1080 ;; Move to the specified line number in that buffer.
1083 (goto-char (point-min))
1084 (if (eq selective-display t
)
1085 (re-search-forward "[\n\C-m]" nil
'end
(1- line
))
1086 (forward-line (1- line
)))))
1087 (put 'goto-line
'interactive-only
'forward-line
)
1089 (defun count-words-region (start end
&optional arg
)
1090 "Count the number of words in the region.
1091 If called interactively, print a message reporting the number of
1092 lines, words, and characters in the region (whether or not the
1093 region is active); with prefix ARG, report for the entire buffer
1094 rather than the region.
1096 If called from Lisp, return the number of words between positions
1098 (interactive (if current-prefix-arg
1099 (list nil nil current-prefix-arg
)
1100 (list (region-beginning) (region-end) nil
)))
1101 (cond ((not (called-interactively-p 'any
))
1102 (count-words start end
))
1104 (count-words--buffer-message))
1106 (count-words--message "Region" start end
))))
1108 (defun count-words (start end
)
1109 "Count words between START and END.
1110 If called interactively, START and END are normally the start and
1111 end of the buffer; but if the region is active, START and END are
1112 the start and end of the region. Print a message reporting the
1113 number of lines, words, and chars.
1115 If called from Lisp, return the number of words between START and
1116 END, without printing any message."
1117 (interactive (list nil nil
))
1118 (cond ((not (called-interactively-p 'any
))
1122 (narrow-to-region start end
)
1123 (goto-char (point-min))
1124 (while (forward-word 1)
1125 (setq words
(1+ words
)))))
1128 (call-interactively 'count-words-region
))
1130 (count-words--buffer-message))))
1132 (defun count-words--buffer-message ()
1133 (count-words--message
1134 (if (buffer-narrowed-p) "Narrowed part of buffer" "Buffer")
1135 (point-min) (point-max)))
1137 (defun count-words--message (str start end
)
1138 (let ((lines (count-lines start end
))
1139 (words (count-words start end
))
1140 (chars (- end start
)))
1141 (message "%s has %d line%s, %d word%s, and %d character%s."
1143 lines
(if (= lines
1) "" "s")
1144 words
(if (= words
1) "" "s")
1145 chars
(if (= chars
1) "" "s"))))
1147 (define-obsolete-function-alias 'count-lines-region
'count-words-region
"24.1")
1150 "Print the current buffer line number and narrowed line number of point."
1152 (let ((start (point-min))
1153 (n (line-number-at-pos)))
1155 (message "Line %d" n
)
1159 (message "line %d (narrowed line %d)"
1160 (+ n
(line-number-at-pos start
) -
1) n
))))))
1162 (defun count-lines (start end
)
1163 "Return number of lines between START and END.
1164 This is usually the number of newlines between them,
1165 but can be one more if START is not equal to END
1166 and the greater of them is not at the start of a line."
1169 (narrow-to-region start end
)
1170 (goto-char (point-min))
1171 (if (eq selective-display t
)
1174 (while (re-search-forward "[\n\C-m]" nil t
40)
1175 (setq done
(+ 40 done
)))
1176 (while (re-search-forward "[\n\C-m]" nil t
1)
1177 (setq done
(+ 1 done
)))
1178 (goto-char (point-max))
1179 (if (and (/= start end
)
1183 (- (buffer-size) (forward-line (buffer-size)))))))
1185 (defun line-number-at-pos (&optional pos
)
1186 "Return (narrowed) buffer line number at position POS.
1187 If POS is nil, use current buffer location.
1188 Counting starts at (point-min), so the value refers
1189 to the contents of the accessible portion of the buffer."
1190 (let ((opoint (or pos
(point))) start
)
1192 (goto-char (point-min))
1193 (setq start
(point))
1196 (1+ (count-lines start
(point))))))
1198 (defun what-cursor-position (&optional detail
)
1199 "Print info on cursor position (on screen and within buffer).
1200 Also describe the character after point, and give its character code
1201 in octal, decimal and hex.
1203 For a non-ASCII multibyte character, also give its encoding in the
1204 buffer's selected coding system if the coding system encodes the
1205 character safely. If the character is encoded into one byte, that
1206 code is shown in hex. If the character is encoded into more than one
1207 byte, just \"...\" is shown.
1209 In addition, with prefix argument, show details about that character
1210 in *Help* buffer. See also the command `describe-char'."
1212 (let* ((char (following-char))
1214 (cond ((memq char
'(?
\x202a ?
\x202b ?
\x202d ?
\x202e
))
1215 ;; If the character is one of LRE, LRO, RLE, RLO, it
1216 ;; will start a directional embedding, which could
1217 ;; completely disrupt the rest of the line (e.g., RLO
1218 ;; will display the rest of the line right-to-left).
1219 ;; So we put an invisible PDF character after these
1220 ;; characters, to end the embedding, which eliminates
1221 ;; any effects on the rest of the line.
1222 (propertize (string ?
\x202c
) 'invisible t
))
1223 ;; Strong right-to-left characters cause reordering of
1224 ;; the following numerical characters which show the
1225 ;; codepoint, so append LRM to countermand that.
1226 ((memq (get-char-code-property char
'bidi-class
) '(R AL
))
1227 (propertize (string ?
\x200e
) 'invisible t
))
1233 (total (buffer-size))
1234 (percent (if (> total
50000)
1235 ;; Avoid overflow from multiplying by 100!
1236 (/ (+ (/ total
200) (1- pos
)) (max (/ total
100) 1))
1237 (/ (+ (/ total
2) (* 100 (1- pos
))) (max total
1))))
1238 (hscroll (if (= (window-hscroll) 0)
1240 (format " Hscroll=%d" (window-hscroll))))
1241 (col (current-column)))
1243 (if (or (/= beg
1) (/= end
(1+ total
)))
1244 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
1245 pos total percent beg end col hscroll
)
1246 (message "point=%d of %d (EOB) column=%d%s"
1247 pos total col hscroll
))
1248 (let ((coding buffer-file-coding-system
)
1249 encoded encoding-msg display-prop under-display
)
1250 (if (or (not coding
)
1251 (eq (coding-system-type coding
) t
))
1252 (setq coding
(default-value 'buffer-file-coding-system
)))
1253 (if (eq (char-charset char
) 'eight-bit
)
1255 (format "(%d, #o%o, #x%x, raw-byte)" char char char
))
1256 ;; Check if the character is displayed with some `display'
1257 ;; text property. In that case, set under-display to the
1258 ;; buffer substring covered by that property.
1259 (setq display-prop
(get-char-property pos
'display
))
1261 (let ((to (or (next-single-char-property-change pos
'display
)
1263 (if (< to
(+ pos
4))
1264 (setq under-display
"")
1265 (setq under-display
"..."
1268 (concat (buffer-substring-no-properties pos to
)
1270 (setq encoded
(and (>= char
128) (encode-coding-char char coding
))))
1273 (if (not (stringp display-prop
))
1274 (format "(%d, #o%o, #x%x, part of display \"%s\")"
1275 char char char under-display
)
1276 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
1277 char char char under-display display-prop
))
1279 (format "(%d, #o%o, #x%x, file %s)"
1281 (if (> (length encoded
) 1)
1283 (encoded-string-description encoded coding
)))
1284 (format "(%d, #o%o, #x%x)" char char char
)))))
1286 ;; We show the detailed information about CHAR.
1287 (describe-char (point)))
1288 (if (or (/= beg
1) (/= end
(1+ total
)))
1289 (message "Char: %s%s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
1291 (single-key-description char
)
1292 (buffer-substring-no-properties (point) (1+ (point))))
1294 encoding-msg pos total percent beg end col hscroll
)
1295 (message "Char: %s%s %s point=%d of %d (%d%%) column=%d%s"
1296 (if enable-multibyte-characters
1298 (single-key-description char
)
1299 (buffer-substring-no-properties (point) (1+ (point))))
1300 (single-key-description char
))
1301 bidi-fixer encoding-msg pos total percent col hscroll
))))))
1303 ;; Initialize read-expression-map. It is defined at C level.
1304 (defvar read-expression-map
1305 (let ((m (make-sparse-keymap)))
1306 (define-key m
"\M-\t" 'completion-at-point
)
1307 ;; Might as well bind TAB to completion, since inserting a TAB char is
1308 ;; much too rarely useful.
1309 (define-key m
"\t" 'completion-at-point
)
1310 (set-keymap-parent m minibuffer-local-map
)
1313 (defun read-minibuffer (prompt &optional initial-contents
)
1314 "Return a Lisp object read using the minibuffer, unevaluated.
1315 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1316 is a string to insert in the minibuffer before reading.
1317 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1318 Such arguments are used as in `read-from-minibuffer'.)"
1319 ;; Used for interactive spec `x'.
1320 (read-from-minibuffer prompt initial-contents minibuffer-local-map
1321 t
'minibuffer-history
))
1323 (defun eval-minibuffer (prompt &optional initial-contents
)
1324 "Return value of Lisp expression read using the minibuffer.
1325 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1326 is a string to insert in the minibuffer before reading.
1327 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1328 Such arguments are used as in `read-from-minibuffer'.)"
1329 ;; Used for interactive spec `X'.
1330 (eval (read--expression prompt initial-contents
)))
1332 (defvar minibuffer-completing-symbol nil
1333 "Non-nil means completing a Lisp symbol in the minibuffer.")
1334 (make-obsolete-variable 'minibuffer-completing-symbol nil
"24.1" 'get
)
1336 (defvar minibuffer-default nil
1337 "The current default value or list of default values in the minibuffer.
1338 The functions `read-from-minibuffer' and `completing-read' bind
1339 this variable locally.")
1341 (defcustom eval-expression-print-level
4
1342 "Value for `print-level' while printing value in `eval-expression'.
1343 A value of nil means no limit."
1345 :type
'(choice (const :tag
"No Limit" nil
) integer
)
1348 (defcustom eval-expression-print-length
12
1349 "Value for `print-length' while printing value in `eval-expression'.
1350 A value of nil means no limit."
1352 :type
'(choice (const :tag
"No Limit" nil
) integer
)
1355 (defcustom eval-expression-debug-on-error t
1356 "If non-nil set `debug-on-error' to t in `eval-expression'.
1357 If nil, don't change the value of `debug-on-error'."
1362 (defun eval-expression-print-format (value)
1363 "Format VALUE as a result of evaluated expression.
1364 Return a formatted string which is displayed in the echo area
1365 in addition to the value printed by prin1 in functions which
1366 display the result of expression evaluation."
1367 (if (and (integerp value
)
1368 (or (eq standard-output t
)
1369 (zerop (prefix-numeric-value current-prefix-arg
))))
1371 (if (and (characterp value
)
1372 (char-displayable-p value
))
1373 (prin1-char value
))))
1375 (format " (#o%o, #x%x, %s)" value value char-string
)
1376 (format " (#o%o, #x%x)" value value
)))))
1378 (defvar eval-expression-minibuffer-setup-hook nil
1379 "Hook run by `eval-expression' when entering the minibuffer.")
1381 (defun read--expression (prompt &optional initial-contents
)
1382 (let ((minibuffer-completing-symbol t
))
1383 (minibuffer-with-setup-hook
1385 (add-hook 'completion-at-point-functions
1386 #'lisp-completion-at-point nil t
)
1387 (run-hooks 'eval-expression-minibuffer-setup-hook
))
1388 (read-from-minibuffer prompt initial-contents
1389 read-expression-map t
1390 'read-expression-history
))))
1392 ;; We define this, rather than making `eval' interactive,
1393 ;; for the sake of completion of names like eval-region, eval-buffer.
1394 (defun eval-expression (exp &optional insert-value
)
1395 "Evaluate EXP and print value in the echo area.
1396 When called interactively, read an Emacs Lisp expression and evaluate it.
1397 Value is also consed on to front of the variable `values'.
1398 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1399 argument) means insert the result into the current buffer instead of
1400 printing it in the echo area.
1402 Normally, this function truncates long output according to the value
1403 of the variables `eval-expression-print-length' and
1404 `eval-expression-print-level'. With a prefix argument of zero,
1405 however, there is no such truncation. Such a prefix argument
1406 also causes integers to be printed in several additional formats
1407 \(octal, hexadecimal, and character).
1409 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1412 If `eval-expression-debug-on-error' is non-nil, which is the default,
1413 this command arranges for all errors to enter the debugger."
1415 (list (read--expression "Eval: ")
1416 current-prefix-arg
))
1418 (if (null eval-expression-debug-on-error
)
1419 (push (eval exp lexical-binding
) values
)
1420 (let ((old-value (make-symbol "t")) new-value
)
1421 ;; Bind debug-on-error to something unique so that we can
1422 ;; detect when evalled code changes it.
1423 (let ((debug-on-error old-value
))
1424 (push (eval exp lexical-binding
) values
)
1425 (setq new-value debug-on-error
))
1426 ;; If evalled code has changed the value of debug-on-error,
1427 ;; propagate that change to the global binding.
1428 (unless (eq old-value new-value
)
1429 (setq debug-on-error new-value
))))
1431 (let ((print-length (and (not (zerop (prefix-numeric-value insert-value
)))
1432 eval-expression-print-length
))
1433 (print-level (and (not (zerop (prefix-numeric-value insert-value
)))
1434 eval-expression-print-level
))
1438 (let ((standard-output (current-buffer)))
1440 (prin1 (car values
))
1441 (when (zerop (prefix-numeric-value insert-value
))
1442 (let ((str (eval-expression-print-format (car values
))))
1443 (if str
(princ str
)))))))
1445 (prin1 (car values
) t
)
1446 (let ((str (eval-expression-print-format (car values
))))
1447 (if str
(princ str t
)))))))
1449 (defun edit-and-eval-command (prompt command
)
1450 "Prompting with PROMPT, let user edit COMMAND and eval result.
1451 COMMAND is a Lisp expression. Let user edit that expression in
1452 the minibuffer, then read and evaluate the result."
1454 (let ((print-level nil
)
1455 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1457 (read-from-minibuffer prompt
1458 (prin1-to-string command
)
1459 read-expression-map t
1461 ;; If command was added to command-history as a string,
1462 ;; get rid of that. We want only evaluable expressions there.
1463 (if (stringp (car command-history
))
1464 (setq command-history
(cdr command-history
)))))))
1466 ;; If command to be redone does not match front of history,
1467 ;; add it to the history.
1468 (or (equal command
(car command-history
))
1469 (setq command-history
(cons command command-history
)))
1472 (defun repeat-complex-command (arg)
1473 "Edit and re-evaluate last complex command, or ARGth from last.
1474 A complex command is one which used the minibuffer.
1475 The command is placed in the minibuffer as a Lisp form for editing.
1476 The result is executed, repeating the command as changed.
1477 If the command has been changed or is not the most recent previous
1478 command it is added to the front of the command history.
1479 You can use the minibuffer history commands \
1480 \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1481 to get different commands to edit and resubmit."
1483 (let ((elt (nth (1- arg
) command-history
))
1488 (let ((print-level nil
)
1489 (minibuffer-history-position arg
)
1490 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1492 (read-from-minibuffer
1493 "Redo: " (prin1-to-string elt
) read-expression-map t
1494 (cons 'command-history arg
))
1496 ;; If command was added to command-history as a
1497 ;; string, get rid of that. We want only
1498 ;; evaluable expressions there.
1499 (if (stringp (car command-history
))
1500 (setq command-history
(cdr command-history
))))))
1502 ;; If command to be redone does not match front of history,
1503 ;; add it to the history.
1504 (or (equal newcmd
(car command-history
))
1505 (setq command-history
(cons newcmd command-history
)))
1508 ;; Trick called-interactively-p into thinking that `newcmd' is
1509 ;; an interactive call (bug#14136).
1510 (add-hook 'called-interactively-p-functions
1511 #'repeat-complex-command--called-interactively-skip
)
1513 (remove-hook 'called-interactively-p-functions
1514 #'repeat-complex-command--called-interactively-skip
)))
1516 (error "Argument %d is beyond length of command history" arg
)
1517 (error "There are no previous complex commands to repeat")))))
1519 (defun repeat-complex-command--called-interactively-skip (i _frame1 frame2
)
1520 (and (eq 'eval
(cadr frame2
))
1521 (eq 'repeat-complex-command
1522 (cadr (backtrace-frame i
#'called-interactively-p
)))
1525 (defvar extended-command-history nil
)
1527 (defun read-extended-command ()
1528 "Read command name to invoke in `execute-extended-command'."
1529 (minibuffer-with-setup-hook
1531 (set (make-local-variable 'minibuffer-default-add-function
)
1533 ;; Get a command name at point in the original buffer
1534 ;; to propose it after M-n.
1535 (with-current-buffer (window-buffer (minibuffer-selected-window))
1536 (and (commandp (function-called-at-point))
1537 (format "%S" (function-called-at-point)))))))
1538 ;; Read a string, completing from and restricting to the set of
1539 ;; all defined commands. Don't provide any initial input.
1540 ;; Save the command read on the extended-command history list.
1543 ((eq current-prefix-arg
'-
) "- ")
1544 ((and (consp current-prefix-arg
)
1545 (eq (car current-prefix-arg
) 4)) "C-u ")
1546 ((and (consp current-prefix-arg
)
1547 (integerp (car current-prefix-arg
)))
1548 (format "%d " (car current-prefix-arg
)))
1549 ((integerp current-prefix-arg
)
1550 (format "%d " current-prefix-arg
)))
1551 ;; This isn't strictly correct if `execute-extended-command'
1552 ;; is bound to anything else (e.g. [menu]).
1553 ;; It could use (key-description (this-single-command-keys)),
1554 ;; but actually a prompt other than "M-x" would be confusing,
1555 ;; because "M-x" is a well-known prompt to read a command
1556 ;; and it serves as a shorthand for "Extended command: ".
1558 obarray
'commandp t nil
'extended-command-history
)))
1560 (defcustom suggest-key-bindings t
1561 "Non-nil means show the equivalent key-binding when M-x command has one.
1562 The value can be a length of time to show the message for.
1563 If the value is non-nil and not a number, we wait 2 seconds."
1565 :type
'(choice (const :tag
"off" nil
)
1566 (integer :tag
"time" 2)
1569 (defun execute-extended-command (prefixarg &optional command-name
)
1570 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1571 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1572 "Read a command name, then read the arguments and call the command.
1573 Interactively, to pass a prefix argument to the command you are
1574 invoking, give a prefix argument to `execute-extended-command'.
1575 Noninteractively, the argument PREFIXARG is the prefix argument to
1576 give to the command you invoke."
1577 (interactive (list current-prefix-arg
(read-extended-command)))
1578 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1579 (if (null command-name
)
1580 (setq command-name
(let ((current-prefix-arg prefixarg
)) ; for prompt
1581 (read-extended-command))))
1582 (let* ((function (and (stringp command-name
) (intern-soft command-name
)))
1583 (binding (and suggest-key-bindings
1584 (not executing-kbd-macro
)
1585 (where-is-internal function overriding-local-map t
))))
1586 (unless (commandp function
)
1587 (error "`%s' is not a valid command name" command-name
))
1588 (setq this-command function
)
1589 ;; Normally `real-this-command' should never be changed, but here we really
1590 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1591 ;; binding" for <cmd>, so the command the user really wanted to run is
1592 ;; `function' and not `execute-extended-command'. The difference is
1593 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1594 (setq real-this-command function
)
1595 (let ((prefix-arg prefixarg
))
1596 (command-execute function
'record
))
1597 ;; If enabled, show which key runs this command.
1599 ;; But first wait, and skip the message if there is input.
1601 ;; If this command displayed something in the echo area;
1602 ;; wait a few seconds, then display our suggestion message.
1604 ((zerop (length (current-message))) 0)
1605 ((numberp suggest-key-bindings
) suggest-key-bindings
)
1607 (when (and waited
(not (consp unread-command-events
)))
1609 (format "You can run the command `%s' with %s"
1610 function
(key-description binding
))
1611 (sit-for (if (numberp suggest-key-bindings
)
1612 suggest-key-bindings
1615 (defun command-execute (cmd &optional record-flag keys special
)
1616 ;; BEWARE: Called directly from the C code.
1617 "Execute CMD as an editor command.
1618 CMD must be a symbol that satisfies the `commandp' predicate.
1619 Optional second arg RECORD-FLAG non-nil
1620 means unconditionally put this command in the variable `command-history'.
1621 Otherwise, that is done only if an arg is read using the minibuffer.
1622 The argument KEYS specifies the value to use instead of (this-command-keys)
1623 when reading the arguments; if it is nil, (this-command-keys) is used.
1624 The argument SPECIAL, if non-nil, means that this command is executing
1625 a special event, so ignore the prefix argument and don't clear it."
1626 (setq debug-on-next-call nil
)
1627 (let ((prefixarg (unless special
1629 (setq current-prefix-arg prefix-arg
)
1630 (setq prefix-arg nil
)))))
1633 ;; FIXME: Weird calling convention!
1634 (run-hooks 'disabled-command-function
))
1638 (setq final
(indirect-function final
))
1639 (if (autoloadp final
)
1640 (setq final
(autoload-do-load final cmd
)))))
1643 ;; If requested, place the macro in the command history. For
1644 ;; other sorts of commands, call-interactively takes care of this.
1646 (push `(execute-kbd-macro ,final
,prefixarg
) command-history
)
1647 ;; Don't keep command history around forever.
1648 (when (and (numberp history-length
) (> history-length
0))
1649 (let ((cell (nthcdr history-length command-history
)))
1650 (if (consp cell
) (setcdr cell nil
)))))
1651 (execute-kbd-macro final prefixarg
))
1653 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1654 (prog1 (call-interactively cmd record-flag keys
)
1655 (when (and (symbolp cmd
)
1656 (get cmd
'byte-obsolete-info
)
1657 (not (get cmd
'command-execute-obsolete-warned
)))
1658 (put cmd
'command-execute-obsolete-warned t
)
1659 (message "%s" (macroexp--obsolete-warning
1660 cmd
(get cmd
'byte-obsolete-info
) "command")))))))))
1662 (defvar minibuffer-history nil
1663 "Default minibuffer history list.
1664 This is used for all minibuffer input
1665 except when an alternate history list is specified.
1667 Maximum length of the history list is determined by the value
1668 of `history-length', which see.")
1669 (defvar minibuffer-history-sexp-flag nil
1670 "Control whether history list elements are expressions or strings.
1671 If the value of this variable equals current minibuffer depth,
1672 they are expressions; otherwise they are strings.
1673 \(That convention is designed to do the right thing for
1674 recursive uses of the minibuffer.)")
1675 (setq minibuffer-history-variable
'minibuffer-history
)
1676 (setq minibuffer-history-position nil
) ;; Defvar is in C code.
1677 (defvar minibuffer-history-search-history nil
)
1679 (defvar minibuffer-text-before-history nil
1680 "Text that was in this minibuffer before any history commands.
1681 This is nil if there have not yet been any history commands
1682 in this use of the minibuffer.")
1684 (add-hook 'minibuffer-setup-hook
'minibuffer-history-initialize
)
1686 (defun minibuffer-history-initialize ()
1687 (setq minibuffer-text-before-history nil
))
1689 (defun minibuffer-avoid-prompt (_new _old
)
1690 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1691 (constrain-to-field nil
(point-max)))
1693 (defcustom minibuffer-history-case-insensitive-variables nil
1694 "Minibuffer history variables for which matching should ignore case.
1695 If a history variable is a member of this list, then the
1696 \\[previous-matching-history-element] and \\[next-matching-history-element]\
1697 commands ignore case when searching it, regardless of `case-fold-search'."
1698 :type
'(repeat variable
)
1701 (defun previous-matching-history-element (regexp n
)
1702 "Find the previous history element that matches REGEXP.
1703 \(Previous history elements refer to earlier actions.)
1704 With prefix argument N, search for Nth previous match.
1705 If N is negative, find the next or Nth next match.
1706 Normally, history elements are matched case-insensitively if
1707 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1708 makes the search case-sensitive.
1709 See also `minibuffer-history-case-insensitive-variables'."
1711 (let* ((enable-recursive-minibuffers t
)
1712 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1714 minibuffer-local-map
1716 'minibuffer-history-search-history
1717 (car minibuffer-history-search-history
))))
1718 ;; Use the last regexp specified, by default, if input is empty.
1719 (list (if (string= regexp
"")
1720 (if minibuffer-history-search-history
1721 (car minibuffer-history-search-history
)
1722 (user-error "No previous history search regexp"))
1724 (prefix-numeric-value current-prefix-arg
))))
1726 (if (and (zerop minibuffer-history-position
)
1727 (null minibuffer-text-before-history
))
1728 (setq minibuffer-text-before-history
1729 (minibuffer-contents-no-properties)))
1730 (let ((history (symbol-value minibuffer-history-variable
))
1732 (if (isearch-no-upper-case-p regexp t
) ; assume isearch.el is dumped
1733 ;; On some systems, ignore case for file names.
1734 (if (memq minibuffer-history-variable
1735 minibuffer-history-case-insensitive-variables
)
1737 ;; Respect the user's setting for case-fold-search:
1743 (pos minibuffer-history-position
))
1746 (setq pos
(min (max 1 (+ pos
(if (< n
0) -
1 1))) (length history
)))
1747 (when (= pos prevpos
)
1748 (user-error (if (= pos
1)
1749 "No later matching history item"
1750 "No earlier matching history item")))
1752 (if (eq minibuffer-history-sexp-flag
(minibuffer-depth))
1753 (let ((print-level nil
))
1754 (prin1-to-string (nth (1- pos
) history
)))
1755 (nth (1- pos
) history
)))
1758 (and (string-match regexp match-string
)
1760 (and (string-match (concat ".*\\(" regexp
"\\)") match-string
)
1761 (match-beginning 1))))
1763 (setq n
(+ n
(if (< n
0) 1 -
1)))))
1764 (setq minibuffer-history-position pos
)
1765 (goto-char (point-max))
1766 (delete-minibuffer-contents)
1767 (insert match-string
)
1768 (goto-char (+ (minibuffer-prompt-end) match-offset
))))
1769 (if (memq (car (car command-history
)) '(previous-matching-history-element
1770 next-matching-history-element
))
1771 (setq command-history
(cdr command-history
))))
1773 (defun next-matching-history-element (regexp n
)
1774 "Find the next history element that matches REGEXP.
1775 \(The next history element refers to a more recent action.)
1776 With prefix argument N, search for Nth next match.
1777 If N is negative, find the previous or Nth previous match.
1778 Normally, history elements are matched case-insensitively if
1779 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1780 makes the search case-sensitive."
1782 (let* ((enable-recursive-minibuffers t
)
1783 (regexp (read-from-minibuffer "Next element matching (regexp): "
1785 minibuffer-local-map
1787 'minibuffer-history-search-history
1788 (car minibuffer-history-search-history
))))
1789 ;; Use the last regexp specified, by default, if input is empty.
1790 (list (if (string= regexp
"")
1791 (if minibuffer-history-search-history
1792 (car minibuffer-history-search-history
)
1793 (user-error "No previous history search regexp"))
1795 (prefix-numeric-value current-prefix-arg
))))
1796 (previous-matching-history-element regexp
(- n
)))
1798 (defvar minibuffer-temporary-goal-position nil
)
1800 (defvar minibuffer-default-add-function
'minibuffer-default-add-completions
1801 "Function run by `goto-history-element' before consuming default values.
1802 This is useful to dynamically add more elements to the list of default values
1803 when `goto-history-element' reaches the end of this list.
1804 Before calling this function `goto-history-element' sets the variable
1805 `minibuffer-default-add-done' to t, so it will call this function only
1806 once. In special cases, when this function needs to be called more
1807 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1808 overriding the setting of this variable to t in `goto-history-element'.")
1810 (defvar minibuffer-default-add-done nil
1811 "When nil, add more elements to the end of the list of default values.
1812 The value nil causes `goto-history-element' to add more elements to
1813 the list of defaults when it reaches the end of this list. It does
1814 this by calling a function defined by `minibuffer-default-add-function'.")
1816 (make-variable-buffer-local 'minibuffer-default-add-done
)
1818 (defun minibuffer-default-add-completions ()
1819 "Return a list of all completions without the default value.
1820 This function is used to add all elements of the completion table to
1821 the end of the list of defaults just after the default value."
1822 (let ((def minibuffer-default
)
1823 (all (all-completions ""
1824 minibuffer-completion-table
1825 minibuffer-completion-predicate
)))
1828 (cons def
(delete def all
)))))
1830 (defun goto-history-element (nabs)
1831 "Puts element of the minibuffer history in the minibuffer.
1832 The argument NABS specifies the absolute history position."
1834 (when (and (not minibuffer-default-add-done
)
1835 (functionp minibuffer-default-add-function
)
1836 (< nabs
(- (if (listp minibuffer-default
)
1837 (length minibuffer-default
)
1839 (setq minibuffer-default-add-done t
1840 minibuffer-default
(funcall minibuffer-default-add-function
)))
1841 (let ((minimum (if minibuffer-default
1842 (- (if (listp minibuffer-default
)
1843 (length minibuffer-default
)
1846 elt minibuffer-returned-to-present
)
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 (if (< nabs minimum
)
1852 (user-error (if minibuffer-default
1853 "End of defaults; no next item"
1854 "End of history; no default available")))
1855 (if (> nabs
(length (symbol-value minibuffer-history-variable
)))
1856 (user-error "Beginning of history; no preceding item"))
1857 (unless (memq last-command
'(next-history-element
1858 previous-history-element
))
1859 (let ((prompt-end (minibuffer-prompt-end)))
1860 (set (make-local-variable 'minibuffer-temporary-goal-position
)
1861 (cond ((<= (point) prompt-end
) prompt-end
)
1864 (goto-char (point-max))
1865 (delete-minibuffer-contents)
1866 (setq minibuffer-history-position nabs
)
1868 (setq elt
(if (listp minibuffer-default
)
1869 (nth (1- (abs nabs
)) minibuffer-default
)
1870 minibuffer-default
)))
1872 (setq elt
(or minibuffer-text-before-history
""))
1873 (setq minibuffer-returned-to-present t
)
1874 (setq minibuffer-text-before-history nil
))
1875 (t (setq elt
(nth (1- minibuffer-history-position
)
1876 (symbol-value minibuffer-history-variable
)))))
1878 (if (and (eq minibuffer-history-sexp-flag
(minibuffer-depth))
1879 (not minibuffer-returned-to-present
))
1880 (let ((print-level nil
))
1881 (prin1-to-string elt
))
1883 (goto-char (or minibuffer-temporary-goal-position
(point-max)))))
1885 (defun next-history-element (n)
1886 "Puts next element of the minibuffer history in the minibuffer.
1887 With argument N, it uses the Nth following element."
1890 (goto-history-element (- minibuffer-history-position n
))))
1892 (defun previous-history-element (n)
1893 "Puts previous element of the minibuffer history in the minibuffer.
1894 With argument N, it uses the Nth previous element."
1897 (goto-history-element (+ minibuffer-history-position n
))))
1899 (defun next-complete-history-element (n)
1900 "Get next history element which completes the minibuffer before the point.
1901 The contents of the minibuffer after the point are deleted, and replaced
1902 by the new completion."
1904 (let ((point-at-start (point)))
1905 (next-matching-history-element
1907 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
1909 ;; next-matching-history-element always puts us at (point-min).
1910 ;; Move to the position we were at before changing the buffer contents.
1911 ;; This is still sensible, because the text before point has not changed.
1912 (goto-char point-at-start
)))
1914 (defun previous-complete-history-element (n)
1916 Get previous history element which completes the minibuffer before the point.
1917 The contents of the minibuffer after the point are deleted, and replaced
1918 by the new completion."
1920 (next-complete-history-element (- n
)))
1922 ;; For compatibility with the old subr of the same name.
1923 (defun minibuffer-prompt-width ()
1924 "Return the display width of the minibuffer prompt.
1925 Return 0 if current buffer is not a minibuffer."
1926 ;; Return the width of everything before the field at the end of
1927 ;; the buffer; this should be 0 for normal buffers.
1928 (1- (minibuffer-prompt-end)))
1930 ;; isearch minibuffer history
1931 (add-hook 'minibuffer-setup-hook
'minibuffer-history-isearch-setup
)
1933 (defvar minibuffer-history-isearch-message-overlay
)
1934 (make-variable-buffer-local 'minibuffer-history-isearch-message-overlay
)
1936 (defun minibuffer-history-isearch-setup ()
1937 "Set up a minibuffer for using isearch to search the minibuffer history.
1938 Intended to be added to `minibuffer-setup-hook'."
1939 (set (make-local-variable 'isearch-search-fun-function
)
1940 'minibuffer-history-isearch-search
)
1941 (set (make-local-variable 'isearch-message-function
)
1942 'minibuffer-history-isearch-message
)
1943 (set (make-local-variable 'isearch-wrap-function
)
1944 'minibuffer-history-isearch-wrap
)
1945 (set (make-local-variable 'isearch-push-state-function
)
1946 'minibuffer-history-isearch-push-state
)
1947 (add-hook 'isearch-mode-end-hook
'minibuffer-history-isearch-end nil t
))
1949 (defun minibuffer-history-isearch-end ()
1950 "Clean up the minibuffer after terminating isearch in the minibuffer."
1951 (if minibuffer-history-isearch-message-overlay
1952 (delete-overlay minibuffer-history-isearch-message-overlay
)))
1954 (defun minibuffer-history-isearch-search ()
1955 "Return the proper search function, for isearch in minibuffer history."
1956 (lambda (string bound noerror
)
1958 ;; Use standard functions to search within minibuffer text
1959 (isearch-search-fun-default))
1961 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1962 ;; searching forward. Lazy-highlight calls this lambda with the
1963 ;; bound arg, so skip the minibuffer prompt.
1964 (if (and bound isearch-forward
(< (point) (minibuffer-prompt-end)))
1965 (goto-char (minibuffer-prompt-end)))
1967 ;; 1. First try searching in the initial minibuffer text
1968 (funcall search-fun string
1969 (if isearch-forward bound
(minibuffer-prompt-end))
1971 ;; 2. If the above search fails, start putting next/prev history
1972 ;; elements in the minibuffer successively, and search the string
1973 ;; in them. Do this only when bound is nil (i.e. not while
1974 ;; lazy-highlighting search strings in the current minibuffer text).
1979 (cond (isearch-forward
1980 (next-history-element 1)
1981 (goto-char (minibuffer-prompt-end)))
1983 (previous-history-element 1)
1984 (goto-char (point-max))))
1985 (setq isearch-barrier
(point) isearch-opoint
(point))
1986 ;; After putting the next/prev history element, search
1987 ;; the string in them again, until next-history-element
1988 ;; or previous-history-element raises an error at the
1989 ;; beginning/end of history.
1990 (setq found
(funcall search-fun string
1991 (unless isearch-forward
1992 ;; For backward search, don't search
1993 ;; in the minibuffer prompt
1994 (minibuffer-prompt-end))
1996 ;; Return point of the new search result
1998 ;; Return nil when next(prev)-history-element fails
2001 (defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis
)
2002 "Display the minibuffer history search prompt.
2003 If there are no search errors, this function displays an overlay with
2004 the isearch prompt which replaces the original minibuffer prompt.
2005 Otherwise, it displays the standard isearch message returned from
2006 the function `isearch-message'."
2007 (if (not (and (minibufferp) isearch-success
(not isearch-error
)))
2008 ;; Use standard function `isearch-message' when not in the minibuffer,
2009 ;; or search fails, or has an error (like incomplete regexp).
2010 ;; This function overwrites minibuffer text with isearch message,
2011 ;; so it's possible to see what is wrong in the search string.
2012 (isearch-message c-q-hack ellipsis
)
2013 ;; Otherwise, put the overlay with the standard isearch prompt over
2014 ;; the initial minibuffer prompt.
2015 (if (overlayp minibuffer-history-isearch-message-overlay
)
2016 (move-overlay minibuffer-history-isearch-message-overlay
2017 (point-min) (minibuffer-prompt-end))
2018 (setq minibuffer-history-isearch-message-overlay
2019 (make-overlay (point-min) (minibuffer-prompt-end)))
2020 (overlay-put minibuffer-history-isearch-message-overlay
'evaporate t
))
2021 (overlay-put minibuffer-history-isearch-message-overlay
2022 'display
(isearch-message-prefix c-q-hack ellipsis
))
2023 ;; And clear any previous isearch message.
2026 (defun minibuffer-history-isearch-wrap ()
2027 "Wrap the minibuffer history search when search fails.
2028 Move point to the first history element for a forward search,
2029 or to the last history element for a backward search."
2030 ;; When `minibuffer-history-isearch-search' fails on reaching the
2031 ;; beginning/end of the history, wrap the search to the first/last
2032 ;; minibuffer history element.
2034 (goto-history-element (length (symbol-value minibuffer-history-variable
)))
2035 (goto-history-element 0))
2036 (setq isearch-success t
)
2037 (goto-char (if isearch-forward
(minibuffer-prompt-end) (point-max))))
2039 (defun minibuffer-history-isearch-push-state ()
2040 "Save a function restoring the state of minibuffer history search.
2041 Save `minibuffer-history-position' to the additional state parameter
2042 in the search status stack."
2043 (let ((pos minibuffer-history-position
))
2045 (minibuffer-history-isearch-pop-state cmd pos
))))
2047 (defun minibuffer-history-isearch-pop-state (_cmd hist-pos
)
2048 "Restore the minibuffer history search state.
2049 Go to the history element by the absolute history position HIST-POS."
2050 (goto-history-element hist-pos
))
2053 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2054 (define-obsolete-function-alias 'advertised-undo
'undo
"23.2")
2056 (defconst undo-equiv-table
(make-hash-table :test
'eq
:weakness t
)
2057 "Table mapping redo records to the corresponding undo one.
2058 A redo record for undo-in-region maps to t.
2059 A redo record for ordinary undo maps to the following (earlier) undo.")
2061 (defvar undo-in-region nil
2062 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
2064 (defvar undo-no-redo nil
2065 "If t, `undo' doesn't go through redo entries.")
2067 (defvar pending-undo-list nil
2068 "Within a run of consecutive undo commands, list remaining to be undone.
2069 If t, we undid all the way to the end of it.")
2071 (defun undo (&optional arg
)
2072 "Undo some previous changes.
2073 Repeat this command to undo more changes.
2074 A numeric ARG serves as a repeat count.
2076 In Transient Mark mode when the mark is active, only undo changes within
2077 the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
2078 as an argument limits undo to changes within the current region."
2080 ;; Make last-command indicate for the next command that this was an undo.
2081 ;; That way, another undo will undo more.
2082 ;; If we get to the end of the undo history and get an error,
2083 ;; another undo command will find the undo history empty
2084 ;; and will get another error. To begin undoing the undos,
2085 ;; you must type some other command.
2086 (let* ((modified (buffer-modified-p))
2087 ;; For an indirect buffer, look in the base buffer for the
2089 (base-buffer (or (buffer-base-buffer) (current-buffer)))
2090 (recent-save (with-current-buffer base-buffer
2091 (recent-auto-save-p)))
2093 ;; If we get an error in undo-start,
2094 ;; the next command should not be a "consecutive undo".
2095 ;; So set `this-command' to something other than `undo'.
2096 (setq this-command
'undo-start
)
2098 (unless (and (eq last-command
'undo
)
2099 (or (eq pending-undo-list t
)
2100 ;; If something (a timer or filter?) changed the buffer
2101 ;; since the previous command, don't continue the undo seq.
2102 (let ((list buffer-undo-list
))
2103 (while (eq (car list
) nil
)
2104 (setq list
(cdr list
)))
2105 ;; If the last undo record made was made by undo
2106 ;; it shows nothing else happened in between.
2107 (gethash list undo-equiv-table
))))
2108 (setq undo-in-region
2109 (or (region-active-p) (and arg
(not (numberp arg
)))))
2111 (undo-start (region-beginning) (region-end))
2113 ;; get rid of initial undo boundary
2115 ;; If we got this far, the next command should be a consecutive undo.
2116 (setq this-command
'undo
)
2117 ;; Check to see whether we're hitting a redo record, and if
2118 ;; so, ask the user whether she wants to skip the redo/undo pair.
2119 (let ((equiv (gethash pending-undo-list undo-equiv-table
)))
2120 (or (eq (selected-window) (minibuffer-window))
2121 (setq message
(format "%s%s!"
2122 (if (or undo-no-redo
(not equiv
))
2124 (if undo-in-region
" in region" ""))))
2125 (when (and (consp equiv
) undo-no-redo
)
2126 ;; The equiv entry might point to another redo record if we have done
2127 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2128 (while (let ((next (gethash equiv undo-equiv-table
)))
2129 (if next
(setq equiv next
))))
2130 (setq pending-undo-list equiv
)))
2133 (prefix-numeric-value arg
)
2135 ;; Record the fact that the just-generated undo records come from an
2136 ;; undo operation--that is, they are redo records.
2137 ;; In the ordinary case (not within a region), map the redo
2138 ;; record to the following undos.
2139 ;; I don't know how to do that in the undo-in-region case.
2140 (let ((list buffer-undo-list
))
2141 ;; Strip any leading undo boundaries there might be, like we do
2142 ;; above when checking.
2143 (while (eq (car list
) nil
)
2144 (setq list
(cdr list
)))
2145 (puthash list
(if undo-in-region t pending-undo-list
)
2147 ;; Don't specify a position in the undo record for the undo command.
2148 ;; Instead, undoing this should move point to where the change is.
2149 (let ((tail buffer-undo-list
)
2152 (when (integerp (car tail
))
2153 (let ((pos (car tail
)))
2155 (setcdr prev
(cdr tail
))
2156 (setq buffer-undo-list
(cdr tail
)))
2157 (setq tail
(cdr tail
))
2159 (if (eq pos
(car tail
))
2161 (setcdr prev
(cdr tail
))
2162 (setq buffer-undo-list
(cdr tail
)))
2164 (setq tail
(cdr tail
)))
2166 (setq prev tail tail
(cdr tail
))))
2167 ;; Record what the current undo list says,
2168 ;; so the next command can tell if the buffer was modified in between.
2169 (and modified
(not (buffer-modified-p))
2170 (with-current-buffer base-buffer
2171 (delete-auto-save-file-if-necessary recent-save
)))
2172 ;; Display a message announcing success.
2174 (message "%s" message
))))
2176 (defun buffer-disable-undo (&optional buffer
)
2177 "Make BUFFER stop keeping undo information.
2178 No argument or nil as argument means do this for the current buffer."
2180 (with-current-buffer (if buffer
(get-buffer buffer
) (current-buffer))
2181 (setq buffer-undo-list t
)))
2183 (defun undo-only (&optional arg
)
2184 "Undo some previous changes.
2185 Repeat this command to undo more changes.
2186 A numeric ARG serves as a repeat count.
2187 Contrary to `undo', this will not redo a previous undo."
2189 (let ((undo-no-redo t
)) (undo arg
)))
2191 (defvar undo-in-progress nil
2192 "Non-nil while performing an undo.
2193 Some change-hooks test this variable to do something different.")
2195 (defun undo-more (n)
2196 "Undo back N undo-boundaries beyond what was already undone recently.
2197 Call `undo-start' to get ready to undo recent changes,
2198 then call `undo-more' one or more times to undo them."
2199 (or (listp pending-undo-list
)
2200 (user-error (concat "No further undo information"
2201 (and undo-in-region
" for region"))))
2202 (let ((undo-in-progress t
))
2203 ;; Note: The following, while pulling elements off
2204 ;; `pending-undo-list' will call primitive change functions which
2205 ;; will push more elements onto `buffer-undo-list'.
2206 (setq pending-undo-list
(primitive-undo n pending-undo-list
))
2207 (if (null pending-undo-list
)
2208 (setq pending-undo-list t
))))
2210 (defun primitive-undo (n list
)
2211 "Undo N records from the front of the list LIST.
2212 Return what remains of the list."
2214 ;; This is a good feature, but would make undo-start
2215 ;; unable to do what is expected.
2216 ;;(when (null (car (list)))
2217 ;; ;; If the head of the list is a boundary, it is the boundary
2218 ;; ;; preceding this command. Get rid of it and don't count it.
2219 ;; (setq list (cdr list))))
2222 ;; In a writable buffer, enable undoing read-only text that is
2223 ;; so because of text properties.
2224 (inhibit-read-only t
)
2225 ;; Don't let `intangible' properties interfere with undo.
2226 (inhibit-point-motion-hooks t
)
2227 ;; We use oldlist only to check for EQ. ++kfs
2228 (oldlist buffer-undo-list
)
2232 (while (setq next
(pop list
)) ;Exit inner loop at undo boundary.
2233 ;; Handle an integer by setting point to that value.
2235 ((pred integerp
) (goto-char next
))
2236 ;; Element (t . TIME) records previous modtime.
2237 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2238 ;; UNKNOWN_MODTIME_NSECS.
2240 ;; If this records an obsolete save
2241 ;; (not matching the actual disk file)
2242 ;; then don't mark unmodified.
2243 (when (or (equal time
(visited-file-modtime))
2245 (equal (list (car time
) (cdr time
))
2246 (visited-file-modtime))))
2247 (when (fboundp 'unlock-buffer
)
2249 (set-buffer-modified-p nil
)))
2250 ;; Element (nil PROP VAL BEG . END) is property change.
2251 (`(nil .
,(or `(,prop
,val
,beg .
,end
) pcase--dontcare
))
2252 (when (or (> (point-min) beg
) (< (point-max) end
))
2253 (error "Changes to be undone are outside visible portion of buffer"))
2254 (put-text-property beg end prop val
))
2255 ;; Element (BEG . END) means range was inserted.
2256 (`(,(and beg
(pred integerp
)) .
,(and end
(pred integerp
)))
2257 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2258 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2259 (when (or (> (point-min) beg
) (< (point-max) end
))
2260 (error "Changes to be undone are outside visible portion of buffer"))
2261 ;; Set point first thing, so that undoing this undo
2262 ;; does not send point back to where it is now.
2264 (delete-region beg end
))
2265 ;; Element (apply FUN . ARGS) means call FUN to undo.
2266 (`(apply .
,fun-args
)
2267 (let ((currbuff (current-buffer)))
2268 (if (integerp (car fun-args
))
2269 ;; Long format: (apply DELTA START END FUN . ARGS).
2270 (pcase-let* ((`(,delta
,start
,end
,fun .
,args
) fun-args
)
2271 (start-mark (copy-marker start nil
))
2272 (end-mark (copy-marker end t
)))
2273 (when (or (> (point-min) start
) (< (point-max) end
))
2274 (error "Changes to be undone are outside visible portion of buffer"))
2275 (apply fun args
) ;; Use `save-current-buffer'?
2276 ;; Check that the function did what the entry
2277 ;; said it would do.
2278 (unless (and (= start start-mark
)
2279 (= (+ delta end
) end-mark
))
2280 (error "Changes to be undone by function different than announced"))
2281 (set-marker start-mark nil
)
2282 (set-marker end-mark nil
))
2284 (unless (eq currbuff
(current-buffer))
2285 (error "Undo function switched buffer"))
2286 (setq did-apply t
)))
2287 ;; Element (STRING . POS) means STRING was deleted.
2288 (`(,(and string
(pred stringp
)) .
,(and pos
(pred integerp
)))
2289 (when (let ((apos (abs pos
)))
2290 (or (< apos
(point-min)) (> apos
(point-max))))
2291 (error "Changes to be undone are outside visible portion of buffer"))
2297 ;; Now that we record marker adjustments
2298 ;; (caused by deletion) for undo,
2299 ;; we should always insert after markers,
2300 ;; so that undoing the marker adjustments
2301 ;; put the markers back in the right place.
2304 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2305 (`(,(and marker
(pred markerp
)) .
,(and offset
(pred integerp
)))
2306 (when (marker-buffer marker
)
2309 (marker-buffer marker
))))
2310 (_ (error "Unrecognized entry in undo list %S" next
))))
2311 (setq arg
(1- arg
)))
2312 ;; Make sure an apply entry produces at least one undo entry,
2313 ;; so the test in `undo' for continuing an undo series
2316 (eq oldlist buffer-undo-list
))
2317 (setq buffer-undo-list
2318 (cons (list 'apply
'cdr nil
) buffer-undo-list
))))
2321 ;; Deep copy of a list
2322 (defun undo-copy-list (list)
2323 "Make a copy of undo list LIST."
2324 (mapcar 'undo-copy-list-1 list
))
2326 (defun undo-copy-list-1 (elt)
2328 (cons (car elt
) (undo-copy-list-1 (cdr elt
)))
2331 (defun undo-start (&optional beg end
)
2332 "Set `pending-undo-list' to the front of the undo list.
2333 The next call to `undo-more' will undo the most recently made change.
2334 If BEG and END are specified, then only undo elements
2335 that apply to text between BEG and END are used; other undo elements
2336 are ignored. If BEG and END are nil, all undo elements are used."
2337 (if (eq buffer-undo-list t
)
2338 (user-error "No undo information in this buffer"))
2339 (setq pending-undo-list
2340 (if (and beg end
(not (= beg end
)))
2341 (undo-make-selective-list (min beg end
) (max beg end
))
2344 (defvar undo-adjusted-markers
)
2346 (defun undo-make-selective-list (start end
)
2347 "Return a list of undo elements for the region START to END.
2348 The elements come from `buffer-undo-list', but we keep only
2349 the elements inside this region, and discard those outside this region.
2350 If we find an element that crosses an edge of this region,
2351 we stop and ignore all further elements."
2352 (let ((undo-list-copy (undo-copy-list buffer-undo-list
))
2353 (undo-list (list nil
))
2354 undo-adjusted-markers
2356 undo-elt temp-undo-list delta
)
2357 (while undo-list-copy
2358 (setq undo-elt
(car undo-list-copy
))
2360 (cond ((and (consp undo-elt
) (eq (car undo-elt
) t
))
2361 ;; This is a "was unmodified" element.
2362 ;; Keep it if we have kept everything thus far.
2363 (not some-rejected
))
2365 (undo-elt-in-region undo-elt start end
)))))
2368 (setq end
(+ end
(cdr (undo-delta undo-elt
))))
2369 ;; Don't put two nils together in the list
2370 (if (not (and (eq (car undo-list
) nil
)
2372 (setq undo-list
(cons undo-elt undo-list
))))
2373 (if (undo-elt-crosses-region undo-elt start end
)
2374 (setq undo-list-copy nil
)
2375 (setq some-rejected t
)
2376 (setq temp-undo-list
(cdr undo-list-copy
))
2377 (setq delta
(undo-delta undo-elt
))
2379 (when (/= (cdr delta
) 0)
2380 (let ((position (car delta
))
2381 (offset (cdr delta
)))
2383 ;; Loop down the earlier events adjusting their buffer
2384 ;; positions to reflect the fact that a change to the buffer
2385 ;; isn't being undone. We only need to process those element
2386 ;; types which undo-elt-in-region will return as being in
2387 ;; the region since only those types can ever get into the
2390 (while temp-undo-list
2391 (setq undo-elt
(car temp-undo-list
))
2392 (cond ((integerp undo-elt
)
2393 (if (>= undo-elt position
)
2394 (setcar temp-undo-list
(- undo-elt offset
))))
2395 ((atom undo-elt
) nil
)
2396 ((stringp (car undo-elt
))
2397 ;; (TEXT . POSITION)
2398 (let ((text-pos (abs (cdr undo-elt
)))
2399 (point-at-end (< (cdr undo-elt
) 0 )))
2400 (if (>= text-pos position
)
2401 (setcdr undo-elt
(* (if point-at-end -
1 1)
2402 (- text-pos offset
))))))
2403 ((integerp (car undo-elt
))
2405 (when (>= (car undo-elt
) position
)
2406 (setcar undo-elt
(- (car undo-elt
) offset
))
2407 (setcdr undo-elt
(- (cdr undo-elt
) offset
))))
2408 ((null (car undo-elt
))
2409 ;; (nil PROPERTY VALUE BEG . END)
2410 (let ((tail (nthcdr 3 undo-elt
)))
2411 (when (>= (car tail
) position
)
2412 (setcar tail
(- (car tail
) offset
))
2413 (setcdr tail
(- (cdr tail
) offset
))))))
2414 (setq temp-undo-list
(cdr temp-undo-list
))))))))
2415 (setq undo-list-copy
(cdr undo-list-copy
)))
2416 (nreverse undo-list
)))
2418 (defun undo-elt-in-region (undo-elt start end
)
2419 "Determine whether UNDO-ELT falls inside the region START ... END.
2420 If it crosses the edge, we return nil."
2421 (cond ((integerp undo-elt
)
2422 (and (>= undo-elt start
)
2428 ((stringp (car undo-elt
))
2429 ;; (TEXT . POSITION)
2430 (and (>= (abs (cdr undo-elt
)) start
)
2431 (<= (abs (cdr undo-elt
)) end
)))
2432 ((and (consp undo-elt
) (markerp (car undo-elt
)))
2433 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2434 ;; See if MARKER is inside the region.
2435 (let ((alist-elt (assq (car undo-elt
) undo-adjusted-markers
)))
2437 (setq alist-elt
(cons (car undo-elt
)
2438 (marker-position (car undo-elt
))))
2439 (setq undo-adjusted-markers
2440 (cons alist-elt undo-adjusted-markers
)))
2441 (and (cdr alist-elt
)
2442 (>= (cdr alist-elt
) start
)
2443 (<= (cdr alist-elt
) end
))))
2444 ((null (car undo-elt
))
2445 ;; (nil PROPERTY VALUE BEG . END)
2446 (let ((tail (nthcdr 3 undo-elt
)))
2447 (and (>= (car tail
) start
)
2448 (<= (cdr tail
) end
))))
2449 ((integerp (car undo-elt
))
2451 (and (>= (car undo-elt
) start
)
2452 (<= (cdr undo-elt
) end
)))))
2454 (defun undo-elt-crosses-region (undo-elt start end
)
2455 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2456 This assumes we have already decided that UNDO-ELT
2457 is not *inside* the region START...END."
2458 (cond ((atom undo-elt
) nil
)
2459 ((null (car undo-elt
))
2460 ;; (nil PROPERTY VALUE BEG . END)
2461 (let ((tail (nthcdr 3 undo-elt
)))
2462 (and (< (car tail
) end
)
2463 (> (cdr tail
) start
))))
2464 ((integerp (car undo-elt
))
2466 (and (< (car undo-elt
) end
)
2467 (> (cdr undo-elt
) start
)))))
2469 ;; Return the first affected buffer position and the delta for an undo element
2470 ;; delta is defined as the change in subsequent buffer positions if we *did*
2472 (defun undo-delta (undo-elt)
2473 (if (consp undo-elt
)
2474 (cond ((stringp (car undo-elt
))
2475 ;; (TEXT . POSITION)
2476 (cons (abs (cdr undo-elt
)) (length (car undo-elt
))))
2477 ((integerp (car undo-elt
))
2479 (cons (car undo-elt
) (- (car undo-elt
) (cdr undo-elt
))))
2484 (defcustom undo-ask-before-discard nil
2485 "If non-nil ask about discarding undo info for the current command.
2486 Normally, Emacs discards the undo info for the current command if
2487 it exceeds `undo-outer-limit'. But if you set this option
2488 non-nil, it asks in the echo area whether to discard the info.
2489 If you answer no, there is a slight risk that Emacs might crash, so
2490 only do it if you really want to undo the command.
2492 This option is mainly intended for debugging. You have to be
2493 careful if you use it for other purposes. Garbage collection is
2494 inhibited while the question is asked, meaning that Emacs might
2495 leak memory. So you should make sure that you do not wait
2496 excessively long before answering the question."
2501 (defvar undo-extra-outer-limit nil
2502 "If non-nil, an extra level of size that's ok in an undo item.
2503 We don't ask the user about truncating the undo list until the
2504 current item gets bigger than this amount.
2506 This variable only matters if `undo-ask-before-discard' is non-nil.")
2507 (make-variable-buffer-local 'undo-extra-outer-limit
)
2509 ;; When the first undo batch in an undo list is longer than
2510 ;; undo-outer-limit, this function gets called to warn the user that
2511 ;; the undo info for the current command was discarded. Garbage
2512 ;; collection is inhibited around the call, so it had better not do a
2514 (setq undo-outer-limit-function
'undo-outer-limit-truncate
)
2515 (defun undo-outer-limit-truncate (size)
2516 (if undo-ask-before-discard
2517 (when (or (null undo-extra-outer-limit
)
2518 (> size undo-extra-outer-limit
))
2519 ;; Don't ask the question again unless it gets even bigger.
2520 ;; This applies, in particular, if the user quits from the question.
2521 ;; Such a quit quits out of GC, but something else will call GC
2522 ;; again momentarily. It will call this function again,
2523 ;; but we don't want to ask the question again.
2524 (setq undo-extra-outer-limit
(+ size
50000))
2525 (if (let (use-dialog-box track-mouse executing-kbd-macro
)
2526 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
2527 (buffer-name) size
)))
2528 (progn (setq buffer-undo-list nil
)
2529 (setq undo-extra-outer-limit nil
)
2532 (display-warning '(undo discard-info
)
2534 (format "Buffer `%s' undo info was %d bytes long.\n"
2536 "The undo info was discarded because it exceeded \
2539 This is normal if you executed a command that made a huge change
2540 to the buffer. In that case, to prevent similar problems in the
2541 future, set `undo-outer-limit' to a value that is large enough to
2542 cover the maximum size of normal changes you expect a single
2543 command to make, but not so large that it might exceed the
2544 maximum memory allotted to Emacs.
2546 If you did not execute any such command, the situation is
2547 probably due to a bug and you should report it.
2549 You can disable the popping up of this buffer by adding the entry
2550 \(undo discard-info) to the user option `warning-suppress-types',
2551 which is defined in the `warnings' library.\n")
2553 (setq buffer-undo-list nil
)
2556 (defcustom password-word-equivalents
2557 '("password" "passphrase" "pass phrase"
2558 ; These are sorted according to the GNU en_US locale.
2561 "ପ୍ରବେଶ ସଙ୍କେତ" ; or
2587 "пароль" ; kk, ru, uk
2602 "List of words equivalent to \"password\".
2603 This is used by Shell mode and other parts of Emacs to recognize
2604 password prompts, including prompts in languages other than
2605 English. Different case choices should not be assumed to be
2606 included; callers should bind `case-fold-search' to t."
2607 :type
'(repeat string
)
2611 (defvar shell-command-history nil
2612 "History list for some commands that read shell commands.
2614 Maximum length of the history list is determined by the value
2615 of `history-length', which see.")
2617 (defvar shell-command-switch
(purecopy "-c")
2618 "Switch used to have the shell execute its command line argument.")
2620 (defvar shell-command-default-error-buffer nil
2621 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2622 This buffer is used when `shell-command' or `shell-command-on-region'
2623 is run interactively. A value of nil means that output to stderr and
2624 stdout will be intermixed in the output stream.")
2626 (declare-function mailcap-file-default-commands
"mailcap" (files))
2627 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
2629 (defun minibuffer-default-add-shell-commands ()
2630 "Return a list of all commands associated with the current file.
2631 This function is used to add all related commands retrieved by `mailcap'
2632 to the end of the list of defaults just after the default value."
2634 (let* ((filename (if (listp minibuffer-default
)
2635 (car minibuffer-default
)
2636 minibuffer-default
))
2637 (commands (and filename
(require 'mailcap nil t
)
2638 (mailcap-file-default-commands (list filename
)))))
2639 (setq commands
(mapcar (lambda (command)
2640 (concat command
" " filename
))
2642 (if (listp minibuffer-default
)
2643 (append minibuffer-default commands
)
2644 (cons minibuffer-default commands
))))
2646 (declare-function shell-completion-vars
"shell" ())
2648 (defvar minibuffer-local-shell-command-map
2649 (let ((map (make-sparse-keymap)))
2650 (set-keymap-parent map minibuffer-local-map
)
2651 (define-key map
"\t" 'completion-at-point
)
2653 "Keymap used for completing shell commands in minibuffer.")
2655 (defun read-shell-command (prompt &optional initial-contents hist
&rest args
)
2656 "Read a shell command from the minibuffer.
2657 The arguments are the same as the ones of `read-from-minibuffer',
2658 except READ and KEYMAP are missing and HIST defaults
2659 to `shell-command-history'."
2661 (minibuffer-with-setup-hook
2663 (shell-completion-vars)
2664 (set (make-local-variable 'minibuffer-default-add-function
)
2665 'minibuffer-default-add-shell-commands
))
2666 (apply 'read-from-minibuffer prompt initial-contents
2667 minibuffer-local-shell-command-map
2669 (or hist
'shell-command-history
)
2672 (defcustom async-shell-command-buffer
'confirm-new-buffer
2673 "What to do when the output buffer is used by another shell command.
2674 This option specifies how to resolve the conflict where a new command
2675 wants to direct its output to the buffer `*Async Shell Command*',
2676 but this buffer is already taken by another running shell command.
2678 The value `confirm-kill-process' is used to ask for confirmation before
2679 killing the already running process and running a new process
2680 in the same buffer, `confirm-new-buffer' for confirmation before running
2681 the command in a new buffer with a name other than the default buffer name,
2682 `new-buffer' for doing the same without confirmation,
2683 `confirm-rename-buffer' for confirmation before renaming the existing
2684 output buffer and running a new command in the default buffer,
2685 `rename-buffer' for doing the same without confirmation."
2686 :type
'(choice (const :tag
"Confirm killing of running command"
2687 confirm-kill-process
)
2688 (const :tag
"Confirm creation of a new buffer"
2690 (const :tag
"Create a new buffer"
2692 (const :tag
"Confirm renaming of existing buffer"
2693 confirm-rename-buffer
)
2694 (const :tag
"Rename the existing buffer"
2699 (defun async-shell-command (command &optional output-buffer error-buffer
)
2700 "Execute string COMMAND asynchronously in background.
2702 Like `shell-command', but adds `&' at the end of COMMAND
2703 to execute it asynchronously.
2705 The output appears in the buffer `*Async Shell Command*'.
2706 That buffer is in shell mode.
2708 You can configure `async-shell-command-buffer' to specify what to do in
2709 case when `*Async Shell Command*' buffer is already taken by another
2710 running shell command. To run COMMAND without displaying the output
2711 in a window you can configure `display-buffer-alist' to use the action
2712 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2714 In Elisp, you will often be better served by calling `start-process'
2715 directly, since it offers more control and does not impose the use of a
2716 shell (with its need to quote arguments)."
2719 (read-shell-command "Async shell command: " nil nil
2723 ((eq major-mode
'dired-mode
)
2724 (dired-get-filename nil t
)))))
2725 (and filename
(file-relative-name filename
))))
2727 shell-command-default-error-buffer
))
2728 (unless (string-match "&[ \t]*\\'" command
)
2729 (setq command
(concat command
" &")))
2730 (shell-command command output-buffer error-buffer
))
2732 (defun shell-command (command &optional output-buffer error-buffer
)
2733 "Execute string COMMAND in inferior shell; display output, if any.
2734 With prefix argument, insert the COMMAND's output at point.
2736 If COMMAND ends in `&', execute it asynchronously.
2737 The output appears in the buffer `*Async Shell Command*'.
2738 That buffer is in shell mode. You can also use
2739 `async-shell-command' that automatically adds `&'.
2741 Otherwise, COMMAND is executed synchronously. The output appears in
2742 the buffer `*Shell Command Output*'. If the output is short enough to
2743 display in the echo area (which is determined by the variables
2744 `resize-mini-windows' and `max-mini-window-height'), it is shown
2745 there, but it is nonetheless available in buffer `*Shell Command
2746 Output*' even though that buffer is not automatically displayed.
2748 To specify a coding system for converting non-ASCII characters
2749 in the shell command output, use \\[universal-coding-system-argument] \
2750 before this command.
2752 Noninteractive callers can specify coding systems by binding
2753 `coding-system-for-read' and `coding-system-for-write'.
2755 The optional second argument OUTPUT-BUFFER, if non-nil,
2756 says to put the output in some other buffer.
2757 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2758 If OUTPUT-BUFFER is not a buffer and not nil,
2759 insert output in current buffer. (This cannot be done asynchronously.)
2760 In either case, the buffer is first erased, and the output is
2761 inserted after point (leaving mark after it).
2763 If the command terminates without error, but generates output,
2764 and you did not specify \"insert it in the current buffer\",
2765 the output can be displayed in the echo area or in its buffer.
2766 If the output is short enough to display in the echo area
2767 \(determined by the variable `max-mini-window-height' if
2768 `resize-mini-windows' is non-nil), it is shown there.
2769 Otherwise,the buffer containing the output is displayed.
2771 If there is output and an error, and you did not specify \"insert it
2772 in the current buffer\", a message about the error goes at the end
2775 If there is no output, or if output is inserted in the current buffer,
2776 then `*Shell Command Output*' is deleted.
2778 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2779 or buffer name to which to direct the command's standard error output.
2780 If it is nil, error output is mingled with regular output.
2781 In an interactive call, the variable `shell-command-default-error-buffer'
2782 specifies the value of ERROR-BUFFER.
2784 In Elisp, you will often be better served by calling `call-process' or
2785 `start-process' directly, since it offers more control and does not impose
2786 the use of a shell (with its need to quote arguments)."
2790 (read-shell-command "Shell command: " nil nil
2794 ((eq major-mode
'dired-mode
)
2795 (dired-get-filename nil t
)))))
2796 (and filename
(file-relative-name filename
))))
2798 shell-command-default-error-buffer
))
2799 ;; Look for a handler in case default-directory is a remote file name.
2801 (find-file-name-handler (directory-file-name default-directory
)
2804 (funcall handler
'shell-command command output-buffer error-buffer
)
2805 (if (and output-buffer
2806 (not (or (bufferp output-buffer
) (stringp output-buffer
))))
2807 ;; Output goes in current buffer.
2811 (expand-file-name "scor"
2812 (or small-temporary-file-directory
2813 temporary-file-directory
)))
2815 (barf-if-buffer-read-only)
2817 ;; We do not use -f for csh; we will not support broken use of
2818 ;; .cshrcs. Even the BSD csh manual says to use
2819 ;; "if ($?prompt) exit" before things which are not useful
2820 ;; non-interactively. Besides, if someone wants their other
2821 ;; aliases for shell commands then they can still have them.
2822 (call-process shell-file-name nil
2826 nil shell-command-switch command
)
2827 (when (and error-file
(file-exists-p error-file
))
2828 (if (< 0 (nth 7 (file-attributes error-file
)))
2829 (with-current-buffer (get-buffer-create error-buffer
)
2830 (let ((pos-from-end (- (point-max) (point))))
2833 ;; Do no formatting while reading error file,
2834 ;; because that can run a shell command, and we
2835 ;; don't want that to cause an infinite recursion.
2836 (format-insert-file error-file nil
)
2837 ;; Put point after the inserted errors.
2838 (goto-char (- (point-max) pos-from-end
)))
2839 (display-buffer (current-buffer))))
2840 (delete-file error-file
))
2841 ;; This is like exchange-point-and-mark, but doesn't
2842 ;; activate the mark. It is cleaner to avoid activation,
2843 ;; even though the command loop would deactivate the mark
2844 ;; because we inserted text.
2845 (goto-char (prog1 (mark t
)
2846 (set-marker (mark-marker) (point)
2847 (current-buffer)))))
2848 ;; Output goes in a separate buffer.
2849 ;; Preserve the match data in case called from a program.
2851 (if (string-match "[ \t]*&[ \t]*\\'" command
)
2852 ;; Command ending with ampersand means asynchronous.
2853 (let ((buffer (get-buffer-create
2854 (or output-buffer
"*Async Shell Command*")))
2855 (directory default-directory
)
2857 ;; Remove the ampersand.
2858 (setq command
(substring command
0 (match-beginning 0)))
2859 ;; Ask the user what to do with already running process.
2860 (setq proc
(get-buffer-process buffer
))
2863 ((eq async-shell-command-buffer
'confirm-kill-process
)
2864 ;; If will kill a process, query first.
2865 (if (yes-or-no-p "A command is running in the default buffer. Kill it? ")
2867 (error "Shell command in progress")))
2868 ((eq async-shell-command-buffer
'confirm-new-buffer
)
2869 ;; If will create a new buffer, query first.
2870 (if (yes-or-no-p "A command is running in the default buffer. Use a new buffer? ")
2871 (setq buffer
(generate-new-buffer
2872 (or output-buffer
"*Async Shell Command*")))
2873 (error "Shell command in progress")))
2874 ((eq async-shell-command-buffer
'new-buffer
)
2875 ;; It will create a new buffer.
2876 (setq buffer
(generate-new-buffer
2877 (or output-buffer
"*Async Shell Command*"))))
2878 ((eq async-shell-command-buffer
'confirm-rename-buffer
)
2879 ;; If will rename the buffer, query first.
2880 (if (yes-or-no-p "A command is running in the default buffer. Rename it? ")
2882 (with-current-buffer buffer
2884 (setq buffer
(get-buffer-create
2885 (or output-buffer
"*Async Shell Command*"))))
2886 (error "Shell command in progress")))
2887 ((eq async-shell-command-buffer
'rename-buffer
)
2888 ;; It will rename the buffer.
2889 (with-current-buffer buffer
2891 (setq buffer
(get-buffer-create
2892 (or output-buffer
"*Async Shell Command*"))))))
2893 (with-current-buffer buffer
2894 (setq buffer-read-only nil
)
2895 ;; Setting buffer-read-only to nil doesn't suffice
2896 ;; if some text has a non-nil read-only property,
2897 ;; which comint sometimes adds for prompts.
2898 (let ((inhibit-read-only t
))
2900 (display-buffer buffer
'(nil (allow-no-window . t
)))
2901 (setq default-directory directory
)
2902 (setq proc
(start-process "Shell" buffer shell-file-name
2903 shell-command-switch command
))
2904 (setq mode-line-process
'(":%s"))
2905 (require 'shell
) (shell-mode)
2906 (set-process-sentinel proc
'shell-command-sentinel
)
2907 ;; Use the comint filter for proper handling of carriage motion
2908 ;; (see `comint-inhibit-carriage-motion'),.
2909 (set-process-filter proc
'comint-output-filter
)
2911 ;; Otherwise, command is executed synchronously.
2912 (shell-command-on-region (point) (point) command
2913 output-buffer nil error-buffer
)))))))
2915 (defun display-message-or-buffer (message
2916 &optional buffer-name not-this-window frame
)
2917 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2918 MESSAGE may be either a string or a buffer.
2920 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2921 the maximum height of the echo area, as defined by `max-mini-window-height'
2922 if `resize-mini-windows' is non-nil.
2924 Returns either the string shown in the echo area, or when a pop-up
2925 buffer is used, the window used to display it.
2927 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2928 name of the buffer used to display it in the case where a pop-up buffer
2929 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2930 string and it is displayed in the echo area, it is not specified whether
2931 the contents are inserted into the buffer anyway.
2933 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2934 and only used if a buffer is displayed."
2935 (cond ((and (stringp message
) (not (string-match "\n" message
)))
2936 ;; Trivial case where we can use the echo area
2937 (message "%s" message
))
2938 ((and (stringp message
)
2939 (= (string-match "\n" message
) (1- (length message
))))
2940 ;; Trivial case where we can just remove single trailing newline
2941 (message "%s" (substring message
0 (1- (length message
)))))
2944 (with-current-buffer
2945 (if (bufferp message
)
2947 (get-buffer-create (or buffer-name
"*Message*")))
2949 (unless (bufferp message
)
2954 (if (= (buffer-size) 0)
2956 (count-screen-lines nil nil nil
(minibuffer-window)))))
2958 ((and (or (<= lines
1)
2960 (if resize-mini-windows
2961 (cond ((floatp max-mini-window-height
)
2963 max-mini-window-height
))
2964 ((integerp max-mini-window-height
)
2965 max-mini-window-height
)
2969 ;; Don't use the echo area if the output buffer is
2970 ;; already displayed in the selected frame.
2971 (not (get-buffer-window (current-buffer))))
2973 (goto-char (point-max))
2976 (message "%s" (buffer-substring (point-min) (point))))
2979 (goto-char (point-min))
2980 (display-buffer (current-buffer)
2981 not-this-window frame
))))))))
2984 ;; We have a sentinel to prevent insertion of a termination message
2985 ;; in the buffer itself.
2986 (defun shell-command-sentinel (process signal
)
2987 (if (memq (process-status process
) '(exit signal
))
2989 (car (cdr (cdr (process-command process
))))
2990 (substring signal
0 -
1))))
2992 (defun shell-command-on-region (start end command
2993 &optional output-buffer replace
2994 error-buffer display-error-buffer
)
2995 "Execute string COMMAND in inferior shell with region as input.
2996 Normally display output (if any) in temp buffer `*Shell Command Output*';
2997 Prefix arg means replace the region with it. Return the exit code of
3000 To specify a coding system for converting non-ASCII characters
3001 in the input and output to the shell command, use \\[universal-coding-system-argument]
3002 before this command. By default, the input (from the current buffer)
3003 is encoded using coding-system specified by `process-coding-system-alist',
3004 falling back to `default-process-coding-system' if no match for COMMAND
3005 is found in `process-coding-system-alist'.
3007 Noninteractive callers can specify coding systems by binding
3008 `coding-system-for-read' and `coding-system-for-write'.
3010 If the command generates output, the output may be displayed
3011 in the echo area or in a buffer.
3012 If the output is short enough to display in the echo area
3013 \(determined by the variable `max-mini-window-height' if
3014 `resize-mini-windows' is non-nil), it is shown there.
3015 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3016 The output is available in that buffer in both cases.
3018 If there is output and an error, a message about the error
3019 appears at the end of the output. If there is no output, or if
3020 output is inserted in the current buffer, the buffer `*Shell
3021 Command Output*' is deleted.
3023 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3024 command's output. If the value is a buffer or buffer name,
3025 put the output there. If the value is nil, use the buffer
3026 `*Shell Command Output*'. Any other value, excluding nil,
3027 means to insert the output in the current buffer. In either case,
3028 the output is inserted after point (leaving mark after it).
3030 Optional fifth arg REPLACE, if non-nil, means to insert the
3031 output in place of text from START to END, putting point and mark
3034 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3035 or buffer name to which to direct the command's standard error
3036 output. If nil, error output is mingled with regular output.
3037 When called interactively, `shell-command-default-error-buffer'
3038 is used for ERROR-BUFFER.
3040 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3041 display the error buffer if there were any errors. When called
3042 interactively, this is t."
3043 (interactive (let (string)
3045 (error "The mark is not set now, so there is no region"))
3046 ;; Do this before calling region-beginning
3047 ;; and region-end, in case subprocess output
3048 ;; relocates them while we are in the minibuffer.
3049 (setq string
(read-shell-command "Shell command on region: "))
3050 ;; call-interactively recognizes region-beginning and
3051 ;; region-end specially, leaving them in the history.
3052 (list (region-beginning) (region-end)
3056 shell-command-default-error-buffer
3061 (expand-file-name "scor"
3062 (or small-temporary-file-directory
3063 temporary-file-directory
)))
3068 (not (or (bufferp output-buffer
) (stringp output-buffer
)))))
3069 ;; Replace specified region with output from command.
3070 (let ((swap (and replace
(< start end
))))
3071 ;; Don't muck with mark unless REPLACE says we should.
3073 (and replace
(push-mark (point) 'nomsg
))
3075 (call-process-region start end shell-file-name replace
3079 nil shell-command-switch command
))
3080 ;; It is rude to delete a buffer which the command is not using.
3081 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3082 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3083 ;; (kill-buffer shell-buffer)))
3084 ;; Don't muck with mark unless REPLACE says we should.
3085 (and replace swap
(exchange-point-and-mark)))
3086 ;; No prefix argument: put the output in a temp buffer,
3087 ;; replacing its entire contents.
3088 (let ((buffer (get-buffer-create
3089 (or output-buffer
"*Shell Command Output*"))))
3091 (if (eq buffer
(current-buffer))
3092 ;; If the input is the same buffer as the output,
3093 ;; delete everything but the specified region,
3094 ;; then replace that region with the output.
3095 (progn (setq buffer-read-only nil
)
3096 (delete-region (max start end
) (point-max))
3097 (delete-region (point-min) (min start end
))
3099 (call-process-region (point-min) (point-max)
3104 nil shell-command-switch
3106 ;; Clear the output buffer, then run the command with
3108 (let ((directory default-directory
))
3109 (with-current-buffer buffer
3110 (setq buffer-read-only nil
)
3111 (if (not output-buffer
)
3112 (setq default-directory directory
))
3115 (call-process-region start end shell-file-name nil
3117 (list buffer error-file
)
3119 nil shell-command-switch command
)))
3120 ;; Report the output.
3121 (with-current-buffer buffer
3122 (setq mode-line-process
3123 (cond ((null exit-status
)
3125 ((stringp exit-status
)
3126 (format " - Signal [%s]" exit-status
))
3127 ((not (equal 0 exit-status
))
3128 (format " - Exit [%d]" exit-status
)))))
3129 (if (with-current-buffer buffer
(> (point-max) (point-min)))
3130 ;; There's some output, display it
3131 (display-message-or-buffer buffer
)
3132 ;; No output; error?
3135 (< 0 (nth 7 (file-attributes error-file
))))
3136 (format "some error output%s"
3137 (if shell-command-default-error-buffer
3138 (format " to the \"%s\" buffer"
3139 shell-command-default-error-buffer
)
3142 (cond ((null exit-status
)
3143 (message "(Shell command failed with error)"))
3144 ((equal 0 exit-status
)
3145 (message "(Shell command succeeded with %s)"
3147 ((stringp exit-status
)
3148 (message "(Shell command killed by signal %s)"
3151 (message "(Shell command failed with code %d and %s)"
3152 exit-status output
))))
3153 ;; Don't kill: there might be useful info in the undo-log.
3154 ;; (kill-buffer buffer)
3157 (when (and error-file
(file-exists-p error-file
))
3158 (if (< 0 (nth 7 (file-attributes error-file
)))
3159 (with-current-buffer (get-buffer-create error-buffer
)
3160 (let ((pos-from-end (- (point-max) (point))))
3163 ;; Do no formatting while reading error file,
3164 ;; because that can run a shell command, and we
3165 ;; don't want that to cause an infinite recursion.
3166 (format-insert-file error-file nil
)
3167 ;; Put point after the inserted errors.
3168 (goto-char (- (point-max) pos-from-end
)))
3169 (and display-error-buffer
3170 (display-buffer (current-buffer)))))
3171 (delete-file error-file
))
3174 (defun shell-command-to-string (command)
3175 "Execute shell command COMMAND and return its output as a string."
3176 (with-output-to-string
3177 (with-current-buffer
3179 (process-file shell-file-name nil t nil shell-command-switch command
))))
3181 (defun process-file (program &optional infile buffer display
&rest args
)
3182 "Process files synchronously in a separate process.
3183 Similar to `call-process', but may invoke a file handler based on
3184 `default-directory'. The current working directory of the
3185 subprocess is `default-directory'.
3187 File names in INFILE and BUFFER are handled normally, but file
3188 names in ARGS should be relative to `default-directory', as they
3189 are passed to the process verbatim. (This is a difference to
3190 `call-process' which does not support file handlers for INFILE
3193 Some file handlers might not support all variants, for example
3194 they might behave as if DISPLAY was nil, regardless of the actual
3196 (let ((fh (find-file-name-handler default-directory
'process-file
))
3199 (if fh
(apply fh
'process-file program infile buffer display args
)
3200 (when infile
(setq lc
(file-local-copy infile
)))
3201 (setq stderr-file
(when (and (consp buffer
) (stringp (cadr buffer
)))
3202 (make-temp-file "emacs")))
3204 (apply 'call-process program
3206 (if stderr-file
(list (car buffer
) stderr-file
) buffer
)
3208 (when stderr-file
(copy-file stderr-file
(cadr buffer
) t
))))
3209 (when stderr-file
(delete-file stderr-file
))
3210 (when lc
(delete-file lc
)))))
3212 (defvar process-file-side-effects t
3213 "Whether a call of `process-file' changes remote files.
3215 By default, this variable is always set to `t', meaning that a
3216 call of `process-file' could potentially change any file on a
3217 remote host. When set to `nil', a file handler could optimize
3218 its behavior with respect to remote file attribute caching.
3220 You should only ever change this variable with a let-binding;
3221 never with `setq'.")
3223 (defun start-file-process (name buffer program
&rest program-args
)
3224 "Start a program in a subprocess. Return the process object for it.
3226 Similar to `start-process', but may invoke a file handler based on
3227 `default-directory'. See Info node `(elisp)Magic File Names'.
3229 This handler ought to run PROGRAM, perhaps on the local host,
3230 perhaps on a remote host that corresponds to `default-directory'.
3231 In the latter case, the local part of `default-directory' becomes
3232 the working directory of the process.
3234 PROGRAM and PROGRAM-ARGS might be file names. They are not
3235 objects of file handler invocation. File handlers might not
3236 support pty association, if PROGRAM is nil."
3237 (let ((fh (find-file-name-handler default-directory
'start-file-process
)))
3238 (if fh
(apply fh
'start-file-process name buffer program program-args
)
3239 (apply 'start-process name buffer program program-args
))))
3243 (defvar tabulated-list-format
)
3244 (defvar tabulated-list-entries
)
3245 (defvar tabulated-list-sort-key
)
3246 (declare-function tabulated-list-init-header
"tabulated-list" ())
3247 (declare-function tabulated-list-print
"tabulated-list"
3248 (&optional remember-pos
))
3250 (defvar process-menu-query-only nil
)
3252 (define-derived-mode process-menu-mode tabulated-list-mode
"Process Menu"
3253 "Major mode for listing the processes called by Emacs."
3254 (setq tabulated-list-format
[("Process" 15 t
)
3259 (make-local-variable 'process-menu-query-only
)
3260 (setq tabulated-list-sort-key
(cons "Process" nil
))
3261 (add-hook 'tabulated-list-revert-hook
'list-processes--refresh nil t
)
3262 (tabulated-list-init-header))
3264 (defun list-processes--refresh ()
3265 "Recompute the list of processes for the Process List buffer.
3266 Also, delete any process that is exited or signaled."
3267 (setq tabulated-list-entries nil
)
3268 (dolist (p (process-list))
3269 (cond ((memq (process-status p
) '(exit signal closed
))
3271 ((or (not process-menu-query-only
)
3272 (process-query-on-exit-flag p
))
3273 (let* ((buf (process-buffer p
))
3274 (type (process-type p
))
3275 (name (process-name p
))
3276 (status (symbol-name (process-status p
)))
3277 (buf-label (if (buffer-live-p buf
)
3278 `(,(buffer-name buf
)
3280 help-echo
,(concat "Visit buffer `"
3281 (buffer-name buf
) "'")
3284 action process-menu-visit-buffer
)
3286 (tty (or (process-tty-name p
) "--"))
3288 (if (memq type
'(network serial
))
3289 (let ((contact (process-contact p t
)))
3290 (if (eq type
'network
)
3292 (if (plist-get contact
:type
)
3295 (if (plist-get contact
:server
)
3296 (format "server on %s"
3298 (plist-get contact
:host
)
3299 (plist-get contact
:local
)))
3300 (format "connection to %s"
3301 (plist-get contact
:host
))))
3302 (format "(serial port %s%s)"
3303 (or (plist-get contact
:port
) "?")
3304 (let ((speed (plist-get contact
:speed
)))
3306 (format " at %s b/s" speed
)
3308 (mapconcat 'identity
(process-command p
) " "))))
3309 (push (list p
(vector name status buf-label tty cmd
))
3310 tabulated-list-entries
))))))
3312 (defun process-menu-visit-buffer (button)
3313 (display-buffer (button-get button
'process-buffer
)))
3315 (defun list-processes (&optional query-only buffer
)
3316 "Display a list of all processes that are Emacs sub-processes.
3317 If optional argument QUERY-ONLY is non-nil, only processes with
3318 the query-on-exit flag set are listed.
3319 Any process listed as exited or signaled is actually eliminated
3320 after the listing is made.
3321 Optional argument BUFFER specifies a buffer to use, instead of
3323 The return value is always nil.
3325 This function lists only processes that were launched by Emacs. To
3326 see other processes running on the system, use `list-system-processes'."
3328 (or (fboundp 'process-list
)
3329 (error "Asynchronous subprocesses are not supported on this system"))
3330 (unless (bufferp buffer
)
3331 (setq buffer
(get-buffer-create "*Process List*")))
3332 (with-current-buffer buffer
3334 (setq process-menu-query-only query-only
)
3335 (list-processes--refresh)
3336 (tabulated-list-print))
3337 (display-buffer buffer
)
3340 (defvar universal-argument-map
3341 (let ((map (make-sparse-keymap))
3342 (universal-argument-minus
3343 ;; For backward compatibility, minus with no modifiers is an ordinary
3344 ;; command if digits have already been entered.
3345 `(menu-item "" negative-argument
3346 :filter
,(lambda (cmd)
3347 (if (integerp prefix-arg
) nil cmd
)))))
3348 (define-key map
[switch-frame
]
3349 (lambda (e) (interactive "e")
3350 (handle-switch-frame e
) (universal-argument--mode)))
3351 (define-key map
[?\C-u
] 'universal-argument-more
)
3352 (define-key map
[?-
] universal-argument-minus
)
3353 (define-key map
[?
0] 'digit-argument
)
3354 (define-key map
[?
1] 'digit-argument
)
3355 (define-key map
[?
2] 'digit-argument
)
3356 (define-key map
[?
3] 'digit-argument
)
3357 (define-key map
[?
4] 'digit-argument
)
3358 (define-key map
[?
5] 'digit-argument
)
3359 (define-key map
[?
6] 'digit-argument
)
3360 (define-key map
[?
7] 'digit-argument
)
3361 (define-key map
[?
8] 'digit-argument
)
3362 (define-key map
[?
9] 'digit-argument
)
3363 (define-key map
[kp-0
] 'digit-argument
)
3364 (define-key map
[kp-1
] 'digit-argument
)
3365 (define-key map
[kp-2
] 'digit-argument
)
3366 (define-key map
[kp-3
] 'digit-argument
)
3367 (define-key map
[kp-4
] 'digit-argument
)
3368 (define-key map
[kp-5
] 'digit-argument
)
3369 (define-key map
[kp-6
] 'digit-argument
)
3370 (define-key map
[kp-7
] 'digit-argument
)
3371 (define-key map
[kp-8
] 'digit-argument
)
3372 (define-key map
[kp-9
] 'digit-argument
)
3373 (define-key map
[kp-subtract
] universal-argument-minus
)
3375 "Keymap used while processing \\[universal-argument].")
3377 (defun universal-argument--mode ()
3378 (set-transient-map universal-argument-map
))
3380 (defun universal-argument ()
3381 "Begin a numeric argument for the following command.
3382 Digits or minus sign following \\[universal-argument] make up the numeric argument.
3383 \\[universal-argument] following the digits or minus sign ends the argument.
3384 \\[universal-argument] without digits or minus sign provides 4 as argument.
3385 Repeating \\[universal-argument] without digits or minus sign
3386 multiplies the argument by 4 each time.
3387 For some commands, just \\[universal-argument] by itself serves as a flag
3388 which is different in effect from any particular numeric argument.
3389 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
3391 (setq prefix-arg
(list 4))
3392 (universal-argument--mode))
3394 (defun universal-argument-more (arg)
3395 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3396 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3398 (setq prefix-arg
(if (consp arg
)
3399 (list (* 4 (car arg
)))
3403 (when (consp prefix-arg
) (universal-argument--mode)))
3405 (defun negative-argument (arg)
3406 "Begin a negative numeric argument for the next command.
3407 \\[universal-argument] following digits or minus sign ends the argument."
3409 (setq prefix-arg
(cond ((integerp arg
) (- arg
))
3412 (universal-argument--mode))
3414 (defun digit-argument (arg)
3415 "Part of the numeric argument for the next command.
3416 \\[universal-argument] following digits or minus sign ends the argument."
3418 (let* ((char (if (integerp last-command-event
)
3420 (get last-command-event
'ascii-character
)))
3421 (digit (- (logand char ?
\177) ?
0)))
3422 (setq prefix-arg
(cond ((integerp arg
)
3424 (if (< arg
0) (- digit
) digit
)))
3426 ;; Treat -0 as just -, so that -01 will work.
3427 (if (zerop digit
) '-
(- digit
)))
3430 (universal-argument--mode))
3433 (defvar filter-buffer-substring-functions nil
3434 "This variable is a wrapper hook around `filter-buffer-substring'.")
3435 (make-obsolete-variable 'filter-buffer-substring-functions
3436 'filter-buffer-substring-function
"24.4")
3438 (defvar filter-buffer-substring-function
#'buffer-substring--filter
3439 "Function to perform the filtering in `filter-buffer-substring'.
3440 The function is called with 3 arguments:
3441 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3442 as those of `filter-buffer-substring' in each case.
3443 It should return the buffer substring between BEG and END, after filtering.")
3445 (defvar buffer-substring-filters nil
3446 "List of filter functions for `filter-buffer-substring'.
3447 Each function must accept a single argument, a string, and return
3448 a string. The buffer substring is passed to the first function
3449 in the list, and the return value of each function is passed to
3451 As a special convention, point is set to the start of the buffer text
3452 being operated on (i.e., the first argument of `filter-buffer-substring')
3453 before these functions are called.")
3454 (make-obsolete-variable 'buffer-substring-filters
3455 'filter-buffer-substring-function
"24.1")
3457 (defun filter-buffer-substring (beg end
&optional delete
)
3458 "Return the buffer substring between BEG and END, after filtering.
3459 The hook `filter-buffer-substring-function' performs the actual filtering.
3460 By default, no filtering is done.
3462 If DELETE is non-nil, the text between BEG and END is deleted
3465 This function should be used instead of `buffer-substring',
3466 `buffer-substring-no-properties', or `delete-and-extract-region'
3467 when you want to allow filtering to take place. For example,
3468 major or minor modes can use `filter-buffer-substring-function' to
3469 extract characters that are special to a buffer, and should not
3470 be copied into other buffers."
3471 (funcall filter-buffer-substring-function beg end delete
))
3473 (defun buffer-substring--filter (beg end
&optional delete
)
3474 (with-wrapper-hook filter-buffer-substring-functions
(beg end delete
)
3476 ((or delete buffer-substring-filters
)
3479 (let ((string (if delete
(delete-and-extract-region beg end
)
3480 (buffer-substring beg end
))))
3481 (dolist (filter buffer-substring-filters
)
3482 (setq string
(funcall filter string
)))
3485 (buffer-substring beg end
)))))
3488 ;;;; Window system cut and paste hooks.
3490 (defvar interprogram-cut-function nil
3491 "Function to call to make a killed region available to other programs.
3492 Most window systems provide a facility for cutting and pasting
3493 text between different programs, such as the clipboard on X and
3494 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3496 This variable holds a function that Emacs calls whenever text is
3497 put in the kill ring, to make the new kill available to other
3498 programs. The function takes one argument, TEXT, which is a
3499 string containing the text which should be made available.")
3501 (defvar interprogram-paste-function nil
3502 "Function to call to get text cut from other programs.
3503 Most window systems provide a facility for cutting and pasting
3504 text between different programs, such as the clipboard on X and
3505 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3507 This variable holds a function that Emacs calls to obtain text
3508 that other programs have provided for pasting. The function is
3509 called with no arguments. If no other program has provided text
3510 to paste, the function should return nil (in which case the
3511 caller, usually `current-kill', should use the top of the Emacs
3512 kill ring). If another program has provided text to paste, the
3513 function should return that text as a string (in which case the
3514 caller should put this string in the kill ring as the latest
3517 The function may also return a list of strings if the window
3518 system supports multiple selections. The first string will be
3519 used as the pasted text, but the other will be placed in the kill
3520 ring for easy access via `yank-pop'.
3522 Note that the function should return a string only if a program
3523 other than Emacs has provided a string for pasting; if Emacs
3524 provided the most recent string, the function should return nil.
3525 If it is difficult to tell whether Emacs or some other program
3526 provided the current string, it is probably good enough to return
3527 nil if the string is equal (according to `string=') to the last
3528 text Emacs provided.")
3532 ;;;; The kill ring data structure.
3534 (defvar kill-ring nil
3535 "List of killed text sequences.
3536 Since the kill ring is supposed to interact nicely with cut-and-paste
3537 facilities offered by window systems, use of this variable should
3538 interact nicely with `interprogram-cut-function' and
3539 `interprogram-paste-function'. The functions `kill-new',
3540 `kill-append', and `current-kill' are supposed to implement this
3541 interaction; you may want to use them instead of manipulating the kill
3544 (defcustom kill-ring-max
60
3545 "Maximum length of kill ring before oldest elements are thrown away."
3549 (defvar kill-ring-yank-pointer nil
3550 "The tail of the kill ring whose car is the last thing yanked.")
3552 (defcustom save-interprogram-paste-before-kill nil
3553 "Save clipboard strings into kill ring before replacing them.
3554 When one selects something in another program to paste it into Emacs,
3555 but kills something in Emacs before actually pasting it,
3556 this selection is gone unless this variable is non-nil,
3557 in which case the other program's selection is saved in the `kill-ring'
3558 before the Emacs kill and one can still paste it using \\[yank] \\[yank-pop]."
3563 (defcustom kill-do-not-save-duplicates nil
3564 "Do not add a new string to `kill-ring' if it duplicates the last one.
3565 The comparison is done using `equal-including-properties'."
3570 (defun kill-new (string &optional replace
)
3571 "Make STRING the latest kill in the kill ring.
3572 Set `kill-ring-yank-pointer' to point to it.
3573 If `interprogram-cut-function' is non-nil, apply it to STRING.
3574 Optional second argument REPLACE non-nil means that STRING will replace
3575 the front of the kill ring, rather than being added to the list.
3577 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3578 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3581 When the yank handler has a non-nil PARAM element, the original STRING
3582 argument is not used by `insert-for-yank'. However, since Lisp code
3583 may access and use elements from the kill ring directly, the STRING
3584 argument should still be a \"useful\" string for such uses."
3585 (unless (and kill-do-not-save-duplicates
3586 ;; Due to text properties such as 'yank-handler that
3587 ;; can alter the contents to yank, comparison using
3588 ;; `equal' is unsafe.
3589 (equal-including-properties string
(car kill-ring
)))
3590 (if (fboundp 'menu-bar-update-yank-menu
)
3591 (menu-bar-update-yank-menu string
(and replace
(car kill-ring
)))))
3592 (when save-interprogram-paste-before-kill
3593 (let ((interprogram-paste (and interprogram-paste-function
3594 (funcall interprogram-paste-function
))))
3595 (when interprogram-paste
3596 (dolist (s (if (listp interprogram-paste
)
3597 (nreverse interprogram-paste
)
3598 (list interprogram-paste
)))
3599 (unless (and kill-do-not-save-duplicates
3600 (equal-including-properties s
(car kill-ring
)))
3601 (push s kill-ring
))))))
3602 (unless (and kill-do-not-save-duplicates
3603 (equal-including-properties string
(car kill-ring
)))
3604 (if (and replace kill-ring
)
3605 (setcar kill-ring string
)
3606 (push string kill-ring
)
3607 (if (> (length kill-ring
) kill-ring-max
)
3608 (setcdr (nthcdr (1- kill-ring-max
) kill-ring
) nil
))))
3609 (setq kill-ring-yank-pointer kill-ring
)
3610 (if interprogram-cut-function
3611 (funcall interprogram-cut-function string
)))
3613 (defun kill-append (string before-p
)
3614 "Append STRING to the end of the latest kill in the kill ring.
3615 If BEFORE-P is non-nil, prepend STRING to the kill.
3616 If `interprogram-cut-function' is set, pass the resulting kill to it."
3617 (let* ((cur (car kill-ring
)))
3618 (kill-new (if before-p
(concat string cur
) (concat cur string
))
3619 (or (= (length cur
) 0)
3620 (equal nil
(get-text-property 0 'yank-handler cur
))))))
3622 (defcustom yank-pop-change-selection nil
3623 "Whether rotating the kill ring changes the window system selection.
3624 If non-nil, whenever the kill ring is rotated (usually via the
3625 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3626 to copy the new kill to the window system selection."
3631 (defun current-kill (n &optional do-not-move
)
3632 "Rotate the yanking point by N places, and then return that kill.
3633 If N is zero and `interprogram-paste-function' is set to a
3634 function that returns a string or a list of strings, and if that
3635 function doesn't return nil, then that string (or list) is added
3636 to the front of the kill ring and the string (or first string in
3637 the list) is returned as the latest kill.
3639 If N is not zero, and if `yank-pop-change-selection' is
3640 non-nil, use `interprogram-cut-function' to transfer the
3641 kill at the new yank point into the window system selection.
3643 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3644 move the yanking point; just return the Nth kill forward."
3646 (let ((interprogram-paste (and (= n
0)
3647 interprogram-paste-function
3648 (funcall interprogram-paste-function
))))
3649 (if interprogram-paste
3651 ;; Disable the interprogram cut function when we add the new
3652 ;; text to the kill ring, so Emacs doesn't try to own the
3653 ;; selection, with identical text.
3654 (let ((interprogram-cut-function nil
))
3655 (if (listp interprogram-paste
)
3656 (mapc 'kill-new
(nreverse interprogram-paste
))
3657 (kill-new interprogram-paste
)))
3659 (or kill-ring
(error "Kill ring is empty"))
3660 (let ((ARGth-kill-element
3661 (nthcdr (mod (- n
(length kill-ring-yank-pointer
))
3665 (setq kill-ring-yank-pointer ARGth-kill-element
)
3666 (when (and yank-pop-change-selection
3668 interprogram-cut-function
)
3669 (funcall interprogram-cut-function
(car ARGth-kill-element
))))
3670 (car ARGth-kill-element
)))))
3674 ;;;; Commands for manipulating the kill ring.
3676 (defcustom kill-read-only-ok nil
3677 "Non-nil means don't signal an error for killing read-only text."
3681 (defun kill-region (beg end
&optional region
)
3682 "Kill (\"cut\") text between point and mark.
3683 This deletes the text from the buffer and saves it in the kill ring.
3684 The command \\[yank] can retrieve it from there.
3685 \(If you want to save the region without killing it, use \\[kill-ring-save].)
3687 If you want to append the killed region to the last killed text,
3688 use \\[append-next-kill] before \\[kill-region].
3690 If the buffer is read-only, Emacs will beep and refrain from deleting
3691 the text, but put the text in the kill ring anyway. This means that
3692 you can use the killing commands to copy text from a read-only buffer.
3694 Lisp programs should use this function for killing text.
3695 (To delete text, use `delete-region'.)
3696 Supply two arguments, character positions indicating the stretch of text
3698 Any command that calls this function is a \"kill command\".
3699 If the previous command was also a kill command,
3700 the text killed this time appends to the text killed last time
3701 to make one entry in the kill ring.
3703 The optional argument REGION if non-nil, indicates that we're not just killing
3704 some text between BEG and END, but we're killing the region."
3705 ;; Pass mark first, then point, because the order matters when
3706 ;; calling `kill-append'.
3707 (interactive (list (mark) (point) 'region
))
3708 (unless (and beg end
)
3709 (error "The mark is not set now, so there is no region"))
3711 (let ((string (if region
3712 (funcall region-extract-function
'delete
)
3713 (filter-buffer-substring beg end
'delete
))))
3714 (when string
;STRING is nil if BEG = END
3715 ;; Add that string to the kill ring, one way or another.
3716 (if (eq last-command
'kill-region
)
3717 (kill-append string
(< end beg
))
3718 (kill-new string nil
)))
3719 (when (or string
(eq last-command
'kill-region
))
3720 (setq this-command
'kill-region
))
3721 (setq deactivate-mark t
)
3723 ((buffer-read-only text-read-only
)
3724 ;; The code above failed because the buffer, or some of the characters
3725 ;; in the region, are read-only.
3726 ;; We should beep, in case the user just isn't aware of this.
3727 ;; However, there's no harm in putting
3728 ;; the region's text in the kill ring, anyway.
3729 (copy-region-as-kill beg end region
)
3730 ;; Set this-command now, so it will be set even if we get an error.
3731 (setq this-command
'kill-region
)
3732 ;; This should barf, if appropriate, and give us the correct error.
3733 (if kill-read-only-ok
3734 (progn (message "Read only text copied to kill ring") nil
)
3735 ;; Signal an error if the buffer is read-only.
3736 (barf-if-buffer-read-only)
3737 ;; If the buffer isn't read-only, the text is.
3738 (signal 'text-read-only
(list (current-buffer)))))))
3740 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3741 ;; to get two copies of the text when the user accidentally types M-w and
3742 ;; then corrects it with the intended C-w.
3743 (defun copy-region-as-kill (beg end
&optional region
)
3744 "Save the region as if killed, but don't kill it.
3745 In Transient Mark mode, deactivate the mark.
3746 If `interprogram-cut-function' is non-nil, also save the text for a window
3747 system cut and paste.
3749 The optional argument REGION if non-nil, indicates that we're not just copying
3750 some text between BEG and END, but we're copying the region.
3752 This command's old key binding has been given to `kill-ring-save'."
3753 ;; Pass mark first, then point, because the order matters when
3754 ;; calling `kill-append'.
3755 (interactive (list (mark) (point)
3756 (prefix-numeric-value current-prefix-arg
)))
3757 (let ((str (if region
3758 (funcall region-extract-function nil
)
3759 (filter-buffer-substring beg end
))))
3760 (if (eq last-command
'kill-region
)
3761 (kill-append str
(< end beg
))
3763 (setq deactivate-mark t
)
3766 (defun kill-ring-save (beg end
&optional region
)
3767 "Save the region as if killed, but don't kill it.
3768 In Transient Mark mode, deactivate the mark.
3769 If `interprogram-cut-function' is non-nil, also save the text for a window
3770 system cut and paste.
3772 If you want to append the killed line to the last killed text,
3773 use \\[append-next-kill] before \\[kill-ring-save].
3775 The optional argument REGION if non-nil, indicates that we're not just copying
3776 some text between BEG and END, but we're copying the region.
3778 This command is similar to `copy-region-as-kill', except that it gives
3779 visual feedback indicating the extent of the region being copied."
3780 ;; Pass mark first, then point, because the order matters when
3781 ;; calling `kill-append'.
3782 (interactive (list (mark) (point)
3783 (prefix-numeric-value current-prefix-arg
)))
3784 (copy-region-as-kill beg end region
)
3785 ;; This use of called-interactively-p is correct because the code it
3786 ;; controls just gives the user visual feedback.
3787 (if (called-interactively-p 'interactive
)
3788 (indicate-copied-region)))
3790 (defun indicate-copied-region (&optional message-len
)
3791 "Indicate that the region text has been copied interactively.
3792 If the mark is visible in the selected window, blink the cursor
3793 between point and mark if there is currently no active region
3796 If the mark lies outside the selected window, display an
3797 informative message containing a sample of the copied text. The
3798 optional argument MESSAGE-LEN, if non-nil, specifies the length
3799 of this sample text; it defaults to 40."
3800 (let ((mark (mark t
))
3802 ;; Inhibit quitting so we can make a quit here
3803 ;; look like a C-g typed as a command.
3805 (if (pos-visible-in-window-p mark
(selected-window))
3806 ;; Swap point-and-mark quickly so as to show the region that
3807 ;; was selected. Don't do it if the region is highlighted.
3808 (unless (and (region-active-p)
3809 (face-background 'region
))
3810 ;; Swap point and mark.
3811 (set-marker (mark-marker) (point) (current-buffer))
3813 (sit-for blink-matching-delay
)
3815 (set-marker (mark-marker) mark
(current-buffer))
3817 ;; If user quit, deactivate the mark
3818 ;; as C-g would as a command.
3819 (and quit-flag mark-active
3821 (let ((len (min (abs (- mark point
))
3822 (or message-len
40))))
3824 ;; Don't say "killed"; that is misleading.
3825 (message "Saved text until \"%s\""
3826 (buffer-substring-no-properties (- mark len
) mark
))
3827 (message "Saved text from \"%s\""
3828 (buffer-substring-no-properties mark
(+ mark len
))))))))
3830 (defun append-next-kill (&optional interactive
)
3831 "Cause following command, if it kills, to add to previous kill.
3832 If the next command kills forward from point, the kill is
3833 appended to the previous killed text. If the command kills
3834 backward, the kill is prepended. Kill commands that act on the
3835 region, such as `kill-region', are regarded as killing forward if
3836 point is after mark, and killing backward if point is before
3839 If the next command is not a kill command, `append-next-kill' has
3842 The argument is used for internal purposes; do not supply one."
3844 ;; We don't use (interactive-p), since that breaks kbd macros.
3847 (setq this-command
'kill-region
)
3848 (message "If the next command is a kill, it will append"))
3849 (setq last-command
'kill-region
)))
3853 (defcustom yank-handled-properties
3854 '((font-lock-face . yank-handle-font-lock-face-property
)
3855 (category . yank-handle-category-property
))
3856 "List of special text property handling conditions for yanking.
3857 Each element should have the form (PROP . FUN), where PROP is a
3858 property symbol and FUN is a function. When the `yank' command
3859 inserts text into the buffer, it scans the inserted text for
3860 stretches of text that have `eq' values of the text property
3861 PROP; for each such stretch of text, FUN is called with three
3862 arguments: the property's value in that text, and the start and
3863 end positions of the text.
3865 This is done prior to removing the properties specified by
3866 `yank-excluded-properties'."
3868 :type
'(repeat (cons (symbol :tag
"property symbol")
3872 ;; This is actually used in subr.el but defcustom does not work there.
3873 (defcustom yank-excluded-properties
3874 '(category field follow-link fontified font-lock-face help-echo
3875 intangible invisible keymap local-map mouse-face read-only
3877 "Text properties to discard when yanking.
3878 The value should be a list of text properties to discard or t,
3879 which means to discard all text properties.
3881 See also `yank-handled-properties'."
3882 :type
'(choice (const :tag
"All" t
) (repeat symbol
))
3886 (defvar yank-window-start nil
)
3887 (defvar yank-undo-function nil
3888 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3889 Function is called with two parameters, START and END corresponding to
3890 the value of the mark and point; it is guaranteed that START <= END.
3891 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3893 (defun yank-pop (&optional arg
)
3894 "Replace just-yanked stretch of killed text with a different stretch.
3895 This command is allowed only immediately after a `yank' or a `yank-pop'.
3896 At such a time, the region contains a stretch of reinserted
3897 previously-killed text. `yank-pop' deletes that text and inserts in its
3898 place a different stretch of killed text.
3900 With no argument, the previous kill is inserted.
3901 With argument N, insert the Nth previous kill.
3902 If N is negative, this is a more recent kill.
3904 The sequence of kills wraps around, so that after the oldest one
3905 comes the newest one.
3907 When this command inserts killed text into the buffer, it honors
3908 `yank-excluded-properties' and `yank-handler' as described in the
3909 doc string for `insert-for-yank-1', which see."
3911 (if (not (eq last-command
'yank
))
3912 (error "Previous command was not a yank"))
3913 (setq this-command
'yank
)
3914 (unless arg
(setq arg
1))
3915 (let ((inhibit-read-only t
)
3916 (before (< (point) (mark t
))))
3918 (funcall (or yank-undo-function
'delete-region
) (point) (mark t
))
3919 (funcall (or yank-undo-function
'delete-region
) (mark t
) (point)))
3920 (setq yank-undo-function nil
)
3921 (set-marker (mark-marker) (point) (current-buffer))
3922 (insert-for-yank (current-kill arg
))
3923 ;; Set the window start back where it was in the yank command,
3925 (set-window-start (selected-window) yank-window-start t
)
3927 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3928 ;; It is cleaner to avoid activation, even though the command
3929 ;; loop would deactivate the mark because we inserted text.
3930 (goto-char (prog1 (mark t
)
3931 (set-marker (mark-marker) (point) (current-buffer))))))
3934 (defun yank (&optional arg
)
3935 "Reinsert (\"paste\") the last stretch of killed text.
3936 More precisely, reinsert the most recent kill, which is the
3937 stretch of killed text most recently killed OR yanked. Put point
3938 at the end, and set mark at the beginning without activating it.
3939 With just \\[universal-argument] as argument, put point at beginning, and mark at end.
3940 With argument N, reinsert the Nth most recent kill.
3942 When this command inserts text into the buffer, it honors the
3943 `yank-handled-properties' and `yank-excluded-properties'
3944 variables, and the `yank-handler' text property. See
3945 `insert-for-yank-1' for details.
3947 See also the command `yank-pop' (\\[yank-pop])."
3949 (setq yank-window-start
(window-start))
3950 ;; If we don't get all the way thru, make last-command indicate that
3951 ;; for the following command.
3952 (setq this-command t
)
3954 (insert-for-yank (current-kill (cond
3959 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3960 ;; It is cleaner to avoid activation, even though the command
3961 ;; loop would deactivate the mark because we inserted text.
3962 (goto-char (prog1 (mark t
)
3963 (set-marker (mark-marker) (point) (current-buffer)))))
3964 ;; If we do get all the way thru, make this-command indicate that.
3965 (if (eq this-command t
)
3966 (setq this-command
'yank
))
3969 (defun rotate-yank-pointer (arg)
3970 "Rotate the yanking point in the kill ring.
3971 With ARG, rotate that many kills forward (or backward, if negative)."
3975 ;; Some kill commands.
3977 ;; Internal subroutine of delete-char
3978 (defun kill-forward-chars (arg)
3979 (if (listp arg
) (setq arg
(car arg
)))
3980 (if (eq arg
'-
) (setq arg -
1))
3981 (kill-region (point) (+ (point) arg
)))
3983 ;; Internal subroutine of backward-delete-char
3984 (defun kill-backward-chars (arg)
3985 (if (listp arg
) (setq arg
(car arg
)))
3986 (if (eq arg
'-
) (setq arg -
1))
3987 (kill-region (point) (- (point) arg
)))
3989 (defcustom backward-delete-char-untabify-method
'untabify
3990 "The method for untabifying when deleting backward.
3991 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3992 `hungry' -- delete all whitespace, both tabs and spaces;
3993 `all' -- delete all whitespace, including tabs, spaces and newlines;
3994 nil -- just delete one character."
3995 :type
'(choice (const untabify
) (const hungry
) (const all
) (const nil
))
3999 (defun backward-delete-char-untabify (arg &optional killp
)
4000 "Delete characters backward, changing tabs into spaces.
4001 The exact behavior depends on `backward-delete-char-untabify-method'.
4002 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4003 Interactively, ARG is the prefix arg (default 1)
4004 and KILLP is t if a prefix arg was specified."
4005 (interactive "*p\nP")
4006 (when (eq backward-delete-char-untabify-method
'untabify
)
4009 (while (and (> count
0) (not (bobp)))
4010 (if (= (preceding-char) ?
\t)
4011 (let ((col (current-column)))
4013 (setq col
(- col
(current-column)))
4014 (insert-char ?\s col
)
4017 (setq count
(1- count
))))))
4018 (let* ((skip (cond ((eq backward-delete-char-untabify-method
'hungry
) " \t")
4019 ((eq backward-delete-char-untabify-method
'all
)
4022 (let* ((oldpt (point))
4023 (wh (- oldpt
(save-excursion
4024 (skip-chars-backward skip
)
4025 (constrain-to-field nil oldpt
)))))
4026 (+ arg
(if (zerop wh
) 0 (1- wh
))))
4028 ;; Avoid warning about delete-backward-char
4029 (with-no-warnings (delete-backward-char n killp
))))
4031 (defun zap-to-char (arg char
)
4032 "Kill up to and including ARGth occurrence of CHAR.
4033 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4034 Goes backward if ARG is negative; error if CHAR not found."
4035 (interactive (list (prefix-numeric-value current-prefix-arg
)
4036 (read-char "Zap to char: " t
)))
4037 ;; Avoid "obsolete" warnings for translation-table-for-input.
4039 (if (char-table-p translation-table-for-input
)
4040 (setq char
(or (aref translation-table-for-input char
) char
))))
4041 (kill-region (point) (progn
4042 (search-forward (char-to-string char
) nil nil arg
)
4045 ;; kill-line and its subroutines.
4047 (defcustom kill-whole-line nil
4048 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4052 (defun kill-line (&optional arg
)
4053 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4054 With prefix argument ARG, kill that many lines from point.
4055 Negative arguments kill lines backward.
4056 With zero argument, kills the text before point on the current line.
4058 When calling from a program, nil means \"no arg\",
4059 a number counts as a prefix arg.
4061 To kill a whole line, when point is not at the beginning, type \
4062 \\[move-beginning-of-line] \\[kill-line] \\[kill-line].
4064 If `show-trailing-whitespace' is non-nil, this command will just
4065 kill the rest of the current line, even if there are only
4068 If option `kill-whole-line' is non-nil, then this command kills the whole line
4069 including its terminating newline, when used at the beginning of a line
4070 with no argument. As a consequence, you can always kill a whole line
4071 by typing \\[move-beginning-of-line] \\[kill-line].
4073 If you want to append the killed line to the last killed text,
4074 use \\[append-next-kill] before \\[kill-line].
4076 If the buffer is read-only, Emacs will beep and refrain from deleting
4077 the line, but put the line in the kill ring anyway. This means that
4078 you can use this command to copy text from a read-only buffer.
4079 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4082 (kill-region (point)
4083 ;; It is better to move point to the other end of the kill
4084 ;; before killing. That way, in a read-only buffer, point
4085 ;; moves across the text that is copied to the kill ring.
4086 ;; The choice has no effect on undo now that undo records
4087 ;; the value of point from before the command was run.
4090 (forward-visible-line (prefix-numeric-value arg
))
4092 (signal 'end-of-buffer nil
))
4095 (end-of-visible-line) (point))))
4096 (if (or (save-excursion
4097 ;; If trailing whitespace is visible,
4098 ;; don't treat it as nothing.
4099 (unless show-trailing-whitespace
4100 (skip-chars-forward " \t" end
))
4102 (and kill-whole-line
(bolp)))
4103 (forward-visible-line 1)
4107 (defun kill-whole-line (&optional arg
)
4109 With prefix ARG, kill that many lines starting from the current line.
4110 If ARG is negative, kill backward. Also kill the preceding newline.
4111 \(This is meant to make \\[repeat] work well with negative arguments.)
4112 If ARG is zero, kill current line but exclude the trailing newline."
4114 (or arg
(setq arg
1))
4115 (if (and (> arg
0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
4116 (signal 'end-of-buffer nil
))
4117 (if (and (< arg
0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
4118 (signal 'beginning-of-buffer nil
))
4119 (unless (eq last-command
'kill-region
)
4121 (setq last-command
'kill-region
))
4123 ;; We need to kill in two steps, because the previous command
4124 ;; could have been a kill command, in which case the text
4125 ;; before point needs to be prepended to the current kill
4126 ;; ring entry and the text after point appended. Also, we
4127 ;; need to use save-excursion to avoid copying the same text
4128 ;; twice to the kill ring in read-only buffers.
4130 (kill-region (point) (progn (forward-visible-line 0) (point))))
4131 (kill-region (point) (progn (end-of-visible-line) (point))))
4134 (kill-region (point) (progn (end-of-visible-line) (point))))
4135 (kill-region (point)
4136 (progn (forward-visible-line (1+ arg
))
4137 (unless (bobp) (backward-char))
4141 (kill-region (point) (progn (forward-visible-line 0) (point))))
4142 (kill-region (point)
4143 (progn (forward-visible-line arg
) (point))))))
4145 (defun forward-visible-line (arg)
4146 "Move forward by ARG lines, ignoring currently invisible newlines only.
4147 If ARG is negative, move backward -ARG lines.
4148 If ARG is zero, move to the beginning of the current line."
4153 (or (zerop (forward-line 1))
4154 (signal 'end-of-buffer nil
))
4155 ;; If the newline we just skipped is invisible,
4158 (get-char-property (1- (point)) 'invisible
)))
4159 (if (if (eq buffer-invisibility-spec t
)
4161 (or (memq prop buffer-invisibility-spec
)
4162 (assq prop buffer-invisibility-spec
)))
4163 (setq arg
(1+ arg
))))
4164 (setq arg
(1- arg
)))
4165 ;; If invisible text follows, and it is a number of complete lines,
4167 (let ((opoint (point)))
4168 (while (and (not (eobp))
4170 (get-char-property (point) 'invisible
)))
4171 (if (eq buffer-invisibility-spec t
)
4173 (or (memq prop buffer-invisibility-spec
)
4174 (assq prop buffer-invisibility-spec
)))))
4176 (if (get-text-property (point) 'invisible
)
4177 (or (next-single-property-change (point) 'invisible
)
4179 (next-overlay-change (point)))))
4181 (goto-char opoint
))))
4183 (while (or first
(<= arg
0))
4186 (or (zerop (forward-line -
1))
4187 (signal 'beginning-of-buffer nil
)))
4188 ;; If the newline we just moved to is invisible,
4192 (get-char-property (1- (point)) 'invisible
)))
4193 (unless (if (eq buffer-invisibility-spec t
)
4195 (or (memq prop buffer-invisibility-spec
)
4196 (assq prop buffer-invisibility-spec
)))
4197 (setq arg
(1+ arg
)))))
4199 ;; If invisible text follows, and it is a number of complete lines,
4201 (let ((opoint (point)))
4202 (while (and (not (bobp))
4204 (get-char-property (1- (point)) 'invisible
)))
4205 (if (eq buffer-invisibility-spec t
)
4207 (or (memq prop buffer-invisibility-spec
)
4208 (assq prop buffer-invisibility-spec
)))))
4210 (if (get-text-property (1- (point)) 'invisible
)
4211 (or (previous-single-property-change (point) 'invisible
)
4213 (previous-overlay-change (point)))))
4215 (goto-char opoint
)))))
4216 ((beginning-of-buffer end-of-buffer
)
4219 (defun end-of-visible-line ()
4220 "Move to end of current visible line."
4222 ;; If the following character is currently invisible,
4223 ;; skip all characters with that same `invisible' property value,
4224 ;; then find the next newline.
4225 (while (and (not (eobp))
4227 (skip-chars-forward "^\n")
4229 (get-char-property (point) 'invisible
)))
4230 (if (eq buffer-invisibility-spec t
)
4232 (or (memq prop buffer-invisibility-spec
)
4233 (assq prop buffer-invisibility-spec
))))))
4234 (skip-chars-forward "^\n")
4235 (if (get-text-property (point) 'invisible
)
4236 (goto-char (or (next-single-property-change (point) 'invisible
)
4238 (goto-char (next-overlay-change (point))))
4241 (defun insert-buffer (buffer)
4242 "Insert after point the contents of BUFFER.
4243 Puts mark after the inserted text.
4244 BUFFER may be a buffer or a buffer name.
4246 This function is meant for the user to run interactively.
4247 Don't call it from programs: use `insert-buffer-substring' instead!"
4251 (barf-if-buffer-read-only)
4252 (read-buffer "Insert buffer: "
4253 (if (eq (selected-window) (next-window))
4254 (other-buffer (current-buffer))
4255 (window-buffer (next-window)))
4259 (insert-buffer-substring (get-buffer buffer
))
4262 (put 'insert-buffer
'interactive-only
'insert-buffer-substring
)
4264 (defun append-to-buffer (buffer start end
)
4265 "Append to specified buffer the text of the region.
4266 It is inserted into that buffer before its point.
4268 When calling from a program, give three arguments:
4269 BUFFER (or buffer name), START and END.
4270 START and END specify the portion of the current buffer to be copied."
4272 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t
))
4273 (region-beginning) (region-end)))
4274 (let* ((oldbuf (current-buffer))
4275 (append-to (get-buffer-create buffer
))
4276 (windows (get-buffer-window-list append-to t t
))
4279 (with-current-buffer append-to
4280 (setq point
(point))
4281 (barf-if-buffer-read-only)
4282 (insert-buffer-substring oldbuf start end
)
4283 (dolist (window windows
)
4284 (when (= (window-point window
) point
)
4285 (set-window-point window
(point))))))))
4287 (defun prepend-to-buffer (buffer start end
)
4288 "Prepend to specified buffer the text of the region.
4289 It is inserted into that buffer after its point.
4291 When calling from a program, give three arguments:
4292 BUFFER (or buffer name), START and END.
4293 START and END specify the portion of the current buffer to be copied."
4294 (interactive "BPrepend to buffer: \nr")
4295 (let ((oldbuf (current-buffer)))
4296 (with-current-buffer (get-buffer-create buffer
)
4297 (barf-if-buffer-read-only)
4299 (insert-buffer-substring oldbuf start end
)))))
4301 (defun copy-to-buffer (buffer start end
)
4302 "Copy to specified buffer the text of the region.
4303 It is inserted into that buffer, replacing existing text there.
4305 When calling from a program, give three arguments:
4306 BUFFER (or buffer name), START and END.
4307 START and END specify the portion of the current buffer to be copied."
4308 (interactive "BCopy to buffer: \nr")
4309 (let ((oldbuf (current-buffer)))
4310 (with-current-buffer (get-buffer-create buffer
)
4311 (barf-if-buffer-read-only)
4314 (insert-buffer-substring oldbuf start end
)))))
4316 (define-error 'mark-inactive
(purecopy "The mark is not active now"))
4318 (defvar activate-mark-hook nil
4319 "Hook run when the mark becomes active.
4320 It is also run at the end of a command, if the mark is active and
4321 it is possible that the region may have changed.")
4323 (defvar deactivate-mark-hook nil
4324 "Hook run when the mark becomes inactive.")
4326 (defun mark (&optional force
)
4327 "Return this buffer's mark value as integer, or nil if never set.
4329 In Transient Mark mode, this function signals an error if
4330 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4331 or the argument FORCE is non-nil, it disregards whether the mark
4332 is active, and returns an integer or nil in the usual way.
4334 If you are using this in an editing command, you are most likely making
4335 a mistake; see the documentation of `set-mark'."
4336 (if (or force
(not transient-mark-mode
) mark-active mark-even-if-inactive
)
4337 (marker-position (mark-marker))
4338 (signal 'mark-inactive nil
)))
4340 ;; Behind display-selections-p.
4341 (declare-function x-selection-owner-p
"xselect.c"
4342 (&optional selection terminal
))
4343 (declare-function x-selection-exists-p
"xselect.c"
4344 (&optional selection terminal
))
4346 (defun deactivate-mark (&optional force
)
4347 "Deactivate the mark.
4348 If Transient Mark mode is disabled, this function normally does
4349 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4351 Deactivating the mark sets `mark-active' to nil, updates the
4352 primary selection according to `select-active-regions', and runs
4353 `deactivate-mark-hook'.
4355 If Transient Mark mode was temporarily enabled, reset the value
4356 of the variable `transient-mark-mode'; if this causes Transient
4357 Mark mode to be disabled, don't change `mark-active' to nil or
4358 run `deactivate-mark-hook'."
4359 (when (or transient-mark-mode force
)
4360 (when (and (if (eq select-active-regions
'only
)
4361 (eq (car-safe transient-mark-mode
) 'only
)
4362 select-active-regions
)
4364 (display-selections-p))
4365 ;; The var `saved-region-selection', if non-nil, is the text in
4366 ;; the region prior to the last command modifying the buffer.
4367 ;; Set the selection to that, or to the current region.
4368 (cond (saved-region-selection
4369 (x-set-selection 'PRIMARY saved-region-selection
)
4370 (setq saved-region-selection nil
))
4371 ;; If another program has acquired the selection, region
4372 ;; deactivation should not clobber it (Bug#11772).
4373 ((and (/= (region-beginning) (region-end))
4374 (or (x-selection-owner-p 'PRIMARY
)
4375 (null (x-selection-exists-p 'PRIMARY
))))
4376 (x-set-selection 'PRIMARY
4377 (funcall region-extract-function nil
)))))
4378 (when mark-active
(force-mode-line-update)) ;Refresh toolbar (bug#16382).
4379 (if (and (null force
)
4380 (or (eq transient-mark-mode
'lambda
)
4381 (and (eq (car-safe transient-mark-mode
) 'only
)
4382 (null (cdr transient-mark-mode
)))))
4383 ;; When deactivating a temporary region, don't change
4384 ;; `mark-active' or run `deactivate-mark-hook'.
4385 (setq transient-mark-mode nil
)
4386 (if (eq (car-safe transient-mark-mode
) 'only
)
4387 (setq transient-mark-mode
(cdr transient-mark-mode
)))
4388 (setq mark-active nil
)
4389 (run-hooks 'deactivate-mark-hook
))
4390 (redisplay--update-region-highlight (selected-window))))
4392 (defun activate-mark (&optional no-tmm
)
4394 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4396 (unless (region-active-p)
4397 (force-mode-line-update) ;Refresh toolbar (bug#16382).
4398 (setq mark-active t
)
4399 (unless (or transient-mark-mode no-tmm
)
4400 (setq transient-mark-mode
'lambda
))
4401 (run-hooks 'activate-mark-hook
))))
4403 (defun set-mark (pos)
4404 "Set this buffer's mark to POS. Don't use this function!
4405 That is to say, don't use this function unless you want
4406 the user to see that the mark has moved, and you want the previous
4407 mark position to be lost.
4409 Normally, when a new mark is set, the old one should go on the stack.
4410 This is why most applications should use `push-mark', not `set-mark'.
4412 Novice Emacs Lisp programmers often try to use the mark for the wrong
4413 purposes. The mark saves a location for the user's convenience.
4414 Most editing commands should not alter the mark.
4415 To remember a location for internal use in the Lisp program,
4416 store it in a Lisp variable. Example:
4418 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4421 (set-marker (mark-marker) pos
(current-buffer))
4422 (activate-mark 'no-tmm
))
4423 ;; Normally we never clear mark-active except in Transient Mark mode.
4424 ;; But when we actually clear out the mark value too, we must
4425 ;; clear mark-active in any mode.
4427 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4428 ;; it should never be nil if the mark is nil.
4429 (setq mark-active nil
)
4430 (set-marker (mark-marker) nil
)))
4432 (defcustom use-empty-active-region nil
4433 "Whether \"region-aware\" commands should act on empty regions.
4434 If nil, region-aware commands treat empty regions as inactive.
4435 If non-nil, region-aware commands treat the region as active as
4436 long as the mark is active, even if the region is empty.
4438 Region-aware commands are those that act on the region if it is
4439 active and Transient Mark mode is enabled, and on the text near
4443 :group
'editing-basics
)
4445 (defun use-region-p ()
4446 "Return t if the region is active and it is appropriate to act on it.
4447 This is used by commands that act specially on the region under
4448 Transient Mark mode.
4450 The return value is t if Transient Mark mode is enabled and the
4451 mark is active; furthermore, if `use-empty-active-region' is nil,
4452 the region must not be empty. Otherwise, the return value is nil.
4454 For some commands, it may be appropriate to ignore the value of
4455 `use-empty-active-region'; in that case, use `region-active-p'."
4456 (and (region-active-p)
4457 (or use-empty-active-region
(> (region-end) (region-beginning)))))
4459 (defun region-active-p ()
4460 "Return t if Transient Mark mode is enabled and the mark is active.
4462 Some commands act specially on the region when Transient Mark
4463 mode is enabled. Usually, such commands should use
4464 `use-region-p' instead of this function, because `use-region-p'
4465 also checks the value of `use-empty-active-region'."
4466 (and transient-mark-mode mark-active
))
4469 (defvar redisplay-unhighlight-region-function
4470 (lambda (rol) (when (overlayp rol
) (delete-overlay rol
))))
4472 (defvar redisplay-highlight-region-function
4473 (lambda (start end window rol
)
4474 (if (not (overlayp rol
))
4475 (let ((nrol (make-overlay start end
)))
4476 (funcall redisplay-unhighlight-region-function rol
)
4477 (overlay-put nrol
'window window
)
4478 (overlay-put nrol
'face
'region
)
4479 ;; Normal priority so that a large region doesn't hide all the
4480 ;; overlays within it, but high secondary priority so that if it
4481 ;; ends/starts in the middle of a small overlay, that small overlay
4482 ;; won't hide the region's boundaries.
4483 (overlay-put nrol
'priority
'(nil .
100))
4485 (unless (and (eq (overlay-buffer rol
) (current-buffer))
4486 (eq (overlay-start rol
) start
)
4487 (eq (overlay-end rol
) end
))
4488 (move-overlay rol start end
(current-buffer)))
4491 (defun redisplay--update-region-highlight (window)
4492 (with-current-buffer (window-buffer window
)
4493 (let ((rol (window-parameter window
'internal-region-overlay
)))
4494 (if (not (region-active-p))
4495 (funcall redisplay-unhighlight-region-function rol
)
4496 (let* ((pt (window-point window
))
4498 (start (min pt mark
))
4501 (funcall redisplay-highlight-region-function
4502 start end window rol
)))
4503 (unless (equal new rol
)
4504 (set-window-parameter window
'internal-region-overlay
4507 (defun redisplay--update-region-highlights (windows)
4508 (with-demoted-errors "redisplay--update-region-highlights: %S"
4510 (redisplay--update-region-highlight (selected-window))
4511 (unless (listp windows
) (setq windows
(window-list-1 nil nil t
)))
4512 (if highlight-nonselected-windows
4513 (mapc #'redisplay--update-region-highlight windows
)
4514 (let ((msw (and (window-minibuffer-p) (minibuffer-selected-window))))
4516 (if (or (eq w
(selected-window)) (eq w msw
))
4517 (redisplay--update-region-highlight w
)
4518 (funcall redisplay-unhighlight-region-function
4519 (window-parameter w
'internal-region-overlay
)))))))))
4521 (add-function :before pre-redisplay-function
4522 #'redisplay--update-region-highlights
)
4525 (defvar-local mark-ring nil
4526 "The list of former marks of the current buffer, most recent first.")
4527 (put 'mark-ring
'permanent-local t
)
4529 (defcustom mark-ring-max
16
4530 "Maximum size of mark ring. Start discarding off end if gets this big."
4532 :group
'editing-basics
)
4534 (defvar global-mark-ring nil
4535 "The list of saved global marks, most recent first.")
4537 (defcustom global-mark-ring-max
16
4538 "Maximum size of global mark ring. \
4539 Start discarding off end if gets this big."
4541 :group
'editing-basics
)
4543 (defun pop-to-mark-command ()
4544 "Jump to mark, and pop a new position for mark off the ring.
4545 \(Does not affect global mark ring)."
4548 (error "No mark set in this buffer")
4549 (if (= (point) (mark t
))
4550 (message "Mark popped"))
4551 (goto-char (mark t
))
4554 (defun push-mark-command (arg &optional nomsg
)
4555 "Set mark at where point is.
4556 If no prefix ARG and mark is already set there, just activate it.
4557 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4559 (let ((mark (mark t
)))
4560 (if (or arg
(null mark
) (/= mark
(point)))
4561 (push-mark nil nomsg t
)
4562 (activate-mark 'no-tmm
)
4564 (message "Mark activated")))))
4566 (defcustom set-mark-command-repeat-pop nil
4567 "Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
4568 That means that C-u \\[set-mark-command] \\[set-mark-command]
4569 will pop the mark twice, and
4570 C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
4571 will pop the mark three times.
4573 A value of nil means \\[set-mark-command]'s behavior does not change
4574 after C-u \\[set-mark-command]."
4576 :group
'editing-basics
)
4578 (defun set-mark-command (arg)
4579 "Set the mark where point is, or jump to the mark.
4580 Setting the mark also alters the region, which is the text
4581 between point and mark; this is the closest equivalent in
4582 Emacs to what some editors call the \"selection\".
4584 With no prefix argument, set the mark at point, and push the
4585 old mark position on local mark ring. Also push the old mark on
4586 global mark ring, if the previous mark was set in another buffer.
4588 When Transient Mark Mode is off, immediately repeating this
4589 command activates `transient-mark-mode' temporarily.
4591 With prefix argument (e.g., \\[universal-argument] \\[set-mark-command]), \
4592 jump to the mark, and set the mark from
4593 position popped off the local mark ring (this does not affect the global
4594 mark ring). Use \\[pop-global-mark] to jump to a mark popped off the global
4595 mark ring (see `pop-global-mark').
4597 If `set-mark-command-repeat-pop' is non-nil, repeating
4598 the \\[set-mark-command] command with no prefix argument pops the next position
4599 off the local (or global) mark ring and jumps there.
4601 With \\[universal-argument] \\[universal-argument] as prefix
4602 argument, unconditionally set mark where point is, even if
4603 `set-mark-command-repeat-pop' is non-nil.
4605 Novice Emacs Lisp programmers often try to use the mark for the wrong
4606 purposes. See the documentation of `set-mark' for more information."
4608 (cond ((eq transient-mark-mode
'lambda
)
4609 (setq transient-mark-mode nil
))
4610 ((eq (car-safe transient-mark-mode
) 'only
)
4613 ((and (consp arg
) (> (prefix-numeric-value arg
) 4))
4614 (push-mark-command nil
))
4615 ((not (eq this-command
'set-mark-command
))
4617 (pop-to-mark-command)
4618 (push-mark-command t
)))
4619 ((and set-mark-command-repeat-pop
4620 (eq last-command
'pop-to-mark-command
))
4621 (setq this-command
'pop-to-mark-command
)
4622 (pop-to-mark-command))
4623 ((and set-mark-command-repeat-pop
4624 (eq last-command
'pop-global-mark
)
4626 (setq this-command
'pop-global-mark
)
4629 (setq this-command
'pop-to-mark-command
)
4630 (pop-to-mark-command))
4631 ((eq last-command
'set-mark-command
)
4632 (if (region-active-p)
4635 (message "Mark deactivated"))
4637 (message "Mark activated")))
4639 (push-mark-command nil
))))
4641 (defun push-mark (&optional location nomsg activate
)
4642 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4643 If the last global mark pushed was not in the current buffer,
4644 also push LOCATION on the global mark ring.
4645 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4647 Novice Emacs Lisp programmers often try to use the mark for the wrong
4648 purposes. See the documentation of `set-mark' for more information.
4650 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4651 (unless (null (mark t
))
4652 (setq mark-ring
(cons (copy-marker (mark-marker)) mark-ring
))
4653 (when (> (length mark-ring
) mark-ring-max
)
4654 (move-marker (car (nthcdr mark-ring-max mark-ring
)) nil
)
4655 (setcdr (nthcdr (1- mark-ring-max
) mark-ring
) nil
)))
4656 (set-marker (mark-marker) (or location
(point)) (current-buffer))
4657 ;; Now push the mark on the global mark ring.
4658 (if (and global-mark-ring
4659 (eq (marker-buffer (car global-mark-ring
)) (current-buffer)))
4660 ;; The last global mark pushed was in this same buffer.
4661 ;; Don't push another one.
4663 (setq global-mark-ring
(cons (copy-marker (mark-marker)) global-mark-ring
))
4664 (when (> (length global-mark-ring
) global-mark-ring-max
)
4665 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring
)) nil
)
4666 (setcdr (nthcdr (1- global-mark-ring-max
) global-mark-ring
) nil
)))
4667 (or nomsg executing-kbd-macro
(> (minibuffer-depth) 0)
4668 (message "Mark set"))
4669 (if (or activate
(not transient-mark-mode
))
4670 (set-mark (mark t
)))
4674 "Pop off mark ring into the buffer's actual mark.
4675 Does not set point. Does nothing if mark ring is empty."
4677 (setq mark-ring
(nconc mark-ring
(list (copy-marker (mark-marker)))))
4678 (set-marker (mark-marker) (+ 0 (car mark-ring
)) (current-buffer))
4679 (move-marker (car mark-ring
) nil
)
4680 (if (null (mark t
)) (ding))
4681 (setq mark-ring
(cdr mark-ring
)))
4684 (define-obsolete-function-alias
4685 'exchange-dot-and-mark
'exchange-point-and-mark
"23.3")
4686 (defun exchange-point-and-mark (&optional arg
)
4687 "Put the mark where point is now, and point where the mark is now.
4688 This command works even when the mark is not active,
4689 and it reactivates the mark.
4691 If Transient Mark mode is on, a prefix ARG deactivates the mark
4692 if it is active, and otherwise avoids reactivating it. If
4693 Transient Mark mode is off, a prefix ARG enables Transient Mark
4696 (let ((omark (mark t
))
4697 (temp-highlight (eq (car-safe transient-mark-mode
) 'only
)))
4699 (error "No mark set in this buffer"))
4702 (cond (temp-highlight
4703 (setq transient-mark-mode
(cons 'only transient-mark-mode
)))
4704 ((or (and arg
(region-active-p)) ; (xor arg (not (region-active-p)))
4705 (not (or arg
(region-active-p))))
4707 (t (activate-mark)))
4710 (defcustom shift-select-mode t
4711 "When non-nil, shifted motion keys activate the mark momentarily.
4713 While the mark is activated in this way, any shift-translated point
4714 motion key extends the region, and if Transient Mark mode was off, it
4715 is temporarily turned on. Furthermore, the mark will be deactivated
4716 by any subsequent point motion key that was not shift-translated, or
4717 by any action that normally deactivates the mark in Transient Mark mode.
4719 See `this-command-keys-shift-translated' for the meaning of
4722 :group
'editing-basics
)
4724 (defun handle-shift-selection ()
4725 "Activate/deactivate mark depending on invocation thru shift translation.
4726 This function is called by `call-interactively' when a command
4727 with a `^' character in its `interactive' spec is invoked, before
4728 running the command itself.
4730 If `shift-select-mode' is enabled and the command was invoked
4731 through shift translation, set the mark and activate the region
4732 temporarily, unless it was already set in this way. See
4733 `this-command-keys-shift-translated' for the meaning of shift
4736 Otherwise, if the region has been activated temporarily,
4737 deactivate it, and restore the variable `transient-mark-mode' to
4739 (cond ((and shift-select-mode this-command-keys-shift-translated
)
4740 (unless (and mark-active
4741 (eq (car-safe transient-mark-mode
) 'only
))
4742 (setq transient-mark-mode
4744 (unless (eq transient-mark-mode
'lambda
)
4745 transient-mark-mode
)))
4746 (push-mark nil nil t
)))
4747 ((eq (car-safe transient-mark-mode
) 'only
)
4748 (setq transient-mark-mode
(cdr transient-mark-mode
))
4749 (deactivate-mark))))
4751 (define-minor-mode transient-mark-mode
4752 "Toggle Transient Mark mode.
4753 With a prefix argument ARG, enable Transient Mark mode if ARG is
4754 positive, and disable it otherwise. If called from Lisp, enable
4755 Transient Mark mode if ARG is omitted or nil.
4757 Transient Mark mode is a global minor mode. When enabled, the
4758 region is highlighted whenever the mark is active. The mark is
4759 \"deactivated\" by changing the buffer, and after certain other
4760 operations that set the mark but whose main purpose is something
4761 else--for example, incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
4763 You can also deactivate the mark by typing \\[keyboard-quit] or
4764 \\[keyboard-escape-quit].
4766 Many commands change their behavior when Transient Mark mode is
4767 in effect and the mark is active, by acting on the region instead
4768 of their usual default part of the buffer's text. Examples of
4769 such commands include \\[comment-dwim], \\[flush-lines], \\[keep-lines],
4770 \\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
4771 To see the documentation of commands which are sensitive to the
4772 Transient Mark mode, invoke \\[apropos-documentation] and type \"transient\"
4773 or \"mark.*active\" at the prompt."
4775 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4776 :variable transient-mark-mode
)
4778 (defvar widen-automatically t
4779 "Non-nil means it is ok for commands to call `widen' when they want to.
4780 Some commands will do this in order to go to positions outside
4781 the current accessible part of the buffer.
4783 If `widen-automatically' is nil, these commands will do something else
4784 as a fallback, and won't change the buffer bounds.")
4786 (defvar non-essential nil
4787 "Whether the currently executing code is performing an essential task.
4788 This variable should be non-nil only when running code which should not
4789 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4790 user for a password when we are simply scanning a set of files in the
4791 background or displaying possible completions before the user even asked
4794 (defun pop-global-mark ()
4795 "Pop off global mark ring and jump to the top location."
4797 ;; Pop entries which refer to non-existent buffers.
4798 (while (and global-mark-ring
(not (marker-buffer (car global-mark-ring
))))
4799 (setq global-mark-ring
(cdr global-mark-ring
)))
4800 (or global-mark-ring
4801 (error "No global mark set"))
4802 (let* ((marker (car global-mark-ring
))
4803 (buffer (marker-buffer marker
))
4804 (position (marker-position marker
)))
4805 (setq global-mark-ring
(nconc (cdr global-mark-ring
)
4806 (list (car global-mark-ring
))))
4808 (or (and (>= position
(point-min))
4809 (<= position
(point-max)))
4810 (if widen-automatically
4812 (error "Global mark position is outside accessible part of buffer")))
4813 (goto-char position
)
4814 (switch-to-buffer buffer
)))
4816 (defcustom next-line-add-newlines nil
4817 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4820 :group
'editing-basics
)
4822 (defun next-line (&optional arg try-vscroll
)
4823 "Move cursor vertically down ARG lines.
4824 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4825 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4826 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4827 function will not vscroll.
4831 If there is no character in the target line exactly under the current column,
4832 the cursor is positioned after the character in that line which spans this
4833 column, or at the end of the line if it is not long enough.
4834 If there is no line in the buffer after this one, behavior depends on the
4835 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4836 to create a line, and moves the cursor to that line. Otherwise it moves the
4837 cursor to the end of the buffer.
4839 If the variable `line-move-visual' is non-nil, this command moves
4840 by display lines. Otherwise, it moves by buffer lines, without
4841 taking variable-width characters or continued lines into account.
4843 The command \\[set-goal-column] can be used to create
4844 a semipermanent goal column for this command.
4845 Then instead of trying to move exactly vertically (or as close as possible),
4846 this command moves to the specified goal column (or as close as possible).
4847 The goal column is stored in the variable `goal-column', which is nil
4848 when there is no goal column. Note that setting `goal-column'
4849 overrides `line-move-visual' and causes this command to move by buffer
4850 lines rather than by display lines.
4852 If you are thinking of using this in a Lisp program, consider
4853 using `forward-line' instead. It is usually easier to use
4854 and more reliable (no dependence on goal column, etc.)."
4855 (interactive "^p\np")
4856 (or arg
(setq arg
1))
4857 (if (and next-line-add-newlines
(= arg
1))
4858 (if (save-excursion (end-of-line) (eobp))
4859 ;; When adding a newline, don't expand an abbrev.
4860 (let ((abbrev-mode nil
))
4862 (insert (if use-hard-newlines hard-newline
"\n")))
4863 (line-move arg nil nil try-vscroll
))
4864 (if (called-interactively-p 'interactive
)
4866 (line-move arg nil nil try-vscroll
)
4867 ((beginning-of-buffer end-of-buffer
)
4868 (signal (car err
) (cdr err
))))
4869 (line-move arg nil nil try-vscroll
)))
4871 (put 'next-line
'interactive-only
'forward-line
)
4873 (defun previous-line (&optional arg try-vscroll
)
4874 "Move cursor vertically up ARG lines.
4875 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4876 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4877 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4878 function will not vscroll.
4882 If there is no character in the target line exactly over the current column,
4883 the cursor is positioned after the character in that line which spans this
4884 column, or at the end of the line if it is not long enough.
4886 If the variable `line-move-visual' is non-nil, this command moves
4887 by display lines. Otherwise, it moves by buffer lines, without
4888 taking variable-width characters or continued lines into account.
4890 The command \\[set-goal-column] can be used to create
4891 a semipermanent goal column for this command.
4892 Then instead of trying to move exactly vertically (or as close as possible),
4893 this command moves to the specified goal column (or as close as possible).
4894 The goal column is stored in the variable `goal-column', which is nil
4895 when there is no goal column. Note that setting `goal-column'
4896 overrides `line-move-visual' and causes this command to move by buffer
4897 lines rather than by display lines.
4899 If you are thinking of using this in a Lisp program, consider using
4900 `forward-line' with a negative argument instead. It is usually easier
4901 to use and more reliable (no dependence on goal column, etc.)."
4902 (interactive "^p\np")
4903 (or arg
(setq arg
1))
4904 (if (called-interactively-p 'interactive
)
4906 (line-move (- arg
) nil nil try-vscroll
)
4907 ((beginning-of-buffer end-of-buffer
)
4908 (signal (car err
) (cdr err
))))
4909 (line-move (- arg
) nil nil try-vscroll
))
4911 (put 'previous-line
'interactive-only
4912 "use `forward-line' with negative argument instead.")
4914 (defcustom track-eol nil
4915 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4916 This means moving to the end of each line moved onto.
4917 The beginning of a blank line does not count as the end of a line.
4918 This has no effect when the variable `line-move-visual' is non-nil."
4920 :group
'editing-basics
)
4922 (defcustom goal-column nil
4923 "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.
4924 A non-nil setting overrides the variable `line-move-visual', which see."
4925 :type
'(choice integer
4926 (const :tag
"None" nil
))
4927 :group
'editing-basics
)
4928 (make-variable-buffer-local 'goal-column
)
4930 (defvar temporary-goal-column
0
4931 "Current goal column for vertical motion.
4932 It is the column where point was at the start of the current run
4933 of vertical motion commands.
4935 When moving by visual lines via the function `line-move-visual', it is a cons
4936 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4937 divided by the default column width, and HSCROLL is the number of
4938 columns by which window is scrolled from left margin.
4940 When the `track-eol' feature is doing its job, the value is
4941 `most-positive-fixnum'.")
4943 (defcustom line-move-ignore-invisible t
4944 "Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
4945 Outline mode sets this."
4947 :group
'editing-basics
)
4949 (defcustom line-move-visual t
4950 "When non-nil, `line-move' moves point by visual lines.
4951 This movement is based on where the cursor is displayed on the
4952 screen, instead of relying on buffer contents alone. It takes
4953 into account variable-width characters and line continuation.
4954 If nil, `line-move' moves point by logical lines.
4955 A non-nil setting of `goal-column' overrides the value of this variable
4956 and forces movement by logical lines.
4957 A window that is horizontally scrolled also forces movement by logical
4960 :group
'editing-basics
4963 ;; Only used if display-graphic-p.
4964 (declare-function font-info
"font.c" (name &optional frame
))
4966 (defun default-font-height ()
4967 "Return the height in pixels of the current buffer's default face font."
4968 (let ((default-font (face-font 'default
)))
4970 ((and (display-multi-font-p)
4971 ;; Avoid calling font-info if the frame's default font was
4972 ;; not changed since the frame was created. That's because
4973 ;; font-info is expensive for some fonts, see bug #14838.
4974 (not (string= (frame-parameter nil
'font
) default-font
)))
4975 (aref (font-info default-font
) 3))
4976 (t (frame-char-height)))))
4978 (defun default-line-height ()
4979 "Return the pixel height of current buffer's default-face text line.
4981 The value includes `line-spacing', if any, defined for the buffer
4983 (let ((dfh (default-font-height))
4984 (lsp (if (display-graphic-p)
4986 (default-value 'line-spacing
)
4987 (frame-parameter nil
'line-spacing
)
4991 (setq lsp
(* dfh lsp
)))
4994 (defun window-screen-lines ()
4995 "Return the number of screen lines in the text area of the selected window.
4997 This is different from `window-text-height' in that this function counts
4998 lines in units of the height of the font used by the default face displayed
4999 in the window, not in units of the frame's default font, and also accounts
5000 for `line-spacing', if any, defined for the window's buffer or frame.
5002 The value is a floating-point number."
5003 (let ((canonical (window-text-height))
5004 (fch (frame-char-height))
5005 (dlh (default-line-height)))
5006 (/ (* (float canonical
) fch
) dlh
)))
5008 ;; Returns non-nil if partial move was done.
5009 (defun line-move-partial (arg noerror to-end
)
5011 ;; Move backward (up).
5012 ;; If already vscrolled, reduce vscroll
5013 (let ((vs (window-vscroll nil t
))
5014 (dlh (default-line-height)))
5016 (set-window-vscroll nil
(- vs dlh
) t
)))
5018 ;; Move forward (down).
5019 (let* ((lh (window-line-height -
1))
5024 (this-lh (window-line-height))
5025 (this-height (car this-lh
))
5026 (this-ypos (nth 2 this-lh
))
5027 (dlh (default-line-height))
5028 (wslines (window-screen-lines))
5029 (edges (window-inside-pixel-edges))
5030 (winh (- (nth 3 edges
) (nth 1 edges
) 1))
5032 (if (> (mod wslines
1.0) 0.0)
5033 (setq wslines
(round (+ wslines
0.5))))
5038 (<= this-ypos
(- dlh
)))
5040 (let ((wend (pos-visible-in-window-p t nil t
)))
5041 (setq rbot
(nth 3 wend
)
5043 vpos
(nth 5 wend
))))
5045 (let ((wstart (pos-visible-in-window-p nil nil t
)))
5046 (setq this-ypos
(nth 2 wstart
)
5047 this-height
(nth 4 wstart
))))
5050 (let ((ppos (posn-at-point))
5052 (setq col-row
(posn-actual-col-row ppos
))
5054 (- (cdr col-row
) (window-vscroll))
5055 (cdr (posn-col-row ppos
))))))
5056 ;; VPOS > 0 means the last line is only partially visible.
5057 ;; But if the part that is visible is at least as tall as the
5058 ;; default font, that means the line is actually fully
5059 ;; readable, and something like line-spacing is hidden. So in
5060 ;; that case we accept the last line in the window as still
5061 ;; visible, and consider the margin as starting one line
5063 (if (and vpos
(> vpos
0))
5065 (>= rowh
(default-font-height))
5067 (setq last-line
(min (- wslines scroll-margin
) vpos
))
5068 (setq last-line
(min (- wslines scroll-margin
1) (1- vpos
)))))
5070 ;; If last line of window is fully visible, and vscrolling
5071 ;; more would make this line invisible, move forward.
5072 ((and (or (< (setq vs
(window-vscroll nil t
)) dlh
)
5074 (<= this-height dlh
))
5075 (or (null rbot
) (= rbot
0)))
5077 ;; If cursor is not in the bottom scroll margin, and the
5078 ;; current line is is not too tall, move forward.
5079 ((and (or (null this-height
) (<= this-height winh
))
5084 ;; When already vscrolled, we vscroll some more if we can,
5085 ;; or clear vscroll and move forward at end of tall image.
5087 (when (or (and rbot
(> rbot
0))
5088 (and this-height
(> this-height dlh
)))
5089 (set-window-vscroll nil
(+ vs dlh
) t
)))
5090 ;; If cursor just entered the bottom scroll margin, move forward,
5091 ;; but also optionally vscroll one line so redisplay won't recenter.
5095 ;; Don't vscroll if the partially-visible line at window
5096 ;; bottom is not too tall (a.k.a. "just one more text
5097 ;; line"): in that case, we do want redisplay to behave
5098 ;; normally, i.e. recenter or whatever.
5100 ;; Note: ROWH + RBOT from the value returned by
5101 ;; pos-visible-in-window-p give the total height of the
5102 ;; partially-visible glyph row at the end of the window. As
5103 ;; we are dealing with floats, we disregard sub-pixel
5104 ;; discrepancies between that and DLH.
5105 (if (and rowh rbot
(>= (- (+ rowh rbot
) winh
) 1))
5106 (set-window-vscroll nil dlh t
))
5107 (line-move-1 arg noerror to-end
)
5109 ;; If there are lines above the last line, scroll-up one line.
5110 ((and vpos
(> vpos
0))
5113 ;; Finally, start vscroll.
5115 (set-window-vscroll nil dlh t
)))))))
5118 ;; This is like line-move-1 except that it also performs
5119 ;; vertical scrolling of tall images if appropriate.
5120 ;; That is not really a clean thing to do, since it mixes
5121 ;; scrolling with cursor motion. But so far we don't have
5122 ;; a cleaner solution to the problem of making C-n do something
5123 ;; useful given a tall image.
5124 (defun line-move (arg &optional noerror to-end try-vscroll
)
5125 "Move forward ARG lines.
5126 If NOERROR, don't signal an error if we can't move ARG lines.
5128 TRY-VSCROLL controls whether to vscroll tall lines: if either
5129 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5133 (unless (and auto-window-vscroll try-vscroll
5134 ;; Only vscroll for single line moves
5136 ;; Under scroll-conservatively, the display engine
5137 ;; does this better.
5138 (zerop scroll-conservatively
)
5139 ;; But don't vscroll in a keyboard macro.
5140 (not defining-kbd-macro
)
5141 (not executing-kbd-macro
)
5142 (line-move-partial arg noerror to-end
))
5143 (set-window-vscroll nil
0 t
)
5144 (if (and line-move-visual
5145 ;; Display-based column are incompatible with goal-column.
5147 ;; When the text in the window is scrolled to the left,
5148 ;; display-based motion doesn't make sense (because each
5149 ;; logical line occupies exactly one screen line).
5150 (not (> (window-hscroll) 0))
5151 ;; Likewise when the text _was_ scrolled to the left
5152 ;; when the current run of vertical motion commands
5154 (not (and (memq last-command
5155 `(next-line previous-line
,this-command
))
5157 (numberp temporary-goal-column
)
5158 (>= temporary-goal-column
5159 (- (window-width) hscroll-margin
)))))
5160 (prog1 (line-move-visual arg noerror
)
5161 ;; If we moved into a tall line, set vscroll to make
5162 ;; scrolling through tall images more smooth.
5163 (let ((lh (line-pixel-height))
5164 (edges (window-inside-pixel-edges))
5165 (dlh (default-line-height))
5167 (setq winh
(- (nth 3 edges
) (nth 1 edges
) 1))
5169 (< (point) (window-start))
5174 (line-move-1 arg noerror to-end
)))))
5176 ;; Display-based alternative to line-move-1.
5177 ;; Arg says how many lines to move. The value is t if we can move the
5178 ;; specified number of lines.
5179 (defun line-move-visual (arg &optional noerror
)
5180 "Move ARG lines forward.
5181 If NOERROR, don't signal an error if we can't move that many lines."
5182 (let ((opoint (point))
5183 (hscroll (window-hscroll))
5185 ;; Check if the previous command was a line-motion command, or if
5186 ;; we were called from some other command.
5187 (if (and (consp temporary-goal-column
)
5188 (memq last-command
`(next-line previous-line
,this-command
)))
5189 ;; If so, there's no need to reset `temporary-goal-column',
5190 ;; but we may need to hscroll.
5191 (if (or (/= (cdr temporary-goal-column
) hscroll
)
5192 (> (cdr temporary-goal-column
) 0))
5193 (setq target-hscroll
(cdr temporary-goal-column
)))
5194 ;; Otherwise, we should reset `temporary-goal-column'.
5195 (let ((posn (posn-at-point)))
5197 ;; Handle the `overflow-newline-into-fringe' case:
5198 ((eq (nth 1 posn
) 'right-fringe
)
5199 (setq temporary-goal-column
(cons (- (window-width) 1) hscroll
)))
5200 ((car (posn-x-y posn
))
5201 (setq temporary-goal-column
5202 (cons (/ (float (car (posn-x-y posn
)))
5203 (frame-char-width)) hscroll
))))))
5205 (set-window-hscroll (selected-window) target-hscroll
))
5206 ;; vertical-motion can move more than it was asked to if it moves
5207 ;; across display strings with newlines. We don't want to ring
5208 ;; the bell and announce beginning/end of buffer in that case.
5209 (or (and (or (and (>= arg
0)
5210 (>= (vertical-motion
5211 (cons (or goal-column
5212 (if (consp temporary-goal-column
)
5213 (car temporary-goal-column
)
5214 temporary-goal-column
))
5218 (<= (vertical-motion
5219 (cons (or goal-column
5220 (if (consp temporary-goal-column
)
5221 (car temporary-goal-column
)
5222 temporary-goal-column
))
5227 ;; If the goal column lies on a display string,
5228 ;; `vertical-motion' advances the cursor to the end
5229 ;; of the string. For arg < 0, this can cause the
5230 ;; cursor to get stuck. (Bug#3020).
5231 (= (vertical-motion arg
) arg
)))
5233 (signal (if (< arg
0) 'beginning-of-buffer
'end-of-buffer
)
5236 ;; This is the guts of next-line and previous-line.
5237 ;; Arg says how many lines to move.
5238 ;; The value is t if we can move the specified number of lines.
5239 (defun line-move-1 (arg &optional noerror _to-end
)
5240 ;; Don't run any point-motion hooks, and disregard intangibility,
5241 ;; for intermediate positions.
5242 (let ((inhibit-point-motion-hooks t
)
5245 (if (consp temporary-goal-column
)
5246 (setq temporary-goal-column
(+ (car temporary-goal-column
)
5247 (cdr temporary-goal-column
))))
5250 (if (not (memq last-command
'(next-line previous-line
)))
5251 (setq temporary-goal-column
5252 (if (and track-eol
(eolp)
5253 ;; Don't count beg of empty line as end of line
5254 ;; unless we just did explicit end-of-line.
5255 (or (not (bolp)) (eq last-command
'move-end-of-line
)))
5256 most-positive-fixnum
5259 (if (not (or (integerp selective-display
)
5260 line-move-ignore-invisible
))
5261 ;; Use just newline characters.
5262 ;; Set ARG to 0 if we move as many lines as requested.
5264 (progn (if (> arg
1) (forward-line (1- arg
)))
5265 ;; This way of moving forward ARG lines
5266 ;; verifies that we have a newline after the last one.
5267 ;; It doesn't get confused by intangible text.
5269 (if (zerop (forward-line 1))
5271 (and (zerop (forward-line arg
))
5275 (signal (if (< arg
0)
5276 'beginning-of-buffer
5279 ;; Move by arg lines, but ignore invisible ones.
5281 (while (and (> arg
0) (not done
))
5282 ;; If the following character is currently invisible,
5283 ;; skip all characters with that same `invisible' property value.
5284 (while (and (not (eobp)) (invisible-p (point)))
5285 (goto-char (next-char-property-change (point))))
5287 ;; We don't use `end-of-line', since we want to escape
5288 ;; from field boundaries occurring exactly at point.
5289 (goto-char (constrain-to-field
5290 (let ((inhibit-field-text-motion t
))
5291 (line-end-position))
5293 'inhibit-line-move-field-capture
))
5294 ;; If there's no invisibility here, move over the newline.
5298 (signal 'end-of-buffer nil
)
5300 ((and (> arg
1) ;; Use vertical-motion for last move
5301 (not (integerp selective-display
))
5302 (not (invisible-p (point))))
5303 ;; We avoid vertical-motion when possible
5304 ;; because that has to fontify.
5306 ;; Otherwise move a more sophisticated way.
5307 ((zerop (vertical-motion 1))
5309 (signal 'end-of-buffer nil
)
5312 (setq arg
(1- arg
))))
5313 ;; The logic of this is the same as the loop above,
5314 ;; it just goes in the other direction.
5315 (while (and (< arg
0) (not done
))
5316 ;; For completely consistency with the forward-motion
5317 ;; case, we should call beginning-of-line here.
5318 ;; However, if point is inside a field and on a
5319 ;; continued line, the call to (vertical-motion -1)
5320 ;; below won't move us back far enough; then we return
5321 ;; to the same column in line-move-finish, and point
5322 ;; gets stuck -- cyd
5327 (signal 'beginning-of-buffer nil
)
5329 ((and (< arg -
1) ;; Use vertical-motion for last move
5330 (not (integerp selective-display
))
5331 (not (invisible-p (1- (point)))))
5333 ((zerop (vertical-motion -
1))
5335 (signal 'beginning-of-buffer nil
)
5339 (while (and ;; Don't move over previous invis lines
5340 ;; if our target is the middle of this line.
5341 (or (zerop (or goal-column temporary-goal-column
))
5343 (not (bobp)) (invisible-p (1- (point))))
5344 (goto-char (previous-char-property-change (point))))))))
5345 ;; This is the value the function returns.
5349 ;; If we did not move down as far as desired, at least go
5350 ;; to end of line. Be sure to call point-entered and
5351 ;; point-left-hooks.
5352 (let* ((npoint (prog1 (line-end-position)
5353 (goto-char opoint
)))
5354 (inhibit-point-motion-hooks nil
))
5355 (goto-char npoint
)))
5357 ;; If we did not move up as far as desired,
5358 ;; at least go to beginning of line.
5359 (let* ((npoint (prog1 (line-beginning-position)
5360 (goto-char opoint
)))
5361 (inhibit-point-motion-hooks nil
))
5362 (goto-char npoint
)))
5364 (line-move-finish (or goal-column temporary-goal-column
)
5365 opoint
(> orig-arg
0)))))))
5367 (defun line-move-finish (column opoint forward
)
5370 ;; Set REPEAT to t to repeat the whole thing.
5375 (line-beg (line-beginning-position))
5377 ;; Compute the end of the line
5378 ;; ignoring effectively invisible newlines.
5380 ;; Like end-of-line but ignores fields.
5381 (skip-chars-forward "^\n")
5382 (while (and (not (eobp)) (invisible-p (point)))
5383 (goto-char (next-char-property-change (point)))
5384 (skip-chars-forward "^\n"))
5387 ;; Move to the desired column.
5388 (line-move-to-column (truncate column
))
5390 ;; Corner case: suppose we start out in a field boundary in
5391 ;; the middle of a continued line. When we get to
5392 ;; line-move-finish, point is at the start of a new *screen*
5393 ;; line but the same text line; then line-move-to-column would
5394 ;; move us backwards. Test using C-n with point on the "x" in
5395 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5402 ;; Process intangibility within a line.
5403 ;; With inhibit-point-motion-hooks bound to nil, a call to
5404 ;; goto-char moves point past intangible text.
5406 ;; However, inhibit-point-motion-hooks controls both the
5407 ;; intangibility and the point-entered/point-left hooks. The
5408 ;; following hack avoids calling the point-* hooks
5409 ;; unnecessarily. Note that we move *forward* past intangible
5410 ;; text when the initial and final points are the same.
5412 (let ((inhibit-point-motion-hooks nil
))
5415 ;; If intangibility moves us to a different (later) place
5416 ;; in the same line, use that as the destination.
5417 (if (<= (point) line-end
)
5419 ;; If that position is "too late",
5420 ;; try the previous allowable position.
5424 ;; If going forward, don't accept the previous
5425 ;; allowable position if it is before the target line.
5426 (< line-beg
(point))
5427 ;; If going backward, don't accept the previous
5428 ;; allowable position if it is still after the target line.
5429 (<= (point) line-end
))
5431 ;; As a last resort, use the end of the line.
5432 (setq new line-end
))))
5434 ;; Now move to the updated destination, processing fields
5435 ;; as well as intangibility.
5437 (let ((inhibit-point-motion-hooks nil
))
5439 ;; Ignore field boundaries if the initial and final
5440 ;; positions have the same `field' property, even if the
5441 ;; fields are non-contiguous. This seems to be "nicer"
5442 ;; behavior in many situations.
5443 (if (eq (get-char-property new
'field
)
5444 (get-char-property opoint
'field
))
5446 (constrain-to-field new opoint t t
5447 'inhibit-line-move-field-capture
))))
5449 ;; If all this moved us to a different line,
5450 ;; retry everything within that new line.
5451 (when (or (< (point) line-beg
) (> (point) line-end
))
5452 ;; Repeat the intangibility and field processing.
5453 (setq repeat t
))))))
5455 (defun line-move-to-column (col)
5456 "Try to find column COL, considering invisibility.
5457 This function works only in certain cases,
5458 because what we really need is for `move-to-column'
5459 and `current-column' to be able to ignore invisible text."
5462 (move-to-column col
))
5464 (when (and line-move-ignore-invisible
5465 (not (bolp)) (invisible-p (1- (point))))
5466 (let ((normal-location (point))
5467 (normal-column (current-column)))
5468 ;; If the following character is currently invisible,
5469 ;; skip all characters with that same `invisible' property value.
5470 (while (and (not (eobp))
5471 (invisible-p (point)))
5472 (goto-char (next-char-property-change (point))))
5473 ;; Have we advanced to a larger column position?
5474 (if (> (current-column) normal-column
)
5475 ;; We have made some progress towards the desired column.
5476 ;; See if we can make any further progress.
5477 (line-move-to-column (+ (current-column) (- col normal-column
)))
5478 ;; Otherwise, go to the place we originally found
5479 ;; and move back over invisible text.
5480 ;; that will get us to the same place on the screen
5481 ;; but with a more reasonable buffer position.
5482 (goto-char normal-location
)
5483 (let ((line-beg (line-beginning-position)))
5484 (while (and (not (bolp)) (invisible-p (1- (point))))
5485 (goto-char (previous-char-property-change (point) line-beg
))))))))
5487 (defun move-end-of-line (arg)
5488 "Move point to end of current line as displayed.
5489 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5490 If point reaches the beginning or end of buffer, it stops there.
5492 To ignore the effects of the `intangible' text or overlay
5493 property, bind `inhibit-point-motion-hooks' to t.
5494 If there is an image in the current line, this function
5495 disregards newlines that are part of the text on which the image
5498 (or arg
(setq arg
1))
5503 (let ((goal-column 0)
5504 (line-move-visual nil
))
5505 (and (line-move arg t
)
5506 ;; With bidi reordering, we may not be at bol,
5507 ;; so make sure we are.
5508 (skip-chars-backward "^\n")
5511 (while (and (not (bobp)) (invisible-p (1- (point))))
5512 (goto-char (previous-single-char-property-change
5513 (point) 'invisible
)))
5517 (if (and (> (point) newpos
)
5518 (eq (preceding-char) ?
\n))
5520 (if (and (> (point) newpos
) (not (eobp))
5521 (not (eq (following-char) ?
\n)))
5522 ;; If we skipped something intangible and now we're not
5523 ;; really at eol, keep going.
5527 (defun move-beginning-of-line (arg)
5528 "Move point to beginning of current line as displayed.
5529 \(If there's an image in the line, this disregards newlines
5530 which are part of the text that the image rests on.)
5532 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5533 If point reaches the beginning or end of buffer, it stops there.
5534 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5536 (or arg
(setq arg
1))
5538 (let ((orig (point))
5539 first-vis first-vis-field-value
)
5541 ;; Move by lines, if ARG is not 1 (the default).
5543 (let ((line-move-visual nil
))
5544 (line-move (1- arg
) t
)))
5546 ;; Move to beginning-of-line, ignoring fields and invisible text.
5547 (skip-chars-backward "^\n")
5548 (while (and (not (bobp)) (invisible-p (1- (point))))
5549 (goto-char (previous-char-property-change (point)))
5550 (skip-chars-backward "^\n"))
5552 ;; Now find first visible char in the line.
5553 (while (and (< (point) orig
) (invisible-p (point)))
5554 (goto-char (next-char-property-change (point) orig
)))
5555 (setq first-vis
(point))
5557 ;; See if fields would stop us from reaching FIRST-VIS.
5558 (setq first-vis-field-value
5559 (constrain-to-field first-vis orig
(/= arg
1) t nil
))
5561 (goto-char (if (/= first-vis-field-value first-vis
)
5562 ;; If yes, obey them.
5563 first-vis-field-value
5564 ;; Otherwise, move to START with attention to fields.
5565 ;; (It is possible that fields never matter in this case.)
5566 (constrain-to-field (point) orig
5567 (/= arg
1) t nil
)))))
5570 ;; Many people have said they rarely use this feature, and often type
5571 ;; it by accident. Maybe it shouldn't even be on a key.
5572 (put 'set-goal-column
'disabled t
)
5574 (defun set-goal-column (arg)
5575 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
5576 Those commands will move to this position in the line moved to
5577 rather than trying to keep the same horizontal position.
5578 With a non-nil argument ARG, clears out the goal column
5579 so that \\[next-line] and \\[previous-line] resume vertical motion.
5580 The goal column is stored in the variable `goal-column'."
5584 (setq goal-column nil
)
5585 (message "No goal column"))
5586 (setq goal-column
(current-column))
5587 ;; The older method below can be erroneous if `set-goal-column' is bound
5588 ;; to a sequence containing %
5589 ;;(message (substitute-command-keys
5590 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5594 (format "Goal column %d " goal-column
)
5595 (substitute-command-keys
5596 "(use \\[set-goal-column] with an arg to unset it)")))
5601 ;;; Editing based on visual lines, as opposed to logical lines.
5603 (defun end-of-visual-line (&optional n
)
5604 "Move point to end of current visual line.
5605 With argument N not nil or 1, move forward N - 1 visual lines first.
5606 If point reaches the beginning or end of buffer, it stops there.
5607 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5611 (let ((line-move-visual t
))
5612 (line-move (1- n
) t
)))
5613 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5614 ;; constrain to field boundaries, so we don't either.
5615 (vertical-motion (cons (window-width) 0)))
5617 (defun beginning-of-visual-line (&optional n
)
5618 "Move point to beginning of current visual line.
5619 With argument N not nil or 1, move forward N - 1 visual lines first.
5620 If point reaches the beginning or end of buffer, it stops there.
5621 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5624 (let ((opoint (point)))
5626 (let ((line-move-visual t
))
5627 (line-move (1- n
) t
)))
5629 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5630 (goto-char (constrain-to-field (point) opoint
(/= n
1)))))
5632 (defun kill-visual-line (&optional arg
)
5633 "Kill the rest of the visual line.
5634 With prefix argument ARG, kill that many visual lines from point.
5635 If ARG is negative, kill visual lines backward.
5636 If ARG is zero, kill the text before point on the current visual
5639 If you want to append the killed line to the last killed text,
5640 use \\[append-next-kill] before \\[kill-line].
5642 If the buffer is read-only, Emacs will beep and refrain from deleting
5643 the line, but put the line in the kill ring anyway. This means that
5644 you can use this command to copy text from a read-only buffer.
5645 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5648 ;; Like in `kill-line', it's better to move point to the other end
5649 ;; of the kill before killing.
5650 (let ((opoint (point))
5651 (kill-whole-line (and kill-whole-line
(bolp))))
5653 (vertical-motion (prefix-numeric-value arg
))
5654 (end-of-visual-line 1)
5655 (if (= (point) opoint
)
5657 ;; Skip any trailing whitespace at the end of the visual line.
5658 ;; We used to do this only if `show-trailing-whitespace' is
5659 ;; nil, but that's wrong; the correct thing would be to check
5660 ;; whether the trailing whitespace is highlighted. But, it's
5661 ;; OK to just do this unconditionally.
5662 (skip-chars-forward " \t")))
5663 (kill-region opoint
(if (and kill-whole-line
(looking-at "\n"))
5667 (defun next-logical-line (&optional arg try-vscroll
)
5668 "Move cursor vertically down ARG lines.
5669 This is identical to `next-line', except that it always moves
5670 by logical lines instead of visual lines, ignoring the value of
5671 the variable `line-move-visual'."
5672 (interactive "^p\np")
5673 (let ((line-move-visual nil
))
5675 (next-line arg try-vscroll
))))
5677 (defun previous-logical-line (&optional arg try-vscroll
)
5678 "Move cursor vertically up ARG lines.
5679 This is identical to `previous-line', except that it always moves
5680 by logical lines instead of visual lines, ignoring the value of
5681 the variable `line-move-visual'."
5682 (interactive "^p\np")
5683 (let ((line-move-visual nil
))
5685 (previous-line arg try-vscroll
))))
5687 (defgroup visual-line nil
5688 "Editing based on visual lines."
5692 (defvar visual-line-mode-map
5693 (let ((map (make-sparse-keymap)))
5694 (define-key map
[remap kill-line
] 'kill-visual-line
)
5695 (define-key map
[remap move-beginning-of-line
] 'beginning-of-visual-line
)
5696 (define-key map
[remap move-end-of-line
] 'end-of-visual-line
)
5697 ;; These keybindings interfere with xterm function keys. Are
5698 ;; there any other suitable bindings?
5699 ;; (define-key map "\M-[" 'previous-logical-line)
5700 ;; (define-key map "\M-]" 'next-logical-line)
5703 (defcustom visual-line-fringe-indicators
'(nil nil
)
5704 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5705 The value should be a list of the form (LEFT RIGHT), where LEFT
5706 and RIGHT are symbols representing the bitmaps to display, to
5707 indicate wrapped lines, in the left and right fringes respectively.
5708 See also `fringe-indicator-alist'.
5709 The default is not to display fringe indicators for wrapped lines.
5710 This variable does not affect fringe indicators displayed for
5712 :type
'(list (choice (const :tag
"Hide left indicator" nil
)
5713 (const :tag
"Left curly arrow" left-curly-arrow
)
5714 (symbol :tag
"Other bitmap"))
5715 (choice (const :tag
"Hide right indicator" nil
)
5716 (const :tag
"Right curly arrow" right-curly-arrow
)
5717 (symbol :tag
"Other bitmap")))
5718 :set
(lambda (symbol value
)
5719 (dolist (buf (buffer-list))
5720 (with-current-buffer buf
5721 (when (and (boundp 'visual-line-mode
)
5722 (symbol-value 'visual-line-mode
))
5723 (setq fringe-indicator-alist
5724 (cons (cons 'continuation value
)
5727 (copy-tree fringe-indicator-alist
)))))))
5728 (set-default symbol value
)))
5730 (defvar visual-line--saved-state nil
)
5732 (define-minor-mode visual-line-mode
5733 "Toggle visual line based editing (Visual Line mode).
5734 With a prefix argument ARG, enable Visual Line mode if ARG is
5735 positive, and disable it otherwise. If called from Lisp, enable
5736 the mode if ARG is omitted or nil.
5738 When Visual Line mode is enabled, `word-wrap' is turned on in
5739 this buffer, and simple editing commands are redefined to act on
5740 visual lines, not logical lines. See Info node `Visual Line
5742 :keymap visual-line-mode-map
5745 (if visual-line-mode
5747 (set (make-local-variable 'visual-line--saved-state
) nil
)
5748 ;; Save the local values of some variables, to be restored if
5749 ;; visual-line-mode is turned off.
5750 (dolist (var '(line-move-visual truncate-lines
5751 truncate-partial-width-windows
5752 word-wrap fringe-indicator-alist
))
5753 (if (local-variable-p var
)
5754 (push (cons var
(symbol-value var
))
5755 visual-line--saved-state
)))
5756 (set (make-local-variable 'line-move-visual
) t
)
5757 (set (make-local-variable 'truncate-partial-width-windows
) nil
)
5758 (setq truncate-lines nil
5760 fringe-indicator-alist
5761 (cons (cons 'continuation visual-line-fringe-indicators
)
5762 fringe-indicator-alist
)))
5763 (kill-local-variable 'line-move-visual
)
5764 (kill-local-variable 'word-wrap
)
5765 (kill-local-variable 'truncate-lines
)
5766 (kill-local-variable 'truncate-partial-width-windows
)
5767 (kill-local-variable 'fringe-indicator-alist
)
5768 (dolist (saved visual-line--saved-state
)
5769 (set (make-local-variable (car saved
)) (cdr saved
)))
5770 (kill-local-variable 'visual-line--saved-state
)))
5772 (defun turn-on-visual-line-mode ()
5773 (visual-line-mode 1))
5775 (define-globalized-minor-mode global-visual-line-mode
5776 visual-line-mode turn-on-visual-line-mode
)
5779 (defun transpose-chars (arg)
5780 "Interchange characters around point, moving forward one character.
5781 With prefix arg ARG, effect is to take character before point
5782 and drag it forward past ARG other characters (backward if ARG negative).
5783 If no argument and at end of line, the previous two chars are exchanged."
5785 (and (null arg
) (eolp) (forward-char -
1))
5786 (transpose-subr 'forward-char
(prefix-numeric-value arg
)))
5788 (defun transpose-words (arg)
5789 "Interchange words around point, leaving point at end of them.
5790 With prefix arg ARG, effect is to take word before or around point
5791 and drag it forward past ARG other words (backward if ARG negative).
5792 If ARG is zero, the words around or after point and around or after mark
5794 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5796 (transpose-subr 'forward-word arg
))
5798 (defun transpose-sexps (arg)
5799 "Like \\[transpose-words] but applies to sexps.
5800 Does not work on a sexp that point is in the middle of
5801 if it is a list or string."
5805 ;; Here we should try to simulate the behavior of
5806 ;; (cons (progn (forward-sexp x) (point))
5807 ;; (progn (forward-sexp (- x)) (point)))
5808 ;; Except that we don't want to rely on the second forward-sexp
5809 ;; putting us back to where we want to be, since forward-sexp-function
5810 ;; might do funny things like infix-precedence.
5812 (looking-at "\\sw\\|\\s_")
5814 (save-excursion (forward-char -
1) (looking-at "\\sw\\|\\s_"))))
5815 ;; Jumping over a symbol. We might be inside it, mind you.
5816 (progn (funcall (if (> arg
0)
5817 'skip-syntax-backward
'skip-syntax-forward
)
5819 (cons (save-excursion (forward-sexp arg
) (point)) (point)))
5820 ;; Otherwise, we're between sexps. Take a step back before jumping
5821 ;; to make sure we'll obey the same precedence no matter which direction
5823 (funcall (if (> arg
0) 'skip-syntax-backward
'skip-syntax-forward
) " .")
5824 (cons (save-excursion (forward-sexp arg
) (point))
5825 (progn (while (or (forward-comment (if (> arg
0) 1 -
1))
5826 (not (zerop (funcall (if (> arg
0)
5827 'skip-syntax-forward
5828 'skip-syntax-backward
)
5833 (defun transpose-lines (arg)
5834 "Exchange current line and previous line, leaving point after both.
5835 With argument ARG, takes previous line and moves it past ARG lines.
5836 With argument 0, interchanges line point is in with line mark is in."
5838 (transpose-subr (function
5842 ;; Move forward over ARG lines,
5843 ;; but create newlines if necessary.
5844 (setq arg
(forward-line arg
))
5845 (if (/= (preceding-char) ?
\n)
5846 (setq arg
(1+ arg
)))
5849 (forward-line arg
))))
5852 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5853 ;; which seems inconsistent with the ARG /= 0 case.
5854 ;; FIXME document SPECIAL.
5855 (defun transpose-subr (mover arg
&optional special
)
5856 "Subroutine to do the work of transposing objects.
5857 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5858 moves forward by units of the given object (e.g. forward-sentence,
5859 forward-paragraph). If ARG is zero, exchanges the current object
5860 with the one containing mark. If ARG is an integer, moves the
5861 current object past ARG following (if ARG is positive) or
5862 preceding (if ARG is negative) objects, leaving point after the
5864 (let ((aux (if special mover
5866 (cons (progn (funcall mover x
) (point))
5867 (progn (funcall mover
(- x
)) (point))))))
5872 (setq pos1
(funcall aux
1))
5873 (goto-char (or (mark) (error "No mark set in this buffer")))
5874 (setq pos2
(funcall aux
1))
5875 (transpose-subr-1 pos1 pos2
))
5876 (exchange-point-and-mark))
5878 (setq pos1
(funcall aux -
1))
5879 (setq pos2
(funcall aux arg
))
5880 (transpose-subr-1 pos1 pos2
)
5881 (goto-char (car pos2
)))
5883 (setq pos1
(funcall aux -
1))
5884 (goto-char (car pos1
))
5885 (setq pos2
(funcall aux arg
))
5886 (transpose-subr-1 pos1 pos2
)))))
5888 (defun transpose-subr-1 (pos1 pos2
)
5889 (when (> (car pos1
) (cdr pos1
)) (setq pos1
(cons (cdr pos1
) (car pos1
))))
5890 (when (> (car pos2
) (cdr pos2
)) (setq pos2
(cons (cdr pos2
) (car pos2
))))
5891 (when (> (car pos1
) (car pos2
))
5893 (setq pos1 pos2 pos2 swap
)))
5894 (if (> (cdr pos1
) (car pos2
)) (error "Don't have two things to transpose"))
5895 (atomic-change-group
5896 ;; This sequence of insertions attempts to preserve marker
5897 ;; positions at the start and end of the transposed objects.
5898 (let* ((word (buffer-substring (car pos2
) (cdr pos2
)))
5899 (len1 (- (cdr pos1
) (car pos1
)))
5900 (len2 (length word
))
5901 (boundary (make-marker)))
5902 (set-marker boundary
(car pos2
))
5903 (goto-char (cdr pos1
))
5904 (insert-before-markers word
)
5905 (setq word
(delete-and-extract-region (car pos1
) (+ (car pos1
) len1
)))
5906 (goto-char boundary
)
5908 (goto-char (+ boundary len1
))
5909 (delete-region (point) (+ (point) len2
))
5910 (set-marker boundary nil
))))
5912 (defun backward-word (&optional arg
)
5913 "Move backward until encountering the beginning of a word.
5914 With argument ARG, do this that many times.
5915 If ARG is omitted or nil, move point backward one word."
5917 (forward-word (- (or arg
1))))
5919 (defun mark-word (&optional arg allow-extend
)
5920 "Set mark ARG words away from point.
5921 The place mark goes is the same place \\[forward-word] would
5922 move to with the same argument.
5923 Interactively, if this command is repeated
5924 or (in Transient Mark mode) if the mark is active,
5925 it marks the next ARG words after the ones already marked."
5926 (interactive "P\np")
5927 (cond ((and allow-extend
5928 (or (and (eq last-command this-command
) (mark t
))
5930 (setq arg
(if arg
(prefix-numeric-value arg
)
5931 (if (< (mark) (point)) -
1 1)))
5940 (forward-word (prefix-numeric-value arg
))
5944 (defun kill-word (arg)
5945 "Kill characters forward until encountering the end of a word.
5946 With argument ARG, do this that many times."
5948 (kill-region (point) (progn (forward-word arg
) (point))))
5950 (defun backward-kill-word (arg)
5951 "Kill characters backward until encountering the beginning of a word.
5952 With argument ARG, do this that many times."
5954 (kill-word (- arg
)))
5956 (defun current-word (&optional strict really-word
)
5957 "Return the symbol or word that point is on (or a nearby one) as a string.
5958 The return value includes no text properties.
5959 If optional arg STRICT is non-nil, return nil unless point is within
5960 or adjacent to a symbol or word. In all cases the value can be nil
5961 if there is no word nearby.
5962 The function, belying its name, normally finds a symbol.
5963 If optional arg REALLY-WORD is non-nil, it finds just a word."
5965 (let* ((oldpoint (point)) (start (point)) (end (point))
5966 (syntaxes (if really-word
"w" "w_"))
5967 (not-syntaxes (concat "^" syntaxes
)))
5968 (skip-syntax-backward syntaxes
) (setq start
(point))
5969 (goto-char oldpoint
)
5970 (skip-syntax-forward syntaxes
) (setq end
(point))
5971 (when (and (eq start oldpoint
) (eq end oldpoint
)
5972 ;; Point is neither within nor adjacent to a word.
5974 ;; Look for preceding word in same line.
5975 (skip-syntax-backward not-syntaxes
(line-beginning-position))
5977 ;; No preceding word in same line.
5978 ;; Look for following word in same line.
5980 (skip-syntax-forward not-syntaxes
(line-end-position))
5981 (setq start
(point))
5982 (skip-syntax-forward syntaxes
)
5985 (skip-syntax-backward syntaxes
)
5986 (setq start
(point))))
5987 ;; If we found something nonempty, return it as a string.
5988 (unless (= start end
)
5989 (buffer-substring-no-properties start end
)))))
5991 (defcustom fill-prefix nil
5992 "String for filling to insert at front of new line, or nil for none."
5993 :type
'(choice (const :tag
"None" nil
)
5996 (make-variable-buffer-local 'fill-prefix
)
5997 (put 'fill-prefix
'safe-local-variable
'string-or-null-p
)
5999 (defcustom auto-fill-inhibit-regexp nil
6000 "Regexp to match lines which should not be auto-filled."
6001 :type
'(choice (const :tag
"None" nil
)
6005 (defun do-auto-fill ()
6006 "The default value for `normal-auto-fill-function'.
6007 This is the default auto-fill function, some major modes use a different one.
6008 Returns t if it really did any work."
6009 (let (fc justify give-up
6010 (fill-prefix fill-prefix
))
6011 (if (or (not (setq justify
(current-justification)))
6012 (null (setq fc
(current-fill-column)))
6013 (and (eq justify
'left
)
6014 (<= (current-column) fc
))
6015 (and auto-fill-inhibit-regexp
6016 (save-excursion (beginning-of-line)
6017 (looking-at auto-fill-inhibit-regexp
))))
6018 nil
;; Auto-filling not required
6019 (if (memq justify
'(full center right
))
6020 (save-excursion (unjustify-current-line)))
6022 ;; Choose a fill-prefix automatically.
6023 (when (and adaptive-fill-mode
6024 (or (null fill-prefix
) (string= fill-prefix
"")))
6026 (fill-context-prefix
6027 (save-excursion (fill-forward-paragraph -
1) (point))
6028 (save-excursion (fill-forward-paragraph 1) (point)))))
6029 (and prefix
(not (equal prefix
""))
6030 ;; Use auto-indentation rather than a guessed empty prefix.
6031 (not (and fill-indent-according-to-mode
6032 (string-match "\\`[ \t]*\\'" prefix
)))
6033 (setq fill-prefix prefix
))))
6035 (while (and (not give-up
) (> (current-column) fc
))
6036 ;; Determine where to split the line.
6041 (setq after-prefix
(point))
6043 (looking-at (regexp-quote fill-prefix
))
6044 (setq after-prefix
(match-end 0)))
6045 (move-to-column (1+ fc
))
6046 (fill-move-to-break-point after-prefix
)
6049 ;; See whether the place we found is any good.
6051 (goto-char fill-point
)
6053 ;; There is no use breaking at end of line.
6054 (save-excursion (skip-chars-forward " ") (eolp))
6055 ;; It is futile to split at the end of the prefix
6056 ;; since we would just insert the prefix again.
6057 (and after-prefix
(<= (point) after-prefix
))
6058 ;; Don't split right after a comment starter
6059 ;; since we would just make another comment starter.
6060 (and comment-start-skip
6061 (let ((limit (point)))
6063 (and (re-search-forward comment-start-skip
6065 (eq (point) limit
))))))
6066 ;; No good place to break => stop trying.
6068 ;; Ok, we have a useful place to break the line. Do it.
6069 (let ((prev-column (current-column)))
6070 ;; If point is at the fill-point, do not `save-excursion'.
6071 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6072 ;; point will end up before it rather than after it.
6074 (skip-chars-backward " \t")
6075 (= (point) fill-point
))
6076 (default-indent-new-line t
)
6078 (goto-char fill-point
)
6079 (default-indent-new-line t
)))
6080 ;; Now do justification, if required
6081 (if (not (eq justify
'left
))
6084 (justify-current-line justify nil t
)))
6085 ;; If making the new line didn't reduce the hpos of
6086 ;; the end of the line, then give up now;
6087 ;; trying again will not help.
6088 (if (>= (current-column) prev-column
)
6089 (setq give-up t
))))))
6090 ;; Justify last line.
6091 (justify-current-line justify t t
)
6094 (defvar comment-line-break-function
'comment-indent-new-line
6095 "Mode-specific function which line breaks and continues a comment.
6096 This function is called during auto-filling when a comment syntax
6098 The function should take a single optional argument, which is a flag
6099 indicating whether it should use soft newlines.")
6101 (defun default-indent-new-line (&optional soft
)
6102 "Break line at point and indent.
6103 If a comment syntax is defined, call `comment-indent-new-line'.
6105 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6106 unless optional argument SOFT is non-nil."
6109 (funcall comment-line-break-function soft
)
6110 ;; Insert the newline before removing empty space so that markers
6111 ;; get preserved better.
6112 (if soft
(insert-and-inherit ?
\n) (newline 1))
6113 (save-excursion (forward-char -
1) (delete-horizontal-space))
6114 (delete-horizontal-space)
6116 (if (and fill-prefix
(not adaptive-fill-mode
))
6117 ;; Blindly trust a non-adaptive fill-prefix.
6119 (indent-to-left-margin)
6120 (insert-before-markers-and-inherit fill-prefix
))
6123 ;; If there's an adaptive prefix, use it unless we're inside
6124 ;; a comment and the prefix is not a comment starter.
6126 (indent-to-left-margin)
6127 (insert-and-inherit fill-prefix
))
6128 ;; If we're not inside a comment, just try to indent.
6129 (t (indent-according-to-mode))))))
6131 (defvar normal-auto-fill-function
'do-auto-fill
6132 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6133 Some major modes set this.")
6135 (put 'auto-fill-function
:minor-mode-function
'auto-fill-mode
)
6136 ;; `functions' and `hooks' are usually unsafe to set, but setting
6137 ;; auto-fill-function to nil in a file-local setting is safe and
6138 ;; can be useful to prevent auto-filling.
6139 (put 'auto-fill-function
'safe-local-variable
'null
)
6141 (define-minor-mode auto-fill-mode
6142 "Toggle automatic line breaking (Auto Fill mode).
6143 With a prefix argument ARG, enable Auto Fill mode if ARG is
6144 positive, and disable it otherwise. If called from Lisp, enable
6145 the mode if ARG is omitted or nil.
6147 When Auto Fill mode is enabled, inserting a space at a column
6148 beyond `current-fill-column' automatically breaks the line at a
6151 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6154 The value of `normal-auto-fill-function' specifies the function to use
6155 for `auto-fill-function' when turning Auto Fill mode on."
6156 :variable
(auto-fill-function
6157 .
(lambda (v) (setq auto-fill-function
6158 (if v normal-auto-fill-function
)))))
6160 ;; This holds a document string used to document auto-fill-mode.
6161 (defun auto-fill-function ()
6162 "Automatically break line at a previous space, in insertion of text."
6165 (defun turn-on-auto-fill ()
6166 "Unconditionally turn on Auto Fill mode."
6169 (defun turn-off-auto-fill ()
6170 "Unconditionally turn off Auto Fill mode."
6171 (auto-fill-mode -
1))
6173 (custom-add-option 'text-mode-hook
'turn-on-auto-fill
)
6175 (defun set-fill-column (arg)
6176 "Set `fill-column' to specified argument.
6177 Use \\[universal-argument] followed by a number to specify a column.
6178 Just \\[universal-argument] as argument means to use the current column."
6180 (list (or current-prefix-arg
6181 ;; We used to use current-column silently, but C-x f is too easily
6182 ;; typed as a typo for C-x C-f, so we turned it into an error and
6183 ;; now an interactive prompt.
6184 (read-number "Set fill-column to: " (current-column)))))
6186 (setq arg
(current-column)))
6187 (if (not (integerp arg
))
6188 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6189 (error "set-fill-column requires an explicit argument")
6190 (message "Fill column set to %d (was %d)" arg fill-column
)
6191 (setq fill-column arg
)))
6193 (defun set-selective-display (arg)
6194 "Set `selective-display' to ARG; clear it if no arg.
6195 When the value of `selective-display' is a number > 0,
6196 lines whose indentation is >= that value are not displayed.
6197 The variable `selective-display' has a separate value for each buffer."
6199 (if (eq selective-display t
)
6200 (error "selective-display already in use for marked lines"))
6203 (narrow-to-region (point-min) (point))
6204 (goto-char (window-start))
6205 (vertical-motion (window-height)))))
6206 (setq selective-display
6207 (and arg
(prefix-numeric-value arg
)))
6208 (recenter current-vpos
))
6209 (set-window-start (selected-window) (window-start))
6210 (princ "selective-display set to " t
)
6211 (prin1 selective-display t
)
6214 (defvaralias 'indicate-unused-lines
'indicate-empty-lines
)
6216 (defun toggle-truncate-lines (&optional arg
)
6217 "Toggle truncating of long lines for the current buffer.
6218 When truncating is off, long lines are folded.
6219 With prefix argument ARG, truncate long lines if ARG is positive,
6220 otherwise fold them. Note that in side-by-side windows, this
6221 command has no effect if `truncate-partial-width-windows' is
6224 (setq truncate-lines
6226 (not truncate-lines
)
6227 (> (prefix-numeric-value arg
) 0)))
6228 (force-mode-line-update)
6229 (unless truncate-lines
6230 (let ((buffer (current-buffer)))
6231 (walk-windows (lambda (window)
6232 (if (eq buffer
(window-buffer window
))
6233 (set-window-hscroll window
0)))
6235 (message "Truncate long lines %s"
6236 (if truncate-lines
"enabled" "disabled")))
6238 (defun toggle-word-wrap (&optional arg
)
6239 "Toggle whether to use word-wrapping for continuation lines.
6240 With prefix argument ARG, wrap continuation lines at word boundaries
6241 if ARG is positive, otherwise wrap them at the right screen edge.
6242 This command toggles the value of `word-wrap'. It has no effect
6243 if long lines are truncated."
6248 (> (prefix-numeric-value arg
) 0)))
6249 (force-mode-line-update)
6250 (message "Word wrapping %s"
6251 (if word-wrap
"enabled" "disabled")))
6253 (defvar overwrite-mode-textual
(purecopy " Ovwrt")
6254 "The string displayed in the mode line when in overwrite mode.")
6255 (defvar overwrite-mode-binary
(purecopy " Bin Ovwrt")
6256 "The string displayed in the mode line when in binary overwrite mode.")
6258 (define-minor-mode overwrite-mode
6259 "Toggle Overwrite mode.
6260 With a prefix argument ARG, enable Overwrite mode if ARG is
6261 positive, and disable it otherwise. If called from Lisp, enable
6262 the mode if ARG is omitted or nil.
6264 When Overwrite mode is enabled, printing characters typed in
6265 replace existing text on a one-for-one basis, rather than pushing
6266 it to the right. At the end of a line, such characters extend
6267 the line. Before a tab, such characters insert until the tab is
6268 filled in. \\[quoted-insert] still inserts characters in
6269 overwrite mode; this is supposed to make it easier to insert
6270 characters when necessary."
6271 :variable
(overwrite-mode
6272 .
(lambda (v) (setq overwrite-mode
(if v
'overwrite-mode-textual
)))))
6274 (define-minor-mode binary-overwrite-mode
6275 "Toggle Binary Overwrite mode.
6276 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6277 is positive, and disable it otherwise. If called from Lisp,
6278 enable the mode if ARG is omitted or nil.
6280 When Binary Overwrite mode is enabled, printing characters typed
6281 in replace existing text. Newlines are not treated specially, so
6282 typing at the end of a line joins the line to the next, with the
6283 typed character between them. Typing before a tab character
6284 simply replaces the tab with the character typed.
6285 \\[quoted-insert] replaces the text at the cursor, just as
6286 ordinary typing characters do.
6288 Note that Binary Overwrite mode is not its own minor mode; it is
6289 a specialization of overwrite mode, entered by setting the
6290 `overwrite-mode' variable to `overwrite-mode-binary'."
6291 :variable
(overwrite-mode
6292 .
(lambda (v) (setq overwrite-mode
(if v
'overwrite-mode-binary
)))))
6294 (define-minor-mode line-number-mode
6295 "Toggle line number display in the mode line (Line Number mode).
6296 With a prefix argument ARG, enable Line Number mode if ARG is
6297 positive, and disable it otherwise. If called from Lisp, enable
6298 the mode if ARG is omitted or nil.
6300 Line numbers do not appear for very large buffers and buffers
6301 with very long lines; see variables `line-number-display-limit'
6302 and `line-number-display-limit-width'."
6303 :init-value t
:global t
:group
'mode-line
)
6305 (define-minor-mode column-number-mode
6306 "Toggle column number display in the mode line (Column Number mode).
6307 With a prefix argument ARG, enable Column Number mode if ARG is
6308 positive, and disable it otherwise.
6310 If called from Lisp, enable the mode if ARG is omitted or nil."
6311 :global t
:group
'mode-line
)
6313 (define-minor-mode size-indication-mode
6314 "Toggle buffer size display in the mode line (Size Indication mode).
6315 With a prefix argument ARG, enable Size Indication mode if ARG is
6316 positive, and disable it otherwise.
6318 If called from Lisp, enable the mode if ARG is omitted or nil."
6319 :global t
:group
'mode-line
)
6321 (define-minor-mode auto-save-mode
6322 "Toggle auto-saving in the current buffer (Auto Save mode).
6323 With a prefix argument ARG, enable Auto Save mode if ARG is
6324 positive, and disable it otherwise.
6326 If called from Lisp, enable the mode if ARG is omitted or nil."
6327 :variable
((and buffer-auto-save-file-name
6328 ;; If auto-save is off because buffer has shrunk,
6329 ;; then toggling should turn it on.
6330 (>= buffer-saved-size
0))
6332 (setq buffer-auto-save-file-name
6335 ((and buffer-file-name auto-save-visited-file-name
6336 (not buffer-read-only
))
6338 (t (make-auto-save-file-name))))))
6339 ;; If -1 was stored here, to temporarily turn off saving,
6341 (and (< buffer-saved-size
0)
6342 (setq buffer-saved-size
0)))
6344 (defgroup paren-blinking nil
6345 "Blinking matching of parens and expressions."
6346 :prefix
"blink-matching-"
6347 :group
'paren-matching
)
6349 (defcustom blink-matching-paren t
6350 "Non-nil means show matching open-paren when close-paren is inserted.
6351 If t, highlight the paren. If `jump', move cursor to its position."
6353 (const :tag
"Disable" nil
)
6354 (const :tag
"Highlight" t
)
6355 (const :tag
"Move cursor" jump
))
6356 :group
'paren-blinking
)
6358 (defcustom blink-matching-paren-on-screen t
6359 "Non-nil means show matching open-paren when it is on screen.
6360 If nil, don't show it (but the open-paren can still be shown
6361 when it is off screen).
6363 This variable has no effect if `blink-matching-paren' is nil.
6364 \(In that case, the open-paren is never shown.)
6365 It is also ignored if `show-paren-mode' is enabled."
6367 :group
'paren-blinking
)
6369 (defcustom blink-matching-paren-distance
(* 100 1024)
6370 "If non-nil, maximum distance to search backwards for matching open-paren.
6371 If nil, search stops at the beginning of the accessible portion of the buffer."
6372 :version
"23.2" ; 25->100k
6373 :type
'(choice (const nil
) integer
)
6374 :group
'paren-blinking
)
6376 (defcustom blink-matching-delay
1
6377 "Time in seconds to delay after showing a matching paren."
6379 :group
'paren-blinking
)
6381 (defcustom blink-matching-paren-dont-ignore-comments nil
6382 "If nil, `blink-matching-paren' ignores comments.
6383 More precisely, when looking for the matching parenthesis,
6384 it skips the contents of comments that end before point."
6386 :group
'paren-blinking
)
6388 (defun blink-matching-check-mismatch (start end
)
6389 "Return whether or not START...END are matching parens.
6390 END is the current point and START is the blink position.
6391 START might be nil if no matching starter was found.
6392 Returns non-nil if we find there is a mismatch."
6393 (let* ((end-syntax (syntax-after (1- end
)))
6394 (matching-paren (and (consp end-syntax
)
6395 (eq (syntax-class end-syntax
) 5)
6397 ;; For self-matched chars like " and $, we can't know when they're
6398 ;; mismatched or unmatched, so we can only do it for parens.
6399 (when matching-paren
6402 (eq (char-after start
) matching-paren
)
6403 ;; The cdr might hold a new paren-class info rather than
6404 ;; a matching-char info, in which case the two CDRs
6406 (eq matching-paren
(cdr-safe (syntax-after start
)))))))))
6408 (defvar blink-matching-check-function
#'blink-matching-check-mismatch
6409 "Function to check parentheses mismatches.
6410 The function takes two arguments (START and END) where START is the
6411 position just before the opening token and END is the position right after.
6412 START can be nil, if it was not found.
6413 The function should return non-nil if the two tokens do not match.")
6415 (defvar blink-matching--overlay
6416 (let ((ol (make-overlay (point) (point) nil t
)))
6417 (overlay-put ol
'face
'show-paren-match
)
6420 "Overlay used to highlight the matching paren.")
6422 (defun blink-matching-open ()
6423 "Momentarily highlight the beginning of the sexp before point."
6425 (when (and (not (bobp))
6426 blink-matching-paren
)
6427 (let* ((oldpos (point))
6428 (message-log-max nil
) ; Don't log messages about paren matching.
6432 (if blink-matching-paren-distance
6434 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
6435 (- (point) blink-matching-paren-distance
))
6437 (let ((parse-sexp-ignore-comments
6438 (and parse-sexp-ignore-comments
6439 (not blink-matching-paren-dont-ignore-comments
))))
6443 ;; backward-sexp skips backward over prefix chars,
6444 ;; so move back to the matching paren.
6445 (while (and (< (point) (1- oldpos
))
6446 (let ((code (syntax-after (point))))
6447 (or (eq (syntax-class code
) 6)
6448 (eq (logand 1048576 (car code
))
6453 (mismatch (funcall blink-matching-check-function blinkpos oldpos
)))
6458 (minibuffer-message "Mismatched parentheses")
6459 (message "Mismatched parentheses"))
6461 (minibuffer-message "No matching parenthesis found")
6462 (message "No matching parenthesis found"))))
6463 ((not blinkpos
) nil
)
6464 ((pos-visible-in-window-p blinkpos
)
6465 ;; Matching open within window, temporarily move to or highlight
6466 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6468 (and blink-matching-paren-on-screen
6469 (not show-paren-mode
)
6470 (if (eq blink-matching-paren
'jump
)
6472 (goto-char blinkpos
)
6473 (sit-for blink-matching-delay
))
6476 (move-overlay blink-matching--overlay blinkpos
(1+ blinkpos
)
6478 (sit-for blink-matching-delay
))
6479 (delete-overlay blink-matching--overlay
)))))
6482 (goto-char blinkpos
)
6483 (let ((open-paren-line-string
6484 ;; Show what precedes the open in its line, if anything.
6486 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
6487 (buffer-substring (line-beginning-position)
6489 ;; Show what follows the open in its line, if anything.
6492 (skip-chars-forward " \t")
6494 (buffer-substring blinkpos
6495 (line-end-position)))
6496 ;; Otherwise show the previous nonblank line,
6498 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
6500 (buffer-substring (progn
6501 (skip-chars-backward "\n \t")
6502 (line-beginning-position))
6503 (progn (end-of-line)
6504 (skip-chars-backward " \t")
6506 ;; Replace the newline and other whitespace with `...'.
6508 (buffer-substring blinkpos
(1+ blinkpos
))))
6509 ;; There is nothing to show except the char itself.
6510 (t (buffer-substring blinkpos
(1+ blinkpos
))))))
6511 (message "Matches %s"
6512 (substring-no-properties open-paren-line-string
)))))))))
6514 (defvar blink-paren-function
'blink-matching-open
6515 "Function called, if non-nil, whenever a close parenthesis is inserted.
6516 More precisely, a char with closeparen syntax is self-inserted.")
6518 (defun blink-paren-post-self-insert-function ()
6519 (when (and (eq (char-before) last-command-event
) ; Sanity check.
6520 (memq (char-syntax last-command-event
) '(?\
) ?\$
))
6521 blink-paren-function
6522 (not executing-kbd-macro
)
6523 (not noninteractive
)
6524 ;; Verify an even number of quoting characters precede the close.
6525 (= 1 (logand 1 (- (point)
6528 (skip-syntax-backward "/\\")
6530 (funcall blink-paren-function
)))
6532 (put 'blink-paren-post-self-insert-function
'priority
100)
6534 (add-hook 'post-self-insert-hook
#'blink-paren-post-self-insert-function
6535 ;; Most likely, this hook is nil, so this arg doesn't matter,
6536 ;; but I use it as a reminder that this function usually
6537 ;; likes to be run after others since it does
6538 ;; `sit-for'. That's also the reason it get a `priority' prop
6542 ;; This executes C-g typed while Emacs is waiting for a command.
6543 ;; Quitting out of a program does not go through here;
6544 ;; that happens in the QUIT macro at the C code level.
6545 (defun keyboard-quit ()
6546 "Signal a `quit' condition.
6547 During execution of Lisp code, this character causes a quit directly.
6548 At top-level, as an editor command, this simply beeps."
6550 ;; Avoid adding the region to the window selection.
6551 (setq saved-region-selection nil
)
6552 (let (select-active-regions)
6554 (if (fboundp 'kmacro-keyboard-quit
)
6555 (kmacro-keyboard-quit))
6556 (setq defining-kbd-macro nil
)
6557 (let ((debug-on-quit nil
))
6558 (signal 'quit nil
)))
6560 (defvar buffer-quit-function nil
6561 "Function to call to \"quit\" the current buffer, or nil if none.
6562 \\[keyboard-escape-quit] calls this function when its more local actions
6563 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
6565 (defun keyboard-escape-quit ()
6566 "Exit the current \"mode\" (in a generalized sense of the word).
6567 This command can exit an interactive command such as `query-replace',
6568 can clear out a prefix argument or a region,
6569 can get out of the minibuffer or other recursive edit,
6570 cancel the use of the current buffer (for special-purpose buffers),
6571 or go back to just one window (by deleting all but the selected window)."
6573 (cond ((eq last-command
'mode-exited
) nil
)
6576 ((> (minibuffer-depth) 0)
6577 (abort-recursive-edit))
6580 ((> (recursion-depth) 0)
6581 (exit-recursive-edit))
6582 (buffer-quit-function
6583 (funcall buffer-quit-function
))
6584 ((not (one-window-p t
))
6585 (delete-other-windows))
6586 ((string-match "^ \\*" (buffer-name (current-buffer)))
6589 (defun play-sound-file (file &optional volume device
)
6590 "Play sound stored in FILE.
6591 VOLUME and DEVICE correspond to the keywords of the sound
6592 specification for `play-sound'."
6593 (interactive "fPlay sound file: ")
6594 (let ((sound (list :file file
)))
6596 (plist-put sound
:volume volume
))
6598 (plist-put sound
:device device
))
6600 (play-sound sound
)))
6603 (defcustom read-mail-command
'rmail
6604 "Your preference for a mail reading package.
6605 This is used by some keybindings which support reading mail.
6606 See also `mail-user-agent' concerning sending mail."
6607 :type
'(radio (function-item :tag
"Rmail" :format
"%t\n" rmail
)
6608 (function-item :tag
"Gnus" :format
"%t\n" gnus
)
6609 (function-item :tag
"Emacs interface to MH"
6610 :format
"%t\n" mh-rmail
)
6611 (function :tag
"Other"))
6615 (defcustom mail-user-agent
'message-user-agent
6616 "Your preference for a mail composition package.
6617 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6618 outgoing email message. This variable lets you specify which
6619 mail-sending package you prefer.
6621 Valid values include:
6623 `message-user-agent' -- use the Message package.
6624 See Info node `(message)'.
6625 `sendmail-user-agent' -- use the Mail package.
6626 See Info node `(emacs)Sending Mail'.
6627 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6628 See Info node `(mh-e)'.
6629 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6630 paraphernalia if Gnus is running, particularly
6631 the Gcc: header for archiving.
6633 Additional valid symbols may be available; check with the author of
6634 your package for details. The function should return non-nil if it
6637 See also `read-mail-command' concerning reading mail."
6638 :type
'(radio (function-item :tag
"Message package"
6641 (function-item :tag
"Mail package"
6643 sendmail-user-agent
)
6644 (function-item :tag
"Emacs interface to MH"
6647 (function-item :tag
"Message with full Gnus features"
6650 (function :tag
"Other"))
6651 :version
"23.2" ; sendmail->message
6654 (defcustom compose-mail-user-agent-warnings t
6655 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6656 If the value of `mail-user-agent' is the default, and the user
6657 appears to have customizations applying to the old default,
6658 `compose-mail' issues a warning."
6663 (defun rfc822-goto-eoh ()
6664 "If the buffer starts with a mail header, move point to the header's end.
6665 Otherwise, moves to `point-min'.
6666 The end of the header is the start of the next line, if there is one,
6667 else the end of the last line. This function obeys RFC822."
6668 (goto-char (point-min))
6669 (when (re-search-forward
6670 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil
'move
)
6671 (goto-char (match-beginning 0))))
6673 ;; Used by Rmail (e.g., rmail-forward).
6674 (defvar mail-encode-mml nil
6675 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6676 the outgoing message before sending it.")
6678 (defun compose-mail (&optional to subject other-headers continue
6679 switch-function yank-action send-actions
6681 "Start composing a mail message to send.
6682 This uses the user's chosen mail composition package
6683 as selected with the variable `mail-user-agent'.
6684 The optional arguments TO and SUBJECT specify recipients
6685 and the initial Subject field, respectively.
6687 OTHER-HEADERS is an alist specifying additional
6688 header fields. Elements look like (HEADER . VALUE) where both
6689 HEADER and VALUE are strings.
6691 CONTINUE, if non-nil, says to continue editing a message already
6692 being composed. Interactively, CONTINUE is the prefix argument.
6694 SWITCH-FUNCTION, if non-nil, is a function to use to
6695 switch to and display the buffer used for mail composition.
6697 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6698 to insert the raw text of the message being replied to.
6699 It has the form (FUNCTION . ARGS). The user agent will apply
6700 FUNCTION to ARGS, to insert the raw text of the original message.
6701 \(The user agent will also run `mail-citation-hook', *after* the
6702 original text has been inserted in this way.)
6704 SEND-ACTIONS is a list of actions to call when the message is sent.
6705 Each action has the form (FUNCTION . ARGS).
6707 RETURN-ACTION, if non-nil, is an action for returning to the
6708 caller. It has the form (FUNCTION . ARGS). The function is
6709 called after the mail has been sent or put aside, and the mail
6712 (list nil nil nil current-prefix-arg
))
6714 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6715 ;; from sendmail-user-agent to message-user-agent. Some users may
6716 ;; encounter incompatibilities. This hack tries to detect problems
6717 ;; and warn about them.
6718 (and compose-mail-user-agent-warnings
6719 (eq mail-user-agent
'message-user-agent
)
6721 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6722 mail-yank-hooks mail-archive-file-name
6723 mail-default-reply-to mail-mailing-lists
6727 (push var warn-vars
)))
6729 (display-warning 'mail
6731 The default mail mode is now Message mode.
6732 You have the following Mail mode variable%s customized:
6733 \n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
6734 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6735 (if (> (length warn-vars
) 1) "s" "")
6736 (mapconcat 'symbol-name
6739 (let ((function (get mail-user-agent
'composefunc
)))
6740 (funcall function to subject other-headers continue switch-function
6741 yank-action send-actions return-action
)))
6743 (defun compose-mail-other-window (&optional to subject other-headers continue
6744 yank-action send-actions
6746 "Like \\[compose-mail], but edit the outgoing message in another window."
6747 (interactive (list nil nil nil current-prefix-arg
))
6748 (compose-mail to subject other-headers continue
6749 'switch-to-buffer-other-window yank-action send-actions
6752 (defun compose-mail-other-frame (&optional to subject other-headers continue
6753 yank-action send-actions
6755 "Like \\[compose-mail], but edit the outgoing message in another frame."
6756 (interactive (list nil nil nil current-prefix-arg
))
6757 (compose-mail to subject other-headers continue
6758 'switch-to-buffer-other-frame yank-action send-actions
6762 (defvar set-variable-value-history nil
6763 "History of values entered with `set-variable'.
6765 Maximum length of the history list is determined by the value
6766 of `history-length', which see.")
6768 (defun set-variable (variable value
&optional make-local
)
6769 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6770 VARIABLE should be a user option variable name, a Lisp variable
6771 meant to be customized by users. You should enter VALUE in Lisp syntax,
6772 so if you want VALUE to be a string, you must surround it with doublequotes.
6773 VALUE is used literally, not evaluated.
6775 If VARIABLE has a `variable-interactive' property, that is used as if
6776 it were the arg to `interactive' (which see) to interactively read VALUE.
6778 If VARIABLE has been defined with `defcustom', then the type information
6779 in the definition is used to check that VALUE is valid.
6781 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6783 (let* ((default-var (variable-at-point))
6784 (var (if (custom-variable-p default-var
)
6785 (read-variable (format "Set variable (default %s): " default-var
)
6787 (read-variable "Set variable: ")))
6788 (minibuffer-help-form '(describe-variable var
))
6789 (prop (get var
'variable-interactive
))
6790 (obsolete (car (get var
'byte-obsolete-variable
)))
6791 (prompt (format "Set %s %s to value: " var
6792 (cond ((local-variable-p var
)
6794 ((or current-prefix-arg
6795 (local-variable-if-set-p var
))
6800 (message (concat "`%S' is obsolete; "
6801 (if (symbolp obsolete
) "use `%S' instead" "%s"))
6805 ;; Use VAR's `variable-interactive' property
6806 ;; as an interactive spec for prompting.
6807 (call-interactively `(lambda (arg)
6810 (read-from-minibuffer prompt nil
6811 read-expression-map t
6812 'set-variable-value-history
6813 (format "%S" (symbol-value var
)))))))
6814 (list var val current-prefix-arg
)))
6816 (and (custom-variable-p variable
)
6817 (not (get variable
'custom-type
))
6818 (custom-load-symbol variable
))
6819 (let ((type (get variable
'custom-type
)))
6821 ;; Match with custom type.
6823 (setq type
(widget-convert type
))
6824 (unless (widget-apply type
:match value
)
6825 (error "Value `%S' does not match type %S of %S"
6826 value
(car type
) variable
))))
6829 (make-local-variable variable
))
6831 (set variable value
)
6833 ;; Force a thorough redisplay for the case that the variable
6834 ;; has an effect on the display, like `tab-width' has.
6835 (force-mode-line-update))
6837 ;; Define the major mode for lists of completions.
6839 (defvar completion-list-mode-map
6840 (let ((map (make-sparse-keymap)))
6841 (define-key map
[mouse-2
] 'mouse-choose-completion
)
6842 (define-key map
[follow-link
] 'mouse-face
)
6843 (define-key map
[down-mouse-2
] nil
)
6844 (define-key map
"\C-m" 'choose-completion
)
6845 (define-key map
"\e\e\e" 'delete-completion-window
)
6846 (define-key map
[left] 'previous-completion)
6847 (define-key map [right] 'next-completion)
6848 (define-key map "q" 'quit-window)
6849 (define-key map "z" 'kill-this-buffer)
6851 "Local map for completion list buffers.")
6853 ;; Completion mode is suitable only for specially formatted data.
6854 (put 'completion-list-mode 'mode-class 'special)
6856 (defvar completion-reference-buffer nil
6857 "Record the buffer that was current when the completion list was requested.
6858 This is a local variable in the completion list buffer.
6859 Initial value is nil to avoid some compiler warnings.")
6861 (defvar completion-no-auto-exit nil
6862 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6863 This also applies to other functions such as `choose-completion'.")
6865 (defvar completion-base-position nil
6866 "Position of the base of the text corresponding to the shown completions.
6867 This variable is used in the *Completions* buffers.
6868 Its value is a list of the form (START END) where START is the place
6869 where the completion should be inserted and END (if non-nil) is the end
6870 of the text to replace. If END is nil, point is used instead.")
6872 (defvar completion-list-insert-choice-function #'completion--replace
6873 "Function to use to insert the text chosen in *Completions*.
6874 Called with three arguments (BEG END TEXT), it should replace the text
6875 between BEG and END with TEXT. Expected to be set buffer-locally
6876 in the *Completions* buffer.")
6878 (defvar completion-base-size nil
6879 "Number of chars before point not involved in completion.
6880 This is a local variable in the completion list buffer.
6881 It refers to the chars in the minibuffer if completing in the
6882 minibuffer, or in `completion-reference-buffer' otherwise.
6883 Only characters in the field at point are included.
6885 If nil, Emacs determines which part of the tail end of the
6886 buffer's text is involved in completion by comparing the text
6888 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6890 (defun delete-completion-window ()
6891 "Delete the completion list window.
6892 Go to the window from which completion was requested."
6894 (let ((buf completion-reference-buffer))
6895 (if (one-window-p t)
6896 (if (window-dedicated-p) (delete-frame))
6897 (delete-window (selected-window))
6898 (if (get-buffer-window buf)
6899 (select-window (get-buffer-window buf))))))
6901 (defun previous-completion (n)
6902 "Move to the previous item in the completion list."
6904 (next-completion (- n)))
6906 (defun next-completion (n)
6907 "Move to the next item in the completion list.
6908 With prefix argument N, move N items (negative N means move backward)."
6910 (let ((beg (point-min)) (end (point-max)))
6911 (while (and (> n 0) (not (eobp)))
6912 ;; If in a completion, move to the end of it.
6913 (when (get-text-property (point) 'mouse-face)
6914 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6915 ;; Move to start of next one.
6916 (unless (get-text-property (point) 'mouse-face)
6917 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6919 (while (and (< n 0) (not (bobp)))
6920 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6921 ;; If in a completion, move to the start of it.
6922 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6923 (goto-char (previous-single-property-change
6924 (point) 'mouse-face nil beg)))
6925 ;; Move to end of the previous completion.
6926 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6927 (goto-char (previous-single-property-change
6928 (point) 'mouse-face nil beg)))
6929 ;; Move to the start of that one.
6930 (goto-char (previous-single-property-change
6931 (point) 'mouse-face nil beg))
6934 (defun choose-completion (&optional event)
6935 "Choose the completion at point.
6936 If EVENT, use EVENT's position to determine the starting position."
6937 (interactive (list last-nonmenu-event))
6938 ;; In case this is run via the mouse, give temporary modes such as
6939 ;; isearch a chance to turn off.
6940 (run-hooks 'mouse-leave-buffer-hook)
6941 (with-current-buffer (window-buffer (posn-window (event-start event)))
6942 (let ((buffer completion-reference-buffer)
6943 (base-size completion-base-size)
6944 (base-position completion-base-position)
6945 (insert-function completion-list-insert-choice-function)
6948 (goto-char (posn-point (event-start event)))
6951 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6952 (setq end (point) beg (1+ (point))))
6954 (get-text-property (1- (point)) 'mouse-face))
6955 (setq end (1- (point)) beg (point)))
6956 (t (error "No completion here")))
6957 (setq beg (previous-single-property-change beg 'mouse-face))
6958 (setq end (or (next-single-property-change end 'mouse-face)
6960 (buffer-substring-no-properties beg end)))))
6962 (unless (buffer-live-p buffer)
6963 (error "Destination buffer is dead"))
6964 (quit-window nil (posn-window (event-start event)))
6966 (with-current-buffer buffer
6967 (choose-completion-string
6971 ;; Someone's using old completion code that doesn't know
6972 ;; about base-position yet.
6973 (list (+ base-size (field-beginning))))
6974 ;; If all else fails, just guess.
6975 (list (choose-completion-guess-base-position choice)))
6976 insert-function)))))
6978 ;; Delete the longest partial match for STRING
6979 ;; that can be found before POINT.
6980 (defun choose-completion-guess-base-position (string)
6982 (let ((opoint (point))
6984 ;; Try moving back by the length of the string.
6985 (goto-char (max (- (point) (length string))
6986 (minibuffer-prompt-end)))
6987 ;; See how far back we were actually able to move. That is the
6988 ;; upper bound on how much we can match and delete.
6989 (setq len (- opoint (point)))
6990 (if completion-ignore-case
6991 (setq string (downcase string)))
6992 (while (and (> len 0)
6993 (let ((tail (buffer-substring (point) opoint)))
6994 (if completion-ignore-case
6995 (setq tail (downcase tail)))
6996 (not (string= tail (substring string 0 len)))))
7001 (defun choose-completion-delete-max-match (string)
7002 (declare (obsolete choose-completion-guess-base-position "23.2"))
7003 (delete-region (choose-completion-guess-base-position string) (point)))
7005 (defvar choose-completion-string-functions nil
7006 "Functions that may override the normal insertion of a completion choice.
7007 These functions are called in order with three arguments:
7008 CHOICE - the string to insert in the buffer,
7009 BUFFER - the buffer in which the choice should be inserted,
7010 BASE-POSITION - where to insert the completion.
7012 If a function in the list returns non-nil, that function is supposed
7013 to have inserted the CHOICE in the BUFFER, and possibly exited
7014 the minibuffer; no further functions will be called.
7016 If all functions in the list return nil, that means to use
7017 the default method of inserting the completion in BUFFER.")
7019 (defun choose-completion-string (choice &optional
7020 buffer base-position insert-function)
7021 "Switch to BUFFER and insert the completion choice CHOICE.
7022 BASE-POSITION says where to insert the completion.
7023 INSERT-FUNCTION says how to insert the completion and falls
7024 back on `completion-list-insert-choice-function' when nil."
7026 ;; If BUFFER is the minibuffer, exit the minibuffer
7027 ;; unless it is reading a file name and CHOICE is a directory,
7028 ;; or completion-no-auto-exit is non-nil.
7030 ;; Some older code may call us passing `base-size' instead of
7031 ;; `base-position'. It's difficult to make any use of `base-size',
7032 ;; so we just ignore it.
7033 (unless (consp base-position)
7034 (message "Obsolete `base-size' passed to choose-completion-string")
7035 (setq base-position nil))
7037 (let* ((buffer (or buffer completion-reference-buffer))
7038 (mini-p (minibufferp buffer)))
7039 ;; If BUFFER is a minibuffer, barf unless it's the currently
7040 ;; active minibuffer.
7042 (not (and (active-minibuffer-window)
7044 (window-buffer (active-minibuffer-window))))))
7045 (error "Minibuffer is not active for completion")
7046 ;; Set buffer so buffer-local choose-completion-string-functions works.
7048 (unless (run-hook-with-args-until-success
7049 'choose-completion-string-functions
7050 ;; The fourth arg used to be `mini-p' but was useless
7051 ;; (since minibufferp can be used on the `buffer' arg)
7052 ;; and indeed unused. The last used to be `base-size', so we
7053 ;; keep it to try and avoid breaking old code.
7054 choice buffer base-position nil)
7055 ;; This remove-text-properties should be unnecessary since `choice'
7056 ;; comes from buffer-substring-no-properties.
7057 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7058 ;; Insert the completion into the buffer where it was requested.
7059 (funcall (or insert-function completion-list-insert-choice-function)
7060 (or (car base-position) (point))
7061 (or (cadr base-position) (point))
7063 ;; Update point in the window that BUFFER is showing in.
7064 (let ((window (get-buffer-window buffer t)))
7065 (set-window-point window (point)))
7066 ;; If completing for the minibuffer, exit it with this choice.
7067 (and (not completion-no-auto-exit)
7068 (minibufferp buffer)
7069 minibuffer-completion-table
7070 ;; If this is reading a file name, and the file name chosen
7071 ;; is a directory, don't exit the minibuffer.
7072 (let* ((result (buffer-substring (field-beginning) (point)))
7074 (completion-boundaries result minibuffer-completion-table
7075 minibuffer-completion-predicate
7077 (if (eq (car bounds) (length result))
7078 ;; The completion chosen leads to a new set of completions
7079 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7080 (let ((mini (active-minibuffer-window)))
7081 (select-window mini)
7082 (when minibuffer-auto-raise
7083 (raise-frame (window-frame mini))))
7084 (exit-minibuffer))))))))
7086 (define-derived-mode completion-list-mode nil "Completion List"
7087 "Major mode for buffers showing lists of possible completions.
7088 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
7089 to select the completion near point.
7090 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
7093 \\{completion-list-mode-map}"
7094 (set (make-local-variable 'completion-base-size) nil))
7096 (defun completion-list-mode-finish ()
7097 "Finish setup of the completions buffer.
7098 Called from `temp-buffer-show-hook'."
7099 (when (eq major-mode 'completion-list-mode)
7100 (setq buffer-read-only t)))
7102 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7105 ;; Variables and faces used in `completion-setup-function'.
7107 (defcustom completion-show-help t
7108 "Non-nil means show help message in *Completions* buffer."
7113 ;; This function goes in completion-setup-hook, so that it is called
7114 ;; after the text of the completion list buffer is written.
7115 (defun completion-setup-function ()
7116 (let* ((mainbuf (current-buffer))
7118 ;; FIXME: This is a bad hack. We try to set the default-directory
7119 ;; in the *Completions* buffer so that the relative file names
7120 ;; displayed there can be treated as valid file names, independently
7121 ;; from the completion context. But this suffers from many problems:
7122 ;; - It's not clear when the completions are file names. With some
7123 ;; completion tables (e.g. bzr revision specs), the listed
7124 ;; completions can mix file names and other things.
7125 ;; - It doesn't pay attention to possible quoting.
7126 ;; - With fancy completion styles, the code below will not always
7127 ;; find the right base directory.
7128 (if minibuffer-completing-file-name
7129 (file-name-as-directory
7131 (buffer-substring (minibuffer-prompt-end)
7132 (- (point) (or completion-base-size 0))))))))
7133 (with-current-buffer standard-output
7134 (let ((base-size completion-base-size) ;Read before killing localvars.
7135 (base-position completion-base-position)
7136 (insert-fun completion-list-insert-choice-function))
7137 (completion-list-mode)
7138 (set (make-local-variable 'completion-base-size) base-size)
7139 (set (make-local-variable 'completion-base-position) base-position)
7140 (set (make-local-variable 'completion-list-insert-choice-function)
7142 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7143 (if base-dir (setq default-directory base-dir))
7144 ;; Maybe insert help string.
7145 (when completion-show-help
7146 (goto-char (point-min))
7147 (if (display-mouse-p)
7148 (insert (substitute-command-keys
7149 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
7150 (insert (substitute-command-keys
7151 "In this buffer, type \\[choose-completion] to \
7152 select the completion near point.\n\n"))))))
7154 (add-hook 'completion-setup-hook 'completion-setup-function)
7156 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7157 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7159 (defun switch-to-completions ()
7160 "Select the completion list window."
7162 (let ((window (or (get-buffer-window "*Completions*" 0)
7163 ;; Make sure we have a completions window.
7164 (progn (minibuffer-completion-help)
7165 (get-buffer-window "*Completions*" 0)))))
7167 (select-window window)
7168 ;; In the new buffer, go to the first completion.
7169 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7171 (next-completion 1)))))
7173 ;;; Support keyboard commands to turn on various modifiers.
7175 ;; These functions -- which are not commands -- each add one modifier
7176 ;; to the following event.
7178 (defun event-apply-alt-modifier (_ignore-prompt)
7179 "\\<function-key-map>Add the Alt modifier to the following event.
7180 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
7181 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7182 (defun event-apply-super-modifier (_ignore-prompt)
7183 "\\<function-key-map>Add the Super modifier to the following event.
7184 For example, type \\[event-apply-super-modifier] & to enter Super-&."
7185 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7186 (defun event-apply-hyper-modifier (_ignore-prompt)
7187 "\\<function-key-map>Add the Hyper modifier to the following event.
7188 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
7189 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7190 (defun event-apply-shift-modifier (_ignore-prompt)
7191 "\\<function-key-map>Add the Shift modifier to the following event.
7192 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
7193 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7194 (defun event-apply-control-modifier (_ignore-prompt)
7195 "\\<function-key-map>Add the Ctrl modifier to the following event.
7196 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
7197 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7198 (defun event-apply-meta-modifier (_ignore-prompt)
7199 "\\<function-key-map>Add the Meta modifier to the following event.
7200 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
7201 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7203 (defun event-apply-modifier (event symbol lshiftby prefix)
7204 "Apply a modifier flag to event EVENT.
7205 SYMBOL is the name of this modifier, as a symbol.
7206 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7207 PREFIX is the string that represents this modifier in an event type symbol."
7209 (cond ((eq symbol 'control)
7210 (if (and (<= (downcase event) ?z)
7211 (>= (downcase event) ?a))
7212 (- (downcase event) ?a -1)
7213 (if (and (<= (downcase event) ?Z)
7214 (>= (downcase event) ?A))
7215 (- (downcase event) ?A -1)
7216 (logior (lsh 1 lshiftby) event))))
7218 (if (and (<= (downcase event) ?z)
7219 (>= (downcase event) ?a))
7221 (logior (lsh 1 lshiftby) event)))
7223 (logior (lsh 1 lshiftby) event)))
7224 (if (memq symbol (event-modifiers event))
7226 (let ((event-type (if (symbolp event) event (car event))))
7227 (setq event-type (intern (concat prefix (symbol-name event-type))))
7230 (cons event-type (cdr event)))))))
7232 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7233 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7234 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7235 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7236 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7237 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7239 ;;;; Keypad support.
7241 ;; Make the keypad keys act like ordinary typing keys. If people add
7242 ;; bindings for the function key symbols, then those bindings will
7243 ;; override these, so this shouldn't interfere with any existing
7246 ;; Also tell read-char how to handle these keys.
7248 (lambda (keypad-normal)
7249 (let ((keypad (nth 0 keypad-normal))
7250 (normal (nth 1 keypad-normal)))
7251 (put keypad 'ascii-character normal)
7252 (define-key function-key-map (vector keypad) (vector normal))))
7253 ;; See also kp-keys bound in bindings.el.
7259 ;; Do the same for various keys that are represented as symbols under
7260 ;; GUIs but naturally correspond to characters.
7271 ;;;; forking a twin copy of a buffer.
7274 (defvar clone-buffer-hook nil
7275 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7277 (defvar clone-indirect-buffer-hook nil
7278 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7280 (defun clone-process (process &optional newname)
7281 "Create a twin copy of PROCESS.
7282 If NEWNAME is nil, it defaults to PROCESS' name;
7283 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7284 If PROCESS is associated with a buffer, the new process will be associated
7285 with the current buffer instead.
7286 Returns nil if PROCESS has already terminated."
7287 (setq newname (or newname (process-name process)))
7288 (if (string-match "<[0-9]+>\\'" newname)
7289 (setq newname (substring newname 0 (match-beginning 0))))
7290 (when (memq (process-status process) '(run stop open))
7291 (let* ((process-connection-type (process-tty-name process))
7293 (if (memq (process-status process) '(open))
7294 (let ((args (process-contact process t)))
7295 (setq args (plist-put args :name newname))
7296 (setq args (plist-put args :buffer
7297 (if (process-buffer process)
7299 (apply 'make-network-process args))
7300 (apply 'start-process newname
7301 (if (process-buffer process) (current-buffer))
7302 (process-command process)))))
7303 (set-process-query-on-exit-flag
7304 new-process (process-query-on-exit-flag process))
7305 (set-process-inherit-coding-system-flag
7306 new-process (process-inherit-coding-system-flag process))
7307 (set-process-filter new-process (process-filter process))
7308 (set-process-sentinel new-process (process-sentinel process))
7309 (set-process-plist new-process (copy-sequence (process-plist process)))
7312 ;; things to maybe add (currently partly covered by `funcall mode'):
7315 (defun clone-buffer (&optional newname display-flag)
7316 "Create and return a twin copy of the current buffer.
7317 Unlike an indirect buffer, the new buffer can be edited
7318 independently of the old one (if it is not read-only).
7319 NEWNAME is the name of the new buffer. It may be modified by
7320 adding or incrementing <N> at the end as necessary to create a
7321 unique buffer name. If nil, it defaults to the name of the
7322 current buffer, with the proper suffix. If DISPLAY-FLAG is
7323 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7324 clone a file-visiting buffer, or a buffer whose major mode symbol
7325 has a non-nil `no-clone' property, results in an error.
7327 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7328 current buffer with appropriate suffix. However, if a prefix
7329 argument is given, then the command prompts for NEWNAME in the
7332 This runs the normal hook `clone-buffer-hook' in the new buffer
7333 after it has been set up properly in other respects."
7336 (if buffer-file-name
7337 (error "Cannot clone a file-visiting buffer"))
7338 (if (get major-mode 'no-clone)
7339 (error "Cannot clone a buffer in %s mode" mode-name))
7340 (list (if current-prefix-arg
7341 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7343 (if buffer-file-name
7344 (error "Cannot clone a file-visiting buffer"))
7345 (if (get major-mode 'no-clone)
7346 (error "Cannot clone a buffer in %s mode" mode-name))
7347 (setq newname (or newname (buffer-name)))
7348 (if (string-match "<[0-9]+>\\'" newname)
7349 (setq newname (substring newname 0 (match-beginning 0))))
7350 (let ((buf (current-buffer))
7354 (mk (if mark-active (mark t)))
7355 (modified (buffer-modified-p))
7357 (lvars (buffer-local-variables))
7358 (process (get-buffer-process (current-buffer)))
7359 (new (generate-new-buffer (or newname (buffer-name)))))
7362 (with-current-buffer new
7363 (insert-buffer-substring buf)))
7364 (with-current-buffer new
7365 (narrow-to-region ptmin ptmax)
7367 (if mk (set-mark mk))
7368 (set-buffer-modified-p modified)
7370 ;; Clone the old buffer's process, if any.
7371 (when process (clone-process process))
7373 ;; Now set up the major mode.
7376 ;; Set up other local variables.
7378 (condition-case () ;in case var is read-only
7381 (set (make-local-variable (car v)) (cdr v)))
7385 ;; Run any hooks (typically set up by the major mode
7386 ;; for cloning to work properly).
7387 (run-hooks 'clone-buffer-hook))
7389 ;; Presumably the current buffer is shown in the selected frame, so
7390 ;; we want to display the clone elsewhere.
7391 (let ((same-window-regexps nil)
7392 (same-window-buffer-names))
7393 (pop-to-buffer new)))
7397 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7398 "Create an indirect buffer that is a twin copy of the current buffer.
7400 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7401 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7402 or if not called with a prefix arg, NEWNAME defaults to the current
7403 buffer's name. The name is modified by adding a `<N>' suffix to it
7404 or by incrementing the N in an existing suffix. Trying to clone a
7405 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7406 property results in an error.
7408 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7409 This is always done when called interactively.
7411 Optional third arg NORECORD non-nil means do not put this buffer at the
7412 front of the list of recently selected ones."
7415 (if (get major-mode 'no-clone-indirect)
7416 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7417 (list (if current-prefix-arg
7418 (read-buffer "Name of indirect buffer: " (current-buffer)))
7420 (if (get major-mode 'no-clone-indirect)
7421 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7422 (setq newname (or newname (buffer-name)))
7423 (if (string-match "<[0-9]+>\\'" newname)
7424 (setq newname (substring newname 0 (match-beginning 0))))
7425 (let* ((name (generate-new-buffer-name newname))
7426 (buffer (make-indirect-buffer (current-buffer) name t)))
7427 (with-current-buffer buffer
7428 (run-hooks 'clone-indirect-buffer-hook))
7430 (pop-to-buffer buffer norecord))
7434 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7435 "Like `clone-indirect-buffer' but display in another window."
7438 (if (get major-mode 'no-clone-indirect)
7439 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7440 (list (if current-prefix-arg
7441 (read-buffer "Name of indirect buffer: " (current-buffer)))
7443 (let ((pop-up-windows t))
7444 (clone-indirect-buffer newname display-flag norecord)))
7447 ;;; Handling of Backspace and Delete keys.
7449 (defcustom normal-erase-is-backspace 'maybe
7450 "Set the default behavior of the Delete and Backspace keys.
7452 If set to t, Delete key deletes forward and Backspace key deletes
7455 If set to nil, both Delete and Backspace keys delete backward.
7457 If set to 'maybe (which is the default), Emacs automatically
7458 selects a behavior. On window systems, the behavior depends on
7459 the keyboard used. If the keyboard has both a Backspace key and
7460 a Delete key, and both are mapped to their usual meanings, the
7461 option's default value is set to t, so that Backspace can be used
7462 to delete backward, and Delete can be used to delete forward.
7464 If not running under a window system, customizing this option
7465 accomplishes a similar effect by mapping C-h, which is usually
7466 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7467 via `keyboard-translate'. The former functionality of C-h is
7468 available on the F1 key. You should probably not use this
7469 setting if you don't have both Backspace, Delete and F1 keys.
7471 Setting this variable with setq doesn't take effect. Programmatically,
7472 call `normal-erase-is-backspace-mode' (which see) instead."
7473 :type '(choice (const :tag "Off" nil)
7474 (const :tag "Maybe" maybe)
7475 (other :tag "On" t))
7476 :group 'editing-basics
7478 :set (lambda (symbol value)
7479 ;; The fboundp is because of a problem with :set when
7480 ;; dumping Emacs. It doesn't really matter.
7481 (if (fboundp 'normal-erase-is-backspace-mode)
7482 (normal-erase-is-backspace-mode (or value 0))
7483 (set-default symbol value))))
7485 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7486 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7487 (unless frame (setq frame (selected-frame)))
7488 (with-selected-frame frame
7489 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7490 (normal-erase-is-backspace-mode
7491 (if (if (eq normal-erase-is-backspace 'maybe)
7492 (and (not noninteractive)
7493 (or (memq system-type '(ms-dos windows-nt))
7494 (memq window-system '(w32 ns))
7495 (and (memq window-system '(x))
7496 (fboundp 'x-backspace-delete-keys-p)
7497 (x-backspace-delete-keys-p))
7498 ;; If the terminal Emacs is running on has erase char
7499 ;; set to ^H, use the Backspace key for deleting
7500 ;; backward, and the Delete key for deleting forward.
7501 (and (null window-system)
7502 (eq tty-erase-char ?\^H))))
7503 normal-erase-is-backspace)
7506 (define-minor-mode normal-erase-is-backspace-mode
7507 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7508 With a prefix argument ARG, enable this feature if ARG is
7509 positive, and disable it otherwise. If called from Lisp, enable
7510 the mode if ARG is omitted or nil.
7512 On window systems, when this mode is on, Delete is mapped to C-d
7513 and Backspace is mapped to DEL; when this mode is off, both
7514 Delete and Backspace are mapped to DEL. (The remapping goes via
7515 `local-function-key-map', so binding Delete or Backspace in the
7516 global or local keymap will override that.)
7518 In addition, on window systems, the bindings of C-Delete, M-Delete,
7519 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7520 the global keymap in accordance with the functionality of Delete and
7521 Backspace. For example, if Delete is remapped to C-d, which deletes
7522 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7523 to DEL, which deletes backward, C-Delete is bound to
7524 `backward-kill-word'.
7526 If not running on a window system, a similar effect is accomplished by
7527 remapping C-h (normally produced by the Backspace key) and DEL via
7528 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7529 to C-d; if it's off, the keys are not remapped.
7531 When not running on a window system, and this mode is turned on, the
7532 former functionality of C-h is available on the F1 key. You should
7533 probably not turn on this mode on a text-only terminal if you don't
7534 have both Backspace, Delete and F1 keys.
7536 See also `normal-erase-is-backspace'."
7537 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7539 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7541 (let ((enabled (eq 1 (terminal-parameter
7542 nil 'normal-erase-is-backspace))))
7544 (cond ((or (memq window-system '(x w32 ns pc))
7545 (memq system-type '(ms-dos windows-nt)))
7547 `(([M-delete] [M-backspace])
7548 ([C-M-delete] [C-M-backspace])
7549 ([?\e C-delete] [?\e C-backspace]))))
7553 (define-key local-function-key-map [delete] [deletechar])
7554 (define-key local-function-key-map [kp-delete] [deletechar])
7555 (define-key local-function-key-map [backspace] [?\C-?])
7556 (dolist (b bindings)
7557 ;; Not sure if input-decode-map is really right, but
7558 ;; keyboard-translate-table (used below) only works
7559 ;; for integer events, and key-translation-table is
7560 ;; global (like the global-map, used earlier).
7561 (define-key input-decode-map (car b) nil)
7562 (define-key input-decode-map (cadr b) nil)))
7563 (define-key local-function-key-map [delete] [?\C-?])
7564 (define-key local-function-key-map [kp-delete] [?\C-?])
7565 (define-key local-function-key-map [backspace] [?\C-?])
7566 (dolist (b bindings)
7567 (define-key input-decode-map (car b) (cadr b))
7568 (define-key input-decode-map (cadr b) (car b))))))
7572 (keyboard-translate ?\C-h ?\C-?)
7573 (keyboard-translate ?\C-? ?\C-d))
7574 (keyboard-translate ?\C-h ?\C-h)
7575 (keyboard-translate ?\C-? ?\C-?))))
7577 (if (called-interactively-p 'interactive)
7578 (message "Delete key deletes %s"
7579 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7580 "forward" "backward")))))
7582 (defvar vis-mode-saved-buffer-invisibility-spec nil
7583 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7585 (define-minor-mode read-only-mode
7586 "Change whether the current buffer is read-only.
7587 With prefix argument ARG, make the buffer read-only if ARG is
7588 positive, otherwise make it writable. If buffer is read-only
7589 and `view-read-only' is non-nil, enter view mode.
7591 Do not call this from a Lisp program unless you really intend to
7592 do the same thing as the \\[read-only-mode] command, including
7593 possibly enabling or disabling View mode. Also, note that this
7594 command works by setting the variable `buffer-read-only', which
7595 does not affect read-only regions caused by text properties. To
7596 ignore read-only status in a Lisp program (whether due to text
7597 properties or buffer state), bind `inhibit-read-only' temporarily
7598 to a non-nil value."
7599 :variable buffer-read-only
7601 ((and (not buffer-read-only) view-mode)
7602 (View-exit-and-edit)
7603 (make-local-variable 'view-read-only)
7604 (setq view-read-only t)) ; Must leave view mode.
7605 ((and buffer-read-only view-read-only
7606 ;; If view-mode is already active, `view-mode-enter' is a nop.
7608 (not (eq (get major-mode 'mode-class) 'special)))
7609 (view-mode-enter))))
7611 (define-minor-mode visible-mode
7612 "Toggle making all invisible text temporarily visible (Visible mode).
7613 With a prefix argument ARG, enable Visible mode if ARG is
7614 positive, and disable it otherwise. If called from Lisp, enable
7615 the mode if ARG is omitted or nil.
7617 This mode works by saving the value of `buffer-invisibility-spec'
7618 and setting it to nil."
7620 :group 'editing-basics
7621 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7622 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7623 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7625 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7626 buffer-invisibility-spec)
7627 (setq buffer-invisibility-spec nil)))
7629 (defvar messages-buffer-mode-map
7630 (let ((map (make-sparse-keymap)))
7631 (set-keymap-parent map special-mode-map)
7632 (define-key map "g" nil) ; nothing to revert
7635 (define-derived-mode messages-buffer-mode special-mode "Messages"
7636 "Major mode used in the \"*Messages*\" buffer.")
7638 (defun messages-buffer ()
7639 "Return the \"*Messages*\" buffer.
7640 If it does not exist, create and it switch it to `messages-buffer-mode'."
7641 (or (get-buffer "*Messages*")
7642 (with-current-buffer (get-buffer-create "*Messages*")
7643 (messages-buffer-mode)
7647 ;; Minibuffer prompt stuff.
7649 ;;(defun minibuffer-prompt-modification (start end)
7650 ;; (error "You cannot modify the prompt"))
7653 ;;(defun minibuffer-prompt-insertion (start end)
7654 ;; (let ((inhibit-modification-hooks t))
7655 ;; (delete-region start end)
7656 ;; ;; Discard undo information for the text insertion itself
7657 ;; ;; and for the text deletion.above.
7658 ;; (when (consp buffer-undo-list)
7659 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7660 ;; (message "You cannot modify the prompt")))
7663 ;;(setq minibuffer-prompt-properties
7664 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7665 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7668 ;;;; Problematic external packages.
7670 ;; rms says this should be done by specifying symbols that define
7671 ;; versions together with bad values. This is therefore not as
7672 ;; flexible as it could be. See the thread:
7673 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7674 (defconst bad-packages-alist
7675 ;; Not sure exactly which semantic versions have problems.
7676 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7677 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
7678 "The version of `semantic' loaded does not work in Emacs 22.
7679 It can cause constant high CPU load.
7680 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7681 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7682 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7683 ;; provided the `CUA-mode' feature. Since this is no longer true,
7684 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7686 "CUA-mode is now part of the standard GNU Emacs distribution,
7687 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7689 You have loaded an older version of CUA-mode which does not work
7690 correctly with this version of Emacs. You should remove the old
7691 version and use the one distributed with Emacs."))
7692 "Alist of packages known to cause problems in this version of Emacs.
7693 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7694 PACKAGE is either a regular expression to match file names, or a
7695 symbol (a feature name), like for `with-eval-after-load'.
7696 SYMBOL is either the name of a string variable, or `t'. Upon
7697 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7698 warning using STRING as the message.")
7700 (defun bad-package-check (package)
7701 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7703 (let* ((list (assoc package bad-packages-alist))
7704 (symbol (nth 1 list)))
7708 (and (stringp (setq symbol (eval symbol)))
7709 (string-match-p (nth 2 list) symbol)))
7710 (display-warning package (nth 3 list) :warning)))
7713 (dolist (elem bad-packages-alist)
7714 (let ((pkg (car elem)))
7715 (with-eval-after-load pkg
7716 (bad-package-check pkg))))
7719 ;;; Generic dispatcher commands
7721 ;; Macro `define-alternatives' is used to create generic commands.
7722 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7723 ;; that can have different alternative implementations where choosing
7724 ;; among them is exclusively a matter of user preference.
7726 ;; (define-alternatives COMMAND) creates a new interactive command
7727 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7728 ;; Typically, the user will not need to customize this variable; packages
7729 ;; wanting to add alternative implementations should use
7731 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7733 (defmacro define-alternatives (command &rest customizations)
7734 "Define the new command `COMMAND'.
7736 The argument `COMMAND' should be a symbol.
7738 Running `M-x COMMAND RET' for the first time prompts for which
7739 alternative to use and records the selected command as a custom
7742 Running `C-u M-x COMMAND RET' prompts again for an alternative
7743 and overwrites the previous choice.
7745 The variable `COMMAND-alternatives' contains an alist with
7746 alternative implementations of COMMAND. `define-alternatives'
7747 does not have any effect until this variable is set.
7749 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7750 `defcustom' keywords and values to add to the declaration of
7751 `COMMAND-alternatives' (typically :group and :version)."
7752 (let* ((command-name (symbol-name command))
7753 (varalt-name (concat command-name "-alternatives"))
7754 (varalt-sym (intern varalt-name))
7755 (varimp-sym (intern (concat command-name "--implementation"))))
7758 (defcustom ,varalt-sym nil
7759 ,(format "Alist of alternative implementations for the `%s' command.
7761 Each entry must be a pair (ALTNAME . ALTFUN), where:
7762 ALTNAME - The name shown at user to describe the alternative implementation.
7763 ALTFUN - The function called to implement this alternative."
7765 :type '(alist :key-type string :value-type function)
7768 (put ',varalt-sym 'definition-name ',command)
7769 (defvar ,varimp-sym nil "Internal use only.")
7771 (defun ,command (&optional arg)
7772 ,(format "Run generic command `%s'.
7773 If used for the first time, or with interactive ARG, ask the user which
7774 implementation to use for `%s'. The variable `%s'
7775 contains the list of implementations currently supported for this command."
7776 command-name command-name varalt-name)
7778 (when (or arg (null ,varimp-sym))
7779 (let ((val (completing-read
7780 ,(format "Select implementation for command `%s': "
7782 ,varalt-sym nil t)))
7783 (unless (string-equal val "")
7784 (when (null ,varimp-sym)
7786 "Use `C-u M-x %s RET' to select another implementation"
7789 (customize-save-variable ',varimp-sym
7790 (cdr (assoc-string val ,varalt-sym))))))
7792 (call-interactively ,varimp-sym)
7793 (message ,(format "No implementation selected for command `%s'"
7797 ;; This is here because files in obsolete/ are not scanned for autoloads.
7799 (defvar iswitchb-mode nil "\
7800 Non-nil if Iswitchb mode is enabled.
7801 See the command `iswitchb-mode' for a description of this minor mode.
7802 Setting this variable directly does not take effect;
7803 either customize it (see the info node `Easy Customization')
7804 or call the function `iswitchb-mode'.")
7806 (custom-autoload 'iswitchb-mode "iswitchb" nil)
7808 (autoload 'iswitchb-mode "iswitchb" "\
7809 Toggle Iswitchb mode.
7810 With a prefix argument ARG, enable Iswitchb mode if ARG is
7811 positive, and disable it otherwise. If called from Lisp, enable
7812 the mode if ARG is omitted or nil.
7814 Iswitchb mode is a global minor mode that enables switching
7815 between buffers using substrings. See `iswitchb' for details.
7817 \(fn &optional ARG)" t nil)
7819 (make-obsolete 'iswitchb-mode
7820 "use `icomplete-mode' or `ido-mode' instead." "24.4")
7825 ;;; simple.el ends here