]> code.delx.au - gnu-emacs/blob - lisp/simple.el
Fix bug #9392 with rmail-forward.
[gnu-emacs] / lisp / simple.el
1 ;;; simple.el --- basic editing commands for Emacs
2
3 ;; Copyright (C) 1985-1987, 1993-2011 Free Software Foundation, Inc.
4
5 ;; Maintainer: FSF
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)) ;For define-minor-mode.
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 "Test if BUFFER is a `next-error' capable buffer.
149
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
152
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
156
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
160 (and (buffer-name buffer) ;First make sure it's live.
161 (not (and avoid-current (eq buffer (current-buffer))))
162 (with-current-buffer buffer
163 (if next-error-function ; This is the normal test.
164 ;; Optionally reject some buffers.
165 (if extra-test-exclusive
166 (funcall extra-test-exclusive)
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 When turned on, cursor motion in the compilation, grep, occur or diff
325 buffer causes automatic display of the corresponding source code
326 location."
327 :group 'next-error :init-value nil :lighter " Fol"
328 (if (not next-error-follow-minor-mode)
329 (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t)
330 (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t)
331 (make-local-variable 'next-error-follow-last-line)))
332
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
335 (defun next-error-follow-mode-post-command-hook ()
336 (unless (equal next-error-follow-last-line (line-number-at-pos))
337 (setq next-error-follow-last-line (line-number-at-pos))
338 (condition-case nil
339 (let ((compilation-context-lines nil))
340 (setq compilation-current-error (point))
341 (next-error-no-select 0))
342 (error t))))
343
344 \f
345 ;;;
346
347 (defun fundamental-mode ()
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
350 (interactive)
351 (kill-all-local-variables)
352 (run-mode-hooks 'fundamental-mode-hook))
353
354 ;; Special major modes to view specially formatted data rather than files.
355
356 (defvar special-mode-map
357 (let ((map (make-sparse-keymap)))
358 (suppress-keymap map)
359 (define-key map "q" 'quit-window)
360 (define-key map " " 'scroll-up)
361 (define-key map "\C-?" 'scroll-down)
362 (define-key map "?" 'describe-mode)
363 (define-key map "h" 'describe-mode)
364 (define-key map ">" 'end-of-buffer)
365 (define-key map "<" 'beginning-of-buffer)
366 (define-key map "g" 'revert-buffer)
367 (define-key map "z" 'kill-this-buffer)
368 map))
369
370 (put 'special-mode 'mode-class 'special)
371 (define-derived-mode special-mode nil "Special"
372 "Parent major mode from which special major modes should inherit."
373 (setq buffer-read-only t))
374
375 ;; Major mode meant to be the parent of programming modes.
376
377 (defvar prog-mode-map
378 (let ((map (make-sparse-keymap)))
379 (define-key map [?\C-\M-q] 'prog-indent-sexp)
380 map)
381 "Keymap used for programming modes.")
382
383 (defun prog-indent-sexp ()
384 "Indent the expression after point."
385 (interactive)
386 (let ((start (point))
387 (end (save-excursion (forward-sexp 1) (point))))
388 (indent-region start end nil)))
389
390 (define-derived-mode prog-mode fundamental-mode "Prog"
391 "Major mode for editing programming language source code."
392 (set (make-local-variable 'require-final-newline) mode-require-final-newline)
393 (set (make-local-variable 'parse-sexp-ignore-comments) t)
394 ;; Any programming language is always written left to right.
395 (setq bidi-paragraph-direction 'left-to-right))
396
397 ;; Making and deleting lines.
398
399 (defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard))
400 "Propertized string representing a hard newline character.")
401
402 (defun newline (&optional arg)
403 "Insert a newline, and move to left margin of the new line if it's blank.
404 If `use-hard-newlines' is non-nil, the newline is marked with the
405 text-property `hard'.
406 With ARG, insert that many newlines.
407 Call `auto-fill-function' if the current column number is greater
408 than the value of `fill-column' and ARG is nil."
409 (interactive "*P")
410 (barf-if-buffer-read-only)
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
413 (let* ((was-page-start (and (bolp) (looking-at page-delimiter)))
414 (beforepos (point))
415 (last-command-event ?\n)
416 ;; Don't auto-fill if we have a numeric argument.
417 (auto-fill-function (if arg nil auto-fill-function))
418 (postproc
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
421 (lambda ()
422 ;; Mark the newline(s) `hard'.
423 (if use-hard-newlines
424 (set-hard-newline-properties
425 (- (point) (prefix-numeric-value arg)) (point)))
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
428 (save-excursion
429 (goto-char beforepos)
430 (beginning-of-line)
431 (and (looking-at "[ \t]$")
432 (> (current-left-margin) 0)
433 (delete-region (point)
434 (line-end-position))))
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
437 ;; starts a page.
438 (or was-page-start
439 (move-to-left-margin nil t)))))
440 (unwind-protect
441 (progn
442 (add-hook 'post-self-insert-hook postproc)
443 (self-insert-command (prefix-numeric-value arg)))
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
447 (remove-hook 'post-self-insert-hook postproc)))
448 nil)
449
450 (defun set-hard-newline-properties (from to)
451 (let ((sticky (get-text-property from 'rear-nonsticky)))
452 (put-text-property from to 'hard 't)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
454 (if (and (listp sticky) (not (memq 'hard sticky)))
455 (put-text-property from (point) 'rear-nonsticky
456 (cons 'hard sticky)))))
457
458 (defun open-line (n)
459 "Insert a newline and leave point before it.
460 If there is a fill prefix and/or a `left-margin', insert them
461 on the new line if the line would have been blank.
462 With arg N, insert N newlines."
463 (interactive "*p")
464 (let* ((do-fill-prefix (and fill-prefix (bolp)))
465 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
466 (loc (point-marker))
467 ;; Don't expand an abbrev before point.
468 (abbrev-mode nil))
469 (newline n)
470 (goto-char loc)
471 (while (> n 0)
472 (cond ((bolp)
473 (if do-left-margin (indent-to (current-left-margin)))
474 (if do-fill-prefix (insert-and-inherit fill-prefix))))
475 (forward-line 1)
476 (setq n (1- n)))
477 (goto-char loc)
478 (end-of-line)))
479
480 (defun split-line (&optional arg)
481 "Split current line, moving portion beyond point vertically down.
482 If the current line starts with `fill-prefix', insert it on the new
483 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
484
485 When called from Lisp code, ARG may be a prefix string to copy."
486 (interactive "*P")
487 (skip-chars-forward " \t")
488 (let* ((col (current-column))
489 (pos (point))
490 ;; What prefix should we check for (nil means don't).
491 (prefix (cond ((stringp arg) arg)
492 (arg nil)
493 (t fill-prefix)))
494 ;; Does this line start with it?
495 (have-prfx (and prefix
496 (save-excursion
497 (beginning-of-line)
498 (looking-at (regexp-quote prefix))))))
499 (newline 1)
500 (if have-prfx (insert-and-inherit prefix))
501 (indent-to col 0)
502 (goto-char pos)))
503
504 (defun delete-indentation (&optional arg)
505 "Join this line to previous and fix up whitespace at join.
506 If there is a fill prefix, delete it from the beginning of this line.
507 With argument, join this line to following line."
508 (interactive "*P")
509 (beginning-of-line)
510 (if arg (forward-line 1))
511 (if (eq (preceding-char) ?\n)
512 (progn
513 (delete-region (point) (1- (point)))
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
516 (if (and fill-prefix
517 (<= (+ (point) (length fill-prefix)) (point-max))
518 (string= fill-prefix
519 (buffer-substring (point)
520 (+ (point) (length fill-prefix)))))
521 (delete-region (point) (+ (point) (length fill-prefix))))
522 (fixup-whitespace))))
523
524 (defalias 'join-line #'delete-indentation) ; easier to find
525
526 (defun delete-blank-lines ()
527 "On blank line, delete all surrounding blank lines, leaving just one.
528 On isolated blank line, delete that one.
529 On nonblank line, delete any immediately following blank lines."
530 (interactive "*")
531 (let (thisblank singleblank)
532 (save-excursion
533 (beginning-of-line)
534 (setq thisblank (looking-at "[ \t]*$"))
535 ;; Set singleblank if there is just one blank line here.
536 (setq singleblank
537 (and thisblank
538 (not (looking-at "[ \t]*\n[ \t]*$"))
539 (or (bobp)
540 (progn (forward-line -1)
541 (not (looking-at "[ \t]*$")))))))
542 ;; Delete preceding blank lines, and this one too if it's the only one.
543 (if thisblank
544 (progn
545 (beginning-of-line)
546 (if singleblank (forward-line 1))
547 (delete-region (point)
548 (if (re-search-backward "[^ \t\n]" nil t)
549 (progn (forward-line 1) (point))
550 (point-min)))))
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
553 (if (not (and thisblank singleblank))
554 (save-excursion
555 (end-of-line)
556 (forward-line 1)
557 (delete-region (point)
558 (if (re-search-forward "[^ \t\n]" nil t)
559 (progn (beginning-of-line) (point))
560 (point-max)))))
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
563 (if (looking-at "^[ \t]*\n\\'")
564 (delete-region (point) (point-max)))))
565
566 (defun delete-trailing-whitespace (&optional start end)
567 "Delete all the trailing whitespace across the current buffer.
568 All whitespace after the last non-whitespace character in a line is deleted.
569 This respects narrowing, created by \\[narrow-to-region] and friends.
570 A formfeed is not considered whitespace by this function.
571 If the region is active, only delete whitespace within the region."
572 (interactive (progn
573 (barf-if-buffer-read-only)
574 (if (use-region-p)
575 (list (region-beginning) (region-end))
576 (list nil nil))))
577 (save-match-data
578 (save-excursion
579 (let ((end-marker (copy-marker (or end (point-max))))
580 (start (or start (point-min))))
581 (goto-char start)
582 (while (re-search-forward "\\s-$" end-marker t)
583 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
584 ;; Don't delete formfeeds, even if they are considered whitespace.
585 (save-match-data
586 (if (looking-at ".*\f")
587 (goto-char (match-end 0))))
588 (delete-region (point) (match-end 0)))
589 (set-marker end-marker nil))))
590 ;; Return nil for the benefit of `write-file-functions'.
591 nil)
592
593 (defun newline-and-indent ()
594 "Insert a newline, then indent according to major mode.
595 Indentation is done using the value of `indent-line-function'.
596 In programming language modes, this is the same as TAB.
597 In some text modes, where TAB inserts a tab, this command indents to the
598 column specified by the function `current-left-margin'."
599 (interactive "*")
600 (delete-horizontal-space t)
601 (newline)
602 (indent-according-to-mode))
603
604 (defun reindent-then-newline-and-indent ()
605 "Reindent current line, insert newline, then indent the new line.
606 Indentation of both lines is done according to the current major mode,
607 which means calling the current value of `indent-line-function'.
608 In programming language modes, this is the same as TAB.
609 In some text modes, where TAB inserts a tab, this indents to the
610 column specified by the function `current-left-margin'."
611 (interactive "*")
612 (let ((pos (point)))
613 ;; Be careful to insert the newline before indenting the line.
614 ;; Otherwise, the indentation might be wrong.
615 (newline)
616 (save-excursion
617 (goto-char pos)
618 ;; We are at EOL before the call to indent-according-to-mode, and
619 ;; after it we usually are as well, but not always. We tried to
620 ;; address it with `save-excursion' but that uses a normal marker
621 ;; whereas we need `move after insertion', so we do the save/restore
622 ;; by hand.
623 (setq pos (copy-marker pos t))
624 (indent-according-to-mode)
625 (goto-char pos)
626 ;; Remove the trailing white-space after indentation because
627 ;; indentation may introduce the whitespace.
628 (delete-horizontal-space t))
629 (indent-according-to-mode)))
630
631 (defun quoted-insert (arg)
632 "Read next input character and insert it.
633 This is useful for inserting control characters.
634 With argument, insert ARG copies of the character.
635
636 If the first character you type after this command is an octal digit,
637 you should type a sequence of octal digits which specify a character code.
638 Any nondigit terminates the sequence. If the terminator is a RET,
639 it is discarded; any other terminator is used itself as input.
640 The variable `read-quoted-char-radix' specifies the radix for this feature;
641 set it to 10 or 16 to use decimal or hex instead of octal.
642
643 In overwrite mode, this function inserts the character anyway, and
644 does not handle octal digits specially. This means that if you use
645 overwrite as your normal editing mode, you can use this function to
646 insert characters when necessary.
647
648 In binary overwrite mode, this function does overwrite, and octal
649 digits are interpreted as a character code. This is intended to be
650 useful for editing binary files."
651 (interactive "*p")
652 (let* ((char
653 ;; Avoid "obsolete" warnings for translation-table-for-input.
654 (with-no-warnings
655 (let (translation-table-for-input input-method-function)
656 (if (or (not overwrite-mode)
657 (eq overwrite-mode 'overwrite-mode-binary))
658 (read-quoted-char)
659 (read-char))))))
660 ;; This used to assume character codes 0240 - 0377 stand for
661 ;; characters in some single-byte character set, and converted them
662 ;; to Emacs characters. But in 23.1 this feature is deprecated
663 ;; in favor of inserting the corresponding Unicode characters.
664 ;; (if (and enable-multibyte-characters
665 ;; (>= char ?\240)
666 ;; (<= char ?\377))
667 ;; (setq char (unibyte-char-to-multibyte char)))
668 (if (> arg 0)
669 (if (eq overwrite-mode 'overwrite-mode-binary)
670 (delete-char arg)))
671 (while (> arg 0)
672 (insert-and-inherit char)
673 (setq arg (1- arg)))))
674
675 (defun forward-to-indentation (&optional arg)
676 "Move forward ARG lines and position at first nonblank character."
677 (interactive "^p")
678 (forward-line (or arg 1))
679 (skip-chars-forward " \t"))
680
681 (defun backward-to-indentation (&optional arg)
682 "Move backward ARG lines and position at first nonblank character."
683 (interactive "^p")
684 (forward-line (- (or arg 1)))
685 (skip-chars-forward " \t"))
686
687 (defun back-to-indentation ()
688 "Move point to the first non-whitespace character on this line."
689 (interactive "^")
690 (beginning-of-line 1)
691 (skip-syntax-forward " " (line-end-position))
692 ;; Move back over chars that have whitespace syntax but have the p flag.
693 (backward-prefix-chars))
694
695 (defun fixup-whitespace ()
696 "Fixup white space between objects around point.
697 Leave one space or none, according to the context."
698 (interactive "*")
699 (save-excursion
700 (delete-horizontal-space)
701 (if (or (looking-at "^\\|\\s)")
702 (save-excursion (forward-char -1)
703 (looking-at "$\\|\\s(\\|\\s'")))
704 nil
705 (insert ?\s))))
706
707 (defun delete-horizontal-space (&optional backward-only)
708 "Delete all spaces and tabs around point.
709 If BACKWARD-ONLY is non-nil, only delete them before point."
710 (interactive "*P")
711 (let ((orig-pos (point)))
712 (delete-region
713 (if backward-only
714 orig-pos
715 (progn
716 (skip-chars-forward " \t")
717 (constrain-to-field nil orig-pos t)))
718 (progn
719 (skip-chars-backward " \t")
720 (constrain-to-field nil orig-pos)))))
721
722 (defun just-one-space (&optional n)
723 "Delete all spaces and tabs around point, leaving one space (or N spaces).
724 If N is negative, delete newlines as well."
725 (interactive "*p")
726 (unless n (setq n 1))
727 (let ((orig-pos (point))
728 (skip-characters (if (< n 0) " \t\n\r" " \t"))
729 (n (abs n)))
730 (skip-chars-backward skip-characters)
731 (constrain-to-field nil orig-pos)
732 (dotimes (i n)
733 (if (= (following-char) ?\s)
734 (forward-char 1)
735 (insert ?\s)))
736 (delete-region
737 (point)
738 (progn
739 (skip-chars-forward skip-characters)
740 (constrain-to-field nil orig-pos t)))))
741 \f
742 (defun beginning-of-buffer (&optional arg)
743 "Move point to the beginning of the buffer.
744 With numeric arg N, put point N/10 of the way from the beginning.
745 If the buffer is narrowed, this command uses the beginning of the
746 accessible part of the buffer.
747
748 If Transient Mark mode is disabled, leave mark at previous
749 position, unless a \\[universal-argument] prefix is supplied.
750
751 Don't use this command in Lisp programs!
752 \(goto-char (point-min)) is faster."
753 (interactive "^P")
754 (or (consp arg)
755 (region-active-p)
756 (push-mark))
757 (let ((size (- (point-max) (point-min))))
758 (goto-char (if (and arg (not (consp arg)))
759 (+ (point-min)
760 (if (> size 10000)
761 ;; Avoid overflow for large buffer sizes!
762 (* (prefix-numeric-value arg)
763 (/ size 10))
764 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
765 (point-min))))
766 (if (and arg (not (consp arg))) (forward-line 1)))
767
768 (defun end-of-buffer (&optional arg)
769 "Move point to the end of the buffer.
770 With numeric arg N, put point N/10 of the way from the end.
771 If the buffer is narrowed, this command uses the end of the
772 accessible part of the buffer.
773
774 If Transient Mark mode is disabled, leave mark at previous
775 position, unless a \\[universal-argument] prefix is supplied.
776
777 Don't use this command in Lisp programs!
778 \(goto-char (point-max)) is faster."
779 (interactive "^P")
780 (or (consp arg) (region-active-p) (push-mark))
781 (let ((size (- (point-max) (point-min))))
782 (goto-char (if (and arg (not (consp arg)))
783 (- (point-max)
784 (if (> size 10000)
785 ;; Avoid overflow for large buffer sizes!
786 (* (prefix-numeric-value arg)
787 (/ size 10))
788 (/ (* size (prefix-numeric-value arg)) 10)))
789 (point-max))))
790 ;; If we went to a place in the middle of the buffer,
791 ;; adjust it to the beginning of a line.
792 (cond ((and arg (not (consp arg))) (forward-line 1))
793 ((> (point) (window-end nil t))
794 ;; If the end of the buffer is not already on the screen,
795 ;; then scroll specially to put it near, but not at, the bottom.
796 (overlay-recenter (point))
797 (recenter -3))))
798
799 (defcustom delete-active-region t
800 "Whether single-char deletion commands delete an active region.
801 This has an effect only if Transient Mark mode is enabled, and
802 affects `delete-forward-char' and `delete-backward-char', though
803 not `delete-char'.
804
805 If the value is the symbol `kill', the active region is killed
806 instead of deleted."
807 :type '(choice (const :tag "Delete active region" t)
808 (const :tag "Kill active region" kill)
809 (const :tag "Do ordinary deletion" nil))
810 :group 'editing
811 :version "24.1")
812
813 (defun delete-backward-char (n &optional killflag)
814 "Delete the previous N characters (following if N is negative).
815 If Transient Mark mode is enabled, the mark is active, and N is 1,
816 delete the text in the region and deactivate the mark instead.
817 To disable this, set `delete-active-region' to nil.
818
819 Optional second arg KILLFLAG, if non-nil, means to kill (save in
820 kill ring) instead of delete. Interactively, N is the prefix
821 arg, and KILLFLAG is set if N is explicitly specified.
822
823 In Overwrite mode, single character backward deletion may replace
824 tabs with spaces so as to back over columns, unless point is at
825 the end of the line."
826 (interactive "p\nP")
827 (unless (integerp n)
828 (signal 'wrong-type-argument (list 'integerp n)))
829 (cond ((and (use-region-p)
830 delete-active-region
831 (= n 1))
832 ;; If a region is active, kill or delete it.
833 (if (eq delete-active-region 'kill)
834 (kill-region (region-beginning) (region-end))
835 (delete-region (region-beginning) (region-end))))
836 ;; In Overwrite mode, maybe untabify while deleting
837 ((null (or (null overwrite-mode)
838 (<= n 0)
839 (memq (char-before) '(?\t ?\n))
840 (eobp)
841 (eq (char-after) ?\n)))
842 (let ((ocol (current-column)))
843 (delete-char (- n) killflag)
844 (save-excursion
845 (insert-char ?\s (- ocol (current-column)) nil))))
846 ;; Otherwise, do simple deletion.
847 (t (delete-char (- n) killflag))))
848
849 (defun delete-forward-char (n &optional killflag)
850 "Delete the following N characters (previous if N is negative).
851 If Transient Mark mode is enabled, the mark is active, and N is 1,
852 delete the text in the region and deactivate the mark instead.
853 To disable this, set `delete-active-region' to nil.
854
855 Optional second arg KILLFLAG non-nil means to kill (save in kill
856 ring) instead of delete. Interactively, N is the prefix arg, and
857 KILLFLAG is set if N was explicitly specified."
858 (interactive "p\nP")
859 (unless (integerp n)
860 (signal 'wrong-type-argument (list 'integerp n)))
861 (cond ((and (use-region-p)
862 delete-active-region
863 (= n 1))
864 ;; If a region is active, kill or delete it.
865 (if (eq delete-active-region 'kill)
866 (kill-region (region-beginning) (region-end))
867 (delete-region (region-beginning) (region-end))))
868 ;; Otherwise, do simple deletion.
869 (t (delete-char n killflag))))
870
871 (defun mark-whole-buffer ()
872 "Put point at beginning and mark at end of buffer.
873 You probably should not use this function in Lisp programs;
874 it is usually a mistake for a Lisp function to use any subroutine
875 that uses or sets the mark."
876 (interactive)
877 (push-mark (point))
878 (push-mark (point-max) nil t)
879 (goto-char (point-min)))
880 \f
881
882 ;; Counting lines, one way or another.
883
884 (defun goto-line (line &optional buffer)
885 "Goto LINE, counting from line 1 at beginning of buffer.
886 Normally, move point in the current buffer, and leave mark at the
887 previous position. With just \\[universal-argument] as argument,
888 move point in the most recently selected other buffer, and switch to it.
889
890 If there's a number in the buffer at point, it is the default for LINE.
891
892 This function is usually the wrong thing to use in a Lisp program.
893 What you probably want instead is something like:
894 (goto-char (point-min)) (forward-line (1- N))
895 If at all possible, an even better solution is to use char counts
896 rather than line counts."
897 (interactive
898 (if (and current-prefix-arg (not (consp current-prefix-arg)))
899 (list (prefix-numeric-value current-prefix-arg))
900 ;; Look for a default, a number in the buffer at point.
901 (let* ((default
902 (save-excursion
903 (skip-chars-backward "0-9")
904 (if (looking-at "[0-9]")
905 (string-to-number
906 (buffer-substring-no-properties
907 (point)
908 (progn (skip-chars-forward "0-9")
909 (point)))))))
910 ;; Decide if we're switching buffers.
911 (buffer
912 (if (consp current-prefix-arg)
913 (other-buffer (current-buffer) t)))
914 (buffer-prompt
915 (if buffer
916 (concat " in " (buffer-name buffer))
917 "")))
918 ;; Read the argument, offering that number (if any) as default.
919 (list (read-number (format (if default "Goto line%s (%s): "
920 "Goto line%s: ")
921 buffer-prompt
922 default)
923 default)
924 buffer))))
925 ;; Switch to the desired buffer, one way or another.
926 (if buffer
927 (let ((window (get-buffer-window buffer)))
928 (if window (select-window window)
929 (switch-to-buffer-other-window buffer))))
930 ;; Leave mark at previous position
931 (or (region-active-p) (push-mark))
932 ;; Move to the specified line number in that buffer.
933 (save-restriction
934 (widen)
935 (goto-char (point-min))
936 (if (eq selective-display t)
937 (re-search-forward "[\n\C-m]" nil 'end (1- line))
938 (forward-line (1- line)))))
939
940 (defun count-words-region (start end)
941 "Print the number of words in the region.
942 When called interactively, the word count is printed in echo area."
943 (interactive "r")
944 (let ((count 0))
945 (save-excursion
946 (save-restriction
947 (narrow-to-region start end)
948 (goto-char (point-min))
949 (while (forward-word 1)
950 (setq count (1+ count)))))
951 (if (called-interactively-p 'interactive)
952 (message "Region has %d words" count))
953 count))
954
955 (defun count-lines-region (start end)
956 "Print number of lines and characters in the region."
957 (interactive "r")
958 (message "Region has %d lines, %d characters"
959 (count-lines start end) (- end start)))
960
961 (defun what-line ()
962 "Print the current buffer line number and narrowed line number of point."
963 (interactive)
964 (let ((start (point-min))
965 (n (line-number-at-pos)))
966 (if (= start 1)
967 (message "Line %d" n)
968 (save-excursion
969 (save-restriction
970 (widen)
971 (message "line %d (narrowed line %d)"
972 (+ n (line-number-at-pos start) -1) n))))))
973
974 (defun count-lines (start end)
975 "Return number of lines between START and END.
976 This is usually the number of newlines between them,
977 but can be one more if START is not equal to END
978 and the greater of them is not at the start of a line."
979 (save-excursion
980 (save-restriction
981 (narrow-to-region start end)
982 (goto-char (point-min))
983 (if (eq selective-display t)
984 (save-match-data
985 (let ((done 0))
986 (while (re-search-forward "[\n\C-m]" nil t 40)
987 (setq done (+ 40 done)))
988 (while (re-search-forward "[\n\C-m]" nil t 1)
989 (setq done (+ 1 done)))
990 (goto-char (point-max))
991 (if (and (/= start end)
992 (not (bolp)))
993 (1+ done)
994 done)))
995 (- (buffer-size) (forward-line (buffer-size)))))))
996
997 (defun line-number-at-pos (&optional pos)
998 "Return (narrowed) buffer line number at position POS.
999 If POS is nil, use current buffer location.
1000 Counting starts at (point-min), so the value refers
1001 to the contents of the accessible portion of the buffer."
1002 (let ((opoint (or pos (point))) start)
1003 (save-excursion
1004 (goto-char (point-min))
1005 (setq start (point))
1006 (goto-char opoint)
1007 (forward-line 0)
1008 (1+ (count-lines start (point))))))
1009
1010 (defun what-cursor-position (&optional detail)
1011 "Print info on cursor position (on screen and within buffer).
1012 Also describe the character after point, and give its character code
1013 in octal, decimal and hex.
1014
1015 For a non-ASCII multibyte character, also give its encoding in the
1016 buffer's selected coding system if the coding system encodes the
1017 character safely. If the character is encoded into one byte, that
1018 code is shown in hex. If the character is encoded into more than one
1019 byte, just \"...\" is shown.
1020
1021 In addition, with prefix argument, show details about that character
1022 in *Help* buffer. See also the command `describe-char'."
1023 (interactive "P")
1024 (let* ((char (following-char))
1025 (beg (point-min))
1026 (end (point-max))
1027 (pos (point))
1028 (total (buffer-size))
1029 (percent (if (> total 50000)
1030 ;; Avoid overflow from multiplying by 100!
1031 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
1032 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
1033 (hscroll (if (= (window-hscroll) 0)
1034 ""
1035 (format " Hscroll=%d" (window-hscroll))))
1036 (col (current-column)))
1037 (if (= pos end)
1038 (if (or (/= beg 1) (/= end (1+ total)))
1039 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
1040 pos total percent beg end col hscroll)
1041 (message "point=%d of %d (EOB) column=%d%s"
1042 pos total col hscroll))
1043 (let ((coding buffer-file-coding-system)
1044 encoded encoding-msg display-prop under-display)
1045 (if (or (not coding)
1046 (eq (coding-system-type coding) t))
1047 (setq coding (default-value 'buffer-file-coding-system)))
1048 (if (eq (char-charset char) 'eight-bit)
1049 (setq encoding-msg
1050 (format "(%d, #o%o, #x%x, raw-byte)" char char char))
1051 ;; Check if the character is displayed with some `display'
1052 ;; text property. In that case, set under-display to the
1053 ;; buffer substring covered by that property.
1054 (setq display-prop (get-text-property pos 'display))
1055 (if display-prop
1056 (let ((to (or (next-single-property-change pos 'display)
1057 (point-max))))
1058 (if (< to (+ pos 4))
1059 (setq under-display "")
1060 (setq under-display "..."
1061 to (+ pos 4)))
1062 (setq under-display
1063 (concat (buffer-substring-no-properties pos to)
1064 under-display)))
1065 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
1066 (setq encoding-msg
1067 (if display-prop
1068 (if (not (stringp display-prop))
1069 (format "(%d, #o%o, #x%x, part of display \"%s\")"
1070 char char char under-display)
1071 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
1072 char char char under-display display-prop))
1073 (if encoded
1074 (format "(%d, #o%o, #x%x, file %s)"
1075 char char char
1076 (if (> (length encoded) 1)
1077 "..."
1078 (encoded-string-description encoded coding)))
1079 (format "(%d, #o%o, #x%x)" char char char)))))
1080 (if detail
1081 ;; We show the detailed information about CHAR.
1082 (describe-char (point)))
1083 (if (or (/= beg 1) (/= end (1+ total)))
1084 (message "Char: %s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
1085 (if (< char 256)
1086 (single-key-description char)
1087 (buffer-substring-no-properties (point) (1+ (point))))
1088 encoding-msg pos total percent beg end col hscroll)
1089 (message "Char: %s %s point=%d of %d (%d%%) column=%d%s"
1090 (if enable-multibyte-characters
1091 (if (< char 128)
1092 (single-key-description char)
1093 (buffer-substring-no-properties (point) (1+ (point))))
1094 (single-key-description char))
1095 encoding-msg pos total percent col hscroll))))))
1096 \f
1097 ;; Initialize read-expression-map. It is defined at C level.
1098 (let ((m (make-sparse-keymap)))
1099 (define-key m "\M-\t" 'lisp-complete-symbol)
1100 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1101 ;; too rarely useful.
1102 (define-key m "\t" 'lisp-complete-symbol)
1103 (set-keymap-parent m minibuffer-local-map)
1104 (setq read-expression-map m))
1105
1106 (defvar minibuffer-completing-symbol nil
1107 "Non-nil means completing a Lisp symbol in the minibuffer.")
1108 (make-obsolete-variable 'minibuffer-completing-symbol nil "24.1" 'get)
1109
1110 (defvar minibuffer-default nil
1111 "The current default value or list of default values in the minibuffer.
1112 The functions `read-from-minibuffer' and `completing-read' bind
1113 this variable locally.")
1114
1115 (defcustom eval-expression-print-level 4
1116 "Value for `print-level' while printing value in `eval-expression'.
1117 A value of nil means no limit."
1118 :group 'lisp
1119 :type '(choice (const :tag "No Limit" nil) integer)
1120 :version "21.1")
1121
1122 (defcustom eval-expression-print-length 12
1123 "Value for `print-length' while printing value in `eval-expression'.
1124 A value of nil means no limit."
1125 :group 'lisp
1126 :type '(choice (const :tag "No Limit" nil) integer)
1127 :version "21.1")
1128
1129 (defcustom eval-expression-debug-on-error t
1130 "If non-nil set `debug-on-error' to t in `eval-expression'.
1131 If nil, don't change the value of `debug-on-error'."
1132 :group 'lisp
1133 :type 'boolean
1134 :version "21.1")
1135
1136 (defun eval-expression-print-format (value)
1137 "Format VALUE as a result of evaluated expression.
1138 Return a formatted string which is displayed in the echo area
1139 in addition to the value printed by prin1 in functions which
1140 display the result of expression evaluation."
1141 (if (and (integerp value)
1142 (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp)))
1143 (eq this-command last-command)
1144 (if (boundp 'edebug-active) edebug-active)))
1145 (let ((char-string
1146 (if (or (if (boundp 'edebug-active) edebug-active)
1147 (memq this-command '(eval-last-sexp eval-print-last-sexp)))
1148 (prin1-char value))))
1149 (if char-string
1150 (format " (#o%o, #x%x, %s)" value value char-string)
1151 (format " (#o%o, #x%x)" value value)))))
1152
1153 ;; We define this, rather than making `eval' interactive,
1154 ;; for the sake of completion of names like eval-region, eval-buffer.
1155 (defun eval-expression (eval-expression-arg
1156 &optional eval-expression-insert-value)
1157 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1158 When called interactively, read an Emacs Lisp expression and
1159 evaluate it.
1160 Value is also consed on to front of the variable `values'.
1161 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1162 with prefix argument) means insert the result into the current buffer
1163 instead of printing it in the echo area. Truncates long output
1164 according to the value of the variables `eval-expression-print-length'
1165 and `eval-expression-print-level'.
1166
1167 If `eval-expression-debug-on-error' is non-nil, which is the default,
1168 this command arranges for all errors to enter the debugger."
1169 (interactive
1170 (list (let ((minibuffer-completing-symbol t))
1171 (read-from-minibuffer "Eval: "
1172 nil read-expression-map t
1173 'read-expression-history))
1174 current-prefix-arg))
1175
1176 (if (null eval-expression-debug-on-error)
1177 (push (eval eval-expression-arg lexical-binding) values)
1178 (let ((old-value (make-symbol "t")) new-value)
1179 ;; Bind debug-on-error to something unique so that we can
1180 ;; detect when evaled code changes it.
1181 (let ((debug-on-error old-value))
1182 (push (eval eval-expression-arg lexical-binding) values)
1183 (setq new-value debug-on-error))
1184 ;; If evaled code has changed the value of debug-on-error,
1185 ;; propagate that change to the global binding.
1186 (unless (eq old-value new-value)
1187 (setq debug-on-error new-value))))
1188
1189 (let ((print-length eval-expression-print-length)
1190 (print-level eval-expression-print-level))
1191 (if eval-expression-insert-value
1192 (with-no-warnings
1193 (let ((standard-output (current-buffer)))
1194 (prin1 (car values))))
1195 (prog1
1196 (prin1 (car values) t)
1197 (let ((str (eval-expression-print-format (car values))))
1198 (if str (princ str t)))))))
1199
1200 (defun edit-and-eval-command (prompt command)
1201 "Prompting with PROMPT, let user edit COMMAND and eval result.
1202 COMMAND is a Lisp expression. Let user edit that expression in
1203 the minibuffer, then read and evaluate the result."
1204 (let ((command
1205 (let ((print-level nil)
1206 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1207 (unwind-protect
1208 (read-from-minibuffer prompt
1209 (prin1-to-string command)
1210 read-expression-map t
1211 'command-history)
1212 ;; If command was added to command-history as a string,
1213 ;; get rid of that. We want only evaluable expressions there.
1214 (if (stringp (car command-history))
1215 (setq command-history (cdr command-history)))))))
1216
1217 ;; If command to be redone does not match front of history,
1218 ;; add it to the history.
1219 (or (equal command (car command-history))
1220 (setq command-history (cons command command-history)))
1221 (eval command)))
1222
1223 (defun repeat-complex-command (arg)
1224 "Edit and re-evaluate last complex command, or ARGth from last.
1225 A complex command is one which used the minibuffer.
1226 The command is placed in the minibuffer as a Lisp form for editing.
1227 The result is executed, repeating the command as changed.
1228 If the command has been changed or is not the most recent previous
1229 command it is added to the front of the command history.
1230 You can use the minibuffer history commands \
1231 \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1232 to get different commands to edit and resubmit."
1233 (interactive "p")
1234 (let ((elt (nth (1- arg) command-history))
1235 newcmd)
1236 (if elt
1237 (progn
1238 (setq newcmd
1239 (let ((print-level nil)
1240 (minibuffer-history-position arg)
1241 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1242 (unwind-protect
1243 (read-from-minibuffer
1244 "Redo: " (prin1-to-string elt) read-expression-map t
1245 (cons 'command-history arg))
1246
1247 ;; If command was added to command-history as a
1248 ;; string, get rid of that. We want only
1249 ;; evaluable expressions there.
1250 (if (stringp (car command-history))
1251 (setq command-history (cdr command-history))))))
1252
1253 ;; If command to be redone does not match front of history,
1254 ;; add it to the history.
1255 (or (equal newcmd (car command-history))
1256 (setq command-history (cons newcmd command-history)))
1257 (eval newcmd))
1258 (if command-history
1259 (error "Argument %d is beyond length of command history" arg)
1260 (error "There are no previous complex commands to repeat")))))
1261
1262 (defun read-extended-command ()
1263 "Read command name to invoke in `execute-extended-command'."
1264 (minibuffer-with-setup-hook
1265 (lambda ()
1266 (set (make-local-variable 'minibuffer-default-add-function)
1267 (lambda ()
1268 ;; Get a command name at point in the original buffer
1269 ;; to propose it after M-n.
1270 (with-current-buffer (window-buffer (minibuffer-selected-window))
1271 (and (commandp (function-called-at-point))
1272 (format "%S" (function-called-at-point)))))))
1273 ;; Read a string, completing from and restricting to the set of
1274 ;; all defined commands. Don't provide any initial input.
1275 ;; Save the command read on the extended-command history list.
1276 (completing-read
1277 (concat (cond
1278 ((eq current-prefix-arg '-) "- ")
1279 ((and (consp current-prefix-arg)
1280 (eq (car current-prefix-arg) 4)) "C-u ")
1281 ((and (consp current-prefix-arg)
1282 (integerp (car current-prefix-arg)))
1283 (format "%d " (car current-prefix-arg)))
1284 ((integerp current-prefix-arg)
1285 (format "%d " current-prefix-arg)))
1286 ;; This isn't strictly correct if `execute-extended-command'
1287 ;; is bound to anything else (e.g. [menu]).
1288 ;; It could use (key-description (this-single-command-keys)),
1289 ;; but actually a prompt other than "M-x" would be confusing,
1290 ;; because "M-x" is a well-known prompt to read a command
1291 ;; and it serves as a shorthand for "Extended command: ".
1292 "M-x ")
1293 obarray 'commandp t nil 'extended-command-history)))
1294
1295 \f
1296 (defvar minibuffer-history nil
1297 "Default minibuffer history list.
1298 This is used for all minibuffer input
1299 except when an alternate history list is specified.
1300
1301 Maximum length of the history list is determined by the value
1302 of `history-length', which see.")
1303 (defvar minibuffer-history-sexp-flag nil
1304 "Control whether history list elements are expressions or strings.
1305 If the value of this variable equals current minibuffer depth,
1306 they are expressions; otherwise they are strings.
1307 \(That convention is designed to do the right thing for
1308 recursive uses of the minibuffer.)")
1309 (setq minibuffer-history-variable 'minibuffer-history)
1310 (setq minibuffer-history-position nil) ;; Defvar is in C code.
1311 (defvar minibuffer-history-search-history nil)
1312
1313 (defvar minibuffer-text-before-history nil
1314 "Text that was in this minibuffer before any history commands.
1315 This is nil if there have not yet been any history commands
1316 in this use of the minibuffer.")
1317
1318 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1319
1320 (defun minibuffer-history-initialize ()
1321 (setq minibuffer-text-before-history nil))
1322
1323 (defun minibuffer-avoid-prompt (_new _old)
1324 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1325 (constrain-to-field nil (point-max)))
1326
1327 (defcustom minibuffer-history-case-insensitive-variables nil
1328 "Minibuffer history variables for which matching should ignore case.
1329 If a history variable is a member of this list, then the
1330 \\[previous-matching-history-element] and \\[next-matching-history-element]\
1331 commands ignore case when searching it, regardless of `case-fold-search'."
1332 :type '(repeat variable)
1333 :group 'minibuffer)
1334
1335 (defun previous-matching-history-element (regexp n)
1336 "Find the previous history element that matches REGEXP.
1337 \(Previous history elements refer to earlier actions.)
1338 With prefix argument N, search for Nth previous match.
1339 If N is negative, find the next or Nth next match.
1340 Normally, history elements are matched case-insensitively if
1341 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1342 makes the search case-sensitive.
1343 See also `minibuffer-history-case-insensitive-variables'."
1344 (interactive
1345 (let* ((enable-recursive-minibuffers t)
1346 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1347 nil
1348 minibuffer-local-map
1349 nil
1350 'minibuffer-history-search-history
1351 (car minibuffer-history-search-history))))
1352 ;; Use the last regexp specified, by default, if input is empty.
1353 (list (if (string= regexp "")
1354 (if minibuffer-history-search-history
1355 (car minibuffer-history-search-history)
1356 (error "No previous history search regexp"))
1357 regexp)
1358 (prefix-numeric-value current-prefix-arg))))
1359 (unless (zerop n)
1360 (if (and (zerop minibuffer-history-position)
1361 (null minibuffer-text-before-history))
1362 (setq minibuffer-text-before-history
1363 (minibuffer-contents-no-properties)))
1364 (let ((history (symbol-value minibuffer-history-variable))
1365 (case-fold-search
1366 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1367 ;; On some systems, ignore case for file names.
1368 (if (memq minibuffer-history-variable
1369 minibuffer-history-case-insensitive-variables)
1370 t
1371 ;; Respect the user's setting for case-fold-search:
1372 case-fold-search)
1373 nil))
1374 prevpos
1375 match-string
1376 match-offset
1377 (pos minibuffer-history-position))
1378 (while (/= n 0)
1379 (setq prevpos pos)
1380 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1381 (when (= pos prevpos)
1382 (error (if (= pos 1)
1383 "No later matching history item"
1384 "No earlier matching history item")))
1385 (setq match-string
1386 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
1387 (let ((print-level nil))
1388 (prin1-to-string (nth (1- pos) history)))
1389 (nth (1- pos) history)))
1390 (setq match-offset
1391 (if (< n 0)
1392 (and (string-match regexp match-string)
1393 (match-end 0))
1394 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1395 (match-beginning 1))))
1396 (when match-offset
1397 (setq n (+ n (if (< n 0) 1 -1)))))
1398 (setq minibuffer-history-position pos)
1399 (goto-char (point-max))
1400 (delete-minibuffer-contents)
1401 (insert match-string)
1402 (goto-char (+ (minibuffer-prompt-end) match-offset))))
1403 (if (memq (car (car command-history)) '(previous-matching-history-element
1404 next-matching-history-element))
1405 (setq command-history (cdr command-history))))
1406
1407 (defun next-matching-history-element (regexp n)
1408 "Find the next history element that matches REGEXP.
1409 \(The next history element refers to a more recent action.)
1410 With prefix argument N, search for Nth next match.
1411 If N is negative, find the previous or Nth previous match.
1412 Normally, history elements are matched case-insensitively if
1413 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1414 makes the search case-sensitive."
1415 (interactive
1416 (let* ((enable-recursive-minibuffers t)
1417 (regexp (read-from-minibuffer "Next element matching (regexp): "
1418 nil
1419 minibuffer-local-map
1420 nil
1421 'minibuffer-history-search-history
1422 (car minibuffer-history-search-history))))
1423 ;; Use the last regexp specified, by default, if input is empty.
1424 (list (if (string= regexp "")
1425 (if minibuffer-history-search-history
1426 (car minibuffer-history-search-history)
1427 (error "No previous history search regexp"))
1428 regexp)
1429 (prefix-numeric-value current-prefix-arg))))
1430 (previous-matching-history-element regexp (- n)))
1431
1432 (defvar minibuffer-temporary-goal-position nil)
1433
1434 (defvar minibuffer-default-add-function 'minibuffer-default-add-completions
1435 "Function run by `goto-history-element' before consuming default values.
1436 This is useful to dynamically add more elements to the list of default values
1437 when `goto-history-element' reaches the end of this list.
1438 Before calling this function `goto-history-element' sets the variable
1439 `minibuffer-default-add-done' to t, so it will call this function only
1440 once. In special cases, when this function needs to be called more
1441 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1442 overriding the setting of this variable to t in `goto-history-element'.")
1443
1444 (defvar minibuffer-default-add-done nil
1445 "When nil, add more elements to the end of the list of default values.
1446 The value nil causes `goto-history-element' to add more elements to
1447 the list of defaults when it reaches the end of this list. It does
1448 this by calling a function defined by `minibuffer-default-add-function'.")
1449
1450 (make-variable-buffer-local 'minibuffer-default-add-done)
1451
1452 (defun minibuffer-default-add-completions ()
1453 "Return a list of all completions without the default value.
1454 This function is used to add all elements of the completion table to
1455 the end of the list of defaults just after the default value."
1456 (let ((def minibuffer-default)
1457 (all (all-completions ""
1458 minibuffer-completion-table
1459 minibuffer-completion-predicate)))
1460 (if (listp def)
1461 (append def all)
1462 (cons def (delete def all)))))
1463
1464 (defun goto-history-element (nabs)
1465 "Puts element of the minibuffer history in the minibuffer.
1466 The argument NABS specifies the absolute history position."
1467 (interactive "p")
1468 (when (and (not minibuffer-default-add-done)
1469 (functionp minibuffer-default-add-function)
1470 (< nabs (- (if (listp minibuffer-default)
1471 (length minibuffer-default)
1472 1))))
1473 (setq minibuffer-default-add-done t
1474 minibuffer-default (funcall minibuffer-default-add-function)))
1475 (let ((minimum (if minibuffer-default
1476 (- (if (listp minibuffer-default)
1477 (length minibuffer-default)
1478 1))
1479 0))
1480 elt minibuffer-returned-to-present)
1481 (if (and (zerop minibuffer-history-position)
1482 (null minibuffer-text-before-history))
1483 (setq minibuffer-text-before-history
1484 (minibuffer-contents-no-properties)))
1485 (if (< nabs minimum)
1486 (if minibuffer-default
1487 (error "End of defaults; no next item")
1488 (error "End of history; no default available")))
1489 (if (> nabs (length (symbol-value minibuffer-history-variable)))
1490 (error "Beginning of history; no preceding item"))
1491 (unless (memq last-command '(next-history-element
1492 previous-history-element))
1493 (let ((prompt-end (minibuffer-prompt-end)))
1494 (set (make-local-variable 'minibuffer-temporary-goal-position)
1495 (cond ((<= (point) prompt-end) prompt-end)
1496 ((eobp) nil)
1497 (t (point))))))
1498 (goto-char (point-max))
1499 (delete-minibuffer-contents)
1500 (setq minibuffer-history-position nabs)
1501 (cond ((< nabs 0)
1502 (setq elt (if (listp minibuffer-default)
1503 (nth (1- (abs nabs)) minibuffer-default)
1504 minibuffer-default)))
1505 ((= nabs 0)
1506 (setq elt (or minibuffer-text-before-history ""))
1507 (setq minibuffer-returned-to-present t)
1508 (setq minibuffer-text-before-history nil))
1509 (t (setq elt (nth (1- minibuffer-history-position)
1510 (symbol-value minibuffer-history-variable)))))
1511 (insert
1512 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1513 (not minibuffer-returned-to-present))
1514 (let ((print-level nil))
1515 (prin1-to-string elt))
1516 elt))
1517 (goto-char (or minibuffer-temporary-goal-position (point-max)))))
1518
1519 (defun next-history-element (n)
1520 "Puts next element of the minibuffer history in the minibuffer.
1521 With argument N, it uses the Nth following element."
1522 (interactive "p")
1523 (or (zerop n)
1524 (goto-history-element (- minibuffer-history-position n))))
1525
1526 (defun previous-history-element (n)
1527 "Puts previous element of the minibuffer history in the minibuffer.
1528 With argument N, it uses the Nth previous element."
1529 (interactive "p")
1530 (or (zerop n)
1531 (goto-history-element (+ minibuffer-history-position n))))
1532
1533 (defun next-complete-history-element (n)
1534 "Get next history element which completes the minibuffer before the point.
1535 The contents of the minibuffer after the point are deleted, and replaced
1536 by the new completion."
1537 (interactive "p")
1538 (let ((point-at-start (point)))
1539 (next-matching-history-element
1540 (concat
1541 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
1542 n)
1543 ;; next-matching-history-element always puts us at (point-min).
1544 ;; Move to the position we were at before changing the buffer contents.
1545 ;; This is still sensical, because the text before point has not changed.
1546 (goto-char point-at-start)))
1547
1548 (defun previous-complete-history-element (n)
1549 "\
1550 Get previous history element which completes the minibuffer before the point.
1551 The contents of the minibuffer after the point are deleted, and replaced
1552 by the new completion."
1553 (interactive "p")
1554 (next-complete-history-element (- n)))
1555
1556 ;; For compatibility with the old subr of the same name.
1557 (defun minibuffer-prompt-width ()
1558 "Return the display width of the minibuffer prompt.
1559 Return 0 if current buffer is not a minibuffer."
1560 ;; Return the width of everything before the field at the end of
1561 ;; the buffer; this should be 0 for normal buffers.
1562 (1- (minibuffer-prompt-end)))
1563 \f
1564 ;; isearch minibuffer history
1565 (add-hook 'minibuffer-setup-hook 'minibuffer-history-isearch-setup)
1566
1567 (defvar minibuffer-history-isearch-message-overlay)
1568 (make-variable-buffer-local 'minibuffer-history-isearch-message-overlay)
1569
1570 (defun minibuffer-history-isearch-setup ()
1571 "Set up a minibuffer for using isearch to search the minibuffer history.
1572 Intended to be added to `minibuffer-setup-hook'."
1573 (set (make-local-variable 'isearch-search-fun-function)
1574 'minibuffer-history-isearch-search)
1575 (set (make-local-variable 'isearch-message-function)
1576 'minibuffer-history-isearch-message)
1577 (set (make-local-variable 'isearch-wrap-function)
1578 'minibuffer-history-isearch-wrap)
1579 (set (make-local-variable 'isearch-push-state-function)
1580 'minibuffer-history-isearch-push-state)
1581 (add-hook 'isearch-mode-end-hook 'minibuffer-history-isearch-end nil t))
1582
1583 (defun minibuffer-history-isearch-end ()
1584 "Clean up the minibuffer after terminating isearch in the minibuffer."
1585 (if minibuffer-history-isearch-message-overlay
1586 (delete-overlay minibuffer-history-isearch-message-overlay)))
1587
1588 (defun minibuffer-history-isearch-search ()
1589 "Return the proper search function, for isearch in minibuffer history."
1590 (cond
1591 (isearch-word
1592 (if isearch-forward 'word-search-forward 'word-search-backward))
1593 (t
1594 (lambda (string bound noerror)
1595 (let ((search-fun
1596 ;; Use standard functions to search within minibuffer text
1597 (cond
1598 (isearch-regexp
1599 (if isearch-forward 're-search-forward 're-search-backward))
1600 (t
1601 (if isearch-forward 'search-forward 'search-backward))))
1602 found)
1603 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1604 ;; searching forward. Lazy-highlight calls this lambda with the
1605 ;; bound arg, so skip the minibuffer prompt.
1606 (if (and bound isearch-forward (< (point) (minibuffer-prompt-end)))
1607 (goto-char (minibuffer-prompt-end)))
1608 (or
1609 ;; 1. First try searching in the initial minibuffer text
1610 (funcall search-fun string
1611 (if isearch-forward bound (minibuffer-prompt-end))
1612 noerror)
1613 ;; 2. If the above search fails, start putting next/prev history
1614 ;; elements in the minibuffer successively, and search the string
1615 ;; in them. Do this only when bound is nil (i.e. not while
1616 ;; lazy-highlighting search strings in the current minibuffer text).
1617 (unless bound
1618 (condition-case nil
1619 (progn
1620 (while (not found)
1621 (cond (isearch-forward
1622 (next-history-element 1)
1623 (goto-char (minibuffer-prompt-end)))
1624 (t
1625 (previous-history-element 1)
1626 (goto-char (point-max))))
1627 (setq isearch-barrier (point) isearch-opoint (point))
1628 ;; After putting the next/prev history element, search
1629 ;; the string in them again, until next-history-element
1630 ;; or previous-history-element raises an error at the
1631 ;; beginning/end of history.
1632 (setq found (funcall search-fun string
1633 (unless isearch-forward
1634 ;; For backward search, don't search
1635 ;; in the minibuffer prompt
1636 (minibuffer-prompt-end))
1637 noerror)))
1638 ;; Return point of the new search result
1639 (point))
1640 ;; Return nil when next(prev)-history-element fails
1641 (error nil)))))))))
1642
1643 (defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis)
1644 "Display the minibuffer history search prompt.
1645 If there are no search errors, this function displays an overlay with
1646 the isearch prompt which replaces the original minibuffer prompt.
1647 Otherwise, it displays the standard isearch message returned from
1648 `isearch-message'."
1649 (if (not (and (minibufferp) isearch-success (not isearch-error)))
1650 ;; Use standard function `isearch-message' when not in the minibuffer,
1651 ;; or search fails, or has an error (like incomplete regexp).
1652 ;; This function overwrites minibuffer text with isearch message,
1653 ;; so it's possible to see what is wrong in the search string.
1654 (isearch-message c-q-hack ellipsis)
1655 ;; Otherwise, put the overlay with the standard isearch prompt over
1656 ;; the initial minibuffer prompt.
1657 (if (overlayp minibuffer-history-isearch-message-overlay)
1658 (move-overlay minibuffer-history-isearch-message-overlay
1659 (point-min) (minibuffer-prompt-end))
1660 (setq minibuffer-history-isearch-message-overlay
1661 (make-overlay (point-min) (minibuffer-prompt-end)))
1662 (overlay-put minibuffer-history-isearch-message-overlay 'evaporate t))
1663 (overlay-put minibuffer-history-isearch-message-overlay
1664 'display (isearch-message-prefix c-q-hack ellipsis))
1665 ;; And clear any previous isearch message.
1666 (message "")))
1667
1668 (defun minibuffer-history-isearch-wrap ()
1669 "Wrap the minibuffer history search when search fails.
1670 Move point to the first history element for a forward search,
1671 or to the last history element for a backward search."
1672 (unless isearch-word
1673 ;; When `minibuffer-history-isearch-search' fails on reaching the
1674 ;; beginning/end of the history, wrap the search to the first/last
1675 ;; minibuffer history element.
1676 (if isearch-forward
1677 (goto-history-element (length (symbol-value minibuffer-history-variable)))
1678 (goto-history-element 0))
1679 (setq isearch-success t))
1680 (goto-char (if isearch-forward (minibuffer-prompt-end) (point-max))))
1681
1682 (defun minibuffer-history-isearch-push-state ()
1683 "Save a function restoring the state of minibuffer history search.
1684 Save `minibuffer-history-position' to the additional state parameter
1685 in the search status stack."
1686 `(lambda (cmd)
1687 (minibuffer-history-isearch-pop-state cmd ,minibuffer-history-position)))
1688
1689 (defun minibuffer-history-isearch-pop-state (_cmd hist-pos)
1690 "Restore the minibuffer history search state.
1691 Go to the history element by the absolute history position HIST-POS."
1692 (goto-history-element hist-pos))
1693
1694 \f
1695 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1696 (define-obsolete-function-alias 'advertised-undo 'undo "23.2")
1697
1698 (defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
1699 "Table mapping redo records to the corresponding undo one.
1700 A redo record for undo-in-region maps to t.
1701 A redo record for ordinary undo maps to the following (earlier) undo.")
1702
1703 (defvar undo-in-region nil
1704 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
1705
1706 (defvar undo-no-redo nil
1707 "If t, `undo' doesn't go through redo entries.")
1708
1709 (defvar pending-undo-list nil
1710 "Within a run of consecutive undo commands, list remaining to be undone.
1711 If t, we undid all the way to the end of it.")
1712
1713 (defun undo (&optional arg)
1714 "Undo some previous changes.
1715 Repeat this command to undo more changes.
1716 A numeric ARG serves as a repeat count.
1717
1718 In Transient Mark mode when the mark is active, only undo changes within
1719 the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
1720 as an argument limits undo to changes within the current region."
1721 (interactive "*P")
1722 ;; Make last-command indicate for the next command that this was an undo.
1723 ;; That way, another undo will undo more.
1724 ;; If we get to the end of the undo history and get an error,
1725 ;; another undo command will find the undo history empty
1726 ;; and will get another error. To begin undoing the undos,
1727 ;; you must type some other command.
1728 (let ((modified (buffer-modified-p))
1729 (recent-save (recent-auto-save-p))
1730 message)
1731 ;; If we get an error in undo-start,
1732 ;; the next command should not be a "consecutive undo".
1733 ;; So set `this-command' to something other than `undo'.
1734 (setq this-command 'undo-start)
1735
1736 (unless (and (eq last-command 'undo)
1737 (or (eq pending-undo-list t)
1738 ;; If something (a timer or filter?) changed the buffer
1739 ;; since the previous command, don't continue the undo seq.
1740 (let ((list buffer-undo-list))
1741 (while (eq (car list) nil)
1742 (setq list (cdr list)))
1743 ;; If the last undo record made was made by undo
1744 ;; it shows nothing else happened in between.
1745 (gethash list undo-equiv-table))))
1746 (setq undo-in-region
1747 (or (region-active-p) (and arg (not (numberp arg)))))
1748 (if undo-in-region
1749 (undo-start (region-beginning) (region-end))
1750 (undo-start))
1751 ;; get rid of initial undo boundary
1752 (undo-more 1))
1753 ;; If we got this far, the next command should be a consecutive undo.
1754 (setq this-command 'undo)
1755 ;; Check to see whether we're hitting a redo record, and if
1756 ;; so, ask the user whether she wants to skip the redo/undo pair.
1757 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
1758 (or (eq (selected-window) (minibuffer-window))
1759 (setq message (if undo-in-region
1760 (if equiv "Redo in region!" "Undo in region!")
1761 (if equiv "Redo!" "Undo!"))))
1762 (when (and (consp equiv) undo-no-redo)
1763 ;; The equiv entry might point to another redo record if we have done
1764 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1765 (while (let ((next (gethash equiv undo-equiv-table)))
1766 (if next (setq equiv next))))
1767 (setq pending-undo-list equiv)))
1768 (undo-more
1769 (if (numberp arg)
1770 (prefix-numeric-value arg)
1771 1))
1772 ;; Record the fact that the just-generated undo records come from an
1773 ;; undo operation--that is, they are redo records.
1774 ;; In the ordinary case (not within a region), map the redo
1775 ;; record to the following undos.
1776 ;; I don't know how to do that in the undo-in-region case.
1777 (let ((list buffer-undo-list))
1778 ;; Strip any leading undo boundaries there might be, like we do
1779 ;; above when checking.
1780 (while (eq (car list) nil)
1781 (setq list (cdr list)))
1782 (puthash list (if undo-in-region t pending-undo-list)
1783 undo-equiv-table))
1784 ;; Don't specify a position in the undo record for the undo command.
1785 ;; Instead, undoing this should move point to where the change is.
1786 (let ((tail buffer-undo-list)
1787 (prev nil))
1788 (while (car tail)
1789 (when (integerp (car tail))
1790 (let ((pos (car tail)))
1791 (if prev
1792 (setcdr prev (cdr tail))
1793 (setq buffer-undo-list (cdr tail)))
1794 (setq tail (cdr tail))
1795 (while (car tail)
1796 (if (eq pos (car tail))
1797 (if prev
1798 (setcdr prev (cdr tail))
1799 (setq buffer-undo-list (cdr tail)))
1800 (setq prev tail))
1801 (setq tail (cdr tail)))
1802 (setq tail nil)))
1803 (setq prev tail tail (cdr tail))))
1804 ;; Record what the current undo list says,
1805 ;; so the next command can tell if the buffer was modified in between.
1806 (and modified (not (buffer-modified-p))
1807 (delete-auto-save-file-if-necessary recent-save))
1808 ;; Display a message announcing success.
1809 (if message
1810 (message "%s" message))))
1811
1812 (defun buffer-disable-undo (&optional buffer)
1813 "Make BUFFER stop keeping undo information.
1814 No argument or nil as argument means do this for the current buffer."
1815 (interactive)
1816 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
1817 (setq buffer-undo-list t)))
1818
1819 (defun undo-only (&optional arg)
1820 "Undo some previous changes.
1821 Repeat this command to undo more changes.
1822 A numeric ARG serves as a repeat count.
1823 Contrary to `undo', this will not redo a previous undo."
1824 (interactive "*p")
1825 (let ((undo-no-redo t)) (undo arg)))
1826
1827 (defvar undo-in-progress nil
1828 "Non-nil while performing an undo.
1829 Some change-hooks test this variable to do something different.")
1830
1831 (defun undo-more (n)
1832 "Undo back N undo-boundaries beyond what was already undone recently.
1833 Call `undo-start' to get ready to undo recent changes,
1834 then call `undo-more' one or more times to undo them."
1835 (or (listp pending-undo-list)
1836 (error (concat "No further undo information"
1837 (and undo-in-region " for region"))))
1838 (let ((undo-in-progress t))
1839 ;; Note: The following, while pulling elements off
1840 ;; `pending-undo-list' will call primitive change functions which
1841 ;; will push more elements onto `buffer-undo-list'.
1842 (setq pending-undo-list (primitive-undo n pending-undo-list))
1843 (if (null pending-undo-list)
1844 (setq pending-undo-list t))))
1845
1846 ;; Deep copy of a list
1847 (defun undo-copy-list (list)
1848 "Make a copy of undo list LIST."
1849 (mapcar 'undo-copy-list-1 list))
1850
1851 (defun undo-copy-list-1 (elt)
1852 (if (consp elt)
1853 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1854 elt))
1855
1856 (defun undo-start (&optional beg end)
1857 "Set `pending-undo-list' to the front of the undo list.
1858 The next call to `undo-more' will undo the most recently made change.
1859 If BEG and END are specified, then only undo elements
1860 that apply to text between BEG and END are used; other undo elements
1861 are ignored. If BEG and END are nil, all undo elements are used."
1862 (if (eq buffer-undo-list t)
1863 (error "No undo information in this buffer"))
1864 (setq pending-undo-list
1865 (if (and beg end (not (= beg end)))
1866 (undo-make-selective-list (min beg end) (max beg end))
1867 buffer-undo-list)))
1868
1869 (defvar undo-adjusted-markers)
1870
1871 (defun undo-make-selective-list (start end)
1872 "Return a list of undo elements for the region START to END.
1873 The elements come from `buffer-undo-list', but we keep only
1874 the elements inside this region, and discard those outside this region.
1875 If we find an element that crosses an edge of this region,
1876 we stop and ignore all further elements."
1877 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1878 (undo-list (list nil))
1879 undo-adjusted-markers
1880 some-rejected
1881 undo-elt temp-undo-list delta)
1882 (while undo-list-copy
1883 (setq undo-elt (car undo-list-copy))
1884 (let ((keep-this
1885 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1886 ;; This is a "was unmodified" element.
1887 ;; Keep it if we have kept everything thus far.
1888 (not some-rejected))
1889 (t
1890 (undo-elt-in-region undo-elt start end)))))
1891 (if keep-this
1892 (progn
1893 (setq end (+ end (cdr (undo-delta undo-elt))))
1894 ;; Don't put two nils together in the list
1895 (if (not (and (eq (car undo-list) nil)
1896 (eq undo-elt nil)))
1897 (setq undo-list (cons undo-elt undo-list))))
1898 (if (undo-elt-crosses-region undo-elt start end)
1899 (setq undo-list-copy nil)
1900 (setq some-rejected t)
1901 (setq temp-undo-list (cdr undo-list-copy))
1902 (setq delta (undo-delta undo-elt))
1903
1904 (when (/= (cdr delta) 0)
1905 (let ((position (car delta))
1906 (offset (cdr delta)))
1907
1908 ;; Loop down the earlier events adjusting their buffer
1909 ;; positions to reflect the fact that a change to the buffer
1910 ;; isn't being undone. We only need to process those element
1911 ;; types which undo-elt-in-region will return as being in
1912 ;; the region since only those types can ever get into the
1913 ;; output
1914
1915 (while temp-undo-list
1916 (setq undo-elt (car temp-undo-list))
1917 (cond ((integerp undo-elt)
1918 (if (>= undo-elt position)
1919 (setcar temp-undo-list (- undo-elt offset))))
1920 ((atom undo-elt) nil)
1921 ((stringp (car undo-elt))
1922 ;; (TEXT . POSITION)
1923 (let ((text-pos (abs (cdr undo-elt)))
1924 (point-at-end (< (cdr undo-elt) 0 )))
1925 (if (>= text-pos position)
1926 (setcdr undo-elt (* (if point-at-end -1 1)
1927 (- text-pos offset))))))
1928 ((integerp (car undo-elt))
1929 ;; (BEGIN . END)
1930 (when (>= (car undo-elt) position)
1931 (setcar undo-elt (- (car undo-elt) offset))
1932 (setcdr undo-elt (- (cdr undo-elt) offset))))
1933 ((null (car undo-elt))
1934 ;; (nil PROPERTY VALUE BEG . END)
1935 (let ((tail (nthcdr 3 undo-elt)))
1936 (when (>= (car tail) position)
1937 (setcar tail (- (car tail) offset))
1938 (setcdr tail (- (cdr tail) offset))))))
1939 (setq temp-undo-list (cdr temp-undo-list))))))))
1940 (setq undo-list-copy (cdr undo-list-copy)))
1941 (nreverse undo-list)))
1942
1943 (defun undo-elt-in-region (undo-elt start end)
1944 "Determine whether UNDO-ELT falls inside the region START ... END.
1945 If it crosses the edge, we return nil."
1946 (cond ((integerp undo-elt)
1947 (and (>= undo-elt start)
1948 (<= undo-elt end)))
1949 ((eq undo-elt nil)
1950 t)
1951 ((atom undo-elt)
1952 nil)
1953 ((stringp (car undo-elt))
1954 ;; (TEXT . POSITION)
1955 (and (>= (abs (cdr undo-elt)) start)
1956 (< (abs (cdr undo-elt)) end)))
1957 ((and (consp undo-elt) (markerp (car undo-elt)))
1958 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1959 ;; See if MARKER is inside the region.
1960 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1961 (unless alist-elt
1962 (setq alist-elt (cons (car undo-elt)
1963 (marker-position (car undo-elt))))
1964 (setq undo-adjusted-markers
1965 (cons alist-elt undo-adjusted-markers)))
1966 (and (cdr alist-elt)
1967 (>= (cdr alist-elt) start)
1968 (<= (cdr alist-elt) end))))
1969 ((null (car undo-elt))
1970 ;; (nil PROPERTY VALUE BEG . END)
1971 (let ((tail (nthcdr 3 undo-elt)))
1972 (and (>= (car tail) start)
1973 (<= (cdr tail) end))))
1974 ((integerp (car undo-elt))
1975 ;; (BEGIN . END)
1976 (and (>= (car undo-elt) start)
1977 (<= (cdr undo-elt) end)))))
1978
1979 (defun undo-elt-crosses-region (undo-elt start end)
1980 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1981 This assumes we have already decided that UNDO-ELT
1982 is not *inside* the region START...END."
1983 (cond ((atom undo-elt) nil)
1984 ((null (car undo-elt))
1985 ;; (nil PROPERTY VALUE BEG . END)
1986 (let ((tail (nthcdr 3 undo-elt)))
1987 (and (< (car tail) end)
1988 (> (cdr tail) start))))
1989 ((integerp (car undo-elt))
1990 ;; (BEGIN . END)
1991 (and (< (car undo-elt) end)
1992 (> (cdr undo-elt) start)))))
1993
1994 ;; Return the first affected buffer position and the delta for an undo element
1995 ;; delta is defined as the change in subsequent buffer positions if we *did*
1996 ;; the undo.
1997 (defun undo-delta (undo-elt)
1998 (if (consp undo-elt)
1999 (cond ((stringp (car undo-elt))
2000 ;; (TEXT . POSITION)
2001 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
2002 ((integerp (car undo-elt))
2003 ;; (BEGIN . END)
2004 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
2005 (t
2006 '(0 . 0)))
2007 '(0 . 0)))
2008
2009 (defcustom undo-ask-before-discard nil
2010 "If non-nil ask about discarding undo info for the current command.
2011 Normally, Emacs discards the undo info for the current command if
2012 it exceeds `undo-outer-limit'. But if you set this option
2013 non-nil, it asks in the echo area whether to discard the info.
2014 If you answer no, there is a slight risk that Emacs might crash, so
2015 only do it if you really want to undo the command.
2016
2017 This option is mainly intended for debugging. You have to be
2018 careful if you use it for other purposes. Garbage collection is
2019 inhibited while the question is asked, meaning that Emacs might
2020 leak memory. So you should make sure that you do not wait
2021 excessively long before answering the question."
2022 :type 'boolean
2023 :group 'undo
2024 :version "22.1")
2025
2026 (defvar undo-extra-outer-limit nil
2027 "If non-nil, an extra level of size that's ok in an undo item.
2028 We don't ask the user about truncating the undo list until the
2029 current item gets bigger than this amount.
2030
2031 This variable only matters if `undo-ask-before-discard' is non-nil.")
2032 (make-variable-buffer-local 'undo-extra-outer-limit)
2033
2034 ;; When the first undo batch in an undo list is longer than
2035 ;; undo-outer-limit, this function gets called to warn the user that
2036 ;; the undo info for the current command was discarded. Garbage
2037 ;; collection is inhibited around the call, so it had better not do a
2038 ;; lot of consing.
2039 (setq undo-outer-limit-function 'undo-outer-limit-truncate)
2040 (defun undo-outer-limit-truncate (size)
2041 (if undo-ask-before-discard
2042 (when (or (null undo-extra-outer-limit)
2043 (> size undo-extra-outer-limit))
2044 ;; Don't ask the question again unless it gets even bigger.
2045 ;; This applies, in particular, if the user quits from the question.
2046 ;; Such a quit quits out of GC, but something else will call GC
2047 ;; again momentarily. It will call this function again,
2048 ;; but we don't want to ask the question again.
2049 (setq undo-extra-outer-limit (+ size 50000))
2050 (if (let (use-dialog-box track-mouse executing-kbd-macro )
2051 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
2052 (buffer-name) size)))
2053 (progn (setq buffer-undo-list nil)
2054 (setq undo-extra-outer-limit nil)
2055 t)
2056 nil))
2057 (display-warning '(undo discard-info)
2058 (concat
2059 (format "Buffer `%s' undo info was %d bytes long.\n"
2060 (buffer-name) size)
2061 "The undo info was discarded because it exceeded \
2062 `undo-outer-limit'.
2063
2064 This is normal if you executed a command that made a huge change
2065 to the buffer. In that case, to prevent similar problems in the
2066 future, set `undo-outer-limit' to a value that is large enough to
2067 cover the maximum size of normal changes you expect a single
2068 command to make, but not so large that it might exceed the
2069 maximum memory allotted to Emacs.
2070
2071 If you did not execute any such command, the situation is
2072 probably due to a bug and you should report it.
2073
2074 You can disable the popping up of this buffer by adding the entry
2075 \(undo discard-info) to the user option `warning-suppress-types',
2076 which is defined in the `warnings' library.\n")
2077 :warning)
2078 (setq buffer-undo-list nil)
2079 t))
2080 \f
2081 (defvar shell-command-history nil
2082 "History list for some commands that read shell commands.
2083
2084 Maximum length of the history list is determined by the value
2085 of `history-length', which see.")
2086
2087 (defvar shell-command-switch (purecopy "-c")
2088 "Switch used to have the shell execute its command line argument.")
2089
2090 (defvar shell-command-default-error-buffer nil
2091 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2092 This buffer is used when `shell-command' or `shell-command-on-region'
2093 is run interactively. A value of nil means that output to stderr and
2094 stdout will be intermixed in the output stream.")
2095
2096 (declare-function mailcap-file-default-commands "mailcap" (files))
2097 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
2098
2099 (defun minibuffer-default-add-shell-commands ()
2100 "Return a list of all commands associated with the current file.
2101 This function is used to add all related commands retrieved by `mailcap'
2102 to the end of the list of defaults just after the default value."
2103 (interactive)
2104 (let* ((filename (if (listp minibuffer-default)
2105 (car minibuffer-default)
2106 minibuffer-default))
2107 (commands (and filename (require 'mailcap nil t)
2108 (mailcap-file-default-commands (list filename)))))
2109 (setq commands (mapcar (lambda (command)
2110 (concat command " " filename))
2111 commands))
2112 (if (listp minibuffer-default)
2113 (append minibuffer-default commands)
2114 (cons minibuffer-default commands))))
2115
2116 (declare-function shell-completion-vars "shell" ())
2117
2118 (defvar minibuffer-local-shell-command-map
2119 (let ((map (make-sparse-keymap)))
2120 (set-keymap-parent map minibuffer-local-map)
2121 (define-key map "\t" 'completion-at-point)
2122 map)
2123 "Keymap used for completing shell commands in minibuffer.")
2124
2125 (defun read-shell-command (prompt &optional initial-contents hist &rest args)
2126 "Read a shell command from the minibuffer.
2127 The arguments are the same as the ones of `read-from-minibuffer',
2128 except READ and KEYMAP are missing and HIST defaults
2129 to `shell-command-history'."
2130 (require 'shell)
2131 (minibuffer-with-setup-hook
2132 (lambda ()
2133 (shell-completion-vars)
2134 (set (make-local-variable 'minibuffer-default-add-function)
2135 'minibuffer-default-add-shell-commands))
2136 (apply 'read-from-minibuffer prompt initial-contents
2137 minibuffer-local-shell-command-map
2138 nil
2139 (or hist 'shell-command-history)
2140 args)))
2141
2142 (defun async-shell-command (command &optional output-buffer error-buffer)
2143 "Execute string COMMAND asynchronously in background.
2144
2145 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2146 surrounded by whitespace and executes the command asynchronously.
2147 The output appears in the buffer `*Async Shell Command*'.
2148
2149 In Elisp, you will often be better served by calling `start-process'
2150 directly, since it offers more control and does not impose the use of a
2151 shell (with its need to quote arguments)."
2152 (interactive
2153 (list
2154 (read-shell-command "Async shell command: " nil nil
2155 (and buffer-file-name
2156 (file-relative-name buffer-file-name)))
2157 current-prefix-arg
2158 shell-command-default-error-buffer))
2159 (unless (string-match "&[ \t]*\\'" command)
2160 (setq command (concat command " &")))
2161 (shell-command command output-buffer error-buffer))
2162
2163 (defun shell-command (command &optional output-buffer error-buffer)
2164 "Execute string COMMAND in inferior shell; display output, if any.
2165 With prefix argument, insert the COMMAND's output at point.
2166
2167 If COMMAND ends in ampersand, execute it asynchronously.
2168 The output appears in the buffer `*Async Shell Command*'.
2169 That buffer is in shell mode.
2170
2171 Otherwise, COMMAND is executed synchronously. The output appears in
2172 the buffer `*Shell Command Output*'. If the output is short enough to
2173 display in the echo area (which is determined by the variables
2174 `resize-mini-windows' and `max-mini-window-height'), it is shown
2175 there, but it is nonetheless available in buffer `*Shell Command
2176 Output*' even though that buffer is not automatically displayed.
2177
2178 To specify a coding system for converting non-ASCII characters
2179 in the shell command output, use \\[universal-coding-system-argument] \
2180 before this command.
2181
2182 Noninteractive callers can specify coding systems by binding
2183 `coding-system-for-read' and `coding-system-for-write'.
2184
2185 The optional second argument OUTPUT-BUFFER, if non-nil,
2186 says to put the output in some other buffer.
2187 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2188 If OUTPUT-BUFFER is not a buffer and not nil,
2189 insert output in current buffer. (This cannot be done asynchronously.)
2190 In either case, the buffer is first erased, and the output is
2191 inserted after point (leaving mark after it).
2192
2193 If the command terminates without error, but generates output,
2194 and you did not specify \"insert it in the current buffer\",
2195 the output can be displayed in the echo area or in its buffer.
2196 If the output is short enough to display in the echo area
2197 \(determined by the variable `max-mini-window-height' if
2198 `resize-mini-windows' is non-nil), it is shown there.
2199 Otherwise,the buffer containing the output is displayed.
2200
2201 If there is output and an error, and you did not specify \"insert it
2202 in the current buffer\", a message about the error goes at the end
2203 of the output.
2204
2205 If there is no output, or if output is inserted in the current buffer,
2206 then `*Shell Command Output*' is deleted.
2207
2208 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2209 or buffer name to which to direct the command's standard error output.
2210 If it is nil, error output is mingled with regular output.
2211 In an interactive call, the variable `shell-command-default-error-buffer'
2212 specifies the value of ERROR-BUFFER.
2213
2214 In Elisp, you will often be better served by calling `call-process' or
2215 `start-process' directly, since it offers more control and does not impose
2216 the use of a shell (with its need to quote arguments)."
2217
2218 (interactive
2219 (list
2220 (read-shell-command "Shell command: " nil nil
2221 (let ((filename
2222 (cond
2223 (buffer-file-name)
2224 ((eq major-mode 'dired-mode)
2225 (dired-get-filename nil t)))))
2226 (and filename (file-relative-name filename))))
2227 current-prefix-arg
2228 shell-command-default-error-buffer))
2229 ;; Look for a handler in case default-directory is a remote file name.
2230 (let ((handler
2231 (find-file-name-handler (directory-file-name default-directory)
2232 'shell-command)))
2233 (if handler
2234 (funcall handler 'shell-command command output-buffer error-buffer)
2235 (if (and output-buffer
2236 (not (or (bufferp output-buffer) (stringp output-buffer))))
2237 ;; Output goes in current buffer.
2238 (let ((error-file
2239 (if error-buffer
2240 (make-temp-file
2241 (expand-file-name "scor"
2242 (or small-temporary-file-directory
2243 temporary-file-directory)))
2244 nil)))
2245 (barf-if-buffer-read-only)
2246 (push-mark nil t)
2247 ;; We do not use -f for csh; we will not support broken use of
2248 ;; .cshrcs. Even the BSD csh manual says to use
2249 ;; "if ($?prompt) exit" before things which are not useful
2250 ;; non-interactively. Besides, if someone wants their other
2251 ;; aliases for shell commands then they can still have them.
2252 (call-process shell-file-name nil
2253 (if error-file
2254 (list t error-file)
2255 t)
2256 nil shell-command-switch command)
2257 (when (and error-file (file-exists-p error-file))
2258 (if (< 0 (nth 7 (file-attributes error-file)))
2259 (with-current-buffer (get-buffer-create error-buffer)
2260 (let ((pos-from-end (- (point-max) (point))))
2261 (or (bobp)
2262 (insert "\f\n"))
2263 ;; Do no formatting while reading error file,
2264 ;; because that can run a shell command, and we
2265 ;; don't want that to cause an infinite recursion.
2266 (format-insert-file error-file nil)
2267 ;; Put point after the inserted errors.
2268 (goto-char (- (point-max) pos-from-end)))
2269 (display-buffer (current-buffer))))
2270 (delete-file error-file))
2271 ;; This is like exchange-point-and-mark, but doesn't
2272 ;; activate the mark. It is cleaner to avoid activation,
2273 ;; even though the command loop would deactivate the mark
2274 ;; because we inserted text.
2275 (goto-char (prog1 (mark t)
2276 (set-marker (mark-marker) (point)
2277 (current-buffer)))))
2278 ;; Output goes in a separate buffer.
2279 ;; Preserve the match data in case called from a program.
2280 (save-match-data
2281 (if (string-match "[ \t]*&[ \t]*\\'" command)
2282 ;; Command ending with ampersand means asynchronous.
2283 (let ((buffer (get-buffer-create
2284 (or output-buffer "*Async Shell Command*")))
2285 (directory default-directory)
2286 proc)
2287 ;; Remove the ampersand.
2288 (setq command (substring command 0 (match-beginning 0)))
2289 ;; If will kill a process, query first.
2290 (setq proc (get-buffer-process buffer))
2291 (if proc
2292 (if (yes-or-no-p "A command is running. Kill it? ")
2293 (kill-process proc)
2294 (error "Shell command in progress")))
2295 (with-current-buffer buffer
2296 (setq buffer-read-only nil)
2297 ;; Setting buffer-read-only to nil doesn't suffice
2298 ;; if some text has a non-nil read-only property,
2299 ;; which comint sometimes adds for prompts.
2300 (let ((inhibit-read-only t))
2301 (erase-buffer))
2302 (display-buffer buffer)
2303 (setq default-directory directory)
2304 (setq proc (start-process "Shell" buffer shell-file-name
2305 shell-command-switch command))
2306 (setq mode-line-process '(":%s"))
2307 (require 'shell) (shell-mode)
2308 (set-process-sentinel proc 'shell-command-sentinel)
2309 ;; Use the comint filter for proper handling of carriage motion
2310 ;; (see `comint-inhibit-carriage-motion'),.
2311 (set-process-filter proc 'comint-output-filter)
2312 ))
2313 ;; Otherwise, command is executed synchronously.
2314 (shell-command-on-region (point) (point) command
2315 output-buffer nil error-buffer)))))))
2316
2317 (defun display-message-or-buffer (message
2318 &optional buffer-name not-this-window frame)
2319 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2320 MESSAGE may be either a string or a buffer.
2321
2322 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2323 the maximum height of the echo area, as defined by `max-mini-window-height'
2324 if `resize-mini-windows' is non-nil.
2325
2326 Returns either the string shown in the echo area, or when a pop-up
2327 buffer is used, the window used to display it.
2328
2329 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2330 name of the buffer used to display it in the case where a pop-up buffer
2331 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2332 string and it is displayed in the echo area, it is not specified whether
2333 the contents are inserted into the buffer anyway.
2334
2335 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2336 and only used if a buffer is displayed."
2337 (cond ((and (stringp message) (not (string-match "\n" message)))
2338 ;; Trivial case where we can use the echo area
2339 (message "%s" message))
2340 ((and (stringp message)
2341 (= (string-match "\n" message) (1- (length message))))
2342 ;; Trivial case where we can just remove single trailing newline
2343 (message "%s" (substring message 0 (1- (length message)))))
2344 (t
2345 ;; General case
2346 (with-current-buffer
2347 (if (bufferp message)
2348 message
2349 (get-buffer-create (or buffer-name "*Message*")))
2350
2351 (unless (bufferp message)
2352 (erase-buffer)
2353 (insert message))
2354
2355 (let ((lines
2356 (if (= (buffer-size) 0)
2357 0
2358 (count-screen-lines nil nil nil (minibuffer-window)))))
2359 (cond ((= lines 0))
2360 ((and (or (<= lines 1)
2361 (<= lines
2362 (if resize-mini-windows
2363 (cond ((floatp max-mini-window-height)
2364 (* (frame-height)
2365 max-mini-window-height))
2366 ((integerp max-mini-window-height)
2367 max-mini-window-height)
2368 (t
2369 1))
2370 1)))
2371 ;; Don't use the echo area if the output buffer is
2372 ;; already dispayed in the selected frame.
2373 (not (get-buffer-window (current-buffer))))
2374 ;; Echo area
2375 (goto-char (point-max))
2376 (when (bolp)
2377 (backward-char 1))
2378 (message "%s" (buffer-substring (point-min) (point))))
2379 (t
2380 ;; Buffer
2381 (goto-char (point-min))
2382 (display-buffer (current-buffer)
2383 not-this-window frame))))))))
2384
2385
2386 ;; We have a sentinel to prevent insertion of a termination message
2387 ;; in the buffer itself.
2388 (defun shell-command-sentinel (process signal)
2389 (if (memq (process-status process) '(exit signal))
2390 (message "%s: %s."
2391 (car (cdr (cdr (process-command process))))
2392 (substring signal 0 -1))))
2393
2394 (defun shell-command-on-region (start end command
2395 &optional output-buffer replace
2396 error-buffer display-error-buffer)
2397 "Execute string COMMAND in inferior shell with region as input.
2398 Normally display output (if any) in temp buffer `*Shell Command Output*';
2399 Prefix arg means replace the region with it. Return the exit code of
2400 COMMAND.
2401
2402 To specify a coding system for converting non-ASCII characters
2403 in the input and output to the shell command, use \\[universal-coding-system-argument]
2404 before this command. By default, the input (from the current buffer)
2405 is encoded in the same coding system that will be used to save the file,
2406 `buffer-file-coding-system'. If the output is going to replace the region,
2407 then it is decoded from that same coding system.
2408
2409 The noninteractive arguments are START, END, COMMAND,
2410 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2411 Noninteractive callers can specify coding systems by binding
2412 `coding-system-for-read' and `coding-system-for-write'.
2413
2414 If the command generates output, the output may be displayed
2415 in the echo area or in a buffer.
2416 If the output is short enough to display in the echo area
2417 \(determined by the variable `max-mini-window-height' if
2418 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2419 it is displayed in the buffer `*Shell Command Output*'. The output
2420 is available in that buffer in both cases.
2421
2422 If there is output and an error, a message about the error
2423 appears at the end of the output.
2424
2425 If there is no output, or if output is inserted in the current buffer,
2426 then `*Shell Command Output*' is deleted.
2427
2428 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2429 that says to put the output in some other buffer.
2430 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2431 If OUTPUT-BUFFER is not a buffer and not nil,
2432 insert output in the current buffer.
2433 In either case, the output is inserted after point (leaving mark after it).
2434
2435 If REPLACE, the optional fifth argument, is non-nil, that means insert
2436 the output in place of text from START to END, putting point and mark
2437 around it.
2438
2439 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2440 or buffer name to which to direct the command's standard error output.
2441 If it is nil, error output is mingled with regular output.
2442 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2443 were any errors. (This is always t, interactively.)
2444 In an interactive call, the variable `shell-command-default-error-buffer'
2445 specifies the value of ERROR-BUFFER."
2446 (interactive (let (string)
2447 (unless (mark)
2448 (error "The mark is not set now, so there is no region"))
2449 ;; Do this before calling region-beginning
2450 ;; and region-end, in case subprocess output
2451 ;; relocates them while we are in the minibuffer.
2452 (setq string (read-shell-command "Shell command on region: "))
2453 ;; call-interactively recognizes region-beginning and
2454 ;; region-end specially, leaving them in the history.
2455 (list (region-beginning) (region-end)
2456 string
2457 current-prefix-arg
2458 current-prefix-arg
2459 shell-command-default-error-buffer
2460 t)))
2461 (let ((error-file
2462 (if error-buffer
2463 (make-temp-file
2464 (expand-file-name "scor"
2465 (or small-temporary-file-directory
2466 temporary-file-directory)))
2467 nil))
2468 exit-status)
2469 (if (or replace
2470 (and output-buffer
2471 (not (or (bufferp output-buffer) (stringp output-buffer)))))
2472 ;; Replace specified region with output from command.
2473 (let ((swap (and replace (< start end))))
2474 ;; Don't muck with mark unless REPLACE says we should.
2475 (goto-char start)
2476 (and replace (push-mark (point) 'nomsg))
2477 (setq exit-status
2478 (call-process-region start end shell-file-name t
2479 (if error-file
2480 (list t error-file)
2481 t)
2482 nil shell-command-switch command))
2483 ;; It is rude to delete a buffer which the command is not using.
2484 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2485 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2486 ;; (kill-buffer shell-buffer)))
2487 ;; Don't muck with mark unless REPLACE says we should.
2488 (and replace swap (exchange-point-and-mark)))
2489 ;; No prefix argument: put the output in a temp buffer,
2490 ;; replacing its entire contents.
2491 (let ((buffer (get-buffer-create
2492 (or output-buffer "*Shell Command Output*"))))
2493 (unwind-protect
2494 (if (eq buffer (current-buffer))
2495 ;; If the input is the same buffer as the output,
2496 ;; delete everything but the specified region,
2497 ;; then replace that region with the output.
2498 (progn (setq buffer-read-only nil)
2499 (delete-region (max start end) (point-max))
2500 (delete-region (point-min) (min start end))
2501 (setq exit-status
2502 (call-process-region (point-min) (point-max)
2503 shell-file-name t
2504 (if error-file
2505 (list t error-file)
2506 t)
2507 nil shell-command-switch
2508 command)))
2509 ;; Clear the output buffer, then run the command with
2510 ;; output there.
2511 (let ((directory default-directory))
2512 (with-current-buffer buffer
2513 (setq buffer-read-only nil)
2514 (if (not output-buffer)
2515 (setq default-directory directory))
2516 (erase-buffer)))
2517 (setq exit-status
2518 (call-process-region start end shell-file-name nil
2519 (if error-file
2520 (list buffer error-file)
2521 buffer)
2522 nil shell-command-switch command)))
2523 ;; Report the output.
2524 (with-current-buffer buffer
2525 (setq mode-line-process
2526 (cond ((null exit-status)
2527 " - Error")
2528 ((stringp exit-status)
2529 (format " - Signal [%s]" exit-status))
2530 ((not (equal 0 exit-status))
2531 (format " - Exit [%d]" exit-status)))))
2532 (if (with-current-buffer buffer (> (point-max) (point-min)))
2533 ;; There's some output, display it
2534 (display-message-or-buffer buffer)
2535 ;; No output; error?
2536 (let ((output
2537 (if (and error-file
2538 (< 0 (nth 7 (file-attributes error-file))))
2539 (format "some error output%s"
2540 (if shell-command-default-error-buffer
2541 (format " to the \"%s\" buffer"
2542 shell-command-default-error-buffer)
2543 ""))
2544 "no output")))
2545 (cond ((null exit-status)
2546 (message "(Shell command failed with error)"))
2547 ((equal 0 exit-status)
2548 (message "(Shell command succeeded with %s)"
2549 output))
2550 ((stringp exit-status)
2551 (message "(Shell command killed by signal %s)"
2552 exit-status))
2553 (t
2554 (message "(Shell command failed with code %d and %s)"
2555 exit-status output))))
2556 ;; Don't kill: there might be useful info in the undo-log.
2557 ;; (kill-buffer buffer)
2558 ))))
2559
2560 (when (and error-file (file-exists-p error-file))
2561 (if (< 0 (nth 7 (file-attributes error-file)))
2562 (with-current-buffer (get-buffer-create error-buffer)
2563 (let ((pos-from-end (- (point-max) (point))))
2564 (or (bobp)
2565 (insert "\f\n"))
2566 ;; Do no formatting while reading error file,
2567 ;; because that can run a shell command, and we
2568 ;; don't want that to cause an infinite recursion.
2569 (format-insert-file error-file nil)
2570 ;; Put point after the inserted errors.
2571 (goto-char (- (point-max) pos-from-end)))
2572 (and display-error-buffer
2573 (display-buffer (current-buffer)))))
2574 (delete-file error-file))
2575 exit-status))
2576
2577 (defun shell-command-to-string (command)
2578 "Execute shell command COMMAND and return its output as a string."
2579 (with-output-to-string
2580 (with-current-buffer
2581 standard-output
2582 (process-file shell-file-name nil t nil shell-command-switch command))))
2583
2584 (defun process-file (program &optional infile buffer display &rest args)
2585 "Process files synchronously in a separate process.
2586 Similar to `call-process', but may invoke a file handler based on
2587 `default-directory'. The current working directory of the
2588 subprocess is `default-directory'.
2589
2590 File names in INFILE and BUFFER are handled normally, but file
2591 names in ARGS should be relative to `default-directory', as they
2592 are passed to the process verbatim. \(This is a difference to
2593 `call-process' which does not support file handlers for INFILE
2594 and BUFFER.\)
2595
2596 Some file handlers might not support all variants, for example
2597 they might behave as if DISPLAY was nil, regardless of the actual
2598 value passed."
2599 (let ((fh (find-file-name-handler default-directory 'process-file))
2600 lc stderr-file)
2601 (unwind-protect
2602 (if fh (apply fh 'process-file program infile buffer display args)
2603 (when infile (setq lc (file-local-copy infile)))
2604 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
2605 (make-temp-file "emacs")))
2606 (prog1
2607 (apply 'call-process program
2608 (or lc infile)
2609 (if stderr-file (list (car buffer) stderr-file) buffer)
2610 display args)
2611 (when stderr-file (copy-file stderr-file (cadr buffer)))))
2612 (when stderr-file (delete-file stderr-file))
2613 (when lc (delete-file lc)))))
2614
2615 (defvar process-file-side-effects t
2616 "Whether a call of `process-file' changes remote files.
2617
2618 Per default, this variable is always set to `t', meaning that a
2619 call of `process-file' could potentially change any file on a
2620 remote host. When set to `nil', a file handler could optimize
2621 its behaviour with respect to remote file attributes caching.
2622
2623 This variable should never be changed by `setq'. Instead of, it
2624 shall be set only by let-binding.")
2625
2626 (defun start-file-process (name buffer program &rest program-args)
2627 "Start a program in a subprocess. Return the process object for it.
2628
2629 Similar to `start-process', but may invoke a file handler based on
2630 `default-directory'. See Info node `(elisp)Magic File Names'.
2631
2632 This handler ought to run PROGRAM, perhaps on the local host,
2633 perhaps on a remote host that corresponds to `default-directory'.
2634 In the latter case, the local part of `default-directory' becomes
2635 the working directory of the process.
2636
2637 PROGRAM and PROGRAM-ARGS might be file names. They are not
2638 objects of file handler invocation. File handlers might not
2639 support pty association, if PROGRAM is nil."
2640 (let ((fh (find-file-name-handler default-directory 'start-file-process)))
2641 (if fh (apply fh 'start-file-process name buffer program program-args)
2642 (apply 'start-process name buffer program program-args))))
2643 \f
2644 ;;;; Process menu
2645
2646 (defvar tabulated-list-format)
2647 (defvar tabulated-list-entries)
2648 (defvar tabulated-list-sort-key)
2649 (declare-function tabulated-list-init-header "tabulated-list" ())
2650 (declare-function tabulated-list-print "tabulated-list"
2651 (&optional remember-pos))
2652
2653 (defvar process-menu-query-only nil)
2654
2655 (define-derived-mode process-menu-mode tabulated-list-mode "Process Menu"
2656 "Major mode for listing the processes called by Emacs."
2657 (setq tabulated-list-format [("Process" 15 t)
2658 ("Status" 7 t)
2659 ("Buffer" 15 t)
2660 ("TTY" 12 t)
2661 ("Command" 0 t)])
2662 (make-local-variable 'process-menu-query-only)
2663 (setq tabulated-list-sort-key (cons "Process" nil))
2664 (add-hook 'tabulated-list-revert-hook 'list-processes--refresh nil t)
2665 (tabulated-list-init-header))
2666
2667 (defun list-processes--refresh ()
2668 "Recompute the list of processes for the Process List buffer."
2669 (setq tabulated-list-entries nil)
2670 (dolist (p (process-list))
2671 (when (or (not process-menu-query-only)
2672 (process-query-on-exit-flag p))
2673 (let* ((buf (process-buffer p))
2674 (type (process-type p))
2675 (name (process-name p))
2676 (status (symbol-name (process-status p)))
2677 (buf-label (if (buffer-live-p buf)
2678 `(,(buffer-name buf)
2679 face link
2680 help-echo ,(concat "Visit buffer `"
2681 (buffer-name buf) "'")
2682 follow-link t
2683 process-buffer ,buf
2684 action process-menu-visit-buffer)
2685 "--"))
2686 (tty (or (process-tty-name p) "--"))
2687 (cmd
2688 (if (memq type '(network serial))
2689 (let ((contact (process-contact p t)))
2690 (if (eq type 'network)
2691 (format "(%s %s)"
2692 (if (plist-get contact :type)
2693 "datagram"
2694 "network")
2695 (if (plist-get contact :server)
2696 (format "server on %s"
2697 (plist-get contact :server))
2698 (format "connection to %s"
2699 (plist-get contact :host))))
2700 (format "(serial port %s%s)"
2701 (or (plist-get contact :port) "?")
2702 (let ((speed (plist-get contact :speed)))
2703 (if speed
2704 (format " at %s b/s" speed)
2705 "")))))
2706 (mapconcat 'identity (process-command p) " "))))
2707 (push (list p (vector name status buf-label tty cmd))
2708 tabulated-list-entries)))))
2709
2710 (defun process-menu-visit-buffer (button)
2711 (display-buffer (button-get button 'process-buffer)))
2712
2713 (defun list-processes (&optional query-only buffer)
2714 "Display a list of all processes.
2715 If optional argument QUERY-ONLY is non-nil, only processes with
2716 the query-on-exit flag set are listed.
2717 Any process listed as exited or signaled is actually eliminated
2718 after the listing is made.
2719 Optional argument BUFFER specifies a buffer to use, instead of
2720 \"*Process List\".
2721 The return value is always nil."
2722 (interactive)
2723 (or (fboundp 'process-list)
2724 (error "Asynchronous subprocesses are not supported on this system"))
2725 (unless (bufferp buffer)
2726 (setq buffer (get-buffer-create "*Process List*")))
2727 (with-current-buffer buffer
2728 (process-menu-mode)
2729 (setq process-menu-query-only query-only)
2730 (list-processes--refresh)
2731 (tabulated-list-print))
2732 (display-buffer buffer)
2733 nil)
2734 \f
2735 (defvar universal-argument-map
2736 (let ((map (make-sparse-keymap)))
2737 (define-key map [t] 'universal-argument-other-key)
2738 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2739 (define-key map [switch-frame] nil)
2740 (define-key map [?\C-u] 'universal-argument-more)
2741 (define-key map [?-] 'universal-argument-minus)
2742 (define-key map [?0] 'digit-argument)
2743 (define-key map [?1] 'digit-argument)
2744 (define-key map [?2] 'digit-argument)
2745 (define-key map [?3] 'digit-argument)
2746 (define-key map [?4] 'digit-argument)
2747 (define-key map [?5] 'digit-argument)
2748 (define-key map [?6] 'digit-argument)
2749 (define-key map [?7] 'digit-argument)
2750 (define-key map [?8] 'digit-argument)
2751 (define-key map [?9] 'digit-argument)
2752 (define-key map [kp-0] 'digit-argument)
2753 (define-key map [kp-1] 'digit-argument)
2754 (define-key map [kp-2] 'digit-argument)
2755 (define-key map [kp-3] 'digit-argument)
2756 (define-key map [kp-4] 'digit-argument)
2757 (define-key map [kp-5] 'digit-argument)
2758 (define-key map [kp-6] 'digit-argument)
2759 (define-key map [kp-7] 'digit-argument)
2760 (define-key map [kp-8] 'digit-argument)
2761 (define-key map [kp-9] 'digit-argument)
2762 (define-key map [kp-subtract] 'universal-argument-minus)
2763 map)
2764 "Keymap used while processing \\[universal-argument].")
2765
2766 (defvar universal-argument-num-events nil
2767 "Number of argument-specifying events read by `universal-argument'.
2768 `universal-argument-other-key' uses this to discard those events
2769 from (this-command-keys), and reread only the final command.")
2770
2771 (defvar saved-overriding-map t
2772 "The saved value of `overriding-terminal-local-map'.
2773 That variable gets restored to this value on exiting \"universal
2774 argument mode\".")
2775
2776 (defun save&set-overriding-map (map)
2777 "Set `overriding-terminal-local-map' to MAP."
2778 (when (eq saved-overriding-map t)
2779 (setq saved-overriding-map overriding-terminal-local-map)
2780 (setq overriding-terminal-local-map map)))
2781
2782 (defun restore-overriding-map ()
2783 "Restore `overriding-terminal-local-map' to its saved value."
2784 (setq overriding-terminal-local-map saved-overriding-map)
2785 (setq saved-overriding-map t))
2786
2787 (defun universal-argument ()
2788 "Begin a numeric argument for the following command.
2789 Digits or minus sign following \\[universal-argument] make up the numeric argument.
2790 \\[universal-argument] following the digits or minus sign ends the argument.
2791 \\[universal-argument] without digits or minus sign provides 4 as argument.
2792 Repeating \\[universal-argument] without digits or minus sign
2793 multiplies the argument by 4 each time.
2794 For some commands, just \\[universal-argument] by itself serves as a flag
2795 which is different in effect from any particular numeric argument.
2796 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
2797 (interactive)
2798 (setq prefix-arg (list 4))
2799 (setq universal-argument-num-events (length (this-command-keys)))
2800 (save&set-overriding-map universal-argument-map))
2801
2802 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2803 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2804 (defun universal-argument-more (arg)
2805 (interactive "P")
2806 (if (consp arg)
2807 (setq prefix-arg (list (* 4 (car arg))))
2808 (if (eq arg '-)
2809 (setq prefix-arg (list -4))
2810 (setq prefix-arg arg)
2811 (restore-overriding-map)))
2812 (setq universal-argument-num-events (length (this-command-keys))))
2813
2814 (defun negative-argument (arg)
2815 "Begin a negative numeric argument for the next command.
2816 \\[universal-argument] following digits or minus sign ends the argument."
2817 (interactive "P")
2818 (cond ((integerp arg)
2819 (setq prefix-arg (- arg)))
2820 ((eq arg '-)
2821 (setq prefix-arg nil))
2822 (t
2823 (setq prefix-arg '-)))
2824 (setq universal-argument-num-events (length (this-command-keys)))
2825 (save&set-overriding-map universal-argument-map))
2826
2827 (defun digit-argument (arg)
2828 "Part of the numeric argument for the next command.
2829 \\[universal-argument] following digits or minus sign ends the argument."
2830 (interactive "P")
2831 (let* ((char (if (integerp last-command-event)
2832 last-command-event
2833 (get last-command-event 'ascii-character)))
2834 (digit (- (logand char ?\177) ?0)))
2835 (cond ((integerp arg)
2836 (setq prefix-arg (+ (* arg 10)
2837 (if (< arg 0) (- digit) digit))))
2838 ((eq arg '-)
2839 ;; Treat -0 as just -, so that -01 will work.
2840 (setq prefix-arg (if (zerop digit) '- (- digit))))
2841 (t
2842 (setq prefix-arg digit))))
2843 (setq universal-argument-num-events (length (this-command-keys)))
2844 (save&set-overriding-map universal-argument-map))
2845
2846 ;; For backward compatibility, minus with no modifiers is an ordinary
2847 ;; command if digits have already been entered.
2848 (defun universal-argument-minus (arg)
2849 (interactive "P")
2850 (if (integerp arg)
2851 (universal-argument-other-key arg)
2852 (negative-argument arg)))
2853
2854 ;; Anything else terminates the argument and is left in the queue to be
2855 ;; executed as a command.
2856 (defun universal-argument-other-key (arg)
2857 (interactive "P")
2858 (setq prefix-arg arg)
2859 (let* ((key (this-command-keys))
2860 (keylist (listify-key-sequence key)))
2861 (setq unread-command-events
2862 (append (nthcdr universal-argument-num-events keylist)
2863 unread-command-events)))
2864 (reset-this-command-lengths)
2865 (restore-overriding-map))
2866 \f
2867
2868 (defvar filter-buffer-substring-functions nil
2869 "Wrapper hook around `filter-buffer-substring'.
2870 The functions on this special hook are called with 4 arguments:
2871 NEXT-FUN BEG END DELETE
2872 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2873 that performs the default operation. The other 3 arguments are like
2874 the ones passed to `filter-buffer-substring'.")
2875
2876 (defvar buffer-substring-filters nil
2877 "List of filter functions for `filter-buffer-substring'.
2878 Each function must accept a single argument, a string, and return
2879 a string. The buffer substring is passed to the first function
2880 in the list, and the return value of each function is passed to
2881 the next. The return value of the last function is used as the
2882 return value of `filter-buffer-substring'.
2883
2884 If this variable is nil, no filtering is performed.")
2885 (make-obsolete-variable 'buffer-substring-filters
2886 'filter-buffer-substring-functions "24.1")
2887
2888 (defun filter-buffer-substring (beg end &optional delete)
2889 "Return the buffer substring between BEG and END, after filtering.
2890 The filtering is performed by `filter-buffer-substring-functions'.
2891
2892 If DELETE is non-nil, the text between BEG and END is deleted
2893 from the buffer.
2894
2895 This function should be used instead of `buffer-substring',
2896 `buffer-substring-no-properties', or `delete-and-extract-region'
2897 when you want to allow filtering to take place. For example,
2898 major or minor modes can use `filter-buffer-substring-functions' to
2899 extract characters that are special to a buffer, and should not
2900 be copied into other buffers."
2901 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2902 (cond
2903 ((or delete buffer-substring-filters)
2904 (save-excursion
2905 (goto-char beg)
2906 (let ((string (if delete (delete-and-extract-region beg end)
2907 (buffer-substring beg end))))
2908 (dolist (filter buffer-substring-filters)
2909 (setq string (funcall filter string)))
2910 string)))
2911 (t
2912 (buffer-substring beg end)))))
2913
2914
2915 ;;;; Window system cut and paste hooks.
2916
2917 (defvar interprogram-cut-function nil
2918 "Function to call to make a killed region available to other programs.
2919
2920 Most window systems provide some sort of facility for cutting and
2921 pasting text between the windows of different programs.
2922 This variable holds a function that Emacs calls whenever text
2923 is put in the kill ring, to make the new kill available to other
2924 programs.
2925
2926 The function takes one argument, TEXT, which is a string containing
2927 the text which should be made available.")
2928
2929 (defvar interprogram-paste-function nil
2930 "Function to call to get text cut from other programs.
2931
2932 Most window systems provide some sort of facility for cutting and
2933 pasting text between the windows of different programs.
2934 This variable holds a function that Emacs calls to obtain
2935 text that other programs have provided for pasting.
2936
2937 The function should be called with no arguments. If the function
2938 returns nil, then no other program has provided such text, and the top
2939 of the Emacs kill ring should be used. If the function returns a
2940 string, then the caller of the function \(usually `current-kill')
2941 should put this string in the kill ring as the latest kill.
2942
2943 This function may also return a list of strings if the window
2944 system supports multiple selections. The first string will be
2945 used as the pasted text, but the other will be placed in the
2946 kill ring for easy access via `yank-pop'.
2947
2948 Note that the function should return a string only if a program other
2949 than Emacs has provided a string for pasting; if Emacs provided the
2950 most recent string, the function should return nil. If it is
2951 difficult to tell whether Emacs or some other program provided the
2952 current string, it is probably good enough to return nil if the string
2953 is equal (according to `string=') to the last text Emacs provided.")
2954 \f
2955
2956
2957 ;;;; The kill ring data structure.
2958
2959 (defvar kill-ring nil
2960 "List of killed text sequences.
2961 Since the kill ring is supposed to interact nicely with cut-and-paste
2962 facilities offered by window systems, use of this variable should
2963 interact nicely with `interprogram-cut-function' and
2964 `interprogram-paste-function'. The functions `kill-new',
2965 `kill-append', and `current-kill' are supposed to implement this
2966 interaction; you may want to use them instead of manipulating the kill
2967 ring directly.")
2968
2969 (defcustom kill-ring-max 60
2970 "Maximum length of kill ring before oldest elements are thrown away."
2971 :type 'integer
2972 :group 'killing)
2973
2974 (defvar kill-ring-yank-pointer nil
2975 "The tail of the kill ring whose car is the last thing yanked.")
2976
2977 (defcustom save-interprogram-paste-before-kill nil
2978 "Save clipboard strings into kill ring before replacing them.
2979 When one selects something in another program to paste it into Emacs,
2980 but kills something in Emacs before actually pasting it,
2981 this selection is gone unless this variable is non-nil,
2982 in which case the other program's selection is saved in the `kill-ring'
2983 before the Emacs kill and one can still paste it using \\[yank] \\[yank-pop]."
2984 :type 'boolean
2985 :group 'killing
2986 :version "23.2")
2987
2988 (defcustom kill-do-not-save-duplicates nil
2989 "Do not add a new string to `kill-ring' when it is the same as the last one."
2990 :type 'boolean
2991 :group 'killing
2992 :version "23.2")
2993
2994 (defun kill-new (string &optional replace yank-handler)
2995 "Make STRING the latest kill in the kill ring.
2996 Set `kill-ring-yank-pointer' to point to it.
2997 If `interprogram-cut-function' is non-nil, apply it to STRING.
2998 Optional second argument REPLACE non-nil means that STRING will replace
2999 the front of the kill ring, rather than being added to the list.
3000
3001 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3002 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3003 STRING.
3004
3005 When the yank handler has a non-nil PARAM element, the original STRING
3006 argument is not used by `insert-for-yank'. However, since Lisp code
3007 may access and use elements from the kill ring directly, the STRING
3008 argument should still be a \"useful\" string for such uses."
3009 (if (> (length string) 0)
3010 (if yank-handler
3011 (put-text-property 0 (length string)
3012 'yank-handler yank-handler string))
3013 (if yank-handler
3014 (signal 'args-out-of-range
3015 (list string "yank-handler specified for empty string"))))
3016 (unless (and kill-do-not-save-duplicates
3017 (equal string (car kill-ring)))
3018 (if (fboundp 'menu-bar-update-yank-menu)
3019 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3020 (when save-interprogram-paste-before-kill
3021 (let ((interprogram-paste (and interprogram-paste-function
3022 (funcall interprogram-paste-function))))
3023 (when interprogram-paste
3024 (dolist (s (if (listp interprogram-paste)
3025 (nreverse interprogram-paste)
3026 (list interprogram-paste)))
3027 (unless (and kill-do-not-save-duplicates
3028 (equal s (car kill-ring)))
3029 (push s kill-ring))))))
3030 (unless (and kill-do-not-save-duplicates
3031 (equal string (car kill-ring)))
3032 (if (and replace kill-ring)
3033 (setcar kill-ring string)
3034 (push string kill-ring)
3035 (if (> (length kill-ring) kill-ring-max)
3036 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3037 (setq kill-ring-yank-pointer kill-ring)
3038 (if interprogram-cut-function
3039 (funcall interprogram-cut-function string)))
3040 (set-advertised-calling-convention
3041 'kill-new '(string &optional replace) "23.3")
3042
3043 (defun kill-append (string before-p &optional yank-handler)
3044 "Append STRING to the end of the latest kill in the kill ring.
3045 If BEFORE-P is non-nil, prepend STRING to the kill.
3046 If `interprogram-cut-function' is set, pass the resulting kill to it."
3047 (let* ((cur (car kill-ring)))
3048 (kill-new (if before-p (concat string cur) (concat cur string))
3049 (or (= (length cur) 0)
3050 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3051 yank-handler)))
3052 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3053
3054 (defcustom yank-pop-change-selection nil
3055 "If non-nil, rotating the kill ring changes the window system selection."
3056 :type 'boolean
3057 :group 'killing
3058 :version "23.1")
3059
3060 (defun current-kill (n &optional do-not-move)
3061 "Rotate the yanking point by N places, and then return that kill.
3062 If N is zero and `interprogram-paste-function' is set to a
3063 function that returns a string or a list of strings, and if that
3064 function doesn't return nil, then that string (or list) is added
3065 to the front of the kill ring and the string (or first string in
3066 the list) is returned as the latest kill.
3067
3068 If N is not zero, and if `yank-pop-change-selection' is
3069 non-nil, use `interprogram-cut-function' to transfer the
3070 kill at the new yank point into the window system selection.
3071
3072 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3073 move the yanking point; just return the Nth kill forward."
3074
3075 (let ((interprogram-paste (and (= n 0)
3076 interprogram-paste-function
3077 (funcall interprogram-paste-function))))
3078 (if interprogram-paste
3079 (progn
3080 ;; Disable the interprogram cut function when we add the new
3081 ;; text to the kill ring, so Emacs doesn't try to own the
3082 ;; selection, with identical text.
3083 (let ((interprogram-cut-function nil))
3084 (if (listp interprogram-paste)
3085 (mapc 'kill-new (nreverse interprogram-paste))
3086 (kill-new interprogram-paste)))
3087 (car kill-ring))
3088 (or kill-ring (error "Kill ring is empty"))
3089 (let ((ARGth-kill-element
3090 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3091 (length kill-ring))
3092 kill-ring)))
3093 (unless do-not-move
3094 (setq kill-ring-yank-pointer ARGth-kill-element)
3095 (when (and yank-pop-change-selection
3096 (> n 0)
3097 interprogram-cut-function)
3098 (funcall interprogram-cut-function (car ARGth-kill-element))))
3099 (car ARGth-kill-element)))))
3100
3101
3102
3103 ;;;; Commands for manipulating the kill ring.
3104
3105 (defcustom kill-read-only-ok nil
3106 "Non-nil means don't signal an error for killing read-only text."
3107 :type 'boolean
3108 :group 'killing)
3109
3110 (put 'text-read-only 'error-conditions
3111 '(text-read-only buffer-read-only error))
3112 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3113
3114 (defun kill-region (beg end &optional yank-handler)
3115 "Kill (\"cut\") text between point and mark.
3116 This deletes the text from the buffer and saves it in the kill ring.
3117 The command \\[yank] can retrieve it from there.
3118 \(If you want to save the region without killing it, use \\[kill-ring-save].)
3119
3120 If you want to append the killed region to the last killed text,
3121 use \\[append-next-kill] before \\[kill-region].
3122
3123 If the buffer is read-only, Emacs will beep and refrain from deleting
3124 the text, but put the text in the kill ring anyway. This means that
3125 you can use the killing commands to copy text from a read-only buffer.
3126
3127 Lisp programs should use this function for killing text.
3128 (To delete text, use `delete-region'.)
3129 Supply two arguments, character positions indicating the stretch of text
3130 to be killed.
3131 Any command that calls this function is a \"kill command\".
3132 If the previous command was also a kill command,
3133 the text killed this time appends to the text killed last time
3134 to make one entry in the kill ring."
3135 ;; Pass point first, then mark, because the order matters
3136 ;; when calling kill-append.
3137 (interactive (list (point) (mark)))
3138 (unless (and beg end)
3139 (error "The mark is not set now, so there is no region"))
3140 (condition-case nil
3141 (let ((string (filter-buffer-substring beg end t)))
3142 (when string ;STRING is nil if BEG = END
3143 ;; Add that string to the kill ring, one way or another.
3144 (if (eq last-command 'kill-region)
3145 (kill-append string (< end beg) yank-handler)
3146 (kill-new string nil yank-handler)))
3147 (when (or string (eq last-command 'kill-region))
3148 (setq this-command 'kill-region))
3149 nil)
3150 ((buffer-read-only text-read-only)
3151 ;; The code above failed because the buffer, or some of the characters
3152 ;; in the region, are read-only.
3153 ;; We should beep, in case the user just isn't aware of this.
3154 ;; However, there's no harm in putting
3155 ;; the region's text in the kill ring, anyway.
3156 (copy-region-as-kill beg end)
3157 ;; Set this-command now, so it will be set even if we get an error.
3158 (setq this-command 'kill-region)
3159 ;; This should barf, if appropriate, and give us the correct error.
3160 (if kill-read-only-ok
3161 (progn (message "Read only text copied to kill ring") nil)
3162 ;; Signal an error if the buffer is read-only.
3163 (barf-if-buffer-read-only)
3164 ;; If the buffer isn't read-only, the text is.
3165 (signal 'text-read-only (list (current-buffer)))))))
3166 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3167
3168 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3169 ;; to get two copies of the text when the user accidentally types M-w and
3170 ;; then corrects it with the intended C-w.
3171 (defun copy-region-as-kill (beg end)
3172 "Save the region as if killed, but don't kill it.
3173 In Transient Mark mode, deactivate the mark.
3174 If `interprogram-cut-function' is non-nil, also save the text for a window
3175 system cut and paste.
3176
3177 This command's old key binding has been given to `kill-ring-save'."
3178 (interactive "r")
3179 (if (eq last-command 'kill-region)
3180 (kill-append (filter-buffer-substring beg end) (< end beg))
3181 (kill-new (filter-buffer-substring beg end)))
3182 (setq deactivate-mark t)
3183 nil)
3184
3185 (defun kill-ring-save (beg end)
3186 "Save the region as if killed, but don't kill it.
3187 In Transient Mark mode, deactivate the mark.
3188 If `interprogram-cut-function' is non-nil, also save the text for a window
3189 system cut and paste.
3190
3191 If you want to append the killed line to the last killed text,
3192 use \\[append-next-kill] before \\[kill-ring-save].
3193
3194 This command is similar to `copy-region-as-kill', except that it gives
3195 visual feedback indicating the extent of the region being copied."
3196 (interactive "r")
3197 (copy-region-as-kill beg end)
3198 ;; This use of called-interactively-p is correct
3199 ;; because the code it controls just gives the user visual feedback.
3200 (if (called-interactively-p 'interactive)
3201 (let ((other-end (if (= (point) beg) end beg))
3202 (opoint (point))
3203 ;; Inhibit quitting so we can make a quit here
3204 ;; look like a C-g typed as a command.
3205 (inhibit-quit t))
3206 (if (pos-visible-in-window-p other-end (selected-window))
3207 ;; Swap point-and-mark quickly so as to show the region that
3208 ;; was selected. Don't do it if the region is highlighted.
3209 (unless (and (region-active-p)
3210 (face-background 'region))
3211 ;; Swap point and mark.
3212 (set-marker (mark-marker) (point) (current-buffer))
3213 (goto-char other-end)
3214 (sit-for blink-matching-delay)
3215 ;; Swap back.
3216 (set-marker (mark-marker) other-end (current-buffer))
3217 (goto-char opoint)
3218 ;; If user quit, deactivate the mark
3219 ;; as C-g would as a command.
3220 (and quit-flag mark-active
3221 (deactivate-mark)))
3222 (let* ((killed-text (current-kill 0))
3223 (message-len (min (length killed-text) 40)))
3224 (if (= (point) beg)
3225 ;; Don't say "killed"; that is misleading.
3226 (message "Saved text until \"%s\""
3227 (substring killed-text (- message-len)))
3228 (message "Saved text from \"%s\""
3229 (substring killed-text 0 message-len))))))))
3230
3231 (defun append-next-kill (&optional interactive)
3232 "Cause following command, if it kills, to append to previous kill.
3233 The argument is used for internal purposes; do not supply one."
3234 (interactive "p")
3235 ;; We don't use (interactive-p), since that breaks kbd macros.
3236 (if interactive
3237 (progn
3238 (setq this-command 'kill-region)
3239 (message "If the next command is a kill, it will append"))
3240 (setq last-command 'kill-region)))
3241 \f
3242 ;; Yanking.
3243
3244 ;; This is actually used in subr.el but defcustom does not work there.
3245 (defcustom yank-excluded-properties
3246 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3247 yank-handler follow-link fontified)
3248 "Text properties to discard when yanking.
3249 The value should be a list of text properties to discard or t,
3250 which means to discard all text properties."
3251 :type '(choice (const :tag "All" t) (repeat symbol))
3252 :group 'killing
3253 :version "22.1")
3254
3255 (defvar yank-window-start nil)
3256 (defvar yank-undo-function nil
3257 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3258 Function is called with two parameters, START and END corresponding to
3259 the value of the mark and point; it is guaranteed that START <= END.
3260 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3261
3262 (defun yank-pop (&optional arg)
3263 "Replace just-yanked stretch of killed text with a different stretch.
3264 This command is allowed only immediately after a `yank' or a `yank-pop'.
3265 At such a time, the region contains a stretch of reinserted
3266 previously-killed text. `yank-pop' deletes that text and inserts in its
3267 place a different stretch of killed text.
3268
3269 With no argument, the previous kill is inserted.
3270 With argument N, insert the Nth previous kill.
3271 If N is negative, this is a more recent kill.
3272
3273 The sequence of kills wraps around, so that after the oldest one
3274 comes the newest one.
3275
3276 When this command inserts killed text into the buffer, it honors
3277 `yank-excluded-properties' and `yank-handler' as described in the
3278 doc string for `insert-for-yank-1', which see."
3279 (interactive "*p")
3280 (if (not (eq last-command 'yank))
3281 (error "Previous command was not a yank"))
3282 (setq this-command 'yank)
3283 (unless arg (setq arg 1))
3284 (let ((inhibit-read-only t)
3285 (before (< (point) (mark t))))
3286 (if before
3287 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3288 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3289 (setq yank-undo-function nil)
3290 (set-marker (mark-marker) (point) (current-buffer))
3291 (insert-for-yank (current-kill arg))
3292 ;; Set the window start back where it was in the yank command,
3293 ;; if possible.
3294 (set-window-start (selected-window) yank-window-start t)
3295 (if before
3296 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3297 ;; It is cleaner to avoid activation, even though the command
3298 ;; loop would deactivate the mark because we inserted text.
3299 (goto-char (prog1 (mark t)
3300 (set-marker (mark-marker) (point) (current-buffer))))))
3301 nil)
3302
3303 (defun yank (&optional arg)
3304 "Reinsert (\"paste\") the last stretch of killed text.
3305 More precisely, reinsert the stretch of killed text most recently
3306 killed OR yanked. Put point at end, and set mark at beginning.
3307 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3308 With argument N, reinsert the Nth most recently killed stretch of killed
3309 text.
3310
3311 When this command inserts killed text into the buffer, it honors
3312 `yank-excluded-properties' and `yank-handler' as described in the
3313 doc string for `insert-for-yank-1', which see.
3314
3315 See also the command `yank-pop' (\\[yank-pop])."
3316 (interactive "*P")
3317 (setq yank-window-start (window-start))
3318 ;; If we don't get all the way thru, make last-command indicate that
3319 ;; for the following command.
3320 (setq this-command t)
3321 (push-mark (point))
3322 (insert-for-yank (current-kill (cond
3323 ((listp arg) 0)
3324 ((eq arg '-) -2)
3325 (t (1- arg)))))
3326 (if (consp arg)
3327 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3328 ;; It is cleaner to avoid activation, even though the command
3329 ;; loop would deactivate the mark because we inserted text.
3330 (goto-char (prog1 (mark t)
3331 (set-marker (mark-marker) (point) (current-buffer)))))
3332 ;; If we do get all the way thru, make this-command indicate that.
3333 (if (eq this-command t)
3334 (setq this-command 'yank))
3335 nil)
3336
3337 (defun rotate-yank-pointer (arg)
3338 "Rotate the yanking point in the kill ring.
3339 With ARG, rotate that many kills forward (or backward, if negative)."
3340 (interactive "p")
3341 (current-kill arg))
3342 \f
3343 ;; Some kill commands.
3344
3345 ;; Internal subroutine of delete-char
3346 (defun kill-forward-chars (arg)
3347 (if (listp arg) (setq arg (car arg)))
3348 (if (eq arg '-) (setq arg -1))
3349 (kill-region (point) (+ (point) arg)))
3350
3351 ;; Internal subroutine of backward-delete-char
3352 (defun kill-backward-chars (arg)
3353 (if (listp arg) (setq arg (car arg)))
3354 (if (eq arg '-) (setq arg -1))
3355 (kill-region (point) (- (point) arg)))
3356
3357 (defcustom backward-delete-char-untabify-method 'untabify
3358 "The method for untabifying when deleting backward.
3359 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3360 `hungry' -- delete all whitespace, both tabs and spaces;
3361 `all' -- delete all whitespace, including tabs, spaces and newlines;
3362 nil -- just delete one character."
3363 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3364 :version "20.3"
3365 :group 'killing)
3366
3367 (defun backward-delete-char-untabify (arg &optional killp)
3368 "Delete characters backward, changing tabs into spaces.
3369 The exact behavior depends on `backward-delete-char-untabify-method'.
3370 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3371 Interactively, ARG is the prefix arg (default 1)
3372 and KILLP is t if a prefix arg was specified."
3373 (interactive "*p\nP")
3374 (when (eq backward-delete-char-untabify-method 'untabify)
3375 (let ((count arg))
3376 (save-excursion
3377 (while (and (> count 0) (not (bobp)))
3378 (if (= (preceding-char) ?\t)
3379 (let ((col (current-column)))
3380 (forward-char -1)
3381 (setq col (- col (current-column)))
3382 (insert-char ?\s col)
3383 (delete-char 1)))
3384 (forward-char -1)
3385 (setq count (1- count))))))
3386 (let* ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
3387 ((eq backward-delete-char-untabify-method 'all)
3388 " \t\n\r")))
3389 (n (if skip
3390 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3391 (point)))))
3392 (+ arg (if (zerop wh) 0 (1- wh))))
3393 arg)))
3394 ;; Avoid warning about delete-backward-char
3395 (with-no-warnings (delete-backward-char n killp))))
3396
3397 (defun zap-to-char (arg char)
3398 "Kill up to and including ARGth occurrence of CHAR.
3399 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3400 Goes backward if ARG is negative; error if CHAR not found."
3401 (interactive "p\ncZap to char: ")
3402 ;; Avoid "obsolete" warnings for translation-table-for-input.
3403 (with-no-warnings
3404 (if (char-table-p translation-table-for-input)
3405 (setq char (or (aref translation-table-for-input char) char))))
3406 (kill-region (point) (progn
3407 (search-forward (char-to-string char) nil nil arg)
3408 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3409 (point))))
3410
3411 ;; kill-line and its subroutines.
3412
3413 (defcustom kill-whole-line nil
3414 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3415 :type 'boolean
3416 :group 'killing)
3417
3418 (defun kill-line (&optional arg)
3419 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3420 With prefix argument ARG, kill that many lines from point.
3421 Negative arguments kill lines backward.
3422 With zero argument, kills the text before point on the current line.
3423
3424 When calling from a program, nil means \"no arg\",
3425 a number counts as a prefix arg.
3426
3427 To kill a whole line, when point is not at the beginning, type \
3428 \\[move-beginning-of-line] \\[kill-line] \\[kill-line].
3429
3430 If `kill-whole-line' is non-nil, then this command kills the whole line
3431 including its terminating newline, when used at the beginning of a line
3432 with no argument. As a consequence, you can always kill a whole line
3433 by typing \\[move-beginning-of-line] \\[kill-line].
3434
3435 If you want to append the killed line to the last killed text,
3436 use \\[append-next-kill] before \\[kill-line].
3437
3438 If the buffer is read-only, Emacs will beep and refrain from deleting
3439 the line, but put the line in the kill ring anyway. This means that
3440 you can use this command to copy text from a read-only buffer.
3441 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3442 even beep.)"
3443 (interactive "P")
3444 (kill-region (point)
3445 ;; It is better to move point to the other end of the kill
3446 ;; before killing. That way, in a read-only buffer, point
3447 ;; moves across the text that is copied to the kill ring.
3448 ;; The choice has no effect on undo now that undo records
3449 ;; the value of point from before the command was run.
3450 (progn
3451 (if arg
3452 (forward-visible-line (prefix-numeric-value arg))
3453 (if (eobp)
3454 (signal 'end-of-buffer nil))
3455 (let ((end
3456 (save-excursion
3457 (end-of-visible-line) (point))))
3458 (if (or (save-excursion
3459 ;; If trailing whitespace is visible,
3460 ;; don't treat it as nothing.
3461 (unless show-trailing-whitespace
3462 (skip-chars-forward " \t" end))
3463 (= (point) end))
3464 (and kill-whole-line (bolp)))
3465 (forward-visible-line 1)
3466 (goto-char end))))
3467 (point))))
3468
3469 (defun kill-whole-line (&optional arg)
3470 "Kill current line.
3471 With prefix ARG, kill that many lines starting from the current line.
3472 If ARG is negative, kill backward. Also kill the preceding newline.
3473 \(This is meant to make \\[repeat] work well with negative arguments.\)
3474 If ARG is zero, kill current line but exclude the trailing newline."
3475 (interactive "p")
3476 (or arg (setq arg 1))
3477 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3478 (signal 'end-of-buffer nil))
3479 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3480 (signal 'beginning-of-buffer nil))
3481 (unless (eq last-command 'kill-region)
3482 (kill-new "")
3483 (setq last-command 'kill-region))
3484 (cond ((zerop arg)
3485 ;; We need to kill in two steps, because the previous command
3486 ;; could have been a kill command, in which case the text
3487 ;; before point needs to be prepended to the current kill
3488 ;; ring entry and the text after point appended. Also, we
3489 ;; need to use save-excursion to avoid copying the same text
3490 ;; twice to the kill ring in read-only buffers.
3491 (save-excursion
3492 (kill-region (point) (progn (forward-visible-line 0) (point))))
3493 (kill-region (point) (progn (end-of-visible-line) (point))))
3494 ((< arg 0)
3495 (save-excursion
3496 (kill-region (point) (progn (end-of-visible-line) (point))))
3497 (kill-region (point)
3498 (progn (forward-visible-line (1+ arg))
3499 (unless (bobp) (backward-char))
3500 (point))))
3501 (t
3502 (save-excursion
3503 (kill-region (point) (progn (forward-visible-line 0) (point))))
3504 (kill-region (point)
3505 (progn (forward-visible-line arg) (point))))))
3506
3507 (defun forward-visible-line (arg)
3508 "Move forward by ARG lines, ignoring currently invisible newlines only.
3509 If ARG is negative, move backward -ARG lines.
3510 If ARG is zero, move to the beginning of the current line."
3511 (condition-case nil
3512 (if (> arg 0)
3513 (progn
3514 (while (> arg 0)
3515 (or (zerop (forward-line 1))
3516 (signal 'end-of-buffer nil))
3517 ;; If the newline we just skipped is invisible,
3518 ;; don't count it.
3519 (let ((prop
3520 (get-char-property (1- (point)) 'invisible)))
3521 (if (if (eq buffer-invisibility-spec t)
3522 prop
3523 (or (memq prop buffer-invisibility-spec)
3524 (assq prop buffer-invisibility-spec)))
3525 (setq arg (1+ arg))))
3526 (setq arg (1- arg)))
3527 ;; If invisible text follows, and it is a number of complete lines,
3528 ;; skip it.
3529 (let ((opoint (point)))
3530 (while (and (not (eobp))
3531 (let ((prop
3532 (get-char-property (point) 'invisible)))
3533 (if (eq buffer-invisibility-spec t)
3534 prop
3535 (or (memq prop buffer-invisibility-spec)
3536 (assq prop buffer-invisibility-spec)))))
3537 (goto-char
3538 (if (get-text-property (point) 'invisible)
3539 (or (next-single-property-change (point) 'invisible)
3540 (point-max))
3541 (next-overlay-change (point)))))
3542 (unless (bolp)
3543 (goto-char opoint))))
3544 (let ((first t))
3545 (while (or first (<= arg 0))
3546 (if first
3547 (beginning-of-line)
3548 (or (zerop (forward-line -1))
3549 (signal 'beginning-of-buffer nil)))
3550 ;; If the newline we just moved to is invisible,
3551 ;; don't count it.
3552 (unless (bobp)
3553 (let ((prop
3554 (get-char-property (1- (point)) 'invisible)))
3555 (unless (if (eq buffer-invisibility-spec t)
3556 prop
3557 (or (memq prop buffer-invisibility-spec)
3558 (assq prop buffer-invisibility-spec)))
3559 (setq arg (1+ arg)))))
3560 (setq first nil))
3561 ;; If invisible text follows, and it is a number of complete lines,
3562 ;; skip it.
3563 (let ((opoint (point)))
3564 (while (and (not (bobp))
3565 (let ((prop
3566 (get-char-property (1- (point)) 'invisible)))
3567 (if (eq buffer-invisibility-spec t)
3568 prop
3569 (or (memq prop buffer-invisibility-spec)
3570 (assq prop buffer-invisibility-spec)))))
3571 (goto-char
3572 (if (get-text-property (1- (point)) 'invisible)
3573 (or (previous-single-property-change (point) 'invisible)
3574 (point-min))
3575 (previous-overlay-change (point)))))
3576 (unless (bolp)
3577 (goto-char opoint)))))
3578 ((beginning-of-buffer end-of-buffer)
3579 nil)))
3580
3581 (defun end-of-visible-line ()
3582 "Move to end of current visible line."
3583 (end-of-line)
3584 ;; If the following character is currently invisible,
3585 ;; skip all characters with that same `invisible' property value,
3586 ;; then find the next newline.
3587 (while (and (not (eobp))
3588 (save-excursion
3589 (skip-chars-forward "^\n")
3590 (let ((prop
3591 (get-char-property (point) 'invisible)))
3592 (if (eq buffer-invisibility-spec t)
3593 prop
3594 (or (memq prop buffer-invisibility-spec)
3595 (assq prop buffer-invisibility-spec))))))
3596 (skip-chars-forward "^\n")
3597 (if (get-text-property (point) 'invisible)
3598 (goto-char (next-single-property-change (point) 'invisible))
3599 (goto-char (next-overlay-change (point))))
3600 (end-of-line)))
3601 \f
3602 (defun insert-buffer (buffer)
3603 "Insert after point the contents of BUFFER.
3604 Puts mark after the inserted text.
3605 BUFFER may be a buffer or a buffer name.
3606
3607 This function is meant for the user to run interactively.
3608 Don't call it from programs: use `insert-buffer-substring' instead!"
3609 (interactive
3610 (list
3611 (progn
3612 (barf-if-buffer-read-only)
3613 (read-buffer "Insert buffer: "
3614 (if (eq (selected-window) (next-window (selected-window)))
3615 (other-buffer (current-buffer))
3616 (window-buffer (next-window (selected-window))))
3617 t))))
3618 (push-mark
3619 (save-excursion
3620 (insert-buffer-substring (get-buffer buffer))
3621 (point)))
3622 nil)
3623
3624 (defun append-to-buffer (buffer start end)
3625 "Append to specified buffer the text of the region.
3626 It is inserted into that buffer before its point.
3627
3628 When calling from a program, give three arguments:
3629 BUFFER (or buffer name), START and END.
3630 START and END specify the portion of the current buffer to be copied."
3631 (interactive
3632 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3633 (region-beginning) (region-end)))
3634 (let* ((oldbuf (current-buffer))
3635 (append-to (get-buffer-create buffer))
3636 (windows (get-buffer-window-list append-to t t))
3637 point)
3638 (save-excursion
3639 (with-current-buffer append-to
3640 (setq point (point))
3641 (barf-if-buffer-read-only)
3642 (insert-buffer-substring oldbuf start end)
3643 (dolist (window windows)
3644 (when (= (window-point window) point)
3645 (set-window-point window (point))))))))
3646
3647 (defun prepend-to-buffer (buffer start end)
3648 "Prepend to specified buffer the text of the region.
3649 It is inserted into that buffer after its point.
3650
3651 When calling from a program, give three arguments:
3652 BUFFER (or buffer name), START and END.
3653 START and END specify the portion of the current buffer to be copied."
3654 (interactive "BPrepend to buffer: \nr")
3655 (let ((oldbuf (current-buffer)))
3656 (with-current-buffer (get-buffer-create buffer)
3657 (barf-if-buffer-read-only)
3658 (save-excursion
3659 (insert-buffer-substring oldbuf start end)))))
3660
3661 (defun copy-to-buffer (buffer start end)
3662 "Copy to specified buffer the text of the region.
3663 It is inserted into that buffer, replacing existing text there.
3664
3665 When calling from a program, give three arguments:
3666 BUFFER (or buffer name), START and END.
3667 START and END specify the portion of the current buffer to be copied."
3668 (interactive "BCopy to buffer: \nr")
3669 (let ((oldbuf (current-buffer)))
3670 (with-current-buffer (get-buffer-create buffer)
3671 (barf-if-buffer-read-only)
3672 (erase-buffer)
3673 (save-excursion
3674 (insert-buffer-substring oldbuf start end)))))
3675 \f
3676 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3677 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3678
3679 (defvar activate-mark-hook nil
3680 "Hook run when the mark becomes active.
3681 It is also run at the end of a command, if the mark is active and
3682 it is possible that the region may have changed.")
3683
3684 (defvar deactivate-mark-hook nil
3685 "Hook run when the mark becomes inactive.")
3686
3687 (defun mark (&optional force)
3688 "Return this buffer's mark value as integer, or nil if never set.
3689
3690 In Transient Mark mode, this function signals an error if
3691 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3692 or the argument FORCE is non-nil, it disregards whether the mark
3693 is active, and returns an integer or nil in the usual way.
3694
3695 If you are using this in an editing command, you are most likely making
3696 a mistake; see the documentation of `set-mark'."
3697 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3698 (marker-position (mark-marker))
3699 (signal 'mark-inactive nil)))
3700
3701 (defsubst deactivate-mark (&optional force)
3702 "Deactivate the mark by setting `mark-active' to nil.
3703 Unless FORCE is non-nil, this function does nothing if Transient
3704 Mark mode is disabled.
3705 This function also runs `deactivate-mark-hook'."
3706 (when (or transient-mark-mode force)
3707 (when (and (if (eq select-active-regions 'only)
3708 (eq (car-safe transient-mark-mode) 'only)
3709 select-active-regions)
3710 (region-active-p)
3711 (display-selections-p))
3712 ;; The var `saved-region-selection', if non-nil, is the text in
3713 ;; the region prior to the last command modifying the buffer.
3714 ;; Set the selection to that, or to the current region.
3715 (cond (saved-region-selection
3716 (x-set-selection 'PRIMARY saved-region-selection)
3717 (setq saved-region-selection nil))
3718 ((/= (region-beginning) (region-end))
3719 (x-set-selection 'PRIMARY
3720 (buffer-substring-no-properties
3721 (region-beginning)
3722 (region-end))))))
3723 (if (and (null force)
3724 (or (eq transient-mark-mode 'lambda)
3725 (and (eq (car-safe transient-mark-mode) 'only)
3726 (null (cdr transient-mark-mode)))))
3727 ;; When deactivating a temporary region, don't change
3728 ;; `mark-active' or run `deactivate-mark-hook'.
3729 (setq transient-mark-mode nil)
3730 (if (eq (car-safe transient-mark-mode) 'only)
3731 (setq transient-mark-mode (cdr transient-mark-mode)))
3732 (setq mark-active nil)
3733 (run-hooks 'deactivate-mark-hook))))
3734
3735 (defun activate-mark ()
3736 "Activate the mark."
3737 (when (mark t)
3738 (setq mark-active t)
3739 (unless transient-mark-mode
3740 (setq transient-mark-mode 'lambda))))
3741
3742 (defun set-mark (pos)
3743 "Set this buffer's mark to POS. Don't use this function!
3744 That is to say, don't use this function unless you want
3745 the user to see that the mark has moved, and you want the previous
3746 mark position to be lost.
3747
3748 Normally, when a new mark is set, the old one should go on the stack.
3749 This is why most applications should use `push-mark', not `set-mark'.
3750
3751 Novice Emacs Lisp programmers often try to use the mark for the wrong
3752 purposes. The mark saves a location for the user's convenience.
3753 Most editing commands should not alter the mark.
3754 To remember a location for internal use in the Lisp program,
3755 store it in a Lisp variable. Example:
3756
3757 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3758
3759 (if pos
3760 (progn
3761 (setq mark-active t)
3762 (run-hooks 'activate-mark-hook)
3763 (set-marker (mark-marker) pos (current-buffer)))
3764 ;; Normally we never clear mark-active except in Transient Mark mode.
3765 ;; But when we actually clear out the mark value too, we must
3766 ;; clear mark-active in any mode.
3767 (deactivate-mark t)
3768 (set-marker (mark-marker) nil)))
3769
3770 (defcustom use-empty-active-region nil
3771 "Whether \"region-aware\" commands should act on empty regions.
3772 If nil, region-aware commands treat empty regions as inactive.
3773 If non-nil, region-aware commands treat the region as active as
3774 long as the mark is active, even if the region is empty.
3775
3776 Region-aware commands are those that act on the region if it is
3777 active and Transient Mark mode is enabled, and on the text near
3778 point otherwise."
3779 :type 'boolean
3780 :version "23.1"
3781 :group 'editing-basics)
3782
3783 (defun use-region-p ()
3784 "Return t if the region is active and it is appropriate to act on it.
3785 This is used by commands that act specially on the region under
3786 Transient Mark mode.
3787
3788 The return value is t if Transient Mark mode is enabled and the
3789 mark is active; furthermore, if `use-empty-active-region' is nil,
3790 the region must not be empty. Otherwise, the return value is nil.
3791
3792 For some commands, it may be appropriate to ignore the value of
3793 `use-empty-active-region'; in that case, use `region-active-p'."
3794 (and (region-active-p)
3795 (or use-empty-active-region (> (region-end) (region-beginning)))))
3796
3797 (defun region-active-p ()
3798 "Return t if Transient Mark mode is enabled and the mark is active.
3799
3800 Some commands act specially on the region when Transient Mark
3801 mode is enabled. Usually, such commands should use
3802 `use-region-p' instead of this function, because `use-region-p'
3803 also checks the value of `use-empty-active-region'."
3804 (and transient-mark-mode mark-active))
3805
3806 (defvar mark-ring nil
3807 "The list of former marks of the current buffer, most recent first.")
3808 (make-variable-buffer-local 'mark-ring)
3809 (put 'mark-ring 'permanent-local t)
3810
3811 (defcustom mark-ring-max 16
3812 "Maximum size of mark ring. Start discarding off end if gets this big."
3813 :type 'integer
3814 :group 'editing-basics)
3815
3816 (defvar global-mark-ring nil
3817 "The list of saved global marks, most recent first.")
3818
3819 (defcustom global-mark-ring-max 16
3820 "Maximum size of global mark ring. \
3821 Start discarding off end if gets this big."
3822 :type 'integer
3823 :group 'editing-basics)
3824
3825 (defun pop-to-mark-command ()
3826 "Jump to mark, and pop a new position for mark off the ring.
3827 \(Does not affect global mark ring\)."
3828 (interactive)
3829 (if (null (mark t))
3830 (error "No mark set in this buffer")
3831 (if (= (point) (mark t))
3832 (message "Mark popped"))
3833 (goto-char (mark t))
3834 (pop-mark)))
3835
3836 (defun push-mark-command (arg &optional nomsg)
3837 "Set mark at where point is.
3838 If no prefix ARG and mark is already set there, just activate it.
3839 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3840 (interactive "P")
3841 (let ((mark (marker-position (mark-marker))))
3842 (if (or arg (null mark) (/= mark (point)))
3843 (push-mark nil nomsg t)
3844 (setq mark-active t)
3845 (run-hooks 'activate-mark-hook)
3846 (unless nomsg
3847 (message "Mark activated")))))
3848
3849 (defcustom set-mark-command-repeat-pop nil
3850 "Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
3851 That means that C-u \\[set-mark-command] \\[set-mark-command]
3852 will pop the mark twice, and
3853 C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
3854 will pop the mark three times.
3855
3856 A value of nil means \\[set-mark-command]'s behavior does not change
3857 after C-u \\[set-mark-command]."
3858 :type 'boolean
3859 :group 'editing-basics)
3860
3861 (defcustom set-mark-default-inactive nil
3862 "If non-nil, setting the mark does not activate it.
3863 This causes \\[set-mark-command] and \\[exchange-point-and-mark] to
3864 behave the same whether or not `transient-mark-mode' is enabled."
3865 :type 'boolean
3866 :group 'editing-basics
3867 :version "23.1")
3868
3869 (defun set-mark-command (arg)
3870 "Set the mark where point is, or jump to the mark.
3871 Setting the mark also alters the region, which is the text
3872 between point and mark; this is the closest equivalent in
3873 Emacs to what some editors call the \"selection\".
3874
3875 With no prefix argument, set the mark at point, and push the
3876 old mark position on local mark ring. Also push the old mark on
3877 global mark ring, if the previous mark was set in another buffer.
3878
3879 When Transient Mark Mode is off, immediately repeating this
3880 command activates `transient-mark-mode' temporarily.
3881
3882 With prefix argument \(e.g., \\[universal-argument] \\[set-mark-command]\), \
3883 jump to the mark, and set the mark from
3884 position popped off the local mark ring \(this does not affect the global
3885 mark ring\). Use \\[pop-global-mark] to jump to a mark popped off the global
3886 mark ring \(see `pop-global-mark'\).
3887
3888 If `set-mark-command-repeat-pop' is non-nil, repeating
3889 the \\[set-mark-command] command with no prefix argument pops the next position
3890 off the local (or global) mark ring and jumps there.
3891
3892 With \\[universal-argument] \\[universal-argument] as prefix
3893 argument, unconditionally set mark where point is, even if
3894 `set-mark-command-repeat-pop' is non-nil.
3895
3896 Novice Emacs Lisp programmers often try to use the mark for the wrong
3897 purposes. See the documentation of `set-mark' for more information."
3898 (interactive "P")
3899 (cond ((eq transient-mark-mode 'lambda)
3900 (setq transient-mark-mode nil))
3901 ((eq (car-safe transient-mark-mode) 'only)
3902 (deactivate-mark)))
3903 (cond
3904 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3905 (push-mark-command nil))
3906 ((not (eq this-command 'set-mark-command))
3907 (if arg
3908 (pop-to-mark-command)
3909 (push-mark-command t)))
3910 ((and set-mark-command-repeat-pop
3911 (eq last-command 'pop-to-mark-command))
3912 (setq this-command 'pop-to-mark-command)
3913 (pop-to-mark-command))
3914 ((and set-mark-command-repeat-pop
3915 (eq last-command 'pop-global-mark)
3916 (not arg))
3917 (setq this-command 'pop-global-mark)
3918 (pop-global-mark))
3919 (arg
3920 (setq this-command 'pop-to-mark-command)
3921 (pop-to-mark-command))
3922 ((eq last-command 'set-mark-command)
3923 (if (region-active-p)
3924 (progn
3925 (deactivate-mark)
3926 (message "Mark deactivated"))
3927 (activate-mark)
3928 (message "Mark activated")))
3929 (t
3930 (push-mark-command nil)
3931 (if set-mark-default-inactive (deactivate-mark)))))
3932
3933 (defun push-mark (&optional location nomsg activate)
3934 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3935 If the last global mark pushed was not in the current buffer,
3936 also push LOCATION on the global mark ring.
3937 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3938
3939 Novice Emacs Lisp programmers often try to use the mark for the wrong
3940 purposes. See the documentation of `set-mark' for more information.
3941
3942 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3943 (unless (null (mark t))
3944 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3945 (when (> (length mark-ring) mark-ring-max)
3946 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3947 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3948 (set-marker (mark-marker) (or location (point)) (current-buffer))
3949 ;; Now push the mark on the global mark ring.
3950 (if (and global-mark-ring
3951 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3952 ;; The last global mark pushed was in this same buffer.
3953 ;; Don't push another one.
3954 nil
3955 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3956 (when (> (length global-mark-ring) global-mark-ring-max)
3957 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3958 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3959 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3960 (message "Mark set"))
3961 (if (or activate (not transient-mark-mode))
3962 (set-mark (mark t)))
3963 nil)
3964
3965 (defun pop-mark ()
3966 "Pop off mark ring into the buffer's actual mark.
3967 Does not set point. Does nothing if mark ring is empty."
3968 (when mark-ring
3969 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3970 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3971 (move-marker (car mark-ring) nil)
3972 (if (null (mark t)) (ding))
3973 (setq mark-ring (cdr mark-ring)))
3974 (deactivate-mark))
3975
3976 (define-obsolete-function-alias
3977 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3978 (defun exchange-point-and-mark (&optional arg)
3979 "Put the mark where point is now, and point where the mark is now.
3980 This command works even when the mark is not active,
3981 and it reactivates the mark.
3982
3983 If Transient Mark mode is on, a prefix ARG deactivates the mark
3984 if it is active, and otherwise avoids reactivating it. If
3985 Transient Mark mode is off, a prefix ARG enables Transient Mark
3986 mode temporarily."
3987 (interactive "P")
3988 (let ((omark (mark t))
3989 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3990 (if (null omark)
3991 (error "No mark set in this buffer"))
3992 (deactivate-mark)
3993 (set-mark (point))
3994 (goto-char omark)
3995 (if set-mark-default-inactive (deactivate-mark))
3996 (cond (temp-highlight
3997 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3998 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3999 (not (or arg (region-active-p))))
4000 (deactivate-mark))
4001 (t (activate-mark)))
4002 nil))
4003
4004 (defcustom shift-select-mode t
4005 "When non-nil, shifted motion keys activate the mark momentarily.
4006
4007 While the mark is activated in this way, any shift-translated point
4008 motion key extends the region, and if Transient Mark mode was off, it
4009 is temporarily turned on. Furthermore, the mark will be deactivated
4010 by any subsequent point motion key that was not shift-translated, or
4011 by any action that normally deactivates the mark in Transient Mark mode.
4012
4013 See `this-command-keys-shift-translated' for the meaning of
4014 shift-translation."
4015 :type 'boolean
4016 :group 'editing-basics)
4017
4018 (defun handle-shift-selection ()
4019 "Activate/deactivate mark depending on invocation thru shift translation.
4020 This function is called by `call-interactively' when a command
4021 with a `^' character in its `interactive' spec is invoked, before
4022 running the command itself.
4023
4024 If `shift-select-mode' is enabled and the command was invoked
4025 through shift translation, set the mark and activate the region
4026 temporarily, unless it was already set in this way. See
4027 `this-command-keys-shift-translated' for the meaning of shift
4028 translation.
4029
4030 Otherwise, if the region has been activated temporarily,
4031 deactivate it, and restore the variable `transient-mark-mode' to
4032 its earlier value."
4033 (cond ((and shift-select-mode this-command-keys-shift-translated)
4034 (unless (and mark-active
4035 (eq (car-safe transient-mark-mode) 'only))
4036 (setq transient-mark-mode
4037 (cons 'only
4038 (unless (eq transient-mark-mode 'lambda)
4039 transient-mark-mode)))
4040 (push-mark nil nil t)))
4041 ((eq (car-safe transient-mark-mode) 'only)
4042 (setq transient-mark-mode (cdr transient-mark-mode))
4043 (deactivate-mark))))
4044
4045 (define-minor-mode transient-mark-mode
4046 "Toggle Transient Mark mode.
4047 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4048
4049 In Transient Mark mode, when the mark is active, the region is highlighted.
4050 Changing the buffer \"deactivates\" the mark.
4051 So do certain other operations that set the mark
4052 but whose main purpose is something else--for example,
4053 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
4054
4055 You can also deactivate the mark by typing \\[keyboard-quit] or
4056 \\[keyboard-escape-quit].
4057
4058 Many commands change their behavior when Transient Mark mode is in effect
4059 and the mark is active, by acting on the region instead of their usual
4060 default part of the buffer's text. Examples of such commands include
4061 \\[comment-dwim], \\[flush-lines], \\[keep-lines], \
4062 \\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
4063 Invoke \\[apropos-documentation] and type \"transient\" or
4064 \"mark.*active\" at the prompt, to see the documentation of
4065 commands which are sensitive to the Transient Mark mode."
4066 :global t
4067 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4068 :variable transient-mark-mode)
4069
4070 (defvar widen-automatically t
4071 "Non-nil means it is ok for commands to call `widen' when they want to.
4072 Some commands will do this in order to go to positions outside
4073 the current accessible part of the buffer.
4074
4075 If `widen-automatically' is nil, these commands will do something else
4076 as a fallback, and won't change the buffer bounds.")
4077
4078 (defvar non-essential nil
4079 "Whether the currently executing code is performing an essential task.
4080 This variable should be non-nil only when running code which should not
4081 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4082 user for a password when we are simply scanning a set of files in the
4083 background or displaying possible completions before the user even asked
4084 for it.")
4085
4086 (defun pop-global-mark ()
4087 "Pop off global mark ring and jump to the top location."
4088 (interactive)
4089 ;; Pop entries which refer to non-existent buffers.
4090 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4091 (setq global-mark-ring (cdr global-mark-ring)))
4092 (or global-mark-ring
4093 (error "No global mark set"))
4094 (let* ((marker (car global-mark-ring))
4095 (buffer (marker-buffer marker))
4096 (position (marker-position marker)))
4097 (setq global-mark-ring (nconc (cdr global-mark-ring)
4098 (list (car global-mark-ring))))
4099 (set-buffer buffer)
4100 (or (and (>= position (point-min))
4101 (<= position (point-max)))
4102 (if widen-automatically
4103 (widen)
4104 (error "Global mark position is outside accessible part of buffer")))
4105 (goto-char position)
4106 (switch-to-buffer buffer)))
4107 \f
4108 (defcustom next-line-add-newlines nil
4109 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4110 :type 'boolean
4111 :version "21.1"
4112 :group 'editing-basics)
4113
4114 (defun next-line (&optional arg try-vscroll)
4115 "Move cursor vertically down ARG lines.
4116 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4117 If there is no character in the target line exactly under the current column,
4118 the cursor is positioned after the character in that line which spans this
4119 column, or at the end of the line if it is not long enough.
4120 If there is no line in the buffer after this one, behavior depends on the
4121 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4122 to create a line, and moves the cursor to that line. Otherwise it moves the
4123 cursor to the end of the buffer.
4124
4125 If the variable `line-move-visual' is non-nil, this command moves
4126 by display lines. Otherwise, it moves by buffer lines, without
4127 taking variable-width characters or continued lines into account.
4128
4129 The command \\[set-goal-column] can be used to create
4130 a semipermanent goal column for this command.
4131 Then instead of trying to move exactly vertically (or as close as possible),
4132 this command moves to the specified goal column (or as close as possible).
4133 The goal column is stored in the variable `goal-column', which is nil
4134 when there is no goal column.
4135
4136 If you are thinking of using this in a Lisp program, consider
4137 using `forward-line' instead. It is usually easier to use
4138 and more reliable (no dependence on goal column, etc.)."
4139 (interactive "^p\np")
4140 (or arg (setq arg 1))
4141 (if (and next-line-add-newlines (= arg 1))
4142 (if (save-excursion (end-of-line) (eobp))
4143 ;; When adding a newline, don't expand an abbrev.
4144 (let ((abbrev-mode nil))
4145 (end-of-line)
4146 (insert (if use-hard-newlines hard-newline "\n")))
4147 (line-move arg nil nil try-vscroll))
4148 (if (called-interactively-p 'interactive)
4149 (condition-case err
4150 (line-move arg nil nil try-vscroll)
4151 ((beginning-of-buffer end-of-buffer)
4152 (signal (car err) (cdr err))))
4153 (line-move arg nil nil try-vscroll)))
4154 nil)
4155
4156 (defun previous-line (&optional arg try-vscroll)
4157 "Move cursor vertically up ARG lines.
4158 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4159 If there is no character in the target line exactly over the current column,
4160 the cursor is positioned after the character in that line which spans this
4161 column, or at the end of the line if it is not long enough.
4162
4163 If the variable `line-move-visual' is non-nil, this command moves
4164 by display lines. Otherwise, it moves by buffer lines, without
4165 taking variable-width characters or continued lines into account.
4166
4167 The command \\[set-goal-column] can be used to create
4168 a semipermanent goal column for this command.
4169 Then instead of trying to move exactly vertically (or as close as possible),
4170 this command moves to the specified goal column (or as close as possible).
4171 The goal column is stored in the variable `goal-column', which is nil
4172 when there is no goal column.
4173
4174 If you are thinking of using this in a Lisp program, consider using
4175 `forward-line' with a negative argument instead. It is usually easier
4176 to use and more reliable (no dependence on goal column, etc.)."
4177 (interactive "^p\np")
4178 (or arg (setq arg 1))
4179 (if (called-interactively-p 'interactive)
4180 (condition-case err
4181 (line-move (- arg) nil nil try-vscroll)
4182 ((beginning-of-buffer end-of-buffer)
4183 (signal (car err) (cdr err))))
4184 (line-move (- arg) nil nil try-vscroll))
4185 nil)
4186
4187 (defcustom track-eol nil
4188 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4189 This means moving to the end of each line moved onto.
4190 The beginning of a blank line does not count as the end of a line.
4191 This has no effect when `line-move-visual' is non-nil."
4192 :type 'boolean
4193 :group 'editing-basics)
4194
4195 (defcustom goal-column nil
4196 "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
4197 :type '(choice integer
4198 (const :tag "None" nil))
4199 :group 'editing-basics)
4200 (make-variable-buffer-local 'goal-column)
4201
4202 (defvar temporary-goal-column 0
4203 "Current goal column for vertical motion.
4204 It is the column where point was at the start of the current run
4205 of vertical motion commands.
4206
4207 When moving by visual lines via `line-move-visual', it is a cons
4208 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4209 divided by the default column width, and HSCROLL is the number of
4210 columns by which window is scrolled from left margin.
4211
4212 When the `track-eol' feature is doing its job, the value is
4213 `most-positive-fixnum'.")
4214
4215 (defcustom line-move-ignore-invisible t
4216 "Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
4217 Outline mode sets this."
4218 :type 'boolean
4219 :group 'editing-basics)
4220
4221 (defcustom line-move-visual t
4222 "When non-nil, `line-move' moves point by visual lines.
4223 This movement is based on where the cursor is displayed on the
4224 screen, instead of relying on buffer contents alone. It takes
4225 into account variable-width characters and line continuation.
4226 If nil, `line-move' moves point by logical lines."
4227 :type 'boolean
4228 :group 'editing-basics
4229 :version "23.1")
4230
4231 ;; Returns non-nil if partial move was done.
4232 (defun line-move-partial (arg noerror to-end)
4233 (if (< arg 0)
4234 ;; Move backward (up).
4235 ;; If already vscrolled, reduce vscroll
4236 (let ((vs (window-vscroll nil t)))
4237 (when (> vs (frame-char-height))
4238 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4239
4240 ;; Move forward (down).
4241 (let* ((lh (window-line-height -1))
4242 (vpos (nth 1 lh))
4243 (ypos (nth 2 lh))
4244 (rbot (nth 3 lh))
4245 py vs)
4246 (when (or (null lh)
4247 (>= rbot (frame-char-height))
4248 (<= ypos (- (frame-char-height))))
4249 (unless lh
4250 (let ((wend (pos-visible-in-window-p t nil t)))
4251 (setq rbot (nth 3 wend)
4252 vpos (nth 5 wend))))
4253 (cond
4254 ;; If last line of window is fully visible, move forward.
4255 ((or (null rbot) (= rbot 0))
4256 nil)
4257 ;; If cursor is not in the bottom scroll margin, move forward.
4258 ((and (> vpos 0)
4259 (< (setq py
4260 (or (nth 1 (window-line-height))
4261 (let ((ppos (posn-at-point)))
4262 (cdr (or (posn-actual-col-row ppos)
4263 (posn-col-row ppos))))))
4264 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4265 nil)
4266 ;; When already vscrolled, we vscroll some more if we can,
4267 ;; or clear vscroll and move forward at end of tall image.
4268 ((> (setq vs (window-vscroll nil t)) 0)
4269 (when (> rbot 0)
4270 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4271 ;; If cursor just entered the bottom scroll margin, move forward,
4272 ;; but also vscroll one line so redisplay wont recenter.
4273 ((and (> vpos 0)
4274 (= py (min (- (window-text-height) scroll-margin 1)
4275 (1- vpos))))
4276 (set-window-vscroll nil (frame-char-height) t)
4277 (line-move-1 arg noerror to-end)
4278 t)
4279 ;; If there are lines above the last line, scroll-up one line.
4280 ((> vpos 0)
4281 (scroll-up 1)
4282 t)
4283 ;; Finally, start vscroll.
4284 (t
4285 (set-window-vscroll nil (frame-char-height) t)))))))
4286
4287
4288 ;; This is like line-move-1 except that it also performs
4289 ;; vertical scrolling of tall images if appropriate.
4290 ;; That is not really a clean thing to do, since it mixes
4291 ;; scrolling with cursor motion. But so far we don't have
4292 ;; a cleaner solution to the problem of making C-n do something
4293 ;; useful given a tall image.
4294 (defun line-move (arg &optional noerror to-end try-vscroll)
4295 (unless (and auto-window-vscroll try-vscroll
4296 ;; Only vscroll for single line moves
4297 (= (abs arg) 1)
4298 ;; But don't vscroll in a keyboard macro.
4299 (not defining-kbd-macro)
4300 (not executing-kbd-macro)
4301 (line-move-partial arg noerror to-end))
4302 (set-window-vscroll nil 0 t)
4303 (if line-move-visual
4304 (line-move-visual arg noerror)
4305 (line-move-1 arg noerror to-end))))
4306
4307 ;; Display-based alternative to line-move-1.
4308 ;; Arg says how many lines to move. The value is t if we can move the
4309 ;; specified number of lines.
4310 (defun line-move-visual (arg &optional noerror)
4311 (let ((opoint (point))
4312 (hscroll (window-hscroll))
4313 target-hscroll)
4314 ;; Check if the previous command was a line-motion command, or if
4315 ;; we were called from some other command.
4316 (if (and (consp temporary-goal-column)
4317 (memq last-command `(next-line previous-line ,this-command)))
4318 ;; If so, there's no need to reset `temporary-goal-column',
4319 ;; but we may need to hscroll.
4320 (if (or (/= (cdr temporary-goal-column) hscroll)
4321 (> (cdr temporary-goal-column) 0))
4322 (setq target-hscroll (cdr temporary-goal-column)))
4323 ;; Otherwise, we should reset `temporary-goal-column'.
4324 (let ((posn (posn-at-point)))
4325 (cond
4326 ;; Handle the `overflow-newline-into-fringe' case:
4327 ((eq (nth 1 posn) 'right-fringe)
4328 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4329 ((car (posn-x-y posn))
4330 (setq temporary-goal-column
4331 (cons (/ (float (car (posn-x-y posn)))
4332 (frame-char-width)) hscroll))))))
4333 (if target-hscroll
4334 (set-window-hscroll (selected-window) target-hscroll))
4335 (or (and (= (vertical-motion
4336 (cons (or goal-column
4337 (if (consp temporary-goal-column)
4338 (car temporary-goal-column)
4339 temporary-goal-column))
4340 arg))
4341 arg)
4342 (or (>= arg 0)
4343 (/= (point) opoint)
4344 ;; If the goal column lies on a display string,
4345 ;; `vertical-motion' advances the cursor to the end
4346 ;; of the string. For arg < 0, this can cause the
4347 ;; cursor to get stuck. (Bug#3020).
4348 (= (vertical-motion arg) arg)))
4349 (unless noerror
4350 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4351 nil)))))
4352
4353 ;; This is the guts of next-line and previous-line.
4354 ;; Arg says how many lines to move.
4355 ;; The value is t if we can move the specified number of lines.
4356 (defun line-move-1 (arg &optional noerror _to-end)
4357 ;; Don't run any point-motion hooks, and disregard intangibility,
4358 ;; for intermediate positions.
4359 (let ((inhibit-point-motion-hooks t)
4360 (opoint (point))
4361 (orig-arg arg))
4362 (if (consp temporary-goal-column)
4363 (setq temporary-goal-column (+ (car temporary-goal-column)
4364 (cdr temporary-goal-column))))
4365 (unwind-protect
4366 (progn
4367 (if (not (memq last-command '(next-line previous-line)))
4368 (setq temporary-goal-column
4369 (if (and track-eol (eolp)
4370 ;; Don't count beg of empty line as end of line
4371 ;; unless we just did explicit end-of-line.
4372 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4373 most-positive-fixnum
4374 (current-column))))
4375
4376 (if (not (or (integerp selective-display)
4377 line-move-ignore-invisible))
4378 ;; Use just newline characters.
4379 ;; Set ARG to 0 if we move as many lines as requested.
4380 (or (if (> arg 0)
4381 (progn (if (> arg 1) (forward-line (1- arg)))
4382 ;; This way of moving forward ARG lines
4383 ;; verifies that we have a newline after the last one.
4384 ;; It doesn't get confused by intangible text.
4385 (end-of-line)
4386 (if (zerop (forward-line 1))
4387 (setq arg 0)))
4388 (and (zerop (forward-line arg))
4389 (bolp)
4390 (setq arg 0)))
4391 (unless noerror
4392 (signal (if (< arg 0)
4393 'beginning-of-buffer
4394 'end-of-buffer)
4395 nil)))
4396 ;; Move by arg lines, but ignore invisible ones.
4397 (let (done)
4398 (while (and (> arg 0) (not done))
4399 ;; If the following character is currently invisible,
4400 ;; skip all characters with that same `invisible' property value.
4401 (while (and (not (eobp)) (invisible-p (point)))
4402 (goto-char (next-char-property-change (point))))
4403 ;; Move a line.
4404 ;; We don't use `end-of-line', since we want to escape
4405 ;; from field boundaries occurring exactly at point.
4406 (goto-char (constrain-to-field
4407 (let ((inhibit-field-text-motion t))
4408 (line-end-position))
4409 (point) t t
4410 'inhibit-line-move-field-capture))
4411 ;; If there's no invisibility here, move over the newline.
4412 (cond
4413 ((eobp)
4414 (if (not noerror)
4415 (signal 'end-of-buffer nil)
4416 (setq done t)))
4417 ((and (> arg 1) ;; Use vertical-motion for last move
4418 (not (integerp selective-display))
4419 (not (invisible-p (point))))
4420 ;; We avoid vertical-motion when possible
4421 ;; because that has to fontify.
4422 (forward-line 1))
4423 ;; Otherwise move a more sophisticated way.
4424 ((zerop (vertical-motion 1))
4425 (if (not noerror)
4426 (signal 'end-of-buffer nil)
4427 (setq done t))))
4428 (unless done
4429 (setq arg (1- arg))))
4430 ;; The logic of this is the same as the loop above,
4431 ;; it just goes in the other direction.
4432 (while (and (< arg 0) (not done))
4433 ;; For completely consistency with the forward-motion
4434 ;; case, we should call beginning-of-line here.
4435 ;; However, if point is inside a field and on a
4436 ;; continued line, the call to (vertical-motion -1)
4437 ;; below won't move us back far enough; then we return
4438 ;; to the same column in line-move-finish, and point
4439 ;; gets stuck -- cyd
4440 (forward-line 0)
4441 (cond
4442 ((bobp)
4443 (if (not noerror)
4444 (signal 'beginning-of-buffer nil)
4445 (setq done t)))
4446 ((and (< arg -1) ;; Use vertical-motion for last move
4447 (not (integerp selective-display))
4448 (not (invisible-p (1- (point)))))
4449 (forward-line -1))
4450 ((zerop (vertical-motion -1))
4451 (if (not noerror)
4452 (signal 'beginning-of-buffer nil)
4453 (setq done t))))
4454 (unless done
4455 (setq arg (1+ arg))
4456 (while (and ;; Don't move over previous invis lines
4457 ;; if our target is the middle of this line.
4458 (or (zerop (or goal-column temporary-goal-column))
4459 (< arg 0))
4460 (not (bobp)) (invisible-p (1- (point))))
4461 (goto-char (previous-char-property-change (point))))))))
4462 ;; This is the value the function returns.
4463 (= arg 0))
4464
4465 (cond ((> arg 0)
4466 ;; If we did not move down as far as desired, at least go
4467 ;; to end of line. Be sure to call point-entered and
4468 ;; point-left-hooks.
4469 (let* ((npoint (prog1 (line-end-position)
4470 (goto-char opoint)))
4471 (inhibit-point-motion-hooks nil))
4472 (goto-char npoint)))
4473 ((< arg 0)
4474 ;; If we did not move up as far as desired,
4475 ;; at least go to beginning of line.
4476 (let* ((npoint (prog1 (line-beginning-position)
4477 (goto-char opoint)))
4478 (inhibit-point-motion-hooks nil))
4479 (goto-char npoint)))
4480 (t
4481 (line-move-finish (or goal-column temporary-goal-column)
4482 opoint (> orig-arg 0)))))))
4483
4484 (defun line-move-finish (column opoint forward)
4485 (let ((repeat t))
4486 (while repeat
4487 ;; Set REPEAT to t to repeat the whole thing.
4488 (setq repeat nil)
4489
4490 (let (new
4491 (old (point))
4492 (line-beg (line-beginning-position))
4493 (line-end
4494 ;; Compute the end of the line
4495 ;; ignoring effectively invisible newlines.
4496 (save-excursion
4497 ;; Like end-of-line but ignores fields.
4498 (skip-chars-forward "^\n")
4499 (while (and (not (eobp)) (invisible-p (point)))
4500 (goto-char (next-char-property-change (point)))
4501 (skip-chars-forward "^\n"))
4502 (point))))
4503
4504 ;; Move to the desired column.
4505 (line-move-to-column (truncate column))
4506
4507 ;; Corner case: suppose we start out in a field boundary in
4508 ;; the middle of a continued line. When we get to
4509 ;; line-move-finish, point is at the start of a new *screen*
4510 ;; line but the same text line; then line-move-to-column would
4511 ;; move us backwards. Test using C-n with point on the "x" in
4512 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4513 (and forward
4514 (< (point) old)
4515 (goto-char old))
4516
4517 (setq new (point))
4518
4519 ;; Process intangibility within a line.
4520 ;; With inhibit-point-motion-hooks bound to nil, a call to
4521 ;; goto-char moves point past intangible text.
4522
4523 ;; However, inhibit-point-motion-hooks controls both the
4524 ;; intangibility and the point-entered/point-left hooks. The
4525 ;; following hack avoids calling the point-* hooks
4526 ;; unnecessarily. Note that we move *forward* past intangible
4527 ;; text when the initial and final points are the same.
4528 (goto-char new)
4529 (let ((inhibit-point-motion-hooks nil))
4530 (goto-char new)
4531
4532 ;; If intangibility moves us to a different (later) place
4533 ;; in the same line, use that as the destination.
4534 (if (<= (point) line-end)
4535 (setq new (point))
4536 ;; If that position is "too late",
4537 ;; try the previous allowable position.
4538 ;; See if it is ok.
4539 (backward-char)
4540 (if (if forward
4541 ;; If going forward, don't accept the previous
4542 ;; allowable position if it is before the target line.
4543 (< line-beg (point))
4544 ;; If going backward, don't accept the previous
4545 ;; allowable position if it is still after the target line.
4546 (<= (point) line-end))
4547 (setq new (point))
4548 ;; As a last resort, use the end of the line.
4549 (setq new line-end))))
4550
4551 ;; Now move to the updated destination, processing fields
4552 ;; as well as intangibility.
4553 (goto-char opoint)
4554 (let ((inhibit-point-motion-hooks nil))
4555 (goto-char
4556 ;; Ignore field boundaries if the initial and final
4557 ;; positions have the same `field' property, even if the
4558 ;; fields are non-contiguous. This seems to be "nicer"
4559 ;; behavior in many situations.
4560 (if (eq (get-char-property new 'field)
4561 (get-char-property opoint 'field))
4562 new
4563 (constrain-to-field new opoint t t
4564 'inhibit-line-move-field-capture))))
4565
4566 ;; If all this moved us to a different line,
4567 ;; retry everything within that new line.
4568 (when (or (< (point) line-beg) (> (point) line-end))
4569 ;; Repeat the intangibility and field processing.
4570 (setq repeat t))))))
4571
4572 (defun line-move-to-column (col)
4573 "Try to find column COL, considering invisibility.
4574 This function works only in certain cases,
4575 because what we really need is for `move-to-column'
4576 and `current-column' to be able to ignore invisible text."
4577 (if (zerop col)
4578 (beginning-of-line)
4579 (move-to-column col))
4580
4581 (when (and line-move-ignore-invisible
4582 (not (bolp)) (invisible-p (1- (point))))
4583 (let ((normal-location (point))
4584 (normal-column (current-column)))
4585 ;; If the following character is currently invisible,
4586 ;; skip all characters with that same `invisible' property value.
4587 (while (and (not (eobp))
4588 (invisible-p (point)))
4589 (goto-char (next-char-property-change (point))))
4590 ;; Have we advanced to a larger column position?
4591 (if (> (current-column) normal-column)
4592 ;; We have made some progress towards the desired column.
4593 ;; See if we can make any further progress.
4594 (line-move-to-column (+ (current-column) (- col normal-column)))
4595 ;; Otherwise, go to the place we originally found
4596 ;; and move back over invisible text.
4597 ;; that will get us to the same place on the screen
4598 ;; but with a more reasonable buffer position.
4599 (goto-char normal-location)
4600 (let ((line-beg (line-beginning-position)))
4601 (while (and (not (bolp)) (invisible-p (1- (point))))
4602 (goto-char (previous-char-property-change (point) line-beg))))))))
4603
4604 (defun move-end-of-line (arg)
4605 "Move point to end of current line as displayed.
4606 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4607 If point reaches the beginning or end of buffer, it stops there.
4608
4609 To ignore the effects of the `intangible' text or overlay
4610 property, bind `inhibit-point-motion-hooks' to t.
4611 If there is an image in the current line, this function
4612 disregards newlines that are part of the text on which the image
4613 rests."
4614 (interactive "^p")
4615 (or arg (setq arg 1))
4616 (let (done)
4617 (while (not done)
4618 (let ((newpos
4619 (save-excursion
4620 (let ((goal-column 0)
4621 (line-move-visual nil))
4622 (and (line-move arg t)
4623 ;; With bidi reordering, we may not be at bol,
4624 ;; so make sure we are.
4625 (skip-chars-backward "^\n")
4626 (not (bobp))
4627 (progn
4628 (while (and (not (bobp)) (invisible-p (1- (point))))
4629 (goto-char (previous-single-char-property-change
4630 (point) 'invisible)))
4631 (backward-char 1)))
4632 (point)))))
4633 (goto-char newpos)
4634 (if (and (> (point) newpos)
4635 (eq (preceding-char) ?\n))
4636 (backward-char 1)
4637 (if (and (> (point) newpos) (not (eobp))
4638 (not (eq (following-char) ?\n)))
4639 ;; If we skipped something intangible and now we're not
4640 ;; really at eol, keep going.
4641 (setq arg 1)
4642 (setq done t)))))))
4643
4644 (defun move-beginning-of-line (arg)
4645 "Move point to beginning of current line as displayed.
4646 \(If there's an image in the line, this disregards newlines
4647 which are part of the text that the image rests on.)
4648
4649 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4650 If point reaches the beginning or end of buffer, it stops there.
4651 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4652 (interactive "^p")
4653 (or arg (setq arg 1))
4654
4655 (let ((orig (point))
4656 first-vis first-vis-field-value)
4657
4658 ;; Move by lines, if ARG is not 1 (the default).
4659 (if (/= arg 1)
4660 (let ((line-move-visual nil))
4661 (line-move (1- arg) t)))
4662
4663 ;; Move to beginning-of-line, ignoring fields and invisibles.
4664 (skip-chars-backward "^\n")
4665 (while (and (not (bobp)) (invisible-p (1- (point))))
4666 (goto-char (previous-char-property-change (point)))
4667 (skip-chars-backward "^\n"))
4668
4669 ;; Now find first visible char in the line
4670 (while (and (not (eobp)) (invisible-p (point)))
4671 (goto-char (next-char-property-change (point))))
4672 (setq first-vis (point))
4673
4674 ;; See if fields would stop us from reaching FIRST-VIS.
4675 (setq first-vis-field-value
4676 (constrain-to-field first-vis orig (/= arg 1) t nil))
4677
4678 (goto-char (if (/= first-vis-field-value first-vis)
4679 ;; If yes, obey them.
4680 first-vis-field-value
4681 ;; Otherwise, move to START with attention to fields.
4682 ;; (It is possible that fields never matter in this case.)
4683 (constrain-to-field (point) orig
4684 (/= arg 1) t nil)))))
4685
4686
4687 ;; Many people have said they rarely use this feature, and often type
4688 ;; it by accident. Maybe it shouldn't even be on a key.
4689 (put 'set-goal-column 'disabled t)
4690
4691 (defun set-goal-column (arg)
4692 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
4693 Those commands will move to this position in the line moved to
4694 rather than trying to keep the same horizontal position.
4695 With a non-nil argument ARG, clears out the goal column
4696 so that \\[next-line] and \\[previous-line] resume vertical motion.
4697 The goal column is stored in the variable `goal-column'."
4698 (interactive "P")
4699 (if arg
4700 (progn
4701 (setq goal-column nil)
4702 (message "No goal column"))
4703 (setq goal-column (current-column))
4704 ;; The older method below can be erroneous if `set-goal-column' is bound
4705 ;; to a sequence containing %
4706 ;;(message (substitute-command-keys
4707 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
4708 ;;goal-column)
4709 (message "%s"
4710 (concat
4711 (format "Goal column %d " goal-column)
4712 (substitute-command-keys
4713 "(use \\[set-goal-column] with an arg to unset it)")))
4714
4715 )
4716 nil)
4717 \f
4718 ;;; Editing based on visual lines, as opposed to logical lines.
4719
4720 (defun end-of-visual-line (&optional n)
4721 "Move point to end of current visual line.
4722 With argument N not nil or 1, move forward N - 1 visual lines first.
4723 If point reaches the beginning or end of buffer, it stops there.
4724 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4725 (interactive "^p")
4726 (or n (setq n 1))
4727 (if (/= n 1)
4728 (let ((line-move-visual t))
4729 (line-move (1- n) t)))
4730 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4731 ;; constrain to field boundaries, so we don't either.
4732 (vertical-motion (cons (window-width) 0)))
4733
4734 (defun beginning-of-visual-line (&optional n)
4735 "Move point to beginning of current visual line.
4736 With argument N not nil or 1, move forward N - 1 visual lines first.
4737 If point reaches the beginning or end of buffer, it stops there.
4738 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4739 (interactive "^p")
4740 (or n (setq n 1))
4741 (let ((opoint (point)))
4742 (if (/= n 1)
4743 (let ((line-move-visual t))
4744 (line-move (1- n) t)))
4745 (vertical-motion 0)
4746 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4747 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4748
4749 (defun kill-visual-line (&optional arg)
4750 "Kill the rest of the visual line.
4751 With prefix argument ARG, kill that many visual lines from point.
4752 If ARG is negative, kill visual lines backward.
4753 If ARG is zero, kill the text before point on the current visual
4754 line.
4755
4756 If you want to append the killed line to the last killed text,
4757 use \\[append-next-kill] before \\[kill-line].
4758
4759 If the buffer is read-only, Emacs will beep and refrain from deleting
4760 the line, but put the line in the kill ring anyway. This means that
4761 you can use this command to copy text from a read-only buffer.
4762 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4763 even beep.)"
4764 (interactive "P")
4765 ;; Like in `kill-line', it's better to move point to the other end
4766 ;; of the kill before killing.
4767 (let ((opoint (point))
4768 (kill-whole-line (and kill-whole-line (bolp))))
4769 (if arg
4770 (vertical-motion (prefix-numeric-value arg))
4771 (end-of-visual-line 1)
4772 (if (= (point) opoint)
4773 (vertical-motion 1)
4774 ;; Skip any trailing whitespace at the end of the visual line.
4775 ;; We used to do this only if `show-trailing-whitespace' is
4776 ;; nil, but that's wrong; the correct thing would be to check
4777 ;; whether the trailing whitespace is highlighted. But, it's
4778 ;; OK to just do this unconditionally.
4779 (skip-chars-forward " \t")))
4780 (kill-region opoint (if (and kill-whole-line (looking-at "\n"))
4781 (1+ (point))
4782 (point)))))
4783
4784 (defun next-logical-line (&optional arg try-vscroll)
4785 "Move cursor vertically down ARG lines.
4786 This is identical to `next-line', except that it always moves
4787 by logical lines instead of visual lines, ignoring the value of
4788 the variable `line-move-visual'."
4789 (interactive "^p\np")
4790 (let ((line-move-visual nil))
4791 (with-no-warnings
4792 (next-line arg try-vscroll))))
4793
4794 (defun previous-logical-line (&optional arg try-vscroll)
4795 "Move cursor vertically up ARG lines.
4796 This is identical to `previous-line', except that it always moves
4797 by logical lines instead of visual lines, ignoring the value of
4798 the variable `line-move-visual'."
4799 (interactive "^p\np")
4800 (let ((line-move-visual nil))
4801 (with-no-warnings
4802 (previous-line arg try-vscroll))))
4803
4804 (defgroup visual-line nil
4805 "Editing based on visual lines."
4806 :group 'convenience
4807 :version "23.1")
4808
4809 (defvar visual-line-mode-map
4810 (let ((map (make-sparse-keymap)))
4811 (define-key map [remap kill-line] 'kill-visual-line)
4812 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4813 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4814 ;; These keybindings interfere with xterm function keys. Are
4815 ;; there any other suitable bindings?
4816 ;; (define-key map "\M-[" 'previous-logical-line)
4817 ;; (define-key map "\M-]" 'next-logical-line)
4818 map))
4819
4820 (defcustom visual-line-fringe-indicators '(nil nil)
4821 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4822 The value should be a list of the form (LEFT RIGHT), where LEFT
4823 and RIGHT are symbols representing the bitmaps to display, to
4824 indicate wrapped lines, in the left and right fringes respectively.
4825 See also `fringe-indicator-alist'.
4826 The default is not to display fringe indicators for wrapped lines.
4827 This variable does not affect fringe indicators displayed for
4828 other purposes."
4829 :type '(list (choice (const :tag "Hide left indicator" nil)
4830 (const :tag "Left curly arrow" left-curly-arrow)
4831 (symbol :tag "Other bitmap"))
4832 (choice (const :tag "Hide right indicator" nil)
4833 (const :tag "Right curly arrow" right-curly-arrow)
4834 (symbol :tag "Other bitmap")))
4835 :set (lambda (symbol value)
4836 (dolist (buf (buffer-list))
4837 (with-current-buffer buf
4838 (when (and (boundp 'visual-line-mode)
4839 (symbol-value 'visual-line-mode))
4840 (setq fringe-indicator-alist
4841 (cons (cons 'continuation value)
4842 (assq-delete-all
4843 'continuation
4844 (copy-tree fringe-indicator-alist)))))))
4845 (set-default symbol value)))
4846
4847 (defvar visual-line--saved-state nil)
4848
4849 (define-minor-mode visual-line-mode
4850 "Redefine simple editing commands to act on visual lines, not logical lines.
4851 This also turns on `word-wrap' in the buffer."
4852 :keymap visual-line-mode-map
4853 :group 'visual-line
4854 :lighter " Wrap"
4855 (if visual-line-mode
4856 (progn
4857 (set (make-local-variable 'visual-line--saved-state) nil)
4858 ;; Save the local values of some variables, to be restored if
4859 ;; visual-line-mode is turned off.
4860 (dolist (var '(line-move-visual truncate-lines
4861 truncate-partial-width-windows
4862 word-wrap fringe-indicator-alist))
4863 (if (local-variable-p var)
4864 (push (cons var (symbol-value var))
4865 visual-line--saved-state)))
4866 (set (make-local-variable 'line-move-visual) t)
4867 (set (make-local-variable 'truncate-partial-width-windows) nil)
4868 (setq truncate-lines nil
4869 word-wrap t
4870 fringe-indicator-alist
4871 (cons (cons 'continuation visual-line-fringe-indicators)
4872 fringe-indicator-alist)))
4873 (kill-local-variable 'line-move-visual)
4874 (kill-local-variable 'word-wrap)
4875 (kill-local-variable 'truncate-lines)
4876 (kill-local-variable 'truncate-partial-width-windows)
4877 (kill-local-variable 'fringe-indicator-alist)
4878 (dolist (saved visual-line--saved-state)
4879 (set (make-local-variable (car saved)) (cdr saved)))
4880 (kill-local-variable 'visual-line--saved-state)))
4881
4882 (defun turn-on-visual-line-mode ()
4883 (visual-line-mode 1))
4884
4885 (define-globalized-minor-mode global-visual-line-mode
4886 visual-line-mode turn-on-visual-line-mode
4887 :lighter " vl")
4888
4889 \f
4890 (defun transpose-chars (arg)
4891 "Interchange characters around point, moving forward one character.
4892 With prefix arg ARG, effect is to take character before point
4893 and drag it forward past ARG other characters (backward if ARG negative).
4894 If no argument and at end of line, the previous two chars are exchanged."
4895 (interactive "*P")
4896 (and (null arg) (eolp) (forward-char -1))
4897 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4898
4899 (defun transpose-words (arg)
4900 "Interchange words around point, leaving point at end of them.
4901 With prefix arg ARG, effect is to take word before or around point
4902 and drag it forward past ARG other words (backward if ARG negative).
4903 If ARG is zero, the words around or after point and around or after mark
4904 are interchanged."
4905 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4906 (interactive "*p")
4907 (transpose-subr 'forward-word arg))
4908
4909 (defun transpose-sexps (arg)
4910 "Like \\[transpose-words] but applies to sexps.
4911 Does not work on a sexp that point is in the middle of
4912 if it is a list or string."
4913 (interactive "*p")
4914 (transpose-subr
4915 (lambda (arg)
4916 ;; Here we should try to simulate the behavior of
4917 ;; (cons (progn (forward-sexp x) (point))
4918 ;; (progn (forward-sexp (- x)) (point)))
4919 ;; Except that we don't want to rely on the second forward-sexp
4920 ;; putting us back to where we want to be, since forward-sexp-function
4921 ;; might do funny things like infix-precedence.
4922 (if (if (> arg 0)
4923 (looking-at "\\sw\\|\\s_")
4924 (and (not (bobp))
4925 (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_"))))
4926 ;; Jumping over a symbol. We might be inside it, mind you.
4927 (progn (funcall (if (> arg 0)
4928 'skip-syntax-backward 'skip-syntax-forward)
4929 "w_")
4930 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4931 ;; Otherwise, we're between sexps. Take a step back before jumping
4932 ;; to make sure we'll obey the same precedence no matter which direction
4933 ;; we're going.
4934 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4935 (cons (save-excursion (forward-sexp arg) (point))
4936 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4937 (not (zerop (funcall (if (> arg 0)
4938 'skip-syntax-forward
4939 'skip-syntax-backward)
4940 ".")))))
4941 (point)))))
4942 arg 'special))
4943
4944 (defun transpose-lines (arg)
4945 "Exchange current line and previous line, leaving point after both.
4946 With argument ARG, takes previous line and moves it past ARG lines.
4947 With argument 0, interchanges line point is in with line mark is in."
4948 (interactive "*p")
4949 (transpose-subr (function
4950 (lambda (arg)
4951 (if (> arg 0)
4952 (progn
4953 ;; Move forward over ARG lines,
4954 ;; but create newlines if necessary.
4955 (setq arg (forward-line arg))
4956 (if (/= (preceding-char) ?\n)
4957 (setq arg (1+ arg)))
4958 (if (> arg 0)
4959 (newline arg)))
4960 (forward-line arg))))
4961 arg))
4962
4963 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4964 ;; which seems inconsistent with the ARG /= 0 case.
4965 ;; FIXME document SPECIAL.
4966 (defun transpose-subr (mover arg &optional special)
4967 "Subroutine to do the work of transposing objects.
4968 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4969 moves forward by units of the given object (e.g. forward-sentence,
4970 forward-paragraph). If ARG is zero, exchanges the current object
4971 with the one containing mark. If ARG is an integer, moves the
4972 current object past ARG following (if ARG is positive) or
4973 preceding (if ARG is negative) objects, leaving point after the
4974 current object."
4975 (let ((aux (if special mover
4976 (lambda (x)
4977 (cons (progn (funcall mover x) (point))
4978 (progn (funcall mover (- x)) (point))))))
4979 pos1 pos2)
4980 (cond
4981 ((= arg 0)
4982 (save-excursion
4983 (setq pos1 (funcall aux 1))
4984 (goto-char (or (mark) (error "No mark set in this buffer")))
4985 (setq pos2 (funcall aux 1))
4986 (transpose-subr-1 pos1 pos2))
4987 (exchange-point-and-mark))
4988 ((> arg 0)
4989 (setq pos1 (funcall aux -1))
4990 (setq pos2 (funcall aux arg))
4991 (transpose-subr-1 pos1 pos2)
4992 (goto-char (car pos2)))
4993 (t
4994 (setq pos1 (funcall aux -1))
4995 (goto-char (car pos1))
4996 (setq pos2 (funcall aux arg))
4997 (transpose-subr-1 pos1 pos2)))))
4998
4999 (defun transpose-subr-1 (pos1 pos2)
5000 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5001 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5002 (when (> (car pos1) (car pos2))
5003 (let ((swap pos1))
5004 (setq pos1 pos2 pos2 swap)))
5005 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5006 (atomic-change-group
5007 (let (word2)
5008 ;; FIXME: We first delete the two pieces of text, so markers that
5009 ;; used to point to after the text end up pointing to before it :-(
5010 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5011 (goto-char (car pos2))
5012 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5013 (goto-char (car pos1))
5014 (insert word2))))
5015 \f
5016 (defun backward-word (&optional arg)
5017 "Move backward until encountering the beginning of a word.
5018 With argument ARG, do this that many times."
5019 (interactive "^p")
5020 (forward-word (- (or arg 1))))
5021
5022 (defun mark-word (&optional arg allow-extend)
5023 "Set mark ARG words away from point.
5024 The place mark goes is the same place \\[forward-word] would
5025 move to with the same argument.
5026 Interactively, if this command is repeated
5027 or (in Transient Mark mode) if the mark is active,
5028 it marks the next ARG words after the ones already marked."
5029 (interactive "P\np")
5030 (cond ((and allow-extend
5031 (or (and (eq last-command this-command) (mark t))
5032 (region-active-p)))
5033 (setq arg (if arg (prefix-numeric-value arg)
5034 (if (< (mark) (point)) -1 1)))
5035 (set-mark
5036 (save-excursion
5037 (goto-char (mark))
5038 (forward-word arg)
5039 (point))))
5040 (t
5041 (push-mark
5042 (save-excursion
5043 (forward-word (prefix-numeric-value arg))
5044 (point))
5045 nil t))))
5046
5047 (defun kill-word (arg)
5048 "Kill characters forward until encountering the end of a word.
5049 With argument ARG, do this that many times."
5050 (interactive "p")
5051 (kill-region (point) (progn (forward-word arg) (point))))
5052
5053 (defun backward-kill-word (arg)
5054 "Kill characters backward until encountering the beginning of a word.
5055 With argument ARG, do this that many times."
5056 (interactive "p")
5057 (kill-word (- arg)))
5058
5059 (defun current-word (&optional strict really-word)
5060 "Return the symbol or word that point is on (or a nearby one) as a string.
5061 The return value includes no text properties.
5062 If optional arg STRICT is non-nil, return nil unless point is within
5063 or adjacent to a symbol or word. In all cases the value can be nil
5064 if there is no word nearby.
5065 The function, belying its name, normally finds a symbol.
5066 If optional arg REALLY-WORD is non-nil, it finds just a word."
5067 (save-excursion
5068 (let* ((oldpoint (point)) (start (point)) (end (point))
5069 (syntaxes (if really-word "w" "w_"))
5070 (not-syntaxes (concat "^" syntaxes)))
5071 (skip-syntax-backward syntaxes) (setq start (point))
5072 (goto-char oldpoint)
5073 (skip-syntax-forward syntaxes) (setq end (point))
5074 (when (and (eq start oldpoint) (eq end oldpoint)
5075 ;; Point is neither within nor adjacent to a word.
5076 (not strict))
5077 ;; Look for preceding word in same line.
5078 (skip-syntax-backward not-syntaxes (line-beginning-position))
5079 (if (bolp)
5080 ;; No preceding word in same line.
5081 ;; Look for following word in same line.
5082 (progn
5083 (skip-syntax-forward not-syntaxes (line-end-position))
5084 (setq start (point))
5085 (skip-syntax-forward syntaxes)
5086 (setq end (point)))
5087 (setq end (point))
5088 (skip-syntax-backward syntaxes)
5089 (setq start (point))))
5090 ;; If we found something nonempty, return it as a string.
5091 (unless (= start end)
5092 (buffer-substring-no-properties start end)))))
5093 \f
5094 (defcustom fill-prefix nil
5095 "String for filling to insert at front of new line, or nil for none."
5096 :type '(choice (const :tag "None" nil)
5097 string)
5098 :group 'fill)
5099 (make-variable-buffer-local 'fill-prefix)
5100 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5101
5102 (defcustom auto-fill-inhibit-regexp nil
5103 "Regexp to match lines which should not be auto-filled."
5104 :type '(choice (const :tag "None" nil)
5105 regexp)
5106 :group 'fill)
5107
5108 (defun do-auto-fill ()
5109 "The default value for `normal-auto-fill-function'.
5110 This is the default auto-fill function, some major modes use a different one.
5111 Returns t if it really did any work."
5112 (let (fc justify give-up
5113 (fill-prefix fill-prefix))
5114 (if (or (not (setq justify (current-justification)))
5115 (null (setq fc (current-fill-column)))
5116 (and (eq justify 'left)
5117 (<= (current-column) fc))
5118 (and auto-fill-inhibit-regexp
5119 (save-excursion (beginning-of-line)
5120 (looking-at auto-fill-inhibit-regexp))))
5121 nil ;; Auto-filling not required
5122 (if (memq justify '(full center right))
5123 (save-excursion (unjustify-current-line)))
5124
5125 ;; Choose a fill-prefix automatically.
5126 (when (and adaptive-fill-mode
5127 (or (null fill-prefix) (string= fill-prefix "")))
5128 (let ((prefix
5129 (fill-context-prefix
5130 (save-excursion (fill-forward-paragraph -1) (point))
5131 (save-excursion (fill-forward-paragraph 1) (point)))))
5132 (and prefix (not (equal prefix ""))
5133 ;; Use auto-indentation rather than a guessed empty prefix.
5134 (not (and fill-indent-according-to-mode
5135 (string-match "\\`[ \t]*\\'" prefix)))
5136 (setq fill-prefix prefix))))
5137
5138 (while (and (not give-up) (> (current-column) fc))
5139 ;; Determine where to split the line.
5140 (let* (after-prefix
5141 (fill-point
5142 (save-excursion
5143 (beginning-of-line)
5144 (setq after-prefix (point))
5145 (and fill-prefix
5146 (looking-at (regexp-quote fill-prefix))
5147 (setq after-prefix (match-end 0)))
5148 (move-to-column (1+ fc))
5149 (fill-move-to-break-point after-prefix)
5150 (point))))
5151
5152 ;; See whether the place we found is any good.
5153 (if (save-excursion
5154 (goto-char fill-point)
5155 (or (bolp)
5156 ;; There is no use breaking at end of line.
5157 (save-excursion (skip-chars-forward " ") (eolp))
5158 ;; It is futile to split at the end of the prefix
5159 ;; since we would just insert the prefix again.
5160 (and after-prefix (<= (point) after-prefix))
5161 ;; Don't split right after a comment starter
5162 ;; since we would just make another comment starter.
5163 (and comment-start-skip
5164 (let ((limit (point)))
5165 (beginning-of-line)
5166 (and (re-search-forward comment-start-skip
5167 limit t)
5168 (eq (point) limit))))))
5169 ;; No good place to break => stop trying.
5170 (setq give-up t)
5171 ;; Ok, we have a useful place to break the line. Do it.
5172 (let ((prev-column (current-column)))
5173 ;; If point is at the fill-point, do not `save-excursion'.
5174 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5175 ;; point will end up before it rather than after it.
5176 (if (save-excursion
5177 (skip-chars-backward " \t")
5178 (= (point) fill-point))
5179 (default-indent-new-line t)
5180 (save-excursion
5181 (goto-char fill-point)
5182 (default-indent-new-line t)))
5183 ;; Now do justification, if required
5184 (if (not (eq justify 'left))
5185 (save-excursion
5186 (end-of-line 0)
5187 (justify-current-line justify nil t)))
5188 ;; If making the new line didn't reduce the hpos of
5189 ;; the end of the line, then give up now;
5190 ;; trying again will not help.
5191 (if (>= (current-column) prev-column)
5192 (setq give-up t))))))
5193 ;; Justify last line.
5194 (justify-current-line justify t t)
5195 t)))
5196
5197 (defvar comment-line-break-function 'comment-indent-new-line
5198 "*Mode-specific function which line breaks and continues a comment.
5199 This function is called during auto-filling when a comment syntax
5200 is defined.
5201 The function should take a single optional argument, which is a flag
5202 indicating whether it should use soft newlines.")
5203
5204 (defun default-indent-new-line (&optional soft)
5205 "Break line at point and indent.
5206 If a comment syntax is defined, call `comment-indent-new-line'.
5207
5208 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5209 unless optional argument SOFT is non-nil."
5210 (interactive)
5211 (if comment-start
5212 (funcall comment-line-break-function soft)
5213 ;; Insert the newline before removing empty space so that markers
5214 ;; get preserved better.
5215 (if soft (insert-and-inherit ?\n) (newline 1))
5216 (save-excursion (forward-char -1) (delete-horizontal-space))
5217 (delete-horizontal-space)
5218
5219 (if (and fill-prefix (not adaptive-fill-mode))
5220 ;; Blindly trust a non-adaptive fill-prefix.
5221 (progn
5222 (indent-to-left-margin)
5223 (insert-before-markers-and-inherit fill-prefix))
5224
5225 (cond
5226 ;; If there's an adaptive prefix, use it unless we're inside
5227 ;; a comment and the prefix is not a comment starter.
5228 (fill-prefix
5229 (indent-to-left-margin)
5230 (insert-and-inherit fill-prefix))
5231 ;; If we're not inside a comment, just try to indent.
5232 (t (indent-according-to-mode))))))
5233
5234 (defvar normal-auto-fill-function 'do-auto-fill
5235 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5236 Some major modes set this.")
5237
5238 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5239 ;; `functions' and `hooks' are usually unsafe to set, but setting
5240 ;; auto-fill-function to nil in a file-local setting is safe and
5241 ;; can be useful to prevent auto-filling.
5242 (put 'auto-fill-function 'safe-local-variable 'null)
5243
5244 (define-minor-mode auto-fill-mode
5245 "Toggle Auto Fill mode.
5246 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5247 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5248 automatically breaks the line at a previous space.
5249
5250 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5251 non-`nil'.
5252
5253 The value of `normal-auto-fill-function' specifies the function to use
5254 for `auto-fill-function' when turning Auto Fill mode on."
5255 :variable (eq auto-fill-function normal-auto-fill-function))
5256
5257 ;; This holds a document string used to document auto-fill-mode.
5258 (defun auto-fill-function ()
5259 "Automatically break line at a previous space, in insertion of text."
5260 nil)
5261
5262 (defun turn-on-auto-fill ()
5263 "Unconditionally turn on Auto Fill mode."
5264 (auto-fill-mode 1))
5265
5266 (defun turn-off-auto-fill ()
5267 "Unconditionally turn off Auto Fill mode."
5268 (auto-fill-mode -1))
5269
5270 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5271
5272 (defun set-fill-column (arg)
5273 "Set `fill-column' to specified argument.
5274 Use \\[universal-argument] followed by a number to specify a column.
5275 Just \\[universal-argument] as argument means to use the current column."
5276 (interactive
5277 (list (or current-prefix-arg
5278 ;; We used to use current-column silently, but C-x f is too easily
5279 ;; typed as a typo for C-x C-f, so we turned it into an error and
5280 ;; now an interactive prompt.
5281 (read-number "Set fill-column to: " (current-column)))))
5282 (if (consp arg)
5283 (setq arg (current-column)))
5284 (if (not (integerp arg))
5285 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5286 (error "set-fill-column requires an explicit argument")
5287 (message "Fill column set to %d (was %d)" arg fill-column)
5288 (setq fill-column arg)))
5289 \f
5290 (defun set-selective-display (arg)
5291 "Set `selective-display' to ARG; clear it if no arg.
5292 When the value of `selective-display' is a number > 0,
5293 lines whose indentation is >= that value are not displayed.
5294 The variable `selective-display' has a separate value for each buffer."
5295 (interactive "P")
5296 (if (eq selective-display t)
5297 (error "selective-display already in use for marked lines"))
5298 (let ((current-vpos
5299 (save-restriction
5300 (narrow-to-region (point-min) (point))
5301 (goto-char (window-start))
5302 (vertical-motion (window-height)))))
5303 (setq selective-display
5304 (and arg (prefix-numeric-value arg)))
5305 (recenter current-vpos))
5306 (set-window-start (selected-window) (window-start (selected-window)))
5307 (princ "selective-display set to " t)
5308 (prin1 selective-display t)
5309 (princ "." t))
5310
5311 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5312
5313 (defun toggle-truncate-lines (&optional arg)
5314 "Toggle truncating of long lines for the current buffer.
5315 When truncating is off, long lines are folded.
5316 With prefix argument ARG, truncate long lines if ARG is positive,
5317 otherwise fold them. Note that in side-by-side windows, this
5318 command has no effect if `truncate-partial-width-windows' is
5319 non-nil."
5320 (interactive "P")
5321 (setq truncate-lines
5322 (if (null arg)
5323 (not truncate-lines)
5324 (> (prefix-numeric-value arg) 0)))
5325 (force-mode-line-update)
5326 (unless truncate-lines
5327 (let ((buffer (current-buffer)))
5328 (walk-windows (lambda (window)
5329 (if (eq buffer (window-buffer window))
5330 (set-window-hscroll window 0)))
5331 nil t)))
5332 (message "Truncate long lines %s"
5333 (if truncate-lines "enabled" "disabled")))
5334
5335 (defun toggle-word-wrap (&optional arg)
5336 "Toggle whether to use word-wrapping for continuation lines.
5337 With prefix argument ARG, wrap continuation lines at word boundaries
5338 if ARG is positive, otherwise wrap them at the right screen edge.
5339 This command toggles the value of `word-wrap'. It has no effect
5340 if long lines are truncated."
5341 (interactive "P")
5342 (setq word-wrap
5343 (if (null arg)
5344 (not word-wrap)
5345 (> (prefix-numeric-value arg) 0)))
5346 (force-mode-line-update)
5347 (message "Word wrapping %s"
5348 (if word-wrap "enabled" "disabled")))
5349
5350 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5351 "The string displayed in the mode line when in overwrite mode.")
5352 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5353 "The string displayed in the mode line when in binary overwrite mode.")
5354
5355 (define-minor-mode overwrite-mode
5356 "Toggle overwrite mode.
5357 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5358 otherwise turn it off. In overwrite mode, printing characters typed
5359 in replace existing text on a one-for-one basis, rather than pushing
5360 it to the right. At the end of a line, such characters extend the line.
5361 Before a tab, such characters insert until the tab is filled in.
5362 \\[quoted-insert] still inserts characters in overwrite mode; this
5363 is supposed to make it easier to insert characters when necessary."
5364 :variable (eq overwrite-mode 'overwrite-mode-textual))
5365
5366 (define-minor-mode binary-overwrite-mode
5367 "Toggle binary overwrite mode.
5368 With prefix argument ARG, turn binary overwrite mode on if ARG is
5369 positive, otherwise turn it off. In binary overwrite mode, printing
5370 characters typed in replace existing text. Newlines are not treated
5371 specially, so typing at the end of a line joins the line to the next,
5372 with the typed character between them. Typing before a tab character
5373 simply replaces the tab with the character typed. \\[quoted-insert]
5374 replaces the text at the cursor, just as ordinary typing characters do.
5375
5376 Note that binary overwrite mode is not its own minor mode; it is a
5377 specialization of overwrite mode, entered by setting the
5378 `overwrite-mode' variable to `overwrite-mode-binary'."
5379 :variable (eq overwrite-mode 'overwrite-mode-binary))
5380
5381 (define-minor-mode line-number-mode
5382 "Toggle Line Number mode.
5383 With ARG, turn Line Number mode on if ARG is positive, otherwise
5384 turn it off. When Line Number mode is enabled, the line number
5385 appears in the mode line.
5386
5387 Line numbers do not appear for very large buffers and buffers
5388 with very long lines; see variables `line-number-display-limit'
5389 and `line-number-display-limit-width'."
5390 :init-value t :global t :group 'mode-line)
5391
5392 (define-minor-mode column-number-mode
5393 "Toggle Column Number mode.
5394 With ARG, turn Column Number mode on if ARG is positive,
5395 otherwise turn it off. When Column Number mode is enabled, the
5396 column number appears in the mode line."
5397 :global t :group 'mode-line)
5398
5399 (define-minor-mode size-indication-mode
5400 "Toggle Size Indication mode.
5401 With ARG, turn Size Indication mode on if ARG is positive,
5402 otherwise turn it off. When Size Indication mode is enabled, the
5403 size of the accessible part of the buffer appears in the mode line."
5404 :global t :group 'mode-line)
5405
5406 (define-minor-mode auto-save-mode
5407 "Toggle auto-saving of contents of current buffer.
5408 With prefix argument ARG, turn auto-saving on if positive, else off."
5409 :variable ((and buffer-auto-save-file-name
5410 ;; If auto-save is off because buffer has shrunk,
5411 ;; then toggling should turn it on.
5412 (>= buffer-saved-size 0))
5413 . (lambda (val)
5414 (setq buffer-auto-save-file-name
5415 (cond
5416 ((null val) nil)
5417 ((and buffer-file-name auto-save-visited-file-name
5418 (not buffer-read-only))
5419 buffer-file-name)
5420 (t (make-auto-save-file-name))))))
5421 ;; If -1 was stored here, to temporarily turn off saving,
5422 ;; turn it back on.
5423 (and (< buffer-saved-size 0)
5424 (setq buffer-saved-size 0)))
5425 \f
5426 (defgroup paren-blinking nil
5427 "Blinking matching of parens and expressions."
5428 :prefix "blink-matching-"
5429 :group 'paren-matching)
5430
5431 (defcustom blink-matching-paren t
5432 "Non-nil means show matching open-paren when close-paren is inserted."
5433 :type 'boolean
5434 :group 'paren-blinking)
5435
5436 (defcustom blink-matching-paren-on-screen t
5437 "Non-nil means show matching open-paren when it is on screen.
5438 If nil, don't show it (but the open-paren can still be shown
5439 when it is off screen).
5440
5441 This variable has no effect if `blink-matching-paren' is nil.
5442 \(In that case, the open-paren is never shown.)
5443 It is also ignored if `show-paren-mode' is enabled."
5444 :type 'boolean
5445 :group 'paren-blinking)
5446
5447 (defcustom blink-matching-paren-distance (* 100 1024)
5448 "If non-nil, maximum distance to search backwards for matching open-paren.
5449 If nil, search stops at the beginning of the accessible portion of the buffer."
5450 :version "23.2" ; 25->100k
5451 :type '(choice (const nil) integer)
5452 :group 'paren-blinking)
5453
5454 (defcustom blink-matching-delay 1
5455 "Time in seconds to delay after showing a matching paren."
5456 :type 'number
5457 :group 'paren-blinking)
5458
5459 (defcustom blink-matching-paren-dont-ignore-comments nil
5460 "If nil, `blink-matching-paren' ignores comments.
5461 More precisely, when looking for the matching parenthesis,
5462 it skips the contents of comments that end before point."
5463 :type 'boolean
5464 :group 'paren-blinking)
5465
5466 (defun blink-matching-check-mismatch (start end)
5467 "Return whether or not START...END are matching parens.
5468 END is the current point and START is the blink position.
5469 START might be nil if no matching starter was found.
5470 Returns non-nil if we find there is a mismatch."
5471 (let* ((end-syntax (syntax-after (1- end)))
5472 (matching-paren (and (consp end-syntax)
5473 (eq (syntax-class end-syntax) 5)
5474 (cdr end-syntax))))
5475 ;; For self-matched chars like " and $, we can't know when they're
5476 ;; mismatched or unmatched, so we can only do it for parens.
5477 (when matching-paren
5478 (not (and start
5479 (or
5480 (eq (char-after start) matching-paren)
5481 ;; The cdr might hold a new paren-class info rather than
5482 ;; a matching-char info, in which case the two CDRs
5483 ;; should match.
5484 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5485
5486 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5487 "Function to check parentheses mismatches.
5488 The function takes two arguments (START and END) where START is the
5489 position just before the opening token and END is the position right after.
5490 START can be nil, if it was not found.
5491 The function should return non-nil if the two tokens do not match.")
5492
5493 (defun blink-matching-open ()
5494 "Move cursor momentarily to the beginning of the sexp before point."
5495 (interactive)
5496 (when (and (not (bobp))
5497 blink-matching-paren)
5498 (let* ((oldpos (point))
5499 (message-log-max nil) ; Don't log messages about paren matching.
5500 (blinkpos
5501 (save-excursion
5502 (save-restriction
5503 (if blink-matching-paren-distance
5504 (narrow-to-region
5505 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5506 (- (point) blink-matching-paren-distance))
5507 oldpos))
5508 (let ((parse-sexp-ignore-comments
5509 (and parse-sexp-ignore-comments
5510 (not blink-matching-paren-dont-ignore-comments))))
5511 (condition-case ()
5512 (progn
5513 (forward-sexp -1)
5514 ;; backward-sexp skips backward over prefix chars,
5515 ;; so move back to the matching paren.
5516 (while (and (< (point) (1- oldpos))
5517 (let ((code (syntax-after (point))))
5518 (or (eq (syntax-class code) 6)
5519 (eq (logand 1048576 (car code))
5520 1048576))))
5521 (forward-char 1))
5522 (point))
5523 (error nil))))))
5524 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5525 (cond
5526 (mismatch
5527 (if blinkpos
5528 (if (minibufferp)
5529 (minibuffer-message "Mismatched parentheses")
5530 (message "Mismatched parentheses"))
5531 (if (minibufferp)
5532 (minibuffer-message "No matching parenthesis found")
5533 (message "No matching parenthesis found"))))
5534 ((not blinkpos) nil)
5535 ((pos-visible-in-window-p blinkpos)
5536 ;; Matching open within window, temporarily move to blinkpos but only
5537 ;; if `blink-matching-paren-on-screen' is non-nil.
5538 (and blink-matching-paren-on-screen
5539 (not show-paren-mode)
5540 (save-excursion
5541 (goto-char blinkpos)
5542 (sit-for blink-matching-delay))))
5543 (t
5544 (save-excursion
5545 (goto-char blinkpos)
5546 (let ((open-paren-line-string
5547 ;; Show what precedes the open in its line, if anything.
5548 (cond
5549 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
5550 (buffer-substring (line-beginning-position)
5551 (1+ blinkpos)))
5552 ;; Show what follows the open in its line, if anything.
5553 ((save-excursion
5554 (forward-char 1)
5555 (skip-chars-forward " \t")
5556 (not (eolp)))
5557 (buffer-substring blinkpos
5558 (line-end-position)))
5559 ;; Otherwise show the previous nonblank line,
5560 ;; if there is one.
5561 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
5562 (concat
5563 (buffer-substring (progn
5564 (skip-chars-backward "\n \t")
5565 (line-beginning-position))
5566 (progn (end-of-line)
5567 (skip-chars-backward " \t")
5568 (point)))
5569 ;; Replace the newline and other whitespace with `...'.
5570 "..."
5571 (buffer-substring blinkpos (1+ blinkpos))))
5572 ;; There is nothing to show except the char itself.
5573 (t (buffer-substring blinkpos (1+ blinkpos))))))
5574 (message "Matches %s"
5575 (substring-no-properties open-paren-line-string)))))))))
5576
5577 (defvar blink-paren-function 'blink-matching-open
5578 "Function called, if non-nil, whenever a close parenthesis is inserted.
5579 More precisely, a char with closeparen syntax is self-inserted.")
5580
5581 (defun blink-paren-post-self-insert-function ()
5582 (when (and (eq (char-before) last-command-event) ; Sanity check.
5583 (memq (char-syntax last-command-event) '(?\) ?\$))
5584 blink-paren-function
5585 (not executing-kbd-macro)
5586 (not noninteractive)
5587 ;; Verify an even number of quoting characters precede the close.
5588 (= 1 (logand 1 (- (point)
5589 (save-excursion
5590 (forward-char -1)
5591 (skip-syntax-backward "/\\")
5592 (point))))))
5593 (funcall blink-paren-function)))
5594
5595 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5596 ;; Most likely, this hook is nil, so this arg doesn't matter,
5597 ;; but I use it as a reminder that this function usually
5598 ;; likes to be run after others since it does `sit-for'.
5599 'append)
5600 \f
5601 ;; This executes C-g typed while Emacs is waiting for a command.
5602 ;; Quitting out of a program does not go through here;
5603 ;; that happens in the QUIT macro at the C code level.
5604 (defun keyboard-quit ()
5605 "Signal a `quit' condition.
5606 During execution of Lisp code, this character causes a quit directly.
5607 At top-level, as an editor command, this simply beeps."
5608 (interactive)
5609 ;; Avoid adding the region to the window selection.
5610 (setq saved-region-selection nil)
5611 (let (select-active-regions)
5612 (deactivate-mark))
5613 (if (fboundp 'kmacro-keyboard-quit)
5614 (kmacro-keyboard-quit))
5615 (setq defining-kbd-macro nil)
5616 (let ((debug-on-quit nil))
5617 (signal 'quit nil)))
5618
5619 (defvar buffer-quit-function nil
5620 "Function to call to \"quit\" the current buffer, or nil if none.
5621 \\[keyboard-escape-quit] calls this function when its more local actions
5622 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5623
5624 (defun keyboard-escape-quit ()
5625 "Exit the current \"mode\" (in a generalized sense of the word).
5626 This command can exit an interactive command such as `query-replace',
5627 can clear out a prefix argument or a region,
5628 can get out of the minibuffer or other recursive edit,
5629 cancel the use of the current buffer (for special-purpose buffers),
5630 or go back to just one window (by deleting all but the selected window)."
5631 (interactive)
5632 (cond ((eq last-command 'mode-exited) nil)
5633 ((region-active-p)
5634 (deactivate-mark))
5635 ((> (minibuffer-depth) 0)
5636 (abort-recursive-edit))
5637 (current-prefix-arg
5638 nil)
5639 ((> (recursion-depth) 0)
5640 (exit-recursive-edit))
5641 (buffer-quit-function
5642 (funcall buffer-quit-function))
5643 ((not (one-window-p t))
5644 (delete-other-windows))
5645 ((string-match "^ \\*" (buffer-name (current-buffer)))
5646 (bury-buffer))))
5647
5648 (defun play-sound-file (file &optional volume device)
5649 "Play sound stored in FILE.
5650 VOLUME and DEVICE correspond to the keywords of the sound
5651 specification for `play-sound'."
5652 (interactive "fPlay sound file: ")
5653 (let ((sound (list :file file)))
5654 (if volume
5655 (plist-put sound :volume volume))
5656 (if device
5657 (plist-put sound :device device))
5658 (push 'sound sound)
5659 (play-sound sound)))
5660
5661 \f
5662 (defcustom read-mail-command 'rmail
5663 "Your preference for a mail reading package.
5664 This is used by some keybindings which support reading mail.
5665 See also `mail-user-agent' concerning sending mail."
5666 :type '(radio (function-item :tag "Rmail" :format "%t\n" rmail)
5667 (function-item :tag "Gnus" :format "%t\n" gnus)
5668 (function-item :tag "Emacs interface to MH"
5669 :format "%t\n" mh-rmail)
5670 (function :tag "Other"))
5671 :version "21.1"
5672 :group 'mail)
5673
5674 (defcustom mail-user-agent 'message-user-agent
5675 "Your preference for a mail composition package.
5676 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5677 outgoing email message. This variable lets you specify which
5678 mail-sending package you prefer.
5679
5680 Valid values include:
5681
5682 `message-user-agent' -- use the Message package.
5683 See Info node `(message)'.
5684 `sendmail-user-agent' -- use the Mail package.
5685 See Info node `(emacs)Sending Mail'.
5686 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5687 See Info node `(mh-e)'.
5688 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5689 paraphernalia, particularly the Gcc: header for
5690 archiving.
5691
5692 Additional valid symbols may be available; check with the author of
5693 your package for details. The function should return non-nil if it
5694 succeeds.
5695
5696 See also `read-mail-command' concerning reading mail."
5697 :type '(radio (function-item :tag "Message package"
5698 :format "%t\n"
5699 message-user-agent)
5700 (function-item :tag "Mail package"
5701 :format "%t\n"
5702 sendmail-user-agent)
5703 (function-item :tag "Emacs interface to MH"
5704 :format "%t\n"
5705 mh-e-user-agent)
5706 (function-item :tag "Message with full Gnus features"
5707 :format "%t\n"
5708 gnus-user-agent)
5709 (function :tag "Other"))
5710 :version "23.2" ; sendmail->message
5711 :group 'mail)
5712
5713 (defcustom compose-mail-user-agent-warnings t
5714 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5715 If the value of `mail-user-agent' is the default, and the user
5716 appears to have customizations applying to the old default,
5717 `compose-mail' issues a warning."
5718 :type 'boolean
5719 :version "23.2"
5720 :group 'mail)
5721
5722 (defun rfc822-goto-eoh ()
5723 "If the buffer starts with a mail header, move point to the header's end.
5724 Otherwise, moves to `point-min'.
5725 The end of the header is the start of the next line, if there is one,
5726 else the end of the last line. This function obeys RFC822."
5727 (goto-char (point-min))
5728 (when (re-search-forward
5729 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
5730 (goto-char (match-beginning 0))))
5731
5732 ;; Used by Rmail (e.g., rmail-forward).
5733 (defvar mail-encode-mml nil
5734 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5735 the outgoing message before sending it.")
5736
5737 (defun compose-mail (&optional to subject other-headers continue
5738 switch-function yank-action send-actions
5739 return-action)
5740 "Start composing a mail message to send.
5741 This uses the user's chosen mail composition package
5742 as selected with the variable `mail-user-agent'.
5743 The optional arguments TO and SUBJECT specify recipients
5744 and the initial Subject field, respectively.
5745
5746 OTHER-HEADERS is an alist specifying additional
5747 header fields. Elements look like (HEADER . VALUE) where both
5748 HEADER and VALUE are strings.
5749
5750 CONTINUE, if non-nil, says to continue editing a message already
5751 being composed. Interactively, CONTINUE is the prefix argument.
5752
5753 SWITCH-FUNCTION, if non-nil, is a function to use to
5754 switch to and display the buffer used for mail composition.
5755
5756 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5757 to insert the raw text of the message being replied to.
5758 It has the form (FUNCTION . ARGS). The user agent will apply
5759 FUNCTION to ARGS, to insert the raw text of the original message.
5760 \(The user agent will also run `mail-citation-hook', *after* the
5761 original text has been inserted in this way.)
5762
5763 SEND-ACTIONS is a list of actions to call when the message is sent.
5764 Each action has the form (FUNCTION . ARGS).
5765
5766 RETURN-ACTION, if non-nil, is an action for returning to the
5767 caller. It has the form (FUNCTION . ARGS). The function is
5768 called after the mail has been sent or put aside, and the mail
5769 buffer buried."
5770 (interactive
5771 (list nil nil nil current-prefix-arg))
5772
5773 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5774 ;; from sendmail-user-agent to message-user-agent. Some users may
5775 ;; encounter incompatibilities. This hack tries to detect problems
5776 ;; and warn about them.
5777 (and compose-mail-user-agent-warnings
5778 (eq mail-user-agent 'message-user-agent)
5779 (let (warn-vars)
5780 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5781 mail-yank-hooks mail-archive-file-name
5782 mail-default-reply-to mail-mailing-lists
5783 mail-self-blind))
5784 (and (boundp var)
5785 (symbol-value var)
5786 (push var warn-vars)))
5787 (when warn-vars
5788 (display-warning 'mail
5789 (format "\
5790 The default mail mode is now Message mode.
5791 You have the following Mail mode variable%s customized:
5792 \n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
5793 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5794 (if (> (length warn-vars) 1) "s" "")
5795 (mapconcat 'symbol-name
5796 warn-vars " "))))))
5797
5798 (let ((function (get mail-user-agent 'composefunc)))
5799 (funcall function to subject other-headers continue switch-function
5800 yank-action send-actions return-action)))
5801
5802 (defun compose-mail-other-window (&optional to subject other-headers continue
5803 yank-action send-actions
5804 return-action)
5805 "Like \\[compose-mail], but edit the outgoing message in another window."
5806 (interactive (list nil nil nil current-prefix-arg))
5807 (compose-mail to subject other-headers continue
5808 'switch-to-buffer-other-window yank-action send-actions
5809 return-action))
5810
5811 (defun compose-mail-other-frame (&optional to subject other-headers continue
5812 yank-action send-actions
5813 return-action)
5814 "Like \\[compose-mail], but edit the outgoing message in another frame."
5815 (interactive (list nil nil nil current-prefix-arg))
5816 (compose-mail to subject other-headers continue
5817 'switch-to-buffer-other-frame yank-action send-actions
5818 return-action))
5819
5820 \f
5821 (defvar set-variable-value-history nil
5822 "History of values entered with `set-variable'.
5823
5824 Maximum length of the history list is determined by the value
5825 of `history-length', which see.")
5826
5827 (defun set-variable (variable value &optional make-local)
5828 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5829 VARIABLE should be a user option variable name, a Lisp variable
5830 meant to be customized by users. You should enter VALUE in Lisp syntax,
5831 so if you want VALUE to be a string, you must surround it with doublequotes.
5832 VALUE is used literally, not evaluated.
5833
5834 If VARIABLE has a `variable-interactive' property, that is used as if
5835 it were the arg to `interactive' (which see) to interactively read VALUE.
5836
5837 If VARIABLE has been defined with `defcustom', then the type information
5838 in the definition is used to check that VALUE is valid.
5839
5840 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5841 (interactive
5842 (let* ((default-var (variable-at-point))
5843 (var (if (user-variable-p default-var)
5844 (read-variable (format "Set variable (default %s): " default-var)
5845 default-var)
5846 (read-variable "Set variable: ")))
5847 (minibuffer-help-form '(describe-variable var))
5848 (prop (get var 'variable-interactive))
5849 (obsolete (car (get var 'byte-obsolete-variable)))
5850 (prompt (format "Set %s %s to value: " var
5851 (cond ((local-variable-p var)
5852 "(buffer-local)")
5853 ((or current-prefix-arg
5854 (local-variable-if-set-p var))
5855 "buffer-locally")
5856 (t "globally"))))
5857 (val (progn
5858 (when obsolete
5859 (message (concat "`%S' is obsolete; "
5860 (if (symbolp obsolete) "use `%S' instead" "%s"))
5861 var obsolete)
5862 (sit-for 3))
5863 (if prop
5864 ;; Use VAR's `variable-interactive' property
5865 ;; as an interactive spec for prompting.
5866 (call-interactively `(lambda (arg)
5867 (interactive ,prop)
5868 arg))
5869 (read
5870 (read-string prompt nil
5871 'set-variable-value-history
5872 (format "%S" (symbol-value var))))))))
5873 (list var val current-prefix-arg)))
5874
5875 (and (custom-variable-p variable)
5876 (not (get variable 'custom-type))
5877 (custom-load-symbol variable))
5878 (let ((type (get variable 'custom-type)))
5879 (when type
5880 ;; Match with custom type.
5881 (require 'cus-edit)
5882 (setq type (widget-convert type))
5883 (unless (widget-apply type :match value)
5884 (error "Value `%S' does not match type %S of %S"
5885 value (car type) variable))))
5886
5887 (if make-local
5888 (make-local-variable variable))
5889
5890 (set variable value)
5891
5892 ;; Force a thorough redisplay for the case that the variable
5893 ;; has an effect on the display, like `tab-width' has.
5894 (force-mode-line-update))
5895 \f
5896 ;; Define the major mode for lists of completions.
5897
5898 (defvar completion-list-mode-map
5899 (let ((map (make-sparse-keymap)))
5900 (define-key map [mouse-2] 'mouse-choose-completion)
5901 (define-key map [follow-link] 'mouse-face)
5902 (define-key map [down-mouse-2] nil)
5903 (define-key map "\C-m" 'choose-completion)
5904 (define-key map "\e\e\e" 'delete-completion-window)
5905 (define-key map [left] 'previous-completion)
5906 (define-key map [right] 'next-completion)
5907 (define-key map "q" 'quit-window)
5908 (define-key map "z" 'kill-this-buffer)
5909 map)
5910 "Local map for completion list buffers.")
5911
5912 ;; Completion mode is suitable only for specially formatted data.
5913 (put 'completion-list-mode 'mode-class 'special)
5914
5915 (defvar completion-reference-buffer nil
5916 "Record the buffer that was current when the completion list was requested.
5917 This is a local variable in the completion list buffer.
5918 Initial value is nil to avoid some compiler warnings.")
5919
5920 (defvar completion-no-auto-exit nil
5921 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5922 This also applies to other functions such as `choose-completion'.")
5923
5924 (defvar completion-base-position nil
5925 "Position of the base of the text corresponding to the shown completions.
5926 This variable is used in the *Completions* buffers.
5927 Its value is a list of the form (START END) where START is the place
5928 where the completion should be inserted and END (if non-nil) is the end
5929 of the text to replace. If END is nil, point is used instead.")
5930
5931 (defvar completion-list-insert-choice-function #'completion--replace
5932 "Function to use to insert the text chosen in *Completions*.
5933 Called with 3 arguments (BEG END TEXT), it should replace the text
5934 between BEG and END with TEXT. Expected to be set buffer-locally
5935 in the *Completions* buffer.")
5936
5937 (defvar completion-base-size nil
5938 "Number of chars before point not involved in completion.
5939 This is a local variable in the completion list buffer.
5940 It refers to the chars in the minibuffer if completing in the
5941 minibuffer, or in `completion-reference-buffer' otherwise.
5942 Only characters in the field at point are included.
5943
5944 If nil, Emacs determines which part of the tail end of the
5945 buffer's text is involved in completion by comparing the text
5946 directly.")
5947 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5948
5949 (defun delete-completion-window ()
5950 "Delete the completion list window.
5951 Go to the window from which completion was requested."
5952 (interactive)
5953 (let ((buf completion-reference-buffer))
5954 (if (one-window-p t)
5955 (if (window-dedicated-p (selected-window))
5956 (delete-frame (selected-frame)))
5957 (delete-window (selected-window))
5958 (if (get-buffer-window buf)
5959 (select-window (get-buffer-window buf))))))
5960
5961 (defun previous-completion (n)
5962 "Move to the previous item in the completion list."
5963 (interactive "p")
5964 (next-completion (- n)))
5965
5966 (defun next-completion (n)
5967 "Move to the next item in the completion list.
5968 With prefix argument N, move N items (negative N means move backward)."
5969 (interactive "p")
5970 (let ((beg (point-min)) (end (point-max)))
5971 (while (and (> n 0) (not (eobp)))
5972 ;; If in a completion, move to the end of it.
5973 (when (get-text-property (point) 'mouse-face)
5974 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5975 ;; Move to start of next one.
5976 (unless (get-text-property (point) 'mouse-face)
5977 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5978 (setq n (1- n)))
5979 (while (and (< n 0) (not (bobp)))
5980 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5981 ;; If in a completion, move to the start of it.
5982 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5983 (goto-char (previous-single-property-change
5984 (point) 'mouse-face nil beg)))
5985 ;; Move to end of the previous completion.
5986 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5987 (goto-char (previous-single-property-change
5988 (point) 'mouse-face nil beg)))
5989 ;; Move to the start of that one.
5990 (goto-char (previous-single-property-change
5991 (point) 'mouse-face nil beg))
5992 (setq n (1+ n))))))
5993
5994 (defun choose-completion (&optional event)
5995 "Choose the completion at point."
5996 (interactive (list last-nonmenu-event))
5997 ;; In case this is run via the mouse, give temporary modes such as
5998 ;; isearch a chance to turn off.
5999 (run-hooks 'mouse-leave-buffer-hook)
6000 (with-current-buffer (window-buffer (posn-window (event-start event)))
6001 (let ((buffer completion-reference-buffer)
6002 (base-size completion-base-size)
6003 (base-position completion-base-position)
6004 (insert-function completion-list-insert-choice-function)
6005 (choice
6006 (save-excursion
6007 (goto-char (posn-point (event-start event)))
6008 (let (beg end)
6009 (cond
6010 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6011 (setq end (point) beg (1+ (point))))
6012 ((and (not (bobp))
6013 (get-text-property (1- (point)) 'mouse-face))
6014 (setq end (1- (point)) beg (point)))
6015 (t (error "No completion here")))
6016 (setq beg (previous-single-property-change beg 'mouse-face))
6017 (setq end (or (next-single-property-change end 'mouse-face)
6018 (point-max)))
6019 (buffer-substring-no-properties beg end))))
6020 (owindow (selected-window)))
6021
6022 (unless (buffer-live-p buffer)
6023 (error "Destination buffer is dead"))
6024 (select-window (posn-window (event-start event)))
6025 (if (and (one-window-p t 'selected-frame)
6026 (window-dedicated-p (selected-window)))
6027 ;; This is a special buffer's frame
6028 (iconify-frame (selected-frame))
6029 (or (window-dedicated-p (selected-window))
6030 (bury-buffer)))
6031 (select-window
6032 (or (get-buffer-window buffer 0)
6033 owindow))
6034
6035 (with-current-buffer buffer
6036 (choose-completion-string
6037 choice buffer
6038 (or base-position
6039 (when base-size
6040 ;; Someone's using old completion code that doesn't know
6041 ;; about base-position yet.
6042 (list (+ base-size (field-beginning))))
6043 ;; If all else fails, just guess.
6044 (list (choose-completion-guess-base-position choice)))
6045 insert-function)))))
6046
6047 ;; Delete the longest partial match for STRING
6048 ;; that can be found before POINT.
6049 (defun choose-completion-guess-base-position (string)
6050 (save-excursion
6051 (let ((opoint (point))
6052 len)
6053 ;; Try moving back by the length of the string.
6054 (goto-char (max (- (point) (length string))
6055 (minibuffer-prompt-end)))
6056 ;; See how far back we were actually able to move. That is the
6057 ;; upper bound on how much we can match and delete.
6058 (setq len (- opoint (point)))
6059 (if completion-ignore-case
6060 (setq string (downcase string)))
6061 (while (and (> len 0)
6062 (let ((tail (buffer-substring (point) opoint)))
6063 (if completion-ignore-case
6064 (setq tail (downcase tail)))
6065 (not (string= tail (substring string 0 len)))))
6066 (setq len (1- len))
6067 (forward-char 1))
6068 (point))))
6069
6070 (defun choose-completion-delete-max-match (string)
6071 (delete-region (choose-completion-guess-base-position string) (point)))
6072 (make-obsolete 'choose-completion-delete-max-match
6073 'choose-completion-guess-base-position "23.2")
6074
6075 (defvar choose-completion-string-functions nil
6076 "Functions that may override the normal insertion of a completion choice.
6077 These functions are called in order with four arguments:
6078 CHOICE - the string to insert in the buffer,
6079 BUFFER - the buffer in which the choice should be inserted,
6080 MINI-P - non-nil if BUFFER is a minibuffer, and
6081 BASE-SIZE - the number of characters in BUFFER before
6082 the string being completed.
6083
6084 If a function in the list returns non-nil, that function is supposed
6085 to have inserted the CHOICE in the BUFFER, and possibly exited
6086 the minibuffer; no further functions will be called.
6087
6088 If all functions in the list return nil, that means to use
6089 the default method of inserting the completion in BUFFER.")
6090
6091 (defun choose-completion-string (choice &optional
6092 buffer base-position insert-function)
6093 "Switch to BUFFER and insert the completion choice CHOICE.
6094 BASE-POSITION, says where to insert the completion."
6095
6096 ;; If BUFFER is the minibuffer, exit the minibuffer
6097 ;; unless it is reading a file name and CHOICE is a directory,
6098 ;; or completion-no-auto-exit is non-nil.
6099
6100 ;; Some older code may call us passing `base-size' instead of
6101 ;; `base-position'. It's difficult to make any use of `base-size',
6102 ;; so we just ignore it.
6103 (unless (consp base-position)
6104 (message "Obsolete `base-size' passed to choose-completion-string")
6105 (setq base-position nil))
6106
6107 (let* ((buffer (or buffer completion-reference-buffer))
6108 (mini-p (minibufferp buffer)))
6109 ;; If BUFFER is a minibuffer, barf unless it's the currently
6110 ;; active minibuffer.
6111 (if (and mini-p
6112 (not (and (active-minibuffer-window)
6113 (equal buffer
6114 (window-buffer (active-minibuffer-window))))))
6115 (error "Minibuffer is not active for completion")
6116 ;; Set buffer so buffer-local choose-completion-string-functions works.
6117 (set-buffer buffer)
6118 (unless (run-hook-with-args-until-success
6119 'choose-completion-string-functions
6120 ;; The fourth arg used to be `mini-p' but was useless
6121 ;; (since minibufferp can be used on the `buffer' arg)
6122 ;; and indeed unused. The last used to be `base-size', so we
6123 ;; keep it to try and avoid breaking old code.
6124 choice buffer base-position nil)
6125 ;; This remove-text-properties should be unnecessary since `choice'
6126 ;; comes from buffer-substring-no-properties.
6127 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6128 ;; Insert the completion into the buffer where it was requested.
6129 (funcall (or insert-function completion-list-insert-choice-function)
6130 (or (car base-position) (point))
6131 (or (cadr base-position) (point))
6132 choice)
6133 ;; Update point in the window that BUFFER is showing in.
6134 (let ((window (get-buffer-window buffer t)))
6135 (set-window-point window (point)))
6136 ;; If completing for the minibuffer, exit it with this choice.
6137 (and (not completion-no-auto-exit)
6138 (minibufferp buffer)
6139 minibuffer-completion-table
6140 ;; If this is reading a file name, and the file name chosen
6141 ;; is a directory, don't exit the minibuffer.
6142 (let* ((result (buffer-substring (field-beginning) (point)))
6143 (bounds
6144 (completion-boundaries result minibuffer-completion-table
6145 minibuffer-completion-predicate
6146 "")))
6147 (if (eq (car bounds) (length result))
6148 ;; The completion chosen leads to a new set of completions
6149 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6150 (let ((mini (active-minibuffer-window)))
6151 (select-window mini)
6152 (when minibuffer-auto-raise
6153 (raise-frame (window-frame mini))))
6154 (exit-minibuffer))))))))
6155
6156 (define-derived-mode completion-list-mode nil "Completion List"
6157 "Major mode for buffers showing lists of possible completions.
6158 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
6159 to select the completion near point.
6160 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
6161 with the mouse.
6162
6163 \\{completion-list-mode-map}"
6164 (set (make-local-variable 'completion-base-size) nil))
6165
6166 (defun completion-list-mode-finish ()
6167 "Finish setup of the completions buffer.
6168 Called from `temp-buffer-show-hook'."
6169 (when (eq major-mode 'completion-list-mode)
6170 (toggle-read-only 1)))
6171
6172 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6173
6174
6175 ;; Variables and faces used in `completion-setup-function'.
6176
6177 (defcustom completion-show-help t
6178 "Non-nil means show help message in *Completions* buffer."
6179 :type 'boolean
6180 :version "22.1"
6181 :group 'completion)
6182
6183 ;; This function goes in completion-setup-hook, so that it is called
6184 ;; after the text of the completion list buffer is written.
6185 (defun completion-setup-function ()
6186 (let* ((mainbuf (current-buffer))
6187 (base-dir
6188 ;; When reading a file name in the minibuffer,
6189 ;; try and find the right default-directory to set in the
6190 ;; completion list buffer.
6191 ;; FIXME: Why do we do that, actually? --Stef
6192 (if minibuffer-completing-file-name
6193 (file-name-as-directory
6194 (expand-file-name
6195 (substring (minibuffer-completion-contents)
6196 0 (or completion-base-size 0)))))))
6197 (with-current-buffer standard-output
6198 (let ((base-size completion-base-size) ;Read before killing localvars.
6199 (base-position completion-base-position)
6200 (insert-fun completion-list-insert-choice-function))
6201 (completion-list-mode)
6202 (set (make-local-variable 'completion-base-size) base-size)
6203 (set (make-local-variable 'completion-base-position) base-position)
6204 (set (make-local-variable 'completion-list-insert-choice-function)
6205 insert-fun))
6206 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6207 (if base-dir (setq default-directory base-dir))
6208 ;; Maybe insert help string.
6209 (when completion-show-help
6210 (goto-char (point-min))
6211 (if (display-mouse-p)
6212 (insert (substitute-command-keys
6213 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
6214 (insert (substitute-command-keys
6215 "In this buffer, type \\[choose-completion] to \
6216 select the completion near point.\n\n"))))))
6217
6218 (add-hook 'completion-setup-hook 'completion-setup-function)
6219
6220 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6221 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6222
6223 (defun switch-to-completions ()
6224 "Select the completion list window."
6225 (interactive)
6226 (let ((window (or (get-buffer-window "*Completions*" 0)
6227 ;; Make sure we have a completions window.
6228 (progn (minibuffer-completion-help)
6229 (get-buffer-window "*Completions*" 0)))))
6230 (when window
6231 (select-window window)
6232 ;; In the new buffer, go to the first completion.
6233 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6234 (when (bobp)
6235 (next-completion 1)))))
6236 \f
6237 ;;; Support keyboard commands to turn on various modifiers.
6238
6239 ;; These functions -- which are not commands -- each add one modifier
6240 ;; to the following event.
6241
6242 (defun event-apply-alt-modifier (_ignore-prompt)
6243 "\\<function-key-map>Add the Alt modifier to the following event.
6244 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
6245 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6246 (defun event-apply-super-modifier (_ignore-prompt)
6247 "\\<function-key-map>Add the Super modifier to the following event.
6248 For example, type \\[event-apply-super-modifier] & to enter Super-&."
6249 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6250 (defun event-apply-hyper-modifier (_ignore-prompt)
6251 "\\<function-key-map>Add the Hyper modifier to the following event.
6252 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
6253 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6254 (defun event-apply-shift-modifier (_ignore-prompt)
6255 "\\<function-key-map>Add the Shift modifier to the following event.
6256 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
6257 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6258 (defun event-apply-control-modifier (_ignore-prompt)
6259 "\\<function-key-map>Add the Ctrl modifier to the following event.
6260 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
6261 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6262 (defun event-apply-meta-modifier (_ignore-prompt)
6263 "\\<function-key-map>Add the Meta modifier to the following event.
6264 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
6265 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6266
6267 (defun event-apply-modifier (event symbol lshiftby prefix)
6268 "Apply a modifier flag to event EVENT.
6269 SYMBOL is the name of this modifier, as a symbol.
6270 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6271 PREFIX is the string that represents this modifier in an event type symbol."
6272 (if (numberp event)
6273 (cond ((eq symbol 'control)
6274 (if (and (<= (downcase event) ?z)
6275 (>= (downcase event) ?a))
6276 (- (downcase event) ?a -1)
6277 (if (and (<= (downcase event) ?Z)
6278 (>= (downcase event) ?A))
6279 (- (downcase event) ?A -1)
6280 (logior (lsh 1 lshiftby) event))))
6281 ((eq symbol 'shift)
6282 (if (and (<= (downcase event) ?z)
6283 (>= (downcase event) ?a))
6284 (upcase event)
6285 (logior (lsh 1 lshiftby) event)))
6286 (t
6287 (logior (lsh 1 lshiftby) event)))
6288 (if (memq symbol (event-modifiers event))
6289 event
6290 (let ((event-type (if (symbolp event) event (car event))))
6291 (setq event-type (intern (concat prefix (symbol-name event-type))))
6292 (if (symbolp event)
6293 event-type
6294 (cons event-type (cdr event)))))))
6295
6296 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6297 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6298 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6299 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6300 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6301 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6302 \f
6303 ;;;; Keypad support.
6304
6305 ;; Make the keypad keys act like ordinary typing keys. If people add
6306 ;; bindings for the function key symbols, then those bindings will
6307 ;; override these, so this shouldn't interfere with any existing
6308 ;; bindings.
6309
6310 ;; Also tell read-char how to handle these keys.
6311 (mapc
6312 (lambda (keypad-normal)
6313 (let ((keypad (nth 0 keypad-normal))
6314 (normal (nth 1 keypad-normal)))
6315 (put keypad 'ascii-character normal)
6316 (define-key function-key-map (vector keypad) (vector normal))))
6317 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6318 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6319 (kp-space ?\s)
6320 (kp-tab ?\t)
6321 (kp-enter ?\r)
6322 (kp-multiply ?*)
6323 (kp-add ?+)
6324 (kp-separator ?,)
6325 (kp-subtract ?-)
6326 (kp-decimal ?.)
6327 (kp-divide ?/)
6328 (kp-equal ?=)
6329 ;; Do the same for various keys that are represented as symbols under
6330 ;; GUIs but naturally correspond to characters.
6331 (backspace 127)
6332 (delete 127)
6333 (tab ?\t)
6334 (linefeed ?\n)
6335 (clear ?\C-l)
6336 (return ?\C-m)
6337 (escape ?\e)
6338 ))
6339 \f
6340 ;;;;
6341 ;;;; forking a twin copy of a buffer.
6342 ;;;;
6343
6344 (defvar clone-buffer-hook nil
6345 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6346
6347 (defvar clone-indirect-buffer-hook nil
6348 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6349
6350 (defun clone-process (process &optional newname)
6351 "Create a twin copy of PROCESS.
6352 If NEWNAME is nil, it defaults to PROCESS' name;
6353 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6354 If PROCESS is associated with a buffer, the new process will be associated
6355 with the current buffer instead.
6356 Returns nil if PROCESS has already terminated."
6357 (setq newname (or newname (process-name process)))
6358 (if (string-match "<[0-9]+>\\'" newname)
6359 (setq newname (substring newname 0 (match-beginning 0))))
6360 (when (memq (process-status process) '(run stop open))
6361 (let* ((process-connection-type (process-tty-name process))
6362 (new-process
6363 (if (memq (process-status process) '(open))
6364 (let ((args (process-contact process t)))
6365 (setq args (plist-put args :name newname))
6366 (setq args (plist-put args :buffer
6367 (if (process-buffer process)
6368 (current-buffer))))
6369 (apply 'make-network-process args))
6370 (apply 'start-process newname
6371 (if (process-buffer process) (current-buffer))
6372 (process-command process)))))
6373 (set-process-query-on-exit-flag
6374 new-process (process-query-on-exit-flag process))
6375 (set-process-inherit-coding-system-flag
6376 new-process (process-inherit-coding-system-flag process))
6377 (set-process-filter new-process (process-filter process))
6378 (set-process-sentinel new-process (process-sentinel process))
6379 (set-process-plist new-process (copy-sequence (process-plist process)))
6380 new-process)))
6381
6382 ;; things to maybe add (currently partly covered by `funcall mode'):
6383 ;; - syntax-table
6384 ;; - overlays
6385 (defun clone-buffer (&optional newname display-flag)
6386 "Create and return a twin copy of the current buffer.
6387 Unlike an indirect buffer, the new buffer can be edited
6388 independently of the old one (if it is not read-only).
6389 NEWNAME is the name of the new buffer. It may be modified by
6390 adding or incrementing <N> at the end as necessary to create a
6391 unique buffer name. If nil, it defaults to the name of the
6392 current buffer, with the proper suffix. If DISPLAY-FLAG is
6393 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6394 clone a file-visiting buffer, or a buffer whose major mode symbol
6395 has a non-nil `no-clone' property, results in an error.
6396
6397 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6398 current buffer with appropriate suffix. However, if a prefix
6399 argument is given, then the command prompts for NEWNAME in the
6400 minibuffer.
6401
6402 This runs the normal hook `clone-buffer-hook' in the new buffer
6403 after it has been set up properly in other respects."
6404 (interactive
6405 (progn
6406 (if buffer-file-name
6407 (error "Cannot clone a file-visiting buffer"))
6408 (if (get major-mode 'no-clone)
6409 (error "Cannot clone a buffer in %s mode" mode-name))
6410 (list (if current-prefix-arg
6411 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6412 t)))
6413 (if buffer-file-name
6414 (error "Cannot clone a file-visiting buffer"))
6415 (if (get major-mode 'no-clone)
6416 (error "Cannot clone a buffer in %s mode" mode-name))
6417 (setq newname (or newname (buffer-name)))
6418 (if (string-match "<[0-9]+>\\'" newname)
6419 (setq newname (substring newname 0 (match-beginning 0))))
6420 (let ((buf (current-buffer))
6421 (ptmin (point-min))
6422 (ptmax (point-max))
6423 (pt (point))
6424 (mk (if mark-active (mark t)))
6425 (modified (buffer-modified-p))
6426 (mode major-mode)
6427 (lvars (buffer-local-variables))
6428 (process (get-buffer-process (current-buffer)))
6429 (new (generate-new-buffer (or newname (buffer-name)))))
6430 (save-restriction
6431 (widen)
6432 (with-current-buffer new
6433 (insert-buffer-substring buf)))
6434 (with-current-buffer new
6435 (narrow-to-region ptmin ptmax)
6436 (goto-char pt)
6437 (if mk (set-mark mk))
6438 (set-buffer-modified-p modified)
6439
6440 ;; Clone the old buffer's process, if any.
6441 (when process (clone-process process))
6442
6443 ;; Now set up the major mode.
6444 (funcall mode)
6445
6446 ;; Set up other local variables.
6447 (mapc (lambda (v)
6448 (condition-case () ;in case var is read-only
6449 (if (symbolp v)
6450 (makunbound v)
6451 (set (make-local-variable (car v)) (cdr v)))
6452 (error nil)))
6453 lvars)
6454
6455 ;; Run any hooks (typically set up by the major mode
6456 ;; for cloning to work properly).
6457 (run-hooks 'clone-buffer-hook))
6458 (if display-flag
6459 ;; Presumably the current buffer is shown in the selected frame, so
6460 ;; we want to display the clone elsewhere.
6461 (let ((same-window-regexps nil)
6462 (same-window-buffer-names))
6463 (pop-to-buffer new)))
6464 new))
6465
6466
6467 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6468 "Create an indirect buffer that is a twin copy of the current buffer.
6469
6470 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6471 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6472 or if not called with a prefix arg, NEWNAME defaults to the current
6473 buffer's name. The name is modified by adding a `<N>' suffix to it
6474 or by incrementing the N in an existing suffix. Trying to clone a
6475 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6476 property results in an error.
6477
6478 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6479 This is always done when called interactively.
6480
6481 Optional third arg NORECORD non-nil means do not put this buffer at the
6482 front of the list of recently selected ones."
6483 (interactive
6484 (progn
6485 (if (get major-mode 'no-clone-indirect)
6486 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6487 (list (if current-prefix-arg
6488 (read-buffer "Name of indirect buffer: " (current-buffer)))
6489 t)))
6490 (if (get major-mode 'no-clone-indirect)
6491 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6492 (setq newname (or newname (buffer-name)))
6493 (if (string-match "<[0-9]+>\\'" newname)
6494 (setq newname (substring newname 0 (match-beginning 0))))
6495 (let* ((name (generate-new-buffer-name newname))
6496 (buffer (make-indirect-buffer (current-buffer) name t)))
6497 (with-current-buffer buffer
6498 (run-hooks 'clone-indirect-buffer-hook))
6499 (when display-flag
6500 (pop-to-buffer buffer norecord))
6501 buffer))
6502
6503
6504 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6505 "Like `clone-indirect-buffer' but display in another window."
6506 (interactive
6507 (progn
6508 (if (get major-mode 'no-clone-indirect)
6509 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6510 (list (if current-prefix-arg
6511 (read-buffer "Name of indirect buffer: " (current-buffer)))
6512 t)))
6513 (let ((pop-up-windows t))
6514 (clone-indirect-buffer newname display-flag norecord)))
6515
6516 \f
6517 ;;; Handling of Backspace and Delete keys.
6518
6519 (defcustom normal-erase-is-backspace 'maybe
6520 "Set the default behavior of the Delete and Backspace keys.
6521
6522 If set to t, Delete key deletes forward and Backspace key deletes
6523 backward.
6524
6525 If set to nil, both Delete and Backspace keys delete backward.
6526
6527 If set to 'maybe (which is the default), Emacs automatically
6528 selects a behavior. On window systems, the behavior depends on
6529 the keyboard used. If the keyboard has both a Backspace key and
6530 a Delete key, and both are mapped to their usual meanings, the
6531 option's default value is set to t, so that Backspace can be used
6532 to delete backward, and Delete can be used to delete forward.
6533
6534 If not running under a window system, customizing this option
6535 accomplishes a similar effect by mapping C-h, which is usually
6536 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6537 via `keyboard-translate'. The former functionality of C-h is
6538 available on the F1 key. You should probably not use this
6539 setting if you don't have both Backspace, Delete and F1 keys.
6540
6541 Setting this variable with setq doesn't take effect. Programmatically,
6542 call `normal-erase-is-backspace-mode' (which see) instead."
6543 :type '(choice (const :tag "Off" nil)
6544 (const :tag "Maybe" maybe)
6545 (other :tag "On" t))
6546 :group 'editing-basics
6547 :version "21.1"
6548 :set (lambda (symbol value)
6549 ;; The fboundp is because of a problem with :set when
6550 ;; dumping Emacs. It doesn't really matter.
6551 (if (fboundp 'normal-erase-is-backspace-mode)
6552 (normal-erase-is-backspace-mode (or value 0))
6553 (set-default symbol value))))
6554
6555 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6556 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6557 (unless frame (setq frame (selected-frame)))
6558 (with-selected-frame frame
6559 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6560 (normal-erase-is-backspace-mode
6561 (if (if (eq normal-erase-is-backspace 'maybe)
6562 (and (not noninteractive)
6563 (or (memq system-type '(ms-dos windows-nt))
6564 (memq window-system '(ns))
6565 (and (memq window-system '(x))
6566 (fboundp 'x-backspace-delete-keys-p)
6567 (x-backspace-delete-keys-p))
6568 ;; If the terminal Emacs is running on has erase char
6569 ;; set to ^H, use the Backspace key for deleting
6570 ;; backward, and the Delete key for deleting forward.
6571 (and (null window-system)
6572 (eq tty-erase-char ?\^H))))
6573 normal-erase-is-backspace)
6574 1 0)))))
6575
6576 (define-minor-mode normal-erase-is-backspace-mode
6577 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6578
6579 With numeric ARG, turn the mode on if and only if ARG is positive.
6580
6581 On window systems, when this mode is on, Delete is mapped to C-d
6582 and Backspace is mapped to DEL; when this mode is off, both
6583 Delete and Backspace are mapped to DEL. (The remapping goes via
6584 `local-function-key-map', so binding Delete or Backspace in the
6585 global or local keymap will override that.)
6586
6587 In addition, on window systems, the bindings of C-Delete, M-Delete,
6588 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6589 the global keymap in accordance with the functionality of Delete and
6590 Backspace. For example, if Delete is remapped to C-d, which deletes
6591 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6592 to DEL, which deletes backward, C-Delete is bound to
6593 `backward-kill-word'.
6594
6595 If not running on a window system, a similar effect is accomplished by
6596 remapping C-h (normally produced by the Backspace key) and DEL via
6597 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6598 to C-d; if it's off, the keys are not remapped.
6599
6600 When not running on a window system, and this mode is turned on, the
6601 former functionality of C-h is available on the F1 key. You should
6602 probably not turn on this mode on a text-only terminal if you don't
6603 have both Backspace, Delete and F1 keys.
6604
6605 See also `normal-erase-is-backspace'."
6606 :variable (eq (terminal-parameter
6607 nil 'normal-erase-is-backspace) 1)
6608 (let ((enabled (eq 1 (terminal-parameter
6609 nil 'normal-erase-is-backspace))))
6610
6611 (cond ((or (memq window-system '(x w32 ns pc))
6612 (memq system-type '(ms-dos windows-nt)))
6613 (let ((bindings
6614 `(([M-delete] [M-backspace])
6615 ([C-M-delete] [C-M-backspace])
6616 ([?\e C-delete] [?\e C-backspace]))))
6617
6618 (if enabled
6619 (progn
6620 (define-key local-function-key-map [delete] [deletechar])
6621 (define-key local-function-key-map [kp-delete] [?\C-d])
6622 (define-key local-function-key-map [backspace] [?\C-?])
6623 (dolist (b bindings)
6624 ;; Not sure if input-decode-map is really right, but
6625 ;; keyboard-translate-table (used below) only works
6626 ;; for integer events, and key-translation-table is
6627 ;; global (like the global-map, used earlier).
6628 (define-key input-decode-map (car b) nil)
6629 (define-key input-decode-map (cadr b) nil)))
6630 (define-key local-function-key-map [delete] [?\C-?])
6631 (define-key local-function-key-map [kp-delete] [?\C-?])
6632 (define-key local-function-key-map [backspace] [?\C-?])
6633 (dolist (b bindings)
6634 (define-key input-decode-map (car b) (cadr b))
6635 (define-key input-decode-map (cadr b) (car b))))))
6636 (t
6637 (if enabled
6638 (progn
6639 (keyboard-translate ?\C-h ?\C-?)
6640 (keyboard-translate ?\C-? ?\C-d))
6641 (keyboard-translate ?\C-h ?\C-h)
6642 (keyboard-translate ?\C-? ?\C-?))))
6643
6644 (if (called-interactively-p 'interactive)
6645 (message "Delete key deletes %s"
6646 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6647 "forward" "backward")))))
6648 \f
6649 (defvar vis-mode-saved-buffer-invisibility-spec nil
6650 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6651
6652 (define-minor-mode visible-mode
6653 "Toggle Visible mode.
6654 With argument ARG turn Visible mode on if ARG is positive, otherwise
6655 turn it off.
6656
6657 Enabling Visible mode makes all invisible text temporarily visible.
6658 Disabling Visible mode turns off that effect. Visible mode works by
6659 saving the value of `buffer-invisibility-spec' and setting it to nil."
6660 :lighter " Vis"
6661 :group 'editing-basics
6662 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6663 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6664 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6665 (when visible-mode
6666 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6667 buffer-invisibility-spec)
6668 (setq buffer-invisibility-spec nil)))
6669 \f
6670 ;; Minibuffer prompt stuff.
6671
6672 ;;(defun minibuffer-prompt-modification (start end)
6673 ;; (error "You cannot modify the prompt"))
6674 ;;
6675 ;;
6676 ;;(defun minibuffer-prompt-insertion (start end)
6677 ;; (let ((inhibit-modification-hooks t))
6678 ;; (delete-region start end)
6679 ;; ;; Discard undo information for the text insertion itself
6680 ;; ;; and for the text deletion.above.
6681 ;; (when (consp buffer-undo-list)
6682 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6683 ;; (message "You cannot modify the prompt")))
6684 ;;
6685 ;;
6686 ;;(setq minibuffer-prompt-properties
6687 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6688 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6689
6690 \f
6691 ;;;; Problematic external packages.
6692
6693 ;; rms says this should be done by specifying symbols that define
6694 ;; versions together with bad values. This is therefore not as
6695 ;; flexible as it could be. See the thread:
6696 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6697 (defconst bad-packages-alist
6698 ;; Not sure exactly which semantic versions have problems.
6699 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6700 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
6701 "The version of `semantic' loaded does not work in Emacs 22.
6702 It can cause constant high CPU load.
6703 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6704 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6705 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6706 ;; provided the `CUA-mode' feature. Since this is no longer true,
6707 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6708 (CUA-mode t nil
6709 "CUA-mode is now part of the standard GNU Emacs distribution,
6710 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6711
6712 You have loaded an older version of CUA-mode which does not work
6713 correctly with this version of Emacs. You should remove the old
6714 version and use the one distributed with Emacs."))
6715 "Alist of packages known to cause problems in this version of Emacs.
6716 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6717 PACKAGE is either a regular expression to match file names, or a
6718 symbol (a feature name); see the documentation of
6719 `after-load-alist', to which this variable adds functions.
6720 SYMBOL is either the name of a string variable, or `t'. Upon
6721 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6722 warning using STRING as the message.")
6723
6724 (defun bad-package-check (package)
6725 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6726 (condition-case nil
6727 (let* ((list (assoc package bad-packages-alist))
6728 (symbol (nth 1 list)))
6729 (and list
6730 (boundp symbol)
6731 (or (eq symbol t)
6732 (and (stringp (setq symbol (eval symbol)))
6733 (string-match-p (nth 2 list) symbol)))
6734 (display-warning package (nth 3 list) :warning)))
6735 (error nil)))
6736
6737 (mapc (lambda (elem)
6738 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6739 bad-packages-alist)
6740
6741
6742 (provide 'simple)
6743
6744 ;;; simple.el ends here