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