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