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