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