| blob | 1a596cf11db0876fc8804a76f296b7db39b5cf42 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2014 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 `cycle-spacing' runs, it saves in this variable:
827 its N argument, the original point position, and the original spacing
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 deletes all spaces.
843 The third call in a sequence restores the original whitespace (and point).
845 If MODE is `single-shot', it only performs the first step in the sequence.
846 If MODE is `fast' and the first step would not result in any change
847 \(i.e., there are exactly (abs N) spaces around point),
848 the function goes straight to the second step.
850 Repeatedly calling the function with different values of N starts a
851 new sequence each time."
859 ;; Command run for the first time, single-shot mode or different argument
871 ;; Special handling for case where there was no space at all.
874 ;; If this run causes no change in buffer content, delete all spaces,
875 ;; otherwise delete all excess spaces.
880 ;; Command run for the second time.
884 ;; Command run for the third time.
889 \f
891 "Move point to the beginning of the buffer.
892 With numeric arg N, put point N/10 of the way from the beginning.
893 If the buffer is narrowed, this command uses the beginning of the
894 accessible part of the buffer.
896 If Transient Mark mode is disabled, leave mark at previous
907 ;; Avoid overflow for large buffer sizes!
915 "Move point to the end of the buffer.
916 With numeric arg N, put point N/10 of the way from the end.
917 If the buffer is narrowed, this command uses the end of the
918 accessible part of the buffer.
920 If Transient Mark mode is disabled, leave mark at previous
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.
945 "Whether single-char deletion commands delete an active region.
946 This has an effect only if Transient Mark mode is enabled, and
947 affects `delete-forward-char' and `delete-backward-char', though
948 not `delete-char'.
950 If the value is the symbol `kill', the active region is killed
951 instead of deleted."
964 "Function to get the region's content.
965 Called with one argument DELETE.
966 If DELETE is `delete-only', then only delete the region and the return value
967 is undefined. If DELETE is nil, just return the content as a string.
971 "Delete the previous N characters (following if N is negative).
972 If Transient Mark mode is enabled, the mark is active, and N is 1,
973 delete the text in the region and deactivate the mark instead.
974 To disable this, set option `delete-active-region' to nil.
976 Optional second arg KILLFLAG, if non-nil, means to kill (save in
977 kill ring) instead of delete. Interactively, N is the prefix
978 arg, and KILLFLAG is set if N is explicitly specified.
980 In Overwrite mode, single character backward deletion may replace
981 tabs with spaces so as to back over columns, unless point is at
982 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.
1008 "Delete the following N characters (previous if N is negative).
1009 If Transient Mark mode is enabled, the mark is active, and N is 1,
1010 delete the text in the region and deactivate the mark instead.
1011 To disable this, set variable `delete-active-region' to nil.
1013 Optional second arg KILLFLAG non-nil means to kill (save in kill
1014 ring) instead of delete. Interactively, N is the prefix arg, and
1015 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.
1032 "Put point at beginning and mark at end of buffer.
1033 If narrowing is in effect, only uses the accessible part of the buffer.
1034 You probably should not use this function in Lisp programs;
1035 it is usually a mistake for a Lisp function to use any subroutine
1036 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."
1070 ;; Look for a default, a number in the buffer at point.
1080 ;; Decide if we're switching buffers.
1088 ;; Read the argument, offering that number (if any) as default.
1091 buffer))))
1092 ;; Switch to the desired buffer, one way or another.
1097 ;; Leave mark at previous position
1099 ;; 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'."
1232 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1233 ;; start a directional embedding, which could completely
1234 ;; disrupt the rest of the line (e.g., RLO will display the
1235 ;; rest of the line right-to-left). So we put an invisible
1236 ;; PDF character after these characters, to end the
1237 ;; embedding, which eliminates any effects on the rest of
1238 ;; the line. For RLE and RLO we also append an invisible
1239 ;; LRM, to avoid reordering the following numerical
1240 ;; characters. For LRI/RLI/FSI we append a PDI.
1247 ;; Strong right-to-left characters cause reordering of
1248 ;; the following numerical characters which show the
1249 ;; codepoint, so append LRM to countermand that.
1259 ;; Avoid overflow from multiplying by 100!
1263 ""
1269 pos total percent beg end col hscroll)
1271 pos total col hscroll))
1273 encoded encoding-msg display-prop under-display)
1280 ;; Check if the character is displayed with some `display'
1281 ;; text property. In that case, set under-display to the
1282 ;; buffer substring covered by that property.
1293 under-display)))
1299 char char char under-display)
1301 char char char under-display display-prop))
1304 char char char
1306 "..."
1310 ;; We show the detailed information about CHAR.
1317 bidi-fixer
1318 encoding-msg pos total percent beg end col hscroll)
1325 bidi-fixer encoding-msg pos total percent col hscroll))))))
1326 \f
1327 ;; Initialize read-expression-map. It is defined at C level.
1331 ;; Might as well bind TAB to completion, since inserting a TAB char is
1332 ;; much too rarely useful.
1335 m))
1338 "Return a Lisp object read using the minibuffer, unevaluated.
1339 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1340 is a string to insert in the minibuffer before reading.
1341 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1342 Such arguments are used as in `read-from-minibuffer'.)"
1343 ;; Used for interactive spec `x'.
1348 "Return value of Lisp expression read using the minibuffer.
1349 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1350 is a string to insert in the minibuffer before reading.
1351 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1352 Such arguments are used as in `read-from-minibuffer'.)"
1353 ;; Used for interactive spec `X'.
1361 "The current default value or list of default values in the minibuffer.
1362 The functions `read-from-minibuffer' and `completing-read' bind
1366 "Value for `print-level' while printing value in `eval-expression'.
1367 A value of nil means no limit."
1373 "Value for `print-length' while printing value in `eval-expression'.
1374 A value of nil means no limit."
1380 "If non-nil set `debug-on-error' to t in `eval-expression'.
1381 If nil, don't change the value of `debug-on-error'."
1387 "Format VALUE as a result of evaluated expression.
1388 Return a formatted string which is displayed in the echo area
1389 in addition to the value printed by prin1 in functions which
1390 display the result of expression evaluation."
1409 ;; FIXME: call emacs-lisp-mode?
1416 read-expression-map t
1419 ;; We define this, rather than making `eval' interactive,
1420 ;; for the sake of completion of names like eval-region, eval-buffer.
1422 "Evaluate EXP and print value in the echo area.
1423 When called interactively, read an Emacs Lisp expression and evaluate it.
1424 Value is also consed on to front of the variable `values'.
1425 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1426 argument) means insert the result into the current buffer instead of
1427 printing it in the echo area.
1429 Normally, this function truncates long output according to the value
1430 of the variables `eval-expression-print-length' and
1431 `eval-expression-print-level'. With a prefix argument of zero,
1432 however, there is no such truncation. Such a prefix argument
1433 also causes integers to be printed in several additional formats
1434 \(octal, hexadecimal, and character).
1436 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1437 minibuffer.
1439 If `eval-expression-debug-on-error' is non-nil, which is the default,
1440 this command arranges for all errors to enter the debugger."
1443 current-prefix-arg))
1448 ;; Bind debug-on-error to something unique so that we can
1449 ;; detect when evalled code changes it.
1453 ;; If evalled code has changed the value of debug-on-error,
1454 ;; propagate that change to the global binding.
1459 eval-expression-print-length))
1461 eval-expression-print-level))
1477 "Prompting with PROMPT, let user edit COMMAND and eval result.
1478 COMMAND is a Lisp expression. Let user edit that expression in
1479 the minibuffer, then read and evaluate the result."
1486 read-expression-map t
1488 ;; If command was added to command-history as a string,
1489 ;; get rid of that. We want only evaluable expressions there.
1493 ;; If command to be redone does not match front of history,
1494 ;; add it to the history.
1500 "Edit and re-evaluate last complex command, or ARGth from last.
1501 A complex command is one which used the minibuffer.
1502 The command is placed in the minibuffer as a Lisp form for editing.
1503 The result is executed, repeating the command as changed.
1504 If the command has been changed or is not the most recent previous
1505 command it is added to the front of the command history.
1506 You can use the minibuffer history commands \
1508 to get different commands to edit and resubmit."
1511 newcmd)
1523 ;; If command was added to command-history as a
1524 ;; string, get rid of that. We want only
1525 ;; evaluable expressions there.
1529 ;; If command to be redone does not match front of history,
1530 ;; add it to the history.
1544 "Read command name to invoke in `execute-extended-command'."
1549 ;; Get a command name at point in the original buffer
1550 ;; to propose it after M-n.
1554 ;; Read a string, completing from and restricting to the set of
1555 ;; all defined commands. Don't provide any initial input.
1556 ;; Save the command read on the extended-command history list.
1567 ;; This isn't strictly correct if `execute-extended-command'
1568 ;; is bound to anything else (e.g. [menu]).
1569 ;; It could use (key-description (this-single-command-keys)),
1570 ;; but actually a prompt other than "M-x" would be confusing,
1571 ;; because "M-x" is a well-known prompt to read a command
1572 ;; and it serves as a shorthand for "Extended command: ".
1577 "Non-nil means show the equivalent key-binding when M-x command has one.
1578 The value can be a length of time to show the message for.
1579 If the value is non-nil and not a number, we wait 2 seconds."
1586 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1587 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1588 "Read a command name, then read the arguments and call the command.
1589 Interactively, to pass a prefix argument to the command you are
1590 invoking, give a prefix argument to `execute-extended-command'.
1591 Noninteractively, the argument PREFIXARG is the prefix argument to
1592 give to the command you invoke."
1594 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1605 ;; Normally `real-this-command' should never be changed, but here we really
1606 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1607 ;; binding" for <cmd>, so the command the user really wanted to run is
1608 ;; `function' and not `execute-extended-command'. The difference is
1609 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1613 ;; If enabled, show which key runs this command.
1615 ;; But first wait, and skip the message if there is input.
1617 ;; If this command displayed something in the echo area;
1618 ;; wait a few seconds, then display our suggestion message.
1628 suggest-key-bindings
1632 ;; BEWARE: Called directly from the C code.
1633 "Execute CMD as an editor command.
1634 CMD must be a symbol that satisfies the `commandp' predicate.
1635 Optional second arg RECORD-FLAG non-nil
1636 means unconditionally put this command in the variable `command-history'.
1637 Otherwise, that is done only if an arg is read using the minibuffer.
1638 The argument KEYS specifies the value to use instead of (this-command-keys)
1639 when reading the arguments; if it is nil, (this-command-keys) is used.
1640 The argument SPECIAL, if non-nil, means that this command is executing
1641 a special event, so ignore the prefix argument and don't clear it."
1649 disabled-command-function)
1650 ;; FIXME: Weird calling convention!
1660 ;; If requested, place the macro in the command history. For
1661 ;; other sorts of commands, call-interactively takes care of this.
1664 ;; Don't keep command history around forever.
1670 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1678 \f
1680 "Default minibuffer history list.
1681 This is used for all minibuffer input
1682 except when an alternate history list is specified.
1684 Maximum length of the history list is determined by the value
1687 "Control whether history list elements are expressions or strings.
1688 If the value of this variable equals current minibuffer depth,
1689 they are expressions; otherwise they are strings.
1690 \(That convention is designed to do the right thing for
1697 "Text that was in this minibuffer before any history commands.
1698 This is nil if there have not yet been any history commands
1707 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1711 "Minibuffer history variables for which matching should ignore case.
1712 If a history variable is a member of this list, then the
1714 commands ignore case when searching it, regardless of `case-fold-search'."
1719 "Find the previous history element that matches REGEXP.
1720 \(Previous history elements refer to earlier actions.)
1721 With prefix argument N, search for Nth previous match.
1722 If N is negative, find the next or Nth next match.
1723 Normally, history elements are matched case-insensitively if
1724 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1725 makes the search case-sensitive.
1726 See also `minibuffer-history-case-insensitive-variables'."
1730 nil
1731 minibuffer-local-map
1732 nil
1733 'minibuffer-history-search-history
1735 ;; Use the last regexp specified, by default, if input is empty.
1740 regexp)
1750 ;; On some systems, ignore case for file names.
1752 minibuffer-history-case-insensitive-variables)
1753 t
1754 ;; Respect the user's setting for case-fold-search:
1755 case-fold-search)
1756 nil))
1757 prevpos
1758 match-string
1759 match-offset
1766 "No later matching history item"
1787 next-matching-history-element))
1791 "Find the next history element that matches REGEXP.
1792 \(The next history element refers to a more recent action.)
1793 With prefix argument N, search for Nth next match.
1794 If N is negative, find the previous or Nth previous match.
1795 Normally, history elements are matched case-insensitively if
1796 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1797 makes the search case-sensitive."
1801 nil
1802 minibuffer-local-map
1803 nil
1804 'minibuffer-history-search-history
1806 ;; Use the last regexp specified, by default, if input is empty.
1811 regexp)
1818 "Function run by `goto-history-element' before consuming default values.
1819 This is useful to dynamically add more elements to the list of default values
1820 when `goto-history-element' reaches the end of this list.
1821 Before calling this function `goto-history-element' sets the variable
1822 `minibuffer-default-add-done' to t, so it will call this function only
1823 once. In special cases, when this function needs to be called more
1824 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1828 "When nil, add more elements to the end of the list of default values.
1829 The value nil causes `goto-history-element' to add more elements to
1830 the list of defaults when it reaches the end of this list. It does
1836 "Return a list of all completions without the default value.
1837 This function is used to add all elements of the completion table to
1838 the end of the list of defaults just after the default value."
1841 minibuffer-completion-table
1842 minibuffer-completion-predicate)))
1848 "Puts element of the minibuffer history in the minibuffer.
1849 The argument NABS specifies the absolute history position."
1863 elt minibuffer-returned-to-present)
1870 "End of defaults; no next item"
1875 previous-history-element))
1887 minibuffer-default)))
1899 elt))
1903 "Puts next element of the minibuffer history in the minibuffer.
1904 With argument N, it uses the Nth following element."
1910 "Puts previous element of the minibuffer history in the minibuffer.
1911 With argument N, it uses the Nth previous element."
1917 "Get next history element which completes the minibuffer before the point.
1918 The contents of the minibuffer after the point are deleted, and replaced
1919 by the new completion."
1925 n)
1926 ;; next-matching-history-element always puts us at (point-min).
1927 ;; Move to the position we were at before changing the buffer contents.
1928 ;; This is still sensible, because the text before point has not changed.
1932 "\
1933 Get previous history element which completes the minibuffer before the point.
1934 The contents of the minibuffer after the point are deleted, and replaced
1935 by the new completion."
1939 ;; For compatibility with the old subr of the same name.
1941 "Return the display width of the minibuffer prompt.
1942 Return 0 if current buffer is not a minibuffer."
1943 ;; Return the width of everything before the field at the end of
1944 ;; the buffer; this should be 0 for normal buffers.
1946 \f
1947 ;; isearch minibuffer history
1954 "Set up a minibuffer for using isearch to search the minibuffer history.
1955 Intended to be added to `minibuffer-setup-hook'."
1967 "Clean up the minibuffer after terminating isearch in the minibuffer."
1972 "Return the proper search function, for isearch in minibuffer history."
1975 ;; Use standard functions to search within minibuffer text
1977 found)
1978 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1979 ;; searching forward. Lazy-highlight calls this lambda with the
1980 ;; bound arg, so skip the minibuffer prompt.
1984 ;; 1. First try searching in the initial minibuffer text
1987 noerror)
1988 ;; 2. If the above search fails, start putting next/prev history
1989 ;; elements in the minibuffer successively, and search the string
1990 ;; in them. Do this only when bound is nil (i.e. not while
1991 ;; lazy-highlighting search strings in the current minibuffer text).
2003 ;; After putting the next/prev history element, search
2004 ;; the string in them again, until next-history-element
2005 ;; or previous-history-element raises an error at the
2006 ;; beginning/end of history.
2009 ;; For backward search, don't search
2010 ;; in the minibuffer prompt
2012 noerror)))
2013 ;; Return point of the new search result
2015 ;; Return nil when next(prev)-history-element fails
2019 "Display the minibuffer history search prompt.
2020 If there are no search errors, this function displays an overlay with
2021 the isearch prompt which replaces the original minibuffer prompt.
2022 Otherwise, it displays the standard isearch message returned from
2023 the function `isearch-message'."
2025 ;; Use standard function `isearch-message' when not in the minibuffer,
2026 ;; or search fails, or has an error (like incomplete regexp).
2027 ;; This function overwrites minibuffer text with isearch message,
2028 ;; so it's possible to see what is wrong in the search string.
2030 ;; Otherwise, put the overlay with the standard isearch prompt over
2031 ;; the initial minibuffer prompt.
2040 ;; And clear any previous isearch message.
2044 "Wrap the minibuffer history search when search fails.
2045 Move point to the first history element for a forward search,
2046 or to the last history element for a backward search."
2047 ;; When `minibuffer-history-isearch-search' fails on reaching the
2048 ;; beginning/end of the history, wrap the search to the first/last
2049 ;; minibuffer history element.
2057 "Save a function restoring the state of minibuffer history search.
2058 Save `minibuffer-history-position' to the additional state parameter
2059 in the search status stack."
2065 "Restore the minibuffer history search state.
2066 Go to the history element by the absolute history position HIST-POS."
2069 \f
2070 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2074 "Table mapping redo records to the corresponding undo one.
2075 A redo record for undo-in-region maps to t.
2085 "Within a run of consecutive undo commands, list remaining to be undone.
2089 "Undo some previous changes.
2090 Repeat this command to undo more changes.
2091 A numeric ARG serves as a repeat count.
2093 In Transient Mark mode when the mark is active, only undo changes within
2095 as an argument limits undo to changes within the current region."
2097 ;; Make last-command indicate for the next command that this was an undo.
2098 ;; That way, another undo will undo more.
2099 ;; If we get to the end of the undo history and get an error,
2100 ;; another undo command will find the undo history empty
2101 ;; and will get another error. To begin undoing the undos,
2102 ;; you must type some other command.
2104 ;; For an indirect buffer, look in the base buffer for the
2105 ;; auto-save data.
2109 message)
2110 ;; If we get an error in undo-start,
2111 ;; the next command should not be a "consecutive undo".
2112 ;; So set `this-command' to something other than `undo'.
2117 ;; If something (a timer or filter?) changed the buffer
2118 ;; since the previous command, don't continue the undo seq.
2122 ;; If the last undo record made was made by undo
2123 ;; it shows nothing else happened in between.
2130 ;; get rid of initial undo boundary
2132 ;; If we got this far, the next command should be a consecutive undo.
2134 ;; Check to see whether we're hitting a redo record, and if
2135 ;; so, ask the user whether she wants to skip the redo/undo pair.
2143 ;; The equiv entry might point to another redo record if we have done
2144 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2152 ;; Record the fact that the just-generated undo records come from an
2153 ;; undo operation--that is, they are redo records.
2154 ;; In the ordinary case (not within a region), map the redo
2155 ;; record to the following undos.
2156 ;; I don't know how to do that in the undo-in-region case.
2158 ;; Strip any leading undo boundaries there might be, like we do
2159 ;; above when checking.
2163 ;; Prevent identity mapping. This can happen if
2164 ;; consecutive nils are erroneously in undo list.
2166 t
2167 pending-undo-list)
2168 undo-equiv-table))
2169 ;; Don't specify a position in the undo record for the undo command.
2170 ;; Instead, undoing this should move point to where the change is.
2189 ;; Record what the current undo list says,
2190 ;; so the next command can tell if the buffer was modified in between.
2194 ;; Display a message announcing success.
2199 "Make BUFFER stop keeping undo information.
2200 No argument or nil as argument means do this for the current buffer."
2206 "Undo some previous changes.
2207 Repeat this command to undo more changes.
2208 A numeric ARG serves as a repeat count.
2209 Contrary to `undo', this will not redo a previous undo."
2214 "Non-nil while performing an undo.
2218 "Undo back N undo-boundaries beyond what was already undone recently.
2219 Call `undo-start' to get ready to undo recent changes,
2220 then call `undo-more' one or more times to undo them."
2225 ;; Note: The following, while pulling elements off
2226 ;; `pending-undo-list' will call primitive change functions which
2227 ;; will push more elements onto `buffer-undo-list'.
2233 "Undo N records from the front of the list LIST.
2234 Return what remains of the list."
2236 ;; This is a good feature, but would make undo-start
2237 ;; unable to do what is expected.
2238 ;;(when (null (car (list)))
2239 ;; ;; If the head of the list is a boundary, it is the boundary
2240 ;; ;; preceding this command. Get rid of it and don't count it.
2241 ;; (setq list (cdr list))))
2244 ;; In a writable buffer, enable undoing read-only text that is
2245 ;; so because of text properties.
2247 ;; Don't let `intangible' properties interfere with undo.
2249 ;; We use oldlist only to check for EQ. ++kfs
2255 ;; Handle an integer by setting point to that value.
2258 ;; Element (t . TIME) records previous modtime.
2259 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2260 ;; UNKNOWN_MODTIME_NSECS.
2262 ;; If this records an obsolete save
2263 ;; (not matching the actual disk file)
2264 ;; then don't mark unmodified.
2272 ;; Element (nil PROP VAL BEG . END) is property change.
2277 ;; Element (BEG . END) means range was inserted.
2279 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2280 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2283 ;; Set point first thing, so that undoing this undo
2284 ;; does not send point back to where it is now.
2287 ;; Element (apply FUN . ARGS) means call FUN to undo.
2291 ;; Long format: (apply DELTA START END FUN . ARGS).
2298 ;; Check that the function did what the entry
2299 ;; said it would do.
2309 ;; Element (STRING . POS) means STRING was deleted.
2315 ;; Check that marker adjustments which were recorded
2316 ;; with the (STRING . POS) record are still valid, ie
2317 ;; the markers haven't moved. We check their validity
2318 ;; before reinserting the string so as we don't need to
2319 ;; mind marker insertion-type.
2327 ;; Insert string and adjust point
2335 ;; Adjust the valid marker adjustments
2339 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2342 next)
2343 ;; Even though these elements are not expected in the undo
2344 ;; list, adjust them to be conservative for the 24.4
2345 ;; release. (Bug#16818)
2352 ;; Make sure an apply entry produces at least one undo entry,
2353 ;; so the test in `undo' for continuing an undo series
2354 ;; will work right.
2359 list)
2361 ;; Deep copy of a list
2363 "Make a copy of undo list LIST."
2369 elt))
2372 "Set `pending-undo-list' to the front of the undo list.
2373 The next call to `undo-more' will undo the most recently made change.
2374 If BEG and END are specified, then only undo elements
2375 that apply to text between BEG and END are used; other undo elements
2376 are ignored. If BEG and END are nil, all undo elements are used."
2382 buffer-undo-list)))
2384 ;; The positions given in elements of the undo list are the positions
2385 ;; as of the time that element was recorded to undo history. In
2386 ;; general, subsequent buffer edits render those positions invalid in
2387 ;; the current buffer, unless adjusted according to the intervening
2388 ;; undo elements.
2389 ;;
2390 ;; Undo in region is a use case that requires adjustments to undo
2391 ;; elements. It must adjust positions of elements in the region based
2392 ;; on newer elements not in the region so as they may be correctly
2393 ;; applied in the current buffer. undo-make-selective-list
2394 ;; accomplishes this with its undo-deltas list of adjustments. An
2395 ;; example undo history from oldest to newest:
2396 ;;
2397 ;; buf pos:
2398 ;; 123456789 buffer-undo-list undo-deltas
2399 ;; --------- ---------------- -----------
2400 ;; aaa (1 . 4) (1 . -3)
2401 ;; aaba (3 . 4) N/A (in region)
2402 ;; ccaaba (1 . 3) (1 . -2)
2403 ;; ccaabaddd (7 . 10) (7 . -3)
2404 ;; ccaabdd ("ad" . 6) (6 . 2)
2405 ;; ccaabaddd (6 . 8) (6 . -2)
2406 ;; | |<-- region: "caab", from 2 to 6
2407 ;;
2408 ;; When the user starts a run of undos in region,
2409 ;; undo-make-selective-list is called to create the full list of in
2410 ;; region elements. Each element is adjusted forward chronologically
2411 ;; through undo-deltas to determine if it is in the region.
2412 ;;
2413 ;; In the above example, the insertion of "b" is (3 . 4) in the
2414 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2415 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2416 ;; . 6) is assessed as in the region and placed in the selective list.
2417 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2418 ;; due to the selected element. The "b" insertion is the only element
2419 ;; fully in the region, so in this example undo-make-selective-list
2420 ;; returns (nil (5 . 6)).
2421 ;;
2422 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2423 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2424 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2425 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2426 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2427 ;;
2428 ;; More interesting is how to adjust the "ddd" insertion due to the
2429 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2430 ;; If the reinsertion was a manual retyping of "ad", then the total
2431 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2432 ;; the reinsertion was due to undo, one might expect the first "d"
2433 ;; character would again be a part of the "ddd" text, meaning its
2434 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2435 ;;
2436 ;; undo-make-selective-list assumes in this situation that "ad" was a
2437 ;; new edit, even if it was inserted because of an undo.
2438 ;; Consequently, if the user undos in region "8 to 10" of the
2439 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2440 ;; "ccaabad", as though the first "d" became detached from the
2441 ;; original "ddd" insertion. This quirk is a FIXME.
2444 "Return a list of undo elements for the region START to END.
2445 The elements come from `buffer-undo-list', but we keep only the
2446 elements inside this region, and discard those outside this
2447 region. The elements' positions are adjusted so as the returned
2448 list can be applied to the current buffer."
2450 ;; A list of position adjusted undo elements in the region.
2452 ;; A list of undo-deltas for out of region undo elements.
2453 undo-deltas
2454 undo-elt)
2462 ;; Don't put two nils together in the list
2466 ;; This is a "was unmodified" element. Keep it
2467 ;; if we have kept everything thus far.
2470 ;; Skip over marker adjustments, instead relying
2471 ;; on finding them after (TEXT . POS) elements
2473 nil)
2476 undo-deltas)))
2481 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2482 ;; kept. primitive-undo may discard them later.
2495 "Determine whether UNDO-ELT falls inside the region START ... END.
2496 If it crosses the edge, we return nil.
2498 Generally this function is not useful for determining
2499 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2500 because markers can be arbitrarily relocated. Instead, pass the
2501 marker adjustment's corresponding (TEXT . POS) element."
2506 t)
2508 nil)
2510 ;; (TEXT . POSITION)
2514 ;; (MARKER . ADJUSTMENT)
2517 ;; (nil PROPERTY VALUE BEG . END)
2522 ;; (BEGIN . END)
2527 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2528 This assumes we have already decided that UNDO-ELT
2529 is not *inside* the region START...END."
2533 ;; (nil PROPERTY VALUE BEG . END)
2538 ;; (BEGIN . END)
2543 "Return adjustment of undo element ELT by the undo DELTAS
2544 list."
2546 ;; POSITION
2549 ;; (BEG . END)
2552 ;; (TEXT . POSITION)
2556 ;; (nil PROPERTY VALUE BEG . END)
2559 ;; (apply DELTA START END FUN . ARGS)
2560 ;; FIXME
2561 ;; All others return same elt
2564 ;; (BEG . END) can adjust to the same positions, commonly when an
2565 ;; insertion was undone and they are out of region, for example:
2566 ;;
2567 ;; buf pos:
2568 ;; 123456789 buffer-undo-list undo-deltas
2569 ;; --------- ---------------- -----------
2570 ;; [...]
2571 ;; abbaa (2 . 4) (2 . -2)
2572 ;; aaa ("bb" . 2) (2 . 2)
2573 ;; [...]
2574 ;;
2575 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2576 ;; undo. Further adjustments to such an element should be the same as
2577 ;; for (TEXT . POSITION) elements. The options are:
2578 ;;
2579 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2580 ;; analogous to marker insertion-type t.
2581 ;;
2582 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2583 ;; marker insertion-type nil.
2584 ;;
2585 ;; There was no strong reason to prefer one or the other, except that
2586 ;; the first is more consistent with prior undo in region behavior.
2588 "Return cons of adjustments to BEG and END by the undo DELTAS
2589 list."
2591 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2596 "Return adjustment of POS by the undo DELTAS list, comparing
2597 with < or <= based on USE-<."
2603 ;; Don't allow pos to become less than the undo-delta
2604 ;; position. This edge case is described in the overview
2605 ;; comments.
2608 ;; Return the first affected buffer position and the delta for an undo element
2609 ;; delta is defined as the change in subsequent buffer positions if we *did*
2610 ;; the undo.
2614 ;; (TEXT . POSITION)
2617 ;; (BEGIN . END)
2624 "If non-nil ask about discarding undo info for the current command.
2625 Normally, Emacs discards the undo info for the current command if
2626 it exceeds `undo-outer-limit'. But if you set this option
2627 non-nil, it asks in the echo area whether to discard the info.
2628 If you answer no, there is a slight risk that Emacs might crash, so
2629 only do it if you really want to undo the command.
2631 This option is mainly intended for debugging. You have to be
2632 careful if you use it for other purposes. Garbage collection is
2633 inhibited while the question is asked, meaning that Emacs might
2634 leak memory. So you should make sure that you do not wait
2635 excessively long before answering the question."
2641 "If non-nil, an extra level of size that's ok in an undo item.
2642 We don't ask the user about truncating the undo list until the
2643 current item gets bigger than this amount.
2648 ;; When the first undo batch in an undo list is longer than
2649 ;; undo-outer-limit, this function gets called to warn the user that
2650 ;; the undo info for the current command was discarded. Garbage
2651 ;; collection is inhibited around the call, so it had better not do a
2652 ;; lot of consing.
2658 ;; Don't ask the question again unless it gets even bigger.
2659 ;; This applies, in particular, if the user quits from the question.
2660 ;; Such a quit quits out of GC, but something else will call GC
2661 ;; again momentarily. It will call this function again,
2662 ;; but we don't want to ask the question again.
2669 t)
2670 nil))
2675 "The undo info was discarded because it exceeded \
2676 `undo-outer-limit'.
2678 This is normal if you executed a command that made a huge change
2679 to the buffer. In that case, to prevent similar problems in the
2680 future, set `undo-outer-limit' to a value that is large enough to
2681 cover the maximum size of normal changes you expect a single
2682 command to make, but not so large that it might exceed the
2683 maximum memory allotted to Emacs.
2685 If you did not execute any such command, the situation is
2686 probably due to a bug and you should report it.
2688 You can disable the popping up of this buffer by adding the entry
2689 \(undo discard-info) to the user option `warning-suppress-types',
2693 t))
2694 \f
2697 ; These are sorted according to the GNU en_US locale.
2740 )
2742 This is used by Shell mode and other parts of Emacs to recognize
2743 password prompts, including prompts in languages other than
2744 English. Different case choices should not be assumed to be
2745 included; callers should bind `case-fold-search' to t."
2751 "History list for some commands that read shell commands.
2753 Maximum length of the history list is determined by the value
2760 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2761 This buffer is used when `shell-command' or `shell-command-on-region'
2762 is run interactively. A value of nil means that output to stderr and
2769 "Return a list of all commands associated with the current file.
2770 This function is used to add all related commands retrieved by `mailcap'
2771 to the end of the list of defaults just after the default value."
2775 minibuffer-default))
2780 commands))
2791 map)
2795 "Read a shell command from the minibuffer.
2796 The arguments are the same as the ones of `read-from-minibuffer',
2797 except READ and KEYMAP are missing and HIST defaults
2798 to `shell-command-history'."
2806 minibuffer-local-shell-command-map
2807 nil
2809 args)))
2812 "What to do when the output buffer is used by another shell command.
2813 This option specifies how to resolve the conflict where a new command
2814 wants to direct its output to the buffer `*Async Shell Command*',
2815 but this buffer is already taken by another running shell command.
2817 The value `confirm-kill-process' is used to ask for confirmation before
2818 killing the already running process and running a new process
2819 in the same buffer, `confirm-new-buffer' for confirmation before running
2820 the command in a new buffer with a name other than the default buffer name,
2821 `new-buffer' for doing the same without confirmation,
2822 `confirm-rename-buffer' for confirmation before renaming the existing
2823 output buffer and running a new command in the default buffer,
2824 `rename-buffer' for doing the same without confirmation."
2826 confirm-kill-process)
2828 confirm-new-buffer)
2830 new-buffer)
2832 confirm-rename-buffer)
2834 rename-buffer))
2839 "Execute string COMMAND asynchronously in background.
2841 Like `shell-command', but adds `&' at the end of COMMAND
2842 to execute it asynchronously.
2844 The output appears in the buffer `*Async Shell Command*'.
2845 That buffer is in shell mode.
2847 You can configure `async-shell-command-buffer' to specify what to do in
2848 case when `*Async Shell Command*' buffer is already taken by another
2849 running shell command. To run COMMAND without displaying the output
2850 in a window you can configure `display-buffer-alist' to use the action
2851 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2853 In Elisp, you will often be better served by calling `start-process'
2854 directly, since it offers more control and does not impose the use of a
2855 shell (with its need to quote arguments)."
2865 current-prefix-arg
2866 shell-command-default-error-buffer))
2872 "Execute string COMMAND in inferior shell; display output, if any.
2873 With prefix argument, insert the COMMAND's output at point.
2875 If COMMAND ends in `&', execute it asynchronously.
2876 The output appears in the buffer `*Async Shell Command*'.
2877 That buffer is in shell mode. You can also use
2878 `async-shell-command' that automatically adds `&'.
2880 Otherwise, COMMAND is executed synchronously. The output appears in
2881 the buffer `*Shell Command Output*'. If the output is short enough to
2882 display in the echo area (which is determined by the variables
2883 `resize-mini-windows' and `max-mini-window-height'), it is shown
2884 there, but it is nonetheless available in buffer `*Shell Command
2885 Output*' even though that buffer is not automatically displayed.
2887 To specify a coding system for converting non-ASCII characters
2889 before this command.
2891 Noninteractive callers can specify coding systems by binding
2892 `coding-system-for-read' and `coding-system-for-write'.
2894 The optional second argument OUTPUT-BUFFER, if non-nil,
2895 says to put the output in some other buffer.
2896 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2897 If OUTPUT-BUFFER is not a buffer and not nil,
2898 insert output in current buffer. (This cannot be done asynchronously.)
2899 In either case, the buffer is first erased, and the output is
2900 inserted after point (leaving mark after it).
2902 If the command terminates without error, but generates output,
2904 the output can be displayed in the echo area or in its buffer.
2905 If the output is short enough to display in the echo area
2906 \(determined by the variable `max-mini-window-height' if
2907 `resize-mini-windows' is non-nil), it is shown there.
2908 Otherwise,the buffer containing the output is displayed.
2912 of the output.
2914 If there is no output, or if output is inserted in the current buffer,
2915 then `*Shell Command Output*' is deleted.
2917 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2918 or buffer name to which to direct the command's standard error output.
2919 If it is nil, error output is mingled with regular output.
2920 In an interactive call, the variable `shell-command-default-error-buffer'
2921 specifies the value of ERROR-BUFFER.
2923 In Elisp, you will often be better served by calling `call-process' or
2924 `start-process' directly, since it offers more control and does not impose
2925 the use of a shell (with its need to quote arguments)."
2936 current-prefix-arg
2937 shell-command-default-error-buffer))
2938 ;; Look for a handler in case default-directory is a remote file name.
2946 ;; Output goes in current buffer.
2952 temporary-file-directory)))
2953 nil)))
2956 ;; We do not use -f for csh; we will not support broken use of
2957 ;; .cshrcs. Even the BSD csh manual says to use
2958 ;; "if ($?prompt) exit" before things which are not useful
2959 ;; non-interactively. Besides, if someone wants their other
2960 ;; aliases for shell commands then they can still have them.
2964 t)
2965 nil shell-command-switch command)
2972 ;; Do no formatting while reading error file,
2973 ;; because that can run a shell command, and we
2974 ;; don't want that to cause an infinite recursion.
2976 ;; Put point after the inserted errors.
2980 ;; This is like exchange-point-and-mark, but doesn't
2981 ;; activate the mark. It is cleaner to avoid activation,
2982 ;; even though the command loop would deactivate the mark
2983 ;; because we inserted text.
2987 ;; Output goes in a separate buffer.
2988 ;; Preserve the match data in case called from a program.
2991 ;; Command ending with ampersand means asynchronous.
2995 proc)
2996 ;; Remove the ampersand.
2998 ;; Ask the user what to do with already running process.
3003 ;; If will kill a process, query first.
3008 ;; If will create a new buffer, query first.
3014 ;; It will create a new buffer.
3018 ;; If will rename the buffer, query first.
3027 ;; It will rename the buffer.
3034 ;; Setting buffer-read-only to nil doesn't suffice
3035 ;; if some text has a non-nil read-only property,
3036 ;; which comint sometimes adds for prompts.
3042 shell-command-switch command))
3046 ;; Use the comint filter for proper handling of carriage motion
3047 ;; (see `comint-inhibit-carriage-motion'),.
3049 ))
3050 ;; Otherwise, command is executed synchronously.
3052 output-buffer nil error-buffer)))))))
3056 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3057 MESSAGE may be either a string or a buffer.
3059 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3060 the maximum height of the echo area, as defined by `max-mini-window-height'
3061 if `resize-mini-windows' is non-nil.
3063 Returns either the string shown in the echo area, or when a pop-up
3064 buffer is used, the window used to display it.
3066 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3067 name of the buffer used to display it in the case where a pop-up buffer
3068 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3069 string and it is displayed in the echo area, it is not specified whether
3070 the contents are inserted into the buffer anyway.
3072 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3073 and only used if a buffer is displayed."
3075 ;; Trivial case where we can use the echo area
3079 ;; Trivial case where we can just remove single trailing newline
3082 ;; General case
3085 message
3094 0
3098 (<= lines
3102 max-mini-window-height))
3104 max-mini-window-height)
3108 ;; Don't use the echo area if the output buffer is
3109 ;; already displayed in the selected frame.
3111 ;; Echo area
3117 ;; Buffer
3120 not-this-window frame))))))))
3123 ;; We have a sentinel to prevent insertion of a termination message
3124 ;; in the buffer itself.
3132 &optional output-buffer replace
3133 error-buffer display-error-buffer)
3134 "Execute string COMMAND in inferior shell with region as input.
3135 Normally display output (if any) in temp buffer `*Shell Command Output*';
3136 Prefix arg means replace the region with it. Return the exit code of
3137 COMMAND.
3139 To specify a coding system for converting non-ASCII characters
3141 before this command. By default, the input (from the current buffer)
3142 is encoded using coding-system specified by `process-coding-system-alist',
3143 falling back to `default-process-coding-system' if no match for COMMAND
3144 is found in `process-coding-system-alist'.
3146 Noninteractive callers can specify coding systems by binding
3147 `coding-system-for-read' and `coding-system-for-write'.
3149 If the command generates output, the output may be displayed
3150 in the echo area or in a buffer.
3151 If the output is short enough to display in the echo area
3152 \(determined by the variable `max-mini-window-height' if
3153 `resize-mini-windows' is non-nil), it is shown there.
3154 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3155 The output is available in that buffer in both cases.
3157 If there is output and an error, a message about the error
3158 appears at the end of the output. If there is no output, or if
3159 output is inserted in the current buffer, the buffer `*Shell
3160 Command Output*' is deleted.
3162 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3163 command's output. If the value is a buffer or buffer name,
3164 put the output there. If the value is nil, use the buffer
3165 `*Shell Command Output*'. Any other value, excluding nil,
3166 means to insert the output in the current buffer. In either case,
3167 the output is inserted after point (leaving mark after it).
3169 Optional fifth arg REPLACE, if non-nil, means to insert the
3170 output in place of text from START to END, putting point and mark
3171 around it.
3173 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3174 or buffer name to which to direct the command's standard error
3175 output. If nil, error output is mingled with regular output.
3176 When called interactively, `shell-command-default-error-buffer'
3177 is used for ERROR-BUFFER.
3179 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3180 display the error buffer if there were any errors. When called
3181 interactively, this is t."
3185 ;; Do this before calling region-beginning
3186 ;; and region-end, in case subprocess output
3187 ;; relocates them while we are in the minibuffer.
3189 ;; call-interactively recognizes region-beginning and
3190 ;; region-end specially, leaving them in the history.
3192 string
3193 current-prefix-arg
3194 current-prefix-arg
3195 shell-command-default-error-buffer
3196 t)))
3202 temporary-file-directory)))
3203 nil))
3204 exit-status)
3208 ;; Replace specified region with output from command.
3210 ;; Don't muck with mark unless REPLACE says we should.
3217 t)
3218 nil shell-command-switch command))
3219 ;; It is rude to delete a buffer which the command is not using.
3220 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3221 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3222 ;; (kill-buffer shell-buffer)))
3223 ;; Don't muck with mark unless REPLACE says we should.
3225 ;; No prefix argument: put the output in a temp buffer,
3226 ;; replacing its entire contents.
3231 ;; If the input is the same buffer as the output,
3232 ;; delete everything but the specified region,
3233 ;; then replace that region with the output.
3239 shell-file-name t
3242 t)
3243 nil shell-command-switch
3244 command)))
3245 ;; Clear the output buffer, then run the command with
3246 ;; output there.
3257 buffer)
3258 nil shell-command-switch command)))
3259 ;; Report the output.
3269 ;; There's some output, display it
3271 ;; No output; error?
3278 shell-command-default-error-buffer)
3285 output))
3288 exit-status))
3291 exit-status output))))
3292 ;; Don't kill: there might be useful info in the undo-log.
3293 ;; (kill-buffer buffer)
3294 ))))
3302 ;; Do no formatting while reading error file,
3303 ;; because that can run a shell command, and we
3304 ;; don't want that to cause an infinite recursion.
3306 ;; Put point after the inserted errors.
3311 exit-status))
3314 "Execute shell command COMMAND and return its output as a string."
3317 standard-output
3321 "Process files synchronously in a separate process.
3322 Similar to `call-process', but may invoke a file handler based on
3323 `default-directory'. The current working directory of the
3324 subprocess is `default-directory'.
3326 File names in INFILE and BUFFER are handled normally, but file
3327 names in ARGS should be relative to `default-directory', as they
3328 are passed to the process verbatim. (This is a difference to
3329 `call-process' which does not support file handlers for INFILE
3330 and BUFFER.)
3332 Some file handlers might not support all variants, for example
3333 they might behave as if DISPLAY was nil, regardless of the actual
3334 value passed."
3336 lc stderr-file)
3346 display args)
3352 "Whether a call of `process-file' changes remote files.
3354 By default, this variable is always set to `t', meaning that a
3355 call of `process-file' could potentially change any file on a
3356 remote host. When set to `nil', a file handler could optimize
3357 its behavior with respect to remote file attribute caching.
3359 You should only ever change this variable with a let-binding;
3363 "Start a program in a subprocess. Return the process object for it.
3365 Similar to `start-process', but may invoke a file handler based on
3366 `default-directory'. See Info node `(elisp)Magic File Names'.
3368 This handler ought to run PROGRAM, perhaps on the local host,
3369 perhaps on a remote host that corresponds to `default-directory'.
3370 In the latter case, the local part of `default-directory' becomes
3371 the working directory of the process.
3373 PROGRAM and PROGRAM-ARGS might be file names. They are not
3374 objects of file handler invocation. File handlers might not
3375 support pty association, if PROGRAM is nil."
3379 \f
3380 ;;;; Process menu
3394 map))
3397 "Major mode for listing the processes called by Emacs."
3409 "Kill process at point in a `list-processes' buffer."
3415 "Recompute the list of processes for the Process List buffer.
3416 Also, delete any process that is exited or signaled."
3429 face link
3432 follow-link t
3433 process-buffer ,buf
3434 action process-menu-visit-buffer)
3443 "datagram"
3460 tabulated-list-entries))))))
3466 "Display a list of all processes that are Emacs sub-processes.
3467 If optional argument QUERY-ONLY is non-nil, only processes with
3468 the query-on-exit flag set are listed.
3469 Any process listed as exited or signaled is actually eliminated
3470 after the listing is made.
3471 Optional argument BUFFER specifies a buffer to use, instead of
3473 The return value is always nil.
3475 This function lists only processes that were launched by Emacs. To
3476 see other processes running on the system, use `list-system-processes'."
3488 nil)
3489 \f
3493 ;; For backward compatibility, minus with no modifiers is an ordinary
3494 ;; command if digits have already been entered.
3524 map)
3531 "Begin a numeric argument for the following command.
3536 multiplies the argument by 4 each time.
3538 which is different in effect from any particular numeric argument.
3545 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3546 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3552 arg)))
3556 "Begin a negative numeric argument for the next command.
3565 "Part of the numeric argument for the next command.
3569 last-command-event
3576 ;; Treat -0 as just -, so that -01 will work.
3579 digit))))
3581 \f
3589 "Function to perform the filtering in `filter-buffer-substring'.
3590 The function is called with the same 3 arguments (BEG END DELETE)
3591 that `filter-buffer-substring' received. It should return the
3592 buffer substring between BEG and END, after filtering. If DELETE is
3596 "List of filter functions for `buffer-substring--filter'.
3597 Each function must accept a single argument, a string, and return a string.
3598 The buffer substring is passed to the first function in the list,
3599 and the return value of each function is passed to the next.
3600 As a special convention, point is set to the start of the buffer text
3601 being operated on (i.e., the first argument of `buffer-substring--filter')
3607 "Return the buffer substring between BEG and END, after filtering.
3608 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3610 This calls the function that `filter-buffer-substring-function' specifies
3611 \(passing the same three arguments that it received) to do the work,
3612 and returns whatever it does. The default function does no filtering,
3613 unless a hook has been set.
3615 Use `filter-buffer-substring' instead of `buffer-substring',
3616 `buffer-substring-no-properties', or `delete-and-extract-region' when
3617 you want to allow filtering to take place. For example, major or minor
3618 modes can use `filter-buffer-substring-function' to extract characters
3619 that are special to a buffer, and should not be copied into other buffers."
3623 "Default function to use for `filter-buffer-substring-function'.
3624 Its arguments and return value are as specified for `filter-buffer-substring'.
3625 This respects the wrapper hook `filter-buffer-substring-functions',
3626 and the abnormal hook `buffer-substring-filters'.
3627 No filtering is done unless a hook says to."
3637 string)))
3642 ;;;; Window system cut and paste hooks.
3645 "Function to call to make a killed region available to other programs.
3646 Most window systems provide a facility for cutting and pasting
3647 text between different programs, such as the clipboard on X and
3648 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3650 This variable holds a function that Emacs calls whenever text is
3651 put in the kill ring, to make the new kill available to other
3652 programs. The function takes one argument, TEXT, which is a
3656 "Function to call to get text cut from other programs.
3657 Most window systems provide a facility for cutting and pasting
3658 text between different programs, such as the clipboard on X and
3659 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3661 This variable holds a function that Emacs calls to obtain text
3662 that other programs have provided for pasting. The function is
3663 called with no arguments. If no other program has provided text
3664 to paste, the function should return nil (in which case the
3665 caller, usually `current-kill', should use the top of the Emacs
3666 kill ring). If another program has provided text to paste, the
3667 function should return that text as a string (in which case the
3668 caller should put this string in the kill ring as the latest
3669 kill).
3671 The function may also return a list of strings if the window
3672 system supports multiple selections. The first string will be
3673 used as the pasted text, but the other will be placed in the kill
3674 ring for easy access via `yank-pop'.
3676 Note that the function should return a string only if a program
3677 other than Emacs has provided a string for pasting; if Emacs
3678 provided the most recent string, the function should return nil.
3679 If it is difficult to tell whether Emacs or some other program
3680 provided the current string, it is probably good enough to return
3681 nil if the string is equal (according to `string=') to the last
3683 \f
3686 ;;;; The kill ring data structure.
3689 "List of killed text sequences.
3690 Since the kill ring is supposed to interact nicely with cut-and-paste
3691 facilities offered by window systems, use of this variable should
3692 interact nicely with `interprogram-cut-function' and
3693 `interprogram-paste-function'. The functions `kill-new',
3694 `kill-append', and `current-kill' are supposed to implement this
3695 interaction; you may want to use them instead of manipulating the kill
3699 "Maximum length of kill ring before oldest elements are thrown away."
3707 "Save clipboard strings into kill ring before replacing them.
3708 When one selects something in another program to paste it into Emacs,
3709 but kills something in Emacs before actually pasting it,
3710 this selection is gone unless this variable is non-nil,
3711 in which case the other program's selection is saved in the `kill-ring'
3718 "Do not add a new string to `kill-ring' if it duplicates the last one.
3719 The comparison is done using `equal-including-properties'."
3725 "Make STRING the latest kill in the kill ring.
3726 Set `kill-ring-yank-pointer' to point to it.
3727 If `interprogram-cut-function' is non-nil, apply it to STRING.
3728 Optional second argument REPLACE non-nil means that STRING will replace
3729 the front of the kill ring, rather than being added to the list.
3731 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3732 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3733 STRING.
3735 When the yank handler has a non-nil PARAM element, the original STRING
3736 argument is not used by `insert-for-yank'. However, since Lisp code
3737 may access and use elements from the kill ring directly, the STRING
3740 ;; Due to text properties such as 'yank-handler that
3741 ;; can alter the contents to yank, comparison using
3742 ;; `equal' is unsafe.
3767 ;; It has been argued that this should work similar to `self-insert-command'
3768 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3770 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3776 "Append STRING to the end of the latest kill in the kill ring.
3777 If BEFORE-P is non-nil, prepend STRING to the kill.
3778 Also removes the last undo boundary in the current buffer,
3779 depending on `kill-append-merge-undo'.
3780 If `interprogram-cut-function' is set, pass the resulting kill to it."
3788 ;; find the next undo boundary
3792 ;; remove this undo boundary
3797 "Whether rotating the kill ring changes the window system selection.
3798 If non-nil, whenever the kill ring is rotated (usually via the
3799 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3800 to copy the new kill to the window system selection."
3806 "Rotate the yanking point by N places, and then return that kill.
3807 If N is zero and `interprogram-paste-function' is set to a
3808 function that returns a string or a list of strings, and if that
3809 function doesn't return nil, then that string (or list) is added
3810 to the front of the kill ring and the string (or first string in
3811 the list) is returned as the latest kill.
3813 If N is not zero, and if `yank-pop-change-selection' is
3814 non-nil, use `interprogram-cut-function' to transfer the
3815 kill at the new yank point into the window system selection.
3817 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3818 move the yanking point; just return the Nth kill forward."
3821 interprogram-paste-function
3825 ;; Disable the interprogram cut function when we add the new
3826 ;; text to the kill ring, so Emacs doesn't try to own the
3827 ;; selection, with identical text.
3837 kill-ring)))
3842 interprogram-cut-function)
3848 ;;;; Commands for manipulating the kill ring.
3851 "Non-nil means don't signal an error for killing read-only text."
3857 This deletes the text from the buffer and saves it in the kill ring.
3861 If you want to append the killed region to the last killed text,
3864 If the buffer is read-only, Emacs will beep and refrain from deleting
3865 the text, but put the text in the kill ring anyway. This means that
3866 you can use the killing commands to copy text from a read-only buffer.
3868 Lisp programs should use this function for killing text.
3869 (To delete text, use `delete-region'.)
3870 Supply two arguments, character positions indicating the stretch of text
3871 to be killed.
3873 If the previous command was also a kill command,
3874 the text killed this time appends to the text killed last time
3875 to make one entry in the kill ring.
3877 The optional argument REGION if non-nil, indicates that we're not just killing
3878 some text between BEG and END, but we're killing the region."
3879 ;; Pass mark first, then point, because the order matters when
3880 ;; calling `kill-append'.
3889 ;; Add that string to the kill ring, one way or another.
3896 nil)
3898 ;; The code above failed because the buffer, or some of the characters
3899 ;; in the region, are read-only.
3900 ;; We should beep, in case the user just isn't aware of this.
3901 ;; However, there's no harm in putting
3902 ;; the region's text in the kill ring, anyway.
3904 ;; Set this-command now, so it will be set even if we get an error.
3906 ;; This should barf, if appropriate, and give us the correct error.
3909 ;; Signal an error if the buffer is read-only.
3911 ;; If the buffer isn't read-only, the text is.
3914 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3915 ;; to get two copies of the text when the user accidentally types M-w and
3916 ;; then corrects it with the intended C-w.
3918 "Save the region as if killed, but don't kill it.
3919 In Transient Mark mode, deactivate the mark.
3920 If `interprogram-cut-function' is non-nil, also save the text for a window
3921 system cut and paste.
3923 The optional argument REGION if non-nil, indicates that we're not just copying
3924 some text between BEG and END, but we're copying the region.
3926 This command's old key binding has been given to `kill-ring-save'."
3927 ;; Pass mark first, then point, because the order matters when
3928 ;; calling `kill-append'.
3938 nil)
3941 "Save the region as if killed, but don't kill it.
3942 In Transient Mark mode, deactivate the mark.
3943 If `interprogram-cut-function' is non-nil, also save the text for a window
3944 system cut and paste.
3946 If you want to append the killed line to the last killed text,
3949 The optional argument REGION if non-nil, indicates that we're not just copying
3950 some text between BEG and END, but we're copying the region.
3952 This command is similar to `copy-region-as-kill', except that it gives
3953 visual feedback indicating the extent of the region being copied."
3954 ;; Pass mark first, then point, because the order matters when
3955 ;; calling `kill-append'.
3959 ;; This use of called-interactively-p is correct because the code it
3960 ;; controls just gives the user visual feedback.
3965 "Indicate that the region text has been copied interactively.
3966 If the mark is visible in the selected window, blink the cursor
3967 between point and mark if there is currently no active region
3968 highlighting.
3970 If the mark lies outside the selected window, display an
3971 informative message containing a sample of the copied text. The
3972 optional argument MESSAGE-LEN, if non-nil, specifies the length
3973 of this sample text; it defaults to 40."
3976 ;; Inhibit quitting so we can make a quit here
3977 ;; look like a C-g typed as a command.
3980 ;; Swap point-and-mark quickly so as to show the region that
3981 ;; was selected. Don't do it if the region is highlighted.
3984 ;; Swap point and mark.
3988 ;; Swap back.
3991 ;; If user quit, deactivate the mark
3992 ;; as C-g would as a command.
3998 ;; Don't say "killed"; that is misleading.
4005 "Cause following command, if it kills, to add to previous kill.
4006 If the next command kills forward from point, the kill is
4007 appended to the previous killed text. If the command kills
4008 backward, the kill is prepended. Kill commands that act on the
4009 region, such as `kill-region', are regarded as killing forward if
4010 point is after mark, and killing backward if point is before
4011 mark.
4013 If the next command is not a kill command, `append-next-kill' has
4014 no effect.
4016 The argument is used for internal purposes; do not supply one."
4018 ;; We don't use (interactive-p), since that breaks kbd macros.
4024 \f
4025 ;; Yanking.
4030 "List of special text property handling conditions for yanking.
4031 Each element should have the form (PROP . FUN), where PROP is a
4032 property symbol and FUN is a function. When the `yank' command
4033 inserts text into the buffer, it scans the inserted text for
4034 stretches of text that have `eq' values of the text property
4035 PROP; for each such stretch of text, FUN is called with three
4036 arguments: the property's value in that text, and the start and
4037 end positions of the text.
4039 This is done prior to removing the properties specified by
4040 `yank-excluded-properties'."
4043 function))
4046 ;; This is actually used in subr.el but defcustom does not work there.
4049 intangible invisible keymap local-map mouse-face read-only
4050 yank-handler)
4051 "Text properties to discard when yanking.
4052 The value should be a list of text properties to discard or t,
4053 which means to discard all text properties.
4055 See also `yank-handled-properties'."
4062 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4063 Function is called with two parameters, START and END corresponding to
4064 the value of the mark and point; it is guaranteed that START <= END.
4068 "Replace just-yanked stretch of killed text with a different stretch.
4069 This command is allowed only immediately after a `yank' or a `yank-pop'.
4070 At such a time, the region contains a stretch of reinserted
4071 previously-killed text. `yank-pop' deletes that text and inserts in its
4072 place a different stretch of killed text.
4074 With no argument, the previous kill is inserted.
4075 With argument N, insert the Nth previous kill.
4076 If N is negative, this is a more recent kill.
4078 The sequence of kills wraps around, so that after the oldest one
4079 comes the newest one.
4081 When this command inserts killed text into the buffer, it honors
4082 `yank-excluded-properties' and `yank-handler' as described in the
4083 doc string for `insert-for-yank-1', which see."
4097 ;; Set the window start back where it was in the yank command,
4098 ;; if possible.
4101 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4102 ;; It is cleaner to avoid activation, even though the command
4103 ;; loop would deactivate the mark because we inserted text.
4106 nil)
4110 More precisely, reinsert the most recent kill, which is the
4111 stretch of killed text most recently killed OR yanked. Put point
4112 at the end, and set mark at the beginning without activating it.
4114 With argument N, reinsert the Nth most recent kill.
4116 When this command inserts text into the buffer, it honors the
4117 `yank-handled-properties' and `yank-excluded-properties'
4118 variables, and the `yank-handler' text property. See
4119 `insert-for-yank-1' for details.
4124 ;; If we don't get all the way thru, make last-command indicate that
4125 ;; for the following command.
4133 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4134 ;; It is cleaner to avoid activation, even though the command
4135 ;; loop would deactivate the mark because we inserted text.
4138 ;; If we do get all the way thru, make this-command indicate that.
4141 nil)
4144 "Rotate the yanking point in the kill ring.
4145 With ARG, rotate that many kills forward (or backward, if negative)."
4148 \f
4149 ;; Some kill commands.
4151 ;; Internal subroutine of delete-char
4157 ;; Internal subroutine of backward-delete-char
4164 "The method for untabifying when deleting backward.
4165 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4166 `hungry' -- delete all whitespace, both tabs and spaces;
4167 `all' -- delete all whitespace, including tabs, spaces and newlines;
4168 nil -- just delete one character."
4174 "Delete characters backward, changing tabs into spaces.
4175 The exact behavior depends on `backward-delete-char-untabify-method'.
4176 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4177 Interactively, ARG is the prefix arg (default 1)
4178 and KILLP is t if a prefix arg was specified."
4201 arg)))
4202 ;; Avoid warning about delete-backward-char
4206 "Kill up to and including ARGth occurrence of CHAR.
4207 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4208 Goes backward if ARG is negative; error if CHAR not found."
4211 ;; Avoid "obsolete" warnings for translation-table-for-input.
4219 ;; kill-line and its subroutines.
4222 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4227 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4228 With prefix argument ARG, kill that many lines from point.
4229 Negative arguments kill lines backward.
4230 With zero argument, kills the text before point on the current line.
4233 a number counts as a prefix arg.
4235 To kill a whole line, when point is not at the beginning, type \
4238 If `show-trailing-whitespace' is non-nil, this command will just
4239 kill the rest of the current line, even if there are only
4240 nonblanks there.
4242 If option `kill-whole-line' is non-nil, then this command kills the whole line
4243 including its terminating newline, when used at the beginning of a line
4244 with no argument. As a consequence, you can always kill a whole line
4247 If you want to append the killed line to the last killed text,
4250 If the buffer is read-only, Emacs will beep and refrain from deleting
4251 the line, but put the line in the kill ring anyway. This means that
4252 you can use this command to copy text from a read-only buffer.
4253 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4254 even beep.)"
4257 ;; It is better to move point to the other end of the kill
4258 ;; before killing. That way, in a read-only buffer, point
4259 ;; moves across the text that is copied to the kill ring.
4260 ;; The choice has no effect on undo now that undo records
4261 ;; the value of point from before the command was run.
4271 ;; If trailing whitespace is visible,
4272 ;; don't treat it as nothing.
4282 "Kill current line.
4283 With prefix ARG, kill that many lines starting from the current line.
4284 If ARG is negative, kill backward. Also kill the preceding newline.
4286 If ARG is zero, kill current line but exclude the trailing newline."
4297 ;; We need to kill in two steps, because the previous command
4298 ;; could have been a kill command, in which case the text
4299 ;; before point needs to be prepended to the current kill
4300 ;; ring entry and the text after point appended. Also, we
4301 ;; need to use save-excursion to avoid copying the same text
4302 ;; twice to the kill ring in read-only buffers.
4320 "Move forward by ARG lines, ignoring currently invisible newlines only.
4321 If ARG is negative, move backward -ARG lines.
4322 If ARG is zero, move to the beginning of the current line."
4329 ;; If the newline we just skipped is invisible,
4330 ;; don't count it.
4334 prop
4339 ;; If invisible text follows, and it is a number of complete lines,
4340 ;; skip it.
4346 prop
4362 ;; If the newline we just moved to is invisible,
4363 ;; don't count it.
4368 prop
4373 ;; If invisible text follows, and it is a number of complete lines,
4374 ;; skip it.
4380 prop
4391 nil)))
4394 "Move to end of current visible line."
4396 ;; If the following character is currently invisible,
4397 ;; skip all characters with that same `invisible' property value,
4398 ;; then find the next newline.
4405 prop
4414 \f
4416 "Insert after point the contents of BUFFER.
4417 Puts mark after the inserted text.
4418 BUFFER may be a buffer or a buffer name."
4428 t))))
4433 nil)
4436 "Append to specified buffer the text of the region.
4437 It is inserted into that buffer before its point.
4439 When calling from a program, give three arguments:
4440 BUFFER (or buffer name), START and END.
4441 START and END specify the portion of the current buffer to be copied."
4448 point)
4459 "Prepend to specified buffer the text of the region.
4460 It is inserted into that buffer after its point.
4462 When calling from a program, give three arguments:
4463 BUFFER (or buffer name), START and END.
4464 START and END specify the portion of the current buffer to be copied."
4473 "Copy to specified buffer the text of the region.
4474 It is inserted into that buffer, replacing existing text there.
4476 When calling from a program, give three arguments:
4477 BUFFER (or buffer name), START and END.
4478 START and END specify the portion of the current buffer to be copied."
4486 \f
4490 "Hook run when the mark becomes active.
4491 It is also run at the end of a command, if the mark is active and
4498 "Return this buffer's mark value as integer, or nil if never set.
4500 In Transient Mark mode, this function signals an error if
4501 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4502 or the argument FORCE is non-nil, it disregards whether the mark
4503 is active, and returns an integer or nil in the usual way.
4505 If you are using this in an editing command, you are most likely making
4506 a mistake; see the documentation of `set-mark'."
4511 ;; Behind display-selections-p.
4514 "Deactivate the mark.
4515 If Transient Mark mode is disabled, this function normally does
4516 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4518 Deactivating the mark sets `mark-active' to nil, updates the
4519 primary selection according to `select-active-regions', and runs
4520 `deactivate-mark-hook'.
4522 If Transient Mark mode was temporarily enabled, reset the value
4523 of the variable `transient-mark-mode'; if this causes Transient
4524 Mark mode to be disabled, don't change `mark-active' to nil or
4525 run `deactivate-mark-hook'."
4529 select-active-regions)
4532 ;; The var `saved-region-selection', if non-nil, is the text in
4533 ;; the region prior to the last command modifying the buffer.
4534 ;; Set the selection to that, or to the current region.
4538 ;; If another program has acquired the selection, region
4539 ;; deactivation should not clobber it (Bug#11772).
4558 "Activate the mark.
4559 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4569 "Set this buffer's mark to POS. Don't use this function!
4570 That is to say, don't use this function unless you want
4571 the user to see that the mark has moved, and you want the previous
4572 mark position to be lost.
4574 Normally, when a new mark is set, the old one should go on the stack.
4575 This is why most applications should use `push-mark', not `set-mark'.
4577 Novice Emacs Lisp programmers often try to use the mark for the wrong
4578 purposes. The mark saves a location for the user's convenience.
4579 Most editing commands should not alter the mark.
4580 To remember a location for internal use in the Lisp program,
4581 store it in a Lisp variable. Example:
4583 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4588 ;; Normally we never clear mark-active except in Transient Mark mode.
4589 ;; But when we actually clear out the mark value too, we must
4590 ;; clear mark-active in any mode.
4592 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4593 ;; it should never be nil if the mark is nil.
4599 If nil, region-aware commands treat empty regions as inactive.
4600 If non-nil, region-aware commands treat the region as active as
4601 long as the mark is active, even if the region is empty.
4603 Region-aware commands are those that act on the region if it is
4604 active and Transient Mark mode is enabled, and on the text near
4605 point otherwise."
4611 "Return t if the region is active and it is appropriate to act on it.
4612 This is used by commands that act specially on the region under
4613 Transient Mark mode.
4615 The return value is t if Transient Mark mode is enabled and the
4616 mark is active; furthermore, if `use-empty-active-region' is nil,
4617 the region must not be empty. Otherwise, the return value is nil.
4619 For some commands, it may be appropriate to ignore the value of
4620 `use-empty-active-region'; in that case, use `region-active-p'."
4625 "Return t if Transient Mark mode is enabled and the mark is active.
4627 Some commands act specially on the region when Transient Mark
4628 mode is enabled. Usually, such commands should use
4629 `use-region-p' instead of this function, because `use-region-p'
4630 also checks the value of `use-empty-active-region'."
4632 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4633 ;; without the mark being set (e.g. bug#17324). We really should fix
4634 ;; that problem, but in the mean time, let's make sure we don't say the
4635 ;; region is active when there's no mark.
4649 ;; Normal priority so that a large region doesn't hide all the
4650 ;; overlays within it, but high secondary priority so that if it
4651 ;; ends/starts in the middle of a small overlay, that small overlay
4652 ;; won't hide the region's boundaries.
4654 nrol)
4659 rol)))
4672 start end window rol)))
4675 new)))))))
4700 "Maximum size of mark ring. Start discarding off end if gets this big."
4708 "Maximum size of global mark ring. \
4709 Start discarding off end if gets this big."
4714 "Jump to mark, and pop a new position for mark off the ring.
4715 \(Does not affect global mark ring)."
4725 "Set mark at where point is.
4726 If no prefix ARG and mark is already set there, just activate it.
4727 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4739 will pop the mark twice, and
4741 will pop the mark three times.
4749 "Set the mark where point is, or jump to the mark.
4750 Setting the mark also alters the region, which is the text
4751 between point and mark; this is the closest equivalent in
4754 With no prefix argument, set the mark at point, and push the
4755 old mark position on local mark ring. Also push the old mark on
4756 global mark ring, if the previous mark was set in another buffer.
4758 When Transient Mark Mode is off, immediately repeating this
4759 command activates `transient-mark-mode' temporarily.
4762 jump to the mark, and set the mark from
4763 position popped off the local mark ring (this does not affect the global
4765 mark ring (see `pop-global-mark').
4767 If `set-mark-command-repeat-pop' is non-nil, repeating
4769 off the local (or global) mark ring and jumps there.
4772 argument, unconditionally set mark where point is, even if
4773 `set-mark-command-repeat-pop' is non-nil.
4775 Novice Emacs Lisp programmers often try to use the mark for the wrong
4776 purposes. See the documentation of `set-mark' for more information."
4796 arg)
4810 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4811 If the last global mark pushed was not in the current buffer,
4812 also push LOCATION on the global mark ring.
4813 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4815 Novice Emacs Lisp programmers often try to use the mark for the wrong
4816 purposes. See the documentation of `set-mark' for more information.
4818 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4825 ;; Now push the mark on the global mark ring.
4828 ;; The last global mark pushed was in this same buffer.
4829 ;; Don't push another one.
4830 nil
4839 nil)
4842 "Pop off mark ring into the buffer's actual mark.
4843 Does not set point. Does nothing if mark ring is empty."
4855 "Put the mark where point is now, and point where the mark is now.
4856 This command works even when the mark is not active,
4857 and it reactivates the mark.
4859 If Transient Mark mode is on, a prefix ARG deactivates the mark
4860 if it is active, and otherwise avoids reactivating it. If
4861 Transient Mark mode is off, a prefix ARG enables Transient Mark
4862 mode temporarily."
4876 nil))
4879 "When non-nil, shifted motion keys activate the mark momentarily.
4881 While the mark is activated in this way, any shift-translated point
4882 motion key extends the region, and if Transient Mark mode was off, it
4883 is temporarily turned on. Furthermore, the mark will be deactivated
4884 by any subsequent point motion key that was not shift-translated, or
4885 by any action that normally deactivates the mark in Transient Mark mode.
4887 See `this-command-keys-shift-translated' for the meaning of
4888 shift-translation."
4893 "Activate/deactivate mark depending on invocation thru shift translation.
4894 This function is called by `call-interactively' when a command
4895 with a `^' character in its `interactive' spec is invoked, before
4896 running the command itself.
4898 If `shift-select-mode' is enabled and the command was invoked
4899 through shift translation, set the mark and activate the region
4900 temporarily, unless it was already set in this way. See
4901 `this-command-keys-shift-translated' for the meaning of shift
4902 translation.
4904 Otherwise, if the region has been activated temporarily,
4905 deactivate it, and restore the variable `transient-mark-mode' to
4906 its earlier value."
4913 transient-mark-mode)))
4922 "Toggle Transient Mark mode.
4923 With a prefix argument ARG, enable Transient Mark mode if ARG is
4924 positive, and disable it otherwise. If called from Lisp, enable
4925 Transient Mark mode if ARG is omitted or nil.
4927 Transient Mark mode is a global minor mode. When enabled, the
4928 region is highlighted whenever the mark is active. The mark is
4930 operations that set the mark but whose main purpose is something
4936 Many commands change their behavior when Transient Mark mode is
4937 in effect and the mark is active, by acting on the region instead
4938 of their usual default part of the buffer's text. Examples of
4941 To see the documentation of commands which are sensitive to the
4944 :global t
4945 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4949 "Non-nil means it is ok for commands to call `widen' when they want to.
4950 Some commands will do this in order to go to positions outside
4951 the current accessible part of the buffer.
4953 If `widen-automatically' is nil, these commands will do something else
4957 "Whether the currently executing code is performing an essential task.
4958 This variable should be non-nil only when running code which should not
4959 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4960 user for a password when we are simply scanning a set of files in the
4961 background or displaying possible completions before the user even asked
4965 "Pop off global mark ring and jump to the top location."
4967 ;; Pop entries which refer to non-existent buffers.
4985 \f
4987 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4993 "Move cursor vertically down ARG lines.
4994 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4995 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4996 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4997 function will not vscroll.
4999 ARG defaults to 1.
5001 If there is no character in the target line exactly under the current column,
5002 the cursor is positioned after the character in that line which spans this
5003 column, or at the end of the line if it is not long enough.
5004 If there is no line in the buffer after this one, behavior depends on the
5005 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5006 to create a line, and moves the cursor to that line. Otherwise it moves the
5007 cursor to the end of the buffer.
5009 If the variable `line-move-visual' is non-nil, this command moves
5010 by display lines. Otherwise, it moves by buffer lines, without
5011 taking variable-width characters or continued lines into account.
5014 a semipermanent goal column for this command.
5015 Then instead of trying to move exactly vertically (or as close as possible),
5016 this command moves to the specified goal column (or as close as possible).
5017 The goal column is stored in the variable `goal-column', which is nil
5018 when there is no goal column. Note that setting `goal-column'
5019 overrides `line-move-visual' and causes this command to move by buffer
5020 lines rather than by display lines."
5026 ;; When adding a newline, don't expand an abbrev.
5037 nil)
5040 "Move cursor vertically up ARG lines.
5041 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5042 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5043 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5044 function will not vscroll.
5046 ARG defaults to 1.
5048 If there is no character in the target line exactly over the current column,
5049 the cursor is positioned after the character in that line which spans this
5050 column, or at the end of the line if it is not long enough.
5052 If the variable `line-move-visual' is non-nil, this command moves
5053 by display lines. Otherwise, it moves by buffer lines, without
5054 taking variable-width characters or continued lines into account.
5057 a semipermanent goal column for this command.
5058 Then instead of trying to move exactly vertically (or as close as possible),
5059 this command moves to the specified goal column (or as close as possible).
5060 The goal column is stored in the variable `goal-column', which is nil
5061 when there is no goal column. Note that setting `goal-column'
5062 overrides `line-move-visual' and causes this command to move by buffer
5063 lines rather than by display lines."
5074 nil)
5077 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5078 This means moving to the end of each line moved onto.
5079 The beginning of a blank line does not count as the end of a line.
5080 This has no effect when the variable `line-move-visual' is non-nil."
5086 A non-nil setting overrides the variable `line-move-visual', which see."
5093 "Current goal column for vertical motion.
5094 It is the column where point was at the start of the current run
5095 of vertical motion commands.
5097 When moving by visual lines via the function `line-move-visual', it is a cons
5098 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5099 divided by the default column width, and HSCROLL is the number of
5100 columns by which window is scrolled from left margin.
5102 When the `track-eol' feature is doing its job, the value is
5106 "Non-nil means commands that move by lines ignore invisible newlines.
5107 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5108 as if newlines that are invisible didn't exist, and count
5109 only visible newlines. Thus, moving across across 2 newlines
5110 one of which is invisible will be counted as a one-line move.
5111 Also, a non-nil value causes invisible text to be ignored when
5112 counting columns for the purposes of keeping point in the same
5115 Outline mode sets this."
5120 "When non-nil, `line-move' moves point by visual lines.
5121 This movement is based on where the cursor is displayed on the
5122 screen, instead of relying on buffer contents alone. It takes
5123 into account variable-width characters and line continuation.
5124 If nil, `line-move' moves point by logical lines.
5125 A non-nil setting of `goal-column' overrides the value of this variable
5126 and forces movement by logical lines.
5127 A window that is horizontally scrolled also forces movement by logical
5128 lines."
5133 ;; Only used if display-graphic-p.
5137 "Return the height in pixels of the current buffer's default face font."
5141 ;; Avoid calling font-info if the frame's default font was
5142 ;; not changed since the frame was created. That's because
5143 ;; font-info is expensive for some fonts, see bug #14838.
5149 "Return the pixel height of current buffer's default-face text line.
5151 The value includes `line-spacing', if any, defined for the buffer
5152 or the frame."
5165 "Return the number of screen lines in the text area of the selected window.
5167 This is different from `window-text-height' in that this function counts
5168 lines in units of the height of the font used by the default face displayed
5169 in the window, not in units of the frame's default font, and also accounts
5170 for `line-spacing', if any, defined for the window's buffer or frame.
5172 The value is a floating-point number."
5177 ;; Returns non-nil if partial move was done.
5180 ;; Move backward (up).
5181 ;; If already vscrolled, reduce vscroll
5187 ;; Move forward (down).
5200 py vs last-line)
5220 col-row)
5225 ;; VPOS > 0 means the last line is only partially visible.
5226 ;; But if the part that is visible is at least as tall as the
5227 ;; default font, that means the line is actually fully
5228 ;; readable, and something like line-spacing is hidden. So in
5229 ;; that case we accept the last line in the window as still
5230 ;; visible, and consider the margin as starting one line
5231 ;; later.
5239 ;; If last line of window is fully visible, and vscrolling
5240 ;; more would make this line invisible, move forward.
5245 nil)
5246 ;; If cursor is not in the bottom scroll margin, and the
5247 ;; current line is is not too tall, move forward.
5249 vpos
5252 nil)
5253 ;; When already vscrolled, we vscroll some more if we can,
5254 ;; or clear vscroll and move forward at end of tall image.
5259 ;; If cursor just entered the bottom scroll margin, move forward,
5260 ;; but also optionally vscroll one line so redisplay won't recenter.
5264 ;; Don't vscroll if the partially-visible line at window
5265 ;; bottom is not too tall (a.k.a. "just one more text
5266 ;; line"): in that case, we do want redisplay to behave
5267 ;; normally, i.e. recenter or whatever.
5268 ;;
5269 ;; Note: ROWH + RBOT from the value returned by
5270 ;; pos-visible-in-window-p give the total height of the
5271 ;; partially-visible glyph row at the end of the window. As
5272 ;; we are dealing with floats, we disregard sub-pixel
5273 ;; discrepancies between that and DLH.
5277 t)
5278 ;; If there are lines above the last line, scroll-up one line.
5281 t)
5282 ;; Finally, start vscroll.
5287 ;; This is like line-move-1 except that it also performs
5288 ;; vertical scrolling of tall images if appropriate.
5289 ;; That is not really a clean thing to do, since it mixes
5290 ;; scrolling with cursor motion. But so far we don't have
5291 ;; a cleaner solution to the problem of making C-n do something
5292 ;; useful given a tall image.
5294 "Move forward ARG lines.
5295 If NOERROR, don't signal an error if we can't move ARG lines.
5296 TO-END is unused.
5297 TRY-VSCROLL controls whether to vscroll tall lines: if either
5298 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5299 not vscroll."
5303 ;; Only vscroll for single line moves
5305 ;; Under scroll-conservatively, the display engine
5306 ;; does this better.
5308 ;; But don't vscroll in a keyboard macro.
5314 ;; Display-based column are incompatible with goal-column.
5316 ;; When the text in the window is scrolled to the left,
5317 ;; display-based motion doesn't make sense (because each
5318 ;; logical line occupies exactly one screen line).
5320 ;; Likewise when the text _was_ scrolled to the left
5321 ;; when the current run of vertical motion commands
5322 ;; started.
5325 auto-hscroll-mode
5327 (>= temporary-goal-column
5330 ;; If we moved into a tall line, set vscroll to make
5331 ;; scrolling through tall images more smooth.
5335 winh)
5341 nil
5345 ;; Display-based alternative to line-move-1.
5346 ;; Arg says how many lines to move. The value is t if we can move the
5347 ;; specified number of lines.
5349 "Move ARG lines forward.
5350 If NOERROR, don't signal an error if we can't move that many lines."
5353 target-hscroll)
5354 ;; Check if the previous command was a line-motion command, or if
5355 ;; we were called from some other command.
5358 ;; If so, there's no need to reset `temporary-goal-column',
5359 ;; but we may need to hscroll.
5363 ;; Otherwise, we should reset `temporary-goal-column'.
5366 ;; Handle the `overflow-newline-into-fringe' case:
5373 hscroll))))))
5376 ;; vertical-motion can move more than it was asked to if it moves
5377 ;; across display strings with newlines. We don't want to ring
5378 ;; the bell and announce beginning/end of buffer in that case.
5384 temporary-goal-column))
5385 arg))
5386 arg))
5392 temporary-goal-column))
5393 arg))
5394 arg)))
5397 ;; If the goal column lies on a display string,
5398 ;; `vertical-motion' advances the cursor to the end
5399 ;; of the string. For arg < 0, this can cause the
5400 ;; cursor to get stuck. (Bug#3020).
5404 nil)))))
5406 ;; This is the guts of next-line and previous-line.
5407 ;; Arg says how many lines to move.
5408 ;; The value is t if we can move the specified number of lines.
5410 ;; Don't run any point-motion hooks, and disregard intangibility,
5411 ;; for intermediate positions.
5423 ;; Don't count beg of empty line as end of line
5424 ;; unless we just did explicit end-of-line.
5426 most-positive-fixnum
5430 line-move-ignore-invisible))
5431 ;; Use just newline characters.
5432 ;; Set ARG to 0 if we move as many lines as requested.
5435 ;; This way of moving forward ARG lines
5436 ;; verifies that we have a newline after the last one.
5437 ;; It doesn't get confused by intangible text.
5446 'beginning-of-buffer
5448 nil)))
5449 ;; Move by arg lines, but ignore invisible ones.
5452 ;; If the following character is currently invisible,
5453 ;; skip all characters with that same `invisible' property value.
5456 ;; Move a line.
5457 ;; We don't use `end-of-line', since we want to escape
5458 ;; from field boundaries occurring exactly at point.
5464 ;; If there's no invisibility here, move over the newline.
5473 ;; We avoid vertical-motion when possible
5474 ;; because that has to fontify.
5476 ;; Otherwise move a more sophisticated way.
5483 ;; The logic of this is the same as the loop above,
5484 ;; it just goes in the other direction.
5486 ;; For completely consistency with the forward-motion
5487 ;; case, we should call beginning-of-line here.
5488 ;; However, if point is inside a field and on a
5489 ;; continued line, the call to (vertical-motion -1)
5490 ;; below won't move us back far enough; then we return
5491 ;; to the same column in line-move-finish, and point
5492 ;; gets stuck -- cyd
5510 ;; if our target is the middle of this line.
5515 ;; This is the value the function returns.
5519 ;; If we did not move down as far as desired, at least go
5520 ;; to end of line. Be sure to call point-entered and
5521 ;; point-left-hooks.
5527 ;; If we did not move up as far as desired,
5528 ;; at least go to beginning of line.
5540 ;; Set REPEAT to t to repeat the whole thing.
5547 ;; Compute the end of the line
5548 ;; ignoring effectively invisible newlines.
5550 ;; Like end-of-line but ignores fields.
5557 ;; Move to the desired column.
5560 ;; Corner case: suppose we start out in a field boundary in
5561 ;; the middle of a continued line. When we get to
5562 ;; line-move-finish, point is at the start of a new *screen*
5563 ;; line but the same text line; then line-move-to-column would
5564 ;; move us backwards. Test using C-n with point on the "x" in
5565 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5572 ;; Process intangibility within a line.
5573 ;; With inhibit-point-motion-hooks bound to nil, a call to
5574 ;; goto-char moves point past intangible text.
5576 ;; However, inhibit-point-motion-hooks controls both the
5577 ;; intangibility and the point-entered/point-left hooks. The
5578 ;; following hack avoids calling the point-* hooks
5579 ;; unnecessarily. Note that we move *forward* past intangible
5580 ;; text when the initial and final points are the same.
5585 ;; If intangibility moves us to a different (later) place
5586 ;; in the same line, use that as the destination.
5589 ;; If that position is "too late",
5590 ;; try the previous allowable position.
5591 ;; See if it is ok.
5594 ;; If going forward, don't accept the previous
5595 ;; allowable position if it is before the target line.
5597 ;; If going backward, don't accept the previous
5598 ;; allowable position if it is still after the target line.
5601 ;; As a last resort, use the end of the line.
5604 ;; Now move to the updated destination, processing fields
5605 ;; as well as intangibility.
5609 ;; Ignore field boundaries if the initial and final
5610 ;; positions have the same `field' property, even if the
5611 ;; fields are non-contiguous. This seems to be "nicer"
5612 ;; behavior in many situations.
5615 new
5619 ;; If all this moved us to a different line,
5620 ;; retry everything within that new line.
5622 ;; Repeat the intangibility and field processing.
5626 "Try to find column COL, considering invisibility.
5627 This function works only in certain cases,
5628 because what we really need is for `move-to-column'
5629 and `current-column' to be able to ignore invisible text."
5638 ;; If the following character is currently invisible,
5639 ;; skip all characters with that same `invisible' property value.
5643 ;; Have we advanced to a larger column position?
5645 ;; We have made some progress towards the desired column.
5646 ;; See if we can make any further progress.
5648 ;; Otherwise, go to the place we originally found
5649 ;; and move back over invisible text.
5650 ;; that will get us to the same place on the screen
5651 ;; but with a more reasonable buffer position.
5658 "Move point to end of current line as displayed.
5659 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5660 If point reaches the beginning or end of buffer, it stops there.
5662 To ignore the effects of the `intangible' text or overlay
5663 property, bind `inhibit-point-motion-hooks' to t.
5664 If there is an image in the current line, this function
5665 disregards newlines that are part of the text on which the image
5666 rests."
5676 ;; With bidi reordering, we may not be at bol,
5677 ;; so make sure we are.
5692 ;; If we skipped something intangible and now we're not
5693 ;; really at eol, keep going.
5698 "Move point to beginning of current line as displayed.
5699 \(If there's an image in the line, this disregards newlines
5700 which are part of the text that the image rests on.)
5702 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5703 If point reaches the beginning or end of buffer, it stops there.
5704 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5709 first-vis first-vis-field-value)
5711 ;; Move by lines, if ARG is not 1 (the default).
5716 ;; Move to beginning-of-line, ignoring fields and invisible text.
5722 ;; Now find first visible char in the line.
5727 ;; See if fields would stop us from reaching FIRST-VIS.
5732 ;; If yes, obey them.
5733 first-vis-field-value
5734 ;; Otherwise, move to START with attention to fields.
5735 ;; (It is possible that fields never matter in this case.)
5740 ;; Many people have said they rarely use this feature, and often type
5741 ;; it by accident. Maybe it shouldn't even be on a key.
5746 Those commands will move to this position in the line moved to
5747 rather than trying to keep the same horizontal position.
5748 With a non-nil argument ARG, clears out the goal column
5750 The goal column is stored in the variable `goal-column'."
5757 ;; The older method below can be erroneous if `set-goal-column' is bound
5758 ;; to a sequence containing %
5759 ;;(message (substitute-command-keys
5760 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5761 ;;goal-column)
5768 )
5769 nil)
5770 \f
5771 ;;; Editing based on visual lines, as opposed to logical lines.
5774 "Move point to end of current visual line.
5775 With argument N not nil or 1, move forward N - 1 visual lines first.
5776 If point reaches the beginning or end of buffer, it stops there.
5777 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5783 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5784 ;; constrain to field boundaries, so we don't either.
5788 "Move point to beginning of current visual line.
5789 With argument N not nil or 1, move forward N - 1 visual lines first.
5790 If point reaches the beginning or end of buffer, it stops there.
5791 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5799 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5803 "Kill the rest of the visual line.
5804 With prefix argument ARG, kill that many visual lines from point.
5805 If ARG is negative, kill visual lines backward.
5806 If ARG is zero, kill the text before point on the current visual
5807 line.
5809 If you want to append the killed line to the last killed text,
5812 If the buffer is read-only, Emacs will beep and refrain from deleting
5813 the line, but put the line in the kill ring anyway. This means that
5814 you can use this command to copy text from a read-only buffer.
5815 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5816 even beep.)"
5818 ;; Like in `kill-line', it's better to move point to the other end
5819 ;; of the kill before killing.
5827 ;; Skip any trailing whitespace at the end of the visual line.
5828 ;; We used to do this only if `show-trailing-whitespace' is
5829 ;; nil, but that's wrong; the correct thing would be to check
5830 ;; whether the trailing whitespace is highlighted. But, it's
5831 ;; OK to just do this unconditionally.
5838 "Move cursor vertically down ARG lines.
5839 This is identical to `next-line', except that it always moves
5840 by logical lines instead of visual lines, ignoring the value of
5841 the variable `line-move-visual'."
5848 "Move cursor vertically up ARG lines.
5849 This is identical to `previous-line', except that it always moves
5850 by logical lines instead of visual lines, ignoring the value of
5851 the variable `line-move-visual'."
5858 "Editing based on visual lines."
5867 ;; These keybindings interfere with xterm function keys. Are
5868 ;; there any other suitable bindings?
5869 ;; (define-key map "\M-[" 'previous-logical-line)
5870 ;; (define-key map "\M-]" 'next-logical-line)
5871 map))
5874 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5875 The value should be a list of the form (LEFT RIGHT), where LEFT
5876 and RIGHT are symbols representing the bitmaps to display, to
5877 indicate wrapped lines, in the left and right fringes respectively.
5878 See also `fringe-indicator-alist'.
5879 The default is not to display fringe indicators for wrapped lines.
5880 This variable does not affect fringe indicators displayed for
5881 other purposes."
5896 'continuation
5903 "Toggle visual line based editing (Visual Line mode).
5904 With a prefix argument ARG, enable Visual Line mode if ARG is
5905 positive, and disable it otherwise. If called from Lisp, enable
5906 the mode if ARG is omitted or nil.
5908 When Visual Line mode is enabled, `word-wrap' is turned on in
5909 this buffer, and simple editing commands are redefined to act on
5910 visual lines, not logical lines. See Info node `Visual Line
5911 Mode' for details."
5912 :keymap visual-line-mode-map
5918 ;; Save the local values of some variables, to be restored if
5919 ;; visual-line-mode is turned off.
5921 truncate-partial-width-windows
5922 word-wrap fringe-indicator-alist))
5925 visual-line--saved-state)))
5929 word-wrap t
5930 fringe-indicator-alist
5932 fringe-indicator-alist)))
5946 visual-line-mode turn-on-visual-line-mode)
5948 \f
5950 "Interchange characters around point, moving forward one character.
5951 With prefix arg ARG, effect is to take character before point
5952 and drag it forward past ARG other characters (backward if ARG negative).
5953 If no argument and at end of line, the previous two chars are exchanged."
5961 "Interchange words around point, leaving point at end of them.
5962 With prefix arg ARG, effect is to take word before or around point
5963 and drag it forward past ARG other words (backward if ARG negative).
5964 If ARG is zero, the words around or after point and around or after mark
5965 are interchanged."
5966 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5972 Does not work on a sexp that point is in the middle of
5973 if it is a list or string."
5977 ;; Here we should try to simulate the behavior of
5978 ;; (cons (progn (forward-sexp x) (point))
5979 ;; (progn (forward-sexp (- x)) (point)))
5980 ;; Except that we don't want to rely on the second forward-sexp
5981 ;; putting us back to where we want to be, since forward-sexp-function
5982 ;; might do funny things like infix-precedence.
5987 ;; Jumping over a symbol. We might be inside it, mind you.
5992 ;; Otherwise, we're between sexps. Take a step back before jumping
5993 ;; to make sure we'll obey the same precedence no matter which direction
5994 ;; we're going.
5999 'skip-syntax-forward
6006 "Exchange current line and previous line, leaving point after both.
6007 With argument ARG, takes previous line and moves it past ARG lines.
6008 With argument 0, interchanges line point is in with line mark is in."
6014 ;; Move forward over ARG lines,
6015 ;; but create newlines if necessary.
6022 arg))
6024 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6025 ;; which seems inconsistent with the ARG /= 0 case.
6026 ;; FIXME document SPECIAL.
6028 "Subroutine to do the work of transposing objects.
6029 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6030 moves forward by units of the given object (e.g. forward-sentence,
6031 forward-paragraph). If ARG is zero, exchanges the current object
6032 with the one containing mark. If ARG is an integer, moves the
6033 current object past ARG following (if ARG is positive) or
6034 preceding (if ARG is negative) objects, leaving point after the
6035 current object."
6040 pos1 pos2)
6068 ;; This sequence of insertions attempts to preserve marker
6069 ;; positions at the start and end of the transposed objects.
6083 \f
6085 "Move backward until encountering the beginning of a word.
6086 With argument ARG, do this that many times.
6087 If ARG is omitted or nil, move point backward one word."
6092 "Set mark ARG words away from point.
6094 move to with the same argument.
6095 Interactively, if this command is repeated
6096 or (in Transient Mark mode) if the mark is active,
6097 it marks the next ARG words after the ones already marked."
6114 nil t))))
6117 "Kill characters forward until encountering the end of a word.
6118 With argument ARG, do this that many times."
6123 "Kill characters backward until encountering the beginning of a word.
6124 With argument ARG, do this that many times."
6129 "Return the symbol or word that point is on (or a nearby one) as a string.
6130 The return value includes no text properties.
6131 If optional arg STRICT is non-nil, return nil unless point is within
6132 or adjacent to a symbol or word. In all cases the value can be nil
6133 if there is no word nearby.
6134 The function, belying its name, normally finds a symbol.
6135 If optional arg REALLY-WORD is non-nil, it finds just a word."
6144 ;; Point is neither within nor adjacent to a word.
6146 ;; Look for preceding word in same line.
6149 ;; No preceding word in same line.
6150 ;; Look for following word in same line.
6159 ;; If we found something nonempty, return it as a string.
6162 \f
6164 "String for filling to insert at front of new line, or nil for none."
6166 string)
6172 "Regexp to match lines which should not be auto-filled."
6174 regexp)
6178 "The default value for `normal-auto-fill-function'.
6179 This is the default auto-fill function, some major modes use a different one.
6180 Returns t if it really did any work."
6190 nil ;; Auto-filling not required
6194 ;; Choose a fill-prefix automatically.
6202 ;; Use auto-indentation rather than a guessed empty prefix.
6208 ;; Determine where to split the line.
6221 ;; See whether the place we found is any good.
6225 ;; There is no use breaking at end of line.
6227 ;; It is futile to split at the end of the prefix
6228 ;; since we would just insert the prefix again.
6230 ;; Don't split right after a comment starter
6231 ;; since we would just make another comment starter.
6236 limit t)
6238 ;; No good place to break => stop trying.
6240 ;; Ok, we have a useful place to break the line. Do it.
6242 ;; If point is at the fill-point, do not `save-excursion'.
6243 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6244 ;; point will end up before it rather than after it.
6252 ;; Now do justification, if required
6257 ;; If making the new line didn't reduce the hpos of
6258 ;; the end of the line, then give up now;
6259 ;; trying again will not help.
6262 ;; Justify last line.
6264 t)))
6267 "Mode-specific function which line breaks and continues a comment.
6268 This function is called during auto-filling when a comment syntax
6269 is defined.
6270 The function should take a single optional argument, which is a flag
6274 "Break line at point and indent.
6275 If a comment syntax is defined, call `comment-indent-new-line'.
6277 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6278 unless optional argument SOFT is non-nil."
6282 ;; Insert the newline before removing empty space so that markers
6283 ;; get preserved better.
6289 ;; Blindly trust a non-adaptive fill-prefix.
6295 ;; If there's an adaptive prefix, use it unless we're inside
6296 ;; a comment and the prefix is not a comment starter.
6300 ;; If we're not inside a comment, just try to indent.
6304 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6308 ;; `functions' and `hooks' are usually unsafe to set, but setting
6309 ;; auto-fill-function to nil in a file-local setting is safe and
6310 ;; can be useful to prevent auto-filling.
6314 "Toggle automatic line breaking (Auto Fill mode).
6315 With a prefix argument ARG, enable Auto Fill mode if ARG is
6316 positive, and disable it otherwise. If called from Lisp, enable
6317 the mode if ARG is omitted or nil.
6319 When Auto Fill mode is enabled, inserting a space at a column
6320 beyond `current-fill-column' automatically breaks the line at a
6321 previous space.
6323 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6324 non-`nil'.
6326 The value of `normal-auto-fill-function' specifies the function to use
6327 for `auto-fill-function' when turning Auto Fill mode on."
6332 ;; This holds a document string used to document auto-fill-mode.
6334 "Automatically break line at a previous space, in insertion of text."
6335 nil)
6338 "Unconditionally turn on Auto Fill mode."
6342 "Unconditionally turn off Auto Fill mode."
6348 "Set `fill-column' to specified argument.
6353 ;; We used to use current-column silently, but C-x f is too easily
6354 ;; typed as a typo for C-x C-f, so we turned it into an error and
6355 ;; now an interactive prompt.
6360 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6364 \f
6366 "Set `selective-display' to ARG; clear it if no arg.
6367 When the value of `selective-display' is a number > 0,
6368 lines whose indentation is >= that value are not displayed.
6369 The variable `selective-display' has a separate value for each buffer."
6389 "Toggle truncating of long lines for the current buffer.
6390 When truncating is off, long lines are folded.
6391 With prefix argument ARG, truncate long lines if ARG is positive,
6392 otherwise fold them. Note that in side-by-side windows, this
6393 command has no effect if `truncate-partial-width-windows' is
6394 non-nil."
6406 nil t)))
6411 "Toggle whether to use word-wrapping for continuation lines.
6412 With prefix argument ARG, wrap continuation lines at word boundaries
6413 if ARG is positive, otherwise wrap them at the right screen edge.
6414 This command toggles the value of `word-wrap'. It has no effect
6415 if long lines are truncated."
6431 "Toggle Overwrite mode.
6432 With a prefix argument ARG, enable Overwrite mode if ARG is
6433 positive, and disable it otherwise. If called from Lisp, enable
6434 the mode if ARG is omitted or nil.
6436 When Overwrite mode is enabled, printing characters typed in
6437 replace existing text on a one-for-one basis, rather than pushing
6438 it to the right. At the end of a line, such characters extend
6439 the line. Before a tab, such characters insert until the tab is
6441 overwrite mode; this is supposed to make it easier to insert
6442 characters when necessary."
6447 "Toggle Binary Overwrite mode.
6448 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6449 is positive, and disable it otherwise. If called from Lisp,
6450 enable the mode if ARG is omitted or nil.
6452 When Binary Overwrite mode is enabled, printing characters typed
6453 in replace existing text. Newlines are not treated specially, so
6454 typing at the end of a line joins the line to the next, with the
6455 typed character between them. Typing before a tab character
6456 simply replaces the tab with the character typed.
6458 ordinary typing characters do.
6460 Note that Binary Overwrite mode is not its own minor mode; it is
6461 a specialization of overwrite mode, entered by setting the
6462 `overwrite-mode' variable to `overwrite-mode-binary'."
6467 "Toggle line number display in the mode line (Line Number mode).
6468 With a prefix argument ARG, enable Line Number mode if ARG is
6469 positive, and disable it otherwise. If called from Lisp, enable
6470 the mode if ARG is omitted or nil.
6472 Line numbers do not appear for very large buffers and buffers
6473 with very long lines; see variables `line-number-display-limit'
6474 and `line-number-display-limit-width'."
6478 "Toggle column number display in the mode line (Column Number mode).
6479 With a prefix argument ARG, enable Column Number mode if ARG is
6480 positive, and disable it otherwise.
6482 If called from Lisp, enable the mode if ARG is omitted or nil."
6486 "Toggle buffer size display in the mode line (Size Indication mode).
6487 With a prefix argument ARG, enable Size Indication mode if ARG is
6488 positive, and disable it otherwise.
6490 If called from Lisp, enable the mode if ARG is omitted or nil."
6494 "Toggle auto-saving in the current buffer (Auto Save mode).
6495 With a prefix argument ARG, enable Auto Save mode if ARG is
6496 positive, and disable it otherwise.
6498 If called from Lisp, enable the mode if ARG is omitted or nil."
6500 ;; If auto-save is off because buffer has shrunk,
6501 ;; then toggling should turn it on.
6509 buffer-file-name)
6511 ;; If -1 was stored here, to temporarily turn off saving,
6512 ;; turn it back on.
6515 \f
6517 "Blinking matching of parens and expressions."
6522 "Non-nil means show matching open-paren when close-paren is inserted.
6523 If t, highlight the paren. If `jump', move cursor to its position."
6531 "Non-nil means show matching open-paren when it is on screen.
6532 If nil, don't show it (but the open-paren can still be shown
6533 when it is off screen).
6535 This variable has no effect if `blink-matching-paren' is nil.
6536 \(In that case, the open-paren is never shown.)
6537 It is also ignored if `show-paren-mode' is enabled."
6542 "If non-nil, maximum distance to search backwards for matching open-paren.
6543 If nil, search stops at the beginning of the accessible portion of the buffer."
6549 "Time in seconds to delay after showing a matching paren."
6554 "If nil, `blink-matching-paren' ignores comments.
6555 More precisely, when looking for the matching parenthesis,
6556 it skips the contents of comments that end before point."
6561 "Return whether or not START...END are matching parens.
6562 END is the current point and START is the blink position.
6563 START might be nil if no matching starter was found.
6564 Returns non-nil if we find there is a mismatch."
6569 ;; For self-matched chars like " and $, we can't know when they're
6570 ;; mismatched or unmatched, so we can only do it for parens.
6575 ;; The cdr might hold a new paren-class info rather than
6576 ;; a matching-char info, in which case the two CDRs
6577 ;; should match.
6581 "Function to check parentheses mismatches.
6582 The function takes two arguments (START and END) where START is the
6583 position just before the opening token and END is the position right after.
6584 START can be nil, if it was not found.
6591 ol)
6595 "Momentarily highlight the beginning of the sexp before point."
6598 blink-matching-paren)
6608 oldpos))
6616 ;; backward-sexp skips backward over prefix chars,
6617 ;; so move back to the matching paren.
6638 ;; Matching open within window, temporarily move to or highlight
6639 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6640 ;; is non-nil.
6657 ;; Show what precedes the open in its line, if anything.
6662 ;; Show what follows the open in its line, if anything.
6669 ;; Otherwise show the previous nonblank line,
6670 ;; if there is one.
6679 ;; Replace the newline and other whitespace with `...'.
6680 "..."
6682 ;; There is nothing to show except the char itself.
6688 "Function called, if non-nil, whenever a close parenthesis is inserted.
6694 blink-paren-function
6697 ;; Verify an even number of quoting characters precede the close.
6708 ;; Most likely, this hook is nil, so this arg doesn't matter,
6709 ;; but I use it as a reminder that this function usually
6710 ;; likes to be run after others since it does
6711 ;; `sit-for'. That's also the reason it get a `priority' prop
6712 ;; of 100.
6714 \f
6715 ;; This executes C-g typed while Emacs is waiting for a command.
6716 ;; Quitting out of a program does not go through here;
6717 ;; that happens in the QUIT macro at the C code level.
6719 "Signal a `quit' condition.
6720 During execution of Lisp code, this character causes a quit directly.
6721 At top-level, as an editor command, this simply beeps."
6723 ;; Avoid adding the region to the window selection.
6731 ;; Force the next redisplay cycle to remove the "Def" indicator from
6732 ;; all the mode lines.
6746 This command can exit an interactive command such as `query-replace',
6747 can clear out a prefix argument or a region,
6748 can get out of the minibuffer or other recursive edit,
6749 cancel the use of the current buffer (for special-purpose buffers),
6750 or go back to just one window (by deleting all but the selected window)."
6758 nil)
6769 "Play sound stored in FILE.
6770 VOLUME and DEVICE correspond to the keywords of the sound
6771 specification for `play-sound'."
6781 \f
6783 "Your preference for a mail reading package.
6784 This is used by some keybindings which support reading mail.
6785 See also `mail-user-agent' concerning sending mail."
6795 "Your preference for a mail composition package.
6796 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6797 outgoing email message. This variable lets you specify which
6798 mail-sending package you prefer.
6800 Valid values include:
6802 `message-user-agent' -- use the Message package.
6803 See Info node `(message)'.
6804 `sendmail-user-agent' -- use the Mail package.
6805 See Info node `(emacs)Sending Mail'.
6806 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6807 See Info node `(mh-e)'.
6808 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6809 paraphernalia if Gnus is running, particularly
6810 the Gcc: header for archiving.
6812 Additional valid symbols may be available; check with the author of
6813 your package for details. The function should return non-nil if it
6814 succeeds.
6816 See also `read-mail-command' concerning reading mail."
6819 message-user-agent)
6822 sendmail-user-agent)
6825 mh-e-user-agent)
6828 gnus-user-agent)
6834 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6835 If the value of `mail-user-agent' is the default, and the user
6836 appears to have customizations applying to the old default,
6837 `compose-mail' issues a warning."
6843 "If the buffer starts with a mail header, move point to the header's end.
6844 Otherwise, moves to `point-min'.
6845 The end of the header is the start of the next line, if there is one,
6846 else the end of the last line. This function obeys RFC822."
6852 ;; Used by Rmail (e.g., rmail-forward).
6854 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6858 switch-function yank-action send-actions
6859 return-action)
6860 "Start composing a mail message to send.
6861 This uses the user's chosen mail composition package
6862 as selected with the variable `mail-user-agent'.
6863 The optional arguments TO and SUBJECT specify recipients
6864 and the initial Subject field, respectively.
6866 OTHER-HEADERS is an alist specifying additional
6867 header fields. Elements look like (HEADER . VALUE) where both
6868 HEADER and VALUE are strings.
6870 CONTINUE, if non-nil, says to continue editing a message already
6871 being composed. Interactively, CONTINUE is the prefix argument.
6873 SWITCH-FUNCTION, if non-nil, is a function to use to
6874 switch to and display the buffer used for mail composition.
6876 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6877 to insert the raw text of the message being replied to.
6878 It has the form (FUNCTION . ARGS). The user agent will apply
6879 FUNCTION to ARGS, to insert the raw text of the original message.
6880 \(The user agent will also run `mail-citation-hook', *after* the
6881 original text has been inserted in this way.)
6883 SEND-ACTIONS is a list of actions to call when the message is sent.
6884 Each action has the form (FUNCTION . ARGS).
6886 RETURN-ACTION, if non-nil, is an action for returning to the
6887 caller. It has the form (FUNCTION . ARGS). The function is
6888 called after the mail has been sent or put aside, and the mail
6889 buffer buried."
6893 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6894 ;; from sendmail-user-agent to message-user-agent. Some users may
6895 ;; encounter incompatibilities. This hack tries to detect problems
6896 ;; and warn about them.
6901 mail-yank-hooks mail-archive-file-name
6902 mail-default-reply-to mail-mailing-lists
6903 mail-self-blind))
6910 The default mail mode is now Message mode.
6911 You have the following Mail mode variable%s customized:
6913 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6920 yank-action send-actions return-action)))
6923 yank-action send-actions
6924 return-action)
6928 'switch-to-buffer-other-window yank-action send-actions
6929 return-action))
6932 yank-action send-actions
6933 return-action)
6937 'switch-to-buffer-other-frame yank-action send-actions
6938 return-action))
6940 \f
6942 "History of values entered with `set-variable'.
6944 Maximum length of the history list is determined by the value
6948 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6949 VARIABLE should be a user option variable name, a Lisp variable
6950 meant to be customized by users. You should enter VALUE in Lisp syntax,
6951 so if you want VALUE to be a string, you must surround it with doublequotes.
6952 VALUE is used literally, not evaluated.
6954 If VARIABLE has a `variable-interactive' property, that is used as if
6955 it were the arg to `interactive' (which see) to interactively read VALUE.
6957 If VARIABLE has been defined with `defcustom', then the type information
6958 in the definition is used to check that VALUE is valid.
6960 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6965 default-var)
6981 var obsolete)
6984 ;; Use VAR's `variable-interactive' property
6985 ;; as an interactive spec for prompting.
6988 arg))
6990 read-expression-map t
6991 'set-variable-value-history
7000 ;; Match with custom type.
7012 ;; Force a thorough redisplay for the case that the variable
7013 ;; has an effect on the display, like `tab-width' has.
7015 \f
7016 ;; Define the major mode for lists of completions.
7026 (define-key map [right] 'next-completion)
7028 (define-key map [backtab] 'previous-completion)
7029 (define-key map "q" 'quit-window)
7030 (define-key map "z" 'kill-this-buffer)
7031 map)
7032 "Local map for completion list buffers.")
7034 ;; Completion mode is suitable only for specially formatted data.
7035 (put 'completion-list-mode 'mode-class 'special)
7037 (defvar completion-reference-buffer nil
7038 "Record the buffer that was current when the completion list was requested.
7039 This is a local variable in the completion list buffer.
7040 Initial value is nil to avoid some compiler warnings.")
7042 (defvar completion-no-auto-exit nil
7043 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7044 This also applies to other functions such as `choose-completion'.")
7046 (defvar completion-base-position nil
7047 "Position of the base of the text corresponding to the shown completions.
7048 This variable is used in the *Completions* buffers.
7049 Its value is a list of the form (START END) where START is the place
7050 where the completion should be inserted and END (if non-nil) is the end
7051 of the text to replace. If END is nil, point is used instead.")
7053 (defvar completion-list-insert-choice-function #'completion--replace
7054 "Function to use to insert the text chosen in *Completions*.
7055 Called with three arguments (BEG END TEXT), it should replace the text
7056 between BEG and END with TEXT. Expected to be set buffer-locally
7057 in the *Completions* buffer.")
7059 (defvar completion-base-size nil
7060 "Number of chars before point not involved in completion.
7061 This is a local variable in the completion list buffer.
7062 It refers to the chars in the minibuffer if completing in the
7063 minibuffer, or in `completion-reference-buffer' otherwise.
7064 Only characters in the field at point are included.
7066 If nil, Emacs determines which part of the tail end of the
7067 buffer's text is involved in completion by comparing the text
7068 directly.")
7069 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7071 (defun delete-completion-window ()
7072 "Delete the completion list window.
7073 Go to the window from which completion was requested."
7074 (interactive)
7075 (let ((buf completion-reference-buffer))
7076 (if (one-window-p t)
7077 (if (window-dedicated-p) (delete-frame))
7078 (delete-window (selected-window))
7079 (if (get-buffer-window buf)
7080 (select-window (get-buffer-window buf))))))
7082 (defun previous-completion (n)
7083 "Move to the previous item in the completion list."
7084 (interactive "p")
7085 (next-completion (- n)))
7087 (defun next-completion (n)
7088 "Move to the next item in the completion list.
7089 With prefix argument N, move N items (negative N means move backward)."
7090 (interactive "p")
7091 (let ((beg (point-min)) (end (point-max)))
7092 (while (and (> n 0) (not (eobp)))
7093 ;; If in a completion, move to the end of it.
7094 (when (get-text-property (point) 'mouse-face)
7095 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7096 ;; Move to start of next one.
7097 (unless (get-text-property (point) 'mouse-face)
7098 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7099 (setq n (1- n)))
7100 (while (and (< n 0) (not (bobp)))
7101 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7102 ;; If in a completion, move to the start of it.
7103 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7104 (goto-char (previous-single-property-change
7105 (point) 'mouse-face nil beg)))
7106 ;; Move to end of the previous completion.
7107 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7108 (goto-char (previous-single-property-change
7109 (point) 'mouse-face nil beg)))
7110 ;; Move to the start of that one.
7111 (goto-char (previous-single-property-change
7112 (point) 'mouse-face nil beg))
7113 (setq n (1+ n))))))
7115 (defun choose-completion (&optional event)
7116 "Choose the completion at point.
7117 If EVENT, use EVENT's position to determine the starting position."
7118 (interactive (list last-nonmenu-event))
7119 ;; In case this is run via the mouse, give temporary modes such as
7120 ;; isearch a chance to turn off.
7121 (run-hooks 'mouse-leave-buffer-hook)
7122 (with-current-buffer (window-buffer (posn-window (event-start event)))
7123 (let ((buffer completion-reference-buffer)
7124 (base-size completion-base-size)
7125 (base-position completion-base-position)
7126 (insert-function completion-list-insert-choice-function)
7127 (choice
7128 (save-excursion
7129 (goto-char (posn-point (event-start event)))
7130 (let (beg end)
7131 (cond
7132 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7133 (setq end (point) beg (1+ (point))))
7134 ((and (not (bobp))
7135 (get-text-property (1- (point)) 'mouse-face))
7136 (setq end (1- (point)) beg (point)))
7137 (t (error "No completion here")))
7138 (setq beg (previous-single-property-change beg 'mouse-face))
7139 (setq end (or (next-single-property-change end 'mouse-face)
7140 (point-max)))
7141 (buffer-substring-no-properties beg end)))))
7143 (unless (buffer-live-p buffer)
7144 (error "Destination buffer is dead"))
7145 (quit-window nil (posn-window (event-start event)))
7147 (with-current-buffer buffer
7148 (choose-completion-string
7149 choice buffer
7150 (or base-position
7151 (when base-size
7152 ;; Someone's using old completion code that doesn't know
7153 ;; about base-position yet.
7154 (list (+ base-size (field-beginning))))
7155 ;; If all else fails, just guess.
7156 (list (choose-completion-guess-base-position choice)))
7157 insert-function)))))
7159 ;; Delete the longest partial match for STRING
7160 ;; that can be found before POINT.
7161 (defun choose-completion-guess-base-position (string)
7162 (save-excursion
7163 (let ((opoint (point))
7164 len)
7165 ;; Try moving back by the length of the string.
7166 (goto-char (max (- (point) (length string))
7167 (minibuffer-prompt-end)))
7168 ;; See how far back we were actually able to move. That is the
7169 ;; upper bound on how much we can match and delete.
7170 (setq len (- opoint (point)))
7171 (if completion-ignore-case
7172 (setq string (downcase string)))
7173 (while (and (> len 0)
7174 (let ((tail (buffer-substring (point) opoint)))
7175 (if completion-ignore-case
7176 (setq tail (downcase tail)))
7177 (not (string= tail (substring string 0 len)))))
7178 (setq len (1- len))
7179 (forward-char 1))
7180 (point))))
7182 (defun choose-completion-delete-max-match (string)
7183 (declare (obsolete choose-completion-guess-base-position "23.2"))
7184 (delete-region (choose-completion-guess-base-position string) (point)))
7186 (defvar choose-completion-string-functions nil
7187 "Functions that may override the normal insertion of a completion choice.
7188 These functions are called in order with three arguments:
7189 CHOICE - the string to insert in the buffer,
7190 BUFFER - the buffer in which the choice should be inserted,
7191 BASE-POSITION - where to insert the completion.
7193 If a function in the list returns non-nil, that function is supposed
7194 to have inserted the CHOICE in the BUFFER, and possibly exited
7195 the minibuffer; no further functions will be called.
7197 If all functions in the list return nil, that means to use
7198 the default method of inserting the completion in BUFFER.")
7200 (defun choose-completion-string (choice &optional
7201 buffer base-position insert-function)
7202 "Switch to BUFFER and insert the completion choice CHOICE.
7203 BASE-POSITION says where to insert the completion.
7204 INSERT-FUNCTION says how to insert the completion and falls
7205 back on `completion-list-insert-choice-function' when nil."
7207 ;; If BUFFER is the minibuffer, exit the minibuffer
7208 ;; unless it is reading a file name and CHOICE is a directory,
7209 ;; or completion-no-auto-exit is non-nil.
7211 ;; Some older code may call us passing `base-size' instead of
7212 ;; `base-position'. It's difficult to make any use of `base-size',
7213 ;; so we just ignore it.
7214 (unless (consp base-position)
7215 (message "Obsolete `base-size' passed to choose-completion-string")
7216 (setq base-position nil))
7218 (let* ((buffer (or buffer completion-reference-buffer))
7219 (mini-p (minibufferp buffer)))
7220 ;; If BUFFER is a minibuffer, barf unless it's the currently
7221 ;; active minibuffer.
7222 (if (and mini-p
7223 (not (and (active-minibuffer-window)
7224 (equal buffer
7225 (window-buffer (active-minibuffer-window))))))
7226 (error "Minibuffer is not active for completion")
7227 ;; Set buffer so buffer-local choose-completion-string-functions works.
7228 (set-buffer buffer)
7229 (unless (run-hook-with-args-until-success
7230 'choose-completion-string-functions
7231 ;; The fourth arg used to be `mini-p' but was useless
7232 ;; (since minibufferp can be used on the `buffer' arg)
7233 ;; and indeed unused. The last used to be `base-size', so we
7234 ;; keep it to try and avoid breaking old code.
7235 choice buffer base-position nil)
7236 ;; This remove-text-properties should be unnecessary since `choice'
7237 ;; comes from buffer-substring-no-properties.
7238 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7239 ;; Insert the completion into the buffer where it was requested.
7240 (funcall (or insert-function completion-list-insert-choice-function)
7241 (or (car base-position) (point))
7242 (or (cadr base-position) (point))
7243 choice)
7244 ;; Update point in the window that BUFFER is showing in.
7245 (let ((window (get-buffer-window buffer t)))
7246 (set-window-point window (point)))
7247 ;; If completing for the minibuffer, exit it with this choice.
7248 (and (not completion-no-auto-exit)
7249 (minibufferp buffer)
7250 minibuffer-completion-table
7251 ;; If this is reading a file name, and the file name chosen
7252 ;; is a directory, don't exit the minibuffer.
7253 (let* ((result (buffer-substring (field-beginning) (point)))
7254 (bounds
7255 (completion-boundaries result minibuffer-completion-table
7256 minibuffer-completion-predicate
7257 "")))
7258 (if (eq (car bounds) (length result))
7259 ;; The completion chosen leads to a new set of completions
7260 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7261 (let ((mini (active-minibuffer-window)))
7262 (select-window mini)
7263 (when minibuffer-auto-raise
7264 (raise-frame (window-frame mini))))
7265 (exit-minibuffer))))))))
7267 (define-derived-mode completion-list-mode nil "Completion List"
7268 "Major mode for buffers showing lists of possible completions.
7270 to select the completion near point.
7271 Or click to select one with the mouse.
7274 (set (make-local-variable 'completion-base-size) nil))
7276 (defun completion-list-mode-finish ()
7277 "Finish setup of the completions buffer.
7278 Called from `temp-buffer-show-hook'."
7279 (when (eq major-mode 'completion-list-mode)
7280 (setq buffer-read-only t)))
7282 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7285 ;; Variables and faces used in `completion-setup-function'.
7287 (defcustom completion-show-help t
7288 "Non-nil means show help message in *Completions* buffer."
7289 :type 'boolean
7290 :version "22.1"
7291 :group 'completion)
7293 ;; This function goes in completion-setup-hook, so that it is called
7294 ;; after the text of the completion list buffer is written.
7295 (defun completion-setup-function ()
7296 (let* ((mainbuf (current-buffer))
7297 (base-dir
7298 ;; FIXME: This is a bad hack. We try to set the default-directory
7299 ;; in the *Completions* buffer so that the relative file names
7300 ;; displayed there can be treated as valid file names, independently
7301 ;; from the completion context. But this suffers from many problems:
7302 ;; - It's not clear when the completions are file names. With some
7303 ;; completion tables (e.g. bzr revision specs), the listed
7304 ;; completions can mix file names and other things.
7305 ;; - It doesn't pay attention to possible quoting.
7306 ;; - With fancy completion styles, the code below will not always
7307 ;; find the right base directory.
7308 (if minibuffer-completing-file-name
7309 (file-name-as-directory
7310 (expand-file-name
7311 (buffer-substring (minibuffer-prompt-end)
7312 (- (point) (or completion-base-size 0))))))))
7313 (with-current-buffer standard-output
7314 (let ((base-size completion-base-size) ;Read before killing localvars.
7315 (base-position completion-base-position)
7316 (insert-fun completion-list-insert-choice-function))
7317 (completion-list-mode)
7318 (set (make-local-variable 'completion-base-size) base-size)
7319 (set (make-local-variable 'completion-base-position) base-position)
7320 (set (make-local-variable 'completion-list-insert-choice-function)
7321 insert-fun))
7322 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7323 (if base-dir (setq default-directory base-dir))
7324 ;; Maybe insert help string.
7325 (when completion-show-help
7326 (goto-char (point-min))
7327 (if (display-mouse-p)
7328 (insert (substitute-command-keys
7330 (insert (substitute-command-keys
7334 (add-hook 'completion-setup-hook 'completion-setup-function)
7336 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7337 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7339 (defun switch-to-completions ()
7340 "Select the completion list window."
7341 (interactive)
7342 (let ((window (or (get-buffer-window "*Completions*" 0)
7343 ;; Make sure we have a completions window.
7344 (progn (minibuffer-completion-help)
7345 (get-buffer-window "*Completions*" 0)))))
7346 (when window
7347 (select-window window)
7348 ;; In the new buffer, go to the first completion.
7349 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7350 (when (bobp)
7351 (next-completion 1)))))
7352 \f
7353 ;;; Support keyboard commands to turn on various modifiers.
7355 ;; These functions -- which are not commands -- each add one modifier
7356 ;; to the following event.
7358 (defun event-apply-alt-modifier (_ignore-prompt)
7361 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7362 (defun event-apply-super-modifier (_ignore-prompt)
7365 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7366 (defun event-apply-hyper-modifier (_ignore-prompt)
7369 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7370 (defun event-apply-shift-modifier (_ignore-prompt)
7373 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7374 (defun event-apply-control-modifier (_ignore-prompt)
7377 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7378 (defun event-apply-meta-modifier (_ignore-prompt)
7381 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7383 (defun event-apply-modifier (event symbol lshiftby prefix)
7384 "Apply a modifier flag to event EVENT.
7385 SYMBOL is the name of this modifier, as a symbol.
7386 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7387 PREFIX is the string that represents this modifier in an event type symbol."
7388 (if (numberp event)
7389 (cond ((eq symbol 'control)
7390 (if (and (<= (downcase event) ?z)
7391 (>= (downcase event) ?a))
7392 (- (downcase event) ?a -1)
7393 (if (and (<= (downcase event) ?Z)
7394 (>= (downcase event) ?A))
7395 (- (downcase event) ?A -1)
7396 (logior (lsh 1 lshiftby) event))))
7397 ((eq symbol 'shift)
7398 (if (and (<= (downcase event) ?z)
7399 (>= (downcase event) ?a))
7400 (upcase event)
7401 (logior (lsh 1 lshiftby) event)))
7402 (t
7403 (logior (lsh 1 lshiftby) event)))
7404 (if (memq symbol (event-modifiers event))
7405 event
7406 (let ((event-type (if (symbolp event) event (car event))))
7407 (setq event-type (intern (concat prefix (symbol-name event-type))))
7408 (if (symbolp event)
7409 event-type
7410 (cons event-type (cdr event)))))))
7412 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7413 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7414 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7415 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7416 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7417 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7418 \f
7419 ;;;; Keypad support.
7421 ;; Make the keypad keys act like ordinary typing keys. If people add
7422 ;; bindings for the function key symbols, then those bindings will
7423 ;; override these, so this shouldn't interfere with any existing
7424 ;; bindings.
7426 ;; Also tell read-char how to handle these keys.
7427 (mapc
7428 (lambda (keypad-normal)
7429 (let ((keypad (nth 0 keypad-normal))
7430 (normal (nth 1 keypad-normal)))
7431 (put keypad 'ascii-character normal)
7432 (define-key function-key-map (vector keypad) (vector normal))))
7433 ;; See also kp-keys bound in bindings.el.
7434 '((kp-space ?\s)
7437 (kp-separator ?,)
7438 (kp-equal ?=)
7439 ;; Do the same for various keys that are represented as symbols under
7440 ;; GUIs but naturally correspond to characters.
7441 (backspace 127)
7442 (delete 127)
7445 (clear ?\C-l)
7446 (return ?\C-m)
7447 (escape ?\e)
7448 ))
7449 \f
7450 ;;;;
7451 ;;;; forking a twin copy of a buffer.
7452 ;;;;
7454 (defvar clone-buffer-hook nil
7455 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7457 (defvar clone-indirect-buffer-hook nil
7458 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7460 (defun clone-process (process &optional newname)
7461 "Create a twin copy of PROCESS.
7462 If NEWNAME is nil, it defaults to PROCESS' name;
7463 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7464 If PROCESS is associated with a buffer, the new process will be associated
7465 with the current buffer instead.
7466 Returns nil if PROCESS has already terminated."
7467 (setq newname (or newname (process-name process)))
7469 (setq newname (substring newname 0 (match-beginning 0))))
7470 (when (memq (process-status process) '(run stop open))
7471 (let* ((process-connection-type (process-tty-name process))
7472 (new-process
7473 (if (memq (process-status process) '(open))
7474 (let ((args (process-contact process t)))
7475 (setq args (plist-put args :name newname))
7476 (setq args (plist-put args :buffer
7477 (if (process-buffer process)
7478 (current-buffer))))
7479 (apply 'make-network-process args))
7480 (apply 'start-process newname
7481 (if (process-buffer process) (current-buffer))
7482 (process-command process)))))
7483 (set-process-query-on-exit-flag
7484 new-process (process-query-on-exit-flag process))
7485 (set-process-inherit-coding-system-flag
7486 new-process (process-inherit-coding-system-flag process))
7487 (set-process-filter new-process (process-filter process))
7488 (set-process-sentinel new-process (process-sentinel process))
7489 (set-process-plist new-process (copy-sequence (process-plist process)))
7490 new-process)))
7492 ;; things to maybe add (currently partly covered by `funcall mode'):
7493 ;; - syntax-table
7494 ;; - overlays
7495 (defun clone-buffer (&optional newname display-flag)
7496 "Create and return a twin copy of the current buffer.
7497 Unlike an indirect buffer, the new buffer can be edited
7498 independently of the old one (if it is not read-only).
7499 NEWNAME is the name of the new buffer. It may be modified by
7500 adding or incrementing <N> at the end as necessary to create a
7501 unique buffer name. If nil, it defaults to the name of the
7502 current buffer, with the proper suffix. If DISPLAY-FLAG is
7503 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7504 clone a file-visiting buffer, or a buffer whose major mode symbol
7505 has a non-nil `no-clone' property, results in an error.
7507 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7508 current buffer with appropriate suffix. However, if a prefix
7509 argument is given, then the command prompts for NEWNAME in the
7510 minibuffer.
7512 This runs the normal hook `clone-buffer-hook' in the new buffer
7513 after it has been set up properly in other respects."
7514 (interactive
7515 (progn
7516 (if buffer-file-name
7517 (error "Cannot clone a file-visiting buffer"))
7518 (if (get major-mode 'no-clone)
7519 (error "Cannot clone a buffer in %s mode" mode-name))
7520 (list (if current-prefix-arg
7521 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7522 t)))
7523 (if buffer-file-name
7524 (error "Cannot clone a file-visiting buffer"))
7525 (if (get major-mode 'no-clone)
7526 (error "Cannot clone a buffer in %s mode" mode-name))
7527 (setq newname (or newname (buffer-name)))
7529 (setq newname (substring newname 0 (match-beginning 0))))
7530 (let ((buf (current-buffer))
7531 (ptmin (point-min))
7532 (ptmax (point-max))
7533 (pt (point))
7534 (mk (if mark-active (mark t)))
7535 (modified (buffer-modified-p))
7536 (mode major-mode)
7537 (lvars (buffer-local-variables))
7538 (process (get-buffer-process (current-buffer)))
7539 (new (generate-new-buffer (or newname (buffer-name)))))
7540 (save-restriction
7541 (widen)
7542 (with-current-buffer new
7543 (insert-buffer-substring buf)))
7544 (with-current-buffer new
7545 (narrow-to-region ptmin ptmax)
7546 (goto-char pt)
7547 (if mk (set-mark mk))
7548 (set-buffer-modified-p modified)
7550 ;; Clone the old buffer's process, if any.
7551 (when process (clone-process process))
7553 ;; Now set up the major mode.
7554 (funcall mode)
7556 ;; Set up other local variables.
7557 (mapc (lambda (v)
7558 (condition-case () ;in case var is read-only
7559 (if (symbolp v)
7560 (makunbound v)
7561 (set (make-local-variable (car v)) (cdr v)))
7562 (error nil)))
7563 lvars)
7565 ;; Run any hooks (typically set up by the major mode
7566 ;; for cloning to work properly).
7567 (run-hooks 'clone-buffer-hook))
7568 (if display-flag
7569 ;; Presumably the current buffer is shown in the selected frame, so
7570 ;; we want to display the clone elsewhere.
7571 (let ((same-window-regexps nil)
7572 (same-window-buffer-names))
7573 (pop-to-buffer new)))
7574 new))
7577 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7578 "Create an indirect buffer that is a twin copy of the current buffer.
7580 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7581 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7582 or if not called with a prefix arg, NEWNAME defaults to the current
7583 buffer's name. The name is modified by adding a `<N>' suffix to it
7584 or by incrementing the N in an existing suffix. Trying to clone a
7585 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7586 property results in an error.
7588 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7589 This is always done when called interactively.
7591 Optional third arg NORECORD non-nil means do not put this buffer at the
7592 front of the list of recently selected ones.
7594 Returns the newly created indirect buffer."
7595 (interactive
7596 (progn
7597 (if (get major-mode 'no-clone-indirect)
7598 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7599 (list (if current-prefix-arg
7600 (read-buffer "Name of indirect buffer: " (current-buffer)))
7601 t)))
7602 (if (get major-mode 'no-clone-indirect)
7603 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7604 (setq newname (or newname (buffer-name)))
7606 (setq newname (substring newname 0 (match-beginning 0))))
7607 (let* ((name (generate-new-buffer-name newname))
7608 (buffer (make-indirect-buffer (current-buffer) name t)))
7609 (with-current-buffer buffer
7610 (run-hooks 'clone-indirect-buffer-hook))
7611 (when display-flag
7612 (pop-to-buffer buffer norecord))
7613 buffer))
7616 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7617 "Like `clone-indirect-buffer' but display in another window."
7618 (interactive
7619 (progn
7620 (if (get major-mode 'no-clone-indirect)
7621 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7622 (list (if current-prefix-arg
7623 (read-buffer "Name of indirect buffer: " (current-buffer)))
7624 t)))
7625 (let ((pop-up-windows t))
7626 (clone-indirect-buffer newname display-flag norecord)))
7628 \f
7629 ;;; Handling of Backspace and Delete keys.
7631 (defcustom normal-erase-is-backspace 'maybe
7632 "Set the default behavior of the Delete and Backspace keys.
7634 If set to t, Delete key deletes forward and Backspace key deletes
7635 backward.
7637 If set to nil, both Delete and Backspace keys delete backward.
7639 If set to 'maybe (which is the default), Emacs automatically
7640 selects a behavior. On window systems, the behavior depends on
7641 the keyboard used. If the keyboard has both a Backspace key and
7642 a Delete key, and both are mapped to their usual meanings, the
7643 option's default value is set to t, so that Backspace can be used
7644 to delete backward, and Delete can be used to delete forward.
7646 If not running under a window system, customizing this option
7647 accomplishes a similar effect by mapping C-h, which is usually
7648 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7649 via `keyboard-translate'. The former functionality of C-h is
7650 available on the F1 key. You should probably not use this
7651 setting if you don't have both Backspace, Delete and F1 keys.
7653 Setting this variable with setq doesn't take effect. Programmatically,
7654 call `normal-erase-is-backspace-mode' (which see) instead."
7655 :type '(choice (const :tag "Off" nil)
7656 (const :tag "Maybe" maybe)
7657 (other :tag "On" t))
7658 :group 'editing-basics
7659 :version "21.1"
7660 :set (lambda (symbol value)
7661 ;; The fboundp is because of a problem with :set when
7662 ;; dumping Emacs. It doesn't really matter.
7663 (if (fboundp 'normal-erase-is-backspace-mode)
7664 (normal-erase-is-backspace-mode (or value 0))
7665 (set-default symbol value))))
7667 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7668 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7669 (unless frame (setq frame (selected-frame)))
7670 (with-selected-frame frame
7671 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7672 (normal-erase-is-backspace-mode
7673 (if (if (eq normal-erase-is-backspace 'maybe)
7674 (and (not noninteractive)
7675 (or (memq system-type '(ms-dos windows-nt))
7676 (memq window-system '(w32 ns))
7677 (and (memq window-system '(x))
7678 (fboundp 'x-backspace-delete-keys-p)
7679 (x-backspace-delete-keys-p))
7680 ;; If the terminal Emacs is running on has erase char
7681 ;; set to ^H, use the Backspace key for deleting
7682 ;; backward, and the Delete key for deleting forward.
7683 (and (null window-system)
7684 (eq tty-erase-char ?\^H))))
7685 normal-erase-is-backspace)
7686 1 0)))))
7688 (define-minor-mode normal-erase-is-backspace-mode
7689 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7690 With a prefix argument ARG, enable this feature if ARG is
7691 positive, and disable it otherwise. If called from Lisp, enable
7692 the mode if ARG is omitted or nil.
7694 On window systems, when this mode is on, Delete is mapped to C-d
7695 and Backspace is mapped to DEL; when this mode is off, both
7696 Delete and Backspace are mapped to DEL. (The remapping goes via
7697 `local-function-key-map', so binding Delete or Backspace in the
7698 global or local keymap will override that.)
7700 In addition, on window systems, the bindings of C-Delete, M-Delete,
7701 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7702 the global keymap in accordance with the functionality of Delete and
7703 Backspace. For example, if Delete is remapped to C-d, which deletes
7704 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7705 to DEL, which deletes backward, C-Delete is bound to
7706 `backward-kill-word'.
7708 If not running on a window system, a similar effect is accomplished by
7709 remapping C-h (normally produced by the Backspace key) and DEL via
7710 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7711 to C-d; if it's off, the keys are not remapped.
7713 When not running on a window system, and this mode is turned on, the
7714 former functionality of C-h is available on the F1 key. You should
7715 probably not turn on this mode on a text-only terminal if you don't
7716 have both Backspace, Delete and F1 keys.
7718 See also `normal-erase-is-backspace'."
7719 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7720 . (lambda (v)
7721 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7722 (if v 1 0))))
7723 (let ((enabled (eq 1 (terminal-parameter
7724 nil 'normal-erase-is-backspace))))
7726 (cond ((or (memq window-system '(x w32 ns pc))
7727 (memq system-type '(ms-dos windows-nt)))
7728 (let ((bindings
7729 `(([M-delete] [M-backspace])
7730 ([C-M-delete] [C-M-backspace])
7731 ([?\e C-delete] [?\e C-backspace]))))
7733 (if enabled
7734 (progn
7735 (define-key local-function-key-map [delete] [deletechar])
7736 (define-key local-function-key-map [kp-delete] [deletechar])
7737 (define-key local-function-key-map [backspace] [?\C-?])
7738 (dolist (b bindings)
7739 ;; Not sure if input-decode-map is really right, but
7740 ;; keyboard-translate-table (used below) only works
7741 ;; for integer events, and key-translation-table is
7742 ;; global (like the global-map, used earlier).
7743 (define-key input-decode-map (car b) nil)
7744 (define-key input-decode-map (cadr b) nil)))
7745 (define-key local-function-key-map [delete] [?\C-?])
7746 (define-key local-function-key-map [kp-delete] [?\C-?])
7747 (define-key local-function-key-map [backspace] [?\C-?])
7748 (dolist (b bindings)
7749 (define-key input-decode-map (car b) (cadr b))
7750 (define-key input-decode-map (cadr b) (car b))))))
7751 (t
7752 (if enabled
7753 (progn
7754 (keyboard-translate ?\C-h ?\C-?)
7755 (keyboard-translate ?\C-? ?\C-d))
7756 (keyboard-translate ?\C-h ?\C-h)
7757 (keyboard-translate ?\C-? ?\C-?))))
7759 (if (called-interactively-p 'interactive)
7760 (message "Delete key deletes %s"
7761 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7762 "forward" "backward")))))
7763 \f
7764 (defvar vis-mode-saved-buffer-invisibility-spec nil
7765 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7767 (define-minor-mode read-only-mode
7768 "Change whether the current buffer is read-only.
7769 With prefix argument ARG, make the buffer read-only if ARG is
7770 positive, otherwise make it writable. If buffer is read-only
7771 and `view-read-only' is non-nil, enter view mode.
7773 Do not call this from a Lisp program unless you really intend to
7775 possibly enabling or disabling View mode. Also, note that this
7776 command works by setting the variable `buffer-read-only', which
7777 does not affect read-only regions caused by text properties. To
7778 ignore read-only status in a Lisp program (whether due to text
7779 properties or buffer state), bind `inhibit-read-only' temporarily
7780 to a non-nil value."
7781 :variable buffer-read-only
7782 (cond
7783 ((and (not buffer-read-only) view-mode)
7784 (View-exit-and-edit)
7785 (make-local-variable 'view-read-only)
7786 (setq view-read-only t)) ; Must leave view mode.
7787 ((and buffer-read-only view-read-only
7788 ;; If view-mode is already active, `view-mode-enter' is a nop.
7789 (not view-mode)
7790 (not (eq (get major-mode 'mode-class) 'special)))
7791 (view-mode-enter))))
7793 (define-minor-mode visible-mode
7794 "Toggle making all invisible text temporarily visible (Visible mode).
7795 With a prefix argument ARG, enable Visible mode if ARG is
7796 positive, and disable it otherwise. If called from Lisp, enable
7797 the mode if ARG is omitted or nil.
7799 This mode works by saving the value of `buffer-invisibility-spec'
7800 and setting it to nil."
7801 :lighter " Vis"
7802 :group 'editing-basics
7803 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7804 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7805 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7806 (when visible-mode
7807 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7808 buffer-invisibility-spec)
7809 (setq buffer-invisibility-spec nil)))
7810 \f
7811 (defvar messages-buffer-mode-map
7812 (let ((map (make-sparse-keymap)))
7813 (set-keymap-parent map special-mode-map)
7814 (define-key map "g" nil) ; nothing to revert
7815 map))
7817 (define-derived-mode messages-buffer-mode special-mode "Messages"
7820 (defun messages-buffer ()
7822 If it does not exist, create and it switch it to `messages-buffer-mode'."
7823 (or (get-buffer "*Messages*")
7824 (with-current-buffer (get-buffer-create "*Messages*")
7825 (messages-buffer-mode)
7826 (current-buffer))))
7828 \f
7829 ;; Minibuffer prompt stuff.
7831 ;;(defun minibuffer-prompt-modification (start end)
7832 ;; (error "You cannot modify the prompt"))
7833 ;;
7834 ;;
7835 ;;(defun minibuffer-prompt-insertion (start end)
7836 ;; (let ((inhibit-modification-hooks t))
7837 ;; (delete-region start end)
7838 ;; ;; Discard undo information for the text insertion itself
7839 ;; ;; and for the text deletion.above.
7840 ;; (when (consp buffer-undo-list)
7841 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7842 ;; (message "You cannot modify the prompt")))
7843 ;;
7844 ;;
7845 ;;(setq minibuffer-prompt-properties
7846 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7847 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7849 \f
7850 ;;;; Problematic external packages.
7852 ;; rms says this should be done by specifying symbols that define
7853 ;; versions together with bad values. This is therefore not as
7854 ;; flexible as it could be. See the thread:
7855 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7856 (defconst bad-packages-alist
7857 ;; Not sure exactly which semantic versions have problems.
7858 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7860 "The version of `semantic' loaded does not work in Emacs 22.
7861 It can cause constant high CPU load.
7862 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7863 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7864 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7865 ;; provided the `CUA-mode' feature. Since this is no longer true,
7866 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7867 (CUA-mode t nil
7868 "CUA-mode is now part of the standard GNU Emacs distribution,
7869 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7871 You have loaded an older version of CUA-mode which does not work
7872 correctly with this version of Emacs. You should remove the old
7873 version and use the one distributed with Emacs."))
7874 "Alist of packages known to cause problems in this version of Emacs.
7875 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7876 PACKAGE is either a regular expression to match file names, or a
7877 symbol (a feature name), like for `with-eval-after-load'.
7878 SYMBOL is either the name of a string variable, or `t'. Upon
7879 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7880 warning using STRING as the message.")
7882 (defun bad-package-check (package)
7883 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7884 (condition-case nil
7885 (let* ((list (assoc package bad-packages-alist))
7886 (symbol (nth 1 list)))
7887 (and list
7888 (boundp symbol)
7889 (or (eq symbol t)
7890 (and (stringp (setq symbol (eval symbol)))
7891 (string-match-p (nth 2 list) symbol)))
7892 (display-warning package (nth 3 list) :warning)))
7893 (error nil)))
7895 (dolist (elem bad-packages-alist)
7896 (let ((pkg (car elem)))
7897 (with-eval-after-load pkg
7898 (bad-package-check pkg))))
7900 \f
7901 ;;; Generic dispatcher commands
7903 ;; Macro `define-alternatives' is used to create generic commands.
7904 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7905 ;; that can have different alternative implementations where choosing
7906 ;; among them is exclusively a matter of user preference.
7908 ;; (define-alternatives COMMAND) creates a new interactive command
7909 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7910 ;; Typically, the user will not need to customize this variable; packages
7911 ;; wanting to add alternative implementations should use
7912 ;;
7913 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7915 (defmacro define-alternatives (command &rest customizations)
7916 "Define the new command `COMMAND'.
7918 The argument `COMMAND' should be a symbol.
7920 Running `M-x COMMAND RET' for the first time prompts for which
7921 alternative to use and records the selected command as a custom
7922 variable.
7924 Running `C-u M-x COMMAND RET' prompts again for an alternative
7925 and overwrites the previous choice.
7927 The variable `COMMAND-alternatives' contains an alist with
7928 alternative implementations of COMMAND. `define-alternatives'
7929 does not have any effect until this variable is set.
7931 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7932 `defcustom' keywords and values to add to the declaration of
7933 `COMMAND-alternatives' (typically :group and :version)."
7934 (let* ((command-name (symbol-name command))
7935 (varalt-name (concat command-name "-alternatives"))
7936 (varalt-sym (intern varalt-name))
7937 (varimp-sym (intern (concat command-name "--implementation"))))
7938 `(progn
7940 (defcustom ,varalt-sym nil
7941 ,(format "Alist of alternative implementations for the `%s' command.
7943 Each entry must be a pair (ALTNAME . ALTFUN), where:
7944 ALTNAME - The name shown at user to describe the alternative implementation.
7945 ALTFUN - The function called to implement this alternative."
7946 command-name)
7947 :type '(alist :key-type string :value-type function)
7948 ,@customizations)
7950 (put ',varalt-sym 'definition-name ',command)
7951 (defvar ,varimp-sym nil "Internal use only.")
7953 (defun ,command (&optional arg)
7954 ,(format "Run generic command `%s'.
7955 If used for the first time, or with interactive ARG, ask the user which
7956 implementation to use for `%s'. The variable `%s'
7957 contains the list of implementations currently supported for this command."
7958 command-name command-name varalt-name)
7959 (interactive "P")
7960 (when (or arg (null ,varimp-sym))
7961 (let ((val (completing-read
7962 ,(format "Select implementation for command `%s': "
7963 command-name)
7964 ,varalt-sym nil t)))
7965 (unless (string-equal val "")
7966 (when (null ,varimp-sym)
7967 (message
7968 "Use `C-u M-x %s RET' to select another implementation"
7969 ,command-name)
7970 (sit-for 3))
7971 (customize-save-variable ',varimp-sym
7972 (cdr (assoc-string val ,varalt-sym))))))
7973 (if ,varimp-sym
7974 (call-interactively ,varimp-sym)
7975 (message ,(format "No implementation selected for command `%s'"
7976 command-name)))))))
7978 \f
7980 (provide 'simple)
7982 ;;; simple.el ends here