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