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