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)
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.
25 ;; A grab-bag of basic Emacs commands not specifically related to some
26 ;; major mode or to file-handling.
35 "Killing and yanking commands"
38 (defgroup paren-matching nil
39 "Highlight (un)matching of parens and expressions."
43 (defun fundamental-mode ()
44 "Major mode not specialized for anything in particular.
45 Other major modes are defined by comparison with this one."
47 (kill-all-local-variables))
49 ;; Making and deleting lines.
51 (defun newline (&optional arg)
52 "Insert a newline, and move to left margin of the new line if it's blank.
53 The newline is marked with the text-property `hard'.
54 With arg, insert that many newlines.
55 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
57 (barf-if-buffer-read-only)
58 ;; Inserting a newline at the end of a line produces better redisplay in
59 ;; try_window_id than inserting at the beginning of a line, and the textual
60 ;; result is the same. So, if we're at beginning of line, pretend to be at
61 ;; the end of the previous line.
62 (let ((flag (and (not (bobp))
64 ;; Make sure no functions want to be told about
65 ;; the range of the changes.
66 (not after-change-functions)
67 (not before-change-functions)
68 ;; Make sure there are no markers here.
69 (not (buffer-has-markers-at (1- (point))))
70 (not (buffer-has-markers-at (point)))
71 ;; Make sure no text properties want to know
72 ;; where the change was.
73 (not (get-char-property (1- (point)) 'modification-hooks))
74 (not (get-char-property (1- (point)) 'insert-behind-hooks))
76 (not (get-char-property (point) 'insert-in-front-hooks)))
77 ;; Make sure the newline before point isn't intangible.
78 (not (get-char-property (1- (point)) 'intangible))
79 ;; Make sure the newline before point isn't read-only.
80 (not (get-char-property (1- (point)) 'read-only))
81 ;; Make sure the newline before point isn't invisible.
82 (not (get-char-property (1- (point)) 'invisible))
83 ;; Make sure the newline before point has the same
84 ;; properties as the char before it (if any).
85 (< (or (previous-property-change (point)) -2)
87 (was-page-start (and (bolp)
88 (looking-at page-delimiter)))
90 (if flag (backward-char 1))
91 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
92 ;; Set last-command-char to tell self-insert what to insert.
93 (let ((last-command-char ?\n)
94 ;; Don't auto-fill if we have a numeric argument.
95 ;; Also not if flag is true (it would fill wrong line);
96 ;; there is no need to since we're at BOL.
97 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
99 (self-insert-command (prefix-numeric-value arg))
100 ;; If we get an error in self-insert-command, put point at right place.
101 (if flag (forward-char 1))))
102 ;; Even if we did *not* get an error, keep that forward-char;
103 ;; all further processing should apply to the newline that the user
104 ;; thinks he inserted.
106 ;; Mark the newline(s) `hard'.
107 (if use-hard-newlines
108 (set-hard-newline-properties
109 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
110 ;; If the newline leaves the previous line blank,
111 ;; and we have a left margin, delete that from the blank line.
114 (goto-char beforepos)
116 (and (looking-at "[ \t]$")
117 (> (current-left-margin) 0)
118 (delete-region (point) (progn (end-of-line) (point))))))
119 ;; Indent the line after the newline, except in one case:
120 ;; when we added the newline at the beginning of a line
121 ;; which starts a page.
123 (move-to-left-margin nil t)))
126 (defun set-hard-newline-properties (from to)
127 (let ((sticky (get-text-property from 'rear-nonsticky)))
128 (put-text-property from to 'hard 't)
129 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
130 (if (and (listp sticky) (not (memq 'hard sticky)))
131 (put-text-property from (point) 'rear-nonsticky
132 (cons 'hard sticky)))))
134 (defun open-line (arg)
135 "Insert a newline and leave point before it.
136 If there is a fill prefix and/or a left-margin, insert them on the new line
137 if the line would have been blank.
138 With arg N, insert N newlines."
140 (let* ((do-fill-prefix (and fill-prefix (bolp)))
141 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
147 (if do-left-margin (indent-to (current-left-margin)))
148 (if do-fill-prefix (insert-and-inherit fill-prefix))))
155 "Split current line, moving portion beyond point vertically down."
157 (skip-chars-forward " \t")
158 (let ((col (current-column))
164 (defun delete-indentation (&optional arg)
165 "Join this line to previous and fix up whitespace at join.
166 If there is a fill prefix, delete it from the beginning of this line.
167 With argument, join this line to following line."
170 (if arg (forward-line 1))
171 (if (eq (preceding-char) ?\n)
173 (delete-region (point) (1- (point)))
174 ;; If the second line started with the fill prefix,
175 ;; delete the prefix.
177 (<= (+ (point) (length fill-prefix)) (point-max))
179 (buffer-substring (point)
180 (+ (point) (length fill-prefix)))))
181 (delete-region (point) (+ (point) (length fill-prefix))))
182 (fixup-whitespace))))
184 (defalias 'join-line #'delete-indentation) ; easier to find
186 (defun delete-blank-lines ()
187 "On blank line, delete all surrounding blank lines, leaving just one.
188 On isolated blank line, delete that one.
189 On nonblank line, delete any immediately following blank lines."
191 (let (thisblank singleblank)
194 (setq thisblank (looking-at "[ \t]*$"))
195 ;; Set singleblank if there is just one blank line here.
198 (not (looking-at "[ \t]*\n[ \t]*$"))
200 (progn (forward-line -1)
201 (not (looking-at "[ \t]*$")))))))
202 ;; Delete preceding blank lines, and this one too if it's the only one.
206 (if singleblank (forward-line 1))
207 (delete-region (point)
208 (if (re-search-backward "[^ \t\n]" nil t)
209 (progn (forward-line 1) (point))
211 ;; Delete following blank lines, unless the current line is blank
212 ;; and there are no following blank lines.
213 (if (not (and thisblank singleblank))
217 (delete-region (point)
218 (if (re-search-forward "[^ \t\n]" nil t)
219 (progn (beginning-of-line) (point))
221 ;; Handle the special case where point is followed by newline and eob.
222 ;; Delete the line, leaving point at eob.
223 (if (looking-at "^[ \t]*\n\\'")
224 (delete-region (point) (point-max)))))
226 (defun newline-and-indent ()
227 "Insert a newline, then indent according to major mode.
228 Indentation is done using the value of `indent-line-function'.
229 In programming language modes, this is the same as TAB.
230 In some text modes, where TAB inserts a tab, this command indents to the
231 column specified by the function `current-left-margin'."
233 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
235 (indent-according-to-mode))
237 (defun reindent-then-newline-and-indent ()
238 "Reindent current line, insert newline, then indent the new line.
239 Indentation of both lines is done according to the current major mode,
240 which means calling the current value of `indent-line-function'.
241 In programming language modes, this is the same as TAB.
242 In some text modes, where TAB inserts a tab, this indents to the
243 column specified by the function `current-left-margin'."
246 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
247 (indent-according-to-mode))
249 (indent-according-to-mode))
251 (defun quoted-insert (arg)
252 "Read next input character and insert it.
253 This is useful for inserting control characters.
255 If the first character you type after this command is an octal digit,
256 you should type a sequence of octal digits which specify a character code.
257 Any nondigit terminates the sequence. If the terminator is a RET,
258 it is discarded; any other terminator is used itself as input.
259 The variable `read-quoted-char-radix' specifies the radix for this feature;
260 set it to 10 or 16 to use decimal or hex instead of octal.
262 In overwrite mode, this function inserts the character anyway, and
263 does not handle octal digits specially. This means that if you use
264 overwrite as your normal editing mode, you can use this function to
265 insert characters when necessary.
267 In binary overwrite mode, this function does overwrite, and octal
268 digits are interpreted as a character code. This is intended to be
269 useful for editing binary files."
271 (let ((char (if (or (not overwrite-mode)
272 (eq overwrite-mode 'overwrite-mode-binary))
275 ;; Assume character codes 0240 - 0377 stand for characters in some
276 ;; single-byte character set, and convert them to Emacs
278 (if (and enable-multibyte-characters
281 (setq char (unibyte-char-to-multibyte char)))
283 (if (eq overwrite-mode 'overwrite-mode-binary)
286 (insert-and-inherit char)
287 (setq arg (1- arg)))))
289 (defun forward-to-indentation (arg)
290 "Move forward ARG lines and position at first nonblank character."
293 (skip-chars-forward " \t"))
295 (defun backward-to-indentation (arg)
296 "Move backward ARG lines and position at first nonblank character."
298 (forward-line (- arg))
299 (skip-chars-forward " \t"))
301 (defun back-to-indentation ()
302 "Move point to the first non-whitespace character on this line."
304 (beginning-of-line 1)
305 (skip-chars-forward " \t"))
307 (defun fixup-whitespace ()
308 "Fixup white space between objects around point.
309 Leave one space or none, according to the context."
312 (delete-horizontal-space)
313 (if (or (looking-at "^\\|\\s)")
314 (save-excursion (forward-char -1)
315 (looking-at "$\\|\\s(\\|\\s'")))
319 (defun delete-horizontal-space ()
320 "Delete all spaces and tabs around point."
322 (skip-chars-backward " \t")
323 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
325 (defun just-one-space ()
326 "Delete all spaces and tabs around point, leaving one space."
328 (skip-chars-backward " \t")
329 (if (= (following-char) ? )
332 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
335 (defun beginning-of-buffer (&optional arg)
336 "Move point to the beginning of the buffer; leave mark at previous position.
337 With arg N, put point N/10 of the way from the beginning.
339 If the buffer is narrowed, this command uses the beginning and size
340 of the accessible part of the buffer.
342 Don't use this command in Lisp programs!
343 \(goto-char (point-min)) is faster and avoids clobbering the mark."
346 (let ((size (- (point-max) (point-min))))
350 ;; Avoid overflow for large buffer sizes!
351 (* (prefix-numeric-value arg)
353 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
355 (if arg (forward-line 1)))
357 (defun end-of-buffer (&optional arg)
358 "Move point to the end of the buffer; leave mark at previous position.
359 With arg N, put point N/10 of the way from the end.
361 If the buffer is narrowed, this command uses the beginning and size
362 of the accessible part of the buffer.
364 Don't use this command in Lisp programs!
365 \(goto-char (point-max)) is faster and avoids clobbering the mark."
368 (let ((size (- (point-max) (point-min))))
372 ;; Avoid overflow for large buffer sizes!
373 (* (prefix-numeric-value arg)
375 (/ (* size (prefix-numeric-value arg)) 10)))
377 ;; If we went to a place in the middle of the buffer,
378 ;; adjust it to the beginning of a line.
379 (cond (arg (forward-line 1))
380 ((< (point) (window-end nil t))
381 ;; If the end of the buffer is not already on the screen,
382 ;; then scroll specially to put it near, but not at, the bottom.
383 (overlay-recenter (point))
386 (defun mark-whole-buffer ()
387 "Put point at beginning and mark at end of buffer.
388 You probably should not use this function in Lisp programs;
389 it is usually a mistake for a Lisp function to use any subroutine
390 that uses or sets the mark."
393 (push-mark (point-max) nil t)
394 (goto-char (point-min)))
397 ;; Counting lines, one way or another.
399 (defun goto-line (arg)
400 "Goto line ARG, counting from line 1 at beginning of buffer."
401 (interactive "NGoto line: ")
402 (setq arg (prefix-numeric-value arg))
406 (if (eq selective-display t)
407 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
408 (forward-line (1- arg)))))
410 (defun count-lines-region (start end)
411 "Print number of lines and characters in the region."
413 (message "Region has %d lines, %d characters"
414 (count-lines start end) (- end start)))
417 "Print the current buffer line number and narrowed line number of point."
419 (let ((opoint (point)) start)
422 (goto-char (point-min))
429 (message "line %d (narrowed line %d)"
430 (1+ (count-lines 1 (point)))
431 (1+ (count-lines start (point))))
432 (message "Line %d" (1+ (count-lines 1 (point)))))))))
434 (defun count-lines (start end)
435 "Return number of lines between START and END.
436 This is usually the number of newlines between them,
437 but can be one more if START is not equal to END
438 and the greater of them is not at the start of a line."
441 (narrow-to-region start end)
442 (goto-char (point-min))
443 (if (eq selective-display t)
446 (while (re-search-forward "[\n\C-m]" nil t 40)
447 (setq done (+ 40 done)))
448 (while (re-search-forward "[\n\C-m]" nil t 1)
449 (setq done (+ 1 done)))
450 (goto-char (point-max))
451 (if (and (/= start end)
455 (- (buffer-size) (forward-line (buffer-size)))))))
457 (defun what-cursor-position (&optional detail)
458 "Print info on cursor position (on screen and within buffer).
459 Also describe the character after point, and give its character code
460 in octal, decimal and hex.
462 For a non-ASCII multibyte character, also give its encoding in the
463 buffer's selected coding system if the coding system encodes the
464 character safely. If the character is encoded into one byte, that
465 code is shown in hex. If the character is encoded into more than one
466 byte, just \"...\" is shown.
468 In addition, with prefix argument, show details about that character
469 in *Help* buffer. See also the command `describe-char-after'."
471 (let* ((char (following-char))
475 (total (buffer-size))
476 (percent (if (> total 50000)
477 ;; Avoid overflow from multiplying by 100!
478 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
479 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
480 (hscroll (if (= (window-hscroll) 0)
482 (format " Hscroll=%d" (window-hscroll))))
483 (col (current-column)))
485 (if (or (/= beg 1) (/= end (1+ total)))
486 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
487 pos total percent beg end col hscroll)
488 (message "point=%d of %d (%d%%) column %d %s"
489 pos total percent col hscroll))
490 (let ((coding buffer-file-coding-system)
491 encoded encoding-msg)
493 (eq (coding-system-type coding) t))
494 (setq coding default-buffer-file-coding-system))
495 (if (not (char-valid-p char))
497 (format "(0%o, %d, 0x%x, invalid)" char char char))
498 (setq encoded (and (>= char 128) (encode-coding-char char coding)))
501 (format "(0%o, %d, 0x%x, file %s)"
503 (if (> (length encoded) 1)
505 (encoded-string-description encoded coding)))
506 (format "(0%o, %d, 0x%x)" char char char))))
508 ;; We show the detailed information about CHAR.
509 (describe-char-after (point)))
510 (if (or (/= beg 1) (/= end (1+ total)))
511 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
513 (single-key-description char)
514 (buffer-substring-no-properties (point) (1+ (point))))
515 encoding-msg pos total percent beg end col hscroll)
516 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
518 (single-key-description char)
519 (buffer-substring-no-properties (point) (1+ (point))))
520 encoding-msg pos total percent col hscroll))))))
522 (defvar read-expression-map (cons 'keymap minibuffer-local-map)
523 "Minibuffer keymap used for reading Lisp expressions.")
524 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
526 (defvar read-expression-history nil)
528 (defcustom eval-expression-print-level 4
529 "*Value to use for `print-level' when printing value in `eval-expression'."
534 (defcustom eval-expression-print-length 12
535 "*Value to use for `print-length' when printing value in `eval-expression'."
540 (defcustom eval-expression-debug-on-error t
541 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
542 If nil, don't change the value of `debug-on-error'."
547 ;; We define this, rather than making `eval' interactive,
548 ;; for the sake of completion of names like eval-region, eval-current-buffer.
549 (defun eval-expression (eval-expression-arg
550 &optional eval-expression-insert-value)
551 "Evaluate EXPRESSION and print value in minibuffer.
552 Value is also consed on to front of the variable `values'."
554 (list (read-from-minibuffer "Eval: "
555 nil read-expression-map t
556 'read-expression-history)
559 (if (null eval-expression-debug-on-error)
560 (setq values (cons (eval eval-expression-arg) values))
561 (let ((old-value (make-symbol "t")) new-value)
562 ;; Bind debug-on-error to something unique so that we can
563 ;; detect when evaled code changes it.
564 (let ((debug-on-error old-value))
565 (setq values (cons (eval eval-expression-arg) values))
566 (setq new-value debug-on-error))
567 ;; If evaled code has changed the value of debug-on-error,
568 ;; propagate that change to the global binding.
569 (unless (eq old-value new-value)
570 (setq debug-on-error new-value))))
572 (let ((print-length eval-expression-print-length)
573 (print-level eval-expression-print-level))
575 (if eval-expression-insert-value (current-buffer) t))))
577 (defun edit-and-eval-command (prompt command)
578 "Prompting with PROMPT, let user edit COMMAND and eval result.
579 COMMAND is a Lisp expression. Let user edit that expression in
580 the minibuffer, then read and evaluate the result."
581 (let ((command (read-from-minibuffer prompt
582 (prin1-to-string command)
583 read-expression-map t
584 '(command-history . 1))))
585 ;; If command was added to command-history as a string,
586 ;; get rid of that. We want only evaluable expressions there.
587 (if (stringp (car command-history))
588 (setq command-history (cdr command-history)))
590 ;; If command to be redone does not match front of history,
591 ;; add it to the history.
592 (or (equal command (car command-history))
593 (setq command-history (cons command command-history)))
596 (defun repeat-complex-command (arg)
597 "Edit and re-evaluate last complex command, or ARGth from last.
598 A complex command is one which used the minibuffer.
599 The command is placed in the minibuffer as a Lisp form for editing.
600 The result is executed, repeating the command as changed.
601 If the command has been changed or is not the most recent previous command
602 it is added to the front of the command history.
603 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
604 to get different commands to edit and resubmit."
606 (let ((elt (nth (1- arg) command-history))
611 (let ((print-level nil)
612 (minibuffer-history-position arg)
613 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
614 (read-from-minibuffer
615 "Redo: " (prin1-to-string elt) read-expression-map t
616 (cons 'command-history arg))))
618 ;; If command was added to command-history as a string,
619 ;; get rid of that. We want only evaluable expressions there.
620 (if (stringp (car command-history))
621 (setq command-history (cdr command-history)))
623 ;; If command to be redone does not match front of history,
624 ;; add it to the history.
625 (or (equal newcmd (car command-history))
626 (setq command-history (cons newcmd command-history)))
630 (defvar minibuffer-history nil
631 "Default minibuffer history list.
632 This is used for all minibuffer input
633 except when an alternate history list is specified.")
634 (defvar minibuffer-history-sexp-flag nil
635 "Non-nil when doing history operations on `command-history'.
636 More generally, indicates that the history list being acted on
637 contains expressions rather than strings.
638 It is only valid if its value equals the current minibuffer depth,
639 to handle recursive uses of the minibuffer.")
640 (setq minibuffer-history-variable 'minibuffer-history)
641 (setq minibuffer-history-position nil)
642 (defvar minibuffer-history-search-history nil)
645 (lambda (key-and-command)
647 (lambda (keymap-and-completionp)
648 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
649 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
650 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
651 (define-key (symbol-value (car keymap-and-completionp))
652 (car key-and-command)
653 (let ((command (cdr key-and-command)))
655 ;; (and ... nil) => ... turns back on the completion-oriented
656 ;; history commands which rms turned off since they seem to
657 ;; do things he doesn't like.
658 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
659 (progn (error "EMACS BUG!") (cdr command))
662 '((minibuffer-local-map . nil)
663 (minibuffer-local-ns-map . nil)
664 (minibuffer-local-completion-map . t)
665 (minibuffer-local-must-match-map . t)
666 (read-expression-map . nil))))
667 '(("\en" . (next-history-element . next-complete-history-element))
668 ([next] . (next-history-element . next-complete-history-element))
669 ("\ep" . (previous-history-element . previous-complete-history-element))
670 ([prior] . (previous-history-element . previous-complete-history-element))
671 ("\er" . previous-matching-history-element)
672 ("\es" . next-matching-history-element)))
674 (defvar minibuffer-text-before-history nil
675 "Text that was in this minibuffer before any history commands.
676 This is nil if there have not yet been any history commands
677 in this use of the minibuffer.")
679 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
681 (defun minibuffer-history-initialize ()
682 (setq minibuffer-text-before-history nil))
684 (defcustom minibuffer-history-case-insensitive-variables nil
685 "*Minibuffer history variables for which matching should ignore case.
686 If a history variable is a member of this list, then the
687 \\[previous-matching-history-element] and \\[next-matching-history-element]\
688 commands ignore case when searching it, regardless of `case-fold-search'."
689 :type '(repeat variable)
692 (defun previous-matching-history-element (regexp n)
693 "Find the previous history element that matches REGEXP.
694 \(Previous history elements refer to earlier actions.)
695 With prefix argument N, search for Nth previous match.
696 If N is negative, find the next or Nth next match.
697 An uppercase letter in REGEXP makes the search case-sensitive.
698 See also `minibuffer-history-case-insensitive-variables'."
700 (let* ((enable-recursive-minibuffers t)
701 (regexp (read-from-minibuffer "Previous element matching (regexp): "
705 'minibuffer-history-search-history)))
706 ;; Use the last regexp specified, by default, if input is empty.
707 (list (if (string= regexp "")
708 (if minibuffer-history-search-history
709 (car minibuffer-history-search-history)
710 (error "No previous history search regexp"))
712 (prefix-numeric-value current-prefix-arg))))
713 (if (and (zerop minibuffer-history-position)
714 (null minibuffer-text-before-history))
715 (setq minibuffer-text-before-history (field-string (point-max))))
716 (let ((history (symbol-value minibuffer-history-variable))
718 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
719 ;; On some systems, ignore case for file names.
720 (if (memq minibuffer-history-variable
721 minibuffer-history-case-insensitive-variables)
723 ;; Respect the user's setting for case-fold-search:
727 (pos minibuffer-history-position))
730 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
733 "No later matching history item"
734 "No earlier matching history item")))
735 (if (string-match regexp
736 (if (eq minibuffer-history-sexp-flag
738 (let ((print-level nil))
739 (prin1-to-string (nth (1- pos) history)))
740 (nth (1- pos) history)))
741 (setq n (+ n (if (< n 0) 1 -1)))))
742 (setq minibuffer-history-position pos)
743 (goto-char (point-max))
745 (let ((elt (nth (1- pos) history)))
746 (insert (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
747 (let ((print-level nil))
748 (prin1-to-string elt))
750 (goto-char (field-beginning)))
751 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
752 (eq (car (car command-history)) 'next-matching-history-element))
753 (setq command-history (cdr command-history))))
755 (defun next-matching-history-element (regexp n)
756 "Find the next history element that matches REGEXP.
757 \(The next history element refers to a more recent action.)
758 With prefix argument N, search for Nth next match.
759 If N is negative, find the previous or Nth previous match.
760 An uppercase letter in REGEXP makes the search case-sensitive."
762 (let* ((enable-recursive-minibuffers t)
763 (regexp (read-from-minibuffer "Next element matching (regexp): "
767 'minibuffer-history-search-history)))
768 ;; Use the last regexp specified, by default, if input is empty.
769 (list (if (string= regexp "")
770 (setcar minibuffer-history-search-history
771 (nth 1 minibuffer-history-search-history))
773 (prefix-numeric-value current-prefix-arg))))
774 (previous-matching-history-element regexp (- n)))
776 (defun next-history-element (n)
777 "Insert the next element of the minibuffer history into the minibuffer."
780 (let ((narg (- minibuffer-history-position n))
781 (minimum (if minibuffer-default -1 0))
782 elt minibuffer-returned-to-present)
783 (if (and (zerop minibuffer-history-position)
784 (null minibuffer-text-before-history))
785 (setq minibuffer-text-before-history (field-string (point-max))))
787 (if minibuffer-default
788 (error "End of history; no next item")
789 (error "End of history; no default available")))
790 (if (> narg (length (symbol-value minibuffer-history-variable)))
791 (error "Beginning of history; no preceding item"))
792 (goto-char (point-max))
794 (setq minibuffer-history-position narg)
796 (setq elt minibuffer-default))
798 (setq elt (or minibuffer-text-before-history ""))
799 (setq minibuffer-returned-to-present t)
800 (setq minibuffer-text-before-history nil))
801 (t (setq elt (nth (1- minibuffer-history-position)
802 (symbol-value minibuffer-history-variable)))))
804 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
805 (not minibuffer-returned-to-present))
806 (let ((print-level nil))
807 (prin1-to-string elt))
809 (goto-char (field-beginning)))))
811 (defun previous-history-element (n)
812 "Inserts the previous element of the minibuffer history into the minibuffer."
814 (next-history-element (- n)))
816 (defun next-complete-history-element (n)
817 "Get next history element which completes the minibuffer before the point.
818 The contents of the minibuffer after the point are deleted, and replaced
819 by the new completion."
821 (let ((point-at-start (point)))
822 (next-matching-history-element
824 "^" (regexp-quote (buffer-substring (field-beginning) (point))))
826 ;; next-matching-history-element always puts us at (point-min).
827 ;; Move to the position we were at before changing the buffer contents.
828 ;; This is still sensical, because the text before point has not changed.
829 (goto-char point-at-start)))
831 (defun previous-complete-history-element (n)
833 Get previous history element which completes the minibuffer before the point.
834 The contents of the minibuffer after the point are deleted, and replaced
835 by the new completion."
837 (next-complete-history-element (- n)))
839 ;; These two functions are for compatibility with the old subrs of the
842 (defun minibuffer-prompt-width ()
843 "Return the display width of the minibuffer prompt.
844 Return 0 if current buffer is not a mini-buffer."
845 ;; Return the width of everything before the field at the end of
846 ;; the buffer; this should be 0 for normal buffers.
847 (1- (field-beginning (point-max))))
849 (defun minibuffer-prompt-end ()
850 "Return the buffer position of the end of the minibuffer prompt.
851 Return 0 if current buffer is not a mini-buffer."
852 (field-beginning (point-max)))
855 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
856 (defalias 'advertised-undo 'undo)
858 (defun undo (&optional arg)
859 "Undo some previous changes.
860 Repeat this command to undo more changes.
861 A numeric argument serves as a repeat count.
863 Just C-u as argument requests selective undo,
864 limited to changes within the current region.
865 Likewise in Transient Mark mode when the mark is active."
867 ;; If we don't get all the way thru, make last-command indicate that
868 ;; for the following command.
869 (setq this-command t)
870 (let ((modified (buffer-modified-p))
871 (recent-save (recent-auto-save-p)))
872 (or (eq (selected-window) (minibuffer-window))
874 (or (eq last-command 'undo)
875 (progn (if (or arg (and transient-mark-mode mark-active))
876 (undo-start (region-beginning) (region-end))
879 (undo-more (if arg (prefix-numeric-value arg) 1))
880 ;; Don't specify a position in the undo record for the undo command.
881 ;; Instead, undoing this should move point to where the change is.
882 (let ((tail buffer-undo-list)
884 (while (and tail (not done) (not (null (car tail))))
885 (if (integerp (car tail))
888 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
889 (setq tail (cdr tail))))
890 (and modified (not (buffer-modified-p))
891 (delete-auto-save-file-if-necessary recent-save)))
892 ;; If we do get all the way thru, make this-command indicate that.
893 (setq this-command 'undo))
895 (defvar pending-undo-list nil
896 "Within a run of consecutive undo commands, list remaining to be undone.")
898 (defvar undo-in-progress nil
899 "Non-nil while performing an undo.
900 Some change-hooks test this variable to do something different.")
902 (defun undo-more (count)
903 "Undo back N undo-boundaries beyond what was already undone recently.
904 Call `undo-start' to get ready to undo recent changes,
905 then call `undo-more' one or more times to undo them."
906 (or pending-undo-list
907 (error "No further undo information"))
908 (let ((undo-in-progress t))
909 (setq pending-undo-list (primitive-undo count pending-undo-list))))
911 ;; Deep copy of a list
912 (defun undo-copy-list (list)
913 "Make a copy of undo list LIST."
914 (mapcar 'undo-copy-list-1 list))
916 (defun undo-copy-list-1 (elt)
918 (cons (car elt) (undo-copy-list-1 (cdr elt)))
921 (defun undo-start (&optional beg end)
922 "Set `pending-undo-list' to the front of the undo list.
923 The next call to `undo-more' will undo the most recently made change.
924 If BEG and END are specified, then only undo elements
925 that apply to text between BEG and END are used; other undo elements
926 are ignored. If BEG and END are nil, all undo elements are used."
927 (if (eq buffer-undo-list t)
928 (error "No undo information in this buffer"))
929 (setq pending-undo-list
930 (if (and beg end (not (= beg end)))
931 (undo-make-selective-list (min beg end) (max beg end))
934 (defvar undo-adjusted-markers)
936 (defun undo-make-selective-list (start end)
937 "Return a list of undo elements for the region START to END.
938 The elements come from `buffer-undo-list', but we keep only
939 the elements inside this region, and discard those outside this region.
940 If we find an element that crosses an edge of this region,
941 we stop and ignore all further elements."
942 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
943 (undo-list (list nil))
944 undo-adjusted-markers
946 undo-elt undo-elt temp-undo-list delta)
947 (while undo-list-copy
948 (setq undo-elt (car undo-list-copy))
950 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
951 ;; This is a "was unmodified" element.
952 ;; Keep it if we have kept everything thus far.
955 (undo-elt-in-region undo-elt start end)))))
958 (setq end (+ end (cdr (undo-delta undo-elt))))
959 ;; Don't put two nils together in the list
960 (if (not (and (eq (car undo-list) nil)
962 (setq undo-list (cons undo-elt undo-list))))
963 (if (undo-elt-crosses-region undo-elt start end)
964 (setq undo-list-copy nil)
965 (setq some-rejected t)
966 (setq temp-undo-list (cdr undo-list-copy))
967 (setq delta (undo-delta undo-elt))
969 (when (/= (cdr delta) 0)
970 (let ((position (car delta))
971 (offset (cdr delta)))
973 ;; Loop down the earlier events adjusting their buffer positions
974 ;; to reflect the fact that a change to the buffer isn't being
975 ;; undone. We only need to process those element types which
976 ;; undo-elt-in-region will return as being in the region since
977 ;; only those types can ever get into the output
979 (while temp-undo-list
980 (setq undo-elt (car temp-undo-list))
981 (cond ((integerp undo-elt)
982 (if (>= undo-elt position)
983 (setcar temp-undo-list (- undo-elt offset))))
984 ((atom undo-elt) nil)
985 ((stringp (car undo-elt))
987 (let ((text-pos (abs (cdr undo-elt)))
988 (point-at-end (< (cdr undo-elt) 0 )))
989 (if (>= text-pos position)
990 (setcdr undo-elt (* (if point-at-end -1 1)
991 (- text-pos offset))))))
992 ((integerp (car undo-elt))
994 (when (>= (car undo-elt) position)
995 (setcar undo-elt (- (car undo-elt) offset))
996 (setcdr undo-elt (- (cdr undo-elt) offset))))
997 ((null (car undo-elt))
998 ;; (nil PROPERTY VALUE BEG . END)
999 (let ((tail (nthcdr 3 undo-elt)))
1000 (when (>= (car tail) position)
1001 (setcar tail (- (car tail) offset))
1002 (setcdr tail (- (cdr tail) offset))))))
1003 (setq temp-undo-list (cdr temp-undo-list))))))))
1004 (setq undo-list-copy (cdr undo-list-copy)))
1005 (nreverse undo-list)))
1007 (defun undo-elt-in-region (undo-elt start end)
1008 "Determine whether UNDO-ELT falls inside the region START ... END.
1009 If it crosses the edge, we return nil."
1010 (cond ((integerp undo-elt)
1011 (and (>= undo-elt start)
1017 ((stringp (car undo-elt))
1018 ;; (TEXT . POSITION)
1019 (and (>= (abs (cdr undo-elt)) start)
1020 (< (abs (cdr undo-elt)) end)))
1021 ((and (consp undo-elt) (markerp (car undo-elt)))
1022 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1023 ;; See if MARKER is inside the region.
1024 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1026 (setq alist-elt (cons (car undo-elt)
1027 (marker-position (car undo-elt))))
1028 (setq undo-adjusted-markers
1029 (cons alist-elt undo-adjusted-markers)))
1030 (and (cdr alist-elt)
1031 (>= (cdr alist-elt) start)
1032 (< (cdr alist-elt) end))))
1033 ((null (car undo-elt))
1034 ;; (nil PROPERTY VALUE BEG . END)
1035 (let ((tail (nthcdr 3 undo-elt)))
1036 (and (>= (car tail) start)
1037 (< (cdr tail) end))))
1038 ((integerp (car undo-elt))
1040 (and (>= (car undo-elt) start)
1041 (< (cdr undo-elt) end)))))
1043 (defun undo-elt-crosses-region (undo-elt start end)
1044 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1045 This assumes we have already decided that UNDO-ELT
1046 is not *inside* the region START...END."
1047 (cond ((atom undo-elt) nil)
1048 ((null (car undo-elt))
1049 ;; (nil PROPERTY VALUE BEG . END)
1050 (let ((tail (nthcdr 3 undo-elt)))
1051 (not (or (< (car tail) end)
1052 (> (cdr tail) start)))))
1053 ((integerp (car undo-elt))
1055 (not (or (< (car undo-elt) end)
1056 (> (cdr undo-elt) start))))))
1058 ;; Return the first affected buffer position and the delta for an undo element
1059 ;; delta is defined as the change in subsequent buffer positions if we *did*
1061 (defun undo-delta (undo-elt)
1062 (if (consp undo-elt)
1063 (cond ((stringp (car undo-elt))
1064 ;; (TEXT . POSITION)
1065 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1066 ((integerp (car undo-elt))
1068 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1073 (defvar shell-command-history nil
1074 "History list for some commands that read shell commands.")
1076 (defvar shell-command-switch "-c"
1077 "Switch used to have the shell execute its command line argument.")
1079 (defvar shell-command-default-error-buffer nil
1080 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1081 This buffer is used when `shell-command' or 'shell-command-on-region'
1082 is run interactively. A value of nil means that output to stderr and
1083 stdout will be intermixed in the output stream.")
1085 (defun shell-command (command &optional output-buffer error-buffer)
1086 "Execute string COMMAND in inferior shell; display output, if any.
1088 If COMMAND ends in ampersand, execute it asynchronously.
1089 The output appears in the buffer `*Async Shell Command*'.
1090 That buffer is in shell mode.
1092 Otherwise, COMMAND is executed synchronously. The output appears in the
1093 buffer `*Shell Command Output*'.
1094 If the output is one line, it is displayed in the echo area *as well*,
1095 but it is nonetheless available in buffer `*Shell Command Output*',
1096 even though that buffer is not automatically displayed.
1097 If there is no output, or if output is inserted in the current buffer,
1098 then `*Shell Command Output*' is deleted.
1100 To specify a coding system for converting non-ASCII characters
1101 in the shell command output, use \\[universal-coding-system-argument]
1102 before this command.
1104 Noninteractive callers can specify coding systems by binding
1105 `coding-system-for-read' and `coding-system-for-write'.
1107 The optional second argument OUTPUT-BUFFER, if non-nil,
1108 says to put the output in some other buffer.
1109 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1110 If OUTPUT-BUFFER is not a buffer and not nil,
1111 insert output in current buffer. (This cannot be done asynchronously.)
1112 In either case, the output is inserted after point (leaving mark after it).
1114 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1115 or buffer name to which to direct the command's standard error output.
1116 If it is nil, error output is mingled with regular output.
1117 In an interactive call, the variable `shell-command-default-error-buffer'
1118 specifies the value of ERROR-BUFFER."
1120 (interactive (list (read-from-minibuffer "Shell command: "
1121 nil nil nil 'shell-command-history)
1123 shell-command-default-error-buffer))
1124 ;; Look for a handler in case default-directory is a remote file name.
1126 (find-file-name-handler (directory-file-name default-directory)
1129 (funcall handler 'shell-command command output-buffer error-buffer)
1130 (if (and output-buffer
1131 (not (or (bufferp output-buffer) (stringp output-buffer))))
1135 (expand-file-name "scor"
1136 (or small-temporary-file-directory
1137 temporary-file-directory)))
1139 (barf-if-buffer-read-only)
1141 ;; We do not use -f for csh; we will not support broken use of
1142 ;; .cshrcs. Even the BSD csh manual says to use
1143 ;; "if ($?prompt) exit" before things which are not useful
1144 ;; non-interactively. Besides, if someone wants their other
1145 ;; aliases for shell commands then they can still have them.
1146 (call-process shell-file-name nil
1150 nil shell-command-switch command)
1151 (when (and error-file (file-exists-p error-file))
1152 (if (< 0 (nth 7 (file-attributes error-file)))
1153 (with-current-buffer (get-buffer-create error-buffer)
1154 (let ((pos-from-end (- (point-max) (point))))
1157 ;; Do no formatting while reading error file,
1158 ;; because that can run a shell command, and we
1159 ;; don't want that to cause an infinite recursion.
1160 (format-insert-file error-file nil)
1161 ;; Put point after the inserted errors.
1162 (goto-char (- (point-max) pos-from-end)))
1163 (display-buffer (current-buffer))))
1164 (delete-file error-file))
1165 ;; This is like exchange-point-and-mark, but doesn't
1166 ;; activate the mark. It is cleaner to avoid activation,
1167 ;; even though the command loop would deactivate the mark
1168 ;; because we inserted text.
1169 (goto-char (prog1 (mark t)
1170 (set-marker (mark-marker) (point)
1171 (current-buffer)))))
1172 ;; Preserve the match data in case called from a program.
1174 (if (string-match "[ \t]*&[ \t]*$" command)
1175 ;; Command ending with ampersand means asynchronous.
1176 (let ((buffer (get-buffer-create
1177 (or output-buffer "*Async Shell Command*")))
1178 (directory default-directory)
1180 ;; Remove the ampersand.
1181 (setq command (substring command 0 (match-beginning 0)))
1182 ;; If will kill a process, query first.
1183 (setq proc (get-buffer-process buffer))
1185 (if (yes-or-no-p "A command is running. Kill it? ")
1187 (error "Shell command in progress")))
1190 (setq buffer-read-only nil)
1192 (display-buffer buffer)
1193 (setq default-directory directory)
1194 (setq proc (start-process "Shell" buffer shell-file-name
1195 shell-command-switch command))
1196 (setq mode-line-process '(":%s"))
1197 (require 'shell) (shell-mode)
1198 (set-process-sentinel proc 'shell-command-sentinel)
1200 (shell-command-on-region (point) (point) command
1201 output-buffer nil error-buffer)))))))
1203 ;; We have a sentinel to prevent insertion of a termination message
1204 ;; in the buffer itself.
1205 (defun shell-command-sentinel (process signal)
1206 (if (memq (process-status process) '(exit signal))
1208 (car (cdr (cdr (process-command process))))
1209 (substring signal 0 -1))))
1211 (defun shell-command-on-region (start end command
1212 &optional output-buffer replace
1214 "Execute string COMMAND in inferior shell with region as input.
1215 Normally display output (if any) in temp buffer `*Shell Command Output*';
1216 Prefix arg means replace the region with it. Return the exit code of
1219 To specify a coding system for converting non-ASCII characters
1220 in the input and output to the shell command, use \\[universal-coding-system-argument]
1221 before this command. By default, the input (from the current buffer)
1222 is encoded in the same coding system that will be used to save the file,
1223 `buffer-file-coding-system'. If the output is going to replace the region,
1224 then it is decoded from that same coding system.
1226 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1227 REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1228 systems by binding `coding-system-for-read' and
1229 `coding-system-for-write'.
1231 If the output is one line, it is displayed in the echo area,
1232 but it is nonetheless available in buffer `*Shell Command Output*'
1233 even though that buffer is not automatically displayed.
1234 If there is no output, or if output is inserted in the current buffer,
1235 then `*Shell Command Output*' is deleted.
1237 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1238 that says to put the output in some other buffer.
1239 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1240 If OUTPUT-BUFFER is not a buffer and not nil,
1241 insert output in the current buffer.
1242 In either case, the output is inserted after point (leaving mark after it).
1244 If REPLACE, the optional fifth argument, is non-nil, that means insert
1245 the output in place of text from START to END, putting point and mark
1248 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1249 or buffer name to which to direct the command's standard error output.
1250 If it is nil, error output is mingled with regular output.
1251 In an interactive call, the variable `shell-command-default-error-buffer'
1252 specifies the value of ERROR-BUFFER."
1253 (interactive (let ((string
1254 ;; Do this before calling region-beginning
1255 ;; and region-end, in case subprocess output
1256 ;; relocates them while we are in the minibuffer.
1257 (read-from-minibuffer "Shell command on region: "
1259 'shell-command-history)))
1260 ;; call-interactively recognizes region-beginning and
1261 ;; region-end specially, leaving them in the history.
1262 (list (region-beginning) (region-end)
1266 shell-command-default-error-buffer)))
1270 (expand-file-name "scor"
1271 (or small-temporary-file-directory
1272 temporary-file-directory)))
1277 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1278 ;; Replace specified region with output from command.
1279 (let ((swap (and replace (< start end))))
1280 ;; Don't muck with mark unless REPLACE says we should.
1282 (and replace (push-mark))
1284 (call-process-region start end shell-file-name t
1288 nil shell-command-switch command))
1289 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1290 (and shell-buffer (not (eq shell-buffer (current-buffer)))
1291 (kill-buffer shell-buffer)))
1292 ;; Don't muck with mark unless REPLACE says we should.
1293 (and replace swap (exchange-point-and-mark)))
1294 ;; No prefix argument: put the output in a temp buffer,
1295 ;; replacing its entire contents.
1296 (let ((buffer (get-buffer-create
1297 (or output-buffer "*Shell Command Output*")))
1300 (if (eq buffer (current-buffer))
1301 ;; If the input is the same buffer as the output,
1302 ;; delete everything but the specified region,
1303 ;; then replace that region with the output.
1304 (progn (setq buffer-read-only nil)
1305 (delete-region (max start end) (point-max))
1306 (delete-region (point-min) (min start end))
1308 (call-process-region (point-min) (point-max)
1313 nil shell-command-switch
1315 ;; Clear the output buffer, then run the command with
1317 (let ((directory default-directory))
1320 (setq buffer-read-only nil)
1321 (if (not output-buffer)
1322 (setq default-directory directory))
1325 (call-process-region start end shell-file-name nil
1327 (list buffer error-file)
1329 nil shell-command-switch command)))
1330 (setq success (and exit-status (equal 0 exit-status)))
1331 ;; Report the amount of output.
1332 (let ((lines (save-excursion
1334 (if (= (buffer-size) 0)
1336 (count-lines (point-min) (point-max))))))
1339 (< 0 (nth 7 (file-attributes error-file))))
1340 (message "(Shell command %sed with some error output)"
1341 (if (equal 0 exit-status)
1344 (message "(Shell command %sed with no output)"
1345 (if (equal 0 exit-status)
1348 (kill-buffer buffer))
1353 (goto-char (point-min))
1354 (buffer-substring (point)
1355 (progn (end-of-line) (point))))))
1359 (goto-char (point-min)))
1360 (display-buffer buffer)))))))
1361 (when (and error-file (file-exists-p error-file))
1362 (if (< 0 (nth 7 (file-attributes error-file)))
1363 (with-current-buffer (get-buffer-create error-buffer)
1364 (let ((pos-from-end (- (point-max) (point))))
1367 ;; Do no formatting while reading error file,
1368 ;; because that can run a shell command, and we
1369 ;; don't want that to cause an infinite recursion.
1370 (format-insert-file error-file nil)
1371 ;; Put point after the inserted errors.
1372 (goto-char (- (point-max) pos-from-end)))
1373 (display-buffer (current-buffer))))
1374 (delete-file error-file))
1377 (defun shell-command-to-string (command)
1378 "Execute shell command COMMAND and return its output as a string."
1379 (with-output-to-string
1380 (with-current-buffer
1382 (call-process shell-file-name nil t nil shell-command-switch command))))
1384 (defvar universal-argument-map
1385 (let ((map (make-sparse-keymap)))
1386 (define-key map [t] 'universal-argument-other-key)
1387 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1388 (define-key map [switch-frame] nil)
1389 (define-key map [?\C-u] 'universal-argument-more)
1390 (define-key map [?-] 'universal-argument-minus)
1391 (define-key map [?0] 'digit-argument)
1392 (define-key map [?1] 'digit-argument)
1393 (define-key map [?2] 'digit-argument)
1394 (define-key map [?3] 'digit-argument)
1395 (define-key map [?4] 'digit-argument)
1396 (define-key map [?5] 'digit-argument)
1397 (define-key map [?6] 'digit-argument)
1398 (define-key map [?7] 'digit-argument)
1399 (define-key map [?8] 'digit-argument)
1400 (define-key map [?9] 'digit-argument)
1402 "Keymap used while processing \\[universal-argument].")
1404 (defvar universal-argument-num-events nil
1405 "Number of argument-specifying events read by `universal-argument'.
1406 `universal-argument-other-key' uses this to discard those events
1407 from (this-command-keys), and reread only the final command.")
1409 (defun universal-argument ()
1410 "Begin a numeric argument for the following command.
1411 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1412 \\[universal-argument] following the digits or minus sign ends the argument.
1413 \\[universal-argument] without digits or minus sign provides 4 as argument.
1414 Repeating \\[universal-argument] without digits or minus sign
1415 multiplies the argument by 4 each time.
1416 For some commands, just \\[universal-argument] by itself serves as a flag
1417 which is different in effect from any particular numeric argument.
1418 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1420 (setq prefix-arg (list 4))
1421 (setq universal-argument-num-events (length (this-command-keys)))
1422 (setq overriding-terminal-local-map universal-argument-map))
1424 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1425 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1426 (defun universal-argument-more (arg)
1429 (setq prefix-arg (list (* 4 (car arg))))
1431 (setq prefix-arg (list -4))
1432 (setq prefix-arg arg)
1433 (setq overriding-terminal-local-map nil)))
1434 (setq universal-argument-num-events (length (this-command-keys))))
1436 (defun negative-argument (arg)
1437 "Begin a negative numeric argument for the next command.
1438 \\[universal-argument] following digits or minus sign ends the argument."
1440 (cond ((integerp arg)
1441 (setq prefix-arg (- arg)))
1443 (setq prefix-arg nil))
1445 (setq prefix-arg '-)))
1446 (setq universal-argument-num-events (length (this-command-keys)))
1447 (setq overriding-terminal-local-map universal-argument-map))
1449 (defun digit-argument (arg)
1450 "Part of the numeric argument for the next command.
1451 \\[universal-argument] following digits or minus sign ends the argument."
1453 (let ((digit (- (logand last-command-char ?\177) ?0)))
1454 (cond ((integerp arg)
1455 (setq prefix-arg (+ (* arg 10)
1456 (if (< arg 0) (- digit) digit))))
1458 ;; Treat -0 as just -, so that -01 will work.
1459 (setq prefix-arg (if (zerop digit) '- (- digit))))
1461 (setq prefix-arg digit))))
1462 (setq universal-argument-num-events (length (this-command-keys)))
1463 (setq overriding-terminal-local-map universal-argument-map))
1465 ;; For backward compatibility, minus with no modifiers is an ordinary
1466 ;; command if digits have already been entered.
1467 (defun universal-argument-minus (arg)
1470 (universal-argument-other-key arg)
1471 (negative-argument arg)))
1473 ;; Anything else terminates the argument and is left in the queue to be
1474 ;; executed as a command.
1475 (defun universal-argument-other-key (arg)
1477 (setq prefix-arg arg)
1478 (let* ((key (this-command-keys))
1479 (keylist (listify-key-sequence key)))
1480 (setq unread-command-events
1481 (append (nthcdr universal-argument-num-events keylist)
1482 unread-command-events)))
1483 (reset-this-command-lengths)
1484 (setq overriding-terminal-local-map nil))
1486 ;;;; Window system cut and paste hooks.
1488 (defvar interprogram-cut-function nil
1489 "Function to call to make a killed region available to other programs.
1491 Most window systems provide some sort of facility for cutting and
1492 pasting text between the windows of different programs.
1493 This variable holds a function that Emacs calls whenever text
1494 is put in the kill ring, to make the new kill available to other
1497 The function takes one or two arguments.
1498 The first argument, TEXT, is a string containing
1499 the text which should be made available.
1500 The second, PUSH, if non-nil means this is a \"new\" kill;
1501 nil means appending to an \"old\" kill.")
1503 (defvar interprogram-paste-function nil
1504 "Function to call to get text cut from other programs.
1506 Most window systems provide some sort of facility for cutting and
1507 pasting text between the windows of different programs.
1508 This variable holds a function that Emacs calls to obtain
1509 text that other programs have provided for pasting.
1511 The function should be called with no arguments. If the function
1512 returns nil, then no other program has provided such text, and the top
1513 of the Emacs kill ring should be used. If the function returns a
1514 string, that string should be put in the kill ring as the latest kill.
1516 Note that the function should return a string only if a program other
1517 than Emacs has provided a string for pasting; if Emacs provided the
1518 most recent string, the function should return nil. If it is
1519 difficult to tell whether Emacs or some other program provided the
1520 current string, it is probably good enough to return nil if the string
1521 is equal (according to `string=') to the last text Emacs provided.")
1525 ;;;; The kill ring data structure.
1527 (defvar kill-ring nil
1528 "List of killed text sequences.
1529 Since the kill ring is supposed to interact nicely with cut-and-paste
1530 facilities offered by window systems, use of this variable should
1531 interact nicely with `interprogram-cut-function' and
1532 `interprogram-paste-function'. The functions `kill-new',
1533 `kill-append', and `current-kill' are supposed to implement this
1534 interaction; you may want to use them instead of manipulating the kill
1537 (defcustom kill-ring-max 60
1538 "*Maximum length of kill ring before oldest elements are thrown away."
1542 (defvar kill-ring-yank-pointer nil
1543 "The tail of the kill ring whose car is the last thing yanked.")
1545 (defun kill-new (string &optional replace)
1546 "Make STRING the latest kill in the kill ring.
1547 Set the kill-ring-yank pointer to point to it.
1548 If `interprogram-cut-function' is non-nil, apply it to STRING.
1549 Optional second argument REPLACE non-nil means that STRING will replace
1550 the front of the kill ring, rather than being added to the list."
1551 (and (fboundp 'menu-bar-update-yank-menu)
1552 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1554 (setcar kill-ring string)
1555 (setq kill-ring (cons string kill-ring))
1556 (if (> (length kill-ring) kill-ring-max)
1557 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1558 (setq kill-ring-yank-pointer kill-ring)
1559 (if interprogram-cut-function
1560 (funcall interprogram-cut-function string (not replace))))
1562 (defun kill-append (string before-p)
1563 "Append STRING to the end of the latest kill in the kill ring.
1564 If BEFORE-P is non-nil, prepend STRING to the kill.
1565 If `interprogram-cut-function' is set, pass the resulting kill to
1567 (kill-new (if before-p
1568 (concat string (car kill-ring))
1569 (concat (car kill-ring) string)) t))
1571 (defun current-kill (n &optional do-not-move)
1572 "Rotate the yanking point by N places, and then return that kill.
1573 If N is zero, `interprogram-paste-function' is set, and calling it
1574 returns a string, then that string is added to the front of the
1575 kill ring and returned as the latest kill.
1576 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1577 yanking point; just return the Nth kill forward."
1578 (let ((interprogram-paste (and (= n 0)
1579 interprogram-paste-function
1580 (funcall interprogram-paste-function))))
1581 (if interprogram-paste
1583 ;; Disable the interprogram cut function when we add the new
1584 ;; text to the kill ring, so Emacs doesn't try to own the
1585 ;; selection, with identical text.
1586 (let ((interprogram-cut-function nil))
1587 (kill-new interprogram-paste))
1589 (or kill-ring (error "Kill ring is empty"))
1590 (let ((ARGth-kill-element
1591 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1595 (setq kill-ring-yank-pointer ARGth-kill-element))
1596 (car ARGth-kill-element)))))
1600 ;;;; Commands for manipulating the kill ring.
1602 (defcustom kill-read-only-ok nil
1603 "*Non-nil means don't signal an error for killing read-only text."
1607 (put 'text-read-only 'error-conditions
1608 '(text-read-only buffer-read-only error))
1609 (put 'text-read-only 'error-message "Text is read-only")
1611 (defun kill-region (beg end)
1612 "Kill between point and mark.
1613 The text is deleted but saved in the kill ring.
1614 The command \\[yank] can retrieve it from there.
1615 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1616 If the buffer is read-only, Emacs will beep and refrain from deleting
1617 the text, but put the text in the kill ring anyway. This means that
1618 you can use the killing commands to copy text from a read-only buffer.
1620 This is the primitive for programs to kill text (as opposed to deleting it).
1621 Supply two arguments, character numbers indicating the stretch of text
1623 Any command that calls this function is a \"kill command\".
1624 If the previous command was also a kill command,
1625 the text killed this time appends to the text killed last time
1626 to make one entry in the kill ring."
1629 (let ((string (delete-and-extract-region beg end)))
1630 (when string ;STRING is nil if BEG = END
1631 ;; Add that string to the kill ring, one way or another.
1632 (if (eq last-command 'kill-region)
1633 (kill-append string (< end beg))
1635 (setq this-command 'kill-region))
1636 ((buffer-read-only text-read-only)
1637 ;; The code above failed because the buffer, or some of the characters
1638 ;; in the region, are read-only.
1639 ;; We should beep, in case the user just isn't aware of this.
1640 ;; However, there's no harm in putting
1641 ;; the region's text in the kill ring, anyway.
1642 (copy-region-as-kill beg end)
1643 ;; Set this-command now, so it will be set even if we get an error.
1644 (setq this-command 'kill-region)
1645 ;; This should barf, if appropriate, and give us the correct error.
1646 (if kill-read-only-ok
1647 (message "Read only text copied to kill ring")
1648 ;; Signal an error if the buffer is read-only.
1649 (barf-if-buffer-read-only)
1650 ;; If the buffer isn't read-only, the text is.
1651 (signal 'text-read-only (list (current-buffer)))))))
1653 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1654 ;; to get two copies of the text when the user accidentally types M-w and
1655 ;; then corrects it with the intended C-w.
1656 (defun copy-region-as-kill (beg end)
1657 "Save the region as if killed, but don't kill it.
1658 In Transient Mark mode, deactivate the mark.
1659 If `interprogram-cut-function' is non-nil, also save the text for a window
1660 system cut and paste."
1662 (if (eq last-command 'kill-region)
1663 (kill-append (buffer-substring beg end) (< end beg))
1664 (kill-new (buffer-substring beg end)))
1665 (if transient-mark-mode
1666 (setq deactivate-mark t))
1669 (defun kill-ring-save (beg end)
1670 "Save the region as if killed, but don't kill it.
1671 In Transient Mark mode, deactivate the mark.
1672 If `interprogram-cut-function' is non-nil, also save the text for a window
1673 system cut and paste.
1675 This command is similar to `copy-region-as-kill', except that it gives
1676 visual feedback indicating the extent of the region being copied."
1678 (copy-region-as-kill beg end)
1680 (let ((other-end (if (= (point) beg) end beg))
1682 ;; Inhibit quitting so we can make a quit here
1683 ;; look like a C-g typed as a command.
1685 (if (pos-visible-in-window-p other-end (selected-window))
1687 ;; Swap point and mark.
1688 (set-marker (mark-marker) (point) (current-buffer))
1689 (goto-char other-end)
1692 (set-marker (mark-marker) other-end (current-buffer))
1694 ;; If user quit, deactivate the mark
1695 ;; as C-g would as a command.
1696 (and quit-flag mark-active
1698 (let* ((killed-text (current-kill 0))
1699 (message-len (min (length killed-text) 40)))
1701 ;; Don't say "killed"; that is misleading.
1702 (message "Saved text until \"%s\""
1703 (substring killed-text (- message-len)))
1704 (message "Saved text from \"%s\""
1705 (substring killed-text 0 message-len))))))))
1707 (defun append-next-kill (&optional interactive)
1708 "Cause following command, if it kills, to append to previous kill.
1709 The argument is used for internal purposes; do not supply one."
1711 ;; We don't use (interactive-p), since that breaks kbd macros.
1714 (setq this-command 'kill-region)
1715 (message "If the next command is a kill, it will append"))
1716 (setq last-command 'kill-region)))
1720 (defun yank-pop (arg)
1721 "Replace just-yanked stretch of killed text with a different stretch.
1722 This command is allowed only immediately after a `yank' or a `yank-pop'.
1723 At such a time, the region contains a stretch of reinserted
1724 previously-killed text. `yank-pop' deletes that text and inserts in its
1725 place a different stretch of killed text.
1727 With no argument, the previous kill is inserted.
1728 With argument N, insert the Nth previous kill.
1729 If N is negative, this is a more recent kill.
1731 The sequence of kills wraps around, so that after the oldest one
1732 comes the newest one."
1734 (if (not (eq last-command 'yank))
1735 (error "Previous command was not a yank"))
1736 (setq this-command 'yank)
1737 (let ((inhibit-read-only t)
1738 (before (< (point) (mark t))))
1739 (delete-region (point) (mark t))
1740 (set-marker (mark-marker) (point) (current-buffer))
1741 (let ((opoint (point)))
1742 (insert (current-kill arg))
1743 (let ((inhibit-read-only t))
1744 (remove-text-properties opoint (point) '(read-only nil))))
1746 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1747 ;; It is cleaner to avoid activation, even though the command
1748 ;; loop would deactivate the mark because we inserted text.
1749 (goto-char (prog1 (mark t)
1750 (set-marker (mark-marker) (point) (current-buffer))))))
1753 (defun yank (&optional arg)
1754 "Reinsert the last stretch of killed text.
1755 More precisely, reinsert the stretch of killed text most recently
1756 killed OR yanked. Put point at end, and set mark at beginning.
1757 With just C-u as argument, same but put point at beginning (and mark at end).
1758 With argument N, reinsert the Nth most recently killed stretch of killed
1760 See also the command \\[yank-pop]."
1762 ;; If we don't get all the way thru, make last-command indicate that
1763 ;; for the following command.
1764 (setq this-command t)
1766 (let ((opoint (point)))
1767 (insert (current-kill (cond
1771 (let ((inhibit-read-only t))
1772 (remove-text-properties opoint (point) '(read-only nil))))
1774 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1775 ;; It is cleaner to avoid activation, even though the command
1776 ;; loop would deactivate the mark because we inserted text.
1777 (goto-char (prog1 (mark t)
1778 (set-marker (mark-marker) (point) (current-buffer)))))
1779 ;; If we do get all the way thru, make this-command indicate that.
1780 (setq this-command 'yank)
1783 (defun rotate-yank-pointer (arg)
1784 "Rotate the yanking point in the kill ring.
1785 With argument, rotate that many kills forward (or backward, if negative)."
1789 ;; Some kill commands.
1791 ;; Internal subroutine of delete-char
1792 (defun kill-forward-chars (arg)
1793 (if (listp arg) (setq arg (car arg)))
1794 (if (eq arg '-) (setq arg -1))
1795 (kill-region (point) (forward-point arg)))
1797 ;; Internal subroutine of backward-delete-char
1798 (defun kill-backward-chars (arg)
1799 (if (listp arg) (setq arg (car arg)))
1800 (if (eq arg '-) (setq arg -1))
1801 (kill-region (point) (forward-point (- arg))))
1803 (defcustom backward-delete-char-untabify-method 'untabify
1804 "*The method for untabifying when deleting backward.
1805 Can be `untabify' -- turn a tab to many spaces, then delete one space;
1806 `hungry' -- delete all whitespace, both tabs and spaces;
1807 `all' -- delete all whitespace, including tabs, spaces and newlines;
1808 nil -- just delete one character."
1809 :type '(choice (const untabify) (const hungry) (const all) (const nil))
1812 (defun backward-delete-char-untabify (arg &optional killp)
1813 "Delete characters backward, changing tabs into spaces.
1814 The exact behavior depends on `backward-delete-char-untabify-method'.
1815 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
1816 Interactively, ARG is the prefix arg (default 1)
1817 and KILLP is t if a prefix arg was specified."
1818 (interactive "*p\nP")
1819 (when (eq backward-delete-char-untabify-method 'untabify)
1822 (while (and (> count 0) (not (bobp)))
1823 (if (= (preceding-char) ?\t)
1824 (let ((col (current-column)))
1826 (setq col (- col (current-column)))
1827 (insert-char ?\ col)
1830 (setq count (1- count))))))
1831 (delete-backward-char
1832 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1833 ((eq backward-delete-char-untabify-method 'all)
1836 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
1838 (+ arg (if (zerop wh) 0 (1- wh))))
1842 (defun zap-to-char (arg char)
1843 "Kill up to and including ARG'th occurrence of CHAR.
1844 Case is ignored if `case-fold-search' is non-nil in the current buffer.
1845 Goes backward if ARG is negative; error if CHAR not found."
1846 (interactive "p\ncZap to char: ")
1847 (kill-region (point) (progn
1848 (search-forward (char-to-string char) nil nil arg)
1849 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
1852 ;; kill-line and its subroutines.
1854 (defcustom kill-whole-line nil
1855 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
1859 (defun kill-line (&optional arg)
1860 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1861 With prefix argument, kill that many lines from point.
1862 Negative arguments kill lines backward.
1864 When calling from a program, nil means \"no arg\",
1865 a number counts as a prefix arg.
1867 To kill a whole line, when point is not at the beginning, type \
1868 \\[beginning-of-line] \\[kill-line] \\[kill-line].
1870 If `kill-whole-line' is non-nil, then this command kills the whole line
1871 including its terminating newline, when used at the beginning of a line
1872 with no argument. As a consequence, you can always kill a whole line
1873 by typing \\[beginning-of-line] \\[kill-line]."
1875 (kill-region (point)
1876 ;; It is better to move point to the other end of the kill
1877 ;; before killing. That way, in a read-only buffer, point
1878 ;; moves across the text that is copied to the kill ring.
1879 ;; The choice has no effect on undo now that undo records
1880 ;; the value of point from before the command was run.
1883 (forward-visible-line (prefix-numeric-value arg))
1885 (signal 'end-of-buffer nil))
1886 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
1887 (forward-visible-line 1)
1888 (end-of-visible-line)))
1891 (defun forward-visible-line (arg)
1892 "Move forward by ARG lines, ignoring currently invisible newlines only.
1893 If ARG is negative, move backward -ARG lines.
1894 If ARG is zero, move to the beginning of the current line."
1898 (or (zerop (forward-line 1))
1899 (signal 'end-of-buffer nil))
1900 ;; If the following character is currently invisible,
1901 ;; skip all characters with that same `invisible' property value,
1902 ;; then find the next newline.
1903 (while (and (not (eobp))
1905 (get-char-property (point) 'invisible)))
1906 (if (eq buffer-invisibility-spec t)
1908 (or (memq prop buffer-invisibility-spec)
1909 (assq prop buffer-invisibility-spec)))))
1911 (if (get-text-property (point) 'invisible)
1912 (or (next-single-property-change (point) 'invisible)
1914 (next-overlay-change (point))))
1915 (or (zerop (forward-line 1))
1916 (signal 'end-of-buffer nil)))
1917 (setq arg (1- arg)))
1919 (while (or first (< arg 0))
1922 (or (zerop (forward-line -1))
1923 (signal 'beginning-of-buffer nil)))
1924 (while (and (not (bobp))
1926 (get-char-property (1- (point)) 'invisible)))
1927 (if (eq buffer-invisibility-spec t)
1929 (or (memq prop buffer-invisibility-spec)
1930 (assq prop buffer-invisibility-spec)))))
1932 (if (get-text-property (1- (point)) 'invisible)
1933 (or (previous-single-property-change (point) 'invisible)
1935 (previous-overlay-change (point))))
1936 (or (zerop (forward-line -1))
1937 (signal 'beginning-of-buffer nil)))
1939 (setq arg (1+ arg)))))
1940 ((beginning-of-buffer end-of-buffer)
1943 (defun end-of-visible-line ()
1944 "Move to end of current visible line."
1946 ;; If the following character is currently invisible,
1947 ;; skip all characters with that same `invisible' property value,
1948 ;; then find the next newline.
1949 (while (and (not (eobp))
1951 (get-char-property (point) 'invisible)))
1952 (if (eq buffer-invisibility-spec t)
1954 (or (memq prop buffer-invisibility-spec)
1955 (assq prop buffer-invisibility-spec)))))
1956 (if (get-text-property (point) 'invisible)
1957 (goto-char (next-single-property-change (point) 'invisible))
1958 (goto-char (next-overlay-change (point))))
1961 (defun insert-buffer (buffer)
1962 "Insert after point the contents of BUFFER.
1963 Puts mark after the inserted text.
1964 BUFFER may be a buffer or a buffer name.
1966 This function is meant for the user to run interactively.
1967 Don't call it from programs!"
1971 (barf-if-buffer-read-only)
1972 (read-buffer "Insert buffer: "
1973 (if (eq (selected-window) (next-window (selected-window)))
1974 (other-buffer (current-buffer))
1975 (window-buffer (next-window (selected-window))))
1977 (or (bufferp buffer)
1978 (setq buffer (get-buffer buffer)))
1979 (let (start end newmark)
1983 (setq start (point-min) end (point-max)))
1984 (insert-buffer-substring buffer start end)
1985 (setq newmark (point)))
1986 (push-mark newmark))
1989 (defun append-to-buffer (buffer start end)
1990 "Append to specified buffer the text of the region.
1991 It is inserted into that buffer before its point.
1993 When calling from a program, give three arguments:
1994 BUFFER (or buffer name), START and END.
1995 START and END specify the portion of the current buffer to be copied."
1997 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
1998 (region-beginning) (region-end)))
1999 (let ((oldbuf (current-buffer)))
2001 (let* ((append-to (get-buffer-create buffer))
2002 (windows (get-buffer-window-list append-to t t))
2004 (set-buffer append-to)
2005 (setq point (point))
2006 (barf-if-buffer-read-only)
2007 (insert-buffer-substring oldbuf start end)
2008 (dolist (window windows)
2009 (when (= (window-point window) point)
2010 (set-window-point window (point))))))))
2012 (defun prepend-to-buffer (buffer start end)
2013 "Prepend to specified buffer the text of the region.
2014 It is inserted into that buffer after its point.
2016 When calling from a program, give three arguments:
2017 BUFFER (or buffer name), START and END.
2018 START and END specify the portion of the current buffer to be copied."
2019 (interactive "BPrepend to buffer: \nr")
2020 (let ((oldbuf (current-buffer)))
2022 (set-buffer (get-buffer-create buffer))
2023 (barf-if-buffer-read-only)
2025 (insert-buffer-substring oldbuf start end)))))
2027 (defun copy-to-buffer (buffer start end)
2028 "Copy to specified buffer the text of the region.
2029 It is inserted into that buffer, replacing existing text there.
2031 When calling from a program, give three arguments:
2032 BUFFER (or buffer name), START and END.
2033 START and END specify the portion of the current buffer to be copied."
2034 (interactive "BCopy to buffer: \nr")
2035 (let ((oldbuf (current-buffer)))
2037 (set-buffer (get-buffer-create buffer))
2038 (barf-if-buffer-read-only)
2041 (insert-buffer-substring oldbuf start end)))))
2043 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2044 (put 'mark-inactive 'error-message "The mark is not active now")
2046 (defun mark (&optional force)
2047 "Return this buffer's mark value as integer; error if mark inactive.
2048 If optional argument FORCE is non-nil, access the mark value
2049 even if the mark is not currently active, and return nil
2050 if there is no mark at all.
2052 If you are using this in an editing command, you are most likely making
2053 a mistake; see the documentation of `set-mark'."
2054 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2055 (marker-position (mark-marker))
2056 (signal 'mark-inactive nil)))
2058 ;; Many places set mark-active directly, and several of them failed to also
2059 ;; run deactivate-mark-hook. This shorthand should simplify.
2060 (defsubst deactivate-mark ()
2061 "Deactivate the mark by setting `mark-active' to nil.
2062 \(That makes a difference only in Transient Mark mode.)
2063 Also runs the hook `deactivate-mark-hook'."
2064 (if transient-mark-mode
2066 (setq mark-active nil)
2067 (run-hooks 'deactivate-mark-hook))))
2069 (defun set-mark (pos)
2070 "Set this buffer's mark to POS. Don't use this function!
2071 That is to say, don't use this function unless you want
2072 the user to see that the mark has moved, and you want the previous
2073 mark position to be lost.
2075 Normally, when a new mark is set, the old one should go on the stack.
2076 This is why most applications should use push-mark, not set-mark.
2078 Novice Emacs Lisp programmers often try to use the mark for the wrong
2079 purposes. The mark saves a location for the user's convenience.
2080 Most editing commands should not alter the mark.
2081 To remember a location for internal use in the Lisp program,
2082 store it in a Lisp variable. Example:
2084 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2088 (setq mark-active t)
2089 (run-hooks 'activate-mark-hook)
2090 (set-marker (mark-marker) pos (current-buffer)))
2091 ;; Normally we never clear mark-active except in Transient Mark mode.
2092 ;; But when we actually clear out the mark value too,
2093 ;; we must clear mark-active in any mode.
2094 (setq mark-active nil)
2095 (run-hooks 'deactivate-mark-hook)
2096 (set-marker (mark-marker) nil)))
2098 (defvar mark-ring nil
2099 "The list of former marks of the current buffer, most recent first.")
2100 (make-variable-buffer-local 'mark-ring)
2101 (put 'mark-ring 'permanent-local t)
2103 (defcustom mark-ring-max 16
2104 "*Maximum size of mark ring. Start discarding off end if gets this big."
2106 :group 'editing-basics)
2108 (defvar global-mark-ring nil
2109 "The list of saved global marks, most recent first.")
2111 (defcustom global-mark-ring-max 16
2112 "*Maximum size of global mark ring. \
2113 Start discarding off end if gets this big."
2115 :group 'editing-basics)
2117 (defun set-mark-command (arg)
2118 "Set mark at where point is, or jump to mark.
2119 With no prefix argument, set mark, push old mark position on local mark
2120 ring, and push mark on global mark ring.
2121 With argument, jump to mark, and pop a new position for mark off the ring
2122 \(does not affect global mark ring\).
2124 Novice Emacs Lisp programmers often try to use the mark for the wrong
2125 purposes. See the documentation of `set-mark' for more information."
2129 (push-mark nil nil t))
2131 (error "No mark set in this buffer")
2132 (goto-char (mark t))
2135 (defun push-mark (&optional location nomsg activate)
2136 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
2137 If the last global mark pushed was not in the current buffer,
2138 also push LOCATION on the global mark ring.
2139 Display `Mark set' unless the optional second arg NOMSG is non-nil.
2140 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2142 Novice Emacs Lisp programmers often try to use the mark for the wrong
2143 purposes. See the documentation of `set-mark' for more information.
2145 In Transient Mark mode, this does not activate the mark."
2148 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2149 (if (> (length mark-ring) mark-ring-max)
2151 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2152 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
2153 (set-marker (mark-marker) (or location (point)) (current-buffer))
2154 ;; Now push the mark on the global mark ring.
2155 (if (and global-mark-ring
2156 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
2157 ;; The last global mark pushed was in this same buffer.
2158 ;; Don't push another one.
2160 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
2161 (if (> (length global-mark-ring) global-mark-ring-max)
2163 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2165 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2166 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2167 (message "Mark set"))
2168 (if (or activate (not transient-mark-mode))
2169 (set-mark (mark t)))
2173 "Pop off mark ring into the buffer's actual mark.
2174 Does not set point. Does nothing if mark ring is empty."
2177 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
2178 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
2180 (move-marker (car mark-ring) nil)
2181 (if (null (mark t)) (ding))
2182 (setq mark-ring (cdr mark-ring)))))
2184 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2185 (defun exchange-point-and-mark ()
2186 "Put the mark where point is now, and point where the mark is now.
2187 This command works even when the mark is not active,
2188 and it reactivates the mark."
2190 (let ((omark (mark t)))
2192 (error "No mark set in this buffer"))
2197 (defun transient-mark-mode (arg)
2198 "Toggle Transient Mark mode.
2199 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
2201 In Transient Mark mode, when the mark is active, the region is highlighted.
2202 Changing the buffer \"deactivates\" the mark.
2203 So do certain other operations that set the mark
2204 but whose main purpose is something else--for example,
2205 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
2207 (setq transient-mark-mode
2209 (not transient-mark-mode)
2210 (> (prefix-numeric-value arg) 0)))
2212 (if transient-mark-mode
2213 (message "Transient Mark mode enabled")
2214 (message "Transient Mark mode disabled"))))
2216 (defun pop-global-mark ()
2217 "Pop off global mark ring and jump to the top location."
2219 ;; Pop entries which refer to non-existent buffers.
2220 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2221 (setq global-mark-ring (cdr global-mark-ring)))
2222 (or global-mark-ring
2223 (error "No global mark set"))
2224 (let* ((marker (car global-mark-ring))
2225 (buffer (marker-buffer marker))
2226 (position (marker-position marker)))
2227 (setq global-mark-ring (nconc (cdr global-mark-ring)
2228 (list (car global-mark-ring))))
2230 (or (and (>= position (point-min))
2231 (<= position (point-max)))
2233 (goto-char position)
2234 (switch-to-buffer buffer)))
2236 (defcustom next-line-add-newlines t
2237 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2239 :group 'editing-basics)
2241 (defun next-line (arg)
2242 "Move cursor vertically down ARG lines.
2243 If there is no character in the target line exactly under the current column,
2244 the cursor is positioned after the character in that line which spans this
2245 column, or at the end of the line if it is not long enough.
2246 If there is no line in the buffer after this one, behavior depends on the
2247 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2248 to create a line, and moves the cursor to that line. Otherwise it moves the
2249 cursor to the end of the buffer.
2251 The command \\[set-goal-column] can be used to create
2252 a semipermanent goal column for this command.
2253 Then instead of trying to move exactly vertically (or as close as possible),
2254 this command moves to the specified goal column (or as close as possible).
2255 The goal column is stored in the variable `goal-column', which is nil
2256 when there is no goal column.
2258 If you are thinking of using this in a Lisp program, consider
2259 using `forward-line' instead. It is usually easier to use
2260 and more reliable (no dependence on goal column, etc.)."
2262 (if (and next-line-add-newlines (= arg 1))
2263 (let ((opoint (point)))
2272 ((beginning-of-buffer end-of-buffer) (ding)))
2276 (defun previous-line (arg)
2277 "Move cursor vertically up ARG lines.
2278 If there is no character in the target line exactly over the current column,
2279 the cursor is positioned after the character in that line which spans this
2280 column, or at the end of the line if it is not long enough.
2282 The command \\[set-goal-column] can be used to create
2283 a semipermanent goal column for this command.
2284 Then instead of trying to move exactly vertically (or as close as possible),
2285 this command moves to the specified goal column (or as close as possible).
2286 The goal column is stored in the variable `goal-column', which is nil
2287 when there is no goal column.
2289 If you are thinking of using this in a Lisp program, consider using
2290 `forward-line' with a negative argument instead. It is usually easier
2291 to use and more reliable (no dependence on goal column, etc.)."
2296 ((beginning-of-buffer end-of-buffer) (ding)))
2297 (line-move (- arg)))
2300 (defcustom track-eol nil
2301 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2302 This means moving to the end of each line moved onto.
2303 The beginning of a blank line does not count as the end of a line."
2305 :group 'editing-basics)
2307 (defcustom goal-column nil
2308 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2309 :type '(choice integer
2310 (const :tag "None" nil))
2311 :group 'editing-basics)
2312 (make-variable-buffer-local 'goal-column)
2314 (defvar temporary-goal-column 0
2315 "Current goal column for vertical motion.
2316 It is the column where point was
2317 at the start of current run of vertical motion commands.
2318 When the `track-eol' feature is doing its job, the value is 9999.")
2320 (defcustom line-move-ignore-invisible nil
2321 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2322 Outline mode sets this."
2324 :group 'editing-basics)
2326 ;; This is the guts of next-line and previous-line.
2327 ;; Arg says how many lines to move.
2328 (defun line-move (arg)
2329 ;; Don't run any point-motion hooks, and disregard intangibility,
2330 ;; for intermediate positions.
2331 (let ((inhibit-point-motion-hooks t)
2333 new line-end line-beg)
2336 (if (not (or (eq last-command 'next-line)
2337 (eq last-command 'previous-line)))
2338 (setq temporary-goal-column
2339 (if (and track-eol (eolp)
2340 ;; Don't count beg of empty line as end of line
2341 ;; unless we just did explicit end-of-line.
2342 (or (not (bolp)) (eq last-command 'end-of-line)))
2345 (if (and (not (integerp selective-display))
2346 (not line-move-ignore-invisible))
2347 ;; Use just newline characters.
2349 (progn (if (> arg 1) (forward-line (1- arg)))
2350 ;; This way of moving forward ARG lines
2351 ;; verifies that we have a newline after the last one.
2352 ;; It doesn't get confused by intangible text.
2354 (zerop (forward-line 1)))
2355 (and (zerop (forward-line arg))
2357 (signal (if (< arg 0)
2358 'beginning-of-buffer
2361 ;; Move by arg lines, but ignore invisible ones.
2364 (and (zerop (vertical-motion 1))
2365 (signal 'end-of-buffer nil))
2366 ;; If the following character is currently invisible,
2367 ;; skip all characters with that same `invisible' property value.
2368 (while (and (not (eobp))
2370 (get-char-property (point) 'invisible)))
2371 (if (eq buffer-invisibility-spec t)
2373 (or (memq prop buffer-invisibility-spec)
2374 (assq prop buffer-invisibility-spec)))))
2375 (if (get-text-property (point) 'invisible)
2376 (goto-char (next-single-property-change (point) 'invisible))
2377 (goto-char (next-overlay-change (point)))))
2378 (setq arg (1- arg)))
2381 (and (zerop (vertical-motion -1))
2382 (signal 'beginning-of-buffer nil))
2383 (while (and (not (bobp))
2385 (get-char-property (1- (point)) 'invisible)))
2386 (if (eq buffer-invisibility-spec t)
2388 (or (memq prop buffer-invisibility-spec)
2389 (assq prop buffer-invisibility-spec)))))
2390 (if (get-text-property (1- (point)) 'invisible)
2391 (goto-char (previous-single-property-change (point) 'invisible))
2392 (goto-char (previous-overlay-change (point)))))
2393 (setq arg (1+ arg))))
2394 (let ((buffer-invisibility-spec nil))
2395 (move-to-column (or goal-column temporary-goal-column))))
2397 ;; If we are moving into some intangible text,
2398 ;; look for following text on the same line which isn't intangible
2400 (setq line-end (save-excursion (end-of-line) (point)))
2401 (setq line-beg (save-excursion (beginning-of-line) (point)))
2402 (let ((after (and (< new (point-max))
2403 (get-char-property new 'intangible)))
2404 (before (and (> new (point-min))
2405 (get-char-property (1- new) 'intangible))))
2406 (when (and before (eq before after)
2408 (goto-char (point-min))
2409 (let ((inhibit-point-motion-hooks nil))
2411 (if (<= new line-end)
2412 (setq new (point)))))
2413 ;; NEW is where we want to move to.
2414 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2415 ;; Move there in just one step, from our starting position,
2416 ;; with intangibility and point-motion hooks enabled this time.
2418 (setq inhibit-point-motion-hooks nil)
2419 (goto-char (constrain-to-field new opoint t t))
2420 ;; If intangibility processing moved us to a different line,
2421 ;; readjust the horizontal position within the line we ended up at.
2422 (when (or (< (point) line-beg) (> (point) line-end))
2424 (setq inhibit-point-motion-hooks t)
2425 (setq line-end (save-excursion (end-of-line) (point)))
2427 (setq line-beg (point))
2428 (let ((buffer-invisibility-spec nil))
2429 (move-to-column (or goal-column temporary-goal-column)))
2430 (if (<= (point) line-end)
2432 (goto-char (point-min))
2433 (setq inhibit-point-motion-hooks nil)
2434 (goto-char (constrain-to-field new opoint t t))
2438 ;;; Many people have said they rarely use this feature, and often type
2439 ;;; it by accident. Maybe it shouldn't even be on a key.
2440 (put 'set-goal-column 'disabled t)
2442 (defun set-goal-column (arg)
2443 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2444 Those commands will move to this position in the line moved to
2445 rather than trying to keep the same horizontal position.
2446 With a non-nil argument, clears out the goal column
2447 so that \\[next-line] and \\[previous-line] resume vertical motion.
2448 The goal column is stored in the variable `goal-column'."
2452 (setq goal-column nil)
2453 (message "No goal column"))
2454 (setq goal-column (current-column))
2455 (message (substitute-command-keys
2456 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2461 (defun scroll-other-window-down (lines)
2462 "Scroll the \"other window\" down.
2463 For more details, see the documentation for `scroll-other-window'."
2465 (scroll-other-window
2466 ;; Just invert the argument's meaning.
2467 ;; We can do that without knowing which window it will be.
2468 (if (eq lines '-) nil
2470 (- (prefix-numeric-value lines))))))
2471 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2473 (defun beginning-of-buffer-other-window (arg)
2474 "Move point to the beginning of the buffer in the other window.
2475 Leave mark at previous position.
2476 With arg N, put point N/10 of the way from the true beginning."
2478 (let ((orig-window (selected-window))
2479 (window (other-window-for-scrolling)))
2480 ;; We use unwind-protect rather than save-window-excursion
2481 ;; because the latter would preserve the things we want to change.
2484 (select-window window)
2485 ;; Set point and mark in that window's buffer.
2486 (beginning-of-buffer arg)
2487 ;; Set point accordingly.
2489 (select-window orig-window))))
2491 (defun end-of-buffer-other-window (arg)
2492 "Move point to the end of the buffer in the other window.
2493 Leave mark at previous position.
2494 With arg N, put point N/10 of the way from the true end."
2496 ;; See beginning-of-buffer-other-window for comments.
2497 (let ((orig-window (selected-window))
2498 (window (other-window-for-scrolling)))
2501 (select-window window)
2504 (select-window orig-window))))
2506 (defun transpose-chars (arg)
2507 "Interchange characters around point, moving forward one character.
2508 With prefix arg ARG, effect is to take character before point
2509 and drag it forward past ARG other characters (backward if ARG negative).
2510 If no argument and at end of line, the previous two chars are exchanged."
2512 (and (null arg) (eolp) (forward-char -1))
2513 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2515 (defun transpose-words (arg)
2516 "Interchange words around point, leaving point at end of them.
2517 With prefix arg ARG, effect is to take word before or around point
2518 and drag it forward past ARG other words (backward if ARG negative).
2519 If ARG is zero, the words around or after point and around or after mark
2522 (transpose-subr 'forward-word arg))
2524 (defun transpose-sexps (arg)
2525 "Like \\[transpose-words] but applies to sexps.
2526 Does not work on a sexp that point is in the middle of
2527 if it is a list or string."
2529 (transpose-subr 'forward-sexp arg))
2531 (defun transpose-lines (arg)
2532 "Exchange current line and previous line, leaving point after both.
2533 With argument ARG, takes previous line and moves it past ARG lines.
2534 With argument 0, interchanges line point is in with line mark is in."
2536 (transpose-subr (function
2540 ;; Move forward over ARG lines,
2541 ;; but create newlines if necessary.
2542 (setq arg (forward-line arg))
2543 (if (/= (preceding-char) ?\n)
2544 (setq arg (1+ arg)))
2547 (forward-line arg))))
2550 (defvar transpose-subr-start1)
2551 (defvar transpose-subr-start2)
2552 (defvar transpose-subr-end1)
2553 (defvar transpose-subr-end2)
2555 (defun transpose-subr (mover arg)
2556 (let (transpose-subr-start1
2558 transpose-subr-start2
2559 transpose-subr-end2)
2564 (setq transpose-subr-end2 (point))
2566 (setq transpose-subr-start2 (point))
2569 (setq transpose-subr-end1 (point))
2571 (setq transpose-subr-start1 (point))
2573 (exchange-point-and-mark))
2577 (setq transpose-subr-start1 (point))
2579 (setq transpose-subr-end1 (point))
2581 (setq transpose-subr-end2 (point))
2582 (funcall mover (- arg))
2583 (setq transpose-subr-start2 (point))
2585 (goto-char transpose-subr-end2))
2587 (setq transpose-subr-start2 (point))
2589 (setq transpose-subr-end2 (point))
2590 (funcall mover (1- arg))
2591 (setq transpose-subr-start1 (point))
2592 (funcall mover (- arg))
2593 (setq transpose-subr-end1 (point))
2594 (transpose-subr-1)))))
2596 (defun transpose-subr-1 ()
2597 (if (> (min transpose-subr-end1 transpose-subr-end2)
2598 (max transpose-subr-start1 transpose-subr-start2))
2599 (error "Don't have two things to transpose"))
2600 (let* ((word1 (buffer-substring transpose-subr-start1 transpose-subr-end1))
2601 (len1 (length word1))
2602 (word2 (buffer-substring transpose-subr-start2 transpose-subr-end2))
2603 (len2 (length word2)))
2604 (delete-region transpose-subr-start2 transpose-subr-end2)
2605 (goto-char transpose-subr-start2)
2607 (goto-char (if (< transpose-subr-start1 transpose-subr-start2)
2608 transpose-subr-start1
2609 (+ transpose-subr-start1 (- len1 len2))))
2610 (delete-region (point) (+ (point) len1))
2613 (defvar comment-indent-hook nil
2614 "Obsolete variable for function to compute desired indentation for a comment.
2615 This function is called with no args with point at the beginning of
2616 the comment's starting delimiter.")
2618 (defun backward-word (arg)
2619 "Move backward until encountering the end of a word.
2620 With argument, do this that many times.
2621 In programs, it is faster to call `forward-word' with negative arg."
2623 (forward-word (- arg)))
2625 (defun mark-word (arg)
2626 "Set mark arg words away from point."
2634 (defun kill-word (arg)
2635 "Kill characters forward until encountering the end of a word.
2636 With argument, do this that many times."
2638 (kill-region (point) (progn (forward-word arg) (point))))
2640 (defun backward-kill-word (arg)
2641 "Kill characters backward until encountering the end of a word.
2642 With argument, do this that many times."
2644 (kill-word (- arg)))
2646 (defun current-word (&optional strict)
2647 "Return the word point is on (or a nearby word) as a string.
2648 If optional arg STRICT is non-nil, return nil unless point is within
2649 or adjacent to a word."
2651 (let ((oldpoint (point)) (start (point)) (end (point)))
2652 (skip-syntax-backward "w_") (setq start (point))
2653 (goto-char oldpoint)
2654 (skip-syntax-forward "w_") (setq end (point))
2655 (if (and (eq start oldpoint) (eq end oldpoint))
2656 ;; Point is neither within nor adjacent to a word.
2659 ;; Look for preceding word in same line.
2660 (skip-syntax-backward "^w_"
2661 (save-excursion (beginning-of-line)
2664 ;; No preceding word in same line.
2665 ;; Look for following word in same line.
2667 (skip-syntax-forward "^w_"
2668 (save-excursion (end-of-line)
2670 (setq start (point))
2671 (skip-syntax-forward "w_")
2674 (skip-syntax-backward "w_")
2675 (setq start (point)))
2676 (buffer-substring-no-properties start end)))
2677 (buffer-substring-no-properties start end)))))
2679 (defcustom fill-prefix nil
2680 "*String for filling to insert at front of new line, or nil for none.
2681 Setting this variable automatically makes it local to the current buffer."
2682 :type '(choice (const :tag "None" nil)
2685 (make-variable-buffer-local 'fill-prefix)
2687 (defcustom auto-fill-inhibit-regexp nil
2688 "*Regexp to match lines which should not be auto-filled."
2689 :type '(choice (const :tag "None" nil)
2693 (defvar comment-line-break-function 'indent-new-comment-line
2694 "*Mode-specific function which line breaks and continues a comment.
2696 This function is only called during auto-filling of a comment section.
2697 The function should take a single optional argument, which is a flag
2698 indicating whether it should use soft newlines.
2700 Setting this variable automatically makes it local to the current buffer.")
2702 ;; This function is used as the auto-fill-function of a buffer
2703 ;; when Auto-Fill mode is enabled.
2704 ;; It returns t if it really did any work.
2705 ;; (Actually some major modes use a different auto-fill function,
2706 ;; but this one is the default one.)
2707 (defun do-auto-fill ()
2708 (let (fc justify bol give-up
2709 (fill-prefix fill-prefix))
2710 (if (or (not (setq justify (current-justification)))
2711 (null (setq fc (current-fill-column)))
2712 (and (eq justify 'left)
2713 (<= (current-column) fc))
2714 (save-excursion (beginning-of-line)
2716 (and auto-fill-inhibit-regexp
2717 (looking-at auto-fill-inhibit-regexp))))
2718 nil ;; Auto-filling not required
2719 (if (memq justify '(full center right))
2720 (save-excursion (unjustify-current-line)))
2722 ;; Choose a fill-prefix automatically.
2723 (if (and adaptive-fill-mode
2724 (or (null fill-prefix) (string= fill-prefix "")))
2726 (fill-context-prefix
2727 (save-excursion (backward-paragraph 1) (point))
2728 (save-excursion (forward-paragraph 1) (point)))))
2729 (and prefix (not (equal prefix ""))
2730 (setq fill-prefix prefix))))
2732 (while (and (not give-up) (> (current-column) fc))
2733 ;; Determine where to split the line.
2736 (let ((opoint (point))
2741 (setq after-prefix (point))
2743 (looking-at (regexp-quote fill-prefix))
2744 (setq after-prefix (match-end 0)))
2745 (move-to-column (1+ fc))
2746 ;; Move back to the point where we can break the line.
2747 ;; We break the line between word or
2748 ;; after/before the character which has character
2749 ;; category `|'. We search space, \c| followed by
2750 ;; a character, or \c| following a character. If
2751 ;; not found, place the point at beginning of line.
2753 ;; If this is after period and a single space,
2754 ;; move back once more--we don't want to break
2755 ;; the line there and make it look like a
2759 sentence-end-double-space
2760 (save-excursion (forward-char -1)
2761 (and (looking-at "\\. ")
2762 (not (looking-at "\\. ")))))
2765 fill-nobreak-predicate
2766 (funcall fill-nobreak-predicate)))
2768 (re-search-backward "[ \t]\\|\\c|.\\|.\\c|\\|^")
2769 ;; If we find nowhere on the line to break it,
2770 ;; break after one word. Set bounce to t
2771 ;; so we will not keep going in this while loop.
2772 (if (<= (point) after-prefix)
2774 (goto-char after-prefix)
2775 (re-search-forward "[ \t]" opoint t)
2777 (if (looking-at "[ \t]")
2778 ;; Break the line at word boundary.
2779 (skip-chars-backward " \t")
2780 ;; Break the line after/before \c|.
2782 (if enable-multibyte-characters
2783 ;; If we are going to break the line after or
2784 ;; before a non-ascii character, we may have
2785 ;; to run a special function for the charset
2786 ;; of the character to find the correct break
2788 (if (not (and (eq (charset-after (1- (point))) 'ascii)
2789 (eq (charset-after (point)) 'ascii)))
2790 (fill-find-break-point after-prefix)))
2792 ;; Let fill-point be set to the place where we end up.
2793 ;; But move back before any whitespace here.
2794 (skip-chars-backward " \t")
2797 ;; See whether the place we found is any good.
2799 (goto-char fill-point)
2801 ;; There is no use breaking at end of line.
2802 (not (save-excursion (skip-chars-forward " ") (eolp)))
2803 ;; It is futile to split at the end of the prefix
2804 ;; since we would just insert the prefix again.
2805 (not (and after-prefix (<= (point) after-prefix)))
2806 ;; Don't split right after a comment starter
2807 ;; since we would just make another comment starter.
2808 (not (and comment-start-skip
2809 (let ((limit (point)))
2811 (and (re-search-forward comment-start-skip
2813 (eq (point) limit)))))))
2814 ;; Ok, we have a useful place to break the line. Do it.
2815 (let ((prev-column (current-column)))
2816 ;; If point is at the fill-point, do not `save-excursion'.
2817 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2818 ;; point will end up before it rather than after it.
2820 (skip-chars-backward " \t")
2821 (= (point) fill-point))
2822 (funcall comment-line-break-function t)
2824 (goto-char fill-point)
2825 (funcall comment-line-break-function t)))
2826 ;; Now do justification, if required
2827 (if (not (eq justify 'left))
2830 (justify-current-line justify nil t)))
2831 ;; If making the new line didn't reduce the hpos of
2832 ;; the end of the line, then give up now;
2833 ;; trying again will not help.
2834 (if (>= (current-column) prev-column)
2836 ;; No good place to break => stop trying.
2838 ;; Justify last line.
2839 (justify-current-line justify t t)
2842 (defvar normal-auto-fill-function 'do-auto-fill
2843 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
2844 Some major modes set this.")
2846 (defun auto-fill-mode (&optional arg)
2847 "Toggle Auto Fill mode.
2848 With arg, turn Auto Fill mode on if and only if arg is positive.
2849 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
2850 automatically breaks the line at a previous space.
2852 The value of `normal-auto-fill-function' specifies the function to use
2853 for `auto-fill-function' when turning Auto Fill mode on."
2855 (prog1 (setq auto-fill-function
2857 (not auto-fill-function)
2858 (> (prefix-numeric-value arg) 0))
2859 normal-auto-fill-function
2861 (force-mode-line-update)))
2863 ;; This holds a document string used to document auto-fill-mode.
2864 (defun auto-fill-function ()
2865 "Automatically break line at a previous space, in insertion of text."
2868 (defun turn-on-auto-fill ()
2869 "Unconditionally turn on Auto Fill mode."
2871 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
2873 (defun set-fill-column (arg)
2874 "Set `fill-column' to specified argument.
2875 Use \\[universal-argument] followed by a number to specify a column.
2876 Just \\[universal-argument] as argument means to use the current column."
2879 (setq arg (current-column)))
2880 (if (not (integerp arg))
2881 ;; Disallow missing argument; it's probably a typo for C-x C-f.
2882 (error "set-fill-column requires an explicit argument")
2883 (message "Fill column set to %d (was %d)" arg fill-column)
2884 (setq fill-column arg)))
2886 (defun set-selective-display (arg)
2887 "Set `selective-display' to ARG; clear it if no arg.
2888 When the value of `selective-display' is a number > 0,
2889 lines whose indentation is >= that value are not displayed.
2890 The variable `selective-display' has a separate value for each buffer."
2892 (if (eq selective-display t)
2893 (error "selective-display already in use for marked lines"))
2896 (narrow-to-region (point-min) (point))
2897 (goto-char (window-start))
2898 (vertical-motion (window-height)))))
2899 (setq selective-display
2900 (and arg (prefix-numeric-value arg)))
2901 (recenter current-vpos))
2902 (set-window-start (selected-window) (window-start (selected-window)))
2903 (princ "selective-display set to " t)
2904 (prin1 selective-display t)
2907 (defvar overwrite-mode-textual " Ovwrt"
2908 "The string displayed in the mode line when in overwrite mode.")
2909 (defvar overwrite-mode-binary " Bin Ovwrt"
2910 "The string displayed in the mode line when in binary overwrite mode.")
2912 (defun overwrite-mode (arg)
2913 "Toggle overwrite mode.
2914 With arg, turn overwrite mode on iff arg is positive.
2915 In overwrite mode, printing characters typed in replace existing text
2916 on a one-for-one basis, rather than pushing it to the right. At the
2917 end of a line, such characters extend the line. Before a tab,
2918 such characters insert until the tab is filled in.
2919 \\[quoted-insert] still inserts characters in overwrite mode; this
2920 is supposed to make it easier to insert characters when necessary."
2922 (setq overwrite-mode
2923 (if (if (null arg) (not overwrite-mode)
2924 (> (prefix-numeric-value arg) 0))
2925 'overwrite-mode-textual))
2926 (force-mode-line-update))
2928 (defun binary-overwrite-mode (arg)
2929 "Toggle binary overwrite mode.
2930 With arg, turn binary overwrite mode on iff arg is positive.
2931 In binary overwrite mode, printing characters typed in replace
2932 existing text. Newlines are not treated specially, so typing at the
2933 end of a line joins the line to the next, with the typed character
2934 between them. Typing before a tab character simply replaces the tab
2935 with the character typed.
2936 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2937 typing characters do.
2939 Note that binary overwrite mode is not its own minor mode; it is a
2940 specialization of overwrite-mode, entered by setting the
2941 `overwrite-mode' variable to `overwrite-mode-binary'."
2943 (setq overwrite-mode
2945 (not (eq overwrite-mode 'overwrite-mode-binary))
2946 (> (prefix-numeric-value arg) 0))
2947 'overwrite-mode-binary))
2948 (force-mode-line-update))
2950 (defcustom line-number-mode t
2951 "*Non-nil means display line number in mode line."
2953 :group 'editing-basics)
2955 (defun line-number-mode (arg)
2956 "Toggle Line Number mode.
2957 With arg, turn Line Number mode on iff arg is positive.
2958 When Line Number mode is enabled, the line number appears
2961 Line numbers do not appear for very large buffers, see variable
2962 `line-number-display-limit'."
2964 (setq line-number-mode
2965 (if (null arg) (not line-number-mode)
2966 (> (prefix-numeric-value arg) 0)))
2967 (force-mode-line-update))
2969 (defcustom column-number-mode nil
2970 "*Non-nil means display column number in mode line."
2972 :group 'editing-basics)
2974 (defun column-number-mode (arg)
2975 "Toggle Column Number mode.
2976 With arg, turn Column Number mode on iff arg is positive.
2977 When Column Number mode is enabled, the column number appears
2980 (setq column-number-mode
2981 (if (null arg) (not column-number-mode)
2982 (> (prefix-numeric-value arg) 0)))
2983 (force-mode-line-update))
2985 (defgroup paren-blinking nil
2986 "Blinking matching of parens and expressions."
2987 :prefix "blink-matching-"
2988 :group 'paren-matching)
2990 (defcustom blink-matching-paren t
2991 "*Non-nil means show matching open-paren when close-paren is inserted."
2993 :group 'paren-blinking)
2995 (defcustom blink-matching-paren-on-screen t
2996 "*Non-nil means show matching open-paren when it is on screen.
2997 If nil, means don't show it (but the open-paren can still be shown
2998 when it is off screen)."
3000 :group 'paren-blinking)
3002 (defcustom blink-matching-paren-distance (* 25 1024)
3003 "*If non-nil, is maximum distance to search for matching open-paren."
3005 :group 'paren-blinking)
3007 (defcustom blink-matching-delay 1
3008 "*Time in seconds to delay after showing a matching paren."
3010 :group 'paren-blinking)
3012 (defcustom blink-matching-paren-dont-ignore-comments nil
3013 "*Non-nil means `blink-matching-paren' will not ignore comments."
3015 :group 'paren-blinking)
3017 (defun blink-matching-open ()
3018 "Move cursor momentarily to the beginning of the sexp before point."
3020 (and (> (point) (1+ (point-min)))
3021 blink-matching-paren
3022 ;; Verify an even number of quoting characters precede the close.
3023 (= 1 (logand 1 (- (point)
3026 (skip-syntax-backward "/\\")
3028 (let* ((oldpos (point))
3033 (if blink-matching-paren-distance
3034 (narrow-to-region (max (point-min)
3035 (- (point) blink-matching-paren-distance))
3038 (let ((parse-sexp-ignore-comments
3039 (and parse-sexp-ignore-comments
3040 (not blink-matching-paren-dont-ignore-comments))))
3041 (setq blinkpos (scan-sexps oldpos -1)))
3044 (/= (char-syntax (char-after blinkpos))
3047 (or (null (matching-paren (char-after blinkpos)))
3048 (/= (char-after (1- oldpos))
3049 (matching-paren (char-after blinkpos))))))
3050 (if mismatch (setq blinkpos nil))
3052 ;; Don't log messages about paren matching.
3053 (let (message-log-max)
3054 (goto-char blinkpos)
3055 (if (pos-visible-in-window-p)
3056 (and blink-matching-paren-on-screen
3057 (sit-for blink-matching-delay))
3058 (goto-char blinkpos)
3061 ;; Show what precedes the open in its line, if anything.
3063 (skip-chars-backward " \t")
3065 (buffer-substring (progn (beginning-of-line) (point))
3067 ;; Show what follows the open in its line, if anything.
3070 (skip-chars-forward " \t")
3072 (buffer-substring blinkpos
3073 (progn (end-of-line) (point)))
3074 ;; Otherwise show the previous nonblank line,
3077 (skip-chars-backward "\n \t")
3080 (buffer-substring (progn
3081 (skip-chars-backward "\n \t")
3084 (progn (end-of-line)
3085 (skip-chars-backward " \t")
3087 ;; Replace the newline and other whitespace with `...'.
3089 (buffer-substring blinkpos (1+ blinkpos)))
3090 ;; There is nothing to show except the char itself.
3091 (buffer-substring blinkpos (1+ blinkpos))))))))
3093 (message "Mismatched parentheses"))
3094 ((not blink-matching-paren-distance)
3095 (message "Unmatched parenthesis"))))))))
3097 ;Turned off because it makes dbx bomb out.
3098 (setq blink-paren-function 'blink-matching-open)
3100 ;; This executes C-g typed while Emacs is waiting for a command.
3101 ;; Quitting out of a program does not go through here;
3102 ;; that happens in the QUIT macro at the C code level.
3103 (defun keyboard-quit ()
3104 "Signal a `quit' condition.
3105 During execution of Lisp code, this character causes a quit directly.
3106 At top-level, as an editor command, this simply beeps."
3111 (define-key global-map "\C-g" 'keyboard-quit)
3113 (defvar buffer-quit-function nil
3114 "Function to call to \"quit\" the current buffer, or nil if none.
3115 \\[keyboard-escape-quit] calls this function when its more local actions
3116 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3118 (defun keyboard-escape-quit ()
3119 "Exit the current \"mode\" (in a generalized sense of the word).
3120 This command can exit an interactive command such as `query-replace',
3121 can clear out a prefix argument or a region,
3122 can get out of the minibuffer or other recursive edit,
3123 cancel the use of the current buffer (for special-purpose buffers),
3124 or go back to just one window (by deleting all but the selected window)."
3126 (cond ((eq last-command 'mode-exited) nil)
3127 ((> (minibuffer-depth) 0)
3128 (abort-recursive-edit))
3131 ((and transient-mark-mode
3134 ((> (recursion-depth) 0)
3135 (exit-recursive-edit))
3136 (buffer-quit-function
3137 (funcall buffer-quit-function))
3138 ((not (one-window-p t))
3139 (delete-other-windows))
3140 ((string-match "^ \\*" (buffer-name (current-buffer)))
3143 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3145 (defcustom input-mode-8-bit t
3146 "Control acceptance of 8-bit keyboard input.
3147 This may be useful for inputting non-ASCII characters if your keyboard
3148 can generate them. It is not necessary to change this under a window
3149 system which can distinguish 8-bit characters and Meta keys.
3150 Setting this variable directly does not take effect;
3151 use either M-x customize or the function `set-input-mode'."
3152 :set (lambda (symbol value)
3153 (let ((mode (current-input-mode)))
3154 (set-input-mode (nth 0 mode) (nth 1 mode) value)))
3155 :initialize 'custom-initialize-default
3156 :type '(choice (const :tag "8-bit input for a Meta key" t)
3157 (const :tag "Direct 8-bit character input" 0)
3158 (const :tag "Assume top bit is parity and ignore" nil))
3160 :link '(custom-manual "Single-Byte European Support")
3163 (defcustom read-mail-command 'rmail
3164 "*Your preference for a mail reading package.
3165 This is used by some keybindings which support reading mail."
3166 :type '(choice (function-item rmail)
3167 (function-item gnus)
3168 (function-item mh-rmail)
3169 (function :tag "Other"))
3173 (defcustom mail-user-agent 'sendmail-user-agent
3174 "*Your preference for a mail composition package.
3175 Various Emacs Lisp packages (e.g. reporter) require you to compose an
3176 outgoing email message. This variable lets you specify which
3177 mail-sending package you prefer.
3179 Valid values include:
3181 `sendmail-user-agent' -- use the default Emacs Mail package
3182 `mh-e-user-agent' -- use the Emacs interface to the MH mail system
3183 `message-user-agent' -- use the GNUS mail sending package
3185 Additional valid symbols may be available; check with the author of
3186 your package for details."
3187 :type '(radio (function-item :tag "Default Emacs mail"
3189 sendmail-user-agent)
3190 (function-item :tag "Emacs interface to MH"
3193 (function-item :tag "Gnus mail sending package"
3196 (function :tag "Other"))
3199 (defun define-mail-user-agent (symbol composefunc sendfunc
3200 &optional abortfunc hookvar)
3201 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3203 SYMBOL can be any Lisp symbol. Its function definition and/or
3204 value as a variable do not matter for this usage; we use only certain
3205 properties on its property list, to encode the rest of the arguments.
3207 COMPOSEFUNC is program callable function that composes an outgoing
3208 mail message buffer. This function should set up the basics of the
3209 buffer without requiring user interaction. It should populate the
3210 standard mail headers, leaving the `to:' and `subject:' headers blank
3213 COMPOSEFUNC should accept several optional arguments--the same
3214 arguments that `compose-mail' takes. See that function's documentation.
3216 SENDFUNC is the command a user would run to send the message.
3218 Optional ABORTFUNC is the command a user would run to abort the
3219 message. For mail packages that don't have a separate abort function,
3220 this can be `kill-buffer' (the equivalent of omitting this argument).
3222 Optional HOOKVAR is a hook variable that gets run before the message
3223 is actually sent. Callers that use the `mail-user-agent' may
3224 install a hook function temporarily on this hook variable.
3225 If HOOKVAR is nil, `mail-send-hook' is used.
3227 The properties used on SYMBOL are `composefunc', `sendfunc',
3228 `abortfunc', and `hookvar'."
3229 (put symbol 'composefunc composefunc)
3230 (put symbol 'sendfunc sendfunc)
3231 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3232 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3234 (define-mail-user-agent 'sendmail-user-agent
3235 'sendmail-user-agent-compose
3236 'mail-send-and-exit)
3238 (defun rfc822-goto-eoh ()
3239 ;; Go to header delimiter line in a mail message, following RFC822 rules
3240 (goto-char (point-min))
3241 (while (looking-at "^[^: \n]+:\\|^[ \t]")
3245 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3246 switch-function yank-action
3249 (let ((special-display-buffer-names nil)
3250 (special-display-regexps nil)
3251 (same-window-buffer-names nil)
3252 (same-window-regexps nil))
3253 (funcall switch-function "*mail*")))
3254 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3255 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3256 (body (cdr (assoc-ignore-case "body" other-headers))))
3257 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3259 (error "Message aborted"))
3262 (while other-headers
3263 (unless (member-ignore-case (car (car other-headers))
3264 '("in-reply-to" "cc" "body"))
3265 (insert (car (car other-headers)) ": "
3266 (cdr (car other-headers)) "\n"))
3267 (setq other-headers (cdr other-headers)))
3273 (define-mail-user-agent 'mh-e-user-agent
3274 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3275 'mh-before-send-letter-hook)
3277 (defun compose-mail (&optional to subject other-headers continue
3278 switch-function yank-action send-actions)
3279 "Start composing a mail message to send.
3280 This uses the user's chosen mail composition package
3281 as selected with the variable `mail-user-agent'.
3282 The optional arguments TO and SUBJECT specify recipients
3283 and the initial Subject field, respectively.
3285 OTHER-HEADERS is an alist specifying additional
3286 header fields. Elements look like (HEADER . VALUE) where both
3287 HEADER and VALUE are strings.
3289 CONTINUE, if non-nil, says to continue editing a message already
3292 SWITCH-FUNCTION, if non-nil, is a function to use to
3293 switch to and display the buffer used for mail composition.
3295 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3296 to insert the raw text of the message being replied to.
3297 It has the form (FUNCTION . ARGS). The user agent will apply
3298 FUNCTION to ARGS, to insert the raw text of the original message.
3299 \(The user agent will also run `mail-citation-hook', *after* the
3300 original text has been inserted in this way.)
3302 SEND-ACTIONS is a list of actions to call when the message is sent.
3303 Each action has the form (FUNCTION . ARGS)."
3305 (list nil nil nil current-prefix-arg))
3306 (let ((function (get mail-user-agent 'composefunc)))
3307 (funcall function to subject other-headers continue
3308 switch-function yank-action send-actions)))
3310 (defun compose-mail-other-window (&optional to subject other-headers continue
3311 yank-action send-actions)
3312 "Like \\[compose-mail], but edit the outgoing message in another window."
3314 (list nil nil nil current-prefix-arg))
3315 (compose-mail to subject other-headers continue
3316 'switch-to-buffer-other-window yank-action send-actions))
3319 (defun compose-mail-other-frame (&optional to subject other-headers continue
3320 yank-action send-actions)
3321 "Like \\[compose-mail], but edit the outgoing message in another frame."
3323 (list nil nil nil current-prefix-arg))
3324 (compose-mail to subject other-headers continue
3325 'switch-to-buffer-other-frame yank-action send-actions))
3327 (defvar set-variable-value-history nil
3328 "History of values entered with `set-variable'.")
3330 (defun set-variable (var val)
3331 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3332 When using this interactively, enter a Lisp object for VALUE.
3333 If you want VALUE to be a string, you must surround it with doublequotes.
3334 VALUE is used literally, not evaluated.
3336 If VARIABLE has a `variable-interactive' property, that is used as if
3337 it were the arg to `interactive' (which see) to interactively read VALUE.
3339 If VARIABLE has been defined with `defcustom', then the type information
3340 in the definition is used to check that VALUE is valid."
3342 (let* ((default-var (variable-at-point))
3343 (var (if (symbolp default-var)
3344 (read-variable (format "Set variable (default %s): " default-var)
3346 (read-variable "Set variable: ")))
3347 (minibuffer-help-form '(describe-variable var))
3348 (prop (get var 'variable-interactive))
3349 (prompt (format "Set %s to value: " var))
3351 ;; Use VAR's `variable-interactive' property
3352 ;; as an interactive spec for prompting.
3353 (call-interactively `(lambda (arg)
3357 (read-string prompt nil
3358 'set-variable-value-history)))))
3361 (let ((type (get var 'custom-type)))
3363 ;; Match with custom type.
3365 (setq type (widget-convert type))
3366 (unless (widget-apply type :match val)
3367 (error "Value `%S' does not match type %S of %S"
3368 val (car type) var))))
3371 ;; Define the major mode for lists of completions.
3373 (defvar completion-list-mode-map nil
3374 "Local map for completion list buffers.")
3375 (or completion-list-mode-map
3376 (let ((map (make-sparse-keymap)))
3377 (define-key map [mouse-2] 'mouse-choose-completion)
3378 (define-key map [down-mouse-2] nil)
3379 (define-key map "\C-m" 'choose-completion)
3380 (define-key map "\e\e\e" 'delete-completion-window)
3381 (define-key map [left] 'previous-completion)
3382 (define-key map [right] 'next-completion)
3383 (setq completion-list-mode-map map)))
3385 ;; Completion mode is suitable only for specially formatted data.
3386 (put 'completion-list-mode 'mode-class 'special)
3388 (defvar completion-reference-buffer nil
3389 "Record the buffer that was current when the completion list was requested.
3390 This is a local variable in the completion list buffer.
3391 Initial value is nil to avoid some compiler warnings.")
3393 (defvar completion-no-auto-exit nil
3394 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3395 This also applies to other functions such as `choose-completion'
3396 and `mouse-choose-completion'.")
3398 (defvar completion-base-size nil
3399 "Number of chars at beginning of minibuffer not involved in completion.
3400 This is a local variable in the completion list buffer
3401 but it talks about the buffer in `completion-reference-buffer'.
3402 If this is nil, it means to compare text to determine which part
3403 of the tail end of the buffer's text is involved in completion.")
3405 (defun delete-completion-window ()
3406 "Delete the completion list window.
3407 Go to the window from which completion was requested."
3409 (let ((buf completion-reference-buffer))
3410 (if (one-window-p t)
3411 (if (window-dedicated-p (selected-window))
3412 (delete-frame (selected-frame)))
3413 (delete-window (selected-window))
3414 (if (get-buffer-window buf)
3415 (select-window (get-buffer-window buf))))))
3417 (defun previous-completion (n)
3418 "Move to the previous item in the completion list."
3420 (next-completion (- n)))
3422 (defun next-completion (n)
3423 "Move to the next item in the completion list.
3424 With prefix argument N, move N items (negative N means move backward)."
3426 (while (and (> n 0) (not (eobp)))
3427 (let ((prop (get-text-property (point) 'mouse-face))
3429 ;; If in a completion, move to the end of it.
3431 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3432 ;; Move to start of next one.
3433 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3435 (while (and (< n 0) (not (bobp)))
3436 (let ((prop (get-text-property (1- (point)) 'mouse-face))
3438 ;; If in a completion, move to the start of it.
3440 (goto-char (previous-single-property-change
3441 (point) 'mouse-face nil end)))
3442 ;; Move to end of the previous completion.
3443 (goto-char (previous-single-property-change (point) 'mouse-face nil end))
3444 ;; Move to the start of that one.
3445 (goto-char (previous-single-property-change (point) 'mouse-face nil end)))
3448 (defun choose-completion ()
3449 "Choose the completion that point is in or next to."
3451 (let (beg end completion (buffer completion-reference-buffer)
3452 (base-size completion-base-size))
3453 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3454 (setq end (point) beg (1+ (point))))
3455 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3456 (setq end (1- (point)) beg (point)))
3458 (error "No completion here"))
3459 (setq beg (previous-single-property-change beg 'mouse-face))
3460 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3461 (setq completion (buffer-substring beg end))
3462 (let ((owindow (selected-window)))
3463 (if (and (one-window-p t 'selected-frame)
3464 (window-dedicated-p (selected-window)))
3465 ;; This is a special buffer's frame
3466 (iconify-frame (selected-frame))
3467 (or (window-dedicated-p (selected-window))
3469 (select-window owindow))
3470 (choose-completion-string completion buffer base-size)))
3472 ;; Delete the longest partial match for STRING
3473 ;; that can be found before POINT.
3474 (defun choose-completion-delete-max-match (string)
3475 (let ((opoint (point))
3476 (len (min (length string)
3477 (- (point) (point-min)))))
3478 (goto-char (- (point) (length string)))
3479 (if completion-ignore-case
3480 (setq string (downcase string)))
3481 (while (and (> len 0)
3482 (let ((tail (buffer-substring (point)
3484 (if completion-ignore-case
3485 (setq tail (downcase tail)))
3486 (not (string= tail (substring string 0 len)))))
3491 ;; Switch to BUFFER and insert the completion choice CHOICE.
3492 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3493 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
3495 ;; If BUFFER is the minibuffer, exit the minibuffer
3496 ;; unless it is reading a file name and CHOICE is a directory,
3497 ;; or completion-no-auto-exit is non-nil.
3498 (defun choose-completion-string (choice &optional buffer base-size)
3499 (let ((buffer (or buffer completion-reference-buffer))
3500 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))))
3501 ;; If BUFFER is a minibuffer, barf unless it's the currently
3502 ;; active minibuffer.
3504 (or (not (active-minibuffer-window))
3506 (window-buffer (active-minibuffer-window))))))
3507 (error "Minibuffer is not active for completion")
3508 ;; Insert the completion into the buffer where completion was requested.
3511 (delete-region (+ base-size (if mini-p
3512 (minibuffer-prompt-end)
3515 (choose-completion-delete-max-match choice))
3517 (remove-text-properties (- (point) (length choice)) (point)
3519 ;; Update point in the window that BUFFER is showing in.
3520 (let ((window (get-buffer-window buffer t)))
3521 (set-window-point window (point)))
3522 ;; If completing for the minibuffer, exit it with this choice.
3523 (and (not completion-no-auto-exit)
3524 (equal buffer (window-buffer (minibuffer-window)))
3525 minibuffer-completion-table
3526 ;; If this is reading a file name, and the file name chosen
3527 ;; is a directory, don't exit the minibuffer.
3528 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
3529 (file-directory-p (field-string (point-max))))
3530 (select-window (active-minibuffer-window))
3531 (exit-minibuffer))))))
3533 (defun completion-list-mode ()
3534 "Major mode for buffers showing lists of possible completions.
3535 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3536 to select the completion near point.
3537 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3540 (kill-all-local-variables)
3541 (use-local-map completion-list-mode-map)
3542 (setq mode-name "Completion List")
3543 (setq major-mode 'completion-list-mode)
3544 (make-local-variable 'completion-base-size)
3545 (setq completion-base-size nil)
3546 (run-hooks 'completion-list-mode-hook))
3548 (defvar completion-setup-hook nil
3549 "Normal hook run at the end of setting up a completion list buffer.
3550 When this hook is run, the current buffer is the one in which the
3551 command to display the completion list buffer was run.
3552 The completion list buffer is available as the value of `standard-output'.")
3554 ;; This function goes in completion-setup-hook, so that it is called
3555 ;; after the text of the completion list buffer is written.
3557 (defun completion-setup-function ()
3559 (let ((mainbuf (current-buffer)))
3560 (set-buffer standard-output)
3561 (completion-list-mode)
3562 (make-local-variable 'completion-reference-buffer)
3563 (setq completion-reference-buffer mainbuf)
3564 (if (eq minibuffer-completion-table 'read-file-name-internal)
3565 ;; For file name completion,
3566 ;; use the number of chars before the start of the
3567 ;; last file name component.
3568 (setq completion-base-size
3570 (set-buffer mainbuf)
3571 (goto-char (point-max))
3572 (skip-chars-backward (format "^%c" directory-sep-char))
3573 (- (point) (minibuffer-prompt-end))))
3574 ;; Otherwise, in minibuffer, the whole input is being completed.
3576 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3577 (buffer-name mainbuf))
3578 (setq completion-base-size 0))))
3579 (goto-char (point-min))
3580 (if (display-mouse-p)
3581 (insert (substitute-command-keys
3582 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
3583 (insert (substitute-command-keys
3584 "In this buffer, type \\[choose-completion] to \
3585 select the completion near point.\n\n")))))
3587 (add-hook 'completion-setup-hook 'completion-setup-function)
3589 (define-key minibuffer-local-completion-map [prior]
3590 'switch-to-completions)
3591 (define-key minibuffer-local-must-match-map [prior]
3592 'switch-to-completions)
3593 (define-key minibuffer-local-completion-map "\M-v"
3594 'switch-to-completions)
3595 (define-key minibuffer-local-must-match-map "\M-v"
3596 'switch-to-completions)
3598 (defun switch-to-completions ()
3599 "Select the completion list window."
3601 ;; Make sure we have a completions window.
3602 (or (get-buffer-window "*Completions*")
3603 (minibuffer-completion-help))
3604 (let ((window (get-buffer-window "*Completions*")))
3606 (select-window window)
3607 (goto-char (point-min))
3608 (search-forward "\n\n")
3611 ;; Support keyboard commands to turn on various modifiers.
3613 ;; These functions -- which are not commands -- each add one modifier
3614 ;; to the following event.
3616 (defun event-apply-alt-modifier (ignore-prompt)
3617 "Add the Alt modifier to the following event.
3618 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
3619 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3620 (defun event-apply-super-modifier (ignore-prompt)
3621 "Add the Super modifier to the following event.
3622 For example, type \\[event-apply-super-modifier] & to enter Super-&."
3623 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3624 (defun event-apply-hyper-modifier (ignore-prompt)
3625 "Add the Hyper modifier to the following event.
3626 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
3627 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3628 (defun event-apply-shift-modifier (ignore-prompt)
3629 "Add the Shift modifier to the following event.
3630 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
3631 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3632 (defun event-apply-control-modifier (ignore-prompt)
3633 "Add the Ctrl modifier to the following event.
3634 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
3635 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3636 (defun event-apply-meta-modifier (ignore-prompt)
3637 "Add the Meta modifier to the following event.
3638 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
3639 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3641 (defun event-apply-modifier (event symbol lshiftby prefix)
3642 "Apply a modifier flag to event EVENT.
3643 SYMBOL is the name of this modifier, as a symbol.
3644 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3645 PREFIX is the string that represents this modifier in an event type symbol."
3647 (cond ((eq symbol 'control)
3648 (if (and (<= (downcase event) ?z)
3649 (>= (downcase event) ?a))
3650 (- (downcase event) ?a -1)
3651 (if (and (<= (downcase event) ?Z)
3652 (>= (downcase event) ?A))
3653 (- (downcase event) ?A -1)
3654 (logior (lsh 1 lshiftby) event))))
3656 (if (and (<= (downcase event) ?z)
3657 (>= (downcase event) ?a))
3659 (logior (lsh 1 lshiftby) event)))
3661 (logior (lsh 1 lshiftby) event)))
3662 (if (memq symbol (event-modifiers event))
3664 (let ((event-type (if (symbolp event) event (car event))))
3665 (setq event-type (intern (concat prefix (symbol-name event-type))))
3668 (cons event-type (cdr event)))))))
3670 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3671 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3672 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3673 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3674 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3675 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3677 ;;;; Keypad support.
3679 ;;; Make the keypad keys act like ordinary typing keys. If people add
3680 ;;; bindings for the function key symbols, then those bindings will
3681 ;;; override these, so this shouldn't interfere with any existing
3684 ;; Also tell read-char how to handle these keys.
3686 (lambda (keypad-normal)
3687 (let ((keypad (nth 0 keypad-normal))
3688 (normal (nth 1 keypad-normal)))
3689 (put keypad 'ascii-character normal)
3690 (define-key function-key-map (vector keypad) (vector normal))))
3691 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3692 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3705 ;;;; forking a twin copy of a buffer.
3708 (defvar clone-buffer-hook nil
3709 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
3711 (defun clone-process (process &optional newname)
3712 "Create a twin copy of PROCESS.
3713 If NEWNAME is nil, it defaults to PROCESS' name;
3714 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3715 If PROCESS is associated with a buffer, the new process will be associated
3716 with the current buffer instead.
3717 Returns nil if PROCESS has already terminated."
3718 (setq newname (or newname (process-name process)))
3719 (if (string-match "<[0-9]+>\\'" newname)
3720 (setq newname (substring newname 0 (match-beginning 0))))
3721 (when (memq (process-status process) '(run stop open))
3722 (let* ((process-connection-type (process-tty-name process))
3723 (old-kwoq (process-kill-without-query process nil))
3725 (if (memq (process-status process) '(open))
3726 (apply 'open-network-stream newname
3727 (if (process-buffer process) (current-buffer))
3728 (process-contact process))
3729 (apply 'start-process newname
3730 (if (process-buffer process) (current-buffer))
3731 (process-command process)))))
3732 (process-kill-without-query new-process old-kwoq)
3733 (process-kill-without-query process old-kwoq)
3734 (set-process-inherit-coding-system-flag
3735 new-process (process-inherit-coding-system-flag process))
3736 (set-process-filter new-process (process-filter process))
3737 (set-process-sentinel new-process (process-sentinel process))
3740 ;; things to maybe add (currently partly covered by `funcall mode':
3743 (defun clone-buffer (&optional newname display-flag)
3744 "Create a twin copy of the current buffer.
3745 If NEWNAME is nil, it defaults to the current buffer's name;
3746 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3748 If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
3749 This runs the normal hook `clone-buffer-hook' in the new buffer
3750 after it has been set up properly in other respects."
3751 (interactive (list (if current-prefix-arg (read-string "Name: "))
3753 (if buffer-file-name
3754 (error "Cannot clone a file-visiting buffer"))
3755 (if (get major-mode 'no-clone)
3756 (error "Cannot clone a buffer in %s mode" mode-name))
3757 (setq newname (or newname (buffer-name)))
3758 (if (string-match "<[0-9]+>\\'" newname)
3759 (setq newname (substring newname 0 (match-beginning 0))))
3760 (let ((buf (current-buffer))
3764 (mk (if mark-active (mark t)))
3765 (modified (buffer-modified-p))
3767 (lvars (buffer-local-variables))
3768 (process (get-buffer-process (current-buffer)))
3769 (new (generate-new-buffer (or newname (buffer-name)))))
3772 (with-current-buffer new
3773 (insert-buffer-substring buf)))
3774 (with-current-buffer new
3775 (narrow-to-region ptmin ptmax)
3777 (if mk (set-mark mk))
3778 (set-buffer-modified-p modified)
3780 ;; Clone the old buffer's process, if any.
3781 (when process (clone-process process))
3783 ;; Now set up the major mode.
3786 ;; Set up other local variables.
3788 (condition-case () ;in case var is read-only
3791 (set (make-local-variable (car v)) (cdr v)))
3795 ;; Run any hooks (typically set up by the major mode
3796 ;; for cloning to work properly).
3797 (run-hooks 'clone-buffer-hook))
3798 (if display-flag (pop-to-buffer new))
3802 (defun clone-indirect-buffer (newname display-flag &optional norecord)
3803 "Create an indirect buffer that is a twin copy of the current buffer.
3805 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
3806 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
3807 or if not called with a prefix arg, NEWNAME defaults to the current
3808 buffer's name. The name is modified by adding a `<N>' suffix to it
3809 or by incrementing the N in an existing suffix.
3811 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
3812 This is always done when called interactively.
3814 Optional last arg NORECORD non-nil means do not put this buffer at the
3815 front of the list of recently selected ones."
3816 (interactive (list (if current-prefix-arg
3817 (read-string "BName of indirect buffer: "))
3819 (setq newname (or newname (buffer-name)))
3820 (if (string-match "<[0-9]+>\\'" newname)
3821 (setq newname (substring newname 0 (match-beginning 0))))
3822 (let* ((name (generate-new-buffer-name newname))
3823 (buffer (make-indirect-buffer (current-buffer) name t)))
3825 (pop-to-buffer buffer))
3829 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
3830 "Create an indirect buffer that is a twin copy of BUFFER.
3831 Select the new buffer in another window.
3832 Optional second arg NORECORD non-nil means do not put this buffer at
3833 the front of the list of recently selected ones."
3834 (interactive "bClone buffer in other window: ")
3835 (let ((popup-windows t))
3837 (clone-indirect-buffer nil t norecord)))
3839 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
3844 (defconst syntax-code-table
3845 '((?\ 0 "whitespace")
3847 (?. 1 "punctuation")
3850 (?\( 4 "open parenthesis")
3851 (?\) 5 "close parenthesis")
3852 (?\' 6 "expression prefix")
3853 (?\" 7 "string quote")
3854 (?$ 8 "paired delimiter")
3856 (?/ 10 "character quote")
3857 (?< 11 "comment start")
3858 (?> 12 "comment end")
3860 (nil 14 "comment fence")
3861 (nil 15 "string fence"))
3862 "Alist of forms (CHAR CODE DESCRIPTION) mapping characters to syntax info.
3863 CHAR is a character that is allowed as first char in the string
3864 specifying the syntax when calling `modify-syntax-entry'. CODE is the
3865 corresponing syntax code as it is stored in a syntax cell, and
3866 can be used as value of a `syntax-table' property.
3867 DESCRIPTION is the descriptive string for the syntax.")
3869 (defconst syntax-flag-table
3870 '((?1 . #b10000000000000000)
3871 (?2 . #b100000000000000000)
3872 (?3 . #b1000000000000000000)
3873 (?4 . #b10000000000000000000)
3874 (?p . #b100000000000000000000)
3875 (?b . #b1000000000000000000000)
3876 (?n . #b10000000000000000000000))
3877 "Alist of pairs (CHAR . FLAG) mapping characters to syntax flags.
3878 CHAR is a character that is allowed as second or following character
3879 in the string argument to `modify-syntax-entry' specifying the syntax.
3880 FLAG is the corresponding syntax flag value that is stored in a
3883 (defun string-to-syntax (string)
3884 "Convert a syntax specification STRING into syntax cell form.
3885 STRING should be a string as it is allowed as argument of
3886 `modify-syntax-entry'. Value is the equivalent cons cell
3887 \(CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
3889 (let* ((first-char (aref string 0))
3890 (code (or (nth 1 (assq first-char syntax-code-table))
3891 (error "Invalid syntax specification `%s'" string)))
3892 (length (length string))
3895 ;; Determine the matching character, if any.
3896 (when (and (> length 1)
3897 (memq first-char '(?\( ?\))))
3898 (setq matching-char (aref string i)
3900 ;; Add any flags to the syntax code.
3902 (let ((flag (or (assq (aref string i) syntax-flag-table)
3903 (error "Invalid syntax flag in `%s'" string))))
3904 (setq code (logior flag code))
3907 (cons code matching-char)))
3909 ;;; simple.el ends here