Add blink-matching-check-function and misc cleanups.
[bpt/emacs.git] / lisp / simple.el
1 ;;; simple.el --- basic editing commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
6
7 ;; Maintainer: FSF
8 ;; Keywords: internal
9 ;; Package: emacs
10
11 ;; This file is part of GNU Emacs.
12
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
17
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25
26 ;;; Commentary:
27
28 ;; A grab-bag of basic Emacs commands not specifically related to some
29 ;; major mode or to file-handling.
30
31 ;;; Code:
32
33 ;; This is for lexical-let in apply-partially.
34 (eval-when-compile (require 'cl))
35
36 (declare-function widget-convert "wid-edit" (type &rest args))
37 (declare-function shell-mode "shell" ())
38
39 (defvar compilation-current-error)
40
41 (defcustom idle-update-delay 0.5
42 "Idle time delay before updating various things on the screen.
43 Various Emacs features that update auxiliary information when point moves
44 wait this many seconds after Emacs becomes idle before doing an update."
45 :type 'number
46 :group 'display
47 :version "22.1")
48
49 (defgroup killing nil
50 "Killing and yanking commands."
51 :group 'editing)
52
53 (defgroup paren-matching nil
54 "Highlight (un)matching of parens and expressions."
55 :group 'matching)
56
57 (defun get-next-valid-buffer (list &optional buffer visible-ok frame)
58 "Search LIST for a valid buffer to display in FRAME.
59 Return nil when all buffers in LIST are undesirable for display,
60 otherwise return the first suitable buffer in LIST.
61
62 Buffers not visible in windows are preferred to visible buffers,
63 unless VISIBLE-OK is non-nil.
64 If the optional argument FRAME is nil, it defaults to the selected frame.
65 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
66 ;; This logic is more or less copied from other-buffer.
67 (setq frame (or frame (selected-frame)))
68 (let ((pred (frame-parameter frame 'buffer-predicate))
69 found buf)
70 (while (and (not found) list)
71 (setq buf (car list))
72 (if (and (not (eq buffer buf))
73 (buffer-live-p buf)
74 (or (null pred) (funcall pred buf))
75 (not (eq (aref (buffer-name buf) 0) ?\s))
76 (or visible-ok (null (get-buffer-window buf 'visible))))
77 (setq found buf)
78 (setq list (cdr list))))
79 (car list)))
80
81 (defun last-buffer (&optional buffer visible-ok frame)
82 "Return the last buffer in FRAME's buffer list.
83 If BUFFER is the last buffer, return the preceding buffer instead.
84 Buffers not visible in windows are preferred to visible buffers,
85 unless optional argument VISIBLE-OK is non-nil.
86 Optional third argument FRAME nil or omitted means use the
87 selected frame's buffer list.
88 If no such buffer exists, return the buffer `*scratch*', creating
89 it if necessary."
90 (setq frame (or frame (selected-frame)))
91 (or (get-next-valid-buffer (nreverse (buffer-list frame))
92 buffer visible-ok frame)
93 (get-buffer "*scratch*")
94 (let ((scratch (get-buffer-create "*scratch*")))
95 (set-buffer-major-mode scratch)
96 scratch)))
97
98 (defun next-buffer ()
99 "Switch to the next buffer in cyclic order."
100 (interactive)
101 (let ((buffer (current-buffer)))
102 (switch-to-buffer (other-buffer buffer t))
103 (bury-buffer buffer)))
104
105 (defun previous-buffer ()
106 "Switch to the previous buffer in cyclic order."
107 (interactive)
108 (switch-to-buffer (last-buffer (current-buffer) t)))
109
110 \f
111 ;;; next-error support framework
112
113 (defgroup next-error nil
114 "`next-error' support framework."
115 :group 'compilation
116 :version "22.1")
117
118 (defface next-error
119 '((t (:inherit region)))
120 "Face used to highlight next error locus."
121 :group 'next-error
122 :version "22.1")
123
124 (defcustom next-error-highlight 0.5
125 "Highlighting of locations in selected source buffers.
126 If a number, highlight the locus in `next-error' face for the given time
127 in seconds, or until the next command is executed.
128 If t, highlight the locus until the next command is executed, or until
129 some other locus replaces it.
130 If nil, don't highlight the locus in the source buffer.
131 If `fringe-arrow', indicate the locus by the fringe arrow."
132 :type '(choice (number :tag "Highlight for specified time")
133 (const :tag "Semipermanent highlighting" t)
134 (const :tag "No highlighting" nil)
135 (const :tag "Fringe arrow" fringe-arrow))
136 :group 'next-error
137 :version "22.1")
138
139 (defcustom next-error-highlight-no-select 0.5
140 "Highlighting of locations in `next-error-no-select'.
141 If number, highlight the locus in `next-error' face for given time in seconds.
142 If t, highlight the locus indefinitely until some other locus replaces it.
143 If nil, don't highlight the locus in the source buffer.
144 If `fringe-arrow', indicate the locus by the fringe arrow."
145 :type '(choice (number :tag "Highlight for specified time")
146 (const :tag "Semipermanent highlighting" t)
147 (const :tag "No highlighting" nil)
148 (const :tag "Fringe arrow" fringe-arrow))
149 :group 'next-error
150 :version "22.1")
151
152 (defcustom next-error-recenter nil
153 "Display the line in the visited source file recentered as specified.
154 If non-nil, the value is passed directly to `recenter'."
155 :type '(choice (integer :tag "Line to recenter to")
156 (const :tag "Center of window" (4))
157 (const :tag "No recentering" nil))
158 :group 'next-error
159 :version "23.1")
160
161 (defcustom next-error-hook nil
162 "List of hook functions run by `next-error' after visiting source file."
163 :type 'hook
164 :group 'next-error)
165
166 (defvar next-error-highlight-timer nil)
167
168 (defvar next-error-overlay-arrow-position nil)
169 (put 'next-error-overlay-arrow-position 'overlay-arrow-string (purecopy "=>"))
170 (add-to-list 'overlay-arrow-variable-list 'next-error-overlay-arrow-position)
171
172 (defvar next-error-last-buffer nil
173 "The most recent `next-error' buffer.
174 A buffer becomes most recent when its compilation, grep, or
175 similar mode is started, or when it is used with \\[next-error]
176 or \\[compile-goto-error].")
177
178 (defvar next-error-function nil
179 "Function to use to find the next error in the current buffer.
180 The function is called with 2 parameters:
181 ARG is an integer specifying by how many errors to move.
182 RESET is a boolean which, if non-nil, says to go back to the beginning
183 of the errors before moving.
184 Major modes providing compile-like functionality should set this variable
185 to indicate to `next-error' that this is a candidate buffer and how
186 to navigate in it.")
187 (make-variable-buffer-local 'next-error-function)
188
189 (defvar next-error-move-function nil
190 "Function to use to move to an error locus.
191 It takes two arguments, a buffer position in the error buffer
192 and a buffer position in the error locus buffer.
193 The buffer for the error locus should already be current.
194 nil means use goto-char using the second argument position.")
195 (make-variable-buffer-local 'next-error-move-function)
196
197 (defsubst next-error-buffer-p (buffer
198 &optional avoid-current
199 extra-test-inclusive
200 extra-test-exclusive)
201 "Test if BUFFER is a `next-error' capable buffer.
202
203 If AVOID-CURRENT is non-nil, treat the current buffer
204 as an absolute last resort only.
205
206 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
207 that normally would not qualify. If it returns t, the buffer
208 in question is treated as usable.
209
210 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
211 that would normally be considered usable. If it returns nil,
212 that buffer is rejected."
213 (and (buffer-name buffer) ;First make sure it's live.
214 (not (and avoid-current (eq buffer (current-buffer))))
215 (with-current-buffer buffer
216 (if next-error-function ; This is the normal test.
217 ;; Optionally reject some buffers.
218 (if extra-test-exclusive
219 (funcall extra-test-exclusive)
220 t)
221 ;; Optionally accept some other buffers.
222 (and extra-test-inclusive
223 (funcall extra-test-inclusive))))))
224
225 (defun next-error-find-buffer (&optional avoid-current
226 extra-test-inclusive
227 extra-test-exclusive)
228 "Return a `next-error' capable buffer.
229
230 If AVOID-CURRENT is non-nil, treat the current buffer
231 as an absolute last resort only.
232
233 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
234 that normally would not qualify. If it returns t, the buffer
235 in question is treated as usable.
236
237 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
238 that would normally be considered usable. If it returns nil,
239 that buffer is rejected."
240 (or
241 ;; 1. If one window on the selected frame displays such buffer, return it.
242 (let ((window-buffers
243 (delete-dups
244 (delq nil (mapcar (lambda (w)
245 (if (next-error-buffer-p
246 (window-buffer w)
247 avoid-current
248 extra-test-inclusive extra-test-exclusive)
249 (window-buffer w)))
250 (window-list))))))
251 (if (eq (length window-buffers) 1)
252 (car window-buffers)))
253 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
254 (if (and next-error-last-buffer
255 (next-error-buffer-p next-error-last-buffer avoid-current
256 extra-test-inclusive extra-test-exclusive))
257 next-error-last-buffer)
258 ;; 3. If the current buffer is acceptable, choose it.
259 (if (next-error-buffer-p (current-buffer) avoid-current
260 extra-test-inclusive extra-test-exclusive)
261 (current-buffer))
262 ;; 4. Look for any acceptable buffer.
263 (let ((buffers (buffer-list)))
264 (while (and buffers
265 (not (next-error-buffer-p
266 (car buffers) avoid-current
267 extra-test-inclusive extra-test-exclusive)))
268 (setq buffers (cdr buffers)))
269 (car buffers))
270 ;; 5. Use the current buffer as a last resort if it qualifies,
271 ;; even despite AVOID-CURRENT.
272 (and avoid-current
273 (next-error-buffer-p (current-buffer) nil
274 extra-test-inclusive extra-test-exclusive)
275 (progn
276 (message "This is the only buffer with error message locations")
277 (current-buffer)))
278 ;; 6. Give up.
279 (error "No buffers contain error message locations")))
280
281 (defun next-error (&optional arg reset)
282 "Visit next `next-error' message and corresponding source code.
283
284 If all the error messages parsed so far have been processed already,
285 the message buffer is checked for new ones.
286
287 A prefix ARG specifies how many error messages to move;
288 negative means move back to previous error messages.
289 Just \\[universal-argument] as a prefix means reparse the error message buffer
290 and start at the first error.
291
292 The RESET argument specifies that we should restart from the beginning.
293
294 \\[next-error] normally uses the most recently started
295 compilation, grep, or occur buffer. It can also operate on any
296 buffer with output from the \\[compile], \\[grep] commands, or,
297 more generally, on any buffer in Compilation mode or with
298 Compilation Minor mode enabled, or any buffer in which
299 `next-error-function' is bound to an appropriate function.
300 To specify use of a particular buffer for error messages, type
301 \\[next-error] in that buffer when it is the only one displayed
302 in the current frame.
303
304 Once \\[next-error] has chosen the buffer for error messages, it
305 runs `next-error-hook' with `run-hooks', and stays with that buffer
306 until you use it in some other buffer which uses Compilation mode
307 or Compilation Minor mode.
308
309 See variables `compilation-parse-errors-function' and
310 \`compilation-error-regexp-alist' for customization ideas."
311 (interactive "P")
312 (if (consp arg) (setq reset t arg nil))
313 (when (setq next-error-last-buffer (next-error-find-buffer))
314 ;; we know here that next-error-function is a valid symbol we can funcall
315 (with-current-buffer next-error-last-buffer
316 (funcall next-error-function (prefix-numeric-value arg) reset)
317 (when next-error-recenter
318 (recenter next-error-recenter))
319 (run-hooks 'next-error-hook))))
320
321 (defun next-error-internal ()
322 "Visit the source code corresponding to the `next-error' message at point."
323 (setq next-error-last-buffer (current-buffer))
324 ;; we know here that next-error-function is a valid symbol we can funcall
325 (with-current-buffer next-error-last-buffer
326 (funcall next-error-function 0 nil)
327 (when next-error-recenter
328 (recenter next-error-recenter))
329 (run-hooks 'next-error-hook)))
330
331 (defalias 'goto-next-locus 'next-error)
332 (defalias 'next-match 'next-error)
333
334 (defun previous-error (&optional n)
335 "Visit previous `next-error' message and corresponding source code.
336
337 Prefix arg N says how many error messages to move backwards (or
338 forwards, if negative).
339
340 This operates on the output from the \\[compile] and \\[grep] commands."
341 (interactive "p")
342 (next-error (- (or n 1))))
343
344 (defun first-error (&optional n)
345 "Restart at the first error.
346 Visit corresponding source code.
347 With prefix arg N, visit the source code of the Nth error.
348 This operates on the output from the \\[compile] command, for instance."
349 (interactive "p")
350 (next-error n t))
351
352 (defun next-error-no-select (&optional n)
353 "Move point to the next error in the `next-error' buffer and highlight match.
354 Prefix arg N says how many error messages to move forwards (or
355 backwards, if negative).
356 Finds and highlights the source line like \\[next-error], but does not
357 select the source buffer."
358 (interactive "p")
359 (let ((next-error-highlight next-error-highlight-no-select))
360 (next-error n))
361 (pop-to-buffer next-error-last-buffer))
362
363 (defun previous-error-no-select (&optional n)
364 "Move point to the previous error in the `next-error' buffer and highlight match.
365 Prefix arg N says how many error messages to move backwards (or
366 forwards, if negative).
367 Finds and highlights the source line like \\[previous-error], but does not
368 select the source buffer."
369 (interactive "p")
370 (next-error-no-select (- (or n 1))))
371
372 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
373 (defvar next-error-follow-last-line nil)
374
375 (define-minor-mode next-error-follow-minor-mode
376 "Minor mode for compilation, occur and diff modes.
377 When turned on, cursor motion in the compilation, grep, occur or diff
378 buffer causes automatic display of the corresponding source code
379 location."
380 :group 'next-error :init-value nil :lighter " Fol"
381 (if (not next-error-follow-minor-mode)
382 (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t)
383 (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t)
384 (make-local-variable 'next-error-follow-last-line)))
385
386 ;; Used as a `post-command-hook' by `next-error-follow-mode'
387 ;; for the *Compilation* *grep* and *Occur* buffers.
388 (defun next-error-follow-mode-post-command-hook ()
389 (unless (equal next-error-follow-last-line (line-number-at-pos))
390 (setq next-error-follow-last-line (line-number-at-pos))
391 (condition-case nil
392 (let ((compilation-context-lines nil))
393 (setq compilation-current-error (point))
394 (next-error-no-select 0))
395 (error t))))
396
397 \f
398 ;;;
399
400 (defun fundamental-mode ()
401 "Major mode not specialized for anything in particular.
402 Other major modes are defined by comparison with this one."
403 (interactive)
404 (kill-all-local-variables)
405 (run-mode-hooks 'fundamental-mode-hook))
406
407 ;; Special major modes to view specially formatted data rather than files.
408
409 (defvar special-mode-map
410 (let ((map (make-sparse-keymap)))
411 (suppress-keymap map)
412 (define-key map "q" 'quit-window)
413 (define-key map " " 'scroll-up)
414 (define-key map "\C-?" 'scroll-down)
415 (define-key map "?" 'describe-mode)
416 (define-key map ">" 'end-of-buffer)
417 (define-key map "<" 'beginning-of-buffer)
418 (define-key map "g" 'revert-buffer)
419 map))
420
421 (put 'special-mode 'mode-class 'special)
422 (define-derived-mode special-mode nil "Special"
423 "Parent major mode from which special major modes should inherit."
424 (setq buffer-read-only t))
425
426 ;; Major mode meant to be the parent of programming modes.
427
428 (defvar prog-mode-map
429 (let ((map (make-sparse-keymap)))
430 (define-key map [?\C-\M-q] 'prog-indent-sexp)
431 map)
432 "Keymap used for programming modes.")
433
434 (defun prog-indent-sexp ()
435 "Indent the expression after point."
436 (interactive)
437 (let ((start (point))
438 (end (save-excursion (forward-sexp 1) (point))))
439 (indent-region start end nil)))
440
441 (define-derived-mode prog-mode fundamental-mode "Prog"
442 "Major mode for editing programming language source code."
443 (set (make-local-variable 'require-final-newline) mode-require-final-newline)
444 (set (make-local-variable 'parse-sexp-ignore-comments) t))
445
446 ;; Making and deleting lines.
447
448 (defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard))
449 "Propertized string representing a hard newline character.")
450
451 (defun newline (&optional arg)
452 "Insert a newline, and move to left margin of the new line if it's blank.
453 If `use-hard-newlines' is non-nil, the newline is marked with the
454 text-property `hard'.
455 With ARG, insert that many newlines.
456 Call `auto-fill-function' if the current column number is greater
457 than the value of `fill-column' and ARG is nil."
458 (interactive "*P")
459 (barf-if-buffer-read-only)
460 (let ((was-page-start (and (bolp)
461 (looking-at page-delimiter)))
462 (beforepos (point)))
463 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
464 ;; Set last-command-event to tell self-insert what to insert.
465 (let ((last-command-event ?\n)
466 ;; Don't auto-fill if we have a numeric argument.
467 (auto-fill-function (if arg nil auto-fill-function))
468 (post-self-insert-hook post-self-insert-hook))
469 ;; Do the rest in post-self-insert-hook, because we want to do it
470 ;; *before* other functions on that hook.
471 (add-hook 'post-self-insert-hook
472 (lambda ()
473 ;; Mark the newline(s) `hard'.
474 (if use-hard-newlines
475 (set-hard-newline-properties
476 (- (point) (prefix-numeric-value arg)) (point)))
477 ;; If the newline leaves the previous line blank, and we
478 ;; have a left margin, delete that from the blank line.
479 (save-excursion
480 (goto-char beforepos)
481 (beginning-of-line)
482 (and (looking-at "[ \t]$")
483 (> (current-left-margin) 0)
484 (delete-region (point)
485 (line-end-position))))
486 ;; Indent the line after the newline, except in one case:
487 ;; when we added the newline at the beginning of a line which
488 ;; starts a page.
489 (or was-page-start
490 (move-to-left-margin nil t))))
491 (self-insert-command (prefix-numeric-value arg))))
492 nil)
493
494 (defun set-hard-newline-properties (from to)
495 (let ((sticky (get-text-property from 'rear-nonsticky)))
496 (put-text-property from to 'hard 't)
497 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
498 (if (and (listp sticky) (not (memq 'hard sticky)))
499 (put-text-property from (point) 'rear-nonsticky
500 (cons 'hard sticky)))))
501
502 (defun open-line (n)
503 "Insert a newline and leave point before it.
504 If there is a fill prefix and/or a `left-margin', insert them
505 on the new line if the line would have been blank.
506 With arg N, insert N newlines."
507 (interactive "*p")
508 (let* ((do-fill-prefix (and fill-prefix (bolp)))
509 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
510 (loc (point))
511 ;; Don't expand an abbrev before point.
512 (abbrev-mode nil))
513 (newline n)
514 (goto-char loc)
515 (while (> n 0)
516 (cond ((bolp)
517 (if do-left-margin (indent-to (current-left-margin)))
518 (if do-fill-prefix (insert-and-inherit fill-prefix))))
519 (forward-line 1)
520 (setq n (1- n)))
521 (goto-char loc)
522 (end-of-line)))
523
524 (defun split-line (&optional arg)
525 "Split current line, moving portion beyond point vertically down.
526 If the current line starts with `fill-prefix', insert it on the new
527 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
528
529 When called from Lisp code, ARG may be a prefix string to copy."
530 (interactive "*P")
531 (skip-chars-forward " \t")
532 (let* ((col (current-column))
533 (pos (point))
534 ;; What prefix should we check for (nil means don't).
535 (prefix (cond ((stringp arg) arg)
536 (arg nil)
537 (t fill-prefix)))
538 ;; Does this line start with it?
539 (have-prfx (and prefix
540 (save-excursion
541 (beginning-of-line)
542 (looking-at (regexp-quote prefix))))))
543 (newline 1)
544 (if have-prfx (insert-and-inherit prefix))
545 (indent-to col 0)
546 (goto-char pos)))
547
548 (defun delete-indentation (&optional arg)
549 "Join this line to previous and fix up whitespace at join.
550 If there is a fill prefix, delete it from the beginning of this line.
551 With argument, join this line to following line."
552 (interactive "*P")
553 (beginning-of-line)
554 (if arg (forward-line 1))
555 (if (eq (preceding-char) ?\n)
556 (progn
557 (delete-region (point) (1- (point)))
558 ;; If the second line started with the fill prefix,
559 ;; delete the prefix.
560 (if (and fill-prefix
561 (<= (+ (point) (length fill-prefix)) (point-max))
562 (string= fill-prefix
563 (buffer-substring (point)
564 (+ (point) (length fill-prefix)))))
565 (delete-region (point) (+ (point) (length fill-prefix))))
566 (fixup-whitespace))))
567
568 (defalias 'join-line #'delete-indentation) ; easier to find
569
570 (defun delete-blank-lines ()
571 "On blank line, delete all surrounding blank lines, leaving just one.
572 On isolated blank line, delete that one.
573 On nonblank line, delete any immediately following blank lines."
574 (interactive "*")
575 (let (thisblank singleblank)
576 (save-excursion
577 (beginning-of-line)
578 (setq thisblank (looking-at "[ \t]*$"))
579 ;; Set singleblank if there is just one blank line here.
580 (setq singleblank
581 (and thisblank
582 (not (looking-at "[ \t]*\n[ \t]*$"))
583 (or (bobp)
584 (progn (forward-line -1)
585 (not (looking-at "[ \t]*$")))))))
586 ;; Delete preceding blank lines, and this one too if it's the only one.
587 (if thisblank
588 (progn
589 (beginning-of-line)
590 (if singleblank (forward-line 1))
591 (delete-region (point)
592 (if (re-search-backward "[^ \t\n]" nil t)
593 (progn (forward-line 1) (point))
594 (point-min)))))
595 ;; Delete following blank lines, unless the current line is blank
596 ;; and there are no following blank lines.
597 (if (not (and thisblank singleblank))
598 (save-excursion
599 (end-of-line)
600 (forward-line 1)
601 (delete-region (point)
602 (if (re-search-forward "[^ \t\n]" nil t)
603 (progn (beginning-of-line) (point))
604 (point-max)))))
605 ;; Handle the special case where point is followed by newline and eob.
606 ;; Delete the line, leaving point at eob.
607 (if (looking-at "^[ \t]*\n\\'")
608 (delete-region (point) (point-max)))))
609
610 (defun delete-trailing-whitespace ()
611 "Delete all the trailing whitespace across the current buffer.
612 All whitespace after the last non-whitespace character in a line is deleted.
613 This respects narrowing, created by \\[narrow-to-region] and friends.
614 A formfeed is not considered whitespace by this function."
615 (interactive "*")
616 (save-match-data
617 (save-excursion
618 (goto-char (point-min))
619 (while (re-search-forward "\\s-$" nil t)
620 (skip-syntax-backward "-" (save-excursion (forward-line 0) (point)))
621 ;; Don't delete formfeeds, even if they are considered whitespace.
622 (save-match-data
623 (if (looking-at ".*\f")
624 (goto-char (match-end 0))))
625 (delete-region (point) (match-end 0))))))
626
627 (defun newline-and-indent ()
628 "Insert a newline, then indent according to major mode.
629 Indentation is done using the value of `indent-line-function'.
630 In programming language modes, this is the same as TAB.
631 In some text modes, where TAB inserts a tab, this command indents to the
632 column specified by the function `current-left-margin'."
633 (interactive "*")
634 (delete-horizontal-space t)
635 (newline)
636 (indent-according-to-mode))
637
638 (defun reindent-then-newline-and-indent ()
639 "Reindent current line, insert newline, then indent the new line.
640 Indentation of both lines is done according to the current major mode,
641 which means calling the current value of `indent-line-function'.
642 In programming language modes, this is the same as TAB.
643 In some text modes, where TAB inserts a tab, this indents to the
644 column specified by the function `current-left-margin'."
645 (interactive "*")
646 (let ((pos (point)))
647 ;; Be careful to insert the newline before indenting the line.
648 ;; Otherwise, the indentation might be wrong.
649 (newline)
650 (save-excursion
651 (goto-char pos)
652 ;; We are at EOL before the call to indent-according-to-mode, and
653 ;; after it we usually are as well, but not always. We tried to
654 ;; address it with `save-excursion' but that uses a normal marker
655 ;; whereas we need `move after insertion', so we do the save/restore
656 ;; by hand.
657 (setq pos (copy-marker pos t))
658 (indent-according-to-mode)
659 (goto-char pos)
660 ;; Remove the trailing white-space after indentation because
661 ;; indentation may introduce the whitespace.
662 (delete-horizontal-space t))
663 (indent-according-to-mode)))
664
665 (defun quoted-insert (arg)
666 "Read next input character and insert it.
667 This is useful for inserting control characters.
668 With argument, insert ARG copies of the character.
669
670 If the first character you type after this command is an octal digit,
671 you should type a sequence of octal digits which specify a character code.
672 Any nondigit terminates the sequence. If the terminator is a RET,
673 it is discarded; any other terminator is used itself as input.
674 The variable `read-quoted-char-radix' specifies the radix for this feature;
675 set it to 10 or 16 to use decimal or hex instead of octal.
676
677 In overwrite mode, this function inserts the character anyway, and
678 does not handle octal digits specially. This means that if you use
679 overwrite as your normal editing mode, you can use this function to
680 insert characters when necessary.
681
682 In binary overwrite mode, this function does overwrite, and octal
683 digits are interpreted as a character code. This is intended to be
684 useful for editing binary files."
685 (interactive "*p")
686 (let* ((char
687 ;; Avoid "obsolete" warnings for translation-table-for-input.
688 (with-no-warnings
689 (let (translation-table-for-input input-method-function)
690 (if (or (not overwrite-mode)
691 (eq overwrite-mode 'overwrite-mode-binary))
692 (read-quoted-char)
693 (read-char))))))
694 ;; This used to assume character codes 0240 - 0377 stand for
695 ;; characters in some single-byte character set, and converted them
696 ;; to Emacs characters. But in 23.1 this feature is deprecated
697 ;; in favor of inserting the corresponding Unicode characters.
698 ;; (if (and enable-multibyte-characters
699 ;; (>= char ?\240)
700 ;; (<= char ?\377))
701 ;; (setq char (unibyte-char-to-multibyte char)))
702 (if (> arg 0)
703 (if (eq overwrite-mode 'overwrite-mode-binary)
704 (delete-char arg)))
705 (while (> arg 0)
706 (insert-and-inherit char)
707 (setq arg (1- arg)))))
708
709 (defun forward-to-indentation (&optional arg)
710 "Move forward ARG lines and position at first nonblank character."
711 (interactive "^p")
712 (forward-line (or arg 1))
713 (skip-chars-forward " \t"))
714
715 (defun backward-to-indentation (&optional arg)
716 "Move backward ARG lines and position at first nonblank character."
717 (interactive "^p")
718 (forward-line (- (or arg 1)))
719 (skip-chars-forward " \t"))
720
721 (defun back-to-indentation ()
722 "Move point to the first non-whitespace character on this line."
723 (interactive "^")
724 (beginning-of-line 1)
725 (skip-syntax-forward " " (line-end-position))
726 ;; Move back over chars that have whitespace syntax but have the p flag.
727 (backward-prefix-chars))
728
729 (defun fixup-whitespace ()
730 "Fixup white space between objects around point.
731 Leave one space or none, according to the context."
732 (interactive "*")
733 (save-excursion
734 (delete-horizontal-space)
735 (if (or (looking-at "^\\|\\s)")
736 (save-excursion (forward-char -1)
737 (looking-at "$\\|\\s(\\|\\s'")))
738 nil
739 (insert ?\s))))
740
741 (defun delete-horizontal-space (&optional backward-only)
742 "Delete all spaces and tabs around point.
743 If BACKWARD-ONLY is non-nil, only delete them before point."
744 (interactive "*P")
745 (let ((orig-pos (point)))
746 (delete-region
747 (if backward-only
748 orig-pos
749 (progn
750 (skip-chars-forward " \t")
751 (constrain-to-field nil orig-pos t)))
752 (progn
753 (skip-chars-backward " \t")
754 (constrain-to-field nil orig-pos)))))
755
756 (defun just-one-space (&optional n)
757 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
758 (interactive "*p")
759 (let ((orig-pos (point)))
760 (skip-chars-backward " \t")
761 (constrain-to-field nil orig-pos)
762 (dotimes (i (or n 1))
763 (if (= (following-char) ?\s)
764 (forward-char 1)
765 (insert ?\s)))
766 (delete-region
767 (point)
768 (progn
769 (skip-chars-forward " \t")
770 (constrain-to-field nil orig-pos t)))))
771 \f
772 (defun beginning-of-buffer (&optional arg)
773 "Move point to the beginning of the buffer.
774 With numeric arg N, put point N/10 of the way from the beginning.
775 If the buffer is narrowed, this command uses the beginning of the
776 accessible part of the buffer.
777
778 If Transient Mark mode is disabled, leave mark at previous
779 position, unless a \\[universal-argument] prefix is supplied.
780
781 Don't use this command in Lisp programs!
782 \(goto-char (point-min)) is faster."
783 (interactive "^P")
784 (or (consp arg)
785 (region-active-p)
786 (push-mark))
787 (let ((size (- (point-max) (point-min))))
788 (goto-char (if (and arg (not (consp arg)))
789 (+ (point-min)
790 (if (> size 10000)
791 ;; Avoid overflow for large buffer sizes!
792 (* (prefix-numeric-value arg)
793 (/ size 10))
794 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
795 (point-min))))
796 (if (and arg (not (consp arg))) (forward-line 1)))
797
798 (defun end-of-buffer (&optional arg)
799 "Move point to the end of the buffer.
800 With numeric arg N, put point N/10 of the way from the end.
801 If the buffer is narrowed, this command uses the end of the
802 accessible part of the buffer.
803
804 If Transient Mark mode is disabled, leave mark at previous
805 position, unless a \\[universal-argument] prefix is supplied.
806
807 Don't use this command in Lisp programs!
808 \(goto-char (point-max)) is faster."
809 (interactive "^P")
810 (or (consp arg) (region-active-p) (push-mark))
811 (let ((size (- (point-max) (point-min))))
812 (goto-char (if (and arg (not (consp arg)))
813 (- (point-max)
814 (if (> size 10000)
815 ;; Avoid overflow for large buffer sizes!
816 (* (prefix-numeric-value arg)
817 (/ size 10))
818 (/ (* size (prefix-numeric-value arg)) 10)))
819 (point-max))))
820 ;; If we went to a place in the middle of the buffer,
821 ;; adjust it to the beginning of a line.
822 (cond ((and arg (not (consp arg))) (forward-line 1))
823 ((> (point) (window-end nil t))
824 ;; If the end of the buffer is not already on the screen,
825 ;; then scroll specially to put it near, but not at, the bottom.
826 (overlay-recenter (point))
827 (recenter -3))))
828
829 (defcustom delete-active-region t
830 "Whether single-char deletion commands delete an active region.
831 This has an effect only if Transient Mark mode is enabled, and
832 affects `delete-forward-char' and `delete-backward-char', though
833 not `delete-char'.
834
835 If the value is the symbol `kill', the active region is killed
836 instead of deleted."
837 :type '(choice (const :tag "Delete active region" t)
838 (const :tag "Kill active region" kill)
839 (const :tag "Do ordinary deletion" nil))
840 :group 'editing
841 :version "24.1")
842
843 (defun delete-backward-char (n &optional killflag)
844 "Delete the previous N characters (following if N is negative).
845 If Transient Mark mode is enabled, the mark is active, and N is 1,
846 delete the text in the region and deactivate the mark instead.
847 To disable this, set `delete-active-region' to nil.
848
849 Optional second arg KILLFLAG, if non-nil, means to kill (save in
850 kill ring) instead of delete. Interactively, N is the prefix
851 arg, and KILLFLAG is set if N is explicitly specified.
852
853 In Overwrite mode, single character backward deletion may replace
854 tabs with spaces so as to back over columns, unless point is at
855 the end of the line."
856 (interactive "p\nP")
857 (unless (integerp n)
858 (signal 'wrong-type-argument (list 'integerp n)))
859 (cond ((and (use-region-p)
860 delete-active-region
861 (= n 1))
862 ;; If a region is active, kill or delete it.
863 (if (eq delete-active-region 'kill)
864 (kill-region (region-beginning) (region-end))
865 (delete-region (region-beginning) (region-end))))
866 ;; In Overwrite mode, maybe untabify while deleting
867 ((null (or (null overwrite-mode)
868 (<= n 0)
869 (memq (char-before) '(?\t ?\n))
870 (eobp)
871 (eq (char-after) ?\n)))
872 (let* ((ocol (current-column))
873 (val (delete-char (- n) killflag)))
874 (save-excursion
875 (insert-char ?\s (- ocol (current-column)) nil))))
876 ;; Otherwise, do simple deletion.
877 (t (delete-char (- n) killflag))))
878
879 (defun delete-forward-char (n &optional killflag)
880 "Delete the following N characters (previous if N is negative).
881 If Transient Mark mode is enabled, the mark is active, and N is 1,
882 delete the text in the region and deactivate the mark instead.
883 To disable this, set `delete-active-region' to nil.
884
885 Optional second arg KILLFLAG non-nil means to kill (save in kill
886 ring) instead of delete. Interactively, N is the prefix arg, and
887 KILLFLAG is set if N was explicitly specified."
888 (interactive "p\nP")
889 (unless (integerp n)
890 (signal 'wrong-type-argument (list 'integerp n)))
891 (cond ((and (use-region-p)
892 delete-active-region
893 (= n 1))
894 ;; If a region is active, kill or delete it.
895 (if (eq delete-active-region 'kill)
896 (kill-region (region-beginning) (region-end))
897 (delete-region (region-beginning) (region-end))))
898 ;; Otherwise, do simple deletion.
899 (t (delete-char n killflag))))
900
901 (defun mark-whole-buffer ()
902 "Put point at beginning and mark at end of buffer.
903 You probably should not use this function in Lisp programs;
904 it is usually a mistake for a Lisp function to use any subroutine
905 that uses or sets the mark."
906 (interactive)
907 (push-mark (point))
908 (push-mark (point-max) nil t)
909 (goto-char (point-min)))
910 \f
911
912 ;; Counting lines, one way or another.
913
914 (defun goto-line (line &optional buffer)
915 "Goto LINE, counting from line 1 at beginning of buffer.
916 Normally, move point in the current buffer, and leave mark at the
917 previous position. With just \\[universal-argument] as argument,
918 move point in the most recently selected other buffer, and switch to it.
919
920 If there's a number in the buffer at point, it is the default for LINE.
921
922 This function is usually the wrong thing to use in a Lisp program.
923 What you probably want instead is something like:
924 (goto-char (point-min)) (forward-line (1- N))
925 If at all possible, an even better solution is to use char counts
926 rather than line counts."
927 (interactive
928 (if (and current-prefix-arg (not (consp current-prefix-arg)))
929 (list (prefix-numeric-value current-prefix-arg))
930 ;; Look for a default, a number in the buffer at point.
931 (let* ((default
932 (save-excursion
933 (skip-chars-backward "0-9")
934 (if (looking-at "[0-9]")
935 (buffer-substring-no-properties
936 (point)
937 (progn (skip-chars-forward "0-9")
938 (point))))))
939 ;; Decide if we're switching buffers.
940 (buffer
941 (if (consp current-prefix-arg)
942 (other-buffer (current-buffer) t)))
943 (buffer-prompt
944 (if buffer
945 (concat " in " (buffer-name buffer))
946 "")))
947 ;; Read the argument, offering that number (if any) as default.
948 (list (read-from-minibuffer (format (if default "Goto line%s (%s): "
949 "Goto line%s: ")
950 buffer-prompt
951 default)
952 nil nil t
953 'minibuffer-history
954 default)
955 buffer))))
956 ;; Switch to the desired buffer, one way or another.
957 (if buffer
958 (let ((window (get-buffer-window buffer)))
959 (if window (select-window window)
960 (switch-to-buffer-other-window buffer))))
961 ;; Leave mark at previous position
962 (or (region-active-p) (push-mark))
963 ;; Move to the specified line number in that buffer.
964 (save-restriction
965 (widen)
966 (goto-char (point-min))
967 (if (eq selective-display t)
968 (re-search-forward "[\n\C-m]" nil 'end (1- line))
969 (forward-line (1- line)))))
970
971 (defun count-lines-region (start end)
972 "Print number of lines and characters in the region."
973 (interactive "r")
974 (message "Region has %d lines, %d characters"
975 (count-lines start end) (- end start)))
976
977 (defun what-line ()
978 "Print the current buffer line number and narrowed line number of point."
979 (interactive)
980 (let ((start (point-min))
981 (n (line-number-at-pos)))
982 (if (= start 1)
983 (message "Line %d" n)
984 (save-excursion
985 (save-restriction
986 (widen)
987 (message "line %d (narrowed line %d)"
988 (+ n (line-number-at-pos start) -1) n))))))
989
990 (defun count-lines (start end)
991 "Return number of lines between START and END.
992 This is usually the number of newlines between them,
993 but can be one more if START is not equal to END
994 and the greater of them is not at the start of a line."
995 (save-excursion
996 (save-restriction
997 (narrow-to-region start end)
998 (goto-char (point-min))
999 (if (eq selective-display t)
1000 (save-match-data
1001 (let ((done 0))
1002 (while (re-search-forward "[\n\C-m]" nil t 40)
1003 (setq done (+ 40 done)))
1004 (while (re-search-forward "[\n\C-m]" nil t 1)
1005 (setq done (+ 1 done)))
1006 (goto-char (point-max))
1007 (if (and (/= start end)
1008 (not (bolp)))
1009 (1+ done)
1010 done)))
1011 (- (buffer-size) (forward-line (buffer-size)))))))
1012
1013 (defun line-number-at-pos (&optional pos)
1014 "Return (narrowed) buffer line number at position POS.
1015 If POS is nil, use current buffer location.
1016 Counting starts at (point-min), so the value refers
1017 to the contents of the accessible portion of the buffer."
1018 (let ((opoint (or pos (point))) start)
1019 (save-excursion
1020 (goto-char (point-min))
1021 (setq start (point))
1022 (goto-char opoint)
1023 (forward-line 0)
1024 (1+ (count-lines start (point))))))
1025
1026 (defun what-cursor-position (&optional detail)
1027 "Print info on cursor position (on screen and within buffer).
1028 Also describe the character after point, and give its character code
1029 in octal, decimal and hex.
1030
1031 For a non-ASCII multibyte character, also give its encoding in the
1032 buffer's selected coding system if the coding system encodes the
1033 character safely. If the character is encoded into one byte, that
1034 code is shown in hex. If the character is encoded into more than one
1035 byte, just \"...\" is shown.
1036
1037 In addition, with prefix argument, show details about that character
1038 in *Help* buffer. See also the command `describe-char'."
1039 (interactive "P")
1040 (let* ((char (following-char))
1041 (beg (point-min))
1042 (end (point-max))
1043 (pos (point))
1044 (total (buffer-size))
1045 (percent (if (> total 50000)
1046 ;; Avoid overflow from multiplying by 100!
1047 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
1048 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
1049 (hscroll (if (= (window-hscroll) 0)
1050 ""
1051 (format " Hscroll=%d" (window-hscroll))))
1052 (col (current-column)))
1053 (if (= pos end)
1054 (if (or (/= beg 1) (/= end (1+ total)))
1055 (message "point=%d of %d (%d%%) <%d-%d> column=%d%s"
1056 pos total percent beg end col hscroll)
1057 (message "point=%d of %d (EOB) column=%d%s"
1058 pos total col hscroll))
1059 (let ((coding buffer-file-coding-system)
1060 encoded encoding-msg display-prop under-display)
1061 (if (or (not coding)
1062 (eq (coding-system-type coding) t))
1063 (setq coding (default-value 'buffer-file-coding-system)))
1064 (if (eq (char-charset char) 'eight-bit)
1065 (setq encoding-msg
1066 (format "(%d, #o%o, #x%x, raw-byte)" char char char))
1067 ;; Check if the character is displayed with some `display'
1068 ;; text property. In that case, set under-display to the
1069 ;; buffer substring covered by that property.
1070 (setq display-prop (get-text-property pos 'display))
1071 (if display-prop
1072 (let ((to (or (next-single-property-change pos 'display)
1073 (point-max))))
1074 (if (< to (+ pos 4))
1075 (setq under-display "")
1076 (setq under-display "..."
1077 to (+ pos 4)))
1078 (setq under-display
1079 (concat (buffer-substring-no-properties pos to)
1080 under-display)))
1081 (setq encoded (and (>= char 128) (encode-coding-char char coding))))
1082 (setq encoding-msg
1083 (if display-prop
1084 (if (not (stringp display-prop))
1085 (format "(%d, #o%o, #x%x, part of display \"%s\")"
1086 char char char under-display)
1087 (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")"
1088 char char char under-display display-prop))
1089 (if encoded
1090 (format "(%d, #o%o, #x%x, file %s)"
1091 char char char
1092 (if (> (length encoded) 1)
1093 "..."
1094 (encoded-string-description encoded coding)))
1095 (format "(%d, #o%o, #x%x)" char char char)))))
1096 (if detail
1097 ;; We show the detailed information about CHAR.
1098 (describe-char (point)))
1099 (if (or (/= beg 1) (/= end (1+ total)))
1100 (message "Char: %s %s point=%d of %d (%d%%) <%d-%d> column=%d%s"
1101 (if (< char 256)
1102 (single-key-description char)
1103 (buffer-substring-no-properties (point) (1+ (point))))
1104 encoding-msg pos total percent beg end col hscroll)
1105 (message "Char: %s %s point=%d of %d (%d%%) column=%d%s"
1106 (if enable-multibyte-characters
1107 (if (< char 128)
1108 (single-key-description char)
1109 (buffer-substring-no-properties (point) (1+ (point))))
1110 (single-key-description char))
1111 encoding-msg pos total percent col hscroll))))))
1112 \f
1113 ;; Initialize read-expression-map. It is defined at C level.
1114 (let ((m (make-sparse-keymap)))
1115 (define-key m "\M-\t" 'lisp-complete-symbol)
1116 (set-keymap-parent m minibuffer-local-map)
1117 (setq read-expression-map m))
1118
1119 (defvar read-expression-history nil)
1120
1121 (defvar minibuffer-completing-symbol nil
1122 "Non-nil means completing a Lisp symbol in the minibuffer.")
1123
1124 (defvar minibuffer-default nil
1125 "The current default value or list of default values in the minibuffer.
1126 The functions `read-from-minibuffer' and `completing-read' bind
1127 this variable locally.")
1128
1129 (defcustom eval-expression-print-level 4
1130 "Value for `print-level' while printing value in `eval-expression'.
1131 A value of nil means no limit."
1132 :group 'lisp
1133 :type '(choice (const :tag "No Limit" nil) integer)
1134 :version "21.1")
1135
1136 (defcustom eval-expression-print-length 12
1137 "Value for `print-length' while printing value in `eval-expression'.
1138 A value of nil means no limit."
1139 :group 'lisp
1140 :type '(choice (const :tag "No Limit" nil) integer)
1141 :version "21.1")
1142
1143 (defcustom eval-expression-debug-on-error t
1144 "If non-nil set `debug-on-error' to t in `eval-expression'.
1145 If nil, don't change the value of `debug-on-error'."
1146 :group 'lisp
1147 :type 'boolean
1148 :version "21.1")
1149
1150 (defun eval-expression-print-format (value)
1151 "Format VALUE as a result of evaluated expression.
1152 Return a formatted string which is displayed in the echo area
1153 in addition to the value printed by prin1 in functions which
1154 display the result of expression evaluation."
1155 (if (and (integerp value)
1156 (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp)))
1157 (eq this-command last-command)
1158 (if (boundp 'edebug-active) edebug-active)))
1159 (let ((char-string
1160 (if (or (if (boundp 'edebug-active) edebug-active)
1161 (memq this-command '(eval-last-sexp eval-print-last-sexp)))
1162 (prin1-char value))))
1163 (if char-string
1164 (format " (#o%o, #x%x, %s)" value value char-string)
1165 (format " (#o%o, #x%x)" value value)))))
1166
1167 ;; We define this, rather than making `eval' interactive,
1168 ;; for the sake of completion of names like eval-region, eval-buffer.
1169 (defun eval-expression (eval-expression-arg
1170 &optional eval-expression-insert-value)
1171 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1172 Value is also consed on to front of the variable `values'.
1173 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1174 with prefix argument) means insert the result into the current buffer
1175 instead of printing it in the echo area. Truncates long output
1176 according to the value of the variables `eval-expression-print-length'
1177 and `eval-expression-print-level'.
1178
1179 If `eval-expression-debug-on-error' is non-nil, which is the default,
1180 this command arranges for all errors to enter the debugger."
1181 (interactive
1182 (list (let ((minibuffer-completing-symbol t))
1183 (read-from-minibuffer "Eval: "
1184 nil read-expression-map t
1185 'read-expression-history))
1186 current-prefix-arg))
1187
1188 (if (null eval-expression-debug-on-error)
1189 (setq values (cons (eval eval-expression-arg) values))
1190 (let ((old-value (make-symbol "t")) new-value)
1191 ;; Bind debug-on-error to something unique so that we can
1192 ;; detect when evaled code changes it.
1193 (let ((debug-on-error old-value))
1194 (setq values (cons (eval eval-expression-arg) values))
1195 (setq new-value debug-on-error))
1196 ;; If evaled code has changed the value of debug-on-error,
1197 ;; propagate that change to the global binding.
1198 (unless (eq old-value new-value)
1199 (setq debug-on-error new-value))))
1200
1201 (let ((print-length eval-expression-print-length)
1202 (print-level eval-expression-print-level))
1203 (if eval-expression-insert-value
1204 (with-no-warnings
1205 (let ((standard-output (current-buffer)))
1206 (prin1 (car values))))
1207 (prog1
1208 (prin1 (car values) t)
1209 (let ((str (eval-expression-print-format (car values))))
1210 (if str (princ str t)))))))
1211
1212 (defun edit-and-eval-command (prompt command)
1213 "Prompting with PROMPT, let user edit COMMAND and eval result.
1214 COMMAND is a Lisp expression. Let user edit that expression in
1215 the minibuffer, then read and evaluate the result."
1216 (let ((command
1217 (let ((print-level nil)
1218 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1219 (unwind-protect
1220 (read-from-minibuffer prompt
1221 (prin1-to-string command)
1222 read-expression-map t
1223 'command-history)
1224 ;; If command was added to command-history as a string,
1225 ;; get rid of that. We want only evaluable expressions there.
1226 (if (stringp (car command-history))
1227 (setq command-history (cdr command-history)))))))
1228
1229 ;; If command to be redone does not match front of history,
1230 ;; add it to the history.
1231 (or (equal command (car command-history))
1232 (setq command-history (cons command command-history)))
1233 (eval command)))
1234
1235 (defun repeat-complex-command (arg)
1236 "Edit and re-evaluate last complex command, or ARGth from last.
1237 A complex command is one which used the minibuffer.
1238 The command is placed in the minibuffer as a Lisp form for editing.
1239 The result is executed, repeating the command as changed.
1240 If the command has been changed or is not the most recent previous
1241 command it is added to the front of the command history.
1242 You can use the minibuffer history commands \
1243 \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1244 to get different commands to edit and resubmit."
1245 (interactive "p")
1246 (let ((elt (nth (1- arg) command-history))
1247 newcmd)
1248 (if elt
1249 (progn
1250 (setq newcmd
1251 (let ((print-level nil)
1252 (minibuffer-history-position arg)
1253 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
1254 (unwind-protect
1255 (read-from-minibuffer
1256 "Redo: " (prin1-to-string elt) read-expression-map t
1257 (cons 'command-history arg))
1258
1259 ;; If command was added to command-history as a
1260 ;; string, get rid of that. We want only
1261 ;; evaluable expressions there.
1262 (if (stringp (car command-history))
1263 (setq command-history (cdr command-history))))))
1264
1265 ;; If command to be redone does not match front of history,
1266 ;; add it to the history.
1267 (or (equal newcmd (car command-history))
1268 (setq command-history (cons newcmd command-history)))
1269 (eval newcmd))
1270 (if command-history
1271 (error "Argument %d is beyond length of command history" arg)
1272 (error "There are no previous complex commands to repeat")))))
1273
1274 (defun read-extended-command ()
1275 "Read command name to invoke in `execute-extended-command'."
1276 (minibuffer-with-setup-hook
1277 (lambda ()
1278 (set (make-local-variable 'minibuffer-default-add-function)
1279 (lambda ()
1280 ;; Get a command name at point in the original buffer
1281 ;; to propose it after M-n.
1282 (with-current-buffer (window-buffer (minibuffer-selected-window))
1283 (and (commandp (function-called-at-point))
1284 (format "%S" (function-called-at-point)))))))
1285 ;; Read a string, completing from and restricting to the set of
1286 ;; all defined commands. Don't provide any initial input.
1287 ;; Save the command read on the extended-command history list.
1288 (completing-read
1289 (concat (cond
1290 ((eq current-prefix-arg '-) "- ")
1291 ((and (consp current-prefix-arg)
1292 (eq (car current-prefix-arg) 4)) "C-u ")
1293 ((and (consp current-prefix-arg)
1294 (integerp (car current-prefix-arg)))
1295 (format "%d " (car current-prefix-arg)))
1296 ((integerp current-prefix-arg)
1297 (format "%d " current-prefix-arg)))
1298 ;; This isn't strictly correct if `execute-extended-command'
1299 ;; is bound to anything else (e.g. [menu]).
1300 ;; It could use (key-description (this-single-command-keys)),
1301 ;; but actually a prompt other than "M-x" would be confusing,
1302 ;; because "M-x" is a well-known prompt to read a command
1303 ;; and it serves as a shorthand for "Extended command: ".
1304 "M-x ")
1305 obarray 'commandp t nil 'extended-command-history)))
1306
1307 \f
1308 (defvar minibuffer-history nil
1309 "Default minibuffer history list.
1310 This is used for all minibuffer input
1311 except when an alternate history list is specified.
1312
1313 Maximum length of the history list is determined by the value
1314 of `history-length', which see.")
1315 (defvar minibuffer-history-sexp-flag nil
1316 "Control whether history list elements are expressions or strings.
1317 If the value of this variable equals current minibuffer depth,
1318 they are expressions; otherwise they are strings.
1319 \(That convention is designed to do the right thing for
1320 recursive uses of the minibuffer.)")
1321 (setq minibuffer-history-variable 'minibuffer-history)
1322 (setq minibuffer-history-position nil) ;; Defvar is in C code.
1323 (defvar minibuffer-history-search-history nil)
1324
1325 (defvar minibuffer-text-before-history nil
1326 "Text that was in this minibuffer before any history commands.
1327 This is nil if there have not yet been any history commands
1328 in this use of the minibuffer.")
1329
1330 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
1331
1332 (defun minibuffer-history-initialize ()
1333 (setq minibuffer-text-before-history nil))
1334
1335 (defun minibuffer-avoid-prompt (new old)
1336 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1337 (constrain-to-field nil (point-max)))
1338
1339 (defcustom minibuffer-history-case-insensitive-variables nil
1340 "Minibuffer history variables for which matching should ignore case.
1341 If a history variable is a member of this list, then the
1342 \\[previous-matching-history-element] and \\[next-matching-history-element]\
1343 commands ignore case when searching it, regardless of `case-fold-search'."
1344 :type '(repeat variable)
1345 :group 'minibuffer)
1346
1347 (defun previous-matching-history-element (regexp n)
1348 "Find the previous history element that matches REGEXP.
1349 \(Previous history elements refer to earlier actions.)
1350 With prefix argument N, search for Nth previous match.
1351 If N is negative, find the next or Nth next match.
1352 Normally, history elements are matched case-insensitively if
1353 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1354 makes the search case-sensitive.
1355 See also `minibuffer-history-case-insensitive-variables'."
1356 (interactive
1357 (let* ((enable-recursive-minibuffers t)
1358 (regexp (read-from-minibuffer "Previous element matching (regexp): "
1359 nil
1360 minibuffer-local-map
1361 nil
1362 'minibuffer-history-search-history
1363 (car minibuffer-history-search-history))))
1364 ;; Use the last regexp specified, by default, if input is empty.
1365 (list (if (string= regexp "")
1366 (if minibuffer-history-search-history
1367 (car minibuffer-history-search-history)
1368 (error "No previous history search regexp"))
1369 regexp)
1370 (prefix-numeric-value current-prefix-arg))))
1371 (unless (zerop n)
1372 (if (and (zerop minibuffer-history-position)
1373 (null minibuffer-text-before-history))
1374 (setq minibuffer-text-before-history
1375 (minibuffer-contents-no-properties)))
1376 (let ((history (symbol-value minibuffer-history-variable))
1377 (case-fold-search
1378 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
1379 ;; On some systems, ignore case for file names.
1380 (if (memq minibuffer-history-variable
1381 minibuffer-history-case-insensitive-variables)
1382 t
1383 ;; Respect the user's setting for case-fold-search:
1384 case-fold-search)
1385 nil))
1386 prevpos
1387 match-string
1388 match-offset
1389 (pos minibuffer-history-position))
1390 (while (/= n 0)
1391 (setq prevpos pos)
1392 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
1393 (when (= pos prevpos)
1394 (error (if (= pos 1)
1395 "No later matching history item"
1396 "No earlier matching history item")))
1397 (setq match-string
1398 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
1399 (let ((print-level nil))
1400 (prin1-to-string (nth (1- pos) history)))
1401 (nth (1- pos) history)))
1402 (setq match-offset
1403 (if (< n 0)
1404 (and (string-match regexp match-string)
1405 (match-end 0))
1406 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
1407 (match-beginning 1))))
1408 (when match-offset
1409 (setq n (+ n (if (< n 0) 1 -1)))))
1410 (setq minibuffer-history-position pos)
1411 (goto-char (point-max))
1412 (delete-minibuffer-contents)
1413 (insert match-string)
1414 (goto-char (+ (minibuffer-prompt-end) match-offset))))
1415 (if (memq (car (car command-history)) '(previous-matching-history-element
1416 next-matching-history-element))
1417 (setq command-history (cdr command-history))))
1418
1419 (defun next-matching-history-element (regexp n)
1420 "Find the next history element that matches REGEXP.
1421 \(The next history element refers to a more recent action.)
1422 With prefix argument N, search for Nth next match.
1423 If N is negative, find the previous or Nth previous match.
1424 Normally, history elements are matched case-insensitively if
1425 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1426 makes the search case-sensitive."
1427 (interactive
1428 (let* ((enable-recursive-minibuffers t)
1429 (regexp (read-from-minibuffer "Next element matching (regexp): "
1430 nil
1431 minibuffer-local-map
1432 nil
1433 'minibuffer-history-search-history
1434 (car minibuffer-history-search-history))))
1435 ;; Use the last regexp specified, by default, if input is empty.
1436 (list (if (string= regexp "")
1437 (if minibuffer-history-search-history
1438 (car minibuffer-history-search-history)
1439 (error "No previous history search regexp"))
1440 regexp)
1441 (prefix-numeric-value current-prefix-arg))))
1442 (previous-matching-history-element regexp (- n)))
1443
1444 (defvar minibuffer-temporary-goal-position nil)
1445
1446 (defvar minibuffer-default-add-function 'minibuffer-default-add-completions
1447 "Function run by `goto-history-element' before consuming default values.
1448 This is useful to dynamically add more elements to the list of default values
1449 when `goto-history-element' reaches the end of this list.
1450 Before calling this function `goto-history-element' sets the variable
1451 `minibuffer-default-add-done' to t, so it will call this function only
1452 once. In special cases, when this function needs to be called more
1453 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1454 overriding the setting of this variable to t in `goto-history-element'.")
1455
1456 (defvar minibuffer-default-add-done nil
1457 "When nil, add more elements to the end of the list of default values.
1458 The value nil causes `goto-history-element' to add more elements to
1459 the list of defaults when it reaches the end of this list. It does
1460 this by calling a function defined by `minibuffer-default-add-function'.")
1461
1462 (make-variable-buffer-local 'minibuffer-default-add-done)
1463
1464 (defun minibuffer-default-add-completions ()
1465 "Return a list of all completions without the default value.
1466 This function is used to add all elements of the completion table to
1467 the end of the list of defaults just after the default value."
1468 (let ((def minibuffer-default)
1469 (all (all-completions ""
1470 minibuffer-completion-table
1471 minibuffer-completion-predicate)))
1472 (if (listp def)
1473 (append def all)
1474 (cons def (delete def all)))))
1475
1476 (defun goto-history-element (nabs)
1477 "Puts element of the minibuffer history in the minibuffer.
1478 The argument NABS specifies the absolute history position."
1479 (interactive "p")
1480 (when (and (not minibuffer-default-add-done)
1481 (functionp minibuffer-default-add-function)
1482 (< nabs (- (if (listp minibuffer-default)
1483 (length minibuffer-default)
1484 1))))
1485 (setq minibuffer-default-add-done t
1486 minibuffer-default (funcall minibuffer-default-add-function)))
1487 (let ((minimum (if minibuffer-default
1488 (- (if (listp minibuffer-default)
1489 (length minibuffer-default)
1490 1))
1491 0))
1492 elt minibuffer-returned-to-present)
1493 (if (and (zerop minibuffer-history-position)
1494 (null minibuffer-text-before-history))
1495 (setq minibuffer-text-before-history
1496 (minibuffer-contents-no-properties)))
1497 (if (< nabs minimum)
1498 (if minibuffer-default
1499 (error "End of defaults; no next item")
1500 (error "End of history; no default available")))
1501 (if (> nabs (length (symbol-value minibuffer-history-variable)))
1502 (error "Beginning of history; no preceding item"))
1503 (unless (memq last-command '(next-history-element
1504 previous-history-element))
1505 (let ((prompt-end (minibuffer-prompt-end)))
1506 (set (make-local-variable 'minibuffer-temporary-goal-position)
1507 (cond ((<= (point) prompt-end) prompt-end)
1508 ((eobp) nil)
1509 (t (point))))))
1510 (goto-char (point-max))
1511 (delete-minibuffer-contents)
1512 (setq minibuffer-history-position nabs)
1513 (cond ((< nabs 0)
1514 (setq elt (if (listp minibuffer-default)
1515 (nth (1- (abs nabs)) minibuffer-default)
1516 minibuffer-default)))
1517 ((= nabs 0)
1518 (setq elt (or minibuffer-text-before-history ""))
1519 (setq minibuffer-returned-to-present t)
1520 (setq minibuffer-text-before-history nil))
1521 (t (setq elt (nth (1- minibuffer-history-position)
1522 (symbol-value minibuffer-history-variable)))))
1523 (insert
1524 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
1525 (not minibuffer-returned-to-present))
1526 (let ((print-level nil))
1527 (prin1-to-string elt))
1528 elt))
1529 (goto-char (or minibuffer-temporary-goal-position (point-max)))))
1530
1531 (defun next-history-element (n)
1532 "Puts next element of the minibuffer history in the minibuffer.
1533 With argument N, it uses the Nth following element."
1534 (interactive "p")
1535 (or (zerop n)
1536 (goto-history-element (- minibuffer-history-position n))))
1537
1538 (defun previous-history-element (n)
1539 "Puts previous element of the minibuffer history in the minibuffer.
1540 With argument N, it uses the Nth previous element."
1541 (interactive "p")
1542 (or (zerop n)
1543 (goto-history-element (+ minibuffer-history-position n))))
1544
1545 (defun next-complete-history-element (n)
1546 "Get next history element which completes the minibuffer before the point.
1547 The contents of the minibuffer after the point are deleted, and replaced
1548 by the new completion."
1549 (interactive "p")
1550 (let ((point-at-start (point)))
1551 (next-matching-history-element
1552 (concat
1553 "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point))))
1554 n)
1555 ;; next-matching-history-element always puts us at (point-min).
1556 ;; Move to the position we were at before changing the buffer contents.
1557 ;; This is still sensical, because the text before point has not changed.
1558 (goto-char point-at-start)))
1559
1560 (defun previous-complete-history-element (n)
1561 "\
1562 Get previous history element which completes the minibuffer before the point.
1563 The contents of the minibuffer after the point are deleted, and replaced
1564 by the new completion."
1565 (interactive "p")
1566 (next-complete-history-element (- n)))
1567
1568 ;; For compatibility with the old subr of the same name.
1569 (defun minibuffer-prompt-width ()
1570 "Return the display width of the minibuffer prompt.
1571 Return 0 if current buffer is not a minibuffer."
1572 ;; Return the width of everything before the field at the end of
1573 ;; the buffer; this should be 0 for normal buffers.
1574 (1- (minibuffer-prompt-end)))
1575 \f
1576 ;; isearch minibuffer history
1577 (add-hook 'minibuffer-setup-hook 'minibuffer-history-isearch-setup)
1578
1579 (defvar minibuffer-history-isearch-message-overlay)
1580 (make-variable-buffer-local 'minibuffer-history-isearch-message-overlay)
1581
1582 (defun minibuffer-history-isearch-setup ()
1583 "Set up a minibuffer for using isearch to search the minibuffer history.
1584 Intended to be added to `minibuffer-setup-hook'."
1585 (set (make-local-variable 'isearch-search-fun-function)
1586 'minibuffer-history-isearch-search)
1587 (set (make-local-variable 'isearch-message-function)
1588 'minibuffer-history-isearch-message)
1589 (set (make-local-variable 'isearch-wrap-function)
1590 'minibuffer-history-isearch-wrap)
1591 (set (make-local-variable 'isearch-push-state-function)
1592 'minibuffer-history-isearch-push-state)
1593 (add-hook 'isearch-mode-end-hook 'minibuffer-history-isearch-end nil t))
1594
1595 (defun minibuffer-history-isearch-end ()
1596 "Clean up the minibuffer after terminating isearch in the minibuffer."
1597 (if minibuffer-history-isearch-message-overlay
1598 (delete-overlay minibuffer-history-isearch-message-overlay)))
1599
1600 (defun minibuffer-history-isearch-search ()
1601 "Return the proper search function, for isearch in minibuffer history."
1602 (cond
1603 (isearch-word
1604 (if isearch-forward 'word-search-forward 'word-search-backward))
1605 (t
1606 (lambda (string bound noerror)
1607 (let ((search-fun
1608 ;; Use standard functions to search within minibuffer text
1609 (cond
1610 (isearch-regexp
1611 (if isearch-forward 're-search-forward 're-search-backward))
1612 (t
1613 (if isearch-forward 'search-forward 'search-backward))))
1614 found)
1615 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1616 ;; searching forward. Lazy-highlight calls this lambda with the
1617 ;; bound arg, so skip the minibuffer prompt.
1618 (if (and bound isearch-forward (< (point) (minibuffer-prompt-end)))
1619 (goto-char (minibuffer-prompt-end)))
1620 (or
1621 ;; 1. First try searching in the initial minibuffer text
1622 (funcall search-fun string
1623 (if isearch-forward bound (minibuffer-prompt-end))
1624 noerror)
1625 ;; 2. If the above search fails, start putting next/prev history
1626 ;; elements in the minibuffer successively, and search the string
1627 ;; in them. Do this only when bound is nil (i.e. not while
1628 ;; lazy-highlighting search strings in the current minibuffer text).
1629 (unless bound
1630 (condition-case nil
1631 (progn
1632 (while (not found)
1633 (cond (isearch-forward
1634 (next-history-element 1)
1635 (goto-char (minibuffer-prompt-end)))
1636 (t
1637 (previous-history-element 1)
1638 (goto-char (point-max))))
1639 (setq isearch-barrier (point) isearch-opoint (point))
1640 ;; After putting the next/prev history element, search
1641 ;; the string in them again, until next-history-element
1642 ;; or previous-history-element raises an error at the
1643 ;; beginning/end of history.
1644 (setq found (funcall search-fun string
1645 (unless isearch-forward
1646 ;; For backward search, don't search
1647 ;; in the minibuffer prompt
1648 (minibuffer-prompt-end))
1649 noerror)))
1650 ;; Return point of the new search result
1651 (point))
1652 ;; Return nil when next(prev)-history-element fails
1653 (error nil)))))))))
1654
1655 (defun minibuffer-history-isearch-message (&optional c-q-hack ellipsis)
1656 "Display the minibuffer history search prompt.
1657 If there are no search errors, this function displays an overlay with
1658 the isearch prompt which replaces the original minibuffer prompt.
1659 Otherwise, it displays the standard isearch message returned from
1660 `isearch-message'."
1661 (if (not (and (minibufferp) isearch-success (not isearch-error)))
1662 ;; Use standard function `isearch-message' when not in the minibuffer,
1663 ;; or search fails, or has an error (like incomplete regexp).
1664 ;; This function overwrites minibuffer text with isearch message,
1665 ;; so it's possible to see what is wrong in the search string.
1666 (isearch-message c-q-hack ellipsis)
1667 ;; Otherwise, put the overlay with the standard isearch prompt over
1668 ;; the initial minibuffer prompt.
1669 (if (overlayp minibuffer-history-isearch-message-overlay)
1670 (move-overlay minibuffer-history-isearch-message-overlay
1671 (point-min) (minibuffer-prompt-end))
1672 (setq minibuffer-history-isearch-message-overlay
1673 (make-overlay (point-min) (minibuffer-prompt-end)))
1674 (overlay-put minibuffer-history-isearch-message-overlay 'evaporate t))
1675 (overlay-put minibuffer-history-isearch-message-overlay
1676 'display (isearch-message-prefix c-q-hack ellipsis))
1677 ;; And clear any previous isearch message.
1678 (message "")))
1679
1680 (defun minibuffer-history-isearch-wrap ()
1681 "Wrap the minibuffer history search when search fails.
1682 Move point to the first history element for a forward search,
1683 or to the last history element for a backward search."
1684 (unless isearch-word
1685 ;; When `minibuffer-history-isearch-search' fails on reaching the
1686 ;; beginning/end of the history, wrap the search to the first/last
1687 ;; minibuffer history element.
1688 (if isearch-forward
1689 (goto-history-element (length (symbol-value minibuffer-history-variable)))
1690 (goto-history-element 0))
1691 (setq isearch-success t))
1692 (goto-char (if isearch-forward (minibuffer-prompt-end) (point-max))))
1693
1694 (defun minibuffer-history-isearch-push-state ()
1695 "Save a function restoring the state of minibuffer history search.
1696 Save `minibuffer-history-position' to the additional state parameter
1697 in the search status stack."
1698 `(lambda (cmd)
1699 (minibuffer-history-isearch-pop-state cmd ,minibuffer-history-position)))
1700
1701 (defun minibuffer-history-isearch-pop-state (cmd hist-pos)
1702 "Restore the minibuffer history search state.
1703 Go to the history element by the absolute history position HIST-POS."
1704 (goto-history-element hist-pos))
1705
1706 \f
1707 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1708 (define-obsolete-function-alias 'advertised-undo 'undo "23.2")
1709
1710 (defconst undo-equiv-table (make-hash-table :test 'eq :weakness t)
1711 "Table mapping redo records to the corresponding undo one.
1712 A redo record for undo-in-region maps to t.
1713 A redo record for ordinary undo maps to the following (earlier) undo.")
1714
1715 (defvar undo-in-region nil
1716 "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.")
1717
1718 (defvar undo-no-redo nil
1719 "If t, `undo' doesn't go through redo entries.")
1720
1721 (defvar pending-undo-list nil
1722 "Within a run of consecutive undo commands, list remaining to be undone.
1723 If t, we undid all the way to the end of it.")
1724
1725 (defun undo (&optional arg)
1726 "Undo some previous changes.
1727 Repeat this command to undo more changes.
1728 A numeric ARG serves as a repeat count.
1729
1730 In Transient Mark mode when the mark is active, only undo changes within
1731 the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument]
1732 as an argument limits undo to changes within the current region."
1733 (interactive "*P")
1734 ;; Make last-command indicate for the next command that this was an undo.
1735 ;; That way, another undo will undo more.
1736 ;; If we get to the end of the undo history and get an error,
1737 ;; another undo command will find the undo history empty
1738 ;; and will get another error. To begin undoing the undos,
1739 ;; you must type some other command.
1740 (let ((modified (buffer-modified-p))
1741 (recent-save (recent-auto-save-p))
1742 message)
1743 ;; If we get an error in undo-start,
1744 ;; the next command should not be a "consecutive undo".
1745 ;; So set `this-command' to something other than `undo'.
1746 (setq this-command 'undo-start)
1747
1748 (unless (and (eq last-command 'undo)
1749 (or (eq pending-undo-list t)
1750 ;; If something (a timer or filter?) changed the buffer
1751 ;; since the previous command, don't continue the undo seq.
1752 (let ((list buffer-undo-list))
1753 (while (eq (car list) nil)
1754 (setq list (cdr list)))
1755 ;; If the last undo record made was made by undo
1756 ;; it shows nothing else happened in between.
1757 (gethash list undo-equiv-table))))
1758 (setq undo-in-region
1759 (or (region-active-p) (and arg (not (numberp arg)))))
1760 (if undo-in-region
1761 (undo-start (region-beginning) (region-end))
1762 (undo-start))
1763 ;; get rid of initial undo boundary
1764 (undo-more 1))
1765 ;; If we got this far, the next command should be a consecutive undo.
1766 (setq this-command 'undo)
1767 ;; Check to see whether we're hitting a redo record, and if
1768 ;; so, ask the user whether she wants to skip the redo/undo pair.
1769 (let ((equiv (gethash pending-undo-list undo-equiv-table)))
1770 (or (eq (selected-window) (minibuffer-window))
1771 (setq message (if undo-in-region
1772 (if equiv "Redo in region!" "Undo in region!")
1773 (if equiv "Redo!" "Undo!"))))
1774 (when (and (consp equiv) undo-no-redo)
1775 ;; The equiv entry might point to another redo record if we have done
1776 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1777 (while (let ((next (gethash equiv undo-equiv-table)))
1778 (if next (setq equiv next))))
1779 (setq pending-undo-list equiv)))
1780 (undo-more
1781 (if (numberp arg)
1782 (prefix-numeric-value arg)
1783 1))
1784 ;; Record the fact that the just-generated undo records come from an
1785 ;; undo operation--that is, they are redo records.
1786 ;; In the ordinary case (not within a region), map the redo
1787 ;; record to the following undos.
1788 ;; I don't know how to do that in the undo-in-region case.
1789 (let ((list buffer-undo-list))
1790 ;; Strip any leading undo boundaries there might be, like we do
1791 ;; above when checking.
1792 (while (eq (car list) nil)
1793 (setq list (cdr list)))
1794 (puthash list (if undo-in-region t pending-undo-list)
1795 undo-equiv-table))
1796 ;; Don't specify a position in the undo record for the undo command.
1797 ;; Instead, undoing this should move point to where the change is.
1798 (let ((tail buffer-undo-list)
1799 (prev nil))
1800 (while (car tail)
1801 (when (integerp (car tail))
1802 (let ((pos (car tail)))
1803 (if prev
1804 (setcdr prev (cdr tail))
1805 (setq buffer-undo-list (cdr tail)))
1806 (setq tail (cdr tail))
1807 (while (car tail)
1808 (if (eq pos (car tail))
1809 (if prev
1810 (setcdr prev (cdr tail))
1811 (setq buffer-undo-list (cdr tail)))
1812 (setq prev tail))
1813 (setq tail (cdr tail)))
1814 (setq tail nil)))
1815 (setq prev tail tail (cdr tail))))
1816 ;; Record what the current undo list says,
1817 ;; so the next command can tell if the buffer was modified in between.
1818 (and modified (not (buffer-modified-p))
1819 (delete-auto-save-file-if-necessary recent-save))
1820 ;; Display a message announcing success.
1821 (if message
1822 (message "%s" message))))
1823
1824 (defun buffer-disable-undo (&optional buffer)
1825 "Make BUFFER stop keeping undo information.
1826 No argument or nil as argument means do this for the current buffer."
1827 (interactive)
1828 (with-current-buffer (if buffer (get-buffer buffer) (current-buffer))
1829 (setq buffer-undo-list t)))
1830
1831 (defun undo-only (&optional arg)
1832 "Undo some previous changes.
1833 Repeat this command to undo more changes.
1834 A numeric ARG serves as a repeat count.
1835 Contrary to `undo', this will not redo a previous undo."
1836 (interactive "*p")
1837 (let ((undo-no-redo t)) (undo arg)))
1838
1839 (defvar undo-in-progress nil
1840 "Non-nil while performing an undo.
1841 Some change-hooks test this variable to do something different.")
1842
1843 (defun undo-more (n)
1844 "Undo back N undo-boundaries beyond what was already undone recently.
1845 Call `undo-start' to get ready to undo recent changes,
1846 then call `undo-more' one or more times to undo them."
1847 (or (listp pending-undo-list)
1848 (error (concat "No further undo information"
1849 (and undo-in-region " for region"))))
1850 (let ((undo-in-progress t))
1851 ;; Note: The following, while pulling elements off
1852 ;; `pending-undo-list' will call primitive change functions which
1853 ;; will push more elements onto `buffer-undo-list'.
1854 (setq pending-undo-list (primitive-undo n pending-undo-list))
1855 (if (null pending-undo-list)
1856 (setq pending-undo-list t))))
1857
1858 ;; Deep copy of a list
1859 (defun undo-copy-list (list)
1860 "Make a copy of undo list LIST."
1861 (mapcar 'undo-copy-list-1 list))
1862
1863 (defun undo-copy-list-1 (elt)
1864 (if (consp elt)
1865 (cons (car elt) (undo-copy-list-1 (cdr elt)))
1866 elt))
1867
1868 (defun undo-start (&optional beg end)
1869 "Set `pending-undo-list' to the front of the undo list.
1870 The next call to `undo-more' will undo the most recently made change.
1871 If BEG and END are specified, then only undo elements
1872 that apply to text between BEG and END are used; other undo elements
1873 are ignored. If BEG and END are nil, all undo elements are used."
1874 (if (eq buffer-undo-list t)
1875 (error "No undo information in this buffer"))
1876 (setq pending-undo-list
1877 (if (and beg end (not (= beg end)))
1878 (undo-make-selective-list (min beg end) (max beg end))
1879 buffer-undo-list)))
1880
1881 (defvar undo-adjusted-markers)
1882
1883 (defun undo-make-selective-list (start end)
1884 "Return a list of undo elements for the region START to END.
1885 The elements come from `buffer-undo-list', but we keep only
1886 the elements inside this region, and discard those outside this region.
1887 If we find an element that crosses an edge of this region,
1888 we stop and ignore all further elements."
1889 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
1890 (undo-list (list nil))
1891 undo-adjusted-markers
1892 some-rejected
1893 undo-elt undo-elt temp-undo-list delta)
1894 (while undo-list-copy
1895 (setq undo-elt (car undo-list-copy))
1896 (let ((keep-this
1897 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
1898 ;; This is a "was unmodified" element.
1899 ;; Keep it if we have kept everything thus far.
1900 (not some-rejected))
1901 (t
1902 (undo-elt-in-region undo-elt start end)))))
1903 (if keep-this
1904 (progn
1905 (setq end (+ end (cdr (undo-delta undo-elt))))
1906 ;; Don't put two nils together in the list
1907 (if (not (and (eq (car undo-list) nil)
1908 (eq undo-elt nil)))
1909 (setq undo-list (cons undo-elt undo-list))))
1910 (if (undo-elt-crosses-region undo-elt start end)
1911 (setq undo-list-copy nil)
1912 (setq some-rejected t)
1913 (setq temp-undo-list (cdr undo-list-copy))
1914 (setq delta (undo-delta undo-elt))
1915
1916 (when (/= (cdr delta) 0)
1917 (let ((position (car delta))
1918 (offset (cdr delta)))
1919
1920 ;; Loop down the earlier events adjusting their buffer
1921 ;; positions to reflect the fact that a change to the buffer
1922 ;; isn't being undone. We only need to process those element
1923 ;; types which undo-elt-in-region will return as being in
1924 ;; the region since only those types can ever get into the
1925 ;; output
1926
1927 (while temp-undo-list
1928 (setq undo-elt (car temp-undo-list))
1929 (cond ((integerp undo-elt)
1930 (if (>= undo-elt position)
1931 (setcar temp-undo-list (- undo-elt offset))))
1932 ((atom undo-elt) nil)
1933 ((stringp (car undo-elt))
1934 ;; (TEXT . POSITION)
1935 (let ((text-pos (abs (cdr undo-elt)))
1936 (point-at-end (< (cdr undo-elt) 0 )))
1937 (if (>= text-pos position)
1938 (setcdr undo-elt (* (if point-at-end -1 1)
1939 (- text-pos offset))))))
1940 ((integerp (car undo-elt))
1941 ;; (BEGIN . END)
1942 (when (>= (car undo-elt) position)
1943 (setcar undo-elt (- (car undo-elt) offset))
1944 (setcdr undo-elt (- (cdr undo-elt) offset))))
1945 ((null (car undo-elt))
1946 ;; (nil PROPERTY VALUE BEG . END)
1947 (let ((tail (nthcdr 3 undo-elt)))
1948 (when (>= (car tail) position)
1949 (setcar tail (- (car tail) offset))
1950 (setcdr tail (- (cdr tail) offset))))))
1951 (setq temp-undo-list (cdr temp-undo-list))))))))
1952 (setq undo-list-copy (cdr undo-list-copy)))
1953 (nreverse undo-list)))
1954
1955 (defun undo-elt-in-region (undo-elt start end)
1956 "Determine whether UNDO-ELT falls inside the region START ... END.
1957 If it crosses the edge, we return nil."
1958 (cond ((integerp undo-elt)
1959 (and (>= undo-elt start)
1960 (<= undo-elt end)))
1961 ((eq undo-elt nil)
1962 t)
1963 ((atom undo-elt)
1964 nil)
1965 ((stringp (car undo-elt))
1966 ;; (TEXT . POSITION)
1967 (and (>= (abs (cdr undo-elt)) start)
1968 (< (abs (cdr undo-elt)) end)))
1969 ((and (consp undo-elt) (markerp (car undo-elt)))
1970 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1971 ;; See if MARKER is inside the region.
1972 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1973 (unless alist-elt
1974 (setq alist-elt (cons (car undo-elt)
1975 (marker-position (car undo-elt))))
1976 (setq undo-adjusted-markers
1977 (cons alist-elt undo-adjusted-markers)))
1978 (and (cdr alist-elt)
1979 (>= (cdr alist-elt) start)
1980 (<= (cdr alist-elt) end))))
1981 ((null (car undo-elt))
1982 ;; (nil PROPERTY VALUE BEG . END)
1983 (let ((tail (nthcdr 3 undo-elt)))
1984 (and (>= (car tail) start)
1985 (<= (cdr tail) end))))
1986 ((integerp (car undo-elt))
1987 ;; (BEGIN . END)
1988 (and (>= (car undo-elt) start)
1989 (<= (cdr undo-elt) end)))))
1990
1991 (defun undo-elt-crosses-region (undo-elt start end)
1992 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1993 This assumes we have already decided that UNDO-ELT
1994 is not *inside* the region START...END."
1995 (cond ((atom undo-elt) nil)
1996 ((null (car undo-elt))
1997 ;; (nil PROPERTY VALUE BEG . END)
1998 (let ((tail (nthcdr 3 undo-elt)))
1999 (and (< (car tail) end)
2000 (> (cdr tail) start))))
2001 ((integerp (car undo-elt))
2002 ;; (BEGIN . END)
2003 (and (< (car undo-elt) end)
2004 (> (cdr undo-elt) start)))))
2005
2006 ;; Return the first affected buffer position and the delta for an undo element
2007 ;; delta is defined as the change in subsequent buffer positions if we *did*
2008 ;; the undo.
2009 (defun undo-delta (undo-elt)
2010 (if (consp undo-elt)
2011 (cond ((stringp (car undo-elt))
2012 ;; (TEXT . POSITION)
2013 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
2014 ((integerp (car undo-elt))
2015 ;; (BEGIN . END)
2016 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
2017 (t
2018 '(0 . 0)))
2019 '(0 . 0)))
2020
2021 (defcustom undo-ask-before-discard nil
2022 "If non-nil ask about discarding undo info for the current command.
2023 Normally, Emacs discards the undo info for the current command if
2024 it exceeds `undo-outer-limit'. But if you set this option
2025 non-nil, it asks in the echo area whether to discard the info.
2026 If you answer no, there is a slight risk that Emacs might crash, so
2027 only do it if you really want to undo the command.
2028
2029 This option is mainly intended for debugging. You have to be
2030 careful if you use it for other purposes. Garbage collection is
2031 inhibited while the question is asked, meaning that Emacs might
2032 leak memory. So you should make sure that you do not wait
2033 excessively long before answering the question."
2034 :type 'boolean
2035 :group 'undo
2036 :version "22.1")
2037
2038 (defvar undo-extra-outer-limit nil
2039 "If non-nil, an extra level of size that's ok in an undo item.
2040 We don't ask the user about truncating the undo list until the
2041 current item gets bigger than this amount.
2042
2043 This variable only matters if `undo-ask-before-discard' is non-nil.")
2044 (make-variable-buffer-local 'undo-extra-outer-limit)
2045
2046 ;; When the first undo batch in an undo list is longer than
2047 ;; undo-outer-limit, this function gets called to warn the user that
2048 ;; the undo info for the current command was discarded. Garbage
2049 ;; collection is inhibited around the call, so it had better not do a
2050 ;; lot of consing.
2051 (setq undo-outer-limit-function 'undo-outer-limit-truncate)
2052 (defun undo-outer-limit-truncate (size)
2053 (if undo-ask-before-discard
2054 (when (or (null undo-extra-outer-limit)
2055 (> size undo-extra-outer-limit))
2056 ;; Don't ask the question again unless it gets even bigger.
2057 ;; This applies, in particular, if the user quits from the question.
2058 ;; Such a quit quits out of GC, but something else will call GC
2059 ;; again momentarily. It will call this function again,
2060 ;; but we don't want to ask the question again.
2061 (setq undo-extra-outer-limit (+ size 50000))
2062 (if (let (use-dialog-box track-mouse executing-kbd-macro )
2063 (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? "
2064 (buffer-name) size)))
2065 (progn (setq buffer-undo-list nil)
2066 (setq undo-extra-outer-limit nil)
2067 t)
2068 nil))
2069 (display-warning '(undo discard-info)
2070 (concat
2071 (format "Buffer `%s' undo info was %d bytes long.\n"
2072 (buffer-name) size)
2073 "The undo info was discarded because it exceeded \
2074 `undo-outer-limit'.
2075
2076 This is normal if you executed a command that made a huge change
2077 to the buffer. In that case, to prevent similar problems in the
2078 future, set `undo-outer-limit' to a value that is large enough to
2079 cover the maximum size of normal changes you expect a single
2080 command to make, but not so large that it might exceed the
2081 maximum memory allotted to Emacs.
2082
2083 If you did not execute any such command, the situation is
2084 probably due to a bug and you should report it.
2085
2086 You can disable the popping up of this buffer by adding the entry
2087 \(undo discard-info) to the user option `warning-suppress-types',
2088 which is defined in the `warnings' library.\n")
2089 :warning)
2090 (setq buffer-undo-list nil)
2091 t))
2092 \f
2093 (defvar shell-command-history nil
2094 "History list for some commands that read shell commands.
2095
2096 Maximum length of the history list is determined by the value
2097 of `history-length', which see.")
2098
2099 (defvar shell-command-switch (purecopy "-c")
2100 "Switch used to have the shell execute its command line argument.")
2101
2102 (defvar shell-command-default-error-buffer nil
2103 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2104 This buffer is used when `shell-command' or `shell-command-on-region'
2105 is run interactively. A value of nil means that output to stderr and
2106 stdout will be intermixed in the output stream.")
2107
2108 (declare-function mailcap-file-default-commands "mailcap" (files))
2109 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
2110
2111 (defun minibuffer-default-add-shell-commands ()
2112 "Return a list of all commands associated with the current file.
2113 This function is used to add all related commands retrieved by `mailcap'
2114 to the end of the list of defaults just after the default value."
2115 (interactive)
2116 (let* ((filename (if (listp minibuffer-default)
2117 (car minibuffer-default)
2118 minibuffer-default))
2119 (commands (and filename (require 'mailcap nil t)
2120 (mailcap-file-default-commands (list filename)))))
2121 (setq commands (mapcar (lambda (command)
2122 (concat command " " filename))
2123 commands))
2124 (if (listp minibuffer-default)
2125 (append minibuffer-default commands)
2126 (cons minibuffer-default commands))))
2127
2128 (defvar shell-delimiter-argument-list)
2129 (defvar shell-file-name-chars)
2130 (defvar shell-file-name-quote-list)
2131
2132 (defun minibuffer-complete-shell-command ()
2133 "Dynamically complete shell command at point."
2134 (interactive)
2135 (require 'shell)
2136 (let ((comint-delimiter-argument-list shell-delimiter-argument-list)
2137 (comint-file-name-chars shell-file-name-chars)
2138 (comint-file-name-quote-list shell-file-name-quote-list))
2139 (run-hook-with-args-until-success 'shell-dynamic-complete-functions)))
2140
2141 (defvar minibuffer-local-shell-command-map
2142 (let ((map (make-sparse-keymap)))
2143 (set-keymap-parent map minibuffer-local-map)
2144 (define-key map "\t" 'minibuffer-complete-shell-command)
2145 map)
2146 "Keymap used for completing shell commands in minibuffer.")
2147
2148 (defun read-shell-command (prompt &optional initial-contents hist &rest args)
2149 "Read a shell command from the minibuffer.
2150 The arguments are the same as the ones of `read-from-minibuffer',
2151 except READ and KEYMAP are missing and HIST defaults
2152 to `shell-command-history'."
2153 (minibuffer-with-setup-hook
2154 (lambda ()
2155 (set (make-local-variable 'minibuffer-default-add-function)
2156 'minibuffer-default-add-shell-commands))
2157 (apply 'read-from-minibuffer prompt initial-contents
2158 minibuffer-local-shell-command-map
2159 nil
2160 (or hist 'shell-command-history)
2161 args)))
2162
2163 (defun async-shell-command (command &optional output-buffer error-buffer)
2164 "Execute string COMMAND asynchronously in background.
2165
2166 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2167 surrounded by whitespace and executes the command asynchronously.
2168 The output appears in the buffer `*Async Shell Command*'.
2169
2170 In Elisp, you will often be better served by calling `start-process'
2171 directly, since it offers more control and does not impose the use of a
2172 shell (with its need to quote arguments)."
2173 (interactive
2174 (list
2175 (read-shell-command "Async shell command: " nil nil
2176 (and buffer-file-name
2177 (file-relative-name buffer-file-name)))
2178 current-prefix-arg
2179 shell-command-default-error-buffer))
2180 (unless (string-match "&[ \t]*\\'" command)
2181 (setq command (concat command " &")))
2182 (shell-command command output-buffer error-buffer))
2183
2184 (defun shell-command (command &optional output-buffer error-buffer)
2185 "Execute string COMMAND in inferior shell; display output, if any.
2186 With prefix argument, insert the COMMAND's output at point.
2187
2188 If COMMAND ends in ampersand, execute it asynchronously.
2189 The output appears in the buffer `*Async Shell Command*'.
2190 That buffer is in shell mode.
2191
2192 Otherwise, COMMAND is executed synchronously. The output appears in
2193 the buffer `*Shell Command Output*'. If the output is short enough to
2194 display in the echo area (which is determined by the variables
2195 `resize-mini-windows' and `max-mini-window-height'), it is shown
2196 there, but it is nonetheless available in buffer `*Shell Command
2197 Output*' even though that buffer is not automatically displayed.
2198
2199 To specify a coding system for converting non-ASCII characters
2200 in the shell command output, use \\[universal-coding-system-argument] \
2201 before this command.
2202
2203 Noninteractive callers can specify coding systems by binding
2204 `coding-system-for-read' and `coding-system-for-write'.
2205
2206 The optional second argument OUTPUT-BUFFER, if non-nil,
2207 says to put the output in some other buffer.
2208 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2209 If OUTPUT-BUFFER is not a buffer and not nil,
2210 insert output in current buffer. (This cannot be done asynchronously.)
2211 In either case, the buffer is first erased, and the output is
2212 inserted after point (leaving mark after it).
2213
2214 If the command terminates without error, but generates output,
2215 and you did not specify \"insert it in the current buffer\",
2216 the output can be displayed in the echo area or in its buffer.
2217 If the output is short enough to display in the echo area
2218 \(determined by the variable `max-mini-window-height' if
2219 `resize-mini-windows' is non-nil), it is shown there.
2220 Otherwise,the buffer containing the output is displayed.
2221
2222 If there is output and an error, and you did not specify \"insert it
2223 in the current buffer\", a message about the error goes at the end
2224 of the output.
2225
2226 If there is no output, or if output is inserted in the current buffer,
2227 then `*Shell Command Output*' is deleted.
2228
2229 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2230 or buffer name to which to direct the command's standard error output.
2231 If it is nil, error output is mingled with regular output.
2232 In an interactive call, the variable `shell-command-default-error-buffer'
2233 specifies the value of ERROR-BUFFER.
2234
2235 In Elisp, you will often be better served by calling `call-process' or
2236 `start-process' directly, since it offers more control and does not impose
2237 the use of a shell (with its need to quote arguments)."
2238
2239 (interactive
2240 (list
2241 (read-shell-command "Shell command: " nil nil
2242 (let ((filename
2243 (cond
2244 (buffer-file-name)
2245 ((eq major-mode 'dired-mode)
2246 (dired-get-filename nil t)))))
2247 (and filename (file-relative-name filename))))
2248 current-prefix-arg
2249 shell-command-default-error-buffer))
2250 ;; Look for a handler in case default-directory is a remote file name.
2251 (let ((handler
2252 (find-file-name-handler (directory-file-name default-directory)
2253 'shell-command)))
2254 (if handler
2255 (funcall handler 'shell-command command output-buffer error-buffer)
2256 (if (and output-buffer
2257 (not (or (bufferp output-buffer) (stringp output-buffer))))
2258 ;; Output goes in current buffer.
2259 (let ((error-file
2260 (if error-buffer
2261 (make-temp-file
2262 (expand-file-name "scor"
2263 (or small-temporary-file-directory
2264 temporary-file-directory)))
2265 nil)))
2266 (barf-if-buffer-read-only)
2267 (push-mark nil t)
2268 ;; We do not use -f for csh; we will not support broken use of
2269 ;; .cshrcs. Even the BSD csh manual says to use
2270 ;; "if ($?prompt) exit" before things which are not useful
2271 ;; non-interactively. Besides, if someone wants their other
2272 ;; aliases for shell commands then they can still have them.
2273 (call-process shell-file-name nil
2274 (if error-file
2275 (list t error-file)
2276 t)
2277 nil shell-command-switch command)
2278 (when (and error-file (file-exists-p error-file))
2279 (if (< 0 (nth 7 (file-attributes error-file)))
2280 (with-current-buffer (get-buffer-create error-buffer)
2281 (let ((pos-from-end (- (point-max) (point))))
2282 (or (bobp)
2283 (insert "\f\n"))
2284 ;; Do no formatting while reading error file,
2285 ;; because that can run a shell command, and we
2286 ;; don't want that to cause an infinite recursion.
2287 (format-insert-file error-file nil)
2288 ;; Put point after the inserted errors.
2289 (goto-char (- (point-max) pos-from-end)))
2290 (display-buffer (current-buffer))))
2291 (delete-file error-file))
2292 ;; This is like exchange-point-and-mark, but doesn't
2293 ;; activate the mark. It is cleaner to avoid activation,
2294 ;; even though the command loop would deactivate the mark
2295 ;; because we inserted text.
2296 (goto-char (prog1 (mark t)
2297 (set-marker (mark-marker) (point)
2298 (current-buffer)))))
2299 ;; Output goes in a separate buffer.
2300 ;; Preserve the match data in case called from a program.
2301 (save-match-data
2302 (if (string-match "[ \t]*&[ \t]*\\'" command)
2303 ;; Command ending with ampersand means asynchronous.
2304 (let ((buffer (get-buffer-create
2305 (or output-buffer "*Async Shell Command*")))
2306 (directory default-directory)
2307 proc)
2308 ;; Remove the ampersand.
2309 (setq command (substring command 0 (match-beginning 0)))
2310 ;; If will kill a process, query first.
2311 (setq proc (get-buffer-process buffer))
2312 (if proc
2313 (if (yes-or-no-p "A command is running. Kill it? ")
2314 (kill-process proc)
2315 (error "Shell command in progress")))
2316 (with-current-buffer buffer
2317 (setq buffer-read-only nil)
2318 (erase-buffer)
2319 (display-buffer buffer)
2320 (setq default-directory directory)
2321 (setq proc (start-process "Shell" buffer shell-file-name
2322 shell-command-switch command))
2323 (setq mode-line-process '(":%s"))
2324 (require 'shell) (shell-mode)
2325 (set-process-sentinel proc 'shell-command-sentinel)
2326 ;; Use the comint filter for proper handling of carriage motion
2327 ;; (see `comint-inhibit-carriage-motion'),.
2328 (set-process-filter proc 'comint-output-filter)
2329 ))
2330 ;; Otherwise, command is executed synchronously.
2331 (shell-command-on-region (point) (point) command
2332 output-buffer nil error-buffer)))))))
2333
2334 (defun display-message-or-buffer (message
2335 &optional buffer-name not-this-window frame)
2336 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2337 MESSAGE may be either a string or a buffer.
2338
2339 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2340 the maximum height of the echo area, as defined by `max-mini-window-height'
2341 if `resize-mini-windows' is non-nil.
2342
2343 Returns either the string shown in the echo area, or when a pop-up
2344 buffer is used, the window used to display it.
2345
2346 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2347 name of the buffer used to display it in the case where a pop-up buffer
2348 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2349 string and it is displayed in the echo area, it is not specified whether
2350 the contents are inserted into the buffer anyway.
2351
2352 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2353 and only used if a buffer is displayed."
2354 (cond ((and (stringp message) (not (string-match "\n" message)))
2355 ;; Trivial case where we can use the echo area
2356 (message "%s" message))
2357 ((and (stringp message)
2358 (= (string-match "\n" message) (1- (length message))))
2359 ;; Trivial case where we can just remove single trailing newline
2360 (message "%s" (substring message 0 (1- (length message)))))
2361 (t
2362 ;; General case
2363 (with-current-buffer
2364 (if (bufferp message)
2365 message
2366 (get-buffer-create (or buffer-name "*Message*")))
2367
2368 (unless (bufferp message)
2369 (erase-buffer)
2370 (insert message))
2371
2372 (let ((lines
2373 (if (= (buffer-size) 0)
2374 0
2375 (count-screen-lines nil nil nil (minibuffer-window)))))
2376 (cond ((= lines 0))
2377 ((and (or (<= lines 1)
2378 (<= lines
2379 (if resize-mini-windows
2380 (cond ((floatp max-mini-window-height)
2381 (* (frame-height)
2382 max-mini-window-height))
2383 ((integerp max-mini-window-height)
2384 max-mini-window-height)
2385 (t
2386 1))
2387 1)))
2388 ;; Don't use the echo area if the output buffer is
2389 ;; already dispayed in the selected frame.
2390 (not (get-buffer-window (current-buffer))))
2391 ;; Echo area
2392 (goto-char (point-max))
2393 (when (bolp)
2394 (backward-char 1))
2395 (message "%s" (buffer-substring (point-min) (point))))
2396 (t
2397 ;; Buffer
2398 (goto-char (point-min))
2399 (display-buffer (current-buffer)
2400 not-this-window frame))))))))
2401
2402
2403 ;; We have a sentinel to prevent insertion of a termination message
2404 ;; in the buffer itself.
2405 (defun shell-command-sentinel (process signal)
2406 (if (memq (process-status process) '(exit signal))
2407 (message "%s: %s."
2408 (car (cdr (cdr (process-command process))))
2409 (substring signal 0 -1))))
2410
2411 (defun shell-command-on-region (start end command
2412 &optional output-buffer replace
2413 error-buffer display-error-buffer)
2414 "Execute string COMMAND in inferior shell with region as input.
2415 Normally display output (if any) in temp buffer `*Shell Command Output*';
2416 Prefix arg means replace the region with it. Return the exit code of
2417 COMMAND.
2418
2419 To specify a coding system for converting non-ASCII characters
2420 in the input and output to the shell command, use \\[universal-coding-system-argument]
2421 before this command. By default, the input (from the current buffer)
2422 is encoded in the same coding system that will be used to save the file,
2423 `buffer-file-coding-system'. If the output is going to replace the region,
2424 then it is decoded from that same coding system.
2425
2426 The noninteractive arguments are START, END, COMMAND,
2427 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2428 Noninteractive callers can specify coding systems by binding
2429 `coding-system-for-read' and `coding-system-for-write'.
2430
2431 If the command generates output, the output may be displayed
2432 in the echo area or in a buffer.
2433 If the output is short enough to display in the echo area
2434 \(determined by the variable `max-mini-window-height' if
2435 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2436 it is displayed in the buffer `*Shell Command Output*'. The output
2437 is available in that buffer in both cases.
2438
2439 If there is output and an error, a message about the error
2440 appears at the end of the output.
2441
2442 If there is no output, or if output is inserted in the current buffer,
2443 then `*Shell Command Output*' is deleted.
2444
2445 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2446 that says to put the output in some other buffer.
2447 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2448 If OUTPUT-BUFFER is not a buffer and not nil,
2449 insert output in the current buffer.
2450 In either case, the output is inserted after point (leaving mark after it).
2451
2452 If REPLACE, the optional fifth argument, is non-nil, that means insert
2453 the output in place of text from START to END, putting point and mark
2454 around it.
2455
2456 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2457 or buffer name to which to direct the command's standard error output.
2458 If it is nil, error output is mingled with regular output.
2459 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2460 were any errors. (This is always t, interactively.)
2461 In an interactive call, the variable `shell-command-default-error-buffer'
2462 specifies the value of ERROR-BUFFER."
2463 (interactive (let (string)
2464 (unless (mark)
2465 (error "The mark is not set now, so there is no region"))
2466 ;; Do this before calling region-beginning
2467 ;; and region-end, in case subprocess output
2468 ;; relocates them while we are in the minibuffer.
2469 (setq string (read-shell-command "Shell command on region: "))
2470 ;; call-interactively recognizes region-beginning and
2471 ;; region-end specially, leaving them in the history.
2472 (list (region-beginning) (region-end)
2473 string
2474 current-prefix-arg
2475 current-prefix-arg
2476 shell-command-default-error-buffer
2477 t)))
2478 (let ((error-file
2479 (if error-buffer
2480 (make-temp-file
2481 (expand-file-name "scor"
2482 (or small-temporary-file-directory
2483 temporary-file-directory)))
2484 nil))
2485 exit-status)
2486 (if (or replace
2487 (and output-buffer
2488 (not (or (bufferp output-buffer) (stringp output-buffer)))))
2489 ;; Replace specified region with output from command.
2490 (let ((swap (and replace (< start end))))
2491 ;; Don't muck with mark unless REPLACE says we should.
2492 (goto-char start)
2493 (and replace (push-mark (point) 'nomsg))
2494 (setq exit-status
2495 (call-process-region start end shell-file-name t
2496 (if error-file
2497 (list t error-file)
2498 t)
2499 nil shell-command-switch command))
2500 ;; It is rude to delete a buffer which the command is not using.
2501 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2502 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2503 ;; (kill-buffer shell-buffer)))
2504 ;; Don't muck with mark unless REPLACE says we should.
2505 (and replace swap (exchange-point-and-mark)))
2506 ;; No prefix argument: put the output in a temp buffer,
2507 ;; replacing its entire contents.
2508 (let ((buffer (get-buffer-create
2509 (or output-buffer "*Shell Command Output*"))))
2510 (unwind-protect
2511 (if (eq buffer (current-buffer))
2512 ;; If the input is the same buffer as the output,
2513 ;; delete everything but the specified region,
2514 ;; then replace that region with the output.
2515 (progn (setq buffer-read-only nil)
2516 (delete-region (max start end) (point-max))
2517 (delete-region (point-min) (min start end))
2518 (setq exit-status
2519 (call-process-region (point-min) (point-max)
2520 shell-file-name t
2521 (if error-file
2522 (list t error-file)
2523 t)
2524 nil shell-command-switch
2525 command)))
2526 ;; Clear the output buffer, then run the command with
2527 ;; output there.
2528 (let ((directory default-directory))
2529 (with-current-buffer buffer
2530 (setq buffer-read-only nil)
2531 (if (not output-buffer)
2532 (setq default-directory directory))
2533 (erase-buffer)))
2534 (setq exit-status
2535 (call-process-region start end shell-file-name nil
2536 (if error-file
2537 (list buffer error-file)
2538 buffer)
2539 nil shell-command-switch command)))
2540 ;; Report the output.
2541 (with-current-buffer buffer
2542 (setq mode-line-process
2543 (cond ((null exit-status)
2544 " - Error")
2545 ((stringp exit-status)
2546 (format " - Signal [%s]" exit-status))
2547 ((not (equal 0 exit-status))
2548 (format " - Exit [%d]" exit-status)))))
2549 (if (with-current-buffer buffer (> (point-max) (point-min)))
2550 ;; There's some output, display it
2551 (display-message-or-buffer buffer)
2552 ;; No output; error?
2553 (let ((output
2554 (if (and error-file
2555 (< 0 (nth 7 (file-attributes error-file))))
2556 "some error output"
2557 "no output")))
2558 (cond ((null exit-status)
2559 (message "(Shell command failed with error)"))
2560 ((equal 0 exit-status)
2561 (message "(Shell command succeeded with %s)"
2562 output))
2563 ((stringp exit-status)
2564 (message "(Shell command killed by signal %s)"
2565 exit-status))
2566 (t
2567 (message "(Shell command failed with code %d and %s)"
2568 exit-status output))))
2569 ;; Don't kill: there might be useful info in the undo-log.
2570 ;; (kill-buffer buffer)
2571 ))))
2572
2573 (when (and error-file (file-exists-p error-file))
2574 (if (< 0 (nth 7 (file-attributes error-file)))
2575 (with-current-buffer (get-buffer-create error-buffer)
2576 (let ((pos-from-end (- (point-max) (point))))
2577 (or (bobp)
2578 (insert "\f\n"))
2579 ;; Do no formatting while reading error file,
2580 ;; because that can run a shell command, and we
2581 ;; don't want that to cause an infinite recursion.
2582 (format-insert-file error-file nil)
2583 ;; Put point after the inserted errors.
2584 (goto-char (- (point-max) pos-from-end)))
2585 (and display-error-buffer
2586 (display-buffer (current-buffer)))))
2587 (delete-file error-file))
2588 exit-status))
2589
2590 (defun shell-command-to-string (command)
2591 "Execute shell command COMMAND and return its output as a string."
2592 (with-output-to-string
2593 (with-current-buffer
2594 standard-output
2595 (call-process shell-file-name nil t nil shell-command-switch command))))
2596
2597 (defun process-file (program &optional infile buffer display &rest args)
2598 "Process files synchronously in a separate process.
2599 Similar to `call-process', but may invoke a file handler based on
2600 `default-directory'. The current working directory of the
2601 subprocess is `default-directory'.
2602
2603 File names in INFILE and BUFFER are handled normally, but file
2604 names in ARGS should be relative to `default-directory', as they
2605 are passed to the process verbatim. \(This is a difference to
2606 `call-process' which does not support file handlers for INFILE
2607 and BUFFER.\)
2608
2609 Some file handlers might not support all variants, for example
2610 they might behave as if DISPLAY was nil, regardless of the actual
2611 value passed."
2612 (let ((fh (find-file-name-handler default-directory 'process-file))
2613 lc stderr-file)
2614 (unwind-protect
2615 (if fh (apply fh 'process-file program infile buffer display args)
2616 (when infile (setq lc (file-local-copy infile)))
2617 (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer)))
2618 (make-temp-file "emacs")))
2619 (prog1
2620 (apply 'call-process program
2621 (or lc infile)
2622 (if stderr-file (list (car buffer) stderr-file) buffer)
2623 display args)
2624 (when stderr-file (copy-file stderr-file (cadr buffer)))))
2625 (when stderr-file (delete-file stderr-file))
2626 (when lc (delete-file lc)))))
2627
2628 (defvar process-file-side-effects t
2629 "Whether a call of `process-file' changes remote files.
2630
2631 Per default, this variable is always set to `t', meaning that a
2632 call of `process-file' could potentially change any file on a
2633 remote host. When set to `nil', a file handler could optimize
2634 its behaviour with respect to remote file attributes caching.
2635
2636 This variable should never be changed by `setq'. Instead of, it
2637 shall be set only by let-binding.")
2638
2639 (defun start-file-process (name buffer program &rest program-args)
2640 "Start a program in a subprocess. Return the process object for it.
2641
2642 Similar to `start-process', but may invoke a file handler based on
2643 `default-directory'. See Info node `(elisp)Magic File Names'.
2644
2645 This handler ought to run PROGRAM, perhaps on the local host,
2646 perhaps on a remote host that corresponds to `default-directory'.
2647 In the latter case, the local part of `default-directory' becomes
2648 the working directory of the process.
2649
2650 PROGRAM and PROGRAM-ARGS might be file names. They are not
2651 objects of file handler invocation. File handlers might not
2652 support pty association, if PROGRAM is nil."
2653 (let ((fh (find-file-name-handler default-directory 'start-file-process)))
2654 (if fh (apply fh 'start-file-process name buffer program program-args)
2655 (apply 'start-process name buffer program program-args))))
2656
2657 \f
2658 (defvar universal-argument-map
2659 (let ((map (make-sparse-keymap)))
2660 (define-key map [t] 'universal-argument-other-key)
2661 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2662 (define-key map [switch-frame] nil)
2663 (define-key map [?\C-u] 'universal-argument-more)
2664 (define-key map [?-] 'universal-argument-minus)
2665 (define-key map [?0] 'digit-argument)
2666 (define-key map [?1] 'digit-argument)
2667 (define-key map [?2] 'digit-argument)
2668 (define-key map [?3] 'digit-argument)
2669 (define-key map [?4] 'digit-argument)
2670 (define-key map [?5] 'digit-argument)
2671 (define-key map [?6] 'digit-argument)
2672 (define-key map [?7] 'digit-argument)
2673 (define-key map [?8] 'digit-argument)
2674 (define-key map [?9] 'digit-argument)
2675 (define-key map [kp-0] 'digit-argument)
2676 (define-key map [kp-1] 'digit-argument)
2677 (define-key map [kp-2] 'digit-argument)
2678 (define-key map [kp-3] 'digit-argument)
2679 (define-key map [kp-4] 'digit-argument)
2680 (define-key map [kp-5] 'digit-argument)
2681 (define-key map [kp-6] 'digit-argument)
2682 (define-key map [kp-7] 'digit-argument)
2683 (define-key map [kp-8] 'digit-argument)
2684 (define-key map [kp-9] 'digit-argument)
2685 (define-key map [kp-subtract] 'universal-argument-minus)
2686 map)
2687 "Keymap used while processing \\[universal-argument].")
2688
2689 (defvar universal-argument-num-events nil
2690 "Number of argument-specifying events read by `universal-argument'.
2691 `universal-argument-other-key' uses this to discard those events
2692 from (this-command-keys), and reread only the final command.")
2693
2694 (defvar overriding-map-is-bound nil
2695 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2696
2697 (defvar saved-overriding-map nil
2698 "The saved value of `overriding-terminal-local-map'.
2699 That variable gets restored to this value on exiting \"universal
2700 argument mode\".")
2701
2702 (defun ensure-overriding-map-is-bound ()
2703 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2704 (unless overriding-map-is-bound
2705 (setq saved-overriding-map overriding-terminal-local-map)
2706 (setq overriding-terminal-local-map universal-argument-map)
2707 (setq overriding-map-is-bound t)))
2708
2709 (defun restore-overriding-map ()
2710 "Restore `overriding-terminal-local-map' to its saved value."
2711 (setq overriding-terminal-local-map saved-overriding-map)
2712 (setq overriding-map-is-bound nil))
2713
2714 (defun universal-argument ()
2715 "Begin a numeric argument for the following command.
2716 Digits or minus sign following \\[universal-argument] make up the numeric argument.
2717 \\[universal-argument] following the digits or minus sign ends the argument.
2718 \\[universal-argument] without digits or minus sign provides 4 as argument.
2719 Repeating \\[universal-argument] without digits or minus sign
2720 multiplies the argument by 4 each time.
2721 For some commands, just \\[universal-argument] by itself serves as a flag
2722 which is different in effect from any particular numeric argument.
2723 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
2724 (interactive)
2725 (setq prefix-arg (list 4))
2726 (setq universal-argument-num-events (length (this-command-keys)))
2727 (ensure-overriding-map-is-bound))
2728
2729 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2730 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2731 (defun universal-argument-more (arg)
2732 (interactive "P")
2733 (if (consp arg)
2734 (setq prefix-arg (list (* 4 (car arg))))
2735 (if (eq arg '-)
2736 (setq prefix-arg (list -4))
2737 (setq prefix-arg arg)
2738 (restore-overriding-map)))
2739 (setq universal-argument-num-events (length (this-command-keys))))
2740
2741 (defun negative-argument (arg)
2742 "Begin a negative numeric argument for the next command.
2743 \\[universal-argument] following digits or minus sign ends the argument."
2744 (interactive "P")
2745 (cond ((integerp arg)
2746 (setq prefix-arg (- arg)))
2747 ((eq arg '-)
2748 (setq prefix-arg nil))
2749 (t
2750 (setq prefix-arg '-)))
2751 (setq universal-argument-num-events (length (this-command-keys)))
2752 (ensure-overriding-map-is-bound))
2753
2754 (defun digit-argument (arg)
2755 "Part of the numeric argument for the next command.
2756 \\[universal-argument] following digits or minus sign ends the argument."
2757 (interactive "P")
2758 (let* ((char (if (integerp last-command-event)
2759 last-command-event
2760 (get last-command-event 'ascii-character)))
2761 (digit (- (logand char ?\177) ?0)))
2762 (cond ((integerp arg)
2763 (setq prefix-arg (+ (* arg 10)
2764 (if (< arg 0) (- digit) digit))))
2765 ((eq arg '-)
2766 ;; Treat -0 as just -, so that -01 will work.
2767 (setq prefix-arg (if (zerop digit) '- (- digit))))
2768 (t
2769 (setq prefix-arg digit))))
2770 (setq universal-argument-num-events (length (this-command-keys)))
2771 (ensure-overriding-map-is-bound))
2772
2773 ;; For backward compatibility, minus with no modifiers is an ordinary
2774 ;; command if digits have already been entered.
2775 (defun universal-argument-minus (arg)
2776 (interactive "P")
2777 (if (integerp arg)
2778 (universal-argument-other-key arg)
2779 (negative-argument arg)))
2780
2781 ;; Anything else terminates the argument and is left in the queue to be
2782 ;; executed as a command.
2783 (defun universal-argument-other-key (arg)
2784 (interactive "P")
2785 (setq prefix-arg arg)
2786 (let* ((key (this-command-keys))
2787 (keylist (listify-key-sequence key)))
2788 (setq unread-command-events
2789 (append (nthcdr universal-argument-num-events keylist)
2790 unread-command-events)))
2791 (reset-this-command-lengths)
2792 (restore-overriding-map))
2793 \f
2794 ;; This function is here rather than in subr.el because it uses CL.
2795 (defmacro with-wrapper-hook (var args &rest body)
2796 "Run BODY wrapped with the VAR hook.
2797 VAR is a special hook: its functions are called with a first argument
2798 which is the \"original\" code (the BODY), so the hook function can wrap
2799 the original function, or call it any number of times (including not calling
2800 it at all). This is similar to an `around' advice.
2801 VAR is normally a symbol (a variable) in which case it is treated like
2802 a hook, with a buffer-local and a global part. But it can also be an
2803 arbitrary expression.
2804 ARGS is a list of variables which will be passed as additional arguments
2805 to each function, after the initial argument, and which the first argument
2806 expects to receive when called."
2807 (declare (indent 2) (debug t))
2808 ;; We need those two gensyms because CL's lexical scoping is not available
2809 ;; for function arguments :-(
2810 (let ((funs (make-symbol "funs"))
2811 (global (make-symbol "global"))
2812 (argssym (make-symbol "args")))
2813 ;; Since the hook is a wrapper, the loop has to be done via
2814 ;; recursion: a given hook function will call its parameter in order to
2815 ;; continue looping.
2816 `(labels ((runrestofhook (,funs ,global ,argssym)
2817 ;; `funs' holds the functions left on the hook and `global'
2818 ;; holds the functions left on the global part of the hook
2819 ;; (in case the hook is local).
2820 (lexical-let ((funs ,funs)
2821 (global ,global))
2822 (if (consp funs)
2823 (if (eq t (car funs))
2824 (runrestofhook
2825 (append global (cdr funs)) nil ,argssym)
2826 (apply (car funs)
2827 (lambda (&rest ,argssym)
2828 (runrestofhook (cdr funs) global ,argssym))
2829 ,argssym))
2830 ;; Once there are no more functions on the hook, run
2831 ;; the original body.
2832 (apply (lambda ,args ,@body) ,argssym)))))
2833 (runrestofhook ,var
2834 ;; The global part of the hook, if any.
2835 ,(if (symbolp var)
2836 `(if (local-variable-p ',var)
2837 (default-value ',var)))
2838 (list ,@args)))))
2839
2840 (defvar filter-buffer-substring-functions nil
2841 "Wrapper hook around `filter-buffer-substring'.
2842 The functions on this special hook are called with 4 arguments:
2843 NEXT-FUN BEG END DELETE
2844 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2845 that performs the default operation. The other 3 arguments are like
2846 the ones passed to `filter-buffer-substring'.")
2847
2848 (defvar buffer-substring-filters nil
2849 "List of filter functions for `filter-buffer-substring'.
2850 Each function must accept a single argument, a string, and return
2851 a string. The buffer substring is passed to the first function
2852 in the list, and the return value of each function is passed to
2853 the next. The return value of the last function is used as the
2854 return value of `filter-buffer-substring'.
2855
2856 If this variable is nil, no filtering is performed.")
2857 (make-obsolete-variable 'buffer-substring-filters
2858 'filter-buffer-substring-functions "24.1")
2859
2860 (defun filter-buffer-substring (beg end &optional delete)
2861 "Return the buffer substring between BEG and END, after filtering.
2862 The filtering is performed by `filter-buffer-substring-functions'.
2863
2864 If DELETE is non-nil, the text between BEG and END is deleted
2865 from the buffer.
2866
2867 This function should be used instead of `buffer-substring',
2868 `buffer-substring-no-properties', or `delete-and-extract-region'
2869 when you want to allow filtering to take place. For example,
2870 major or minor modes can use `filter-buffer-substring-functions' to
2871 extract characters that are special to a buffer, and should not
2872 be copied into other buffers."
2873 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2874 (cond
2875 ((or delete buffer-substring-filters)
2876 (save-excursion
2877 (goto-char beg)
2878 (let ((string (if delete (delete-and-extract-region beg end)
2879 (buffer-substring beg end))))
2880 (dolist (filter buffer-substring-filters)
2881 (setq string (funcall filter string)))
2882 string)))
2883 (t
2884 (buffer-substring beg end)))))
2885
2886
2887 ;;;; Window system cut and paste hooks.
2888
2889 (defvar interprogram-cut-function nil
2890 "Function to call to make a killed region available to other programs.
2891
2892 Most window systems provide some sort of facility for cutting and
2893 pasting text between the windows of different programs.
2894 This variable holds a function that Emacs calls whenever text
2895 is put in the kill ring, to make the new kill available to other
2896 programs.
2897
2898 The function takes one argument, TEXT, which is a string containing
2899 the text which should be made available.")
2900
2901 (defvar interprogram-paste-function nil
2902 "Function to call to get text cut from other programs.
2903
2904 Most window systems provide some sort of facility for cutting and
2905 pasting text between the windows of different programs.
2906 This variable holds a function that Emacs calls to obtain
2907 text that other programs have provided for pasting.
2908
2909 The function should be called with no arguments. If the function
2910 returns nil, then no other program has provided such text, and the top
2911 of the Emacs kill ring should be used. If the function returns a
2912 string, then the caller of the function \(usually `current-kill')
2913 should put this string in the kill ring as the latest kill.
2914
2915 This function may also return a list of strings if the window
2916 system supports multiple selections. The first string will be
2917 used as the pasted text, but the other will be placed in the
2918 kill ring for easy access via `yank-pop'.
2919
2920 Note that the function should return a string only if a program other
2921 than Emacs has provided a string for pasting; if Emacs provided the
2922 most recent string, the function should return nil. If it is
2923 difficult to tell whether Emacs or some other program provided the
2924 current string, it is probably good enough to return nil if the string
2925 is equal (according to `string=') to the last text Emacs provided.")
2926 \f
2927
2928
2929 ;;;; The kill ring data structure.
2930
2931 (defvar kill-ring nil
2932 "List of killed text sequences.
2933 Since the kill ring is supposed to interact nicely with cut-and-paste
2934 facilities offered by window systems, use of this variable should
2935 interact nicely with `interprogram-cut-function' and
2936 `interprogram-paste-function'. The functions `kill-new',
2937 `kill-append', and `current-kill' are supposed to implement this
2938 interaction; you may want to use them instead of manipulating the kill
2939 ring directly.")
2940
2941 (defcustom kill-ring-max 60
2942 "Maximum length of kill ring before oldest elements are thrown away."
2943 :type 'integer
2944 :group 'killing)
2945
2946 (defvar kill-ring-yank-pointer nil
2947 "The tail of the kill ring whose car is the last thing yanked.")
2948
2949 (defcustom save-interprogram-paste-before-kill nil
2950 "Save clipboard strings into kill ring before replacing them.
2951 When one selects something in another program to paste it into Emacs,
2952 but kills something in Emacs before actually pasting it,
2953 this selection is gone unless this variable is non-nil,
2954 in which case the other program's selection is saved in the `kill-ring'
2955 before the Emacs kill and one can still paste it using \\[yank] \\[yank-pop]."
2956 :type 'boolean
2957 :group 'killing
2958 :version "23.2")
2959
2960 (defcustom kill-do-not-save-duplicates nil
2961 "Do not add a new string to `kill-ring' when it is the same as the last one."
2962 :type 'boolean
2963 :group 'killing
2964 :version "23.2")
2965
2966 (defun kill-new (string &optional replace yank-handler)
2967 "Make STRING the latest kill in the kill ring.
2968 Set `kill-ring-yank-pointer' to point to it.
2969 If `interprogram-cut-function' is non-nil, apply it to STRING.
2970 Optional second argument REPLACE non-nil means that STRING will replace
2971 the front of the kill ring, rather than being added to the list.
2972
2973 Optional third arguments YANK-HANDLER controls how the STRING is later
2974 inserted into a buffer; see `insert-for-yank' for details.
2975 When a yank handler is specified, STRING must be non-empty (the yank
2976 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2977
2978 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
2979 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
2980 STRING.
2981
2982 When the yank handler has a non-nil PARAM element, the original STRING
2983 argument is not used by `insert-for-yank'. However, since Lisp code
2984 may access and use elements from the kill ring directly, the STRING
2985 argument should still be a \"useful\" string for such uses."
2986 (if (> (length string) 0)
2987 (if yank-handler
2988 (put-text-property 0 (length string)
2989 'yank-handler yank-handler string))
2990 (if yank-handler
2991 (signal 'args-out-of-range
2992 (list string "yank-handler specified for empty string"))))
2993 (unless (and kill-do-not-save-duplicates
2994 (equal string (car kill-ring)))
2995 (if (fboundp 'menu-bar-update-yank-menu)
2996 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
2997 (when save-interprogram-paste-before-kill
2998 (let ((interprogram-paste (and interprogram-paste-function
2999 (funcall interprogram-paste-function))))
3000 (when interprogram-paste
3001 (dolist (s (if (listp interprogram-paste)
3002 (nreverse interprogram-paste)
3003 (list interprogram-paste)))
3004 (unless (and kill-do-not-save-duplicates
3005 (equal s (car kill-ring)))
3006 (push s kill-ring))))))
3007 (unless (and kill-do-not-save-duplicates
3008 (equal string (car kill-ring)))
3009 (if (and replace kill-ring)
3010 (setcar kill-ring string)
3011 (push string kill-ring)
3012 (if (> (length kill-ring) kill-ring-max)
3013 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3014 (setq kill-ring-yank-pointer kill-ring)
3015 (if interprogram-cut-function
3016 (funcall interprogram-cut-function string)))
3017
3018 (defun kill-append (string before-p &optional yank-handler)
3019 "Append STRING to the end of the latest kill in the kill ring.
3020 If BEFORE-P is non-nil, prepend STRING to the kill.
3021 Optional third argument YANK-HANDLER, if non-nil, specifies the
3022 yank-handler text property to be set on the combined kill ring
3023 string. If the specified yank-handler arg differs from the
3024 yank-handler property of the latest kill string, this function
3025 adds the combined string to the kill ring as a new element,
3026 instead of replacing the last kill with it.
3027 If `interprogram-cut-function' is set, pass the resulting kill to it."
3028 (let* ((cur (car kill-ring)))
3029 (kill-new (if before-p (concat string cur) (concat cur string))
3030 (or (= (length cur) 0)
3031 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3032 yank-handler)))
3033
3034 (defcustom yank-pop-change-selection nil
3035 "If non-nil, rotating the kill ring changes the window system selection."
3036 :type 'boolean
3037 :group 'killing
3038 :version "23.1")
3039
3040 (defun current-kill (n &optional do-not-move)
3041 "Rotate the yanking point by N places, and then return that kill.
3042 If N is zero, `interprogram-paste-function' is set, and calling
3043 it returns a string or list of strings, then that string (or
3044 list) is added to the front of the kill ring and the string (or
3045 first string in the list) is returned as the latest kill.
3046
3047 If N is not zero, and if `yank-pop-change-selection' is
3048 non-nil, use `interprogram-cut-function' to transfer the
3049 kill at the new yank point into the window system selection.
3050
3051 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3052 move the yanking point; just return the Nth kill forward."
3053
3054 (let ((interprogram-paste (and (= n 0)
3055 interprogram-paste-function
3056 (funcall interprogram-paste-function))))
3057 (if interprogram-paste
3058 (progn
3059 ;; Disable the interprogram cut function when we add the new
3060 ;; text to the kill ring, so Emacs doesn't try to own the
3061 ;; selection, with identical text.
3062 (let ((interprogram-cut-function nil))
3063 (if (listp interprogram-paste)
3064 (mapc 'kill-new (nreverse interprogram-paste))
3065 (kill-new interprogram-paste)))
3066 (car kill-ring))
3067 (or kill-ring (error "Kill ring is empty"))
3068 (let ((ARGth-kill-element
3069 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3070 (length kill-ring))
3071 kill-ring)))
3072 (unless do-not-move
3073 (setq kill-ring-yank-pointer ARGth-kill-element)
3074 (when (and yank-pop-change-selection
3075 (> n 0)
3076 interprogram-cut-function)
3077 (funcall interprogram-cut-function (car ARGth-kill-element))))
3078 (car ARGth-kill-element)))))
3079
3080
3081
3082 ;;;; Commands for manipulating the kill ring.
3083
3084 (defcustom kill-read-only-ok nil
3085 "Non-nil means don't signal an error for killing read-only text."
3086 :type 'boolean
3087 :group 'killing)
3088
3089 (put 'text-read-only 'error-conditions
3090 '(text-read-only buffer-read-only error))
3091 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3092
3093 (defun kill-region (beg end &optional yank-handler)
3094 "Kill (\"cut\") text between point and mark.
3095 This deletes the text from the buffer and saves it in the kill ring.
3096 The command \\[yank] can retrieve it from there.
3097 \(If you want to save the region without killing it, use \\[kill-ring-save].)
3098
3099 If you want to append the killed region to the last killed text,
3100 use \\[append-next-kill] before \\[kill-region].
3101
3102 If the buffer is read-only, Emacs will beep and refrain from deleting
3103 the text, but put the text in the kill ring anyway. This means that
3104 you can use the killing commands to copy text from a read-only buffer.
3105
3106 Lisp programs should use this function for killing text.
3107 (To delete text, use `delete-region'.)
3108 Supply two arguments, character positions indicating the stretch of text
3109 to be killed.
3110 Any command that calls this function is a \"kill command\".
3111 If the previous command was also a kill command,
3112 the text killed this time appends to the text killed last time
3113 to make one entry in the kill ring.
3114
3115 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
3116 specifies the yank-handler text property to be set on the killed
3117 text. See `insert-for-yank'."
3118 ;; Pass point first, then mark, because the order matters
3119 ;; when calling kill-append.
3120 (interactive (list (point) (mark)))
3121 (unless (and beg end)
3122 (error "The mark is not set now, so there is no region"))
3123 (condition-case nil
3124 (let ((string (filter-buffer-substring beg end t)))
3125 (when string ;STRING is nil if BEG = END
3126 ;; Add that string to the kill ring, one way or another.
3127 (if (eq last-command 'kill-region)
3128 (kill-append string (< end beg) yank-handler)
3129 (kill-new string nil yank-handler)))
3130 (when (or string (eq last-command 'kill-region))
3131 (setq this-command 'kill-region))
3132 nil)
3133 ((buffer-read-only text-read-only)
3134 ;; The code above failed because the buffer, or some of the characters
3135 ;; in the region, are read-only.
3136 ;; We should beep, in case the user just isn't aware of this.
3137 ;; However, there's no harm in putting
3138 ;; the region's text in the kill ring, anyway.
3139 (copy-region-as-kill beg end)
3140 ;; Set this-command now, so it will be set even if we get an error.
3141 (setq this-command 'kill-region)
3142 ;; This should barf, if appropriate, and give us the correct error.
3143 (if kill-read-only-ok
3144 (progn (message "Read only text copied to kill ring") nil)
3145 ;; Signal an error if the buffer is read-only.
3146 (barf-if-buffer-read-only)
3147 ;; If the buffer isn't read-only, the text is.
3148 (signal 'text-read-only (list (current-buffer)))))))
3149
3150 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3151 ;; to get two copies of the text when the user accidentally types M-w and
3152 ;; then corrects it with the intended C-w.
3153 (defun copy-region-as-kill (beg end)
3154 "Save the region as if killed, but don't kill it.
3155 In Transient Mark mode, deactivate the mark.
3156 If `interprogram-cut-function' is non-nil, also save the text for a window
3157 system cut and paste.
3158
3159 This command's old key binding has been given to `kill-ring-save'."
3160 (interactive "r")
3161 (if (eq last-command 'kill-region)
3162 (kill-append (filter-buffer-substring beg end) (< end beg))
3163 (kill-new (filter-buffer-substring beg end)))
3164 (setq deactivate-mark t)
3165 nil)
3166
3167 (defun kill-ring-save (beg end)
3168 "Save the region as if killed, but don't kill it.
3169 In Transient Mark mode, deactivate the mark.
3170 If `interprogram-cut-function' is non-nil, also save the text for a window
3171 system cut and paste.
3172
3173 If you want to append the killed line to the last killed text,
3174 use \\[append-next-kill] before \\[kill-ring-save].
3175
3176 This command is similar to `copy-region-as-kill', except that it gives
3177 visual feedback indicating the extent of the region being copied."
3178 (interactive "r")
3179 (copy-region-as-kill beg end)
3180 ;; This use of called-interactively-p is correct
3181 ;; because the code it controls just gives the user visual feedback.
3182 (if (called-interactively-p 'interactive)
3183 (let ((other-end (if (= (point) beg) end beg))
3184 (opoint (point))
3185 ;; Inhibit quitting so we can make a quit here
3186 ;; look like a C-g typed as a command.
3187 (inhibit-quit t))
3188 (if (pos-visible-in-window-p other-end (selected-window))
3189 ;; Swap point-and-mark quickly so as to show the region that
3190 ;; was selected. Don't do it if the region is highlighted.
3191 (unless (and (region-active-p)
3192 (face-background 'region))
3193 ;; Swap point and mark.
3194 (set-marker (mark-marker) (point) (current-buffer))
3195 (goto-char other-end)
3196 (sit-for blink-matching-delay)
3197 ;; Swap back.
3198 (set-marker (mark-marker) other-end (current-buffer))
3199 (goto-char opoint)
3200 ;; If user quit, deactivate the mark
3201 ;; as C-g would as a command.
3202 (and quit-flag mark-active
3203 (deactivate-mark)))
3204 (let* ((killed-text (current-kill 0))
3205 (message-len (min (length killed-text) 40)))
3206 (if (= (point) beg)
3207 ;; Don't say "killed"; that is misleading.
3208 (message "Saved text until \"%s\""
3209 (substring killed-text (- message-len)))
3210 (message "Saved text from \"%s\""
3211 (substring killed-text 0 message-len))))))))
3212
3213 (defun append-next-kill (&optional interactive)
3214 "Cause following command, if it kills, to append to previous kill.
3215 The argument is used for internal purposes; do not supply one."
3216 (interactive "p")
3217 ;; We don't use (interactive-p), since that breaks kbd macros.
3218 (if interactive
3219 (progn
3220 (setq this-command 'kill-region)
3221 (message "If the next command is a kill, it will append"))
3222 (setq last-command 'kill-region)))
3223 \f
3224 ;; Yanking.
3225
3226 ;; This is actually used in subr.el but defcustom does not work there.
3227 (defcustom yank-excluded-properties
3228 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3229 yank-handler follow-link fontified)
3230 "Text properties to discard when yanking.
3231 The value should be a list of text properties to discard or t,
3232 which means to discard all text properties."
3233 :type '(choice (const :tag "All" t) (repeat symbol))
3234 :group 'killing
3235 :version "22.1")
3236
3237 (defvar yank-window-start nil)
3238 (defvar yank-undo-function nil
3239 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3240 Function is called with two parameters, START and END corresponding to
3241 the value of the mark and point; it is guaranteed that START <= END.
3242 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3243
3244 (defun yank-pop (&optional arg)
3245 "Replace just-yanked stretch of killed text with a different stretch.
3246 This command is allowed only immediately after a `yank' or a `yank-pop'.
3247 At such a time, the region contains a stretch of reinserted
3248 previously-killed text. `yank-pop' deletes that text and inserts in its
3249 place a different stretch of killed text.
3250
3251 With no argument, the previous kill is inserted.
3252 With argument N, insert the Nth previous kill.
3253 If N is negative, this is a more recent kill.
3254
3255 The sequence of kills wraps around, so that after the oldest one
3256 comes the newest one.
3257
3258 When this command inserts killed text into the buffer, it honors
3259 `yank-excluded-properties' and `yank-handler' as described in the
3260 doc string for `insert-for-yank-1', which see."
3261 (interactive "*p")
3262 (if (not (eq last-command 'yank))
3263 (error "Previous command was not a yank"))
3264 (setq this-command 'yank)
3265 (unless arg (setq arg 1))
3266 (let ((inhibit-read-only t)
3267 (before (< (point) (mark t))))
3268 (if before
3269 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3270 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3271 (setq yank-undo-function nil)
3272 (set-marker (mark-marker) (point) (current-buffer))
3273 (insert-for-yank (current-kill arg))
3274 ;; Set the window start back where it was in the yank command,
3275 ;; if possible.
3276 (set-window-start (selected-window) yank-window-start t)
3277 (if before
3278 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3279 ;; It is cleaner to avoid activation, even though the command
3280 ;; loop would deactivate the mark because we inserted text.
3281 (goto-char (prog1 (mark t)
3282 (set-marker (mark-marker) (point) (current-buffer))))))
3283 nil)
3284
3285 (defun yank (&optional arg)
3286 "Reinsert (\"paste\") the last stretch of killed text.
3287 More precisely, reinsert the stretch of killed text most recently
3288 killed OR yanked. Put point at end, and set mark at beginning.
3289 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3290 With argument N, reinsert the Nth most recently killed stretch of killed
3291 text.
3292
3293 When this command inserts killed text into the buffer, it honors
3294 `yank-excluded-properties' and `yank-handler' as described in the
3295 doc string for `insert-for-yank-1', which see.
3296
3297 See also the command `yank-pop' (\\[yank-pop])."
3298 (interactive "*P")
3299 (setq yank-window-start (window-start))
3300 ;; If we don't get all the way thru, make last-command indicate that
3301 ;; for the following command.
3302 (setq this-command t)
3303 (push-mark (point))
3304 (insert-for-yank (current-kill (cond
3305 ((listp arg) 0)
3306 ((eq arg '-) -2)
3307 (t (1- arg)))))
3308 (if (consp arg)
3309 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3310 ;; It is cleaner to avoid activation, even though the command
3311 ;; loop would deactivate the mark because we inserted text.
3312 (goto-char (prog1 (mark t)
3313 (set-marker (mark-marker) (point) (current-buffer)))))
3314 ;; If we do get all the way thru, make this-command indicate that.
3315 (if (eq this-command t)
3316 (setq this-command 'yank))
3317 nil)
3318
3319 (defun rotate-yank-pointer (arg)
3320 "Rotate the yanking point in the kill ring.
3321 With ARG, rotate that many kills forward (or backward, if negative)."
3322 (interactive "p")
3323 (current-kill arg))
3324 \f
3325 ;; Some kill commands.
3326
3327 ;; Internal subroutine of delete-char
3328 (defun kill-forward-chars (arg)
3329 (if (listp arg) (setq arg (car arg)))
3330 (if (eq arg '-) (setq arg -1))
3331 (kill-region (point) (+ (point) arg)))
3332
3333 ;; Internal subroutine of backward-delete-char
3334 (defun kill-backward-chars (arg)
3335 (if (listp arg) (setq arg (car arg)))
3336 (if (eq arg '-) (setq arg -1))
3337 (kill-region (point) (- (point) arg)))
3338
3339 (defcustom backward-delete-char-untabify-method 'untabify
3340 "The method for untabifying when deleting backward.
3341 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3342 `hungry' -- delete all whitespace, both tabs and spaces;
3343 `all' -- delete all whitespace, including tabs, spaces and newlines;
3344 nil -- just delete one character."
3345 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3346 :version "20.3"
3347 :group 'killing)
3348
3349 (defun backward-delete-char-untabify (arg &optional killp)
3350 "Delete characters backward, changing tabs into spaces.
3351 The exact behavior depends on `backward-delete-char-untabify-method'.
3352 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3353 Interactively, ARG is the prefix arg (default 1)
3354 and KILLP is t if a prefix arg was specified."
3355 (interactive "*p\nP")
3356 (when (eq backward-delete-char-untabify-method 'untabify)
3357 (let ((count arg))
3358 (save-excursion
3359 (while (and (> count 0) (not (bobp)))
3360 (if (= (preceding-char) ?\t)
3361 (let ((col (current-column)))
3362 (forward-char -1)
3363 (setq col (- col (current-column)))
3364 (insert-char ?\s col)
3365 (delete-char 1)))
3366 (forward-char -1)
3367 (setq count (1- count))))))
3368 (delete-backward-char
3369 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
3370 ((eq backward-delete-char-untabify-method 'all)
3371 " \t\n\r"))))
3372 (if skip
3373 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3374 (point)))))
3375 (+ arg (if (zerop wh) 0 (1- wh))))
3376 arg))
3377 killp))
3378
3379 (defun zap-to-char (arg char)
3380 "Kill up to and including ARGth occurrence of CHAR.
3381 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3382 Goes backward if ARG is negative; error if CHAR not found."
3383 (interactive "p\ncZap to char: ")
3384 ;; Avoid "obsolete" warnings for translation-table-for-input.
3385 (with-no-warnings
3386 (if (char-table-p translation-table-for-input)
3387 (setq char (or (aref translation-table-for-input char) char))))
3388 (kill-region (point) (progn
3389 (search-forward (char-to-string char) nil nil arg)
3390 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3391 (point))))
3392
3393 ;; kill-line and its subroutines.
3394
3395 (defcustom kill-whole-line nil
3396 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3397 :type 'boolean
3398 :group 'killing)
3399
3400 (defun kill-line (&optional arg)
3401 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3402 With prefix argument ARG, kill that many lines from point.
3403 Negative arguments kill lines backward.
3404 With zero argument, kills the text before point on the current line.
3405
3406 When calling from a program, nil means \"no arg\",
3407 a number counts as a prefix arg.
3408
3409 To kill a whole line, when point is not at the beginning, type \
3410 \\[move-beginning-of-line] \\[kill-line] \\[kill-line].
3411
3412 If `kill-whole-line' is non-nil, then this command kills the whole line
3413 including its terminating newline, when used at the beginning of a line
3414 with no argument. As a consequence, you can always kill a whole line
3415 by typing \\[move-beginning-of-line] \\[kill-line].
3416
3417 If you want to append the killed line to the last killed text,
3418 use \\[append-next-kill] before \\[kill-line].
3419
3420 If the buffer is read-only, Emacs will beep and refrain from deleting
3421 the line, but put the line in the kill ring anyway. This means that
3422 you can use this command to copy text from a read-only buffer.
3423 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3424 even beep.)"
3425 (interactive "P")
3426 (kill-region (point)
3427 ;; It is better to move point to the other end of the kill
3428 ;; before killing. That way, in a read-only buffer, point
3429 ;; moves across the text that is copied to the kill ring.
3430 ;; The choice has no effect on undo now that undo records
3431 ;; the value of point from before the command was run.
3432 (progn
3433 (if arg
3434 (forward-visible-line (prefix-numeric-value arg))
3435 (if (eobp)
3436 (signal 'end-of-buffer nil))
3437 (let ((end
3438 (save-excursion
3439 (end-of-visible-line) (point))))
3440 (if (or (save-excursion
3441 ;; If trailing whitespace is visible,
3442 ;; don't treat it as nothing.
3443 (unless show-trailing-whitespace
3444 (skip-chars-forward " \t" end))
3445 (= (point) end))
3446 (and kill-whole-line (bolp)))
3447 (forward-visible-line 1)
3448 (goto-char end))))
3449 (point))))
3450
3451 (defun kill-whole-line (&optional arg)
3452 "Kill current line.
3453 With prefix ARG, kill that many lines starting from the current line.
3454 If ARG is negative, kill backward. Also kill the preceding newline.
3455 \(This is meant to make \\[repeat] work well with negative arguments.\)
3456 If ARG is zero, kill current line but exclude the trailing newline."
3457 (interactive "p")
3458 (or arg (setq arg 1))
3459 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3460 (signal 'end-of-buffer nil))
3461 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3462 (signal 'beginning-of-buffer nil))
3463 (unless (eq last-command 'kill-region)
3464 (kill-new "")
3465 (setq last-command 'kill-region))
3466 (cond ((zerop arg)
3467 ;; We need to kill in two steps, because the previous command
3468 ;; could have been a kill command, in which case the text
3469 ;; before point needs to be prepended to the current kill
3470 ;; ring entry and the text after point appended. Also, we
3471 ;; need to use save-excursion to avoid copying the same text
3472 ;; twice to the kill ring in read-only buffers.
3473 (save-excursion
3474 (kill-region (point) (progn (forward-visible-line 0) (point))))
3475 (kill-region (point) (progn (end-of-visible-line) (point))))
3476 ((< arg 0)
3477 (save-excursion
3478 (kill-region (point) (progn (end-of-visible-line) (point))))
3479 (kill-region (point)
3480 (progn (forward-visible-line (1+ arg))
3481 (unless (bobp) (backward-char))
3482 (point))))
3483 (t
3484 (save-excursion
3485 (kill-region (point) (progn (forward-visible-line 0) (point))))
3486 (kill-region (point)
3487 (progn (forward-visible-line arg) (point))))))
3488
3489 (defun forward-visible-line (arg)
3490 "Move forward by ARG lines, ignoring currently invisible newlines only.
3491 If ARG is negative, move backward -ARG lines.
3492 If ARG is zero, move to the beginning of the current line."
3493 (condition-case nil
3494 (if (> arg 0)
3495 (progn
3496 (while (> arg 0)
3497 (or (zerop (forward-line 1))
3498 (signal 'end-of-buffer nil))
3499 ;; If the newline we just skipped is invisible,
3500 ;; don't count it.
3501 (let ((prop
3502 (get-char-property (1- (point)) 'invisible)))
3503 (if (if (eq buffer-invisibility-spec t)
3504 prop
3505 (or (memq prop buffer-invisibility-spec)
3506 (assq prop buffer-invisibility-spec)))
3507 (setq arg (1+ arg))))
3508 (setq arg (1- arg)))
3509 ;; If invisible text follows, and it is a number of complete lines,
3510 ;; skip it.
3511 (let ((opoint (point)))
3512 (while (and (not (eobp))
3513 (let ((prop
3514 (get-char-property (point) 'invisible)))
3515 (if (eq buffer-invisibility-spec t)
3516 prop
3517 (or (memq prop buffer-invisibility-spec)
3518 (assq prop buffer-invisibility-spec)))))
3519 (goto-char
3520 (if (get-text-property (point) 'invisible)
3521 (or (next-single-property-change (point) 'invisible)
3522 (point-max))
3523 (next-overlay-change (point)))))
3524 (unless (bolp)
3525 (goto-char opoint))))
3526 (let ((first t))
3527 (while (or first (<= arg 0))
3528 (if first
3529 (beginning-of-line)
3530 (or (zerop (forward-line -1))
3531 (signal 'beginning-of-buffer nil)))
3532 ;; If the newline we just moved to is invisible,
3533 ;; don't count it.
3534 (unless (bobp)
3535 (let ((prop
3536 (get-char-property (1- (point)) 'invisible)))
3537 (unless (if (eq buffer-invisibility-spec t)
3538 prop
3539 (or (memq prop buffer-invisibility-spec)
3540 (assq prop buffer-invisibility-spec)))
3541 (setq arg (1+ arg)))))
3542 (setq first nil))
3543 ;; If invisible text follows, and it is a number of complete lines,
3544 ;; skip it.
3545 (let ((opoint (point)))
3546 (while (and (not (bobp))
3547 (let ((prop
3548 (get-char-property (1- (point)) 'invisible)))
3549 (if (eq buffer-invisibility-spec t)
3550 prop
3551 (or (memq prop buffer-invisibility-spec)
3552 (assq prop buffer-invisibility-spec)))))
3553 (goto-char
3554 (if (get-text-property (1- (point)) 'invisible)
3555 (or (previous-single-property-change (point) 'invisible)
3556 (point-min))
3557 (previous-overlay-change (point)))))
3558 (unless (bolp)
3559 (goto-char opoint)))))
3560 ((beginning-of-buffer end-of-buffer)
3561 nil)))
3562
3563 (defun end-of-visible-line ()
3564 "Move to end of current visible line."
3565 (end-of-line)
3566 ;; If the following character is currently invisible,
3567 ;; skip all characters with that same `invisible' property value,
3568 ;; then find the next newline.
3569 (while (and (not (eobp))
3570 (save-excursion
3571 (skip-chars-forward "^\n")
3572 (let ((prop
3573 (get-char-property (point) 'invisible)))
3574 (if (eq buffer-invisibility-spec t)
3575 prop
3576 (or (memq prop buffer-invisibility-spec)
3577 (assq prop buffer-invisibility-spec))))))
3578 (skip-chars-forward "^\n")
3579 (if (get-text-property (point) 'invisible)
3580 (goto-char (next-single-property-change (point) 'invisible))
3581 (goto-char (next-overlay-change (point))))
3582 (end-of-line)))
3583 \f
3584 (defun insert-buffer (buffer)
3585 "Insert after point the contents of BUFFER.
3586 Puts mark after the inserted text.
3587 BUFFER may be a buffer or a buffer name.
3588
3589 This function is meant for the user to run interactively.
3590 Don't call it from programs: use `insert-buffer-substring' instead!"
3591 (interactive
3592 (list
3593 (progn
3594 (barf-if-buffer-read-only)
3595 (read-buffer "Insert buffer: "
3596 (if (eq (selected-window) (next-window (selected-window)))
3597 (other-buffer (current-buffer))
3598 (window-buffer (next-window (selected-window))))
3599 t))))
3600 (push-mark
3601 (save-excursion
3602 (insert-buffer-substring (get-buffer buffer))
3603 (point)))
3604 nil)
3605
3606 (defun append-to-buffer (buffer start end)
3607 "Append to specified buffer the text of the region.
3608 It is inserted into that buffer before its point.
3609
3610 When calling from a program, give three arguments:
3611 BUFFER (or buffer name), START and END.
3612 START and END specify the portion of the current buffer to be copied."
3613 (interactive
3614 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3615 (region-beginning) (region-end)))
3616 (let* ((oldbuf (current-buffer))
3617 (append-to (get-buffer-create buffer))
3618 (windows (get-buffer-window-list append-to t t))
3619 point)
3620 (save-excursion
3621 (with-current-buffer append-to
3622 (setq point (point))
3623 (barf-if-buffer-read-only)
3624 (insert-buffer-substring oldbuf start end)
3625 (dolist (window windows)
3626 (when (= (window-point window) point)
3627 (set-window-point window (point))))))))
3628
3629 (defun prepend-to-buffer (buffer start end)
3630 "Prepend to specified buffer the text of the region.
3631 It is inserted into that buffer after its point.
3632
3633 When calling from a program, give three arguments:
3634 BUFFER (or buffer name), START and END.
3635 START and END specify the portion of the current buffer to be copied."
3636 (interactive "BPrepend to buffer: \nr")
3637 (let ((oldbuf (current-buffer)))
3638 (with-current-buffer (get-buffer-create buffer)
3639 (barf-if-buffer-read-only)
3640 (save-excursion
3641 (insert-buffer-substring oldbuf start end)))))
3642
3643 (defun copy-to-buffer (buffer start end)
3644 "Copy to specified buffer the text of the region.
3645 It is inserted into that buffer, replacing existing text there.
3646
3647 When calling from a program, give three arguments:
3648 BUFFER (or buffer name), START and END.
3649 START and END specify the portion of the current buffer to be copied."
3650 (interactive "BCopy to buffer: \nr")
3651 (let ((oldbuf (current-buffer)))
3652 (with-current-buffer (get-buffer-create buffer)
3653 (barf-if-buffer-read-only)
3654 (erase-buffer)
3655 (save-excursion
3656 (insert-buffer-substring oldbuf start end)))))
3657 \f
3658 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3659 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3660
3661 (defvar activate-mark-hook nil
3662 "Hook run when the mark becomes active.
3663 It is also run at the end of a command, if the mark is active and
3664 it is possible that the region may have changed.")
3665
3666 (defvar deactivate-mark-hook nil
3667 "Hook run when the mark becomes inactive.")
3668
3669 (defun mark (&optional force)
3670 "Return this buffer's mark value as integer, or nil if never set.
3671
3672 In Transient Mark mode, this function signals an error if
3673 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3674 or the argument FORCE is non-nil, it disregards whether the mark
3675 is active, and returns an integer or nil in the usual way.
3676
3677 If you are using this in an editing command, you are most likely making
3678 a mistake; see the documentation of `set-mark'."
3679 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3680 (marker-position (mark-marker))
3681 (signal 'mark-inactive nil)))
3682
3683 (declare-function x-selection-owner-p "xselect.c" (&optional selection))
3684
3685 (defsubst deactivate-mark (&optional force)
3686 "Deactivate the mark by setting `mark-active' to nil.
3687 Unless FORCE is non-nil, this function does nothing if Transient
3688 Mark mode is disabled.
3689 This function also runs `deactivate-mark-hook'."
3690 (when (or transient-mark-mode force)
3691 (when (and (if (eq select-active-regions 'only)
3692 (eq (car-safe transient-mark-mode) 'only)
3693 select-active-regions)
3694 (region-active-p)
3695 (display-selections-p))
3696 ;; The var `saved-region-selection', if non-nil, is the text in
3697 ;; the region prior to the last command modifying the buffer.
3698 ;; Set the selection to that, or to the current region.
3699 (cond (saved-region-selection
3700 (x-set-selection 'PRIMARY saved-region-selection)
3701 (setq saved-region-selection nil))
3702 ((/= (region-beginning) (region-end))
3703 (x-set-selection 'PRIMARY
3704 (buffer-substring-no-properties
3705 (region-beginning)
3706 (region-end))))))
3707 (if (and (null force)
3708 (or (eq transient-mark-mode 'lambda)
3709 (and (eq (car-safe transient-mark-mode) 'only)
3710 (null (cdr transient-mark-mode)))))
3711 ;; When deactivating a temporary region, don't change
3712 ;; `mark-active' or run `deactivate-mark-hook'.
3713 (setq transient-mark-mode nil)
3714 (if (eq (car-safe transient-mark-mode) 'only)
3715 (setq transient-mark-mode (cdr transient-mark-mode)))
3716 (setq mark-active nil)
3717 (run-hooks 'deactivate-mark-hook))))
3718
3719 (defun activate-mark ()
3720 "Activate the mark."
3721 (when (mark t)
3722 (setq mark-active t)
3723 (unless transient-mark-mode
3724 (setq transient-mark-mode 'lambda))))
3725
3726 (defun set-mark (pos)
3727 "Set this buffer's mark to POS. Don't use this function!
3728 That is to say, don't use this function unless you want
3729 the user to see that the mark has moved, and you want the previous
3730 mark position to be lost.
3731
3732 Normally, when a new mark is set, the old one should go on the stack.
3733 This is why most applications should use `push-mark', not `set-mark'.
3734
3735 Novice Emacs Lisp programmers often try to use the mark for the wrong
3736 purposes. The mark saves a location for the user's convenience.
3737 Most editing commands should not alter the mark.
3738 To remember a location for internal use in the Lisp program,
3739 store it in a Lisp variable. Example:
3740
3741 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3742
3743 (if pos
3744 (progn
3745 (setq mark-active t)
3746 (run-hooks 'activate-mark-hook)
3747 (set-marker (mark-marker) pos (current-buffer)))
3748 ;; Normally we never clear mark-active except in Transient Mark mode.
3749 ;; But when we actually clear out the mark value too, we must
3750 ;; clear mark-active in any mode.
3751 (deactivate-mark t)
3752 (set-marker (mark-marker) nil)))
3753
3754 (defcustom use-empty-active-region nil
3755 "Whether \"region-aware\" commands should act on empty regions.
3756 If nil, region-aware commands treat empty regions as inactive.
3757 If non-nil, region-aware commands treat the region as active as
3758 long as the mark is active, even if the region is empty.
3759
3760 Region-aware commands are those that act on the region if it is
3761 active and Transient Mark mode is enabled, and on the text near
3762 point otherwise."
3763 :type 'boolean
3764 :version "23.1"
3765 :group 'editing-basics)
3766
3767 (defun use-region-p ()
3768 "Return t if the region is active and it is appropriate to act on it.
3769 This is used by commands that act specially on the region under
3770 Transient Mark mode.
3771
3772 The return value is t if Transient Mark mode is enabled and the
3773 mark is active; furthermore, if `use-empty-active-region' is nil,
3774 the region must not be empty. Otherwise, the return value is nil.
3775
3776 For some commands, it may be appropriate to ignore the value of
3777 `use-empty-active-region'; in that case, use `region-active-p'."
3778 (and (region-active-p)
3779 (or use-empty-active-region (> (region-end) (region-beginning)))))
3780
3781 (defun region-active-p ()
3782 "Return t if Transient Mark mode is enabled and the mark is active.
3783
3784 Some commands act specially on the region when Transient Mark
3785 mode is enabled. Usually, such commands should use
3786 `use-region-p' instead of this function, because `use-region-p'
3787 also checks the value of `use-empty-active-region'."
3788 (and transient-mark-mode mark-active))
3789
3790 (defvar mark-ring nil
3791 "The list of former marks of the current buffer, most recent first.")
3792 (make-variable-buffer-local 'mark-ring)
3793 (put 'mark-ring 'permanent-local t)
3794
3795 (defcustom mark-ring-max 16
3796 "Maximum size of mark ring. Start discarding off end if gets this big."
3797 :type 'integer
3798 :group 'editing-basics)
3799
3800 (defvar global-mark-ring nil
3801 "The list of saved global marks, most recent first.")
3802
3803 (defcustom global-mark-ring-max 16
3804 "Maximum size of global mark ring. \
3805 Start discarding off end if gets this big."
3806 :type 'integer
3807 :group 'editing-basics)
3808
3809 (defun pop-to-mark-command ()
3810 "Jump to mark, and pop a new position for mark off the ring.
3811 \(Does not affect global mark ring\)."
3812 (interactive)
3813 (if (null (mark t))
3814 (error "No mark set in this buffer")
3815 (if (= (point) (mark t))
3816 (message "Mark popped"))
3817 (goto-char (mark t))
3818 (pop-mark)))
3819
3820 (defun push-mark-command (arg &optional nomsg)
3821 "Set mark at where point is.
3822 If no prefix ARG and mark is already set there, just activate it.
3823 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3824 (interactive "P")
3825 (let ((mark (marker-position (mark-marker))))
3826 (if (or arg (null mark) (/= mark (point)))
3827 (push-mark nil nomsg t)
3828 (setq mark-active t)
3829 (run-hooks 'activate-mark-hook)
3830 (unless nomsg
3831 (message "Mark activated")))))
3832
3833 (defcustom set-mark-command-repeat-pop nil
3834 "Non-nil means repeating \\[set-mark-command] after popping mark pops it again.
3835 That means that C-u \\[set-mark-command] \\[set-mark-command]
3836 will pop the mark twice, and
3837 C-u \\[set-mark-command] \\[set-mark-command] \\[set-mark-command]
3838 will pop the mark three times.
3839
3840 A value of nil means \\[set-mark-command]'s behavior does not change
3841 after C-u \\[set-mark-command]."
3842 :type 'boolean
3843 :group 'editing-basics)
3844
3845 (defcustom set-mark-default-inactive nil
3846 "If non-nil, setting the mark does not activate it.
3847 This causes \\[set-mark-command] and \\[exchange-point-and-mark] to
3848 behave the same whether or not `transient-mark-mode' is enabled."
3849 :type 'boolean
3850 :group 'editing-basics
3851 :version "23.1")
3852
3853 (defun set-mark-command (arg)
3854 "Set the mark where point is, or jump to the mark.
3855 Setting the mark also alters the region, which is the text
3856 between point and mark; this is the closest equivalent in
3857 Emacs to what some editors call the \"selection\".
3858
3859 With no prefix argument, set the mark at point, and push the
3860 old mark position on local mark ring. Also push the old mark on
3861 global mark ring, if the previous mark was set in another buffer.
3862
3863 When Transient Mark Mode is off, immediately repeating this
3864 command activates `transient-mark-mode' temporarily.
3865
3866 With prefix argument \(e.g., \\[universal-argument] \\[set-mark-command]\), \
3867 jump to the mark, and set the mark from
3868 position popped off the local mark ring \(this does not affect the global
3869 mark ring\). Use \\[pop-global-mark] to jump to a mark popped off the global
3870 mark ring \(see `pop-global-mark'\).
3871
3872 If `set-mark-command-repeat-pop' is non-nil, repeating
3873 the \\[set-mark-command] command with no prefix argument pops the next position
3874 off the local (or global) mark ring and jumps there.
3875
3876 With \\[universal-argument] \\[universal-argument] as prefix
3877 argument, unconditionally set mark where point is, even if
3878 `set-mark-command-repeat-pop' is non-nil.
3879
3880 Novice Emacs Lisp programmers often try to use the mark for the wrong
3881 purposes. See the documentation of `set-mark' for more information."
3882 (interactive "P")
3883 (cond ((eq transient-mark-mode 'lambda)
3884 (setq transient-mark-mode nil))
3885 ((eq (car-safe transient-mark-mode) 'only)
3886 (deactivate-mark)))
3887 (cond
3888 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3889 (push-mark-command nil))
3890 ((not (eq this-command 'set-mark-command))
3891 (if arg
3892 (pop-to-mark-command)
3893 (push-mark-command t)))
3894 ((and set-mark-command-repeat-pop
3895 (eq last-command 'pop-to-mark-command))
3896 (setq this-command 'pop-to-mark-command)
3897 (pop-to-mark-command))
3898 ((and set-mark-command-repeat-pop
3899 (eq last-command 'pop-global-mark)
3900 (not arg))
3901 (setq this-command 'pop-global-mark)
3902 (pop-global-mark))
3903 (arg
3904 (setq this-command 'pop-to-mark-command)
3905 (pop-to-mark-command))
3906 ((eq last-command 'set-mark-command)
3907 (if (region-active-p)
3908 (progn
3909 (deactivate-mark)
3910 (message "Mark deactivated"))
3911 (activate-mark)
3912 (message "Mark activated")))
3913 (t
3914 (push-mark-command nil)
3915 (if set-mark-default-inactive (deactivate-mark)))))
3916
3917 (defun push-mark (&optional location nomsg activate)
3918 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3919 If the last global mark pushed was not in the current buffer,
3920 also push LOCATION on the global mark ring.
3921 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3922
3923 Novice Emacs Lisp programmers often try to use the mark for the wrong
3924 purposes. See the documentation of `set-mark' for more information.
3925
3926 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3927 (unless (null (mark t))
3928 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3929 (when (> (length mark-ring) mark-ring-max)
3930 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3931 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3932 (set-marker (mark-marker) (or location (point)) (current-buffer))
3933 ;; Now push the mark on the global mark ring.
3934 (if (and global-mark-ring
3935 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3936 ;; The last global mark pushed was in this same buffer.
3937 ;; Don't push another one.
3938 nil
3939 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3940 (when (> (length global-mark-ring) global-mark-ring-max)
3941 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3942 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3943 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3944 (message "Mark set"))
3945 (if (or activate (not transient-mark-mode))
3946 (set-mark (mark t)))
3947 nil)
3948
3949 (defun pop-mark ()
3950 "Pop off mark ring into the buffer's actual mark.
3951 Does not set point. Does nothing if mark ring is empty."
3952 (when mark-ring
3953 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3954 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3955 (move-marker (car mark-ring) nil)
3956 (if (null (mark t)) (ding))
3957 (setq mark-ring (cdr mark-ring)))
3958 (deactivate-mark))
3959
3960 (define-obsolete-function-alias
3961 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3962 (defun exchange-point-and-mark (&optional arg)
3963 "Put the mark where point is now, and point where the mark is now.
3964 This command works even when the mark is not active,
3965 and it reactivates the mark.
3966
3967 If Transient Mark mode is on, a prefix ARG deactivates the mark
3968 if it is active, and otherwise avoids reactivating it. If
3969 Transient Mark mode is off, a prefix ARG enables Transient Mark
3970 mode temporarily."
3971 (interactive "P")
3972 (let ((omark (mark t))
3973 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3974 (if (null omark)
3975 (error "No mark set in this buffer"))
3976 (deactivate-mark)
3977 (set-mark (point))
3978 (goto-char omark)
3979 (if set-mark-default-inactive (deactivate-mark))
3980 (cond (temp-highlight
3981 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3982 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3983 (not (or arg (region-active-p))))
3984 (deactivate-mark))
3985 (t (activate-mark)))
3986 nil))
3987
3988 (defcustom shift-select-mode t
3989 "When non-nil, shifted motion keys activate the mark momentarily.
3990
3991 While the mark is activated in this way, any shift-translated point
3992 motion key extends the region, and if Transient Mark mode was off, it
3993 is temporarily turned on. Furthermore, the mark will be deactivated
3994 by any subsequent point motion key that was not shift-translated, or
3995 by any action that normally deactivates the mark in Transient Mark mode.
3996
3997 See `this-command-keys-shift-translated' for the meaning of
3998 shift-translation."
3999 :type 'boolean
4000 :group 'editing-basics)
4001
4002 (defun handle-shift-selection ()
4003 "Activate/deactivate mark depending on invocation thru shift translation.
4004 This function is called by `call-interactively' when a command
4005 with a `^' character in its `interactive' spec is invoked, before
4006 running the command itself.
4007
4008 If `shift-select-mode' is enabled and the command was invoked
4009 through shift translation, set the mark and activate the region
4010 temporarily, unless it was already set in this way. See
4011 `this-command-keys-shift-translated' for the meaning of shift
4012 translation.
4013
4014 Otherwise, if the region has been activated temporarily,
4015 deactivate it, and restore the variable `transient-mark-mode' to
4016 its earlier value."
4017 (cond ((and shift-select-mode this-command-keys-shift-translated)
4018 (unless (and mark-active
4019 (eq (car-safe transient-mark-mode) 'only))
4020 (setq transient-mark-mode
4021 (cons 'only
4022 (unless (eq transient-mark-mode 'lambda)
4023 transient-mark-mode)))
4024 (push-mark nil nil t)))
4025 ((eq (car-safe transient-mark-mode) 'only)
4026 (setq transient-mark-mode (cdr transient-mark-mode))
4027 (deactivate-mark))))
4028
4029 (define-minor-mode transient-mark-mode
4030 "Toggle Transient Mark mode.
4031 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4032
4033 In Transient Mark mode, when the mark is active, the region is highlighted.
4034 Changing the buffer \"deactivates\" the mark.
4035 So do certain other operations that set the mark
4036 but whose main purpose is something else--for example,
4037 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer].
4038
4039 You can also deactivate the mark by typing \\[keyboard-quit] or
4040 \\[keyboard-escape-quit].
4041
4042 Many commands change their behavior when Transient Mark mode is in effect
4043 and the mark is active, by acting on the region instead of their usual
4044 default part of the buffer's text. Examples of such commands include
4045 \\[comment-dwim], \\[flush-lines], \\[keep-lines], \
4046 \\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo].
4047 Invoke \\[apropos-documentation] and type \"transient\" or
4048 \"mark.*active\" at the prompt, to see the documentation of
4049 commands which are sensitive to the Transient Mark mode."
4050 :global t
4051 :init-value (not noninteractive)
4052 :initialize 'custom-initialize-delay
4053 :group 'editing-basics)
4054
4055 ;; The variable transient-mark-mode is ugly: it can take on special
4056 ;; values. Document these here.
4057 (defvar transient-mark-mode t
4058 "*Non-nil if Transient Mark mode is enabled.
4059 See the command `transient-mark-mode' for a description of this minor mode.
4060
4061 Non-nil also enables highlighting of the region whenever the mark is active.
4062 The variable `highlight-nonselected-windows' controls whether to highlight
4063 all windows or just the selected window.
4064
4065 If the value is `lambda', that enables Transient Mark mode temporarily.
4066 After any subsequent action that would normally deactivate the mark
4067 \(such as buffer modification), Transient Mark mode is turned off.
4068
4069 If the value is (only . OLDVAL), that enables Transient Mark mode
4070 temporarily. After any subsequent point motion command that is not
4071 shift-translated, or any other action that would normally deactivate
4072 the mark (such as buffer modification), the value of
4073 `transient-mark-mode' is set to OLDVAL.")
4074
4075 (defvar widen-automatically t
4076 "Non-nil means it is ok for commands to call `widen' when they want to.
4077 Some commands will do this in order to go to positions outside
4078 the current accessible part of the buffer.
4079
4080 If `widen-automatically' is nil, these commands will do something else
4081 as a fallback, and won't change the buffer bounds.")
4082
4083 (defvar non-essential nil
4084 "Whether the currently executing code is performing an essential task.
4085 This variable should be non-nil only when running code which should not
4086 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4087 user for a password when we are simply scanning a set of files in the
4088 background or displaying possible completions before the user even asked
4089 for it.")
4090
4091 (defun pop-global-mark ()
4092 "Pop off global mark ring and jump to the top location."
4093 (interactive)
4094 ;; Pop entries which refer to non-existent buffers.
4095 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4096 (setq global-mark-ring (cdr global-mark-ring)))
4097 (or global-mark-ring
4098 (error "No global mark set"))
4099 (let* ((marker (car global-mark-ring))
4100 (buffer (marker-buffer marker))
4101 (position (marker-position marker)))
4102 (setq global-mark-ring (nconc (cdr global-mark-ring)
4103 (list (car global-mark-ring))))
4104 (set-buffer buffer)
4105 (or (and (>= position (point-min))
4106 (<= position (point-max)))
4107 (if widen-automatically
4108 (widen)
4109 (error "Global mark position is outside accessible part of buffer")))
4110 (goto-char position)
4111 (switch-to-buffer buffer)))
4112 \f
4113 (defcustom next-line-add-newlines nil
4114 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4115 :type 'boolean
4116 :version "21.1"
4117 :group 'editing-basics)
4118
4119 (defun next-line (&optional arg try-vscroll)
4120 "Move cursor vertically down ARG lines.
4121 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4122 If there is no character in the target line exactly under the current column,
4123 the cursor is positioned after the character in that line which spans this
4124 column, or at the end of the line if it is not long enough.
4125 If there is no line in the buffer after this one, behavior depends on the
4126 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4127 to create a line, and moves the cursor to that line. Otherwise it moves the
4128 cursor to the end of the buffer.
4129
4130 If the variable `line-move-visual' is non-nil, this command moves
4131 by display lines. Otherwise, it moves by buffer lines, without
4132 taking variable-width characters or continued lines into account.
4133
4134 The command \\[set-goal-column] can be used to create
4135 a semipermanent goal column for this command.
4136 Then instead of trying to move exactly vertically (or as close as possible),
4137 this command moves to the specified goal column (or as close as possible).
4138 The goal column is stored in the variable `goal-column', which is nil
4139 when there is no goal column.
4140
4141 If you are thinking of using this in a Lisp program, consider
4142 using `forward-line' instead. It is usually easier to use
4143 and more reliable (no dependence on goal column, etc.)."
4144 (interactive "^p\np")
4145 (or arg (setq arg 1))
4146 (if (and next-line-add-newlines (= arg 1))
4147 (if (save-excursion (end-of-line) (eobp))
4148 ;; When adding a newline, don't expand an abbrev.
4149 (let ((abbrev-mode nil))
4150 (end-of-line)
4151 (insert (if use-hard-newlines hard-newline "\n")))
4152 (line-move arg nil nil try-vscroll))
4153 (if (called-interactively-p 'interactive)
4154 (condition-case err
4155 (line-move arg nil nil try-vscroll)
4156 ((beginning-of-buffer end-of-buffer)
4157 (signal (car err) (cdr err))))
4158 (line-move arg nil nil try-vscroll)))
4159 nil)
4160
4161 (defun previous-line (&optional arg try-vscroll)
4162 "Move cursor vertically up ARG lines.
4163 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4164 If there is no character in the target line exactly over the current column,
4165 the cursor is positioned after the character in that line which spans this
4166 column, or at the end of the line if it is not long enough.
4167
4168 If the variable `line-move-visual' is non-nil, this command moves
4169 by display lines. Otherwise, it moves by buffer lines, without
4170 taking variable-width characters or continued lines into account.
4171
4172 The command \\[set-goal-column] can be used to create
4173 a semipermanent goal column for this command.
4174 Then instead of trying to move exactly vertically (or as close as possible),
4175 this command moves to the specified goal column (or as close as possible).
4176 The goal column is stored in the variable `goal-column', which is nil
4177 when there is no goal column.
4178
4179 If you are thinking of using this in a Lisp program, consider using
4180 `forward-line' with a negative argument instead. It is usually easier
4181 to use and more reliable (no dependence on goal column, etc.)."
4182 (interactive "^p\np")
4183 (or arg (setq arg 1))
4184 (if (called-interactively-p 'interactive)
4185 (condition-case err
4186 (line-move (- arg) nil nil try-vscroll)
4187 ((beginning-of-buffer end-of-buffer)
4188 (signal (car err) (cdr err))))
4189 (line-move (- arg) nil nil try-vscroll))
4190 nil)
4191
4192 (defcustom track-eol nil
4193 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4194 This means moving to the end of each line moved onto.
4195 The beginning of a blank line does not count as the end of a line.
4196 This has no effect when `line-move-visual' is non-nil."
4197 :type 'boolean
4198 :group 'editing-basics)
4199
4200 (defcustom goal-column nil
4201 "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
4202 :type '(choice integer
4203 (const :tag "None" nil))
4204 :group 'editing-basics)
4205 (make-variable-buffer-local 'goal-column)
4206
4207 (defvar temporary-goal-column 0
4208 "Current goal column for vertical motion.
4209 It is the column where point was at the start of the current run
4210 of vertical motion commands.
4211
4212 When moving by visual lines via `line-move-visual', it is a cons
4213 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4214 divided by the default column width, and HSCROLL is the number of
4215 columns by which window is scrolled from left margin.
4216
4217 When the `track-eol' feature is doing its job, the value is
4218 `most-positive-fixnum'.")
4219
4220 (defcustom line-move-ignore-invisible t
4221 "Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
4222 Outline mode sets this."
4223 :type 'boolean
4224 :group 'editing-basics)
4225
4226 (defcustom line-move-visual t
4227 "When non-nil, `line-move' moves point by visual lines.
4228 This movement is based on where the cursor is displayed on the
4229 screen, instead of relying on buffer contents alone. It takes
4230 into account variable-width characters and line continuation."
4231 :type 'boolean
4232 :group 'editing-basics)
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 (truncate (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 ocurring 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 (save-excursion (beginning-of-line) (point)))
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 (save-excursion (beginning-of-line) (point))))
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
5082 (save-excursion (beginning-of-line)
5083 (point)))
5084 (if (bolp)
5085 ;; No preceding word in same line.
5086 ;; Look for following word in same line.
5087 (progn
5088 (skip-syntax-forward not-syntaxes
5089 (save-excursion (end-of-line)
5090 (point)))
5091 (setq start (point))
5092 (skip-syntax-forward syntaxes)
5093 (setq end (point)))
5094 (setq end (point))
5095 (skip-syntax-backward syntaxes)
5096 (setq start (point))))
5097 ;; If we found something nonempty, return it as a string.
5098 (unless (= start end)
5099 (buffer-substring-no-properties start end)))))
5100 \f
5101 (defcustom fill-prefix nil
5102 "String for filling to insert at front of new line, or nil for none."
5103 :type '(choice (const :tag "None" nil)
5104 string)
5105 :group 'fill)
5106 (make-variable-buffer-local 'fill-prefix)
5107 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5108
5109 (defcustom auto-fill-inhibit-regexp nil
5110 "Regexp to match lines which should not be auto-filled."
5111 :type '(choice (const :tag "None" nil)
5112 regexp)
5113 :group 'fill)
5114
5115 ;; This function is used as the auto-fill-function of a buffer
5116 ;; when Auto-Fill mode is enabled.
5117 ;; It returns t if it really did any work.
5118 ;; (Actually some major modes use a different auto-fill function,
5119 ;; but this one is the default one.)
5120 (defun do-auto-fill ()
5121 (let (fc justify give-up
5122 (fill-prefix fill-prefix))
5123 (if (or (not (setq justify (current-justification)))
5124 (null (setq fc (current-fill-column)))
5125 (and (eq justify 'left)
5126 (<= (current-column) fc))
5127 (and auto-fill-inhibit-regexp
5128 (save-excursion (beginning-of-line)
5129 (looking-at auto-fill-inhibit-regexp))))
5130 nil ;; Auto-filling not required
5131 (if (memq justify '(full center right))
5132 (save-excursion (unjustify-current-line)))
5133
5134 ;; Choose a fill-prefix automatically.
5135 (when (and adaptive-fill-mode
5136 (or (null fill-prefix) (string= fill-prefix "")))
5137 (let ((prefix
5138 (fill-context-prefix
5139 (save-excursion (backward-paragraph 1) (point))
5140 (save-excursion (forward-paragraph 1) (point)))))
5141 (and prefix (not (equal prefix ""))
5142 ;; Use auto-indentation rather than a guessed empty prefix.
5143 (not (and fill-indent-according-to-mode
5144 (string-match "\\`[ \t]*\\'" prefix)))
5145 (setq fill-prefix prefix))))
5146
5147 (while (and (not give-up) (> (current-column) fc))
5148 ;; Determine where to split the line.
5149 (let* (after-prefix
5150 (fill-point
5151 (save-excursion
5152 (beginning-of-line)
5153 (setq after-prefix (point))
5154 (and fill-prefix
5155 (looking-at (regexp-quote fill-prefix))
5156 (setq after-prefix (match-end 0)))
5157 (move-to-column (1+ fc))
5158 (fill-move-to-break-point after-prefix)
5159 (point))))
5160
5161 ;; See whether the place we found is any good.
5162 (if (save-excursion
5163 (goto-char fill-point)
5164 (or (bolp)
5165 ;; There is no use breaking at end of line.
5166 (save-excursion (skip-chars-forward " ") (eolp))
5167 ;; It is futile to split at the end of the prefix
5168 ;; since we would just insert the prefix again.
5169 (and after-prefix (<= (point) after-prefix))
5170 ;; Don't split right after a comment starter
5171 ;; since we would just make another comment starter.
5172 (and comment-start-skip
5173 (let ((limit (point)))
5174 (beginning-of-line)
5175 (and (re-search-forward comment-start-skip
5176 limit t)
5177 (eq (point) limit))))))
5178 ;; No good place to break => stop trying.
5179 (setq give-up t)
5180 ;; Ok, we have a useful place to break the line. Do it.
5181 (let ((prev-column (current-column)))
5182 ;; If point is at the fill-point, do not `save-excursion'.
5183 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5184 ;; point will end up before it rather than after it.
5185 (if (save-excursion
5186 (skip-chars-backward " \t")
5187 (= (point) fill-point))
5188 (default-indent-new-line t)
5189 (save-excursion
5190 (goto-char fill-point)
5191 (default-indent-new-line t)))
5192 ;; Now do justification, if required
5193 (if (not (eq justify 'left))
5194 (save-excursion
5195 (end-of-line 0)
5196 (justify-current-line justify nil t)))
5197 ;; If making the new line didn't reduce the hpos of
5198 ;; the end of the line, then give up now;
5199 ;; trying again will not help.
5200 (if (>= (current-column) prev-column)
5201 (setq give-up t))))))
5202 ;; Justify last line.
5203 (justify-current-line justify t t)
5204 t)))
5205
5206 (defvar comment-line-break-function 'comment-indent-new-line
5207 "*Mode-specific function which line breaks and continues a comment.
5208 This function is called during auto-filling when a comment syntax
5209 is defined.
5210 The function should take a single optional argument, which is a flag
5211 indicating whether it should use soft newlines.")
5212
5213 (defun default-indent-new-line (&optional soft)
5214 "Break line at point and indent.
5215 If a comment syntax is defined, call `comment-indent-new-line'.
5216
5217 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5218 unless optional argument SOFT is non-nil."
5219 (interactive)
5220 (if comment-start
5221 (funcall comment-line-break-function soft)
5222 ;; Insert the newline before removing empty space so that markers
5223 ;; get preserved better.
5224 (if soft (insert-and-inherit ?\n) (newline 1))
5225 (save-excursion (forward-char -1) (delete-horizontal-space))
5226 (delete-horizontal-space)
5227
5228 (if (and fill-prefix (not adaptive-fill-mode))
5229 ;; Blindly trust a non-adaptive fill-prefix.
5230 (progn
5231 (indent-to-left-margin)
5232 (insert-before-markers-and-inherit fill-prefix))
5233
5234 (cond
5235 ;; If there's an adaptive prefix, use it unless we're inside
5236 ;; a comment and the prefix is not a comment starter.
5237 (fill-prefix
5238 (indent-to-left-margin)
5239 (insert-and-inherit fill-prefix))
5240 ;; If we're not inside a comment, just try to indent.
5241 (t (indent-according-to-mode))))))
5242
5243 (defvar normal-auto-fill-function 'do-auto-fill
5244 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5245 Some major modes set this.")
5246
5247 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5248 ;; `functions' and `hooks' are usually unsafe to set, but setting
5249 ;; auto-fill-function to nil in a file-local setting is safe and
5250 ;; can be useful to prevent auto-filling.
5251 (put 'auto-fill-function 'safe-local-variable 'null)
5252 ;; FIXME: turn into a proper minor mode.
5253 ;; Add a global minor mode version of it.
5254 (define-minor-mode auto-fill-mode
5255 "Toggle Auto Fill mode.
5256 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5257 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5258 automatically breaks the line at a previous space.
5259
5260 The value of `normal-auto-fill-function' specifies the function to use
5261 for `auto-fill-function' when turning Auto Fill mode on."
5262 :variable (eq auto-fill-function normal-auto-fill-function))
5263
5264 ;; This holds a document string used to document auto-fill-mode.
5265 (defun auto-fill-function ()
5266 "Automatically break line at a previous space, in insertion of text."
5267 nil)
5268
5269 (defun turn-on-auto-fill ()
5270 "Unconditionally turn on Auto Fill mode."
5271 (auto-fill-mode 1))
5272
5273 (defun turn-off-auto-fill ()
5274 "Unconditionally turn off Auto Fill mode."
5275 (auto-fill-mode -1))
5276
5277 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5278
5279 (defun set-fill-column (arg)
5280 "Set `fill-column' to specified argument.
5281 Use \\[universal-argument] followed by a number to specify a column.
5282 Just \\[universal-argument] as argument means to use the current column."
5283 (interactive
5284 (list (or current-prefix-arg
5285 ;; We used to use current-column silently, but C-x f is too easily
5286 ;; typed as a typo for C-x C-f, so we turned it into an error and
5287 ;; now an interactive prompt.
5288 (read-number "Set fill-column to: " (current-column)))))
5289 (if (consp arg)
5290 (setq arg (current-column)))
5291 (if (not (integerp arg))
5292 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5293 (error "set-fill-column requires an explicit argument")
5294 (message "Fill column set to %d (was %d)" arg fill-column)
5295 (setq fill-column arg)))
5296 \f
5297 (defun set-selective-display (arg)
5298 "Set `selective-display' to ARG; clear it if no arg.
5299 When the value of `selective-display' is a number > 0,
5300 lines whose indentation is >= that value are not displayed.
5301 The variable `selective-display' has a separate value for each buffer."
5302 (interactive "P")
5303 (if (eq selective-display t)
5304 (error "selective-display already in use for marked lines"))
5305 (let ((current-vpos
5306 (save-restriction
5307 (narrow-to-region (point-min) (point))
5308 (goto-char (window-start))
5309 (vertical-motion (window-height)))))
5310 (setq selective-display
5311 (and arg (prefix-numeric-value arg)))
5312 (recenter current-vpos))
5313 (set-window-start (selected-window) (window-start (selected-window)))
5314 (princ "selective-display set to " t)
5315 (prin1 selective-display t)
5316 (princ "." t))
5317
5318 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5319
5320 (defun toggle-truncate-lines (&optional arg)
5321 "Toggle whether to fold or truncate long lines for the current buffer.
5322 With prefix argument ARG, truncate long lines if ARG is positive,
5323 otherwise don't truncate them. Note that in side-by-side windows,
5324 this command has no effect if `truncate-partial-width-windows'
5325 is non-nil."
5326 (interactive "P")
5327 (setq truncate-lines
5328 (if (null arg)
5329 (not truncate-lines)
5330 (> (prefix-numeric-value arg) 0)))
5331 (force-mode-line-update)
5332 (unless truncate-lines
5333 (let ((buffer (current-buffer)))
5334 (walk-windows (lambda (window)
5335 (if (eq buffer (window-buffer window))
5336 (set-window-hscroll window 0)))
5337 nil t)))
5338 (message "Truncate long lines %s"
5339 (if truncate-lines "enabled" "disabled")))
5340
5341 (defun toggle-word-wrap (&optional arg)
5342 "Toggle whether to use word-wrapping for continuation lines.
5343 With prefix argument ARG, wrap continuation lines at word boundaries
5344 if ARG is positive, otherwise wrap them at the right screen edge.
5345 This command toggles the value of `word-wrap'. It has no effect
5346 if long lines are truncated."
5347 (interactive "P")
5348 (setq word-wrap
5349 (if (null arg)
5350 (not word-wrap)
5351 (> (prefix-numeric-value arg) 0)))
5352 (force-mode-line-update)
5353 (message "Word wrapping %s"
5354 (if word-wrap "enabled" "disabled")))
5355
5356 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5357 "The string displayed in the mode line when in overwrite mode.")
5358 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5359 "The string displayed in the mode line when in binary overwrite mode.")
5360
5361 (define-minor-mode overwrite-mode
5362 "Toggle overwrite mode.
5363 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5364 otherwise turn it off. In overwrite mode, printing characters typed
5365 in replace existing text on a one-for-one basis, rather than pushing
5366 it to the right. At the end of a line, such characters extend the line.
5367 Before a tab, such characters insert until the tab is filled in.
5368 \\[quoted-insert] still inserts characters in overwrite mode; this
5369 is supposed to make it easier to insert characters when necessary."
5370 :variable (eq overwrite-mode 'overwrite-mode-textual))
5371
5372 (define-minor-mode binary-overwrite-mode
5373 "Toggle binary overwrite mode.
5374 With prefix argument ARG, turn binary overwrite mode on if ARG is
5375 positive, otherwise turn it off. In binary overwrite mode, printing
5376 characters typed in replace existing text. Newlines are not treated
5377 specially, so typing at the end of a line joins the line to the next,
5378 with the typed character between them. Typing before a tab character
5379 simply replaces the tab with the character typed. \\[quoted-insert]
5380 replaces the text at the cursor, just as ordinary typing characters do.
5381
5382 Note that binary overwrite mode is not its own minor mode; it is a
5383 specialization of overwrite mode, entered by setting the
5384 `overwrite-mode' variable to `overwrite-mode-binary'."
5385 :variable (eq overwrite-mode 'overwrite-mode-binary))
5386
5387 (define-minor-mode line-number-mode
5388 "Toggle Line Number mode.
5389 With ARG, turn Line Number mode on if ARG is positive, otherwise
5390 turn it off. When Line Number mode is enabled, the line number
5391 appears in the mode line.
5392
5393 Line numbers do not appear for very large buffers and buffers
5394 with very long lines; see variables `line-number-display-limit'
5395 and `line-number-display-limit-width'."
5396 :init-value t :global t :group 'mode-line)
5397
5398 (define-minor-mode column-number-mode
5399 "Toggle Column Number mode.
5400 With ARG, turn Column Number mode on if ARG is positive,
5401 otherwise turn it off. When Column Number mode is enabled, the
5402 column number appears in the mode line."
5403 :global t :group 'mode-line)
5404
5405 (define-minor-mode size-indication-mode
5406 "Toggle Size Indication mode.
5407 With ARG, turn Size Indication mode on if ARG is positive,
5408 otherwise turn it off. When Size Indication mode is enabled, the
5409 size of the accessible part of the buffer appears in the mode line."
5410 :global t :group 'mode-line)
5411
5412 (define-minor-mode auto-save-mode
5413 "Toggle auto-saving of contents of current buffer.
5414 With prefix argument ARG, turn auto-saving on if positive, else off."
5415 :variable ((and buffer-auto-save-file-name
5416 ;; If auto-save is off because buffer has shrunk,
5417 ;; then toggling should turn it on.
5418 (>= buffer-saved-size 0))
5419 . (lambda (val)
5420 (setq buffer-auto-save-file-name
5421 (cond
5422 ((null val) nil)
5423 ((and buffer-file-name auto-save-visited-file-name
5424 (not buffer-read-only))
5425 buffer-file-name)
5426 (t (make-auto-save-file-name))))))
5427 ;; If -1 was stored here, to temporarily turn off saving,
5428 ;; turn it back on.
5429 (and (< buffer-saved-size 0)
5430 (setq buffer-saved-size 0)))
5431 \f
5432 (defgroup paren-blinking nil
5433 "Blinking matching of parens and expressions."
5434 :prefix "blink-matching-"
5435 :group 'paren-matching)
5436
5437 (defcustom blink-matching-paren t
5438 "Non-nil means show matching open-paren when close-paren is inserted."
5439 :type 'boolean
5440 :group 'paren-blinking)
5441
5442 (defcustom blink-matching-paren-on-screen t
5443 "Non-nil means show matching open-paren when it is on screen.
5444 If nil, don't show it (but the open-paren can still be shown
5445 when it is off screen).
5446
5447 This variable has no effect if `blink-matching-paren' is nil.
5448 \(In that case, the open-paren is never shown.)
5449 It is also ignored if `show-paren-mode' is enabled."
5450 :type 'boolean
5451 :group 'paren-blinking)
5452
5453 (defcustom blink-matching-paren-distance (* 100 1024)
5454 "If non-nil, maximum distance to search backwards for matching open-paren.
5455 If nil, search stops at the beginning of the accessible portion of the buffer."
5456 :version "23.2" ; 25->100k
5457 :type '(choice (const nil) integer)
5458 :group 'paren-blinking)
5459
5460 (defcustom blink-matching-delay 1
5461 "Time in seconds to delay after showing a matching paren."
5462 :type 'number
5463 :group 'paren-blinking)
5464
5465 (defcustom blink-matching-paren-dont-ignore-comments nil
5466 "If nil, `blink-matching-paren' ignores comments.
5467 More precisely, when looking for the matching parenthesis,
5468 it skips the contents of comments that end before point."
5469 :type 'boolean
5470 :group 'paren-blinking)
5471
5472 (defun blink-matching-check-mismatch (start end)
5473 "Return whether or not START...END are matching parens.
5474 END is the current point and START is the blink position.
5475 START might be nil if no matching starter was found.
5476 Returns non-nil if we find there is a mismatch."
5477 (let* ((end-syntax (syntax-after (1- end)))
5478 (matching-paren (and (consp end-syntax)
5479 (eq (syntax-class end-syntax) 5)
5480 (cdr end-syntax))))
5481 ;; For self-matched chars like " and $, we can't know when they're
5482 ;; mismatched or unmatched, so we can only do it for parens.
5483 (when matching-paren
5484 (not (and start
5485 (or
5486 (eq (char-after start) matching-paren)
5487 ;; The cdr might hold a new paren-class info rather than
5488 ;; a matching-char info, in which case the two CDRs
5489 ;; should match.
5490 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5491
5492 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5493 "Function to check parentheses mismatches.
5494 The function takes two arguments (START and END) where START is the
5495 position just before the opening token and END is the position right after.
5496 START can be nil, if it was not found.
5497 The function should return non-nil if the two tokens do not match.")
5498
5499 (defun blink-matching-open ()
5500 "Move cursor momentarily to the beginning of the sexp before point."
5501 (interactive)
5502 (when (and (not (bobp))
5503 blink-matching-paren)
5504 (let* ((oldpos (point))
5505 (message-log-max nil) ; Don't log messages about paren matching.
5506 (blinkpos
5507 (save-excursion
5508 (save-restriction
5509 (if blink-matching-paren-distance
5510 (narrow-to-region
5511 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5512 (- (point) blink-matching-paren-distance))
5513 oldpos))
5514 (let ((parse-sexp-ignore-comments
5515 (and parse-sexp-ignore-comments
5516 (not blink-matching-paren-dont-ignore-comments))))
5517 (condition-case ()
5518 (progn
5519 (forward-sexp -1)
5520 ;; backward-sexp skips backward over prefix chars,
5521 ;; so move back to the matching paren.
5522 (while (and (< (point) (1- oldpos))
5523 (let ((code (car (syntax-after (point)))))
5524 (or (eq (logand 65536 code) 6)
5525 (eq (logand 1048576 code) 1048576))))
5526 (forward-char 1))
5527 (point))
5528 (error nil))))))
5529 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5530 (cond
5531 (mismatch
5532 (if blinkpos
5533 (if (minibufferp)
5534 (minibuffer-message " [Mismatched parentheses]")
5535 (message "Mismatched parentheses"))
5536 (if (minibufferp)
5537 (minibuffer-message " [Unmatched parenthesis]")
5538 (message "Unmatched parenthesis"))))
5539 ((pos-visible-in-window-p blinkpos)
5540 ;; Matching open within window, temporarily move to blinkpos but only
5541 ;; if `blink-matching-paren-on-screen' is non-nil.
5542 (and blink-matching-paren-on-screen
5543 (not show-paren-mode)
5544 (save-excursion
5545 (goto-char blinkpos)
5546 (sit-for blink-matching-delay))))
5547 (t
5548 (save-excursion
5549 (goto-char blinkpos)
5550 (let ((open-paren-line-string
5551 ;; Show what precedes the open in its line, if anything.
5552 (cond
5553 ((save-excursion (skip-chars-backward " \t") (not (bolp)))
5554 (buffer-substring (line-beginning-position)
5555 (1+ blinkpos)))
5556 ;; Show what follows the open in its line, if anything.
5557 ((save-excursion
5558 (forward-char 1)
5559 (skip-chars-forward " \t")
5560 (not (eolp)))
5561 (buffer-substring blinkpos
5562 (line-end-position)))
5563 ;; Otherwise show the previous nonblank line,
5564 ;; if there is one.
5565 ((save-excursion (skip-chars-backward "\n \t") (not (bobp)))
5566 (concat
5567 (buffer-substring (progn
5568 (skip-chars-backward "\n \t")
5569 (line-beginning-position))
5570 (progn (end-of-line)
5571 (skip-chars-backward " \t")
5572 (point)))
5573 ;; Replace the newline and other whitespace with `...'.
5574 "..."
5575 (buffer-substring blinkpos (1+ blinkpos))))
5576 ;; There is nothing to show except the char itself.
5577 (t (buffer-substring blinkpos (1+ blinkpos))))))
5578 (message "Matches %s"
5579 (substring-no-properties open-paren-line-string)))))))))
5580
5581 (defvar blink-paren-function 'blink-matching-open
5582 "Function called, if non-nil, whenever a close parenthesis is inserted.
5583 More precisely, a char with closeparen syntax is self-inserted.")
5584
5585 (defun blink-paren-post-self-insert-function ()
5586 (when (and (eq (char-before) last-command-event) ; Sanity check.
5587 (memq (char-syntax last-command-event) '(?\) ?\$))
5588 blink-paren-function
5589 (not executing-kbd-macro)
5590 (not noninteractive)
5591 ;; Verify an even number of quoting characters precede the close.
5592 (= 1 (logand 1 (- (point)
5593 (save-excursion
5594 (forward-char -1)
5595 (skip-syntax-backward "/\\")
5596 (point))))))
5597 (funcall blink-paren-function)))
5598
5599 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5600 ;; Most likely, this hook is nil, so this arg doesn't matter,
5601 ;; but I use it as a reminder that this function usually
5602 ;; likes to be run after others since it does `sit-for'.
5603 'append)
5604 \f
5605 ;; This executes C-g typed while Emacs is waiting for a command.
5606 ;; Quitting out of a program does not go through here;
5607 ;; that happens in the QUIT macro at the C code level.
5608 (defun keyboard-quit ()
5609 "Signal a `quit' condition.
5610 During execution of Lisp code, this character causes a quit directly.
5611 At top-level, as an editor command, this simply beeps."
5612 (interactive)
5613 ;; Avoid adding the region to the window selection.
5614 (setq saved-region-selection nil)
5615 (let (select-active-regions)
5616 (deactivate-mark))
5617 (if (fboundp 'kmacro-keyboard-quit)
5618 (kmacro-keyboard-quit))
5619 (setq defining-kbd-macro 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 (define-mail-user-agent 'sendmail-user-agent
5726 'sendmail-user-agent-compose
5727 'mail-send-and-exit)
5728
5729 (defun rfc822-goto-eoh ()
5730 ;; Go to header delimiter line in a mail message, following RFC822 rules
5731 (goto-char (point-min))
5732 (when (re-search-forward
5733 "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move)
5734 (goto-char (match-beginning 0))))
5735
5736 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
5737 switch-function yank-action
5738 send-actions)
5739 (if switch-function
5740 (let ((special-display-buffer-names nil)
5741 (special-display-regexps nil)
5742 (same-window-buffer-names nil)
5743 (same-window-regexps nil))
5744 (funcall switch-function "*mail*")))
5745 (let ((cc (cdr (assoc-string "cc" other-headers t)))
5746 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
5747 (body (cdr (assoc-string "body" other-headers t))))
5748 (or (mail continue to subject in-reply-to cc yank-action send-actions)
5749 continue
5750 (error "Message aborted"))
5751 (save-excursion
5752 (rfc822-goto-eoh)
5753 (while other-headers
5754 (unless (member-ignore-case (car (car other-headers))
5755 '("in-reply-to" "cc" "body"))
5756 (insert (car (car other-headers)) ": "
5757 (cdr (car other-headers))
5758 (if use-hard-newlines hard-newline "\n")))
5759 (setq other-headers (cdr other-headers)))
5760 (when body
5761 (forward-line 1)
5762 (insert body))
5763 t)))
5764
5765 (defun compose-mail (&optional to subject other-headers continue
5766 switch-function yank-action send-actions)
5767 "Start composing a mail message to send.
5768 This uses the user's chosen mail composition package
5769 as selected with the variable `mail-user-agent'.
5770 The optional arguments TO and SUBJECT specify recipients
5771 and the initial Subject field, respectively.
5772
5773 OTHER-HEADERS is an alist specifying additional
5774 header fields. Elements look like (HEADER . VALUE) where both
5775 HEADER and VALUE are strings.
5776
5777 CONTINUE, if non-nil, says to continue editing a message already
5778 being composed. Interactively, CONTINUE is the prefix argument.
5779
5780 SWITCH-FUNCTION, if non-nil, is a function to use to
5781 switch to and display the buffer used for mail composition.
5782
5783 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5784 to insert the raw text of the message being replied to.
5785 It has the form (FUNCTION . ARGS). The user agent will apply
5786 FUNCTION to ARGS, to insert the raw text of the original message.
5787 \(The user agent will also run `mail-citation-hook', *after* the
5788 original text has been inserted in this way.)
5789
5790 SEND-ACTIONS is a list of actions to call when the message is sent.
5791 Each action has the form (FUNCTION . ARGS)."
5792 (interactive
5793 (list nil nil nil current-prefix-arg))
5794
5795 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5796 ;; from sendmail-user-agent to message-user-agent. Some users may
5797 ;; encounter incompatibilities. This hack tries to detect problems
5798 ;; and warn about them.
5799 (and compose-mail-user-agent-warnings
5800 (eq mail-user-agent 'message-user-agent)
5801 (let (warn-vars)
5802 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5803 mail-yank-hooks mail-archive-file-name
5804 mail-default-reply-to mail-mailing-lists
5805 mail-self-blind))
5806 (and (boundp var)
5807 (symbol-value var)
5808 (push var warn-vars)))
5809 (when warn-vars
5810 (display-warning 'mail
5811 (format "\
5812 The default mail mode is now Message mode.
5813 You have the following Mail mode variable%s customized:
5814 \n %s\n\nTo use Mail mode, set `mail-user-agent' to sendmail-user-agent.
5815 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5816 (if (> (length warn-vars) 1) "s" "")
5817 (mapconcat 'symbol-name
5818 warn-vars " "))))))
5819
5820 (let ((function (get mail-user-agent 'composefunc)))
5821 (funcall function to subject other-headers continue
5822 switch-function yank-action send-actions)))
5823
5824 (defun compose-mail-other-window (&optional to subject other-headers continue
5825 yank-action send-actions)
5826 "Like \\[compose-mail], but edit the outgoing message in another window."
5827 (interactive
5828 (list nil nil nil current-prefix-arg))
5829 (compose-mail to subject other-headers continue
5830 'switch-to-buffer-other-window yank-action send-actions))
5831
5832
5833 (defun compose-mail-other-frame (&optional to subject other-headers continue
5834 yank-action send-actions)
5835 "Like \\[compose-mail], but edit the outgoing message in another frame."
5836 (interactive
5837 (list nil nil nil current-prefix-arg))
5838 (compose-mail to subject other-headers continue
5839 'switch-to-buffer-other-frame yank-action send-actions))
5840 \f
5841 (defvar set-variable-value-history nil
5842 "History of values entered with `set-variable'.
5843
5844 Maximum length of the history list is determined by the value
5845 of `history-length', which see.")
5846
5847 (defun set-variable (variable value &optional make-local)
5848 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5849 VARIABLE should be a user option variable name, a Lisp variable
5850 meant to be customized by users. You should enter VALUE in Lisp syntax,
5851 so if you want VALUE to be a string, you must surround it with doublequotes.
5852 VALUE is used literally, not evaluated.
5853
5854 If VARIABLE has a `variable-interactive' property, that is used as if
5855 it were the arg to `interactive' (which see) to interactively read VALUE.
5856
5857 If VARIABLE has been defined with `defcustom', then the type information
5858 in the definition is used to check that VALUE is valid.
5859
5860 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5861 (interactive
5862 (let* ((default-var (variable-at-point))
5863 (var (if (user-variable-p default-var)
5864 (read-variable (format "Set variable (default %s): " default-var)
5865 default-var)
5866 (read-variable "Set variable: ")))
5867 (minibuffer-help-form '(describe-variable var))
5868 (prop (get var 'variable-interactive))
5869 (obsolete (car (get var 'byte-obsolete-variable)))
5870 (prompt (format "Set %s %s to value: " var
5871 (cond ((local-variable-p var)
5872 "(buffer-local)")
5873 ((or current-prefix-arg
5874 (local-variable-if-set-p var))
5875 "buffer-locally")
5876 (t "globally"))))
5877 (val (progn
5878 (when obsolete
5879 (message (concat "`%S' is obsolete; "
5880 (if (symbolp obsolete) "use `%S' instead" "%s"))
5881 var obsolete)
5882 (sit-for 3))
5883 (if prop
5884 ;; Use VAR's `variable-interactive' property
5885 ;; as an interactive spec for prompting.
5886 (call-interactively `(lambda (arg)
5887 (interactive ,prop)
5888 arg))
5889 (read
5890 (read-string prompt nil
5891 'set-variable-value-history
5892 (format "%S" (symbol-value var))))))))
5893 (list var val current-prefix-arg)))
5894
5895 (and (custom-variable-p variable)
5896 (not (get variable 'custom-type))
5897 (custom-load-symbol variable))
5898 (let ((type (get variable 'custom-type)))
5899 (when type
5900 ;; Match with custom type.
5901 (require 'cus-edit)
5902 (setq type (widget-convert type))
5903 (unless (widget-apply type :match value)
5904 (error "Value `%S' does not match type %S of %S"
5905 value (car type) variable))))
5906
5907 (if make-local
5908 (make-local-variable variable))
5909
5910 (set variable value)
5911
5912 ;; Force a thorough redisplay for the case that the variable
5913 ;; has an effect on the display, like `tab-width' has.
5914 (force-mode-line-update))
5915 \f
5916 ;; Define the major mode for lists of completions.
5917
5918 (defvar completion-list-mode-map
5919 (let ((map (make-sparse-keymap)))
5920 (define-key map [mouse-2] 'mouse-choose-completion)
5921 (define-key map [follow-link] 'mouse-face)
5922 (define-key map [down-mouse-2] nil)
5923 (define-key map "\C-m" 'choose-completion)
5924 (define-key map "\e\e\e" 'delete-completion-window)
5925 (define-key map [left] 'previous-completion)
5926 (define-key map [right] 'next-completion)
5927 (define-key map "q" 'quit-window)
5928 map)
5929 "Local map for completion list buffers.")
5930
5931 ;; Completion mode is suitable only for specially formatted data.
5932 (put 'completion-list-mode 'mode-class 'special)
5933
5934 (defvar completion-reference-buffer nil
5935 "Record the buffer that was current when the completion list was requested.
5936 This is a local variable in the completion list buffer.
5937 Initial value is nil to avoid some compiler warnings.")
5938
5939 (defvar completion-no-auto-exit nil
5940 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5941 This also applies to other functions such as `choose-completion'.")
5942
5943 (defvar completion-base-position nil
5944 "Position of the base of the text corresponding to the shown completions.
5945 This variable is used in the *Completions* buffers.
5946 Its value is a list of the form (START END) where START is the place
5947 where the completion should be inserted and END (if non-nil) is the end
5948 of the text to replace. If END is nil, point is used instead.")
5949
5950 (defvar completion-base-size nil
5951 "Number of chars before point not involved in completion.
5952 This is a local variable in the completion list buffer.
5953 It refers to the chars in the minibuffer if completing in the
5954 minibuffer, or in `completion-reference-buffer' otherwise.
5955 Only characters in the field at point are included.
5956
5957 If nil, Emacs determines which part of the tail end of the
5958 buffer's text is involved in completion by comparing the text
5959 directly.")
5960 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5961
5962 (defun delete-completion-window ()
5963 "Delete the completion list window.
5964 Go to the window from which completion was requested."
5965 (interactive)
5966 (let ((buf completion-reference-buffer))
5967 (if (one-window-p t)
5968 (if (window-dedicated-p (selected-window))
5969 (delete-frame (selected-frame)))
5970 (delete-window (selected-window))
5971 (if (get-buffer-window buf)
5972 (select-window (get-buffer-window buf))))))
5973
5974 (defun previous-completion (n)
5975 "Move to the previous item in the completion list."
5976 (interactive "p")
5977 (next-completion (- n)))
5978
5979 (defun next-completion (n)
5980 "Move to the next item in the completion list.
5981 With prefix argument N, move N items (negative N means move backward)."
5982 (interactive "p")
5983 (let ((beg (point-min)) (end (point-max)))
5984 (while (and (> n 0) (not (eobp)))
5985 ;; If in a completion, move to the end of it.
5986 (when (get-text-property (point) 'mouse-face)
5987 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5988 ;; Move to start of next one.
5989 (unless (get-text-property (point) 'mouse-face)
5990 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5991 (setq n (1- n)))
5992 (while (and (< n 0) (not (bobp)))
5993 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5994 ;; If in a completion, move to the start of it.
5995 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5996 (goto-char (previous-single-property-change
5997 (point) 'mouse-face nil beg)))
5998 ;; Move to end of the previous completion.
5999 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6000 (goto-char (previous-single-property-change
6001 (point) 'mouse-face nil beg)))
6002 ;; Move to the start of that one.
6003 (goto-char (previous-single-property-change
6004 (point) 'mouse-face nil beg))
6005 (setq n (1+ n))))))
6006
6007 (defun choose-completion (&optional event)
6008 "Choose the completion at point."
6009 (interactive (list last-nonmenu-event))
6010 ;; In case this is run via the mouse, give temporary modes such as
6011 ;; isearch a chance to turn off.
6012 (run-hooks 'mouse-leave-buffer-hook)
6013 (let (buffer base-size base-position choice)
6014 (with-current-buffer (window-buffer (posn-window (event-start event)))
6015 (setq buffer completion-reference-buffer)
6016 (setq base-size completion-base-size)
6017 (setq base-position completion-base-position)
6018 (save-excursion
6019 (goto-char (posn-point (event-start event)))
6020 (let (beg end)
6021 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
6022 (setq end (point) beg (1+ (point))))
6023 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
6024 (setq end (1- (point)) beg (point)))
6025 (if (null beg)
6026 (error "No completion here"))
6027 (setq beg (previous-single-property-change beg 'mouse-face))
6028 (setq end (or (next-single-property-change end 'mouse-face)
6029 (point-max)))
6030 (setq choice (buffer-substring-no-properties beg end)))))
6031
6032 (let ((owindow (selected-window)))
6033 (select-window (posn-window (event-start event)))
6034 (if (and (one-window-p t 'selected-frame)
6035 (window-dedicated-p (selected-window)))
6036 ;; This is a special buffer's frame
6037 (iconify-frame (selected-frame))
6038 (or (window-dedicated-p (selected-window))
6039 (bury-buffer)))
6040 (select-window
6041 (or (and (buffer-live-p buffer)
6042 (get-buffer-window buffer 0))
6043 owindow)))
6044
6045 (choose-completion-string
6046 choice buffer
6047 (or base-position
6048 (when base-size
6049 ;; Someone's using old completion code that doesn't know
6050 ;; about base-position yet.
6051 (list (+ base-size (with-current-buffer buffer (field-beginning)))))
6052 ;; If all else fails, just guess.
6053 (with-current-buffer buffer
6054 (list (choose-completion-guess-base-position choice)))))))
6055
6056 ;; Delete the longest partial match for STRING
6057 ;; that can be found before POINT.
6058 (defun choose-completion-guess-base-position (string)
6059 (save-excursion
6060 (let ((opoint (point))
6061 len)
6062 ;; Try moving back by the length of the string.
6063 (goto-char (max (- (point) (length string))
6064 (minibuffer-prompt-end)))
6065 ;; See how far back we were actually able to move. That is the
6066 ;; upper bound on how much we can match and delete.
6067 (setq len (- opoint (point)))
6068 (if completion-ignore-case
6069 (setq string (downcase string)))
6070 (while (and (> len 0)
6071 (let ((tail (buffer-substring (point) opoint)))
6072 (if completion-ignore-case
6073 (setq tail (downcase tail)))
6074 (not (string= tail (substring string 0 len)))))
6075 (setq len (1- len))
6076 (forward-char 1))
6077 (point))))
6078
6079 (defun choose-completion-delete-max-match (string)
6080 (delete-region (choose-completion-guess-base-position string) (point)))
6081 (make-obsolete 'choose-completion-delete-max-match
6082 'choose-completion-guess-base-position "23.2")
6083
6084 (defvar choose-completion-string-functions nil
6085 "Functions that may override the normal insertion of a completion choice.
6086 These functions are called in order with four arguments:
6087 CHOICE - the string to insert in the buffer,
6088 BUFFER - the buffer in which the choice should be inserted,
6089 MINI-P - non-nil if BUFFER is a minibuffer, and
6090 BASE-SIZE - the number of characters in BUFFER before
6091 the string being completed.
6092
6093 If a function in the list returns non-nil, that function is supposed
6094 to have inserted the CHOICE in the BUFFER, and possibly exited
6095 the minibuffer; no further functions will be called.
6096
6097 If all functions in the list return nil, that means to use
6098 the default method of inserting the completion in BUFFER.")
6099
6100 (defun choose-completion-string (choice &optional buffer base-position)
6101 "Switch to BUFFER and insert the completion choice CHOICE.
6102 BASE-POSITION, says where to insert the completion."
6103
6104 ;; If BUFFER is the minibuffer, exit the minibuffer
6105 ;; unless it is reading a file name and CHOICE is a directory,
6106 ;; or completion-no-auto-exit is non-nil.
6107
6108 ;; Some older code may call us passing `base-size' instead of
6109 ;; `base-position'. It's difficult to make any use of `base-size',
6110 ;; so we just ignore it.
6111 (unless (consp base-position)
6112 (message "Obsolete `base-size' passed to choose-completion-string")
6113 (setq base-position nil))
6114
6115 (let* ((buffer (or buffer completion-reference-buffer))
6116 (mini-p (minibufferp buffer)))
6117 ;; If BUFFER is a minibuffer, barf unless it's the currently
6118 ;; active minibuffer.
6119 (if (and mini-p
6120 (or (not (active-minibuffer-window))
6121 (not (equal buffer
6122 (window-buffer (active-minibuffer-window))))))
6123 (error "Minibuffer is not active for completion")
6124 ;; Set buffer so buffer-local choose-completion-string-functions works.
6125 (set-buffer buffer)
6126 (unless (run-hook-with-args-until-success
6127 'choose-completion-string-functions
6128 ;; The fourth arg used to be `mini-p' but was useless
6129 ;; (since minibufferp can be used on the `buffer' arg)
6130 ;; and indeed unused. The last used to be `base-size', so we
6131 ;; keep it to try and avoid breaking old code.
6132 choice buffer base-position nil)
6133 ;; Insert the completion into the buffer where it was requested.
6134 (delete-region (or (car base-position) (point))
6135 (or (cadr base-position) (point)))
6136 (insert choice)
6137 (remove-text-properties (- (point) (length choice)) (point)
6138 '(mouse-face nil))
6139 ;; Update point in the window that BUFFER is showing in.
6140 (let ((window (get-buffer-window buffer t)))
6141 (set-window-point window (point)))
6142 ;; If completing for the minibuffer, exit it with this choice.
6143 (and (not completion-no-auto-exit)
6144 (minibufferp buffer)
6145 minibuffer-completion-table
6146 ;; If this is reading a file name, and the file name chosen
6147 ;; is a directory, don't exit the minibuffer.
6148 (let* ((result (buffer-substring (field-beginning) (point)))
6149 (bounds
6150 (completion-boundaries result minibuffer-completion-table
6151 minibuffer-completion-predicate
6152 "")))
6153 (if (eq (car bounds) (length result))
6154 ;; The completion chosen leads to a new set of completions
6155 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6156 (let ((mini (active-minibuffer-window)))
6157 (select-window mini)
6158 (when minibuffer-auto-raise
6159 (raise-frame (window-frame mini))))
6160 (exit-minibuffer))))))))
6161
6162 (define-derived-mode completion-list-mode nil "Completion List"
6163 "Major mode for buffers showing lists of possible completions.
6164 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
6165 to select the completion near point.
6166 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
6167 with the mouse.
6168
6169 \\{completion-list-mode-map}"
6170 (set (make-local-variable 'completion-base-size) nil))
6171
6172 (defun completion-list-mode-finish ()
6173 "Finish setup of the completions buffer.
6174 Called from `temp-buffer-show-hook'."
6175 (when (eq major-mode 'completion-list-mode)
6176 (toggle-read-only 1)))
6177
6178 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6179
6180
6181 ;; Variables and faces used in `completion-setup-function'.
6182
6183 (defcustom completion-show-help t
6184 "Non-nil means show help message in *Completions* buffer."
6185 :type 'boolean
6186 :version "22.1"
6187 :group 'completion)
6188
6189 ;; This function goes in completion-setup-hook, so that it is called
6190 ;; after the text of the completion list buffer is written.
6191 (defun completion-setup-function ()
6192 (let* ((mainbuf (current-buffer))
6193 (base-dir
6194 ;; When reading a file name in the minibuffer,
6195 ;; try and find the right default-directory to set in the
6196 ;; completion list buffer.
6197 ;; FIXME: Why do we do that, actually? --Stef
6198 (if minibuffer-completing-file-name
6199 (file-name-as-directory
6200 (expand-file-name
6201 (substring (minibuffer-completion-contents)
6202 0 (or completion-base-size 0)))))))
6203 (with-current-buffer standard-output
6204 (let ((base-size completion-base-size) ;Read before killing localvars.
6205 (base-position completion-base-position))
6206 (completion-list-mode)
6207 (set (make-local-variable 'completion-base-size) base-size)
6208 (set (make-local-variable 'completion-base-position) base-position))
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 (old-state (lookup-key local-function-key-map [delete])))
6621
6622 (if enabled
6623 (progn
6624 (define-key local-function-key-map [delete] [?\C-d])
6625 (define-key local-function-key-map [kp-delete] [?\C-d])
6626 (define-key local-function-key-map [backspace] [?\C-?])
6627 (dolist (b bindings)
6628 ;; Not sure if input-decode-map is really right, but
6629 ;; keyboard-translate-table (used below) only works
6630 ;; for integer events, and key-translation-table is
6631 ;; global (like the global-map, used earlier).
6632 (define-key input-decode-map (car b) nil)
6633 (define-key input-decode-map (cadr b) nil)))
6634 (define-key local-function-key-map [delete] [?\C-?])
6635 (define-key local-function-key-map [kp-delete] [?\C-?])
6636 (define-key local-function-key-map [backspace] [?\C-?])
6637 (dolist (b bindings)
6638 (define-key input-decode-map (car b) (cadr b))
6639 (define-key input-decode-map (cadr b) (car b))))))
6640 (t
6641 (if enabled
6642 (progn
6643 (keyboard-translate ?\C-h ?\C-?)
6644 (keyboard-translate ?\C-? ?\C-d))
6645 (keyboard-translate ?\C-h ?\C-h)
6646 (keyboard-translate ?\C-? ?\C-?))))
6647
6648 (if (called-interactively-p 'interactive)
6649 (message "Delete key deletes %s"
6650 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6651 "forward" "backward")))))
6652 \f
6653 (defvar vis-mode-saved-buffer-invisibility-spec nil
6654 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6655
6656 (define-minor-mode visible-mode
6657 "Toggle Visible mode.
6658 With argument ARG turn Visible mode on if ARG is positive, otherwise
6659 turn it off.
6660
6661 Enabling Visible mode makes all invisible text temporarily visible.
6662 Disabling Visible mode turns off that effect. Visible mode works by
6663 saving the value of `buffer-invisibility-spec' and setting it to nil."
6664 :lighter " Vis"
6665 :group 'editing-basics
6666 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6667 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6668 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6669 (when visible-mode
6670 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6671 buffer-invisibility-spec)
6672 (setq buffer-invisibility-spec nil)))
6673 \f
6674 ;; Partial application of functions (similar to "currying").
6675 ;; This function is here rather than in subr.el because it uses CL.
6676 (defun apply-partially (fun &rest args)
6677 "Return a function that is a partial application of FUN to ARGS.
6678 ARGS is a list of the first N arguments to pass to FUN.
6679 The result is a new function which does the same as FUN, except that
6680 the first N arguments are fixed at the values with which this function
6681 was called."
6682 (lexical-let ((fun fun) (args1 args))
6683 (lambda (&rest args2) (apply fun (append args1 args2)))))
6684 \f
6685 ;; Minibuffer prompt stuff.
6686
6687 ;(defun minibuffer-prompt-modification (start end)
6688 ; (error "You cannot modify the prompt"))
6689 ;
6690 ;
6691 ;(defun minibuffer-prompt-insertion (start end)
6692 ; (let ((inhibit-modification-hooks t))
6693 ; (delete-region start end)
6694 ; ;; Discard undo information for the text insertion itself
6695 ; ;; and for the text deletion.above.
6696 ; (when (consp buffer-undo-list)
6697 ; (setq buffer-undo-list (cddr buffer-undo-list)))
6698 ; (message "You cannot modify the prompt")))
6699 ;
6700 ;
6701 ;(setq minibuffer-prompt-properties
6702 ; (list 'modification-hooks '(minibuffer-prompt-modification)
6703 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6704 ;
6705
6706 \f
6707 ;;;; Problematic external packages.
6708
6709 ;; rms says this should be done by specifying symbols that define
6710 ;; versions together with bad values. This is therefore not as
6711 ;; flexible as it could be. See the thread:
6712 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6713 (defconst bad-packages-alist
6714 ;; Not sure exactly which semantic versions have problems.
6715 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6716 '((semantic semantic-version "\\`2\\.0pre[1-3]\\'"
6717 "The version of `semantic' loaded does not work in Emacs 22.
6718 It can cause constant high CPU load.
6719 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6720 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6721 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6722 ;; provided the `CUA-mode' feature. Since this is no longer true,
6723 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6724 (CUA-mode t nil
6725 "CUA-mode is now part of the standard GNU Emacs distribution,
6726 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6727
6728 You have loaded an older version of CUA-mode which does not work
6729 correctly with this version of Emacs. You should remove the old
6730 version and use the one distributed with Emacs."))
6731 "Alist of packages known to cause problems in this version of Emacs.
6732 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6733 PACKAGE is either a regular expression to match file names, or a
6734 symbol (a feature name); see the documentation of
6735 `after-load-alist', to which this variable adds functions.
6736 SYMBOL is either the name of a string variable, or `t'. Upon
6737 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6738 warning using STRING as the message.")
6739
6740 (defun bad-package-check (package)
6741 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6742 (condition-case nil
6743 (let* ((list (assoc package bad-packages-alist))
6744 (symbol (nth 1 list)))
6745 (and list
6746 (boundp symbol)
6747 (or (eq symbol t)
6748 (and (stringp (setq symbol (eval symbol)))
6749 (string-match-p (nth 2 list) symbol)))
6750 (display-warning package (nth 3 list) :warning)))
6751 (error nil)))
6752
6753 (mapc (lambda (elem)
6754 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6755 bad-packages-alist)
6756
6757
6758 (provide 'simple)
6759
6760 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
6761 ;;; simple.el ends here