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