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