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