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