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