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