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