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