| blob | 5e5cd877e9b343a8e0a3a4bcaa1500bffe656e68 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2015 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
356 ;; Special major modes to view specially formatted data rather than files.
370 map))
374 "Parent major mode from which special major modes should inherit."
377 ;; Making and deleting lines.
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
409 ;; Don't auto-fill if we have a numeric argument.
412 ;; Do the rest in post-self-insert-hook, because we want to do it
413 ;; *before* other functions on that hook.
416 ;; Mark the newline(s) `hard'.
420 ;; If the newline leaves the previous line blank, and we
421 ;; have a left margin, delete that from the blank line.
429 ;; Indent the line after the newline, except in one case:
430 ;; when we added the newline at the beginning of a line which
431 ;; starts a page.
436 ;; FIXME: For non-interactive uses, many calls actually just want
437 ;; (insert "\n"), so maybe we should do just that, so as to avoid
438 ;; the risk of filling or running abbrevs unexpectedly.
445 ;; We first used let-binding to protect the hook, but that was naive
446 ;; since add-hook affects the symbol-default value of the variable,
447 ;; whereas the let-binding might only protect the buffer-local value.
451 nil)
456 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
462 "Insert a newline and leave point before it.
463 If there is a fill prefix and/or a `left-margin', insert them
464 on the new line if the line would have been blank.
465 With arg N, insert N newlines."
470 ;; Don't expand an abbrev before point.
484 "Split current line, moving portion beyond point vertically down.
485 If the current line starts with `fill-prefix', insert it on the new
486 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
488 When called from Lisp code, ARG may be a prefix string to copy."
493 ;; What prefix should we check for (nil means don't).
497 ;; Does this line start with it?
508 "Join this line to previous and fix up whitespace at join.
509 If there is a fill prefix, delete it from the beginning of this line.
510 With argument, join this line to following line."
517 ;; If the second line started with the fill prefix,
518 ;; delete the prefix.
530 "On blank line, delete all surrounding blank lines, leaving just one.
531 On isolated blank line, delete that one.
532 On nonblank line, delete any immediately following blank lines."
538 ;; Set singleblank if there is just one blank line here.
545 ;; Delete preceding blank lines, and this one too if it's the only one.
554 ;; Delete following blank lines, unless the current line is blank
555 ;; and there are no following blank lines.
564 ;; Handle the special case where point is followed by newline and eob.
565 ;; Delete the line, leaving point at eob.
571 Trailing lines are deleted only if `delete-trailing-whitespace'
572 is called on the entire buffer (rather than an active region)."
578 "Delete trailing whitespace between START and END.
579 If called interactively, START and END are the start/end of the
580 region if the mark is active, or of the buffer's accessible
581 portion if the mark is inactive.
583 This command deletes whitespace characters after the last
584 non-whitespace character in each line between START and END. It
585 does not consider formfeed characters to be whitespace.
587 If this command acts on the entire buffer (i.e. if called
588 interactively with the mark inactive, or called from Lisp with
589 END nil), it also deletes all trailing lines at the end of the
590 buffer if the variable `delete-trailing-lines' is non-nil."
603 ;; Don't delete formfeeds, even if they are considered whitespace.
607 ;; Delete trailing empty lines.
610 delete-trailing-lines
611 ;; Really the end of buffer.
616 ;; Return nil for the benefit of `write-file-functions'.
617 nil)
620 "Insert a newline, then indent according to major mode.
621 Indentation is done using the value of `indent-line-function'.
622 In programming language modes, this is the same as TAB.
623 In some text modes, where TAB inserts a tab, this command indents to the
624 column specified by the function `current-left-margin'."
631 "Reindent current line, insert newline, then indent the new line.
632 Indentation of both lines is done according to the current major mode,
633 which means calling the current value of `indent-line-function'.
634 In programming language modes, this is the same as TAB.
635 In some text modes, where TAB inserts a tab, this indents to the
636 column specified by the function `current-left-margin'."
639 ;; Be careful to insert the newline before indenting the line.
640 ;; Otherwise, the indentation might be wrong.
644 ;; We are at EOL before the call to indent-according-to-mode, and
645 ;; after it we usually are as well, but not always. We tried to
646 ;; address it with `save-excursion' but that uses a normal marker
647 ;; whereas we need `move after insertion', so we do the save/restore
648 ;; by hand.
652 ;; Remove the trailing white-space after indentation because
653 ;; indentation may introduce the whitespace.
659 Legitimate radix values are 8, 10 and 16."
664 "Like `read-char', but do not allow quitting.
665 Also, if the first character read is an octal digit,
666 we read any number of octal digits and return the
667 specified character code. Any nondigit terminates the sequence.
668 If the terminator is RET, it is discarded;
669 any other terminator is used itself as input.
671 The optional argument PROMPT specifies a string to use to prompt the user.
672 The variable `read-quoted-char-radix' controls which radix to use
673 for numeric input."
676 help-event-list)))
680 ;; Don't let C-h or other help chars get the help
681 ;; message--only help function keys. See bug#16617.
685 "Type the special character you want to use,
686 or the octal character code.
687 RET terminates the character code and is discarded;
697 done t))
699 ;; Turn a meta-character into a character with the 0200 bit set.
701 done t))
717 done t))
719 done t)))
721 code))
724 "Read next input character and insert it.
725 This is useful for inserting control characters.
726 With argument, insert ARG copies of the character.
728 If the first character you type after this command is an octal digit,
729 you should type a sequence of octal digits which specify a character code.
730 Any nondigit terminates the sequence. If the terminator is a RET,
731 it is discarded; any other terminator is used itself as input.
732 The variable `read-quoted-char-radix' specifies the radix for this feature;
733 set it to 10 or 16 to use decimal or hex instead of octal.
735 In overwrite mode, this function inserts the character anyway, and
736 does not handle octal digits specially. This means that if you use
737 overwrite as your normal editing mode, you can use this function to
738 insert characters when necessary.
740 In binary overwrite mode, this function does overwrite, and octal
741 digits are interpreted as a character code. This is intended to be
742 useful for editing binary files."
745 ;; Avoid "obsolete" warnings for translation-table-for-input.
752 ;; This used to assume character codes 0240 - 0377 stand for
753 ;; characters in some single-byte character set, and converted them
754 ;; to Emacs characters. But in 23.1 this feature is deprecated
755 ;; in favor of inserting the corresponding Unicode characters.
756 ;; (if (and enable-multibyte-characters
757 ;; (>= char ?\240)
758 ;; (<= char ?\377))
759 ;; (setq char (unibyte-char-to-multibyte char)))
771 "Move forward ARG lines and position at first nonblank character."
777 "Move backward ARG lines and position at first nonblank character."
783 "Move point to the first non-whitespace character on this line."
787 ;; Move back over chars that have whitespace syntax but have the p flag.
791 "Fixup white space between objects around point.
792 Leave one space or none, according to the context."
799 nil
803 "Delete all spaces and tabs around point.
804 If BACKWARD-ONLY is non-nil, only delete them before point."
809 orig-pos
818 "Delete all spaces and tabs around point, leaving one space (or N spaces).
819 If N is negative, delete newlines as well, leaving -N spaces.
820 See also `cycle-spacing'."
825 "Store context used in consecutive calls to `cycle-spacing' command.
826 The first time this function is run, it saves the original point
827 position and original spacing around the point in this
831 "Manipulate whitespace around point in a smart way.
832 In interactive use, this function behaves differently in successive
833 consecutive calls.
835 The first call in a sequence acts like `just-one-space'.
836 It deletes all spaces and tabs around point, leaving one space
837 \(or N spaces). N is the prefix argument. If N is negative,
838 it deletes newlines as well, leaving -N spaces.
839 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
841 The second call in a sequence (or the first call if the above does
842 not result in any changes) deletes all spaces.
844 The third call in a sequence restores the original whitespace (and point).
846 If SINGLE-SHOT is non-nil, it only performs the first step in the sequence."
854 ;; Command run for the first time or single-shot is non-nil.
865 ;; Special handling for case where there was no space at all.
868 ;; If this run causes no change in buffer content, delete all spaces,
869 ;; otherwise delete all excess spaces.
874 ;; Command run for the second time.
878 ;; Command run for the third time.
883 \f
885 "Move point to the beginning of the buffer.
886 With numeric arg N, put point N/10 of the way from the beginning.
887 If the buffer is narrowed, this command uses the beginning of the
888 accessible part of the buffer.
890 If Transient Mark mode is disabled, leave mark at previous
893 Don't use this command in Lisp programs!
894 \(goto-char (point-min)) is faster."
903 ;; Avoid overflow for large buffer sizes!
913 "Move point to the end of the buffer.
914 With numeric arg N, put point N/10 of the way from the end.
915 If the buffer is narrowed, this command uses the end of the
916 accessible part of the buffer.
918 If Transient Mark mode is disabled, leave mark at previous
921 Don't use this command in Lisp programs!
922 \(goto-char (point-max)) is faster."
929 ;; Avoid overflow for large buffer sizes!
934 ;; If we went to a place in the middle of the buffer,
935 ;; adjust it to the beginning of a line.
939 ;; If the end of the buffer is not already on the screen,
940 ;; then scroll specially to put it near, but not at, the bottom.
946 "Whether single-char deletion commands delete an active region.
947 This has an effect only if Transient Mark mode is enabled, and
948 affects `delete-forward-char' and `delete-backward-char', though
949 not `delete-char'.
951 If the value is the symbol `kill', the active region is killed
952 instead of deleted."
965 "Function to get the region's content.
966 Called with one argument DELETE.
967 If DELETE is `delete-only', then only delete the region and the return value
968 is undefined. If DELETE is nil, just return the content as a string.
972 "Delete the previous N characters (following if N is negative).
973 If Transient Mark mode is enabled, the mark is active, and N is 1,
974 delete the text in the region and deactivate the mark instead.
975 To disable this, set option `delete-active-region' to nil.
977 Optional second arg KILLFLAG, if non-nil, means to kill (save in
978 kill ring) instead of delete. Interactively, N is the prefix
979 arg, and KILLFLAG is set if N is explicitly specified.
981 In Overwrite mode, single character backward deletion may replace
982 tabs with spaces so as to back over columns, unless point is at
983 the end of the line."
988 delete-active-region
990 ;; If a region is active, kill or delete it.
994 ;; In Overwrite mode, maybe untabify while deleting
1004 ;; Otherwise, do simple deletion.
1009 "Delete the following N characters (previous if N is negative).
1010 If Transient Mark mode is enabled, the mark is active, and N is 1,
1011 delete the text in the region and deactivate the mark instead.
1012 To disable this, set variable `delete-active-region' to nil.
1014 Optional second arg KILLFLAG non-nil means to kill (save in kill
1015 ring) instead of delete. Interactively, N is the prefix arg, and
1016 KILLFLAG is set if N was explicitly specified."
1021 delete-active-region
1023 ;; If a region is active, kill or delete it.
1028 ;; Otherwise, do simple deletion.
1033 "Put point at beginning and mark at end of buffer.
1034 If narrowing is in effect, only uses the accessible part of the buffer.
1035 You probably should not use this function in Lisp programs;
1036 it is usually a mistake for a Lisp function to use any subroutine
1037 that uses or sets the mark."
1042 \f
1044 ;; Counting lines, one way or another.
1047 "Go to LINE, counting from line 1 at beginning of buffer.
1048 If called interactively, a numeric prefix argument specifies
1049 LINE; without a numeric prefix argument, read LINE from the
1050 minibuffer.
1052 If optional argument BUFFER is non-nil, switch to that buffer and
1054 as argument, BUFFER is the most recently selected other buffer.
1056 Prior to moving point, this function sets the mark (without
1057 activating it), unless Transient Mark mode is enabled and the
1058 mark is already active.
1060 This function is usually the wrong thing to use in a Lisp program.
1061 What you probably want instead is something like:
1062 (goto-char (point-min))
1063 (forward-line (1- N))
1064 If at all possible, an even better solution is to use char counts
1065 rather than line counts."
1069 ;; Look for a default, a number in the buffer at point.
1079 ;; Decide if we're switching buffers.
1087 ;; Read the argument, offering that number (if any) as default.
1090 buffer))))
1091 ;; Switch to the desired buffer, one way or another.
1096 ;; Leave mark at previous position
1098 ;; Move to the specified line number in that buffer.
1108 "Count the number of words in the region.
1109 If called interactively, print a message reporting the number of
1110 lines, words, and characters in the region (whether or not the
1111 region is active); with prefix ARG, report for the entire buffer
1112 rather than the region.
1114 If called from Lisp, return the number of words between positions
1115 START and END."
1127 "Count words between START and END.
1128 If called interactively, START and END are normally the start and
1129 end of the buffer; but if the region is active, START and END are
1130 the start and end of the region. Print a message reporting the
1131 number of lines, words, and chars.
1133 If called from Lisp, return the number of words between START and
1134 END, without printing any message."
1144 words))
1160 str
1168 "Print the current buffer line number and narrowed line number of point."
1181 "Return number of lines between START and END.
1182 This is usually the number of newlines between them,
1183 but can be one more if START is not equal to END
1184 and the greater of them is not at the start of a line."
1200 done)))
1204 "Return (narrowed) buffer line number at position POS.
1205 If POS is nil, use current buffer location.
1206 Counting starts at (point-min), so the value refers
1207 to the contents of the accessible portion of the buffer."
1217 "Print info on cursor position (on screen and within buffer).
1218 Also describe the character after point, and give its character code
1219 in octal, decimal and hex.
1221 For a non-ASCII multibyte character, also give its encoding in the
1222 buffer's selected coding system if the coding system encodes the
1223 character safely. If the character is encoded into one byte, that
1224 code is shown in hex. If the character is encoded into more than one
1227 In addition, with prefix argument, show details about that character
1228 in *Help* buffer. See also the command `describe-char'."
1233 ;; If the character is one of LRE, LRO, RLE, RLO, it
1234 ;; will start a directional embedding, which could
1235 ;; completely disrupt the rest of the line (e.g., RLO
1236 ;; will display the rest of the line right-to-left).
1237 ;; So we put an invisible PDF character after these
1238 ;; characters, to end the embedding, which eliminates
1239 ;; any effects on the rest of the line.
1241 ;; Strong right-to-left characters cause reordering of
1242 ;; the following numerical characters which show the
1243 ;; codepoint, so append LRM to countermand that.
1253 ;; Avoid overflow from multiplying by 100!
1257 ""
1263 pos total percent beg end col hscroll)
1265 pos total col hscroll))
1267 encoded encoding-msg display-prop under-display)
1274 ;; Check if the character is displayed with some `display'
1275 ;; text property. In that case, set under-display to the
1276 ;; buffer substring covered by that property.
1287 under-display)))
1293 char char char under-display)
1295 char char char under-display display-prop))
1298 char char char
1300 "..."
1304 ;; We show the detailed information about CHAR.
1311 bidi-fixer
1312 encoding-msg pos total percent beg end col hscroll)
1319 bidi-fixer encoding-msg pos total percent col hscroll))))))
1320 \f
1321 ;; Initialize read-expression-map. It is defined at C level.
1325 ;; Might as well bind TAB to completion, since inserting a TAB char is
1326 ;; much too rarely useful.
1329 m))
1332 "Return a Lisp object read using the minibuffer, unevaluated.
1333 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1334 is a string to insert in the minibuffer before reading.
1335 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1336 Such arguments are used as in `read-from-minibuffer'.)"
1337 ;; Used for interactive spec `x'.
1342 "Return value of Lisp expression read using the minibuffer.
1343 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1344 is a string to insert in the minibuffer before reading.
1345 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1346 Such arguments are used as in `read-from-minibuffer'.)"
1347 ;; Used for interactive spec `X'.
1355 "The current default value or list of default values in the minibuffer.
1356 The functions `read-from-minibuffer' and `completing-read' bind
1360 "Value for `print-level' while printing value in `eval-expression'.
1361 A value of nil means no limit."
1367 "Value for `print-length' while printing value in `eval-expression'.
1368 A value of nil means no limit."
1374 "If non-nil set `debug-on-error' to t in `eval-expression'.
1375 If nil, don't change the value of `debug-on-error'."
1381 "Format VALUE as a result of evaluated expression.
1382 Return a formatted string which is displayed in the echo area
1383 in addition to the value printed by prin1 in functions which
1384 display the result of expression evaluation."
1407 read-expression-map t
1410 ;; We define this, rather than making `eval' interactive,
1411 ;; for the sake of completion of names like eval-region, eval-buffer.
1413 "Evaluate EXP and print value in the echo area.
1414 When called interactively, read an Emacs Lisp expression and evaluate it.
1415 Value is also consed on to front of the variable `values'.
1416 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1417 argument) means insert the result into the current buffer instead of
1418 printing it in the echo area.
1420 Normally, this function truncates long output according to the value
1421 of the variables `eval-expression-print-length' and
1422 `eval-expression-print-level'. With a prefix argument of zero,
1423 however, there is no such truncation. Such a prefix argument
1424 also causes integers to be printed in several additional formats
1425 \(octal, hexadecimal, and character).
1427 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1428 minibuffer.
1430 If `eval-expression-debug-on-error' is non-nil, which is the default,
1431 this command arranges for all errors to enter the debugger."
1434 current-prefix-arg))
1439 ;; Bind debug-on-error to something unique so that we can
1440 ;; detect when evalled code changes it.
1444 ;; If evalled code has changed the value of debug-on-error,
1445 ;; propagate that change to the global binding.
1450 eval-expression-print-length))
1452 eval-expression-print-level))
1468 "Prompting with PROMPT, let user edit COMMAND and eval result.
1469 COMMAND is a Lisp expression. Let user edit that expression in
1470 the minibuffer, then read and evaluate the result."
1477 read-expression-map t
1479 ;; If command was added to command-history as a string,
1480 ;; get rid of that. We want only evaluable expressions there.
1484 ;; If command to be redone does not match front of history,
1485 ;; add it to the history.
1491 "Edit and re-evaluate last complex command, or ARGth from last.
1492 A complex command is one which used the minibuffer.
1493 The command is placed in the minibuffer as a Lisp form for editing.
1494 The result is executed, repeating the command as changed.
1495 If the command has been changed or is not the most recent previous
1496 command it is added to the front of the command history.
1497 You can use the minibuffer history commands \
1499 to get different commands to edit and resubmit."
1502 newcmd)
1514 ;; If command was added to command-history as a
1515 ;; string, get rid of that. We want only
1516 ;; evaluable expressions there.
1520 ;; If command to be redone does not match front of history,
1521 ;; add it to the history.
1526 ;; Trick called-interactively-p into thinking that `newcmd' is
1527 ;; an interactive call (bug#14136).
1546 "Read command name to invoke in `execute-extended-command'."
1551 ;; Get a command name at point in the original buffer
1552 ;; to propose it after M-n.
1556 ;; Read a string, completing from and restricting to the set of
1557 ;; all defined commands. Don't provide any initial input.
1558 ;; Save the command read on the extended-command history list.
1569 ;; This isn't strictly correct if `execute-extended-command'
1570 ;; is bound to anything else (e.g. [menu]).
1571 ;; It could use (key-description (this-single-command-keys)),
1572 ;; but actually a prompt other than "M-x" would be confusing,
1573 ;; because "M-x" is a well-known prompt to read a command
1574 ;; and it serves as a shorthand for "Extended command: ".
1579 "Non-nil means show the equivalent key-binding when M-x command has one.
1580 The value can be a length of time to show the message for.
1581 If the value is non-nil and not a number, we wait 2 seconds."
1588 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1589 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1590 "Read a command name, then read the arguments and call the command.
1591 Interactively, to pass a prefix argument to the command you are
1592 invoking, give a prefix argument to `execute-extended-command'.
1593 Noninteractively, the argument PREFIXARG is the prefix argument to
1594 give to the command you invoke."
1596 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1607 ;; Normally `real-this-command' should never be changed, but here we really
1608 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1609 ;; binding" for <cmd>, so the command the user really wanted to run is
1610 ;; `function' and not `execute-extended-command'. The difference is
1611 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1615 ;; If enabled, show which key runs this command.
1617 ;; But first wait, and skip the message if there is input.
1619 ;; If this command displayed something in the echo area;
1620 ;; wait a few seconds, then display our suggestion message.
1630 suggest-key-bindings
1634 ;; BEWARE: Called directly from the C code.
1635 "Execute CMD as an editor command.
1636 CMD must be a symbol that satisfies the `commandp' predicate.
1637 Optional second arg RECORD-FLAG non-nil
1638 means unconditionally put this command in the variable `command-history'.
1639 Otherwise, that is done only if an arg is read using the minibuffer.
1640 The argument KEYS specifies the value to use instead of (this-command-keys)
1641 when reading the arguments; if it is nil, (this-command-keys) is used.
1642 The argument SPECIAL, if non-nil, means that this command is executing
1643 a special event, so ignore the prefix argument and don't clear it."
1651 disabled-command-function)
1652 ;; FIXME: Weird calling convention!
1662 ;; If requested, place the macro in the command history. For
1663 ;; other sorts of commands, call-interactively takes care of this.
1666 ;; Don't keep command history around forever.
1672 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1680 \f
1682 "Default minibuffer history list.
1683 This is used for all minibuffer input
1684 except when an alternate history list is specified.
1686 Maximum length of the history list is determined by the value
1689 "Control whether history list elements are expressions or strings.
1690 If the value of this variable equals current minibuffer depth,
1691 they are expressions; otherwise they are strings.
1692 \(That convention is designed to do the right thing for
1699 "Text that was in this minibuffer before any history commands.
1700 This is nil if there have not yet been any history commands
1709 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1713 "Minibuffer history variables for which matching should ignore case.
1714 If a history variable is a member of this list, then the
1716 commands ignore case when searching it, regardless of `case-fold-search'."
1721 "Find the previous history element that matches REGEXP.
1722 \(Previous history elements refer to earlier actions.)
1723 With prefix argument N, search for Nth previous match.
1724 If N is negative, find the next or Nth next match.
1725 Normally, history elements are matched case-insensitively if
1726 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1727 makes the search case-sensitive.
1728 See also `minibuffer-history-case-insensitive-variables'."
1732 nil
1733 minibuffer-local-map
1734 nil
1735 'minibuffer-history-search-history
1737 ;; Use the last regexp specified, by default, if input is empty.
1742 regexp)
1752 ;; On some systems, ignore case for file names.
1754 minibuffer-history-case-insensitive-variables)
1755 t
1756 ;; Respect the user's setting for case-fold-search:
1757 case-fold-search)
1758 nil))
1759 prevpos
1760 match-string
1761 match-offset
1768 "No later matching history item"
1789 next-matching-history-element))
1793 "Find the next history element that matches REGEXP.
1794 \(The next history element refers to a more recent action.)
1795 With prefix argument N, search for Nth next match.
1796 If N is negative, find the previous or Nth previous match.
1797 Normally, history elements are matched case-insensitively if
1798 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1799 makes the search case-sensitive."
1803 nil
1804 minibuffer-local-map
1805 nil
1806 'minibuffer-history-search-history
1808 ;; Use the last regexp specified, by default, if input is empty.
1813 regexp)
1820 "Function run by `goto-history-element' before consuming default values.
1821 This is useful to dynamically add more elements to the list of default values
1822 when `goto-history-element' reaches the end of this list.
1823 Before calling this function `goto-history-element' sets the variable
1824 `minibuffer-default-add-done' to t, so it will call this function only
1825 once. In special cases, when this function needs to be called more
1826 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1830 "When nil, add more elements to the end of the list of default values.
1831 The value nil causes `goto-history-element' to add more elements to
1832 the list of defaults when it reaches the end of this list. It does
1838 "Return a list of all completions without the default value.
1839 This function is used to add all elements of the completion table to
1840 the end of the list of defaults just after the default value."
1843 minibuffer-completion-table
1844 minibuffer-completion-predicate)))
1850 "Puts element of the minibuffer history in the minibuffer.
1851 The argument NABS specifies the absolute history position."
1865 elt minibuffer-returned-to-present)
1872 "End of defaults; no next item"
1877 previous-history-element))
1889 minibuffer-default)))
1901 elt))
1905 "Puts next element of the minibuffer history in the minibuffer.
1906 With argument N, it uses the Nth following element."
1912 "Puts previous element of the minibuffer history in the minibuffer.
1913 With argument N, it uses the Nth previous element."
1919 "Get next history element which completes the minibuffer before the point.
1920 The contents of the minibuffer after the point are deleted, and replaced
1921 by the new completion."
1927 n)
1928 ;; next-matching-history-element always puts us at (point-min).
1929 ;; Move to the position we were at before changing the buffer contents.
1930 ;; This is still sensible, because the text before point has not changed.
1934 "\
1935 Get previous history element which completes the minibuffer before the point.
1936 The contents of the minibuffer after the point are deleted, and replaced
1937 by the new completion."
1941 ;; For compatibility with the old subr of the same name.
1943 "Return the display width of the minibuffer prompt.
1944 Return 0 if current buffer is not a minibuffer."
1945 ;; Return the width of everything before the field at the end of
1946 ;; the buffer; this should be 0 for normal buffers.
1948 \f
1949 ;; isearch minibuffer history
1956 "Set up a minibuffer for using isearch to search the minibuffer history.
1957 Intended to be added to `minibuffer-setup-hook'."
1969 "Clean up the minibuffer after terminating isearch in the minibuffer."
1974 "Return the proper search function, for isearch in minibuffer history."
1977 ;; Use standard functions to search within minibuffer text
1979 found)
1980 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1981 ;; searching forward. Lazy-highlight calls this lambda with the
1982 ;; bound arg, so skip the minibuffer prompt.
1986 ;; 1. First try searching in the initial minibuffer text
1989 noerror)
1990 ;; 2. If the above search fails, start putting next/prev history
1991 ;; elements in the minibuffer successively, and search the string
1992 ;; in them. Do this only when bound is nil (i.e. not while
1993 ;; lazy-highlighting search strings in the current minibuffer text).
2005 ;; After putting the next/prev history element, search
2006 ;; the string in them again, until next-history-element
2007 ;; or previous-history-element raises an error at the
2008 ;; beginning/end of history.
2011 ;; For backward search, don't search
2012 ;; in the minibuffer prompt
2014 noerror)))
2015 ;; Return point of the new search result
2017 ;; Return nil when next(prev)-history-element fails
2021 "Display the minibuffer history search prompt.
2022 If there are no search errors, this function displays an overlay with
2023 the isearch prompt which replaces the original minibuffer prompt.
2024 Otherwise, it displays the standard isearch message returned from
2025 the function `isearch-message'."
2027 ;; Use standard function `isearch-message' when not in the minibuffer,
2028 ;; or search fails, or has an error (like incomplete regexp).
2029 ;; This function overwrites minibuffer text with isearch message,
2030 ;; so it's possible to see what is wrong in the search string.
2032 ;; Otherwise, put the overlay with the standard isearch prompt over
2033 ;; the initial minibuffer prompt.
2042 ;; And clear any previous isearch message.
2046 "Wrap the minibuffer history search when search fails.
2047 Move point to the first history element for a forward search,
2048 or to the last history element for a backward search."
2049 ;; When `minibuffer-history-isearch-search' fails on reaching the
2050 ;; beginning/end of the history, wrap the search to the first/last
2051 ;; minibuffer history element.
2059 "Save a function restoring the state of minibuffer history search.
2060 Save `minibuffer-history-position' to the additional state parameter
2061 in the search status stack."
2067 "Restore the minibuffer history search state.
2068 Go to the history element by the absolute history position HIST-POS."
2071 \f
2072 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2076 "Table mapping redo records to the corresponding undo one.
2077 A redo record for undo-in-region maps to t.
2087 "Within a run of consecutive undo commands, list remaining to be undone.
2091 "Undo some previous changes.
2092 Repeat this command to undo more changes.
2093 A numeric ARG serves as a repeat count.
2095 In Transient Mark mode when the mark is active, only undo changes within
2097 as an argument limits undo to changes within the current region."
2099 ;; Make last-command indicate for the next command that this was an undo.
2100 ;; That way, another undo will undo more.
2101 ;; If we get to the end of the undo history and get an error,
2102 ;; another undo command will find the undo history empty
2103 ;; and will get another error. To begin undoing the undos,
2104 ;; you must type some other command.
2106 ;; For an indirect buffer, look in the base buffer for the
2107 ;; auto-save data.
2111 message)
2112 ;; If we get an error in undo-start,
2113 ;; the next command should not be a "consecutive undo".
2114 ;; So set `this-command' to something other than `undo'.
2119 ;; If something (a timer or filter?) changed the buffer
2120 ;; since the previous command, don't continue the undo seq.
2124 ;; If the last undo record made was made by undo
2125 ;; it shows nothing else happened in between.
2132 ;; get rid of initial undo boundary
2134 ;; If we got this far, the next command should be a consecutive undo.
2136 ;; Check to see whether we're hitting a redo record, and if
2137 ;; so, ask the user whether she wants to skip the redo/undo pair.
2145 ;; The equiv entry might point to another redo record if we have done
2146 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2154 ;; Record the fact that the just-generated undo records come from an
2155 ;; undo operation--that is, they are redo records.
2156 ;; In the ordinary case (not within a region), map the redo
2157 ;; record to the following undos.
2158 ;; I don't know how to do that in the undo-in-region case.
2160 ;; Strip any leading undo boundaries there might be, like we do
2161 ;; above when checking.
2165 ;; Prevent identity mapping. This can happen if
2166 ;; consecutive nils are erroneously in undo list.
2168 t
2169 pending-undo-list)
2170 undo-equiv-table))
2171 ;; Don't specify a position in the undo record for the undo command.
2172 ;; Instead, undoing this should move point to where the change is.
2191 ;; Record what the current undo list says,
2192 ;; so the next command can tell if the buffer was modified in between.
2196 ;; Display a message announcing success.
2201 "Make BUFFER stop keeping undo information.
2202 No argument or nil as argument means do this for the current buffer."
2208 "Undo some previous changes.
2209 Repeat this command to undo more changes.
2210 A numeric ARG serves as a repeat count.
2211 Contrary to `undo', this will not redo a previous undo."
2216 "Non-nil while performing an undo.
2220 "Undo back N undo-boundaries beyond what was already undone recently.
2221 Call `undo-start' to get ready to undo recent changes,
2222 then call `undo-more' one or more times to undo them."
2227 ;; Note: The following, while pulling elements off
2228 ;; `pending-undo-list' will call primitive change functions which
2229 ;; will push more elements onto `buffer-undo-list'.
2235 "Undo N records from the front of the list LIST.
2236 Return what remains of the list."
2238 ;; This is a good feature, but would make undo-start
2239 ;; unable to do what is expected.
2240 ;;(when (null (car (list)))
2241 ;; ;; If the head of the list is a boundary, it is the boundary
2242 ;; ;; preceding this command. Get rid of it and don't count it.
2243 ;; (setq list (cdr list))))
2246 ;; In a writable buffer, enable undoing read-only text that is
2247 ;; so because of text properties.
2249 ;; Don't let `intangible' properties interfere with undo.
2251 ;; We use oldlist only to check for EQ. ++kfs
2257 ;; Handle an integer by setting point to that value.
2260 ;; Element (t . TIME) records previous modtime.
2261 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2262 ;; UNKNOWN_MODTIME_NSECS.
2264 ;; If this records an obsolete save
2265 ;; (not matching the actual disk file)
2266 ;; then don't mark unmodified.
2274 ;; Element (nil PROP VAL BEG . END) is property change.
2279 ;; Element (BEG . END) means range was inserted.
2281 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2282 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2285 ;; Set point first thing, so that undoing this undo
2286 ;; does not send point back to where it is now.
2289 ;; Element (apply FUN . ARGS) means call FUN to undo.
2293 ;; Long format: (apply DELTA START END FUN . ARGS).
2300 ;; Check that the function did what the entry
2301 ;; said it would do.
2311 ;; Element (STRING . POS) means STRING was deleted.
2317 ;; Check that marker adjustments which were recorded
2318 ;; with the (STRING . POS) record are still valid, ie
2319 ;; the markers haven't moved. We check their validity
2320 ;; before reinserting the string so as we don't need to
2321 ;; mind marker insertion-type.
2329 ;; Insert string and adjust point
2337 ;; Adjust the valid marker adjustments
2341 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2344 next)
2345 ;; Even though these elements are not expected in the undo
2346 ;; list, adjust them to be conservative for the 24.4
2347 ;; release. (Bug#16818)
2354 ;; Make sure an apply entry produces at least one undo entry,
2355 ;; so the test in `undo' for continuing an undo series
2356 ;; will work right.
2361 list)
2363 ;; Deep copy of a list
2365 "Make a copy of undo list LIST."
2371 elt))
2374 "Set `pending-undo-list' to the front of the undo list.
2375 The next call to `undo-more' will undo the most recently made change.
2376 If BEG and END are specified, then only undo elements
2377 that apply to text between BEG and END are used; other undo elements
2378 are ignored. If BEG and END are nil, all undo elements are used."
2384 buffer-undo-list)))
2387 "Return a list of undo elements for the region START to END.
2388 The elements come from `buffer-undo-list', but we keep only
2389 the elements inside this region, and discard those outside this region.
2390 If we find an element that crosses an edge of this region,
2391 we stop and ignore all further elements."
2394 some-rejected
2395 undo-elt temp-undo-list delta)
2400 ;; This is a "was unmodified" element.
2401 ;; Keep it if we have kept everything thus far.
2403 ;; Skip over marker adjustments, instead relying on
2404 ;; finding them after (TEXT . POS) elements
2406 nil)
2412 ;; Don't put two nils together in the list
2416 ;; If (TEXT . POS), "keep" its subsequent (MARKER
2417 ;; . ADJUSTMENT) whose markers haven't moved.
2437 ;; Loop down the earlier events adjusting their buffer
2438 ;; positions to reflect the fact that a change to the buffer
2439 ;; isn't being undone. We only need to process those element
2440 ;; types which undo-elt-in-region will return as being in
2441 ;; the region since only those types can ever get into the
2442 ;; output
2451 ;; (TEXT . POSITION)
2458 ;; (BEGIN . END)
2463 ;; (nil PROPERTY VALUE BEG . END)
2473 "Determine whether UNDO-ELT falls inside the region START ... END.
2474 If it crosses the edge, we return nil.
2476 Generally this function is not useful for determining
2477 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2478 because markers can be arbitrarily relocated. Instead, pass the
2479 marker adjustment's corresponding (TEXT . POS) element."
2484 t)
2486 nil)
2488 ;; (TEXT . POSITION)
2492 ;; (MARKER . ADJUSTMENT)
2495 ;; (nil PROPERTY VALUE BEG . END)
2500 ;; (BEGIN . END)
2505 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2506 This assumes we have already decided that UNDO-ELT
2507 is not *inside* the region START...END."
2510 ;; (nil PROPERTY VALUE BEG . END)
2515 ;; (BEGIN . END)
2519 ;; Return the first affected buffer position and the delta for an undo element
2520 ;; delta is defined as the change in subsequent buffer positions if we *did*
2521 ;; the undo.
2525 ;; (TEXT . POSITION)
2528 ;; (BEGIN . END)
2535 "If non-nil ask about discarding undo info for the current command.
2536 Normally, Emacs discards the undo info for the current command if
2537 it exceeds `undo-outer-limit'. But if you set this option
2538 non-nil, it asks in the echo area whether to discard the info.
2539 If you answer no, there is a slight risk that Emacs might crash, so
2540 only do it if you really want to undo the command.
2542 This option is mainly intended for debugging. You have to be
2543 careful if you use it for other purposes. Garbage collection is
2544 inhibited while the question is asked, meaning that Emacs might
2545 leak memory. So you should make sure that you do not wait
2546 excessively long before answering the question."
2552 "If non-nil, an extra level of size that's ok in an undo item.
2553 We don't ask the user about truncating the undo list until the
2554 current item gets bigger than this amount.
2559 ;; When the first undo batch in an undo list is longer than
2560 ;; undo-outer-limit, this function gets called to warn the user that
2561 ;; the undo info for the current command was discarded. Garbage
2562 ;; collection is inhibited around the call, so it had better not do a
2563 ;; lot of consing.
2569 ;; Don't ask the question again unless it gets even bigger.
2570 ;; This applies, in particular, if the user quits from the question.
2571 ;; Such a quit quits out of GC, but something else will call GC
2572 ;; again momentarily. It will call this function again,
2573 ;; but we don't want to ask the question again.
2580 t)
2581 nil))
2586 "The undo info was discarded because it exceeded \
2587 `undo-outer-limit'.
2589 This is normal if you executed a command that made a huge change
2590 to the buffer. In that case, to prevent similar problems in the
2591 future, set `undo-outer-limit' to a value that is large enough to
2592 cover the maximum size of normal changes you expect a single
2593 command to make, but not so large that it might exceed the
2594 maximum memory allotted to Emacs.
2596 If you did not execute any such command, the situation is
2597 probably due to a bug and you should report it.
2599 You can disable the popping up of this buffer by adding the entry
2600 \(undo discard-info) to the user option `warning-suppress-types',
2604 t))
2605 \f
2608 ; These are sorted according to the GNU en_US locale.
2651 )
2653 This is used by Shell mode and other parts of Emacs to recognize
2654 password prompts, including prompts in languages other than
2655 English. Different case choices should not be assumed to be
2656 included; callers should bind `case-fold-search' to t."
2662 "History list for some commands that read shell commands.
2664 Maximum length of the history list is determined by the value
2671 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2672 This buffer is used when `shell-command' or `shell-command-on-region'
2673 is run interactively. A value of nil means that output to stderr and
2680 "Return a list of all commands associated with the current file.
2681 This function is used to add all related commands retrieved by `mailcap'
2682 to the end of the list of defaults just after the default value."
2686 minibuffer-default))
2691 commands))
2702 map)
2706 "Read a shell command from the minibuffer.
2707 The arguments are the same as the ones of `read-from-minibuffer',
2708 except READ and KEYMAP are missing and HIST defaults
2709 to `shell-command-history'."
2717 minibuffer-local-shell-command-map
2718 nil
2720 args)))
2723 "What to do when the output buffer is used by another shell command.
2724 This option specifies how to resolve the conflict where a new command
2725 wants to direct its output to the buffer `*Async Shell Command*',
2726 but this buffer is already taken by another running shell command.
2728 The value `confirm-kill-process' is used to ask for confirmation before
2729 killing the already running process and running a new process
2730 in the same buffer, `confirm-new-buffer' for confirmation before running
2731 the command in a new buffer with a name other than the default buffer name,
2732 `new-buffer' for doing the same without confirmation,
2733 `confirm-rename-buffer' for confirmation before renaming the existing
2734 output buffer and running a new command in the default buffer,
2735 `rename-buffer' for doing the same without confirmation."
2737 confirm-kill-process)
2739 confirm-new-buffer)
2741 new-buffer)
2743 confirm-rename-buffer)
2745 rename-buffer))
2750 "Execute string COMMAND asynchronously in background.
2752 Like `shell-command', but adds `&' at the end of COMMAND
2753 to execute it asynchronously.
2755 The output appears in the buffer `*Async Shell Command*'.
2756 That buffer is in shell mode.
2758 You can configure `async-shell-command-buffer' to specify what to do in
2759 case when `*Async Shell Command*' buffer is already taken by another
2760 running shell command. To run COMMAND without displaying the output
2761 in a window you can configure `display-buffer-alist' to use the action
2762 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2764 In Elisp, you will often be better served by calling `start-process'
2765 directly, since it offers more control and does not impose the use of a
2766 shell (with its need to quote arguments)."
2776 current-prefix-arg
2777 shell-command-default-error-buffer))
2783 "Execute string COMMAND in inferior shell; display output, if any.
2784 With prefix argument, insert the COMMAND's output at point.
2786 If COMMAND ends in `&', execute it asynchronously.
2787 The output appears in the buffer `*Async Shell Command*'.
2788 That buffer is in shell mode. You can also use
2789 `async-shell-command' that automatically adds `&'.
2791 Otherwise, COMMAND is executed synchronously. The output appears in
2792 the buffer `*Shell Command Output*'. If the output is short enough to
2793 display in the echo area (which is determined by the variables
2794 `resize-mini-windows' and `max-mini-window-height'), it is shown
2795 there, but it is nonetheless available in buffer `*Shell Command
2796 Output*' even though that buffer is not automatically displayed.
2798 To specify a coding system for converting non-ASCII characters
2800 before this command.
2802 Noninteractive callers can specify coding systems by binding
2803 `coding-system-for-read' and `coding-system-for-write'.
2805 The optional second argument OUTPUT-BUFFER, if non-nil,
2806 says to put the output in some other buffer.
2807 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2808 If OUTPUT-BUFFER is not a buffer and not nil,
2809 insert output in current buffer. (This cannot be done asynchronously.)
2810 In either case, the buffer is first erased, and the output is
2811 inserted after point (leaving mark after it).
2813 If the command terminates without error, but generates output,
2815 the output can be displayed in the echo area or in its buffer.
2816 If the output is short enough to display in the echo area
2817 \(determined by the variable `max-mini-window-height' if
2818 `resize-mini-windows' is non-nil), it is shown there.
2819 Otherwise,the buffer containing the output is displayed.
2823 of the output.
2825 If there is no output, or if output is inserted in the current buffer,
2826 then `*Shell Command Output*' is deleted.
2828 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2829 or buffer name to which to direct the command's standard error output.
2830 If it is nil, error output is mingled with regular output.
2831 In an interactive call, the variable `shell-command-default-error-buffer'
2832 specifies the value of ERROR-BUFFER.
2834 In Elisp, you will often be better served by calling `call-process' or
2835 `start-process' directly, since it offers more control and does not impose
2836 the use of a shell (with its need to quote arguments)."
2847 current-prefix-arg
2848 shell-command-default-error-buffer))
2849 ;; Look for a handler in case default-directory is a remote file name.
2857 ;; Output goes in current buffer.
2863 temporary-file-directory)))
2864 nil)))
2867 ;; We do not use -f for csh; we will not support broken use of
2868 ;; .cshrcs. Even the BSD csh manual says to use
2869 ;; "if ($?prompt) exit" before things which are not useful
2870 ;; non-interactively. Besides, if someone wants their other
2871 ;; aliases for shell commands then they can still have them.
2875 t)
2876 nil shell-command-switch command)
2883 ;; Do no formatting while reading error file,
2884 ;; because that can run a shell command, and we
2885 ;; don't want that to cause an infinite recursion.
2887 ;; Put point after the inserted errors.
2891 ;; This is like exchange-point-and-mark, but doesn't
2892 ;; activate the mark. It is cleaner to avoid activation,
2893 ;; even though the command loop would deactivate the mark
2894 ;; because we inserted text.
2898 ;; Output goes in a separate buffer.
2899 ;; Preserve the match data in case called from a program.
2902 ;; Command ending with ampersand means asynchronous.
2906 proc)
2907 ;; Remove the ampersand.
2909 ;; Ask the user what to do with already running process.
2914 ;; If will kill a process, query first.
2919 ;; If will create a new buffer, query first.
2925 ;; It will create a new buffer.
2929 ;; If will rename the buffer, query first.
2938 ;; It will rename the buffer.
2945 ;; Setting buffer-read-only to nil doesn't suffice
2946 ;; if some text has a non-nil read-only property,
2947 ;; which comint sometimes adds for prompts.
2953 shell-command-switch command))
2957 ;; Use the comint filter for proper handling of carriage motion
2958 ;; (see `comint-inhibit-carriage-motion'),.
2960 ))
2961 ;; Otherwise, command is executed synchronously.
2963 output-buffer nil error-buffer)))))))
2967 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2968 MESSAGE may be either a string or a buffer.
2970 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2971 the maximum height of the echo area, as defined by `max-mini-window-height'
2972 if `resize-mini-windows' is non-nil.
2974 Returns either the string shown in the echo area, or when a pop-up
2975 buffer is used, the window used to display it.
2977 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2978 name of the buffer used to display it in the case where a pop-up buffer
2979 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2980 string and it is displayed in the echo area, it is not specified whether
2981 the contents are inserted into the buffer anyway.
2983 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2984 and only used if a buffer is displayed."
2986 ;; Trivial case where we can use the echo area
2990 ;; Trivial case where we can just remove single trailing newline
2993 ;; General case
2996 message
3005 0
3009 (<= lines
3013 max-mini-window-height))
3015 max-mini-window-height)
3019 ;; Don't use the echo area if the output buffer is
3020 ;; already displayed in the selected frame.
3022 ;; Echo area
3028 ;; Buffer
3031 not-this-window frame))))))))
3034 ;; We have a sentinel to prevent insertion of a termination message
3035 ;; in the buffer itself.
3043 &optional output-buffer replace
3044 error-buffer display-error-buffer)
3045 "Execute string COMMAND in inferior shell with region as input.
3046 Normally display output (if any) in temp buffer `*Shell Command Output*';
3047 Prefix arg means replace the region with it. Return the exit code of
3048 COMMAND.
3050 To specify a coding system for converting non-ASCII characters
3052 before this command. By default, the input (from the current buffer)
3053 is encoded using coding-system specified by `process-coding-system-alist',
3054 falling back to `default-process-coding-system' if no match for COMMAND
3055 is found in `process-coding-system-alist'.
3057 Noninteractive callers can specify coding systems by binding
3058 `coding-system-for-read' and `coding-system-for-write'.
3060 If the command generates output, the output may be displayed
3061 in the echo area or in a buffer.
3062 If the output is short enough to display in the echo area
3063 \(determined by the variable `max-mini-window-height' if
3064 `resize-mini-windows' is non-nil), it is shown there.
3065 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3066 The output is available in that buffer in both cases.
3068 If there is output and an error, a message about the error
3069 appears at the end of the output. If there is no output, or if
3070 output is inserted in the current buffer, the buffer `*Shell
3071 Command Output*' is deleted.
3073 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3074 command's output. If the value is a buffer or buffer name,
3075 put the output there. If the value is nil, use the buffer
3076 `*Shell Command Output*'. Any other value, excluding nil,
3077 means to insert the output in the current buffer. In either case,
3078 the output is inserted after point (leaving mark after it).
3080 Optional fifth arg REPLACE, if non-nil, means to insert the
3081 output in place of text from START to END, putting point and mark
3082 around it.
3084 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3085 or buffer name to which to direct the command's standard error
3086 output. If nil, error output is mingled with regular output.
3087 When called interactively, `shell-command-default-error-buffer'
3088 is used for ERROR-BUFFER.
3090 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3091 display the error buffer if there were any errors. When called
3092 interactively, this is t."
3096 ;; Do this before calling region-beginning
3097 ;; and region-end, in case subprocess output
3098 ;; relocates them while we are in the minibuffer.
3100 ;; call-interactively recognizes region-beginning and
3101 ;; region-end specially, leaving them in the history.
3103 string
3104 current-prefix-arg
3105 current-prefix-arg
3106 shell-command-default-error-buffer
3107 t)))
3113 temporary-file-directory)))
3114 nil))
3115 exit-status)
3119 ;; Replace specified region with output from command.
3121 ;; Don't muck with mark unless REPLACE says we should.
3128 t)
3129 nil shell-command-switch command))
3130 ;; It is rude to delete a buffer which the command is not using.
3131 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3132 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3133 ;; (kill-buffer shell-buffer)))
3134 ;; Don't muck with mark unless REPLACE says we should.
3136 ;; No prefix argument: put the output in a temp buffer,
3137 ;; replacing its entire contents.
3142 ;; If the input is the same buffer as the output,
3143 ;; delete everything but the specified region,
3144 ;; then replace that region with the output.
3150 shell-file-name t
3153 t)
3154 nil shell-command-switch
3155 command)))
3156 ;; Clear the output buffer, then run the command with
3157 ;; output there.
3168 buffer)
3169 nil shell-command-switch command)))
3170 ;; Report the output.
3180 ;; There's some output, display it
3182 ;; No output; error?
3189 shell-command-default-error-buffer)
3196 output))
3199 exit-status))
3202 exit-status output))))
3203 ;; Don't kill: there might be useful info in the undo-log.
3204 ;; (kill-buffer buffer)
3205 ))))
3213 ;; Do no formatting while reading error file,
3214 ;; because that can run a shell command, and we
3215 ;; don't want that to cause an infinite recursion.
3217 ;; Put point after the inserted errors.
3222 exit-status))
3225 "Execute shell command COMMAND and return its output as a string."
3228 standard-output
3232 "Process files synchronously in a separate process.
3233 Similar to `call-process', but may invoke a file handler based on
3234 `default-directory'. The current working directory of the
3235 subprocess is `default-directory'.
3237 File names in INFILE and BUFFER are handled normally, but file
3238 names in ARGS should be relative to `default-directory', as they
3239 are passed to the process verbatim. (This is a difference to
3240 `call-process' which does not support file handlers for INFILE
3241 and BUFFER.)
3243 Some file handlers might not support all variants, for example
3244 they might behave as if DISPLAY was nil, regardless of the actual
3245 value passed."
3247 lc stderr-file)
3257 display args)
3263 "Whether a call of `process-file' changes remote files.
3265 By default, this variable is always set to `t', meaning that a
3266 call of `process-file' could potentially change any file on a
3267 remote host. When set to `nil', a file handler could optimize
3268 its behavior with respect to remote file attribute caching.
3270 You should only ever change this variable with a let-binding;
3274 "Start a program in a subprocess. Return the process object for it.
3276 Similar to `start-process', but may invoke a file handler based on
3277 `default-directory'. See Info node `(elisp)Magic File Names'.
3279 This handler ought to run PROGRAM, perhaps on the local host,
3280 perhaps on a remote host that corresponds to `default-directory'.
3281 In the latter case, the local part of `default-directory' becomes
3282 the working directory of the process.
3284 PROGRAM and PROGRAM-ARGS might be file names. They are not
3285 objects of file handler invocation. File handlers might not
3286 support pty association, if PROGRAM is nil."
3290 \f
3291 ;;;; Process menu
3303 "Major mode for listing the processes called by Emacs."
3315 "Recompute the list of processes for the Process List buffer.
3316 Also, delete any process that is exited or signaled."
3329 face link
3332 follow-link t
3333 process-buffer ,buf
3334 action process-menu-visit-buffer)
3343 "datagram"
3360 tabulated-list-entries))))))
3366 "Display a list of all processes that are Emacs sub-processes.
3367 If optional argument QUERY-ONLY is non-nil, only processes with
3368 the query-on-exit flag set are listed.
3369 Any process listed as exited or signaled is actually eliminated
3370 after the listing is made.
3371 Optional argument BUFFER specifies a buffer to use, instead of
3373 The return value is always nil.
3375 This function lists only processes that were launched by Emacs. To
3376 see other processes running on the system, use `list-system-processes'."
3388 nil)
3389 \f
3393 ;; For backward compatibility, minus with no modifiers is an ordinary
3394 ;; command if digits have already been entered.
3424 map)
3431 "Begin a numeric argument for the following command.
3436 multiplies the argument by 4 each time.
3438 which is different in effect from any particular numeric argument.
3445 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3446 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3452 arg)))
3456 "Begin a negative numeric argument for the next command.
3465 "Part of the numeric argument for the next command.
3469 last-command-event
3476 ;; Treat -0 as just -, so that -01 will work.
3479 digit))))
3481 \f
3489 "Function to perform the filtering in `filter-buffer-substring'.
3490 The function is called with the same 3 arguments (BEG END DELETE)
3491 that `filter-buffer-substring' received. It should return the
3492 buffer substring between BEG and END, after filtering. If DELETE is
3496 "List of filter functions for `buffer-substring--filter'.
3497 Each function must accept a single argument, a string, and return a string.
3498 The buffer substring is passed to the first function in the list,
3499 and the return value of each function is passed to the next.
3500 As a special convention, point is set to the start of the buffer text
3501 being operated on (i.e., the first argument of `buffer-substring--filter')
3507 "Return the buffer substring between BEG and END, after filtering.
3508 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3510 This calls the function that `filter-buffer-substring-function' specifies
3511 \(passing the same three arguments that it received) to do the work,
3512 and returns whatever it does. The default function does no filtering,
3513 unless a hook has been set.
3515 Use `filter-buffer-substring' instead of `buffer-substring',
3516 `buffer-substring-no-properties', or `delete-and-extract-region' when
3517 you want to allow filtering to take place. For example, major or minor
3518 modes can use `filter-buffer-substring-function' to extract characters
3519 that are special to a buffer, and should not be copied into other buffers."
3523 "Default function to use for `filter-buffer-substring-function'.
3524 Its arguments and return value are as specified for `filter-buffer-substring'.
3525 This respects the wrapper hook `filter-buffer-substring-functions',
3526 and the abnormal hook `buffer-substring-filters'.
3527 No filtering is done unless a hook says to."
3537 string)))
3542 ;;;; Window system cut and paste hooks.
3545 "Function to call to make a killed region available to other programs.
3546 Most window systems provide a facility for cutting and pasting
3547 text between different programs, such as the clipboard on X and
3548 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3550 This variable holds a function that Emacs calls whenever text is
3551 put in the kill ring, to make the new kill available to other
3552 programs. The function takes one argument, TEXT, which is a
3556 "Function to call to get text cut from other programs.
3557 Most window systems provide a facility for cutting and pasting
3558 text between different programs, such as the clipboard on X and
3559 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3561 This variable holds a function that Emacs calls to obtain text
3562 that other programs have provided for pasting. The function is
3563 called with no arguments. If no other program has provided text
3564 to paste, the function should return nil (in which case the
3565 caller, usually `current-kill', should use the top of the Emacs
3566 kill ring). If another program has provided text to paste, the
3567 function should return that text as a string (in which case the
3568 caller should put this string in the kill ring as the latest
3569 kill).
3571 The function may also return a list of strings if the window
3572 system supports multiple selections. The first string will be
3573 used as the pasted text, but the other will be placed in the kill
3574 ring for easy access via `yank-pop'.
3576 Note that the function should return a string only if a program
3577 other than Emacs has provided a string for pasting; if Emacs
3578 provided the most recent string, the function should return nil.
3579 If it is difficult to tell whether Emacs or some other program
3580 provided the current string, it is probably good enough to return
3581 nil if the string is equal (according to `string=') to the last
3583 \f
3586 ;;;; The kill ring data structure.
3589 "List of killed text sequences.
3590 Since the kill ring is supposed to interact nicely with cut-and-paste
3591 facilities offered by window systems, use of this variable should
3592 interact nicely with `interprogram-cut-function' and
3593 `interprogram-paste-function'. The functions `kill-new',
3594 `kill-append', and `current-kill' are supposed to implement this
3595 interaction; you may want to use them instead of manipulating the kill
3599 "Maximum length of kill ring before oldest elements are thrown away."
3607 "Save clipboard strings into kill ring before replacing them.
3608 When one selects something in another program to paste it into Emacs,
3609 but kills something in Emacs before actually pasting it,
3610 this selection is gone unless this variable is non-nil,
3611 in which case the other program's selection is saved in the `kill-ring'
3618 "Do not add a new string to `kill-ring' if it duplicates the last one.
3619 The comparison is done using `equal-including-properties'."
3625 "Make STRING the latest kill in the kill ring.
3626 Set `kill-ring-yank-pointer' to point to it.
3627 If `interprogram-cut-function' is non-nil, apply it to STRING.
3628 Optional second argument REPLACE non-nil means that STRING will replace
3629 the front of the kill ring, rather than being added to the list.
3631 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3632 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3633 STRING.
3635 When the yank handler has a non-nil PARAM element, the original STRING
3636 argument is not used by `insert-for-yank'. However, since Lisp code
3637 may access and use elements from the kill ring directly, the STRING
3640 ;; Due to text properties such as 'yank-handler that
3641 ;; can alter the contents to yank, comparison using
3642 ;; `equal' is unsafe.
3668 "Append STRING to the end of the latest kill in the kill ring.
3669 If BEFORE-P is non-nil, prepend STRING to the kill.
3670 If `interprogram-cut-function' is set, pass the resulting kill to it."
3677 "Whether rotating the kill ring changes the window system selection.
3678 If non-nil, whenever the kill ring is rotated (usually via the
3679 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3680 to copy the new kill to the window system selection."
3686 "Rotate the yanking point by N places, and then return that kill.
3687 If N is zero and `interprogram-paste-function' is set to a
3688 function that returns a string or a list of strings, and if that
3689 function doesn't return nil, then that string (or list) is added
3690 to the front of the kill ring and the string (or first string in
3691 the list) is returned as the latest kill.
3693 If N is not zero, and if `yank-pop-change-selection' is
3694 non-nil, use `interprogram-cut-function' to transfer the
3695 kill at the new yank point into the window system selection.
3697 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3698 move the yanking point; just return the Nth kill forward."
3701 interprogram-paste-function
3705 ;; Disable the interprogram cut function when we add the new
3706 ;; text to the kill ring, so Emacs doesn't try to own the
3707 ;; selection, with identical text.
3717 kill-ring)))
3722 interprogram-cut-function)
3728 ;;;; Commands for manipulating the kill ring.
3731 "Non-nil means don't signal an error for killing read-only text."
3737 This deletes the text from the buffer and saves it in the kill ring.
3741 If you want to append the killed region to the last killed text,
3744 If the buffer is read-only, Emacs will beep and refrain from deleting
3745 the text, but put the text in the kill ring anyway. This means that
3746 you can use the killing commands to copy text from a read-only buffer.
3748 Lisp programs should use this function for killing text.
3749 (To delete text, use `delete-region'.)
3750 Supply two arguments, character positions indicating the stretch of text
3751 to be killed.
3753 If the previous command was also a kill command,
3754 the text killed this time appends to the text killed last time
3755 to make one entry in the kill ring.
3757 The optional argument REGION if non-nil, indicates that we're not just killing
3758 some text between BEG and END, but we're killing the region."
3759 ;; Pass mark first, then point, because the order matters when
3760 ;; calling `kill-append'.
3769 ;; Add that string to the kill ring, one way or another.
3776 nil)
3778 ;; The code above failed because the buffer, or some of the characters
3779 ;; in the region, are read-only.
3780 ;; We should beep, in case the user just isn't aware of this.
3781 ;; However, there's no harm in putting
3782 ;; the region's text in the kill ring, anyway.
3784 ;; Set this-command now, so it will be set even if we get an error.
3786 ;; This should barf, if appropriate, and give us the correct error.
3789 ;; Signal an error if the buffer is read-only.
3791 ;; If the buffer isn't read-only, the text is.
3794 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3795 ;; to get two copies of the text when the user accidentally types M-w and
3796 ;; then corrects it with the intended C-w.
3798 "Save the region as if killed, but don't kill it.
3799 In Transient Mark mode, deactivate the mark.
3800 If `interprogram-cut-function' is non-nil, also save the text for a window
3801 system cut and paste.
3803 The optional argument REGION if non-nil, indicates that we're not just copying
3804 some text between BEG and END, but we're copying the region.
3806 This command's old key binding has been given to `kill-ring-save'."
3807 ;; Pass mark first, then point, because the order matters when
3808 ;; calling `kill-append'.
3818 nil)
3821 "Save the region as if killed, but don't kill it.
3822 In Transient Mark mode, deactivate the mark.
3823 If `interprogram-cut-function' is non-nil, also save the text for a window
3824 system cut and paste.
3826 If you want to append the killed line to the last killed text,
3829 The optional argument REGION if non-nil, indicates that we're not just copying
3830 some text between BEG and END, but we're copying the region.
3832 This command is similar to `copy-region-as-kill', except that it gives
3833 visual feedback indicating the extent of the region being copied."
3834 ;; Pass mark first, then point, because the order matters when
3835 ;; calling `kill-append'.
3839 ;; This use of called-interactively-p is correct because the code it
3840 ;; controls just gives the user visual feedback.
3845 "Indicate that the region text has been copied interactively.
3846 If the mark is visible in the selected window, blink the cursor
3847 between point and mark if there is currently no active region
3848 highlighting.
3850 If the mark lies outside the selected window, display an
3851 informative message containing a sample of the copied text. The
3852 optional argument MESSAGE-LEN, if non-nil, specifies the length
3853 of this sample text; it defaults to 40."
3856 ;; Inhibit quitting so we can make a quit here
3857 ;; look like a C-g typed as a command.
3860 ;; Swap point-and-mark quickly so as to show the region that
3861 ;; was selected. Don't do it if the region is highlighted.
3864 ;; Swap point and mark.
3868 ;; Swap back.
3871 ;; If user quit, deactivate the mark
3872 ;; as C-g would as a command.
3878 ;; Don't say "killed"; that is misleading.
3885 "Cause following command, if it kills, to add to previous kill.
3886 If the next command kills forward from point, the kill is
3887 appended to the previous killed text. If the command kills
3888 backward, the kill is prepended. Kill commands that act on the
3889 region, such as `kill-region', are regarded as killing forward if
3890 point is after mark, and killing backward if point is before
3891 mark.
3893 If the next command is not a kill command, `append-next-kill' has
3894 no effect.
3896 The argument is used for internal purposes; do not supply one."
3898 ;; We don't use (interactive-p), since that breaks kbd macros.
3904 \f
3905 ;; Yanking.
3910 "List of special text property handling conditions for yanking.
3911 Each element should have the form (PROP . FUN), where PROP is a
3912 property symbol and FUN is a function. When the `yank' command
3913 inserts text into the buffer, it scans the inserted text for
3914 stretches of text that have `eq' values of the text property
3915 PROP; for each such stretch of text, FUN is called with three
3916 arguments: the property's value in that text, and the start and
3917 end positions of the text.
3919 This is done prior to removing the properties specified by
3920 `yank-excluded-properties'."
3923 function))
3926 ;; This is actually used in subr.el but defcustom does not work there.
3929 intangible invisible keymap local-map mouse-face read-only
3930 yank-handler)
3931 "Text properties to discard when yanking.
3932 The value should be a list of text properties to discard or t,
3933 which means to discard all text properties.
3935 See also `yank-handled-properties'."
3942 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3943 Function is called with two parameters, START and END corresponding to
3944 the value of the mark and point; it is guaranteed that START <= END.
3948 "Replace just-yanked stretch of killed text with a different stretch.
3949 This command is allowed only immediately after a `yank' or a `yank-pop'.
3950 At such a time, the region contains a stretch of reinserted
3951 previously-killed text. `yank-pop' deletes that text and inserts in its
3952 place a different stretch of killed text.
3954 With no argument, the previous kill is inserted.
3955 With argument N, insert the Nth previous kill.
3956 If N is negative, this is a more recent kill.
3958 The sequence of kills wraps around, so that after the oldest one
3959 comes the newest one.
3961 When this command inserts killed text into the buffer, it honors
3962 `yank-excluded-properties' and `yank-handler' as described in the
3963 doc string for `insert-for-yank-1', which see."
3977 ;; Set the window start back where it was in the yank command,
3978 ;; if possible.
3981 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3982 ;; It is cleaner to avoid activation, even though the command
3983 ;; loop would deactivate the mark because we inserted text.
3986 nil)
3990 More precisely, reinsert the most recent kill, which is the
3991 stretch of killed text most recently killed OR yanked. Put point
3992 at the end, and set mark at the beginning without activating it.
3994 With argument N, reinsert the Nth most recent kill.
3996 When this command inserts text into the buffer, it honors the
3997 `yank-handled-properties' and `yank-excluded-properties'
3998 variables, and the `yank-handler' text property. See
3999 `insert-for-yank-1' for details.
4004 ;; If we don't get all the way thru, make last-command indicate that
4005 ;; for the following command.
4013 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4014 ;; It is cleaner to avoid activation, even though the command
4015 ;; loop would deactivate the mark because we inserted text.
4018 ;; If we do get all the way thru, make this-command indicate that.
4021 nil)
4024 "Rotate the yanking point in the kill ring.
4025 With ARG, rotate that many kills forward (or backward, if negative)."
4028 \f
4029 ;; Some kill commands.
4031 ;; Internal subroutine of delete-char
4037 ;; Internal subroutine of backward-delete-char
4044 "The method for untabifying when deleting backward.
4045 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4046 `hungry' -- delete all whitespace, both tabs and spaces;
4047 `all' -- delete all whitespace, including tabs, spaces and newlines;
4048 nil -- just delete one character."
4054 "Delete characters backward, changing tabs into spaces.
4055 The exact behavior depends on `backward-delete-char-untabify-method'.
4056 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4057 Interactively, ARG is the prefix arg (default 1)
4058 and KILLP is t if a prefix arg was specified."
4081 arg)))
4082 ;; Avoid warning about delete-backward-char
4086 "Kill up to and including ARGth occurrence of CHAR.
4087 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4088 Goes backward if ARG is negative; error if CHAR not found."
4091 ;; Avoid "obsolete" warnings for translation-table-for-input.
4099 ;; kill-line and its subroutines.
4102 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4107 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4108 With prefix argument ARG, kill that many lines from point.
4109 Negative arguments kill lines backward.
4110 With zero argument, kills the text before point on the current line.
4113 a number counts as a prefix arg.
4115 To kill a whole line, when point is not at the beginning, type \
4118 If `show-trailing-whitespace' is non-nil, this command will just
4119 kill the rest of the current line, even if there are only
4120 nonblanks there.
4122 If option `kill-whole-line' is non-nil, then this command kills the whole line
4123 including its terminating newline, when used at the beginning of a line
4124 with no argument. As a consequence, you can always kill a whole line
4127 If you want to append the killed line to the last killed text,
4130 If the buffer is read-only, Emacs will beep and refrain from deleting
4131 the line, but put the line in the kill ring anyway. This means that
4132 you can use this command to copy text from a read-only buffer.
4133 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4134 even beep.)"
4137 ;; It is better to move point to the other end of the kill
4138 ;; before killing. That way, in a read-only buffer, point
4139 ;; moves across the text that is copied to the kill ring.
4140 ;; The choice has no effect on undo now that undo records
4141 ;; the value of point from before the command was run.
4151 ;; If trailing whitespace is visible,
4152 ;; don't treat it as nothing.
4162 "Kill current line.
4163 With prefix ARG, kill that many lines starting from the current line.
4164 If ARG is negative, kill backward. Also kill the preceding newline.
4166 If ARG is zero, kill current line but exclude the trailing newline."
4177 ;; We need to kill in two steps, because the previous command
4178 ;; could have been a kill command, in which case the text
4179 ;; before point needs to be prepended to the current kill
4180 ;; ring entry and the text after point appended. Also, we
4181 ;; need to use save-excursion to avoid copying the same text
4182 ;; twice to the kill ring in read-only buffers.
4200 "Move forward by ARG lines, ignoring currently invisible newlines only.
4201 If ARG is negative, move backward -ARG lines.
4202 If ARG is zero, move to the beginning of the current line."
4209 ;; If the newline we just skipped is invisible,
4210 ;; don't count it.
4214 prop
4219 ;; If invisible text follows, and it is a number of complete lines,
4220 ;; skip it.
4226 prop
4242 ;; If the newline we just moved to is invisible,
4243 ;; don't count it.
4248 prop
4253 ;; If invisible text follows, and it is a number of complete lines,
4254 ;; skip it.
4260 prop
4271 nil)))
4274 "Move to end of current visible line."
4276 ;; If the following character is currently invisible,
4277 ;; skip all characters with that same `invisible' property value,
4278 ;; then find the next newline.
4285 prop
4294 \f
4296 "Insert after point the contents of BUFFER.
4297 Puts mark after the inserted text.
4298 BUFFER may be a buffer or a buffer name.
4300 This function is meant for the user to run interactively.
4301 Don't call it from programs: use `insert-buffer-substring' instead!"
4310 t))))
4315 nil)
4319 "Append to specified buffer the text of the region.
4320 It is inserted into that buffer before its point.
4322 When calling from a program, give three arguments:
4323 BUFFER (or buffer name), START and END.
4324 START and END specify the portion of the current buffer to be copied."
4331 point)
4342 "Prepend to specified buffer the text of the region.
4343 It is inserted into that buffer after its point.
4345 When calling from a program, give three arguments:
4346 BUFFER (or buffer name), START and END.
4347 START and END specify the portion of the current buffer to be copied."
4356 "Copy to specified buffer the text of the region.
4357 It is inserted into that buffer, replacing existing text there.
4359 When calling from a program, give three arguments:
4360 BUFFER (or buffer name), START and END.
4361 START and END specify the portion of the current buffer to be copied."
4369 \f
4373 "Hook run when the mark becomes active.
4374 It is also run at the end of a command, if the mark is active and
4381 "Return this buffer's mark value as integer, or nil if never set.
4383 In Transient Mark mode, this function signals an error if
4384 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4385 or the argument FORCE is non-nil, it disregards whether the mark
4386 is active, and returns an integer or nil in the usual way.
4388 If you are using this in an editing command, you are most likely making
4389 a mistake; see the documentation of `set-mark'."
4394 ;; Behind display-selections-p.
4401 "Deactivate the mark.
4402 If Transient Mark mode is disabled, this function normally does
4403 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4405 Deactivating the mark sets `mark-active' to nil, updates the
4406 primary selection according to `select-active-regions', and runs
4407 `deactivate-mark-hook'.
4409 If Transient Mark mode was temporarily enabled, reset the value
4410 of the variable `transient-mark-mode'; if this causes Transient
4411 Mark mode to be disabled, don't change `mark-active' to nil or
4412 run `deactivate-mark-hook'."
4416 select-active-regions)
4419 ;; The var `saved-region-selection', if non-nil, is the text in
4420 ;; the region prior to the last command modifying the buffer.
4421 ;; Set the selection to that, or to the current region.
4426 ;; If another program has acquired the selection, region
4427 ;; deactivation should not clobber it (Bug#11772).
4444 "Activate the mark.
4445 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4455 "Set this buffer's mark to POS. Don't use this function!
4456 That is to say, don't use this function unless you want
4457 the user to see that the mark has moved, and you want the previous
4458 mark position to be lost.
4460 Normally, when a new mark is set, the old one should go on the stack.
4461 This is why most applications should use `push-mark', not `set-mark'.
4463 Novice Emacs Lisp programmers often try to use the mark for the wrong
4464 purposes. The mark saves a location for the user's convenience.
4465 Most editing commands should not alter the mark.
4466 To remember a location for internal use in the Lisp program,
4467 store it in a Lisp variable. Example:
4469 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4474 ;; Normally we never clear mark-active except in Transient Mark mode.
4475 ;; But when we actually clear out the mark value too, we must
4476 ;; clear mark-active in any mode.
4478 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4479 ;; it should never be nil if the mark is nil.
4485 If nil, region-aware commands treat empty regions as inactive.
4486 If non-nil, region-aware commands treat the region as active as
4487 long as the mark is active, even if the region is empty.
4489 Region-aware commands are those that act on the region if it is
4490 active and Transient Mark mode is enabled, and on the text near
4491 point otherwise."
4497 "Return t if the region is active and it is appropriate to act on it.
4498 This is used by commands that act specially on the region under
4499 Transient Mark mode.
4501 The return value is t if Transient Mark mode is enabled and the
4502 mark is active; furthermore, if `use-empty-active-region' is nil,
4503 the region must not be empty. Otherwise, the return value is nil.
4505 For some commands, it may be appropriate to ignore the value of
4506 `use-empty-active-region'; in that case, use `region-active-p'."
4511 "Return t if Transient Mark mode is enabled and the mark is active.
4513 Some commands act specially on the region when Transient Mark
4514 mode is enabled. Usually, such commands should use
4515 `use-region-p' instead of this function, because `use-region-p'
4516 also checks the value of `use-empty-active-region'."
4518 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4519 ;; without the mark being set (e.g. bug#17324). We really should fix
4520 ;; that problem, but in the mean time, let's make sure we don't say the
4521 ;; region is active when there's no mark.
4535 ;; Normal priority so that a large region doesn't hide all the
4536 ;; overlays within it, but high secondary priority so that if it
4537 ;; ends/starts in the middle of a small overlay, that small overlay
4538 ;; won't hide the region's boundaries.
4540 nrol)
4545 rol)))
4558 start end window rol)))
4561 new)))))))
4586 "Maximum size of mark ring. Start discarding off end if gets this big."
4594 "Maximum size of global mark ring. \
4595 Start discarding off end if gets this big."
4600 "Jump to mark, and pop a new position for mark off the ring.
4601 \(Does not affect global mark ring)."
4611 "Set mark at where point is.
4612 If no prefix ARG and mark is already set there, just activate it.
4613 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4625 will pop the mark twice, and
4627 will pop the mark three times.
4635 "Set the mark where point is, or jump to the mark.
4636 Setting the mark also alters the region, which is the text
4637 between point and mark; this is the closest equivalent in
4640 With no prefix argument, set the mark at point, and push the
4641 old mark position on local mark ring. Also push the old mark on
4642 global mark ring, if the previous mark was set in another buffer.
4644 When Transient Mark Mode is off, immediately repeating this
4645 command activates `transient-mark-mode' temporarily.
4648 jump to the mark, and set the mark from
4649 position popped off the local mark ring (this does not affect the global
4651 mark ring (see `pop-global-mark').
4653 If `set-mark-command-repeat-pop' is non-nil, repeating
4655 off the local (or global) mark ring and jumps there.
4658 argument, unconditionally set mark where point is, even if
4659 `set-mark-command-repeat-pop' is non-nil.
4661 Novice Emacs Lisp programmers often try to use the mark for the wrong
4662 purposes. See the documentation of `set-mark' for more information."
4698 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4699 If the last global mark pushed was not in the current buffer,
4700 also push LOCATION on the global mark ring.
4701 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4703 Novice Emacs Lisp programmers often try to use the mark for the wrong
4704 purposes. See the documentation of `set-mark' for more information.
4706 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4713 ;; Now push the mark on the global mark ring.
4716 ;; The last global mark pushed was in this same buffer.
4717 ;; Don't push another one.
4718 nil
4727 nil)
4730 "Pop off mark ring into the buffer's actual mark.
4731 Does not set point. Does nothing if mark ring is empty."
4743 "Put the mark where point is now, and point where the mark is now.
4744 This command works even when the mark is not active,
4745 and it reactivates the mark.
4747 If Transient Mark mode is on, a prefix ARG deactivates the mark
4748 if it is active, and otherwise avoids reactivating it. If
4749 Transient Mark mode is off, a prefix ARG enables Transient Mark
4750 mode temporarily."
4764 nil))
4767 "When non-nil, shifted motion keys activate the mark momentarily.
4769 While the mark is activated in this way, any shift-translated point
4770 motion key extends the region, and if Transient Mark mode was off, it
4771 is temporarily turned on. Furthermore, the mark will be deactivated
4772 by any subsequent point motion key that was not shift-translated, or
4773 by any action that normally deactivates the mark in Transient Mark mode.
4775 See `this-command-keys-shift-translated' for the meaning of
4776 shift-translation."
4781 "Activate/deactivate mark depending on invocation thru shift translation.
4782 This function is called by `call-interactively' when a command
4783 with a `^' character in its `interactive' spec is invoked, before
4784 running the command itself.
4786 If `shift-select-mode' is enabled and the command was invoked
4787 through shift translation, set the mark and activate the region
4788 temporarily, unless it was already set in this way. See
4789 `this-command-keys-shift-translated' for the meaning of shift
4790 translation.
4792 Otherwise, if the region has been activated temporarily,
4793 deactivate it, and restore the variable `transient-mark-mode' to
4794 its earlier value."
4801 transient-mark-mode)))
4808 "Toggle Transient Mark mode.
4809 With a prefix argument ARG, enable Transient Mark mode if ARG is
4810 positive, and disable it otherwise. If called from Lisp, enable
4811 Transient Mark mode if ARG is omitted or nil.
4813 Transient Mark mode is a global minor mode. When enabled, the
4814 region is highlighted with the `region' face whenever the mark
4816 and after certain other operations that set the mark but whose
4817 main purpose is something else--for example, incremental search,
4823 Many commands change their behavior when Transient Mark mode is
4824 in effect and the mark is active, by acting on the region instead
4825 of their usual default part of the buffer's text. Examples of
4828 To see the documentation of commands which are sensitive to the
4831 :global t
4832 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4836 "Non-nil means it is ok for commands to call `widen' when they want to.
4837 Some commands will do this in order to go to positions outside
4838 the current accessible part of the buffer.
4840 If `widen-automatically' is nil, these commands will do something else
4844 "Whether the currently executing code is performing an essential task.
4845 This variable should be non-nil only when running code which should not
4846 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4847 user for a password when we are simply scanning a set of files in the
4848 background or displaying possible completions before the user even asked
4852 "Pop off global mark ring and jump to the top location."
4854 ;; Pop entries which refer to non-existent buffers.
4872 \f
4874 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4880 "Move cursor vertically down ARG lines.
4881 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4882 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4883 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4884 function will not vscroll.
4886 ARG defaults to 1.
4888 If there is no character in the target line exactly under the current column,
4889 the cursor is positioned after the character in that line which spans this
4890 column, or at the end of the line if it is not long enough.
4891 If there is no line in the buffer after this one, behavior depends on the
4892 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4893 to create a line, and moves the cursor to that line. Otherwise it moves the
4894 cursor to the end of the buffer.
4896 If the variable `line-move-visual' is non-nil, this command moves
4897 by display lines. Otherwise, it moves by buffer lines, without
4898 taking variable-width characters or continued lines into account.
4901 a semipermanent goal column for this command.
4902 Then instead of trying to move exactly vertically (or as close as possible),
4903 this command moves to the specified goal column (or as close as possible).
4904 The goal column is stored in the variable `goal-column', which is nil
4905 when there is no goal column. Note that setting `goal-column'
4906 overrides `line-move-visual' and causes this command to move by buffer
4907 lines rather than by display lines.
4909 If you are thinking of using this in a Lisp program, consider
4910 using `forward-line' instead. It is usually easier to use
4911 and more reliable (no dependence on goal column, etc.)."
4916 ;; When adding a newline, don't expand an abbrev.
4927 nil)
4931 "Move cursor vertically up ARG lines.
4932 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4933 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4934 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4935 function will not vscroll.
4937 ARG defaults to 1.
4939 If there is no character in the target line exactly over the current column,
4940 the cursor is positioned after the character in that line which spans this
4941 column, or at the end of the line if it is not long enough.
4943 If the variable `line-move-visual' is non-nil, this command moves
4944 by display lines. Otherwise, it moves by buffer lines, without
4945 taking variable-width characters or continued lines into account.
4948 a semipermanent goal column for this command.
4949 Then instead of trying to move exactly vertically (or as close as possible),
4950 this command moves to the specified goal column (or as close as possible).
4951 The goal column is stored in the variable `goal-column', which is nil
4952 when there is no goal column. Note that setting `goal-column'
4953 overrides `line-move-visual' and causes this command to move by buffer
4954 lines rather than by display lines.
4956 If you are thinking of using this in a Lisp program, consider using
4957 `forward-line' with a negative argument instead. It is usually easier
4958 to use and more reliable (no dependence on goal column, etc.)."
4967 nil)
4972 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4973 This means moving to the end of each line moved onto.
4974 The beginning of a blank line does not count as the end of a line.
4975 This has no effect when the variable `line-move-visual' is non-nil."
4981 A non-nil setting overrides the variable `line-move-visual', which see."
4988 "Current goal column for vertical motion.
4989 It is the column where point was at the start of the current run
4990 of vertical motion commands.
4992 When moving by visual lines via the function `line-move-visual', it is a cons
4993 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4994 divided by the default column width, and HSCROLL is the number of
4995 columns by which window is scrolled from left margin.
4997 When the `track-eol' feature is doing its job, the value is
5001 "Non-nil means commands that move by lines ignore invisible newlines.
5002 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5003 as if newlines that are invisible didn't exist, and count
5004 only visible newlines. Thus, moving across across 2 newlines
5005 one of which is invisible will be counted as a one-line move.
5006 Also, a non-nil value causes invisible text to be ignored when
5007 counting columns for the purposes of keeping point in the same
5010 Outline mode sets this."
5015 "When non-nil, `line-move' moves point by visual lines.
5016 This movement is based on where the cursor is displayed on the
5017 screen, instead of relying on buffer contents alone. It takes
5018 into account variable-width characters and line continuation.
5019 If nil, `line-move' moves point by logical lines.
5020 A non-nil setting of `goal-column' overrides the value of this variable
5021 and forces movement by logical lines.
5022 A window that is horizontally scrolled also forces movement by logical
5023 lines."
5028 ;; Only used if display-graphic-p.
5032 "Return the height in pixels of the current buffer's default face font."
5036 ;; Avoid calling font-info if the frame's default font was
5037 ;; not changed since the frame was created. That's because
5038 ;; font-info is expensive for some fonts, see bug #14838.
5044 "Return the pixel height of current buffer's default-face text line.
5046 The value includes `line-spacing', if any, defined for the buffer
5047 or the frame."
5060 "Return the number of screen lines in the text area of the selected window.
5062 This is different from `window-text-height' in that this function counts
5063 lines in units of the height of the font used by the default face displayed
5064 in the window, not in units of the frame's default font, and also accounts
5065 for `line-spacing', if any, defined for the window's buffer or frame.
5067 The value is a floating-point number."
5072 ;; Returns non-nil if partial move was done.
5075 ;; Move backward (up).
5076 ;; If already vscrolled, reduce vscroll
5082 ;; Move forward (down).
5095 py vs last-line)
5115 col-row)
5120 ;; VPOS > 0 means the last line is only partially visible.
5121 ;; But if the part that is visible is at least as tall as the
5122 ;; default font, that means the line is actually fully
5123 ;; readable, and something like line-spacing is hidden. So in
5124 ;; that case we accept the last line in the window as still
5125 ;; visible, and consider the margin as starting one line
5126 ;; later.
5134 ;; If last line of window is fully visible, and vscrolling
5135 ;; more would make this line invisible, move forward.
5140 nil)
5141 ;; If cursor is not in the bottom scroll margin, and the
5142 ;; current line is is not too tall, move forward.
5144 vpos
5147 nil)
5148 ;; When already vscrolled, we vscroll some more if we can,
5149 ;; or clear vscroll and move forward at end of tall image.
5154 ;; If cursor just entered the bottom scroll margin, move forward,
5155 ;; but also optionally vscroll one line so redisplay won't recenter.
5159 ;; Don't vscroll if the partially-visible line at window
5160 ;; bottom is not too tall (a.k.a. "just one more text
5161 ;; line"): in that case, we do want redisplay to behave
5162 ;; normally, i.e. recenter or whatever.
5163 ;;
5164 ;; Note: ROWH + RBOT from the value returned by
5165 ;; pos-visible-in-window-p give the total height of the
5166 ;; partially-visible glyph row at the end of the window. As
5167 ;; we are dealing with floats, we disregard sub-pixel
5168 ;; discrepancies between that and DLH.
5172 t)
5173 ;; If there are lines above the last line, scroll-up one line.
5176 t)
5177 ;; Finally, start vscroll.
5182 ;; This is like line-move-1 except that it also performs
5183 ;; vertical scrolling of tall images if appropriate.
5184 ;; That is not really a clean thing to do, since it mixes
5185 ;; scrolling with cursor motion. But so far we don't have
5186 ;; a cleaner solution to the problem of making C-n do something
5187 ;; useful given a tall image.
5189 "Move forward ARG lines.
5190 If NOERROR, don't signal an error if we can't move ARG lines.
5191 TO-END is unused.
5192 TRY-VSCROLL controls whether to vscroll tall lines: if either
5193 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5194 not vscroll."
5198 ;; Only vscroll for single line moves
5200 ;; Under scroll-conservatively, the display engine
5201 ;; does this better.
5203 ;; But don't vscroll in a keyboard macro.
5209 ;; Display-based column are incompatible with goal-column.
5211 ;; When the text in the window is scrolled to the left,
5212 ;; display-based motion doesn't make sense (because each
5213 ;; logical line occupies exactly one screen line).
5215 ;; Likewise when the text _was_ scrolled to the left
5216 ;; when the current run of vertical motion commands
5217 ;; started.
5220 auto-hscroll-mode
5222 (>= temporary-goal-column
5225 ;; If we moved into a tall line, set vscroll to make
5226 ;; scrolling through tall images more smooth.
5230 winh)
5236 nil
5240 ;; Display-based alternative to line-move-1.
5241 ;; Arg says how many lines to move. The value is t if we can move the
5242 ;; specified number of lines.
5244 "Move ARG lines forward.
5245 If NOERROR, don't signal an error if we can't move that many lines."
5248 target-hscroll)
5249 ;; Check if the previous command was a line-motion command, or if
5250 ;; we were called from some other command.
5253 ;; If so, there's no need to reset `temporary-goal-column',
5254 ;; but we may need to hscroll.
5258 ;; Otherwise, we should reset `temporary-goal-column'.
5260 x-pos)
5262 ;; Handle the `overflow-newline-into-fringe' case:
5267 ;; In R2L lines, the X pixel coordinate is measured from the
5268 ;; left edge of the window, but columns are still counted
5269 ;; from the logical-order beginning of the line, i.e. from
5270 ;; the right edge in this case. We need to adjust for that.
5276 hscroll))))))
5279 ;; vertical-motion can move more than it was asked to if it moves
5280 ;; across display strings with newlines. We don't want to ring
5281 ;; the bell and announce beginning/end of buffer in that case.
5287 temporary-goal-column))
5288 arg))
5289 arg))
5295 temporary-goal-column))
5296 arg))
5297 arg)))
5300 ;; If the goal column lies on a display string,
5301 ;; `vertical-motion' advances the cursor to the end
5302 ;; of the string. For arg < 0, this can cause the
5303 ;; cursor to get stuck. (Bug#3020).
5307 nil)))))
5309 ;; This is the guts of next-line and previous-line.
5310 ;; Arg says how many lines to move.
5311 ;; The value is t if we can move the specified number of lines.
5313 ;; Don't run any point-motion hooks, and disregard intangibility,
5314 ;; for intermediate positions.
5326 ;; Don't count beg of empty line as end of line
5327 ;; unless we just did explicit end-of-line.
5329 most-positive-fixnum
5333 line-move-ignore-invisible))
5334 ;; Use just newline characters.
5335 ;; Set ARG to 0 if we move as many lines as requested.
5338 ;; This way of moving forward ARG lines
5339 ;; verifies that we have a newline after the last one.
5340 ;; It doesn't get confused by intangible text.
5349 'beginning-of-buffer
5351 nil)))
5352 ;; Move by arg lines, but ignore invisible ones.
5355 ;; If the following character is currently invisible,
5356 ;; skip all characters with that same `invisible' property value.
5359 ;; Move a line.
5360 ;; We don't use `end-of-line', since we want to escape
5361 ;; from field boundaries occurring exactly at point.
5367 ;; If there's no invisibility here, move over the newline.
5376 ;; We avoid vertical-motion when possible
5377 ;; because that has to fontify.
5379 ;; Otherwise move a more sophisticated way.
5386 ;; The logic of this is the same as the loop above,
5387 ;; it just goes in the other direction.
5389 ;; For completely consistency with the forward-motion
5390 ;; case, we should call beginning-of-line here.
5391 ;; However, if point is inside a field and on a
5392 ;; continued line, the call to (vertical-motion -1)
5393 ;; below won't move us back far enough; then we return
5394 ;; to the same column in line-move-finish, and point
5395 ;; gets stuck -- cyd
5413 ;; if our target is the middle of this line.
5418 ;; This is the value the function returns.
5422 ;; If we did not move down as far as desired, at least go
5423 ;; to end of line. Be sure to call point-entered and
5424 ;; point-left-hooks.
5430 ;; If we did not move up as far as desired,
5431 ;; at least go to beginning of line.
5443 ;; Set REPEAT to t to repeat the whole thing.
5450 ;; Compute the end of the line
5451 ;; ignoring effectively invisible newlines.
5453 ;; Like end-of-line but ignores fields.
5460 ;; Move to the desired column.
5463 ;; Corner case: suppose we start out in a field boundary in
5464 ;; the middle of a continued line. When we get to
5465 ;; line-move-finish, point is at the start of a new *screen*
5466 ;; line but the same text line; then line-move-to-column would
5467 ;; move us backwards. Test using C-n with point on the "x" in
5468 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5475 ;; Process intangibility within a line.
5476 ;; With inhibit-point-motion-hooks bound to nil, a call to
5477 ;; goto-char moves point past intangible text.
5479 ;; However, inhibit-point-motion-hooks controls both the
5480 ;; intangibility and the point-entered/point-left hooks. The
5481 ;; following hack avoids calling the point-* hooks
5482 ;; unnecessarily. Note that we move *forward* past intangible
5483 ;; text when the initial and final points are the same.
5488 ;; If intangibility moves us to a different (later) place
5489 ;; in the same line, use that as the destination.
5492 ;; If that position is "too late",
5493 ;; try the previous allowable position.
5494 ;; See if it is ok.
5497 ;; If going forward, don't accept the previous
5498 ;; allowable position if it is before the target line.
5500 ;; If going backward, don't accept the previous
5501 ;; allowable position if it is still after the target line.
5504 ;; As a last resort, use the end of the line.
5507 ;; Now move to the updated destination, processing fields
5508 ;; as well as intangibility.
5512 ;; Ignore field boundaries if the initial and final
5513 ;; positions have the same `field' property, even if the
5514 ;; fields are non-contiguous. This seems to be "nicer"
5515 ;; behavior in many situations.
5518 new
5522 ;; If all this moved us to a different line,
5523 ;; retry everything within that new line.
5525 ;; Repeat the intangibility and field processing.
5529 "Try to find column COL, considering invisibility.
5530 This function works only in certain cases,
5531 because what we really need is for `move-to-column'
5532 and `current-column' to be able to ignore invisible text."
5541 ;; If the following character is currently invisible,
5542 ;; skip all characters with that same `invisible' property value.
5546 ;; Have we advanced to a larger column position?
5548 ;; We have made some progress towards the desired column.
5549 ;; See if we can make any further progress.
5551 ;; Otherwise, go to the place we originally found
5552 ;; and move back over invisible text.
5553 ;; that will get us to the same place on the screen
5554 ;; but with a more reasonable buffer position.
5561 "Move point to end of current line as displayed.
5562 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5563 If point reaches the beginning or end of buffer, it stops there.
5565 To ignore the effects of the `intangible' text or overlay
5566 property, bind `inhibit-point-motion-hooks' to t.
5567 If there is an image in the current line, this function
5568 disregards newlines that are part of the text on which the image
5569 rests."
5579 ;; With bidi reordering, we may not be at bol,
5580 ;; so make sure we are.
5595 ;; If we skipped something intangible and now we're not
5596 ;; really at eol, keep going.
5601 "Move point to beginning of current line as displayed.
5602 \(If there's an image in the line, this disregards newlines
5603 which are part of the text that the image rests on.)
5605 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5606 If point reaches the beginning or end of buffer, it stops there.
5607 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5612 first-vis first-vis-field-value)
5614 ;; Move by lines, if ARG is not 1 (the default).
5619 ;; Move to beginning-of-line, ignoring fields and invisible text.
5625 ;; Now find first visible char in the line.
5630 ;; See if fields would stop us from reaching FIRST-VIS.
5635 ;; If yes, obey them.
5636 first-vis-field-value
5637 ;; Otherwise, move to START with attention to fields.
5638 ;; (It is possible that fields never matter in this case.)
5643 ;; Many people have said they rarely use this feature, and often type
5644 ;; it by accident. Maybe it shouldn't even be on a key.
5649 Those commands will move to this position in the line moved to
5650 rather than trying to keep the same horizontal position.
5651 With a non-nil argument ARG, clears out the goal column
5653 The goal column is stored in the variable `goal-column'."
5660 ;; The older method below can be erroneous if `set-goal-column' is bound
5661 ;; to a sequence containing %
5662 ;;(message (substitute-command-keys
5663 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5664 ;;goal-column)
5671 )
5672 nil)
5673 \f
5674 ;;; Editing based on visual lines, as opposed to logical lines.
5677 "Move point to end of current visual line.
5678 With argument N not nil or 1, move forward N - 1 visual lines first.
5679 If point reaches the beginning or end of buffer, it stops there.
5680 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5686 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5687 ;; constrain to field boundaries, so we don't either.
5691 "Move point to beginning of current visual line.
5692 With argument N not nil or 1, move forward N - 1 visual lines first.
5693 If point reaches the beginning or end of buffer, it stops there.
5694 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5702 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5706 "Kill the rest of the visual line.
5707 With prefix argument ARG, kill that many visual lines from point.
5708 If ARG is negative, kill visual lines backward.
5709 If ARG is zero, kill the text before point on the current visual
5710 line.
5712 If you want to append the killed line to the last killed text,
5715 If the buffer is read-only, Emacs will beep and refrain from deleting
5716 the line, but put the line in the kill ring anyway. This means that
5717 you can use this command to copy text from a read-only buffer.
5718 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5719 even beep.)"
5721 ;; Like in `kill-line', it's better to move point to the other end
5722 ;; of the kill before killing.
5730 ;; Skip any trailing whitespace at the end of the visual line.
5731 ;; We used to do this only if `show-trailing-whitespace' is
5732 ;; nil, but that's wrong; the correct thing would be to check
5733 ;; whether the trailing whitespace is highlighted. But, it's
5734 ;; OK to just do this unconditionally.
5741 "Move cursor vertically down ARG lines.
5742 This is identical to `next-line', except that it always moves
5743 by logical lines instead of visual lines, ignoring the value of
5744 the variable `line-move-visual'."
5751 "Move cursor vertically up ARG lines.
5752 This is identical to `previous-line', except that it always moves
5753 by logical lines instead of visual lines, ignoring the value of
5754 the variable `line-move-visual'."
5761 "Editing based on visual lines."
5770 ;; These keybindings interfere with xterm function keys. Are
5771 ;; there any other suitable bindings?
5772 ;; (define-key map "\M-[" 'previous-logical-line)
5773 ;; (define-key map "\M-]" 'next-logical-line)
5774 map))
5777 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5778 The value should be a list of the form (LEFT RIGHT), where LEFT
5779 and RIGHT are symbols representing the bitmaps to display, to
5780 indicate wrapped lines, in the left and right fringes respectively.
5781 See also `fringe-indicator-alist'.
5782 The default is not to display fringe indicators for wrapped lines.
5783 This variable does not affect fringe indicators displayed for
5784 other purposes."
5799 'continuation
5806 "Toggle visual line based editing (Visual Line mode).
5807 With a prefix argument ARG, enable Visual Line mode if ARG is
5808 positive, and disable it otherwise. If called from Lisp, enable
5809 the mode if ARG is omitted or nil.
5811 When Visual Line mode is enabled, `word-wrap' is turned on in
5812 this buffer, and simple editing commands are redefined to act on
5813 visual lines, not logical lines. See Info node `Visual Line
5814 Mode' for details."
5815 :keymap visual-line-mode-map
5821 ;; Save the local values of some variables, to be restored if
5822 ;; visual-line-mode is turned off.
5824 truncate-partial-width-windows
5825 word-wrap fringe-indicator-alist))
5828 visual-line--saved-state)))
5832 word-wrap t
5833 fringe-indicator-alist
5835 fringe-indicator-alist)))
5849 visual-line-mode turn-on-visual-line-mode)
5851 \f
5853 "Interchange characters around point, moving forward one character.
5854 With prefix arg ARG, effect is to take character before point
5855 and drag it forward past ARG other characters (backward if ARG negative).
5856 If no argument and at end of line, the previous two chars are exchanged."
5862 "Interchange words around point, leaving point at end of them.
5863 With prefix arg ARG, effect is to take word before or around point
5864 and drag it forward past ARG other words (backward if ARG negative).
5865 If ARG is zero, the words around or after point and around or after mark
5866 are interchanged."
5867 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5873 Does not work on a sexp that point is in the middle of
5874 if it is a list or string."
5878 ;; Here we should try to simulate the behavior of
5879 ;; (cons (progn (forward-sexp x) (point))
5880 ;; (progn (forward-sexp (- x)) (point)))
5881 ;; Except that we don't want to rely on the second forward-sexp
5882 ;; putting us back to where we want to be, since forward-sexp-function
5883 ;; might do funny things like infix-precedence.
5888 ;; Jumping over a symbol. We might be inside it, mind you.
5893 ;; Otherwise, we're between sexps. Take a step back before jumping
5894 ;; to make sure we'll obey the same precedence no matter which direction
5895 ;; we're going.
5900 'skip-syntax-forward
5907 "Exchange current line and previous line, leaving point after both.
5908 With argument ARG, takes previous line and moves it past ARG lines.
5909 With argument 0, interchanges line point is in with line mark is in."
5915 ;; Move forward over ARG lines,
5916 ;; but create newlines if necessary.
5923 arg))
5925 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5926 ;; which seems inconsistent with the ARG /= 0 case.
5927 ;; FIXME document SPECIAL.
5929 "Subroutine to do the work of transposing objects.
5930 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5931 moves forward by units of the given object (e.g. forward-sentence,
5932 forward-paragraph). If ARG is zero, exchanges the current object
5933 with the one containing mark. If ARG is an integer, moves the
5934 current object past ARG following (if ARG is positive) or
5935 preceding (if ARG is negative) objects, leaving point after the
5936 current object."
5941 pos1 pos2)
5969 ;; This sequence of insertions attempts to preserve marker
5970 ;; positions at the start and end of the transposed objects.
5984 \f
5986 "Move backward until encountering the beginning of a word.
5987 With argument ARG, do this that many times.
5988 If ARG is omitted or nil, move point backward one word."
5993 "Set mark ARG words away from point.
5995 move to with the same argument.
5996 Interactively, if this command is repeated
5997 or (in Transient Mark mode) if the mark is active,
5998 it marks the next ARG words after the ones already marked."
6015 nil t))))
6018 "Kill characters forward until encountering the end of a word.
6019 With argument ARG, do this that many times."
6024 "Kill characters backward until encountering the beginning of a word.
6025 With argument ARG, do this that many times."
6030 "Return the symbol or word that point is on (or a nearby one) as a string.
6031 The return value includes no text properties.
6032 If optional arg STRICT is non-nil, return nil unless point is within
6033 or adjacent to a symbol or word. In all cases the value can be nil
6034 if there is no word nearby.
6035 The function, belying its name, normally finds a symbol.
6036 If optional arg REALLY-WORD is non-nil, it finds just a word."
6045 ;; Point is neither within nor adjacent to a word.
6047 ;; Look for preceding word in same line.
6050 ;; No preceding word in same line.
6051 ;; Look for following word in same line.
6060 ;; If we found something nonempty, return it as a string.
6063 \f
6065 "String for filling to insert at front of new line, or nil for none."
6067 string)
6073 "Regexp to match lines which should not be auto-filled."
6075 regexp)
6079 "The default value for `normal-auto-fill-function'.
6080 This is the default auto-fill function, some major modes use a different one.
6081 Returns t if it really did any work."
6091 nil ;; Auto-filling not required
6095 ;; Choose a fill-prefix automatically.
6103 ;; Use auto-indentation rather than a guessed empty prefix.
6109 ;; Determine where to split the line.
6122 ;; See whether the place we found is any good.
6126 ;; There is no use breaking at end of line.
6128 ;; It is futile to split at the end of the prefix
6129 ;; since we would just insert the prefix again.
6131 ;; Don't split right after a comment starter
6132 ;; since we would just make another comment starter.
6137 limit t)
6139 ;; No good place to break => stop trying.
6141 ;; Ok, we have a useful place to break the line. Do it.
6143 ;; If point is at the fill-point, do not `save-excursion'.
6144 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6145 ;; point will end up before it rather than after it.
6153 ;; Now do justification, if required
6158 ;; If making the new line didn't reduce the hpos of
6159 ;; the end of the line, then give up now;
6160 ;; trying again will not help.
6163 ;; Justify last line.
6165 t)))
6168 "Mode-specific function which line breaks and continues a comment.
6169 This function is called during auto-filling when a comment syntax
6170 is defined.
6171 The function should take a single optional argument, which is a flag
6175 "Break line at point and indent.
6176 If a comment syntax is defined, call `comment-indent-new-line'.
6178 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6179 unless optional argument SOFT is non-nil."
6183 ;; Insert the newline before removing empty space so that markers
6184 ;; get preserved better.
6190 ;; Blindly trust a non-adaptive fill-prefix.
6196 ;; If there's an adaptive prefix, use it unless we're inside
6197 ;; a comment and the prefix is not a comment starter.
6201 ;; If we're not inside a comment, just try to indent.
6205 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6209 ;; `functions' and `hooks' are usually unsafe to set, but setting
6210 ;; auto-fill-function to nil in a file-local setting is safe and
6211 ;; can be useful to prevent auto-filling.
6215 "Toggle automatic line breaking (Auto Fill mode).
6216 With a prefix argument ARG, enable Auto Fill mode if ARG is
6217 positive, and disable it otherwise. If called from Lisp, enable
6218 the mode if ARG is omitted or nil.
6220 When Auto Fill mode is enabled, inserting a space at a column
6221 beyond `current-fill-column' automatically breaks the line at a
6222 previous space.
6224 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6225 non-`nil'.
6227 The value of `normal-auto-fill-function' specifies the function to use
6228 for `auto-fill-function' when turning Auto Fill mode on."
6233 ;; This holds a document string used to document auto-fill-mode.
6235 "Automatically break line at a previous space, in insertion of text."
6236 nil)
6239 "Unconditionally turn on Auto Fill mode."
6243 "Unconditionally turn off Auto Fill mode."
6249 "Set `fill-column' to specified argument.
6254 ;; We used to use current-column silently, but C-x f is too easily
6255 ;; typed as a typo for C-x C-f, so we turned it into an error and
6256 ;; now an interactive prompt.
6261 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6265 \f
6267 "Set `selective-display' to ARG; clear it if no arg.
6268 When the value of `selective-display' is a number > 0,
6269 lines whose indentation is >= that value are not displayed.
6270 The variable `selective-display' has a separate value for each buffer."
6290 "Toggle truncating of long lines for the current buffer.
6291 When truncating is off, long lines are folded.
6292 With prefix argument ARG, truncate long lines if ARG is positive,
6293 otherwise fold them. Note that in side-by-side windows, this
6294 command has no effect if `truncate-partial-width-windows' is
6295 non-nil."
6307 nil t)))
6312 "Toggle whether to use word-wrapping for continuation lines.
6313 With prefix argument ARG, wrap continuation lines at word boundaries
6314 if ARG is positive, otherwise wrap them at the right screen edge.
6315 This command toggles the value of `word-wrap'. It has no effect
6316 if long lines are truncated."
6332 "Toggle Overwrite mode.
6333 With a prefix argument ARG, enable Overwrite mode if ARG is
6334 positive, and disable it otherwise. If called from Lisp, enable
6335 the mode if ARG is omitted or nil.
6337 When Overwrite mode is enabled, printing characters typed in
6338 replace existing text on a one-for-one basis, rather than pushing
6339 it to the right. At the end of a line, such characters extend
6340 the line. Before a tab, such characters insert until the tab is
6342 overwrite mode; this is supposed to make it easier to insert
6343 characters when necessary."
6348 "Toggle Binary Overwrite mode.
6349 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6350 is positive, and disable it otherwise. If called from Lisp,
6351 enable the mode if ARG is omitted or nil.
6353 When Binary Overwrite mode is enabled, printing characters typed
6354 in replace existing text. Newlines are not treated specially, so
6355 typing at the end of a line joins the line to the next, with the
6356 typed character between them. Typing before a tab character
6357 simply replaces the tab with the character typed.
6359 ordinary typing characters do.
6361 Note that Binary Overwrite mode is not its own minor mode; it is
6362 a specialization of overwrite mode, entered by setting the
6363 `overwrite-mode' variable to `overwrite-mode-binary'."
6368 "Toggle line number display in the mode line (Line Number mode).
6369 With a prefix argument ARG, enable Line Number mode if ARG is
6370 positive, and disable it otherwise. If called from Lisp, enable
6371 the mode if ARG is omitted or nil.
6373 Line numbers do not appear for very large buffers and buffers
6374 with very long lines; see variables `line-number-display-limit'
6375 and `line-number-display-limit-width'."
6379 "Toggle column number display in the mode line (Column Number mode).
6380 With a prefix argument ARG, enable Column Number mode if ARG is
6381 positive, and disable it otherwise.
6383 If called from Lisp, enable the mode if ARG is omitted or nil."
6387 "Toggle buffer size display in the mode line (Size Indication mode).
6388 With a prefix argument ARG, enable Size Indication mode if ARG is
6389 positive, and disable it otherwise.
6391 If called from Lisp, enable the mode if ARG is omitted or nil."
6395 "Toggle auto-saving in the current buffer (Auto Save mode).
6396 With a prefix argument ARG, enable Auto Save mode if ARG is
6397 positive, and disable it otherwise.
6399 If called from Lisp, enable the mode if ARG is omitted or nil."
6401 ;; If auto-save is off because buffer has shrunk,
6402 ;; then toggling should turn it on.
6410 buffer-file-name)
6412 ;; If -1 was stored here, to temporarily turn off saving,
6413 ;; turn it back on.
6416 \f
6418 "Blinking matching of parens and expressions."
6423 "Non-nil means show matching open-paren when close-paren is inserted.
6424 If t, highlight the paren. If `jump', move cursor to its position."
6432 "Non-nil means show matching open-paren when it is on screen.
6433 If nil, don't show it (but the open-paren can still be shown
6434 when it is off screen).
6436 This variable has no effect if `blink-matching-paren' is nil.
6437 \(In that case, the open-paren is never shown.)
6438 It is also ignored if `show-paren-mode' is enabled."
6443 "If non-nil, maximum distance to search backwards for matching open-paren.
6444 If nil, search stops at the beginning of the accessible portion of the buffer."
6450 "Time in seconds to delay after showing a matching paren."
6455 "If nil, `blink-matching-paren' ignores comments.
6456 More precisely, when looking for the matching parenthesis,
6457 it skips the contents of comments that end before point."
6462 "Return whether or not START...END are matching parens.
6463 END is the current point and START is the blink position.
6464 START might be nil if no matching starter was found.
6465 Returns non-nil if we find there is a mismatch."
6470 ;; For self-matched chars like " and $, we can't know when they're
6471 ;; mismatched or unmatched, so we can only do it for parens.
6476 ;; The cdr might hold a new paren-class info rather than
6477 ;; a matching-char info, in which case the two CDRs
6478 ;; should match.
6482 "Function to check parentheses mismatches.
6483 The function takes two arguments (START and END) where START is the
6484 position just before the opening token and END is the position right after.
6485 START can be nil, if it was not found.
6492 ol)
6496 "Momentarily highlight the beginning of the sexp before point."
6499 blink-matching-paren)
6509 oldpos))
6516 ;; backward-sexp skips backward over prefix chars,
6517 ;; so move back to the matching paren.
6538 ;; Matching open within window, temporarily move to or highlight
6539 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6540 ;; is non-nil.
6557 ;; Show what precedes the open in its line, if anything.
6562 ;; Show what follows the open in its line, if anything.
6569 ;; Otherwise show the previous nonblank line,
6570 ;; if there is one.
6579 ;; Replace the newline and other whitespace with `...'.
6580 "..."
6582 ;; There is nothing to show except the char itself.
6588 "Function called, if non-nil, whenever a close parenthesis is inserted.
6594 blink-paren-function
6597 ;; Verify an even number of quoting characters precede the close.
6608 ;; Most likely, this hook is nil, so this arg doesn't matter,
6609 ;; but I use it as a reminder that this function usually
6610 ;; likes to be run after others since it does
6611 ;; `sit-for'. That's also the reason it get a `priority' prop
6612 ;; of 100.
6614 \f
6615 ;; This executes C-g typed while Emacs is waiting for a command.
6616 ;; Quitting out of a program does not go through here;
6617 ;; that happens in the QUIT macro at the C code level.
6619 "Signal a `quit' condition.
6620 During execution of Lisp code, this character causes a quit directly.
6621 At top-level, as an editor command, this simply beeps."
6623 ;; Avoid adding the region to the window selection.
6629 ;; Force the next redisplay cycle to remove the "Def" indicator from
6630 ;; all the mode lines.
6644 This command can exit an interactive command such as `query-replace',
6645 can clear out a prefix argument or a region,
6646 can get out of the minibuffer or other recursive edit,
6647 cancel the use of the current buffer (for special-purpose buffers),
6648 or go back to just one window (by deleting all but the selected window)."
6656 nil)
6667 "Play sound stored in FILE.
6668 VOLUME and DEVICE correspond to the keywords of the sound
6669 specification for `play-sound'."
6679 \f
6681 "Your preference for a mail reading package.
6682 This is used by some keybindings which support reading mail.
6683 See also `mail-user-agent' concerning sending mail."
6693 "Your preference for a mail composition package.
6694 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6695 outgoing email message. This variable lets you specify which
6696 mail-sending package you prefer.
6698 Valid values include:
6700 `message-user-agent' -- use the Message package.
6701 See Info node `(message)'.
6702 `sendmail-user-agent' -- use the Mail package.
6703 See Info node `(emacs)Sending Mail'.
6704 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6705 See Info node `(mh-e)'.
6706 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6707 paraphernalia if Gnus is running, particularly
6708 the Gcc: header for archiving.
6710 Additional valid symbols may be available; check with the author of
6711 your package for details. The function should return non-nil if it
6712 succeeds.
6714 See also `read-mail-command' concerning reading mail."
6717 message-user-agent)
6720 sendmail-user-agent)
6723 mh-e-user-agent)
6726 gnus-user-agent)
6732 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6733 If the value of `mail-user-agent' is the default, and the user
6734 appears to have customizations applying to the old default,
6735 `compose-mail' issues a warning."
6741 "If the buffer starts with a mail header, move point to the header's end.
6742 Otherwise, moves to `point-min'.
6743 The end of the header is the start of the next line, if there is one,
6744 else the end of the last line. This function obeys RFC822."
6750 ;; Used by Rmail (e.g., rmail-forward).
6752 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6756 switch-function yank-action send-actions
6757 return-action)
6758 "Start composing a mail message to send.
6759 This uses the user's chosen mail composition package
6760 as selected with the variable `mail-user-agent'.
6761 The optional arguments TO and SUBJECT specify recipients
6762 and the initial Subject field, respectively.
6764 OTHER-HEADERS is an alist specifying additional
6765 header fields. Elements look like (HEADER . VALUE) where both
6766 HEADER and VALUE are strings.
6768 CONTINUE, if non-nil, says to continue editing a message already
6769 being composed. Interactively, CONTINUE is the prefix argument.
6771 SWITCH-FUNCTION, if non-nil, is a function to use to
6772 switch to and display the buffer used for mail composition.
6774 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6775 to insert the raw text of the message being replied to.
6776 It has the form (FUNCTION . ARGS). The user agent will apply
6777 FUNCTION to ARGS, to insert the raw text of the original message.
6778 \(The user agent will also run `mail-citation-hook', *after* the
6779 original text has been inserted in this way.)
6781 SEND-ACTIONS is a list of actions to call when the message is sent.
6782 Each action has the form (FUNCTION . ARGS).
6784 RETURN-ACTION, if non-nil, is an action for returning to the
6785 caller. It has the form (FUNCTION . ARGS). The function is
6786 called after the mail has been sent or put aside, and the mail
6787 buffer buried."
6791 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6792 ;; from sendmail-user-agent to message-user-agent. Some users may
6793 ;; encounter incompatibilities. This hack tries to detect problems
6794 ;; and warn about them.
6799 mail-yank-hooks mail-archive-file-name
6800 mail-default-reply-to mail-mailing-lists
6801 mail-self-blind))
6808 The default mail mode is now Message mode.
6809 You have the following Mail mode variable%s customized:
6811 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6818 yank-action send-actions return-action)))
6821 yank-action send-actions
6822 return-action)
6826 'switch-to-buffer-other-window yank-action send-actions
6827 return-action))
6830 yank-action send-actions
6831 return-action)
6835 'switch-to-buffer-other-frame yank-action send-actions
6836 return-action))
6838 \f
6840 "History of values entered with `set-variable'.
6842 Maximum length of the history list is determined by the value
6846 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6847 VARIABLE should be a user option variable name, a Lisp variable
6848 meant to be customized by users. You should enter VALUE in Lisp syntax,
6849 so if you want VALUE to be a string, you must surround it with doublequotes.
6850 VALUE is used literally, not evaluated.
6852 If VARIABLE has a `variable-interactive' property, that is used as if
6853 it were the arg to `interactive' (which see) to interactively read VALUE.
6855 If VARIABLE has been defined with `defcustom', then the type information
6856 in the definition is used to check that VALUE is valid.
6858 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6863 default-var)
6879 var obsolete)
6882 ;; Use VAR's `variable-interactive' property
6883 ;; as an interactive spec for prompting.
6886 arg))
6888 read-expression-map t
6889 'set-variable-value-history
6898 ;; Match with custom type.
6910 ;; Force a thorough redisplay for the case that the variable
6911 ;; has an effect on the display, like `tab-width' has.
6913 \f
6914 ;; Define the major mode for lists of completions.
6924 (define-key map [right] 'next-completion)
6925 (define-key map "q" 'quit-window)
6926 (define-key map "z" 'kill-this-buffer)
6927 map)
6928 "Local map for completion list buffers.")
6930 ;; Completion mode is suitable only for specially formatted data.
6931 (put 'completion-list-mode 'mode-class 'special)
6933 (defvar completion-reference-buffer nil
6934 "Record the buffer that was current when the completion list was requested.
6935 This is a local variable in the completion list buffer.
6936 Initial value is nil to avoid some compiler warnings.")
6938 (defvar completion-no-auto-exit nil
6939 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6940 This also applies to other functions such as `choose-completion'.")
6942 (defvar completion-base-position nil
6943 "Position of the base of the text corresponding to the shown completions.
6944 This variable is used in the *Completions* buffers.
6945 Its value is a list of the form (START END) where START is the place
6946 where the completion should be inserted and END (if non-nil) is the end
6947 of the text to replace. If END is nil, point is used instead.")
6949 (defvar completion-list-insert-choice-function #'completion--replace
6950 "Function to use to insert the text chosen in *Completions*.
6951 Called with three arguments (BEG END TEXT), it should replace the text
6952 between BEG and END with TEXT. Expected to be set buffer-locally
6953 in the *Completions* buffer.")
6955 (defvar completion-base-size nil
6956 "Number of chars before point not involved in completion.
6957 This is a local variable in the completion list buffer.
6958 It refers to the chars in the minibuffer if completing in the
6959 minibuffer, or in `completion-reference-buffer' otherwise.
6960 Only characters in the field at point are included.
6962 If nil, Emacs determines which part of the tail end of the
6963 buffer's text is involved in completion by comparing the text
6964 directly.")
6965 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6967 (defun delete-completion-window ()
6968 "Delete the completion list window.
6969 Go to the window from which completion was requested."
6970 (interactive)
6971 (let ((buf completion-reference-buffer))
6972 (if (one-window-p t)
6973 (if (window-dedicated-p) (delete-frame))
6974 (delete-window (selected-window))
6975 (if (get-buffer-window buf)
6976 (select-window (get-buffer-window buf))))))
6978 (defun previous-completion (n)
6979 "Move to the previous item in the completion list."
6980 (interactive "p")
6981 (next-completion (- n)))
6983 (defun next-completion (n)
6984 "Move to the next item in the completion list.
6985 With prefix argument N, move N items (negative N means move backward)."
6986 (interactive "p")
6987 (let ((beg (point-min)) (end (point-max)))
6988 (while (and (> n 0) (not (eobp)))
6989 ;; If in a completion, move to the end of it.
6990 (when (get-text-property (point) 'mouse-face)
6991 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6992 ;; Move to start of next one.
6993 (unless (get-text-property (point) 'mouse-face)
6994 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6995 (setq n (1- n)))
6996 (while (and (< n 0) (not (bobp)))
6997 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6998 ;; If in a completion, move to the start of it.
6999 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7000 (goto-char (previous-single-property-change
7001 (point) 'mouse-face nil beg)))
7002 ;; Move to end of the previous completion.
7003 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7004 (goto-char (previous-single-property-change
7005 (point) 'mouse-face nil beg)))
7006 ;; Move to the start of that one.
7007 (goto-char (previous-single-property-change
7008 (point) 'mouse-face nil beg))
7009 (setq n (1+ n))))))
7011 (defun choose-completion (&optional event)
7012 "Choose the completion at point.
7013 If EVENT, use EVENT's position to determine the starting position."
7014 (interactive (list last-nonmenu-event))
7015 ;; In case this is run via the mouse, give temporary modes such as
7016 ;; isearch a chance to turn off.
7017 (run-hooks 'mouse-leave-buffer-hook)
7018 (with-current-buffer (window-buffer (posn-window (event-start event)))
7019 (let ((buffer completion-reference-buffer)
7020 (base-size completion-base-size)
7021 (base-position completion-base-position)
7022 (insert-function completion-list-insert-choice-function)
7023 (choice
7024 (save-excursion
7025 (goto-char (posn-point (event-start event)))
7026 (let (beg end)
7027 (cond
7028 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7029 (setq end (point) beg (1+ (point))))
7030 ((and (not (bobp))
7031 (get-text-property (1- (point)) 'mouse-face))
7032 (setq end (1- (point)) beg (point)))
7033 (t (error "No completion here")))
7034 (setq beg (previous-single-property-change beg 'mouse-face))
7035 (setq end (or (next-single-property-change end 'mouse-face)
7036 (point-max)))
7037 (buffer-substring-no-properties beg end)))))
7039 (unless (buffer-live-p buffer)
7040 (error "Destination buffer is dead"))
7041 (quit-window nil (posn-window (event-start event)))
7043 (with-current-buffer buffer
7044 (choose-completion-string
7045 choice buffer
7046 (or base-position
7047 (when base-size
7048 ;; Someone's using old completion code that doesn't know
7049 ;; about base-position yet.
7050 (list (+ base-size (field-beginning))))
7051 ;; If all else fails, just guess.
7052 (list (choose-completion-guess-base-position choice)))
7053 insert-function)))))
7055 ;; Delete the longest partial match for STRING
7056 ;; that can be found before POINT.
7057 (defun choose-completion-guess-base-position (string)
7058 (save-excursion
7059 (let ((opoint (point))
7060 len)
7061 ;; Try moving back by the length of the string.
7062 (goto-char (max (- (point) (length string))
7063 (minibuffer-prompt-end)))
7064 ;; See how far back we were actually able to move. That is the
7065 ;; upper bound on how much we can match and delete.
7066 (setq len (- opoint (point)))
7067 (if completion-ignore-case
7068 (setq string (downcase string)))
7069 (while (and (> len 0)
7070 (let ((tail (buffer-substring (point) opoint)))
7071 (if completion-ignore-case
7072 (setq tail (downcase tail)))
7073 (not (string= tail (substring string 0 len)))))
7074 (setq len (1- len))
7075 (forward-char 1))
7076 (point))))
7078 (defun choose-completion-delete-max-match (string)
7079 (declare (obsolete choose-completion-guess-base-position "23.2"))
7080 (delete-region (choose-completion-guess-base-position string) (point)))
7082 (defvar choose-completion-string-functions nil
7083 "Functions that may override the normal insertion of a completion choice.
7084 These functions are called in order with three arguments:
7085 CHOICE - the string to insert in the buffer,
7086 BUFFER - the buffer in which the choice should be inserted,
7087 BASE-POSITION - where to insert the completion.
7089 If a function in the list returns non-nil, that function is supposed
7090 to have inserted the CHOICE in the BUFFER, and possibly exited
7091 the minibuffer; no further functions will be called.
7093 If all functions in the list return nil, that means to use
7094 the default method of inserting the completion in BUFFER.")
7096 (defun choose-completion-string (choice &optional
7097 buffer base-position insert-function)
7098 "Switch to BUFFER and insert the completion choice CHOICE.
7099 BASE-POSITION says where to insert the completion.
7100 INSERT-FUNCTION says how to insert the completion and falls
7101 back on `completion-list-insert-choice-function' when nil."
7103 ;; If BUFFER is the minibuffer, exit the minibuffer
7104 ;; unless it is reading a file name and CHOICE is a directory,
7105 ;; or completion-no-auto-exit is non-nil.
7107 ;; Some older code may call us passing `base-size' instead of
7108 ;; `base-position'. It's difficult to make any use of `base-size',
7109 ;; so we just ignore it.
7110 (unless (consp base-position)
7111 (message "Obsolete `base-size' passed to choose-completion-string")
7112 (setq base-position nil))
7114 (let* ((buffer (or buffer completion-reference-buffer))
7115 (mini-p (minibufferp buffer)))
7116 ;; If BUFFER is a minibuffer, barf unless it's the currently
7117 ;; active minibuffer.
7118 (if (and mini-p
7119 (not (and (active-minibuffer-window)
7120 (equal buffer
7121 (window-buffer (active-minibuffer-window))))))
7122 (error "Minibuffer is not active for completion")
7123 ;; Set buffer so buffer-local choose-completion-string-functions works.
7124 (set-buffer buffer)
7125 (unless (run-hook-with-args-until-success
7126 'choose-completion-string-functions
7127 ;; The fourth arg used to be `mini-p' but was useless
7128 ;; (since minibufferp can be used on the `buffer' arg)
7129 ;; and indeed unused. The last used to be `base-size', so we
7130 ;; keep it to try and avoid breaking old code.
7131 choice buffer base-position nil)
7132 ;; This remove-text-properties should be unnecessary since `choice'
7133 ;; comes from buffer-substring-no-properties.
7134 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7135 ;; Insert the completion into the buffer where it was requested.
7136 (funcall (or insert-function completion-list-insert-choice-function)
7137 (or (car base-position) (point))
7138 (or (cadr base-position) (point))
7139 choice)
7140 ;; Update point in the window that BUFFER is showing in.
7141 (let ((window (get-buffer-window buffer t)))
7142 (set-window-point window (point)))
7143 ;; If completing for the minibuffer, exit it with this choice.
7144 (and (not completion-no-auto-exit)
7145 (minibufferp buffer)
7146 minibuffer-completion-table
7147 ;; If this is reading a file name, and the file name chosen
7148 ;; is a directory, don't exit the minibuffer.
7149 (let* ((result (buffer-substring (field-beginning) (point)))
7150 (bounds
7151 (completion-boundaries result minibuffer-completion-table
7152 minibuffer-completion-predicate
7153 "")))
7154 (if (eq (car bounds) (length result))
7155 ;; The completion chosen leads to a new set of completions
7156 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7157 (let ((mini (active-minibuffer-window)))
7158 (select-window mini)
7159 (when minibuffer-auto-raise
7160 (raise-frame (window-frame mini))))
7161 (exit-minibuffer))))))))
7163 (define-derived-mode completion-list-mode nil "Completion List"
7164 "Major mode for buffers showing lists of possible completions.
7166 to select the completion near point.
7167 Or click to select one with the mouse.
7170 (set (make-local-variable 'completion-base-size) nil))
7172 (defun completion-list-mode-finish ()
7173 "Finish setup of the completions buffer.
7174 Called from `temp-buffer-show-hook'."
7175 (when (eq major-mode 'completion-list-mode)
7176 (setq buffer-read-only t)))
7178 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7181 ;; Variables and faces used in `completion-setup-function'.
7183 (defcustom completion-show-help t
7184 "Non-nil means show help message in *Completions* buffer."
7185 :type 'boolean
7186 :version "22.1"
7187 :group 'completion)
7189 ;; This function goes in completion-setup-hook, so that it is called
7190 ;; after the text of the completion list buffer is written.
7191 (defun completion-setup-function ()
7192 (let* ((mainbuf (current-buffer))
7193 (base-dir
7194 ;; FIXME: This is a bad hack. We try to set the default-directory
7195 ;; in the *Completions* buffer so that the relative file names
7196 ;; displayed there can be treated as valid file names, independently
7197 ;; from the completion context. But this suffers from many problems:
7198 ;; - It's not clear when the completions are file names. With some
7199 ;; completion tables (e.g. bzr revision specs), the listed
7200 ;; completions can mix file names and other things.
7201 ;; - It doesn't pay attention to possible quoting.
7202 ;; - With fancy completion styles, the code below will not always
7203 ;; find the right base directory.
7204 (if minibuffer-completing-file-name
7205 (file-name-as-directory
7206 (expand-file-name
7207 (buffer-substring (minibuffer-prompt-end)
7208 (- (point) (or completion-base-size 0))))))))
7209 (with-current-buffer standard-output
7210 (let ((base-size completion-base-size) ;Read before killing localvars.
7211 (base-position completion-base-position)
7212 (insert-fun completion-list-insert-choice-function))
7213 (completion-list-mode)
7214 (set (make-local-variable 'completion-base-size) base-size)
7215 (set (make-local-variable 'completion-base-position) base-position)
7216 (set (make-local-variable 'completion-list-insert-choice-function)
7217 insert-fun))
7218 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7219 (if base-dir (setq default-directory base-dir))
7220 ;; Maybe insert help string.
7221 (when completion-show-help
7222 (goto-char (point-min))
7223 (if (display-mouse-p)
7224 (insert (substitute-command-keys
7226 (insert (substitute-command-keys
7230 (add-hook 'completion-setup-hook 'completion-setup-function)
7232 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7233 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7235 (defun switch-to-completions ()
7236 "Select the completion list window."
7237 (interactive)
7238 (let ((window (or (get-buffer-window "*Completions*" 0)
7239 ;; Make sure we have a completions window.
7240 (progn (minibuffer-completion-help)
7241 (get-buffer-window "*Completions*" 0)))))
7242 (when window
7243 (select-window window)
7244 ;; In the new buffer, go to the first completion.
7245 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7246 (when (bobp)
7247 (next-completion 1)))))
7248 \f
7249 ;;; Support keyboard commands to turn on various modifiers.
7251 ;; These functions -- which are not commands -- each add one modifier
7252 ;; to the following event.
7254 (defun event-apply-alt-modifier (_ignore-prompt)
7257 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7258 (defun event-apply-super-modifier (_ignore-prompt)
7261 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7262 (defun event-apply-hyper-modifier (_ignore-prompt)
7265 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7266 (defun event-apply-shift-modifier (_ignore-prompt)
7269 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7270 (defun event-apply-control-modifier (_ignore-prompt)
7273 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7274 (defun event-apply-meta-modifier (_ignore-prompt)
7277 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7279 (defun event-apply-modifier (event symbol lshiftby prefix)
7280 "Apply a modifier flag to event EVENT.
7281 SYMBOL is the name of this modifier, as a symbol.
7282 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7283 PREFIX is the string that represents this modifier in an event type symbol."
7284 (if (numberp event)
7285 (cond ((eq symbol 'control)
7286 (if (and (<= (downcase event) ?z)
7287 (>= (downcase event) ?a))
7288 (- (downcase event) ?a -1)
7289 (if (and (<= (downcase event) ?Z)
7290 (>= (downcase event) ?A))
7291 (- (downcase event) ?A -1)
7292 (logior (lsh 1 lshiftby) event))))
7293 ((eq symbol 'shift)
7294 (if (and (<= (downcase event) ?z)
7295 (>= (downcase event) ?a))
7296 (upcase event)
7297 (logior (lsh 1 lshiftby) event)))
7298 (t
7299 (logior (lsh 1 lshiftby) event)))
7300 (if (memq symbol (event-modifiers event))
7301 event
7302 (let ((event-type (if (symbolp event) event (car event))))
7303 (setq event-type (intern (concat prefix (symbol-name event-type))))
7304 (if (symbolp event)
7305 event-type
7306 (cons event-type (cdr event)))))))
7308 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7309 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7310 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7311 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7312 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7313 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7314 \f
7315 ;;;; Keypad support.
7317 ;; Make the keypad keys act like ordinary typing keys. If people add
7318 ;; bindings for the function key symbols, then those bindings will
7319 ;; override these, so this shouldn't interfere with any existing
7320 ;; bindings.
7322 ;; Also tell read-char how to handle these keys.
7323 (mapc
7324 (lambda (keypad-normal)
7325 (let ((keypad (nth 0 keypad-normal))
7326 (normal (nth 1 keypad-normal)))
7327 (put keypad 'ascii-character normal)
7328 (define-key function-key-map (vector keypad) (vector normal))))
7329 ;; See also kp-keys bound in bindings.el.
7330 '((kp-space ?\s)
7333 (kp-separator ?,)
7334 (kp-equal ?=)
7335 ;; Do the same for various keys that are represented as symbols under
7336 ;; GUIs but naturally correspond to characters.
7337 (backspace 127)
7338 (delete 127)
7341 (clear ?\C-l)
7342 (return ?\C-m)
7343 (escape ?\e)
7344 ))
7345 \f
7346 ;;;;
7347 ;;;; forking a twin copy of a buffer.
7348 ;;;;
7350 (defvar clone-buffer-hook nil
7351 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7353 (defvar clone-indirect-buffer-hook nil
7354 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7356 (defun clone-process (process &optional newname)
7357 "Create a twin copy of PROCESS.
7358 If NEWNAME is nil, it defaults to PROCESS' name;
7359 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7360 If PROCESS is associated with a buffer, the new process will be associated
7361 with the current buffer instead.
7362 Returns nil if PROCESS has already terminated."
7363 (setq newname (or newname (process-name process)))
7365 (setq newname (substring newname 0 (match-beginning 0))))
7366 (when (memq (process-status process) '(run stop open))
7367 (let* ((process-connection-type (process-tty-name process))
7368 (new-process
7369 (if (memq (process-status process) '(open))
7370 (let ((args (process-contact process t)))
7371 (setq args (plist-put args :name newname))
7372 (setq args (plist-put args :buffer
7373 (if (process-buffer process)
7374 (current-buffer))))
7375 (apply 'make-network-process args))
7376 (apply 'start-process newname
7377 (if (process-buffer process) (current-buffer))
7378 (process-command process)))))
7379 (set-process-query-on-exit-flag
7380 new-process (process-query-on-exit-flag process))
7381 (set-process-inherit-coding-system-flag
7382 new-process (process-inherit-coding-system-flag process))
7383 (set-process-filter new-process (process-filter process))
7384 (set-process-sentinel new-process (process-sentinel process))
7385 (set-process-plist new-process (copy-sequence (process-plist process)))
7386 new-process)))
7388 ;; things to maybe add (currently partly covered by `funcall mode'):
7389 ;; - syntax-table
7390 ;; - overlays
7391 (defun clone-buffer (&optional newname display-flag)
7392 "Create and return a twin copy of the current buffer.
7393 Unlike an indirect buffer, the new buffer can be edited
7394 independently of the old one (if it is not read-only).
7395 NEWNAME is the name of the new buffer. It may be modified by
7396 adding or incrementing <N> at the end as necessary to create a
7397 unique buffer name. If nil, it defaults to the name of the
7398 current buffer, with the proper suffix. If DISPLAY-FLAG is
7399 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7400 clone a file-visiting buffer, or a buffer whose major mode symbol
7401 has a non-nil `no-clone' property, results in an error.
7403 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7404 current buffer with appropriate suffix. However, if a prefix
7405 argument is given, then the command prompts for NEWNAME in the
7406 minibuffer.
7408 This runs the normal hook `clone-buffer-hook' in the new buffer
7409 after it has been set up properly in other respects."
7410 (interactive
7411 (progn
7412 (if buffer-file-name
7413 (error "Cannot clone a file-visiting buffer"))
7414 (if (get major-mode 'no-clone)
7415 (error "Cannot clone a buffer in %s mode" mode-name))
7416 (list (if current-prefix-arg
7417 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7418 t)))
7419 (if buffer-file-name
7420 (error "Cannot clone a file-visiting buffer"))
7421 (if (get major-mode 'no-clone)
7422 (error "Cannot clone a buffer in %s mode" mode-name))
7423 (setq newname (or newname (buffer-name)))
7425 (setq newname (substring newname 0 (match-beginning 0))))
7426 (let ((buf (current-buffer))
7427 (ptmin (point-min))
7428 (ptmax (point-max))
7429 (pt (point))
7430 (mk (if mark-active (mark t)))
7431 (modified (buffer-modified-p))
7432 (mode major-mode)
7433 (lvars (buffer-local-variables))
7434 (process (get-buffer-process (current-buffer)))
7435 (new (generate-new-buffer (or newname (buffer-name)))))
7436 (save-restriction
7437 (widen)
7438 (with-current-buffer new
7439 (insert-buffer-substring buf)))
7440 (with-current-buffer new
7441 (narrow-to-region ptmin ptmax)
7442 (goto-char pt)
7443 (if mk (set-mark mk))
7444 (set-buffer-modified-p modified)
7446 ;; Clone the old buffer's process, if any.
7447 (when process (clone-process process))
7449 ;; Now set up the major mode.
7450 (funcall mode)
7452 ;; Set up other local variables.
7453 (mapc (lambda (v)
7454 (condition-case () ;in case var is read-only
7455 (if (symbolp v)
7456 (makunbound v)
7457 (set (make-local-variable (car v)) (cdr v)))
7458 (error nil)))
7459 lvars)
7461 ;; Run any hooks (typically set up by the major mode
7462 ;; for cloning to work properly).
7463 (run-hooks 'clone-buffer-hook))
7464 (if display-flag
7465 ;; Presumably the current buffer is shown in the selected frame, so
7466 ;; we want to display the clone elsewhere.
7467 (let ((same-window-regexps nil)
7468 (same-window-buffer-names))
7469 (pop-to-buffer new)))
7470 new))
7473 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7474 "Create an indirect buffer that is a twin copy of the current buffer.
7476 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7477 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7478 or if not called with a prefix arg, NEWNAME defaults to the current
7479 buffer's name. The name is modified by adding a `<N>' suffix to it
7480 or by incrementing the N in an existing suffix. Trying to clone a
7481 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7482 property results in an error.
7484 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7485 This is always done when called interactively.
7487 Optional third arg NORECORD non-nil means do not put this buffer at the
7488 front of the list of recently selected ones."
7489 (interactive
7490 (progn
7491 (if (get major-mode 'no-clone-indirect)
7492 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7493 (list (if current-prefix-arg
7494 (read-buffer "Name of indirect buffer: " (current-buffer)))
7495 t)))
7496 (if (get major-mode 'no-clone-indirect)
7497 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7498 (setq newname (or newname (buffer-name)))
7500 (setq newname (substring newname 0 (match-beginning 0))))
7501 (let* ((name (generate-new-buffer-name newname))
7502 (buffer (make-indirect-buffer (current-buffer) name t)))
7503 (with-current-buffer buffer
7504 (run-hooks 'clone-indirect-buffer-hook))
7505 (when display-flag
7506 (pop-to-buffer buffer norecord))
7507 buffer))
7510 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7511 "Like `clone-indirect-buffer' but display in another window."
7512 (interactive
7513 (progn
7514 (if (get major-mode 'no-clone-indirect)
7515 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7516 (list (if current-prefix-arg
7517 (read-buffer "Name of indirect buffer: " (current-buffer)))
7518 t)))
7519 (let ((pop-up-windows t))
7520 (clone-indirect-buffer newname display-flag norecord)))
7522 \f
7523 ;;; Handling of Backspace and Delete keys.
7525 (defcustom normal-erase-is-backspace 'maybe
7526 "Set the default behavior of the Delete and Backspace keys.
7528 If set to t, Delete key deletes forward and Backspace key deletes
7529 backward.
7531 If set to nil, both Delete and Backspace keys delete backward.
7533 If set to 'maybe (which is the default), Emacs automatically
7534 selects a behavior. On window systems, the behavior depends on
7535 the keyboard used. If the keyboard has both a Backspace key and
7536 a Delete key, and both are mapped to their usual meanings, the
7537 option's default value is set to t, so that Backspace can be used
7538 to delete backward, and Delete can be used to delete forward.
7540 If not running under a window system, customizing this option
7541 accomplishes a similar effect by mapping C-h, which is usually
7542 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7543 via `keyboard-translate'. The former functionality of C-h is
7544 available on the F1 key. You should probably not use this
7545 setting if you don't have both Backspace, Delete and F1 keys.
7547 Setting this variable with setq doesn't take effect. Programmatically,
7548 call `normal-erase-is-backspace-mode' (which see) instead."
7549 :type '(choice (const :tag "Off" nil)
7550 (const :tag "Maybe" maybe)
7551 (other :tag "On" t))
7552 :group 'editing-basics
7553 :version "21.1"
7554 :set (lambda (symbol value)
7555 ;; The fboundp is because of a problem with :set when
7556 ;; dumping Emacs. It doesn't really matter.
7557 (if (fboundp 'normal-erase-is-backspace-mode)
7558 (normal-erase-is-backspace-mode (or value 0))
7559 (set-default symbol value))))
7561 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7562 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7563 (unless frame (setq frame (selected-frame)))
7564 (with-selected-frame frame
7565 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7566 (normal-erase-is-backspace-mode
7567 (if (if (eq normal-erase-is-backspace 'maybe)
7568 (and (not noninteractive)
7569 (or (memq system-type '(ms-dos windows-nt))
7570 (memq window-system '(w32 ns))
7571 (and (memq window-system '(x))
7572 (fboundp 'x-backspace-delete-keys-p)
7573 (x-backspace-delete-keys-p))
7574 ;; If the terminal Emacs is running on has erase char
7575 ;; set to ^H, use the Backspace key for deleting
7576 ;; backward, and the Delete key for deleting forward.
7577 (and (null window-system)
7578 (eq tty-erase-char ?\^H))))
7579 normal-erase-is-backspace)
7580 1 0)))))
7582 (define-minor-mode normal-erase-is-backspace-mode
7583 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7584 With a prefix argument ARG, enable this feature if ARG is
7585 positive, and disable it otherwise. If called from Lisp, enable
7586 the mode if ARG is omitted or nil.
7588 On window systems, when this mode is on, Delete is mapped to C-d
7589 and Backspace is mapped to DEL; when this mode is off, both
7590 Delete and Backspace are mapped to DEL. (The remapping goes via
7591 `local-function-key-map', so binding Delete or Backspace in the
7592 global or local keymap will override that.)
7594 In addition, on window systems, the bindings of C-Delete, M-Delete,
7595 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7596 the global keymap in accordance with the functionality of Delete and
7597 Backspace. For example, if Delete is remapped to C-d, which deletes
7598 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7599 to DEL, which deletes backward, C-Delete is bound to
7600 `backward-kill-word'.
7602 If not running on a window system, a similar effect is accomplished by
7603 remapping C-h (normally produced by the Backspace key) and DEL via
7604 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7605 to C-d; if it's off, the keys are not remapped.
7607 When not running on a window system, and this mode is turned on, the
7608 former functionality of C-h is available on the F1 key. You should
7609 probably not turn on this mode on a text-only terminal if you don't
7610 have both Backspace, Delete and F1 keys.
7612 See also `normal-erase-is-backspace'."
7613 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7614 . (lambda (v)
7615 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7616 (if v 1 0))))
7617 (let ((enabled (eq 1 (terminal-parameter
7618 nil 'normal-erase-is-backspace))))
7620 (cond ((or (memq window-system '(x w32 ns pc))
7621 (memq system-type '(ms-dos windows-nt)))
7622 (let ((bindings
7623 `(([M-delete] [M-backspace])
7624 ([C-M-delete] [C-M-backspace])
7625 ([?\e C-delete] [?\e C-backspace]))))
7627 (if enabled
7628 (progn
7629 (define-key local-function-key-map [delete] [deletechar])
7630 (define-key local-function-key-map [kp-delete] [deletechar])
7631 (define-key local-function-key-map [backspace] [?\C-?])
7632 (dolist (b bindings)
7633 ;; Not sure if input-decode-map is really right, but
7634 ;; keyboard-translate-table (used below) only works
7635 ;; for integer events, and key-translation-table is
7636 ;; global (like the global-map, used earlier).
7637 (define-key input-decode-map (car b) nil)
7638 (define-key input-decode-map (cadr b) nil)))
7639 (define-key local-function-key-map [delete] [?\C-?])
7640 (define-key local-function-key-map [kp-delete] [?\C-?])
7641 (define-key local-function-key-map [backspace] [?\C-?])
7642 (dolist (b bindings)
7643 (define-key input-decode-map (car b) (cadr b))
7644 (define-key input-decode-map (cadr b) (car b))))))
7645 (t
7646 (if enabled
7647 (progn
7648 (keyboard-translate ?\C-h ?\C-?)
7649 (keyboard-translate ?\C-? ?\C-d))
7650 (keyboard-translate ?\C-h ?\C-h)
7651 (keyboard-translate ?\C-? ?\C-?))))
7653 (if (called-interactively-p 'interactive)
7654 (message "Delete key deletes %s"
7655 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7656 "forward" "backward")))))
7657 \f
7658 (defvar vis-mode-saved-buffer-invisibility-spec nil
7659 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7661 (define-minor-mode read-only-mode
7662 "Change whether the current buffer is read-only.
7663 With prefix argument ARG, make the buffer read-only if ARG is
7664 positive, otherwise make it writable. If buffer is read-only
7665 and `view-read-only' is non-nil, enter view mode.
7667 Do not call this from a Lisp program unless you really intend to
7669 possibly enabling or disabling View mode. Also, note that this
7670 command works by setting the variable `buffer-read-only', which
7671 does not affect read-only regions caused by text properties. To
7672 ignore read-only status in a Lisp program (whether due to text
7673 properties or buffer state), bind `inhibit-read-only' temporarily
7674 to a non-nil value."
7675 :variable buffer-read-only
7676 (cond
7677 ((and (not buffer-read-only) view-mode)
7678 (View-exit-and-edit)
7679 (make-local-variable 'view-read-only)
7680 (setq view-read-only t)) ; Must leave view mode.
7681 ((and buffer-read-only view-read-only
7682 ;; If view-mode is already active, `view-mode-enter' is a nop.
7683 (not view-mode)
7684 (not (eq (get major-mode 'mode-class) 'special)))
7685 (view-mode-enter))))
7687 (define-minor-mode visible-mode
7688 "Toggle making all invisible text temporarily visible (Visible mode).
7689 With a prefix argument ARG, enable Visible mode if ARG is
7690 positive, and disable it otherwise. If called from Lisp, enable
7691 the mode if ARG is omitted or nil.
7693 This mode works by saving the value of `buffer-invisibility-spec'
7694 and setting it to nil."
7695 :lighter " Vis"
7696 :group 'editing-basics
7697 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7698 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7699 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7700 (when visible-mode
7701 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7702 buffer-invisibility-spec)
7703 (setq buffer-invisibility-spec nil)))
7704 \f
7705 (defvar messages-buffer-mode-map
7706 (let ((map (make-sparse-keymap)))
7707 (set-keymap-parent map special-mode-map)
7708 (define-key map "g" nil) ; nothing to revert
7709 map))
7711 (define-derived-mode messages-buffer-mode special-mode "Messages"
7714 (defun messages-buffer ()
7716 If it does not exist, create and it switch it to `messages-buffer-mode'."
7717 (or (get-buffer "*Messages*")
7718 (with-current-buffer (get-buffer-create "*Messages*")
7719 (messages-buffer-mode)
7720 (current-buffer))))
7722 \f
7723 ;; Minibuffer prompt stuff.
7725 ;;(defun minibuffer-prompt-modification (start end)
7726 ;; (error "You cannot modify the prompt"))
7727 ;;
7728 ;;
7729 ;;(defun minibuffer-prompt-insertion (start end)
7730 ;; (let ((inhibit-modification-hooks t))
7731 ;; (delete-region start end)
7732 ;; ;; Discard undo information for the text insertion itself
7733 ;; ;; and for the text deletion.above.
7734 ;; (when (consp buffer-undo-list)
7735 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7736 ;; (message "You cannot modify the prompt")))
7737 ;;
7738 ;;
7739 ;;(setq minibuffer-prompt-properties
7740 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7741 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7743 \f
7744 ;;;; Problematic external packages.
7746 ;; rms says this should be done by specifying symbols that define
7747 ;; versions together with bad values. This is therefore not as
7748 ;; flexible as it could be. See the thread:
7749 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7750 (defconst bad-packages-alist
7751 ;; Not sure exactly which semantic versions have problems.
7752 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7754 "The version of `semantic' loaded does not work in Emacs 22.
7755 It can cause constant high CPU load.
7756 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7757 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7758 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7759 ;; provided the `CUA-mode' feature. Since this is no longer true,
7760 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7761 (CUA-mode t nil
7762 "CUA-mode is now part of the standard GNU Emacs distribution,
7763 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7765 You have loaded an older version of CUA-mode which does not work
7766 correctly with this version of Emacs. You should remove the old
7767 version and use the one distributed with Emacs."))
7768 "Alist of packages known to cause problems in this version of Emacs.
7769 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7770 PACKAGE is either a regular expression to match file names, or a
7771 symbol (a feature name), like for `with-eval-after-load'.
7772 SYMBOL is either the name of a string variable, or `t'. Upon
7773 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7774 warning using STRING as the message.")
7776 (defun bad-package-check (package)
7777 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7778 (condition-case nil
7779 (let* ((list (assoc package bad-packages-alist))
7780 (symbol (nth 1 list)))
7781 (and list
7782 (boundp symbol)
7783 (or (eq symbol t)
7784 (and (stringp (setq symbol (eval symbol)))
7785 (string-match-p (nth 2 list) symbol)))
7786 (display-warning package (nth 3 list) :warning)))
7787 (error nil)))
7789 (dolist (elem bad-packages-alist)
7790 (let ((pkg (car elem)))
7791 (with-eval-after-load pkg
7792 (bad-package-check pkg))))
7794 \f
7795 ;;; Generic dispatcher commands
7797 ;; Macro `define-alternatives' is used to create generic commands.
7798 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7799 ;; that can have different alternative implementations where choosing
7800 ;; among them is exclusively a matter of user preference.
7802 ;; (define-alternatives COMMAND) creates a new interactive command
7803 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7804 ;; Typically, the user will not need to customize this variable; packages
7805 ;; wanting to add alternative implementations should use
7806 ;;
7807 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7809 (defmacro define-alternatives (command &rest customizations)
7810 "Define the new command `COMMAND'.
7812 The argument `COMMAND' should be a symbol.
7814 Running `M-x COMMAND RET' for the first time prompts for which
7815 alternative to use and records the selected command as a custom
7816 variable.
7818 Running `C-u M-x COMMAND RET' prompts again for an alternative
7819 and overwrites the previous choice.
7821 The variable `COMMAND-alternatives' contains an alist with
7822 alternative implementations of COMMAND. `define-alternatives'
7823 does not have any effect until this variable is set.
7825 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7826 `defcustom' keywords and values to add to the declaration of
7827 `COMMAND-alternatives' (typically :group and :version)."
7828 (let* ((command-name (symbol-name command))
7829 (varalt-name (concat command-name "-alternatives"))
7830 (varalt-sym (intern varalt-name))
7831 (varimp-sym (intern (concat command-name "--implementation"))))
7832 `(progn
7834 (defcustom ,varalt-sym nil
7835 ,(format "Alist of alternative implementations for the `%s' command.
7837 Each entry must be a pair (ALTNAME . ALTFUN), where:
7838 ALTNAME - The name shown at user to describe the alternative implementation.
7839 ALTFUN - The function called to implement this alternative."
7840 command-name)
7841 :type '(alist :key-type string :value-type function)
7842 ,@customizations)
7844 (put ',varalt-sym 'definition-name ',command)
7845 (defvar ,varimp-sym nil "Internal use only.")
7847 (defun ,command (&optional arg)
7848 ,(format "Run generic command `%s'.
7849 If used for the first time, or with interactive ARG, ask the user which
7850 implementation to use for `%s'. The variable `%s'
7851 contains the list of implementations currently supported for this command."
7852 command-name command-name varalt-name)
7853 (interactive "P")
7854 (when (or arg (null ,varimp-sym))
7855 (let ((val (completing-read
7856 ,(format "Select implementation for command `%s': "
7857 command-name)
7858 ,varalt-sym nil t)))
7859 (unless (string-equal val "")
7860 (when (null ,varimp-sym)
7861 (message
7862 "Use `C-u M-x %s RET' to select another implementation"
7863 ,command-name)
7864 (sit-for 3))
7865 (customize-save-variable ',varimp-sym
7866 (cdr (assoc-string val ,varalt-sym))))))
7867 (if ,varimp-sym
7868 (call-interactively ,varimp-sym)
7869 (message ,(format "No implementation selected for command `%s'"
7870 command-name)))))))
7872 \f
7873 ;; This is here because files in obsolete/ are not scanned for autoloads.
7875 (defvar iswitchb-mode nil "\
7876 Non-nil if Iswitchb mode is enabled.
7877 See the command `iswitchb-mode' for a description of this minor mode.
7878 Setting this variable directly does not take effect;
7879 either customize it (see the info node `Easy Customization')
7880 or call the function `iswitchb-mode'.")
7882 (custom-autoload 'iswitchb-mode "iswitchb" nil)
7884 (autoload 'iswitchb-mode "iswitchb" "\
7885 Toggle Iswitchb mode.
7886 With a prefix argument ARG, enable Iswitchb mode if ARG is
7887 positive, and disable it otherwise. If called from Lisp, enable
7888 the mode if ARG is omitted or nil.
7890 Iswitchb mode is a global minor mode that enables switching
7891 between buffers using substrings. See `iswitchb' for details.
7893 \(fn &optional ARG)" t nil)
7895 (make-obsolete 'iswitchb-mode
7896 "use `icomplete-mode' or `ido-mode' instead." "24.4")
7897 \f
7899 (provide 'simple)
7901 ;;; simple.el ends here