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