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