(standard-latex-block-names): Add "math".
[emacs.git] / lisp / simple.el
blob155f8468d5aacdb18512a9207119ad5e8c141c5f
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 98, 99, 2000
4 ;; Free Software Foundation, Inc.
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
11 ;; any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
23 ;;; Commentary:
25 ;; A grab-bag of basic Emacs commands not specifically related to some
26 ;; major mode or to file-handling.
28 ;;; Code:
30 (eval-when-compile
31 (autoload 'widget-convert "wid-edit")
32 (autoload 'shell-mode "shell")
33 (require 'cl))
36 (defgroup killing nil
37 "Killing and yanking commands"
38 :group 'editing)
40 (defgroup paren-matching nil
41 "Highlight (un)matching of parens and expressions."
42 :group 'matching)
45 (defun fundamental-mode ()
46 "Major mode not specialized for anything in particular.
47 Other major modes are defined by comparison with this one."
48 (interactive)
49 (kill-all-local-variables))
51 ;; Making and deleting lines.
53 (defun newline (&optional arg)
54 "Insert a newline, and move to left margin of the new line if it's blank.
55 The newline is marked with the text-property `hard'.
56 With ARG, insert that many newlines.
57 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
58 (interactive "*P")
59 (barf-if-buffer-read-only)
60 ;; Inserting a newline at the end of a line produces better redisplay in
61 ;; try_window_id than inserting at the beginning of a line, and the textual
62 ;; result is the same. So, if we're at beginning of line, pretend to be at
63 ;; the end of the previous line.
64 (let ((flag (and (not (bobp))
65 (bolp)
66 ;; Make sure no functions want to be told about
67 ;; the range of the changes.
68 (not after-change-functions)
69 (not before-change-functions)
70 ;; Make sure there are no markers here.
71 (not (buffer-has-markers-at (1- (point))))
72 (not (buffer-has-markers-at (point)))
73 ;; Make sure no text properties want to know
74 ;; where the change was.
75 (not (get-char-property (1- (point)) 'modification-hooks))
76 (not (get-char-property (1- (point)) 'insert-behind-hooks))
77 (or (eobp)
78 (not (get-char-property (point) 'insert-in-front-hooks)))
79 ;; Make sure the newline before point isn't intangible.
80 (not (get-char-property (1- (point)) 'intangible))
81 ;; Make sure the newline before point isn't read-only.
82 (not (get-char-property (1- (point)) 'read-only))
83 ;; Make sure the newline before point isn't invisible.
84 (not (get-char-property (1- (point)) 'invisible))
85 ;; Make sure the newline before point has the same
86 ;; properties as the char before it (if any).
87 (< (or (previous-property-change (point)) -2)
88 (- (point) 2))))
89 (was-page-start (and (bolp)
90 (looking-at page-delimiter)))
91 (beforepos (point)))
92 (if flag (backward-char 1))
93 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
94 ;; Set last-command-char to tell self-insert what to insert.
95 (let ((last-command-char ?\n)
96 ;; Don't auto-fill if we have a numeric argument.
97 ;; Also not if flag is true (it would fill wrong line);
98 ;; there is no need to since we're at BOL.
99 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
100 (unwind-protect
101 (self-insert-command (prefix-numeric-value arg))
102 ;; If we get an error in self-insert-command, put point at right place.
103 (if flag (forward-char 1))))
104 ;; Even if we did *not* get an error, keep that forward-char;
105 ;; all further processing should apply to the newline that the user
106 ;; thinks he inserted.
108 ;; Mark the newline(s) `hard'.
109 (if use-hard-newlines
110 (set-hard-newline-properties
111 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
112 ;; If the newline leaves the previous line blank,
113 ;; and we have a left margin, delete that from the blank line.
114 (or flag
115 (save-excursion
116 (goto-char beforepos)
117 (beginning-of-line)
118 (and (looking-at "[ \t]$")
119 (> (current-left-margin) 0)
120 (delete-region (point) (progn (end-of-line) (point))))))
121 ;; Indent the line after the newline, except in one case:
122 ;; when we added the newline at the beginning of a line
123 ;; which starts a page.
124 (or was-page-start
125 (move-to-left-margin nil t)))
126 nil)
128 (defun set-hard-newline-properties (from to)
129 (let ((sticky (get-text-property from 'rear-nonsticky)))
130 (put-text-property from to 'hard 't)
131 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
132 (if (and (listp sticky) (not (memq 'hard sticky)))
133 (put-text-property from (point) 'rear-nonsticky
134 (cons 'hard sticky)))))
136 (defun open-line (arg)
137 "Insert a newline and leave point before it.
138 If there is a fill prefix and/or a left-margin, insert them on the new line
139 if the line would have been blank.
140 With arg N, insert N newlines."
141 (interactive "*p")
142 (let* ((do-fill-prefix (and fill-prefix (bolp)))
143 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
144 (loc (point)))
145 (newline arg)
146 (goto-char loc)
147 (while (> arg 0)
148 (cond ((bolp)
149 (if do-left-margin (indent-to (current-left-margin)))
150 (if do-fill-prefix (insert-and-inherit fill-prefix))))
151 (forward-line 1)
152 (setq arg (1- arg)))
153 (goto-char loc)
154 (end-of-line)))
156 (defun split-line ()
157 "Split current line, moving portion beyond point vertically down."
158 (interactive "*")
159 (skip-chars-forward " \t")
160 (let ((col (current-column))
161 (pos (point)))
162 (newline 1)
163 (indent-to col 0)
164 (goto-char pos)))
166 (defun delete-indentation (&optional arg)
167 "Join this line to previous and fix up whitespace at join.
168 If there is a fill prefix, delete it from the beginning of this line.
169 With argument, join this line to following line."
170 (interactive "*P")
171 (beginning-of-line)
172 (if arg (forward-line 1))
173 (if (eq (preceding-char) ?\n)
174 (progn
175 (delete-region (point) (1- (point)))
176 ;; If the second line started with the fill prefix,
177 ;; delete the prefix.
178 (if (and fill-prefix
179 (<= (+ (point) (length fill-prefix)) (point-max))
180 (string= fill-prefix
181 (buffer-substring (point)
182 (+ (point) (length fill-prefix)))))
183 (delete-region (point) (+ (point) (length fill-prefix))))
184 (fixup-whitespace))))
186 (defalias 'join-line #'delete-indentation) ; easier to find
188 (defun delete-blank-lines ()
189 "On blank line, delete all surrounding blank lines, leaving just one.
190 On isolated blank line, delete that one.
191 On nonblank line, delete any immediately following blank lines."
192 (interactive "*")
193 (let (thisblank singleblank)
194 (save-excursion
195 (beginning-of-line)
196 (setq thisblank (looking-at "[ \t]*$"))
197 ;; Set singleblank if there is just one blank line here.
198 (setq singleblank
199 (and thisblank
200 (not (looking-at "[ \t]*\n[ \t]*$"))
201 (or (bobp)
202 (progn (forward-line -1)
203 (not (looking-at "[ \t]*$")))))))
204 ;; Delete preceding blank lines, and this one too if it's the only one.
205 (if thisblank
206 (progn
207 (beginning-of-line)
208 (if singleblank (forward-line 1))
209 (delete-region (point)
210 (if (re-search-backward "[^ \t\n]" nil t)
211 (progn (forward-line 1) (point))
212 (point-min)))))
213 ;; Delete following blank lines, unless the current line is blank
214 ;; and there are no following blank lines.
215 (if (not (and thisblank singleblank))
216 (save-excursion
217 (end-of-line)
218 (forward-line 1)
219 (delete-region (point)
220 (if (re-search-forward "[^ \t\n]" nil t)
221 (progn (beginning-of-line) (point))
222 (point-max)))))
223 ;; Handle the special case where point is followed by newline and eob.
224 ;; Delete the line, leaving point at eob.
225 (if (looking-at "^[ \t]*\n\\'")
226 (delete-region (point) (point-max)))))
228 (defun newline-and-indent ()
229 "Insert a newline, then indent according to major mode.
230 Indentation is done using the value of `indent-line-function'.
231 In programming language modes, this is the same as TAB.
232 In some text modes, where TAB inserts a tab, this command indents to the
233 column specified by the function `current-left-margin'."
234 (interactive "*")
235 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
236 (newline)
237 (indent-according-to-mode))
239 (defun reindent-then-newline-and-indent ()
240 "Reindent current line, insert newline, then indent the new line.
241 Indentation of both lines is done according to the current major mode,
242 which means calling the current value of `indent-line-function'.
243 In programming language modes, this is the same as TAB.
244 In some text modes, where TAB inserts a tab, this indents to the
245 column specified by the function `current-left-margin'."
246 (interactive "*")
247 (save-excursion
248 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
249 (indent-according-to-mode))
250 (newline)
251 (indent-according-to-mode))
253 (defun quoted-insert (arg)
254 "Read next input character and insert it.
255 This is useful for inserting control characters.
257 If the first character you type after this command is an octal digit,
258 you should type a sequence of octal digits which specify a character code.
259 Any nondigit terminates the sequence. If the terminator is a RET,
260 it is discarded; any other terminator is used itself as input.
261 The variable `read-quoted-char-radix' specifies the radix for this feature;
262 set it to 10 or 16 to use decimal or hex instead of octal.
264 In overwrite mode, this function inserts the character anyway, and
265 does not handle octal digits specially. This means that if you use
266 overwrite as your normal editing mode, you can use this function to
267 insert characters when necessary.
269 In binary overwrite mode, this function does overwrite, and octal
270 digits are interpreted as a character code. This is intended to be
271 useful for editing binary files."
272 (interactive "*p")
273 (let ((char (if (or (not overwrite-mode)
274 (eq overwrite-mode 'overwrite-mode-binary))
275 (read-quoted-char)
276 (read-char))))
277 ;; Assume character codes 0240 - 0377 stand for characters in some
278 ;; single-byte character set, and convert them to Emacs
279 ;; characters.
280 (if (and enable-multibyte-characters
281 (>= char ?\240)
282 (<= char ?\377))
283 (setq char (unibyte-char-to-multibyte char)))
284 (if (> arg 0)
285 (if (eq overwrite-mode 'overwrite-mode-binary)
286 (delete-char arg)))
287 (while (> arg 0)
288 (insert-and-inherit char)
289 (setq arg (1- arg)))))
291 (defun forward-to-indentation (arg)
292 "Move forward ARG lines and position at first nonblank character."
293 (interactive "p")
294 (forward-line arg)
295 (skip-chars-forward " \t"))
297 (defun backward-to-indentation (arg)
298 "Move backward ARG lines and position at first nonblank character."
299 (interactive "p")
300 (forward-line (- arg))
301 (skip-chars-forward " \t"))
303 (defun back-to-indentation ()
304 "Move point to the first non-whitespace character on this line."
305 (interactive)
306 (beginning-of-line 1)
307 (skip-chars-forward " \t"))
309 (defun fixup-whitespace ()
310 "Fixup white space between objects around point.
311 Leave one space or none, according to the context."
312 (interactive "*")
313 (save-excursion
314 (delete-horizontal-space)
315 (if (or (looking-at "^\\|\\s)")
316 (save-excursion (forward-char -1)
317 (looking-at "$\\|\\s(\\|\\s'")))
319 (insert ?\ ))))
321 (defun delete-horizontal-space ()
322 "Delete all spaces and tabs around point."
323 (interactive "*")
324 (skip-chars-backward " \t")
325 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
327 (defun just-one-space ()
328 "Delete all spaces and tabs around point, leaving one space."
329 (interactive "*")
330 (skip-chars-backward " \t")
331 (if (= (following-char) ? )
332 (forward-char 1)
333 (insert ? ))
334 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
337 (defun beginning-of-buffer (&optional arg)
338 "Move point to the beginning of the buffer; leave mark at previous position.
339 With arg N, put point N/10 of the way from the beginning.
341 If the buffer is narrowed, this command uses the beginning and size
342 of the accessible part of the buffer.
344 Don't use this command in Lisp programs!
345 \(goto-char (point-min)) is faster and avoids clobbering the mark."
346 (interactive "P")
347 (push-mark)
348 (let ((size (- (point-max) (point-min))))
349 (goto-char (if arg
350 (+ (point-min)
351 (if (> size 10000)
352 ;; Avoid overflow for large buffer sizes!
353 (* (prefix-numeric-value arg)
354 (/ size 10))
355 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
356 (point-min))))
357 (if arg (forward-line 1)))
359 (defun end-of-buffer (&optional arg)
360 "Move point to the end of the buffer; leave mark at previous position.
361 With arg N, put point N/10 of the way from the end.
363 If the buffer is narrowed, this command uses the beginning and size
364 of the accessible part of the buffer.
366 Don't use this command in Lisp programs!
367 \(goto-char (point-max)) is faster and avoids clobbering the mark."
368 (interactive "P")
369 (push-mark)
370 (let ((size (- (point-max) (point-min))))
371 (goto-char (if arg
372 (- (point-max)
373 (if (> size 10000)
374 ;; Avoid overflow for large buffer sizes!
375 (* (prefix-numeric-value arg)
376 (/ size 10))
377 (/ (* size (prefix-numeric-value arg)) 10)))
378 (point-max))))
379 ;; If we went to a place in the middle of the buffer,
380 ;; adjust it to the beginning of a line.
381 (cond (arg (forward-line 1))
382 ((< (point) (window-end nil t))
383 ;; If the end of the buffer is not already on the screen,
384 ;; then scroll specially to put it near, but not at, the bottom.
385 (overlay-recenter (point))
386 (recenter -3))))
388 (defun mark-whole-buffer ()
389 "Put point at beginning and mark at end of buffer.
390 You probably should not use this function in Lisp programs;
391 it is usually a mistake for a Lisp function to use any subroutine
392 that uses or sets the mark."
393 (interactive)
394 (push-mark (point))
395 (push-mark (point-max) nil t)
396 (goto-char (point-min)))
399 ;; Counting lines, one way or another.
401 (defun goto-line (arg)
402 "Goto line ARG, counting from line 1 at beginning of buffer."
403 (interactive "NGoto line: ")
404 (setq arg (prefix-numeric-value arg))
405 (save-restriction
406 (widen)
407 (goto-char 1)
408 (if (eq selective-display t)
409 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
410 (forward-line (1- arg)))))
412 (defun count-lines-region (start end)
413 "Print number of lines and characters in the region."
414 (interactive "r")
415 (message "Region has %d lines, %d characters"
416 (count-lines start end) (- end start)))
418 (defun what-line ()
419 "Print the current buffer line number and narrowed line number of point."
420 (interactive)
421 (let ((opoint (point)) start)
422 (save-excursion
423 (save-restriction
424 (goto-char (point-min))
425 (widen)
426 (beginning-of-line)
427 (setq start (point))
428 (goto-char opoint)
429 (beginning-of-line)
430 (if (/= start 1)
431 (message "line %d (narrowed line %d)"
432 (1+ (count-lines 1 (point)))
433 (1+ (count-lines start (point))))
434 (message "Line %d" (1+ (count-lines 1 (point)))))))))
436 (defun count-lines (start end)
437 "Return number of lines between START and END.
438 This is usually the number of newlines between them,
439 but can be one more if START is not equal to END
440 and the greater of them is not at the start of a line."
441 (save-excursion
442 (save-restriction
443 (narrow-to-region start end)
444 (goto-char (point-min))
445 (if (eq selective-display t)
446 (save-match-data
447 (let ((done 0))
448 (while (re-search-forward "[\n\C-m]" nil t 40)
449 (setq done (+ 40 done)))
450 (while (re-search-forward "[\n\C-m]" nil t 1)
451 (setq done (+ 1 done)))
452 (goto-char (point-max))
453 (if (and (/= start end)
454 (not (bolp)))
455 (1+ done)
456 done)))
457 (- (buffer-size) (forward-line (buffer-size)))))))
459 (defun what-cursor-position (&optional detail)
460 "Print info on cursor position (on screen and within buffer).
461 Also describe the character after point, and give its character code
462 in octal, decimal and hex.
464 For a non-ASCII multibyte character, also give its encoding in the
465 buffer's selected coding system if the coding system encodes the
466 character safely. If the character is encoded into one byte, that
467 code is shown in hex. If the character is encoded into more than one
468 byte, just \"...\" is shown.
470 In addition, with prefix argument, show details about that character
471 in *Help* buffer. See also the command `describe-char-after'."
472 (interactive "P")
473 (let* ((char (following-char))
474 (beg (point-min))
475 (end (point-max))
476 (pos (point))
477 (total (buffer-size))
478 (percent (if (> total 50000)
479 ;; Avoid overflow from multiplying by 100!
480 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
481 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
482 (hscroll (if (= (window-hscroll) 0)
484 (format " Hscroll=%d" (window-hscroll))))
485 (col (current-column)))
486 (if (= pos end)
487 (if (or (/= beg 1) (/= end (1+ total)))
488 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
489 pos total percent beg end col hscroll)
490 (message "point=%d of %d (%d%%) column %d %s"
491 pos total percent col hscroll))
492 (let ((coding buffer-file-coding-system)
493 encoded encoding-msg)
494 (if (or (not coding)
495 (eq (coding-system-type coding) t))
496 (setq coding default-buffer-file-coding-system))
497 (if (not (char-valid-p char))
498 (setq encoding-msg
499 (format "(0%o, %d, 0x%x, invalid)" char char char))
500 (setq encoded (and (>= char 128) (encode-coding-char char coding)))
501 (setq encoding-msg
502 (if encoded
503 (format "(0%o, %d, 0x%x, file %s)"
504 char char char
505 (if (> (length encoded) 1)
506 "..."
507 (encoded-string-description encoded coding)))
508 (format "(0%o, %d, 0x%x)" char char char))))
509 (if detail
510 ;; We show the detailed information about CHAR.
511 (describe-char-after (point)))
512 (if (or (/= beg 1) (/= end (1+ total)))
513 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
514 (if (< char 256)
515 (single-key-description char)
516 (buffer-substring-no-properties (point) (1+ (point))))
517 encoding-msg pos total percent beg end col hscroll)
518 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
519 (if (< char 256)
520 (single-key-description char)
521 (buffer-substring-no-properties (point) (1+ (point))))
522 encoding-msg pos total percent col hscroll))))))
524 (defvar read-expression-map
525 (let ((m (make-sparse-keymap)))
526 (define-key m "\M-\t" 'lisp-complete-symbol)
527 (set-keymap-parent m minibuffer-local-map)
529 "Minibuffer keymap used for reading Lisp expressions.")
531 (defvar read-expression-history nil)
533 (defcustom eval-expression-print-level 4
534 "*Value to use for `print-level' when printing value in `eval-expression'."
535 :group 'lisp
536 :type 'integer
537 :version "21.1")
539 (defcustom eval-expression-print-length 12
540 "*Value to use for `print-length' when printing value in `eval-expression'."
541 :group 'lisp
542 :type '(choice (const nil) integer)
543 :version "21.1")
545 (defcustom eval-expression-debug-on-error t
546 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
547 If nil, don't change the value of `debug-on-error'."
548 :group 'lisp
549 :type 'boolean
550 :version "21.1")
552 ;; We define this, rather than making `eval' interactive,
553 ;; for the sake of completion of names like eval-region, eval-current-buffer.
554 (defun eval-expression (eval-expression-arg
555 &optional eval-expression-insert-value)
556 "Evaluate EXPRESSION and print value in minibuffer.
557 Value is also consed on to front of the variable `values'."
558 (interactive
559 (list (read-from-minibuffer "Eval: "
560 nil read-expression-map t
561 'read-expression-history)
562 current-prefix-arg))
564 (if (null eval-expression-debug-on-error)
565 (setq values (cons (eval eval-expression-arg) values))
566 (let ((old-value (make-symbol "t")) new-value)
567 ;; Bind debug-on-error to something unique so that we can
568 ;; detect when evaled code changes it.
569 (let ((debug-on-error old-value))
570 (setq values (cons (eval eval-expression-arg) values))
571 (setq new-value debug-on-error))
572 ;; If evaled code has changed the value of debug-on-error,
573 ;; propagate that change to the global binding.
574 (unless (eq old-value new-value)
575 (setq debug-on-error new-value))))
577 (let ((print-length eval-expression-print-length)
578 (print-level eval-expression-print-level))
579 (prin1 (car values)
580 (if eval-expression-insert-value (current-buffer) t))))
582 (defun edit-and-eval-command (prompt command)
583 "Prompting with PROMPT, let user edit COMMAND and eval result.
584 COMMAND is a Lisp expression. Let user edit that expression in
585 the minibuffer, then read and evaluate the result."
586 (let ((command (read-from-minibuffer prompt
587 (prin1-to-string command)
588 read-expression-map t
589 '(command-history . 1))))
590 ;; If command was added to command-history as a string,
591 ;; get rid of that. We want only evaluable expressions there.
592 (if (stringp (car command-history))
593 (setq command-history (cdr command-history)))
595 ;; If command to be redone does not match front of history,
596 ;; add it to the history.
597 (or (equal command (car command-history))
598 (setq command-history (cons command command-history)))
599 (eval command)))
601 (defun repeat-complex-command (arg)
602 "Edit and re-evaluate last complex command, or ARGth from last.
603 A complex command is one which used the minibuffer.
604 The command is placed in the minibuffer as a Lisp form for editing.
605 The result is executed, repeating the command as changed.
606 If the command has been changed or is not the most recent previous command
607 it is added to the front of the command history.
608 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
609 to get different commands to edit and resubmit."
610 (interactive "p")
611 (let ((elt (nth (1- arg) command-history))
612 newcmd)
613 (if elt
614 (progn
615 (setq newcmd
616 (let ((print-level nil)
617 (minibuffer-history-position arg)
618 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
619 (read-from-minibuffer
620 "Redo: " (prin1-to-string elt) read-expression-map t
621 (cons 'command-history arg))))
623 ;; If command was added to command-history as a string,
624 ;; get rid of that. We want only evaluable expressions there.
625 (if (stringp (car command-history))
626 (setq command-history (cdr command-history)))
628 ;; If command to be redone does not match front of history,
629 ;; add it to the history.
630 (or (equal newcmd (car command-history))
631 (setq command-history (cons newcmd command-history)))
632 (eval newcmd))
633 (ding))))
635 (defvar minibuffer-history nil
636 "Default minibuffer history list.
637 This is used for all minibuffer input
638 except when an alternate history list is specified.")
639 (defvar minibuffer-history-sexp-flag nil
640 "Non-nil when doing history operations on `command-history'.
641 More generally, indicates that the history list being acted on
642 contains expressions rather than strings.
643 It is only valid if its value equals the current minibuffer depth,
644 to handle recursive uses of the minibuffer.")
645 (setq minibuffer-history-variable 'minibuffer-history)
646 (setq minibuffer-history-position nil)
647 (defvar minibuffer-history-search-history nil)
649 (mapcar
650 (lambda (key-and-command)
651 (mapcar
652 (lambda (keymap-and-completionp)
653 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
654 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
655 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
656 (define-key (symbol-value (car keymap-and-completionp))
657 (car key-and-command)
658 (let ((command (cdr key-and-command)))
659 (if (consp command)
660 ;; (and ... nil) => ... turns back on the completion-oriented
661 ;; history commands which rms turned off since they seem to
662 ;; do things he doesn't like.
663 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
664 (progn (error "EMACS BUG!") (cdr command))
665 (car command))
666 command))))
667 '((minibuffer-local-map . nil)
668 (minibuffer-local-ns-map . nil)
669 (minibuffer-local-completion-map . t)
670 (minibuffer-local-must-match-map . t)
671 (read-expression-map . nil))))
672 '(("\en" . (next-history-element . next-complete-history-element))
673 ([next] . (next-history-element . next-complete-history-element))
674 ("\ep" . (previous-history-element . previous-complete-history-element))
675 ([prior] . (previous-history-element . previous-complete-history-element))
676 ("\er" . previous-matching-history-element)
677 ("\es" . next-matching-history-element)))
679 (defvar minibuffer-text-before-history nil
680 "Text that was in this minibuffer before any history commands.
681 This is nil if there have not yet been any history commands
682 in this use of the minibuffer.")
684 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
686 (defun minibuffer-history-initialize ()
687 (setq minibuffer-text-before-history nil))
689 (defcustom minibuffer-history-case-insensitive-variables nil
690 "*Minibuffer history variables for which matching should ignore case.
691 If a history variable is a member of this list, then the
692 \\[previous-matching-history-element] and \\[next-matching-history-element]\
693 commands ignore case when searching it, regardless of `case-fold-search'."
694 :type '(repeat variable)
695 :group 'minibuffer)
697 (defun previous-matching-history-element (regexp n)
698 "Find the previous history element that matches REGEXP.
699 \(Previous history elements refer to earlier actions.)
700 With prefix argument N, search for Nth previous match.
701 If N is negative, find the next or Nth next match.
702 An uppercase letter in REGEXP makes the search case-sensitive.
703 See also `minibuffer-history-case-insensitive-variables'."
704 (interactive
705 (let* ((enable-recursive-minibuffers t)
706 (regexp (read-from-minibuffer "Previous element matching (regexp): "
708 minibuffer-local-map
710 'minibuffer-history-search-history)))
711 ;; Use the last regexp specified, by default, if input is empty.
712 (list (if (string= regexp "")
713 (if minibuffer-history-search-history
714 (car minibuffer-history-search-history)
715 (error "No previous history search regexp"))
716 regexp)
717 (prefix-numeric-value current-prefix-arg))))
718 (unless (zerop n)
719 (if (and (zerop minibuffer-history-position)
720 (null minibuffer-text-before-history))
721 (setq minibuffer-text-before-history (field-string (point-max))))
722 (let ((history (symbol-value minibuffer-history-variable))
723 (case-fold-search
724 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
725 ;; On some systems, ignore case for file names.
726 (if (memq minibuffer-history-variable
727 minibuffer-history-case-insensitive-variables)
729 ;; Respect the user's setting for case-fold-search:
730 case-fold-search)
731 nil))
732 prevpos
733 match-string
734 match-offset
735 (pos minibuffer-history-position))
736 (while (/= n 0)
737 (setq prevpos pos)
738 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
739 (when (= pos prevpos)
740 (error (if (= pos 1)
741 "No later matching history item"
742 "No earlier matching history item")))
743 (setq match-string
744 (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
745 (let ((print-level nil))
746 (prin1-to-string (nth (1- pos) history)))
747 (nth (1- pos) history)))
748 (setq match-offset
749 (if (< n 0)
750 (and (string-match regexp match-string)
751 (match-end 0))
752 (and (string-match (concat ".*\\(" regexp "\\)") match-string)
753 (match-beginning 1))))
754 (when match-offset
755 (setq n (+ n (if (< n 0) 1 -1)))))
756 (setq minibuffer-history-position pos)
757 (goto-char (point-max))
758 (delete-field)
759 (insert match-string)
760 (goto-char (+ (field-beginning) match-offset))))
761 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
762 (eq (car (car command-history)) 'next-matching-history-element))
763 (setq command-history (cdr command-history))))
765 (defun next-matching-history-element (regexp n)
766 "Find the next history element that matches REGEXP.
767 \(The next history element refers to a more recent action.)
768 With prefix argument N, search for Nth next match.
769 If N is negative, find the previous or Nth previous match.
770 An uppercase letter in REGEXP makes the search case-sensitive."
771 (interactive
772 (let* ((enable-recursive-minibuffers t)
773 (regexp (read-from-minibuffer "Next element matching (regexp): "
775 minibuffer-local-map
777 'minibuffer-history-search-history)))
778 ;; Use the last regexp specified, by default, if input is empty.
779 (list (if (string= regexp "")
780 (setcar minibuffer-history-search-history
781 (nth 1 minibuffer-history-search-history))
782 regexp)
783 (prefix-numeric-value current-prefix-arg))))
784 (previous-matching-history-element regexp (- n)))
786 (defvar minibuffer-temporary-goal-position nil)
788 (defun next-history-element (n)
789 "Insert the next element of the minibuffer history into the minibuffer."
790 (interactive "p")
791 (or (zerop n)
792 (let ((narg (- minibuffer-history-position n))
793 (minimum (if minibuffer-default -1 0))
794 elt minibuffer-returned-to-present)
795 (if (and (zerop minibuffer-history-position)
796 (null minibuffer-text-before-history))
797 (setq minibuffer-text-before-history (field-string (point-max))))
798 (if (< narg minimum)
799 (if minibuffer-default
800 (error "End of history; no next item")
801 (error "End of history; no default available")))
802 (if (> narg (length (symbol-value minibuffer-history-variable)))
803 (error "Beginning of history; no preceding item"))
804 (unless (or (eq last-command 'next-history-element)
805 (eq last-command 'previous-history-element))
806 (let ((prompt-end (field-beginning (point-max))))
807 (set (make-local-variable 'minibuffer-temporary-goal-position)
808 (cond ((<= (point) prompt-end) prompt-end)
809 ((eobp) nil)
810 (t (point))))))
811 (goto-char (point-max))
812 (delete-field)
813 (setq minibuffer-history-position narg)
814 (cond ((= narg -1)
815 (setq elt minibuffer-default))
816 ((= narg 0)
817 (setq elt (or minibuffer-text-before-history ""))
818 (setq minibuffer-returned-to-present t)
819 (setq minibuffer-text-before-history nil))
820 (t (setq elt (nth (1- minibuffer-history-position)
821 (symbol-value minibuffer-history-variable)))))
822 (insert
823 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
824 (not minibuffer-returned-to-present))
825 (let ((print-level nil))
826 (prin1-to-string elt))
827 elt))
828 (goto-char (or minibuffer-temporary-goal-position (point-max))))))
830 (defun previous-history-element (n)
831 "Inserts the previous element of the minibuffer history into the minibuffer."
832 (interactive "p")
833 (next-history-element (- n)))
835 (defun next-complete-history-element (n)
836 "Get next history element which completes the minibuffer before the point.
837 The contents of the minibuffer after the point are deleted, and replaced
838 by the new completion."
839 (interactive "p")
840 (let ((point-at-start (point)))
841 (next-matching-history-element
842 (concat
843 "^" (regexp-quote (buffer-substring (field-beginning) (point))))
845 ;; next-matching-history-element always puts us at (point-min).
846 ;; Move to the position we were at before changing the buffer contents.
847 ;; This is still sensical, because the text before point has not changed.
848 (goto-char point-at-start)))
850 (defun previous-complete-history-element (n)
852 Get previous history element which completes the minibuffer before the point.
853 The contents of the minibuffer after the point are deleted, and replaced
854 by the new completion."
855 (interactive "p")
856 (next-complete-history-element (- n)))
858 ;; These two functions are for compatibility with the old subrs of the
859 ;; same name.
861 (defun minibuffer-prompt-width ()
862 "Return the display width of the minibuffer prompt.
863 Return 0 if current buffer is not a mini-buffer."
864 ;; Return the width of everything before the field at the end of
865 ;; the buffer; this should be 0 for normal buffers.
866 (1- (field-beginning (point-max))))
868 (defun minibuffer-prompt-end ()
869 "Return the buffer position of the end of the minibuffer prompt.
870 Return 0 if current buffer is not a mini-buffer."
871 (field-beginning (point-max)))
874 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
875 (defalias 'advertised-undo 'undo)
877 (defun undo (&optional arg)
878 "Undo some previous changes.
879 Repeat this command to undo more changes.
880 A numeric argument serves as a repeat count.
882 In Transient Mark mode when the mark is active, only undo changes within
883 the current region. Similarly, when not in Transient Mark mode, just C-u
884 as an argument limits undo to changes within the current region."
885 (interactive "*P")
886 ;; If we don't get all the way thru, make last-command indicate that
887 ;; for the following command.
888 (setq this-command t)
889 (let ((modified (buffer-modified-p))
890 (recent-save (recent-auto-save-p)))
891 (or (eq (selected-window) (minibuffer-window))
892 (message "Undo!"))
893 (unless (eq last-command 'undo)
894 (if (if transient-mark-mode mark-active (and arg (not (numberp arg))))
895 (undo-start (region-beginning) (region-end))
896 (undo-start))
897 ;; get rid of initial undo boundary
898 (undo-more 1))
899 (undo-more
900 (if (or transient-mark-mode (numberp arg))
901 (prefix-numeric-value arg)
903 ;; Don't specify a position in the undo record for the undo command.
904 ;; Instead, undoing this should move point to where the change is.
905 (let ((tail buffer-undo-list)
906 done)
907 (while (and tail (not done) (not (null (car tail))))
908 (if (integerp (car tail))
909 (progn
910 (setq done t)
911 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
912 (setq tail (cdr tail))))
913 (and modified (not (buffer-modified-p))
914 (delete-auto-save-file-if-necessary recent-save)))
915 ;; If we do get all the way thru, make this-command indicate that.
916 (setq this-command 'undo))
918 (defvar pending-undo-list nil
919 "Within a run of consecutive undo commands, list remaining to be undone.")
921 (defvar undo-in-progress nil
922 "Non-nil while performing an undo.
923 Some change-hooks test this variable to do something different.")
925 (defun undo-more (count)
926 "Undo back N undo-boundaries beyond what was already undone recently.
927 Call `undo-start' to get ready to undo recent changes,
928 then call `undo-more' one or more times to undo them."
929 (or pending-undo-list
930 (error "No further undo information"))
931 (let ((undo-in-progress t))
932 (setq pending-undo-list (primitive-undo count pending-undo-list))))
934 ;; Deep copy of a list
935 (defun undo-copy-list (list)
936 "Make a copy of undo list LIST."
937 (mapcar 'undo-copy-list-1 list))
939 (defun undo-copy-list-1 (elt)
940 (if (consp elt)
941 (cons (car elt) (undo-copy-list-1 (cdr elt)))
942 elt))
944 (defun undo-start (&optional beg end)
945 "Set `pending-undo-list' to the front of the undo list.
946 The next call to `undo-more' will undo the most recently made change.
947 If BEG and END are specified, then only undo elements
948 that apply to text between BEG and END are used; other undo elements
949 are ignored. If BEG and END are nil, all undo elements are used."
950 (if (eq buffer-undo-list t)
951 (error "No undo information in this buffer"))
952 (setq pending-undo-list
953 (if (and beg end (not (= beg end)))
954 (undo-make-selective-list (min beg end) (max beg end))
955 buffer-undo-list)))
957 (defvar undo-adjusted-markers)
959 (defun undo-make-selective-list (start end)
960 "Return a list of undo elements for the region START to END.
961 The elements come from `buffer-undo-list', but we keep only
962 the elements inside this region, and discard those outside this region.
963 If we find an element that crosses an edge of this region,
964 we stop and ignore all further elements."
965 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
966 (undo-list (list nil))
967 undo-adjusted-markers
968 some-rejected
969 undo-elt undo-elt temp-undo-list delta)
970 (while undo-list-copy
971 (setq undo-elt (car undo-list-copy))
972 (let ((keep-this
973 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
974 ;; This is a "was unmodified" element.
975 ;; Keep it if we have kept everything thus far.
976 (not some-rejected))
978 (undo-elt-in-region undo-elt start end)))))
979 (if keep-this
980 (progn
981 (setq end (+ end (cdr (undo-delta undo-elt))))
982 ;; Don't put two nils together in the list
983 (if (not (and (eq (car undo-list) nil)
984 (eq undo-elt nil)))
985 (setq undo-list (cons undo-elt undo-list))))
986 (if (undo-elt-crosses-region undo-elt start end)
987 (setq undo-list-copy nil)
988 (setq some-rejected t)
989 (setq temp-undo-list (cdr undo-list-copy))
990 (setq delta (undo-delta undo-elt))
992 (when (/= (cdr delta) 0)
993 (let ((position (car delta))
994 (offset (cdr delta)))
996 ;; Loop down the earlier events adjusting their buffer positions
997 ;; to reflect the fact that a change to the buffer isn't being
998 ;; undone. We only need to process those element types which
999 ;; undo-elt-in-region will return as being in the region since
1000 ;; only those types can ever get into the output
1002 (while temp-undo-list
1003 (setq undo-elt (car temp-undo-list))
1004 (cond ((integerp undo-elt)
1005 (if (>= undo-elt position)
1006 (setcar temp-undo-list (- undo-elt offset))))
1007 ((atom undo-elt) nil)
1008 ((stringp (car undo-elt))
1009 ;; (TEXT . POSITION)
1010 (let ((text-pos (abs (cdr undo-elt)))
1011 (point-at-end (< (cdr undo-elt) 0 )))
1012 (if (>= text-pos position)
1013 (setcdr undo-elt (* (if point-at-end -1 1)
1014 (- text-pos offset))))))
1015 ((integerp (car undo-elt))
1016 ;; (BEGIN . END)
1017 (when (>= (car undo-elt) position)
1018 (setcar undo-elt (- (car undo-elt) offset))
1019 (setcdr undo-elt (- (cdr undo-elt) offset))))
1020 ((null (car undo-elt))
1021 ;; (nil PROPERTY VALUE BEG . END)
1022 (let ((tail (nthcdr 3 undo-elt)))
1023 (when (>= (car tail) position)
1024 (setcar tail (- (car tail) offset))
1025 (setcdr tail (- (cdr tail) offset))))))
1026 (setq temp-undo-list (cdr temp-undo-list))))))))
1027 (setq undo-list-copy (cdr undo-list-copy)))
1028 (nreverse undo-list)))
1030 (defun undo-elt-in-region (undo-elt start end)
1031 "Determine whether UNDO-ELT falls inside the region START ... END.
1032 If it crosses the edge, we return nil."
1033 (cond ((integerp undo-elt)
1034 (and (>= undo-elt start)
1035 (< undo-elt end)))
1036 ((eq undo-elt nil)
1038 ((atom undo-elt)
1039 nil)
1040 ((stringp (car undo-elt))
1041 ;; (TEXT . POSITION)
1042 (and (>= (abs (cdr undo-elt)) start)
1043 (< (abs (cdr undo-elt)) end)))
1044 ((and (consp undo-elt) (markerp (car undo-elt)))
1045 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1046 ;; See if MARKER is inside the region.
1047 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1048 (unless alist-elt
1049 (setq alist-elt (cons (car undo-elt)
1050 (marker-position (car undo-elt))))
1051 (setq undo-adjusted-markers
1052 (cons alist-elt undo-adjusted-markers)))
1053 (and (cdr alist-elt)
1054 (>= (cdr alist-elt) start)
1055 (< (cdr alist-elt) end))))
1056 ((null (car undo-elt))
1057 ;; (nil PROPERTY VALUE BEG . END)
1058 (let ((tail (nthcdr 3 undo-elt)))
1059 (and (>= (car tail) start)
1060 (< (cdr tail) end))))
1061 ((integerp (car undo-elt))
1062 ;; (BEGIN . END)
1063 (and (>= (car undo-elt) start)
1064 (< (cdr undo-elt) end)))))
1066 (defun undo-elt-crosses-region (undo-elt start end)
1067 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1068 This assumes we have already decided that UNDO-ELT
1069 is not *inside* the region START...END."
1070 (cond ((atom undo-elt) nil)
1071 ((null (car undo-elt))
1072 ;; (nil PROPERTY VALUE BEG . END)
1073 (let ((tail (nthcdr 3 undo-elt)))
1074 (not (or (< (car tail) end)
1075 (> (cdr tail) start)))))
1076 ((integerp (car undo-elt))
1077 ;; (BEGIN . END)
1078 (not (or (< (car undo-elt) end)
1079 (> (cdr undo-elt) start))))))
1081 ;; Return the first affected buffer position and the delta for an undo element
1082 ;; delta is defined as the change in subsequent buffer positions if we *did*
1083 ;; the undo.
1084 (defun undo-delta (undo-elt)
1085 (if (consp undo-elt)
1086 (cond ((stringp (car undo-elt))
1087 ;; (TEXT . POSITION)
1088 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1089 ((integerp (car undo-elt))
1090 ;; (BEGIN . END)
1091 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1093 '(0 . 0)))
1094 '(0 . 0)))
1096 (defvar shell-command-history nil
1097 "History list for some commands that read shell commands.")
1099 (defvar shell-command-switch "-c"
1100 "Switch used to have the shell execute its command line argument.")
1102 (defvar shell-command-default-error-buffer nil
1103 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1104 This buffer is used when `shell-command' or 'shell-command-on-region'
1105 is run interactively. A value of nil means that output to stderr and
1106 stdout will be intermixed in the output stream.")
1108 (defun shell-command (command &optional output-buffer error-buffer)
1109 "Execute string COMMAND in inferior shell; display output, if any.
1111 If COMMAND ends in ampersand, execute it asynchronously.
1112 The output appears in the buffer `*Async Shell Command*'.
1113 That buffer is in shell mode.
1115 Otherwise, COMMAND is executed synchronously. The output appears in
1116 the buffer `*Shell Command Output*'. If the output is short enough to
1117 display in the echo area (which is determined by the variables
1118 `resize-mini-windows' and `max-mini-window-height'), it is shown
1119 there, but it is nonetheless available in buffer `*Shell Command
1120 Output*' even though that buffer is not automatically displayed. If
1121 there is no output, or if output is inserted in the current buffer,
1122 then `*Shell Command Output*' is deleted.
1124 To specify a coding system for converting non-ASCII characters
1125 in the shell command output, use \\[universal-coding-system-argument]
1126 before this command.
1128 Noninteractive callers can specify coding systems by binding
1129 `coding-system-for-read' and `coding-system-for-write'.
1131 The optional second argument OUTPUT-BUFFER, if non-nil,
1132 says to put the output in some other buffer.
1133 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1134 If OUTPUT-BUFFER is not a buffer and not nil,
1135 insert output in current buffer. (This cannot be done asynchronously.)
1136 In either case, the output is inserted after point (leaving mark after it).
1138 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1139 or buffer name to which to direct the command's standard error output.
1140 If it is nil, error output is mingled with regular output.
1141 In an interactive call, the variable `shell-command-default-error-buffer'
1142 specifies the value of ERROR-BUFFER."
1144 (interactive (list (read-from-minibuffer "Shell command: "
1145 nil nil nil 'shell-command-history)
1146 current-prefix-arg
1147 shell-command-default-error-buffer))
1148 ;; Look for a handler in case default-directory is a remote file name.
1149 (let ((handler
1150 (find-file-name-handler (directory-file-name default-directory)
1151 'shell-command)))
1152 (if handler
1153 (funcall handler 'shell-command command output-buffer error-buffer)
1154 (if (and output-buffer
1155 (not (or (bufferp output-buffer) (stringp output-buffer))))
1156 (let ((error-file
1157 (if error-buffer
1158 (make-temp-file
1159 (expand-file-name "scor"
1160 (or small-temporary-file-directory
1161 temporary-file-directory)))
1162 nil)))
1163 (barf-if-buffer-read-only)
1164 (push-mark nil t)
1165 ;; We do not use -f for csh; we will not support broken use of
1166 ;; .cshrcs. Even the BSD csh manual says to use
1167 ;; "if ($?prompt) exit" before things which are not useful
1168 ;; non-interactively. Besides, if someone wants their other
1169 ;; aliases for shell commands then they can still have them.
1170 (call-process shell-file-name nil
1171 (if error-file
1172 (list t error-file)
1174 nil shell-command-switch command)
1175 (when (and error-file (file-exists-p error-file))
1176 (if (< 0 (nth 7 (file-attributes error-file)))
1177 (with-current-buffer (get-buffer-create error-buffer)
1178 (let ((pos-from-end (- (point-max) (point))))
1179 (or (bobp)
1180 (insert "\f\n"))
1181 ;; Do no formatting while reading error file,
1182 ;; because that can run a shell command, and we
1183 ;; don't want that to cause an infinite recursion.
1184 (format-insert-file error-file nil)
1185 ;; Put point after the inserted errors.
1186 (goto-char (- (point-max) pos-from-end)))
1187 (display-buffer (current-buffer))))
1188 (delete-file error-file))
1189 ;; This is like exchange-point-and-mark, but doesn't
1190 ;; activate the mark. It is cleaner to avoid activation,
1191 ;; even though the command loop would deactivate the mark
1192 ;; because we inserted text.
1193 (goto-char (prog1 (mark t)
1194 (set-marker (mark-marker) (point)
1195 (current-buffer)))))
1196 ;; Preserve the match data in case called from a program.
1197 (save-match-data
1198 (if (string-match "[ \t]*&[ \t]*$" command)
1199 ;; Command ending with ampersand means asynchronous.
1200 (let ((buffer (get-buffer-create
1201 (or output-buffer "*Async Shell Command*")))
1202 (directory default-directory)
1203 proc)
1204 ;; Remove the ampersand.
1205 (setq command (substring command 0 (match-beginning 0)))
1206 ;; If will kill a process, query first.
1207 (setq proc (get-buffer-process buffer))
1208 (if proc
1209 (if (yes-or-no-p "A command is running. Kill it? ")
1210 (kill-process proc)
1211 (error "Shell command in progress")))
1212 (save-excursion
1213 (set-buffer buffer)
1214 (setq buffer-read-only nil)
1215 (erase-buffer)
1216 (display-buffer buffer)
1217 (setq default-directory directory)
1218 (setq proc (start-process "Shell" buffer shell-file-name
1219 shell-command-switch command))
1220 (setq mode-line-process '(":%s"))
1221 (require 'shell) (shell-mode)
1222 (set-process-sentinel proc 'shell-command-sentinel)
1224 (shell-command-on-region (point) (point) command
1225 output-buffer nil error-buffer)))))))
1227 (defun display-message-or-buffer (message
1228 &optional buffer-name not-this-window frame)
1229 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1230 MESSAGE may be either a string or a buffer.
1232 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1233 the maximum height of the echo area, as defined by `max-mini-window-height'
1234 if `resize-mini-windows' is non-nil.
1236 Returns either the string shown in the echo area, or when a pop-up
1237 buffer is used, the window used to display it.
1239 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1240 name of the buffer used to display it in the case where a pop-up buffer
1241 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1242 string and it is displayed in the echo area, it is not specified whether
1243 the contents are inserted into the buffer anyway.
1245 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1246 and only used if a buffer is displayed."
1247 (cond ((and (stringp message) (not (string-match "\n" message)))
1248 ;; Trivial case where we can use the echo area
1249 (message "%s" message))
1250 ((and (stringp message)
1251 (= (string-match "\n" message) (1- (length message))))
1252 ;; Trivial case where we can just remove single trailing newline
1253 (message "%s" (substring message 0 (1- (length message)))))
1255 ;; General case
1256 (with-current-buffer
1257 (if (bufferp message)
1258 message
1259 (get-buffer-create (or buffer-name "*Message*")))
1261 (unless (bufferp message)
1262 (erase-buffer)
1263 (insert message))
1265 (let ((lines
1266 (if (= (buffer-size) 0)
1268 (count-lines (point-min) (point-max)))))
1269 (cond ((or (<= lines 1)
1270 (<= lines
1271 (if resize-mini-windows
1272 (cond ((floatp max-mini-window-height)
1273 (* (frame-height)
1274 max-mini-window-height))
1275 ((integerp max-mini-window-height)
1276 max-mini-window-height)
1279 1)))
1280 ;; Echo area
1281 (goto-char (point-max))
1282 (when (bolp)
1283 (backward-char 1))
1284 (message "%s" (buffer-substring (point-min) (point))))
1286 ;; Buffer
1287 (goto-char (point-min))
1288 (display-buffer message not-this-window frame))))))))
1291 ;; We have a sentinel to prevent insertion of a termination message
1292 ;; in the buffer itself.
1293 (defun shell-command-sentinel (process signal)
1294 (if (memq (process-status process) '(exit signal))
1295 (message "%s: %s."
1296 (car (cdr (cdr (process-command process))))
1297 (substring signal 0 -1))))
1299 (defun shell-command-on-region (start end command
1300 &optional output-buffer replace
1301 error-buffer)
1302 "Execute string COMMAND in inferior shell with region as input.
1303 Normally display output (if any) in temp buffer `*Shell Command Output*';
1304 Prefix arg means replace the region with it. Return the exit code of
1305 COMMAND.
1307 To specify a coding system for converting non-ASCII characters
1308 in the input and output to the shell command, use \\[universal-coding-system-argument]
1309 before this command. By default, the input (from the current buffer)
1310 is encoded in the same coding system that will be used to save the file,
1311 `buffer-file-coding-system'. If the output is going to replace the region,
1312 then it is decoded from that same coding system.
1314 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1315 REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1316 systems by binding `coding-system-for-read' and
1317 `coding-system-for-write'.
1319 If the output is short enough to display in the echo area (which is
1320 determined by the variable `max-mini-window-height' if
1321 `resize-mini-windows' is non-nil), it is shown there, but it is
1322 nonetheless available in buffer `*Shell Command Output*' even though
1323 that buffer is not automatically displayed. If there is no output, or
1324 if output is inserted in the current buffer, then `*Shell Command
1325 Output*' is deleted.
1327 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1328 that says to put the output in some other buffer.
1329 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1330 If OUTPUT-BUFFER is not a buffer and not nil,
1331 insert output in the current buffer.
1332 In either case, the output is inserted after point (leaving mark after it).
1334 If REPLACE, the optional fifth argument, is non-nil, that means insert
1335 the output in place of text from START to END, putting point and mark
1336 around it.
1338 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1339 or buffer name to which to direct the command's standard error output.
1340 If it is nil, error output is mingled with regular output.
1341 In an interactive call, the variable `shell-command-default-error-buffer'
1342 specifies the value of ERROR-BUFFER."
1343 (interactive (let ((string
1344 ;; Do this before calling region-beginning
1345 ;; and region-end, in case subprocess output
1346 ;; relocates them while we are in the minibuffer.
1347 (read-from-minibuffer "Shell command on region: "
1348 nil nil nil
1349 'shell-command-history)))
1350 ;; call-interactively recognizes region-beginning and
1351 ;; region-end specially, leaving them in the history.
1352 (list (region-beginning) (region-end)
1353 string
1354 current-prefix-arg
1355 current-prefix-arg
1356 shell-command-default-error-buffer)))
1357 (let ((error-file
1358 (if error-buffer
1359 (make-temp-file
1360 (expand-file-name "scor"
1361 (or small-temporary-file-directory
1362 temporary-file-directory)))
1363 nil))
1364 exit-status)
1365 (if (or replace
1366 (and output-buffer
1367 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1368 ;; Replace specified region with output from command.
1369 (let ((swap (and replace (< start end))))
1370 ;; Don't muck with mark unless REPLACE says we should.
1371 (goto-char start)
1372 (and replace (push-mark))
1373 (setq exit-status
1374 (call-process-region start end shell-file-name t
1375 (if error-file
1376 (list t error-file)
1378 nil shell-command-switch command))
1379 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1380 (and shell-buffer (not (eq shell-buffer (current-buffer)))
1381 (kill-buffer shell-buffer)))
1382 ;; Don't muck with mark unless REPLACE says we should.
1383 (and replace swap (exchange-point-and-mark)))
1384 ;; No prefix argument: put the output in a temp buffer,
1385 ;; replacing its entire contents.
1386 (let ((buffer (get-buffer-create
1387 (or output-buffer "*Shell Command Output*")))
1388 (success nil))
1389 (unwind-protect
1390 (if (eq buffer (current-buffer))
1391 ;; If the input is the same buffer as the output,
1392 ;; delete everything but the specified region,
1393 ;; then replace that region with the output.
1394 (progn (setq buffer-read-only nil)
1395 (delete-region (max start end) (point-max))
1396 (delete-region (point-min) (min start end))
1397 (setq exit-status
1398 (call-process-region (point-min) (point-max)
1399 shell-file-name t
1400 (if error-file
1401 (list t error-file)
1403 nil shell-command-switch
1404 command)))
1405 ;; Clear the output buffer, then run the command with
1406 ;; output there.
1407 (let ((directory default-directory))
1408 (save-excursion
1409 (set-buffer buffer)
1410 (setq buffer-read-only nil)
1411 (if (not output-buffer)
1412 (setq default-directory directory))
1413 (erase-buffer)))
1414 (setq exit-status
1415 (call-process-region start end shell-file-name nil
1416 (if error-file
1417 (list buffer error-file)
1418 buffer)
1419 nil shell-command-switch command)))
1420 (setq success (and exit-status (equal 0 exit-status)))
1421 ;; Report the amount of output.
1422 (if (with-current-buffer buffer (> (point-max) (point-min)))
1423 ;; There's some output, display it
1424 (display-message-or-buffer buffer)
1425 ;; No output; error?
1426 (message (if (and error-file
1427 (< 0 (nth 7 (file-attributes error-file))))
1428 "(Shell command %sed with some error output)"
1429 "(Shell command %sed with no output)")
1430 (if (equal 0 exit-status) "succeed" "fail"))
1431 (kill-buffer buffer)))))
1433 (when (and error-file (file-exists-p error-file))
1434 (if (< 0 (nth 7 (file-attributes error-file)))
1435 (with-current-buffer (get-buffer-create error-buffer)
1436 (let ((pos-from-end (- (point-max) (point))))
1437 (or (bobp)
1438 (insert "\f\n"))
1439 ;; Do no formatting while reading error file,
1440 ;; because that can run a shell command, and we
1441 ;; don't want that to cause an infinite recursion.
1442 (format-insert-file error-file nil)
1443 ;; Put point after the inserted errors.
1444 (goto-char (- (point-max) pos-from-end)))
1445 (display-buffer (current-buffer))))
1446 (delete-file error-file))
1447 exit-status))
1449 (defun shell-command-to-string (command)
1450 "Execute shell command COMMAND and return its output as a string."
1451 (with-output-to-string
1452 (with-current-buffer
1453 standard-output
1454 (call-process shell-file-name nil t nil shell-command-switch command))))
1456 (defvar universal-argument-map
1457 (let ((map (make-sparse-keymap)))
1458 (define-key map [t] 'universal-argument-other-key)
1459 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1460 (define-key map [switch-frame] nil)
1461 (define-key map [?\C-u] 'universal-argument-more)
1462 (define-key map [?-] 'universal-argument-minus)
1463 (define-key map [?0] 'digit-argument)
1464 (define-key map [?1] 'digit-argument)
1465 (define-key map [?2] 'digit-argument)
1466 (define-key map [?3] 'digit-argument)
1467 (define-key map [?4] 'digit-argument)
1468 (define-key map [?5] 'digit-argument)
1469 (define-key map [?6] 'digit-argument)
1470 (define-key map [?7] 'digit-argument)
1471 (define-key map [?8] 'digit-argument)
1472 (define-key map [?9] 'digit-argument)
1473 (define-key map [kp-0] 'digit-argument)
1474 (define-key map [kp-1] 'digit-argument)
1475 (define-key map [kp-2] 'digit-argument)
1476 (define-key map [kp-3] 'digit-argument)
1477 (define-key map [kp-4] 'digit-argument)
1478 (define-key map [kp-5] 'digit-argument)
1479 (define-key map [kp-6] 'digit-argument)
1480 (define-key map [kp-7] 'digit-argument)
1481 (define-key map [kp-8] 'digit-argument)
1482 (define-key map [kp-9] 'digit-argument)
1483 (define-key map [kp-subtract] 'universal-argument-minus)
1484 map)
1485 "Keymap used while processing \\[universal-argument].")
1487 (defvar universal-argument-num-events nil
1488 "Number of argument-specifying events read by `universal-argument'.
1489 `universal-argument-other-key' uses this to discard those events
1490 from (this-command-keys), and reread only the final command.")
1492 (defun universal-argument ()
1493 "Begin a numeric argument for the following command.
1494 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1495 \\[universal-argument] following the digits or minus sign ends the argument.
1496 \\[universal-argument] without digits or minus sign provides 4 as argument.
1497 Repeating \\[universal-argument] without digits or minus sign
1498 multiplies the argument by 4 each time.
1499 For some commands, just \\[universal-argument] by itself serves as a flag
1500 which is different in effect from any particular numeric argument.
1501 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1502 (interactive)
1503 (setq prefix-arg (list 4))
1504 (setq universal-argument-num-events (length (this-command-keys)))
1505 (setq overriding-terminal-local-map universal-argument-map))
1507 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1508 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1509 (defun universal-argument-more (arg)
1510 (interactive "P")
1511 (if (consp arg)
1512 (setq prefix-arg (list (* 4 (car arg))))
1513 (if (eq arg '-)
1514 (setq prefix-arg (list -4))
1515 (setq prefix-arg arg)
1516 (setq overriding-terminal-local-map nil)))
1517 (setq universal-argument-num-events (length (this-command-keys))))
1519 (defun negative-argument (arg)
1520 "Begin a negative numeric argument for the next command.
1521 \\[universal-argument] following digits or minus sign ends the argument."
1522 (interactive "P")
1523 (cond ((integerp arg)
1524 (setq prefix-arg (- arg)))
1525 ((eq arg '-)
1526 (setq prefix-arg nil))
1528 (setq prefix-arg '-)))
1529 (setq universal-argument-num-events (length (this-command-keys)))
1530 (setq overriding-terminal-local-map universal-argument-map))
1532 (defun digit-argument (arg)
1533 "Part of the numeric argument for the next command.
1534 \\[universal-argument] following digits or minus sign ends the argument."
1535 (interactive "P")
1536 (let* ((char (if (integerp last-command-char)
1537 last-command-char
1538 (get last-command-char 'ascii-character)))
1539 (digit (- (logand char ?\177) ?0)))
1540 (cond ((integerp arg)
1541 (setq prefix-arg (+ (* arg 10)
1542 (if (< arg 0) (- digit) digit))))
1543 ((eq arg '-)
1544 ;; Treat -0 as just -, so that -01 will work.
1545 (setq prefix-arg (if (zerop digit) '- (- digit))))
1547 (setq prefix-arg digit))))
1548 (setq universal-argument-num-events (length (this-command-keys)))
1549 (setq overriding-terminal-local-map universal-argument-map))
1551 ;; For backward compatibility, minus with no modifiers is an ordinary
1552 ;; command if digits have already been entered.
1553 (defun universal-argument-minus (arg)
1554 (interactive "P")
1555 (if (integerp arg)
1556 (universal-argument-other-key arg)
1557 (negative-argument arg)))
1559 ;; Anything else terminates the argument and is left in the queue to be
1560 ;; executed as a command.
1561 (defun universal-argument-other-key (arg)
1562 (interactive "P")
1563 (setq prefix-arg arg)
1564 (let* ((key (this-command-keys))
1565 (keylist (listify-key-sequence key)))
1566 (setq unread-command-events
1567 (append (nthcdr universal-argument-num-events keylist)
1568 unread-command-events)))
1569 (reset-this-command-lengths)
1570 (setq overriding-terminal-local-map nil))
1572 ;;;; Window system cut and paste hooks.
1574 (defvar interprogram-cut-function nil
1575 "Function to call to make a killed region available to other programs.
1577 Most window systems provide some sort of facility for cutting and
1578 pasting text between the windows of different programs.
1579 This variable holds a function that Emacs calls whenever text
1580 is put in the kill ring, to make the new kill available to other
1581 programs.
1583 The function takes one or two arguments.
1584 The first argument, TEXT, is a string containing
1585 the text which should be made available.
1586 The second, PUSH, if non-nil means this is a \"new\" kill;
1587 nil means appending to an \"old\" kill.")
1589 (defvar interprogram-paste-function nil
1590 "Function to call to get text cut from other programs.
1592 Most window systems provide some sort of facility for cutting and
1593 pasting text between the windows of different programs.
1594 This variable holds a function that Emacs calls to obtain
1595 text that other programs have provided for pasting.
1597 The function should be called with no arguments. If the function
1598 returns nil, then no other program has provided such text, and the top
1599 of the Emacs kill ring should be used. If the function returns a
1600 string, that string should be put in the kill ring as the latest kill.
1602 Note that the function should return a string only if a program other
1603 than Emacs has provided a string for pasting; if Emacs provided the
1604 most recent string, the function should return nil. If it is
1605 difficult to tell whether Emacs or some other program provided the
1606 current string, it is probably good enough to return nil if the string
1607 is equal (according to `string=') to the last text Emacs provided.")
1611 ;;;; The kill ring data structure.
1613 (defvar kill-ring nil
1614 "List of killed text sequences.
1615 Since the kill ring is supposed to interact nicely with cut-and-paste
1616 facilities offered by window systems, use of this variable should
1617 interact nicely with `interprogram-cut-function' and
1618 `interprogram-paste-function'. The functions `kill-new',
1619 `kill-append', and `current-kill' are supposed to implement this
1620 interaction; you may want to use them instead of manipulating the kill
1621 ring directly.")
1623 (defcustom kill-ring-max 60
1624 "*Maximum length of kill ring before oldest elements are thrown away."
1625 :type 'integer
1626 :group 'killing)
1628 (defvar kill-ring-yank-pointer nil
1629 "The tail of the kill ring whose car is the last thing yanked.")
1631 (defun kill-new (string &optional replace)
1632 "Make STRING the latest kill in the kill ring.
1633 Set the kill-ring-yank pointer to point to it.
1634 If `interprogram-cut-function' is non-nil, apply it to STRING.
1635 Optional second argument REPLACE non-nil means that STRING will replace
1636 the front of the kill ring, rather than being added to the list."
1637 (and (fboundp 'menu-bar-update-yank-menu)
1638 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1639 (if replace
1640 (setcar kill-ring string)
1641 (setq kill-ring (cons string kill-ring))
1642 (if (> (length kill-ring) kill-ring-max)
1643 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1644 (setq kill-ring-yank-pointer kill-ring)
1645 (if interprogram-cut-function
1646 (funcall interprogram-cut-function string (not replace))))
1648 (defun kill-append (string before-p)
1649 "Append STRING to the end of the latest kill in the kill ring.
1650 If BEFORE-P is non-nil, prepend STRING to the kill.
1651 If `interprogram-cut-function' is set, pass the resulting kill to
1652 it."
1653 (kill-new (if before-p
1654 (concat string (car kill-ring))
1655 (concat (car kill-ring) string)) t))
1657 (defun current-kill (n &optional do-not-move)
1658 "Rotate the yanking point by N places, and then return that kill.
1659 If N is zero, `interprogram-paste-function' is set, and calling it
1660 returns a string, then that string is added to the front of the
1661 kill ring and returned as the latest kill.
1662 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1663 yanking point; just return the Nth kill forward."
1664 (let ((interprogram-paste (and (= n 0)
1665 interprogram-paste-function
1666 (funcall interprogram-paste-function))))
1667 (if interprogram-paste
1668 (progn
1669 ;; Disable the interprogram cut function when we add the new
1670 ;; text to the kill ring, so Emacs doesn't try to own the
1671 ;; selection, with identical text.
1672 (let ((interprogram-cut-function nil))
1673 (kill-new interprogram-paste))
1674 interprogram-paste)
1675 (or kill-ring (error "Kill ring is empty"))
1676 (let ((ARGth-kill-element
1677 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1678 (length kill-ring))
1679 kill-ring)))
1680 (or do-not-move
1681 (setq kill-ring-yank-pointer ARGth-kill-element))
1682 (car ARGth-kill-element)))))
1686 ;;;; Commands for manipulating the kill ring.
1688 (defcustom kill-read-only-ok nil
1689 "*Non-nil means don't signal an error for killing read-only text."
1690 :type 'boolean
1691 :group 'killing)
1693 (put 'text-read-only 'error-conditions
1694 '(text-read-only buffer-read-only error))
1695 (put 'text-read-only 'error-message "Text is read-only")
1697 (defun kill-region (beg end)
1698 "Kill between point and mark.
1699 The text is deleted but saved in the kill ring.
1700 The command \\[yank] can retrieve it from there.
1701 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1702 If the buffer is read-only, Emacs will beep and refrain from deleting
1703 the text, but put the text in the kill ring anyway. This means that
1704 you can use the killing commands to copy text from a read-only buffer.
1706 This is the primitive for programs to kill text (as opposed to deleting it).
1707 Supply two arguments, character numbers indicating the stretch of text
1708 to be killed.
1709 Any command that calls this function is a \"kill command\".
1710 If the previous command was also a kill command,
1711 the text killed this time appends to the text killed last time
1712 to make one entry in the kill ring."
1713 (interactive "r")
1714 (condition-case nil
1715 (let ((string (delete-and-extract-region beg end)))
1716 (when string ;STRING is nil if BEG = END
1717 ;; Add that string to the kill ring, one way or another.
1718 (if (eq last-command 'kill-region)
1719 (kill-append string (< end beg))
1720 (kill-new string)))
1721 (setq this-command 'kill-region))
1722 ((buffer-read-only text-read-only)
1723 ;; The code above failed because the buffer, or some of the characters
1724 ;; in the region, are read-only.
1725 ;; We should beep, in case the user just isn't aware of this.
1726 ;; However, there's no harm in putting
1727 ;; the region's text in the kill ring, anyway.
1728 (copy-region-as-kill beg end)
1729 ;; Set this-command now, so it will be set even if we get an error.
1730 (setq this-command 'kill-region)
1731 ;; This should barf, if appropriate, and give us the correct error.
1732 (if kill-read-only-ok
1733 (message "Read only text copied to kill ring")
1734 ;; Signal an error if the buffer is read-only.
1735 (barf-if-buffer-read-only)
1736 ;; If the buffer isn't read-only, the text is.
1737 (signal 'text-read-only (list (current-buffer)))))))
1739 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1740 ;; to get two copies of the text when the user accidentally types M-w and
1741 ;; then corrects it with the intended C-w.
1742 (defun copy-region-as-kill (beg end)
1743 "Save the region as if killed, but don't kill it.
1744 In Transient Mark mode, deactivate the mark.
1745 If `interprogram-cut-function' is non-nil, also save the text for a window
1746 system cut and paste."
1747 (interactive "r")
1748 (if (eq last-command 'kill-region)
1749 (kill-append (buffer-substring beg end) (< end beg))
1750 (kill-new (buffer-substring beg end)))
1751 (if transient-mark-mode
1752 (setq deactivate-mark t))
1753 nil)
1755 (defun kill-ring-save (beg end)
1756 "Save the region as if killed, but don't kill it.
1757 In Transient Mark mode, deactivate the mark.
1758 If `interprogram-cut-function' is non-nil, also save the text for a window
1759 system cut and paste.
1761 This command is similar to `copy-region-as-kill', except that it gives
1762 visual feedback indicating the extent of the region being copied."
1763 (interactive "r")
1764 (copy-region-as-kill beg end)
1765 (if (interactive-p)
1766 (let ((other-end (if (= (point) beg) end beg))
1767 (opoint (point))
1768 ;; Inhibit quitting so we can make a quit here
1769 ;; look like a C-g typed as a command.
1770 (inhibit-quit t))
1771 (if (pos-visible-in-window-p other-end (selected-window))
1772 (progn
1773 ;; Swap point and mark.
1774 (set-marker (mark-marker) (point) (current-buffer))
1775 (goto-char other-end)
1776 (sit-for 1)
1777 ;; Swap back.
1778 (set-marker (mark-marker) other-end (current-buffer))
1779 (goto-char opoint)
1780 ;; If user quit, deactivate the mark
1781 ;; as C-g would as a command.
1782 (and quit-flag mark-active
1783 (deactivate-mark)))
1784 (let* ((killed-text (current-kill 0))
1785 (message-len (min (length killed-text) 40)))
1786 (if (= (point) beg)
1787 ;; Don't say "killed"; that is misleading.
1788 (message "Saved text until \"%s\""
1789 (substring killed-text (- message-len)))
1790 (message "Saved text from \"%s\""
1791 (substring killed-text 0 message-len))))))))
1793 (defun append-next-kill (&optional interactive)
1794 "Cause following command, if it kills, to append to previous kill.
1795 The argument is used for internal purposes; do not supply one."
1796 (interactive "p")
1797 ;; We don't use (interactive-p), since that breaks kbd macros.
1798 (if interactive
1799 (progn
1800 (setq this-command 'kill-region)
1801 (message "If the next command is a kill, it will append"))
1802 (setq last-command 'kill-region)))
1804 ;; Yanking.
1806 (defun yank-pop (arg)
1807 "Replace just-yanked stretch of killed text with a different stretch.
1808 This command is allowed only immediately after a `yank' or a `yank-pop'.
1809 At such a time, the region contains a stretch of reinserted
1810 previously-killed text. `yank-pop' deletes that text and inserts in its
1811 place a different stretch of killed text.
1813 With no argument, the previous kill is inserted.
1814 With argument N, insert the Nth previous kill.
1815 If N is negative, this is a more recent kill.
1817 The sequence of kills wraps around, so that after the oldest one
1818 comes the newest one."
1819 (interactive "*p")
1820 (if (not (eq last-command 'yank))
1821 (error "Previous command was not a yank"))
1822 (setq this-command 'yank)
1823 (let ((inhibit-read-only t)
1824 (before (< (point) (mark t))))
1825 (delete-region (point) (mark t))
1826 (set-marker (mark-marker) (point) (current-buffer))
1827 (let ((opoint (point)))
1828 (insert (current-kill arg))
1829 (let ((inhibit-read-only t))
1830 (remove-text-properties opoint (point) '(read-only nil))))
1831 (if before
1832 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1833 ;; It is cleaner to avoid activation, even though the command
1834 ;; loop would deactivate the mark because we inserted text.
1835 (goto-char (prog1 (mark t)
1836 (set-marker (mark-marker) (point) (current-buffer))))))
1837 nil)
1839 (defun yank (&optional arg)
1840 "Reinsert the last stretch of killed text.
1841 More precisely, reinsert the stretch of killed text most recently
1842 killed OR yanked. Put point at end, and set mark at beginning.
1843 With just C-u as argument, same but put point at beginning (and mark at end).
1844 With argument N, reinsert the Nth most recently killed stretch of killed
1845 text.
1846 See also the command \\[yank-pop]."
1847 (interactive "*P")
1848 ;; If we don't get all the way thru, make last-command indicate that
1849 ;; for the following command.
1850 (setq this-command t)
1851 (push-mark (point))
1852 (let ((opoint (point)))
1853 (insert (current-kill (cond
1854 ((listp arg) 0)
1855 ((eq arg '-) -1)
1856 (t (1- arg)))))
1857 (let ((inhibit-read-only t))
1858 (remove-text-properties opoint (point) '(read-only nil))))
1859 (if (consp arg)
1860 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1861 ;; It is cleaner to avoid activation, even though the command
1862 ;; loop would deactivate the mark because we inserted text.
1863 (goto-char (prog1 (mark t)
1864 (set-marker (mark-marker) (point) (current-buffer)))))
1865 ;; If we do get all the way thru, make this-command indicate that.
1866 (setq this-command 'yank)
1867 nil)
1869 (defun rotate-yank-pointer (arg)
1870 "Rotate the yanking point in the kill ring.
1871 With argument, rotate that many kills forward (or backward, if negative)."
1872 (interactive "p")
1873 (current-kill arg))
1875 ;; Some kill commands.
1877 ;; Internal subroutine of delete-char
1878 (defun kill-forward-chars (arg)
1879 (if (listp arg) (setq arg (car arg)))
1880 (if (eq arg '-) (setq arg -1))
1881 (kill-region (point) (forward-point arg)))
1883 ;; Internal subroutine of backward-delete-char
1884 (defun kill-backward-chars (arg)
1885 (if (listp arg) (setq arg (car arg)))
1886 (if (eq arg '-) (setq arg -1))
1887 (kill-region (point) (forward-point (- arg))))
1889 (defcustom backward-delete-char-untabify-method 'untabify
1890 "*The method for untabifying when deleting backward.
1891 Can be `untabify' -- turn a tab to many spaces, then delete one space;
1892 `hungry' -- delete all whitespace, both tabs and spaces;
1893 `all' -- delete all whitespace, including tabs, spaces and newlines;
1894 nil -- just delete one character."
1895 :type '(choice (const untabify) (const hungry) (const all) (const nil))
1896 :group 'killing)
1898 (defun backward-delete-char-untabify (arg &optional killp)
1899 "Delete characters backward, changing tabs into spaces.
1900 The exact behavior depends on `backward-delete-char-untabify-method'.
1901 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
1902 Interactively, ARG is the prefix arg (default 1)
1903 and KILLP is t if a prefix arg was specified."
1904 (interactive "*p\nP")
1905 (when (eq backward-delete-char-untabify-method 'untabify)
1906 (let ((count arg))
1907 (save-excursion
1908 (while (and (> count 0) (not (bobp)))
1909 (if (= (preceding-char) ?\t)
1910 (let ((col (current-column)))
1911 (forward-char -1)
1912 (setq col (- col (current-column)))
1913 (insert-char ?\ col)
1914 (delete-char 1)))
1915 (forward-char -1)
1916 (setq count (1- count))))))
1917 (delete-backward-char
1918 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1919 ((eq backward-delete-char-untabify-method 'all)
1920 " \t\n\r"))))
1921 (if skip
1922 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
1923 (point)))))
1924 (+ arg (if (zerop wh) 0 (1- wh))))
1925 arg))
1926 killp))
1928 (defun zap-to-char (arg char)
1929 "Kill up to and including ARG'th occurrence of CHAR.
1930 Case is ignored if `case-fold-search' is non-nil in the current buffer.
1931 Goes backward if ARG is negative; error if CHAR not found."
1932 (interactive "p\ncZap to char: ")
1933 (kill-region (point) (progn
1934 (search-forward (char-to-string char) nil nil arg)
1935 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
1936 (point))))
1938 ;; kill-line and its subroutines.
1940 (defcustom kill-whole-line nil
1941 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
1942 :type 'boolean
1943 :group 'killing)
1945 (defun kill-line (&optional arg)
1946 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1947 With prefix argument, kill that many lines from point.
1948 Negative arguments kill lines backward.
1949 With zero argument, kills the text before point on the current line.
1951 When calling from a program, nil means \"no arg\",
1952 a number counts as a prefix arg.
1954 To kill a whole line, when point is not at the beginning, type \
1955 \\[beginning-of-line] \\[kill-line] \\[kill-line].
1957 If `kill-whole-line' is non-nil, then this command kills the whole line
1958 including its terminating newline, when used at the beginning of a line
1959 with no argument. As a consequence, you can always kill a whole line
1960 by typing \\[beginning-of-line] \\[kill-line]."
1961 (interactive "P")
1962 (kill-region (point)
1963 ;; It is better to move point to the other end of the kill
1964 ;; before killing. That way, in a read-only buffer, point
1965 ;; moves across the text that is copied to the kill ring.
1966 ;; The choice has no effect on undo now that undo records
1967 ;; the value of point from before the command was run.
1968 (progn
1969 (if arg
1970 (forward-visible-line (prefix-numeric-value arg))
1971 (if (eobp)
1972 (signal 'end-of-buffer nil))
1973 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
1974 (forward-visible-line 1)
1975 (end-of-visible-line)))
1976 (point))))
1978 (defun forward-visible-line (arg)
1979 "Move forward by ARG lines, ignoring currently invisible newlines only.
1980 If ARG is negative, move backward -ARG lines.
1981 If ARG is zero, move to the beginning of the current line."
1982 (condition-case nil
1983 (if (> arg 0)
1984 (while (> arg 0)
1985 (or (zerop (forward-line 1))
1986 (signal 'end-of-buffer nil))
1987 ;; If the following character is currently invisible,
1988 ;; skip all characters with that same `invisible' property value,
1989 ;; then find the next newline.
1990 (while (and (not (eobp))
1991 (let ((prop
1992 (get-char-property (point) 'invisible)))
1993 (if (eq buffer-invisibility-spec t)
1994 prop
1995 (or (memq prop buffer-invisibility-spec)
1996 (assq prop buffer-invisibility-spec)))))
1997 (goto-char
1998 (if (get-text-property (point) 'invisible)
1999 (or (next-single-property-change (point) 'invisible)
2000 (point-max))
2001 (next-overlay-change (point))))
2002 (or (zerop (forward-line 1))
2003 (signal 'end-of-buffer nil)))
2004 (setq arg (1- arg)))
2005 (let ((first t))
2006 (while (or first (< arg 0))
2007 (if (zerop arg)
2008 (beginning-of-line)
2009 (or (zerop (forward-line -1))
2010 (signal 'beginning-of-buffer nil)))
2011 (while (and (not (bobp))
2012 (let ((prop
2013 (get-char-property (1- (point)) 'invisible)))
2014 (if (eq buffer-invisibility-spec t)
2015 prop
2016 (or (memq prop buffer-invisibility-spec)
2017 (assq prop buffer-invisibility-spec)))))
2018 (goto-char
2019 (if (get-text-property (1- (point)) 'invisible)
2020 (or (previous-single-property-change (point) 'invisible)
2021 (point-min))
2022 (previous-overlay-change (point))))
2023 (or (zerop (forward-line -1))
2024 (signal 'beginning-of-buffer nil)))
2025 (setq first nil)
2026 (setq arg (1+ arg)))))
2027 ((beginning-of-buffer end-of-buffer)
2028 nil)))
2030 (defun end-of-visible-line ()
2031 "Move to end of current visible line."
2032 (end-of-line)
2033 ;; If the following character is currently invisible,
2034 ;; skip all characters with that same `invisible' property value,
2035 ;; then find the next newline.
2036 (while (and (not (eobp))
2037 (let ((prop
2038 (get-char-property (point) 'invisible)))
2039 (if (eq buffer-invisibility-spec t)
2040 prop
2041 (or (memq prop buffer-invisibility-spec)
2042 (assq prop buffer-invisibility-spec)))))
2043 (if (get-text-property (point) 'invisible)
2044 (goto-char (next-single-property-change (point) 'invisible))
2045 (goto-char (next-overlay-change (point))))
2046 (end-of-line)))
2048 (defun insert-buffer (buffer)
2049 "Insert after point the contents of BUFFER.
2050 Puts mark after the inserted text.
2051 BUFFER may be a buffer or a buffer name.
2053 This function is meant for the user to run interactively.
2054 Don't call it from programs!"
2055 (interactive
2056 (list
2057 (progn
2058 (barf-if-buffer-read-only)
2059 (read-buffer "Insert buffer: "
2060 (if (eq (selected-window) (next-window (selected-window)))
2061 (other-buffer (current-buffer))
2062 (window-buffer (next-window (selected-window))))
2063 t))))
2064 (or (bufferp buffer)
2065 (setq buffer (get-buffer buffer)))
2066 (let (start end newmark)
2067 (save-excursion
2068 (save-excursion
2069 (set-buffer buffer)
2070 (setq start (point-min) end (point-max)))
2071 (insert-buffer-substring buffer start end)
2072 (setq newmark (point)))
2073 (push-mark newmark))
2074 nil)
2076 (defun append-to-buffer (buffer start end)
2077 "Append to specified buffer the text of the region.
2078 It is inserted into that buffer before its point.
2080 When calling from a program, give three arguments:
2081 BUFFER (or buffer name), START and END.
2082 START and END specify the portion of the current buffer to be copied."
2083 (interactive
2084 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2085 (region-beginning) (region-end)))
2086 (let ((oldbuf (current-buffer)))
2087 (save-excursion
2088 (let* ((append-to (get-buffer-create buffer))
2089 (windows (get-buffer-window-list append-to t t))
2090 point)
2091 (set-buffer append-to)
2092 (setq point (point))
2093 (barf-if-buffer-read-only)
2094 (insert-buffer-substring oldbuf start end)
2095 (dolist (window windows)
2096 (when (= (window-point window) point)
2097 (set-window-point window (point))))))))
2099 (defun prepend-to-buffer (buffer start end)
2100 "Prepend to specified buffer the text of the region.
2101 It is inserted into that buffer after its point.
2103 When calling from a program, give three arguments:
2104 BUFFER (or buffer name), START and END.
2105 START and END specify the portion of the current buffer to be copied."
2106 (interactive "BPrepend to buffer: \nr")
2107 (let ((oldbuf (current-buffer)))
2108 (save-excursion
2109 (set-buffer (get-buffer-create buffer))
2110 (barf-if-buffer-read-only)
2111 (save-excursion
2112 (insert-buffer-substring oldbuf start end)))))
2114 (defun copy-to-buffer (buffer start end)
2115 "Copy to specified buffer the text of the region.
2116 It is inserted into that buffer, replacing existing text there.
2118 When calling from a program, give three arguments:
2119 BUFFER (or buffer name), START and END.
2120 START and END specify the portion of the current buffer to be copied."
2121 (interactive "BCopy to buffer: \nr")
2122 (let ((oldbuf (current-buffer)))
2123 (save-excursion
2124 (set-buffer (get-buffer-create buffer))
2125 (barf-if-buffer-read-only)
2126 (erase-buffer)
2127 (save-excursion
2128 (insert-buffer-substring oldbuf start end)))))
2130 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2131 (put 'mark-inactive 'error-message "The mark is not active now")
2133 (defun mark (&optional force)
2134 "Return this buffer's mark value as integer; error if mark inactive.
2135 If optional argument FORCE is non-nil, access the mark value
2136 even if the mark is not currently active, and return nil
2137 if there is no mark at all.
2139 If you are using this in an editing command, you are most likely making
2140 a mistake; see the documentation of `set-mark'."
2141 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2142 (marker-position (mark-marker))
2143 (signal 'mark-inactive nil)))
2145 ;; Many places set mark-active directly, and several of them failed to also
2146 ;; run deactivate-mark-hook. This shorthand should simplify.
2147 (defsubst deactivate-mark ()
2148 "Deactivate the mark by setting `mark-active' to nil.
2149 \(That makes a difference only in Transient Mark mode.)
2150 Also runs the hook `deactivate-mark-hook'."
2151 (if transient-mark-mode
2152 (progn
2153 (setq mark-active nil)
2154 (run-hooks 'deactivate-mark-hook))))
2156 (defun set-mark (pos)
2157 "Set this buffer's mark to POS. Don't use this function!
2158 That is to say, don't use this function unless you want
2159 the user to see that the mark has moved, and you want the previous
2160 mark position to be lost.
2162 Normally, when a new mark is set, the old one should go on the stack.
2163 This is why most applications should use push-mark, not set-mark.
2165 Novice Emacs Lisp programmers often try to use the mark for the wrong
2166 purposes. The mark saves a location for the user's convenience.
2167 Most editing commands should not alter the mark.
2168 To remember a location for internal use in the Lisp program,
2169 store it in a Lisp variable. Example:
2171 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2173 (if pos
2174 (progn
2175 (setq mark-active t)
2176 (run-hooks 'activate-mark-hook)
2177 (set-marker (mark-marker) pos (current-buffer)))
2178 ;; Normally we never clear mark-active except in Transient Mark mode.
2179 ;; But when we actually clear out the mark value too,
2180 ;; we must clear mark-active in any mode.
2181 (setq mark-active nil)
2182 (run-hooks 'deactivate-mark-hook)
2183 (set-marker (mark-marker) nil)))
2185 (defvar mark-ring nil
2186 "The list of former marks of the current buffer, most recent first.")
2187 (make-variable-buffer-local 'mark-ring)
2188 (put 'mark-ring 'permanent-local t)
2190 (defcustom mark-ring-max 16
2191 "*Maximum size of mark ring. Start discarding off end if gets this big."
2192 :type 'integer
2193 :group 'editing-basics)
2195 (defvar global-mark-ring nil
2196 "The list of saved global marks, most recent first.")
2198 (defcustom global-mark-ring-max 16
2199 "*Maximum size of global mark ring. \
2200 Start discarding off end if gets this big."
2201 :type 'integer
2202 :group 'editing-basics)
2204 (defun set-mark-command (arg)
2205 "Set mark at where point is, or jump to mark.
2206 With no prefix argument, set mark, push old mark position on local mark
2207 ring, and push mark on global mark ring.
2208 With argument, jump to mark, and pop a new position for mark off the ring
2209 \(does not affect global mark ring\).
2211 Novice Emacs Lisp programmers often try to use the mark for the wrong
2212 purposes. See the documentation of `set-mark' for more information."
2213 (interactive "P")
2214 (if (null arg)
2215 (progn
2216 (push-mark nil nil t))
2217 (if (null (mark t))
2218 (error "No mark set in this buffer")
2219 (goto-char (mark t))
2220 (pop-mark))))
2222 (defun push-mark (&optional location nomsg activate)
2223 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
2224 If the last global mark pushed was not in the current buffer,
2225 also push LOCATION on the global mark ring.
2226 Display `Mark set' unless the optional second arg NOMSG is non-nil.
2227 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2229 Novice Emacs Lisp programmers often try to use the mark for the wrong
2230 purposes. See the documentation of `set-mark' for more information.
2232 In Transient Mark mode, this does not activate the mark."
2233 (if (null (mark t))
2235 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2236 (if (> (length mark-ring) mark-ring-max)
2237 (progn
2238 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2239 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
2240 (set-marker (mark-marker) (or location (point)) (current-buffer))
2241 ;; Now push the mark on the global mark ring.
2242 (if (and global-mark-ring
2243 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
2244 ;; The last global mark pushed was in this same buffer.
2245 ;; Don't push another one.
2247 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
2248 (if (> (length global-mark-ring) global-mark-ring-max)
2249 (progn
2250 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2251 nil)
2252 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2253 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2254 (message "Mark set"))
2255 (if (or activate (not transient-mark-mode))
2256 (set-mark (mark t)))
2257 nil)
2259 (defun pop-mark ()
2260 "Pop off mark ring into the buffer's actual mark.
2261 Does not set point. Does nothing if mark ring is empty."
2262 (if mark-ring
2263 (progn
2264 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
2265 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
2266 (deactivate-mark)
2267 (move-marker (car mark-ring) nil)
2268 (if (null (mark t)) (ding))
2269 (setq mark-ring (cdr mark-ring)))))
2271 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2272 (defun exchange-point-and-mark ()
2273 "Put the mark where point is now, and point where the mark is now.
2274 This command works even when the mark is not active,
2275 and it reactivates the mark."
2276 (interactive nil)
2277 (let ((omark (mark t)))
2278 (if (null omark)
2279 (error "No mark set in this buffer"))
2280 (set-mark (point))
2281 (goto-char omark)
2282 nil))
2284 (defun transient-mark-mode (arg)
2285 "Toggle Transient Mark mode.
2286 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
2288 In Transient Mark mode, when the mark is active, the region is highlighted.
2289 Changing the buffer \"deactivates\" the mark.
2290 So do certain other operations that set the mark
2291 but whose main purpose is something else--for example,
2292 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
2293 (interactive "P")
2294 (setq transient-mark-mode
2295 (if (null arg)
2296 (not transient-mark-mode)
2297 (> (prefix-numeric-value arg) 0)))
2298 (if (interactive-p)
2299 (if transient-mark-mode
2300 (message "Transient Mark mode enabled")
2301 (message "Transient Mark mode disabled"))))
2303 (defun pop-global-mark ()
2304 "Pop off global mark ring and jump to the top location."
2305 (interactive)
2306 ;; Pop entries which refer to non-existent buffers.
2307 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2308 (setq global-mark-ring (cdr global-mark-ring)))
2309 (or global-mark-ring
2310 (error "No global mark set"))
2311 (let* ((marker (car global-mark-ring))
2312 (buffer (marker-buffer marker))
2313 (position (marker-position marker)))
2314 (setq global-mark-ring (nconc (cdr global-mark-ring)
2315 (list (car global-mark-ring))))
2316 (set-buffer buffer)
2317 (or (and (>= position (point-min))
2318 (<= position (point-max)))
2319 (widen))
2320 (goto-char position)
2321 (switch-to-buffer buffer)))
2323 (defcustom next-line-add-newlines t
2324 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2325 :type 'boolean
2326 :group 'editing-basics)
2328 (defun next-line (arg)
2329 "Move cursor vertically down ARG lines.
2330 If there is no character in the target line exactly under the current column,
2331 the cursor is positioned after the character in that line which spans this
2332 column, or at the end of the line if it is not long enough.
2333 If there is no line in the buffer after this one, behavior depends on the
2334 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2335 to create a line, and moves the cursor to that line. Otherwise it moves the
2336 cursor to the end of the buffer.
2338 The command \\[set-goal-column] can be used to create
2339 a semipermanent goal column for this command.
2340 Then instead of trying to move exactly vertically (or as close as possible),
2341 this command moves to the specified goal column (or as close as possible).
2342 The goal column is stored in the variable `goal-column', which is nil
2343 when there is no goal column.
2345 If you are thinking of using this in a Lisp program, consider
2346 using `forward-line' instead. It is usually easier to use
2347 and more reliable (no dependence on goal column, etc.)."
2348 (interactive "p")
2349 (if (and next-line-add-newlines (= arg 1))
2350 (let ((opoint (point)))
2351 (end-of-line)
2352 (if (eobp)
2353 (newline 1)
2354 (goto-char opoint)
2355 (line-move arg)))
2356 (if (interactive-p)
2357 (condition-case nil
2358 (line-move arg)
2359 ((beginning-of-buffer end-of-buffer) (ding)))
2360 (line-move arg)))
2361 nil)
2363 (defun previous-line (arg)
2364 "Move cursor vertically up ARG lines.
2365 If there is no character in the target line exactly over the current column,
2366 the cursor is positioned after the character in that line which spans this
2367 column, or at the end of the line if it is not long enough.
2369 The command \\[set-goal-column] can be used to create
2370 a semipermanent goal column for this command.
2371 Then instead of trying to move exactly vertically (or as close as possible),
2372 this command moves to the specified goal column (or as close as possible).
2373 The goal column is stored in the variable `goal-column', which is nil
2374 when there is no goal column.
2376 If you are thinking of using this in a Lisp program, consider using
2377 `forward-line' with a negative argument instead. It is usually easier
2378 to use and more reliable (no dependence on goal column, etc.)."
2379 (interactive "p")
2380 (if (interactive-p)
2381 (condition-case nil
2382 (line-move (- arg))
2383 ((beginning-of-buffer end-of-buffer) (ding)))
2384 (line-move (- arg)))
2385 nil)
2387 (defcustom track-eol nil
2388 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2389 This means moving to the end of each line moved onto.
2390 The beginning of a blank line does not count as the end of a line."
2391 :type 'boolean
2392 :group 'editing-basics)
2394 (defcustom goal-column nil
2395 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2396 :type '(choice integer
2397 (const :tag "None" nil))
2398 :group 'editing-basics)
2399 (make-variable-buffer-local 'goal-column)
2401 (defvar temporary-goal-column 0
2402 "Current goal column for vertical motion.
2403 It is the column where point was
2404 at the start of current run of vertical motion commands.
2405 When the `track-eol' feature is doing its job, the value is 9999.")
2407 (defcustom line-move-ignore-invisible nil
2408 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2409 Outline mode sets this."
2410 :type 'boolean
2411 :group 'editing-basics)
2413 ;; This is the guts of next-line and previous-line.
2414 ;; Arg says how many lines to move.
2415 (defun line-move (arg)
2416 ;; Don't run any point-motion hooks, and disregard intangibility,
2417 ;; for intermediate positions.
2418 (let ((inhibit-point-motion-hooks t)
2419 (opoint (point))
2420 new line-end line-beg)
2421 (unwind-protect
2422 (progn
2423 (if (not (or (eq last-command 'next-line)
2424 (eq last-command 'previous-line)))
2425 (setq temporary-goal-column
2426 (if (and track-eol (eolp)
2427 ;; Don't count beg of empty line as end of line
2428 ;; unless we just did explicit end-of-line.
2429 (or (not (bolp)) (eq last-command 'end-of-line)))
2430 9999
2431 (current-column))))
2432 (if (and (not (integerp selective-display))
2433 (not line-move-ignore-invisible))
2434 ;; Use just newline characters.
2435 (or (if (> arg 0)
2436 (progn (if (> arg 1) (forward-line (1- arg)))
2437 ;; This way of moving forward ARG lines
2438 ;; verifies that we have a newline after the last one.
2439 ;; It doesn't get confused by intangible text.
2440 (end-of-line)
2441 (zerop (forward-line 1)))
2442 (and (zerop (forward-line arg))
2443 (bolp)))
2444 (signal (if (< arg 0)
2445 'beginning-of-buffer
2446 'end-of-buffer)
2447 nil))
2448 ;; Move by arg lines, but ignore invisible ones.
2449 (while (> arg 0)
2450 (end-of-line)
2451 (and (zerop (vertical-motion 1))
2452 (signal 'end-of-buffer nil))
2453 ;; If the following character is currently invisible,
2454 ;; skip all characters with that same `invisible' property value.
2455 (while (and (not (eobp))
2456 (let ((prop
2457 (get-char-property (point) 'invisible)))
2458 (if (eq buffer-invisibility-spec t)
2459 prop
2460 (or (memq prop buffer-invisibility-spec)
2461 (assq prop buffer-invisibility-spec)))))
2462 (if (get-text-property (point) 'invisible)
2463 (goto-char (next-single-property-change (point) 'invisible))
2464 (goto-char (next-overlay-change (point)))))
2465 (setq arg (1- arg)))
2466 (while (< arg 0)
2467 (beginning-of-line)
2468 (and (zerop (vertical-motion -1))
2469 (signal 'beginning-of-buffer nil))
2470 (while (and (not (bobp))
2471 (let ((prop
2472 (get-char-property (1- (point)) 'invisible)))
2473 (if (eq buffer-invisibility-spec t)
2474 prop
2475 (or (memq prop buffer-invisibility-spec)
2476 (assq prop buffer-invisibility-spec)))))
2477 (if (get-text-property (1- (point)) 'invisible)
2478 (goto-char (previous-single-property-change (point) 'invisible))
2479 (goto-char (previous-overlay-change (point)))))
2480 (setq arg (1+ arg))))
2481 (let ((buffer-invisibility-spec nil))
2482 (move-to-column (or goal-column temporary-goal-column))))
2483 (setq new (point))
2484 ;; If we are moving into some intangible text,
2485 ;; look for following text on the same line which isn't intangible
2486 ;; and move there.
2487 (setq line-end (save-excursion (end-of-line) (point)))
2488 (setq line-beg (save-excursion (beginning-of-line) (point)))
2489 (let ((after (and (< new (point-max))
2490 (get-char-property new 'intangible)))
2491 (before (and (> new (point-min))
2492 (get-char-property (1- new) 'intangible))))
2493 (when (and before (eq before after)
2494 (not (bolp)))
2495 (goto-char (point-min))
2496 (let ((inhibit-point-motion-hooks nil))
2497 (goto-char new))
2498 (if (<= new line-end)
2499 (setq new (point)))))
2500 ;; NEW is where we want to move to.
2501 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2502 ;; Move there in just one step, from our starting position,
2503 ;; with intangibility and point-motion hooks enabled this time.
2504 (goto-char opoint)
2505 (setq inhibit-point-motion-hooks nil)
2506 (goto-char (constrain-to-field new opoint nil t
2507 'inhibit-line-move-field-capture))
2508 ;; If intangibility processing moved us to a different line,
2509 ;; readjust the horizontal position within the line we ended up at.
2510 (when (or (< (point) line-beg) (> (point) line-end))
2511 (setq new (point))
2512 (setq inhibit-point-motion-hooks t)
2513 (setq line-end (save-excursion (end-of-line) (point)))
2514 (beginning-of-line)
2515 (setq line-beg (point))
2516 (let ((buffer-invisibility-spec nil))
2517 (move-to-column (or goal-column temporary-goal-column)))
2518 (if (<= (point) line-end)
2519 (setq new (point)))
2520 (goto-char (point-min))
2521 (setq inhibit-point-motion-hooks nil)
2522 (goto-char (constrain-to-field new opoint nil t
2523 'inhibit-line-move-field-capture))
2525 nil)
2527 ;;; Many people have said they rarely use this feature, and often type
2528 ;;; it by accident. Maybe it shouldn't even be on a key.
2529 (put 'set-goal-column 'disabled t)
2531 (defun set-goal-column (arg)
2532 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2533 Those commands will move to this position in the line moved to
2534 rather than trying to keep the same horizontal position.
2535 With a non-nil argument, clears out the goal column
2536 so that \\[next-line] and \\[previous-line] resume vertical motion.
2537 The goal column is stored in the variable `goal-column'."
2538 (interactive "P")
2539 (if arg
2540 (progn
2541 (setq goal-column nil)
2542 (message "No goal column"))
2543 (setq goal-column (current-column))
2544 (message (substitute-command-keys
2545 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2546 goal-column))
2547 nil)
2550 (defun scroll-other-window-down (lines)
2551 "Scroll the \"other window\" down.
2552 For more details, see the documentation for `scroll-other-window'."
2553 (interactive "P")
2554 (scroll-other-window
2555 ;; Just invert the argument's meaning.
2556 ;; We can do that without knowing which window it will be.
2557 (if (eq lines '-) nil
2558 (if (null lines) '-
2559 (- (prefix-numeric-value lines))))))
2560 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2562 (defun beginning-of-buffer-other-window (arg)
2563 "Move point to the beginning of the buffer in the other window.
2564 Leave mark at previous position.
2565 With arg N, put point N/10 of the way from the true beginning."
2566 (interactive "P")
2567 (let ((orig-window (selected-window))
2568 (window (other-window-for-scrolling)))
2569 ;; We use unwind-protect rather than save-window-excursion
2570 ;; because the latter would preserve the things we want to change.
2571 (unwind-protect
2572 (progn
2573 (select-window window)
2574 ;; Set point and mark in that window's buffer.
2575 (beginning-of-buffer arg)
2576 ;; Set point accordingly.
2577 (recenter '(t)))
2578 (select-window orig-window))))
2580 (defun end-of-buffer-other-window (arg)
2581 "Move point to the end of the buffer in the other window.
2582 Leave mark at previous position.
2583 With arg N, put point N/10 of the way from the true end."
2584 (interactive "P")
2585 ;; See beginning-of-buffer-other-window for comments.
2586 (let ((orig-window (selected-window))
2587 (window (other-window-for-scrolling)))
2588 (unwind-protect
2589 (progn
2590 (select-window window)
2591 (end-of-buffer arg)
2592 (recenter '(t)))
2593 (select-window orig-window))))
2595 (defun transpose-chars (arg)
2596 "Interchange characters around point, moving forward one character.
2597 With prefix arg ARG, effect is to take character before point
2598 and drag it forward past ARG other characters (backward if ARG negative).
2599 If no argument and at end of line, the previous two chars are exchanged."
2600 (interactive "*P")
2601 (and (null arg) (eolp) (forward-char -1))
2602 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2604 (defun transpose-words (arg)
2605 "Interchange words around point, leaving point at end of them.
2606 With prefix arg ARG, effect is to take word before or around point
2607 and drag it forward past ARG other words (backward if ARG negative).
2608 If ARG is zero, the words around or after point and around or after mark
2609 are interchanged."
2610 (interactive "*p")
2611 (transpose-subr 'forward-word arg))
2613 (defun transpose-sexps (arg)
2614 "Like \\[transpose-words] but applies to sexps.
2615 Does not work on a sexp that point is in the middle of
2616 if it is a list or string."
2617 (interactive "*p")
2618 (transpose-subr 'forward-sexp arg))
2620 (defun transpose-lines (arg)
2621 "Exchange current line and previous line, leaving point after both.
2622 With argument ARG, takes previous line and moves it past ARG lines.
2623 With argument 0, interchanges line point is in with line mark is in."
2624 (interactive "*p")
2625 (transpose-subr (function
2626 (lambda (arg)
2627 (if (> arg 0)
2628 (progn
2629 ;; Move forward over ARG lines,
2630 ;; but create newlines if necessary.
2631 (setq arg (forward-line arg))
2632 (if (/= (preceding-char) ?\n)
2633 (setq arg (1+ arg)))
2634 (if (> arg 0)
2635 (newline arg)))
2636 (forward-line arg))))
2637 arg))
2639 (defvar transpose-subr-start1)
2640 (defvar transpose-subr-start2)
2641 (defvar transpose-subr-end1)
2642 (defvar transpose-subr-end2)
2644 (defun transpose-subr (mover arg)
2645 (let (transpose-subr-start1
2646 transpose-subr-end1
2647 transpose-subr-start2
2648 transpose-subr-end2)
2649 (if (= arg 0)
2650 (progn
2651 (save-excursion
2652 (funcall mover 1)
2653 (setq transpose-subr-end2 (point))
2654 (funcall mover -1)
2655 (setq transpose-subr-start2 (point))
2656 (goto-char (mark))
2657 (funcall mover 1)
2658 (setq transpose-subr-end1 (point))
2659 (funcall mover -1)
2660 (setq transpose-subr-start1 (point))
2661 (transpose-subr-1))
2662 (exchange-point-and-mark))
2663 (if (> arg 0)
2664 (progn
2665 (funcall mover -1)
2666 (setq transpose-subr-start1 (point))
2667 (funcall mover 1)
2668 (setq transpose-subr-end1 (point))
2669 (funcall mover arg)
2670 (setq transpose-subr-end2 (point))
2671 (funcall mover (- arg))
2672 (setq transpose-subr-start2 (point))
2673 (transpose-subr-1)
2674 (goto-char transpose-subr-end2))
2675 (funcall mover -1)
2676 (setq transpose-subr-start2 (point))
2677 (funcall mover 1)
2678 (setq transpose-subr-end2 (point))
2679 (funcall mover (1- arg))
2680 (setq transpose-subr-start1 (point))
2681 (funcall mover (- arg))
2682 (setq transpose-subr-end1 (point))
2683 (transpose-subr-1)))))
2685 (defun transpose-subr-1 ()
2686 (if (> (min transpose-subr-end1 transpose-subr-end2)
2687 (max transpose-subr-start1 transpose-subr-start2))
2688 (error "Don't have two things to transpose"))
2689 (let* ((word1 (buffer-substring transpose-subr-start1 transpose-subr-end1))
2690 (len1 (length word1))
2691 (word2 (buffer-substring transpose-subr-start2 transpose-subr-end2))
2692 (len2 (length word2)))
2693 (delete-region transpose-subr-start2 transpose-subr-end2)
2694 (goto-char transpose-subr-start2)
2695 (insert word1)
2696 (goto-char (if (< transpose-subr-start1 transpose-subr-start2)
2697 transpose-subr-start1
2698 (+ transpose-subr-start1 (- len1 len2))))
2699 (delete-region (point) (+ (point) len1))
2700 (insert word2)))
2702 (defun backward-word (arg)
2703 "Move backward until encountering the end of a word.
2704 With argument, do this that many times."
2705 (interactive "p")
2706 (forward-word (- arg)))
2708 (defun mark-word (arg)
2709 "Set mark arg words away from point."
2710 (interactive "p")
2711 (push-mark
2712 (save-excursion
2713 (forward-word arg)
2714 (point))
2715 nil t))
2717 (defun kill-word (arg)
2718 "Kill characters forward until encountering the end of a word.
2719 With argument, do this that many times."
2720 (interactive "p")
2721 (kill-region (point) (progn (forward-word arg) (point))))
2723 (defun backward-kill-word (arg)
2724 "Kill characters backward until encountering the end of a word.
2725 With argument, do this that many times."
2726 (interactive "p")
2727 (kill-word (- arg)))
2729 (defun current-word (&optional strict)
2730 "Return the word point is on (or a nearby word) as a string.
2731 If optional arg STRICT is non-nil, return nil unless point is within
2732 or adjacent to a word."
2733 (save-excursion
2734 (let ((oldpoint (point)) (start (point)) (end (point)))
2735 (skip-syntax-backward "w_") (setq start (point))
2736 (goto-char oldpoint)
2737 (skip-syntax-forward "w_") (setq end (point))
2738 (if (and (eq start oldpoint) (eq end oldpoint))
2739 ;; Point is neither within nor adjacent to a word.
2740 (and (not strict)
2741 (progn
2742 ;; Look for preceding word in same line.
2743 (skip-syntax-backward "^w_"
2744 (save-excursion (beginning-of-line)
2745 (point)))
2746 (if (bolp)
2747 ;; No preceding word in same line.
2748 ;; Look for following word in same line.
2749 (progn
2750 (skip-syntax-forward "^w_"
2751 (save-excursion (end-of-line)
2752 (point)))
2753 (setq start (point))
2754 (skip-syntax-forward "w_")
2755 (setq end (point)))
2756 (setq end (point))
2757 (skip-syntax-backward "w_")
2758 (setq start (point)))
2759 (buffer-substring-no-properties start end)))
2760 (buffer-substring-no-properties start end)))))
2762 (defcustom fill-prefix nil
2763 "*String for filling to insert at front of new line, or nil for none.
2764 Setting this variable automatically makes it local to the current buffer."
2765 :type '(choice (const :tag "None" nil)
2766 string)
2767 :group 'fill)
2768 (make-variable-buffer-local 'fill-prefix)
2770 (defcustom auto-fill-inhibit-regexp nil
2771 "*Regexp to match lines which should not be auto-filled."
2772 :type '(choice (const :tag "None" nil)
2773 regexp)
2774 :group 'fill)
2776 (defvar comment-line-break-function 'indent-new-comment-line
2777 "*Mode-specific function which line breaks and continues a comment.
2779 This function is only called during auto-filling of a comment section.
2780 The function should take a single optional argument, which is a flag
2781 indicating whether it should use soft newlines.
2783 Setting this variable automatically makes it local to the current buffer.")
2785 ;; This function is used as the auto-fill-function of a buffer
2786 ;; when Auto-Fill mode is enabled.
2787 ;; It returns t if it really did any work.
2788 ;; (Actually some major modes use a different auto-fill function,
2789 ;; but this one is the default one.)
2790 (defun do-auto-fill ()
2791 (let (fc justify bol give-up
2792 (fill-prefix fill-prefix))
2793 (if (or (not (setq justify (current-justification)))
2794 (null (setq fc (current-fill-column)))
2795 (and (eq justify 'left)
2796 (<= (current-column) fc))
2797 (save-excursion (beginning-of-line)
2798 (setq bol (point))
2799 (and auto-fill-inhibit-regexp
2800 (looking-at auto-fill-inhibit-regexp))))
2801 nil ;; Auto-filling not required
2802 (if (memq justify '(full center right))
2803 (save-excursion (unjustify-current-line)))
2805 ;; Choose a fill-prefix automatically.
2806 (if (and adaptive-fill-mode
2807 (or (null fill-prefix) (string= fill-prefix "")))
2808 (let ((prefix
2809 (fill-context-prefix
2810 (save-excursion (backward-paragraph 1) (point))
2811 (save-excursion (forward-paragraph 1) (point)))))
2812 (and prefix (not (equal prefix ""))
2813 (setq fill-prefix prefix))))
2815 (while (and (not give-up) (> (current-column) fc))
2816 ;; Determine where to split the line.
2817 (let* (after-prefix
2818 (fill-point
2819 (let ((opoint (point))
2820 bounce
2821 (first t))
2822 (save-excursion
2823 (beginning-of-line)
2824 (setq after-prefix (point))
2825 (and fill-prefix
2826 (looking-at (regexp-quote fill-prefix))
2827 (setq after-prefix (match-end 0)))
2828 (move-to-column (1+ fc))
2829 ;; Move back to the point where we can break the line.
2830 ;; We break the line between word or
2831 ;; after/before the character which has character
2832 ;; category `|'. We search space, \c| followed by
2833 ;; a character, or \c| following a character. If
2834 ;; not found, place the point at beginning of line.
2835 (while (or first
2836 ;; If this is after period and a single space,
2837 ;; move back once more--we don't want to break
2838 ;; the line there and make it look like a
2839 ;; sentence end.
2840 (and (not (bobp))
2841 (not bounce)
2842 sentence-end-double-space
2843 (save-excursion (forward-char -1)
2844 (and (looking-at "\\. ")
2845 (not (looking-at "\\. ")))))
2846 (and (not (bobp))
2847 (not bounce)
2848 fill-nobreak-predicate
2849 (funcall fill-nobreak-predicate)))
2850 (setq first nil)
2851 (re-search-backward "[ \t]\\|\\c|.\\|.\\c|\\|^")
2852 ;; If we find nowhere on the line to break it,
2853 ;; break after one word. Set bounce to t
2854 ;; so we will not keep going in this while loop.
2855 (if (<= (point) after-prefix)
2856 (progn
2857 (goto-char after-prefix)
2858 (re-search-forward "[ \t]" opoint t)
2859 (setq bounce t))
2860 (if (looking-at "[ \t]")
2861 ;; Break the line at word boundary.
2862 (skip-chars-backward " \t")
2863 ;; Break the line after/before \c|.
2864 (forward-char 1))))
2865 (if enable-multibyte-characters
2866 ;; If we are going to break the line after or
2867 ;; before a non-ascii character, we may have
2868 ;; to run a special function for the charset
2869 ;; of the character to find the correct break
2870 ;; point.
2871 (if (not (and (eq (charset-after (1- (point))) 'ascii)
2872 (eq (charset-after (point)) 'ascii)))
2873 (fill-find-break-point after-prefix)))
2875 ;; Let fill-point be set to the place where we end up.
2876 ;; But move back before any whitespace here.
2877 (skip-chars-backward " \t")
2878 (point)))))
2880 ;; See whether the place we found is any good.
2881 (if (save-excursion
2882 (goto-char fill-point)
2883 (and (not (bolp))
2884 ;; There is no use breaking at end of line.
2885 (not (save-excursion (skip-chars-forward " ") (eolp)))
2886 ;; It is futile to split at the end of the prefix
2887 ;; since we would just insert the prefix again.
2888 (not (and after-prefix (<= (point) after-prefix)))
2889 ;; Don't split right after a comment starter
2890 ;; since we would just make another comment starter.
2891 (not (and comment-start-skip
2892 (let ((limit (point)))
2893 (beginning-of-line)
2894 (and (re-search-forward comment-start-skip
2895 limit t)
2896 (eq (point) limit)))))))
2897 ;; Ok, we have a useful place to break the line. Do it.
2898 (let ((prev-column (current-column)))
2899 ;; If point is at the fill-point, do not `save-excursion'.
2900 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2901 ;; point will end up before it rather than after it.
2902 (if (save-excursion
2903 (skip-chars-backward " \t")
2904 (= (point) fill-point))
2905 (funcall comment-line-break-function t)
2906 (save-excursion
2907 (goto-char fill-point)
2908 (funcall comment-line-break-function t)))
2909 ;; Now do justification, if required
2910 (if (not (eq justify 'left))
2911 (save-excursion
2912 (end-of-line 0)
2913 (justify-current-line justify nil t)))
2914 ;; If making the new line didn't reduce the hpos of
2915 ;; the end of the line, then give up now;
2916 ;; trying again will not help.
2917 (if (>= (current-column) prev-column)
2918 (setq give-up t)))
2919 ;; No good place to break => stop trying.
2920 (setq give-up t))))
2921 ;; Justify last line.
2922 (justify-current-line justify t t)
2923 t)))
2925 (defvar normal-auto-fill-function 'do-auto-fill
2926 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
2927 Some major modes set this.")
2929 (defun auto-fill-mode (&optional arg)
2930 "Toggle Auto Fill mode.
2931 With arg, turn Auto Fill mode on if and only if arg is positive.
2932 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
2933 automatically breaks the line at a previous space.
2935 The value of `normal-auto-fill-function' specifies the function to use
2936 for `auto-fill-function' when turning Auto Fill mode on."
2937 (interactive "P")
2938 (prog1 (setq auto-fill-function
2939 (if (if (null arg)
2940 (not auto-fill-function)
2941 (> (prefix-numeric-value arg) 0))
2942 normal-auto-fill-function
2943 nil))
2944 (force-mode-line-update)))
2946 ;; This holds a document string used to document auto-fill-mode.
2947 (defun auto-fill-function ()
2948 "Automatically break line at a previous space, in insertion of text."
2949 nil)
2951 (defun turn-on-auto-fill ()
2952 "Unconditionally turn on Auto Fill mode."
2953 (auto-fill-mode 1))
2955 (defun turn-off-auto-fill ()
2956 "Unconditionally turn off Auto Fill mode."
2957 (auto-fill-mode -1))
2959 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
2961 (defun set-fill-column (arg)
2962 "Set `fill-column' to specified argument.
2963 Use \\[universal-argument] followed by a number to specify a column.
2964 Just \\[universal-argument] as argument means to use the current column."
2965 (interactive "P")
2966 (if (consp arg)
2967 (setq arg (current-column)))
2968 (if (not (integerp arg))
2969 ;; Disallow missing argument; it's probably a typo for C-x C-f.
2970 (error "set-fill-column requires an explicit argument")
2971 (message "Fill column set to %d (was %d)" arg fill-column)
2972 (setq fill-column arg)))
2974 (defun set-selective-display (arg)
2975 "Set `selective-display' to ARG; clear it if no arg.
2976 When the value of `selective-display' is a number > 0,
2977 lines whose indentation is >= that value are not displayed.
2978 The variable `selective-display' has a separate value for each buffer."
2979 (interactive "P")
2980 (if (eq selective-display t)
2981 (error "selective-display already in use for marked lines"))
2982 (let ((current-vpos
2983 (save-restriction
2984 (narrow-to-region (point-min) (point))
2985 (goto-char (window-start))
2986 (vertical-motion (window-height)))))
2987 (setq selective-display
2988 (and arg (prefix-numeric-value arg)))
2989 (recenter current-vpos))
2990 (set-window-start (selected-window) (window-start (selected-window)))
2991 (princ "selective-display set to " t)
2992 (prin1 selective-display t)
2993 (princ "." t))
2995 (defvar overwrite-mode-textual " Ovwrt"
2996 "The string displayed in the mode line when in overwrite mode.")
2997 (defvar overwrite-mode-binary " Bin Ovwrt"
2998 "The string displayed in the mode line when in binary overwrite mode.")
3000 (defun overwrite-mode (arg)
3001 "Toggle overwrite mode.
3002 With arg, turn overwrite mode on iff arg is positive.
3003 In overwrite mode, printing characters typed in replace existing text
3004 on a one-for-one basis, rather than pushing it to the right. At the
3005 end of a line, such characters extend the line. Before a tab,
3006 such characters insert until the tab is filled in.
3007 \\[quoted-insert] still inserts characters in overwrite mode; this
3008 is supposed to make it easier to insert characters when necessary."
3009 (interactive "P")
3010 (setq overwrite-mode
3011 (if (if (null arg) (not overwrite-mode)
3012 (> (prefix-numeric-value arg) 0))
3013 'overwrite-mode-textual))
3014 (force-mode-line-update))
3016 (defun binary-overwrite-mode (arg)
3017 "Toggle binary overwrite mode.
3018 With arg, turn binary overwrite mode on iff arg is positive.
3019 In binary overwrite mode, printing characters typed in replace
3020 existing text. Newlines are not treated specially, so typing at the
3021 end of a line joins the line to the next, with the typed character
3022 between them. Typing before a tab character simply replaces the tab
3023 with the character typed.
3024 \\[quoted-insert] replaces the text at the cursor, just as ordinary
3025 typing characters do.
3027 Note that binary overwrite mode is not its own minor mode; it is a
3028 specialization of overwrite-mode, entered by setting the
3029 `overwrite-mode' variable to `overwrite-mode-binary'."
3030 (interactive "P")
3031 (setq overwrite-mode
3032 (if (if (null arg)
3033 (not (eq overwrite-mode 'overwrite-mode-binary))
3034 (> (prefix-numeric-value arg) 0))
3035 'overwrite-mode-binary))
3036 (force-mode-line-update))
3038 (defcustom line-number-mode t
3039 "*Non-nil means display line number in mode line."
3040 :type 'boolean
3041 :group 'editing-basics)
3043 (defun line-number-mode (arg)
3044 "Toggle Line Number mode.
3045 With arg, turn Line Number mode on iff arg is positive.
3046 When Line Number mode is enabled, the line number appears
3047 in the mode line.
3049 Line numbers do not appear for very large buffers, see variable
3050 `line-number-display-limit'."
3051 (interactive "P")
3052 (setq line-number-mode
3053 (if (null arg) (not line-number-mode)
3054 (> (prefix-numeric-value arg) 0)))
3055 (force-mode-line-update))
3057 (defcustom column-number-mode nil
3058 "*Non-nil means display column number in mode line."
3059 :type 'boolean
3060 :group 'editing-basics)
3062 (defun column-number-mode (arg)
3063 "Toggle Column Number mode.
3064 With arg, turn Column Number mode on iff arg is positive.
3065 When Column Number mode is enabled, the column number appears
3066 in the mode line."
3067 (interactive "P")
3068 (setq column-number-mode
3069 (if (null arg) (not column-number-mode)
3070 (> (prefix-numeric-value arg) 0)))
3071 (force-mode-line-update))
3073 (defgroup paren-blinking nil
3074 "Blinking matching of parens and expressions."
3075 :prefix "blink-matching-"
3076 :group 'paren-matching)
3078 (defcustom blink-matching-paren t
3079 "*Non-nil means show matching open-paren when close-paren is inserted."
3080 :type 'boolean
3081 :group 'paren-blinking)
3083 (defcustom blink-matching-paren-on-screen t
3084 "*Non-nil means show matching open-paren when it is on screen.
3085 If nil, means don't show it (but the open-paren can still be shown
3086 when it is off screen)."
3087 :type 'boolean
3088 :group 'paren-blinking)
3090 (defcustom blink-matching-paren-distance (* 25 1024)
3091 "*If non-nil, is maximum distance to search for matching open-paren."
3092 :type 'integer
3093 :group 'paren-blinking)
3095 (defcustom blink-matching-delay 1
3096 "*Time in seconds to delay after showing a matching paren."
3097 :type 'number
3098 :group 'paren-blinking)
3100 (defcustom blink-matching-paren-dont-ignore-comments nil
3101 "*Non-nil means `blink-matching-paren' will not ignore comments."
3102 :type 'boolean
3103 :group 'paren-blinking)
3105 (defun blink-matching-open ()
3106 "Move cursor momentarily to the beginning of the sexp before point."
3107 (interactive)
3108 (and (> (point) (1+ (point-min)))
3109 blink-matching-paren
3110 ;; Verify an even number of quoting characters precede the close.
3111 (= 1 (logand 1 (- (point)
3112 (save-excursion
3113 (forward-char -1)
3114 (skip-syntax-backward "/\\")
3115 (point)))))
3116 (let* ((oldpos (point))
3117 (blinkpos)
3118 (mismatch))
3119 (save-excursion
3120 (save-restriction
3121 (if blink-matching-paren-distance
3122 (narrow-to-region (max (point-min)
3123 (- (point) blink-matching-paren-distance))
3124 oldpos))
3125 (condition-case ()
3126 (let ((parse-sexp-ignore-comments
3127 (and parse-sexp-ignore-comments
3128 (not blink-matching-paren-dont-ignore-comments))))
3129 (setq blinkpos (scan-sexps oldpos -1)))
3130 (error nil)))
3131 (and blinkpos
3132 (/= (char-syntax (char-after blinkpos))
3133 ?\$)
3134 (setq mismatch
3135 (or (null (matching-paren (char-after blinkpos)))
3136 (/= (char-after (1- oldpos))
3137 (matching-paren (char-after blinkpos))))))
3138 (if mismatch (setq blinkpos nil))
3139 (if blinkpos
3140 ;; Don't log messages about paren matching.
3141 (let (message-log-max)
3142 (goto-char blinkpos)
3143 (if (pos-visible-in-window-p)
3144 (and blink-matching-paren-on-screen
3145 (sit-for blink-matching-delay))
3146 (goto-char blinkpos)
3147 (message
3148 "Matches %s"
3149 ;; Show what precedes the open in its line, if anything.
3150 (if (save-excursion
3151 (skip-chars-backward " \t")
3152 (not (bolp)))
3153 (buffer-substring (progn (beginning-of-line) (point))
3154 (1+ blinkpos))
3155 ;; Show what follows the open in its line, if anything.
3156 (if (save-excursion
3157 (forward-char 1)
3158 (skip-chars-forward " \t")
3159 (not (eolp)))
3160 (buffer-substring blinkpos
3161 (progn (end-of-line) (point)))
3162 ;; Otherwise show the previous nonblank line,
3163 ;; if there is one.
3164 (if (save-excursion
3165 (skip-chars-backward "\n \t")
3166 (not (bobp)))
3167 (concat
3168 (buffer-substring (progn
3169 (skip-chars-backward "\n \t")
3170 (beginning-of-line)
3171 (point))
3172 (progn (end-of-line)
3173 (skip-chars-backward " \t")
3174 (point)))
3175 ;; Replace the newline and other whitespace with `...'.
3176 "..."
3177 (buffer-substring blinkpos (1+ blinkpos)))
3178 ;; There is nothing to show except the char itself.
3179 (buffer-substring blinkpos (1+ blinkpos))))))))
3180 (cond (mismatch
3181 (message "Mismatched parentheses"))
3182 ((not blink-matching-paren-distance)
3183 (message "Unmatched parenthesis"))))))))
3185 ;Turned off because it makes dbx bomb out.
3186 (setq blink-paren-function 'blink-matching-open)
3188 ;; This executes C-g typed while Emacs is waiting for a command.
3189 ;; Quitting out of a program does not go through here;
3190 ;; that happens in the QUIT macro at the C code level.
3191 (defun keyboard-quit ()
3192 "Signal a `quit' condition.
3193 During execution of Lisp code, this character causes a quit directly.
3194 At top-level, as an editor command, this simply beeps."
3195 (interactive)
3196 (deactivate-mark)
3197 (signal 'quit nil))
3199 (define-key global-map "\C-g" 'keyboard-quit)
3201 (defvar buffer-quit-function nil
3202 "Function to call to \"quit\" the current buffer, or nil if none.
3203 \\[keyboard-escape-quit] calls this function when its more local actions
3204 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3206 (defun keyboard-escape-quit ()
3207 "Exit the current \"mode\" (in a generalized sense of the word).
3208 This command can exit an interactive command such as `query-replace',
3209 can clear out a prefix argument or a region,
3210 can get out of the minibuffer or other recursive edit,
3211 cancel the use of the current buffer (for special-purpose buffers),
3212 or go back to just one window (by deleting all but the selected window)."
3213 (interactive)
3214 (cond ((eq last-command 'mode-exited) nil)
3215 ((> (minibuffer-depth) 0)
3216 (abort-recursive-edit))
3217 (current-prefix-arg
3218 nil)
3219 ((and transient-mark-mode
3220 mark-active)
3221 (deactivate-mark))
3222 ((> (recursion-depth) 0)
3223 (exit-recursive-edit))
3224 (buffer-quit-function
3225 (funcall buffer-quit-function))
3226 ((not (one-window-p t))
3227 (delete-other-windows))
3228 ((string-match "^ \\*" (buffer-name (current-buffer)))
3229 (bury-buffer))))
3231 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3233 (defcustom input-mode-8-bit t
3234 "Control acceptance of 8-bit keyboard input.
3235 This may be useful for inputting non-ASCII characters if your keyboard
3236 can generate them. It is not necessary to change this under a window
3237 system which can distinguish 8-bit characters and Meta keys.
3238 Setting this variable directly does not take effect;
3239 use either M-x customize or the function `set-input-mode'."
3240 :set (lambda (symbol value)
3241 (let ((mode (current-input-mode)))
3242 (set-input-mode (nth 0 mode) (nth 1 mode) value)))
3243 :initialize 'custom-initialize-default
3244 :type '(choice (const :tag "8-bit input for a Meta key" t)
3245 (const :tag "Direct 8-bit character input" 0)
3246 (const :tag "Assume top bit is parity and ignore" nil))
3247 :version "21.1"
3248 :link '(custom-manual "Single-Byte European Support")
3249 :group 'keyboard)
3251 (defcustom read-mail-command 'rmail
3252 "*Your preference for a mail reading package.
3253 This is used by some keybindings which support reading mail.
3254 See also `mail-user-agent' concerning sending mail."
3255 :type '(choice (function-item rmail)
3256 (function-item gnus)
3257 (function-item mh-rmail)
3258 (function :tag "Other"))
3259 :version "21.1"
3260 :group 'mail)
3262 (defcustom mail-user-agent 'sendmail-user-agent
3263 "*Your preference for a mail composition package.
3264 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
3265 outgoing email message. This variable lets you specify which
3266 mail-sending package you prefer.
3268 Valid values include:
3270 `sendmail-user-agent' -- use the default Emacs Mail package.
3271 See Info node `(emacs)Sending Mail'.
3272 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
3273 See Info node `(mh-e)'.
3274 `message-user-agent' -- use the Gnus Message package.
3275 See Info node `(message)'.
3276 `gnus-user-agent' -- like `message-user-agent', but with Gnus
3277 paraphernalia, particularly the Gcc: header for
3278 archiving.
3280 Additional valid symbols may be available; check with the author of
3281 your package for details.
3283 See also `read-mail-command' concerning reading mail."
3284 :type '(radio (function-item :tag "Default Emacs mail"
3285 :format "%t\n"
3286 sendmail-user-agent)
3287 (function-item :tag "Emacs interface to MH"
3288 :format "%t\n"
3289 mh-e-user-agent)
3290 (function-item :tag "Gnus Message package"
3291 :format "%t\n"
3292 message-user-agent)
3293 (function-item :tag "Gnus Message with full Gnus features"
3294 :format "%t\n"
3295 gnus-user-agent)
3296 (function :tag "Other"))
3297 :group 'mail)
3299 (defun define-mail-user-agent (symbol composefunc sendfunc
3300 &optional abortfunc hookvar)
3301 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3303 SYMBOL can be any Lisp symbol. Its function definition and/or
3304 value as a variable do not matter for this usage; we use only certain
3305 properties on its property list, to encode the rest of the arguments.
3307 COMPOSEFUNC is program callable function that composes an outgoing
3308 mail message buffer. This function should set up the basics of the
3309 buffer without requiring user interaction. It should populate the
3310 standard mail headers, leaving the `to:' and `subject:' headers blank
3311 by default.
3313 COMPOSEFUNC should accept several optional arguments--the same
3314 arguments that `compose-mail' takes. See that function's documentation.
3316 SENDFUNC is the command a user would run to send the message.
3318 Optional ABORTFUNC is the command a user would run to abort the
3319 message. For mail packages that don't have a separate abort function,
3320 this can be `kill-buffer' (the equivalent of omitting this argument).
3322 Optional HOOKVAR is a hook variable that gets run before the message
3323 is actually sent. Callers that use the `mail-user-agent' may
3324 install a hook function temporarily on this hook variable.
3325 If HOOKVAR is nil, `mail-send-hook' is used.
3327 The properties used on SYMBOL are `composefunc', `sendfunc',
3328 `abortfunc', and `hookvar'."
3329 (put symbol 'composefunc composefunc)
3330 (put symbol 'sendfunc sendfunc)
3331 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3332 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3334 (define-mail-user-agent 'sendmail-user-agent
3335 'sendmail-user-agent-compose
3336 'mail-send-and-exit)
3338 (defun rfc822-goto-eoh ()
3339 ;; Go to header delimiter line in a mail message, following RFC822 rules
3340 (goto-char (point-min))
3341 (while (looking-at "^[^: \n]+:\\|^[ \t]")
3342 (forward-line 1))
3343 (point))
3345 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3346 switch-function yank-action
3347 send-actions)
3348 (if switch-function
3349 (let ((special-display-buffer-names nil)
3350 (special-display-regexps nil)
3351 (same-window-buffer-names nil)
3352 (same-window-regexps nil))
3353 (funcall switch-function "*mail*")))
3354 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3355 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3356 (body (cdr (assoc-ignore-case "body" other-headers))))
3357 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3358 continue
3359 (error "Message aborted"))
3360 (save-excursion
3361 (rfc822-goto-eoh)
3362 (while other-headers
3363 (unless (member-ignore-case (car (car other-headers))
3364 '("in-reply-to" "cc" "body"))
3365 (insert (car (car other-headers)) ": "
3366 (cdr (car other-headers)) "\n"))
3367 (setq other-headers (cdr other-headers)))
3368 (when body
3369 (forward-line 1)
3370 (insert body))
3371 t)))
3373 (define-mail-user-agent 'mh-e-user-agent
3374 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3375 'mh-before-send-letter-hook)
3377 (defun compose-mail (&optional to subject other-headers continue
3378 switch-function yank-action send-actions)
3379 "Start composing a mail message to send.
3380 This uses the user's chosen mail composition package
3381 as selected with the variable `mail-user-agent'.
3382 The optional arguments TO and SUBJECT specify recipients
3383 and the initial Subject field, respectively.
3385 OTHER-HEADERS is an alist specifying additional
3386 header fields. Elements look like (HEADER . VALUE) where both
3387 HEADER and VALUE are strings.
3389 CONTINUE, if non-nil, says to continue editing a message already
3390 being composed.
3392 SWITCH-FUNCTION, if non-nil, is a function to use to
3393 switch to and display the buffer used for mail composition.
3395 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3396 to insert the raw text of the message being replied to.
3397 It has the form (FUNCTION . ARGS). The user agent will apply
3398 FUNCTION to ARGS, to insert the raw text of the original message.
3399 \(The user agent will also run `mail-citation-hook', *after* the
3400 original text has been inserted in this way.)
3402 SEND-ACTIONS is a list of actions to call when the message is sent.
3403 Each action has the form (FUNCTION . ARGS)."
3404 (interactive
3405 (list nil nil nil current-prefix-arg))
3406 (let ((function (get mail-user-agent 'composefunc)))
3407 (funcall function to subject other-headers continue
3408 switch-function yank-action send-actions)))
3410 (defun compose-mail-other-window (&optional to subject other-headers continue
3411 yank-action send-actions)
3412 "Like \\[compose-mail], but edit the outgoing message in another window."
3413 (interactive
3414 (list nil nil nil current-prefix-arg))
3415 (compose-mail to subject other-headers continue
3416 'switch-to-buffer-other-window yank-action send-actions))
3419 (defun compose-mail-other-frame (&optional to subject other-headers continue
3420 yank-action send-actions)
3421 "Like \\[compose-mail], but edit the outgoing message in another frame."
3422 (interactive
3423 (list nil nil nil current-prefix-arg))
3424 (compose-mail to subject other-headers continue
3425 'switch-to-buffer-other-frame yank-action send-actions))
3427 (defvar set-variable-value-history nil
3428 "History of values entered with `set-variable'.")
3430 (defun set-variable (var val)
3431 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3432 When using this interactively, enter a Lisp object for VALUE.
3433 If you want VALUE to be a string, you must surround it with doublequotes.
3434 VALUE is used literally, not evaluated.
3436 If VARIABLE has a `variable-interactive' property, that is used as if
3437 it were the arg to `interactive' (which see) to interactively read VALUE.
3439 If VARIABLE has been defined with `defcustom', then the type information
3440 in the definition is used to check that VALUE is valid."
3441 (interactive
3442 (let* ((default-var (variable-at-point))
3443 (var (if (symbolp default-var)
3444 (read-variable (format "Set variable (default %s): " default-var)
3445 default-var)
3446 (read-variable "Set variable: ")))
3447 (minibuffer-help-form '(describe-variable var))
3448 (prop (get var 'variable-interactive))
3449 (prompt (format "Set %s to value: " var))
3450 (val (if prop
3451 ;; Use VAR's `variable-interactive' property
3452 ;; as an interactive spec for prompting.
3453 (call-interactively `(lambda (arg)
3454 (interactive ,prop)
3455 arg))
3456 (read
3457 (read-string prompt nil
3458 'set-variable-value-history)))))
3459 (list var val)))
3461 (let ((type (get var 'custom-type)))
3462 (when type
3463 ;; Match with custom type.
3464 (require 'wid-edit)
3465 (setq type (widget-convert type))
3466 (unless (widget-apply type :match val)
3467 (error "Value `%S' does not match type %S of %S"
3468 val (car type) var))))
3469 (set var val))
3471 ;; Define the major mode for lists of completions.
3473 (defvar completion-list-mode-map nil
3474 "Local map for completion list buffers.")
3475 (or completion-list-mode-map
3476 (let ((map (make-sparse-keymap)))
3477 (define-key map [mouse-2] 'mouse-choose-completion)
3478 (define-key map [down-mouse-2] nil)
3479 (define-key map "\C-m" 'choose-completion)
3480 (define-key map "\e\e\e" 'delete-completion-window)
3481 (define-key map [left] 'previous-completion)
3482 (define-key map [right] 'next-completion)
3483 (setq completion-list-mode-map map)))
3485 ;; Completion mode is suitable only for specially formatted data.
3486 (put 'completion-list-mode 'mode-class 'special)
3488 (defvar completion-reference-buffer nil
3489 "Record the buffer that was current when the completion list was requested.
3490 This is a local variable in the completion list buffer.
3491 Initial value is nil to avoid some compiler warnings.")
3493 (defvar completion-no-auto-exit nil
3494 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3495 This also applies to other functions such as `choose-completion'
3496 and `mouse-choose-completion'.")
3498 (defvar completion-base-size nil
3499 "Number of chars at beginning of minibuffer not involved in completion.
3500 This is a local variable in the completion list buffer
3501 but it talks about the buffer in `completion-reference-buffer'.
3502 If this is nil, it means to compare text to determine which part
3503 of the tail end of the buffer's text is involved in completion.")
3505 (defun delete-completion-window ()
3506 "Delete the completion list window.
3507 Go to the window from which completion was requested."
3508 (interactive)
3509 (let ((buf completion-reference-buffer))
3510 (if (one-window-p t)
3511 (if (window-dedicated-p (selected-window))
3512 (delete-frame (selected-frame)))
3513 (delete-window (selected-window))
3514 (if (get-buffer-window buf)
3515 (select-window (get-buffer-window buf))))))
3517 (defun previous-completion (n)
3518 "Move to the previous item in the completion list."
3519 (interactive "p")
3520 (next-completion (- n)))
3522 (defun next-completion (n)
3523 "Move to the next item in the completion list.
3524 With prefix argument N, move N items (negative N means move backward)."
3525 (interactive "p")
3526 (while (and (> n 0) (not (eobp)))
3527 (let ((prop (get-text-property (point) 'mouse-face))
3528 (end (point-max)))
3529 ;; If in a completion, move to the end of it.
3530 (if prop
3531 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3532 ;; Move to start of next one.
3533 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3534 (setq n (1- n)))
3535 (while (and (< n 0) (not (bobp)))
3536 (let ((prop (get-text-property (1- (point)) 'mouse-face))
3537 (end (point-min)))
3538 ;; If in a completion, move to the start of it.
3539 (if prop
3540 (goto-char (previous-single-property-change
3541 (point) 'mouse-face nil end)))
3542 ;; Move to end of the previous completion.
3543 (goto-char (previous-single-property-change (point) 'mouse-face nil end))
3544 ;; Move to the start of that one.
3545 (goto-char (previous-single-property-change (point) 'mouse-face nil end)))
3546 (setq n (1+ n))))
3548 (defun choose-completion ()
3549 "Choose the completion that point is in or next to."
3550 (interactive)
3551 (let (beg end completion (buffer completion-reference-buffer)
3552 (base-size completion-base-size))
3553 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3554 (setq end (point) beg (1+ (point))))
3555 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3556 (setq end (1- (point)) beg (point)))
3557 (if (null beg)
3558 (error "No completion here"))
3559 (setq beg (previous-single-property-change beg 'mouse-face))
3560 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3561 (setq completion (buffer-substring beg end))
3562 (let ((owindow (selected-window)))
3563 (if (and (one-window-p t 'selected-frame)
3564 (window-dedicated-p (selected-window)))
3565 ;; This is a special buffer's frame
3566 (iconify-frame (selected-frame))
3567 (or (window-dedicated-p (selected-window))
3568 (bury-buffer)))
3569 (select-window owindow))
3570 (choose-completion-string completion buffer base-size)))
3572 ;; Delete the longest partial match for STRING
3573 ;; that can be found before POINT.
3574 (defun choose-completion-delete-max-match (string)
3575 (let ((opoint (point))
3576 (len (min (length string)
3577 (- (point) (point-min)))))
3578 (goto-char (- (point) (length string)))
3579 (if completion-ignore-case
3580 (setq string (downcase string)))
3581 (while (and (> len 0)
3582 (let ((tail (buffer-substring (point)
3583 (+ (point) len))))
3584 (if completion-ignore-case
3585 (setq tail (downcase tail)))
3586 (not (string= tail (substring string 0 len)))))
3587 (setq len (1- len))
3588 (forward-char 1))
3589 (delete-char len)))
3591 ;; Switch to BUFFER and insert the completion choice CHOICE.
3592 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3593 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
3595 ;; If BUFFER is the minibuffer, exit the minibuffer
3596 ;; unless it is reading a file name and CHOICE is a directory,
3597 ;; or completion-no-auto-exit is non-nil.
3598 (defun choose-completion-string (choice &optional buffer base-size)
3599 (let ((buffer (or buffer completion-reference-buffer))
3600 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))))
3601 ;; If BUFFER is a minibuffer, barf unless it's the currently
3602 ;; active minibuffer.
3603 (if (and mini-p
3604 (or (not (active-minibuffer-window))
3605 (not (equal buffer
3606 (window-buffer (active-minibuffer-window))))))
3607 (error "Minibuffer is not active for completion")
3608 ;; Insert the completion into the buffer where completion was requested.
3609 (set-buffer buffer)
3610 (if base-size
3611 (delete-region (+ base-size (if mini-p
3612 (minibuffer-prompt-end)
3613 (point-min)))
3614 (point))
3615 (choose-completion-delete-max-match choice))
3616 (insert choice)
3617 (remove-text-properties (- (point) (length choice)) (point)
3618 '(mouse-face nil))
3619 ;; Update point in the window that BUFFER is showing in.
3620 (let ((window (get-buffer-window buffer t)))
3621 (set-window-point window (point)))
3622 ;; If completing for the minibuffer, exit it with this choice.
3623 (and (not completion-no-auto-exit)
3624 (equal buffer (window-buffer (minibuffer-window)))
3625 minibuffer-completion-table
3626 ;; If this is reading a file name, and the file name chosen
3627 ;; is a directory, don't exit the minibuffer.
3628 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
3629 (file-directory-p (field-string (point-max))))
3630 (select-window (active-minibuffer-window))
3631 (exit-minibuffer))))))
3633 (defun completion-list-mode ()
3634 "Major mode for buffers showing lists of possible completions.
3635 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3636 to select the completion near point.
3637 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3638 with the mouse."
3639 (interactive)
3640 (kill-all-local-variables)
3641 (use-local-map completion-list-mode-map)
3642 (setq mode-name "Completion List")
3643 (setq major-mode 'completion-list-mode)
3644 (make-local-variable 'completion-base-size)
3645 (setq completion-base-size nil)
3646 (run-hooks 'completion-list-mode-hook))
3648 (defvar completion-setup-hook nil
3649 "Normal hook run at the end of setting up a completion list buffer.
3650 When this hook is run, the current buffer is the one in which the
3651 command to display the completion list buffer was run.
3652 The completion list buffer is available as the value of `standard-output'.")
3654 ;; This function goes in completion-setup-hook, so that it is called
3655 ;; after the text of the completion list buffer is written.
3657 (defun completion-setup-function ()
3658 (save-excursion
3659 (let ((mainbuf (current-buffer)))
3660 (set-buffer standard-output)
3661 (completion-list-mode)
3662 (make-local-variable 'completion-reference-buffer)
3663 (setq completion-reference-buffer mainbuf)
3664 (if (eq minibuffer-completion-table 'read-file-name-internal)
3665 ;; For file name completion,
3666 ;; use the number of chars before the start of the
3667 ;; last file name component.
3668 (setq completion-base-size
3669 (save-excursion
3670 (set-buffer mainbuf)
3671 (goto-char (point-max))
3672 (skip-chars-backward (format "^%c" directory-sep-char))
3673 (- (point) (minibuffer-prompt-end))))
3674 ;; Otherwise, in minibuffer, the whole input is being completed.
3675 (save-match-data
3676 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3677 (buffer-name mainbuf))
3678 (setq completion-base-size 0))))
3679 (goto-char (point-min))
3680 (if (display-mouse-p)
3681 (insert (substitute-command-keys
3682 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
3683 (insert (substitute-command-keys
3684 "In this buffer, type \\[choose-completion] to \
3685 select the completion near point.\n\n")))))
3687 (add-hook 'completion-setup-hook 'completion-setup-function)
3689 (define-key minibuffer-local-completion-map [prior]
3690 'switch-to-completions)
3691 (define-key minibuffer-local-must-match-map [prior]
3692 'switch-to-completions)
3693 (define-key minibuffer-local-completion-map "\M-v"
3694 'switch-to-completions)
3695 (define-key minibuffer-local-must-match-map "\M-v"
3696 'switch-to-completions)
3698 (defun switch-to-completions ()
3699 "Select the completion list window."
3700 (interactive)
3701 ;; Make sure we have a completions window.
3702 (or (get-buffer-window "*Completions*")
3703 (minibuffer-completion-help))
3704 (let ((window (get-buffer-window "*Completions*")))
3705 (when window
3706 (select-window window)
3707 (goto-char (point-min))
3708 (search-forward "\n\n")
3709 (forward-line 1))))
3711 ;; Support keyboard commands to turn on various modifiers.
3713 ;; These functions -- which are not commands -- each add one modifier
3714 ;; to the following event.
3716 (defun event-apply-alt-modifier (ignore-prompt)
3717 "Add the Alt modifier to the following event.
3718 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
3719 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3720 (defun event-apply-super-modifier (ignore-prompt)
3721 "Add the Super modifier to the following event.
3722 For example, type \\[event-apply-super-modifier] & to enter Super-&."
3723 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3724 (defun event-apply-hyper-modifier (ignore-prompt)
3725 "Add the Hyper modifier to the following event.
3726 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
3727 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3728 (defun event-apply-shift-modifier (ignore-prompt)
3729 "Add the Shift modifier to the following event.
3730 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
3731 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3732 (defun event-apply-control-modifier (ignore-prompt)
3733 "Add the Ctrl modifier to the following event.
3734 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
3735 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3736 (defun event-apply-meta-modifier (ignore-prompt)
3737 "Add the Meta modifier to the following event.
3738 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
3739 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3741 (defun event-apply-modifier (event symbol lshiftby prefix)
3742 "Apply a modifier flag to event EVENT.
3743 SYMBOL is the name of this modifier, as a symbol.
3744 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3745 PREFIX is the string that represents this modifier in an event type symbol."
3746 (if (numberp event)
3747 (cond ((eq symbol 'control)
3748 (if (and (<= (downcase event) ?z)
3749 (>= (downcase event) ?a))
3750 (- (downcase event) ?a -1)
3751 (if (and (<= (downcase event) ?Z)
3752 (>= (downcase event) ?A))
3753 (- (downcase event) ?A -1)
3754 (logior (lsh 1 lshiftby) event))))
3755 ((eq symbol 'shift)
3756 (if (and (<= (downcase event) ?z)
3757 (>= (downcase event) ?a))
3758 (upcase event)
3759 (logior (lsh 1 lshiftby) event)))
3761 (logior (lsh 1 lshiftby) event)))
3762 (if (memq symbol (event-modifiers event))
3763 event
3764 (let ((event-type (if (symbolp event) event (car event))))
3765 (setq event-type (intern (concat prefix (symbol-name event-type))))
3766 (if (symbolp event)
3767 event-type
3768 (cons event-type (cdr event)))))))
3770 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3771 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3772 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3773 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3774 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3775 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3777 ;;;; Keypad support.
3779 ;;; Make the keypad keys act like ordinary typing keys. If people add
3780 ;;; bindings for the function key symbols, then those bindings will
3781 ;;; override these, so this shouldn't interfere with any existing
3782 ;;; bindings.
3784 ;; Also tell read-char how to handle these keys.
3785 (mapcar
3786 (lambda (keypad-normal)
3787 (let ((keypad (nth 0 keypad-normal))
3788 (normal (nth 1 keypad-normal)))
3789 (put keypad 'ascii-character normal)
3790 (define-key function-key-map (vector keypad) (vector normal))))
3791 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3792 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3793 (kp-space ?\ )
3794 (kp-tab ?\t)
3795 (kp-enter ?\r)
3796 (kp-multiply ?*)
3797 (kp-add ?+)
3798 (kp-separator ?,)
3799 (kp-subtract ?-)
3800 (kp-decimal ?.)
3801 (kp-divide ?/)
3802 (kp-equal ?=)))
3804 ;;;;
3805 ;;;; forking a twin copy of a buffer.
3806 ;;;;
3808 (defvar clone-buffer-hook nil
3809 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
3811 (defun clone-process (process &optional newname)
3812 "Create a twin copy of PROCESS.
3813 If NEWNAME is nil, it defaults to PROCESS' name;
3814 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3815 If PROCESS is associated with a buffer, the new process will be associated
3816 with the current buffer instead.
3817 Returns nil if PROCESS has already terminated."
3818 (setq newname (or newname (process-name process)))
3819 (if (string-match "<[0-9]+>\\'" newname)
3820 (setq newname (substring newname 0 (match-beginning 0))))
3821 (when (memq (process-status process) '(run stop open))
3822 (let* ((process-connection-type (process-tty-name process))
3823 (old-kwoq (process-kill-without-query process nil))
3824 (new-process
3825 (if (memq (process-status process) '(open))
3826 (apply 'open-network-stream newname
3827 (if (process-buffer process) (current-buffer))
3828 (process-contact process))
3829 (apply 'start-process newname
3830 (if (process-buffer process) (current-buffer))
3831 (process-command process)))))
3832 (process-kill-without-query new-process old-kwoq)
3833 (process-kill-without-query process old-kwoq)
3834 (set-process-inherit-coding-system-flag
3835 new-process (process-inherit-coding-system-flag process))
3836 (set-process-filter new-process (process-filter process))
3837 (set-process-sentinel new-process (process-sentinel process))
3838 new-process)))
3840 ;; things to maybe add (currently partly covered by `funcall mode':
3841 ;; - syntax-table
3842 ;; - overlays
3843 (defun clone-buffer (&optional newname display-flag)
3844 "Create a twin copy of the current buffer.
3845 If NEWNAME is nil, it defaults to the current buffer's name;
3846 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3848 If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
3849 This runs the normal hook `clone-buffer-hook' in the new buffer
3850 after it has been set up properly in other respects."
3851 (interactive (list (if current-prefix-arg (read-string "Name: "))
3853 (if buffer-file-name
3854 (error "Cannot clone a file-visiting buffer"))
3855 (if (get major-mode 'no-clone)
3856 (error "Cannot clone a buffer in %s mode" mode-name))
3857 (setq newname (or newname (buffer-name)))
3858 (if (string-match "<[0-9]+>\\'" newname)
3859 (setq newname (substring newname 0 (match-beginning 0))))
3860 (let ((buf (current-buffer))
3861 (ptmin (point-min))
3862 (ptmax (point-max))
3863 (pt (point))
3864 (mk (if mark-active (mark t)))
3865 (modified (buffer-modified-p))
3866 (mode major-mode)
3867 (lvars (buffer-local-variables))
3868 (process (get-buffer-process (current-buffer)))
3869 (new (generate-new-buffer (or newname (buffer-name)))))
3870 (save-restriction
3871 (widen)
3872 (with-current-buffer new
3873 (insert-buffer-substring buf)))
3874 (with-current-buffer new
3875 (narrow-to-region ptmin ptmax)
3876 (goto-char pt)
3877 (if mk (set-mark mk))
3878 (set-buffer-modified-p modified)
3880 ;; Clone the old buffer's process, if any.
3881 (when process (clone-process process))
3883 ;; Now set up the major mode.
3884 (funcall mode)
3886 ;; Set up other local variables.
3887 (mapcar (lambda (v)
3888 (condition-case () ;in case var is read-only
3889 (if (symbolp v)
3890 (makunbound v)
3891 (set (make-local-variable (car v)) (cdr v)))
3892 (error nil)))
3893 lvars)
3895 ;; Run any hooks (typically set up by the major mode
3896 ;; for cloning to work properly).
3897 (run-hooks 'clone-buffer-hook))
3898 (if display-flag (pop-to-buffer new))
3899 new))
3902 (defun clone-indirect-buffer (newname display-flag &optional norecord)
3903 "Create an indirect buffer that is a twin copy of the current buffer.
3905 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
3906 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
3907 or if not called with a prefix arg, NEWNAME defaults to the current
3908 buffer's name. The name is modified by adding a `<N>' suffix to it
3909 or by incrementing the N in an existing suffix.
3911 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
3912 This is always done when called interactively.
3914 Optional last arg NORECORD non-nil means do not put this buffer at the
3915 front of the list of recently selected ones."
3916 (interactive (list (if current-prefix-arg
3917 (read-string "BName of indirect buffer: "))
3919 (setq newname (or newname (buffer-name)))
3920 (if (string-match "<[0-9]+>\\'" newname)
3921 (setq newname (substring newname 0 (match-beginning 0))))
3922 (let* ((name (generate-new-buffer-name newname))
3923 (buffer (make-indirect-buffer (current-buffer) name t)))
3924 (when display-flag
3925 (pop-to-buffer buffer))
3926 buffer))
3929 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
3930 "Create an indirect buffer that is a twin copy of BUFFER.
3931 Select the new buffer in another window.
3932 Optional second arg NORECORD non-nil means do not put this buffer at
3933 the front of the list of recently selected ones."
3934 (interactive "bClone buffer in other window: ")
3935 (let ((popup-windows t))
3936 (set-buffer buffer)
3937 (clone-indirect-buffer nil t norecord)))
3939 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
3942 ;;; Syntax stuff.
3944 (defconst syntax-code-table
3945 '((?\ 0 "whitespace")
3946 (?- 0 "whitespace")
3947 (?. 1 "punctuation")
3948 (?w 2 "word")
3949 (?_ 3 "symbol")
3950 (?\( 4 "open parenthesis")
3951 (?\) 5 "close parenthesis")
3952 (?\' 6 "expression prefix")
3953 (?\" 7 "string quote")
3954 (?$ 8 "paired delimiter")
3955 (?\\ 9 "escape")
3956 (?/ 10 "character quote")
3957 (?< 11 "comment start")
3958 (?> 12 "comment end")
3959 (?@ 13 "inherit")
3960 (nil 14 "comment fence")
3961 (nil 15 "string fence"))
3962 "Alist of forms (CHAR CODE DESCRIPTION) mapping characters to syntax info.
3963 CHAR is a character that is allowed as first char in the string
3964 specifying the syntax when calling `modify-syntax-entry'. CODE is the
3965 corresponing syntax code as it is stored in a syntax cell, and
3966 can be used as value of a `syntax-table' property.
3967 DESCRIPTION is the descriptive string for the syntax.")
3970 ;;; Misc
3972 (defun byte-compiling-files-p ()
3973 "Return t if currently byte-compiling files."
3974 (and (boundp 'byte-compile-current-file)
3975 (stringp byte-compile-current-file)))
3977 ;;; simple.el ends here