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