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