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