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